/home/lnzliplg/public_html/ruby33.tar
share/man/man5/gemfile.5 0000644 00000056000 15173517734 0010775 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "GEMFILE" "5" "September 2024" ""
.SH "NAME"
\fBGemfile\fR \- A format for describing gem dependencies for Ruby programs
.SH "SYNOPSIS"
A \fBGemfile\fR describes the gem dependencies required to execute associated Ruby code\.
.P
Place the \fBGemfile\fR in the root of the directory containing the associated code\. For instance, in a Rails application, place the \fBGemfile\fR in the same directory as the \fBRakefile\fR\.
.SH "SYNTAX"
A \fBGemfile\fR is evaluated as Ruby code, in a context which makes available a number of methods used to describe the gem requirements\.
.SH "GLOBAL SOURCE"
At the top of the \fBGemfile\fR, add a single line for the \fBRubyGems\fR source that contains the gems listed in the \fBGemfile\fR\.
.IP "" 4
.nf
source "https://rubygems\.org"
.fi
.IP "" 0
.P
You can add only one global source\. In Bundler 1\.13, adding multiple global sources was deprecated\. The \fBsource\fR \fBMUST\fR be a valid RubyGems repository\.
.P
To use more than one source of RubyGems, you should use \fI\fBsource\fR block\fR\.
.P
A source is checked for gems following the heuristics described in \fISOURCE PRIORITY\fR\.
.P
\fBNote about a behavior of the feature deprecated in Bundler 1\.13\fR: If a gem is found in more than one global source, Bundler will print a warning after installing the gem indicating which source was used, and listing the other sources where the gem is available\. A specific source can be selected for gems that need to use a non\-standard repository, suppressing this warning, by using the \fI\fB:source\fR option\fR or \fBsource\fR block\.
.SS "CREDENTIALS"
Some gem sources require a username and password\. Use bundle config(1) \fIbundle\-config\.1\.html\fR to set the username and password for any of the sources that need it\. The command must be run once on each computer that will install the Gemfile, but this keeps the credentials from being stored in plain text in version control\.
.IP "" 4
.nf
bundle config gems\.example\.com user:password
.fi
.IP "" 0
.P
For some sources, like a company Gemfury account, it may be easier to include the credentials in the Gemfile as part of the source URL\.
.IP "" 4
.nf
source "https://user:password@gems\.example\.com"
.fi
.IP "" 0
.P
Credentials in the source URL will take precedence over credentials set using \fBconfig\fR\.
.SH "RUBY"
If your application requires a specific Ruby version or engine, specify your requirements using the \fBruby\fR method, with the following arguments\. All parameters are \fBOPTIONAL\fR unless otherwise specified\.
.SS "VERSION (required)"
The version of Ruby that your application requires\. If your application requires an alternate Ruby engine, such as JRuby, TruffleRuby, etc\., this should be the Ruby version that the engine is compatible with\.
.IP "" 4
.nf
ruby "3\.1\.2"
.fi
.IP "" 0
.P
If you wish to derive your Ruby version from a version file (ie \.ruby\-version), you can use the \fBfile\fR option instead\.
.IP "" 4
.nf
ruby file: "\.ruby\-version"
.fi
.IP "" 0
.P
The version file should conform to any of the following formats:
.IP "\(bu" 4
\fB3\.1\.2\fR (\.ruby\-version)
.IP "\(bu" 4
\fBruby 3\.1\.2\fR (\.tool\-versions, read: https://asdf\-vm\.com/manage/configuration\.html#tool\-versions)
.IP "" 0
.SS "ENGINE"
Each application \fImay\fR specify a Ruby engine\. If an engine is specified, an engine version \fImust\fR also be specified\.
.P
What exactly is an Engine?
.IP "\(bu" 4
A Ruby engine is an implementation of the Ruby language\.
.IP "\(bu" 4
For background: the reference or original implementation of the Ruby programming language is called Matz's Ruby Interpreter \fIhttps://en\.wikipedia\.org/wiki/Ruby_MRI\fR, or MRI for short\. This is named after Ruby creator Yukihiro Matsumoto, also known as Matz\. MRI is also known as CRuby, because it is written in C\. MRI is the most widely used Ruby engine\.
.IP "\(bu" 4
Other implementations \fIhttps://www\.ruby\-lang\.org/en/about/\fR of Ruby exist\. Some of the more well\-known implementations include JRuby \fIhttps://www\.jruby\.org/\fR and TruffleRuby \fIhttps://www\.graalvm\.org/ruby/\fR\. Rubinius is an alternative implementation of Ruby written in Ruby\. JRuby is an implementation of Ruby on the JVM, short for Java Virtual Machine\. TruffleRuby is a Ruby implementation on the GraalVM, a language toolkit built on the JVM\.
.IP "" 0
.SS "ENGINE VERSION"
Each application \fImay\fR specify a Ruby engine version\. If an engine version is specified, an engine \fImust\fR also be specified\. If the engine is "ruby" the engine version specified \fImust\fR match the Ruby version\.
.IP "" 4
.nf
ruby "2\.6\.8", engine: "jruby", engine_version: "9\.3\.8\.0"
.fi
.IP "" 0
.SS "PATCHLEVEL"
Each application \fImay\fR specify a Ruby patchlevel\. Specifying the patchlevel has been meaningless since Ruby 2\.1\.0 was released as the patchlevel is now uniquely determined by a combination of major, minor, and teeny version numbers\.
.P
This option was implemented in Bundler 1\.4\.0 for Ruby 2\.0 or earlier\.
.IP "" 4
.nf
ruby "3\.1\.2", patchlevel: "20"
.fi
.IP "" 0
.SH "GEMS"
Specify gem requirements using the \fBgem\fR method, with the following arguments\. All parameters are \fBOPTIONAL\fR unless otherwise specified\.
.SS "NAME (required)"
For each gem requirement, list a single \fIgem\fR line\.
.IP "" 4
.nf
gem "nokogiri"
.fi
.IP "" 0
.SS "VERSION"
Each \fIgem\fR \fBMAY\fR have one or more version specifiers\.
.IP "" 4
.nf
gem "nokogiri", ">= 1\.4\.2"
gem "RedCloth", ">= 4\.1\.0", "< 4\.2\.0"
.fi
.IP "" 0
.SS "REQUIRE AS"
Each \fIgem\fR \fBMAY\fR specify files that should be used when autorequiring via \fBBundler\.require\fR\. You may pass an array with multiple files or \fBtrue\fR if the file you want \fBrequired\fR has the same name as \fIgem\fR or \fBfalse\fR to prevent any file from being autorequired\.
.IP "" 4
.nf
gem "redis", require: ["redis/connection/hiredis", "redis"]
gem "webmock", require: false
gem "byebug", require: true
.fi
.IP "" 0
.P
The argument defaults to the name of the gem\. For example, these are identical:
.IP "" 4
.nf
gem "nokogiri"
gem "nokogiri", require: "nokogiri"
gem "nokogiri", require: true
.fi
.IP "" 0
.SS "GROUPS"
Each \fIgem\fR \fBMAY\fR specify membership in one or more groups\. Any \fIgem\fR that does not specify membership in any group is placed in the \fBdefault\fR group\.
.IP "" 4
.nf
gem "rspec", group: :test
gem "wirble", groups: [:development, :test]
.fi
.IP "" 0
.P
The Bundler runtime allows its two main methods, \fBBundler\.setup\fR and \fBBundler\.require\fR, to limit their impact to particular groups\.
.IP "" 4
.nf
# setup adds gems to Ruby's load path
Bundler\.setup # defaults to all groups
require "bundler/setup" # same as Bundler\.setup
Bundler\.setup(:default) # only set up the _default_ group
Bundler\.setup(:test) # only set up the _test_ group (but `not` _default_)
Bundler\.setup(:default, :test) # set up the _default_ and _test_ groups, but no others
# require requires all of the gems in the specified groups
Bundler\.require # defaults to the _default_ group
Bundler\.require(:default) # identical
Bundler\.require(:default, :test) # requires the _default_ and _test_ groups
Bundler\.require(:test) # requires the _test_ group
.fi
.IP "" 0
.P
The Bundler CLI allows you to specify a list of groups whose gems \fBbundle install\fR should not install with the \fBwithout\fR configuration\.
.P
To specify multiple groups to ignore, specify a list of groups separated by spaces\.
.IP "" 4
.nf
bundle config set \-\-local without test
bundle config set \-\-local without development test
.fi
.IP "" 0
.P
Also, calling \fBBundler\.setup\fR with no parameters, or calling \fBrequire "bundler/setup"\fR will setup all groups except for the ones you excluded via \fB\-\-without\fR (since they are not available)\.
.P
Note that on \fBbundle install\fR, bundler downloads and evaluates all gems, in order to create a single canonical list of all of the required gems and their dependencies\. This means that you cannot list different versions of the same gems in different groups\. For more details, see Understanding Bundler \fIhttps://bundler\.io/rationale\.html\fR\.
.SS "PLATFORMS"
If a gem should only be used in a particular platform or set of platforms, you can specify them\. Platforms are essentially identical to groups, except that you do not need to use the \fB\-\-without\fR install\-time flag to exclude groups of gems for other platforms\.
.P
There are a number of \fBGemfile\fR platforms:
.TP
\fBruby\fR
C Ruby (MRI), Rubinius, or TruffleRuby, but not Windows
.TP
\fBmri\fR
C Ruby (MRI) only, but not Windows
.TP
\fBwindows\fR
Windows C Ruby (MRI), including RubyInstaller 32\-bit and 64\-bit versions
.TP
\fBmswin\fR
Windows C Ruby (MRI), including RubyInstaller 32\-bit versions
.TP
\fBmswin64\fR
Windows C Ruby (MRI), including RubyInstaller 64\-bit versions
.TP
\fBrbx\fR
Rubinius
.TP
\fBjruby\fR
JRuby
.TP
\fBtruffleruby\fR
TruffleRuby
.P
On platforms \fBruby\fR, \fBmri\fR, \fBmswin\fR, \fBmswin64\fR, and \fBwindows\fR, you may additionally specify a version by appending the major and minor version numbers without a delimiter\. For example, to specify that a gem should only be used on platform \fBruby\fR version 3\.1, use:
.IP "" 4
.nf
ruby_31
.fi
.IP "" 0
.P
As with groups (above), you may specify one or more platforms:
.IP "" 4
.nf
gem "weakling", platforms: :jruby
gem "ruby\-debug", platforms: :mri_31
gem "nokogiri", platforms: [:windows_31, :jruby]
.fi
.IP "" 0
.P
All operations involving groups (\fBbundle install\fR \fIbundle\-install\.1\.html\fR, \fBBundler\.setup\fR, \fBBundler\.require\fR) behave exactly the same as if any groups not matching the current platform were explicitly excluded\.
.P
The following platform values are deprecated and should be replaced with \fBwindows\fR:
.IP "\(bu" 4
\fBmswin\fR, \fBmswin64\fR, \fBmingw32\fR, \fBx64_mingw\fR
.IP "" 0
.P
Note that, while unfortunately using the same terminology, the values of this option are different from the values that \fBbundle lock \-\-add\-platform\fR can take\. The values of this option are more closer to "Ruby Implementation" while the values that \fBbundle lock \-\-add\-platform\fR understands are more related to OS and architecture of the different systems where your lockfile will be used\.
.SS "FORCE_RUBY_PLATFORM"
If you always want the pure ruby variant of a gem to be chosen over platform specific variants, you can use the \fBforce_ruby_platform\fR option:
.IP "" 4
.nf
gem "ffi", force_ruby_platform: true
.fi
.IP "" 0
.P
This can be handy (assuming the pure ruby variant works fine) when:
.IP "\(bu" 4
You're having issues with the platform specific variant\.
.IP "\(bu" 4
The platform specific variant does not yet support a newer ruby (and thus has a \fBrequired_ruby_version\fR upper bound), but you still want your Gemfile{\.lock} files to resolve under that ruby\.
.IP "" 0
.SS "SOURCE"
You can select an alternate RubyGems repository for a gem using the ':source' option\.
.IP "" 4
.nf
gem "some_internal_gem", source: "https://gems\.example\.com"
.fi
.IP "" 0
.P
This forces the gem to be loaded from this source and ignores the global source declared at the top level of the file\. If the gem does not exist in this source, it will not be installed\.
.P
Bundler will search for child dependencies of this gem by first looking in the source selected for the parent, but if they are not found there, it will fall back on the global source\.
.P
\fBNote about a behavior of the feature deprecated in Bundler 1\.13\fR: Selecting a specific source repository this way also suppresses the ambiguous gem warning described above in \fIGLOBAL SOURCE\fR\.
.P
Using the \fB:source\fR option for an individual gem will also make that source available as a possible global source for any other gems which do not specify explicit sources\. Thus, when adding gems with explicit sources, it is recommended that you also ensure all other gems in the Gemfile are using explicit sources\.
.SS "GIT"
If necessary, you can specify that a gem is located at a particular git repository using the \fB:git\fR parameter\. The repository can be accessed via several protocols:
.TP
\fBHTTP(S)\fR
gem "rails", git: "https://github\.com/rails/rails\.git"
.TP
\fBSSH\fR
gem "rails", git: "git@github\.com:rails/rails\.git"
.TP
\fBgit\fR
gem "rails", git: "git://github\.com/rails/rails\.git"
.P
If using SSH, the user that you use to run \fBbundle install\fR \fBMUST\fR have the appropriate keys available in their \fB$HOME/\.ssh\fR\.
.P
\fBNOTE\fR: \fBhttp://\fR and \fBgit://\fR URLs should be avoided if at all possible\. These protocols are unauthenticated, so a man\-in\-the\-middle attacker can deliver malicious code and compromise your system\. HTTPS and SSH are strongly preferred\.
.P
The \fBgroup\fR, \fBplatforms\fR, and \fBrequire\fR options are available and behave exactly the same as they would for a normal gem\.
.P
A git repository \fBSHOULD\fR have at least one file, at the root of the directory containing the gem, with the extension \fB\.gemspec\fR\. This file \fBMUST\fR contain a valid gem specification, as expected by the \fBgem build\fR command\.
.P
If a git repository does not have a \fB\.gemspec\fR, bundler will attempt to create one, but it will not contain any dependencies, executables, or C extension compilation instructions\. As a result, it may fail to properly integrate into your application\.
.P
If a git repository does have a \fB\.gemspec\fR for the gem you attached it to, a version specifier, if provided, means that the git repository is only valid if the \fB\.gemspec\fR specifies a version matching the version specifier\. If not, bundler will print a warning\.
.IP "" 4
.nf
gem "rails", "2\.3\.8", git: "https://github\.com/rails/rails\.git"
# bundle install will fail, because the \.gemspec in the rails
# repository's master branch specifies version 3\.0\.0
.fi
.IP "" 0
.P
If a git repository does \fBnot\fR have a \fB\.gemspec\fR for the gem you attached it to, a version specifier \fBMUST\fR be provided\. Bundler will use this version in the simple \fB\.gemspec\fR it creates\.
.P
Git repositories support a number of additional options\.
.TP
\fBbranch\fR, \fBtag\fR, and \fBref\fR
You \fBMUST\fR only specify at most one of these options\. The default is \fBbranch: "master"\fR\. For example:
.IP
gem "rails", git: "https://github\.com/rails/rails\.git", branch: "5\-0\-stable"
.IP
gem "rails", git: "https://github\.com/rails/rails\.git", tag: "v5\.0\.0"
.IP
gem "rails", git: "https://github\.com/rails/rails\.git", ref: "4aded"
.TP
\fBsubmodules\fR
For reference, a git submodule \fIhttps://git\-scm\.com/book/en/v2/Git\-Tools\-Submodules\fR lets you have another git repository within a subfolder of your repository\. Specify \fBsubmodules: true\fR to cause bundler to expand any submodules included in the git repository
.P
If a git repository contains multiple \fB\.gemspecs\fR, each \fB\.gemspec\fR represents a gem located at the same place in the file system as the \fB\.gemspec\fR\.
.IP "" 4
.nf
|~rails [git root]
| |\-rails\.gemspec [rails gem located here]
|~actionpack
| |\-actionpack\.gemspec [actionpack gem located here]
|~activesupport
| |\-activesupport\.gemspec [activesupport gem located here]
|\|\.\|\.\|\.
.fi
.IP "" 0
.P
To install a gem located in a git repository, bundler changes to the directory containing the gemspec, runs \fBgem build name\.gemspec\fR and then installs the resulting gem\. The \fBgem build\fR command, which comes standard with Rubygems, evaluates the \fB\.gemspec\fR in the context of the directory in which it is located\.
.SS "GIT SOURCE"
A custom git source can be defined via the \fBgit_source\fR method\. Provide the source's name as an argument, and a block which receives a single argument and interpolates it into a string to return the full repo address:
.IP "" 4
.nf
git_source(:stash){ |repo_name| "https://stash\.corp\.acme\.pl/#{repo_name}\.git" }
gem 'rails', stash: 'forks/rails'
.fi
.IP "" 0
.P
In addition, if you wish to choose a specific branch:
.IP "" 4
.nf
gem "rails", stash: "forks/rails", branch: "branch_name"
.fi
.IP "" 0
.SS "GITHUB"
\fBNOTE\fR: This shorthand should be avoided until Bundler 2\.0, since it currently expands to an insecure \fBgit://\fR URL\. This allows a man\-in\-the\-middle attacker to compromise your system\.
.P
If the git repository you want to use is hosted on GitHub and is public, you can use the :github shorthand to specify the github username and repository name (without the trailing "\.git"), separated by a slash\. If both the username and repository name are the same, you can omit one\.
.IP "" 4
.nf
gem "rails", github: "rails/rails"
gem "rails", github: "rails"
.fi
.IP "" 0
.P
Are both equivalent to
.IP "" 4
.nf
gem "rails", git: "https://github\.com/rails/rails\.git"
.fi
.IP "" 0
.P
Since the \fBgithub\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\.
.P
You can also directly pass a pull request URL:
.IP "" 4
.nf
gem "rails", github: "https://github\.com/rails/rails/pull/43753"
.fi
.IP "" 0
.P
Which is equivalent to:
.IP "" 4
.nf
gem "rails", github: "rails/rails", branch: "refs/pull/43753/head"
.fi
.IP "" 0
.SS "GIST"
If the git repository you want to use is hosted as a GitHub Gist and is public, you can use the :gist shorthand to specify the gist identifier (without the trailing "\.git")\.
.IP "" 4
.nf
gem "the_hatch", gist: "4815162342"
.fi
.IP "" 0
.P
Is equivalent to:
.IP "" 4
.nf
gem "the_hatch", git: "https://gist\.github\.com/4815162342\.git"
.fi
.IP "" 0
.P
Since the \fBgist\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\.
.SS "BITBUCKET"
If the git repository you want to use is hosted on Bitbucket and is public, you can use the :bitbucket shorthand to specify the bitbucket username and repository name (without the trailing "\.git"), separated by a slash\. If both the username and repository name are the same, you can omit one\.
.IP "" 4
.nf
gem "rails", bitbucket: "rails/rails"
gem "rails", bitbucket: "rails"
.fi
.IP "" 0
.P
Are both equivalent to
.IP "" 4
.nf
gem "rails", git: "https://rails@bitbucket\.org/rails/rails\.git"
.fi
.IP "" 0
.P
Since the \fBbitbucket\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\.
.SS "PATH"
You can specify that a gem is located in a particular location on the file system\. Relative paths are resolved relative to the directory containing the \fBGemfile\fR\.
.P
Similar to the semantics of the \fB:git\fR option, the \fB:path\fR option requires that the directory in question either contains a \fB\.gemspec\fR for the gem, or that you specify an explicit version that bundler should use\.
.P
Unlike \fB:git\fR, bundler does not compile C extensions for gems specified as paths\.
.IP "" 4
.nf
gem "rails", path: "vendor/rails"
.fi
.IP "" 0
.P
If you would like to use multiple local gems directly from the filesystem, you can set a global \fBpath\fR option to the path containing the gem's files\. This will automatically load gemspec files from subdirectories\.
.IP "" 4
.nf
path 'components' do
gem 'admin_ui'
gem 'public_ui'
end
.fi
.IP "" 0
.SH "BLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS"
The \fB:source\fR, \fB:git\fR, \fB:path\fR, \fB:group\fR, and \fB:platforms\fR options may be applied to a group of gems by using block form\.
.IP "" 4
.nf
source "https://gems\.example\.com" do
gem "some_internal_gem"
gem "another_internal_gem"
end
git "https://github\.com/rails/rails\.git" do
gem "activesupport"
gem "actionpack"
end
platforms :ruby do
gem "ruby\-debug"
gem "sqlite3"
end
group :development, optional: true do
gem "wirble"
gem "faker"
end
.fi
.IP "" 0
.P
In the case of the group block form the :optional option can be given to prevent a group from being installed unless listed in the \fB\-\-with\fR option given to the \fBbundle install\fR command\.
.P
In the case of the \fBgit\fR block form, the \fB:ref\fR, \fB:branch\fR, \fB:tag\fR, and \fB:submodules\fR options may be passed to the \fBgit\fR method, and all gems in the block will inherit those options\.
.P
The presence of a \fBsource\fR block in a Gemfile also makes that source available as a possible global source for any other gems which do not specify explicit sources\. Thus, when defining source blocks, it is recommended that you also ensure all other gems in the Gemfile are using explicit sources, either via source blocks or \fB:source\fR directives on individual gems\.
.SH "INSTALL_IF"
The \fBinstall_if\fR method allows gems to be installed based on a proc or lambda\. This is especially useful for optional gems that can only be used if certain software is installed or some other conditions are met\.
.IP "" 4
.nf
install_if \-> { RUBY_PLATFORM =~ /darwin/ } do
gem "pasteboard"
end
.fi
.IP "" 0
.SH "GEMSPEC"
The \fB\.gemspec\fR \fIhttps://guides\.rubygems\.org/specification\-reference/\fR file is where you provide metadata about your gem to Rubygems\. Some required Gemspec attributes include the name, description, and homepage of your gem\. This is also where you specify the dependencies your gem needs to run\.
.P
If you wish to use Bundler to help install dependencies for a gem while it is being developed, use the \fBgemspec\fR method to pull in the dependencies listed in the \fB\.gemspec\fR file\.
.P
The \fBgemspec\fR method adds any runtime dependencies as gem requirements in the default group\. It also adds development dependencies as gem requirements in the \fBdevelopment\fR group\. Finally, it adds a gem requirement on your project (\fBpath: '\.'\fR)\. In conjunction with \fBBundler\.setup\fR, this allows you to require project files in your test code as you would if the project were installed as a gem; you need not manipulate the load path manually or require project files via relative paths\.
.P
The \fBgemspec\fR method supports optional \fB:path\fR, \fB:glob\fR, \fB:name\fR, and \fB:development_group\fR options, which control where bundler looks for the \fB\.gemspec\fR, the glob it uses to look for the gemspec (defaults to: \fB{,*,*/*}\.gemspec\fR), what named \fB\.gemspec\fR it uses (if more than one is present), and which group development dependencies are included in\.
.P
When a \fBgemspec\fR dependency encounters version conflicts during resolution, the local version under development will always be selected \-\- even if there are remote versions that better match other requirements for the \fBgemspec\fR gem\.
.SH "SOURCE PRIORITY"
When attempting to locate a gem to satisfy a gem requirement, bundler uses the following priority order:
.IP "1." 4
The source explicitly attached to the gem (using \fB:source\fR, \fB:path\fR, or \fB:git\fR)
.IP "2." 4
For implicit gems (dependencies of explicit gems), any source, git, or path repository declared on the parent\. This results in bundler prioritizing the ActiveSupport gem from the Rails git repository over ones from \fBrubygems\.org\fR
.IP "3." 4
If neither of the above conditions are met, the global source will be used\. If multiple global sources are specified, they will be prioritized from last to first, but this is deprecated since Bundler 1\.13, so Bundler prints a warning and will abort with an error in the future\.
.IP "" 0
share/man/man1/bundle-list.1 0000644 00000001664 15173517734 0011605 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-LIST" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-list\fR \- List all the gems in the bundle
.SH "SYNOPSIS"
\fBbundle list\fR [\-\-name\-only] [\-\-paths] [\-\-without\-group=GROUP[ GROUP\|\.\|\.\|\.]] [\-\-only\-group=GROUP[ GROUP\|\.\|\.\|\.]]
.SH "DESCRIPTION"
Prints a list of all the gems in the bundle including their version\.
.P
Example:
.P
bundle list \-\-name\-only
.P
bundle list \-\-paths
.P
bundle list \-\-without\-group test
.P
bundle list \-\-only\-group dev
.P
bundle list \-\-only\-group dev test \-\-paths
.SH "OPTIONS"
.TP
\fB\-\-name\-only\fR
Print only the name of each gem\.
.TP
\fB\-\-paths\fR
Print the path to each gem in the bundle\.
.TP
\fB\-\-without\-group=<list>\fR
A space\-separated list of groups of gems to skip during printing\.
.TP
\fB\-\-only\-group=<list>\fR
A space\-separated list of groups of gems to print\.
share/man/man1/bundle-lock.1 0000644 00000006106 15173517734 0011556 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-LOCK" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-lock\fR \- Creates / Updates a lockfile without installing
.SH "SYNOPSIS"
\fBbundle lock\fR [\-\-update] [\-\-local] [\-\-print] [\-\-lockfile=PATH] [\-\-full\-index] [\-\-add\-platform] [\-\-remove\-platform] [\-\-patch] [\-\-minor] [\-\-major] [\-\-strict] [\-\-conservative]
.SH "DESCRIPTION"
Lock the gems specified in Gemfile\.
.SH "OPTIONS"
.TP
\fB\-\-update=<*gems>\fR
Ignores the existing lockfile\. Resolve then updates lockfile\. Taking a list of gems or updating all gems if no list is given\.
.TP
\fB\-\-local\fR
Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the gems already present in Rubygems' cache or in \fBvendor/cache\fR\. Note that if a appropriate platform\-specific gem exists on \fBrubygems\.org\fR it will not be found\.
.TP
\fB\-\-print\fR
Prints the lockfile to STDOUT instead of writing to the file system\.
.TP
\fB\-\-lockfile=<path>\fR
The path where the lockfile should be written to\.
.TP
\fB\-\-full\-index\fR
Fall back to using the single\-file index of all gems\.
.TP
\fB\-\-add\-platform\fR
Add a new platform to the lockfile, re\-resolving for the addition of that platform\.
.TP
\fB\-\-remove\-platform\fR
Remove a platform from the lockfile\.
.TP
\fB\-\-patch\fR
If updating, prefer updating only to next patch version\.
.TP
\fB\-\-minor\fR
If updating, prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
If updating, prefer updating to next major version (default)\.
.TP
\fB\-\-strict\fR
If updating, do not allow any gem to be updated past latest \-\-patch | \-\-minor | \-\-major\.
.TP
\fB\-\-conservative\fR
If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated\.
.SH "UPDATING ALL GEMS"
If you run \fBbundle lock\fR with \fB\-\-update\fR option without list of gems, bundler will ignore any previously installed gems and resolve all dependencies again based on the latest versions of all gems available in the sources\.
.SH "UPDATING A LIST OF GEMS"
Sometimes, you want to update a single gem in the Gemfile(5), and leave the rest of the gems that you specified locked to the versions in the \fBGemfile\.lock\fR\.
.P
For instance, you only want to update \fBnokogiri\fR, run \fBbundle lock \-\-update nokogiri\fR\.
.P
Bundler will update \fBnokogiri\fR and any of its dependencies, but leave the rest of the gems that you specified locked to the versions in the \fBGemfile\.lock\fR\.
.SH "SUPPORTING OTHER PLATFORMS"
If you want your bundle to support platforms other than the one you're running locally, you can run \fBbundle lock \-\-add\-platform PLATFORM\fR to add PLATFORM to the lockfile, force bundler to re\-resolve and consider the new platform when picking gems, all without needing to have a machine that matches PLATFORM handy to install those platform\-specific gems on\.
.P
For a full explanation of gem platforms, see \fBgem help platform\fR\.
.SH "PATCH LEVEL OPTIONS"
See bundle update(1) \fIbundle\-update\.1\.html\fR for details\.
share/man/man1/bundle-update.1 0000644 00000032551 15173517734 0012113 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-UPDATE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-update\fR \- Update your gems to the latest available versions
.SH "SYNOPSIS"
\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-jobs=JOBS] [\-\-quiet] [\-\-patch|\-\-minor|\-\-major] [\-\-redownload] [\-\-strict] [\-\-conservative]
.SH "DESCRIPTION"
Update the gems specified (all gems, if \fB\-\-all\fR flag is used), ignoring the previously installed gems specified in the \fBGemfile\.lock\fR\. In general, you should use bundle install(1) \fIbundle\-install\.1\.html\fR to install the same exact gems and versions across machines\.
.P
You would use \fBbundle update\fR to explicitly update the version of a gem\.
.SH "OPTIONS"
.TP
\fB\-\-all\fR
Update all gems specified in Gemfile\.
.TP
\fB\-\-group=<name>\fR, \fB\-g=[<name>]\fR
Only update the gems in the specified group\. For instance, you can update all gems in the development group with \fBbundle update \-\-group development\fR\. You can also call \fBbundle update rails \-\-group test\fR to update the rails gem and all gems in the test group, for example\.
.TP
\fB\-\-source=<name>\fR
The name of a \fB:git\fR or \fB:path\fR source used in the Gemfile(5)\. For instance, with a \fB:git\fR source of \fBhttp://github\.com/rails/rails\.git\fR, you would call \fBbundle update \-\-source rails\fR
.TP
\fB\-\-local\fR
Do not attempt to fetch gems remotely and use the gem cache instead\.
.TP
\fB\-\-ruby\fR
Update the locked version of Ruby to the current version of Ruby\.
.TP
\fB\-\-bundler\fR
Update the locked version of bundler to the invoked bundler version\.
.TP
\fB\-\-full\-index\fR
Fall back to using the single\-file index of all gems\.
.TP
\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR
Specify the number of jobs to run in parallel\. The default is the number of available processors\.
.TP
\fB\-\-retry=[<number>]\fR
Retry failed network or git requests for \fInumber\fR times\.
.TP
\fB\-\-quiet\fR
Only output warnings and errors\.
.TP
\fB\-\-redownload\fR
Force downloading every gem\.
.TP
\fB\-\-patch\fR
Prefer updating only to next patch version\.
.TP
\fB\-\-minor\fR
Prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
Prefer updating to next major version (default)\.
.TP
\fB\-\-strict\fR
Do not allow any gem to be updated past latest \fB\-\-patch\fR | \fB\-\-minor\fR | \fB\-\-major\fR\.
.TP
\fB\-\-conservative\fR
Use bundle install conservative update behavior and do not allow indirect dependencies to be updated\.
.SH "UPDATING ALL GEMS"
If you run \fBbundle update \-\-all\fR, bundler will ignore any previously installed gems and resolve all dependencies again based on the latest versions of all gems available in the sources\.
.P
Consider the following Gemfile(5):
.IP "" 4
.nf
source "https://rubygems\.org"
gem "rails", "3\.0\.0\.rc"
gem "nokogiri"
.fi
.IP "" 0
.P
When you run bundle install(1) \fIbundle\-install\.1\.html\fR the first time, bundler will resolve all of the dependencies, all the way down, and install what you need:
.IP "" 4
.nf
Fetching gem metadata from https://rubygems\.org/\|\.\|\.\|\.\|\.\|\.\|\.\|\.\|\.\|\.
Resolving dependencies\|\.\|\.\|\.
Installing builder 2\.1\.2
Installing abstract 1\.0\.0
Installing rack 1\.2\.8
Using bundler 1\.7\.6
Installing rake 10\.4\.0
Installing polyglot 0\.3\.5
Installing mime\-types 1\.25\.1
Installing i18n 0\.4\.2
Installing mini_portile 0\.6\.1
Installing tzinfo 0\.3\.42
Installing rack\-mount 0\.6\.14
Installing rack\-test 0\.5\.7
Installing treetop 1\.4\.15
Installing thor 0\.14\.6
Installing activesupport 3\.0\.0\.rc
Installing erubis 2\.6\.6
Installing activemodel 3\.0\.0\.rc
Installing arel 0\.4\.0
Installing mail 2\.2\.20
Installing activeresource 3\.0\.0\.rc
Installing actionpack 3\.0\.0\.rc
Installing activerecord 3\.0\.0\.rc
Installing actionmailer 3\.0\.0\.rc
Installing railties 3\.0\.0\.rc
Installing rails 3\.0\.0\.rc
Installing nokogiri 1\.6\.5
Bundle complete! 2 Gemfile dependencies, 26 gems total\.
Use `bundle show [gemname]` to see where a bundled gem is installed\.
.fi
.IP "" 0
.P
As you can see, even though you have two gems in the Gemfile(5), your application needs 26 different gems in order to run\. Bundler remembers the exact versions it installed in \fBGemfile\.lock\fR\. The next time you run bundle install(1) \fIbundle\-install\.1\.html\fR, bundler skips the dependency resolution and installs the same gems as it installed last time\.
.P
After checking in the \fBGemfile\.lock\fR into version control and cloning it on another machine, running bundle install(1) \fIbundle\-install\.1\.html\fR will \fIstill\fR install the gems that you installed last time\. You don't need to worry that a new release of \fBerubis\fR or \fBmail\fR changes the gems you use\.
.P
However, from time to time, you might want to update the gems you are using to the newest versions that still match the gems in your Gemfile(5)\.
.P
To do this, run \fBbundle update \-\-all\fR, which will ignore the \fBGemfile\.lock\fR, and resolve all the dependencies again\. Keep in mind that this process can result in a significantly different set of the 25 gems, based on the requirements of new gems that the gem authors released since the last time you ran \fBbundle update \-\-all\fR\.
.SH "UPDATING A LIST OF GEMS"
Sometimes, you want to update a single gem in the Gemfile(5), and leave the rest of the gems that you specified locked to the versions in the \fBGemfile\.lock\fR\.
.P
For instance, in the scenario above, imagine that \fBnokogiri\fR releases version \fB1\.4\.4\fR, and you want to update it \fIwithout\fR updating Rails and all of its dependencies\. To do this, run \fBbundle update nokogiri\fR\.
.P
Bundler will update \fBnokogiri\fR and any of its dependencies, but leave alone Rails and its dependencies\.
.SH "OVERLAPPING DEPENDENCIES"
Sometimes, multiple gems declared in your Gemfile(5) are satisfied by the same second\-level dependency\. For instance, consider the case of \fBthin\fR and \fBrack\-perftools\-profiler\fR\.
.IP "" 4
.nf
source "https://rubygems\.org"
gem "thin"
gem "rack\-perftools\-profiler"
.fi
.IP "" 0
.P
The \fBthin\fR gem depends on \fBrack >= 1\.0\fR, while \fBrack\-perftools\-profiler\fR depends on \fBrack ~> 1\.0\fR\. If you run bundle install, you get:
.IP "" 4
.nf
Fetching source index for https://rubygems\.org/
Installing daemons (1\.1\.0)
Installing eventmachine (0\.12\.10) with native extensions
Installing open4 (1\.0\.1)
Installing perftools\.rb (0\.4\.7) with native extensions
Installing rack (1\.2\.1)
Installing rack\-perftools_profiler (0\.0\.2)
Installing thin (1\.2\.7) with native extensions
Using bundler (1\.0\.0\.rc\.3)
.fi
.IP "" 0
.P
In this case, the two gems have their own set of dependencies, but they share \fBrack\fR in common\. If you run \fBbundle update thin\fR, bundler will update \fBdaemons\fR, \fBeventmachine\fR and \fBrack\fR, which are dependencies of \fBthin\fR, but not \fBopen4\fR or \fBperftools\.rb\fR, which are dependencies of \fBrack\-perftools_profiler\fR\. Note that \fBbundle update thin\fR will update \fBrack\fR even though it's \fIalso\fR a dependency of \fBrack\-perftools_profiler\fR\.
.P
In short, by default, when you update a gem using \fBbundle update\fR, bundler will update all dependencies of that gem, including those that are also dependencies of another gem\.
.P
To prevent updating indirect dependencies, prior to version 1\.14 the only option was the \fBCONSERVATIVE UPDATING\fR behavior in bundle install(1) \fIbundle\-install\.1\.html\fR:
.P
In this scenario, updating the \fBthin\fR version manually in the Gemfile(5), and then running bundle install(1) \fIbundle\-install\.1\.html\fR will only update \fBdaemons\fR and \fBeventmachine\fR, but not \fBrack\fR\. For more information, see the \fBCONSERVATIVE UPDATING\fR section of bundle install(1) \fIbundle\-install\.1\.html\fR\.
.P
Starting with 1\.14, specifying the \fB\-\-conservative\fR option will also prevent indirect dependencies from being updated\.
.SH "PATCH LEVEL OPTIONS"
Version 1\.14 introduced 4 patch\-level options that will influence how gem versions are resolved\. One of the following options can be used: \fB\-\-patch\fR, \fB\-\-minor\fR or \fB\-\-major\fR\. \fB\-\-strict\fR can be added to further influence resolution\.
.TP
\fB\-\-patch\fR
Prefer updating only to next patch version\.
.TP
\fB\-\-minor\fR
Prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
Prefer updating to next major version (default)\.
.TP
\fB\-\-strict\fR
Do not allow any gem to be updated past latest \fB\-\-patch\fR | \fB\-\-minor\fR | \fB\-\-major\fR\.
.P
When Bundler is resolving what versions to use to satisfy declared requirements in the Gemfile or in parent gems, it looks up all available versions, filters out any versions that don't satisfy the requirement, and then, by default, sorts them from newest to oldest, considering them in that order\.
.P
Providing one of the patch level options (e\.g\. \fB\-\-patch\fR) changes the sort order of the satisfying versions, causing Bundler to consider the latest \fB\-\-patch\fR or \fB\-\-minor\fR version available before other versions\. Note that versions outside the stated patch level could still be resolved to if necessary to find a suitable dependency graph\.
.P
For example, if gem 'foo' is locked at 1\.0\.2, with no gem requirement defined in the Gemfile, and versions 1\.0\.3, 1\.0\.4, 1\.1\.0, 1\.1\.1, 2\.0\.0 all exist, the default order of preference by default (\fB\-\-major\fR) will be "2\.0\.0, 1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2"\.
.P
If the \fB\-\-patch\fR option is used, the order of preference will change to "1\.0\.4, 1\.0\.3, 1\.0\.2, 1\.1\.1, 1\.1\.0, 2\.0\.0"\.
.P
If the \fB\-\-minor\fR option is used, the order of preference will change to "1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2, 2\.0\.0"\.
.P
Combining the \fB\-\-strict\fR option with any of the patch level options will remove any versions beyond the scope of the patch level option, to ensure that no gem is updated that far\.
.P
To continue the previous example, if both \fB\-\-patch\fR and \fB\-\-strict\fR options are used, the available versions for resolution would be "1\.0\.4, 1\.0\.3, 1\.0\.2"\. If \fB\-\-minor\fR and \fB\-\-strict\fR are used, it would be "1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2"\.
.P
Gem requirements as defined in the Gemfile will still be the first determining factor for what versions are available\. If the gem requirement for \fBfoo\fR in the Gemfile is '~> 1\.0', that will accomplish the same thing as providing the \fB\-\-minor\fR and \fB\-\-strict\fR options\.
.SH "PATCH LEVEL EXAMPLES"
Given the following gem specifications:
.IP "" 4
.nf
foo 1\.4\.3, requires: ~> bar 2\.0
foo 1\.4\.4, requires: ~> bar 2\.0
foo 1\.4\.5, requires: ~> bar 2\.1
foo 1\.5\.0, requires: ~> bar 2\.1
foo 1\.5\.1, requires: ~> bar 3\.0
bar with versions 2\.0\.3, 2\.0\.4, 2\.1\.0, 2\.1\.1, 3\.0\.0
.fi
.IP "" 0
.P
Gemfile:
.IP "" 4
.nf
gem 'foo'
.fi
.IP "" 0
.P
Gemfile\.lock:
.IP "" 4
.nf
foo (1\.4\.3)
bar (~> 2\.0)
bar (2\.0\.3)
.fi
.IP "" 0
.P
Cases:
.IP "" 4
.nf
# Command Line Result
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
1 bundle update \-\-patch 'foo 1\.4\.5', 'bar 2\.1\.1'
2 bundle update \-\-patch foo 'foo 1\.4\.5', 'bar 2\.1\.1'
3 bundle update \-\-minor 'foo 1\.5\.1', 'bar 3\.0\.0'
4 bundle update \-\-minor \-\-strict 'foo 1\.5\.0', 'bar 2\.1\.1'
5 bundle update \-\-patch \-\-strict 'foo 1\.4\.4', 'bar 2\.0\.4'
.fi
.IP "" 0
.P
In case 1, bar is upgraded to 2\.1\.1, a minor version increase, because the dependency from foo 1\.4\.5 required it\.
.P
In case 2, only foo is requested to be unlocked, but bar is also allowed to move because it's not a declared dependency in the Gemfile\.
.P
In case 3, bar goes up a whole major release, because a minor increase is preferred now for foo, and when it goes to 1\.5\.1, it requires 3\.0\.0 of bar\.
.P
In case 4, foo is preferred up to a minor version, but 1\.5\.1 won't work because the \-\-strict flag removes bar 3\.0\.0 from consideration since it's a major increment\.
.P
In case 5, both foo and bar have any minor or major increments removed from consideration because of the \-\-strict flag, so the most they can move is up to 1\.4\.4 and 2\.0\.4\.
.SH "RECOMMENDED WORKFLOW"
In general, when working with an application managed with bundler, you should use the following workflow:
.IP "\(bu" 4
After you create your Gemfile(5) for the first time, run
.IP
$ bundle install
.IP "\(bu" 4
Check the resulting \fBGemfile\.lock\fR into version control
.IP
$ git add Gemfile\.lock
.IP "\(bu" 4
When checking out this repository on another development machine, run
.IP
$ bundle install
.IP "\(bu" 4
When checking out this repository on a deployment machine, run
.IP
$ bundle install \-\-deployment
.IP "\(bu" 4
After changing the Gemfile(5) to reflect a new or update dependency, run
.IP
$ bundle install
.IP "\(bu" 4
Make sure to check the updated \fBGemfile\.lock\fR into version control
.IP
$ git add Gemfile\.lock
.IP "\(bu" 4
If bundle install(1) \fIbundle\-install\.1\.html\fR reports a conflict, manually update the specific gems that you changed in the Gemfile(5)
.IP
$ bundle update rails thin
.IP "\(bu" 4
If you want to update all the gems to the latest possible versions that still match the gems listed in the Gemfile(5), run
.IP
$ bundle update \-\-all
.IP "" 0
share/man/man1/bundle-clean.1 0000644 00000001326 15173517734 0011707 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CLEAN" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-clean\fR \- Cleans up unused gems in your bundler directory
.SH "SYNOPSIS"
\fBbundle clean\fR [\-\-dry\-run] [\-\-force]
.SH "DESCRIPTION"
This command will remove all unused gems in your bundler directory\. This is useful when you have made many changes to your gem dependencies\.
.SH "OPTIONS"
.TP
\fB\-\-dry\-run\fR
Print the changes, but do not clean the unused gems\.
.TP
\fB\-\-force\fR
Forces cleaning up unused gems even if Bundler is configured to use globally installed gems\. As a consequence, removes all system gems except for the ones in the current application\.
share/man/man1/bundle-plugin.1 0000644 00000004162 15173517734 0012124 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-PLUGIN" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-plugin\fR \- Manage Bundler plugins
.SH "SYNOPSIS"
\fBbundle plugin\fR install PLUGINS [\-\-source=\fISOURCE\fR] [\-\-version=\fIversion\fR] [\-\-git=\fIgit\-url\fR] [\-\-branch=\fIbranch\fR|\-\-ref=\fIrev\fR] [\-\-path=\fIpath\fR]
.br
\fBbundle plugin\fR uninstall PLUGINS
.br
\fBbundle plugin\fR list
.br
\fBbundle plugin\fR help [COMMAND]
.SH "DESCRIPTION"
You can install, uninstall, and list plugin(s) with this command to extend functionalities of Bundler\.
.SH "SUB\-COMMANDS"
.SS "install"
Install the given plugin(s)\.
.TP
\fBbundle plugin install bundler\-graph\fR
Install bundler\-graph gem from globally configured sources (defaults to RubyGems\.org)\. The global source, specified in source in Gemfile is ignored\.
.TP
\fBbundle plugin install bundler\-graph \-\-source https://example\.com\fR
Install bundler\-graph gem from example\.com\. The global source, specified in source in Gemfile is not considered\.
.TP
\fBbundle plugin install bundler\-graph \-\-version 0\.2\.1\fR
You can specify the version of the gem via \fB\-\-version\fR\.
.TP
\fBbundle plugin install bundler\-graph \-\-git https://github\.com/rubygems/bundler\-graph\fR
Install bundler\-graph gem from Git repository\. You can use standard Git URLs like:
.IP
\fBssh://[user@]host\.xz[:port]/path/to/repo\.git\fR
.br
\fBhttp[s]://host\.xz[:port]/path/to/repo\.git\fR
.br
\fB/path/to/repo\fR
.br
\fBfile:///path/to/repo\fR
.IP
When you specify \fB\-\-git\fR, you can use \fB\-\-branch\fR or \fB\-\-ref\fR to specify any branch, tag, or commit hash (revision) to use\.
.TP
\fBbundle plugin install bundler\-graph \-\-path \.\./bundler\-graph\fR
Install bundler\-graph gem from a local path\.
.SS "uninstall"
Uninstall the plugin(s) specified in PLUGINS\.
.SS "list"
List the installed plugins and available commands\.
.P
No options\.
.SS "help"
Describe subcommands or one specific subcommand\.
.P
No options\.
.SH "SEE ALSO"
.IP "\(bu" 4
How to write a Bundler plugin \fIhttps://bundler\.io/guides/bundler_plugins\.html\fR
.IP "" 0
share/man/man1/erb.1 0000644 00000006376 15173517734 0010140 0 ustar 00 .\"Ruby is copyrighted by Yukihiro Matsumoto <matz@netlab.jp>.
.Dd December 16, 2018
.Dt ERB \&1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm erb
.Nd Ruby Templating
.Sh SYNOPSIS
.Nm
.Op Fl -version
.Op Fl UPdnvx
.Op Fl E Ar ext Ns Op Ns : Ns int
.Op Fl S Ar level
.Op Fl T Ar mode
.Op Fl r Ar library
.Op Fl -
.Op file ...
.Pp
.Sh DESCRIPTION
.Nm
is a command line front-end for
.Li "ERB"
library, which is an implementation of eRuby.
.Pp
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.
.Pp
.Nm
is a part of
.Nm Ruby .
.Pp
.Sh OPTIONS
.Bl -tag -width "1234567890123" -compact
.Pp
.It Fl -version
Prints the version of
.Nm .
.Pp
.It Fl E Ar external Ns Op : Ns Ar internal
.It Fl -encoding Ar external Ns Op : Ns Ar internal
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
.Pp
You can omit the one for internal encodings, then the value
.Pf ( Li "Encoding.default_internal" ) will be nil.
.Pp
.It Fl P
Disables ruby code evaluation for lines beginning with
.Li "%" .
.Pp
.It Fl S Ar level
Specifies the safe level in which eRuby script will run.
.Pp
.It Fl T Ar mode
Specifies trim mode (default 0).
.Ar mode
can be one of
.Bl -hang -offset indent
.It Sy 0
EOL remains after the embedded ruby script is evaluated.
.Pp
.It Sy 1
EOL is removed if the line ends with
.Li "%>" .
.Pp
.It Sy 2
EOL is removed if the line starts with
.Li "<%"
and ends with
.Li "%>" .
.Pp
.It Sy -
EOL is removed if the line ends with
.Li "-%>" .
And leading whitespaces are removed if the erb directive starts with
.Li "<%-" .
.Pp
.El
.It Fl r
Load a library
.Pp
.It Fl U
can be one of
Sets the default value for internal encodings
.Pf ( Li "Encoding.default_internal" ) to UTF-8.
.Pp
.It Fl d
.It Fl -debug
Turns on debug mode.
.Li "$DEBUG"
will be set to true.
.Pp
.It Fl h
.It Fl -help
Prints a summary of the options.
.Pp
.It Fl n
Used with
.Fl x .
Prepends the line number to each line in the output.
.Pp
.It Fl v
Enables verbose mode.
.Li "$VERBOSE"
will be set to true.
.Pp
.It Fl x
Converts the eRuby script into Ruby script and prints it without line numbers.
.Pp
.El
.Pp
.Sh EXAMPLES
Here is an eRuby script
.Bd -literal -offset indent
<?xml version="1.0" ?>
<% require 'prime' -%>
<erb-example>
<calc><%= 1+1 %></calc>
<var><%= __FILE__ %></var>
<library><%= Prime.each(10).to_a.join(", ") %></library>
</erb-example>
.Ed
.Pp
Command
.Dl "% erb -T - example.erb"
prints
.Bd -literal -offset indent
<?xml version="1.0" ?>
<erb-example>
<calc>2</calc>
<var>example.erb</var>
<library>2, 3, 5, 7</library>
</erb-example>
.Ed
.Pp
.Sh SEE ALSO
.Xr ruby 1 .
.Pp
And see
.Xr ri 1
documentation for
.Li "ERB"
class.
.Pp
.Sh REPORTING BUGS
.Bl -bullet
.It
Security vulnerabilities should be reported via an email to
.Mt security@ruby-lang.org .
Reported problems will be published after being fixed.
.Pp
.It
Other bugs and feature requests can be reported via the
Ruby Issue Tracking System
.Pq Lk https://bugs.ruby-lang.org/ .
Do not report security vulnerabilities
via this system because it publishes the vulnerabilities immediately.
.El
.Sh AUTHORS
Written by Masatoshi SEKI.
share/man/man1/bundle-info.1 0000644 00000000726 15173517734 0011563 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INFO" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-info\fR \- Show information for the given gem in your bundle
.SH "SYNOPSIS"
\fBbundle info\fR [GEM_NAME] [\-\-path]
.SH "DESCRIPTION"
Given a gem name present in your bundle, print the basic information about it such as homepage, version, path and summary\.
.SH "OPTIONS"
.TP
\fB\-\-path\fR
Print the path of the given gem
share/man/man1/bundle-open.1 0000644 00000001426 15173517734 0011567 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-OPEN" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-open\fR \- Opens the source directory for a gem in your bundle
.SH "SYNOPSIS"
\fBbundle open\fR [GEM] [\-\-path=PATH]
.SH "DESCRIPTION"
Opens the source directory of the provided GEM in your editor\.
.P
For this to work the \fBEDITOR\fR or \fBBUNDLER_EDITOR\fR environment variable has to be set\.
.P
Example:
.IP "" 4
.nf
bundle open 'rack'
.fi
.IP "" 0
.P
Will open the source directory for the 'rack' gem in your bundle\.
.IP "" 4
.nf
bundle open 'rack' \-\-path 'README\.md'
.fi
.IP "" 0
.P
Will open the README\.md file of the 'rack' gem source in your bundle\.
.SH "OPTIONS"
.TP
\fB\-\-path\fR
Specify GEM source relative path to open\.
share/man/man1/bundle-inject.1 0000644 00000001457 15173517734 0012106 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INJECT" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-inject\fR \- Add named gem(s) with version requirements to Gemfile
.SH "SYNOPSIS"
\fBbundle inject\fR [GEM] [VERSION]
.SH "DESCRIPTION"
Adds the named gem(s) with their version requirements to the resolved [\fBGemfile(5)\fR][Gemfile(5)]\.
.P
This command will add the gem to both your [\fBGemfile(5)\fR][Gemfile(5)] and Gemfile\.lock if it isn't listed yet\.
.P
Example:
.IP "" 4
.nf
bundle install
bundle inject 'rack' '> 0'
.fi
.IP "" 0
.P
This will inject the 'rack' gem with a version greater than 0 in your [\fBGemfile(5)\fR][Gemfile(5)] and Gemfile\.lock\.
.P
The \fBbundle inject\fR command was deprecated in Bundler 2\.1 and will be removed in Bundler 3\.0\.
share/man/man1/ruby.1 0000644 00000052046 15173517734 0010344 0 ustar 00 .\"Ruby is copyrighted by Yukihiro Matsumoto <matz@netlab.jp>.
.Dd April 14, 2018
.Dt RUBY \&1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm ruby
.Nd Interpreted object-oriented scripting language
.Sh SYNOPSIS
.Nm
.Op Fl -copyright
.Op Fl -version
.Op Fl SUacdlnpswvy
.Op Fl 0 Ns Op Ar octal
.Op Fl C Ar directory
.Op Fl E Ar external Ns Op : Ns Ar internal
.Op Fl F Ns Op Ar pattern
.Op Fl I Ar directory
.Op Fl K Ns Op Ar c
.Op Fl T Ns Op Ar level
.Op Fl W Ns Op Ar level
.Op Fl e Ar command
.Op Fl i Ns Op Ar extension
.Op Fl r Ar library
.Op Fl x Ns Op Ar directory
.Op Fl - Ns Bro Cm enable Ns | Ns Cm disable Brc Ns - Ns Ar FEATURE
.Op Fl -dump Ns = Ns Ar target
.Op Fl -verbose
.Op Fl -crash-report Ns = Ns Ar template
.Op Fl -
.Op Ar program_file
.Op Ar argument ...
.Sh DESCRIPTION
Ruby is an interpreted scripting language for quick and easy
object-oriented programming. It has many features to process text
files and to do system management tasks (like in Perl). It is simple,
straight-forward, and extensible.
.Pp
If you want a language for easy object-oriented programming, or you
don't like the Perl ugliness, or you do like the concept of LISP, but
don't like too many parentheses, Ruby might be your language of
choice.
.Sh FEATURES
Ruby's features are as follows:
.Bl -tag -width 6n
.It Sy "Interpretive"
Ruby is an interpreted language, so you don't have to recompile
programs written in Ruby to execute them.
.Pp
.It Sy "Variables have no type (dynamic typing)"
Variables in Ruby can contain data of any type. You don't have to
worry about variable typing. Consequently, it has a weaker compile
time check.
.Pp
.It Sy "No declaration needed"
You can use variables in your Ruby programs without any declarations.
Variable names denote their scope - global, class, instance, or local.
.Pp
.It Sy "Simple syntax"
Ruby has a simple syntax influenced slightly from Eiffel.
.Pp
.It Sy "No user-level memory management"
Ruby has automatic memory management. Objects no longer referenced
from anywhere are automatically collected by the garbage collector
built into the interpreter.
.Pp
.It Sy "Everything is an object"
Ruby is a purely object-oriented language, and was so since its
creation. Even such basic data as integers are seen as objects.
.Pp
.It Sy "Class, inheritance, and methods"
Being an object-oriented language, Ruby naturally has basic
features like classes, inheritance, and methods.
.Pp
.It Sy "Singleton methods"
Ruby has the ability to define methods for certain objects. For
example, you can define a press-button action for certain widget by
defining a singleton method for the button. Or, you can make up your
own prototype based object system using singleton methods, if you want
to.
.Pp
.It Sy "Mix-in by modules"
Ruby intentionally does not have the multiple inheritance as it is a
source of confusion. Instead, Ruby has the ability to share
implementations across the inheritance tree. This is often called a
.Sq Mix-in .
.Pp
.It Sy "Iterators"
Ruby has iterators for loop abstraction.
.Pp
.It Sy "Closures"
In Ruby, you can objectify the procedure.
.Pp
.It Sy "Text processing and regular expressions"
Ruby has a bunch of text processing features like in Perl.
.Pp
.It Sy "M17N, character set independent"
Ruby supports multilingualized programming. Easy to process texts
written in many different natural languages and encoded in many
different character encodings, without dependence on Unicode.
.Pp
.It Sy "Bignums"
With built-in bignums, you can for example calculate factorial(400).
.Pp
.It Sy "Reflection and domain specific languages"
Class is also an instance of the Class class. Definition of classes and methods
is an expression just as 1+1 is. So your programs can even write and modify programs.
Thus you can write your application in your own programming language on top of Ruby.
.Pp
.It Sy "Exception handling"
As in Java(tm).
.Pp
.It Sy "Direct access to the OS"
Ruby can use most
.Ux
system calls, often used in system programming.
.Pp
.It Sy "Dynamic loading"
On most
.Ux
systems, you can load object files into the Ruby interpreter
on-the-fly.
.It Sy "Rich libraries"
In addition to the
.Dq builtin libraries
and
.Dq standard libraries
that are bundled with Ruby, a vast amount of third-party libraries
.Pq Dq gems
are available via the package management system called
.Sq RubyGems ,
namely the
.Xr gem 1
command. Visit RubyGems.org
.Pq Lk https://rubygems.org/
to find the gems you need, and explore GitHub
.Pq Lk https://github.com/
to see how they are being developed and used.
.El
.Pp
.Sh OPTIONS
The Ruby interpreter accepts the following command-line options (switches).
They are quite similar to those of
.Xr perl 1 .
.Bl -tag -width "1234567890123" -compact
.Pp
.It Fl -copyright
Prints the copyright notice, and quits immediately without running any
script.
.Pp
.It Fl -version
Prints the version of the Ruby interpreter, and quits immediately without
running any script.
.Pp
.It Fl 0 Ns Op Ar octal
(The digit
.Dq zero . )
Specifies the input record separator
.Pf ( Li "$/" )
as an octal number. If no digit is given, the null character is taken
as the separator. Other switches may follow the digits.
.Fl 00
turns Ruby into paragraph mode.
.Fl 0777
makes Ruby read whole file at once as a single string since there is
no legal character with that value.
.Pp
.It Fl C Ar directory
.It Fl X Ar directory
Causes Ruby to switch to the directory.
.Pp
.It Fl E Ar external Ns Op : Ns Ar internal
.It Fl -encoding Ar external Ns Op : Ns Ar internal
Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).
.Pp
You can omit the one for internal encodings, then the value
.Pf ( Li "Encoding.default_internal" ) will be nil.
.Pp
.It Fl -external-encoding Ns = Ns Ar encoding
.It Fl -internal-encoding Ns = Ns Ar encoding
Specify the default external or internal character encoding
.Pp
.It Fl F Ar pattern
Specifies input field separator
.Pf ( Li "$;" ) .
.Pp
.It Fl I Ar directory
Used to tell Ruby where to load the library scripts. Directory path
will be added to the load-path variable
.Pf ( Li "$:" ) .
.Pp
.It Fl K Ar kcode
Specifies KANJI (Japanese) encoding. The default value for script encodings
.Pf ( Li "__ENCODING__" ) and external encodings ( Li "Encoding.default_external" ) will be the specified one.
.Ar kcode
can be one of
.Bl -hang -offset indent
.It Sy e
EUC-JP
.Pp
.It Sy s
Windows-31J (CP932)
.Pp
.It Sy u
UTF-8
.Pp
.It Sy n
ASCII-8BIT (BINARY)
.El
.Pp
.It Fl S
Makes Ruby use the
.Ev PATH
environment variable to search for script, unless its name begins
with a slash. This is used to emulate
.Li #!
on machines that don't support it, in the following manner:
.Bd -literal -offset indent
#! /usr/local/bin/ruby
# This line makes the next one a comment in Ruby \e
exec /usr/local/bin/ruby -S $0 $*
.Ed
.Pp
On some systems
.Li "$0"
does not always contain the full pathname, so you need the
.Fl S
switch to tell Ruby to search for the script if necessary (to handle embedded
spaces and such). A better construct than
.Li "$*"
would be
.Li ${1+"$@"} ,
but it does not work if the script is being interpreted by
.Xr csh 1 .
.Pp
.It Fl T Ns Op Ar level=1
Turns on taint checks at the specified level (default 1).
.Pp
.It Fl U
Sets the default value for internal encodings
.Pf ( Li "Encoding.default_internal" ) to UTF-8.
.Pp
.It Fl W Ns Op Ar level=2
Turns on verbose mode at the specified level without printing the version
message at the beginning. The level can be;
.Bl -hang -offset indent
.It Sy 0
Verbose mode is "silence". It sets the
.Li "$VERBOSE"
to nil.
.Pp
.It Sy 1
Verbose mode is "medium". It sets the
.Li "$VERBOSE"
to false.
.Pp
.It Sy 2 (default)
Verbose mode is "verbose". It sets the
.Li "$VERBOSE"
to true.
.Fl W Ns
2 is the same as
.Fl w
.
.El
.Pp
.It Fl a
Turns on auto-split mode when used with
.Fl n
or
.Fl p .
In auto-split mode, Ruby executes
.Dl $F = $_.split
at beginning of each loop.
.Pp
.It Fl -backtrace-limit Ns = Ns Ar num
Limits the maximum length of backtraces to
.Ar num
lines (default -1, meaning no limit).
.Pp
.It Fl c
Causes Ruby to check the syntax of the script and exit without
executing. If there are no syntax errors, Ruby will print
.Dq Syntax OK
to the standard output.
.Pp
.It Fl d
.It Fl -debug
Turns on debug mode.
.Li "$DEBUG"
will be set to true.
.Pp
.It Fl e Ar command
Specifies script from command-line while telling Ruby not to search
the rest of the arguments for a script file name.
.Pp
.It Fl h
.It Fl -help
Prints a summary of the options.
.Pp
.It Fl i Ar extension
Specifies in-place-edit mode. The extension, if specified, is added
to old file name to make a backup copy. For example:
.Bd -literal -offset indent
% echo matz > /tmp/junk
% cat /tmp/junk
matz
% ruby -p -i.bak -e '$_.upcase!' /tmp/junk
% cat /tmp/junk
MATZ
% cat /tmp/junk.bak
matz
.Ed
.Pp
.It Fl l
(The lowercase letter
.Dq ell . )
Enables automatic line-ending processing, which means to firstly set
.Li "$\e"
to the value of
.Li "$/" ,
and secondly chops every line read using
.Li chomp! .
.Pp
.It Fl n
Causes Ruby to assume the following loop around your script, which
makes it iterate over file name arguments somewhat like
.Nm sed
.Fl n
or
.Nm awk .
.Bd -literal -offset indent
while gets
...
end
.Ed
.Pp
.It Fl p
Acts mostly same as -n switch, but print the value of variable
.Li "$_"
at the each end of the loop. For example:
.Bd -literal -offset indent
% echo matz | ruby -p -e '$_.tr! "a-z", "A-Z"'
MATZ
.Ed
.Pp
.It Fl r Ar library
Causes Ruby to load the library using require. It is useful when using
.Fl n
or
.Fl p .
.Pp
.It Fl s
Enables some switch parsing for switches after script name but before
any file name arguments (or before a
.Fl - ) .
Any switches found there are removed from
.Li ARGV
and set the corresponding variable in the script. For example:
.Bd -literal -offset indent
#! /usr/local/bin/ruby -s
# prints "true" if invoked with `-xyz' switch.
print "true\en" if $xyz
.Ed
.Pp
.It Fl v
Enables verbose mode. Ruby will print its version at the beginning
and set the variable
.Li "$VERBOSE"
to true. Some methods print extra messages if this variable is true.
If this switch is given, and no other switches are present, Ruby quits
after printing its version.
.Pp
.It Fl w
Enables verbose mode without printing version message at the
beginning. It sets the
.Li "$VERBOSE"
variable to true.
.Pp
.It Fl x Ns Op Ar directory
Tells Ruby that the script is embedded in a message. Leading garbage
will be discarded until the first line that starts with
.Dq #!
and contains the string,
.Dq ruby .
Any meaningful switches on that line will be applied. The end of the script
must be specified with either
.Li EOF ,
.Li "^D" ( Li "control-D" ) ,
.Li "^Z" ( Li "control-Z" ) ,
or the reserved word
.Li __END__ .
If the directory name is specified, Ruby will switch to that directory
before executing script.
.Pp
.It Fl y
.It Fl -yydebug
This option is not guaranteed to be compatible.
.Pp
Turns on compiler debug mode. Ruby will print a bunch of internal
state messages during compilation. Only specify this switch you are going to
debug the Ruby interpreter.
.Pp
.It Fl -disable- Ns Ar FEATURE
.It Fl -enable- Ns Ar FEATURE
Disables (or enables) the specified
.Ar FEATURE .
.Bl -tag -width "--disable-rubyopt" -compact
.It Fl -disable-gems
.It Fl -enable-gems
Disables (or enables) RubyGems libraries. By default, Ruby will load the latest
version of each installed gem. The
.Li Gem
constant is true if RubyGems is enabled, false if otherwise.
.Pp
.It Fl -disable-rubyopt
.It Fl -enable-rubyopt
Ignores (or considers) the
.Ev RUBYOPT
environment variable. By default, Ruby considers the variable.
.Pp
.It Fl -disable-all
.It Fl -enable-all
Disables (or enables) all features.
.Pp
.El
.Pp
.It Fl -dump Ns = Ns Ar target
Dump some information.
.Pp
Prints the specified target.
.Ar target
can be one of:
.Bl -hang -offset indent
.It Sy version
Print version description (same as
.Fl -version).
.It Sy usage
Print a brief usage message (same as
.Fl h).
.It Sy help
Show long help message (same as
.Fl -help).
.It Sy syntax
Check syntax (same as
.Fl c
.Fl -yydebug).
.Pp
.El
.Pp
Or one of the following, which are intended for debugging the interpreter:
.Bl -hang -offset indent -tag -width "parsetree_with_comment"
.It Sy yydebug
Enable compiler debug mode (same as
.Fl -yydebug).
.It Sy parsetree
Print a textual representation of the Ruby AST for the program.
.It Sy parsetree_with_comment
Print a textual representation of the Ruby AST for the program, but with each node annoted with the associated Ruby source code.
.It Sy insns
Print a list of disassembled bytecode instructions.
.It Sy insns_without_opt
Print the list of disassembled bytecode instructions before various optimizations have been applied.
.El
.Pp
.It Fl -verbose
Enables verbose mode without printing version message at the
beginning. It sets the
.Li "$VERBOSE"
variable to true.
If this switch is given, and no script arguments (script file or
.Fl e
options) are present, Ruby quits immediately.
.Pp
.It Fl -crash-report Ns = Ns Ar template
Sets the template of path name to save crash report.
See
.Ev RUBY_CRASH_REPORT
environment variable for details.
.El
.Pp
.Sh ENVIRONMENT
.Bl -tag -width "RUBYSHELL" -compact
.It Ev RUBYLIB
A colon-separated list of directories that are added to Ruby's
library load path
.Pf ( Li "$:" ) . Directories from this environment variable are searched
before the standard load path is searched.
.Pp
e.g.:
.Dl RUBYLIB="$HOME/lib/ruby:$HOME/lib/rubyext"
.Pp
.It Ev RUBYOPT
Additional Ruby options.
.Pp
e.g.
.Dl RUBYOPT="-w -Ke"
.Pp
Note that RUBYOPT can contain only
.Fl d , Fl E , Fl I , Fl K , Fl r , Fl T , Fl U , Fl v , Fl w , Fl W, Fl -debug ,
.Fl -disable- Ns Ar FEATURE
and
.Fl -enable- Ns Ar FEATURE .
.Pp
.It Ev RUBYPATH
A colon-separated list of directories that Ruby searches for
Ruby programs when the
.Fl S
flag is specified. This variable precedes the
.Ev PATH
environment variable.
.Pp
.It Ev RUBYSHELL
The path to the system shell command. This environment variable is
enabled for only mswin32, mingw32, and OS/2 platforms. If this
variable is not defined, Ruby refers to
.Ev COMSPEC .
.Pp
.It Ev PATH
Ruby refers to the
.Ev PATH
environment variable on calling Kernel#system.
.El
.Pp
And Ruby depends on some RubyGems related environment variables unless RubyGems is disabled.
See the help of
.Xr gem 1
as below.
.Bd -literal -offset indent
% gem help
.Ed
.Pp
.Sh GC ENVIRONMENT
The Ruby garbage collector (GC) tracks objects in fixed-sized slots,
but each object may have auxiliary memory allocations handled by the
malloc family of C standard library calls (
.Xr malloc 3 ,
.Xr calloc 3 ,
and
.Xr realloc 3 ) .
In this documentatation, the "heap" refers to the Ruby object heap
of fixed-sized slots, while "malloc" refers to auxiliary
allocations commonly referred to as the "process heap".
Thus there are at least two possible ways to trigger GC:
.Bl -hang -offset indent
.It Sy 1
Reaching the object limit.
.It Sy 2
Reaching the malloc limit.
.Pp
.El
In Ruby 2.1, the generational GC was introduced and the limits are divided
into young and old generations, providing two additional ways to trigger
a GC:
.Bl -hang -offset indent
.It Sy 3
Reaching the old object limit.
.It Sy 4
Reaching the old malloc limit.
.El
.Pp
There are currently 4 possible areas where the GC may be tuned by
the following 11 environment variables:
.Bl -hang -compact -width "RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR"
.It Ev RUBY_GC_HEAP_INIT_SLOTS
Initial allocation slots. Applies to all slot sizes. Introduced in Ruby 2.1, default: 10000.
.Pp
.It Ev RUBY_GC_HEAP_%d_INIT_SLOTS
Initial allocation of slots in a specific heap.
The available heaps can be found in the keys of `GC.stat_heap`.
Introduced in Ruby 3.3.
.Pp
.It Ev RUBY_GC_HEAP_FREE_SLOTS
Prepare at least this amount of slots after GC.
Allocate this number slots if there are not enough slots.
Introduced in Ruby 2.1, default: 4096
.Pp
.It Ev RUBY_GC_HEAP_GROWTH_FACTOR
Increase allocation rate of heap slots by this factor.
Introduced in Ruby 2.1, default: 1.8, minimum: 1.0 (no growth)
.Pp
.It Ev RUBY_GC_HEAP_GROWTH_MAX_SLOTS
Allocation rate is limited to this number of slots,
preventing excessive allocation due to RUBY_GC_HEAP_GROWTH_FACTOR.
Introduced in Ruby 2.1, default: 0 (no limit)
.Pp
.It Ev RUBY_GC_HEAP_OLDOBJECT_LIMIT_FACTOR
Perform a full GC when the number of old objects is more than R * N,
where R is this factor and N is the number of old objects after the
last full GC.
Introduced in Ruby 2.1.1, default: 2.0
.Pp
.It Ev RUBY_GC_MALLOC_LIMIT
The initial limit of young generation allocation from the malloc-family.
GC will start when this limit is reached.
Default: 16MB
.Pp
.It Ev RUBY_GC_MALLOC_LIMIT_MAX
The maximum limit of young generation allocation from malloc before GC starts.
Prevents excessive malloc growth due to RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR.
Introduced in Ruby 2.1, default: 32MB.
.Pp
.It Ev RUBY_GC_MALLOC_LIMIT_GROWTH_FACTOR
Increases the limit of young generation malloc calls, reducing
GC frequency but increasing malloc growth until RUBY_GC_MALLOC_LIMIT_MAX
is reached.
Introduced in Ruby 2.1, default: 1.4, minimum: 1.0 (no growth)
.Pp
.It Ev RUBY_GC_OLDMALLOC_LIMIT
The initial limit of old generation allocation from malloc,
a full GC will start when this limit is reached.
Introduced in Ruby 2.1, default: 16MB
.Pp
.It Ev RUBY_GC_OLDMALLOC_LIMIT_MAX
The maximum limit of old generation allocation from malloc before a
full GC starts.
Prevents excessive malloc growth due to RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR.
Introduced in Ruby 2.1, default: 128MB
.Pp
.It Ev RUBY_GC_OLDMALLOC_LIMIT_GROWTH_FACTOR
Increases the limit of old generation malloc allocation, reducing full
GC frequency but increasing malloc growth until RUBY_GC_OLDMALLOC_LIMIT_MAX
is reached.
Introduced in Ruby 2.1, default: 1.2, minimum: 1.0 (no growth)
.Pp
.El
.Sh STACK SIZE ENVIRONMENT
Stack size environment variables are implementation-dependent and
subject to change with different versions of Ruby. The VM stack is used
for pure-Ruby code and managed by the virtual machine. Machine stack is
used by the operating system and its usage is dependent on C extensions
as well as C compiler options. Using lower values for these may allow
applications to keep more Fibers or Threads running; but increases the
chance of SystemStackError exceptions and segmentation faults (SIGSEGV).
These environment variables are available since Ruby 2.0.0.
All values are specified in bytes.
.Pp
.Bl -hang -compact -width "RUBY_THREAD_MACHINE_STACK_SIZE"
.It Ev RUBY_THREAD_VM_STACK_SIZE
VM stack size used at thread creation.
default: 524288 (32-bit CPU) or 1048575 (64-bit)
.Pp
.It Ev RUBY_THREAD_MACHINE_STACK_SIZE
Machine stack size used at thread creation.
default: 524288 or 1048575
.Pp
.It Ev RUBY_FIBER_VM_STACK_SIZE
VM stack size used at fiber creation.
default: 65536 or 131072
.Pp
.It Ev RUBY_FIBER_MACHINE_STACK_SIZE
Machine stack size used at fiber creation.
default: 262144 or 524288
.Pp
.El
.Sh CRASH REPORT ENVIRONMENT
.Pp
.Bl -tag -compact -width "RUBY_CRASH_REPORT"
.It Ev RUBY_CRASH_REPORT
The template of path name to save crash report.
default: none
.El
.Ss Naming crash report files
The template can contain
.Li \fB%\fP
specifiers which are substituted by the following values when a crash
report file is created:
.Pp
.Bl -hang -compact -width "%NNN"
.It Li \fB%%\fP
A single
.Li \fB%\fP
character.
.It Li \fB%e\fP
Basename of executable.
.It Li \fB%E\fP
Pathname of executable,
with slashes (\fB/\fP) replaced by exclamation marks (\fB!\fP).
.It Li \fB%f\fP
Basename of the program name,
.Li "$0" .
.It Li \fB%F\fP
Pathname of the program name,
.Li "$0",
with slashes (\fB/\fP) replaced by exclamation marks (\fB!\fP).
.It Li \fB%p\fP
PID of dumped process.
.It Li \fB%t\fP
Time of dump, expressed as seconds since the
Epoch, 1970-01-01 00:00:00 +0000 (UTC).
.It Li \fB%NNN\fP
A character code in octal.
.El
.Pp
A single
.Li \fB%\fP
at the end of the template is dropped from the core filename, as is
the combination of a
.Li \fB%\fP
followed by any character other than those listed above. All other
characters in the template become a literal part of the core filename.
The template may include \(aq/\(aq characters, which are interpreted
as delimiters for directory names.
.Ss Piping crash reports to a program
If the first character of this file is a pipe symbol (\fB|\fP),
then the remainder of the line is interpreted as the command-line for
a program (or script) that is to be executed.
.Pp
The pipe template is split on spaces into an argument list before the
template parameters are expanded.
.Sh SEE ALSO
.Bl -hang -compact -width "https://www.ruby-toolbox.com/"
.It Lk https://www.ruby-lang.org/
The official web site.
.It Lk https://www.ruby-toolbox.com/
Comprehensive catalog of Ruby libraries.
.El
.Pp
.Sh REPORTING BUGS
.Bl -bullet
.It
Security vulnerabilities should be reported via an email to
.Mt security@ruby-lang.org .
Reported problems will be published after being fixed.
.Pp
.It
Other bugs and feature requests can be reported via the
Ruby Issue Tracking System
.Pq Lk https://bugs.ruby-lang.org/ .
Do not report security vulnerabilities
via this system because it publishes the vulnerabilities immediately.
.El
.Sh AUTHORS
Ruby is designed and implemented by
.An Yukihiro Matsumoto Aq matz@netlab.jp .
.Pp
See
.Aq Lk https://github.com/ruby/ruby/graphs/contributors
for contributors to Ruby.
share/man/man1/bundle-viz.1 0000644 00000002316 15173517734 0011435 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-VIZ" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-viz\fR \- Generates a visual dependency graph for your Gemfile
.SH "SYNOPSIS"
\fBbundle viz\fR [\-\-file=FILE] [\-\-format=FORMAT] [\-\-requirements] [\-\-version] [\-\-without=GROUP GROUP]
.SH "DESCRIPTION"
\fBviz\fR generates a PNG file of the current \fBGemfile(5)\fR as a dependency graph\. \fBviz\fR requires the ruby\-graphviz gem (and its dependencies)\.
.P
The associated gems must also be installed via \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR\.
.P
\fBviz\fR command was deprecated in Bundler 2\.2\. Use bundler\-graph plugin \fIhttps://github\.com/rubygems/bundler\-graph\fR instead\.
.SH "OPTIONS"
.TP
\fB\-\-file\fR, \fB\-f\fR
The name to use for the generated file\. See \fB\-\-format\fR option
.TP
\fB\-\-format\fR, \fB\-F\fR
This is output format option\. Supported format is png, jpg, svg, dot \|\.\|\.\|\.
.TP
\fB\-\-requirements\fR, \fB\-R\fR
Set to show the version of each required dependency\.
.TP
\fB\-\-version\fR, \fB\-v\fR
Set to show each gem version\.
.TP
\fB\-\-without\fR, \fB\-W\fR
Exclude gems that are part of the specified named group\.
share/man/man1/bundle-console.1 0000644 00000003167 15173517734 0012274 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CONSOLE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-console\fR \- Deprecated way to open an IRB session with the bundle pre\-loaded
.SH "SYNOPSIS"
\fBbundle console\fR [GROUP]
.SH "DESCRIPTION"
Starts an interactive Ruby console session in the context of the current bundle\.
.P
If no \fBGROUP\fR is specified, all gems in the \fBdefault\fR group in the Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR are preliminarily loaded\.
.P
If \fBGROUP\fR is specified, all gems in the given group in the Gemfile in addition to the gems in \fBdefault\fR group are loaded\. Even if the given group does not exist in the Gemfile, IRB console starts without any warning or error\.
.P
The environment variable \fBBUNDLE_CONSOLE\fR or \fBbundle config set console\fR can be used to change the shell from the following:
.IP "\(bu" 4
\fBirb\fR (default)
.IP "\(bu" 4
\fBpry\fR (https://github\.com/pry/pry)
.IP "\(bu" 4
\fBripl\fR (https://github\.com/cldwalker/ripl)
.IP "" 0
.P
\fBbundle console\fR uses irb by default\. An alternative Pry or Ripl can be used with \fBbundle console\fR by adjusting the \fBconsole\fR Bundler setting\. Also make sure that \fBpry\fR or \fBripl\fR is in your Gemfile\.
.SH "EXAMPLE"
.nf
$ bundle config set console pry
$ bundle console
Resolving dependencies\|\.\|\.\|\.
[1] pry(main)>
.fi
.SH "NOTES"
This command was deprecated in Bundler 2\.1 and will be removed in 3\.0\. Use \fBbin/console\fR script, which can be generated by \fBbundle gem <NAME>\fR\.
.SH "SEE ALSO"
Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR
share/man/man1/ri.1 0000644 00000012343 15173517734 0007771 0 ustar 00 .\"Ruby is copyrighted by Yukihiro Matsumoto <matz@netlab.jp>.
.Dd April 20, 2017
.Dt RI \&1 "Ruby Programmer's Reference Guide"
.Os UNIX
.Sh NAME
.Nm ri
.Nd Ruby API reference front end
.Sh SYNOPSIS
.Nm
.Op Fl ahilTv
.Op Fl d Ar DIRNAME
.Op Fl f Ar FORMAT
.Op Fl w Ar WIDTH
.Op Fl - Ns Oo Cm no- Oc Ns Cm pager
.Op Fl -server Ns Oo = Ns Ar PORT Oc
.Op Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs
.Op Fl -no-standard-docs
.Op Fl - Ns Oo Cm no- Oc Ns Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc
.Op Fl - Ns Oo Cm no- Oc Ns Cm profile
.Op Fl -dump Ns = Ns Ar CACHE
.Op Ar name ...
.Sh DESCRIPTION
.Nm
is a command-line front end for the Ruby API reference.
You can search and read the API reference for classes and methods with
.Nm .
.Pp
.Nm
is a part of Ruby.
.Pp
.Ar name
can be:
.Bl -diag -offset indent
.It Class | Module | Module::Class
.Pp
.It Class::method | Class#method | Class.method | method
.Pp
.It gem_name: | gem_name:README | gem_name:History
.El
.Pp
All class names may be abbreviated to their minimum unambiguous form.
If a name is ambiguous, all valid options will be listed.
.Pp
A
.Ql \&.
matches either class or instance methods, while #method
matches only instance and ::method matches only class methods.
.Pp
README and other files may be displayed by prefixing them with the gem name
they're contained in. If the gem name is followed by a
.Ql \&:
all files in the gem will be shown.
The file name extension may be omitted where it is unambiguous.
.Pp
For example:
.Bd -literal -offset indent
ri Fil
ri File
ri File.new
ri zip
ri rdoc:README
.Ed
.Pp
Note that shell quoting or escaping may be required for method names
containing punctuation:
.Bd -literal -offset indent
ri 'Array.[]'
ri compact\e!
.Ed
.Pp
To see the default directories
.Nm
will search, run:
.Bd -literal -offset indent
ri --list-doc-dirs
.Ed
.Pp
Specifying the
.Fl -system , Fl -site , Fl -home , Fl -gems ,
or
.Fl -doc-dir
options will limit
.Nm
to searching only the specified directories.
.Pp
.Nm
options may be set in the
.Ev RI
environment variable.
.Pp
The
.Nm
pager can be set with the
.Ev RI_PAGER
environment variable or the
.Ev PAGER
environment variable.
.Pp
.Sh OPTIONS
.Bl -tag -width "1234567890123" -compact
.Pp
.It Fl i
.It Fl - Ns Oo Cm no- Oc Ns Cm interactive
In interactive mode you can repeatedly
look up methods with autocomplete.
.Pp
.It Fl a
.It Fl - Ns Oo Cm no- Oc Ns Cm all
Show all documentation for a class or module.
.Pp
.It Fl l
.It Fl - Ns Oo Cm no- Oc Ns Cm list
List classes
.Nm
knows about.
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm pager
Send output to a pager,
rather than directly to stdout.
.Pp
.It Fl T
Synonym for
.Fl -no-pager .
.Pp
.It Fl w Ar WIDTH
.It Fl -width Ns = Ns Ar WIDTH
Set the width of the output.
.Pp
.It Fl -server Ns Oo = Ns Ar PORT Oc
Run RDoc server on the given port.
The default port is\~8214.
.Pp
.It Fl f Ar FORMAT
.It Fl -format Ns = Ns Ar FORMAT
Use the selected formatter.
The default formatter is
.Li bs
for paged output and
.Li ansi
otherwise.
Valid formatters are:
.Li ansi , Li bs , Li markdown , Li rdoc .
.Pp
.It Fl h
.It Fl -help
Show help and exit.
.Pp
.It Fl v
.It Fl -version
Output version information and exit.
.El
.Pp
Data source options:
.Bl -tag -width "1234567890123" -compact
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs
List the directories from which
.Nm
will source documentation on stdout and exit.
.Pp
.It Fl d Ar DIRNAME
.It Fl -doc-dir Ns = Ns Ar DIRNAME
List of directories from which to source
documentation in addition to the standard
directories. May be repeated.
.Pp
.It Fl -no-standard-docs
Do not include documentation from the Ruby standard library,
.Pa site_lib ,
installed gems, or
.Pa ~/.rdoc .
Use with
.Fl -doc-dir .
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm system
Include documentation from Ruby's standard library. Defaults to true.
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm site
Include documentation from libraries installed in
.Pa site_lib .
Defaults to true.
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm gems
Include documentation from RubyGems. Defaults to true.
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm home
Include documentation stored in
.Pa ~/.rdoc .
Defaults to true.
.El
.Pp
Debug options:
.Bl -tag -width "1234567890123" -compact
.Pp
.It Fl - Ns Oo Cm no- Oc Ns Cm profile
Run with the Ruby profiler.
.Pp
.It Fl -dump Ns = Ns Ar CACHE
Dump data from an ri cache or data file.
.El
.Pp
.Sh ENVIRONMENT
.Bl -tag -width "USERPROFILE" -compact
.Pp
.It Ev RI
Options to prepend to those specified on the command-line.
.Pp
.It Ev RI_PAGER
.It Ev PAGER
Pager program to use for displaying.
.Pp
.It Ev HOME
.It Ev USERPROFILE
.It Ev HOMEPATH
Path to the user's home directory.
.El
.Pp
.Sh FILES
.Bl -tag -width "USERPROFILE" -compact
.Pp
.It Pa ~/.rdoc
Path for ri data in the user's home directory.
.Pp
.El
.Pp
.Sh SEE ALSO
.Xr ruby 1 ,
.Xr rdoc 1 ,
.Xr gem 1
.Pp
.Sh REPORTING BUGS
.Bl -bullet
.It
Security vulnerabilities should be reported via an email to
.Mt security@ruby-lang.org .
Reported problems will be published after being fixed.
.Pp
.It
Other bugs and feature requests can be reported via the
Ruby Issue Tracking System
.Pq Lk https://bugs.ruby-lang.org/ .
Do not report security vulnerabilities
via this system because it publishes the vulnerabilities immediately.
.El
.Sh AUTHORS
Written by
.An Dave Thomas Aq dave@pragmaticprogrammer.com .
share/man/man1/bundle-version.1 0000644 00000001152 15173517734 0012307 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-VERSION" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-version\fR \- Prints Bundler version information
.SH "SYNOPSIS"
\fBbundle version\fR
.SH "DESCRIPTION"
Prints Bundler version information\.
.SH "OPTIONS"
No options\.
.SH "EXAMPLE"
Print the version of Bundler with build date and commit hash of the in the Git source\.
.IP "" 4
.nf
bundle version
.fi
.IP "" 0
.P
shows \fBBundler version 2\.3\.21 (2022\-08\-24 commit d54be5fdd8)\fR for example\.
.P
cf\. \fBbundle \-\-version\fR shows \fBBundler version 2\.3\.21\fR\.
share/man/man1/bundle-check.1 0000644 00000002107 15173517734 0011700 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CHECK" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-check\fR \- Verifies if dependencies are satisfied by installed gems
.SH "SYNOPSIS"
\fBbundle check\fR [\-\-dry\-run] [\-\-gemfile=FILE] [\-\-path=PATH]
.SH "DESCRIPTION"
\fBcheck\fR searches the local machine for each of the gems requested in the Gemfile\. If all gems are found, Bundler prints a success message and exits with a status of 0\.
.P
If not, the first missing gem is listed and Bundler exits status 1\.
.P
If the lockfile needs to be updated then it will be resolved using the gems installed on the local machine, if they satisfy the requirements\.
.SH "OPTIONS"
.TP
\fB\-\-dry\-run\fR
Locks the [\fBGemfile(5)\fR][Gemfile(5)] before running the command\.
.TP
\fB\-\-gemfile\fR
Use the specified gemfile instead of the [\fBGemfile(5)\fR][Gemfile(5)]\.
.TP
\fB\-\-path\fR
Specify a different path than the system default (\fB$BUNDLE_PATH\fR or \fB$GEM_HOME\fR)\. Bundler will remember this value for future installs on this machine\.
share/man/man1/bundle-doctor.1 0000644 00000002161 15173517734 0012115 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-DOCTOR" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-doctor\fR \- Checks the bundle for common problems
.SH "SYNOPSIS"
\fBbundle doctor\fR [\-\-quiet] [\-\-gemfile=GEMFILE]
.SH "DESCRIPTION"
Checks your Gemfile and gem environment for common problems\. If issues are detected, Bundler prints them and exits status 1\. Otherwise, Bundler prints a success message and exits status 0\.
.P
Examples of common problems caught by bundle\-doctor include:
.IP "\(bu" 4
Invalid Bundler settings
.IP "\(bu" 4
Mismatched Ruby versions
.IP "\(bu" 4
Mismatched platforms
.IP "\(bu" 4
Uninstalled gems
.IP "\(bu" 4
Missing dependencies
.IP "" 0
.SH "OPTIONS"
.TP
\fB\-\-quiet\fR
Only output warnings and errors\.
.TP
\fB\-\-gemfile=<gemfile>\fR
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project's root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
share/man/man1/rake.1 0000644 00000007215 15173517734 0010303 0 ustar 00 .Dd June 12, 2016
.Dt RAKE 1
.Os rake 11.2.2
.Sh NAME
.Nm rake
.Nd make-like build utility for Ruby
.Sh SYNOPSIS
.Nm
.Op Fl f Ar rakefile
.Op Ar options
.Ar targets ...
.Sh DESCRIPTION
.Nm
is a
.Xr make 1 Ns -like
build utility for Ruby.
Tasks and dependencies are specified in standard Ruby syntax.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl m , Fl -multitask
Treat all tasks as multitasks.
.It Fl B , Fl -build-all
Build all prerequisites, including those which are up\-to\-date.
.It Fl j , Fl -jobs Ar num_jobs
Specifies the maximum number of tasks to execute in parallel (default is number of CPU cores + 4).
.El
.Ss Modules
.Bl -tag -width Ds
.It Fl I , Fl -libdir Ar libdir
Include
.Ar libdir
in the search path for required modules.
.It Fl r , Fl -require Ar module
Require
.Ar module
before executing
.Pa rakefile .
.El
.Ss Rakefile location
.Bl -tag -width Ds
.It Fl f , Fl -rakefile Ar filename
Use
.Ar filename
as the rakefile to search for.
.It Fl N , Fl -no-search , Fl -nosearch
Do not search parent directories for the Rakefile.
.It Fl G , Fl -no-system , Fl -nosystem
Use standard project Rakefile search paths, ignore system wide rakefiles.
.It Fl R , Fl -rakelib Ar rakelibdir , Fl -rakelibdir Ar rakelibdir
Auto-import any .rake files in
.Ar rakelibdir
(default is
.Sq rakelib )
.It Fl g , Fl -system
Use system-wide (global) rakefiles (usually
.Pa ~/.rake/*.rake ) .
.El
.Ss Debugging
.Bl -tag -width Ds
.It Fl -backtrace Ns = Ns Ar out
Enable full backtrace.
.Ar out
can be
.Dv stderr
(default) or
.Dv stdout .
.It Fl t , Fl -trace Ns = Ns Ar out
Turn on invoke/execute tracing, enable full backtrace.
.Ar out
can be
.Dv stderr
(default) or
.Dv stdout .
.It Fl -suppress-backtrace Ar pattern
Suppress backtrace lines matching regexp
.Ar pattern .
Ignored if
.Fl -trace
is on.
.It Fl -rules
Trace the rules resolution.
.It Fl n , Fl -dry-run
Do a dry run without executing actions.
.It Fl T , Fl -tasks Op Ar pattern
Display the tasks (matching optional
.Ar pattern )
with descriptions, then exit.
.It Fl D , Fl -describe Op Ar pattern
Describe the tasks (matching optional
.Ar pattern ) ,
then exit.
.It Fl W , Fl -where Op Ar pattern
Describe the tasks (matching optional
.Ar pattern ) ,
then exit.
.It Fl P , Fl -prereqs
Display the tasks and dependencies, then exit.
.It Fl e , Fl -execute Ar code
Execute some Ruby code and exit.
.It Fl p , Fl -execute-print Ar code
Execute some Ruby code, print the result, then exit.
.It Fl E , Fl -execute-continue Ar code
Execute some Ruby code, then continue with normal task processing.
.El
.Ss Information
.Bl -tag -width Ds
.It Fl v , Fl -verbose
Log message to standard output.
.It Fl q , Fl -quiet
Do not log messages to standard output.
.It Fl s , Fl -silent
Like
.Fl -quiet ,
but also suppresses the
.Sq in directory
announcement.
.It Fl X , Fl -no-deprecation-warnings
Disable the deprecation warnings.
.It Fl -comments
Show commented tasks only
.It Fl A , Fl -all
Show all tasks, even uncommented ones (in combination with
.Fl T
or
.Fl D )
.It Fl -job-stats Op Ar level
Display job statistics.
If
.Ar level
is
.Sq history ,
displays a complete job list.
.It Fl V , Fl -version
Display the program version.
.It Fl h , Fl H , Fl -help
Display a help message.
.El
.Sh SEE ALSO
The complete documentation for
.Nm rake
has been installed at
.Pa /usr/share/doc/rake-doc/html/index.html .
It is also available online at
.Lk https://ruby.github.io/rake .
.Sh AUTHORS
.An -nosplit
.Nm
was written by
.An Jim Weirich Aq Mt jim@weirichhouse.org .
.Pp
This manual was created by
.An Caitlin Matos Aq Mt caitlin.matos@zoho.com
for the Debian project (but may be used by others).
It was inspired by the manual by
.An Jani Monoses Aq Mt jani@iv.ro
for the Ubuntu project.
share/man/man1/bundle-platform.1 0000644 00000002613 15173517734 0012451 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-PLATFORM" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-platform\fR \- Displays platform compatibility information
.SH "SYNOPSIS"
\fBbundle platform\fR [\-\-ruby]
.SH "DESCRIPTION"
\fBplatform\fR displays information from your Gemfile, Gemfile\.lock, and Ruby VM about your platform\.
.P
For instance, using this Gemfile(5):
.IP "" 4
.nf
source "https://rubygems\.org"
ruby "3\.1\.2"
gem "rack"
.fi
.IP "" 0
.P
If you run \fBbundle platform\fR on Ruby 3\.1\.2, it displays the following output:
.IP "" 4
.nf
Your platform is: x86_64\-linux
Your app has gems that work on these platforms:
* arm64\-darwin\-21
* ruby
* x64\-mingw\-ucrt
* x86_64\-linux
Your Gemfile specifies a Ruby version requirement:
* ruby 3\.1\.2
Your current platform satisfies the Ruby version requirement\.
.fi
.IP "" 0
.P
\fBplatform\fR lists all the platforms in your \fBGemfile\.lock\fR as well as the \fBruby\fR directive if applicable from your Gemfile(5)\. It also lets you know if the \fBruby\fR directive requirement has been met\. If \fBruby\fR directive doesn't match the running Ruby VM, it tells you what part does not\.
.SH "OPTIONS"
.TP
\fB\-\-ruby\fR
It will display the ruby directive information, so you don't have to parse it from the Gemfile(5)\.
.SH "SEE ALSO"
.IP "\(bu" 4
bundle\-lock(1) \fIbundle\-lock\.1\.html\fR
.IP "" 0
share/man/man1/bundle-config.1 0000644 00000052017 15173517734 0012075 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CONFIG" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-config\fR \- Set bundler configuration options
.SH "SYNOPSIS"
\fBbundle config\fR list
.br
\fBbundle config\fR [get] NAME
.br
\fBbundle config\fR [set] NAME VALUE
.br
\fBbundle config\fR unset NAME
.SH "DESCRIPTION"
This command allows you to interact with Bundler's configuration system\.
.P
Bundler loads configuration settings in this order:
.IP "1." 4
Local config (\fB<project_root>/\.bundle/config\fR or \fB$BUNDLE_APP_CONFIG/config\fR)
.IP "2." 4
Environmental variables (\fBENV\fR)
.IP "3." 4
Global config (\fB~/\.bundle/config\fR)
.IP "4." 4
Bundler default config
.IP "" 0
.P
Executing \fBbundle config list\fR will print a list of all bundler configuration for the current bundle, and where that configuration was set\.
.P
Executing \fBbundle config get <name>\fR will print the value of that configuration setting, and where it was set\.
.P
Executing \fBbundle config set <name> <value>\fR defaults to setting \fBlocal\fR configuration if executing from within a local application, otherwise it will set \fBglobal\fR configuration\. See \fB\-\-local\fR and \fB\-\-global\fR options below\.
.P
Executing \fBbundle config set \-\-local <name> <value>\fR will set that configuration in the directory for the local application\. The configuration will be stored in \fB<project_root>/\.bundle/config\fR\. If \fBBUNDLE_APP_CONFIG\fR is set, the configuration will be stored in \fB$BUNDLE_APP_CONFIG/config\fR\.
.P
Executing \fBbundle config set \-\-global <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\.
.P
Executing \fBbundle config unset <name>\fR will delete the configuration in both local and global sources\.
.P
Executing \fBbundle config unset \-\-global <name>\fR will delete the configuration only from the user configuration\.
.P
Executing \fBbundle config unset \-\-local <name>\fR will delete the configuration only from the local application\.
.P
Executing bundle with the \fBBUNDLE_IGNORE_CONFIG\fR environment variable set will cause it to ignore all configuration\.
.SH "REMEMBERING OPTIONS"
Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are remembered between commands and saved to your local application's configuration (normally, \fB\./\.bundle/config\fR)\.
.P
However, this will be changed in bundler 3, so it's better not to rely on this behavior\. If these options must be remembered, it's better to set them using \fBbundle config\fR (e\.g\., \fBbundle config set \-\-local path foo\fR)\.
.P
The options that can be configured are:
.TP
\fBbin\fR
Creates a directory (defaults to \fB~/bin\fR) and place any executables from the gem there\. These executables run in Bundler's context\. If used, you might add this directory to your environment's \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
.TP
\fBdeployment\fR
In deployment mode, Bundler will 'roll\-out' the bundle for \fBproduction\fR use\. Please check carefully if you want to have this option enabled in \fBdevelopment\fR or \fBtest\fR environments\.
.TP
\fBonly\fR
A space\-separated list of groups to install only gems of the specified groups\.
.TP
\fBpath\fR
The location to install the specified gems to\. This defaults to Rubygems' setting\. Bundler shares this location with Rubygems, \fBgem install \|\.\|\.\|\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \|\.\|\.\|\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
.TP
\fBwithout\fR
A space\-separated list of groups referencing gems to skip during installation\.
.TP
\fBwith\fR
A space\-separated list of \fBoptional\fR groups referencing gems to include during installation\.
.SH "BUILD OPTIONS"
You can use \fBbundle config\fR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem\.
.P
A very common example, the \fBmysql\fR gem, requires Snow Leopard users to pass configuration flags to \fBgem install\fR to specify where to find the \fBmysql_config\fR executable\.
.IP "" 4
.nf
gem install mysql \-\- \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
.fi
.IP "" 0
.P
Since the specific location of that executable can change from machine to machine, you can specify these flags on a per\-machine basis\.
.IP "" 4
.nf
bundle config set \-\-global build\.mysql \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
.fi
.IP "" 0
.P
After running this command, every time bundler needs to install the \fBmysql\fR gem, it will pass along the flags you specified\.
.SH "CONFIGURATION KEYS"
Configuration keys in bundler have two forms: the canonical form and the environment variable form\.
.P
For instance, passing the \fB\-\-without\fR flag to bundle install(1) \fIbundle\-install\.1\.html\fR prevents Bundler from installing certain groups specified in the Gemfile(5)\. Bundler persists this value in \fBapp/\.bundle/config\fR so that calls to \fBBundler\.setup\fR do not try to find gems from the \fBGemfile\fR that you didn't install\. Additionally, subsequent calls to bundle install(1) \fIbundle\-install\.1\.html\fR remember this setting and skip those groups\.
.P
The canonical form of this configuration is \fB"without"\fR\. To convert the canonical form to the environment variable form, capitalize it, and prepend \fBBUNDLE_\fR\. The environment variable form of \fB"without"\fR is \fBBUNDLE_WITHOUT\fR\.
.P
Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables\. The configuration key \fBlocal\.rack\fR becomes the environment variable \fBBUNDLE_LOCAL__RACK\fR\.
.SH "LIST OF AVAILABLE KEYS"
The following is a list of all configuration keys and their purpose\. You can learn more about their operation in bundle install(1) \fIbundle\-install\.1\.html\fR\.
.IP "\(bu" 4
\fBallow_offline_install\fR (\fBBUNDLE_ALLOW_OFFLINE_INSTALL\fR): Allow Bundler to use cached data when installing without network access\.
.IP "\(bu" 4
\fBauto_clean_without_path\fR (\fBBUNDLE_AUTO_CLEAN_WITHOUT_PATH\fR): Automatically run \fBbundle clean\fR after installing when an explicit \fBpath\fR has not been set and Bundler is not installing into the system gems\.
.IP "\(bu" 4
\fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR): Automatically run \fBbundle install\fR when gems are missing\.
.IP "\(bu" 4
\fBbin\fR (\fBBUNDLE_BIN\fR): Install executables from gems in the bundle to the specified directory\. Defaults to \fBfalse\fR\.
.IP "\(bu" 4
\fBcache_all\fR (\fBBUNDLE_CACHE_ALL\fR): Cache all gems, including path and git gems\. This needs to be explicitly configured on bundler 1 and bundler 2, but will be the default on bundler 3\.
.IP "\(bu" 4
\fBcache_all_platforms\fR (\fBBUNDLE_CACHE_ALL_PLATFORMS\fR): Cache gems for all platforms\.
.IP "\(bu" 4
\fBcache_path\fR (\fBBUNDLE_CACHE_PATH\fR): The directory that bundler will place cached gems in when running \fBbundle package\fR, and that bundler will look in when installing gems\. Defaults to \fBvendor/cache\fR\.
.IP "\(bu" 4
\fBclean\fR (\fBBUNDLE_CLEAN\fR): Whether Bundler should run \fBbundle clean\fR automatically after \fBbundle install\fR\.
.IP "\(bu" 4
\fBconsole\fR (\fBBUNDLE_CONSOLE\fR): The console that \fBbundle console\fR starts\. Defaults to \fBirb\fR\.
.IP "\(bu" 4
\fBdefault_install_uses_path\fR (\fBBUNDLE_DEFAULT_INSTALL_USES_PATH\fR): Whether a \fBbundle install\fR without an explicit \fB\-\-path\fR argument defaults to installing gems in \fB\.bundle\fR\.
.IP "\(bu" 4
\fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\.
.IP "\(bu" 4
\fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR): Allow installing gems even if they do not match the checksum provided by RubyGems\.
.IP "\(bu" 4
\fBdisable_exec_load\fR (\fBBUNDLE_DISABLE_EXEC_LOAD\fR): Stop Bundler from using \fBload\fR to launch an executable in\-process in \fBbundle exec\fR\.
.IP "\(bu" 4
\fBdisable_local_branch_check\fR (\fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECK\fR): Allow Bundler to use a local git override without a branch specified in the Gemfile\.
.IP "\(bu" 4
\fBdisable_local_revision_check\fR (\fBBUNDLE_DISABLE_LOCAL_REVISION_CHECK\fR): Allow Bundler to use a local git override without checking if the revision present in the lockfile is present in the repository\.
.IP "\(bu" 4
\fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR): Stop Bundler from accessing gems installed to RubyGems' normal location\.
.IP "\(bu" 4
\fBdisable_version_check\fR (\fBBUNDLE_DISABLE_VERSION_CHECK\fR): Stop Bundler from checking if a newer Bundler version is available on rubygems\.org\.
.IP "\(bu" 4
\fBforce_ruby_platform\fR (\fBBUNDLE_FORCE_RUBY_PLATFORM\fR): Ignore the current machine's platform and install only \fBruby\fR platform gems\. As a result, gems with native extensions will be compiled from source\.
.IP "\(bu" 4
\fBfrozen\fR (\fBBUNDLE_FROZEN\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\. Defaults to \fBtrue\fR when \fB\-\-deployment\fR is used\.
.IP "\(bu" 4
\fBgem\.github_username\fR (\fBBUNDLE_GEM__GITHUB_USERNAME\fR): Sets a GitHub username or organization to be used in \fBREADME\fR file when you create a new gem via \fBbundle gem\fR command\. It can be overridden by passing an explicit \fB\-\-github\-username\fR flag to \fBbundle gem\fR\.
.IP "\(bu" 4
\fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR): Sets the \fB\-\-key\fR parameter for \fBgem push\fR when using the \fBrake release\fR command with a private gemstash server\.
.IP "\(bu" 4
\fBgemfile\fR (\fBBUNDLE_GEMFILE\fR): The name of the file that bundler should use as the \fBGemfile\fR\. This location of this file also sets the root of the project, which is used to resolve relative paths in the \fBGemfile\fR, among other things\. By default, bundler will search up from the current working directory until it finds a \fBGemfile\fR\.
.IP "\(bu" 4
\fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR): Whether Bundler should cache all gems globally, rather than locally to the installing Ruby installation\.
.IP "\(bu" 4
\fBignore_funding_requests\fR (\fBBUNDLE_IGNORE_FUNDING_REQUESTS\fR): When set, no funding requests will be printed\.
.IP "\(bu" 4
\fBignore_messages\fR (\fBBUNDLE_IGNORE_MESSAGES\fR): When set, no post install messages will be printed\. To silence a single gem, use dot notation like \fBignore_messages\.httparty true\fR\.
.IP "\(bu" 4
\fBinit_gems_rb\fR (\fBBUNDLE_INIT_GEMS_RB\fR): Generate a \fBgems\.rb\fR instead of a \fBGemfile\fR when running \fBbundle init\fR\.
.IP "\(bu" 4
\fBjobs\fR (\fBBUNDLE_JOBS\fR): The number of gems Bundler can install in parallel\. Defaults to the number of available processors\.
.IP "\(bu" 4
\fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR): Whether \fBbundle package\fR should skip installing gems\.
.IP "\(bu" 4
\fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR): Whether Bundler should leave outdated gems unpruned when caching\.
.IP "\(bu" 4
\fBonly\fR (\fBBUNDLE_ONLY\fR): A space\-separated list of groups to install only gems of the specified groups\.
.IP "\(bu" 4
\fBpath\fR (\fBBUNDLE_PATH\fR): The location on disk where all gems in your bundle will be located regardless of \fB$GEM_HOME\fR or \fB$GEM_PATH\fR values\. Bundle gems not found in this location will be installed by \fBbundle install\fR\. Defaults to \fBGem\.dir\fR\. When \-\-deployment is used, defaults to vendor/bundle\.
.IP "\(bu" 4
\fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
.IP "\(bu" 4
\fBpath_relative_to_cwd\fR (\fBBUNDLE_PATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\.
.IP "\(bu" 4
\fBplugins\fR (\fBBUNDLE_PLUGINS\fR): Enable Bundler's experimental plugin system\.
.IP "\(bu" 4
\fBprefer_patch\fR (BUNDLE_PREFER_PATCH): Prefer updating only to next patch version during updates\. Makes \fBbundle update\fR calls equivalent to \fBbundler update \-\-patch\fR\.
.IP "\(bu" 4
\fBprint_only_version_number\fR (\fBBUNDLE_PRINT_ONLY_VERSION_NUMBER\fR): Print only version number from \fBbundler \-\-version\fR\.
.IP "\(bu" 4
\fBredirect\fR (\fBBUNDLE_REDIRECT\fR): The number of redirects allowed for network requests\. Defaults to \fB5\fR\.
.IP "\(bu" 4
\fBretry\fR (\fBBUNDLE_RETRY\fR): The number of times to retry failed network requests\. Defaults to \fB3\fR\.
.IP "\(bu" 4
\fBsetup_makes_kernel_gem_public\fR (\fBBUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC\fR): Have \fBBundler\.setup\fR make the \fBKernel#gem\fR method public, even though RubyGems declares it as private\.
.IP "\(bu" 4
\fBshebang\fR (\fBBUNDLE_SHEBANG\fR): The program name that should be invoked for generated binstubs\. Defaults to the ruby install name used to generate the binstub\.
.IP "\(bu" 4
\fBsilence_deprecations\fR (\fBBUNDLE_SILENCE_DEPRECATIONS\fR): Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version\.
.IP "\(bu" 4
\fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR): Silence the warning Bundler prints when installing gems as root\.
.IP "\(bu" 4
\fBssl_ca_cert\fR (\fBBUNDLE_SSL_CA_CERT\fR): Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format\.
.IP "\(bu" 4
\fBssl_client_cert\fR (\fBBUNDLE_SSL_CLIENT_CERT\fR): Path to a designated file containing a X\.509 client certificate and key in PEM format\.
.IP "\(bu" 4
\fBssl_verify_mode\fR (\fBBUNDLE_SSL_VERIFY_MODE\fR): The SSL verification mode Bundler uses when making HTTPS requests\. Defaults to verify peer\.
.IP "\(bu" 4
\fBsystem_bindir\fR (\fBBUNDLE_SYSTEM_BINDIR\fR): The location where RubyGems installs binstubs\. Defaults to \fBGem\.bindir\fR\.
.IP "\(bu" 4
\fBtimeout\fR (\fBBUNDLE_TIMEOUT\fR): The seconds allowed before timing out for network requests\. Defaults to \fB10\fR\.
.IP "\(bu" 4
\fBupdate_requires_all_flag\fR (\fBBUNDLE_UPDATE_REQUIRES_ALL_FLAG\fR): Require passing \fB\-\-all\fR to \fBbundle update\fR when everything should be updated, and disallow passing no options to \fBbundle update\fR\.
.IP "\(bu" 4
\fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR): The custom user agent fragment Bundler includes in API requests\.
.IP "\(bu" 4
\fBversion\fR (\fBBUNDLE_VERSION\fR): The version of Bundler to use when running under Bundler environment\. Defaults to \fBlockfile\fR\. You can also specify \fBsystem\fR or \fBx\.y\.z\fR\. \fBlockfile\fR will use the Bundler version specified in the \fBGemfile\.lock\fR, \fBsystem\fR will use the system version of Bundler, and \fBx\.y\.z\fR will use the specified version of Bundler\.
.IP "\(bu" 4
\fBwith\fR (\fBBUNDLE_WITH\fR): A \fB:\fR\-separated list of groups whose gems bundler should install\.
.IP "\(bu" 4
\fBwithout\fR (\fBBUNDLE_WITHOUT\fR): A \fB:\fR\-separated list of groups whose gems bundler should not install\.
.IP "" 0
.P
In general, you should set these settings per\-application by using the applicable flag to the bundle install(1) \fIbundle\-install\.1\.html\fR or bundle cache(1) \fIbundle\-cache\.1\.html\fR command\.
.P
You can set them globally either via environment variables or \fBbundle config\fR, whichever is preferable for your setup\. If you use both, environment variables will take preference over global settings\.
.SH "LOCAL GIT REPOS"
Bundler also allows you to work against a git repository locally instead of using the remote version\. This can be achieved by setting up a local override:
.IP "" 4
.nf
bundle config set \-\-local local\.GEM_NAME /path/to/local/git/repository
.fi
.IP "" 0
.P
For example, in order to use a local Rack repository, a developer could call:
.IP "" 4
.nf
bundle config set \-\-local local\.rack ~/Work/git/rack
.fi
.IP "" 0
.P
Now instead of checking out the remote git repository, the local override will be used\. Similar to a path source, every time the local git repository change, changes will be automatically picked up by Bundler\. This means a commit in the local git repo will update the revision in the \fBGemfile\.lock\fR to the local git repo revision\. This requires the same attention as git submodules\. Before pushing to the remote, you need to ensure the local override was pushed, otherwise you may point to a commit that only exists in your local machine\. You'll also need to CGI escape your usernames and passwords as well\.
.P
Bundler does many checks to ensure a developer won't work with invalid references\. Particularly, we force a developer to specify a branch in the \fBGemfile\fR in order to use this feature\. If the branch specified in the \fBGemfile\fR and the current branch in the local git repository do not match, Bundler will abort\. This ensures that a developer is always working against the correct branches, and prevents accidental locking to a different branch\.
.P
Finally, Bundler also ensures that the current revision in the \fBGemfile\.lock\fR exists in the local git repository\. By doing this, Bundler forces you to fetch the latest changes in the remotes\.
.SH "MIRRORS OF GEM SOURCES"
Bundler supports overriding gem sources with mirrors\. This allows you to configure rubygems\.org as the gem source in your Gemfile while still using your mirror to fetch gems\.
.IP "" 4
.nf
bundle config set \-\-global mirror\.SOURCE_URL MIRROR_URL
.fi
.IP "" 0
.P
For example, to use a mirror of https://rubygems\.org hosted at https://example\.org:
.IP "" 4
.nf
bundle config set \-\-global mirror\.https://rubygems\.org https://example\.org
.fi
.IP "" 0
.P
Each mirror also provides a fallback timeout setting\. If the mirror does not respond within the fallback timeout, Bundler will try to use the original server instead of the mirror\.
.IP "" 4
.nf
bundle config set \-\-global mirror\.SOURCE_URL\.fallback_timeout TIMEOUT
.fi
.IP "" 0
.P
For example, to fall back to rubygems\.org after 3 seconds:
.IP "" 4
.nf
bundle config set \-\-global mirror\.https://rubygems\.org\.fallback_timeout 3
.fi
.IP "" 0
.P
The default fallback timeout is 0\.1 seconds, but the setting can currently only accept whole seconds (for example, 1, 15, or 30)\.
.SH "CREDENTIALS FOR GEM SOURCES"
Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile\.
.IP "" 4
.nf
bundle config set \-\-global SOURCE_HOSTNAME USERNAME:PASSWORD
.fi
.IP "" 0
.P
For example, to save the credentials of user \fBclaudette\fR for the gem source at \fBgems\.longerous\.com\fR, you would run:
.IP "" 4
.nf
bundle config set \-\-global gems\.longerous\.com claudette:s00pers3krit
.fi
.IP "" 0
.P
Or you can set the credentials as an environment variable like this:
.IP "" 4
.nf
export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
.fi
.IP "" 0
.P
For gems with a git source with HTTP(S) URL you can specify credentials like so:
.IP "" 4
.nf
bundle config set \-\-global https://github\.com/rubygems/rubygems\.git username:password
.fi
.IP "" 0
.P
Or you can set the credentials as an environment variable like so:
.IP "" 4
.nf
export BUNDLE_GITHUB__COM=username:password
.fi
.IP "" 0
.P
This is especially useful for private repositories on hosts such as GitHub, where you can use personal OAuth tokens:
.IP "" 4
.nf
export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x\-oauth\-basic
.fi
.IP "" 0
.P
Note that any configured credentials will be redacted by informative commands such as \fBbundle config list\fR or \fBbundle config get\fR, unless you use the \fB\-\-parseable\fR flag\. This is to avoid unintentionally leaking credentials when copy\-pasting bundler output\.
.P
Also note that to guarantee a sane mapping between valid environment variable names and valid host names, bundler makes the following transformations:
.IP "\(bu" 4
Any \fB\-\fR characters in a host name are mapped to a triple underscore (\fB___\fR) in the corresponding environment variable\.
.IP "\(bu" 4
Any \fB\.\fR characters in a host name are mapped to a double underscore (\fB__\fR) in the corresponding environment variable\.
.IP "" 0
.P
This means that if you have a gem server named \fBmy\.gem\-host\.com\fR, you'll need to use the \fBBUNDLE_MY__GEM___HOST__COM\fR variable to configure credentials for it through ENV\.
.SH "CONFIGURE BUNDLER DIRECTORIES"
Bundler's home, cache and plugin directories and config file can be configured through environment variables\. The default location for Bundler's home directory is \fB~/\.bundle\fR, which all directories inherit from by default\. The following outlines the available environment variables and their default values
.IP "" 4
.nf
BUNDLE_USER_HOME : $HOME/\.bundle
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
.fi
.IP "" 0
share/man/man1/bundle-outdated.1 0000644 00000006265 15173517734 0012445 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-OUTDATED" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-outdated\fR \- List installed gems with newer versions available
.SH "SYNOPSIS"
\fBbundle outdated\fR [GEM] [\-\-local] [\-\-pre] [\-\-source] [\-\-strict] [\-\-parseable | \-\-porcelain] [\-\-group=GROUP] [\-\-groups] [\-\-patch|\-\-minor|\-\-major] [\-\-filter\-major] [\-\-filter\-minor] [\-\-filter\-patch] [\-\-only\-explicit]
.SH "DESCRIPTION"
Outdated lists the names and versions of gems that have a newer version available in the given source\. Calling outdated with [GEM [GEM]] will only check for newer versions of the given gems\. Prerelease gems are ignored by default\. If your gems are up to date, Bundler will exit with a status of 0\. Otherwise, it will exit 1\.
.SH "OPTIONS"
.TP
\fB\-\-local\fR
Do not attempt to fetch gems remotely and use the gem cache instead\.
.TP
\fB\-\-pre\fR
Check for newer pre\-release gems\.
.TP
\fB\-\-source\fR
Check against a specific source\.
.TP
\fB\-\-strict\fR
Only list newer versions allowed by your Gemfile requirements, also respecting conservative update flags (\-\-patch, \-\-minor, \-\-major)\.
.TP
\fB\-\-parseable\fR, \fB\-\-porcelain\fR
Use minimal formatting for more parseable output\.
.TP
\fB\-\-group\fR
List gems from a specific group\.
.TP
\fB\-\-groups\fR
List gems organized by groups\.
.TP
\fB\-\-minor\fR
Prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
Prefer updating to next major version (default)\.
.TP
\fB\-\-patch\fR
Prefer updating only to next patch version\.
.TP
\fB\-\-filter\-major\fR
Only list major newer versions\.
.TP
\fB\-\-filter\-minor\fR
Only list minor newer versions\.
.TP
\fB\-\-filter\-patch\fR
Only list patch newer versions\.
.TP
\fB\-\-only\-explicit\fR
Only list gems specified in your Gemfile, not their dependencies\.
.SH "PATCH LEVEL OPTIONS"
See bundle update(1) \fIbundle\-update\.1\.html\fR for details\.
.SH "FILTERING OUTPUT"
The 3 filtering options do not affect the resolution of versions, merely what versions are shown in the output\.
.P
If the regular output shows the following:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* faker 1\.6\.5 1\.6\.6 ~> 1\.4 development, test
* hashie 1\.2\.0 3\.4\.6 = 1\.2\.0 default
* headless 2\.2\.3 2\.3\.1 = 2\.2\.3 test
.fi
.IP "" 0
.P
\fB\-\-filter\-major\fR would only show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* hashie 1\.2\.0 3\.4\.6 = 1\.2\.0 default
.fi
.IP "" 0
.P
\fB\-\-filter\-minor\fR would only show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* headless 2\.2\.3 2\.3\.1 = 2\.2\.3 test
.fi
.IP "" 0
.P
\fB\-\-filter\-patch\fR would only show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* faker 1\.6\.5 1\.6\.6 ~> 1\.4 development, test
.fi
.IP "" 0
.P
Filter options can be combined\. \fB\-\-filter\-minor\fR and \fB\-\-filter\-patch\fR would show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* faker 1\.6\.5 1\.6\.6 ~> 1\.4 development, test
.fi
.IP "" 0
.P
Combining all three \fBfilter\fR options would be the same result as providing none of them\.
share/man/man1/bundle-pristine.1 0000644 00000003166 15173517734 0012466 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-PRISTINE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-pristine\fR \- Restores installed gems to their pristine condition
.SH "SYNOPSIS"
\fBbundle pristine\fR
.SH "DESCRIPTION"
\fBpristine\fR restores the installed gems in the bundle to their pristine condition using the local gem cache from RubyGems\. For git gems, a forced checkout will be performed\.
.P
For further explanation, \fBbundle pristine\fR ignores unpacked files on disk\. In other words, this command utilizes the local \fB\.gem\fR cache or the gem's git repository as if one were installing from scratch\.
.P
Note: the Bundler gem cannot be restored to its original state with \fBpristine\fR\. One also cannot use \fBbundle pristine\fR on gems with a 'path' option in the Gemfile, because bundler has no original copy it can restore from\.
.P
When is it practical to use \fBbundle pristine\fR?
.P
It comes in handy when a developer is debugging a gem\. \fBbundle pristine\fR is a great way to get rid of experimental changes to a gem that one may not want\.
.P
Why use \fBbundle pristine\fR over \fBgem pristine \-\-all\fR?
.P
Both commands are very similar\. For context: \fBbundle pristine\fR, without arguments, cleans all gems from the lockfile\. Meanwhile, \fBgem pristine \-\-all\fR cleans all installed gems for that Ruby version\.
.P
If a developer forgets which gems in their project they might have been debugging, the Rubygems \fBgem pristine [GEMNAME]\fR command may be inconvenient\. One can avoid waiting for \fBgem pristine \-\-all\fR, and instead run \fBbundle pristine\fR\.
share/man/man1/bundle-show.1 0000644 00000001245 15173517734 0011605 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-SHOW" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-show\fR \- Shows all the gems in your bundle, or the path to a gem
.SH "SYNOPSIS"
\fBbundle show\fR [GEM] [\-\-paths]
.SH "DESCRIPTION"
Without the [GEM] option, \fBshow\fR will print a list of the names and versions of all gems that are required by your [\fBGemfile(5)\fR][Gemfile(5)], sorted by name\.
.P
Calling show with [GEM] will list the exact location of that gem on your machine\.
.SH "OPTIONS"
.TP
\fB\-\-paths\fR
List the paths of all gems that are required by your [\fBGemfile(5)\fR][Gemfile(5)], sorted by gem name\.
share/man/man1/bundle-install.1 0000644 00000040672 15173517734 0012302 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INSTALL" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-install\fR \- Install the dependencies specified in your Gemfile
.SH "SYNOPSIS"
\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-prefer\-local] [\-\-quiet] [\-\-redownload] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\|\.\|\.\|\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-with=GROUP[ GROUP\|\.\|\.\|\.]] [\-\-without=GROUP[ GROUP\|\.\|\.\|\.]]
.SH "DESCRIPTION"
Install the gems specified in your Gemfile(5)\. If this is the first time you run bundle install (and a \fBGemfile\.lock\fR does not exist), Bundler will fetch all remote sources, resolve dependencies and install all needed gems\.
.P
If a \fBGemfile\.lock\fR does exist, and you have not updated your Gemfile(5), Bundler will fetch all remote sources, but use the dependencies specified in the \fBGemfile\.lock\fR instead of resolving dependencies\.
.P
If a \fBGemfile\.lock\fR does exist, and you have updated your Gemfile(5), Bundler will use the dependencies in the \fBGemfile\.lock\fR for all gems that you did not update, but will re\-resolve the dependencies of gems that you did update\. You can find more information about this update process below under \fICONSERVATIVE UPDATING\fR\.
.SH "OPTIONS"
The \fB\-\-clean\fR, \fB\-\-deployment\fR, \fB\-\-frozen\fR, \fB\-\-no\-prune\fR, \fB\-\-path\fR, \fB\-\-shebang\fR, \fB\-\-system\fR, \fB\-\-without\fR and \fB\-\-with\fR options are deprecated because they only make sense if they are applied to every subsequent \fBbundle install\fR run automatically and that requires \fBbundler\fR to silently remember them\. Since \fBbundler\fR will no longer remember CLI flags in future versions, \fBbundle config\fR (see bundle\-config(1)) should be used to apply them permanently\.
.TP
\fB\-\-binstubs[=<directory>]\fR
Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it in \fBbin/\fR\. This lets you link the binstub inside of an application to the exact gem version the application needs\.
.IP
Creates a directory (defaults to \fB~/bin\fR) and places any executables from the gem there\. These executables run in Bundler's context\. If used, you might add this directory to your environment's \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
.TP
\fB\-\-clean\fR
On finishing the installation Bundler is going to remove any gems not present in the current Gemfile(5)\. Don't worry, gems currently in use will not be removed\.
.IP
This option is deprecated in favor of the \fBclean\fR setting\.
.TP
\fB\-\-deployment\fR
In \fIdeployment mode\fR, Bundler will 'roll\-out' the bundle for production or CI use\. Please check carefully if you want to have this option enabled in your development environment\.
.IP
This option is deprecated in favor of the \fBdeployment\fR setting\.
.TP
\fB\-\-redownload\fR
Force download every gem, even if the required versions are already available locally\.
.TP
\fB\-\-frozen\fR
Do not allow the Gemfile\.lock to be updated after this install\. Exits non\-zero if there are going to be changes to the Gemfile\.lock\.
.IP
This option is deprecated in favor of the \fBfrozen\fR setting\.
.TP
\fB\-\-full\-index\fR
Bundler will not call Rubygems' API endpoint (default) but download and cache a (currently big) index file of all gems\. Performance can be improved for large bundles that seldom change by enabling this option\.
.TP
\fB\-\-gemfile=<gemfile>\fR
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project's root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
.TP
\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR
The maximum number of parallel download and install jobs\. The default is the number of available processors\.
.TP
\fB\-\-local\fR
Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the gems already present in Rubygems' cache or in \fBvendor/cache\fR\. Note that if an appropriate platform\-specific gem exists on \fBrubygems\.org\fR it will not be found\.
.TP
\fB\-\-prefer\-local\fR
Force using locally installed gems, or gems already present in Rubygems' cache or in \fBvendor/cache\fR, when resolving, even if newer versions are available remotely\. Only attempt to connect to \fBrubygems\.org\fR for gems that are not present locally\.
.TP
\fB\-\-no\-cache\fR
Do not update the cache in \fBvendor/cache\fR with the newly bundled gems\. This does not remove any gems in the cache but keeps the newly bundled gems from being cached during the install\.
.TP
\fB\-\-no\-prune\fR
Don't remove stale gems from the cache when the installation finishes\.
.IP
This option is deprecated in favor of the \fBno_prune\fR setting\.
.TP
\fB\-\-path=<path>\fR
The location to install the specified gems to\. This defaults to Rubygems' setting\. Bundler shares this location with Rubygems, \fBgem install \|\.\|\.\|\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \|\.\|\.\|\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
.IP
This option is deprecated in favor of the \fBpath\fR setting\.
.TP
\fB\-\-quiet\fR
Do not print progress information to the standard output\. Instead, Bundler will exit using a status code (\fB$?\fR)\.
.TP
\fB\-\-retry=[<number>]\fR
Retry failed network or git requests for \fInumber\fR times\.
.TP
\fB\-\-shebang=<ruby\-executable>\fR
Uses the specified ruby executable (usually \fBruby\fR) to execute the scripts created with \fB\-\-binstubs\fR\. In addition, if you use \fB\-\-binstubs\fR together with \fB\-\-shebang jruby\fR these executables will be changed to execute \fBjruby\fR instead\.
.IP
This option is deprecated in favor of the \fBshebang\fR setting\.
.TP
\fB\-\-standalone[=<list>]\fR
Makes a bundle that can work without depending on Rubygems or Bundler at runtime\. A space separated list of groups to install has to be specified\. Bundler creates a directory named \fBbundle\fR and installs the bundle there\. It also generates a \fBbundle/bundler/setup\.rb\fR file to replace Bundler's own setup in the manner required\. Using this option implicitly sets \fBpath\fR, which is a [remembered option][REMEMBERED OPTIONS]\.
.TP
\fB\-\-system\fR
Installs the gems specified in the bundle to the system's Rubygems location\. This overrides any previous configuration of \fB\-\-path\fR\.
.IP
This option is deprecated in favor of the \fBsystem\fR setting\.
.TP
\fB\-\-trust\-policy=[<policy>]\fR
Apply the Rubygems security policy \fIpolicy\fR, where policy is one of \fBHighSecurity\fR, \fBMediumSecurity\fR, \fBLowSecurity\fR, \fBAlmostNoSecurity\fR, or \fBNoSecurity\fR\. For more details, please see the Rubygems signing documentation linked below in \fISEE ALSO\fR\.
.TP
\fB\-\-with=<list>\fR
A space\-separated list of groups referencing gems to install\. If an optional group is given it is installed\. If a group is given that is in the remembered list of groups given to \-\-without, it is removed from that list\.
.IP
This option is deprecated in favor of the \fBwith\fR setting\.
.TP
\fB\-\-without=<list>\fR
A space\-separated list of groups referencing gems to skip during installation\. If a group is given that is in the remembered list of groups given to \-\-with, it is removed from that list\.
.IP
This option is deprecated in favor of the \fBwithout\fR setting\.
.SH "DEPLOYMENT MODE"
Bundler's defaults are optimized for development\. To switch to defaults optimized for deployment and for CI, use the \fB\-\-deployment\fR flag\. Do not activate deployment mode on development machines, as it will cause an error when the Gemfile(5) is modified\.
.IP "1." 4
A \fBGemfile\.lock\fR is required\.
.IP
To ensure that the same versions of the gems you developed with and tested with are also used in deployments, a \fBGemfile\.lock\fR is required\.
.IP
This is mainly to ensure that you remember to check your \fBGemfile\.lock\fR into version control\.
.IP "2." 4
The \fBGemfile\.lock\fR must be up to date
.IP
In development, you can modify your Gemfile(5) and re\-run \fBbundle install\fR to \fIconservatively update\fR your \fBGemfile\.lock\fR snapshot\.
.IP
In deployment, your \fBGemfile\.lock\fR should be up\-to\-date with changes made in your Gemfile(5)\.
.IP "3." 4
Gems are installed to \fBvendor/bundle\fR not your default system location
.IP
In development, it's convenient to share the gems used in your application with other applications and other scripts that run on the system\.
.IP
In deployment, isolation is a more important default\. In addition, the user deploying the application may not have permission to install gems to the system, or the web server may not have permission to read them\.
.IP
As a result, \fBbundle install \-\-deployment\fR installs gems to the \fBvendor/bundle\fR directory in the application\. This may be overridden using the \fB\-\-path\fR option\.
.IP "" 0
.SH "INSTALLING GROUPS"
By default, \fBbundle install\fR will install all gems in all groups in your Gemfile(5), except those declared for a different platform\.
.P
However, you can explicitly tell Bundler to skip installing certain groups with the \fB\-\-without\fR option\. This option takes a space\-separated list of groups\.
.P
While the \fB\-\-without\fR option will skip \fIinstalling\fR the gems in the specified groups, it will still \fIdownload\fR those gems and use them to resolve the dependencies of every gem in your Gemfile(5)\.
.P
This is so that installing a different set of groups on another machine (such as a production server) will not change the gems and versions that you have already developed and tested against\.
.P
\fBBundler offers a rock\-solid guarantee that the third\-party code you are running in development and testing is also the third\-party code you are running in production\. You can choose to exclude some of that code in different environments, but you will never be caught flat\-footed by different versions of third\-party code being used in different environments\.\fR
.P
For a simple illustration, consider the following Gemfile(5):
.IP "" 4
.nf
source 'https://rubygems\.org'
gem 'sinatra'
group :production do
gem 'rack\-perftools\-profiler'
end
.fi
.IP "" 0
.P
In this case, \fBsinatra\fR depends on any version of Rack (\fB>= 1\.0\fR), while \fBrack\-perftools\-profiler\fR depends on 1\.x (\fB~> 1\.0\fR)\.
.P
When you run \fBbundle install \-\-without production\fR in development, we look at the dependencies of \fBrack\-perftools\-profiler\fR as well\. That way, you do not spend all your time developing against Rack 2\.0, using new APIs unavailable in Rack 1\.x, only to have Bundler switch to Rack 1\.2 when the \fBproduction\fR group \fIis\fR used\.
.P
This should not cause any problems in practice, because we do not attempt to \fBinstall\fR the gems in the excluded groups, and only evaluate as part of the dependency resolution process\.
.P
This also means that you cannot include different versions of the same gem in different groups, because doing so would result in different sets of dependencies used in development and production\. Because of the vagaries of the dependency resolution process, this usually affects more than the gems you list in your Gemfile(5), and can (surprisingly) radically change the gems you are using\.
.SH "THE GEMFILE\.LOCK"
When you run \fBbundle install\fR, Bundler will persist the full names and versions of all gems that you used (including dependencies of the gems specified in the Gemfile(5)) into a file called \fBGemfile\.lock\fR\.
.P
Bundler uses this file in all subsequent calls to \fBbundle install\fR, which guarantees that you always use the same exact code, even as your application moves across machines\.
.P
Because of the way dependency resolution works, even a seemingly small change (for instance, an update to a point\-release of a dependency of a gem in your Gemfile(5)) can result in radically different gems being needed to satisfy all dependencies\.
.P
As a result, you \fBSHOULD\fR check your \fBGemfile\.lock\fR into version control, in both applications and gems\. If you do not, every machine that checks out your repository (including your production server) will resolve all dependencies again, which will result in different versions of third\-party code being used if \fBany\fR of the gems in the Gemfile(5) or any of their dependencies have been updated\.
.P
When Bundler first shipped, the \fBGemfile\.lock\fR was included in the \fB\.gitignore\fR file included with generated gems\. Over time, however, it became clear that this practice forces the pain of broken dependencies onto new contributors, while leaving existing contributors potentially unaware of the problem\. Since \fBbundle install\fR is usually the first step towards a contribution, the pain of broken dependencies would discourage new contributors from contributing\. As a result, we have revised our guidance for gem authors to now recommend checking in the lock for gems\.
.SH "CONSERVATIVE UPDATING"
When you make a change to the Gemfile(5) and then run \fBbundle install\fR, Bundler will update only the gems that you modified\.
.P
In other words, if a gem that you \fBdid not modify\fR worked before you called \fBbundle install\fR, it will continue to use the exact same versions of all dependencies as it used before the update\.
.P
Let's take a look at an example\. Here's your original Gemfile(5):
.IP "" 4
.nf
source 'https://rubygems\.org'
gem 'actionpack', '2\.3\.8'
gem 'activemerchant'
.fi
.IP "" 0
.P
In this case, both \fBactionpack\fR and \fBactivemerchant\fR depend on \fBactivesupport\fR\. The \fBactionpack\fR gem depends on \fBactivesupport 2\.3\.8\fR and \fBrack ~> 1\.1\.0\fR, while the \fBactivemerchant\fR gem depends on \fBactivesupport >= 2\.3\.2\fR, \fBbraintree >= 2\.0\.0\fR, and \fBbuilder >= 2\.0\.0\fR\.
.P
When the dependencies are first resolved, Bundler will select \fBactivesupport 2\.3\.8\fR, which satisfies the requirements of both gems in your Gemfile(5)\.
.P
Next, you modify your Gemfile(5) to:
.IP "" 4
.nf
source 'https://rubygems\.org'
gem 'actionpack', '3\.0\.0\.rc'
gem 'activemerchant'
.fi
.IP "" 0
.P
The \fBactionpack 3\.0\.0\.rc\fR gem has a number of new dependencies, and updates the \fBactivesupport\fR dependency to \fB= 3\.0\.0\.rc\fR and the \fBrack\fR dependency to \fB~> 1\.2\.1\fR\.
.P
When you run \fBbundle install\fR, Bundler notices that you changed the \fBactionpack\fR gem, but not the \fBactivemerchant\fR gem\. It evaluates the gems currently being used to satisfy its requirements:
.TP
\fBactivesupport 2\.3\.8\fR
also used to satisfy a dependency in \fBactivemerchant\fR, which is not being updated
.TP
\fBrack ~> 1\.1\.0\fR
not currently being used to satisfy another dependency
.P
Because you did not explicitly ask to update \fBactivemerchant\fR, you would not expect it to suddenly stop working after updating \fBactionpack\fR\. However, satisfying the new \fBactivesupport 3\.0\.0\.rc\fR dependency of actionpack requires updating one of its dependencies\.
.P
Even though \fBactivemerchant\fR declares a very loose dependency that theoretically matches \fBactivesupport 3\.0\.0\.rc\fR, Bundler treats gems in your Gemfile(5) that have not changed as an atomic unit together with their dependencies\. In this case, the \fBactivemerchant\fR dependency is treated as \fBactivemerchant 1\.7\.1 + activesupport 2\.3\.8\fR, so \fBbundle install\fR will report that it cannot update \fBactionpack\fR\.
.P
To explicitly update \fBactionpack\fR, including its dependencies which other gems in the Gemfile(5) still depend on, run \fBbundle update actionpack\fR (see \fBbundle update(1)\fR)\.
.P
\fBSummary\fR: In general, after making a change to the Gemfile(5) , you should first try to run \fBbundle install\fR, which will guarantee that no other gem in the Gemfile(5) is impacted by the change\. If that does not work, run bundle update(1) \fIbundle\-update\.1\.html\fR\.
.SH "SEE ALSO"
.IP "\(bu" 4
Gem install docs \fIhttps://guides\.rubygems\.org/rubygems\-basics/#installing\-gems\fR
.IP "\(bu" 4
Rubygems signing docs \fIhttps://guides\.rubygems\.org/security/\fR
.IP "" 0
share/man/man1/bundle-cache.1 0000644 00000006564 15173517734 0011701 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CACHE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application
.SH "SYNOPSIS"
\fBbundle cache\fR
.P
alias: \fBpackage\fR, \fBpack\fR
.SH "DESCRIPTION"
Copy all of the \fB\.gem\fR files needed to run the application into the \fBvendor/cache\fR directory\. In the future, when running \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR, use the gems in the cache in preference to the ones on \fBrubygems\.org\fR\.
.SH "GIT AND PATH GEMS"
The \fBbundle cache\fR command can also package \fB:git\fR and \fB:path\fR dependencies besides \.gem files\. This needs to be explicitly enabled via the \fB\-\-all\fR option\. Once used, the \fB\-\-all\fR option will be remembered\.
.SH "SUPPORT FOR MULTIPLE PLATFORMS"
When using gems that have different packages for different platforms, Bundler supports caching of gems for other platforms where the Gemfile has been resolved (i\.e\. present in the lockfile) in \fBvendor/cache\fR\. This needs to be enabled via the \fB\-\-all\-platforms\fR option\. This setting will be remembered in your local bundler configuration\.
.SH "REMOTE FETCHING"
By default, if you run \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR after running bundle cache(1) \fIbundle\-cache\.1\.html\fR, bundler will still connect to \fBrubygems\.org\fR to check whether a platform\-specific gem exists for any of the gems in \fBvendor/cache\fR\.
.P
For instance, consider this Gemfile(5):
.IP "" 4
.nf
source "https://rubygems\.org"
gem "nokogiri"
.fi
.IP "" 0
.P
If you run \fBbundle cache\fR under C Ruby, bundler will retrieve the version of \fBnokogiri\fR for the \fB"ruby"\fR platform\. If you deploy to JRuby and run \fBbundle install\fR, bundler is forced to check to see whether a \fB"java"\fR platformed \fBnokogiri\fR exists\.
.P
Even though the \fBnokogiri\fR gem for the Ruby platform is \fItechnically\fR acceptable on JRuby, it has a C extension that does not run on JRuby\. As a result, bundler will, by default, still connect to \fBrubygems\.org\fR to check whether it has a version of one of your gems more specific to your platform\.
.P
This problem is also not limited to the \fB"java"\fR platform\. A similar (common) problem can happen when developing on Windows and deploying to Linux, or even when developing on OSX and deploying to Linux\.
.P
If you know for sure that the gems packaged in \fBvendor/cache\fR are appropriate for the platform you are on, you can run \fBbundle install \-\-local\fR to skip checking for more appropriate gems, and use the ones in \fBvendor/cache\fR\.
.P
One way to be sure that you have the right platformed versions of all your gems is to run \fBbundle cache\fR on an identical machine and check in the gems\. For instance, you can run \fBbundle cache\fR on an identical staging box during your staging process, and check in the \fBvendor/cache\fR before deploying to production\.
.P
By default, bundle cache(1) \fIbundle\-cache\.1\.html\fR fetches and also installs the gems to the default location\. To package the dependencies to \fBvendor/cache\fR without installing them to the local install location, you can run \fBbundle cache \-\-no\-install\fR\.
.SH "HISTORY"
In Bundler 2\.1, \fBcache\fR took in the functionalities of \fBpackage\fR and now \fBpackage\fR and \fBpack\fR are aliases of \fBcache\fR\.
share/man/man1/bundle-add.1 0000644 00000004773 15173517734 0011366 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-ADD" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-add\fR \- Add gem to the Gemfile and run bundle install
.SH "SYNOPSIS"
\fBbundle add\fR \fIGEM_NAME\fR [\-\-group=GROUP] [\-\-version=VERSION] [\-\-source=SOURCE] [\-\-path=PATH] [\-\-git=GIT|\-\-github=GITHUB] [\-\-branch=BRANCH] [\-\-ref=REF] [\-\-skip\-install] [\-\-strict|\-\-optimistic]
.SH "DESCRIPTION"
Adds the named gem to the [\fBGemfile(5)\fR][Gemfile(5)] and run \fBbundle install\fR\. \fBbundle install\fR can be avoided by using the flag \fB\-\-skip\-install\fR\.
.SH "OPTIONS"
.TP
\fB\-\-version\fR, \fB\-v\fR
Specify version requirements(s) for the added gem\.
.TP
\fB\-\-group\fR, \fB\-g\fR
Specify the group(s) for the added gem\. Multiple groups should be separated by commas\.
.TP
\fB\-\-source\fR, \fB\-s\fR
Specify the source for the added gem\.
.TP
\fB\-\-require\fR, \fB\-r\fR
Adds require path to gem\. Provide false, or a path as a string\.
.TP
\fB\-\-path\fR
Specify the file system path for the added gem\.
.TP
\fB\-\-git\fR
Specify the git source for the added gem\.
.TP
\fB\-\-github\fR
Specify the github source for the added gem\.
.TP
\fB\-\-branch\fR
Specify the git branch for the added gem\.
.TP
\fB\-\-ref\fR
Specify the git ref for the added gem\.
.TP
\fB\-\-skip\-install\fR
Adds the gem to the Gemfile but does not install it\.
.TP
\fB\-\-optimistic\fR
Adds optimistic declaration of version\.
.TP
\fB\-\-strict\fR
Adds strict declaration of version\.
.SH "EXAMPLES"
.IP "1." 4
You can add the \fBrails\fR gem to the Gemfile without any version restriction\. The source of the gem will be the global source\.
.IP
\fBbundle add rails\fR
.IP "2." 4
You can add the \fBrails\fR gem with version greater than 1\.1 (not including 1\.1) and less than 3\.0\.
.IP
\fBbundle add rails \-\-version "> 1\.1, < 3\.0"\fR
.IP "3." 4
You can use the \fBhttps://gems\.example\.com\fR custom source and assign the gem to a group\.
.IP
\fBbundle add rails \-\-version "~> 5\.0\.0" \-\-source "https://gems\.example\.com" \-\-group "development"\fR
.IP "4." 4
The following adds the \fBgem\fR entry to the Gemfile without installing the gem\. You can install gems later via \fBbundle install\fR\.
.IP
\fBbundle add rails \-\-skip\-install\fR
.IP "5." 4
You can assign the gem to more than one group\.
.IP
\fBbundle add rails \-\-group "development, test"\fR
.IP "" 0
.SH "SEE ALSO"
Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR, bundle\-remove(1) \fIbundle\-remove\.1\.html\fR
share/man/man1/bundle-remove.1 0000644 00000001504 15173517734 0012120 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-REMOVE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-remove\fR \- Removes gems from the Gemfile
.SH "SYNOPSIS"
\fBbundle remove [GEM [GEM \|\.\|\.\|\.]] [\-\-install]\fR
.SH "DESCRIPTION"
Removes the given gems from the Gemfile while ensuring that the resulting Gemfile is still valid\. If a gem cannot be removed, a warning is printed\. If a gem is already absent from the Gemfile, and error is raised\.
.SH "OPTIONS"
.TP
\fB\-\-install\fR
Runs \fBbundle install\fR after the given gems have been removed from the Gemfile, which ensures that both the lockfile and the installed gems on disk are also updated to remove the given gem(s)\.
.P
Example:
.P
bundle remove rails
.P
bundle remove rails rack
.P
bundle remove rails rack \-\-install
share/man/man1/bundle-help.1 0000644 00000000700 15173517734 0011550 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-HELP" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-help\fR \- Displays detailed help for each subcommand
.SH "SYNOPSIS"
\fBbundle help\fR [COMMAND]
.SH "DESCRIPTION"
Displays detailed help for the given subcommand\. You can specify a single \fBCOMMAND\fR at the same time\. When \fBCOMMAND\fR is omitted, help for \fBhelp\fR command will be displayed\.
share/man/man1/bundle-binstubs.1 0000644 00000003067 15173517734 0012462 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-BINSTUBS" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-binstubs\fR \- Install the binstubs of the listed gems
.SH "SYNOPSIS"
\fBbundle binstubs\fR \fIGEM_NAME\fR [\-\-force] [\-\-path PATH] [\-\-standalone]
.SH "DESCRIPTION"
Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it into \fBbin/\fR\. Binstubs are a shortcut\-or alternative\- to always using \fBbundle exec\fR\. This gives you a file that can be run directly, and one that will always run the correct gem version used by the application\.
.P
For example, if you run \fBbundle binstubs rspec\-core\fR, Bundler will create the file \fBbin/rspec\fR\. That file will contain enough code to load Bundler, tell it to load the bundled gems, and then run rspec\.
.P
This command generates binstubs for executables in \fBGEM_NAME\fR\. Binstubs are put into \fBbin\fR, or the \fB\-\-path\fR directory if one has been set\. Calling binstubs with [GEM [GEM]] will create binstubs for all given gems\.
.SH "OPTIONS"
.TP
\fB\-\-force\fR
Overwrite existing binstubs if they exist\.
.TP
\fB\-\-path\fR
The location to install the specified binstubs to\. This defaults to \fBbin\fR\.
.TP
\fB\-\-standalone\fR
Makes binstubs that can work without depending on Rubygems or Bundler at runtime\.
.TP
\fB\-\-shebang\fR
Specify a different shebang executable name than the default (default 'ruby')
.TP
\fB\-\-all\fR
Create binstubs for all gems in the bundle\.
share/man/man1/bundle-exec.1 0000644 00000014702 15173517734 0011553 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-EXEC" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-exec\fR \- Execute a command in the context of the bundle
.SH "SYNOPSIS"
\fBbundle exec\fR [\-\-keep\-file\-descriptors] \fIcommand\fR
.SH "DESCRIPTION"
This command executes the command, making all gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] available to \fBrequire\fR in Ruby programs\.
.P
Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] and installed via bundle install(1) \fIbundle\-install\.1\.html\fR, you should run \fBbundle exec rspec spec/my_spec\.rb\fR\.
.P
Note that \fBbundle exec\fR does not require that an executable is available on your shell's \fB$PATH\fR\.
.SH "OPTIONS"
.TP
\fB\-\-keep\-file\-descriptors\fR
Passes all file descriptors to the new processes\. Default is true from bundler version 2\.2\.26\. Setting it to false is now deprecated\.
.SH "BUNDLE INSTALL \-\-BINSTUBS"
If you use the \fB\-\-binstubs\fR flag in bundle install(1) \fIbundle\-install\.1\.html\fR, Bundler will automatically create a directory (which defaults to \fBapp_root/bin\fR) containing all of the executables available from gems in the bundle\.
.P
After using \fB\-\-binstubs\fR, \fBbin/rspec spec/my_spec\.rb\fR is identical to \fBbundle exec rspec spec/my_spec\.rb\fR\.
.SH "ENVIRONMENT MODIFICATIONS"
\fBbundle exec\fR makes a number of changes to the shell environment, then executes the command you specify in full\.
.IP "\(bu" 4
make sure that it's still possible to shell out to \fBbundle\fR from inside a command invoked by \fBbundle exec\fR (using \fB$BUNDLE_BIN_PATH\fR)
.IP "\(bu" 4
put the directory containing executables (like \fBrails\fR, \fBrspec\fR, \fBrackup\fR) for your bundle on \fB$PATH\fR
.IP "\(bu" 4
make sure that if bundler is invoked in the subshell, it uses the same \fBGemfile\fR (by setting \fBBUNDLE_GEMFILE\fR)
.IP "\(bu" 4
add \fB\-rbundler/setup\fR to \fB$RUBYOPT\fR, which makes sure that Ruby programs invoked in the subshell can see the gems in the bundle
.IP "" 0
.P
It also modifies Rubygems:
.IP "\(bu" 4
disallow loading additional gems not in the bundle
.IP "\(bu" 4
modify the \fBgem\fR method to be a no\-op if a gem matching the requirements is in the bundle, and to raise a \fBGem::LoadError\fR if it's not
.IP "\(bu" 4
Define \fBGem\.refresh\fR to be a no\-op, since the source index is always frozen when using bundler, and to prevent gems from the system leaking into the environment
.IP "\(bu" 4
Override \fBGem\.bin_path\fR to use the gems in the bundle, making system executables work
.IP "\(bu" 4
Add all gems in the bundle into Gem\.loaded_specs
.IP "" 0
.P
Finally, \fBbundle exec\fR also implicitly modifies \fBGemfile\.lock\fR if the lockfile and the Gemfile do not match\. Bundler needs the Gemfile to determine things such as a gem's groups, \fBautorequire\fR, and platforms, etc\., and that information isn't stored in the lockfile\. The Gemfile and lockfile must be synced in order to \fBbundle exec\fR successfully, so \fBbundle exec\fR updates the lockfile beforehand\.
.SS "Loading"
By default, when attempting to \fBbundle exec\fR to a file with a ruby shebang, Bundler will \fBKernel\.load\fR that file instead of using \fBKernel\.exec\fR\. For the vast majority of cases, this is a performance improvement\. In a rare few cases, this could cause some subtle side\-effects (such as dependence on the exact contents of \fB$0\fR or \fB__FILE__\fR) and the optimization can be disabled by enabling the \fBdisable_exec_load\fR setting\.
.SS "Shelling out"
Any Ruby code that opens a subshell (like \fBsystem\fR, backticks, or \fB%x{}\fR) will automatically use the current Bundler environment\. If you need to shell out to a Ruby command that is not part of your current bundle, use the \fBwith_unbundled_env\fR method with a block\. Any subshells created inside the block will be given the environment present before Bundler was activated\. For example, Homebrew commands run Ruby, but don't work inside a bundle:
.IP "" 4
.nf
Bundler\.with_unbundled_env do
`brew install wget`
end
.fi
.IP "" 0
.P
Using \fBwith_unbundled_env\fR is also necessary if you are shelling out to a different bundle\. Any Bundler commands run in a subshell will inherit the current Gemfile, so commands that need to run in the context of a different bundle also need to use \fBwith_unbundled_env\fR\.
.IP "" 4
.nf
Bundler\.with_unbundled_env do
Dir\.chdir "/other/bundler/project" do
`bundle exec \./script`
end
end
.fi
.IP "" 0
.P
Bundler provides convenience helpers that wrap \fBsystem\fR and \fBexec\fR, and they can be used like this:
.IP "" 4
.nf
Bundler\.clean_system('brew install wget')
Bundler\.clean_exec('brew install wget')
.fi
.IP "" 0
.SH "RUBYGEMS PLUGINS"
At present, the Rubygems plugin system requires all files named \fBrubygems_plugin\.rb\fR on the load path of \fIany\fR installed gem when any Ruby code requires \fBrubygems\.rb\fR\. This includes executables installed into the system, like \fBrails\fR, \fBrackup\fR, and \fBrspec\fR\.
.P
Since Rubygems plugins can contain arbitrary Ruby code, they commonly end up activating themselves or their dependencies\.
.P
For instance, the \fBgemcutter 0\.5\fR gem depended on \fBjson_pure\fR\. If you had that version of gemcutter installed (even if you \fIalso\fR had a newer version without this problem), Rubygems would activate \fBgemcutter 0\.5\fR and \fBjson_pure <latest>\fR\.
.P
If your Gemfile(5) also contained \fBjson_pure\fR (or a gem with a dependency on \fBjson_pure\fR), the latest version on your system might conflict with the version in your Gemfile(5), or the snapshot version in your \fBGemfile\.lock\fR\.
.P
If this happens, bundler will say:
.IP "" 4
.nf
You have already activated json_pure 1\.4\.6 but your Gemfile
requires json_pure 1\.4\.3\. Consider using bundle exec\.
.fi
.IP "" 0
.P
In this situation, you almost certainly want to remove the underlying gem with the problematic gem plugin\. In general, the authors of these plugins (in this case, the \fBgemcutter\fR gem) have released newer versions that are more careful in their plugins\.
.P
You can find a list of all the gems containing gem plugins by running
.IP "" 4
.nf
ruby \-e "puts Gem\.find_files('rubygems_plugin\.rb')"
.fi
.IP "" 0
.P
At the very least, you should remove all but the newest version of each gem plugin, and also remove all gem plugins that you aren't using (\fBgem uninstall gem_name\fR)\.
share/man/man1/bundle-gem.1 0000644 00000012750 15173517734 0011400 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-GEM" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-gem\fR \- Generate a project skeleton for creating a rubygem
.SH "SYNOPSIS"
\fBbundle gem\fR \fIGEM_NAME\fR \fIOPTIONS\fR
.SH "DESCRIPTION"
Generates a directory named \fBGEM_NAME\fR with a \fBRakefile\fR, \fBGEM_NAME\.gemspec\fR, and other supporting files and directories that can be used to develop a rubygem with that name\.
.P
Run \fBrake \-T\fR in the resulting project for a list of Rake tasks that can be used to test and publish the gem to rubygems\.org\.
.P
The generated project skeleton can be customized with OPTIONS, as explained below\. Note that these options can also be specified via Bundler's global configuration file using the following names:
.IP "\(bu" 4
\fBgem\.coc\fR
.IP "\(bu" 4
\fBgem\.mit\fR
.IP "\(bu" 4
\fBgem\.test\fR
.IP "" 0
.SH "OPTIONS"
.IP "\(bu" 4
\fB\-\-exe\fR or \fB\-b\fR or \fB\-\-bin\fR: Specify that Bundler should create a binary executable (as \fBexe/GEM_NAME\fR) in the generated rubygem project\. This binary will also be added to the \fBGEM_NAME\.gemspec\fR manifest\. This behavior is disabled by default\.
.IP "\(bu" 4
\fB\-\-no\-exe\fR: Do not create a binary (overrides \fB\-\-exe\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-coc\fR: Add a \fBCODE_OF_CONDUCT\.md\fR file to the root of the generated project\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-coc\fR: Do not create a \fBCODE_OF_CONDUCT\.md\fR (overrides \fB\-\-coc\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-ext=c\fR, \fB\-\-ext=rust\fR Add boilerplate for C or Rust (currently magnus \fIhttps://docs\.rs/magnus\fR based) extension code to the generated project\. This behavior is disabled by default\.
.IP "\(bu" 4
\fB\-\-no\-ext\fR: Do not add extension code (overrides \fB\-\-ext\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-mit\fR: Add an MIT license to a \fBLICENSE\.txt\fR file in the root of the generated project\. Your name from the global git config is used for the copyright statement\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-mit\fR: Do not create a \fBLICENSE\.txt\fR (overrides \fB\-\-mit\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-t\fR, \fB\-\-test=minitest\fR, \fB\-\-test=rspec\fR, \fB\-\-test=test\-unit\fR: Specify the test framework that Bundler should use when generating the project\. Acceptable values are \fBminitest\fR, \fBrspec\fR and \fBtest\-unit\fR\. The \fBGEM_NAME\.gemspec\fR will be configured and a skeleton test/spec directory will be created based on this option\. Given no option is specified:
.IP
When Bundler is configured to generate tests, this defaults to Bundler's global config setting \fBgem\.test\fR\.
.IP
When Bundler is configured to not generate tests, an interactive prompt will be displayed and the answer will be used for the current rubygem project\.
.IP
When Bundler is unconfigured, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-test\fR: Do not use a test framework (overrides \fB\-\-test\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-ci\fR, \fB\-\-ci=github\fR, \fB\-\-ci=gitlab\fR, \fB\-\-ci=circle\fR: Specify the continuous integration service that Bundler should use when generating the project\. Acceptable values are \fBgithub\fR, \fBgitlab\fR and \fBcircle\fR\. A configuration file will be generated in the project directory\. Given no option is specified:
.IP
When Bundler is configured to generate CI files, this defaults to Bundler's global config setting \fBgem\.ci\fR\.
.IP
When Bundler is configured to not generate CI files, an interactive prompt will be displayed and the answer will be used for the current rubygem project\.
.IP
When Bundler is unconfigured, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-ci\fR: Do not use a continuous integration service (overrides \fB\-\-ci\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-linter\fR, \fB\-\-linter=rubocop\fR, \fB\-\-linter=standard\fR: Specify the linter and code formatter that Bundler should add to the project's development dependencies\. Acceptable values are \fBrubocop\fR and \fBstandard\fR\. A configuration file will be generated in the project directory\. Given no option is specified:
.IP
When Bundler is configured to add a linter, this defaults to Bundler's global config setting \fBgem\.linter\fR\.
.IP
When Bundler is configured not to add a linter, an interactive prompt will be displayed and the answer will be used for the current rubygem project\.
.IP
When Bundler is unconfigured, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-linter\fR: Do not add a linter (overrides \fB\-\-linter\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-e\fR, \fB\-\-edit[=EDITOR]\fR: Open the resulting GEM_NAME\.gemspec in EDITOR, or the default editor if not specified\. The default is \fB$BUNDLER_EDITOR\fR, \fB$VISUAL\fR, or \fB$EDITOR\fR\.
.IP "" 0
.SH "SEE ALSO"
.IP "\(bu" 4
bundle config(1) \fIbundle\-config\.1\.html\fR
.IP "" 0
share/man/man1/bundle.1 0000644 00000007260 15173517734 0010632 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\fR \- Ruby Dependency Management
.SH "SYNOPSIS"
\fBbundle\fR COMMAND [\-\-no\-color] [\-\-verbose] [ARGS]
.SH "DESCRIPTION"
Bundler manages an \fBapplication's dependencies\fR through its entire life across many machines systematically and repeatably\.
.P
See the bundler website \fIhttps://bundler\.io\fR for information on getting started, and Gemfile(5) for more information on the \fBGemfile\fR format\.
.SH "OPTIONS"
.TP
\fB\-\-no\-color\fR
Print all output without color
.TP
\fB\-\-retry\fR, \fB\-r\fR
Specify the number of times you wish to attempt network commands
.TP
\fB\-\-verbose\fR, \fB\-V\fR
Print out additional logging information
.SH "BUNDLE COMMANDS"
We divide \fBbundle\fR subcommands into primary commands and utilities:
.SH "PRIMARY COMMANDS"
.TP
\fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR
Install the gems specified by the \fBGemfile\fR or \fBGemfile\.lock\fR
.TP
\fBbundle update(1)\fR \fIbundle\-update\.1\.html\fR
Update dependencies to their latest versions
.TP
\fBbundle cache(1)\fR \fIbundle\-cache\.1\.html\fR
Package the \.gem files required by your application into the \fBvendor/cache\fR directory (aliases: \fBbundle package\fR, \fBbundle pack\fR)
.TP
\fBbundle exec(1)\fR \fIbundle\-exec\.1\.html\fR
Execute a script in the current bundle
.TP
\fBbundle config(1)\fR \fIbundle\-config\.1\.html\fR
Specify and read configuration options for Bundler
.TP
\fBbundle help(1)\fR \fIbundle\-help\.1\.html\fR
Display detailed help for each subcommand
.SH "UTILITIES"
.TP
\fBbundle add(1)\fR \fIbundle\-add\.1\.html\fR
Add the named gem to the Gemfile and run \fBbundle install\fR
.TP
\fBbundle binstubs(1)\fR \fIbundle\-binstubs\.1\.html\fR
Generate binstubs for executables in a gem
.TP
\fBbundle check(1)\fR \fIbundle\-check\.1\.html\fR
Determine whether the requirements for your application are installed and available to Bundler
.TP
\fBbundle show(1)\fR \fIbundle\-show\.1\.html\fR
Show the source location of a particular gem in the bundle
.TP
\fBbundle outdated(1)\fR \fIbundle\-outdated\.1\.html\fR
Show all of the outdated gems in the current bundle
.TP
\fBbundle console(1)\fR (deprecated)
Start an IRB session in the current bundle
.TP
\fBbundle open(1)\fR \fIbundle\-open\.1\.html\fR
Open an installed gem in the editor
.TP
\fBbundle lock(1)\fR \fIbundle\-lock\.1\.html\fR
Generate a lockfile for your dependencies
.TP
\fBbundle viz(1)\fR \fIbundle\-viz\.1\.html\fR (deprecated)
Generate a visual representation of your dependencies
.TP
\fBbundle init(1)\fR \fIbundle\-init\.1\.html\fR
Generate a simple \fBGemfile\fR, placed in the current directory
.TP
\fBbundle gem(1)\fR \fIbundle\-gem\.1\.html\fR
Create a simple gem, suitable for development with Bundler
.TP
\fBbundle platform(1)\fR \fIbundle\-platform\.1\.html\fR
Display platform compatibility information
.TP
\fBbundle clean(1)\fR \fIbundle\-clean\.1\.html\fR
Clean up unused gems in your Bundler directory
.TP
\fBbundle doctor(1)\fR \fIbundle\-doctor\.1\.html\fR
Display warnings about common problems
.TP
\fBbundle remove(1)\fR \fIbundle\-remove\.1\.html\fR
Removes gems from the Gemfile
.TP
\fBbundle plugin(1)\fR \fIbundle\-plugin\.1\.html\fR
Manage Bundler plugins
.TP
\fBbundle version(1)\fR \fIbundle\-version\.1\.html\fR
Prints Bundler version information
.SH "PLUGINS"
When running a command that isn't listed in PRIMARY COMMANDS or UTILITIES, Bundler will try to find an executable on your path named \fBbundler\-<command>\fR and execute it, passing down any extra arguments to it\.
.SH "OBSOLETE"
These commands are obsolete and should no longer be used:
.IP "\(bu" 4
\fBbundle inject(1)\fR
.IP "" 0
share/man/man1/bundle-init.1 0000644 00000002176 15173517734 0011574 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INIT" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-init\fR \- Generates a Gemfile into the current working directory
.SH "SYNOPSIS"
\fBbundle init\fR [\-\-gemspec=FILE]
.SH "DESCRIPTION"
Init generates a default [\fBGemfile(5)\fR][Gemfile(5)] in the current working directory\. When adding a [\fBGemfile(5)\fR][Gemfile(5)] to a gem with a gemspec, the \fB\-\-gemspec\fR option will automatically add each dependency listed in the gemspec file to the newly created [\fBGemfile(5)\fR][Gemfile(5)]\.
.SH "OPTIONS"
.TP
\fB\-\-gemspec\fR
Use the specified \.gemspec to create the [\fBGemfile(5)\fR][Gemfile(5)]
.TP
\fB\-\-gemfile\fR
Use the specified name for the gemfile instead of \fBGemfile\fR
.SH "FILES"
Included in the default [\fBGemfile(5)\fR][Gemfile(5)] generated is the line \fB# frozen_string_literal: true\fR\. This is a magic comment supported for the first time in Ruby 2\.3\. The presence of this line results in all string literals in the file being implicitly frozen\.
.SH "SEE ALSO"
Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR
share/ruby/fileutils.rb 0000644 00000235277 15173517734 0011211 0 ustar 00 # frozen_string_literal: true
begin
require 'rbconfig'
rescue LoadError
# for make rjit-headers
end
# Namespace for file utility methods for copying, moving, removing, etc.
#
# == What's Here
#
# First, what’s elsewhere. \Module \FileUtils:
#
# - Inherits from {class Object}[rdoc-ref:Object].
# - Supplements {class File}[rdoc-ref:File]
# (but is not included or extended there).
#
# Here, module \FileUtils provides methods that are useful for:
#
# - {Creating}[rdoc-ref:FileUtils@Creating].
# - {Deleting}[rdoc-ref:FileUtils@Deleting].
# - {Querying}[rdoc-ref:FileUtils@Querying].
# - {Setting}[rdoc-ref:FileUtils@Setting].
# - {Comparing}[rdoc-ref:FileUtils@Comparing].
# - {Copying}[rdoc-ref:FileUtils@Copying].
# - {Moving}[rdoc-ref:FileUtils@Moving].
# - {Options}[rdoc-ref:FileUtils@Options].
#
# === Creating
#
# - ::mkdir: Creates directories.
# - ::mkdir_p, ::makedirs, ::mkpath: Creates directories,
# also creating ancestor directories as needed.
# - ::link_entry: Creates a hard link.
# - ::ln, ::link: Creates hard links.
# - ::ln_s, ::symlink: Creates symbolic links.
# - ::ln_sf: Creates symbolic links, overwriting if necessary.
# - ::ln_sr: Creates symbolic links relative to targets
#
# === Deleting
#
# - ::remove_dir: Removes a directory and its descendants.
# - ::remove_entry: Removes an entry, including its descendants if it is a directory.
# - ::remove_entry_secure: Like ::remove_entry, but removes securely.
# - ::remove_file: Removes a file entry.
# - ::rm, ::remove: Removes entries.
# - ::rm_f, ::safe_unlink: Like ::rm, but removes forcibly.
# - ::rm_r: Removes entries and their descendants.
# - ::rm_rf, ::rmtree: Like ::rm_r, but removes forcibly.
# - ::rmdir: Removes directories.
#
# === Querying
#
# - ::pwd, ::getwd: Returns the path to the working directory.
# - ::uptodate?: Returns whether a given entry is newer than given other entries.
#
# === Setting
#
# - ::cd, ::chdir: Sets the working directory.
# - ::chmod: Sets permissions for an entry.
# - ::chmod_R: Sets permissions for an entry and its descendants.
# - ::chown: Sets the owner and group for entries.
# - ::chown_R: Sets the owner and group for entries and their descendants.
# - ::touch: Sets modification and access times for entries,
# creating if necessary.
#
# === Comparing
#
# - ::compare_file, ::cmp, ::identical?: Returns whether two entries are identical.
# - ::compare_stream: Returns whether two streams are identical.
#
# === Copying
#
# - ::copy_entry: Recursively copies an entry.
# - ::copy_file: Copies an entry.
# - ::copy_stream: Copies a stream.
# - ::cp, ::copy: Copies files.
# - ::cp_lr: Recursively creates hard links.
# - ::cp_r: Recursively copies files, retaining mode, owner, and group.
# - ::install: Recursively copies files, optionally setting mode,
# owner, and group.
#
# === Moving
#
# - ::mv, ::move: Moves entries.
#
# === Options
#
# - ::collect_method: Returns the names of methods that accept a given option.
# - ::commands: Returns the names of methods that accept options.
# - ::have_option?: Returns whether a given method accepts a given option.
# - ::options: Returns all option names.
# - ::options_of: Returns the names of the options for a given method.
#
# == Path Arguments
#
# Some methods in \FileUtils accept _path_ arguments,
# which are interpreted as paths to filesystem entries:
#
# - If the argument is a string, that value is the path.
# - If the argument has method +:to_path+, it is converted via that method.
# - If the argument has method +:to_str+, it is converted via that method.
#
# == About the Examples
#
# Some examples here involve trees of file entries.
# For these, we sometimes display trees using the
# {tree command-line utility}[https://en.wikipedia.org/wiki/Tree_(command)],
# which is a recursive directory-listing utility that produces
# a depth-indented listing of files and directories.
#
# We use a helper method to launch the command and control the format:
#
# def tree(dirpath = '.')
# command = "tree --noreport --charset=ascii #{dirpath}"
# system(command)
# end
#
# To illustrate:
#
# tree('src0')
# # => src0
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# == Avoiding the TOCTTOU Vulnerability
#
# For certain methods that recursively remove entries,
# there is a potential vulnerability called the
# {Time-of-check to time-of-use}[https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use],
# or TOCTTOU, vulnerability that can exist when:
#
# - An ancestor directory of the entry at the target path is world writable;
# such directories include <tt>/tmp</tt>.
# - The directory tree at the target path includes:
#
# - A world-writable descendant directory.
# - A symbolic link.
#
# To avoid that vulnerability, you can use this method to remove entries:
#
# - FileUtils.remove_entry_secure: removes recursively
# if the target path points to a directory.
#
# Also available are these methods,
# each of which calls \FileUtils.remove_entry_secure:
#
# - FileUtils.rm_r with keyword argument <tt>secure: true</tt>.
# - FileUtils.rm_rf with keyword argument <tt>secure: true</tt>.
#
# Finally, this method for moving entries calls \FileUtils.remove_entry_secure
# if the source and destination are on different file systems
# (which means that the "move" is really a copy and remove):
#
# - FileUtils.mv with keyword argument <tt>secure: true</tt>.
#
# \Method \FileUtils.remove_entry_secure removes securely
# by applying a special pre-process:
#
# - If the target path points to a directory, this method uses methods
# {File#chown}[rdoc-ref:File#chown]
# and {File#chmod}[rdoc-ref:File#chmod]
# in removing directories.
# - The owner of the target directory should be either the current process
# or the super user (root).
#
# WARNING: You must ensure that *ALL* parent directories cannot be
# moved by other untrusted users. For example, parent directories
# should not be owned by untrusted users, and should not be world
# writable except when the sticky bit is set.
#
# For details of this security vulnerability, see Perl cases:
#
# - {CVE-2005-0448}[https://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2005-0448].
# - {CVE-2004-0452}[https://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2004-0452].
#
module FileUtils
VERSION = "1.7.2"
def self.private_module_function(name) #:nodoc:
module_function name
private_class_method name
end
#
# Returns a string containing the path to the current directory:
#
# FileUtils.pwd # => "/rdoc/fileutils"
#
# Related: FileUtils.cd.
#
def pwd
Dir.pwd
end
module_function :pwd
alias getwd pwd
module_function :getwd
# Changes the working directory to the given +dir+, which
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments]:
#
# With no block given,
# changes the current directory to the directory at +dir+; returns zero:
#
# FileUtils.pwd # => "/rdoc/fileutils"
# FileUtils.cd('..')
# FileUtils.pwd # => "/rdoc"
# FileUtils.cd('fileutils')
#
# With a block given, changes the current directory to the directory
# at +dir+, calls the block with argument +dir+,
# and restores the original current directory; returns the block's value:
#
# FileUtils.pwd # => "/rdoc/fileutils"
# FileUtils.cd('..') { |arg| [arg, FileUtils.pwd] } # => ["..", "/rdoc"]
# FileUtils.pwd # => "/rdoc/fileutils"
#
# Keyword arguments:
#
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.cd('..')
# FileUtils.cd('fileutils')
#
# Output:
#
# cd ..
# cd fileutils
#
# Related: FileUtils.pwd.
#
def cd(dir, verbose: nil, &block) # :yield: dir
fu_output_message "cd #{dir}" if verbose
result = Dir.chdir(dir, &block)
fu_output_message 'cd -' if verbose and block
result
end
module_function :cd
alias chdir cd
module_function :chdir
#
# Returns +true+ if the file at path +new+
# is newer than all the files at paths in array +old_list+;
# +false+ otherwise.
#
# Argument +new+ and the elements of +old_list+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments]:
#
# FileUtils.uptodate?('Rakefile', ['Gemfile', 'README.md']) # => true
# FileUtils.uptodate?('Gemfile', ['Rakefile', 'README.md']) # => false
#
# A non-existent file is considered to be infinitely old.
#
# Related: FileUtils.touch.
#
def uptodate?(new, old_list)
return false unless File.exist?(new)
new_time = File.mtime(new)
old_list.each do |old|
if File.exist?(old)
return false unless new_time > File.mtime(old)
end
end
true
end
module_function :uptodate?
def remove_trailing_slash(dir) #:nodoc:
dir == '/' ? dir : dir.chomp(?/)
end
private_module_function :remove_trailing_slash
#
# Creates directories at the paths in the given +list+
# (a single path or an array of paths);
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, creates a directory at each +path+ in +list+
# by calling: <tt>Dir.mkdir(path, mode)</tt>;
# see {Dir.mkdir}[rdoc-ref:Dir.mkdir]:
#
# FileUtils.mkdir(%w[tmp0 tmp1]) # => ["tmp0", "tmp1"]
# FileUtils.mkdir('tmp4') # => ["tmp4"]
#
# Keyword arguments:
#
# - <tt>mode: <i>mode</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
# see {File.chmod}[rdoc-ref:File.chmod].
# - <tt>noop: true</tt> - does not create directories.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.mkdir(%w[tmp0 tmp1], verbose: true)
# FileUtils.mkdir(%w[tmp2 tmp3], mode: 0700, verbose: true)
#
# Output:
#
# mkdir tmp0 tmp1
# mkdir -m 700 tmp2 tmp3
#
# Raises an exception if any path points to an existing
# file or directory, or if for any reason a directory cannot be created.
#
# Related: FileUtils.mkdir_p.
#
def mkdir(list, mode: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "mkdir #{mode ? ('-m %03o ' % mode) : ''}#{list.join ' '}" if verbose
return if noop
list.each do |dir|
fu_mkdir dir, mode
end
end
module_function :mkdir
#
# Creates directories at the paths in the given +list+
# (a single path or an array of paths),
# also creating ancestor directories as needed;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, creates a directory at each +path+ in +list+,
# along with any needed ancestor directories,
# by calling: <tt>Dir.mkdir(path, mode)</tt>;
# see {Dir.mkdir}[rdoc-ref:Dir.mkdir]:
#
# FileUtils.mkdir_p(%w[tmp0/tmp1 tmp2/tmp3]) # => ["tmp0/tmp1", "tmp2/tmp3"]
# FileUtils.mkdir_p('tmp4/tmp5') # => ["tmp4/tmp5"]
#
# Keyword arguments:
#
# - <tt>mode: <i>mode</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
# see {File.chmod}[rdoc-ref:File.chmod].
# - <tt>noop: true</tt> - does not create directories.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.mkdir_p(%w[tmp0 tmp1], verbose: true)
# FileUtils.mkdir_p(%w[tmp2 tmp3], mode: 0700, verbose: true)
#
# Output:
#
# mkdir -p tmp0 tmp1
# mkdir -p -m 700 tmp2 tmp3
#
# Raises an exception if for any reason a directory cannot be created.
#
# FileUtils.mkpath and FileUtils.makedirs are aliases for FileUtils.mkdir_p.
#
# Related: FileUtils.mkdir.
#
def mkdir_p(list, mode: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "mkdir -p #{mode ? ('-m %03o ' % mode) : ''}#{list.join ' '}" if verbose
return *list if noop
list.each do |item|
path = remove_trailing_slash(item)
stack = []
until File.directory?(path) || File.dirname(path) == path
stack.push path
path = File.dirname(path)
end
stack.reverse_each do |dir|
begin
fu_mkdir dir, mode
rescue SystemCallError
raise unless File.directory?(dir)
end
end
end
return *list
end
module_function :mkdir_p
alias mkpath mkdir_p
alias makedirs mkdir_p
module_function :mkpath
module_function :makedirs
def fu_mkdir(path, mode) #:nodoc:
path = remove_trailing_slash(path)
if mode
Dir.mkdir path, mode
File.chmod mode, path
else
Dir.mkdir path
end
end
private_module_function :fu_mkdir
#
# Removes directories at the paths in the given +list+
# (a single path or an array of paths);
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, removes the directory at each +path+ in +list+,
# by calling: <tt>Dir.rmdir(path)</tt>;
# see {Dir.rmdir}[rdoc-ref:Dir.rmdir]:
#
# FileUtils.rmdir(%w[tmp0/tmp1 tmp2/tmp3]) # => ["tmp0/tmp1", "tmp2/tmp3"]
# FileUtils.rmdir('tmp4/tmp5') # => ["tmp4/tmp5"]
#
# Keyword arguments:
#
# - <tt>parents: true</tt> - removes successive ancestor directories
# if empty.
# - <tt>noop: true</tt> - does not remove directories.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.rmdir(%w[tmp0/tmp1 tmp2/tmp3], parents: true, verbose: true)
# FileUtils.rmdir('tmp4/tmp5', parents: true, verbose: true)
#
# Output:
#
# rmdir -p tmp0/tmp1 tmp2/tmp3
# rmdir -p tmp4/tmp5
#
# Raises an exception if a directory does not exist
# or if for any reason a directory cannot be removed.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rmdir(list, parents: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "rmdir #{parents ? '-p ' : ''}#{list.join ' '}" if verbose
return if noop
list.each do |dir|
Dir.rmdir(dir = remove_trailing_slash(dir))
if parents
begin
until (parent = File.dirname(dir)) == '.' or parent == dir
dir = parent
Dir.rmdir(dir)
end
rescue Errno::ENOTEMPTY, Errno::EEXIST, Errno::ENOENT
end
end
end
end
module_function :rmdir
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# When +src+ is the path to an existing file
# and +dest+ is the path to a non-existent file,
# creates a hard link at +dest+ pointing to +src+; returns zero:
#
# Dir.children('tmp0/') # => ["t.txt"]
# Dir.children('tmp1/') # => []
# FileUtils.ln('tmp0/t.txt', 'tmp1/t.lnk') # => 0
# Dir.children('tmp1/') # => ["t.lnk"]
#
# When +src+ is the path to an existing file
# and +dest+ is the path to an existing directory,
# creates a hard link at <tt>dest/src</tt> pointing to +src+; returns zero:
#
# Dir.children('tmp2') # => ["t.dat"]
# Dir.children('tmp3') # => []
# FileUtils.ln('tmp2/t.dat', 'tmp3') # => 0
# Dir.children('tmp3') # => ["t.dat"]
#
# When +src+ is an array of paths to existing files
# and +dest+ is the path to an existing directory,
# then for each path +target+ in +src+,
# creates a hard link at <tt>dest/target</tt> pointing to +target+;
# returns +src+:
#
# Dir.children('tmp4/') # => []
# FileUtils.ln(['tmp0/t.txt', 'tmp2/t.dat'], 'tmp4/') # => ["tmp0/t.txt", "tmp2/t.dat"]
# Dir.children('tmp4/') # => ["t.dat", "t.txt"]
#
# Keyword arguments:
#
# - <tt>force: true</tt> - overwrites +dest+ if it exists.
# - <tt>noop: true</tt> - does not create links.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.ln('tmp0/t.txt', 'tmp1/t.lnk', verbose: true)
# FileUtils.ln('tmp2/t.dat', 'tmp3', verbose: true)
# FileUtils.ln(['tmp0/t.txt', 'tmp2/t.dat'], 'tmp4/', verbose: true)
#
# Output:
#
# ln tmp0/t.txt tmp1/t.lnk
# ln tmp2/t.dat tmp3
# ln tmp0/t.txt tmp2/t.dat tmp4/
#
# Raises an exception if +dest+ is the path to an existing file
# and keyword argument +force+ is not +true+.
#
# Related: FileUtils.link_entry (has different options).
#
def ln(src, dest, force: nil, noop: nil, verbose: nil)
fu_output_message "ln#{force ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest0(src, dest) do |s,d|
remove_file d, true if force
File.link s, d
end
end
module_function :ln
alias link ln
module_function :link
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a directory and +dest+ does not exist,
# creates links +dest+ and descendents pointing to +src+ and its descendents:
#
# tree('src0')
# # => src0
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
# File.exist?('dest0') # => false
# FileUtils.cp_lr('src0', 'dest0')
# tree('dest0')
# # => dest0
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ and +dest+ are both paths to directories,
# creates links <tt>dest/src</tt> and descendents
# pointing to +src+ and its descendents:
#
# tree('src1')
# # => src1
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
# FileUtils.mkdir('dest1')
# FileUtils.cp_lr('src1', 'dest1')
# tree('dest1')
# # => dest1
# # `-- src1
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ is an array of paths to entries and +dest+ is the path to a directory,
# for each path +filepath+ in +src+, creates a link at <tt>dest/filepath</tt>
# pointing to that path:
#
# tree('src2')
# # => src2
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
# FileUtils.mkdir('dest2')
# FileUtils.cp_lr(['src2/sub0', 'src2/sub1'], 'dest2')
# tree('dest2')
# # => dest2
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# Keyword arguments:
#
# - <tt>dereference_root: false</tt> - if +src+ is a symbolic link,
# does not dereference it.
# - <tt>noop: true</tt> - does not create links.
# - <tt>remove_destination: true</tt> - removes +dest+ before creating links.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.cp_lr('src0', 'dest0', noop: true, verbose: true)
# FileUtils.cp_lr('src1', 'dest1', noop: true, verbose: true)
# FileUtils.cp_lr(['src2/sub0', 'src2/sub1'], 'dest2', noop: true, verbose: true)
#
# Output:
#
# cp -lr src0 dest0
# cp -lr src1 dest1
# cp -lr src2/sub0 src2/sub1 dest2
#
# Raises an exception if +dest+ is the path to an existing file or directory
# and keyword argument <tt>remove_destination: true</tt> is not given.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def cp_lr(src, dest, noop: nil, verbose: nil,
dereference_root: true, remove_destination: false)
fu_output_message "cp -lr#{remove_destination ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
link_entry s, d, dereference_root, remove_destination
end
end
module_function :cp_lr
# Creates {symbolic links}[https://en.wikipedia.org/wiki/Symbolic_link].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to an existing file:
#
# - When +dest+ is the path to a non-existent file,
# creates a symbolic link at +dest+ pointing to +src+:
#
# FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# FileUtils.ln_s('src0.txt', 'dest0.txt')
# File.symlink?('dest0.txt') # => true
#
# - When +dest+ is the path to an existing file,
# creates a symbolic link at +dest+ pointing to +src+
# if and only if keyword argument <tt>force: true</tt> is given
# (raises an exception otherwise):
#
# FileUtils.touch('src1.txt')
# FileUtils.touch('dest1.txt')
# FileUtils.ln_s('src1.txt', 'dest1.txt', force: true)
# FileTest.symlink?('dest1.txt') # => true
#
# FileUtils.ln_s('src1.txt', 'dest1.txt') # Raises Errno::EEXIST.
#
# If +dest+ is the path to a directory,
# creates a symbolic link at <tt>dest/src</tt> pointing to +src+:
#
# FileUtils.touch('src2.txt')
# FileUtils.mkdir('destdir2')
# FileUtils.ln_s('src2.txt', 'destdir2')
# File.symlink?('destdir2/src2.txt') # => true
#
# If +src+ is an array of paths to existing files and +dest+ is a directory,
# for each child +child+ in +src+ creates a symbolic link <tt>dest/child</tt>
# pointing to +child+:
#
# FileUtils.mkdir('srcdir3')
# FileUtils.touch('srcdir3/src0.txt')
# FileUtils.touch('srcdir3/src1.txt')
# FileUtils.mkdir('destdir3')
# FileUtils.ln_s(['srcdir3/src0.txt', 'srcdir3/src1.txt'], 'destdir3')
# File.symlink?('destdir3/src0.txt') # => true
# File.symlink?('destdir3/src1.txt') # => true
#
# Keyword arguments:
#
# - <tt>force: true</tt> - overwrites +dest+ if it exists.
# - <tt>relative: false</tt> - create links relative to +dest+.
# - <tt>noop: true</tt> - does not create links.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.ln_s('src0.txt', 'dest0.txt', noop: true, verbose: true)
# FileUtils.ln_s('src1.txt', 'destdir1', noop: true, verbose: true)
# FileUtils.ln_s('src2.txt', 'dest2.txt', force: true, noop: true, verbose: true)
# FileUtils.ln_s(['srcdir3/src0.txt', 'srcdir3/src1.txt'], 'destdir3', noop: true, verbose: true)
#
# Output:
#
# ln -s src0.txt dest0.txt
# ln -s src1.txt destdir1
# ln -sf src2.txt dest2.txt
# ln -s srcdir3/src0.txt srcdir3/src1.txt destdir3
#
# Related: FileUtils.ln_sf.
#
def ln_s(src, dest, force: nil, relative: false, target_directory: true, noop: nil, verbose: nil)
if relative
return ln_sr(src, dest, force: force, noop: noop, verbose: verbose)
end
fu_output_message "ln -s#{force ? 'f' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest0(src, dest) do |s,d|
remove_file d, true if force
File.symlink s, d
end
end
module_function :ln_s
alias symlink ln_s
module_function :symlink
# Like FileUtils.ln_s, but always with keyword argument <tt>force: true</tt> given.
#
def ln_sf(src, dest, noop: nil, verbose: nil)
ln_s src, dest, force: true, noop: noop, verbose: verbose
end
module_function :ln_sf
# Like FileUtils.ln_s, but create links relative to +dest+.
#
def ln_sr(src, dest, target_directory: true, force: nil, noop: nil, verbose: nil)
options = "#{force ? 'f' : ''}#{target_directory ? '' : 'T'}"
dest = File.path(dest)
srcs = Array(src)
link = proc do |s, target_dir_p = true|
s = File.path(s)
if target_dir_p
d = File.join(destdirs = dest, File.basename(s))
else
destdirs = File.dirname(d = dest)
end
destdirs = fu_split_path(File.realpath(destdirs))
if fu_starting_path?(s)
srcdirs = fu_split_path((File.realdirpath(s) rescue File.expand_path(s)))
base = fu_relative_components_from(srcdirs, destdirs)
s = File.join(*base)
else
srcdirs = fu_clean_components(*fu_split_path(s))
base = fu_relative_components_from(fu_split_path(Dir.pwd), destdirs)
while srcdirs.first&. == ".." and base.last&.!=("..") and !fu_starting_path?(base.last)
srcdirs.shift
base.pop
end
s = File.join(*base, *srcdirs)
end
fu_output_message "ln -s#{options} #{s} #{d}" if verbose
next if noop
remove_file d, true if force
File.symlink s, d
end
case srcs.size
when 0
when 1
link[srcs[0], target_directory && File.directory?(dest)]
else
srcs.each(&link)
end
end
module_function :ln_sr
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link]; returns +nil+.
#
# Arguments +src+ and +dest+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a file and +dest+ does not exist,
# creates a hard link at +dest+ pointing to +src+:
#
# FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# FileUtils.link_entry('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is the path to a directory and +dest+ does not exist,
# recursively creates hard links at +dest+ pointing to paths in +src+:
#
# FileUtils.mkdir_p(['src1/dir0', 'src1/dir1'])
# src_file_paths = [
# 'src1/dir0/t0.txt',
# 'src1/dir0/t1.txt',
# 'src1/dir1/t2.txt',
# 'src1/dir1/t3.txt',
# ]
# FileUtils.touch(src_file_paths)
# File.directory?('dest1') # => true
# FileUtils.link_entry('src1', 'dest1')
# File.file?('dest1/dir0/t0.txt') # => true
# File.file?('dest1/dir0/t1.txt') # => true
# File.file?('dest1/dir1/t2.txt') # => true
# File.file?('dest1/dir1/t3.txt') # => true
#
# Keyword arguments:
#
# - <tt>dereference_root: true</tt> - dereferences +src+ if it is a symbolic link.
# - <tt>remove_destination: true</tt> - removes +dest+ before creating links.
#
# Raises an exception if +dest+ is the path to an existing file or directory
# and keyword argument <tt>remove_destination: true</tt> is not given.
#
# Related: FileUtils.ln (has different options).
#
def link_entry(src, dest, dereference_root = false, remove_destination = false)
Entry_.new(src, nil, dereference_root).traverse do |ent|
destent = Entry_.new(dest, ent.rel, false)
File.unlink destent.path if remove_destination && File.file?(destent.path)
ent.link destent.path
end
end
module_function :link_entry
# Copies files.
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a file and +dest+ is not the path to a directory,
# copies +src+ to +dest+:
#
# FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# FileUtils.cp('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is the path to a file and +dest+ is the path to a directory,
# copies +src+ to <tt>dest/src</tt>:
#
# FileUtils.touch('src1.txt')
# FileUtils.mkdir('dest1')
# FileUtils.cp('src1.txt', 'dest1')
# File.file?('dest1/src1.txt') # => true
#
# If +src+ is an array of paths to files and +dest+ is the path to a directory,
# copies from each +src+ to +dest+:
#
# src_file_paths = ['src2.txt', 'src2.dat']
# FileUtils.touch(src_file_paths)
# FileUtils.mkdir('dest2')
# FileUtils.cp(src_file_paths, 'dest2')
# File.file?('dest2/src2.txt') # => true
# File.file?('dest2/src2.dat') # => true
#
# Keyword arguments:
#
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>noop: true</tt> - does not copy files.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.cp('src0.txt', 'dest0.txt', noop: true, verbose: true)
# FileUtils.cp('src1.txt', 'dest1', noop: true, verbose: true)
# FileUtils.cp(src_file_paths, 'dest2', noop: true, verbose: true)
#
# Output:
#
# cp src0.txt dest0.txt
# cp src1.txt dest1
# cp src2.txt src2.dat dest2
#
# Raises an exception if +src+ is a directory.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def cp(src, dest, preserve: nil, noop: nil, verbose: nil)
fu_output_message "cp#{preserve ? ' -p' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
copy_file s, d, preserve
end
end
module_function :cp
alias copy cp
module_function :copy
# Recursively copies files.
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# The mode, owner, and group are retained in the copy;
# to change those, use FileUtils.install instead.
#
# If +src+ is the path to a file and +dest+ is not the path to a directory,
# copies +src+ to +dest+:
#
# FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# FileUtils.cp_r('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is the path to a file and +dest+ is the path to a directory,
# copies +src+ to <tt>dest/src</tt>:
#
# FileUtils.touch('src1.txt')
# FileUtils.mkdir('dest1')
# FileUtils.cp_r('src1.txt', 'dest1')
# File.file?('dest1/src1.txt') # => true
#
# If +src+ is the path to a directory and +dest+ does not exist,
# recursively copies +src+ to +dest+:
#
# tree('src2')
# # => src2
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# FileUtils.exist?('dest2') # => false
# FileUtils.cp_r('src2', 'dest2')
# tree('dest2')
# # => dest2
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ and +dest+ are paths to directories,
# recursively copies +src+ to <tt>dest/src</tt>:
#
# tree('src3')
# # => src3
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# FileUtils.mkdir('dest3')
# FileUtils.cp_r('src3', 'dest3')
# tree('dest3')
# # => dest3
# # `-- src3
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ is an array of paths and +dest+ is a directory,
# recursively copies from each path in +src+ to +dest+;
# the paths in +src+ may point to files and/or directories.
#
# Keyword arguments:
#
# - <tt>dereference_root: false</tt> - if +src+ is a symbolic link,
# does not dereference it.
# - <tt>noop: true</tt> - does not copy files.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.cp_r('src0.txt', 'dest0.txt', noop: true, verbose: true)
# FileUtils.cp_r('src1.txt', 'dest1', noop: true, verbose: true)
# FileUtils.cp_r('src2', 'dest2', noop: true, verbose: true)
# FileUtils.cp_r('src3', 'dest3', noop: true, verbose: true)
#
# Output:
#
# cp -r src0.txt dest0.txt
# cp -r src1.txt dest1
# cp -r src2 dest2
# cp -r src3 dest3
#
# Raises an exception of +src+ is the path to a directory
# and +dest+ is the path to a file.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def cp_r(src, dest, preserve: nil, noop: nil, verbose: nil,
dereference_root: true, remove_destination: nil)
fu_output_message "cp -r#{preserve ? 'p' : ''}#{remove_destination ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
copy_entry s, d, preserve, dereference_root, remove_destination
end
end
module_function :cp_r
# Recursively copies files from +src+ to +dest+.
#
# Arguments +src+ and +dest+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a file, copies +src+ to +dest+:
#
# FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# FileUtils.copy_entry('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is a directory, recursively copies +src+ to +dest+:
#
# tree('src1')
# # => src1
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# FileUtils.copy_entry('src1', 'dest1')
# tree('dest1')
# # => dest1
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
#
# The recursive copying preserves file types for regular files,
# directories, and symbolic links;
# other file types (FIFO streams, device files, etc.) are not supported.
#
# Keyword arguments:
#
# - <tt>dereference_root: true</tt> - if +src+ is a symbolic link,
# follows the link.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false)
if dereference_root
src = File.realpath(src)
end
Entry_.new(src, nil, false).wrap_traverse(proc do |ent|
destent = Entry_.new(dest, ent.rel, false)
File.unlink destent.path if remove_destination && (File.file?(destent.path) || File.symlink?(destent.path))
ent.copy destent.path
end, proc do |ent|
destent = Entry_.new(dest, ent.rel, false)
ent.copy_metadata destent.path if preserve
end)
end
module_function :copy_entry
# Copies file from +src+ to +dest+, which should not be directories.
#
# Arguments +src+ and +dest+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# Examples:
#
# FileUtils.touch('src0.txt')
# FileUtils.copy_file('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# Keyword arguments:
#
# - <tt>dereference: false</tt> - if +src+ is a symbolic link,
# does not follow the link.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def copy_file(src, dest, preserve = false, dereference = true)
ent = Entry_.new(src, nil, dereference)
ent.copy_file dest
ent.copy_metadata dest if preserve
end
module_function :copy_file
# Copies \IO stream +src+ to \IO stream +dest+ via
# {IO.copy_stream}[rdoc-ref:IO.copy_stream].
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def copy_stream(src, dest)
IO.copy_stream(src, dest)
end
module_function :copy_stream
# Moves entries.
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ and +dest+ are on different file systems,
# first copies, then removes +src+.
#
# May cause a local vulnerability if not called with keyword argument
# <tt>secure: true</tt>;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# If +src+ is the path to a single file or directory and +dest+ does not exist,
# moves +src+ to +dest+:
#
# tree('src0')
# # => src0
# # |-- src0.txt
# # `-- src1.txt
# File.exist?('dest0') # => false
# FileUtils.mv('src0', 'dest0')
# File.exist?('src0') # => false
# tree('dest0')
# # => dest0
# # |-- src0.txt
# # `-- src1.txt
#
# If +src+ is an array of paths to files and directories
# and +dest+ is the path to a directory,
# copies from each path in the array to +dest+:
#
# File.file?('src1.txt') # => true
# tree('src1')
# # => src1
# # |-- src.dat
# # `-- src.txt
# Dir.empty?('dest1') # => true
# FileUtils.mv(['src1.txt', 'src1'], 'dest1')
# tree('dest1')
# # => dest1
# # |-- src1
# # | |-- src.dat
# # | `-- src.txt
# # `-- src1.txt
#
# Keyword arguments:
#
# - <tt>force: true</tt> - if the move includes removing +src+
# (that is, if +src+ and +dest+ are on different file systems),
# ignores raised exceptions of StandardError and its descendants.
# - <tt>noop: true</tt> - does not move files.
# - <tt>secure: true</tt> - removes +src+ securely;
# see details at FileUtils.remove_entry_secure.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.mv('src0', 'dest0', noop: true, verbose: true)
# FileUtils.mv(['src1.txt', 'src1'], 'dest1', noop: true, verbose: true)
#
# Output:
#
# mv src0 dest0
# mv src1.txt src1 dest1
#
def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
fu_output_message "mv#{force ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
destent = Entry_.new(d, nil, true)
begin
if destent.exist?
if destent.directory?
raise Errno::EEXIST, d
end
end
begin
File.rename s, d
rescue Errno::EXDEV,
Errno::EPERM # move from unencrypted to encrypted dir (ext4)
copy_entry s, d, true
if secure
remove_entry_secure s, force
else
remove_entry s, force
end
end
rescue SystemCallError
raise unless force
end
end
end
module_function :mv
alias move mv
module_function :move
# Removes entries at the paths in the given +list+
# (a single path or an array of paths)
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, removes files at the paths given in +list+:
#
# FileUtils.touch(['src0.txt', 'src0.dat'])
# FileUtils.rm(['src0.dat', 'src0.txt']) # => ["src0.dat", "src0.txt"]
#
# Keyword arguments:
#
# - <tt>force: true</tt> - ignores raised exceptions of StandardError
# and its descendants.
# - <tt>noop: true</tt> - does not remove files; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.rm(['src0.dat', 'src0.txt'], noop: true, verbose: true)
#
# Output:
#
# rm src0.dat src0.txt
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm(list, force: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "rm#{force ? ' -f' : ''} #{list.join ' '}" if verbose
return if noop
list.each do |path|
remove_file path, force
end
end
module_function :rm
alias remove rm
module_function :remove
# Equivalent to:
#
# FileUtils.rm(list, force: true, **kwargs)
#
# Argument +list+ (a single path or an array of paths)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# See FileUtils.rm for keyword arguments.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm_f(list, noop: nil, verbose: nil)
rm list, force: true, noop: noop, verbose: verbose
end
module_function :rm_f
alias safe_unlink rm_f
module_function :safe_unlink
# Removes entries at the paths in the given +list+
# (a single path or an array of paths);
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# May cause a local vulnerability if not called with keyword argument
# <tt>secure: true</tt>;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# For each file path, removes the file at that path:
#
# FileUtils.touch(['src0.txt', 'src0.dat'])
# FileUtils.rm_r(['src0.dat', 'src0.txt'])
# File.exist?('src0.txt') # => false
# File.exist?('src0.dat') # => false
#
# For each directory path, recursively removes files and directories:
#
# tree('src1')
# # => src1
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# FileUtils.rm_r('src1')
# File.exist?('src1') # => false
#
# Keyword arguments:
#
# - <tt>force: true</tt> - ignores raised exceptions of StandardError
# and its descendants.
# - <tt>noop: true</tt> - does not remove entries; returns +nil+.
# - <tt>secure: true</tt> - removes +src+ securely;
# see details at FileUtils.remove_entry_secure.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.rm_r(['src0.dat', 'src0.txt'], noop: true, verbose: true)
# FileUtils.rm_r('src1', noop: true, verbose: true)
#
# Output:
#
# rm -r src0.dat src0.txt
# rm -r src1
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil)
list = fu_list(list)
fu_output_message "rm -r#{force ? 'f' : ''} #{list.join ' '}" if verbose
return if noop
list.each do |path|
if secure
remove_entry_secure path, force
else
remove_entry path, force
end
end
end
module_function :rm_r
# Equivalent to:
#
# FileUtils.rm_r(list, force: true, **kwargs)
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# May cause a local vulnerability if not called with keyword argument
# <tt>secure: true</tt>;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# See FileUtils.rm_r for keyword arguments.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm_rf(list, noop: nil, verbose: nil, secure: nil)
rm_r list, force: true, noop: noop, verbose: verbose, secure: secure
end
module_function :rm_rf
alias rmtree rm_rf
module_function :rmtree
# Securely removes the entry given by +path+,
# which should be the entry for a regular file, a symbolic link,
# or a directory.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Avoids a local vulnerability that can exist in certain circumstances;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def remove_entry_secure(path, force = false)
unless fu_have_symlink?
remove_entry path, force
return
end
fullpath = File.expand_path(path)
st = File.lstat(fullpath)
unless st.directory?
File.unlink fullpath
return
end
# is a directory.
parent_st = File.stat(File.dirname(fullpath))
unless parent_st.world_writable?
remove_entry path, force
return
end
unless parent_st.sticky?
raise ArgumentError, "parent directory is world writable, FileUtils#remove_entry_secure does not work; abort: #{path.inspect} (parent directory mode #{'%o' % parent_st.mode})"
end
# freeze tree root
euid = Process.euid
dot_file = fullpath + "/."
begin
File.open(dot_file) {|f|
unless fu_stat_identical_entry?(st, f.stat)
# symlink (TOC-to-TOU attack?)
File.unlink fullpath
return
end
f.chown euid, -1
f.chmod 0700
}
rescue Errno::EISDIR # JRuby in non-native mode can't open files as dirs
File.lstat(dot_file).tap {|fstat|
unless fu_stat_identical_entry?(st, fstat)
# symlink (TOC-to-TOU attack?)
File.unlink fullpath
return
end
File.chown euid, -1, dot_file
File.chmod 0700, dot_file
}
end
unless fu_stat_identical_entry?(st, File.lstat(fullpath))
# TOC-to-TOU attack?
File.unlink fullpath
return
end
# ---- tree root is frozen ----
root = Entry_.new(path)
root.preorder_traverse do |ent|
if ent.directory?
ent.chown euid, -1
ent.chmod 0700
end
end
root.postorder_traverse do |ent|
begin
ent.remove
rescue
raise unless force
end
end
rescue
raise unless force
end
module_function :remove_entry_secure
def fu_have_symlink? #:nodoc:
File.symlink nil, nil
rescue NotImplementedError
return false
rescue TypeError
return true
end
private_module_function :fu_have_symlink?
def fu_stat_identical_entry?(a, b) #:nodoc:
a.dev == b.dev and a.ino == b.ino
end
private_module_function :fu_stat_identical_entry?
# Removes the entry given by +path+,
# which should be the entry for a regular file, a symbolic link,
# or a directory.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: FileUtils.remove_entry_secure.
#
def remove_entry(path, force = false)
Entry_.new(path).postorder_traverse do |ent|
begin
ent.remove
rescue
raise unless force
end
end
rescue
raise unless force
end
module_function :remove_entry
# Removes the file entry given by +path+,
# which should be the entry for a regular file or a symbolic link.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def remove_file(path, force = false)
Entry_.new(path).remove_file
rescue
raise unless force
end
module_function :remove_file
# Recursively removes the directory entry given by +path+,
# which should be the entry for a regular file, a symbolic link,
# or a directory.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def remove_dir(path, force = false)
remove_entry path, force # FIXME?? check if it is a directory
end
module_function :remove_dir
# Returns +true+ if the contents of files +a+ and +b+ are identical,
# +false+ otherwise.
#
# Arguments +a+ and +b+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# FileUtils.identical? and FileUtils.cmp are aliases for FileUtils.compare_file.
#
# Related: FileUtils.compare_stream.
#
def compare_file(a, b)
return false unless File.size(a) == File.size(b)
File.open(a, 'rb') {|fa|
File.open(b, 'rb') {|fb|
return compare_stream(fa, fb)
}
}
end
module_function :compare_file
alias identical? compare_file
alias cmp compare_file
module_function :identical?
module_function :cmp
# Returns +true+ if the contents of streams +a+ and +b+ are identical,
# +false+ otherwise.
#
# Arguments +a+ and +b+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Related: FileUtils.compare_file.
#
def compare_stream(a, b)
bsize = fu_stream_blksize(a, b)
sa = String.new(capacity: bsize)
sb = String.new(capacity: bsize)
begin
a.read(bsize, sa)
b.read(bsize, sb)
return true if sa.empty? && sb.empty?
end while sa == sb
false
end
module_function :compare_stream
# Copies a file entry.
# See {install(1)}[https://man7.org/linux/man-pages/man1/install.1.html].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments];
#
# If the entry at +dest+ does not exist, copies from +src+ to +dest+:
#
# File.read('src0.txt') # => "aaa\n"
# File.exist?('dest0.txt') # => false
# FileUtils.install('src0.txt', 'dest0.txt')
# File.read('dest0.txt') # => "aaa\n"
#
# If +dest+ is a file entry, copies from +src+ to +dest+, overwriting:
#
# File.read('src1.txt') # => "aaa\n"
# File.read('dest1.txt') # => "bbb\n"
# FileUtils.install('src1.txt', 'dest1.txt')
# File.read('dest1.txt') # => "aaa\n"
#
# If +dest+ is a directory entry, copies from +src+ to <tt>dest/src</tt>,
# overwriting if necessary:
#
# File.read('src2.txt') # => "aaa\n"
# File.read('dest2/src2.txt') # => "bbb\n"
# FileUtils.install('src2.txt', 'dest2')
# File.read('dest2/src2.txt') # => "aaa\n"
#
# If +src+ is an array of paths and +dest+ points to a directory,
# copies each path +path+ in +src+ to <tt>dest/path</tt>:
#
# File.file?('src3.txt') # => true
# File.file?('src3.dat') # => true
# FileUtils.mkdir('dest3')
# FileUtils.install(['src3.txt', 'src3.dat'], 'dest3')
# File.file?('dest3/src3.txt') # => true
# File.file?('dest3/src3.dat') # => true
#
# Keyword arguments:
#
# - <tt>group: <i>group</i></tt> - changes the group if not +nil+,
# using {File.chown}[rdoc-ref:File.chown].
# - <tt>mode: <i>permissions</i></tt> - changes the permissions.
# using {File.chmod}[rdoc-ref:File.chmod].
# - <tt>noop: true</tt> - does not copy entries; returns +nil+.
# - <tt>owner: <i>owner</i></tt> - changes the owner if not +nil+,
# using {File.chown}[rdoc-ref:File.chown].
# - <tt>preserve: true</tt> - preserve timestamps
# using {File.utime}[rdoc-ref:File.utime].
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.install('src0.txt', 'dest0.txt', noop: true, verbose: true)
# FileUtils.install('src1.txt', 'dest1.txt', noop: true, verbose: true)
# FileUtils.install('src2.txt', 'dest2', noop: true, verbose: true)
#
# Output:
#
# install -c src0.txt dest0.txt
# install -c src1.txt dest1.txt
# install -c src2.txt dest2
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def install(src, dest, mode: nil, owner: nil, group: nil, preserve: nil,
noop: nil, verbose: nil)
if verbose
msg = +"install -c"
msg << ' -p' if preserve
msg << ' -m ' << mode_to_s(mode) if mode
msg << " -o #{owner}" if owner
msg << " -g #{group}" if group
msg << ' ' << [src,dest].flatten.join(' ')
fu_output_message msg
end
return if noop
uid = fu_get_uid(owner)
gid = fu_get_gid(group)
fu_each_src_dest(src, dest) do |s, d|
st = File.stat(s)
unless File.exist?(d) and compare_file(s, d)
remove_file d, true
if d.end_with?('/')
mkdir_p d
copy_file s, d + File.basename(s)
else
mkdir_p File.expand_path('..', d)
copy_file s, d
end
File.utime st.atime, st.mtime, d if preserve
File.chmod fu_mode(mode, st), d if mode
File.chown uid, gid, d if uid or gid
end
end
end
module_function :install
def user_mask(target) #:nodoc:
target.each_char.inject(0) do |mask, chr|
case chr
when "u"
mask | 04700
when "g"
mask | 02070
when "o"
mask | 01007
when "a"
mask | 07777
else
raise ArgumentError, "invalid `who' symbol in file mode: #{chr}"
end
end
end
private_module_function :user_mask
def apply_mask(mode, user_mask, op, mode_mask) #:nodoc:
case op
when '='
(mode & ~user_mask) | (user_mask & mode_mask)
when '+'
mode | (user_mask & mode_mask)
when '-'
mode & ~(user_mask & mode_mask)
end
end
private_module_function :apply_mask
def symbolic_modes_to_i(mode_sym, path) #:nodoc:
path = File.stat(path) unless File::Stat === path
mode = path.mode
mode_sym.split(/,/).inject(mode & 07777) do |current_mode, clause|
target, *actions = clause.split(/([=+-])/)
raise ArgumentError, "invalid file mode: #{mode_sym}" if actions.empty?
target = 'a' if target.empty?
user_mask = user_mask(target)
actions.each_slice(2) do |op, perm|
need_apply = op == '='
mode_mask = (perm || '').each_char.inject(0) do |mask, chr|
case chr
when "r"
mask | 0444
when "w"
mask | 0222
when "x"
mask | 0111
when "X"
if path.directory?
mask | 0111
else
mask
end
when "s"
mask | 06000
when "t"
mask | 01000
when "u", "g", "o"
if mask.nonzero?
current_mode = apply_mask(current_mode, user_mask, op, mask)
end
need_apply = false
copy_mask = user_mask(chr)
(current_mode & copy_mask) / (copy_mask & 0111) * (user_mask & 0111)
else
raise ArgumentError, "invalid `perm' symbol in file mode: #{chr}"
end
end
if mode_mask.nonzero? || need_apply
current_mode = apply_mask(current_mode, user_mask, op, mode_mask)
end
end
current_mode
end
end
private_module_function :symbolic_modes_to_i
def fu_mode(mode, path) #:nodoc:
mode.is_a?(String) ? symbolic_modes_to_i(mode, path) : mode
end
private_module_function :fu_mode
def mode_to_s(mode) #:nodoc:
mode.is_a?(String) ? mode : "%o" % mode
end
private_module_function :mode_to_s
# Changes permissions on the entries at the paths given in +list+
# (a single path or an array of paths)
# to the permissions given by +mode+;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
#
# - Modifies each entry that is a regular file using
# {File.chmod}[rdoc-ref:File.chmod].
# - Modifies each entry that is a symbolic link using
# {File.lchmod}[rdoc-ref:File.lchmod].
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# Argument +mode+ may be either an integer or a string:
#
# - \Integer +mode+: represents the permission bits to be set:
#
# FileUtils.chmod(0755, 'src0.txt')
# FileUtils.chmod(0644, ['src0.txt', 'src0.dat'])
#
# - \String +mode+: represents the permissions to be set:
#
# The string is of the form <tt>[targets][[operator][perms[,perms]]</tt>, where:
#
# - +targets+ may be any combination of these letters:
#
# - <tt>'u'</tt>: permissions apply to the file's owner.
# - <tt>'g'</tt>: permissions apply to users in the file's group.
# - <tt>'o'</tt>: permissions apply to other users not in the file's group.
# - <tt>'a'</tt> (the default): permissions apply to all users.
#
# - +operator+ may be one of these letters:
#
# - <tt>'+'</tt>: adds permissions.
# - <tt>'-'</tt>: removes permissions.
# - <tt>'='</tt>: sets (replaces) permissions.
#
# - +perms+ (may be repeated, with separating commas)
# may be any combination of these letters:
#
# - <tt>'r'</tt>: Read.
# - <tt>'w'</tt>: Write.
# - <tt>'x'</tt>: Execute (search, for a directory).
# - <tt>'X'</tt>: Search (for a directories only;
# must be used with <tt>'+'</tt>)
# - <tt>'s'</tt>: Uid or gid.
# - <tt>'t'</tt>: Sticky bit.
#
# Examples:
#
# FileUtils.chmod('u=wrx,go=rx', 'src1.txt')
# FileUtils.chmod('u=wrx,go=rx', '/usr/bin/ruby')
#
# Keyword arguments:
#
# - <tt>noop: true</tt> - does not change permissions; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.chmod(0755, 'src0.txt', noop: true, verbose: true)
# FileUtils.chmod(0644, ['src0.txt', 'src0.dat'], noop: true, verbose: true)
# FileUtils.chmod('u=wrx,go=rx', 'src1.txt', noop: true, verbose: true)
# FileUtils.chmod('u=wrx,go=rx', '/usr/bin/ruby', noop: true, verbose: true)
#
# Output:
#
# chmod 755 src0.txt
# chmod 644 src0.txt src0.dat
# chmod u=wrx,go=rx src1.txt
# chmod u=wrx,go=rx /usr/bin/ruby
#
# Related: FileUtils.chmod_R.
#
def chmod(mode, list, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message sprintf('chmod %s %s', mode_to_s(mode), list.join(' ')) if verbose
return if noop
list.each do |path|
Entry_.new(path).chmod(fu_mode(mode, path))
end
end
module_function :chmod
# Like FileUtils.chmod, but changes permissions recursively.
#
def chmod_R(mode, list, noop: nil, verbose: nil, force: nil)
list = fu_list(list)
fu_output_message sprintf('chmod -R%s %s %s',
(force ? 'f' : ''),
mode_to_s(mode), list.join(' ')) if verbose
return if noop
list.each do |root|
Entry_.new(root).traverse do |ent|
begin
ent.chmod(fu_mode(mode, ent.path))
rescue
raise unless force
end
end
end
end
module_function :chmod_R
# Changes the owner and group on the entries at the paths given in +list+
# (a single path or an array of paths)
# to the given +user+ and +group+;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
#
# - Modifies each entry that is a regular file using
# {File.chown}[rdoc-ref:File.chown].
# - Modifies each entry that is a symbolic link using
# {File.lchown}[rdoc-ref:File.lchown].
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# User and group:
#
# - Argument +user+ may be a user name or a user id;
# if +nil+ or +-1+, the user is not changed.
# - Argument +group+ may be a group name or a group id;
# if +nil+ or +-1+, the group is not changed.
# - The user must be a member of the group.
#
# Examples:
#
# # One path.
# # User and group as string names.
# File.stat('src0.txt').uid # => 1004
# File.stat('src0.txt').gid # => 1004
# FileUtils.chown('user2', 'group1', 'src0.txt')
# File.stat('src0.txt').uid # => 1006
# File.stat('src0.txt').gid # => 1005
#
# # User and group as uid and gid.
# FileUtils.chown(1004, 1004, 'src0.txt')
# File.stat('src0.txt').uid # => 1004
# File.stat('src0.txt').gid # => 1004
#
# # Array of paths.
# FileUtils.chown(1006, 1005, ['src0.txt', 'src0.dat'])
#
# # Directory (not recursive).
# FileUtils.chown('user2', 'group1', '.')
#
# Keyword arguments:
#
# - <tt>noop: true</tt> - does not change permissions; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.chown('user2', 'group1', 'src0.txt', noop: true, verbose: true)
# FileUtils.chown(1004, 1004, 'src0.txt', noop: true, verbose: true)
# FileUtils.chown(1006, 1005, ['src0.txt', 'src0.dat'], noop: true, verbose: true)
# FileUtils.chown('user2', 'group1', path, noop: true, verbose: true)
# FileUtils.chown('user2', 'group1', '.', noop: true, verbose: true)
#
# Output:
#
# chown user2:group1 src0.txt
# chown 1004:1004 src0.txt
# chown 1006:1005 src0.txt src0.dat
# chown user2:group1 src0.txt
# chown user2:group1 .
#
# Related: FileUtils.chown_R.
#
def chown(user, group, list, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message sprintf('chown %s %s',
(group ? "#{user}:#{group}" : user || ':'),
list.join(' ')) if verbose
return if noop
uid = fu_get_uid(user)
gid = fu_get_gid(group)
list.each do |path|
Entry_.new(path).chown uid, gid
end
end
module_function :chown
# Like FileUtils.chown, but changes owner and group recursively.
#
def chown_R(user, group, list, noop: nil, verbose: nil, force: nil)
list = fu_list(list)
fu_output_message sprintf('chown -R%s %s %s',
(force ? 'f' : ''),
(group ? "#{user}:#{group}" : user || ':'),
list.join(' ')) if verbose
return if noop
uid = fu_get_uid(user)
gid = fu_get_gid(group)
list.each do |root|
Entry_.new(root).traverse do |ent|
begin
ent.chown uid, gid
rescue
raise unless force
end
end
end
end
module_function :chown_R
def fu_get_uid(user) #:nodoc:
return nil unless user
case user
when Integer
user
when /\A\d+\z/
user.to_i
else
require 'etc'
Etc.getpwnam(user) ? Etc.getpwnam(user).uid : nil
end
end
private_module_function :fu_get_uid
def fu_get_gid(group) #:nodoc:
return nil unless group
case group
when Integer
group
when /\A\d+\z/
group.to_i
else
require 'etc'
Etc.getgrnam(group) ? Etc.getgrnam(group).gid : nil
end
end
private_module_function :fu_get_gid
# Updates modification times (mtime) and access times (atime)
# of the entries given by the paths in +list+
# (a single path or an array of paths);
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
# By default, creates an empty file for any path to a non-existent entry;
# use keyword argument +nocreate+ to raise an exception instead.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# Examples:
#
# # Single path.
# f = File.new('src0.txt') # Existing file.
# f.atime # => 2022-06-10 11:11:21.200277 -0700
# f.mtime # => 2022-06-10 11:11:21.200277 -0700
# FileUtils.touch('src0.txt')
# f = File.new('src0.txt')
# f.atime # => 2022-06-11 08:28:09.8185343 -0700
# f.mtime # => 2022-06-11 08:28:09.8185343 -0700
#
# # Array of paths.
# FileUtils.touch(['src0.txt', 'src0.dat'])
#
# Keyword arguments:
#
# - <tt>mtime: <i>time</i></tt> - sets the entry's mtime to the given time,
# instead of the current time.
# - <tt>nocreate: true</tt> - raises an exception if the entry does not exist.
# - <tt>noop: true</tt> - does not touch entries; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# FileUtils.touch('src0.txt', noop: true, verbose: true)
# FileUtils.touch(['src0.txt', 'src0.dat'], noop: true, verbose: true)
# FileUtils.touch(path, noop: true, verbose: true)
#
# Output:
#
# touch src0.txt
# touch src0.txt src0.dat
# touch src0.txt
#
# Related: FileUtils.uptodate?.
#
def touch(list, noop: nil, verbose: nil, mtime: nil, nocreate: nil)
list = fu_list(list)
t = mtime
if verbose
fu_output_message "touch #{nocreate ? '-c ' : ''}#{t ? t.strftime('-t %Y%m%d%H%M.%S ') : ''}#{list.join ' '}"
end
return if noop
list.each do |path|
created = nocreate
begin
File.utime(t, t, path)
rescue Errno::ENOENT
raise if created
File.open(path, 'a') {
;
}
created = true
retry if t
end
end
end
module_function :touch
private
module StreamUtils_
private
case (defined?(::RbConfig) ? ::RbConfig::CONFIG['host_os'] : ::RUBY_PLATFORM)
when /mswin|mingw/
def fu_windows?; true end
else
def fu_windows?; false end
end
def fu_copy_stream0(src, dest, blksize = nil) #:nodoc:
IO.copy_stream(src, dest)
end
def fu_stream_blksize(*streams)
streams.each do |s|
next unless s.respond_to?(:stat)
size = fu_blksize(s.stat)
return size if size
end
fu_default_blksize()
end
def fu_blksize(st)
s = st.blksize
return nil unless s
return nil if s == 0
s
end
def fu_default_blksize
1024
end
end
include StreamUtils_
extend StreamUtils_
class Entry_ #:nodoc: internal use only
include StreamUtils_
def initialize(a, b = nil, deref = false)
@prefix = @rel = @path = nil
if b
@prefix = a
@rel = b
else
@path = a
end
@deref = deref
@stat = nil
@lstat = nil
end
def inspect
"\#<#{self.class} #{path()}>"
end
def path
if @path
File.path(@path)
else
join(@prefix, @rel)
end
end
def prefix
@prefix || @path
end
def rel
@rel
end
def dereference?
@deref
end
def exist?
begin
lstat
true
rescue Errno::ENOENT
false
end
end
def file?
s = lstat!
s and s.file?
end
def directory?
s = lstat!
s and s.directory?
end
def symlink?
s = lstat!
s and s.symlink?
end
def chardev?
s = lstat!
s and s.chardev?
end
def blockdev?
s = lstat!
s and s.blockdev?
end
def socket?
s = lstat!
s and s.socket?
end
def pipe?
s = lstat!
s and s.pipe?
end
S_IF_DOOR = 0xD000
def door?
s = lstat!
s and (s.mode & 0xF000 == S_IF_DOOR)
end
def entries
opts = {}
opts[:encoding] = fu_windows? ? ::Encoding::UTF_8 : path.encoding
files = Dir.children(path, **opts)
untaint = RUBY_VERSION < '2.7'
files.map {|n| Entry_.new(prefix(), join(rel(), untaint ? n.untaint : n)) }
end
def stat
return @stat if @stat
if lstat() and lstat().symlink?
@stat = File.stat(path())
else
@stat = lstat()
end
@stat
end
def stat!
return @stat if @stat
if lstat! and lstat!.symlink?
@stat = File.stat(path())
else
@stat = lstat!
end
@stat
rescue SystemCallError
nil
end
def lstat
if dereference?
@lstat ||= File.stat(path())
else
@lstat ||= File.lstat(path())
end
end
def lstat!
lstat()
rescue SystemCallError
nil
end
def chmod(mode)
if symlink?
File.lchmod mode, path() if have_lchmod?
else
File.chmod mode, path()
end
rescue Errno::EOPNOTSUPP
end
def chown(uid, gid)
if symlink?
File.lchown uid, gid, path() if have_lchown?
else
File.chown uid, gid, path()
end
end
def link(dest)
case
when directory?
if !File.exist?(dest) and descendant_directory?(dest, path)
raise ArgumentError, "cannot link directory %s to itself %s" % [path, dest]
end
begin
Dir.mkdir dest
rescue
raise unless File.directory?(dest)
end
else
File.link path(), dest
end
end
def copy(dest)
lstat
case
when file?
copy_file dest
when directory?
if !File.exist?(dest) and descendant_directory?(dest, path)
raise ArgumentError, "cannot copy directory %s to itself %s" % [path, dest]
end
begin
Dir.mkdir dest
rescue
raise unless File.directory?(dest)
end
when symlink?
File.symlink File.readlink(path()), dest
when chardev?, blockdev?
raise "cannot handle device file"
when socket?
begin
require 'socket'
rescue LoadError
raise "cannot handle socket"
else
raise "cannot handle socket" unless defined?(UNIXServer)
end
UNIXServer.new(dest).close
File.chmod lstat().mode, dest
when pipe?
raise "cannot handle FIFO" unless File.respond_to?(:mkfifo)
File.mkfifo dest, lstat().mode
when door?
raise "cannot handle door: #{path()}"
else
raise "unknown file type: #{path()}"
end
end
def copy_file(dest)
File.open(path()) do |s|
File.open(dest, 'wb', s.stat.mode) do |f|
IO.copy_stream(s, f)
end
end
end
def copy_metadata(path)
st = lstat()
if !st.symlink?
File.utime st.atime, st.mtime, path
end
mode = st.mode
begin
if st.symlink?
begin
File.lchown st.uid, st.gid, path
rescue NotImplementedError
end
else
File.chown st.uid, st.gid, path
end
rescue Errno::EPERM, Errno::EACCES
# clear setuid/setgid
mode &= 01777
end
if st.symlink?
begin
File.lchmod mode, path
rescue NotImplementedError, Errno::EOPNOTSUPP
end
else
File.chmod mode, path
end
end
def remove
if directory?
remove_dir1
else
remove_file
end
end
def remove_dir1
platform_support {
Dir.rmdir path().chomp(?/)
}
end
def remove_file
platform_support {
File.unlink path
}
end
def platform_support
return yield unless fu_windows?
first_time_p = true
begin
yield
rescue Errno::ENOENT
raise
rescue => err
if first_time_p
first_time_p = false
begin
File.chmod 0700, path() # Windows does not have symlink
retry
rescue SystemCallError
end
end
raise err
end
end
def preorder_traverse
stack = [self]
while ent = stack.pop
yield ent
stack.concat ent.entries.reverse if ent.directory?
end
end
alias traverse preorder_traverse
def postorder_traverse
if directory?
begin
children = entries()
rescue Errno::EACCES
# Failed to get the list of children.
# Assuming there is no children, try to process the parent directory.
yield self
return
end
children.each do |ent|
ent.postorder_traverse do |e|
yield e
end
end
end
yield self
end
def wrap_traverse(pre, post)
pre.call self
if directory?
entries.each do |ent|
ent.wrap_traverse pre, post
end
end
post.call self
end
private
@@fileutils_rb_have_lchmod = nil
def have_lchmod?
# This is not MT-safe, but it does not matter.
if @@fileutils_rb_have_lchmod == nil
@@fileutils_rb_have_lchmod = check_have_lchmod?
end
@@fileutils_rb_have_lchmod
end
def check_have_lchmod?
return false unless File.respond_to?(:lchmod)
File.lchmod 0
return true
rescue NotImplementedError
return false
end
@@fileutils_rb_have_lchown = nil
def have_lchown?
# This is not MT-safe, but it does not matter.
if @@fileutils_rb_have_lchown == nil
@@fileutils_rb_have_lchown = check_have_lchown?
end
@@fileutils_rb_have_lchown
end
def check_have_lchown?
return false unless File.respond_to?(:lchown)
File.lchown nil, nil
return true
rescue NotImplementedError
return false
end
def join(dir, base)
return File.path(dir) if not base or base == '.'
return File.path(base) if not dir or dir == '.'
begin
File.join(dir, base)
rescue EncodingError
if fu_windows?
File.join(dir.encode(::Encoding::UTF_8), base.encode(::Encoding::UTF_8))
else
raise
end
end
end
if File::ALT_SEPARATOR
DIRECTORY_TERM = "(?=[/#{Regexp.quote(File::ALT_SEPARATOR)}]|\\z)"
else
DIRECTORY_TERM = "(?=/|\\z)"
end
def descendant_directory?(descendant, ascendant)
if File::FNM_SYSCASE.nonzero?
File.expand_path(File.dirname(descendant)).casecmp(File.expand_path(ascendant)) == 0
else
File.expand_path(File.dirname(descendant)) == File.expand_path(ascendant)
end
end
end # class Entry_
def fu_list(arg) #:nodoc:
[arg].flatten.map {|path| File.path(path) }
end
private_module_function :fu_list
def fu_each_src_dest(src, dest) #:nodoc:
fu_each_src_dest0(src, dest) do |s, d|
raise ArgumentError, "same file: #{s} and #{d}" if fu_same?(s, d)
yield s, d
end
end
private_module_function :fu_each_src_dest
def fu_each_src_dest0(src, dest, target_directory = true) #:nodoc:
if tmp = Array.try_convert(src)
tmp.each do |s|
s = File.path(s)
yield s, (target_directory ? File.join(dest, File.basename(s)) : dest)
end
else
src = File.path(src)
if target_directory and File.directory?(dest)
yield src, File.join(dest, File.basename(src))
else
yield src, File.path(dest)
end
end
end
private_module_function :fu_each_src_dest0
def fu_same?(a, b) #:nodoc:
File.identical?(a, b)
end
private_module_function :fu_same?
def fu_output_message(msg) #:nodoc:
output = @fileutils_output if defined?(@fileutils_output)
output ||= $stdout
if defined?(@fileutils_label)
msg = @fileutils_label + msg
end
output.puts msg
end
private_module_function :fu_output_message
def fu_split_path(path)
path = File.path(path)
list = []
until (parent, base = File.split(path); parent == path or parent == ".")
list << base
path = parent
end
list << path
list.reverse!
end
private_module_function :fu_split_path
def fu_relative_components_from(target, base) #:nodoc:
i = 0
while target[i]&.== base[i]
i += 1
end
Array.new(base.size-i, '..').concat(target[i..-1])
end
private_module_function :fu_relative_components_from
def fu_clean_components(*comp)
comp.shift while comp.first == "."
return comp if comp.empty?
clean = [comp.shift]
path = File.join(*clean, "") # ending with File::SEPARATOR
while c = comp.shift
if c == ".." and clean.last != ".." and !(fu_have_symlink? && File.symlink?(path))
clean.pop
path.chomp!(%r((?<=\A|/)[^/]+/\z), "")
else
clean << c
path << c << "/"
end
end
clean
end
private_module_function :fu_clean_components
if fu_windows?
def fu_starting_path?(path)
path&.start_with?(%r(\w:|/))
end
else
def fu_starting_path?(path)
path&.start_with?("/")
end
end
private_module_function :fu_starting_path?
# This hash table holds command options.
OPT_TABLE = {} #:nodoc: internal use only
(private_instance_methods & methods(false)).inject(OPT_TABLE) {|tbl, name|
(tbl[name.to_s] = instance_method(name).parameters).map! {|t, n| n if t == :key}.compact!
tbl
}
public
# Returns an array of the string names of \FileUtils methods
# that accept one or more keyword arguments:
#
# FileUtils.commands.sort.take(3) # => ["cd", "chdir", "chmod"]
#
def self.commands
OPT_TABLE.keys
end
# Returns an array of the string keyword names:
#
# FileUtils.options.take(3) # => ["noop", "verbose", "force"]
#
def self.options
OPT_TABLE.values.flatten.uniq.map {|sym| sym.to_s }
end
# Returns +true+ if method +mid+ accepts the given option +opt+, +false+ otherwise;
# the arguments may be strings or symbols:
#
# FileUtils.have_option?(:chmod, :noop) # => true
# FileUtils.have_option?('chmod', 'secure') # => false
#
def self.have_option?(mid, opt)
li = OPT_TABLE[mid.to_s] or raise ArgumentError, "no such method: #{mid}"
li.include?(opt)
end
# Returns an array of the string keyword name for method +mid+;
# the argument may be a string or a symbol:
#
# FileUtils.options_of(:rm) # => ["force", "noop", "verbose"]
# FileUtils.options_of('mv') # => ["force", "noop", "verbose", "secure"]
#
def self.options_of(mid)
OPT_TABLE[mid.to_s].map {|sym| sym.to_s }
end
# Returns an array of the string method names of the methods
# that accept the given keyword option +opt+;
# the argument must be a symbol:
#
# FileUtils.collect_method(:preserve) # => ["cp", "copy", "cp_r", "install"]
#
def self.collect_method(opt)
OPT_TABLE.keys.select {|m| OPT_TABLE[m].include?(opt) }
end
private
LOW_METHODS = singleton_methods(false) - collect_method(:noop).map(&:intern) # :nodoc:
module LowMethods # :nodoc: internal use only
private
def _do_nothing(*)end
::FileUtils::LOW_METHODS.map {|name| alias_method name, :_do_nothing}
end
METHODS = singleton_methods() - [:private_module_function, # :nodoc:
:commands, :options, :have_option?, :options_of, :collect_method]
#
# This module has all methods of FileUtils module, but it outputs messages
# before acting. This equates to passing the <tt>:verbose</tt> flag to
# methods in FileUtils.
#
module Verbose
include FileUtils
names = ::FileUtils.collect_method(:verbose)
names.each do |name|
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}(*args, **options)
super(*args, **options, verbose: true)
end
EOS
end
private(*names)
extend self
class << self
public(*::FileUtils::METHODS)
end
end
#
# This module has all methods of FileUtils module, but never changes
# files/directories. This equates to passing the <tt>:noop</tt> flag
# to methods in FileUtils.
#
module NoWrite
include FileUtils
include LowMethods
names = ::FileUtils.collect_method(:noop)
names.each do |name|
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}(*args, **options)
super(*args, **options, noop: true)
end
EOS
end
private(*names)
extend self
class << self
public(*::FileUtils::METHODS)
end
end
#
# This module has all methods of FileUtils module, but never changes
# files/directories, with printing message before acting.
# This equates to passing the <tt>:noop</tt> and <tt>:verbose</tt> flag
# to methods in FileUtils.
#
module DryRun
include FileUtils
include LowMethods
names = ::FileUtils.collect_method(:noop)
names.each do |name|
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}(*args, **options)
super(*args, **options, noop: true, verbose: true)
end
EOS
end
private(*names)
extend self
class << self
public(*::FileUtils::METHODS)
end
end
end
share/ruby/benchmark.rb 0000644 00000044657 15173517734 0011143 0 ustar 00 # frozen_string_literal: true
#--
# benchmark.rb - a performance benchmarking library
#
# $Id$
#
# Created by Gotoken (gotoken@notwork.org).
#
# Documentation by Gotoken (original RD), Lyle Johnson (RDoc conversion), and
# Gavin Sinclair (editing).
#++
#
# == Overview
#
# The Benchmark module provides methods for benchmarking Ruby code, giving
# detailed reports on the time taken for each task.
#
# 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
# <code>"a"*1_000_000_000</code>:
#
# 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
VERSION = "0.3.0"
BENCHMARK_VERSION = "2002-04-25" # :nodoc:
# 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.
# (Note: +caption+ must contain a terminating newline character,
# see the default Benchmark::Tms::CAPTION for an example.)
#
# 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 benchmark(caption = "", label_width = nil, format = nil, *labels) # :yield: report
sync = $stdout.sync
$stdout.sync = true
label_width ||= 0
label_width += 1
format ||= FORMAT
print ' '*label_width + caption unless caption.empty?
report = Report.new(label_width, format)
results = yield(report)
Array === results and results.grep(Tms).each {|t|
print((labels.shift || t.label || "").ljust(label_width), t.format(format))
}
report.list
ensure
$stdout.sync = sync unless sync.nil?
end
# 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 bm(label_width = 0, *labels, &blk) # :yield: report
benchmark(CAPTION, label_width, FORMAT, *labels, &blk)
end
# 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 bmbm(width = 0) # :yield: job
job = Job.new(width)
yield(job)
width = job.width + 1
sync = $stdout.sync
$stdout.sync = true
# rehearsal
puts 'Rehearsal '.ljust(width+CAPTION.length,'-')
ets = job.list.inject(Tms.new) { |sum,(label,item)|
print label.ljust(width)
res = Benchmark.measure(&item)
print res.format
sum + res
}.format("total: %tsec")
print " #{ets}\n\n".rjust(width+CAPTION.length+2,'-')
# take
print ' '*width + CAPTION
job.list.map { |label,item|
GC.start
print label.ljust(width)
Benchmark.measure(label, &item).tap { |res| print res }
}
ensure
$stdout.sync = sync unless sync.nil?
end
#
# 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 measure(label = "") # :yield:
t0, r0 = Process.times, Process.clock_gettime(Process::CLOCK_MONOTONIC)
yield
t1, r1 = Process.times, Process.clock_gettime(Process::CLOCK_MONOTONIC)
Benchmark::Tms.new(t1.utime - t0.utime,
t1.stime - t0.stime,
t1.cutime - t0.cutime,
t1.cstime - t0.cstime,
r1 - r0,
label)
end
#
# Returns the elapsed real time used to execute the given block.
#
def realtime # :yield:
r0 = Process.clock_gettime(Process::CLOCK_MONOTONIC)
yield
Process.clock_gettime(Process::CLOCK_MONOTONIC) - r0
end
module_function :benchmark, :measure, :realtime, :bm, :bmbm
#
# A Job is a sequence of labelled blocks to be processed by the
# Benchmark.bmbm method. It is of little direct interest to the user.
#
class Job # :nodoc:
#
# Returns an initialized Job instance.
# Usually, one doesn't call this method directly, as new
# Job objects are created by the #bmbm method.
# +width+ is a initial value for the label offset used in formatting;
# the #bmbm method passes its +width+ argument to this constructor.
#
def initialize(width)
@width = width
@list = []
end
#
# Registers the given label and block pair in the job list.
#
def item(label = "", &blk) # :yield:
raise ArgumentError, "no block" unless block_given?
label = label.to_s
w = label.length
@width = w if @width < w
@list << [label, blk]
self
end
alias report item
# An array of 2-element arrays, consisting of label and block pairs.
attr_reader :list
# Length of the widest label in the #list.
attr_reader :width
end
#
# This class is used by the Benchmark.benchmark and Benchmark.bm methods.
# It is of little direct interest to the user.
#
class Report # :nodoc:
#
# Returns an initialized Report instance.
# Usually, one doesn't call this method directly, as new
# Report objects are created by the #benchmark and #bm methods.
# +width+ and +format+ are the label offset and
# format string used by Tms#format.
#
def initialize(width = 0, format = nil)
@width, @format, @list = width, format, []
end
#
# Prints the +label+ and measured time for the block,
# formatted by +format+. See Tms#format for the
# formatting rules.
#
def item(label = "", *format, &blk) # :yield:
print label.to_s.ljust(@width)
@list << res = Benchmark.measure(label, &blk)
print res.format(@format, *format)
res
end
alias report item
# An array of Benchmark::Tms objects representing each item.
attr_reader :list
end
#
# A data object, representing the times associated with a benchmark
# measurement.
#
class Tms
# Default caption, see also Benchmark::CAPTION
CAPTION = " user system total real\n"
# Default format string, see also Benchmark::FORMAT
FORMAT = "%10.6u %10.6y %10.6t %10.6r\n"
# User CPU time
attr_reader :utime
# System CPU time
attr_reader :stime
# User CPU time of children
attr_reader :cutime
# System CPU time of children
attr_reader :cstime
# Elapsed real time
attr_reader :real
# Total time, that is +utime+ + +stime+ + +cutime+ + +cstime+
attr_reader :total
# Label
attr_reader :label
#
# Returns an initialized Tms object which has
# +utime+ as the user CPU time, +stime+ as the system CPU time,
# +cutime+ as the children's user CPU time, +cstime+ as the children's
# system CPU time, +real+ as the elapsed real time and +label+ as the label.
#
def initialize(utime = 0.0, stime = 0.0, cutime = 0.0, cstime = 0.0, real = 0.0, label = nil)
@utime, @stime, @cutime, @cstime, @real, @label = utime, stime, cutime, cstime, real, label.to_s
@total = @utime + @stime + @cutime + @cstime
end
#
# 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(&blk) # :yield:
self + Benchmark.measure(&blk)
end
#
# 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!(&blk)
t = Benchmark.measure(&blk)
@utime = utime + t.utime
@stime = stime + t.stime
@cutime = cutime + t.cutime
@cstime = cstime + t.cstime
@real = real + t.real
self
end
#
# 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 +(other); memberwise(:+, other) end
#
# 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 -(other); memberwise(:-, other) end
#
# Returns a new Tms object obtained by memberwise multiplication
# of the individual times for this Tms object by +x+.
#
def *(x); memberwise(:*, x) end
#
# 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 /(x); memberwise(:/, x) end
#
# 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:
#
# <tt>%u</tt>:: Replaced by the user CPU time, as reported by Tms#utime.
# <tt>%y</tt>:: Replaced by the system CPU time, as reported by #stime (Mnemonic: y of "s*y*stem")
# <tt>%U</tt>:: Replaced by the children's user CPU time, as reported by Tms#cutime
# <tt>%Y</tt>:: Replaced by the children's system CPU time, as reported by Tms#cstime
# <tt>%t</tt>:: Replaced by the total CPU time, as reported by Tms#total
# <tt>%r</tt>:: Replaced by the elapsed real time, as reported by Tms#real
# <tt>%n</tt>:: 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(format = nil, *args)
str = (format || FORMAT).dup
str.gsub!(/(%[-+.\d]*)n/) { "#{$1}s" % label }
str.gsub!(/(%[-+.\d]*)u/) { "#{$1}f" % utime }
str.gsub!(/(%[-+.\d]*)y/) { "#{$1}f" % stime }
str.gsub!(/(%[-+.\d]*)U/) { "#{$1}f" % cutime }
str.gsub!(/(%[-+.\d]*)Y/) { "#{$1}f" % cstime }
str.gsub!(/(%[-+.\d]*)t/) { "#{$1}f" % total }
str.gsub!(/(%[-+.\d]*)r/) { "(#{$1}f)" % real }
format ? str % args : str
end
#
# Same as #format.
#
def to_s
format
end
#
# 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
[@label, @utime, @stime, @cutime, @cstime, @real]
end
#
# Returns a hash containing the same data as `to_a`.
#
def to_h
{
label: @label,
utime: @utime,
stime: @stime,
cutime: @cutime,
cstime: @cstime,
real: @real
}
end
protected
#
# Returns a new Tms object obtained by memberwise operation +op+
# of the individual times for this Tms object with those of the other
# Tms object (+x+).
#
# +op+ can be a mathematical operation such as <tt>+</tt>, <tt>-</tt>,
# <tt>*</tt>, <tt>/</tt>
#
def memberwise(op, x)
case x
when Benchmark::Tms
Benchmark::Tms.new(utime.__send__(op, x.utime),
stime.__send__(op, x.stime),
cutime.__send__(op, x.cutime),
cstime.__send__(op, x.cstime),
real.__send__(op, x.real)
)
else
Benchmark::Tms.new(utime.__send__(op, x),
stime.__send__(op, x),
cutime.__send__(op, x),
cstime.__send__(op, x),
real.__send__(op, x)
)
end
end
end
# The default caption string (heading above the output times).
CAPTION = Benchmark::Tms::CAPTION
# The default format string used to display times. See also Benchmark::Tms#format.
FORMAT = Benchmark::Tms::FORMAT
end
share/ruby/abbrev.rb 0000644 00000006735 15173517734 0010445 0 ustar 00 # frozen_string_literal: true
#--
# Copyright (c) 2001,2003 Akinori MUSHA <knu@iDaemons.org>
#
# All rights reserved. You can redistribute and/or modify it under
# the same terms as Ruby.
#
# $Idaemons: /home/cvs/rb/abbrev.rb,v 1.2 2001/05/30 09:37:45 knu Exp $
# $RoughId: abbrev.rb,v 1.4 2003/10/14 19:45:42 knu Exp $
# $Id$
#++
##
# 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
VERSION = "0.1.2"
# 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 abbrev(words, pattern = nil)
table = {}
seen = Hash.new(0)
if pattern.is_a?(String)
pattern = /\A#{Regexp.quote(pattern)}/ # regard as a prefix
end
words.each do |word|
next if word.empty?
word.size.downto(1) { |len|
abbrev = word[0...len]
next if pattern && pattern !~ abbrev
case seen[abbrev] += 1
when 1
table[abbrev] = word
when 2
table.delete(abbrev)
else
break
end
}
end
words.each do |word|
next if pattern && pattern !~ word
table[word] = word
end
table
end
module_function :abbrev
end
class Array
# Calculates the set of unambiguous abbreviations for the strings in +self+.
#
# require 'abbrev'
# %w{ car cone }.abbrev
# #=> {"car"=>"car", "ca"=>"car", "cone"=>"cone", "con"=>"cone", "co"=>"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.
#
# %w{ fast boat day }.abbrev(/^.a/)
# #=> {"fast"=>"fast", "fas"=>"fast", "fa"=>"fast", "day"=>"day", "da"=>"day"}
#
# Abbrev.abbrev(%w{car box cone}, "ca")
# #=> {"car"=>"car", "ca"=>"car"}
#
# See also Abbrev.abbrev
def abbrev(pattern = nil)
Abbrev::abbrev(self, pattern)
end
end
share/ruby/forwardable/impl.rb 0000644 00000000636 15173517734 0012427 0 ustar 00 # :stopdoc:
module Forwardable
def self._valid_method?(method)
iseq = RubyVM::InstructionSequence.compile("().#{method}", nil, nil, 0, false)
rescue SyntaxError
false
else
iseq.to_a.dig(-1, 1, 1, :mid) == method.to_sym
end
def self._compile_method(src, file, line)
RubyVM::InstructionSequence.compile(src, file, file, line,
trace_instruction: false)
.eval
end
end
share/ruby/time.rb 0000644 00000057365 15173517734 0010147 0 ustar 00 # frozen_string_literal: true
# shareable_constant_value: literal
require 'date'
# :stopdoc:
# = time.rb
#
# When 'time' is required, Time is extended with additional methods for parsing
# and converting Times.
#
# == Features
#
# This library extends the Time class with the following conversions between
# date strings and Time objects:
#
# * date-time defined by {RFC 2822}[http://www.ietf.org/rfc/rfc2822.txt]
# * HTTP-date defined by {RFC 2616}[http://www.ietf.org/rfc/rfc2616.txt]
# * dateTime defined by XML Schema Part 2: Datatypes ({ISO
# 8601}[http://www.iso.org/iso/date_and_time_format])
# * various formats handled by Date._parse
# * custom formats handled by Date._strptime
# :startdoc:
class Time
VERSION = "0.3.0"
class << Time
#
# A hash of timezones mapped to hour differences from UTC. The
# set of time zones corresponds to the ones specified by RFC 2822
# and ISO 8601.
#
ZoneOffset = { # :nodoc:
'UTC' => 0,
# ISO 8601
'Z' => 0,
# RFC 822
'UT' => 0, 'GMT' => 0,
'EST' => -5, 'EDT' => -4,
'CST' => -6, 'CDT' => -5,
'MST' => -7, 'MDT' => -6,
'PST' => -8, 'PDT' => -7,
# Following definition of military zones is original one.
# See RFC 1123 and RFC 2822 for the error in RFC 822.
'A' => +1, 'B' => +2, 'C' => +3, 'D' => +4, 'E' => +5, 'F' => +6,
'G' => +7, 'H' => +8, 'I' => +9, 'K' => +10, 'L' => +11, 'M' => +12,
'N' => -1, 'O' => -2, 'P' => -3, 'Q' => -4, 'R' => -5, 'S' => -6,
'T' => -7, 'U' => -8, 'V' => -9, 'W' => -10, 'X' => -11, 'Y' => -12,
}
#
# Return the number of seconds the specified time zone differs
# from UTC.
#
# Numeric time zones that include minutes, such as
# <code>-10:00</code> or <code>+1330</code> will work, as will
# simpler hour-only time zones like <code>-10</code> or
# <code>+13</code>.
#
# Textual time zones listed in ZoneOffset are also supported.
#
# If the time zone does not match any of the above, +zone_offset+
# will check if the local time zone (both with and without
# potential Daylight Saving \Time changes being in effect) matches
# +zone+. Specifying a value for +year+ will change the year used
# to find the local time zone.
#
# If +zone_offset+ is unable to determine the offset, nil will be
# returned.
#
# require 'time'
#
# Time.zone_offset("EST") #=> -18000
#
# You must require 'time' to use this method.
#
def zone_offset(zone, year=self.now.year)
off = nil
zone = zone.upcase
if /\A([+-])(\d\d)(:?)(\d\d)(?:\3(\d\d))?\z/ =~ zone
off = ($1 == '-' ? -1 : 1) * (($2.to_i * 60 + $4.to_i) * 60 + $5.to_i)
elsif zone.match?(/\A[+-]\d\d\z/)
off = zone.to_i * 3600
elsif ZoneOffset.include?(zone)
off = ZoneOffset[zone] * 3600
elsif ((t = self.local(year, 1, 1)).zone.upcase == zone rescue false)
off = t.utc_offset
elsif ((t = self.local(year, 7, 1)).zone.upcase == zone rescue false)
off = t.utc_offset
end
off
end
# :stopdoc:
def zone_utc?(zone)
# * +0000
# In RFC 2822, +0000 indicate a time zone at Universal Time.
# Europe/Lisbon is "a time zone at Universal Time" in Winter.
# Atlantic/Reykjavik is "a time zone at Universal Time".
# Africa/Dakar is "a time zone at Universal Time".
# So +0000 is a local time such as Europe/London, etc.
# * GMT
# GMT is used as a time zone abbreviation in Europe/London,
# Africa/Dakar, etc.
# So it is a local time.
#
# * -0000, -00:00
# In RFC 2822, -0000 the date-time contains no information about the
# local time zone.
# In RFC 3339, -00:00 is used for the time in UTC is known,
# but the offset to local time is unknown.
# They are not appropriate for specific time zone such as
# Europe/London because time zone neutral,
# So -00:00 and -0000 are treated as UTC.
zone.match?(/\A(?:-00:00|-0000|-00|UTC|Z|UT)\z/i)
end
private :zone_utc?
def force_zone!(t, zone, offset=nil)
if zone_utc?(zone)
t.utc
elsif offset ||= zone_offset(zone)
# Prefer the local timezone over the fixed offset timezone because
# the former is a real timezone and latter is an artificial timezone.
t.localtime
if t.utc_offset != offset
# Use the fixed offset timezone only if the local timezone cannot
# represent the given offset.
t.localtime(offset)
end
else
t.localtime
end
end
private :force_zone!
LeapYearMonthDays = [31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31] # :nodoc:
CommonYearMonthDays = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31] # :nodoc:
def month_days(y, m)
if ((y % 4 == 0) && (y % 100 != 0)) || (y % 400 == 0)
LeapYearMonthDays[m-1]
else
CommonYearMonthDays[m-1]
end
end
private :month_days
def apply_offset(year, mon, day, hour, min, sec, off)
if off < 0
off = -off
off, o = off.divmod(60)
if o != 0 then sec += o; o, sec = sec.divmod(60); off += o end
off, o = off.divmod(60)
if o != 0 then min += o; o, min = min.divmod(60); off += o end
off, o = off.divmod(24)
if o != 0 then hour += o; o, hour = hour.divmod(24); off += o end
if off != 0
day += off
days = month_days(year, mon)
if days and days < day
mon += 1
if 12 < mon
mon = 1
year += 1
end
day = 1
end
end
elsif 0 < off
off, o = off.divmod(60)
if o != 0 then sec -= o; o, sec = sec.divmod(60); off -= o end
off, o = off.divmod(60)
if o != 0 then min -= o; o, min = min.divmod(60); off -= o end
off, o = off.divmod(24)
if o != 0 then hour -= o; o, hour = hour.divmod(24); off -= o end
if off != 0 then
day -= off
if day < 1
mon -= 1
if mon < 1
year -= 1
mon = 12
end
day = month_days(year, mon)
end
end
end
return year, mon, day, hour, min, sec
end
private :apply_offset
def make_time(date, year, yday, mon, day, hour, min, sec, sec_fraction, zone, now)
if !year && !yday && !mon && !day && !hour && !min && !sec && !sec_fraction
raise ArgumentError, "no time information in #{date.inspect}"
end
off = nil
if year || now
off_year = year || now.year
off = zone_offset(zone, off_year) if zone
end
if yday
unless (1..366) === yday
raise ArgumentError, "yday #{yday} out of range"
end
mon, day = (yday-1).divmod(31)
mon += 1
day += 1
t = make_time(date, year, nil, mon, day, hour, min, sec, sec_fraction, zone, now)
diff = yday - t.yday
return t if diff.zero?
day += diff
if day > 28 and day > (mday = month_days(off_year, mon))
if (mon += 1) > 12
raise ArgumentError, "yday #{yday} out of range"
end
day -= mday
end
return make_time(date, year, nil, mon, day, hour, min, sec, sec_fraction, zone, now)
end
if now and now.respond_to?(:getlocal)
if off
now = now.getlocal(off) if now.utc_offset != off
else
now = now.getlocal
end
end
usec = nil
usec = sec_fraction * 1000000 if sec_fraction
if now
begin
break if year; year = now.year
break if mon; mon = now.mon
break if day; day = now.day
break if hour; hour = now.hour
break if min; min = now.min
break if sec; sec = now.sec
break if sec_fraction; usec = now.tv_usec
end until true
end
year ||= 1970
mon ||= 1
day ||= 1
hour ||= 0
min ||= 0
sec ||= 0
usec ||= 0
if year != off_year
off = nil
off = zone_offset(zone, year) if zone
end
if off
year, mon, day, hour, min, sec =
apply_offset(year, mon, day, hour, min, sec, off)
t = self.utc(year, mon, day, hour, min, sec, usec)
force_zone!(t, zone, off)
t
else
self.local(year, mon, day, hour, min, sec, usec)
end
end
private :make_time
# :startdoc:
#
# Takes a string representation of a Time and attempts to parse it
# using a heuristic.
#
# This method **does not** function as a validator. If the input
# string does not match valid formats strictly, you may get a
# cryptic result. Should consider to use `Time.strptime` instead
# of this method as possible.
#
# require 'time'
#
# Time.parse("2010-10-31") #=> 2010-10-31 00:00:00 -0500
#
# Any missing pieces of the date are inferred based on the current date.
#
# require 'time'
#
# # assuming the current date is "2011-10-31"
# Time.parse("12:00") #=> 2011-10-31 12:00:00 -0500
#
# We can change the date used to infer our missing elements by passing a second
# object that responds to #mon, #day and #year, such as Date, Time or DateTime.
# We can also use our own object.
#
# require 'time'
#
# class MyDate
# attr_reader :mon, :day, :year
#
# def initialize(mon, day, year)
# @mon, @day, @year = mon, day, year
# end
# end
#
# d = Date.parse("2010-10-28")
# t = Time.parse("2010-10-29")
# dt = DateTime.parse("2010-10-30")
# md = MyDate.new(10,31,2010)
#
# Time.parse("12:00", d) #=> 2010-10-28 12:00:00 -0500
# Time.parse("12:00", t) #=> 2010-10-29 12:00:00 -0500
# Time.parse("12:00", dt) #=> 2010-10-30 12:00:00 -0500
# Time.parse("12:00", md) #=> 2010-10-31 12:00:00 -0500
#
# If a block is given, the year described in +date+ is converted
# by the block. This is specifically designed for handling two
# digit years. For example, if you wanted to treat all two digit
# years prior to 70 as the year 2000+ you could write this:
#
# require 'time'
#
# Time.parse("01-10-31") {|year| year + (year < 70 ? 2000 : 1900)}
# #=> 2001-10-31 00:00:00 -0500
# Time.parse("70-10-31") {|year| year + (year < 70 ? 2000 : 1900)}
# #=> 1970-10-31 00:00:00 -0500
#
# If the upper components of the given time are broken or missing, they are
# supplied with those of +now+. For the lower components, the minimum
# values (1 or 0) are assumed if broken or missing. For example:
#
# require 'time'
#
# # Suppose it is "Thu Nov 29 14:33:20 2001" now and
# # your time zone is EST which is GMT-5.
# now = Time.parse("Thu Nov 29 14:33:20 2001")
# Time.parse("16:30", now) #=> 2001-11-29 16:30:00 -0500
# Time.parse("7/23", now) #=> 2001-07-23 00:00:00 -0500
# Time.parse("Aug 31", now) #=> 2001-08-31 00:00:00 -0500
# Time.parse("Aug 2000", now) #=> 2000-08-01 00:00:00 -0500
#
# Since there are numerous conflicts among locally defined time zone
# abbreviations all over the world, this method is not intended to
# understand all of them. For example, the abbreviation "CST" is
# used variously as:
#
# -06:00 in America/Chicago,
# -05:00 in America/Havana,
# +08:00 in Asia/Harbin,
# +09:30 in Australia/Darwin,
# +10:30 in Australia/Adelaide,
# etc.
#
# Based on this fact, this method only understands the time zone
# abbreviations described in RFC 822 and the system time zone, in the
# order named. (i.e. a definition in RFC 822 overrides the system
# time zone definition.) The system time zone is taken from
# <tt>Time.local(year, 1, 1).zone</tt> and
# <tt>Time.local(year, 7, 1).zone</tt>.
# If the extracted time zone abbreviation does not match any of them,
# it is ignored and the given time is regarded as a local time.
#
# ArgumentError is raised if Date._parse cannot extract information from
# +date+ or if the Time class cannot represent specified date.
#
# This method can be used as a fail-safe for other parsing methods as:
#
# Time.rfc2822(date) rescue Time.parse(date)
# Time.httpdate(date) rescue Time.parse(date)
# Time.xmlschema(date) rescue Time.parse(date)
#
# A failure of Time.parse should be checked, though.
#
# You must require 'time' to use this method.
#
def parse(date, now=self.now)
comp = !block_given?
d = Date._parse(date, comp)
year = d[:year]
year = yield(year) if year && !comp
make_time(date, year, d[:yday], d[:mon], d[:mday], d[:hour], d[:min], d[:sec], d[:sec_fraction], d[:zone], now)
end
#
# Works similar to +parse+ except that instead of using a
# heuristic to detect the format of the input string, you provide
# a second argument that describes the format of the string.
#
# If a block is given, the year described in +date+ is converted by the
# block. For example:
#
# Time.strptime(...) {|y| y < 100 ? (y >= 69 ? y + 1900 : y + 2000) : y}
#
# Below is a list of the formatting options:
#
# %a :: The abbreviated weekday name ("Sun")
# %A :: The full weekday name ("Sunday")
# %b :: The abbreviated month name ("Jan")
# %B :: The full month name ("January")
# %c :: The preferred local date and time representation
# %C :: Century (20 in 2009)
# %d :: Day of the month (01..31)
# %D :: Date (%m/%d/%y)
# %e :: Day of the month, blank-padded ( 1..31)
# %F :: Equivalent to %Y-%m-%d (the ISO 8601 date format)
# %g :: The last two digits of the commercial year
# %G :: The week-based year according to ISO-8601 (week 1 starts on Monday
# and includes January 4)
# %h :: Equivalent to %b
# %H :: Hour of the day, 24-hour clock (00..23)
# %I :: Hour of the day, 12-hour clock (01..12)
# %j :: Day of the year (001..366)
# %k :: hour, 24-hour clock, blank-padded ( 0..23)
# %l :: hour, 12-hour clock, blank-padded ( 0..12)
# %L :: Millisecond of the second (000..999)
# %m :: Month of the year (01..12)
# %M :: Minute of the hour (00..59)
# %n :: Newline (\n)
# %N :: Fractional seconds digits
# %p :: Meridian indicator ("AM" or "PM")
# %P :: Meridian indicator ("am" or "pm")
# %r :: time, 12-hour (same as %I:%M:%S %p)
# %R :: time, 24-hour (%H:%M)
# %s :: Number of seconds since 1970-01-01 00:00:00 UTC.
# %S :: Second of the minute (00..60)
# %t :: Tab character (\t)
# %T :: time, 24-hour (%H:%M:%S)
# %u :: Day of the week as a decimal, Monday being 1. (1..7)
# %U :: Week number of the current year, starting with the first Sunday as
# the first day of the first week (00..53)
# %v :: VMS date (%e-%b-%Y)
# %V :: Week number of year according to ISO 8601 (01..53)
# %W :: Week number of the current year, starting with the first Monday
# as the first day of the first week (00..53)
# %w :: Day of the week (Sunday is 0, 0..6)
# %x :: Preferred representation for the date alone, no time
# %X :: Preferred representation for the time alone, no date
# %y :: Year without a century (00..99)
# %Y :: Year which may include century, if provided
# %z :: Time zone as hour offset from UTC (e.g. +0900)
# %Z :: Time zone name
# %% :: Literal "%" character
# %+ :: date(1) (%a %b %e %H:%M:%S %Z %Y)
#
# require 'time'
#
# Time.strptime("2000-10-31", "%Y-%m-%d") #=> 2000-10-31 00:00:00 -0500
#
# You must require 'time' to use this method.
#
def strptime(date, format, now=self.now)
d = Date._strptime(date, format)
raise ArgumentError, "invalid date or strptime format - `#{date}' `#{format}'" unless d
if seconds = d[:seconds]
if sec_fraction = d[:sec_fraction]
usec = sec_fraction * 1000000
usec *= -1 if seconds < 0
else
usec = 0
end
t = Time.at(seconds, usec)
if zone = d[:zone]
force_zone!(t, zone)
end
else
year = d[:year]
year = yield(year) if year && block_given?
yday = d[:yday]
if (d[:cwyear] && !year) || ((d[:cwday] || d[:cweek]) && !(d[:mon] && d[:mday]))
# make_time doesn't deal with cwyear/cwday/cweek
return Date.strptime(date, format).to_time
end
if (d[:wnum0] || d[:wnum1]) && !yday && !(d[:mon] && d[:mday])
yday = Date.strptime(date, format).yday
end
t = make_time(date, year, yday, d[:mon], d[:mday], d[:hour], d[:min], d[:sec], d[:sec_fraction], d[:zone], now)
end
t
end
MonthValue = { # :nodoc:
'JAN' => 1, 'FEB' => 2, 'MAR' => 3, 'APR' => 4, 'MAY' => 5, 'JUN' => 6,
'JUL' => 7, 'AUG' => 8, 'SEP' => 9, 'OCT' =>10, 'NOV' =>11, 'DEC' =>12
}
#
# Parses +date+ as date-time defined by RFC 2822 and converts it to a Time
# object. The format is identical to the date format defined by RFC 822 and
# updated by RFC 1123.
#
# ArgumentError is raised if +date+ is not compliant with RFC 2822
# or if the Time class cannot represent specified date.
#
# See #rfc2822 for more information on this format.
#
# require 'time'
#
# Time.rfc2822("Wed, 05 Oct 2011 22:26:12 -0400")
# #=> 2010-10-05 22:26:12 -0400
#
# You must require 'time' to use this method.
#
def rfc2822(date)
if /\A\s*
(?:(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun)\s*,\s*)?
(\d{1,2})\s+
(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s+
(\d{2,})\s+
(\d{2})\s*
:\s*(\d{2})
(?:\s*:\s*(\d\d))?\s+
([+-]\d{4}|
UT|GMT|EST|EDT|CST|CDT|MST|MDT|PST|PDT|[A-IK-Z])/ix =~ date
# Since RFC 2822 permit comments, the regexp has no right anchor.
day = $1.to_i
mon = MonthValue[$2.upcase]
year = $3.to_i
short_year_p = $3.length <= 3
hour = $4.to_i
min = $5.to_i
sec = $6 ? $6.to_i : 0
zone = $7
if short_year_p
# following year completion is compliant with RFC 2822.
year = if year < 50
2000 + year
else
1900 + year
end
end
off = zone_offset(zone)
year, mon, day, hour, min, sec =
apply_offset(year, mon, day, hour, min, sec, off)
t = self.utc(year, mon, day, hour, min, sec)
force_zone!(t, zone, off)
t
else
raise ArgumentError.new("not RFC 2822 compliant date: #{date.inspect}")
end
end
alias rfc822 rfc2822
#
# Parses +date+ as an HTTP-date defined by RFC 2616 and converts it to a
# Time object.
#
# ArgumentError is raised if +date+ is not compliant with RFC 2616 or if
# the Time class cannot represent specified date.
#
# See #httpdate for more information on this format.
#
# require 'time'
#
# Time.httpdate("Thu, 06 Oct 2011 02:26:12 GMT")
# #=> 2011-10-06 02:26:12 UTC
#
# You must require 'time' to use this method.
#
def httpdate(date)
if date.match?(/\A\s*
(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun),\x20
(\d{2})\x20
(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\x20
(\d{4})\x20
(\d{2}):(\d{2}):(\d{2})\x20
GMT
\s*\z/ix)
self.rfc2822(date).utc
elsif /\A\s*
(?:Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday),\x20
(\d\d)-(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)-(\d\d)\x20
(\d\d):(\d\d):(\d\d)\x20
GMT
\s*\z/ix =~ date
year = $3.to_i
if year < 50
year += 2000
else
year += 1900
end
self.utc(year, $2, $1.to_i, $4.to_i, $5.to_i, $6.to_i)
elsif /\A\s*
(?:Mon|Tue|Wed|Thu|Fri|Sat|Sun)\x20
(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\x20
(\d\d|\x20\d)\x20
(\d\d):(\d\d):(\d\d)\x20
(\d{4})
\s*\z/ix =~ date
self.utc($6.to_i, MonthValue[$1.upcase], $2.to_i,
$3.to_i, $4.to_i, $5.to_i)
else
raise ArgumentError.new("not RFC 2616 compliant date: #{date.inspect}")
end
end
#
# Parses +time+ as a dateTime defined by the XML Schema and converts it to
# a Time object. The format is a restricted version of the format defined
# by ISO 8601.
#
# ArgumentError is raised if +time+ is not compliant with the format or if
# the Time class cannot represent the specified time.
#
# See #xmlschema for more information on this format.
#
# require 'time'
#
# Time.xmlschema("2011-10-05T22:26:12-04:00")
# #=> 2011-10-05 22:26:12-04:00
#
# You must require 'time' to use this method.
#
def xmlschema(time)
if /\A\s*
(-?\d+)-(\d\d)-(\d\d)
T
(\d\d):(\d\d):(\d\d)
(\.\d+)?
(Z|[+-]\d\d(?::?\d\d)?)?
\s*\z/ix =~ time
year = $1.to_i
mon = $2.to_i
day = $3.to_i
hour = $4.to_i
min = $5.to_i
sec = $6.to_i
usec = 0
if $7
usec = Rational($7) * 1000000
end
if $8
zone = $8
off = zone_offset(zone)
year, mon, day, hour, min, sec =
apply_offset(year, mon, day, hour, min, sec, off)
t = self.utc(year, mon, day, hour, min, sec, usec)
force_zone!(t, zone, off)
t
else
self.local(year, mon, day, hour, min, sec, usec)
end
else
raise ArgumentError.new("invalid xmlschema format: #{time.inspect}")
end
end
alias iso8601 xmlschema
end # class << self
#
# Returns a string which represents the time as date-time defined by RFC 2822:
#
# day-of-week, DD month-name CCYY hh:mm:ss zone
#
# where zone is [+-]hhmm.
#
# If +self+ is a UTC time, -0000 is used as zone.
#
# require 'time'
#
# t = Time.now
# t.rfc2822 # => "Wed, 05 Oct 2011 22:26:12 -0400"
#
# You must require 'time' to use this method.
#
def rfc2822
strftime('%a, %d %b %Y %T ') << (utc? ? '-0000' : strftime('%z'))
end
alias rfc822 rfc2822
#
# Returns a string which represents the time as RFC 1123 date of HTTP-date
# defined by RFC 2616:
#
# day-of-week, DD month-name CCYY hh:mm:ss GMT
#
# Note that the result is always UTC (GMT).
#
# require 'time'
#
# t = Time.now
# t.httpdate # => "Thu, 06 Oct 2011 02:26:12 GMT"
#
# You must require 'time' to use this method.
#
def httpdate
getutc.strftime('%a, %d %b %Y %T GMT')
end
#
# Returns a string which represents the time as a dateTime defined by XML
# Schema:
#
# CCYY-MM-DDThh:mm:ssTZD
# CCYY-MM-DDThh:mm:ss.sssTZD
#
# where TZD is Z or [+-]hh:mm.
#
# If self is a UTC time, Z is used as TZD. [+-]hh:mm is used otherwise.
#
# +fraction_digits+ specifies a number of digits to use for fractional
# seconds. Its default value is 0.
#
# require 'time'
#
# t = Time.now
# t.iso8601 # => "2011-10-05T22:26:12-04:00"
#
# You must require 'time' to use this method.
#
def xmlschema(fraction_digits=0)
fraction_digits = fraction_digits.to_i
s = strftime("%FT%T")
if fraction_digits > 0
s << strftime(".%#{fraction_digits}N")
end
s << (utc? ? 'Z' : strftime("%:z"))
end
alias iso8601 xmlschema
end
share/ruby/logger.rb 0000644 00000054036 15173517734 0010460 0 ustar 00 # frozen_string_literal: true
# logger.rb - simple logging utility
# Copyright (C) 2000-2003, 2005, 2008, 2011 NAKAMURA, Hiroshi <nahi@ruby-lang.org>.
#
# Documentation:: NAKAMURA, Hiroshi and Gavin Sinclair
# License::
# You can redistribute it and/or modify it under the same terms of Ruby's
# license; either the dual license version in 2003, or any later version.
# Revision:: $Id$
#
# A simple system for logging messages. See Logger for more documentation.
require 'fiber'
require 'monitor'
require 'rbconfig'
require_relative 'logger/version'
require_relative 'logger/formatter'
require_relative 'logger/log_device'
require_relative 'logger/severity'
require_relative 'logger/errors'
# \Class \Logger provides a simple but sophisticated logging utility that
# you can use to create one or more
# {event logs}[https://en.wikipedia.org/wiki/Logging_(software)#Event_logs]
# for your program.
# Each such log contains a chronological sequence of entries
# that provides a record of the program's activities.
#
# == About the Examples
#
# All examples on this page assume that \Logger has been required:
#
# require 'logger'
#
# == Synopsis
#
# Create a log with Logger.new:
#
# # Single log file.
# logger = Logger.new('t.log')
# # Size-based rotated logging: 3 10-megabyte files.
# logger = Logger.new('t.log', 3, 10485760)
# # Period-based rotated logging: daily (also allowed: 'weekly', 'monthly').
# logger = Logger.new('t.log', 'daily')
# # Log to an IO stream.
# logger = Logger.new($stdout)
#
# Add entries (level, message) with Logger#add:
#
# logger.add(Logger::DEBUG, 'Maximal debugging info')
# logger.add(Logger::INFO, 'Non-error information')
# logger.add(Logger::WARN, 'Non-error warning')
# logger.add(Logger::ERROR, 'Non-fatal error')
# logger.add(Logger::FATAL, 'Fatal error')
# logger.add(Logger::UNKNOWN, 'Most severe')
#
# Close the log with Logger#close:
#
# logger.close
#
# == Entries
#
# You can add entries with method Logger#add:
#
# logger.add(Logger::DEBUG, 'Maximal debugging info')
# logger.add(Logger::INFO, 'Non-error information')
# logger.add(Logger::WARN, 'Non-error warning')
# logger.add(Logger::ERROR, 'Non-fatal error')
# logger.add(Logger::FATAL, 'Fatal error')
# logger.add(Logger::UNKNOWN, 'Most severe')
#
# These shorthand methods also add entries:
#
# logger.debug('Maximal debugging info')
# logger.info('Non-error information')
# logger.warn('Non-error warning')
# logger.error('Non-fatal error')
# logger.fatal('Fatal error')
# logger.unknown('Most severe')
#
# When you call any of these methods,
# the entry may or may not be written to the log,
# depending on the entry's severity and on the log level;
# see {Log Level}[rdoc-ref:Logger@Log+Level]
#
# An entry always has:
#
# - A severity (the required argument to #add).
# - An automatically created timestamp.
#
# And may also have:
#
# - A message.
# - A program name.
#
# Example:
#
# logger = Logger.new($stdout)
# logger.add(Logger::INFO, 'My message.', 'mung')
# # => I, [2022-05-07T17:21:46.536234 #20536] INFO -- mung: My message.
#
# The default format for an entry is:
#
# "%s, [%s #%d] %5s -- %s: %s\n"
#
# where the values to be formatted are:
#
# - \Severity (one letter).
# - Timestamp.
# - Process id.
# - \Severity (word).
# - Program name.
# - Message.
#
# You can use a different entry format by:
#
# - Setting a custom format proc (affects following entries);
# see {formatter=}[Logger.html#attribute-i-formatter].
# - Calling any of the methods above with a block
# (affects only the one entry).
# Doing so can have two benefits:
#
# - Context: the block can evaluate the entire program context
# and create a context-dependent message.
# - Performance: the block is not evaluated unless the log level
# permits the entry actually to be written:
#
# logger.error { my_slow_message_generator }
#
# Contrast this with the string form, where the string is
# always evaluated, regardless of the log level:
#
# logger.error("#{my_slow_message_generator}")
#
# === \Severity
#
# The severity of a log entry has two effects:
#
# - Determines whether the entry is selected for inclusion in the log;
# see {Log Level}[rdoc-ref:Logger@Log+Level].
# - Indicates to any log reader (whether a person or a program)
# the relative importance of the entry.
#
# === Timestamp
#
# The timestamp for a log entry is generated automatically
# when the entry is created.
#
# The logged timestamp is formatted by method
# {Time#strftime}[rdoc-ref:Time#strftime]
# using this format string:
#
# '%Y-%m-%dT%H:%M:%S.%6N'
#
# Example:
#
# logger = Logger.new($stdout)
# logger.add(Logger::INFO)
# # => I, [2022-05-07T17:04:32.318331 #20536] INFO -- : nil
#
# You can set a different format using method #datetime_format=.
#
# === Message
#
# The message is an optional argument to an entry method:
#
# logger = Logger.new($stdout)
# logger.add(Logger::INFO, 'My message')
# # => I, [2022-05-07T18:15:37.647581 #20536] INFO -- : My message
#
# For the default entry formatter, <tt>Logger::Formatter</tt>,
# the message object may be:
#
# - A string: used as-is.
# - An Exception: <tt>message.message</tt> is used.
# - Anything else: <tt>message.inspect</tt> is used.
#
# *Note*: Logger::Formatter does not escape or sanitize
# the message passed to it.
# Developers should be aware that malicious data (user input)
# may be in the message, and should explicitly escape untrusted data.
#
# You can use a custom formatter to escape message data;
# see the example at {formatter=}[Logger.html#attribute-i-formatter].
#
# === Program Name
#
# The program name is an optional argument to an entry method:
#
# logger = Logger.new($stdout)
# logger.add(Logger::INFO, 'My message', 'mung')
# # => I, [2022-05-07T18:17:38.084716 #20536] INFO -- mung: My message
#
# The default program name for a new logger may be set in the call to
# Logger.new via optional keyword argument +progname+:
#
# logger = Logger.new('t.log', progname: 'mung')
#
# The default program name for an existing logger may be set
# by a call to method #progname=:
#
# logger.progname = 'mung'
#
# The current program name may be retrieved with method
# {progname}[Logger.html#attribute-i-progname]:
#
# logger.progname # => "mung"
#
# == Log Level
#
# The log level setting determines whether an entry is actually
# written to the log, based on the entry's severity.
#
# These are the defined severities (least severe to most severe):
#
# logger = Logger.new($stdout)
# logger.add(Logger::DEBUG, 'Maximal debugging info')
# # => D, [2022-05-07T17:57:41.776220 #20536] DEBUG -- : Maximal debugging info
# logger.add(Logger::INFO, 'Non-error information')
# # => I, [2022-05-07T17:59:14.349167 #20536] INFO -- : Non-error information
# logger.add(Logger::WARN, 'Non-error warning')
# # => W, [2022-05-07T18:00:45.337538 #20536] WARN -- : Non-error warning
# logger.add(Logger::ERROR, 'Non-fatal error')
# # => E, [2022-05-07T18:02:41.592912 #20536] ERROR -- : Non-fatal error
# logger.add(Logger::FATAL, 'Fatal error')
# # => F, [2022-05-07T18:05:24.703931 #20536] FATAL -- : Fatal error
# logger.add(Logger::UNKNOWN, 'Most severe')
# # => A, [2022-05-07T18:07:54.657491 #20536] ANY -- : Most severe
#
# The default initial level setting is Logger::DEBUG, the lowest level,
# which means that all entries are to be written, regardless of severity:
#
# logger = Logger.new($stdout)
# logger.level # => 0
# logger.add(0, "My message")
# # => D, [2022-05-11T15:10:59.773668 #20536] DEBUG -- : My message
#
# You can specify a different setting in a new logger
# using keyword argument +level+ with an appropriate value:
#
# logger = Logger.new($stdout, level: Logger::ERROR)
# logger = Logger.new($stdout, level: 'error')
# logger = Logger.new($stdout, level: :error)
# logger.level # => 3
#
# With this level, entries with severity Logger::ERROR and higher
# are written, while those with lower severities are not written:
#
# logger = Logger.new($stdout, level: Logger::ERROR)
# logger.add(3)
# # => E, [2022-05-11T15:17:20.933362 #20536] ERROR -- : nil
# logger.add(2) # Silent.
#
# You can set the log level for an existing logger
# with method #level=:
#
# logger.level = Logger::ERROR
#
# These shorthand methods also set the level:
#
# logger.debug! # => 0
# logger.info! # => 1
# logger.warn! # => 2
# logger.error! # => 3
# logger.fatal! # => 4
#
# You can retrieve the log level with method #level.
#
# logger.level = Logger::ERROR
# logger.level # => 3
#
# These methods return whether a given
# level is to be written:
#
# logger.level = Logger::ERROR
# logger.debug? # => false
# logger.info? # => false
# logger.warn? # => false
# logger.error? # => true
# logger.fatal? # => true
#
# == Log File Rotation
#
# By default, a log file is a single file that grows indefinitely
# (until explicitly closed); there is no file rotation.
#
# To keep log files to a manageable size,
# you can use _log_ _file_ _rotation_, which uses multiple log files:
#
# - Each log file has entries for a non-overlapping
# time interval.
# - Only the most recent log file is open and active;
# the others are closed and inactive.
#
# === Size-Based Rotation
#
# For size-based log file rotation, call Logger.new with:
#
# - Argument +logdev+ as a file path.
# - Argument +shift_age+ with a positive integer:
# the number of log files to be in the rotation.
# - Argument +shift_size+ as a positive integer:
# the maximum size (in bytes) of each log file;
# defaults to 1048576 (1 megabyte).
#
# Examples:
#
# logger = Logger.new('t.log', 3) # Three 1-megabyte files.
# logger = Logger.new('t.log', 5, 10485760) # Five 10-megabyte files.
#
# For these examples, suppose:
#
# logger = Logger.new('t.log', 3)
#
# Logging begins in the new log file, +t.log+;
# the log file is "full" and ready for rotation
# when a new entry would cause its size to exceed +shift_size+.
#
# The first time +t.log+ is full:
#
# - +t.log+ is closed and renamed to +t.log.0+.
# - A new file +t.log+ is opened.
#
# The second time +t.log+ is full:
#
# - +t.log.0 is renamed as +t.log.1+.
# - +t.log+ is closed and renamed to +t.log.0+.
# - A new file +t.log+ is opened.
#
# Each subsequent time that +t.log+ is full,
# the log files are rotated:
#
# - +t.log.1+ is removed.
# - +t.log.0 is renamed as +t.log.1+.
# - +t.log+ is closed and renamed to +t.log.0+.
# - A new file +t.log+ is opened.
#
# === Periodic Rotation
#
# For periodic rotation, call Logger.new with:
#
# - Argument +logdev+ as a file path.
# - Argument +shift_age+ as a string period indicator.
#
# Examples:
#
# logger = Logger.new('t.log', 'daily') # Rotate log files daily.
# logger = Logger.new('t.log', 'weekly') # Rotate log files weekly.
# logger = Logger.new('t.log', 'monthly') # Rotate log files monthly.
#
# Example:
#
# logger = Logger.new('t.log', 'daily')
#
# When the given period expires:
#
# - The base log file, +t.log+ is closed and renamed
# with a date-based suffix such as +t.log.20220509+.
# - A new log file +t.log+ is opened.
# - Nothing is removed.
#
# The default format for the suffix is <tt>'%Y%m%d'</tt>,
# which produces a suffix similar to the one above.
# You can set a different format using create-time option
# +shift_period_suffix+;
# see details and suggestions at
# {Time#strftime}[rdoc-ref:Time#strftime].
#
class Logger
_, name, rev = %w$Id$
if name
name = name.chomp(",v")
else
name = File.basename(__FILE__)
end
rev ||= "v#{VERSION}"
ProgName = "#{name}/#{rev}"
include Severity
# Logging severity threshold (e.g. <tt>Logger::INFO</tt>).
def level
@level_override[Fiber.current] || @level
end
# Sets the log level; returns +severity+.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
# Argument +severity+ may be an integer, a string, or a symbol:
#
# logger.level = Logger::ERROR # => 3
# logger.level = 3 # => 3
# logger.level = 'error' # => "error"
# logger.level = :error # => :error
#
# Logger#sev_threshold= is an alias for Logger#level=.
#
def level=(severity)
@level = Severity.coerce(severity)
end
# Adjust the log level during the block execution for the current Fiber only
#
# logger.with_level(:debug) do
# logger.debug { "Hello" }
# end
def with_level(severity)
prev, @level_override[Fiber.current] = level, Severity.coerce(severity)
begin
yield
ensure
if prev
@level_override[Fiber.current] = prev
else
@level_override.delete(Fiber.current)
end
end
end
# Program name to include in log messages.
attr_accessor :progname
# Sets the date-time format.
#
# Argument +datetime_format+ should be either of these:
#
# - A string suitable for use as a format for method
# {Time#strftime}[rdoc-ref:Time#strftime].
# - +nil+: the logger uses <tt>'%Y-%m-%dT%H:%M:%S.%6N'</tt>.
#
def datetime_format=(datetime_format)
@default_formatter.datetime_format = datetime_format
end
# Returns the date-time format; see #datetime_format=.
#
def datetime_format
@default_formatter.datetime_format
end
# Sets or retrieves the logger entry formatter proc.
#
# When +formatter+ is +nil+, the logger uses Logger::Formatter.
#
# When +formatter+ is a proc, a new entry is formatted by the proc,
# which is called with four arguments:
#
# - +severity+: The severity of the entry.
# - +time+: A Time object representing the entry's timestamp.
# - +progname+: The program name for the entry.
# - +msg+: The message for the entry (string or string-convertible object).
#
# The proc should return a string containing the formatted entry.
#
# This custom formatter uses
# {String#dump}[rdoc-ref:String#dump]
# to escape the message string:
#
# logger = Logger.new($stdout, progname: 'mung')
# original_formatter = logger.formatter || Logger::Formatter.new
# logger.formatter = proc { |severity, time, progname, msg|
# original_formatter.call(severity, time, progname, msg.dump)
# }
# logger.add(Logger::INFO, "hello \n ''")
# logger.add(Logger::INFO, "\f\x00\xff\\\"")
#
# Output:
#
# I, [2022-05-13T13:16:29.637488 #8492] INFO -- mung: "hello \n ''"
# I, [2022-05-13T13:16:29.637610 #8492] INFO -- mung: "\f\x00\xFF\\\""
#
attr_accessor :formatter
alias sev_threshold level
alias sev_threshold= level=
# Returns +true+ if the log level allows entries with severity
# Logger::DEBUG to be written, +false+ otherwise.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def debug?; level <= DEBUG; end
# Sets the log level to Logger::DEBUG.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def debug!; self.level = DEBUG; end
# Returns +true+ if the log level allows entries with severity
# Logger::INFO to be written, +false+ otherwise.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def info?; level <= INFO; end
# Sets the log level to Logger::INFO.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def info!; self.level = INFO; end
# Returns +true+ if the log level allows entries with severity
# Logger::WARN to be written, +false+ otherwise.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def warn?; level <= WARN; end
# Sets the log level to Logger::WARN.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def warn!; self.level = WARN; end
# Returns +true+ if the log level allows entries with severity
# Logger::ERROR to be written, +false+ otherwise.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def error?; level <= ERROR; end
# Sets the log level to Logger::ERROR.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def error!; self.level = ERROR; end
# Returns +true+ if the log level allows entries with severity
# Logger::FATAL to be written, +false+ otherwise.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def fatal?; level <= FATAL; end
# Sets the log level to Logger::FATAL.
# See {Log Level}[rdoc-ref:Logger@Log+Level].
#
def fatal!; self.level = FATAL; end
# :call-seq:
# Logger.new(logdev, shift_age = 0, shift_size = 1048576, **options)
#
# With the single argument +logdev+,
# returns a new logger with all default options:
#
# Logger.new('t.log') # => #<Logger:0x000001e685dc6ac8>
#
# Argument +logdev+ must be one of:
#
# - A string filepath: entries are to be written
# to the file at that path; if the file at that path exists,
# new entries are appended.
# - An IO stream (typically +$stdout+, +$stderr+. or an open file):
# entries are to be written to the given stream.
# - +nil+ or +File::NULL+: no entries are to be written.
#
# Examples:
#
# Logger.new('t.log')
# Logger.new($stdout)
#
# The keyword options are:
#
# - +level+: sets the log level; default value is Logger::DEBUG.
# See {Log Level}[rdoc-ref:Logger@Log+Level]:
#
# Logger.new('t.log', level: Logger::ERROR)
#
# - +progname+: sets the default program name; default is +nil+.
# See {Program Name}[rdoc-ref:Logger@Program+Name]:
#
# Logger.new('t.log', progname: 'mung')
#
# - +formatter+: sets the entry formatter; default is +nil+.
# See {formatter=}[Logger.html#attribute-i-formatter].
# - +datetime_format+: sets the format for entry timestamp;
# default is +nil+.
# See #datetime_format=.
# - +binmode+: sets whether the logger writes in binary mode;
# default is +false+.
# - +shift_period_suffix+: sets the format for the filename suffix
# for periodic log file rotation; default is <tt>'%Y%m%d'</tt>.
# See {Periodic Rotation}[rdoc-ref:Logger@Periodic+Rotation].
#
def initialize(logdev, shift_age = 0, shift_size = 1048576, level: DEBUG,
progname: nil, formatter: nil, datetime_format: nil,
binmode: false, shift_period_suffix: '%Y%m%d')
self.level = level
self.progname = progname
@default_formatter = Formatter.new
self.datetime_format = datetime_format
self.formatter = formatter
@logdev = nil
@level_override = {}
if logdev && logdev != File::NULL
@logdev = LogDevice.new(logdev, shift_age: shift_age,
shift_size: shift_size,
shift_period_suffix: shift_period_suffix,
binmode: binmode)
end
end
# Sets the logger's output stream:
#
# - If +logdev+ is +nil+, reopens the current output stream.
# - If +logdev+ is a filepath, opens the indicated file for append.
# - If +logdev+ is an IO stream
# (usually <tt>$stdout</tt>, <tt>$stderr</tt>, or an open File object),
# opens the stream for append.
#
# Example:
#
# logger = Logger.new('t.log')
# logger.add(Logger::ERROR, 'one')
# logger.close
# logger.add(Logger::ERROR, 'two') # Prints 'log writing failed. closed stream'
# logger.reopen
# logger.add(Logger::ERROR, 'three')
# logger.close
# File.readlines('t.log')
# # =>
# # ["# Logfile created on 2022-05-12 14:21:19 -0500 by logger.rb/v1.5.0\n",
# # "E, [2022-05-12T14:21:27.596726 #22428] ERROR -- : one\n",
# # "E, [2022-05-12T14:23:05.847241 #22428] ERROR -- : three\n"]
#
def reopen(logdev = nil)
@logdev&.reopen(logdev)
self
end
# Creates a log entry, which may or may not be written to the log,
# depending on the entry's severity and on the log level.
# See {Log Level}[rdoc-ref:Logger@Log+Level]
# and {Entries}[rdoc-ref:Logger@Entries] for details.
#
# Examples:
#
# logger = Logger.new($stdout, progname: 'mung')
# logger.add(Logger::INFO)
# logger.add(Logger::ERROR, 'No good')
# logger.add(Logger::ERROR, 'No good', 'gnum')
#
# Output:
#
# I, [2022-05-12T16:25:31.469726 #36328] INFO -- mung: mung
# E, [2022-05-12T16:25:55.349414 #36328] ERROR -- mung: No good
# E, [2022-05-12T16:26:35.841134 #36328] ERROR -- gnum: No good
#
# These convenience methods have implicit severity:
#
# - #debug.
# - #info.
# - #warn.
# - #error.
# - #fatal.
# - #unknown.
#
def add(severity, message = nil, progname = nil)
severity ||= UNKNOWN
if @logdev.nil? or severity < level
return true
end
if progname.nil?
progname = @progname
end
if message.nil?
if block_given?
message = yield
else
message = progname
progname = @progname
end
end
@logdev.write(
format_message(format_severity(severity), Time.now, progname, message))
true
end
alias log add
# Writes the given +msg+ to the log with no formatting;
# returns the number of characters written,
# or +nil+ if no log device exists:
#
# logger = Logger.new($stdout)
# logger << 'My message.' # => 10
#
# Output:
#
# My message.
#
def <<(msg)
@logdev&.write(msg)
end
# Equivalent to calling #add with severity <tt>Logger::DEBUG</tt>.
#
def debug(progname = nil, &block)
add(DEBUG, nil, progname, &block)
end
# Equivalent to calling #add with severity <tt>Logger::INFO</tt>.
#
def info(progname = nil, &block)
add(INFO, nil, progname, &block)
end
# Equivalent to calling #add with severity <tt>Logger::WARN</tt>.
#
def warn(progname = nil, &block)
add(WARN, nil, progname, &block)
end
# Equivalent to calling #add with severity <tt>Logger::ERROR</tt>.
#
def error(progname = nil, &block)
add(ERROR, nil, progname, &block)
end
# Equivalent to calling #add with severity <tt>Logger::FATAL</tt>.
#
def fatal(progname = nil, &block)
add(FATAL, nil, progname, &block)
end
# Equivalent to calling #add with severity <tt>Logger::UNKNOWN</tt>.
#
def unknown(progname = nil, &block)
add(UNKNOWN, nil, progname, &block)
end
# Closes the logger; returns +nil+:
#
# logger = Logger.new('t.log')
# logger.close # => nil
# logger.info('foo') # Prints "log writing failed. closed stream"
#
# Related: Logger#reopen.
def close
@logdev&.close
end
private
# \Severity label for logging (max 5 chars).
SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY).freeze
def format_severity(severity)
SEV_LABEL[severity] || 'ANY'
end
def format_message(severity, datetime, progname, msg)
(@formatter || @default_formatter).call(severity, datetime, progname, msg)
end
end
share/ruby/error_highlight.rb 0000644 00000000124 15173517734 0012346 0 ustar 00 require_relative "error_highlight/base"
require_relative "error_highlight/core_ext"
share/ruby/observer.rb 0000644 00000014604 15173517734 0011025 0 ustar 00 # frozen_string_literal: true
#
# Implementation of the _Observer_ object-oriented design pattern. The
# following documentation is copied, with modifications, from "Programming
# Ruby", by Hunt and Thomas; http://www.ruby-doc.org/docs/ProgrammingRuby/html/lib_patterns.html.
#
# See Observable for more info.
# The Observer pattern (also known as publish/subscribe) provides a simple
# mechanism for one object to inform a set of interested third-party objects
# when its state changes.
#
# == Mechanism
#
# The notifying class mixes in the +Observable+
# module, which provides the methods for managing the associated observer
# objects.
#
# The observable object must:
# * assert that it has +#changed+
# * call +#notify_observers+
#
# An observer subscribes to updates using Observable#add_observer, which also
# specifies the method called via #notify_observers. The default method for
# #notify_observers is #update.
#
# === Example
#
# The following example demonstrates this nicely. A +Ticker+, when run,
# continually receives the stock +Price+ for its <tt>@symbol</tt>. A +Warner+
# is a general observer of the price, and two warners are demonstrated, a
# +WarnLow+ and a +WarnHigh+, which print a warning if the price is below or
# above their set limits, respectively.
#
# The +update+ callback allows the warners to run without being explicitly
# called. The system is set up with the +Ticker+ and several observers, and the
# observers do their duty without the top-level code having to interfere.
#
# Note that the contract between publisher and subscriber (observable and
# observer) is not declared or enforced. The +Ticker+ publishes a time and a
# price, and the warners receive that. But if you don't ensure that your
# contracts are correct, nothing else can warn you.
#
# require "observer"
#
# class Ticker ### Periodically fetch a stock price.
# include Observable
#
# def initialize(symbol)
# @symbol = symbol
# end
#
# def run
# last_price = nil
# loop do
# price = Price.fetch(@symbol)
# print "Current price: #{price}\n"
# if price != last_price
# changed # notify observers
# last_price = price
# notify_observers(Time.now, price)
# end
# sleep 1
# end
# end
# end
#
# class Price ### A mock class to fetch a stock price (60 - 140).
# def self.fetch(symbol)
# 60 + rand(80)
# end
# end
#
# class Warner ### An abstract observer of Ticker objects.
# def initialize(ticker, limit)
# @limit = limit
# ticker.add_observer(self)
# end
# end
#
# class WarnLow < Warner
# def update(time, price) # callback for observer
# if price < @limit
# print "--- #{time.to_s}: Price below #@limit: #{price}\n"
# end
# end
# end
#
# class WarnHigh < Warner
# def update(time, price) # callback for observer
# if price > @limit
# print "+++ #{time.to_s}: Price above #@limit: #{price}\n"
# end
# end
# end
#
# ticker = Ticker.new("MSFT")
# WarnLow.new(ticker, 80)
# WarnHigh.new(ticker, 120)
# ticker.run
#
# Produces:
#
# Current price: 83
# Current price: 75
# --- Sun Jun 09 00:10:25 CDT 2002: Price below 80: 75
# Current price: 90
# Current price: 134
# +++ Sun Jun 09 00:10:25 CDT 2002: Price above 120: 134
# Current price: 134
# Current price: 112
# Current price: 79
# --- Sun Jun 09 00:10:25 CDT 2002: Price below 80: 79
#
# === Usage with procs
#
# The +#notify_observers+ method can also be used with +proc+s by using
# the +:call+ as +func+ parameter.
#
# The following example illustrates the use of a lambda:
#
# require 'observer'
#
# class Ticker
# include Observable
#
# def run
# # logic to retrieve the price (here 77.0)
# changed
# notify_observers(77.0)
# end
# end
#
# ticker = Ticker.new
# warner = ->(price) { puts "New price received: #{price}" }
# ticker.add_observer(warner, :call)
# ticker.run
module Observable
VERSION = "0.1.2"
#
# Add +observer+ as an observer on this object. So that it will receive
# notifications.
#
# +observer+:: the object that will be notified of changes.
# +func+:: Symbol naming the method that will be called when this Observable
# has changes.
#
# This method must return true for +observer.respond_to?+ and will
# receive <tt>*arg</tt> when #notify_observers is called, where
# <tt>*arg</tt> is the value passed to #notify_observers by this
# Observable
def add_observer(observer, func=:update)
@observer_peers = {} unless defined? @observer_peers
unless observer.respond_to? func
raise NoMethodError, "observer does not respond to `#{func}'"
end
@observer_peers[observer] = func
end
#
# Remove +observer+ as an observer on this object so that it will no longer
# receive notifications.
#
# +observer+:: An observer of this Observable
def delete_observer(observer)
@observer_peers.delete observer if defined? @observer_peers
end
#
# Remove all observers associated with this object.
#
def delete_observers
@observer_peers.clear if defined? @observer_peers
end
#
# Return the number of observers associated with this object.
#
def count_observers
if defined? @observer_peers
@observer_peers.size
else
0
end
end
#
# Set the changed state of this object. Notifications will be sent only if
# the changed +state+ is +true+.
#
# +state+:: Boolean indicating the changed state of this Observable.
#
def changed(state=true)
@observer_state = state
end
#
# Returns true if this object's state has been changed since the last
# #notify_observers call.
#
def changed?
if defined? @observer_state and @observer_state
true
else
false
end
end
#
# Notify observers of a change in state *if* this object's changed state is
# +true+.
#
# This will invoke the method named in #add_observer, passing <tt>*arg</tt>.
# The changed state is then set to +false+.
#
# <tt>*arg</tt>:: Any arguments to pass to the observers.
def notify_observers(*arg)
if defined? @observer_state and @observer_state
if defined? @observer_peers
@observer_peers.each do |k, v|
k.__send__(v, *arg)
end
end
@observer_state = false
end
end
end
share/ruby/syslog/logger.rb 0000644 00000013440 15173517734 0011772 0 ustar 00 # frozen_string_literal: false
require 'syslog'
require 'logger'
##
# Syslog::Logger is a Logger work-alike that logs via syslog instead of to a
# file. You can use Syslog::Logger to aggregate logs between multiple
# machines.
#
# By default, Syslog::Logger uses the program name 'ruby', but this can be
# changed via the first argument to Syslog::Logger.new.
#
# NOTE! You can only set the Syslog::Logger program name when you initialize
# Syslog::Logger for the first time. This is a limitation of the way
# Syslog::Logger uses syslog (and in some ways, a limitation of the way
# syslog(3) works). Attempts to change Syslog::Logger's program name after
# the first initialization will be ignored.
#
# === Example
#
# The following will log to syslogd on your local machine:
#
# require 'syslog/logger'
#
# log = Syslog::Logger.new 'my_program'
# log.info 'this line will be logged via syslog(3)'
#
# Also the facility may be set to specify the facility level which will be used:
#
# log.info 'this line will be logged using Syslog default facility level'
#
# log_local1 = Syslog::Logger.new 'my_program', Syslog::LOG_LOCAL1
# log_local1.info 'this line will be logged using local1 facility level'
#
#
# You may need to perform some syslog.conf setup first. For a BSD machine add
# the following lines to /etc/syslog.conf:
#
# !my_program
# *.* /var/log/my_program.log
#
# Then touch /var/log/my_program.log and signal syslogd with a HUP
# (killall -HUP syslogd, on FreeBSD).
#
# If you wish to have logs automatically roll over and archive, see the
# newsyslog.conf(5) and newsyslog(8) man pages.
class Syslog::Logger
# Default formatter for log messages.
class Formatter
def call severity, time, progname, msg
clean msg
end
private
##
# Clean up messages so they're nice and pretty.
def clean message
message = message.to_s.strip
message.gsub!(/\e\[[0-9;]*m/, '') # remove useless ansi color codes
return message
end
end
##
# The version of Syslog::Logger you are using.
VERSION = '2.1.0'
##
# Maps Logger warning types to syslog(3) warning types.
#
# Messages from Ruby applications are not considered as critical as messages
# from other system daemons using syslog(3), so most messages are reduced by
# one level. For example, a fatal message for Ruby's Logger is considered
# an error for syslog(3).
LEVEL_MAP = {
::Logger::UNKNOWN => Syslog::LOG_ALERT,
::Logger::FATAL => Syslog::LOG_ERR,
::Logger::ERROR => Syslog::LOG_WARNING,
::Logger::WARN => Syslog::LOG_NOTICE,
::Logger::INFO => Syslog::LOG_INFO,
::Logger::DEBUG => Syslog::LOG_DEBUG,
}
##
# Returns the internal Syslog object that is initialized when the
# first instance is created.
def self.syslog
@@syslog
end
##
# Specifies the internal Syslog object to be used.
def self.syslog= syslog
@@syslog = syslog
end
##
# Builds a methods for level +meth+.
def self.make_methods meth
level = ::Logger.const_get(meth.upcase)
eval <<-EOM, nil, __FILE__, __LINE__ + 1
def #{meth}(message = nil, &block)
add(#{level}, message, &block)
end
def #{meth}?
level <= #{level}
end
EOM
end
##
# :method: unknown
#
# Logs a +message+ at the unknown (syslog alert) log level, or logs the
# message returned from the block.
##
# :method: fatal
#
# Logs a +message+ at the fatal (syslog err) log level, or logs the message
# returned from the block.
##
# :method: error
#
# Logs a +message+ at the error (syslog warning) log level, or logs the
# message returned from the block.
##
# :method: warn
#
# Logs a +message+ at the warn (syslog notice) log level, or logs the
# message returned from the block.
##
# :method: info
#
# Logs a +message+ at the info (syslog info) log level, or logs the message
# returned from the block.
##
# :method: debug
#
# Logs a +message+ at the debug (syslog debug) log level, or logs the
# message returned from the block.
Logger::Severity::constants.each do |severity|
make_methods severity.downcase
end
##
# Log level for Logger compatibility.
attr_accessor :level
# Logging formatter, as a +Proc+ that will take four arguments and
# return the formatted message. The arguments are:
#
# +severity+:: The Severity of the log message.
# +time+:: A Time instance representing when the message was logged.
# +progname+:: The #progname configured, or passed to the logger method.
# +msg+:: The _Object_ the user passed to the log message; not necessarily a
# String.
#
# The block should return an Object that can be written to the logging
# device via +write+. The default formatter is used when no formatter is
# set.
attr_accessor :formatter
##
# The facility argument is used to specify what type of program is logging the message.
attr_accessor :facility
##
# Fills in variables for Logger compatibility. If this is the first
# instance of Syslog::Logger, +program_name+ may be set to change the logged
# program name. The +facility+ may be set to specify the facility level which will be used.
#
# Due to the way syslog works, only one program name may be chosen.
def initialize program_name = 'ruby', facility = nil
@level = ::Logger::DEBUG
@formatter = Formatter.new
@@syslog ||= Syslog.open(program_name)
@facility = (facility || @@syslog.facility)
end
##
# Almost duplicates Logger#add. +progname+ is ignored.
def add severity, message = nil, progname = nil, &block
severity ||= ::Logger::UNKNOWN
level <= severity and
@@syslog.log( (LEVEL_MAP[severity] | @facility), '%s', formatter.call(severity, Time.now, progname, (message || block.call)) )
true
end
end
share/ruby/cgi/util.rb 0000644 00000020105 15173517734 0010706 0 ustar 00 # frozen_string_literal: true
class CGI
module Util; end
include Util
extend Util
end
module CGI::Util
@@accept_charset = Encoding::UTF_8 unless defined?(@@accept_charset)
# 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)
encoding = string.encoding
buffer = string.b
buffer.gsub!(/([^ a-zA-Z0-9_.\-~]+)/) do |m|
'%' + m.unpack('H2' * m.bytesize).join('%').upcase
end
buffer.tr!(' ', '+')
buffer.force_encoding(encoding)
end
# 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, encoding = @@accept_charset)
str = string.tr('+', ' ')
str = str.b
str.gsub!(/((?:%[0-9a-fA-F]{2})+)/) do |m|
[m.delete('%')].pack('H*')
end
str.force_encoding(encoding)
str.valid_encoding? ? str : str.force_encoding(string.encoding)
end
# 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)
encoding = string.encoding
buffer = string.b
buffer.gsub!(/([^a-zA-Z0-9_.\-~]+)/) do |m|
'%' + m.unpack('H2' * m.bytesize).join('%').upcase
end
buffer.force_encoding(encoding)
end
alias escape_uri_component escapeURIComponent
# URL-decode a string following RFC 3986 with encoding(optional).
# string = CGI.unescapeURIComponent("%27Stop%21%27+said%20Fred")
# # => "'Stop!'+said Fred"
def unescapeURIComponent(string, encoding = @@accept_charset)
str = string.b
str.gsub!(/((?:%[0-9a-fA-F]{2})+)/) do |m|
[m.delete('%')].pack('H*')
end
str.force_encoding(encoding)
str.valid_encoding? ? str : str.force_encoding(string.encoding)
end
alias unescape_uri_component unescapeURIComponent
# The set of special characters and their escaped values
TABLE_FOR_ESCAPE_HTML__ = {
"'" => ''',
'&' => '&',
'"' => '"',
'<' => '<',
'>' => '>',
}
# Escape special characters in HTML, namely '&\"<>
# CGI.escapeHTML('Usage: foo "bar" <baz>')
# # => "Usage: foo "bar" <baz>"
def escapeHTML(string)
enc = string.encoding
unless enc.ascii_compatible?
if enc.dummy?
origenc = enc
enc = Encoding::Converter.asciicompat_encoding(enc)
string = enc ? string.encode(enc) : string.b
end
table = Hash[TABLE_FOR_ESCAPE_HTML__.map {|pair|pair.map {|s|s.encode(enc)}}]
string = string.gsub(/#{"['&\"<>]".encode(enc)}/, table)
string.encode!(origenc) if origenc
string
else
string = string.b
string.gsub!(/['&\"<>]/, TABLE_FOR_ESCAPE_HTML__)
string.force_encoding(enc)
end
end
# TruffleRuby runs the pure-Ruby variant faster, do not use the C extension there
unless RUBY_ENGINE == 'truffleruby'
begin
require 'cgi/escape'
rescue LoadError
end
end
# Unescape a string that has been HTML-escaped
# CGI.unescapeHTML("Usage: foo "bar" <baz>")
# # => "Usage: foo \"bar\" <baz>"
def unescapeHTML(string)
enc = string.encoding
unless enc.ascii_compatible?
if enc.dummy?
origenc = enc
enc = Encoding::Converter.asciicompat_encoding(enc)
string = enc ? string.encode(enc) : string.b
end
string = string.gsub(Regexp.new('&(apos|amp|quot|gt|lt|#[0-9]+|#x[0-9A-Fa-f]+);'.encode(enc))) do
case $1.encode(Encoding::US_ASCII)
when 'apos' then "'".encode(enc)
when 'amp' then '&'.encode(enc)
when 'quot' then '"'.encode(enc)
when 'gt' then '>'.encode(enc)
when 'lt' then '<'.encode(enc)
when /\A#0*(\d+)\z/ then $1.to_i.chr(enc)
when /\A#x([0-9a-f]+)\z/i then $1.hex.chr(enc)
end
end
string.encode!(origenc) if origenc
return string
end
return string unless string.include? '&'
charlimit = case enc
when Encoding::UTF_8; 0x10ffff
when Encoding::ISO_8859_1; 256
else 128
end
string = string.b
string.gsub!(/&(apos|amp|quot|gt|lt|\#[0-9]+|\#[xX][0-9A-Fa-f]+);/) do
match = $1.dup
case match
when 'apos' then "'"
when 'amp' then '&'
when 'quot' then '"'
when 'gt' then '>'
when 'lt' then '<'
when /\A#0*(\d+)\z/
n = $1.to_i
if n < charlimit
n.chr(enc)
else
"&##{$1};"
end
when /\A#x([0-9a-f]+)\z/i
n = $1.hex
if n < charlimit
n.chr(enc)
else
"&#x#{$1};"
end
else
"&#{match};"
end
end
string.force_encoding enc
end
# Synonym for CGI.escapeHTML(str)
alias escape_html escapeHTML
# Synonym for CGI.unescapeHTML(str)
alias unescape_html unescapeHTML
# 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><A HREF="url"></A>"
#
# print CGI.escapeElement('<BR><A HREF="url"></A>', ["A", "IMG"])
# # "<BR><A HREF="url"></A>"
def escapeElement(string, *elements)
elements = elements[0] if elements[0].kind_of?(Array)
unless elements.empty?
string.gsub(/<\/?(?:#{elements.join("|")})\b[^<>]*+>?/im) do
CGI.escapeHTML($&)
end
else
string
end
end
# Undo escaping such as that done by CGI.escapeElement()
#
# print CGI.unescapeElement(
# CGI.escapeHTML('<BR><A HREF="url"></A>'), "A", "IMG")
# # "<BR><A HREF="url"></A>"
#
# print CGI.unescapeElement(
# CGI.escapeHTML('<BR><A HREF="url"></A>'), ["A", "IMG"])
# # "<BR><A HREF="url"></A>"
def unescapeElement(string, *elements)
elements = elements[0] if elements[0].kind_of?(Array)
unless elements.empty?
string.gsub(/<\/?(?:#{elements.join("|")})\b(?>[^&]+|&(?![gl]t;)\w+;)*(?:>)?/im) do
unescapeHTML($&)
end
else
string
end
end
# Synonym for CGI.escapeElement(str)
alias escape_element escapeElement
# Synonym for CGI.unescapeElement(str)
alias unescape_element unescapeElement
# Format a +Time+ object as a String using the format specified by RFC 1123.
#
# CGI.rfc1123_date(Time.now)
# # Sat, 01 Jan 2000 00:00:00 GMT
def rfc1123_date(time)
time.getgm.strftime("%a, %d %b %Y %T GMT")
end
# Prettify (indent) an HTML string.
#
# +string+ is the HTML string to indent. +shift+ is the indentation
# unit to use; it defaults to two spaces.
#
# print CGI.pretty("<HTML><BODY></BODY></HTML>")
# # <HTML>
# # <BODY>
# # </BODY>
# # </HTML>
#
# print CGI.pretty("<HTML><BODY></BODY></HTML>", "\t")
# # <HTML>
# # <BODY>
# # </BODY>
# # </HTML>
#
def pretty(string, shift = " ")
lines = string.gsub(/(?!\A)<.*?>/m, "\n\\0").gsub(/<.*?>(?!\n)/m, "\\0\n")
end_pos = 0
while end_pos = lines.index(/^<\/(\w+)/, end_pos)
element = $1.dup
start_pos = lines.rindex(/^\s*<#{element}/i, end_pos)
lines[start_pos ... end_pos] = "__" + lines[start_pos ... end_pos].gsub(/\n(?!\z)/, "\n" + shift) + "__"
end
lines.gsub(/^((?:#{Regexp::quote(shift)})*)__(?=<\/?\w)/, '\1')
end
alias h escapeHTML
end
share/ruby/cgi/cookie.rb 0000644 00000015116 15173517734 0011210 0 ustar 00 # frozen_string_literal: true
require_relative 'util'
class CGI
# Class representing an HTTP cookie.
#
# In addition to its specific fields and methods, a Cookie instance
# is a delegator to the array of its values.
#
# See RFC 2965.
#
# == Examples of use
# cookie1 = CGI::Cookie.new("name", "value1", "value2", ...)
# cookie1 = CGI::Cookie.new("name" => "name", "value" => "value")
# cookie1 = CGI::Cookie.new('name' => 'name',
# 'value' => ['value1', 'value2', ...],
# 'path' => 'path', # optional
# 'domain' => 'domain', # optional
# 'expires' => Time.now, # optional
# 'secure' => true, # optional
# 'httponly' => true # optional
# )
#
# cgi.out("cookie" => [cookie1, cookie2]) { "string" }
#
# name = cookie1.name
# values = cookie1.value
# path = cookie1.path
# domain = cookie1.domain
# expires = cookie1.expires
# secure = cookie1.secure
# httponly = cookie1.httponly
#
# cookie1.name = 'name'
# cookie1.value = ['value1', 'value2', ...]
# cookie1.path = 'path'
# cookie1.domain = 'domain'
# cookie1.expires = Time.now + 30
# cookie1.secure = true
# cookie1.httponly = true
class Cookie < Array
@@accept_charset="UTF-8" unless defined?(@@accept_charset)
TOKEN_RE = %r"\A[[!-~]&&[^()<>@,;:\\\"/?=\[\]{}]]+\z"
PATH_VALUE_RE = %r"\A[[ -~]&&[^;]]*\z"
DOMAIN_VALUE_RE = %r"\A\.?(?<label>(?!-)[-A-Za-z0-9]+(?<!-))(?:\.\g<label>)*\z"
# Create a new CGI::Cookie object.
#
# :call-seq:
# Cookie.new(name_string,*value)
# Cookie.new(options_hash)
#
# +name_string+::
# The name of the cookie; in this form, there is no #domain or
# #expiration. The #path is gleaned from the +SCRIPT_NAME+ environment
# variable, and #secure is false.
# <tt>*value</tt>::
# value or list of values of the cookie
# +options_hash+::
# A Hash of options to initialize this Cookie. Possible options are:
#
# name:: the name of the cookie. Required.
# value:: the cookie's value or list of values.
# path:: the path for which this cookie applies. Defaults to
# the value of the +SCRIPT_NAME+ environment variable.
# domain:: the domain for which this cookie applies.
# expires:: the time at which this cookie expires, as a +Time+ object.
# secure:: whether this cookie is a secure cookie or not (default to
# false). Secure cookies are only transmitted to HTTPS
# servers.
# httponly:: whether this cookie is a HttpOnly cookie or not (default to
# false). HttpOnly cookies are not available to javascript.
#
# These keywords correspond to attributes of the cookie object.
def initialize(name = "", *value)
@domain = nil
@expires = nil
if name.kind_of?(String)
self.name = name
self.path = (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
@secure = false
@httponly = false
return super(value)
end
options = name
unless options.has_key?("name")
raise ArgumentError, "`name' required"
end
self.name = options["name"]
value = Array(options["value"])
# simple support for IE
self.path = options["path"] || (%r|\A(.*/)| =~ ENV["SCRIPT_NAME"] ? $1 : "")
self.domain = options["domain"]
@expires = options["expires"]
@secure = options["secure"] == true
@httponly = options["httponly"] == true
super(value)
end
# Name of this cookie, as a +String+
attr_reader :name
# Set name of this cookie
def name=(str)
if str and !TOKEN_RE.match?(str)
raise ArgumentError, "invalid name: #{str.dump}"
end
@name = str
end
# Path for which this cookie applies, as a +String+
attr_reader :path
# Set path for which this cookie applies
def path=(str)
if str and !PATH_VALUE_RE.match?(str)
raise ArgumentError, "invalid path: #{str.dump}"
end
@path = str
end
# Domain for which this cookie applies, as a +String+
attr_reader :domain
# Set domain for which this cookie applies
def domain=(str)
if str and ((str = str.b).bytesize > 255 or !DOMAIN_VALUE_RE.match?(str))
raise ArgumentError, "invalid domain: #{str.dump}"
end
@domain = str
end
# Time at which this cookie expires, as a +Time+
attr_accessor :expires
# True if this cookie is secure; false otherwise
attr_reader :secure
# True if this cookie is httponly; false otherwise
attr_reader :httponly
# Returns the value or list of values for this cookie.
def value
self
end
# Replaces the value of this cookie with a new value or list of values.
def value=(val)
replace(Array(val))
end
# Set whether the Cookie is a secure cookie or not.
#
# +val+ must be a boolean.
def secure=(val)
@secure = val if val == true or val == false
@secure
end
# Set whether the Cookie is a httponly cookie or not.
#
# +val+ must be a boolean.
def httponly=(val)
@httponly = !!val
end
# Convert the Cookie to its string representation.
def to_s
val = collect{|v| CGI.escape(v) }.join("&")
buf = "#{@name}=#{val}".dup
buf << "; domain=#{@domain}" if @domain
buf << "; path=#{@path}" if @path
buf << "; expires=#{CGI.rfc1123_date(@expires)}" if @expires
buf << "; secure" if @secure
buf << "; HttpOnly" if @httponly
buf
end
# Parse a raw cookie string into a hash of cookie-name=>Cookie
# pairs.
#
# cookies = CGI::Cookie.parse("raw_cookie_string")
# # { "name1" => cookie1, "name2" => cookie2, ... }
#
def self.parse(raw_cookie)
cookies = Hash.new([])
return cookies unless raw_cookie
raw_cookie.split(/;\s?/).each do |pairs|
name, values = pairs.split('=',2)
next unless name and values
values ||= ""
values = values.split('&').collect{|v| CGI.unescape(v,@@accept_charset) }
if cookies.has_key?(name)
cookies[name].concat(values)
else
cookies[name] = Cookie.new(name, *values)
end
end
cookies
end
# A summary of cookie string.
def inspect
"#<CGI::Cookie: #{self.to_s.inspect}>"
end
end # class Cookie
end
share/ruby/cgi/html.rb 0000644 00000104217 15173517734 0010704 0 ustar 00 # frozen_string_literal: true
class CGI
# Base module for HTML-generation mixins.
#
# Provides methods for code generation for tags following
# the various DTD element types.
module TagMaker # :nodoc:
# Generate code for an element with required start and end tags.
#
# - -
def nn_element(element, attributes = {})
s = nOE_element(element, attributes)
if block_given?
s << yield.to_s
end
s << "</#{element.upcase}>"
end
def nn_element_def(attributes = {}, &block)
nn_element(__callee__, attributes, &block)
end
# Generate code for an empty element.
#
# - O EMPTY
def nOE_element(element, attributes = {})
attributes={attributes=>nil} if attributes.kind_of?(String)
s = "<#{element.upcase}".dup
attributes.each do|name, value|
next unless value
s << " "
s << CGI.escapeHTML(name.to_s)
if value != true
s << '="'
s << CGI.escapeHTML(value.to_s)
s << '"'
end
end
s << ">"
end
def nOE_element_def(attributes = {}, &block)
nOE_element(__callee__, attributes, &block)
end
# Generate code for an element for which the end (and possibly the
# start) tag is optional.
#
# O O or - O
def nO_element(element, attributes = {})
s = nOE_element(element, attributes)
if block_given?
s << yield.to_s
s << "</#{element.upcase}>"
end
s
end
def nO_element_def(attributes = {}, &block)
nO_element(__callee__, attributes, &block)
end
end # TagMaker
# Mixin module providing HTML generation methods.
#
# For example,
# cgi.a("http://www.example.com") { "Example" }
# # => "<A HREF=\"http://www.example.com\">Example</A>"
#
# Modules Html3, Html4, etc., contain more basic HTML-generation methods
# (+#title+, +#h1+, etc.).
#
# See class CGI for a detailed example.
#
module HtmlExtension
# Generate an Anchor element as a string.
#
# +href+ can either be a string, giving the URL
# for the HREF attribute, or it can be a hash of
# the element's attributes.
#
# The body of the element is the string returned by the no-argument
# block passed in.
#
# a("http://www.example.com") { "Example" }
# # => "<A HREF=\"http://www.example.com\">Example</A>"
#
# a("HREF" => "http://www.example.com", "TARGET" => "_top") { "Example" }
# # => "<A HREF=\"http://www.example.com\" TARGET=\"_top\">Example</A>"
#
def a(href = "") # :yield:
attributes = if href.kind_of?(String)
{ "HREF" => href }
else
href
end
super(attributes)
end
# Generate a Document Base URI element as a String.
#
# +href+ can either by a string, giving the base URL for the HREF
# attribute, or it can be a has of the element's attributes.
#
# The passed-in no-argument block is ignored.
#
# base("http://www.example.com/cgi")
# # => "<BASE HREF=\"http://www.example.com/cgi\">"
def base(href = "") # :yield:
attributes = if href.kind_of?(String)
{ "HREF" => href }
else
href
end
super(attributes)
end
# Generate a BlockQuote element as a string.
#
# +cite+ can either be a string, give the URI for the source of
# the quoted text, or a hash, giving all attributes of the element,
# or it can be omitted, in which case the element has no attributes.
#
# The body is provided by the passed-in no-argument block
#
# blockquote("http://www.example.com/quotes/foo.html") { "Foo!" }
# #=> "<BLOCKQUOTE CITE=\"http://www.example.com/quotes/foo.html\">Foo!</BLOCKQUOTE>
def blockquote(cite = {}) # :yield:
attributes = if cite.kind_of?(String)
{ "CITE" => cite }
else
cite
end
super(attributes)
end
# Generate a Table Caption element as a string.
#
# +align+ can be a string, giving the alignment of the caption
# (one of top, bottom, left, or right). It can be a hash of
# all the attributes of the element. Or it can be omitted.
#
# The body of the element is provided by the passed-in no-argument block.
#
# caption("left") { "Capital Cities" }
# # => <CAPTION ALIGN=\"left\">Capital Cities</CAPTION>
def caption(align = {}) # :yield:
attributes = if align.kind_of?(String)
{ "ALIGN" => align }
else
align
end
super(attributes)
end
# Generate a Checkbox Input element as a string.
#
# The attributes of the element can be specified as three arguments,
# +name+, +value+, and +checked+. +checked+ is a boolean value;
# if true, the CHECKED attribute will be included in the element.
#
# Alternatively, the attributes can be specified as a hash.
#
# checkbox("name")
# # = checkbox("NAME" => "name")
#
# checkbox("name", "value")
# # = checkbox("NAME" => "name", "VALUE" => "value")
#
# checkbox("name", "value", true)
# # = checkbox("NAME" => "name", "VALUE" => "value", "CHECKED" => true)
def checkbox(name = "", value = nil, checked = nil)
attributes = if name.kind_of?(String)
{ "TYPE" => "checkbox", "NAME" => name,
"VALUE" => value, "CHECKED" => checked }
else
name["TYPE"] = "checkbox"
name
end
input(attributes)
end
# Generate a sequence of checkbox elements, as a String.
#
# The checkboxes will all have the same +name+ attribute.
# Each checkbox is followed by a label.
# There will be one checkbox for each value. Each value
# can be specified as a String, which will be used both
# as the value of the VALUE attribute and as the label
# for that checkbox. A single-element array has the
# same effect.
#
# Each value can also be specified as a three-element array.
# The first element is the VALUE attribute; the second is the
# label; and the third is a boolean specifying whether this
# checkbox is CHECKED.
#
# Each value can also be specified as a two-element
# array, by omitting either the value element (defaults
# to the same as the label), or the boolean checked element
# (defaults to false).
#
# checkbox_group("name", "foo", "bar", "baz")
# # <INPUT TYPE="checkbox" NAME="name" VALUE="foo">foo
# # <INPUT TYPE="checkbox" NAME="name" VALUE="bar">bar
# # <INPUT TYPE="checkbox" NAME="name" VALUE="baz">baz
#
# checkbox_group("name", ["foo"], ["bar", true], "baz")
# # <INPUT TYPE="checkbox" NAME="name" VALUE="foo">foo
# # <INPUT TYPE="checkbox" CHECKED NAME="name" VALUE="bar">bar
# # <INPUT TYPE="checkbox" NAME="name" VALUE="baz">baz
#
# checkbox_group("name", ["1", "Foo"], ["2", "Bar", true], "Baz")
# # <INPUT TYPE="checkbox" NAME="name" VALUE="1">Foo
# # <INPUT TYPE="checkbox" CHECKED NAME="name" VALUE="2">Bar
# # <INPUT TYPE="checkbox" NAME="name" VALUE="Baz">Baz
#
# checkbox_group("NAME" => "name",
# "VALUES" => ["foo", "bar", "baz"])
#
# checkbox_group("NAME" => "name",
# "VALUES" => [["foo"], ["bar", true], "baz"])
#
# checkbox_group("NAME" => "name",
# "VALUES" => [["1", "Foo"], ["2", "Bar", true], "Baz"])
def checkbox_group(name = "", *values)
if name.kind_of?(Hash)
values = name["VALUES"]
name = name["NAME"]
end
values.collect{|value|
if value.kind_of?(String)
checkbox(name, value) + value
else
if value[-1] == true || value[-1] == false
checkbox(name, value[0], value[-1]) +
value[-2]
else
checkbox(name, value[0]) +
value[-1]
end
end
}.join
end
# Generate an File Upload Input element as a string.
#
# The attributes of the element can be specified as three arguments,
# +name+, +size+, and +maxlength+. +maxlength+ is the maximum length
# of the file's _name_, not of the file's _contents_.
#
# Alternatively, the attributes can be specified as a hash.
#
# See #multipart_form() for forms that include file uploads.
#
# file_field("name")
# # <INPUT TYPE="file" NAME="name" SIZE="20">
#
# file_field("name", 40)
# # <INPUT TYPE="file" NAME="name" SIZE="40">
#
# file_field("name", 40, 100)
# # <INPUT TYPE="file" NAME="name" SIZE="40" MAXLENGTH="100">
#
# file_field("NAME" => "name", "SIZE" => 40)
# # <INPUT TYPE="file" NAME="name" SIZE="40">
def file_field(name = "", size = 20, maxlength = nil)
attributes = if name.kind_of?(String)
{ "TYPE" => "file", "NAME" => name,
"SIZE" => size.to_s }
else
name["TYPE"] = "file"
name
end
attributes["MAXLENGTH"] = maxlength.to_s if maxlength
input(attributes)
end
# Generate a Form element as a string.
#
# +method+ should be either "get" or "post", and defaults to the latter.
# +action+ defaults to the current CGI script name. +enctype+
# defaults to "application/x-www-form-urlencoded".
#
# Alternatively, the attributes can be specified as a hash.
#
# See also #multipart_form() for forms that include file uploads.
#
# form{ "string" }
# # <FORM METHOD="post" ENCTYPE="application/x-www-form-urlencoded">string</FORM>
#
# form("get") { "string" }
# # <FORM METHOD="get" ENCTYPE="application/x-www-form-urlencoded">string</FORM>
#
# form("get", "url") { "string" }
# # <FORM METHOD="get" ACTION="url" ENCTYPE="application/x-www-form-urlencoded">string</FORM>
#
# form("METHOD" => "post", "ENCTYPE" => "enctype") { "string" }
# # <FORM METHOD="post" ENCTYPE="enctype">string</FORM>
def form(method = "post", action = script_name, enctype = "application/x-www-form-urlencoded")
attributes = if method.kind_of?(String)
{ "METHOD" => method, "ACTION" => action,
"ENCTYPE" => enctype }
else
unless method.has_key?("METHOD")
method["METHOD"] = "post"
end
unless method.has_key?("ENCTYPE")
method["ENCTYPE"] = enctype
end
method
end
if block_given?
body = yield
else
body = ""
end
if @output_hidden
body << @output_hidden.collect{|k,v|
"<INPUT TYPE=\"HIDDEN\" NAME=\"#{k}\" VALUE=\"#{v}\">"
}.join
end
super(attributes){body}
end
# Generate a Hidden Input element as a string.
#
# The attributes of the element can be specified as two arguments,
# +name+ and +value+.
#
# Alternatively, the attributes can be specified as a hash.
#
# hidden("name")
# # <INPUT TYPE="hidden" NAME="name">
#
# hidden("name", "value")
# # <INPUT TYPE="hidden" NAME="name" VALUE="value">
#
# hidden("NAME" => "name", "VALUE" => "reset", "ID" => "foo")
# # <INPUT TYPE="hidden" NAME="name" VALUE="value" ID="foo">
def hidden(name = "", value = nil)
attributes = if name.kind_of?(String)
{ "TYPE" => "hidden", "NAME" => name, "VALUE" => value }
else
name["TYPE"] = "hidden"
name
end
input(attributes)
end
# Generate a top-level HTML element as a string.
#
# The attributes of the element are specified as a hash. The
# pseudo-attribute "PRETTY" can be used to specify that the generated
# HTML string should be indented. "PRETTY" can also be specified as
# a string as the sole argument to this method. The pseudo-attribute
# "DOCTYPE", if given, is used as the leading DOCTYPE SGML tag; it
# should include the entire text of this tag, including angle brackets.
#
# The body of the html element is supplied as a block.
#
# html{ "string" }
# # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><HTML>string</HTML>
#
# html("LANG" => "ja") { "string" }
# # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><HTML LANG="ja">string</HTML>
#
# html("DOCTYPE" => false) { "string" }
# # <HTML>string</HTML>
#
# html("DOCTYPE" => '<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">') { "string" }
# # <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN"><HTML>string</HTML>
#
# html("PRETTY" => " ") { "<BODY></BODY>" }
# # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
# # <HTML>
# # <BODY>
# # </BODY>
# # </HTML>
#
# html("PRETTY" => "\t") { "<BODY></BODY>" }
# # <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
# # <HTML>
# # <BODY>
# # </BODY>
# # </HTML>
#
# html("PRETTY") { "<BODY></BODY>" }
# # = html("PRETTY" => " ") { "<BODY></BODY>" }
#
# html(if $VERBOSE then "PRETTY" end) { "HTML string" }
#
def html(attributes = {}) # :yield:
if nil == attributes
attributes = {}
elsif "PRETTY" == attributes
attributes = { "PRETTY" => true }
end
pretty = attributes.delete("PRETTY")
pretty = " " if true == pretty
buf = "".dup
if attributes.has_key?("DOCTYPE")
if attributes["DOCTYPE"]
buf << attributes.delete("DOCTYPE")
else
attributes.delete("DOCTYPE")
end
else
buf << doctype
end
buf << super(attributes)
if pretty
CGI.pretty(buf, pretty)
else
buf
end
end
# Generate an Image Button Input element as a string.
#
# +src+ is the URL of the image to use for the button. +name+
# is the input name. +alt+ is the alternative text for the image.
#
# Alternatively, the attributes can be specified as a hash.
#
# image_button("url")
# # <INPUT TYPE="image" SRC="url">
#
# image_button("url", "name", "string")
# # <INPUT TYPE="image" SRC="url" NAME="name" ALT="string">
#
# image_button("SRC" => "url", "ALT" => "string")
# # <INPUT TYPE="image" SRC="url" ALT="string">
def image_button(src = "", name = nil, alt = nil)
attributes = if src.kind_of?(String)
{ "TYPE" => "image", "SRC" => src, "NAME" => name,
"ALT" => alt }
else
src["TYPE"] = "image"
src["SRC"] ||= ""
src
end
input(attributes)
end
# Generate an Image element as a string.
#
# +src+ is the URL of the image. +alt+ is the alternative text for
# the image. +width+ is the width of the image, and +height+ is
# its height.
#
# Alternatively, the attributes can be specified as a hash.
#
# img("src", "alt", 100, 50)
# # <IMG SRC="src" ALT="alt" WIDTH="100" HEIGHT="50">
#
# img("SRC" => "src", "ALT" => "alt", "WIDTH" => 100, "HEIGHT" => 50)
# # <IMG SRC="src" ALT="alt" WIDTH="100" HEIGHT="50">
def img(src = "", alt = "", width = nil, height = nil)
attributes = if src.kind_of?(String)
{ "SRC" => src, "ALT" => alt }
else
src
end
attributes["WIDTH"] = width.to_s if width
attributes["HEIGHT"] = height.to_s if height
super(attributes)
end
# Generate a Form element with multipart encoding as a String.
#
# Multipart encoding is used for forms that include file uploads.
#
# +action+ is the action to perform. +enctype+ is the encoding
# type, which defaults to "multipart/form-data".
#
# Alternatively, the attributes can be specified as a hash.
#
# multipart_form{ "string" }
# # <FORM METHOD="post" ENCTYPE="multipart/form-data">string</FORM>
#
# multipart_form("url") { "string" }
# # <FORM METHOD="post" ACTION="url" ENCTYPE="multipart/form-data">string</FORM>
def multipart_form(action = nil, enctype = "multipart/form-data")
attributes = if action == nil
{ "METHOD" => "post", "ENCTYPE" => enctype }
elsif action.kind_of?(String)
{ "METHOD" => "post", "ACTION" => action,
"ENCTYPE" => enctype }
else
unless action.has_key?("METHOD")
action["METHOD"] = "post"
end
unless action.has_key?("ENCTYPE")
action["ENCTYPE"] = enctype
end
action
end
if block_given?
form(attributes){ yield }
else
form(attributes)
end
end
# Generate a Password Input element as a string.
#
# +name+ is the name of the input field. +value+ is its default
# value. +size+ is the size of the input field display. +maxlength+
# is the maximum length of the inputted password.
#
# Alternatively, attributes can be specified as a hash.
#
# password_field("name")
# # <INPUT TYPE="password" NAME="name" SIZE="40">
#
# password_field("name", "value")
# # <INPUT TYPE="password" NAME="name" VALUE="value" SIZE="40">
#
# password_field("password", "value", 80, 200)
# # <INPUT TYPE="password" NAME="name" VALUE="value" SIZE="80" MAXLENGTH="200">
#
# password_field("NAME" => "name", "VALUE" => "value")
# # <INPUT TYPE="password" NAME="name" VALUE="value">
def password_field(name = "", value = nil, size = 40, maxlength = nil)
attributes = if name.kind_of?(String)
{ "TYPE" => "password", "NAME" => name,
"VALUE" => value, "SIZE" => size.to_s }
else
name["TYPE"] = "password"
name
end
attributes["MAXLENGTH"] = maxlength.to_s if maxlength
input(attributes)
end
# Generate a Select element as a string.
#
# +name+ is the name of the element. The +values+ are the options that
# can be selected from the Select menu. Each value can be a String or
# a one, two, or three-element Array. If a String or a one-element
# Array, this is both the value of that option and the text displayed for
# it. If a three-element Array, the elements are the option value, displayed
# text, and a boolean value specifying whether this option starts as selected.
# The two-element version omits either the option value (defaults to the same
# as the display text) or the boolean selected specifier (defaults to false).
#
# The attributes and options can also be specified as a hash. In this
# case, options are specified as an array of values as described above,
# with the hash key of "VALUES".
#
# popup_menu("name", "foo", "bar", "baz")
# # <SELECT NAME="name">
# # <OPTION VALUE="foo">foo</OPTION>
# # <OPTION VALUE="bar">bar</OPTION>
# # <OPTION VALUE="baz">baz</OPTION>
# # </SELECT>
#
# popup_menu("name", ["foo"], ["bar", true], "baz")
# # <SELECT NAME="name">
# # <OPTION VALUE="foo">foo</OPTION>
# # <OPTION VALUE="bar" SELECTED>bar</OPTION>
# # <OPTION VALUE="baz">baz</OPTION>
# # </SELECT>
#
# popup_menu("name", ["1", "Foo"], ["2", "Bar", true], "Baz")
# # <SELECT NAME="name">
# # <OPTION VALUE="1">Foo</OPTION>
# # <OPTION SELECTED VALUE="2">Bar</OPTION>
# # <OPTION VALUE="Baz">Baz</OPTION>
# # </SELECT>
#
# popup_menu("NAME" => "name", "SIZE" => 2, "MULTIPLE" => true,
# "VALUES" => [["1", "Foo"], ["2", "Bar", true], "Baz"])
# # <SELECT NAME="name" MULTIPLE SIZE="2">
# # <OPTION VALUE="1">Foo</OPTION>
# # <OPTION SELECTED VALUE="2">Bar</OPTION>
# # <OPTION VALUE="Baz">Baz</OPTION>
# # </SELECT>
def popup_menu(name = "", *values)
if name.kind_of?(Hash)
values = name["VALUES"]
size = name["SIZE"].to_s if name["SIZE"]
multiple = name["MULTIPLE"]
name = name["NAME"]
else
size = nil
multiple = nil
end
select({ "NAME" => name, "SIZE" => size,
"MULTIPLE" => multiple }){
values.collect{|value|
if value.kind_of?(String)
option({ "VALUE" => value }){ value }
else
if value[value.size - 1] == true
option({ "VALUE" => value[0], "SELECTED" => true }){
value[value.size - 2]
}
else
option({ "VALUE" => value[0] }){
value[value.size - 1]
}
end
end
}.join
}
end
# Generates a radio-button Input element.
#
# +name+ is the name of the input field. +value+ is the value of
# the field if checked. +checked+ specifies whether the field
# starts off checked.
#
# Alternatively, the attributes can be specified as a hash.
#
# radio_button("name", "value")
# # <INPUT TYPE="radio" NAME="name" VALUE="value">
#
# radio_button("name", "value", true)
# # <INPUT TYPE="radio" NAME="name" VALUE="value" CHECKED>
#
# radio_button("NAME" => "name", "VALUE" => "value", "ID" => "foo")
# # <INPUT TYPE="radio" NAME="name" VALUE="value" ID="foo">
def radio_button(name = "", value = nil, checked = nil)
attributes = if name.kind_of?(String)
{ "TYPE" => "radio", "NAME" => name,
"VALUE" => value, "CHECKED" => checked }
else
name["TYPE"] = "radio"
name
end
input(attributes)
end
# Generate a sequence of radio button Input elements, as a String.
#
# This works the same as #checkbox_group(). However, it is not valid
# to have more than one radiobutton in a group checked.
#
# radio_group("name", "foo", "bar", "baz")
# # <INPUT TYPE="radio" NAME="name" VALUE="foo">foo
# # <INPUT TYPE="radio" NAME="name" VALUE="bar">bar
# # <INPUT TYPE="radio" NAME="name" VALUE="baz">baz
#
# radio_group("name", ["foo"], ["bar", true], "baz")
# # <INPUT TYPE="radio" NAME="name" VALUE="foo">foo
# # <INPUT TYPE="radio" CHECKED NAME="name" VALUE="bar">bar
# # <INPUT TYPE="radio" NAME="name" VALUE="baz">baz
#
# radio_group("name", ["1", "Foo"], ["2", "Bar", true], "Baz")
# # <INPUT TYPE="radio" NAME="name" VALUE="1">Foo
# # <INPUT TYPE="radio" CHECKED NAME="name" VALUE="2">Bar
# # <INPUT TYPE="radio" NAME="name" VALUE="Baz">Baz
#
# radio_group("NAME" => "name",
# "VALUES" => ["foo", "bar", "baz"])
#
# radio_group("NAME" => "name",
# "VALUES" => [["foo"], ["bar", true], "baz"])
#
# radio_group("NAME" => "name",
# "VALUES" => [["1", "Foo"], ["2", "Bar", true], "Baz"])
def radio_group(name = "", *values)
if name.kind_of?(Hash)
values = name["VALUES"]
name = name["NAME"]
end
values.collect{|value|
if value.kind_of?(String)
radio_button(name, value) + value
else
if value[-1] == true || value[-1] == false
radio_button(name, value[0], value[-1]) +
value[-2]
else
radio_button(name, value[0]) +
value[-1]
end
end
}.join
end
# Generate a reset button Input element, as a String.
#
# This resets the values on a form to their initial values. +value+
# is the text displayed on the button. +name+ is the name of this button.
#
# Alternatively, the attributes can be specified as a hash.
#
# reset
# # <INPUT TYPE="reset">
#
# reset("reset")
# # <INPUT TYPE="reset" VALUE="reset">
#
# reset("VALUE" => "reset", "ID" => "foo")
# # <INPUT TYPE="reset" VALUE="reset" ID="foo">
def reset(value = nil, name = nil)
attributes = if (not value) or value.kind_of?(String)
{ "TYPE" => "reset", "VALUE" => value, "NAME" => name }
else
value["TYPE"] = "reset"
value
end
input(attributes)
end
alias scrolling_list popup_menu
# Generate a submit button Input element, as a String.
#
# +value+ is the text to display on the button. +name+ is the name
# of the input.
#
# Alternatively, the attributes can be specified as a hash.
#
# submit
# # <INPUT TYPE="submit">
#
# submit("ok")
# # <INPUT TYPE="submit" VALUE="ok">
#
# submit("ok", "button1")
# # <INPUT TYPE="submit" VALUE="ok" NAME="button1">
#
# submit("VALUE" => "ok", "NAME" => "button1", "ID" => "foo")
# # <INPUT TYPE="submit" VALUE="ok" NAME="button1" ID="foo">
def submit(value = nil, name = nil)
attributes = if (not value) or value.kind_of?(String)
{ "TYPE" => "submit", "VALUE" => value, "NAME" => name }
else
value["TYPE"] = "submit"
value
end
input(attributes)
end
# Generate a text field Input element, as a String.
#
# +name+ is the name of the input field. +value+ is its initial
# value. +size+ is the size of the input area. +maxlength+
# is the maximum length of input accepted.
#
# Alternatively, the attributes can be specified as a hash.
#
# text_field("name")
# # <INPUT TYPE="text" NAME="name" SIZE="40">
#
# text_field("name", "value")
# # <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="40">
#
# text_field("name", "value", 80)
# # <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="80">
#
# text_field("name", "value", 80, 200)
# # <INPUT TYPE="text" NAME="name" VALUE="value" SIZE="80" MAXLENGTH="200">
#
# text_field("NAME" => "name", "VALUE" => "value")
# # <INPUT TYPE="text" NAME="name" VALUE="value">
def text_field(name = "", value = nil, size = 40, maxlength = nil)
attributes = if name.kind_of?(String)
{ "TYPE" => "text", "NAME" => name, "VALUE" => value,
"SIZE" => size.to_s }
else
name["TYPE"] = "text"
name
end
attributes["MAXLENGTH"] = maxlength.to_s if maxlength
input(attributes)
end
# Generate a TextArea element, as a String.
#
# +name+ is the name of the textarea. +cols+ is the number of
# columns and +rows+ is the number of rows in the display.
#
# Alternatively, the attributes can be specified as a hash.
#
# The body is provided by the passed-in no-argument block
#
# textarea("name")
# # = textarea("NAME" => "name", "COLS" => 70, "ROWS" => 10)
#
# textarea("name", 40, 5)
# # = textarea("NAME" => "name", "COLS" => 40, "ROWS" => 5)
def textarea(name = "", cols = 70, rows = 10) # :yield:
attributes = if name.kind_of?(String)
{ "NAME" => name, "COLS" => cols.to_s,
"ROWS" => rows.to_s }
else
name
end
super(attributes)
end
end # HtmlExtension
# Mixin module for HTML version 3 generation methods.
module Html3 # :nodoc:
include TagMaker
# The DOCTYPE declaration for this version of HTML
def doctype
%|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">|
end
instance_method(:nn_element_def).tap do |m|
# - -
for element in %w[ A TT I B U STRIKE BIG SMALL SUB SUP EM STRONG
DFN CODE SAMP KBD VAR CITE FONT ADDRESS DIV CENTER MAP
APPLET PRE XMP LISTING DL OL UL DIR MENU SELECT TABLE TITLE
STYLE SCRIPT H1 H2 H3 H4 H5 H6 TEXTAREA FORM BLOCKQUOTE
CAPTION ]
define_method(element.downcase, m)
end
end
instance_method(:nOE_element_def).tap do |m|
# - O EMPTY
for element in %w[ IMG BASE BASEFONT BR AREA LINK PARAM HR INPUT
ISINDEX META ]
define_method(element.downcase, m)
end
end
instance_method(:nO_element_def).tap do |m|
# O O or - O
for element in %w[ HTML HEAD BODY P PLAINTEXT DT DD LI OPTION TR
TH TD ]
define_method(element.downcase, m)
end
end
end # Html3
# Mixin module for HTML version 4 generation methods.
module Html4 # :nodoc:
include TagMaker
# The DOCTYPE declaration for this version of HTML
def doctype
%|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">|
end
# Initialize the HTML generation methods for this version.
# - -
instance_method(:nn_element_def).tap do |m|
for element in %w[ TT I B BIG SMALL EM STRONG DFN CODE SAMP KBD
VAR CITE ABBR ACRONYM SUB SUP SPAN BDO ADDRESS DIV MAP OBJECT
H1 H2 H3 H4 H5 H6 PRE Q INS DEL DL OL UL LABEL SELECT OPTGROUP
FIELDSET LEGEND BUTTON TABLE TITLE STYLE SCRIPT NOSCRIPT
TEXTAREA FORM A BLOCKQUOTE CAPTION ]
define_method(element.downcase, m)
end
end
# - O EMPTY
instance_method(:nOE_element_def).tap do |m|
for element in %w[ IMG BASE BR AREA LINK PARAM HR INPUT COL META ]
define_method(element.downcase, m)
end
end
# O O or - O
instance_method(:nO_element_def).tap do |m|
for element in %w[ HTML BODY P DT DD LI OPTION THEAD TFOOT TBODY
COLGROUP TR TH TD HEAD ]
define_method(element.downcase, m)
end
end
end # Html4
# Mixin module for HTML version 4 transitional generation methods.
module Html4Tr # :nodoc:
include TagMaker
# The DOCTYPE declaration for this version of HTML
def doctype
%|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">|
end
# Initialise the HTML generation methods for this version.
# - -
instance_method(:nn_element_def).tap do |m|
for element in %w[ TT I B U S STRIKE BIG SMALL EM STRONG DFN
CODE SAMP KBD VAR CITE ABBR ACRONYM FONT SUB SUP SPAN BDO
ADDRESS DIV CENTER MAP OBJECT APPLET H1 H2 H3 H4 H5 H6 PRE Q
INS DEL DL OL UL DIR MENU LABEL SELECT OPTGROUP FIELDSET
LEGEND BUTTON TABLE IFRAME NOFRAMES TITLE STYLE SCRIPT
NOSCRIPT TEXTAREA FORM A BLOCKQUOTE CAPTION ]
define_method(element.downcase, m)
end
end
# - O EMPTY
instance_method(:nOE_element_def).tap do |m|
for element in %w[ IMG BASE BASEFONT BR AREA LINK PARAM HR INPUT
COL ISINDEX META ]
define_method(element.downcase, m)
end
end
# O O or - O
instance_method(:nO_element_def).tap do |m|
for element in %w[ HTML BODY P DT DD LI OPTION THEAD TFOOT TBODY
COLGROUP TR TH TD HEAD ]
define_method(element.downcase, m)
end
end
end # Html4Tr
# Mixin module for generating HTML version 4 with framesets.
module Html4Fr # :nodoc:
include TagMaker
# The DOCTYPE declaration for this version of HTML
def doctype
%|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">|
end
# Initialise the HTML generation methods for this version.
# - -
instance_method(:nn_element_def).tap do |m|
for element in %w[ FRAMESET ]
define_method(element.downcase, m)
end
end
# - O EMPTY
instance_method(:nOE_element_def).tap do |m|
for element in %w[ FRAME ]
define_method(element.downcase, m)
end
end
end # Html4Fr
# Mixin module for HTML version 5 generation methods.
module Html5 # :nodoc:
include TagMaker
# The DOCTYPE declaration for this version of HTML
def doctype
%|<!DOCTYPE HTML>|
end
# Initialise the HTML generation methods for this version.
# - -
instance_method(:nn_element_def).tap do |m|
for element in %w[ SECTION NAV ARTICLE ASIDE HGROUP HEADER
FOOTER FIGURE FIGCAPTION S TIME U MARK RUBY BDI IFRAME
VIDEO AUDIO CANVAS DATALIST OUTPUT PROGRESS METER DETAILS
SUMMARY MENU DIALOG I B SMALL EM STRONG DFN CODE SAMP KBD
VAR CITE ABBR SUB SUP SPAN BDO ADDRESS DIV MAP OBJECT
H1 H2 H3 H4 H5 H6 PRE Q INS DEL DL OL UL LABEL SELECT
FIELDSET LEGEND BUTTON TABLE TITLE STYLE SCRIPT NOSCRIPT
TEXTAREA FORM A BLOCKQUOTE CAPTION ]
define_method(element.downcase, m)
end
end
# - O EMPTY
instance_method(:nOE_element_def).tap do |m|
for element in %w[ IMG BASE BR AREA LINK PARAM HR INPUT COL META
COMMAND EMBED KEYGEN SOURCE TRACK WBR ]
define_method(element.downcase, m)
end
end
# O O or - O
instance_method(:nO_element_def).tap do |m|
for element in %w[ HTML HEAD BODY P DT DD LI OPTION THEAD TFOOT TBODY
OPTGROUP COLGROUP RT RP TR TH TD ]
define_method(element.downcase, m)
end
end
end # Html5
class HTML3
include Html3
include HtmlExtension
end
class HTML4
include Html4
include HtmlExtension
end
class HTML4Tr
include Html4Tr
include HtmlExtension
end
class HTML4Fr
include Html4Tr
include Html4Fr
include HtmlExtension
end
class HTML5
include Html5
include HtmlExtension
end
end
share/ruby/cgi/session/pstore.rb 0000644 00000005204 15173517734 0012733 0 ustar 00 # frozen_string_literal: true
#
# cgi/session/pstore.rb - persistent storage of marshalled session data
#
# Documentation: William Webber (william@williamwebber.com)
#
# == Overview
#
# This file provides the CGI::Session::PStore class, which builds
# persistent of session data on top of the pstore library. See
# cgi/session.rb for more details on session storage managers.
require_relative '../session'
begin
require 'pstore'
rescue LoadError
end
class CGI
class Session
# PStore-based session storage class.
#
# This builds upon the top-level PStore class provided by the
# library file pstore.rb. Session data is marshalled and stored
# in a file. File locking and transaction services are provided.
class PStore
# Create a new CGI::Session::PStore instance
#
# This constructor is used internally by CGI::Session. The
# user does not generally need to call it directly.
#
# +session+ is the session for which this instance is being
# created. The session id must only contain alphanumeric
# characters; automatically generated session ids observe
# this requirement.
#
# +option+ is a hash of options for the initializer. The
# following options are recognised:
#
# tmpdir:: the directory to use for storing the PStore
# file. Defaults to Dir::tmpdir (generally "/tmp"
# on Unix systems).
# prefix:: the prefix to add to the session id when generating
# the filename for this session's PStore file.
# Defaults to the empty string.
#
# This session's PStore file will be created if it does
# not exist, or opened if it does.
def initialize(session, option={})
option = {'suffix'=>''}.update(option)
path, @hash = session.new_store_file(option)
@p = ::PStore.new(path)
@p.transaction do |p|
File.chmod(0600, p.path)
end
end
# Restore session state from the session's PStore file.
#
# Returns the session state as a hash.
def restore
unless @hash
@p.transaction do
@hash = @p['hash'] || {}
end
end
@hash
end
# Save session state to the session's PStore file.
def update
@p.transaction do
@p['hash'] = @hash
end
end
# Update and close the session's PStore file.
def close
update
end
# Close and delete the session's PStore file.
def delete
path = @p.path
File::unlink path
end
end if defined?(::PStore)
end
end
# :enddoc:
share/ruby/cgi/session.rb 0000644 00000046263 15173517735 0011432 0 ustar 00 # frozen_string_literal: true
#
# cgi/session.rb - session support for cgi scripts
#
# Copyright (C) 2001 Yukihiro "Matz" Matsumoto
# Copyright (C) 2000 Network Applied Communication Laboratory, Inc.
# Copyright (C) 2000 Information-technology Promotion Agency, Japan
#
# Author: Yukihiro "Matz" Matsumoto
#
# Documentation: William Webber (william@williamwebber.com)
require 'cgi'
require 'tmpdir'
class CGI
# == Overview
#
# This file provides the CGI::Session class, which provides session
# support for CGI scripts. A session is a sequence of HTTP requests
# and responses linked together and associated with a single client.
# Information associated with the session is stored
# on the server between requests. A session id is passed between client
# and server with every request and response, transparently
# to the user. This adds state information to the otherwise stateless
# HTTP request/response protocol.
#
# == Lifecycle
#
# A CGI::Session instance is created from a CGI object. By default,
# this CGI::Session instance will start a new session if none currently
# exists, or continue the current session for this client if one does
# exist. The +new_session+ option can be used to either always or
# never create a new session. See #new() for more details.
#
# #delete() deletes a session from session storage. It
# does not however remove the session id from the client. If the client
# makes another request with the same id, the effect will be to start
# a new session with the old session's id.
#
# == Setting and retrieving session data.
#
# The Session class associates data with a session as key-value pairs.
# This data can be set and retrieved by indexing the Session instance
# using '[]', much the same as hashes (although other hash methods
# are not supported).
#
# When session processing has been completed for a request, the
# session should be closed using the close() method. This will
# store the session's state to persistent storage. If you want
# to store the session's state to persistent storage without
# finishing session processing for this request, call the update()
# method.
#
# == Storing session state
#
# The caller can specify what form of storage to use for the session's
# data with the +database_manager+ option to CGI::Session::new. The
# following storage classes are provided as part of the standard library:
#
# CGI::Session::FileStore:: stores data as plain text in a flat file. Only
# works with String data. This is the default
# storage type.
# CGI::Session::MemoryStore:: stores data in an in-memory hash. The data
# only persists for as long as the current Ruby
# interpreter instance does.
# CGI::Session::PStore:: stores data in Marshalled format. Provided by
# cgi/session/pstore.rb. Supports data of any type,
# and provides file-locking and transaction support.
#
# Custom storage types can also be created by defining a class with
# the following methods:
#
# new(session, options)
# restore # returns hash of session data.
# update
# close
# delete
#
# Changing storage type mid-session does not work. Note in particular
# that by default the FileStore and PStore session data files have the
# same name. If your application switches from one to the other without
# making sure that filenames will be different
# and clients still have old sessions lying around in cookies, then
# things will break nastily!
#
# == Maintaining the session id.
#
# Most session state is maintained on the server. However, a session
# id must be passed backwards and forwards between client and server
# to maintain a reference to this session state.
#
# The simplest way to do this is via cookies. The CGI::Session class
# provides transparent support for session id communication via cookies
# if the client has cookies enabled.
#
# If the client has cookies disabled, the session id must be included
# as a parameter of all requests sent by the client to the server. The
# CGI::Session class in conjunction with the CGI class will transparently
# add the session id as a hidden input field to all forms generated
# using the CGI#form() HTML generation method. No built-in support is
# provided for other mechanisms, such as URL re-writing. The caller is
# responsible for extracting the session id from the session_id
# attribute and manually encoding it in URLs and adding it as a hidden
# input to HTML forms created by other mechanisms. Also, session expiry
# is not automatically handled.
#
# == Examples of use
#
# === Setting the user's name
#
# require 'cgi'
# require 'cgi/session'
# require 'cgi/session/pstore' # provides CGI::Session::PStore
#
# cgi = CGI.new("html4")
#
# session = CGI::Session.new(cgi,
# 'database_manager' => CGI::Session::PStore, # use PStore
# 'session_key' => '_rb_sess_id', # custom session key
# 'session_expires' => Time.now + 30 * 60, # 30 minute timeout
# 'prefix' => 'pstore_sid_') # PStore option
# if cgi.has_key?('user_name') and cgi['user_name'] != ''
# # coerce to String: cgi[] returns the
# # string-like CGI::QueryExtension::Value
# session['user_name'] = cgi['user_name'].to_s
# elsif !session['user_name']
# session['user_name'] = "guest"
# end
# session.close
#
# === Creating a new session safely
#
# require 'cgi'
# require 'cgi/session'
#
# cgi = CGI.new("html4")
#
# # We make sure to delete an old session if one exists,
# # not just to free resources, but to prevent the session
# # from being maliciously hijacked later on.
# begin
# session = CGI::Session.new(cgi, 'new_session' => false)
# session.delete
# rescue ArgumentError # if no old session
# end
# session = CGI::Session.new(cgi, 'new_session' => true)
# session.close
#
class Session
class NoSession < RuntimeError #:nodoc:
end
# The id of this session.
attr_reader :session_id, :new_session
def Session::callback(dbman) #:nodoc:
Proc.new{
dbman[0].close unless dbman.empty?
}
end
# Create a new session id.
#
# The session id is a secure random number by SecureRandom
# if possible, otherwise an SHA512 hash based upon the time,
# a random number, and a constant string. This routine is
# used internally for automatically generated session ids.
def create_new_id
require 'securerandom'
begin
# by OpenSSL, or system provided entropy pool
session_id = SecureRandom.hex(16)
rescue NotImplementedError
# never happens on modern systems
require 'digest'
d = Digest('SHA512').new
now = Time::now
d.update(now.to_s)
d.update(String(now.usec))
d.update(String(rand(0)))
d.update(String($$))
d.update('foobar')
session_id = d.hexdigest[0, 32]
end
session_id
end
private :create_new_id
# Create a new file to store the session data.
#
# This file will be created if it does not exist, or opened if it
# does.
#
# This path is generated under _tmpdir_ from _prefix_, the
# digested session id, and _suffix_.
#
# +option+ is a hash of options for the initializer. The
# following options are recognised:
#
# tmpdir:: the directory to use for storing the FileStore
# file. Defaults to Dir::tmpdir (generally "/tmp"
# on Unix systems).
# prefix:: the prefix to add to the session id when generating
# the filename for this session's FileStore file.
# Defaults to "cgi_sid_".
# suffix:: the prefix to add to the session id when generating
# the filename for this session's FileStore file.
# Defaults to the empty string.
def new_store_file(option={}) # :nodoc:
dir = option['tmpdir'] || Dir::tmpdir
prefix = option['prefix']
suffix = option['suffix']
require 'digest/md5'
md5 = Digest::MD5.hexdigest(session_id)[0,16]
path = dir+"/"
path << prefix if prefix
path << md5
path << suffix if suffix
if File::exist? path
hash = nil
elsif new_session
hash = {}
else
raise NoSession, "uninitialized session"
end
return path, hash
end
# Create a new CGI::Session object for +request+.
#
# +request+ is an instance of the +CGI+ class (see cgi.rb).
# +option+ is a hash of options for initialising this
# CGI::Session instance. The following options are
# recognised:
#
# session_key:: the parameter name used for the session id.
# Defaults to '_session_id'.
# session_id:: the session id to use. If not provided, then
# it is retrieved from the +session_key+ parameter
# of the request, or automatically generated for
# a new session.
# new_session:: if true, force creation of a new session. If not set,
# a new session is only created if none currently
# exists. If false, a new session is never created,
# and if none currently exists and the +session_id+
# option is not set, an ArgumentError is raised.
# database_manager:: the name of the class providing storage facilities
# for session state persistence. Built-in support
# is provided for +FileStore+ (the default),
# +MemoryStore+, and +PStore+ (from
# cgi/session/pstore.rb). See the documentation for
# these classes for more details.
#
# The following options are also recognised, but only apply if the
# session id is stored in a cookie.
#
# session_expires:: the time the current session expires, as a
# +Time+ object. If not set, the session will terminate
# when the user's browser is closed.
# session_domain:: the hostname domain for which this session is valid.
# If not set, defaults to the hostname of the server.
# session_secure:: if +true+, this session will only work over HTTPS.
# session_path:: the path for which this session applies. Defaults
# to the directory of the CGI script.
#
# +option+ is also passed on to the session storage class initializer; see
# the documentation for each session storage class for the options
# they support.
#
# The retrieved or created session is automatically added to +request+
# as a cookie, and also to its +output_hidden+ table, which is used
# to add hidden input elements to forms.
#
# *WARNING* the +output_hidden+
# fields are surrounded by a <fieldset> tag in HTML 4 generation, which
# is _not_ invisible on many browsers; you may wish to disable the
# use of fieldsets with code similar to the following
# (see https://blade.ruby-lang.org/ruby-list/37805)
#
# cgi = CGI.new("html4")
# class << cgi
# undef_method :fieldset
# end
#
def initialize(request, option={})
@new_session = false
session_key = option['session_key'] || '_session_id'
session_id = option['session_id']
unless session_id
if option['new_session']
session_id = create_new_id
@new_session = true
end
end
unless session_id
if request.key?(session_key)
session_id = request[session_key]
session_id = session_id.read if session_id.respond_to?(:read)
end
unless session_id
session_id, = request.cookies[session_key]
end
unless session_id
unless option.fetch('new_session', true)
raise ArgumentError, "session_key `%s' should be supplied"%session_key
end
session_id = create_new_id
@new_session = true
end
end
@session_id = session_id
dbman = option['database_manager'] || FileStore
begin
@dbman = dbman::new(self, option)
rescue NoSession
unless option.fetch('new_session', true)
raise ArgumentError, "invalid session_id `%s'"%session_id
end
session_id = @session_id = create_new_id unless session_id
@new_session=true
retry
end
request.instance_eval do
@output_hidden = {session_key => session_id} unless option['no_hidden']
@output_cookies = [
Cookie::new("name" => session_key,
"value" => session_id,
"expires" => option['session_expires'],
"domain" => option['session_domain'],
"secure" => option['session_secure'],
"path" =>
if option['session_path']
option['session_path']
elsif ENV["SCRIPT_NAME"]
File::dirname(ENV["SCRIPT_NAME"])
else
""
end)
] unless option['no_cookies']
end
@dbprot = [@dbman]
ObjectSpace::define_finalizer(self, Session::callback(@dbprot))
end
# Retrieve the session data for key +key+.
def [](key)
@data ||= @dbman.restore
@data[key]
end
# Set the session data for key +key+.
def []=(key, val)
@write_lock ||= true
@data ||= @dbman.restore
@data[key] = val
end
# Store session data on the server. For some session storage types,
# this is a no-op.
def update
@dbman.update
end
# Store session data on the server and close the session storage.
# For some session storage types, this is a no-op.
def close
@dbman.close
@dbprot.clear
end
# Delete the session from storage. Also closes the storage.
#
# Note that the session's data is _not_ automatically deleted
# upon the session expiring.
def delete
@dbman.delete
@dbprot.clear
end
# File-based session storage class.
#
# Implements session storage as a flat file of 'key=value' values.
# This storage type only works directly with String values; the
# user is responsible for converting other types to Strings when
# storing and from Strings when retrieving.
class FileStore
# Create a new FileStore instance.
#
# This constructor is used internally by CGI::Session. The
# user does not generally need to call it directly.
#
# +session+ is the session for which this instance is being
# created. The session id must only contain alphanumeric
# characters; automatically generated session ids observe
# this requirement.
#
# +option+ is a hash of options for the initializer. The
# following options are recognised:
#
# tmpdir:: the directory to use for storing the FileStore
# file. Defaults to Dir::tmpdir (generally "/tmp"
# on Unix systems).
# prefix:: the prefix to add to the session id when generating
# the filename for this session's FileStore file.
# Defaults to "cgi_sid_".
# suffix:: the prefix to add to the session id when generating
# the filename for this session's FileStore file.
# Defaults to the empty string.
#
# This session's FileStore file will be created if it does
# not exist, or opened if it does.
def initialize(session, option={})
option = {'prefix' => 'cgi_sid_'}.update(option)
@path, @hash = session.new_store_file(option)
end
# Restore session state from the session's FileStore file.
#
# Returns the session state as a hash.
def restore
unless @hash
@hash = {}
begin
lockf = File.open(@path+".lock", "r")
lockf.flock File::LOCK_SH
f = File.open(@path, 'r')
for line in f
line.chomp!
k, v = line.split('=',2)
@hash[CGI.unescape(k)] = Marshal.restore(CGI.unescape(v))
end
ensure
f&.close
lockf&.close
end
end
@hash
end
# Save session state to the session's FileStore file.
def update
return unless @hash
begin
lockf = File.open(@path+".lock", File::CREAT|File::RDWR, 0600)
lockf.flock File::LOCK_EX
f = File.open(@path+".new", File::CREAT|File::TRUNC|File::WRONLY, 0600)
for k,v in @hash
f.printf "%s=%s\n", CGI.escape(k), CGI.escape(String(Marshal.dump(v)))
end
f.close
File.rename @path+".new", @path
ensure
f&.close
lockf&.close
end
end
# Update and close the session's FileStore file.
def close
update
end
# Close and delete the session's FileStore file.
def delete
File::unlink @path+".lock" rescue nil
File::unlink @path+".new" rescue nil
File::unlink @path rescue nil
end
end
# In-memory session storage class.
#
# Implements session storage as a global in-memory hash. Session
# data will only persist for as long as the Ruby interpreter
# instance does.
class MemoryStore
GLOBAL_HASH_TABLE = {} #:nodoc:
# Create a new MemoryStore instance.
#
# +session+ is the session this instance is associated with.
# +option+ is a list of initialisation options. None are
# currently recognized.
def initialize(session, option=nil)
@session_id = session.session_id
unless GLOBAL_HASH_TABLE.key?(@session_id)
unless session.new_session
raise CGI::Session::NoSession, "uninitialized session"
end
GLOBAL_HASH_TABLE[@session_id] = {}
end
end
# Restore session state.
#
# Returns session data as a hash.
def restore
GLOBAL_HASH_TABLE[@session_id]
end
# Update session state.
#
# A no-op.
def update
# don't need to update; hash is shared
end
# Close session storage.
#
# A no-op.
def close
# don't need to close
end
# Delete the session state.
def delete
GLOBAL_HASH_TABLE.delete(@session_id)
end
end
# Dummy session storage class.
#
# Implements session storage place holder. No actual storage
# will be done.
class NullStore
# Create a new NullStore instance.
#
# +session+ is the session this instance is associated with.
# +option+ is a list of initialisation options. None are
# currently recognised.
def initialize(session, option=nil)
end
# Restore (empty) session state.
def restore
{}
end
# Update session state.
#
# A no-op.
def update
end
# Close session storage.
#
# A no-op.
def close
end
# Delete the session state.
#
# A no-op.
def delete
end
end
end
end
share/ruby/cgi/core.rb 0000644 00000072445 15173517735 0010700 0 ustar 00 # frozen_string_literal: true
#--
# Methods for generating HTML, parsing CGI-related parameters, and
# generating HTTP responses.
#++
class CGI
unless const_defined?(:Util)
module Util
@@accept_charset = "UTF-8" # :nodoc:
end
include Util
extend Util
end
$CGI_ENV = ENV # for FCGI support
# String for carriage return
CR = "\015"
# String for linefeed
LF = "\012"
# Standard internet newline sequence
EOL = CR + LF
REVISION = '$Id$' #:nodoc:
# Whether processing will be required in binary vs text
NEEDS_BINMODE = File::BINARY != 0
# Path separators in different environments.
PATH_SEPARATOR = {'UNIX'=>'/', 'WINDOWS'=>'\\', 'MACINTOSH'=>':'}
# HTTP status codes.
HTTP_STATUS = {
"OK" => "200 OK",
"PARTIAL_CONTENT" => "206 Partial Content",
"MULTIPLE_CHOICES" => "300 Multiple Choices",
"MOVED" => "301 Moved Permanently",
"REDIRECT" => "302 Found",
"NOT_MODIFIED" => "304 Not Modified",
"BAD_REQUEST" => "400 Bad Request",
"AUTH_REQUIRED" => "401 Authorization Required",
"FORBIDDEN" => "403 Forbidden",
"NOT_FOUND" => "404 Not Found",
"METHOD_NOT_ALLOWED" => "405 Method Not Allowed",
"NOT_ACCEPTABLE" => "406 Not Acceptable",
"LENGTH_REQUIRED" => "411 Length Required",
"PRECONDITION_FAILED" => "412 Precondition Failed",
"SERVER_ERROR" => "500 Internal Server Error",
"NOT_IMPLEMENTED" => "501 Method Not Implemented",
"BAD_GATEWAY" => "502 Bad Gateway",
"VARIANT_ALSO_VARIES" => "506 Variant Also Negotiates"
}
# :startdoc:
# Synonym for ENV.
def env_table
ENV
end
# Synonym for $stdin.
def stdinput
$stdin
end
# Synonym for $stdout.
def stdoutput
$stdout
end
private :env_table, :stdinput, :stdoutput
# Create an HTTP header block as a string.
#
# :call-seq:
# http_header(content_type_string="text/html")
# http_header(headers_hash)
#
# Includes the empty line that ends the header block.
#
# +content_type_string+::
# If this form is used, this string is the <tt>Content-Type</tt>
# +headers_hash+::
# A Hash of header values. The following header keys are recognized:
#
# type:: The Content-Type header. Defaults to "text/html"
# charset:: The charset of the body, appended to the Content-Type header.
# nph:: A boolean value. If true, prepend protocol string and status
# code, and date; and sets default values for "server" and
# "connection" if not explicitly set.
# status::
# The HTTP status code as a String, returned as the Status header. The
# values are:
#
# OK:: 200 OK
# PARTIAL_CONTENT:: 206 Partial Content
# MULTIPLE_CHOICES:: 300 Multiple Choices
# MOVED:: 301 Moved Permanently
# REDIRECT:: 302 Found
# NOT_MODIFIED:: 304 Not Modified
# BAD_REQUEST:: 400 Bad Request
# AUTH_REQUIRED:: 401 Authorization Required
# FORBIDDEN:: 403 Forbidden
# NOT_FOUND:: 404 Not Found
# METHOD_NOT_ALLOWED:: 405 Method Not Allowed
# NOT_ACCEPTABLE:: 406 Not Acceptable
# LENGTH_REQUIRED:: 411 Length Required
# PRECONDITION_FAILED:: 412 Precondition Failed
# SERVER_ERROR:: 500 Internal Server Error
# NOT_IMPLEMENTED:: 501 Method Not Implemented
# BAD_GATEWAY:: 502 Bad Gateway
# VARIANT_ALSO_VARIES:: 506 Variant Also Negotiates
#
# server:: The server software, returned as the Server header.
# connection:: The connection type, returned as the Connection header (for
# instance, "close".
# length:: The length of the content that will be sent, returned as the
# Content-Length header.
# language:: The language of the content, returned as the Content-Language
# header.
# expires:: The time on which the current content expires, as a +Time+
# object, returned as the Expires header.
# cookie::
# A cookie or cookies, returned as one or more Set-Cookie headers. The
# value can be the literal string of the cookie; a CGI::Cookie object;
# an Array of literal cookie strings or Cookie objects; or a hash all of
# whose values are literal cookie strings or Cookie objects.
#
# These cookies are in addition to the cookies held in the
# @output_cookies field.
#
# Other headers can also be set; they are appended as key: value.
#
# Examples:
#
# http_header
# # Content-Type: text/html
#
# http_header("text/plain")
# # Content-Type: text/plain
#
# http_header("nph" => true,
# "status" => "OK", # == "200 OK"
# # "status" => "200 GOOD",
# "server" => ENV['SERVER_SOFTWARE'],
# "connection" => "close",
# "type" => "text/html",
# "charset" => "iso-2022-jp",
# # Content-Type: text/html; charset=iso-2022-jp
# "length" => 103,
# "language" => "ja",
# "expires" => Time.now + 30,
# "cookie" => [cookie1, cookie2],
# "my_header1" => "my_value",
# "my_header2" => "my_value")
#
# This method does not perform charset conversion.
def http_header(options='text/html')
if options.is_a?(String)
content_type = options
buf = _header_for_string(content_type)
elsif options.is_a?(Hash)
if options.size == 1 && options.has_key?('type')
content_type = options['type']
buf = _header_for_string(content_type)
else
buf = _header_for_hash(options.dup)
end
else
raise ArgumentError.new("expected String or Hash but got #{options.class}")
end
if defined?(MOD_RUBY)
_header_for_modruby(buf)
return ''
else
buf << EOL # empty line of separator
return buf
end
end # http_header()
# This method is an alias for #http_header, when HTML5 tag maker is inactive.
#
# NOTE: use #http_header to create HTTP header blocks, this alias is only
# provided for backwards compatibility.
#
# Using #header with the HTML5 tag maker will create a <header> element.
alias :header :http_header
def _no_crlf_check(str)
if str
str = str.to_s
raise "A HTTP status or header field must not include CR and LF" if str =~ /[\r\n]/
str
else
nil
end
end
private :_no_crlf_check
def _header_for_string(content_type) #:nodoc:
buf = ''.dup
if nph?()
buf << "#{_no_crlf_check($CGI_ENV['SERVER_PROTOCOL']) || 'HTTP/1.0'} 200 OK#{EOL}"
buf << "Date: #{CGI.rfc1123_date(Time.now)}#{EOL}"
buf << "Server: #{_no_crlf_check($CGI_ENV['SERVER_SOFTWARE'])}#{EOL}"
buf << "Connection: close#{EOL}"
end
buf << "Content-Type: #{_no_crlf_check(content_type)}#{EOL}"
if @output_cookies
@output_cookies.each {|cookie| buf << "Set-Cookie: #{_no_crlf_check(cookie)}#{EOL}" }
end
return buf
end # _header_for_string
private :_header_for_string
def _header_for_hash(options) #:nodoc:
buf = ''.dup
## add charset to option['type']
options['type'] ||= 'text/html'
charset = options.delete('charset')
options['type'] += "; charset=#{charset}" if charset
## NPH
options.delete('nph') if defined?(MOD_RUBY)
if options.delete('nph') || nph?()
protocol = _no_crlf_check($CGI_ENV['SERVER_PROTOCOL']) || 'HTTP/1.0'
status = options.delete('status')
status = HTTP_STATUS[status] || _no_crlf_check(status) || '200 OK'
buf << "#{protocol} #{status}#{EOL}"
buf << "Date: #{CGI.rfc1123_date(Time.now)}#{EOL}"
options['server'] ||= $CGI_ENV['SERVER_SOFTWARE'] || ''
options['connection'] ||= 'close'
end
## common headers
status = options.delete('status')
buf << "Status: #{HTTP_STATUS[status] || _no_crlf_check(status)}#{EOL}" if status
server = options.delete('server')
buf << "Server: #{_no_crlf_check(server)}#{EOL}" if server
connection = options.delete('connection')
buf << "Connection: #{_no_crlf_check(connection)}#{EOL}" if connection
type = options.delete('type')
buf << "Content-Type: #{_no_crlf_check(type)}#{EOL}" #if type
length = options.delete('length')
buf << "Content-Length: #{_no_crlf_check(length)}#{EOL}" if length
language = options.delete('language')
buf << "Content-Language: #{_no_crlf_check(language)}#{EOL}" if language
expires = options.delete('expires')
buf << "Expires: #{CGI.rfc1123_date(expires)}#{EOL}" if expires
## cookie
if cookie = options.delete('cookie')
case cookie
when String, Cookie
buf << "Set-Cookie: #{_no_crlf_check(cookie)}#{EOL}"
when Array
arr = cookie
arr.each {|c| buf << "Set-Cookie: #{_no_crlf_check(c)}#{EOL}" }
when Hash
hash = cookie
hash.each_value {|c| buf << "Set-Cookie: #{_no_crlf_check(c)}#{EOL}" }
end
end
if @output_cookies
@output_cookies.each {|c| buf << "Set-Cookie: #{_no_crlf_check(c)}#{EOL}" }
end
## other headers
options.each do |key, value|
buf << "#{_no_crlf_check(key)}: #{_no_crlf_check(value)}#{EOL}"
end
return buf
end # _header_for_hash
private :_header_for_hash
def nph? #:nodoc:
return /IIS\/(\d+)/ =~ $CGI_ENV['SERVER_SOFTWARE'] && $1.to_i < 5
end
def _header_for_modruby(buf) #:nodoc:
request = Apache::request
buf.scan(/([^:]+): (.+)#{EOL}/o) do |name, value|
$stderr.printf("name:%s value:%s\n", name, value) if $DEBUG
case name
when 'Set-Cookie'
request.headers_out.add(name, value)
when /^status$/i
request.status_line = value
request.status = value.to_i
when /^content-type$/i
request.content_type = value
when /^content-encoding$/i
request.content_encoding = value
when /^location$/i
request.status = 302 if request.status == 200
request.headers_out[name] = value
else
request.headers_out[name] = value
end
end
request.send_http_header
return ''
end
private :_header_for_modruby
# Print an HTTP header and body to $DEFAULT_OUTPUT ($>)
#
# :call-seq:
# cgi.out(content_type_string='text/html')
# cgi.out(headers_hash)
#
# +content_type_string+::
# If a string is passed, it is assumed to be the content type.
# +headers_hash+::
# This is a Hash of headers, similar to that used by #http_header.
# +block+::
# A block is required and should evaluate to the body of the response.
#
# <tt>Content-Length</tt> is automatically calculated from the size of
# the String returned by the content block.
#
# If <tt>ENV['REQUEST_METHOD'] == "HEAD"</tt>, then only the header
# is output (the content block is still required, but it is ignored).
#
# If the charset is "iso-2022-jp" or "euc-jp" or "shift_jis" then the
# content is converted to this charset, and the language is set to "ja".
#
# Example:
#
# cgi = CGI.new
# cgi.out{ "string" }
# # Content-Type: text/html
# # Content-Length: 6
# #
# # string
#
# cgi.out("text/plain") { "string" }
# # Content-Type: text/plain
# # Content-Length: 6
# #
# # string
#
# cgi.out("nph" => true,
# "status" => "OK", # == "200 OK"
# "server" => ENV['SERVER_SOFTWARE'],
# "connection" => "close",
# "type" => "text/html",
# "charset" => "iso-2022-jp",
# # Content-Type: text/html; charset=iso-2022-jp
# "language" => "ja",
# "expires" => Time.now + (3600 * 24 * 30),
# "cookie" => [cookie1, cookie2],
# "my_header1" => "my_value",
# "my_header2" => "my_value") { "string" }
# # HTTP/1.1 200 OK
# # Date: Sun, 15 May 2011 17:35:54 GMT
# # Server: Apache 2.2.0
# # Connection: close
# # Content-Type: text/html; charset=iso-2022-jp
# # Content-Length: 6
# # Content-Language: ja
# # Expires: Tue, 14 Jun 2011 17:35:54 GMT
# # Set-Cookie: foo
# # Set-Cookie: bar
# # my_header1: my_value
# # my_header2: my_value
# #
# # string
def out(options = "text/html") # :yield:
options = { "type" => options } if options.kind_of?(String)
content = yield
options["length"] = content.bytesize.to_s
output = stdoutput
output.binmode if defined? output.binmode
output.print http_header(options)
output.print content unless "HEAD" == env_table['REQUEST_METHOD']
end
# Print an argument or list of arguments to the default output stream
#
# cgi = CGI.new
# cgi.print # default: cgi.print == $DEFAULT_OUTPUT.print
def print(*options)
stdoutput.print(*options)
end
# Parse an HTTP query string into a hash of key=>value pairs.
#
# params = CGI.parse("query_string")
# # {"name1" => ["value1", "value2", ...],
# # "name2" => ["value1", "value2", ...], ... }
#
def self.parse(query)
params = {}
query.split(/[&;]/).each do |pairs|
key, value = pairs.split('=',2).collect{|v| CGI.unescape(v) }
next unless key
params[key] ||= []
params[key].push(value) if value
end
params.default=[].freeze
params
end
# Maximum content length of post data
##MAX_CONTENT_LENGTH = 2 * 1024 * 1024
# Maximum number of request parameters when multipart
MAX_MULTIPART_COUNT = 128
# Mixin module that provides the following:
#
# 1. Access to the CGI environment variables as methods. See
# documentation to the CGI class for a list of these variables. The
# methods are exposed by removing the leading +HTTP_+ (if it exists) and
# downcasing the name. For example, +auth_type+ will return the
# environment variable +AUTH_TYPE+, and +accept+ will return the value
# for +HTTP_ACCEPT+.
#
# 2. Access to cookies, including the cookies attribute.
#
# 3. Access to parameters, including the params attribute, and overloading
# #[] to perform parameter value lookup by key.
#
# 4. The initialize_query method, for initializing the above
# mechanisms, handling multipart forms, and allowing the
# class to be used in "offline" mode.
#
module QueryExtension
%w[ CONTENT_LENGTH SERVER_PORT ].each do |env|
define_method(env.delete_prefix('HTTP_').downcase) do
(val = env_table[env]) && Integer(val)
end
end
%w[ AUTH_TYPE CONTENT_TYPE GATEWAY_INTERFACE PATH_INFO
PATH_TRANSLATED QUERY_STRING REMOTE_ADDR REMOTE_HOST
REMOTE_IDENT REMOTE_USER REQUEST_METHOD SCRIPT_NAME
SERVER_NAME SERVER_PROTOCOL SERVER_SOFTWARE
HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM HTTP_HOST
HTTP_NEGOTIATE HTTP_PRAGMA HTTP_REFERER HTTP_USER_AGENT ].each do |env|
define_method(env.delete_prefix('HTTP_').downcase) do
env_table[env]
end
end
# Get the raw cookies as a string.
def raw_cookie
env_table["HTTP_COOKIE"]
end
# Get the raw RFC2965 cookies as a string.
def raw_cookie2
env_table["HTTP_COOKIE2"]
end
# Get the cookies as a hash of cookie-name=>Cookie pairs.
attr_accessor :cookies
# Get the parameters as a hash of name=>values pairs, where
# values is an Array.
attr_reader :params
# Get the uploaded files as a hash of name=>values pairs
attr_reader :files
# Set all the parameters.
def params=(hash)
@params.clear
@params.update(hash)
end
##
# Parses multipart form elements according to
# http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2
#
# Returns a hash of multipart form parameters with bodies of type StringIO or
# Tempfile depending on whether the multipart form element exceeds 10 KB
#
# params[name => body]
#
def read_multipart(boundary, content_length)
## read first boundary
stdin = stdinput
first_line = "--#{boundary}#{EOL}"
content_length -= first_line.bytesize
status = stdin.read(first_line.bytesize)
raise EOFError.new("no content body") unless status
raise EOFError.new("bad content body") unless first_line == status
## parse and set params
params = {}
@files = {}
boundary_rexp = /--#{Regexp.quote(boundary)}(#{EOL}|--)/
boundary_size = "#{EOL}--#{boundary}#{EOL}".bytesize
buf = ''.dup
bufsize = 10 * 1024
max_count = MAX_MULTIPART_COUNT
n = 0
tempfiles = []
while true
(n += 1) < max_count or raise StandardError.new("too many parameters.")
## create body (StringIO or Tempfile)
body = create_body(bufsize < content_length)
tempfiles << body if defined?(Tempfile) && body.kind_of?(Tempfile)
class << body
if method_defined?(:path)
alias local_path path
else
def local_path
nil
end
end
attr_reader :original_filename, :content_type
end
## find head and boundary
head = nil
separator = EOL * 2
until head && matched = boundary_rexp.match(buf)
if !head && pos = buf.index(separator)
len = pos + EOL.bytesize
head = buf[0, len]
buf = buf[(pos+separator.bytesize)..-1]
else
if head && buf.size > boundary_size
len = buf.size - boundary_size
body.print(buf[0, len])
buf[0, len] = ''
end
c = stdin.read(bufsize < content_length ? bufsize : content_length)
raise EOFError.new("bad content body") if c.nil? || c.empty?
buf << c
content_length -= c.bytesize
end
end
## read to end of boundary
m = matched
len = m.begin(0)
s = buf[0, len]
if s =~ /(\r?\n)\z/
s = buf[0, len - $1.bytesize]
end
body.print(s)
buf = buf[m.end(0)..-1]
boundary_end = m[1]
content_length = -1 if boundary_end == '--'
## reset file cursor position
body.rewind
## original filename
/Content-Disposition:.* filename=(?:"(.*?)"|([^;\r\n]*))/i.match(head)
filename = $1 || $2 || ''.dup
filename = CGI.unescape(filename) if unescape_filename?()
body.instance_variable_set(:@original_filename, filename)
## content type
/Content-Type: (.*)/i.match(head)
(content_type = $1 || ''.dup).chomp!
body.instance_variable_set(:@content_type, content_type)
## query parameter name
/Content-Disposition:.* name=(?:"(.*?)"|([^;\r\n]*))/i.match(head)
name = $1 || $2 || ''
if body.original_filename.empty?
value=body.read.dup.force_encoding(@accept_charset)
body.close! if defined?(Tempfile) && body.kind_of?(Tempfile)
(params[name] ||= []) << value
unless value.valid_encoding?
if @accept_charset_error_block
@accept_charset_error_block.call(name,value)
else
raise InvalidEncoding,"Accept-Charset encoding error"
end
end
class << params[name].last;self;end.class_eval do
define_method(:read){self}
define_method(:original_filename){""}
define_method(:content_type){""}
end
else
(params[name] ||= []) << body
@files[name]=body
end
## break loop
break if content_length == -1
end
raise EOFError, "bad boundary end of body part" unless boundary_end =~ /--/
params.default = []
params
rescue Exception
if tempfiles
tempfiles.each {|t|
if t.path
t.close!
end
}
end
raise
end # read_multipart
private :read_multipart
def create_body(is_large) #:nodoc:
if is_large
require 'tempfile'
body = Tempfile.new('CGI', encoding: Encoding::ASCII_8BIT)
else
begin
require 'stringio'
body = StringIO.new("".b)
rescue LoadError
require 'tempfile'
body = Tempfile.new('CGI', encoding: Encoding::ASCII_8BIT)
end
end
body.binmode if defined? body.binmode
return body
end
def unescape_filename? #:nodoc:
user_agent = $CGI_ENV['HTTP_USER_AGENT']
return false unless user_agent
return /Mac/i.match(user_agent) && /Mozilla/i.match(user_agent) && !/MSIE/i.match(user_agent)
end
# offline mode. read name=value pairs on standard input.
def read_from_cmdline
require "shellwords"
string = unless ARGV.empty?
ARGV.join(' ')
else
if STDIN.tty?
STDERR.print(
%|(offline mode: enter name=value pairs on standard input)\n|
)
end
array = readlines rescue nil
if not array.nil?
array.join(' ').gsub(/\n/n, '')
else
""
end
end.gsub(/\\=/n, '%3D').gsub(/\\&/n, '%26')
words = Shellwords.shellwords(string)
if words.find{|x| /=/n.match(x) }
words.join('&')
else
words.join('+')
end
end
private :read_from_cmdline
# A wrapper class to use a StringIO object as the body and switch
# to a TempFile when the passed threshold is passed.
# Initialize the data from the query.
#
# Handles multipart forms (in particular, forms that involve file uploads).
# Reads query parameters in the @params field, and cookies into @cookies.
def initialize_query()
if ("POST" == env_table['REQUEST_METHOD']) and
%r|\Amultipart/form-data.*boundary=\"?([^\";,]+)\"?| =~ env_table['CONTENT_TYPE']
current_max_multipart_length = @max_multipart_length.respond_to?(:call) ? @max_multipart_length.call : @max_multipart_length
raise StandardError.new("too large multipart data.") if env_table['CONTENT_LENGTH'].to_i > current_max_multipart_length
boundary = $1.dup
@multipart = true
@params = read_multipart(boundary, Integer(env_table['CONTENT_LENGTH']))
else
@multipart = false
@params = CGI.parse(
case env_table['REQUEST_METHOD']
when "GET", "HEAD"
if defined?(MOD_RUBY)
Apache::request.args or ""
else
env_table['QUERY_STRING'] or ""
end
when "POST"
stdinput.binmode if defined? stdinput.binmode
stdinput.read(Integer(env_table['CONTENT_LENGTH'])) or ''
else
read_from_cmdline
end.dup.force_encoding(@accept_charset)
)
unless Encoding.find(@accept_charset) == Encoding::ASCII_8BIT
@params.each do |key,values|
values.each do |value|
unless value.valid_encoding?
if @accept_charset_error_block
@accept_charset_error_block.call(key,value)
else
raise InvalidEncoding,"Accept-Charset encoding error"
end
end
end
end
end
end
@cookies = CGI::Cookie.parse((env_table['HTTP_COOKIE'] or env_table['COOKIE']))
end
private :initialize_query
# Returns whether the form contained multipart/form-data
def multipart?
@multipart
end
# Get the value for the parameter with a given key.
#
# If the parameter has multiple values, only the first will be
# retrieved; use #params to get the array of values.
def [](key)
params = @params[key]
return '' unless params
value = params[0]
if @multipart
if value
return value
elsif defined? StringIO
StringIO.new("".b)
else
Tempfile.new("CGI",encoding: Encoding::ASCII_8BIT)
end
else
str = if value then value.dup else "" end
str
end
end
# Return all query parameter names as an array of String.
def keys(*args)
@params.keys(*args)
end
# Returns true if a given query string parameter exists.
def has_key?(*args)
@params.has_key?(*args)
end
alias key? has_key?
alias include? has_key?
end # QueryExtension
# Exception raised when there is an invalid encoding detected
class InvalidEncoding < Exception; end
# @@accept_charset is default accept character set.
# This default value default is "UTF-8"
# If you want to change the default accept character set
# when create a new CGI instance, set this:
#
# CGI.accept_charset = "EUC-JP"
#
@@accept_charset="UTF-8" if false # needed for rdoc?
# Return the accept character set for all new CGI instances.
def self.accept_charset
@@accept_charset
end
# Set the accept character set for all new CGI instances.
def self.accept_charset=(accept_charset)
@@accept_charset=accept_charset
end
# Return the accept character set for this CGI instance.
attr_reader :accept_charset
# @@max_multipart_length is the maximum length of multipart data.
# The default value is 128 * 1024 * 1024 bytes
#
# The default can be set to something else in the CGI constructor,
# via the :max_multipart_length key in the option hash.
#
# See CGI.new documentation.
#
@@max_multipart_length= 128 * 1024 * 1024
# Create a new CGI instance.
#
# :call-seq:
# CGI.new(tag_maker) { block }
# CGI.new(options_hash = {}) { block }
#
#
# <tt>tag_maker</tt>::
# This is the same as using the +options_hash+ form with the value <tt>{
# :tag_maker => tag_maker }</tt> Note that it is recommended to use the
# +options_hash+ form, since it also allows you specify the charset you
# will accept.
# <tt>options_hash</tt>::
# A Hash that recognizes three options:
#
# <tt>:accept_charset</tt>::
# specifies encoding of received query string. If omitted,
# <tt>@@accept_charset</tt> is used. If the encoding is not valid, a
# CGI::InvalidEncoding will be raised.
#
# Example. Suppose <tt>@@accept_charset</tt> is "UTF-8"
#
# when not specified:
#
# cgi=CGI.new # @accept_charset # => "UTF-8"
#
# when specified as "EUC-JP":
#
# cgi=CGI.new(:accept_charset => "EUC-JP") # => "EUC-JP"
#
# <tt>:tag_maker</tt>::
# String that specifies which version of the HTML generation methods to
# use. If not specified, no HTML generation methods will be loaded.
#
# The following values are supported:
#
# "html3":: HTML 3.x
# "html4":: HTML 4.0
# "html4Tr":: HTML 4.0 Transitional
# "html4Fr":: HTML 4.0 with Framesets
# "html5":: HTML 5
#
# <tt>:max_multipart_length</tt>::
# Specifies maximum length of multipart data. Can be an Integer scalar or
# a lambda, that will be evaluated when the request is parsed. This
# allows more complex logic to be set when determining whether to accept
# multipart data (e.g. consult a registered users upload allowance)
#
# Default is 128 * 1024 * 1024 bytes
#
# cgi=CGI.new(:max_multipart_length => 268435456) # simple scalar
#
# cgi=CGI.new(:max_multipart_length => -> {check_filesystem}) # lambda
#
# <tt>block</tt>::
# If provided, the block is called when an invalid encoding is
# encountered. For example:
#
# encoding_errors={}
# cgi=CGI.new(:accept_charset=>"EUC-JP") do |name,value|
# encoding_errors[name] = value
# end
#
# Finally, if the CGI object is not created in a standard CGI call
# environment (that is, it can't locate REQUEST_METHOD in its environment),
# then it will run in "offline" mode. In this mode, it reads its parameters
# from the command line or (failing that) from standard input. Otherwise,
# cookies and other parameters are parsed automatically from the standard
# CGI locations, which varies according to the REQUEST_METHOD.
def initialize(options = {}, &block) # :yields: name, value
@accept_charset_error_block = block_given? ? block : nil
@options={
:accept_charset=>@@accept_charset,
:max_multipart_length=>@@max_multipart_length
}
case options
when Hash
@options.merge!(options)
when String
@options[:tag_maker]=options
end
@accept_charset=@options[:accept_charset]
@max_multipart_length=@options[:max_multipart_length]
if defined?(MOD_RUBY) && !ENV.key?("GATEWAY_INTERFACE")
Apache.request.setup_cgi_env
end
extend QueryExtension
@multipart = false
initialize_query() # set @params, @cookies
@output_cookies = nil
@output_hidden = nil
case @options[:tag_maker]
when "html3"
require_relative 'html'
extend Html3
extend HtmlExtension
when "html4"
require_relative 'html'
extend Html4
extend HtmlExtension
when "html4Tr"
require_relative 'html'
extend Html4Tr
extend HtmlExtension
when "html4Fr"
require_relative 'html'
extend Html4Tr
extend Html4Fr
extend HtmlExtension
when "html5"
require_relative 'html'
extend Html5
extend HtmlExtension
end
end
end # class CGI
share/ruby/bundled_gems.rb 0000644 00000015555 15173517735 0011635 0 ustar 00 # -*- frozen-string-literal: true -*-
# :stopdoc:
module Gem::BUNDLED_GEMS
SINCE = {
"rexml" => "3.0.0",
"rss" => "3.0.0",
"webrick" => "3.0.0",
"matrix" => "3.1.0",
"net-ftp" => "3.1.0",
"net-imap" => "3.1.0",
"net-pop" => "3.1.0",
"net-smtp" => "3.1.0",
"prime" => "3.1.0",
"racc" => "3.3.0",
"abbrev" => "3.4.0",
"base64" => "3.4.0",
"bigdecimal" => "3.4.0",
"csv" => "3.4.0",
"drb" => "3.4.0",
"getoptlong" => "3.4.0",
"mutex_m" => "3.4.0",
"nkf" => "3.4.0",
"observer" => "3.4.0",
"resolv-replace" => "3.4.0",
"rinda" => "3.4.0",
"syslog" => "3.4.0",
}.freeze
SINCE_FAST_PATH = SINCE.transform_keys { |g| g.sub(/\A.*\-/, "") }.freeze
EXACT = {
"kconv" => "nkf",
}.freeze
PREFIXED = {
"bigdecimal" => true,
"csv" => true,
"drb" => true,
"rinda" => true,
"syslog" => true,
}.freeze
WARNED = {} # unfrozen
conf = ::RbConfig::CONFIG
LIBDIR = (conf["rubylibdir"] + "/").freeze
ARCHDIR = (conf["rubyarchdir"] + "/").freeze
dlext = [conf["DLEXT"], "so"].uniq
DLEXT = /\.#{Regexp.union(dlext)}\z/
LIBEXT = /\.#{Regexp.union("rb", *dlext)}\z/
def self.replace_require(specs)
return if [::Kernel.singleton_class, ::Kernel].any? {|klass| klass.respond_to?(:no_warning_require) }
spec_names = specs.to_a.each_with_object({}) {|spec, h| h[spec.name] = true }
[::Kernel.singleton_class, ::Kernel].each do |kernel_class|
kernel_class.send(:alias_method, :no_warning_require, :require)
kernel_class.send(:define_method, :require) do |name|
if message = ::Gem::BUNDLED_GEMS.warning?(name, specs: spec_names)
if ::Gem::BUNDLED_GEMS.uplevel > 0
Kernel.warn message, uplevel: ::Gem::BUNDLED_GEMS.uplevel
else
Kernel.warn message
end
end
kernel_class.send(:no_warning_require, name)
end
if kernel_class == ::Kernel
kernel_class.send(:private, :require)
else
kernel_class.send(:public, :require)
end
end
end
def self.uplevel
frame_count = 0
frames_to_skip = 3
uplevel = 0
require_found = false
Thread.each_caller_location do |cl|
frame_count += 1
if frames_to_skip >= 1
frames_to_skip -= 1
next
end
uplevel += 1
if require_found
if cl.base_label != "require"
return uplevel
end
else
if cl.base_label == "require"
require_found = true
end
end
# Don't show script name when bundle exec and call ruby script directly.
if cl.path.end_with?("bundle")
frame_count = 0
break
end
end
require_found ? 1 : frame_count - 1
end
def self.find_gem(path)
if !path
return
elsif path.start_with?(ARCHDIR)
n = path.delete_prefix(ARCHDIR).sub(DLEXT, "")
elsif path.start_with?(LIBDIR)
n = path.delete_prefix(LIBDIR).chomp(".rb")
else
return
end
(EXACT[n] || !!SINCE[n]) or PREFIXED[n = n[%r[\A[^/]+(?=/)]]] && n
end
def self.warning?(name, specs: nil)
# name can be a feature name or a file path with String or Pathname
feature = File.path(name)
# The actual checks needed to properly identify the gem being required
# are costly (see [Bug #20641]), so we first do a much cheaper check
# to exclude the vast majority of candidates.
if feature.include?("/")
# If requiring $LIBDIR/mutex_m.rb, we check SINCE_FAST_PATH["mutex_m"]
# We'll fail to warn requires for files that are not the entry point
# of the gem, e.g. require "logger/formatter.rb" won't warn.
# But that's acceptable because this warning is best effort,
# and in the overwhelming majority of cases logger.rb will end
# up required.
return unless SINCE_FAST_PATH[File.basename(feature, ".*")]
else
return unless SINCE_FAST_PATH[feature]
end
# bootsnap expands `require "csv"` to `require "#{LIBDIR}/csv.rb"`,
# and `require "syslog"` to `require "#{ARCHDIR}/syslog.so"`.
name = feature.delete_prefix(ARCHDIR)
name.delete_prefix!(LIBDIR)
name.tr!("/", "-")
name.sub!(LIBEXT, "")
return if specs.include?(name)
_t, path = $:.resolve_feature_path(feature)
if gem = find_gem(path)
return if specs.include?(gem)
caller = caller_locations(3, 3)&.find {|c| c&.absolute_path}
return if find_gem(caller&.absolute_path)
elsif SINCE[name] && !path
gem = true
else
return
end
return if WARNED[name]
WARNED[name] = true
if gem == true
gem = name
"#{feature} was loaded from the standard library, but"
elsif gem
return if WARNED[gem]
WARNED[gem] = true
"#{feature} is found in #{gem}, which"
else
return
end + build_message(gem)
end
def self.build_message(gem)
msg = " #{RUBY_VERSION < SINCE[gem] ? "will no longer be" : "is not"} part of the default gems starting from Ruby #{SINCE[gem]}."
if defined?(Bundler)
msg += "\nYou can add #{gem} to your Gemfile or gemspec to silence this warning."
# We detect the gem name from caller_locations. First we walk until we find `require`
# then take the first frame that's not from `require`.
#
# Additionally, we need to skip Bootsnap and Zeitwerk if present, these
# gems decorate Kernel#require, so they are not really the ones issuing
# the require call users should be warned about. Those are upwards.
frames_to_skip = 3
location = nil
require_found = false
Thread.each_caller_location do |cl|
if frames_to_skip >= 1
frames_to_skip -= 1
next
end
if require_found
if cl.base_label != "require"
location = cl.path
break
end
else
if cl.base_label == "require"
require_found = true
end
end
end
if location && File.file?(location) && !location.start_with?(Gem::BUNDLED_GEMS::LIBDIR)
caller_gem = nil
Gem.path.each do |path|
if location =~ %r{#{path}/gems/([\w\-\.]+)}
caller_gem = $1
break
end
end
if caller_gem
msg += "\nAlso please contact the author of #{caller_gem} to request adding #{gem} into its gemspec."
end
end
else
msg += " Install #{gem} from RubyGems."
end
msg
end
freeze
end
# for RubyGems without Bundler environment.
# If loading library is not part of the default gems and the bundled gems, warn it.
class LoadError
def message
return super unless path
name = path.tr("/", "-")
if !defined?(Bundler) && Gem::BUNDLED_GEMS::SINCE[name] && !Gem::BUNDLED_GEMS::WARNED[name]
warn name + Gem::BUNDLED_GEMS.build_message(name), uplevel: Gem::BUNDLED_GEMS.uplevel
end
super
end
end
# :startdoc:
share/ruby/coverage.rb 0000644 00000000560 15173517735 0010766 0 ustar 00 require "coverage.so"
module Coverage
def self.line_stub(file)
lines = File.foreach(file).map { nil }
iseqs = [RubyVM::InstructionSequence.compile_file(file)]
until iseqs.empty?
iseq = iseqs.pop
iseq.trace_points.each {|n, type| lines[n - 1] = 0 if type == :line }
iseq.each_child {|child| iseqs << child }
end
lines
end
end
share/ruby/prism.rb 0000644 00000006257 15173517735 0010336 0 ustar 00 # frozen_string_literal: true
# The Prism Ruby parser.
#
# "Parsing Ruby is suddenly manageable!"
# - You, hopefully
#
module Prism
# There are many files in prism that are templated to handle every node type,
# which means the files can end up being quite large. We autoload them to make
# our require speed faster since consuming libraries are unlikely to use all
# of these features.
autoload :BasicVisitor, "prism/visitor"
autoload :Compiler, "prism/compiler"
autoload :Debug, "prism/debug"
autoload :DesugarCompiler, "prism/desugar_compiler"
autoload :Dispatcher, "prism/dispatcher"
autoload :DotVisitor, "prism/dot_visitor"
autoload :DSL, "prism/dsl"
autoload :LexCompat, "prism/lex_compat"
autoload :LexRipper, "prism/lex_compat"
autoload :MutationCompiler, "prism/mutation_compiler"
autoload :NodeInspector, "prism/node_inspector"
autoload :RipperCompat, "prism/ripper_compat"
autoload :Pack, "prism/pack"
autoload :Pattern, "prism/pattern"
autoload :Serialize, "prism/serialize"
autoload :Visitor, "prism/visitor"
# Some of these constants are not meant to be exposed, so marking them as
# private here.
private_constant :Debug
private_constant :LexCompat
private_constant :LexRipper
# :call-seq:
# Prism::lex_compat(source, **options) -> ParseResult
#
# Returns a parse result whose value is an array of tokens that closely
# resembles the return value of Ripper::lex. The main difference is that the
# `:on_sp` token is not emitted.
#
# For supported options, see Prism::parse.
def self.lex_compat(source, **options)
LexCompat.new(source, **options).result
end
# :call-seq:
# Prism::lex_ripper(source) -> Array
#
# This lexes with the Ripper lex. It drops any space events but otherwise
# returns the same tokens. Raises SyntaxError if the syntax in source is
# invalid.
def self.lex_ripper(source)
LexRipper.new(source).result
end
# :call-seq:
# Prism::load(source, serialized) -> ParseResult
#
# Load the serialized AST using the source as a reference into a tree.
def self.load(source, serialized)
Serialize.load(source, serialized)
end
# :call-seq:
# Prism::parse_failure?(source, **options) -> bool
#
# Returns true if the source parses with errors.
def self.parse_failure?(source, **options)
!parse_success?(source, **options)
end
# :call-seq:
# Prism::parse_file_failure?(filepath, **options) -> bool
#
# Returns true if the file at filepath parses with errors.
def self.parse_file_failure?(filepath, **options)
!parse_file_success?(filepath, **options)
end
end
require_relative "prism/node"
require_relative "prism/node_ext"
require_relative "prism/parse_result"
require_relative "prism/parse_result/comments"
require_relative "prism/parse_result/newlines"
# This is a Ruby implementation of the prism parser. If we're running on CRuby
# and we haven't explicitly set the PRISM_FFI_BACKEND environment variable, then
# it's going to require the built library. Otherwise, it's going to require a
# module that uses FFI to call into the library.
if RUBY_ENGINE == "ruby" and !ENV["PRISM_FFI_BACKEND"]
require "prism/prism"
else
require_relative "prism/ffi"
end
share/ruby/weakref.rb 0000644 00000002554 15173517735 0010624 0 ustar 00 # frozen_string_literal: true
require "delegate"
# Weak Reference class that allows a referenced object to be
# garbage-collected.
#
# A WeakRef may be used exactly like the object it references.
#
# Usage:
#
# foo = Object.new # create a new object instance
# p foo.to_s # original's class
# foo = WeakRef.new(foo) # reassign foo with WeakRef instance
# p foo.to_s # should be same class
# GC.start # start the garbage collector
# p foo.to_s # should raise exception (recycled)
#
class WeakRef < Delegator
VERSION = "0.1.3"
##
# RefError is raised when a referenced object has been recycled by the
# garbage collector
class RefError < StandardError
end
@@__map = ::ObjectSpace::WeakMap.new
##
# Creates a weak reference to +orig+
def initialize(orig)
case orig
when true, false, nil
@delegate_sd_obj = orig
else
@@__map[self] = orig
end
super
end
def __getobj__ # :nodoc:
@@__map[self] or defined?(@delegate_sd_obj) ? @delegate_sd_obj :
Kernel::raise(RefError, "Invalid Reference - probably recycled", Kernel::caller(2))
end
def __setobj__(obj) # :nodoc:
end
##
# Returns true if the referenced object is still alive.
def weakref_alive?
@@__map.key?(self) or defined?(@delegate_sd_obj)
end
end
share/ruby/random/formatter.rb 0000644 00000030541 15173517735 0012460 0 ustar 00 # -*- coding: us-ascii -*-
# frozen_string_literal: true
# == \Random number formatter.
#
# Formats generated random numbers in many manners. When <tt>'random/formatter'</tt>
# is required, several methods are added to empty core module <tt>Random::Formatter</tt>,
# making them available as Random's instance and module methods.
#
# Standard library SecureRandom is also extended with the module, and the methods
# described below are available as a module methods in it.
#
# === Examples
#
# Generate random hexadecimal strings:
#
# require 'random/formatter'
#
# prng = Random.new
# prng.hex(10) #=> "52750b30ffbc7de3b362"
# prng.hex(10) #=> "92b15d6c8dc4beb5f559"
# prng.hex(13) #=> "39b290146bea6ce975c37cfc23"
# # or just
# Random.hex #=> "1aed0c631e41be7f77365415541052ee"
#
# Generate random base64 strings:
#
# prng.base64(10) #=> "EcmTPZwWRAozdA=="
# prng.base64(10) #=> "KO1nIU+p9DKxGg=="
# prng.base64(12) #=> "7kJSM/MzBJI+75j8"
# Random.base64(4) #=> "bsQ3fQ=="
#
# Generate random binary strings:
#
# prng.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
# prng.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
# Random.random_bytes(6) #=> "\xA1\xE6Lr\xC43"
#
# Generate alphanumeric strings:
#
# prng.alphanumeric(10) #=> "S8baxMJnPl"
# prng.alphanumeric(10) #=> "aOxAg8BAJe"
# Random.alphanumeric #=> "TmP9OsJHJLtaZYhP"
#
# Generate UUIDs:
#
# prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
# prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
# Random.uuid #=> "f14e0271-de96-45cc-8911-8910292a42cd"
#
# All methods are available in the standard library SecureRandom, too:
#
# SecureRandom.hex #=> "05b45376a30c67238eb93b16499e50cf"
module Random::Formatter
# Generate a random binary string.
#
# The argument _n_ specifies the length of the result string.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in future.
#
# The result may contain any byte: "\x00" - "\xff".
#
# require 'random/formatter'
#
# Random.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
# # or
# prng = Random.new
# prng.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
def random_bytes(n=nil)
n = n ? n.to_int : 16
gen_random(n)
end
# Generate a random hexadecimal string.
#
# The argument _n_ specifies the length, in bytes, of the random number to be generated.
# The length of the resulting hexadecimal string is twice of _n_.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The result may contain 0-9 and a-f.
#
# require 'random/formatter'
#
# Random.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
# # or
# prng = Random.new
# prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
def hex(n=nil)
random_bytes(n).unpack1("H*")
end
# Generate a random base64 string.
#
# The argument _n_ specifies the length, in bytes, of the random number
# to be generated. The length of the result string is about 4/3 of _n_.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
#
# require 'random/formatter'
#
# Random.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
# # or
# prng = Random.new
# prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
#
# See RFC 3548 for the definition of base64.
def base64(n=nil)
[random_bytes(n)].pack("m0")
end
# Generate a random URL-safe base64 string.
#
# The argument _n_ specifies the length, in bytes, of the random number
# to be generated. The length of the result string is about 4/3 of _n_.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The boolean argument _padding_ specifies the padding.
# If it is false or nil, padding is not generated.
# Otherwise padding is generated.
# By default, padding is not generated because "=" may be used as a URL delimiter.
#
# The result may contain A-Z, a-z, 0-9, "-" and "_".
# "=" is also used if _padding_ is true.
#
# require 'random/formatter'
#
# Random.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
# # or
# prng = Random.new
# prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
#
# prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
# prng.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
#
# See RFC 3548 for the definition of URL-safe base64.
def urlsafe_base64(n=nil, padding=false)
s = [random_bytes(n)].pack("m0")
s.tr!("+/", "-_")
s.delete!("=") unless padding
s
end
# Generate a random v4 UUID (Universally Unique IDentifier).
#
# require 'random/formatter'
#
# Random.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
# Random.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
# # or
# prng = Random.new
# prng.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
#
# The version 4 UUID is purely random (except the version).
# It doesn't contain meaningful information such as MAC addresses, timestamps, etc.
#
# The result contains 122 random bits (15.25 random bytes).
#
# See RFC4122[https://datatracker.ietf.org/doc/html/rfc4122] for details of UUID.
#
def uuid
ary = random_bytes(16).unpack("NnnnnN")
ary[2] = (ary[2] & 0x0fff) | 0x4000
ary[3] = (ary[3] & 0x3fff) | 0x8000
"%08x-%04x-%04x-%04x-%04x%08x" % ary
end
alias uuid_v4 uuid
# Generate a random v7 UUID (Universally Unique IDentifier).
#
# require 'random/formatter'
#
# Random.uuid_v7 # => "0188d4c3-1311-7f96-85c7-242a7aa58f1e"
# Random.uuid_v7 # => "0188d4c3-16fe-744f-86af-38fa04c62bb5"
# Random.uuid_v7 # => "0188d4c3-1af8-764f-b049-c204ce0afa23"
# Random.uuid_v7 # => "0188d4c3-1e74-7085-b14f-ef6415dc6f31"
# # |<--sorted-->| |<----- random ---->|
#
# # or
# prng = Random.new
# prng.uuid_v7 # => "0188ca51-5e72-7950-a11d-def7ff977c98"
#
# The version 7 UUID starts with the least significant 48 bits of a 64 bit
# Unix timestamp (milliseconds since the epoch) and fills the remaining bits
# with random data, excluding the version and variant bits.
#
# This allows version 7 UUIDs to be sorted by creation time. Time ordered
# UUIDs can be used for better database index locality of newly inserted
# records, which may have a significant performance benefit compared to random
# data inserts.
#
# The result contains 74 random bits (9.25 random bytes).
#
# Note that this method cannot be made reproducable because its output
# includes not only random bits but also timestamp.
#
# See draft-ietf-uuidrev-rfc4122bis[https://datatracker.ietf.org/doc/draft-ietf-uuidrev-rfc4122bis/]
# for details of UUIDv7.
#
# ==== Monotonicity
#
# UUIDv7 has millisecond precision by default, so multiple UUIDs created
# within the same millisecond are not issued in monotonically increasing
# order. To create UUIDs that are time-ordered with sub-millisecond
# precision, up to 12 bits of additional timestamp may added with
# +extra_timestamp_bits+. The extra timestamp precision comes at the expense
# of random bits. Setting <tt>extra_timestamp_bits: 12</tt> provides ~244ns
# of precision, but only 62 random bits (7.75 random bytes).
#
# prng = Random.new
# Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 12) }
# # =>
# ["0188d4c7-13da-74f9-8b53-22a786ffdd5a",
# "0188d4c7-13da-753b-83a5-7fb9b2afaeea",
# "0188d4c7-13da-754a-88ea-ac0baeedd8db",
# "0188d4c7-13da-7557-83e1-7cad9cda0d8d"]
# # |<--- sorted --->| |<-- random --->|
#
# Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 8) }
# # =>
# ["0188d4c7-3333-7a95-850a-de6edb858f7e",
# "0188d4c7-3333-7ae8-842e-bc3a8b7d0cf9", # <- out of order
# "0188d4c7-3333-7ae2-995a-9f135dc44ead", # <- out of order
# "0188d4c7-3333-7af9-87c3-8f612edac82e"]
# # |<--- sorted -->||<---- random --->|
#
# Any rollbacks of the system clock will break monotonicity. UUIDv7 is based
# on UTC, which excludes leap seconds and can rollback the clock. To avoid
# this, the system clock can synchronize with an NTP server configured to use
# a "leap smear" approach. NTP or PTP will also be needed to synchronize
# across distributed nodes.
#
# Counters and other mechanisms for stronger guarantees of monotonicity are
# not implemented. Applications with stricter requirements should follow
# {Section 6.2}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-07.html#monotonicity_counters]
# of the specification.
#
def uuid_v7(extra_timestamp_bits: 0)
case (extra_timestamp_bits = Integer(extra_timestamp_bits))
when 0 # min timestamp precision
ms = Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond)
rand = random_bytes(10)
rand.setbyte(0, rand.getbyte(0) & 0x0f | 0x70) # version
rand.setbyte(2, rand.getbyte(2) & 0x3f | 0x80) # variant
"%08x-%04x-%s" % [
(ms & 0x0000_ffff_ffff_0000) >> 16,
(ms & 0x0000_0000_0000_ffff),
rand.unpack("H4H4H12").join("-")
]
when 12 # max timestamp precision
ms, ns = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
.divmod(1_000_000)
extra_bits = ns * 4096 / 1_000_000
rand = random_bytes(8)
rand.setbyte(0, rand.getbyte(0) & 0x3f | 0x80) # variant
"%08x-%04x-7%03x-%s" % [
(ms & 0x0000_ffff_ffff_0000) >> 16,
(ms & 0x0000_0000_0000_ffff),
extra_bits,
rand.unpack("H4H12").join("-")
]
when (0..12) # the generic version is slower than the special cases above
rand_a, rand_b1, rand_b2, rand_b3 = random_bytes(10).unpack("nnnN")
rand_mask_bits = 12 - extra_timestamp_bits
ms, ns = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
.divmod(1_000_000)
"%08x-%04x-%04x-%04x-%04x%08x" % [
(ms & 0x0000_ffff_ffff_0000) >> 16,
(ms & 0x0000_0000_0000_ffff),
0x7000 |
((ns * (1 << extra_timestamp_bits) / 1_000_000) << rand_mask_bits) |
rand_a & ((1 << rand_mask_bits) - 1),
0x8000 | (rand_b1 & 0x3fff),
rand_b2,
rand_b3
]
else
raise ArgumentError, "extra_timestamp_bits must be in 0..12"
end
end
# Internal interface to Random; Generate random data _n_ bytes.
private def gen_random(n)
self.bytes(n)
end
# Generate a string that randomly draws from a
# source array of characters.
#
# The argument _source_ specifies the array of characters from which
# to generate the string.
# The argument _n_ specifies the length, in characters, of the string to be
# generated.
#
# The result may contain whatever characters are in the source array.
#
# require 'random/formatter'
#
# prng.choose([*'l'..'r'], 16) #=> "lmrqpoonmmlqlron"
# prng.choose([*'0'..'9'], 5) #=> "27309"
private def choose(source, n)
size = source.size
m = 1
limit = size
while limit * size <= 0x100000000
limit *= size
m += 1
end
result = ''.dup
while m <= n
rs = random_number(limit)
is = rs.digits(size)
(m-is.length).times { is << 0 }
result << source.values_at(*is).join('')
n -= m
end
if 0 < n
rs = random_number(limit)
is = rs.digits(size)
if is.length < n
(n-is.length).times { is << 0 }
else
is.pop while n < is.length
end
result.concat source.values_at(*is).join('')
end
result
end
# The default character list for #alphanumeric.
ALPHANUMERIC = [*'A'..'Z', *'a'..'z', *'0'..'9']
# Generate a random alphanumeric string.
#
# The argument _n_ specifies the length, in characters, of the alphanumeric
# string to be generated.
# The argument _chars_ specifies the character list which the result is
# consist of.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The result may contain A-Z, a-z and 0-9, unless _chars_ is specified.
#
# require 'random/formatter'
#
# Random.alphanumeric #=> "2BuBuLf3WfSKyQbR"
# # or
# prng = Random.new
# prng.alphanumeric(10) #=> "i6K93NdqiH"
#
# Random.alphanumeric(4, chars: [*"0".."9"]) #=> "2952"
# # or
# prng = Random.new
# prng.alphanumeric(10, chars: [*"!".."/"]) #=> ",.,++%/''."
def alphanumeric(n = nil, chars: ALPHANUMERIC)
n = 16 if n.nil?
choose(chars, n)
end
end
share/gems/gems/json-2.7.2/lib/json.rb 0000644 00000047171 15173517735 0013245 0 ustar 00 #frozen_string_literal: false
require 'json/common'
##
# = JavaScript \Object Notation (\JSON)
#
# \JSON is a lightweight data-interchange format.
#
# A \JSON value is one of the following:
# - Double-quoted text: <tt>"foo"</tt>.
# - Number: +1+, +1.0+, +2.0e2+.
# - Boolean: +true+, +false+.
# - Null: +null+.
# - \Array: an ordered list of values, enclosed by square brackets:
# ["foo", 1, 1.0, 2.0e2, true, false, null]
#
# - \Object: a collection of name/value pairs, enclosed by curly braces;
# each name is double-quoted text;
# the values may be any \JSON values:
# {"a": "foo", "b": 1, "c": 1.0, "d": 2.0e2, "e": true, "f": false, "g": null}
#
# A \JSON array or object may contain nested arrays, objects, and scalars
# to any depth:
# {"foo": {"bar": 1, "baz": 2}, "bat": [0, 1, 2]}
# [{"foo": 0, "bar": 1}, ["baz", 2]]
#
# == Using \Module \JSON
#
# To make module \JSON available in your code, begin with:
# require 'json'
#
# All examples here assume that this has been done.
#
# === Parsing \JSON
#
# You can parse a \String containing \JSON data using
# either of two methods:
# - <tt>JSON.parse(source, opts)</tt>
# - <tt>JSON.parse!(source, opts)</tt>
#
# where
# - +source+ is a Ruby object.
# - +opts+ is a \Hash object containing options
# that control both input allowed and output formatting.
#
# The difference between the two methods
# is that JSON.parse! omits some checks
# and may not be safe for some +source+ data;
# use it only for data from trusted sources.
# Use the safer method JSON.parse for less trusted sources.
#
# ==== Parsing \JSON Arrays
#
# When +source+ is a \JSON array, JSON.parse by default returns a Ruby \Array:
# json = '["foo", 1, 1.0, 2.0e2, true, false, null]'
# ruby = JSON.parse(json)
# ruby # => ["foo", 1, 1.0, 200.0, true, false, nil]
# ruby.class # => Array
#
# The \JSON array may contain nested arrays, objects, and scalars
# to any depth:
# json = '[{"foo": 0, "bar": 1}, ["baz", 2]]'
# JSON.parse(json) # => [{"foo"=>0, "bar"=>1}, ["baz", 2]]
#
# ==== Parsing \JSON \Objects
#
# When the source is a \JSON object, JSON.parse by default returns a Ruby \Hash:
# json = '{"a": "foo", "b": 1, "c": 1.0, "d": 2.0e2, "e": true, "f": false, "g": null}'
# ruby = JSON.parse(json)
# ruby # => {"a"=>"foo", "b"=>1, "c"=>1.0, "d"=>200.0, "e"=>true, "f"=>false, "g"=>nil}
# ruby.class # => Hash
#
# The \JSON object may contain nested arrays, objects, and scalars
# to any depth:
# json = '{"foo": {"bar": 1, "baz": 2}, "bat": [0, 1, 2]}'
# JSON.parse(json) # => {"foo"=>{"bar"=>1, "baz"=>2}, "bat"=>[0, 1, 2]}
#
# ==== Parsing \JSON Scalars
#
# When the source is a \JSON scalar (not an array or object),
# JSON.parse returns a Ruby scalar.
#
# \String:
# ruby = JSON.parse('"foo"')
# ruby # => 'foo'
# ruby.class # => String
# \Integer:
# ruby = JSON.parse('1')
# ruby # => 1
# ruby.class # => Integer
# \Float:
# ruby = JSON.parse('1.0')
# ruby # => 1.0
# ruby.class # => Float
# ruby = JSON.parse('2.0e2')
# ruby # => 200
# ruby.class # => Float
# Boolean:
# ruby = JSON.parse('true')
# ruby # => true
# ruby.class # => TrueClass
# ruby = JSON.parse('false')
# ruby # => false
# ruby.class # => FalseClass
# Null:
# ruby = JSON.parse('null')
# ruby # => nil
# ruby.class # => NilClass
#
# ==== Parsing Options
#
# ====== Input Options
#
# Option +max_nesting+ (\Integer) specifies the maximum nesting depth allowed;
# defaults to +100+; specify +false+ to disable depth checking.
#
# With the default, +false+:
# source = '[0, [1, [2, [3]]]]'
# ruby = JSON.parse(source)
# ruby # => [0, [1, [2, [3]]]]
# Too deep:
# # Raises JSON::NestingError (nesting of 2 is too deep):
# JSON.parse(source, {max_nesting: 1})
# Bad value:
# # Raises TypeError (wrong argument type Symbol (expected Fixnum)):
# JSON.parse(source, {max_nesting: :foo})
#
# ---
#
# Option +allow_nan+ (boolean) specifies whether to allow
# NaN, Infinity, and MinusInfinity in +source+;
# defaults to +false+.
#
# With the default, +false+:
# # Raises JSON::ParserError (225: unexpected token at '[NaN]'):
# JSON.parse('[NaN]')
# # Raises JSON::ParserError (232: unexpected token at '[Infinity]'):
# JSON.parse('[Infinity]')
# # Raises JSON::ParserError (248: unexpected token at '[-Infinity]'):
# JSON.parse('[-Infinity]')
# Allow:
# source = '[NaN, Infinity, -Infinity]'
# ruby = JSON.parse(source, {allow_nan: true})
# ruby # => [NaN, Infinity, -Infinity]
#
# ====== Output Options
#
# Option +symbolize_names+ (boolean) specifies whether returned \Hash keys
# should be Symbols;
# defaults to +false+ (use Strings).
#
# With the default, +false+:
# source = '{"a": "foo", "b": 1.0, "c": true, "d": false, "e": null}'
# ruby = JSON.parse(source)
# ruby # => {"a"=>"foo", "b"=>1.0, "c"=>true, "d"=>false, "e"=>nil}
# Use Symbols:
# ruby = JSON.parse(source, {symbolize_names: true})
# ruby # => {:a=>"foo", :b=>1.0, :c=>true, :d=>false, :e=>nil}
#
# ---
#
# Option +object_class+ (\Class) specifies the Ruby class to be used
# for each \JSON object;
# defaults to \Hash.
#
# With the default, \Hash:
# source = '{"a": "foo", "b": 1.0, "c": true, "d": false, "e": null}'
# ruby = JSON.parse(source)
# ruby.class # => Hash
# Use class \OpenStruct:
# ruby = JSON.parse(source, {object_class: OpenStruct})
# ruby # => #<OpenStruct a="foo", b=1.0, c=true, d=false, e=nil>
#
# ---
#
# Option +array_class+ (\Class) specifies the Ruby class to be used
# for each \JSON array;
# defaults to \Array.
#
# With the default, \Array:
# source = '["foo", 1.0, true, false, null]'
# ruby = JSON.parse(source)
# ruby.class # => Array
# Use class \Set:
# ruby = JSON.parse(source, {array_class: Set})
# ruby # => #<Set: {"foo", 1.0, true, false, nil}>
#
# ---
#
# Option +create_additions+ (boolean) specifies whether to use \JSON additions in parsing.
# See {\JSON Additions}[#module-JSON-label-JSON+Additions].
#
# === Generating \JSON
#
# To generate a Ruby \String containing \JSON data,
# use method <tt>JSON.generate(source, opts)</tt>, where
# - +source+ is a Ruby object.
# - +opts+ is a \Hash object containing options
# that control both input allowed and output formatting.
#
# ==== Generating \JSON from Arrays
#
# When the source is a Ruby \Array, JSON.generate returns
# a \String containing a \JSON array:
# ruby = [0, 's', :foo]
# json = JSON.generate(ruby)
# json # => '[0,"s","foo"]'
#
# The Ruby \Array array may contain nested arrays, hashes, and scalars
# to any depth:
# ruby = [0, [1, 2], {foo: 3, bar: 4}]
# json = JSON.generate(ruby)
# json # => '[0,[1,2],{"foo":3,"bar":4}]'
#
# ==== Generating \JSON from Hashes
#
# When the source is a Ruby \Hash, JSON.generate returns
# a \String containing a \JSON object:
# ruby = {foo: 0, bar: 's', baz: :bat}
# json = JSON.generate(ruby)
# json # => '{"foo":0,"bar":"s","baz":"bat"}'
#
# The Ruby \Hash array may contain nested arrays, hashes, and scalars
# to any depth:
# ruby = {foo: [0, 1], bar: {baz: 2, bat: 3}, bam: :bad}
# json = JSON.generate(ruby)
# json # => '{"foo":[0,1],"bar":{"baz":2,"bat":3},"bam":"bad"}'
#
# ==== Generating \JSON from Other Objects
#
# When the source is neither an \Array nor a \Hash,
# the generated \JSON data depends on the class of the source.
#
# When the source is a Ruby \Integer or \Float, JSON.generate returns
# a \String containing a \JSON number:
# JSON.generate(42) # => '42'
# JSON.generate(0.42) # => '0.42'
#
# When the source is a Ruby \String, JSON.generate returns
# a \String containing a \JSON string (with double-quotes):
# JSON.generate('A string') # => '"A string"'
#
# When the source is +true+, +false+ or +nil+, JSON.generate returns
# a \String containing the corresponding \JSON token:
# JSON.generate(true) # => 'true'
# JSON.generate(false) # => 'false'
# JSON.generate(nil) # => 'null'
#
# When the source is none of the above, JSON.generate returns
# a \String containing a \JSON string representation of the source:
# JSON.generate(:foo) # => '"foo"'
# JSON.generate(Complex(0, 0)) # => '"0+0i"'
# JSON.generate(Dir.new('.')) # => '"#<Dir>"'
#
# ==== Generating Options
#
# ====== Input Options
#
# Option +allow_nan+ (boolean) specifies whether
# +NaN+, +Infinity+, and <tt>-Infinity</tt> may be generated;
# defaults to +false+.
#
# With the default, +false+:
# # Raises JSON::GeneratorError (920: NaN not allowed in JSON):
# JSON.generate(JSON::NaN)
# # Raises JSON::GeneratorError (917: Infinity not allowed in JSON):
# JSON.generate(JSON::Infinity)
# # Raises JSON::GeneratorError (917: -Infinity not allowed in JSON):
# JSON.generate(JSON::MinusInfinity)
#
# Allow:
# ruby = [Float::NaN, Float::Infinity, Float::MinusInfinity]
# JSON.generate(ruby, allow_nan: true) # => '[NaN,Infinity,-Infinity]'
#
# ---
#
# Option +max_nesting+ (\Integer) specifies the maximum nesting depth
# in +obj+; defaults to +100+.
#
# With the default, +100+:
# obj = [[[[[[0]]]]]]
# JSON.generate(obj) # => '[[[[[[0]]]]]]'
#
# Too deep:
# # Raises JSON::NestingError (nesting of 2 is too deep):
# JSON.generate(obj, max_nesting: 2)
#
# ====== Escaping Options
#
# Options +script_safe+ (boolean) specifies wether <tt>'\u2028'</tt>, <tt>'\u2029'</tt>
# and <tt>'/'</tt> should be escaped as to make the JSON object safe to interpolate in script
# tags.
#
# Options +ascii_only+ (boolean) specifies wether all characters outside the ASCII range
# should be escaped.
#
# ====== Output Options
#
# The default formatting options generate the most compact
# \JSON data, all on one line and with no whitespace.
#
# You can use these formatting options to generate
# \JSON data in a more open format, using whitespace.
# See also JSON.pretty_generate.
#
# - Option +array_nl+ (\String) specifies a string (usually a newline)
# to be inserted after each \JSON array; defaults to the empty \String, <tt>''</tt>.
# - Option +object_nl+ (\String) specifies a string (usually a newline)
# to be inserted after each \JSON object; defaults to the empty \String, <tt>''</tt>.
# - Option +indent+ (\String) specifies the string (usually spaces) to be
# used for indentation; defaults to the empty \String, <tt>''</tt>;
# defaults to the empty \String, <tt>''</tt>;
# has no effect unless options +array_nl+ or +object_nl+ specify newlines.
# - Option +space+ (\String) specifies a string (usually a space) to be
# inserted after the colon in each \JSON object's pair;
# defaults to the empty \String, <tt>''</tt>.
# - Option +space_before+ (\String) specifies a string (usually a space) to be
# inserted before the colon in each \JSON object's pair;
# defaults to the empty \String, <tt>''</tt>.
#
# In this example, +obj+ is used first to generate the shortest
# \JSON data (no whitespace), then again with all formatting options
# specified:
#
# obj = {foo: [:bar, :baz], bat: {bam: 0, bad: 1}}
# json = JSON.generate(obj)
# puts 'Compact:', json
# opts = {
# array_nl: "\n",
# object_nl: "\n",
# indent: ' ',
# space_before: ' ',
# space: ' '
# }
# puts 'Open:', JSON.generate(obj, opts)
#
# Output:
# Compact:
# {"foo":["bar","baz"],"bat":{"bam":0,"bad":1}}
# Open:
# {
# "foo" : [
# "bar",
# "baz"
# ],
# "bat" : {
# "bam" : 0,
# "bad" : 1
# }
# }
#
# == \JSON Additions
#
# When you "round trip" a non-\String object from Ruby to \JSON and back,
# you have a new \String, instead of the object you began with:
# ruby0 = Range.new(0, 2)
# json = JSON.generate(ruby0)
# json # => '0..2"'
# ruby1 = JSON.parse(json)
# ruby1 # => '0..2'
# ruby1.class # => String
#
# You can use \JSON _additions_ to preserve the original object.
# The addition is an extension of a ruby class, so that:
# - \JSON.generate stores more information in the \JSON string.
# - \JSON.parse, called with option +create_additions+,
# uses that information to create a proper Ruby object.
#
# This example shows a \Range being generated into \JSON
# and parsed back into Ruby, both without and with
# the addition for \Range:
# ruby = Range.new(0, 2)
# # This passage does not use the addition for Range.
# json0 = JSON.generate(ruby)
# ruby0 = JSON.parse(json0)
# # This passage uses the addition for Range.
# require 'json/add/range'
# json1 = JSON.generate(ruby)
# ruby1 = JSON.parse(json1, create_additions: true)
# # Make a nice display.
# display = <<EOT
# Generated JSON:
# Without addition: #{json0} (#{json0.class})
# With addition: #{json1} (#{json1.class})
# Parsed JSON:
# Without addition: #{ruby0.inspect} (#{ruby0.class})
# With addition: #{ruby1.inspect} (#{ruby1.class})
# EOT
# puts display
#
# This output shows the different results:
# Generated JSON:
# Without addition: "0..2" (String)
# With addition: {"json_class":"Range","a":[0,2,false]} (String)
# Parsed JSON:
# Without addition: "0..2" (String)
# With addition: 0..2 (Range)
#
# The \JSON module includes additions for certain classes.
# You can also craft custom additions.
# See {Custom \JSON Additions}[#module-JSON-label-Custom+JSON+Additions].
#
# === Built-in Additions
#
# The \JSON module includes additions for certain classes.
# To use an addition, +require+ its source:
# - BigDecimal: <tt>require 'json/add/bigdecimal'</tt>
# - Complex: <tt>require 'json/add/complex'</tt>
# - Date: <tt>require 'json/add/date'</tt>
# - DateTime: <tt>require 'json/add/date_time'</tt>
# - Exception: <tt>require 'json/add/exception'</tt>
# - OpenStruct: <tt>require 'json/add/ostruct'</tt>
# - Range: <tt>require 'json/add/range'</tt>
# - Rational: <tt>require 'json/add/rational'</tt>
# - Regexp: <tt>require 'json/add/regexp'</tt>
# - Set: <tt>require 'json/add/set'</tt>
# - Struct: <tt>require 'json/add/struct'</tt>
# - Symbol: <tt>require 'json/add/symbol'</tt>
# - Time: <tt>require 'json/add/time'</tt>
#
# To reduce punctuation clutter, the examples below
# show the generated \JSON via +puts+, rather than the usual +inspect+,
#
# \BigDecimal:
# require 'json/add/bigdecimal'
# ruby0 = BigDecimal(0) # 0.0
# json = JSON.generate(ruby0) # {"json_class":"BigDecimal","b":"27:0.0"}
# ruby1 = JSON.parse(json, create_additions: true) # 0.0
# ruby1.class # => BigDecimal
#
# \Complex:
# require 'json/add/complex'
# ruby0 = Complex(1+0i) # 1+0i
# json = JSON.generate(ruby0) # {"json_class":"Complex","r":1,"i":0}
# ruby1 = JSON.parse(json, create_additions: true) # 1+0i
# ruby1.class # Complex
#
# \Date:
# require 'json/add/date'
# ruby0 = Date.today # 2020-05-02
# json = JSON.generate(ruby0) # {"json_class":"Date","y":2020,"m":5,"d":2,"sg":2299161.0}
# ruby1 = JSON.parse(json, create_additions: true) # 2020-05-02
# ruby1.class # Date
#
# \DateTime:
# require 'json/add/date_time'
# ruby0 = DateTime.now # 2020-05-02T10:38:13-05:00
# json = JSON.generate(ruby0) # {"json_class":"DateTime","y":2020,"m":5,"d":2,"H":10,"M":38,"S":13,"of":"-5/24","sg":2299161.0}
# ruby1 = JSON.parse(json, create_additions: true) # 2020-05-02T10:38:13-05:00
# ruby1.class # DateTime
#
# \Exception (and its subclasses including \RuntimeError):
# require 'json/add/exception'
# ruby0 = Exception.new('A message') # A message
# json = JSON.generate(ruby0) # {"json_class":"Exception","m":"A message","b":null}
# ruby1 = JSON.parse(json, create_additions: true) # A message
# ruby1.class # Exception
# ruby0 = RuntimeError.new('Another message') # Another message
# json = JSON.generate(ruby0) # {"json_class":"RuntimeError","m":"Another message","b":null}
# ruby1 = JSON.parse(json, create_additions: true) # Another message
# ruby1.class # RuntimeError
#
# \OpenStruct:
# require 'json/add/ostruct'
# ruby0 = OpenStruct.new(name: 'Matz', language: 'Ruby') # #<OpenStruct name="Matz", language="Ruby">
# json = JSON.generate(ruby0) # {"json_class":"OpenStruct","t":{"name":"Matz","language":"Ruby"}}
# ruby1 = JSON.parse(json, create_additions: true) # #<OpenStruct name="Matz", language="Ruby">
# ruby1.class # OpenStruct
#
# \Range:
# require 'json/add/range'
# ruby0 = Range.new(0, 2) # 0..2
# json = JSON.generate(ruby0) # {"json_class":"Range","a":[0,2,false]}
# ruby1 = JSON.parse(json, create_additions: true) # 0..2
# ruby1.class # Range
#
# \Rational:
# require 'json/add/rational'
# ruby0 = Rational(1, 3) # 1/3
# json = JSON.generate(ruby0) # {"json_class":"Rational","n":1,"d":3}
# ruby1 = JSON.parse(json, create_additions: true) # 1/3
# ruby1.class # Rational
#
# \Regexp:
# require 'json/add/regexp'
# ruby0 = Regexp.new('foo') # (?-mix:foo)
# json = JSON.generate(ruby0) # {"json_class":"Regexp","o":0,"s":"foo"}
# ruby1 = JSON.parse(json, create_additions: true) # (?-mix:foo)
# ruby1.class # Regexp
#
# \Set:
# require 'json/add/set'
# ruby0 = Set.new([0, 1, 2]) # #<Set: {0, 1, 2}>
# json = JSON.generate(ruby0) # {"json_class":"Set","a":[0,1,2]}
# ruby1 = JSON.parse(json, create_additions: true) # #<Set: {0, 1, 2}>
# ruby1.class # Set
#
# \Struct:
# require 'json/add/struct'
# Customer = Struct.new(:name, :address) # Customer
# ruby0 = Customer.new("Dave", "123 Main") # #<struct Customer name="Dave", address="123 Main">
# json = JSON.generate(ruby0) # {"json_class":"Customer","v":["Dave","123 Main"]}
# ruby1 = JSON.parse(json, create_additions: true) # #<struct Customer name="Dave", address="123 Main">
# ruby1.class # Customer
#
# \Symbol:
# require 'json/add/symbol'
# ruby0 = :foo # foo
# json = JSON.generate(ruby0) # {"json_class":"Symbol","s":"foo"}
# ruby1 = JSON.parse(json, create_additions: true) # foo
# ruby1.class # Symbol
#
# \Time:
# require 'json/add/time'
# ruby0 = Time.now # 2020-05-02 11:28:26 -0500
# json = JSON.generate(ruby0) # {"json_class":"Time","s":1588436906,"n":840560000}
# ruby1 = JSON.parse(json, create_additions: true) # 2020-05-02 11:28:26 -0500
# ruby1.class # Time
#
#
# === Custom \JSON Additions
#
# In addition to the \JSON additions provided,
# you can craft \JSON additions of your own,
# either for Ruby built-in classes or for user-defined classes.
#
# Here's a user-defined class +Foo+:
# class Foo
# attr_accessor :bar, :baz
# def initialize(bar, baz)
# self.bar = bar
# self.baz = baz
# end
# end
#
# Here's the \JSON addition for it:
# # Extend class Foo with JSON addition.
# class Foo
# # Serialize Foo object with its class name and arguments
# def to_json(*args)
# {
# JSON.create_id => self.class.name,
# 'a' => [ bar, baz ]
# }.to_json(*args)
# end
# # Deserialize JSON string by constructing new Foo object with arguments.
# def self.json_create(object)
# new(*object['a'])
# end
# end
#
# Demonstration:
# require 'json'
# # This Foo object has no custom addition.
# foo0 = Foo.new(0, 1)
# json0 = JSON.generate(foo0)
# obj0 = JSON.parse(json0)
# # Lood the custom addition.
# require_relative 'foo_addition'
# # This foo has the custom addition.
# foo1 = Foo.new(0, 1)
# json1 = JSON.generate(foo1)
# obj1 = JSON.parse(json1, create_additions: true)
# # Make a nice display.
# display = <<EOT
# Generated JSON:
# Without custom addition: #{json0} (#{json0.class})
# With custom addition: #{json1} (#{json1.class})
# Parsed JSON:
# Without custom addition: #{obj0.inspect} (#{obj0.class})
# With custom addition: #{obj1.inspect} (#{obj1.class})
# EOT
# puts display
#
# Output:
#
# Generated JSON:
# Without custom addition: "#<Foo:0x0000000006534e80>" (String)
# With custom addition: {"json_class":"Foo","a":[0,1]} (String)
# Parsed JSON:
# Without custom addition: "#<Foo:0x0000000006534e80>" (String)
# With custom addition: #<Foo:0x0000000006473bb8 @bar=0, @baz=1> (Foo)
#
module JSON
require 'json/version'
begin
require 'json/ext'
rescue LoadError
require 'json/pure'
end
end
share/ruby/prettyprint.rb 0000644 00000037666 15173517735 0011620 0 ustar 00 # frozen_string_literal: true
#
# This class implements a pretty printing algorithm. It finds line breaks and
# nice indentations for grouped structure.
#
# By default, the class assumes that primitive elements are strings and each
# byte in the strings have single column in width. But it can be used for
# other situations by giving suitable arguments for some methods:
# * newline object and space generation block for PrettyPrint.new
# * optional width argument for PrettyPrint#text
# * PrettyPrint#breakable
#
# There are several candidate uses:
# * text formatting using proportional fonts
# * multibyte characters which has columns different to number of bytes
# * non-string formatting
#
# == Bugs
# * Box based formatting?
# * Other (better) model/algorithm?
#
# Report any bugs at http://bugs.ruby-lang.org
#
# == References
# Christian Lindig, Strictly Pretty, March 2000,
# https://lindig.github.io/papers/strictly-pretty-2000.pdf
#
# Philip Wadler, A prettier printer, March 1998,
# https://homepages.inf.ed.ac.uk/wadler/topics/language-design.html#prettier
#
# == Author
# Tanaka Akira <akr@fsij.org>
#
class PrettyPrint
VERSION = "0.2.0"
# This is a convenience method which is same as follows:
#
# begin
# q = PrettyPrint.new(output, maxwidth, newline, &genspace)
# ...
# q.flush
# output
# end
#
def PrettyPrint.format(output=''.dup, maxwidth=79, newline="\n", genspace=lambda {|n| ' ' * n})
q = PrettyPrint.new(output, maxwidth, newline, &genspace)
yield q
q.flush
output
end
# This is similar to PrettyPrint::format but the result has no breaks.
#
# +maxwidth+, +newline+ and +genspace+ are ignored.
#
# The invocation of +breakable+ in the block doesn't break a line and is
# treated as just an invocation of +text+.
#
def PrettyPrint.singleline_format(output=''.dup, maxwidth=nil, newline=nil, genspace=nil)
q = SingleLine.new(output)
yield q
output
end
# Creates a buffer for pretty printing.
#
# +output+ is an output target. If it is not specified, '' is assumed. It
# should have a << method which accepts the first argument +obj+ of
# PrettyPrint#text, the first argument +sep+ of PrettyPrint#breakable, the
# first argument +newline+ of PrettyPrint.new, and the result of a given
# block for PrettyPrint.new.
#
# +maxwidth+ specifies maximum line length. If it is not specified, 79 is
# assumed. However actual outputs may overflow +maxwidth+ if long
# non-breakable texts are provided.
#
# +newline+ is used for line breaks. "\n" is used if it is not specified.
#
# The block is used to generate spaces. {|width| ' ' * width} is used if it
# is not given.
#
def initialize(output=''.dup, maxwidth=79, newline="\n", &genspace)
@output = output
@maxwidth = maxwidth
@newline = newline
@genspace = genspace || lambda {|n| ' ' * n}
@output_width = 0
@buffer_width = 0
@buffer = []
root_group = Group.new(0)
@group_stack = [root_group]
@group_queue = GroupQueue.new(root_group)
@indent = 0
end
# The output object.
#
# This defaults to '', and should accept the << method
attr_reader :output
# The maximum width of a line, before it is separated in to a newline
#
# This defaults to 79, and should be an Integer
attr_reader :maxwidth
# The value that is appended to +output+ to add a new line.
#
# This defaults to "\n", and should be String
attr_reader :newline
# A lambda or Proc, that takes one argument, of an Integer, and returns
# the corresponding number of spaces.
#
# By default this is:
# lambda {|n| ' ' * n}
attr_reader :genspace
# The number of spaces to be indented
attr_reader :indent
# The PrettyPrint::GroupQueue of groups in stack to be pretty printed
attr_reader :group_queue
# Returns the group most recently added to the stack.
#
# Contrived example:
# out = ""
# => ""
# q = PrettyPrint.new(out)
# => #<PrettyPrint:0x82f85c0 @output="", @maxwidth=79, @newline="\n", @genspace=#<Proc:0x82f8368@/home/vbatts/.rvm/rubies/ruby-head/lib/ruby/2.0.0/prettyprint.rb:82 (lambda)>, @output_width=0, @buffer_width=0, @buffer=[], @group_stack=[#<PrettyPrint::Group:0x82f8138 @depth=0, @breakables=[], @break=false>], @group_queue=#<PrettyPrint::GroupQueue:0x82fb7c0 @queue=[[#<PrettyPrint::Group:0x82f8138 @depth=0, @breakables=[], @break=false>]]>, @indent=0>
# q.group {
# q.text q.current_group.inspect
# q.text q.newline
# q.group(q.current_group.depth + 1) {
# q.text q.current_group.inspect
# q.text q.newline
# q.group(q.current_group.depth + 1) {
# q.text q.current_group.inspect
# q.text q.newline
# q.group(q.current_group.depth + 1) {
# q.text q.current_group.inspect
# q.text q.newline
# }
# }
# }
# }
# => 284
# puts out
# #<PrettyPrint::Group:0x8354758 @depth=1, @breakables=[], @break=false>
# #<PrettyPrint::Group:0x8354550 @depth=2, @breakables=[], @break=false>
# #<PrettyPrint::Group:0x83541cc @depth=3, @breakables=[], @break=false>
# #<PrettyPrint::Group:0x8347e54 @depth=4, @breakables=[], @break=false>
def current_group
@group_stack.last
end
# Breaks the buffer into lines that are shorter than #maxwidth
def break_outmost_groups
while @maxwidth < @output_width + @buffer_width
return unless group = @group_queue.deq
until group.breakables.empty?
data = @buffer.shift
@output_width = data.output(@output, @output_width)
@buffer_width -= data.width
end
while !@buffer.empty? && Text === @buffer.first
text = @buffer.shift
@output_width = text.output(@output, @output_width)
@buffer_width -= text.width
end
end
end
# This adds +obj+ as a text of +width+ columns in width.
#
# If +width+ is not specified, obj.length is used.
#
def text(obj, width=obj.length)
if @buffer.empty?
@output << obj
@output_width += width
else
text = @buffer.last
unless Text === text
text = Text.new
@buffer << text
end
text.add(obj, width)
@buffer_width += width
break_outmost_groups
end
end
# This is similar to #breakable except
# the decision to break or not is determined individually.
#
# Two #fill_breakable under a group may cause 4 results:
# (break,break), (break,non-break), (non-break,break), (non-break,non-break).
# This is different to #breakable because two #breakable under a group
# may cause 2 results:
# (break,break), (non-break,non-break).
#
# The text +sep+ is inserted if a line is not broken at this point.
#
# If +sep+ is not specified, " " is used.
#
# If +width+ is not specified, +sep.length+ is used. You will have to
# specify this when +sep+ is a multibyte character, for example.
#
def fill_breakable(sep=' ', width=sep.length)
group { breakable sep, width }
end
# This says "you can break a line here if necessary", and a +width+\-column
# text +sep+ is inserted if a line is not broken at the point.
#
# If +sep+ is not specified, " " is used.
#
# If +width+ is not specified, +sep.length+ is used. You will have to
# specify this when +sep+ is a multibyte character, for example.
#
def breakable(sep=' ', width=sep.length)
group = @group_stack.last
if group.break?
flush
@output << @newline
@output << @genspace.call(@indent)
@output_width = @indent
@buffer_width = 0
else
@buffer << Breakable.new(sep, width, self)
@buffer_width += width
break_outmost_groups
end
end
# Groups line break hints added in the block. The line break hints are all
# to be used or not.
#
# If +indent+ is specified, the method call is regarded as nested by
# nest(indent) { ... }.
#
# If +open_obj+ is specified, <tt>text open_obj, open_width</tt> is called
# before grouping. If +close_obj+ is specified, <tt>text close_obj,
# close_width</tt> is called after grouping.
#
def group(indent=0, open_obj='', close_obj='', open_width=open_obj.length, close_width=close_obj.length)
text open_obj, open_width
group_sub {
nest(indent) {
yield
}
}
text close_obj, close_width
end
# Takes a block and queues a new group that is indented 1 level further.
def group_sub
group = Group.new(@group_stack.last.depth + 1)
@group_stack.push group
@group_queue.enq group
begin
yield
ensure
@group_stack.pop
if group.breakables.empty?
@group_queue.delete group
end
end
end
# Increases left margin after newline with +indent+ for line breaks added in
# the block.
#
def nest(indent)
@indent += indent
begin
yield
ensure
@indent -= indent
end
end
# outputs buffered data.
#
def flush
@buffer.each {|data|
@output_width = data.output(@output, @output_width)
}
@buffer.clear
@buffer_width = 0
end
# The Text class is the means by which to collect strings from objects.
#
# This class is intended for internal use of the PrettyPrint buffers.
class Text # :nodoc:
# Creates a new text object.
#
# This constructor takes no arguments.
#
# The workflow is to append a PrettyPrint::Text object to the buffer, and
# being able to call the buffer.last() to reference it.
#
# As there are objects, use PrettyPrint::Text#add to include the objects
# and the width to utilized by the String version of this object.
def initialize
@objs = []
@width = 0
end
# The total width of the objects included in this Text object.
attr_reader :width
# Render the String text of the objects that have been added to this Text object.
#
# Output the text to +out+, and increment the width to +output_width+
def output(out, output_width)
@objs.each {|obj| out << obj}
output_width + @width
end
# Include +obj+ in the objects to be pretty printed, and increment
# this Text object's total width by +width+
def add(obj, width)
@objs << obj
@width += width
end
end
# The Breakable class is used for breaking up object information
#
# This class is intended for internal use of the PrettyPrint buffers.
class Breakable # :nodoc:
# Create a new Breakable object.
#
# Arguments:
# * +sep+ String of the separator
# * +width+ Integer width of the +sep+
# * +q+ parent PrettyPrint object, to base from
def initialize(sep, width, q)
@obj = sep
@width = width
@pp = q
@indent = q.indent
@group = q.current_group
@group.breakables.push self
end
# Holds the separator String
#
# The +sep+ argument from ::new
attr_reader :obj
# The width of +obj+ / +sep+
attr_reader :width
# The number of spaces to indent.
#
# This is inferred from +q+ within PrettyPrint, passed in ::new
attr_reader :indent
# Render the String text of the objects that have been added to this
# Breakable object.
#
# Output the text to +out+, and increment the width to +output_width+
def output(out, output_width)
@group.breakables.shift
if @group.break?
out << @pp.newline
out << @pp.genspace.call(@indent)
@indent
else
@pp.group_queue.delete @group if @group.breakables.empty?
out << @obj
output_width + @width
end
end
end
# The Group class is used for making indentation easier.
#
# While this class does neither the breaking into newlines nor indentation,
# it is used in a stack (as well as a queue) within PrettyPrint, to group
# objects.
#
# For information on using groups, see PrettyPrint#group
#
# This class is intended for internal use of the PrettyPrint buffers.
class Group # :nodoc:
# Create a Group object
#
# Arguments:
# * +depth+ - this group's relation to previous groups
def initialize(depth)
@depth = depth
@breakables = []
@break = false
end
# This group's relation to previous groups
attr_reader :depth
# Array to hold the Breakable objects for this Group
attr_reader :breakables
# Makes a break for this Group, and returns true
def break
@break = true
end
# Boolean of whether this Group has made a break
def break?
@break
end
# Boolean of whether this Group has been queried for being first
#
# This is used as a predicate, and ought to be called first.
def first?
if defined? @first
false
else
@first = false
true
end
end
end
# The GroupQueue class is used for managing the queue of Group to be pretty
# printed.
#
# This queue groups the Group objects, based on their depth.
#
# This class is intended for internal use of the PrettyPrint buffers.
class GroupQueue # :nodoc:
# Create a GroupQueue object
#
# Arguments:
# * +groups+ - one or more PrettyPrint::Group objects
def initialize(*groups)
@queue = []
groups.each {|g| enq g}
end
# Enqueue +group+
#
# This does not strictly append the group to the end of the queue,
# but instead adds it in line, base on the +group.depth+
def enq(group)
depth = group.depth
@queue << [] until depth < @queue.length
@queue[depth] << group
end
# Returns the outer group of the queue
def deq
@queue.each {|gs|
(gs.length-1).downto(0) {|i|
unless gs[i].breakables.empty?
group = gs.slice!(i, 1).first
group.break
return group
end
}
gs.each {|group| group.break}
gs.clear
}
return nil
end
# Remote +group+ from this queue
def delete(group)
@queue[group.depth].delete(group)
end
end
# PrettyPrint::SingleLine is used by PrettyPrint.singleline_format
#
# It is passed to be similar to a PrettyPrint object itself, by responding to:
# * #text
# * #breakable
# * #nest
# * #group
# * #flush
# * #first?
#
# but instead, the output has no line breaks
#
class SingleLine
# Create a PrettyPrint::SingleLine object
#
# Arguments:
# * +output+ - String (or similar) to store rendered text. Needs to respond to '<<'
# * +maxwidth+ - Argument position expected to be here for compatibility.
# This argument is a noop.
# * +newline+ - Argument position expected to be here for compatibility.
# This argument is a noop.
def initialize(output, maxwidth=nil, newline=nil)
@output = output
@first = [true]
end
# Add +obj+ to the text to be output.
#
# +width+ argument is here for compatibility. It is a noop argument.
def text(obj, width=nil)
@output << obj
end
# Appends +sep+ to the text to be output. By default +sep+ is ' '
#
# +width+ argument is here for compatibility. It is a noop argument.
def breakable(sep=' ', width=nil)
@output << sep
end
# Takes +indent+ arg, but does nothing with it.
#
# Yields to a block.
def nest(indent) # :nodoc:
yield
end
# Opens a block for grouping objects to be pretty printed.
#
# Arguments:
# * +indent+ - noop argument. Present for compatibility.
# * +open_obj+ - text appended before the &blok. Default is ''
# * +close_obj+ - text appended after the &blok. Default is ''
# * +open_width+ - noop argument. Present for compatibility.
# * +close_width+ - noop argument. Present for compatibility.
def group(indent=nil, open_obj='', close_obj='', open_width=nil, close_width=nil)
@first.push true
@output << open_obj
yield
@output << close_obj
@first.pop
end
# Method present for compatibility, but is a noop
def flush # :nodoc:
end
# This is used as a predicate, and ought to be called first.
def first?
result = @first[-1]
@first[-1] = false
result
end
end
end
share/ruby/prism/node_ext.rb 0000644 00000012015 15173517735 0012130 0 ustar 00 # frozen_string_literal: true
# Here we are reopening the prism module to provide methods on nodes that aren't
# templated and are meant as convenience methods.
module Prism
module RegularExpressionOptions # :nodoc:
# Returns a numeric value that represents the flags that were used to create
# the regular expression.
def options
o = flags & (RegularExpressionFlags::IGNORE_CASE | RegularExpressionFlags::EXTENDED | RegularExpressionFlags::MULTI_LINE)
o |= Regexp::FIXEDENCODING if flags.anybits?(RegularExpressionFlags::EUC_JP | RegularExpressionFlags::WINDOWS_31J | RegularExpressionFlags::UTF_8)
o |= Regexp::NOENCODING if flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
o
end
end
class InterpolatedMatchLastLineNode < Node
include RegularExpressionOptions
end
class InterpolatedRegularExpressionNode < Node
include RegularExpressionOptions
end
class MatchLastLineNode < Node
include RegularExpressionOptions
end
class RegularExpressionNode < Node
include RegularExpressionOptions
end
private_constant :RegularExpressionOptions
module HeredocQuery # :nodoc:
# Returns true if this node was represented as a heredoc in the source code.
def heredoc?
opening&.start_with?("<<")
end
end
class InterpolatedStringNode < Node
include HeredocQuery
end
class InterpolatedXStringNode < Node
include HeredocQuery
end
class StringNode < Node
include HeredocQuery
end
class XStringNode < Node
include HeredocQuery
end
private_constant :HeredocQuery
class FloatNode < Node
# Returns the value of the node as a Ruby Float.
def value
Float(slice)
end
end
class ImaginaryNode < Node
# Returns the value of the node as a Ruby Complex.
def value
Complex(0, numeric.value)
end
end
class IntegerNode < Node
# Returns the value of the node as a Ruby Integer.
def value
Integer(slice)
end
end
class RationalNode < Node
# Returns the value of the node as a Ruby Rational.
def value
Rational(slice.chomp("r"))
end
end
class ConstantReadNode < Node
# Returns the list of parts for the full name of this constant.
# For example: [:Foo]
def full_name_parts
[name]
end
# Returns the full name of this constant. For example: "Foo"
def full_name
name.name
end
end
class ConstantPathNode < Node
# An error class raised when dynamic parts are found while computing a
# constant path's full name. For example:
# Foo::Bar::Baz -> does not raise because all parts of the constant path are
# simple constants
# var::Bar::Baz -> raises because the first part of the constant path is a
# local variable
class DynamicPartsInConstantPathError < StandardError; end
# Returns the list of parts for the full name of this constant path.
# For example: [:Foo, :Bar]
def full_name_parts
parts = [child.name]
current = parent
while current.is_a?(ConstantPathNode)
parts.unshift(current.child.name)
current = current.parent
end
unless current.is_a?(ConstantReadNode)
raise DynamicPartsInConstantPathError, "Constant path contains dynamic parts. Cannot compute full name"
end
parts.unshift(current&.name || :"")
end
# Returns the full name of this constant path. For example: "Foo::Bar"
def full_name
full_name_parts.join("::")
end
end
class ConstantPathTargetNode < Node
# Returns the list of parts for the full name of this constant path.
# For example: [:Foo, :Bar]
def full_name_parts
(parent&.full_name_parts || [:""]).push(child.name)
end
# Returns the full name of this constant path. For example: "Foo::Bar"
def full_name
full_name_parts.join("::")
end
end
class ParametersNode < Node
# Mirrors the Method#parameters method.
def signature
names = []
requireds.each do |param|
names << (param.is_a?(MultiTargetNode) ? [:req] : [:req, param.name])
end
optionals.each { |param| names << [:opt, param.name] }
names << [:rest, rest.name || :*] if rest
posts.each do |param|
names << (param.is_a?(MultiTargetNode) ? [:req] : [:req, param.name])
end
# Regardless of the order in which the keywords were defined, the required
# keywords always come first followed by the optional keywords.
keyopt = []
keywords.each do |param|
if param.is_a?(OptionalKeywordParameterNode)
keyopt << param
else
names << [:keyreq, param.name]
end
end
keyopt.each { |param| names << [:key, param.name] }
case keyword_rest
when ForwardingParameterNode
names.concat([[:rest, :*], [:keyrest, :**], [:block, :&]])
when KeywordRestParameterNode
names << [:keyrest, keyword_rest.name || :**]
when NoKeywordsParameterNode
names << [:nokey]
end
names << [:block, block.name || :&] if block
names
end
end
end
share/ruby/prism/debug.rb 0000644 00000014170 15173517735 0011415 0 ustar 00 # frozen_string_literal: true
module Prism
# This module is used for testing and debugging and is not meant to be used by
# consumers of this library.
module Debug
# A wrapper around a RubyVM::InstructionSequence that provides a more
# convenient interface for accessing parts of the iseq.
class ISeq # :nodoc:
attr_reader :parts
def initialize(parts)
@parts = parts
end
def type
parts[0]
end
def local_table
parts[10]
end
def instructions
parts[13]
end
def each_child
instructions.each do |instruction|
# Only look at arrays. Other instructions are line numbers or
# tracepoint events.
next unless instruction.is_a?(Array)
instruction.each do |opnd|
# Only look at arrays. Other operands are literals.
next unless opnd.is_a?(Array)
# Only look at instruction sequences. Other operands are literals.
next unless opnd[0] == "YARVInstructionSequence/SimpleDataFormat"
yield ISeq.new(opnd)
end
end
end
end
private_constant :ISeq
# :call-seq:
# Debug::cruby_locals(source) -> Array
#
# For the given source, compiles with CRuby and returns a list of all of the
# sets of local variables that were encountered.
def self.cruby_locals(source)
verbose, $VERBOSE = $VERBOSE, nil
begin
locals = []
stack = [ISeq.new(RubyVM::InstructionSequence.compile(source).to_a)]
while (iseq = stack.pop)
names = [*iseq.local_table]
names.map!.with_index do |name, index|
# When an anonymous local variable is present in the iseq's local
# table, it is represented as the stack offset from the top.
# However, when these are dumped to binary and read back in, they
# are replaced with the symbol :#arg_rest. To consistently handle
# this, we replace them here with their index.
if name == :"#arg_rest"
names.length - index + 1
else
name
end
end
locals << names
iseq.each_child { |child| stack << child }
end
locals
ensure
$VERBOSE = verbose
end
end
# Used to hold the place of a local that will be in the local table but
# cannot be accessed directly from the source code. For example, the
# iteration variable in a for loop or the positional parameter on a method
# definition that is destructured.
AnonymousLocal = Object.new
private_constant :AnonymousLocal
# :call-seq:
# Debug::prism_locals(source) -> Array
#
# For the given source, parses with prism and returns a list of all of the
# sets of local variables that were encountered.
def self.prism_locals(source)
locals = []
stack = [Prism.parse(source).value]
while (node = stack.pop)
case node
when BlockNode, DefNode, LambdaNode
names = node.locals
params =
if node.is_a?(DefNode)
node.parameters
elsif node.parameters.is_a?(NumberedParametersNode)
nil
else
node.parameters&.parameters
end
# prism places parameters in the same order that they appear in the
# source. CRuby places them in the order that they need to appear
# according to their own internal calling convention. We mimic that
# order here so that we can compare properly.
if params
sorted = [
*params.requireds.map do |required|
if required.is_a?(RequiredParameterNode)
required.name
else
AnonymousLocal
end
end,
*params.optionals.map(&:name),
*((params.rest.name || :*) if params.rest && !params.rest.is_a?(ImplicitRestNode)),
*params.posts.map do |post|
if post.is_a?(RequiredParameterNode)
post.name
else
AnonymousLocal
end
end,
*params.keywords.grep(RequiredKeywordParameterNode).map(&:name),
*params.keywords.grep(OptionalKeywordParameterNode).map(&:name),
]
if params.keyword_rest.is_a?(ForwardingParameterNode)
sorted.push(:*, :&, :"...")
end
sorted << AnonymousLocal if params.keywords.any?
# Recurse down the parameter tree to find any destructured
# parameters and add them after the other parameters.
param_stack = params.requireds.concat(params.posts).grep(MultiTargetNode).reverse
while (param = param_stack.pop)
case param
when MultiTargetNode
param_stack.concat(param.rights.reverse)
param_stack << param.rest
param_stack.concat(param.lefts.reverse)
when RequiredParameterNode
sorted << param.name
when SplatNode
sorted << param.expression.name if param.expression
end
end
names = sorted.concat(names - sorted)
end
names.map!.with_index do |name, index|
if name == AnonymousLocal
names.length - index + 1
else
name
end
end
locals << names
when ClassNode, ModuleNode, ProgramNode, SingletonClassNode
locals << node.locals
when ForNode
locals << [2]
when PostExecutionNode
locals.push([], [])
when InterpolatedRegularExpressionNode
locals << [] if node.once?
end
stack.concat(node.compact_child_nodes)
end
locals
end
# :call-seq:
# Debug::newlines(source) -> Array
#
# For the given source string, return the byte offsets of every newline in
# the source.
def self.newlines(source)
Prism.parse(source).source.offsets
end
end
end
share/ruby/prism/parse_result/comments.rb 0000644 00000013100 15173517735 0014654 0 ustar 00 # frozen_string_literal: true
module Prism
class ParseResult
# When we've parsed the source, we have both the syntax tree and the list of
# comments that we found in the source. This class is responsible for
# walking the tree and finding the nearest location to attach each comment.
#
# It does this by first finding the nearest locations to each comment.
# Locations can either come from nodes directly or from location fields on
# nodes. For example, a `ClassNode` has an overall location encompassing the
# entire class, but it also has a location for the `class` keyword.
#
# Once the nearest locations are found, it determines which one to attach
# to. If it's a trailing comment (a comment on the same line as other source
# code), it will favor attaching to the nearest location that occurs before
# the comment. Otherwise it will favor attaching to the nearest location
# that is after the comment.
class Comments
# A target for attaching comments that is based on a specific node's
# location.
class NodeTarget # :nodoc:
attr_reader :node
def initialize(node)
@node = node
end
def start_offset
node.location.start_offset
end
def end_offset
node.location.end_offset
end
def encloses?(comment)
start_offset <= comment.location.start_offset &&
comment.location.end_offset <= end_offset
end
def <<(comment)
node.location.comments << comment
end
end
# A target for attaching comments that is based on a location field on a
# node. For example, the `end` token of a ClassNode.
class LocationTarget # :nodoc:
attr_reader :location
def initialize(location)
@location = location
end
def start_offset
location.start_offset
end
def end_offset
location.end_offset
end
def encloses?(comment)
false
end
def <<(comment)
location.comments << comment
end
end
# The parse result that we are attaching comments to.
attr_reader :parse_result
# Create a new Comments object that will attach comments to the given
# parse result.
def initialize(parse_result)
@parse_result = parse_result
end
# Attach the comments to their respective locations in the tree by
# mutating the parse result.
def attach!
parse_result.comments.each do |comment|
preceding, enclosing, following = nearest_targets(parse_result.value, comment)
target =
if comment.trailing?
preceding || following || enclosing || NodeTarget.new(parse_result.value)
else
# If a comment exists on its own line, prefer a leading comment.
following || preceding || enclosing || NodeTarget.new(parse_result.value)
end
target << comment
end
end
private
# Responsible for finding the nearest targets to the given comment within
# the context of the given encapsulating node.
def nearest_targets(node, comment)
comment_start = comment.location.start_offset
comment_end = comment.location.end_offset
targets = []
node.comment_targets.map do |value|
case value
when StatementsNode
targets.concat(value.body.map { |node| NodeTarget.new(node) })
when Node
targets << NodeTarget.new(value)
when Location
targets << LocationTarget.new(value)
end
end
targets.sort_by!(&:start_offset)
preceding = nil
following = nil
left = 0
right = targets.length
# This is a custom binary search that finds the nearest nodes to the
# given comment. When it finds a node that completely encapsulates the
# comment, it recurses downward into the tree.
while left < right
middle = (left + right) / 2
target = targets[middle]
target_start = target.start_offset
target_end = target.end_offset
if target.encloses?(comment)
# The comment is completely contained by this target. Abandon the
# binary search at this level.
return nearest_targets(target.node, comment)
end
if target_end <= comment_start
# This target falls completely before the comment. Because we will
# never consider this target or any targets before it again, this
# target must be the closest preceding target we have encountered so
# far.
preceding = target
left = middle + 1
next
end
if comment_end <= target_start
# This target falls completely after the comment. Because we will
# never consider this target or any targets after it again, this
# target must be the closest following target we have encountered so
# far.
following = target
right = middle
next
end
# This should only happen if there is a bug in this parser.
raise "Comment location overlaps with a target location"
end
[preceding, NodeTarget.new(node), following]
end
end
private_constant :Comments
# Attach the list of comments to their respective locations in the tree.
def attach_comments!
Comments.new(self).attach!
end
end
end
share/ruby/prism/parse_result/newlines.rb 0000644 00000003713 15173517735 0014664 0 ustar 00 # frozen_string_literal: true
module Prism
class ParseResult
# The :line tracepoint event gets fired whenever the Ruby VM encounters an
# expression on a new line. The types of expressions that can trigger this
# event are:
#
# * if statements
# * unless statements
# * nodes that are children of statements lists
#
# In order to keep track of the newlines, we have a list of offsets that
# come back from the parser. We assign these offsets to the first nodes that
# we find in the tree that are on those lines.
#
# Note that the logic in this file should be kept in sync with the Java
# MarkNewlinesVisitor, since that visitor is responsible for marking the
# newlines for JRuby/TruffleRuby.
class Newlines < Visitor
# Create a new Newlines visitor with the given newline offsets.
def initialize(newline_marked)
@newline_marked = newline_marked
end
# Permit block/lambda nodes to mark newlines within themselves.
def visit_block_node(node)
old_newline_marked = @newline_marked
@newline_marked = Array.new(old_newline_marked.size, false)
begin
super(node)
ensure
@newline_marked = old_newline_marked
end
end
alias_method :visit_lambda_node, :visit_block_node
# Mark if/unless nodes as newlines.
def visit_if_node(node)
node.set_newline_flag(@newline_marked)
super(node)
end
alias_method :visit_unless_node, :visit_if_node
# Permit statements lists to mark newlines within themselves.
def visit_statements_node(node)
node.body.each do |child|
child.set_newline_flag(@newline_marked)
end
super(node)
end
end
private_constant :Newlines
# Walk the tree and mark nodes that are on a new line.
def mark_newlines!
value.accept(Newlines.new(Array.new(1 + source.offsets.size, false)))
end
end
end
share/ruby/prism/serialize.rb 0000644 00000161325 15173517735 0012323 0 ustar 00 # frozen_string_literal: true
=begin
This file is generated by the templates/template.rb script and should not be
modified manually. See templates/lib/prism/serialize.rb.erb
if you are looking to modify the template
=end
require "stringio"
# Polyfill for String#unpack1 with the offset parameter.
if String.instance_method(:unpack1).parameters.none? { |_, name| name == :offset }
String.prepend(
Module.new {
def unpack1(format, offset: 0) # :nodoc:
offset == 0 ? super(format) : self[offset..].unpack1(format)
end
}
)
end
module Prism
# A module responsible for deserializing parse results.
module Serialize
# The major version of prism that we are expecting to find in the serialized
# strings.
MAJOR_VERSION = 0
# The minor version of prism that we are expecting to find in the serialized
# strings.
MINOR_VERSION = 19
# The patch version of prism that we are expecting to find in the serialized
# strings.
PATCH_VERSION = 0
# Deserialize the AST represented by the given string into a parse result.
def self.load(input, serialized)
input = input.dup
source = Source.new(input)
loader = Loader.new(source, serialized)
result = loader.load_result
input.force_encoding(loader.encoding)
result
end
# Deserialize the tokens represented by the given string into a parse
# result.
def self.load_tokens(source, serialized)
Loader.new(source, serialized).load_tokens_result
end
class Loader # :nodoc:
attr_reader :encoding, :input, :serialized, :io
attr_reader :constant_pool_offset, :constant_pool, :source
attr_reader :start_line
def initialize(source, serialized)
@encoding = Encoding::UTF_8
@input = source.source.dup
@serialized = serialized
@io = StringIO.new(serialized)
@io.set_encoding(Encoding::BINARY)
@constant_pool_offset = nil
@constant_pool = nil
@source = source
define_load_node_lambdas unless RUBY_ENGINE == "ruby"
end
def load_header
raise "Invalid serialization" if io.read(5) != "PRISM"
raise "Invalid serialization" if io.read(3).unpack("C3") != [MAJOR_VERSION, MINOR_VERSION, PATCH_VERSION]
only_semantic_fields = io.read(1).unpack1("C")
unless only_semantic_fields == 0
raise "Invalid serialization (location fields must be included but are not)"
end
end
def load_encoding
@encoding = Encoding.find(io.read(load_varuint))
@input = input.force_encoding(@encoding).freeze
@encoding
end
def load_start_line
source.start_line = load_varsint
end
def load_comments
load_varuint.times.map do
case load_varuint
when 0 then InlineComment.new(load_location)
when 1 then EmbDocComment.new(load_location)
when 2 then DATAComment.new(load_location)
end
end
end
def load_metadata
comments = load_comments
magic_comments = load_varuint.times.map { MagicComment.new(load_location, load_location) }
data_loc = load_optional_location
errors = load_varuint.times.map { ParseError.new(load_embedded_string, load_location) }
warnings = load_varuint.times.map { ParseWarning.new(load_embedded_string, load_location) }
[comments, magic_comments, data_loc, errors, warnings]
end
def load_tokens
tokens = []
while type = TOKEN_TYPES.fetch(load_varuint)
start = load_varuint
length = load_varuint
lex_state = load_varuint
location = Location.new(@source, start, length)
tokens << [Prism::Token.new(type, location.slice, location), lex_state]
end
tokens
end
def load_tokens_result
tokens = load_tokens
encoding = load_encoding
load_start_line
comments, magic_comments, data_loc, errors, warnings = load_metadata
tokens.each { |token,| token.value.force_encoding(encoding) }
raise "Expected to consume all bytes while deserializing" unless @io.eof?
Prism::ParseResult.new(tokens, comments, magic_comments, data_loc, errors, warnings, @source)
end
def load_nodes
load_header
load_encoding
load_start_line
comments, magic_comments, data_loc, errors, warnings = load_metadata
@constant_pool_offset = io.read(4).unpack1("L")
@constant_pool = Array.new(load_varuint, nil)
[load_node, comments, magic_comments, data_loc, errors, warnings]
end
def load_result
node, comments, magic_comments, data_loc, errors, warnings = load_nodes
Prism::ParseResult.new(node, comments, magic_comments, data_loc, errors, warnings, @source)
end
private
# variable-length integer using https://en.wikipedia.org/wiki/LEB128
# This is also what protobuf uses: https://protobuf.dev/programming-guides/encoding/#varints
def load_varuint
n = io.getbyte
if n < 128
n
else
n -= 128
shift = 0
while (b = io.getbyte) >= 128
n += (b - 128) << (shift += 7)
end
n + (b << (shift + 7))
end
end
def load_varsint
n = load_varuint
(n >> 1) ^ (-(n & 1))
end
def load_serialized_length
io.read(4).unpack1("L")
end
def load_optional_node
if io.getbyte != 0
io.pos -= 1
load_node
end
end
def load_embedded_string
io.read(load_varuint).force_encoding(encoding)
end
def load_string
type = io.getbyte
case type
when 1
input.byteslice(load_varuint, load_varuint).force_encoding(encoding)
when 2
load_embedded_string
else
raise "Unknown serialized string type: #{type}"
end
end
def load_location
Location.new(source, load_varuint, load_varuint)
end
def load_optional_location
load_location if io.getbyte != 0
end
def load_constant(index)
constant = constant_pool[index]
unless constant
offset = constant_pool_offset + index * 8
start = serialized.unpack1("L", offset: offset)
length = serialized.unpack1("L", offset: offset + 4)
constant =
if start.nobits?(1 << 31)
input.byteslice(start, length).to_sym
else
serialized.byteslice(start & ((1 << 31) - 1), length).to_sym
end
constant_pool[index] = constant
end
constant
end
def load_required_constant
load_constant(load_varuint - 1)
end
def load_optional_constant
index = load_varuint
load_constant(index - 1) if index != 0
end
if RUBY_ENGINE == 'ruby'
def load_node
type = io.getbyte
location = load_location
case type
when 1 then
AliasGlobalVariableNode.new(load_node, load_node, load_location, location)
when 2 then
AliasMethodNode.new(load_node, load_node, load_location, location)
when 3 then
AlternationPatternNode.new(load_node, load_node, load_location, location)
when 4 then
AndNode.new(load_node, load_node, load_location, location)
when 5 then
ArgumentsNode.new(load_varuint, Array.new(load_varuint) { load_node }, location)
when 6 then
ArrayNode.new(load_varuint, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
when 7 then
ArrayPatternNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
when 8 then
AssocNode.new(load_node, load_optional_node, load_optional_location, location)
when 9 then
AssocSplatNode.new(load_optional_node, load_location, location)
when 10 then
BackReferenceReadNode.new(load_required_constant, location)
when 11 then
BeginNode.new(load_optional_location, load_optional_node, load_optional_node, load_optional_node, load_optional_node, load_optional_location, location)
when 12 then
BlockArgumentNode.new(load_optional_node, load_location, location)
when 13 then
BlockLocalVariableNode.new(load_required_constant, location)
when 14 then
BlockNode.new(Array.new(load_varuint) { load_required_constant }, load_varuint, load_optional_node, load_optional_node, load_location, load_location, location)
when 15 then
BlockParameterNode.new(load_optional_constant, load_optional_location, load_location, location)
when 16 then
BlockParametersNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
when 17 then
BreakNode.new(load_optional_node, load_location, location)
when 18 then
CallAndWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_optional_location, load_required_constant, load_required_constant, load_location, load_node, location)
when 19 then
CallNode.new(load_varuint, load_optional_node, load_optional_location, load_required_constant, load_optional_location, load_optional_location, load_optional_node, load_optional_location, load_optional_node, location)
when 20 then
CallOperatorWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_optional_location, load_required_constant, load_required_constant, load_required_constant, load_location, load_node, location)
when 21 then
CallOrWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_optional_location, load_required_constant, load_required_constant, load_location, load_node, location)
when 22 then
CallTargetNode.new(load_varuint, load_node, load_location, load_required_constant, load_location, location)
when 23 then
CapturePatternNode.new(load_node, load_node, load_location, location)
when 24 then
CaseMatchNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, load_location, load_location, location)
when 25 then
CaseNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, load_location, load_location, location)
when 26 then
ClassNode.new(Array.new(load_varuint) { load_required_constant }, load_location, load_node, load_optional_location, load_optional_node, load_optional_node, load_location, load_required_constant, location)
when 27 then
ClassVariableAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 28 then
ClassVariableOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
when 29 then
ClassVariableOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 30 then
ClassVariableReadNode.new(load_required_constant, location)
when 31 then
ClassVariableTargetNode.new(load_required_constant, location)
when 32 then
ClassVariableWriteNode.new(load_required_constant, load_location, load_node, load_optional_location, location)
when 33 then
ConstantAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 34 then
ConstantOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
when 35 then
ConstantOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 36 then
ConstantPathAndWriteNode.new(load_node, load_location, load_node, location)
when 37 then
ConstantPathNode.new(load_optional_node, load_node, load_location, location)
when 38 then
ConstantPathOperatorWriteNode.new(load_node, load_location, load_node, load_required_constant, location)
when 39 then
ConstantPathOrWriteNode.new(load_node, load_location, load_node, location)
when 40 then
ConstantPathTargetNode.new(load_optional_node, load_node, load_location, location)
when 41 then
ConstantPathWriteNode.new(load_node, load_location, load_node, location)
when 42 then
ConstantReadNode.new(load_required_constant, location)
when 43 then
ConstantTargetNode.new(load_required_constant, location)
when 44 then
ConstantWriteNode.new(load_required_constant, load_location, load_node, load_location, location)
when 45 then
load_serialized_length
DefNode.new(load_required_constant, load_location, load_optional_node, load_optional_node, load_optional_node, Array.new(load_varuint) { load_required_constant }, load_varuint, load_location, load_optional_location, load_optional_location, load_optional_location, load_optional_location, load_optional_location, location)
when 46 then
DefinedNode.new(load_optional_location, load_node, load_optional_location, load_location, location)
when 47 then
ElseNode.new(load_location, load_optional_node, load_optional_location, location)
when 48 then
EmbeddedStatementsNode.new(load_location, load_optional_node, load_location, location)
when 49 then
EmbeddedVariableNode.new(load_location, load_node, location)
when 50 then
EnsureNode.new(load_location, load_optional_node, load_location, location)
when 51 then
FalseNode.new(location)
when 52 then
FindPatternNode.new(load_optional_node, load_node, Array.new(load_varuint) { load_node }, load_node, load_optional_location, load_optional_location, location)
when 53 then
FlipFlopNode.new(load_varuint, load_optional_node, load_optional_node, load_location, location)
when 54 then
FloatNode.new(location)
when 55 then
ForNode.new(load_node, load_node, load_optional_node, load_location, load_location, load_optional_location, load_location, location)
when 56 then
ForwardingArgumentsNode.new(location)
when 57 then
ForwardingParameterNode.new(location)
when 58 then
ForwardingSuperNode.new(load_optional_node, location)
when 59 then
GlobalVariableAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 60 then
GlobalVariableOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
when 61 then
GlobalVariableOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 62 then
GlobalVariableReadNode.new(load_required_constant, location)
when 63 then
GlobalVariableTargetNode.new(load_required_constant, location)
when 64 then
GlobalVariableWriteNode.new(load_required_constant, load_location, load_node, load_location, location)
when 65 then
HashNode.new(load_location, Array.new(load_varuint) { load_node }, load_location, location)
when 66 then
HashPatternNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, load_optional_location, load_optional_location, location)
when 67 then
IfNode.new(load_optional_location, load_node, load_optional_location, load_optional_node, load_optional_node, load_optional_location, location)
when 68 then
ImaginaryNode.new(load_node, location)
when 69 then
ImplicitNode.new(load_node, location)
when 70 then
ImplicitRestNode.new(location)
when 71 then
InNode.new(load_node, load_optional_node, load_location, load_optional_location, location)
when 72 then
IndexAndWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_location, load_optional_node, load_location, load_optional_node, load_location, load_node, location)
when 73 then
IndexOperatorWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_location, load_optional_node, load_location, load_optional_node, load_required_constant, load_location, load_node, location)
when 74 then
IndexOrWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_location, load_optional_node, load_location, load_optional_node, load_location, load_node, location)
when 75 then
IndexTargetNode.new(load_varuint, load_node, load_location, load_optional_node, load_location, load_optional_node, location)
when 76 then
InstanceVariableAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 77 then
InstanceVariableOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
when 78 then
InstanceVariableOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
when 79 then
InstanceVariableReadNode.new(load_required_constant, location)
when 80 then
InstanceVariableTargetNode.new(load_required_constant, location)
when 81 then
InstanceVariableWriteNode.new(load_required_constant, load_location, load_node, load_location, location)
when 82 then
IntegerNode.new(load_varuint, location)
when 83 then
InterpolatedMatchLastLineNode.new(load_varuint, load_location, Array.new(load_varuint) { load_node }, load_location, location)
when 84 then
InterpolatedRegularExpressionNode.new(load_varuint, load_location, Array.new(load_varuint) { load_node }, load_location, location)
when 85 then
InterpolatedStringNode.new(load_optional_location, Array.new(load_varuint) { load_node }, load_optional_location, location)
when 86 then
InterpolatedSymbolNode.new(load_optional_location, Array.new(load_varuint) { load_node }, load_optional_location, location)
when 87 then
InterpolatedXStringNode.new(load_location, Array.new(load_varuint) { load_node }, load_location, location)
when 88 then
KeywordHashNode.new(load_varuint, Array.new(load_varuint) { load_node }, location)
when 89 then
KeywordRestParameterNode.new(load_optional_constant, load_optional_location, load_location, location)
when 90 then
LambdaNode.new(Array.new(load_varuint) { load_required_constant }, load_varuint, load_location, load_location, load_location, load_optional_node, load_optional_node, location)
when 91 then
LocalVariableAndWriteNode.new(load_location, load_location, load_node, load_required_constant, load_varuint, location)
when 92 then
LocalVariableOperatorWriteNode.new(load_location, load_location, load_node, load_required_constant, load_required_constant, load_varuint, location)
when 93 then
LocalVariableOrWriteNode.new(load_location, load_location, load_node, load_required_constant, load_varuint, location)
when 94 then
LocalVariableReadNode.new(load_required_constant, load_varuint, location)
when 95 then
LocalVariableTargetNode.new(load_required_constant, load_varuint, location)
when 96 then
LocalVariableWriteNode.new(load_required_constant, load_varuint, load_location, load_node, load_location, location)
when 97 then
MatchLastLineNode.new(load_varuint, load_location, load_location, load_location, load_string, location)
when 98 then
MatchPredicateNode.new(load_node, load_node, load_location, location)
when 99 then
MatchRequiredNode.new(load_node, load_node, load_location, location)
when 100 then
MatchWriteNode.new(load_node, Array.new(load_varuint) { load_node }, location)
when 101 then
MissingNode.new(location)
when 102 then
ModuleNode.new(Array.new(load_varuint) { load_required_constant }, load_location, load_node, load_optional_node, load_location, load_required_constant, location)
when 103 then
MultiTargetNode.new(Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
when 104 then
MultiWriteNode.new(Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, load_location, load_node, location)
when 105 then
NextNode.new(load_optional_node, load_location, location)
when 106 then
NilNode.new(location)
when 107 then
NoKeywordsParameterNode.new(load_location, load_location, location)
when 108 then
NumberedParametersNode.new(io.getbyte, location)
when 109 then
NumberedReferenceReadNode.new(load_varuint, location)
when 110 then
OptionalKeywordParameterNode.new(load_required_constant, load_location, load_node, location)
when 111 then
OptionalParameterNode.new(load_required_constant, load_location, load_location, load_node, location)
when 112 then
OrNode.new(load_node, load_node, load_location, location)
when 113 then
ParametersNode.new(Array.new(load_varuint) { load_node }, Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, Array.new(load_varuint) { load_node }, load_optional_node, load_optional_node, location)
when 114 then
ParenthesesNode.new(load_optional_node, load_location, load_location, location)
when 115 then
PinnedExpressionNode.new(load_node, load_location, load_location, load_location, location)
when 116 then
PinnedVariableNode.new(load_node, load_location, location)
when 117 then
PostExecutionNode.new(load_optional_node, load_location, load_location, load_location, location)
when 118 then
PreExecutionNode.new(load_optional_node, load_location, load_location, load_location, location)
when 119 then
ProgramNode.new(Array.new(load_varuint) { load_required_constant }, load_node, location)
when 120 then
RangeNode.new(load_varuint, load_optional_node, load_optional_node, load_location, location)
when 121 then
RationalNode.new(load_node, location)
when 122 then
RedoNode.new(location)
when 123 then
RegularExpressionNode.new(load_varuint, load_location, load_location, load_location, load_string, location)
when 124 then
RequiredKeywordParameterNode.new(load_required_constant, load_location, location)
when 125 then
RequiredParameterNode.new(load_required_constant, location)
when 126 then
RescueModifierNode.new(load_node, load_location, load_node, location)
when 127 then
RescueNode.new(load_location, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_node, load_optional_node, load_optional_node, location)
when 128 then
RestParameterNode.new(load_optional_constant, load_optional_location, load_location, location)
when 129 then
RetryNode.new(location)
when 130 then
ReturnNode.new(load_location, load_optional_node, location)
when 131 then
SelfNode.new(location)
when 132 then
SingletonClassNode.new(Array.new(load_varuint) { load_required_constant }, load_location, load_location, load_node, load_optional_node, load_location, location)
when 133 then
SourceEncodingNode.new(location)
when 134 then
SourceFileNode.new(load_string, location)
when 135 then
SourceLineNode.new(location)
when 136 then
SplatNode.new(load_location, load_optional_node, location)
when 137 then
StatementsNode.new(Array.new(load_varuint) { load_node }, location)
when 138 then
StringNode.new(load_varuint, load_optional_location, load_location, load_optional_location, load_string, location)
when 139 then
SuperNode.new(load_location, load_optional_location, load_optional_node, load_optional_location, load_optional_node, location)
when 140 then
SymbolNode.new(load_varuint, load_optional_location, load_optional_location, load_optional_location, load_string, location)
when 141 then
TrueNode.new(location)
when 142 then
UndefNode.new(Array.new(load_varuint) { load_node }, load_location, location)
when 143 then
UnlessNode.new(load_location, load_node, load_optional_location, load_optional_node, load_optional_node, load_optional_location, location)
when 144 then
UntilNode.new(load_varuint, load_location, load_optional_location, load_node, load_optional_node, location)
when 145 then
WhenNode.new(load_location, Array.new(load_varuint) { load_node }, load_optional_node, location)
when 146 then
WhileNode.new(load_varuint, load_location, load_optional_location, load_node, load_optional_node, location)
when 147 then
XStringNode.new(load_varuint, load_location, load_location, load_location, load_string, location)
when 148 then
YieldNode.new(load_location, load_optional_location, load_optional_node, load_optional_location, location)
end
end
else
def load_node
type = io.getbyte
@load_node_lambdas[type].call
end
def define_load_node_lambdas
@load_node_lambdas = [
nil,
-> {
location = load_location
AliasGlobalVariableNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
AliasMethodNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
AlternationPatternNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
AndNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
ArgumentsNode.new(load_varuint, Array.new(load_varuint) { load_node }, location)
},
-> {
location = load_location
ArrayNode.new(load_varuint, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
},
-> {
location = load_location
ArrayPatternNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
},
-> {
location = load_location
AssocNode.new(load_node, load_optional_node, load_optional_location, location)
},
-> {
location = load_location
AssocSplatNode.new(load_optional_node, load_location, location)
},
-> {
location = load_location
BackReferenceReadNode.new(load_required_constant, location)
},
-> {
location = load_location
BeginNode.new(load_optional_location, load_optional_node, load_optional_node, load_optional_node, load_optional_node, load_optional_location, location)
},
-> {
location = load_location
BlockArgumentNode.new(load_optional_node, load_location, location)
},
-> {
location = load_location
BlockLocalVariableNode.new(load_required_constant, location)
},
-> {
location = load_location
BlockNode.new(Array.new(load_varuint) { load_required_constant }, load_varuint, load_optional_node, load_optional_node, load_location, load_location, location)
},
-> {
location = load_location
BlockParameterNode.new(load_optional_constant, load_optional_location, load_location, location)
},
-> {
location = load_location
BlockParametersNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
},
-> {
location = load_location
BreakNode.new(load_optional_node, load_location, location)
},
-> {
location = load_location
CallAndWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_optional_location, load_required_constant, load_required_constant, load_location, load_node, location)
},
-> {
location = load_location
CallNode.new(load_varuint, load_optional_node, load_optional_location, load_required_constant, load_optional_location, load_optional_location, load_optional_node, load_optional_location, load_optional_node, location)
},
-> {
location = load_location
CallOperatorWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_optional_location, load_required_constant, load_required_constant, load_required_constant, load_location, load_node, location)
},
-> {
location = load_location
CallOrWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_optional_location, load_required_constant, load_required_constant, load_location, load_node, location)
},
-> {
location = load_location
CallTargetNode.new(load_varuint, load_node, load_location, load_required_constant, load_location, location)
},
-> {
location = load_location
CapturePatternNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
CaseMatchNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, load_location, load_location, location)
},
-> {
location = load_location
CaseNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, load_location, load_location, location)
},
-> {
location = load_location
ClassNode.new(Array.new(load_varuint) { load_required_constant }, load_location, load_node, load_optional_location, load_optional_node, load_optional_node, load_location, load_required_constant, location)
},
-> {
location = load_location
ClassVariableAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
ClassVariableOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
},
-> {
location = load_location
ClassVariableOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
ClassVariableReadNode.new(load_required_constant, location)
},
-> {
location = load_location
ClassVariableTargetNode.new(load_required_constant, location)
},
-> {
location = load_location
ClassVariableWriteNode.new(load_required_constant, load_location, load_node, load_optional_location, location)
},
-> {
location = load_location
ConstantAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
ConstantOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
},
-> {
location = load_location
ConstantOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
ConstantPathAndWriteNode.new(load_node, load_location, load_node, location)
},
-> {
location = load_location
ConstantPathNode.new(load_optional_node, load_node, load_location, location)
},
-> {
location = load_location
ConstantPathOperatorWriteNode.new(load_node, load_location, load_node, load_required_constant, location)
},
-> {
location = load_location
ConstantPathOrWriteNode.new(load_node, load_location, load_node, location)
},
-> {
location = load_location
ConstantPathTargetNode.new(load_optional_node, load_node, load_location, location)
},
-> {
location = load_location
ConstantPathWriteNode.new(load_node, load_location, load_node, location)
},
-> {
location = load_location
ConstantReadNode.new(load_required_constant, location)
},
-> {
location = load_location
ConstantTargetNode.new(load_required_constant, location)
},
-> {
location = load_location
ConstantWriteNode.new(load_required_constant, load_location, load_node, load_location, location)
},
-> {
location = load_location
load_serialized_length
DefNode.new(load_required_constant, load_location, load_optional_node, load_optional_node, load_optional_node, Array.new(load_varuint) { load_required_constant }, load_varuint, load_location, load_optional_location, load_optional_location, load_optional_location, load_optional_location, load_optional_location, location)
},
-> {
location = load_location
DefinedNode.new(load_optional_location, load_node, load_optional_location, load_location, location)
},
-> {
location = load_location
ElseNode.new(load_location, load_optional_node, load_optional_location, location)
},
-> {
location = load_location
EmbeddedStatementsNode.new(load_location, load_optional_node, load_location, location)
},
-> {
location = load_location
EmbeddedVariableNode.new(load_location, load_node, location)
},
-> {
location = load_location
EnsureNode.new(load_location, load_optional_node, load_location, location)
},
-> {
location = load_location
FalseNode.new(location)
},
-> {
location = load_location
FindPatternNode.new(load_optional_node, load_node, Array.new(load_varuint) { load_node }, load_node, load_optional_location, load_optional_location, location)
},
-> {
location = load_location
FlipFlopNode.new(load_varuint, load_optional_node, load_optional_node, load_location, location)
},
-> {
location = load_location
FloatNode.new(location)
},
-> {
location = load_location
ForNode.new(load_node, load_node, load_optional_node, load_location, load_location, load_optional_location, load_location, location)
},
-> {
location = load_location
ForwardingArgumentsNode.new(location)
},
-> {
location = load_location
ForwardingParameterNode.new(location)
},
-> {
location = load_location
ForwardingSuperNode.new(load_optional_node, location)
},
-> {
location = load_location
GlobalVariableAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
GlobalVariableOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
},
-> {
location = load_location
GlobalVariableOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
GlobalVariableReadNode.new(load_required_constant, location)
},
-> {
location = load_location
GlobalVariableTargetNode.new(load_required_constant, location)
},
-> {
location = load_location
GlobalVariableWriteNode.new(load_required_constant, load_location, load_node, load_location, location)
},
-> {
location = load_location
HashNode.new(load_location, Array.new(load_varuint) { load_node }, load_location, location)
},
-> {
location = load_location
HashPatternNode.new(load_optional_node, Array.new(load_varuint) { load_node }, load_optional_node, load_optional_location, load_optional_location, location)
},
-> {
location = load_location
IfNode.new(load_optional_location, load_node, load_optional_location, load_optional_node, load_optional_node, load_optional_location, location)
},
-> {
location = load_location
ImaginaryNode.new(load_node, location)
},
-> {
location = load_location
ImplicitNode.new(load_node, location)
},
-> {
location = load_location
ImplicitRestNode.new(location)
},
-> {
location = load_location
InNode.new(load_node, load_optional_node, load_location, load_optional_location, location)
},
-> {
location = load_location
IndexAndWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_location, load_optional_node, load_location, load_optional_node, load_location, load_node, location)
},
-> {
location = load_location
IndexOperatorWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_location, load_optional_node, load_location, load_optional_node, load_required_constant, load_location, load_node, location)
},
-> {
location = load_location
IndexOrWriteNode.new(load_varuint, load_optional_node, load_optional_location, load_location, load_optional_node, load_location, load_optional_node, load_location, load_node, location)
},
-> {
location = load_location
IndexTargetNode.new(load_varuint, load_node, load_location, load_optional_node, load_location, load_optional_node, location)
},
-> {
location = load_location
InstanceVariableAndWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
InstanceVariableOperatorWriteNode.new(load_required_constant, load_location, load_location, load_node, load_required_constant, location)
},
-> {
location = load_location
InstanceVariableOrWriteNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
InstanceVariableReadNode.new(load_required_constant, location)
},
-> {
location = load_location
InstanceVariableTargetNode.new(load_required_constant, location)
},
-> {
location = load_location
InstanceVariableWriteNode.new(load_required_constant, load_location, load_node, load_location, location)
},
-> {
location = load_location
IntegerNode.new(load_varuint, location)
},
-> {
location = load_location
InterpolatedMatchLastLineNode.new(load_varuint, load_location, Array.new(load_varuint) { load_node }, load_location, location)
},
-> {
location = load_location
InterpolatedRegularExpressionNode.new(load_varuint, load_location, Array.new(load_varuint) { load_node }, load_location, location)
},
-> {
location = load_location
InterpolatedStringNode.new(load_optional_location, Array.new(load_varuint) { load_node }, load_optional_location, location)
},
-> {
location = load_location
InterpolatedSymbolNode.new(load_optional_location, Array.new(load_varuint) { load_node }, load_optional_location, location)
},
-> {
location = load_location
InterpolatedXStringNode.new(load_location, Array.new(load_varuint) { load_node }, load_location, location)
},
-> {
location = load_location
KeywordHashNode.new(load_varuint, Array.new(load_varuint) { load_node }, location)
},
-> {
location = load_location
KeywordRestParameterNode.new(load_optional_constant, load_optional_location, load_location, location)
},
-> {
location = load_location
LambdaNode.new(Array.new(load_varuint) { load_required_constant }, load_varuint, load_location, load_location, load_location, load_optional_node, load_optional_node, location)
},
-> {
location = load_location
LocalVariableAndWriteNode.new(load_location, load_location, load_node, load_required_constant, load_varuint, location)
},
-> {
location = load_location
LocalVariableOperatorWriteNode.new(load_location, load_location, load_node, load_required_constant, load_required_constant, load_varuint, location)
},
-> {
location = load_location
LocalVariableOrWriteNode.new(load_location, load_location, load_node, load_required_constant, load_varuint, location)
},
-> {
location = load_location
LocalVariableReadNode.new(load_required_constant, load_varuint, location)
},
-> {
location = load_location
LocalVariableTargetNode.new(load_required_constant, load_varuint, location)
},
-> {
location = load_location
LocalVariableWriteNode.new(load_required_constant, load_varuint, load_location, load_node, load_location, location)
},
-> {
location = load_location
MatchLastLineNode.new(load_varuint, load_location, load_location, load_location, load_string, location)
},
-> {
location = load_location
MatchPredicateNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
MatchRequiredNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
MatchWriteNode.new(load_node, Array.new(load_varuint) { load_node }, location)
},
-> {
location = load_location
MissingNode.new(location)
},
-> {
location = load_location
ModuleNode.new(Array.new(load_varuint) { load_required_constant }, load_location, load_node, load_optional_node, load_location, load_required_constant, location)
},
-> {
location = load_location
MultiTargetNode.new(Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, location)
},
-> {
location = load_location
MultiWriteNode.new(Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_location, load_location, load_node, location)
},
-> {
location = load_location
NextNode.new(load_optional_node, load_location, location)
},
-> {
location = load_location
NilNode.new(location)
},
-> {
location = load_location
NoKeywordsParameterNode.new(load_location, load_location, location)
},
-> {
location = load_location
NumberedParametersNode.new(io.getbyte, location)
},
-> {
location = load_location
NumberedReferenceReadNode.new(load_varuint, location)
},
-> {
location = load_location
OptionalKeywordParameterNode.new(load_required_constant, load_location, load_node, location)
},
-> {
location = load_location
OptionalParameterNode.new(load_required_constant, load_location, load_location, load_node, location)
},
-> {
location = load_location
OrNode.new(load_node, load_node, load_location, location)
},
-> {
location = load_location
ParametersNode.new(Array.new(load_varuint) { load_node }, Array.new(load_varuint) { load_node }, load_optional_node, Array.new(load_varuint) { load_node }, Array.new(load_varuint) { load_node }, load_optional_node, load_optional_node, location)
},
-> {
location = load_location
ParenthesesNode.new(load_optional_node, load_location, load_location, location)
},
-> {
location = load_location
PinnedExpressionNode.new(load_node, load_location, load_location, load_location, location)
},
-> {
location = load_location
PinnedVariableNode.new(load_node, load_location, location)
},
-> {
location = load_location
PostExecutionNode.new(load_optional_node, load_location, load_location, load_location, location)
},
-> {
location = load_location
PreExecutionNode.new(load_optional_node, load_location, load_location, load_location, location)
},
-> {
location = load_location
ProgramNode.new(Array.new(load_varuint) { load_required_constant }, load_node, location)
},
-> {
location = load_location
RangeNode.new(load_varuint, load_optional_node, load_optional_node, load_location, location)
},
-> {
location = load_location
RationalNode.new(load_node, location)
},
-> {
location = load_location
RedoNode.new(location)
},
-> {
location = load_location
RegularExpressionNode.new(load_varuint, load_location, load_location, load_location, load_string, location)
},
-> {
location = load_location
RequiredKeywordParameterNode.new(load_required_constant, load_location, location)
},
-> {
location = load_location
RequiredParameterNode.new(load_required_constant, location)
},
-> {
location = load_location
RescueModifierNode.new(load_node, load_location, load_node, location)
},
-> {
location = load_location
RescueNode.new(load_location, Array.new(load_varuint) { load_node }, load_optional_location, load_optional_node, load_optional_node, load_optional_node, location)
},
-> {
location = load_location
RestParameterNode.new(load_optional_constant, load_optional_location, load_location, location)
},
-> {
location = load_location
RetryNode.new(location)
},
-> {
location = load_location
ReturnNode.new(load_location, load_optional_node, location)
},
-> {
location = load_location
SelfNode.new(location)
},
-> {
location = load_location
SingletonClassNode.new(Array.new(load_varuint) { load_required_constant }, load_location, load_location, load_node, load_optional_node, load_location, location)
},
-> {
location = load_location
SourceEncodingNode.new(location)
},
-> {
location = load_location
SourceFileNode.new(load_string, location)
},
-> {
location = load_location
SourceLineNode.new(location)
},
-> {
location = load_location
SplatNode.new(load_location, load_optional_node, location)
},
-> {
location = load_location
StatementsNode.new(Array.new(load_varuint) { load_node }, location)
},
-> {
location = load_location
StringNode.new(load_varuint, load_optional_location, load_location, load_optional_location, load_string, location)
},
-> {
location = load_location
SuperNode.new(load_location, load_optional_location, load_optional_node, load_optional_location, load_optional_node, location)
},
-> {
location = load_location
SymbolNode.new(load_varuint, load_optional_location, load_optional_location, load_optional_location, load_string, location)
},
-> {
location = load_location
TrueNode.new(location)
},
-> {
location = load_location
UndefNode.new(Array.new(load_varuint) { load_node }, load_location, location)
},
-> {
location = load_location
UnlessNode.new(load_location, load_node, load_optional_location, load_optional_node, load_optional_node, load_optional_location, location)
},
-> {
location = load_location
UntilNode.new(load_varuint, load_location, load_optional_location, load_node, load_optional_node, location)
},
-> {
location = load_location
WhenNode.new(load_location, Array.new(load_varuint) { load_node }, load_optional_node, location)
},
-> {
location = load_location
WhileNode.new(load_varuint, load_location, load_optional_location, load_node, load_optional_node, location)
},
-> {
location = load_location
XStringNode.new(load_varuint, load_location, load_location, load_location, load_string, location)
},
-> {
location = load_location
YieldNode.new(load_location, load_optional_location, load_optional_node, load_optional_location, location)
},
]
end
end
end
# The token types that can be indexed by their enum values.
TOKEN_TYPES = [
nil,
:EOF,
:MISSING,
:NOT_PROVIDED,
:AMPERSAND,
:AMPERSAND_AMPERSAND,
:AMPERSAND_AMPERSAND_EQUAL,
:AMPERSAND_DOT,
:AMPERSAND_EQUAL,
:BACKTICK,
:BACK_REFERENCE,
:BANG,
:BANG_EQUAL,
:BANG_TILDE,
:BRACE_LEFT,
:BRACE_RIGHT,
:BRACKET_LEFT,
:BRACKET_LEFT_ARRAY,
:BRACKET_LEFT_RIGHT,
:BRACKET_LEFT_RIGHT_EQUAL,
:BRACKET_RIGHT,
:CARET,
:CARET_EQUAL,
:CHARACTER_LITERAL,
:CLASS_VARIABLE,
:COLON,
:COLON_COLON,
:COMMA,
:COMMENT,
:CONSTANT,
:DOT,
:DOT_DOT,
:DOT_DOT_DOT,
:EMBDOC_BEGIN,
:EMBDOC_END,
:EMBDOC_LINE,
:EMBEXPR_BEGIN,
:EMBEXPR_END,
:EMBVAR,
:EQUAL,
:EQUAL_EQUAL,
:EQUAL_EQUAL_EQUAL,
:EQUAL_GREATER,
:EQUAL_TILDE,
:FLOAT,
:FLOAT_IMAGINARY,
:FLOAT_RATIONAL,
:FLOAT_RATIONAL_IMAGINARY,
:GLOBAL_VARIABLE,
:GREATER,
:GREATER_EQUAL,
:GREATER_GREATER,
:GREATER_GREATER_EQUAL,
:HEREDOC_END,
:HEREDOC_START,
:IDENTIFIER,
:IGNORED_NEWLINE,
:INSTANCE_VARIABLE,
:INTEGER,
:INTEGER_IMAGINARY,
:INTEGER_RATIONAL,
:INTEGER_RATIONAL_IMAGINARY,
:KEYWORD_ALIAS,
:KEYWORD_AND,
:KEYWORD_BEGIN,
:KEYWORD_BEGIN_UPCASE,
:KEYWORD_BREAK,
:KEYWORD_CASE,
:KEYWORD_CLASS,
:KEYWORD_DEF,
:KEYWORD_DEFINED,
:KEYWORD_DO,
:KEYWORD_DO_LOOP,
:KEYWORD_ELSE,
:KEYWORD_ELSIF,
:KEYWORD_END,
:KEYWORD_END_UPCASE,
:KEYWORD_ENSURE,
:KEYWORD_FALSE,
:KEYWORD_FOR,
:KEYWORD_IF,
:KEYWORD_IF_MODIFIER,
:KEYWORD_IN,
:KEYWORD_MODULE,
:KEYWORD_NEXT,
:KEYWORD_NIL,
:KEYWORD_NOT,
:KEYWORD_OR,
:KEYWORD_REDO,
:KEYWORD_RESCUE,
:KEYWORD_RESCUE_MODIFIER,
:KEYWORD_RETRY,
:KEYWORD_RETURN,
:KEYWORD_SELF,
:KEYWORD_SUPER,
:KEYWORD_THEN,
:KEYWORD_TRUE,
:KEYWORD_UNDEF,
:KEYWORD_UNLESS,
:KEYWORD_UNLESS_MODIFIER,
:KEYWORD_UNTIL,
:KEYWORD_UNTIL_MODIFIER,
:KEYWORD_WHEN,
:KEYWORD_WHILE,
:KEYWORD_WHILE_MODIFIER,
:KEYWORD_YIELD,
:KEYWORD___ENCODING__,
:KEYWORD___FILE__,
:KEYWORD___LINE__,
:LABEL,
:LABEL_END,
:LAMBDA_BEGIN,
:LESS,
:LESS_EQUAL,
:LESS_EQUAL_GREATER,
:LESS_LESS,
:LESS_LESS_EQUAL,
:METHOD_NAME,
:MINUS,
:MINUS_EQUAL,
:MINUS_GREATER,
:NEWLINE,
:NUMBERED_REFERENCE,
:PARENTHESIS_LEFT,
:PARENTHESIS_LEFT_PARENTHESES,
:PARENTHESIS_RIGHT,
:PERCENT,
:PERCENT_EQUAL,
:PERCENT_LOWER_I,
:PERCENT_LOWER_W,
:PERCENT_LOWER_X,
:PERCENT_UPPER_I,
:PERCENT_UPPER_W,
:PIPE,
:PIPE_EQUAL,
:PIPE_PIPE,
:PIPE_PIPE_EQUAL,
:PLUS,
:PLUS_EQUAL,
:QUESTION_MARK,
:REGEXP_BEGIN,
:REGEXP_END,
:SEMICOLON,
:SLASH,
:SLASH_EQUAL,
:STAR,
:STAR_EQUAL,
:STAR_STAR,
:STAR_STAR_EQUAL,
:STRING_BEGIN,
:STRING_CONTENT,
:STRING_END,
:SYMBOL_BEGIN,
:TILDE,
:UAMPERSAND,
:UCOLON_COLON,
:UDOT_DOT,
:UDOT_DOT_DOT,
:UMINUS,
:UMINUS_NUM,
:UPLUS,
:USTAR,
:USTAR_STAR,
:WORDS_SEP,
:__END__,
]
end
end
share/ruby/prism/parse_result.rb 0000644 00000032670 15173517735 0013044 0 ustar 00 # frozen_string_literal: true
module Prism
# This represents a source of Ruby code that has been parsed. It is used in
# conjunction with locations to allow them to resolve line numbers and source
# ranges.
class Source
# The source code that this source object represents.
attr_reader :source
# The line number where this source starts.
attr_accessor :start_line
# The list of newline byte offsets in the source code.
attr_reader :offsets
# Create a new source object with the given source code and newline byte
# offsets. If no newline byte offsets are given, they will be computed from
# the source code.
def initialize(source, start_line = 1, offsets = compute_offsets(source))
@source = source
@start_line = start_line
@offsets = offsets
end
# Perform a byteslice on the source code using the given byte offset and
# byte length.
def slice(byte_offset, length)
source.byteslice(byte_offset, length)
end
# Binary search through the offsets to find the line number for the given
# byte offset.
def line(byte_offset)
start_line + find_line(byte_offset)
end
# Return the byte offset of the start of the line corresponding to the given
# byte offset.
def line_start(byte_offset)
offsets[find_line(byte_offset)]
end
# Return the column number for the given byte offset.
def column(byte_offset)
byte_offset - line_start(byte_offset)
end
# Return the character offset for the given byte offset.
def character_offset(byte_offset)
source.byteslice(0, byte_offset).length
end
# Return the column number in characters for the given byte offset.
def character_column(byte_offset)
character_offset(byte_offset) - character_offset(line_start(byte_offset))
end
private
# Binary search through the offsets to find the line number for the given
# byte offset.
def find_line(byte_offset)
left = 0
right = offsets.length - 1
while left <= right
mid = left + (right - left) / 2
return mid if offsets[mid] == byte_offset
if offsets[mid] < byte_offset
left = mid + 1
else
right = mid - 1
end
end
left - 1
end
# Find all of the newlines in the source code and return their byte offsets
# from the start of the string an array.
def compute_offsets(code)
offsets = [0]
code.b.scan("\n") { offsets << $~.end(0) }
offsets
end
end
# This represents a location in the source.
class Location
# A Source object that is used to determine more information from the given
# offset and length.
protected attr_reader :source
# The byte offset from the beginning of the source where this location
# starts.
attr_reader :start_offset
# The length of this location in bytes.
attr_reader :length
# The list of comments attached to this location
attr_reader :comments
# Create a new location object with the given source, start byte offset, and
# byte length.
def initialize(source, start_offset, length)
@source = source
@start_offset = start_offset
@length = length
@comments = []
end
# Create a new location object with the given options.
def copy(**options)
Location.new(
options.fetch(:source) { source },
options.fetch(:start_offset) { start_offset },
options.fetch(:length) { length }
)
end
# Returns a string representation of this location.
def inspect
"#<Prism::Location @start_offset=#{@start_offset} @length=#{@length} start_line=#{start_line}>"
end
# The source code that this location represents.
def slice
source.slice(start_offset, length)
end
# The character offset from the beginning of the source where this location
# starts.
def start_character_offset
source.character_offset(start_offset)
end
# The byte offset from the beginning of the source where this location ends.
def end_offset
start_offset + length
end
# The character offset from the beginning of the source where this location
# ends.
def end_character_offset
source.character_offset(end_offset)
end
# The line number where this location starts.
def start_line
source.line(start_offset)
end
# The content of the line where this location starts before this location.
def start_line_slice
offset = source.line_start(start_offset)
source.slice(offset, start_offset - offset)
end
# The line number where this location ends.
def end_line
source.line(end_offset)
end
# The column number in bytes where this location starts from the start of
# the line.
def start_column
source.column(start_offset)
end
# The column number in characters where this location ends from the start of
# the line.
def start_character_column
source.character_column(start_offset)
end
# The column number in bytes where this location ends from the start of the
# line.
def end_column
source.column(end_offset)
end
# The column number in characters where this location ends from the start of
# the line.
def end_character_column
source.character_column(end_offset)
end
# Implement the hash pattern matching interface for Location.
def deconstruct_keys(keys)
{ start_offset: start_offset, end_offset: end_offset }
end
# Implement the pretty print interface for Location.
def pretty_print(q)
q.text("(#{start_line},#{start_column})-(#{end_line},#{end_column})")
end
# Returns true if the given other location is equal to this location.
def ==(other)
other.is_a?(Location) &&
other.start_offset == start_offset &&
other.end_offset == end_offset
end
# Returns a new location that stretches from this location to the given
# other location. Raises an error if this location is not before the other
# location or if they don't share the same source.
def join(other)
raise "Incompatible sources" if source != other.source
raise "Incompatible locations" if start_offset > other.start_offset
Location.new(source, start_offset, other.end_offset - start_offset)
end
# Returns a null location that does not correspond to a source and points to
# the beginning of the file. Useful for when you want a location object but
# do not care where it points.
def self.null
new(nil, 0, 0)
end
end
# This represents a comment that was encountered during parsing. It is the
# base class for all comment types.
class Comment
# The location of this comment in the source.
attr_reader :location
# Create a new comment object with the given location.
def initialize(location)
@location = location
end
# Implement the hash pattern matching interface for Comment.
def deconstruct_keys(keys)
{ location: location }
end
end
# InlineComment objects are the most common. They correspond to comments in
# the source file like this one that start with #.
class InlineComment < Comment
# Returns true if this comment happens on the same line as other code and
# false if the comment is by itself.
def trailing?
!location.start_line_slice.strip.empty?
end
# Returns a string representation of this comment.
def inspect
"#<Prism::InlineComment @location=#{location.inspect}>"
end
end
# EmbDocComment objects correspond to comments that are surrounded by =begin
# and =end.
class EmbDocComment < Comment
# This can only be true for inline comments.
def trailing?
false
end
# Returns a string representation of this comment.
def inspect
"#<Prism::EmbDocComment @location=#{location.inspect}>"
end
end
# This represents a magic comment that was encountered during parsing.
class MagicComment
# A Location object representing the location of the key in the source.
attr_reader :key_loc
# A Location object representing the location of the value in the source.
attr_reader :value_loc
# Create a new magic comment object with the given key and value locations.
def initialize(key_loc, value_loc)
@key_loc = key_loc
@value_loc = value_loc
end
# Returns the key of the magic comment by slicing it from the source code.
def key
key_loc.slice
end
# Returns the value of the magic comment by slicing it from the source code.
def value
value_loc.slice
end
# Implement the hash pattern matching interface for MagicComment.
def deconstruct_keys(keys)
{ key_loc: key_loc, value_loc: value_loc }
end
# Returns a string representation of this magic comment.
def inspect
"#<Prism::MagicComment @key=#{key.inspect} @value=#{value.inspect}>"
end
end
# This represents an error that was encountered during parsing.
class ParseError
# The message associated with this error.
attr_reader :message
# A Location object representing the location of this error in the source.
attr_reader :location
# Create a new error object with the given message and location.
def initialize(message, location)
@message = message
@location = location
end
# Implement the hash pattern matching interface for ParseError.
def deconstruct_keys(keys)
{ message: message, location: location }
end
# Returns a string representation of this error.
def inspect
"#<Prism::ParseError @message=#{@message.inspect} @location=#{@location.inspect}>"
end
end
# This represents a warning that was encountered during parsing.
class ParseWarning
# The message associated with this warning.
attr_reader :message
# A Location object representing the location of this warning in the source.
attr_reader :location
# Create a new warning object with the given message and location.
def initialize(message, location)
@message = message
@location = location
end
# Implement the hash pattern matching interface for ParseWarning.
def deconstruct_keys(keys)
{ message: message, location: location }
end
# Returns a string representation of this warning.
def inspect
"#<Prism::ParseWarning @message=#{@message.inspect} @location=#{@location.inspect}>"
end
end
# This represents the result of a call to ::parse or ::parse_file. It contains
# the AST, any comments that were encounters, and any errors that were
# encountered.
class ParseResult
# The value that was generated by parsing. Normally this holds the AST, but
# it can sometimes how a list of tokens or other results passed back from
# the parser.
attr_reader :value
# The list of comments that were encountered during parsing.
attr_reader :comments
# The list of magic comments that were encountered during parsing.
attr_reader :magic_comments
# An optional location that represents the location of the content after the
# __END__ marker. This content is loaded into the DATA constant when the
# file being parsed is the main file being executed.
attr_reader :data_loc
# The list of errors that were generated during parsing.
attr_reader :errors
# The list of warnings that were generated during parsing.
attr_reader :warnings
# A Source instance that represents the source code that was parsed.
attr_reader :source
# Create a new parse result object with the given values.
def initialize(value, comments, magic_comments, data_loc, errors, warnings, source)
@value = value
@comments = comments
@magic_comments = magic_comments
@data_loc = data_loc
@errors = errors
@warnings = warnings
@source = source
end
# Implement the hash pattern matching interface for ParseResult.
def deconstruct_keys(keys)
{ value: value, comments: comments, magic_comments: magic_comments, data_loc: data_loc, errors: errors, warnings: warnings }
end
# Returns true if there were no errors during parsing and false if there
# were.
def success?
errors.empty?
end
# Returns true if there were errors during parsing and false if there were
# not.
def failure?
!success?
end
end
# This represents a token from the Ruby source.
class Token
# The type of token that this token is.
attr_reader :type
# A byteslice of the source that this token represents.
attr_reader :value
# A Location object representing the location of this token in the source.
attr_reader :location
# Create a new token object with the given type, value, and location.
def initialize(type, value, location)
@type = type
@value = value
@location = location
end
# Implement the hash pattern matching interface for Token.
def deconstruct_keys(keys)
{ type: type, value: value, location: location }
end
# Implement the pretty print interface for Token.
def pretty_print(q)
q.group do
q.text(type.to_s)
self.location.pretty_print(q)
q.text("(")
q.nest(2) do
q.breakable("")
q.pp(value)
end
q.breakable("")
q.text(")")
end
end
# Returns true if the given other token is equal to this token.
def ==(other)
other.is_a?(Token) &&
other.type == type &&
other.value == value
end
end
end
share/ruby/prism/pattern.rb 0000644 00000017073 15173517735 0012011 0 ustar 00 # frozen_string_literal: true
module Prism
# A pattern is an object that wraps a Ruby pattern matching expression. The
# expression would normally be passed to an `in` clause within a `case`
# expression or a rightward assignment expression. For example, in the
# following snippet:
#
# case node
# in ConstantPathNode[ConstantReadNode[name: :Prism], ConstantReadNode[name: :Pattern]]
# end
#
# the pattern is the <tt>ConstantPathNode[...]</tt> expression.
#
# The pattern gets compiled into an object that responds to #call by running
# the #compile method. This method itself will run back through Prism to
# parse the expression into a tree, then walk the tree to generate the
# necessary callable objects. For example, if you wanted to compile the
# expression above into a callable, you would:
#
# callable = Prism::Pattern.new("ConstantPathNode[ConstantReadNode[name: :Prism], ConstantReadNode[name: :Pattern]]").compile
# callable.call(node)
#
# The callable object returned by #compile is guaranteed to respond to #call
# with a single argument, which is the node to match against. It also is
# guaranteed to respond to #===, which means it itself can be used in a `case`
# expression, as in:
#
# case node
# when callable
# end
#
# If the query given to the initializer cannot be compiled into a valid
# matcher (either because of a syntax error or because it is using syntax we
# do not yet support) then a Prism::Pattern::CompilationError will be
# raised.
class Pattern
# Raised when the query given to a pattern is either invalid Ruby syntax or
# is using syntax that we don't yet support.
class CompilationError < StandardError
# Create a new CompilationError with the given representation of the node
# that caused the error.
def initialize(repr)
super(<<~ERROR)
prism was unable to compile the pattern you provided into a usable
expression. It failed on to understand the node represented by:
#{repr}
Note that not all syntax supported by Ruby's pattern matching syntax
is also supported by prism's patterns. If you're using some syntax
that you believe should be supported, please open an issue on
GitHub at https://github.com/ruby/prism/issues/new.
ERROR
end
end
# The query that this pattern was initialized with.
attr_reader :query
# Create a new pattern with the given query. The query should be a string
# containing a Ruby pattern matching expression.
def initialize(query)
@query = query
@compiled = nil
end
# Compile the query into a callable object that can be used to match against
# nodes.
def compile
result = Prism.parse("case nil\nin #{query}\nend")
compile_node(result.value.statements.body.last.conditions.last.pattern)
end
# Scan the given node and all of its children for nodes that match the
# pattern. If a block is given, it will be called with each node that
# matches the pattern. If no block is given, an enumerator will be returned
# that will yield each node that matches the pattern.
def scan(root)
return to_enum(__method__, root) unless block_given?
@compiled ||= compile
queue = [root]
while (node = queue.shift)
yield node if @compiled.call(node)
queue.concat(node.compact_child_nodes)
end
end
private
# Shortcut for combining two procs into one that returns true if both return
# true.
def combine_and(left, right)
->(other) { left.call(other) && right.call(other) }
end
# Shortcut for combining two procs into one that returns true if either
# returns true.
def combine_or(left, right)
->(other) { left.call(other) || right.call(other) }
end
# Raise an error because the given node is not supported.
def compile_error(node)
raise CompilationError, node.inspect
end
# in [foo, bar, baz]
def compile_array_pattern_node(node)
compile_error(node) if !node.rest.nil? || node.posts.any?
constant = node.constant
compiled_constant = compile_node(constant) if constant
preprocessed = node.requireds.map { |required| compile_node(required) }
compiled_requireds = ->(other) do
deconstructed = other.deconstruct
deconstructed.length == preprocessed.length &&
preprocessed
.zip(deconstructed)
.all? { |(matcher, value)| matcher.call(value) }
end
if compiled_constant
combine_and(compiled_constant, compiled_requireds)
else
compiled_requireds
end
end
# in foo | bar
def compile_alternation_pattern_node(node)
combine_or(compile_node(node.left), compile_node(node.right))
end
# in Prism::ConstantReadNode
def compile_constant_path_node(node)
parent = node.parent
if parent.is_a?(ConstantReadNode) && parent.slice == "Prism"
compile_node(node.child)
else
compile_error(node)
end
end
# in ConstantReadNode
# in String
def compile_constant_read_node(node)
value = node.slice
if Prism.const_defined?(value, false)
clazz = Prism.const_get(value)
->(other) { clazz === other }
elsif Object.const_defined?(value, false)
clazz = Object.const_get(value)
->(other) { clazz === other }
else
compile_error(node)
end
end
# in InstanceVariableReadNode[name: Symbol]
# in { name: Symbol }
def compile_hash_pattern_node(node)
compile_error(node) if node.rest
compiled_constant = compile_node(node.constant) if node.constant
preprocessed =
node.elements.to_h do |element|
[element.key.unescaped.to_sym, compile_node(element.value)]
end
compiled_keywords = ->(other) do
deconstructed = other.deconstruct_keys(preprocessed.keys)
preprocessed.all? do |keyword, matcher|
deconstructed.key?(keyword) && matcher.call(deconstructed[keyword])
end
end
if compiled_constant
combine_and(compiled_constant, compiled_keywords)
else
compiled_keywords
end
end
# in nil
def compile_nil_node(node)
->(attribute) { attribute.nil? }
end
# in /foo/
def compile_regular_expression_node(node)
regexp = Regexp.new(node.unescaped, node.closing[1..])
->(attribute) { regexp === attribute }
end
# in ""
# in "foo"
def compile_string_node(node)
string = node.unescaped
->(attribute) { string === attribute }
end
# in :+
# in :foo
def compile_symbol_node(node)
symbol = node.unescaped.to_sym
->(attribute) { symbol === attribute }
end
# Compile any kind of node. Dispatch out to the individual compilation
# methods based on the type of node.
def compile_node(node)
case node
when AlternationPatternNode
compile_alternation_pattern_node(node)
when ArrayPatternNode
compile_array_pattern_node(node)
when ConstantPathNode
compile_constant_path_node(node)
when ConstantReadNode
compile_constant_read_node(node)
when HashPatternNode
compile_hash_pattern_node(node)
when NilNode
compile_nil_node(node)
when RegularExpressionNode
compile_regular_expression_node(node)
when StringNode
compile_string_node(node)
when SymbolNode
compile_symbol_node(node)
else
compile_error(node)
end
end
end
end
share/ruby/prism/visitor.rb 0000644 00000036027 15173517735 0012033 0 ustar 00 # frozen_string_literal: true
=begin
This file is generated by the templates/template.rb script and should not be
modified manually. See templates/lib/prism/visitor.rb.erb
if you are looking to modify the template
=end
module Prism
# A class that knows how to walk down the tree. None of the individual visit
# methods are implemented on this visitor, so it forces the consumer to
# implement each one that they need. For a default implementation that
# continues walking the tree, see the Visitor class.
class BasicVisitor
# Calls `accept` on the given node if it is not `nil`, which in turn should
# call back into this visitor by calling the appropriate `visit_*` method.
def visit(node)
node&.accept(self)
end
# Visits each node in `nodes` by calling `accept` on each one.
def visit_all(nodes)
nodes.each { |node| node&.accept(self) }
end
# Visits the child nodes of `node` by calling `accept` on each one.
def visit_child_nodes(node)
node.compact_child_nodes.each { |node| node.accept(self) }
end
end
# A visitor is a class that provides a default implementation for every accept
# method defined on the nodes. This means it can walk a tree without the
# caller needing to define any special handling. This allows you to handle a
# subset of the tree, while still walking the whole tree.
#
# For example, to find all of the method calls that call the `foo` method, you
# could write:
#
# class FooCalls < Prism::Visitor
# def visit_call_node(node)
# if node.name == "foo"
# # Do something with the node
# end
#
# # Call super so that the visitor continues walking the tree
# super
# end
# end
#
class Visitor < BasicVisitor
# Visit a AliasGlobalVariableNode node
alias visit_alias_global_variable_node visit_child_nodes
# Visit a AliasMethodNode node
alias visit_alias_method_node visit_child_nodes
# Visit a AlternationPatternNode node
alias visit_alternation_pattern_node visit_child_nodes
# Visit a AndNode node
alias visit_and_node visit_child_nodes
# Visit a ArgumentsNode node
alias visit_arguments_node visit_child_nodes
# Visit a ArrayNode node
alias visit_array_node visit_child_nodes
# Visit a ArrayPatternNode node
alias visit_array_pattern_node visit_child_nodes
# Visit a AssocNode node
alias visit_assoc_node visit_child_nodes
# Visit a AssocSplatNode node
alias visit_assoc_splat_node visit_child_nodes
# Visit a BackReferenceReadNode node
alias visit_back_reference_read_node visit_child_nodes
# Visit a BeginNode node
alias visit_begin_node visit_child_nodes
# Visit a BlockArgumentNode node
alias visit_block_argument_node visit_child_nodes
# Visit a BlockLocalVariableNode node
alias visit_block_local_variable_node visit_child_nodes
# Visit a BlockNode node
alias visit_block_node visit_child_nodes
# Visit a BlockParameterNode node
alias visit_block_parameter_node visit_child_nodes
# Visit a BlockParametersNode node
alias visit_block_parameters_node visit_child_nodes
# Visit a BreakNode node
alias visit_break_node visit_child_nodes
# Visit a CallAndWriteNode node
alias visit_call_and_write_node visit_child_nodes
# Visit a CallNode node
alias visit_call_node visit_child_nodes
# Visit a CallOperatorWriteNode node
alias visit_call_operator_write_node visit_child_nodes
# Visit a CallOrWriteNode node
alias visit_call_or_write_node visit_child_nodes
# Visit a CallTargetNode node
alias visit_call_target_node visit_child_nodes
# Visit a CapturePatternNode node
alias visit_capture_pattern_node visit_child_nodes
# Visit a CaseMatchNode node
alias visit_case_match_node visit_child_nodes
# Visit a CaseNode node
alias visit_case_node visit_child_nodes
# Visit a ClassNode node
alias visit_class_node visit_child_nodes
# Visit a ClassVariableAndWriteNode node
alias visit_class_variable_and_write_node visit_child_nodes
# Visit a ClassVariableOperatorWriteNode node
alias visit_class_variable_operator_write_node visit_child_nodes
# Visit a ClassVariableOrWriteNode node
alias visit_class_variable_or_write_node visit_child_nodes
# Visit a ClassVariableReadNode node
alias visit_class_variable_read_node visit_child_nodes
# Visit a ClassVariableTargetNode node
alias visit_class_variable_target_node visit_child_nodes
# Visit a ClassVariableWriteNode node
alias visit_class_variable_write_node visit_child_nodes
# Visit a ConstantAndWriteNode node
alias visit_constant_and_write_node visit_child_nodes
# Visit a ConstantOperatorWriteNode node
alias visit_constant_operator_write_node visit_child_nodes
# Visit a ConstantOrWriteNode node
alias visit_constant_or_write_node visit_child_nodes
# Visit a ConstantPathAndWriteNode node
alias visit_constant_path_and_write_node visit_child_nodes
# Visit a ConstantPathNode node
alias visit_constant_path_node visit_child_nodes
# Visit a ConstantPathOperatorWriteNode node
alias visit_constant_path_operator_write_node visit_child_nodes
# Visit a ConstantPathOrWriteNode node
alias visit_constant_path_or_write_node visit_child_nodes
# Visit a ConstantPathTargetNode node
alias visit_constant_path_target_node visit_child_nodes
# Visit a ConstantPathWriteNode node
alias visit_constant_path_write_node visit_child_nodes
# Visit a ConstantReadNode node
alias visit_constant_read_node visit_child_nodes
# Visit a ConstantTargetNode node
alias visit_constant_target_node visit_child_nodes
# Visit a ConstantWriteNode node
alias visit_constant_write_node visit_child_nodes
# Visit a DefNode node
alias visit_def_node visit_child_nodes
# Visit a DefinedNode node
alias visit_defined_node visit_child_nodes
# Visit a ElseNode node
alias visit_else_node visit_child_nodes
# Visit a EmbeddedStatementsNode node
alias visit_embedded_statements_node visit_child_nodes
# Visit a EmbeddedVariableNode node
alias visit_embedded_variable_node visit_child_nodes
# Visit a EnsureNode node
alias visit_ensure_node visit_child_nodes
# Visit a FalseNode node
alias visit_false_node visit_child_nodes
# Visit a FindPatternNode node
alias visit_find_pattern_node visit_child_nodes
# Visit a FlipFlopNode node
alias visit_flip_flop_node visit_child_nodes
# Visit a FloatNode node
alias visit_float_node visit_child_nodes
# Visit a ForNode node
alias visit_for_node visit_child_nodes
# Visit a ForwardingArgumentsNode node
alias visit_forwarding_arguments_node visit_child_nodes
# Visit a ForwardingParameterNode node
alias visit_forwarding_parameter_node visit_child_nodes
# Visit a ForwardingSuperNode node
alias visit_forwarding_super_node visit_child_nodes
# Visit a GlobalVariableAndWriteNode node
alias visit_global_variable_and_write_node visit_child_nodes
# Visit a GlobalVariableOperatorWriteNode node
alias visit_global_variable_operator_write_node visit_child_nodes
# Visit a GlobalVariableOrWriteNode node
alias visit_global_variable_or_write_node visit_child_nodes
# Visit a GlobalVariableReadNode node
alias visit_global_variable_read_node visit_child_nodes
# Visit a GlobalVariableTargetNode node
alias visit_global_variable_target_node visit_child_nodes
# Visit a GlobalVariableWriteNode node
alias visit_global_variable_write_node visit_child_nodes
# Visit a HashNode node
alias visit_hash_node visit_child_nodes
# Visit a HashPatternNode node
alias visit_hash_pattern_node visit_child_nodes
# Visit a IfNode node
alias visit_if_node visit_child_nodes
# Visit a ImaginaryNode node
alias visit_imaginary_node visit_child_nodes
# Visit a ImplicitNode node
alias visit_implicit_node visit_child_nodes
# Visit a ImplicitRestNode node
alias visit_implicit_rest_node visit_child_nodes
# Visit a InNode node
alias visit_in_node visit_child_nodes
# Visit a IndexAndWriteNode node
alias visit_index_and_write_node visit_child_nodes
# Visit a IndexOperatorWriteNode node
alias visit_index_operator_write_node visit_child_nodes
# Visit a IndexOrWriteNode node
alias visit_index_or_write_node visit_child_nodes
# Visit a IndexTargetNode node
alias visit_index_target_node visit_child_nodes
# Visit a InstanceVariableAndWriteNode node
alias visit_instance_variable_and_write_node visit_child_nodes
# Visit a InstanceVariableOperatorWriteNode node
alias visit_instance_variable_operator_write_node visit_child_nodes
# Visit a InstanceVariableOrWriteNode node
alias visit_instance_variable_or_write_node visit_child_nodes
# Visit a InstanceVariableReadNode node
alias visit_instance_variable_read_node visit_child_nodes
# Visit a InstanceVariableTargetNode node
alias visit_instance_variable_target_node visit_child_nodes
# Visit a InstanceVariableWriteNode node
alias visit_instance_variable_write_node visit_child_nodes
# Visit a IntegerNode node
alias visit_integer_node visit_child_nodes
# Visit a InterpolatedMatchLastLineNode node
alias visit_interpolated_match_last_line_node visit_child_nodes
# Visit a InterpolatedRegularExpressionNode node
alias visit_interpolated_regular_expression_node visit_child_nodes
# Visit a InterpolatedStringNode node
alias visit_interpolated_string_node visit_child_nodes
# Visit a InterpolatedSymbolNode node
alias visit_interpolated_symbol_node visit_child_nodes
# Visit a InterpolatedXStringNode node
alias visit_interpolated_x_string_node visit_child_nodes
# Visit a KeywordHashNode node
alias visit_keyword_hash_node visit_child_nodes
# Visit a KeywordRestParameterNode node
alias visit_keyword_rest_parameter_node visit_child_nodes
# Visit a LambdaNode node
alias visit_lambda_node visit_child_nodes
# Visit a LocalVariableAndWriteNode node
alias visit_local_variable_and_write_node visit_child_nodes
# Visit a LocalVariableOperatorWriteNode node
alias visit_local_variable_operator_write_node visit_child_nodes
# Visit a LocalVariableOrWriteNode node
alias visit_local_variable_or_write_node visit_child_nodes
# Visit a LocalVariableReadNode node
alias visit_local_variable_read_node visit_child_nodes
# Visit a LocalVariableTargetNode node
alias visit_local_variable_target_node visit_child_nodes
# Visit a LocalVariableWriteNode node
alias visit_local_variable_write_node visit_child_nodes
# Visit a MatchLastLineNode node
alias visit_match_last_line_node visit_child_nodes
# Visit a MatchPredicateNode node
alias visit_match_predicate_node visit_child_nodes
# Visit a MatchRequiredNode node
alias visit_match_required_node visit_child_nodes
# Visit a MatchWriteNode node
alias visit_match_write_node visit_child_nodes
# Visit a MissingNode node
alias visit_missing_node visit_child_nodes
# Visit a ModuleNode node
alias visit_module_node visit_child_nodes
# Visit a MultiTargetNode node
alias visit_multi_target_node visit_child_nodes
# Visit a MultiWriteNode node
alias visit_multi_write_node visit_child_nodes
# Visit a NextNode node
alias visit_next_node visit_child_nodes
# Visit a NilNode node
alias visit_nil_node visit_child_nodes
# Visit a NoKeywordsParameterNode node
alias visit_no_keywords_parameter_node visit_child_nodes
# Visit a NumberedParametersNode node
alias visit_numbered_parameters_node visit_child_nodes
# Visit a NumberedReferenceReadNode node
alias visit_numbered_reference_read_node visit_child_nodes
# Visit a OptionalKeywordParameterNode node
alias visit_optional_keyword_parameter_node visit_child_nodes
# Visit a OptionalParameterNode node
alias visit_optional_parameter_node visit_child_nodes
# Visit a OrNode node
alias visit_or_node visit_child_nodes
# Visit a ParametersNode node
alias visit_parameters_node visit_child_nodes
# Visit a ParenthesesNode node
alias visit_parentheses_node visit_child_nodes
# Visit a PinnedExpressionNode node
alias visit_pinned_expression_node visit_child_nodes
# Visit a PinnedVariableNode node
alias visit_pinned_variable_node visit_child_nodes
# Visit a PostExecutionNode node
alias visit_post_execution_node visit_child_nodes
# Visit a PreExecutionNode node
alias visit_pre_execution_node visit_child_nodes
# Visit a ProgramNode node
alias visit_program_node visit_child_nodes
# Visit a RangeNode node
alias visit_range_node visit_child_nodes
# Visit a RationalNode node
alias visit_rational_node visit_child_nodes
# Visit a RedoNode node
alias visit_redo_node visit_child_nodes
# Visit a RegularExpressionNode node
alias visit_regular_expression_node visit_child_nodes
# Visit a RequiredKeywordParameterNode node
alias visit_required_keyword_parameter_node visit_child_nodes
# Visit a RequiredParameterNode node
alias visit_required_parameter_node visit_child_nodes
# Visit a RescueModifierNode node
alias visit_rescue_modifier_node visit_child_nodes
# Visit a RescueNode node
alias visit_rescue_node visit_child_nodes
# Visit a RestParameterNode node
alias visit_rest_parameter_node visit_child_nodes
# Visit a RetryNode node
alias visit_retry_node visit_child_nodes
# Visit a ReturnNode node
alias visit_return_node visit_child_nodes
# Visit a SelfNode node
alias visit_self_node visit_child_nodes
# Visit a SingletonClassNode node
alias visit_singleton_class_node visit_child_nodes
# Visit a SourceEncodingNode node
alias visit_source_encoding_node visit_child_nodes
# Visit a SourceFileNode node
alias visit_source_file_node visit_child_nodes
# Visit a SourceLineNode node
alias visit_source_line_node visit_child_nodes
# Visit a SplatNode node
alias visit_splat_node visit_child_nodes
# Visit a StatementsNode node
alias visit_statements_node visit_child_nodes
# Visit a StringNode node
alias visit_string_node visit_child_nodes
# Visit a SuperNode node
alias visit_super_node visit_child_nodes
# Visit a SymbolNode node
alias visit_symbol_node visit_child_nodes
# Visit a TrueNode node
alias visit_true_node visit_child_nodes
# Visit a UndefNode node
alias visit_undef_node visit_child_nodes
# Visit a UnlessNode node
alias visit_unless_node visit_child_nodes
# Visit a UntilNode node
alias visit_until_node visit_child_nodes
# Visit a WhenNode node
alias visit_when_node visit_child_nodes
# Visit a WhileNode node
alias visit_while_node visit_child_nodes
# Visit a XStringNode node
alias visit_x_string_node visit_child_nodes
# Visit a YieldNode node
alias visit_yield_node visit_child_nodes
end
end
share/ruby/prism/dsl.rb 0000644 00000077765 15173517735 0011134 0 ustar 00 # frozen_string_literal: true
=begin
This file is generated by the templates/template.rb script and should not be
modified manually. See templates/lib/prism/dsl.rb.erb
if you are looking to modify the template
=end
module Prism
# The DSL module provides a set of methods that can be used to create prism
# nodes in a more concise manner. For example, instead of writing:
#
# source = Prism::Source.new("[1]")
#
# Prism::ArrayNode.new(
# [
# Prism::IntegerNode.new(
# Prism::IntegerBaseFlags::DECIMAL,
# Prism::Location.new(source, 1, 1),
# )
# ],
# Prism::Location.new(source, 0, 1),
# Prism::Location.new(source, 2, 1)
# )
#
# you could instead write:
#
# source = Prism::Source.new("[1]")
#
# ArrayNode(
# IntegerNode(Prism::IntegerBaseFlags::DECIMAL, Location(source, 1, 1))),
# Location(source, 0, 1),
# Location(source, 2, 1)
# )
#
# This is mostly helpful in the context of writing tests, but can also be used
# to generate trees programmatically.
module DSL
private
# Create a new Location object
def Location(source = nil, start_offset = 0, length = 0)
Location.new(source, start_offset, length)
end
# Create a new AliasGlobalVariableNode node
def AliasGlobalVariableNode(new_name, old_name, keyword_loc, location = Location())
AliasGlobalVariableNode.new(new_name, old_name, keyword_loc, location)
end
# Create a new AliasMethodNode node
def AliasMethodNode(new_name, old_name, keyword_loc, location = Location())
AliasMethodNode.new(new_name, old_name, keyword_loc, location)
end
# Create a new AlternationPatternNode node
def AlternationPatternNode(left, right, operator_loc, location = Location())
AlternationPatternNode.new(left, right, operator_loc, location)
end
# Create a new AndNode node
def AndNode(left, right, operator_loc, location = Location())
AndNode.new(left, right, operator_loc, location)
end
# Create a new ArgumentsNode node
def ArgumentsNode(flags, arguments, location = Location())
ArgumentsNode.new(flags, arguments, location)
end
# Create a new ArrayNode node
def ArrayNode(flags, elements, opening_loc, closing_loc, location = Location())
ArrayNode.new(flags, elements, opening_loc, closing_loc, location)
end
# Create a new ArrayPatternNode node
def ArrayPatternNode(constant, requireds, rest, posts, opening_loc, closing_loc, location = Location())
ArrayPatternNode.new(constant, requireds, rest, posts, opening_loc, closing_loc, location)
end
# Create a new AssocNode node
def AssocNode(key, value, operator_loc, location = Location())
AssocNode.new(key, value, operator_loc, location)
end
# Create a new AssocSplatNode node
def AssocSplatNode(value, operator_loc, location = Location())
AssocSplatNode.new(value, operator_loc, location)
end
# Create a new BackReferenceReadNode node
def BackReferenceReadNode(name, location = Location())
BackReferenceReadNode.new(name, location)
end
# Create a new BeginNode node
def BeginNode(begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc, location = Location())
BeginNode.new(begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc, location)
end
# Create a new BlockArgumentNode node
def BlockArgumentNode(expression, operator_loc, location = Location())
BlockArgumentNode.new(expression, operator_loc, location)
end
# Create a new BlockLocalVariableNode node
def BlockLocalVariableNode(name, location = Location())
BlockLocalVariableNode.new(name, location)
end
# Create a new BlockNode node
def BlockNode(locals, locals_body_index, parameters, body, opening_loc, closing_loc, location = Location())
BlockNode.new(locals, locals_body_index, parameters, body, opening_loc, closing_loc, location)
end
# Create a new BlockParameterNode node
def BlockParameterNode(name, name_loc, operator_loc, location = Location())
BlockParameterNode.new(name, name_loc, operator_loc, location)
end
# Create a new BlockParametersNode node
def BlockParametersNode(parameters, locals, opening_loc, closing_loc, location = Location())
BlockParametersNode.new(parameters, locals, opening_loc, closing_loc, location)
end
# Create a new BreakNode node
def BreakNode(arguments, keyword_loc, location = Location())
BreakNode.new(arguments, keyword_loc, location)
end
# Create a new CallAndWriteNode node
def CallAndWriteNode(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location = Location())
CallAndWriteNode.new(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location)
end
# Create a new CallNode node
def CallNode(flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block, location = Location())
CallNode.new(flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block, location)
end
# Create a new CallOperatorWriteNode node
def CallOperatorWriteNode(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator, operator_loc, value, location = Location())
CallOperatorWriteNode.new(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator, operator_loc, value, location)
end
# Create a new CallOrWriteNode node
def CallOrWriteNode(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location = Location())
CallOrWriteNode.new(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location)
end
# Create a new CallTargetNode node
def CallTargetNode(flags, receiver, call_operator_loc, name, message_loc, location = Location())
CallTargetNode.new(flags, receiver, call_operator_loc, name, message_loc, location)
end
# Create a new CapturePatternNode node
def CapturePatternNode(value, target, operator_loc, location = Location())
CapturePatternNode.new(value, target, operator_loc, location)
end
# Create a new CaseMatchNode node
def CaseMatchNode(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location = Location())
CaseMatchNode.new(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location)
end
# Create a new CaseNode node
def CaseNode(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location = Location())
CaseNode.new(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location)
end
# Create a new ClassNode node
def ClassNode(locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name, location = Location())
ClassNode.new(locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name, location)
end
# Create a new ClassVariableAndWriteNode node
def ClassVariableAndWriteNode(name, name_loc, operator_loc, value, location = Location())
ClassVariableAndWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new ClassVariableOperatorWriteNode node
def ClassVariableOperatorWriteNode(name, name_loc, operator_loc, value, operator, location = Location())
ClassVariableOperatorWriteNode.new(name, name_loc, operator_loc, value, operator, location)
end
# Create a new ClassVariableOrWriteNode node
def ClassVariableOrWriteNode(name, name_loc, operator_loc, value, location = Location())
ClassVariableOrWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new ClassVariableReadNode node
def ClassVariableReadNode(name, location = Location())
ClassVariableReadNode.new(name, location)
end
# Create a new ClassVariableTargetNode node
def ClassVariableTargetNode(name, location = Location())
ClassVariableTargetNode.new(name, location)
end
# Create a new ClassVariableWriteNode node
def ClassVariableWriteNode(name, name_loc, value, operator_loc, location = Location())
ClassVariableWriteNode.new(name, name_loc, value, operator_loc, location)
end
# Create a new ConstantAndWriteNode node
def ConstantAndWriteNode(name, name_loc, operator_loc, value, location = Location())
ConstantAndWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new ConstantOperatorWriteNode node
def ConstantOperatorWriteNode(name, name_loc, operator_loc, value, operator, location = Location())
ConstantOperatorWriteNode.new(name, name_loc, operator_loc, value, operator, location)
end
# Create a new ConstantOrWriteNode node
def ConstantOrWriteNode(name, name_loc, operator_loc, value, location = Location())
ConstantOrWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new ConstantPathAndWriteNode node
def ConstantPathAndWriteNode(target, operator_loc, value, location = Location())
ConstantPathAndWriteNode.new(target, operator_loc, value, location)
end
# Create a new ConstantPathNode node
def ConstantPathNode(parent, child, delimiter_loc, location = Location())
ConstantPathNode.new(parent, child, delimiter_loc, location)
end
# Create a new ConstantPathOperatorWriteNode node
def ConstantPathOperatorWriteNode(target, operator_loc, value, operator, location = Location())
ConstantPathOperatorWriteNode.new(target, operator_loc, value, operator, location)
end
# Create a new ConstantPathOrWriteNode node
def ConstantPathOrWriteNode(target, operator_loc, value, location = Location())
ConstantPathOrWriteNode.new(target, operator_loc, value, location)
end
# Create a new ConstantPathTargetNode node
def ConstantPathTargetNode(parent, child, delimiter_loc, location = Location())
ConstantPathTargetNode.new(parent, child, delimiter_loc, location)
end
# Create a new ConstantPathWriteNode node
def ConstantPathWriteNode(target, operator_loc, value, location = Location())
ConstantPathWriteNode.new(target, operator_loc, value, location)
end
# Create a new ConstantReadNode node
def ConstantReadNode(name, location = Location())
ConstantReadNode.new(name, location)
end
# Create a new ConstantTargetNode node
def ConstantTargetNode(name, location = Location())
ConstantTargetNode.new(name, location)
end
# Create a new ConstantWriteNode node
def ConstantWriteNode(name, name_loc, value, operator_loc, location = Location())
ConstantWriteNode.new(name, name_loc, value, operator_loc, location)
end
# Create a new DefNode node
def DefNode(name, name_loc, receiver, parameters, body, locals, locals_body_index, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location = Location())
DefNode.new(name, name_loc, receiver, parameters, body, locals, locals_body_index, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location)
end
# Create a new DefinedNode node
def DefinedNode(lparen_loc, value, rparen_loc, keyword_loc, location = Location())
DefinedNode.new(lparen_loc, value, rparen_loc, keyword_loc, location)
end
# Create a new ElseNode node
def ElseNode(else_keyword_loc, statements, end_keyword_loc, location = Location())
ElseNode.new(else_keyword_loc, statements, end_keyword_loc, location)
end
# Create a new EmbeddedStatementsNode node
def EmbeddedStatementsNode(opening_loc, statements, closing_loc, location = Location())
EmbeddedStatementsNode.new(opening_loc, statements, closing_loc, location)
end
# Create a new EmbeddedVariableNode node
def EmbeddedVariableNode(operator_loc, variable, location = Location())
EmbeddedVariableNode.new(operator_loc, variable, location)
end
# Create a new EnsureNode node
def EnsureNode(ensure_keyword_loc, statements, end_keyword_loc, location = Location())
EnsureNode.new(ensure_keyword_loc, statements, end_keyword_loc, location)
end
# Create a new FalseNode node
def FalseNode(location = Location())
FalseNode.new(location)
end
# Create a new FindPatternNode node
def FindPatternNode(constant, left, requireds, right, opening_loc, closing_loc, location = Location())
FindPatternNode.new(constant, left, requireds, right, opening_loc, closing_loc, location)
end
# Create a new FlipFlopNode node
def FlipFlopNode(flags, left, right, operator_loc, location = Location())
FlipFlopNode.new(flags, left, right, operator_loc, location)
end
# Create a new FloatNode node
def FloatNode(location = Location())
FloatNode.new(location)
end
# Create a new ForNode node
def ForNode(index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location = Location())
ForNode.new(index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location)
end
# Create a new ForwardingArgumentsNode node
def ForwardingArgumentsNode(location = Location())
ForwardingArgumentsNode.new(location)
end
# Create a new ForwardingParameterNode node
def ForwardingParameterNode(location = Location())
ForwardingParameterNode.new(location)
end
# Create a new ForwardingSuperNode node
def ForwardingSuperNode(block, location = Location())
ForwardingSuperNode.new(block, location)
end
# Create a new GlobalVariableAndWriteNode node
def GlobalVariableAndWriteNode(name, name_loc, operator_loc, value, location = Location())
GlobalVariableAndWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new GlobalVariableOperatorWriteNode node
def GlobalVariableOperatorWriteNode(name, name_loc, operator_loc, value, operator, location = Location())
GlobalVariableOperatorWriteNode.new(name, name_loc, operator_loc, value, operator, location)
end
# Create a new GlobalVariableOrWriteNode node
def GlobalVariableOrWriteNode(name, name_loc, operator_loc, value, location = Location())
GlobalVariableOrWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new GlobalVariableReadNode node
def GlobalVariableReadNode(name, location = Location())
GlobalVariableReadNode.new(name, location)
end
# Create a new GlobalVariableTargetNode node
def GlobalVariableTargetNode(name, location = Location())
GlobalVariableTargetNode.new(name, location)
end
# Create a new GlobalVariableWriteNode node
def GlobalVariableWriteNode(name, name_loc, value, operator_loc, location = Location())
GlobalVariableWriteNode.new(name, name_loc, value, operator_loc, location)
end
# Create a new HashNode node
def HashNode(opening_loc, elements, closing_loc, location = Location())
HashNode.new(opening_loc, elements, closing_loc, location)
end
# Create a new HashPatternNode node
def HashPatternNode(constant, elements, rest, opening_loc, closing_loc, location = Location())
HashPatternNode.new(constant, elements, rest, opening_loc, closing_loc, location)
end
# Create a new IfNode node
def IfNode(if_keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location = Location())
IfNode.new(if_keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
end
# Create a new ImaginaryNode node
def ImaginaryNode(numeric, location = Location())
ImaginaryNode.new(numeric, location)
end
# Create a new ImplicitNode node
def ImplicitNode(value, location = Location())
ImplicitNode.new(value, location)
end
# Create a new ImplicitRestNode node
def ImplicitRestNode(location = Location())
ImplicitRestNode.new(location)
end
# Create a new InNode node
def InNode(pattern, statements, in_loc, then_loc, location = Location())
InNode.new(pattern, statements, in_loc, then_loc, location)
end
# Create a new IndexAndWriteNode node
def IndexAndWriteNode(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value, location = Location())
IndexAndWriteNode.new(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value, location)
end
# Create a new IndexOperatorWriteNode node
def IndexOperatorWriteNode(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator, operator_loc, value, location = Location())
IndexOperatorWriteNode.new(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator, operator_loc, value, location)
end
# Create a new IndexOrWriteNode node
def IndexOrWriteNode(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value, location = Location())
IndexOrWriteNode.new(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value, location)
end
# Create a new IndexTargetNode node
def IndexTargetNode(flags, receiver, opening_loc, arguments, closing_loc, block, location = Location())
IndexTargetNode.new(flags, receiver, opening_loc, arguments, closing_loc, block, location)
end
# Create a new InstanceVariableAndWriteNode node
def InstanceVariableAndWriteNode(name, name_loc, operator_loc, value, location = Location())
InstanceVariableAndWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new InstanceVariableOperatorWriteNode node
def InstanceVariableOperatorWriteNode(name, name_loc, operator_loc, value, operator, location = Location())
InstanceVariableOperatorWriteNode.new(name, name_loc, operator_loc, value, operator, location)
end
# Create a new InstanceVariableOrWriteNode node
def InstanceVariableOrWriteNode(name, name_loc, operator_loc, value, location = Location())
InstanceVariableOrWriteNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new InstanceVariableReadNode node
def InstanceVariableReadNode(name, location = Location())
InstanceVariableReadNode.new(name, location)
end
# Create a new InstanceVariableTargetNode node
def InstanceVariableTargetNode(name, location = Location())
InstanceVariableTargetNode.new(name, location)
end
# Create a new InstanceVariableWriteNode node
def InstanceVariableWriteNode(name, name_loc, value, operator_loc, location = Location())
InstanceVariableWriteNode.new(name, name_loc, value, operator_loc, location)
end
# Create a new IntegerNode node
def IntegerNode(flags, location = Location())
IntegerNode.new(flags, location)
end
# Create a new InterpolatedMatchLastLineNode node
def InterpolatedMatchLastLineNode(flags, opening_loc, parts, closing_loc, location = Location())
InterpolatedMatchLastLineNode.new(flags, opening_loc, parts, closing_loc, location)
end
# Create a new InterpolatedRegularExpressionNode node
def InterpolatedRegularExpressionNode(flags, opening_loc, parts, closing_loc, location = Location())
InterpolatedRegularExpressionNode.new(flags, opening_loc, parts, closing_loc, location)
end
# Create a new InterpolatedStringNode node
def InterpolatedStringNode(opening_loc, parts, closing_loc, location = Location())
InterpolatedStringNode.new(opening_loc, parts, closing_loc, location)
end
# Create a new InterpolatedSymbolNode node
def InterpolatedSymbolNode(opening_loc, parts, closing_loc, location = Location())
InterpolatedSymbolNode.new(opening_loc, parts, closing_loc, location)
end
# Create a new InterpolatedXStringNode node
def InterpolatedXStringNode(opening_loc, parts, closing_loc, location = Location())
InterpolatedXStringNode.new(opening_loc, parts, closing_loc, location)
end
# Create a new KeywordHashNode node
def KeywordHashNode(flags, elements, location = Location())
KeywordHashNode.new(flags, elements, location)
end
# Create a new KeywordRestParameterNode node
def KeywordRestParameterNode(name, name_loc, operator_loc, location = Location())
KeywordRestParameterNode.new(name, name_loc, operator_loc, location)
end
# Create a new LambdaNode node
def LambdaNode(locals, locals_body_index, operator_loc, opening_loc, closing_loc, parameters, body, location = Location())
LambdaNode.new(locals, locals_body_index, operator_loc, opening_loc, closing_loc, parameters, body, location)
end
# Create a new LocalVariableAndWriteNode node
def LocalVariableAndWriteNode(name_loc, operator_loc, value, name, depth, location = Location())
LocalVariableAndWriteNode.new(name_loc, operator_loc, value, name, depth, location)
end
# Create a new LocalVariableOperatorWriteNode node
def LocalVariableOperatorWriteNode(name_loc, operator_loc, value, name, operator, depth, location = Location())
LocalVariableOperatorWriteNode.new(name_loc, operator_loc, value, name, operator, depth, location)
end
# Create a new LocalVariableOrWriteNode node
def LocalVariableOrWriteNode(name_loc, operator_loc, value, name, depth, location = Location())
LocalVariableOrWriteNode.new(name_loc, operator_loc, value, name, depth, location)
end
# Create a new LocalVariableReadNode node
def LocalVariableReadNode(name, depth, location = Location())
LocalVariableReadNode.new(name, depth, location)
end
# Create a new LocalVariableTargetNode node
def LocalVariableTargetNode(name, depth, location = Location())
LocalVariableTargetNode.new(name, depth, location)
end
# Create a new LocalVariableWriteNode node
def LocalVariableWriteNode(name, depth, name_loc, value, operator_loc, location = Location())
LocalVariableWriteNode.new(name, depth, name_loc, value, operator_loc, location)
end
# Create a new MatchLastLineNode node
def MatchLastLineNode(flags, opening_loc, content_loc, closing_loc, unescaped, location = Location())
MatchLastLineNode.new(flags, opening_loc, content_loc, closing_loc, unescaped, location)
end
# Create a new MatchPredicateNode node
def MatchPredicateNode(value, pattern, operator_loc, location = Location())
MatchPredicateNode.new(value, pattern, operator_loc, location)
end
# Create a new MatchRequiredNode node
def MatchRequiredNode(value, pattern, operator_loc, location = Location())
MatchRequiredNode.new(value, pattern, operator_loc, location)
end
# Create a new MatchWriteNode node
def MatchWriteNode(call, targets, location = Location())
MatchWriteNode.new(call, targets, location)
end
# Create a new MissingNode node
def MissingNode(location = Location())
MissingNode.new(location)
end
# Create a new ModuleNode node
def ModuleNode(locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location = Location())
ModuleNode.new(locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location)
end
# Create a new MultiTargetNode node
def MultiTargetNode(lefts, rest, rights, lparen_loc, rparen_loc, location = Location())
MultiTargetNode.new(lefts, rest, rights, lparen_loc, rparen_loc, location)
end
# Create a new MultiWriteNode node
def MultiWriteNode(lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location = Location())
MultiWriteNode.new(lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location)
end
# Create a new NextNode node
def NextNode(arguments, keyword_loc, location = Location())
NextNode.new(arguments, keyword_loc, location)
end
# Create a new NilNode node
def NilNode(location = Location())
NilNode.new(location)
end
# Create a new NoKeywordsParameterNode node
def NoKeywordsParameterNode(operator_loc, keyword_loc, location = Location())
NoKeywordsParameterNode.new(operator_loc, keyword_loc, location)
end
# Create a new NumberedParametersNode node
def NumberedParametersNode(maximum, location = Location())
NumberedParametersNode.new(maximum, location)
end
# Create a new NumberedReferenceReadNode node
def NumberedReferenceReadNode(number, location = Location())
NumberedReferenceReadNode.new(number, location)
end
# Create a new OptionalKeywordParameterNode node
def OptionalKeywordParameterNode(name, name_loc, value, location = Location())
OptionalKeywordParameterNode.new(name, name_loc, value, location)
end
# Create a new OptionalParameterNode node
def OptionalParameterNode(name, name_loc, operator_loc, value, location = Location())
OptionalParameterNode.new(name, name_loc, operator_loc, value, location)
end
# Create a new OrNode node
def OrNode(left, right, operator_loc, location = Location())
OrNode.new(left, right, operator_loc, location)
end
# Create a new ParametersNode node
def ParametersNode(requireds, optionals, rest, posts, keywords, keyword_rest, block, location = Location())
ParametersNode.new(requireds, optionals, rest, posts, keywords, keyword_rest, block, location)
end
# Create a new ParenthesesNode node
def ParenthesesNode(body, opening_loc, closing_loc, location = Location())
ParenthesesNode.new(body, opening_loc, closing_loc, location)
end
# Create a new PinnedExpressionNode node
def PinnedExpressionNode(expression, operator_loc, lparen_loc, rparen_loc, location = Location())
PinnedExpressionNode.new(expression, operator_loc, lparen_loc, rparen_loc, location)
end
# Create a new PinnedVariableNode node
def PinnedVariableNode(variable, operator_loc, location = Location())
PinnedVariableNode.new(variable, operator_loc, location)
end
# Create a new PostExecutionNode node
def PostExecutionNode(statements, keyword_loc, opening_loc, closing_loc, location = Location())
PostExecutionNode.new(statements, keyword_loc, opening_loc, closing_loc, location)
end
# Create a new PreExecutionNode node
def PreExecutionNode(statements, keyword_loc, opening_loc, closing_loc, location = Location())
PreExecutionNode.new(statements, keyword_loc, opening_loc, closing_loc, location)
end
# Create a new ProgramNode node
def ProgramNode(locals, statements, location = Location())
ProgramNode.new(locals, statements, location)
end
# Create a new RangeNode node
def RangeNode(flags, left, right, operator_loc, location = Location())
RangeNode.new(flags, left, right, operator_loc, location)
end
# Create a new RationalNode node
def RationalNode(numeric, location = Location())
RationalNode.new(numeric, location)
end
# Create a new RedoNode node
def RedoNode(location = Location())
RedoNode.new(location)
end
# Create a new RegularExpressionNode node
def RegularExpressionNode(flags, opening_loc, content_loc, closing_loc, unescaped, location = Location())
RegularExpressionNode.new(flags, opening_loc, content_loc, closing_loc, unescaped, location)
end
# Create a new RequiredKeywordParameterNode node
def RequiredKeywordParameterNode(name, name_loc, location = Location())
RequiredKeywordParameterNode.new(name, name_loc, location)
end
# Create a new RequiredParameterNode node
def RequiredParameterNode(name, location = Location())
RequiredParameterNode.new(name, location)
end
# Create a new RescueModifierNode node
def RescueModifierNode(expression, keyword_loc, rescue_expression, location = Location())
RescueModifierNode.new(expression, keyword_loc, rescue_expression, location)
end
# Create a new RescueNode node
def RescueNode(keyword_loc, exceptions, operator_loc, reference, statements, consequent, location = Location())
RescueNode.new(keyword_loc, exceptions, operator_loc, reference, statements, consequent, location)
end
# Create a new RestParameterNode node
def RestParameterNode(name, name_loc, operator_loc, location = Location())
RestParameterNode.new(name, name_loc, operator_loc, location)
end
# Create a new RetryNode node
def RetryNode(location = Location())
RetryNode.new(location)
end
# Create a new ReturnNode node
def ReturnNode(keyword_loc, arguments, location = Location())
ReturnNode.new(keyword_loc, arguments, location)
end
# Create a new SelfNode node
def SelfNode(location = Location())
SelfNode.new(location)
end
# Create a new SingletonClassNode node
def SingletonClassNode(locals, class_keyword_loc, operator_loc, expression, body, end_keyword_loc, location = Location())
SingletonClassNode.new(locals, class_keyword_loc, operator_loc, expression, body, end_keyword_loc, location)
end
# Create a new SourceEncodingNode node
def SourceEncodingNode(location = Location())
SourceEncodingNode.new(location)
end
# Create a new SourceFileNode node
def SourceFileNode(filepath, location = Location())
SourceFileNode.new(filepath, location)
end
# Create a new SourceLineNode node
def SourceLineNode(location = Location())
SourceLineNode.new(location)
end
# Create a new SplatNode node
def SplatNode(operator_loc, expression, location = Location())
SplatNode.new(operator_loc, expression, location)
end
# Create a new StatementsNode node
def StatementsNode(body, location = Location())
StatementsNode.new(body, location)
end
# Create a new StringNode node
def StringNode(flags, opening_loc, content_loc, closing_loc, unescaped, location = Location())
StringNode.new(flags, opening_loc, content_loc, closing_loc, unescaped, location)
end
# Create a new SuperNode node
def SuperNode(keyword_loc, lparen_loc, arguments, rparen_loc, block, location = Location())
SuperNode.new(keyword_loc, lparen_loc, arguments, rparen_loc, block, location)
end
# Create a new SymbolNode node
def SymbolNode(flags, opening_loc, value_loc, closing_loc, unescaped, location = Location())
SymbolNode.new(flags, opening_loc, value_loc, closing_loc, unescaped, location)
end
# Create a new TrueNode node
def TrueNode(location = Location())
TrueNode.new(location)
end
# Create a new UndefNode node
def UndefNode(names, keyword_loc, location = Location())
UndefNode.new(names, keyword_loc, location)
end
# Create a new UnlessNode node
def UnlessNode(keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location = Location())
UnlessNode.new(keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
end
# Create a new UntilNode node
def UntilNode(flags, keyword_loc, closing_loc, predicate, statements, location = Location())
UntilNode.new(flags, keyword_loc, closing_loc, predicate, statements, location)
end
# Create a new WhenNode node
def WhenNode(keyword_loc, conditions, statements, location = Location())
WhenNode.new(keyword_loc, conditions, statements, location)
end
# Create a new WhileNode node
def WhileNode(flags, keyword_loc, closing_loc, predicate, statements, location = Location())
WhileNode.new(flags, keyword_loc, closing_loc, predicate, statements, location)
end
# Create a new XStringNode node
def XStringNode(flags, opening_loc, content_loc, closing_loc, unescaped, location = Location())
XStringNode.new(flags, opening_loc, content_loc, closing_loc, unescaped, location)
end
# Create a new YieldNode node
def YieldNode(keyword_loc, lparen_loc, arguments, rparen_loc, location = Location())
YieldNode.new(keyword_loc, lparen_loc, arguments, rparen_loc, location)
end
end
end
share/ruby/prism/ripper_compat.rb 0000644 00000013713 15173517735 0013175 0 ustar 00 # frozen_string_literal: true
require "ripper"
module Prism
# Note: This integration is not finished, and therefore still has many
# inconsistencies with Ripper. If you'd like to help out, pull requests would
# be greatly appreciated!
#
# This class is meant to provide a compatibility layer between prism and
# Ripper. It functions by parsing the entire tree first and then walking it
# and executing each of the Ripper callbacks as it goes.
#
# This class is going to necessarily be slower than the native Ripper API. It
# is meant as a stopgap until developers migrate to using prism. It is also
# meant as a test harness for the prism parser.
#
# To use this class, you treat `Prism::RipperCompat` effectively as you would
# treat the `Ripper` class.
class RipperCompat < Visitor
# This class mirrors the ::Ripper::SexpBuilder subclass of ::Ripper that
# returns the arrays of [type, *children].
class SexpBuilder < RipperCompat
private
Ripper::PARSER_EVENTS.each do |event|
define_method(:"on_#{event}") do |*args|
[event, *args]
end
end
Ripper::SCANNER_EVENTS.each do |event|
define_method(:"on_#{event}") do |value|
[:"@#{event}", value, [lineno, column]]
end
end
end
# This class mirrors the ::Ripper::SexpBuilderPP subclass of ::Ripper that
# returns the same values as ::Ripper::SexpBuilder except with a couple of
# niceties that flatten linked lists into arrays.
class SexpBuilderPP < SexpBuilder
private
def _dispatch_event_new # :nodoc:
[]
end
def _dispatch_event_push(list, item) # :nodoc:
list << item
list
end
Ripper::PARSER_EVENT_TABLE.each do |event, arity|
case event
when /_new\z/
alias_method :"on_#{event}", :_dispatch_event_new if arity == 0
when /_add\z/
alias_method :"on_#{event}", :_dispatch_event_push
end
end
end
# The source that is being parsed.
attr_reader :source
# The current line number of the parser.
attr_reader :lineno
# The current column number of the parser.
attr_reader :column
# Create a new RipperCompat object with the given source.
def initialize(source)
@source = source
@result = nil
@lineno = nil
@column = nil
end
############################################################################
# Public interface
############################################################################
# True if the parser encountered an error during parsing.
def error?
result.failure?
end
# Parse the source and return the result.
def parse
result.magic_comments.each do |magic_comment|
on_magic_comment(magic_comment.key, magic_comment.value)
end
if error?
result.errors.each do |error|
on_parse_error(error.message)
end
else
result.value.accept(self)
end
end
############################################################################
# Visitor methods
############################################################################
# Visit a CallNode node.
def visit_call_node(node)
if !node.message.match?(/^[[:alpha:]_]/) && node.opening_loc.nil? && node.arguments&.arguments&.length == 1
left = visit(node.receiver)
right = visit(node.arguments.arguments.first)
bounds(node.location)
on_binary(left, node.name, right)
else
raise NotImplementedError
end
end
# Visit a FloatNode node.
def visit_float_node(node)
bounds(node.location)
on_float(node.slice)
end
# Visit a ImaginaryNode node.
def visit_imaginary_node(node)
bounds(node.location)
on_imaginary(node.slice)
end
# Visit an IntegerNode node.
def visit_integer_node(node)
bounds(node.location)
on_int(node.slice)
end
# Visit a RationalNode node.
def visit_rational_node(node)
bounds(node.location)
on_rational(node.slice)
end
# Visit a StatementsNode node.
def visit_statements_node(node)
bounds(node.location)
node.body.inject(on_stmts_new) do |stmts, stmt|
on_stmts_add(stmts, visit(stmt))
end
end
# Visit a ProgramNode node.
def visit_program_node(node)
statements = visit(node.statements)
bounds(node.location)
on_program(statements)
end
############################################################################
# Entrypoints for subclasses
############################################################################
# This is a convenience method that runs the SexpBuilder subclass parser.
def self.sexp_raw(source)
SexpBuilder.new(source).parse
end
# This is a convenience method that runs the SexpBuilderPP subclass parser.
def self.sexp(source)
SexpBuilderPP.new(source).parse
end
private
# This method is responsible for updating lineno and column information
# to reflect the current node.
#
# This method could be drastically improved with some caching on the start
# of every line, but for now it's good enough.
def bounds(location)
@lineno = location.start_line
@column = location.start_column
end
# Lazily initialize the parse result.
def result
@result ||= Prism.parse(source)
end
def _dispatch0; end # :nodoc:
def _dispatch1(_); end # :nodoc:
def _dispatch2(_, _); end # :nodoc:
def _dispatch3(_, _, _); end # :nodoc:
def _dispatch4(_, _, _, _); end # :nodoc:
def _dispatch5(_, _, _, _, _); end # :nodoc:
def _dispatch7(_, _, _, _, _, _, _); end # :nodoc:
alias_method :on_parse_error, :_dispatch1
alias_method :on_magic_comment, :_dispatch2
(Ripper::SCANNER_EVENT_TABLE.merge(Ripper::PARSER_EVENT_TABLE)).each do |event, arity|
alias_method :"on_#{event}", :"_dispatch#{arity}"
end
end
end
share/ruby/prism/ffi.rb 0000644 00000024420 15173517735 0011072 0 ustar 00 # frozen_string_literal: true
# This file is responsible for mirroring the API provided by the C extension by
# using FFI to call into the shared library.
require "rbconfig"
require "ffi"
module Prism
BACKEND = :FFI
module LibRubyParser # :nodoc:
extend FFI::Library
# Define the library that we will be pulling functions from. Note that this
# must align with the build shared library from make/rake.
ffi_lib File.expand_path("../../build/libprism.#{RbConfig::CONFIG["SOEXT"]}", __dir__)
# Convert a native C type declaration into a symbol that FFI understands.
# For example:
#
# const char * -> :pointer
# bool -> :bool
# size_t -> :size_t
# void -> :void
#
def self.resolve_type(type)
type = type.strip
type.end_with?("*") ? :pointer : type.delete_prefix("const ").to_sym
end
# Read through the given header file and find the declaration of each of the
# given functions. For each one, define a function with the same name and
# signature as the C function.
def self.load_exported_functions_from(header, *functions)
File.foreach(File.expand_path("../../include/#{header}", __dir__)) do |line|
# We only want to attempt to load exported functions.
next unless line.start_with?("PRISM_EXPORTED_FUNCTION ")
# We only want to load the functions that we are interested in.
next unless functions.any? { |function| line.include?(function) }
# Parse the function declaration.
unless /^PRISM_EXPORTED_FUNCTION (?<return_type>.+) (?<name>\w+)\((?<arg_types>.+)\);$/ =~ line
raise "Could not parse #{line}"
end
# Delete the function from the list of functions we are looking for to
# mark it as having been found.
functions.delete(name)
# Split up the argument types into an array, ensure we handle the case
# where there are no arguments (by explicit void).
arg_types = arg_types.split(",").map(&:strip)
arg_types = [] if arg_types == %w[void]
# Resolve the type of the argument by dropping the name of the argument
# first if it is present.
arg_types.map! { |type| resolve_type(type.sub(/\w+$/, "")) }
# Attach the function using the FFI library.
attach_function name, arg_types, resolve_type(return_type)
end
# If we didn't find all of the functions, raise an error.
raise "Could not find functions #{functions.inspect}" unless functions.empty?
end
load_exported_functions_from(
"prism.h",
"pm_version",
"pm_serialize_parse",
"pm_serialize_parse_comments",
"pm_serialize_lex",
"pm_serialize_parse_lex",
"pm_parse_success_p"
)
load_exported_functions_from(
"prism/util/pm_buffer.h",
"pm_buffer_sizeof",
"pm_buffer_init",
"pm_buffer_value",
"pm_buffer_length",
"pm_buffer_free"
)
load_exported_functions_from(
"prism/util/pm_string.h",
"pm_string_mapped_init",
"pm_string_free",
"pm_string_source",
"pm_string_length",
"pm_string_sizeof"
)
# This object represents a pm_buffer_t. We only use it as an opaque pointer,
# so it doesn't need to know the fields of pm_buffer_t.
class PrismBuffer # :nodoc:
SIZEOF = LibRubyParser.pm_buffer_sizeof
attr_reader :pointer
def initialize(pointer)
@pointer = pointer
end
def value
LibRubyParser.pm_buffer_value(pointer)
end
def length
LibRubyParser.pm_buffer_length(pointer)
end
def read
value.read_string(length)
end
# Initialize a new buffer and yield it to the block. The buffer will be
# automatically freed when the block returns.
def self.with(&block)
pointer = FFI::MemoryPointer.new(SIZEOF)
begin
raise unless LibRubyParser.pm_buffer_init(pointer)
yield new(pointer)
ensure
LibRubyParser.pm_buffer_free(pointer)
pointer.free
end
end
end
# This object represents a pm_string_t. We only use it as an opaque pointer,
# so it doesn't have to be an FFI::Struct.
class PrismString # :nodoc:
SIZEOF = LibRubyParser.pm_string_sizeof
attr_reader :pointer
def initialize(pointer)
@pointer = pointer
end
def source
LibRubyParser.pm_string_source(pointer)
end
def length
LibRubyParser.pm_string_length(pointer)
end
def read
source.read_string(length)
end
# Yields a pm_string_t pointer to the given block.
def self.with(filepath, &block)
pointer = FFI::MemoryPointer.new(SIZEOF)
begin
raise unless LibRubyParser.pm_string_mapped_init(pointer, filepath)
yield new(pointer)
ensure
LibRubyParser.pm_string_free(pointer)
pointer.free
end
end
end
end
# Mark the LibRubyParser module as private as it should only be called through
# the prism module.
private_constant :LibRubyParser
# The version constant is set by reading the result of calling pm_version.
VERSION = LibRubyParser.pm_version.read_string
class << self
# Mirror the Prism.dump API by using the serialization API.
def dump(code, **options)
LibRubyParser::PrismBuffer.with do |buffer|
LibRubyParser.pm_serialize_parse(buffer.pointer, code, code.bytesize, dump_options(options))
buffer.read
end
end
# Mirror the Prism.dump_file API by using the serialization API.
def dump_file(filepath, **options)
LibRubyParser::PrismString.with(filepath) do |string|
dump(string.read, **options, filepath: filepath)
end
end
# Mirror the Prism.lex API by using the serialization API.
def lex(code, **options)
LibRubyParser::PrismBuffer.with do |buffer|
LibRubyParser.pm_serialize_lex(buffer.pointer, code, code.bytesize, dump_options(options))
Serialize.load_tokens(Source.new(code), buffer.read)
end
end
# Mirror the Prism.lex_file API by using the serialization API.
def lex_file(filepath, **options)
LibRubyParser::PrismString.with(filepath) do |string|
lex(string.read, **options, filepath: filepath)
end
end
# Mirror the Prism.parse API by using the serialization API.
def parse(code, **options)
Prism.load(code, dump(code, **options))
end
# Mirror the Prism.parse_file API by using the serialization API. This uses
# native strings instead of Ruby strings because it allows us to use mmap when
# it is available.
def parse_file(filepath, **options)
LibRubyParser::PrismString.with(filepath) do |string|
parse(string.read, **options, filepath: filepath)
end
end
# Mirror the Prism.parse_comments API by using the serialization API.
def parse_comments(code, **options)
LibRubyParser::PrismBuffer.with do |buffer|
LibRubyParser.pm_serialize_parse_comments(buffer.pointer, code, code.bytesize, dump_options(options))
source = Source.new(code)
loader = Serialize::Loader.new(source, buffer.read)
loader.load_header
loader.load_encoding
loader.load_start_line
loader.load_comments
end
end
# Mirror the Prism.parse_file_comments API by using the serialization
# API. This uses native strings instead of Ruby strings because it allows us
# to use mmap when it is available.
def parse_file_comments(filepath, **options)
LibRubyParser::PrismString.with(filepath) do |string|
parse_comments(string.read, **options, filepath: filepath)
end
end
# Mirror the Prism.parse_lex API by using the serialization API.
def parse_lex(code, **options)
LibRubyParser::PrismBuffer.with do |buffer|
LibRubyParser.pm_serialize_parse_lex(buffer.pointer, code, code.bytesize, dump_options(options))
source = Source.new(code)
loader = Serialize::Loader.new(source, buffer.read)
tokens = loader.load_tokens
node, comments, magic_comments, data_loc, errors, warnings = loader.load_nodes
tokens.each { |token,| token.value.force_encoding(loader.encoding) }
ParseResult.new([node, tokens], comments, magic_comments, data_loc, errors, warnings, source)
end
end
# Mirror the Prism.parse_lex_file API by using the serialization API.
def parse_lex_file(filepath, **options)
LibRubyParser::PrismString.with(filepath) do |string|
parse_lex(string.read, **options, filepath: filepath)
end
end
# Mirror the Prism.parse_success? API by using the serialization API.
def parse_success?(code, **options)
LibRubyParser.pm_parse_success_p(code, code.bytesize, dump_options(options))
end
# Mirror the Prism.parse_file_success? API by using the serialization API.
def parse_file_success?(filepath, **options)
LibRubyParser::PrismString.with(filepath) do |string|
parse_success?(string.read, **options, filepath: filepath)
end
end
private
# Convert the given options into a serialized options string.
def dump_options(options)
template = +""
values = []
template << "L"
if (filepath = options[:filepath])
values.push(filepath.bytesize, filepath.b)
template << "A*"
else
values << 0
end
template << "L"
values << options.fetch(:line, 1)
template << "L"
if (encoding = options[:encoding])
name = encoding.name
values.push(name.bytesize, name.b)
template << "A*"
else
values << 0
end
template << "C"
values << (options.fetch(:frozen_string_literal, false) ? 1 : 0)
template << "C"
values << (options.fetch(:verbose, true) ? 0 : 1)
template << "L"
if (scopes = options[:scopes])
values << scopes.length
scopes.each do |scope|
template << "L"
values << scope.length
scope.each do |local|
name = local.name
template << "L"
values << name.bytesize
template << "A*"
values << name.b
end
end
else
values << 0
end
values.pack(template)
end
end
end
share/ruby/prism/dispatcher.rb 0000644 00000331631 15173517735 0012461 0 ustar 00 # frozen_string_literal: true
=begin
This file is generated by the templates/template.rb script and should not be
modified manually. See templates/lib/prism/dispatcher.rb.erb
if you are looking to modify the template
=end
module Prism
# The dispatcher class fires events for nodes that are found while walking an
# AST to all registered listeners. It's useful for performing different types
# of analysis on the AST while only having to walk the tree once.
#
# To use the dispatcher, you would first instantiate it and register listeners
# for the events you're interested in:
#
# class OctalListener
# def on_integer_node_enter(node)
# if node.octal? && !node.slice.start_with?("0o")
# warn("Octal integers should be written with the 0o prefix")
# end
# end
# end
#
# dispatcher = Dispatcher.new
# dispatcher.register(listener, :on_integer_node_enter)
#
# Then, you can walk any number of trees and dispatch events to the listeners:
#
# result = Prism.parse("001 + 002 + 003")
# dispatcher.dispatch(result.value)
#
# Optionally, you can also use `#dispatch_once` to dispatch enter and leave
# events for a single node without recursing further down the tree. This can
# be useful in circumstances where you want to reuse the listeners you already
# have registers but want to stop walking the tree at a certain point.
#
# integer = result.value.statements.body.first.receiver.receiver
# dispatcher.dispatch_once(integer)
#
class Dispatcher < Visitor
# attr_reader listeners: Hash[Symbol, Array[Listener]]
attr_reader :listeners
# Initialize a new dispatcher.
def initialize
@listeners = {}
end
# Register a listener for one or more events.
#
# def register: (Listener, *Symbol) -> void
def register(listener, *events)
events.each { |event| (listeners[event] ||= []) << listener }
end
# Walks `root` dispatching events to all registered listeners.
#
# def dispatch: (Node) -> void
alias dispatch visit
# Dispatches a single event for `node` to all registered listeners.
#
# def dispatch_once: (Node) -> void
def dispatch_once(node)
node.accept(DispatchOnce.new(listeners))
end
# Dispatch enter and leave events for AliasGlobalVariableNode nodes and continue
# walking the tree.
def visit_alias_global_variable_node(node)
listeners[:on_alias_global_variable_node_enter]&.each { |listener| listener.on_alias_global_variable_node_enter(node) }
super
listeners[:on_alias_global_variable_node_leave]&.each { |listener| listener.on_alias_global_variable_node_leave(node) }
end
# Dispatch enter and leave events for AliasMethodNode nodes and continue
# walking the tree.
def visit_alias_method_node(node)
listeners[:on_alias_method_node_enter]&.each { |listener| listener.on_alias_method_node_enter(node) }
super
listeners[:on_alias_method_node_leave]&.each { |listener| listener.on_alias_method_node_leave(node) }
end
# Dispatch enter and leave events for AlternationPatternNode nodes and continue
# walking the tree.
def visit_alternation_pattern_node(node)
listeners[:on_alternation_pattern_node_enter]&.each { |listener| listener.on_alternation_pattern_node_enter(node) }
super
listeners[:on_alternation_pattern_node_leave]&.each { |listener| listener.on_alternation_pattern_node_leave(node) }
end
# Dispatch enter and leave events for AndNode nodes and continue
# walking the tree.
def visit_and_node(node)
listeners[:on_and_node_enter]&.each { |listener| listener.on_and_node_enter(node) }
super
listeners[:on_and_node_leave]&.each { |listener| listener.on_and_node_leave(node) }
end
# Dispatch enter and leave events for ArgumentsNode nodes and continue
# walking the tree.
def visit_arguments_node(node)
listeners[:on_arguments_node_enter]&.each { |listener| listener.on_arguments_node_enter(node) }
super
listeners[:on_arguments_node_leave]&.each { |listener| listener.on_arguments_node_leave(node) }
end
# Dispatch enter and leave events for ArrayNode nodes and continue
# walking the tree.
def visit_array_node(node)
listeners[:on_array_node_enter]&.each { |listener| listener.on_array_node_enter(node) }
super
listeners[:on_array_node_leave]&.each { |listener| listener.on_array_node_leave(node) }
end
# Dispatch enter and leave events for ArrayPatternNode nodes and continue
# walking the tree.
def visit_array_pattern_node(node)
listeners[:on_array_pattern_node_enter]&.each { |listener| listener.on_array_pattern_node_enter(node) }
super
listeners[:on_array_pattern_node_leave]&.each { |listener| listener.on_array_pattern_node_leave(node) }
end
# Dispatch enter and leave events for AssocNode nodes and continue
# walking the tree.
def visit_assoc_node(node)
listeners[:on_assoc_node_enter]&.each { |listener| listener.on_assoc_node_enter(node) }
super
listeners[:on_assoc_node_leave]&.each { |listener| listener.on_assoc_node_leave(node) }
end
# Dispatch enter and leave events for AssocSplatNode nodes and continue
# walking the tree.
def visit_assoc_splat_node(node)
listeners[:on_assoc_splat_node_enter]&.each { |listener| listener.on_assoc_splat_node_enter(node) }
super
listeners[:on_assoc_splat_node_leave]&.each { |listener| listener.on_assoc_splat_node_leave(node) }
end
# Dispatch enter and leave events for BackReferenceReadNode nodes and continue
# walking the tree.
def visit_back_reference_read_node(node)
listeners[:on_back_reference_read_node_enter]&.each { |listener| listener.on_back_reference_read_node_enter(node) }
super
listeners[:on_back_reference_read_node_leave]&.each { |listener| listener.on_back_reference_read_node_leave(node) }
end
# Dispatch enter and leave events for BeginNode nodes and continue
# walking the tree.
def visit_begin_node(node)
listeners[:on_begin_node_enter]&.each { |listener| listener.on_begin_node_enter(node) }
super
listeners[:on_begin_node_leave]&.each { |listener| listener.on_begin_node_leave(node) }
end
# Dispatch enter and leave events for BlockArgumentNode nodes and continue
# walking the tree.
def visit_block_argument_node(node)
listeners[:on_block_argument_node_enter]&.each { |listener| listener.on_block_argument_node_enter(node) }
super
listeners[:on_block_argument_node_leave]&.each { |listener| listener.on_block_argument_node_leave(node) }
end
# Dispatch enter and leave events for BlockLocalVariableNode nodes and continue
# walking the tree.
def visit_block_local_variable_node(node)
listeners[:on_block_local_variable_node_enter]&.each { |listener| listener.on_block_local_variable_node_enter(node) }
super
listeners[:on_block_local_variable_node_leave]&.each { |listener| listener.on_block_local_variable_node_leave(node) }
end
# Dispatch enter and leave events for BlockNode nodes and continue
# walking the tree.
def visit_block_node(node)
listeners[:on_block_node_enter]&.each { |listener| listener.on_block_node_enter(node) }
super
listeners[:on_block_node_leave]&.each { |listener| listener.on_block_node_leave(node) }
end
# Dispatch enter and leave events for BlockParameterNode nodes and continue
# walking the tree.
def visit_block_parameter_node(node)
listeners[:on_block_parameter_node_enter]&.each { |listener| listener.on_block_parameter_node_enter(node) }
super
listeners[:on_block_parameter_node_leave]&.each { |listener| listener.on_block_parameter_node_leave(node) }
end
# Dispatch enter and leave events for BlockParametersNode nodes and continue
# walking the tree.
def visit_block_parameters_node(node)
listeners[:on_block_parameters_node_enter]&.each { |listener| listener.on_block_parameters_node_enter(node) }
super
listeners[:on_block_parameters_node_leave]&.each { |listener| listener.on_block_parameters_node_leave(node) }
end
# Dispatch enter and leave events for BreakNode nodes and continue
# walking the tree.
def visit_break_node(node)
listeners[:on_break_node_enter]&.each { |listener| listener.on_break_node_enter(node) }
super
listeners[:on_break_node_leave]&.each { |listener| listener.on_break_node_leave(node) }
end
# Dispatch enter and leave events for CallAndWriteNode nodes and continue
# walking the tree.
def visit_call_and_write_node(node)
listeners[:on_call_and_write_node_enter]&.each { |listener| listener.on_call_and_write_node_enter(node) }
super
listeners[:on_call_and_write_node_leave]&.each { |listener| listener.on_call_and_write_node_leave(node) }
end
# Dispatch enter and leave events for CallNode nodes and continue
# walking the tree.
def visit_call_node(node)
listeners[:on_call_node_enter]&.each { |listener| listener.on_call_node_enter(node) }
super
listeners[:on_call_node_leave]&.each { |listener| listener.on_call_node_leave(node) }
end
# Dispatch enter and leave events for CallOperatorWriteNode nodes and continue
# walking the tree.
def visit_call_operator_write_node(node)
listeners[:on_call_operator_write_node_enter]&.each { |listener| listener.on_call_operator_write_node_enter(node) }
super
listeners[:on_call_operator_write_node_leave]&.each { |listener| listener.on_call_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for CallOrWriteNode nodes and continue
# walking the tree.
def visit_call_or_write_node(node)
listeners[:on_call_or_write_node_enter]&.each { |listener| listener.on_call_or_write_node_enter(node) }
super
listeners[:on_call_or_write_node_leave]&.each { |listener| listener.on_call_or_write_node_leave(node) }
end
# Dispatch enter and leave events for CallTargetNode nodes and continue
# walking the tree.
def visit_call_target_node(node)
listeners[:on_call_target_node_enter]&.each { |listener| listener.on_call_target_node_enter(node) }
super
listeners[:on_call_target_node_leave]&.each { |listener| listener.on_call_target_node_leave(node) }
end
# Dispatch enter and leave events for CapturePatternNode nodes and continue
# walking the tree.
def visit_capture_pattern_node(node)
listeners[:on_capture_pattern_node_enter]&.each { |listener| listener.on_capture_pattern_node_enter(node) }
super
listeners[:on_capture_pattern_node_leave]&.each { |listener| listener.on_capture_pattern_node_leave(node) }
end
# Dispatch enter and leave events for CaseMatchNode nodes and continue
# walking the tree.
def visit_case_match_node(node)
listeners[:on_case_match_node_enter]&.each { |listener| listener.on_case_match_node_enter(node) }
super
listeners[:on_case_match_node_leave]&.each { |listener| listener.on_case_match_node_leave(node) }
end
# Dispatch enter and leave events for CaseNode nodes and continue
# walking the tree.
def visit_case_node(node)
listeners[:on_case_node_enter]&.each { |listener| listener.on_case_node_enter(node) }
super
listeners[:on_case_node_leave]&.each { |listener| listener.on_case_node_leave(node) }
end
# Dispatch enter and leave events for ClassNode nodes and continue
# walking the tree.
def visit_class_node(node)
listeners[:on_class_node_enter]&.each { |listener| listener.on_class_node_enter(node) }
super
listeners[:on_class_node_leave]&.each { |listener| listener.on_class_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableAndWriteNode nodes and continue
# walking the tree.
def visit_class_variable_and_write_node(node)
listeners[:on_class_variable_and_write_node_enter]&.each { |listener| listener.on_class_variable_and_write_node_enter(node) }
super
listeners[:on_class_variable_and_write_node_leave]&.each { |listener| listener.on_class_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableOperatorWriteNode nodes and continue
# walking the tree.
def visit_class_variable_operator_write_node(node)
listeners[:on_class_variable_operator_write_node_enter]&.each { |listener| listener.on_class_variable_operator_write_node_enter(node) }
super
listeners[:on_class_variable_operator_write_node_leave]&.each { |listener| listener.on_class_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableOrWriteNode nodes and continue
# walking the tree.
def visit_class_variable_or_write_node(node)
listeners[:on_class_variable_or_write_node_enter]&.each { |listener| listener.on_class_variable_or_write_node_enter(node) }
super
listeners[:on_class_variable_or_write_node_leave]&.each { |listener| listener.on_class_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableReadNode nodes and continue
# walking the tree.
def visit_class_variable_read_node(node)
listeners[:on_class_variable_read_node_enter]&.each { |listener| listener.on_class_variable_read_node_enter(node) }
super
listeners[:on_class_variable_read_node_leave]&.each { |listener| listener.on_class_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableTargetNode nodes and continue
# walking the tree.
def visit_class_variable_target_node(node)
listeners[:on_class_variable_target_node_enter]&.each { |listener| listener.on_class_variable_target_node_enter(node) }
super
listeners[:on_class_variable_target_node_leave]&.each { |listener| listener.on_class_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableWriteNode nodes and continue
# walking the tree.
def visit_class_variable_write_node(node)
listeners[:on_class_variable_write_node_enter]&.each { |listener| listener.on_class_variable_write_node_enter(node) }
super
listeners[:on_class_variable_write_node_leave]&.each { |listener| listener.on_class_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantAndWriteNode nodes and continue
# walking the tree.
def visit_constant_and_write_node(node)
listeners[:on_constant_and_write_node_enter]&.each { |listener| listener.on_constant_and_write_node_enter(node) }
super
listeners[:on_constant_and_write_node_leave]&.each { |listener| listener.on_constant_and_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantOperatorWriteNode nodes and continue
# walking the tree.
def visit_constant_operator_write_node(node)
listeners[:on_constant_operator_write_node_enter]&.each { |listener| listener.on_constant_operator_write_node_enter(node) }
super
listeners[:on_constant_operator_write_node_leave]&.each { |listener| listener.on_constant_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantOrWriteNode nodes and continue
# walking the tree.
def visit_constant_or_write_node(node)
listeners[:on_constant_or_write_node_enter]&.each { |listener| listener.on_constant_or_write_node_enter(node) }
super
listeners[:on_constant_or_write_node_leave]&.each { |listener| listener.on_constant_or_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathAndWriteNode nodes and continue
# walking the tree.
def visit_constant_path_and_write_node(node)
listeners[:on_constant_path_and_write_node_enter]&.each { |listener| listener.on_constant_path_and_write_node_enter(node) }
super
listeners[:on_constant_path_and_write_node_leave]&.each { |listener| listener.on_constant_path_and_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathNode nodes and continue
# walking the tree.
def visit_constant_path_node(node)
listeners[:on_constant_path_node_enter]&.each { |listener| listener.on_constant_path_node_enter(node) }
super
listeners[:on_constant_path_node_leave]&.each { |listener| listener.on_constant_path_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathOperatorWriteNode nodes and continue
# walking the tree.
def visit_constant_path_operator_write_node(node)
listeners[:on_constant_path_operator_write_node_enter]&.each { |listener| listener.on_constant_path_operator_write_node_enter(node) }
super
listeners[:on_constant_path_operator_write_node_leave]&.each { |listener| listener.on_constant_path_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathOrWriteNode nodes and continue
# walking the tree.
def visit_constant_path_or_write_node(node)
listeners[:on_constant_path_or_write_node_enter]&.each { |listener| listener.on_constant_path_or_write_node_enter(node) }
super
listeners[:on_constant_path_or_write_node_leave]&.each { |listener| listener.on_constant_path_or_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathTargetNode nodes and continue
# walking the tree.
def visit_constant_path_target_node(node)
listeners[:on_constant_path_target_node_enter]&.each { |listener| listener.on_constant_path_target_node_enter(node) }
super
listeners[:on_constant_path_target_node_leave]&.each { |listener| listener.on_constant_path_target_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathWriteNode nodes and continue
# walking the tree.
def visit_constant_path_write_node(node)
listeners[:on_constant_path_write_node_enter]&.each { |listener| listener.on_constant_path_write_node_enter(node) }
super
listeners[:on_constant_path_write_node_leave]&.each { |listener| listener.on_constant_path_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantReadNode nodes and continue
# walking the tree.
def visit_constant_read_node(node)
listeners[:on_constant_read_node_enter]&.each { |listener| listener.on_constant_read_node_enter(node) }
super
listeners[:on_constant_read_node_leave]&.each { |listener| listener.on_constant_read_node_leave(node) }
end
# Dispatch enter and leave events for ConstantTargetNode nodes and continue
# walking the tree.
def visit_constant_target_node(node)
listeners[:on_constant_target_node_enter]&.each { |listener| listener.on_constant_target_node_enter(node) }
super
listeners[:on_constant_target_node_leave]&.each { |listener| listener.on_constant_target_node_leave(node) }
end
# Dispatch enter and leave events for ConstantWriteNode nodes and continue
# walking the tree.
def visit_constant_write_node(node)
listeners[:on_constant_write_node_enter]&.each { |listener| listener.on_constant_write_node_enter(node) }
super
listeners[:on_constant_write_node_leave]&.each { |listener| listener.on_constant_write_node_leave(node) }
end
# Dispatch enter and leave events for DefNode nodes and continue
# walking the tree.
def visit_def_node(node)
listeners[:on_def_node_enter]&.each { |listener| listener.on_def_node_enter(node) }
super
listeners[:on_def_node_leave]&.each { |listener| listener.on_def_node_leave(node) }
end
# Dispatch enter and leave events for DefinedNode nodes and continue
# walking the tree.
def visit_defined_node(node)
listeners[:on_defined_node_enter]&.each { |listener| listener.on_defined_node_enter(node) }
super
listeners[:on_defined_node_leave]&.each { |listener| listener.on_defined_node_leave(node) }
end
# Dispatch enter and leave events for ElseNode nodes and continue
# walking the tree.
def visit_else_node(node)
listeners[:on_else_node_enter]&.each { |listener| listener.on_else_node_enter(node) }
super
listeners[:on_else_node_leave]&.each { |listener| listener.on_else_node_leave(node) }
end
# Dispatch enter and leave events for EmbeddedStatementsNode nodes and continue
# walking the tree.
def visit_embedded_statements_node(node)
listeners[:on_embedded_statements_node_enter]&.each { |listener| listener.on_embedded_statements_node_enter(node) }
super
listeners[:on_embedded_statements_node_leave]&.each { |listener| listener.on_embedded_statements_node_leave(node) }
end
# Dispatch enter and leave events for EmbeddedVariableNode nodes and continue
# walking the tree.
def visit_embedded_variable_node(node)
listeners[:on_embedded_variable_node_enter]&.each { |listener| listener.on_embedded_variable_node_enter(node) }
super
listeners[:on_embedded_variable_node_leave]&.each { |listener| listener.on_embedded_variable_node_leave(node) }
end
# Dispatch enter and leave events for EnsureNode nodes and continue
# walking the tree.
def visit_ensure_node(node)
listeners[:on_ensure_node_enter]&.each { |listener| listener.on_ensure_node_enter(node) }
super
listeners[:on_ensure_node_leave]&.each { |listener| listener.on_ensure_node_leave(node) }
end
# Dispatch enter and leave events for FalseNode nodes and continue
# walking the tree.
def visit_false_node(node)
listeners[:on_false_node_enter]&.each { |listener| listener.on_false_node_enter(node) }
super
listeners[:on_false_node_leave]&.each { |listener| listener.on_false_node_leave(node) }
end
# Dispatch enter and leave events for FindPatternNode nodes and continue
# walking the tree.
def visit_find_pattern_node(node)
listeners[:on_find_pattern_node_enter]&.each { |listener| listener.on_find_pattern_node_enter(node) }
super
listeners[:on_find_pattern_node_leave]&.each { |listener| listener.on_find_pattern_node_leave(node) }
end
# Dispatch enter and leave events for FlipFlopNode nodes and continue
# walking the tree.
def visit_flip_flop_node(node)
listeners[:on_flip_flop_node_enter]&.each { |listener| listener.on_flip_flop_node_enter(node) }
super
listeners[:on_flip_flop_node_leave]&.each { |listener| listener.on_flip_flop_node_leave(node) }
end
# Dispatch enter and leave events for FloatNode nodes and continue
# walking the tree.
def visit_float_node(node)
listeners[:on_float_node_enter]&.each { |listener| listener.on_float_node_enter(node) }
super
listeners[:on_float_node_leave]&.each { |listener| listener.on_float_node_leave(node) }
end
# Dispatch enter and leave events for ForNode nodes and continue
# walking the tree.
def visit_for_node(node)
listeners[:on_for_node_enter]&.each { |listener| listener.on_for_node_enter(node) }
super
listeners[:on_for_node_leave]&.each { |listener| listener.on_for_node_leave(node) }
end
# Dispatch enter and leave events for ForwardingArgumentsNode nodes and continue
# walking the tree.
def visit_forwarding_arguments_node(node)
listeners[:on_forwarding_arguments_node_enter]&.each { |listener| listener.on_forwarding_arguments_node_enter(node) }
super
listeners[:on_forwarding_arguments_node_leave]&.each { |listener| listener.on_forwarding_arguments_node_leave(node) }
end
# Dispatch enter and leave events for ForwardingParameterNode nodes and continue
# walking the tree.
def visit_forwarding_parameter_node(node)
listeners[:on_forwarding_parameter_node_enter]&.each { |listener| listener.on_forwarding_parameter_node_enter(node) }
super
listeners[:on_forwarding_parameter_node_leave]&.each { |listener| listener.on_forwarding_parameter_node_leave(node) }
end
# Dispatch enter and leave events for ForwardingSuperNode nodes and continue
# walking the tree.
def visit_forwarding_super_node(node)
listeners[:on_forwarding_super_node_enter]&.each { |listener| listener.on_forwarding_super_node_enter(node) }
super
listeners[:on_forwarding_super_node_leave]&.each { |listener| listener.on_forwarding_super_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableAndWriteNode nodes and continue
# walking the tree.
def visit_global_variable_and_write_node(node)
listeners[:on_global_variable_and_write_node_enter]&.each { |listener| listener.on_global_variable_and_write_node_enter(node) }
super
listeners[:on_global_variable_and_write_node_leave]&.each { |listener| listener.on_global_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableOperatorWriteNode nodes and continue
# walking the tree.
def visit_global_variable_operator_write_node(node)
listeners[:on_global_variable_operator_write_node_enter]&.each { |listener| listener.on_global_variable_operator_write_node_enter(node) }
super
listeners[:on_global_variable_operator_write_node_leave]&.each { |listener| listener.on_global_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableOrWriteNode nodes and continue
# walking the tree.
def visit_global_variable_or_write_node(node)
listeners[:on_global_variable_or_write_node_enter]&.each { |listener| listener.on_global_variable_or_write_node_enter(node) }
super
listeners[:on_global_variable_or_write_node_leave]&.each { |listener| listener.on_global_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableReadNode nodes and continue
# walking the tree.
def visit_global_variable_read_node(node)
listeners[:on_global_variable_read_node_enter]&.each { |listener| listener.on_global_variable_read_node_enter(node) }
super
listeners[:on_global_variable_read_node_leave]&.each { |listener| listener.on_global_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableTargetNode nodes and continue
# walking the tree.
def visit_global_variable_target_node(node)
listeners[:on_global_variable_target_node_enter]&.each { |listener| listener.on_global_variable_target_node_enter(node) }
super
listeners[:on_global_variable_target_node_leave]&.each { |listener| listener.on_global_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableWriteNode nodes and continue
# walking the tree.
def visit_global_variable_write_node(node)
listeners[:on_global_variable_write_node_enter]&.each { |listener| listener.on_global_variable_write_node_enter(node) }
super
listeners[:on_global_variable_write_node_leave]&.each { |listener| listener.on_global_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for HashNode nodes and continue
# walking the tree.
def visit_hash_node(node)
listeners[:on_hash_node_enter]&.each { |listener| listener.on_hash_node_enter(node) }
super
listeners[:on_hash_node_leave]&.each { |listener| listener.on_hash_node_leave(node) }
end
# Dispatch enter and leave events for HashPatternNode nodes and continue
# walking the tree.
def visit_hash_pattern_node(node)
listeners[:on_hash_pattern_node_enter]&.each { |listener| listener.on_hash_pattern_node_enter(node) }
super
listeners[:on_hash_pattern_node_leave]&.each { |listener| listener.on_hash_pattern_node_leave(node) }
end
# Dispatch enter and leave events for IfNode nodes and continue
# walking the tree.
def visit_if_node(node)
listeners[:on_if_node_enter]&.each { |listener| listener.on_if_node_enter(node) }
super
listeners[:on_if_node_leave]&.each { |listener| listener.on_if_node_leave(node) }
end
# Dispatch enter and leave events for ImaginaryNode nodes and continue
# walking the tree.
def visit_imaginary_node(node)
listeners[:on_imaginary_node_enter]&.each { |listener| listener.on_imaginary_node_enter(node) }
super
listeners[:on_imaginary_node_leave]&.each { |listener| listener.on_imaginary_node_leave(node) }
end
# Dispatch enter and leave events for ImplicitNode nodes and continue
# walking the tree.
def visit_implicit_node(node)
listeners[:on_implicit_node_enter]&.each { |listener| listener.on_implicit_node_enter(node) }
super
listeners[:on_implicit_node_leave]&.each { |listener| listener.on_implicit_node_leave(node) }
end
# Dispatch enter and leave events for ImplicitRestNode nodes and continue
# walking the tree.
def visit_implicit_rest_node(node)
listeners[:on_implicit_rest_node_enter]&.each { |listener| listener.on_implicit_rest_node_enter(node) }
super
listeners[:on_implicit_rest_node_leave]&.each { |listener| listener.on_implicit_rest_node_leave(node) }
end
# Dispatch enter and leave events for InNode nodes and continue
# walking the tree.
def visit_in_node(node)
listeners[:on_in_node_enter]&.each { |listener| listener.on_in_node_enter(node) }
super
listeners[:on_in_node_leave]&.each { |listener| listener.on_in_node_leave(node) }
end
# Dispatch enter and leave events for IndexAndWriteNode nodes and continue
# walking the tree.
def visit_index_and_write_node(node)
listeners[:on_index_and_write_node_enter]&.each { |listener| listener.on_index_and_write_node_enter(node) }
super
listeners[:on_index_and_write_node_leave]&.each { |listener| listener.on_index_and_write_node_leave(node) }
end
# Dispatch enter and leave events for IndexOperatorWriteNode nodes and continue
# walking the tree.
def visit_index_operator_write_node(node)
listeners[:on_index_operator_write_node_enter]&.each { |listener| listener.on_index_operator_write_node_enter(node) }
super
listeners[:on_index_operator_write_node_leave]&.each { |listener| listener.on_index_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for IndexOrWriteNode nodes and continue
# walking the tree.
def visit_index_or_write_node(node)
listeners[:on_index_or_write_node_enter]&.each { |listener| listener.on_index_or_write_node_enter(node) }
super
listeners[:on_index_or_write_node_leave]&.each { |listener| listener.on_index_or_write_node_leave(node) }
end
# Dispatch enter and leave events for IndexTargetNode nodes and continue
# walking the tree.
def visit_index_target_node(node)
listeners[:on_index_target_node_enter]&.each { |listener| listener.on_index_target_node_enter(node) }
super
listeners[:on_index_target_node_leave]&.each { |listener| listener.on_index_target_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableAndWriteNode nodes and continue
# walking the tree.
def visit_instance_variable_and_write_node(node)
listeners[:on_instance_variable_and_write_node_enter]&.each { |listener| listener.on_instance_variable_and_write_node_enter(node) }
super
listeners[:on_instance_variable_and_write_node_leave]&.each { |listener| listener.on_instance_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableOperatorWriteNode nodes and continue
# walking the tree.
def visit_instance_variable_operator_write_node(node)
listeners[:on_instance_variable_operator_write_node_enter]&.each { |listener| listener.on_instance_variable_operator_write_node_enter(node) }
super
listeners[:on_instance_variable_operator_write_node_leave]&.each { |listener| listener.on_instance_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableOrWriteNode nodes and continue
# walking the tree.
def visit_instance_variable_or_write_node(node)
listeners[:on_instance_variable_or_write_node_enter]&.each { |listener| listener.on_instance_variable_or_write_node_enter(node) }
super
listeners[:on_instance_variable_or_write_node_leave]&.each { |listener| listener.on_instance_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableReadNode nodes and continue
# walking the tree.
def visit_instance_variable_read_node(node)
listeners[:on_instance_variable_read_node_enter]&.each { |listener| listener.on_instance_variable_read_node_enter(node) }
super
listeners[:on_instance_variable_read_node_leave]&.each { |listener| listener.on_instance_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableTargetNode nodes and continue
# walking the tree.
def visit_instance_variable_target_node(node)
listeners[:on_instance_variable_target_node_enter]&.each { |listener| listener.on_instance_variable_target_node_enter(node) }
super
listeners[:on_instance_variable_target_node_leave]&.each { |listener| listener.on_instance_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableWriteNode nodes and continue
# walking the tree.
def visit_instance_variable_write_node(node)
listeners[:on_instance_variable_write_node_enter]&.each { |listener| listener.on_instance_variable_write_node_enter(node) }
super
listeners[:on_instance_variable_write_node_leave]&.each { |listener| listener.on_instance_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for IntegerNode nodes and continue
# walking the tree.
def visit_integer_node(node)
listeners[:on_integer_node_enter]&.each { |listener| listener.on_integer_node_enter(node) }
super
listeners[:on_integer_node_leave]&.each { |listener| listener.on_integer_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedMatchLastLineNode nodes and continue
# walking the tree.
def visit_interpolated_match_last_line_node(node)
listeners[:on_interpolated_match_last_line_node_enter]&.each { |listener| listener.on_interpolated_match_last_line_node_enter(node) }
super
listeners[:on_interpolated_match_last_line_node_leave]&.each { |listener| listener.on_interpolated_match_last_line_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedRegularExpressionNode nodes and continue
# walking the tree.
def visit_interpolated_regular_expression_node(node)
listeners[:on_interpolated_regular_expression_node_enter]&.each { |listener| listener.on_interpolated_regular_expression_node_enter(node) }
super
listeners[:on_interpolated_regular_expression_node_leave]&.each { |listener| listener.on_interpolated_regular_expression_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedStringNode nodes and continue
# walking the tree.
def visit_interpolated_string_node(node)
listeners[:on_interpolated_string_node_enter]&.each { |listener| listener.on_interpolated_string_node_enter(node) }
super
listeners[:on_interpolated_string_node_leave]&.each { |listener| listener.on_interpolated_string_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedSymbolNode nodes and continue
# walking the tree.
def visit_interpolated_symbol_node(node)
listeners[:on_interpolated_symbol_node_enter]&.each { |listener| listener.on_interpolated_symbol_node_enter(node) }
super
listeners[:on_interpolated_symbol_node_leave]&.each { |listener| listener.on_interpolated_symbol_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedXStringNode nodes and continue
# walking the tree.
def visit_interpolated_x_string_node(node)
listeners[:on_interpolated_x_string_node_enter]&.each { |listener| listener.on_interpolated_x_string_node_enter(node) }
super
listeners[:on_interpolated_x_string_node_leave]&.each { |listener| listener.on_interpolated_x_string_node_leave(node) }
end
# Dispatch enter and leave events for KeywordHashNode nodes and continue
# walking the tree.
def visit_keyword_hash_node(node)
listeners[:on_keyword_hash_node_enter]&.each { |listener| listener.on_keyword_hash_node_enter(node) }
super
listeners[:on_keyword_hash_node_leave]&.each { |listener| listener.on_keyword_hash_node_leave(node) }
end
# Dispatch enter and leave events for KeywordRestParameterNode nodes and continue
# walking the tree.
def visit_keyword_rest_parameter_node(node)
listeners[:on_keyword_rest_parameter_node_enter]&.each { |listener| listener.on_keyword_rest_parameter_node_enter(node) }
super
listeners[:on_keyword_rest_parameter_node_leave]&.each { |listener| listener.on_keyword_rest_parameter_node_leave(node) }
end
# Dispatch enter and leave events for LambdaNode nodes and continue
# walking the tree.
def visit_lambda_node(node)
listeners[:on_lambda_node_enter]&.each { |listener| listener.on_lambda_node_enter(node) }
super
listeners[:on_lambda_node_leave]&.each { |listener| listener.on_lambda_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableAndWriteNode nodes and continue
# walking the tree.
def visit_local_variable_and_write_node(node)
listeners[:on_local_variable_and_write_node_enter]&.each { |listener| listener.on_local_variable_and_write_node_enter(node) }
super
listeners[:on_local_variable_and_write_node_leave]&.each { |listener| listener.on_local_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableOperatorWriteNode nodes and continue
# walking the tree.
def visit_local_variable_operator_write_node(node)
listeners[:on_local_variable_operator_write_node_enter]&.each { |listener| listener.on_local_variable_operator_write_node_enter(node) }
super
listeners[:on_local_variable_operator_write_node_leave]&.each { |listener| listener.on_local_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableOrWriteNode nodes and continue
# walking the tree.
def visit_local_variable_or_write_node(node)
listeners[:on_local_variable_or_write_node_enter]&.each { |listener| listener.on_local_variable_or_write_node_enter(node) }
super
listeners[:on_local_variable_or_write_node_leave]&.each { |listener| listener.on_local_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableReadNode nodes and continue
# walking the tree.
def visit_local_variable_read_node(node)
listeners[:on_local_variable_read_node_enter]&.each { |listener| listener.on_local_variable_read_node_enter(node) }
super
listeners[:on_local_variable_read_node_leave]&.each { |listener| listener.on_local_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableTargetNode nodes and continue
# walking the tree.
def visit_local_variable_target_node(node)
listeners[:on_local_variable_target_node_enter]&.each { |listener| listener.on_local_variable_target_node_enter(node) }
super
listeners[:on_local_variable_target_node_leave]&.each { |listener| listener.on_local_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableWriteNode nodes and continue
# walking the tree.
def visit_local_variable_write_node(node)
listeners[:on_local_variable_write_node_enter]&.each { |listener| listener.on_local_variable_write_node_enter(node) }
super
listeners[:on_local_variable_write_node_leave]&.each { |listener| listener.on_local_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for MatchLastLineNode nodes and continue
# walking the tree.
def visit_match_last_line_node(node)
listeners[:on_match_last_line_node_enter]&.each { |listener| listener.on_match_last_line_node_enter(node) }
super
listeners[:on_match_last_line_node_leave]&.each { |listener| listener.on_match_last_line_node_leave(node) }
end
# Dispatch enter and leave events for MatchPredicateNode nodes and continue
# walking the tree.
def visit_match_predicate_node(node)
listeners[:on_match_predicate_node_enter]&.each { |listener| listener.on_match_predicate_node_enter(node) }
super
listeners[:on_match_predicate_node_leave]&.each { |listener| listener.on_match_predicate_node_leave(node) }
end
# Dispatch enter and leave events for MatchRequiredNode nodes and continue
# walking the tree.
def visit_match_required_node(node)
listeners[:on_match_required_node_enter]&.each { |listener| listener.on_match_required_node_enter(node) }
super
listeners[:on_match_required_node_leave]&.each { |listener| listener.on_match_required_node_leave(node) }
end
# Dispatch enter and leave events for MatchWriteNode nodes and continue
# walking the tree.
def visit_match_write_node(node)
listeners[:on_match_write_node_enter]&.each { |listener| listener.on_match_write_node_enter(node) }
super
listeners[:on_match_write_node_leave]&.each { |listener| listener.on_match_write_node_leave(node) }
end
# Dispatch enter and leave events for MissingNode nodes and continue
# walking the tree.
def visit_missing_node(node)
listeners[:on_missing_node_enter]&.each { |listener| listener.on_missing_node_enter(node) }
super
listeners[:on_missing_node_leave]&.each { |listener| listener.on_missing_node_leave(node) }
end
# Dispatch enter and leave events for ModuleNode nodes and continue
# walking the tree.
def visit_module_node(node)
listeners[:on_module_node_enter]&.each { |listener| listener.on_module_node_enter(node) }
super
listeners[:on_module_node_leave]&.each { |listener| listener.on_module_node_leave(node) }
end
# Dispatch enter and leave events for MultiTargetNode nodes and continue
# walking the tree.
def visit_multi_target_node(node)
listeners[:on_multi_target_node_enter]&.each { |listener| listener.on_multi_target_node_enter(node) }
super
listeners[:on_multi_target_node_leave]&.each { |listener| listener.on_multi_target_node_leave(node) }
end
# Dispatch enter and leave events for MultiWriteNode nodes and continue
# walking the tree.
def visit_multi_write_node(node)
listeners[:on_multi_write_node_enter]&.each { |listener| listener.on_multi_write_node_enter(node) }
super
listeners[:on_multi_write_node_leave]&.each { |listener| listener.on_multi_write_node_leave(node) }
end
# Dispatch enter and leave events for NextNode nodes and continue
# walking the tree.
def visit_next_node(node)
listeners[:on_next_node_enter]&.each { |listener| listener.on_next_node_enter(node) }
super
listeners[:on_next_node_leave]&.each { |listener| listener.on_next_node_leave(node) }
end
# Dispatch enter and leave events for NilNode nodes and continue
# walking the tree.
def visit_nil_node(node)
listeners[:on_nil_node_enter]&.each { |listener| listener.on_nil_node_enter(node) }
super
listeners[:on_nil_node_leave]&.each { |listener| listener.on_nil_node_leave(node) }
end
# Dispatch enter and leave events for NoKeywordsParameterNode nodes and continue
# walking the tree.
def visit_no_keywords_parameter_node(node)
listeners[:on_no_keywords_parameter_node_enter]&.each { |listener| listener.on_no_keywords_parameter_node_enter(node) }
super
listeners[:on_no_keywords_parameter_node_leave]&.each { |listener| listener.on_no_keywords_parameter_node_leave(node) }
end
# Dispatch enter and leave events for NumberedParametersNode nodes and continue
# walking the tree.
def visit_numbered_parameters_node(node)
listeners[:on_numbered_parameters_node_enter]&.each { |listener| listener.on_numbered_parameters_node_enter(node) }
super
listeners[:on_numbered_parameters_node_leave]&.each { |listener| listener.on_numbered_parameters_node_leave(node) }
end
# Dispatch enter and leave events for NumberedReferenceReadNode nodes and continue
# walking the tree.
def visit_numbered_reference_read_node(node)
listeners[:on_numbered_reference_read_node_enter]&.each { |listener| listener.on_numbered_reference_read_node_enter(node) }
super
listeners[:on_numbered_reference_read_node_leave]&.each { |listener| listener.on_numbered_reference_read_node_leave(node) }
end
# Dispatch enter and leave events for OptionalKeywordParameterNode nodes and continue
# walking the tree.
def visit_optional_keyword_parameter_node(node)
listeners[:on_optional_keyword_parameter_node_enter]&.each { |listener| listener.on_optional_keyword_parameter_node_enter(node) }
super
listeners[:on_optional_keyword_parameter_node_leave]&.each { |listener| listener.on_optional_keyword_parameter_node_leave(node) }
end
# Dispatch enter and leave events for OptionalParameterNode nodes and continue
# walking the tree.
def visit_optional_parameter_node(node)
listeners[:on_optional_parameter_node_enter]&.each { |listener| listener.on_optional_parameter_node_enter(node) }
super
listeners[:on_optional_parameter_node_leave]&.each { |listener| listener.on_optional_parameter_node_leave(node) }
end
# Dispatch enter and leave events for OrNode nodes and continue
# walking the tree.
def visit_or_node(node)
listeners[:on_or_node_enter]&.each { |listener| listener.on_or_node_enter(node) }
super
listeners[:on_or_node_leave]&.each { |listener| listener.on_or_node_leave(node) }
end
# Dispatch enter and leave events for ParametersNode nodes and continue
# walking the tree.
def visit_parameters_node(node)
listeners[:on_parameters_node_enter]&.each { |listener| listener.on_parameters_node_enter(node) }
super
listeners[:on_parameters_node_leave]&.each { |listener| listener.on_parameters_node_leave(node) }
end
# Dispatch enter and leave events for ParenthesesNode nodes and continue
# walking the tree.
def visit_parentheses_node(node)
listeners[:on_parentheses_node_enter]&.each { |listener| listener.on_parentheses_node_enter(node) }
super
listeners[:on_parentheses_node_leave]&.each { |listener| listener.on_parentheses_node_leave(node) }
end
# Dispatch enter and leave events for PinnedExpressionNode nodes and continue
# walking the tree.
def visit_pinned_expression_node(node)
listeners[:on_pinned_expression_node_enter]&.each { |listener| listener.on_pinned_expression_node_enter(node) }
super
listeners[:on_pinned_expression_node_leave]&.each { |listener| listener.on_pinned_expression_node_leave(node) }
end
# Dispatch enter and leave events for PinnedVariableNode nodes and continue
# walking the tree.
def visit_pinned_variable_node(node)
listeners[:on_pinned_variable_node_enter]&.each { |listener| listener.on_pinned_variable_node_enter(node) }
super
listeners[:on_pinned_variable_node_leave]&.each { |listener| listener.on_pinned_variable_node_leave(node) }
end
# Dispatch enter and leave events for PostExecutionNode nodes and continue
# walking the tree.
def visit_post_execution_node(node)
listeners[:on_post_execution_node_enter]&.each { |listener| listener.on_post_execution_node_enter(node) }
super
listeners[:on_post_execution_node_leave]&.each { |listener| listener.on_post_execution_node_leave(node) }
end
# Dispatch enter and leave events for PreExecutionNode nodes and continue
# walking the tree.
def visit_pre_execution_node(node)
listeners[:on_pre_execution_node_enter]&.each { |listener| listener.on_pre_execution_node_enter(node) }
super
listeners[:on_pre_execution_node_leave]&.each { |listener| listener.on_pre_execution_node_leave(node) }
end
# Dispatch enter and leave events for ProgramNode nodes and continue
# walking the tree.
def visit_program_node(node)
listeners[:on_program_node_enter]&.each { |listener| listener.on_program_node_enter(node) }
super
listeners[:on_program_node_leave]&.each { |listener| listener.on_program_node_leave(node) }
end
# Dispatch enter and leave events for RangeNode nodes and continue
# walking the tree.
def visit_range_node(node)
listeners[:on_range_node_enter]&.each { |listener| listener.on_range_node_enter(node) }
super
listeners[:on_range_node_leave]&.each { |listener| listener.on_range_node_leave(node) }
end
# Dispatch enter and leave events for RationalNode nodes and continue
# walking the tree.
def visit_rational_node(node)
listeners[:on_rational_node_enter]&.each { |listener| listener.on_rational_node_enter(node) }
super
listeners[:on_rational_node_leave]&.each { |listener| listener.on_rational_node_leave(node) }
end
# Dispatch enter and leave events for RedoNode nodes and continue
# walking the tree.
def visit_redo_node(node)
listeners[:on_redo_node_enter]&.each { |listener| listener.on_redo_node_enter(node) }
super
listeners[:on_redo_node_leave]&.each { |listener| listener.on_redo_node_leave(node) }
end
# Dispatch enter and leave events for RegularExpressionNode nodes and continue
# walking the tree.
def visit_regular_expression_node(node)
listeners[:on_regular_expression_node_enter]&.each { |listener| listener.on_regular_expression_node_enter(node) }
super
listeners[:on_regular_expression_node_leave]&.each { |listener| listener.on_regular_expression_node_leave(node) }
end
# Dispatch enter and leave events for RequiredKeywordParameterNode nodes and continue
# walking the tree.
def visit_required_keyword_parameter_node(node)
listeners[:on_required_keyword_parameter_node_enter]&.each { |listener| listener.on_required_keyword_parameter_node_enter(node) }
super
listeners[:on_required_keyword_parameter_node_leave]&.each { |listener| listener.on_required_keyword_parameter_node_leave(node) }
end
# Dispatch enter and leave events for RequiredParameterNode nodes and continue
# walking the tree.
def visit_required_parameter_node(node)
listeners[:on_required_parameter_node_enter]&.each { |listener| listener.on_required_parameter_node_enter(node) }
super
listeners[:on_required_parameter_node_leave]&.each { |listener| listener.on_required_parameter_node_leave(node) }
end
# Dispatch enter and leave events for RescueModifierNode nodes and continue
# walking the tree.
def visit_rescue_modifier_node(node)
listeners[:on_rescue_modifier_node_enter]&.each { |listener| listener.on_rescue_modifier_node_enter(node) }
super
listeners[:on_rescue_modifier_node_leave]&.each { |listener| listener.on_rescue_modifier_node_leave(node) }
end
# Dispatch enter and leave events for RescueNode nodes and continue
# walking the tree.
def visit_rescue_node(node)
listeners[:on_rescue_node_enter]&.each { |listener| listener.on_rescue_node_enter(node) }
super
listeners[:on_rescue_node_leave]&.each { |listener| listener.on_rescue_node_leave(node) }
end
# Dispatch enter and leave events for RestParameterNode nodes and continue
# walking the tree.
def visit_rest_parameter_node(node)
listeners[:on_rest_parameter_node_enter]&.each { |listener| listener.on_rest_parameter_node_enter(node) }
super
listeners[:on_rest_parameter_node_leave]&.each { |listener| listener.on_rest_parameter_node_leave(node) }
end
# Dispatch enter and leave events for RetryNode nodes and continue
# walking the tree.
def visit_retry_node(node)
listeners[:on_retry_node_enter]&.each { |listener| listener.on_retry_node_enter(node) }
super
listeners[:on_retry_node_leave]&.each { |listener| listener.on_retry_node_leave(node) }
end
# Dispatch enter and leave events for ReturnNode nodes and continue
# walking the tree.
def visit_return_node(node)
listeners[:on_return_node_enter]&.each { |listener| listener.on_return_node_enter(node) }
super
listeners[:on_return_node_leave]&.each { |listener| listener.on_return_node_leave(node) }
end
# Dispatch enter and leave events for SelfNode nodes and continue
# walking the tree.
def visit_self_node(node)
listeners[:on_self_node_enter]&.each { |listener| listener.on_self_node_enter(node) }
super
listeners[:on_self_node_leave]&.each { |listener| listener.on_self_node_leave(node) }
end
# Dispatch enter and leave events for SingletonClassNode nodes and continue
# walking the tree.
def visit_singleton_class_node(node)
listeners[:on_singleton_class_node_enter]&.each { |listener| listener.on_singleton_class_node_enter(node) }
super
listeners[:on_singleton_class_node_leave]&.each { |listener| listener.on_singleton_class_node_leave(node) }
end
# Dispatch enter and leave events for SourceEncodingNode nodes and continue
# walking the tree.
def visit_source_encoding_node(node)
listeners[:on_source_encoding_node_enter]&.each { |listener| listener.on_source_encoding_node_enter(node) }
super
listeners[:on_source_encoding_node_leave]&.each { |listener| listener.on_source_encoding_node_leave(node) }
end
# Dispatch enter and leave events for SourceFileNode nodes and continue
# walking the tree.
def visit_source_file_node(node)
listeners[:on_source_file_node_enter]&.each { |listener| listener.on_source_file_node_enter(node) }
super
listeners[:on_source_file_node_leave]&.each { |listener| listener.on_source_file_node_leave(node) }
end
# Dispatch enter and leave events for SourceLineNode nodes and continue
# walking the tree.
def visit_source_line_node(node)
listeners[:on_source_line_node_enter]&.each { |listener| listener.on_source_line_node_enter(node) }
super
listeners[:on_source_line_node_leave]&.each { |listener| listener.on_source_line_node_leave(node) }
end
# Dispatch enter and leave events for SplatNode nodes and continue
# walking the tree.
def visit_splat_node(node)
listeners[:on_splat_node_enter]&.each { |listener| listener.on_splat_node_enter(node) }
super
listeners[:on_splat_node_leave]&.each { |listener| listener.on_splat_node_leave(node) }
end
# Dispatch enter and leave events for StatementsNode nodes and continue
# walking the tree.
def visit_statements_node(node)
listeners[:on_statements_node_enter]&.each { |listener| listener.on_statements_node_enter(node) }
super
listeners[:on_statements_node_leave]&.each { |listener| listener.on_statements_node_leave(node) }
end
# Dispatch enter and leave events for StringNode nodes and continue
# walking the tree.
def visit_string_node(node)
listeners[:on_string_node_enter]&.each { |listener| listener.on_string_node_enter(node) }
super
listeners[:on_string_node_leave]&.each { |listener| listener.on_string_node_leave(node) }
end
# Dispatch enter and leave events for SuperNode nodes and continue
# walking the tree.
def visit_super_node(node)
listeners[:on_super_node_enter]&.each { |listener| listener.on_super_node_enter(node) }
super
listeners[:on_super_node_leave]&.each { |listener| listener.on_super_node_leave(node) }
end
# Dispatch enter and leave events for SymbolNode nodes and continue
# walking the tree.
def visit_symbol_node(node)
listeners[:on_symbol_node_enter]&.each { |listener| listener.on_symbol_node_enter(node) }
super
listeners[:on_symbol_node_leave]&.each { |listener| listener.on_symbol_node_leave(node) }
end
# Dispatch enter and leave events for TrueNode nodes and continue
# walking the tree.
def visit_true_node(node)
listeners[:on_true_node_enter]&.each { |listener| listener.on_true_node_enter(node) }
super
listeners[:on_true_node_leave]&.each { |listener| listener.on_true_node_leave(node) }
end
# Dispatch enter and leave events for UndefNode nodes and continue
# walking the tree.
def visit_undef_node(node)
listeners[:on_undef_node_enter]&.each { |listener| listener.on_undef_node_enter(node) }
super
listeners[:on_undef_node_leave]&.each { |listener| listener.on_undef_node_leave(node) }
end
# Dispatch enter and leave events for UnlessNode nodes and continue
# walking the tree.
def visit_unless_node(node)
listeners[:on_unless_node_enter]&.each { |listener| listener.on_unless_node_enter(node) }
super
listeners[:on_unless_node_leave]&.each { |listener| listener.on_unless_node_leave(node) }
end
# Dispatch enter and leave events for UntilNode nodes and continue
# walking the tree.
def visit_until_node(node)
listeners[:on_until_node_enter]&.each { |listener| listener.on_until_node_enter(node) }
super
listeners[:on_until_node_leave]&.each { |listener| listener.on_until_node_leave(node) }
end
# Dispatch enter and leave events for WhenNode nodes and continue
# walking the tree.
def visit_when_node(node)
listeners[:on_when_node_enter]&.each { |listener| listener.on_when_node_enter(node) }
super
listeners[:on_when_node_leave]&.each { |listener| listener.on_when_node_leave(node) }
end
# Dispatch enter and leave events for WhileNode nodes and continue
# walking the tree.
def visit_while_node(node)
listeners[:on_while_node_enter]&.each { |listener| listener.on_while_node_enter(node) }
super
listeners[:on_while_node_leave]&.each { |listener| listener.on_while_node_leave(node) }
end
# Dispatch enter and leave events for XStringNode nodes and continue
# walking the tree.
def visit_x_string_node(node)
listeners[:on_x_string_node_enter]&.each { |listener| listener.on_x_string_node_enter(node) }
super
listeners[:on_x_string_node_leave]&.each { |listener| listener.on_x_string_node_leave(node) }
end
# Dispatch enter and leave events for YieldNode nodes and continue
# walking the tree.
def visit_yield_node(node)
listeners[:on_yield_node_enter]&.each { |listener| listener.on_yield_node_enter(node) }
super
listeners[:on_yield_node_leave]&.each { |listener| listener.on_yield_node_leave(node) }
end
class DispatchOnce < Visitor # :nodoc:
attr_reader :listeners
def initialize(listeners)
@listeners = listeners
end
# Dispatch enter and leave events for AliasGlobalVariableNode nodes.
def visit_alias_global_variable_node(node)
listeners[:on_alias_global_variable_node_enter]&.each { |listener| listener.on_alias_global_variable_node_enter(node) }
listeners[:on_alias_global_variable_node_leave]&.each { |listener| listener.on_alias_global_variable_node_leave(node) }
end
# Dispatch enter and leave events for AliasMethodNode nodes.
def visit_alias_method_node(node)
listeners[:on_alias_method_node_enter]&.each { |listener| listener.on_alias_method_node_enter(node) }
listeners[:on_alias_method_node_leave]&.each { |listener| listener.on_alias_method_node_leave(node) }
end
# Dispatch enter and leave events for AlternationPatternNode nodes.
def visit_alternation_pattern_node(node)
listeners[:on_alternation_pattern_node_enter]&.each { |listener| listener.on_alternation_pattern_node_enter(node) }
listeners[:on_alternation_pattern_node_leave]&.each { |listener| listener.on_alternation_pattern_node_leave(node) }
end
# Dispatch enter and leave events for AndNode nodes.
def visit_and_node(node)
listeners[:on_and_node_enter]&.each { |listener| listener.on_and_node_enter(node) }
listeners[:on_and_node_leave]&.each { |listener| listener.on_and_node_leave(node) }
end
# Dispatch enter and leave events for ArgumentsNode nodes.
def visit_arguments_node(node)
listeners[:on_arguments_node_enter]&.each { |listener| listener.on_arguments_node_enter(node) }
listeners[:on_arguments_node_leave]&.each { |listener| listener.on_arguments_node_leave(node) }
end
# Dispatch enter and leave events for ArrayNode nodes.
def visit_array_node(node)
listeners[:on_array_node_enter]&.each { |listener| listener.on_array_node_enter(node) }
listeners[:on_array_node_leave]&.each { |listener| listener.on_array_node_leave(node) }
end
# Dispatch enter and leave events for ArrayPatternNode nodes.
def visit_array_pattern_node(node)
listeners[:on_array_pattern_node_enter]&.each { |listener| listener.on_array_pattern_node_enter(node) }
listeners[:on_array_pattern_node_leave]&.each { |listener| listener.on_array_pattern_node_leave(node) }
end
# Dispatch enter and leave events for AssocNode nodes.
def visit_assoc_node(node)
listeners[:on_assoc_node_enter]&.each { |listener| listener.on_assoc_node_enter(node) }
listeners[:on_assoc_node_leave]&.each { |listener| listener.on_assoc_node_leave(node) }
end
# Dispatch enter and leave events for AssocSplatNode nodes.
def visit_assoc_splat_node(node)
listeners[:on_assoc_splat_node_enter]&.each { |listener| listener.on_assoc_splat_node_enter(node) }
listeners[:on_assoc_splat_node_leave]&.each { |listener| listener.on_assoc_splat_node_leave(node) }
end
# Dispatch enter and leave events for BackReferenceReadNode nodes.
def visit_back_reference_read_node(node)
listeners[:on_back_reference_read_node_enter]&.each { |listener| listener.on_back_reference_read_node_enter(node) }
listeners[:on_back_reference_read_node_leave]&.each { |listener| listener.on_back_reference_read_node_leave(node) }
end
# Dispatch enter and leave events for BeginNode nodes.
def visit_begin_node(node)
listeners[:on_begin_node_enter]&.each { |listener| listener.on_begin_node_enter(node) }
listeners[:on_begin_node_leave]&.each { |listener| listener.on_begin_node_leave(node) }
end
# Dispatch enter and leave events for BlockArgumentNode nodes.
def visit_block_argument_node(node)
listeners[:on_block_argument_node_enter]&.each { |listener| listener.on_block_argument_node_enter(node) }
listeners[:on_block_argument_node_leave]&.each { |listener| listener.on_block_argument_node_leave(node) }
end
# Dispatch enter and leave events for BlockLocalVariableNode nodes.
def visit_block_local_variable_node(node)
listeners[:on_block_local_variable_node_enter]&.each { |listener| listener.on_block_local_variable_node_enter(node) }
listeners[:on_block_local_variable_node_leave]&.each { |listener| listener.on_block_local_variable_node_leave(node) }
end
# Dispatch enter and leave events for BlockNode nodes.
def visit_block_node(node)
listeners[:on_block_node_enter]&.each { |listener| listener.on_block_node_enter(node) }
listeners[:on_block_node_leave]&.each { |listener| listener.on_block_node_leave(node) }
end
# Dispatch enter and leave events for BlockParameterNode nodes.
def visit_block_parameter_node(node)
listeners[:on_block_parameter_node_enter]&.each { |listener| listener.on_block_parameter_node_enter(node) }
listeners[:on_block_parameter_node_leave]&.each { |listener| listener.on_block_parameter_node_leave(node) }
end
# Dispatch enter and leave events for BlockParametersNode nodes.
def visit_block_parameters_node(node)
listeners[:on_block_parameters_node_enter]&.each { |listener| listener.on_block_parameters_node_enter(node) }
listeners[:on_block_parameters_node_leave]&.each { |listener| listener.on_block_parameters_node_leave(node) }
end
# Dispatch enter and leave events for BreakNode nodes.
def visit_break_node(node)
listeners[:on_break_node_enter]&.each { |listener| listener.on_break_node_enter(node) }
listeners[:on_break_node_leave]&.each { |listener| listener.on_break_node_leave(node) }
end
# Dispatch enter and leave events for CallAndWriteNode nodes.
def visit_call_and_write_node(node)
listeners[:on_call_and_write_node_enter]&.each { |listener| listener.on_call_and_write_node_enter(node) }
listeners[:on_call_and_write_node_leave]&.each { |listener| listener.on_call_and_write_node_leave(node) }
end
# Dispatch enter and leave events for CallNode nodes.
def visit_call_node(node)
listeners[:on_call_node_enter]&.each { |listener| listener.on_call_node_enter(node) }
listeners[:on_call_node_leave]&.each { |listener| listener.on_call_node_leave(node) }
end
# Dispatch enter and leave events for CallOperatorWriteNode nodes.
def visit_call_operator_write_node(node)
listeners[:on_call_operator_write_node_enter]&.each { |listener| listener.on_call_operator_write_node_enter(node) }
listeners[:on_call_operator_write_node_leave]&.each { |listener| listener.on_call_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for CallOrWriteNode nodes.
def visit_call_or_write_node(node)
listeners[:on_call_or_write_node_enter]&.each { |listener| listener.on_call_or_write_node_enter(node) }
listeners[:on_call_or_write_node_leave]&.each { |listener| listener.on_call_or_write_node_leave(node) }
end
# Dispatch enter and leave events for CallTargetNode nodes.
def visit_call_target_node(node)
listeners[:on_call_target_node_enter]&.each { |listener| listener.on_call_target_node_enter(node) }
listeners[:on_call_target_node_leave]&.each { |listener| listener.on_call_target_node_leave(node) }
end
# Dispatch enter and leave events for CapturePatternNode nodes.
def visit_capture_pattern_node(node)
listeners[:on_capture_pattern_node_enter]&.each { |listener| listener.on_capture_pattern_node_enter(node) }
listeners[:on_capture_pattern_node_leave]&.each { |listener| listener.on_capture_pattern_node_leave(node) }
end
# Dispatch enter and leave events for CaseMatchNode nodes.
def visit_case_match_node(node)
listeners[:on_case_match_node_enter]&.each { |listener| listener.on_case_match_node_enter(node) }
listeners[:on_case_match_node_leave]&.each { |listener| listener.on_case_match_node_leave(node) }
end
# Dispatch enter and leave events for CaseNode nodes.
def visit_case_node(node)
listeners[:on_case_node_enter]&.each { |listener| listener.on_case_node_enter(node) }
listeners[:on_case_node_leave]&.each { |listener| listener.on_case_node_leave(node) }
end
# Dispatch enter and leave events for ClassNode nodes.
def visit_class_node(node)
listeners[:on_class_node_enter]&.each { |listener| listener.on_class_node_enter(node) }
listeners[:on_class_node_leave]&.each { |listener| listener.on_class_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableAndWriteNode nodes.
def visit_class_variable_and_write_node(node)
listeners[:on_class_variable_and_write_node_enter]&.each { |listener| listener.on_class_variable_and_write_node_enter(node) }
listeners[:on_class_variable_and_write_node_leave]&.each { |listener| listener.on_class_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableOperatorWriteNode nodes.
def visit_class_variable_operator_write_node(node)
listeners[:on_class_variable_operator_write_node_enter]&.each { |listener| listener.on_class_variable_operator_write_node_enter(node) }
listeners[:on_class_variable_operator_write_node_leave]&.each { |listener| listener.on_class_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableOrWriteNode nodes.
def visit_class_variable_or_write_node(node)
listeners[:on_class_variable_or_write_node_enter]&.each { |listener| listener.on_class_variable_or_write_node_enter(node) }
listeners[:on_class_variable_or_write_node_leave]&.each { |listener| listener.on_class_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableReadNode nodes.
def visit_class_variable_read_node(node)
listeners[:on_class_variable_read_node_enter]&.each { |listener| listener.on_class_variable_read_node_enter(node) }
listeners[:on_class_variable_read_node_leave]&.each { |listener| listener.on_class_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableTargetNode nodes.
def visit_class_variable_target_node(node)
listeners[:on_class_variable_target_node_enter]&.each { |listener| listener.on_class_variable_target_node_enter(node) }
listeners[:on_class_variable_target_node_leave]&.each { |listener| listener.on_class_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for ClassVariableWriteNode nodes.
def visit_class_variable_write_node(node)
listeners[:on_class_variable_write_node_enter]&.each { |listener| listener.on_class_variable_write_node_enter(node) }
listeners[:on_class_variable_write_node_leave]&.each { |listener| listener.on_class_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantAndWriteNode nodes.
def visit_constant_and_write_node(node)
listeners[:on_constant_and_write_node_enter]&.each { |listener| listener.on_constant_and_write_node_enter(node) }
listeners[:on_constant_and_write_node_leave]&.each { |listener| listener.on_constant_and_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantOperatorWriteNode nodes.
def visit_constant_operator_write_node(node)
listeners[:on_constant_operator_write_node_enter]&.each { |listener| listener.on_constant_operator_write_node_enter(node) }
listeners[:on_constant_operator_write_node_leave]&.each { |listener| listener.on_constant_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantOrWriteNode nodes.
def visit_constant_or_write_node(node)
listeners[:on_constant_or_write_node_enter]&.each { |listener| listener.on_constant_or_write_node_enter(node) }
listeners[:on_constant_or_write_node_leave]&.each { |listener| listener.on_constant_or_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathAndWriteNode nodes.
def visit_constant_path_and_write_node(node)
listeners[:on_constant_path_and_write_node_enter]&.each { |listener| listener.on_constant_path_and_write_node_enter(node) }
listeners[:on_constant_path_and_write_node_leave]&.each { |listener| listener.on_constant_path_and_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathNode nodes.
def visit_constant_path_node(node)
listeners[:on_constant_path_node_enter]&.each { |listener| listener.on_constant_path_node_enter(node) }
listeners[:on_constant_path_node_leave]&.each { |listener| listener.on_constant_path_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathOperatorWriteNode nodes.
def visit_constant_path_operator_write_node(node)
listeners[:on_constant_path_operator_write_node_enter]&.each { |listener| listener.on_constant_path_operator_write_node_enter(node) }
listeners[:on_constant_path_operator_write_node_leave]&.each { |listener| listener.on_constant_path_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathOrWriteNode nodes.
def visit_constant_path_or_write_node(node)
listeners[:on_constant_path_or_write_node_enter]&.each { |listener| listener.on_constant_path_or_write_node_enter(node) }
listeners[:on_constant_path_or_write_node_leave]&.each { |listener| listener.on_constant_path_or_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathTargetNode nodes.
def visit_constant_path_target_node(node)
listeners[:on_constant_path_target_node_enter]&.each { |listener| listener.on_constant_path_target_node_enter(node) }
listeners[:on_constant_path_target_node_leave]&.each { |listener| listener.on_constant_path_target_node_leave(node) }
end
# Dispatch enter and leave events for ConstantPathWriteNode nodes.
def visit_constant_path_write_node(node)
listeners[:on_constant_path_write_node_enter]&.each { |listener| listener.on_constant_path_write_node_enter(node) }
listeners[:on_constant_path_write_node_leave]&.each { |listener| listener.on_constant_path_write_node_leave(node) }
end
# Dispatch enter and leave events for ConstantReadNode nodes.
def visit_constant_read_node(node)
listeners[:on_constant_read_node_enter]&.each { |listener| listener.on_constant_read_node_enter(node) }
listeners[:on_constant_read_node_leave]&.each { |listener| listener.on_constant_read_node_leave(node) }
end
# Dispatch enter and leave events for ConstantTargetNode nodes.
def visit_constant_target_node(node)
listeners[:on_constant_target_node_enter]&.each { |listener| listener.on_constant_target_node_enter(node) }
listeners[:on_constant_target_node_leave]&.each { |listener| listener.on_constant_target_node_leave(node) }
end
# Dispatch enter and leave events for ConstantWriteNode nodes.
def visit_constant_write_node(node)
listeners[:on_constant_write_node_enter]&.each { |listener| listener.on_constant_write_node_enter(node) }
listeners[:on_constant_write_node_leave]&.each { |listener| listener.on_constant_write_node_leave(node) }
end
# Dispatch enter and leave events for DefNode nodes.
def visit_def_node(node)
listeners[:on_def_node_enter]&.each { |listener| listener.on_def_node_enter(node) }
listeners[:on_def_node_leave]&.each { |listener| listener.on_def_node_leave(node) }
end
# Dispatch enter and leave events for DefinedNode nodes.
def visit_defined_node(node)
listeners[:on_defined_node_enter]&.each { |listener| listener.on_defined_node_enter(node) }
listeners[:on_defined_node_leave]&.each { |listener| listener.on_defined_node_leave(node) }
end
# Dispatch enter and leave events for ElseNode nodes.
def visit_else_node(node)
listeners[:on_else_node_enter]&.each { |listener| listener.on_else_node_enter(node) }
listeners[:on_else_node_leave]&.each { |listener| listener.on_else_node_leave(node) }
end
# Dispatch enter and leave events for EmbeddedStatementsNode nodes.
def visit_embedded_statements_node(node)
listeners[:on_embedded_statements_node_enter]&.each { |listener| listener.on_embedded_statements_node_enter(node) }
listeners[:on_embedded_statements_node_leave]&.each { |listener| listener.on_embedded_statements_node_leave(node) }
end
# Dispatch enter and leave events for EmbeddedVariableNode nodes.
def visit_embedded_variable_node(node)
listeners[:on_embedded_variable_node_enter]&.each { |listener| listener.on_embedded_variable_node_enter(node) }
listeners[:on_embedded_variable_node_leave]&.each { |listener| listener.on_embedded_variable_node_leave(node) }
end
# Dispatch enter and leave events for EnsureNode nodes.
def visit_ensure_node(node)
listeners[:on_ensure_node_enter]&.each { |listener| listener.on_ensure_node_enter(node) }
listeners[:on_ensure_node_leave]&.each { |listener| listener.on_ensure_node_leave(node) }
end
# Dispatch enter and leave events for FalseNode nodes.
def visit_false_node(node)
listeners[:on_false_node_enter]&.each { |listener| listener.on_false_node_enter(node) }
listeners[:on_false_node_leave]&.each { |listener| listener.on_false_node_leave(node) }
end
# Dispatch enter and leave events for FindPatternNode nodes.
def visit_find_pattern_node(node)
listeners[:on_find_pattern_node_enter]&.each { |listener| listener.on_find_pattern_node_enter(node) }
listeners[:on_find_pattern_node_leave]&.each { |listener| listener.on_find_pattern_node_leave(node) }
end
# Dispatch enter and leave events for FlipFlopNode nodes.
def visit_flip_flop_node(node)
listeners[:on_flip_flop_node_enter]&.each { |listener| listener.on_flip_flop_node_enter(node) }
listeners[:on_flip_flop_node_leave]&.each { |listener| listener.on_flip_flop_node_leave(node) }
end
# Dispatch enter and leave events for FloatNode nodes.
def visit_float_node(node)
listeners[:on_float_node_enter]&.each { |listener| listener.on_float_node_enter(node) }
listeners[:on_float_node_leave]&.each { |listener| listener.on_float_node_leave(node) }
end
# Dispatch enter and leave events for ForNode nodes.
def visit_for_node(node)
listeners[:on_for_node_enter]&.each { |listener| listener.on_for_node_enter(node) }
listeners[:on_for_node_leave]&.each { |listener| listener.on_for_node_leave(node) }
end
# Dispatch enter and leave events for ForwardingArgumentsNode nodes.
def visit_forwarding_arguments_node(node)
listeners[:on_forwarding_arguments_node_enter]&.each { |listener| listener.on_forwarding_arguments_node_enter(node) }
listeners[:on_forwarding_arguments_node_leave]&.each { |listener| listener.on_forwarding_arguments_node_leave(node) }
end
# Dispatch enter and leave events for ForwardingParameterNode nodes.
def visit_forwarding_parameter_node(node)
listeners[:on_forwarding_parameter_node_enter]&.each { |listener| listener.on_forwarding_parameter_node_enter(node) }
listeners[:on_forwarding_parameter_node_leave]&.each { |listener| listener.on_forwarding_parameter_node_leave(node) }
end
# Dispatch enter and leave events for ForwardingSuperNode nodes.
def visit_forwarding_super_node(node)
listeners[:on_forwarding_super_node_enter]&.each { |listener| listener.on_forwarding_super_node_enter(node) }
listeners[:on_forwarding_super_node_leave]&.each { |listener| listener.on_forwarding_super_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableAndWriteNode nodes.
def visit_global_variable_and_write_node(node)
listeners[:on_global_variable_and_write_node_enter]&.each { |listener| listener.on_global_variable_and_write_node_enter(node) }
listeners[:on_global_variable_and_write_node_leave]&.each { |listener| listener.on_global_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableOperatorWriteNode nodes.
def visit_global_variable_operator_write_node(node)
listeners[:on_global_variable_operator_write_node_enter]&.each { |listener| listener.on_global_variable_operator_write_node_enter(node) }
listeners[:on_global_variable_operator_write_node_leave]&.each { |listener| listener.on_global_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableOrWriteNode nodes.
def visit_global_variable_or_write_node(node)
listeners[:on_global_variable_or_write_node_enter]&.each { |listener| listener.on_global_variable_or_write_node_enter(node) }
listeners[:on_global_variable_or_write_node_leave]&.each { |listener| listener.on_global_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableReadNode nodes.
def visit_global_variable_read_node(node)
listeners[:on_global_variable_read_node_enter]&.each { |listener| listener.on_global_variable_read_node_enter(node) }
listeners[:on_global_variable_read_node_leave]&.each { |listener| listener.on_global_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableTargetNode nodes.
def visit_global_variable_target_node(node)
listeners[:on_global_variable_target_node_enter]&.each { |listener| listener.on_global_variable_target_node_enter(node) }
listeners[:on_global_variable_target_node_leave]&.each { |listener| listener.on_global_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for GlobalVariableWriteNode nodes.
def visit_global_variable_write_node(node)
listeners[:on_global_variable_write_node_enter]&.each { |listener| listener.on_global_variable_write_node_enter(node) }
listeners[:on_global_variable_write_node_leave]&.each { |listener| listener.on_global_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for HashNode nodes.
def visit_hash_node(node)
listeners[:on_hash_node_enter]&.each { |listener| listener.on_hash_node_enter(node) }
listeners[:on_hash_node_leave]&.each { |listener| listener.on_hash_node_leave(node) }
end
# Dispatch enter and leave events for HashPatternNode nodes.
def visit_hash_pattern_node(node)
listeners[:on_hash_pattern_node_enter]&.each { |listener| listener.on_hash_pattern_node_enter(node) }
listeners[:on_hash_pattern_node_leave]&.each { |listener| listener.on_hash_pattern_node_leave(node) }
end
# Dispatch enter and leave events for IfNode nodes.
def visit_if_node(node)
listeners[:on_if_node_enter]&.each { |listener| listener.on_if_node_enter(node) }
listeners[:on_if_node_leave]&.each { |listener| listener.on_if_node_leave(node) }
end
# Dispatch enter and leave events for ImaginaryNode nodes.
def visit_imaginary_node(node)
listeners[:on_imaginary_node_enter]&.each { |listener| listener.on_imaginary_node_enter(node) }
listeners[:on_imaginary_node_leave]&.each { |listener| listener.on_imaginary_node_leave(node) }
end
# Dispatch enter and leave events for ImplicitNode nodes.
def visit_implicit_node(node)
listeners[:on_implicit_node_enter]&.each { |listener| listener.on_implicit_node_enter(node) }
listeners[:on_implicit_node_leave]&.each { |listener| listener.on_implicit_node_leave(node) }
end
# Dispatch enter and leave events for ImplicitRestNode nodes.
def visit_implicit_rest_node(node)
listeners[:on_implicit_rest_node_enter]&.each { |listener| listener.on_implicit_rest_node_enter(node) }
listeners[:on_implicit_rest_node_leave]&.each { |listener| listener.on_implicit_rest_node_leave(node) }
end
# Dispatch enter and leave events for InNode nodes.
def visit_in_node(node)
listeners[:on_in_node_enter]&.each { |listener| listener.on_in_node_enter(node) }
listeners[:on_in_node_leave]&.each { |listener| listener.on_in_node_leave(node) }
end
# Dispatch enter and leave events for IndexAndWriteNode nodes.
def visit_index_and_write_node(node)
listeners[:on_index_and_write_node_enter]&.each { |listener| listener.on_index_and_write_node_enter(node) }
listeners[:on_index_and_write_node_leave]&.each { |listener| listener.on_index_and_write_node_leave(node) }
end
# Dispatch enter and leave events for IndexOperatorWriteNode nodes.
def visit_index_operator_write_node(node)
listeners[:on_index_operator_write_node_enter]&.each { |listener| listener.on_index_operator_write_node_enter(node) }
listeners[:on_index_operator_write_node_leave]&.each { |listener| listener.on_index_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for IndexOrWriteNode nodes.
def visit_index_or_write_node(node)
listeners[:on_index_or_write_node_enter]&.each { |listener| listener.on_index_or_write_node_enter(node) }
listeners[:on_index_or_write_node_leave]&.each { |listener| listener.on_index_or_write_node_leave(node) }
end
# Dispatch enter and leave events for IndexTargetNode nodes.
def visit_index_target_node(node)
listeners[:on_index_target_node_enter]&.each { |listener| listener.on_index_target_node_enter(node) }
listeners[:on_index_target_node_leave]&.each { |listener| listener.on_index_target_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableAndWriteNode nodes.
def visit_instance_variable_and_write_node(node)
listeners[:on_instance_variable_and_write_node_enter]&.each { |listener| listener.on_instance_variable_and_write_node_enter(node) }
listeners[:on_instance_variable_and_write_node_leave]&.each { |listener| listener.on_instance_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableOperatorWriteNode nodes.
def visit_instance_variable_operator_write_node(node)
listeners[:on_instance_variable_operator_write_node_enter]&.each { |listener| listener.on_instance_variable_operator_write_node_enter(node) }
listeners[:on_instance_variable_operator_write_node_leave]&.each { |listener| listener.on_instance_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableOrWriteNode nodes.
def visit_instance_variable_or_write_node(node)
listeners[:on_instance_variable_or_write_node_enter]&.each { |listener| listener.on_instance_variable_or_write_node_enter(node) }
listeners[:on_instance_variable_or_write_node_leave]&.each { |listener| listener.on_instance_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableReadNode nodes.
def visit_instance_variable_read_node(node)
listeners[:on_instance_variable_read_node_enter]&.each { |listener| listener.on_instance_variable_read_node_enter(node) }
listeners[:on_instance_variable_read_node_leave]&.each { |listener| listener.on_instance_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableTargetNode nodes.
def visit_instance_variable_target_node(node)
listeners[:on_instance_variable_target_node_enter]&.each { |listener| listener.on_instance_variable_target_node_enter(node) }
listeners[:on_instance_variable_target_node_leave]&.each { |listener| listener.on_instance_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for InstanceVariableWriteNode nodes.
def visit_instance_variable_write_node(node)
listeners[:on_instance_variable_write_node_enter]&.each { |listener| listener.on_instance_variable_write_node_enter(node) }
listeners[:on_instance_variable_write_node_leave]&.each { |listener| listener.on_instance_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for IntegerNode nodes.
def visit_integer_node(node)
listeners[:on_integer_node_enter]&.each { |listener| listener.on_integer_node_enter(node) }
listeners[:on_integer_node_leave]&.each { |listener| listener.on_integer_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedMatchLastLineNode nodes.
def visit_interpolated_match_last_line_node(node)
listeners[:on_interpolated_match_last_line_node_enter]&.each { |listener| listener.on_interpolated_match_last_line_node_enter(node) }
listeners[:on_interpolated_match_last_line_node_leave]&.each { |listener| listener.on_interpolated_match_last_line_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedRegularExpressionNode nodes.
def visit_interpolated_regular_expression_node(node)
listeners[:on_interpolated_regular_expression_node_enter]&.each { |listener| listener.on_interpolated_regular_expression_node_enter(node) }
listeners[:on_interpolated_regular_expression_node_leave]&.each { |listener| listener.on_interpolated_regular_expression_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedStringNode nodes.
def visit_interpolated_string_node(node)
listeners[:on_interpolated_string_node_enter]&.each { |listener| listener.on_interpolated_string_node_enter(node) }
listeners[:on_interpolated_string_node_leave]&.each { |listener| listener.on_interpolated_string_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedSymbolNode nodes.
def visit_interpolated_symbol_node(node)
listeners[:on_interpolated_symbol_node_enter]&.each { |listener| listener.on_interpolated_symbol_node_enter(node) }
listeners[:on_interpolated_symbol_node_leave]&.each { |listener| listener.on_interpolated_symbol_node_leave(node) }
end
# Dispatch enter and leave events for InterpolatedXStringNode nodes.
def visit_interpolated_x_string_node(node)
listeners[:on_interpolated_x_string_node_enter]&.each { |listener| listener.on_interpolated_x_string_node_enter(node) }
listeners[:on_interpolated_x_string_node_leave]&.each { |listener| listener.on_interpolated_x_string_node_leave(node) }
end
# Dispatch enter and leave events for KeywordHashNode nodes.
def visit_keyword_hash_node(node)
listeners[:on_keyword_hash_node_enter]&.each { |listener| listener.on_keyword_hash_node_enter(node) }
listeners[:on_keyword_hash_node_leave]&.each { |listener| listener.on_keyword_hash_node_leave(node) }
end
# Dispatch enter and leave events for KeywordRestParameterNode nodes.
def visit_keyword_rest_parameter_node(node)
listeners[:on_keyword_rest_parameter_node_enter]&.each { |listener| listener.on_keyword_rest_parameter_node_enter(node) }
listeners[:on_keyword_rest_parameter_node_leave]&.each { |listener| listener.on_keyword_rest_parameter_node_leave(node) }
end
# Dispatch enter and leave events for LambdaNode nodes.
def visit_lambda_node(node)
listeners[:on_lambda_node_enter]&.each { |listener| listener.on_lambda_node_enter(node) }
listeners[:on_lambda_node_leave]&.each { |listener| listener.on_lambda_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableAndWriteNode nodes.
def visit_local_variable_and_write_node(node)
listeners[:on_local_variable_and_write_node_enter]&.each { |listener| listener.on_local_variable_and_write_node_enter(node) }
listeners[:on_local_variable_and_write_node_leave]&.each { |listener| listener.on_local_variable_and_write_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableOperatorWriteNode nodes.
def visit_local_variable_operator_write_node(node)
listeners[:on_local_variable_operator_write_node_enter]&.each { |listener| listener.on_local_variable_operator_write_node_enter(node) }
listeners[:on_local_variable_operator_write_node_leave]&.each { |listener| listener.on_local_variable_operator_write_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableOrWriteNode nodes.
def visit_local_variable_or_write_node(node)
listeners[:on_local_variable_or_write_node_enter]&.each { |listener| listener.on_local_variable_or_write_node_enter(node) }
listeners[:on_local_variable_or_write_node_leave]&.each { |listener| listener.on_local_variable_or_write_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableReadNode nodes.
def visit_local_variable_read_node(node)
listeners[:on_local_variable_read_node_enter]&.each { |listener| listener.on_local_variable_read_node_enter(node) }
listeners[:on_local_variable_read_node_leave]&.each { |listener| listener.on_local_variable_read_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableTargetNode nodes.
def visit_local_variable_target_node(node)
listeners[:on_local_variable_target_node_enter]&.each { |listener| listener.on_local_variable_target_node_enter(node) }
listeners[:on_local_variable_target_node_leave]&.each { |listener| listener.on_local_variable_target_node_leave(node) }
end
# Dispatch enter and leave events for LocalVariableWriteNode nodes.
def visit_local_variable_write_node(node)
listeners[:on_local_variable_write_node_enter]&.each { |listener| listener.on_local_variable_write_node_enter(node) }
listeners[:on_local_variable_write_node_leave]&.each { |listener| listener.on_local_variable_write_node_leave(node) }
end
# Dispatch enter and leave events for MatchLastLineNode nodes.
def visit_match_last_line_node(node)
listeners[:on_match_last_line_node_enter]&.each { |listener| listener.on_match_last_line_node_enter(node) }
listeners[:on_match_last_line_node_leave]&.each { |listener| listener.on_match_last_line_node_leave(node) }
end
# Dispatch enter and leave events for MatchPredicateNode nodes.
def visit_match_predicate_node(node)
listeners[:on_match_predicate_node_enter]&.each { |listener| listener.on_match_predicate_node_enter(node) }
listeners[:on_match_predicate_node_leave]&.each { |listener| listener.on_match_predicate_node_leave(node) }
end
# Dispatch enter and leave events for MatchRequiredNode nodes.
def visit_match_required_node(node)
listeners[:on_match_required_node_enter]&.each { |listener| listener.on_match_required_node_enter(node) }
listeners[:on_match_required_node_leave]&.each { |listener| listener.on_match_required_node_leave(node) }
end
# Dispatch enter and leave events for MatchWriteNode nodes.
def visit_match_write_node(node)
listeners[:on_match_write_node_enter]&.each { |listener| listener.on_match_write_node_enter(node) }
listeners[:on_match_write_node_leave]&.each { |listener| listener.on_match_write_node_leave(node) }
end
# Dispatch enter and leave events for MissingNode nodes.
def visit_missing_node(node)
listeners[:on_missing_node_enter]&.each { |listener| listener.on_missing_node_enter(node) }
listeners[:on_missing_node_leave]&.each { |listener| listener.on_missing_node_leave(node) }
end
# Dispatch enter and leave events for ModuleNode nodes.
def visit_module_node(node)
listeners[:on_module_node_enter]&.each { |listener| listener.on_module_node_enter(node) }
listeners[:on_module_node_leave]&.each { |listener| listener.on_module_node_leave(node) }
end
# Dispatch enter and leave events for MultiTargetNode nodes.
def visit_multi_target_node(node)
listeners[:on_multi_target_node_enter]&.each { |listener| listener.on_multi_target_node_enter(node) }
listeners[:on_multi_target_node_leave]&.each { |listener| listener.on_multi_target_node_leave(node) }
end
# Dispatch enter and leave events for MultiWriteNode nodes.
def visit_multi_write_node(node)
listeners[:on_multi_write_node_enter]&.each { |listener| listener.on_multi_write_node_enter(node) }
listeners[:on_multi_write_node_leave]&.each { |listener| listener.on_multi_write_node_leave(node) }
end
# Dispatch enter and leave events for NextNode nodes.
def visit_next_node(node)
listeners[:on_next_node_enter]&.each { |listener| listener.on_next_node_enter(node) }
listeners[:on_next_node_leave]&.each { |listener| listener.on_next_node_leave(node) }
end
# Dispatch enter and leave events for NilNode nodes.
def visit_nil_node(node)
listeners[:on_nil_node_enter]&.each { |listener| listener.on_nil_node_enter(node) }
listeners[:on_nil_node_leave]&.each { |listener| listener.on_nil_node_leave(node) }
end
# Dispatch enter and leave events for NoKeywordsParameterNode nodes.
def visit_no_keywords_parameter_node(node)
listeners[:on_no_keywords_parameter_node_enter]&.each { |listener| listener.on_no_keywords_parameter_node_enter(node) }
listeners[:on_no_keywords_parameter_node_leave]&.each { |listener| listener.on_no_keywords_parameter_node_leave(node) }
end
# Dispatch enter and leave events for NumberedParametersNode nodes.
def visit_numbered_parameters_node(node)
listeners[:on_numbered_parameters_node_enter]&.each { |listener| listener.on_numbered_parameters_node_enter(node) }
listeners[:on_numbered_parameters_node_leave]&.each { |listener| listener.on_numbered_parameters_node_leave(node) }
end
# Dispatch enter and leave events for NumberedReferenceReadNode nodes.
def visit_numbered_reference_read_node(node)
listeners[:on_numbered_reference_read_node_enter]&.each { |listener| listener.on_numbered_reference_read_node_enter(node) }
listeners[:on_numbered_reference_read_node_leave]&.each { |listener| listener.on_numbered_reference_read_node_leave(node) }
end
# Dispatch enter and leave events for OptionalKeywordParameterNode nodes.
def visit_optional_keyword_parameter_node(node)
listeners[:on_optional_keyword_parameter_node_enter]&.each { |listener| listener.on_optional_keyword_parameter_node_enter(node) }
listeners[:on_optional_keyword_parameter_node_leave]&.each { |listener| listener.on_optional_keyword_parameter_node_leave(node) }
end
# Dispatch enter and leave events for OptionalParameterNode nodes.
def visit_optional_parameter_node(node)
listeners[:on_optional_parameter_node_enter]&.each { |listener| listener.on_optional_parameter_node_enter(node) }
listeners[:on_optional_parameter_node_leave]&.each { |listener| listener.on_optional_parameter_node_leave(node) }
end
# Dispatch enter and leave events for OrNode nodes.
def visit_or_node(node)
listeners[:on_or_node_enter]&.each { |listener| listener.on_or_node_enter(node) }
listeners[:on_or_node_leave]&.each { |listener| listener.on_or_node_leave(node) }
end
# Dispatch enter and leave events for ParametersNode nodes.
def visit_parameters_node(node)
listeners[:on_parameters_node_enter]&.each { |listener| listener.on_parameters_node_enter(node) }
listeners[:on_parameters_node_leave]&.each { |listener| listener.on_parameters_node_leave(node) }
end
# Dispatch enter and leave events for ParenthesesNode nodes.
def visit_parentheses_node(node)
listeners[:on_parentheses_node_enter]&.each { |listener| listener.on_parentheses_node_enter(node) }
listeners[:on_parentheses_node_leave]&.each { |listener| listener.on_parentheses_node_leave(node) }
end
# Dispatch enter and leave events for PinnedExpressionNode nodes.
def visit_pinned_expression_node(node)
listeners[:on_pinned_expression_node_enter]&.each { |listener| listener.on_pinned_expression_node_enter(node) }
listeners[:on_pinned_expression_node_leave]&.each { |listener| listener.on_pinned_expression_node_leave(node) }
end
# Dispatch enter and leave events for PinnedVariableNode nodes.
def visit_pinned_variable_node(node)
listeners[:on_pinned_variable_node_enter]&.each { |listener| listener.on_pinned_variable_node_enter(node) }
listeners[:on_pinned_variable_node_leave]&.each { |listener| listener.on_pinned_variable_node_leave(node) }
end
# Dispatch enter and leave events for PostExecutionNode nodes.
def visit_post_execution_node(node)
listeners[:on_post_execution_node_enter]&.each { |listener| listener.on_post_execution_node_enter(node) }
listeners[:on_post_execution_node_leave]&.each { |listener| listener.on_post_execution_node_leave(node) }
end
# Dispatch enter and leave events for PreExecutionNode nodes.
def visit_pre_execution_node(node)
listeners[:on_pre_execution_node_enter]&.each { |listener| listener.on_pre_execution_node_enter(node) }
listeners[:on_pre_execution_node_leave]&.each { |listener| listener.on_pre_execution_node_leave(node) }
end
# Dispatch enter and leave events for ProgramNode nodes.
def visit_program_node(node)
listeners[:on_program_node_enter]&.each { |listener| listener.on_program_node_enter(node) }
listeners[:on_program_node_leave]&.each { |listener| listener.on_program_node_leave(node) }
end
# Dispatch enter and leave events for RangeNode nodes.
def visit_range_node(node)
listeners[:on_range_node_enter]&.each { |listener| listener.on_range_node_enter(node) }
listeners[:on_range_node_leave]&.each { |listener| listener.on_range_node_leave(node) }
end
# Dispatch enter and leave events for RationalNode nodes.
def visit_rational_node(node)
listeners[:on_rational_node_enter]&.each { |listener| listener.on_rational_node_enter(node) }
listeners[:on_rational_node_leave]&.each { |listener| listener.on_rational_node_leave(node) }
end
# Dispatch enter and leave events for RedoNode nodes.
def visit_redo_node(node)
listeners[:on_redo_node_enter]&.each { |listener| listener.on_redo_node_enter(node) }
listeners[:on_redo_node_leave]&.each { |listener| listener.on_redo_node_leave(node) }
end
# Dispatch enter and leave events for RegularExpressionNode nodes.
def visit_regular_expression_node(node)
listeners[:on_regular_expression_node_enter]&.each { |listener| listener.on_regular_expression_node_enter(node) }
listeners[:on_regular_expression_node_leave]&.each { |listener| listener.on_regular_expression_node_leave(node) }
end
# Dispatch enter and leave events for RequiredKeywordParameterNode nodes.
def visit_required_keyword_parameter_node(node)
listeners[:on_required_keyword_parameter_node_enter]&.each { |listener| listener.on_required_keyword_parameter_node_enter(node) }
listeners[:on_required_keyword_parameter_node_leave]&.each { |listener| listener.on_required_keyword_parameter_node_leave(node) }
end
# Dispatch enter and leave events for RequiredParameterNode nodes.
def visit_required_parameter_node(node)
listeners[:on_required_parameter_node_enter]&.each { |listener| listener.on_required_parameter_node_enter(node) }
listeners[:on_required_parameter_node_leave]&.each { |listener| listener.on_required_parameter_node_leave(node) }
end
# Dispatch enter and leave events for RescueModifierNode nodes.
def visit_rescue_modifier_node(node)
listeners[:on_rescue_modifier_node_enter]&.each { |listener| listener.on_rescue_modifier_node_enter(node) }
listeners[:on_rescue_modifier_node_leave]&.each { |listener| listener.on_rescue_modifier_node_leave(node) }
end
# Dispatch enter and leave events for RescueNode nodes.
def visit_rescue_node(node)
listeners[:on_rescue_node_enter]&.each { |listener| listener.on_rescue_node_enter(node) }
listeners[:on_rescue_node_leave]&.each { |listener| listener.on_rescue_node_leave(node) }
end
# Dispatch enter and leave events for RestParameterNode nodes.
def visit_rest_parameter_node(node)
listeners[:on_rest_parameter_node_enter]&.each { |listener| listener.on_rest_parameter_node_enter(node) }
listeners[:on_rest_parameter_node_leave]&.each { |listener| listener.on_rest_parameter_node_leave(node) }
end
# Dispatch enter and leave events for RetryNode nodes.
def visit_retry_node(node)
listeners[:on_retry_node_enter]&.each { |listener| listener.on_retry_node_enter(node) }
listeners[:on_retry_node_leave]&.each { |listener| listener.on_retry_node_leave(node) }
end
# Dispatch enter and leave events for ReturnNode nodes.
def visit_return_node(node)
listeners[:on_return_node_enter]&.each { |listener| listener.on_return_node_enter(node) }
listeners[:on_return_node_leave]&.each { |listener| listener.on_return_node_leave(node) }
end
# Dispatch enter and leave events for SelfNode nodes.
def visit_self_node(node)
listeners[:on_self_node_enter]&.each { |listener| listener.on_self_node_enter(node) }
listeners[:on_self_node_leave]&.each { |listener| listener.on_self_node_leave(node) }
end
# Dispatch enter and leave events for SingletonClassNode nodes.
def visit_singleton_class_node(node)
listeners[:on_singleton_class_node_enter]&.each { |listener| listener.on_singleton_class_node_enter(node) }
listeners[:on_singleton_class_node_leave]&.each { |listener| listener.on_singleton_class_node_leave(node) }
end
# Dispatch enter and leave events for SourceEncodingNode nodes.
def visit_source_encoding_node(node)
listeners[:on_source_encoding_node_enter]&.each { |listener| listener.on_source_encoding_node_enter(node) }
listeners[:on_source_encoding_node_leave]&.each { |listener| listener.on_source_encoding_node_leave(node) }
end
# Dispatch enter and leave events for SourceFileNode nodes.
def visit_source_file_node(node)
listeners[:on_source_file_node_enter]&.each { |listener| listener.on_source_file_node_enter(node) }
listeners[:on_source_file_node_leave]&.each { |listener| listener.on_source_file_node_leave(node) }
end
# Dispatch enter and leave events for SourceLineNode nodes.
def visit_source_line_node(node)
listeners[:on_source_line_node_enter]&.each { |listener| listener.on_source_line_node_enter(node) }
listeners[:on_source_line_node_leave]&.each { |listener| listener.on_source_line_node_leave(node) }
end
# Dispatch enter and leave events for SplatNode nodes.
def visit_splat_node(node)
listeners[:on_splat_node_enter]&.each { |listener| listener.on_splat_node_enter(node) }
listeners[:on_splat_node_leave]&.each { |listener| listener.on_splat_node_leave(node) }
end
# Dispatch enter and leave events for StatementsNode nodes.
def visit_statements_node(node)
listeners[:on_statements_node_enter]&.each { |listener| listener.on_statements_node_enter(node) }
listeners[:on_statements_node_leave]&.each { |listener| listener.on_statements_node_leave(node) }
end
# Dispatch enter and leave events for StringNode nodes.
def visit_string_node(node)
listeners[:on_string_node_enter]&.each { |listener| listener.on_string_node_enter(node) }
listeners[:on_string_node_leave]&.each { |listener| listener.on_string_node_leave(node) }
end
# Dispatch enter and leave events for SuperNode nodes.
def visit_super_node(node)
listeners[:on_super_node_enter]&.each { |listener| listener.on_super_node_enter(node) }
listeners[:on_super_node_leave]&.each { |listener| listener.on_super_node_leave(node) }
end
# Dispatch enter and leave events for SymbolNode nodes.
def visit_symbol_node(node)
listeners[:on_symbol_node_enter]&.each { |listener| listener.on_symbol_node_enter(node) }
listeners[:on_symbol_node_leave]&.each { |listener| listener.on_symbol_node_leave(node) }
end
# Dispatch enter and leave events for TrueNode nodes.
def visit_true_node(node)
listeners[:on_true_node_enter]&.each { |listener| listener.on_true_node_enter(node) }
listeners[:on_true_node_leave]&.each { |listener| listener.on_true_node_leave(node) }
end
# Dispatch enter and leave events for UndefNode nodes.
def visit_undef_node(node)
listeners[:on_undef_node_enter]&.each { |listener| listener.on_undef_node_enter(node) }
listeners[:on_undef_node_leave]&.each { |listener| listener.on_undef_node_leave(node) }
end
# Dispatch enter and leave events for UnlessNode nodes.
def visit_unless_node(node)
listeners[:on_unless_node_enter]&.each { |listener| listener.on_unless_node_enter(node) }
listeners[:on_unless_node_leave]&.each { |listener| listener.on_unless_node_leave(node) }
end
# Dispatch enter and leave events for UntilNode nodes.
def visit_until_node(node)
listeners[:on_until_node_enter]&.each { |listener| listener.on_until_node_enter(node) }
listeners[:on_until_node_leave]&.each { |listener| listener.on_until_node_leave(node) }
end
# Dispatch enter and leave events for WhenNode nodes.
def visit_when_node(node)
listeners[:on_when_node_enter]&.each { |listener| listener.on_when_node_enter(node) }
listeners[:on_when_node_leave]&.each { |listener| listener.on_when_node_leave(node) }
end
# Dispatch enter and leave events for WhileNode nodes.
def visit_while_node(node)
listeners[:on_while_node_enter]&.each { |listener| listener.on_while_node_enter(node) }
listeners[:on_while_node_leave]&.each { |listener| listener.on_while_node_leave(node) }
end
# Dispatch enter and leave events for XStringNode nodes.
def visit_x_string_node(node)
listeners[:on_x_string_node_enter]&.each { |listener| listener.on_x_string_node_enter(node) }
listeners[:on_x_string_node_leave]&.each { |listener| listener.on_x_string_node_leave(node) }
end
# Dispatch enter and leave events for YieldNode nodes.
def visit_yield_node(node)
listeners[:on_yield_node_enter]&.each { |listener| listener.on_yield_node_enter(node) }
listeners[:on_yield_node_leave]&.each { |listener| listener.on_yield_node_leave(node) }
end
end
private_constant :DispatchOnce
end
end
share/ruby/prism/node_inspector.rb 0000644 00000004101 15173517735 0013333 0 ustar 00 # frozen_string_literal: true
module Prism
# This object is responsible for generating the output for the inspect method
# implementations of child nodes.
class NodeInspector # :nodoc:
attr_reader :prefix, :output
def initialize(prefix = "")
@prefix = prefix
@output = +""
end
# Appends a line to the output with the current prefix.
def <<(line)
output << "#{prefix}#{line}"
end
# This generates a string that is used as the header of the inspect output
# for any given node.
def header(node)
output = +"@ #{node.class.name.split("::").last} ("
output << "location: (#{node.location.start_line},#{node.location.start_column})-(#{node.location.end_line},#{node.location.end_column})"
output << ", newline: true" if node.newline?
output << ")\n"
output
end
# Generates a string that represents a list of nodes. It handles properly
# using the box drawing characters to make the output look nice.
def list(prefix, nodes)
output = +"(length: #{nodes.length})\n"
last_index = nodes.length - 1
nodes.each_with_index do |node, index|
pointer, preadd = (index == last_index) ? ["└── ", " "] : ["├── ", "│ "]
node_prefix = "#{prefix}#{preadd}"
output << node.inspect(NodeInspector.new(node_prefix)).sub(node_prefix, "#{prefix}#{pointer}")
end
output
end
# Generates a string that represents a location field on a node.
def location(value)
if value
"(#{value.start_line},#{value.start_column})-(#{value.end_line},#{value.end_column}) = #{value.slice.inspect}"
else
"∅"
end
end
# Generates a string that represents a child node.
def child_node(node, append)
node.inspect(child_inspector(append)).delete_prefix(prefix)
end
# Returns a new inspector that can be used to inspect a child node.
def child_inspector(append)
NodeInspector.new("#{prefix}#{append}")
end
# Returns the output as a string.
def to_str
output
end
end
end
share/ruby/prism/pack.rb 0000644 00000013420 15173517735 0011242 0 ustar 00 # frozen_string_literal: true
module Prism
# A parser for the pack template language.
module Pack
%i[
SPACE
COMMENT
INTEGER
UTF8
BER
FLOAT
STRING_SPACE_PADDED
STRING_NULL_PADDED
STRING_NULL_TERMINATED
STRING_MSB
STRING_LSB
STRING_HEX_HIGH
STRING_HEX_LOW
STRING_UU
STRING_MIME
STRING_BASE64
STRING_FIXED
STRING_POINTER
MOVE
BACK
NULL
UNSIGNED
SIGNED
SIGNED_NA
AGNOSTIC_ENDIAN
LITTLE_ENDIAN
BIG_ENDIAN
NATIVE_ENDIAN
ENDIAN_NA
SIZE_SHORT
SIZE_INT
SIZE_LONG
SIZE_LONG_LONG
SIZE_8
SIZE_16
SIZE_32
SIZE_64
SIZE_P
SIZE_NA
LENGTH_FIXED
LENGTH_MAX
LENGTH_RELATIVE
LENGTH_NA
].each do |const|
const_set(const, const)
end
# A directive in the pack template language.
class Directive
# A symbol representing the version of Ruby.
attr_reader :version
# A symbol representing whether or not we are packing or unpacking.
attr_reader :variant
# A byteslice of the source string that this directive represents.
attr_reader :source
# The type of the directive.
attr_reader :type
# The type of signedness of the directive.
attr_reader :signed
# The type of endianness of the directive.
attr_reader :endian
# The size of the directive.
attr_reader :size
# The length type of this directive (used for integers).
attr_reader :length_type
# The length of this directive (used for integers).
attr_reader :length
# Initialize a new directive with the given values.
def initialize(version, variant, source, type, signed, endian, size, length_type, length)
@version = version
@variant = variant
@source = source
@type = type
@signed = signed
@endian = endian
@size = size
@length_type = length_type
@length = length
end
# The descriptions of the various types of endianness.
ENDIAN_DESCRIPTIONS = {
AGNOSTIC_ENDIAN: "agnostic",
LITTLE_ENDIAN: "little-endian (VAX)",
BIG_ENDIAN: "big-endian (network)",
NATIVE_ENDIAN: "native-endian",
ENDIAN_NA: "n/a"
}
# The descriptions of the various types of signedness.
SIGNED_DESCRIPTIONS = {
UNSIGNED: "unsigned",
SIGNED: "signed",
SIGNED_NA: "n/a"
}
# The descriptions of the various types of sizes.
SIZE_DESCRIPTIONS = {
SIZE_SHORT: "short",
SIZE_INT: "int-width",
SIZE_LONG: "long",
SIZE_LONG_LONG: "long long",
SIZE_8: "8-bit",
SIZE_16: "16-bit",
SIZE_32: "32-bit",
SIZE_64: "64-bit",
SIZE_P: "pointer-width"
}
# Provide a human-readable description of the directive.
def describe
case type
when SPACE
"whitespace"
when COMMENT
"comment"
when INTEGER
if size == SIZE_8
base = "#{SIGNED_DESCRIPTIONS[signed]} #{SIZE_DESCRIPTIONS[size]} integer"
else
base = "#{SIGNED_DESCRIPTIONS[signed]} #{SIZE_DESCRIPTIONS[size]} #{ENDIAN_DESCRIPTIONS[endian]} integer"
end
case length_type
when LENGTH_FIXED
if length > 1
base + ", x#{length}"
else
base
end
when LENGTH_MAX
base + ", as many as possible"
end
when UTF8
"UTF-8 character"
when BER
"BER-compressed integer"
when FLOAT
"#{SIZE_DESCRIPTIONS[size]} #{ENDIAN_DESCRIPTIONS[endian]} float"
when STRING_SPACE_PADDED
"arbitrary binary string (space padded)"
when STRING_NULL_PADDED
"arbitrary binary string (null padded, count is width)"
when STRING_NULL_TERMINATED
"arbitrary binary string (null padded, count is width), except that null is added with *"
when STRING_MSB
"bit string (MSB first)"
when STRING_LSB
"bit string (LSB first)"
when STRING_HEX_HIGH
"hex string (high nibble first)"
when STRING_HEX_LOW
"hex string (low nibble first)"
when STRING_UU
"UU-encoded string"
when STRING_MIME
"quoted printable, MIME encoding"
when STRING_BASE64
"base64 encoded string"
when STRING_FIXED
"pointer to a structure (fixed-length string)"
when STRING_POINTER
"pointer to a null-terminated string"
when MOVE
"move to absolute position"
when BACK
"back up a byte"
when NULL
"null byte"
else
raise
end
end
end
# The result of parsing a pack template.
class Format
# A list of the directives in the template.
attr_reader :directives
# The encoding of the template.
attr_reader :encoding
# Create a new Format with the given directives and encoding.
def initialize(directives, encoding)
@directives = directives
@encoding = encoding
end
# Provide a human-readable description of the format.
def describe
source_width = directives.map { |d| d.source.inspect.length }.max
directive_lines = directives.map do |directive|
if directive.type == SPACE
source = directive.source.inspect
else
source = directive.source
end
" #{source.ljust(source_width)} #{directive.describe}"
end
(["Directives:"] + directive_lines + ["Encoding:", " #{encoding}"]).join("\n")
end
end
end
end
share/ruby/prism/node.rb 0000644 00002176644 15173517735 0011275 0 ustar 00 # frozen_string_literal: true
=begin
This file is generated by the templates/template.rb script and should not be
modified manually. See templates/lib/prism/node.rb.erb
if you are looking to modify the template
=end
module Prism
# This represents a node in the tree. It is the parent class of all of the
# various node types.
class Node
# A Location instance that represents the location of this node in the
# source.
attr_reader :location
def newline? # :nodoc:
@newline ? true : false
end
def set_newline_flag(newline_marked) # :nodoc:
line = location.start_line
unless newline_marked[line]
newline_marked[line] = true
@newline = true
end
end
# Slice the location of the node from the source.
def slice
location.slice
end
# Similar to inspect, but respects the current level of indentation given by
# the pretty print object.
def pretty_print(q)
q.seplist(inspect.chomp.each_line, -> { q.breakable }) do |line|
q.text(line.chomp)
end
q.current_group.break
end
# Convert this node into a graphviz dot graph string.
def to_dot
DotVisitor.new.tap { |visitor| accept(visitor) }.to_dot
end
end
# Represents the use of the `alias` keyword to alias a global variable.
#
# alias $foo $bar
# ^^^^^^^^^^^^^^^
class AliasGlobalVariableNode < Node
# attr_reader new_name: Node
attr_reader :new_name
# attr_reader old_name: Node
attr_reader :old_name
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# def initialize: (new_name: Node, old_name: Node, keyword_loc: Location, location: Location) -> void
def initialize(new_name, old_name, keyword_loc, location)
@new_name = new_name
@old_name = old_name
@keyword_loc = keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_alias_global_variable_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[new_name, old_name]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[new_name, old_name]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[new_name, old_name, keyword_loc]
end
# def copy: (**params) -> AliasGlobalVariableNode
def copy(**params)
AliasGlobalVariableNode.new(
params.fetch(:new_name) { new_name },
params.fetch(:old_name) { old_name },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ new_name: new_name, old_name: old_name, keyword_loc: keyword_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── new_name:\n"
inspector << inspector.child_node(new_name, "│ ")
inspector << "├── old_name:\n"
inspector << inspector.child_node(old_name, "│ ")
inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:alias_global_variable_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:alias_global_variable_node
end
end
# Represents the use of the `alias` keyword to alias a method.
#
# alias foo bar
# ^^^^^^^^^^^^^
class AliasMethodNode < Node
# attr_reader new_name: Node
attr_reader :new_name
# attr_reader old_name: Node
attr_reader :old_name
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# def initialize: (new_name: Node, old_name: Node, keyword_loc: Location, location: Location) -> void
def initialize(new_name, old_name, keyword_loc, location)
@new_name = new_name
@old_name = old_name
@keyword_loc = keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_alias_method_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[new_name, old_name]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[new_name, old_name]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[new_name, old_name, keyword_loc]
end
# def copy: (**params) -> AliasMethodNode
def copy(**params)
AliasMethodNode.new(
params.fetch(:new_name) { new_name },
params.fetch(:old_name) { old_name },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ new_name: new_name, old_name: old_name, keyword_loc: keyword_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── new_name:\n"
inspector << inspector.child_node(new_name, "│ ")
inspector << "├── old_name:\n"
inspector << inspector.child_node(old_name, "│ ")
inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:alias_method_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:alias_method_node
end
end
# Represents an alternation pattern in pattern matching.
#
# foo => bar | baz
# ^^^^^^^^^
class AlternationPatternNode < Node
# attr_reader left: Node
attr_reader :left
# attr_reader right: Node
attr_reader :right
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (left: Node, right: Node, operator_loc: Location, location: Location) -> void
def initialize(left, right, operator_loc, location)
@left = left
@right = right
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_alternation_pattern_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[left, right]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[left, right]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[left, right, operator_loc]
end
# def copy: (**params) -> AlternationPatternNode
def copy(**params)
AlternationPatternNode.new(
params.fetch(:left) { left },
params.fetch(:right) { right },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ left: left, right: right, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── left:\n"
inspector << inspector.child_node(left, "│ ")
inspector << "├── right:\n"
inspector << inspector.child_node(right, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:alternation_pattern_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:alternation_pattern_node
end
end
# Represents the use of the `&&` operator or the `and` keyword.
#
# left and right
# ^^^^^^^^^^^^^^
class AndNode < Node
# attr_reader left: Node
attr_reader :left
# attr_reader right: Node
attr_reader :right
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (left: Node, right: Node, operator_loc: Location, location: Location) -> void
def initialize(left, right, operator_loc, location)
@left = left
@right = right
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_and_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[left, right]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[left, right]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[left, right, operator_loc]
end
# def copy: (**params) -> AndNode
def copy(**params)
AndNode.new(
params.fetch(:left) { left },
params.fetch(:right) { right },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ left: left, right: right, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── left:\n"
inspector << inspector.child_node(left, "│ ")
inspector << "├── right:\n"
inspector << inspector.child_node(right, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:and_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:and_node
end
end
# Represents a set of arguments to a method or a keyword.
#
# return foo, bar, baz
# ^^^^^^^^^^^^^
class ArgumentsNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader arguments: Array[Node]
attr_reader :arguments
# def initialize: (flags: Integer, arguments: Array[Node], location: Location) -> void
def initialize(flags, arguments, location)
@flags = flags
@arguments = arguments
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_arguments_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*arguments]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*arguments]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*arguments]
end
# def copy: (**params) -> ArgumentsNode
def copy(**params)
ArgumentsNode.new(
params.fetch(:flags) { flags },
params.fetch(:arguments) { arguments },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, arguments: arguments, location: location }
end
# def contains_keyword_splat?: () -> bool
def contains_keyword_splat?
flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORD_SPLAT)
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("contains_keyword_splat" if contains_keyword_splat?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "└── arguments: #{inspector.list("#{inspector.prefix} ", arguments)}"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:arguments_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:arguments_node
end
end
# Represents an array literal. This can be a regular array using brackets or
# a special array using % like %w or %i.
#
# [1, 2, 3]
# ^^^^^^^^^
class ArrayNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader elements: Array[Node]
attr_reader :elements
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# def initialize: (flags: Integer, elements: Array[Node], opening_loc: Location?, closing_loc: Location?, location: Location) -> void
def initialize(flags, elements, opening_loc, closing_loc, location)
@flags = flags
@elements = elements
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_array_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*elements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*elements]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*elements, *opening_loc, *closing_loc]
end
# def copy: (**params) -> ArrayNode
def copy(**params)
ArrayNode.new(
params.fetch(:flags) { flags },
params.fetch(:elements) { elements },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def contains_splat?: () -> bool
def contains_splat?
flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("contains_splat" if contains_splat?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── elements: #{inspector.list("#{inspector.prefix}│ ", elements)}"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:array_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:array_node
end
end
# Represents an array pattern in pattern matching.
#
# foo in 1, 2
# ^^^^^^^^^^^
#
# foo in [1, 2]
# ^^^^^^^^^^^^^
#
# foo in *1
# ^^^^^^^^^
#
# foo in Bar[]
# ^^^^^^^^^^^^
#
# foo in Bar[1, 2, 3]
# ^^^^^^^^^^^^^^^^^^^
class ArrayPatternNode < Node
# attr_reader constant: Node?
attr_reader :constant
# attr_reader requireds: Array[Node]
attr_reader :requireds
# attr_reader rest: Node?
attr_reader :rest
# attr_reader posts: Array[Node]
attr_reader :posts
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# def initialize: (constant: Node?, requireds: Array[Node], rest: Node?, posts: Array[Node], opening_loc: Location?, closing_loc: Location?, location: Location) -> void
def initialize(constant, requireds, rest, posts, opening_loc, closing_loc, location)
@constant = constant
@requireds = requireds
@rest = rest
@posts = posts
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_array_pattern_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[constant, *requireds, rest, *posts]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << constant if constant
compact.concat(requireds)
compact << rest if rest
compact.concat(posts)
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*constant, *requireds, *rest, *posts, *opening_loc, *closing_loc]
end
# def copy: (**params) -> ArrayPatternNode
def copy(**params)
ArrayPatternNode.new(
params.fetch(:constant) { constant },
params.fetch(:requireds) { requireds },
params.fetch(:rest) { rest },
params.fetch(:posts) { posts },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ constant: constant, requireds: requireds, rest: rest, posts: posts, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (constant = self.constant).nil?
inspector << "├── constant: ∅\n"
else
inspector << "├── constant:\n"
inspector << constant.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── requireds: #{inspector.list("#{inspector.prefix}│ ", requireds)}"
if (rest = self.rest).nil?
inspector << "├── rest: ∅\n"
else
inspector << "├── rest:\n"
inspector << rest.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── posts: #{inspector.list("#{inspector.prefix}│ ", posts)}"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:array_pattern_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:array_pattern_node
end
end
# Represents a hash key/value pair.
#
# { a => b }
# ^^^^^^
class AssocNode < Node
# attr_reader key: Node
attr_reader :key
# attr_reader value: Node?
attr_reader :value
# attr_reader operator_loc: Location?
attr_reader :operator_loc
# def initialize: (key: Node, value: Node?, operator_loc: Location?, location: Location) -> void
def initialize(key, value, operator_loc, location)
@key = key
@value = value
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_assoc_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[key, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << key
compact << value if value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[key, *value, *operator_loc]
end
# def copy: (**params) -> AssocNode
def copy(**params)
AssocNode.new(
params.fetch(:key) { key },
params.fetch(:value) { value },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ key: key, value: value, operator_loc: operator_loc, location: location }
end
# def operator: () -> String?
def operator
operator_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── key:\n"
inspector << inspector.child_node(key, "│ ")
if (value = self.value).nil?
inspector << "├── value: ∅\n"
else
inspector << "├── value:\n"
inspector << value.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:assoc_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:assoc_node
end
end
# Represents a splat in a hash literal.
#
# { **foo }
# ^^^^^
class AssocSplatNode < Node
# attr_reader value: Node?
attr_reader :value
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (value: Node?, operator_loc: Location, location: Location) -> void
def initialize(value, operator_loc, location)
@value = value
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_assoc_splat_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << value if value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*value, operator_loc]
end
# def copy: (**params) -> AssocSplatNode
def copy(**params)
AssocSplatNode.new(
params.fetch(:value) { value },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ value: value, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (value = self.value).nil?
inspector << "├── value: ∅\n"
else
inspector << "├── value:\n"
inspector << value.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:assoc_splat_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:assoc_splat_node
end
end
# Represents reading a reference to a field in the previous match.
#
# $'
# ^^
class BackReferenceReadNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_back_reference_read_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> BackReferenceReadNode
def copy(**params)
BackReferenceReadNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:back_reference_read_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:back_reference_read_node
end
end
# Represents a begin statement.
#
# begin
# foo
# end
# ^^^^^
class BeginNode < Node
# attr_reader begin_keyword_loc: Location?
attr_reader :begin_keyword_loc
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader rescue_clause: RescueNode?
attr_reader :rescue_clause
# attr_reader else_clause: ElseNode?
attr_reader :else_clause
# attr_reader ensure_clause: EnsureNode?
attr_reader :ensure_clause
# attr_reader end_keyword_loc: Location?
attr_reader :end_keyword_loc
# def initialize: (begin_keyword_loc: Location?, statements: StatementsNode?, rescue_clause: RescueNode?, else_clause: ElseNode?, ensure_clause: EnsureNode?, end_keyword_loc: Location?, location: Location) -> void
def initialize(begin_keyword_loc, statements, rescue_clause, else_clause, ensure_clause, end_keyword_loc, location)
@begin_keyword_loc = begin_keyword_loc
@statements = statements
@rescue_clause = rescue_clause
@else_clause = else_clause
@ensure_clause = ensure_clause
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_begin_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
# Never mark BeginNode with a newline flag, mark children instead
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[statements, rescue_clause, else_clause, ensure_clause]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << statements if statements
compact << rescue_clause if rescue_clause
compact << else_clause if else_clause
compact << ensure_clause if ensure_clause
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*begin_keyword_loc, *statements, *rescue_clause, *else_clause, *ensure_clause, *end_keyword_loc]
end
# def copy: (**params) -> BeginNode
def copy(**params)
BeginNode.new(
params.fetch(:begin_keyword_loc) { begin_keyword_loc },
params.fetch(:statements) { statements },
params.fetch(:rescue_clause) { rescue_clause },
params.fetch(:else_clause) { else_clause },
params.fetch(:ensure_clause) { ensure_clause },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ begin_keyword_loc: begin_keyword_loc, statements: statements, rescue_clause: rescue_clause, else_clause: else_clause, ensure_clause: ensure_clause, end_keyword_loc: end_keyword_loc, location: location }
end
# def begin_keyword: () -> String?
def begin_keyword
begin_keyword_loc&.slice
end
# def end_keyword: () -> String?
def end_keyword
end_keyword_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── begin_keyword_loc: #{inspector.location(begin_keyword_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (rescue_clause = self.rescue_clause).nil?
inspector << "├── rescue_clause: ∅\n"
else
inspector << "├── rescue_clause:\n"
inspector << rescue_clause.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (else_clause = self.else_clause).nil?
inspector << "├── else_clause: ∅\n"
else
inspector << "├── else_clause:\n"
inspector << else_clause.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (ensure_clause = self.ensure_clause).nil?
inspector << "├── ensure_clause: ∅\n"
else
inspector << "├── ensure_clause:\n"
inspector << ensure_clause.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:begin_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:begin_node
end
end
# Represents block method arguments.
#
# bar(&args)
# ^^^^^^^^^^
class BlockArgumentNode < Node
# attr_reader expression: Node?
attr_reader :expression
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (expression: Node?, operator_loc: Location, location: Location) -> void
def initialize(expression, operator_loc, location)
@expression = expression
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_block_argument_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[expression]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << expression if expression
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*expression, operator_loc]
end
# def copy: (**params) -> BlockArgumentNode
def copy(**params)
BlockArgumentNode.new(
params.fetch(:expression) { expression },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ expression: expression, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (expression = self.expression).nil?
inspector << "├── expression: ∅\n"
else
inspector << "├── expression:\n"
inspector << expression.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:block_argument_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:block_argument_node
end
end
# Represents a block local variable.
#
# a { |; b| }
# ^
class BlockLocalVariableNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_block_local_variable_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> BlockLocalVariableNode
def copy(**params)
BlockLocalVariableNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:block_local_variable_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:block_local_variable_node
end
end
# Represents a block of ruby code.
#
# [1, 2, 3].each { |i| puts x }
# ^^^^^^^^^^^^^^
class BlockNode < Node
# attr_reader locals: Array[Symbol]
attr_reader :locals
# attr_reader locals_body_index: Integer
attr_reader :locals_body_index
# attr_reader parameters: Node?
attr_reader :parameters
# attr_reader body: Node?
attr_reader :body
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (locals: Array[Symbol], locals_body_index: Integer, parameters: Node?, body: Node?, opening_loc: Location, closing_loc: Location, location: Location) -> void
def initialize(locals, locals_body_index, parameters, body, opening_loc, closing_loc, location)
@locals = locals
@locals_body_index = locals_body_index
@parameters = parameters
@body = body
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_block_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[parameters, body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << parameters if parameters
compact << body if body
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*parameters, *body, opening_loc, closing_loc]
end
# def copy: (**params) -> BlockNode
def copy(**params)
BlockNode.new(
params.fetch(:locals) { locals },
params.fetch(:locals_body_index) { locals_body_index },
params.fetch(:parameters) { parameters },
params.fetch(:body) { body },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ locals: locals, locals_body_index: locals_body_index, parameters: parameters, body: body, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── locals_body_index: #{locals_body_index.inspect}\n"
if (parameters = self.parameters).nil?
inspector << "├── parameters: ∅\n"
else
inspector << "├── parameters:\n"
inspector << parameters.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:block_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:block_node
end
end
# Represents a block parameter to a method, block, or lambda definition.
#
# def a(&b)
# ^^
# end
class BlockParameterNode < Node
# attr_reader name: Symbol?
attr_reader :name
# attr_reader name_loc: Location?
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (name: Symbol?, name_loc: Location?, operator_loc: Location, location: Location) -> void
def initialize(name, name_loc, operator_loc, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_block_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*name_loc, operator_loc]
end
# def copy: (**params) -> BlockParameterNode
def copy(**params)
BlockParameterNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (name = self.name).nil?
inspector << "├── name: ∅\n"
else
inspector << "├── name: #{name.inspect}\n"
end
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:block_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:block_parameter_node
end
end
# Represents a block's parameters declaration.
#
# -> (a, b = 1; local) { }
# ^^^^^^^^^^^^^^^^^
#
# foo do |a, b = 1; local|
# ^^^^^^^^^^^^^^^^^
# end
class BlockParametersNode < Node
# attr_reader parameters: ParametersNode?
attr_reader :parameters
# attr_reader locals: Array[Node]
attr_reader :locals
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# def initialize: (parameters: ParametersNode?, locals: Array[Node], opening_loc: Location?, closing_loc: Location?, location: Location) -> void
def initialize(parameters, locals, opening_loc, closing_loc, location)
@parameters = parameters
@locals = locals
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_block_parameters_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[parameters, *locals]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << parameters if parameters
compact.concat(locals)
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*parameters, *locals, *opening_loc, *closing_loc]
end
# def copy: (**params) -> BlockParametersNode
def copy(**params)
BlockParametersNode.new(
params.fetch(:parameters) { parameters },
params.fetch(:locals) { locals },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ parameters: parameters, locals: locals, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (parameters = self.parameters).nil?
inspector << "├── parameters: ∅\n"
else
inspector << "├── parameters:\n"
inspector << parameters.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── locals: #{inspector.list("#{inspector.prefix}│ ", locals)}"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:block_parameters_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:block_parameters_node
end
end
# Represents the use of the `break` keyword.
#
# break foo
# ^^^^^^^^^
class BreakNode < Node
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# def initialize: (arguments: ArgumentsNode?, keyword_loc: Location, location: Location) -> void
def initialize(arguments, keyword_loc, location)
@arguments = arguments
@keyword_loc = keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_break_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[arguments]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << arguments if arguments
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*arguments, keyword_loc]
end
# def copy: (**params) -> BreakNode
def copy(**params)
BreakNode.new(
params.fetch(:arguments) { arguments },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ arguments: arguments, keyword_loc: keyword_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:break_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:break_node
end
end
# Represents the use of the `&&=` operator on a call.
#
# foo.bar &&= value
# ^^^^^^^^^^^^^^^^^
class CallAndWriteNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader call_operator_loc: Location?
attr_reader :call_operator_loc
# attr_reader message_loc: Location?
attr_reader :message_loc
# attr_reader read_name: Symbol
attr_reader :read_name
# attr_reader write_name: Symbol
attr_reader :write_name
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator_loc: Location, value: Node, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@message_loc = message_loc
@read_name = read_name
@write_name = write_name
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_call_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*receiver, *call_operator_loc, *message_loc, operator_loc, value]
end
# def copy: (**params) -> CallAndWriteNode
def copy(**params)
CallAndWriteNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:message_loc) { message_loc },
params.fetch(:read_name) { read_name },
params.fetch(:write_name) { write_name },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, message_loc: message_loc, read_name: read_name, write_name: write_name, operator_loc: operator_loc, value: value, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String?
def call_operator
call_operator_loc&.slice
end
# def message: () -> String?
def message
message_loc&.slice
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── message_loc: #{inspector.location(message_loc)}\n"
inspector << "├── read_name: #{read_name.inspect}\n"
inspector << "├── write_name: #{write_name.inspect}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:call_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:call_and_write_node
end
end
# Represents a method call, in all of the various forms that can take.
#
# foo
# ^^^
#
# foo()
# ^^^^^
#
# +foo
# ^^^^
#
# foo + bar
# ^^^^^^^^^
#
# foo.bar
# ^^^^^^^
#
# foo&.bar
# ^^^^^^^^
class CallNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader call_operator_loc: Location?
attr_reader :call_operator_loc
# attr_reader name: Symbol
attr_reader :name
# attr_reader message_loc: Location?
attr_reader :message_loc
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# attr_reader block: Node?
attr_reader :block
# def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, name: Symbol, message_loc: Location?, opening_loc: Location?, arguments: ArgumentsNode?, closing_loc: Location?, block: Node?, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, name, message_loc, opening_loc, arguments, closing_loc, block, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@name = name
@message_loc = message_loc
@opening_loc = opening_loc
@arguments = arguments
@closing_loc = closing_loc
@block = block
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_call_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, arguments, block]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << arguments if arguments
compact << block if block
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*receiver, *call_operator_loc, *message_loc, *opening_loc, *arguments, *closing_loc, *block]
end
# def copy: (**params) -> CallNode
def copy(**params)
CallNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:name) { name },
params.fetch(:message_loc) { message_loc },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:arguments) { arguments },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:block) { block },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, name: name, message_loc: message_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String?
def call_operator
call_operator_loc&.slice
end
# def message: () -> String?
def message
message_loc&.slice
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── name: #{name.inspect}\n"
inspector << "├── message_loc: #{inspector.location(message_loc)}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
if (block = self.block).nil?
inspector << "└── block: ∅\n"
else
inspector << "└── block:\n"
inspector << block.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:call_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:call_node
end
end
# Represents the use of an assignment operator on a call.
#
# foo.bar += baz
# ^^^^^^^^^^^^^^
class CallOperatorWriteNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader call_operator_loc: Location?
attr_reader :call_operator_loc
# attr_reader message_loc: Location?
attr_reader :message_loc
# attr_reader read_name: Symbol
attr_reader :read_name
# attr_reader write_name: Symbol
attr_reader :write_name
# attr_reader operator: Symbol
attr_reader :operator
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator: Symbol, operator_loc: Location, value: Node, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator, operator_loc, value, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@message_loc = message_loc
@read_name = read_name
@write_name = write_name
@operator = operator
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_call_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*receiver, *call_operator_loc, *message_loc, operator_loc, value]
end
# def copy: (**params) -> CallOperatorWriteNode
def copy(**params)
CallOperatorWriteNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:message_loc) { message_loc },
params.fetch(:read_name) { read_name },
params.fetch(:write_name) { write_name },
params.fetch(:operator) { operator },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, message_loc: message_loc, read_name: read_name, write_name: write_name, operator: operator, operator_loc: operator_loc, value: value, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String?
def call_operator
call_operator_loc&.slice
end
# def message: () -> String?
def message
message_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── message_loc: #{inspector.location(message_loc)}\n"
inspector << "├── read_name: #{read_name.inspect}\n"
inspector << "├── write_name: #{write_name.inspect}\n"
inspector << "├── operator: #{operator.inspect}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:call_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:call_operator_write_node
end
end
# Represents the use of the `||=` operator on a call.
#
# foo.bar ||= value
# ^^^^^^^^^^^^^^^^^
class CallOrWriteNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader call_operator_loc: Location?
attr_reader :call_operator_loc
# attr_reader message_loc: Location?
attr_reader :message_loc
# attr_reader read_name: Symbol
attr_reader :read_name
# attr_reader write_name: Symbol
attr_reader :write_name
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, message_loc: Location?, read_name: Symbol, write_name: Symbol, operator_loc: Location, value: Node, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, message_loc, read_name, write_name, operator_loc, value, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@message_loc = message_loc
@read_name = read_name
@write_name = write_name
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_call_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*receiver, *call_operator_loc, *message_loc, operator_loc, value]
end
# def copy: (**params) -> CallOrWriteNode
def copy(**params)
CallOrWriteNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:message_loc) { message_loc },
params.fetch(:read_name) { read_name },
params.fetch(:write_name) { write_name },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, message_loc: message_loc, read_name: read_name, write_name: write_name, operator_loc: operator_loc, value: value, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String?
def call_operator
call_operator_loc&.slice
end
# def message: () -> String?
def message
message_loc&.slice
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── message_loc: #{inspector.location(message_loc)}\n"
inspector << "├── read_name: #{read_name.inspect}\n"
inspector << "├── write_name: #{write_name.inspect}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:call_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:call_or_write_node
end
end
# Represents assigning to a method call.
#
# foo.bar, = 1
# ^^^^^^^
#
# begin
# rescue => foo.bar
# ^^^^^^^
# end
#
# for foo.bar in baz do end
# ^^^^^^^
class CallTargetNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node
attr_reader :receiver
# attr_reader call_operator_loc: Location
attr_reader :call_operator_loc
# attr_reader name: Symbol
attr_reader :name
# attr_reader message_loc: Location
attr_reader :message_loc
# def initialize: (flags: Integer, receiver: Node, call_operator_loc: Location, name: Symbol, message_loc: Location, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, name, message_loc, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@name = name
@message_loc = message_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_call_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[receiver]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[receiver, call_operator_loc, message_loc]
end
# def copy: (**params) -> CallTargetNode
def copy(**params)
CallTargetNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:name) { name },
params.fetch(:message_loc) { message_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, name: name, message_loc: message_loc, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String
def call_operator
call_operator_loc.slice
end
# def message: () -> String
def message
message_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── receiver:\n"
inspector << inspector.child_node(receiver, "│ ")
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── name: #{name.inspect}\n"
inspector << "└── message_loc: #{inspector.location(message_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:call_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:call_target_node
end
end
# Represents assigning to a local variable in pattern matching.
#
# foo => [bar => baz]
# ^^^^^^^^^^^^
class CapturePatternNode < Node
# attr_reader value: Node
attr_reader :value
# attr_reader target: Node
attr_reader :target
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (value: Node, target: Node, operator_loc: Location, location: Location) -> void
def initialize(value, target, operator_loc, location)
@value = value
@target = target
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_capture_pattern_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value, target]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value, target]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[value, target, operator_loc]
end
# def copy: (**params) -> CapturePatternNode
def copy(**params)
CapturePatternNode.new(
params.fetch(:value) { value },
params.fetch(:target) { target },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ value: value, target: target, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "├── target:\n"
inspector << inspector.child_node(target, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:capture_pattern_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:capture_pattern_node
end
end
# Represents the use of a case statement for pattern matching.
#
# case true
# in false
# end
# ^^^^^^^^^
class CaseMatchNode < Node
# attr_reader predicate: Node?
attr_reader :predicate
# attr_reader conditions: Array[Node]
attr_reader :conditions
# attr_reader consequent: ElseNode?
attr_reader :consequent
# attr_reader case_keyword_loc: Location
attr_reader :case_keyword_loc
# attr_reader end_keyword_loc: Location
attr_reader :end_keyword_loc
# def initialize: (predicate: Node?, conditions: Array[Node], consequent: ElseNode?, case_keyword_loc: Location, end_keyword_loc: Location, location: Location) -> void
def initialize(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location)
@predicate = predicate
@conditions = conditions
@consequent = consequent
@case_keyword_loc = case_keyword_loc
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_case_match_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[predicate, *conditions, consequent]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << predicate if predicate
compact.concat(conditions)
compact << consequent if consequent
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*predicate, *conditions, *consequent, case_keyword_loc, end_keyword_loc]
end
# def copy: (**params) -> CaseMatchNode
def copy(**params)
CaseMatchNode.new(
params.fetch(:predicate) { predicate },
params.fetch(:conditions) { conditions },
params.fetch(:consequent) { consequent },
params.fetch(:case_keyword_loc) { case_keyword_loc },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ predicate: predicate, conditions: conditions, consequent: consequent, case_keyword_loc: case_keyword_loc, end_keyword_loc: end_keyword_loc, location: location }
end
# def case_keyword: () -> String
def case_keyword
case_keyword_loc.slice
end
# def end_keyword: () -> String
def end_keyword
end_keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (predicate = self.predicate).nil?
inspector << "├── predicate: ∅\n"
else
inspector << "├── predicate:\n"
inspector << predicate.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── conditions: #{inspector.list("#{inspector.prefix}│ ", conditions)}"
if (consequent = self.consequent).nil?
inspector << "├── consequent: ∅\n"
else
inspector << "├── consequent:\n"
inspector << consequent.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── case_keyword_loc: #{inspector.location(case_keyword_loc)}\n"
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:case_match_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:case_match_node
end
end
# Represents the use of a case statement.
#
# case true
# when false
# end
# ^^^^^^^^^^
class CaseNode < Node
# attr_reader predicate: Node?
attr_reader :predicate
# attr_reader conditions: Array[Node]
attr_reader :conditions
# attr_reader consequent: ElseNode?
attr_reader :consequent
# attr_reader case_keyword_loc: Location
attr_reader :case_keyword_loc
# attr_reader end_keyword_loc: Location
attr_reader :end_keyword_loc
# def initialize: (predicate: Node?, conditions: Array[Node], consequent: ElseNode?, case_keyword_loc: Location, end_keyword_loc: Location, location: Location) -> void
def initialize(predicate, conditions, consequent, case_keyword_loc, end_keyword_loc, location)
@predicate = predicate
@conditions = conditions
@consequent = consequent
@case_keyword_loc = case_keyword_loc
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_case_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[predicate, *conditions, consequent]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << predicate if predicate
compact.concat(conditions)
compact << consequent if consequent
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*predicate, *conditions, *consequent, case_keyword_loc, end_keyword_loc]
end
# def copy: (**params) -> CaseNode
def copy(**params)
CaseNode.new(
params.fetch(:predicate) { predicate },
params.fetch(:conditions) { conditions },
params.fetch(:consequent) { consequent },
params.fetch(:case_keyword_loc) { case_keyword_loc },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ predicate: predicate, conditions: conditions, consequent: consequent, case_keyword_loc: case_keyword_loc, end_keyword_loc: end_keyword_loc, location: location }
end
# def case_keyword: () -> String
def case_keyword
case_keyword_loc.slice
end
# def end_keyword: () -> String
def end_keyword
end_keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (predicate = self.predicate).nil?
inspector << "├── predicate: ∅\n"
else
inspector << "├── predicate:\n"
inspector << predicate.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── conditions: #{inspector.list("#{inspector.prefix}│ ", conditions)}"
if (consequent = self.consequent).nil?
inspector << "├── consequent: ∅\n"
else
inspector << "├── consequent:\n"
inspector << consequent.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── case_keyword_loc: #{inspector.location(case_keyword_loc)}\n"
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:case_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:case_node
end
end
# Represents a class declaration involving the `class` keyword.
#
# class Foo end
# ^^^^^^^^^^^^^
class ClassNode < Node
# attr_reader locals: Array[Symbol]
attr_reader :locals
# attr_reader class_keyword_loc: Location
attr_reader :class_keyword_loc
# attr_reader constant_path: Node
attr_reader :constant_path
# attr_reader inheritance_operator_loc: Location?
attr_reader :inheritance_operator_loc
# attr_reader superclass: Node?
attr_reader :superclass
# attr_reader body: Node?
attr_reader :body
# attr_reader end_keyword_loc: Location
attr_reader :end_keyword_loc
# attr_reader name: Symbol
attr_reader :name
# def initialize: (locals: Array[Symbol], class_keyword_loc: Location, constant_path: Node, inheritance_operator_loc: Location?, superclass: Node?, body: Node?, end_keyword_loc: Location, name: Symbol, location: Location) -> void
def initialize(locals, class_keyword_loc, constant_path, inheritance_operator_loc, superclass, body, end_keyword_loc, name, location)
@locals = locals
@class_keyword_loc = class_keyword_loc
@constant_path = constant_path
@inheritance_operator_loc = inheritance_operator_loc
@superclass = superclass
@body = body
@end_keyword_loc = end_keyword_loc
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_class_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[constant_path, superclass, body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << constant_path
compact << superclass if superclass
compact << body if body
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[class_keyword_loc, constant_path, *inheritance_operator_loc, *superclass, *body, end_keyword_loc]
end
# def copy: (**params) -> ClassNode
def copy(**params)
ClassNode.new(
params.fetch(:locals) { locals },
params.fetch(:class_keyword_loc) { class_keyword_loc },
params.fetch(:constant_path) { constant_path },
params.fetch(:inheritance_operator_loc) { inheritance_operator_loc },
params.fetch(:superclass) { superclass },
params.fetch(:body) { body },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ locals: locals, class_keyword_loc: class_keyword_loc, constant_path: constant_path, inheritance_operator_loc: inheritance_operator_loc, superclass: superclass, body: body, end_keyword_loc: end_keyword_loc, name: name, location: location }
end
# def class_keyword: () -> String
def class_keyword
class_keyword_loc.slice
end
# def inheritance_operator: () -> String?
def inheritance_operator
inheritance_operator_loc&.slice
end
# def end_keyword: () -> String
def end_keyword
end_keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── class_keyword_loc: #{inspector.location(class_keyword_loc)}\n"
inspector << "├── constant_path:\n"
inspector << inspector.child_node(constant_path, "│ ")
inspector << "├── inheritance_operator_loc: #{inspector.location(inheritance_operator_loc)}\n"
if (superclass = self.superclass).nil?
inspector << "├── superclass: ∅\n"
else
inspector << "├── superclass:\n"
inspector << superclass.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:class_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:class_node
end
end
# Represents the use of the `&&=` operator for assignment to a class variable.
#
# @@target &&= value
# ^^^^^^^^^^^^^^^^^^
class ClassVariableAndWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_class_variable_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> ClassVariableAndWriteNode
def copy(**params)
ClassVariableAndWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:class_variable_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:class_variable_and_write_node
end
end
# Represents assigning to a class variable using an operator that isn't `=`.
#
# @@target += value
# ^^^^^^^^^^^^^^^^^
class ClassVariableOperatorWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator: Symbol
attr_reader :operator
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, operator: Symbol, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, operator, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@operator = operator
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_class_variable_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> ClassVariableOperatorWriteNode
def copy(**params)
ClassVariableOperatorWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:operator) { operator },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, operator: operator, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator: #{operator.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:class_variable_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:class_variable_operator_write_node
end
end
# Represents the use of the `||=` operator for assignment to a class variable.
#
# @@target ||= value
# ^^^^^^^^^^^^^^^^^^
class ClassVariableOrWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_class_variable_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> ClassVariableOrWriteNode
def copy(**params)
ClassVariableOrWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:class_variable_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:class_variable_or_write_node
end
end
# Represents referencing a class variable.
#
# @@foo
# ^^^^^
class ClassVariableReadNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_class_variable_read_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> ClassVariableReadNode
def copy(**params)
ClassVariableReadNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:class_variable_read_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:class_variable_read_node
end
end
# Represents writing to a class variable in a context that doesn't have an explicit value.
#
# @@foo, @@bar = baz
# ^^^^^ ^^^^^
class ClassVariableTargetNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_class_variable_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> ClassVariableTargetNode
def copy(**params)
ClassVariableTargetNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:class_variable_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:class_variable_target_node
end
end
# Represents writing to a class variable.
#
# @@foo = 1
# ^^^^^^^^^
class ClassVariableWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator_loc: Location?
attr_reader :operator_loc
# def initialize: (name: Symbol, name_loc: Location, value: Node, operator_loc: Location?, location: Location) -> void
def initialize(name, name_loc, value, operator_loc, location)
@name = name
@name_loc = name_loc
@value = value
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_class_variable_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, value, *operator_loc]
end
# def copy: (**params) -> ClassVariableWriteNode
def copy(**params)
ClassVariableWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:value) { value },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, value: value, operator_loc: operator_loc, location: location }
end
# def operator: () -> String?
def operator
operator_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:class_variable_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:class_variable_write_node
end
end
# Represents the use of the `&&=` operator for assignment to a constant.
#
# Target &&= value
# ^^^^^^^^^^^^^^^^
class ConstantAndWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> ConstantAndWriteNode
def copy(**params)
ConstantAndWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_and_write_node
end
end
# Represents assigning to a constant using an operator that isn't `=`.
#
# Target += value
# ^^^^^^^^^^^^^^^
class ConstantOperatorWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator: Symbol
attr_reader :operator
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, operator: Symbol, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, operator, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@operator = operator
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> ConstantOperatorWriteNode
def copy(**params)
ConstantOperatorWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:operator) { operator },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, operator: operator, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator: #{operator.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_operator_write_node
end
end
# Represents the use of the `||=` operator for assignment to a constant.
#
# Target ||= value
# ^^^^^^^^^^^^^^^^
class ConstantOrWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> ConstantOrWriteNode
def copy(**params)
ConstantOrWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_or_write_node
end
end
# Represents the use of the `&&=` operator for assignment to a constant path.
#
# Parent::Child &&= value
# ^^^^^^^^^^^^^^^^^^^^^^^
class ConstantPathAndWriteNode < Node
# attr_reader target: ConstantPathNode
attr_reader :target
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (target: ConstantPathNode, operator_loc: Location, value: Node, location: Location) -> void
def initialize(target, operator_loc, value, location)
@target = target
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_path_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[target, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[target, value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[target, operator_loc, value]
end
# def copy: (**params) -> ConstantPathAndWriteNode
def copy(**params)
ConstantPathAndWriteNode.new(
params.fetch(:target) { target },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ target: target, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── target:\n"
inspector << inspector.child_node(target, "│ ")
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_path_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_path_and_write_node
end
end
# Represents accessing a constant through a path of `::` operators.
#
# Foo::Bar
# ^^^^^^^^
class ConstantPathNode < Node
# attr_reader parent: Node?
attr_reader :parent
# attr_reader child: Node
attr_reader :child
# attr_reader delimiter_loc: Location
attr_reader :delimiter_loc
# def initialize: (parent: Node?, child: Node, delimiter_loc: Location, location: Location) -> void
def initialize(parent, child, delimiter_loc, location)
@parent = parent
@child = child
@delimiter_loc = delimiter_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_path_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[parent, child]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << parent if parent
compact << child
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*parent, child, delimiter_loc]
end
# def copy: (**params) -> ConstantPathNode
def copy(**params)
ConstantPathNode.new(
params.fetch(:parent) { parent },
params.fetch(:child) { child },
params.fetch(:delimiter_loc) { delimiter_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ parent: parent, child: child, delimiter_loc: delimiter_loc, location: location }
end
# def delimiter: () -> String
def delimiter
delimiter_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (parent = self.parent).nil?
inspector << "├── parent: ∅\n"
else
inspector << "├── parent:\n"
inspector << parent.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── child:\n"
inspector << inspector.child_node(child, "│ ")
inspector << "└── delimiter_loc: #{inspector.location(delimiter_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_path_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_path_node
end
end
# Represents assigning to a constant path using an operator that isn't `=`.
#
# Parent::Child += value
# ^^^^^^^^^^^^^^^^^^^^^^
class ConstantPathOperatorWriteNode < Node
# attr_reader target: ConstantPathNode
attr_reader :target
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator: Symbol
attr_reader :operator
# def initialize: (target: ConstantPathNode, operator_loc: Location, value: Node, operator: Symbol, location: Location) -> void
def initialize(target, operator_loc, value, operator, location)
@target = target
@operator_loc = operator_loc
@value = value
@operator = operator
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_path_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[target, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[target, value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[target, operator_loc, value]
end
# def copy: (**params) -> ConstantPathOperatorWriteNode
def copy(**params)
ConstantPathOperatorWriteNode.new(
params.fetch(:target) { target },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:operator) { operator },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ target: target, operator_loc: operator_loc, value: value, operator: operator, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── target:\n"
inspector << inspector.child_node(target, "│ ")
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator: #{operator.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_path_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_path_operator_write_node
end
end
# Represents the use of the `||=` operator for assignment to a constant path.
#
# Parent::Child ||= value
# ^^^^^^^^^^^^^^^^^^^^^^^
class ConstantPathOrWriteNode < Node
# attr_reader target: ConstantPathNode
attr_reader :target
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (target: ConstantPathNode, operator_loc: Location, value: Node, location: Location) -> void
def initialize(target, operator_loc, value, location)
@target = target
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_path_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[target, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[target, value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[target, operator_loc, value]
end
# def copy: (**params) -> ConstantPathOrWriteNode
def copy(**params)
ConstantPathOrWriteNode.new(
params.fetch(:target) { target },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ target: target, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── target:\n"
inspector << inspector.child_node(target, "│ ")
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_path_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_path_or_write_node
end
end
# Represents writing to a constant path in a context that doesn't have an explicit value.
#
# Foo::Foo, Bar::Bar = baz
# ^^^^^^^^ ^^^^^^^^
class ConstantPathTargetNode < Node
# attr_reader parent: Node?
attr_reader :parent
# attr_reader child: Node
attr_reader :child
# attr_reader delimiter_loc: Location
attr_reader :delimiter_loc
# def initialize: (parent: Node?, child: Node, delimiter_loc: Location, location: Location) -> void
def initialize(parent, child, delimiter_loc, location)
@parent = parent
@child = child
@delimiter_loc = delimiter_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_path_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[parent, child]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << parent if parent
compact << child
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*parent, child, delimiter_loc]
end
# def copy: (**params) -> ConstantPathTargetNode
def copy(**params)
ConstantPathTargetNode.new(
params.fetch(:parent) { parent },
params.fetch(:child) { child },
params.fetch(:delimiter_loc) { delimiter_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ parent: parent, child: child, delimiter_loc: delimiter_loc, location: location }
end
# def delimiter: () -> String
def delimiter
delimiter_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (parent = self.parent).nil?
inspector << "├── parent: ∅\n"
else
inspector << "├── parent:\n"
inspector << parent.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── child:\n"
inspector << inspector.child_node(child, "│ ")
inspector << "└── delimiter_loc: #{inspector.location(delimiter_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_path_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_path_target_node
end
end
# Represents writing to a constant path.
#
# ::Foo = 1
# ^^^^^^^^^
#
# Foo::Bar = 1
# ^^^^^^^^^^^^
#
# ::Foo::Bar = 1
# ^^^^^^^^^^^^^^
class ConstantPathWriteNode < Node
# attr_reader target: ConstantPathNode
attr_reader :target
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (target: ConstantPathNode, operator_loc: Location, value: Node, location: Location) -> void
def initialize(target, operator_loc, value, location)
@target = target
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_path_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[target, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[target, value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[target, operator_loc, value]
end
# def copy: (**params) -> ConstantPathWriteNode
def copy(**params)
ConstantPathWriteNode.new(
params.fetch(:target) { target },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ target: target, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── target:\n"
inspector << inspector.child_node(target, "│ ")
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_path_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_path_write_node
end
end
# Represents referencing a constant.
#
# Foo
# ^^^
class ConstantReadNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_read_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> ConstantReadNode
def copy(**params)
ConstantReadNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_read_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_read_node
end
end
# Represents writing to a constant in a context that doesn't have an explicit value.
#
# Foo, Bar = baz
# ^^^ ^^^
class ConstantTargetNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> ConstantTargetNode
def copy(**params)
ConstantTargetNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_target_node
end
end
# Represents writing to a constant.
#
# Foo = 1
# ^^^^^^^
class ConstantWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (name: Symbol, name_loc: Location, value: Node, operator_loc: Location, location: Location) -> void
def initialize(name, name_loc, value, operator_loc, location)
@name = name
@name_loc = name_loc
@value = value
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_constant_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, value, operator_loc]
end
# def copy: (**params) -> ConstantWriteNode
def copy(**params)
ConstantWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:value) { value },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, value: value, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:constant_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:constant_write_node
end
end
# Represents a method definition.
#
# def method
# end
# ^^^^^^^^^^
class DefNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader parameters: ParametersNode?
attr_reader :parameters
# attr_reader body: Node?
attr_reader :body
# attr_reader locals: Array[Symbol]
attr_reader :locals
# attr_reader locals_body_index: Integer
attr_reader :locals_body_index
# attr_reader def_keyword_loc: Location
attr_reader :def_keyword_loc
# attr_reader operator_loc: Location?
attr_reader :operator_loc
# attr_reader lparen_loc: Location?
attr_reader :lparen_loc
# attr_reader rparen_loc: Location?
attr_reader :rparen_loc
# attr_reader equal_loc: Location?
attr_reader :equal_loc
# attr_reader end_keyword_loc: Location?
attr_reader :end_keyword_loc
# def initialize: (name: Symbol, name_loc: Location, receiver: Node?, parameters: ParametersNode?, body: Node?, locals: Array[Symbol], locals_body_index: Integer, def_keyword_loc: Location, operator_loc: Location?, lparen_loc: Location?, rparen_loc: Location?, equal_loc: Location?, end_keyword_loc: Location?, location: Location) -> void
def initialize(name, name_loc, receiver, parameters, body, locals, locals_body_index, def_keyword_loc, operator_loc, lparen_loc, rparen_loc, equal_loc, end_keyword_loc, location)
@name = name
@name_loc = name_loc
@receiver = receiver
@parameters = parameters
@body = body
@locals = locals
@locals_body_index = locals_body_index
@def_keyword_loc = def_keyword_loc
@operator_loc = operator_loc
@lparen_loc = lparen_loc
@rparen_loc = rparen_loc
@equal_loc = equal_loc
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_def_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, parameters, body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << parameters if parameters
compact << body if body
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, *receiver, *parameters, *body, def_keyword_loc, *operator_loc, *lparen_loc, *rparen_loc, *equal_loc, *end_keyword_loc]
end
# def copy: (**params) -> DefNode
def copy(**params)
DefNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:receiver) { receiver },
params.fetch(:parameters) { parameters },
params.fetch(:body) { body },
params.fetch(:locals) { locals },
params.fetch(:locals_body_index) { locals_body_index },
params.fetch(:def_keyword_loc) { def_keyword_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:lparen_loc) { lparen_loc },
params.fetch(:rparen_loc) { rparen_loc },
params.fetch(:equal_loc) { equal_loc },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, receiver: receiver, parameters: parameters, body: body, locals: locals, locals_body_index: locals_body_index, def_keyword_loc: def_keyword_loc, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc, equal_loc: equal_loc, end_keyword_loc: end_keyword_loc, location: location }
end
# def def_keyword: () -> String
def def_keyword
def_keyword_loc.slice
end
# def operator: () -> String?
def operator
operator_loc&.slice
end
# def lparen: () -> String?
def lparen
lparen_loc&.slice
end
# def rparen: () -> String?
def rparen
rparen_loc&.slice
end
# def equal: () -> String?
def equal
equal_loc&.slice
end
# def end_keyword: () -> String?
def end_keyword
end_keyword_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (parameters = self.parameters).nil?
inspector << "├── parameters: ∅\n"
else
inspector << "├── parameters:\n"
inspector << parameters.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── locals_body_index: #{locals_body_index.inspect}\n"
inspector << "├── def_keyword_loc: #{inspector.location(def_keyword_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
inspector << "├── equal_loc: #{inspector.location(equal_loc)}\n"
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:def_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:def_node
end
end
# Represents the use of the `defined?` keyword.
#
# defined?(a)
# ^^^^^^^^^^^
class DefinedNode < Node
# attr_reader lparen_loc: Location?
attr_reader :lparen_loc
# attr_reader value: Node
attr_reader :value
# attr_reader rparen_loc: Location?
attr_reader :rparen_loc
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# def initialize: (lparen_loc: Location?, value: Node, rparen_loc: Location?, keyword_loc: Location, location: Location) -> void
def initialize(lparen_loc, value, rparen_loc, keyword_loc, location)
@lparen_loc = lparen_loc
@value = value
@rparen_loc = rparen_loc
@keyword_loc = keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_defined_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*lparen_loc, value, *rparen_loc, keyword_loc]
end
# def copy: (**params) -> DefinedNode
def copy(**params)
DefinedNode.new(
params.fetch(:lparen_loc) { lparen_loc },
params.fetch(:value) { value },
params.fetch(:rparen_loc) { rparen_loc },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ lparen_loc: lparen_loc, value: value, rparen_loc: rparen_loc, keyword_loc: keyword_loc, location: location }
end
# def lparen: () -> String?
def lparen
lparen_loc&.slice
end
# def rparen: () -> String?
def rparen
rparen_loc&.slice
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:defined_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:defined_node
end
end
# Represents an `else` clause in a `case`, `if`, or `unless` statement.
#
# if a then b else c end
# ^^^^^^^^^^
class ElseNode < Node
# attr_reader else_keyword_loc: Location
attr_reader :else_keyword_loc
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader end_keyword_loc: Location?
attr_reader :end_keyword_loc
# def initialize: (else_keyword_loc: Location, statements: StatementsNode?, end_keyword_loc: Location?, location: Location) -> void
def initialize(else_keyword_loc, statements, end_keyword_loc, location)
@else_keyword_loc = else_keyword_loc
@statements = statements
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_else_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[else_keyword_loc, *statements, *end_keyword_loc]
end
# def copy: (**params) -> ElseNode
def copy(**params)
ElseNode.new(
params.fetch(:else_keyword_loc) { else_keyword_loc },
params.fetch(:statements) { statements },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ else_keyword_loc: else_keyword_loc, statements: statements, end_keyword_loc: end_keyword_loc, location: location }
end
# def else_keyword: () -> String
def else_keyword
else_keyword_loc.slice
end
# def end_keyword: () -> String?
def end_keyword
end_keyword_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── else_keyword_loc: #{inspector.location(else_keyword_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:else_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:else_node
end
end
# Represents an interpolated set of statements.
#
# "foo #{bar}"
# ^^^^^^
class EmbeddedStatementsNode < Node
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (opening_loc: Location, statements: StatementsNode?, closing_loc: Location, location: Location) -> void
def initialize(opening_loc, statements, closing_loc, location)
@opening_loc = opening_loc
@statements = statements
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_embedded_statements_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, *statements, closing_loc]
end
# def copy: (**params) -> EmbeddedStatementsNode
def copy(**params)
EmbeddedStatementsNode.new(
params.fetch(:opening_loc) { opening_loc },
params.fetch(:statements) { statements },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ opening_loc: opening_loc, statements: statements, closing_loc: closing_loc, location: location }
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:embedded_statements_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:embedded_statements_node
end
end
# Represents an interpolated variable.
#
# "foo #@bar"
# ^^^^^
class EmbeddedVariableNode < Node
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader variable: Node
attr_reader :variable
# def initialize: (operator_loc: Location, variable: Node, location: Location) -> void
def initialize(operator_loc, variable, location)
@operator_loc = operator_loc
@variable = variable
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_embedded_variable_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[variable]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[variable]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[operator_loc, variable]
end
# def copy: (**params) -> EmbeddedVariableNode
def copy(**params)
EmbeddedVariableNode.new(
params.fetch(:operator_loc) { operator_loc },
params.fetch(:variable) { variable },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ operator_loc: operator_loc, variable: variable, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── variable:\n"
inspector << inspector.child_node(variable, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:embedded_variable_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:embedded_variable_node
end
end
# Represents an `ensure` clause in a `begin` statement.
#
# begin
# foo
# ensure
# ^^^^^^
# bar
# end
class EnsureNode < Node
# attr_reader ensure_keyword_loc: Location
attr_reader :ensure_keyword_loc
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader end_keyword_loc: Location
attr_reader :end_keyword_loc
# def initialize: (ensure_keyword_loc: Location, statements: StatementsNode?, end_keyword_loc: Location, location: Location) -> void
def initialize(ensure_keyword_loc, statements, end_keyword_loc, location)
@ensure_keyword_loc = ensure_keyword_loc
@statements = statements
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_ensure_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[ensure_keyword_loc, *statements, end_keyword_loc]
end
# def copy: (**params) -> EnsureNode
def copy(**params)
EnsureNode.new(
params.fetch(:ensure_keyword_loc) { ensure_keyword_loc },
params.fetch(:statements) { statements },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ ensure_keyword_loc: ensure_keyword_loc, statements: statements, end_keyword_loc: end_keyword_loc, location: location }
end
# def ensure_keyword: () -> String
def ensure_keyword
ensure_keyword_loc.slice
end
# def end_keyword: () -> String
def end_keyword
end_keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── ensure_keyword_loc: #{inspector.location(ensure_keyword_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:ensure_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:ensure_node
end
end
# Represents the use of the literal `false` keyword.
#
# false
# ^^^^^
class FalseNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_false_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> FalseNode
def copy(**params)
FalseNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:false_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:false_node
end
end
# Represents a find pattern in pattern matching.
#
# foo in *bar, baz, *qux
# ^^^^^^^^^^^^^^^
#
# foo in [*bar, baz, *qux]
# ^^^^^^^^^^^^^^^^^
#
# foo in Foo(*bar, baz, *qux)
# ^^^^^^^^^^^^^^^^^^^^
class FindPatternNode < Node
# attr_reader constant: Node?
attr_reader :constant
# attr_reader left: Node
attr_reader :left
# attr_reader requireds: Array[Node]
attr_reader :requireds
# attr_reader right: Node
attr_reader :right
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# def initialize: (constant: Node?, left: Node, requireds: Array[Node], right: Node, opening_loc: Location?, closing_loc: Location?, location: Location) -> void
def initialize(constant, left, requireds, right, opening_loc, closing_loc, location)
@constant = constant
@left = left
@requireds = requireds
@right = right
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_find_pattern_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[constant, left, *requireds, right]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << constant if constant
compact << left
compact.concat(requireds)
compact << right
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*constant, left, *requireds, right, *opening_loc, *closing_loc]
end
# def copy: (**params) -> FindPatternNode
def copy(**params)
FindPatternNode.new(
params.fetch(:constant) { constant },
params.fetch(:left) { left },
params.fetch(:requireds) { requireds },
params.fetch(:right) { right },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ constant: constant, left: left, requireds: requireds, right: right, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (constant = self.constant).nil?
inspector << "├── constant: ∅\n"
else
inspector << "├── constant:\n"
inspector << constant.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── left:\n"
inspector << inspector.child_node(left, "│ ")
inspector << "├── requireds: #{inspector.list("#{inspector.prefix}│ ", requireds)}"
inspector << "├── right:\n"
inspector << inspector.child_node(right, "│ ")
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:find_pattern_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:find_pattern_node
end
end
# Represents the use of the `..` or `...` operators to create flip flops.
#
# baz if foo .. bar
# ^^^^^^^^^^
class FlipFlopNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader left: Node?
attr_reader :left
# attr_reader right: Node?
attr_reader :right
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (flags: Integer, left: Node?, right: Node?, operator_loc: Location, location: Location) -> void
def initialize(flags, left, right, operator_loc, location)
@flags = flags
@left = left
@right = right
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_flip_flop_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[left, right]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << left if left
compact << right if right
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*left, *right, operator_loc]
end
# def copy: (**params) -> FlipFlopNode
def copy(**params)
FlipFlopNode.new(
params.fetch(:flags) { flags },
params.fetch(:left) { left },
params.fetch(:right) { right },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, left: left, right: right, operator_loc: operator_loc, location: location }
end
# def exclude_end?: () -> bool
def exclude_end?
flags.anybits?(RangeFlags::EXCLUDE_END)
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("exclude_end" if exclude_end?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (left = self.left).nil?
inspector << "├── left: ∅\n"
else
inspector << "├── left:\n"
inspector << left.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (right = self.right).nil?
inspector << "├── right: ∅\n"
else
inspector << "├── right:\n"
inspector << right.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:flip_flop_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:flip_flop_node
end
end
# Represents a floating point number literal.
#
# 1.0
# ^^^
class FloatNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_float_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> FloatNode
def copy(**params)
FloatNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:float_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:float_node
end
end
# Represents the use of the `for` keyword.
#
# for i in a end
# ^^^^^^^^^^^^^^
class ForNode < Node
# attr_reader index: Node
attr_reader :index
# attr_reader collection: Node
attr_reader :collection
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader for_keyword_loc: Location
attr_reader :for_keyword_loc
# attr_reader in_keyword_loc: Location
attr_reader :in_keyword_loc
# attr_reader do_keyword_loc: Location?
attr_reader :do_keyword_loc
# attr_reader end_keyword_loc: Location
attr_reader :end_keyword_loc
# def initialize: (index: Node, collection: Node, statements: StatementsNode?, for_keyword_loc: Location, in_keyword_loc: Location, do_keyword_loc: Location?, end_keyword_loc: Location, location: Location) -> void
def initialize(index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location)
@index = index
@collection = collection
@statements = statements
@for_keyword_loc = for_keyword_loc
@in_keyword_loc = in_keyword_loc
@do_keyword_loc = do_keyword_loc
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_for_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[index, collection, statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << index
compact << collection
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[index, collection, *statements, for_keyword_loc, in_keyword_loc, *do_keyword_loc, end_keyword_loc]
end
# def copy: (**params) -> ForNode
def copy(**params)
ForNode.new(
params.fetch(:index) { index },
params.fetch(:collection) { collection },
params.fetch(:statements) { statements },
params.fetch(:for_keyword_loc) { for_keyword_loc },
params.fetch(:in_keyword_loc) { in_keyword_loc },
params.fetch(:do_keyword_loc) { do_keyword_loc },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ index: index, collection: collection, statements: statements, for_keyword_loc: for_keyword_loc, in_keyword_loc: in_keyword_loc, do_keyword_loc: do_keyword_loc, end_keyword_loc: end_keyword_loc, location: location }
end
# def for_keyword: () -> String
def for_keyword
for_keyword_loc.slice
end
# def in_keyword: () -> String
def in_keyword
in_keyword_loc.slice
end
# def do_keyword: () -> String?
def do_keyword
do_keyword_loc&.slice
end
# def end_keyword: () -> String
def end_keyword
end_keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── index:\n"
inspector << inspector.child_node(index, "│ ")
inspector << "├── collection:\n"
inspector << inspector.child_node(collection, "│ ")
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── for_keyword_loc: #{inspector.location(for_keyword_loc)}\n"
inspector << "├── in_keyword_loc: #{inspector.location(in_keyword_loc)}\n"
inspector << "├── do_keyword_loc: #{inspector.location(do_keyword_loc)}\n"
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:for_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:for_node
end
end
# Represents forwarding all arguments to this method to another method.
#
# def foo(...)
# bar(...)
# ^^^
# end
class ForwardingArgumentsNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_forwarding_arguments_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> ForwardingArgumentsNode
def copy(**params)
ForwardingArgumentsNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:forwarding_arguments_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:forwarding_arguments_node
end
end
# Represents the use of the forwarding parameter in a method, block, or lambda declaration.
#
# def foo(...)
# ^^^
# end
class ForwardingParameterNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_forwarding_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> ForwardingParameterNode
def copy(**params)
ForwardingParameterNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:forwarding_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:forwarding_parameter_node
end
end
# Represents the use of the `super` keyword without parentheses or arguments.
#
# super
# ^^^^^
class ForwardingSuperNode < Node
# attr_reader block: BlockNode?
attr_reader :block
# def initialize: (block: BlockNode?, location: Location) -> void
def initialize(block, location)
@block = block
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_forwarding_super_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[block]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << block if block
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*block]
end
# def copy: (**params) -> ForwardingSuperNode
def copy(**params)
ForwardingSuperNode.new(
params.fetch(:block) { block },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ block: block, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (block = self.block).nil?
inspector << "└── block: ∅\n"
else
inspector << "└── block:\n"
inspector << block.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:forwarding_super_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:forwarding_super_node
end
end
# Represents the use of the `&&=` operator for assignment to a global variable.
#
# $target &&= value
# ^^^^^^^^^^^^^^^^^
class GlobalVariableAndWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_global_variable_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> GlobalVariableAndWriteNode
def copy(**params)
GlobalVariableAndWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:global_variable_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:global_variable_and_write_node
end
end
# Represents assigning to a global variable using an operator that isn't `=`.
#
# $target += value
# ^^^^^^^^^^^^^^^^
class GlobalVariableOperatorWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator: Symbol
attr_reader :operator
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, operator: Symbol, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, operator, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@operator = operator
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_global_variable_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> GlobalVariableOperatorWriteNode
def copy(**params)
GlobalVariableOperatorWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:operator) { operator },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, operator: operator, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator: #{operator.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:global_variable_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:global_variable_operator_write_node
end
end
# Represents the use of the `||=` operator for assignment to a global variable.
#
# $target ||= value
# ^^^^^^^^^^^^^^^^^
class GlobalVariableOrWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_global_variable_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> GlobalVariableOrWriteNode
def copy(**params)
GlobalVariableOrWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:global_variable_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:global_variable_or_write_node
end
end
# Represents referencing a global variable.
#
# $foo
# ^^^^
class GlobalVariableReadNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_global_variable_read_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> GlobalVariableReadNode
def copy(**params)
GlobalVariableReadNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:global_variable_read_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:global_variable_read_node
end
end
# Represents writing to a global variable in a context that doesn't have an explicit value.
#
# $foo, $bar = baz
# ^^^^ ^^^^
class GlobalVariableTargetNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_global_variable_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> GlobalVariableTargetNode
def copy(**params)
GlobalVariableTargetNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:global_variable_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:global_variable_target_node
end
end
# Represents writing to a global variable.
#
# $foo = 1
# ^^^^^^^^
class GlobalVariableWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (name: Symbol, name_loc: Location, value: Node, operator_loc: Location, location: Location) -> void
def initialize(name, name_loc, value, operator_loc, location)
@name = name
@name_loc = name_loc
@value = value
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_global_variable_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, value, operator_loc]
end
# def copy: (**params) -> GlobalVariableWriteNode
def copy(**params)
GlobalVariableWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:value) { value },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, value: value, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:global_variable_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:global_variable_write_node
end
end
# Represents a hash literal.
#
# { a => b }
# ^^^^^^^^^^
class HashNode < Node
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader elements: Array[Node]
attr_reader :elements
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (opening_loc: Location, elements: Array[Node], closing_loc: Location, location: Location) -> void
def initialize(opening_loc, elements, closing_loc, location)
@opening_loc = opening_loc
@elements = elements
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_hash_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*elements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*elements]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, *elements, closing_loc]
end
# def copy: (**params) -> HashNode
def copy(**params)
HashNode.new(
params.fetch(:opening_loc) { opening_loc },
params.fetch(:elements) { elements },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ opening_loc: opening_loc, elements: elements, closing_loc: closing_loc, location: location }
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── elements: #{inspector.list("#{inspector.prefix}│ ", elements)}"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:hash_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:hash_node
end
end
# Represents a hash pattern in pattern matching.
#
# foo => { a: 1, b: 2 }
# ^^^^^^^^^^^^^^
#
# foo => { a: 1, b: 2, **c }
# ^^^^^^^^^^^^^^^^^^^
class HashPatternNode < Node
# attr_reader constant: Node?
attr_reader :constant
# attr_reader elements: Array[Node]
attr_reader :elements
# attr_reader rest: Node?
attr_reader :rest
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# def initialize: (constant: Node?, elements: Array[Node], rest: Node?, opening_loc: Location?, closing_loc: Location?, location: Location) -> void
def initialize(constant, elements, rest, opening_loc, closing_loc, location)
@constant = constant
@elements = elements
@rest = rest
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_hash_pattern_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[constant, *elements, rest]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << constant if constant
compact.concat(elements)
compact << rest if rest
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*constant, *elements, *rest, *opening_loc, *closing_loc]
end
# def copy: (**params) -> HashPatternNode
def copy(**params)
HashPatternNode.new(
params.fetch(:constant) { constant },
params.fetch(:elements) { elements },
params.fetch(:rest) { rest },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ constant: constant, elements: elements, rest: rest, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (constant = self.constant).nil?
inspector << "├── constant: ∅\n"
else
inspector << "├── constant:\n"
inspector << constant.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── elements: #{inspector.list("#{inspector.prefix}│ ", elements)}"
if (rest = self.rest).nil?
inspector << "├── rest: ∅\n"
else
inspector << "├── rest:\n"
inspector << rest.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:hash_pattern_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:hash_pattern_node
end
end
# Represents the use of the `if` keyword, either in the block form or the modifier form.
#
# bar if foo
# ^^^^^^^^^^
#
# if foo then bar end
# ^^^^^^^^^^^^^^^^^^^
class IfNode < Node
# attr_reader if_keyword_loc: Location?
attr_reader :if_keyword_loc
# attr_reader predicate: Node
attr_reader :predicate
# attr_reader then_keyword_loc: Location?
attr_reader :then_keyword_loc
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader consequent: Node?
attr_reader :consequent
# attr_reader end_keyword_loc: Location?
attr_reader :end_keyword_loc
# def initialize: (if_keyword_loc: Location?, predicate: Node, then_keyword_loc: Location?, statements: StatementsNode?, consequent: Node?, end_keyword_loc: Location?, location: Location) -> void
def initialize(if_keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
@if_keyword_loc = if_keyword_loc
@predicate = predicate
@then_keyword_loc = then_keyword_loc
@statements = statements
@consequent = consequent
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_if_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
predicate.set_newline_flag(newline_marked)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[predicate, statements, consequent]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << predicate
compact << statements if statements
compact << consequent if consequent
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*if_keyword_loc, predicate, *then_keyword_loc, *statements, *consequent, *end_keyword_loc]
end
# def copy: (**params) -> IfNode
def copy(**params)
IfNode.new(
params.fetch(:if_keyword_loc) { if_keyword_loc },
params.fetch(:predicate) { predicate },
params.fetch(:then_keyword_loc) { then_keyword_loc },
params.fetch(:statements) { statements },
params.fetch(:consequent) { consequent },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ if_keyword_loc: if_keyword_loc, predicate: predicate, then_keyword_loc: then_keyword_loc, statements: statements, consequent: consequent, end_keyword_loc: end_keyword_loc, location: location }
end
# def if_keyword: () -> String?
def if_keyword
if_keyword_loc&.slice
end
# def then_keyword: () -> String?
def then_keyword
then_keyword_loc&.slice
end
# def end_keyword: () -> String?
def end_keyword
end_keyword_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── if_keyword_loc: #{inspector.location(if_keyword_loc)}\n"
inspector << "├── predicate:\n"
inspector << inspector.child_node(predicate, "│ ")
inspector << "├── then_keyword_loc: #{inspector.location(then_keyword_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (consequent = self.consequent).nil?
inspector << "├── consequent: ∅\n"
else
inspector << "├── consequent:\n"
inspector << consequent.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:if_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:if_node
end
end
# Represents an imaginary number literal.
#
# 1.0i
# ^^^^
class ImaginaryNode < Node
# attr_reader numeric: Node
attr_reader :numeric
# def initialize: (numeric: Node, location: Location) -> void
def initialize(numeric, location)
@numeric = numeric
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_imaginary_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[numeric]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[numeric]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[numeric]
end
# def copy: (**params) -> ImaginaryNode
def copy(**params)
ImaginaryNode.new(
params.fetch(:numeric) { numeric },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ numeric: numeric, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── numeric:\n"
inspector << inspector.child_node(numeric, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:imaginary_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:imaginary_node
end
end
# Represents a node that is implicitly being added to the tree but doesn't
# correspond directly to a node in the source.
#
# { foo: }
# ^^^^
#
# { Foo: }
# ^^^^
class ImplicitNode < Node
# attr_reader value: Node
attr_reader :value
# def initialize: (value: Node, location: Location) -> void
def initialize(value, location)
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_implicit_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[value]
end
# def copy: (**params) -> ImplicitNode
def copy(**params)
ImplicitNode.new(
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ value: value, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:implicit_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:implicit_node
end
end
# Represents using a trailing comma to indicate an implicit rest parameter.
#
# foo { |bar,| }
# ^
#
# foo in [bar,]
# ^
#
# for foo, in bar do end
# ^
#
# foo, = bar
# ^
class ImplicitRestNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_implicit_rest_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> ImplicitRestNode
def copy(**params)
ImplicitRestNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:implicit_rest_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:implicit_rest_node
end
end
# Represents the use of the `in` keyword in a case statement.
#
# case a; in b then c end
# ^^^^^^^^^^^
class InNode < Node
# attr_reader pattern: Node
attr_reader :pattern
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader in_loc: Location
attr_reader :in_loc
# attr_reader then_loc: Location?
attr_reader :then_loc
# def initialize: (pattern: Node, statements: StatementsNode?, in_loc: Location, then_loc: Location?, location: Location) -> void
def initialize(pattern, statements, in_loc, then_loc, location)
@pattern = pattern
@statements = statements
@in_loc = in_loc
@then_loc = then_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_in_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[pattern, statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << pattern
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[pattern, *statements, in_loc, *then_loc]
end
# def copy: (**params) -> InNode
def copy(**params)
InNode.new(
params.fetch(:pattern) { pattern },
params.fetch(:statements) { statements },
params.fetch(:in_loc) { in_loc },
params.fetch(:then_loc) { then_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ pattern: pattern, statements: statements, in_loc: in_loc, then_loc: then_loc, location: location }
end
# def in: () -> String
def in
in_loc.slice
end
# def then: () -> String?
def then
then_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── pattern:\n"
inspector << inspector.child_node(pattern, "│ ")
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── in_loc: #{inspector.location(in_loc)}\n"
inspector << "└── then_loc: #{inspector.location(then_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:in_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:in_node
end
end
# Represents the use of the `&&=` operator on a call to the `[]` method.
#
# foo.bar[baz] &&= value
# ^^^^^^^^^^^^^^^^^^^^^^
class IndexAndWriteNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader call_operator_loc: Location?
attr_reader :call_operator_loc
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader block: Node?
attr_reader :block
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, opening_loc: Location, arguments: ArgumentsNode?, closing_loc: Location, block: Node?, operator_loc: Location, value: Node, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@opening_loc = opening_loc
@arguments = arguments
@closing_loc = closing_loc
@block = block
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_index_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, arguments, block, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << arguments if arguments
compact << block if block
compact << value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*receiver, *call_operator_loc, opening_loc, *arguments, closing_loc, *block, operator_loc, value]
end
# def copy: (**params) -> IndexAndWriteNode
def copy(**params)
IndexAndWriteNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:arguments) { arguments },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:block) { block },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, operator_loc: operator_loc, value: value, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String?
def call_operator
call_operator_loc&.slice
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
if (block = self.block).nil?
inspector << "├── block: ∅\n"
else
inspector << "├── block:\n"
inspector << block.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:index_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:index_and_write_node
end
end
# Represents the use of an assignment operator on a call to `[]`.
#
# foo.bar[baz] += value
# ^^^^^^^^^^^^^^^^^^^^^
class IndexOperatorWriteNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader call_operator_loc: Location?
attr_reader :call_operator_loc
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader block: Node?
attr_reader :block
# attr_reader operator: Symbol
attr_reader :operator
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, opening_loc: Location, arguments: ArgumentsNode?, closing_loc: Location, block: Node?, operator: Symbol, operator_loc: Location, value: Node, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator, operator_loc, value, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@opening_loc = opening_loc
@arguments = arguments
@closing_loc = closing_loc
@block = block
@operator = operator
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_index_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, arguments, block, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << arguments if arguments
compact << block if block
compact << value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*receiver, *call_operator_loc, opening_loc, *arguments, closing_loc, *block, operator_loc, value]
end
# def copy: (**params) -> IndexOperatorWriteNode
def copy(**params)
IndexOperatorWriteNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:arguments) { arguments },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:block) { block },
params.fetch(:operator) { operator },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, operator: operator, operator_loc: operator_loc, value: value, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String?
def call_operator
call_operator_loc&.slice
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
if (block = self.block).nil?
inspector << "├── block: ∅\n"
else
inspector << "├── block:\n"
inspector << block.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── operator: #{operator.inspect}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:index_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:index_operator_write_node
end
end
# Represents the use of the `||=` operator on a call to `[]`.
#
# foo.bar[baz] ||= value
# ^^^^^^^^^^^^^^^^^^^^^^
class IndexOrWriteNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node?
attr_reader :receiver
# attr_reader call_operator_loc: Location?
attr_reader :call_operator_loc
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader block: Node?
attr_reader :block
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (flags: Integer, receiver: Node?, call_operator_loc: Location?, opening_loc: Location, arguments: ArgumentsNode?, closing_loc: Location, block: Node?, operator_loc: Location, value: Node, location: Location) -> void
def initialize(flags, receiver, call_operator_loc, opening_loc, arguments, closing_loc, block, operator_loc, value, location)
@flags = flags
@receiver = receiver
@call_operator_loc = call_operator_loc
@opening_loc = opening_loc
@arguments = arguments
@closing_loc = closing_loc
@block = block
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_index_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, arguments, block, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver if receiver
compact << arguments if arguments
compact << block if block
compact << value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*receiver, *call_operator_loc, opening_loc, *arguments, closing_loc, *block, operator_loc, value]
end
# def copy: (**params) -> IndexOrWriteNode
def copy(**params)
IndexOrWriteNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:call_operator_loc) { call_operator_loc },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:arguments) { arguments },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:block) { block },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, call_operator_loc: call_operator_loc, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, operator_loc: operator_loc, value: value, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def call_operator: () -> String?
def call_operator
call_operator_loc&.slice
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (receiver = self.receiver).nil?
inspector << "├── receiver: ∅\n"
else
inspector << "├── receiver:\n"
inspector << receiver.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── call_operator_loc: #{inspector.location(call_operator_loc)}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
if (block = self.block).nil?
inspector << "├── block: ∅\n"
else
inspector << "├── block:\n"
inspector << block.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:index_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:index_or_write_node
end
end
# Represents assigning to an index.
#
# foo[bar], = 1
# ^^^^^^^^
#
# begin
# rescue => foo[bar]
# ^^^^^^^^
# end
#
# for foo[bar] in baz do end
# ^^^^^^^^
class IndexTargetNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader receiver: Node
attr_reader :receiver
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader block: Node?
attr_reader :block
# def initialize: (flags: Integer, receiver: Node, opening_loc: Location, arguments: ArgumentsNode?, closing_loc: Location, block: Node?, location: Location) -> void
def initialize(flags, receiver, opening_loc, arguments, closing_loc, block, location)
@flags = flags
@receiver = receiver
@opening_loc = opening_loc
@arguments = arguments
@closing_loc = closing_loc
@block = block
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_index_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[receiver, arguments, block]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << receiver
compact << arguments if arguments
compact << block if block
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[receiver, opening_loc, *arguments, closing_loc, *block]
end
# def copy: (**params) -> IndexTargetNode
def copy(**params)
IndexTargetNode.new(
params.fetch(:flags) { flags },
params.fetch(:receiver) { receiver },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:arguments) { arguments },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:block) { block },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, receiver: receiver, opening_loc: opening_loc, arguments: arguments, closing_loc: closing_loc, block: block, location: location }
end
# def safe_navigation?: () -> bool
def safe_navigation?
flags.anybits?(CallNodeFlags::SAFE_NAVIGATION)
end
# def variable_call?: () -> bool
def variable_call?
flags.anybits?(CallNodeFlags::VARIABLE_CALL)
end
# def attribute_write?: () -> bool
def attribute_write?
flags.anybits?(CallNodeFlags::ATTRIBUTE_WRITE)
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("safe_navigation" if safe_navigation?), ("variable_call" if variable_call?), ("attribute_write" if attribute_write?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── receiver:\n"
inspector << inspector.child_node(receiver, "│ ")
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
if (block = self.block).nil?
inspector << "└── block: ∅\n"
else
inspector << "└── block:\n"
inspector << block.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:index_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:index_target_node
end
end
# Represents the use of the `&&=` operator for assignment to an instance variable.
#
# @target &&= value
# ^^^^^^^^^^^^^^^^^
class InstanceVariableAndWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_instance_variable_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> InstanceVariableAndWriteNode
def copy(**params)
InstanceVariableAndWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:instance_variable_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:instance_variable_and_write_node
end
end
# Represents assigning to an instance variable using an operator that isn't `=`.
#
# @target += value
# ^^^^^^^^^^^^^^^^
class InstanceVariableOperatorWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator: Symbol
attr_reader :operator
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, operator: Symbol, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, operator, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@operator = operator
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_instance_variable_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> InstanceVariableOperatorWriteNode
def copy(**params)
InstanceVariableOperatorWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:operator) { operator },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, operator: operator, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator: #{operator.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:instance_variable_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:instance_variable_operator_write_node
end
end
# Represents the use of the `||=` operator for assignment to an instance variable.
#
# @target ||= value
# ^^^^^^^^^^^^^^^^^
class InstanceVariableOrWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_instance_variable_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> InstanceVariableOrWriteNode
def copy(**params)
InstanceVariableOrWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:instance_variable_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:instance_variable_or_write_node
end
end
# Represents referencing an instance variable.
#
# @foo
# ^^^^
class InstanceVariableReadNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_instance_variable_read_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> InstanceVariableReadNode
def copy(**params)
InstanceVariableReadNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:instance_variable_read_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:instance_variable_read_node
end
end
# Represents writing to an instance variable in a context that doesn't have an explicit value.
#
# @foo, @bar = baz
# ^^^^ ^^^^
class InstanceVariableTargetNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_instance_variable_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> InstanceVariableTargetNode
def copy(**params)
InstanceVariableTargetNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:instance_variable_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:instance_variable_target_node
end
end
# Represents writing to an instance variable.
#
# @foo = 1
# ^^^^^^^^
class InstanceVariableWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (name: Symbol, name_loc: Location, value: Node, operator_loc: Location, location: Location) -> void
def initialize(name, name_loc, value, operator_loc, location)
@name = name
@name_loc = name_loc
@value = value
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_instance_variable_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, value, operator_loc]
end
# def copy: (**params) -> InstanceVariableWriteNode
def copy(**params)
InstanceVariableWriteNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:value) { value },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, value: value, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:instance_variable_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:instance_variable_write_node
end
end
# Represents an integer number literal.
#
# 1
# ^
class IntegerNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# def initialize: (flags: Integer, location: Location) -> void
def initialize(flags, location)
@flags = flags
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_integer_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> IntegerNode
def copy(**params)
IntegerNode.new(
params.fetch(:flags) { flags },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, location: location }
end
# def binary?: () -> bool
def binary?
flags.anybits?(IntegerBaseFlags::BINARY)
end
# def decimal?: () -> bool
def decimal?
flags.anybits?(IntegerBaseFlags::DECIMAL)
end
# def octal?: () -> bool
def octal?
flags.anybits?(IntegerBaseFlags::OCTAL)
end
# def hexadecimal?: () -> bool
def hexadecimal?
flags.anybits?(IntegerBaseFlags::HEXADECIMAL)
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("binary" if binary?), ("decimal" if decimal?), ("octal" if octal?), ("hexadecimal" if hexadecimal?)].compact
inspector << "└── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:integer_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:integer_node
end
end
# Represents a regular expression literal that contains interpolation that
# is being used in the predicate of a conditional to implicitly match
# against the last line read by an IO object.
#
# if /foo #{bar} baz/ then end
# ^^^^^^^^^^^^^^^^
class InterpolatedMatchLastLineNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader parts: Array[Node]
attr_reader :parts
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (flags: Integer, opening_loc: Location, parts: Array[Node], closing_loc: Location, location: Location) -> void
def initialize(flags, opening_loc, parts, closing_loc, location)
@flags = flags
@opening_loc = opening_loc
@parts = parts
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_interpolated_match_last_line_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
first = parts.first
first.set_newline_flag(newline_marked) if first
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*parts]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*parts]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, *parts, closing_loc]
end
# def copy: (**params) -> InterpolatedMatchLastLineNode
def copy(**params)
InterpolatedMatchLastLineNode.new(
params.fetch(:flags) { flags },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:parts) { parts },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, opening_loc: opening_loc, parts: parts, closing_loc: closing_loc, location: location }
end
# def ignore_case?: () -> bool
def ignore_case?
flags.anybits?(RegularExpressionFlags::IGNORE_CASE)
end
# def extended?: () -> bool
def extended?
flags.anybits?(RegularExpressionFlags::EXTENDED)
end
# def multi_line?: () -> bool
def multi_line?
flags.anybits?(RegularExpressionFlags::MULTI_LINE)
end
# def once?: () -> bool
def once?
flags.anybits?(RegularExpressionFlags::ONCE)
end
# def euc_jp?: () -> bool
def euc_jp?
flags.anybits?(RegularExpressionFlags::EUC_JP)
end
# def ascii_8bit?: () -> bool
def ascii_8bit?
flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
end
# def windows_31j?: () -> bool
def windows_31j?
flags.anybits?(RegularExpressionFlags::WINDOWS_31J)
end
# def utf_8?: () -> bool
def utf_8?
flags.anybits?(RegularExpressionFlags::UTF_8)
end
# def forced_utf8_encoding?: () -> bool
def forced_utf8_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_UTF8_ENCODING)
end
# def forced_binary_encoding?: () -> bool
def forced_binary_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_BINARY_ENCODING)
end
# def forced_us_ascii_encoding?: () -> bool
def forced_us_ascii_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_US_ASCII_ENCODING)
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("ignore_case" if ignore_case?), ("extended" if extended?), ("multi_line" if multi_line?), ("once" if once?), ("euc_jp" if euc_jp?), ("ascii_8bit" if ascii_8bit?), ("windows_31j" if windows_31j?), ("utf_8" if utf_8?), ("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("forced_us_ascii_encoding" if forced_us_ascii_encoding?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── parts: #{inspector.list("#{inspector.prefix}│ ", parts)}"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:interpolated_match_last_line_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:interpolated_match_last_line_node
end
end
# Represents a regular expression literal that contains interpolation.
#
# /foo #{bar} baz/
# ^^^^^^^^^^^^^^^^
class InterpolatedRegularExpressionNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader parts: Array[Node]
attr_reader :parts
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (flags: Integer, opening_loc: Location, parts: Array[Node], closing_loc: Location, location: Location) -> void
def initialize(flags, opening_loc, parts, closing_loc, location)
@flags = flags
@opening_loc = opening_loc
@parts = parts
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_interpolated_regular_expression_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
first = parts.first
first.set_newline_flag(newline_marked) if first
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*parts]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*parts]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, *parts, closing_loc]
end
# def copy: (**params) -> InterpolatedRegularExpressionNode
def copy(**params)
InterpolatedRegularExpressionNode.new(
params.fetch(:flags) { flags },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:parts) { parts },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, opening_loc: opening_loc, parts: parts, closing_loc: closing_loc, location: location }
end
# def ignore_case?: () -> bool
def ignore_case?
flags.anybits?(RegularExpressionFlags::IGNORE_CASE)
end
# def extended?: () -> bool
def extended?
flags.anybits?(RegularExpressionFlags::EXTENDED)
end
# def multi_line?: () -> bool
def multi_line?
flags.anybits?(RegularExpressionFlags::MULTI_LINE)
end
# def once?: () -> bool
def once?
flags.anybits?(RegularExpressionFlags::ONCE)
end
# def euc_jp?: () -> bool
def euc_jp?
flags.anybits?(RegularExpressionFlags::EUC_JP)
end
# def ascii_8bit?: () -> bool
def ascii_8bit?
flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
end
# def windows_31j?: () -> bool
def windows_31j?
flags.anybits?(RegularExpressionFlags::WINDOWS_31J)
end
# def utf_8?: () -> bool
def utf_8?
flags.anybits?(RegularExpressionFlags::UTF_8)
end
# def forced_utf8_encoding?: () -> bool
def forced_utf8_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_UTF8_ENCODING)
end
# def forced_binary_encoding?: () -> bool
def forced_binary_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_BINARY_ENCODING)
end
# def forced_us_ascii_encoding?: () -> bool
def forced_us_ascii_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_US_ASCII_ENCODING)
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("ignore_case" if ignore_case?), ("extended" if extended?), ("multi_line" if multi_line?), ("once" if once?), ("euc_jp" if euc_jp?), ("ascii_8bit" if ascii_8bit?), ("windows_31j" if windows_31j?), ("utf_8" if utf_8?), ("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("forced_us_ascii_encoding" if forced_us_ascii_encoding?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── parts: #{inspector.list("#{inspector.prefix}│ ", parts)}"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:interpolated_regular_expression_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:interpolated_regular_expression_node
end
end
# Represents a string literal that contains interpolation.
#
# "foo #{bar} baz"
# ^^^^^^^^^^^^^^^^
class InterpolatedStringNode < Node
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader parts: Array[Node]
attr_reader :parts
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# def initialize: (opening_loc: Location?, parts: Array[Node], closing_loc: Location?, location: Location) -> void
def initialize(opening_loc, parts, closing_loc, location)
@opening_loc = opening_loc
@parts = parts
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_interpolated_string_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
first = parts.first
first.set_newline_flag(newline_marked) if first
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*parts]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*parts]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*opening_loc, *parts, *closing_loc]
end
# def copy: (**params) -> InterpolatedStringNode
def copy(**params)
InterpolatedStringNode.new(
params.fetch(:opening_loc) { opening_loc },
params.fetch(:parts) { parts },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ opening_loc: opening_loc, parts: parts, closing_loc: closing_loc, location: location }
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── parts: #{inspector.list("#{inspector.prefix}│ ", parts)}"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:interpolated_string_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:interpolated_string_node
end
end
# Represents a symbol literal that contains interpolation.
#
# :"foo #{bar} baz"
# ^^^^^^^^^^^^^^^^^
class InterpolatedSymbolNode < Node
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader parts: Array[Node]
attr_reader :parts
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# def initialize: (opening_loc: Location?, parts: Array[Node], closing_loc: Location?, location: Location) -> void
def initialize(opening_loc, parts, closing_loc, location)
@opening_loc = opening_loc
@parts = parts
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_interpolated_symbol_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
first = parts.first
first.set_newline_flag(newline_marked) if first
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*parts]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*parts]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*opening_loc, *parts, *closing_loc]
end
# def copy: (**params) -> InterpolatedSymbolNode
def copy(**params)
InterpolatedSymbolNode.new(
params.fetch(:opening_loc) { opening_loc },
params.fetch(:parts) { parts },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ opening_loc: opening_loc, parts: parts, closing_loc: closing_loc, location: location }
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── parts: #{inspector.list("#{inspector.prefix}│ ", parts)}"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:interpolated_symbol_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:interpolated_symbol_node
end
end
# Represents an xstring literal that contains interpolation.
#
# `foo #{bar} baz`
# ^^^^^^^^^^^^^^^^
class InterpolatedXStringNode < Node
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader parts: Array[Node]
attr_reader :parts
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (opening_loc: Location, parts: Array[Node], closing_loc: Location, location: Location) -> void
def initialize(opening_loc, parts, closing_loc, location)
@opening_loc = opening_loc
@parts = parts
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_interpolated_x_string_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
first = parts.first
first.set_newline_flag(newline_marked) if first
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*parts]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*parts]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, *parts, closing_loc]
end
# def copy: (**params) -> InterpolatedXStringNode
def copy(**params)
InterpolatedXStringNode.new(
params.fetch(:opening_loc) { opening_loc },
params.fetch(:parts) { parts },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ opening_loc: opening_loc, parts: parts, closing_loc: closing_loc, location: location }
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── parts: #{inspector.list("#{inspector.prefix}│ ", parts)}"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:interpolated_x_string_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:interpolated_x_string_node
end
end
# Represents a hash literal without opening and closing braces.
#
# foo(a: b)
# ^^^^
class KeywordHashNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader elements: Array[Node]
attr_reader :elements
# def initialize: (flags: Integer, elements: Array[Node], location: Location) -> void
def initialize(flags, elements, location)
@flags = flags
@elements = elements
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_keyword_hash_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*elements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*elements]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*elements]
end
# def copy: (**params) -> KeywordHashNode
def copy(**params)
KeywordHashNode.new(
params.fetch(:flags) { flags },
params.fetch(:elements) { elements },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, elements: elements, location: location }
end
# def static_keys?: () -> bool
def static_keys?
flags.anybits?(KeywordHashNodeFlags::STATIC_KEYS)
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("static_keys" if static_keys?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "└── elements: #{inspector.list("#{inspector.prefix} ", elements)}"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:keyword_hash_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:keyword_hash_node
end
end
# Represents a keyword rest parameter to a method, block, or lambda definition.
#
# def a(**b)
# ^^^
# end
class KeywordRestParameterNode < Node
# attr_reader name: Symbol?
attr_reader :name
# attr_reader name_loc: Location?
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (name: Symbol?, name_loc: Location?, operator_loc: Location, location: Location) -> void
def initialize(name, name_loc, operator_loc, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_keyword_rest_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*name_loc, operator_loc]
end
# def copy: (**params) -> KeywordRestParameterNode
def copy(**params)
KeywordRestParameterNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (name = self.name).nil?
inspector << "├── name: ∅\n"
else
inspector << "├── name: #{name.inspect}\n"
end
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:keyword_rest_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:keyword_rest_parameter_node
end
end
# Represents using a lambda literal (not the lambda method call).
#
# ->(value) { value * 2 }
# ^^^^^^^^^^^^^^^^^^^^^^^
class LambdaNode < Node
# attr_reader locals: Array[Symbol]
attr_reader :locals
# attr_reader locals_body_index: Integer
attr_reader :locals_body_index
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader parameters: Node?
attr_reader :parameters
# attr_reader body: Node?
attr_reader :body
# def initialize: (locals: Array[Symbol], locals_body_index: Integer, operator_loc: Location, opening_loc: Location, closing_loc: Location, parameters: Node?, body: Node?, location: Location) -> void
def initialize(locals, locals_body_index, operator_loc, opening_loc, closing_loc, parameters, body, location)
@locals = locals
@locals_body_index = locals_body_index
@operator_loc = operator_loc
@opening_loc = opening_loc
@closing_loc = closing_loc
@parameters = parameters
@body = body
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_lambda_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[parameters, body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << parameters if parameters
compact << body if body
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[operator_loc, opening_loc, closing_loc, *parameters, *body]
end
# def copy: (**params) -> LambdaNode
def copy(**params)
LambdaNode.new(
params.fetch(:locals) { locals },
params.fetch(:locals_body_index) { locals_body_index },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:parameters) { parameters },
params.fetch(:body) { body },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ locals: locals, locals_body_index: locals_body_index, operator_loc: operator_loc, opening_loc: opening_loc, closing_loc: closing_loc, parameters: parameters, body: body, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── locals_body_index: #{locals_body_index.inspect}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
if (parameters = self.parameters).nil?
inspector << "├── parameters: ∅\n"
else
inspector << "├── parameters:\n"
inspector << parameters.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (body = self.body).nil?
inspector << "└── body: ∅\n"
else
inspector << "└── body:\n"
inspector << body.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:lambda_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:lambda_node
end
end
# Represents the use of the `&&=` operator for assignment to a local variable.
#
# target &&= value
# ^^^^^^^^^^^^^^^^
class LocalVariableAndWriteNode < Node
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader name: Symbol
attr_reader :name
# attr_reader depth: Integer
attr_reader :depth
# def initialize: (name_loc: Location, operator_loc: Location, value: Node, name: Symbol, depth: Integer, location: Location) -> void
def initialize(name_loc, operator_loc, value, name, depth, location)
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@name = name
@depth = depth
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_local_variable_and_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> LocalVariableAndWriteNode
def copy(**params)
LocalVariableAndWriteNode.new(
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:name) { name },
params.fetch(:depth) { depth },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name_loc: name_loc, operator_loc: operator_loc, value: value, name: name, depth: depth, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "├── name: #{name.inspect}\n"
inspector << "└── depth: #{depth.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:local_variable_and_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:local_variable_and_write_node
end
end
# Represents assigning to a local variable using an operator that isn't `=`.
#
# target += value
# ^^^^^^^^^^^^^^^
class LocalVariableOperatorWriteNode < Node
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader name: Symbol
attr_reader :name
# attr_reader operator: Symbol
attr_reader :operator
# attr_reader depth: Integer
attr_reader :depth
# def initialize: (name_loc: Location, operator_loc: Location, value: Node, name: Symbol, operator: Symbol, depth: Integer, location: Location) -> void
def initialize(name_loc, operator_loc, value, name, operator, depth, location)
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@name = name
@operator = operator
@depth = depth
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_local_variable_operator_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> LocalVariableOperatorWriteNode
def copy(**params)
LocalVariableOperatorWriteNode.new(
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:name) { name },
params.fetch(:operator) { operator },
params.fetch(:depth) { depth },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name_loc: name_loc, operator_loc: operator_loc, value: value, name: name, operator: operator, depth: depth, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "├── name: #{name.inspect}\n"
inspector << "├── operator: #{operator.inspect}\n"
inspector << "└── depth: #{depth.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:local_variable_operator_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:local_variable_operator_write_node
end
end
# Represents the use of the `||=` operator for assignment to a local variable.
#
# target ||= value
# ^^^^^^^^^^^^^^^^
class LocalVariableOrWriteNode < Node
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# attr_reader name: Symbol
attr_reader :name
# attr_reader depth: Integer
attr_reader :depth
# def initialize: (name_loc: Location, operator_loc: Location, value: Node, name: Symbol, depth: Integer, location: Location) -> void
def initialize(name_loc, operator_loc, value, name, depth, location)
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@name = name
@depth = depth
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_local_variable_or_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> LocalVariableOrWriteNode
def copy(**params)
LocalVariableOrWriteNode.new(
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:name) { name },
params.fetch(:depth) { depth },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name_loc: name_loc, operator_loc: operator_loc, value: value, name: name, depth: depth, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "├── name: #{name.inspect}\n"
inspector << "└── depth: #{depth.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:local_variable_or_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:local_variable_or_write_node
end
end
# Represents reading a local variable. Note that this requires that a local
# variable of the same name has already been written to in the same scope,
# otherwise it is parsed as a method call.
#
# foo
# ^^^
class LocalVariableReadNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader depth: Integer
attr_reader :depth
# def initialize: (name: Symbol, depth: Integer, location: Location) -> void
def initialize(name, depth, location)
@name = name
@depth = depth
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_local_variable_read_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> LocalVariableReadNode
def copy(**params)
LocalVariableReadNode.new(
params.fetch(:name) { name },
params.fetch(:depth) { depth },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, depth: depth, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "└── depth: #{depth.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:local_variable_read_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:local_variable_read_node
end
end
# Represents writing to a local variable in a context that doesn't have an explicit value.
#
# foo, bar = baz
# ^^^ ^^^
class LocalVariableTargetNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader depth: Integer
attr_reader :depth
# def initialize: (name: Symbol, depth: Integer, location: Location) -> void
def initialize(name, depth, location)
@name = name
@depth = depth
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_local_variable_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> LocalVariableTargetNode
def copy(**params)
LocalVariableTargetNode.new(
params.fetch(:name) { name },
params.fetch(:depth) { depth },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, depth: depth, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "└── depth: #{depth.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:local_variable_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:local_variable_target_node
end
end
# Represents writing to a local variable.
#
# foo = 1
# ^^^^^^^
class LocalVariableWriteNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader depth: Integer
attr_reader :depth
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader value: Node
attr_reader :value
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (name: Symbol, depth: Integer, name_loc: Location, value: Node, operator_loc: Location, location: Location) -> void
def initialize(name, depth, name_loc, value, operator_loc, location)
@name = name
@depth = depth
@name_loc = name_loc
@value = value
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_local_variable_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, value, operator_loc]
end
# def copy: (**params) -> LocalVariableWriteNode
def copy(**params)
LocalVariableWriteNode.new(
params.fetch(:name) { name },
params.fetch(:depth) { depth },
params.fetch(:name_loc) { name_loc },
params.fetch(:value) { value },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, depth: depth, name_loc: name_loc, value: value, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── depth: #{depth.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:local_variable_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:local_variable_write_node
end
end
# Represents a regular expression literal used in the predicate of a
# conditional to implicitly match against the last line read by an IO
# object.
#
# if /foo/i then end
# ^^^^^^
class MatchLastLineNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader content_loc: Location
attr_reader :content_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader unescaped: String
attr_reader :unescaped
# def initialize: (flags: Integer, opening_loc: Location, content_loc: Location, closing_loc: Location, unescaped: String, location: Location) -> void
def initialize(flags, opening_loc, content_loc, closing_loc, unescaped, location)
@flags = flags
@opening_loc = opening_loc
@content_loc = content_loc
@closing_loc = closing_loc
@unescaped = unescaped
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_match_last_line_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, content_loc, closing_loc]
end
# def copy: (**params) -> MatchLastLineNode
def copy(**params)
MatchLastLineNode.new(
params.fetch(:flags) { flags },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:content_loc) { content_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:unescaped) { unescaped },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end
# def ignore_case?: () -> bool
def ignore_case?
flags.anybits?(RegularExpressionFlags::IGNORE_CASE)
end
# def extended?: () -> bool
def extended?
flags.anybits?(RegularExpressionFlags::EXTENDED)
end
# def multi_line?: () -> bool
def multi_line?
flags.anybits?(RegularExpressionFlags::MULTI_LINE)
end
# def once?: () -> bool
def once?
flags.anybits?(RegularExpressionFlags::ONCE)
end
# def euc_jp?: () -> bool
def euc_jp?
flags.anybits?(RegularExpressionFlags::EUC_JP)
end
# def ascii_8bit?: () -> bool
def ascii_8bit?
flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
end
# def windows_31j?: () -> bool
def windows_31j?
flags.anybits?(RegularExpressionFlags::WINDOWS_31J)
end
# def utf_8?: () -> bool
def utf_8?
flags.anybits?(RegularExpressionFlags::UTF_8)
end
# def forced_utf8_encoding?: () -> bool
def forced_utf8_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_UTF8_ENCODING)
end
# def forced_binary_encoding?: () -> bool
def forced_binary_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_BINARY_ENCODING)
end
# def forced_us_ascii_encoding?: () -> bool
def forced_us_ascii_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_US_ASCII_ENCODING)
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def content: () -> String
def content
content_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("ignore_case" if ignore_case?), ("extended" if extended?), ("multi_line" if multi_line?), ("once" if once?), ("euc_jp" if euc_jp?), ("ascii_8bit" if ascii_8bit?), ("windows_31j" if windows_31j?), ("utf_8" if utf_8?), ("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("forced_us_ascii_encoding" if forced_us_ascii_encoding?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── content_loc: #{inspector.location(content_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "└── unescaped: #{unescaped.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:match_last_line_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:match_last_line_node
end
end
# Represents the use of the modifier `in` operator.
#
# foo in bar
# ^^^^^^^^^^
class MatchPredicateNode < Node
# attr_reader value: Node
attr_reader :value
# attr_reader pattern: Node
attr_reader :pattern
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (value: Node, pattern: Node, operator_loc: Location, location: Location) -> void
def initialize(value, pattern, operator_loc, location)
@value = value
@pattern = pattern
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_match_predicate_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value, pattern]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value, pattern]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[value, pattern, operator_loc]
end
# def copy: (**params) -> MatchPredicateNode
def copy(**params)
MatchPredicateNode.new(
params.fetch(:value) { value },
params.fetch(:pattern) { pattern },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ value: value, pattern: pattern, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "├── pattern:\n"
inspector << inspector.child_node(pattern, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:match_predicate_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:match_predicate_node
end
end
# Represents the use of the `=>` operator.
#
# foo => bar
# ^^^^^^^^^^
class MatchRequiredNode < Node
# attr_reader value: Node
attr_reader :value
# attr_reader pattern: Node
attr_reader :pattern
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (value: Node, pattern: Node, operator_loc: Location, location: Location) -> void
def initialize(value, pattern, operator_loc, location)
@value = value
@pattern = pattern
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_match_required_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value, pattern]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value, pattern]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[value, pattern, operator_loc]
end
# def copy: (**params) -> MatchRequiredNode
def copy(**params)
MatchRequiredNode.new(
params.fetch(:value) { value },
params.fetch(:pattern) { pattern },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ value: value, pattern: pattern, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── value:\n"
inspector << inspector.child_node(value, "│ ")
inspector << "├── pattern:\n"
inspector << inspector.child_node(pattern, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:match_required_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:match_required_node
end
end
# Represents writing local variables using a regular expression match with
# named capture groups.
#
# /(?<foo>bar)/ =~ baz
# ^^^^^^^^^^^^^^^^^^^^
class MatchWriteNode < Node
# attr_reader call: CallNode
attr_reader :call
# attr_reader targets: Array[Node]
attr_reader :targets
# def initialize: (call: CallNode, targets: Array[Node], location: Location) -> void
def initialize(call, targets, location)
@call = call
@targets = targets
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_match_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[call, *targets]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[call, *targets]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[call, *targets]
end
# def copy: (**params) -> MatchWriteNode
def copy(**params)
MatchWriteNode.new(
params.fetch(:call) { call },
params.fetch(:targets) { targets },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ call: call, targets: targets, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── call:\n"
inspector << inspector.child_node(call, "│ ")
inspector << "└── targets: #{inspector.list("#{inspector.prefix} ", targets)}"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:match_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:match_write_node
end
end
# Represents a node that is missing from the source and results in a syntax
# error.
class MissingNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_missing_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> MissingNode
def copy(**params)
MissingNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:missing_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:missing_node
end
end
# Represents a module declaration involving the `module` keyword.
#
# module Foo end
# ^^^^^^^^^^^^^^
class ModuleNode < Node
# attr_reader locals: Array[Symbol]
attr_reader :locals
# attr_reader module_keyword_loc: Location
attr_reader :module_keyword_loc
# attr_reader constant_path: Node
attr_reader :constant_path
# attr_reader body: Node?
attr_reader :body
# attr_reader end_keyword_loc: Location
attr_reader :end_keyword_loc
# attr_reader name: Symbol
attr_reader :name
# def initialize: (locals: Array[Symbol], module_keyword_loc: Location, constant_path: Node, body: Node?, end_keyword_loc: Location, name: Symbol, location: Location) -> void
def initialize(locals, module_keyword_loc, constant_path, body, end_keyword_loc, name, location)
@locals = locals
@module_keyword_loc = module_keyword_loc
@constant_path = constant_path
@body = body
@end_keyword_loc = end_keyword_loc
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_module_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[constant_path, body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << constant_path
compact << body if body
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[module_keyword_loc, constant_path, *body, end_keyword_loc]
end
# def copy: (**params) -> ModuleNode
def copy(**params)
ModuleNode.new(
params.fetch(:locals) { locals },
params.fetch(:module_keyword_loc) { module_keyword_loc },
params.fetch(:constant_path) { constant_path },
params.fetch(:body) { body },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ locals: locals, module_keyword_loc: module_keyword_loc, constant_path: constant_path, body: body, end_keyword_loc: end_keyword_loc, name: name, location: location }
end
# def module_keyword: () -> String
def module_keyword
module_keyword_loc.slice
end
# def end_keyword: () -> String
def end_keyword
end_keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── module_keyword_loc: #{inspector.location(module_keyword_loc)}\n"
inspector << "├── constant_path:\n"
inspector << inspector.child_node(constant_path, "│ ")
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:module_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:module_node
end
end
# Represents a multi-target expression.
#
# a, (b, c) = 1, 2, 3
# ^^^^^^
class MultiTargetNode < Node
# attr_reader lefts: Array[Node]
attr_reader :lefts
# attr_reader rest: Node?
attr_reader :rest
# attr_reader rights: Array[Node]
attr_reader :rights
# attr_reader lparen_loc: Location?
attr_reader :lparen_loc
# attr_reader rparen_loc: Location?
attr_reader :rparen_loc
# def initialize: (lefts: Array[Node], rest: Node?, rights: Array[Node], lparen_loc: Location?, rparen_loc: Location?, location: Location) -> void
def initialize(lefts, rest, rights, lparen_loc, rparen_loc, location)
@lefts = lefts
@rest = rest
@rights = rights
@lparen_loc = lparen_loc
@rparen_loc = rparen_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_multi_target_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*lefts, rest, *rights]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact.concat(lefts)
compact << rest if rest
compact.concat(rights)
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*lefts, *rest, *rights, *lparen_loc, *rparen_loc]
end
# def copy: (**params) -> MultiTargetNode
def copy(**params)
MultiTargetNode.new(
params.fetch(:lefts) { lefts },
params.fetch(:rest) { rest },
params.fetch(:rights) { rights },
params.fetch(:lparen_loc) { lparen_loc },
params.fetch(:rparen_loc) { rparen_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ lefts: lefts, rest: rest, rights: rights, lparen_loc: lparen_loc, rparen_loc: rparen_loc, location: location }
end
# def lparen: () -> String?
def lparen
lparen_loc&.slice
end
# def rparen: () -> String?
def rparen
rparen_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── lefts: #{inspector.list("#{inspector.prefix}│ ", lefts)}"
if (rest = self.rest).nil?
inspector << "├── rest: ∅\n"
else
inspector << "├── rest:\n"
inspector << rest.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── rights: #{inspector.list("#{inspector.prefix}│ ", rights)}"
inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
inspector << "└── rparen_loc: #{inspector.location(rparen_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:multi_target_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:multi_target_node
end
end
# Represents a write to a multi-target expression.
#
# a, b, c = 1, 2, 3
# ^^^^^^^^^^^^^^^^^
class MultiWriteNode < Node
# attr_reader lefts: Array[Node]
attr_reader :lefts
# attr_reader rest: Node?
attr_reader :rest
# attr_reader rights: Array[Node]
attr_reader :rights
# attr_reader lparen_loc: Location?
attr_reader :lparen_loc
# attr_reader rparen_loc: Location?
attr_reader :rparen_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (lefts: Array[Node], rest: Node?, rights: Array[Node], lparen_loc: Location?, rparen_loc: Location?, operator_loc: Location, value: Node, location: Location) -> void
def initialize(lefts, rest, rights, lparen_loc, rparen_loc, operator_loc, value, location)
@lefts = lefts
@rest = rest
@rights = rights
@lparen_loc = lparen_loc
@rparen_loc = rparen_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_multi_write_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*lefts, rest, *rights, value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact.concat(lefts)
compact << rest if rest
compact.concat(rights)
compact << value
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*lefts, *rest, *rights, *lparen_loc, *rparen_loc, operator_loc, value]
end
# def copy: (**params) -> MultiWriteNode
def copy(**params)
MultiWriteNode.new(
params.fetch(:lefts) { lefts },
params.fetch(:rest) { rest },
params.fetch(:rights) { rights },
params.fetch(:lparen_loc) { lparen_loc },
params.fetch(:rparen_loc) { rparen_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ lefts: lefts, rest: rest, rights: rights, lparen_loc: lparen_loc, rparen_loc: rparen_loc, operator_loc: operator_loc, value: value, location: location }
end
# def lparen: () -> String?
def lparen
lparen_loc&.slice
end
# def rparen: () -> String?
def rparen
rparen_loc&.slice
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── lefts: #{inspector.list("#{inspector.prefix}│ ", lefts)}"
if (rest = self.rest).nil?
inspector << "├── rest: ∅\n"
else
inspector << "├── rest:\n"
inspector << rest.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── rights: #{inspector.list("#{inspector.prefix}│ ", rights)}"
inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:multi_write_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:multi_write_node
end
end
# Represents the use of the `next` keyword.
#
# next 1
# ^^^^^^
class NextNode < Node
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# def initialize: (arguments: ArgumentsNode?, keyword_loc: Location, location: Location) -> void
def initialize(arguments, keyword_loc, location)
@arguments = arguments
@keyword_loc = keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_next_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[arguments]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << arguments if arguments
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*arguments, keyword_loc]
end
# def copy: (**params) -> NextNode
def copy(**params)
NextNode.new(
params.fetch(:arguments) { arguments },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ arguments: arguments, keyword_loc: keyword_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:next_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:next_node
end
end
# Represents the use of the `nil` keyword.
#
# nil
# ^^^
class NilNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_nil_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> NilNode
def copy(**params)
NilNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:nil_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:nil_node
end
end
# Represents the use of `**nil` inside method arguments.
#
# def a(**nil)
# ^^^^^
# end
class NoKeywordsParameterNode < Node
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# def initialize: (operator_loc: Location, keyword_loc: Location, location: Location) -> void
def initialize(operator_loc, keyword_loc, location)
@operator_loc = operator_loc
@keyword_loc = keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_no_keywords_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[operator_loc, keyword_loc]
end
# def copy: (**params) -> NoKeywordsParameterNode
def copy(**params)
NoKeywordsParameterNode.new(
params.fetch(:operator_loc) { operator_loc },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ operator_loc: operator_loc, keyword_loc: keyword_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:no_keywords_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:no_keywords_parameter_node
end
end
# Represents an implicit set of parameters through the use of numbered
# parameters within a block or lambda.
#
# -> { _1 + _2 }
# ^^^^^^^^^^^^^^
class NumberedParametersNode < Node
# attr_reader maximum: Integer
attr_reader :maximum
# def initialize: (maximum: Integer, location: Location) -> void
def initialize(maximum, location)
@maximum = maximum
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_numbered_parameters_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> NumberedParametersNode
def copy(**params)
NumberedParametersNode.new(
params.fetch(:maximum) { maximum },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ maximum: maximum, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── maximum: #{maximum.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:numbered_parameters_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:numbered_parameters_node
end
end
# Represents reading a numbered reference to a capture in the previous match.
#
# $1
# ^^
class NumberedReferenceReadNode < Node
# attr_reader number: Integer
attr_reader :number
# def initialize: (number: Integer, location: Location) -> void
def initialize(number, location)
@number = number
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_numbered_reference_read_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> NumberedReferenceReadNode
def copy(**params)
NumberedReferenceReadNode.new(
params.fetch(:number) { number },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ number: number, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── number: #{number.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:numbered_reference_read_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:numbered_reference_read_node
end
end
# Represents an optional keyword parameter to a method, block, or lambda definition.
#
# def a(b: 1)
# ^^^^
# end
class OptionalKeywordParameterNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, value, location)
@name = name
@name_loc = name_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_optional_keyword_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, value]
end
# def copy: (**params) -> OptionalKeywordParameterNode
def copy(**params)
OptionalKeywordParameterNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, value: value, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:optional_keyword_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:optional_keyword_parameter_node
end
end
# Represents an optional parameter to a method, block, or lambda definition.
#
# def a(b = 1)
# ^^^^^
# end
class OptionalParameterNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader value: Node
attr_reader :value
# def initialize: (name: Symbol, name_loc: Location, operator_loc: Location, value: Node, location: Location) -> void
def initialize(name, name_loc, operator_loc, value, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@value = value
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_optional_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[value]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[value]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc, operator_loc, value]
end
# def copy: (**params) -> OptionalParameterNode
def copy(**params)
OptionalParameterNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:value) { value },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, value: value, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "└── value:\n"
inspector << inspector.child_node(value, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:optional_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:optional_parameter_node
end
end
# Represents the use of the `||` operator or the `or` keyword.
#
# left or right
# ^^^^^^^^^^^^^
class OrNode < Node
# attr_reader left: Node
attr_reader :left
# attr_reader right: Node
attr_reader :right
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (left: Node, right: Node, operator_loc: Location, location: Location) -> void
def initialize(left, right, operator_loc, location)
@left = left
@right = right
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_or_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[left, right]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[left, right]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[left, right, operator_loc]
end
# def copy: (**params) -> OrNode
def copy(**params)
OrNode.new(
params.fetch(:left) { left },
params.fetch(:right) { right },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ left: left, right: right, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── left:\n"
inspector << inspector.child_node(left, "│ ")
inspector << "├── right:\n"
inspector << inspector.child_node(right, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:or_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:or_node
end
end
# Represents the list of parameters on a method, block, or lambda definition.
#
# def a(b, c, d)
# ^^^^^^^
# end
class ParametersNode < Node
# attr_reader requireds: Array[Node]
attr_reader :requireds
# attr_reader optionals: Array[Node]
attr_reader :optionals
# attr_reader rest: Node?
attr_reader :rest
# attr_reader posts: Array[Node]
attr_reader :posts
# attr_reader keywords: Array[Node]
attr_reader :keywords
# attr_reader keyword_rest: Node?
attr_reader :keyword_rest
# attr_reader block: BlockParameterNode?
attr_reader :block
# def initialize: (requireds: Array[Node], optionals: Array[Node], rest: Node?, posts: Array[Node], keywords: Array[Node], keyword_rest: Node?, block: BlockParameterNode?, location: Location) -> void
def initialize(requireds, optionals, rest, posts, keywords, keyword_rest, block, location)
@requireds = requireds
@optionals = optionals
@rest = rest
@posts = posts
@keywords = keywords
@keyword_rest = keyword_rest
@block = block
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_parameters_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*requireds, *optionals, rest, *posts, *keywords, keyword_rest, block]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact.concat(requireds)
compact.concat(optionals)
compact << rest if rest
compact.concat(posts)
compact.concat(keywords)
compact << keyword_rest if keyword_rest
compact << block if block
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*requireds, *optionals, *rest, *posts, *keywords, *keyword_rest, *block]
end
# def copy: (**params) -> ParametersNode
def copy(**params)
ParametersNode.new(
params.fetch(:requireds) { requireds },
params.fetch(:optionals) { optionals },
params.fetch(:rest) { rest },
params.fetch(:posts) { posts },
params.fetch(:keywords) { keywords },
params.fetch(:keyword_rest) { keyword_rest },
params.fetch(:block) { block },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ requireds: requireds, optionals: optionals, rest: rest, posts: posts, keywords: keywords, keyword_rest: keyword_rest, block: block, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── requireds: #{inspector.list("#{inspector.prefix}│ ", requireds)}"
inspector << "├── optionals: #{inspector.list("#{inspector.prefix}│ ", optionals)}"
if (rest = self.rest).nil?
inspector << "├── rest: ∅\n"
else
inspector << "├── rest:\n"
inspector << rest.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── posts: #{inspector.list("#{inspector.prefix}│ ", posts)}"
inspector << "├── keywords: #{inspector.list("#{inspector.prefix}│ ", keywords)}"
if (keyword_rest = self.keyword_rest).nil?
inspector << "├── keyword_rest: ∅\n"
else
inspector << "├── keyword_rest:\n"
inspector << keyword_rest.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (block = self.block).nil?
inspector << "└── block: ∅\n"
else
inspector << "└── block:\n"
inspector << block.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:parameters_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:parameters_node
end
end
# Represents a parenthesized expression
#
# (10 + 34)
# ^^^^^^^^^
class ParenthesesNode < Node
# attr_reader body: Node?
attr_reader :body
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (body: Node?, opening_loc: Location, closing_loc: Location, location: Location) -> void
def initialize(body, opening_loc, closing_loc, location)
@body = body
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_parentheses_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
# Never mark ParenthesesNode with a newline flag, mark children instead
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << body if body
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*body, opening_loc, closing_loc]
end
# def copy: (**params) -> ParenthesesNode
def copy(**params)
ParenthesesNode.new(
params.fetch(:body) { body },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ body: body, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:parentheses_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:parentheses_node
end
end
# Represents the use of the `^` operator for pinning an expression in a
# pattern matching expression.
#
# foo in ^(bar)
# ^^^^^^
class PinnedExpressionNode < Node
# attr_reader expression: Node
attr_reader :expression
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader lparen_loc: Location
attr_reader :lparen_loc
# attr_reader rparen_loc: Location
attr_reader :rparen_loc
# def initialize: (expression: Node, operator_loc: Location, lparen_loc: Location, rparen_loc: Location, location: Location) -> void
def initialize(expression, operator_loc, lparen_loc, rparen_loc, location)
@expression = expression
@operator_loc = operator_loc
@lparen_loc = lparen_loc
@rparen_loc = rparen_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_pinned_expression_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[expression]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[expression]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[expression, operator_loc, lparen_loc, rparen_loc]
end
# def copy: (**params) -> PinnedExpressionNode
def copy(**params)
PinnedExpressionNode.new(
params.fetch(:expression) { expression },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:lparen_loc) { lparen_loc },
params.fetch(:rparen_loc) { rparen_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ expression: expression, operator_loc: operator_loc, lparen_loc: lparen_loc, rparen_loc: rparen_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def lparen: () -> String
def lparen
lparen_loc.slice
end
# def rparen: () -> String
def rparen
rparen_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── expression:\n"
inspector << inspector.child_node(expression, "│ ")
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
inspector << "└── rparen_loc: #{inspector.location(rparen_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:pinned_expression_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:pinned_expression_node
end
end
# Represents the use of the `^` operator for pinning a variable in a pattern
# matching expression.
#
# foo in ^bar
# ^^^^
class PinnedVariableNode < Node
# attr_reader variable: Node
attr_reader :variable
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (variable: Node, operator_loc: Location, location: Location) -> void
def initialize(variable, operator_loc, location)
@variable = variable
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_pinned_variable_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[variable]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[variable]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[variable, operator_loc]
end
# def copy: (**params) -> PinnedVariableNode
def copy(**params)
PinnedVariableNode.new(
params.fetch(:variable) { variable },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ variable: variable, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── variable:\n"
inspector << inspector.child_node(variable, "│ ")
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:pinned_variable_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:pinned_variable_node
end
end
# Represents the use of the `END` keyword.
#
# END { foo }
# ^^^^^^^^^^^
class PostExecutionNode < Node
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (statements: StatementsNode?, keyword_loc: Location, opening_loc: Location, closing_loc: Location, location: Location) -> void
def initialize(statements, keyword_loc, opening_loc, closing_loc, location)
@statements = statements
@keyword_loc = keyword_loc
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_post_execution_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*statements, keyword_loc, opening_loc, closing_loc]
end
# def copy: (**params) -> PostExecutionNode
def copy(**params)
PostExecutionNode.new(
params.fetch(:statements) { statements },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ statements: statements, keyword_loc: keyword_loc, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:post_execution_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:post_execution_node
end
end
# Represents the use of the `BEGIN` keyword.
#
# BEGIN { foo }
# ^^^^^^^^^^^^^
class PreExecutionNode < Node
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# def initialize: (statements: StatementsNode?, keyword_loc: Location, opening_loc: Location, closing_loc: Location, location: Location) -> void
def initialize(statements, keyword_loc, opening_loc, closing_loc, location)
@statements = statements
@keyword_loc = keyword_loc
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_pre_execution_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*statements, keyword_loc, opening_loc, closing_loc]
end
# def copy: (**params) -> PreExecutionNode
def copy(**params)
PreExecutionNode.new(
params.fetch(:statements) { statements },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ statements: statements, keyword_loc: keyword_loc, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:pre_execution_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:pre_execution_node
end
end
# The top level node of any parse tree.
class ProgramNode < Node
# attr_reader locals: Array[Symbol]
attr_reader :locals
# attr_reader statements: StatementsNode
attr_reader :statements
# def initialize: (locals: Array[Symbol], statements: StatementsNode, location: Location) -> void
def initialize(locals, statements, location)
@locals = locals
@statements = statements
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_program_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[statements]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[statements]
end
# def copy: (**params) -> ProgramNode
def copy(**params)
ProgramNode.new(
params.fetch(:locals) { locals },
params.fetch(:statements) { statements },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ locals: locals, statements: statements, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "└── statements:\n"
inspector << inspector.child_node(statements, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:program_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:program_node
end
end
# Represents the use of the `..` or `...` operators.
#
# 1..2
# ^^^^
#
# c if a =~ /left/ ... b =~ /right/
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
class RangeNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader left: Node?
attr_reader :left
# attr_reader right: Node?
attr_reader :right
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (flags: Integer, left: Node?, right: Node?, operator_loc: Location, location: Location) -> void
def initialize(flags, left, right, operator_loc, location)
@flags = flags
@left = left
@right = right
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_range_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[left, right]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << left if left
compact << right if right
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*left, *right, operator_loc]
end
# def copy: (**params) -> RangeNode
def copy(**params)
RangeNode.new(
params.fetch(:flags) { flags },
params.fetch(:left) { left },
params.fetch(:right) { right },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, left: left, right: right, operator_loc: operator_loc, location: location }
end
# def exclude_end?: () -> bool
def exclude_end?
flags.anybits?(RangeFlags::EXCLUDE_END)
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("exclude_end" if exclude_end?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
if (left = self.left).nil?
inspector << "├── left: ∅\n"
else
inspector << "├── left:\n"
inspector << left.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (right = self.right).nil?
inspector << "├── right: ∅\n"
else
inspector << "├── right:\n"
inspector << right.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:range_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:range_node
end
end
# Represents a rational number literal.
#
# 1.0r
# ^^^^
class RationalNode < Node
# attr_reader numeric: Node
attr_reader :numeric
# def initialize: (numeric: Node, location: Location) -> void
def initialize(numeric, location)
@numeric = numeric
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_rational_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[numeric]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[numeric]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[numeric]
end
# def copy: (**params) -> RationalNode
def copy(**params)
RationalNode.new(
params.fetch(:numeric) { numeric },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ numeric: numeric, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── numeric:\n"
inspector << inspector.child_node(numeric, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:rational_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:rational_node
end
end
# Represents the use of the `redo` keyword.
#
# redo
# ^^^^
class RedoNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_redo_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> RedoNode
def copy(**params)
RedoNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:redo_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:redo_node
end
end
# Represents a regular expression literal with no interpolation.
#
# /foo/i
# ^^^^^^
class RegularExpressionNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader content_loc: Location
attr_reader :content_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader unescaped: String
attr_reader :unescaped
# def initialize: (flags: Integer, opening_loc: Location, content_loc: Location, closing_loc: Location, unescaped: String, location: Location) -> void
def initialize(flags, opening_loc, content_loc, closing_loc, unescaped, location)
@flags = flags
@opening_loc = opening_loc
@content_loc = content_loc
@closing_loc = closing_loc
@unescaped = unescaped
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_regular_expression_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, content_loc, closing_loc]
end
# def copy: (**params) -> RegularExpressionNode
def copy(**params)
RegularExpressionNode.new(
params.fetch(:flags) { flags },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:content_loc) { content_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:unescaped) { unescaped },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end
# def ignore_case?: () -> bool
def ignore_case?
flags.anybits?(RegularExpressionFlags::IGNORE_CASE)
end
# def extended?: () -> bool
def extended?
flags.anybits?(RegularExpressionFlags::EXTENDED)
end
# def multi_line?: () -> bool
def multi_line?
flags.anybits?(RegularExpressionFlags::MULTI_LINE)
end
# def once?: () -> bool
def once?
flags.anybits?(RegularExpressionFlags::ONCE)
end
# def euc_jp?: () -> bool
def euc_jp?
flags.anybits?(RegularExpressionFlags::EUC_JP)
end
# def ascii_8bit?: () -> bool
def ascii_8bit?
flags.anybits?(RegularExpressionFlags::ASCII_8BIT)
end
# def windows_31j?: () -> bool
def windows_31j?
flags.anybits?(RegularExpressionFlags::WINDOWS_31J)
end
# def utf_8?: () -> bool
def utf_8?
flags.anybits?(RegularExpressionFlags::UTF_8)
end
# def forced_utf8_encoding?: () -> bool
def forced_utf8_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_UTF8_ENCODING)
end
# def forced_binary_encoding?: () -> bool
def forced_binary_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_BINARY_ENCODING)
end
# def forced_us_ascii_encoding?: () -> bool
def forced_us_ascii_encoding?
flags.anybits?(RegularExpressionFlags::FORCED_US_ASCII_ENCODING)
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def content: () -> String
def content
content_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("ignore_case" if ignore_case?), ("extended" if extended?), ("multi_line" if multi_line?), ("once" if once?), ("euc_jp" if euc_jp?), ("ascii_8bit" if ascii_8bit?), ("windows_31j" if windows_31j?), ("utf_8" if utf_8?), ("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("forced_us_ascii_encoding" if forced_us_ascii_encoding?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── content_loc: #{inspector.location(content_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "└── unescaped: #{unescaped.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:regular_expression_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:regular_expression_node
end
end
# Represents a required keyword parameter to a method, block, or lambda definition.
#
# def a(b: )
# ^^
# end
class RequiredKeywordParameterNode < Node
# attr_reader name: Symbol
attr_reader :name
# attr_reader name_loc: Location
attr_reader :name_loc
# def initialize: (name: Symbol, name_loc: Location, location: Location) -> void
def initialize(name, name_loc, location)
@name = name
@name_loc = name_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_required_keyword_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[name_loc]
end
# def copy: (**params) -> RequiredKeywordParameterNode
def copy(**params)
RequiredKeywordParameterNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── name: #{name.inspect}\n"
inspector << "└── name_loc: #{inspector.location(name_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:required_keyword_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:required_keyword_parameter_node
end
end
# Represents a required parameter to a method, block, or lambda definition.
#
# def a(b)
# ^
# end
class RequiredParameterNode < Node
# attr_reader name: Symbol
attr_reader :name
# def initialize: (name: Symbol, location: Location) -> void
def initialize(name, location)
@name = name
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_required_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> RequiredParameterNode
def copy(**params)
RequiredParameterNode.new(
params.fetch(:name) { name },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── name: #{name.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:required_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:required_parameter_node
end
end
# Represents an expression modified with a rescue.
#
# foo rescue nil
# ^^^^^^^^^^^^^^
class RescueModifierNode < Node
# attr_reader expression: Node
attr_reader :expression
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader rescue_expression: Node
attr_reader :rescue_expression
# def initialize: (expression: Node, keyword_loc: Location, rescue_expression: Node, location: Location) -> void
def initialize(expression, keyword_loc, rescue_expression, location)
@expression = expression
@keyword_loc = keyword_loc
@rescue_expression = rescue_expression
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_rescue_modifier_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
expression.set_newline_flag(newline_marked)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[expression, rescue_expression]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[expression, rescue_expression]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[expression, keyword_loc, rescue_expression]
end
# def copy: (**params) -> RescueModifierNode
def copy(**params)
RescueModifierNode.new(
params.fetch(:expression) { expression },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:rescue_expression) { rescue_expression },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ expression: expression, keyword_loc: keyword_loc, rescue_expression: rescue_expression, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── expression:\n"
inspector << inspector.child_node(expression, "│ ")
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "└── rescue_expression:\n"
inspector << inspector.child_node(rescue_expression, " ")
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:rescue_modifier_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:rescue_modifier_node
end
end
# Represents a rescue statement.
#
# begin
# rescue Foo, *splat, Bar => ex
# foo
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
# end
#
# `Foo, *splat, Bar` are in the `exceptions` field.
# `ex` is in the `exception` field.
class RescueNode < Node
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader exceptions: Array[Node]
attr_reader :exceptions
# attr_reader operator_loc: Location?
attr_reader :operator_loc
# attr_reader reference: Node?
attr_reader :reference
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader consequent: RescueNode?
attr_reader :consequent
# def initialize: (keyword_loc: Location, exceptions: Array[Node], operator_loc: Location?, reference: Node?, statements: StatementsNode?, consequent: RescueNode?, location: Location) -> void
def initialize(keyword_loc, exceptions, operator_loc, reference, statements, consequent, location)
@keyword_loc = keyword_loc
@exceptions = exceptions
@operator_loc = operator_loc
@reference = reference
@statements = statements
@consequent = consequent
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_rescue_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*exceptions, reference, statements, consequent]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact.concat(exceptions)
compact << reference if reference
compact << statements if statements
compact << consequent if consequent
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, *exceptions, *operator_loc, *reference, *statements, *consequent]
end
# def copy: (**params) -> RescueNode
def copy(**params)
RescueNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:exceptions) { exceptions },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:reference) { reference },
params.fetch(:statements) { statements },
params.fetch(:consequent) { consequent },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, exceptions: exceptions, operator_loc: operator_loc, reference: reference, statements: statements, consequent: consequent, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def operator: () -> String?
def operator
operator_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── exceptions: #{inspector.list("#{inspector.prefix}│ ", exceptions)}"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
if (reference = self.reference).nil?
inspector << "├── reference: ∅\n"
else
inspector << "├── reference:\n"
inspector << reference.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (consequent = self.consequent).nil?
inspector << "└── consequent: ∅\n"
else
inspector << "└── consequent:\n"
inspector << consequent.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:rescue_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:rescue_node
end
end
# Represents a rest parameter to a method, block, or lambda definition.
#
# def a(*b)
# ^^
# end
class RestParameterNode < Node
# attr_reader name: Symbol?
attr_reader :name
# attr_reader name_loc: Location?
attr_reader :name_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# def initialize: (name: Symbol?, name_loc: Location?, operator_loc: Location, location: Location) -> void
def initialize(name, name_loc, operator_loc, location)
@name = name
@name_loc = name_loc
@operator_loc = operator_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_rest_parameter_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*name_loc, operator_loc]
end
# def copy: (**params) -> RestParameterNode
def copy(**params)
RestParameterNode.new(
params.fetch(:name) { name },
params.fetch(:name_loc) { name_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ name: name, name_loc: name_loc, operator_loc: operator_loc, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
if (name = self.name).nil?
inspector << "├── name: ∅\n"
else
inspector << "├── name: #{name.inspect}\n"
end
inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:rest_parameter_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:rest_parameter_node
end
end
# Represents the use of the `retry` keyword.
#
# retry
# ^^^^^
class RetryNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_retry_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> RetryNode
def copy(**params)
RetryNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:retry_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:retry_node
end
end
# Represents the use of the `return` keyword.
#
# return 1
# ^^^^^^^^
class ReturnNode < Node
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# def initialize: (keyword_loc: Location, arguments: ArgumentsNode?, location: Location) -> void
def initialize(keyword_loc, arguments, location)
@keyword_loc = keyword_loc
@arguments = arguments
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_return_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[arguments]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << arguments if arguments
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, *arguments]
end
# def copy: (**params) -> ReturnNode
def copy(**params)
ReturnNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:arguments) { arguments },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, arguments: arguments, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "└── arguments: ∅\n"
else
inspector << "└── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:return_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:return_node
end
end
# Represents the `self` keyword.
#
# self
# ^^^^
class SelfNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_self_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> SelfNode
def copy(**params)
SelfNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:self_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:self_node
end
end
# Represents a singleton class declaration involving the `class` keyword.
#
# class << self end
# ^^^^^^^^^^^^^^^^^
class SingletonClassNode < Node
# attr_reader locals: Array[Symbol]
attr_reader :locals
# attr_reader class_keyword_loc: Location
attr_reader :class_keyword_loc
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader expression: Node
attr_reader :expression
# attr_reader body: Node?
attr_reader :body
# attr_reader end_keyword_loc: Location
attr_reader :end_keyword_loc
# def initialize: (locals: Array[Symbol], class_keyword_loc: Location, operator_loc: Location, expression: Node, body: Node?, end_keyword_loc: Location, location: Location) -> void
def initialize(locals, class_keyword_loc, operator_loc, expression, body, end_keyword_loc, location)
@locals = locals
@class_keyword_loc = class_keyword_loc
@operator_loc = operator_loc
@expression = expression
@body = body
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_singleton_class_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[expression, body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << expression
compact << body if body
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[class_keyword_loc, operator_loc, expression, *body, end_keyword_loc]
end
# def copy: (**params) -> SingletonClassNode
def copy(**params)
SingletonClassNode.new(
params.fetch(:locals) { locals },
params.fetch(:class_keyword_loc) { class_keyword_loc },
params.fetch(:operator_loc) { operator_loc },
params.fetch(:expression) { expression },
params.fetch(:body) { body },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ locals: locals, class_keyword_loc: class_keyword_loc, operator_loc: operator_loc, expression: expression, body: body, end_keyword_loc: end_keyword_loc, location: location }
end
# def class_keyword: () -> String
def class_keyword
class_keyword_loc.slice
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def end_keyword: () -> String
def end_keyword
end_keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── class_keyword_loc: #{inspector.location(class_keyword_loc)}\n"
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
inspector << "├── expression:\n"
inspector << inspector.child_node(expression, "│ ")
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:singleton_class_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:singleton_class_node
end
end
# Represents the use of the `__ENCODING__` keyword.
#
# __ENCODING__
# ^^^^^^^^^^^^
class SourceEncodingNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_source_encoding_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> SourceEncodingNode
def copy(**params)
SourceEncodingNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:source_encoding_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:source_encoding_node
end
end
# Represents the use of the `__FILE__` keyword.
#
# __FILE__
# ^^^^^^^^
class SourceFileNode < Node
# attr_reader filepath: String
attr_reader :filepath
# def initialize: (filepath: String, location: Location) -> void
def initialize(filepath, location)
@filepath = filepath
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_source_file_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> SourceFileNode
def copy(**params)
SourceFileNode.new(
params.fetch(:filepath) { filepath },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ filepath: filepath, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── filepath: #{filepath.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:source_file_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:source_file_node
end
end
# Represents the use of the `__LINE__` keyword.
#
# __LINE__
# ^^^^^^^^
class SourceLineNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_source_line_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> SourceLineNode
def copy(**params)
SourceLineNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:source_line_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:source_line_node
end
end
# Represents the use of the splat operator.
#
# [*a]
# ^^
class SplatNode < Node
# attr_reader operator_loc: Location
attr_reader :operator_loc
# attr_reader expression: Node?
attr_reader :expression
# def initialize: (operator_loc: Location, expression: Node?, location: Location) -> void
def initialize(operator_loc, expression, location)
@operator_loc = operator_loc
@expression = expression
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_splat_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[expression]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << expression if expression
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[operator_loc, *expression]
end
# def copy: (**params) -> SplatNode
def copy(**params)
SplatNode.new(
params.fetch(:operator_loc) { operator_loc },
params.fetch(:expression) { expression },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ operator_loc: operator_loc, expression: expression, location: location }
end
# def operator: () -> String
def operator
operator_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── operator_loc: #{inspector.location(operator_loc)}\n"
if (expression = self.expression).nil?
inspector << "└── expression: ∅\n"
else
inspector << "└── expression:\n"
inspector << expression.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:splat_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:splat_node
end
end
# Represents a set of statements contained within some scope.
#
# foo; bar; baz
# ^^^^^^^^^^^^^
class StatementsNode < Node
# attr_reader body: Array[Node]
attr_reader :body
# def initialize: (body: Array[Node], location: Location) -> void
def initialize(body, location)
@body = body
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_statements_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*body]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*body]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*body]
end
# def copy: (**params) -> StatementsNode
def copy(**params)
StatementsNode.new(
params.fetch(:body) { body },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ body: body, location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "└── body: #{inspector.list("#{inspector.prefix} ", body)}"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:statements_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:statements_node
end
end
# Represents a string literal, a string contained within a `%w` list, or
# plain string content within an interpolated string.
#
# "foo"
# ^^^^^
#
# %w[foo]
# ^^^
#
# "foo #{bar} baz"
# ^^^^ ^^^^
class StringNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader content_loc: Location
attr_reader :content_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# attr_reader unescaped: String
attr_reader :unescaped
# def initialize: (flags: Integer, opening_loc: Location?, content_loc: Location, closing_loc: Location?, unescaped: String, location: Location) -> void
def initialize(flags, opening_loc, content_loc, closing_loc, unescaped, location)
@flags = flags
@opening_loc = opening_loc
@content_loc = content_loc
@closing_loc = closing_loc
@unescaped = unescaped
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_string_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*opening_loc, content_loc, *closing_loc]
end
# def copy: (**params) -> StringNode
def copy(**params)
StringNode.new(
params.fetch(:flags) { flags },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:content_loc) { content_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:unescaped) { unescaped },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end
# def forced_utf8_encoding?: () -> bool
def forced_utf8_encoding?
flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
end
# def forced_binary_encoding?: () -> bool
def forced_binary_encoding?
flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
end
# def frozen?: () -> bool
def frozen?
flags.anybits?(StringFlags::FROZEN)
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def content: () -> String
def content
content_loc.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("frozen" if frozen?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── content_loc: #{inspector.location(content_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "└── unescaped: #{unescaped.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:string_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:string_node
end
end
# Represents the use of the `super` keyword with parentheses or arguments.
#
# super()
# ^^^^^^^
#
# super foo, bar
# ^^^^^^^^^^^^^^
class SuperNode < Node
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader lparen_loc: Location?
attr_reader :lparen_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader rparen_loc: Location?
attr_reader :rparen_loc
# attr_reader block: Node?
attr_reader :block
# def initialize: (keyword_loc: Location, lparen_loc: Location?, arguments: ArgumentsNode?, rparen_loc: Location?, block: Node?, location: Location) -> void
def initialize(keyword_loc, lparen_loc, arguments, rparen_loc, block, location)
@keyword_loc = keyword_loc
@lparen_loc = lparen_loc
@arguments = arguments
@rparen_loc = rparen_loc
@block = block
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_super_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[arguments, block]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << arguments if arguments
compact << block if block
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, *lparen_loc, *arguments, *rparen_loc, *block]
end
# def copy: (**params) -> SuperNode
def copy(**params)
SuperNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:lparen_loc) { lparen_loc },
params.fetch(:arguments) { arguments },
params.fetch(:rparen_loc) { rparen_loc },
params.fetch(:block) { block },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, lparen_loc: lparen_loc, arguments: arguments, rparen_loc: rparen_loc, block: block, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def lparen: () -> String?
def lparen
lparen_loc&.slice
end
# def rparen: () -> String?
def rparen
rparen_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── rparen_loc: #{inspector.location(rparen_loc)}\n"
if (block = self.block).nil?
inspector << "└── block: ∅\n"
else
inspector << "└── block:\n"
inspector << block.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:super_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:super_node
end
end
# Represents a symbol literal or a symbol contained within a `%i` list.
#
# :foo
# ^^^^
#
# %i[foo]
# ^^^
class SymbolNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader opening_loc: Location?
attr_reader :opening_loc
# attr_reader value_loc: Location?
attr_reader :value_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# attr_reader unescaped: String
attr_reader :unescaped
# def initialize: (flags: Integer, opening_loc: Location?, value_loc: Location?, closing_loc: Location?, unescaped: String, location: Location) -> void
def initialize(flags, opening_loc, value_loc, closing_loc, unescaped, location)
@flags = flags
@opening_loc = opening_loc
@value_loc = value_loc
@closing_loc = closing_loc
@unescaped = unescaped
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_symbol_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*opening_loc, *value_loc, *closing_loc]
end
# def copy: (**params) -> SymbolNode
def copy(**params)
SymbolNode.new(
params.fetch(:flags) { flags },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:value_loc) { value_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:unescaped) { unescaped },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, opening_loc: opening_loc, value_loc: value_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end
# def forced_utf8_encoding?: () -> bool
def forced_utf8_encoding?
flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING)
end
# def forced_binary_encoding?: () -> bool
def forced_binary_encoding?
flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING)
end
# def forced_us_ascii_encoding?: () -> bool
def forced_us_ascii_encoding?
flags.anybits?(SymbolFlags::FORCED_US_ASCII_ENCODING)
end
# def opening: () -> String?
def opening
opening_loc&.slice
end
# def value: () -> String?
def value
value_loc&.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("forced_us_ascii_encoding" if forced_us_ascii_encoding?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── value_loc: #{inspector.location(value_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "└── unescaped: #{unescaped.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:symbol_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:symbol_node
end
end
# Represents the use of the literal `true` keyword.
#
# true
# ^^^^
class TrueNode < Node
# def initialize: (location: Location) -> void
def initialize(location)
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_true_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[]
end
# def copy: (**params) -> TrueNode
def copy(**params)
TrueNode.new(
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ location: location }
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:true_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:true_node
end
end
# Represents the use of the `undef` keyword.
#
# undef :foo, :bar, :baz
# ^^^^^^^^^^^^^^^^^^^^^^
class UndefNode < Node
# attr_reader names: Array[Node]
attr_reader :names
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# def initialize: (names: Array[Node], keyword_loc: Location, location: Location) -> void
def initialize(names, keyword_loc, location)
@names = names
@keyword_loc = keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_undef_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*names]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[*names]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[*names, keyword_loc]
end
# def copy: (**params) -> UndefNode
def copy(**params)
UndefNode.new(
params.fetch(:names) { names },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ names: names, keyword_loc: keyword_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── names: #{inspector.list("#{inspector.prefix}│ ", names)}"
inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:undef_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:undef_node
end
end
# Represents the use of the `unless` keyword, either in the block form or the modifier form.
#
# bar unless foo
# ^^^^^^^^^^^^^^
#
# unless foo then bar end
# ^^^^^^^^^^^^^^^^^^^^^^^
class UnlessNode < Node
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader predicate: Node
attr_reader :predicate
# attr_reader then_keyword_loc: Location?
attr_reader :then_keyword_loc
# attr_reader statements: StatementsNode?
attr_reader :statements
# attr_reader consequent: ElseNode?
attr_reader :consequent
# attr_reader end_keyword_loc: Location?
attr_reader :end_keyword_loc
# def initialize: (keyword_loc: Location, predicate: Node, then_keyword_loc: Location?, statements: StatementsNode?, consequent: ElseNode?, end_keyword_loc: Location?, location: Location) -> void
def initialize(keyword_loc, predicate, then_keyword_loc, statements, consequent, end_keyword_loc, location)
@keyword_loc = keyword_loc
@predicate = predicate
@then_keyword_loc = then_keyword_loc
@statements = statements
@consequent = consequent
@end_keyword_loc = end_keyword_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_unless_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
predicate.set_newline_flag(newline_marked)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[predicate, statements, consequent]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << predicate
compact << statements if statements
compact << consequent if consequent
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, predicate, *then_keyword_loc, *statements, *consequent, *end_keyword_loc]
end
# def copy: (**params) -> UnlessNode
def copy(**params)
UnlessNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:predicate) { predicate },
params.fetch(:then_keyword_loc) { then_keyword_loc },
params.fetch(:statements) { statements },
params.fetch(:consequent) { consequent },
params.fetch(:end_keyword_loc) { end_keyword_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, predicate: predicate, then_keyword_loc: then_keyword_loc, statements: statements, consequent: consequent, end_keyword_loc: end_keyword_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def then_keyword: () -> String?
def then_keyword
then_keyword_loc&.slice
end
# def end_keyword: () -> String?
def end_keyword
end_keyword_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── predicate:\n"
inspector << inspector.child_node(predicate, "│ ")
inspector << "├── then_keyword_loc: #{inspector.location(then_keyword_loc)}\n"
if (statements = self.statements).nil?
inspector << "├── statements: ∅\n"
else
inspector << "├── statements:\n"
inspector << statements.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (consequent = self.consequent).nil?
inspector << "├── consequent: ∅\n"
else
inspector << "├── consequent:\n"
inspector << consequent.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:unless_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:unless_node
end
end
# Represents the use of the `until` keyword, either in the block form or the modifier form.
#
# bar until foo
# ^^^^^^^^^^^^^
#
# until foo do bar end
# ^^^^^^^^^^^^^^^^^^^^
class UntilNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# attr_reader predicate: Node
attr_reader :predicate
# attr_reader statements: StatementsNode?
attr_reader :statements
# def initialize: (flags: Integer, keyword_loc: Location, closing_loc: Location?, predicate: Node, statements: StatementsNode?, location: Location) -> void
def initialize(flags, keyword_loc, closing_loc, predicate, statements, location)
@flags = flags
@keyword_loc = keyword_loc
@closing_loc = closing_loc
@predicate = predicate
@statements = statements
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_until_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
predicate.set_newline_flag(newline_marked)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[predicate, statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << predicate
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, *closing_loc, predicate, *statements]
end
# def copy: (**params) -> UntilNode
def copy(**params)
UntilNode.new(
params.fetch(:flags) { flags },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:predicate) { predicate },
params.fetch(:statements) { statements },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements, location: location }
end
# def begin_modifier?: () -> bool
def begin_modifier?
flags.anybits?(LoopFlags::BEGIN_MODIFIER)
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("begin_modifier" if begin_modifier?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "├── predicate:\n"
inspector << inspector.child_node(predicate, "│ ")
if (statements = self.statements).nil?
inspector << "└── statements: ∅\n"
else
inspector << "└── statements:\n"
inspector << statements.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:until_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:until_node
end
end
# Represents the use of the `when` keyword within a case statement.
#
# case true
# when true
# ^^^^^^^^^
# end
class WhenNode < Node
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader conditions: Array[Node]
attr_reader :conditions
# attr_reader statements: StatementsNode?
attr_reader :statements
# def initialize: (keyword_loc: Location, conditions: Array[Node], statements: StatementsNode?, location: Location) -> void
def initialize(keyword_loc, conditions, statements, location)
@keyword_loc = keyword_loc
@conditions = conditions
@statements = statements
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_when_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[*conditions, statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact.concat(conditions)
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, *conditions, *statements]
end
# def copy: (**params) -> WhenNode
def copy(**params)
WhenNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:conditions) { conditions },
params.fetch(:statements) { statements },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, conditions: conditions, statements: statements, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── conditions: #{inspector.list("#{inspector.prefix}│ ", conditions)}"
if (statements = self.statements).nil?
inspector << "└── statements: ∅\n"
else
inspector << "└── statements:\n"
inspector << statements.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:when_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:when_node
end
end
# Represents the use of the `while` keyword, either in the block form or the modifier form.
#
# bar while foo
# ^^^^^^^^^^^^^
#
# while foo do bar end
# ^^^^^^^^^^^^^^^^^^^^
class WhileNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader closing_loc: Location?
attr_reader :closing_loc
# attr_reader predicate: Node
attr_reader :predicate
# attr_reader statements: StatementsNode?
attr_reader :statements
# def initialize: (flags: Integer, keyword_loc: Location, closing_loc: Location?, predicate: Node, statements: StatementsNode?, location: Location) -> void
def initialize(flags, keyword_loc, closing_loc, predicate, statements, location)
@flags = flags
@keyword_loc = keyword_loc
@closing_loc = closing_loc
@predicate = predicate
@statements = statements
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_while_node(self)
end
def set_newline_flag(newline_marked) # :nodoc:
predicate.set_newline_flag(newline_marked)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[predicate, statements]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << predicate
compact << statements if statements
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, *closing_loc, predicate, *statements]
end
# def copy: (**params) -> WhileNode
def copy(**params)
WhileNode.new(
params.fetch(:flags) { flags },
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:predicate) { predicate },
params.fetch(:statements) { statements },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements, location: location }
end
# def begin_modifier?: () -> bool
def begin_modifier?
flags.anybits?(LoopFlags::BEGIN_MODIFIER)
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def closing: () -> String?
def closing
closing_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("begin_modifier" if begin_modifier?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "├── predicate:\n"
inspector << inspector.child_node(predicate, "│ ")
if (statements = self.statements).nil?
inspector << "└── statements: ∅\n"
else
inspector << "└── statements:\n"
inspector << statements.inspect(inspector.child_inspector(" ")).delete_prefix(inspector.prefix)
end
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:while_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:while_node
end
end
# Represents an xstring literal with no interpolation.
#
# `foo`
# ^^^^^
class XStringNode < Node
# attr_reader flags: Integer
private attr_reader :flags
# attr_reader opening_loc: Location
attr_reader :opening_loc
# attr_reader content_loc: Location
attr_reader :content_loc
# attr_reader closing_loc: Location
attr_reader :closing_loc
# attr_reader unescaped: String
attr_reader :unescaped
# def initialize: (flags: Integer, opening_loc: Location, content_loc: Location, closing_loc: Location, unescaped: String, location: Location) -> void
def initialize(flags, opening_loc, content_loc, closing_loc, unescaped, location)
@flags = flags
@opening_loc = opening_loc
@content_loc = content_loc
@closing_loc = closing_loc
@unescaped = unescaped
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_x_string_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
[]
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[opening_loc, content_loc, closing_loc]
end
# def copy: (**params) -> XStringNode
def copy(**params)
XStringNode.new(
params.fetch(:flags) { flags },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:content_loc) { content_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:unescaped) { unescaped },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end
# def forced_utf8_encoding?: () -> bool
def forced_utf8_encoding?
flags.anybits?(EncodingFlags::FORCED_UTF8_ENCODING)
end
# def forced_binary_encoding?: () -> bool
def forced_binary_encoding?
flags.anybits?(EncodingFlags::FORCED_BINARY_ENCODING)
end
# def opening: () -> String
def opening
opening_loc.slice
end
# def content: () -> String
def content
content_loc.slice
end
# def closing: () -> String
def closing
closing_loc.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
flags = [("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?)].compact
inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "├── content_loc: #{inspector.location(content_loc)}\n"
inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
inspector << "└── unescaped: #{unescaped.inspect}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:x_string_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:x_string_node
end
end
# Represents the use of the `yield` keyword.
#
# yield 1
# ^^^^^^^
class YieldNode < Node
# attr_reader keyword_loc: Location
attr_reader :keyword_loc
# attr_reader lparen_loc: Location?
attr_reader :lparen_loc
# attr_reader arguments: ArgumentsNode?
attr_reader :arguments
# attr_reader rparen_loc: Location?
attr_reader :rparen_loc
# def initialize: (keyword_loc: Location, lparen_loc: Location?, arguments: ArgumentsNode?, rparen_loc: Location?, location: Location) -> void
def initialize(keyword_loc, lparen_loc, arguments, rparen_loc, location)
@keyword_loc = keyword_loc
@lparen_loc = lparen_loc
@arguments = arguments
@rparen_loc = rparen_loc
@location = location
end
# def accept: (visitor: Visitor) -> void
def accept(visitor)
visitor.visit_yield_node(self)
end
# def child_nodes: () -> Array[nil | Node]
def child_nodes
[arguments]
end
# def compact_child_nodes: () -> Array[Node]
def compact_child_nodes
compact = []
compact << arguments if arguments
compact
end
# def comment_targets: () -> Array[Node | Location]
def comment_targets
[keyword_loc, *lparen_loc, *arguments, *rparen_loc]
end
# def copy: (**params) -> YieldNode
def copy(**params)
YieldNode.new(
params.fetch(:keyword_loc) { keyword_loc },
params.fetch(:lparen_loc) { lparen_loc },
params.fetch(:arguments) { arguments },
params.fetch(:rparen_loc) { rparen_loc },
params.fetch(:location) { location },
)
end
# def deconstruct: () -> Array[nil | Node]
alias deconstruct child_nodes
# def deconstruct_keys: (keys: Array[Symbol]) -> Hash[Symbol, nil | Node | Array[Node] | String | Token | Array[Token] | Location]
def deconstruct_keys(keys)
{ keyword_loc: keyword_loc, lparen_loc: lparen_loc, arguments: arguments, rparen_loc: rparen_loc, location: location }
end
# def keyword: () -> String
def keyword
keyword_loc.slice
end
# def lparen: () -> String?
def lparen
lparen_loc&.slice
end
# def rparen: () -> String?
def rparen
rparen_loc&.slice
end
# def inspect(inspector: NodeInspector) -> String
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
inspector << "├── lparen_loc: #{inspector.location(lparen_loc)}\n"
if (arguments = self.arguments).nil?
inspector << "├── arguments: ∅\n"
else
inspector << "├── arguments:\n"
inspector << arguments.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "└── rparen_loc: #{inspector.location(rparen_loc)}\n"
inspector.to_str
end
# Sometimes you want to check an instance of a node against a list of
# classes to see what kind of behavior to perform. Usually this is done by
# calling `[cls1, cls2].include?(node.class)` or putting the node into a
# case statement and doing `case node; when cls1; when cls2; end`. Both of
# these approaches are relatively slow because of the constant lookups,
# method calls, and/or array allocations.
#
# Instead, you can call #type, which will return to you a symbol that you
# can use for comparison. This is faster than the other approaches because
# it uses a single integer comparison, but also because if you're on CRuby
# you can take advantage of the fact that case statements with all symbol
# keys will use a jump table.
#
# def type: () -> Symbol
def type
:yield_node
end
# Similar to #type, this method returns a symbol that you can use for
# splitting on the type of the node without having to do a long === chain.
# Note that like #type, it will still be slower than using == for a single
# class, but should be faster in a case statement or an array comparison.
#
# def self.type: () -> Symbol
def self.type
:yield_node
end
end
# Flags for arguments nodes.
module ArgumentsNodeFlags
# if arguments contain keyword splat
CONTAINS_KEYWORD_SPLAT = 1 << 0
end
# Flags for array nodes.
module ArrayNodeFlags
# if array contains splat nodes
CONTAINS_SPLAT = 1 << 0
end
# Flags for call nodes.
module CallNodeFlags
# &. operator
SAFE_NAVIGATION = 1 << 0
# a call that could have been a local variable
VARIABLE_CALL = 1 << 1
# a call that is an attribute write, so the value being written should be returned
ATTRIBUTE_WRITE = 1 << 2
end
# Flags for nodes that have unescaped content.
module EncodingFlags
# internal bytes forced the encoding to UTF-8
FORCED_UTF8_ENCODING = 1 << 0
# internal bytes forced the encoding to binary
FORCED_BINARY_ENCODING = 1 << 1
end
# Flags for integer nodes that correspond to the base of the integer.
module IntegerBaseFlags
# 0b prefix
BINARY = 1 << 0
# 0d or no prefix
DECIMAL = 1 << 1
# 0o or 0 prefix
OCTAL = 1 << 2
# 0x prefix
HEXADECIMAL = 1 << 3
end
# Flags for keyword hash nodes.
module KeywordHashNodeFlags
# a keyword hash which only has `AssocNode` elements all with static literal keys, which means the elements can be treated as keyword arguments
STATIC_KEYS = 1 << 0
end
# Flags for while and until loop nodes.
module LoopFlags
# a loop after a begin statement, so the body is executed first before the condition
BEGIN_MODIFIER = 1 << 0
end
# Flags for range and flip-flop nodes.
module RangeFlags
# ... operator
EXCLUDE_END = 1 << 0
end
# Flags for regular expression and match last line nodes.
module RegularExpressionFlags
# i - ignores the case of characters when matching
IGNORE_CASE = 1 << 0
# x - ignores whitespace and allows comments in regular expressions
EXTENDED = 1 << 1
# m - allows $ to match the end of lines within strings
MULTI_LINE = 1 << 2
# o - only interpolates values into the regular expression once
ONCE = 1 << 3
# e - forces the EUC-JP encoding
EUC_JP = 1 << 4
# n - forces the ASCII-8BIT encoding
ASCII_8BIT = 1 << 5
# s - forces the Windows-31J encoding
WINDOWS_31J = 1 << 6
# u - forces the UTF-8 encoding
UTF_8 = 1 << 7
# internal bytes forced the encoding to UTF-8
FORCED_UTF8_ENCODING = 1 << 8
# internal bytes forced the encoding to binary
FORCED_BINARY_ENCODING = 1 << 9
# internal bytes forced the encoding to US-ASCII
FORCED_US_ASCII_ENCODING = 1 << 10
end
# Flags for string nodes.
module StringFlags
# internal bytes forced the encoding to UTF-8
FORCED_UTF8_ENCODING = 1 << 0
# internal bytes forced the encoding to binary
FORCED_BINARY_ENCODING = 1 << 1
# frozen by virtue of a `frozen_string_literal` comment
FROZEN = 1 << 2
end
# Flags for symbol nodes.
module SymbolFlags
# internal bytes forced the encoding to UTF-8
FORCED_UTF8_ENCODING = 1 << 0
# internal bytes forced the encoding to binary
FORCED_BINARY_ENCODING = 1 << 1
# internal bytes forced the encoding to US-ASCII
FORCED_US_ASCII_ENCODING = 1 << 2
end
end
share/ruby/prism/desugar_compiler.rb 0000644 00000013333 15173517735 0013653 0 ustar 00 # frozen_string_literal: true
module Prism
# DesugarCompiler is a compiler that desugars Ruby code into a more primitive
# form. This is useful for consumers that want to deal with fewer node types.
class DesugarCompiler < MutationCompiler
# @@foo &&= bar
#
# becomes
#
# @@foo && @@foo = bar
def visit_class_variable_and_write_node(node)
desugar_and_write_node(node, ClassVariableReadNode, ClassVariableWriteNode, node.name)
end
# @@foo ||= bar
#
# becomes
#
# defined?(@@foo) ? @@foo : @@foo = bar
def visit_class_variable_or_write_node(node)
desugar_or_write_defined_node(node, ClassVariableReadNode, ClassVariableWriteNode, node.name)
end
# @@foo += bar
#
# becomes
#
# @@foo = @@foo + bar
def visit_class_variable_operator_write_node(node)
desugar_operator_write_node(node, ClassVariableReadNode, ClassVariableWriteNode, node.name)
end
# Foo &&= bar
#
# becomes
#
# Foo && Foo = bar
def visit_constant_and_write_node(node)
desugar_and_write_node(node, ConstantReadNode, ConstantWriteNode, node.name)
end
# Foo ||= bar
#
# becomes
#
# defined?(Foo) ? Foo : Foo = bar
def visit_constant_or_write_node(node)
desugar_or_write_defined_node(node, ConstantReadNode, ConstantWriteNode, node.name)
end
# Foo += bar
#
# becomes
#
# Foo = Foo + bar
def visit_constant_operator_write_node(node)
desugar_operator_write_node(node, ConstantReadNode, ConstantWriteNode, node.name)
end
# $foo &&= bar
#
# becomes
#
# $foo && $foo = bar
def visit_global_variable_and_write_node(node)
desugar_and_write_node(node, GlobalVariableReadNode, GlobalVariableWriteNode, node.name)
end
# $foo ||= bar
#
# becomes
#
# defined?($foo) ? $foo : $foo = bar
def visit_global_variable_or_write_node(node)
desugar_or_write_defined_node(node, GlobalVariableReadNode, GlobalVariableWriteNode, node.name)
end
# $foo += bar
#
# becomes
#
# $foo = $foo + bar
def visit_global_variable_operator_write_node(node)
desugar_operator_write_node(node, GlobalVariableReadNode, GlobalVariableWriteNode, node.name)
end
# @foo &&= bar
#
# becomes
#
# @foo && @foo = bar
def visit_instance_variable_and_write_node(node)
desugar_and_write_node(node, InstanceVariableReadNode, InstanceVariableWriteNode, node.name)
end
# @foo ||= bar
#
# becomes
#
# @foo || @foo = bar
def visit_instance_variable_or_write_node(node)
desugar_or_write_node(node, InstanceVariableReadNode, InstanceVariableWriteNode, node.name)
end
# @foo += bar
#
# becomes
#
# @foo = @foo + bar
def visit_instance_variable_operator_write_node(node)
desugar_operator_write_node(node, InstanceVariableReadNode, InstanceVariableWriteNode, node.name)
end
# foo &&= bar
#
# becomes
#
# foo && foo = bar
def visit_local_variable_and_write_node(node)
desugar_and_write_node(node, LocalVariableReadNode, LocalVariableWriteNode, node.name, node.depth)
end
# foo ||= bar
#
# becomes
#
# foo || foo = bar
def visit_local_variable_or_write_node(node)
desugar_or_write_node(node, LocalVariableReadNode, LocalVariableWriteNode, node.name, node.depth)
end
# foo += bar
#
# becomes
#
# foo = foo + bar
def visit_local_variable_operator_write_node(node)
desugar_operator_write_node(node, LocalVariableReadNode, LocalVariableWriteNode, node.name, node.depth)
end
private
# Desugar `x &&= y` to `x && x = y`
def desugar_and_write_node(node, read_class, write_class, *arguments)
AndNode.new(
read_class.new(*arguments, node.name_loc),
write_class.new(*arguments, node.name_loc, node.value, node.operator_loc, node.location),
node.operator_loc,
node.location
)
end
# Desugar `x += y` to `x = x + y`
def desugar_operator_write_node(node, read_class, write_class, *arguments)
write_class.new(
*arguments,
node.name_loc,
CallNode.new(
0,
read_class.new(*arguments, node.name_loc),
nil,
node.operator_loc.slice.chomp("="),
node.operator_loc.copy(length: node.operator_loc.length - 1),
nil,
ArgumentsNode.new(0, [node.value], node.value.location),
nil,
nil,
node.location
),
node.operator_loc.copy(start_offset: node.operator_loc.end_offset - 1, length: 1),
node.location
)
end
# Desugar `x ||= y` to `x || x = y`
def desugar_or_write_node(node, read_class, write_class, *arguments)
OrNode.new(
read_class.new(*arguments, node.name_loc),
write_class.new(*arguments, node.name_loc, node.value, node.operator_loc, node.location),
node.operator_loc,
node.location
)
end
# Desugar `x ||= y` to `defined?(x) ? x : x = y`
def desugar_or_write_defined_node(node, read_class, write_class, *arguments)
IfNode.new(
node.operator_loc,
DefinedNode.new(nil, read_class.new(*arguments, node.name_loc), nil, node.operator_loc, node.name_loc),
node.operator_loc,
StatementsNode.new([read_class.new(*arguments, node.name_loc)], node.location),
ElseNode.new(
node.operator_loc,
StatementsNode.new(
[write_class.new(*arguments, node.name_loc, node.value, node.operator_loc, node.location)],
node.location
),
node.operator_loc,
node.location
),
node.operator_loc,
node.location
)
end
end
end
share/ruby/prism/lex_compat.rb 0000644 00000076047 15173517735 0012475 0 ustar 00 # frozen_string_literal: true
require "delegate"
module Prism
# This class is responsible for lexing the source using prism and then
# converting those tokens to be compatible with Ripper. In the vast majority
# of cases, this is a one-to-one mapping of the token type. Everything else
# generally lines up. However, there are a few cases that require special
# handling.
class LexCompat # :nodoc:
# This is a mapping of prism token types to Ripper token types. This is a
# many-to-one mapping because we split up our token types, whereas Ripper
# tends to group them.
RIPPER = {
AMPERSAND: :on_op,
AMPERSAND_AMPERSAND: :on_op,
AMPERSAND_AMPERSAND_EQUAL: :on_op,
AMPERSAND_DOT: :on_op,
AMPERSAND_EQUAL: :on_op,
BACK_REFERENCE: :on_backref,
BACKTICK: :on_backtick,
BANG: :on_op,
BANG_EQUAL: :on_op,
BANG_TILDE: :on_op,
BRACE_LEFT: :on_lbrace,
BRACE_RIGHT: :on_rbrace,
BRACKET_LEFT: :on_lbracket,
BRACKET_LEFT_ARRAY: :on_lbracket,
BRACKET_LEFT_RIGHT: :on_op,
BRACKET_LEFT_RIGHT_EQUAL: :on_op,
BRACKET_RIGHT: :on_rbracket,
CARET: :on_op,
CARET_EQUAL: :on_op,
CHARACTER_LITERAL: :on_CHAR,
CLASS_VARIABLE: :on_cvar,
COLON: :on_op,
COLON_COLON: :on_op,
COMMA: :on_comma,
COMMENT: :on_comment,
CONSTANT: :on_const,
DOT: :on_period,
DOT_DOT: :on_op,
DOT_DOT_DOT: :on_op,
EMBDOC_BEGIN: :on_embdoc_beg,
EMBDOC_END: :on_embdoc_end,
EMBDOC_LINE: :on_embdoc,
EMBEXPR_BEGIN: :on_embexpr_beg,
EMBEXPR_END: :on_embexpr_end,
EMBVAR: :on_embvar,
EOF: :on_eof,
EQUAL: :on_op,
EQUAL_EQUAL: :on_op,
EQUAL_EQUAL_EQUAL: :on_op,
EQUAL_GREATER: :on_op,
EQUAL_TILDE: :on_op,
FLOAT: :on_float,
FLOAT_IMAGINARY: :on_imaginary,
FLOAT_RATIONAL: :on_rational,
FLOAT_RATIONAL_IMAGINARY: :on_imaginary,
GREATER: :on_op,
GREATER_EQUAL: :on_op,
GREATER_GREATER: :on_op,
GREATER_GREATER_EQUAL: :on_op,
GLOBAL_VARIABLE: :on_gvar,
HEREDOC_END: :on_heredoc_end,
HEREDOC_START: :on_heredoc_beg,
IDENTIFIER: :on_ident,
IGNORED_NEWLINE: :on_ignored_nl,
INTEGER: :on_int,
INTEGER_IMAGINARY: :on_imaginary,
INTEGER_RATIONAL: :on_rational,
INTEGER_RATIONAL_IMAGINARY: :on_imaginary,
INSTANCE_VARIABLE: :on_ivar,
INVALID: :INVALID,
KEYWORD___ENCODING__: :on_kw,
KEYWORD___LINE__: :on_kw,
KEYWORD___FILE__: :on_kw,
KEYWORD_ALIAS: :on_kw,
KEYWORD_AND: :on_kw,
KEYWORD_BEGIN: :on_kw,
KEYWORD_BEGIN_UPCASE: :on_kw,
KEYWORD_BREAK: :on_kw,
KEYWORD_CASE: :on_kw,
KEYWORD_CLASS: :on_kw,
KEYWORD_DEF: :on_kw,
KEYWORD_DEFINED: :on_kw,
KEYWORD_DO: :on_kw,
KEYWORD_DO_LOOP: :on_kw,
KEYWORD_ELSE: :on_kw,
KEYWORD_ELSIF: :on_kw,
KEYWORD_END: :on_kw,
KEYWORD_END_UPCASE: :on_kw,
KEYWORD_ENSURE: :on_kw,
KEYWORD_FALSE: :on_kw,
KEYWORD_FOR: :on_kw,
KEYWORD_IF: :on_kw,
KEYWORD_IF_MODIFIER: :on_kw,
KEYWORD_IN: :on_kw,
KEYWORD_MODULE: :on_kw,
KEYWORD_NEXT: :on_kw,
KEYWORD_NIL: :on_kw,
KEYWORD_NOT: :on_kw,
KEYWORD_OR: :on_kw,
KEYWORD_REDO: :on_kw,
KEYWORD_RESCUE: :on_kw,
KEYWORD_RESCUE_MODIFIER: :on_kw,
KEYWORD_RETRY: :on_kw,
KEYWORD_RETURN: :on_kw,
KEYWORD_SELF: :on_kw,
KEYWORD_SUPER: :on_kw,
KEYWORD_THEN: :on_kw,
KEYWORD_TRUE: :on_kw,
KEYWORD_UNDEF: :on_kw,
KEYWORD_UNLESS: :on_kw,
KEYWORD_UNLESS_MODIFIER: :on_kw,
KEYWORD_UNTIL: :on_kw,
KEYWORD_UNTIL_MODIFIER: :on_kw,
KEYWORD_WHEN: :on_kw,
KEYWORD_WHILE: :on_kw,
KEYWORD_WHILE_MODIFIER: :on_kw,
KEYWORD_YIELD: :on_kw,
LABEL: :on_label,
LABEL_END: :on_label_end,
LAMBDA_BEGIN: :on_tlambeg,
LESS: :on_op,
LESS_EQUAL: :on_op,
LESS_EQUAL_GREATER: :on_op,
LESS_LESS: :on_op,
LESS_LESS_EQUAL: :on_op,
METHOD_NAME: :on_ident,
MINUS: :on_op,
MINUS_EQUAL: :on_op,
MINUS_GREATER: :on_tlambda,
NEWLINE: :on_nl,
NUMBERED_REFERENCE: :on_backref,
PARENTHESIS_LEFT: :on_lparen,
PARENTHESIS_LEFT_PARENTHESES: :on_lparen,
PARENTHESIS_RIGHT: :on_rparen,
PERCENT: :on_op,
PERCENT_EQUAL: :on_op,
PERCENT_LOWER_I: :on_qsymbols_beg,
PERCENT_LOWER_W: :on_qwords_beg,
PERCENT_LOWER_X: :on_backtick,
PERCENT_UPPER_I: :on_symbols_beg,
PERCENT_UPPER_W: :on_words_beg,
PIPE: :on_op,
PIPE_EQUAL: :on_op,
PIPE_PIPE: :on_op,
PIPE_PIPE_EQUAL: :on_op,
PLUS: :on_op,
PLUS_EQUAL: :on_op,
QUESTION_MARK: :on_op,
RATIONAL_FLOAT: :on_rational,
RATIONAL_INTEGER: :on_rational,
REGEXP_BEGIN: :on_regexp_beg,
REGEXP_END: :on_regexp_end,
SEMICOLON: :on_semicolon,
SLASH: :on_op,
SLASH_EQUAL: :on_op,
STAR: :on_op,
STAR_EQUAL: :on_op,
STAR_STAR: :on_op,
STAR_STAR_EQUAL: :on_op,
STRING_BEGIN: :on_tstring_beg,
STRING_CONTENT: :on_tstring_content,
STRING_END: :on_tstring_end,
SYMBOL_BEGIN: :on_symbeg,
TILDE: :on_op,
UAMPERSAND: :on_op,
UCOLON_COLON: :on_op,
UDOT_DOT: :on_op,
UDOT_DOT_DOT: :on_op,
UMINUS: :on_op,
UMINUS_NUM: :on_op,
UPLUS: :on_op,
USTAR: :on_op,
USTAR_STAR: :on_op,
WORDS_SEP: :on_words_sep,
"__END__": :on___end__
}.freeze
# When we produce tokens, we produce the same arrays that Ripper does.
# However, we add a couple of convenience methods onto them to make them a
# little easier to work with. We delegate all other methods to the array.
class Token < SimpleDelegator
# The location of the token in the source.
def location
self[0]
end
# The type of the token.
def event
self[1]
end
# The slice of the source that this token represents.
def value
self[2]
end
# The state of the lexer when this token was produced.
def state
self[3]
end
end
# Ripper doesn't include the rest of the token in the event, so we need to
# trim it down to just the content on the first line when comparing.
class EndContentToken < Token
def ==(other) # :nodoc:
[self[0], self[1], self[2][0..self[2].index("\n")], self[3]] == other
end
end
# Tokens where state should be ignored
# used for :on_comment, :on_heredoc_end, :on_embexpr_end
class IgnoreStateToken < Token
def ==(other) # :nodoc:
self[0...-1] == other[0...-1]
end
end
# Ident tokens for the most part are exactly the same, except sometimes we
# know an ident is a local when ripper doesn't (when they are introduced
# through named captures in regular expressions). In that case we don't
# compare the state.
class IdentToken < Token
def ==(other) # :nodoc:
(self[0...-1] == other[0...-1]) && (
(other[3] == Ripper::EXPR_LABEL | Ripper::EXPR_END) ||
(other[3] & Ripper::EXPR_ARG_ANY != 0)
)
end
end
# Ignored newlines can occasionally have a LABEL state attached to them, so
# we compare the state differently here.
class IgnoredNewlineToken < Token
def ==(other) # :nodoc:
return false unless self[0...-1] == other[0...-1]
if self[4] == Ripper::EXPR_ARG | Ripper::EXPR_LABELED
other[4] & Ripper::EXPR_ARG | Ripper::EXPR_LABELED > 0
else
self[4] == other[4]
end
end
end
# If we have an identifier that follows a method name like:
#
# def foo bar
#
# then Ripper will mark bar as END|LABEL if there is a local in a parent
# scope named bar because it hasn't pushed the local table yet. We do this
# more accurately, so we need to allow comparing against both END and
# END|LABEL.
class ParamToken < Token
def ==(other) # :nodoc:
(self[0...-1] == other[0...-1]) && (
(other[3] == Ripper::EXPR_END) ||
(other[3] == Ripper::EXPR_END | Ripper::EXPR_LABEL)
)
end
end
# A heredoc in this case is a list of tokens that belong to the body of the
# heredoc that should be appended onto the list of tokens when the heredoc
# closes.
module Heredoc # :nodoc:
# Heredocs that are no dash or tilde heredocs are just a list of tokens.
# We need to keep them around so that we can insert them in the correct
# order back into the token stream and set the state of the last token to
# the state that the heredoc was opened in.
class PlainHeredoc # :nodoc:
attr_reader :tokens
def initialize
@tokens = []
end
def <<(token)
tokens << token
end
def to_a
tokens
end
end
# Dash heredocs are a little more complicated. They are a list of tokens
# that need to be split on "\\\n" to mimic Ripper's behavior. We also need
# to keep track of the state that the heredoc was opened in.
class DashHeredoc # :nodoc:
attr_reader :split, :tokens
def initialize(split)
@split = split
@tokens = []
end
def <<(token)
tokens << token
end
def to_a
embexpr_balance = 0
tokens.each_with_object([]) do |token, results|
case token.event
when :on_embexpr_beg
embexpr_balance += 1
results << token
when :on_embexpr_end
embexpr_balance -= 1
results << token
when :on_tstring_content
if embexpr_balance == 0
lineno = token[0][0]
column = token[0][1]
if split
# Split on "\\\n" to mimic Ripper's behavior. Use a lookbehind
# to keep the delimiter in the result.
token.value.split(/(?<=[^\\]\\\n)|(?<=[^\\]\\\r\n)/).each_with_index do |value, index|
column = 0 if index > 0
results << Token.new([[lineno, column], :on_tstring_content, value, token.state])
lineno += value.count("\n")
end
else
results << token
end
else
results << token
end
else
results << token
end
end
end
end
# Heredocs that are dedenting heredocs are a little more complicated.
# Ripper outputs on_ignored_sp tokens for the whitespace that is being
# removed from the output. prism only modifies the node itself and keeps
# the token the same. This simplifies prism, but makes comparing against
# Ripper much harder because there is a length mismatch.
#
# Fortunately, we already have to pull out the heredoc tokens in order to
# insert them into the stream in the correct order. As such, we can do
# some extra manipulation on the tokens to make them match Ripper's
# output by mirroring the dedent logic that Ripper uses.
class DedentingHeredoc # :nodoc:
TAB_WIDTH = 8
attr_reader :tokens, :dedent_next, :dedent, :embexpr_balance
def initialize
@tokens = []
@dedent_next = true
@dedent = nil
@embexpr_balance = 0
@ended_on_newline = false
end
# As tokens are coming in, we track the minimum amount of common leading
# whitespace on plain string content tokens. This allows us to later
# remove that amount of whitespace from the beginning of each line.
def <<(token)
case token.event
when :on_embexpr_beg, :on_heredoc_beg
@embexpr_balance += 1
@dedent = 0 if @dedent_next && @ended_on_newline
when :on_embexpr_end, :on_heredoc_end
@embexpr_balance -= 1
when :on_tstring_content
if embexpr_balance == 0
line = token.value
if dedent_next && !(line.strip.empty? && line.end_with?("\n"))
leading = line[/\A(\s*)\n?/, 1]
next_dedent = 0
leading.each_char do |char|
if char == "\t"
next_dedent = next_dedent - (next_dedent % TAB_WIDTH) + TAB_WIDTH
else
next_dedent += 1
end
end
@dedent = [dedent, next_dedent].compact.min
@dedent_next = true
@ended_on_newline = line.end_with?("\n")
tokens << token
return
end
end
end
@dedent_next = token.event == :on_tstring_content && embexpr_balance == 0
@ended_on_newline = false
tokens << token
end
def to_a
# If every line in the heredoc is blank, we still need to split up the
# string content token into multiple tokens.
if dedent.nil?
results = []
embexpr_balance = 0
tokens.each do |token|
case token.event
when :on_embexpr_beg, :on_heredoc_beg
embexpr_balance += 1
results << token
when :on_embexpr_end, :on_heredoc_end
embexpr_balance -= 1
results << token
when :on_tstring_content
if embexpr_balance == 0
lineno = token[0][0]
column = token[0][1]
token.value.split(/(?<=\n)/).each_with_index do |value, index|
column = 0 if index > 0
results << Token.new([[lineno, column], :on_tstring_content, value, token.state])
lineno += 1
end
else
results << token
end
else
results << token
end
end
return results
end
# If the minimum common whitespace is 0, then we need to concatenate
# string nodes together that are immediately adjacent.
if dedent == 0
results = []
embexpr_balance = 0
index = 0
max_index = tokens.length
while index < max_index
token = tokens[index]
results << token
index += 1
case token.event
when :on_embexpr_beg, :on_heredoc_beg
embexpr_balance += 1
when :on_embexpr_end, :on_heredoc_end
embexpr_balance -= 1
when :on_tstring_content
if embexpr_balance == 0
while index < max_index && tokens[index].event == :on_tstring_content
token.value << tokens[index].value
index += 1
end
end
end
end
return results
end
# Otherwise, we're going to run through each token in the list and
# insert on_ignored_sp tokens for the amount of dedent that we need to
# perform. We also need to remove the dedent from the beginning of
# each line of plain string content tokens.
results = []
dedent_next = true
embexpr_balance = 0
tokens.each do |token|
# Notice that the structure of this conditional largely matches the
# whitespace calculation we performed above. This is because
# checking if the subsequent token needs to be dedented is common to
# both the dedent calculation and the ignored_sp insertion.
case token.event
when :on_embexpr_beg
embexpr_balance += 1
results << token
when :on_embexpr_end
embexpr_balance -= 1
results << token
when :on_tstring_content
if embexpr_balance == 0
# Here we're going to split the string on newlines, but maintain
# the newlines in the resulting array. We'll do that with a look
# behind assertion.
splits = token.value.split(/(?<=\n)/)
index = 0
while index < splits.length
line = splits[index]
lineno = token[0][0] + index
column = token[0][1]
# Blank lines do not count toward common leading whitespace
# calculation and do not need to be dedented.
if dedent_next || index > 0
column = 0
end
# If the dedent is 0 and we're not supposed to dedent the next
# line or this line doesn't start with whitespace, then we
# should concatenate the rest of the string to match ripper.
if dedent == 0 && (!dedent_next || !line.start_with?(/\s/))
line = splits[index..].join
index = splits.length
end
# If we are supposed to dedent this line or if this is not the
# first line of the string and this line isn't entirely blank,
# then we need to insert an on_ignored_sp token and remove the
# dedent from the beginning of the line.
if (dedent > 0) && (dedent_next || index > 0)
deleting = 0
deleted_chars = []
# Gather up all of the characters that we're going to
# delete, stopping when you hit a character that would put
# you over the dedent amount.
line.each_char.with_index do |char, i|
case char
when "\r"
if line[i + 1] == "\n"
break
end
when "\n"
break
when "\t"
deleting = deleting - (deleting % TAB_WIDTH) + TAB_WIDTH
else
deleting += 1
end
break if deleting > dedent
deleted_chars << char
end
# If we have something to delete, then delete it from the
# string and insert an on_ignored_sp token.
if deleted_chars.any?
ignored = deleted_chars.join
line.delete_prefix!(ignored)
results << Token.new([[lineno, 0], :on_ignored_sp, ignored, token[3]])
column = ignored.length
end
end
results << Token.new([[lineno, column], token[1], line, token[3]]) unless line.empty?
index += 1
end
else
results << token
end
else
results << token
end
dedent_next =
((token.event == :on_tstring_content) || (token.event == :on_heredoc_end)) &&
embexpr_balance == 0
end
results
end
end
# Here we will split between the two types of heredocs and return the
# object that will store their tokens.
def self.build(opening)
case opening.value[2]
when "~"
DedentingHeredoc.new
when "-"
DashHeredoc.new(opening.value[3] != "'")
else
PlainHeredoc.new
end
end
end
private_constant :Heredoc
attr_reader :source, :options
def initialize(source, **options)
@source = source
@options = options
end
def result
tokens = []
state = :default
heredoc_stack = [[]]
result = Prism.lex(source, **options)
result_value = result.value
previous_state = nil
last_heredoc_end = nil
# In previous versions of Ruby, Ripper wouldn't flush the bom before the
# first token, so we had to have a hack in place to account for that. This
# checks for that behavior.
bom_flushed = Ripper.lex("\xEF\xBB\xBF# test")[0][0][1] == 0
bom = source.byteslice(0..2) == "\xEF\xBB\xBF"
result_value.each_with_index do |(token, lex_state), index|
lineno = token.location.start_line
column = token.location.start_column
# If there's a UTF-8 byte-order mark as the start of the file, then for
# certain tokens ripper sets the first token back by 3 bytes. It also
# keeps the byte order mark in the first token's value. This is weird,
# and I don't want to mirror that in our parser. So instead, we'll match
# up the columns and values here.
if bom && lineno == 1
column -= 3
if index == 0 && column == 0 && !bom_flushed
flushed =
case token.type
when :BACK_REFERENCE, :INSTANCE_VARIABLE, :CLASS_VARIABLE,
:GLOBAL_VARIABLE, :NUMBERED_REFERENCE, :PERCENT_LOWER_I,
:PERCENT_LOWER_X, :PERCENT_LOWER_W, :PERCENT_UPPER_I,
:PERCENT_UPPER_W, :STRING_BEGIN
true
when :REGEXP_BEGIN, :SYMBOL_BEGIN
token.value.start_with?("%")
else
false
end
unless flushed
column -= 3
value = token.value
value.prepend(String.new("\xEF\xBB\xBF", encoding: value.encoding))
end
end
end
event = RIPPER.fetch(token.type)
value = token.value
lex_state = Ripper::Lexer::State.new(lex_state)
token =
case event
when :on___end__
EndContentToken.new([[lineno, column], event, value, lex_state])
when :on_comment
IgnoreStateToken.new([[lineno, column], event, value, lex_state])
when :on_heredoc_end
# Heredoc end tokens can be emitted in an odd order, so we don't
# want to bother comparing the state on them.
last_heredoc_end = token.location.end_offset
IgnoreStateToken.new([[lineno, column], event, value, lex_state])
when :on_ident
if lex_state == Ripper::EXPR_END
# If we have an identifier that follows a method name like:
#
# def foo bar
#
# then Ripper will mark bar as END|LABEL if there is a local in a
# parent scope named bar because it hasn't pushed the local table
# yet. We do this more accurately, so we need to allow comparing
# against both END and END|LABEL.
ParamToken.new([[lineno, column], event, value, lex_state])
elsif lex_state == Ripper::EXPR_END | Ripper::EXPR_LABEL
# In the event that we're comparing identifiers, we're going to
# allow a little divergence. Ripper doesn't account for local
# variables introduced through named captures in regexes, and we
# do, which accounts for this difference.
IdentToken.new([[lineno, column], event, value, lex_state])
else
Token.new([[lineno, column], event, value, lex_state])
end
when :on_embexpr_end
IgnoreStateToken.new([[lineno, column], event, value, lex_state])
when :on_ignored_nl
# Ignored newlines can occasionally have a LABEL state attached to
# them which doesn't actually impact anything. We don't mirror that
# state so we ignored it.
IgnoredNewlineToken.new([[lineno, column], event, value, lex_state])
when :on_regexp_end
# On regex end, Ripper scans and then sets end state, so the ripper
# lexed output is begin, when it should be end. prism sets lex state
# correctly to end state, but we want to be able to compare against
# Ripper's lexed state. So here, if it's a regexp end token, we
# output the state as the previous state, solely for the sake of
# comparison.
previous_token = result_value[index - 1][0]
lex_state =
if RIPPER.fetch(previous_token.type) == :on_embexpr_end
# If the previous token is embexpr_end, then we have to do even
# more processing. The end of an embedded expression sets the
# state to the state that it had at the beginning of the
# embedded expression. So we have to go and find that state and
# set it here.
counter = 1
current_index = index - 1
until counter == 0
current_index -= 1
current_event = RIPPER.fetch(result_value[current_index][0].type)
counter += { on_embexpr_beg: -1, on_embexpr_end: 1 }[current_event] || 0
end
Ripper::Lexer::State.new(result_value[current_index][1])
else
previous_state
end
Token.new([[lineno, column], event, value, lex_state])
when :on_eof
previous_token = result_value[index - 1][0]
# If we're at the end of the file and the previous token was a
# comment and there is still whitespace after the comment, then
# Ripper will append a on_nl token (even though there isn't
# necessarily a newline). We mirror that here.
if previous_token.type == :COMMENT
# If the comment is at the start of a heredoc: <<HEREDOC # comment
# then the comment's end_offset is up near the heredoc_beg.
# This is not the correct offset to use for figuring out if
# there is trailing whitespace after the last token.
# Use the greater offset of the two to determine the start of
# the trailing whitespace.
start_offset = [previous_token.location.end_offset, last_heredoc_end].compact.max
end_offset = token.location.start_offset
if start_offset < end_offset
if bom
start_offset += 3
end_offset += 3
end
tokens << Token.new([[lineno, 0], :on_nl, source.byteslice(start_offset...end_offset), lex_state])
end
end
Token.new([[lineno, column], event, value, lex_state])
else
Token.new([[lineno, column], event, value, lex_state])
end
previous_state = lex_state
# The order in which tokens appear in our lexer is different from the
# order that they appear in Ripper. When we hit the declaration of a
# heredoc in prism, we skip forward and lex the rest of the content of
# the heredoc before going back and lexing at the end of the heredoc
# identifier.
#
# To match up to ripper, we keep a small state variable around here to
# track whether we're in the middle of a heredoc or not. In this way we
# can shuffle around the token to match Ripper's output.
case state
when :default
# The default state is when there are no heredocs at all. In this
# state we can append the token to the list of tokens and move on.
tokens << token
# If we get the declaration of a heredoc, then we open a new heredoc
# and move into the heredoc_opened state.
if event == :on_heredoc_beg
state = :heredoc_opened
heredoc_stack.last << Heredoc.build(token)
end
when :heredoc_opened
# The heredoc_opened state is when we've seen the declaration of a
# heredoc and are now lexing the body of the heredoc. In this state we
# push tokens onto the most recently created heredoc.
heredoc_stack.last.last << token
case event
when :on_heredoc_beg
# If we receive a heredoc declaration while lexing the body of a
# heredoc, this means we have nested heredocs. In this case we'll
# push a new heredoc onto the stack and stay in the heredoc_opened
# state since we're now lexing the body of the new heredoc.
heredoc_stack << [Heredoc.build(token)]
when :on_heredoc_end
# If we receive the end of a heredoc, then we're done lexing the
# body of the heredoc. In this case we now have a completed heredoc
# but need to wait for the next newline to push it into the token
# stream.
state = :heredoc_closed
end
when :heredoc_closed
if %i[on_nl on_ignored_nl on_comment].include?(event) || (event == :on_tstring_content && value.end_with?("\n"))
if heredoc_stack.size > 1
flushing = heredoc_stack.pop
heredoc_stack.last.last << token
flushing.each do |heredoc|
heredoc.to_a.each do |flushed_token|
heredoc_stack.last.last << flushed_token
end
end
state = :heredoc_opened
next
end
elsif event == :on_heredoc_beg
tokens << token
state = :heredoc_opened
heredoc_stack.last << Heredoc.build(token)
next
elsif heredoc_stack.size > 1
heredoc_stack[-2].last << token
next
end
heredoc_stack.last.each do |heredoc|
tokens.concat(heredoc.to_a)
end
heredoc_stack.last.clear
state = :default
tokens << token
end
end
# Drop the EOF token from the list
tokens = tokens[0...-1]
# We sort by location to compare against Ripper's output
tokens.sort_by!(&:location)
ParseResult.new(tokens, result.comments, result.magic_comments, result.data_loc, result.errors, result.warnings, [])
end
end
private_constant :LexCompat
# This is a class that wraps the Ripper lexer to produce almost exactly the
# same tokens.
class LexRipper # :nodoc:
attr_reader :source
def initialize(source)
@source = source
end
def result
previous = []
results = []
Ripper.lex(source, raise_errors: true).each do |token|
case token[1]
when :on_sp
# skip
when :on_tstring_content
if previous[1] == :on_tstring_content && (token[2].start_with?("\#$") || token[2].start_with?("\#@"))
previous[2] << token[2]
else
results << token
previous = token
end
when :on_words_sep
if previous[1] == :on_words_sep
previous[2] << token[2]
else
results << token
previous = token
end
else
results << token
previous = token
end
end
results
end
end
private_constant :LexRipper
end
share/ruby/prism/compiler.rb 0000644 00000035604 15173517735 0012146 0 ustar 00 # frozen_string_literal: true
=begin
This file is generated by the templates/template.rb script and should not be
modified manually. See templates/lib/prism/compiler.rb.erb
if you are looking to modify the template
=end
module Prism
# A compiler is a visitor that returns the value of each node as it visits.
# This is as opposed to a visitor which will only walk the tree. This can be
# useful when you are trying to compile a tree into a different format.
#
# For example, to build a representation of the tree as s-expressions, you
# could write:
#
# class SExpressions < Prism::Compiler
# def visit_arguments_node(node) = [:arguments, super]
# def visit_call_node(node) = [:call, super]
# def visit_integer_node(node) = [:integer]
# def visit_program_node(node) = [:program, super]
# end
#
# Prism.parse("1 + 2").value.accept(SExpressions.new)
# # => [:program, [[[:call, [[:integer], [:arguments, [[:integer]]]]]]]]
#
class Compiler
# Visit an individual node.
def visit(node)
node&.accept(self)
end
# Visit a list of nodes.
def visit_all(nodes)
nodes.map { |node| node&.accept(self) }
end
# Visit the child nodes of the given node.
def visit_child_nodes(node)
node.compact_child_nodes.map { |node| node.accept(self) }
end
# Compile a AliasGlobalVariableNode node
alias visit_alias_global_variable_node visit_child_nodes
# Compile a AliasMethodNode node
alias visit_alias_method_node visit_child_nodes
# Compile a AlternationPatternNode node
alias visit_alternation_pattern_node visit_child_nodes
# Compile a AndNode node
alias visit_and_node visit_child_nodes
# Compile a ArgumentsNode node
alias visit_arguments_node visit_child_nodes
# Compile a ArrayNode node
alias visit_array_node visit_child_nodes
# Compile a ArrayPatternNode node
alias visit_array_pattern_node visit_child_nodes
# Compile a AssocNode node
alias visit_assoc_node visit_child_nodes
# Compile a AssocSplatNode node
alias visit_assoc_splat_node visit_child_nodes
# Compile a BackReferenceReadNode node
alias visit_back_reference_read_node visit_child_nodes
# Compile a BeginNode node
alias visit_begin_node visit_child_nodes
# Compile a BlockArgumentNode node
alias visit_block_argument_node visit_child_nodes
# Compile a BlockLocalVariableNode node
alias visit_block_local_variable_node visit_child_nodes
# Compile a BlockNode node
alias visit_block_node visit_child_nodes
# Compile a BlockParameterNode node
alias visit_block_parameter_node visit_child_nodes
# Compile a BlockParametersNode node
alias visit_block_parameters_node visit_child_nodes
# Compile a BreakNode node
alias visit_break_node visit_child_nodes
# Compile a CallAndWriteNode node
alias visit_call_and_write_node visit_child_nodes
# Compile a CallNode node
alias visit_call_node visit_child_nodes
# Compile a CallOperatorWriteNode node
alias visit_call_operator_write_node visit_child_nodes
# Compile a CallOrWriteNode node
alias visit_call_or_write_node visit_child_nodes
# Compile a CallTargetNode node
alias visit_call_target_node visit_child_nodes
# Compile a CapturePatternNode node
alias visit_capture_pattern_node visit_child_nodes
# Compile a CaseMatchNode node
alias visit_case_match_node visit_child_nodes
# Compile a CaseNode node
alias visit_case_node visit_child_nodes
# Compile a ClassNode node
alias visit_class_node visit_child_nodes
# Compile a ClassVariableAndWriteNode node
alias visit_class_variable_and_write_node visit_child_nodes
# Compile a ClassVariableOperatorWriteNode node
alias visit_class_variable_operator_write_node visit_child_nodes
# Compile a ClassVariableOrWriteNode node
alias visit_class_variable_or_write_node visit_child_nodes
# Compile a ClassVariableReadNode node
alias visit_class_variable_read_node visit_child_nodes
# Compile a ClassVariableTargetNode node
alias visit_class_variable_target_node visit_child_nodes
# Compile a ClassVariableWriteNode node
alias visit_class_variable_write_node visit_child_nodes
# Compile a ConstantAndWriteNode node
alias visit_constant_and_write_node visit_child_nodes
# Compile a ConstantOperatorWriteNode node
alias visit_constant_operator_write_node visit_child_nodes
# Compile a ConstantOrWriteNode node
alias visit_constant_or_write_node visit_child_nodes
# Compile a ConstantPathAndWriteNode node
alias visit_constant_path_and_write_node visit_child_nodes
# Compile a ConstantPathNode node
alias visit_constant_path_node visit_child_nodes
# Compile a ConstantPathOperatorWriteNode node
alias visit_constant_path_operator_write_node visit_child_nodes
# Compile a ConstantPathOrWriteNode node
alias visit_constant_path_or_write_node visit_child_nodes
# Compile a ConstantPathTargetNode node
alias visit_constant_path_target_node visit_child_nodes
# Compile a ConstantPathWriteNode node
alias visit_constant_path_write_node visit_child_nodes
# Compile a ConstantReadNode node
alias visit_constant_read_node visit_child_nodes
# Compile a ConstantTargetNode node
alias visit_constant_target_node visit_child_nodes
# Compile a ConstantWriteNode node
alias visit_constant_write_node visit_child_nodes
# Compile a DefNode node
alias visit_def_node visit_child_nodes
# Compile a DefinedNode node
alias visit_defined_node visit_child_nodes
# Compile a ElseNode node
alias visit_else_node visit_child_nodes
# Compile a EmbeddedStatementsNode node
alias visit_embedded_statements_node visit_child_nodes
# Compile a EmbeddedVariableNode node
alias visit_embedded_variable_node visit_child_nodes
# Compile a EnsureNode node
alias visit_ensure_node visit_child_nodes
# Compile a FalseNode node
alias visit_false_node visit_child_nodes
# Compile a FindPatternNode node
alias visit_find_pattern_node visit_child_nodes
# Compile a FlipFlopNode node
alias visit_flip_flop_node visit_child_nodes
# Compile a FloatNode node
alias visit_float_node visit_child_nodes
# Compile a ForNode node
alias visit_for_node visit_child_nodes
# Compile a ForwardingArgumentsNode node
alias visit_forwarding_arguments_node visit_child_nodes
# Compile a ForwardingParameterNode node
alias visit_forwarding_parameter_node visit_child_nodes
# Compile a ForwardingSuperNode node
alias visit_forwarding_super_node visit_child_nodes
# Compile a GlobalVariableAndWriteNode node
alias visit_global_variable_and_write_node visit_child_nodes
# Compile a GlobalVariableOperatorWriteNode node
alias visit_global_variable_operator_write_node visit_child_nodes
# Compile a GlobalVariableOrWriteNode node
alias visit_global_variable_or_write_node visit_child_nodes
# Compile a GlobalVariableReadNode node
alias visit_global_variable_read_node visit_child_nodes
# Compile a GlobalVariableTargetNode node
alias visit_global_variable_target_node visit_child_nodes
# Compile a GlobalVariableWriteNode node
alias visit_global_variable_write_node visit_child_nodes
# Compile a HashNode node
alias visit_hash_node visit_child_nodes
# Compile a HashPatternNode node
alias visit_hash_pattern_node visit_child_nodes
# Compile a IfNode node
alias visit_if_node visit_child_nodes
# Compile a ImaginaryNode node
alias visit_imaginary_node visit_child_nodes
# Compile a ImplicitNode node
alias visit_implicit_node visit_child_nodes
# Compile a ImplicitRestNode node
alias visit_implicit_rest_node visit_child_nodes
# Compile a InNode node
alias visit_in_node visit_child_nodes
# Compile a IndexAndWriteNode node
alias visit_index_and_write_node visit_child_nodes
# Compile a IndexOperatorWriteNode node
alias visit_index_operator_write_node visit_child_nodes
# Compile a IndexOrWriteNode node
alias visit_index_or_write_node visit_child_nodes
# Compile a IndexTargetNode node
alias visit_index_target_node visit_child_nodes
# Compile a InstanceVariableAndWriteNode node
alias visit_instance_variable_and_write_node visit_child_nodes
# Compile a InstanceVariableOperatorWriteNode node
alias visit_instance_variable_operator_write_node visit_child_nodes
# Compile a InstanceVariableOrWriteNode node
alias visit_instance_variable_or_write_node visit_child_nodes
# Compile a InstanceVariableReadNode node
alias visit_instance_variable_read_node visit_child_nodes
# Compile a InstanceVariableTargetNode node
alias visit_instance_variable_target_node visit_child_nodes
# Compile a InstanceVariableWriteNode node
alias visit_instance_variable_write_node visit_child_nodes
# Compile a IntegerNode node
alias visit_integer_node visit_child_nodes
# Compile a InterpolatedMatchLastLineNode node
alias visit_interpolated_match_last_line_node visit_child_nodes
# Compile a InterpolatedRegularExpressionNode node
alias visit_interpolated_regular_expression_node visit_child_nodes
# Compile a InterpolatedStringNode node
alias visit_interpolated_string_node visit_child_nodes
# Compile a InterpolatedSymbolNode node
alias visit_interpolated_symbol_node visit_child_nodes
# Compile a InterpolatedXStringNode node
alias visit_interpolated_x_string_node visit_child_nodes
# Compile a KeywordHashNode node
alias visit_keyword_hash_node visit_child_nodes
# Compile a KeywordRestParameterNode node
alias visit_keyword_rest_parameter_node visit_child_nodes
# Compile a LambdaNode node
alias visit_lambda_node visit_child_nodes
# Compile a LocalVariableAndWriteNode node
alias visit_local_variable_and_write_node visit_child_nodes
# Compile a LocalVariableOperatorWriteNode node
alias visit_local_variable_operator_write_node visit_child_nodes
# Compile a LocalVariableOrWriteNode node
alias visit_local_variable_or_write_node visit_child_nodes
# Compile a LocalVariableReadNode node
alias visit_local_variable_read_node visit_child_nodes
# Compile a LocalVariableTargetNode node
alias visit_local_variable_target_node visit_child_nodes
# Compile a LocalVariableWriteNode node
alias visit_local_variable_write_node visit_child_nodes
# Compile a MatchLastLineNode node
alias visit_match_last_line_node visit_child_nodes
# Compile a MatchPredicateNode node
alias visit_match_predicate_node visit_child_nodes
# Compile a MatchRequiredNode node
alias visit_match_required_node visit_child_nodes
# Compile a MatchWriteNode node
alias visit_match_write_node visit_child_nodes
# Compile a MissingNode node
alias visit_missing_node visit_child_nodes
# Compile a ModuleNode node
alias visit_module_node visit_child_nodes
# Compile a MultiTargetNode node
alias visit_multi_target_node visit_child_nodes
# Compile a MultiWriteNode node
alias visit_multi_write_node visit_child_nodes
# Compile a NextNode node
alias visit_next_node visit_child_nodes
# Compile a NilNode node
alias visit_nil_node visit_child_nodes
# Compile a NoKeywordsParameterNode node
alias visit_no_keywords_parameter_node visit_child_nodes
# Compile a NumberedParametersNode node
alias visit_numbered_parameters_node visit_child_nodes
# Compile a NumberedReferenceReadNode node
alias visit_numbered_reference_read_node visit_child_nodes
# Compile a OptionalKeywordParameterNode node
alias visit_optional_keyword_parameter_node visit_child_nodes
# Compile a OptionalParameterNode node
alias visit_optional_parameter_node visit_child_nodes
# Compile a OrNode node
alias visit_or_node visit_child_nodes
# Compile a ParametersNode node
alias visit_parameters_node visit_child_nodes
# Compile a ParenthesesNode node
alias visit_parentheses_node visit_child_nodes
# Compile a PinnedExpressionNode node
alias visit_pinned_expression_node visit_child_nodes
# Compile a PinnedVariableNode node
alias visit_pinned_variable_node visit_child_nodes
# Compile a PostExecutionNode node
alias visit_post_execution_node visit_child_nodes
# Compile a PreExecutionNode node
alias visit_pre_execution_node visit_child_nodes
# Compile a ProgramNode node
alias visit_program_node visit_child_nodes
# Compile a RangeNode node
alias visit_range_node visit_child_nodes
# Compile a RationalNode node
alias visit_rational_node visit_child_nodes
# Compile a RedoNode node
alias visit_redo_node visit_child_nodes
# Compile a RegularExpressionNode node
alias visit_regular_expression_node visit_child_nodes
# Compile a RequiredKeywordParameterNode node
alias visit_required_keyword_parameter_node visit_child_nodes
# Compile a RequiredParameterNode node
alias visit_required_parameter_node visit_child_nodes
# Compile a RescueModifierNode node
alias visit_rescue_modifier_node visit_child_nodes
# Compile a RescueNode node
alias visit_rescue_node visit_child_nodes
# Compile a RestParameterNode node
alias visit_rest_parameter_node visit_child_nodes
# Compile a RetryNode node
alias visit_retry_node visit_child_nodes
# Compile a ReturnNode node
alias visit_return_node visit_child_nodes
# Compile a SelfNode node
alias visit_self_node visit_child_nodes
# Compile a SingletonClassNode node
alias visit_singleton_class_node visit_child_nodes
# Compile a SourceEncodingNode node
alias visit_source_encoding_node visit_child_nodes
# Compile a SourceFileNode node
alias visit_source_file_node visit_child_nodes
# Compile a SourceLineNode node
alias visit_source_line_node visit_child_nodes
# Compile a SplatNode node
alias visit_splat_node visit_child_nodes
# Compile a StatementsNode node
alias visit_statements_node visit_child_nodes
# Compile a StringNode node
alias visit_string_node visit_child_nodes
# Compile a SuperNode node
alias visit_super_node visit_child_nodes
# Compile a SymbolNode node
alias visit_symbol_node visit_child_nodes
# Compile a TrueNode node
alias visit_true_node visit_child_nodes
# Compile a UndefNode node
alias visit_undef_node visit_child_nodes
# Compile a UnlessNode node
alias visit_unless_node visit_child_nodes
# Compile a UntilNode node
alias visit_until_node visit_child_nodes
# Compile a WhenNode node
alias visit_when_node visit_child_nodes
# Compile a WhileNode node
alias visit_while_node visit_child_nodes
# Compile a XStringNode node
alias visit_x_string_node visit_child_nodes
# Compile a YieldNode node
alias visit_yield_node visit_child_nodes
end
end
share/ruby/prism/mutation_compiler.rb 0000644 00000051475 15173517735 0014072 0 ustar 00 # frozen_string_literal: true
=begin
This file is generated by the templates/template.rb script and should not be
modified manually. See templates/lib/prism/mutation_compiler.rb.erb
if you are looking to modify the template
=end
module Prism
# This visitor walks through the tree and copies each node as it is being
# visited. This is useful for consumers that want to mutate the tree, as you
# can change subtrees in place without effecting the rest of the tree.
class MutationCompiler < Compiler
# Copy a AliasGlobalVariableNode node
def visit_alias_global_variable_node(node)
node.copy(new_name: visit(node.new_name), old_name: visit(node.old_name))
end
# Copy a AliasMethodNode node
def visit_alias_method_node(node)
node.copy(new_name: visit(node.new_name), old_name: visit(node.old_name))
end
# Copy a AlternationPatternNode node
def visit_alternation_pattern_node(node)
node.copy(left: visit(node.left), right: visit(node.right))
end
# Copy a AndNode node
def visit_and_node(node)
node.copy(left: visit(node.left), right: visit(node.right))
end
# Copy a ArgumentsNode node
def visit_arguments_node(node)
node.copy(arguments: visit_all(node.arguments))
end
# Copy a ArrayNode node
def visit_array_node(node)
node.copy(elements: visit_all(node.elements))
end
# Copy a ArrayPatternNode node
def visit_array_pattern_node(node)
node.copy(constant: visit(node.constant), requireds: visit_all(node.requireds), rest: visit(node.rest), posts: visit_all(node.posts))
end
# Copy a AssocNode node
def visit_assoc_node(node)
node.copy(key: visit(node.key), value: visit(node.value))
end
# Copy a AssocSplatNode node
def visit_assoc_splat_node(node)
node.copy(value: visit(node.value))
end
# Copy a BackReferenceReadNode node
def visit_back_reference_read_node(node)
node.copy
end
# Copy a BeginNode node
def visit_begin_node(node)
node.copy(statements: visit(node.statements), rescue_clause: visit(node.rescue_clause), else_clause: visit(node.else_clause), ensure_clause: visit(node.ensure_clause))
end
# Copy a BlockArgumentNode node
def visit_block_argument_node(node)
node.copy(expression: visit(node.expression))
end
# Copy a BlockLocalVariableNode node
def visit_block_local_variable_node(node)
node.copy
end
# Copy a BlockNode node
def visit_block_node(node)
node.copy(parameters: visit(node.parameters), body: visit(node.body))
end
# Copy a BlockParameterNode node
def visit_block_parameter_node(node)
node.copy
end
# Copy a BlockParametersNode node
def visit_block_parameters_node(node)
node.copy(parameters: visit(node.parameters), locals: visit_all(node.locals))
end
# Copy a BreakNode node
def visit_break_node(node)
node.copy(arguments: visit(node.arguments))
end
# Copy a CallAndWriteNode node
def visit_call_and_write_node(node)
node.copy(receiver: visit(node.receiver), value: visit(node.value))
end
# Copy a CallNode node
def visit_call_node(node)
node.copy(receiver: visit(node.receiver), arguments: visit(node.arguments), block: visit(node.block))
end
# Copy a CallOperatorWriteNode node
def visit_call_operator_write_node(node)
node.copy(receiver: visit(node.receiver), value: visit(node.value))
end
# Copy a CallOrWriteNode node
def visit_call_or_write_node(node)
node.copy(receiver: visit(node.receiver), value: visit(node.value))
end
# Copy a CallTargetNode node
def visit_call_target_node(node)
node.copy(receiver: visit(node.receiver))
end
# Copy a CapturePatternNode node
def visit_capture_pattern_node(node)
node.copy(value: visit(node.value), target: visit(node.target))
end
# Copy a CaseMatchNode node
def visit_case_match_node(node)
node.copy(predicate: visit(node.predicate), conditions: visit_all(node.conditions), consequent: visit(node.consequent))
end
# Copy a CaseNode node
def visit_case_node(node)
node.copy(predicate: visit(node.predicate), conditions: visit_all(node.conditions), consequent: visit(node.consequent))
end
# Copy a ClassNode node
def visit_class_node(node)
node.copy(constant_path: visit(node.constant_path), superclass: visit(node.superclass), body: visit(node.body))
end
# Copy a ClassVariableAndWriteNode node
def visit_class_variable_and_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a ClassVariableOperatorWriteNode node
def visit_class_variable_operator_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a ClassVariableOrWriteNode node
def visit_class_variable_or_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a ClassVariableReadNode node
def visit_class_variable_read_node(node)
node.copy
end
# Copy a ClassVariableTargetNode node
def visit_class_variable_target_node(node)
node.copy
end
# Copy a ClassVariableWriteNode node
def visit_class_variable_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a ConstantAndWriteNode node
def visit_constant_and_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a ConstantOperatorWriteNode node
def visit_constant_operator_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a ConstantOrWriteNode node
def visit_constant_or_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a ConstantPathAndWriteNode node
def visit_constant_path_and_write_node(node)
node.copy(target: visit(node.target), value: visit(node.value))
end
# Copy a ConstantPathNode node
def visit_constant_path_node(node)
node.copy(parent: visit(node.parent), child: visit(node.child))
end
# Copy a ConstantPathOperatorWriteNode node
def visit_constant_path_operator_write_node(node)
node.copy(target: visit(node.target), value: visit(node.value))
end
# Copy a ConstantPathOrWriteNode node
def visit_constant_path_or_write_node(node)
node.copy(target: visit(node.target), value: visit(node.value))
end
# Copy a ConstantPathTargetNode node
def visit_constant_path_target_node(node)
node.copy(parent: visit(node.parent), child: visit(node.child))
end
# Copy a ConstantPathWriteNode node
def visit_constant_path_write_node(node)
node.copy(target: visit(node.target), value: visit(node.value))
end
# Copy a ConstantReadNode node
def visit_constant_read_node(node)
node.copy
end
# Copy a ConstantTargetNode node
def visit_constant_target_node(node)
node.copy
end
# Copy a ConstantWriteNode node
def visit_constant_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a DefNode node
def visit_def_node(node)
node.copy(receiver: visit(node.receiver), parameters: visit(node.parameters), body: visit(node.body))
end
# Copy a DefinedNode node
def visit_defined_node(node)
node.copy(value: visit(node.value))
end
# Copy a ElseNode node
def visit_else_node(node)
node.copy(statements: visit(node.statements))
end
# Copy a EmbeddedStatementsNode node
def visit_embedded_statements_node(node)
node.copy(statements: visit(node.statements))
end
# Copy a EmbeddedVariableNode node
def visit_embedded_variable_node(node)
node.copy(variable: visit(node.variable))
end
# Copy a EnsureNode node
def visit_ensure_node(node)
node.copy(statements: visit(node.statements))
end
# Copy a FalseNode node
def visit_false_node(node)
node.copy
end
# Copy a FindPatternNode node
def visit_find_pattern_node(node)
node.copy(constant: visit(node.constant), left: visit(node.left), requireds: visit_all(node.requireds), right: visit(node.right))
end
# Copy a FlipFlopNode node
def visit_flip_flop_node(node)
node.copy(left: visit(node.left), right: visit(node.right))
end
# Copy a FloatNode node
def visit_float_node(node)
node.copy
end
# Copy a ForNode node
def visit_for_node(node)
node.copy(index: visit(node.index), collection: visit(node.collection), statements: visit(node.statements))
end
# Copy a ForwardingArgumentsNode node
def visit_forwarding_arguments_node(node)
node.copy
end
# Copy a ForwardingParameterNode node
def visit_forwarding_parameter_node(node)
node.copy
end
# Copy a ForwardingSuperNode node
def visit_forwarding_super_node(node)
node.copy(block: visit(node.block))
end
# Copy a GlobalVariableAndWriteNode node
def visit_global_variable_and_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a GlobalVariableOperatorWriteNode node
def visit_global_variable_operator_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a GlobalVariableOrWriteNode node
def visit_global_variable_or_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a GlobalVariableReadNode node
def visit_global_variable_read_node(node)
node.copy
end
# Copy a GlobalVariableTargetNode node
def visit_global_variable_target_node(node)
node.copy
end
# Copy a GlobalVariableWriteNode node
def visit_global_variable_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a HashNode node
def visit_hash_node(node)
node.copy(elements: visit_all(node.elements))
end
# Copy a HashPatternNode node
def visit_hash_pattern_node(node)
node.copy(constant: visit(node.constant), elements: visit_all(node.elements), rest: visit(node.rest))
end
# Copy a IfNode node
def visit_if_node(node)
node.copy(predicate: visit(node.predicate), statements: visit(node.statements), consequent: visit(node.consequent))
end
# Copy a ImaginaryNode node
def visit_imaginary_node(node)
node.copy(numeric: visit(node.numeric))
end
# Copy a ImplicitNode node
def visit_implicit_node(node)
node.copy(value: visit(node.value))
end
# Copy a ImplicitRestNode node
def visit_implicit_rest_node(node)
node.copy
end
# Copy a InNode node
def visit_in_node(node)
node.copy(pattern: visit(node.pattern), statements: visit(node.statements))
end
# Copy a IndexAndWriteNode node
def visit_index_and_write_node(node)
node.copy(receiver: visit(node.receiver), arguments: visit(node.arguments), block: visit(node.block), value: visit(node.value))
end
# Copy a IndexOperatorWriteNode node
def visit_index_operator_write_node(node)
node.copy(receiver: visit(node.receiver), arguments: visit(node.arguments), block: visit(node.block), value: visit(node.value))
end
# Copy a IndexOrWriteNode node
def visit_index_or_write_node(node)
node.copy(receiver: visit(node.receiver), arguments: visit(node.arguments), block: visit(node.block), value: visit(node.value))
end
# Copy a IndexTargetNode node
def visit_index_target_node(node)
node.copy(receiver: visit(node.receiver), arguments: visit(node.arguments), block: visit(node.block))
end
# Copy a InstanceVariableAndWriteNode node
def visit_instance_variable_and_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a InstanceVariableOperatorWriteNode node
def visit_instance_variable_operator_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a InstanceVariableOrWriteNode node
def visit_instance_variable_or_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a InstanceVariableReadNode node
def visit_instance_variable_read_node(node)
node.copy
end
# Copy a InstanceVariableTargetNode node
def visit_instance_variable_target_node(node)
node.copy
end
# Copy a InstanceVariableWriteNode node
def visit_instance_variable_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a IntegerNode node
def visit_integer_node(node)
node.copy
end
# Copy a InterpolatedMatchLastLineNode node
def visit_interpolated_match_last_line_node(node)
node.copy(parts: visit_all(node.parts))
end
# Copy a InterpolatedRegularExpressionNode node
def visit_interpolated_regular_expression_node(node)
node.copy(parts: visit_all(node.parts))
end
# Copy a InterpolatedStringNode node
def visit_interpolated_string_node(node)
node.copy(parts: visit_all(node.parts))
end
# Copy a InterpolatedSymbolNode node
def visit_interpolated_symbol_node(node)
node.copy(parts: visit_all(node.parts))
end
# Copy a InterpolatedXStringNode node
def visit_interpolated_x_string_node(node)
node.copy(parts: visit_all(node.parts))
end
# Copy a KeywordHashNode node
def visit_keyword_hash_node(node)
node.copy(elements: visit_all(node.elements))
end
# Copy a KeywordRestParameterNode node
def visit_keyword_rest_parameter_node(node)
node.copy
end
# Copy a LambdaNode node
def visit_lambda_node(node)
node.copy(parameters: visit(node.parameters), body: visit(node.body))
end
# Copy a LocalVariableAndWriteNode node
def visit_local_variable_and_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a LocalVariableOperatorWriteNode node
def visit_local_variable_operator_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a LocalVariableOrWriteNode node
def visit_local_variable_or_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a LocalVariableReadNode node
def visit_local_variable_read_node(node)
node.copy
end
# Copy a LocalVariableTargetNode node
def visit_local_variable_target_node(node)
node.copy
end
# Copy a LocalVariableWriteNode node
def visit_local_variable_write_node(node)
node.copy(value: visit(node.value))
end
# Copy a MatchLastLineNode node
def visit_match_last_line_node(node)
node.copy
end
# Copy a MatchPredicateNode node
def visit_match_predicate_node(node)
node.copy(value: visit(node.value), pattern: visit(node.pattern))
end
# Copy a MatchRequiredNode node
def visit_match_required_node(node)
node.copy(value: visit(node.value), pattern: visit(node.pattern))
end
# Copy a MatchWriteNode node
def visit_match_write_node(node)
node.copy(call: visit(node.call), targets: visit_all(node.targets))
end
# Copy a MissingNode node
def visit_missing_node(node)
node.copy
end
# Copy a ModuleNode node
def visit_module_node(node)
node.copy(constant_path: visit(node.constant_path), body: visit(node.body))
end
# Copy a MultiTargetNode node
def visit_multi_target_node(node)
node.copy(lefts: visit_all(node.lefts), rest: visit(node.rest), rights: visit_all(node.rights))
end
# Copy a MultiWriteNode node
def visit_multi_write_node(node)
node.copy(lefts: visit_all(node.lefts), rest: visit(node.rest), rights: visit_all(node.rights), value: visit(node.value))
end
# Copy a NextNode node
def visit_next_node(node)
node.copy(arguments: visit(node.arguments))
end
# Copy a NilNode node
def visit_nil_node(node)
node.copy
end
# Copy a NoKeywordsParameterNode node
def visit_no_keywords_parameter_node(node)
node.copy
end
# Copy a NumberedParametersNode node
def visit_numbered_parameters_node(node)
node.copy
end
# Copy a NumberedReferenceReadNode node
def visit_numbered_reference_read_node(node)
node.copy
end
# Copy a OptionalKeywordParameterNode node
def visit_optional_keyword_parameter_node(node)
node.copy(value: visit(node.value))
end
# Copy a OptionalParameterNode node
def visit_optional_parameter_node(node)
node.copy(value: visit(node.value))
end
# Copy a OrNode node
def visit_or_node(node)
node.copy(left: visit(node.left), right: visit(node.right))
end
# Copy a ParametersNode node
def visit_parameters_node(node)
node.copy(requireds: visit_all(node.requireds), optionals: visit_all(node.optionals), rest: visit(node.rest), posts: visit_all(node.posts), keywords: visit_all(node.keywords), keyword_rest: visit(node.keyword_rest), block: visit(node.block))
end
# Copy a ParenthesesNode node
def visit_parentheses_node(node)
node.copy(body: visit(node.body))
end
# Copy a PinnedExpressionNode node
def visit_pinned_expression_node(node)
node.copy(expression: visit(node.expression))
end
# Copy a PinnedVariableNode node
def visit_pinned_variable_node(node)
node.copy(variable: visit(node.variable))
end
# Copy a PostExecutionNode node
def visit_post_execution_node(node)
node.copy(statements: visit(node.statements))
end
# Copy a PreExecutionNode node
def visit_pre_execution_node(node)
node.copy(statements: visit(node.statements))
end
# Copy a ProgramNode node
def visit_program_node(node)
node.copy(statements: visit(node.statements))
end
# Copy a RangeNode node
def visit_range_node(node)
node.copy(left: visit(node.left), right: visit(node.right))
end
# Copy a RationalNode node
def visit_rational_node(node)
node.copy(numeric: visit(node.numeric))
end
# Copy a RedoNode node
def visit_redo_node(node)
node.copy
end
# Copy a RegularExpressionNode node
def visit_regular_expression_node(node)
node.copy
end
# Copy a RequiredKeywordParameterNode node
def visit_required_keyword_parameter_node(node)
node.copy
end
# Copy a RequiredParameterNode node
def visit_required_parameter_node(node)
node.copy
end
# Copy a RescueModifierNode node
def visit_rescue_modifier_node(node)
node.copy(expression: visit(node.expression), rescue_expression: visit(node.rescue_expression))
end
# Copy a RescueNode node
def visit_rescue_node(node)
node.copy(exceptions: visit_all(node.exceptions), reference: visit(node.reference), statements: visit(node.statements), consequent: visit(node.consequent))
end
# Copy a RestParameterNode node
def visit_rest_parameter_node(node)
node.copy
end
# Copy a RetryNode node
def visit_retry_node(node)
node.copy
end
# Copy a ReturnNode node
def visit_return_node(node)
node.copy(arguments: visit(node.arguments))
end
# Copy a SelfNode node
def visit_self_node(node)
node.copy
end
# Copy a SingletonClassNode node
def visit_singleton_class_node(node)
node.copy(expression: visit(node.expression), body: visit(node.body))
end
# Copy a SourceEncodingNode node
def visit_source_encoding_node(node)
node.copy
end
# Copy a SourceFileNode node
def visit_source_file_node(node)
node.copy
end
# Copy a SourceLineNode node
def visit_source_line_node(node)
node.copy
end
# Copy a SplatNode node
def visit_splat_node(node)
node.copy(expression: visit(node.expression))
end
# Copy a StatementsNode node
def visit_statements_node(node)
node.copy(body: visit_all(node.body))
end
# Copy a StringNode node
def visit_string_node(node)
node.copy
end
# Copy a SuperNode node
def visit_super_node(node)
node.copy(arguments: visit(node.arguments), block: visit(node.block))
end
# Copy a SymbolNode node
def visit_symbol_node(node)
node.copy
end
# Copy a TrueNode node
def visit_true_node(node)
node.copy
end
# Copy a UndefNode node
def visit_undef_node(node)
node.copy(names: visit_all(node.names))
end
# Copy a UnlessNode node
def visit_unless_node(node)
node.copy(predicate: visit(node.predicate), statements: visit(node.statements), consequent: visit(node.consequent))
end
# Copy a UntilNode node
def visit_until_node(node)
node.copy(predicate: visit(node.predicate), statements: visit(node.statements))
end
# Copy a WhenNode node
def visit_when_node(node)
node.copy(conditions: visit_all(node.conditions), statements: visit(node.statements))
end
# Copy a WhileNode node
def visit_while_node(node)
node.copy(predicate: visit(node.predicate), statements: visit(node.statements))
end
# Copy a XStringNode node
def visit_x_string_node(node)
node.copy
end
# Copy a YieldNode node
def visit_yield_node(node)
node.copy(arguments: visit(node.arguments))
end
end
end
share/ruby/base64.rb 0000644 00000032341 15173517735 0010261 0 ustar 00 # frozen_string_literal: true
#
# \Module \Base64 provides methods for:
#
# - Encoding a binary string (containing non-ASCII characters)
# as a string of printable ASCII characters.
# - Decoding such an encoded string.
#
# \Base64 is commonly used in contexts where binary data
# is not allowed or supported:
#
# - Images in HTML or CSS files, or in URLs.
# - Email attachments.
#
# A \Base64-encoded string is about one-third larger that its source.
# See the {Wikipedia article}[https://en.wikipedia.org/wiki/Base64]
# for more information.
#
# This module provides three pairs of encode/decode methods.
# Your choices among these methods should depend on:
#
# - Which character set is to be used for encoding and decoding.
# - Whether "padding" is to be used.
# - Whether encoded strings are to contain newlines.
#
# Note: Examples on this page assume that the including program has executed:
#
# require 'base64'
#
# == Encoding Character Sets
#
# A \Base64-encoded string consists only of characters from a 64-character set:
#
# - <tt>('A'..'Z')</tt>.
# - <tt>('a'..'z')</tt>.
# - <tt>('0'..'9')</tt>.
# - <tt>=</tt>, the 'padding' character.
# - Either:
# - <tt>%w[+ /]</tt>:
# {RFC-2045-compliant}[https://datatracker.ietf.org/doc/html/rfc2045];
# _not_ safe for URLs.
# - <tt>%w[- _]</tt>:
# {RFC-4648-compliant}[https://datatracker.ietf.org/doc/html/rfc4648];
# safe for URLs.
#
# If you are working with \Base64-encoded strings that will come from
# or be put into URLs, you should choose this encoder-decoder pair
# of RFC-4648-compliant methods:
#
# - Base64.urlsafe_encode64 and Base64.urlsafe_decode64.
#
# Otherwise, you may choose any of the pairs in this module,
# including the pair above, or the RFC-2045-compliant pairs:
#
# - Base64.encode64 and Base64.decode64.
# - Base64.strict_encode64 and Base64.strict_decode64.
#
# == Padding
#
# \Base64-encoding changes a triplet of input bytes
# into a quartet of output characters.
#
# <b>Padding in Encode Methods</b>
#
# Padding -- extending an encoded string with zero, one, or two trailing
# <tt>=</tt> characters -- is performed by methods Base64.encode64,
# Base64.strict_encode64, and, by default, Base64.urlsafe_encode64:
#
# Base64.encode64('s') # => "cw==\n"
# Base64.strict_encode64('s') # => "cw=="
# Base64.urlsafe_encode64('s') # => "cw=="
# Base64.urlsafe_encode64('s', padding: false) # => "cw"
#
# When padding is performed, the encoded string is always of length <em>4n</em>,
# where +n+ is a non-negative integer:
#
# - Input bytes of length <em>3n</em> generate unpadded output characters
# of length <em>4n</em>:
#
# # n = 1: 3 bytes => 4 characters.
# Base64.strict_encode64('123') # => "MDEy"
# # n = 2: 6 bytes => 8 characters.
# Base64.strict_encode64('123456') # => "MDEyMzQ1"
#
# - Input bytes of length <em>3n+1</em> generate padded output characters
# of length <em>4(n+1)</em>, with two padding characters at the end:
#
# # n = 1: 4 bytes => 8 characters.
# Base64.strict_encode64('1234') # => "MDEyMw=="
# # n = 2: 7 bytes => 12 characters.
# Base64.strict_encode64('1234567') # => "MDEyMzQ1Ng=="
#
# - Input bytes of length <em>3n+2</em> generate padded output characters
# of length <em>4(n+1)</em>, with one padding character at the end:
#
# # n = 1: 5 bytes => 8 characters.
# Base64.strict_encode64('12345') # => "MDEyMzQ="
# # n = 2: 8 bytes => 12 characters.
# Base64.strict_encode64('12345678') # => "MDEyMzQ1Njc="
#
# When padding is suppressed, for a positive integer <em>n</em>:
#
# - Input bytes of length <em>3n</em> generate unpadded output characters
# of length <em>4n</em>:
#
# # n = 1: 3 bytes => 4 characters.
# Base64.urlsafe_encode64('123', padding: false) # => "MDEy"
# # n = 2: 6 bytes => 8 characters.
# Base64.urlsafe_encode64('123456', padding: false) # => "MDEyMzQ1"
#
# - Input bytes of length <em>3n+1</em> generate unpadded output characters
# of length <em>4n+2</em>, with two padding characters at the end:
#
# # n = 1: 4 bytes => 6 characters.
# Base64.urlsafe_encode64('1234', padding: false) # => "MDEyMw"
# # n = 2: 7 bytes => 10 characters.
# Base64.urlsafe_encode64('1234567', padding: false) # => "MDEyMzQ1Ng"
#
# - Input bytes of length <em>3n+2</em> generate unpadded output characters
# of length <em>4n+3</em>, with one padding character at the end:
#
# # n = 1: 5 bytes => 7 characters.
# Base64.urlsafe_encode64('12345', padding: false) # => "MDEyMzQ"
# # m = 2: 8 bytes => 11 characters.
# Base64.urlsafe_encode64('12345678', padding: false) # => "MDEyMzQ1Njc"
#
# <b>Padding in Decode Methods</b>
#
# All of the \Base64 decode methods support (but do not require) padding.
#
# \Method Base64.decode64 does not check the size of the padding:
#
# Base64.decode64("MDEyMzQ1Njc") # => "01234567"
# Base64.decode64("MDEyMzQ1Njc=") # => "01234567"
# Base64.decode64("MDEyMzQ1Njc==") # => "01234567"
#
# \Method Base64.strict_decode64 strictly enforces padding size:
#
# Base64.strict_decode64("MDEyMzQ1Njc") # Raises ArgumentError
# Base64.strict_decode64("MDEyMzQ1Njc=") # => "01234567"
# Base64.strict_decode64("MDEyMzQ1Njc==") # Raises ArgumentError
#
# \Method Base64.urlsafe_decode64 allows padding in +str+,
# which if present, must be correct:
# see {Padding}[Base64.html#module-Base64-label-Padding], above:
#
# Base64.urlsafe_decode64("MDEyMzQ1Njc") # => "01234567"
# Base64.urlsafe_decode64("MDEyMzQ1Njc=") # => "01234567"
# Base64.urlsafe_decode64("MDEyMzQ1Njc==") # Raises ArgumentError.
#
# == Newlines
#
# An encoded string returned by Base64.encode64 or Base64.urlsafe_encode64
# has an embedded newline character
# after each 60-character sequence, and, if non-empty, at the end:
#
# # No newline if empty.
# encoded = Base64.encode64("\x00" * 0)
# encoded.index("\n") # => nil
#
# # Newline at end of short output.
# encoded = Base64.encode64("\x00" * 1)
# encoded.size # => 4
# encoded.index("\n") # => 4
#
# # Newline at end of longer output.
# encoded = Base64.encode64("\x00" * 45)
# encoded.size # => 60
# encoded.index("\n") # => 60
#
# # Newlines embedded and at end of still longer output.
# encoded = Base64.encode64("\x00" * 46)
# encoded.size # => 65
# encoded.rindex("\n") # => 65
# encoded.split("\n").map {|s| s.size } # => [60, 4]
#
# The string to be encoded may itself contain newlines,
# which are encoded as \Base64:
#
# # Base64.encode64("\n\n\n") # => "CgoK\n"
# s = "This is line 1\nThis is line 2\n"
# Base64.encode64(s) # => "VGhpcyBpcyBsaW5lIDEKVGhpcyBpcyBsaW5lIDIK\n"
#
module Base64
VERSION = "0.2.0"
module_function
# Returns a string containing the RFC-2045-compliant \Base64-encoding of +bin+.
#
# Per RFC 2045, the returned string may contain the URL-unsafe characters
# <tt>+</tt> or <tt>/</tt>;
# see {Encoding Character Set}[Base64.html#module-Base64-label-Encoding+Character+Sets] above:
#
# Base64.encode64("\xFB\xEF\xBE") # => "++++\n"
# Base64.encode64("\xFF\xFF\xFF") # => "////\n"
#
# The returned string may include padding;
# see {Padding}[Base64.html#module-Base64-label-Padding] above.
#
# Base64.encode64('*') # => "Kg==\n"
#
# The returned string ends with a newline character, and if sufficiently long
# will have one or more embedded newline characters;
# see {Newlines}[Base64.html#module-Base64-label-Newlines] above:
#
# Base64.encode64('*') # => "Kg==\n"
# Base64.encode64('*' * 46)
# # => "KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioq\nKg==\n"
#
# The string to be encoded may itself contain newlines,
# which will be encoded as ordinary \Base64:
#
# Base64.encode64("\n\n\n") # => "CgoK\n"
# s = "This is line 1\nThis is line 2\n"
# Base64.encode64(s) # => "VGhpcyBpcyBsaW5lIDEKVGhpcyBpcyBsaW5lIDIK\n"
#
def encode64(bin)
[bin].pack("m")
end
# Returns a string containing the decoding of an RFC-2045-compliant
# \Base64-encoded string +str+:
#
# s = "VGhpcyBpcyBsaW5lIDEKVGhpcyBpcyBsaW5lIDIK\n"
# Base64.decode64(s) # => "This is line 1\nThis is line 2\n"
#
# Non-\Base64 characters in +str+ are ignored;
# see {Encoding Character Set}[Base64.html#module-Base64-label-Encoding+Character+Sets] above:
# these include newline characters and characters <tt>-</tt> and <tt>/</tt>:
#
# Base64.decode64("\x00\n-_") # => ""
#
# Padding in +str+ (even if incorrect) is ignored:
#
# Base64.decode64("MDEyMzQ1Njc") # => "01234567"
# Base64.decode64("MDEyMzQ1Njc=") # => "01234567"
# Base64.decode64("MDEyMzQ1Njc==") # => "01234567"
#
def decode64(str)
str.unpack1("m")
end
# Returns a string containing the RFC-2045-compliant \Base64-encoding of +bin+.
#
# Per RFC 2045, the returned string may contain the URL-unsafe characters
# <tt>+</tt> or <tt>/</tt>;
# see {Encoding Character Set}[Base64.html#module-Base64-label-Encoding+Character+Sets] above:
#
# Base64.strict_encode64("\xFB\xEF\xBE") # => "++++\n"
# Base64.strict_encode64("\xFF\xFF\xFF") # => "////\n"
#
# The returned string may include padding;
# see {Padding}[Base64.html#module-Base64-label-Padding] above.
#
# Base64.strict_encode64('*') # => "Kg==\n"
#
# The returned string will have no newline characters, regardless of its length;
# see {Newlines}[Base64.html#module-Base64-label-Newlines] above:
#
# Base64.strict_encode64('*') # => "Kg=="
# Base64.strict_encode64('*' * 46)
# # => "KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKg=="
#
# The string to be encoded may itself contain newlines,
# which will be encoded as ordinary \Base64:
#
# Base64.strict_encode64("\n\n\n") # => "CgoK"
# s = "This is line 1\nThis is line 2\n"
# Base64.strict_encode64(s) # => "VGhpcyBpcyBsaW5lIDEKVGhpcyBpcyBsaW5lIDIK"
#
def strict_encode64(bin)
[bin].pack("m0")
end
# Returns a string containing the decoding of an RFC-2045-compliant
# \Base64-encoded string +str+:
#
# s = "VGhpcyBpcyBsaW5lIDEKVGhpcyBpcyBsaW5lIDIK"
# Base64.strict_decode64(s) # => "This is line 1\nThis is line 2\n"
#
# Non-\Base64 characters in +str+ not allowed;
# see {Encoding Character Set}[Base64.html#module-Base64-label-Encoding+Character+Sets] above:
# these include newline characters and characters <tt>-</tt> and <tt>/</tt>:
#
# Base64.strict_decode64("\n") # Raises ArgumentError
# Base64.strict_decode64('-') # Raises ArgumentError
# Base64.strict_decode64('_') # Raises ArgumentError
#
# Padding in +str+, if present, must be correct:
#
# Base64.strict_decode64("MDEyMzQ1Njc") # Raises ArgumentError
# Base64.strict_decode64("MDEyMzQ1Njc=") # => "01234567"
# Base64.strict_decode64("MDEyMzQ1Njc==") # Raises ArgumentError
#
def strict_decode64(str)
str.unpack1("m0")
end
# Returns the RFC-4648-compliant \Base64-encoding of +bin+.
#
# Per RFC 4648, the returned string will not contain the URL-unsafe characters
# <tt>+</tt> or <tt>/</tt>,
# but instead may contain the URL-safe characters
# <tt>-</tt> and <tt>_</tt>;
# see {Encoding Character Set}[Base64.html#module-Base64-label-Encoding+Character+Sets] above:
#
# Base64.urlsafe_encode64("\xFB\xEF\xBE") # => "----"
# Base64.urlsafe_encode64("\xFF\xFF\xFF") # => "____"
#
# By default, the returned string may have padding;
# see {Padding}[Base64.html#module-Base64-label-Padding], above:
#
# Base64.urlsafe_encode64('*') # => "Kg=="
#
# Optionally, you can suppress padding:
#
# Base64.urlsafe_encode64('*', padding: false) # => "Kg"
#
# The returned string will have no newline characters, regardless of its length;
# see {Newlines}[Base64.html#module-Base64-label-Newlines] above:
#
# Base64.urlsafe_encode64('*') # => "Kg=="
# Base64.urlsafe_encode64('*' * 46)
# # => "KioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKioqKg=="
#
def urlsafe_encode64(bin, padding: true)
str = strict_encode64(bin)
str.chomp!("==") or str.chomp!("=") unless padding
str.tr!("+/", "-_")
str
end
# Returns the decoding of an RFC-4648-compliant \Base64-encoded string +str+:
#
# +str+ may not contain non-Base64 characters;
# see {Encoding Character Set}[Base64.html#module-Base64-label-Encoding+Character+Sets] above:
#
# Base64.urlsafe_decode64('+') # Raises ArgumentError.
# Base64.urlsafe_decode64('/') # Raises ArgumentError.
# Base64.urlsafe_decode64("\n") # Raises ArgumentError.
#
# Padding in +str+, if present, must be correct:
# see {Padding}[Base64.html#module-Base64-label-Padding], above:
#
# Base64.urlsafe_decode64("MDEyMzQ1Njc") # => "01234567"
# Base64.urlsafe_decode64("MDEyMzQ1Njc=") # => "01234567"
# Base64.urlsafe_decode64("MDEyMzQ1Njc==") # Raises ArgumentError.
#
def urlsafe_decode64(str)
# NOTE: RFC 4648 does say nothing about unpadded input, but says that
# "the excess pad characters MAY also be ignored", so it is inferred that
# unpadded input is also acceptable.
if !str.end_with?("=") && str.length % 4 != 0
str = str.ljust((str.length + 3) & ~3, "=")
str.tr!("-_", "+/")
else
str = str.tr("-_", "+/")
end
strict_decode64(str)
end
end
share/ruby/did_you_mean.rb 0000644 00000012554 15173517735 0011635 0 ustar 00 require_relative "did_you_mean/version"
require_relative "did_you_mean/core_ext/name_error"
require_relative "did_you_mean/spell_checker"
require_relative 'did_you_mean/spell_checkers/name_error_checkers'
require_relative 'did_you_mean/spell_checkers/method_name_checker'
require_relative 'did_you_mean/spell_checkers/key_error_checker'
require_relative 'did_you_mean/spell_checkers/null_checker'
require_relative 'did_you_mean/spell_checkers/require_path_checker'
require_relative 'did_you_mean/spell_checkers/pattern_key_name_checker'
require_relative 'did_you_mean/formatter'
require_relative 'did_you_mean/tree_spell_checker'
# The +DidYouMean+ gem adds functionality to suggest possible method/class
# names upon errors such as +NameError+ and +NoMethodError+. In Ruby 2.3 or
# later, it is automatically activated during startup.
#
# @example
#
# methosd
# # => NameError: undefined local variable or method `methosd' for main:Object
# # Did you mean? methods
# # method
#
# OBject
# # => NameError: uninitialized constant OBject
# # Did you mean? Object
#
# @full_name = "Yuki Nishijima"
# first_name, last_name = full_name.split(" ")
# # => NameError: undefined local variable or method `full_name' for main:Object
# # Did you mean? @full_name
#
# @@full_name = "Yuki Nishijima"
# @@full_anme
# # => NameError: uninitialized class variable @@full_anme in Object
# # Did you mean? @@full_name
#
# full_name = "Yuki Nishijima"
# full_name.starts_with?("Y")
# # => NoMethodError: undefined method `starts_with?' for "Yuki Nishijima":String
# # Did you mean? start_with?
#
# hash = {foo: 1, bar: 2, baz: 3}
# hash.fetch(:fooo)
# # => KeyError: key not found: :fooo
# # Did you mean? :foo
#
#
# == Disabling +did_you_mean+
#
# Occasionally, you may want to disable the +did_you_mean+ gem for e.g.
# debugging issues in the error object itself. You can disable it entirely by
# specifying +--disable-did_you_mean+ option to the +ruby+ command:
#
# $ ruby --disable-did_you_mean -e "1.zeor?"
# -e:1:in `<main>': undefined method `zeor?' for 1:Integer (NameError)
#
# When you do not have direct access to the +ruby+ command (e.g.
# +rails console+, +irb+), you could applyoptions using the +RUBYOPT+
# environment variable:
#
# $ RUBYOPT='--disable-did_you_mean' irb
# irb:0> 1.zeor?
# # => NoMethodError (undefined method `zeor?' for 1:Integer)
#
#
# == Getting the original error message
#
# Sometimes, you do not want to disable the gem entirely, but need to get the
# original error message without suggestions (e.g. testing). In this case, you
# could use the +#original_message+ method on the error object:
#
# no_method_error = begin
# 1.zeor?
# rescue NoMethodError => error
# error
# end
#
# no_method_error.message
# # => NoMethodError (undefined method `zeor?' for 1:Integer)
# # Did you mean? zero?
#
# no_method_error.original_message
# # => NoMethodError (undefined method `zeor?' for 1:Integer)
#
module DidYouMean
# Map of error types and spell checker objects.
@spell_checkers = Hash.new(NullChecker)
# Returns a sharable hash map of error types and spell checker objects.
def self.spell_checkers
@spell_checkers
end
# Adds +DidYouMean+ functionality to an error using a given spell checker
def self.correct_error(error_class, spell_checker)
if defined?(Ractor)
new_mapping = { **@spell_checkers, error_class.to_s => spell_checker }
new_mapping.default = NullChecker
@spell_checkers = Ractor.make_shareable(new_mapping)
else
spell_checkers[error_class.to_s] = spell_checker
end
error_class.prepend(Correctable) if error_class.is_a?(Class) && !(error_class < Correctable)
end
correct_error NameError, NameErrorCheckers
correct_error KeyError, KeyErrorChecker
correct_error NoMethodError, MethodNameChecker
correct_error LoadError, RequirePathChecker if RUBY_VERSION >= '2.8.0'
correct_error NoMatchingPatternKeyError, PatternKeyNameChecker if defined?(::NoMatchingPatternKeyError)
# TODO: Remove on the 3.4 development start:
class DeprecatedMapping # :nodoc:
def []=(key, value)
warn "Calling `DidYouMean::SPELL_CHECKERS[#{key.to_s}] = #{value.to_s}' has been deprecated. " \
"Please call `DidYouMean.correct_error(#{key.to_s}, #{value.to_s})' instead."
DidYouMean.correct_error(key, value)
end
def merge!(hash)
warn "Calling `DidYouMean::SPELL_CHECKERS.merge!(error_name => spell_checker)' has been deprecated. " \
"Please call `DidYouMean.correct_error(error_name, spell_checker)' instead."
hash.each do |error_class, spell_checker|
DidYouMean.correct_error(error_class, spell_checker)
end
end
end
# TODO: Remove on the 3.4 development start:
SPELL_CHECKERS = DeprecatedMapping.new
deprecate_constant :SPELL_CHECKERS
private_constant :DeprecatedMapping
# Returns the currently set formatter. By default, it is set to +DidYouMean::Formatter+.
def self.formatter
if defined?(Ractor)
Ractor.current[:__did_you_mean_formatter__] || Formatter
else
Formatter
end
end
# Updates the primary formatter used to format the suggestions.
def self.formatter=(formatter)
if defined?(Ractor)
Ractor.current[:__did_you_mean_formatter__] = formatter
end
end
end
share/ruby/securerandom.rb 0000644 00000004072 15173517735 0011664 0 ustar 00 # -*- coding: us-ascii -*-
# frozen_string_literal: true
require 'random/formatter'
# == Secure random number generator interface.
#
# This library is an interface to secure random number generators which are
# suitable for generating session keys in HTTP cookies, etc.
#
# You can use this library in your application by requiring it:
#
# require 'securerandom'
#
# It supports the following secure random number generators:
#
# * openssl
# * /dev/urandom
# * Win32
#
# SecureRandom is extended by the Random::Formatter module which
# defines the following methods:
#
# * alphanumeric
# * base64
# * choose
# * gen_random
# * hex
# * rand
# * random_bytes
# * random_number
# * urlsafe_base64
# * uuid
#
# These methods are usable as class methods of SecureRandom such as
# +SecureRandom.hex+.
#
# If a secure random number generator is not available,
# +NotImplementedError+ is raised.
module SecureRandom
# The version
VERSION = "0.3.1"
class << self
# Returns a random binary string containing +size+ bytes.
#
# See Random.bytes
def bytes(n)
return gen_random(n)
end
private
# :stopdoc:
# Implementation using OpenSSL
def gen_random_openssl(n)
return OpenSSL::Random.random_bytes(n)
end
# Implementation using system random device
def gen_random_urandom(n)
ret = Random.urandom(n)
unless ret
raise NotImplementedError, "No random device"
end
unless ret.length == n
raise NotImplementedError, "Unexpected partial read from random device: only #{ret.length} for #{n} bytes"
end
ret
end
begin
# Check if Random.urandom is available
Random.urandom(1)
alias gen_random gen_random_urandom
rescue RuntimeError
begin
require 'openssl'
rescue NoMethodError
raise NotImplementedError, "No random device"
else
alias gen_random gen_random_openssl
end
end
# :startdoc:
# Generate random data bytes for Random::Formatter
public :gen_random
end
end
SecureRandom.extend(Random::Formatter)
share/ruby/kconv.rb 0000644 00000013345 15173517735 0010320 0 ustar 00 # frozen_string_literal: false
#
# kconv.rb - Kanji Converter.
#
# $Id$
#
# ----
#
# kconv.rb implements the Kconv class for Kanji Converter. Additionally,
# some methods in String classes are added to allow easy conversion.
#
require 'nkf'
#
# Kanji Converter for Ruby.
#
module Kconv
#
# Public Constants
#
#Constant of Encoding
# Auto-Detect
AUTO = NKF::AUTO
# ISO-2022-JP
JIS = NKF::JIS
# EUC-JP
EUC = NKF::EUC
# Shift_JIS
SJIS = NKF::SJIS
# BINARY
BINARY = NKF::BINARY
# NOCONV
NOCONV = NKF::NOCONV
# ASCII
ASCII = NKF::ASCII
# UTF-8
UTF8 = NKF::UTF8
# UTF-16
UTF16 = NKF::UTF16
# UTF-32
UTF32 = NKF::UTF32
# UNKNOWN
UNKNOWN = NKF::UNKNOWN
#
# Public Methods
#
# call-seq:
# Kconv.kconv(str, to_enc, from_enc=nil)
#
# Convert <code>str</code> to <code>to_enc</code>.
# <code>to_enc</code> and <code>from_enc</code> are given as constants of Kconv or Encoding objects.
def kconv(str, to_enc, from_enc=nil)
opt = ''
opt += ' --ic=' + from_enc.to_s if from_enc
opt += ' --oc=' + to_enc.to_s if to_enc
::NKF::nkf(opt, str)
end
module_function :kconv
#
# Encode to
#
# call-seq:
# Kconv.tojis(str) => string
#
# Convert <code>str</code> to ISO-2022-JP
def tojis(str)
kconv(str, JIS)
end
module_function :tojis
# call-seq:
# Kconv.toeuc(str) => string
#
# Convert <code>str</code> to EUC-JP
def toeuc(str)
kconv(str, EUC)
end
module_function :toeuc
# call-seq:
# Kconv.tosjis(str) => string
#
# Convert <code>str</code> to Shift_JIS
def tosjis(str)
kconv(str, SJIS)
end
module_function :tosjis
# call-seq:
# Kconv.toutf8(str) => string
#
# Convert <code>str</code> to UTF-8
def toutf8(str)
kconv(str, UTF8)
end
module_function :toutf8
# call-seq:
# Kconv.toutf16(str) => string
#
# Convert <code>str</code> to UTF-16
def toutf16(str)
kconv(str, UTF16)
end
module_function :toutf16
# call-seq:
# Kconv.toutf32(str) => string
#
# Convert <code>str</code> to UTF-32
def toutf32(str)
kconv(str, UTF32)
end
module_function :toutf32
# call-seq:
# Kconv.tolocale => string
#
# Convert <code>self</code> to locale encoding
def tolocale(str)
kconv(str, Encoding.locale_charmap)
end
module_function :tolocale
#
# guess
#
# call-seq:
# Kconv.guess(str) => encoding
#
# Guess input encoding by NKF.guess
def guess(str)
::NKF::guess(str)
end
module_function :guess
#
# isEncoding
#
# call-seq:
# Kconv.iseuc(str) => true or false
#
# Returns whether input encoding is EUC-JP or not.
#
# *Note* don't expect this return value is MatchData.
def iseuc(str)
str.dup.force_encoding(EUC).valid_encoding?
end
module_function :iseuc
# call-seq:
# Kconv.issjis(str) => true or false
#
# Returns whether input encoding is Shift_JIS or not.
def issjis(str)
str.dup.force_encoding(SJIS).valid_encoding?
end
module_function :issjis
# call-seq:
# Kconv.isjis(str) => true or false
#
# Returns whether input encoding is ISO-2022-JP or not.
def isjis(str)
/\A [\t\n\r\x20-\x7E]*
(?:
(?:\x1b \x28 I [\x21-\x7E]*
|\x1b \x28 J [\x21-\x7E]*
|\x1b \x24 @ (?:[\x21-\x7E]{2})*
|\x1b \x24 B (?:[\x21-\x7E]{2})*
|\x1b \x24 \x28 D (?:[\x21-\x7E]{2})*
)*
\x1b \x28 B [\t\n\r\x20-\x7E]*
)*
\z/nox =~ str.dup.force_encoding('BINARY') ? true : false
end
module_function :isjis
# call-seq:
# Kconv.isutf8(str) => true or false
#
# Returns whether input encoding is UTF-8 or not.
def isutf8(str)
str.dup.force_encoding(UTF8).valid_encoding?
end
module_function :isutf8
end
class String
# call-seq:
# String#kconv(to_enc, from_enc)
#
# Convert <code>self</code> to <code>to_enc</code>.
# <code>to_enc</code> and <code>from_enc</code> are given as constants of Kconv or Encoding objects.
def kconv(to_enc, from_enc=nil)
from_enc = self.encoding if !from_enc && self.encoding != Encoding.list[0]
Kconv::kconv(self, to_enc, from_enc)
end
#
# to Encoding
#
# call-seq:
# String#tojis => string
#
# Convert <code>self</code> to ISO-2022-JP
def tojis; Kconv.tojis(self) end
# call-seq:
# String#toeuc => string
#
# Convert <code>self</code> to EUC-JP
def toeuc; Kconv.toeuc(self) end
# call-seq:
# String#tosjis => string
#
# Convert <code>self</code> to Shift_JIS
def tosjis; Kconv.tosjis(self) end
# call-seq:
# String#toutf8 => string
#
# Convert <code>self</code> to UTF-8
def toutf8; Kconv.toutf8(self) end
# call-seq:
# String#toutf16 => string
#
# Convert <code>self</code> to UTF-16
def toutf16; Kconv.toutf16(self) end
# call-seq:
# String#toutf32 => string
#
# Convert <code>self</code> to UTF-32
def toutf32; Kconv.toutf32(self) end
# call-seq:
# String#tolocale => string
#
# Convert <code>self</code> to locale encoding
def tolocale; Kconv.tolocale(self) end
#
# is Encoding
#
# call-seq:
# String#iseuc => true or false
#
# Returns whether <code>self</code>'s encoding is EUC-JP or not.
def iseuc; Kconv.iseuc(self) end
# call-seq:
# String#issjis => true or false
#
# Returns whether <code>self</code>'s encoding is Shift_JIS or not.
def issjis; Kconv.issjis(self) end
# call-seq:
# String#isjis => true or false
#
# Returns whether <code>self</code>'s encoding is ISO-2022-JP or not.
def isjis; Kconv.isjis(self) end
# call-seq:
# String#isutf8 => true or false
#
# Returns whether <code>self</code>'s encoding is UTF-8 or not.
def isutf8; Kconv.isutf8(self) end
end
share/ruby/optionparser.rb 0000644 00000000073 15173517735 0011717 0 ustar 00 # frozen_string_literal: false
require_relative 'optparse'
share/ruby/open-uri.rb 0000644 00000063541 15173517735 0010741 0 ustar 00 # frozen_string_literal: true
require 'uri'
require 'stringio'
require 'time'
module URI
# Allows the opening of various resources including URIs.
#
# If the first argument responds to the 'open' method, 'open' is called on
# it with the rest of the arguments.
#
# If the first argument is a string that begins with <code>(protocol)://</code>, it is parsed by
# URI.parse. If the parsed object responds to the 'open' method,
# 'open' is called on it with the rest of the arguments.
#
# Otherwise, Kernel#open is called.
#
# OpenURI::OpenRead#open provides URI::HTTP#open, URI::HTTPS#open and
# URI::FTP#open, Kernel#open.
#
# We can accept URIs and strings that begin with http://, https:// and
# ftp://. In these cases, the opened file object is extended by OpenURI::Meta.
def self.open(name, *rest, &block)
if name.respond_to?(:open)
name.open(*rest, &block)
elsif name.respond_to?(:to_str) &&
%r{\A[A-Za-z][A-Za-z0-9+\-\.]*://} =~ name &&
(uri = URI.parse(name)).respond_to?(:open)
uri.open(*rest, &block)
else
super
end
end
singleton_class.send(:ruby2_keywords, :open) if respond_to?(:ruby2_keywords, true)
end
# OpenURI is an easy-to-use wrapper for Net::HTTP, Net::HTTPS and Net::FTP.
#
# == Example
#
# It is possible to open an http, https or ftp URL as though it were a file:
#
# URI.open("http://www.ruby-lang.org/") {|f|
# f.each_line {|line| p line}
# }
#
# The opened file has several getter methods for its meta-information, as
# follows, since it is extended by OpenURI::Meta.
#
# URI.open("http://www.ruby-lang.org/en") {|f|
# f.each_line {|line| p line}
# p f.base_uri # <URI::HTTP:0x40e6ef2 URL:http://www.ruby-lang.org/en/>
# p f.content_type # "text/html"
# p f.charset # "iso-8859-1"
# p f.content_encoding # []
# p f.last_modified # Thu Dec 05 02:45:02 UTC 2002
# }
#
# Additional header fields can be specified by an optional hash argument.
#
# URI.open("http://www.ruby-lang.org/en/",
# "User-Agent" => "Ruby/#{RUBY_VERSION}",
# "From" => "foo@bar.invalid",
# "Referer" => "http://www.ruby-lang.org/") {|f|
# # ...
# }
#
# The environment variables such as http_proxy, https_proxy and ftp_proxy
# are in effect by default. Here we disable proxy:
#
# URI.open("http://www.ruby-lang.org/en/", :proxy => nil) {|f|
# # ...
# }
#
# See OpenURI::OpenRead.open and URI.open for more on available options.
#
# URI objects can be opened in a similar way.
#
# uri = URI.parse("http://www.ruby-lang.org/en/")
# uri.open {|f|
# # ...
# }
#
# URI objects can be read directly. The returned string is also extended by
# OpenURI::Meta.
#
# str = uri.read
# p str.base_uri
#
# Author:: Tanaka Akira <akr@m17n.org>
module OpenURI
VERSION = "0.4.1"
Options = {
:proxy => true,
:proxy_http_basic_authentication => true,
:progress_proc => true,
:content_length_proc => true,
:http_basic_authentication => true,
:read_timeout => true,
:open_timeout => true,
:ssl_ca_cert => nil,
:ssl_verify_mode => nil,
:ssl_min_version => nil,
:ssl_max_version => nil,
:ftp_active_mode => false,
:redirect => true,
:encoding => nil,
:max_redirects => 64,
}
def OpenURI.check_options(options) # :nodoc:
options.each {|k, v|
next unless Symbol === k
unless Options.include? k
raise ArgumentError, "unrecognized option: #{k}"
end
}
end
def OpenURI.scan_open_optional_arguments(*rest) # :nodoc:
if !rest.empty? && (String === rest.first || Integer === rest.first)
mode = rest.shift
if !rest.empty? && Integer === rest.first
perm = rest.shift
end
end
return mode, perm, rest
end
def OpenURI.open_uri(name, *rest) # :nodoc:
uri = URI::Generic === name ? name : URI.parse(name)
mode, _, rest = OpenURI.scan_open_optional_arguments(*rest)
options = rest.shift if !rest.empty? && Hash === rest.first
raise ArgumentError.new("extra arguments") if !rest.empty?
options ||= {}
OpenURI.check_options(options)
if /\Arb?(?:\Z|:([^:]+))/ =~ mode
encoding, = $1,Encoding.find($1) if $1
mode = nil
end
if options.has_key? :encoding
if !encoding.nil?
raise ArgumentError, "encoding specified twice"
end
encoding = Encoding.find(options[:encoding])
end
unless mode == nil ||
mode == 'r' || mode == 'rb' ||
mode == File::RDONLY
raise ArgumentError.new("invalid access mode #{mode} (#{uri.class} resource is read only.)")
end
io = open_loop(uri, options)
io.set_encoding(encoding) if encoding
if block_given?
begin
yield io
ensure
if io.respond_to? :close!
io.close! # Tempfile
else
io.close if !io.closed?
end
end
else
io
end
end
def OpenURI.open_loop(uri, options) # :nodoc:
proxy_opts = []
proxy_opts << :proxy_http_basic_authentication if options.include? :proxy_http_basic_authentication
proxy_opts << :proxy if options.include? :proxy
proxy_opts.compact!
if 1 < proxy_opts.length
raise ArgumentError, "multiple proxy options specified"
end
case proxy_opts.first
when :proxy_http_basic_authentication
opt_proxy, proxy_user, proxy_pass = options.fetch(:proxy_http_basic_authentication)
proxy_user = proxy_user.to_str
proxy_pass = proxy_pass.to_str
if opt_proxy == true
raise ArgumentError.new("Invalid authenticated proxy option: #{options[:proxy_http_basic_authentication].inspect}")
end
when :proxy
opt_proxy = options.fetch(:proxy)
proxy_user = nil
proxy_pass = nil
when nil
opt_proxy = true
proxy_user = nil
proxy_pass = nil
end
case opt_proxy
when true
find_proxy = lambda {|u| pxy = u.find_proxy; pxy ? [pxy, nil, nil] : nil}
when nil, false
find_proxy = lambda {|u| nil}
when String
opt_proxy = URI.parse(opt_proxy)
find_proxy = lambda {|u| [opt_proxy, proxy_user, proxy_pass]}
when URI::Generic
find_proxy = lambda {|u| [opt_proxy, proxy_user, proxy_pass]}
else
raise ArgumentError.new("Invalid proxy option: #{opt_proxy}")
end
uri_set = {}
max_redirects = options[:max_redirects]
buf = nil
while true
redirect = catch(:open_uri_redirect) {
buf = Buffer.new
uri.buffer_open(buf, find_proxy.call(uri), options)
nil
}
if redirect
if redirect.relative?
# Although it violates RFC2616, Location: field may have relative
# URI. It is converted to absolute URI using uri as a base URI.
redirect = uri + redirect
end
if !options.fetch(:redirect, true)
raise HTTPRedirect.new(buf.io.status.join(' '), buf.io, redirect)
end
unless OpenURI.redirectable?(uri, redirect)
raise "redirection forbidden: #{uri} -> #{redirect}"
end
if options.include? :http_basic_authentication
# send authentication only for the URI directly specified.
options = options.dup
options.delete :http_basic_authentication
end
uri = redirect
raise "HTTP redirection loop: #{uri}" if uri_set.include? uri.to_s
uri_set[uri.to_s] = true
raise TooManyRedirects.new("Too many redirects", buf.io) if max_redirects && uri_set.size > max_redirects
else
break
end
end
io = buf.io
io.base_uri = uri
io
end
def OpenURI.redirectable?(uri1, uri2) # :nodoc:
# This test is intended to forbid a redirection from http://... to
# file:///etc/passwd, file:///dev/zero, etc. CVE-2011-1521
# https to http redirect is also forbidden intentionally.
# It avoids sending secure cookie or referer by non-secure HTTP protocol.
# (RFC 2109 4.3.1, RFC 2965 3.3, RFC 2616 15.1.3)
# However this is ad hoc. It should be extensible/configurable.
uri1.scheme.downcase == uri2.scheme.downcase ||
(/\A(?:http|ftp)\z/i =~ uri1.scheme && /\A(?:https?|ftp)\z/i =~ uri2.scheme)
end
def OpenURI.open_http(buf, target, proxy, options) # :nodoc:
if proxy
proxy_uri, proxy_user, proxy_pass = proxy
raise "Non-HTTP proxy URI: #{proxy_uri}" if proxy_uri.class != URI::HTTP
end
if target.userinfo
raise ArgumentError, "userinfo not supported. [RFC3986]"
end
header = {}
options.each {|k, v| header[k] = v if String === k }
require 'net/http'
klass = Net::HTTP
if URI::HTTP === target
# HTTP or HTTPS
if proxy
unless proxy_user && proxy_pass
proxy_user, proxy_pass = proxy_uri.userinfo.split(':') if proxy_uri.userinfo
end
if proxy_user && proxy_pass
klass = Net::HTTP::Proxy(proxy_uri.hostname, proxy_uri.port, proxy_user, proxy_pass)
else
klass = Net::HTTP::Proxy(proxy_uri.hostname, proxy_uri.port)
end
end
target_host = target.hostname
target_port = target.port
request_uri = target.request_uri
else
# FTP over HTTP proxy
target_host = proxy_uri.hostname
target_port = proxy_uri.port
request_uri = target.to_s
if proxy_user && proxy_pass
header["Proxy-Authorization"] =
'Basic ' + ["#{proxy_user}:#{proxy_pass}"].pack('m0')
end
end
http = proxy ? klass.new(target_host, target_port) : klass.new(target_host, target_port, nil)
if target.class == URI::HTTPS
require 'net/https'
http.use_ssl = true
http.verify_mode = options[:ssl_verify_mode] || OpenSSL::SSL::VERIFY_PEER
http.min_version = options[:ssl_min_version]
http.max_version = options[:ssl_max_version]
store = OpenSSL::X509::Store.new
if options[:ssl_ca_cert]
Array(options[:ssl_ca_cert]).each do |cert|
if File.directory? cert
store.add_path cert
else
store.add_file cert
end
end
else
store.set_default_paths
end
http.cert_store = store
end
if options.include? :read_timeout
http.read_timeout = options[:read_timeout]
end
if options.include? :open_timeout
http.open_timeout = options[:open_timeout]
end
resp = nil
http.start {
req = Net::HTTP::Get.new(request_uri, header)
if options.include? :http_basic_authentication
user, pass = options[:http_basic_authentication]
req.basic_auth user, pass
end
http.request(req) {|response|
resp = response
if options[:content_length_proc] && Net::HTTPSuccess === resp
if resp.key?('Content-Length')
options[:content_length_proc].call(resp['Content-Length'].to_i)
else
options[:content_length_proc].call(nil)
end
end
resp.read_body {|str|
buf << str
if options[:progress_proc] && Net::HTTPSuccess === resp
options[:progress_proc].call(buf.size)
end
str.clear
}
}
}
io = buf.io
io.rewind
io.status = [resp.code, resp.message]
resp.each_name {|name| buf.io.meta_add_field2 name, resp.get_fields(name) }
case resp
when Net::HTTPSuccess
when Net::HTTPMovedPermanently, # 301
Net::HTTPFound, # 302
Net::HTTPSeeOther, # 303
Net::HTTPTemporaryRedirect, # 307
Net::HTTPPermanentRedirect # 308
begin
loc_uri = URI.parse(resp['location'])
rescue URI::InvalidURIError
raise OpenURI::HTTPError.new(io.status.join(' ') + ' (Invalid Location URI)', io)
end
throw :open_uri_redirect, loc_uri
else
raise OpenURI::HTTPError.new(io.status.join(' '), io)
end
end
class HTTPError < StandardError
def initialize(message, io)
super(message)
@io = io
end
attr_reader :io
end
# Raised on redirection,
# only occurs when +redirect+ option for HTTP is +false+.
class HTTPRedirect < HTTPError
def initialize(message, io, uri)
super(message, io)
@uri = uri
end
attr_reader :uri
end
class TooManyRedirects < HTTPError
end
class Buffer # :nodoc: all
def initialize
@io = StringIO.new
@size = 0
end
attr_reader :size
StringMax = 10240
def <<(str)
@io << str
@size += str.length
if StringIO === @io && StringMax < @size
require 'tempfile'
io = Tempfile.new('open-uri')
io.binmode
Meta.init io, @io if Meta === @io
io << @io.string
@io = io
end
end
def io
Meta.init @io unless Meta === @io
@io
end
end
# :stopdoc:
RE_LWS = /[\r\n\t ]+/n
RE_TOKEN = %r{[^\x00- ()<>@,;:\\"/\[\]?={}\x7f]+}n
RE_QUOTED_STRING = %r{"(?:[\r\n\t !#-\[\]-~\x80-\xff]|\\[\x00-\x7f])*"}n
RE_PARAMETERS = %r{(?:;#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?=#{RE_LWS}?(?:#{RE_TOKEN}|#{RE_QUOTED_STRING})#{RE_LWS}?)*}n
# :startdoc:
# Mixin for holding meta-information.
module Meta
def Meta.init(obj, src=nil) # :nodoc:
obj.extend Meta
obj.instance_eval {
@base_uri = nil
@meta = {} # name to string. legacy.
@metas = {} # name to array of strings.
}
if src
obj.status = src.status
obj.base_uri = src.base_uri
src.metas.each {|name, values|
obj.meta_add_field2(name, values)
}
end
end
# returns an Array that consists of status code and message.
attr_accessor :status
# returns a URI that is the base of relative URIs in the data.
# It may differ from the URI supplied by a user due to redirection.
attr_accessor :base_uri
# returns a Hash that represents header fields.
# The Hash keys are downcased for canonicalization.
# The Hash values are a field body.
# If there are multiple field with same field name,
# the field values are concatenated with a comma.
attr_reader :meta
# returns a Hash that represents header fields.
# The Hash keys are downcased for canonicalization.
# The Hash value are an array of field values.
attr_reader :metas
def meta_setup_encoding # :nodoc:
charset = self.charset
enc = nil
if charset
begin
enc = Encoding.find(charset)
rescue ArgumentError
end
end
enc = Encoding::ASCII_8BIT unless enc
if self.respond_to? :force_encoding
self.force_encoding(enc)
elsif self.respond_to? :string
self.string.force_encoding(enc)
else # Tempfile
self.set_encoding enc
end
end
def meta_add_field2(name, values) # :nodoc:
name = name.downcase
@metas[name] = values
@meta[name] = values.join(', ')
meta_setup_encoding if name == 'content-type'
end
def meta_add_field(name, value) # :nodoc:
meta_add_field2(name, [value])
end
# returns a Time that represents the Last-Modified field.
def last_modified
if vs = @metas['last-modified']
v = vs.join(', ')
Time.httpdate(v)
else
nil
end
end
def content_type_parse # :nodoc:
vs = @metas['content-type']
# The last (?:;#{RE_LWS}?)? matches extra ";" which violates RFC2045.
if vs && %r{\A#{RE_LWS}?(#{RE_TOKEN})#{RE_LWS}?/(#{RE_TOKEN})#{RE_LWS}?(#{RE_PARAMETERS})(?:;#{RE_LWS}?)?\z}no =~ vs.join(', ')
type = $1.downcase
subtype = $2.downcase
parameters = []
$3.scan(/;#{RE_LWS}?(#{RE_TOKEN})#{RE_LWS}?=#{RE_LWS}?(?:(#{RE_TOKEN})|(#{RE_QUOTED_STRING}))/no) {|att, val, qval|
if qval
val = qval[1...-1].gsub(/[\r\n\t !#-\[\]-~\x80-\xff]+|(\\[\x00-\x7f])/n) { $1 ? $1[1,1] : $& }
end
parameters << [att.downcase, val]
}
["#{type}/#{subtype}", *parameters]
else
nil
end
end
# returns "type/subtype" which is MIME Content-Type.
# It is downcased for canonicalization.
# Content-Type parameters are stripped.
def content_type
type, *_ = content_type_parse
type || 'application/octet-stream'
end
# returns a charset parameter in Content-Type field.
# It is downcased for canonicalization.
#
# If charset parameter is not given but a block is given,
# the block is called and its result is returned.
# It can be used to guess charset.
#
# If charset parameter and block is not given,
# nil is returned except text type.
# In that case, "utf-8" is returned as defined by RFC6838 4.2.1
def charset
type, *parameters = content_type_parse
if pair = parameters.assoc('charset')
pair.last.downcase
elsif block_given?
yield
elsif type && %r{\Atext/} =~ type
"utf-8" # RFC6838 4.2.1
else
nil
end
end
# Returns a list of encodings in Content-Encoding field as an array of
# strings.
#
# The encodings are downcased for canonicalization.
def content_encoding
vs = @metas['content-encoding']
if vs && %r{\A#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?(?:,#{RE_LWS}?#{RE_TOKEN}#{RE_LWS}?)*}o =~ (v = vs.join(', '))
v.scan(RE_TOKEN).map {|content_coding| content_coding.downcase}
else
[]
end
end
end
# Mixin for HTTP and FTP URIs.
module OpenRead
# OpenURI::OpenRead#open provides `open' for URI::HTTP and URI::FTP.
#
# OpenURI::OpenRead#open takes optional 3 arguments as:
#
# OpenURI::OpenRead#open([mode [, perm]] [, options]) [{|io| ... }]
#
# OpenURI::OpenRead#open returns an IO-like object if block is not given.
# Otherwise it yields the IO object and return the value of the block.
# The IO object is extended with OpenURI::Meta.
#
# +mode+ and +perm+ are the same as Kernel#open.
#
# However, +mode+ must be read mode because OpenURI::OpenRead#open doesn't
# support write mode (yet).
# Also +perm+ is ignored because it is meaningful only for file creation.
#
# +options+ must be a hash.
#
# Each option with a string key specifies an extra header field for HTTP.
# I.e., it is ignored for FTP without HTTP proxy.
#
# The hash may include other options, where keys are symbols:
#
# [:proxy]
# Synopsis:
# :proxy => "http://proxy.foo.com:8000/"
# :proxy => URI.parse("http://proxy.foo.com:8000/")
# :proxy => true
# :proxy => false
# :proxy => nil
#
# If :proxy option is specified, the value should be String, URI,
# boolean or nil.
#
# When String or URI is given, it is treated as proxy URI.
#
# When true is given or the option itself is not specified,
# environment variable `scheme_proxy' is examined.
# `scheme' is replaced by `http', `https' or `ftp'.
#
# When false or nil is given, the environment variables are ignored and
# connection will be made to a server directly.
#
# [:proxy_http_basic_authentication]
# Synopsis:
# :proxy_http_basic_authentication =>
# ["http://proxy.foo.com:8000/", "proxy-user", "proxy-password"]
# :proxy_http_basic_authentication =>
# [URI.parse("http://proxy.foo.com:8000/"),
# "proxy-user", "proxy-password"]
#
# If :proxy option is specified, the value should be an Array with 3
# elements. It should contain a proxy URI, a proxy user name and a proxy
# password. The proxy URI should be a String, an URI or nil. The proxy
# user name and password should be a String.
#
# If nil is given for the proxy URI, this option is just ignored.
#
# If :proxy and :proxy_http_basic_authentication is specified,
# ArgumentError is raised.
#
# [:http_basic_authentication]
# Synopsis:
# :http_basic_authentication=>[user, password]
#
# If :http_basic_authentication is specified,
# the value should be an array which contains 2 strings:
# username and password.
# It is used for HTTP Basic authentication defined by RFC 2617.
#
# [:content_length_proc]
# Synopsis:
# :content_length_proc => lambda {|content_length| ... }
#
# If :content_length_proc option is specified, the option value procedure
# is called before actual transfer is started.
# It takes one argument, which is expected content length in bytes.
#
# If two or more transfers are performed by HTTP redirection, the
# procedure is called only once for the last transfer.
#
# When expected content length is unknown, the procedure is called with
# nil. This happens when the HTTP response has no Content-Length header.
#
# [:progress_proc]
# Synopsis:
# :progress_proc => lambda {|size| ...}
#
# If :progress_proc option is specified, the proc is called with one
# argument each time when `open' gets content fragment from network.
# The argument +size+ is the accumulated transferred size in bytes.
#
# If two or more transfer is done by HTTP redirection, the procedure
# is called only one for a last transfer.
#
# :progress_proc and :content_length_proc are intended to be used for
# progress bar.
# For example, it can be implemented as follows using Ruby/ProgressBar.
#
# pbar = nil
# open("http://...",
# :content_length_proc => lambda {|t|
# if t && 0 < t
# pbar = ProgressBar.new("...", t)
# pbar.file_transfer_mode
# end
# },
# :progress_proc => lambda {|s|
# pbar.set s if pbar
# }) {|f| ... }
#
# [:read_timeout]
# Synopsis:
# :read_timeout=>nil (no timeout)
# :read_timeout=>10 (10 second)
#
# :read_timeout option specifies a timeout of read for http connections.
#
# [:open_timeout]
# Synopsis:
# :open_timeout=>nil (no timeout)
# :open_timeout=>10 (10 second)
#
# :open_timeout option specifies a timeout of open for http connections.
#
# [:ssl_ca_cert]
# Synopsis:
# :ssl_ca_cert=>filename or an Array of filenames
#
# :ssl_ca_cert is used to specify CA certificate for SSL.
# If it is given, default certificates are not used.
#
# [:ssl_verify_mode]
# Synopsis:
# :ssl_verify_mode=>mode
#
# :ssl_verify_mode is used to specify openssl verify mode.
#
# [:ssl_min_version]
# Synopsis:
# :ssl_min_version=>:TLS1_2
#
# :ssl_min_version option specifies the minimum allowed SSL/TLS protocol
# version. See also OpenSSL::SSL::SSLContext#min_version=.
#
# [:ssl_max_version]
# Synopsis:
# :ssl_max_version=>:TLS1_2
#
# :ssl_max_version option specifies the maximum allowed SSL/TLS protocol
# version. See also OpenSSL::SSL::SSLContext#max_version=.
#
# [:ftp_active_mode]
# Synopsis:
# :ftp_active_mode=>bool
#
# <tt>:ftp_active_mode => true</tt> is used to make ftp active mode.
# Ruby 1.9 uses passive mode by default.
# Note that the active mode is default in Ruby 1.8 or prior.
#
# [:redirect]
# Synopsis:
# :redirect=>bool
#
# +:redirect+ is true by default. <tt>:redirect => false</tt> is used to
# disable all HTTP redirects.
#
# OpenURI::HTTPRedirect exception raised on redirection.
# Using +true+ also means that redirections between http and ftp are
# permitted.
#
def open(*rest, &block)
OpenURI.open_uri(self, *rest, &block)
end
# OpenURI::OpenRead#read([ options ]) reads a content referenced by self and
# returns the content as string.
# The string is extended with OpenURI::Meta.
# The argument +options+ is same as OpenURI::OpenRead#open.
def read(options={})
self.open(options) {|f|
str = f.read
Meta.init str, f
str
}
end
end
end
module URI
class HTTP
def buffer_open(buf, proxy, options) # :nodoc:
OpenURI.open_http(buf, self, proxy, options)
end
include OpenURI::OpenRead
end
class FTP
def buffer_open(buf, proxy, options) # :nodoc:
if proxy
OpenURI.open_http(buf, self, proxy, options)
return
end
begin
require 'net/ftp'
rescue LoadError
abort "net/ftp is not found. You may need to `gem install net-ftp` to install net/ftp."
end
path = self.path
path = path.sub(%r{\A/}, '%2F') # re-encode the beginning slash because uri library decodes it.
directories = path.split(%r{/}, -1)
directories.each {|d|
d.gsub!(/%([0-9A-Fa-f][0-9A-Fa-f])/) { [$1].pack("H2") }
}
unless filename = directories.pop
raise ArgumentError, "no filename: #{self.inspect}"
end
directories.each {|d|
if /[\r\n]/ =~ d
raise ArgumentError, "invalid directory: #{d.inspect}"
end
}
if /[\r\n]/ =~ filename
raise ArgumentError, "invalid filename: #{filename.inspect}"
end
typecode = self.typecode
if typecode && /\A[aid]\z/ !~ typecode
raise ArgumentError, "invalid typecode: #{typecode.inspect}"
end
# The access sequence is defined by RFC 1738
ftp = Net::FTP.new
ftp.connect(self.hostname, self.port)
ftp.passive = !options[:ftp_active_mode]
# todo: extract user/passwd from .netrc.
user = 'anonymous'
passwd = nil
user, passwd = self.userinfo.split(/:/) if self.userinfo
ftp.login(user, passwd)
directories.each {|cwd|
ftp.voidcmd("CWD #{cwd}")
}
if typecode
# xxx: typecode D is not handled.
ftp.voidcmd("TYPE #{typecode.upcase}")
end
if options[:content_length_proc]
options[:content_length_proc].call(ftp.size(filename))
end
ftp.retrbinary("RETR #{filename}", 4096) { |str|
buf << str
options[:progress_proc].call(buf.size) if options[:progress_proc]
}
ftp.close
buf.io.rewind
end
include OpenURI::OpenRead
end
end
share/ruby/unicode_normalize/normalize.rb 0000644 00000014003 15173517735 0014676 0 ustar 00 # coding: utf-8
# frozen_string_literal: false
# Copyright Ayumu Nojima (野島 歩) and Martin J. Dürst (duerst@it.aoyama.ac.jp)
# This file, the companion file tables.rb (autogenerated), and the module,
# constants, and method defined herein are part of the implementation of the
# built-in String class, not part of the standard library. They should
# therefore never be gemified. They implement the methods
# String#unicode_normalize, String#unicode_normalize!, and String#unicode_normalized?.
#
# They are placed here because they are written in Ruby. They are loaded on
# demand when any of the three methods mentioned above is executed for the
# first time. This reduces the memory footprint and startup time for scripts
# and applications that do not use those methods.
#
# The name and even the existence of the module UnicodeNormalize and all of its
# content are purely an implementation detail, and should not be exposed in
# any test or spec or otherwise.
require_relative 'tables'
# :stopdoc:
module UnicodeNormalize # :nodoc:
## Constant for max hash capacity to avoid DoS attack
MAX_HASH_LENGTH = 18000 # enough for all test cases, otherwise tests get slow
## Regular Expressions and Hash Constants
REGEXP_D = Regexp.compile(REGEXP_D_STRING, Regexp::EXTENDED)
REGEXP_C = Regexp.compile(REGEXP_C_STRING, Regexp::EXTENDED)
REGEXP_K = Regexp.compile(REGEXP_K_STRING, Regexp::EXTENDED)
NF_HASH_D = Hash.new do |hash, key|
hash.shift if hash.length>MAX_HASH_LENGTH # prevent DoS attack
hash[key] = nfd_one(key)
end
NF_HASH_C = Hash.new do |hash, key|
hash.shift if hash.length>MAX_HASH_LENGTH # prevent DoS attack
hash[key] = nfc_one(key)
end
## Constants For Hangul
# for details such as the meaning of the identifiers below, please see
# http://www.unicode.org/versions/Unicode7.0.0/ch03.pdf, pp. 144/145
SBASE = 0xAC00
LBASE = 0x1100
VBASE = 0x1161
TBASE = 0x11A7
LCOUNT = 19
VCOUNT = 21
TCOUNT = 28
NCOUNT = VCOUNT * TCOUNT
SCOUNT = LCOUNT * NCOUNT
# Unicode-based encodings (except UTF-8)
UNICODE_ENCODINGS = [Encoding::UTF_16BE, Encoding::UTF_16LE, Encoding::UTF_32BE, Encoding::UTF_32LE,
Encoding::GB18030, Encoding::UCS_2BE, Encoding::UCS_4BE]
## Hangul Algorithm
def self.hangul_decomp_one(target)
syllable_index = target.ord - SBASE
return target if syllable_index < 0 || syllable_index >= SCOUNT
l = LBASE + syllable_index / NCOUNT
v = VBASE + (syllable_index % NCOUNT) / TCOUNT
t = TBASE + syllable_index % TCOUNT
(t==TBASE ? [l, v] : [l, v, t]).pack('U*') + target[1..-1]
end
def self.hangul_comp_one(string)
length = string.length
if length>1 and 0 <= (lead =string[0].ord-LBASE) and lead < LCOUNT and
0 <= (vowel=string[1].ord-VBASE) and vowel < VCOUNT
lead_vowel = SBASE + (lead * VCOUNT + vowel) * TCOUNT
if length>2 and 0 < (trail=string[2].ord-TBASE) and trail < TCOUNT
(lead_vowel + trail).chr(Encoding::UTF_8) + string[3..-1]
else
lead_vowel.chr(Encoding::UTF_8) + string[2..-1]
end
else
string
end
end
## Canonical Ordering
def self.canonical_ordering_one(string)
sorting = string.each_char.collect { |c| [c, CLASS_TABLE[c]] }
(sorting.length-2).downto(0) do |i| # almost, but not exactly bubble sort
(0..i).each do |j|
later_class = sorting[j+1].last
if 0<later_class and later_class<sorting[j].last
sorting[j], sorting[j+1] = sorting[j+1], sorting[j]
end
end
end
return sorting.collect(&:first).join('')
end
## Normalization Forms for Patterns (not whole Strings)
def self.nfd_one(string)
string = string.chars.map! {|c| DECOMPOSITION_TABLE[c] || c}.join('')
canonical_ordering_one(hangul_decomp_one(string))
end
def self.nfc_one(string)
nfd_string = nfd_one string
start = nfd_string[0]
last_class = CLASS_TABLE[start]-1
accents = ''
nfd_string[1..-1].each_char do |accent|
accent_class = CLASS_TABLE[accent]
if last_class<accent_class and composite = COMPOSITION_TABLE[start+accent]
start = composite
else
accents << accent
last_class = accent_class
end
end
hangul_comp_one(start+accents)
end
def self.normalize(string, form = :nfc)
encoding = string.encoding
case encoding
when Encoding::UTF_8
case form
when :nfc then
string.gsub REGEXP_C, NF_HASH_C
when :nfd then
string.gsub REGEXP_D, NF_HASH_D
when :nfkc then
string.gsub(REGEXP_K, KOMPATIBLE_TABLE).gsub(REGEXP_C, NF_HASH_C)
when :nfkd then
string.gsub(REGEXP_K, KOMPATIBLE_TABLE).gsub(REGEXP_D, NF_HASH_D)
else
raise ArgumentError, "Invalid normalization form #{form}."
end
when Encoding::US_ASCII
string
when *UNICODE_ENCODINGS
normalize(string.encode(Encoding::UTF_8), form).encode(encoding)
else
raise Encoding::CompatibilityError, "Unicode Normalization not appropriate for #{encoding}"
end
end
def self.normalized?(string, form = :nfc)
encoding = string.encoding
case encoding
when Encoding::UTF_8
case form
when :nfc then
string.scan REGEXP_C do |match|
return false if NF_HASH_C[match] != match
end
true
when :nfd then
string.scan REGEXP_D do |match|
return false if NF_HASH_D[match] != match
end
true
when :nfkc then
normalized?(string, :nfc) and string !~ REGEXP_K
when :nfkd then
normalized?(string, :nfd) and string !~ REGEXP_K
else
raise ArgumentError, "Invalid normalization form #{form}."
end
when Encoding::US_ASCII
true
when *UNICODE_ENCODINGS
normalized? string.encode(Encoding::UTF_8), form
else
raise Encoding::CompatibilityError, "Unicode Normalization not appropriate for #{encoding}"
end
end
end # module
share/ruby/unicode_normalize/tables.rb 0000644 00000666566 15173517735 0014203 0 ustar 00 # coding: us-ascii
# frozen_string_literal: true
# automatically generated by template/unicode_norm_gen.tmpl
module UnicodeNormalize # :nodoc:
accents = "" \
"[\u0300-\u034E" \
"\u0350-\u036F" \
"\u0483-\u0487" \
"\u0591-\u05BD" \
"\u05BF" \
"\u05C1\u05C2" \
"\u05C4\u05C5" \
"\u05C7" \
"\u0610-\u061A" \
"\u064B-\u065F" \
"\u0670" \
"\u06D6-\u06DC" \
"\u06DF-\u06E4" \
"\u06E7\u06E8" \
"\u06EA-\u06ED" \
"\u0711" \
"\u0730-\u074A" \
"\u07EB-\u07F3" \
"\u07FD" \
"\u0816-\u0819" \
"\u081B-\u0823" \
"\u0825-\u0827" \
"\u0829-\u082D" \
"\u0859-\u085B" \
"\u0898-\u089F" \
"\u08CA-\u08E1" \
"\u08E3-\u08FF" \
"\u093C" \
"\u094D" \
"\u0951-\u0954" \
"\u09BC" \
"\u09BE" \
"\u09CD" \
"\u09D7" \
"\u09FE" \
"\u0A3C" \
"\u0A4D" \
"\u0ABC" \
"\u0ACD" \
"\u0B3C" \
"\u0B3E" \
"\u0B4D" \
"\u0B56\u0B57" \
"\u0BBE" \
"\u0BCD" \
"\u0BD7" \
"\u0C3C" \
"\u0C4D" \
"\u0C55\u0C56" \
"\u0CBC" \
"\u0CC2" \
"\u0CCD" \
"\u0CD5\u0CD6" \
"\u0D3B\u0D3C" \
"\u0D3E" \
"\u0D4D" \
"\u0D57" \
"\u0DCA" \
"\u0DCF" \
"\u0DDF" \
"\u0E38-\u0E3A" \
"\u0E48-\u0E4B" \
"\u0EB8-\u0EBA" \
"\u0EC8-\u0ECB" \
"\u0F18\u0F19" \
"\u0F35" \
"\u0F37" \
"\u0F39" \
"\u0F71\u0F72" \
"\u0F74" \
"\u0F7A-\u0F7D" \
"\u0F80" \
"\u0F82-\u0F84" \
"\u0F86\u0F87" \
"\u0FC6" \
"\u102E" \
"\u1037" \
"\u1039\u103A" \
"\u108D" \
"\u135D-\u135F" \
"\u1714\u1715" \
"\u1734" \
"\u17D2" \
"\u17DD" \
"\u18A9" \
"\u1939-\u193B" \
"\u1A17\u1A18" \
"\u1A60" \
"\u1A75-\u1A7C" \
"\u1A7F" \
"\u1AB0-\u1ABD" \
"\u1ABF-\u1ACE" \
"\u1B34\u1B35" \
"\u1B44" \
"\u1B6B-\u1B73" \
"\u1BAA\u1BAB" \
"\u1BE6" \
"\u1BF2\u1BF3" \
"\u1C37" \
"\u1CD0-\u1CD2" \
"\u1CD4-\u1CE0" \
"\u1CE2-\u1CE8" \
"\u1CED" \
"\u1CF4" \
"\u1CF8\u1CF9" \
"\u1DC0-\u1DFF" \
"\u20D0-\u20DC" \
"\u20E1" \
"\u20E5-\u20F0" \
"\u2CEF-\u2CF1" \
"\u2D7F" \
"\u2DE0-\u2DFF" \
"\u302A-\u302F" \
"\u3099\u309A" \
"\uA66F" \
"\uA674-\uA67D" \
"\uA69E\uA69F" \
"\uA6F0\uA6F1" \
"\uA806" \
"\uA82C" \
"\uA8C4" \
"\uA8E0-\uA8F1" \
"\uA92B-\uA92D" \
"\uA953" \
"\uA9B3" \
"\uA9C0" \
"\uAAB0" \
"\uAAB2-\uAAB4" \
"\uAAB7\uAAB8" \
"\uAABE\uAABF" \
"\uAAC1" \
"\uAAF6" \
"\uABED" \
"\uFB1E" \
"\uFE20-\uFE2F" \
"\u{101FD}" \
"\u{102E0}" \
"\u{10376}-\u{1037A}" \
"\u{10A0D}" \
"\u{10A0F}" \
"\u{10A38}-\u{10A3A}" \
"\u{10A3F}" \
"\u{10AE5}\u{10AE6}" \
"\u{10D24}-\u{10D27}" \
"\u{10EAB}\u{10EAC}" \
"\u{10EFD}-\u{10EFF}" \
"\u{10F46}-\u{10F50}" \
"\u{10F82}-\u{10F85}" \
"\u{11046}" \
"\u{11070}" \
"\u{1107F}" \
"\u{110B9}\u{110BA}" \
"\u{11100}-\u{11102}" \
"\u{11127}" \
"\u{11133}\u{11134}" \
"\u{11173}" \
"\u{111C0}" \
"\u{111CA}" \
"\u{11235}\u{11236}" \
"\u{112E9}\u{112EA}" \
"\u{1133B}\u{1133C}" \
"\u{1133E}" \
"\u{1134D}" \
"\u{11357}" \
"\u{11366}-\u{1136C}" \
"\u{11370}-\u{11374}" \
"\u{11442}" \
"\u{11446}" \
"\u{1145E}" \
"\u{114B0}" \
"\u{114BA}" \
"\u{114BD}" \
"\u{114C2}\u{114C3}" \
"\u{115AF}" \
"\u{115BF}\u{115C0}" \
"\u{1163F}" \
"\u{116B6}\u{116B7}" \
"\u{1172B}" \
"\u{11839}\u{1183A}" \
"\u{11930}" \
"\u{1193D}\u{1193E}" \
"\u{11943}" \
"\u{119E0}" \
"\u{11A34}" \
"\u{11A47}" \
"\u{11A99}" \
"\u{11C3F}" \
"\u{11D42}" \
"\u{11D44}\u{11D45}" \
"\u{11D97}" \
"\u{11F41}\u{11F42}" \
"\u{16AF0}-\u{16AF4}" \
"\u{16B30}-\u{16B36}" \
"\u{16FF0}\u{16FF1}" \
"\u{1BC9E}" \
"\u{1D165}-\u{1D169}" \
"\u{1D16D}-\u{1D172}" \
"\u{1D17B}-\u{1D182}" \
"\u{1D185}-\u{1D18B}" \
"\u{1D1AA}-\u{1D1AD}" \
"\u{1D242}-\u{1D244}" \
"\u{1E000}-\u{1E006}" \
"\u{1E008}-\u{1E018}" \
"\u{1E01B}-\u{1E021}" \
"\u{1E023}\u{1E024}" \
"\u{1E026}-\u{1E02A}" \
"\u{1E08F}" \
"\u{1E130}-\u{1E136}" \
"\u{1E2AE}" \
"\u{1E2EC}-\u{1E2EF}" \
"\u{1E4EC}-\u{1E4EF}" \
"\u{1E8D0}-\u{1E8D6}" \
"\u{1E944}-\u{1E94A}" \
"]"
ACCENTS = accents
REGEXP_D_STRING = "#{'' # composition starters and composition exclusions
}" \
"[\u00C0-\u00C5" \
"\u00C7-\u00CF" \
"\u00D1-\u00D6" \
"\u00D9-\u00DD" \
"\u00E0-\u00E5" \
"\u00E7-\u00EF" \
"\u00F1-\u00F6" \
"\u00F9-\u00FD" \
"\u00FF-\u010F" \
"\u0112-\u0125" \
"\u0128-\u0130" \
"\u0134-\u0137" \
"\u0139-\u013E" \
"\u0143-\u0148" \
"\u014C-\u0151" \
"\u0154-\u0165" \
"\u0168-\u017E" \
"\u01A0\u01A1" \
"\u01AF\u01B0" \
"\u01CD-\u01DC" \
"\u01DE-\u01E3" \
"\u01E6-\u01F0" \
"\u01F4\u01F5" \
"\u01F8-\u021B" \
"\u021E\u021F" \
"\u0226-\u0233" \
"\u0340\u0341" \
"\u0343\u0344" \
"\u0374" \
"\u037E" \
"\u0385-\u038A" \
"\u038C" \
"\u038E-\u0390" \
"\u03AA-\u03B0" \
"\u03CA-\u03CE" \
"\u03D3\u03D4" \
"\u0400\u0401" \
"\u0403" \
"\u0407" \
"\u040C-\u040E" \
"\u0419" \
"\u0439" \
"\u0450\u0451" \
"\u0453" \
"\u0457" \
"\u045C-\u045E" \
"\u0476\u0477" \
"\u04C1\u04C2" \
"\u04D0-\u04D3" \
"\u04D6\u04D7" \
"\u04DA-\u04DF" \
"\u04E2-\u04E7" \
"\u04EA-\u04F5" \
"\u04F8\u04F9" \
"\u0622-\u0626" \
"\u06C0" \
"\u06C2" \
"\u06D3" \
"\u0929" \
"\u0931" \
"\u0934" \
"\u0958-\u095F" \
"\u09CB\u09CC" \
"\u09DC\u09DD" \
"\u09DF" \
"\u0A33" \
"\u0A36" \
"\u0A59-\u0A5B" \
"\u0A5E" \
"\u0B48" \
"\u0B4B\u0B4C" \
"\u0B5C\u0B5D" \
"\u0B94" \
"\u0BCA-\u0BCC" \
"\u0C48" \
"\u0CC0" \
"\u0CC7\u0CC8" \
"\u0CCA\u0CCB" \
"\u0D4A-\u0D4C" \
"\u0DDA" \
"\u0DDC-\u0DDE" \
"\u0F43" \
"\u0F4D" \
"\u0F52" \
"\u0F57" \
"\u0F5C" \
"\u0F69" \
"\u0F73" \
"\u0F75\u0F76" \
"\u0F78" \
"\u0F81" \
"\u0F93" \
"\u0F9D" \
"\u0FA2" \
"\u0FA7" \
"\u0FAC" \
"\u0FB9" \
"\u1026" \
"\u1B06" \
"\u1B08" \
"\u1B0A" \
"\u1B0C" \
"\u1B0E" \
"\u1B12" \
"\u1B3B" \
"\u1B3D" \
"\u1B40\u1B41" \
"\u1B43" \
"\u1E00-\u1E99" \
"\u1E9B" \
"\u1EA0-\u1EF9" \
"\u1F00-\u1F15" \
"\u1F18-\u1F1D" \
"\u1F20-\u1F45" \
"\u1F48-\u1F4D" \
"\u1F50-\u1F57" \
"\u1F59" \
"\u1F5B" \
"\u1F5D" \
"\u1F5F-\u1F7D" \
"\u1F80-\u1FB4" \
"\u1FB6-\u1FBC" \
"\u1FBE" \
"\u1FC1-\u1FC4" \
"\u1FC6-\u1FD3" \
"\u1FD6-\u1FDB" \
"\u1FDD-\u1FEF" \
"\u1FF2-\u1FF4" \
"\u1FF6-\u1FFD" \
"\u2000\u2001" \
"\u2126" \
"\u212A\u212B" \
"\u219A\u219B" \
"\u21AE" \
"\u21CD-\u21CF" \
"\u2204" \
"\u2209" \
"\u220C" \
"\u2224" \
"\u2226" \
"\u2241" \
"\u2244" \
"\u2247" \
"\u2249" \
"\u2260" \
"\u2262" \
"\u226D-\u2271" \
"\u2274\u2275" \
"\u2278\u2279" \
"\u2280\u2281" \
"\u2284\u2285" \
"\u2288\u2289" \
"\u22AC-\u22AF" \
"\u22E0-\u22E3" \
"\u22EA-\u22ED" \
"\u2329\u232A" \
"\u2ADC" \
"\u304C" \
"\u304E" \
"\u3050" \
"\u3052" \
"\u3054" \
"\u3056" \
"\u3058" \
"\u305A" \
"\u305C" \
"\u305E" \
"\u3060" \
"\u3062" \
"\u3065" \
"\u3067" \
"\u3069" \
"\u3070\u3071" \
"\u3073\u3074" \
"\u3076\u3077" \
"\u3079\u307A" \
"\u307C\u307D" \
"\u3094" \
"\u309E" \
"\u30AC" \
"\u30AE" \
"\u30B0" \
"\u30B2" \
"\u30B4" \
"\u30B6" \
"\u30B8" \
"\u30BA" \
"\u30BC" \
"\u30BE" \
"\u30C0" \
"\u30C2" \
"\u30C5" \
"\u30C7" \
"\u30C9" \
"\u30D0\u30D1" \
"\u30D3\u30D4" \
"\u30D6\u30D7" \
"\u30D9\u30DA" \
"\u30DC\u30DD" \
"\u30F4" \
"\u30F7-\u30FA" \
"\u30FE" \
"\uF900-\uFA0D" \
"\uFA10" \
"\uFA12" \
"\uFA15-\uFA1E" \
"\uFA20" \
"\uFA22" \
"\uFA25\uFA26" \
"\uFA2A-\uFA6D" \
"\uFA70-\uFAD9" \
"\uFB1D" \
"\uFB1F" \
"\uFB2A-\uFB36" \
"\uFB38-\uFB3C" \
"\uFB3E" \
"\uFB40\uFB41" \
"\uFB43\uFB44" \
"\uFB46-\uFB4E" \
"\u{1109A}" \
"\u{1109C}" \
"\u{110AB}" \
"\u{1112E}\u{1112F}" \
"\u{1134B}\u{1134C}" \
"\u{114BB}\u{114BC}" \
"\u{114BE}" \
"\u{115BA}\u{115BB}" \
"\u{11938}" \
"\u{1D15E}-\u{1D164}" \
"\u{1D1BB}-\u{1D1C0}" \
"\u{2F800}-\u{2FA1D}" \
"]#{accents}*" \
"|#{'' # characters that can be the result of a composition, except composition starters
}" \
"[<->" \
"A-P" \
"R-Z" \
"a-p" \
"r-z" \
"\u00A8" \
"\u00C6" \
"\u00D8" \
"\u00E6" \
"\u00F8" \
"\u017F" \
"\u01B7" \
"\u0292" \
"\u0391" \
"\u0395" \
"\u0397" \
"\u0399" \
"\u039F" \
"\u03A1" \
"\u03A5" \
"\u03A9" \
"\u03B1" \
"\u03B5" \
"\u03B7" \
"\u03B9" \
"\u03BF" \
"\u03C1" \
"\u03C5" \
"\u03C9" \
"\u03D2" \
"\u0406" \
"\u0410" \
"\u0413" \
"\u0415-\u0418" \
"\u041A" \
"\u041E" \
"\u0423" \
"\u0427" \
"\u042B" \
"\u042D" \
"\u0430" \
"\u0433" \
"\u0435-\u0438" \
"\u043A" \
"\u043E" \
"\u0443" \
"\u0447" \
"\u044B" \
"\u044D" \
"\u0456" \
"\u0474\u0475" \
"\u04D8\u04D9" \
"\u04E8\u04E9" \
"\u0627" \
"\u0648" \
"\u064A" \
"\u06C1" \
"\u06D2" \
"\u06D5" \
"\u0928" \
"\u0930" \
"\u0933" \
"\u09C7" \
"\u0B47" \
"\u0B92" \
"\u0BC6\u0BC7" \
"\u0C46" \
"\u0CBF" \
"\u0CC6" \
"\u0D46\u0D47" \
"\u0DD9" \
"\u1025" \
"\u1B05" \
"\u1B07" \
"\u1B09" \
"\u1B0B" \
"\u1B0D" \
"\u1B11" \
"\u1B3A" \
"\u1B3C" \
"\u1B3E\u1B3F" \
"\u1B42" \
"\u1FBF" \
"\u1FFE" \
"\u2190" \
"\u2192" \
"\u2194" \
"\u21D0" \
"\u21D2" \
"\u21D4" \
"\u2203" \
"\u2208" \
"\u220B" \
"\u2223" \
"\u2225" \
"\u223C" \
"\u2243" \
"\u2245" \
"\u2248" \
"\u224D" \
"\u2261" \
"\u2264\u2265" \
"\u2272\u2273" \
"\u2276\u2277" \
"\u227A-\u227D" \
"\u2282\u2283" \
"\u2286\u2287" \
"\u2291\u2292" \
"\u22A2" \
"\u22A8\u22A9" \
"\u22AB" \
"\u22B2-\u22B5" \
"\u3046" \
"\u304B" \
"\u304D" \
"\u304F" \
"\u3051" \
"\u3053" \
"\u3055" \
"\u3057" \
"\u3059" \
"\u305B" \
"\u305D" \
"\u305F" \
"\u3061" \
"\u3064" \
"\u3066" \
"\u3068" \
"\u306F" \
"\u3072" \
"\u3075" \
"\u3078" \
"\u307B" \
"\u309D" \
"\u30A6" \
"\u30AB" \
"\u30AD" \
"\u30AF" \
"\u30B1" \
"\u30B3" \
"\u30B5" \
"\u30B7" \
"\u30B9" \
"\u30BB" \
"\u30BD" \
"\u30BF" \
"\u30C1" \
"\u30C4" \
"\u30C6" \
"\u30C8" \
"\u30CF" \
"\u30D2" \
"\u30D5" \
"\u30D8" \
"\u30DB" \
"\u30EF-\u30F2" \
"\u30FD" \
"\u{11099}" \
"\u{1109B}" \
"\u{110A5}" \
"\u{11131}\u{11132}" \
"\u{11347}" \
"\u{114B9}" \
"\u{115B8}\u{115B9}" \
"\u{11935}" \
"]?#{accents}+" \
"|#{'' # precomposed Hangul syllables
}" \
"[\u{AC00}-\u{D7A4}]"
REGEXP_C_STRING = "#{'' # composition exclusions
}" \
"[\u0340\u0341" \
"\u0343\u0344" \
"\u0374" \
"\u037E" \
"\u0387" \
"\u0958-\u095F" \
"\u09DC\u09DD" \
"\u09DF" \
"\u0A33" \
"\u0A36" \
"\u0A59-\u0A5B" \
"\u0A5E" \
"\u0B5C\u0B5D" \
"\u0F43" \
"\u0F4D" \
"\u0F52" \
"\u0F57" \
"\u0F5C" \
"\u0F69" \
"\u0F73" \
"\u0F75\u0F76" \
"\u0F78" \
"\u0F81" \
"\u0F93" \
"\u0F9D" \
"\u0FA2" \
"\u0FA7" \
"\u0FAC" \
"\u0FB9" \
"\u1F71" \
"\u1F73" \
"\u1F75" \
"\u1F77" \
"\u1F79" \
"\u1F7B" \
"\u1F7D" \
"\u1FBB" \
"\u1FBE" \
"\u1FC9" \
"\u1FCB" \
"\u1FD3" \
"\u1FDB" \
"\u1FE3" \
"\u1FEB" \
"\u1FEE\u1FEF" \
"\u1FF9" \
"\u1FFB" \
"\u1FFD" \
"\u2000\u2001" \
"\u2126" \
"\u212A\u212B" \
"\u2329\u232A" \
"\u2ADC" \
"\uF900-\uFA0D" \
"\uFA10" \
"\uFA12" \
"\uFA15-\uFA1E" \
"\uFA20" \
"\uFA22" \
"\uFA25\uFA26" \
"\uFA2A-\uFA6D" \
"\uFA70-\uFAD9" \
"\uFB1D" \
"\uFB1F" \
"\uFB2A-\uFB36" \
"\uFB38-\uFB3C" \
"\uFB3E" \
"\uFB40\uFB41" \
"\uFB43\uFB44" \
"\uFB46-\uFB4E" \
"\u{1D15E}-\u{1D164}" \
"\u{1D1BB}-\u{1D1C0}" \
"\u{2F800}-\u{2FA1D}" \
"]#{accents}*" \
"|#{'' # composition starters and characters that can be the result of a composition
}" \
"[<->" \
"A-P" \
"R-Z" \
"a-p" \
"r-z" \
"\u00A8" \
"\u00C0-\u00CF" \
"\u00D1-\u00D6" \
"\u00D8-\u00DD" \
"\u00E0-\u00EF" \
"\u00F1-\u00F6" \
"\u00F8-\u00FD" \
"\u00FF-\u010F" \
"\u0112-\u0125" \
"\u0128-\u0130" \
"\u0134-\u0137" \
"\u0139-\u013E" \
"\u0143-\u0148" \
"\u014C-\u0151" \
"\u0154-\u0165" \
"\u0168-\u017F" \
"\u01A0\u01A1" \
"\u01AF\u01B0" \
"\u01B7" \
"\u01CD-\u01DC" \
"\u01DE-\u01E3" \
"\u01E6-\u01F0" \
"\u01F4\u01F5" \
"\u01F8-\u021B" \
"\u021E\u021F" \
"\u0226-\u0233" \
"\u0292" \
"\u0385\u0386" \
"\u0388-\u038A" \
"\u038C" \
"\u038E-\u0391" \
"\u0395" \
"\u0397" \
"\u0399" \
"\u039F" \
"\u03A1" \
"\u03A5" \
"\u03A9-\u03B1" \
"\u03B5" \
"\u03B7" \
"\u03B9" \
"\u03BF" \
"\u03C1" \
"\u03C5" \
"\u03C9-\u03CE" \
"\u03D2-\u03D4" \
"\u0400\u0401" \
"\u0403" \
"\u0406\u0407" \
"\u040C-\u040E" \
"\u0410" \
"\u0413" \
"\u0415-\u041A" \
"\u041E" \
"\u0423" \
"\u0427" \
"\u042B" \
"\u042D" \
"\u0430" \
"\u0433" \
"\u0435-\u043A" \
"\u043E" \
"\u0443" \
"\u0447" \
"\u044B" \
"\u044D" \
"\u0450\u0451" \
"\u0453" \
"\u0456\u0457" \
"\u045C-\u045E" \
"\u0474-\u0477" \
"\u04C1\u04C2" \
"\u04D0-\u04D3" \
"\u04D6-\u04DF" \
"\u04E2-\u04F5" \
"\u04F8\u04F9" \
"\u0622-\u0627" \
"\u0648" \
"\u064A" \
"\u06C0-\u06C2" \
"\u06D2\u06D3" \
"\u06D5" \
"\u0928\u0929" \
"\u0930\u0931" \
"\u0933\u0934" \
"\u09C7" \
"\u09CB\u09CC" \
"\u0B47\u0B48" \
"\u0B4B\u0B4C" \
"\u0B92" \
"\u0B94" \
"\u0BC6\u0BC7" \
"\u0BCA-\u0BCC" \
"\u0C46" \
"\u0C48" \
"\u0CBF\u0CC0" \
"\u0CC6-\u0CC8" \
"\u0CCA\u0CCB" \
"\u0D46\u0D47" \
"\u0D4A-\u0D4C" \
"\u0DD9\u0DDA" \
"\u0DDC-\u0DDE" \
"\u1025\u1026" \
"\u1B05-\u1B0E" \
"\u1B11\u1B12" \
"\u1B3A-\u1B43" \
"\u1E00-\u1E99" \
"\u1E9B" \
"\u1EA0-\u1EF9" \
"\u1F00-\u1F15" \
"\u1F18-\u1F1D" \
"\u1F20-\u1F45" \
"\u1F48-\u1F4D" \
"\u1F50-\u1F57" \
"\u1F59" \
"\u1F5B" \
"\u1F5D" \
"\u1F5F-\u1F70" \
"\u1F72" \
"\u1F74" \
"\u1F76" \
"\u1F78" \
"\u1F7A" \
"\u1F7C" \
"\u1F80-\u1FB4" \
"\u1FB6-\u1FBA" \
"\u1FBC" \
"\u1FBF" \
"\u1FC1-\u1FC4" \
"\u1FC6-\u1FC8" \
"\u1FCA" \
"\u1FCC-\u1FD2" \
"\u1FD6-\u1FDA" \
"\u1FDD-\u1FE2" \
"\u1FE4-\u1FEA" \
"\u1FEC\u1FED" \
"\u1FF2-\u1FF4" \
"\u1FF6-\u1FF8" \
"\u1FFA" \
"\u1FFC" \
"\u1FFE" \
"\u2190" \
"\u2192" \
"\u2194" \
"\u219A\u219B" \
"\u21AE" \
"\u21CD-\u21D0" \
"\u21D2" \
"\u21D4" \
"\u2203\u2204" \
"\u2208\u2209" \
"\u220B\u220C" \
"\u2223-\u2226" \
"\u223C" \
"\u2241" \
"\u2243-\u2245" \
"\u2247-\u2249" \
"\u224D" \
"\u2260-\u2262" \
"\u2264\u2265" \
"\u226D-\u227D" \
"\u2280-\u2289" \
"\u2291\u2292" \
"\u22A2" \
"\u22A8\u22A9" \
"\u22AB-\u22AF" \
"\u22B2-\u22B5" \
"\u22E0-\u22E3" \
"\u22EA-\u22ED" \
"\u3046" \
"\u304B-\u3062" \
"\u3064-\u3069" \
"\u306F-\u307D" \
"\u3094" \
"\u309D\u309E" \
"\u30A6" \
"\u30AB-\u30C2" \
"\u30C4-\u30C9" \
"\u30CF-\u30DD" \
"\u30EF-\u30F2" \
"\u30F4" \
"\u30F7-\u30FA" \
"\u30FD\u30FE" \
"\u{11099}-\u{1109C}" \
"\u{110A5}" \
"\u{110AB}" \
"\u{1112E}\u{1112F}" \
"\u{11131}\u{11132}" \
"\u{11347}" \
"\u{1134B}\u{1134C}" \
"\u{114B9}" \
"\u{114BB}\u{114BC}" \
"\u{114BE}" \
"\u{115B8}-\u{115BB}" \
"\u{11935}" \
"\u{11938}" \
"]?#{accents}+" \
"|#{'' # Hangul syllables with separate trailer
}" \
"[\uAC00" \
"\uAC1C" \
"\uAC38" \
"\uAC54" \
"\uAC70" \
"\uAC8C" \
"\uACA8" \
"\uACC4" \
"\uACE0" \
"\uACFC" \
"\uAD18" \
"\uAD34" \
"\uAD50" \
"\uAD6C" \
"\uAD88" \
"\uADA4" \
"\uADC0" \
"\uADDC" \
"\uADF8" \
"\uAE14" \
"\uAE30" \
"\uAE4C" \
"\uAE68" \
"\uAE84" \
"\uAEA0" \
"\uAEBC" \
"\uAED8" \
"\uAEF4" \
"\uAF10" \
"\uAF2C" \
"\uAF48" \
"\uAF64" \
"\uAF80" \
"\uAF9C" \
"\uAFB8" \
"\uAFD4" \
"\uAFF0" \
"\uB00C" \
"\uB028" \
"\uB044" \
"\uB060" \
"\uB07C" \
"\uB098" \
"\uB0B4" \
"\uB0D0" \
"\uB0EC" \
"\uB108" \
"\uB124" \
"\uB140" \
"\uB15C" \
"\uB178" \
"\uB194" \
"\uB1B0" \
"\uB1CC" \
"\uB1E8" \
"\uB204" \
"\uB220" \
"\uB23C" \
"\uB258" \
"\uB274" \
"\uB290" \
"\uB2AC" \
"\uB2C8" \
"\uB2E4" \
"\uB300" \
"\uB31C" \
"\uB338" \
"\uB354" \
"\uB370" \
"\uB38C" \
"\uB3A8" \
"\uB3C4" \
"\uB3E0" \
"\uB3FC" \
"\uB418" \
"\uB434" \
"\uB450" \
"\uB46C" \
"\uB488" \
"\uB4A4" \
"\uB4C0" \
"\uB4DC" \
"\uB4F8" \
"\uB514" \
"\uB530" \
"\uB54C" \
"\uB568" \
"\uB584" \
"\uB5A0" \
"\uB5BC" \
"\uB5D8" \
"\uB5F4" \
"\uB610" \
"\uB62C" \
"\uB648" \
"\uB664" \
"\uB680" \
"\uB69C" \
"\uB6B8" \
"\uB6D4" \
"\uB6F0" \
"\uB70C" \
"\uB728" \
"\uB744" \
"\uB760" \
"\uB77C" \
"\uB798" \
"\uB7B4" \
"\uB7D0" \
"\uB7EC" \
"\uB808" \
"\uB824" \
"\uB840" \
"\uB85C" \
"\uB878" \
"\uB894" \
"\uB8B0" \
"\uB8CC" \
"\uB8E8" \
"\uB904" \
"\uB920" \
"\uB93C" \
"\uB958" \
"\uB974" \
"\uB990" \
"\uB9AC" \
"\uB9C8" \
"\uB9E4" \
"\uBA00" \
"\uBA1C" \
"\uBA38" \
"\uBA54" \
"\uBA70" \
"\uBA8C" \
"\uBAA8" \
"\uBAC4" \
"\uBAE0" \
"\uBAFC" \
"\uBB18" \
"\uBB34" \
"\uBB50" \
"\uBB6C" \
"\uBB88" \
"\uBBA4" \
"\uBBC0" \
"\uBBDC" \
"\uBBF8" \
"\uBC14" \
"\uBC30" \
"\uBC4C" \
"\uBC68" \
"\uBC84" \
"\uBCA0" \
"\uBCBC" \
"\uBCD8" \
"\uBCF4" \
"\uBD10" \
"\uBD2C" \
"\uBD48" \
"\uBD64" \
"\uBD80" \
"\uBD9C" \
"\uBDB8" \
"\uBDD4" \
"\uBDF0" \
"\uBE0C" \
"\uBE28" \
"\uBE44" \
"\uBE60" \
"\uBE7C" \
"\uBE98" \
"\uBEB4" \
"\uBED0" \
"\uBEEC" \
"\uBF08" \
"\uBF24" \
"\uBF40" \
"\uBF5C" \
"\uBF78" \
"\uBF94" \
"\uBFB0" \
"\uBFCC" \
"\uBFE8" \
"\uC004" \
"\uC020" \
"\uC03C" \
"\uC058" \
"\uC074" \
"\uC090" \
"\uC0AC" \
"\uC0C8" \
"\uC0E4" \
"\uC100" \
"\uC11C" \
"\uC138" \
"\uC154" \
"\uC170" \
"\uC18C" \
"\uC1A8" \
"\uC1C4" \
"\uC1E0" \
"\uC1FC" \
"\uC218" \
"\uC234" \
"\uC250" \
"\uC26C" \
"\uC288" \
"\uC2A4" \
"\uC2C0" \
"\uC2DC" \
"\uC2F8" \
"\uC314" \
"\uC330" \
"\uC34C" \
"\uC368" \
"\uC384" \
"\uC3A0" \
"\uC3BC" \
"\uC3D8" \
"\uC3F4" \
"\uC410" \
"\uC42C" \
"\uC448" \
"\uC464" \
"\uC480" \
"\uC49C" \
"\uC4B8" \
"\uC4D4" \
"\uC4F0" \
"\uC50C" \
"\uC528" \
"\uC544" \
"\uC560" \
"\uC57C" \
"\uC598" \
"\uC5B4" \
"\uC5D0" \
"\uC5EC" \
"\uC608" \
"\uC624" \
"\uC640" \
"\uC65C" \
"\uC678" \
"\uC694" \
"\uC6B0" \
"\uC6CC" \
"\uC6E8" \
"\uC704" \
"\uC720" \
"\uC73C" \
"\uC758" \
"\uC774" \
"\uC790" \
"\uC7AC" \
"\uC7C8" \
"\uC7E4" \
"\uC800" \
"\uC81C" \
"\uC838" \
"\uC854" \
"\uC870" \
"\uC88C" \
"\uC8A8" \
"\uC8C4" \
"\uC8E0" \
"\uC8FC" \
"\uC918" \
"\uC934" \
"\uC950" \
"\uC96C" \
"\uC988" \
"\uC9A4" \
"\uC9C0" \
"\uC9DC" \
"\uC9F8" \
"\uCA14" \
"\uCA30" \
"\uCA4C" \
"\uCA68" \
"\uCA84" \
"\uCAA0" \
"\uCABC" \
"\uCAD8" \
"\uCAF4" \
"\uCB10" \
"\uCB2C" \
"\uCB48" \
"\uCB64" \
"\uCB80" \
"\uCB9C" \
"\uCBB8" \
"\uCBD4" \
"\uCBF0" \
"\uCC0C" \
"\uCC28" \
"\uCC44" \
"\uCC60" \
"\uCC7C" \
"\uCC98" \
"\uCCB4" \
"\uCCD0" \
"\uCCEC" \
"\uCD08" \
"\uCD24" \
"\uCD40" \
"\uCD5C" \
"\uCD78" \
"\uCD94" \
"\uCDB0" \
"\uCDCC" \
"\uCDE8" \
"\uCE04" \
"\uCE20" \
"\uCE3C" \
"\uCE58" \
"\uCE74" \
"\uCE90" \
"\uCEAC" \
"\uCEC8" \
"\uCEE4" \
"\uCF00" \
"\uCF1C" \
"\uCF38" \
"\uCF54" \
"\uCF70" \
"\uCF8C" \
"\uCFA8" \
"\uCFC4" \
"\uCFE0" \
"\uCFFC" \
"\uD018" \
"\uD034" \
"\uD050" \
"\uD06C" \
"\uD088" \
"\uD0A4" \
"\uD0C0" \
"\uD0DC" \
"\uD0F8" \
"\uD114" \
"\uD130" \
"\uD14C" \
"\uD168" \
"\uD184" \
"\uD1A0" \
"\uD1BC" \
"\uD1D8" \
"\uD1F4" \
"\uD210" \
"\uD22C" \
"\uD248" \
"\uD264" \
"\uD280" \
"\uD29C" \
"\uD2B8" \
"\uD2D4" \
"\uD2F0" \
"\uD30C" \
"\uD328" \
"\uD344" \
"\uD360" \
"\uD37C" \
"\uD398" \
"\uD3B4" \
"\uD3D0" \
"\uD3EC" \
"\uD408" \
"\uD424" \
"\uD440" \
"\uD45C" \
"\uD478" \
"\uD494" \
"\uD4B0" \
"\uD4CC" \
"\uD4E8" \
"\uD504" \
"\uD520" \
"\uD53C" \
"\uD558" \
"\uD574" \
"\uD590" \
"\uD5AC" \
"\uD5C8" \
"\uD5E4" \
"\uD600" \
"\uD61C" \
"\uD638" \
"\uD654" \
"\uD670" \
"\uD68C" \
"\uD6A8" \
"\uD6C4" \
"\uD6E0" \
"\uD6FC" \
"\uD718" \
"\uD734" \
"\uD750" \
"\uD76C" \
"\uD788" \
"][\u11A8-\u11C2]" \
"|#{'' # decomposed Hangul syllables
}" \
"[\u1100-\u1112][\u1161-\u1175][\u11A8-\u11C2]?"
REGEXP_K_STRING = "" \
"[\u00A0" \
"\u00A8" \
"\u00AA" \
"\u00AF" \
"\u00B2-\u00B5" \
"\u00B8-\u00BA" \
"\u00BC-\u00BE" \
"\u0132\u0133" \
"\u013F\u0140" \
"\u0149" \
"\u017F" \
"\u01C4-\u01CC" \
"\u01F1-\u01F3" \
"\u02B0-\u02B8" \
"\u02D8-\u02DD" \
"\u02E0-\u02E4" \
"\u037A" \
"\u0384\u0385" \
"\u03D0-\u03D6" \
"\u03F0-\u03F2" \
"\u03F4\u03F5" \
"\u03F9" \
"\u0587" \
"\u0675-\u0678" \
"\u0E33" \
"\u0EB3" \
"\u0EDC\u0EDD" \
"\u0F0C" \
"\u0F77" \
"\u0F79" \
"\u10FC" \
"\u1D2C-\u1D2E" \
"\u1D30-\u1D3A" \
"\u1D3C-\u1D4D" \
"\u1D4F-\u1D6A" \
"\u1D78" \
"\u1D9B-\u1DBF" \
"\u1E9A\u1E9B" \
"\u1FBD" \
"\u1FBF-\u1FC1" \
"\u1FCD-\u1FCF" \
"\u1FDD-\u1FDF" \
"\u1FED\u1FEE" \
"\u1FFD\u1FFE" \
"\u2000-\u200A" \
"\u2011" \
"\u2017" \
"\u2024-\u2026" \
"\u202F" \
"\u2033\u2034" \
"\u2036\u2037" \
"\u203C" \
"\u203E" \
"\u2047-\u2049" \
"\u2057" \
"\u205F" \
"\u2070\u2071" \
"\u2074-\u208E" \
"\u2090-\u209C" \
"\u20A8" \
"\u2100-\u2103" \
"\u2105-\u2107" \
"\u2109-\u2113" \
"\u2115\u2116" \
"\u2119-\u211D" \
"\u2120-\u2122" \
"\u2124" \
"\u2128" \
"\u212C\u212D" \
"\u212F-\u2131" \
"\u2133-\u2139" \
"\u213B-\u2140" \
"\u2145-\u2149" \
"\u2150-\u217F" \
"\u2189" \
"\u222C\u222D" \
"\u222F\u2230" \
"\u2460-\u24EA" \
"\u2A0C" \
"\u2A74-\u2A76" \
"\u2C7C\u2C7D" \
"\u2D6F" \
"\u2E9F" \
"\u2EF3" \
"\u2F00-\u2FD5" \
"\u3000" \
"\u3036" \
"\u3038-\u303A" \
"\u309B\u309C" \
"\u309F" \
"\u30FF" \
"\u3131-\u318E" \
"\u3192-\u319F" \
"\u3200-\u321E" \
"\u3220-\u3247" \
"\u3250-\u327E" \
"\u3280-\u33FF" \
"\uA69C\uA69D" \
"\uA770" \
"\uA7F2-\uA7F4" \
"\uA7F8\uA7F9" \
"\uAB5C-\uAB5F" \
"\uAB69" \
"\uFB00-\uFB06" \
"\uFB13-\uFB17" \
"\uFB20-\uFB29" \
"\uFB4F-\uFBB1" \
"\uFBD3-\uFD3D" \
"\uFD50-\uFD8F" \
"\uFD92-\uFDC7" \
"\uFDF0-\uFDFC" \
"\uFE10-\uFE19" \
"\uFE30-\uFE44" \
"\uFE47-\uFE52" \
"\uFE54-\uFE66" \
"\uFE68-\uFE6B" \
"\uFE70-\uFE72" \
"\uFE74" \
"\uFE76-\uFEFC" \
"\uFF01-\uFFBE" \
"\uFFC2-\uFFC7" \
"\uFFCA-\uFFCF" \
"\uFFD2-\uFFD7" \
"\uFFDA-\uFFDC" \
"\uFFE0-\uFFE6" \
"\uFFE8-\uFFEE" \
"\u{10781}-\u{10785}" \
"\u{10787}-\u{107B0}" \
"\u{107B2}-\u{107BA}" \
"\u{1D400}-\u{1D454}" \
"\u{1D456}-\u{1D49C}" \
"\u{1D49E}\u{1D49F}" \
"\u{1D4A2}" \
"\u{1D4A5}\u{1D4A6}" \
"\u{1D4A9}-\u{1D4AC}" \
"\u{1D4AE}-\u{1D4B9}" \
"\u{1D4BB}" \
"\u{1D4BD}-\u{1D4C3}" \
"\u{1D4C5}-\u{1D505}" \
"\u{1D507}-\u{1D50A}" \
"\u{1D50D}-\u{1D514}" \
"\u{1D516}-\u{1D51C}" \
"\u{1D51E}-\u{1D539}" \
"\u{1D53B}-\u{1D53E}" \
"\u{1D540}-\u{1D544}" \
"\u{1D546}" \
"\u{1D54A}-\u{1D550}" \
"\u{1D552}-\u{1D6A5}" \
"\u{1D6A8}-\u{1D7CB}" \
"\u{1D7CE}-\u{1D7FF}" \
"\u{1E030}-\u{1E06D}" \
"\u{1EE00}-\u{1EE03}" \
"\u{1EE05}-\u{1EE1F}" \
"\u{1EE21}\u{1EE22}" \
"\u{1EE24}" \
"\u{1EE27}" \
"\u{1EE29}-\u{1EE32}" \
"\u{1EE34}-\u{1EE37}" \
"\u{1EE39}" \
"\u{1EE3B}" \
"\u{1EE42}" \
"\u{1EE47}" \
"\u{1EE49}" \
"\u{1EE4B}" \
"\u{1EE4D}-\u{1EE4F}" \
"\u{1EE51}\u{1EE52}" \
"\u{1EE54}" \
"\u{1EE57}" \
"\u{1EE59}" \
"\u{1EE5B}" \
"\u{1EE5D}" \
"\u{1EE5F}" \
"\u{1EE61}\u{1EE62}" \
"\u{1EE64}" \
"\u{1EE67}-\u{1EE6A}" \
"\u{1EE6C}-\u{1EE72}" \
"\u{1EE74}-\u{1EE77}" \
"\u{1EE79}-\u{1EE7C}" \
"\u{1EE7E}" \
"\u{1EE80}-\u{1EE89}" \
"\u{1EE8B}-\u{1EE9B}" \
"\u{1EEA1}-\u{1EEA3}" \
"\u{1EEA5}-\u{1EEA9}" \
"\u{1EEAB}-\u{1EEBB}" \
"\u{1F100}-\u{1F10A}" \
"\u{1F110}-\u{1F12E}" \
"\u{1F130}-\u{1F14F}" \
"\u{1F16A}-\u{1F16C}" \
"\u{1F190}" \
"\u{1F200}-\u{1F202}" \
"\u{1F210}-\u{1F23B}" \
"\u{1F240}-\u{1F248}" \
"\u{1F250}\u{1F251}" \
"\u{1FBF0}-\u{1FBF9}" \
"]"
class_table = {
"\u0300"=>230,
"\u0301"=>230,
"\u0302"=>230,
"\u0303"=>230,
"\u0304"=>230,
"\u0305"=>230,
"\u0306"=>230,
"\u0307"=>230,
"\u0308"=>230,
"\u0309"=>230,
"\u030A"=>230,
"\u030B"=>230,
"\u030C"=>230,
"\u030D"=>230,
"\u030E"=>230,
"\u030F"=>230,
"\u0310"=>230,
"\u0311"=>230,
"\u0312"=>230,
"\u0313"=>230,
"\u0314"=>230,
"\u0315"=>232,
"\u0316"=>220,
"\u0317"=>220,
"\u0318"=>220,
"\u0319"=>220,
"\u031A"=>232,
"\u031B"=>216,
"\u031C"=>220,
"\u031D"=>220,
"\u031E"=>220,
"\u031F"=>220,
"\u0320"=>220,
"\u0321"=>202,
"\u0322"=>202,
"\u0323"=>220,
"\u0324"=>220,
"\u0325"=>220,
"\u0326"=>220,
"\u0327"=>202,
"\u0328"=>202,
"\u0329"=>220,
"\u032A"=>220,
"\u032B"=>220,
"\u032C"=>220,
"\u032D"=>220,
"\u032E"=>220,
"\u032F"=>220,
"\u0330"=>220,
"\u0331"=>220,
"\u0332"=>220,
"\u0333"=>220,
"\u0334"=>1,
"\u0335"=>1,
"\u0336"=>1,
"\u0337"=>1,
"\u0338"=>1,
"\u0339"=>220,
"\u033A"=>220,
"\u033B"=>220,
"\u033C"=>220,
"\u033D"=>230,
"\u033E"=>230,
"\u033F"=>230,
"\u0340"=>230,
"\u0341"=>230,
"\u0342"=>230,
"\u0343"=>230,
"\u0344"=>230,
"\u0345"=>240,
"\u0346"=>230,
"\u0347"=>220,
"\u0348"=>220,
"\u0349"=>220,
"\u034A"=>230,
"\u034B"=>230,
"\u034C"=>230,
"\u034D"=>220,
"\u034E"=>220,
"\u0350"=>230,
"\u0351"=>230,
"\u0352"=>230,
"\u0353"=>220,
"\u0354"=>220,
"\u0355"=>220,
"\u0356"=>220,
"\u0357"=>230,
"\u0358"=>232,
"\u0359"=>220,
"\u035A"=>220,
"\u035B"=>230,
"\u035C"=>233,
"\u035D"=>234,
"\u035E"=>234,
"\u035F"=>233,
"\u0360"=>234,
"\u0361"=>234,
"\u0362"=>233,
"\u0363"=>230,
"\u0364"=>230,
"\u0365"=>230,
"\u0366"=>230,
"\u0367"=>230,
"\u0368"=>230,
"\u0369"=>230,
"\u036A"=>230,
"\u036B"=>230,
"\u036C"=>230,
"\u036D"=>230,
"\u036E"=>230,
"\u036F"=>230,
"\u0483"=>230,
"\u0484"=>230,
"\u0485"=>230,
"\u0486"=>230,
"\u0487"=>230,
"\u0591"=>220,
"\u0592"=>230,
"\u0593"=>230,
"\u0594"=>230,
"\u0595"=>230,
"\u0596"=>220,
"\u0597"=>230,
"\u0598"=>230,
"\u0599"=>230,
"\u059A"=>222,
"\u059B"=>220,
"\u059C"=>230,
"\u059D"=>230,
"\u059E"=>230,
"\u059F"=>230,
"\u05A0"=>230,
"\u05A1"=>230,
"\u05A2"=>220,
"\u05A3"=>220,
"\u05A4"=>220,
"\u05A5"=>220,
"\u05A6"=>220,
"\u05A7"=>220,
"\u05A8"=>230,
"\u05A9"=>230,
"\u05AA"=>220,
"\u05AB"=>230,
"\u05AC"=>230,
"\u05AD"=>222,
"\u05AE"=>228,
"\u05AF"=>230,
"\u05B0"=>10,
"\u05B1"=>11,
"\u05B2"=>12,
"\u05B3"=>13,
"\u05B4"=>14,
"\u05B5"=>15,
"\u05B6"=>16,
"\u05B7"=>17,
"\u05B8"=>18,
"\u05B9"=>19,
"\u05BA"=>19,
"\u05BB"=>20,
"\u05BC"=>21,
"\u05BD"=>22,
"\u05BF"=>23,
"\u05C1"=>24,
"\u05C2"=>25,
"\u05C4"=>230,
"\u05C5"=>220,
"\u05C7"=>18,
"\u0610"=>230,
"\u0611"=>230,
"\u0612"=>230,
"\u0613"=>230,
"\u0614"=>230,
"\u0615"=>230,
"\u0616"=>230,
"\u0617"=>230,
"\u0618"=>30,
"\u0619"=>31,
"\u061A"=>32,
"\u064B"=>27,
"\u064C"=>28,
"\u064D"=>29,
"\u064E"=>30,
"\u064F"=>31,
"\u0650"=>32,
"\u0651"=>33,
"\u0652"=>34,
"\u0653"=>230,
"\u0654"=>230,
"\u0655"=>220,
"\u0656"=>220,
"\u0657"=>230,
"\u0658"=>230,
"\u0659"=>230,
"\u065A"=>230,
"\u065B"=>230,
"\u065C"=>220,
"\u065D"=>230,
"\u065E"=>230,
"\u065F"=>220,
"\u0670"=>35,
"\u06D6"=>230,
"\u06D7"=>230,
"\u06D8"=>230,
"\u06D9"=>230,
"\u06DA"=>230,
"\u06DB"=>230,
"\u06DC"=>230,
"\u06DF"=>230,
"\u06E0"=>230,
"\u06E1"=>230,
"\u06E2"=>230,
"\u06E3"=>220,
"\u06E4"=>230,
"\u06E7"=>230,
"\u06E8"=>230,
"\u06EA"=>220,
"\u06EB"=>230,
"\u06EC"=>230,
"\u06ED"=>220,
"\u0711"=>36,
"\u0730"=>230,
"\u0731"=>220,
"\u0732"=>230,
"\u0733"=>230,
"\u0734"=>220,
"\u0735"=>230,
"\u0736"=>230,
"\u0737"=>220,
"\u0738"=>220,
"\u0739"=>220,
"\u073A"=>230,
"\u073B"=>220,
"\u073C"=>220,
"\u073D"=>230,
"\u073E"=>220,
"\u073F"=>230,
"\u0740"=>230,
"\u0741"=>230,
"\u0742"=>220,
"\u0743"=>230,
"\u0744"=>220,
"\u0745"=>230,
"\u0746"=>220,
"\u0747"=>230,
"\u0748"=>220,
"\u0749"=>230,
"\u074A"=>230,
"\u07EB"=>230,
"\u07EC"=>230,
"\u07ED"=>230,
"\u07EE"=>230,
"\u07EF"=>230,
"\u07F0"=>230,
"\u07F1"=>230,
"\u07F2"=>220,
"\u07F3"=>230,
"\u07FD"=>220,
"\u0816"=>230,
"\u0817"=>230,
"\u0818"=>230,
"\u0819"=>230,
"\u081B"=>230,
"\u081C"=>230,
"\u081D"=>230,
"\u081E"=>230,
"\u081F"=>230,
"\u0820"=>230,
"\u0821"=>230,
"\u0822"=>230,
"\u0823"=>230,
"\u0825"=>230,
"\u0826"=>230,
"\u0827"=>230,
"\u0829"=>230,
"\u082A"=>230,
"\u082B"=>230,
"\u082C"=>230,
"\u082D"=>230,
"\u0859"=>220,
"\u085A"=>220,
"\u085B"=>220,
"\u0898"=>230,
"\u0899"=>220,
"\u089A"=>220,
"\u089B"=>220,
"\u089C"=>230,
"\u089D"=>230,
"\u089E"=>230,
"\u089F"=>230,
"\u08CA"=>230,
"\u08CB"=>230,
"\u08CC"=>230,
"\u08CD"=>230,
"\u08CE"=>230,
"\u08CF"=>220,
"\u08D0"=>220,
"\u08D1"=>220,
"\u08D2"=>220,
"\u08D3"=>220,
"\u08D4"=>230,
"\u08D5"=>230,
"\u08D6"=>230,
"\u08D7"=>230,
"\u08D8"=>230,
"\u08D9"=>230,
"\u08DA"=>230,
"\u08DB"=>230,
"\u08DC"=>230,
"\u08DD"=>230,
"\u08DE"=>230,
"\u08DF"=>230,
"\u08E0"=>230,
"\u08E1"=>230,
"\u08E3"=>220,
"\u08E4"=>230,
"\u08E5"=>230,
"\u08E6"=>220,
"\u08E7"=>230,
"\u08E8"=>230,
"\u08E9"=>220,
"\u08EA"=>230,
"\u08EB"=>230,
"\u08EC"=>230,
"\u08ED"=>220,
"\u08EE"=>220,
"\u08EF"=>220,
"\u08F0"=>27,
"\u08F1"=>28,
"\u08F2"=>29,
"\u08F3"=>230,
"\u08F4"=>230,
"\u08F5"=>230,
"\u08F6"=>220,
"\u08F7"=>230,
"\u08F8"=>230,
"\u08F9"=>220,
"\u08FA"=>220,
"\u08FB"=>230,
"\u08FC"=>230,
"\u08FD"=>230,
"\u08FE"=>230,
"\u08FF"=>230,
"\u093C"=>7,
"\u094D"=>9,
"\u0951"=>230,
"\u0952"=>220,
"\u0953"=>230,
"\u0954"=>230,
"\u09BC"=>7,
"\u09CD"=>9,
"\u09FE"=>230,
"\u0A3C"=>7,
"\u0A4D"=>9,
"\u0ABC"=>7,
"\u0ACD"=>9,
"\u0B3C"=>7,
"\u0B4D"=>9,
"\u0BCD"=>9,
"\u0C3C"=>7,
"\u0C4D"=>9,
"\u0C55"=>84,
"\u0C56"=>91,
"\u0CBC"=>7,
"\u0CCD"=>9,
"\u0D3B"=>9,
"\u0D3C"=>9,
"\u0D4D"=>9,
"\u0DCA"=>9,
"\u0E38"=>103,
"\u0E39"=>103,
"\u0E3A"=>9,
"\u0E48"=>107,
"\u0E49"=>107,
"\u0E4A"=>107,
"\u0E4B"=>107,
"\u0EB8"=>118,
"\u0EB9"=>118,
"\u0EBA"=>9,
"\u0EC8"=>122,
"\u0EC9"=>122,
"\u0ECA"=>122,
"\u0ECB"=>122,
"\u0F18"=>220,
"\u0F19"=>220,
"\u0F35"=>220,
"\u0F37"=>220,
"\u0F39"=>216,
"\u0F71"=>129,
"\u0F72"=>130,
"\u0F74"=>132,
"\u0F7A"=>130,
"\u0F7B"=>130,
"\u0F7C"=>130,
"\u0F7D"=>130,
"\u0F80"=>130,
"\u0F82"=>230,
"\u0F83"=>230,
"\u0F84"=>9,
"\u0F86"=>230,
"\u0F87"=>230,
"\u0FC6"=>220,
"\u1037"=>7,
"\u1039"=>9,
"\u103A"=>9,
"\u108D"=>220,
"\u135D"=>230,
"\u135E"=>230,
"\u135F"=>230,
"\u1714"=>9,
"\u1715"=>9,
"\u1734"=>9,
"\u17D2"=>9,
"\u17DD"=>230,
"\u18A9"=>228,
"\u1939"=>222,
"\u193A"=>230,
"\u193B"=>220,
"\u1A17"=>230,
"\u1A18"=>220,
"\u1A60"=>9,
"\u1A75"=>230,
"\u1A76"=>230,
"\u1A77"=>230,
"\u1A78"=>230,
"\u1A79"=>230,
"\u1A7A"=>230,
"\u1A7B"=>230,
"\u1A7C"=>230,
"\u1A7F"=>220,
"\u1AB0"=>230,
"\u1AB1"=>230,
"\u1AB2"=>230,
"\u1AB3"=>230,
"\u1AB4"=>230,
"\u1AB5"=>220,
"\u1AB6"=>220,
"\u1AB7"=>220,
"\u1AB8"=>220,
"\u1AB9"=>220,
"\u1ABA"=>220,
"\u1ABB"=>230,
"\u1ABC"=>230,
"\u1ABD"=>220,
"\u1ABF"=>220,
"\u1AC0"=>220,
"\u1AC1"=>230,
"\u1AC2"=>230,
"\u1AC3"=>220,
"\u1AC4"=>220,
"\u1AC5"=>230,
"\u1AC6"=>230,
"\u1AC7"=>230,
"\u1AC8"=>230,
"\u1AC9"=>230,
"\u1ACA"=>220,
"\u1ACB"=>230,
"\u1ACC"=>230,
"\u1ACD"=>230,
"\u1ACE"=>230,
"\u1B34"=>7,
"\u1B44"=>9,
"\u1B6B"=>230,
"\u1B6C"=>220,
"\u1B6D"=>230,
"\u1B6E"=>230,
"\u1B6F"=>230,
"\u1B70"=>230,
"\u1B71"=>230,
"\u1B72"=>230,
"\u1B73"=>230,
"\u1BAA"=>9,
"\u1BAB"=>9,
"\u1BE6"=>7,
"\u1BF2"=>9,
"\u1BF3"=>9,
"\u1C37"=>7,
"\u1CD0"=>230,
"\u1CD1"=>230,
"\u1CD2"=>230,
"\u1CD4"=>1,
"\u1CD5"=>220,
"\u1CD6"=>220,
"\u1CD7"=>220,
"\u1CD8"=>220,
"\u1CD9"=>220,
"\u1CDA"=>230,
"\u1CDB"=>230,
"\u1CDC"=>220,
"\u1CDD"=>220,
"\u1CDE"=>220,
"\u1CDF"=>220,
"\u1CE0"=>230,
"\u1CE2"=>1,
"\u1CE3"=>1,
"\u1CE4"=>1,
"\u1CE5"=>1,
"\u1CE6"=>1,
"\u1CE7"=>1,
"\u1CE8"=>1,
"\u1CED"=>220,
"\u1CF4"=>230,
"\u1CF8"=>230,
"\u1CF9"=>230,
"\u1DC0"=>230,
"\u1DC1"=>230,
"\u1DC2"=>220,
"\u1DC3"=>230,
"\u1DC4"=>230,
"\u1DC5"=>230,
"\u1DC6"=>230,
"\u1DC7"=>230,
"\u1DC8"=>230,
"\u1DC9"=>230,
"\u1DCA"=>220,
"\u1DCB"=>230,
"\u1DCC"=>230,
"\u1DCD"=>234,
"\u1DCE"=>214,
"\u1DCF"=>220,
"\u1DD0"=>202,
"\u1DD1"=>230,
"\u1DD2"=>230,
"\u1DD3"=>230,
"\u1DD4"=>230,
"\u1DD5"=>230,
"\u1DD6"=>230,
"\u1DD7"=>230,
"\u1DD8"=>230,
"\u1DD9"=>230,
"\u1DDA"=>230,
"\u1DDB"=>230,
"\u1DDC"=>230,
"\u1DDD"=>230,
"\u1DDE"=>230,
"\u1DDF"=>230,
"\u1DE0"=>230,
"\u1DE1"=>230,
"\u1DE2"=>230,
"\u1DE3"=>230,
"\u1DE4"=>230,
"\u1DE5"=>230,
"\u1DE6"=>230,
"\u1DE7"=>230,
"\u1DE8"=>230,
"\u1DE9"=>230,
"\u1DEA"=>230,
"\u1DEB"=>230,
"\u1DEC"=>230,
"\u1DED"=>230,
"\u1DEE"=>230,
"\u1DEF"=>230,
"\u1DF0"=>230,
"\u1DF1"=>230,
"\u1DF2"=>230,
"\u1DF3"=>230,
"\u1DF4"=>230,
"\u1DF5"=>230,
"\u1DF6"=>232,
"\u1DF7"=>228,
"\u1DF8"=>228,
"\u1DF9"=>220,
"\u1DFA"=>218,
"\u1DFB"=>230,
"\u1DFC"=>233,
"\u1DFD"=>220,
"\u1DFE"=>230,
"\u1DFF"=>220,
"\u20D0"=>230,
"\u20D1"=>230,
"\u20D2"=>1,
"\u20D3"=>1,
"\u20D4"=>230,
"\u20D5"=>230,
"\u20D6"=>230,
"\u20D7"=>230,
"\u20D8"=>1,
"\u20D9"=>1,
"\u20DA"=>1,
"\u20DB"=>230,
"\u20DC"=>230,
"\u20E1"=>230,
"\u20E5"=>1,
"\u20E6"=>1,
"\u20E7"=>230,
"\u20E8"=>220,
"\u20E9"=>230,
"\u20EA"=>1,
"\u20EB"=>1,
"\u20EC"=>220,
"\u20ED"=>220,
"\u20EE"=>220,
"\u20EF"=>220,
"\u20F0"=>230,
"\u2CEF"=>230,
"\u2CF0"=>230,
"\u2CF1"=>230,
"\u2D7F"=>9,
"\u2DE0"=>230,
"\u2DE1"=>230,
"\u2DE2"=>230,
"\u2DE3"=>230,
"\u2DE4"=>230,
"\u2DE5"=>230,
"\u2DE6"=>230,
"\u2DE7"=>230,
"\u2DE8"=>230,
"\u2DE9"=>230,
"\u2DEA"=>230,
"\u2DEB"=>230,
"\u2DEC"=>230,
"\u2DED"=>230,
"\u2DEE"=>230,
"\u2DEF"=>230,
"\u2DF0"=>230,
"\u2DF1"=>230,
"\u2DF2"=>230,
"\u2DF3"=>230,
"\u2DF4"=>230,
"\u2DF5"=>230,
"\u2DF6"=>230,
"\u2DF7"=>230,
"\u2DF8"=>230,
"\u2DF9"=>230,
"\u2DFA"=>230,
"\u2DFB"=>230,
"\u2DFC"=>230,
"\u2DFD"=>230,
"\u2DFE"=>230,
"\u2DFF"=>230,
"\u302A"=>218,
"\u302B"=>228,
"\u302C"=>232,
"\u302D"=>222,
"\u302E"=>224,
"\u302F"=>224,
"\u3099"=>8,
"\u309A"=>8,
"\uA66F"=>230,
"\uA674"=>230,
"\uA675"=>230,
"\uA676"=>230,
"\uA677"=>230,
"\uA678"=>230,
"\uA679"=>230,
"\uA67A"=>230,
"\uA67B"=>230,
"\uA67C"=>230,
"\uA67D"=>230,
"\uA69E"=>230,
"\uA69F"=>230,
"\uA6F0"=>230,
"\uA6F1"=>230,
"\uA806"=>9,
"\uA82C"=>9,
"\uA8C4"=>9,
"\uA8E0"=>230,
"\uA8E1"=>230,
"\uA8E2"=>230,
"\uA8E3"=>230,
"\uA8E4"=>230,
"\uA8E5"=>230,
"\uA8E6"=>230,
"\uA8E7"=>230,
"\uA8E8"=>230,
"\uA8E9"=>230,
"\uA8EA"=>230,
"\uA8EB"=>230,
"\uA8EC"=>230,
"\uA8ED"=>230,
"\uA8EE"=>230,
"\uA8EF"=>230,
"\uA8F0"=>230,
"\uA8F1"=>230,
"\uA92B"=>220,
"\uA92C"=>220,
"\uA92D"=>220,
"\uA953"=>9,
"\uA9B3"=>7,
"\uA9C0"=>9,
"\uAAB0"=>230,
"\uAAB2"=>230,
"\uAAB3"=>230,
"\uAAB4"=>220,
"\uAAB7"=>230,
"\uAAB8"=>230,
"\uAABE"=>230,
"\uAABF"=>230,
"\uAAC1"=>230,
"\uAAF6"=>9,
"\uABED"=>9,
"\uFB1E"=>26,
"\uFE20"=>230,
"\uFE21"=>230,
"\uFE22"=>230,
"\uFE23"=>230,
"\uFE24"=>230,
"\uFE25"=>230,
"\uFE26"=>230,
"\uFE27"=>220,
"\uFE28"=>220,
"\uFE29"=>220,
"\uFE2A"=>220,
"\uFE2B"=>220,
"\uFE2C"=>220,
"\uFE2D"=>220,
"\uFE2E"=>230,
"\uFE2F"=>230,
"\u{101FD}"=>220,
"\u{102E0}"=>220,
"\u{10376}"=>230,
"\u{10377}"=>230,
"\u{10378}"=>230,
"\u{10379}"=>230,
"\u{1037A}"=>230,
"\u{10A0D}"=>220,
"\u{10A0F}"=>230,
"\u{10A38}"=>230,
"\u{10A39}"=>1,
"\u{10A3A}"=>220,
"\u{10A3F}"=>9,
"\u{10AE5}"=>230,
"\u{10AE6}"=>220,
"\u{10D24}"=>230,
"\u{10D25}"=>230,
"\u{10D26}"=>230,
"\u{10D27}"=>230,
"\u{10EAB}"=>230,
"\u{10EAC}"=>230,
"\u{10EFD}"=>220,
"\u{10EFE}"=>220,
"\u{10EFF}"=>220,
"\u{10F46}"=>220,
"\u{10F47}"=>220,
"\u{10F48}"=>230,
"\u{10F49}"=>230,
"\u{10F4A}"=>230,
"\u{10F4B}"=>220,
"\u{10F4C}"=>230,
"\u{10F4D}"=>220,
"\u{10F4E}"=>220,
"\u{10F4F}"=>220,
"\u{10F50}"=>220,
"\u{10F82}"=>230,
"\u{10F83}"=>220,
"\u{10F84}"=>230,
"\u{10F85}"=>220,
"\u{11046}"=>9,
"\u{11070}"=>9,
"\u{1107F}"=>9,
"\u{110B9}"=>9,
"\u{110BA}"=>7,
"\u{11100}"=>230,
"\u{11101}"=>230,
"\u{11102}"=>230,
"\u{11133}"=>9,
"\u{11134}"=>9,
"\u{11173}"=>7,
"\u{111C0}"=>9,
"\u{111CA}"=>7,
"\u{11235}"=>9,
"\u{11236}"=>7,
"\u{112E9}"=>7,
"\u{112EA}"=>9,
"\u{1133B}"=>7,
"\u{1133C}"=>7,
"\u{1134D}"=>9,
"\u{11366}"=>230,
"\u{11367}"=>230,
"\u{11368}"=>230,
"\u{11369}"=>230,
"\u{1136A}"=>230,
"\u{1136B}"=>230,
"\u{1136C}"=>230,
"\u{11370}"=>230,
"\u{11371}"=>230,
"\u{11372}"=>230,
"\u{11373}"=>230,
"\u{11374}"=>230,
"\u{11442}"=>9,
"\u{11446}"=>7,
"\u{1145E}"=>230,
"\u{114C2}"=>9,
"\u{114C3}"=>7,
"\u{115BF}"=>9,
"\u{115C0}"=>7,
"\u{1163F}"=>9,
"\u{116B6}"=>9,
"\u{116B7}"=>7,
"\u{1172B}"=>9,
"\u{11839}"=>9,
"\u{1183A}"=>7,
"\u{1193D}"=>9,
"\u{1193E}"=>9,
"\u{11943}"=>7,
"\u{119E0}"=>9,
"\u{11A34}"=>9,
"\u{11A47}"=>9,
"\u{11A99}"=>9,
"\u{11C3F}"=>9,
"\u{11D42}"=>7,
"\u{11D44}"=>9,
"\u{11D45}"=>9,
"\u{11D97}"=>9,
"\u{11F41}"=>9,
"\u{11F42}"=>9,
"\u{16AF0}"=>1,
"\u{16AF1}"=>1,
"\u{16AF2}"=>1,
"\u{16AF3}"=>1,
"\u{16AF4}"=>1,
"\u{16B30}"=>230,
"\u{16B31}"=>230,
"\u{16B32}"=>230,
"\u{16B33}"=>230,
"\u{16B34}"=>230,
"\u{16B35}"=>230,
"\u{16B36}"=>230,
"\u{16FF0}"=>6,
"\u{16FF1}"=>6,
"\u{1BC9E}"=>1,
"\u{1D165}"=>216,
"\u{1D166}"=>216,
"\u{1D167}"=>1,
"\u{1D168}"=>1,
"\u{1D169}"=>1,
"\u{1D16D}"=>226,
"\u{1D16E}"=>216,
"\u{1D16F}"=>216,
"\u{1D170}"=>216,
"\u{1D171}"=>216,
"\u{1D172}"=>216,
"\u{1D17B}"=>220,
"\u{1D17C}"=>220,
"\u{1D17D}"=>220,
"\u{1D17E}"=>220,
"\u{1D17F}"=>220,
"\u{1D180}"=>220,
"\u{1D181}"=>220,
"\u{1D182}"=>220,
"\u{1D185}"=>230,
"\u{1D186}"=>230,
"\u{1D187}"=>230,
"\u{1D188}"=>230,
"\u{1D189}"=>230,
"\u{1D18A}"=>220,
"\u{1D18B}"=>220,
"\u{1D1AA}"=>230,
"\u{1D1AB}"=>230,
"\u{1D1AC}"=>230,
"\u{1D1AD}"=>230,
"\u{1D242}"=>230,
"\u{1D243}"=>230,
"\u{1D244}"=>230,
"\u{1E000}"=>230,
"\u{1E001}"=>230,
"\u{1E002}"=>230,
"\u{1E003}"=>230,
"\u{1E004}"=>230,
"\u{1E005}"=>230,
"\u{1E006}"=>230,
"\u{1E008}"=>230,
"\u{1E009}"=>230,
"\u{1E00A}"=>230,
"\u{1E00B}"=>230,
"\u{1E00C}"=>230,
"\u{1E00D}"=>230,
"\u{1E00E}"=>230,
"\u{1E00F}"=>230,
"\u{1E010}"=>230,
"\u{1E011}"=>230,
"\u{1E012}"=>230,
"\u{1E013}"=>230,
"\u{1E014}"=>230,
"\u{1E015}"=>230,
"\u{1E016}"=>230,
"\u{1E017}"=>230,
"\u{1E018}"=>230,
"\u{1E01B}"=>230,
"\u{1E01C}"=>230,
"\u{1E01D}"=>230,
"\u{1E01E}"=>230,
"\u{1E01F}"=>230,
"\u{1E020}"=>230,
"\u{1E021}"=>230,
"\u{1E023}"=>230,
"\u{1E024}"=>230,
"\u{1E026}"=>230,
"\u{1E027}"=>230,
"\u{1E028}"=>230,
"\u{1E029}"=>230,
"\u{1E02A}"=>230,
"\u{1E08F}"=>230,
"\u{1E130}"=>230,
"\u{1E131}"=>230,
"\u{1E132}"=>230,
"\u{1E133}"=>230,
"\u{1E134}"=>230,
"\u{1E135}"=>230,
"\u{1E136}"=>230,
"\u{1E2AE}"=>230,
"\u{1E2EC}"=>230,
"\u{1E2ED}"=>230,
"\u{1E2EE}"=>230,
"\u{1E2EF}"=>230,
"\u{1E4EC}"=>232,
"\u{1E4ED}"=>232,
"\u{1E4EE}"=>220,
"\u{1E4EF}"=>230,
"\u{1E8D0}"=>220,
"\u{1E8D1}"=>220,
"\u{1E8D2}"=>220,
"\u{1E8D3}"=>220,
"\u{1E8D4}"=>220,
"\u{1E8D5}"=>220,
"\u{1E8D6}"=>220,
"\u{1E944}"=>230,
"\u{1E945}"=>230,
"\u{1E946}"=>230,
"\u{1E947}"=>230,
"\u{1E948}"=>230,
"\u{1E949}"=>230,
"\u{1E94A}"=>7,
}
class_table.default = 0
CLASS_TABLE = class_table.freeze
DECOMPOSITION_TABLE = {
"\u00C0"=>"A\u0300",
"\u00C1"=>"A\u0301",
"\u00C2"=>"A\u0302",
"\u00C3"=>"A\u0303",
"\u00C4"=>"A\u0308",
"\u00C5"=>"A\u030A",
"\u00C7"=>"C\u0327",
"\u00C8"=>"E\u0300",
"\u00C9"=>"E\u0301",
"\u00CA"=>"E\u0302",
"\u00CB"=>"E\u0308",
"\u00CC"=>"I\u0300",
"\u00CD"=>"I\u0301",
"\u00CE"=>"I\u0302",
"\u00CF"=>"I\u0308",
"\u00D1"=>"N\u0303",
"\u00D2"=>"O\u0300",
"\u00D3"=>"O\u0301",
"\u00D4"=>"O\u0302",
"\u00D5"=>"O\u0303",
"\u00D6"=>"O\u0308",
"\u00D9"=>"U\u0300",
"\u00DA"=>"U\u0301",
"\u00DB"=>"U\u0302",
"\u00DC"=>"U\u0308",
"\u00DD"=>"Y\u0301",
"\u00E0"=>"a\u0300",
"\u00E1"=>"a\u0301",
"\u00E2"=>"a\u0302",
"\u00E3"=>"a\u0303",
"\u00E4"=>"a\u0308",
"\u00E5"=>"a\u030A",
"\u00E7"=>"c\u0327",
"\u00E8"=>"e\u0300",
"\u00E9"=>"e\u0301",
"\u00EA"=>"e\u0302",
"\u00EB"=>"e\u0308",
"\u00EC"=>"i\u0300",
"\u00ED"=>"i\u0301",
"\u00EE"=>"i\u0302",
"\u00EF"=>"i\u0308",
"\u00F1"=>"n\u0303",
"\u00F2"=>"o\u0300",
"\u00F3"=>"o\u0301",
"\u00F4"=>"o\u0302",
"\u00F5"=>"o\u0303",
"\u00F6"=>"o\u0308",
"\u00F9"=>"u\u0300",
"\u00FA"=>"u\u0301",
"\u00FB"=>"u\u0302",
"\u00FC"=>"u\u0308",
"\u00FD"=>"y\u0301",
"\u00FF"=>"y\u0308",
"\u0100"=>"A\u0304",
"\u0101"=>"a\u0304",
"\u0102"=>"A\u0306",
"\u0103"=>"a\u0306",
"\u0104"=>"A\u0328",
"\u0105"=>"a\u0328",
"\u0106"=>"C\u0301",
"\u0107"=>"c\u0301",
"\u0108"=>"C\u0302",
"\u0109"=>"c\u0302",
"\u010A"=>"C\u0307",
"\u010B"=>"c\u0307",
"\u010C"=>"C\u030C",
"\u010D"=>"c\u030C",
"\u010E"=>"D\u030C",
"\u010F"=>"d\u030C",
"\u0112"=>"E\u0304",
"\u0113"=>"e\u0304",
"\u0114"=>"E\u0306",
"\u0115"=>"e\u0306",
"\u0116"=>"E\u0307",
"\u0117"=>"e\u0307",
"\u0118"=>"E\u0328",
"\u0119"=>"e\u0328",
"\u011A"=>"E\u030C",
"\u011B"=>"e\u030C",
"\u011C"=>"G\u0302",
"\u011D"=>"g\u0302",
"\u011E"=>"G\u0306",
"\u011F"=>"g\u0306",
"\u0120"=>"G\u0307",
"\u0121"=>"g\u0307",
"\u0122"=>"G\u0327",
"\u0123"=>"g\u0327",
"\u0124"=>"H\u0302",
"\u0125"=>"h\u0302",
"\u0128"=>"I\u0303",
"\u0129"=>"i\u0303",
"\u012A"=>"I\u0304",
"\u012B"=>"i\u0304",
"\u012C"=>"I\u0306",
"\u012D"=>"i\u0306",
"\u012E"=>"I\u0328",
"\u012F"=>"i\u0328",
"\u0130"=>"I\u0307",
"\u0134"=>"J\u0302",
"\u0135"=>"j\u0302",
"\u0136"=>"K\u0327",
"\u0137"=>"k\u0327",
"\u0139"=>"L\u0301",
"\u013A"=>"l\u0301",
"\u013B"=>"L\u0327",
"\u013C"=>"l\u0327",
"\u013D"=>"L\u030C",
"\u013E"=>"l\u030C",
"\u0143"=>"N\u0301",
"\u0144"=>"n\u0301",
"\u0145"=>"N\u0327",
"\u0146"=>"n\u0327",
"\u0147"=>"N\u030C",
"\u0148"=>"n\u030C",
"\u014C"=>"O\u0304",
"\u014D"=>"o\u0304",
"\u014E"=>"O\u0306",
"\u014F"=>"o\u0306",
"\u0150"=>"O\u030B",
"\u0151"=>"o\u030B",
"\u0154"=>"R\u0301",
"\u0155"=>"r\u0301",
"\u0156"=>"R\u0327",
"\u0157"=>"r\u0327",
"\u0158"=>"R\u030C",
"\u0159"=>"r\u030C",
"\u015A"=>"S\u0301",
"\u015B"=>"s\u0301",
"\u015C"=>"S\u0302",
"\u015D"=>"s\u0302",
"\u015E"=>"S\u0327",
"\u015F"=>"s\u0327",
"\u0160"=>"S\u030C",
"\u0161"=>"s\u030C",
"\u0162"=>"T\u0327",
"\u0163"=>"t\u0327",
"\u0164"=>"T\u030C",
"\u0165"=>"t\u030C",
"\u0168"=>"U\u0303",
"\u0169"=>"u\u0303",
"\u016A"=>"U\u0304",
"\u016B"=>"u\u0304",
"\u016C"=>"U\u0306",
"\u016D"=>"u\u0306",
"\u016E"=>"U\u030A",
"\u016F"=>"u\u030A",
"\u0170"=>"U\u030B",
"\u0171"=>"u\u030B",
"\u0172"=>"U\u0328",
"\u0173"=>"u\u0328",
"\u0174"=>"W\u0302",
"\u0175"=>"w\u0302",
"\u0176"=>"Y\u0302",
"\u0177"=>"y\u0302",
"\u0178"=>"Y\u0308",
"\u0179"=>"Z\u0301",
"\u017A"=>"z\u0301",
"\u017B"=>"Z\u0307",
"\u017C"=>"z\u0307",
"\u017D"=>"Z\u030C",
"\u017E"=>"z\u030C",
"\u01A0"=>"O\u031B",
"\u01A1"=>"o\u031B",
"\u01AF"=>"U\u031B",
"\u01B0"=>"u\u031B",
"\u01CD"=>"A\u030C",
"\u01CE"=>"a\u030C",
"\u01CF"=>"I\u030C",
"\u01D0"=>"i\u030C",
"\u01D1"=>"O\u030C",
"\u01D2"=>"o\u030C",
"\u01D3"=>"U\u030C",
"\u01D4"=>"u\u030C",
"\u01D5"=>"U\u0308\u0304",
"\u01D6"=>"u\u0308\u0304",
"\u01D7"=>"U\u0308\u0301",
"\u01D8"=>"u\u0308\u0301",
"\u01D9"=>"U\u0308\u030C",
"\u01DA"=>"u\u0308\u030C",
"\u01DB"=>"U\u0308\u0300",
"\u01DC"=>"u\u0308\u0300",
"\u01DE"=>"A\u0308\u0304",
"\u01DF"=>"a\u0308\u0304",
"\u01E0"=>"A\u0307\u0304",
"\u01E1"=>"a\u0307\u0304",
"\u01E2"=>"\u00C6\u0304",
"\u01E3"=>"\u00E6\u0304",
"\u01E6"=>"G\u030C",
"\u01E7"=>"g\u030C",
"\u01E8"=>"K\u030C",
"\u01E9"=>"k\u030C",
"\u01EA"=>"O\u0328",
"\u01EB"=>"o\u0328",
"\u01EC"=>"O\u0328\u0304",
"\u01ED"=>"o\u0328\u0304",
"\u01EE"=>"\u01B7\u030C",
"\u01EF"=>"\u0292\u030C",
"\u01F0"=>"j\u030C",
"\u01F4"=>"G\u0301",
"\u01F5"=>"g\u0301",
"\u01F8"=>"N\u0300",
"\u01F9"=>"n\u0300",
"\u01FA"=>"A\u030A\u0301",
"\u01FB"=>"a\u030A\u0301",
"\u01FC"=>"\u00C6\u0301",
"\u01FD"=>"\u00E6\u0301",
"\u01FE"=>"\u00D8\u0301",
"\u01FF"=>"\u00F8\u0301",
"\u0200"=>"A\u030F",
"\u0201"=>"a\u030F",
"\u0202"=>"A\u0311",
"\u0203"=>"a\u0311",
"\u0204"=>"E\u030F",
"\u0205"=>"e\u030F",
"\u0206"=>"E\u0311",
"\u0207"=>"e\u0311",
"\u0208"=>"I\u030F",
"\u0209"=>"i\u030F",
"\u020A"=>"I\u0311",
"\u020B"=>"i\u0311",
"\u020C"=>"O\u030F",
"\u020D"=>"o\u030F",
"\u020E"=>"O\u0311",
"\u020F"=>"o\u0311",
"\u0210"=>"R\u030F",
"\u0211"=>"r\u030F",
"\u0212"=>"R\u0311",
"\u0213"=>"r\u0311",
"\u0214"=>"U\u030F",
"\u0215"=>"u\u030F",
"\u0216"=>"U\u0311",
"\u0217"=>"u\u0311",
"\u0218"=>"S\u0326",
"\u0219"=>"s\u0326",
"\u021A"=>"T\u0326",
"\u021B"=>"t\u0326",
"\u021E"=>"H\u030C",
"\u021F"=>"h\u030C",
"\u0226"=>"A\u0307",
"\u0227"=>"a\u0307",
"\u0228"=>"E\u0327",
"\u0229"=>"e\u0327",
"\u022A"=>"O\u0308\u0304",
"\u022B"=>"o\u0308\u0304",
"\u022C"=>"O\u0303\u0304",
"\u022D"=>"o\u0303\u0304",
"\u022E"=>"O\u0307",
"\u022F"=>"o\u0307",
"\u0230"=>"O\u0307\u0304",
"\u0231"=>"o\u0307\u0304",
"\u0232"=>"Y\u0304",
"\u0233"=>"y\u0304",
"\u0340"=>"\u0300",
"\u0341"=>"\u0301",
"\u0343"=>"\u0313",
"\u0344"=>"\u0308\u0301",
"\u0374"=>"\u02B9",
"\u037E"=>";",
"\u0385"=>"\u00A8\u0301",
"\u0386"=>"\u0391\u0301",
"\u0387"=>"\u00B7",
"\u0388"=>"\u0395\u0301",
"\u0389"=>"\u0397\u0301",
"\u038A"=>"\u0399\u0301",
"\u038C"=>"\u039F\u0301",
"\u038E"=>"\u03A5\u0301",
"\u038F"=>"\u03A9\u0301",
"\u0390"=>"\u03B9\u0308\u0301",
"\u03AA"=>"\u0399\u0308",
"\u03AB"=>"\u03A5\u0308",
"\u03AC"=>"\u03B1\u0301",
"\u03AD"=>"\u03B5\u0301",
"\u03AE"=>"\u03B7\u0301",
"\u03AF"=>"\u03B9\u0301",
"\u03B0"=>"\u03C5\u0308\u0301",
"\u03CA"=>"\u03B9\u0308",
"\u03CB"=>"\u03C5\u0308",
"\u03CC"=>"\u03BF\u0301",
"\u03CD"=>"\u03C5\u0301",
"\u03CE"=>"\u03C9\u0301",
"\u03D3"=>"\u03D2\u0301",
"\u03D4"=>"\u03D2\u0308",
"\u0400"=>"\u0415\u0300",
"\u0401"=>"\u0415\u0308",
"\u0403"=>"\u0413\u0301",
"\u0407"=>"\u0406\u0308",
"\u040C"=>"\u041A\u0301",
"\u040D"=>"\u0418\u0300",
"\u040E"=>"\u0423\u0306",
"\u0419"=>"\u0418\u0306",
"\u0439"=>"\u0438\u0306",
"\u0450"=>"\u0435\u0300",
"\u0451"=>"\u0435\u0308",
"\u0453"=>"\u0433\u0301",
"\u0457"=>"\u0456\u0308",
"\u045C"=>"\u043A\u0301",
"\u045D"=>"\u0438\u0300",
"\u045E"=>"\u0443\u0306",
"\u0476"=>"\u0474\u030F",
"\u0477"=>"\u0475\u030F",
"\u04C1"=>"\u0416\u0306",
"\u04C2"=>"\u0436\u0306",
"\u04D0"=>"\u0410\u0306",
"\u04D1"=>"\u0430\u0306",
"\u04D2"=>"\u0410\u0308",
"\u04D3"=>"\u0430\u0308",
"\u04D6"=>"\u0415\u0306",
"\u04D7"=>"\u0435\u0306",
"\u04DA"=>"\u04D8\u0308",
"\u04DB"=>"\u04D9\u0308",
"\u04DC"=>"\u0416\u0308",
"\u04DD"=>"\u0436\u0308",
"\u04DE"=>"\u0417\u0308",
"\u04DF"=>"\u0437\u0308",
"\u04E2"=>"\u0418\u0304",
"\u04E3"=>"\u0438\u0304",
"\u04E4"=>"\u0418\u0308",
"\u04E5"=>"\u0438\u0308",
"\u04E6"=>"\u041E\u0308",
"\u04E7"=>"\u043E\u0308",
"\u04EA"=>"\u04E8\u0308",
"\u04EB"=>"\u04E9\u0308",
"\u04EC"=>"\u042D\u0308",
"\u04ED"=>"\u044D\u0308",
"\u04EE"=>"\u0423\u0304",
"\u04EF"=>"\u0443\u0304",
"\u04F0"=>"\u0423\u0308",
"\u04F1"=>"\u0443\u0308",
"\u04F2"=>"\u0423\u030B",
"\u04F3"=>"\u0443\u030B",
"\u04F4"=>"\u0427\u0308",
"\u04F5"=>"\u0447\u0308",
"\u04F8"=>"\u042B\u0308",
"\u04F9"=>"\u044B\u0308",
"\u0622"=>"\u0627\u0653",
"\u0623"=>"\u0627\u0654",
"\u0624"=>"\u0648\u0654",
"\u0625"=>"\u0627\u0655",
"\u0626"=>"\u064A\u0654",
"\u06C0"=>"\u06D5\u0654",
"\u06C2"=>"\u06C1\u0654",
"\u06D3"=>"\u06D2\u0654",
"\u0929"=>"\u0928\u093C",
"\u0931"=>"\u0930\u093C",
"\u0934"=>"\u0933\u093C",
"\u0958"=>"\u0915\u093C",
"\u0959"=>"\u0916\u093C",
"\u095A"=>"\u0917\u093C",
"\u095B"=>"\u091C\u093C",
"\u095C"=>"\u0921\u093C",
"\u095D"=>"\u0922\u093C",
"\u095E"=>"\u092B\u093C",
"\u095F"=>"\u092F\u093C",
"\u09CB"=>"\u09C7\u09BE",
"\u09CC"=>"\u09C7\u09D7",
"\u09DC"=>"\u09A1\u09BC",
"\u09DD"=>"\u09A2\u09BC",
"\u09DF"=>"\u09AF\u09BC",
"\u0A33"=>"\u0A32\u0A3C",
"\u0A36"=>"\u0A38\u0A3C",
"\u0A59"=>"\u0A16\u0A3C",
"\u0A5A"=>"\u0A17\u0A3C",
"\u0A5B"=>"\u0A1C\u0A3C",
"\u0A5E"=>"\u0A2B\u0A3C",
"\u0B48"=>"\u0B47\u0B56",
"\u0B4B"=>"\u0B47\u0B3E",
"\u0B4C"=>"\u0B47\u0B57",
"\u0B5C"=>"\u0B21\u0B3C",
"\u0B5D"=>"\u0B22\u0B3C",
"\u0B94"=>"\u0B92\u0BD7",
"\u0BCA"=>"\u0BC6\u0BBE",
"\u0BCB"=>"\u0BC7\u0BBE",
"\u0BCC"=>"\u0BC6\u0BD7",
"\u0C48"=>"\u0C46\u0C56",
"\u0CC0"=>"\u0CBF\u0CD5",
"\u0CC7"=>"\u0CC6\u0CD5",
"\u0CC8"=>"\u0CC6\u0CD6",
"\u0CCA"=>"\u0CC6\u0CC2",
"\u0CCB"=>"\u0CC6\u0CC2\u0CD5",
"\u0D4A"=>"\u0D46\u0D3E",
"\u0D4B"=>"\u0D47\u0D3E",
"\u0D4C"=>"\u0D46\u0D57",
"\u0DDA"=>"\u0DD9\u0DCA",
"\u0DDC"=>"\u0DD9\u0DCF",
"\u0DDD"=>"\u0DD9\u0DCF\u0DCA",
"\u0DDE"=>"\u0DD9\u0DDF",
"\u0F43"=>"\u0F42\u0FB7",
"\u0F4D"=>"\u0F4C\u0FB7",
"\u0F52"=>"\u0F51\u0FB7",
"\u0F57"=>"\u0F56\u0FB7",
"\u0F5C"=>"\u0F5B\u0FB7",
"\u0F69"=>"\u0F40\u0FB5",
"\u0F73"=>"\u0F71\u0F72",
"\u0F75"=>"\u0F71\u0F74",
"\u0F76"=>"\u0FB2\u0F80",
"\u0F78"=>"\u0FB3\u0F80",
"\u0F81"=>"\u0F71\u0F80",
"\u0F93"=>"\u0F92\u0FB7",
"\u0F9D"=>"\u0F9C\u0FB7",
"\u0FA2"=>"\u0FA1\u0FB7",
"\u0FA7"=>"\u0FA6\u0FB7",
"\u0FAC"=>"\u0FAB\u0FB7",
"\u0FB9"=>"\u0F90\u0FB5",
"\u1026"=>"\u1025\u102E",
"\u1B06"=>"\u1B05\u1B35",
"\u1B08"=>"\u1B07\u1B35",
"\u1B0A"=>"\u1B09\u1B35",
"\u1B0C"=>"\u1B0B\u1B35",
"\u1B0E"=>"\u1B0D\u1B35",
"\u1B12"=>"\u1B11\u1B35",
"\u1B3B"=>"\u1B3A\u1B35",
"\u1B3D"=>"\u1B3C\u1B35",
"\u1B40"=>"\u1B3E\u1B35",
"\u1B41"=>"\u1B3F\u1B35",
"\u1B43"=>"\u1B42\u1B35",
"\u1E00"=>"A\u0325",
"\u1E01"=>"a\u0325",
"\u1E02"=>"B\u0307",
"\u1E03"=>"b\u0307",
"\u1E04"=>"B\u0323",
"\u1E05"=>"b\u0323",
"\u1E06"=>"B\u0331",
"\u1E07"=>"b\u0331",
"\u1E08"=>"C\u0327\u0301",
"\u1E09"=>"c\u0327\u0301",
"\u1E0A"=>"D\u0307",
"\u1E0B"=>"d\u0307",
"\u1E0C"=>"D\u0323",
"\u1E0D"=>"d\u0323",
"\u1E0E"=>"D\u0331",
"\u1E0F"=>"d\u0331",
"\u1E10"=>"D\u0327",
"\u1E11"=>"d\u0327",
"\u1E12"=>"D\u032D",
"\u1E13"=>"d\u032D",
"\u1E14"=>"E\u0304\u0300",
"\u1E15"=>"e\u0304\u0300",
"\u1E16"=>"E\u0304\u0301",
"\u1E17"=>"e\u0304\u0301",
"\u1E18"=>"E\u032D",
"\u1E19"=>"e\u032D",
"\u1E1A"=>"E\u0330",
"\u1E1B"=>"e\u0330",
"\u1E1C"=>"E\u0327\u0306",
"\u1E1D"=>"e\u0327\u0306",
"\u1E1E"=>"F\u0307",
"\u1E1F"=>"f\u0307",
"\u1E20"=>"G\u0304",
"\u1E21"=>"g\u0304",
"\u1E22"=>"H\u0307",
"\u1E23"=>"h\u0307",
"\u1E24"=>"H\u0323",
"\u1E25"=>"h\u0323",
"\u1E26"=>"H\u0308",
"\u1E27"=>"h\u0308",
"\u1E28"=>"H\u0327",
"\u1E29"=>"h\u0327",
"\u1E2A"=>"H\u032E",
"\u1E2B"=>"h\u032E",
"\u1E2C"=>"I\u0330",
"\u1E2D"=>"i\u0330",
"\u1E2E"=>"I\u0308\u0301",
"\u1E2F"=>"i\u0308\u0301",
"\u1E30"=>"K\u0301",
"\u1E31"=>"k\u0301",
"\u1E32"=>"K\u0323",
"\u1E33"=>"k\u0323",
"\u1E34"=>"K\u0331",
"\u1E35"=>"k\u0331",
"\u1E36"=>"L\u0323",
"\u1E37"=>"l\u0323",
"\u1E38"=>"L\u0323\u0304",
"\u1E39"=>"l\u0323\u0304",
"\u1E3A"=>"L\u0331",
"\u1E3B"=>"l\u0331",
"\u1E3C"=>"L\u032D",
"\u1E3D"=>"l\u032D",
"\u1E3E"=>"M\u0301",
"\u1E3F"=>"m\u0301",
"\u1E40"=>"M\u0307",
"\u1E41"=>"m\u0307",
"\u1E42"=>"M\u0323",
"\u1E43"=>"m\u0323",
"\u1E44"=>"N\u0307",
"\u1E45"=>"n\u0307",
"\u1E46"=>"N\u0323",
"\u1E47"=>"n\u0323",
"\u1E48"=>"N\u0331",
"\u1E49"=>"n\u0331",
"\u1E4A"=>"N\u032D",
"\u1E4B"=>"n\u032D",
"\u1E4C"=>"O\u0303\u0301",
"\u1E4D"=>"o\u0303\u0301",
"\u1E4E"=>"O\u0303\u0308",
"\u1E4F"=>"o\u0303\u0308",
"\u1E50"=>"O\u0304\u0300",
"\u1E51"=>"o\u0304\u0300",
"\u1E52"=>"O\u0304\u0301",
"\u1E53"=>"o\u0304\u0301",
"\u1E54"=>"P\u0301",
"\u1E55"=>"p\u0301",
"\u1E56"=>"P\u0307",
"\u1E57"=>"p\u0307",
"\u1E58"=>"R\u0307",
"\u1E59"=>"r\u0307",
"\u1E5A"=>"R\u0323",
"\u1E5B"=>"r\u0323",
"\u1E5C"=>"R\u0323\u0304",
"\u1E5D"=>"r\u0323\u0304",
"\u1E5E"=>"R\u0331",
"\u1E5F"=>"r\u0331",
"\u1E60"=>"S\u0307",
"\u1E61"=>"s\u0307",
"\u1E62"=>"S\u0323",
"\u1E63"=>"s\u0323",
"\u1E64"=>"S\u0301\u0307",
"\u1E65"=>"s\u0301\u0307",
"\u1E66"=>"S\u030C\u0307",
"\u1E67"=>"s\u030C\u0307",
"\u1E68"=>"S\u0323\u0307",
"\u1E69"=>"s\u0323\u0307",
"\u1E6A"=>"T\u0307",
"\u1E6B"=>"t\u0307",
"\u1E6C"=>"T\u0323",
"\u1E6D"=>"t\u0323",
"\u1E6E"=>"T\u0331",
"\u1E6F"=>"t\u0331",
"\u1E70"=>"T\u032D",
"\u1E71"=>"t\u032D",
"\u1E72"=>"U\u0324",
"\u1E73"=>"u\u0324",
"\u1E74"=>"U\u0330",
"\u1E75"=>"u\u0330",
"\u1E76"=>"U\u032D",
"\u1E77"=>"u\u032D",
"\u1E78"=>"U\u0303\u0301",
"\u1E79"=>"u\u0303\u0301",
"\u1E7A"=>"U\u0304\u0308",
"\u1E7B"=>"u\u0304\u0308",
"\u1E7C"=>"V\u0303",
"\u1E7D"=>"v\u0303",
"\u1E7E"=>"V\u0323",
"\u1E7F"=>"v\u0323",
"\u1E80"=>"W\u0300",
"\u1E81"=>"w\u0300",
"\u1E82"=>"W\u0301",
"\u1E83"=>"w\u0301",
"\u1E84"=>"W\u0308",
"\u1E85"=>"w\u0308",
"\u1E86"=>"W\u0307",
"\u1E87"=>"w\u0307",
"\u1E88"=>"W\u0323",
"\u1E89"=>"w\u0323",
"\u1E8A"=>"X\u0307",
"\u1E8B"=>"x\u0307",
"\u1E8C"=>"X\u0308",
"\u1E8D"=>"x\u0308",
"\u1E8E"=>"Y\u0307",
"\u1E8F"=>"y\u0307",
"\u1E90"=>"Z\u0302",
"\u1E91"=>"z\u0302",
"\u1E92"=>"Z\u0323",
"\u1E93"=>"z\u0323",
"\u1E94"=>"Z\u0331",
"\u1E95"=>"z\u0331",
"\u1E96"=>"h\u0331",
"\u1E97"=>"t\u0308",
"\u1E98"=>"w\u030A",
"\u1E99"=>"y\u030A",
"\u1E9B"=>"\u017F\u0307",
"\u1EA0"=>"A\u0323",
"\u1EA1"=>"a\u0323",
"\u1EA2"=>"A\u0309",
"\u1EA3"=>"a\u0309",
"\u1EA4"=>"A\u0302\u0301",
"\u1EA5"=>"a\u0302\u0301",
"\u1EA6"=>"A\u0302\u0300",
"\u1EA7"=>"a\u0302\u0300",
"\u1EA8"=>"A\u0302\u0309",
"\u1EA9"=>"a\u0302\u0309",
"\u1EAA"=>"A\u0302\u0303",
"\u1EAB"=>"a\u0302\u0303",
"\u1EAC"=>"A\u0323\u0302",
"\u1EAD"=>"a\u0323\u0302",
"\u1EAE"=>"A\u0306\u0301",
"\u1EAF"=>"a\u0306\u0301",
"\u1EB0"=>"A\u0306\u0300",
"\u1EB1"=>"a\u0306\u0300",
"\u1EB2"=>"A\u0306\u0309",
"\u1EB3"=>"a\u0306\u0309",
"\u1EB4"=>"A\u0306\u0303",
"\u1EB5"=>"a\u0306\u0303",
"\u1EB6"=>"A\u0323\u0306",
"\u1EB7"=>"a\u0323\u0306",
"\u1EB8"=>"E\u0323",
"\u1EB9"=>"e\u0323",
"\u1EBA"=>"E\u0309",
"\u1EBB"=>"e\u0309",
"\u1EBC"=>"E\u0303",
"\u1EBD"=>"e\u0303",
"\u1EBE"=>"E\u0302\u0301",
"\u1EBF"=>"e\u0302\u0301",
"\u1EC0"=>"E\u0302\u0300",
"\u1EC1"=>"e\u0302\u0300",
"\u1EC2"=>"E\u0302\u0309",
"\u1EC3"=>"e\u0302\u0309",
"\u1EC4"=>"E\u0302\u0303",
"\u1EC5"=>"e\u0302\u0303",
"\u1EC6"=>"E\u0323\u0302",
"\u1EC7"=>"e\u0323\u0302",
"\u1EC8"=>"I\u0309",
"\u1EC9"=>"i\u0309",
"\u1ECA"=>"I\u0323",
"\u1ECB"=>"i\u0323",
"\u1ECC"=>"O\u0323",
"\u1ECD"=>"o\u0323",
"\u1ECE"=>"O\u0309",
"\u1ECF"=>"o\u0309",
"\u1ED0"=>"O\u0302\u0301",
"\u1ED1"=>"o\u0302\u0301",
"\u1ED2"=>"O\u0302\u0300",
"\u1ED3"=>"o\u0302\u0300",
"\u1ED4"=>"O\u0302\u0309",
"\u1ED5"=>"o\u0302\u0309",
"\u1ED6"=>"O\u0302\u0303",
"\u1ED7"=>"o\u0302\u0303",
"\u1ED8"=>"O\u0323\u0302",
"\u1ED9"=>"o\u0323\u0302",
"\u1EDA"=>"O\u031B\u0301",
"\u1EDB"=>"o\u031B\u0301",
"\u1EDC"=>"O\u031B\u0300",
"\u1EDD"=>"o\u031B\u0300",
"\u1EDE"=>"O\u031B\u0309",
"\u1EDF"=>"o\u031B\u0309",
"\u1EE0"=>"O\u031B\u0303",
"\u1EE1"=>"o\u031B\u0303",
"\u1EE2"=>"O\u031B\u0323",
"\u1EE3"=>"o\u031B\u0323",
"\u1EE4"=>"U\u0323",
"\u1EE5"=>"u\u0323",
"\u1EE6"=>"U\u0309",
"\u1EE7"=>"u\u0309",
"\u1EE8"=>"U\u031B\u0301",
"\u1EE9"=>"u\u031B\u0301",
"\u1EEA"=>"U\u031B\u0300",
"\u1EEB"=>"u\u031B\u0300",
"\u1EEC"=>"U\u031B\u0309",
"\u1EED"=>"u\u031B\u0309",
"\u1EEE"=>"U\u031B\u0303",
"\u1EEF"=>"u\u031B\u0303",
"\u1EF0"=>"U\u031B\u0323",
"\u1EF1"=>"u\u031B\u0323",
"\u1EF2"=>"Y\u0300",
"\u1EF3"=>"y\u0300",
"\u1EF4"=>"Y\u0323",
"\u1EF5"=>"y\u0323",
"\u1EF6"=>"Y\u0309",
"\u1EF7"=>"y\u0309",
"\u1EF8"=>"Y\u0303",
"\u1EF9"=>"y\u0303",
"\u1F00"=>"\u03B1\u0313",
"\u1F01"=>"\u03B1\u0314",
"\u1F02"=>"\u03B1\u0313\u0300",
"\u1F03"=>"\u03B1\u0314\u0300",
"\u1F04"=>"\u03B1\u0313\u0301",
"\u1F05"=>"\u03B1\u0314\u0301",
"\u1F06"=>"\u03B1\u0313\u0342",
"\u1F07"=>"\u03B1\u0314\u0342",
"\u1F08"=>"\u0391\u0313",
"\u1F09"=>"\u0391\u0314",
"\u1F0A"=>"\u0391\u0313\u0300",
"\u1F0B"=>"\u0391\u0314\u0300",
"\u1F0C"=>"\u0391\u0313\u0301",
"\u1F0D"=>"\u0391\u0314\u0301",
"\u1F0E"=>"\u0391\u0313\u0342",
"\u1F0F"=>"\u0391\u0314\u0342",
"\u1F10"=>"\u03B5\u0313",
"\u1F11"=>"\u03B5\u0314",
"\u1F12"=>"\u03B5\u0313\u0300",
"\u1F13"=>"\u03B5\u0314\u0300",
"\u1F14"=>"\u03B5\u0313\u0301",
"\u1F15"=>"\u03B5\u0314\u0301",
"\u1F18"=>"\u0395\u0313",
"\u1F19"=>"\u0395\u0314",
"\u1F1A"=>"\u0395\u0313\u0300",
"\u1F1B"=>"\u0395\u0314\u0300",
"\u1F1C"=>"\u0395\u0313\u0301",
"\u1F1D"=>"\u0395\u0314\u0301",
"\u1F20"=>"\u03B7\u0313",
"\u1F21"=>"\u03B7\u0314",
"\u1F22"=>"\u03B7\u0313\u0300",
"\u1F23"=>"\u03B7\u0314\u0300",
"\u1F24"=>"\u03B7\u0313\u0301",
"\u1F25"=>"\u03B7\u0314\u0301",
"\u1F26"=>"\u03B7\u0313\u0342",
"\u1F27"=>"\u03B7\u0314\u0342",
"\u1F28"=>"\u0397\u0313",
"\u1F29"=>"\u0397\u0314",
"\u1F2A"=>"\u0397\u0313\u0300",
"\u1F2B"=>"\u0397\u0314\u0300",
"\u1F2C"=>"\u0397\u0313\u0301",
"\u1F2D"=>"\u0397\u0314\u0301",
"\u1F2E"=>"\u0397\u0313\u0342",
"\u1F2F"=>"\u0397\u0314\u0342",
"\u1F30"=>"\u03B9\u0313",
"\u1F31"=>"\u03B9\u0314",
"\u1F32"=>"\u03B9\u0313\u0300",
"\u1F33"=>"\u03B9\u0314\u0300",
"\u1F34"=>"\u03B9\u0313\u0301",
"\u1F35"=>"\u03B9\u0314\u0301",
"\u1F36"=>"\u03B9\u0313\u0342",
"\u1F37"=>"\u03B9\u0314\u0342",
"\u1F38"=>"\u0399\u0313",
"\u1F39"=>"\u0399\u0314",
"\u1F3A"=>"\u0399\u0313\u0300",
"\u1F3B"=>"\u0399\u0314\u0300",
"\u1F3C"=>"\u0399\u0313\u0301",
"\u1F3D"=>"\u0399\u0314\u0301",
"\u1F3E"=>"\u0399\u0313\u0342",
"\u1F3F"=>"\u0399\u0314\u0342",
"\u1F40"=>"\u03BF\u0313",
"\u1F41"=>"\u03BF\u0314",
"\u1F42"=>"\u03BF\u0313\u0300",
"\u1F43"=>"\u03BF\u0314\u0300",
"\u1F44"=>"\u03BF\u0313\u0301",
"\u1F45"=>"\u03BF\u0314\u0301",
"\u1F48"=>"\u039F\u0313",
"\u1F49"=>"\u039F\u0314",
"\u1F4A"=>"\u039F\u0313\u0300",
"\u1F4B"=>"\u039F\u0314\u0300",
"\u1F4C"=>"\u039F\u0313\u0301",
"\u1F4D"=>"\u039F\u0314\u0301",
"\u1F50"=>"\u03C5\u0313",
"\u1F51"=>"\u03C5\u0314",
"\u1F52"=>"\u03C5\u0313\u0300",
"\u1F53"=>"\u03C5\u0314\u0300",
"\u1F54"=>"\u03C5\u0313\u0301",
"\u1F55"=>"\u03C5\u0314\u0301",
"\u1F56"=>"\u03C5\u0313\u0342",
"\u1F57"=>"\u03C5\u0314\u0342",
"\u1F59"=>"\u03A5\u0314",
"\u1F5B"=>"\u03A5\u0314\u0300",
"\u1F5D"=>"\u03A5\u0314\u0301",
"\u1F5F"=>"\u03A5\u0314\u0342",
"\u1F60"=>"\u03C9\u0313",
"\u1F61"=>"\u03C9\u0314",
"\u1F62"=>"\u03C9\u0313\u0300",
"\u1F63"=>"\u03C9\u0314\u0300",
"\u1F64"=>"\u03C9\u0313\u0301",
"\u1F65"=>"\u03C9\u0314\u0301",
"\u1F66"=>"\u03C9\u0313\u0342",
"\u1F67"=>"\u03C9\u0314\u0342",
"\u1F68"=>"\u03A9\u0313",
"\u1F69"=>"\u03A9\u0314",
"\u1F6A"=>"\u03A9\u0313\u0300",
"\u1F6B"=>"\u03A9\u0314\u0300",
"\u1F6C"=>"\u03A9\u0313\u0301",
"\u1F6D"=>"\u03A9\u0314\u0301",
"\u1F6E"=>"\u03A9\u0313\u0342",
"\u1F6F"=>"\u03A9\u0314\u0342",
"\u1F70"=>"\u03B1\u0300",
"\u1F71"=>"\u03B1\u0301",
"\u1F72"=>"\u03B5\u0300",
"\u1F73"=>"\u03B5\u0301",
"\u1F74"=>"\u03B7\u0300",
"\u1F75"=>"\u03B7\u0301",
"\u1F76"=>"\u03B9\u0300",
"\u1F77"=>"\u03B9\u0301",
"\u1F78"=>"\u03BF\u0300",
"\u1F79"=>"\u03BF\u0301",
"\u1F7A"=>"\u03C5\u0300",
"\u1F7B"=>"\u03C5\u0301",
"\u1F7C"=>"\u03C9\u0300",
"\u1F7D"=>"\u03C9\u0301",
"\u1F80"=>"\u03B1\u0313\u0345",
"\u1F81"=>"\u03B1\u0314\u0345",
"\u1F82"=>"\u03B1\u0313\u0300\u0345",
"\u1F83"=>"\u03B1\u0314\u0300\u0345",
"\u1F84"=>"\u03B1\u0313\u0301\u0345",
"\u1F85"=>"\u03B1\u0314\u0301\u0345",
"\u1F86"=>"\u03B1\u0313\u0342\u0345",
"\u1F87"=>"\u03B1\u0314\u0342\u0345",
"\u1F88"=>"\u0391\u0313\u0345",
"\u1F89"=>"\u0391\u0314\u0345",
"\u1F8A"=>"\u0391\u0313\u0300\u0345",
"\u1F8B"=>"\u0391\u0314\u0300\u0345",
"\u1F8C"=>"\u0391\u0313\u0301\u0345",
"\u1F8D"=>"\u0391\u0314\u0301\u0345",
"\u1F8E"=>"\u0391\u0313\u0342\u0345",
"\u1F8F"=>"\u0391\u0314\u0342\u0345",
"\u1F90"=>"\u03B7\u0313\u0345",
"\u1F91"=>"\u03B7\u0314\u0345",
"\u1F92"=>"\u03B7\u0313\u0300\u0345",
"\u1F93"=>"\u03B7\u0314\u0300\u0345",
"\u1F94"=>"\u03B7\u0313\u0301\u0345",
"\u1F95"=>"\u03B7\u0314\u0301\u0345",
"\u1F96"=>"\u03B7\u0313\u0342\u0345",
"\u1F97"=>"\u03B7\u0314\u0342\u0345",
"\u1F98"=>"\u0397\u0313\u0345",
"\u1F99"=>"\u0397\u0314\u0345",
"\u1F9A"=>"\u0397\u0313\u0300\u0345",
"\u1F9B"=>"\u0397\u0314\u0300\u0345",
"\u1F9C"=>"\u0397\u0313\u0301\u0345",
"\u1F9D"=>"\u0397\u0314\u0301\u0345",
"\u1F9E"=>"\u0397\u0313\u0342\u0345",
"\u1F9F"=>"\u0397\u0314\u0342\u0345",
"\u1FA0"=>"\u03C9\u0313\u0345",
"\u1FA1"=>"\u03C9\u0314\u0345",
"\u1FA2"=>"\u03C9\u0313\u0300\u0345",
"\u1FA3"=>"\u03C9\u0314\u0300\u0345",
"\u1FA4"=>"\u03C9\u0313\u0301\u0345",
"\u1FA5"=>"\u03C9\u0314\u0301\u0345",
"\u1FA6"=>"\u03C9\u0313\u0342\u0345",
"\u1FA7"=>"\u03C9\u0314\u0342\u0345",
"\u1FA8"=>"\u03A9\u0313\u0345",
"\u1FA9"=>"\u03A9\u0314\u0345",
"\u1FAA"=>"\u03A9\u0313\u0300\u0345",
"\u1FAB"=>"\u03A9\u0314\u0300\u0345",
"\u1FAC"=>"\u03A9\u0313\u0301\u0345",
"\u1FAD"=>"\u03A9\u0314\u0301\u0345",
"\u1FAE"=>"\u03A9\u0313\u0342\u0345",
"\u1FAF"=>"\u03A9\u0314\u0342\u0345",
"\u1FB0"=>"\u03B1\u0306",
"\u1FB1"=>"\u03B1\u0304",
"\u1FB2"=>"\u03B1\u0300\u0345",
"\u1FB3"=>"\u03B1\u0345",
"\u1FB4"=>"\u03B1\u0301\u0345",
"\u1FB6"=>"\u03B1\u0342",
"\u1FB7"=>"\u03B1\u0342\u0345",
"\u1FB8"=>"\u0391\u0306",
"\u1FB9"=>"\u0391\u0304",
"\u1FBA"=>"\u0391\u0300",
"\u1FBB"=>"\u0391\u0301",
"\u1FBC"=>"\u0391\u0345",
"\u1FBE"=>"\u03B9",
"\u1FC1"=>"\u00A8\u0342",
"\u1FC2"=>"\u03B7\u0300\u0345",
"\u1FC3"=>"\u03B7\u0345",
"\u1FC4"=>"\u03B7\u0301\u0345",
"\u1FC6"=>"\u03B7\u0342",
"\u1FC7"=>"\u03B7\u0342\u0345",
"\u1FC8"=>"\u0395\u0300",
"\u1FC9"=>"\u0395\u0301",
"\u1FCA"=>"\u0397\u0300",
"\u1FCB"=>"\u0397\u0301",
"\u1FCC"=>"\u0397\u0345",
"\u1FCD"=>"\u1FBF\u0300",
"\u1FCE"=>"\u1FBF\u0301",
"\u1FCF"=>"\u1FBF\u0342",
"\u1FD0"=>"\u03B9\u0306",
"\u1FD1"=>"\u03B9\u0304",
"\u1FD2"=>"\u03B9\u0308\u0300",
"\u1FD3"=>"\u03B9\u0308\u0301",
"\u1FD6"=>"\u03B9\u0342",
"\u1FD7"=>"\u03B9\u0308\u0342",
"\u1FD8"=>"\u0399\u0306",
"\u1FD9"=>"\u0399\u0304",
"\u1FDA"=>"\u0399\u0300",
"\u1FDB"=>"\u0399\u0301",
"\u1FDD"=>"\u1FFE\u0300",
"\u1FDE"=>"\u1FFE\u0301",
"\u1FDF"=>"\u1FFE\u0342",
"\u1FE0"=>"\u03C5\u0306",
"\u1FE1"=>"\u03C5\u0304",
"\u1FE2"=>"\u03C5\u0308\u0300",
"\u1FE3"=>"\u03C5\u0308\u0301",
"\u1FE4"=>"\u03C1\u0313",
"\u1FE5"=>"\u03C1\u0314",
"\u1FE6"=>"\u03C5\u0342",
"\u1FE7"=>"\u03C5\u0308\u0342",
"\u1FE8"=>"\u03A5\u0306",
"\u1FE9"=>"\u03A5\u0304",
"\u1FEA"=>"\u03A5\u0300",
"\u1FEB"=>"\u03A5\u0301",
"\u1FEC"=>"\u03A1\u0314",
"\u1FED"=>"\u00A8\u0300",
"\u1FEE"=>"\u00A8\u0301",
"\u1FEF"=>"`",
"\u1FF2"=>"\u03C9\u0300\u0345",
"\u1FF3"=>"\u03C9\u0345",
"\u1FF4"=>"\u03C9\u0301\u0345",
"\u1FF6"=>"\u03C9\u0342",
"\u1FF7"=>"\u03C9\u0342\u0345",
"\u1FF8"=>"\u039F\u0300",
"\u1FF9"=>"\u039F\u0301",
"\u1FFA"=>"\u03A9\u0300",
"\u1FFB"=>"\u03A9\u0301",
"\u1FFC"=>"\u03A9\u0345",
"\u1FFD"=>"\u00B4",
"\u2000"=>"\u2002",
"\u2001"=>"\u2003",
"\u2126"=>"\u03A9",
"\u212A"=>"K",
"\u212B"=>"A\u030A",
"\u219A"=>"\u2190\u0338",
"\u219B"=>"\u2192\u0338",
"\u21AE"=>"\u2194\u0338",
"\u21CD"=>"\u21D0\u0338",
"\u21CE"=>"\u21D4\u0338",
"\u21CF"=>"\u21D2\u0338",
"\u2204"=>"\u2203\u0338",
"\u2209"=>"\u2208\u0338",
"\u220C"=>"\u220B\u0338",
"\u2224"=>"\u2223\u0338",
"\u2226"=>"\u2225\u0338",
"\u2241"=>"\u223C\u0338",
"\u2244"=>"\u2243\u0338",
"\u2247"=>"\u2245\u0338",
"\u2249"=>"\u2248\u0338",
"\u2260"=>"=\u0338",
"\u2262"=>"\u2261\u0338",
"\u226D"=>"\u224D\u0338",
"\u226E"=>"<\u0338",
"\u226F"=>">\u0338",
"\u2270"=>"\u2264\u0338",
"\u2271"=>"\u2265\u0338",
"\u2274"=>"\u2272\u0338",
"\u2275"=>"\u2273\u0338",
"\u2278"=>"\u2276\u0338",
"\u2279"=>"\u2277\u0338",
"\u2280"=>"\u227A\u0338",
"\u2281"=>"\u227B\u0338",
"\u2284"=>"\u2282\u0338",
"\u2285"=>"\u2283\u0338",
"\u2288"=>"\u2286\u0338",
"\u2289"=>"\u2287\u0338",
"\u22AC"=>"\u22A2\u0338",
"\u22AD"=>"\u22A8\u0338",
"\u22AE"=>"\u22A9\u0338",
"\u22AF"=>"\u22AB\u0338",
"\u22E0"=>"\u227C\u0338",
"\u22E1"=>"\u227D\u0338",
"\u22E2"=>"\u2291\u0338",
"\u22E3"=>"\u2292\u0338",
"\u22EA"=>"\u22B2\u0338",
"\u22EB"=>"\u22B3\u0338",
"\u22EC"=>"\u22B4\u0338",
"\u22ED"=>"\u22B5\u0338",
"\u2329"=>"\u3008",
"\u232A"=>"\u3009",
"\u2ADC"=>"\u2ADD\u0338",
"\u304C"=>"\u304B\u3099",
"\u304E"=>"\u304D\u3099",
"\u3050"=>"\u304F\u3099",
"\u3052"=>"\u3051\u3099",
"\u3054"=>"\u3053\u3099",
"\u3056"=>"\u3055\u3099",
"\u3058"=>"\u3057\u3099",
"\u305A"=>"\u3059\u3099",
"\u305C"=>"\u305B\u3099",
"\u305E"=>"\u305D\u3099",
"\u3060"=>"\u305F\u3099",
"\u3062"=>"\u3061\u3099",
"\u3065"=>"\u3064\u3099",
"\u3067"=>"\u3066\u3099",
"\u3069"=>"\u3068\u3099",
"\u3070"=>"\u306F\u3099",
"\u3071"=>"\u306F\u309A",
"\u3073"=>"\u3072\u3099",
"\u3074"=>"\u3072\u309A",
"\u3076"=>"\u3075\u3099",
"\u3077"=>"\u3075\u309A",
"\u3079"=>"\u3078\u3099",
"\u307A"=>"\u3078\u309A",
"\u307C"=>"\u307B\u3099",
"\u307D"=>"\u307B\u309A",
"\u3094"=>"\u3046\u3099",
"\u309E"=>"\u309D\u3099",
"\u30AC"=>"\u30AB\u3099",
"\u30AE"=>"\u30AD\u3099",
"\u30B0"=>"\u30AF\u3099",
"\u30B2"=>"\u30B1\u3099",
"\u30B4"=>"\u30B3\u3099",
"\u30B6"=>"\u30B5\u3099",
"\u30B8"=>"\u30B7\u3099",
"\u30BA"=>"\u30B9\u3099",
"\u30BC"=>"\u30BB\u3099",
"\u30BE"=>"\u30BD\u3099",
"\u30C0"=>"\u30BF\u3099",
"\u30C2"=>"\u30C1\u3099",
"\u30C5"=>"\u30C4\u3099",
"\u30C7"=>"\u30C6\u3099",
"\u30C9"=>"\u30C8\u3099",
"\u30D0"=>"\u30CF\u3099",
"\u30D1"=>"\u30CF\u309A",
"\u30D3"=>"\u30D2\u3099",
"\u30D4"=>"\u30D2\u309A",
"\u30D6"=>"\u30D5\u3099",
"\u30D7"=>"\u30D5\u309A",
"\u30D9"=>"\u30D8\u3099",
"\u30DA"=>"\u30D8\u309A",
"\u30DC"=>"\u30DB\u3099",
"\u30DD"=>"\u30DB\u309A",
"\u30F4"=>"\u30A6\u3099",
"\u30F7"=>"\u30EF\u3099",
"\u30F8"=>"\u30F0\u3099",
"\u30F9"=>"\u30F1\u3099",
"\u30FA"=>"\u30F2\u3099",
"\u30FE"=>"\u30FD\u3099",
"\uF900"=>"\u8C48",
"\uF901"=>"\u66F4",
"\uF902"=>"\u8ECA",
"\uF903"=>"\u8CC8",
"\uF904"=>"\u6ED1",
"\uF905"=>"\u4E32",
"\uF906"=>"\u53E5",
"\uF907"=>"\u9F9C",
"\uF908"=>"\u9F9C",
"\uF909"=>"\u5951",
"\uF90A"=>"\u91D1",
"\uF90B"=>"\u5587",
"\uF90C"=>"\u5948",
"\uF90D"=>"\u61F6",
"\uF90E"=>"\u7669",
"\uF90F"=>"\u7F85",
"\uF910"=>"\u863F",
"\uF911"=>"\u87BA",
"\uF912"=>"\u88F8",
"\uF913"=>"\u908F",
"\uF914"=>"\u6A02",
"\uF915"=>"\u6D1B",
"\uF916"=>"\u70D9",
"\uF917"=>"\u73DE",
"\uF918"=>"\u843D",
"\uF919"=>"\u916A",
"\uF91A"=>"\u99F1",
"\uF91B"=>"\u4E82",
"\uF91C"=>"\u5375",
"\uF91D"=>"\u6B04",
"\uF91E"=>"\u721B",
"\uF91F"=>"\u862D",
"\uF920"=>"\u9E1E",
"\uF921"=>"\u5D50",
"\uF922"=>"\u6FEB",
"\uF923"=>"\u85CD",
"\uF924"=>"\u8964",
"\uF925"=>"\u62C9",
"\uF926"=>"\u81D8",
"\uF927"=>"\u881F",
"\uF928"=>"\u5ECA",
"\uF929"=>"\u6717",
"\uF92A"=>"\u6D6A",
"\uF92B"=>"\u72FC",
"\uF92C"=>"\u90CE",
"\uF92D"=>"\u4F86",
"\uF92E"=>"\u51B7",
"\uF92F"=>"\u52DE",
"\uF930"=>"\u64C4",
"\uF931"=>"\u6AD3",
"\uF932"=>"\u7210",
"\uF933"=>"\u76E7",
"\uF934"=>"\u8001",
"\uF935"=>"\u8606",
"\uF936"=>"\u865C",
"\uF937"=>"\u8DEF",
"\uF938"=>"\u9732",
"\uF939"=>"\u9B6F",
"\uF93A"=>"\u9DFA",
"\uF93B"=>"\u788C",
"\uF93C"=>"\u797F",
"\uF93D"=>"\u7DA0",
"\uF93E"=>"\u83C9",
"\uF93F"=>"\u9304",
"\uF940"=>"\u9E7F",
"\uF941"=>"\u8AD6",
"\uF942"=>"\u58DF",
"\uF943"=>"\u5F04",
"\uF944"=>"\u7C60",
"\uF945"=>"\u807E",
"\uF946"=>"\u7262",
"\uF947"=>"\u78CA",
"\uF948"=>"\u8CC2",
"\uF949"=>"\u96F7",
"\uF94A"=>"\u58D8",
"\uF94B"=>"\u5C62",
"\uF94C"=>"\u6A13",
"\uF94D"=>"\u6DDA",
"\uF94E"=>"\u6F0F",
"\uF94F"=>"\u7D2F",
"\uF950"=>"\u7E37",
"\uF951"=>"\u964B",
"\uF952"=>"\u52D2",
"\uF953"=>"\u808B",
"\uF954"=>"\u51DC",
"\uF955"=>"\u51CC",
"\uF956"=>"\u7A1C",
"\uF957"=>"\u7DBE",
"\uF958"=>"\u83F1",
"\uF959"=>"\u9675",
"\uF95A"=>"\u8B80",
"\uF95B"=>"\u62CF",
"\uF95C"=>"\u6A02",
"\uF95D"=>"\u8AFE",
"\uF95E"=>"\u4E39",
"\uF95F"=>"\u5BE7",
"\uF960"=>"\u6012",
"\uF961"=>"\u7387",
"\uF962"=>"\u7570",
"\uF963"=>"\u5317",
"\uF964"=>"\u78FB",
"\uF965"=>"\u4FBF",
"\uF966"=>"\u5FA9",
"\uF967"=>"\u4E0D",
"\uF968"=>"\u6CCC",
"\uF969"=>"\u6578",
"\uF96A"=>"\u7D22",
"\uF96B"=>"\u53C3",
"\uF96C"=>"\u585E",
"\uF96D"=>"\u7701",
"\uF96E"=>"\u8449",
"\uF96F"=>"\u8AAA",
"\uF970"=>"\u6BBA",
"\uF971"=>"\u8FB0",
"\uF972"=>"\u6C88",
"\uF973"=>"\u62FE",
"\uF974"=>"\u82E5",
"\uF975"=>"\u63A0",
"\uF976"=>"\u7565",
"\uF977"=>"\u4EAE",
"\uF978"=>"\u5169",
"\uF979"=>"\u51C9",
"\uF97A"=>"\u6881",
"\uF97B"=>"\u7CE7",
"\uF97C"=>"\u826F",
"\uF97D"=>"\u8AD2",
"\uF97E"=>"\u91CF",
"\uF97F"=>"\u52F5",
"\uF980"=>"\u5442",
"\uF981"=>"\u5973",
"\uF982"=>"\u5EEC",
"\uF983"=>"\u65C5",
"\uF984"=>"\u6FFE",
"\uF985"=>"\u792A",
"\uF986"=>"\u95AD",
"\uF987"=>"\u9A6A",
"\uF988"=>"\u9E97",
"\uF989"=>"\u9ECE",
"\uF98A"=>"\u529B",
"\uF98B"=>"\u66C6",
"\uF98C"=>"\u6B77",
"\uF98D"=>"\u8F62",
"\uF98E"=>"\u5E74",
"\uF98F"=>"\u6190",
"\uF990"=>"\u6200",
"\uF991"=>"\u649A",
"\uF992"=>"\u6F23",
"\uF993"=>"\u7149",
"\uF994"=>"\u7489",
"\uF995"=>"\u79CA",
"\uF996"=>"\u7DF4",
"\uF997"=>"\u806F",
"\uF998"=>"\u8F26",
"\uF999"=>"\u84EE",
"\uF99A"=>"\u9023",
"\uF99B"=>"\u934A",
"\uF99C"=>"\u5217",
"\uF99D"=>"\u52A3",
"\uF99E"=>"\u54BD",
"\uF99F"=>"\u70C8",
"\uF9A0"=>"\u88C2",
"\uF9A1"=>"\u8AAA",
"\uF9A2"=>"\u5EC9",
"\uF9A3"=>"\u5FF5",
"\uF9A4"=>"\u637B",
"\uF9A5"=>"\u6BAE",
"\uF9A6"=>"\u7C3E",
"\uF9A7"=>"\u7375",
"\uF9A8"=>"\u4EE4",
"\uF9A9"=>"\u56F9",
"\uF9AA"=>"\u5BE7",
"\uF9AB"=>"\u5DBA",
"\uF9AC"=>"\u601C",
"\uF9AD"=>"\u73B2",
"\uF9AE"=>"\u7469",
"\uF9AF"=>"\u7F9A",
"\uF9B0"=>"\u8046",
"\uF9B1"=>"\u9234",
"\uF9B2"=>"\u96F6",
"\uF9B3"=>"\u9748",
"\uF9B4"=>"\u9818",
"\uF9B5"=>"\u4F8B",
"\uF9B6"=>"\u79AE",
"\uF9B7"=>"\u91B4",
"\uF9B8"=>"\u96B8",
"\uF9B9"=>"\u60E1",
"\uF9BA"=>"\u4E86",
"\uF9BB"=>"\u50DA",
"\uF9BC"=>"\u5BEE",
"\uF9BD"=>"\u5C3F",
"\uF9BE"=>"\u6599",
"\uF9BF"=>"\u6A02",
"\uF9C0"=>"\u71CE",
"\uF9C1"=>"\u7642",
"\uF9C2"=>"\u84FC",
"\uF9C3"=>"\u907C",
"\uF9C4"=>"\u9F8D",
"\uF9C5"=>"\u6688",
"\uF9C6"=>"\u962E",
"\uF9C7"=>"\u5289",
"\uF9C8"=>"\u677B",
"\uF9C9"=>"\u67F3",
"\uF9CA"=>"\u6D41",
"\uF9CB"=>"\u6E9C",
"\uF9CC"=>"\u7409",
"\uF9CD"=>"\u7559",
"\uF9CE"=>"\u786B",
"\uF9CF"=>"\u7D10",
"\uF9D0"=>"\u985E",
"\uF9D1"=>"\u516D",
"\uF9D2"=>"\u622E",
"\uF9D3"=>"\u9678",
"\uF9D4"=>"\u502B",
"\uF9D5"=>"\u5D19",
"\uF9D6"=>"\u6DEA",
"\uF9D7"=>"\u8F2A",
"\uF9D8"=>"\u5F8B",
"\uF9D9"=>"\u6144",
"\uF9DA"=>"\u6817",
"\uF9DB"=>"\u7387",
"\uF9DC"=>"\u9686",
"\uF9DD"=>"\u5229",
"\uF9DE"=>"\u540F",
"\uF9DF"=>"\u5C65",
"\uF9E0"=>"\u6613",
"\uF9E1"=>"\u674E",
"\uF9E2"=>"\u68A8",
"\uF9E3"=>"\u6CE5",
"\uF9E4"=>"\u7406",
"\uF9E5"=>"\u75E2",
"\uF9E6"=>"\u7F79",
"\uF9E7"=>"\u88CF",
"\uF9E8"=>"\u88E1",
"\uF9E9"=>"\u91CC",
"\uF9EA"=>"\u96E2",
"\uF9EB"=>"\u533F",
"\uF9EC"=>"\u6EBA",
"\uF9ED"=>"\u541D",
"\uF9EE"=>"\u71D0",
"\uF9EF"=>"\u7498",
"\uF9F0"=>"\u85FA",
"\uF9F1"=>"\u96A3",
"\uF9F2"=>"\u9C57",
"\uF9F3"=>"\u9E9F",
"\uF9F4"=>"\u6797",
"\uF9F5"=>"\u6DCB",
"\uF9F6"=>"\u81E8",
"\uF9F7"=>"\u7ACB",
"\uF9F8"=>"\u7B20",
"\uF9F9"=>"\u7C92",
"\uF9FA"=>"\u72C0",
"\uF9FB"=>"\u7099",
"\uF9FC"=>"\u8B58",
"\uF9FD"=>"\u4EC0",
"\uF9FE"=>"\u8336",
"\uF9FF"=>"\u523A",
"\uFA00"=>"\u5207",
"\uFA01"=>"\u5EA6",
"\uFA02"=>"\u62D3",
"\uFA03"=>"\u7CD6",
"\uFA04"=>"\u5B85",
"\uFA05"=>"\u6D1E",
"\uFA06"=>"\u66B4",
"\uFA07"=>"\u8F3B",
"\uFA08"=>"\u884C",
"\uFA09"=>"\u964D",
"\uFA0A"=>"\u898B",
"\uFA0B"=>"\u5ED3",
"\uFA0C"=>"\u5140",
"\uFA0D"=>"\u55C0",
"\uFA10"=>"\u585A",
"\uFA12"=>"\u6674",
"\uFA15"=>"\u51DE",
"\uFA16"=>"\u732A",
"\uFA17"=>"\u76CA",
"\uFA18"=>"\u793C",
"\uFA19"=>"\u795E",
"\uFA1A"=>"\u7965",
"\uFA1B"=>"\u798F",
"\uFA1C"=>"\u9756",
"\uFA1D"=>"\u7CBE",
"\uFA1E"=>"\u7FBD",
"\uFA20"=>"\u8612",
"\uFA22"=>"\u8AF8",
"\uFA25"=>"\u9038",
"\uFA26"=>"\u90FD",
"\uFA2A"=>"\u98EF",
"\uFA2B"=>"\u98FC",
"\uFA2C"=>"\u9928",
"\uFA2D"=>"\u9DB4",
"\uFA2E"=>"\u90DE",
"\uFA2F"=>"\u96B7",
"\uFA30"=>"\u4FAE",
"\uFA31"=>"\u50E7",
"\uFA32"=>"\u514D",
"\uFA33"=>"\u52C9",
"\uFA34"=>"\u52E4",
"\uFA35"=>"\u5351",
"\uFA36"=>"\u559D",
"\uFA37"=>"\u5606",
"\uFA38"=>"\u5668",
"\uFA39"=>"\u5840",
"\uFA3A"=>"\u58A8",
"\uFA3B"=>"\u5C64",
"\uFA3C"=>"\u5C6E",
"\uFA3D"=>"\u6094",
"\uFA3E"=>"\u6168",
"\uFA3F"=>"\u618E",
"\uFA40"=>"\u61F2",
"\uFA41"=>"\u654F",
"\uFA42"=>"\u65E2",
"\uFA43"=>"\u6691",
"\uFA44"=>"\u6885",
"\uFA45"=>"\u6D77",
"\uFA46"=>"\u6E1A",
"\uFA47"=>"\u6F22",
"\uFA48"=>"\u716E",
"\uFA49"=>"\u722B",
"\uFA4A"=>"\u7422",
"\uFA4B"=>"\u7891",
"\uFA4C"=>"\u793E",
"\uFA4D"=>"\u7949",
"\uFA4E"=>"\u7948",
"\uFA4F"=>"\u7950",
"\uFA50"=>"\u7956",
"\uFA51"=>"\u795D",
"\uFA52"=>"\u798D",
"\uFA53"=>"\u798E",
"\uFA54"=>"\u7A40",
"\uFA55"=>"\u7A81",
"\uFA56"=>"\u7BC0",
"\uFA57"=>"\u7DF4",
"\uFA58"=>"\u7E09",
"\uFA59"=>"\u7E41",
"\uFA5A"=>"\u7F72",
"\uFA5B"=>"\u8005",
"\uFA5C"=>"\u81ED",
"\uFA5D"=>"\u8279",
"\uFA5E"=>"\u8279",
"\uFA5F"=>"\u8457",
"\uFA60"=>"\u8910",
"\uFA61"=>"\u8996",
"\uFA62"=>"\u8B01",
"\uFA63"=>"\u8B39",
"\uFA64"=>"\u8CD3",
"\uFA65"=>"\u8D08",
"\uFA66"=>"\u8FB6",
"\uFA67"=>"\u9038",
"\uFA68"=>"\u96E3",
"\uFA69"=>"\u97FF",
"\uFA6A"=>"\u983B",
"\uFA6B"=>"\u6075",
"\uFA6C"=>"\u{242EE}",
"\uFA6D"=>"\u8218",
"\uFA70"=>"\u4E26",
"\uFA71"=>"\u51B5",
"\uFA72"=>"\u5168",
"\uFA73"=>"\u4F80",
"\uFA74"=>"\u5145",
"\uFA75"=>"\u5180",
"\uFA76"=>"\u52C7",
"\uFA77"=>"\u52FA",
"\uFA78"=>"\u559D",
"\uFA79"=>"\u5555",
"\uFA7A"=>"\u5599",
"\uFA7B"=>"\u55E2",
"\uFA7C"=>"\u585A",
"\uFA7D"=>"\u58B3",
"\uFA7E"=>"\u5944",
"\uFA7F"=>"\u5954",
"\uFA80"=>"\u5A62",
"\uFA81"=>"\u5B28",
"\uFA82"=>"\u5ED2",
"\uFA83"=>"\u5ED9",
"\uFA84"=>"\u5F69",
"\uFA85"=>"\u5FAD",
"\uFA86"=>"\u60D8",
"\uFA87"=>"\u614E",
"\uFA88"=>"\u6108",
"\uFA89"=>"\u618E",
"\uFA8A"=>"\u6160",
"\uFA8B"=>"\u61F2",
"\uFA8C"=>"\u6234",
"\uFA8D"=>"\u63C4",
"\uFA8E"=>"\u641C",
"\uFA8F"=>"\u6452",
"\uFA90"=>"\u6556",
"\uFA91"=>"\u6674",
"\uFA92"=>"\u6717",
"\uFA93"=>"\u671B",
"\uFA94"=>"\u6756",
"\uFA95"=>"\u6B79",
"\uFA96"=>"\u6BBA",
"\uFA97"=>"\u6D41",
"\uFA98"=>"\u6EDB",
"\uFA99"=>"\u6ECB",
"\uFA9A"=>"\u6F22",
"\uFA9B"=>"\u701E",
"\uFA9C"=>"\u716E",
"\uFA9D"=>"\u77A7",
"\uFA9E"=>"\u7235",
"\uFA9F"=>"\u72AF",
"\uFAA0"=>"\u732A",
"\uFAA1"=>"\u7471",
"\uFAA2"=>"\u7506",
"\uFAA3"=>"\u753B",
"\uFAA4"=>"\u761D",
"\uFAA5"=>"\u761F",
"\uFAA6"=>"\u76CA",
"\uFAA7"=>"\u76DB",
"\uFAA8"=>"\u76F4",
"\uFAA9"=>"\u774A",
"\uFAAA"=>"\u7740",
"\uFAAB"=>"\u78CC",
"\uFAAC"=>"\u7AB1",
"\uFAAD"=>"\u7BC0",
"\uFAAE"=>"\u7C7B",
"\uFAAF"=>"\u7D5B",
"\uFAB0"=>"\u7DF4",
"\uFAB1"=>"\u7F3E",
"\uFAB2"=>"\u8005",
"\uFAB3"=>"\u8352",
"\uFAB4"=>"\u83EF",
"\uFAB5"=>"\u8779",
"\uFAB6"=>"\u8941",
"\uFAB7"=>"\u8986",
"\uFAB8"=>"\u8996",
"\uFAB9"=>"\u8ABF",
"\uFABA"=>"\u8AF8",
"\uFABB"=>"\u8ACB",
"\uFABC"=>"\u8B01",
"\uFABD"=>"\u8AFE",
"\uFABE"=>"\u8AED",
"\uFABF"=>"\u8B39",
"\uFAC0"=>"\u8B8A",
"\uFAC1"=>"\u8D08",
"\uFAC2"=>"\u8F38",
"\uFAC3"=>"\u9072",
"\uFAC4"=>"\u9199",
"\uFAC5"=>"\u9276",
"\uFAC6"=>"\u967C",
"\uFAC7"=>"\u96E3",
"\uFAC8"=>"\u9756",
"\uFAC9"=>"\u97DB",
"\uFACA"=>"\u97FF",
"\uFACB"=>"\u980B",
"\uFACC"=>"\u983B",
"\uFACD"=>"\u9B12",
"\uFACE"=>"\u9F9C",
"\uFACF"=>"\u{2284A}",
"\uFAD0"=>"\u{22844}",
"\uFAD1"=>"\u{233D5}",
"\uFAD2"=>"\u3B9D",
"\uFAD3"=>"\u4018",
"\uFAD4"=>"\u4039",
"\uFAD5"=>"\u{25249}",
"\uFAD6"=>"\u{25CD0}",
"\uFAD7"=>"\u{27ED3}",
"\uFAD8"=>"\u9F43",
"\uFAD9"=>"\u9F8E",
"\uFB1D"=>"\u05D9\u05B4",
"\uFB1F"=>"\u05F2\u05B7",
"\uFB2A"=>"\u05E9\u05C1",
"\uFB2B"=>"\u05E9\u05C2",
"\uFB2C"=>"\u05E9\u05BC\u05C1",
"\uFB2D"=>"\u05E9\u05BC\u05C2",
"\uFB2E"=>"\u05D0\u05B7",
"\uFB2F"=>"\u05D0\u05B8",
"\uFB30"=>"\u05D0\u05BC",
"\uFB31"=>"\u05D1\u05BC",
"\uFB32"=>"\u05D2\u05BC",
"\uFB33"=>"\u05D3\u05BC",
"\uFB34"=>"\u05D4\u05BC",
"\uFB35"=>"\u05D5\u05BC",
"\uFB36"=>"\u05D6\u05BC",
"\uFB38"=>"\u05D8\u05BC",
"\uFB39"=>"\u05D9\u05BC",
"\uFB3A"=>"\u05DA\u05BC",
"\uFB3B"=>"\u05DB\u05BC",
"\uFB3C"=>"\u05DC\u05BC",
"\uFB3E"=>"\u05DE\u05BC",
"\uFB40"=>"\u05E0\u05BC",
"\uFB41"=>"\u05E1\u05BC",
"\uFB43"=>"\u05E3\u05BC",
"\uFB44"=>"\u05E4\u05BC",
"\uFB46"=>"\u05E6\u05BC",
"\uFB47"=>"\u05E7\u05BC",
"\uFB48"=>"\u05E8\u05BC",
"\uFB49"=>"\u05E9\u05BC",
"\uFB4A"=>"\u05EA\u05BC",
"\uFB4B"=>"\u05D5\u05B9",
"\uFB4C"=>"\u05D1\u05BF",
"\uFB4D"=>"\u05DB\u05BF",
"\uFB4E"=>"\u05E4\u05BF",
"\u{1109A}"=>"\u{11099}\u{110BA}",
"\u{1109C}"=>"\u{1109B}\u{110BA}",
"\u{110AB}"=>"\u{110A5}\u{110BA}",
"\u{1112E}"=>"\u{11131}\u{11127}",
"\u{1112F}"=>"\u{11132}\u{11127}",
"\u{1134B}"=>"\u{11347}\u{1133E}",
"\u{1134C}"=>"\u{11347}\u{11357}",
"\u{114BB}"=>"\u{114B9}\u{114BA}",
"\u{114BC}"=>"\u{114B9}\u{114B0}",
"\u{114BE}"=>"\u{114B9}\u{114BD}",
"\u{115BA}"=>"\u{115B8}\u{115AF}",
"\u{115BB}"=>"\u{115B9}\u{115AF}",
"\u{11938}"=>"\u{11935}\u{11930}",
"\u{1D15E}"=>"\u{1D157}\u{1D165}",
"\u{1D15F}"=>"\u{1D158}\u{1D165}",
"\u{1D160}"=>"\u{1D158}\u{1D165}\u{1D16E}",
"\u{1D161}"=>"\u{1D158}\u{1D165}\u{1D16F}",
"\u{1D162}"=>"\u{1D158}\u{1D165}\u{1D170}",
"\u{1D163}"=>"\u{1D158}\u{1D165}\u{1D171}",
"\u{1D164}"=>"\u{1D158}\u{1D165}\u{1D172}",
"\u{1D1BB}"=>"\u{1D1B9}\u{1D165}",
"\u{1D1BC}"=>"\u{1D1BA}\u{1D165}",
"\u{1D1BD}"=>"\u{1D1B9}\u{1D165}\u{1D16E}",
"\u{1D1BE}"=>"\u{1D1BA}\u{1D165}\u{1D16E}",
"\u{1D1BF}"=>"\u{1D1B9}\u{1D165}\u{1D16F}",
"\u{1D1C0}"=>"\u{1D1BA}\u{1D165}\u{1D16F}",
"\u{2F800}"=>"\u4E3D",
"\u{2F801}"=>"\u4E38",
"\u{2F802}"=>"\u4E41",
"\u{2F803}"=>"\u{20122}",
"\u{2F804}"=>"\u4F60",
"\u{2F805}"=>"\u4FAE",
"\u{2F806}"=>"\u4FBB",
"\u{2F807}"=>"\u5002",
"\u{2F808}"=>"\u507A",
"\u{2F809}"=>"\u5099",
"\u{2F80A}"=>"\u50E7",
"\u{2F80B}"=>"\u50CF",
"\u{2F80C}"=>"\u349E",
"\u{2F80D}"=>"\u{2063A}",
"\u{2F80E}"=>"\u514D",
"\u{2F80F}"=>"\u5154",
"\u{2F810}"=>"\u5164",
"\u{2F811}"=>"\u5177",
"\u{2F812}"=>"\u{2051C}",
"\u{2F813}"=>"\u34B9",
"\u{2F814}"=>"\u5167",
"\u{2F815}"=>"\u518D",
"\u{2F816}"=>"\u{2054B}",
"\u{2F817}"=>"\u5197",
"\u{2F818}"=>"\u51A4",
"\u{2F819}"=>"\u4ECC",
"\u{2F81A}"=>"\u51AC",
"\u{2F81B}"=>"\u51B5",
"\u{2F81C}"=>"\u{291DF}",
"\u{2F81D}"=>"\u51F5",
"\u{2F81E}"=>"\u5203",
"\u{2F81F}"=>"\u34DF",
"\u{2F820}"=>"\u523B",
"\u{2F821}"=>"\u5246",
"\u{2F822}"=>"\u5272",
"\u{2F823}"=>"\u5277",
"\u{2F824}"=>"\u3515",
"\u{2F825}"=>"\u52C7",
"\u{2F826}"=>"\u52C9",
"\u{2F827}"=>"\u52E4",
"\u{2F828}"=>"\u52FA",
"\u{2F829}"=>"\u5305",
"\u{2F82A}"=>"\u5306",
"\u{2F82B}"=>"\u5317",
"\u{2F82C}"=>"\u5349",
"\u{2F82D}"=>"\u5351",
"\u{2F82E}"=>"\u535A",
"\u{2F82F}"=>"\u5373",
"\u{2F830}"=>"\u537D",
"\u{2F831}"=>"\u537F",
"\u{2F832}"=>"\u537F",
"\u{2F833}"=>"\u537F",
"\u{2F834}"=>"\u{20A2C}",
"\u{2F835}"=>"\u7070",
"\u{2F836}"=>"\u53CA",
"\u{2F837}"=>"\u53DF",
"\u{2F838}"=>"\u{20B63}",
"\u{2F839}"=>"\u53EB",
"\u{2F83A}"=>"\u53F1",
"\u{2F83B}"=>"\u5406",
"\u{2F83C}"=>"\u549E",
"\u{2F83D}"=>"\u5438",
"\u{2F83E}"=>"\u5448",
"\u{2F83F}"=>"\u5468",
"\u{2F840}"=>"\u54A2",
"\u{2F841}"=>"\u54F6",
"\u{2F842}"=>"\u5510",
"\u{2F843}"=>"\u5553",
"\u{2F844}"=>"\u5563",
"\u{2F845}"=>"\u5584",
"\u{2F846}"=>"\u5584",
"\u{2F847}"=>"\u5599",
"\u{2F848}"=>"\u55AB",
"\u{2F849}"=>"\u55B3",
"\u{2F84A}"=>"\u55C2",
"\u{2F84B}"=>"\u5716",
"\u{2F84C}"=>"\u5606",
"\u{2F84D}"=>"\u5717",
"\u{2F84E}"=>"\u5651",
"\u{2F84F}"=>"\u5674",
"\u{2F850}"=>"\u5207",
"\u{2F851}"=>"\u58EE",
"\u{2F852}"=>"\u57CE",
"\u{2F853}"=>"\u57F4",
"\u{2F854}"=>"\u580D",
"\u{2F855}"=>"\u578B",
"\u{2F856}"=>"\u5832",
"\u{2F857}"=>"\u5831",
"\u{2F858}"=>"\u58AC",
"\u{2F859}"=>"\u{214E4}",
"\u{2F85A}"=>"\u58F2",
"\u{2F85B}"=>"\u58F7",
"\u{2F85C}"=>"\u5906",
"\u{2F85D}"=>"\u591A",
"\u{2F85E}"=>"\u5922",
"\u{2F85F}"=>"\u5962",
"\u{2F860}"=>"\u{216A8}",
"\u{2F861}"=>"\u{216EA}",
"\u{2F862}"=>"\u59EC",
"\u{2F863}"=>"\u5A1B",
"\u{2F864}"=>"\u5A27",
"\u{2F865}"=>"\u59D8",
"\u{2F866}"=>"\u5A66",
"\u{2F867}"=>"\u36EE",
"\u{2F868}"=>"\u36FC",
"\u{2F869}"=>"\u5B08",
"\u{2F86A}"=>"\u5B3E",
"\u{2F86B}"=>"\u5B3E",
"\u{2F86C}"=>"\u{219C8}",
"\u{2F86D}"=>"\u5BC3",
"\u{2F86E}"=>"\u5BD8",
"\u{2F86F}"=>"\u5BE7",
"\u{2F870}"=>"\u5BF3",
"\u{2F871}"=>"\u{21B18}",
"\u{2F872}"=>"\u5BFF",
"\u{2F873}"=>"\u5C06",
"\u{2F874}"=>"\u5F53",
"\u{2F875}"=>"\u5C22",
"\u{2F876}"=>"\u3781",
"\u{2F877}"=>"\u5C60",
"\u{2F878}"=>"\u5C6E",
"\u{2F879}"=>"\u5CC0",
"\u{2F87A}"=>"\u5C8D",
"\u{2F87B}"=>"\u{21DE4}",
"\u{2F87C}"=>"\u5D43",
"\u{2F87D}"=>"\u{21DE6}",
"\u{2F87E}"=>"\u5D6E",
"\u{2F87F}"=>"\u5D6B",
"\u{2F880}"=>"\u5D7C",
"\u{2F881}"=>"\u5DE1",
"\u{2F882}"=>"\u5DE2",
"\u{2F883}"=>"\u382F",
"\u{2F884}"=>"\u5DFD",
"\u{2F885}"=>"\u5E28",
"\u{2F886}"=>"\u5E3D",
"\u{2F887}"=>"\u5E69",
"\u{2F888}"=>"\u3862",
"\u{2F889}"=>"\u{22183}",
"\u{2F88A}"=>"\u387C",
"\u{2F88B}"=>"\u5EB0",
"\u{2F88C}"=>"\u5EB3",
"\u{2F88D}"=>"\u5EB6",
"\u{2F88E}"=>"\u5ECA",
"\u{2F88F}"=>"\u{2A392}",
"\u{2F890}"=>"\u5EFE",
"\u{2F891}"=>"\u{22331}",
"\u{2F892}"=>"\u{22331}",
"\u{2F893}"=>"\u8201",
"\u{2F894}"=>"\u5F22",
"\u{2F895}"=>"\u5F22",
"\u{2F896}"=>"\u38C7",
"\u{2F897}"=>"\u{232B8}",
"\u{2F898}"=>"\u{261DA}",
"\u{2F899}"=>"\u5F62",
"\u{2F89A}"=>"\u5F6B",
"\u{2F89B}"=>"\u38E3",
"\u{2F89C}"=>"\u5F9A",
"\u{2F89D}"=>"\u5FCD",
"\u{2F89E}"=>"\u5FD7",
"\u{2F89F}"=>"\u5FF9",
"\u{2F8A0}"=>"\u6081",
"\u{2F8A1}"=>"\u393A",
"\u{2F8A2}"=>"\u391C",
"\u{2F8A3}"=>"\u6094",
"\u{2F8A4}"=>"\u{226D4}",
"\u{2F8A5}"=>"\u60C7",
"\u{2F8A6}"=>"\u6148",
"\u{2F8A7}"=>"\u614C",
"\u{2F8A8}"=>"\u614E",
"\u{2F8A9}"=>"\u614C",
"\u{2F8AA}"=>"\u617A",
"\u{2F8AB}"=>"\u618E",
"\u{2F8AC}"=>"\u61B2",
"\u{2F8AD}"=>"\u61A4",
"\u{2F8AE}"=>"\u61AF",
"\u{2F8AF}"=>"\u61DE",
"\u{2F8B0}"=>"\u61F2",
"\u{2F8B1}"=>"\u61F6",
"\u{2F8B2}"=>"\u6210",
"\u{2F8B3}"=>"\u621B",
"\u{2F8B4}"=>"\u625D",
"\u{2F8B5}"=>"\u62B1",
"\u{2F8B6}"=>"\u62D4",
"\u{2F8B7}"=>"\u6350",
"\u{2F8B8}"=>"\u{22B0C}",
"\u{2F8B9}"=>"\u633D",
"\u{2F8BA}"=>"\u62FC",
"\u{2F8BB}"=>"\u6368",
"\u{2F8BC}"=>"\u6383",
"\u{2F8BD}"=>"\u63E4",
"\u{2F8BE}"=>"\u{22BF1}",
"\u{2F8BF}"=>"\u6422",
"\u{2F8C0}"=>"\u63C5",
"\u{2F8C1}"=>"\u63A9",
"\u{2F8C2}"=>"\u3A2E",
"\u{2F8C3}"=>"\u6469",
"\u{2F8C4}"=>"\u647E",
"\u{2F8C5}"=>"\u649D",
"\u{2F8C6}"=>"\u6477",
"\u{2F8C7}"=>"\u3A6C",
"\u{2F8C8}"=>"\u654F",
"\u{2F8C9}"=>"\u656C",
"\u{2F8CA}"=>"\u{2300A}",
"\u{2F8CB}"=>"\u65E3",
"\u{2F8CC}"=>"\u66F8",
"\u{2F8CD}"=>"\u6649",
"\u{2F8CE}"=>"\u3B19",
"\u{2F8CF}"=>"\u6691",
"\u{2F8D0}"=>"\u3B08",
"\u{2F8D1}"=>"\u3AE4",
"\u{2F8D2}"=>"\u5192",
"\u{2F8D3}"=>"\u5195",
"\u{2F8D4}"=>"\u6700",
"\u{2F8D5}"=>"\u669C",
"\u{2F8D6}"=>"\u80AD",
"\u{2F8D7}"=>"\u43D9",
"\u{2F8D8}"=>"\u6717",
"\u{2F8D9}"=>"\u671B",
"\u{2F8DA}"=>"\u6721",
"\u{2F8DB}"=>"\u675E",
"\u{2F8DC}"=>"\u6753",
"\u{2F8DD}"=>"\u{233C3}",
"\u{2F8DE}"=>"\u3B49",
"\u{2F8DF}"=>"\u67FA",
"\u{2F8E0}"=>"\u6785",
"\u{2F8E1}"=>"\u6852",
"\u{2F8E2}"=>"\u6885",
"\u{2F8E3}"=>"\u{2346D}",
"\u{2F8E4}"=>"\u688E",
"\u{2F8E5}"=>"\u681F",
"\u{2F8E6}"=>"\u6914",
"\u{2F8E7}"=>"\u3B9D",
"\u{2F8E8}"=>"\u6942",
"\u{2F8E9}"=>"\u69A3",
"\u{2F8EA}"=>"\u69EA",
"\u{2F8EB}"=>"\u6AA8",
"\u{2F8EC}"=>"\u{236A3}",
"\u{2F8ED}"=>"\u6ADB",
"\u{2F8EE}"=>"\u3C18",
"\u{2F8EF}"=>"\u6B21",
"\u{2F8F0}"=>"\u{238A7}",
"\u{2F8F1}"=>"\u6B54",
"\u{2F8F2}"=>"\u3C4E",
"\u{2F8F3}"=>"\u6B72",
"\u{2F8F4}"=>"\u6B9F",
"\u{2F8F5}"=>"\u6BBA",
"\u{2F8F6}"=>"\u6BBB",
"\u{2F8F7}"=>"\u{23A8D}",
"\u{2F8F8}"=>"\u{21D0B}",
"\u{2F8F9}"=>"\u{23AFA}",
"\u{2F8FA}"=>"\u6C4E",
"\u{2F8FB}"=>"\u{23CBC}",
"\u{2F8FC}"=>"\u6CBF",
"\u{2F8FD}"=>"\u6CCD",
"\u{2F8FE}"=>"\u6C67",
"\u{2F8FF}"=>"\u6D16",
"\u{2F900}"=>"\u6D3E",
"\u{2F901}"=>"\u6D77",
"\u{2F902}"=>"\u6D41",
"\u{2F903}"=>"\u6D69",
"\u{2F904}"=>"\u6D78",
"\u{2F905}"=>"\u6D85",
"\u{2F906}"=>"\u{23D1E}",
"\u{2F907}"=>"\u6D34",
"\u{2F908}"=>"\u6E2F",
"\u{2F909}"=>"\u6E6E",
"\u{2F90A}"=>"\u3D33",
"\u{2F90B}"=>"\u6ECB",
"\u{2F90C}"=>"\u6EC7",
"\u{2F90D}"=>"\u{23ED1}",
"\u{2F90E}"=>"\u6DF9",
"\u{2F90F}"=>"\u6F6E",
"\u{2F910}"=>"\u{23F5E}",
"\u{2F911}"=>"\u{23F8E}",
"\u{2F912}"=>"\u6FC6",
"\u{2F913}"=>"\u7039",
"\u{2F914}"=>"\u701E",
"\u{2F915}"=>"\u701B",
"\u{2F916}"=>"\u3D96",
"\u{2F917}"=>"\u704A",
"\u{2F918}"=>"\u707D",
"\u{2F919}"=>"\u7077",
"\u{2F91A}"=>"\u70AD",
"\u{2F91B}"=>"\u{20525}",
"\u{2F91C}"=>"\u7145",
"\u{2F91D}"=>"\u{24263}",
"\u{2F91E}"=>"\u719C",
"\u{2F91F}"=>"\u{243AB}",
"\u{2F920}"=>"\u7228",
"\u{2F921}"=>"\u7235",
"\u{2F922}"=>"\u7250",
"\u{2F923}"=>"\u{24608}",
"\u{2F924}"=>"\u7280",
"\u{2F925}"=>"\u7295",
"\u{2F926}"=>"\u{24735}",
"\u{2F927}"=>"\u{24814}",
"\u{2F928}"=>"\u737A",
"\u{2F929}"=>"\u738B",
"\u{2F92A}"=>"\u3EAC",
"\u{2F92B}"=>"\u73A5",
"\u{2F92C}"=>"\u3EB8",
"\u{2F92D}"=>"\u3EB8",
"\u{2F92E}"=>"\u7447",
"\u{2F92F}"=>"\u745C",
"\u{2F930}"=>"\u7471",
"\u{2F931}"=>"\u7485",
"\u{2F932}"=>"\u74CA",
"\u{2F933}"=>"\u3F1B",
"\u{2F934}"=>"\u7524",
"\u{2F935}"=>"\u{24C36}",
"\u{2F936}"=>"\u753E",
"\u{2F937}"=>"\u{24C92}",
"\u{2F938}"=>"\u7570",
"\u{2F939}"=>"\u{2219F}",
"\u{2F93A}"=>"\u7610",
"\u{2F93B}"=>"\u{24FA1}",
"\u{2F93C}"=>"\u{24FB8}",
"\u{2F93D}"=>"\u{25044}",
"\u{2F93E}"=>"\u3FFC",
"\u{2F93F}"=>"\u4008",
"\u{2F940}"=>"\u76F4",
"\u{2F941}"=>"\u{250F3}",
"\u{2F942}"=>"\u{250F2}",
"\u{2F943}"=>"\u{25119}",
"\u{2F944}"=>"\u{25133}",
"\u{2F945}"=>"\u771E",
"\u{2F946}"=>"\u771F",
"\u{2F947}"=>"\u771F",
"\u{2F948}"=>"\u774A",
"\u{2F949}"=>"\u4039",
"\u{2F94A}"=>"\u778B",
"\u{2F94B}"=>"\u4046",
"\u{2F94C}"=>"\u4096",
"\u{2F94D}"=>"\u{2541D}",
"\u{2F94E}"=>"\u784E",
"\u{2F94F}"=>"\u788C",
"\u{2F950}"=>"\u78CC",
"\u{2F951}"=>"\u40E3",
"\u{2F952}"=>"\u{25626}",
"\u{2F953}"=>"\u7956",
"\u{2F954}"=>"\u{2569A}",
"\u{2F955}"=>"\u{256C5}",
"\u{2F956}"=>"\u798F",
"\u{2F957}"=>"\u79EB",
"\u{2F958}"=>"\u412F",
"\u{2F959}"=>"\u7A40",
"\u{2F95A}"=>"\u7A4A",
"\u{2F95B}"=>"\u7A4F",
"\u{2F95C}"=>"\u{2597C}",
"\u{2F95D}"=>"\u{25AA7}",
"\u{2F95E}"=>"\u{25AA7}",
"\u{2F95F}"=>"\u7AEE",
"\u{2F960}"=>"\u4202",
"\u{2F961}"=>"\u{25BAB}",
"\u{2F962}"=>"\u7BC6",
"\u{2F963}"=>"\u7BC9",
"\u{2F964}"=>"\u4227",
"\u{2F965}"=>"\u{25C80}",
"\u{2F966}"=>"\u7CD2",
"\u{2F967}"=>"\u42A0",
"\u{2F968}"=>"\u7CE8",
"\u{2F969}"=>"\u7CE3",
"\u{2F96A}"=>"\u7D00",
"\u{2F96B}"=>"\u{25F86}",
"\u{2F96C}"=>"\u7D63",
"\u{2F96D}"=>"\u4301",
"\u{2F96E}"=>"\u7DC7",
"\u{2F96F}"=>"\u7E02",
"\u{2F970}"=>"\u7E45",
"\u{2F971}"=>"\u4334",
"\u{2F972}"=>"\u{26228}",
"\u{2F973}"=>"\u{26247}",
"\u{2F974}"=>"\u4359",
"\u{2F975}"=>"\u{262D9}",
"\u{2F976}"=>"\u7F7A",
"\u{2F977}"=>"\u{2633E}",
"\u{2F978}"=>"\u7F95",
"\u{2F979}"=>"\u7FFA",
"\u{2F97A}"=>"\u8005",
"\u{2F97B}"=>"\u{264DA}",
"\u{2F97C}"=>"\u{26523}",
"\u{2F97D}"=>"\u8060",
"\u{2F97E}"=>"\u{265A8}",
"\u{2F97F}"=>"\u8070",
"\u{2F980}"=>"\u{2335F}",
"\u{2F981}"=>"\u43D5",
"\u{2F982}"=>"\u80B2",
"\u{2F983}"=>"\u8103",
"\u{2F984}"=>"\u440B",
"\u{2F985}"=>"\u813E",
"\u{2F986}"=>"\u5AB5",
"\u{2F987}"=>"\u{267A7}",
"\u{2F988}"=>"\u{267B5}",
"\u{2F989}"=>"\u{23393}",
"\u{2F98A}"=>"\u{2339C}",
"\u{2F98B}"=>"\u8201",
"\u{2F98C}"=>"\u8204",
"\u{2F98D}"=>"\u8F9E",
"\u{2F98E}"=>"\u446B",
"\u{2F98F}"=>"\u8291",
"\u{2F990}"=>"\u828B",
"\u{2F991}"=>"\u829D",
"\u{2F992}"=>"\u52B3",
"\u{2F993}"=>"\u82B1",
"\u{2F994}"=>"\u82B3",
"\u{2F995}"=>"\u82BD",
"\u{2F996}"=>"\u82E6",
"\u{2F997}"=>"\u{26B3C}",
"\u{2F998}"=>"\u82E5",
"\u{2F999}"=>"\u831D",
"\u{2F99A}"=>"\u8363",
"\u{2F99B}"=>"\u83AD",
"\u{2F99C}"=>"\u8323",
"\u{2F99D}"=>"\u83BD",
"\u{2F99E}"=>"\u83E7",
"\u{2F99F}"=>"\u8457",
"\u{2F9A0}"=>"\u8353",
"\u{2F9A1}"=>"\u83CA",
"\u{2F9A2}"=>"\u83CC",
"\u{2F9A3}"=>"\u83DC",
"\u{2F9A4}"=>"\u{26C36}",
"\u{2F9A5}"=>"\u{26D6B}",
"\u{2F9A6}"=>"\u{26CD5}",
"\u{2F9A7}"=>"\u452B",
"\u{2F9A8}"=>"\u84F1",
"\u{2F9A9}"=>"\u84F3",
"\u{2F9AA}"=>"\u8516",
"\u{2F9AB}"=>"\u{273CA}",
"\u{2F9AC}"=>"\u8564",
"\u{2F9AD}"=>"\u{26F2C}",
"\u{2F9AE}"=>"\u455D",
"\u{2F9AF}"=>"\u4561",
"\u{2F9B0}"=>"\u{26FB1}",
"\u{2F9B1}"=>"\u{270D2}",
"\u{2F9B2}"=>"\u456B",
"\u{2F9B3}"=>"\u8650",
"\u{2F9B4}"=>"\u865C",
"\u{2F9B5}"=>"\u8667",
"\u{2F9B6}"=>"\u8669",
"\u{2F9B7}"=>"\u86A9",
"\u{2F9B8}"=>"\u8688",
"\u{2F9B9}"=>"\u870E",
"\u{2F9BA}"=>"\u86E2",
"\u{2F9BB}"=>"\u8779",
"\u{2F9BC}"=>"\u8728",
"\u{2F9BD}"=>"\u876B",
"\u{2F9BE}"=>"\u8786",
"\u{2F9BF}"=>"\u45D7",
"\u{2F9C0}"=>"\u87E1",
"\u{2F9C1}"=>"\u8801",
"\u{2F9C2}"=>"\u45F9",
"\u{2F9C3}"=>"\u8860",
"\u{2F9C4}"=>"\u8863",
"\u{2F9C5}"=>"\u{27667}",
"\u{2F9C6}"=>"\u88D7",
"\u{2F9C7}"=>"\u88DE",
"\u{2F9C8}"=>"\u4635",
"\u{2F9C9}"=>"\u88FA",
"\u{2F9CA}"=>"\u34BB",
"\u{2F9CB}"=>"\u{278AE}",
"\u{2F9CC}"=>"\u{27966}",
"\u{2F9CD}"=>"\u46BE",
"\u{2F9CE}"=>"\u46C7",
"\u{2F9CF}"=>"\u8AA0",
"\u{2F9D0}"=>"\u8AED",
"\u{2F9D1}"=>"\u8B8A",
"\u{2F9D2}"=>"\u8C55",
"\u{2F9D3}"=>"\u{27CA8}",
"\u{2F9D4}"=>"\u8CAB",
"\u{2F9D5}"=>"\u8CC1",
"\u{2F9D6}"=>"\u8D1B",
"\u{2F9D7}"=>"\u8D77",
"\u{2F9D8}"=>"\u{27F2F}",
"\u{2F9D9}"=>"\u{20804}",
"\u{2F9DA}"=>"\u8DCB",
"\u{2F9DB}"=>"\u8DBC",
"\u{2F9DC}"=>"\u8DF0",
"\u{2F9DD}"=>"\u{208DE}",
"\u{2F9DE}"=>"\u8ED4",
"\u{2F9DF}"=>"\u8F38",
"\u{2F9E0}"=>"\u{285D2}",
"\u{2F9E1}"=>"\u{285ED}",
"\u{2F9E2}"=>"\u9094",
"\u{2F9E3}"=>"\u90F1",
"\u{2F9E4}"=>"\u9111",
"\u{2F9E5}"=>"\u{2872E}",
"\u{2F9E6}"=>"\u911B",
"\u{2F9E7}"=>"\u9238",
"\u{2F9E8}"=>"\u92D7",
"\u{2F9E9}"=>"\u92D8",
"\u{2F9EA}"=>"\u927C",
"\u{2F9EB}"=>"\u93F9",
"\u{2F9EC}"=>"\u9415",
"\u{2F9ED}"=>"\u{28BFA}",
"\u{2F9EE}"=>"\u958B",
"\u{2F9EF}"=>"\u4995",
"\u{2F9F0}"=>"\u95B7",
"\u{2F9F1}"=>"\u{28D77}",
"\u{2F9F2}"=>"\u49E6",
"\u{2F9F3}"=>"\u96C3",
"\u{2F9F4}"=>"\u5DB2",
"\u{2F9F5}"=>"\u9723",
"\u{2F9F6}"=>"\u{29145}",
"\u{2F9F7}"=>"\u{2921A}",
"\u{2F9F8}"=>"\u4A6E",
"\u{2F9F9}"=>"\u4A76",
"\u{2F9FA}"=>"\u97E0",
"\u{2F9FB}"=>"\u{2940A}",
"\u{2F9FC}"=>"\u4AB2",
"\u{2F9FD}"=>"\u{29496}",
"\u{2F9FE}"=>"\u980B",
"\u{2F9FF}"=>"\u980B",
"\u{2FA00}"=>"\u9829",
"\u{2FA01}"=>"\u{295B6}",
"\u{2FA02}"=>"\u98E2",
"\u{2FA03}"=>"\u4B33",
"\u{2FA04}"=>"\u9929",
"\u{2FA05}"=>"\u99A7",
"\u{2FA06}"=>"\u99C2",
"\u{2FA07}"=>"\u99FE",
"\u{2FA08}"=>"\u4BCE",
"\u{2FA09}"=>"\u{29B30}",
"\u{2FA0A}"=>"\u9B12",
"\u{2FA0B}"=>"\u9C40",
"\u{2FA0C}"=>"\u9CFD",
"\u{2FA0D}"=>"\u4CCE",
"\u{2FA0E}"=>"\u4CED",
"\u{2FA0F}"=>"\u9D67",
"\u{2FA10}"=>"\u{2A0CE}",
"\u{2FA11}"=>"\u4CF8",
"\u{2FA12}"=>"\u{2A105}",
"\u{2FA13}"=>"\u{2A20E}",
"\u{2FA14}"=>"\u{2A291}",
"\u{2FA15}"=>"\u9EBB",
"\u{2FA16}"=>"\u4D56",
"\u{2FA17}"=>"\u9EF9",
"\u{2FA18}"=>"\u9EFE",
"\u{2FA19}"=>"\u9F05",
"\u{2FA1A}"=>"\u9F0F",
"\u{2FA1B}"=>"\u9F16",
"\u{2FA1C}"=>"\u9F3B",
"\u{2FA1D}"=>"\u{2A600}",
}.freeze
KOMPATIBLE_TABLE = {
"\u00A0"=>" ",
"\u00A8"=>" \u0308",
"\u00AA"=>"a",
"\u00AF"=>" \u0304",
"\u00B2"=>"2",
"\u00B3"=>"3",
"\u00B4"=>" \u0301",
"\u00B5"=>"\u03BC",
"\u00B8"=>" \u0327",
"\u00B9"=>"1",
"\u00BA"=>"o",
"\u00BC"=>"1\u20444",
"\u00BD"=>"1\u20442",
"\u00BE"=>"3\u20444",
"\u0132"=>"IJ",
"\u0133"=>"ij",
"\u013F"=>"L\u00B7",
"\u0140"=>"l\u00B7",
"\u0149"=>"\u02BCn",
"\u017F"=>"s",
"\u01C4"=>"D\u017D",
"\u01C5"=>"D\u017E",
"\u01C6"=>"d\u017E",
"\u01C7"=>"LJ",
"\u01C8"=>"Lj",
"\u01C9"=>"lj",
"\u01CA"=>"NJ",
"\u01CB"=>"Nj",
"\u01CC"=>"nj",
"\u01F1"=>"DZ",
"\u01F2"=>"Dz",
"\u01F3"=>"dz",
"\u02B0"=>"h",
"\u02B1"=>"\u0266",
"\u02B2"=>"j",
"\u02B3"=>"r",
"\u02B4"=>"\u0279",
"\u02B5"=>"\u027B",
"\u02B6"=>"\u0281",
"\u02B7"=>"w",
"\u02B8"=>"y",
"\u02D8"=>" \u0306",
"\u02D9"=>" \u0307",
"\u02DA"=>" \u030A",
"\u02DB"=>" \u0328",
"\u02DC"=>" \u0303",
"\u02DD"=>" \u030B",
"\u02E0"=>"\u0263",
"\u02E1"=>"l",
"\u02E2"=>"s",
"\u02E3"=>"x",
"\u02E4"=>"\u0295",
"\u037A"=>" \u0345",
"\u0384"=>" \u0301",
"\u03D0"=>"\u03B2",
"\u03D1"=>"\u03B8",
"\u03D2"=>"\u03A5",
"\u03D5"=>"\u03C6",
"\u03D6"=>"\u03C0",
"\u03F0"=>"\u03BA",
"\u03F1"=>"\u03C1",
"\u03F2"=>"\u03C2",
"\u03F4"=>"\u0398",
"\u03F5"=>"\u03B5",
"\u03F9"=>"\u03A3",
"\u0587"=>"\u0565\u0582",
"\u0675"=>"\u0627\u0674",
"\u0676"=>"\u0648\u0674",
"\u0677"=>"\u06C7\u0674",
"\u0678"=>"\u064A\u0674",
"\u0E33"=>"\u0E4D\u0E32",
"\u0EB3"=>"\u0ECD\u0EB2",
"\u0EDC"=>"\u0EAB\u0E99",
"\u0EDD"=>"\u0EAB\u0EA1",
"\u0F0C"=>"\u0F0B",
"\u0F77"=>"\u0FB2\u0F81",
"\u0F79"=>"\u0FB3\u0F81",
"\u10FC"=>"\u10DC",
"\u1D2C"=>"A",
"\u1D2D"=>"\u00C6",
"\u1D2E"=>"B",
"\u1D30"=>"D",
"\u1D31"=>"E",
"\u1D32"=>"\u018E",
"\u1D33"=>"G",
"\u1D34"=>"H",
"\u1D35"=>"I",
"\u1D36"=>"J",
"\u1D37"=>"K",
"\u1D38"=>"L",
"\u1D39"=>"M",
"\u1D3A"=>"N",
"\u1D3C"=>"O",
"\u1D3D"=>"\u0222",
"\u1D3E"=>"P",
"\u1D3F"=>"R",
"\u1D40"=>"T",
"\u1D41"=>"U",
"\u1D42"=>"W",
"\u1D43"=>"a",
"\u1D44"=>"\u0250",
"\u1D45"=>"\u0251",
"\u1D46"=>"\u1D02",
"\u1D47"=>"b",
"\u1D48"=>"d",
"\u1D49"=>"e",
"\u1D4A"=>"\u0259",
"\u1D4B"=>"\u025B",
"\u1D4C"=>"\u025C",
"\u1D4D"=>"g",
"\u1D4F"=>"k",
"\u1D50"=>"m",
"\u1D51"=>"\u014B",
"\u1D52"=>"o",
"\u1D53"=>"\u0254",
"\u1D54"=>"\u1D16",
"\u1D55"=>"\u1D17",
"\u1D56"=>"p",
"\u1D57"=>"t",
"\u1D58"=>"u",
"\u1D59"=>"\u1D1D",
"\u1D5A"=>"\u026F",
"\u1D5B"=>"v",
"\u1D5C"=>"\u1D25",
"\u1D5D"=>"\u03B2",
"\u1D5E"=>"\u03B3",
"\u1D5F"=>"\u03B4",
"\u1D60"=>"\u03C6",
"\u1D61"=>"\u03C7",
"\u1D62"=>"i",
"\u1D63"=>"r",
"\u1D64"=>"u",
"\u1D65"=>"v",
"\u1D66"=>"\u03B2",
"\u1D67"=>"\u03B3",
"\u1D68"=>"\u03C1",
"\u1D69"=>"\u03C6",
"\u1D6A"=>"\u03C7",
"\u1D78"=>"\u043D",
"\u1D9B"=>"\u0252",
"\u1D9C"=>"c",
"\u1D9D"=>"\u0255",
"\u1D9E"=>"\u00F0",
"\u1D9F"=>"\u025C",
"\u1DA0"=>"f",
"\u1DA1"=>"\u025F",
"\u1DA2"=>"\u0261",
"\u1DA3"=>"\u0265",
"\u1DA4"=>"\u0268",
"\u1DA5"=>"\u0269",
"\u1DA6"=>"\u026A",
"\u1DA7"=>"\u1D7B",
"\u1DA8"=>"\u029D",
"\u1DA9"=>"\u026D",
"\u1DAA"=>"\u1D85",
"\u1DAB"=>"\u029F",
"\u1DAC"=>"\u0271",
"\u1DAD"=>"\u0270",
"\u1DAE"=>"\u0272",
"\u1DAF"=>"\u0273",
"\u1DB0"=>"\u0274",
"\u1DB1"=>"\u0275",
"\u1DB2"=>"\u0278",
"\u1DB3"=>"\u0282",
"\u1DB4"=>"\u0283",
"\u1DB5"=>"\u01AB",
"\u1DB6"=>"\u0289",
"\u1DB7"=>"\u028A",
"\u1DB8"=>"\u1D1C",
"\u1DB9"=>"\u028B",
"\u1DBA"=>"\u028C",
"\u1DBB"=>"z",
"\u1DBC"=>"\u0290",
"\u1DBD"=>"\u0291",
"\u1DBE"=>"\u0292",
"\u1DBF"=>"\u03B8",
"\u1E9A"=>"a\u02BE",
"\u1FBD"=>" \u0313",
"\u1FBF"=>" \u0313",
"\u1FC0"=>" \u0342",
"\u1FFE"=>" \u0314",
"\u2002"=>" ",
"\u2003"=>" ",
"\u2004"=>" ",
"\u2005"=>" ",
"\u2006"=>" ",
"\u2007"=>" ",
"\u2008"=>" ",
"\u2009"=>" ",
"\u200A"=>" ",
"\u2011"=>"\u2010",
"\u2017"=>" \u0333",
"\u2024"=>".",
"\u2025"=>"..",
"\u2026"=>"...",
"\u202F"=>" ",
"\u2033"=>"\u2032\u2032",
"\u2034"=>"\u2032\u2032\u2032",
"\u2036"=>"\u2035\u2035",
"\u2037"=>"\u2035\u2035\u2035",
"\u203C"=>"!!",
"\u203E"=>" \u0305",
"\u2047"=>"??",
"\u2048"=>"?!",
"\u2049"=>"!?",
"\u2057"=>"\u2032\u2032\u2032\u2032",
"\u205F"=>" ",
"\u2070"=>"0",
"\u2071"=>"i",
"\u2074"=>"4",
"\u2075"=>"5",
"\u2076"=>"6",
"\u2077"=>"7",
"\u2078"=>"8",
"\u2079"=>"9",
"\u207A"=>"+",
"\u207B"=>"\u2212",
"\u207C"=>"=",
"\u207D"=>"(",
"\u207E"=>")",
"\u207F"=>"n",
"\u2080"=>"0",
"\u2081"=>"1",
"\u2082"=>"2",
"\u2083"=>"3",
"\u2084"=>"4",
"\u2085"=>"5",
"\u2086"=>"6",
"\u2087"=>"7",
"\u2088"=>"8",
"\u2089"=>"9",
"\u208A"=>"+",
"\u208B"=>"\u2212",
"\u208C"=>"=",
"\u208D"=>"(",
"\u208E"=>")",
"\u2090"=>"a",
"\u2091"=>"e",
"\u2092"=>"o",
"\u2093"=>"x",
"\u2094"=>"\u0259",
"\u2095"=>"h",
"\u2096"=>"k",
"\u2097"=>"l",
"\u2098"=>"m",
"\u2099"=>"n",
"\u209A"=>"p",
"\u209B"=>"s",
"\u209C"=>"t",
"\u20A8"=>"Rs",
"\u2100"=>"a/c",
"\u2101"=>"a/s",
"\u2102"=>"C",
"\u2103"=>"\u00B0C",
"\u2105"=>"c/o",
"\u2106"=>"c/u",
"\u2107"=>"\u0190",
"\u2109"=>"\u00B0F",
"\u210A"=>"g",
"\u210B"=>"H",
"\u210C"=>"H",
"\u210D"=>"H",
"\u210E"=>"h",
"\u210F"=>"\u0127",
"\u2110"=>"I",
"\u2111"=>"I",
"\u2112"=>"L",
"\u2113"=>"l",
"\u2115"=>"N",
"\u2116"=>"No",
"\u2119"=>"P",
"\u211A"=>"Q",
"\u211B"=>"R",
"\u211C"=>"R",
"\u211D"=>"R",
"\u2120"=>"SM",
"\u2121"=>"TEL",
"\u2122"=>"TM",
"\u2124"=>"Z",
"\u2128"=>"Z",
"\u212C"=>"B",
"\u212D"=>"C",
"\u212F"=>"e",
"\u2130"=>"E",
"\u2131"=>"F",
"\u2133"=>"M",
"\u2134"=>"o",
"\u2135"=>"\u05D0",
"\u2136"=>"\u05D1",
"\u2137"=>"\u05D2",
"\u2138"=>"\u05D3",
"\u2139"=>"i",
"\u213B"=>"FAX",
"\u213C"=>"\u03C0",
"\u213D"=>"\u03B3",
"\u213E"=>"\u0393",
"\u213F"=>"\u03A0",
"\u2140"=>"\u2211",
"\u2145"=>"D",
"\u2146"=>"d",
"\u2147"=>"e",
"\u2148"=>"i",
"\u2149"=>"j",
"\u2150"=>"1\u20447",
"\u2151"=>"1\u20449",
"\u2152"=>"1\u204410",
"\u2153"=>"1\u20443",
"\u2154"=>"2\u20443",
"\u2155"=>"1\u20445",
"\u2156"=>"2\u20445",
"\u2157"=>"3\u20445",
"\u2158"=>"4\u20445",
"\u2159"=>"1\u20446",
"\u215A"=>"5\u20446",
"\u215B"=>"1\u20448",
"\u215C"=>"3\u20448",
"\u215D"=>"5\u20448",
"\u215E"=>"7\u20448",
"\u215F"=>"1\u2044",
"\u2160"=>"I",
"\u2161"=>"II",
"\u2162"=>"III",
"\u2163"=>"IV",
"\u2164"=>"V",
"\u2165"=>"VI",
"\u2166"=>"VII",
"\u2167"=>"VIII",
"\u2168"=>"IX",
"\u2169"=>"X",
"\u216A"=>"XI",
"\u216B"=>"XII",
"\u216C"=>"L",
"\u216D"=>"C",
"\u216E"=>"D",
"\u216F"=>"M",
"\u2170"=>"i",
"\u2171"=>"ii",
"\u2172"=>"iii",
"\u2173"=>"iv",
"\u2174"=>"v",
"\u2175"=>"vi",
"\u2176"=>"vii",
"\u2177"=>"viii",
"\u2178"=>"ix",
"\u2179"=>"x",
"\u217A"=>"xi",
"\u217B"=>"xii",
"\u217C"=>"l",
"\u217D"=>"c",
"\u217E"=>"d",
"\u217F"=>"m",
"\u2189"=>"0\u20443",
"\u222C"=>"\u222B\u222B",
"\u222D"=>"\u222B\u222B\u222B",
"\u222F"=>"\u222E\u222E",
"\u2230"=>"\u222E\u222E\u222E",
"\u2460"=>"1",
"\u2461"=>"2",
"\u2462"=>"3",
"\u2463"=>"4",
"\u2464"=>"5",
"\u2465"=>"6",
"\u2466"=>"7",
"\u2467"=>"8",
"\u2468"=>"9",
"\u2469"=>"10",
"\u246A"=>"11",
"\u246B"=>"12",
"\u246C"=>"13",
"\u246D"=>"14",
"\u246E"=>"15",
"\u246F"=>"16",
"\u2470"=>"17",
"\u2471"=>"18",
"\u2472"=>"19",
"\u2473"=>"20",
"\u2474"=>"(1)",
"\u2475"=>"(2)",
"\u2476"=>"(3)",
"\u2477"=>"(4)",
"\u2478"=>"(5)",
"\u2479"=>"(6)",
"\u247A"=>"(7)",
"\u247B"=>"(8)",
"\u247C"=>"(9)",
"\u247D"=>"(10)",
"\u247E"=>"(11)",
"\u247F"=>"(12)",
"\u2480"=>"(13)",
"\u2481"=>"(14)",
"\u2482"=>"(15)",
"\u2483"=>"(16)",
"\u2484"=>"(17)",
"\u2485"=>"(18)",
"\u2486"=>"(19)",
"\u2487"=>"(20)",
"\u2488"=>"1.",
"\u2489"=>"2.",
"\u248A"=>"3.",
"\u248B"=>"4.",
"\u248C"=>"5.",
"\u248D"=>"6.",
"\u248E"=>"7.",
"\u248F"=>"8.",
"\u2490"=>"9.",
"\u2491"=>"10.",
"\u2492"=>"11.",
"\u2493"=>"12.",
"\u2494"=>"13.",
"\u2495"=>"14.",
"\u2496"=>"15.",
"\u2497"=>"16.",
"\u2498"=>"17.",
"\u2499"=>"18.",
"\u249A"=>"19.",
"\u249B"=>"20.",
"\u249C"=>"(a)",
"\u249D"=>"(b)",
"\u249E"=>"(c)",
"\u249F"=>"(d)",
"\u24A0"=>"(e)",
"\u24A1"=>"(f)",
"\u24A2"=>"(g)",
"\u24A3"=>"(h)",
"\u24A4"=>"(i)",
"\u24A5"=>"(j)",
"\u24A6"=>"(k)",
"\u24A7"=>"(l)",
"\u24A8"=>"(m)",
"\u24A9"=>"(n)",
"\u24AA"=>"(o)",
"\u24AB"=>"(p)",
"\u24AC"=>"(q)",
"\u24AD"=>"(r)",
"\u24AE"=>"(s)",
"\u24AF"=>"(t)",
"\u24B0"=>"(u)",
"\u24B1"=>"(v)",
"\u24B2"=>"(w)",
"\u24B3"=>"(x)",
"\u24B4"=>"(y)",
"\u24B5"=>"(z)",
"\u24B6"=>"A",
"\u24B7"=>"B",
"\u24B8"=>"C",
"\u24B9"=>"D",
"\u24BA"=>"E",
"\u24BB"=>"F",
"\u24BC"=>"G",
"\u24BD"=>"H",
"\u24BE"=>"I",
"\u24BF"=>"J",
"\u24C0"=>"K",
"\u24C1"=>"L",
"\u24C2"=>"M",
"\u24C3"=>"N",
"\u24C4"=>"O",
"\u24C5"=>"P",
"\u24C6"=>"Q",
"\u24C7"=>"R",
"\u24C8"=>"S",
"\u24C9"=>"T",
"\u24CA"=>"U",
"\u24CB"=>"V",
"\u24CC"=>"W",
"\u24CD"=>"X",
"\u24CE"=>"Y",
"\u24CF"=>"Z",
"\u24D0"=>"a",
"\u24D1"=>"b",
"\u24D2"=>"c",
"\u24D3"=>"d",
"\u24D4"=>"e",
"\u24D5"=>"f",
"\u24D6"=>"g",
"\u24D7"=>"h",
"\u24D8"=>"i",
"\u24D9"=>"j",
"\u24DA"=>"k",
"\u24DB"=>"l",
"\u24DC"=>"m",
"\u24DD"=>"n",
"\u24DE"=>"o",
"\u24DF"=>"p",
"\u24E0"=>"q",
"\u24E1"=>"r",
"\u24E2"=>"s",
"\u24E3"=>"t",
"\u24E4"=>"u",
"\u24E5"=>"v",
"\u24E6"=>"w",
"\u24E7"=>"x",
"\u24E8"=>"y",
"\u24E9"=>"z",
"\u24EA"=>"0",
"\u2A0C"=>"\u222B\u222B\u222B\u222B",
"\u2A74"=>"::=",
"\u2A75"=>"==",
"\u2A76"=>"===",
"\u2C7C"=>"j",
"\u2C7D"=>"V",
"\u2D6F"=>"\u2D61",
"\u2E9F"=>"\u6BCD",
"\u2EF3"=>"\u9F9F",
"\u2F00"=>"\u4E00",
"\u2F01"=>"\u4E28",
"\u2F02"=>"\u4E36",
"\u2F03"=>"\u4E3F",
"\u2F04"=>"\u4E59",
"\u2F05"=>"\u4E85",
"\u2F06"=>"\u4E8C",
"\u2F07"=>"\u4EA0",
"\u2F08"=>"\u4EBA",
"\u2F09"=>"\u513F",
"\u2F0A"=>"\u5165",
"\u2F0B"=>"\u516B",
"\u2F0C"=>"\u5182",
"\u2F0D"=>"\u5196",
"\u2F0E"=>"\u51AB",
"\u2F0F"=>"\u51E0",
"\u2F10"=>"\u51F5",
"\u2F11"=>"\u5200",
"\u2F12"=>"\u529B",
"\u2F13"=>"\u52F9",
"\u2F14"=>"\u5315",
"\u2F15"=>"\u531A",
"\u2F16"=>"\u5338",
"\u2F17"=>"\u5341",
"\u2F18"=>"\u535C",
"\u2F19"=>"\u5369",
"\u2F1A"=>"\u5382",
"\u2F1B"=>"\u53B6",
"\u2F1C"=>"\u53C8",
"\u2F1D"=>"\u53E3",
"\u2F1E"=>"\u56D7",
"\u2F1F"=>"\u571F",
"\u2F20"=>"\u58EB",
"\u2F21"=>"\u5902",
"\u2F22"=>"\u590A",
"\u2F23"=>"\u5915",
"\u2F24"=>"\u5927",
"\u2F25"=>"\u5973",
"\u2F26"=>"\u5B50",
"\u2F27"=>"\u5B80",
"\u2F28"=>"\u5BF8",
"\u2F29"=>"\u5C0F",
"\u2F2A"=>"\u5C22",
"\u2F2B"=>"\u5C38",
"\u2F2C"=>"\u5C6E",
"\u2F2D"=>"\u5C71",
"\u2F2E"=>"\u5DDB",
"\u2F2F"=>"\u5DE5",
"\u2F30"=>"\u5DF1",
"\u2F31"=>"\u5DFE",
"\u2F32"=>"\u5E72",
"\u2F33"=>"\u5E7A",
"\u2F34"=>"\u5E7F",
"\u2F35"=>"\u5EF4",
"\u2F36"=>"\u5EFE",
"\u2F37"=>"\u5F0B",
"\u2F38"=>"\u5F13",
"\u2F39"=>"\u5F50",
"\u2F3A"=>"\u5F61",
"\u2F3B"=>"\u5F73",
"\u2F3C"=>"\u5FC3",
"\u2F3D"=>"\u6208",
"\u2F3E"=>"\u6236",
"\u2F3F"=>"\u624B",
"\u2F40"=>"\u652F",
"\u2F41"=>"\u6534",
"\u2F42"=>"\u6587",
"\u2F43"=>"\u6597",
"\u2F44"=>"\u65A4",
"\u2F45"=>"\u65B9",
"\u2F46"=>"\u65E0",
"\u2F47"=>"\u65E5",
"\u2F48"=>"\u66F0",
"\u2F49"=>"\u6708",
"\u2F4A"=>"\u6728",
"\u2F4B"=>"\u6B20",
"\u2F4C"=>"\u6B62",
"\u2F4D"=>"\u6B79",
"\u2F4E"=>"\u6BB3",
"\u2F4F"=>"\u6BCB",
"\u2F50"=>"\u6BD4",
"\u2F51"=>"\u6BDB",
"\u2F52"=>"\u6C0F",
"\u2F53"=>"\u6C14",
"\u2F54"=>"\u6C34",
"\u2F55"=>"\u706B",
"\u2F56"=>"\u722A",
"\u2F57"=>"\u7236",
"\u2F58"=>"\u723B",
"\u2F59"=>"\u723F",
"\u2F5A"=>"\u7247",
"\u2F5B"=>"\u7259",
"\u2F5C"=>"\u725B",
"\u2F5D"=>"\u72AC",
"\u2F5E"=>"\u7384",
"\u2F5F"=>"\u7389",
"\u2F60"=>"\u74DC",
"\u2F61"=>"\u74E6",
"\u2F62"=>"\u7518",
"\u2F63"=>"\u751F",
"\u2F64"=>"\u7528",
"\u2F65"=>"\u7530",
"\u2F66"=>"\u758B",
"\u2F67"=>"\u7592",
"\u2F68"=>"\u7676",
"\u2F69"=>"\u767D",
"\u2F6A"=>"\u76AE",
"\u2F6B"=>"\u76BF",
"\u2F6C"=>"\u76EE",
"\u2F6D"=>"\u77DB",
"\u2F6E"=>"\u77E2",
"\u2F6F"=>"\u77F3",
"\u2F70"=>"\u793A",
"\u2F71"=>"\u79B8",
"\u2F72"=>"\u79BE",
"\u2F73"=>"\u7A74",
"\u2F74"=>"\u7ACB",
"\u2F75"=>"\u7AF9",
"\u2F76"=>"\u7C73",
"\u2F77"=>"\u7CF8",
"\u2F78"=>"\u7F36",
"\u2F79"=>"\u7F51",
"\u2F7A"=>"\u7F8A",
"\u2F7B"=>"\u7FBD",
"\u2F7C"=>"\u8001",
"\u2F7D"=>"\u800C",
"\u2F7E"=>"\u8012",
"\u2F7F"=>"\u8033",
"\u2F80"=>"\u807F",
"\u2F81"=>"\u8089",
"\u2F82"=>"\u81E3",
"\u2F83"=>"\u81EA",
"\u2F84"=>"\u81F3",
"\u2F85"=>"\u81FC",
"\u2F86"=>"\u820C",
"\u2F87"=>"\u821B",
"\u2F88"=>"\u821F",
"\u2F89"=>"\u826E",
"\u2F8A"=>"\u8272",
"\u2F8B"=>"\u8278",
"\u2F8C"=>"\u864D",
"\u2F8D"=>"\u866B",
"\u2F8E"=>"\u8840",
"\u2F8F"=>"\u884C",
"\u2F90"=>"\u8863",
"\u2F91"=>"\u897E",
"\u2F92"=>"\u898B",
"\u2F93"=>"\u89D2",
"\u2F94"=>"\u8A00",
"\u2F95"=>"\u8C37",
"\u2F96"=>"\u8C46",
"\u2F97"=>"\u8C55",
"\u2F98"=>"\u8C78",
"\u2F99"=>"\u8C9D",
"\u2F9A"=>"\u8D64",
"\u2F9B"=>"\u8D70",
"\u2F9C"=>"\u8DB3",
"\u2F9D"=>"\u8EAB",
"\u2F9E"=>"\u8ECA",
"\u2F9F"=>"\u8F9B",
"\u2FA0"=>"\u8FB0",
"\u2FA1"=>"\u8FB5",
"\u2FA2"=>"\u9091",
"\u2FA3"=>"\u9149",
"\u2FA4"=>"\u91C6",
"\u2FA5"=>"\u91CC",
"\u2FA6"=>"\u91D1",
"\u2FA7"=>"\u9577",
"\u2FA8"=>"\u9580",
"\u2FA9"=>"\u961C",
"\u2FAA"=>"\u96B6",
"\u2FAB"=>"\u96B9",
"\u2FAC"=>"\u96E8",
"\u2FAD"=>"\u9751",
"\u2FAE"=>"\u975E",
"\u2FAF"=>"\u9762",
"\u2FB0"=>"\u9769",
"\u2FB1"=>"\u97CB",
"\u2FB2"=>"\u97ED",
"\u2FB3"=>"\u97F3",
"\u2FB4"=>"\u9801",
"\u2FB5"=>"\u98A8",
"\u2FB6"=>"\u98DB",
"\u2FB7"=>"\u98DF",
"\u2FB8"=>"\u9996",
"\u2FB9"=>"\u9999",
"\u2FBA"=>"\u99AC",
"\u2FBB"=>"\u9AA8",
"\u2FBC"=>"\u9AD8",
"\u2FBD"=>"\u9ADF",
"\u2FBE"=>"\u9B25",
"\u2FBF"=>"\u9B2F",
"\u2FC0"=>"\u9B32",
"\u2FC1"=>"\u9B3C",
"\u2FC2"=>"\u9B5A",
"\u2FC3"=>"\u9CE5",
"\u2FC4"=>"\u9E75",
"\u2FC5"=>"\u9E7F",
"\u2FC6"=>"\u9EA5",
"\u2FC7"=>"\u9EBB",
"\u2FC8"=>"\u9EC3",
"\u2FC9"=>"\u9ECD",
"\u2FCA"=>"\u9ED1",
"\u2FCB"=>"\u9EF9",
"\u2FCC"=>"\u9EFD",
"\u2FCD"=>"\u9F0E",
"\u2FCE"=>"\u9F13",
"\u2FCF"=>"\u9F20",
"\u2FD0"=>"\u9F3B",
"\u2FD1"=>"\u9F4A",
"\u2FD2"=>"\u9F52",
"\u2FD3"=>"\u9F8D",
"\u2FD4"=>"\u9F9C",
"\u2FD5"=>"\u9FA0",
"\u3000"=>" ",
"\u3036"=>"\u3012",
"\u3038"=>"\u5341",
"\u3039"=>"\u5344",
"\u303A"=>"\u5345",
"\u309B"=>" \u3099",
"\u309C"=>" \u309A",
"\u309F"=>"\u3088\u308A",
"\u30FF"=>"\u30B3\u30C8",
"\u3131"=>"\u1100",
"\u3132"=>"\u1101",
"\u3133"=>"\u11AA",
"\u3134"=>"\u1102",
"\u3135"=>"\u11AC",
"\u3136"=>"\u11AD",
"\u3137"=>"\u1103",
"\u3138"=>"\u1104",
"\u3139"=>"\u1105",
"\u313A"=>"\u11B0",
"\u313B"=>"\u11B1",
"\u313C"=>"\u11B2",
"\u313D"=>"\u11B3",
"\u313E"=>"\u11B4",
"\u313F"=>"\u11B5",
"\u3140"=>"\u111A",
"\u3141"=>"\u1106",
"\u3142"=>"\u1107",
"\u3143"=>"\u1108",
"\u3144"=>"\u1121",
"\u3145"=>"\u1109",
"\u3146"=>"\u110A",
"\u3147"=>"\u110B",
"\u3148"=>"\u110C",
"\u3149"=>"\u110D",
"\u314A"=>"\u110E",
"\u314B"=>"\u110F",
"\u314C"=>"\u1110",
"\u314D"=>"\u1111",
"\u314E"=>"\u1112",
"\u314F"=>"\u1161",
"\u3150"=>"\u1162",
"\u3151"=>"\u1163",
"\u3152"=>"\u1164",
"\u3153"=>"\u1165",
"\u3154"=>"\u1166",
"\u3155"=>"\u1167",
"\u3156"=>"\u1168",
"\u3157"=>"\u1169",
"\u3158"=>"\u116A",
"\u3159"=>"\u116B",
"\u315A"=>"\u116C",
"\u315B"=>"\u116D",
"\u315C"=>"\u116E",
"\u315D"=>"\u116F",
"\u315E"=>"\u1170",
"\u315F"=>"\u1171",
"\u3160"=>"\u1172",
"\u3161"=>"\u1173",
"\u3162"=>"\u1174",
"\u3163"=>"\u1175",
"\u3164"=>"\u1160",
"\u3165"=>"\u1114",
"\u3166"=>"\u1115",
"\u3167"=>"\u11C7",
"\u3168"=>"\u11C8",
"\u3169"=>"\u11CC",
"\u316A"=>"\u11CE",
"\u316B"=>"\u11D3",
"\u316C"=>"\u11D7",
"\u316D"=>"\u11D9",
"\u316E"=>"\u111C",
"\u316F"=>"\u11DD",
"\u3170"=>"\u11DF",
"\u3171"=>"\u111D",
"\u3172"=>"\u111E",
"\u3173"=>"\u1120",
"\u3174"=>"\u1122",
"\u3175"=>"\u1123",
"\u3176"=>"\u1127",
"\u3177"=>"\u1129",
"\u3178"=>"\u112B",
"\u3179"=>"\u112C",
"\u317A"=>"\u112D",
"\u317B"=>"\u112E",
"\u317C"=>"\u112F",
"\u317D"=>"\u1132",
"\u317E"=>"\u1136",
"\u317F"=>"\u1140",
"\u3180"=>"\u1147",
"\u3181"=>"\u114C",
"\u3182"=>"\u11F1",
"\u3183"=>"\u11F2",
"\u3184"=>"\u1157",
"\u3185"=>"\u1158",
"\u3186"=>"\u1159",
"\u3187"=>"\u1184",
"\u3188"=>"\u1185",
"\u3189"=>"\u1188",
"\u318A"=>"\u1191",
"\u318B"=>"\u1192",
"\u318C"=>"\u1194",
"\u318D"=>"\u119E",
"\u318E"=>"\u11A1",
"\u3192"=>"\u4E00",
"\u3193"=>"\u4E8C",
"\u3194"=>"\u4E09",
"\u3195"=>"\u56DB",
"\u3196"=>"\u4E0A",
"\u3197"=>"\u4E2D",
"\u3198"=>"\u4E0B",
"\u3199"=>"\u7532",
"\u319A"=>"\u4E59",
"\u319B"=>"\u4E19",
"\u319C"=>"\u4E01",
"\u319D"=>"\u5929",
"\u319E"=>"\u5730",
"\u319F"=>"\u4EBA",
"\u3200"=>"(\u1100)",
"\u3201"=>"(\u1102)",
"\u3202"=>"(\u1103)",
"\u3203"=>"(\u1105)",
"\u3204"=>"(\u1106)",
"\u3205"=>"(\u1107)",
"\u3206"=>"(\u1109)",
"\u3207"=>"(\u110B)",
"\u3208"=>"(\u110C)",
"\u3209"=>"(\u110E)",
"\u320A"=>"(\u110F)",
"\u320B"=>"(\u1110)",
"\u320C"=>"(\u1111)",
"\u320D"=>"(\u1112)",
"\u320E"=>"(\u1100\u1161)",
"\u320F"=>"(\u1102\u1161)",
"\u3210"=>"(\u1103\u1161)",
"\u3211"=>"(\u1105\u1161)",
"\u3212"=>"(\u1106\u1161)",
"\u3213"=>"(\u1107\u1161)",
"\u3214"=>"(\u1109\u1161)",
"\u3215"=>"(\u110B\u1161)",
"\u3216"=>"(\u110C\u1161)",
"\u3217"=>"(\u110E\u1161)",
"\u3218"=>"(\u110F\u1161)",
"\u3219"=>"(\u1110\u1161)",
"\u321A"=>"(\u1111\u1161)",
"\u321B"=>"(\u1112\u1161)",
"\u321C"=>"(\u110C\u116E)",
"\u321D"=>"(\u110B\u1169\u110C\u1165\u11AB)",
"\u321E"=>"(\u110B\u1169\u1112\u116E)",
"\u3220"=>"(\u4E00)",
"\u3221"=>"(\u4E8C)",
"\u3222"=>"(\u4E09)",
"\u3223"=>"(\u56DB)",
"\u3224"=>"(\u4E94)",
"\u3225"=>"(\u516D)",
"\u3226"=>"(\u4E03)",
"\u3227"=>"(\u516B)",
"\u3228"=>"(\u4E5D)",
"\u3229"=>"(\u5341)",
"\u322A"=>"(\u6708)",
"\u322B"=>"(\u706B)",
"\u322C"=>"(\u6C34)",
"\u322D"=>"(\u6728)",
"\u322E"=>"(\u91D1)",
"\u322F"=>"(\u571F)",
"\u3230"=>"(\u65E5)",
"\u3231"=>"(\u682A)",
"\u3232"=>"(\u6709)",
"\u3233"=>"(\u793E)",
"\u3234"=>"(\u540D)",
"\u3235"=>"(\u7279)",
"\u3236"=>"(\u8CA1)",
"\u3237"=>"(\u795D)",
"\u3238"=>"(\u52B4)",
"\u3239"=>"(\u4EE3)",
"\u323A"=>"(\u547C)",
"\u323B"=>"(\u5B66)",
"\u323C"=>"(\u76E3)",
"\u323D"=>"(\u4F01)",
"\u323E"=>"(\u8CC7)",
"\u323F"=>"(\u5354)",
"\u3240"=>"(\u796D)",
"\u3241"=>"(\u4F11)",
"\u3242"=>"(\u81EA)",
"\u3243"=>"(\u81F3)",
"\u3244"=>"\u554F",
"\u3245"=>"\u5E7C",
"\u3246"=>"\u6587",
"\u3247"=>"\u7B8F",
"\u3250"=>"PTE",
"\u3251"=>"21",
"\u3252"=>"22",
"\u3253"=>"23",
"\u3254"=>"24",
"\u3255"=>"25",
"\u3256"=>"26",
"\u3257"=>"27",
"\u3258"=>"28",
"\u3259"=>"29",
"\u325A"=>"30",
"\u325B"=>"31",
"\u325C"=>"32",
"\u325D"=>"33",
"\u325E"=>"34",
"\u325F"=>"35",
"\u3260"=>"\u1100",
"\u3261"=>"\u1102",
"\u3262"=>"\u1103",
"\u3263"=>"\u1105",
"\u3264"=>"\u1106",
"\u3265"=>"\u1107",
"\u3266"=>"\u1109",
"\u3267"=>"\u110B",
"\u3268"=>"\u110C",
"\u3269"=>"\u110E",
"\u326A"=>"\u110F",
"\u326B"=>"\u1110",
"\u326C"=>"\u1111",
"\u326D"=>"\u1112",
"\u326E"=>"\u1100\u1161",
"\u326F"=>"\u1102\u1161",
"\u3270"=>"\u1103\u1161",
"\u3271"=>"\u1105\u1161",
"\u3272"=>"\u1106\u1161",
"\u3273"=>"\u1107\u1161",
"\u3274"=>"\u1109\u1161",
"\u3275"=>"\u110B\u1161",
"\u3276"=>"\u110C\u1161",
"\u3277"=>"\u110E\u1161",
"\u3278"=>"\u110F\u1161",
"\u3279"=>"\u1110\u1161",
"\u327A"=>"\u1111\u1161",
"\u327B"=>"\u1112\u1161",
"\u327C"=>"\u110E\u1161\u11B7\u1100\u1169",
"\u327D"=>"\u110C\u116E\u110B\u1174",
"\u327E"=>"\u110B\u116E",
"\u3280"=>"\u4E00",
"\u3281"=>"\u4E8C",
"\u3282"=>"\u4E09",
"\u3283"=>"\u56DB",
"\u3284"=>"\u4E94",
"\u3285"=>"\u516D",
"\u3286"=>"\u4E03",
"\u3287"=>"\u516B",
"\u3288"=>"\u4E5D",
"\u3289"=>"\u5341",
"\u328A"=>"\u6708",
"\u328B"=>"\u706B",
"\u328C"=>"\u6C34",
"\u328D"=>"\u6728",
"\u328E"=>"\u91D1",
"\u328F"=>"\u571F",
"\u3290"=>"\u65E5",
"\u3291"=>"\u682A",
"\u3292"=>"\u6709",
"\u3293"=>"\u793E",
"\u3294"=>"\u540D",
"\u3295"=>"\u7279",
"\u3296"=>"\u8CA1",
"\u3297"=>"\u795D",
"\u3298"=>"\u52B4",
"\u3299"=>"\u79D8",
"\u329A"=>"\u7537",
"\u329B"=>"\u5973",
"\u329C"=>"\u9069",
"\u329D"=>"\u512A",
"\u329E"=>"\u5370",
"\u329F"=>"\u6CE8",
"\u32A0"=>"\u9805",
"\u32A1"=>"\u4F11",
"\u32A2"=>"\u5199",
"\u32A3"=>"\u6B63",
"\u32A4"=>"\u4E0A",
"\u32A5"=>"\u4E2D",
"\u32A6"=>"\u4E0B",
"\u32A7"=>"\u5DE6",
"\u32A8"=>"\u53F3",
"\u32A9"=>"\u533B",
"\u32AA"=>"\u5B97",
"\u32AB"=>"\u5B66",
"\u32AC"=>"\u76E3",
"\u32AD"=>"\u4F01",
"\u32AE"=>"\u8CC7",
"\u32AF"=>"\u5354",
"\u32B0"=>"\u591C",
"\u32B1"=>"36",
"\u32B2"=>"37",
"\u32B3"=>"38",
"\u32B4"=>"39",
"\u32B5"=>"40",
"\u32B6"=>"41",
"\u32B7"=>"42",
"\u32B8"=>"43",
"\u32B9"=>"44",
"\u32BA"=>"45",
"\u32BB"=>"46",
"\u32BC"=>"47",
"\u32BD"=>"48",
"\u32BE"=>"49",
"\u32BF"=>"50",
"\u32C0"=>"1\u6708",
"\u32C1"=>"2\u6708",
"\u32C2"=>"3\u6708",
"\u32C3"=>"4\u6708",
"\u32C4"=>"5\u6708",
"\u32C5"=>"6\u6708",
"\u32C6"=>"7\u6708",
"\u32C7"=>"8\u6708",
"\u32C8"=>"9\u6708",
"\u32C9"=>"10\u6708",
"\u32CA"=>"11\u6708",
"\u32CB"=>"12\u6708",
"\u32CC"=>"Hg",
"\u32CD"=>"erg",
"\u32CE"=>"eV",
"\u32CF"=>"LTD",
"\u32D0"=>"\u30A2",
"\u32D1"=>"\u30A4",
"\u32D2"=>"\u30A6",
"\u32D3"=>"\u30A8",
"\u32D4"=>"\u30AA",
"\u32D5"=>"\u30AB",
"\u32D6"=>"\u30AD",
"\u32D7"=>"\u30AF",
"\u32D8"=>"\u30B1",
"\u32D9"=>"\u30B3",
"\u32DA"=>"\u30B5",
"\u32DB"=>"\u30B7",
"\u32DC"=>"\u30B9",
"\u32DD"=>"\u30BB",
"\u32DE"=>"\u30BD",
"\u32DF"=>"\u30BF",
"\u32E0"=>"\u30C1",
"\u32E1"=>"\u30C4",
"\u32E2"=>"\u30C6",
"\u32E3"=>"\u30C8",
"\u32E4"=>"\u30CA",
"\u32E5"=>"\u30CB",
"\u32E6"=>"\u30CC",
"\u32E7"=>"\u30CD",
"\u32E8"=>"\u30CE",
"\u32E9"=>"\u30CF",
"\u32EA"=>"\u30D2",
"\u32EB"=>"\u30D5",
"\u32EC"=>"\u30D8",
"\u32ED"=>"\u30DB",
"\u32EE"=>"\u30DE",
"\u32EF"=>"\u30DF",
"\u32F0"=>"\u30E0",
"\u32F1"=>"\u30E1",
"\u32F2"=>"\u30E2",
"\u32F3"=>"\u30E4",
"\u32F4"=>"\u30E6",
"\u32F5"=>"\u30E8",
"\u32F6"=>"\u30E9",
"\u32F7"=>"\u30EA",
"\u32F8"=>"\u30EB",
"\u32F9"=>"\u30EC",
"\u32FA"=>"\u30ED",
"\u32FB"=>"\u30EF",
"\u32FC"=>"\u30F0",
"\u32FD"=>"\u30F1",
"\u32FE"=>"\u30F2",
"\u32FF"=>"\u4EE4\u548C",
"\u3300"=>"\u30A2\u30D1\u30FC\u30C8",
"\u3301"=>"\u30A2\u30EB\u30D5\u30A1",
"\u3302"=>"\u30A2\u30F3\u30DA\u30A2",
"\u3303"=>"\u30A2\u30FC\u30EB",
"\u3304"=>"\u30A4\u30CB\u30F3\u30B0",
"\u3305"=>"\u30A4\u30F3\u30C1",
"\u3306"=>"\u30A6\u30A9\u30F3",
"\u3307"=>"\u30A8\u30B9\u30AF\u30FC\u30C9",
"\u3308"=>"\u30A8\u30FC\u30AB\u30FC",
"\u3309"=>"\u30AA\u30F3\u30B9",
"\u330A"=>"\u30AA\u30FC\u30E0",
"\u330B"=>"\u30AB\u30A4\u30EA",
"\u330C"=>"\u30AB\u30E9\u30C3\u30C8",
"\u330D"=>"\u30AB\u30ED\u30EA\u30FC",
"\u330E"=>"\u30AC\u30ED\u30F3",
"\u330F"=>"\u30AC\u30F3\u30DE",
"\u3310"=>"\u30AE\u30AC",
"\u3311"=>"\u30AE\u30CB\u30FC",
"\u3312"=>"\u30AD\u30E5\u30EA\u30FC",
"\u3313"=>"\u30AE\u30EB\u30C0\u30FC",
"\u3314"=>"\u30AD\u30ED",
"\u3315"=>"\u30AD\u30ED\u30B0\u30E9\u30E0",
"\u3316"=>"\u30AD\u30ED\u30E1\u30FC\u30C8\u30EB",
"\u3317"=>"\u30AD\u30ED\u30EF\u30C3\u30C8",
"\u3318"=>"\u30B0\u30E9\u30E0",
"\u3319"=>"\u30B0\u30E9\u30E0\u30C8\u30F3",
"\u331A"=>"\u30AF\u30EB\u30BC\u30A4\u30ED",
"\u331B"=>"\u30AF\u30ED\u30FC\u30CD",
"\u331C"=>"\u30B1\u30FC\u30B9",
"\u331D"=>"\u30B3\u30EB\u30CA",
"\u331E"=>"\u30B3\u30FC\u30DD",
"\u331F"=>"\u30B5\u30A4\u30AF\u30EB",
"\u3320"=>"\u30B5\u30F3\u30C1\u30FC\u30E0",
"\u3321"=>"\u30B7\u30EA\u30F3\u30B0",
"\u3322"=>"\u30BB\u30F3\u30C1",
"\u3323"=>"\u30BB\u30F3\u30C8",
"\u3324"=>"\u30C0\u30FC\u30B9",
"\u3325"=>"\u30C7\u30B7",
"\u3326"=>"\u30C9\u30EB",
"\u3327"=>"\u30C8\u30F3",
"\u3328"=>"\u30CA\u30CE",
"\u3329"=>"\u30CE\u30C3\u30C8",
"\u332A"=>"\u30CF\u30A4\u30C4",
"\u332B"=>"\u30D1\u30FC\u30BB\u30F3\u30C8",
"\u332C"=>"\u30D1\u30FC\u30C4",
"\u332D"=>"\u30D0\u30FC\u30EC\u30EB",
"\u332E"=>"\u30D4\u30A2\u30B9\u30C8\u30EB",
"\u332F"=>"\u30D4\u30AF\u30EB",
"\u3330"=>"\u30D4\u30B3",
"\u3331"=>"\u30D3\u30EB",
"\u3332"=>"\u30D5\u30A1\u30E9\u30C3\u30C9",
"\u3333"=>"\u30D5\u30A3\u30FC\u30C8",
"\u3334"=>"\u30D6\u30C3\u30B7\u30A7\u30EB",
"\u3335"=>"\u30D5\u30E9\u30F3",
"\u3336"=>"\u30D8\u30AF\u30BF\u30FC\u30EB",
"\u3337"=>"\u30DA\u30BD",
"\u3338"=>"\u30DA\u30CB\u30D2",
"\u3339"=>"\u30D8\u30EB\u30C4",
"\u333A"=>"\u30DA\u30F3\u30B9",
"\u333B"=>"\u30DA\u30FC\u30B8",
"\u333C"=>"\u30D9\u30FC\u30BF",
"\u333D"=>"\u30DD\u30A4\u30F3\u30C8",
"\u333E"=>"\u30DC\u30EB\u30C8",
"\u333F"=>"\u30DB\u30F3",
"\u3340"=>"\u30DD\u30F3\u30C9",
"\u3341"=>"\u30DB\u30FC\u30EB",
"\u3342"=>"\u30DB\u30FC\u30F3",
"\u3343"=>"\u30DE\u30A4\u30AF\u30ED",
"\u3344"=>"\u30DE\u30A4\u30EB",
"\u3345"=>"\u30DE\u30C3\u30CF",
"\u3346"=>"\u30DE\u30EB\u30AF",
"\u3347"=>"\u30DE\u30F3\u30B7\u30E7\u30F3",
"\u3348"=>"\u30DF\u30AF\u30ED\u30F3",
"\u3349"=>"\u30DF\u30EA",
"\u334A"=>"\u30DF\u30EA\u30D0\u30FC\u30EB",
"\u334B"=>"\u30E1\u30AC",
"\u334C"=>"\u30E1\u30AC\u30C8\u30F3",
"\u334D"=>"\u30E1\u30FC\u30C8\u30EB",
"\u334E"=>"\u30E4\u30FC\u30C9",
"\u334F"=>"\u30E4\u30FC\u30EB",
"\u3350"=>"\u30E6\u30A2\u30F3",
"\u3351"=>"\u30EA\u30C3\u30C8\u30EB",
"\u3352"=>"\u30EA\u30E9",
"\u3353"=>"\u30EB\u30D4\u30FC",
"\u3354"=>"\u30EB\u30FC\u30D6\u30EB",
"\u3355"=>"\u30EC\u30E0",
"\u3356"=>"\u30EC\u30F3\u30C8\u30B2\u30F3",
"\u3357"=>"\u30EF\u30C3\u30C8",
"\u3358"=>"0\u70B9",
"\u3359"=>"1\u70B9",
"\u335A"=>"2\u70B9",
"\u335B"=>"3\u70B9",
"\u335C"=>"4\u70B9",
"\u335D"=>"5\u70B9",
"\u335E"=>"6\u70B9",
"\u335F"=>"7\u70B9",
"\u3360"=>"8\u70B9",
"\u3361"=>"9\u70B9",
"\u3362"=>"10\u70B9",
"\u3363"=>"11\u70B9",
"\u3364"=>"12\u70B9",
"\u3365"=>"13\u70B9",
"\u3366"=>"14\u70B9",
"\u3367"=>"15\u70B9",
"\u3368"=>"16\u70B9",
"\u3369"=>"17\u70B9",
"\u336A"=>"18\u70B9",
"\u336B"=>"19\u70B9",
"\u336C"=>"20\u70B9",
"\u336D"=>"21\u70B9",
"\u336E"=>"22\u70B9",
"\u336F"=>"23\u70B9",
"\u3370"=>"24\u70B9",
"\u3371"=>"hPa",
"\u3372"=>"da",
"\u3373"=>"AU",
"\u3374"=>"bar",
"\u3375"=>"oV",
"\u3376"=>"pc",
"\u3377"=>"dm",
"\u3378"=>"dm2",
"\u3379"=>"dm3",
"\u337A"=>"IU",
"\u337B"=>"\u5E73\u6210",
"\u337C"=>"\u662D\u548C",
"\u337D"=>"\u5927\u6B63",
"\u337E"=>"\u660E\u6CBB",
"\u337F"=>"\u682A\u5F0F\u4F1A\u793E",
"\u3380"=>"pA",
"\u3381"=>"nA",
"\u3382"=>"\u03BCA",
"\u3383"=>"mA",
"\u3384"=>"kA",
"\u3385"=>"KB",
"\u3386"=>"MB",
"\u3387"=>"GB",
"\u3388"=>"cal",
"\u3389"=>"kcal",
"\u338A"=>"pF",
"\u338B"=>"nF",
"\u338C"=>"\u03BCF",
"\u338D"=>"\u03BCg",
"\u338E"=>"mg",
"\u338F"=>"kg",
"\u3390"=>"Hz",
"\u3391"=>"kHz",
"\u3392"=>"MHz",
"\u3393"=>"GHz",
"\u3394"=>"THz",
"\u3395"=>"\u03BCl",
"\u3396"=>"ml",
"\u3397"=>"dl",
"\u3398"=>"kl",
"\u3399"=>"fm",
"\u339A"=>"nm",
"\u339B"=>"\u03BCm",
"\u339C"=>"mm",
"\u339D"=>"cm",
"\u339E"=>"km",
"\u339F"=>"mm2",
"\u33A0"=>"cm2",
"\u33A1"=>"m2",
"\u33A2"=>"km2",
"\u33A3"=>"mm3",
"\u33A4"=>"cm3",
"\u33A5"=>"m3",
"\u33A6"=>"km3",
"\u33A7"=>"m\u2215s",
"\u33A8"=>"m\u2215s2",
"\u33A9"=>"Pa",
"\u33AA"=>"kPa",
"\u33AB"=>"MPa",
"\u33AC"=>"GPa",
"\u33AD"=>"rad",
"\u33AE"=>"rad\u2215s",
"\u33AF"=>"rad\u2215s2",
"\u33B0"=>"ps",
"\u33B1"=>"ns",
"\u33B2"=>"\u03BCs",
"\u33B3"=>"ms",
"\u33B4"=>"pV",
"\u33B5"=>"nV",
"\u33B6"=>"\u03BCV",
"\u33B7"=>"mV",
"\u33B8"=>"kV",
"\u33B9"=>"MV",
"\u33BA"=>"pW",
"\u33BB"=>"nW",
"\u33BC"=>"\u03BCW",
"\u33BD"=>"mW",
"\u33BE"=>"kW",
"\u33BF"=>"MW",
"\u33C0"=>"k\u03A9",
"\u33C1"=>"M\u03A9",
"\u33C2"=>"a.m.",
"\u33C3"=>"Bq",
"\u33C4"=>"cc",
"\u33C5"=>"cd",
"\u33C6"=>"C\u2215kg",
"\u33C7"=>"Co.",
"\u33C8"=>"dB",
"\u33C9"=>"Gy",
"\u33CA"=>"ha",
"\u33CB"=>"HP",
"\u33CC"=>"in",
"\u33CD"=>"KK",
"\u33CE"=>"KM",
"\u33CF"=>"kt",
"\u33D0"=>"lm",
"\u33D1"=>"ln",
"\u33D2"=>"log",
"\u33D3"=>"lx",
"\u33D4"=>"mb",
"\u33D5"=>"mil",
"\u33D6"=>"mol",
"\u33D7"=>"PH",
"\u33D8"=>"p.m.",
"\u33D9"=>"PPM",
"\u33DA"=>"PR",
"\u33DB"=>"sr",
"\u33DC"=>"Sv",
"\u33DD"=>"Wb",
"\u33DE"=>"V\u2215m",
"\u33DF"=>"A\u2215m",
"\u33E0"=>"1\u65E5",
"\u33E1"=>"2\u65E5",
"\u33E2"=>"3\u65E5",
"\u33E3"=>"4\u65E5",
"\u33E4"=>"5\u65E5",
"\u33E5"=>"6\u65E5",
"\u33E6"=>"7\u65E5",
"\u33E7"=>"8\u65E5",
"\u33E8"=>"9\u65E5",
"\u33E9"=>"10\u65E5",
"\u33EA"=>"11\u65E5",
"\u33EB"=>"12\u65E5",
"\u33EC"=>"13\u65E5",
"\u33ED"=>"14\u65E5",
"\u33EE"=>"15\u65E5",
"\u33EF"=>"16\u65E5",
"\u33F0"=>"17\u65E5",
"\u33F1"=>"18\u65E5",
"\u33F2"=>"19\u65E5",
"\u33F3"=>"20\u65E5",
"\u33F4"=>"21\u65E5",
"\u33F5"=>"22\u65E5",
"\u33F6"=>"23\u65E5",
"\u33F7"=>"24\u65E5",
"\u33F8"=>"25\u65E5",
"\u33F9"=>"26\u65E5",
"\u33FA"=>"27\u65E5",
"\u33FB"=>"28\u65E5",
"\u33FC"=>"29\u65E5",
"\u33FD"=>"30\u65E5",
"\u33FE"=>"31\u65E5",
"\u33FF"=>"gal",
"\uA69C"=>"\u044A",
"\uA69D"=>"\u044C",
"\uA770"=>"\uA76F",
"\uA7F2"=>"C",
"\uA7F3"=>"F",
"\uA7F4"=>"Q",
"\uA7F8"=>"\u0126",
"\uA7F9"=>"\u0153",
"\uAB5C"=>"\uA727",
"\uAB5D"=>"\uAB37",
"\uAB5E"=>"\u026B",
"\uAB5F"=>"\uAB52",
"\uAB69"=>"\u028D",
"\uFB00"=>"ff",
"\uFB01"=>"fi",
"\uFB02"=>"fl",
"\uFB03"=>"ffi",
"\uFB04"=>"ffl",
"\uFB05"=>"st",
"\uFB06"=>"st",
"\uFB13"=>"\u0574\u0576",
"\uFB14"=>"\u0574\u0565",
"\uFB15"=>"\u0574\u056B",
"\uFB16"=>"\u057E\u0576",
"\uFB17"=>"\u0574\u056D",
"\uFB20"=>"\u05E2",
"\uFB21"=>"\u05D0",
"\uFB22"=>"\u05D3",
"\uFB23"=>"\u05D4",
"\uFB24"=>"\u05DB",
"\uFB25"=>"\u05DC",
"\uFB26"=>"\u05DD",
"\uFB27"=>"\u05E8",
"\uFB28"=>"\u05EA",
"\uFB29"=>"+",
"\uFB4F"=>"\u05D0\u05DC",
"\uFB50"=>"\u0671",
"\uFB51"=>"\u0671",
"\uFB52"=>"\u067B",
"\uFB53"=>"\u067B",
"\uFB54"=>"\u067B",
"\uFB55"=>"\u067B",
"\uFB56"=>"\u067E",
"\uFB57"=>"\u067E",
"\uFB58"=>"\u067E",
"\uFB59"=>"\u067E",
"\uFB5A"=>"\u0680",
"\uFB5B"=>"\u0680",
"\uFB5C"=>"\u0680",
"\uFB5D"=>"\u0680",
"\uFB5E"=>"\u067A",
"\uFB5F"=>"\u067A",
"\uFB60"=>"\u067A",
"\uFB61"=>"\u067A",
"\uFB62"=>"\u067F",
"\uFB63"=>"\u067F",
"\uFB64"=>"\u067F",
"\uFB65"=>"\u067F",
"\uFB66"=>"\u0679",
"\uFB67"=>"\u0679",
"\uFB68"=>"\u0679",
"\uFB69"=>"\u0679",
"\uFB6A"=>"\u06A4",
"\uFB6B"=>"\u06A4",
"\uFB6C"=>"\u06A4",
"\uFB6D"=>"\u06A4",
"\uFB6E"=>"\u06A6",
"\uFB6F"=>"\u06A6",
"\uFB70"=>"\u06A6",
"\uFB71"=>"\u06A6",
"\uFB72"=>"\u0684",
"\uFB73"=>"\u0684",
"\uFB74"=>"\u0684",
"\uFB75"=>"\u0684",
"\uFB76"=>"\u0683",
"\uFB77"=>"\u0683",
"\uFB78"=>"\u0683",
"\uFB79"=>"\u0683",
"\uFB7A"=>"\u0686",
"\uFB7B"=>"\u0686",
"\uFB7C"=>"\u0686",
"\uFB7D"=>"\u0686",
"\uFB7E"=>"\u0687",
"\uFB7F"=>"\u0687",
"\uFB80"=>"\u0687",
"\uFB81"=>"\u0687",
"\uFB82"=>"\u068D",
"\uFB83"=>"\u068D",
"\uFB84"=>"\u068C",
"\uFB85"=>"\u068C",
"\uFB86"=>"\u068E",
"\uFB87"=>"\u068E",
"\uFB88"=>"\u0688",
"\uFB89"=>"\u0688",
"\uFB8A"=>"\u0698",
"\uFB8B"=>"\u0698",
"\uFB8C"=>"\u0691",
"\uFB8D"=>"\u0691",
"\uFB8E"=>"\u06A9",
"\uFB8F"=>"\u06A9",
"\uFB90"=>"\u06A9",
"\uFB91"=>"\u06A9",
"\uFB92"=>"\u06AF",
"\uFB93"=>"\u06AF",
"\uFB94"=>"\u06AF",
"\uFB95"=>"\u06AF",
"\uFB96"=>"\u06B3",
"\uFB97"=>"\u06B3",
"\uFB98"=>"\u06B3",
"\uFB99"=>"\u06B3",
"\uFB9A"=>"\u06B1",
"\uFB9B"=>"\u06B1",
"\uFB9C"=>"\u06B1",
"\uFB9D"=>"\u06B1",
"\uFB9E"=>"\u06BA",
"\uFB9F"=>"\u06BA",
"\uFBA0"=>"\u06BB",
"\uFBA1"=>"\u06BB",
"\uFBA2"=>"\u06BB",
"\uFBA3"=>"\u06BB",
"\uFBA4"=>"\u06C0",
"\uFBA5"=>"\u06C0",
"\uFBA6"=>"\u06C1",
"\uFBA7"=>"\u06C1",
"\uFBA8"=>"\u06C1",
"\uFBA9"=>"\u06C1",
"\uFBAA"=>"\u06BE",
"\uFBAB"=>"\u06BE",
"\uFBAC"=>"\u06BE",
"\uFBAD"=>"\u06BE",
"\uFBAE"=>"\u06D2",
"\uFBAF"=>"\u06D2",
"\uFBB0"=>"\u06D3",
"\uFBB1"=>"\u06D3",
"\uFBD3"=>"\u06AD",
"\uFBD4"=>"\u06AD",
"\uFBD5"=>"\u06AD",
"\uFBD6"=>"\u06AD",
"\uFBD7"=>"\u06C7",
"\uFBD8"=>"\u06C7",
"\uFBD9"=>"\u06C6",
"\uFBDA"=>"\u06C6",
"\uFBDB"=>"\u06C8",
"\uFBDC"=>"\u06C8",
"\uFBDD"=>"\u06C7\u0674",
"\uFBDE"=>"\u06CB",
"\uFBDF"=>"\u06CB",
"\uFBE0"=>"\u06C5",
"\uFBE1"=>"\u06C5",
"\uFBE2"=>"\u06C9",
"\uFBE3"=>"\u06C9",
"\uFBE4"=>"\u06D0",
"\uFBE5"=>"\u06D0",
"\uFBE6"=>"\u06D0",
"\uFBE7"=>"\u06D0",
"\uFBE8"=>"\u0649",
"\uFBE9"=>"\u0649",
"\uFBEA"=>"\u0626\u0627",
"\uFBEB"=>"\u0626\u0627",
"\uFBEC"=>"\u0626\u06D5",
"\uFBED"=>"\u0626\u06D5",
"\uFBEE"=>"\u0626\u0648",
"\uFBEF"=>"\u0626\u0648",
"\uFBF0"=>"\u0626\u06C7",
"\uFBF1"=>"\u0626\u06C7",
"\uFBF2"=>"\u0626\u06C6",
"\uFBF3"=>"\u0626\u06C6",
"\uFBF4"=>"\u0626\u06C8",
"\uFBF5"=>"\u0626\u06C8",
"\uFBF6"=>"\u0626\u06D0",
"\uFBF7"=>"\u0626\u06D0",
"\uFBF8"=>"\u0626\u06D0",
"\uFBF9"=>"\u0626\u0649",
"\uFBFA"=>"\u0626\u0649",
"\uFBFB"=>"\u0626\u0649",
"\uFBFC"=>"\u06CC",
"\uFBFD"=>"\u06CC",
"\uFBFE"=>"\u06CC",
"\uFBFF"=>"\u06CC",
"\uFC00"=>"\u0626\u062C",
"\uFC01"=>"\u0626\u062D",
"\uFC02"=>"\u0626\u0645",
"\uFC03"=>"\u0626\u0649",
"\uFC04"=>"\u0626\u064A",
"\uFC05"=>"\u0628\u062C",
"\uFC06"=>"\u0628\u062D",
"\uFC07"=>"\u0628\u062E",
"\uFC08"=>"\u0628\u0645",
"\uFC09"=>"\u0628\u0649",
"\uFC0A"=>"\u0628\u064A",
"\uFC0B"=>"\u062A\u062C",
"\uFC0C"=>"\u062A\u062D",
"\uFC0D"=>"\u062A\u062E",
"\uFC0E"=>"\u062A\u0645",
"\uFC0F"=>"\u062A\u0649",
"\uFC10"=>"\u062A\u064A",
"\uFC11"=>"\u062B\u062C",
"\uFC12"=>"\u062B\u0645",
"\uFC13"=>"\u062B\u0649",
"\uFC14"=>"\u062B\u064A",
"\uFC15"=>"\u062C\u062D",
"\uFC16"=>"\u062C\u0645",
"\uFC17"=>"\u062D\u062C",
"\uFC18"=>"\u062D\u0645",
"\uFC19"=>"\u062E\u062C",
"\uFC1A"=>"\u062E\u062D",
"\uFC1B"=>"\u062E\u0645",
"\uFC1C"=>"\u0633\u062C",
"\uFC1D"=>"\u0633\u062D",
"\uFC1E"=>"\u0633\u062E",
"\uFC1F"=>"\u0633\u0645",
"\uFC20"=>"\u0635\u062D",
"\uFC21"=>"\u0635\u0645",
"\uFC22"=>"\u0636\u062C",
"\uFC23"=>"\u0636\u062D",
"\uFC24"=>"\u0636\u062E",
"\uFC25"=>"\u0636\u0645",
"\uFC26"=>"\u0637\u062D",
"\uFC27"=>"\u0637\u0645",
"\uFC28"=>"\u0638\u0645",
"\uFC29"=>"\u0639\u062C",
"\uFC2A"=>"\u0639\u0645",
"\uFC2B"=>"\u063A\u062C",
"\uFC2C"=>"\u063A\u0645",
"\uFC2D"=>"\u0641\u062C",
"\uFC2E"=>"\u0641\u062D",
"\uFC2F"=>"\u0641\u062E",
"\uFC30"=>"\u0641\u0645",
"\uFC31"=>"\u0641\u0649",
"\uFC32"=>"\u0641\u064A",
"\uFC33"=>"\u0642\u062D",
"\uFC34"=>"\u0642\u0645",
"\uFC35"=>"\u0642\u0649",
"\uFC36"=>"\u0642\u064A",
"\uFC37"=>"\u0643\u0627",
"\uFC38"=>"\u0643\u062C",
"\uFC39"=>"\u0643\u062D",
"\uFC3A"=>"\u0643\u062E",
"\uFC3B"=>"\u0643\u0644",
"\uFC3C"=>"\u0643\u0645",
"\uFC3D"=>"\u0643\u0649",
"\uFC3E"=>"\u0643\u064A",
"\uFC3F"=>"\u0644\u062C",
"\uFC40"=>"\u0644\u062D",
"\uFC41"=>"\u0644\u062E",
"\uFC42"=>"\u0644\u0645",
"\uFC43"=>"\u0644\u0649",
"\uFC44"=>"\u0644\u064A",
"\uFC45"=>"\u0645\u062C",
"\uFC46"=>"\u0645\u062D",
"\uFC47"=>"\u0645\u062E",
"\uFC48"=>"\u0645\u0645",
"\uFC49"=>"\u0645\u0649",
"\uFC4A"=>"\u0645\u064A",
"\uFC4B"=>"\u0646\u062C",
"\uFC4C"=>"\u0646\u062D",
"\uFC4D"=>"\u0646\u062E",
"\uFC4E"=>"\u0646\u0645",
"\uFC4F"=>"\u0646\u0649",
"\uFC50"=>"\u0646\u064A",
"\uFC51"=>"\u0647\u062C",
"\uFC52"=>"\u0647\u0645",
"\uFC53"=>"\u0647\u0649",
"\uFC54"=>"\u0647\u064A",
"\uFC55"=>"\u064A\u062C",
"\uFC56"=>"\u064A\u062D",
"\uFC57"=>"\u064A\u062E",
"\uFC58"=>"\u064A\u0645",
"\uFC59"=>"\u064A\u0649",
"\uFC5A"=>"\u064A\u064A",
"\uFC5B"=>"\u0630\u0670",
"\uFC5C"=>"\u0631\u0670",
"\uFC5D"=>"\u0649\u0670",
"\uFC5E"=>" \u064C\u0651",
"\uFC5F"=>" \u064D\u0651",
"\uFC60"=>" \u064E\u0651",
"\uFC61"=>" \u064F\u0651",
"\uFC62"=>" \u0650\u0651",
"\uFC63"=>" \u0651\u0670",
"\uFC64"=>"\u0626\u0631",
"\uFC65"=>"\u0626\u0632",
"\uFC66"=>"\u0626\u0645",
"\uFC67"=>"\u0626\u0646",
"\uFC68"=>"\u0626\u0649",
"\uFC69"=>"\u0626\u064A",
"\uFC6A"=>"\u0628\u0631",
"\uFC6B"=>"\u0628\u0632",
"\uFC6C"=>"\u0628\u0645",
"\uFC6D"=>"\u0628\u0646",
"\uFC6E"=>"\u0628\u0649",
"\uFC6F"=>"\u0628\u064A",
"\uFC70"=>"\u062A\u0631",
"\uFC71"=>"\u062A\u0632",
"\uFC72"=>"\u062A\u0645",
"\uFC73"=>"\u062A\u0646",
"\uFC74"=>"\u062A\u0649",
"\uFC75"=>"\u062A\u064A",
"\uFC76"=>"\u062B\u0631",
"\uFC77"=>"\u062B\u0632",
"\uFC78"=>"\u062B\u0645",
"\uFC79"=>"\u062B\u0646",
"\uFC7A"=>"\u062B\u0649",
"\uFC7B"=>"\u062B\u064A",
"\uFC7C"=>"\u0641\u0649",
"\uFC7D"=>"\u0641\u064A",
"\uFC7E"=>"\u0642\u0649",
"\uFC7F"=>"\u0642\u064A",
"\uFC80"=>"\u0643\u0627",
"\uFC81"=>"\u0643\u0644",
"\uFC82"=>"\u0643\u0645",
"\uFC83"=>"\u0643\u0649",
"\uFC84"=>"\u0643\u064A",
"\uFC85"=>"\u0644\u0645",
"\uFC86"=>"\u0644\u0649",
"\uFC87"=>"\u0644\u064A",
"\uFC88"=>"\u0645\u0627",
"\uFC89"=>"\u0645\u0645",
"\uFC8A"=>"\u0646\u0631",
"\uFC8B"=>"\u0646\u0632",
"\uFC8C"=>"\u0646\u0645",
"\uFC8D"=>"\u0646\u0646",
"\uFC8E"=>"\u0646\u0649",
"\uFC8F"=>"\u0646\u064A",
"\uFC90"=>"\u0649\u0670",
"\uFC91"=>"\u064A\u0631",
"\uFC92"=>"\u064A\u0632",
"\uFC93"=>"\u064A\u0645",
"\uFC94"=>"\u064A\u0646",
"\uFC95"=>"\u064A\u0649",
"\uFC96"=>"\u064A\u064A",
"\uFC97"=>"\u0626\u062C",
"\uFC98"=>"\u0626\u062D",
"\uFC99"=>"\u0626\u062E",
"\uFC9A"=>"\u0626\u0645",
"\uFC9B"=>"\u0626\u0647",
"\uFC9C"=>"\u0628\u062C",
"\uFC9D"=>"\u0628\u062D",
"\uFC9E"=>"\u0628\u062E",
"\uFC9F"=>"\u0628\u0645",
"\uFCA0"=>"\u0628\u0647",
"\uFCA1"=>"\u062A\u062C",
"\uFCA2"=>"\u062A\u062D",
"\uFCA3"=>"\u062A\u062E",
"\uFCA4"=>"\u062A\u0645",
"\uFCA5"=>"\u062A\u0647",
"\uFCA6"=>"\u062B\u0645",
"\uFCA7"=>"\u062C\u062D",
"\uFCA8"=>"\u062C\u0645",
"\uFCA9"=>"\u062D\u062C",
"\uFCAA"=>"\u062D\u0645",
"\uFCAB"=>"\u062E\u062C",
"\uFCAC"=>"\u062E\u0645",
"\uFCAD"=>"\u0633\u062C",
"\uFCAE"=>"\u0633\u062D",
"\uFCAF"=>"\u0633\u062E",
"\uFCB0"=>"\u0633\u0645",
"\uFCB1"=>"\u0635\u062D",
"\uFCB2"=>"\u0635\u062E",
"\uFCB3"=>"\u0635\u0645",
"\uFCB4"=>"\u0636\u062C",
"\uFCB5"=>"\u0636\u062D",
"\uFCB6"=>"\u0636\u062E",
"\uFCB7"=>"\u0636\u0645",
"\uFCB8"=>"\u0637\u062D",
"\uFCB9"=>"\u0638\u0645",
"\uFCBA"=>"\u0639\u062C",
"\uFCBB"=>"\u0639\u0645",
"\uFCBC"=>"\u063A\u062C",
"\uFCBD"=>"\u063A\u0645",
"\uFCBE"=>"\u0641\u062C",
"\uFCBF"=>"\u0641\u062D",
"\uFCC0"=>"\u0641\u062E",
"\uFCC1"=>"\u0641\u0645",
"\uFCC2"=>"\u0642\u062D",
"\uFCC3"=>"\u0642\u0645",
"\uFCC4"=>"\u0643\u062C",
"\uFCC5"=>"\u0643\u062D",
"\uFCC6"=>"\u0643\u062E",
"\uFCC7"=>"\u0643\u0644",
"\uFCC8"=>"\u0643\u0645",
"\uFCC9"=>"\u0644\u062C",
"\uFCCA"=>"\u0644\u062D",
"\uFCCB"=>"\u0644\u062E",
"\uFCCC"=>"\u0644\u0645",
"\uFCCD"=>"\u0644\u0647",
"\uFCCE"=>"\u0645\u062C",
"\uFCCF"=>"\u0645\u062D",
"\uFCD0"=>"\u0645\u062E",
"\uFCD1"=>"\u0645\u0645",
"\uFCD2"=>"\u0646\u062C",
"\uFCD3"=>"\u0646\u062D",
"\uFCD4"=>"\u0646\u062E",
"\uFCD5"=>"\u0646\u0645",
"\uFCD6"=>"\u0646\u0647",
"\uFCD7"=>"\u0647\u062C",
"\uFCD8"=>"\u0647\u0645",
"\uFCD9"=>"\u0647\u0670",
"\uFCDA"=>"\u064A\u062C",
"\uFCDB"=>"\u064A\u062D",
"\uFCDC"=>"\u064A\u062E",
"\uFCDD"=>"\u064A\u0645",
"\uFCDE"=>"\u064A\u0647",
"\uFCDF"=>"\u0626\u0645",
"\uFCE0"=>"\u0626\u0647",
"\uFCE1"=>"\u0628\u0645",
"\uFCE2"=>"\u0628\u0647",
"\uFCE3"=>"\u062A\u0645",
"\uFCE4"=>"\u062A\u0647",
"\uFCE5"=>"\u062B\u0645",
"\uFCE6"=>"\u062B\u0647",
"\uFCE7"=>"\u0633\u0645",
"\uFCE8"=>"\u0633\u0647",
"\uFCE9"=>"\u0634\u0645",
"\uFCEA"=>"\u0634\u0647",
"\uFCEB"=>"\u0643\u0644",
"\uFCEC"=>"\u0643\u0645",
"\uFCED"=>"\u0644\u0645",
"\uFCEE"=>"\u0646\u0645",
"\uFCEF"=>"\u0646\u0647",
"\uFCF0"=>"\u064A\u0645",
"\uFCF1"=>"\u064A\u0647",
"\uFCF2"=>"\u0640\u064E\u0651",
"\uFCF3"=>"\u0640\u064F\u0651",
"\uFCF4"=>"\u0640\u0650\u0651",
"\uFCF5"=>"\u0637\u0649",
"\uFCF6"=>"\u0637\u064A",
"\uFCF7"=>"\u0639\u0649",
"\uFCF8"=>"\u0639\u064A",
"\uFCF9"=>"\u063A\u0649",
"\uFCFA"=>"\u063A\u064A",
"\uFCFB"=>"\u0633\u0649",
"\uFCFC"=>"\u0633\u064A",
"\uFCFD"=>"\u0634\u0649",
"\uFCFE"=>"\u0634\u064A",
"\uFCFF"=>"\u062D\u0649",
"\uFD00"=>"\u062D\u064A",
"\uFD01"=>"\u062C\u0649",
"\uFD02"=>"\u062C\u064A",
"\uFD03"=>"\u062E\u0649",
"\uFD04"=>"\u062E\u064A",
"\uFD05"=>"\u0635\u0649",
"\uFD06"=>"\u0635\u064A",
"\uFD07"=>"\u0636\u0649",
"\uFD08"=>"\u0636\u064A",
"\uFD09"=>"\u0634\u062C",
"\uFD0A"=>"\u0634\u062D",
"\uFD0B"=>"\u0634\u062E",
"\uFD0C"=>"\u0634\u0645",
"\uFD0D"=>"\u0634\u0631",
"\uFD0E"=>"\u0633\u0631",
"\uFD0F"=>"\u0635\u0631",
"\uFD10"=>"\u0636\u0631",
"\uFD11"=>"\u0637\u0649",
"\uFD12"=>"\u0637\u064A",
"\uFD13"=>"\u0639\u0649",
"\uFD14"=>"\u0639\u064A",
"\uFD15"=>"\u063A\u0649",
"\uFD16"=>"\u063A\u064A",
"\uFD17"=>"\u0633\u0649",
"\uFD18"=>"\u0633\u064A",
"\uFD19"=>"\u0634\u0649",
"\uFD1A"=>"\u0634\u064A",
"\uFD1B"=>"\u062D\u0649",
"\uFD1C"=>"\u062D\u064A",
"\uFD1D"=>"\u062C\u0649",
"\uFD1E"=>"\u062C\u064A",
"\uFD1F"=>"\u062E\u0649",
"\uFD20"=>"\u062E\u064A",
"\uFD21"=>"\u0635\u0649",
"\uFD22"=>"\u0635\u064A",
"\uFD23"=>"\u0636\u0649",
"\uFD24"=>"\u0636\u064A",
"\uFD25"=>"\u0634\u062C",
"\uFD26"=>"\u0634\u062D",
"\uFD27"=>"\u0634\u062E",
"\uFD28"=>"\u0634\u0645",
"\uFD29"=>"\u0634\u0631",
"\uFD2A"=>"\u0633\u0631",
"\uFD2B"=>"\u0635\u0631",
"\uFD2C"=>"\u0636\u0631",
"\uFD2D"=>"\u0634\u062C",
"\uFD2E"=>"\u0634\u062D",
"\uFD2F"=>"\u0634\u062E",
"\uFD30"=>"\u0634\u0645",
"\uFD31"=>"\u0633\u0647",
"\uFD32"=>"\u0634\u0647",
"\uFD33"=>"\u0637\u0645",
"\uFD34"=>"\u0633\u062C",
"\uFD35"=>"\u0633\u062D",
"\uFD36"=>"\u0633\u062E",
"\uFD37"=>"\u0634\u062C",
"\uFD38"=>"\u0634\u062D",
"\uFD39"=>"\u0634\u062E",
"\uFD3A"=>"\u0637\u0645",
"\uFD3B"=>"\u0638\u0645",
"\uFD3C"=>"\u0627\u064B",
"\uFD3D"=>"\u0627\u064B",
"\uFD50"=>"\u062A\u062C\u0645",
"\uFD51"=>"\u062A\u062D\u062C",
"\uFD52"=>"\u062A\u062D\u062C",
"\uFD53"=>"\u062A\u062D\u0645",
"\uFD54"=>"\u062A\u062E\u0645",
"\uFD55"=>"\u062A\u0645\u062C",
"\uFD56"=>"\u062A\u0645\u062D",
"\uFD57"=>"\u062A\u0645\u062E",
"\uFD58"=>"\u062C\u0645\u062D",
"\uFD59"=>"\u062C\u0645\u062D",
"\uFD5A"=>"\u062D\u0645\u064A",
"\uFD5B"=>"\u062D\u0645\u0649",
"\uFD5C"=>"\u0633\u062D\u062C",
"\uFD5D"=>"\u0633\u062C\u062D",
"\uFD5E"=>"\u0633\u062C\u0649",
"\uFD5F"=>"\u0633\u0645\u062D",
"\uFD60"=>"\u0633\u0645\u062D",
"\uFD61"=>"\u0633\u0645\u062C",
"\uFD62"=>"\u0633\u0645\u0645",
"\uFD63"=>"\u0633\u0645\u0645",
"\uFD64"=>"\u0635\u062D\u062D",
"\uFD65"=>"\u0635\u062D\u062D",
"\uFD66"=>"\u0635\u0645\u0645",
"\uFD67"=>"\u0634\u062D\u0645",
"\uFD68"=>"\u0634\u062D\u0645",
"\uFD69"=>"\u0634\u062C\u064A",
"\uFD6A"=>"\u0634\u0645\u062E",
"\uFD6B"=>"\u0634\u0645\u062E",
"\uFD6C"=>"\u0634\u0645\u0645",
"\uFD6D"=>"\u0634\u0645\u0645",
"\uFD6E"=>"\u0636\u062D\u0649",
"\uFD6F"=>"\u0636\u062E\u0645",
"\uFD70"=>"\u0636\u062E\u0645",
"\uFD71"=>"\u0637\u0645\u062D",
"\uFD72"=>"\u0637\u0645\u062D",
"\uFD73"=>"\u0637\u0645\u0645",
"\uFD74"=>"\u0637\u0645\u064A",
"\uFD75"=>"\u0639\u062C\u0645",
"\uFD76"=>"\u0639\u0645\u0645",
"\uFD77"=>"\u0639\u0645\u0645",
"\uFD78"=>"\u0639\u0645\u0649",
"\uFD79"=>"\u063A\u0645\u0645",
"\uFD7A"=>"\u063A\u0645\u064A",
"\uFD7B"=>"\u063A\u0645\u0649",
"\uFD7C"=>"\u0641\u062E\u0645",
"\uFD7D"=>"\u0641\u062E\u0645",
"\uFD7E"=>"\u0642\u0645\u062D",
"\uFD7F"=>"\u0642\u0645\u0645",
"\uFD80"=>"\u0644\u062D\u0645",
"\uFD81"=>"\u0644\u062D\u064A",
"\uFD82"=>"\u0644\u062D\u0649",
"\uFD83"=>"\u0644\u062C\u062C",
"\uFD84"=>"\u0644\u062C\u062C",
"\uFD85"=>"\u0644\u062E\u0645",
"\uFD86"=>"\u0644\u062E\u0645",
"\uFD87"=>"\u0644\u0645\u062D",
"\uFD88"=>"\u0644\u0645\u062D",
"\uFD89"=>"\u0645\u062D\u062C",
"\uFD8A"=>"\u0645\u062D\u0645",
"\uFD8B"=>"\u0645\u062D\u064A",
"\uFD8C"=>"\u0645\u062C\u062D",
"\uFD8D"=>"\u0645\u062C\u0645",
"\uFD8E"=>"\u0645\u062E\u062C",
"\uFD8F"=>"\u0645\u062E\u0645",
"\uFD92"=>"\u0645\u062C\u062E",
"\uFD93"=>"\u0647\u0645\u062C",
"\uFD94"=>"\u0647\u0645\u0645",
"\uFD95"=>"\u0646\u062D\u0645",
"\uFD96"=>"\u0646\u062D\u0649",
"\uFD97"=>"\u0646\u062C\u0645",
"\uFD98"=>"\u0646\u062C\u0645",
"\uFD99"=>"\u0646\u062C\u0649",
"\uFD9A"=>"\u0646\u0645\u064A",
"\uFD9B"=>"\u0646\u0645\u0649",
"\uFD9C"=>"\u064A\u0645\u0645",
"\uFD9D"=>"\u064A\u0645\u0645",
"\uFD9E"=>"\u0628\u062E\u064A",
"\uFD9F"=>"\u062A\u062C\u064A",
"\uFDA0"=>"\u062A\u062C\u0649",
"\uFDA1"=>"\u062A\u062E\u064A",
"\uFDA2"=>"\u062A\u062E\u0649",
"\uFDA3"=>"\u062A\u0645\u064A",
"\uFDA4"=>"\u062A\u0645\u0649",
"\uFDA5"=>"\u062C\u0645\u064A",
"\uFDA6"=>"\u062C\u062D\u0649",
"\uFDA7"=>"\u062C\u0645\u0649",
"\uFDA8"=>"\u0633\u062E\u0649",
"\uFDA9"=>"\u0635\u062D\u064A",
"\uFDAA"=>"\u0634\u062D\u064A",
"\uFDAB"=>"\u0636\u062D\u064A",
"\uFDAC"=>"\u0644\u062C\u064A",
"\uFDAD"=>"\u0644\u0645\u064A",
"\uFDAE"=>"\u064A\u062D\u064A",
"\uFDAF"=>"\u064A\u062C\u064A",
"\uFDB0"=>"\u064A\u0645\u064A",
"\uFDB1"=>"\u0645\u0645\u064A",
"\uFDB2"=>"\u0642\u0645\u064A",
"\uFDB3"=>"\u0646\u062D\u064A",
"\uFDB4"=>"\u0642\u0645\u062D",
"\uFDB5"=>"\u0644\u062D\u0645",
"\uFDB6"=>"\u0639\u0645\u064A",
"\uFDB7"=>"\u0643\u0645\u064A",
"\uFDB8"=>"\u0646\u062C\u062D",
"\uFDB9"=>"\u0645\u062E\u064A",
"\uFDBA"=>"\u0644\u062C\u0645",
"\uFDBB"=>"\u0643\u0645\u0645",
"\uFDBC"=>"\u0644\u062C\u0645",
"\uFDBD"=>"\u0646\u062C\u062D",
"\uFDBE"=>"\u062C\u062D\u064A",
"\uFDBF"=>"\u062D\u062C\u064A",
"\uFDC0"=>"\u0645\u062C\u064A",
"\uFDC1"=>"\u0641\u0645\u064A",
"\uFDC2"=>"\u0628\u062D\u064A",
"\uFDC3"=>"\u0643\u0645\u0645",
"\uFDC4"=>"\u0639\u062C\u0645",
"\uFDC5"=>"\u0635\u0645\u0645",
"\uFDC6"=>"\u0633\u062E\u064A",
"\uFDC7"=>"\u0646\u062C\u064A",
"\uFDF0"=>"\u0635\u0644\u06D2",
"\uFDF1"=>"\u0642\u0644\u06D2",
"\uFDF2"=>"\u0627\u0644\u0644\u0647",
"\uFDF3"=>"\u0627\u0643\u0628\u0631",
"\uFDF4"=>"\u0645\u062D\u0645\u062F",
"\uFDF5"=>"\u0635\u0644\u0639\u0645",
"\uFDF6"=>"\u0631\u0633\u0648\u0644",
"\uFDF7"=>"\u0639\u0644\u064A\u0647",
"\uFDF8"=>"\u0648\u0633\u0644\u0645",
"\uFDF9"=>"\u0635\u0644\u0649",
"\uFDFA"=>"\u0635\u0644\u0649 \u0627\u0644\u0644\u0647 \u0639\u0644\u064A\u0647 \u0648\u0633\u0644\u0645",
"\uFDFB"=>"\u062C\u0644 \u062C\u0644\u0627\u0644\u0647",
"\uFDFC"=>"\u0631\u06CC\u0627\u0644",
"\uFE10"=>",",
"\uFE11"=>"\u3001",
"\uFE12"=>"\u3002",
"\uFE13"=>":",
"\uFE14"=>";",
"\uFE15"=>"!",
"\uFE16"=>"?",
"\uFE17"=>"\u3016",
"\uFE18"=>"\u3017",
"\uFE19"=>"...",
"\uFE30"=>"..",
"\uFE31"=>"\u2014",
"\uFE32"=>"\u2013",
"\uFE33"=>"_",
"\uFE34"=>"_",
"\uFE35"=>"(",
"\uFE36"=>")",
"\uFE37"=>"{",
"\uFE38"=>"}",
"\uFE39"=>"\u3014",
"\uFE3A"=>"\u3015",
"\uFE3B"=>"\u3010",
"\uFE3C"=>"\u3011",
"\uFE3D"=>"\u300A",
"\uFE3E"=>"\u300B",
"\uFE3F"=>"\u3008",
"\uFE40"=>"\u3009",
"\uFE41"=>"\u300C",
"\uFE42"=>"\u300D",
"\uFE43"=>"\u300E",
"\uFE44"=>"\u300F",
"\uFE47"=>"[",
"\uFE48"=>"]",
"\uFE49"=>" \u0305",
"\uFE4A"=>" \u0305",
"\uFE4B"=>" \u0305",
"\uFE4C"=>" \u0305",
"\uFE4D"=>"_",
"\uFE4E"=>"_",
"\uFE4F"=>"_",
"\uFE50"=>",",
"\uFE51"=>"\u3001",
"\uFE52"=>".",
"\uFE54"=>";",
"\uFE55"=>":",
"\uFE56"=>"?",
"\uFE57"=>"!",
"\uFE58"=>"\u2014",
"\uFE59"=>"(",
"\uFE5A"=>")",
"\uFE5B"=>"{",
"\uFE5C"=>"}",
"\uFE5D"=>"\u3014",
"\uFE5E"=>"\u3015",
"\uFE5F"=>"#",
"\uFE60"=>"&",
"\uFE61"=>"*",
"\uFE62"=>"+",
"\uFE63"=>"-",
"\uFE64"=>"<",
"\uFE65"=>">",
"\uFE66"=>"=",
"\uFE68"=>"\\",
"\uFE69"=>"$",
"\uFE6A"=>"%",
"\uFE6B"=>"@",
"\uFE70"=>" \u064B",
"\uFE71"=>"\u0640\u064B",
"\uFE72"=>" \u064C",
"\uFE74"=>" \u064D",
"\uFE76"=>" \u064E",
"\uFE77"=>"\u0640\u064E",
"\uFE78"=>" \u064F",
"\uFE79"=>"\u0640\u064F",
"\uFE7A"=>" \u0650",
"\uFE7B"=>"\u0640\u0650",
"\uFE7C"=>" \u0651",
"\uFE7D"=>"\u0640\u0651",
"\uFE7E"=>" \u0652",
"\uFE7F"=>"\u0640\u0652",
"\uFE80"=>"\u0621",
"\uFE81"=>"\u0622",
"\uFE82"=>"\u0622",
"\uFE83"=>"\u0623",
"\uFE84"=>"\u0623",
"\uFE85"=>"\u0624",
"\uFE86"=>"\u0624",
"\uFE87"=>"\u0625",
"\uFE88"=>"\u0625",
"\uFE89"=>"\u0626",
"\uFE8A"=>"\u0626",
"\uFE8B"=>"\u0626",
"\uFE8C"=>"\u0626",
"\uFE8D"=>"\u0627",
"\uFE8E"=>"\u0627",
"\uFE8F"=>"\u0628",
"\uFE90"=>"\u0628",
"\uFE91"=>"\u0628",
"\uFE92"=>"\u0628",
"\uFE93"=>"\u0629",
"\uFE94"=>"\u0629",
"\uFE95"=>"\u062A",
"\uFE96"=>"\u062A",
"\uFE97"=>"\u062A",
"\uFE98"=>"\u062A",
"\uFE99"=>"\u062B",
"\uFE9A"=>"\u062B",
"\uFE9B"=>"\u062B",
"\uFE9C"=>"\u062B",
"\uFE9D"=>"\u062C",
"\uFE9E"=>"\u062C",
"\uFE9F"=>"\u062C",
"\uFEA0"=>"\u062C",
"\uFEA1"=>"\u062D",
"\uFEA2"=>"\u062D",
"\uFEA3"=>"\u062D",
"\uFEA4"=>"\u062D",
"\uFEA5"=>"\u062E",
"\uFEA6"=>"\u062E",
"\uFEA7"=>"\u062E",
"\uFEA8"=>"\u062E",
"\uFEA9"=>"\u062F",
"\uFEAA"=>"\u062F",
"\uFEAB"=>"\u0630",
"\uFEAC"=>"\u0630",
"\uFEAD"=>"\u0631",
"\uFEAE"=>"\u0631",
"\uFEAF"=>"\u0632",
"\uFEB0"=>"\u0632",
"\uFEB1"=>"\u0633",
"\uFEB2"=>"\u0633",
"\uFEB3"=>"\u0633",
"\uFEB4"=>"\u0633",
"\uFEB5"=>"\u0634",
"\uFEB6"=>"\u0634",
"\uFEB7"=>"\u0634",
"\uFEB8"=>"\u0634",
"\uFEB9"=>"\u0635",
"\uFEBA"=>"\u0635",
"\uFEBB"=>"\u0635",
"\uFEBC"=>"\u0635",
"\uFEBD"=>"\u0636",
"\uFEBE"=>"\u0636",
"\uFEBF"=>"\u0636",
"\uFEC0"=>"\u0636",
"\uFEC1"=>"\u0637",
"\uFEC2"=>"\u0637",
"\uFEC3"=>"\u0637",
"\uFEC4"=>"\u0637",
"\uFEC5"=>"\u0638",
"\uFEC6"=>"\u0638",
"\uFEC7"=>"\u0638",
"\uFEC8"=>"\u0638",
"\uFEC9"=>"\u0639",
"\uFECA"=>"\u0639",
"\uFECB"=>"\u0639",
"\uFECC"=>"\u0639",
"\uFECD"=>"\u063A",
"\uFECE"=>"\u063A",
"\uFECF"=>"\u063A",
"\uFED0"=>"\u063A",
"\uFED1"=>"\u0641",
"\uFED2"=>"\u0641",
"\uFED3"=>"\u0641",
"\uFED4"=>"\u0641",
"\uFED5"=>"\u0642",
"\uFED6"=>"\u0642",
"\uFED7"=>"\u0642",
"\uFED8"=>"\u0642",
"\uFED9"=>"\u0643",
"\uFEDA"=>"\u0643",
"\uFEDB"=>"\u0643",
"\uFEDC"=>"\u0643",
"\uFEDD"=>"\u0644",
"\uFEDE"=>"\u0644",
"\uFEDF"=>"\u0644",
"\uFEE0"=>"\u0644",
"\uFEE1"=>"\u0645",
"\uFEE2"=>"\u0645",
"\uFEE3"=>"\u0645",
"\uFEE4"=>"\u0645",
"\uFEE5"=>"\u0646",
"\uFEE6"=>"\u0646",
"\uFEE7"=>"\u0646",
"\uFEE8"=>"\u0646",
"\uFEE9"=>"\u0647",
"\uFEEA"=>"\u0647",
"\uFEEB"=>"\u0647",
"\uFEEC"=>"\u0647",
"\uFEED"=>"\u0648",
"\uFEEE"=>"\u0648",
"\uFEEF"=>"\u0649",
"\uFEF0"=>"\u0649",
"\uFEF1"=>"\u064A",
"\uFEF2"=>"\u064A",
"\uFEF3"=>"\u064A",
"\uFEF4"=>"\u064A",
"\uFEF5"=>"\u0644\u0622",
"\uFEF6"=>"\u0644\u0622",
"\uFEF7"=>"\u0644\u0623",
"\uFEF8"=>"\u0644\u0623",
"\uFEF9"=>"\u0644\u0625",
"\uFEFA"=>"\u0644\u0625",
"\uFEFB"=>"\u0644\u0627",
"\uFEFC"=>"\u0644\u0627",
"\uFF01"=>"!",
"\uFF02"=>"\"",
"\uFF03"=>"#",
"\uFF04"=>"$",
"\uFF05"=>"%",
"\uFF06"=>"&",
"\uFF07"=>"'",
"\uFF08"=>"(",
"\uFF09"=>")",
"\uFF0A"=>"*",
"\uFF0B"=>"+",
"\uFF0C"=>",",
"\uFF0D"=>"-",
"\uFF0E"=>".",
"\uFF0F"=>"/",
"\uFF10"=>"0",
"\uFF11"=>"1",
"\uFF12"=>"2",
"\uFF13"=>"3",
"\uFF14"=>"4",
"\uFF15"=>"5",
"\uFF16"=>"6",
"\uFF17"=>"7",
"\uFF18"=>"8",
"\uFF19"=>"9",
"\uFF1A"=>":",
"\uFF1B"=>";",
"\uFF1C"=>"<",
"\uFF1D"=>"=",
"\uFF1E"=>">",
"\uFF1F"=>"?",
"\uFF20"=>"@",
"\uFF21"=>"A",
"\uFF22"=>"B",
"\uFF23"=>"C",
"\uFF24"=>"D",
"\uFF25"=>"E",
"\uFF26"=>"F",
"\uFF27"=>"G",
"\uFF28"=>"H",
"\uFF29"=>"I",
"\uFF2A"=>"J",
"\uFF2B"=>"K",
"\uFF2C"=>"L",
"\uFF2D"=>"M",
"\uFF2E"=>"N",
"\uFF2F"=>"O",
"\uFF30"=>"P",
"\uFF31"=>"Q",
"\uFF32"=>"R",
"\uFF33"=>"S",
"\uFF34"=>"T",
"\uFF35"=>"U",
"\uFF36"=>"V",
"\uFF37"=>"W",
"\uFF38"=>"X",
"\uFF39"=>"Y",
"\uFF3A"=>"Z",
"\uFF3B"=>"[",
"\uFF3C"=>"\\",
"\uFF3D"=>"]",
"\uFF3E"=>"^",
"\uFF3F"=>"_",
"\uFF40"=>"`",
"\uFF41"=>"a",
"\uFF42"=>"b",
"\uFF43"=>"c",
"\uFF44"=>"d",
"\uFF45"=>"e",
"\uFF46"=>"f",
"\uFF47"=>"g",
"\uFF48"=>"h",
"\uFF49"=>"i",
"\uFF4A"=>"j",
"\uFF4B"=>"k",
"\uFF4C"=>"l",
"\uFF4D"=>"m",
"\uFF4E"=>"n",
"\uFF4F"=>"o",
"\uFF50"=>"p",
"\uFF51"=>"q",
"\uFF52"=>"r",
"\uFF53"=>"s",
"\uFF54"=>"t",
"\uFF55"=>"u",
"\uFF56"=>"v",
"\uFF57"=>"w",
"\uFF58"=>"x",
"\uFF59"=>"y",
"\uFF5A"=>"z",
"\uFF5B"=>"{",
"\uFF5C"=>"|",
"\uFF5D"=>"}",
"\uFF5E"=>"~",
"\uFF5F"=>"\u2985",
"\uFF60"=>"\u2986",
"\uFF61"=>"\u3002",
"\uFF62"=>"\u300C",
"\uFF63"=>"\u300D",
"\uFF64"=>"\u3001",
"\uFF65"=>"\u30FB",
"\uFF66"=>"\u30F2",
"\uFF67"=>"\u30A1",
"\uFF68"=>"\u30A3",
"\uFF69"=>"\u30A5",
"\uFF6A"=>"\u30A7",
"\uFF6B"=>"\u30A9",
"\uFF6C"=>"\u30E3",
"\uFF6D"=>"\u30E5",
"\uFF6E"=>"\u30E7",
"\uFF6F"=>"\u30C3",
"\uFF70"=>"\u30FC",
"\uFF71"=>"\u30A2",
"\uFF72"=>"\u30A4",
"\uFF73"=>"\u30A6",
"\uFF74"=>"\u30A8",
"\uFF75"=>"\u30AA",
"\uFF76"=>"\u30AB",
"\uFF77"=>"\u30AD",
"\uFF78"=>"\u30AF",
"\uFF79"=>"\u30B1",
"\uFF7A"=>"\u30B3",
"\uFF7B"=>"\u30B5",
"\uFF7C"=>"\u30B7",
"\uFF7D"=>"\u30B9",
"\uFF7E"=>"\u30BB",
"\uFF7F"=>"\u30BD",
"\uFF80"=>"\u30BF",
"\uFF81"=>"\u30C1",
"\uFF82"=>"\u30C4",
"\uFF83"=>"\u30C6",
"\uFF84"=>"\u30C8",
"\uFF85"=>"\u30CA",
"\uFF86"=>"\u30CB",
"\uFF87"=>"\u30CC",
"\uFF88"=>"\u30CD",
"\uFF89"=>"\u30CE",
"\uFF8A"=>"\u30CF",
"\uFF8B"=>"\u30D2",
"\uFF8C"=>"\u30D5",
"\uFF8D"=>"\u30D8",
"\uFF8E"=>"\u30DB",
"\uFF8F"=>"\u30DE",
"\uFF90"=>"\u30DF",
"\uFF91"=>"\u30E0",
"\uFF92"=>"\u30E1",
"\uFF93"=>"\u30E2",
"\uFF94"=>"\u30E4",
"\uFF95"=>"\u30E6",
"\uFF96"=>"\u30E8",
"\uFF97"=>"\u30E9",
"\uFF98"=>"\u30EA",
"\uFF99"=>"\u30EB",
"\uFF9A"=>"\u30EC",
"\uFF9B"=>"\u30ED",
"\uFF9C"=>"\u30EF",
"\uFF9D"=>"\u30F3",
"\uFF9E"=>"\u3099",
"\uFF9F"=>"\u309A",
"\uFFA0"=>"\u1160",
"\uFFA1"=>"\u1100",
"\uFFA2"=>"\u1101",
"\uFFA3"=>"\u11AA",
"\uFFA4"=>"\u1102",
"\uFFA5"=>"\u11AC",
"\uFFA6"=>"\u11AD",
"\uFFA7"=>"\u1103",
"\uFFA8"=>"\u1104",
"\uFFA9"=>"\u1105",
"\uFFAA"=>"\u11B0",
"\uFFAB"=>"\u11B1",
"\uFFAC"=>"\u11B2",
"\uFFAD"=>"\u11B3",
"\uFFAE"=>"\u11B4",
"\uFFAF"=>"\u11B5",
"\uFFB0"=>"\u111A",
"\uFFB1"=>"\u1106",
"\uFFB2"=>"\u1107",
"\uFFB3"=>"\u1108",
"\uFFB4"=>"\u1121",
"\uFFB5"=>"\u1109",
"\uFFB6"=>"\u110A",
"\uFFB7"=>"\u110B",
"\uFFB8"=>"\u110C",
"\uFFB9"=>"\u110D",
"\uFFBA"=>"\u110E",
"\uFFBB"=>"\u110F",
"\uFFBC"=>"\u1110",
"\uFFBD"=>"\u1111",
"\uFFBE"=>"\u1112",
"\uFFC2"=>"\u1161",
"\uFFC3"=>"\u1162",
"\uFFC4"=>"\u1163",
"\uFFC5"=>"\u1164",
"\uFFC6"=>"\u1165",
"\uFFC7"=>"\u1166",
"\uFFCA"=>"\u1167",
"\uFFCB"=>"\u1168",
"\uFFCC"=>"\u1169",
"\uFFCD"=>"\u116A",
"\uFFCE"=>"\u116B",
"\uFFCF"=>"\u116C",
"\uFFD2"=>"\u116D",
"\uFFD3"=>"\u116E",
"\uFFD4"=>"\u116F",
"\uFFD5"=>"\u1170",
"\uFFD6"=>"\u1171",
"\uFFD7"=>"\u1172",
"\uFFDA"=>"\u1173",
"\uFFDB"=>"\u1174",
"\uFFDC"=>"\u1175",
"\uFFE0"=>"\u00A2",
"\uFFE1"=>"\u00A3",
"\uFFE2"=>"\u00AC",
"\uFFE3"=>" \u0304",
"\uFFE4"=>"\u00A6",
"\uFFE5"=>"\u00A5",
"\uFFE6"=>"\u20A9",
"\uFFE8"=>"\u2502",
"\uFFE9"=>"\u2190",
"\uFFEA"=>"\u2191",
"\uFFEB"=>"\u2192",
"\uFFEC"=>"\u2193",
"\uFFED"=>"\u25A0",
"\uFFEE"=>"\u25CB",
"\u{10781}"=>"\u02D0",
"\u{10782}"=>"\u02D1",
"\u{10783}"=>"\u00E6",
"\u{10784}"=>"\u0299",
"\u{10785}"=>"\u0253",
"\u{10787}"=>"\u02A3",
"\u{10788}"=>"\uAB66",
"\u{10789}"=>"\u02A5",
"\u{1078A}"=>"\u02A4",
"\u{1078B}"=>"\u0256",
"\u{1078C}"=>"\u0257",
"\u{1078D}"=>"\u1D91",
"\u{1078E}"=>"\u0258",
"\u{1078F}"=>"\u025E",
"\u{10790}"=>"\u02A9",
"\u{10791}"=>"\u0264",
"\u{10792}"=>"\u0262",
"\u{10793}"=>"\u0260",
"\u{10794}"=>"\u029B",
"\u{10795}"=>"\u0127",
"\u{10796}"=>"\u029C",
"\u{10797}"=>"\u0267",
"\u{10798}"=>"\u0284",
"\u{10799}"=>"\u02AA",
"\u{1079A}"=>"\u02AB",
"\u{1079B}"=>"\u026C",
"\u{1079C}"=>"\u{1DF04}",
"\u{1079D}"=>"\uA78E",
"\u{1079E}"=>"\u026E",
"\u{1079F}"=>"\u{1DF05}",
"\u{107A0}"=>"\u028E",
"\u{107A1}"=>"\u{1DF06}",
"\u{107A2}"=>"\u00F8",
"\u{107A3}"=>"\u0276",
"\u{107A4}"=>"\u0277",
"\u{107A5}"=>"q",
"\u{107A6}"=>"\u027A",
"\u{107A7}"=>"\u{1DF08}",
"\u{107A8}"=>"\u027D",
"\u{107A9}"=>"\u027E",
"\u{107AA}"=>"\u0280",
"\u{107AB}"=>"\u02A8",
"\u{107AC}"=>"\u02A6",
"\u{107AD}"=>"\uAB67",
"\u{107AE}"=>"\u02A7",
"\u{107AF}"=>"\u0288",
"\u{107B0}"=>"\u2C71",
"\u{107B2}"=>"\u028F",
"\u{107B3}"=>"\u02A1",
"\u{107B4}"=>"\u02A2",
"\u{107B5}"=>"\u0298",
"\u{107B6}"=>"\u01C0",
"\u{107B7}"=>"\u01C1",
"\u{107B8}"=>"\u01C2",
"\u{107B9}"=>"\u{1DF0A}",
"\u{107BA}"=>"\u{1DF1E}",
"\u{1D400}"=>"A",
"\u{1D401}"=>"B",
"\u{1D402}"=>"C",
"\u{1D403}"=>"D",
"\u{1D404}"=>"E",
"\u{1D405}"=>"F",
"\u{1D406}"=>"G",
"\u{1D407}"=>"H",
"\u{1D408}"=>"I",
"\u{1D409}"=>"J",
"\u{1D40A}"=>"K",
"\u{1D40B}"=>"L",
"\u{1D40C}"=>"M",
"\u{1D40D}"=>"N",
"\u{1D40E}"=>"O",
"\u{1D40F}"=>"P",
"\u{1D410}"=>"Q",
"\u{1D411}"=>"R",
"\u{1D412}"=>"S",
"\u{1D413}"=>"T",
"\u{1D414}"=>"U",
"\u{1D415}"=>"V",
"\u{1D416}"=>"W",
"\u{1D417}"=>"X",
"\u{1D418}"=>"Y",
"\u{1D419}"=>"Z",
"\u{1D41A}"=>"a",
"\u{1D41B}"=>"b",
"\u{1D41C}"=>"c",
"\u{1D41D}"=>"d",
"\u{1D41E}"=>"e",
"\u{1D41F}"=>"f",
"\u{1D420}"=>"g",
"\u{1D421}"=>"h",
"\u{1D422}"=>"i",
"\u{1D423}"=>"j",
"\u{1D424}"=>"k",
"\u{1D425}"=>"l",
"\u{1D426}"=>"m",
"\u{1D427}"=>"n",
"\u{1D428}"=>"o",
"\u{1D429}"=>"p",
"\u{1D42A}"=>"q",
"\u{1D42B}"=>"r",
"\u{1D42C}"=>"s",
"\u{1D42D}"=>"t",
"\u{1D42E}"=>"u",
"\u{1D42F}"=>"v",
"\u{1D430}"=>"w",
"\u{1D431}"=>"x",
"\u{1D432}"=>"y",
"\u{1D433}"=>"z",
"\u{1D434}"=>"A",
"\u{1D435}"=>"B",
"\u{1D436}"=>"C",
"\u{1D437}"=>"D",
"\u{1D438}"=>"E",
"\u{1D439}"=>"F",
"\u{1D43A}"=>"G",
"\u{1D43B}"=>"H",
"\u{1D43C}"=>"I",
"\u{1D43D}"=>"J",
"\u{1D43E}"=>"K",
"\u{1D43F}"=>"L",
"\u{1D440}"=>"M",
"\u{1D441}"=>"N",
"\u{1D442}"=>"O",
"\u{1D443}"=>"P",
"\u{1D444}"=>"Q",
"\u{1D445}"=>"R",
"\u{1D446}"=>"S",
"\u{1D447}"=>"T",
"\u{1D448}"=>"U",
"\u{1D449}"=>"V",
"\u{1D44A}"=>"W",
"\u{1D44B}"=>"X",
"\u{1D44C}"=>"Y",
"\u{1D44D}"=>"Z",
"\u{1D44E}"=>"a",
"\u{1D44F}"=>"b",
"\u{1D450}"=>"c",
"\u{1D451}"=>"d",
"\u{1D452}"=>"e",
"\u{1D453}"=>"f",
"\u{1D454}"=>"g",
"\u{1D456}"=>"i",
"\u{1D457}"=>"j",
"\u{1D458}"=>"k",
"\u{1D459}"=>"l",
"\u{1D45A}"=>"m",
"\u{1D45B}"=>"n",
"\u{1D45C}"=>"o",
"\u{1D45D}"=>"p",
"\u{1D45E}"=>"q",
"\u{1D45F}"=>"r",
"\u{1D460}"=>"s",
"\u{1D461}"=>"t",
"\u{1D462}"=>"u",
"\u{1D463}"=>"v",
"\u{1D464}"=>"w",
"\u{1D465}"=>"x",
"\u{1D466}"=>"y",
"\u{1D467}"=>"z",
"\u{1D468}"=>"A",
"\u{1D469}"=>"B",
"\u{1D46A}"=>"C",
"\u{1D46B}"=>"D",
"\u{1D46C}"=>"E",
"\u{1D46D}"=>"F",
"\u{1D46E}"=>"G",
"\u{1D46F}"=>"H",
"\u{1D470}"=>"I",
"\u{1D471}"=>"J",
"\u{1D472}"=>"K",
"\u{1D473}"=>"L",
"\u{1D474}"=>"M",
"\u{1D475}"=>"N",
"\u{1D476}"=>"O",
"\u{1D477}"=>"P",
"\u{1D478}"=>"Q",
"\u{1D479}"=>"R",
"\u{1D47A}"=>"S",
"\u{1D47B}"=>"T",
"\u{1D47C}"=>"U",
"\u{1D47D}"=>"V",
"\u{1D47E}"=>"W",
"\u{1D47F}"=>"X",
"\u{1D480}"=>"Y",
"\u{1D481}"=>"Z",
"\u{1D482}"=>"a",
"\u{1D483}"=>"b",
"\u{1D484}"=>"c",
"\u{1D485}"=>"d",
"\u{1D486}"=>"e",
"\u{1D487}"=>"f",
"\u{1D488}"=>"g",
"\u{1D489}"=>"h",
"\u{1D48A}"=>"i",
"\u{1D48B}"=>"j",
"\u{1D48C}"=>"k",
"\u{1D48D}"=>"l",
"\u{1D48E}"=>"m",
"\u{1D48F}"=>"n",
"\u{1D490}"=>"o",
"\u{1D491}"=>"p",
"\u{1D492}"=>"q",
"\u{1D493}"=>"r",
"\u{1D494}"=>"s",
"\u{1D495}"=>"t",
"\u{1D496}"=>"u",
"\u{1D497}"=>"v",
"\u{1D498}"=>"w",
"\u{1D499}"=>"x",
"\u{1D49A}"=>"y",
"\u{1D49B}"=>"z",
"\u{1D49C}"=>"A",
"\u{1D49E}"=>"C",
"\u{1D49F}"=>"D",
"\u{1D4A2}"=>"G",
"\u{1D4A5}"=>"J",
"\u{1D4A6}"=>"K",
"\u{1D4A9}"=>"N",
"\u{1D4AA}"=>"O",
"\u{1D4AB}"=>"P",
"\u{1D4AC}"=>"Q",
"\u{1D4AE}"=>"S",
"\u{1D4AF}"=>"T",
"\u{1D4B0}"=>"U",
"\u{1D4B1}"=>"V",
"\u{1D4B2}"=>"W",
"\u{1D4B3}"=>"X",
"\u{1D4B4}"=>"Y",
"\u{1D4B5}"=>"Z",
"\u{1D4B6}"=>"a",
"\u{1D4B7}"=>"b",
"\u{1D4B8}"=>"c",
"\u{1D4B9}"=>"d",
"\u{1D4BB}"=>"f",
"\u{1D4BD}"=>"h",
"\u{1D4BE}"=>"i",
"\u{1D4BF}"=>"j",
"\u{1D4C0}"=>"k",
"\u{1D4C1}"=>"l",
"\u{1D4C2}"=>"m",
"\u{1D4C3}"=>"n",
"\u{1D4C5}"=>"p",
"\u{1D4C6}"=>"q",
"\u{1D4C7}"=>"r",
"\u{1D4C8}"=>"s",
"\u{1D4C9}"=>"t",
"\u{1D4CA}"=>"u",
"\u{1D4CB}"=>"v",
"\u{1D4CC}"=>"w",
"\u{1D4CD}"=>"x",
"\u{1D4CE}"=>"y",
"\u{1D4CF}"=>"z",
"\u{1D4D0}"=>"A",
"\u{1D4D1}"=>"B",
"\u{1D4D2}"=>"C",
"\u{1D4D3}"=>"D",
"\u{1D4D4}"=>"E",
"\u{1D4D5}"=>"F",
"\u{1D4D6}"=>"G",
"\u{1D4D7}"=>"H",
"\u{1D4D8}"=>"I",
"\u{1D4D9}"=>"J",
"\u{1D4DA}"=>"K",
"\u{1D4DB}"=>"L",
"\u{1D4DC}"=>"M",
"\u{1D4DD}"=>"N",
"\u{1D4DE}"=>"O",
"\u{1D4DF}"=>"P",
"\u{1D4E0}"=>"Q",
"\u{1D4E1}"=>"R",
"\u{1D4E2}"=>"S",
"\u{1D4E3}"=>"T",
"\u{1D4E4}"=>"U",
"\u{1D4E5}"=>"V",
"\u{1D4E6}"=>"W",
"\u{1D4E7}"=>"X",
"\u{1D4E8}"=>"Y",
"\u{1D4E9}"=>"Z",
"\u{1D4EA}"=>"a",
"\u{1D4EB}"=>"b",
"\u{1D4EC}"=>"c",
"\u{1D4ED}"=>"d",
"\u{1D4EE}"=>"e",
"\u{1D4EF}"=>"f",
"\u{1D4F0}"=>"g",
"\u{1D4F1}"=>"h",
"\u{1D4F2}"=>"i",
"\u{1D4F3}"=>"j",
"\u{1D4F4}"=>"k",
"\u{1D4F5}"=>"l",
"\u{1D4F6}"=>"m",
"\u{1D4F7}"=>"n",
"\u{1D4F8}"=>"o",
"\u{1D4F9}"=>"p",
"\u{1D4FA}"=>"q",
"\u{1D4FB}"=>"r",
"\u{1D4FC}"=>"s",
"\u{1D4FD}"=>"t",
"\u{1D4FE}"=>"u",
"\u{1D4FF}"=>"v",
"\u{1D500}"=>"w",
"\u{1D501}"=>"x",
"\u{1D502}"=>"y",
"\u{1D503}"=>"z",
"\u{1D504}"=>"A",
"\u{1D505}"=>"B",
"\u{1D507}"=>"D",
"\u{1D508}"=>"E",
"\u{1D509}"=>"F",
"\u{1D50A}"=>"G",
"\u{1D50D}"=>"J",
"\u{1D50E}"=>"K",
"\u{1D50F}"=>"L",
"\u{1D510}"=>"M",
"\u{1D511}"=>"N",
"\u{1D512}"=>"O",
"\u{1D513}"=>"P",
"\u{1D514}"=>"Q",
"\u{1D516}"=>"S",
"\u{1D517}"=>"T",
"\u{1D518}"=>"U",
"\u{1D519}"=>"V",
"\u{1D51A}"=>"W",
"\u{1D51B}"=>"X",
"\u{1D51C}"=>"Y",
"\u{1D51E}"=>"a",
"\u{1D51F}"=>"b",
"\u{1D520}"=>"c",
"\u{1D521}"=>"d",
"\u{1D522}"=>"e",
"\u{1D523}"=>"f",
"\u{1D524}"=>"g",
"\u{1D525}"=>"h",
"\u{1D526}"=>"i",
"\u{1D527}"=>"j",
"\u{1D528}"=>"k",
"\u{1D529}"=>"l",
"\u{1D52A}"=>"m",
"\u{1D52B}"=>"n",
"\u{1D52C}"=>"o",
"\u{1D52D}"=>"p",
"\u{1D52E}"=>"q",
"\u{1D52F}"=>"r",
"\u{1D530}"=>"s",
"\u{1D531}"=>"t",
"\u{1D532}"=>"u",
"\u{1D533}"=>"v",
"\u{1D534}"=>"w",
"\u{1D535}"=>"x",
"\u{1D536}"=>"y",
"\u{1D537}"=>"z",
"\u{1D538}"=>"A",
"\u{1D539}"=>"B",
"\u{1D53B}"=>"D",
"\u{1D53C}"=>"E",
"\u{1D53D}"=>"F",
"\u{1D53E}"=>"G",
"\u{1D540}"=>"I",
"\u{1D541}"=>"J",
"\u{1D542}"=>"K",
"\u{1D543}"=>"L",
"\u{1D544}"=>"M",
"\u{1D546}"=>"O",
"\u{1D54A}"=>"S",
"\u{1D54B}"=>"T",
"\u{1D54C}"=>"U",
"\u{1D54D}"=>"V",
"\u{1D54E}"=>"W",
"\u{1D54F}"=>"X",
"\u{1D550}"=>"Y",
"\u{1D552}"=>"a",
"\u{1D553}"=>"b",
"\u{1D554}"=>"c",
"\u{1D555}"=>"d",
"\u{1D556}"=>"e",
"\u{1D557}"=>"f",
"\u{1D558}"=>"g",
"\u{1D559}"=>"h",
"\u{1D55A}"=>"i",
"\u{1D55B}"=>"j",
"\u{1D55C}"=>"k",
"\u{1D55D}"=>"l",
"\u{1D55E}"=>"m",
"\u{1D55F}"=>"n",
"\u{1D560}"=>"o",
"\u{1D561}"=>"p",
"\u{1D562}"=>"q",
"\u{1D563}"=>"r",
"\u{1D564}"=>"s",
"\u{1D565}"=>"t",
"\u{1D566}"=>"u",
"\u{1D567}"=>"v",
"\u{1D568}"=>"w",
"\u{1D569}"=>"x",
"\u{1D56A}"=>"y",
"\u{1D56B}"=>"z",
"\u{1D56C}"=>"A",
"\u{1D56D}"=>"B",
"\u{1D56E}"=>"C",
"\u{1D56F}"=>"D",
"\u{1D570}"=>"E",
"\u{1D571}"=>"F",
"\u{1D572}"=>"G",
"\u{1D573}"=>"H",
"\u{1D574}"=>"I",
"\u{1D575}"=>"J",
"\u{1D576}"=>"K",
"\u{1D577}"=>"L",
"\u{1D578}"=>"M",
"\u{1D579}"=>"N",
"\u{1D57A}"=>"O",
"\u{1D57B}"=>"P",
"\u{1D57C}"=>"Q",
"\u{1D57D}"=>"R",
"\u{1D57E}"=>"S",
"\u{1D57F}"=>"T",
"\u{1D580}"=>"U",
"\u{1D581}"=>"V",
"\u{1D582}"=>"W",
"\u{1D583}"=>"X",
"\u{1D584}"=>"Y",
"\u{1D585}"=>"Z",
"\u{1D586}"=>"a",
"\u{1D587}"=>"b",
"\u{1D588}"=>"c",
"\u{1D589}"=>"d",
"\u{1D58A}"=>"e",
"\u{1D58B}"=>"f",
"\u{1D58C}"=>"g",
"\u{1D58D}"=>"h",
"\u{1D58E}"=>"i",
"\u{1D58F}"=>"j",
"\u{1D590}"=>"k",
"\u{1D591}"=>"l",
"\u{1D592}"=>"m",
"\u{1D593}"=>"n",
"\u{1D594}"=>"o",
"\u{1D595}"=>"p",
"\u{1D596}"=>"q",
"\u{1D597}"=>"r",
"\u{1D598}"=>"s",
"\u{1D599}"=>"t",
"\u{1D59A}"=>"u",
"\u{1D59B}"=>"v",
"\u{1D59C}"=>"w",
"\u{1D59D}"=>"x",
"\u{1D59E}"=>"y",
"\u{1D59F}"=>"z",
"\u{1D5A0}"=>"A",
"\u{1D5A1}"=>"B",
"\u{1D5A2}"=>"C",
"\u{1D5A3}"=>"D",
"\u{1D5A4}"=>"E",
"\u{1D5A5}"=>"F",
"\u{1D5A6}"=>"G",
"\u{1D5A7}"=>"H",
"\u{1D5A8}"=>"I",
"\u{1D5A9}"=>"J",
"\u{1D5AA}"=>"K",
"\u{1D5AB}"=>"L",
"\u{1D5AC}"=>"M",
"\u{1D5AD}"=>"N",
"\u{1D5AE}"=>"O",
"\u{1D5AF}"=>"P",
"\u{1D5B0}"=>"Q",
"\u{1D5B1}"=>"R",
"\u{1D5B2}"=>"S",
"\u{1D5B3}"=>"T",
"\u{1D5B4}"=>"U",
"\u{1D5B5}"=>"V",
"\u{1D5B6}"=>"W",
"\u{1D5B7}"=>"X",
"\u{1D5B8}"=>"Y",
"\u{1D5B9}"=>"Z",
"\u{1D5BA}"=>"a",
"\u{1D5BB}"=>"b",
"\u{1D5BC}"=>"c",
"\u{1D5BD}"=>"d",
"\u{1D5BE}"=>"e",
"\u{1D5BF}"=>"f",
"\u{1D5C0}"=>"g",
"\u{1D5C1}"=>"h",
"\u{1D5C2}"=>"i",
"\u{1D5C3}"=>"j",
"\u{1D5C4}"=>"k",
"\u{1D5C5}"=>"l",
"\u{1D5C6}"=>"m",
"\u{1D5C7}"=>"n",
"\u{1D5C8}"=>"o",
"\u{1D5C9}"=>"p",
"\u{1D5CA}"=>"q",
"\u{1D5CB}"=>"r",
"\u{1D5CC}"=>"s",
"\u{1D5CD}"=>"t",
"\u{1D5CE}"=>"u",
"\u{1D5CF}"=>"v",
"\u{1D5D0}"=>"w",
"\u{1D5D1}"=>"x",
"\u{1D5D2}"=>"y",
"\u{1D5D3}"=>"z",
"\u{1D5D4}"=>"A",
"\u{1D5D5}"=>"B",
"\u{1D5D6}"=>"C",
"\u{1D5D7}"=>"D",
"\u{1D5D8}"=>"E",
"\u{1D5D9}"=>"F",
"\u{1D5DA}"=>"G",
"\u{1D5DB}"=>"H",
"\u{1D5DC}"=>"I",
"\u{1D5DD}"=>"J",
"\u{1D5DE}"=>"K",
"\u{1D5DF}"=>"L",
"\u{1D5E0}"=>"M",
"\u{1D5E1}"=>"N",
"\u{1D5E2}"=>"O",
"\u{1D5E3}"=>"P",
"\u{1D5E4}"=>"Q",
"\u{1D5E5}"=>"R",
"\u{1D5E6}"=>"S",
"\u{1D5E7}"=>"T",
"\u{1D5E8}"=>"U",
"\u{1D5E9}"=>"V",
"\u{1D5EA}"=>"W",
"\u{1D5EB}"=>"X",
"\u{1D5EC}"=>"Y",
"\u{1D5ED}"=>"Z",
"\u{1D5EE}"=>"a",
"\u{1D5EF}"=>"b",
"\u{1D5F0}"=>"c",
"\u{1D5F1}"=>"d",
"\u{1D5F2}"=>"e",
"\u{1D5F3}"=>"f",
"\u{1D5F4}"=>"g",
"\u{1D5F5}"=>"h",
"\u{1D5F6}"=>"i",
"\u{1D5F7}"=>"j",
"\u{1D5F8}"=>"k",
"\u{1D5F9}"=>"l",
"\u{1D5FA}"=>"m",
"\u{1D5FB}"=>"n",
"\u{1D5FC}"=>"o",
"\u{1D5FD}"=>"p",
"\u{1D5FE}"=>"q",
"\u{1D5FF}"=>"r",
"\u{1D600}"=>"s",
"\u{1D601}"=>"t",
"\u{1D602}"=>"u",
"\u{1D603}"=>"v",
"\u{1D604}"=>"w",
"\u{1D605}"=>"x",
"\u{1D606}"=>"y",
"\u{1D607}"=>"z",
"\u{1D608}"=>"A",
"\u{1D609}"=>"B",
"\u{1D60A}"=>"C",
"\u{1D60B}"=>"D",
"\u{1D60C}"=>"E",
"\u{1D60D}"=>"F",
"\u{1D60E}"=>"G",
"\u{1D60F}"=>"H",
"\u{1D610}"=>"I",
"\u{1D611}"=>"J",
"\u{1D612}"=>"K",
"\u{1D613}"=>"L",
"\u{1D614}"=>"M",
"\u{1D615}"=>"N",
"\u{1D616}"=>"O",
"\u{1D617}"=>"P",
"\u{1D618}"=>"Q",
"\u{1D619}"=>"R",
"\u{1D61A}"=>"S",
"\u{1D61B}"=>"T",
"\u{1D61C}"=>"U",
"\u{1D61D}"=>"V",
"\u{1D61E}"=>"W",
"\u{1D61F}"=>"X",
"\u{1D620}"=>"Y",
"\u{1D621}"=>"Z",
"\u{1D622}"=>"a",
"\u{1D623}"=>"b",
"\u{1D624}"=>"c",
"\u{1D625}"=>"d",
"\u{1D626}"=>"e",
"\u{1D627}"=>"f",
"\u{1D628}"=>"g",
"\u{1D629}"=>"h",
"\u{1D62A}"=>"i",
"\u{1D62B}"=>"j",
"\u{1D62C}"=>"k",
"\u{1D62D}"=>"l",
"\u{1D62E}"=>"m",
"\u{1D62F}"=>"n",
"\u{1D630}"=>"o",
"\u{1D631}"=>"p",
"\u{1D632}"=>"q",
"\u{1D633}"=>"r",
"\u{1D634}"=>"s",
"\u{1D635}"=>"t",
"\u{1D636}"=>"u",
"\u{1D637}"=>"v",
"\u{1D638}"=>"w",
"\u{1D639}"=>"x",
"\u{1D63A}"=>"y",
"\u{1D63B}"=>"z",
"\u{1D63C}"=>"A",
"\u{1D63D}"=>"B",
"\u{1D63E}"=>"C",
"\u{1D63F}"=>"D",
"\u{1D640}"=>"E",
"\u{1D641}"=>"F",
"\u{1D642}"=>"G",
"\u{1D643}"=>"H",
"\u{1D644}"=>"I",
"\u{1D645}"=>"J",
"\u{1D646}"=>"K",
"\u{1D647}"=>"L",
"\u{1D648}"=>"M",
"\u{1D649}"=>"N",
"\u{1D64A}"=>"O",
"\u{1D64B}"=>"P",
"\u{1D64C}"=>"Q",
"\u{1D64D}"=>"R",
"\u{1D64E}"=>"S",
"\u{1D64F}"=>"T",
"\u{1D650}"=>"U",
"\u{1D651}"=>"V",
"\u{1D652}"=>"W",
"\u{1D653}"=>"X",
"\u{1D654}"=>"Y",
"\u{1D655}"=>"Z",
"\u{1D656}"=>"a",
"\u{1D657}"=>"b",
"\u{1D658}"=>"c",
"\u{1D659}"=>"d",
"\u{1D65A}"=>"e",
"\u{1D65B}"=>"f",
"\u{1D65C}"=>"g",
"\u{1D65D}"=>"h",
"\u{1D65E}"=>"i",
"\u{1D65F}"=>"j",
"\u{1D660}"=>"k",
"\u{1D661}"=>"l",
"\u{1D662}"=>"m",
"\u{1D663}"=>"n",
"\u{1D664}"=>"o",
"\u{1D665}"=>"p",
"\u{1D666}"=>"q",
"\u{1D667}"=>"r",
"\u{1D668}"=>"s",
"\u{1D669}"=>"t",
"\u{1D66A}"=>"u",
"\u{1D66B}"=>"v",
"\u{1D66C}"=>"w",
"\u{1D66D}"=>"x",
"\u{1D66E}"=>"y",
"\u{1D66F}"=>"z",
"\u{1D670}"=>"A",
"\u{1D671}"=>"B",
"\u{1D672}"=>"C",
"\u{1D673}"=>"D",
"\u{1D674}"=>"E",
"\u{1D675}"=>"F",
"\u{1D676}"=>"G",
"\u{1D677}"=>"H",
"\u{1D678}"=>"I",
"\u{1D679}"=>"J",
"\u{1D67A}"=>"K",
"\u{1D67B}"=>"L",
"\u{1D67C}"=>"M",
"\u{1D67D}"=>"N",
"\u{1D67E}"=>"O",
"\u{1D67F}"=>"P",
"\u{1D680}"=>"Q",
"\u{1D681}"=>"R",
"\u{1D682}"=>"S",
"\u{1D683}"=>"T",
"\u{1D684}"=>"U",
"\u{1D685}"=>"V",
"\u{1D686}"=>"W",
"\u{1D687}"=>"X",
"\u{1D688}"=>"Y",
"\u{1D689}"=>"Z",
"\u{1D68A}"=>"a",
"\u{1D68B}"=>"b",
"\u{1D68C}"=>"c",
"\u{1D68D}"=>"d",
"\u{1D68E}"=>"e",
"\u{1D68F}"=>"f",
"\u{1D690}"=>"g",
"\u{1D691}"=>"h",
"\u{1D692}"=>"i",
"\u{1D693}"=>"j",
"\u{1D694}"=>"k",
"\u{1D695}"=>"l",
"\u{1D696}"=>"m",
"\u{1D697}"=>"n",
"\u{1D698}"=>"o",
"\u{1D699}"=>"p",
"\u{1D69A}"=>"q",
"\u{1D69B}"=>"r",
"\u{1D69C}"=>"s",
"\u{1D69D}"=>"t",
"\u{1D69E}"=>"u",
"\u{1D69F}"=>"v",
"\u{1D6A0}"=>"w",
"\u{1D6A1}"=>"x",
"\u{1D6A2}"=>"y",
"\u{1D6A3}"=>"z",
"\u{1D6A4}"=>"\u0131",
"\u{1D6A5}"=>"\u0237",
"\u{1D6A8}"=>"\u0391",
"\u{1D6A9}"=>"\u0392",
"\u{1D6AA}"=>"\u0393",
"\u{1D6AB}"=>"\u0394",
"\u{1D6AC}"=>"\u0395",
"\u{1D6AD}"=>"\u0396",
"\u{1D6AE}"=>"\u0397",
"\u{1D6AF}"=>"\u0398",
"\u{1D6B0}"=>"\u0399",
"\u{1D6B1}"=>"\u039A",
"\u{1D6B2}"=>"\u039B",
"\u{1D6B3}"=>"\u039C",
"\u{1D6B4}"=>"\u039D",
"\u{1D6B5}"=>"\u039E",
"\u{1D6B6}"=>"\u039F",
"\u{1D6B7}"=>"\u03A0",
"\u{1D6B8}"=>"\u03A1",
"\u{1D6B9}"=>"\u0398",
"\u{1D6BA}"=>"\u03A3",
"\u{1D6BB}"=>"\u03A4",
"\u{1D6BC}"=>"\u03A5",
"\u{1D6BD}"=>"\u03A6",
"\u{1D6BE}"=>"\u03A7",
"\u{1D6BF}"=>"\u03A8",
"\u{1D6C0}"=>"\u03A9",
"\u{1D6C1}"=>"\u2207",
"\u{1D6C2}"=>"\u03B1",
"\u{1D6C3}"=>"\u03B2",
"\u{1D6C4}"=>"\u03B3",
"\u{1D6C5}"=>"\u03B4",
"\u{1D6C6}"=>"\u03B5",
"\u{1D6C7}"=>"\u03B6",
"\u{1D6C8}"=>"\u03B7",
"\u{1D6C9}"=>"\u03B8",
"\u{1D6CA}"=>"\u03B9",
"\u{1D6CB}"=>"\u03BA",
"\u{1D6CC}"=>"\u03BB",
"\u{1D6CD}"=>"\u03BC",
"\u{1D6CE}"=>"\u03BD",
"\u{1D6CF}"=>"\u03BE",
"\u{1D6D0}"=>"\u03BF",
"\u{1D6D1}"=>"\u03C0",
"\u{1D6D2}"=>"\u03C1",
"\u{1D6D3}"=>"\u03C2",
"\u{1D6D4}"=>"\u03C3",
"\u{1D6D5}"=>"\u03C4",
"\u{1D6D6}"=>"\u03C5",
"\u{1D6D7}"=>"\u03C6",
"\u{1D6D8}"=>"\u03C7",
"\u{1D6D9}"=>"\u03C8",
"\u{1D6DA}"=>"\u03C9",
"\u{1D6DB}"=>"\u2202",
"\u{1D6DC}"=>"\u03B5",
"\u{1D6DD}"=>"\u03B8",
"\u{1D6DE}"=>"\u03BA",
"\u{1D6DF}"=>"\u03C6",
"\u{1D6E0}"=>"\u03C1",
"\u{1D6E1}"=>"\u03C0",
"\u{1D6E2}"=>"\u0391",
"\u{1D6E3}"=>"\u0392",
"\u{1D6E4}"=>"\u0393",
"\u{1D6E5}"=>"\u0394",
"\u{1D6E6}"=>"\u0395",
"\u{1D6E7}"=>"\u0396",
"\u{1D6E8}"=>"\u0397",
"\u{1D6E9}"=>"\u0398",
"\u{1D6EA}"=>"\u0399",
"\u{1D6EB}"=>"\u039A",
"\u{1D6EC}"=>"\u039B",
"\u{1D6ED}"=>"\u039C",
"\u{1D6EE}"=>"\u039D",
"\u{1D6EF}"=>"\u039E",
"\u{1D6F0}"=>"\u039F",
"\u{1D6F1}"=>"\u03A0",
"\u{1D6F2}"=>"\u03A1",
"\u{1D6F3}"=>"\u0398",
"\u{1D6F4}"=>"\u03A3",
"\u{1D6F5}"=>"\u03A4",
"\u{1D6F6}"=>"\u03A5",
"\u{1D6F7}"=>"\u03A6",
"\u{1D6F8}"=>"\u03A7",
"\u{1D6F9}"=>"\u03A8",
"\u{1D6FA}"=>"\u03A9",
"\u{1D6FB}"=>"\u2207",
"\u{1D6FC}"=>"\u03B1",
"\u{1D6FD}"=>"\u03B2",
"\u{1D6FE}"=>"\u03B3",
"\u{1D6FF}"=>"\u03B4",
"\u{1D700}"=>"\u03B5",
"\u{1D701}"=>"\u03B6",
"\u{1D702}"=>"\u03B7",
"\u{1D703}"=>"\u03B8",
"\u{1D704}"=>"\u03B9",
"\u{1D705}"=>"\u03BA",
"\u{1D706}"=>"\u03BB",
"\u{1D707}"=>"\u03BC",
"\u{1D708}"=>"\u03BD",
"\u{1D709}"=>"\u03BE",
"\u{1D70A}"=>"\u03BF",
"\u{1D70B}"=>"\u03C0",
"\u{1D70C}"=>"\u03C1",
"\u{1D70D}"=>"\u03C2",
"\u{1D70E}"=>"\u03C3",
"\u{1D70F}"=>"\u03C4",
"\u{1D710}"=>"\u03C5",
"\u{1D711}"=>"\u03C6",
"\u{1D712}"=>"\u03C7",
"\u{1D713}"=>"\u03C8",
"\u{1D714}"=>"\u03C9",
"\u{1D715}"=>"\u2202",
"\u{1D716}"=>"\u03B5",
"\u{1D717}"=>"\u03B8",
"\u{1D718}"=>"\u03BA",
"\u{1D719}"=>"\u03C6",
"\u{1D71A}"=>"\u03C1",
"\u{1D71B}"=>"\u03C0",
"\u{1D71C}"=>"\u0391",
"\u{1D71D}"=>"\u0392",
"\u{1D71E}"=>"\u0393",
"\u{1D71F}"=>"\u0394",
"\u{1D720}"=>"\u0395",
"\u{1D721}"=>"\u0396",
"\u{1D722}"=>"\u0397",
"\u{1D723}"=>"\u0398",
"\u{1D724}"=>"\u0399",
"\u{1D725}"=>"\u039A",
"\u{1D726}"=>"\u039B",
"\u{1D727}"=>"\u039C",
"\u{1D728}"=>"\u039D",
"\u{1D729}"=>"\u039E",
"\u{1D72A}"=>"\u039F",
"\u{1D72B}"=>"\u03A0",
"\u{1D72C}"=>"\u03A1",
"\u{1D72D}"=>"\u0398",
"\u{1D72E}"=>"\u03A3",
"\u{1D72F}"=>"\u03A4",
"\u{1D730}"=>"\u03A5",
"\u{1D731}"=>"\u03A6",
"\u{1D732}"=>"\u03A7",
"\u{1D733}"=>"\u03A8",
"\u{1D734}"=>"\u03A9",
"\u{1D735}"=>"\u2207",
"\u{1D736}"=>"\u03B1",
"\u{1D737}"=>"\u03B2",
"\u{1D738}"=>"\u03B3",
"\u{1D739}"=>"\u03B4",
"\u{1D73A}"=>"\u03B5",
"\u{1D73B}"=>"\u03B6",
"\u{1D73C}"=>"\u03B7",
"\u{1D73D}"=>"\u03B8",
"\u{1D73E}"=>"\u03B9",
"\u{1D73F}"=>"\u03BA",
"\u{1D740}"=>"\u03BB",
"\u{1D741}"=>"\u03BC",
"\u{1D742}"=>"\u03BD",
"\u{1D743}"=>"\u03BE",
"\u{1D744}"=>"\u03BF",
"\u{1D745}"=>"\u03C0",
"\u{1D746}"=>"\u03C1",
"\u{1D747}"=>"\u03C2",
"\u{1D748}"=>"\u03C3",
"\u{1D749}"=>"\u03C4",
"\u{1D74A}"=>"\u03C5",
"\u{1D74B}"=>"\u03C6",
"\u{1D74C}"=>"\u03C7",
"\u{1D74D}"=>"\u03C8",
"\u{1D74E}"=>"\u03C9",
"\u{1D74F}"=>"\u2202",
"\u{1D750}"=>"\u03B5",
"\u{1D751}"=>"\u03B8",
"\u{1D752}"=>"\u03BA",
"\u{1D753}"=>"\u03C6",
"\u{1D754}"=>"\u03C1",
"\u{1D755}"=>"\u03C0",
"\u{1D756}"=>"\u0391",
"\u{1D757}"=>"\u0392",
"\u{1D758}"=>"\u0393",
"\u{1D759}"=>"\u0394",
"\u{1D75A}"=>"\u0395",
"\u{1D75B}"=>"\u0396",
"\u{1D75C}"=>"\u0397",
"\u{1D75D}"=>"\u0398",
"\u{1D75E}"=>"\u0399",
"\u{1D75F}"=>"\u039A",
"\u{1D760}"=>"\u039B",
"\u{1D761}"=>"\u039C",
"\u{1D762}"=>"\u039D",
"\u{1D763}"=>"\u039E",
"\u{1D764}"=>"\u039F",
"\u{1D765}"=>"\u03A0",
"\u{1D766}"=>"\u03A1",
"\u{1D767}"=>"\u0398",
"\u{1D768}"=>"\u03A3",
"\u{1D769}"=>"\u03A4",
"\u{1D76A}"=>"\u03A5",
"\u{1D76B}"=>"\u03A6",
"\u{1D76C}"=>"\u03A7",
"\u{1D76D}"=>"\u03A8",
"\u{1D76E}"=>"\u03A9",
"\u{1D76F}"=>"\u2207",
"\u{1D770}"=>"\u03B1",
"\u{1D771}"=>"\u03B2",
"\u{1D772}"=>"\u03B3",
"\u{1D773}"=>"\u03B4",
"\u{1D774}"=>"\u03B5",
"\u{1D775}"=>"\u03B6",
"\u{1D776}"=>"\u03B7",
"\u{1D777}"=>"\u03B8",
"\u{1D778}"=>"\u03B9",
"\u{1D779}"=>"\u03BA",
"\u{1D77A}"=>"\u03BB",
"\u{1D77B}"=>"\u03BC",
"\u{1D77C}"=>"\u03BD",
"\u{1D77D}"=>"\u03BE",
"\u{1D77E}"=>"\u03BF",
"\u{1D77F}"=>"\u03C0",
"\u{1D780}"=>"\u03C1",
"\u{1D781}"=>"\u03C2",
"\u{1D782}"=>"\u03C3",
"\u{1D783}"=>"\u03C4",
"\u{1D784}"=>"\u03C5",
"\u{1D785}"=>"\u03C6",
"\u{1D786}"=>"\u03C7",
"\u{1D787}"=>"\u03C8",
"\u{1D788}"=>"\u03C9",
"\u{1D789}"=>"\u2202",
"\u{1D78A}"=>"\u03B5",
"\u{1D78B}"=>"\u03B8",
"\u{1D78C}"=>"\u03BA",
"\u{1D78D}"=>"\u03C6",
"\u{1D78E}"=>"\u03C1",
"\u{1D78F}"=>"\u03C0",
"\u{1D790}"=>"\u0391",
"\u{1D791}"=>"\u0392",
"\u{1D792}"=>"\u0393",
"\u{1D793}"=>"\u0394",
"\u{1D794}"=>"\u0395",
"\u{1D795}"=>"\u0396",
"\u{1D796}"=>"\u0397",
"\u{1D797}"=>"\u0398",
"\u{1D798}"=>"\u0399",
"\u{1D799}"=>"\u039A",
"\u{1D79A}"=>"\u039B",
"\u{1D79B}"=>"\u039C",
"\u{1D79C}"=>"\u039D",
"\u{1D79D}"=>"\u039E",
"\u{1D79E}"=>"\u039F",
"\u{1D79F}"=>"\u03A0",
"\u{1D7A0}"=>"\u03A1",
"\u{1D7A1}"=>"\u0398",
"\u{1D7A2}"=>"\u03A3",
"\u{1D7A3}"=>"\u03A4",
"\u{1D7A4}"=>"\u03A5",
"\u{1D7A5}"=>"\u03A6",
"\u{1D7A6}"=>"\u03A7",
"\u{1D7A7}"=>"\u03A8",
"\u{1D7A8}"=>"\u03A9",
"\u{1D7A9}"=>"\u2207",
"\u{1D7AA}"=>"\u03B1",
"\u{1D7AB}"=>"\u03B2",
"\u{1D7AC}"=>"\u03B3",
"\u{1D7AD}"=>"\u03B4",
"\u{1D7AE}"=>"\u03B5",
"\u{1D7AF}"=>"\u03B6",
"\u{1D7B0}"=>"\u03B7",
"\u{1D7B1}"=>"\u03B8",
"\u{1D7B2}"=>"\u03B9",
"\u{1D7B3}"=>"\u03BA",
"\u{1D7B4}"=>"\u03BB",
"\u{1D7B5}"=>"\u03BC",
"\u{1D7B6}"=>"\u03BD",
"\u{1D7B7}"=>"\u03BE",
"\u{1D7B8}"=>"\u03BF",
"\u{1D7B9}"=>"\u03C0",
"\u{1D7BA}"=>"\u03C1",
"\u{1D7BB}"=>"\u03C2",
"\u{1D7BC}"=>"\u03C3",
"\u{1D7BD}"=>"\u03C4",
"\u{1D7BE}"=>"\u03C5",
"\u{1D7BF}"=>"\u03C6",
"\u{1D7C0}"=>"\u03C7",
"\u{1D7C1}"=>"\u03C8",
"\u{1D7C2}"=>"\u03C9",
"\u{1D7C3}"=>"\u2202",
"\u{1D7C4}"=>"\u03B5",
"\u{1D7C5}"=>"\u03B8",
"\u{1D7C6}"=>"\u03BA",
"\u{1D7C7}"=>"\u03C6",
"\u{1D7C8}"=>"\u03C1",
"\u{1D7C9}"=>"\u03C0",
"\u{1D7CA}"=>"\u03DC",
"\u{1D7CB}"=>"\u03DD",
"\u{1D7CE}"=>"0",
"\u{1D7CF}"=>"1",
"\u{1D7D0}"=>"2",
"\u{1D7D1}"=>"3",
"\u{1D7D2}"=>"4",
"\u{1D7D3}"=>"5",
"\u{1D7D4}"=>"6",
"\u{1D7D5}"=>"7",
"\u{1D7D6}"=>"8",
"\u{1D7D7}"=>"9",
"\u{1D7D8}"=>"0",
"\u{1D7D9}"=>"1",
"\u{1D7DA}"=>"2",
"\u{1D7DB}"=>"3",
"\u{1D7DC}"=>"4",
"\u{1D7DD}"=>"5",
"\u{1D7DE}"=>"6",
"\u{1D7DF}"=>"7",
"\u{1D7E0}"=>"8",
"\u{1D7E1}"=>"9",
"\u{1D7E2}"=>"0",
"\u{1D7E3}"=>"1",
"\u{1D7E4}"=>"2",
"\u{1D7E5}"=>"3",
"\u{1D7E6}"=>"4",
"\u{1D7E7}"=>"5",
"\u{1D7E8}"=>"6",
"\u{1D7E9}"=>"7",
"\u{1D7EA}"=>"8",
"\u{1D7EB}"=>"9",
"\u{1D7EC}"=>"0",
"\u{1D7ED}"=>"1",
"\u{1D7EE}"=>"2",
"\u{1D7EF}"=>"3",
"\u{1D7F0}"=>"4",
"\u{1D7F1}"=>"5",
"\u{1D7F2}"=>"6",
"\u{1D7F3}"=>"7",
"\u{1D7F4}"=>"8",
"\u{1D7F5}"=>"9",
"\u{1D7F6}"=>"0",
"\u{1D7F7}"=>"1",
"\u{1D7F8}"=>"2",
"\u{1D7F9}"=>"3",
"\u{1D7FA}"=>"4",
"\u{1D7FB}"=>"5",
"\u{1D7FC}"=>"6",
"\u{1D7FD}"=>"7",
"\u{1D7FE}"=>"8",
"\u{1D7FF}"=>"9",
"\u{1E030}"=>"\u0430",
"\u{1E031}"=>"\u0431",
"\u{1E032}"=>"\u0432",
"\u{1E033}"=>"\u0433",
"\u{1E034}"=>"\u0434",
"\u{1E035}"=>"\u0435",
"\u{1E036}"=>"\u0436",
"\u{1E037}"=>"\u0437",
"\u{1E038}"=>"\u0438",
"\u{1E039}"=>"\u043A",
"\u{1E03A}"=>"\u043B",
"\u{1E03B}"=>"\u043C",
"\u{1E03C}"=>"\u043E",
"\u{1E03D}"=>"\u043F",
"\u{1E03E}"=>"\u0440",
"\u{1E03F}"=>"\u0441",
"\u{1E040}"=>"\u0442",
"\u{1E041}"=>"\u0443",
"\u{1E042}"=>"\u0444",
"\u{1E043}"=>"\u0445",
"\u{1E044}"=>"\u0446",
"\u{1E045}"=>"\u0447",
"\u{1E046}"=>"\u0448",
"\u{1E047}"=>"\u044B",
"\u{1E048}"=>"\u044D",
"\u{1E049}"=>"\u044E",
"\u{1E04A}"=>"\uA689",
"\u{1E04B}"=>"\u04D9",
"\u{1E04C}"=>"\u0456",
"\u{1E04D}"=>"\u0458",
"\u{1E04E}"=>"\u04E9",
"\u{1E04F}"=>"\u04AF",
"\u{1E050}"=>"\u04CF",
"\u{1E051}"=>"\u0430",
"\u{1E052}"=>"\u0431",
"\u{1E053}"=>"\u0432",
"\u{1E054}"=>"\u0433",
"\u{1E055}"=>"\u0434",
"\u{1E056}"=>"\u0435",
"\u{1E057}"=>"\u0436",
"\u{1E058}"=>"\u0437",
"\u{1E059}"=>"\u0438",
"\u{1E05A}"=>"\u043A",
"\u{1E05B}"=>"\u043B",
"\u{1E05C}"=>"\u043E",
"\u{1E05D}"=>"\u043F",
"\u{1E05E}"=>"\u0441",
"\u{1E05F}"=>"\u0443",
"\u{1E060}"=>"\u0444",
"\u{1E061}"=>"\u0445",
"\u{1E062}"=>"\u0446",
"\u{1E063}"=>"\u0447",
"\u{1E064}"=>"\u0448",
"\u{1E065}"=>"\u044A",
"\u{1E066}"=>"\u044B",
"\u{1E067}"=>"\u0491",
"\u{1E068}"=>"\u0456",
"\u{1E069}"=>"\u0455",
"\u{1E06A}"=>"\u045F",
"\u{1E06B}"=>"\u04AB",
"\u{1E06C}"=>"\uA651",
"\u{1E06D}"=>"\u04B1",
"\u{1EE00}"=>"\u0627",
"\u{1EE01}"=>"\u0628",
"\u{1EE02}"=>"\u062C",
"\u{1EE03}"=>"\u062F",
"\u{1EE05}"=>"\u0648",
"\u{1EE06}"=>"\u0632",
"\u{1EE07}"=>"\u062D",
"\u{1EE08}"=>"\u0637",
"\u{1EE09}"=>"\u064A",
"\u{1EE0A}"=>"\u0643",
"\u{1EE0B}"=>"\u0644",
"\u{1EE0C}"=>"\u0645",
"\u{1EE0D}"=>"\u0646",
"\u{1EE0E}"=>"\u0633",
"\u{1EE0F}"=>"\u0639",
"\u{1EE10}"=>"\u0641",
"\u{1EE11}"=>"\u0635",
"\u{1EE12}"=>"\u0642",
"\u{1EE13}"=>"\u0631",
"\u{1EE14}"=>"\u0634",
"\u{1EE15}"=>"\u062A",
"\u{1EE16}"=>"\u062B",
"\u{1EE17}"=>"\u062E",
"\u{1EE18}"=>"\u0630",
"\u{1EE19}"=>"\u0636",
"\u{1EE1A}"=>"\u0638",
"\u{1EE1B}"=>"\u063A",
"\u{1EE1C}"=>"\u066E",
"\u{1EE1D}"=>"\u06BA",
"\u{1EE1E}"=>"\u06A1",
"\u{1EE1F}"=>"\u066F",
"\u{1EE21}"=>"\u0628",
"\u{1EE22}"=>"\u062C",
"\u{1EE24}"=>"\u0647",
"\u{1EE27}"=>"\u062D",
"\u{1EE29}"=>"\u064A",
"\u{1EE2A}"=>"\u0643",
"\u{1EE2B}"=>"\u0644",
"\u{1EE2C}"=>"\u0645",
"\u{1EE2D}"=>"\u0646",
"\u{1EE2E}"=>"\u0633",
"\u{1EE2F}"=>"\u0639",
"\u{1EE30}"=>"\u0641",
"\u{1EE31}"=>"\u0635",
"\u{1EE32}"=>"\u0642",
"\u{1EE34}"=>"\u0634",
"\u{1EE35}"=>"\u062A",
"\u{1EE36}"=>"\u062B",
"\u{1EE37}"=>"\u062E",
"\u{1EE39}"=>"\u0636",
"\u{1EE3B}"=>"\u063A",
"\u{1EE42}"=>"\u062C",
"\u{1EE47}"=>"\u062D",
"\u{1EE49}"=>"\u064A",
"\u{1EE4B}"=>"\u0644",
"\u{1EE4D}"=>"\u0646",
"\u{1EE4E}"=>"\u0633",
"\u{1EE4F}"=>"\u0639",
"\u{1EE51}"=>"\u0635",
"\u{1EE52}"=>"\u0642",
"\u{1EE54}"=>"\u0634",
"\u{1EE57}"=>"\u062E",
"\u{1EE59}"=>"\u0636",
"\u{1EE5B}"=>"\u063A",
"\u{1EE5D}"=>"\u06BA",
"\u{1EE5F}"=>"\u066F",
"\u{1EE61}"=>"\u0628",
"\u{1EE62}"=>"\u062C",
"\u{1EE64}"=>"\u0647",
"\u{1EE67}"=>"\u062D",
"\u{1EE68}"=>"\u0637",
"\u{1EE69}"=>"\u064A",
"\u{1EE6A}"=>"\u0643",
"\u{1EE6C}"=>"\u0645",
"\u{1EE6D}"=>"\u0646",
"\u{1EE6E}"=>"\u0633",
"\u{1EE6F}"=>"\u0639",
"\u{1EE70}"=>"\u0641",
"\u{1EE71}"=>"\u0635",
"\u{1EE72}"=>"\u0642",
"\u{1EE74}"=>"\u0634",
"\u{1EE75}"=>"\u062A",
"\u{1EE76}"=>"\u062B",
"\u{1EE77}"=>"\u062E",
"\u{1EE79}"=>"\u0636",
"\u{1EE7A}"=>"\u0638",
"\u{1EE7B}"=>"\u063A",
"\u{1EE7C}"=>"\u066E",
"\u{1EE7E}"=>"\u06A1",
"\u{1EE80}"=>"\u0627",
"\u{1EE81}"=>"\u0628",
"\u{1EE82}"=>"\u062C",
"\u{1EE83}"=>"\u062F",
"\u{1EE84}"=>"\u0647",
"\u{1EE85}"=>"\u0648",
"\u{1EE86}"=>"\u0632",
"\u{1EE87}"=>"\u062D",
"\u{1EE88}"=>"\u0637",
"\u{1EE89}"=>"\u064A",
"\u{1EE8B}"=>"\u0644",
"\u{1EE8C}"=>"\u0645",
"\u{1EE8D}"=>"\u0646",
"\u{1EE8E}"=>"\u0633",
"\u{1EE8F}"=>"\u0639",
"\u{1EE90}"=>"\u0641",
"\u{1EE91}"=>"\u0635",
"\u{1EE92}"=>"\u0642",
"\u{1EE93}"=>"\u0631",
"\u{1EE94}"=>"\u0634",
"\u{1EE95}"=>"\u062A",
"\u{1EE96}"=>"\u062B",
"\u{1EE97}"=>"\u062E",
"\u{1EE98}"=>"\u0630",
"\u{1EE99}"=>"\u0636",
"\u{1EE9A}"=>"\u0638",
"\u{1EE9B}"=>"\u063A",
"\u{1EEA1}"=>"\u0628",
"\u{1EEA2}"=>"\u062C",
"\u{1EEA3}"=>"\u062F",
"\u{1EEA5}"=>"\u0648",
"\u{1EEA6}"=>"\u0632",
"\u{1EEA7}"=>"\u062D",
"\u{1EEA8}"=>"\u0637",
"\u{1EEA9}"=>"\u064A",
"\u{1EEAB}"=>"\u0644",
"\u{1EEAC}"=>"\u0645",
"\u{1EEAD}"=>"\u0646",
"\u{1EEAE}"=>"\u0633",
"\u{1EEAF}"=>"\u0639",
"\u{1EEB0}"=>"\u0641",
"\u{1EEB1}"=>"\u0635",
"\u{1EEB2}"=>"\u0642",
"\u{1EEB3}"=>"\u0631",
"\u{1EEB4}"=>"\u0634",
"\u{1EEB5}"=>"\u062A",
"\u{1EEB6}"=>"\u062B",
"\u{1EEB7}"=>"\u062E",
"\u{1EEB8}"=>"\u0630",
"\u{1EEB9}"=>"\u0636",
"\u{1EEBA}"=>"\u0638",
"\u{1EEBB}"=>"\u063A",
"\u{1F100}"=>"0.",
"\u{1F101}"=>"0,",
"\u{1F102}"=>"1,",
"\u{1F103}"=>"2,",
"\u{1F104}"=>"3,",
"\u{1F105}"=>"4,",
"\u{1F106}"=>"5,",
"\u{1F107}"=>"6,",
"\u{1F108}"=>"7,",
"\u{1F109}"=>"8,",
"\u{1F10A}"=>"9,",
"\u{1F110}"=>"(A)",
"\u{1F111}"=>"(B)",
"\u{1F112}"=>"(C)",
"\u{1F113}"=>"(D)",
"\u{1F114}"=>"(E)",
"\u{1F115}"=>"(F)",
"\u{1F116}"=>"(G)",
"\u{1F117}"=>"(H)",
"\u{1F118}"=>"(I)",
"\u{1F119}"=>"(J)",
"\u{1F11A}"=>"(K)",
"\u{1F11B}"=>"(L)",
"\u{1F11C}"=>"(M)",
"\u{1F11D}"=>"(N)",
"\u{1F11E}"=>"(O)",
"\u{1F11F}"=>"(P)",
"\u{1F120}"=>"(Q)",
"\u{1F121}"=>"(R)",
"\u{1F122}"=>"(S)",
"\u{1F123}"=>"(T)",
"\u{1F124}"=>"(U)",
"\u{1F125}"=>"(V)",
"\u{1F126}"=>"(W)",
"\u{1F127}"=>"(X)",
"\u{1F128}"=>"(Y)",
"\u{1F129}"=>"(Z)",
"\u{1F12A}"=>"\u3014S\u3015",
"\u{1F12B}"=>"C",
"\u{1F12C}"=>"R",
"\u{1F12D}"=>"CD",
"\u{1F12E}"=>"WZ",
"\u{1F130}"=>"A",
"\u{1F131}"=>"B",
"\u{1F132}"=>"C",
"\u{1F133}"=>"D",
"\u{1F134}"=>"E",
"\u{1F135}"=>"F",
"\u{1F136}"=>"G",
"\u{1F137}"=>"H",
"\u{1F138}"=>"I",
"\u{1F139}"=>"J",
"\u{1F13A}"=>"K",
"\u{1F13B}"=>"L",
"\u{1F13C}"=>"M",
"\u{1F13D}"=>"N",
"\u{1F13E}"=>"O",
"\u{1F13F}"=>"P",
"\u{1F140}"=>"Q",
"\u{1F141}"=>"R",
"\u{1F142}"=>"S",
"\u{1F143}"=>"T",
"\u{1F144}"=>"U",
"\u{1F145}"=>"V",
"\u{1F146}"=>"W",
"\u{1F147}"=>"X",
"\u{1F148}"=>"Y",
"\u{1F149}"=>"Z",
"\u{1F14A}"=>"HV",
"\u{1F14B}"=>"MV",
"\u{1F14C}"=>"SD",
"\u{1F14D}"=>"SS",
"\u{1F14E}"=>"PPV",
"\u{1F14F}"=>"WC",
"\u{1F16A}"=>"MC",
"\u{1F16B}"=>"MD",
"\u{1F16C}"=>"MR",
"\u{1F190}"=>"DJ",
"\u{1F200}"=>"\u307B\u304B",
"\u{1F201}"=>"\u30B3\u30B3",
"\u{1F202}"=>"\u30B5",
"\u{1F210}"=>"\u624B",
"\u{1F211}"=>"\u5B57",
"\u{1F212}"=>"\u53CC",
"\u{1F213}"=>"\u30C7",
"\u{1F214}"=>"\u4E8C",
"\u{1F215}"=>"\u591A",
"\u{1F216}"=>"\u89E3",
"\u{1F217}"=>"\u5929",
"\u{1F218}"=>"\u4EA4",
"\u{1F219}"=>"\u6620",
"\u{1F21A}"=>"\u7121",
"\u{1F21B}"=>"\u6599",
"\u{1F21C}"=>"\u524D",
"\u{1F21D}"=>"\u5F8C",
"\u{1F21E}"=>"\u518D",
"\u{1F21F}"=>"\u65B0",
"\u{1F220}"=>"\u521D",
"\u{1F221}"=>"\u7D42",
"\u{1F222}"=>"\u751F",
"\u{1F223}"=>"\u8CA9",
"\u{1F224}"=>"\u58F0",
"\u{1F225}"=>"\u5439",
"\u{1F226}"=>"\u6F14",
"\u{1F227}"=>"\u6295",
"\u{1F228}"=>"\u6355",
"\u{1F229}"=>"\u4E00",
"\u{1F22A}"=>"\u4E09",
"\u{1F22B}"=>"\u904A",
"\u{1F22C}"=>"\u5DE6",
"\u{1F22D}"=>"\u4E2D",
"\u{1F22E}"=>"\u53F3",
"\u{1F22F}"=>"\u6307",
"\u{1F230}"=>"\u8D70",
"\u{1F231}"=>"\u6253",
"\u{1F232}"=>"\u7981",
"\u{1F233}"=>"\u7A7A",
"\u{1F234}"=>"\u5408",
"\u{1F235}"=>"\u6E80",
"\u{1F236}"=>"\u6709",
"\u{1F237}"=>"\u6708",
"\u{1F238}"=>"\u7533",
"\u{1F239}"=>"\u5272",
"\u{1F23A}"=>"\u55B6",
"\u{1F23B}"=>"\u914D",
"\u{1F240}"=>"\u3014\u672C\u3015",
"\u{1F241}"=>"\u3014\u4E09\u3015",
"\u{1F242}"=>"\u3014\u4E8C\u3015",
"\u{1F243}"=>"\u3014\u5B89\u3015",
"\u{1F244}"=>"\u3014\u70B9\u3015",
"\u{1F245}"=>"\u3014\u6253\u3015",
"\u{1F246}"=>"\u3014\u76D7\u3015",
"\u{1F247}"=>"\u3014\u52DD\u3015",
"\u{1F248}"=>"\u3014\u6557\u3015",
"\u{1F250}"=>"\u5F97",
"\u{1F251}"=>"\u53EF",
"\u{1FBF0}"=>"0",
"\u{1FBF1}"=>"1",
"\u{1FBF2}"=>"2",
"\u{1FBF3}"=>"3",
"\u{1FBF4}"=>"4",
"\u{1FBF5}"=>"5",
"\u{1FBF6}"=>"6",
"\u{1FBF7}"=>"7",
"\u{1FBF8}"=>"8",
"\u{1FBF9}"=>"9",
"\u0385"=>" \u0308\u0301",
"\u03D3"=>"\u03A5\u0301",
"\u03D4"=>"\u03A5\u0308",
"\u1E9B"=>"s\u0307",
"\u1FC1"=>" \u0308\u0342",
"\u1FCD"=>" \u0313\u0300",
"\u1FCE"=>" \u0313\u0301",
"\u1FCF"=>" \u0313\u0342",
"\u1FDD"=>" \u0314\u0300",
"\u1FDE"=>" \u0314\u0301",
"\u1FDF"=>" \u0314\u0342",
"\u1FED"=>" \u0308\u0300",
"\u1FEE"=>" \u0308\u0301",
"\u1FFD"=>" \u0301",
"\u2000"=>" ",
"\u2001"=>" ",
}.freeze
COMPOSITION_TABLE = {
"A\u0300"=>"\u00C0",
"A\u0301"=>"\u00C1",
"A\u0302"=>"\u00C2",
"A\u0303"=>"\u00C3",
"A\u0308"=>"\u00C4",
"A\u030A"=>"\u00C5",
"C\u0327"=>"\u00C7",
"E\u0300"=>"\u00C8",
"E\u0301"=>"\u00C9",
"E\u0302"=>"\u00CA",
"E\u0308"=>"\u00CB",
"I\u0300"=>"\u00CC",
"I\u0301"=>"\u00CD",
"I\u0302"=>"\u00CE",
"I\u0308"=>"\u00CF",
"N\u0303"=>"\u00D1",
"O\u0300"=>"\u00D2",
"O\u0301"=>"\u00D3",
"O\u0302"=>"\u00D4",
"O\u0303"=>"\u00D5",
"O\u0308"=>"\u00D6",
"U\u0300"=>"\u00D9",
"U\u0301"=>"\u00DA",
"U\u0302"=>"\u00DB",
"U\u0308"=>"\u00DC",
"Y\u0301"=>"\u00DD",
"a\u0300"=>"\u00E0",
"a\u0301"=>"\u00E1",
"a\u0302"=>"\u00E2",
"a\u0303"=>"\u00E3",
"a\u0308"=>"\u00E4",
"a\u030A"=>"\u00E5",
"c\u0327"=>"\u00E7",
"e\u0300"=>"\u00E8",
"e\u0301"=>"\u00E9",
"e\u0302"=>"\u00EA",
"e\u0308"=>"\u00EB",
"i\u0300"=>"\u00EC",
"i\u0301"=>"\u00ED",
"i\u0302"=>"\u00EE",
"i\u0308"=>"\u00EF",
"n\u0303"=>"\u00F1",
"o\u0300"=>"\u00F2",
"o\u0301"=>"\u00F3",
"o\u0302"=>"\u00F4",
"o\u0303"=>"\u00F5",
"o\u0308"=>"\u00F6",
"u\u0300"=>"\u00F9",
"u\u0301"=>"\u00FA",
"u\u0302"=>"\u00FB",
"u\u0308"=>"\u00FC",
"y\u0301"=>"\u00FD",
"y\u0308"=>"\u00FF",
"A\u0304"=>"\u0100",
"a\u0304"=>"\u0101",
"A\u0306"=>"\u0102",
"a\u0306"=>"\u0103",
"A\u0328"=>"\u0104",
"a\u0328"=>"\u0105",
"C\u0301"=>"\u0106",
"c\u0301"=>"\u0107",
"C\u0302"=>"\u0108",
"c\u0302"=>"\u0109",
"C\u0307"=>"\u010A",
"c\u0307"=>"\u010B",
"C\u030C"=>"\u010C",
"c\u030C"=>"\u010D",
"D\u030C"=>"\u010E",
"d\u030C"=>"\u010F",
"E\u0304"=>"\u0112",
"e\u0304"=>"\u0113",
"E\u0306"=>"\u0114",
"e\u0306"=>"\u0115",
"E\u0307"=>"\u0116",
"e\u0307"=>"\u0117",
"E\u0328"=>"\u0118",
"e\u0328"=>"\u0119",
"E\u030C"=>"\u011A",
"e\u030C"=>"\u011B",
"G\u0302"=>"\u011C",
"g\u0302"=>"\u011D",
"G\u0306"=>"\u011E",
"g\u0306"=>"\u011F",
"G\u0307"=>"\u0120",
"g\u0307"=>"\u0121",
"G\u0327"=>"\u0122",
"g\u0327"=>"\u0123",
"H\u0302"=>"\u0124",
"h\u0302"=>"\u0125",
"I\u0303"=>"\u0128",
"i\u0303"=>"\u0129",
"I\u0304"=>"\u012A",
"i\u0304"=>"\u012B",
"I\u0306"=>"\u012C",
"i\u0306"=>"\u012D",
"I\u0328"=>"\u012E",
"i\u0328"=>"\u012F",
"I\u0307"=>"\u0130",
"J\u0302"=>"\u0134",
"j\u0302"=>"\u0135",
"K\u0327"=>"\u0136",
"k\u0327"=>"\u0137",
"L\u0301"=>"\u0139",
"l\u0301"=>"\u013A",
"L\u0327"=>"\u013B",
"l\u0327"=>"\u013C",
"L\u030C"=>"\u013D",
"l\u030C"=>"\u013E",
"N\u0301"=>"\u0143",
"n\u0301"=>"\u0144",
"N\u0327"=>"\u0145",
"n\u0327"=>"\u0146",
"N\u030C"=>"\u0147",
"n\u030C"=>"\u0148",
"O\u0304"=>"\u014C",
"o\u0304"=>"\u014D",
"O\u0306"=>"\u014E",
"o\u0306"=>"\u014F",
"O\u030B"=>"\u0150",
"o\u030B"=>"\u0151",
"R\u0301"=>"\u0154",
"r\u0301"=>"\u0155",
"R\u0327"=>"\u0156",
"r\u0327"=>"\u0157",
"R\u030C"=>"\u0158",
"r\u030C"=>"\u0159",
"S\u0301"=>"\u015A",
"s\u0301"=>"\u015B",
"S\u0302"=>"\u015C",
"s\u0302"=>"\u015D",
"S\u0327"=>"\u015E",
"s\u0327"=>"\u015F",
"S\u030C"=>"\u0160",
"s\u030C"=>"\u0161",
"T\u0327"=>"\u0162",
"t\u0327"=>"\u0163",
"T\u030C"=>"\u0164",
"t\u030C"=>"\u0165",
"U\u0303"=>"\u0168",
"u\u0303"=>"\u0169",
"U\u0304"=>"\u016A",
"u\u0304"=>"\u016B",
"U\u0306"=>"\u016C",
"u\u0306"=>"\u016D",
"U\u030A"=>"\u016E",
"u\u030A"=>"\u016F",
"U\u030B"=>"\u0170",
"u\u030B"=>"\u0171",
"U\u0328"=>"\u0172",
"u\u0328"=>"\u0173",
"W\u0302"=>"\u0174",
"w\u0302"=>"\u0175",
"Y\u0302"=>"\u0176",
"y\u0302"=>"\u0177",
"Y\u0308"=>"\u0178",
"Z\u0301"=>"\u0179",
"z\u0301"=>"\u017A",
"Z\u0307"=>"\u017B",
"z\u0307"=>"\u017C",
"Z\u030C"=>"\u017D",
"z\u030C"=>"\u017E",
"O\u031B"=>"\u01A0",
"o\u031B"=>"\u01A1",
"U\u031B"=>"\u01AF",
"u\u031B"=>"\u01B0",
"A\u030C"=>"\u01CD",
"a\u030C"=>"\u01CE",
"I\u030C"=>"\u01CF",
"i\u030C"=>"\u01D0",
"O\u030C"=>"\u01D1",
"o\u030C"=>"\u01D2",
"U\u030C"=>"\u01D3",
"u\u030C"=>"\u01D4",
"\u00DC\u0304"=>"\u01D5",
"\u00FC\u0304"=>"\u01D6",
"\u00DC\u0301"=>"\u01D7",
"\u00FC\u0301"=>"\u01D8",
"\u00DC\u030C"=>"\u01D9",
"\u00FC\u030C"=>"\u01DA",
"\u00DC\u0300"=>"\u01DB",
"\u00FC\u0300"=>"\u01DC",
"\u00C4\u0304"=>"\u01DE",
"\u00E4\u0304"=>"\u01DF",
"\u0226\u0304"=>"\u01E0",
"\u0227\u0304"=>"\u01E1",
"\u00C6\u0304"=>"\u01E2",
"\u00E6\u0304"=>"\u01E3",
"G\u030C"=>"\u01E6",
"g\u030C"=>"\u01E7",
"K\u030C"=>"\u01E8",
"k\u030C"=>"\u01E9",
"O\u0328"=>"\u01EA",
"o\u0328"=>"\u01EB",
"\u01EA\u0304"=>"\u01EC",
"\u01EB\u0304"=>"\u01ED",
"\u01B7\u030C"=>"\u01EE",
"\u0292\u030C"=>"\u01EF",
"j\u030C"=>"\u01F0",
"G\u0301"=>"\u01F4",
"g\u0301"=>"\u01F5",
"N\u0300"=>"\u01F8",
"n\u0300"=>"\u01F9",
"\u00C5\u0301"=>"\u01FA",
"\u00E5\u0301"=>"\u01FB",
"\u00C6\u0301"=>"\u01FC",
"\u00E6\u0301"=>"\u01FD",
"\u00D8\u0301"=>"\u01FE",
"\u00F8\u0301"=>"\u01FF",
"A\u030F"=>"\u0200",
"a\u030F"=>"\u0201",
"A\u0311"=>"\u0202",
"a\u0311"=>"\u0203",
"E\u030F"=>"\u0204",
"e\u030F"=>"\u0205",
"E\u0311"=>"\u0206",
"e\u0311"=>"\u0207",
"I\u030F"=>"\u0208",
"i\u030F"=>"\u0209",
"I\u0311"=>"\u020A",
"i\u0311"=>"\u020B",
"O\u030F"=>"\u020C",
"o\u030F"=>"\u020D",
"O\u0311"=>"\u020E",
"o\u0311"=>"\u020F",
"R\u030F"=>"\u0210",
"r\u030F"=>"\u0211",
"R\u0311"=>"\u0212",
"r\u0311"=>"\u0213",
"U\u030F"=>"\u0214",
"u\u030F"=>"\u0215",
"U\u0311"=>"\u0216",
"u\u0311"=>"\u0217",
"S\u0326"=>"\u0218",
"s\u0326"=>"\u0219",
"T\u0326"=>"\u021A",
"t\u0326"=>"\u021B",
"H\u030C"=>"\u021E",
"h\u030C"=>"\u021F",
"A\u0307"=>"\u0226",
"a\u0307"=>"\u0227",
"E\u0327"=>"\u0228",
"e\u0327"=>"\u0229",
"\u00D6\u0304"=>"\u022A",
"\u00F6\u0304"=>"\u022B",
"\u00D5\u0304"=>"\u022C",
"\u00F5\u0304"=>"\u022D",
"O\u0307"=>"\u022E",
"o\u0307"=>"\u022F",
"\u022E\u0304"=>"\u0230",
"\u022F\u0304"=>"\u0231",
"Y\u0304"=>"\u0232",
"y\u0304"=>"\u0233",
"\u00A8\u0301"=>"\u0385",
"\u0391\u0301"=>"\u0386",
"\u0395\u0301"=>"\u0388",
"\u0397\u0301"=>"\u0389",
"\u0399\u0301"=>"\u038A",
"\u039F\u0301"=>"\u038C",
"\u03A5\u0301"=>"\u038E",
"\u03A9\u0301"=>"\u038F",
"\u03CA\u0301"=>"\u0390",
"\u0399\u0308"=>"\u03AA",
"\u03A5\u0308"=>"\u03AB",
"\u03B1\u0301"=>"\u03AC",
"\u03B5\u0301"=>"\u03AD",
"\u03B7\u0301"=>"\u03AE",
"\u03B9\u0301"=>"\u03AF",
"\u03CB\u0301"=>"\u03B0",
"\u03B9\u0308"=>"\u03CA",
"\u03C5\u0308"=>"\u03CB",
"\u03BF\u0301"=>"\u03CC",
"\u03C5\u0301"=>"\u03CD",
"\u03C9\u0301"=>"\u03CE",
"\u03D2\u0301"=>"\u03D3",
"\u03D2\u0308"=>"\u03D4",
"\u0415\u0300"=>"\u0400",
"\u0415\u0308"=>"\u0401",
"\u0413\u0301"=>"\u0403",
"\u0406\u0308"=>"\u0407",
"\u041A\u0301"=>"\u040C",
"\u0418\u0300"=>"\u040D",
"\u0423\u0306"=>"\u040E",
"\u0418\u0306"=>"\u0419",
"\u0438\u0306"=>"\u0439",
"\u0435\u0300"=>"\u0450",
"\u0435\u0308"=>"\u0451",
"\u0433\u0301"=>"\u0453",
"\u0456\u0308"=>"\u0457",
"\u043A\u0301"=>"\u045C",
"\u0438\u0300"=>"\u045D",
"\u0443\u0306"=>"\u045E",
"\u0474\u030F"=>"\u0476",
"\u0475\u030F"=>"\u0477",
"\u0416\u0306"=>"\u04C1",
"\u0436\u0306"=>"\u04C2",
"\u0410\u0306"=>"\u04D0",
"\u0430\u0306"=>"\u04D1",
"\u0410\u0308"=>"\u04D2",
"\u0430\u0308"=>"\u04D3",
"\u0415\u0306"=>"\u04D6",
"\u0435\u0306"=>"\u04D7",
"\u04D8\u0308"=>"\u04DA",
"\u04D9\u0308"=>"\u04DB",
"\u0416\u0308"=>"\u04DC",
"\u0436\u0308"=>"\u04DD",
"\u0417\u0308"=>"\u04DE",
"\u0437\u0308"=>"\u04DF",
"\u0418\u0304"=>"\u04E2",
"\u0438\u0304"=>"\u04E3",
"\u0418\u0308"=>"\u04E4",
"\u0438\u0308"=>"\u04E5",
"\u041E\u0308"=>"\u04E6",
"\u043E\u0308"=>"\u04E7",
"\u04E8\u0308"=>"\u04EA",
"\u04E9\u0308"=>"\u04EB",
"\u042D\u0308"=>"\u04EC",
"\u044D\u0308"=>"\u04ED",
"\u0423\u0304"=>"\u04EE",
"\u0443\u0304"=>"\u04EF",
"\u0423\u0308"=>"\u04F0",
"\u0443\u0308"=>"\u04F1",
"\u0423\u030B"=>"\u04F2",
"\u0443\u030B"=>"\u04F3",
"\u0427\u0308"=>"\u04F4",
"\u0447\u0308"=>"\u04F5",
"\u042B\u0308"=>"\u04F8",
"\u044B\u0308"=>"\u04F9",
"\u0627\u0653"=>"\u0622",
"\u0627\u0654"=>"\u0623",
"\u0648\u0654"=>"\u0624",
"\u0627\u0655"=>"\u0625",
"\u064A\u0654"=>"\u0626",
"\u06D5\u0654"=>"\u06C0",
"\u06C1\u0654"=>"\u06C2",
"\u06D2\u0654"=>"\u06D3",
"\u0928\u093C"=>"\u0929",
"\u0930\u093C"=>"\u0931",
"\u0933\u093C"=>"\u0934",
"\u09C7\u09BE"=>"\u09CB",
"\u09C7\u09D7"=>"\u09CC",
"\u0B47\u0B56"=>"\u0B48",
"\u0B47\u0B3E"=>"\u0B4B",
"\u0B47\u0B57"=>"\u0B4C",
"\u0B92\u0BD7"=>"\u0B94",
"\u0BC6\u0BBE"=>"\u0BCA",
"\u0BC7\u0BBE"=>"\u0BCB",
"\u0BC6\u0BD7"=>"\u0BCC",
"\u0C46\u0C56"=>"\u0C48",
"\u0CBF\u0CD5"=>"\u0CC0",
"\u0CC6\u0CD5"=>"\u0CC7",
"\u0CC6\u0CD6"=>"\u0CC8",
"\u0CC6\u0CC2"=>"\u0CCA",
"\u0CCA\u0CD5"=>"\u0CCB",
"\u0D46\u0D3E"=>"\u0D4A",
"\u0D47\u0D3E"=>"\u0D4B",
"\u0D46\u0D57"=>"\u0D4C",
"\u0DD9\u0DCA"=>"\u0DDA",
"\u0DD9\u0DCF"=>"\u0DDC",
"\u0DDC\u0DCA"=>"\u0DDD",
"\u0DD9\u0DDF"=>"\u0DDE",
"\u1025\u102E"=>"\u1026",
"\u1B05\u1B35"=>"\u1B06",
"\u1B07\u1B35"=>"\u1B08",
"\u1B09\u1B35"=>"\u1B0A",
"\u1B0B\u1B35"=>"\u1B0C",
"\u1B0D\u1B35"=>"\u1B0E",
"\u1B11\u1B35"=>"\u1B12",
"\u1B3A\u1B35"=>"\u1B3B",
"\u1B3C\u1B35"=>"\u1B3D",
"\u1B3E\u1B35"=>"\u1B40",
"\u1B3F\u1B35"=>"\u1B41",
"\u1B42\u1B35"=>"\u1B43",
"A\u0325"=>"\u1E00",
"a\u0325"=>"\u1E01",
"B\u0307"=>"\u1E02",
"b\u0307"=>"\u1E03",
"B\u0323"=>"\u1E04",
"b\u0323"=>"\u1E05",
"B\u0331"=>"\u1E06",
"b\u0331"=>"\u1E07",
"\u00C7\u0301"=>"\u1E08",
"\u00E7\u0301"=>"\u1E09",
"D\u0307"=>"\u1E0A",
"d\u0307"=>"\u1E0B",
"D\u0323"=>"\u1E0C",
"d\u0323"=>"\u1E0D",
"D\u0331"=>"\u1E0E",
"d\u0331"=>"\u1E0F",
"D\u0327"=>"\u1E10",
"d\u0327"=>"\u1E11",
"D\u032D"=>"\u1E12",
"d\u032D"=>"\u1E13",
"\u0112\u0300"=>"\u1E14",
"\u0113\u0300"=>"\u1E15",
"\u0112\u0301"=>"\u1E16",
"\u0113\u0301"=>"\u1E17",
"E\u032D"=>"\u1E18",
"e\u032D"=>"\u1E19",
"E\u0330"=>"\u1E1A",
"e\u0330"=>"\u1E1B",
"\u0228\u0306"=>"\u1E1C",
"\u0229\u0306"=>"\u1E1D",
"F\u0307"=>"\u1E1E",
"f\u0307"=>"\u1E1F",
"G\u0304"=>"\u1E20",
"g\u0304"=>"\u1E21",
"H\u0307"=>"\u1E22",
"h\u0307"=>"\u1E23",
"H\u0323"=>"\u1E24",
"h\u0323"=>"\u1E25",
"H\u0308"=>"\u1E26",
"h\u0308"=>"\u1E27",
"H\u0327"=>"\u1E28",
"h\u0327"=>"\u1E29",
"H\u032E"=>"\u1E2A",
"h\u032E"=>"\u1E2B",
"I\u0330"=>"\u1E2C",
"i\u0330"=>"\u1E2D",
"\u00CF\u0301"=>"\u1E2E",
"\u00EF\u0301"=>"\u1E2F",
"K\u0301"=>"\u1E30",
"k\u0301"=>"\u1E31",
"K\u0323"=>"\u1E32",
"k\u0323"=>"\u1E33",
"K\u0331"=>"\u1E34",
"k\u0331"=>"\u1E35",
"L\u0323"=>"\u1E36",
"l\u0323"=>"\u1E37",
"\u1E36\u0304"=>"\u1E38",
"\u1E37\u0304"=>"\u1E39",
"L\u0331"=>"\u1E3A",
"l\u0331"=>"\u1E3B",
"L\u032D"=>"\u1E3C",
"l\u032D"=>"\u1E3D",
"M\u0301"=>"\u1E3E",
"m\u0301"=>"\u1E3F",
"M\u0307"=>"\u1E40",
"m\u0307"=>"\u1E41",
"M\u0323"=>"\u1E42",
"m\u0323"=>"\u1E43",
"N\u0307"=>"\u1E44",
"n\u0307"=>"\u1E45",
"N\u0323"=>"\u1E46",
"n\u0323"=>"\u1E47",
"N\u0331"=>"\u1E48",
"n\u0331"=>"\u1E49",
"N\u032D"=>"\u1E4A",
"n\u032D"=>"\u1E4B",
"\u00D5\u0301"=>"\u1E4C",
"\u00F5\u0301"=>"\u1E4D",
"\u00D5\u0308"=>"\u1E4E",
"\u00F5\u0308"=>"\u1E4F",
"\u014C\u0300"=>"\u1E50",
"\u014D\u0300"=>"\u1E51",
"\u014C\u0301"=>"\u1E52",
"\u014D\u0301"=>"\u1E53",
"P\u0301"=>"\u1E54",
"p\u0301"=>"\u1E55",
"P\u0307"=>"\u1E56",
"p\u0307"=>"\u1E57",
"R\u0307"=>"\u1E58",
"r\u0307"=>"\u1E59",
"R\u0323"=>"\u1E5A",
"r\u0323"=>"\u1E5B",
"\u1E5A\u0304"=>"\u1E5C",
"\u1E5B\u0304"=>"\u1E5D",
"R\u0331"=>"\u1E5E",
"r\u0331"=>"\u1E5F",
"S\u0307"=>"\u1E60",
"s\u0307"=>"\u1E61",
"S\u0323"=>"\u1E62",
"s\u0323"=>"\u1E63",
"\u015A\u0307"=>"\u1E64",
"\u015B\u0307"=>"\u1E65",
"\u0160\u0307"=>"\u1E66",
"\u0161\u0307"=>"\u1E67",
"\u1E62\u0307"=>"\u1E68",
"\u1E63\u0307"=>"\u1E69",
"T\u0307"=>"\u1E6A",
"t\u0307"=>"\u1E6B",
"T\u0323"=>"\u1E6C",
"t\u0323"=>"\u1E6D",
"T\u0331"=>"\u1E6E",
"t\u0331"=>"\u1E6F",
"T\u032D"=>"\u1E70",
"t\u032D"=>"\u1E71",
"U\u0324"=>"\u1E72",
"u\u0324"=>"\u1E73",
"U\u0330"=>"\u1E74",
"u\u0330"=>"\u1E75",
"U\u032D"=>"\u1E76",
"u\u032D"=>"\u1E77",
"\u0168\u0301"=>"\u1E78",
"\u0169\u0301"=>"\u1E79",
"\u016A\u0308"=>"\u1E7A",
"\u016B\u0308"=>"\u1E7B",
"V\u0303"=>"\u1E7C",
"v\u0303"=>"\u1E7D",
"V\u0323"=>"\u1E7E",
"v\u0323"=>"\u1E7F",
"W\u0300"=>"\u1E80",
"w\u0300"=>"\u1E81",
"W\u0301"=>"\u1E82",
"w\u0301"=>"\u1E83",
"W\u0308"=>"\u1E84",
"w\u0308"=>"\u1E85",
"W\u0307"=>"\u1E86",
"w\u0307"=>"\u1E87",
"W\u0323"=>"\u1E88",
"w\u0323"=>"\u1E89",
"X\u0307"=>"\u1E8A",
"x\u0307"=>"\u1E8B",
"X\u0308"=>"\u1E8C",
"x\u0308"=>"\u1E8D",
"Y\u0307"=>"\u1E8E",
"y\u0307"=>"\u1E8F",
"Z\u0302"=>"\u1E90",
"z\u0302"=>"\u1E91",
"Z\u0323"=>"\u1E92",
"z\u0323"=>"\u1E93",
"Z\u0331"=>"\u1E94",
"z\u0331"=>"\u1E95",
"h\u0331"=>"\u1E96",
"t\u0308"=>"\u1E97",
"w\u030A"=>"\u1E98",
"y\u030A"=>"\u1E99",
"\u017F\u0307"=>"\u1E9B",
"A\u0323"=>"\u1EA0",
"a\u0323"=>"\u1EA1",
"A\u0309"=>"\u1EA2",
"a\u0309"=>"\u1EA3",
"\u00C2\u0301"=>"\u1EA4",
"\u00E2\u0301"=>"\u1EA5",
"\u00C2\u0300"=>"\u1EA6",
"\u00E2\u0300"=>"\u1EA7",
"\u00C2\u0309"=>"\u1EA8",
"\u00E2\u0309"=>"\u1EA9",
"\u00C2\u0303"=>"\u1EAA",
"\u00E2\u0303"=>"\u1EAB",
"\u1EA0\u0302"=>"\u1EAC",
"\u1EA1\u0302"=>"\u1EAD",
"\u0102\u0301"=>"\u1EAE",
"\u0103\u0301"=>"\u1EAF",
"\u0102\u0300"=>"\u1EB0",
"\u0103\u0300"=>"\u1EB1",
"\u0102\u0309"=>"\u1EB2",
"\u0103\u0309"=>"\u1EB3",
"\u0102\u0303"=>"\u1EB4",
"\u0103\u0303"=>"\u1EB5",
"\u1EA0\u0306"=>"\u1EB6",
"\u1EA1\u0306"=>"\u1EB7",
"E\u0323"=>"\u1EB8",
"e\u0323"=>"\u1EB9",
"E\u0309"=>"\u1EBA",
"e\u0309"=>"\u1EBB",
"E\u0303"=>"\u1EBC",
"e\u0303"=>"\u1EBD",
"\u00CA\u0301"=>"\u1EBE",
"\u00EA\u0301"=>"\u1EBF",
"\u00CA\u0300"=>"\u1EC0",
"\u00EA\u0300"=>"\u1EC1",
"\u00CA\u0309"=>"\u1EC2",
"\u00EA\u0309"=>"\u1EC3",
"\u00CA\u0303"=>"\u1EC4",
"\u00EA\u0303"=>"\u1EC5",
"\u1EB8\u0302"=>"\u1EC6",
"\u1EB9\u0302"=>"\u1EC7",
"I\u0309"=>"\u1EC8",
"i\u0309"=>"\u1EC9",
"I\u0323"=>"\u1ECA",
"i\u0323"=>"\u1ECB",
"O\u0323"=>"\u1ECC",
"o\u0323"=>"\u1ECD",
"O\u0309"=>"\u1ECE",
"o\u0309"=>"\u1ECF",
"\u00D4\u0301"=>"\u1ED0",
"\u00F4\u0301"=>"\u1ED1",
"\u00D4\u0300"=>"\u1ED2",
"\u00F4\u0300"=>"\u1ED3",
"\u00D4\u0309"=>"\u1ED4",
"\u00F4\u0309"=>"\u1ED5",
"\u00D4\u0303"=>"\u1ED6",
"\u00F4\u0303"=>"\u1ED7",
"\u1ECC\u0302"=>"\u1ED8",
"\u1ECD\u0302"=>"\u1ED9",
"\u01A0\u0301"=>"\u1EDA",
"\u01A1\u0301"=>"\u1EDB",
"\u01A0\u0300"=>"\u1EDC",
"\u01A1\u0300"=>"\u1EDD",
"\u01A0\u0309"=>"\u1EDE",
"\u01A1\u0309"=>"\u1EDF",
"\u01A0\u0303"=>"\u1EE0",
"\u01A1\u0303"=>"\u1EE1",
"\u01A0\u0323"=>"\u1EE2",
"\u01A1\u0323"=>"\u1EE3",
"U\u0323"=>"\u1EE4",
"u\u0323"=>"\u1EE5",
"U\u0309"=>"\u1EE6",
"u\u0309"=>"\u1EE7",
"\u01AF\u0301"=>"\u1EE8",
"\u01B0\u0301"=>"\u1EE9",
"\u01AF\u0300"=>"\u1EEA",
"\u01B0\u0300"=>"\u1EEB",
"\u01AF\u0309"=>"\u1EEC",
"\u01B0\u0309"=>"\u1EED",
"\u01AF\u0303"=>"\u1EEE",
"\u01B0\u0303"=>"\u1EEF",
"\u01AF\u0323"=>"\u1EF0",
"\u01B0\u0323"=>"\u1EF1",
"Y\u0300"=>"\u1EF2",
"y\u0300"=>"\u1EF3",
"Y\u0323"=>"\u1EF4",
"y\u0323"=>"\u1EF5",
"Y\u0309"=>"\u1EF6",
"y\u0309"=>"\u1EF7",
"Y\u0303"=>"\u1EF8",
"y\u0303"=>"\u1EF9",
"\u03B1\u0313"=>"\u1F00",
"\u03B1\u0314"=>"\u1F01",
"\u1F00\u0300"=>"\u1F02",
"\u1F01\u0300"=>"\u1F03",
"\u1F00\u0301"=>"\u1F04",
"\u1F01\u0301"=>"\u1F05",
"\u1F00\u0342"=>"\u1F06",
"\u1F01\u0342"=>"\u1F07",
"\u0391\u0313"=>"\u1F08",
"\u0391\u0314"=>"\u1F09",
"\u1F08\u0300"=>"\u1F0A",
"\u1F09\u0300"=>"\u1F0B",
"\u1F08\u0301"=>"\u1F0C",
"\u1F09\u0301"=>"\u1F0D",
"\u1F08\u0342"=>"\u1F0E",
"\u1F09\u0342"=>"\u1F0F",
"\u03B5\u0313"=>"\u1F10",
"\u03B5\u0314"=>"\u1F11",
"\u1F10\u0300"=>"\u1F12",
"\u1F11\u0300"=>"\u1F13",
"\u1F10\u0301"=>"\u1F14",
"\u1F11\u0301"=>"\u1F15",
"\u0395\u0313"=>"\u1F18",
"\u0395\u0314"=>"\u1F19",
"\u1F18\u0300"=>"\u1F1A",
"\u1F19\u0300"=>"\u1F1B",
"\u1F18\u0301"=>"\u1F1C",
"\u1F19\u0301"=>"\u1F1D",
"\u03B7\u0313"=>"\u1F20",
"\u03B7\u0314"=>"\u1F21",
"\u1F20\u0300"=>"\u1F22",
"\u1F21\u0300"=>"\u1F23",
"\u1F20\u0301"=>"\u1F24",
"\u1F21\u0301"=>"\u1F25",
"\u1F20\u0342"=>"\u1F26",
"\u1F21\u0342"=>"\u1F27",
"\u0397\u0313"=>"\u1F28",
"\u0397\u0314"=>"\u1F29",
"\u1F28\u0300"=>"\u1F2A",
"\u1F29\u0300"=>"\u1F2B",
"\u1F28\u0301"=>"\u1F2C",
"\u1F29\u0301"=>"\u1F2D",
"\u1F28\u0342"=>"\u1F2E",
"\u1F29\u0342"=>"\u1F2F",
"\u03B9\u0313"=>"\u1F30",
"\u03B9\u0314"=>"\u1F31",
"\u1F30\u0300"=>"\u1F32",
"\u1F31\u0300"=>"\u1F33",
"\u1F30\u0301"=>"\u1F34",
"\u1F31\u0301"=>"\u1F35",
"\u1F30\u0342"=>"\u1F36",
"\u1F31\u0342"=>"\u1F37",
"\u0399\u0313"=>"\u1F38",
"\u0399\u0314"=>"\u1F39",
"\u1F38\u0300"=>"\u1F3A",
"\u1F39\u0300"=>"\u1F3B",
"\u1F38\u0301"=>"\u1F3C",
"\u1F39\u0301"=>"\u1F3D",
"\u1F38\u0342"=>"\u1F3E",
"\u1F39\u0342"=>"\u1F3F",
"\u03BF\u0313"=>"\u1F40",
"\u03BF\u0314"=>"\u1F41",
"\u1F40\u0300"=>"\u1F42",
"\u1F41\u0300"=>"\u1F43",
"\u1F40\u0301"=>"\u1F44",
"\u1F41\u0301"=>"\u1F45",
"\u039F\u0313"=>"\u1F48",
"\u039F\u0314"=>"\u1F49",
"\u1F48\u0300"=>"\u1F4A",
"\u1F49\u0300"=>"\u1F4B",
"\u1F48\u0301"=>"\u1F4C",
"\u1F49\u0301"=>"\u1F4D",
"\u03C5\u0313"=>"\u1F50",
"\u03C5\u0314"=>"\u1F51",
"\u1F50\u0300"=>"\u1F52",
"\u1F51\u0300"=>"\u1F53",
"\u1F50\u0301"=>"\u1F54",
"\u1F51\u0301"=>"\u1F55",
"\u1F50\u0342"=>"\u1F56",
"\u1F51\u0342"=>"\u1F57",
"\u03A5\u0314"=>"\u1F59",
"\u1F59\u0300"=>"\u1F5B",
"\u1F59\u0301"=>"\u1F5D",
"\u1F59\u0342"=>"\u1F5F",
"\u03C9\u0313"=>"\u1F60",
"\u03C9\u0314"=>"\u1F61",
"\u1F60\u0300"=>"\u1F62",
"\u1F61\u0300"=>"\u1F63",
"\u1F60\u0301"=>"\u1F64",
"\u1F61\u0301"=>"\u1F65",
"\u1F60\u0342"=>"\u1F66",
"\u1F61\u0342"=>"\u1F67",
"\u03A9\u0313"=>"\u1F68",
"\u03A9\u0314"=>"\u1F69",
"\u1F68\u0300"=>"\u1F6A",
"\u1F69\u0300"=>"\u1F6B",
"\u1F68\u0301"=>"\u1F6C",
"\u1F69\u0301"=>"\u1F6D",
"\u1F68\u0342"=>"\u1F6E",
"\u1F69\u0342"=>"\u1F6F",
"\u03B1\u0300"=>"\u1F70",
"\u03B5\u0300"=>"\u1F72",
"\u03B7\u0300"=>"\u1F74",
"\u03B9\u0300"=>"\u1F76",
"\u03BF\u0300"=>"\u1F78",
"\u03C5\u0300"=>"\u1F7A",
"\u03C9\u0300"=>"\u1F7C",
"\u1F00\u0345"=>"\u1F80",
"\u1F01\u0345"=>"\u1F81",
"\u1F02\u0345"=>"\u1F82",
"\u1F03\u0345"=>"\u1F83",
"\u1F04\u0345"=>"\u1F84",
"\u1F05\u0345"=>"\u1F85",
"\u1F06\u0345"=>"\u1F86",
"\u1F07\u0345"=>"\u1F87",
"\u1F08\u0345"=>"\u1F88",
"\u1F09\u0345"=>"\u1F89",
"\u1F0A\u0345"=>"\u1F8A",
"\u1F0B\u0345"=>"\u1F8B",
"\u1F0C\u0345"=>"\u1F8C",
"\u1F0D\u0345"=>"\u1F8D",
"\u1F0E\u0345"=>"\u1F8E",
"\u1F0F\u0345"=>"\u1F8F",
"\u1F20\u0345"=>"\u1F90",
"\u1F21\u0345"=>"\u1F91",
"\u1F22\u0345"=>"\u1F92",
"\u1F23\u0345"=>"\u1F93",
"\u1F24\u0345"=>"\u1F94",
"\u1F25\u0345"=>"\u1F95",
"\u1F26\u0345"=>"\u1F96",
"\u1F27\u0345"=>"\u1F97",
"\u1F28\u0345"=>"\u1F98",
"\u1F29\u0345"=>"\u1F99",
"\u1F2A\u0345"=>"\u1F9A",
"\u1F2B\u0345"=>"\u1F9B",
"\u1F2C\u0345"=>"\u1F9C",
"\u1F2D\u0345"=>"\u1F9D",
"\u1F2E\u0345"=>"\u1F9E",
"\u1F2F\u0345"=>"\u1F9F",
"\u1F60\u0345"=>"\u1FA0",
"\u1F61\u0345"=>"\u1FA1",
"\u1F62\u0345"=>"\u1FA2",
"\u1F63\u0345"=>"\u1FA3",
"\u1F64\u0345"=>"\u1FA4",
"\u1F65\u0345"=>"\u1FA5",
"\u1F66\u0345"=>"\u1FA6",
"\u1F67\u0345"=>"\u1FA7",
"\u1F68\u0345"=>"\u1FA8",
"\u1F69\u0345"=>"\u1FA9",
"\u1F6A\u0345"=>"\u1FAA",
"\u1F6B\u0345"=>"\u1FAB",
"\u1F6C\u0345"=>"\u1FAC",
"\u1F6D\u0345"=>"\u1FAD",
"\u1F6E\u0345"=>"\u1FAE",
"\u1F6F\u0345"=>"\u1FAF",
"\u03B1\u0306"=>"\u1FB0",
"\u03B1\u0304"=>"\u1FB1",
"\u1F70\u0345"=>"\u1FB2",
"\u03B1\u0345"=>"\u1FB3",
"\u03AC\u0345"=>"\u1FB4",
"\u03B1\u0342"=>"\u1FB6",
"\u1FB6\u0345"=>"\u1FB7",
"\u0391\u0306"=>"\u1FB8",
"\u0391\u0304"=>"\u1FB9",
"\u0391\u0300"=>"\u1FBA",
"\u0391\u0345"=>"\u1FBC",
"\u00A8\u0342"=>"\u1FC1",
"\u1F74\u0345"=>"\u1FC2",
"\u03B7\u0345"=>"\u1FC3",
"\u03AE\u0345"=>"\u1FC4",
"\u03B7\u0342"=>"\u1FC6",
"\u1FC6\u0345"=>"\u1FC7",
"\u0395\u0300"=>"\u1FC8",
"\u0397\u0300"=>"\u1FCA",
"\u0397\u0345"=>"\u1FCC",
"\u1FBF\u0300"=>"\u1FCD",
"\u1FBF\u0301"=>"\u1FCE",
"\u1FBF\u0342"=>"\u1FCF",
"\u03B9\u0306"=>"\u1FD0",
"\u03B9\u0304"=>"\u1FD1",
"\u03CA\u0300"=>"\u1FD2",
"\u03B9\u0342"=>"\u1FD6",
"\u03CA\u0342"=>"\u1FD7",
"\u0399\u0306"=>"\u1FD8",
"\u0399\u0304"=>"\u1FD9",
"\u0399\u0300"=>"\u1FDA",
"\u1FFE\u0300"=>"\u1FDD",
"\u1FFE\u0301"=>"\u1FDE",
"\u1FFE\u0342"=>"\u1FDF",
"\u03C5\u0306"=>"\u1FE0",
"\u03C5\u0304"=>"\u1FE1",
"\u03CB\u0300"=>"\u1FE2",
"\u03C1\u0313"=>"\u1FE4",
"\u03C1\u0314"=>"\u1FE5",
"\u03C5\u0342"=>"\u1FE6",
"\u03CB\u0342"=>"\u1FE7",
"\u03A5\u0306"=>"\u1FE8",
"\u03A5\u0304"=>"\u1FE9",
"\u03A5\u0300"=>"\u1FEA",
"\u03A1\u0314"=>"\u1FEC",
"\u00A8\u0300"=>"\u1FED",
"\u1F7C\u0345"=>"\u1FF2",
"\u03C9\u0345"=>"\u1FF3",
"\u03CE\u0345"=>"\u1FF4",
"\u03C9\u0342"=>"\u1FF6",
"\u1FF6\u0345"=>"\u1FF7",
"\u039F\u0300"=>"\u1FF8",
"\u03A9\u0300"=>"\u1FFA",
"\u03A9\u0345"=>"\u1FFC",
"\u2190\u0338"=>"\u219A",
"\u2192\u0338"=>"\u219B",
"\u2194\u0338"=>"\u21AE",
"\u21D0\u0338"=>"\u21CD",
"\u21D4\u0338"=>"\u21CE",
"\u21D2\u0338"=>"\u21CF",
"\u2203\u0338"=>"\u2204",
"\u2208\u0338"=>"\u2209",
"\u220B\u0338"=>"\u220C",
"\u2223\u0338"=>"\u2224",
"\u2225\u0338"=>"\u2226",
"\u223C\u0338"=>"\u2241",
"\u2243\u0338"=>"\u2244",
"\u2245\u0338"=>"\u2247",
"\u2248\u0338"=>"\u2249",
"=\u0338"=>"\u2260",
"\u2261\u0338"=>"\u2262",
"\u224D\u0338"=>"\u226D",
"<\u0338"=>"\u226E",
">\u0338"=>"\u226F",
"\u2264\u0338"=>"\u2270",
"\u2265\u0338"=>"\u2271",
"\u2272\u0338"=>"\u2274",
"\u2273\u0338"=>"\u2275",
"\u2276\u0338"=>"\u2278",
"\u2277\u0338"=>"\u2279",
"\u227A\u0338"=>"\u2280",
"\u227B\u0338"=>"\u2281",
"\u2282\u0338"=>"\u2284",
"\u2283\u0338"=>"\u2285",
"\u2286\u0338"=>"\u2288",
"\u2287\u0338"=>"\u2289",
"\u22A2\u0338"=>"\u22AC",
"\u22A8\u0338"=>"\u22AD",
"\u22A9\u0338"=>"\u22AE",
"\u22AB\u0338"=>"\u22AF",
"\u227C\u0338"=>"\u22E0",
"\u227D\u0338"=>"\u22E1",
"\u2291\u0338"=>"\u22E2",
"\u2292\u0338"=>"\u22E3",
"\u22B2\u0338"=>"\u22EA",
"\u22B3\u0338"=>"\u22EB",
"\u22B4\u0338"=>"\u22EC",
"\u22B5\u0338"=>"\u22ED",
"\u304B\u3099"=>"\u304C",
"\u304D\u3099"=>"\u304E",
"\u304F\u3099"=>"\u3050",
"\u3051\u3099"=>"\u3052",
"\u3053\u3099"=>"\u3054",
"\u3055\u3099"=>"\u3056",
"\u3057\u3099"=>"\u3058",
"\u3059\u3099"=>"\u305A",
"\u305B\u3099"=>"\u305C",
"\u305D\u3099"=>"\u305E",
"\u305F\u3099"=>"\u3060",
"\u3061\u3099"=>"\u3062",
"\u3064\u3099"=>"\u3065",
"\u3066\u3099"=>"\u3067",
"\u3068\u3099"=>"\u3069",
"\u306F\u3099"=>"\u3070",
"\u306F\u309A"=>"\u3071",
"\u3072\u3099"=>"\u3073",
"\u3072\u309A"=>"\u3074",
"\u3075\u3099"=>"\u3076",
"\u3075\u309A"=>"\u3077",
"\u3078\u3099"=>"\u3079",
"\u3078\u309A"=>"\u307A",
"\u307B\u3099"=>"\u307C",
"\u307B\u309A"=>"\u307D",
"\u3046\u3099"=>"\u3094",
"\u309D\u3099"=>"\u309E",
"\u30AB\u3099"=>"\u30AC",
"\u30AD\u3099"=>"\u30AE",
"\u30AF\u3099"=>"\u30B0",
"\u30B1\u3099"=>"\u30B2",
"\u30B3\u3099"=>"\u30B4",
"\u30B5\u3099"=>"\u30B6",
"\u30B7\u3099"=>"\u30B8",
"\u30B9\u3099"=>"\u30BA",
"\u30BB\u3099"=>"\u30BC",
"\u30BD\u3099"=>"\u30BE",
"\u30BF\u3099"=>"\u30C0",
"\u30C1\u3099"=>"\u30C2",
"\u30C4\u3099"=>"\u30C5",
"\u30C6\u3099"=>"\u30C7",
"\u30C8\u3099"=>"\u30C9",
"\u30CF\u3099"=>"\u30D0",
"\u30CF\u309A"=>"\u30D1",
"\u30D2\u3099"=>"\u30D3",
"\u30D2\u309A"=>"\u30D4",
"\u30D5\u3099"=>"\u30D6",
"\u30D5\u309A"=>"\u30D7",
"\u30D8\u3099"=>"\u30D9",
"\u30D8\u309A"=>"\u30DA",
"\u30DB\u3099"=>"\u30DC",
"\u30DB\u309A"=>"\u30DD",
"\u30A6\u3099"=>"\u30F4",
"\u30EF\u3099"=>"\u30F7",
"\u30F0\u3099"=>"\u30F8",
"\u30F1\u3099"=>"\u30F9",
"\u30F2\u3099"=>"\u30FA",
"\u30FD\u3099"=>"\u30FE",
"\u{11099}\u{110BA}"=>"\u{1109A}",
"\u{1109B}\u{110BA}"=>"\u{1109C}",
"\u{110A5}\u{110BA}"=>"\u{110AB}",
"\u{11131}\u{11127}"=>"\u{1112E}",
"\u{11132}\u{11127}"=>"\u{1112F}",
"\u{11347}\u{1133E}"=>"\u{1134B}",
"\u{11347}\u{11357}"=>"\u{1134C}",
"\u{114B9}\u{114BA}"=>"\u{114BB}",
"\u{114B9}\u{114B0}"=>"\u{114BC}",
"\u{114B9}\u{114BD}"=>"\u{114BE}",
"\u{115B8}\u{115AF}"=>"\u{115BA}",
"\u{115B9}\u{115AF}"=>"\u{115BB}",
"\u{11935}\u{11930}"=>"\u{11938}",
}.freeze
end
share/ruby/monitor.rb 0000644 00000015405 15173517735 0010666 0 ustar 00 # frozen_string_literal: false
# = monitor.rb
#
# Copyright (C) 2001 Shugo Maeda <shugo@ruby-lang.org>
#
# This library is distributed under the terms of the Ruby license.
# You can freely distribute/modify this library.
#
require 'monitor.so'
#
# In concurrent programming, a monitor is an object or module intended to be
# used safely by more than one thread. The defining characteristic of a
# monitor is that its methods are executed with mutual exclusion. That is, at
# each point in time, at most one thread may be executing any of its methods.
# This mutual exclusion greatly simplifies reasoning about the implementation
# of monitors compared to reasoning about parallel code that updates a data
# structure.
#
# You can read more about the general principles on the Wikipedia page for
# Monitors[https://en.wikipedia.org/wiki/Monitor_%28synchronization%29].
#
# == Examples
#
# === Simple object.extend
#
# require 'monitor.rb'
#
# buf = []
# buf.extend(MonitorMixin)
# empty_cond = buf.new_cond
#
# # consumer
# Thread.start do
# loop do
# buf.synchronize do
# empty_cond.wait_while { buf.empty? }
# print buf.shift
# end
# end
# end
#
# # producer
# while line = ARGF.gets
# buf.synchronize do
# buf.push(line)
# empty_cond.signal
# end
# end
#
# The consumer thread waits for the producer thread to push a line to buf
# while <tt>buf.empty?</tt>. The producer thread (main thread) reads a
# line from ARGF and pushes it into buf then calls <tt>empty_cond.signal</tt>
# to notify the consumer thread of new data.
#
# === Simple Class include
#
# require 'monitor'
#
# class SynchronizedArray < Array
#
# include MonitorMixin
#
# def initialize(*args)
# super(*args)
# end
#
# alias :old_shift :shift
# alias :old_unshift :unshift
#
# def shift(n=1)
# self.synchronize do
# self.old_shift(n)
# end
# end
#
# def unshift(item)
# self.synchronize do
# self.old_unshift(item)
# end
# end
#
# # other methods ...
# end
#
# +SynchronizedArray+ implements an Array with synchronized access to items.
# This Class is implemented as subclass of Array which includes the
# MonitorMixin module.
#
module MonitorMixin
#
# FIXME: This isn't documented in Nutshell.
#
# Since MonitorMixin.new_cond returns a ConditionVariable, and the example
# above calls while_wait and signal, this class should be documented.
#
class ConditionVariable
#
# Releases the lock held in the associated monitor and waits; reacquires the lock on wakeup.
#
# If +timeout+ is given, this method returns after +timeout+ seconds passed,
# even if no other thread doesn't signal.
#
def wait(timeout = nil)
@monitor.mon_check_owner
@monitor.wait_for_cond(@cond, timeout)
end
#
# Calls wait repeatedly while the given block yields a truthy value.
#
def wait_while
while yield
wait
end
end
#
# Calls wait repeatedly until the given block yields a truthy value.
#
def wait_until
until yield
wait
end
end
#
# Wakes up the first thread in line waiting for this lock.
#
def signal
@monitor.mon_check_owner
@cond.signal
end
#
# Wakes up all threads waiting for this lock.
#
def broadcast
@monitor.mon_check_owner
@cond.broadcast
end
private
def initialize(monitor)
@monitor = monitor
@cond = Thread::ConditionVariable.new
end
end
def self.extend_object(obj)
super(obj)
obj.__send__(:mon_initialize)
end
#
# Attempts to enter exclusive section. Returns +false+ if lock fails.
#
def mon_try_enter
@mon_data.try_enter
end
# For backward compatibility
alias try_mon_enter mon_try_enter
#
# Enters exclusive section.
#
def mon_enter
@mon_data.enter
end
#
# Leaves exclusive section.
#
def mon_exit
mon_check_owner
@mon_data.exit
end
#
# Returns true if this monitor is locked by any thread
#
def mon_locked?
@mon_data.mon_locked?
end
#
# Returns true if this monitor is locked by current thread.
#
def mon_owned?
@mon_data.mon_owned?
end
#
# Enters exclusive section and executes the block. Leaves the exclusive
# section automatically when the block exits. See example under
# +MonitorMixin+.
#
def mon_synchronize(&b)
@mon_data.synchronize(&b)
end
alias synchronize mon_synchronize
#
# Creates a new MonitorMixin::ConditionVariable associated with the
# Monitor object.
#
def new_cond
unless defined?(@mon_data)
mon_initialize
@mon_initialized_by_new_cond = true
end
return ConditionVariable.new(@mon_data)
end
private
# Use <tt>extend MonitorMixin</tt> or <tt>include MonitorMixin</tt> instead
# of this constructor. Have look at the examples above to understand how to
# use this module.
def initialize(...)
super
mon_initialize
end
# Initializes the MonitorMixin after being included in a class or when an
# object has been extended with the MonitorMixin
def mon_initialize
if defined?(@mon_data)
if defined?(@mon_initialized_by_new_cond)
return # already initialized.
elsif @mon_data_owner_object_id == self.object_id
raise ThreadError, "already initialized"
end
end
@mon_data = ::Monitor.new
@mon_data_owner_object_id = self.object_id
end
def mon_check_owner
@mon_data.mon_check_owner
end
end
# Use the Monitor class when you want to have a lock object for blocks with
# mutual exclusion.
#
# require 'monitor'
#
# lock = Monitor.new
# lock.synchronize do
# # exclusive access
# end
#
class Monitor
def new_cond
::MonitorMixin::ConditionVariable.new(self)
end
# for compatibility
alias try_mon_enter try_enter
alias mon_try_enter try_enter
alias mon_enter enter
alias mon_exit exit
alias mon_synchronize synchronize
end
# Documentation comments:
# - All documentation comes from Nutshell.
# - MonitorMixin.new_cond appears in the example, but is not documented in
# Nutshell.
# - All the internals (internal modules Accessible and Initializable, class
# ConditionVariable) appear in RDoc. It might be good to hide them, by
# making them private, or marking them :nodoc:, etc.
# - RDoc doesn't recognise aliases, so we have mon_synchronize documented, but
# not synchronize.
# - mon_owner is in Nutshell, but appears as an accessor in a separate module
# here, so is hard/impossible to RDoc. Some other useful accessors
# (mon_count and some queue stuff) are also in this module, and don't appear
# directly in the RDoc output.
# - in short, it may be worth changing the code layout in this file to make the
# documentation easier
share/ruby/find.rb 0000644 00000005021 15173517735 0010110 0 ustar 00 # frozen_string_literal: true
#
# find.rb: the Find module for processing all files under a given directory.
#
#
# 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
VERSION = "0.2.0"
#
# 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 find(*paths, ignore_error: true) # :yield: path
block_given? or return enum_for(__method__, *paths, ignore_error: ignore_error)
fs_encoding = Encoding.find("filesystem")
paths.collect!{|d| raise Errno::ENOENT, d unless File.exist?(d); d.dup}.each do |path|
path = path.to_path if path.respond_to? :to_path
enc = path.encoding == Encoding::US_ASCII ? fs_encoding : path.encoding
ps = [path]
while file = ps.shift
catch(:prune) do
yield file.dup
begin
s = File.lstat(file)
rescue Errno::ENOENT, Errno::EACCES, Errno::ENOTDIR, Errno::ELOOP, Errno::ENAMETOOLONG, Errno::EINVAL
raise unless ignore_error
next
end
if s.directory? then
begin
fs = Dir.children(file, encoding: enc)
rescue Errno::ENOENT, Errno::EACCES, Errno::ENOTDIR, Errno::ELOOP, Errno::ENAMETOOLONG, Errno::EINVAL
raise unless ignore_error
next
end
fs.sort!
fs.reverse_each {|f|
f = File.join(file, f)
ps.unshift f
}
end
end
end
end
nil
end
#
# 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 prune
throw :prune
end
module_function :find, :prune
end
share/ruby/set.rb 0000644 00000061677 15173517735 0010006 0 ustar 00 # frozen_string_literal: true
# :markup: markdown
#
# set.rb - defines the Set class
#
# Copyright (c) 2002-2023 Akinori MUSHA <knu@iDaemons.org>
#
# Documentation by Akinori MUSHA and Gavin Sinclair.
#
# All rights reserved. You can redistribute and/or modify it under the same
# terms as Ruby.
##
# This library provides the Set class, which implements a collection
# of unordered values with no duplicates. It is a hybrid of Array's
# intuitive inter-operation facilities and Hash's fast lookup.
#
# The method `to_set` is added to Enumerable for convenience.
#
# Set is easy to use with Enumerable objects (implementing `each`).
# Most of the initializer methods and binary operators accept generic
# Enumerable objects besides sets and arrays. An Enumerable object
# can be converted to Set using the `to_set` method.
#
# Set uses Hash as storage, so you must note the following points:
#
# * Equality of elements is determined according to Object#eql? and
# Object#hash. Use Set#compare_by_identity to make a set compare
# its elements by their identity.
# * Set assumes that the identity of each element does not change
# while it is stored. Modifying an element of a set will render the
# set to an unreliable state.
# * When a string is to be stored, a frozen copy of the string is
# stored instead unless the original string is already frozen.
#
# ## Comparison
#
# The comparison operators `<`, `>`, `<=`, and `>=` are implemented as
# shorthand for the {proper_,}{subset?,superset?} methods. The `<=>`
# operator reflects this order, or return `nil` for sets that both
# have distinct elements (`{x, y}` vs. `{x, z}` for example).
#
# ## Example
#
# ```ruby
# require 'set'
# s1 = Set[1, 2] #=> #<Set: {1, 2}>
# s2 = [1, 2].to_set #=> #<Set: {1, 2}>
# s1 == s2 #=> true
# s1.add("foo") #=> #<Set: {1, 2, "foo"}>
# s1.merge([2, 6]) #=> #<Set: {1, 2, "foo", 6}>
# s1.subset?(s2) #=> false
# s2.subset?(s1) #=> true
# ```
#
# ## Contact
#
# - Akinori MUSHA <<knu@iDaemons.org>> (current maintainer)
#
# ## What's Here
#
# First, what's elsewhere. \Class \Set:
#
# - Inherits from {class Object}[rdoc-ref:Object@What-27s+Here].
# - Includes {module Enumerable}[rdoc-ref:Enumerable@What-27s+Here],
# which provides dozens of additional methods.
#
# In particular, class \Set does not have many methods of its own
# for fetching or for iterating.
# Instead, it relies on those in \Enumerable.
#
# Here, class \Set provides methods that are useful for:
#
# - [Creating a Set](#class-Set-label-Methods+for+Creating+a+Set)
# - [Set Operations](#class-Set-label-Methods+for+Set+Operations)
# - [Comparing](#class-Set-label-Methods+for+Comparing)
# - [Querying](#class-Set-label-Methods+for+Querying)
# - [Assigning](#class-Set-label-Methods+for+Assigning)
# - [Deleting](#class-Set-label-Methods+for+Deleting)
# - [Converting](#class-Set-label-Methods+for+Converting)
# - [Iterating](#class-Set-label-Methods+for+Iterating)
# - [And more....](#class-Set-label-Other+Methods)
#
# ### Methods for Creating a \Set
#
# - ::[]:
# Returns a new set containing the given objects.
# - ::new:
# Returns a new set containing either the given objects
# (if no block given) or the return values from the called block
# (if a block given).
#
# ### Methods for \Set Operations
#
# - [|](#method-i-7C) (aliased as #union and #+):
# Returns a new set containing all elements from +self+
# and all elements from a given enumerable (no duplicates).
# - [&](#method-i-26) (aliased as #intersection):
# Returns a new set containing all elements common to +self+
# and a given enumerable.
# - [-](#method-i-2D) (aliased as #difference):
# Returns a copy of +self+ with all elements
# in a given enumerable removed.
# - [\^](#method-i-5E):
# Returns a new set containing all elements from +self+
# and a given enumerable except those common to both.
#
# ### Methods for Comparing
#
# - [<=>](#method-i-3C-3D-3E):
# Returns -1, 0, or 1 as +self+ is less than, equal to,
# or greater than a given object.
# - [==](#method-i-3D-3D):
# Returns whether +self+ and a given enumerable are equal,
# as determined by Object#eql?.
# - \#compare_by_identity?:
# Returns whether the set considers only identity
# when comparing elements.
#
# ### Methods for Querying
#
# - \#length (aliased as #size):
# Returns the count of elements.
# - \#empty?:
# Returns whether the set has no elements.
# - \#include? (aliased as #member? and #===):
# Returns whether a given object is an element in the set.
# - \#subset? (aliased as [<=](#method-i-3C-3D)):
# Returns whether a given object is a subset of the set.
# - \#proper_subset? (aliased as [<](#method-i-3C)):
# Returns whether a given enumerable is a proper subset of the set.
# - \#superset? (aliased as [>=](#method-i-3E-3D])):
# Returns whether a given enumerable is a superset of the set.
# - \#proper_superset? (aliased as [>](#method-i-3E)):
# Returns whether a given enumerable is a proper superset of the set.
# - \#disjoint?:
# Returns +true+ if the set and a given enumerable
# have no common elements, +false+ otherwise.
# - \#intersect?:
# Returns +true+ if the set and a given enumerable:
# have any common elements, +false+ otherwise.
# - \#compare_by_identity?:
# Returns whether the set considers only identity
# when comparing elements.
#
# ### Methods for Assigning
#
# - \#add (aliased as #<<):
# Adds a given object to the set; returns +self+.
# - \#add?:
# If the given object is not an element in the set,
# adds it and returns +self+; otherwise, returns +nil+.
# - \#merge:
# Merges the elements of each given enumerable object to the set; returns +self+.
# - \#replace:
# Replaces the contents of the set with the contents
# of a given enumerable.
#
# ### Methods for Deleting
#
# - \#clear:
# Removes all elements in the set; returns +self+.
# - \#delete:
# Removes a given object from the set; returns +self+.
# - \#delete?:
# If the given object is an element in the set,
# removes it and returns +self+; otherwise, returns +nil+.
# - \#subtract:
# Removes each given object from the set; returns +self+.
# - \#delete_if - Removes elements specified by a given block.
# - \#select! (aliased as #filter!):
# Removes elements not specified by a given block.
# - \#keep_if:
# Removes elements not specified by a given block.
# - \#reject!
# Removes elements specified by a given block.
#
# ### Methods for Converting
#
# - \#classify:
# Returns a hash that classifies the elements,
# as determined by the given block.
# - \#collect! (aliased as #map!):
# Replaces each element with a block return-value.
# - \#divide:
# Returns a hash that classifies the elements,
# as determined by the given block;
# differs from #classify in that the block may accept
# either one or two arguments.
# - \#flatten:
# Returns a new set that is a recursive flattening of +self+.
# \#flatten!:
# Replaces each nested set in +self+ with the elements from that set.
# - \#inspect (aliased as #to_s):
# Returns a string displaying the elements.
# - \#join:
# Returns a string containing all elements, converted to strings
# as needed, and joined by the given record separator.
# - \#to_a:
# Returns an array containing all set elements.
# - \#to_set:
# Returns +self+ if given no arguments and no block;
# with a block given, returns a new set consisting of block
# return values.
#
# ### Methods for Iterating
#
# - \#each:
# Calls the block with each successive element; returns +self+.
#
# ### Other Methods
#
# - \#reset:
# Resets the internal state; useful if an object
# has been modified while an element in the set.
#
class Set
VERSION = "1.1.0"
include Enumerable
# Creates a new set containing the given objects.
#
# Set[1, 2] # => #<Set: {1, 2}>
# Set[1, 2, 1] # => #<Set: {1, 2}>
# Set[1, 'c', :s] # => #<Set: {1, "c", :s}>
def self.[](*ary)
new(ary)
end
# Creates a new set containing the elements of the given enumerable
# object.
#
# If a block is given, the elements of enum are preprocessed by the
# given block.
#
# Set.new([1, 2]) #=> #<Set: {1, 2}>
# Set.new([1, 2, 1]) #=> #<Set: {1, 2}>
# Set.new([1, 'c', :s]) #=> #<Set: {1, "c", :s}>
# Set.new(1..5) #=> #<Set: {1, 2, 3, 4, 5}>
# Set.new([1, 2, 3]) { |x| x * x } #=> #<Set: {1, 4, 9}>
def initialize(enum = nil, &block) # :yields: o
@hash ||= Hash.new(false)
enum.nil? and return
if block
do_with_enum(enum) { |o| add(block[o]) }
else
merge(enum)
end
end
# Makes the set compare its elements by their identity and returns
# self. This method may not be supported by all subclasses of Set.
def compare_by_identity
if @hash.respond_to?(:compare_by_identity)
@hash.compare_by_identity
self
else
raise NotImplementedError, "#{self.class.name}\##{__method__} is not implemented"
end
end
# Returns true if the set will compare its elements by their
# identity. Also see Set#compare_by_identity.
def compare_by_identity?
@hash.respond_to?(:compare_by_identity?) && @hash.compare_by_identity?
end
def do_with_enum(enum, &block) # :nodoc:
if enum.respond_to?(:each_entry)
enum.each_entry(&block) if block
elsif enum.respond_to?(:each)
enum.each(&block) if block
else
raise ArgumentError, "value must be enumerable"
end
end
private :do_with_enum
# Dup internal hash.
def initialize_dup(orig)
super
@hash = orig.instance_variable_get(:@hash).dup
end
# Clone internal hash.
def initialize_clone(orig, **options)
super
@hash = orig.instance_variable_get(:@hash).clone(**options)
end
def freeze # :nodoc:
@hash.freeze
super
end
# Returns the number of elements.
def size
@hash.size
end
alias length size
# Returns true if the set contains no elements.
def empty?
@hash.empty?
end
# Removes all elements and returns self.
#
# set = Set[1, 'c', :s] #=> #<Set: {1, "c", :s}>
# set.clear #=> #<Set: {}>
# set #=> #<Set: {}>
def clear
@hash.clear
self
end
# Replaces the contents of the set with the contents of the given
# enumerable object and returns self.
#
# set = Set[1, 'c', :s] #=> #<Set: {1, "c", :s}>
# set.replace([1, 2]) #=> #<Set: {1, 2}>
# set #=> #<Set: {1, 2}>
def replace(enum)
if enum.instance_of?(self.class)
@hash.replace(enum.instance_variable_get(:@hash))
self
else
do_with_enum(enum) # make sure enum is enumerable before calling clear
clear
merge(enum)
end
end
# Converts the set to an array. The order of elements is uncertain.
#
# Set[1, 2].to_a #=> [1, 2]
# Set[1, 'c', :s].to_a #=> [1, "c", :s]
def to_a
@hash.keys
end
# Returns self if no arguments are given. Otherwise, converts the
# set to another with `klass.new(self, *args, &block)`.
#
# In subclasses, returns `klass.new(self, *args, &block)` unless
# overridden.
def to_set(klass = Set, *args, &block)
return self if instance_of?(Set) && klass == Set && block.nil? && args.empty?
klass.new(self, *args, &block)
end
def flatten_merge(set, seen = Set.new) # :nodoc:
set.each { |e|
if e.is_a?(Set)
if seen.include?(e_id = e.object_id)
raise ArgumentError, "tried to flatten recursive Set"
end
seen.add(e_id)
flatten_merge(e, seen)
seen.delete(e_id)
else
add(e)
end
}
self
end
protected :flatten_merge
# Returns a new set that is a copy of the set, flattening each
# containing set recursively.
def flatten
self.class.new.flatten_merge(self)
end
# Equivalent to Set#flatten, but replaces the receiver with the
# result in place. Returns nil if no modifications were made.
def flatten!
replace(flatten()) if any?(Set)
end
# Returns true if the set contains the given object.
#
# Note that <code>include?</code> and <code>member?</code> do not test member
# equality using <code>==</code> as do other Enumerables.
#
# See also Enumerable#include?
def include?(o)
@hash[o]
end
alias member? include?
# Returns true if the set is a superset of the given set.
def superset?(set)
case
when set.instance_of?(self.class) && @hash.respond_to?(:>=)
@hash >= set.instance_variable_get(:@hash)
when set.is_a?(Set)
size >= set.size && set.all?(self)
else
raise ArgumentError, "value must be a set"
end
end
alias >= superset?
# Returns true if the set is a proper superset of the given set.
def proper_superset?(set)
case
when set.instance_of?(self.class) && @hash.respond_to?(:>)
@hash > set.instance_variable_get(:@hash)
when set.is_a?(Set)
size > set.size && set.all?(self)
else
raise ArgumentError, "value must be a set"
end
end
alias > proper_superset?
# Returns true if the set is a subset of the given set.
def subset?(set)
case
when set.instance_of?(self.class) && @hash.respond_to?(:<=)
@hash <= set.instance_variable_get(:@hash)
when set.is_a?(Set)
size <= set.size && all?(set)
else
raise ArgumentError, "value must be a set"
end
end
alias <= subset?
# Returns true if the set is a proper subset of the given set.
def proper_subset?(set)
case
when set.instance_of?(self.class) && @hash.respond_to?(:<)
@hash < set.instance_variable_get(:@hash)
when set.is_a?(Set)
size < set.size && all?(set)
else
raise ArgumentError, "value must be a set"
end
end
alias < proper_subset?
# Returns 0 if the set are equal,
# -1 / +1 if the set is a proper subset / superset of the given set,
# or nil if they both have unique elements.
def <=>(set)
return unless set.is_a?(Set)
case size <=> set.size
when -1 then -1 if proper_subset?(set)
when +1 then +1 if proper_superset?(set)
else 0 if self.==(set)
end
end
# Returns true if the set and the given enumerable have at least one
# element in common.
#
# Set[1, 2, 3].intersect? Set[4, 5] #=> false
# Set[1, 2, 3].intersect? Set[3, 4] #=> true
# Set[1, 2, 3].intersect? 4..5 #=> false
# Set[1, 2, 3].intersect? [3, 4] #=> true
def intersect?(set)
case set
when Set
if size < set.size
any?(set)
else
set.any?(self)
end
when Enumerable
set.any?(self)
else
raise ArgumentError, "value must be enumerable"
end
end
# Returns true if the set and the given enumerable have
# no element in common. This method is the opposite of `intersect?`.
#
# Set[1, 2, 3].disjoint? Set[3, 4] #=> false
# Set[1, 2, 3].disjoint? Set[4, 5] #=> true
# Set[1, 2, 3].disjoint? [3, 4] #=> false
# Set[1, 2, 3].disjoint? 4..5 #=> true
def disjoint?(set)
!intersect?(set)
end
# Calls the given block once for each element in the set, passing
# the element as parameter. Returns an enumerator if no block is
# given.
def each(&block)
block_given? or return enum_for(__method__) { size }
@hash.each_key(&block)
self
end
# Adds the given object to the set and returns self. Use `merge` to
# add many elements at once.
#
# Set[1, 2].add(3) #=> #<Set: {1, 2, 3}>
# Set[1, 2].add([3, 4]) #=> #<Set: {1, 2, [3, 4]}>
# Set[1, 2].add(2) #=> #<Set: {1, 2}>
def add(o)
@hash[o] = true
self
end
alias << add
# Adds the given object to the set and returns self. If the
# object is already in the set, returns nil.
#
# Set[1, 2].add?(3) #=> #<Set: {1, 2, 3}>
# Set[1, 2].add?([3, 4]) #=> #<Set: {1, 2, [3, 4]}>
# Set[1, 2].add?(2) #=> nil
def add?(o)
add(o) unless include?(o)
end
# Deletes the given object from the set and returns self. Use
# `subtract` to delete many items at once.
def delete(o)
@hash.delete(o)
self
end
# Deletes the given object from the set and returns self. If the
# object is not in the set, returns nil.
def delete?(o)
delete(o) if include?(o)
end
# Deletes every element of the set for which block evaluates to
# true, and returns self. Returns an enumerator if no block is
# given.
def delete_if
block_given? or return enum_for(__method__) { size }
# @hash.delete_if should be faster, but using it breaks the order
# of enumeration in subclasses.
select { |o| yield o }.each { |o| @hash.delete(o) }
self
end
# Deletes every element of the set for which block evaluates to
# false, and returns self. Returns an enumerator if no block is
# given.
def keep_if
block_given? or return enum_for(__method__) { size }
# @hash.keep_if should be faster, but using it breaks the order of
# enumeration in subclasses.
reject { |o| yield o }.each { |o| @hash.delete(o) }
self
end
# Replaces the elements with ones returned by `collect()`.
# Returns an enumerator if no block is given.
def collect!
block_given? or return enum_for(__method__) { size }
set = self.class.new
each { |o| set << yield(o) }
replace(set)
end
alias map! collect!
# Equivalent to Set#delete_if, but returns nil if no changes were
# made. Returns an enumerator if no block is given.
def reject!(&block)
block_given? or return enum_for(__method__) { size }
n = size
delete_if(&block)
self if size != n
end
# Equivalent to Set#keep_if, but returns nil if no changes were
# made. Returns an enumerator if no block is given.
def select!(&block)
block_given? or return enum_for(__method__) { size }
n = size
keep_if(&block)
self if size != n
end
# Equivalent to Set#select!
alias filter! select!
# Merges the elements of the given enumerable objects to the set and
# returns self.
def merge(*enums, **nil)
enums.each do |enum|
if enum.instance_of?(self.class)
@hash.update(enum.instance_variable_get(:@hash))
else
do_with_enum(enum) { |o| add(o) }
end
end
self
end
# Deletes every element that appears in the given enumerable object
# and returns self.
def subtract(enum)
do_with_enum(enum) { |o| delete(o) }
self
end
# Returns a new set built by merging the set and the elements of the
# given enumerable object.
#
# Set[1, 2, 3] | Set[2, 4, 5] #=> #<Set: {1, 2, 3, 4, 5}>
# Set[1, 5, 'z'] | (1..6) #=> #<Set: {1, 5, "z", 2, 3, 4, 6}>
def |(enum)
dup.merge(enum)
end
alias + |
alias union |
# Returns a new set built by duplicating the set, removing every
# element that appears in the given enumerable object.
#
# Set[1, 3, 5] - Set[1, 5] #=> #<Set: {3}>
# Set['a', 'b', 'z'] - ['a', 'c'] #=> #<Set: {"b", "z"}>
def -(enum)
dup.subtract(enum)
end
alias difference -
# Returns a new set containing elements common to the set and the
# given enumerable object.
#
# Set[1, 3, 5] & Set[3, 2, 1] #=> #<Set: {3, 1}>
# Set['a', 'b', 'z'] & ['a', 'b', 'c'] #=> #<Set: {"a", "b"}>
def &(enum)
n = self.class.new
if enum.is_a?(Set)
if enum.size > size
each { |o| n.add(o) if enum.include?(o) }
else
enum.each { |o| n.add(o) if include?(o) }
end
else
do_with_enum(enum) { |o| n.add(o) if include?(o) }
end
n
end
alias intersection &
# Returns a new set containing elements exclusive between the set
# and the given enumerable object. `(set ^ enum)` is equivalent to
# `((set | enum) - (set & enum))`.
#
# Set[1, 2] ^ Set[2, 3] #=> #<Set: {3, 1}>
# Set[1, 'b', 'c'] ^ ['b', 'd'] #=> #<Set: {"d", 1, "c"}>
def ^(enum)
n = Set.new(enum)
each { |o| n.add(o) unless n.delete?(o) }
n
end
# Returns true if two sets are equal. The equality of each couple
# of elements is defined according to Object#eql?.
#
# Set[1, 2] == Set[2, 1] #=> true
# Set[1, 3, 5] == Set[1, 5] #=> false
# Set['a', 'b', 'c'] == Set['a', 'c', 'b'] #=> true
# Set['a', 'b', 'c'] == ['a', 'c', 'b'] #=> false
def ==(other)
if self.equal?(other)
true
elsif other.instance_of?(self.class)
@hash == other.instance_variable_get(:@hash)
elsif other.is_a?(Set) && self.size == other.size
other.all? { |o| @hash.include?(o) }
else
false
end
end
def hash # :nodoc:
@hash.hash
end
def eql?(o) # :nodoc:
return false unless o.is_a?(Set)
@hash.eql?(o.instance_variable_get(:@hash))
end
# Resets the internal state after modification to existing elements
# and returns self.
#
# Elements will be reindexed and deduplicated.
def reset
if @hash.respond_to?(:rehash)
@hash.rehash # This should perform frozenness check.
else
raise FrozenError, "can't modify frozen #{self.class.name}" if frozen?
end
self
end
# Returns true if the given object is a member of the set,
# and false otherwise.
#
# Used in case statements:
#
# require 'set'
#
# case :apple
# when Set[:potato, :carrot]
# "vegetable"
# when Set[:apple, :banana]
# "fruit"
# end
# # => "fruit"
#
# Or by itself:
#
# Set[1, 2, 3] === 2 #=> true
# Set[1, 2, 3] === 4 #=> false
#
alias === include?
# Classifies the set by the return value of the given block and
# returns a hash of {value => set of elements} pairs. The block is
# called once for each element of the set, passing the element as
# parameter.
#
# require 'set'
# files = Set.new(Dir.glob("*.rb"))
# hash = files.classify { |f| File.mtime(f).year }
# hash #=> {2000=>#<Set: {"a.rb", "b.rb"}>,
# # 2001=>#<Set: {"c.rb", "d.rb", "e.rb"}>,
# # 2002=>#<Set: {"f.rb"}>}
#
# Returns an enumerator if no block is given.
def classify # :yields: o
block_given? or return enum_for(__method__) { size }
h = {}
each { |i|
(h[yield(i)] ||= self.class.new).add(i)
}
h
end
# Divides the set into a set of subsets according to the commonality
# defined by the given block.
#
# If the arity of the block is 2, elements o1 and o2 are in common
# if block.call(o1, o2) is true. Otherwise, elements o1 and o2 are
# in common if block.call(o1) == block.call(o2).
#
# require 'set'
# numbers = Set[1, 3, 4, 6, 9, 10, 11]
# set = numbers.divide { |i,j| (i - j).abs == 1 }
# set #=> #<Set: {#<Set: {1}>,
# # #<Set: {11, 9, 10}>,
# # #<Set: {3, 4}>,
# # #<Set: {6}>}>
#
# Returns an enumerator if no block is given.
def divide(&func)
func or return enum_for(__method__) { size }
if func.arity == 2
require 'tsort'
class << dig = {} # :nodoc:
include TSort
alias tsort_each_node each_key
def tsort_each_child(node, &block)
fetch(node).each(&block)
end
end
each { |u|
dig[u] = a = []
each{ |v| func.call(u, v) and a << v }
}
set = Set.new()
dig.each_strongly_connected_component { |css|
set.add(self.class.new(css))
}
set
else
Set.new(classify(&func).values)
end
end
# Returns a string created by converting each element of the set to a string
# See also: Array#join
def join(separator=nil)
to_a.join(separator)
end
InspectKey = :__inspect_key__ # :nodoc:
# Returns a string containing a human-readable representation of the
# set ("#<Set: {element1, element2, ...}>").
def inspect
ids = (Thread.current[InspectKey] ||= [])
if ids.include?(object_id)
return sprintf('#<%s: {...}>', self.class.name)
end
ids << object_id
begin
return sprintf('#<%s: {%s}>', self.class, to_a.inspect[1..-2])
ensure
ids.pop
end
end
alias to_s inspect
def pretty_print(pp) # :nodoc:
pp.group(1, sprintf('#<%s:', self.class.name), '>') {
pp.breakable
pp.group(1, '{', '}') {
pp.seplist(self) { |o|
pp.pp o
}
}
}
end
def pretty_print_cycle(pp) # :nodoc:
pp.text sprintf('#<%s: {%s}>', self.class.name, empty? ? '' : '...')
end
end
module Enumerable
# Makes a set from the enumerable object with given arguments.
# Needs to `require "set"` to use this method.
def to_set(klass = Set, *args, &block)
klass.new(self, *args, &block)
end unless method_defined?(:to_set)
end
autoload :SortedSet, "#{__dir__}/set/sorted_set"
share/ruby/ipaddr.rb 0000644 00000051667 15173517735 0010454 0 ustar 00 # frozen_string_literal: true
#
# ipaddr.rb - A class to manipulate an IP address
#
# Copyright (c) 2002 Hajimu UMEMOTO <ume@mahoroba.org>.
# Copyright (c) 2007, 2009, 2012 Akinori MUSHA <knu@iDaemons.org>.
# All rights reserved.
#
# You can redistribute and/or modify it under the same terms as Ruby.
#
# $Id$
#
# Contact:
# - Akinori MUSHA <knu@iDaemons.org> (current maintainer)
#
# TODO:
# - scope_id support
#
require 'socket'
# 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
VERSION = "1.2.6"
# 32 bit mask for IPv4
IN4MASK = 0xffffffff
# 128 bit mask for IPv6
IN6MASK = 0xffffffffffffffffffffffffffffffff
# Format string for IPv6
IN6FORMAT = (["%.4x"] * 8).join(':').freeze
# Regexp _internally_ used for parsing IPv4 address.
RE_IPV4ADDRLIKE = %r{
\A
(\d+) \. (\d+) \. (\d+) \. (\d+)
\z
}x
# Regexp _internally_ used for parsing IPv6 address.
RE_IPV6ADDRLIKE_FULL = %r{
\A
(?:
(?: [\da-f]{1,4} : ){7} [\da-f]{1,4}
|
( (?: [\da-f]{1,4} : ){6} )
(\d+) \. (\d+) \. (\d+) \. (\d+)
)
\z
}xi
# Regexp _internally_ used for parsing IPv6 address.
RE_IPV6ADDRLIKE_COMPRESSED = %r{
\A
( (?: (?: [\da-f]{1,4} : )* [\da-f]{1,4} )? )
::
( (?:
( (?: [\da-f]{1,4} : )* )
(?:
[\da-f]{1,4}
|
(\d+) \. (\d+) \. (\d+) \. (\d+)
)
)? )
\z
}xi
# Generic IPAddr related error. Exceptions raised in this class should
# inherit from Error.
class Error < ArgumentError; end
# Raised when the provided IP address is an invalid address.
class InvalidAddressError < 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 AddressFamilyError < Error; end
# Raised when the address is an invalid length.
class InvalidPrefixError < InvalidAddressError; end
# Returns the address family of this IP address.
attr_reader :family
# Creates a new ipaddr containing the given network byte ordered
# string form of an IP address.
def self.new_ntoh(addr)
return new(ntop(addr))
end
# Convert a network byte ordered string form of an IP address into
# human readable form.
def self.ntop(addr)
case addr.size
when 4
addr.unpack('C4').join('.')
when 16
IN6FORMAT % addr.unpack('n8')
else
raise AddressFamilyError, "unsupported address family"
end
end
# Returns a new ipaddr built by bitwise AND.
def &(other)
return self.clone.set(@addr & coerce_other(other).to_i)
end
# Returns a new ipaddr built by bitwise OR.
def |(other)
return self.clone.set(@addr | coerce_other(other).to_i)
end
# Returns a new ipaddr built by bitwise right-shift.
def >>(num)
return self.clone.set(@addr >> num)
end
# Returns a new ipaddr built by bitwise left shift.
def <<(num)
return self.clone.set(addr_mask(@addr << num))
end
# Returns a new ipaddr built by bitwise negation.
def ~
return self.clone.set(addr_mask(~@addr))
end
# Returns true if two ipaddrs are equal.
def ==(other)
other = coerce_other(other)
rescue
false
else
@family == other.family && @addr == other.to_i
end
# 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(prefixlen)
return self.clone.mask!(prefixlen)
end
# 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")
# net4 = IPAddr.new("192.168.2.0/16")
# p net1.include?(net2) #=> true
# p net1.include?(net3) #=> false
# p net1.include?(net4) #=> false
# p net4.include?(net1) #=> true
def include?(other)
other = coerce_other(other)
return false unless other.family == family
begin_addr <= other.begin_addr && end_addr >= other.end_addr
end
alias === include?
# Returns the integer representation of the ipaddr.
def to_i
return @addr
end
# Returns a string containing the IP address representation.
def to_s
str = to_string
return str if ipv4?
str.gsub!(/\b0{1,3}([\da-f]+)\b/i, '\1')
loop do
break if str.sub!(/\A0:0:0:0:0:0:0:0\z/, '::')
break if str.sub!(/\b0:0:0:0:0:0:0\b/, ':')
break if str.sub!(/\b0:0:0:0:0:0\b/, ':')
break if str.sub!(/\b0:0:0:0:0\b/, ':')
break if str.sub!(/\b0:0:0:0\b/, ':')
break if str.sub!(/\b0:0:0\b/, ':')
break if str.sub!(/\b0:0\b/, ':')
break
end
str.sub!(/:{3,}/, '::')
if /\A::(ffff:)?([\da-f]{1,4}):([\da-f]{1,4})\z/i =~ str
str = sprintf('::%s%d.%d.%d.%d', $1, $2.hex / 256, $2.hex % 256, $3.hex / 256, $3.hex % 256)
end
str
end
# Returns a string containing the IP address representation in
# canonical form.
def to_string
str = _to_string(@addr)
if @family == Socket::AF_INET6
str << zone_id.to_s
end
return str
end
# Returns a network byte ordered string form of the IP address.
def hton
case @family
when Socket::AF_INET
return [@addr].pack('N')
when Socket::AF_INET6
return (0..7).map { |i|
(@addr >> (112 - 16 * i)) & 0xffff
}.pack('n8')
else
raise AddressFamilyError, "unsupported address family"
end
end
# Returns true if the ipaddr is an IPv4 address.
def ipv4?
return @family == Socket::AF_INET
end
# Returns true if the ipaddr is an IPv6 address.
def ipv6?
return @family == Socket::AF_INET6
end
# Returns true if the ipaddr is a loopback address.
def loopback?
case @family
when Socket::AF_INET
@addr & 0xff000000 == 0x7f000000
when Socket::AF_INET6
@addr == 1
else
raise AddressFamilyError, "unsupported address family"
end
end
# 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. Private IPv4 addresses in the
# IPv4-mapped IPv6 address range are also considered private.
def private?
case @family
when Socket::AF_INET
@addr & 0xff000000 == 0x0a000000 || # 10.0.0.0/8
@addr & 0xfff00000 == 0xac100000 || # 172.16.0.0/12
@addr & 0xffff0000 == 0xc0a80000 # 192.168.0.0/16
when Socket::AF_INET6
@addr & 0xfe00_0000_0000_0000_0000_0000_0000_0000 == 0xfc00_0000_0000_0000_0000_0000_0000_0000 ||
(@addr & 0xffff_0000_0000 == 0xffff_0000_0000 && (
@addr & 0xff000000 == 0x0a000000 || # ::ffff:10.0.0.0/8
@addr & 0xfff00000 == 0xac100000 || # ::ffff::172.16.0.0/12
@addr & 0xffff0000 == 0xc0a80000 # ::ffff::192.168.0.0/16
))
else
raise AddressFamilyError, "unsupported address family"
end
end
# 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?
case @family
when Socket::AF_INET
@addr & 0xffff0000 == 0xa9fe0000 # 169.254.0.0/16
when Socket::AF_INET6
@addr & 0xffc0_0000_0000_0000_0000_0000_0000_0000 == 0xfe80_0000_0000_0000_0000_0000_0000_0000
else
raise AddressFamilyError, "unsupported address family"
end
end
# Returns true if the ipaddr is an IPv4-mapped IPv6 address.
def ipv4_mapped?
return ipv6? && (@addr >> 32) == 0xffff
end
# Returns true if the ipaddr is an IPv4-compatible IPv6 address.
def ipv4_compat?
warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
_ipv4_compat?
end
def _ipv4_compat?
if !ipv6? || (@addr >> 32) != 0
return false
end
a = (@addr & IN4MASK)
return a != 0 && a != 1
end
private :_ipv4_compat?
# Returns a new ipaddr built by converting the native IPv4 address
# into an IPv4-mapped IPv6 address.
def ipv4_mapped
if !ipv4?
raise InvalidAddressError, "not an IPv4 address: #{@addr}"
end
clone = self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6)
clone.instance_variable_set(:@mask_addr, @mask_addr | 0xffffffffffffffffffffffff00000000)
clone
end
# Returns a new ipaddr built by converting the native IPv4 address
# into an IPv4-compatible IPv6 address.
def ipv4_compat
warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE
if !ipv4?
raise InvalidAddressError, "not an IPv4 address: #{@addr}"
end
return self.clone.set(@addr, Socket::AF_INET6)
end
# 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
if !ipv4_mapped? && !_ipv4_compat?
return self
end
return self.clone.set(@addr & IN4MASK, Socket::AF_INET)
end
# Returns a string for DNS reverse lookup. It returns a string in
# RFC3172 form for an IPv6 address.
def reverse
case @family
when Socket::AF_INET
return _reverse + ".in-addr.arpa"
when Socket::AF_INET6
return ip6_arpa
else
raise AddressFamilyError, "unsupported address family"
end
end
# Returns a string for DNS reverse lookup compatible with RFC3172.
def ip6_arpa
if !ipv6?
raise InvalidAddressError, "not an IPv6 address: #{@addr}"
end
return _reverse + ".ip6.arpa"
end
# Returns a string for DNS reverse lookup compatible with RFC1886.
def ip6_int
if !ipv6?
raise InvalidAddressError, "not an IPv6 address: #{@addr}"
end
return _reverse + ".ip6.int"
end
# Returns the successor to the ipaddr.
def succ
return self.clone.set(@addr + 1, @family)
end
# Compares the ipaddr with another.
def <=>(other)
other = coerce_other(other)
rescue
nil
else
@addr <=> other.to_i if other.family == @family
end
include Comparable
# Checks equality used by Hash.
def eql?(other)
return self.class == other.class && self.hash == other.hash && self == other
end
# Returns a hash value used by Hash, Set, and Array classes
def hash
return ([@addr, @mask_addr, @zone_id].hash << 1) | (ipv4? ? 0 : 1)
end
# Creates a Range object for the network address.
def to_range
self.class.new(begin_addr, @family)..self.class.new(end_addr, @family)
end
# Returns the prefix length in bits for the ipaddr.
def prefix
case @family
when Socket::AF_INET
n = IN4MASK ^ @mask_addr
i = 32
when Socket::AF_INET6
n = IN6MASK ^ @mask_addr
i = 128
else
raise AddressFamilyError, "unsupported address family"
end
while n.positive?
n >>= 1
i -= 1
end
i
end
# Sets the prefix length in bits
def prefix=(prefix)
case prefix
when Integer
mask!(prefix)
else
raise InvalidPrefixError, "prefix must be an integer: #{@addr}"
end
end
# Returns a string containing a human-readable representation of the
# ipaddr. ("#<IPAddr: family:address/mask>")
def inspect
case @family
when Socket::AF_INET
af = "IPv4"
when Socket::AF_INET6
af = "IPv6"
zone_id = @zone_id.to_s
else
raise AddressFamilyError, "unsupported address family"
end
return sprintf("#<%s: %s:%s%s/%s>", self.class.name,
af, _to_string(@addr), zone_id, _to_string(@mask_addr))
end
# Returns the netmask in string format e.g. 255.255.0.0
def netmask
_to_string(@mask_addr)
end
# Returns the IPv6 zone identifier, if present.
# Raises InvalidAddressError if not an IPv6 address.
def zone_id
if @family == Socket::AF_INET6
@zone_id
else
raise InvalidAddressError, "not an IPv6 address"
end
end
# Returns the IPv6 zone identifier, if present.
# Raises InvalidAddressError if not an IPv6 address.
def zone_id=(zid)
if @family == Socket::AF_INET6
case zid
when nil, /\A%(\w+)\z/
@zone_id = zid
else
raise InvalidAddressError, "invalid zone identifier for address"
end
else
raise InvalidAddressError, "not an IPv6 address"
end
end
protected
def begin_addr
@addr & @mask_addr
end
def end_addr
case @family
when Socket::AF_INET
@addr | (IN4MASK ^ @mask_addr)
when Socket::AF_INET6
@addr | (IN6MASK ^ @mask_addr)
else
raise AddressFamilyError, "unsupported address family"
end
end
# Set +@addr+, the internal stored ip address, to given +addr+. The
# parameter +addr+ is validated using the first +family+ member,
# which is +Socket::AF_INET+ or +Socket::AF_INET6+.
def set(addr, *family)
case family[0] ? family[0] : @family
when Socket::AF_INET
if addr < 0 || addr > IN4MASK
raise InvalidAddressError, "invalid address: #{@addr}"
end
when Socket::AF_INET6
if addr < 0 || addr > IN6MASK
raise InvalidAddressError, "invalid address: #{@addr}"
end
else
raise AddressFamilyError, "unsupported address family"
end
@addr = addr
if family[0]
@family = family[0]
if @family == Socket::AF_INET
@mask_addr &= IN4MASK
end
end
return self
end
# Set current netmask to given mask.
def mask!(mask)
case mask
when String
case mask
when /\A(0|[1-9]+\d*)\z/
prefixlen = mask.to_i
when /\A\d+\z/
raise InvalidPrefixError, "leading zeros in prefix"
else
m = IPAddr.new(mask)
if m.family != @family
raise InvalidPrefixError, "address family is not same: #{@addr}"
end
@mask_addr = m.to_i
n = @mask_addr ^ m.instance_variable_get(:@mask_addr)
unless ((n + 1) & n).zero?
raise InvalidPrefixError, "invalid mask #{mask}: #{@addr}"
end
@addr &= @mask_addr
return self
end
else
prefixlen = mask
end
case @family
when Socket::AF_INET
if prefixlen < 0 || prefixlen > 32
raise InvalidPrefixError, "invalid length: #{@addr}"
end
masklen = 32 - prefixlen
@mask_addr = ((IN4MASK >> masklen) << masklen)
when Socket::AF_INET6
if prefixlen < 0 || prefixlen > 128
raise InvalidPrefixError, "invalid length: #{@addr}"
end
masklen = 128 - prefixlen
@mask_addr = ((IN6MASK >> masklen) << masklen)
else
raise AddressFamilyError, "unsupported address family"
end
@addr = ((@addr >> masklen) << masklen)
return self
end
private
# 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(addr = '::', family = Socket::AF_UNSPEC)
@mask_addr = nil
if !addr.kind_of?(String)
case family
when Socket::AF_INET, Socket::AF_INET6
set(addr.to_i, family)
@mask_addr = (family == Socket::AF_INET) ? IN4MASK : IN6MASK
return
when Socket::AF_UNSPEC
raise AddressFamilyError, "address family must be specified"
else
raise AddressFamilyError, "unsupported address family: #{family}"
end
end
prefix, prefixlen = addr.split('/', 2)
if prefix =~ /\A\[(.*)\]\z/i
prefix = $1
family = Socket::AF_INET6
end
if prefix =~ /\A(.*)(%\w+)\z/
prefix = $1
zone_id = $2
family = Socket::AF_INET6
end
# It seems AI_NUMERICHOST doesn't do the job.
#Socket.getaddrinfo(left, nil, Socket::AF_INET6, Socket::SOCK_STREAM, nil,
# Socket::AI_NUMERICHOST)
@addr = @family = nil
if family == Socket::AF_UNSPEC || family == Socket::AF_INET
@addr = in_addr(prefix)
if @addr
@family = Socket::AF_INET
end
end
if !@addr && (family == Socket::AF_UNSPEC || family == Socket::AF_INET6)
@addr = in6_addr(prefix)
@family = Socket::AF_INET6
end
@zone_id = zone_id
if family != Socket::AF_UNSPEC && @family != family
raise AddressFamilyError, "address family mismatch"
end
if prefixlen
mask!(prefixlen)
else
@mask_addr = (@family == Socket::AF_INET) ? IN4MASK : IN6MASK
end
end
def coerce_other(other)
case other
when IPAddr
other
when String
self.class.new(other)
else
self.class.new(other, @family)
end
end
def in_addr(addr)
case addr
when Array
octets = addr
else
m = RE_IPV4ADDRLIKE.match(addr) or return nil
octets = m.captures
end
octets.inject(0) { |i, s|
(n = s.to_i) < 256 or raise InvalidAddressError, "invalid address: #{@addr}"
s.match(/\A0./) and raise InvalidAddressError, "zero-filled number in IPv4 address is ambiguous: #{@addr}"
i << 8 | n
}
end
def in6_addr(left)
case left
when RE_IPV6ADDRLIKE_FULL
if $2
addr = in_addr($~[2,4])
left = $1 + ':'
else
addr = 0
end
right = ''
when RE_IPV6ADDRLIKE_COMPRESSED
if $4
left.count(':') <= 6 or raise InvalidAddressError, "invalid address: #{@addr}"
addr = in_addr($~[4,4])
left = $1
right = $3 + '0:0'
else
left.count(':') <= ($1.empty? || $2.empty? ? 8 : 7) or
raise InvalidAddressError, "invalid address: #{@addr}"
left = $1
right = $2
addr = 0
end
else
raise InvalidAddressError, "invalid address: #{@addr}"
end
l = left.split(':')
r = right.split(':')
rest = 8 - l.size - r.size
if rest < 0
return nil
end
(l + Array.new(rest, '0') + r).inject(0) { |i, s|
i << 16 | s.hex
} | addr
end
def addr_mask(addr)
case @family
when Socket::AF_INET
return addr & IN4MASK
when Socket::AF_INET6
return addr & IN6MASK
else
raise AddressFamilyError, "unsupported address family"
end
end
def _reverse
case @family
when Socket::AF_INET
return (0..3).map { |i|
(@addr >> (8 * i)) & 0xff
}.join('.')
when Socket::AF_INET6
return ("%.32x" % @addr).reverse!.gsub!(/.(?!$)/, '\&.')
else
raise AddressFamilyError, "unsupported address family"
end
end
def _to_string(addr)
case @family
when Socket::AF_INET
return (0..3).map { |i|
(addr >> (24 - 8 * i)) & 0xff
}.join('.')
when Socket::AF_INET6
return (("%.32x" % addr).gsub!(/.{4}(?!$)/, '\&:'))
else
raise AddressFamilyError, "unsupported address family"
end
end
end
unless Socket.const_defined? :AF_INET6
class Socket < BasicSocket
# IPv6 protocol family
AF_INET6 = Object.new.freeze
end
class << IPSocket
private
def valid_v6?(addr)
case addr
when IPAddr::RE_IPV6ADDRLIKE_FULL
if $2
$~[2,4].all? {|i| i.to_i < 256 }
else
true
end
when IPAddr::RE_IPV6ADDRLIKE_COMPRESSED
if $4
addr.count(':') <= 6 && $~[4,4].all? {|i| i.to_i < 256}
else
addr.count(':') <= 7
end
else
false
end
end
alias getaddress_orig getaddress
public
# Returns a +String+ based representation of a valid DNS hostname,
# IPv4 or IPv6 address.
#
# IPSocket.getaddress 'localhost' #=> "::1"
# IPSocket.getaddress 'broadcasthost' #=> "255.255.255.255"
# IPSocket.getaddress 'www.ruby-lang.org' #=> "221.186.184.68"
# IPSocket.getaddress 'www.ccc.de' #=> "2a00:1328:e102:ccc0::122"
def getaddress(s)
if valid_v6?(s)
s
else
getaddress_orig(s)
end
end
end
end
share/ruby/openssl.rb 0000644 00000002034 15173517735 0010654 0 ustar 00 # frozen_string_literal: true
=begin
= Info
'OpenSSL for Ruby 2' project
Copyright (C) 2002 Michal Rokos <m.rokos@sh.cvut.cz>
All rights reserved.
= Licence
This program is licensed under the same licence as Ruby.
(See the file 'LICENCE'.)
=end
require 'openssl.so'
require_relative 'openssl/bn'
require_relative 'openssl/pkey'
require_relative 'openssl/cipher'
require_relative 'openssl/digest'
require_relative 'openssl/hmac'
require_relative 'openssl/x509'
require_relative 'openssl/ssl'
require_relative 'openssl/pkcs5'
require_relative 'openssl/version'
module OpenSSL
# call-seq:
# OpenSSL.secure_compare(string, string) -> boolean
#
# Constant time memory comparison. Inputs are hashed using SHA-256 to mask
# the length of the secret. Returns +true+ if the strings are identical,
# +false+ otherwise.
def self.secure_compare(a, b)
hashed_a = OpenSSL::Digest.digest('SHA256', a)
hashed_b = OpenSSL::Digest.digest('SHA256', b)
OpenSSL.fixed_length_secure_compare(hashed_a, hashed_b) && a == b
end
end
share/ruby/digest/sha2/loader.rb 0000644 00000000070 15173517735 0012551 0 ustar 00 # frozen_string_literal: true
require 'digest/sha2.so'
share/ruby/digest/loader.rb 0000644 00000000063 15173517735 0011716 0 ustar 00 # frozen_string_literal: true
require 'digest.so'
share/ruby/digest/version.rb 0000644 00000000105 15173517735 0012132 0 ustar 00 # frozen_string_literal: true
module Digest
VERSION = "3.1.1"
end
share/ruby/digest/sha2.rb 0000644 00000007425 15173517735 0011316 0 ustar 00 # frozen_string_literal: false
#--
# sha2.rb - defines Digest::SHA2 class which wraps up the SHA256,
# SHA384, and SHA512 classes.
#++
# Copyright (c) 2006 Akinori MUSHA <knu@iDaemons.org>
#
# All rights reserved. You can redistribute and/or modify it under the same
# terms as Ruby.
#
# $Id$
require 'digest'
require 'digest/sha2/loader'
module Digest
#
# A meta digest provider class for SHA256, SHA384 and SHA512.
#
# FIPS 180-2 describes SHA2 family of digest algorithms. It defines
# three algorithms:
# * one which works on chunks of 512 bits and returns a 256-bit
# digest (SHA256),
# * one which works on chunks of 1024 bits and returns a 384-bit
# digest (SHA384),
# * and one which works on chunks of 1024 bits and returns a 512-bit
# digest (SHA512).
#
# ==Examples
# require 'digest'
#
# # Compute a complete digest
# Digest::SHA2.hexdigest 'abc' # => "ba7816bf8..."
# Digest::SHA2.new(256).hexdigest 'abc' # => "ba7816bf8..."
# Digest::SHA256.hexdigest 'abc' # => "ba7816bf8..."
#
# Digest::SHA2.new(384).hexdigest 'abc' # => "cb00753f4..."
# Digest::SHA384.hexdigest 'abc' # => "cb00753f4..."
#
# Digest::SHA2.new(512).hexdigest 'abc' # => "ddaf35a19..."
# Digest::SHA512.hexdigest 'abc' # => "ddaf35a19..."
#
# # Compute digest by chunks
# sha2 = Digest::SHA2.new # =>#<Digest::SHA2:256>
# sha2.update "ab"
# sha2 << "c" # alias for #update
# sha2.hexdigest # => "ba7816bf8..."
#
# # Use the same object to compute another digest
# sha2.reset
# sha2 << "message"
# sha2.hexdigest # => "ab530a13e..."
#
class SHA2 < Digest::Class
# call-seq:
# Digest::SHA2.new(bitlen = 256) -> digest_obj
#
# Create a new SHA2 hash object with a given bit length.
#
# Valid bit lengths are 256, 384 and 512.
def initialize(bitlen = 256)
case bitlen
when 256
@sha2 = Digest::SHA256.new
when 384
@sha2 = Digest::SHA384.new
when 512
@sha2 = Digest::SHA512.new
else
raise ArgumentError, "unsupported bit length: %s" % bitlen.inspect
end
@bitlen = bitlen
end
# call-seq:
# digest_obj.reset -> digest_obj
#
# Reset the digest to the initial state and return self.
def reset
@sha2.reset
self
end
# call-seq:
# digest_obj.update(string) -> digest_obj
# digest_obj << string -> digest_obj
#
# Update the digest using a given _string_ and return self.
def update(str)
@sha2.update(str)
self
end
alias << update
def finish # :nodoc:
@sha2.digest!
end
private :finish
# call-seq:
# digest_obj.block_length -> Integer
#
# Return the block length of the digest in bytes.
#
# Digest::SHA256.new.block_length * 8
# # => 512
# Digest::SHA384.new.block_length * 8
# # => 1024
# Digest::SHA512.new.block_length * 8
# # => 1024
def block_length
@sha2.block_length
end
# call-seq:
# digest_obj.digest_length -> Integer
#
# Return the length of the hash value (the digest) in bytes.
#
# Digest::SHA256.new.digest_length * 8
# # => 256
# Digest::SHA384.new.digest_length * 8
# # => 384
# Digest::SHA512.new.digest_length * 8
# # => 512
#
# For example, digests produced by Digest::SHA256 will always be 32 bytes
# (256 bits) in size.
def digest_length
@sha2.digest_length
end
def initialize_copy(other) # :nodoc:
@sha2 = other.instance_eval { @sha2.clone }
end
def inspect # :nodoc:
"#<%s:%d %s>" % [self.class.name, @bitlen, hexdigest]
end
end
end
share/ruby/pstore.rb 0000644 00000050565 15173517735 0010521 0 ustar 00 # frozen_string_literal: true
# = PStore -- Transactional File Storage for Ruby Objects
#
# pstore.rb -
# originally by matz
# documentation by Kev Jackson and James Edward Gray II
# improved by Hongli Lai
#
# See PStore for documentation.
require "digest"
# \PStore implements a file based persistence mechanism based on a Hash.
# User code can store hierarchies of Ruby objects (values)
# into the data store by name (keys).
# An object hierarchy may be just a single object.
# User code may later read values back from the data store
# or even update data, as needed.
#
# The transactional behavior ensures that any changes succeed or fail together.
# This can be used to ensure that the data store is not left in a transitory state,
# where some values were updated but others were not.
#
# Behind the scenes, Ruby objects are stored to the data store file with Marshal.
# That carries the usual limitations. Proc objects cannot be marshalled,
# for example.
#
# There are three important concepts here (details at the links):
#
# - {Store}[rdoc-ref:PStore@The+Store]: a store is an instance of \PStore.
# - {Entries}[rdoc-ref:PStore@Entries]: the store is hash-like;
# each entry is the key for a stored object.
# - {Transactions}[rdoc-ref:PStore@Transactions]: each transaction is a collection
# of prospective changes to the store;
# a transaction is defined in the block given with a call
# to PStore#transaction.
#
# == About the Examples
#
# Examples on this page need a store that has known properties.
# They can get a new (and populated) store by calling thus:
#
# example_store do |store|
# # Example code using store goes here.
# end
#
# All we really need to know about +example_store+
# is that it yields a fresh store with a known population of entries;
# its implementation:
#
# require 'pstore'
# require 'tempfile'
# # Yield a pristine store for use in examples.
# def example_store
# # Create the store in a temporary file.
# Tempfile.create do |file|
# store = PStore.new(file)
# # Populate the store.
# store.transaction do
# store[:foo] = 0
# store[:bar] = 1
# store[:baz] = 2
# end
# yield store
# end
# end
#
# == The Store
#
# The contents of the store are maintained in a file whose path is specified
# when the store is created (see PStore.new).
# The objects are stored and retrieved using
# module Marshal, which means that certain objects cannot be added to the store;
# see {Marshal::dump}[rdoc-ref:Marshal.dump].
#
# == Entries
#
# A store may have any number of entries.
# Each entry has a key and a value, just as in a hash:
#
# - Key: as in a hash, the key can be (almost) any object;
# see {Hash Keys}[rdoc-ref:Hash@Hash+Keys].
# You may find it convenient to keep it simple by using only
# symbols or strings as keys.
# - Value: the value may be any object that can be marshalled by \Marshal
# (see {Marshal::dump}[rdoc-ref:Marshal.dump])
# and in fact may be a collection
# (e.g., an array, a hash, a set, a range, etc).
# That collection may in turn contain nested objects,
# including collections, to any depth;
# those objects must also be \Marshal-able.
# See {Hierarchical Values}[rdoc-ref:PStore@Hierarchical+Values].
#
# == Transactions
#
# === The Transaction Block
#
# The block given with a call to method #transaction#
# contains a _transaction_,
# which consists of calls to \PStore methods that
# read from or write to the store
# (that is, all \PStore methods except #transaction itself,
# #path, and Pstore.new):
#
# example_store do |store|
# store.transaction do
# store.keys # => [:foo, :bar, :baz]
# store[:bat] = 3
# store.keys # => [:foo, :bar, :baz, :bat]
# end
# end
#
# Execution of the transaction is deferred until the block exits,
# and is executed _atomically_ (all-or-nothing):
# either all transaction calls are executed, or none are.
# This maintains the integrity of the store.
#
# Other code in the block (including even calls to #path and PStore.new)
# is executed immediately, not deferred.
#
# The transaction block:
#
# - May not contain a nested call to #transaction.
# - Is the only context where methods that read from or write to
# the store are allowed.
#
# As seen above, changes in a transaction are made automatically
# when the block exits.
# The block may be exited early by calling method #commit or #abort.
#
# - Method #commit triggers the update to the store and exits the block:
#
# example_store do |store|
# store.transaction do
# store.keys # => [:foo, :bar, :baz]
# store[:bat] = 3
# store.commit
# fail 'Cannot get here'
# end
# store.transaction do
# # Update was completed.
# store.keys # => [:foo, :bar, :baz, :bat]
# end
# end
#
# - Method #abort discards the update to the store and exits the block:
#
# example_store do |store|
# store.transaction do
# store.keys # => [:foo, :bar, :baz]
# store[:bat] = 3
# store.abort
# fail 'Cannot get here'
# end
# store.transaction do
# # Update was not completed.
# store.keys # => [:foo, :bar, :baz]
# end
# end
#
# === Read-Only Transactions
#
# By default, a transaction allows both reading from and writing to
# the store:
#
# store.transaction do
# # Read-write transaction.
# # Any code except a call to #transaction is allowed here.
# end
#
# If argument +read_only+ is passed as +true+,
# only reading is allowed:
#
# store.transaction(true) do
# # Read-only transaction:
# # Calls to #transaction, #[]=, and #delete are not allowed here.
# end
#
# == Hierarchical Values
#
# The value for an entry may be a simple object (as seen above).
# It may also be a hierarchy of objects nested to any depth:
#
# deep_store = PStore.new('deep.store')
# deep_store.transaction do
# array_of_hashes = [{}, {}, {}]
# deep_store[:array_of_hashes] = array_of_hashes
# deep_store[:array_of_hashes] # => [{}, {}, {}]
# hash_of_arrays = {foo: [], bar: [], baz: []}
# deep_store[:hash_of_arrays] = hash_of_arrays
# deep_store[:hash_of_arrays] # => {:foo=>[], :bar=>[], :baz=>[]}
# deep_store[:hash_of_arrays][:foo].push(:bat)
# deep_store[:hash_of_arrays] # => {:foo=>[:bat], :bar=>[], :baz=>[]}
# end
#
# And recall that you can use
# {dig methods}[rdoc-ref:dig_methods.rdoc]
# in a returned hierarchy of objects.
#
# == Working with the Store
#
# === Creating a Store
#
# Use method PStore.new to create a store.
# The new store creates or opens its containing file:
#
# store = PStore.new('t.store')
#
# === Modifying the Store
#
# Use method #[]= to update or create an entry:
#
# example_store do |store|
# store.transaction do
# store[:foo] = 1 # Update.
# store[:bam] = 1 # Create.
# end
# end
#
# Use method #delete to remove an entry:
#
# example_store do |store|
# store.transaction do
# store.delete(:foo)
# store[:foo] # => nil
# end
# end
#
# === Retrieving Values
#
# Use method #fetch (allows default) or #[] (defaults to +nil+)
# to retrieve an entry:
#
# example_store do |store|
# store.transaction do
# store[:foo] # => 0
# store[:nope] # => nil
# store.fetch(:baz) # => 2
# store.fetch(:nope, nil) # => nil
# store.fetch(:nope) # Raises exception.
# end
# end
#
# === Querying the Store
#
# Use method #key? to determine whether a given key exists:
#
# example_store do |store|
# store.transaction do
# store.key?(:foo) # => true
# end
# end
#
# Use method #keys to retrieve keys:
#
# example_store do |store|
# store.transaction do
# store.keys # => [:foo, :bar, :baz]
# end
# end
#
# Use method #path to retrieve the path to the store's underlying file;
# this method may be called from outside a transaction block:
#
# store = PStore.new('t.store')
# store.path # => "t.store"
#
# == Transaction Safety
#
# For transaction safety, see:
#
# - Optional argument +thread_safe+ at method PStore.new.
# - Attribute #ultra_safe.
#
# Needless to say, if you're storing valuable data with \PStore, then you should
# backup the \PStore file from time to time.
#
# == An Example Store
#
# require "pstore"
#
# # A mock wiki object.
# class WikiPage
#
# attr_reader :page_name
#
# def initialize(page_name, author, contents)
# @page_name = page_name
# @revisions = Array.new
# add_revision(author, contents)
# end
#
# def add_revision(author, contents)
# @revisions << {created: Time.now,
# author: author,
# contents: contents}
# end
#
# def wiki_page_references
# [@page_name] + @revisions.last[:contents].scan(/\b(?:[A-Z]+[a-z]+){2,}/)
# end
#
# end
#
# # Create a new wiki page.
# home_page = WikiPage.new("HomePage", "James Edward Gray II",
# "A page about the JoysOfDocumentation..." )
#
# wiki = PStore.new("wiki_pages.pstore")
# # Update page data and the index together, or not at all.
# wiki.transaction do
# # Store page.
# wiki[home_page.page_name] = home_page
# # Create page index.
# wiki[:wiki_index] ||= Array.new
# # Update wiki index.
# wiki[:wiki_index].push(*home_page.wiki_page_references)
# end
#
# # Read wiki data, setting argument read_only to true.
# wiki.transaction(true) do
# wiki.keys.each do |key|
# puts key
# puts wiki[key]
# end
# end
#
class PStore
VERSION = "0.1.3"
RDWR_ACCESS = {mode: IO::RDWR | IO::CREAT | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
RD_ACCESS = {mode: IO::RDONLY | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
WR_ACCESS = {mode: IO::WRONLY | IO::CREAT | IO::TRUNC | IO::BINARY, encoding: Encoding::ASCII_8BIT}.freeze
# The error type thrown by all PStore methods.
class Error < StandardError
end
# Whether \PStore should do its best to prevent file corruptions,
# even when an unlikely error (such as memory-error or filesystem error) occurs:
#
# - +true+: changes are posted by creating a temporary file,
# writing the updated data to it, then renaming the file to the given #path.
# File integrity is maintained.
# Note: has effect only if the filesystem has atomic file rename
# (as do POSIX platforms Linux, MacOS, FreeBSD and others).
#
# - +false+ (the default): changes are posted by rewinding the open file
# and writing the updated data.
# File integrity is maintained if the filesystem raises
# no unexpected I/O error;
# if such an error occurs during a write to the store,
# the file may become corrupted.
#
attr_accessor :ultra_safe
# Returns a new \PStore object.
#
# Argument +file+ is the path to the file in which objects are to be stored;
# if the file exists, it should be one that was written by \PStore.
#
# path = 't.store'
# store = PStore.new(path)
#
# A \PStore object is
# {reentrant}[https://en.wikipedia.org/wiki/Reentrancy_(computing)].
# If argument +thread_safe+ is given as +true+,
# the object is also thread-safe (at the cost of a small performance penalty):
#
# store = PStore.new(path, true)
#
def initialize(file, thread_safe = false)
dir = File::dirname(file)
unless File::directory? dir
raise PStore::Error, format("directory %s does not exist", dir)
end
if File::exist? file and not File::readable? file
raise PStore::Error, format("file %s not readable", file)
end
@filename = file
@abort = false
@ultra_safe = false
@thread_safe = thread_safe
@lock = Thread::Mutex.new
end
# Raises PStore::Error if the calling code is not in a PStore#transaction.
def in_transaction
raise PStore::Error, "not in transaction" unless @lock.locked?
end
#
# Raises PStore::Error if the calling code is not in a PStore#transaction or
# if the code is in a read-only PStore#transaction.
#
def in_transaction_wr
in_transaction
raise PStore::Error, "in read-only transaction" if @rdonly
end
private :in_transaction, :in_transaction_wr
# Returns the value for the given +key+ if the key exists.
# +nil+ otherwise;
# if not +nil+, the returned value is an object or a hierarchy of objects:
#
# example_store do |store|
# store.transaction do
# store[:foo] # => 0
# store[:nope] # => nil
# end
# end
#
# Returns +nil+ if there is no such key.
#
# See also {Hierarchical Values}[rdoc-ref:PStore@Hierarchical+Values].
#
# Raises an exception if called outside a transaction block.
def [](key)
in_transaction
@table[key]
end
# Like #[], except that it accepts a default value for the store.
# If the +key+ does not exist:
#
# - Raises an exception if +default+ is +PStore::Error+.
# - Returns the value of +default+ otherwise:
#
# example_store do |store|
# store.transaction do
# store.fetch(:nope, nil) # => nil
# store.fetch(:nope) # Raises an exception.
# end
# end
#
# Raises an exception if called outside a transaction block.
def fetch(key, default=PStore::Error)
in_transaction
unless @table.key? key
if default == PStore::Error
raise PStore::Error, format("undefined key `%s'", key)
else
return default
end
end
@table[key]
end
# Creates or replaces the value for the given +key+:
#
# example_store do |store|
# temp.transaction do
# temp[:bat] = 3
# end
# end
#
# See also {Hierarchical Values}[rdoc-ref:PStore@Hierarchical+Values].
#
# Raises an exception if called outside a transaction block.
def []=(key, value)
in_transaction_wr
@table[key] = value
end
# Removes and returns the value at +key+ if it exists:
#
# example_store do |store|
# store.transaction do
# store[:bat] = 3
# store.delete(:bat)
# end
# end
#
# Returns +nil+ if there is no such key.
#
# Raises an exception if called outside a transaction block.
def delete(key)
in_transaction_wr
@table.delete key
end
# Returns an array of the existing keys:
#
# example_store do |store|
# store.transaction do
# store.keys # => [:foo, :bar, :baz]
# end
# end
#
# Raises an exception if called outside a transaction block.
def keys
in_transaction
@table.keys
end
alias roots keys
# Returns +true+ if +key+ exists, +false+ otherwise:
#
# example_store do |store|
# store.transaction do
# store.key?(:foo) # => true
# end
# end
#
# Raises an exception if called outside a transaction block.
def key?(key)
in_transaction
@table.key? key
end
alias root? key?
# Returns the string file path used to create the store:
#
# store.path # => "flat.store"
#
def path
@filename
end
# Exits the current transaction block, committing any changes
# specified in the
# {transaction block}[rdoc-ref:PStore@The+Transaction+Block].
#
# Raises an exception if called outside a transaction block.
def commit
in_transaction
@abort = false
throw :pstore_abort_transaction
end
# Exits the current transaction block, discarding any changes
# specified in the
# {transaction block}[rdoc-ref:PStore@The+Transaction+Block].
#
# Raises an exception if called outside a transaction block.
def abort
in_transaction
@abort = true
throw :pstore_abort_transaction
end
# Opens a transaction block for the store.
# See {Transactions}[rdoc-ref:PStore@Transactions].
#
# With argument +read_only+ as +false+, the block may both read from
# and write to the store.
#
# With argument +read_only+ as +true+, the block may not include calls
# to #transaction, #[]=, or #delete.
#
# Raises an exception if called within a transaction block.
def transaction(read_only = false) # :yields: pstore
value = nil
if !@thread_safe
raise PStore::Error, "nested transaction" unless @lock.try_lock
else
begin
@lock.lock
rescue ThreadError
raise PStore::Error, "nested transaction"
end
end
begin
@rdonly = read_only
@abort = false
file = open_and_lock_file(@filename, read_only)
if file
begin
@table, checksum, original_data_size = load_data(file, read_only)
catch(:pstore_abort_transaction) do
value = yield(self)
end
if !@abort && !read_only
save_data(checksum, original_data_size, file)
end
ensure
file.close
end
else
# This can only occur if read_only == true.
@table = {}
catch(:pstore_abort_transaction) do
value = yield(self)
end
end
ensure
@lock.unlock
end
value
end
private
# Constant for relieving Ruby's garbage collector.
CHECKSUM_ALGO = %w[SHA512 SHA384 SHA256 SHA1 RMD160 MD5].each do |algo|
begin
break Digest(algo)
rescue LoadError
end
end
EMPTY_STRING = ""
EMPTY_MARSHAL_DATA = Marshal.dump({})
EMPTY_MARSHAL_CHECKSUM = CHECKSUM_ALGO.digest(EMPTY_MARSHAL_DATA)
#
# Open the specified filename (either in read-only mode or in
# read-write mode) and lock it for reading or writing.
#
# The opened File object will be returned. If _read_only_ is true,
# and the file does not exist, then nil will be returned.
#
# All exceptions are propagated.
#
def open_and_lock_file(filename, read_only)
if read_only
begin
file = File.new(filename, **RD_ACCESS)
begin
file.flock(File::LOCK_SH)
return file
rescue
file.close
raise
end
rescue Errno::ENOENT
return nil
end
else
file = File.new(filename, **RDWR_ACCESS)
file.flock(File::LOCK_EX)
return file
end
end
# Load the given PStore file.
# If +read_only+ is true, the unmarshalled Hash will be returned.
# If +read_only+ is false, a 3-tuple will be returned: the unmarshalled
# Hash, a checksum of the data, and the size of the data.
def load_data(file, read_only)
if read_only
begin
table = load(file)
raise Error, "PStore file seems to be corrupted." unless table.is_a?(Hash)
rescue EOFError
# This seems to be a newly-created file.
table = {}
end
table
else
data = file.read
if data.empty?
# This seems to be a newly-created file.
table = {}
checksum = empty_marshal_checksum
size = empty_marshal_data.bytesize
else
table = load(data)
checksum = CHECKSUM_ALGO.digest(data)
size = data.bytesize
raise Error, "PStore file seems to be corrupted." unless table.is_a?(Hash)
end
data.replace(EMPTY_STRING)
[table, checksum, size]
end
end
def on_windows?
is_windows = RUBY_PLATFORM =~ /mswin|mingw|bccwin|wince/
self.class.__send__(:define_method, :on_windows?) do
is_windows
end
is_windows
end
def save_data(original_checksum, original_file_size, file)
new_data = dump(@table)
if new_data.bytesize != original_file_size || CHECKSUM_ALGO.digest(new_data) != original_checksum
if @ultra_safe && !on_windows?
# Windows doesn't support atomic file renames.
save_data_with_atomic_file_rename_strategy(new_data, file)
else
save_data_with_fast_strategy(new_data, file)
end
end
new_data.replace(EMPTY_STRING)
end
def save_data_with_atomic_file_rename_strategy(data, file)
temp_filename = "#{@filename}.tmp.#{Process.pid}.#{rand 1000000}"
temp_file = File.new(temp_filename, **WR_ACCESS)
begin
temp_file.flock(File::LOCK_EX)
temp_file.write(data)
temp_file.flush
File.rename(temp_filename, @filename)
rescue
File.unlink(temp_file) rescue nil
raise
ensure
temp_file.close
end
end
def save_data_with_fast_strategy(data, file)
file.rewind
file.write(data)
file.truncate(data.bytesize)
end
# This method is just a wrapped around Marshal.dump
# to allow subclass overriding used in YAML::Store.
def dump(table) # :nodoc:
Marshal::dump(table)
end
# This method is just a wrapped around Marshal.load.
# to allow subclass overriding used in YAML::Store.
def load(content) # :nodoc:
Marshal::load(content)
end
def empty_marshal_data
EMPTY_MARSHAL_DATA
end
def empty_marshal_checksum
EMPTY_MARSHAL_CHECKSUM
end
end
share/ruby/un.rb 0000644 00000026254 15173517735 0007625 0 ustar 00 # frozen_string_literal: false
#
# = un.rb
#
# Copyright (c) 2003 WATANABE Hirofumi <eban@ruby-lang.org>
#
# This program is free software.
# You can distribute/modify this program under the same terms of Ruby.
#
# == Utilities to replace common UNIX commands in Makefiles etc
#
# == SYNOPSIS
#
# ruby -run -e cp -- [OPTION] SOURCE DEST
# ruby -run -e ln -- [OPTION] TARGET LINK_NAME
# ruby -run -e mv -- [OPTION] SOURCE DEST
# ruby -run -e rm -- [OPTION] FILE
# ruby -run -e mkdir -- [OPTION] DIRS
# ruby -run -e rmdir -- [OPTION] DIRS
# ruby -run -e install -- [OPTION] SOURCE DEST
# ruby -run -e chmod -- [OPTION] OCTAL-MODE FILE
# ruby -run -e touch -- [OPTION] FILE
# ruby -run -e wait_writable -- [OPTION] FILE
# ruby -run -e mkmf -- [OPTION] EXTNAME [OPTION]
# ruby -run -e httpd -- [OPTION] [DocumentRoot]
# ruby -run -e colorize -- [FILE]
# ruby -run -e help [COMMAND]
require "fileutils"
require "optparse"
module FileUtils
@fileutils_output = $stdout
end
# :nodoc:
def setup(options = "", *long_options)
caller = caller_locations(1, 1)[0].label
opt_hash = {}
argv = []
OptionParser.new do |o|
options.scan(/.:?/) do |s|
opt_name = s.delete(":").intern
o.on("-" + s.tr(":", " ")) do |val|
opt_hash[opt_name] = val
end
end
long_options.each do |s|
opt_name, arg_name = s.split(/(?=[\s=])/, 2)
opt_name.delete_prefix!('--')
s = "--#{opt_name.gsub(/([A-Z]+|[a-z])([A-Z])/, '\1-\2').downcase}#{arg_name}"
puts "#{opt_name}=>#{s}" if $DEBUG
opt_name = opt_name.intern
o.on(s) do |val|
opt_hash[opt_name] = val
end
end
o.on("-v") do opt_hash[:verbose] = true end
o.on("--help") do
UN.help([caller])
exit
end
o.order!(ARGV) do |x|
if /[*?\[{]/ =~ x
argv.concat(Dir[x])
else
argv << x
end
end
end
yield argv, opt_hash
end
##
# Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY
#
# ruby -run -e cp -- [OPTION] SOURCE DEST
#
# -p preserve file attributes if possible
# -r copy recursively
# -l make hard link instead of copying (implies -r)
# -v verbose
#
def cp
setup("prl") do |argv, options|
cmd = "cp"
cmd += "_r" if options.delete :r
cmd = "cp_lr" if options.delete :l
options[:preserve] = true if options.delete :p
dest = argv.pop
argv = argv[0] if argv.size == 1
FileUtils.__send__ cmd, argv, dest, **options
end
end
##
# Create a link to the specified TARGET with LINK_NAME.
#
# ruby -run -e ln -- [OPTION] TARGET LINK_NAME
#
# -s make symbolic links instead of hard links
# -f remove existing destination files
# -v verbose
#
def ln
setup("sf") do |argv, options|
cmd = "ln"
cmd += "_s" if options.delete :s
options[:force] = true if options.delete :f
dest = argv.pop
argv = argv[0] if argv.size == 1
FileUtils.__send__ cmd, argv, dest, **options
end
end
##
# Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.
#
# ruby -run -e mv -- [OPTION] SOURCE DEST
#
# -v verbose
#
def mv
setup do |argv, options|
dest = argv.pop
argv = argv[0] if argv.size == 1
FileUtils.mv argv, dest, **options
end
end
##
# Remove the FILE
#
# ruby -run -e rm -- [OPTION] FILE
#
# -f ignore nonexistent files
# -r remove the contents of directories recursively
# -v verbose
#
def rm
setup("fr") do |argv, options|
cmd = "rm"
cmd += "_r" if options.delete :r
options[:force] = true if options.delete :f
FileUtils.__send__ cmd, argv, **options
end
end
##
# Create the DIR, if they do not already exist.
#
# ruby -run -e mkdir -- [OPTION] DIR
#
# -p no error if existing, make parent directories as needed
# -v verbose
#
def mkdir
setup("p") do |argv, options|
cmd = "mkdir"
cmd += "_p" if options.delete :p
FileUtils.__send__ cmd, argv, **options
end
end
##
# Remove the DIR.
#
# ruby -run -e rmdir -- [OPTION] DIR
#
# -p remove DIRECTORY and its ancestors.
# -v verbose
#
def rmdir
setup("p") do |argv, options|
options[:parents] = true if options.delete :p
FileUtils.rmdir argv, **options
end
end
##
# Copy SOURCE to DEST.
#
# ruby -run -e install -- [OPTION] SOURCE DEST
#
# -p apply access/modification times of SOURCE files to
# corresponding destination files
# -m set permission mode (as in chmod), instead of 0755
# -o set owner user id, instead of the current owner
# -g set owner group id, instead of the current group
# -v verbose
#
def install
setup("pm:o:g:") do |argv, options|
(mode = options.delete :m) and options[:mode] = /\A\d/ =~ mode ? mode.oct : mode
options[:preserve] = true if options.delete :p
(owner = options.delete :o) and options[:owner] = owner
(group = options.delete :g) and options[:group] = group
dest = argv.pop
argv = argv[0] if argv.size == 1
FileUtils.install argv, dest, **options
end
end
##
# Change the mode of each FILE to OCTAL-MODE.
#
# ruby -run -e chmod -- [OPTION] OCTAL-MODE FILE
#
# -v verbose
#
def chmod
setup do |argv, options|
mode = argv.shift
mode = /\A\d/ =~ mode ? mode.oct : mode
FileUtils.chmod mode, argv, **options
end
end
##
# Update the access and modification times of each FILE to the current time.
#
# ruby -run -e touch -- [OPTION] FILE
#
# -v verbose
#
def touch
setup do |argv, options|
FileUtils.touch argv, **options
end
end
##
# Wait until the file becomes writable.
#
# ruby -run -e wait_writable -- [OPTION] FILE
#
# -n RETRY count to retry
# -w SEC each wait time in seconds
# -v verbose
#
def wait_writable
setup("n:w:v") do |argv, options|
verbose = options[:verbose]
n = options[:n] and n = Integer(n)
wait = (wait = options[:w]) ? Float(wait) : 0.2
argv.each do |file|
begin
File.open(file, "r+b") {}
rescue Errno::ENOENT
break
rescue Errno::EACCES => e
raise if n and (n -= 1) <= 0
if verbose
puts e
STDOUT.flush
end
sleep wait
retry
end
end
end
end
##
# Create makefile using mkmf.
#
# ruby -run -e mkmf -- [OPTION] EXTNAME [OPTION]
#
# -d ARGS run dir_config
# -h ARGS run have_header
# -l ARGS run have_library
# -f ARGS run have_func
# -v ARGS run have_var
# -t ARGS run have_type
# -m ARGS run have_macro
# -c ARGS run have_const
# --vendor install to vendor_ruby
#
def mkmf
setup("d:h:l:f:v:t:m:c:", "vendor") do |argv, options|
require 'mkmf'
opt = options[:d] and opt.split(/:/).each {|n| dir_config(*n.split(/,/))}
opt = options[:h] and opt.split(/:/).each {|n| have_header(*n.split(/,/))}
opt = options[:l] and opt.split(/:/).each {|n| have_library(*n.split(/,/))}
opt = options[:f] and opt.split(/:/).each {|n| have_func(*n.split(/,/))}
opt = options[:v] and opt.split(/:/).each {|n| have_var(*n.split(/,/))}
opt = options[:t] and opt.split(/:/).each {|n| have_type(*n.split(/,/))}
opt = options[:m] and opt.split(/:/).each {|n| have_macro(*n.split(/,/))}
opt = options[:c] and opt.split(/:/).each {|n| have_const(*n.split(/,/))}
$configure_args["--vendor"] = true if options[:vendor]
create_makefile(*argv)
end
end
##
# Run WEBrick HTTP server.
#
# ruby -run -e httpd -- [OPTION] [DocumentRoot]
#
# --bind-address=ADDR address to bind
# --port=NUM listening port number
# --max-clients=MAX max number of simultaneous clients
# --temp-dir=DIR temporary directory
# --do-not-reverse-lookup disable reverse lookup
# --request-timeout=SECOND request timeout in seconds
# --http-version=VERSION HTTP version
# --server-name=NAME name of the server host
# --server-software=NAME name and version of the server
# --ssl-certificate=CERT The SSL certificate file for the server
# --ssl-private-key=KEY The SSL private key file for the server certificate
# -v verbose
#
def httpd
setup("", "BindAddress=ADDR", "Port=PORT", "MaxClients=NUM", "TempDir=DIR",
"DoNotReverseLookup", "RequestTimeout=SECOND", "HTTPVersion=VERSION",
"ServerName=NAME", "ServerSoftware=NAME",
"SSLCertificate=CERT", "SSLPrivateKey=KEY") do
|argv, options|
begin
require 'webrick'
rescue LoadError
abort "webrick is not found. You may need to `gem install webrick` to install webrick."
end
opt = options[:RequestTimeout] and options[:RequestTimeout] = opt.to_i
[:Port, :MaxClients].each do |name|
opt = options[name] and (options[name] = Integer(opt)) rescue nil
end
if cert = options[:SSLCertificate]
key = options[:SSLPrivateKey] or
raise "--ssl-private-key option must also be given"
require 'webrick/https'
options[:SSLEnable] = true
options[:SSLCertificate] = OpenSSL::X509::Certificate.new(File.read(cert))
options[:SSLPrivateKey] = OpenSSL::PKey.read(File.read(key))
options[:Port] ||= 8443 # HTTPS Alternate
end
options[:Port] ||= 8080 # HTTP Alternate
options[:DocumentRoot] = argv.shift || '.'
s = nil
options[:StartCallback] = proc {
logger = s.logger
logger.info("To access this server, open this URL in a browser:")
s.listeners.each do |listener|
if options[:SSLEnable]
addr = listener.addr
addr[3] = "127.0.0.1" if addr[3] == "0.0.0.0"
addr[3] = "::1" if addr[3] == "::"
logger.info(" https://#{Addrinfo.new(addr).inspect_sockaddr}")
else
logger.info(" http://#{listener.connect_address.inspect_sockaddr}")
end
end
}
s = WEBrick::HTTPServer.new(options)
shut = proc {s.shutdown}
siglist = %w"TERM QUIT"
siglist.concat(%w"HUP INT") if STDIN.tty?
siglist &= Signal.list.keys
siglist.each do |sig|
Signal.trap(sig, shut)
end
s.start
end
end
##
# Colorize ruby code.
#
# ruby -run -e colorize -- [FILE]
#
def colorize
begin
require "irb/color"
rescue LoadError
raise "colorize requires irb 1.1.0 or later"
end
setup do |argv, |
if argv.empty?
puts IRB::Color.colorize_code STDIN.read
return
end
argv.each do |file|
puts IRB::Color.colorize_code File.read(file)
end
end
end
##
# Display help message.
#
# ruby -run -e help [COMMAND]
#
def help
setup do |argv,|
UN.help(argv)
end
end
module UN # :nodoc:
VERSION = "0.3.0"
module_function
def help(argv, output: $stdout)
all = argv.empty?
cmd = nil
if all
store = proc {|msg| output << msg}
else
messages = {}
store = proc {|msg| messages[cmd] = msg}
end
File.open(__FILE__) do |me|
while me.gets("##\n")
if help = me.gets("\n\n")
if all or argv.include?(cmd = help[/^#\s*ruby\s.*-e\s+(\w+)/, 1])
store[help.gsub(/^# ?/, "")]
break unless all or argv.size > messages.size
end
end
end
end
if messages
argv.each {|arg| output << messages[arg]}
end
end
end
share/ruby/set/sorted_set.rb 0000644 00000000305 15173517735 0012136 0 ustar 00 begin
require 'sorted_set'
rescue ::LoadError
raise "The `SortedSet` class has been extracted from the `set` library. " \
"You must use the `sorted_set` gem or other alternatives."
end
share/ruby/readline.rb 0000644 00000000327 15173517735 0010757 0 ustar 00 begin
require "readline.#{RbConfig::CONFIG["DLEXT"]}"
rescue LoadError
require 'reline' unless defined? Reline
Object.send(:remove_const, :Readline) if Object.const_defined?(:Readline)
Readline = Reline
end
share/gems/gems/json-2.7.2/lib/json 0000755 00000000000 15173517735 0012622 0 ustar 00 share/ruby/drb/timeridconv.rb 0000644 00000004245 15173517735 0012271 0 ustar 00 # frozen_string_literal: false
require_relative 'drb'
require 'monitor'
module DRb
# Timer id conversion keeps objects alive for a certain amount of time after
# their last access. The default time period is 600 seconds and can be
# changed upon initialization.
#
# To use TimerIdConv:
#
# DRb.install_id_conv TimerIdConv.new 60 # one minute
class TimerIdConv < DRbIdConv
class TimerHolder2 # :nodoc:
include MonitorMixin
class InvalidIndexError < RuntimeError; end
def initialize(keeping=600)
super()
@sentinel = Object.new
@gc = {}
@renew = {}
@keeping = keeping
@expires = nil
end
def add(obj)
synchronize do
rotate
key = obj.__id__
@renew[key] = obj
invoke_keeper
return key
end
end
def fetch(key)
synchronize do
rotate
obj = peek(key)
raise InvalidIndexError if obj == @sentinel
@renew[key] = obj # KeepIt
return obj
end
end
private
def peek(key)
return @renew.fetch(key) { @gc.fetch(key, @sentinel) }
end
def invoke_keeper
return if @expires
@expires = Time.now + @keeping
on_gc
end
def on_gc
return unless Thread.main.alive?
return if @expires.nil?
Thread.new { rotate } if @expires < Time.now
ObjectSpace.define_finalizer(Object.new) {on_gc}
end
def rotate
synchronize do
if @expires &.< Time.now
@gc = @renew # GCed
@renew = {}
@expires = @gc.empty? ? nil : Time.now + @keeping
end
end
end
end
# Creates a new TimerIdConv which will hold objects for +keeping+ seconds.
def initialize(keeping=600)
@holder = TimerHolder2.new(keeping)
end
def to_obj(ref) # :nodoc:
return super if ref.nil?
@holder.fetch(ref)
rescue TimerHolder2::InvalidIndexError
raise "invalid reference"
end
def to_id(obj) # :nodoc:
return @holder.add(obj)
end
end
end
# DRb.install_id_conv(TimerIdConv.new)
share/ruby/drb/eq.rb 0000644 00000000423 15173517735 0010345 0 ustar 00 # frozen_string_literal: false
module DRb
class DRbObject # :nodoc:
def ==(other)
return false unless DRbObject === other
(@ref == other.__drbref) && (@uri == other.__drburi)
end
def hash
[@uri, @ref].hash
end
alias eql? ==
end
end
share/ruby/drb/ssl.rb 0000644 00000027620 15173517735 0010551 0 ustar 00 # frozen_string_literal: false
require 'socket'
require 'openssl'
require_relative 'drb'
require 'singleton'
module DRb
# The protocol for DRb over an SSL socket
#
# The URI for a DRb socket over SSL is:
# <code>drbssl://<host>:<port>?<option></code>. The option is optional
class DRbSSLSocket < DRbTCPSocket
# SSLConfig handles the needed SSL information for establishing a
# DRbSSLSocket connection, including generating the X509 / RSA pair.
#
# An instance of this config can be passed to DRbSSLSocket.new,
# DRbSSLSocket.open and DRbSSLSocket.open_server
#
# See DRb::DRbSSLSocket::SSLConfig.new for more details
class SSLConfig
# Default values for a SSLConfig instance.
#
# See DRb::DRbSSLSocket::SSLConfig.new for more details
DEFAULT = {
:SSLCertificate => nil,
:SSLPrivateKey => nil,
:SSLClientCA => nil,
:SSLCACertificatePath => nil,
:SSLCACertificateFile => nil,
:SSLTmpDhCallback => nil,
:SSLVerifyMode => ::OpenSSL::SSL::VERIFY_NONE,
:SSLVerifyDepth => nil,
:SSLVerifyCallback => nil, # custom verification
:SSLCertificateStore => nil,
# Must specify if you use auto generated certificate.
:SSLCertName => nil, # e.g. [["CN","fqdn.example.com"]]
:SSLCertComment => "Generated by Ruby/OpenSSL"
}
# Create a new DRb::DRbSSLSocket::SSLConfig instance
#
# The DRb::DRbSSLSocket will take either a +config+ Hash or an instance
# of SSLConfig, and will setup the certificate for its session for the
# configuration. If want it to generate a generic certificate, the bare
# minimum is to provide the :SSLCertName
#
# === Config options
#
# From +config+ Hash:
#
# :SSLCertificate ::
# An instance of OpenSSL::X509::Certificate. If this is not provided,
# then a generic X509 is generated, with a correspond :SSLPrivateKey
#
# :SSLPrivateKey ::
# A private key instance, like OpenSSL::PKey::RSA. This key must be
# the key that signed the :SSLCertificate
#
# :SSLClientCA ::
# An OpenSSL::X509::Certificate, or Array of certificates that will
# used as ClientCAs in the SSL Context
#
# :SSLCACertificatePath ::
# A path to the directory of CA certificates. The certificates must
# be in PEM format.
#
# :SSLCACertificateFile ::
# A path to a CA certificate file, in PEM format.
#
# :SSLTmpDhCallback ::
# A DH callback. See OpenSSL::SSL::SSLContext.tmp_dh_callback
#
# :SSLMinVersion ::
# This is the minimum SSL version to allow. See
# OpenSSL::SSL::SSLContext#min_version=.
#
# :SSLMaxVersion ::
# This is the maximum SSL version to allow. See
# OpenSSL::SSL::SSLContext#max_version=.
#
# :SSLVerifyMode ::
# This is the SSL verification mode. See OpenSSL::SSL::VERIFY_* for
# available modes. The default is OpenSSL::SSL::VERIFY_NONE
#
# :SSLVerifyDepth ::
# Number of CA certificates to walk, when verifying a certificate
# chain.
#
# :SSLVerifyCallback ::
# A callback to be used for additional verification. See
# OpenSSL::SSL::SSLContext.verify_callback
#
# :SSLCertificateStore ::
# A OpenSSL::X509::Store used for verification of certificates
#
# :SSLCertName ::
# Issuer name for the certificate. This is required when generating
# the certificate (if :SSLCertificate and :SSLPrivateKey were not
# given). The value of this is to be an Array of pairs:
#
# [["C", "Raleigh"], ["ST","North Carolina"],
# ["CN","fqdn.example.com"]]
#
# See also OpenSSL::X509::Name
#
# :SSLCertComment ::
# A comment to be used for generating the certificate. The default is
# "Generated by Ruby/OpenSSL"
#
#
# === Example
#
# These values can be added after the fact, like a Hash.
#
# require 'drb/ssl'
# c = DRb::DRbSSLSocket::SSLConfig.new {}
# c[:SSLCertificate] =
# OpenSSL::X509::Certificate.new(File.read('mycert.crt'))
# c[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(File.read('mycert.key'))
# c[:SSLVerifyMode] = OpenSSL::SSL::VERIFY_PEER
# c[:SSLCACertificatePath] = "/etc/ssl/certs/"
# c.setup_certificate
#
# or
#
# require 'drb/ssl'
# c = DRb::DRbSSLSocket::SSLConfig.new({
# :SSLCertName => [["CN" => DRb::DRbSSLSocket.getservername]]
# })
# c.setup_certificate
#
def initialize(config)
@config = config
@cert = config[:SSLCertificate]
@pkey = config[:SSLPrivateKey]
@ssl_ctx = nil
end
# A convenience method to access the values like a Hash
def [](key);
@config[key] || DEFAULT[key]
end
# Connect to IO +tcp+, with context of the current certificate
# configuration
def connect(tcp)
ssl = ::OpenSSL::SSL::SSLSocket.new(tcp, @ssl_ctx)
ssl.sync = true
ssl.connect
ssl
end
# Accept connection to IO +tcp+, with context of the current certificate
# configuration
def accept(tcp)
ssl = OpenSSL::SSL::SSLSocket.new(tcp, @ssl_ctx)
ssl.sync = true
ssl.accept
ssl
end
# Ensures that :SSLCertificate and :SSLPrivateKey have been provided
# or that a new certificate is generated with the other parameters
# provided.
def setup_certificate
if @cert && @pkey
return
end
rsa = OpenSSL::PKey::RSA.new(2048){|p, n|
next unless self[:verbose]
case p
when 0; $stderr.putc "." # BN_generate_prime
when 1; $stderr.putc "+" # BN_generate_prime
when 2; $stderr.putc "*" # searching good prime,
# n = #of try,
# but also data from BN_generate_prime
when 3; $stderr.putc "\n" # found good prime, n==0 - p, n==1 - q,
# but also data from BN_generate_prime
else; $stderr.putc "*" # BN_generate_prime
end
}
cert = OpenSSL::X509::Certificate.new
cert.version = 3
cert.serial = 0
name = OpenSSL::X509::Name.new(self[:SSLCertName])
cert.subject = name
cert.issuer = name
cert.not_before = Time.now
cert.not_after = Time.now + (365*24*60*60)
cert.public_key = rsa.public_key
ef = OpenSSL::X509::ExtensionFactory.new(nil,cert)
cert.extensions = [
ef.create_extension("basicConstraints","CA:FALSE"),
ef.create_extension("subjectKeyIdentifier", "hash") ]
ef.issuer_certificate = cert
cert.add_extension(ef.create_extension("authorityKeyIdentifier",
"keyid:always,issuer:always"))
if comment = self[:SSLCertComment]
cert.add_extension(ef.create_extension("nsComment", comment))
end
cert.sign(rsa, "SHA256")
@cert = cert
@pkey = rsa
end
# Establish the OpenSSL::SSL::SSLContext with the configuration
# parameters provided.
def setup_ssl_context
ctx = ::OpenSSL::SSL::SSLContext.new
ctx.cert = @cert
ctx.key = @pkey
ctx.min_version = self[:SSLMinVersion]
ctx.max_version = self[:SSLMaxVersion]
ctx.client_ca = self[:SSLClientCA]
ctx.ca_path = self[:SSLCACertificatePath]
ctx.ca_file = self[:SSLCACertificateFile]
ctx.tmp_dh_callback = self[:SSLTmpDhCallback]
ctx.verify_mode = self[:SSLVerifyMode]
ctx.verify_depth = self[:SSLVerifyDepth]
ctx.verify_callback = self[:SSLVerifyCallback]
ctx.cert_store = self[:SSLCertificateStore]
@ssl_ctx = ctx
end
end
# Parse the dRuby +uri+ for an SSL connection.
#
# Expects drbssl://...
#
# Raises DRbBadScheme or DRbBadURI if +uri+ is not matching or malformed
def self.parse_uri(uri) # :nodoc:
if /\Adrbssl:\/\/(.*?):(\d+)(\?(.*))?\z/ =~ uri
host = $1
port = $2.to_i
option = $4
[host, port, option]
else
raise(DRbBadScheme, uri) unless uri.start_with?('drbssl:')
raise(DRbBadURI, 'can\'t parse uri:' + uri)
end
end
# Return an DRb::DRbSSLSocket instance as a client-side connection,
# with the SSL connected. This is called from DRb::start_service or while
# connecting to a remote object:
#
# DRb.start_service 'drbssl://localhost:0', front, config
#
# +uri+ is the URI we are connected to,
# <code>'drbssl://localhost:0'</code> above, +config+ is our
# configuration. Either a Hash or DRb::DRbSSLSocket::SSLConfig
def self.open(uri, config)
host, port, = parse_uri(uri)
soc = TCPSocket.open(host, port)
ssl_conf = SSLConfig::new(config)
ssl_conf.setup_ssl_context
ssl = ssl_conf.connect(soc)
self.new(uri, ssl, ssl_conf, true)
end
# Returns a DRb::DRbSSLSocket instance as a server-side connection, with
# the SSL connected. This is called from DRb::start_service or while
# connecting to a remote object:
#
# DRb.start_service 'drbssl://localhost:0', front, config
#
# +uri+ is the URI we are connected to,
# <code>'drbssl://localhost:0'</code> above, +config+ is our
# configuration. Either a Hash or DRb::DRbSSLSocket::SSLConfig
def self.open_server(uri, config)
uri = 'drbssl://:0' unless uri
host, port, = parse_uri(uri)
if host.size == 0
host = getservername
soc = open_server_inaddr_any(host, port)
else
soc = TCPServer.open(host, port)
end
port = soc.addr[1] if port == 0
@uri = "drbssl://#{host}:#{port}"
ssl_conf = SSLConfig.new(config)
ssl_conf.setup_certificate
ssl_conf.setup_ssl_context
self.new(@uri, soc, ssl_conf, false)
end
# This is a convenience method to parse +uri+ and separate out any
# additional options appended in the +uri+.
#
# Returns an option-less uri and the option => [uri,option]
#
# The +config+ is completely unused, so passing nil is sufficient.
def self.uri_option(uri, config) # :nodoc:
host, port, option = parse_uri(uri)
return "drbssl://#{host}:#{port}", option
end
# Create a DRb::DRbSSLSocket instance.
#
# +uri+ is the URI we are connected to.
# +soc+ is the tcp socket we are bound to.
# +config+ is our configuration. Either a Hash or SSLConfig
# +is_established+ is a boolean of whether +soc+ is currently established
#
# This is called automatically based on the DRb protocol.
def initialize(uri, soc, config, is_established)
@ssl = is_established ? soc : nil
super(uri, soc.to_io, config)
end
# Returns the SSL stream
def stream; @ssl; end # :nodoc:
# Closes the SSL stream before closing the dRuby connection.
def close # :nodoc:
if @ssl
@ssl.close
@ssl = nil
end
super
end
def accept # :nodoc:
begin
while true
soc = accept_or_shutdown
return nil unless soc
break if (@acl ? @acl.allow_socket?(soc) : true)
soc.close
end
begin
ssl = @config.accept(soc)
rescue Exception
soc.close
raise
end
self.class.new(uri, ssl, @config, true)
rescue OpenSSL::SSL::SSLError
warn("#{$!.message} (#{$!.class})", uplevel: 0) if @config[:verbose]
retry
end
end
end
DRbProtocol.add_protocol(DRbSSLSocket)
end
share/ruby/drb/observer.rb 0000644 00000001237 15173517735 0011573 0 ustar 00 # frozen_string_literal: false
require 'observer'
module DRb
# The Observable module extended to DRb. See Observable for details.
module DRbObservable
include Observable
# Notifies observers of a change in state. See also
# Observable#notify_observers
def notify_observers(*arg)
if defined? @observer_state and @observer_state
if defined? @observer_peers
@observer_peers.each do |observer, method|
begin
observer.__send__(method, *arg)
rescue
delete_observer(observer)
end
end
end
@observer_state = false
end
end
end
end
share/ruby/drb/gw.rb 0000644 00000006005 15173517735 0010357 0 ustar 00 # frozen_string_literal: false
require_relative 'drb'
require 'monitor'
module DRb
# Gateway id conversion forms a gateway between different DRb protocols or
# networks.
#
# The gateway needs to install this id conversion and create servers for
# each of the protocols or networks it will be a gateway between. It then
# needs to create a server that attaches to each of these networks. For
# example:
#
# require 'drb/drb'
# require 'drb/unix'
# require 'drb/gw'
#
# DRb.install_id_conv DRb::GWIdConv.new
# gw = DRb::GW.new
# s1 = DRb::DRbServer.new 'drbunix:/path/to/gateway', gw
# s2 = DRb::DRbServer.new 'druby://example:10000', gw
#
# s1.thread.join
# s2.thread.join
#
# Each client must register services with the gateway, for example:
#
# DRb.start_service 'drbunix:', nil # an anonymous server
# gw = DRbObject.new nil, 'drbunix:/path/to/gateway'
# gw[:unix] = some_service
# DRb.thread.join
class GWIdConv < DRbIdConv
def to_obj(ref) # :nodoc:
if Array === ref && ref[0] == :DRbObject
return DRbObject.new_with(ref[1], ref[2])
end
super(ref)
end
end
# The GW provides a synchronized store for participants in the gateway to
# communicate.
class GW
include MonitorMixin
# Creates a new GW
def initialize
super()
@hash = {}
end
# Retrieves +key+ from the GW
def [](key)
synchronize do
@hash[key]
end
end
# Stores value +v+ at +key+ in the GW
def []=(key, v)
synchronize do
@hash[key] = v
end
end
end
class DRbObject # :nodoc:
def self._load(s)
uri, ref = Marshal.load(s)
if DRb.uri == uri
return ref ? DRb.to_obj(ref) : DRb.front
end
self.new_with(DRb.uri, [:DRbObject, uri, ref])
end
def _dump(lv)
if DRb.uri == @uri
if Array === @ref && @ref[0] == :DRbObject
Marshal.dump([@ref[1], @ref[2]])
else
Marshal.dump([@uri, @ref]) # ??
end
else
Marshal.dump([DRb.uri, [:DRbObject, @uri, @ref]])
end
end
end
end
=begin
DRb.install_id_conv(DRb::GWIdConv.new)
front = DRb::GW.new
s1 = DRb::DRbServer.new('drbunix:/tmp/gw_b_a', front)
s2 = DRb::DRbServer.new('drbunix:/tmp/gw_b_c', front)
s1.thread.join
s2.thread.join
=end
=begin
# foo.rb
require 'drb/drb'
class Foo
include DRbUndumped
def initialize(name, peer=nil)
@name = name
@peer = peer
end
def ping(obj)
puts "#{@name}: ping: #{obj.inspect}"
@peer.ping(self) if @peer
end
end
=end
=begin
# gw_a.rb
require 'drb/unix'
require 'foo'
obj = Foo.new('a')
DRb.start_service("drbunix:/tmp/gw_a", obj)
robj = DRbObject.new_with_uri('drbunix:/tmp/gw_b_a')
robj[:a] = obj
DRb.thread.join
=end
=begin
# gw_c.rb
require 'drb/unix'
require 'foo'
foo = Foo.new('c', nil)
DRb.start_service("drbunix:/tmp/gw_c", nil)
robj = DRbObject.new_with_uri("drbunix:/tmp/gw_b_c")
puts "c->b"
a = robj[:a]
sleep 2
a.ping(foo)
DRb.thread.join
=end
share/ruby/drb/extserv.rb 0000644 00000001510 15173517735 0011436 0 ustar 00 # frozen_string_literal: false
=begin
external service
Copyright (c) 2000,2002 Masatoshi SEKI
=end
require_relative 'drb'
require 'monitor'
module DRb
class ExtServ
include MonitorMixin
include DRbUndumped
def initialize(there, name, server=nil)
super()
@server = server || DRb::primary_server
@name = name
ro = DRbObject.new(nil, there)
synchronize do
@invoker = ro.register(name, DRbObject.new(self, @server.uri))
end
end
attr_reader :server
def front
DRbObject.new(nil, @server.uri)
end
def stop_service
synchronize do
@invoker.unregister(@name)
server = @server
@server = nil
server.stop_service
true
end
end
def alive?
@server ? @server.alive? : false
end
end
end
share/ruby/drb/extservm.rb 0000644 00000003467 15173517735 0011630 0 ustar 00 # frozen_string_literal: false
=begin
external service manager
Copyright (c) 2000 Masatoshi SEKI
=end
require_relative 'drb'
require 'monitor'
module DRb
class ExtServManager
include DRbUndumped
include MonitorMixin
@@command = {}
def self.command
@@command
end
def self.command=(cmd)
@@command = cmd
end
def initialize
super()
@cond = new_cond
@servers = {}
@waiting = []
@queue = Thread::Queue.new
@thread = invoke_thread
@uri = nil
end
attr_accessor :uri
def service(name)
synchronize do
while true
server = @servers[name]
return server if server && server.alive? # server may be `false'
invoke_service(name)
@cond.wait
end
end
end
def register(name, ro)
synchronize do
@servers[name] = ro
@cond.signal
end
self
end
alias regist register
def unregister(name)
synchronize do
@servers.delete(name)
end
end
alias unregist unregister
private
def invoke_thread
Thread.new do
while name = @queue.pop
invoke_service_command(name, @@command[name])
end
end
end
def invoke_service(name)
@queue.push(name)
end
def invoke_service_command(name, command)
raise "invalid command. name: #{name}" unless command
synchronize do
return if @servers.include?(name)
@servers[name] = false
end
uri = @uri || DRb.uri
if command.respond_to? :to_ary
command = command.to_ary + [uri, name]
pid = spawn(*command)
else
pid = spawn("#{command} #{uri} #{name}")
end
th = Process.detach(pid)
th[:drb_service] = name
th
end
end
end
share/ruby/drb/unix.rb 0000644 00000005433 15173517735 0010731 0 ustar 00 # frozen_string_literal: false
require 'socket'
require_relative 'drb'
require 'tmpdir'
raise(LoadError, "UNIXServer is required") unless defined?(UNIXServer)
module DRb
# Implements DRb over a UNIX socket
#
# DRb UNIX socket URIs look like <code>drbunix:<path>?<option></code>. The
# option is optional.
class DRbUNIXSocket < DRbTCPSocket
# :stopdoc:
def self.parse_uri(uri)
if /\Adrbunix:(.*?)(\?(.*))?\z/ =~ uri
filename = $1
option = $3
[filename, option]
else
raise(DRbBadScheme, uri) unless uri.start_with?('drbunix:')
raise(DRbBadURI, 'can\'t parse uri:' + uri)
end
end
def self.open(uri, config)
filename, = parse_uri(uri)
soc = UNIXSocket.open(filename)
self.new(uri, soc, config)
end
def self.open_server(uri, config)
filename, = parse_uri(uri)
if filename.size == 0
soc = temp_server
filename = soc.path
uri = 'drbunix:' + soc.path
else
soc = UNIXServer.open(filename)
end
owner = config[:UNIXFileOwner]
group = config[:UNIXFileGroup]
if owner || group
require 'etc'
owner = Etc.getpwnam( owner ).uid if owner
group = Etc.getgrnam( group ).gid if group
File.chown owner, group, filename
end
mode = config[:UNIXFileMode]
File.chmod(mode, filename) if mode
self.new(uri, soc, config, true)
end
def self.uri_option(uri, config)
filename, option = parse_uri(uri)
return "drbunix:#{filename}", option
end
def initialize(uri, soc, config={}, server_mode = false)
super(uri, soc, config)
set_sockopt(@socket)
@server_mode = server_mode
@acl = nil
end
# import from tempfile.rb
Max_try = 10
private
def self.temp_server
tmpdir = Dir::tmpdir
n = 0
while true
begin
tmpname = sprintf('%s/druby%d.%d', tmpdir, $$, n)
lock = tmpname + '.lock'
unless File.exist?(tmpname) or File.exist?(lock)
Dir.mkdir(lock)
break
end
rescue
raise "cannot generate tempfile `%s'" % tmpname if n >= Max_try
#sleep(1)
end
n += 1
end
soc = UNIXServer.new(tmpname)
Dir.rmdir(lock)
soc
end
public
def close
return unless @socket
shutdown # DRbProtocol#shutdown
path = @socket.path if @server_mode
@socket.close
File.unlink(path) if @server_mode
@socket = nil
close_shutdown_pipe
end
def accept
s = accept_or_shutdown
return nil unless s
self.class.new(nil, s, @config)
end
def set_sockopt(soc)
# no-op for now
end
end
DRbProtocol.add_protocol(DRbUNIXSocket)
# :startdoc:
end
share/ruby/drb/weakidconv.rb 0000644 00000002175 15173517735 0012100 0 ustar 00 # frozen_string_literal: false
require_relative 'drb'
require 'monitor'
module DRb
# To use WeakIdConv:
#
# DRb.start_service(nil, nil, {:idconv => DRb::WeakIdConv.new})
class WeakIdConv < DRbIdConv
class WeakSet
include MonitorMixin
def initialize
super()
@immutable = {}
@map = ObjectSpace::WeakMap.new
end
def add(obj)
synchronize do
begin
@map[obj] = self
rescue ArgumentError
@immutable[obj.__id__] = obj
end
return obj.__id__
end
end
def fetch(ref)
synchronize do
@immutable.fetch(ref) {
@map.each { |key, _|
return key if key.__id__ == ref
}
raise RangeError.new("invalid reference")
}
end
end
end
def initialize()
super()
@weak_set = WeakSet.new
end
def to_obj(ref) # :nodoc:
return super if ref.nil?
@weak_set.fetch(ref)
end
def to_id(obj) # :nodoc:
return @weak_set.add(obj)
end
end
end
# DRb.install_id_conv(WeakIdConv.new)
share/ruby/drb/version.rb 0000644 00000000043 15173517736 0011424 0 ustar 00 module DRb
VERSION = "2.2.0"
end
share/ruby/drb/invokemethod.rb 0000644 00000001411 15173517736 0012433 0 ustar 00 # frozen_string_literal: false
# for ruby-1.8.0
module DRb # :nodoc: all
class DRbServer
module InvokeMethod18Mixin
def block_yield(x)
if x.size == 1 && x[0].class == Array
x[0] = DRbArray.new(x[0])
end
@block.call(*x)
end
def perform_with_block
@obj.__send__(@msg_id, *@argv) do |*x|
jump_error = nil
begin
block_value = block_yield(x)
rescue LocalJumpError
jump_error = $!
end
if jump_error
case jump_error.reason
when :break
break(jump_error.exit_value)
else
raise jump_error
end
end
block_value
end
end
end
end
end
share/ruby/drb/drb.rb 0000644 00000163200 15173517736 0010513 0 ustar 00 # frozen_string_literal: false
#
# = drb/drb.rb
#
# Distributed Ruby: _dRuby_
#
# Copyright (c) 1999-2003 Masatoshi SEKI. You can redistribute it and/or
# modify it under the same terms as Ruby.
#
# Author:: Masatoshi SEKI
#
# Documentation:: William Webber (william@williamwebber.com)
#
# == Overview
#
# dRuby is a distributed object system for Ruby. It allows an object in one
# Ruby process to invoke methods on an object in another Ruby process on the
# same or a different machine.
#
# The Ruby standard library contains the core classes of the dRuby package.
# However, the full package also includes access control lists and the
# Rinda tuple-space distributed task management system, as well as a
# large number of samples. The full dRuby package can be downloaded from
# the dRuby home page (see *References*).
#
# For an introduction and examples of usage see the documentation to the
# DRb module.
#
# == References
#
# [http://www2a.biglobe.ne.jp/~seki/ruby/druby.html]
# The dRuby home page, in Japanese. Contains the full dRuby package
# and links to other Japanese-language sources.
#
# [http://www2a.biglobe.ne.jp/~seki/ruby/druby.en.html]
# The English version of the dRuby home page.
#
# [http://pragprog.com/book/sidruby/the-druby-book]
# The dRuby Book: Distributed and Parallel Computing with Ruby
# by Masatoshi Seki and Makoto Inoue
#
# [http://www.ruby-doc.org/docs/ProgrammingRuby/html/ospace.html]
# The chapter from *Programming* *Ruby* by Dave Thomas and Andy Hunt
# which discusses dRuby.
#
# [http://www.clio.ne.jp/home/web-i31s/Flotuard/Ruby/PRC2K_seki/dRuby.en.html]
# Translation of presentation on Ruby by Masatoshi Seki.
require 'socket'
require 'io/wait'
require 'monitor'
require_relative 'eq'
require_relative 'version'
#
# == Overview
#
# dRuby is a distributed object system for Ruby. It is written in
# pure Ruby and uses its own protocol. No add-in services are needed
# beyond those provided by the Ruby runtime, such as TCP sockets. It
# does not rely on or interoperate with other distributed object
# systems such as CORBA, RMI, or .NET.
#
# dRuby allows methods to be called in one Ruby process upon a Ruby
# object located in another Ruby process, even on another machine.
# References to objects can be passed between processes. Method
# arguments and return values are dumped and loaded in marshalled
# format. All of this is done transparently to both the caller of the
# remote method and the object that it is called upon.
#
# An object in a remote process is locally represented by a
# DRb::DRbObject instance. This acts as a sort of proxy for the
# remote object. Methods called upon this DRbObject instance are
# forwarded to its remote object. This is arranged dynamically at run
# time. There are no statically declared interfaces for remote
# objects, such as CORBA's IDL.
#
# dRuby calls made into a process are handled by a DRb::DRbServer
# instance within that process. This reconstitutes the method call,
# invokes it upon the specified local object, and returns the value to
# the remote caller. Any object can receive calls over dRuby. There
# is no need to implement a special interface, or mixin special
# functionality. Nor, in the general case, does an object need to
# explicitly register itself with a DRbServer in order to receive
# dRuby calls.
#
# One process wishing to make dRuby calls upon another process must
# somehow obtain an initial reference to an object in the remote
# process by some means other than as the return value of a remote
# method call, as there is initially no remote object reference it can
# invoke a method upon. This is done by attaching to the server by
# URI. Each DRbServer binds itself to a URI such as
# 'druby://example.com:8787'. A DRbServer can have an object attached
# to it that acts as the server's *front* *object*. A DRbObject can
# be explicitly created from the server's URI. This DRbObject's
# remote object will be the server's front object. This front object
# can then return references to other Ruby objects in the DRbServer's
# process.
#
# Method calls made over dRuby behave largely the same as normal Ruby
# method calls made within a process. Method calls with blocks are
# supported, as are raising exceptions. In addition to a method's
# standard errors, a dRuby call may also raise one of the
# dRuby-specific errors, all of which are subclasses of DRb::DRbError.
#
# Any type of object can be passed as an argument to a dRuby call or
# returned as its return value. By default, such objects are dumped
# or marshalled at the local end, then loaded or unmarshalled at the
# remote end. The remote end therefore receives a copy of the local
# object, not a distributed reference to it; methods invoked upon this
# copy are executed entirely in the remote process, not passed on to
# the local original. This has semantics similar to pass-by-value.
#
# However, if an object cannot be marshalled, a dRuby reference to it
# is passed or returned instead. This will turn up at the remote end
# as a DRbObject instance. All methods invoked upon this remote proxy
# are forwarded to the local object, as described in the discussion of
# DRbObjects. This has semantics similar to the normal Ruby
# pass-by-reference.
#
# The easiest way to signal that we want an otherwise marshallable
# object to be passed or returned as a DRbObject reference, rather
# than marshalled and sent as a copy, is to include the
# DRb::DRbUndumped mixin module.
#
# dRuby supports calling remote methods with blocks. As blocks (or
# rather the Proc objects that represent them) are not marshallable,
# the block executes in the local, not the remote, context. Each
# value yielded to the block is passed from the remote object to the
# local block, then the value returned by each block invocation is
# passed back to the remote execution context to be collected, before
# the collected values are finally returned to the local context as
# the return value of the method invocation.
#
# == Examples of usage
#
# For more dRuby samples, see the +samples+ directory in the full
# dRuby distribution.
#
# === dRuby in client/server mode
#
# This illustrates setting up a simple client-server drb
# system. Run the server and client code in different terminals,
# starting the server code first.
#
# ==== Server code
#
# require 'drb/drb'
#
# # The URI for the server to connect to
# URI="druby://localhost:8787"
#
# class TimeServer
#
# def get_current_time
# return Time.now
# end
#
# end
#
# # The object that handles requests on the server
# FRONT_OBJECT=TimeServer.new
#
# DRb.start_service(URI, FRONT_OBJECT)
# # Wait for the drb server thread to finish before exiting.
# DRb.thread.join
#
# ==== Client code
#
# require 'drb/drb'
#
# # The URI to connect to
# SERVER_URI="druby://localhost:8787"
#
# # Start a local DRbServer to handle callbacks.
# #
# # Not necessary for this small example, but will be required
# # as soon as we pass a non-marshallable object as an argument
# # to a dRuby call.
# #
# # Note: this must be called at least once per process to take any effect.
# # This is particularly important if your application forks.
# DRb.start_service
#
# timeserver = DRbObject.new_with_uri(SERVER_URI)
# puts timeserver.get_current_time
#
# === Remote objects under dRuby
#
# This example illustrates returning a reference to an object
# from a dRuby call. The Logger instances live in the server
# process. References to them are returned to the client process,
# where methods can be invoked upon them. These methods are
# executed in the server process.
#
# ==== Server code
#
# require 'drb/drb'
#
# URI="druby://localhost:8787"
#
# class Logger
#
# # Make dRuby send Logger instances as dRuby references,
# # not copies.
# include DRb::DRbUndumped
#
# def initialize(n, fname)
# @name = n
# @filename = fname
# end
#
# def log(message)
# File.open(@filename, "a") do |f|
# f.puts("#{Time.now}: #{@name}: #{message}")
# end
# end
#
# end
#
# # We have a central object for creating and retrieving loggers.
# # This retains a local reference to all loggers created. This
# # is so an existing logger can be looked up by name, but also
# # to prevent loggers from being garbage collected. A dRuby
# # reference to an object is not sufficient to prevent it being
# # garbage collected!
# class LoggerFactory
#
# def initialize(bdir)
# @basedir = bdir
# @loggers = {}
# end
#
# def get_logger(name)
# if !@loggers.has_key? name
# # make the filename safe, then declare it to be so
# fname = name.gsub(/[.\/\\\:]/, "_")
# @loggers[name] = Logger.new(name, @basedir + "/" + fname)
# end
# return @loggers[name]
# end
#
# end
#
# FRONT_OBJECT=LoggerFactory.new("/tmp/dlog")
#
# DRb.start_service(URI, FRONT_OBJECT)
# DRb.thread.join
#
# ==== Client code
#
# require 'drb/drb'
#
# SERVER_URI="druby://localhost:8787"
#
# DRb.start_service
#
# log_service=DRbObject.new_with_uri(SERVER_URI)
#
# ["loga", "logb", "logc"].each do |logname|
#
# logger=log_service.get_logger(logname)
#
# logger.log("Hello, world!")
# logger.log("Goodbye, world!")
# logger.log("=== EOT ===")
#
# end
#
# == Security
#
# As with all network services, security needs to be considered when
# using dRuby. By allowing external access to a Ruby object, you are
# not only allowing outside clients to call the methods you have
# defined for that object, but by default to execute arbitrary Ruby
# code on your server. Consider the following:
#
# # !!! UNSAFE CODE !!!
# ro = DRbObject::new_with_uri("druby://your.server.com:8989")
# class << ro
# undef :instance_eval # force call to be passed to remote object
# end
# ro.instance_eval("`rm -rf *`")
#
# The dangers posed by instance_eval and friends are such that a
# DRbServer should only be used when clients are trusted.
#
# A DRbServer can be configured with an access control list to
# selectively allow or deny access from specified IP addresses. The
# main druby distribution provides the ACL class for this purpose. In
# general, this mechanism should only be used alongside, rather than
# as a replacement for, a good firewall.
#
# == dRuby internals
#
# dRuby is implemented using three main components: a remote method
# call marshaller/unmarshaller; a transport protocol; and an
# ID-to-object mapper. The latter two can be directly, and the first
# indirectly, replaced, in order to provide different behaviour and
# capabilities.
#
# Marshalling and unmarshalling of remote method calls is performed by
# a DRb::DRbMessage instance. This uses the Marshal module to dump
# the method call before sending it over the transport layer, then
# reconstitute it at the other end. There is normally no need to
# replace this component, and no direct way is provided to do so.
# However, it is possible to implement an alternative marshalling
# scheme as part of an implementation of the transport layer.
#
# The transport layer is responsible for opening client and server
# network connections and forwarding dRuby request across them.
# Normally, it uses DRb::DRbMessage internally to manage marshalling
# and unmarshalling. The transport layer is managed by
# DRb::DRbProtocol. Multiple protocols can be installed in
# DRbProtocol at the one time; selection between them is determined by
# the scheme of a dRuby URI. The default transport protocol is
# selected by the scheme 'druby:', and implemented by
# DRb::DRbTCPSocket. This uses plain TCP/IP sockets for
# communication. An alternative protocol, using UNIX domain sockets,
# is implemented by DRb::DRbUNIXSocket in the file drb/unix.rb, and
# selected by the scheme 'drbunix:'. A sample implementation over
# HTTP can be found in the samples accompanying the main dRuby
# distribution.
#
# The ID-to-object mapping component maps dRuby object ids to the
# objects they refer to, and vice versa. The implementation to use
# can be specified as part of a DRb::DRbServer's configuration. The
# default implementation is provided by DRb::DRbIdConv. It uses an
# object's ObjectSpace id as its dRuby id. This means that the dRuby
# reference to that object only remains meaningful for the lifetime of
# the object's process and the lifetime of the object within that
# process. A modified implementation is provided by DRb::TimerIdConv
# in the file drb/timeridconv.rb. This implementation retains a local
# reference to all objects exported over dRuby for a configurable
# period of time (defaulting to ten minutes), to prevent them being
# garbage-collected within this time. Another sample implementation
# is provided in sample/name.rb in the main dRuby distribution. This
# allows objects to specify their own id or "name". A dRuby reference
# can be made persistent across processes by having each process
# register an object using the same dRuby name.
#
module DRb
# Superclass of all errors raised in the DRb module.
class DRbError < RuntimeError; end
# Error raised when an error occurs on the underlying communication
# protocol.
class DRbConnError < DRbError; end
# Class responsible for converting between an object and its id.
#
# This, the default implementation, uses an object's local ObjectSpace
# __id__ as its id. This means that an object's identification over
# drb remains valid only while that object instance remains alive
# within the server runtime.
#
# For alternative mechanisms, see DRb::TimerIdConv in drb/timeridconv.rb
# and DRbNameIdConv in sample/name.rb in the full drb distribution.
class DRbIdConv
# Convert an object reference id to an object.
#
# This implementation looks up the reference id in the local object
# space and returns the object it refers to.
def to_obj(ref)
ObjectSpace._id2ref(ref)
end
# Convert an object into a reference id.
#
# This implementation returns the object's __id__ in the local
# object space.
def to_id(obj)
case obj
when Object
obj.nil? ? nil : obj.__id__
when BasicObject
obj.__id__
end
end
end
# Mixin module making an object undumpable or unmarshallable.
#
# If an object which includes this module is returned by method
# called over drb, then the object remains in the server space
# and a reference to the object is returned, rather than the
# object being marshalled and moved into the client space.
module DRbUndumped
def _dump(dummy) # :nodoc:
raise TypeError, 'can\'t dump'
end
end
# Error raised by the DRb module when an attempt is made to refer to
# the context's current drb server but the context does not have one.
# See #current_server.
class DRbServerNotFound < DRbError; end
# Error raised by the DRbProtocol module when it cannot find any
# protocol implementation support the scheme specified in a URI.
class DRbBadURI < DRbError; end
# Error raised by a dRuby protocol when it doesn't support the
# scheme specified in a URI. See DRb::DRbProtocol.
class DRbBadScheme < DRbError; end
# An exception wrapping a DRb::DRbUnknown object
class DRbUnknownError < DRbError
# Create a new DRbUnknownError for the DRb::DRbUnknown object +unknown+
def initialize(unknown)
@unknown = unknown
super(unknown.name)
end
# Get the wrapped DRb::DRbUnknown object.
attr_reader :unknown
def self._load(s) # :nodoc:
Marshal::load(s)
end
def _dump(lv) # :nodoc:
Marshal::dump(@unknown)
end
end
# An exception wrapping an error object
class DRbRemoteError < DRbError
# Creates a new remote error that wraps the Exception +error+
def initialize(error)
@reason = error.class.to_s
super("#{error.message} (#{error.class})")
set_backtrace(error.backtrace)
end
# the class of the error, as a string.
attr_reader :reason
end
# Class wrapping a marshalled object whose type is unknown locally.
#
# If an object is returned by a method invoked over drb, but the
# class of the object is unknown in the client namespace, or
# the object is a constant unknown in the client namespace, then
# the still-marshalled object is returned wrapped in a DRbUnknown instance.
#
# If this object is passed as an argument to a method invoked over
# drb, then the wrapped object is passed instead.
#
# The class or constant name of the object can be read from the
# +name+ attribute. The marshalled object is held in the +buf+
# attribute.
class DRbUnknown
# Create a new DRbUnknown object.
#
# +buf+ is a string containing a marshalled object that could not
# be unmarshalled. +err+ is the error message that was raised
# when the unmarshalling failed. It is used to determine the
# name of the unmarshalled object.
def initialize(err, buf)
case err.to_s
when /uninitialized constant (\S+)/
@name = $1
when /undefined class\/module (\S+)/
@name = $1
else
@name = nil
end
@buf = buf
end
# The name of the unknown thing.
#
# Class name for unknown objects; variable name for unknown
# constants.
attr_reader :name
# Buffer contained the marshalled, unknown object.
attr_reader :buf
def self._load(s) # :nodoc:
begin
Marshal::load(s)
rescue NameError, ArgumentError
DRbUnknown.new($!, s)
end
end
def _dump(lv) # :nodoc:
@buf
end
# Attempt to load the wrapped marshalled object again.
#
# If the class of the object is now known locally, the object
# will be unmarshalled and returned. Otherwise, a new
# but identical DRbUnknown object will be returned.
def reload
self.class._load(@buf)
end
# Create a DRbUnknownError exception containing this object.
def exception
DRbUnknownError.new(self)
end
end
# An Array wrapper that can be sent to another server via DRb.
#
# All entries in the array will be dumped or be references that point to
# the local server.
class DRbArray
# Creates a new DRbArray that either dumps or wraps all the items in the
# Array +ary+ so they can be loaded by a remote DRb server.
def initialize(ary)
@ary = ary.collect { |obj|
if obj.kind_of? DRbUndumped
DRbObject.new(obj)
else
begin
Marshal.dump(obj)
obj
rescue
DRbObject.new(obj)
end
end
}
end
def self._load(s) # :nodoc:
Marshal::load(s)
end
def _dump(lv) # :nodoc:
Marshal.dump(@ary)
end
end
# Handler for sending and receiving drb messages.
#
# This takes care of the low-level marshalling and unmarshalling
# of drb requests and responses sent over the wire between server
# and client. This relieves the implementor of a new drb
# protocol layer with having to deal with these details.
#
# The user does not have to directly deal with this object in
# normal use.
class DRbMessage
def initialize(config) # :nodoc:
@load_limit = config[:load_limit]
@argc_limit = config[:argc_limit]
end
def dump(obj, error=false) # :nodoc:
case obj
when DRbUndumped
obj = make_proxy(obj, error)
when Object
# nothing
else
obj = make_proxy(obj, error)
end
begin
str = Marshal::dump(obj)
rescue
str = Marshal::dump(make_proxy(obj, error))
end
[str.size].pack('N') + str
end
def load(soc) # :nodoc:
begin
sz = soc.read(4) # sizeof (N)
rescue
raise(DRbConnError, $!.message, $!.backtrace)
end
raise(DRbConnError, 'connection closed') if sz.nil?
raise(DRbConnError, 'premature header') if sz.size < 4
sz = sz.unpack('N')[0]
raise(DRbConnError, "too large packet #{sz}") if @load_limit < sz
begin
str = soc.read(sz)
rescue
raise(DRbConnError, $!.message, $!.backtrace)
end
raise(DRbConnError, 'connection closed') if str.nil?
raise(DRbConnError, 'premature marshal format(can\'t read)') if str.size < sz
DRb.mutex.synchronize do
begin
Marshal::load(str)
rescue NameError, ArgumentError
DRbUnknown.new($!, str)
end
end
end
def send_request(stream, ref, msg_id, arg, b) # :nodoc:
ary = []
ary.push(dump(ref.__drbref))
ary.push(dump(msg_id.id2name))
ary.push(dump(arg.length))
arg.each do |e|
ary.push(dump(e))
end
ary.push(dump(b))
stream.write(ary.join(''))
rescue
raise(DRbConnError, $!.message, $!.backtrace)
end
def recv_request(stream) # :nodoc:
ref = load(stream)
ro = DRb.to_obj(ref)
msg = load(stream)
argc = load(stream)
raise(DRbConnError, "too many arguments") if @argc_limit < argc
argv = Array.new(argc, nil)
argc.times do |n|
argv[n] = load(stream)
end
block = load(stream)
return ro, msg, argv, block
end
def send_reply(stream, succ, result) # :nodoc:
stream.write(dump(succ) + dump(result, !succ))
rescue
raise(DRbConnError, $!.message, $!.backtrace)
end
def recv_reply(stream) # :nodoc:
succ = load(stream)
result = load(stream)
[succ, result]
end
private
def make_proxy(obj, error=false) # :nodoc:
if error
DRbRemoteError.new(obj)
else
DRbObject.new(obj)
end
end
end
# Module managing the underlying network protocol(s) used by drb.
#
# By default, drb uses the DRbTCPSocket protocol. Other protocols
# can be defined. A protocol must define the following class methods:
#
# [open(uri, config)] Open a client connection to the server at +uri+,
# using configuration +config+. Return a protocol
# instance for this connection.
# [open_server(uri, config)] Open a server listening at +uri+,
# using configuration +config+. Return a
# protocol instance for this listener.
# [uri_option(uri, config)] Take a URI, possibly containing an option
# component (e.g. a trailing '?param=val'),
# and return a [uri, option] tuple.
#
# All of these methods should raise a DRbBadScheme error if the URI
# does not identify the protocol they support (e.g. "druby:" for
# the standard Ruby protocol). This is how the DRbProtocol module,
# given a URI, determines which protocol implementation serves that
# protocol.
#
# The protocol instance returned by #open_server must have the
# following methods:
#
# [accept] Accept a new connection to the server. Returns a protocol
# instance capable of communicating with the client.
# [close] Close the server connection.
# [uri] Get the URI for this server.
#
# The protocol instance returned by #open must have the following methods:
#
# [send_request (ref, msg_id, arg, b)]
# Send a request to +ref+ with the given message id and arguments.
# This is most easily implemented by calling DRbMessage.send_request,
# providing a stream that sits on top of the current protocol.
# [recv_reply]
# Receive a reply from the server and return it as a [success-boolean,
# reply-value] pair. This is most easily implemented by calling
# DRb.recv_reply, providing a stream that sits on top of the
# current protocol.
# [alive?]
# Is this connection still alive?
# [close]
# Close this connection.
#
# The protocol instance returned by #open_server().accept() must have
# the following methods:
#
# [recv_request]
# Receive a request from the client and return a [object, message,
# args, block] tuple. This is most easily implemented by calling
# DRbMessage.recv_request, providing a stream that sits on top of
# the current protocol.
# [send_reply(succ, result)]
# Send a reply to the client. This is most easily implemented
# by calling DRbMessage.send_reply, providing a stream that sits
# on top of the current protocol.
# [close]
# Close this connection.
#
# A new protocol is registered with the DRbProtocol module using
# the add_protocol method.
#
# For examples of other protocols, see DRbUNIXSocket in drb/unix.rb,
# and HTTP0 in sample/http0.rb and sample/http0serv.rb in the full
# drb distribution.
module DRbProtocol
# Add a new protocol to the DRbProtocol module.
def add_protocol(prot)
@protocol.push(prot)
end
module_function :add_protocol
# Open a client connection to +uri+ with the configuration +config+.
#
# The DRbProtocol module asks each registered protocol in turn to
# try to open the URI. Each protocol signals that it does not handle that
# URI by raising a DRbBadScheme error. If no protocol recognises the
# URI, then a DRbBadURI error is raised. If a protocol accepts the
# URI, but an error occurs in opening it, a DRbConnError is raised.
def open(uri, config, first=true)
@protocol.each do |prot|
begin
return prot.open(uri, config)
rescue DRbBadScheme
rescue DRbConnError
raise($!)
rescue
raise(DRbConnError, "#{uri} - #{$!.inspect}")
end
end
if first && (config[:auto_load] != false)
auto_load(uri)
return open(uri, config, false)
end
raise DRbBadURI, 'can\'t parse uri:' + uri
end
module_function :open
# Open a server listening for connections at +uri+ with
# configuration +config+.
#
# The DRbProtocol module asks each registered protocol in turn to
# try to open a server at the URI. Each protocol signals that it does
# not handle that URI by raising a DRbBadScheme error. If no protocol
# recognises the URI, then a DRbBadURI error is raised. If a protocol
# accepts the URI, but an error occurs in opening it, the underlying
# error is passed on to the caller.
def open_server(uri, config, first=true)
@protocol.each do |prot|
begin
return prot.open_server(uri, config)
rescue DRbBadScheme
end
end
if first && (config[:auto_load] != false)
auto_load(uri)
return open_server(uri, config, false)
end
raise DRbBadURI, 'can\'t parse uri:' + uri
end
module_function :open_server
# Parse +uri+ into a [uri, option] pair.
#
# The DRbProtocol module asks each registered protocol in turn to
# try to parse the URI. Each protocol signals that it does not handle that
# URI by raising a DRbBadScheme error. If no protocol recognises the
# URI, then a DRbBadURI error is raised.
def uri_option(uri, config, first=true)
@protocol.each do |prot|
begin
uri, opt = prot.uri_option(uri, config)
# opt = nil if opt == ''
return uri, opt
rescue DRbBadScheme
end
end
if first && (config[:auto_load] != false)
auto_load(uri)
return uri_option(uri, config, false)
end
raise DRbBadURI, 'can\'t parse uri:' + uri
end
module_function :uri_option
def auto_load(uri) # :nodoc:
if /\Adrb([a-z0-9]+):/ =~ uri
require("drb/#{$1}") rescue nil
end
end
module_function :auto_load
end
# The default drb protocol which communicates over a TCP socket.
#
# The DRb TCP protocol URI looks like:
# <code>druby://<host>:<port>?<option></code>. The option is optional.
class DRbTCPSocket
# :stopdoc:
private
def self.parse_uri(uri)
if /\Adruby:\/\/(.*?):(\d+)(\?(.*))?\z/ =~ uri
host = $1
port = $2.to_i
option = $4
[host, port, option]
else
raise(DRbBadScheme, uri) unless uri.start_with?('druby:')
raise(DRbBadURI, 'can\'t parse uri:' + uri)
end
end
public
# Open a client connection to +uri+ (DRb URI string) using configuration
# +config+.
#
# This can raise DRb::DRbBadScheme or DRb::DRbBadURI if +uri+ is not for a
# recognized protocol. See DRb::DRbServer.new for information on built-in
# URI protocols.
def self.open(uri, config)
host, port, = parse_uri(uri)
soc = TCPSocket.open(host, port)
self.new(uri, soc, config)
end
# Returns the hostname of this server
def self.getservername
host = Socket::gethostname
begin
Socket::getaddrinfo(host, nil,
Socket::AF_UNSPEC,
Socket::SOCK_STREAM,
0,
Socket::AI_PASSIVE)[0][3]
rescue
'localhost'
end
end
# For the families available for +host+, returns a TCPServer on +port+.
# If +port+ is 0 the first available port is used. IPv4 servers are
# preferred over IPv6 servers.
def self.open_server_inaddr_any(host, port)
infos = Socket::getaddrinfo(host, nil,
Socket::AF_UNSPEC,
Socket::SOCK_STREAM,
0,
Socket::AI_PASSIVE)
families = Hash[*infos.collect { |af, *_| af }.uniq.zip([]).flatten]
return TCPServer.open('0.0.0.0', port) if families.has_key?('AF_INET')
return TCPServer.open('::', port) if families.has_key?('AF_INET6')
return TCPServer.open(port)
# :stopdoc:
end
# Open a server listening for connections at +uri+ using
# configuration +config+.
def self.open_server(uri, config)
uri = 'druby://:0' unless uri
host, port, _ = parse_uri(uri)
config = {:tcp_original_host => host}.update(config)
if host.size == 0
host = getservername
soc = open_server_inaddr_any(host, port)
else
soc = TCPServer.open(host, port)
end
port = soc.addr[1] if port == 0
config[:tcp_port] = port
uri = "druby://#{host}:#{port}"
self.new(uri, soc, config)
end
# Parse +uri+ into a [uri, option] pair.
def self.uri_option(uri, config)
host, port, option = parse_uri(uri)
return "druby://#{host}:#{port}", option
end
# Create a new DRbTCPSocket instance.
#
# +uri+ is the URI we are connected to.
# +soc+ is the tcp socket we are bound to. +config+ is our
# configuration.
def initialize(uri, soc, config={})
@uri = uri
@socket = soc
@config = config
@acl = config[:tcp_acl]
@msg = DRbMessage.new(config)
set_sockopt(@socket)
@shutdown_pipe_r, @shutdown_pipe_w = IO.pipe
end
# Get the URI that we are connected to.
attr_reader :uri
# Get the address of our TCP peer (the other end of the socket
# we are bound to.
def peeraddr
@socket.peeraddr
end
# Get the socket.
def stream; @socket; end
# On the client side, send a request to the server.
def send_request(ref, msg_id, arg, b)
@msg.send_request(stream, ref, msg_id, arg, b)
end
# On the server side, receive a request from the client.
def recv_request
@msg.recv_request(stream)
end
# On the server side, send a reply to the client.
def send_reply(succ, result)
@msg.send_reply(stream, succ, result)
end
# On the client side, receive a reply from the server.
def recv_reply
@msg.recv_reply(stream)
end
public
# Close the connection.
#
# If this is an instance returned by #open_server, then this stops
# listening for new connections altogether. If this is an instance
# returned by #open or by #accept, then it closes this particular
# client-server session.
def close
shutdown
if @socket
@socket.close
@socket = nil
end
close_shutdown_pipe
end
def close_shutdown_pipe
@shutdown_pipe_w.close
@shutdown_pipe_r.close
end
private :close_shutdown_pipe
# On the server side, for an instance returned by #open_server,
# accept a client connection and return a new instance to handle
# the server's side of this client-server session.
def accept
while true
s = accept_or_shutdown
return nil unless s
break if (@acl ? @acl.allow_socket?(s) : true)
s.close
end
if @config[:tcp_original_host].to_s.size == 0
uri = "druby://#{s.addr[3]}:#{@config[:tcp_port]}"
else
uri = @uri
end
self.class.new(uri, s, @config)
end
def accept_or_shutdown
readables, = IO.select([@socket, @shutdown_pipe_r])
if readables.include? @shutdown_pipe_r
return nil
end
@socket.accept
end
private :accept_or_shutdown
# Graceful shutdown
def shutdown
@shutdown_pipe_w.close
end
# Check to see if this connection is alive.
def alive?
return false unless @socket
if @socket.to_io.wait_readable(0)
close
return false
end
true
end
def set_sockopt(soc) # :nodoc:
soc.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
rescue IOError, Errno::ECONNRESET, Errno::EINVAL
# closed/shutdown socket, ignore error
end
end
module DRbProtocol
@protocol = [DRbTCPSocket] # default
end
class DRbURIOption # :nodoc: I don't understand the purpose of this class...
def initialize(option)
@option = option.to_s
end
attr_reader :option
def to_s; @option; end
def ==(other)
return false unless DRbURIOption === other
@option == other.option
end
def hash
@option.hash
end
alias eql? ==
end
# Object wrapping a reference to a remote drb object.
#
# Method calls on this object are relayed to the remote
# object that this object is a stub for.
class DRbObject
# Unmarshall a marshalled DRbObject.
#
# If the referenced object is located within the local server, then
# the object itself is returned. Otherwise, a new DRbObject is
# created to act as a stub for the remote referenced object.
def self._load(s)
uri, ref = Marshal.load(s)
if DRb.here?(uri)
obj = DRb.to_obj(ref)
return obj
end
self.new_with(uri, ref)
end
# Creates a DRb::DRbObject given the reference information to the remote
# host +uri+ and object +ref+.
def self.new_with(uri, ref)
it = self.allocate
it.instance_variable_set(:@uri, uri)
it.instance_variable_set(:@ref, ref)
it
end
# Create a new DRbObject from a URI alone.
def self.new_with_uri(uri)
self.new(nil, uri)
end
# Marshall this object.
#
# The URI and ref of the object are marshalled.
def _dump(lv)
Marshal.dump([@uri, @ref])
end
# Create a new remote object stub.
#
# +obj+ is the (local) object we want to create a stub for. Normally
# this is +nil+. +uri+ is the URI of the remote object that this
# will be a stub for.
def initialize(obj, uri=nil)
@uri = nil
@ref = nil
case obj
when Object
is_nil = obj.nil?
when BasicObject
is_nil = false
end
if is_nil
return if uri.nil?
@uri, option = DRbProtocol.uri_option(uri, DRb.config)
@ref = DRbURIOption.new(option) unless option.nil?
else
@uri = uri ? uri : (DRb.uri rescue nil)
@ref = obj ? DRb.to_id(obj) : nil
end
end
# Get the URI of the remote object.
def __drburi
@uri
end
# Get the reference of the object, if local.
def __drbref
@ref
end
undef :to_s
undef :to_a if respond_to?(:to_a)
# Routes respond_to? to the referenced remote object.
def respond_to?(msg_id, priv=false)
case msg_id
when :_dump
true
when :marshal_dump
false
else
method_missing(:respond_to?, msg_id, priv)
end
end
# Routes method calls to the referenced remote object.
ruby2_keywords def method_missing(msg_id, *a, &b)
if DRb.here?(@uri)
obj = DRb.to_obj(@ref)
DRb.current_server.check_insecure_method(obj, msg_id)
return obj.__send__(msg_id, *a, &b)
end
succ, result = self.class.with_friend(@uri) do
DRbConn.open(@uri) do |conn|
conn.send_message(self, msg_id, a, b)
end
end
if succ
return result
elsif DRbUnknown === result
raise result
else
bt = self.class.prepare_backtrace(@uri, result)
result.set_backtrace(bt + caller)
raise result
end
end
# Given the +uri+ of another host executes the block provided.
def self.with_friend(uri) # :nodoc:
friend = DRb.fetch_server(uri)
return yield() unless friend
save = Thread.current['DRb']
Thread.current['DRb'] = { 'server' => friend }
return yield
ensure
Thread.current['DRb'] = save if friend
end
# Returns a modified backtrace from +result+ with the +uri+ where each call
# in the backtrace came from.
def self.prepare_backtrace(uri, result) # :nodoc:
prefix = "(#{uri}) "
bt = []
result.backtrace.each do |x|
break if /`__send__'$/ =~ x
if /\A\(druby:\/\// =~ x
bt.push(x)
else
bt.push(prefix + x)
end
end
bt
end
def pretty_print(q) # :nodoc:
q.pp_object(self)
end
def pretty_print_cycle(q) # :nodoc:
q.object_address_group(self) {
q.breakable
q.text '...'
}
end
end
class ThreadObject
include MonitorMixin
def initialize(&blk)
super()
@wait_ev = new_cond
@req_ev = new_cond
@res_ev = new_cond
@status = :wait
@req = nil
@res = nil
@thread = Thread.new(self, &blk)
end
def alive?
@thread.alive?
end
def kill
@thread.kill
@thread.join
end
def method_missing(msg, *arg, &blk)
synchronize do
@wait_ev.wait_until { @status == :wait }
@req = [msg] + arg
@status = :req
@req_ev.broadcast
@res_ev.wait_until { @status == :res }
value = @res
@req = @res = nil
@status = :wait
@wait_ev.broadcast
return value
end
end
def _execute()
synchronize do
@req_ev.wait_until { @status == :req }
@res = yield(@req)
@status = :res
@res_ev.signal
end
end
end
# Class handling the connection between a DRbObject and the
# server the real object lives on.
#
# This class maintains a pool of connections, to reduce the
# overhead of starting and closing down connections for each
# method call.
#
# This class is used internally by DRbObject. The user does
# not normally need to deal with it directly.
class DRbConn
POOL_SIZE = 16 # :nodoc:
def self.make_pool
ThreadObject.new do |queue|
pool = []
while true
queue._execute do |message|
case(message[0])
when :take then
remote_uri = message[1]
conn = nil
new_pool = []
pool.each do |c|
if conn.nil? and c.uri == remote_uri
conn = c if c.alive?
else
new_pool.push c
end
end
pool = new_pool
conn
when :store then
conn = message[1]
pool.unshift(conn)
pool.pop.close while pool.size > POOL_SIZE
conn
else
nil
end
end
end
end
end
@pool_proxy = nil
def self.stop_pool
@pool_proxy&.kill
@pool_proxy = nil
end
def self.open(remote_uri) # :nodoc:
begin
@pool_proxy = make_pool unless @pool_proxy&.alive?
conn = @pool_proxy.take(remote_uri)
conn = self.new(remote_uri) unless conn
succ, result = yield(conn)
return succ, result
ensure
if conn
if succ
@pool_proxy.store(conn)
else
conn.close
end
end
end
end
def initialize(remote_uri) # :nodoc:
@uri = remote_uri
@protocol = DRbProtocol.open(remote_uri, DRb.config)
end
attr_reader :uri # :nodoc:
def send_message(ref, msg_id, arg, block) # :nodoc:
@protocol.send_request(ref, msg_id, arg, block)
@protocol.recv_reply
end
def close # :nodoc:
@protocol.close
@protocol = nil
end
def alive? # :nodoc:
return false unless @protocol
@protocol.alive?
end
end
# Class representing a drb server instance.
#
# A DRbServer must be running in the local process before any incoming
# dRuby calls can be accepted, or any local objects can be passed as
# dRuby references to remote processes, even if those local objects are
# never actually called remotely. You do not need to start a DRbServer
# in the local process if you are only making outgoing dRuby calls
# passing marshalled parameters.
#
# Unless multiple servers are being used, the local DRbServer is normally
# started by calling DRb.start_service.
class DRbServer
@@acl = nil
@@idconv = DRbIdConv.new
@@secondary_server = nil
@@argc_limit = 256
@@load_limit = 0xffffffff
@@verbose = false
# Set the default value for the :argc_limit option.
#
# See #new(). The initial default value is 256.
def self.default_argc_limit(argc)
@@argc_limit = argc
end
# Set the default value for the :load_limit option.
#
# See #new(). The initial default value is 25 MB.
def self.default_load_limit(sz)
@@load_limit = sz
end
# Set the default access control list to +acl+. The default ACL is +nil+.
#
# See also DRb::ACL and #new()
def self.default_acl(acl)
@@acl = acl
end
# Set the default value for the :id_conv option.
#
# See #new(). The initial default value is a DRbIdConv instance.
def self.default_id_conv(idconv)
@@idconv = idconv
end
# Set the default value of the :verbose option.
#
# See #new(). The initial default value is false.
def self.verbose=(on)
@@verbose = on
end
# Get the default value of the :verbose option.
def self.verbose
@@verbose
end
def self.make_config(hash={}) # :nodoc:
default_config = {
:idconv => @@idconv,
:verbose => @@verbose,
:tcp_acl => @@acl,
:load_limit => @@load_limit,
:argc_limit => @@argc_limit,
}
default_config.update(hash)
end
# Create a new DRbServer instance.
#
# +uri+ is the URI to bind to. This is normally of the form
# 'druby://<hostname>:<port>' where <hostname> is a hostname of
# the local machine. If nil, then the system's default hostname
# will be bound to, on a port selected by the system; these value
# can be retrieved from the +uri+ attribute. 'druby:' specifies
# the default dRuby transport protocol: another protocol, such
# as 'drbunix:', can be specified instead.
#
# +front+ is the front object for the server, that is, the object
# to which remote method calls on the server will be passed. If
# nil, then the server will not accept remote method calls.
#
# If +config_or_acl+ is a hash, it is the configuration to
# use for this server. The following options are recognised:
#
# :idconv :: an id-to-object conversion object. This defaults
# to an instance of the class DRb::DRbIdConv.
# :verbose :: if true, all unsuccessful remote calls on objects
# in the server will be logged to $stdout. false
# by default.
# :tcp_acl :: the access control list for this server. See
# the ACL class from the main dRuby distribution.
# :load_limit :: the maximum message size in bytes accepted by
# the server. Defaults to 25 MB (26214400).
# :argc_limit :: the maximum number of arguments to a remote
# method accepted by the server. Defaults to
# 256.
# The default values of these options can be modified on
# a class-wide basis by the class methods #default_argc_limit,
# #default_load_limit, #default_acl, #default_id_conv,
# and #verbose=
#
# If +config_or_acl+ is not a hash, but is not nil, it is
# assumed to be the access control list for this server.
# See the :tcp_acl option for more details.
#
# If no other server is currently set as the primary server,
# this will become the primary server.
#
# The server will immediately start running in its own thread.
def initialize(uri=nil, front=nil, config_or_acl=nil)
if Hash === config_or_acl
config = config_or_acl.dup
else
acl = config_or_acl || @@acl
config = {
:tcp_acl => acl
}
end
@config = self.class.make_config(config)
@protocol = DRbProtocol.open_server(uri, @config)
@uri = @protocol.uri
@exported_uri = [@uri]
@front = front
@idconv = @config[:idconv]
@grp = ThreadGroup.new
@thread = run
DRb.regist_server(self)
end
# The URI of this DRbServer.
attr_reader :uri
# The main thread of this DRbServer.
#
# This is the thread that listens for and accepts connections
# from clients, not that handles each client's request-response
# session.
attr_reader :thread
# The front object of the DRbServer.
#
# This object receives remote method calls made on the server's
# URI alone, with an object id.
attr_reader :front
# The configuration of this DRbServer
attr_reader :config
# Set whether to operate in verbose mode.
#
# In verbose mode, failed calls are logged to stdout.
def verbose=(v); @config[:verbose]=v; end
# Get whether the server is in verbose mode.
#
# In verbose mode, failed calls are logged to stdout.
def verbose; @config[:verbose]; end
# Is this server alive?
def alive?
@thread.alive?
end
# Is +uri+ the URI for this server?
def here?(uri)
@exported_uri.include?(uri)
end
# Stop this server.
def stop_service
DRb.remove_server(self)
if Thread.current['DRb'] && Thread.current['DRb']['server'] == self
Thread.current['DRb']['stop_service'] = true
else
shutdown
end
end
# Convert a dRuby reference to the local object it refers to.
def to_obj(ref)
return front if ref.nil?
return front[ref.to_s] if DRbURIOption === ref
@idconv.to_obj(ref)
end
# Convert a local object to a dRuby reference.
def to_id(obj)
return nil if obj.__id__ == front.__id__
@idconv.to_id(obj)
end
private
def shutdown
current = Thread.current
if @protocol.respond_to? :shutdown
@protocol.shutdown
else
[@thread, *@grp.list].each { |thread|
thread.kill unless thread == current # xxx: Thread#kill
}
end
@thread.join unless @thread == current
end
##
# Starts the DRb main loop in a new thread.
def run
Thread.start do
begin
while main_loop
end
ensure
@protocol.close if @protocol
end
end
end
# List of insecure methods.
#
# These methods are not callable via dRuby.
INSECURE_METHOD = [
:__send__
]
# Has a method been included in the list of insecure methods?
def insecure_method?(msg_id)
INSECURE_METHOD.include?(msg_id)
end
# Coerce an object to a string, providing our own representation if
# to_s is not defined for the object.
def any_to_s(obj)
"#{obj}:#{obj.class}"
rescue
Kernel.instance_method(:to_s).bind_call(obj)
end
# Check that a method is callable via dRuby.
#
# +obj+ is the object we want to invoke the method on. +msg_id+ is the
# method name, as a Symbol.
#
# If the method is an insecure method (see #insecure_method?) a
# SecurityError is thrown. If the method is private or undefined,
# a NameError is thrown.
def check_insecure_method(obj, msg_id)
return true if Proc === obj && msg_id == :__drb_yield
raise(ArgumentError, "#{any_to_s(msg_id)} is not a symbol") unless Symbol == msg_id.class
raise(SecurityError, "insecure method `#{msg_id}'") if insecure_method?(msg_id)
case obj
when Object
if obj.private_methods.include?(msg_id)
desc = any_to_s(obj)
raise NoMethodError, "private method `#{msg_id}' called for #{desc}"
elsif obj.protected_methods.include?(msg_id)
desc = any_to_s(obj)
raise NoMethodError, "protected method `#{msg_id}' called for #{desc}"
else
true
end
else
if Kernel.instance_method(:private_methods).bind(obj).call.include?(msg_id)
desc = any_to_s(obj)
raise NoMethodError, "private method `#{msg_id}' called for #{desc}"
elsif Kernel.instance_method(:protected_methods).bind(obj).call.include?(msg_id)
desc = any_to_s(obj)
raise NoMethodError, "protected method `#{msg_id}' called for #{desc}"
else
true
end
end
end
public :check_insecure_method
class InvokeMethod # :nodoc:
def initialize(drb_server, client)
@drb_server = drb_server
@client = client
end
def perform
begin
setup_message
ensure
@result = nil
@succ = false
end
if @block
@result = perform_with_block
else
@result = perform_without_block
end
@succ = true
case @result
when Array
if @msg_id == :to_ary
@result = DRbArray.new(@result)
end
end
return @succ, @result
rescue NoMemoryError, SystemExit, SystemStackError, SecurityError
raise
rescue Exception
@result = $!
return @succ, @result
end
private
def init_with_client
obj, msg, argv, block = @client.recv_request
@obj = obj
@msg_id = msg.intern
@argv = argv
@block = block
end
def check_insecure_method
@drb_server.check_insecure_method(@obj, @msg_id)
end
def setup_message
init_with_client
check_insecure_method
end
def perform_without_block
if Proc === @obj && @msg_id == :__drb_yield
if @argv.size == 1
ary = @argv
else
ary = [@argv]
end
ary.collect(&@obj)[0]
else
@obj.__send__(@msg_id, *@argv)
end
end
end
require_relative 'invokemethod'
class InvokeMethod
include InvokeMethod18Mixin
end
def error_print(exception)
exception.backtrace.inject(true) do |first, x|
if first
$stderr.puts "#{x}: #{exception} (#{exception.class})"
else
$stderr.puts "\tfrom #{x}"
end
false
end
end
# The main loop performed by a DRbServer's internal thread.
#
# Accepts a connection from a client, and starts up its own
# thread to handle it. This thread loops, receiving requests
# from the client, invoking them on a local object, and
# returning responses, until the client closes the connection
# or a local method call fails.
def main_loop
client0 = @protocol.accept
return nil if !client0
Thread.start(client0) do |client|
@grp.add Thread.current
Thread.current['DRb'] = { 'client' => client ,
'server' => self }
DRb.mutex.synchronize do
client_uri = client.uri
@exported_uri << client_uri unless @exported_uri.include?(client_uri)
end
_last_invoke_method = nil
loop do
begin
succ = false
invoke_method = InvokeMethod.new(self, client)
succ, result = invoke_method.perform
error_print(result) if !succ && verbose
unless DRbConnError === result && result.message == 'connection closed'
client.send_reply(succ, result)
end
rescue Exception => e
error_print(e) if verbose
ensure
_last_invoke_method = invoke_method
client.close unless succ
if Thread.current['DRb']['stop_service']
shutdown
break
end
break unless succ
end
end
end
end
end
@primary_server = nil
# Start a dRuby server locally.
#
# The new dRuby server will become the primary server, even
# if another server is currently the primary server.
#
# +uri+ is the URI for the server to bind to. If nil,
# the server will bind to random port on the default local host
# name and use the default dRuby protocol.
#
# +front+ is the server's front object. This may be nil.
#
# +config+ is the configuration for the new server. This may
# be nil.
#
# See DRbServer::new.
def start_service(uri=nil, front=nil, config=nil)
@primary_server = DRbServer.new(uri, front, config)
end
module_function :start_service
# The primary local dRuby server.
#
# This is the server created by the #start_service call.
attr_accessor :primary_server
module_function :primary_server=, :primary_server
# Get the 'current' server.
#
# In the context of execution taking place within the main
# thread of a dRuby server (typically, as a result of a remote
# call on the server or one of its objects), the current
# server is that server. Otherwise, the current server is
# the primary server.
#
# If the above rule fails to find a server, a DRbServerNotFound
# error is raised.
def current_server
drb = Thread.current['DRb']
server = (drb && drb['server']) ? drb['server'] : @primary_server
raise DRbServerNotFound unless server
return server
end
module_function :current_server
# Stop the local dRuby server.
#
# This operates on the primary server. If there is no primary
# server currently running, it is a noop.
def stop_service
@primary_server.stop_service if @primary_server
@primary_server = nil
end
module_function :stop_service
# Get the URI defining the local dRuby space.
#
# This is the URI of the current server. See #current_server.
def uri
drb = Thread.current['DRb']
client = (drb && drb['client'])
if client
uri = client.uri
return uri if uri
end
current_server.uri
end
module_function :uri
# Is +uri+ the URI for the current local server?
def here?(uri)
current_server.here?(uri) rescue false
# (current_server.uri rescue nil) == uri
end
module_function :here?
# Get the configuration of the current server.
#
# If there is no current server, this returns the default configuration.
# See #current_server and DRbServer::make_config.
def config
current_server.config
rescue
DRbServer.make_config
end
module_function :config
# Get the front object of the current server.
#
# This raises a DRbServerNotFound error if there is no current server.
# See #current_server.
def front
current_server.front
end
module_function :front
# Convert a reference into an object using the current server.
#
# This raises a DRbServerNotFound error if there is no current server.
# See #current_server.
def to_obj(ref)
current_server.to_obj(ref)
end
# Get a reference id for an object using the current server.
#
# This raises a DRbServerNotFound error if there is no current server.
# See #current_server.
def to_id(obj)
current_server.to_id(obj)
end
module_function :to_id
module_function :to_obj
# Get the thread of the primary server.
#
# This returns nil if there is no primary server. See #primary_server.
def thread
@primary_server ? @primary_server.thread : nil
end
module_function :thread
# Set the default id conversion object.
#
# This is expected to be an instance such as DRb::DRbIdConv that responds to
# #to_id and #to_obj that can convert objects to and from DRb references.
#
# See DRbServer#default_id_conv.
def install_id_conv(idconv)
DRbServer.default_id_conv(idconv)
end
module_function :install_id_conv
# Set the default ACL to +acl+.
#
# See DRb::DRbServer.default_acl.
def install_acl(acl)
DRbServer.default_acl(acl)
end
module_function :install_acl
@mutex = Thread::Mutex.new
def mutex # :nodoc:
@mutex
end
module_function :mutex
@server = {}
# Registers +server+ with DRb.
#
# This is called when a new DRb::DRbServer is created.
#
# If there is no primary server then +server+ becomes the primary server.
#
# Example:
#
# require 'drb'
#
# s = DRb::DRbServer.new # automatically calls regist_server
# DRb.fetch_server s.uri #=> #<DRb::DRbServer:0x...>
def regist_server(server)
@server[server.uri] = server
mutex.synchronize do
@primary_server = server unless @primary_server
end
end
module_function :regist_server
# Removes +server+ from the list of registered servers.
def remove_server(server)
@server.delete(server.uri)
mutex.synchronize do
if @primary_server == server
@primary_server = nil
end
end
end
module_function :remove_server
# Retrieves the server with the given +uri+.
#
# See also regist_server and remove_server.
def fetch_server(uri)
@server[uri]
end
module_function :fetch_server
end
# :stopdoc:
DRbObject = DRb::DRbObject
DRbUndumped = DRb::DRbUndumped
DRbIdConv = DRb::DRbIdConv
share/ruby/drb/acl.rb 0000644 00000011161 15173517736 0010501 0 ustar 00 # frozen_string_literal: false
# Copyright (c) 2000,2002,2003 Masatoshi SEKI
#
# acl.rb is copyrighted free software by Masatoshi SEKI.
# You can redistribute it and/or modify it under the same terms as Ruby.
require 'ipaddr'
##
# Simple Access Control Lists.
#
# Access control lists are composed of "allow" and "deny" halves to control
# access. Use "all" or "*" to match any address. To match a specific address
# use any address or address mask that IPAddr can understand.
#
# Example:
#
# list = %w[
# deny all
# allow 192.168.1.1
# allow ::ffff:192.168.1.2
# allow 192.168.1.3
# ]
#
# # From Socket#peeraddr, see also ACL#allow_socket?
# addr = ["AF_INET", 10, "lc630", "192.168.1.3"]
#
# acl = ACL.new
# p acl.allow_addr?(addr) # => true
#
# acl = ACL.new(list, ACL::DENY_ALLOW)
# p acl.allow_addr?(addr) # => true
class ACL
##
# The current version of ACL
VERSION=["2.0.0"]
##
# An entry in an ACL
class ACLEntry
##
# Creates a new entry using +str+.
#
# +str+ may be "*" or "all" to match any address, an IP address string
# to match a specific address, an IP address mask per IPAddr, or one
# containing "*" to match part of an IPv4 address.
#
# IPAddr::InvalidPrefixError may be raised when an IP network
# address with an invalid netmask/prefix is given.
def initialize(str)
if str == '*' or str == 'all'
@pat = [:all]
elsif str.include?('*')
@pat = [:name, dot_pat(str)]
else
begin
@pat = [:ip, IPAddr.new(str)]
rescue IPAddr::InvalidPrefixError
# In this case, `str` shouldn't be a host name pattern
# because it contains a slash.
raise
rescue ArgumentError
@pat = [:name, dot_pat(str)]
end
end
end
private
##
# Creates a regular expression to match IPv4 addresses
def dot_pat_str(str)
list = str.split('.').collect { |s|
(s == '*') ? '.+' : s
}
list.join("\\.")
end
private
##
# Creates a Regexp to match an address.
def dot_pat(str)
/\A#{dot_pat_str(str)}\z/
end
public
##
# Matches +addr+ against this entry.
def match(addr)
case @pat[0]
when :all
true
when :ip
begin
ipaddr = IPAddr.new(addr[3])
ipaddr = ipaddr.ipv4_mapped if @pat[1].ipv6? && ipaddr.ipv4?
rescue ArgumentError
return false
end
(@pat[1].include?(ipaddr)) ? true : false
when :name
(@pat[1] =~ addr[2]) ? true : false
else
false
end
end
end
##
# A list of ACLEntry objects. Used to implement the allow and deny halves
# of an ACL
class ACLList
##
# Creates an empty ACLList
def initialize
@list = []
end
public
##
# Matches +addr+ against each ACLEntry in this list.
def match(addr)
@list.each do |e|
return true if e.match(addr)
end
false
end
public
##
# Adds +str+ as an ACLEntry in this list
def add(str)
@list.push(ACLEntry.new(str))
end
end
##
# Default to deny
DENY_ALLOW = 0
##
# Default to allow
ALLOW_DENY = 1
##
# Creates a new ACL from +list+ with an evaluation +order+ of DENY_ALLOW or
# ALLOW_DENY.
#
# An ACL +list+ is an Array of "allow" or "deny" and an address or address
# mask or "all" or "*" to match any address:
#
# %w[
# deny all
# allow 192.0.2.2
# allow 192.0.2.128/26
# ]
def initialize(list=nil, order = DENY_ALLOW)
@order = order
@deny = ACLList.new
@allow = ACLList.new
install_list(list) if list
end
public
##
# Allow connections from Socket +soc+?
def allow_socket?(soc)
allow_addr?(soc.peeraddr)
end
public
##
# Allow connections from addrinfo +addr+? It must be formatted like
# Socket#peeraddr:
#
# ["AF_INET", 10, "lc630", "192.0.2.1"]
def allow_addr?(addr)
case @order
when DENY_ALLOW
return true if @allow.match(addr)
return false if @deny.match(addr)
return true
when ALLOW_DENY
return false if @deny.match(addr)
return true if @allow.match(addr)
return false
else
false
end
end
public
##
# Adds +list+ of ACL entries to this ACL.
def install_list(list)
i = 0
while i < list.size
permission, domain = list.slice(i,2)
case permission.downcase
when 'allow'
@allow.add(domain)
when 'deny'
@deny.add(domain)
else
raise "Invalid ACL entry #{list}"
end
i += 2
end
end
end
share/ruby/mutex_m.rb 0000644 00000004556 15173517736 0010663 0 ustar 00 # frozen_string_literal: false
#
# mutex_m.rb -
# $Release Version: 3.0$
# $Revision: 1.7 $
# Original from mutex.rb
# by Keiju ISHITSUKA(keiju@ishitsuka.com)
# modified by matz
# patched by akira yamada
#
# --
# = mutex_m.rb
#
# When 'mutex_m' is required, any object that extends or includes Mutex_m will
# be treated like a Mutex.
#
# Start by requiring the standard library Mutex_m:
#
# require "mutex_m.rb"
#
# From here you can extend an object with Mutex instance methods:
#
# obj = Object.new
# obj.extend Mutex_m
#
# Or mixin Mutex_m into your module to your class inherit Mutex instance
# methods --- remember to call super() in your class initialize method.
#
# class Foo
# include Mutex_m
# def initialize
# # ...
# super()
# end
# # ...
# end
# obj = Foo.new
# # this obj can be handled like Mutex
#
module Mutex_m
VERSION = "0.2.0"
Ractor.make_shareable(VERSION) if defined?(Ractor)
def Mutex_m.define_aliases(cl) # :nodoc:
cl.alias_method(:locked?, :mu_locked?)
cl.alias_method(:lock, :mu_lock)
cl.alias_method(:unlock, :mu_unlock)
cl.alias_method(:try_lock, :mu_try_lock)
cl.alias_method(:synchronize, :mu_synchronize)
end
def Mutex_m.append_features(cl) # :nodoc:
super
define_aliases(cl) unless cl.instance_of?(Module)
end
def Mutex_m.extend_object(obj) # :nodoc:
super
obj.mu_extended
end
def mu_extended # :nodoc:
unless (defined? locked? and
defined? lock and
defined? unlock and
defined? try_lock and
defined? synchronize)
Mutex_m.define_aliases(singleton_class)
end
mu_initialize
end
# See Thread::Mutex#synchronize
def mu_synchronize(&block)
@_mutex.synchronize(&block)
end
# See Thread::Mutex#locked?
def mu_locked?
@_mutex.locked?
end
# See Thread::Mutex#try_lock
def mu_try_lock
@_mutex.try_lock
end
# See Thread::Mutex#lock
def mu_lock
@_mutex.lock
end
# See Thread::Mutex#unlock
def mu_unlock
@_mutex.unlock
end
# See Thread::Mutex#sleep
def sleep(timeout = nil)
@_mutex.sleep(timeout)
end
private
def mu_initialize # :nodoc:
@_mutex = Thread::Mutex.new
end
def initialize(*args) # :nodoc:
mu_initialize
super
end
ruby2_keywords(:initialize) if respond_to?(:ruby2_keywords, true)
end
share/ruby/digest.rb 0000644 00000006465 15173517736 0010465 0 ustar 00 # frozen_string_literal: false
if defined?(Digest) &&
/\A(?:2\.|3\.0\.[0-2]\z)/.match?(RUBY_VERSION) &&
caller_locations.any? { |l|
%r{/(rubygems/gem_runner|bundler/cli)\.rb}.match?(l.path)
}
# Before Ruby 3.0.3/3.1.0, the gem and bundle commands used to load
# the digest library before loading additionally installed gems, so
# you will get constant redefinition warnings and unexpected
# implementation overwriting if we proceed here. Avoid that.
return
end
require 'digest/version'
require 'digest/loader'
module Digest
# A mutex for Digest().
REQUIRE_MUTEX = Thread::Mutex.new
def self.const_missing(name) # :nodoc:
case name
when :SHA256, :SHA384, :SHA512
lib = 'digest/sha2'
else
lib = File.join('digest', name.to_s.downcase)
end
begin
require lib
rescue LoadError
raise LoadError, "library not found for class Digest::#{name} -- #{lib}", caller(1)
end
unless Digest.const_defined?(name)
raise NameError, "uninitialized constant Digest::#{name}", caller(1)
end
Digest.const_get(name)
end
class ::Digest::Class
# Creates a digest object and reads a given file, _name_.
# Optional arguments are passed to the constructor of the digest
# class.
#
# p Digest::SHA256.file("X11R6.8.2-src.tar.bz2").hexdigest
# # => "f02e3c85572dc9ad7cb77c2a638e3be24cc1b5bea9fdbb0b0299c9668475c534"
def self.file(name, *args)
new(*args).file(name)
end
# Returns the base64 encoded hash value of a given _string_. The
# return value is properly padded with '=' and contains no line
# feeds.
def self.base64digest(str, *args)
[digest(str, *args)].pack('m0')
end
end
module Instance
# Updates the digest with the contents of a given file _name_ and
# returns self.
def file(name)
File.open(name, "rb") {|f|
buf = ""
while f.read(16384, buf)
update buf
end
}
self
end
# If none is given, returns the resulting hash value of the digest
# in a base64 encoded form, keeping the digest's state.
#
# If a +string+ is given, returns the hash value for the given
# +string+ in a base64 encoded form, resetting the digest to the
# initial state before and after the process.
#
# In either case, the return value is properly padded with '=' and
# contains no line feeds.
def base64digest(str = nil)
[str ? digest(str) : digest].pack('m0')
end
# Returns the resulting hash value and resets the digest to the
# initial state.
def base64digest!
[digest!].pack('m0')
end
end
end
# call-seq:
# Digest(name) -> digest_subclass
#
# Returns a Digest subclass by +name+ in a thread-safe manner even
# when on-demand loading is involved.
#
# require 'digest'
#
# Digest("MD5")
# # => Digest::MD5
#
# Digest(:SHA256)
# # => Digest::SHA256
#
# Digest(:Foo)
# # => LoadError: library not found for class Digest::Foo -- digest/foo
def Digest(name)
const = name.to_sym
Digest::REQUIRE_MUTEX.synchronize {
# Ignore autoload's because it is void when we have #const_missing
Digest.const_missing(const)
}
rescue LoadError
# Constants do not necessarily rely on digest/*.
if Digest.const_defined?(const)
Digest.const_get(const)
else
raise
end
end
share/ruby/fiddle.rb 0000644 00000005610 15173517736 0010424 0 ustar 00 # frozen_string_literal: true
require 'fiddle.so'
require 'fiddle/closure'
require 'fiddle/function'
require 'fiddle/version'
module Fiddle
if WINDOWS
# Returns the last win32 +Error+ of the current executing +Thread+ or nil
# if none
def self.win32_last_error
Thread.current[:__FIDDLE_WIN32_LAST_ERROR__]
end
# Sets the last win32 +Error+ of the current executing +Thread+ to +error+
def self.win32_last_error= error
Thread.current[:__FIDDLE_WIN32_LAST_ERROR__] = error
end
# Returns the last win32 socket +Error+ of the current executing
# +Thread+ or nil if none
def self.win32_last_socket_error
Thread.current[:__FIDDLE_WIN32_LAST_SOCKET_ERROR__]
end
# Sets the last win32 socket +Error+ of the current executing
# +Thread+ to +error+
def self.win32_last_socket_error= error
Thread.current[:__FIDDLE_WIN32_LAST_SOCKET_ERROR__] = error
end
end
# Returns the last +Error+ of the current executing +Thread+ or nil if none
def self.last_error
Thread.current[:__FIDDLE_LAST_ERROR__]
end
# Sets the last +Error+ of the current executing +Thread+ to +error+
def self.last_error= error
Thread.current[:__DL2_LAST_ERROR__] = error
Thread.current[:__FIDDLE_LAST_ERROR__] = error
end
# call-seq: dlopen(library) => Fiddle::Handle
#
# Creates a new handler that opens +library+, and returns an instance of
# Fiddle::Handle.
#
# If +nil+ is given for the +library+, Fiddle::Handle::DEFAULT is used, which
# is the equivalent to RTLD_DEFAULT. See <code>man 3 dlopen</code> for more.
#
# lib = Fiddle.dlopen(nil)
#
# The default is dependent on OS, and provide a handle for all libraries
# already loaded. For example, in most cases you can use this to access
# +libc+ functions, or ruby functions like +rb_str_new+.
#
# See Fiddle::Handle.new for more.
def dlopen library
begin
Fiddle::Handle.new(library)
rescue DLError => error
case RUBY_PLATFORM
when /linux/
case error.message
when /\A(\/.+?): (?:invalid ELF header|file too short)/
# This may be a linker script:
# https://sourceware.org/binutils/docs/ld.html#Scripts
path = $1
else
raise
end
else
raise
end
File.open(path) do |input|
input.each_line do |line|
case line
when /\A\s*(?:INPUT|GROUP)\s*\(\s*([^\s,\)]+)/
# TODO: Should we support multiple files?
return dlopen($1)
end
end
end
# Not found
raise
end
end
module_function :dlopen
# Add constants for backwards compat
RTLD_GLOBAL = Handle::RTLD_GLOBAL # :nodoc:
RTLD_LAZY = Handle::RTLD_LAZY # :nodoc:
RTLD_NOW = Handle::RTLD_NOW # :nodoc:
Fiddle::Types.constants.each do |type|
const_set "TYPE_#{type}", Fiddle::Types.const_get(type)
end
end
share/ruby/open3.rb 0000644 00000137013 15173517736 0010224 0 ustar 00 # frozen_string_literal: true
#
# = open3.rb: Popen, but with stderr, too
#
# Author:: Yukihiro Matsumoto
# Documentation:: Konrad Meyer
#
# Open3 gives you access to stdin, stdout, and stderr when running other
# programs.
#
#
# Open3 grants you access to stdin, stdout, stderr and a thread to wait for the
# child process when running another program.
# You can specify various attributes, redirections, current directory, etc., of
# the program in the same way as for Process.spawn.
#
# - Open3.popen3 : pipes for stdin, stdout, stderr
# - Open3.popen2 : pipes for stdin, stdout
# - Open3.popen2e : pipes for stdin, merged stdout and stderr
# - Open3.capture3 : give a string for stdin; get strings for stdout, stderr
# - Open3.capture2 : give a string for stdin; get a string for stdout
# - Open3.capture2e : give a string for stdin; get a string for merged stdout and stderr
# - Open3.pipeline_rw : pipes for first stdin and last stdout of a pipeline
# - Open3.pipeline_r : pipe for last stdout of a pipeline
# - Open3.pipeline_w : pipe for first stdin of a pipeline
# - Open3.pipeline_start : run a pipeline without waiting
# - Open3.pipeline : run a pipeline and wait for its completion
#
require 'open3/version'
# \Module \Open3 supports creating child processes
# with access to their $stdin, $stdout, and $stderr streams.
#
# == What's Here
#
# Each of these methods executes a given command in a new process or subshell,
# or multiple commands in new processes and/or subshells:
#
# - Each of these methods executes a single command in a process or subshell,
# accepts a string for input to $stdin,
# and returns string output from $stdout, $stderr, or both:
#
# - Open3.capture2: Executes the command;
# returns the string from $stdout.
# - Open3.capture2e: Executes the command;
# returns the string from merged $stdout and $stderr.
# - Open3.capture3: Executes the command;
# returns strings from $stdout and $stderr.
#
# - Each of these methods executes a single command in a process or subshell,
# and returns pipes for $stdin, $stdout, and/or $stderr:
#
# - Open3.popen2: Executes the command;
# returns pipes for $stdin and $stdout.
# - Open3.popen2e: Executes the command;
# returns pipes for $stdin and merged $stdout and $stderr.
# - Open3.popen3: Executes the command;
# returns pipes for $stdin, $stdout, and $stderr.
#
# - Each of these methods executes one or more commands in processes and/or subshells,
# returns pipes for the first $stdin, the last $stdout, or both:
#
# - Open3.pipeline_r: Returns a pipe for the last $stdout.
# - Open3.pipeline_rw: Returns pipes for the first $stdin and the last $stdout.
# - Open3.pipeline_w: Returns a pipe for the first $stdin.
# - Open3.pipeline_start: Does not wait for processes to complete.
# - Open3.pipeline: Waits for processes to complete.
#
# Each of the methods above accepts:
#
# - An optional hash of environment variable names and values;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
# - A required string argument that is a +command_line+ or +exe_path+;
# see {Argument command_line or exe_path}[rdoc-ref:Process@Argument+command_line+or+exe_path].
# - An optional hash of execution options;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
module Open3
# :call-seq:
# Open3.popen3([env, ] command_line, options = {}) -> [stdin, stdout, stderr, wait_thread]
# Open3.popen3([env, ] exe_path, *args, options = {}) -> [stdin, stdout, stderr, wait_thread]
# Open3.popen3([env, ] command_line, options = {}) {|stdin, stdout, stderr, wait_thread| ... } -> object
# Open3.popen3([env, ] exe_path, *args, options = {}) {|stdin, stdout, stderr, wait_thread| ... } -> object
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process, by calling Process.spawn with the given arguments.
# - Creates streams +stdin+, +stdout+, and +stderr+,
# which are the standard input, standard output, and standard error streams
# in the child process.
# - Creates thread +wait_thread+ that waits for the child process to exit;
# the thread has method +pid+, which returns the process ID
# of the child process.
#
# With no block given, returns the array
# <tt>[stdin, stdout, stderr, wait_thread]</tt>.
# The caller should close each of the three returned streams.
#
# stdin, stdout, stderr, wait_thread = Open3.popen3('echo')
# # => [#<IO:fd 8>, #<IO:fd 10>, #<IO:fd 12>, #<Process::Waiter:0x00007f58d5428f58 run>]
# stdin.close
# stdout.close
# stderr.close
# wait_thread.pid # => 2210481
# wait_thread.value # => #<Process::Status: pid 2210481 exit 0>
#
# With a block given, calls the block with the four variables
# (three streams and the wait thread)
# and returns the block's return value.
# The caller need not close the streams:
#
# Open3.popen3('echo') do |stdin, stdout, stderr, wait_thread|
# p stdin
# p stdout
# p stderr
# p wait_thread
# p wait_thread.pid
# p wait_thread.value
# end
#
# Output:
#
# #<IO:fd 6>
# #<IO:fd 7>
# #<IO:fd 9>
# #<Process::Waiter:0x00007f58d53606e8 sleep>
# 2211047
# #<Process::Status: pid 2211047 exit 0>
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# Unlike Process.spawn, this method waits for the child process to exit
# before returning, so the caller need not do so.
#
# If the first argument is a hash, it becomes leading argument +env+
# in the call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in the call to Process.spawn;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# The single required argument is one of the following:
#
# - +command_line+ if it is a string,
# and if it begins with a shell reserved word or special built-in,
# or if it contains one or more metacharacters.
# - +exe_path+ otherwise.
#
# <b>Argument +command_line+</b>
#
# \String argument +command_line+ is a command line to be passed to a shell;
# it must begin with a shell reserved word, begin with a special built-in,
# or contain meta characters:
#
# Open3.popen3('if true; then echo "Foo"; fi') {|*args| p args } # Shell reserved word.
# Open3.popen3('echo') {|*args| p args } # Built-in.
# Open3.popen3('date > date.tmp') {|*args| p args } # Contains meta character.
#
# Output (similar for each call above):
#
# [#<IO:(closed)>, #<IO:(closed)>, #<IO:(closed)>, #<Process::Waiter:0x00007f58d52f28c8 dead>]
#
# The command line may also contain arguments and options for the command:
#
# Open3.popen3('echo "Foo"') { |i, o, e, t| o.gets }
# "Foo\n"
#
# <b>Argument +exe_path+</b>
#
# Argument +exe_path+ is one of the following:
#
# - The string path to an executable to be called.
# - A 2-element array containing the path to an executable
# and the string to be used as the name of the executing process.
#
# Example:
#
# Open3.popen3('/usr/bin/date') { |i, o, e, t| o.gets }
# # => "Wed Sep 27 02:56:44 PM CDT 2023\n"
#
# Ruby invokes the executable directly, with no shell and no shell expansion:
#
# Open3.popen3('doesnt_exist') { |i, o, e, t| o.gets } # Raises Errno::ENOENT
#
# If one or more +args+ is given, each is an argument or option
# to be passed to the executable:
#
# Open3.popen3('echo', 'C #') { |i, o, e, t| o.gets }
# # => "C #\n"
# Open3.popen3('echo', 'hello', 'world') { |i, o, e, t| o.gets }
# # => "hello world\n"
#
# Take care to avoid deadlocks.
# Output streams +stdout+ and +stderr+ have fixed-size buffers,
# so reading extensively from one but not the other can cause a deadlock
# when the unread buffer fills.
# To avoid that, +stdout+ and +stderr+ should be read simultaneously
# (using threads or IO.select).
#
# Related:
#
# - Open3.popen2: Makes the standard input and standard output streams
# of the child process available as separate streams,
# with no access to the standard error stream.
# - Open3.popen2e: Makes the standard input and the merge
# of the standard output and standard error streams
# of the child process available as separate streams.
#
def popen3(*cmd, &block)
if Hash === cmd.last
opts = cmd.pop.dup
else
opts = {}
end
in_r, in_w = IO.pipe
opts[:in] = in_r
in_w.sync = true
out_r, out_w = IO.pipe
opts[:out] = out_w
err_r, err_w = IO.pipe
opts[:err] = err_w
popen_run(cmd, opts, [in_r, out_w, err_w], [in_w, out_r, err_r], &block)
end
module_function :popen3
# :call-seq:
# Open3.popen2([env, ] command_line, options = {}) -> [stdin, stdout, wait_thread]
# Open3.popen2([env, ] exe_path, *args, options = {}) -> [stdin, stdout, wait_thread]
# Open3.popen2([env, ] command_line, options = {}) {|stdin, stdout, wait_thread| ... } -> object
# Open3.popen2([env, ] exe_path, *args, options = {}) {|stdin, stdout, wait_thread| ... } -> object
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process, by calling Process.spawn with the given arguments.
# - Creates streams +stdin+ and +stdout+,
# which are the standard input and standard output streams
# in the child process.
# - Creates thread +wait_thread+ that waits for the child process to exit;
# the thread has method +pid+, which returns the process ID
# of the child process.
#
# With no block given, returns the array
# <tt>[stdin, stdout, wait_thread]</tt>.
# The caller should close each of the two returned streams.
#
# stdin, stdout, wait_thread = Open3.popen2('echo')
# # => [#<IO:fd 6>, #<IO:fd 7>, #<Process::Waiter:0x00007f58d52dbe98 run>]
# stdin.close
# stdout.close
# wait_thread.pid # => 2263572
# wait_thread.value # => #<Process::Status: pid 2263572 exit 0>
#
# With a block given, calls the block with the three variables
# (two streams and the wait thread)
# and returns the block's return value.
# The caller need not close the streams:
#
# Open3.popen2('echo') do |stdin, stdout, wait_thread|
# p stdin
# p stdout
# p wait_thread
# p wait_thread.pid
# p wait_thread.value
# end
#
# Output:
#
# #<IO:fd 6>
# #<IO:fd 7>
# #<Process::Waiter:0x00007f58d59a34b0 sleep>
# 2263636
# #<Process::Status: pid 2263636 exit 0>
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# Unlike Process.spawn, this method waits for the child process to exit
# before returning, so the caller need not do so.
#
# If the first argument is a hash, it becomes leading argument +env+
# in the call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in the call to Process.spawn;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# The single required argument is one of the following:
#
# - +command_line+ if it is a string,
# and if it begins with a shell reserved word or special built-in,
# or if it contains one or more metacharacters.
# - +exe_path+ otherwise.
#
# <b>Argument +command_line+</b>
#
# \String argument +command_line+ is a command line to be passed to a shell;
# it must begin with a shell reserved word, begin with a special built-in,
# or contain meta characters:
#
# Open3.popen2('if true; then echo "Foo"; fi') {|*args| p args } # Shell reserved word.
# Open3.popen2('echo') {|*args| p args } # Built-in.
# Open3.popen2('date > date.tmp') {|*args| p args } # Contains meta character.
#
# Output (similar for each call above):
#
# # => [#<IO:(closed)>, #<IO:(closed)>, #<Process::Waiter:0x00007f7577dfe410 dead>]
#
# The command line may also contain arguments and options for the command:
#
# Open3.popen2('echo "Foo"') { |i, o, t| o.gets }
# "Foo\n"
#
# <b>Argument +exe_path+</b>
#
# Argument +exe_path+ is one of the following:
#
# - The string path to an executable to be called.
# - A 2-element array containing the path to an executable
# and the string to be used as the name of the executing process.
#
# Example:
#
# Open3.popen2('/usr/bin/date') { |i, o, t| o.gets }
# # => "Thu Sep 28 09:41:06 AM CDT 2023\n"
#
# Ruby invokes the executable directly, with no shell and no shell expansion:
#
# Open3.popen2('doesnt_exist') { |i, o, t| o.gets } # Raises Errno::ENOENT
#
# If one or more +args+ is given, each is an argument or option
# to be passed to the executable:
#
# Open3.popen2('echo', 'C #') { |i, o, t| o.gets }
# # => "C #\n"
# Open3.popen2('echo', 'hello', 'world') { |i, o, t| o.gets }
# # => "hello world\n"
#
#
# Related:
#
# - Open3.popen2e: Makes the standard input and the merge
# of the standard output and standard error streams
# of the child process available as separate streams.
# - Open3.popen3: Makes the standard input, standard output,
# and standard error streams
# of the child process available as separate streams.
#
def popen2(*cmd, &block)
if Hash === cmd.last
opts = cmd.pop.dup
else
opts = {}
end
in_r, in_w = IO.pipe
opts[:in] = in_r
in_w.sync = true
out_r, out_w = IO.pipe
opts[:out] = out_w
popen_run(cmd, opts, [in_r, out_w], [in_w, out_r], &block)
end
module_function :popen2
# :call-seq:
# Open3.popen2e([env, ] command_line, options = {}) -> [stdin, stdout_and_stderr, wait_thread]
# Open3.popen2e([env, ] exe_path, *args, options = {}) -> [stdin, stdout_and_stderr, wait_thread]
# Open3.popen2e([env, ] command_line, options = {}) {|stdin, stdout_and_stderr, wait_thread| ... } -> object
# Open3.popen2e([env, ] exe_path, *args, options = {}) {|stdin, stdout_and_stderr, wait_thread| ... } -> object
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process, by calling Process.spawn with the given arguments.
# - Creates streams +stdin+, +stdout_and_stderr+,
# which are the standard input and the merge of the standard output
# and standard error streams in the child process.
# - Creates thread +wait_thread+ that waits for the child process to exit;
# the thread has method +pid+, which returns the process ID
# of the child process.
#
# With no block given, returns the array
# <tt>[stdin, stdout_and_stderr, wait_thread]</tt>.
# The caller should close each of the two returned streams.
#
# stdin, stdout_and_stderr, wait_thread = Open3.popen2e('echo')
# # => [#<IO:fd 6>, #<IO:fd 7>, #<Process::Waiter:0x00007f7577da4398 run>]
# stdin.close
# stdout_and_stderr.close
# wait_thread.pid # => 2274600
# wait_thread.value # => #<Process::Status: pid 2274600 exit 0>
#
# With a block given, calls the block with the three variables
# (two streams and the wait thread)
# and returns the block's return value.
# The caller need not close the streams:
#
# Open3.popen2e('echo') do |stdin, stdout_and_stderr, wait_thread|
# p stdin
# p stdout_and_stderr
# p wait_thread
# p wait_thread.pid
# p wait_thread.value
# end
#
# Output:
#
# #<IO:fd 6>
# #<IO:fd 7>
# #<Process::Waiter:0x00007f75777578c8 sleep>
# 2274763
# #<Process::Status: pid 2274763 exit 0>
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# Unlike Process.spawn, this method waits for the child process to exit
# before returning, so the caller need not do so.
#
# If the first argument is a hash, it becomes leading argument +env+
# in the call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in the call to Process.spawn;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# The single required argument is one of the following:
#
# - +command_line+ if it is a string,
# and if it begins with a shell reserved word or special built-in,
# or if it contains one or more metacharacters.
# - +exe_path+ otherwise.
#
# <b>Argument +command_line+</b>
#
# \String argument +command_line+ is a command line to be passed to a shell;
# it must begin with a shell reserved word, begin with a special built-in,
# or contain meta characters:
#
# Open3.popen2e('if true; then echo "Foo"; fi') {|*args| p args } # Shell reserved word.
# Open3.popen2e('echo') {|*args| p args } # Built-in.
# Open3.popen2e('date > date.tmp') {|*args| p args } # Contains meta character.
#
# Output (similar for each call above):
#
# # => [#<IO:(closed)>, #<IO:(closed)>, #<Process::Waiter:0x00007f7577d8a1f0 dead>]
#
# The command line may also contain arguments and options for the command:
#
# Open3.popen2e('echo "Foo"') { |i, o_and_e, t| o_and_e.gets }
# "Foo\n"
#
# <b>Argument +exe_path+</b>
#
# Argument +exe_path+ is one of the following:
#
# - The string path to an executable to be called.
# - A 2-element array containing the path to an executable
# and the string to be used as the name of the executing process.
#
# Example:
#
# Open3.popen2e('/usr/bin/date') { |i, o_and_e, t| o_and_e.gets }
# # => "Thu Sep 28 01:58:45 PM CDT 2023\n"
#
# Ruby invokes the executable directly, with no shell and no shell expansion:
#
# Open3.popen2e('doesnt_exist') { |i, o_and_e, t| o_and_e.gets } # Raises Errno::ENOENT
#
# If one or more +args+ is given, each is an argument or option
# to be passed to the executable:
#
# Open3.popen2e('echo', 'C #') { |i, o_and_e, t| o_and_e.gets }
# # => "C #\n"
# Open3.popen2e('echo', 'hello', 'world') { |i, o_and_e, t| o_and_e.gets }
# # => "hello world\n"
#
# Related:
#
# - Open3.popen2: Makes the standard input and standard output streams
# of the child process available as separate streams,
# with no access to the standard error stream.
# - Open3.popen3: Makes the standard input, standard output,
# and standard error streams
# of the child process available as separate streams.
#
def popen2e(*cmd, &block)
if Hash === cmd.last
opts = cmd.pop.dup
else
opts = {}
end
in_r, in_w = IO.pipe
opts[:in] = in_r
in_w.sync = true
out_r, out_w = IO.pipe
opts[[:out, :err]] = out_w
popen_run(cmd, opts, [in_r, out_w], [in_w, out_r], &block)
ensure
if block
in_r.close
in_w.close
out_r.close
out_w.close
end
end
module_function :popen2e
def popen_run(cmd, opts, child_io, parent_io) # :nodoc:
pid = spawn(*cmd, opts)
wait_thr = Process.detach(pid)
child_io.each(&:close)
result = [*parent_io, wait_thr]
if defined? yield
begin
return yield(*result)
ensure
parent_io.each(&:close)
wait_thr.join
end
end
result
end
module_function :popen_run
class << self
private :popen_run
end
# :call-seq:
# Open3.capture3([env, ] command_line, options = {}) -> [stdout_s, stderr_s, status]
# Open3.capture3([env, ] exe_path, *args, options = {}) -> [stdout_s, stderr_s, status]
#
# Basically a wrapper for Open3.popen3 that:
#
# - Creates a child process, by calling Open3.popen3 with the given arguments
# (except for certain entries in hash +options+; see below).
# - Returns as strings +stdout_s+ and +stderr_s+ the standard output
# and standard error of the child process.
# - Returns as +status+ a <tt>Process::Status</tt> object
# that represents the exit status of the child process.
#
# Returns the array <tt>[stdout_s, stderr_s, status]</tt>:
#
# stdout_s, stderr_s, status = Open3.capture3('echo "Foo"')
# # => ["Foo\n", "", #<Process::Status: pid 2281954 exit 0>]
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# Unlike Process.spawn, this method waits for the child process to exit
# before returning, so the caller need not do so.
#
# If the first argument is a hash, it becomes leading argument +env+
# in the call to Open3.popen3;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in the call to Open3.popen3;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# The hash +options+ is given;
# two options have local effect in method Open3.capture3:
#
# - If entry <tt>options[:stdin_data]</tt> exists, the entry is removed
# and its string value is sent to the command's standard input:
#
# Open3.capture3('tee', stdin_data: 'Foo')
# # => ["Foo", "", #<Process::Status: pid 2319575 exit 0>]
#
# - If entry <tt>options[:binmode]</tt> exists, the entry is removed and
# the internal streams are set to binary mode.
#
# The single required argument is one of the following:
#
# - +command_line+ if it is a string,
# and if it begins with a shell reserved word or special built-in,
# or if it contains one or more metacharacters.
# - +exe_path+ otherwise.
#
# <b>Argument +command_line+</b>
#
# \String argument +command_line+ is a command line to be passed to a shell;
# it must begin with a shell reserved word, begin with a special built-in,
# or contain meta characters:
#
# Open3.capture3('if true; then echo "Foo"; fi') # Shell reserved word.
# # => ["Foo\n", "", #<Process::Status: pid 2282025 exit 0>]
# Open3.capture3('echo') # Built-in.
# # => ["\n", "", #<Process::Status: pid 2282092 exit 0>]
# Open3.capture3('date > date.tmp') # Contains meta character.
# # => ["", "", #<Process::Status: pid 2282110 exit 0>]
#
# The command line may also contain arguments and options for the command:
#
# Open3.capture3('echo "Foo"')
# # => ["Foo\n", "", #<Process::Status: pid 2282092 exit 0>]
#
# <b>Argument +exe_path+</b>
#
# Argument +exe_path+ is one of the following:
#
# - The string path to an executable to be called.
# - A 2-element array containing the path to an executable
# and the string to be used as the name of the executing process.
#
# Example:
#
# Open3.capture3('/usr/bin/date')
# # => ["Thu Sep 28 05:03:51 PM CDT 2023\n", "", #<Process::Status: pid 2282300 exit 0>]
#
# Ruby invokes the executable directly, with no shell and no shell expansion:
#
# Open3.capture3('doesnt_exist') # Raises Errno::ENOENT
#
# If one or more +args+ is given, each is an argument or option
# to be passed to the executable:
#
# Open3.capture3('echo', 'C #')
# # => ["C #\n", "", #<Process::Status: pid 2282368 exit 0>]
# Open3.capture3('echo', 'hello', 'world')
# # => ["hello world\n", "", #<Process::Status: pid 2282372 exit 0>]
#
def capture3(*cmd)
if Hash === cmd.last
opts = cmd.pop.dup
else
opts = {}
end
stdin_data = opts.delete(:stdin_data) || ''
binmode = opts.delete(:binmode)
popen3(*cmd, opts) {|i, o, e, t|
if binmode
i.binmode
o.binmode
e.binmode
end
out_reader = Thread.new { o.read }
err_reader = Thread.new { e.read }
begin
if stdin_data.respond_to? :readpartial
IO.copy_stream(stdin_data, i)
else
i.write stdin_data
end
rescue Errno::EPIPE
end
i.close
[out_reader.value, err_reader.value, t.value]
}
end
module_function :capture3
# :call-seq:
# Open3.capture2([env, ] command_line, options = {}) -> [stdout_s, status]
# Open3.capture2([env, ] exe_path, *args, options = {}) -> [stdout_s, status]
#
# Basically a wrapper for Open3.popen3 that:
#
# - Creates a child process, by calling Open3.popen3 with the given arguments
# (except for certain entries in hash +options+; see below).
# - Returns as string +stdout_s+ the standard output of the child process.
# - Returns as +status+ a <tt>Process::Status</tt> object
# that represents the exit status of the child process.
#
# Returns the array <tt>[stdout_s, status]</tt>:
#
# stdout_s, status = Open3.capture2('echo "Foo"')
# # => ["Foo\n", #<Process::Status: pid 2326047 exit 0>]
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# Unlike Process.spawn, this method waits for the child process to exit
# before returning, so the caller need not do so.
#
# If the first argument is a hash, it becomes leading argument +env+
# in the call to Open3.popen3;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in the call to Open3.popen3;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# The hash +options+ is given;
# two options have local effect in method Open3.capture2:
#
# - If entry <tt>options[:stdin_data]</tt> exists, the entry is removed
# and its string value is sent to the command's standard input:
#
# Open3.capture2('tee', stdin_data: 'Foo')
#
# # => ["Foo", #<Process::Status: pid 2326087 exit 0>]
#
# - If entry <tt>options[:binmode]</tt> exists, the entry is removed and
# the internal streams are set to binary mode.
#
# The single required argument is one of the following:
#
# - +command_line+ if it is a string,
# and if it begins with a shell reserved word or special built-in,
# or if it contains one or more metacharacters.
# - +exe_path+ otherwise.
#
# <b>Argument +command_line+</b>
#
# \String argument +command_line+ is a command line to be passed to a shell;
# it must begin with a shell reserved word, begin with a special built-in,
# or contain meta characters:
#
# Open3.capture2('if true; then echo "Foo"; fi') # Shell reserved word.
# # => ["Foo\n", #<Process::Status: pid 2326131 exit 0>]
# Open3.capture2('echo') # Built-in.
# # => ["\n", #<Process::Status: pid 2326139 exit 0>]
# Open3.capture2('date > date.tmp') # Contains meta character.
# # => ["", #<Process::Status: pid 2326174 exit 0>]
#
# The command line may also contain arguments and options for the command:
#
# Open3.capture2('echo "Foo"')
# # => ["Foo\n", #<Process::Status: pid 2326183 exit 0>]
#
# <b>Argument +exe_path+</b>
#
# Argument +exe_path+ is one of the following:
#
# - The string path to an executable to be called.
# - A 2-element array containing the path to an executable
# and the string to be used as the name of the executing process.
#
# Example:
#
# Open3.capture2('/usr/bin/date')
# # => ["Fri Sep 29 01:00:39 PM CDT 2023\n", #<Process::Status: pid 2326222 exit 0>]
#
# Ruby invokes the executable directly, with no shell and no shell expansion:
#
# Open3.capture2('doesnt_exist') # Raises Errno::ENOENT
#
# If one or more +args+ is given, each is an argument or option
# to be passed to the executable:
#
# Open3.capture2('echo', 'C #')
# # => ["C #\n", #<Process::Status: pid 2326267 exit 0>]
# Open3.capture2('echo', 'hello', 'world')
# # => ["hello world\n", #<Process::Status: pid 2326299 exit 0>]
#
def capture2(*cmd)
if Hash === cmd.last
opts = cmd.pop.dup
else
opts = {}
end
stdin_data = opts.delete(:stdin_data)
binmode = opts.delete(:binmode)
popen2(*cmd, opts) {|i, o, t|
if binmode
i.binmode
o.binmode
end
out_reader = Thread.new { o.read }
if stdin_data
begin
if stdin_data.respond_to? :readpartial
IO.copy_stream(stdin_data, i)
else
i.write stdin_data
end
rescue Errno::EPIPE
end
end
i.close
[out_reader.value, t.value]
}
end
module_function :capture2
# :call-seq:
# Open3.capture2e([env, ] command_line, options = {}) -> [stdout_and_stderr_s, status]
# Open3.capture2e([env, ] exe_path, *args, options = {}) -> [stdout_and_stderr_s, status]
#
# Basically a wrapper for Open3.popen3 that:
#
# - Creates a child process, by calling Open3.popen3 with the given arguments
# (except for certain entries in hash +options+; see below).
# - Returns as string +stdout_and_stderr_s+ the merged standard output
# and standard error of the child process.
# - Returns as +status+ a <tt>Process::Status</tt> object
# that represents the exit status of the child process.
#
# Returns the array <tt>[stdout_and_stderr_s, status]</tt>:
#
# stdout_and_stderr_s, status = Open3.capture2e('echo "Foo"')
# # => ["Foo\n", #<Process::Status: pid 2371692 exit 0>]
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# Unlike Process.spawn, this method waits for the child process to exit
# before returning, so the caller need not do so.
#
# If the first argument is a hash, it becomes leading argument +env+
# in the call to Open3.popen3;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in the call to Open3.popen3;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# The hash +options+ is given;
# two options have local effect in method Open3.capture2e:
#
# - If entry <tt>options[:stdin_data]</tt> exists, the entry is removed
# and its string value is sent to the command's standard input:
#
# Open3.capture2e('tee', stdin_data: 'Foo')
# # => ["Foo", #<Process::Status: pid 2371732 exit 0>]
#
# - If entry <tt>options[:binmode]</tt> exists, the entry is removed and
# the internal streams are set to binary mode.
#
# The single required argument is one of the following:
#
# - +command_line+ if it is a string,
# and if it begins with a shell reserved word or special built-in,
# or if it contains one or more metacharacters.
# - +exe_path+ otherwise.
#
# <b>Argument +command_line+</b>
#
# \String argument +command_line+ is a command line to be passed to a shell;
# it must begin with a shell reserved word, begin with a special built-in,
# or contain meta characters:
#
# Open3.capture2e('if true; then echo "Foo"; fi') # Shell reserved word.
# # => ["Foo\n", #<Process::Status: pid 2371740 exit 0>]
# Open3.capture2e('echo') # Built-in.
# # => ["\n", #<Process::Status: pid 2371774 exit 0>]
# Open3.capture2e('date > date.tmp') # Contains meta character.
# # => ["", #<Process::Status: pid 2371812 exit 0>]
#
# The command line may also contain arguments and options for the command:
#
# Open3.capture2e('echo "Foo"')
# # => ["Foo\n", #<Process::Status: pid 2326183 exit 0>]
#
# <b>Argument +exe_path+</b>
#
# Argument +exe_path+ is one of the following:
#
# - The string path to an executable to be called.
# - A 2-element array containing the path to an executable
# and the string to be used as the name of the executing process.
#
# Example:
#
# Open3.capture2e('/usr/bin/date')
# # => ["Sat Sep 30 09:01:46 AM CDT 2023\n", #<Process::Status: pid 2371820 exit 0>]
#
# Ruby invokes the executable directly, with no shell and no shell expansion:
#
# Open3.capture2e('doesnt_exist') # Raises Errno::ENOENT
#
# If one or more +args+ is given, each is an argument or option
# to be passed to the executable:
#
# Open3.capture2e('echo', 'C #')
# # => ["C #\n", #<Process::Status: pid 2371856 exit 0>]
# Open3.capture2e('echo', 'hello', 'world')
# # => ["hello world\n", #<Process::Status: pid 2371894 exit 0>]
#
def capture2e(*cmd)
if Hash === cmd.last
opts = cmd.pop.dup
else
opts = {}
end
stdin_data = opts.delete(:stdin_data)
binmode = opts.delete(:binmode)
popen2e(*cmd, opts) {|i, oe, t|
if binmode
i.binmode
oe.binmode
end
outerr_reader = Thread.new { oe.read }
if stdin_data
begin
if stdin_data.respond_to? :readpartial
IO.copy_stream(stdin_data, i)
else
i.write stdin_data
end
rescue Errno::EPIPE
end
end
i.close
[outerr_reader.value, t.value]
}
end
module_function :capture2e
# :call-seq:
# Open3.pipeline_rw([env, ] *cmds, options = {}) -> [first_stdin, last_stdout, wait_threads]
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process for each of the given +cmds+
# by calling Process.spawn.
# - Pipes the +stdout+ from each child to the +stdin+ of the next child,
# or, for the first child, from the caller's +stdin+,
# or, for the last child, to the caller's +stdout+.
#
# The method does not wait for child processes to exit,
# so the caller must do so.
#
# With no block given, returns a 3-element array containing:
#
# - The +stdin+ stream of the first child process.
# - The +stdout+ stream of the last child process.
# - An array of the wait threads for all of the child processes.
#
# Example:
#
# first_stdin, last_stdout, wait_threads = Open3.pipeline_rw('sort', 'cat -n')
# # => [#<IO:fd 20>, #<IO:fd 21>, [#<Process::Waiter:0x000055e8de29ab40 sleep>, #<Process::Waiter:0x000055e8de29a690 sleep>]]
# first_stdin.puts("foo\nbar\nbaz")
# first_stdin.close # Send EOF to sort.
# puts last_stdout.read
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
#
# Output:
#
# 1 bar
# 2 baz
# 3 foo
#
# With a block given, calls the block with the +stdin+ stream of the first child,
# the +stdout+ stream of the last child,
# and an array of the wait processes:
#
# Open3.pipeline_rw('sort', 'cat -n') do |first_stdin, last_stdout, wait_threads|
# first_stdin.puts "foo\nbar\nbaz"
# first_stdin.close # send EOF to sort.
# puts last_stdout.read
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
# end
#
# Output:
#
# 1 bar
# 2 baz
# 3 foo
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# If the first argument is a hash, it becomes leading argument +env+
# in each call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in each call to Process.spawn;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# Each remaining argument in +cmds+ is one of:
#
# - A +command_line+: a string that begins with a shell reserved word
# or special built-in, or contains one or more metacharacters.
# - An +exe_path+: the string path to an executable to be called.
# - An array containing a +command_line+ or an +exe_path+,
# along with zero or more string arguments for the command.
#
# See {Argument command_line or exe_path}[rdoc-ref:Process@Argument+command_line+or+exe_path].
#
def pipeline_rw(*cmds, &block)
if Hash === cmds.last
opts = cmds.pop.dup
else
opts = {}
end
in_r, in_w = IO.pipe
opts[:in] = in_r
in_w.sync = true
out_r, out_w = IO.pipe
opts[:out] = out_w
pipeline_run(cmds, opts, [in_r, out_w], [in_w, out_r], &block)
end
module_function :pipeline_rw
# :call-seq:
# Open3.pipeline_r([env, ] *cmds, options = {}) -> [last_stdout, wait_threads]
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process for each of the given +cmds+
# by calling Process.spawn.
# - Pipes the +stdout+ from each child to the +stdin+ of the next child,
# or, for the last child, to the caller's +stdout+.
#
# The method does not wait for child processes to exit,
# so the caller must do so.
#
# With no block given, returns a 2-element array containing:
#
# - The +stdout+ stream of the last child process.
# - An array of the wait threads for all of the child processes.
#
# Example:
#
# last_stdout, wait_threads = Open3.pipeline_r('ls', 'grep R')
# # => [#<IO:fd 5>, [#<Process::Waiter:0x000055e8de2f9898 dead>, #<Process::Waiter:0x000055e8de2f94b0 sleep>]]
# puts last_stdout.read
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
#
# Output:
#
# Rakefile
# README.md
#
# With a block given, calls the block with the +stdout+ stream
# of the last child process,
# and an array of the wait processes:
#
# Open3.pipeline_r('ls', 'grep R') do |last_stdout, wait_threads|
# puts last_stdout.read
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
# end
#
# Output:
#
# Rakefile
# README.md
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# If the first argument is a hash, it becomes leading argument +env+
# in each call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in each call to Process.spawn;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# Each remaining argument in +cmds+ is one of:
#
# - A +command_line+: a string that begins with a shell reserved word
# or special built-in, or contains one or more metacharacters.
# - An +exe_path+: the string path to an executable to be called.
# - An array containing a +command_line+ or an +exe_path+,
# along with zero or more string arguments for the command.
#
# See {Argument command_line or exe_path}[rdoc-ref:Process@Argument+command_line+or+exe_path].
#
def pipeline_r(*cmds, &block)
if Hash === cmds.last
opts = cmds.pop.dup
else
opts = {}
end
out_r, out_w = IO.pipe
opts[:out] = out_w
pipeline_run(cmds, opts, [out_w], [out_r], &block)
end
module_function :pipeline_r
# :call-seq:
# Open3.pipeline_w([env, ] *cmds, options = {}) -> [first_stdin, wait_threads]
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process for each of the given +cmds+
# by calling Process.spawn.
# - Pipes the +stdout+ from each child to the +stdin+ of the next child,
# or, for the first child, pipes the caller's +stdout+ to the child's +stdin+.
#
# The method does not wait for child processes to exit,
# so the caller must do so.
#
# With no block given, returns a 2-element array containing:
#
# - The +stdin+ stream of the first child process.
# - An array of the wait threads for all of the child processes.
#
# Example:
#
# first_stdin, wait_threads = Open3.pipeline_w('sort', 'cat -n')
# # => [#<IO:fd 7>, [#<Process::Waiter:0x000055e8de928278 run>, #<Process::Waiter:0x000055e8de923e80 run>]]
# first_stdin.puts("foo\nbar\nbaz")
# first_stdin.close # Send EOF to sort.
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
#
# Output:
#
# 1 bar
# 2 baz
# 3 foo
#
# With a block given, calls the block with the +stdin+ stream
# of the first child process,
# and an array of the wait processes:
#
# Open3.pipeline_w('sort', 'cat -n') do |first_stdin, wait_threads|
# first_stdin.puts("foo\nbar\nbaz")
# first_stdin.close # Send EOF to sort.
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
# end
#
# Output:
#
# 1 bar
# 2 baz
# 3 foo
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# If the first argument is a hash, it becomes leading argument +env+
# in each call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in each call to Process.spawn;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# Each remaining argument in +cmds+ is one of:
#
# - A +command_line+: a string that begins with a shell reserved word
# or special built-in, or contains one or more metacharacters.
# - An +exe_path+: the string path to an executable to be called.
# - An array containing a +command_line+ or an +exe_path+,
# along with zero or more string arguments for the command.
#
# See {Argument command_line or exe_path}[rdoc-ref:Process@Argument+command_line+or+exe_path].
#
def pipeline_w(*cmds, &block)
if Hash === cmds.last
opts = cmds.pop.dup
else
opts = {}
end
in_r, in_w = IO.pipe
opts[:in] = in_r
in_w.sync = true
pipeline_run(cmds, opts, [in_r], [in_w], &block)
end
module_function :pipeline_w
# :call-seq:
# Open3.pipeline_start([env, ] *cmds, options = {}) -> [wait_threads]
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process for each of the given +cmds+
# by calling Process.spawn.
# - Does not wait for child processes to exit.
#
# With no block given, returns an array of the wait threads
# for all of the child processes.
#
# Example:
#
# wait_threads = Open3.pipeline_start('ls', 'grep R')
# # => [#<Process::Waiter:0x000055e8de9d2bb0 run>, #<Process::Waiter:0x000055e8de9d2890 run>]
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
#
# Output:
#
# Rakefile
# README.md
#
# With a block given, calls the block with an array of the wait processes:
#
# Open3.pipeline_start('ls', 'grep R') do |wait_threads|
# wait_threads.each do |wait_thread|
# wait_thread.join
# end
# end
#
# Output:
#
# Rakefile
# README.md
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# If the first argument is a hash, it becomes leading argument +env+
# in each call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in each call to Process.spawn;
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# Each remaining argument in +cmds+ is one of:
#
# - A +command_line+: a string that begins with a shell reserved word
# or special built-in, or contains one or more metacharacters.
# - An +exe_path+: the string path to an executable to be called.
# - An array containing a +command_line+ or an +exe_path+,
# along with zero or more string arguments for the command.
#
# See {Argument command_line or exe_path}[rdoc-ref:Process@Argument+command_line+or+exe_path].
#
def pipeline_start(*cmds, &block)
if Hash === cmds.last
opts = cmds.pop.dup
else
opts = {}
end
if block
pipeline_run(cmds, opts, [], [], &block)
else
ts, = pipeline_run(cmds, opts, [], [])
ts
end
end
module_function :pipeline_start
# :call-seq:
# Open3.pipeline([env, ] *cmds, options = {}) -> array_of_statuses
#
# Basically a wrapper for
# {Process.spawn}[rdoc-ref:Process.spawn]
# that:
#
# - Creates a child process for each of the given +cmds+
# by calling Process.spawn.
# - Pipes the +stdout+ from each child to the +stdin+ of the next child,
# or, for the last child, to the caller's +stdout+.
# - Waits for the child processes to exit.
# - Returns an array of Process::Status objects (one for each child).
#
# Example:
#
# wait_threads = Open3.pipeline('ls', 'grep R')
# # => [#<Process::Status: pid 2139200 exit 0>, #<Process::Status: pid 2139202 exit 0>]
#
# Output:
#
# Rakefile
# README.md
#
# Like Process.spawn, this method has potential security vulnerabilities
# if called with untrusted input;
# see {Command Injection}[rdoc-ref:command_injection.rdoc@Command+Injection].
#
# If the first argument is a hash, it becomes leading argument +env+
# in each call to Process.spawn;
# see {Execution Environment}[rdoc-ref:Process@Execution+Environment].
#
# If the last argument is a hash, it becomes trailing argument +options+
# in each call to Process.spawn'
# see {Execution Options}[rdoc-ref:Process@Execution+Options].
#
# Each remaining argument in +cmds+ is one of:
#
# - A +command_line+: a string that begins with a shell reserved word
# or special built-in, or contains one or more metacharacters.
# - An +exe_path+: the string path to an executable to be called.
# - An array containing a +command_line+ or an +exe_path+,
# along with zero or more string arguments for the command.
#
# See {Argument command_line or exe_path}[rdoc-ref:Process@Argument+command_line+or+exe_path].
#
def pipeline(*cmds)
if Hash === cmds.last
opts = cmds.pop.dup
else
opts = {}
end
pipeline_run(cmds, opts, [], []) {|ts|
ts.map(&:value)
}
end
module_function :pipeline
def pipeline_run(cmds, pipeline_opts, child_io, parent_io) # :nodoc:
if cmds.empty?
raise ArgumentError, "no commands"
end
opts_base = pipeline_opts.dup
opts_base.delete :in
opts_base.delete :out
wait_thrs = []
r = nil
cmds.each_with_index {|cmd, i|
cmd_opts = opts_base.dup
if String === cmd
cmd = [cmd]
else
cmd_opts.update cmd.pop if Hash === cmd.last
end
if i == 0
if !cmd_opts.include?(:in)
if pipeline_opts.include?(:in)
cmd_opts[:in] = pipeline_opts[:in]
end
end
else
cmd_opts[:in] = r
end
if i != cmds.length - 1
r2, w2 = IO.pipe
cmd_opts[:out] = w2
else
if !cmd_opts.include?(:out)
if pipeline_opts.include?(:out)
cmd_opts[:out] = pipeline_opts[:out]
end
end
end
pid = spawn(*cmd, cmd_opts)
wait_thrs << Process.detach(pid)
r&.close
w2&.close
r = r2
}
result = parent_io + [wait_thrs]
child_io.each(&:close)
if defined? yield
begin
return yield(*result)
ensure
parent_io.each(&:close)
wait_thrs.each(&:join)
end
end
result
end
module_function :pipeline_run
class << self
private :pipeline_run
end
end
# JRuby uses different popen logic on Windows, require it here to reuse wrapper methods above.
require 'open3/jruby_windows' if RUBY_ENGINE == 'jruby' && JRuby::Util::ON_WINDOWS
share/ruby/openssl/ssl.rb 0000644 00000043022 15173517736 0011460 0 ustar 00 # frozen_string_literal: true
=begin
= Info
'OpenSSL for Ruby 2' project
Copyright (C) 2001 GOTOU YUUZOU <gotoyuzo@notwork.org>
All rights reserved.
= Licence
This program is licensed under the same licence as Ruby.
(See the file 'LICENCE'.)
=end
require "openssl/buffering"
if defined?(OpenSSL::SSL)
require "io/nonblock"
require "ipaddr"
require "socket"
module OpenSSL
module SSL
class SSLContext
DEFAULT_PARAMS = { # :nodoc:
:min_version => OpenSSL::SSL::TLS1_VERSION,
:verify_mode => OpenSSL::SSL::VERIFY_PEER,
:verify_hostname => true,
:options => -> {
opts = OpenSSL::SSL::OP_ALL
opts &= ~OpenSSL::SSL::OP_DONT_INSERT_EMPTY_FRAGMENTS
opts |= OpenSSL::SSL::OP_NO_COMPRESSION
opts
}.call
}
if defined?(OpenSSL::PKey::DH)
DH_ffdhe2048 = OpenSSL::PKey::DH.new <<-_end_of_pem_
-----BEGIN DH PARAMETERS-----
MIIBCAKCAQEA//////////+t+FRYortKmq/cViAnPTzx2LnFg84tNpWp4TZBFGQz
+8yTnc4kmz75fS/jY2MMddj2gbICrsRhetPfHtXV/WVhJDP1H18GbtCFY2VVPe0a
87VXE15/V8k1mE8McODmi3fipona8+/och3xWKE2rec1MKzKT0g6eXq8CrGCsyT7
YdEIqUuyyOP7uWrat2DX9GgdT0Kj3jlN9K5W7edjcrsZCwenyO4KbXCeAvzhzffi
7MA0BM0oNC9hkXL+nOmFg/+OTxIy7vKBg8P+OxtMb61zO7X8vC7CIAXFjvGDfRaD
ssbzSibBsu/6iGtCOGEoXJf//////////wIBAg==
-----END DH PARAMETERS-----
_end_of_pem_
private_constant :DH_ffdhe2048
DEFAULT_TMP_DH_CALLBACK = lambda { |ctx, is_export, keylen| # :nodoc:
warn "using default DH parameters." if $VERBOSE
DH_ffdhe2048
}
end
if !(OpenSSL::OPENSSL_VERSION.start_with?("OpenSSL") &&
OpenSSL::OPENSSL_VERSION_NUMBER >= 0x10100000)
DEFAULT_PARAMS.merge!(
ciphers: %w{
ECDHE-ECDSA-AES128-GCM-SHA256
ECDHE-RSA-AES128-GCM-SHA256
ECDHE-ECDSA-AES256-GCM-SHA384
ECDHE-RSA-AES256-GCM-SHA384
DHE-RSA-AES128-GCM-SHA256
DHE-DSS-AES128-GCM-SHA256
DHE-RSA-AES256-GCM-SHA384
DHE-DSS-AES256-GCM-SHA384
ECDHE-ECDSA-AES128-SHA256
ECDHE-RSA-AES128-SHA256
ECDHE-ECDSA-AES128-SHA
ECDHE-RSA-AES128-SHA
ECDHE-ECDSA-AES256-SHA384
ECDHE-RSA-AES256-SHA384
ECDHE-ECDSA-AES256-SHA
ECDHE-RSA-AES256-SHA
DHE-RSA-AES128-SHA256
DHE-RSA-AES256-SHA256
DHE-RSA-AES128-SHA
DHE-RSA-AES256-SHA
DHE-DSS-AES128-SHA256
DHE-DSS-AES256-SHA256
DHE-DSS-AES128-SHA
DHE-DSS-AES256-SHA
AES128-GCM-SHA256
AES256-GCM-SHA384
AES128-SHA256
AES256-SHA256
AES128-SHA
AES256-SHA
}.join(":"),
)
end
DEFAULT_CERT_STORE = OpenSSL::X509::Store.new # :nodoc:
DEFAULT_CERT_STORE.set_default_paths
DEFAULT_CERT_STORE.flags = OpenSSL::X509::V_FLAG_CRL_CHECK_ALL
# A callback invoked when DH parameters are required for ephemeral DH key
# exchange.
#
# The callback is invoked with the SSLSocket, a
# flag indicating the use of an export cipher and the keylength
# required.
#
# The callback must return an OpenSSL::PKey::DH instance of the correct
# key length.
#
# <b>Deprecated in version 3.0.</b> Use #tmp_dh= instead.
attr_accessor :tmp_dh_callback
# A callback invoked at connect time to distinguish between multiple
# server names.
#
# The callback is invoked with an SSLSocket and a server name. The
# callback must return an SSLContext for the server name or nil.
attr_accessor :servername_cb
# call-seq:
# SSLContext.new -> ctx
# SSLContext.new(:TLSv1) -> ctx
# SSLContext.new("SSLv23") -> ctx
#
# Creates a new SSL context.
#
# If an argument is given, #ssl_version= is called with the value. Note
# that this form is deprecated. New applications should use #min_version=
# and #max_version= as necessary.
def initialize(version = nil)
self.options |= OpenSSL::SSL::OP_ALL
self.ssl_version = version if version
self.verify_mode = OpenSSL::SSL::VERIFY_NONE
self.verify_hostname = false
end
##
# call-seq:
# ctx.set_params(params = {}) -> params
#
# Sets saner defaults optimized for the use with HTTP-like protocols.
#
# If a Hash _params_ is given, the parameters are overridden with it.
# The keys in _params_ must be assignment methods on SSLContext.
#
# If the verify_mode is not VERIFY_NONE and ca_file, ca_path and
# cert_store are not set then the system default certificate store is
# used.
def set_params(params={})
params = DEFAULT_PARAMS.merge(params)
self.options = params.delete(:options) # set before min_version/max_version
params.each{|name, value| self.__send__("#{name}=", value) }
if self.verify_mode != OpenSSL::SSL::VERIFY_NONE
unless self.ca_file or self.ca_path or self.cert_store
self.cert_store = DEFAULT_CERT_STORE
end
end
return params
end
# call-seq:
# ctx.min_version = OpenSSL::SSL::TLS1_2_VERSION
# ctx.min_version = :TLS1_2
# ctx.min_version = nil
#
# Sets the lower bound on the supported SSL/TLS protocol version. The
# version may be specified by an integer constant named
# OpenSSL::SSL::*_VERSION, a Symbol, or +nil+ which means "any version".
#
# Be careful that you don't overwrite OpenSSL::SSL::OP_NO_{SSL,TLS}v*
# options by #options= once you have called #min_version= or
# #max_version=.
#
# === Example
# ctx = OpenSSL::SSL::SSLContext.new
# ctx.min_version = OpenSSL::SSL::TLS1_1_VERSION
# ctx.max_version = OpenSSL::SSL::TLS1_2_VERSION
#
# sock = OpenSSL::SSL::SSLSocket.new(tcp_sock, ctx)
# sock.connect # Initiates a connection using either TLS 1.1 or TLS 1.2
def min_version=(version)
set_minmax_proto_version(version, @max_proto_version ||= nil)
@min_proto_version = version
end
# call-seq:
# ctx.max_version = OpenSSL::SSL::TLS1_2_VERSION
# ctx.max_version = :TLS1_2
# ctx.max_version = nil
#
# Sets the upper bound of the supported SSL/TLS protocol version. See
# #min_version= for the possible values.
def max_version=(version)
set_minmax_proto_version(@min_proto_version ||= nil, version)
@max_proto_version = version
end
# call-seq:
# ctx.ssl_version = :TLSv1
# ctx.ssl_version = "SSLv23"
#
# Sets the SSL/TLS protocol version for the context. This forces
# connections to use only the specified protocol version. This is
# deprecated and only provided for backwards compatibility. Use
# #min_version= and #max_version= instead.
#
# === History
# As the name hints, this used to call the SSL_CTX_set_ssl_version()
# function which sets the SSL method used for connections created from
# the context. As of Ruby/OpenSSL 2.1, this accessor method is
# implemented to call #min_version= and #max_version= instead.
def ssl_version=(meth)
meth = meth.to_s if meth.is_a?(Symbol)
if /(?<type>_client|_server)\z/ =~ meth
meth = $`
if $VERBOSE
warn "#{caller(1, 1)[0]}: method type #{type.inspect} is ignored"
end
end
version = METHODS_MAP[meth.intern] or
raise ArgumentError, "unknown SSL method `%s'" % meth
set_minmax_proto_version(version, version)
@min_proto_version = @max_proto_version = version
end
METHODS_MAP = {
SSLv23: 0,
SSLv2: OpenSSL::SSL::SSL2_VERSION,
SSLv3: OpenSSL::SSL::SSL3_VERSION,
TLSv1: OpenSSL::SSL::TLS1_VERSION,
TLSv1_1: OpenSSL::SSL::TLS1_1_VERSION,
TLSv1_2: OpenSSL::SSL::TLS1_2_VERSION,
}.freeze
private_constant :METHODS_MAP
# The list of available SSL/TLS methods. This constant is only provided
# for backwards compatibility.
METHODS = METHODS_MAP.flat_map { |name,|
[name, :"#{name}_client", :"#{name}_server"]
}.freeze
deprecate_constant :METHODS
end
module SocketForwarder
# The file descriptor for the socket.
def fileno
to_io.fileno
end
def addr
to_io.addr
end
def peeraddr
to_io.peeraddr
end
def setsockopt(level, optname, optval)
to_io.setsockopt(level, optname, optval)
end
def getsockopt(level, optname)
to_io.getsockopt(level, optname)
end
def fcntl(*args)
to_io.fcntl(*args)
end
def closed?
to_io.closed?
end
def do_not_reverse_lookup=(flag)
to_io.do_not_reverse_lookup = flag
end
end
def verify_certificate_identity(cert, hostname)
should_verify_common_name = true
cert.extensions.each{|ext|
next if ext.oid != "subjectAltName"
ostr = OpenSSL::ASN1.decode(ext.to_der).value.last
sequence = OpenSSL::ASN1.decode(ostr.value)
sequence.value.each{|san|
case san.tag
when 2 # dNSName in GeneralName (RFC5280)
should_verify_common_name = false
return true if verify_hostname(hostname, san.value)
when 7 # iPAddress in GeneralName (RFC5280)
should_verify_common_name = false
if san.value.size == 4 || san.value.size == 16
begin
return true if san.value == IPAddr.new(hostname).hton
rescue IPAddr::InvalidAddressError
end
end
end
}
}
if should_verify_common_name
cert.subject.to_a.each{|oid, value|
if oid == "CN"
return true if verify_hostname(hostname, value)
end
}
end
return false
end
module_function :verify_certificate_identity
def verify_hostname(hostname, san) # :nodoc:
# RFC 5280, IA5String is limited to the set of ASCII characters
return false unless san.ascii_only?
return false unless hostname.ascii_only?
# See RFC 6125, section 6.4.1
# Matching is case-insensitive.
san_parts = san.downcase.split(".")
# TODO: this behavior should probably be more strict
return san == hostname if san_parts.size < 2
# Matching is case-insensitive.
host_parts = hostname.downcase.split(".")
# RFC 6125, section 6.4.3, subitem 2.
# If the wildcard character is the only character of the left-most
# label in the presented identifier, the client SHOULD NOT compare
# against anything but the left-most label of the reference
# identifier (e.g., *.example.com would match foo.example.com but
# not bar.foo.example.com or example.com).
return false unless san_parts.size == host_parts.size
# RFC 6125, section 6.4.3, subitem 1.
# The client SHOULD NOT attempt to match a presented identifier in
# which the wildcard character comprises a label other than the
# left-most label (e.g., do not match bar.*.example.net).
return false unless verify_wildcard(host_parts.shift, san_parts.shift)
san_parts.join(".") == host_parts.join(".")
end
module_function :verify_hostname
def verify_wildcard(domain_component, san_component) # :nodoc:
parts = san_component.split("*", -1)
return false if parts.size > 2
return san_component == domain_component if parts.size == 1
# RFC 6125, section 6.4.3, subitem 3.
# The client SHOULD NOT attempt to match a presented identifier
# where the wildcard character is embedded within an A-label or
# U-label of an internationalized domain name.
return false if domain_component.start_with?("xn--") && san_component != "*"
parts[0].length + parts[1].length < domain_component.length &&
domain_component.start_with?(parts[0]) &&
domain_component.end_with?(parts[1])
end
module_function :verify_wildcard
class SSLSocket
include Buffering
include SocketForwarder
attr_reader :hostname
# The underlying IO object.
attr_reader :io
alias :to_io :io
# The SSLContext object used in this connection.
attr_reader :context
# Whether to close the underlying socket as well, when the SSL/TLS
# connection is shut down. This defaults to +false+.
attr_accessor :sync_close
# call-seq:
# ssl.sysclose => nil
#
# Sends "close notify" to the peer and tries to shut down the SSL
# connection gracefully.
#
# If sync_close is set to +true+, the underlying IO is also closed.
def sysclose
return if closed?
stop
io.close if sync_close
end
# call-seq:
# ssl.post_connection_check(hostname) -> true
#
# Perform hostname verification following RFC 6125.
#
# This method MUST be called after calling #connect to ensure that the
# hostname of a remote peer has been verified.
def post_connection_check(hostname)
if peer_cert.nil?
msg = "Peer verification enabled, but no certificate received."
if using_anon_cipher?
msg += " Anonymous cipher suite #{cipher[0]} was negotiated. " \
"Anonymous suites must be disabled to use peer verification."
end
raise SSLError, msg
end
unless OpenSSL::SSL.verify_certificate_identity(peer_cert, hostname)
raise SSLError, "hostname \"#{hostname}\" does not match the server certificate"
end
return true
end
# call-seq:
# ssl.session -> aSession
#
# Returns the SSLSession object currently used, or nil if the session is
# not established.
def session
SSL::Session.new(self)
rescue SSL::Session::SessionError
nil
end
private
def using_anon_cipher?
ctx = OpenSSL::SSL::SSLContext.new
ctx.ciphers = "aNULL"
ctx.ciphers.include?(cipher)
end
def client_cert_cb
@context.client_cert_cb
end
def tmp_dh_callback
@context.tmp_dh_callback || OpenSSL::SSL::SSLContext::DEFAULT_TMP_DH_CALLBACK
end
def session_new_cb
@context.session_new_cb
end
def session_get_cb
@context.session_get_cb
end
class << self
# call-seq:
# open(remote_host, remote_port, local_host=nil, local_port=nil, context: nil)
#
# Creates a new instance of SSLSocket.
# _remote\_host_ and _remote\_port_ are used to open TCPSocket.
# If _local\_host_ and _local\_port_ are specified,
# then those parameters are used on the local end to establish the connection.
# If _context_ is provided,
# the SSL Sockets initial params will be taken from the context.
#
# === Examples
#
# sock = OpenSSL::SSL::SSLSocket.open('localhost', 443)
# sock.connect # Initiates a connection to localhost:443
#
# with SSLContext:
#
# ctx = OpenSSL::SSL::SSLContext.new
# sock = OpenSSL::SSL::SSLSocket.open('localhost', 443, context: ctx)
# sock.connect # Initiates a connection to localhost:443 with SSLContext
def open(remote_host, remote_port, local_host=nil, local_port=nil, context: nil)
sock = ::TCPSocket.open(remote_host, remote_port, local_host, local_port)
if context.nil?
return OpenSSL::SSL::SSLSocket.new(sock)
else
return OpenSSL::SSL::SSLSocket.new(sock, context)
end
end
end
end
##
# SSLServer represents a TCP/IP server socket with Secure Sockets Layer.
class SSLServer
include SocketForwarder
# When true then #accept works exactly the same as TCPServer#accept
attr_accessor :start_immediately
# Creates a new instance of SSLServer.
# * _srv_ is an instance of TCPServer.
# * _ctx_ is an instance of OpenSSL::SSL::SSLContext.
def initialize(svr, ctx)
@svr = svr
@ctx = ctx
unless ctx.session_id_context
# see #6137 - session id may not exceed 32 bytes
prng = ::Random.new($0.hash)
session_id = prng.bytes(16).unpack1('H*')
@ctx.session_id_context = session_id
end
@start_immediately = true
end
# Returns the TCPServer passed to the SSLServer when initialized.
def to_io
@svr
end
# See TCPServer#listen for details.
def listen(backlog=Socket::SOMAXCONN)
@svr.listen(backlog)
end
# See BasicSocket#shutdown for details.
def shutdown(how=Socket::SHUT_RDWR)
@svr.shutdown(how)
end
# Works similar to TCPServer#accept.
def accept
# Socket#accept returns [socket, addrinfo].
# TCPServer#accept returns a socket.
# The following comma strips addrinfo.
sock, = @svr.accept
begin
ssl = OpenSSL::SSL::SSLSocket.new(sock, @ctx)
ssl.sync_close = true
ssl.accept if @start_immediately
ssl
rescue Exception => ex
if ssl
ssl.close
else
sock.close
end
raise ex
end
end
# See IO#close for details.
def close
@svr.close
end
end
end
end
end
share/ruby/openssl/hmac.rb 0000644 00000004774 15173517736 0011602 0 ustar 00 # frozen_string_literal: true
module OpenSSL
class HMAC
# Securely compare with another HMAC instance in constant time.
def ==(other)
return false unless HMAC === other
return false unless self.digest.bytesize == other.digest.bytesize
OpenSSL.fixed_length_secure_compare(self.digest, other.digest)
end
# :call-seq:
# hmac.base64digest -> string
#
# Returns the authentication code an a Base64-encoded string.
def base64digest
[digest].pack("m0")
end
class << self
# :call-seq:
# HMAC.digest(digest, key, data) -> aString
#
# Returns the authentication code as a binary string. The _digest_ parameter
# specifies the digest algorithm to use. This may be a String representing
# the algorithm name or an instance of OpenSSL::Digest.
#
# === Example
# key = 'key'
# data = 'The quick brown fox jumps over the lazy dog'
#
# hmac = OpenSSL::HMAC.digest('SHA1', key, data)
# #=> "\xDE|\x9B\x85\xB8\xB7\x8A\xA6\xBC\x8Az6\xF7\n\x90p\x1C\x9D\xB4\xD9"
def digest(digest, key, data)
hmac = new(key, digest)
hmac << data
hmac.digest
end
# :call-seq:
# HMAC.hexdigest(digest, key, data) -> aString
#
# Returns the authentication code as a hex-encoded string. The _digest_
# parameter specifies the digest algorithm to use. This may be a String
# representing the algorithm name or an instance of OpenSSL::Digest.
#
# === Example
# key = 'key'
# data = 'The quick brown fox jumps over the lazy dog'
#
# hmac = OpenSSL::HMAC.hexdigest('SHA1', key, data)
# #=> "de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9"
def hexdigest(digest, key, data)
hmac = new(key, digest)
hmac << data
hmac.hexdigest
end
# :call-seq:
# HMAC.base64digest(digest, key, data) -> aString
#
# Returns the authentication code as a Base64-encoded string. The _digest_
# parameter specifies the digest algorithm to use. This may be a String
# representing the algorithm name or an instance of OpenSSL::Digest.
#
# === Example
# key = 'key'
# data = 'The quick brown fox jumps over the lazy dog'
#
# hmac = OpenSSL::HMAC.base64digest('SHA1', key, data)
# #=> "3nybhbi3iqa8ino29wqQcBydtNk="
def base64digest(digest, key, data)
[digest(digest, key, data)].pack("m0")
end
end
end
end
share/ruby/openssl/marshal.rb 0000644 00000001070 15173517736 0012303 0 ustar 00 # frozen_string_literal: true
#--
# = Ruby-space definitions to add DER (de)serialization to classes
#
# = Info
# 'OpenSSL for Ruby 2' project
# Copyright (C) 2002 Michal Rokos <m.rokos@sh.cvut.cz>
# All rights reserved.
#
# = Licence
# This program is licensed under the same licence as Ruby.
# (See the file 'LICENCE'.)
#++
module OpenSSL
module Marshal
def self.included(base)
base.extend(ClassMethods)
end
module ClassMethods
def _load(string)
new(string)
end
end
def _dump(_level)
to_der
end
end
end
share/ruby/openssl/pkcs5.rb 0000644 00000001145 15173517736 0011704 0 ustar 00 # frozen_string_literal: true
#--
# Ruby/OpenSSL Project
# Copyright (C) 2017 Ruby/OpenSSL Project Authors
#++
module OpenSSL
module PKCS5
module_function
# OpenSSL::PKCS5.pbkdf2_hmac has been renamed to OpenSSL::KDF.pbkdf2_hmac.
# This method is provided for backwards compatibility.
def pbkdf2_hmac(pass, salt, iter, keylen, digest)
OpenSSL::KDF.pbkdf2_hmac(pass, salt: salt, iterations: iter,
length: keylen, hash: digest)
end
def pbkdf2_hmac_sha1(pass, salt, iter, keylen)
pbkdf2_hmac(pass, salt, iter, keylen, "sha1")
end
end
end
share/ruby/openssl/buffering.rb 0000644 00000024236 15173517736 0012634 0 ustar 00 # coding: binary
# frozen_string_literal: true
#--
#= Info
# 'OpenSSL for Ruby 2' project
# Copyright (C) 2001 GOTOU YUUZOU <gotoyuzo@notwork.org>
# All rights reserved.
#
#= Licence
# This program is licensed under the same licence as Ruby.
# (See the file 'LICENCE'.)
#++
##
# OpenSSL IO buffering mix-in module.
#
# This module allows an OpenSSL::SSL::SSLSocket to behave like an IO.
#
# You typically won't use this module directly, you can see it implemented in
# OpenSSL::SSL::SSLSocket.
module OpenSSL::Buffering
include Enumerable
# A buffer which will retain binary encoding.
class Buffer < String
BINARY = Encoding::BINARY
def initialize
super
force_encoding(BINARY)
end
def << string
if string.encoding == BINARY
super(string)
else
super(string.b)
end
return self
end
alias concat <<
end
##
# The "sync mode" of the SSLSocket.
#
# See IO#sync for full details.
attr_accessor :sync
##
# Default size to read from or write to the SSLSocket for buffer operations.
BLOCK_SIZE = 1024*16
##
# Creates an instance of OpenSSL's buffering IO module.
def initialize(*)
super
@eof = false
@rbuffer = Buffer.new
@sync = @io.sync
end
#
# for reading.
#
private
##
# Fills the buffer from the underlying SSLSocket
def fill_rbuff
begin
@rbuffer << self.sysread(BLOCK_SIZE)
rescue Errno::EAGAIN
retry
rescue EOFError
@eof = true
end
end
##
# Consumes _size_ bytes from the buffer
def consume_rbuff(size=nil)
if @rbuffer.empty?
nil
else
size = @rbuffer.size unless size
@rbuffer.slice!(0, size)
end
end
public
# call-seq:
# ssl.getbyte => 81
#
# Get the next 8bit byte from `ssl`. Returns `nil` on EOF
def getbyte
read(1)&.ord
end
##
# Reads _size_ bytes from the stream. If _buf_ is provided it must
# reference a string which will receive the data.
#
# See IO#read for full details.
def read(size=nil, buf=nil)
if size == 0
if buf
buf.clear
return buf
else
return ""
end
end
until @eof
break if size && size <= @rbuffer.size
fill_rbuff
end
ret = consume_rbuff(size) || ""
if buf
buf.replace(ret)
ret = buf
end
(size && ret.empty?) ? nil : ret
end
##
# Reads at most _maxlen_ bytes from the stream. If _buf_ is provided it
# must reference a string which will receive the data.
#
# See IO#readpartial for full details.
def readpartial(maxlen, buf=nil)
if maxlen == 0
if buf
buf.clear
return buf
else
return ""
end
end
if @rbuffer.empty?
begin
return sysread(maxlen, buf)
rescue Errno::EAGAIN
retry
end
end
ret = consume_rbuff(maxlen)
if buf
buf.replace(ret)
ret = buf
end
ret
end
##
# Reads at most _maxlen_ bytes in the non-blocking manner.
#
# When no data can be read without blocking it raises
# OpenSSL::SSL::SSLError extended by IO::WaitReadable or IO::WaitWritable.
#
# IO::WaitReadable means SSL needs to read internally so read_nonblock
# should be called again when the underlying IO is readable.
#
# IO::WaitWritable means SSL needs to write internally so read_nonblock
# should be called again after the underlying IO is writable.
#
# OpenSSL::Buffering#read_nonblock needs two rescue clause as follows:
#
# # emulates blocking read (readpartial).
# begin
# result = ssl.read_nonblock(maxlen)
# rescue IO::WaitReadable
# IO.select([io])
# retry
# rescue IO::WaitWritable
# IO.select(nil, [io])
# retry
# end
#
# Note that one reason that read_nonblock writes to the underlying IO is
# when the peer requests a new TLS/SSL handshake. See openssl the FAQ for
# more details. http://www.openssl.org/support/faq.html
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that read_nonblock should not raise an IO::Wait*able exception, but
# return the symbol +:wait_writable+ or +:wait_readable+ instead. At EOF,
# it will return +nil+ instead of raising EOFError.
def read_nonblock(maxlen, buf=nil, exception: true)
if maxlen == 0
if buf
buf.clear
return buf
else
return ""
end
end
if @rbuffer.empty?
return sysread_nonblock(maxlen, buf, exception: exception)
end
ret = consume_rbuff(maxlen)
if buf
buf.replace(ret)
ret = buf
end
ret
end
##
# Reads the next "line" from the stream. Lines are separated by _eol_. If
# _limit_ is provided the result will not be longer than the given number of
# bytes.
#
# _eol_ may be a String or Regexp.
#
# Unlike IO#gets the line read will not be assigned to +$_+.
#
# Unlike IO#gets the separator must be provided if a limit is provided.
def gets(eol=$/, limit=nil)
idx = @rbuffer.index(eol)
until @eof
break if idx
fill_rbuff
idx = @rbuffer.index(eol)
end
if eol.is_a?(Regexp)
size = idx ? idx+$&.size : nil
else
size = idx ? idx+eol.size : nil
end
if size && limit && limit >= 0
size = [size, limit].min
end
consume_rbuff(size)
end
##
# Executes the block for every line in the stream where lines are separated
# by _eol_.
#
# See also #gets
def each(eol=$/)
while line = self.gets(eol)
yield line
end
end
alias each_line each
##
# Reads lines from the stream which are separated by _eol_.
#
# See also #gets
def readlines(eol=$/)
ary = []
while line = self.gets(eol)
ary << line
end
ary
end
##
# Reads a line from the stream which is separated by _eol_.
#
# Raises EOFError if at end of file.
def readline(eol=$/)
raise EOFError if eof?
gets(eol)
end
##
# Reads one character from the stream. Returns nil if called at end of
# file.
def getc
read(1)
end
##
# Calls the given block once for each byte in the stream.
def each_byte # :yields: byte
while c = getc
yield(c.ord)
end
end
##
# Reads a one-character string from the stream. Raises an EOFError at end
# of file.
def readchar
raise EOFError if eof?
getc
end
##
# Pushes character _c_ back onto the stream such that a subsequent buffered
# character read will return it.
#
# Unlike IO#getc multiple bytes may be pushed back onto the stream.
#
# Has no effect on unbuffered reads (such as #sysread).
def ungetc(c)
@rbuffer[0,0] = c.chr
end
##
# Returns true if the stream is at file which means there is no more data to
# be read.
def eof?
fill_rbuff if !@eof && @rbuffer.empty?
@eof && @rbuffer.empty?
end
alias eof eof?
#
# for writing.
#
private
##
# Writes _s_ to the buffer. When the buffer is full or #sync is true the
# buffer is flushed to the underlying socket.
def do_write(s)
@wbuffer = Buffer.new unless defined? @wbuffer
@wbuffer << s
@wbuffer.force_encoding(Encoding::BINARY)
@sync ||= false
if @sync or @wbuffer.size > BLOCK_SIZE
until @wbuffer.empty?
begin
nwrote = syswrite(@wbuffer)
rescue Errno::EAGAIN
retry
end
@wbuffer[0, nwrote] = ""
end
end
end
public
##
# Writes _s_ to the stream. If the argument is not a String it will be
# converted using +.to_s+ method. Returns the number of bytes written.
def write(*s)
s.inject(0) do |written, str|
do_write(str)
written + str.bytesize
end
end
##
# Writes _s_ in the non-blocking manner.
#
# If there is buffered data, it is flushed first. This may block.
#
# write_nonblock returns number of bytes written to the SSL connection.
#
# When no data can be written without blocking it raises
# OpenSSL::SSL::SSLError extended by IO::WaitReadable or IO::WaitWritable.
#
# IO::WaitReadable means SSL needs to read internally so write_nonblock
# should be called again after the underlying IO is readable.
#
# IO::WaitWritable means SSL needs to write internally so write_nonblock
# should be called again after underlying IO is writable.
#
# So OpenSSL::Buffering#write_nonblock needs two rescue clause as follows.
#
# # emulates blocking write.
# begin
# result = ssl.write_nonblock(str)
# rescue IO::WaitReadable
# IO.select([io])
# retry
# rescue IO::WaitWritable
# IO.select(nil, [io])
# retry
# end
#
# Note that one reason that write_nonblock reads from the underlying IO
# is when the peer requests a new TLS/SSL handshake. See the openssl FAQ
# for more details. http://www.openssl.org/support/faq.html
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that write_nonblock should not raise an IO::Wait*able exception, but
# return the symbol +:wait_writable+ or +:wait_readable+ instead.
def write_nonblock(s, exception: true)
flush
syswrite_nonblock(s, exception: exception)
end
##
# Writes _s_ to the stream. _s_ will be converted to a String using
# +.to_s+ method.
def <<(s)
do_write(s)
self
end
##
# Writes _args_ to the stream along with a record separator.
#
# See IO#puts for full details.
def puts(*args)
s = Buffer.new
if args.empty?
s << "\n"
end
args.each{|arg|
s << arg.to_s
s.sub!(/(?<!\n)\z/, "\n")
}
do_write(s)
nil
end
##
# Writes _args_ to the stream.
#
# See IO#print for full details.
def print(*args)
s = Buffer.new
args.each{ |arg| s << arg.to_s }
do_write(s)
nil
end
##
# Formats and writes to the stream converting parameters under control of
# the format string.
#
# See Kernel#sprintf for format string details.
def printf(s, *args)
do_write(s % args)
nil
end
##
# Flushes buffered data to the SSLSocket.
def flush
osync = @sync
@sync = true
do_write ""
return self
ensure
@sync = osync
end
##
# Closes the SSLSocket and flushes any unwritten data.
def close
flush rescue nil
sysclose
end
end
share/ruby/openssl/digest.rb 0000644 00000003054 15173517736 0012137 0 ustar 00 # frozen_string_literal: true
#--
# = Ruby-space predefined Digest subclasses
#
# = Info
# 'OpenSSL for Ruby 2' project
# Copyright (C) 2002 Michal Rokos <m.rokos@sh.cvut.cz>
# All rights reserved.
#
# = Licence
# This program is licensed under the same licence as Ruby.
# (See the file 'LICENCE'.)
#++
module OpenSSL
class Digest
# Return the hash value computed with _name_ Digest. _name_ is either the
# long name or short name of a supported digest algorithm.
#
# === Example
#
# OpenSSL::Digest.digest("SHA256", "abc")
def self.digest(name, data)
super(data, name)
end
%w(MD4 MD5 RIPEMD160 SHA1 SHA224 SHA256 SHA384 SHA512).each do |name|
klass = Class.new(self) {
define_method(:initialize, ->(data = nil) {super(name, data)})
}
singleton = (class << klass; self; end)
singleton.class_eval{
define_method(:digest) {|data| new.digest(data)}
define_method(:hexdigest) {|data| new.hexdigest(data)}
}
const_set(name.tr('-', '_'), klass)
end
# Deprecated.
#
# This class is only provided for backwards compatibility.
# Use OpenSSL::Digest instead.
class Digest < Digest; end # :nodoc:
deprecate_constant :Digest
end # Digest
# Returns a Digest subclass by _name_
#
# require 'openssl'
#
# OpenSSL::Digest("MD5")
# # => OpenSSL::Digest::MD5
#
# Digest("Foo")
# # => NameError: wrong constant name Foo
def Digest(name)
OpenSSL::Digest.const_get(name)
end
module_function :Digest
end # OpenSSL
share/ruby/openssl/version.rb 0000644 00000000106 15173517736 0012340 0 ustar 00 # frozen_string_literal: true
module OpenSSL
VERSION = "3.2.0"
end
share/ruby/openssl/cipher.rb 0000644 00000003320 15173517736 0012126 0 ustar 00 # frozen_string_literal: true
#--
# = Ruby-space predefined Cipher subclasses
#
# = Info
# 'OpenSSL for Ruby 2' project
# Copyright (C) 2002 Michal Rokos <m.rokos@sh.cvut.cz>
# All rights reserved.
#
# = Licence
# This program is licensed under the same licence as Ruby.
# (See the file 'LICENCE'.)
#++
module OpenSSL
class Cipher
%w(AES CAST5 BF DES IDEA RC2 RC4 RC5).each{|name|
klass = Class.new(Cipher){
define_method(:initialize){|*args|
cipher_name = args.inject(name){|n, arg| "#{n}-#{arg}" }
super(cipher_name.downcase)
}
}
const_set(name, klass)
}
%w(128 192 256).each{|keylen|
klass = Class.new(Cipher){
define_method(:initialize){|mode = "CBC"|
super("aes-#{keylen}-#{mode}".downcase)
}
}
const_set("AES#{keylen}", klass)
}
# call-seq:
# cipher.random_key -> key
#
# Generate a random key with OpenSSL::Random.random_bytes and sets it to
# the cipher, and returns it.
#
# You must call #encrypt or #decrypt before calling this method.
def random_key
str = OpenSSL::Random.random_bytes(self.key_len)
self.key = str
end
# call-seq:
# cipher.random_iv -> iv
#
# Generate a random IV with OpenSSL::Random.random_bytes and sets it to the
# cipher, and returns it.
#
# You must call #encrypt or #decrypt before calling this method.
def random_iv
str = OpenSSL::Random.random_bytes(self.iv_len)
self.iv = str
end
# Deprecated.
#
# This class is only provided for backwards compatibility.
# Use OpenSSL::Cipher.
class Cipher < Cipher; end
deprecate_constant :Cipher
end # Cipher
end # OpenSSL
share/ruby/openssl/pkey.rb 0000644 00000035416 15173517736 0011637 0 ustar 00 # frozen_string_literal: true
#--
# Ruby/OpenSSL Project
# Copyright (C) 2017 Ruby/OpenSSL Project Authors
#++
require_relative 'marshal'
module OpenSSL::PKey
class DH
include OpenSSL::Marshal
# :call-seq:
# dh.public_key -> dhnew
#
# Returns a new DH instance that carries just the \DH parameters.
#
# Contrary to the method name, the returned DH object contains only
# parameters and not the public key.
#
# This method is provided for backwards compatibility. In most cases, there
# is no need to call this method.
#
# For the purpose of re-generating the key pair while keeping the
# parameters, check OpenSSL::PKey.generate_key.
#
# Example:
# # OpenSSL::PKey::DH.generate by default generates a random key pair
# dh1 = OpenSSL::PKey::DH.generate(2048)
# p dh1.priv_key #=> #<OpenSSL::BN 1288347...>
# dhcopy = dh1.public_key
# p dhcopy.priv_key #=> nil
def public_key
DH.new(to_der)
end
# :call-seq:
# dh.compute_key(pub_bn) -> string
#
# Returns a String containing a shared secret computed from the other
# party's public value.
#
# This method is provided for backwards compatibility, and calls #derive
# internally.
#
# === Parameters
# * _pub_bn_ is a OpenSSL::BN, *not* the DH instance returned by
# DH#public_key as that contains the DH parameters only.
def compute_key(pub_bn)
# FIXME: This is constructing an X.509 SubjectPublicKeyInfo and is very
# inefficient
obj = OpenSSL::ASN1.Sequence([
OpenSSL::ASN1.Sequence([
OpenSSL::ASN1.ObjectId("dhKeyAgreement"),
OpenSSL::ASN1.Sequence([
OpenSSL::ASN1.Integer(p),
OpenSSL::ASN1.Integer(g),
]),
]),
OpenSSL::ASN1.BitString(OpenSSL::ASN1.Integer(pub_bn).to_der),
])
derive(OpenSSL::PKey.read(obj.to_der))
end
# :call-seq:
# dh.generate_key! -> self
#
# Generates a private and public key unless a private key already exists.
# If this DH instance was generated from public \DH parameters (e.g. by
# encoding the result of DH#public_key), then this method needs to be
# called first in order to generate the per-session keys before performing
# the actual key exchange.
#
# <b>Deprecated in version 3.0</b>. This method is incompatible with
# OpenSSL 3.0.0 or later.
#
# See also OpenSSL::PKey.generate_key.
#
# Example:
# # DEPRECATED USAGE: This will not work on OpenSSL 3.0 or later
# dh0 = OpenSSL::PKey::DH.new(2048)
# dh = dh0.public_key # #public_key only copies the DH parameters (contrary to the name)
# dh.generate_key!
# puts dh.private? # => true
# puts dh0.pub_key == dh.pub_key #=> false
#
# # With OpenSSL::PKey.generate_key
# dh0 = OpenSSL::PKey::DH.new(2048)
# dh = OpenSSL::PKey.generate_key(dh0)
# puts dh0.pub_key == dh.pub_key #=> false
def generate_key!
if OpenSSL::OPENSSL_VERSION_NUMBER >= 0x30000000
raise DHError, "OpenSSL::PKey::DH is immutable on OpenSSL 3.0; " \
"use OpenSSL::PKey.generate_key instead"
end
unless priv_key
tmp = OpenSSL::PKey.generate_key(self)
set_key(tmp.pub_key, tmp.priv_key)
end
self
end
class << self
# :call-seq:
# DH.generate(size, generator = 2) -> dh
#
# Creates a new DH instance from scratch by generating random parameters
# and a key pair.
#
# See also OpenSSL::PKey.generate_parameters and
# OpenSSL::PKey.generate_key.
#
# +size+::
# The desired key size in bits.
# +generator+::
# The generator.
def generate(size, generator = 2, &blk)
dhparams = OpenSSL::PKey.generate_parameters("DH", {
"dh_paramgen_prime_len" => size,
"dh_paramgen_generator" => generator,
}, &blk)
OpenSSL::PKey.generate_key(dhparams)
end
# Handle DH.new(size, generator) form here; new(str) and new() forms
# are handled by #initialize
def new(*args, &blk) # :nodoc:
if args[0].is_a?(Integer)
generate(*args, &blk)
else
super
end
end
end
end
class DSA
include OpenSSL::Marshal
# :call-seq:
# dsa.public_key -> dsanew
#
# Returns a new DSA instance that carries just the \DSA parameters and the
# public key.
#
# This method is provided for backwards compatibility. In most cases, there
# is no need to call this method.
#
# For the purpose of serializing the public key, to PEM or DER encoding of
# X.509 SubjectPublicKeyInfo format, check PKey#public_to_pem and
# PKey#public_to_der.
def public_key
OpenSSL::PKey.read(public_to_der)
end
class << self
# :call-seq:
# DSA.generate(size) -> dsa
#
# Creates a new DSA instance by generating a private/public key pair
# from scratch.
#
# See also OpenSSL::PKey.generate_parameters and
# OpenSSL::PKey.generate_key.
#
# +size+::
# The desired key size in bits.
def generate(size, &blk)
# FIPS 186-4 specifies four (L,N) pairs: (1024,160), (2048,224),
# (2048,256), and (3072,256).
#
# q size is derived here with compatibility with
# DSA_generator_parameters_ex() which previous versions of ruby/openssl
# used to call.
qsize = size >= 2048 ? 256 : 160
dsaparams = OpenSSL::PKey.generate_parameters("DSA", {
"dsa_paramgen_bits" => size,
"dsa_paramgen_q_bits" => qsize,
}, &blk)
OpenSSL::PKey.generate_key(dsaparams)
end
# Handle DSA.new(size) form here; new(str) and new() forms
# are handled by #initialize
def new(*args, &blk) # :nodoc:
if args[0].is_a?(Integer)
generate(*args, &blk)
else
super
end
end
end
# :call-seq:
# dsa.syssign(string) -> string
#
# Computes and returns the \DSA signature of +string+, where +string+ is
# expected to be an already-computed message digest of the original input
# data. The signature is issued using the private key of this DSA instance.
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#sign_raw and PKey::PKey#verify_raw instead.
#
# +string+::
# A message digest of the original input data to be signed.
#
# Example:
# dsa = OpenSSL::PKey::DSA.new(2048)
# doc = "Sign me"
# digest = OpenSSL::Digest.digest('SHA1', doc)
#
# # With legacy #syssign and #sysverify:
# sig = dsa.syssign(digest)
# p dsa.sysverify(digest, sig) #=> true
#
# # With #sign_raw and #verify_raw:
# sig = dsa.sign_raw(nil, digest)
# p dsa.verify_raw(nil, sig, digest) #=> true
def syssign(string)
q or raise OpenSSL::PKey::DSAError, "incomplete DSA"
private? or raise OpenSSL::PKey::DSAError, "Private DSA key needed!"
begin
sign_raw(nil, string)
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::DSAError, $!.message
end
end
# :call-seq:
# dsa.sysverify(digest, sig) -> true | false
#
# Verifies whether the signature is valid given the message digest input.
# It does so by validating +sig+ using the public key of this DSA instance.
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#sign_raw and PKey::PKey#verify_raw instead.
#
# +digest+::
# A message digest of the original input data to be signed.
# +sig+::
# A \DSA signature value.
def sysverify(digest, sig)
verify_raw(nil, sig, digest)
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::DSAError, $!.message
end
end
if defined?(EC)
class EC
include OpenSSL::Marshal
# :call-seq:
# key.dsa_sign_asn1(data) -> String
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#sign_raw and PKey::PKey#verify_raw instead.
def dsa_sign_asn1(data)
sign_raw(nil, data)
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::ECError, $!.message
end
# :call-seq:
# key.dsa_verify_asn1(data, sig) -> true | false
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#sign_raw and PKey::PKey#verify_raw instead.
def dsa_verify_asn1(data, sig)
verify_raw(nil, sig, data)
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::ECError, $!.message
end
# :call-seq:
# ec.dh_compute_key(pubkey) -> string
#
# Derives a shared secret by ECDH. _pubkey_ must be an instance of
# OpenSSL::PKey::EC::Point and must belong to the same group.
#
# This method is provided for backwards compatibility, and calls #derive
# internally.
def dh_compute_key(pubkey)
obj = OpenSSL::ASN1.Sequence([
OpenSSL::ASN1.Sequence([
OpenSSL::ASN1.ObjectId("id-ecPublicKey"),
group.to_der,
]),
OpenSSL::ASN1.BitString(pubkey.to_octet_string(:uncompressed)),
])
derive(OpenSSL::PKey.read(obj.to_der))
end
end
class EC::Point
# :call-seq:
# point.to_bn([conversion_form]) -> OpenSSL::BN
#
# Returns the octet string representation of the EC point as an instance of
# OpenSSL::BN.
#
# If _conversion_form_ is not given, the _point_conversion_form_ attribute
# set to the group is used.
#
# See #to_octet_string for more information.
def to_bn(conversion_form = group.point_conversion_form)
OpenSSL::BN.new(to_octet_string(conversion_form), 2)
end
end
end
class RSA
include OpenSSL::Marshal
# :call-seq:
# rsa.public_key -> rsanew
#
# Returns a new RSA instance that carries just the public key components.
#
# This method is provided for backwards compatibility. In most cases, there
# is no need to call this method.
#
# For the purpose of serializing the public key, to PEM or DER encoding of
# X.509 SubjectPublicKeyInfo format, check PKey#public_to_pem and
# PKey#public_to_der.
def public_key
OpenSSL::PKey.read(public_to_der)
end
class << self
# :call-seq:
# RSA.generate(size, exponent = 65537) -> RSA
#
# Generates an \RSA keypair.
#
# See also OpenSSL::PKey.generate_key.
#
# +size+::
# The desired key size in bits.
# +exponent+::
# An odd Integer, normally 3, 17, or 65537.
def generate(size, exp = 0x10001, &blk)
OpenSSL::PKey.generate_key("RSA", {
"rsa_keygen_bits" => size,
"rsa_keygen_pubexp" => exp,
}, &blk)
end
# Handle RSA.new(size, exponent) form here; new(str) and new() forms
# are handled by #initialize
def new(*args, &blk) # :nodoc:
if args[0].is_a?(Integer)
generate(*args, &blk)
else
super
end
end
end
# :call-seq:
# rsa.private_encrypt(string) -> String
# rsa.private_encrypt(string, padding) -> String
#
# Encrypt +string+ with the private key. +padding+ defaults to
# PKCS1_PADDING, which is known to be insecure but is kept for backwards
# compatibility. The encrypted string output can be decrypted using
# #public_decrypt.
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#sign_raw and PKey::PKey#verify_raw, and
# PKey::PKey#verify_recover instead.
def private_encrypt(string, padding = PKCS1_PADDING)
n or raise OpenSSL::PKey::RSAError, "incomplete RSA"
private? or raise OpenSSL::PKey::RSAError, "private key needed."
begin
sign_raw(nil, string, {
"rsa_padding_mode" => translate_padding_mode(padding),
})
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::RSAError, $!.message
end
end
# :call-seq:
# rsa.public_decrypt(string) -> String
# rsa.public_decrypt(string, padding) -> String
#
# Decrypt +string+, which has been encrypted with the private key, with the
# public key. +padding+ defaults to PKCS1_PADDING which is known to be
# insecure but is kept for backwards compatibility.
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#sign_raw and PKey::PKey#verify_raw, and
# PKey::PKey#verify_recover instead.
def public_decrypt(string, padding = PKCS1_PADDING)
n or raise OpenSSL::PKey::RSAError, "incomplete RSA"
begin
verify_recover(nil, string, {
"rsa_padding_mode" => translate_padding_mode(padding),
})
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::RSAError, $!.message
end
end
# :call-seq:
# rsa.public_encrypt(string) -> String
# rsa.public_encrypt(string, padding) -> String
#
# Encrypt +string+ with the public key. +padding+ defaults to
# PKCS1_PADDING, which is known to be insecure but is kept for backwards
# compatibility. The encrypted string output can be decrypted using
# #private_decrypt.
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#encrypt and PKey::PKey#decrypt instead.
def public_encrypt(data, padding = PKCS1_PADDING)
n or raise OpenSSL::PKey::RSAError, "incomplete RSA"
begin
encrypt(data, {
"rsa_padding_mode" => translate_padding_mode(padding),
})
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::RSAError, $!.message
end
end
# :call-seq:
# rsa.private_decrypt(string) -> String
# rsa.private_decrypt(string, padding) -> String
#
# Decrypt +string+, which has been encrypted with the public key, with the
# private key. +padding+ defaults to PKCS1_PADDING, which is known to be
# insecure but is kept for backwards compatibility.
#
# <b>Deprecated in version 3.0</b>.
# Consider using PKey::PKey#encrypt and PKey::PKey#decrypt instead.
def private_decrypt(data, padding = PKCS1_PADDING)
n or raise OpenSSL::PKey::RSAError, "incomplete RSA"
private? or raise OpenSSL::PKey::RSAError, "private key needed."
begin
decrypt(data, {
"rsa_padding_mode" => translate_padding_mode(padding),
})
rescue OpenSSL::PKey::PKeyError
raise OpenSSL::PKey::RSAError, $!.message
end
end
PKCS1_PADDING = 1
SSLV23_PADDING = 2
NO_PADDING = 3
PKCS1_OAEP_PADDING = 4
private def translate_padding_mode(num)
case num
when PKCS1_PADDING
"pkcs1"
when SSLV23_PADDING
"sslv23"
when NO_PADDING
"none"
when PKCS1_OAEP_PADDING
"oaep"
else
raise OpenSSL::PKey::PKeyError, "unsupported padding mode"
end
end
end
end
share/ruby/openssl/x509.rb 0000644 00000027147 15173517736 0011376 0 ustar 00 # frozen_string_literal: true
#--
# = Ruby-space definitions that completes C-space funcs for X509 and subclasses
#
# = Info
# 'OpenSSL for Ruby 2' project
# Copyright (C) 2002 Michal Rokos <m.rokos@sh.cvut.cz>
# All rights reserved.
#
# = Licence
# This program is licensed under the same licence as Ruby.
# (See the file 'LICENCE'.)
#++
require_relative 'marshal'
module OpenSSL
module X509
class ExtensionFactory
def create_extension(*arg)
if arg.size > 1
create_ext(*arg)
else
send("create_ext_from_"+arg[0].class.name.downcase, arg[0])
end
end
def create_ext_from_array(ary)
raise ExtensionError, "unexpected array form" if ary.size > 3
create_ext(ary[0], ary[1], ary[2])
end
def create_ext_from_string(str) # "oid = critical, value"
oid, value = str.split(/=/, 2)
oid.strip!
value.strip!
create_ext(oid, value)
end
def create_ext_from_hash(hash)
create_ext(hash["oid"], hash["value"], hash["critical"])
end
end
class Extension
include OpenSSL::Marshal
def ==(other)
return false unless Extension === other
to_der == other.to_der
end
def to_s # "oid = critical, value"
str = self.oid
str << " = "
str << "critical, " if self.critical?
str << self.value.gsub(/\n/, ", ")
end
def to_h # {"oid"=>sn|ln, "value"=>value, "critical"=>true|false}
{"oid"=>self.oid,"value"=>self.value,"critical"=>self.critical?}
end
def to_a
[ self.oid, self.value, self.critical? ]
end
module Helpers
def find_extension(oid)
extensions.find { |e| e.oid == oid }
end
end
module SubjectKeyIdentifier
include Helpers
# Get the subject's key identifier from the subjectKeyIdentifier
# exteension, as described in RFC5280 Section 4.2.1.2.
#
# Returns the binary String key identifier or nil or raises
# ASN1::ASN1Error.
def subject_key_identifier
ext = find_extension("subjectKeyIdentifier")
return nil if ext.nil?
ski_asn1 = ASN1.decode(ext.value_der)
if ext.critical? || ski_asn1.tag_class != :UNIVERSAL || ski_asn1.tag != ASN1::OCTET_STRING
raise ASN1::ASN1Error, "invalid extension"
end
ski_asn1.value
end
end
module AuthorityKeyIdentifier
include Helpers
# Get the issuing certificate's key identifier from the
# authorityKeyIdentifier extension, as described in RFC5280
# Section 4.2.1.1
#
# Returns the binary String keyIdentifier or nil or raises
# ASN1::ASN1Error.
def authority_key_identifier
ext = find_extension("authorityKeyIdentifier")
return nil if ext.nil?
aki_asn1 = ASN1.decode(ext.value_der)
if ext.critical? || aki_asn1.tag_class != :UNIVERSAL || aki_asn1.tag != ASN1::SEQUENCE
raise ASN1::ASN1Error, "invalid extension"
end
key_id = aki_asn1.value.find do |v|
v.tag_class == :CONTEXT_SPECIFIC && v.tag == 0
end
key_id.nil? ? nil : key_id.value
end
end
module CRLDistributionPoints
include Helpers
# Get the distributionPoint fullName URI from the certificate's CRL
# distribution points extension, as described in RFC5280 Section
# 4.2.1.13
#
# Returns an array of strings or nil or raises ASN1::ASN1Error.
def crl_uris
ext = find_extension("crlDistributionPoints")
return nil if ext.nil?
cdp_asn1 = ASN1.decode(ext.value_der)
if cdp_asn1.tag_class != :UNIVERSAL || cdp_asn1.tag != ASN1::SEQUENCE
raise ASN1::ASN1Error, "invalid extension"
end
crl_uris = cdp_asn1.map do |crl_distribution_point|
distribution_point = crl_distribution_point.value.find do |v|
v.tag_class == :CONTEXT_SPECIFIC && v.tag == 0
end
full_name = distribution_point&.value&.find do |v|
v.tag_class == :CONTEXT_SPECIFIC && v.tag == 0
end
full_name&.value&.find do |v|
v.tag_class == :CONTEXT_SPECIFIC && v.tag == 6 # uniformResourceIdentifier
end
end
crl_uris&.map(&:value)
end
end
module AuthorityInfoAccess
include Helpers
# Get the information and services for the issuer from the certificate's
# authority information access extension exteension, as described in RFC5280
# Section 4.2.2.1.
#
# Returns an array of strings or nil or raises ASN1::ASN1Error.
def ca_issuer_uris
aia_asn1 = parse_aia_asn1
return nil if aia_asn1.nil?
ca_issuer = aia_asn1.value.select do |authority_info_access|
authority_info_access.value.first.value == "caIssuers"
end
ca_issuer&.map(&:value)&.map(&:last)&.map(&:value)
end
# Get the URIs for OCSP from the certificate's authority information access
# extension exteension, as described in RFC5280 Section 4.2.2.1.
#
# Returns an array of strings or nil or raises ASN1::ASN1Error.
def ocsp_uris
aia_asn1 = parse_aia_asn1
return nil if aia_asn1.nil?
ocsp = aia_asn1.value.select do |authority_info_access|
authority_info_access.value.first.value == "OCSP"
end
ocsp&.map(&:value)&.map(&:last)&.map(&:value)
end
private
def parse_aia_asn1
ext = find_extension("authorityInfoAccess")
return nil if ext.nil?
aia_asn1 = ASN1.decode(ext.value_der)
if ext.critical? || aia_asn1.tag_class != :UNIVERSAL || aia_asn1.tag != ASN1::SEQUENCE
raise ASN1::ASN1Error, "invalid extension"
end
aia_asn1
end
end
end
class Name
include OpenSSL::Marshal
module RFC2253DN
Special = ',=+<>#;'
HexChar = /[0-9a-fA-F]/
HexPair = /#{HexChar}#{HexChar}/
HexString = /#{HexPair}+/
Pair = /\\(?:[#{Special}]|\\|"|#{HexPair})/
StringChar = /[^\\"#{Special}]/
QuoteChar = /[^\\"]/
AttributeType = /[a-zA-Z][0-9a-zA-Z]*|[0-9]+(?:\.[0-9]+)*/
AttributeValue = /
(?!["#])((?:#{StringChar}|#{Pair})*)|
\#(#{HexString})|
"((?:#{QuoteChar}|#{Pair})*)"
/x
TypeAndValue = /\A(#{AttributeType})=#{AttributeValue}/
module_function
def expand_pair(str)
return nil unless str
return str.gsub(Pair){
pair = $&
case pair.size
when 2 then pair[1,1]
when 3 then Integer("0x#{pair[1,2]}").chr
else raise OpenSSL::X509::NameError, "invalid pair: #{str}"
end
}
end
def expand_hexstring(str)
return nil unless str
der = str.gsub(HexPair){$&.to_i(16).chr }
a1 = OpenSSL::ASN1.decode(der)
return a1.value, a1.tag
end
def expand_value(str1, str2, str3)
value = expand_pair(str1)
value, tag = expand_hexstring(str2) unless value
value = expand_pair(str3) unless value
return value, tag
end
def scan(dn)
str = dn
ary = []
while true
if md = TypeAndValue.match(str)
remain = md.post_match
type = md[1]
value, tag = expand_value(md[2], md[3], md[4]) rescue nil
if value
type_and_value = [type, value]
type_and_value.push(tag) if tag
ary.unshift(type_and_value)
if remain.length > 2 && remain[0] == ?,
str = remain[1..-1]
next
elsif remain.length > 2 && remain[0] == ?+
raise OpenSSL::X509::NameError,
"multi-valued RDN is not supported: #{dn}"
elsif remain.empty?
break
end
end
end
msg_dn = dn[0, dn.length - str.length] + " =>" + str
raise OpenSSL::X509::NameError, "malformed RDN: #{msg_dn}"
end
return ary
end
end
class << self
# Parses the UTF-8 string representation of a distinguished name,
# according to RFC 2253.
#
# See also #to_utf8 for the opposite operation.
def parse_rfc2253(str, template=OBJECT_TYPE_TEMPLATE)
ary = OpenSSL::X509::Name::RFC2253DN.scan(str)
self.new(ary, template)
end
# Parses the string representation of a distinguished name. Two
# different forms are supported:
#
# - \OpenSSL format (<tt>X509_NAME_oneline()</tt>) used by
# <tt>#to_s</tt>. For example: <tt>/DC=com/DC=example/CN=nobody</tt>
# - \OpenSSL format (<tt>X509_NAME_print()</tt>)
# used by <tt>#to_s(OpenSSL::X509::Name::COMPAT)</tt>. For example:
# <tt>DC=com, DC=example, CN=nobody</tt>
#
# Neither of them is standardized and has quirks and inconsistencies
# in handling of escaped characters or multi-valued RDNs.
#
# Use of this method is discouraged in new applications. See
# Name.parse_rfc2253 and #to_utf8 for the alternative.
def parse_openssl(str, template=OBJECT_TYPE_TEMPLATE)
if str.start_with?("/")
# /A=B/C=D format
ary = str[1..-1].split("/").map { |i| i.split("=", 2) }
else
# Comma-separated
ary = str.split(",").map { |i| i.strip.split("=", 2) }
end
self.new(ary, template)
end
alias parse parse_openssl
end
def pretty_print(q)
q.object_group(self) {
q.text ' '
q.text to_s(OpenSSL::X509::Name::RFC2253)
}
end
end
class Attribute
include OpenSSL::Marshal
def ==(other)
return false unless Attribute === other
to_der == other.to_der
end
end
class StoreContext
def cleanup
warn "(#{caller.first}) OpenSSL::X509::StoreContext#cleanup is deprecated with no replacement" if $VERBOSE
end
end
class Certificate
include OpenSSL::Marshal
include Extension::SubjectKeyIdentifier
include Extension::AuthorityKeyIdentifier
include Extension::CRLDistributionPoints
include Extension::AuthorityInfoAccess
def pretty_print(q)
q.object_group(self) {
q.breakable
q.text 'subject='; q.pp self.subject; q.text ','; q.breakable
q.text 'issuer='; q.pp self.issuer; q.text ','; q.breakable
q.text 'serial='; q.pp self.serial; q.text ','; q.breakable
q.text 'not_before='; q.pp self.not_before; q.text ','; q.breakable
q.text 'not_after='; q.pp self.not_after
}
end
def self.load_file(path)
load(File.binread(path))
end
end
class CRL
include OpenSSL::Marshal
include Extension::AuthorityKeyIdentifier
def ==(other)
return false unless CRL === other
to_der == other.to_der
end
end
class Revoked
def ==(other)
return false unless Revoked === other
to_der == other.to_der
end
end
class Request
include OpenSSL::Marshal
def ==(other)
return false unless Request === other
to_der == other.to_der
end
end
end
end
share/ruby/openssl/bn.rb 0000644 00000001303 15173517736 0011252 0 ustar 00 # frozen_string_literal: true
#--
#
# = Ruby-space definitions that completes C-space funcs for BN
#
# = Info
# 'OpenSSL for Ruby 2' project
# Copyright (C) 2002 Michal Rokos <m.rokos@sh.cvut.cz>
# All rights reserved.
#
# = Licence
# This program is licensed under the same licence as Ruby.
# (See the file 'LICENCE'.)
#++
module OpenSSL
class BN
include Comparable
def pretty_print(q)
q.object_group(self) {
q.text ' '
q.text to_i.to_s
}
end
end # BN
end # OpenSSL
##
#--
# Add double dispatch to Integer
#++
class Integer
# Casts an Integer as an OpenSSL::BN
#
# See `man bn` for more info.
def to_bn
OpenSSL::BN::new(self)
end
end # Integer
share/ruby/optparse.rb 0000644 00000173510 15173517736 0011037 0 ustar 00 # frozen_string_literal: true
#
# optparse.rb - command-line option analysis with the OptionParser class.
#
# Author:: Nobu Nakada
# Documentation:: Nobu Nakada and Gavin Sinclair.
#
# See OptionParser for documentation.
#
#--
# == Developer Documentation (not for RDoc output)
#
# === Class tree
#
# - OptionParser:: front end
# - OptionParser::Switch:: each switches
# - OptionParser::List:: options list
# - OptionParser::ParseError:: errors on parsing
# - OptionParser::AmbiguousOption
# - OptionParser::NeedlessArgument
# - OptionParser::MissingArgument
# - OptionParser::InvalidOption
# - OptionParser::InvalidArgument
# - OptionParser::AmbiguousArgument
#
# === Object relationship diagram
#
# +--------------+
# | OptionParser |<>-----+
# +--------------+ | +--------+
# | ,-| Switch |
# on_head -------->+---------------+ / +--------+
# accept/reject -->| List |<|>-
# | |<|>- +----------+
# on ------------->+---------------+ `-| argument |
# : : | class |
# +---------------+ |==========|
# on_tail -------->| | |pattern |
# +---------------+ |----------|
# OptionParser.accept ->| DefaultList | |converter |
# reject |(shared between| +----------+
# | all instances)|
# +---------------+
#
#++
#
# == OptionParser
#
# === New to +OptionParser+?
#
# See the {Tutorial}[optparse/tutorial.rdoc].
#
# === Introduction
#
# OptionParser is a class for command-line option analysis. It is much more
# advanced, yet also easier to use, than GetoptLong, and is a more Ruby-oriented
# solution.
#
# === Features
#
# 1. The argument specification and the code to handle it are written in the
# same place.
# 2. It can output an option summary; you don't need to maintain this string
# separately.
# 3. Optional and mandatory arguments are specified very gracefully.
# 4. Arguments can be automatically converted to a specified class.
# 5. Arguments can be restricted to a certain set.
#
# All of these features are demonstrated in the examples below. See
# #make_switch for full documentation.
#
# === Minimal example
#
# require 'optparse'
#
# options = {}
# OptionParser.new do |parser|
# parser.banner = "Usage: example.rb [options]"
#
# parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
# options[:verbose] = v
# end
# end.parse!
#
# p options
# p ARGV
#
# === Generating Help
#
# OptionParser can be used to automatically generate help for the commands you
# write:
#
# require 'optparse'
#
# Options = Struct.new(:name)
#
# class Parser
# def self.parse(options)
# args = Options.new("world")
#
# opt_parser = OptionParser.new do |parser|
# parser.banner = "Usage: example.rb [options]"
#
# parser.on("-nNAME", "--name=NAME", "Name to say hello to") do |n|
# args.name = n
# end
#
# parser.on("-h", "--help", "Prints this help") do
# puts parser
# exit
# end
# end
#
# opt_parser.parse!(options)
# return args
# end
# end
# options = Parser.parse %w[--help]
#
# #=>
# # Usage: example.rb [options]
# # -n, --name=NAME Name to say hello to
# # -h, --help Prints this help
#
# === Required Arguments
#
# For options that require an argument, option specification strings may include an
# option name in all caps. If an option is used without the required argument,
# an exception will be raised.
#
# require 'optparse'
#
# options = {}
# OptionParser.new do |parser|
# parser.on("-r", "--require LIBRARY",
# "Require the LIBRARY before executing your script") do |lib|
# puts "You required #{lib}!"
# end
# end.parse!
#
# Used:
#
# $ ruby optparse-test.rb -r
# optparse-test.rb:9:in `<main>': missing argument: -r (OptionParser::MissingArgument)
# $ ruby optparse-test.rb -r my-library
# You required my-library!
#
# === Type Coercion
#
# OptionParser supports the ability to coerce command line arguments
# into objects for us.
#
# OptionParser comes with a few ready-to-use kinds of type
# coercion. They are:
#
# - Date -- Anything accepted by +Date.parse+ (need to require +optparse/date+)
# - DateTime -- Anything accepted by +DateTime.parse+ (need to require +optparse/date+)
# - Time -- Anything accepted by +Time.httpdate+ or +Time.parse+ (need to require +optparse/time+)
# - URI -- Anything accepted by +URI.parse+ (need to require +optparse/uri+)
# - Shellwords -- Anything accepted by +Shellwords.shellwords+ (need to require +optparse/shellwords+)
# - String -- Any non-empty string
# - Integer -- Any integer. Will convert octal. (e.g. 124, -3, 040)
# - Float -- Any float. (e.g. 10, 3.14, -100E+13)
# - Numeric -- Any integer, float, or rational (1, 3.4, 1/3)
# - DecimalInteger -- Like +Integer+, but no octal format.
# - OctalInteger -- Like +Integer+, but no decimal format.
# - DecimalNumeric -- Decimal integer or float.
# - TrueClass -- Accepts '+, yes, true, -, no, false' and
# defaults as +true+
# - FalseClass -- Same as +TrueClass+, but defaults to +false+
# - Array -- Strings separated by ',' (e.g. 1,2,3)
# - Regexp -- Regular expressions. Also includes options.
#
# We can also add our own coercions, which we will cover below.
#
# ==== Using Built-in Conversions
#
# As an example, the built-in +Time+ conversion is used. The other built-in
# conversions behave in the same way.
# OptionParser will attempt to parse the argument
# as a +Time+. If it succeeds, that time will be passed to the
# handler block. Otherwise, an exception will be raised.
#
# require 'optparse'
# require 'optparse/time'
# OptionParser.new do |parser|
# parser.on("-t", "--time [TIME]", Time, "Begin execution at given time") do |time|
# p time
# end
# end.parse!
#
# Used:
#
# $ ruby optparse-test.rb -t nonsense
# ... invalid argument: -t nonsense (OptionParser::InvalidArgument)
# $ ruby optparse-test.rb -t 10-11-12
# 2010-11-12 00:00:00 -0500
# $ ruby optparse-test.rb -t 9:30
# 2014-08-13 09:30:00 -0400
#
# ==== Creating Custom Conversions
#
# The +accept+ method on OptionParser may be used to create converters.
# It specifies which conversion block to call whenever a class is specified.
# The example below uses it to fetch a +User+ object before the +on+ handler receives it.
#
# require 'optparse'
#
# User = Struct.new(:id, :name)
#
# def find_user id
# not_found = ->{ raise "No User Found for id #{id}" }
# [ User.new(1, "Sam"),
# User.new(2, "Gandalf") ].find(not_found) do |u|
# u.id == id
# end
# end
#
# op = OptionParser.new
# op.accept(User) do |user_id|
# find_user user_id.to_i
# end
#
# op.on("--user ID", User) do |user|
# puts user
# end
#
# op.parse!
#
# Used:
#
# $ ruby optparse-test.rb --user 1
# #<struct User id=1, name="Sam">
# $ ruby optparse-test.rb --user 2
# #<struct User id=2, name="Gandalf">
# $ ruby optparse-test.rb --user 3
# optparse-test.rb:15:in `block in find_user': No User Found for id 3 (RuntimeError)
#
# === Store options to a Hash
#
# The +into+ option of +order+, +parse+ and so on methods stores command line options into a Hash.
#
# require 'optparse'
#
# options = {}
# OptionParser.new do |parser|
# parser.on('-a')
# parser.on('-b NUM', Integer)
# parser.on('-v', '--verbose')
# end.parse!(into: options)
#
# p options
#
# Used:
#
# $ ruby optparse-test.rb -a
# {:a=>true}
# $ ruby optparse-test.rb -a -v
# {:a=>true, :verbose=>true}
# $ ruby optparse-test.rb -a -b 100
# {:a=>true, :b=>100}
#
# === Complete example
#
# The following example is a complete Ruby program. You can run it and see the
# effect of specifying various options. This is probably the best way to learn
# the features of +optparse+.
#
# require 'optparse'
# require 'optparse/time'
# require 'ostruct'
# require 'pp'
#
# class OptparseExample
# Version = '1.0.0'
#
# CODES = %w[iso-2022-jp shift_jis euc-jp utf8 binary]
# CODE_ALIASES = { "jis" => "iso-2022-jp", "sjis" => "shift_jis" }
#
# class ScriptOptions
# attr_accessor :library, :inplace, :encoding, :transfer_type,
# :verbose, :extension, :delay, :time, :record_separator,
# :list
#
# def initialize
# self.library = []
# self.inplace = false
# self.encoding = "utf8"
# self.transfer_type = :auto
# self.verbose = false
# end
#
# def define_options(parser)
# parser.banner = "Usage: example.rb [options]"
# parser.separator ""
# parser.separator "Specific options:"
#
# # add additional options
# perform_inplace_option(parser)
# delay_execution_option(parser)
# execute_at_time_option(parser)
# specify_record_separator_option(parser)
# list_example_option(parser)
# specify_encoding_option(parser)
# optional_option_argument_with_keyword_completion_option(parser)
# boolean_verbose_option(parser)
#
# parser.separator ""
# parser.separator "Common options:"
# # No argument, shows at tail. This will print an options summary.
# # Try it and see!
# parser.on_tail("-h", "--help", "Show this message") do
# puts parser
# exit
# end
# # Another typical switch to print the version.
# parser.on_tail("--version", "Show version") do
# puts Version
# exit
# end
# end
#
# def perform_inplace_option(parser)
# # Specifies an optional option argument
# parser.on("-i", "--inplace [EXTENSION]",
# "Edit ARGV files in place",
# "(make backup if EXTENSION supplied)") do |ext|
# self.inplace = true
# self.extension = ext || ''
# self.extension.sub!(/\A\.?(?=.)/, ".") # Ensure extension begins with dot.
# end
# end
#
# def delay_execution_option(parser)
# # Cast 'delay' argument to a Float.
# parser.on("--delay N", Float, "Delay N seconds before executing") do |n|
# self.delay = n
# end
# end
#
# def execute_at_time_option(parser)
# # Cast 'time' argument to a Time object.
# parser.on("-t", "--time [TIME]", Time, "Begin execution at given time") do |time|
# self.time = time
# end
# end
#
# def specify_record_separator_option(parser)
# # Cast to octal integer.
# parser.on("-F", "--irs [OCTAL]", OptionParser::OctalInteger,
# "Specify record separator (default \\0)") do |rs|
# self.record_separator = rs
# end
# end
#
# def list_example_option(parser)
# # List of arguments.
# parser.on("--list x,y,z", Array, "Example 'list' of arguments") do |list|
# self.list = list
# end
# end
#
# def specify_encoding_option(parser)
# # Keyword completion. We are specifying a specific set of arguments (CODES
# # and CODE_ALIASES - notice the latter is a Hash), and the user may provide
# # the shortest unambiguous text.
# code_list = (CODE_ALIASES.keys + CODES).join(', ')
# parser.on("--code CODE", CODES, CODE_ALIASES, "Select encoding",
# "(#{code_list})") do |encoding|
# self.encoding = encoding
# end
# end
#
# def optional_option_argument_with_keyword_completion_option(parser)
# # Optional '--type' option argument with keyword completion.
# parser.on("--type [TYPE]", [:text, :binary, :auto],
# "Select transfer type (text, binary, auto)") do |t|
# self.transfer_type = t
# end
# end
#
# def boolean_verbose_option(parser)
# # Boolean switch.
# parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
# self.verbose = v
# end
# end
# end
#
# #
# # Return a structure describing the options.
# #
# def parse(args)
# # The options specified on the command line will be collected in
# # *options*.
#
# @options = ScriptOptions.new
# @args = OptionParser.new do |parser|
# @options.define_options(parser)
# parser.parse!(args)
# end
# @options
# end
#
# attr_reader :parser, :options
# end # class OptparseExample
#
# example = OptparseExample.new
# options = example.parse(ARGV)
# pp options # example.options
# pp ARGV
#
# === Shell Completion
#
# For modern shells (e.g. bash, zsh, etc.), you can use shell
# completion for command line options.
#
# === Further documentation
#
# The above examples, along with the accompanying
# {Tutorial}[optparse/tutorial.rdoc],
# should be enough to learn how to use this class.
# If you have any questions, file a ticket at http://bugs.ruby-lang.org.
#
class OptionParser
OptionParser::Version = "0.4.0"
# :stopdoc:
NoArgument = [NO_ARGUMENT = :NONE, nil].freeze
RequiredArgument = [REQUIRED_ARGUMENT = :REQUIRED, true].freeze
OptionalArgument = [OPTIONAL_ARGUMENT = :OPTIONAL, false].freeze
# :startdoc:
#
# Keyword completion module. This allows partial arguments to be specified
# and resolved against a list of acceptable values.
#
module Completion
def self.regexp(key, icase)
Regexp.new('\A' + Regexp.quote(key).gsub(/\w+\b/, '\&\w*'), icase)
end
def self.candidate(key, icase = false, pat = nil, &block)
pat ||= Completion.regexp(key, icase)
candidates = []
block.call do |k, *v|
(if Regexp === k
kn = ""
k === key
else
kn = defined?(k.id2name) ? k.id2name : k
pat === kn
end) or next
v << k if v.empty?
candidates << [k, v, kn]
end
candidates
end
def candidate(key, icase = false, pat = nil)
Completion.candidate(key, icase, pat, &method(:each))
end
public
def complete(key, icase = false, pat = nil)
candidates = candidate(key, icase, pat, &method(:each)).sort_by {|k, v, kn| kn.size}
if candidates.size == 1
canon, sw, * = candidates[0]
elsif candidates.size > 1
canon, sw, cn = candidates.shift
candidates.each do |k, v, kn|
next if sw == v
if String === cn and String === kn
if cn.rindex(kn, 0)
canon, sw, cn = k, v, kn
next
elsif kn.rindex(cn, 0)
next
end
end
throw :ambiguous, key
end
end
if canon
block_given? or return key, *sw
yield(key, *sw)
end
end
def convert(opt = nil, val = nil, *)
val
end
end
#
# Map from option/keyword string to object with completion.
#
class OptionMap < Hash
include Completion
end
#
# Individual switch class. Not important to the user.
#
# Defined within Switch are several Switch-derived classes: NoArgument,
# RequiredArgument, etc.
#
class Switch
attr_reader :pattern, :conv, :short, :long, :arg, :desc, :block
#
# Guesses argument style from +arg+. Returns corresponding
# OptionParser::Switch class (OptionalArgument, etc.).
#
def self.guess(arg)
case arg
when ""
t = self
when /\A=?\[/
t = Switch::OptionalArgument
when /\A\s+\[/
t = Switch::PlacedArgument
else
t = Switch::RequiredArgument
end
self >= t or incompatible_argument_styles(arg, t)
t
end
def self.incompatible_argument_styles(arg, t)
raise(ArgumentError, "#{arg}: incompatible argument styles\n #{self}, #{t}",
ParseError.filter_backtrace(caller(2)))
end
def self.pattern
NilClass
end
def initialize(pattern = nil, conv = nil,
short = nil, long = nil, arg = nil,
desc = ([] if short or long), block = nil, &_block)
raise if Array === pattern
block ||= _block
@pattern, @conv, @short, @long, @arg, @desc, @block =
pattern, conv, short, long, arg, desc, block
end
#
# Parses +arg+ and returns rest of +arg+ and matched portion to the
# argument pattern. Yields when the pattern doesn't match substring.
#
def parse_arg(arg) # :nodoc:
pattern or return nil, [arg]
unless m = pattern.match(arg)
yield(InvalidArgument, arg)
return arg, []
end
if String === m
m = [s = m]
else
m = m.to_a
s = m[0]
return nil, m unless String === s
end
raise InvalidArgument, arg unless arg.rindex(s, 0)
return nil, m if s.length == arg.length
yield(InvalidArgument, arg) # didn't match whole arg
return arg[s.length..-1], m
end
private :parse_arg
#
# Parses argument, converts and returns +arg+, +block+ and result of
# conversion. Yields at semi-error condition instead of raising an
# exception.
#
def conv_arg(arg, val = []) # :nodoc:
if conv
val = conv.call(*val)
else
val = proc {|v| v}.call(*val)
end
return arg, block, val
end
private :conv_arg
#
# Produces the summary text. Each line of the summary is yielded to the
# block (without newline).
#
# +sdone+:: Already summarized short style options keyed hash.
# +ldone+:: Already summarized long style options keyed hash.
# +width+:: Width of left side (option part). In other words, the right
# side (description part) starts after +width+ columns.
# +max+:: Maximum width of left side -> the options are filled within
# +max+ columns.
# +indent+:: Prefix string indents all summarized lines.
#
def summarize(sdone = {}, ldone = {}, width = 1, max = width - 1, indent = "")
sopts, lopts = [], [], nil
@short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short
@long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long
return if sopts.empty? and lopts.empty? # completely hidden
left = [sopts.join(', ')]
right = desc.dup
while s = lopts.shift
l = left[-1].length + s.length
l += arg.length if left.size == 1 && arg
l < max or sopts.empty? or left << +''
left[-1] << (left[-1].empty? ? ' ' * 4 : ', ') << s
end
if arg
left[0] << (left[1] ? arg.sub(/\A(\[?)=/, '\1') + ',' : arg)
end
mlen = left.collect {|ss| ss.length}.max.to_i
while mlen > width and l = left.shift
mlen = left.collect {|ss| ss.length}.max.to_i if l.length == mlen
if l.length < width and (r = right[0]) and !r.empty?
l = l.to_s.ljust(width) + ' ' + r
right.shift
end
yield(indent + l)
end
while begin l = left.shift; r = right.shift; l or r end
l = l.to_s.ljust(width) + ' ' + r if r and !r.empty?
yield(indent + l)
end
self
end
def add_banner(to) # :nodoc:
unless @short or @long
s = desc.join
to << " [" + s + "]..." unless s.empty?
end
to
end
def match_nonswitch?(str) # :nodoc:
@pattern =~ str unless @short or @long
end
#
# Main name of the switch.
#
def switch_name
(long.first || short.first).sub(/\A-+(?:\[no-\])?/, '')
end
def compsys(sdone, ldone) # :nodoc:
sopts, lopts = [], []
@short.each {|s| sdone.fetch(s) {sopts << s}; sdone[s] = true} if @short
@long.each {|s| ldone.fetch(s) {lopts << s}; ldone[s] = true} if @long
return if sopts.empty? and lopts.empty? # completely hidden
(sopts+lopts).each do |opt|
# "(-x -c -r)-l[left justify]"
if /^--\[no-\](.+)$/ =~ opt
o = $1
yield("--#{o}", desc.join(""))
yield("--no-#{o}", desc.join(""))
else
yield("#{opt}", desc.join(""))
end
end
end
def pretty_print_contents(q) # :nodoc:
if @block
q.text ":" + @block.source_location.join(":") + ":"
first = false
else
first = true
end
[@short, @long].each do |list|
list.each do |opt|
if first
q.text ":"
first = false
end
q.breakable
q.text opt
end
end
end
def pretty_print(q) # :nodoc:
q.object_group(self) {pretty_print_contents(q)}
end
#
# Switch that takes no arguments.
#
class NoArgument < self
#
# Raises an exception if any arguments given.
#
def parse(arg, argv)
yield(NeedlessArgument, arg) if arg
conv_arg(arg)
end
def self.incompatible_argument_styles(*)
end
def self.pattern
Object
end
def pretty_head # :nodoc:
"NoArgument"
end
end
#
# Switch that takes an argument.
#
class RequiredArgument < self
#
# Raises an exception if argument is not present.
#
def parse(arg, argv)
unless arg
raise MissingArgument if argv.empty?
arg = argv.shift
end
conv_arg(*parse_arg(arg, &method(:raise)))
end
def pretty_head # :nodoc:
"Required"
end
end
#
# Switch that can omit argument.
#
class OptionalArgument < self
#
# Parses argument if given, or uses default value.
#
def parse(arg, argv, &error)
if arg
conv_arg(*parse_arg(arg, &error))
else
conv_arg(arg)
end
end
def pretty_head # :nodoc:
"Optional"
end
end
#
# Switch that takes an argument, which does not begin with '-' or is '-'.
#
class PlacedArgument < self
#
# Returns nil if argument is not present or begins with '-' and is not '-'.
#
def parse(arg, argv, &error)
if !(val = arg) and (argv.empty? or /\A-./ =~ (val = argv[0]))
return nil, block, nil
end
opt = (val = parse_arg(val, &error))[1]
val = conv_arg(*val)
if opt and !arg
argv.shift
else
val[0] = nil
end
val
end
def pretty_head # :nodoc:
"Placed"
end
end
end
#
# Simple option list providing mapping from short and/or long option
# string to OptionParser::Switch and mapping from acceptable argument to
# matching pattern and converter pair. Also provides summary feature.
#
class List
# Map from acceptable argument types to pattern and converter pairs.
attr_reader :atype
# Map from short style option switches to actual switch objects.
attr_reader :short
# Map from long style option switches to actual switch objects.
attr_reader :long
# List of all switches and summary string.
attr_reader :list
#
# Just initializes all instance variables.
#
def initialize
@atype = {}
@short = OptionMap.new
@long = OptionMap.new
@list = []
end
def pretty_print(q) # :nodoc:
q.group(1, "(", ")") do
@list.each do |sw|
next unless Switch === sw
q.group(1, "(" + sw.pretty_head, ")") do
sw.pretty_print_contents(q)
end
end
end
end
#
# See OptionParser.accept.
#
def accept(t, pat = /.*/m, &block)
if pat
pat.respond_to?(:match) or
raise TypeError, "has no `match'", ParseError.filter_backtrace(caller(2))
else
pat = t if t.respond_to?(:match)
end
unless block
block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
end
@atype[t] = [pat, block]
end
#
# See OptionParser.reject.
#
def reject(t)
@atype.delete(t)
end
#
# Adds +sw+ according to +sopts+, +lopts+ and +nlopts+.
#
# +sw+:: OptionParser::Switch instance to be added.
# +sopts+:: Short style option list.
# +lopts+:: Long style option list.
# +nlopts+:: Negated long style options list.
#
def update(sw, sopts, lopts, nsw = nil, nlopts = nil) # :nodoc:
sopts.each {|o| @short[o] = sw} if sopts
lopts.each {|o| @long[o] = sw} if lopts
nlopts.each {|o| @long[o] = nsw} if nsw and nlopts
used = @short.invert.update(@long.invert)
@list.delete_if {|o| Switch === o and !used[o]}
end
private :update
#
# Inserts +switch+ at the head of the list, and associates short, long
# and negated long options. Arguments are:
#
# +switch+:: OptionParser::Switch instance to be inserted.
# +short_opts+:: List of short style options.
# +long_opts+:: List of long style options.
# +nolong_opts+:: List of long style options with "no-" prefix.
#
# prepend(switch, short_opts, long_opts, nolong_opts)
#
def prepend(*args)
update(*args)
@list.unshift(args[0])
end
#
# Appends +switch+ at the tail of the list, and associates short, long
# and negated long options. Arguments are:
#
# +switch+:: OptionParser::Switch instance to be inserted.
# +short_opts+:: List of short style options.
# +long_opts+:: List of long style options.
# +nolong_opts+:: List of long style options with "no-" prefix.
#
# append(switch, short_opts, long_opts, nolong_opts)
#
def append(*args)
update(*args)
@list.push(args[0])
end
#
# Searches +key+ in +id+ list. The result is returned or yielded if a
# block is given. If it isn't found, nil is returned.
#
def search(id, key)
if list = __send__(id)
val = list.fetch(key) {return nil}
block_given? ? yield(val) : val
end
end
#
# Searches list +id+ for +opt+ and the optional patterns for completion
# +pat+. If +icase+ is true, the search is case insensitive. The result
# is returned or yielded if a block is given. If it isn't found, nil is
# returned.
#
def complete(id, opt, icase = false, *pat, &block)
__send__(id).complete(opt, icase, *pat, &block)
end
def get_candidates(id)
yield __send__(id).keys
end
#
# Iterates over each option, passing the option to the +block+.
#
def each_option(&block)
list.each(&block)
end
#
# Creates the summary table, passing each line to the +block+ (without
# newline). The arguments +args+ are passed along to the summarize
# method which is called on every option.
#
def summarize(*args, &block)
sum = []
list.reverse_each do |opt|
if opt.respond_to?(:summarize) # perhaps OptionParser::Switch
s = []
opt.summarize(*args) {|l| s << l}
sum.concat(s.reverse)
elsif !opt or opt.empty?
sum << ""
elsif opt.respond_to?(:each_line)
sum.concat([*opt.each_line].reverse)
else
sum.concat([*opt.each].reverse)
end
end
sum.reverse_each(&block)
end
def add_banner(to) # :nodoc:
list.each do |opt|
if opt.respond_to?(:add_banner)
opt.add_banner(to)
end
end
to
end
def compsys(*args, &block) # :nodoc:
list.each do |opt|
if opt.respond_to?(:compsys)
opt.compsys(*args, &block)
end
end
end
end
#
# Hash with completion search feature. See OptionParser::Completion.
#
class CompletingHash < Hash
include Completion
#
# Completion for hash key.
#
def match(key)
*values = fetch(key) {
raise AmbiguousArgument, catch(:ambiguous) {return complete(key)}
}
return key, *values
end
end
# :stopdoc:
#
# Enumeration of acceptable argument styles. Possible values are:
#
# NO_ARGUMENT:: The switch takes no arguments. (:NONE)
# REQUIRED_ARGUMENT:: The switch requires an argument. (:REQUIRED)
# OPTIONAL_ARGUMENT:: The switch requires an optional argument. (:OPTIONAL)
#
# Use like --switch=argument (long style) or -Xargument (short style). For
# short style, only portion matched to argument pattern is treated as
# argument.
#
ArgumentStyle = {}
NoArgument.each {|el| ArgumentStyle[el] = Switch::NoArgument}
RequiredArgument.each {|el| ArgumentStyle[el] = Switch::RequiredArgument}
OptionalArgument.each {|el| ArgumentStyle[el] = Switch::OptionalArgument}
ArgumentStyle.freeze
#
# Switches common used such as '--', and also provides default
# argument classes
#
DefaultList = List.new
DefaultList.short['-'] = Switch::NoArgument.new {}
DefaultList.long[''] = Switch::NoArgument.new {throw :terminate}
COMPSYS_HEADER = <<'XXX' # :nodoc:
typeset -A opt_args
local context state line
_arguments -s -S \
XXX
def compsys(to, name = File.basename($0)) # :nodoc:
to << "#compdef #{name}\n"
to << COMPSYS_HEADER
visit(:compsys, {}, {}) {|o, d|
to << %Q[ "#{o}[#{d.gsub(/[\"\[\]]/, '\\\\\&')}]" \\\n]
}
to << " '*:file:_files' && return 0\n"
end
#
# Default options for ARGV, which never appear in option summary.
#
Officious = {}
#
# --help
# Shows option summary.
#
Officious['help'] = proc do |parser|
Switch::NoArgument.new do |arg|
puts parser.help
exit
end
end
#
# --*-completion-bash=WORD
# Shows candidates for command line completion.
#
Officious['*-completion-bash'] = proc do |parser|
Switch::RequiredArgument.new do |arg|
puts parser.candidate(arg)
exit
end
end
#
# --*-completion-zsh[=NAME:FILE]
# Creates zsh completion file.
#
Officious['*-completion-zsh'] = proc do |parser|
Switch::OptionalArgument.new do |arg|
parser.compsys(STDOUT, arg)
exit
end
end
#
# --version
# Shows version string if Version is defined.
#
Officious['version'] = proc do |parser|
Switch::OptionalArgument.new do |pkg|
if pkg
begin
require 'optparse/version'
rescue LoadError
else
show_version(*pkg.split(/,/)) or
abort("#{parser.program_name}: no version found in package #{pkg}")
exit
end
end
v = parser.ver or abort("#{parser.program_name}: version unknown")
puts v
exit
end
end
# :startdoc:
#
# Class methods
#
#
# Initializes a new instance and evaluates the optional block in context
# of the instance. Arguments +args+ are passed to #new, see there for
# description of parameters.
#
# This method is *deprecated*, its behavior corresponds to the older #new
# method.
#
def self.with(*args, &block)
opts = new(*args)
opts.instance_eval(&block)
opts
end
#
# Returns an incremented value of +default+ according to +arg+.
#
def self.inc(arg, default = nil)
case arg
when Integer
arg.nonzero?
when nil
default.to_i + 1
end
end
def inc(*args)
self.class.inc(*args)
end
#
# Initializes the instance and yields itself if called with a block.
#
# +banner+:: Banner message.
# +width+:: Summary width.
# +indent+:: Summary indent.
#
def initialize(banner = nil, width = 32, indent = ' ' * 4)
@stack = [DefaultList, List.new, List.new]
@program_name = nil
@banner = banner
@summary_width = width
@summary_indent = indent
@default_argv = ARGV
@require_exact = false
@raise_unknown = true
add_officious
yield self if block_given?
end
def add_officious # :nodoc:
list = base()
Officious.each do |opt, block|
list.long[opt] ||= block.call(self)
end
end
#
# Terminates option parsing. Optional parameter +arg+ is a string pushed
# back to be the first non-option argument.
#
def terminate(arg = nil)
self.class.terminate(arg)
end
def self.terminate(arg = nil)
throw :terminate, arg
end
@stack = [DefaultList]
def self.top() DefaultList end
#
# Directs to accept specified class +t+. The argument string is passed to
# the block in which it should be converted to the desired class.
#
# +t+:: Argument class specifier, any object including Class.
# +pat+:: Pattern for argument, defaults to +t+ if it responds to match.
#
# accept(t, pat, &block)
#
def accept(*args, &blk) top.accept(*args, &blk) end
#
# See #accept.
#
def self.accept(*args, &blk) top.accept(*args, &blk) end
#
# Directs to reject specified class argument.
#
# +t+:: Argument class specifier, any object including Class.
#
# reject(t)
#
def reject(*args, &blk) top.reject(*args, &blk) end
#
# See #reject.
#
def self.reject(*args, &blk) top.reject(*args, &blk) end
#
# Instance methods
#
# Heading banner preceding summary.
attr_writer :banner
# Program name to be emitted in error message and default banner,
# defaults to $0.
attr_writer :program_name
# Width for option list portion of summary. Must be Numeric.
attr_accessor :summary_width
# Indentation for summary. Must be String (or have + String method).
attr_accessor :summary_indent
# Strings to be parsed in default.
attr_accessor :default_argv
# Whether to require that options match exactly (disallows providing
# abbreviated long option as short option).
attr_accessor :require_exact
# Whether to raise at unknown option.
attr_accessor :raise_unknown
#
# Heading banner preceding summary.
#
def banner
unless @banner
@banner = +"Usage: #{program_name} [options]"
visit(:add_banner, @banner)
end
@banner
end
#
# Program name to be emitted in error message and default banner, defaults
# to $0.
#
def program_name
@program_name || File.basename($0, '.*')
end
# for experimental cascading :-)
alias set_banner banner=
alias set_program_name program_name=
alias set_summary_width summary_width=
alias set_summary_indent summary_indent=
# Version
attr_writer :version
# Release code
attr_writer :release
#
# Version
#
def version
(defined?(@version) && @version) || (defined?(::Version) && ::Version)
end
#
# Release code
#
def release
(defined?(@release) && @release) || (defined?(::Release) && ::Release) || (defined?(::RELEASE) && ::RELEASE)
end
#
# Returns version string from program_name, version and release.
#
def ver
if v = version
str = +"#{program_name} #{[v].join('.')}"
str << " (#{v})" if v = release
str
end
end
def warn(mesg = $!)
super("#{program_name}: #{mesg}")
end
def abort(mesg = $!)
super("#{program_name}: #{mesg}")
end
#
# Subject of #on / #on_head, #accept / #reject
#
def top
@stack[-1]
end
#
# Subject of #on_tail.
#
def base
@stack[1]
end
#
# Pushes a new List.
#
def new
@stack.push(List.new)
if block_given?
yield self
else
self
end
end
#
# Removes the last List.
#
def remove
@stack.pop
end
#
# Puts option summary into +to+ and returns +to+. Yields each line if
# a block is given.
#
# +to+:: Output destination, which must have method <<. Defaults to [].
# +width+:: Width of left side, defaults to @summary_width.
# +max+:: Maximum length allowed for left side, defaults to +width+ - 1.
# +indent+:: Indentation, defaults to @summary_indent.
#
def summarize(to = [], width = @summary_width, max = width - 1, indent = @summary_indent, &blk)
nl = "\n"
blk ||= proc {|l| to << (l.index(nl, -1) ? l : l + nl)}
visit(:summarize, {}, {}, width, max, indent, &blk)
to
end
#
# Returns option summary string.
#
def help; summarize("#{banner}".sub(/\n?\z/, "\n")) end
alias to_s help
def pretty_print(q) # :nodoc:
q.object_group(self) do
first = true
if @stack.size > 2
@stack.each_with_index do |s, i|
next if i < 2
next if s.list.empty?
if first
first = false
q.text ":"
end
q.breakable
s.pretty_print(q)
end
end
end
end
def inspect # :nodoc:
require 'pp'
pretty_print_inspect
end
#
# Returns option summary list.
#
def to_a; summarize("#{banner}".split(/^/)) end
#
# Checks if an argument is given twice, in which case an ArgumentError is
# raised. Called from OptionParser#switch only.
#
# +obj+:: New argument.
# +prv+:: Previously specified argument.
# +msg+:: Exception message.
#
def notwice(obj, prv, msg) # :nodoc:
unless !prv or prv == obj
raise(ArgumentError, "argument #{msg} given twice: #{obj}",
ParseError.filter_backtrace(caller(2)))
end
obj
end
private :notwice
SPLAT_PROC = proc {|*a| a.length <= 1 ? a.first : a} # :nodoc:
# :call-seq:
# make_switch(params, block = nil)
#
# :include: ../doc/optparse/creates_option.rdoc
#
def make_switch(opts, block = nil)
short, long, nolong, style, pattern, conv, not_pattern, not_conv, not_style = [], [], []
ldesc, sdesc, desc, arg = [], [], []
default_style = Switch::NoArgument
default_pattern = nil
klass = nil
q, a = nil
has_arg = false
opts.each do |o|
# argument class
next if search(:atype, o) do |pat, c|
klass = notwice(o, klass, 'type')
if not_style and not_style != Switch::NoArgument
not_pattern, not_conv = pat, c
else
default_pattern, conv = pat, c
end
end
# directly specified pattern(any object possible to match)
if (!(String === o || Symbol === o)) and o.respond_to?(:match)
pattern = notwice(o, pattern, 'pattern')
if pattern.respond_to?(:convert)
conv = pattern.method(:convert).to_proc
else
conv = SPLAT_PROC
end
next
end
# anything others
case o
when Proc, Method
block = notwice(o, block, 'block')
when Array, Hash
case pattern
when CompletingHash
when nil
pattern = CompletingHash.new
conv = pattern.method(:convert).to_proc if pattern.respond_to?(:convert)
else
raise ArgumentError, "argument pattern given twice"
end
o.each {|pat, *v| pattern[pat] = v.fetch(0) {pat}}
when Module
raise ArgumentError, "unsupported argument type: #{o}", ParseError.filter_backtrace(caller(4))
when *ArgumentStyle.keys
style = notwice(ArgumentStyle[o], style, 'style')
when /^--no-([^\[\]=\s]*)(.+)?/
q, a = $1, $2
o = notwice(a ? Object : TrueClass, klass, 'type')
not_pattern, not_conv = search(:atype, o) unless not_style
not_style = (not_style || default_style).guess(arg = a) if a
default_style = Switch::NoArgument
default_pattern, conv = search(:atype, FalseClass) unless default_pattern
ldesc << "--no-#{q}"
(q = q.downcase).tr!('_', '-')
long << "no-#{q}"
nolong << q
when /^--\[no-\]([^\[\]=\s]*)(.+)?/
q, a = $1, $2
o = notwice(a ? Object : TrueClass, klass, 'type')
if a
default_style = default_style.guess(arg = a)
default_pattern, conv = search(:atype, o) unless default_pattern
end
ldesc << "--[no-]#{q}"
(o = q.downcase).tr!('_', '-')
long << o
not_pattern, not_conv = search(:atype, FalseClass) unless not_style
not_style = Switch::NoArgument
nolong << "no-#{o}"
when /^--([^\[\]=\s]*)(.+)?/
q, a = $1, $2
if a
o = notwice(NilClass, klass, 'type')
default_style = default_style.guess(arg = a)
default_pattern, conv = search(:atype, o) unless default_pattern
end
ldesc << "--#{q}"
(o = q.downcase).tr!('_', '-')
long << o
when /^-(\[\^?\]?(?:[^\\\]]|\\.)*\])(.+)?/
q, a = $1, $2
o = notwice(Object, klass, 'type')
if a
default_style = default_style.guess(arg = a)
default_pattern, conv = search(:atype, o) unless default_pattern
else
has_arg = true
end
sdesc << "-#{q}"
short << Regexp.new(q)
when /^-(.)(.+)?/
q, a = $1, $2
if a
o = notwice(NilClass, klass, 'type')
default_style = default_style.guess(arg = a)
default_pattern, conv = search(:atype, o) unless default_pattern
end
sdesc << "-#{q}"
short << q
when /^=/
style = notwice(default_style.guess(arg = o), style, 'style')
default_pattern, conv = search(:atype, Object) unless default_pattern
else
desc.push(o) if o && !o.empty?
end
end
default_pattern, conv = search(:atype, default_style.pattern) unless default_pattern
if !(short.empty? and long.empty?)
if has_arg and default_style == Switch::NoArgument
default_style = Switch::RequiredArgument
end
s = (style || default_style).new(pattern || default_pattern,
conv, sdesc, ldesc, arg, desc, block)
elsif !block
if style or pattern
raise ArgumentError, "no switch given", ParseError.filter_backtrace(caller)
end
s = desc
else
short << pattern
s = (style || default_style).new(pattern,
conv, nil, nil, arg, desc, block)
end
return s, short, long,
(not_style.new(not_pattern, not_conv, sdesc, ldesc, nil, desc, block) if not_style),
nolong
end
# :call-seq:
# define(*params, &block)
#
# :include: ../doc/optparse/creates_option.rdoc
#
def define(*opts, &block)
top.append(*(sw = make_switch(opts, block)))
sw[0]
end
# :call-seq:
# on(*params, &block)
#
# :include: ../doc/optparse/creates_option.rdoc
#
def on(*opts, &block)
define(*opts, &block)
self
end
alias def_option define
# :call-seq:
# define_head(*params, &block)
#
# :include: ../doc/optparse/creates_option.rdoc
#
def define_head(*opts, &block)
top.prepend(*(sw = make_switch(opts, block)))
sw[0]
end
# :call-seq:
# on_head(*params, &block)
#
# :include: ../doc/optparse/creates_option.rdoc
#
# The new option is added at the head of the summary.
#
def on_head(*opts, &block)
define_head(*opts, &block)
self
end
alias def_head_option define_head
# :call-seq:
# define_tail(*params, &block)
#
# :include: ../doc/optparse/creates_option.rdoc
#
def define_tail(*opts, &block)
base.append(*(sw = make_switch(opts, block)))
sw[0]
end
#
# :call-seq:
# on_tail(*params, &block)
#
# :include: ../doc/optparse/creates_option.rdoc
#
# The new option is added at the tail of the summary.
#
def on_tail(*opts, &block)
define_tail(*opts, &block)
self
end
alias def_tail_option define_tail
#
# Add separator in summary.
#
def separator(string)
top.append(string, nil, nil)
end
#
# Parses command line arguments +argv+ in order. When a block is given,
# each non-option argument is yielded. When optional +into+ keyword
# argument is provided, the parsed option values are stored there via
# <code>[]=</code> method (so it can be Hash, or OpenStruct, or other
# similar object).
#
# Returns the rest of +argv+ left unparsed.
#
def order(*argv, into: nil, &nonopt)
argv = argv[0].dup if argv.size == 1 and Array === argv[0]
order!(argv, into: into, &nonopt)
end
#
# Same as #order, but removes switches destructively.
# Non-option arguments remain in +argv+.
#
def order!(argv = default_argv, into: nil, &nonopt)
setter = ->(name, val) {into[name.to_sym] = val} if into
parse_in_order(argv, setter, &nonopt)
end
def parse_in_order(argv = default_argv, setter = nil, &nonopt) # :nodoc:
opt, arg, val, rest = nil
nonopt ||= proc {|a| throw :terminate, a}
argv.unshift(arg) if arg = catch(:terminate) {
while arg = argv.shift
case arg
# long option
when /\A--([^=]*)(?:=(.*))?/m
opt, rest = $1, $2
opt.tr!('_', '-')
begin
sw, = complete(:long, opt, true)
if require_exact && !sw.long.include?(arg)
throw :terminate, arg unless raise_unknown
raise InvalidOption, arg
end
rescue ParseError
throw :terminate, arg unless raise_unknown
raise $!.set_option(arg, true)
end
begin
opt, cb, val = sw.parse(rest, argv) {|*exc| raise(*exc)}
val = cb.call(val) if cb
setter.call(sw.switch_name, val) if setter
rescue ParseError
raise $!.set_option(arg, rest)
end
# short option
when /\A-(.)((=).*|.+)?/m
eq, rest, opt = $3, $2, $1
has_arg, val = eq, rest
begin
sw, = search(:short, opt)
unless sw
begin
sw, = complete(:short, opt)
# short option matched.
val = arg.delete_prefix('-')
has_arg = true
rescue InvalidOption
raise if require_exact
# if no short options match, try completion with long
# options.
sw, = complete(:long, opt)
eq ||= !rest
end
end
rescue ParseError
throw :terminate, arg unless raise_unknown
raise $!.set_option(arg, true)
end
begin
opt, cb, val = sw.parse(val, argv) {|*exc| raise(*exc) if eq}
rescue ParseError
raise $!.set_option(arg, arg.length > 2)
else
raise InvalidOption, arg if has_arg and !eq and arg == "-#{opt}"
end
begin
argv.unshift(opt) if opt and (!rest or (opt = opt.sub(/\A-*/, '-')) != '-')
val = cb.call(val) if cb
setter.call(sw.switch_name, val) if setter
rescue ParseError
raise $!.set_option(arg, arg.length > 2)
end
# non-option argument
else
catch(:prune) do
visit(:each_option) do |sw0|
sw = sw0
sw.block.call(arg) if Switch === sw and sw.match_nonswitch?(arg)
end
nonopt.call(arg)
end
end
end
nil
}
visit(:search, :short, nil) {|sw| sw.block.call(*argv) if !sw.pattern}
argv
end
private :parse_in_order
#
# Parses command line arguments +argv+ in permutation mode and returns
# list of non-option arguments. When optional +into+ keyword
# argument is provided, the parsed option values are stored there via
# <code>[]=</code> method (so it can be Hash, or OpenStruct, or other
# similar object).
#
def permute(*argv, into: nil)
argv = argv[0].dup if argv.size == 1 and Array === argv[0]
permute!(argv, into: into)
end
#
# Same as #permute, but removes switches destructively.
# Non-option arguments remain in +argv+.
#
def permute!(argv = default_argv, into: nil)
nonopts = []
order!(argv, into: into, &nonopts.method(:<<))
argv[0, 0] = nonopts
argv
end
#
# Parses command line arguments +argv+ in order when environment variable
# POSIXLY_CORRECT is set, and in permutation mode otherwise.
# When optional +into+ keyword argument is provided, the parsed option
# values are stored there via <code>[]=</code> method (so it can be Hash,
# or OpenStruct, or other similar object).
#
def parse(*argv, into: nil)
argv = argv[0].dup if argv.size == 1 and Array === argv[0]
parse!(argv, into: into)
end
#
# Same as #parse, but removes switches destructively.
# Non-option arguments remain in +argv+.
#
def parse!(argv = default_argv, into: nil)
if ENV.include?('POSIXLY_CORRECT')
order!(argv, into: into)
else
permute!(argv, into: into)
end
end
#
# Wrapper method for getopts.rb.
#
# params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option")
# # params["a"] = true # -a
# # params["b"] = "1" # -b1
# # params["foo"] = "1" # --foo
# # params["bar"] = "x" # --bar x
# # params["zot"] = "z" # --zot Z
#
# Option +symbolize_names+ (boolean) specifies whether returned Hash keys should be Symbols; defaults to +false+ (use Strings).
#
# params = ARGV.getopts("ab:", "foo", "bar:", "zot:Z;zot option", symbolize_names: true)
# # params[:a] = true # -a
# # params[:b] = "1" # -b1
# # params[:foo] = "1" # --foo
# # params[:bar] = "x" # --bar x
# # params[:zot] = "z" # --zot Z
#
def getopts(*args, symbolize_names: false)
argv = Array === args.first ? args.shift : default_argv
single_options, *long_options = *args
result = {}
single_options.scan(/(.)(:)?/) do |opt, val|
if val
result[opt] = nil
define("-#{opt} VAL")
else
result[opt] = false
define("-#{opt}")
end
end if single_options
long_options.each do |arg|
arg, desc = arg.split(';', 2)
opt, val = arg.split(':', 2)
if val
result[opt] = val.empty? ? nil : val
define("--#{opt}=#{result[opt] || "VAL"}", *[desc].compact)
else
result[opt] = false
define("--#{opt}", *[desc].compact)
end
end
parse_in_order(argv, result.method(:[]=))
symbolize_names ? result.transform_keys(&:to_sym) : result
end
#
# See #getopts.
#
def self.getopts(*args, symbolize_names: false)
new.getopts(*args, symbolize_names: symbolize_names)
end
#
# Traverses @stack, sending each element method +id+ with +args+ and
# +block+.
#
def visit(id, *args, &block) # :nodoc:
@stack.reverse_each do |el|
el.__send__(id, *args, &block)
end
nil
end
private :visit
#
# Searches +key+ in @stack for +id+ hash and returns or yields the result.
#
def search(id, key) # :nodoc:
block_given = block_given?
visit(:search, id, key) do |k|
return block_given ? yield(k) : k
end
end
private :search
#
# Completes shortened long style option switch and returns pair of
# canonical switch and switch descriptor OptionParser::Switch.
#
# +typ+:: Searching table.
# +opt+:: Searching key.
# +icase+:: Search case insensitive if true.
# +pat+:: Optional pattern for completion.
#
def complete(typ, opt, icase = false, *pat) # :nodoc:
if pat.empty?
search(typ, opt) {|sw| return [sw, opt]} # exact match or...
end
ambiguous = catch(:ambiguous) {
visit(:complete, typ, opt, icase, *pat) {|o, *sw| return sw}
}
exc = ambiguous ? AmbiguousOption : InvalidOption
raise exc.new(opt, additional: self.method(:additional_message).curry[typ])
end
private :complete
#
# Returns additional info.
#
def additional_message(typ, opt)
return unless typ and opt and defined?(DidYouMean::SpellChecker)
all_candidates = []
visit(:get_candidates, typ) do |candidates|
all_candidates.concat(candidates)
end
all_candidates.select! {|cand| cand.is_a?(String) }
checker = DidYouMean::SpellChecker.new(dictionary: all_candidates)
DidYouMean.formatter.message_for(all_candidates & checker.correct(opt))
end
def candidate(word)
list = []
case word
when '-'
long = short = true
when /\A--/
word, arg = word.split(/=/, 2)
argpat = Completion.regexp(arg, false) if arg and !arg.empty?
long = true
when /\A-/
short = true
end
pat = Completion.regexp(word, long)
visit(:each_option) do |opt|
next unless Switch === opt
opts = (long ? opt.long : []) + (short ? opt.short : [])
opts = Completion.candidate(word, true, pat, &opts.method(:each)).map(&:first) if pat
if /\A=/ =~ opt.arg
opts.map! {|sw| sw + "="}
if arg and CompletingHash === opt.pattern
if opts = opt.pattern.candidate(arg, false, argpat)
opts.map!(&:last)
end
end
end
list.concat(opts)
end
list
end
#
# Loads options from file names as +filename+. Does nothing when the file
# is not present. Returns whether successfully loaded.
#
# +filename+ defaults to basename of the program without suffix in a
# directory ~/.options, then the basename with '.options' suffix
# under XDG and Haiku standard places.
#
# The optional +into+ keyword argument works exactly like that accepted in
# method #parse.
#
def load(filename = nil, into: nil)
unless filename
basename = File.basename($0, '.*')
return true if load(File.expand_path(basename, '~/.options'), into: into) rescue nil
basename << ".options"
return [
# XDG
ENV['XDG_CONFIG_HOME'],
'~/.config',
*ENV['XDG_CONFIG_DIRS']&.split(File::PATH_SEPARATOR),
# Haiku
'~/config/settings',
].any? {|dir|
next if !dir or dir.empty?
load(File.expand_path(basename, dir), into: into) rescue nil
}
end
begin
parse(*File.readlines(filename, chomp: true), into: into)
true
rescue Errno::ENOENT, Errno::ENOTDIR
false
end
end
#
# Parses environment variable +env+ or its uppercase with splitting like a
# shell.
#
# +env+ defaults to the basename of the program.
#
def environment(env = File.basename($0, '.*'))
env = ENV[env] || ENV[env.upcase] or return
require 'shellwords'
parse(*Shellwords.shellwords(env))
end
#
# Acceptable argument classes
#
#
# Any string and no conversion. This is fall-back.
#
accept(Object) {|s,|s or s.nil?}
accept(NilClass) {|s,|s}
#
# Any non-empty string, and no conversion.
#
accept(String, /.+/m) {|s,*|s}
#
# Ruby/C-like integer, octal for 0-7 sequence, binary for 0b, hexadecimal
# for 0x, and decimal for others; with optional sign prefix. Converts to
# Integer.
#
decimal = '\d+(?:_\d+)*'
binary = 'b[01]+(?:_[01]+)*'
hex = 'x[\da-f]+(?:_[\da-f]+)*'
octal = "0(?:[0-7]+(?:_[0-7]+)*|#{binary}|#{hex})?"
integer = "#{octal}|#{decimal}"
accept(Integer, %r"\A[-+]?(?:#{integer})\z"io) {|s,|
begin
Integer(s)
rescue ArgumentError
raise OptionParser::InvalidArgument, s
end if s
}
#
# Float number format, and converts to Float.
#
float = "(?:#{decimal}(?=(.)?)(?:\\.(?:#{decimal})?)?|\\.#{decimal})(?:E[-+]?#{decimal})?"
floatpat = %r"\A[-+]?#{float}\z"io
accept(Float, floatpat) {|s,| s.to_f if s}
#
# Generic numeric format, converts to Integer for integer format, Float
# for float format, and Rational for rational format.
#
real = "[-+]?(?:#{octal}|#{float})"
accept(Numeric, /\A(#{real})(?:\/(#{real}))?\z/io) {|s, d, f, n,|
if n
Rational(d, n)
elsif f
Float(s)
else
Integer(s)
end
}
#
# Decimal integer format, to be converted to Integer.
#
DecimalInteger = /\A[-+]?#{decimal}\z/io
accept(DecimalInteger, DecimalInteger) {|s,|
begin
Integer(s, 10)
rescue ArgumentError
raise OptionParser::InvalidArgument, s
end if s
}
#
# Ruby/C like octal/hexadecimal/binary integer format, to be converted to
# Integer.
#
OctalInteger = /\A[-+]?(?:[0-7]+(?:_[0-7]+)*|0(?:#{binary}|#{hex}))\z/io
accept(OctalInteger, OctalInteger) {|s,|
begin
Integer(s, 8)
rescue ArgumentError
raise OptionParser::InvalidArgument, s
end if s
}
#
# Decimal integer/float number format, to be converted to Integer for
# integer format, Float for float format.
#
DecimalNumeric = floatpat # decimal integer is allowed as float also.
accept(DecimalNumeric, floatpat) {|s, f|
begin
if f
Float(s)
else
Integer(s)
end
rescue ArgumentError
raise OptionParser::InvalidArgument, s
end if s
}
#
# Boolean switch, which means whether it is present or not, whether it is
# absent or not with prefix no-, or it takes an argument
# yes/no/true/false/+/-.
#
yesno = CompletingHash.new
%w[- no false].each {|el| yesno[el] = false}
%w[+ yes true].each {|el| yesno[el] = true}
yesno['nil'] = false # should be nil?
accept(TrueClass, yesno) {|arg, val| val == nil or val}
#
# Similar to TrueClass, but defaults to false.
#
accept(FalseClass, yesno) {|arg, val| val != nil and val}
#
# List of strings separated by ",".
#
accept(Array) do |s, |
if s
s = s.split(',').collect {|ss| ss unless ss.empty?}
end
s
end
#
# Regular expression with options.
#
accept(Regexp, %r"\A/((?:\\.|[^\\])*)/([[:alpha:]]+)?\z|.*") do |all, s, o|
f = 0
if o
f |= Regexp::IGNORECASE if /i/ =~ o
f |= Regexp::MULTILINE if /m/ =~ o
f |= Regexp::EXTENDED if /x/ =~ o
case o = o.delete("imx")
when ""
when "u"
s = s.encode(Encoding::UTF_8)
when "e"
s = s.encode(Encoding::EUC_JP)
when "s"
s = s.encode(Encoding::SJIS)
when "n"
f |= Regexp::NOENCODING
else
raise OptionParser::InvalidArgument, "unknown regexp option - #{o}"
end
else
s ||= all
end
Regexp.new(s, f)
end
#
# Exceptions
#
#
# Base class of exceptions from OptionParser.
#
class ParseError < RuntimeError
# Reason which caused the error.
Reason = 'parse error'
def initialize(*args, additional: nil)
@additional = additional
@arg0, = args
@args = args
@reason = nil
end
attr_reader :args
attr_writer :reason
attr_accessor :additional
#
# Pushes back erred argument(s) to +argv+.
#
def recover(argv)
argv[0, 0] = @args
argv
end
def self.filter_backtrace(array)
unless $DEBUG
array.delete_if(&%r"\A#{Regexp.quote(__FILE__)}:"o.method(:=~))
end
array
end
def set_backtrace(array)
super(self.class.filter_backtrace(array))
end
def set_option(opt, eq)
if eq
@args[0] = opt
else
@args.unshift(opt)
end
self
end
#
# Returns error reason. Override this for I18N.
#
def reason
@reason || self.class::Reason
end
def inspect
"#<#{self.class}: #{args.join(' ')}>"
end
#
# Default stringizing method to emit standard error message.
#
def message
"#{reason}: #{args.join(' ')}#{additional[@arg0] if additional}"
end
alias to_s message
end
#
# Raises when ambiguously completable string is encountered.
#
class AmbiguousOption < ParseError
const_set(:Reason, 'ambiguous option')
end
#
# Raises when there is an argument for a switch which takes no argument.
#
class NeedlessArgument < ParseError
const_set(:Reason, 'needless argument')
end
#
# Raises when a switch with mandatory argument has no argument.
#
class MissingArgument < ParseError
const_set(:Reason, 'missing argument')
end
#
# Raises when switch is undefined.
#
class InvalidOption < ParseError
const_set(:Reason, 'invalid option')
end
#
# Raises when the given argument does not match required format.
#
class InvalidArgument < ParseError
const_set(:Reason, 'invalid argument')
end
#
# Raises when the given argument word can't be completed uniquely.
#
class AmbiguousArgument < InvalidArgument
const_set(:Reason, 'ambiguous argument')
end
#
# Miscellaneous
#
#
# Extends command line arguments array (ARGV) to parse itself.
#
module Arguable
#
# Sets OptionParser object, when +opt+ is +false+ or +nil+, methods
# OptionParser::Arguable#options and OptionParser::Arguable#options= are
# undefined. Thus, there is no ways to access the OptionParser object
# via the receiver object.
#
def options=(opt)
unless @optparse = opt
class << self
undef_method(:options)
undef_method(:options=)
end
end
end
#
# Actual OptionParser object, automatically created if nonexistent.
#
# If called with a block, yields the OptionParser object and returns the
# result of the block. If an OptionParser::ParseError exception occurs
# in the block, it is rescued, a error message printed to STDERR and
# +nil+ returned.
#
def options
@optparse ||= OptionParser.new
@optparse.default_argv = self
block_given? or return @optparse
begin
yield @optparse
rescue ParseError
@optparse.warn $!
nil
end
end
#
# Parses +self+ destructively in order and returns +self+ containing the
# rest arguments left unparsed.
#
def order!(&blk) options.order!(self, &blk) end
#
# Parses +self+ destructively in permutation mode and returns +self+
# containing the rest arguments left unparsed.
#
def permute!() options.permute!(self) end
#
# Parses +self+ destructively and returns +self+ containing the
# rest arguments left unparsed.
#
def parse!() options.parse!(self) end
#
# Substitution of getopts is possible as follows. Also see
# OptionParser#getopts.
#
# def getopts(*args)
# ($OPT = ARGV.getopts(*args)).each do |opt, val|
# eval "$OPT_#{opt.gsub(/[^A-Za-z0-9_]/, '_')} = val"
# end
# rescue OptionParser::ParseError
# end
#
def getopts(*args, symbolize_names: false)
options.getopts(self, *args, symbolize_names: symbolize_names)
end
#
# Initializes instance variable.
#
def self.extend_object(obj)
super
obj.instance_eval {@optparse = nil}
end
def initialize(*args)
super
@optparse = nil
end
end
#
# Acceptable argument classes. Now contains DecimalInteger, OctalInteger
# and DecimalNumeric. See Acceptable argument classes (in source code).
#
module Acceptables
const_set(:DecimalInteger, OptionParser::DecimalInteger)
const_set(:OctalInteger, OptionParser::OctalInteger)
const_set(:DecimalNumeric, OptionParser::DecimalNumeric)
end
end
# ARGV is arguable by OptionParser
ARGV.extend(OptionParser::Arguable)
# An alias for OptionParser.
OptParse = OptionParser # :nodoc:
share/ruby/optparse/time.rb 0000644 00000000347 15173517736 0011772 0 ustar 00 # frozen_string_literal: false
require_relative '../optparse'
require 'time'
OptionParser.accept(Time) do |s,|
begin
(Time.httpdate(s) rescue Time.parse(s)) if s
rescue
raise OptionParser::InvalidArgument, s
end
end
share/ruby/optparse/kwargs.rb 0000644 00000001042 15173517736 0012323 0 ustar 00 # frozen_string_literal: true
require_relative '../optparse'
class OptionParser
# :call-seq:
# define_by_keywords(options, method, **params)
#
# :include: ../../doc/optparse/creates_option.rdoc
#
def define_by_keywords(options, meth, **opts)
meth.parameters.each do |type, name|
case type
when :key, :keyreq
op, cl = *(type == :key ? %w"[ ]" : ["", ""])
define("--#{name}=#{op}#{name.upcase}#{cl}", *opts[name]) do |o|
options[name] = o
end
end
end
options
end
end
share/ruby/optparse/version.rb 0000644 00000004015 15173517736 0012515 0 ustar 00 # frozen_string_literal: false
# OptionParser internal utility
class << OptionParser
def show_version(*pkgs)
progname = ARGV.options.program_name
result = false
show = proc do |klass, cname, version|
str = "#{progname}"
unless klass == ::Object and cname == :VERSION
version = version.join(".") if Array === version
str << ": #{klass}" unless klass == Object
str << " version #{version}"
end
[:Release, :RELEASE].find do |rel|
if klass.const_defined?(rel)
str << " (#{klass.const_get(rel)})"
end
end
puts str
result = true
end
if pkgs.size == 1 and pkgs[0] == "all"
self.search_const(::Object, /\AV(?:ERSION|ersion)\z/) do |klass, cname, version|
unless cname[1] == ?e and klass.const_defined?(:Version)
show.call(klass, cname.intern, version)
end
end
else
pkgs.each do |pkg|
begin
pkg = pkg.split(/::|\//).inject(::Object) {|m, c| m.const_get(c)}
v = case
when pkg.const_defined?(:Version)
pkg.const_get(n = :Version)
when pkg.const_defined?(:VERSION)
pkg.const_get(n = :VERSION)
else
n = nil
"unknown"
end
show.call(pkg, n, v)
rescue NameError
end
end
end
result
end
def each_const(path, base = ::Object)
path.split(/::|\//).inject(base) do |klass, name|
raise NameError, path unless Module === klass
klass.constants.grep(/#{name}/i) do |c|
klass.const_defined?(c) or next
klass.const_get(c)
end
end
end
def search_const(klass, name)
klasses = [klass]
while klass = klasses.shift
klass.constants.each do |cname|
klass.const_defined?(cname) or next
const = klass.const_get(cname)
yield klass, cname, const if name === cname
klasses << const if Module === const and const != ::Object
end
end
end
end
share/ruby/optparse/shellwords.rb 0000644 00000000244 15173517736 0013216 0 ustar 00 # frozen_string_literal: false
# -*- ruby -*-
require 'shellwords'
require_relative '../optparse'
OptionParser.accept(Shellwords) {|s,| Shellwords.shellwords(s)}
share/ruby/optparse/uri.rb 0000644 00000000217 15173517736 0011627 0 ustar 00 # frozen_string_literal: false
# -*- ruby -*-
require_relative '../optparse'
require 'uri'
OptionParser.accept(URI) {|s,| URI.parse(s) if s}
share/ruby/optparse/ac.rb 0000644 00000003032 15173517736 0011411 0 ustar 00 # frozen_string_literal: false
require_relative '../optparse'
class OptionParser::AC < OptionParser
private
def _check_ac_args(name, block)
unless /\A\w[-\w]*\z/ =~ name
raise ArgumentError, name
end
unless block
raise ArgumentError, "no block given", ParseError.filter_backtrace(caller)
end
end
ARG_CONV = proc {|val| val.nil? ? true : val}
def _ac_arg_enable(prefix, name, help_string, block)
_check_ac_args(name, block)
sdesc = []
ldesc = ["--#{prefix}-#{name}"]
desc = [help_string]
q = name.downcase
ac_block = proc {|val| block.call(ARG_CONV.call(val))}
enable = Switch::PlacedArgument.new(nil, ARG_CONV, sdesc, ldesc, nil, desc, ac_block)
disable = Switch::NoArgument.new(nil, proc {false}, sdesc, ldesc, nil, desc, ac_block)
top.append(enable, [], ["enable-" + q], disable, ['disable-' + q])
enable
end
public
def ac_arg_enable(name, help_string, &block)
_ac_arg_enable("enable", name, help_string, block)
end
def ac_arg_disable(name, help_string, &block)
_ac_arg_enable("disable", name, help_string, block)
end
def ac_arg_with(name, help_string, &block)
_check_ac_args(name, block)
sdesc = []
ldesc = ["--with-#{name}"]
desc = [help_string]
q = name.downcase
with = Switch::PlacedArgument.new(*search(:atype, String), sdesc, ldesc, nil, desc, block)
without = Switch::NoArgument.new(nil, proc {}, sdesc, ldesc, nil, desc, block)
top.append(with, [], ["with-" + q], without, ['without-' + q])
with
end
end
share/ruby/optparse/date.rb 0000644 00000000560 15173517736 0011746 0 ustar 00 # frozen_string_literal: false
require_relative '../optparse'
require 'date'
OptionParser.accept(DateTime) do |s,|
begin
DateTime.parse(s) if s
rescue ArgumentError
raise OptionParser::InvalidArgument, s
end
end
OptionParser.accept(Date) do |s,|
begin
Date.parse(s) if s
rescue ArgumentError
raise OptionParser::InvalidArgument, s
end
end
share/ruby/shellwords.rb 0000644 00000016160 15173517736 0011365 0 ustar 00 # frozen-string-literal: true
##
# == Manipulates strings like the UNIX Bourne shell
#
# This module manipulates strings according to the word parsing rules
# of the UNIX Bourne shell.
#
# The shellwords() function was originally a port of shellwords.pl,
# but modified to conform to the Shell & Utilities volume of the IEEE
# Std 1003.1-2008, 2016 Edition [1].
#
# === Usage
#
# You can use Shellwords to parse a string into a Bourne shell friendly Array.
#
# require 'shellwords'
#
# argv = Shellwords.split('three blind "mice"')
# argv #=> ["three", "blind", "mice"]
#
# Once you've required Shellwords, you can use the #split alias
# String#shellsplit.
#
# argv = "see how they run".shellsplit
# argv #=> ["see", "how", "they", "run"]
#
# They treat quotes as special characters, so an unmatched quote will
# cause an ArgumentError.
#
# argv = "they all ran after the farmer's wife".shellsplit
# #=> ArgumentError: Unmatched quote: ...
#
# Shellwords also provides methods that do the opposite.
# Shellwords.escape, or its alias, String#shellescape, escapes
# shell metacharacters in a string for use in a command line.
#
# filename = "special's.txt"
#
# system("cat -- #{filename.shellescape}")
# # runs "cat -- special\\'s.txt"
#
# Note the '--'. Without it, cat(1) will treat the following argument
# as a command line option if it starts with '-'. It is guaranteed
# that Shellwords.escape converts a string to a form that a Bourne
# shell will parse back to the original string, but it is the
# programmer's responsibility to make sure that passing an arbitrary
# argument to a command does no harm.
#
# Shellwords also comes with a core extension for Array, Array#shelljoin.
#
# dir = "Funny GIFs"
# argv = %W[ls -lta -- #{dir}]
# system(argv.shelljoin + " | less")
# # runs "ls -lta -- Funny\\ GIFs | less"
#
# You can use this method to build a complete command line out of an
# array of arguments.
#
# === Authors
# * Wakou Aoyama
# * Akinori MUSHA <knu@iDaemons.org>
#
# === Contact
# * Akinori MUSHA <knu@iDaemons.org> (current maintainer)
#
# === Resources
#
# 1: {IEEE Std 1003.1-2008, 2016 Edition, the Shell & Utilities volume}[http://pubs.opengroup.org/onlinepubs/9699919799/utilities/contents.html]
module Shellwords
VERSION = "0.2.0"
# Splits a string into an array of tokens in the same way the UNIX
# Bourne shell does.
#
# argv = Shellwords.split('here are "two words"')
# argv #=> ["here", "are", "two words"]
#
# Note, however, that this is not a command line parser. Shell
# metacharacters except for the single and double quotes and
# backslash are not treated as such.
#
# argv = Shellwords.split('ruby my_prog.rb | less')
# argv #=> ["ruby", "my_prog.rb", "|", "less"]
#
# String#shellsplit is a shortcut for this function.
#
# argv = 'here are "two words"'.shellsplit
# argv #=> ["here", "are", "two words"]
def shellsplit(line)
words = []
field = String.new
line.scan(/\G\s*(?>([^\s\\\'\"]+)|'([^\']*)'|"((?:[^\"\\]|\\.)*)"|(\\.?)|(\S))(\s|\z)?/m) do
|word, sq, dq, esc, garbage, sep|
raise ArgumentError, "Unmatched quote: #{line.inspect}" if garbage
# 2.2.3 Double-Quotes:
#
# The <backslash> shall retain its special meaning as an
# escape character only when followed by one of the following
# characters when considered special:
#
# $ ` " \ <newline>
field << (word || sq || (dq && dq.gsub(/\\([$`"\\\n])/, '\\1')) || esc.gsub(/\\(.)/, '\\1'))
if sep
words << field
field = String.new
end
end
words
end
alias shellwords shellsplit
module_function :shellsplit, :shellwords
class << self
alias split shellsplit
end
# Escapes a string so that it can be safely used in a Bourne shell
# command line. +str+ can be a non-string object that responds to
# +to_s+.
#
# Note that a resulted string should be used unquoted and is not
# intended for use in double quotes nor in single quotes.
#
# argv = Shellwords.escape("It's better to give than to receive")
# argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"
#
# String#shellescape is a shorthand for this function.
#
# argv = "It's better to give than to receive".shellescape
# argv #=> "It\\'s\\ better\\ to\\ give\\ than\\ to\\ receive"
#
# # Search files in lib for method definitions
# pattern = "^[ \t]*def "
# open("| grep -Ern -e #{pattern.shellescape} lib") { |grep|
# grep.each_line { |line|
# file, lineno, matched_line = line.split(':', 3)
# # ...
# }
# }
#
# It is the caller's responsibility to encode the string in the right
# encoding for the shell environment where this string is used.
#
# Multibyte characters are treated as multibyte characters, not as bytes.
#
# Returns an empty quoted String if +str+ has a length of zero.
def shellescape(str)
str = str.to_s
# An empty argument will be skipped, so return empty quotes.
return "''".dup if str.empty?
str = str.dup
# Treat multibyte characters as is. It is the caller's responsibility
# to encode the string in the right encoding for the shell
# environment.
str.gsub!(/[^A-Za-z0-9_\-.,:+\/@\n]/, "\\\\\\&")
# A LF cannot be escaped with a backslash because a backslash + LF
# combo is regarded as a line continuation and simply ignored.
str.gsub!(/\n/, "'\n'")
return str
end
module_function :shellescape
class << self
alias escape shellescape
end
# Builds a command line string from an argument list, +array+.
#
# All elements are joined into a single string with fields separated by a
# space, where each element is escaped for the Bourne shell and stringified
# using +to_s+.
#
# ary = ["There's", "a", "time", "and", "place", "for", "everything"]
# argv = Shellwords.join(ary)
# argv #=> "There\\'s a time and place for everything"
#
# Array#shelljoin is a shortcut for this function.
#
# ary = ["Don't", "rock", "the", "boat"]
# argv = ary.shelljoin
# argv #=> "Don\\'t rock the boat"
#
# You can also mix non-string objects in the elements as allowed in Array#join.
#
# output = `#{['ps', '-p', $$].shelljoin}`
#
def shelljoin(array)
array.map { |arg| shellescape(arg) }.join(' ')
end
module_function :shelljoin
class << self
alias join shelljoin
end
end
class String
# call-seq:
# str.shellsplit => array
#
# Splits +str+ into an array of tokens in the same way the UNIX
# Bourne shell does.
#
# See Shellwords.shellsplit for details.
def shellsplit
Shellwords.split(self)
end
# call-seq:
# str.shellescape => string
#
# Escapes +str+ so that it can be safely used in a Bourne shell
# command line.
#
# See Shellwords.shellescape for details.
def shellescape
Shellwords.escape(self)
end
end
class Array
# call-seq:
# array.shelljoin => string
#
# Builds a command line string from an argument list +array+ joining
# all elements escaped for the Bourne shell and separated by a space.
#
# See Shellwords.shelljoin for details.
def shelljoin
Shellwords.join(self)
end
end
share/ruby/forwardable.rb 0000644 00000022035 15173517736 0011465 0 ustar 00 # frozen_string_literal: false
#
# forwardable.rb -
# $Release Version: 1.1$
# $Revision$
# by Keiju ISHITSUKA(keiju@ishitsuka.com)
# original definition by delegator.rb
# Revised by Daniel J. Berger with suggestions from Florian Gross.
#
# Documentation by James Edward Gray II and Gavin Sinclair
# The Forwardable module provides delegation of specified
# methods to a designated object, using the methods #def_delegator
# and #def_delegators.
#
# For example, say you have a class RecordCollection which
# contains an array <tt>@records</tt>. You could provide the lookup method
# #record_number(), which simply calls #[] on the <tt>@records</tt>
# array, like this:
#
# require 'forwardable'
#
# class RecordCollection
# attr_accessor :records
# extend Forwardable
# def_delegator :@records, :[], :record_number
# end
#
# We can use the lookup method like so:
#
# r = RecordCollection.new
# r.records = [4,5,6]
# r.record_number(0) # => 4
#
# Further, if you wish to provide the methods #size, #<<, and #map,
# all of which delegate to @records, this is how you can do it:
#
# class RecordCollection # re-open RecordCollection class
# def_delegators :@records, :size, :<<, :map
# end
#
# r = RecordCollection.new
# r.records = [1,2,3]
# r.record_number(0) # => 1
# r.size # => 3
# r << 4 # => [1, 2, 3, 4]
# r.map { |x| x * 2 } # => [2, 4, 6, 8]
#
# You can even extend regular objects with Forwardable.
#
# my_hash = Hash.new
# my_hash.extend Forwardable # prepare object for delegation
# my_hash.def_delegator "STDOUT", "puts" # add delegation for STDOUT.puts()
# my_hash.puts "Howdy!"
#
# == Another example
#
# You could use Forwardable as an alternative to inheritance, when you don't want
# to inherit all methods from the superclass. For instance, here is how you might
# add a range of +Array+ instance methods to a new class +Queue+:
#
# class Queue
# extend Forwardable
#
# def initialize
# @q = [ ] # prepare delegate object
# end
#
# # setup preferred interface, enq() and deq()...
# def_delegator :@q, :push, :enq
# def_delegator :@q, :shift, :deq
#
# # support some general Array methods that fit Queues well
# def_delegators :@q, :clear, :first, :push, :shift, :size
# end
#
# q = Thread::Queue.new
# q.enq 1, 2, 3, 4, 5
# q.push 6
#
# q.shift # => 1
# while q.size > 0
# puts q.deq
# end
#
# q.enq "Ruby", "Perl", "Python"
# puts q.first
# q.clear
# puts q.first
#
# This should output:
#
# 2
# 3
# 4
# 5
# 6
# Ruby
# nil
#
# == Notes
#
# Be advised, RDoc will not detect delegated methods.
#
# +forwardable.rb+ provides single-method delegation via the def_delegator and
# def_delegators methods. For full-class delegation via DelegateClass, see
# +delegate.rb+.
#
module Forwardable
require 'forwardable/impl'
# Version of +forwardable.rb+
VERSION = "1.3.3"
VERSION.freeze
FORWARDABLE_VERSION = VERSION
FORWARDABLE_VERSION.freeze
@debug = nil
class << self
# ignored
attr_accessor :debug
end
# Takes a hash as its argument. The key is a symbol or an array of
# symbols. These symbols correspond to method names, instance variable
# names, or constant names (see def_delegator). The value is
# the accessor to which the methods will be delegated.
#
# :call-seq:
# delegate method => accessor
# delegate [method, method, ...] => accessor
#
def instance_delegate(hash)
hash.each do |methods, accessor|
unless defined?(methods.each)
def_instance_delegator(accessor, methods)
else
methods.each {|method| def_instance_delegator(accessor, method)}
end
end
end
#
# Shortcut for defining multiple delegator methods, but with no
# provision for using a different name. The following two code
# samples have the same effect:
#
# def_delegators :@records, :size, :<<, :map
#
# def_delegator :@records, :size
# def_delegator :@records, :<<
# def_delegator :@records, :map
#
def def_instance_delegators(accessor, *methods)
methods.each do |method|
next if /\A__(?:send|id)__\z/ =~ method
def_instance_delegator(accessor, method)
end
end
# Define +method+ as delegator instance method with an optional
# alias name +ali+. Method calls to +ali+ will be delegated to
# +accessor.method+. +accessor+ should be a method name, instance
# variable name, or constant name. Use the full path to the
# constant if providing the constant name.
# Returns the name of the method defined.
#
# class MyQueue
# CONST = 1
# extend Forwardable
# attr_reader :queue
# def initialize
# @queue = []
# end
#
# def_delegator :@queue, :push, :mypush
# def_delegator 'MyQueue::CONST', :to_i
# end
#
# q = MyQueue.new
# q.mypush 42
# q.queue #=> [42]
# q.push 23 #=> NoMethodError
# q.to_i #=> 1
#
def def_instance_delegator(accessor, method, ali = method)
gen = Forwardable._delegator_method(self, accessor, method, ali)
# If it's not a class or module, it's an instance
mod = Module === self ? self : singleton_class
ret = mod.module_eval(&gen)
mod.__send__(:ruby2_keywords, ali) if RUBY_VERSION >= '2.7'
ret
end
alias delegate instance_delegate
alias def_delegators def_instance_delegators
alias def_delegator def_instance_delegator
# :nodoc:
def self._delegator_method(obj, accessor, method, ali)
accessor = accessor.to_s unless Symbol === accessor
if Module === obj ?
obj.method_defined?(accessor) || obj.private_method_defined?(accessor) :
obj.respond_to?(accessor, true)
accessor = "#{accessor}()"
end
method_call = ".__send__(:#{method}, *args, &block)"
if _valid_method?(method)
loc, = caller_locations(2,1)
pre = "_ ="
mesg = "#{Module === obj ? obj : obj.class}\##{ali} at #{loc.path}:#{loc.lineno} forwarding to private method "
method_call = "#{<<-"begin;"}\n#{<<-"end;".chomp}"
begin;
unless defined? _.#{method}
::Kernel.warn #{mesg.dump}"\#{_.class}"'##{method}', uplevel: 1
_#{method_call}
else
_.#{method}(*args, &block)
end
end;
end
_compile_method("#{<<-"begin;"}\n#{<<-"end;"}", __FILE__, __LINE__+1)
begin;
proc do
def #{ali}(*args, &block)
#{pre}
begin
#{accessor}
end#{method_call}
end
end
end;
end
end
# SingleForwardable can be used to setup delegation at the object level as well.
#
# printer = String.new
# printer.extend SingleForwardable # prepare object for delegation
# printer.def_delegator "STDOUT", "puts" # add delegation for STDOUT.puts()
# printer.puts "Howdy!"
#
# Also, SingleForwardable can be used to set up delegation for a Class or Module.
#
# class Implementation
# def self.service
# puts "serviced!"
# end
# end
#
# module Facade
# extend SingleForwardable
# def_delegator :Implementation, :service
# end
#
# Facade.service #=> serviced!
#
# If you want to use both Forwardable and SingleForwardable, you can
# use methods def_instance_delegator and def_single_delegator, etc.
module SingleForwardable
# Takes a hash as its argument. The key is a symbol or an array of
# symbols. These symbols correspond to method names. The value is
# the accessor to which the methods will be delegated.
#
# :call-seq:
# delegate method => accessor
# delegate [method, method, ...] => accessor
#
def single_delegate(hash)
hash.each do |methods, accessor|
unless defined?(methods.each)
def_single_delegator(accessor, methods)
else
methods.each {|method| def_single_delegator(accessor, method)}
end
end
end
#
# Shortcut for defining multiple delegator methods, but with no
# provision for using a different name. The following two code
# samples have the same effect:
#
# def_delegators :@records, :size, :<<, :map
#
# def_delegator :@records, :size
# def_delegator :@records, :<<
# def_delegator :@records, :map
#
def def_single_delegators(accessor, *methods)
methods.each do |method|
next if /\A__(?:send|id)__\z/ =~ method
def_single_delegator(accessor, method)
end
end
# :call-seq:
# def_single_delegator(accessor, method, new_name=method)
#
# Defines a method _method_ which delegates to _accessor_ (i.e. it calls
# the method of the same name in _accessor_). If _new_name_ is
# provided, it is used as the name for the delegate method.
# Returns the name of the method defined.
def def_single_delegator(accessor, method, ali = method)
gen = Forwardable._delegator_method(self, accessor, method, ali)
ret = instance_eval(&gen)
singleton_class.__send__(:ruby2_keywords, ali) if RUBY_VERSION >= '2.7'
ret
end
alias delegate single_delegate
alias def_delegators def_single_delegators
alias def_delegator def_single_delegator
end
share/ruby/syntax_suggest.rb 0000644 00000000112 15173517736 0012254 0 ustar 00 # frozen_string_literal: true
require_relative "syntax_suggest/core_ext"
share/ruby/singleton.rb 0000644 00000007703 15173517736 0011204 0 ustar 00 # frozen_string_literal: false
# The Singleton module implements the Singleton pattern.
#
# == Usage
#
# To use Singleton, include the module in your class.
#
# class Klass
# include Singleton
# # ...
# end
#
# This ensures that only one instance of Klass can be created.
#
# a,b = Klass.instance, Klass.instance
#
# a == b
# # => true
#
# Klass.new
# # => NoMethodError - new is private ...
#
# The instance is created at upon the first call of Klass.instance().
#
# class OtherKlass
# include Singleton
# # ...
# end
#
# ObjectSpace.each_object(OtherKlass){}
# # => 0
#
# OtherKlass.instance
# ObjectSpace.each_object(OtherKlass){}
# # => 1
#
#
# This behavior is preserved under inheritance and cloning.
#
# == Implementation
#
# This above is achieved by:
#
# * Making Klass.new and Klass.allocate private.
#
# * Overriding Klass.inherited(sub_klass) and Klass.clone() to ensure that the
# Singleton properties are kept when inherited and cloned.
#
# * Providing the Klass.instance() method that returns the same object each
# time it is called.
#
# * Overriding Klass._load(str) to call Klass.instance().
#
# * Overriding Klass#clone and Klass#dup to raise TypeErrors to prevent
# cloning or duping.
#
# == Singleton and Marshal
#
# By default Singleton's #_dump(depth) returns the empty string. Marshalling by
# default will strip state information, e.g. instance variables from the instance.
# Classes using Singleton can provide custom _load(str) and _dump(depth) methods
# to retain some of the previous state of the instance.
#
# require 'singleton'
#
# class Example
# include Singleton
# attr_accessor :keep, :strip
# def _dump(depth)
# # this strips the @strip information from the instance
# Marshal.dump(@keep, depth)
# end
#
# def self._load(str)
# instance.keep = Marshal.load(str)
# instance
# end
# end
#
# a = Example.instance
# a.keep = "keep this"
# a.strip = "get rid of this"
#
# stored_state = Marshal.dump(a)
#
# a.keep = nil
# a.strip = nil
# b = Marshal.load(stored_state)
# p a == b # => true
# p a.keep # => "keep this"
# p a.strip # => nil
#
module Singleton
VERSION = "0.2.0"
# Raises a TypeError to prevent cloning.
def clone
raise TypeError, "can't clone instance of singleton #{self.class}"
end
# Raises a TypeError to prevent duping.
def dup
raise TypeError, "can't dup instance of singleton #{self.class}"
end
# By default, do not retain any state when marshalling.
def _dump(depth = -1)
''
end
module SingletonClassMethods # :nodoc:
def clone # :nodoc:
Singleton.__init__(super)
end
# By default calls instance(). Override to retain singleton state.
def _load(str)
instance
end
def instance # :nodoc:
@singleton__instance__ || @singleton__mutex__.synchronize { @singleton__instance__ ||= new }
end
private
def inherited(sub_klass)
super
Singleton.__init__(sub_klass)
end
end
class << Singleton # :nodoc:
def __init__(klass) # :nodoc:
klass.instance_eval {
@singleton__instance__ = nil
@singleton__mutex__ = Thread::Mutex.new
}
klass
end
private
# extending an object with Singleton is a bad idea
undef_method :extend_object
def append_features(mod)
# help out people counting on transitive mixins
unless mod.instance_of?(Class)
raise TypeError, "Inclusion of the OO-Singleton module in module #{mod}"
end
super
end
def included(klass)
super
klass.private_class_method :new, :allocate
klass.extend SingletonClassMethods
Singleton.__init__(klass)
end
end
##
# :singleton-method: _load
# By default calls instance(). Override to retain singleton state.
##
# :singleton-method: instance
# Returns the singleton instance.
end
share/gems/gems/psych-5.1.2/lib/psych.rb 0000644 00000060707 15173517736 0013575 0 ustar 00 # frozen_string_literal: true
require_relative 'psych/versions'
case RUBY_ENGINE
when 'jruby'
require_relative 'psych_jars'
if JRuby::Util.respond_to?(:load_ext)
JRuby::Util.load_ext('org.jruby.ext.psych.PsychLibrary')
else
require 'java'; require 'jruby'
org.jruby.ext.psych.PsychLibrary.new.load(JRuby.runtime, false)
end
else
require 'psych.so'
end
require_relative 'psych/nodes'
require_relative 'psych/streaming'
require_relative 'psych/visitors'
require_relative 'psych/handler'
require_relative 'psych/tree_builder'
require_relative 'psych/parser'
require_relative 'psych/omap'
require_relative 'psych/set'
require_relative 'psych/coder'
require_relative 'psych/core_ext'
require_relative 'psych/stream'
require_relative 'psych/json/tree_builder'
require_relative 'psych/json/stream'
require_relative 'psych/handlers/document_stream'
require_relative 'psych/class_loader'
###
# = Overview
#
# Psych is a YAML parser and emitter.
# Psych leverages libyaml [Home page: https://pyyaml.org/wiki/LibYAML]
# or [git repo: https://github.com/yaml/libyaml] for its YAML parsing
# and emitting capabilities. In addition to wrapping libyaml, Psych also
# knows how to serialize and de-serialize most Ruby objects to and from
# the YAML format.
#
# = I NEED TO PARSE OR EMIT YAML RIGHT NOW!
#
# # Parse some YAML
# Psych.load("--- foo") # => "foo"
#
# # Emit some YAML
# Psych.dump("foo") # => "--- foo\n...\n"
# { :a => 'b'}.to_yaml # => "---\n:a: b\n"
#
# Got more time on your hands? Keep on reading!
#
# == YAML Parsing
#
# Psych provides a range of interfaces for parsing a YAML document ranging from
# low level to high level, depending on your parsing needs. At the lowest
# level, is an event based parser. Mid level is access to the raw YAML AST,
# and at the highest level is the ability to unmarshal YAML to Ruby objects.
#
# == YAML Emitting
#
# Psych provides a range of interfaces ranging from low to high level for
# producing YAML documents. Very similar to the YAML parsing interfaces, Psych
# provides at the lowest level, an event based system, mid-level is building
# a YAML AST, and the highest level is converting a Ruby object straight to
# a YAML document.
#
# == High-level API
#
# === Parsing
#
# The high level YAML parser provided by Psych simply takes YAML as input and
# returns a Ruby data structure. For information on using the high level parser
# see Psych.load
#
# ==== Reading from a string
#
# Psych.safe_load("--- a") # => 'a'
# Psych.safe_load("---\n - a\n - b") # => ['a', 'b']
# # From a trusted string:
# Psych.load("--- !ruby/range\nbegin: 0\nend: 42\nexcl: false\n") # => 0..42
#
# ==== Reading from a file
#
# Psych.safe_load_file("data.yml", permitted_classes: [Date])
# Psych.load_file("trusted_database.yml")
#
# ==== Exception handling
#
# begin
# # The second argument changes only the exception contents
# Psych.parse("--- `", "file.txt")
# rescue Psych::SyntaxError => ex
# ex.file # => 'file.txt'
# ex.message # => "(file.txt): found character that cannot start any token"
# end
#
# === Emitting
#
# The high level emitter has the easiest interface. Psych simply takes a Ruby
# data structure and converts it to a YAML document. See Psych.dump for more
# information on dumping a Ruby data structure.
#
# ==== Writing to a string
#
# # Dump an array, get back a YAML string
# Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
#
# # Dump an array to an IO object
# Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
#
# # Dump an array with indentation set
# Psych.dump(['a', ['b']], :indentation => 3) # => "---\n- a\n- - b\n"
#
# # Dump an array to an IO with indentation set
# Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)
#
# ==== Writing to a file
#
# Currently there is no direct API for dumping Ruby structure to file:
#
# File.open('database.yml', 'w') do |file|
# file.write(Psych.dump(['a', 'b']))
# end
#
# == Mid-level API
#
# === Parsing
#
# Psych provides access to an AST produced from parsing a YAML document. This
# tree is built using the Psych::Parser and Psych::TreeBuilder. The AST can
# be examined and manipulated freely. Please see Psych::parse_stream,
# Psych::Nodes, and Psych::Nodes::Node for more information on dealing with
# YAML syntax trees.
#
# ==== Reading from a string
#
# # Returns Psych::Nodes::Stream
# Psych.parse_stream("---\n - a\n - b")
#
# # Returns Psych::Nodes::Document
# Psych.parse("---\n - a\n - b")
#
# ==== Reading from a file
#
# # Returns Psych::Nodes::Stream
# Psych.parse_stream(File.read('database.yml'))
#
# # Returns Psych::Nodes::Document
# Psych.parse_file('database.yml')
#
# ==== Exception handling
#
# begin
# # The second argument changes only the exception contents
# Psych.parse("--- `", "file.txt")
# rescue Psych::SyntaxError => ex
# ex.file # => 'file.txt'
# ex.message # => "(file.txt): found character that cannot start any token"
# end
#
# === Emitting
#
# At the mid level is building an AST. This AST is exactly the same as the AST
# used when parsing a YAML document. Users can build an AST by hand and the
# AST knows how to emit itself as a YAML document. See Psych::Nodes,
# Psych::Nodes::Node, and Psych::TreeBuilder for more information on building
# a YAML AST.
#
# ==== Writing to a string
#
# # We need Psych::Nodes::Stream (not Psych::Nodes::Document)
# stream = Psych.parse_stream("---\n - a\n - b")
#
# stream.to_yaml # => "---\n- a\n- b\n"
#
# ==== Writing to a file
#
# # We need Psych::Nodes::Stream (not Psych::Nodes::Document)
# stream = Psych.parse_stream(File.read('database.yml'))
#
# File.open('database.yml', 'w') do |file|
# file.write(stream.to_yaml)
# end
#
# == Low-level API
#
# === Parsing
#
# The lowest level parser should be used when the YAML input is already known,
# and the developer does not want to pay the price of building an AST or
# automatic detection and conversion to Ruby objects. See Psych::Parser for
# more information on using the event based parser.
#
# ==== Reading to Psych::Nodes::Stream structure
#
# parser = Psych::Parser.new(TreeBuilder.new) # => #<Psych::Parser>
# parser = Psych.parser # it's an alias for the above
#
# parser.parse("---\n - a\n - b") # => #<Psych::Parser>
# parser.handler # => #<Psych::TreeBuilder>
# parser.handler.root # => #<Psych::Nodes::Stream>
#
# ==== Receiving an events stream
#
# recorder = Psych::Handlers::Recorder.new
# parser = Psych::Parser.new(recorder)
#
# parser.parse("---\n - a\n - b")
# recorder.events # => [list of [event, args] lists]
# # event is one of: Psych::Handler::EVENTS
# # args are the arguments passed to the event
#
# === Emitting
#
# The lowest level emitter is an event based system. Events are sent to a
# Psych::Emitter object. That object knows how to convert the events to a YAML
# document. This interface should be used when document format is known in
# advance or speed is a concern. See Psych::Emitter for more information.
#
# ==== Writing to a Ruby structure
#
# Psych.parser.parse("--- a") # => #<Psych::Parser>
#
# parser.handler.first # => #<Psych::Nodes::Stream>
# parser.handler.first.to_ruby # => ["a"]
#
# parser.handler.root.first # => #<Psych::Nodes::Document>
# parser.handler.root.first.to_ruby # => "a"
#
# # You can instantiate an Emitter manually
# Psych::Visitors::ToRuby.new.accept(parser.handler.root.first)
# # => "a"
module Psych
# The version of libyaml Psych is using
LIBYAML_VERSION = Psych.libyaml_version.join('.').freeze
###
# Load +yaml+ in to a Ruby data structure. If multiple documents are
# provided, the object contained in the first document will be returned.
# +filename+ will be used in the exception message if any exception
# is raised while parsing. If +yaml+ is empty, it returns
# the specified +fallback+ return value, which defaults to +false+.
#
# Raises a Psych::SyntaxError when a YAML syntax error is detected.
#
# Example:
#
# Psych.unsafe_load("--- a") # => 'a'
# Psych.unsafe_load("---\n - a\n - b") # => ['a', 'b']
#
# begin
# Psych.unsafe_load("--- `", filename: "file.txt")
# rescue Psych::SyntaxError => ex
# ex.file # => 'file.txt'
# ex.message # => "(file.txt): found character that cannot start any token"
# end
#
# When the optional +symbolize_names+ keyword argument is set to a
# true value, returns symbols for keys in Hash objects (default: strings).
#
# Psych.unsafe_load("---\n foo: bar") # => {"foo"=>"bar"}
# Psych.unsafe_load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
#
# Raises a TypeError when `yaml` parameter is NilClass
#
# NOTE: This method *should not* be used to parse untrusted documents, such as
# YAML documents that are supplied via user input. Instead, please use the
# load method or the safe_load method.
#
def self.unsafe_load yaml, filename: nil, fallback: false, symbolize_names: false, freeze: false, strict_integer: false
result = parse(yaml, filename: filename)
return fallback unless result
result.to_ruby(symbolize_names: symbolize_names, freeze: freeze, strict_integer: strict_integer)
end
###
# Safely load the yaml string in +yaml+. By default, only the following
# classes are allowed to be deserialized:
#
# * TrueClass
# * FalseClass
# * NilClass
# * Integer
# * Float
# * String
# * Array
# * Hash
#
# Recursive data structures are not allowed by default. Arbitrary classes
# can be allowed by adding those classes to the +permitted_classes+ keyword argument. They are
# additive. For example, to allow Date deserialization:
#
# Psych.safe_load(yaml, permitted_classes: [Date])
#
# Now the Date class can be loaded in addition to the classes listed above.
#
# Aliases can be explicitly allowed by changing the +aliases+ keyword argument.
# For example:
#
# x = []
# x << x
# yaml = Psych.dump x
# Psych.safe_load yaml # => raises an exception
# Psych.safe_load yaml, aliases: true # => loads the aliases
#
# A Psych::DisallowedClass exception will be raised if the yaml contains a
# class that isn't in the +permitted_classes+ list.
#
# A Psych::AliasesNotEnabled exception will be raised if the yaml contains aliases
# but the +aliases+ keyword argument is set to false.
#
# +filename+ will be used in the exception message if any exception is raised
# while parsing.
#
# When the optional +symbolize_names+ keyword argument is set to a
# true value, returns symbols for keys in Hash objects (default: strings).
#
# Psych.safe_load("---\n foo: bar") # => {"foo"=>"bar"}
# Psych.safe_load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
#
def self.safe_load yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false
result = parse(yaml, filename: filename)
return fallback unless result
class_loader = ClassLoader::Restricted.new(permitted_classes.map(&:to_s),
permitted_symbols.map(&:to_s))
scanner = ScalarScanner.new class_loader, strict_integer: strict_integer
visitor = if aliases
Visitors::ToRuby.new scanner, class_loader, symbolize_names: symbolize_names, freeze: freeze
else
Visitors::NoAliasRuby.new scanner, class_loader, symbolize_names: symbolize_names, freeze: freeze
end
result = visitor.accept result
result
end
###
# Load +yaml+ in to a Ruby data structure. If multiple documents are
# provided, the object contained in the first document will be returned.
# +filename+ will be used in the exception message if any exception
# is raised while parsing. If +yaml+ is empty, it returns
# the specified +fallback+ return value, which defaults to +false+.
#
# Raises a Psych::SyntaxError when a YAML syntax error is detected.
#
# Example:
#
# Psych.load("--- a") # => 'a'
# Psych.load("---\n - a\n - b") # => ['a', 'b']
#
# begin
# Psych.load("--- `", filename: "file.txt")
# rescue Psych::SyntaxError => ex
# ex.file # => 'file.txt'
# ex.message # => "(file.txt): found character that cannot start any token"
# end
#
# When the optional +symbolize_names+ keyword argument is set to a
# true value, returns symbols for keys in Hash objects (default: strings).
#
# Psych.load("---\n foo: bar") # => {"foo"=>"bar"}
# Psych.load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
#
# Raises a TypeError when `yaml` parameter is NilClass. This method is
# similar to `safe_load` except that `Symbol` objects are allowed by default.
#
def self.load yaml, permitted_classes: [Symbol], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false
safe_load yaml, permitted_classes: permitted_classes,
permitted_symbols: permitted_symbols,
aliases: aliases,
filename: filename,
fallback: fallback,
symbolize_names: symbolize_names,
freeze: freeze,
strict_integer: strict_integer
end
###
# Parse a YAML string in +yaml+. Returns the Psych::Nodes::Document.
# +filename+ is used in the exception message if a Psych::SyntaxError is
# raised.
#
# Raises a Psych::SyntaxError when a YAML syntax error is detected.
#
# Example:
#
# Psych.parse("---\n - a\n - b") # => #<Psych::Nodes::Document:0x00>
#
# begin
# Psych.parse("--- `", filename: "file.txt")
# rescue Psych::SyntaxError => ex
# ex.file # => 'file.txt'
# ex.message # => "(file.txt): found character that cannot start any token"
# end
#
# See Psych::Nodes for more information about YAML AST.
def self.parse yaml, filename: nil
parse_stream(yaml, filename: filename) do |node|
return node
end
false
end
###
# Parse a file at +filename+. Returns the Psych::Nodes::Document.
#
# Raises a Psych::SyntaxError when a YAML syntax error is detected.
def self.parse_file filename, fallback: false
result = File.open filename, 'r:bom|utf-8' do |f|
parse f, filename: filename
end
result || fallback
end
###
# Returns a default parser
def self.parser
Psych::Parser.new(TreeBuilder.new)
end
###
# Parse a YAML string in +yaml+. Returns the Psych::Nodes::Stream.
# This method can handle multiple YAML documents contained in +yaml+.
# +filename+ is used in the exception message if a Psych::SyntaxError is
# raised.
#
# If a block is given, a Psych::Nodes::Document node will be yielded to the
# block as it's being parsed.
#
# Raises a Psych::SyntaxError when a YAML syntax error is detected.
#
# Example:
#
# Psych.parse_stream("---\n - a\n - b") # => #<Psych::Nodes::Stream:0x00>
#
# Psych.parse_stream("--- a\n--- b") do |node|
# node # => #<Psych::Nodes::Document:0x00>
# end
#
# begin
# Psych.parse_stream("--- `", filename: "file.txt")
# rescue Psych::SyntaxError => ex
# ex.file # => 'file.txt'
# ex.message # => "(file.txt): found character that cannot start any token"
# end
#
# Raises a TypeError when NilClass is passed.
#
# See Psych::Nodes for more information about YAML AST.
def self.parse_stream yaml, filename: nil, &block
if block_given?
parser = Psych::Parser.new(Handlers::DocumentStream.new(&block))
parser.parse yaml, filename
else
parser = self.parser
parser.parse yaml, filename
parser.handler.root
end
end
###
# call-seq:
# Psych.dump(o) -> string of yaml
# Psych.dump(o, options) -> string of yaml
# Psych.dump(o, io) -> io object passed in
# Psych.dump(o, io, options) -> io object passed in
#
# Dump Ruby object +o+ to a YAML string. Optional +options+ may be passed in
# to control the output format. If an IO object is passed in, the YAML will
# be dumped to that IO object.
#
# Currently supported options are:
#
# [<tt>:indentation</tt>] Number of space characters used to indent.
# Acceptable value should be in <tt>0..9</tt> range,
# otherwise option is ignored.
#
# Default: <tt>2</tt>.
# [<tt>:line_width</tt>] Max character to wrap line at.
#
# Default: <tt>0</tt> (meaning "wrap at 81").
# [<tt>:canonical</tt>] Write "canonical" YAML form (very verbose, yet
# strictly formal).
#
# Default: <tt>false</tt>.
# [<tt>:header</tt>] Write <tt>%YAML [version]</tt> at the beginning of document.
#
# Default: <tt>false</tt>.
#
# Example:
#
# # Dump an array, get back a YAML string
# Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
#
# # Dump an array to an IO object
# Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
#
# # Dump an array with indentation set
# Psych.dump(['a', ['b']], indentation: 3) # => "---\n- a\n- - b\n"
#
# # Dump an array to an IO with indentation set
# Psych.dump(['a', ['b']], StringIO.new, indentation: 3)
def self.dump o, io = nil, options = {}
if Hash === io
options = io
io = nil
end
visitor = Psych::Visitors::YAMLTree.create options
visitor << o
visitor.tree.yaml io, options
end
###
# call-seq:
# Psych.safe_dump(o) -> string of yaml
# Psych.safe_dump(o, options) -> string of yaml
# Psych.safe_dump(o, io) -> io object passed in
# Psych.safe_dump(o, io, options) -> io object passed in
#
# Safely dump Ruby object +o+ to a YAML string. Optional +options+ may be passed in
# to control the output format. If an IO object is passed in, the YAML will
# be dumped to that IO object. By default, only the following
# classes are allowed to be serialized:
#
# * TrueClass
# * FalseClass
# * NilClass
# * Integer
# * Float
# * String
# * Array
# * Hash
#
# Arbitrary classes can be allowed by adding those classes to the +permitted_classes+
# keyword argument. They are additive. For example, to allow Date serialization:
#
# Psych.safe_dump(yaml, permitted_classes: [Date])
#
# Now the Date class can be dumped in addition to the classes listed above.
#
# A Psych::DisallowedClass exception will be raised if the object contains a
# class that isn't in the +permitted_classes+ list.
#
# Currently supported options are:
#
# [<tt>:indentation</tt>] Number of space characters used to indent.
# Acceptable value should be in <tt>0..9</tt> range,
# otherwise option is ignored.
#
# Default: <tt>2</tt>.
# [<tt>:line_width</tt>] Max character to wrap line at.
#
# Default: <tt>0</tt> (meaning "wrap at 81").
# [<tt>:canonical</tt>] Write "canonical" YAML form (very verbose, yet
# strictly formal).
#
# Default: <tt>false</tt>.
# [<tt>:header</tt>] Write <tt>%YAML [version]</tt> at the beginning of document.
#
# Default: <tt>false</tt>.
#
# Example:
#
# # Dump an array, get back a YAML string
# Psych.safe_dump(['a', 'b']) # => "---\n- a\n- b\n"
#
# # Dump an array to an IO object
# Psych.safe_dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
#
# # Dump an array with indentation set
# Psych.safe_dump(['a', ['b']], indentation: 3) # => "---\n- a\n- - b\n"
#
# # Dump an array to an IO with indentation set
# Psych.safe_dump(['a', ['b']], StringIO.new, indentation: 3)
def self.safe_dump o, io = nil, options = {}
if Hash === io
options = io
io = nil
end
visitor = Psych::Visitors::RestrictedYAMLTree.create options
visitor << o
visitor.tree.yaml io, options
end
###
# Dump a list of objects as separate documents to a document stream.
#
# Example:
#
# Psych.dump_stream("foo\n ", {}) # => "--- ! \"foo\\n \"\n--- {}\n"
def self.dump_stream *objects
visitor = Psych::Visitors::YAMLTree.create({})
objects.each do |o|
visitor << o
end
visitor.tree.yaml
end
###
# Dump Ruby +object+ to a JSON string.
def self.to_json object
visitor = Psych::Visitors::JSONTree.create
visitor << object
visitor.tree.yaml
end
###
# Load multiple documents given in +yaml+. Returns the parsed documents
# as a list. If a block is given, each document will be converted to Ruby
# and passed to the block during parsing
#
# Example:
#
# Psych.load_stream("--- foo\n...\n--- bar\n...") # => ['foo', 'bar']
#
# list = []
# Psych.load_stream("--- foo\n...\n--- bar\n...") do |ruby|
# list << ruby
# end
# list # => ['foo', 'bar']
#
def self.load_stream yaml, filename: nil, fallback: [], **kwargs
result = if block_given?
parse_stream(yaml, filename: filename) do |node|
yield node.to_ruby(**kwargs)
end
else
parse_stream(yaml, filename: filename).children.map { |node| node.to_ruby(**kwargs) }
end
return fallback if result.is_a?(Array) && result.empty?
result
end
###
# Load the document contained in +filename+. Returns the yaml contained in
# +filename+ as a Ruby object, or if the file is empty, it returns
# the specified +fallback+ return value, which defaults to +false+.
#
# NOTE: This method *should not* be used to parse untrusted documents, such as
# YAML documents that are supplied via user input. Instead, please use the
# safe_load_file method.
def self.unsafe_load_file filename, **kwargs
File.open(filename, 'r:bom|utf-8') { |f|
self.unsafe_load f, filename: filename, **kwargs
}
end
###
# Safely loads the document contained in +filename+. Returns the yaml contained in
# +filename+ as a Ruby object, or if the file is empty, it returns
# the specified +fallback+ return value, which defaults to +false+.
# See safe_load for options.
def self.safe_load_file filename, **kwargs
File.open(filename, 'r:bom|utf-8') { |f|
self.safe_load f, filename: filename, **kwargs
}
end
###
# Loads the document contained in +filename+. Returns the yaml contained in
# +filename+ as a Ruby object, or if the file is empty, it returns
# the specified +fallback+ return value, which defaults to +false+.
# See load for options.
def self.load_file filename, **kwargs
File.open(filename, 'r:bom|utf-8') { |f|
self.load f, filename: filename, **kwargs
}
end
# :stopdoc:
def self.add_domain_type domain, type_tag, &block
key = ['tag', domain, type_tag].join ':'
domain_types[key] = [key, block]
domain_types["tag:#{type_tag}"] = [key, block]
end
def self.add_builtin_type type_tag, &block
domain = 'yaml.org,2002'
key = ['tag', domain, type_tag].join ':'
domain_types[key] = [key, block]
end
def self.remove_type type_tag
domain_types.delete type_tag
end
def self.add_tag tag, klass
load_tags[tag] = klass.name
dump_tags[klass] = tag
end
class << self
if defined?(Ractor)
class Config
attr_accessor :load_tags, :dump_tags, :domain_types
def initialize
@load_tags = {}
@dump_tags = {}
@domain_types = {}
end
end
def config
Ractor.current[:PsychConfig] ||= Config.new
end
def load_tags
config.load_tags
end
def dump_tags
config.dump_tags
end
def domain_types
config.domain_types
end
def load_tags=(value)
config.load_tags = value
end
def dump_tags=(value)
config.dump_tags = value
end
def domain_types=(value)
config.domain_types = value
end
else
attr_accessor :load_tags
attr_accessor :dump_tags
attr_accessor :domain_types
end
end
self.load_tags = {}
self.dump_tags = {}
self.domain_types = {}
# :startdoc:
end
share/ruby/ripper/sexp.rb 0000644 00000011054 15173517736 0011454 0 ustar 00 # frozen_string_literal: true
#
# $Id$
#
# Copyright (c) 2004,2005 Minero Aoki
#
# This program is free software.
# You can distribute and/or modify this program under the Ruby License.
# For details of Ruby License, see ruby/COPYING.
#
require 'ripper/core'
class Ripper
# [EXPERIMENTAL]
# Parses +src+ and create S-exp tree.
# Returns more readable tree rather than Ripper.sexp_raw.
# This method is mainly for developer use.
# The +filename+ argument is mostly ignored.
# By default, this method does not handle syntax errors in +src+,
# returning +nil+ in such cases. Use the +raise_errors+ keyword
# to raise a SyntaxError for an error in +src+.
#
# require 'ripper'
# require 'pp'
#
# pp Ripper.sexp("def m(a) nil end")
# #=> [:program,
# [[:def,
# [:@ident, "m", [1, 4]],
# [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil, nil, nil, nil]],
# [:bodystmt, [[:var_ref, [:@kw, "nil", [1, 9]]]], nil, nil, nil]]]]
#
def Ripper.sexp(src, filename = '-', lineno = 1, raise_errors: false)
builder = SexpBuilderPP.new(src, filename, lineno)
sexp = builder.parse
if builder.error?
if raise_errors
raise SyntaxError, builder.error
end
else
sexp
end
end
# [EXPERIMENTAL]
# Parses +src+ and create S-exp tree.
# This method is mainly for developer use.
# The +filename+ argument is mostly ignored.
# By default, this method does not handle syntax errors in +src+,
# returning +nil+ in such cases. Use the +raise_errors+ keyword
# to raise a SyntaxError for an error in +src+.
#
# require 'ripper'
# require 'pp'
#
# pp Ripper.sexp_raw("def m(a) nil end")
# #=> [:program,
# [:stmts_add,
# [:stmts_new],
# [:def,
# [:@ident, "m", [1, 4]],
# [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil]],
# [:bodystmt,
# [:stmts_add, [:stmts_new], [:var_ref, [:@kw, "nil", [1, 9]]]],
# nil,
# nil,
# nil]]]]
#
def Ripper.sexp_raw(src, filename = '-', lineno = 1, raise_errors: false)
builder = SexpBuilder.new(src, filename, lineno)
sexp = builder.parse
if builder.error?
if raise_errors
raise SyntaxError, builder.error
end
else
sexp
end
end
class SexpBuilder < ::Ripper #:nodoc:
attr_reader :error
private
def dedent_element(e, width)
if (n = dedent_string(e[1], width)) > 0
e[2][1] += n
end
e
end
def on_heredoc_dedent(val, width)
sub = proc do |cont|
cont.map! do |e|
if Array === e
case e[0]
when :@tstring_content
e = dedent_element(e, width)
when /_add\z/
e[1] = sub[e[1]]
end
elsif String === e
dedent_string(e, width)
end
e
end
end
sub[val]
val
end
events = private_instance_methods(false).grep(/\Aon_/) {$'.to_sym}
(PARSER_EVENTS - events).each do |event|
module_eval(<<-End, __FILE__, __LINE__ + 1)
def on_#{event}(*args)
args.unshift :#{event}
args
end
End
end
SCANNER_EVENTS.each do |event|
module_eval(<<-End, __FILE__, __LINE__ + 1)
def on_#{event}(tok)
[:@#{event}, tok, [lineno(), column()]]
end
End
end
def on_error(mesg)
@error = mesg
end
remove_method :on_parse_error
alias on_parse_error on_error
alias compile_error on_error
end
class SexpBuilderPP < SexpBuilder #:nodoc:
private
def on_heredoc_dedent(val, width)
val.map! do |e|
next e if Symbol === e and /_content\z/ =~ e
if Array === e and e[0] == :@tstring_content
e = dedent_element(e, width)
elsif String === e
dedent_string(e, width)
end
e
end
val
end
def _dispatch_event_new
[]
end
def _dispatch_event_push(list, item)
list.push item
list
end
def on_mlhs_paren(list)
[:mlhs, *list]
end
def on_mlhs_add_star(list, star)
list.push([:rest_param, star])
end
def on_mlhs_add_post(list, post)
list.concat(post)
end
PARSER_EVENT_TABLE.each do |event, arity|
if /_new\z/ =~ event and arity == 0
alias_method "on_#{event}", :_dispatch_event_new
elsif /_add\z/ =~ event
alias_method "on_#{event}", :_dispatch_event_push
end
end
end
end
share/ruby/ripper/lexer.rb 0000644 00000023270 15173517736 0011617 0 ustar 00 # frozen_string_literal: true
#
# $Id$
#
# Copyright (c) 2004,2005 Minero Aoki
#
# This program is free software.
# You can distribute and/or modify this program under the Ruby License.
# For details of Ruby License, see ruby/COPYING.
#
require 'ripper/core'
class Ripper
# Tokenizes the Ruby program and returns an array of strings.
# The +filename+ and +lineno+ arguments are mostly ignored, since the
# return value is just the tokenized input.
# By default, this method does not handle syntax errors in +src+,
# use the +raise_errors+ keyword to raise a SyntaxError for an error in +src+.
#
# p Ripper.tokenize("def m(a) nil end")
# # => ["def", " ", "m", "(", "a", ")", " ", "nil", " ", "end"]
#
def Ripper.tokenize(src, filename = '-', lineno = 1, **kw)
Lexer.new(src, filename, lineno).tokenize(**kw)
end
# Tokenizes the Ruby program and returns an array of an array,
# which is formatted like
# <code>[[lineno, column], type, token, state]</code>.
# The +filename+ argument is mostly ignored.
# By default, this method does not handle syntax errors in +src+,
# use the +raise_errors+ keyword to raise a SyntaxError for an error in +src+.
#
# require 'ripper'
# require 'pp'
#
# pp Ripper.lex("def m(a) nil end")
# #=> [[[1, 0], :on_kw, "def", FNAME ],
# [[1, 3], :on_sp, " ", FNAME ],
# [[1, 4], :on_ident, "m", ENDFN ],
# [[1, 5], :on_lparen, "(", BEG|LABEL],
# [[1, 6], :on_ident, "a", ARG ],
# [[1, 7], :on_rparen, ")", ENDFN ],
# [[1, 8], :on_sp, " ", BEG ],
# [[1, 9], :on_kw, "nil", END ],
# [[1, 12], :on_sp, " ", END ],
# [[1, 13], :on_kw, "end", END ]]
#
def Ripper.lex(src, filename = '-', lineno = 1, **kw)
Lexer.new(src, filename, lineno).lex(**kw)
end
class Lexer < ::Ripper #:nodoc: internal use only
class State
attr_reader :to_int, :to_s
def initialize(i)
@to_int = i
@to_s = Ripper.lex_state_name(i)
freeze
end
def [](index)
case index
when 0, :to_int
@to_int
when 1, :to_s
@event
else
nil
end
end
alias to_i to_int
alias inspect to_s
def pretty_print(q) q.text(to_s) end
def ==(i) super or to_int == i end
def &(i) self.class.new(to_int & i) end
def |(i) self.class.new(to_int | i) end
def allbits?(i) to_int.allbits?(i) end
def anybits?(i) to_int.anybits?(i) end
def nobits?(i) to_int.nobits?(i) end
end
class Elem
attr_accessor :pos, :event, :tok, :state, :message
def initialize(pos, event, tok, state, message = nil)
@pos = pos
@event = event
@tok = tok
@state = State.new(state)
@message = message
end
def [](index)
case index
when 0, :pos
@pos
when 1, :event
@event
when 2, :tok
@tok
when 3, :state
@state
when 4, :message
@message
else
nil
end
end
def inspect
"#<#{self.class}: #{event}@#{pos[0]}:#{pos[1]}:#{state}: #{tok.inspect}#{": " if message}#{message}>"
end
alias to_s inspect
def pretty_print(q)
q.group(2, "#<#{self.class}:", ">") {
q.breakable
q.text("#{event}@#{pos[0]}:#{pos[1]}")
q.breakable
state.pretty_print(q)
q.breakable
q.text("token: ")
tok.pretty_print(q)
if message
q.breakable
q.text("message: ")
q.text(message)
end
}
end
def to_a
if @message
[@pos, @event, @tok, @state, @message]
else
[@pos, @event, @tok, @state]
end
end
end
attr_reader :errors
def tokenize(**kw)
parse(**kw).sort_by(&:pos).map(&:tok)
end
def lex(**kw)
parse(**kw).sort_by(&:pos).map(&:to_a)
end
# parse the code and returns elements including errors.
def scan(**kw)
result = (parse(**kw) + errors + @stack.flatten).uniq.sort_by {|e| [*e.pos, (e.message ? -1 : 0)]}
result.each_with_index do |e, i|
if e.event == :on_parse_error and e.tok.empty? and (pre = result[i-1]) and
pre.pos[0] == e.pos[0] and (pre.pos[1] + pre.tok.size) == e.pos[1]
e.tok = pre.tok
e.pos[1] = pre.pos[1]
result[i-1] = e
result[i] = pre
end
end
result
end
def parse(raise_errors: false)
@errors = []
@buf = []
@stack = []
super()
@buf = @stack.pop unless @stack.empty?
if raise_errors and !@errors.empty?
raise SyntaxError, @errors.map(&:message).join(' ;')
end
@buf.flatten!
unless (result = @buf).empty?
result.concat(@buf) until (@buf = []; super(); @buf.flatten!; @buf.empty?)
end
result
end
private
unless SCANNER_EVENT_TABLE.key?(:ignored_sp)
SCANNER_EVENT_TABLE[:ignored_sp] = 1
SCANNER_EVENTS << :ignored_sp
EVENTS << :ignored_sp
end
def on_heredoc_dedent(v, w)
ignored_sp = []
heredoc = @buf.last
if Array === heredoc
heredoc.each_with_index do |e, i|
if Elem === e and e.event == :on_tstring_content and e.pos[1].zero?
tok = e.tok.dup if w > 0 and /\A\s/ =~ e.tok
if (n = dedent_string(e.tok, w)) > 0
if e.tok.empty?
e.tok = tok[0, n]
e.event = :on_ignored_sp
next
end
ignored_sp << [i, Elem.new(e.pos.dup, :on_ignored_sp, tok[0, n], e.state)]
e.pos[1] += n
end
end
end
end
ignored_sp.reverse_each do |i, e|
heredoc[i, 0] = [e]
end
v
end
def on_heredoc_beg(tok)
@stack.push @buf
buf = []
@buf.push buf
@buf = buf
@buf.push Elem.new([lineno(), column()], __callee__, tok, state())
end
def on_heredoc_end(tok)
@buf.push Elem.new([lineno(), column()], __callee__, tok, state())
@buf = @stack.pop unless @stack.empty?
end
def _push_token(tok)
e = Elem.new([lineno(), column()], __callee__, tok, state())
@buf.push(e)
e
end
def on_error1(mesg)
@errors.push Elem.new([lineno(), column()], __callee__, token(), state(), mesg)
end
def on_error2(mesg, elem)
if elem
elem = Elem.new(elem.pos, __callee__, elem.tok, elem.state, mesg)
else
elem = Elem.new([lineno(), column()], __callee__, token(), state(), mesg)
end
@errors.push elem
end
PARSER_EVENTS.grep(/_error\z/) do |e|
arity = PARSER_EVENT_TABLE.fetch(e)
alias_method "on_#{e}", "on_error#{arity}"
end
alias compile_error on_error1
(SCANNER_EVENTS.map {|event|:"on_#{event}"} - private_instance_methods(false)).each do |event|
alias_method event, :_push_token
end
end
# [EXPERIMENTAL]
# Parses +src+ and return a string which was matched to +pattern+.
# +pattern+ should be described as Regexp.
#
# require 'ripper'
#
# p Ripper.slice('def m(a) nil end', 'ident') #=> "m"
# p Ripper.slice('def m(a) nil end', '[ident lparen rparen]+') #=> "m(a)"
# p Ripper.slice("<<EOS\nstring\nEOS",
# 'heredoc_beg nl $(tstring_content*) heredoc_end', 1)
# #=> "string\n"
#
def Ripper.slice(src, pattern, n = 0)
if m = token_match(src, pattern)
then m.string(n)
else nil
end
end
def Ripper.token_match(src, pattern) #:nodoc:
TokenPattern.compile(pattern).match(src)
end
class TokenPattern #:nodoc:
class Error < ::StandardError # :nodoc:
end
class CompileError < Error # :nodoc:
end
class MatchError < Error # :nodoc:
end
class << self
alias compile new
end
def initialize(pattern)
@source = pattern
@re = compile(pattern)
end
def match(str)
match_list(::Ripper.lex(str))
end
def match_list(tokens)
if m = @re.match(map_tokens(tokens))
then MatchData.new(tokens, m)
else nil
end
end
private
def compile(pattern)
if m = /[^\w\s$()\[\]{}?*+\.]/.match(pattern)
raise CompileError, "invalid char in pattern: #{m[0].inspect}"
end
buf = +''
pattern.scan(/(?:\w+|\$\(|[()\[\]\{\}?*+\.]+)/) do |tok|
case tok
when /\w/
buf.concat map_token(tok)
when '$('
buf.concat '('
when '('
buf.concat '(?:'
when /[?*\[\])\.]/
buf.concat tok
else
raise 'must not happen'
end
end
Regexp.compile(buf)
rescue RegexpError => err
raise CompileError, err.message
end
def map_tokens(tokens)
tokens.map {|pos,type,str| map_token(type.to_s.delete_prefix('on_')) }.join
end
MAP = {}
seed = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
SCANNER_EVENT_TABLE.each do |ev, |
raise CompileError, "[RIPPER FATAL] too many system token" if seed.empty?
MAP[ev.to_s.delete_prefix('on_')] = seed.shift
end
def map_token(tok)
MAP[tok] or raise CompileError, "unknown token: #{tok}"
end
class MatchData # :nodoc:
def initialize(tokens, match)
@tokens = tokens
@match = match
end
def string(n = 0)
return nil unless @match
match(n).join
end
private
def match(n = 0)
return [] unless @match
@tokens[@match.begin(n)...@match.end(n)].map {|pos,type,str| str }
end
end
end
end
share/ruby/ripper/core.rb 0000644 00000003253 15173517736 0011427 0 ustar 00 # frozen_string_literal: true
#
# $Id$
#
# Copyright (c) 2003-2005 Minero Aoki
#
# This program is free software.
# You can distribute and/or modify this program under the Ruby License.
# For details of Ruby License, see ruby/COPYING.
#
require 'ripper.so'
class Ripper
# Parses the given Ruby program read from +src+.
# +src+ must be a String or an IO or a object with a #gets method.
def Ripper.parse(src, filename = '(ripper)', lineno = 1)
new(src, filename, lineno).parse
end
# This array contains name of parser events.
PARSER_EVENTS = PARSER_EVENT_TABLE.keys
# This array contains name of scanner events.
SCANNER_EVENTS = SCANNER_EVENT_TABLE.keys
# This array contains name of all ripper events.
EVENTS = PARSER_EVENTS + SCANNER_EVENTS
private
# :stopdoc:
def _dispatch_0() nil end
def _dispatch_1(a) a end
def _dispatch_2(a, b) a end
def _dispatch_3(a, b, c) a end
def _dispatch_4(a, b, c, d) a end
def _dispatch_5(a, b, c, d, e) a end
def _dispatch_6(a, b, c, d, e, f) a end
def _dispatch_7(a, b, c, d, e, f, g) a end
# :startdoc:
#
# Parser Events
#
PARSER_EVENT_TABLE.each do |id, arity|
alias_method "on_#{id}", "_dispatch_#{arity}"
end
# This method is called when weak warning is produced by the parser.
# +fmt+ and +args+ is printf style.
def warn(fmt, *args)
end
# This method is called when strong warning is produced by the parser.
# +fmt+ and +args+ is printf style.
def warning(fmt, *args)
end
# This method is called when the parser found syntax error.
def compile_error(msg)
end
#
# Scanner Events
#
SCANNER_EVENTS.each do |id|
alias_method "on_#{id}", :_dispatch_1
end
end
share/ruby/ripper/filter.rb 0000644 00000004160 15173517736 0011762 0 ustar 00 # frozen_string_literal: true
#
# $Id$
#
# Copyright (c) 2004,2005 Minero Aoki
#
# This program is free software.
# You can distribute and/or modify this program under the Ruby License.
# For details of Ruby License, see ruby/COPYING.
#
require 'ripper/lexer'
class Ripper
# This class handles only scanner events,
# which are dispatched in the 'right' order (same with input).
class Filter
# Creates a new Ripper::Filter instance, passes parameters +src+,
# +filename+, and +lineno+ to Ripper::Lexer.new
#
# The lexer is for internal use only.
def initialize(src, filename = '-', lineno = 1)
@__lexer = Lexer.new(src, filename, lineno)
@__line = nil
@__col = nil
@__state = nil
end
# The file name of the input.
def filename
@__lexer.filename
end
# The line number of the current token.
# This value starts from 1.
# This method is valid only in event handlers.
def lineno
@__line
end
# The column number of the current token.
# This value starts from 0.
# This method is valid only in event handlers.
def column
@__col
end
# The scanner's state of the current token.
# This value is the bitwise OR of zero or more of the +Ripper::EXPR_*+ constants.
def state
@__state
end
# Starts the parser.
# +init+ is a data accumulator and is passed to the next event handler (as
# of Enumerable#inject).
def parse(init = nil)
data = init
@__lexer.lex.each do |pos, event, tok, state|
@__line, @__col = *pos
@__state = state
data = if respond_to?(event, true)
then __send__(event, tok, data)
else on_default(event, tok, data)
end
end
data
end
private
# This method is called when some event handler is undefined.
# +event+ is :on_XXX, +token+ is the scanned token, and +data+ is a data
# accumulator.
#
# The return value of this method is passed to the next event handler (as
# of Enumerable#inject).
def on_default(event, token, data)
data
end
end
end
share/ruby/uri.rb 0000644 00000006073 15173517736 0010000 0 ustar 00 # frozen_string_literal: false
# URI is a module providing classes to handle Uniform Resource Identifiers
# (RFC2396[http://tools.ietf.org/html/rfc2396]).
#
# == Features
#
# * Uniform way of handling URIs.
# * Flexibility to introduce custom URI schemes.
# * Flexibility to have an alternate URI::Parser (or just different patterns
# and regexp's).
#
# == Basic example
#
# require 'uri'
#
# uri = URI("http://foo.com/posts?id=30&limit=5#time=1305298413")
# #=> #<URI::HTTP http://foo.com/posts?id=30&limit=5#time=1305298413>
#
# uri.scheme #=> "http"
# uri.host #=> "foo.com"
# uri.path #=> "/posts"
# uri.query #=> "id=30&limit=5"
# uri.fragment #=> "time=1305298413"
#
# uri.to_s #=> "http://foo.com/posts?id=30&limit=5#time=1305298413"
#
# == Adding custom URIs
#
# module URI
# class RSYNC < Generic
# DEFAULT_PORT = 873
# end
# register_scheme 'RSYNC', RSYNC
# end
# #=> URI::RSYNC
#
# URI.scheme_list
# #=> {"FILE"=>URI::File, "FTP"=>URI::FTP, "HTTP"=>URI::HTTP,
# # "HTTPS"=>URI::HTTPS, "LDAP"=>URI::LDAP, "LDAPS"=>URI::LDAPS,
# # "MAILTO"=>URI::MailTo, "RSYNC"=>URI::RSYNC}
#
# uri = URI("rsync://rsync.foo.com")
# #=> #<URI::RSYNC rsync://rsync.foo.com>
#
# == RFC References
#
# A good place to view an RFC spec is http://www.ietf.org/rfc.html.
#
# Here is a list of all related RFC's:
# - RFC822[http://tools.ietf.org/html/rfc822]
# - RFC1738[http://tools.ietf.org/html/rfc1738]
# - RFC2255[http://tools.ietf.org/html/rfc2255]
# - RFC2368[http://tools.ietf.org/html/rfc2368]
# - RFC2373[http://tools.ietf.org/html/rfc2373]
# - RFC2396[http://tools.ietf.org/html/rfc2396]
# - RFC2732[http://tools.ietf.org/html/rfc2732]
# - RFC3986[http://tools.ietf.org/html/rfc3986]
#
# == Class tree
#
# - URI::Generic (in uri/generic.rb)
# - URI::File - (in uri/file.rb)
# - URI::FTP - (in uri/ftp.rb)
# - URI::HTTP - (in uri/http.rb)
# - URI::HTTPS - (in uri/https.rb)
# - URI::LDAP - (in uri/ldap.rb)
# - URI::LDAPS - (in uri/ldaps.rb)
# - URI::MailTo - (in uri/mailto.rb)
# - URI::Parser - (in uri/common.rb)
# - URI::REGEXP - (in uri/common.rb)
# - URI::REGEXP::PATTERN - (in uri/common.rb)
# - URI::Util - (in uri/common.rb)
# - URI::Error - (in uri/common.rb)
# - URI::InvalidURIError - (in uri/common.rb)
# - URI::InvalidComponentError - (in uri/common.rb)
# - URI::BadURIError - (in uri/common.rb)
#
# == Copyright Info
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# Documentation::
# Akira Yamada <akira@ruby-lang.org>
# Dmitry V. Sabanin <sdmitry@lrn.ru>
# Vincent Batts <vbatts@hashbangbash.com>
# License::
# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
# You can redistribute it and/or modify it under the same term as Ruby.
#
module URI
end
require_relative 'uri/version'
require_relative 'uri/common'
require_relative 'uri/generic'
require_relative 'uri/file'
require_relative 'uri/ftp'
require_relative 'uri/http'
require_relative 'uri/https'
require_relative 'uri/ldap'
require_relative 'uri/ldaps'
require_relative 'uri/mailto'
require_relative 'uri/ws'
require_relative 'uri/wss'
share/ruby/csv.rb 0000644 00000270732 15173517736 0010001 0 ustar 00 # encoding: US-ASCII
# frozen_string_literal: true
# = csv.rb -- CSV Reading and Writing
#
# Created by James Edward Gray II on 2005-10-31.
#
# See CSV for documentation.
#
# == Description
#
# Welcome to the new and improved CSV.
#
# This version of the CSV library began its life as FasterCSV. FasterCSV was
# intended as a replacement to Ruby's then standard CSV library. It was
# designed to address concerns users of that library had and it had three
# primary goals:
#
# 1. Be significantly faster than CSV while remaining a pure Ruby library.
# 2. Use a smaller and easier to maintain code base. (FasterCSV eventually
# grew larger, was also but considerably richer in features. The parsing
# core remains quite small.)
# 3. Improve on the CSV interface.
#
# Obviously, the last one is subjective. I did try to defer to the original
# interface whenever I didn't have a compelling reason to change it though, so
# hopefully this won't be too radically different.
#
# We must have met our goals because FasterCSV was renamed to CSV and replaced
# the original library as of Ruby 1.9. If you are migrating code from 1.8 or
# earlier, you may have to change your code to comply with the new interface.
#
# == What's the Different From the Old CSV?
#
# I'm sure I'll miss something, but I'll try to mention most of the major
# differences I am aware of, to help others quickly get up to speed:
#
# === \CSV Parsing
#
# * This parser is m17n aware. See CSV for full details.
# * This library has a stricter parser and will throw MalformedCSVErrors on
# problematic data.
# * This library has a less liberal idea of a line ending than CSV. What you
# set as the <tt>:row_sep</tt> is law. It can auto-detect your line endings
# though.
# * The old library returned empty lines as <tt>[nil]</tt>. This library calls
# them <tt>[]</tt>.
# * This library has a much faster parser.
#
# === Interface
#
# * CSV now uses keyword parameters to set options.
# * CSV no longer has generate_row() or parse_row().
# * The old CSV's Reader and Writer classes have been dropped.
# * CSV::open() is now more like Ruby's open().
# * CSV objects now support most standard IO methods.
# * CSV now has a new() method used to wrap objects like String and IO for
# reading and writing.
# * CSV::generate() is different from the old method.
# * CSV no longer supports partial reads. It works line-by-line.
# * CSV no longer allows the instance methods to override the separators for
# performance reasons. They must be set in the constructor.
#
# If you use this library and find yourself missing any functionality I have
# trimmed, please {let me know}[mailto:james@grayproductions.net].
#
# == Documentation
#
# See CSV for documentation.
#
# == What is CSV, really?
#
# CSV maintains a pretty strict definition of CSV taken directly from
# {the RFC}[https://www.ietf.org/rfc/rfc4180.txt]. I relax the rules in only one
# place and that is to make using this library easier. CSV will parse all valid
# CSV.
#
# What you don't want to do is to feed CSV invalid data. Because of the way the
# CSV format works, it's common for a parser to need to read until the end of
# the file to be sure a field is invalid. This consumes a lot of time and memory.
#
# Luckily, when working with invalid CSV, Ruby's built-in methods will almost
# always be superior in every way. For example, parsing non-quoted fields is as
# easy as:
#
# data.split(",")
#
# == Questions and/or Comments
#
# Feel free to email {James Edward Gray II}[mailto:james@grayproductions.net]
# with any questions.
require "forwardable"
require "date"
require "stringio"
require_relative "csv/fields_converter"
require_relative "csv/input_record_separator"
require_relative "csv/parser"
require_relative "csv/row"
require_relative "csv/table"
require_relative "csv/writer"
# == \CSV
#
# === \CSV Data
#
# \CSV (comma-separated values) data is a text representation of a table:
# - A _row_ _separator_ delimits table rows.
# A common row separator is the newline character <tt>"\n"</tt>.
# - A _column_ _separator_ delimits fields in a row.
# A common column separator is the comma character <tt>","</tt>.
#
# This \CSV \String, with row separator <tt>"\n"</tt>
# and column separator <tt>","</tt>,
# has three rows and two columns:
# "foo,0\nbar,1\nbaz,2\n"
#
# Despite the name \CSV, a \CSV representation can use different separators.
#
# For more about tables, see the Wikipedia article
# "{Table (information)}[https://en.wikipedia.org/wiki/Table_(information)]",
# especially its section
# "{Simple table}[https://en.wikipedia.org/wiki/Table_(information)#Simple_table]"
#
# == \Class \CSV
#
# Class \CSV provides methods for:
# - Parsing \CSV data from a \String object, a \File (via its file path), or an \IO object.
# - Generating \CSV data to a \String object.
#
# To make \CSV available:
# require 'csv'
#
# All examples here assume that this has been done.
#
# == Keeping It Simple
#
# A \CSV object has dozens of instance methods that offer fine-grained control
# of parsing and generating \CSV data.
# For many needs, though, simpler approaches will do.
#
# This section summarizes the singleton methods in \CSV
# that allow you to parse and generate without explicitly
# creating \CSV objects.
# For details, follow the links.
#
# === Simple Parsing
#
# Parsing methods commonly return either of:
# - An \Array of Arrays of Strings:
# - The outer \Array is the entire "table".
# - Each inner \Array is a row.
# - Each \String is a field.
# - A CSV::Table object. For details, see
# {\CSV with Headers}[#class-CSV-label-CSV+with+Headers].
#
# ==== Parsing a \String
#
# The input to be parsed can be a string:
# string = "foo,0\nbar,1\nbaz,2\n"
#
# \Method CSV.parse returns the entire \CSV data:
# CSV.parse(string) # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# \Method CSV.parse_line returns only the first row:
# CSV.parse_line(string) # => ["foo", "0"]
#
# \CSV extends class \String with instance method String#parse_csv,
# which also returns only the first row:
# string.parse_csv # => ["foo", "0"]
#
# ==== Parsing Via a \File Path
#
# The input to be parsed can be in a file:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# \Method CSV.read returns the entire \CSV data:
# CSV.read(path) # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# \Method CSV.foreach iterates, passing each row to the given block:
# CSV.foreach(path) do |row|
# p row
# end
# Output:
# ["foo", "0"]
# ["bar", "1"]
# ["baz", "2"]
#
# \Method CSV.table returns the entire \CSV data as a CSV::Table object:
# CSV.table(path) # => #<CSV::Table mode:col_or_row row_count:3>
#
# ==== Parsing from an Open \IO Stream
#
# The input to be parsed can be in an open \IO stream:
#
# \Method CSV.read returns the entire \CSV data:
# File.open(path) do |file|
# CSV.read(file)
# end # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# As does method CSV.parse:
# File.open(path) do |file|
# CSV.parse(file)
# end # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# \Method CSV.parse_line returns only the first row:
# File.open(path) do |file|
# CSV.parse_line(file)
# end # => ["foo", "0"]
#
# \Method CSV.foreach iterates, passing each row to the given block:
# File.open(path) do |file|
# CSV.foreach(file) do |row|
# p row
# end
# end
# Output:
# ["foo", "0"]
# ["bar", "1"]
# ["baz", "2"]
#
# \Method CSV.table returns the entire \CSV data as a CSV::Table object:
# File.open(path) do |file|
# CSV.table(file)
# end # => #<CSV::Table mode:col_or_row row_count:3>
#
# === Simple Generating
#
# \Method CSV.generate returns a \String;
# this example uses method CSV#<< to append the rows
# that are to be generated:
# output_string = CSV.generate do |csv|
# csv << ['foo', 0]
# csv << ['bar', 1]
# csv << ['baz', 2]
# end
# output_string # => "foo,0\nbar,1\nbaz,2\n"
#
# \Method CSV.generate_line returns a \String containing the single row
# constructed from an \Array:
# CSV.generate_line(['foo', '0']) # => "foo,0\n"
#
# \CSV extends class \Array with instance method <tt>Array#to_csv</tt>,
# which forms an \Array into a \String:
# ['foo', '0'].to_csv # => "foo,0\n"
#
# === "Filtering" \CSV
#
# \Method CSV.filter provides a Unix-style filter for \CSV data.
# The input data is processed to form the output data:
# in_string = "foo,0\nbar,1\nbaz,2\n"
# out_string = ''
# CSV.filter(in_string, out_string) do |row|
# row[0] = row[0].upcase
# row[1] *= 4
# end
# out_string # => "FOO,0000\nBAR,1111\nBAZ,2222\n"
#
# == \CSV Objects
#
# There are three ways to create a \CSV object:
# - \Method CSV.new returns a new \CSV object.
# - \Method CSV.instance returns a new or cached \CSV object.
# - \Method \CSV() also returns a new or cached \CSV object.
#
# === Instance Methods
#
# \CSV has three groups of instance methods:
# - Its own internally defined instance methods.
# - Methods included by module Enumerable.
# - Methods delegated to class IO. See below.
#
# ==== Delegated Methods
#
# For convenience, a CSV object will delegate to many methods in class IO.
# (A few have wrapper "guard code" in \CSV.) You may call:
# * IO#binmode
# * #binmode?
# * IO#close
# * IO#close_read
# * IO#close_write
# * IO#closed?
# * #eof
# * #eof?
# * IO#external_encoding
# * IO#fcntl
# * IO#fileno
# * #flock
# * IO#flush
# * IO#fsync
# * IO#internal_encoding
# * #ioctl
# * IO#isatty
# * #path
# * IO#pid
# * IO#pos
# * IO#pos=
# * IO#reopen
# * #rewind
# * IO#seek
# * #stat
# * IO#string
# * IO#sync
# * IO#sync=
# * IO#tell
# * #to_i
# * #to_io
# * IO#truncate
# * IO#tty?
#
# === Options
#
# The default values for options are:
# DEFAULT_OPTIONS = {
# # For both parsing and generating.
# col_sep: ",",
# row_sep: :auto,
# quote_char: '"',
# # For parsing.
# field_size_limit: nil,
# converters: nil,
# unconverted_fields: nil,
# headers: false,
# return_headers: false,
# header_converters: nil,
# skip_blanks: false,
# skip_lines: nil,
# liberal_parsing: false,
# nil_value: nil,
# empty_value: "",
# strip: false,
# # For generating.
# write_headers: nil,
# quote_empty: true,
# force_quotes: false,
# write_converters: nil,
# write_nil_value: nil,
# write_empty_value: "",
# }
#
# ==== Options for Parsing
#
# Options for parsing, described in detail below, include:
# - +row_sep+: Specifies the row separator; used to delimit rows.
# - +col_sep+: Specifies the column separator; used to delimit fields.
# - +quote_char+: Specifies the quote character; used to quote fields.
# - +field_size_limit+: Specifies the maximum field size + 1 allowed.
# Deprecated since 3.2.3. Use +max_field_size+ instead.
# - +max_field_size+: Specifies the maximum field size allowed.
# - +converters+: Specifies the field converters to be used.
# - +unconverted_fields+: Specifies whether unconverted fields are to be available.
# - +headers+: Specifies whether data contains headers,
# or specifies the headers themselves.
# - +return_headers+: Specifies whether headers are to be returned.
# - +header_converters+: Specifies the header converters to be used.
# - +skip_blanks+: Specifies whether blanks lines are to be ignored.
# - +skip_lines+: Specifies how comments lines are to be recognized.
# - +strip+: Specifies whether leading and trailing whitespace are to be
# stripped from fields. This must be compatible with +col_sep+; if it is not,
# then an +ArgumentError+ exception will be raised.
# - +liberal_parsing+: Specifies whether \CSV should attempt to parse
# non-compliant data.
# - +nil_value+: Specifies the object that is to be substituted for each null (no-text) field.
# - +empty_value+: Specifies the object that is to be substituted for each empty field.
#
# :include: ../doc/csv/options/common/row_sep.rdoc
#
# :include: ../doc/csv/options/common/col_sep.rdoc
#
# :include: ../doc/csv/options/common/quote_char.rdoc
#
# :include: ../doc/csv/options/parsing/field_size_limit.rdoc
#
# :include: ../doc/csv/options/parsing/converters.rdoc
#
# :include: ../doc/csv/options/parsing/unconverted_fields.rdoc
#
# :include: ../doc/csv/options/parsing/headers.rdoc
#
# :include: ../doc/csv/options/parsing/return_headers.rdoc
#
# :include: ../doc/csv/options/parsing/header_converters.rdoc
#
# :include: ../doc/csv/options/parsing/skip_blanks.rdoc
#
# :include: ../doc/csv/options/parsing/skip_lines.rdoc
#
# :include: ../doc/csv/options/parsing/strip.rdoc
#
# :include: ../doc/csv/options/parsing/liberal_parsing.rdoc
#
# :include: ../doc/csv/options/parsing/nil_value.rdoc
#
# :include: ../doc/csv/options/parsing/empty_value.rdoc
#
# ==== Options for Generating
#
# Options for generating, described in detail below, include:
# - +row_sep+: Specifies the row separator; used to delimit rows.
# - +col_sep+: Specifies the column separator; used to delimit fields.
# - +quote_char+: Specifies the quote character; used to quote fields.
# - +write_headers+: Specifies whether headers are to be written.
# - +force_quotes+: Specifies whether each output field is to be quoted.
# - +quote_empty+: Specifies whether each empty output field is to be quoted.
# - +write_converters+: Specifies the field converters to be used in writing.
# - +write_nil_value+: Specifies the object that is to be substituted for each +nil+-valued field.
# - +write_empty_value+: Specifies the object that is to be substituted for each empty field.
#
# :include: ../doc/csv/options/common/row_sep.rdoc
#
# :include: ../doc/csv/options/common/col_sep.rdoc
#
# :include: ../doc/csv/options/common/quote_char.rdoc
#
# :include: ../doc/csv/options/generating/write_headers.rdoc
#
# :include: ../doc/csv/options/generating/force_quotes.rdoc
#
# :include: ../doc/csv/options/generating/quote_empty.rdoc
#
# :include: ../doc/csv/options/generating/write_converters.rdoc
#
# :include: ../doc/csv/options/generating/write_nil_value.rdoc
#
# :include: ../doc/csv/options/generating/write_empty_value.rdoc
#
# === \CSV with Headers
#
# CSV allows to specify column names of CSV file, whether they are in data, or
# provided separately. If headers are specified, reading methods return an instance
# of CSV::Table, consisting of CSV::Row.
#
# # Headers are part of data
# data = CSV.parse(<<~ROWS, headers: true)
# Name,Department,Salary
# Bob,Engineering,1000
# Jane,Sales,2000
# John,Management,5000
# ROWS
#
# data.class #=> CSV::Table
# data.first #=> #<CSV::Row "Name":"Bob" "Department":"Engineering" "Salary":"1000">
# data.first.to_h #=> {"Name"=>"Bob", "Department"=>"Engineering", "Salary"=>"1000"}
#
# # Headers provided by developer
# data = CSV.parse('Bob,Engineering,1000', headers: %i[name department salary])
# data.first #=> #<CSV::Row name:"Bob" department:"Engineering" salary:"1000">
#
# === \Converters
#
# By default, each value (field or header) parsed by \CSV is formed into a \String.
# You can use a _field_ _converter_ or _header_ _converter_
# to intercept and modify the parsed values:
# - See {Field Converters}[#class-CSV-label-Field+Converters].
# - See {Header Converters}[#class-CSV-label-Header+Converters].
#
# Also by default, each value to be written during generation is written 'as-is'.
# You can use a _write_ _converter_ to modify values before writing.
# - See {Write Converters}[#class-CSV-label-Write+Converters].
#
# ==== Specifying \Converters
#
# You can specify converters for parsing or generating in the +options+
# argument to various \CSV methods:
# - Option +converters+ for converting parsed field values.
# - Option +header_converters+ for converting parsed header values.
# - Option +write_converters+ for converting values to be written (generated).
#
# There are three forms for specifying converters:
# - A converter proc: executable code to be used for conversion.
# - A converter name: the name of a stored converter.
# - A converter list: an array of converter procs, converter names, and converter lists.
#
# ===== Converter Procs
#
# This converter proc, +strip_converter+, accepts a value +field+
# and returns <tt>field.strip</tt>:
# strip_converter = proc {|field| field.strip }
# In this call to <tt>CSV.parse</tt>,
# the keyword argument <tt>converters: string_converter</tt>
# specifies that:
# - \Proc +string_converter+ is to be called for each parsed field.
# - The converter's return value is to replace the +field+ value.
# Example:
# string = " foo , 0 \n bar , 1 \n baz , 2 \n"
# array = CSV.parse(string, converters: strip_converter)
# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# A converter proc can receive a second argument, +field_info+,
# that contains details about the field.
# This modified +strip_converter+ displays its arguments:
# strip_converter = proc do |field, field_info|
# p [field, field_info]
# field.strip
# end
# string = " foo , 0 \n bar , 1 \n baz , 2 \n"
# array = CSV.parse(string, converters: strip_converter)
# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
# Output:
# [" foo ", #<struct CSV::FieldInfo index=0, line=1, header=nil>]
# [" 0 ", #<struct CSV::FieldInfo index=1, line=1, header=nil>]
# [" bar ", #<struct CSV::FieldInfo index=0, line=2, header=nil>]
# [" 1 ", #<struct CSV::FieldInfo index=1, line=2, header=nil>]
# [" baz ", #<struct CSV::FieldInfo index=0, line=3, header=nil>]
# [" 2 ", #<struct CSV::FieldInfo index=1, line=3, header=nil>]
# Each CSV::FieldInfo object shows:
# - The 0-based field index.
# - The 1-based line index.
# - The field header, if any.
#
# ===== Stored \Converters
#
# A converter may be given a name and stored in a structure where
# the parsing methods can find it by name.
#
# The storage structure for field converters is the \Hash CSV::Converters.
# It has several built-in converter procs:
# - <tt>:integer</tt>: converts each \String-embedded integer into a true \Integer.
# - <tt>:float</tt>: converts each \String-embedded float into a true \Float.
# - <tt>:date</tt>: converts each \String-embedded date into a true \Date.
# - <tt>:date_time</tt>: converts each \String-embedded date-time into a true \DateTime
# .
# This example creates a converter proc, then stores it:
# strip_converter = proc {|field| field.strip }
# CSV::Converters[:strip] = strip_converter
# Then the parsing method call can refer to the converter
# by its name, <tt>:strip</tt>:
# string = " foo , 0 \n bar , 1 \n baz , 2 \n"
# array = CSV.parse(string, converters: :strip)
# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# The storage structure for header converters is the \Hash CSV::HeaderConverters,
# which works in the same way.
# It also has built-in converter procs:
# - <tt>:downcase</tt>: Downcases each header.
# - <tt>:symbol</tt>: Converts each header to a \Symbol.
#
# There is no such storage structure for write headers.
#
# In order for the parsing methods to access stored converters in non-main-Ractors, the
# storage structure must be made shareable first.
# Therefore, <tt>Ractor.make_shareable(CSV::Converters)</tt> and
# <tt>Ractor.make_shareable(CSV::HeaderConverters)</tt> must be called before the creation
# of Ractors that use the converters stored in these structures. (Since making the storage
# structures shareable involves freezing them, any custom converters that are to be used
# must be added first.)
#
# ===== Converter Lists
#
# A _converter_ _list_ is an \Array that may include any assortment of:
# - Converter procs.
# - Names of stored converters.
# - Nested converter lists.
#
# Examples:
# numeric_converters = [:integer, :float]
# date_converters = [:date, :date_time]
# [numeric_converters, strip_converter]
# [strip_converter, date_converters, :float]
#
# Like a converter proc, a converter list may be named and stored in either
# \CSV::Converters or CSV::HeaderConverters:
# CSV::Converters[:custom] = [strip_converter, date_converters, :float]
# CSV::HeaderConverters[:custom] = [:downcase, :symbol]
#
# There are two built-in converter lists:
# CSV::Converters[:numeric] # => [:integer, :float]
# CSV::Converters[:all] # => [:date_time, :numeric]
#
# ==== Field \Converters
#
# With no conversion, all parsed fields in all rows become Strings:
# string = "foo,0\nbar,1\nbaz,2\n"
# ary = CSV.parse(string)
# ary # => # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# When you specify a field converter, each parsed field is passed to the converter;
# its return value becomes the stored value for the field.
# A converter might, for example, convert an integer embedded in a \String
# into a true \Integer.
# (In fact, that's what built-in field converter +:integer+ does.)
#
# There are three ways to use field \converters.
#
# - Using option {converters}[#class-CSV-label-Option+converters] with a parsing method:
# ary = CSV.parse(string, converters: :integer)
# ary # => [0, 1, 2] # => [["foo", 0], ["bar", 1], ["baz", 2]]
# - Using option {converters}[#class-CSV-label-Option+converters] with a new \CSV instance:
# csv = CSV.new(string, converters: :integer)
# # Field converters in effect:
# csv.converters # => [:integer]
# csv.read # => [["foo", 0], ["bar", 1], ["baz", 2]]
# - Using method #convert to add a field converter to a \CSV instance:
# csv = CSV.new(string)
# # Add a converter.
# csv.convert(:integer)
# csv.converters # => [:integer]
# csv.read # => [["foo", 0], ["bar", 1], ["baz", 2]]
#
# Installing a field converter does not affect already-read rows:
# csv = CSV.new(string)
# csv.shift # => ["foo", "0"]
# # Add a converter.
# csv.convert(:integer)
# csv.converters # => [:integer]
# csv.read # => [["bar", 1], ["baz", 2]]
#
# There are additional built-in \converters, and custom \converters are also supported.
#
# ===== Built-In Field \Converters
#
# The built-in field converters are in \Hash CSV::Converters:
# - Each key is a field converter name.
# - Each value is one of:
# - A \Proc field converter.
# - An \Array of field converter names.
#
# Display:
# CSV::Converters.each_pair do |name, value|
# if value.kind_of?(Proc)
# p [name, value.class]
# else
# p [name, value]
# end
# end
# Output:
# [:integer, Proc]
# [:float, Proc]
# [:numeric, [:integer, :float]]
# [:date, Proc]
# [:date_time, Proc]
# [:all, [:date_time, :numeric]]
#
# Each of these converters transcodes values to UTF-8 before attempting conversion.
# If a value cannot be transcoded to UTF-8 the conversion will
# fail and the value will remain unconverted.
#
# Converter +:integer+ converts each field that Integer() accepts:
# data = '0,1,2,x'
# # Without the converter
# csv = CSV.parse_line(data)
# csv # => ["0", "1", "2", "x"]
# # With the converter
# csv = CSV.parse_line(data, converters: :integer)
# csv # => [0, 1, 2, "x"]
#
# Converter +:float+ converts each field that Float() accepts:
# data = '1.0,3.14159,x'
# # Without the converter
# csv = CSV.parse_line(data)
# csv # => ["1.0", "3.14159", "x"]
# # With the converter
# csv = CSV.parse_line(data, converters: :float)
# csv # => [1.0, 3.14159, "x"]
#
# Converter +:numeric+ converts with both +:integer+ and +:float+..
#
# Converter +:date+ converts each field that Date::parse accepts:
# data = '2001-02-03,x'
# # Without the converter
# csv = CSV.parse_line(data)
# csv # => ["2001-02-03", "x"]
# # With the converter
# csv = CSV.parse_line(data, converters: :date)
# csv # => [#<Date: 2001-02-03 ((2451944j,0s,0n),+0s,2299161j)>, "x"]
#
# Converter +:date_time+ converts each field that DateTime::parse accepts:
# data = '2020-05-07T14:59:00-05:00,x'
# # Without the converter
# csv = CSV.parse_line(data)
# csv # => ["2020-05-07T14:59:00-05:00", "x"]
# # With the converter
# csv = CSV.parse_line(data, converters: :date_time)
# csv # => [#<DateTime: 2020-05-07T14:59:00-05:00 ((2458977j,71940s,0n),-18000s,2299161j)>, "x"]
#
# Converter +:numeric+ converts with both +:date_time+ and +:numeric+..
#
# As seen above, method #convert adds \converters to a \CSV instance,
# and method #converters returns an \Array of the \converters in effect:
# csv = CSV.new('0,1,2')
# csv.converters # => []
# csv.convert(:integer)
# csv.converters # => [:integer]
# csv.convert(:date)
# csv.converters # => [:integer, :date]
#
# ===== Custom Field \Converters
#
# You can define a custom field converter:
# strip_converter = proc {|field| field.strip }
# string = " foo , 0 \n bar , 1 \n baz , 2 \n"
# array = CSV.parse(string, converters: strip_converter)
# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
# You can register the converter in \Converters \Hash,
# which allows you to refer to it by name:
# CSV::Converters[:strip] = strip_converter
# string = " foo , 0 \n bar , 1 \n baz , 2 \n"
# array = CSV.parse(string, converters: :strip)
# array # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# ==== Header \Converters
#
# Header converters operate only on headers (and not on other rows).
#
# There are three ways to use header \converters;
# these examples use built-in header converter +:downcase+,
# which downcases each parsed header.
#
# - Option +header_converters+ with a singleton parsing method:
# string = "Name,Count\nFoo,0\n,Bar,1\nBaz,2"
# tbl = CSV.parse(string, headers: true, header_converters: :downcase)
# tbl.class # => CSV::Table
# tbl.headers # => ["name", "count"]
#
# - Option +header_converters+ with a new \CSV instance:
# csv = CSV.new(string, header_converters: :downcase)
# # Header converters in effect:
# csv.header_converters # => [:downcase]
# tbl = CSV.parse(string, headers: true)
# tbl.headers # => ["Name", "Count"]
#
# - Method #header_convert adds a header converter to a \CSV instance:
# csv = CSV.new(string)
# # Add a header converter.
# csv.header_convert(:downcase)
# csv.header_converters # => [:downcase]
# tbl = CSV.parse(string, headers: true)
# tbl.headers # => ["Name", "Count"]
#
# ===== Built-In Header \Converters
#
# The built-in header \converters are in \Hash CSV::HeaderConverters.
# The keys there are the names of the \converters:
# CSV::HeaderConverters.keys # => [:downcase, :symbol]
#
# Converter +:downcase+ converts each header by downcasing it:
# string = "Name,Count\nFoo,0\n,Bar,1\nBaz,2"
# tbl = CSV.parse(string, headers: true, header_converters: :downcase)
# tbl.class # => CSV::Table
# tbl.headers # => ["name", "count"]
#
# Converter +:symbol+ converts each header by making it into a \Symbol:
# string = "Name,Count\nFoo,0\n,Bar,1\nBaz,2"
# tbl = CSV.parse(string, headers: true, header_converters: :symbol)
# tbl.headers # => [:name, :count]
# Details:
# - Strips leading and trailing whitespace.
# - Downcases the header.
# - Replaces embedded spaces with underscores.
# - Removes non-word characters.
# - Makes the string into a \Symbol.
#
# ===== Custom Header \Converters
#
# You can define a custom header converter:
# upcase_converter = proc {|header| header.upcase }
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(string, headers: true, header_converters: upcase_converter)
# table # => #<CSV::Table mode:col_or_row row_count:4>
# table.headers # => ["NAME", "VALUE"]
# You can register the converter in \HeaderConverters \Hash,
# which allows you to refer to it by name:
# CSV::HeaderConverters[:upcase] = upcase_converter
# table = CSV.parse(string, headers: true, header_converters: :upcase)
# table # => #<CSV::Table mode:col_or_row row_count:4>
# table.headers # => ["NAME", "VALUE"]
#
# ===== Write \Converters
#
# When you specify a write converter for generating \CSV,
# each field to be written is passed to the converter;
# its return value becomes the new value for the field.
# A converter might, for example, strip whitespace from a field.
#
# Using no write converter (all fields unmodified):
# output_string = CSV.generate do |csv|
# csv << [' foo ', 0]
# csv << [' bar ', 1]
# csv << [' baz ', 2]
# end
# output_string # => " foo ,0\n bar ,1\n baz ,2\n"
# Using option +write_converters+ with two custom write converters:
# strip_converter = proc {|field| field.respond_to?(:strip) ? field.strip : field }
# upcase_converter = proc {|field| field.respond_to?(:upcase) ? field.upcase : field }
# write_converters = [strip_converter, upcase_converter]
# output_string = CSV.generate(write_converters: write_converters) do |csv|
# csv << [' foo ', 0]
# csv << [' bar ', 1]
# csv << [' baz ', 2]
# end
# output_string # => "FOO,0\nBAR,1\nBAZ,2\n"
#
# === Character Encodings (M17n or Multilingualization)
#
# This new CSV parser is m17n savvy. The parser works in the Encoding of the IO
# or String object being read from or written to. Your data is never transcoded
# (unless you ask Ruby to transcode it for you) and will literally be parsed in
# the Encoding it is in. Thus CSV will return Arrays or Rows of Strings in the
# Encoding of your data. This is accomplished by transcoding the parser itself
# into your Encoding.
#
# Some transcoding must take place, of course, to accomplish this multiencoding
# support. For example, <tt>:col_sep</tt>, <tt>:row_sep</tt>, and
# <tt>:quote_char</tt> must be transcoded to match your data. Hopefully this
# makes the entire process feel transparent, since CSV's defaults should just
# magically work for your data. However, you can set these values manually in
# the target Encoding to avoid the translation.
#
# It's also important to note that while all of CSV's core parser is now
# Encoding agnostic, some features are not. For example, the built-in
# converters will try to transcode data to UTF-8 before making conversions.
# Again, you can provide custom converters that are aware of your Encodings to
# avoid this translation. It's just too hard for me to support native
# conversions in all of Ruby's Encodings.
#
# Anyway, the practical side of this is simple: make sure IO and String objects
# passed into CSV have the proper Encoding set and everything should just work.
# CSV methods that allow you to open IO objects (CSV::foreach(), CSV::open(),
# CSV::read(), and CSV::readlines()) do allow you to specify the Encoding.
#
# One minor exception comes when generating CSV into a String with an Encoding
# that is not ASCII compatible. There's no existing data for CSV to use to
# prepare itself and thus you will probably need to manually specify the desired
# Encoding for most of those cases. It will try to guess using the fields in a
# row of output though, when using CSV::generate_line() or Array#to_csv().
#
# I try to point out any other Encoding issues in the documentation of methods
# as they come up.
#
# This has been tested to the best of my ability with all non-"dummy" Encodings
# Ruby ships with. However, it is brave new code and may have some bugs.
# Please feel free to {report}[mailto:james@grayproductions.net] any issues you
# find with it.
#
class CSV
# The error thrown when the parser encounters illegal CSV formatting.
class MalformedCSVError < RuntimeError
attr_reader :line_number
alias_method :lineno, :line_number
def initialize(message, line_number)
@line_number = line_number
super("#{message} in line #{line_number}.")
end
end
# The error thrown when the parser encounters invalid encoding in CSV.
class InvalidEncodingError < MalformedCSVError
attr_reader :encoding
def initialize(encoding, line_number)
@encoding = encoding
super("Invalid byte sequence in #{encoding}", line_number)
end
end
#
# A FieldInfo Struct contains details about a field's position in the data
# source it was read from. CSV will pass this Struct to some blocks that make
# decisions based on field structure. See CSV.convert_fields() for an
# example.
#
# <b><tt>index</tt></b>:: The zero-based index of the field in its row.
# <b><tt>line</tt></b>:: The line of the data source this row is from.
# <b><tt>header</tt></b>:: The header for the column, when available.
# <b><tt>quoted?</tt></b>:: True or false, whether the original value is quoted or not.
#
FieldInfo = Struct.new(:index, :line, :header, :quoted?)
# A Regexp used to find and convert some common Date formats.
DateMatcher = / \A(?: (\w+,?\s+)?\w+\s+\d{1,2},?\s+\d{2,4} |
\d{4}-\d{2}-\d{2} )\z /x
# A Regexp used to find and convert some common DateTime formats.
DateTimeMatcher =
/ \A(?: (\w+,?\s+)?\w+\s+\d{1,2}\s+\d{1,2}:\d{1,2}:\d{1,2},?\s+\d{2,4} |
# ISO-8601 and RFC-3339 (space instead of T) recognized by DateTime.parse
\d{4}-\d{2}-\d{2}
(?:[T\s]\d{2}:\d{2}(?::\d{2}(?:\.\d+)?(?:[+-]\d{2}(?::\d{2})|Z)?)?)?
)\z /x
# The encoding used by all converters.
ConverterEncoding = Encoding.find("UTF-8")
# A \Hash containing the names and \Procs for the built-in field converters.
# See {Built-In Field Converters}[#class-CSV-label-Built-In+Field+Converters].
#
# This \Hash is intentionally left unfrozen, and may be extended with
# custom field converters.
# See {Custom Field Converters}[#class-CSV-label-Custom+Field+Converters].
Converters = {
integer: lambda { |f|
Integer(f.encode(ConverterEncoding)) rescue f
},
float: lambda { |f|
Float(f.encode(ConverterEncoding)) rescue f
},
numeric: [:integer, :float],
date: lambda { |f|
begin
e = f.encode(ConverterEncoding)
e.match?(DateMatcher) ? Date.parse(e) : f
rescue # encoding conversion or date parse errors
f
end
},
date_time: lambda { |f|
begin
e = f.encode(ConverterEncoding)
e.match?(DateTimeMatcher) ? DateTime.parse(e) : f
rescue # encoding conversion or date parse errors
f
end
},
all: [:date_time, :numeric],
}
# A \Hash containing the names and \Procs for the built-in header converters.
# See {Built-In Header Converters}[#class-CSV-label-Built-In+Header+Converters].
#
# This \Hash is intentionally left unfrozen, and may be extended with
# custom field converters.
# See {Custom Header Converters}[#class-CSV-label-Custom+Header+Converters].
HeaderConverters = {
downcase: lambda { |h| h.encode(ConverterEncoding).downcase },
symbol: lambda { |h|
h.encode(ConverterEncoding).downcase.gsub(/[^\s\w]+/, "").strip.
gsub(/\s+/, "_").to_sym
},
symbol_raw: lambda { |h| h.encode(ConverterEncoding).to_sym }
}
# Default values for method options.
DEFAULT_OPTIONS = {
# For both parsing and generating.
col_sep: ",",
row_sep: :auto,
quote_char: '"',
# For parsing.
field_size_limit: nil,
max_field_size: nil,
converters: nil,
unconverted_fields: nil,
headers: false,
return_headers: false,
header_converters: nil,
skip_blanks: false,
skip_lines: nil,
liberal_parsing: false,
nil_value: nil,
empty_value: "",
strip: false,
# For generating.
write_headers: nil,
quote_empty: true,
force_quotes: false,
write_converters: nil,
write_nil_value: nil,
write_empty_value: "",
}.freeze
class << self
# :call-seq:
# instance(string, **options)
# instance(io = $stdout, **options)
# instance(string, **options) {|csv| ... }
# instance(io = $stdout, **options) {|csv| ... }
#
# Creates or retrieves cached \CSV objects.
# For arguments and options, see CSV.new.
#
# This API is not Ractor-safe.
#
# ---
#
# With no block given, returns a \CSV object.
#
# The first call to +instance+ creates and caches a \CSV object:
# s0 = 's0'
# csv0 = CSV.instance(s0)
# csv0.class # => CSV
#
# Subsequent calls to +instance+ with that _same_ +string+ or +io+
# retrieve that same cached object:
# csv1 = CSV.instance(s0)
# csv1.class # => CSV
# csv1.equal?(csv0) # => true # Same CSV object
#
# A subsequent call to +instance+ with a _different_ +string+ or +io+
# creates and caches a _different_ \CSV object.
# s1 = 's1'
# csv2 = CSV.instance(s1)
# csv2.equal?(csv0) # => false # Different CSV object
#
# All the cached objects remains available:
# csv3 = CSV.instance(s0)
# csv3.equal?(csv0) # true # Same CSV object
# csv4 = CSV.instance(s1)
# csv4.equal?(csv2) # true # Same CSV object
#
# ---
#
# When a block is given, calls the block with the created or retrieved
# \CSV object; returns the block's return value:
# CSV.instance(s0) {|csv| :foo } # => :foo
def instance(data = $stdout, **options)
# create a _signature_ for this method call, data object and options
sig = [data.object_id] +
options.values_at(*DEFAULT_OPTIONS.keys)
# fetch or create the instance for this signature
@@instances ||= Hash.new
instance = (@@instances[sig] ||= new(data, **options))
if block_given?
yield instance # run block, if given, returning result
else
instance # or return the instance
end
end
# :call-seq:
# filter(in_string_or_io, **options) {|row| ... } -> array_of_arrays or csv_table
# filter(in_string_or_io, out_string_or_io, **options) {|row| ... } -> array_of_arrays or csv_table
# filter(**options) {|row| ... } -> array_of_arrays or csv_table
#
# - Parses \CSV from a source (\String, \IO stream, or ARGF).
# - Calls the given block with each parsed row:
# - Without headers, each row is an \Array.
# - With headers, each row is a CSV::Row.
# - Generates \CSV to an output (\String, \IO stream, or STDOUT).
# - Returns the parsed source:
# - Without headers, an \Array of \Arrays.
# - With headers, a CSV::Table.
#
# When +in_string_or_io+ is given, but not +out_string_or_io+,
# parses from the given +in_string_or_io+
# and generates to STDOUT.
#
# \String input without headers:
#
# in_string = "foo,0\nbar,1\nbaz,2"
# CSV.filter(in_string) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]]
#
# Output (to STDOUT):
#
# FOO,0
# BAR,-1
# BAZ,-2
#
# \String input with headers:
#
# in_string = "Name,Value\nfoo,0\nbar,1\nbaz,2"
# CSV.filter(in_string, headers: true) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end # => #<CSV::Table mode:col_or_row row_count:4>
#
# Output (to STDOUT):
#
# Name,Value
# FOO,0
# BAR,-1
# BAZ,-2
#
# \IO stream input without headers:
#
# File.write('t.csv', "foo,0\nbar,1\nbaz,2")
# File.open('t.csv') do |in_io|
# CSV.filter(in_io) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end
# end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]]
#
# Output (to STDOUT):
#
# FOO,0
# BAR,-1
# BAZ,-2
#
# \IO stream input with headers:
#
# File.write('t.csv', "Name,Value\nfoo,0\nbar,1\nbaz,2")
# File.open('t.csv') do |in_io|
# CSV.filter(in_io, headers: true) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end
# end # => #<CSV::Table mode:col_or_row row_count:4>
#
# Output (to STDOUT):
#
# Name,Value
# FOO,0
# BAR,-1
# BAZ,-2
#
# When both +in_string_or_io+ and +out_string_or_io+ are given,
# parses from +in_string_or_io+ and generates to +out_string_or_io+.
#
# \String output without headers:
#
# in_string = "foo,0\nbar,1\nbaz,2"
# out_string = ''
# CSV.filter(in_string, out_string) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]]
# out_string # => "FOO,0\nBAR,-1\nBAZ,-2\n"
#
# \String output with headers:
#
# in_string = "Name,Value\nfoo,0\nbar,1\nbaz,2"
# out_string = ''
# CSV.filter(in_string, out_string, headers: true) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end # => #<CSV::Table mode:col_or_row row_count:4>
# out_string # => "Name,Value\nFOO,0\nBAR,-1\nBAZ,-2\n"
#
# \IO stream output without headers:
#
# in_string = "foo,0\nbar,1\nbaz,2"
# File.open('t.csv', 'w') do |out_io|
# CSV.filter(in_string, out_io) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end
# end # => [["FOO", 0], ["BAR", -1], ["BAZ", -2]]
# File.read('t.csv') # => "FOO,0\nBAR,-1\nBAZ,-2\n"
#
# \IO stream output with headers:
#
# in_string = "Name,Value\nfoo,0\nbar,1\nbaz,2"
# File.open('t.csv', 'w') do |out_io|
# CSV.filter(in_string, out_io, headers: true) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end
# end # => #<CSV::Table mode:col_or_row row_count:4>
# File.read('t.csv') # => "Name,Value\nFOO,0\nBAR,-1\nBAZ,-2\n"
#
# When neither +in_string_or_io+ nor +out_string_or_io+ given,
# parses from {ARGF}[rdoc-ref:ARGF]
# and generates to STDOUT.
#
# Without headers:
#
# # Put Ruby code into a file.
# ruby = <<-EOT
# require 'csv'
# CSV.filter do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end
# EOT
# File.write('t.rb', ruby)
# # Put some CSV into a file.
# File.write('t.csv', "foo,0\nbar,1\nbaz,2")
# # Run the Ruby code with CSV filename as argument.
# system(Gem.ruby, "t.rb", "t.csv")
#
# Output (to STDOUT):
#
# FOO,0
# BAR,-1
# BAZ,-2
#
# With headers:
#
# # Put Ruby code into a file.
# ruby = <<-EOT
# require 'csv'
# CSV.filter(headers: true) do |row|
# row[0].upcase!
# row[1] = - row[1].to_i
# end
# EOT
# File.write('t.rb', ruby)
# # Put some CSV into a file.
# File.write('t.csv', "Name,Value\nfoo,0\nbar,1\nbaz,2")
# # Run the Ruby code with CSV filename as argument.
# system(Gem.ruby, "t.rb", "t.csv")
#
# Output (to STDOUT):
#
# Name,Value
# FOO,0
# BAR,-1
# BAZ,-2
#
# Arguments:
#
# * Argument +in_string_or_io+ must be a \String or an \IO stream.
# * Argument +out_string_or_io+ must be a \String or an \IO stream.
# * Arguments <tt>**options</tt> must be keyword options.
# See {Options for Parsing}[#class-CSV-label-Options+for+Parsing].
def filter(input=nil, output=nil, **options)
# parse options for input, output, or both
in_options, out_options = Hash.new, {row_sep: InputRecordSeparator.value}
options.each do |key, value|
case key
when /\Ain(?:put)?_(.+)\Z/
in_options[$1.to_sym] = value
when /\Aout(?:put)?_(.+)\Z/
out_options[$1.to_sym] = value
else
in_options[key] = value
out_options[key] = value
end
end
# build input and output wrappers
input = new(input || ARGF, **in_options)
output = new(output || $stdout, **out_options)
# process headers
need_manual_header_output =
(in_options[:headers] and
out_options[:headers] == true and
out_options[:write_headers])
if need_manual_header_output
first_row = input.shift
if first_row
if first_row.is_a?(Row)
headers = first_row.headers
yield headers
output << headers
end
yield first_row
output << first_row
end
end
# read, yield, write
input.each do |row|
yield row
output << row
end
end
#
# :call-seq:
# foreach(path_or_io, mode='r', **options) {|row| ... )
# foreach(path_or_io, mode='r', **options) -> new_enumerator
#
# Calls the block with each row read from source +path_or_io+.
#
# \Path input without headers:
#
# string = "foo,0\nbar,1\nbaz,2\n"
# in_path = 't.csv'
# File.write(in_path, string)
# CSV.foreach(in_path) {|row| p row }
#
# Output:
#
# ["foo", "0"]
# ["bar", "1"]
# ["baz", "2"]
#
# \Path input with headers:
#
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# in_path = 't.csv'
# File.write(in_path, string)
# CSV.foreach(in_path, headers: true) {|row| p row }
#
# Output:
#
# <CSV::Row "Name":"foo" "Value":"0">
# <CSV::Row "Name":"bar" "Value":"1">
# <CSV::Row "Name":"baz" "Value":"2">
#
# \IO stream input without headers:
#
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# File.open('t.csv') do |in_io|
# CSV.foreach(in_io) {|row| p row }
# end
#
# Output:
#
# ["foo", "0"]
# ["bar", "1"]
# ["baz", "2"]
#
# \IO stream input with headers:
#
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# File.open('t.csv') do |in_io|
# CSV.foreach(in_io, headers: true) {|row| p row }
# end
#
# Output:
#
# <CSV::Row "Name":"foo" "Value":"0">
# <CSV::Row "Name":"bar" "Value":"1">
# <CSV::Row "Name":"baz" "Value":"2">
#
# With no block given, returns an \Enumerator:
#
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# CSV.foreach(path) # => #<Enumerator: CSV:foreach("t.csv", "r")>
#
# Arguments:
# * Argument +path_or_io+ must be a file path or an \IO stream.
# * Argument +mode+, if given, must be a \File mode.
# See {Access Modes}[rdoc-ref:File@Access+Modes].
# * Arguments <tt>**options</tt> must be keyword options.
# See {Options for Parsing}[#class-CSV-label-Options+for+Parsing].
# * This method optionally accepts an additional <tt>:encoding</tt> option
# that you can use to specify the Encoding of the data read from +path+ or +io+.
# You must provide this unless your data is in the encoding
# given by <tt>Encoding::default_external</tt>.
# Parsing will use this to determine how to parse the data.
# You may provide a second Encoding to
# have the data transcoded as it is read. For example,
# encoding: 'UTF-32BE:UTF-8'
# would read +UTF-32BE+ data from the file
# but transcode it to +UTF-8+ before parsing.
def foreach(path, mode="r", **options, &block)
return to_enum(__method__, path, mode, **options) unless block_given?
open(path, mode, **options) do |csv|
csv.each(&block)
end
end
#
# :call-seq:
# generate(csv_string, **options) {|csv| ... }
# generate(**options) {|csv| ... }
#
# * Argument +csv_string+, if given, must be a \String object;
# defaults to a new empty \String.
# * Arguments +options+, if given, should be generating options.
# See {Options for Generating}[#class-CSV-label-Options+for+Generating].
#
# ---
#
# Creates a new \CSV object via <tt>CSV.new(csv_string, **options)</tt>;
# calls the block with the \CSV object, which the block may modify;
# returns the \String generated from the \CSV object.
#
# Note that a passed \String *is* modified by this method.
# Pass <tt>csv_string</tt>.dup if the \String must be preserved.
#
# This method has one additional option: <tt>:encoding</tt>,
# which sets the base Encoding for the output if no no +str+ is specified.
# CSV needs this hint if you plan to output non-ASCII compatible data.
#
# ---
#
# Add lines:
# input_string = "foo,0\nbar,1\nbaz,2\n"
# output_string = CSV.generate(input_string) do |csv|
# csv << ['bat', 3]
# csv << ['bam', 4]
# end
# output_string # => "foo,0\nbar,1\nbaz,2\nbat,3\nbam,4\n"
# input_string # => "foo,0\nbar,1\nbaz,2\nbat,3\nbam,4\n"
# output_string.equal?(input_string) # => true # Same string, modified
#
# Add lines into new string, preserving old string:
# input_string = "foo,0\nbar,1\nbaz,2\n"
# output_string = CSV.generate(input_string.dup) do |csv|
# csv << ['bat', 3]
# csv << ['bam', 4]
# end
# output_string # => "foo,0\nbar,1\nbaz,2\nbat,3\nbam,4\n"
# input_string # => "foo,0\nbar,1\nbaz,2\n"
# output_string.equal?(input_string) # => false # Different strings
#
# Create lines from nothing:
# output_string = CSV.generate do |csv|
# csv << ['foo', 0]
# csv << ['bar', 1]
# csv << ['baz', 2]
# end
# output_string # => "foo,0\nbar,1\nbaz,2\n"
#
# ---
#
# Raises an exception if +csv_string+ is not a \String object:
# # Raises TypeError (no implicit conversion of Integer into String)
# CSV.generate(0)
#
def generate(str=nil, **options)
encoding = options[:encoding]
# add a default empty String, if none was given
if str
str = StringIO.new(str)
str.seek(0, IO::SEEK_END)
str.set_encoding(encoding) if encoding
else
str = +""
str.force_encoding(encoding) if encoding
end
csv = new(str, **options) # wrap
yield csv # yield for appending
csv.string # return final String
end
# :call-seq:
# CSV.generate_line(ary)
# CSV.generate_line(ary, **options)
#
# Returns the \String created by generating \CSV from +ary+
# using the specified +options+.
#
# Argument +ary+ must be an \Array.
#
# Special options:
# * Option <tt>:row_sep</tt> defaults to <tt>"\n"> on Ruby 3.0 or later
# and <tt>$INPUT_RECORD_SEPARATOR</tt> (<tt>$/</tt>) otherwise.:
# $INPUT_RECORD_SEPARATOR # => "\n"
# * This method accepts an additional option, <tt>:encoding</tt>, which sets the base
# Encoding for the output. This method will try to guess your Encoding from
# the first non-+nil+ field in +row+, if possible, but you may need to use
# this parameter as a backup plan.
#
# For other +options+,
# see {Options for Generating}[#class-CSV-label-Options+for+Generating].
#
# ---
#
# Returns the \String generated from an \Array:
# CSV.generate_line(['foo', '0']) # => "foo,0\n"
#
# ---
#
# Raises an exception if +ary+ is not an \Array:
# # Raises NoMethodError (undefined method `find' for :foo:Symbol)
# CSV.generate_line(:foo)
#
def generate_line(row, **options)
options = {row_sep: InputRecordSeparator.value}.merge(options)
str = +""
if options[:encoding]
str.force_encoding(options[:encoding])
else
fallback_encoding = nil
output_encoding = nil
row.each do |field|
next unless field.is_a?(String)
fallback_encoding ||= field.encoding
next if field.ascii_only?
output_encoding = field.encoding
break
end
output_encoding ||= fallback_encoding
if output_encoding
str.force_encoding(output_encoding)
end
end
(new(str, **options) << row).string
end
# :call-seq:
# CSV.generate_lines(rows)
# CSV.generate_lines(rows, **options)
#
# Returns the \String created by generating \CSV from
# using the specified +options+.
#
# Argument +rows+ must be an \Array of row. Row is \Array of \String or \CSV::Row.
#
# Special options:
# * Option <tt>:row_sep</tt> defaults to <tt>"\n"</tt> on Ruby 3.0 or later
# and <tt>$INPUT_RECORD_SEPARATOR</tt> (<tt>$/</tt>) otherwise.:
# $INPUT_RECORD_SEPARATOR # => "\n"
# * This method accepts an additional option, <tt>:encoding</tt>, which sets the base
# Encoding for the output. This method will try to guess your Encoding from
# the first non-+nil+ field in +row+, if possible, but you may need to use
# this parameter as a backup plan.
#
# For other +options+,
# see {Options for Generating}[#class-CSV-label-Options+for+Generating].
#
# ---
#
# Returns the \String generated from an
# CSV.generate_lines([['foo', '0'], ['bar', '1'], ['baz', '2']]) # => "foo,0\nbar,1\nbaz,2\n"
#
# ---
#
# Raises an exception
# # Raises NoMethodError (undefined method `each' for :foo:Symbol)
# CSV.generate_lines(:foo)
#
def generate_lines(rows, **options)
self.generate(**options) do |csv|
rows.each do |row|
csv << row
end
end
end
#
# :call-seq:
# open(file_path, mode = "rb", **options ) -> new_csv
# open(io, mode = "rb", **options ) -> new_csv
# open(file_path, mode = "rb", **options ) { |csv| ... } -> object
# open(io, mode = "rb", **options ) { |csv| ... } -> object
#
# possible options elements:
# keyword form:
# :invalid => nil # raise error on invalid byte sequence (default)
# :invalid => :replace # replace invalid byte sequence
# :undef => :replace # replace undefined conversion
# :replace => string # replacement string ("?" or "\uFFFD" if not specified)
#
# * Argument +path+, if given, must be the path to a file.
# :include: ../doc/csv/arguments/io.rdoc
# * Argument +mode+, if given, must be a \File mode.
# See {Access Modes}[rdoc-ref:File@Access+Modes].
# * Arguments <tt>**options</tt> must be keyword options.
# See {Options for Generating}[#class-CSV-label-Options+for+Generating].
# * This method optionally accepts an additional <tt>:encoding</tt> option
# that you can use to specify the Encoding of the data read from +path+ or +io+.
# You must provide this unless your data is in the encoding
# given by <tt>Encoding::default_external</tt>.
# Parsing will use this to determine how to parse the data.
# You may provide a second Encoding to
# have the data transcoded as it is read. For example,
# encoding: 'UTF-32BE:UTF-8'
# would read +UTF-32BE+ data from the file
# but transcode it to +UTF-8+ before parsing.
#
# ---
#
# These examples assume prior execution of:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# ---
#
# With no block given, returns a new \CSV object.
#
# Create a \CSV object using a file path:
# csv = CSV.open(path)
# csv # => #<CSV io_type:File io_path:"t.csv" encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
#
# Create a \CSV object using an open \File:
# csv = CSV.open(File.open(path))
# csv # => #<CSV io_type:File io_path:"t.csv" encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
#
# ---
#
# With a block given, calls the block with the created \CSV object;
# returns the block's return value:
#
# Using a file path:
# csv = CSV.open(path) {|csv| p csv}
# csv # => #<CSV io_type:File io_path:"t.csv" encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
# Output:
# #<CSV io_type:File io_path:"t.csv" encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
#
# Using an open \File:
# csv = CSV.open(File.open(path)) {|csv| p csv}
# csv # => #<CSV io_type:File io_path:"t.csv" encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
# Output:
# #<CSV io_type:File io_path:"t.csv" encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
#
# ---
#
# Raises an exception if the argument is not a \String object or \IO object:
# # Raises TypeError (no implicit conversion of Symbol into String)
# CSV.open(:foo)
def open(filename, mode="r", **options)
# wrap a File opened with the remaining +args+ with no newline
# decorator
file_opts = options.dup
unless file_opts.key?(:newline)
file_opts[:universal_newline] ||= false
end
options.delete(:invalid)
options.delete(:undef)
options.delete(:replace)
options.delete_if {|k, _| /newline\z/.match?(k)}
begin
f = File.open(filename, mode, **file_opts)
rescue ArgumentError => e
raise unless /needs binmode/.match?(e.message) and mode == "r"
mode = "rb"
file_opts = {encoding: Encoding.default_external}.merge(file_opts)
retry
end
begin
csv = new(f, **options)
rescue Exception
f.close
raise
end
# handle blocks like Ruby's open(), not like the CSV library
if block_given?
begin
yield csv
ensure
csv.close
end
else
csv
end
end
#
# :call-seq:
# parse(string) -> array_of_arrays
# parse(io) -> array_of_arrays
# parse(string, headers: ..., **options) -> csv_table
# parse(io, headers: ..., **options) -> csv_table
# parse(string, **options) {|row| ... }
# parse(io, **options) {|row| ... }
#
# Parses +string+ or +io+ using the specified +options+.
#
# - Argument +string+ should be a \String object;
# it will be put into a new StringIO object positioned at the beginning.
# :include: ../doc/csv/arguments/io.rdoc
# - Argument +options+: see {Options for Parsing}[#class-CSV-label-Options+for+Parsing]
#
# ====== Without Option +headers+
#
# Without {option +headers+}[#class-CSV-label-Option+headers] case.
#
# These examples assume prior execution of:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# ---
#
# With no block given, returns an \Array of Arrays formed from the source.
#
# Parse a \String:
# a_of_a = CSV.parse(string)
# a_of_a # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# Parse an open \File:
# a_of_a = File.open(path) do |file|
# CSV.parse(file)
# end
# a_of_a # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# ---
#
# With a block given, calls the block with each parsed row:
#
# Parse a \String:
# CSV.parse(string) {|row| p row }
#
# Output:
# ["foo", "0"]
# ["bar", "1"]
# ["baz", "2"]
#
# Parse an open \File:
# File.open(path) do |file|
# CSV.parse(file) {|row| p row }
# end
#
# Output:
# ["foo", "0"]
# ["bar", "1"]
# ["baz", "2"]
#
# ====== With Option +headers+
#
# With {option +headers+}[#class-CSV-label-Option+headers] case.
#
# These examples assume prior execution of:
# string = "Name,Count\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# ---
#
# With no block given, returns a CSV::Table object formed from the source.
#
# Parse a \String:
# csv_table = CSV.parse(string, headers: ['Name', 'Count'])
# csv_table # => #<CSV::Table mode:col_or_row row_count:5>
#
# Parse an open \File:
# csv_table = File.open(path) do |file|
# CSV.parse(file, headers: ['Name', 'Count'])
# end
# csv_table # => #<CSV::Table mode:col_or_row row_count:4>
#
# ---
#
# With a block given, calls the block with each parsed row,
# which has been formed into a CSV::Row object:
#
# Parse a \String:
# CSV.parse(string, headers: ['Name', 'Count']) {|row| p row }
#
# Output:
# # <CSV::Row "Name":"foo" "Count":"0">
# # <CSV::Row "Name":"bar" "Count":"1">
# # <CSV::Row "Name":"baz" "Count":"2">
#
# Parse an open \File:
# File.open(path) do |file|
# CSV.parse(file, headers: ['Name', 'Count']) {|row| p row }
# end
#
# Output:
# # <CSV::Row "Name":"foo" "Count":"0">
# # <CSV::Row "Name":"bar" "Count":"1">
# # <CSV::Row "Name":"baz" "Count":"2">
#
# ---
#
# Raises an exception if the argument is not a \String object or \IO object:
# # Raises NoMethodError (undefined method `close' for :foo:Symbol)
# CSV.parse(:foo)
def parse(str, **options, &block)
csv = new(str, **options)
return csv.each(&block) if block_given?
# slurp contents, if no block is given
begin
csv.read
ensure
csv.close
end
end
# :call-seq:
# CSV.parse_line(string) -> new_array or nil
# CSV.parse_line(io) -> new_array or nil
# CSV.parse_line(string, **options) -> new_array or nil
# CSV.parse_line(io, **options) -> new_array or nil
# CSV.parse_line(string, headers: true, **options) -> csv_row or nil
# CSV.parse_line(io, headers: true, **options) -> csv_row or nil
#
# Returns the data created by parsing the first line of +string+ or +io+
# using the specified +options+.
#
# - Argument +string+ should be a \String object;
# it will be put into a new StringIO object positioned at the beginning.
# :include: ../doc/csv/arguments/io.rdoc
# - Argument +options+: see {Options for Parsing}[#class-CSV-label-Options+for+Parsing]
#
# ====== Without Option +headers+
#
# Without option +headers+, returns the first row as a new \Array.
#
# These examples assume prior execution of:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# Parse the first line from a \String object:
# CSV.parse_line(string) # => ["foo", "0"]
#
# Parse the first line from a File object:
# File.open(path) do |file|
# CSV.parse_line(file) # => ["foo", "0"]
# end # => ["foo", "0"]
#
# Returns +nil+ if the argument is an empty \String:
# CSV.parse_line('') # => nil
#
# ====== With Option +headers+
#
# With {option +headers+}[#class-CSV-label-Option+headers],
# returns the first row as a CSV::Row object.
#
# These examples assume prior execution of:
# string = "Name,Count\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# Parse the first line from a \String object:
# CSV.parse_line(string, headers: true) # => #<CSV::Row "Name":"foo" "Count":"0">
#
# Parse the first line from a File object:
# File.open(path) do |file|
# CSV.parse_line(file, headers: true)
# end # => #<CSV::Row "Name":"foo" "Count":"0">
#
# ---
#
# Raises an exception if the argument is +nil+:
# # Raises ArgumentError (Cannot parse nil as CSV):
# CSV.parse_line(nil)
#
def parse_line(line, **options)
new(line, **options).each.first
end
#
# :call-seq:
# read(source, **options) -> array_of_arrays
# read(source, headers: true, **options) -> csv_table
#
# Opens the given +source+ with the given +options+ (see CSV.open),
# reads the source (see CSV#read), and returns the result,
# which will be either an \Array of Arrays or a CSV::Table.
#
# Without headers:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# CSV.read(path) # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# With headers:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# CSV.read(path, headers: true) # => #<CSV::Table mode:col_or_row row_count:4>
def read(path, **options)
open(path, **options) { |csv| csv.read }
end
# :call-seq:
# CSV.readlines(source, **options)
#
# Alias for CSV.read.
def readlines(path, **options)
read(path, **options)
end
# :call-seq:
# CSV.table(source, **options)
#
# Calls CSV.read with +source+, +options+, and certain default options:
# - +headers+: +true+
# - +converters+: +:numeric+
# - +header_converters+: +:symbol+
#
# Returns a CSV::Table object.
#
# Example:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# CSV.table(path) # => #<CSV::Table mode:col_or_row row_count:4>
def table(path, **options)
default_options = {
headers: true,
converters: :numeric,
header_converters: :symbol,
}
options = default_options.merge(options)
read(path, **options)
end
end
# :call-seq:
# CSV.new(string)
# CSV.new(io)
# CSV.new(string, **options)
# CSV.new(io, **options)
#
# Returns the new \CSV object created using +string+ or +io+
# and the specified +options+.
#
# - Argument +string+ should be a \String object;
# it will be put into a new StringIO object positioned at the beginning.
# :include: ../doc/csv/arguments/io.rdoc
# - Argument +options+: See:
# * {Options for Parsing}[#class-CSV-label-Options+for+Parsing]
# * {Options for Generating}[#class-CSV-label-Options+for+Generating]
# For performance reasons, the options cannot be overridden
# in a \CSV object, so those specified here will endure.
#
# In addition to the \CSV instance methods, several \IO methods are delegated.
# See {Delegated Methods}[#class-CSV-label-Delegated+Methods].
#
# ---
#
# Create a \CSV object from a \String object:
# csv = CSV.new('foo,0')
# csv # => #<CSV io_type:StringIO encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
#
# Create a \CSV object from a \File object:
# File.write('t.csv', 'foo,0')
# csv = CSV.new(File.open('t.csv'))
# csv # => #<CSV io_type:File io_path:"t.csv" encoding:UTF-8 lineno:0 col_sep:"," row_sep:"\n" quote_char:"\"">
#
# ---
#
# Raises an exception if the argument is +nil+:
# # Raises ArgumentError (Cannot parse nil as CSV):
# CSV.new(nil)
#
def initialize(data,
col_sep: ",",
row_sep: :auto,
quote_char: '"',
field_size_limit: nil,
max_field_size: nil,
converters: nil,
unconverted_fields: nil,
headers: false,
return_headers: false,
write_headers: nil,
header_converters: nil,
skip_blanks: false,
force_quotes: false,
skip_lines: nil,
liberal_parsing: false,
internal_encoding: nil,
external_encoding: nil,
encoding: nil,
nil_value: nil,
empty_value: "",
strip: false,
quote_empty: true,
write_converters: nil,
write_nil_value: nil,
write_empty_value: "")
raise ArgumentError.new("Cannot parse nil as CSV") if data.nil?
if data.is_a?(String)
if encoding
if encoding.is_a?(String)
data_external_encoding, data_internal_encoding = encoding.split(":", 2)
if data_internal_encoding
data = data.encode(data_internal_encoding, data_external_encoding)
else
data = data.dup.force_encoding(data_external_encoding)
end
else
data = data.dup.force_encoding(encoding)
end
end
@io = StringIO.new(data)
else
@io = data
end
@encoding = determine_encoding(encoding, internal_encoding)
@base_fields_converter_options = {
nil_value: nil_value,
empty_value: empty_value,
}
@write_fields_converter_options = {
nil_value: write_nil_value,
empty_value: write_empty_value,
}
@initial_converters = converters
@initial_header_converters = header_converters
@initial_write_converters = write_converters
if max_field_size.nil? and field_size_limit
max_field_size = field_size_limit - 1
end
@parser_options = {
column_separator: col_sep,
row_separator: row_sep,
quote_character: quote_char,
max_field_size: max_field_size,
unconverted_fields: unconverted_fields,
headers: headers,
return_headers: return_headers,
skip_blanks: skip_blanks,
skip_lines: skip_lines,
liberal_parsing: liberal_parsing,
encoding: @encoding,
nil_value: nil_value,
empty_value: empty_value,
strip: strip,
}
@parser = nil
@parser_enumerator = nil
@eof_error = nil
@writer_options = {
encoding: @encoding,
force_encoding: (not encoding.nil?),
force_quotes: force_quotes,
headers: headers,
write_headers: write_headers,
column_separator: col_sep,
row_separator: row_sep,
quote_character: quote_char,
quote_empty: quote_empty,
}
@writer = nil
writer if @writer_options[:write_headers]
end
# :call-seq:
# csv.col_sep -> string
#
# Returns the encoded column separator; used for parsing and writing;
# see {Option +col_sep+}[#class-CSV-label-Option+col_sep]:
# CSV.new('').col_sep # => ","
def col_sep
parser.column_separator
end
# :call-seq:
# csv.row_sep -> string
#
# Returns the encoded row separator; used for parsing and writing;
# see {Option +row_sep+}[#class-CSV-label-Option+row_sep]:
# CSV.new('').row_sep # => "\n"
def row_sep
parser.row_separator
end
# :call-seq:
# csv.quote_char -> character
#
# Returns the encoded quote character; used for parsing and writing;
# see {Option +quote_char+}[#class-CSV-label-Option+quote_char]:
# CSV.new('').quote_char # => "\""
def quote_char
parser.quote_character
end
# :call-seq:
# csv.field_size_limit -> integer or nil
#
# Returns the limit for field size; used for parsing;
# see {Option +field_size_limit+}[#class-CSV-label-Option+field_size_limit]:
# CSV.new('').field_size_limit # => nil
#
# Deprecated since 3.2.3. Use +max_field_size+ instead.
def field_size_limit
parser.field_size_limit
end
# :call-seq:
# csv.max_field_size -> integer or nil
#
# Returns the limit for field size; used for parsing;
# see {Option +max_field_size+}[#class-CSV-label-Option+max_field_size]:
# CSV.new('').max_field_size # => nil
#
# Since 3.2.3.
def max_field_size
parser.max_field_size
end
# :call-seq:
# csv.skip_lines -> regexp or nil
#
# Returns the \Regexp used to identify comment lines; used for parsing;
# see {Option +skip_lines+}[#class-CSV-label-Option+skip_lines]:
# CSV.new('').skip_lines # => nil
def skip_lines
parser.skip_lines
end
# :call-seq:
# csv.converters -> array
#
# Returns an \Array containing field converters;
# see {Field Converters}[#class-CSV-label-Field+Converters]:
# csv = CSV.new('')
# csv.converters # => []
# csv.convert(:integer)
# csv.converters # => [:integer]
# csv.convert(proc {|x| x.to_s })
# csv.converters
#
# Notes that you need to call
# +Ractor.make_shareable(CSV::Converters)+ on the main Ractor to use
# this method.
def converters
parser_fields_converter.map do |converter|
name = Converters.rassoc(converter)
name ? name.first : converter
end
end
# :call-seq:
# csv.unconverted_fields? -> object
#
# Returns the value that determines whether unconverted fields are to be
# available; used for parsing;
# see {Option +unconverted_fields+}[#class-CSV-label-Option+unconverted_fields]:
# CSV.new('').unconverted_fields? # => nil
def unconverted_fields?
parser.unconverted_fields?
end
# :call-seq:
# csv.headers -> object
#
# Returns the value that determines whether headers are used; used for parsing;
# see {Option +headers+}[#class-CSV-label-Option+headers]:
# CSV.new('').headers # => nil
def headers
if @writer
@writer.headers
else
parsed_headers = parser.headers
return parsed_headers if parsed_headers
raw_headers = @parser_options[:headers]
raw_headers = nil if raw_headers == false
raw_headers
end
end
# :call-seq:
# csv.return_headers? -> true or false
#
# Returns the value that determines whether headers are to be returned; used for parsing;
# see {Option +return_headers+}[#class-CSV-label-Option+return_headers]:
# CSV.new('').return_headers? # => false
def return_headers?
parser.return_headers?
end
# :call-seq:
# csv.write_headers? -> true or false
#
# Returns the value that determines whether headers are to be written; used for generating;
# see {Option +write_headers+}[#class-CSV-label-Option+write_headers]:
# CSV.new('').write_headers? # => nil
def write_headers?
@writer_options[:write_headers]
end
# :call-seq:
# csv.header_converters -> array
#
# Returns an \Array containing header converters; used for parsing;
# see {Header Converters}[#class-CSV-label-Header+Converters]:
# CSV.new('').header_converters # => []
#
# Notes that you need to call
# +Ractor.make_shareable(CSV::HeaderConverters)+ on the main Ractor
# to use this method.
def header_converters
header_fields_converter.map do |converter|
name = HeaderConverters.rassoc(converter)
name ? name.first : converter
end
end
# :call-seq:
# csv.skip_blanks? -> true or false
#
# Returns the value that determines whether blank lines are to be ignored; used for parsing;
# see {Option +skip_blanks+}[#class-CSV-label-Option+skip_blanks]:
# CSV.new('').skip_blanks? # => false
def skip_blanks?
parser.skip_blanks?
end
# :call-seq:
# csv.force_quotes? -> true or false
#
# Returns the value that determines whether all output fields are to be quoted;
# used for generating;
# see {Option +force_quotes+}[#class-CSV-label-Option+force_quotes]:
# CSV.new('').force_quotes? # => false
def force_quotes?
@writer_options[:force_quotes]
end
# :call-seq:
# csv.liberal_parsing? -> true or false
#
# Returns the value that determines whether illegal input is to be handled; used for parsing;
# see {Option +liberal_parsing+}[#class-CSV-label-Option+liberal_parsing]:
# CSV.new('').liberal_parsing? # => false
def liberal_parsing?
parser.liberal_parsing?
end
# :call-seq:
# csv.encoding -> encoding
#
# Returns the encoding used for parsing and generating;
# see {Character Encodings (M17n or Multilingualization)}[#class-CSV-label-Character+Encodings+-28M17n+or+Multilingualization-29]:
# CSV.new('').encoding # => #<Encoding:UTF-8>
attr_reader :encoding
# :call-seq:
# csv.line_no -> integer
#
# Returns the count of the rows parsed or generated.
#
# Parsing:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# CSV.open(path) do |csv|
# csv.each do |row|
# p [csv.lineno, row]
# end
# end
# Output:
# [1, ["foo", "0"]]
# [2, ["bar", "1"]]
# [3, ["baz", "2"]]
#
# Generating:
# CSV.generate do |csv|
# p csv.lineno; csv << ['foo', 0]
# p csv.lineno; csv << ['bar', 1]
# p csv.lineno; csv << ['baz', 2]
# end
# Output:
# 0
# 1
# 2
def lineno
if @writer
@writer.lineno
else
parser.lineno
end
end
# :call-seq:
# csv.line -> array
#
# Returns the line most recently read:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# CSV.open(path) do |csv|
# csv.each do |row|
# p [csv.lineno, csv.line]
# end
# end
# Output:
# [1, "foo,0\n"]
# [2, "bar,1\n"]
# [3, "baz,2\n"]
def line
parser.line
end
### IO and StringIO Delegation ###
extend Forwardable
def_delegators :@io, :binmode, :close, :close_read, :close_write,
:closed?, :external_encoding, :fcntl,
:fileno, :flush, :fsync, :internal_encoding,
:isatty, :pid, :pos, :pos=, :reopen,
:seek, :string, :sync, :sync=, :tell,
:truncate, :tty?
def binmode?
if @io.respond_to?(:binmode?)
@io.binmode?
else
false
end
end
def flock(*args)
raise NotImplementedError unless @io.respond_to?(:flock)
@io.flock(*args)
end
def ioctl(*args)
raise NotImplementedError unless @io.respond_to?(:ioctl)
@io.ioctl(*args)
end
def path
@io.path if @io.respond_to?(:path)
end
def stat(*args)
raise NotImplementedError unless @io.respond_to?(:stat)
@io.stat(*args)
end
def to_i
raise NotImplementedError unless @io.respond_to?(:to_i)
@io.to_i
end
def to_io
@io.respond_to?(:to_io) ? @io.to_io : @io
end
def eof?
return false if @eof_error
begin
parser_enumerator.peek
false
rescue MalformedCSVError => error
@eof_error = error
false
rescue StopIteration
true
end
end
alias_method :eof, :eof?
# Rewinds the underlying IO object and resets CSV's lineno() counter.
def rewind
@parser = nil
@parser_enumerator = nil
@eof_error = nil
@writer.rewind if @writer
@io.rewind
end
### End Delegation ###
# :call-seq:
# csv << row -> self
#
# Appends a row to +self+.
#
# - Argument +row+ must be an \Array object or a CSV::Row object.
# - The output stream must be open for writing.
#
# ---
#
# Append Arrays:
# CSV.generate do |csv|
# csv << ['foo', 0]
# csv << ['bar', 1]
# csv << ['baz', 2]
# end # => "foo,0\nbar,1\nbaz,2\n"
#
# Append CSV::Rows:
# headers = []
# CSV.generate do |csv|
# csv << CSV::Row.new(headers, ['foo', 0])
# csv << CSV::Row.new(headers, ['bar', 1])
# csv << CSV::Row.new(headers, ['baz', 2])
# end # => "foo,0\nbar,1\nbaz,2\n"
#
# Headers in CSV::Row objects are not appended:
# headers = ['Name', 'Count']
# CSV.generate do |csv|
# csv << CSV::Row.new(headers, ['foo', 0])
# csv << CSV::Row.new(headers, ['bar', 1])
# csv << CSV::Row.new(headers, ['baz', 2])
# end # => "foo,0\nbar,1\nbaz,2\n"
#
# ---
#
# Raises an exception if +row+ is not an \Array or \CSV::Row:
# CSV.generate do |csv|
# # Raises NoMethodError (undefined method `collect' for :foo:Symbol)
# csv << :foo
# end
#
# Raises an exception if the output stream is not opened for writing:
# path = 't.csv'
# File.write(path, '')
# File.open(path) do |file|
# CSV.open(file) do |csv|
# # Raises IOError (not opened for writing)
# csv << ['foo', 0]
# end
# end
def <<(row)
writer << row
self
end
alias_method :add_row, :<<
alias_method :puts, :<<
# :call-seq:
# convert(converter_name) -> array_of_procs
# convert {|field, field_info| ... } -> array_of_procs
#
# - With no block, installs a field converter (a \Proc).
# - With a block, defines and installs a custom field converter.
# - Returns the \Array of installed field converters.
#
# - Argument +converter_name+, if given, should be the name
# of an existing field converter.
#
# See {Field Converters}[#class-CSV-label-Field+Converters].
# ---
#
# With no block, installs a field converter:
# csv = CSV.new('')
# csv.convert(:integer)
# csv.convert(:float)
# csv.convert(:date)
# csv.converters # => [:integer, :float, :date]
#
# ---
#
# The block, if given, is called for each field:
# - Argument +field+ is the field value.
# - Argument +field_info+ is a CSV::FieldInfo object
# containing details about the field.
#
# The examples here assume the prior execution of:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# Example giving a block:
# csv = CSV.open(path)
# csv.convert {|field, field_info| p [field, field_info]; field.upcase }
# csv.read # => [["FOO", "0"], ["BAR", "1"], ["BAZ", "2"]]
#
# Output:
# ["foo", #<struct CSV::FieldInfo index=0, line=1, header=nil>]
# ["0", #<struct CSV::FieldInfo index=1, line=1, header=nil>]
# ["bar", #<struct CSV::FieldInfo index=0, line=2, header=nil>]
# ["1", #<struct CSV::FieldInfo index=1, line=2, header=nil>]
# ["baz", #<struct CSV::FieldInfo index=0, line=3, header=nil>]
# ["2", #<struct CSV::FieldInfo index=1, line=3, header=nil>]
#
# The block need not return a \String object:
# csv = CSV.open(path)
# csv.convert {|field, field_info| field.to_sym }
# csv.read # => [[:foo, :"0"], [:bar, :"1"], [:baz, :"2"]]
#
# If +converter_name+ is given, the block is not called:
# csv = CSV.open(path)
# csv.convert(:integer) {|field, field_info| fail 'Cannot happen' }
# csv.read # => [["foo", 0], ["bar", 1], ["baz", 2]]
#
# ---
#
# Raises a parse-time exception if +converter_name+ is not the name of a built-in
# field converter:
# csv = CSV.open(path)
# csv.convert(:nosuch) => [nil]
# # Raises NoMethodError (undefined method `arity' for nil:NilClass)
# csv.read
def convert(name = nil, &converter)
parser_fields_converter.add_converter(name, &converter)
end
# :call-seq:
# header_convert(converter_name) -> array_of_procs
# header_convert {|header, field_info| ... } -> array_of_procs
#
# - With no block, installs a header converter (a \Proc).
# - With a block, defines and installs a custom header converter.
# - Returns the \Array of installed header converters.
#
# - Argument +converter_name+, if given, should be the name
# of an existing header converter.
#
# See {Header Converters}[#class-CSV-label-Header+Converters].
# ---
#
# With no block, installs a header converter:
# csv = CSV.new('')
# csv.header_convert(:symbol)
# csv.header_convert(:downcase)
# csv.header_converters # => [:symbol, :downcase]
#
# ---
#
# The block, if given, is called for each header:
# - Argument +header+ is the header value.
# - Argument +field_info+ is a CSV::FieldInfo object
# containing details about the header.
#
# The examples here assume the prior execution of:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
#
# Example giving a block:
# csv = CSV.open(path, headers: true)
# csv.header_convert {|header, field_info| p [header, field_info]; header.upcase }
# table = csv.read
# table # => #<CSV::Table mode:col_or_row row_count:4>
# table.headers # => ["NAME", "VALUE"]
#
# Output:
# ["Name", #<struct CSV::FieldInfo index=0, line=1, header=nil>]
# ["Value", #<struct CSV::FieldInfo index=1, line=1, header=nil>]
# The block need not return a \String object:
# csv = CSV.open(path, headers: true)
# csv.header_convert {|header, field_info| header.to_sym }
# table = csv.read
# table.headers # => [:Name, :Value]
#
# If +converter_name+ is given, the block is not called:
# csv = CSV.open(path, headers: true)
# csv.header_convert(:downcase) {|header, field_info| fail 'Cannot happen' }
# table = csv.read
# table.headers # => ["name", "value"]
# ---
#
# Raises a parse-time exception if +converter_name+ is not the name of a built-in
# field converter:
# csv = CSV.open(path, headers: true)
# csv.header_convert(:nosuch)
# # Raises NoMethodError (undefined method `arity' for nil:NilClass)
# csv.read
def header_convert(name = nil, &converter)
header_fields_converter.add_converter(name, &converter)
end
include Enumerable
# :call-seq:
# csv.each -> enumerator
# csv.each {|row| ...}
#
# Calls the block with each successive row.
# The data source must be opened for reading.
#
# Without headers:
# string = "foo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string)
# csv.each do |row|
# p row
# end
# Output:
# ["foo", "0"]
# ["bar", "1"]
# ["baz", "2"]
#
# With headers:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string, headers: true)
# csv.each do |row|
# p row
# end
# Output:
# <CSV::Row "Name":"foo" "Value":"0">
# <CSV::Row "Name":"bar" "Value":"1">
# <CSV::Row "Name":"baz" "Value":"2">
#
# ---
#
# Raises an exception if the source is not opened for reading:
# string = "foo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string)
# csv.close
# # Raises IOError (not opened for reading)
# csv.each do |row|
# p row
# end
def each(&block)
return to_enum(__method__) unless block_given?
begin
while true
yield(parser_enumerator.next)
end
rescue StopIteration
end
end
# :call-seq:
# csv.read -> array or csv_table
#
# Forms the remaining rows from +self+ into:
# - A CSV::Table object, if headers are in use.
# - An \Array of Arrays, otherwise.
#
# The data source must be opened for reading.
#
# Without headers:
# string = "foo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# csv = CSV.open(path)
# csv.read # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# With headers:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# path = 't.csv'
# File.write(path, string)
# csv = CSV.open(path, headers: true)
# csv.read # => #<CSV::Table mode:col_or_row row_count:4>
#
# ---
#
# Raises an exception if the source is not opened for reading:
# string = "foo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string)
# csv.close
# # Raises IOError (not opened for reading)
# csv.read
def read
rows = to_a
if parser.use_headers?
Table.new(rows, headers: parser.headers)
else
rows
end
end
alias_method :readlines, :read
# :call-seq:
# csv.header_row? -> true or false
#
# Returns +true+ if the next row to be read is a header row\;
# +false+ otherwise.
#
# Without headers:
# string = "foo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string)
# csv.header_row? # => false
#
# With headers:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string, headers: true)
# csv.header_row? # => true
# csv.shift # => #<CSV::Row "Name":"foo" "Value":"0">
# csv.header_row? # => false
#
# ---
#
# Raises an exception if the source is not opened for reading:
# string = "foo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string)
# csv.close
# # Raises IOError (not opened for reading)
# csv.header_row?
def header_row?
parser.header_row?
end
# :call-seq:
# csv.shift -> array, csv_row, or nil
#
# Returns the next row of data as:
# - An \Array if no headers are used.
# - A CSV::Row object if headers are used.
#
# The data source must be opened for reading.
#
# Without headers:
# string = "foo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string)
# csv.shift # => ["foo", "0"]
# csv.shift # => ["bar", "1"]
# csv.shift # => ["baz", "2"]
# csv.shift # => nil
#
# With headers:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string, headers: true)
# csv.shift # => #<CSV::Row "Name":"foo" "Value":"0">
# csv.shift # => #<CSV::Row "Name":"bar" "Value":"1">
# csv.shift # => #<CSV::Row "Name":"baz" "Value":"2">
# csv.shift # => nil
#
# ---
#
# Raises an exception if the source is not opened for reading:
# string = "foo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string)
# csv.close
# # Raises IOError (not opened for reading)
# csv.shift
def shift
if @eof_error
eof_error, @eof_error = @eof_error, nil
raise eof_error
end
begin
parser_enumerator.next
rescue StopIteration
nil
end
end
alias_method :gets, :shift
alias_method :readline, :shift
# :call-seq:
# csv.inspect -> string
#
# Returns a \String showing certain properties of +self+:
# string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# csv = CSV.new(string, headers: true)
# s = csv.inspect
# s # => "#<CSV io_type:StringIO encoding:UTF-8 lineno:0 col_sep:\",\" row_sep:\"\\n\" quote_char:\"\\\"\" headers:true>"
def inspect
str = ["#<", self.class.to_s, " io_type:"]
# show type of wrapped IO
if @io == $stdout then str << "$stdout"
elsif @io == $stdin then str << "$stdin"
elsif @io == $stderr then str << "$stderr"
else str << @io.class.to_s
end
# show IO.path(), if available
if @io.respond_to?(:path) and (p = @io.path)
str << " io_path:" << p.inspect
end
# show encoding
str << " encoding:" << @encoding.name
# show other attributes
["lineno", "col_sep", "row_sep", "quote_char"].each do |attr_name|
if a = __send__(attr_name)
str << " " << attr_name << ":" << a.inspect
end
end
["skip_blanks", "liberal_parsing"].each do |attr_name|
if a = __send__("#{attr_name}?")
str << " " << attr_name << ":" << a.inspect
end
end
_headers = headers
str << " headers:" << _headers.inspect if _headers
str << ">"
begin
str.join('')
rescue # any encoding error
str.map do |s|
e = Encoding::Converter.asciicompat_encoding(s.encoding)
e ? s.encode(e) : s.force_encoding("ASCII-8BIT")
end.join('')
end
end
private
def determine_encoding(encoding, internal_encoding)
# honor the IO encoding if we can, otherwise default to ASCII-8BIT
io_encoding = raw_encoding
return io_encoding if io_encoding
return Encoding.find(internal_encoding) if internal_encoding
if encoding
encoding, = encoding.split(":", 2) if encoding.is_a?(String)
return Encoding.find(encoding)
end
Encoding.default_internal || Encoding.default_external
end
def normalize_converters(converters)
converters ||= []
unless converters.is_a?(Array)
converters = [converters]
end
converters.collect do |converter|
case converter
when Proc # custom code block
[nil, converter]
else # by name
[converter, nil]
end
end
end
#
# Processes +fields+ with <tt>@converters</tt>, or <tt>@header_converters</tt>
# if +headers+ is passed as +true+, returning the converted field set. Any
# converter that changes the field into something other than a String halts
# the pipeline of conversion for that field. This is primarily an efficiency
# shortcut.
#
def convert_fields(fields, headers = false)
if headers
header_fields_converter.convert(fields, nil, 0)
else
parser_fields_converter.convert(fields, @headers, lineno)
end
end
#
# Returns the encoding of the internal IO object.
#
def raw_encoding
if @io.respond_to? :internal_encoding
@io.internal_encoding || @io.external_encoding
elsif @io.respond_to? :encoding
@io.encoding
else
nil
end
end
def parser_fields_converter
@parser_fields_converter ||= build_parser_fields_converter
end
def build_parser_fields_converter
specific_options = {
builtin_converters_name: :Converters,
}
options = @base_fields_converter_options.merge(specific_options)
build_fields_converter(@initial_converters, options)
end
def header_fields_converter
@header_fields_converter ||= build_header_fields_converter
end
def build_header_fields_converter
specific_options = {
builtin_converters_name: :HeaderConverters,
accept_nil: true,
}
options = @base_fields_converter_options.merge(specific_options)
build_fields_converter(@initial_header_converters, options)
end
def writer_fields_converter
@writer_fields_converter ||= build_writer_fields_converter
end
def build_writer_fields_converter
build_fields_converter(@initial_write_converters,
@write_fields_converter_options)
end
def build_fields_converter(initial_converters, options)
fields_converter = FieldsConverter.new(options)
normalize_converters(initial_converters).each do |name, converter|
fields_converter.add_converter(name, &converter)
end
fields_converter
end
def parser
@parser ||= Parser.new(@io, parser_options)
end
def parser_options
@parser_options.merge(header_fields_converter: header_fields_converter,
fields_converter: parser_fields_converter)
end
def parser_enumerator
@parser_enumerator ||= parser.parse
end
def writer
@writer ||= Writer.new(@io, writer_options)
end
def writer_options
@writer_options.merge(header_fields_converter: header_fields_converter,
fields_converter: writer_fields_converter)
end
end
# Passes +args+ to CSV::instance.
#
# CSV("CSV,data").read
# #=> [["CSV", "data"]]
#
# If a block is given, the instance is passed the block and the return value
# becomes the return value of the block.
#
# CSV("CSV,data") { |c|
# c.read.any? { |a| a.include?("data") }
# } #=> true
#
# CSV("CSV,data") { |c|
# c.read.any? { |a| a.include?("zombies") }
# } #=> false
#
# CSV options may also be given.
#
# io = StringIO.new
# CSV(io, col_sep: ";") { |csv| csv << ["a", "b", "c"] }
#
# This API is not Ractor-safe.
#
def CSV(*args, **options, &block)
CSV.instance(*args, **options, &block)
end
require_relative "csv/version"
require_relative "csv/core_ext/array"
require_relative "csv/core_ext/string"
share/ruby/cgi.rb 0000644 00000023526 15173517736 0007745 0 ustar 00 # frozen_string_literal: true
#
# cgi.rb - cgi support library
#
# Copyright (C) 2000 Network Applied Communication Laboratory, Inc.
#
# Copyright (C) 2000 Information-technology Promotion Agency, Japan
#
# Author: Wakou Aoyama <wakou@ruby-lang.org>
#
# Documentation: Wakou Aoyama (RDoc'd and embellished by William Webber)
#
# == Overview
#
# The Common Gateway Interface (CGI) is a simple protocol for passing an HTTP
# request from a web server to a standalone program, and returning the output
# to the web browser. Basically, a CGI program is called with the parameters
# of the request passed in either in the environment (GET) or via $stdin
# (POST), and everything it prints to $stdout is returned to the client.
#
# This file holds the CGI class. This class provides functionality for
# retrieving HTTP request parameters, managing cookies, and generating HTML
# output.
#
# The file CGI::Session provides session management functionality; see that
# class for more details.
#
# See http://www.w3.org/CGI/ for more information on the CGI protocol.
#
# == Introduction
#
# CGI is a large class, providing several categories of methods, many of which
# are mixed in from other modules. Some of the documentation is in this class,
# some in the modules CGI::QueryExtension and CGI::HtmlExtension. See
# CGI::Cookie for specific information on handling cookies, and cgi/session.rb
# (CGI::Session) for information on sessions.
#
# For queries, CGI provides methods to get at environmental variables,
# parameters, cookies, and multipart request data. For responses, CGI provides
# methods for writing output and generating HTML.
#
# Read on for more details. Examples are provided at the bottom.
#
# == Queries
#
# The CGI class dynamically mixes in parameter and cookie-parsing
# functionality, environmental variable access, and support for
# parsing multipart requests (including uploaded files) from the
# CGI::QueryExtension module.
#
# === Environmental Variables
#
# The standard CGI environmental variables are available as read-only
# attributes of a CGI object. The following is a list of these variables:
#
#
# AUTH_TYPE HTTP_HOST REMOTE_IDENT
# CONTENT_LENGTH HTTP_NEGOTIATE REMOTE_USER
# CONTENT_TYPE HTTP_PRAGMA REQUEST_METHOD
# GATEWAY_INTERFACE HTTP_REFERER SCRIPT_NAME
# HTTP_ACCEPT HTTP_USER_AGENT SERVER_NAME
# HTTP_ACCEPT_CHARSET PATH_INFO SERVER_PORT
# HTTP_ACCEPT_ENCODING PATH_TRANSLATED SERVER_PROTOCOL
# HTTP_ACCEPT_LANGUAGE QUERY_STRING SERVER_SOFTWARE
# HTTP_CACHE_CONTROL REMOTE_ADDR
# HTTP_FROM REMOTE_HOST
#
#
# For each of these variables, there is a corresponding attribute with the
# same name, except all lower case and without a preceding HTTP_.
# +content_length+ and +server_port+ are integers; the rest are strings.
#
# === Parameters
#
# The method #params() returns a hash of all parameters in the request as
# name/value-list pairs, where the value-list is an Array of one or more
# values. The CGI object itself also behaves as a hash of parameter names
# to values, but only returns a single value (as a String) for each
# parameter name.
#
# For instance, suppose the request contains the parameter
# "favourite_colours" with the multiple values "blue" and "green". The
# following behavior would occur:
#
# cgi.params["favourite_colours"] # => ["blue", "green"]
# cgi["favourite_colours"] # => "blue"
#
# If a parameter does not exist, the former method will return an empty
# array, the latter an empty string. The simplest way to test for existence
# of a parameter is by the #has_key? method.
#
# === Cookies
#
# HTTP Cookies are automatically parsed from the request. They are available
# from the #cookies() accessor, which returns a hash from cookie name to
# CGI::Cookie object.
#
# === Multipart requests
#
# If a request's method is POST and its content type is multipart/form-data,
# then it may contain uploaded files. These are stored by the QueryExtension
# module in the parameters of the request. The parameter name is the name
# attribute of the file input field, as usual. However, the value is not
# a string, but an IO object, either an IOString for small files, or a
# Tempfile for larger ones. This object also has the additional singleton
# methods:
#
# #local_path():: the path of the uploaded file on the local filesystem
# #original_filename():: the name of the file on the client computer
# #content_type():: the content type of the file
#
# == Responses
#
# The CGI class provides methods for sending header and content output to
# the HTTP client, and mixes in methods for programmatic HTML generation
# from CGI::HtmlExtension and CGI::TagMaker modules. The precise version of HTML
# to use for HTML generation is specified at object creation time.
#
# === Writing output
#
# The simplest way to send output to the HTTP client is using the #out() method.
# This takes the HTTP headers as a hash parameter, and the body content
# via a block. The headers can be generated as a string using the #http_header()
# method. The output stream can be written directly to using the #print()
# method.
#
# === Generating HTML
#
# Each HTML element has a corresponding method for generating that
# element as a String. The name of this method is the same as that
# of the element, all lowercase. The attributes of the element are
# passed in as a hash, and the body as a no-argument block that evaluates
# to a String. The HTML generation module knows which elements are
# always empty, and silently drops any passed-in body. It also knows
# which elements require matching closing tags and which don't. However,
# it does not know what attributes are legal for which elements.
#
# There are also some additional HTML generation methods mixed in from
# the CGI::HtmlExtension module. These include individual methods for the
# different types of form inputs, and methods for elements that commonly
# take particular attributes where the attributes can be directly specified
# as arguments, rather than via a hash.
#
# === Utility HTML escape and other methods like a function.
#
# There are some utility tool defined in cgi/util.rb .
# And when include, you can use utility methods like a function.
#
# == Examples of use
#
# === Get form values
#
# require "cgi"
# cgi = CGI.new
# value = cgi['field_name'] # <== value string for 'field_name'
# # if not 'field_name' included, then return "".
# fields = cgi.keys # <== array of field names
#
# # returns true if form has 'field_name'
# cgi.has_key?('field_name')
# cgi.has_key?('field_name')
# cgi.include?('field_name')
#
# CAUTION! <code>cgi['field_name']</code> returned an Array with the old
# cgi.rb(included in Ruby 1.6)
#
# === Get form values as hash
#
# require "cgi"
# cgi = CGI.new
# params = cgi.params
#
# cgi.params is a hash.
#
# cgi.params['new_field_name'] = ["value"] # add new param
# cgi.params['field_name'] = ["new_value"] # change value
# cgi.params.delete('field_name') # delete param
# cgi.params.clear # delete all params
#
#
# === Save form values to file
#
# require "pstore"
# db = PStore.new("query.db")
# db.transaction do
# db["params"] = cgi.params
# end
#
#
# === Restore form values from file
#
# require "pstore"
# db = PStore.new("query.db")
# db.transaction do
# cgi.params = db["params"]
# end
#
#
# === Get multipart form values
#
# require "cgi"
# cgi = CGI.new
# value = cgi['field_name'] # <== value string for 'field_name'
# value.read # <== body of value
# value.local_path # <== path to local file of value
# value.original_filename # <== original filename of value
# value.content_type # <== content_type of value
#
# and value has StringIO or Tempfile class methods.
#
# === Get cookie values
#
# require "cgi"
# cgi = CGI.new
# values = cgi.cookies['name'] # <== array of 'name'
# # if not 'name' included, then return [].
# names = cgi.cookies.keys # <== array of cookie names
#
# and cgi.cookies is a hash.
#
# === Get cookie objects
#
# require "cgi"
# cgi = CGI.new
# for name, cookie in cgi.cookies
# cookie.expires = Time.now + 30
# end
# cgi.out("cookie" => cgi.cookies) {"string"}
#
# cgi.cookies # { "name1" => cookie1, "name2" => cookie2, ... }
#
# require "cgi"
# cgi = CGI.new
# cgi.cookies['name'].expires = Time.now + 30
# cgi.out("cookie" => cgi.cookies['name']) {"string"}
#
# === Print http header and html string to $DEFAULT_OUTPUT ($>)
#
# require "cgi"
# cgi = CGI.new("html4") # add HTML generation methods
# cgi.out do
# cgi.html do
# cgi.head do
# cgi.title { "TITLE" }
# end +
# cgi.body do
# cgi.form("ACTION" => "uri") do
# cgi.p do
# cgi.textarea("get_text") +
# cgi.br +
# cgi.submit
# end
# end +
# cgi.pre do
# CGI.escapeHTML(
# "params: #{cgi.params.inspect}\n" +
# "cookies: #{cgi.cookies.inspect}\n" +
# ENV.collect do |key, value|
# "#{key} --> #{value}\n"
# end.join("")
# )
# end
# end
# end
# end
#
# # add HTML generation methods
# CGI.new("html3") # html3.2
# CGI.new("html4") # html4.01 (Strict)
# CGI.new("html4Tr") # html4.01 Transitional
# CGI.new("html4Fr") # html4.01 Frameset
# CGI.new("html5") # html5
#
# === Some utility methods
#
# require 'cgi/util'
# CGI.escapeHTML('Usage: foo "bar" <baz>')
#
#
# === Some utility methods like a function
#
# require 'cgi/util'
# include CGI::Util
# escapeHTML('Usage: foo "bar" <baz>')
# h('Usage: foo "bar" <baz>') # alias
#
#
class CGI
VERSION = "0.4.2"
end
require 'cgi/core'
require 'cgi/cookie'
require 'cgi/util'
CGI.autoload(:HtmlExtension, 'cgi/html')
share/ruby/objspace.rb 0000644 00000010214 15173517736 0010757 0 ustar 00 # frozen_string_literal: true
require 'objspace.so'
module ObjectSpace
class << self
private :_dump
private :_dump_all
private :_dump_shapes
end
module_function
# Dump the contents of a ruby object as JSON.
#
# _output_ can be one of: +:stdout+, +:file+, +:string+, or IO object.
#
# * +:file+ means dumping to a tempfile and returning corresponding File object;
# * +:stdout+ means printing the dump and returning +nil+;
# * +:string+ means returning a string with the dump;
# * if an instance of IO object is provided, the output goes there, and the object
# is returned.
#
# This method is only expected to work with C Ruby.
# This is an experimental method and is subject to change.
# In particular, the function signature and output format are
# not guaranteed to be compatible in future versions of ruby.
def dump(obj, output: :string)
out = case output
when :file, nil
require 'tempfile'
Tempfile.create(%w(rubyobj .json))
when :stdout
STDOUT
when :string
+''
when IO
output
else
raise ArgumentError, "wrong output option: #{output.inspect}"
end
ret = _dump(obj, out)
return nil if output == :stdout
ret
end
# Dump the contents of the ruby heap as JSON.
#
# _output_ argument is the same as for #dump.
#
# _full_ must be a boolean. If true, all heap slots are dumped including the empty ones (+T_NONE+).
#
# _since_ must be a non-negative integer or +nil+.
#
# If _since_ is a positive integer, only objects of that generation and
# newer generations are dumped. The current generation can be accessed using
# GC::count. Objects that were allocated without object allocation tracing enabled
# are ignored. See ::trace_object_allocations for more information and
# examples.
#
# If _since_ is omitted or is +nil+, all objects are dumped.
#
# _shapes_ must be a boolean or a non-negative integer.
#
# If _shapes_ is a positive integer, only shapes newer than the provided
# shape id are dumped. The current shape_id can be accessed using <tt>RubyVM.stat(:next_shape_id)</tt>.
#
# If _shapes_ is +false+, no shapes are dumped.
#
# To only dump objects allocated past a certain point you can combine _since_ and _shapes_:
# ObjectSpace.trace_object_allocations
# GC.start
# gc_generation = GC.count
# shape_generation = RubyVM.stat(:next_shape_id)
# call_method_to_instrument
# ObjectSpace.dump_all(since: gc_generation, shapes: shape_generation)
#
# This method is only expected to work with C Ruby.
# This is an experimental method and is subject to change.
# In particular, the function signature and output format are
# not guaranteed to be compatible in future versions of ruby.
def dump_all(output: :file, full: false, since: nil, shapes: true)
out = case output
when :file, nil
require 'tempfile'
Tempfile.create(%w(rubyheap .json))
when :stdout
STDOUT
when :string
+''
when IO
output
else
raise ArgumentError, "wrong output option: #{output.inspect}"
end
shapes = 0 if shapes == true
ret = _dump_all(out, full, since, shapes)
return nil if output == :stdout
ret
end
# Dump the contents of the ruby shape tree as JSON.
#
# _output_ argument is the same as for #dump.
#
# If _since_ is a positive integer, only shapes newer than the provided
# shape id are dumped. The current shape_id can be accessed using <tt>RubyVM.stat(:next_shape_id)</tt>.
#
# This method is only expected to work with C Ruby.
# This is an experimental method and is subject to change.
# In particular, the function signature and output format are
# not guaranteed to be compatible in future versions of ruby.
def dump_shapes(output: :file, since: 0)
out = case output
when :file, nil
require 'tempfile'
Tempfile.create(%w(rubyshapes .json))
when :stdout
STDOUT
when :string
+''
when IO
output
else
raise ArgumentError, "wrong output option: #{output.inspect}"
end
ret = _dump_shapes(out, since)
return nil if output == :stdout
ret
end
end
share/gems/gems/psych-5.1.2/lib/psych 0000755 00000000000 15173517736 0013152 0 ustar 00 share/ruby/pp.rb 0000644 00000042372 15173517736 0007622 0 ustar 00 # frozen_string_literal: true
require 'prettyprint'
##
# A pretty-printer for Ruby objects.
#
##
# == What PP Does
#
# Standard output by #p returns this:
# #<PP:0x81fedf0 @genspace=#<Proc:0x81feda0>, @group_queue=#<PrettyPrint::GroupQueue:0x81fed3c @queue=[[#<PrettyPrint::Group:0x81fed78 @breakables=[], @depth=0, @break=false>], []]>, @buffer=[], @newline="\n", @group_stack=[#<PrettyPrint::Group:0x81fed78 @breakables=[], @depth=0, @break=false>], @buffer_width=0, @indent=0, @maxwidth=79, @output_width=2, @output=#<IO:0x8114ee4>>
#
# Pretty-printed output returns this:
# #<PP:0x81fedf0
# @buffer=[],
# @buffer_width=0,
# @genspace=#<Proc:0x81feda0>,
# @group_queue=
# #<PrettyPrint::GroupQueue:0x81fed3c
# @queue=
# [[#<PrettyPrint::Group:0x81fed78 @break=false, @breakables=[], @depth=0>],
# []]>,
# @group_stack=
# [#<PrettyPrint::Group:0x81fed78 @break=false, @breakables=[], @depth=0>],
# @indent=0,
# @maxwidth=79,
# @newline="\n",
# @output=#<IO:0x8114ee4>,
# @output_width=2>
#
##
# == Usage
#
# pp(obj) #=> obj
# pp obj #=> obj
# pp(obj1, obj2, ...) #=> [obj1, obj2, ...]
# pp() #=> nil
#
# Output <tt>obj(s)</tt> to <tt>$></tt> in pretty printed format.
#
# It returns <tt>obj(s)</tt>.
#
##
# == Output Customization
#
# To define a customized pretty printing function for your classes,
# redefine method <code>#pretty_print(pp)</code> in the class.
# Note that <code>require 'pp'</code> is needed before redefining <code>#pretty_print(pp)</code>.
#
# <code>#pretty_print</code> takes the +pp+ argument, which is an instance of the PP class.
# The method uses #text, #breakable, #nest, #group and #pp to print the
# object.
#
##
# == Pretty-Print JSON
#
# To pretty-print JSON refer to JSON#pretty_generate.
#
##
# == Author
# Tanaka Akira <akr@fsij.org>
class PP < PrettyPrint
VERSION = "0.5.0"
# Returns the usable width for +out+.
# As the width of +out+:
# 1. If +out+ is assigned to a tty device, its width is used.
# 2. Otherwise, or it could not get the value, the +COLUMN+
# environment variable is assumed to be set to the width.
# 3. If +COLUMN+ is not set to a non-zero number, 80 is assumed.
#
# And finally, returns the above width value - 1.
# * This -1 is for Windows command prompt, which moves the cursor to
# the next line if it reaches the last column.
def PP.width_for(out)
begin
require 'io/console'
_, width = out.winsize
rescue LoadError, NoMethodError, SystemCallError
end
(width || ENV['COLUMNS']&.to_i&.nonzero? || 80) - 1
end
# Outputs +obj+ to +out+ in pretty printed format of
# +width+ columns in width.
#
# If +out+ is omitted, <code>$></code> is assumed.
# If +width+ is omitted, the width of +out+ is assumed (see
# width_for).
#
# PP.pp returns +out+.
def PP.pp(obj, out=$>, width=width_for(out))
q = PP.new(out, width)
q.guard_inspect_key {q.pp obj}
q.flush
#$pp = q
out << "\n"
end
# Outputs +obj+ to +out+ like PP.pp but with no indent and
# newline.
#
# PP.singleline_pp returns +out+.
def PP.singleline_pp(obj, out=$>)
q = SingleLine.new(out)
q.guard_inspect_key {q.pp obj}
q.flush
out
end
# :stopdoc:
def PP.mcall(obj, mod, meth, *args, &block)
mod.instance_method(meth).bind_call(obj, *args, &block)
end
# :startdoc:
if defined? ::Ractor
class << self
# Returns the sharing detection flag as a boolean value.
# It is false (nil) by default.
def sharing_detection
Ractor.current[:pp_sharing_detection]
end
# Sets the sharing detection flag to b.
def sharing_detection=(b)
Ractor.current[:pp_sharing_detection] = b
end
end
else
@sharing_detection = false
class << self
# Returns the sharing detection flag as a boolean value.
# It is false by default.
attr_accessor :sharing_detection
end
end
module PPMethods
# Yields to a block
# and preserves the previous set of objects being printed.
def guard_inspect_key
if Thread.current[:__recursive_key__] == nil
Thread.current[:__recursive_key__] = {}.compare_by_identity
end
if Thread.current[:__recursive_key__][:inspect] == nil
Thread.current[:__recursive_key__][:inspect] = {}.compare_by_identity
end
save = Thread.current[:__recursive_key__][:inspect]
begin
Thread.current[:__recursive_key__][:inspect] = {}.compare_by_identity
yield
ensure
Thread.current[:__recursive_key__][:inspect] = save
end
end
# Check whether the object_id +id+ is in the current buffer of objects
# to be pretty printed. Used to break cycles in chains of objects to be
# pretty printed.
def check_inspect_key(id)
Thread.current[:__recursive_key__] &&
Thread.current[:__recursive_key__][:inspect] &&
Thread.current[:__recursive_key__][:inspect].include?(id)
end
# Adds the object_id +id+ to the set of objects being pretty printed, so
# as to not repeat objects.
def push_inspect_key(id)
Thread.current[:__recursive_key__][:inspect][id] = true
end
# Removes an object from the set of objects being pretty printed.
def pop_inspect_key(id)
Thread.current[:__recursive_key__][:inspect].delete id
end
# Adds +obj+ to the pretty printing buffer
# using Object#pretty_print or Object#pretty_print_cycle.
#
# Object#pretty_print_cycle is used when +obj+ is already
# printed, a.k.a the object reference chain has a cycle.
def pp(obj)
# If obj is a Delegator then use the object being delegated to for cycle
# detection
obj = obj.__getobj__ if defined?(::Delegator) and obj.is_a?(::Delegator)
if check_inspect_key(obj)
group {obj.pretty_print_cycle self}
return
end
begin
push_inspect_key(obj)
group {obj.pretty_print self}
ensure
pop_inspect_key(obj) unless PP.sharing_detection
end
end
# A convenience method which is same as follows:
#
# group(1, '#<' + obj.class.name, '>') { ... }
def object_group(obj, &block) # :yield:
group(1, '#<' + obj.class.name, '>', &block)
end
# A convenience method, like object_group, but also reformats the Object's
# object_id.
def object_address_group(obj, &block)
str = Kernel.instance_method(:to_s).bind_call(obj)
str.chomp!('>')
group(1, str, '>', &block)
end
# A convenience method which is same as follows:
#
# text ','
# breakable
def comma_breakable
text ','
breakable
end
# Adds a separated list.
# The list is separated by comma with breakable space, by default.
#
# #seplist iterates the +list+ using +iter_method+.
# It yields each object to the block given for #seplist.
# The procedure +separator_proc+ is called between each yields.
#
# If the iteration is zero times, +separator_proc+ is not called at all.
#
# If +separator_proc+ is nil or not given,
# +lambda { comma_breakable }+ is used.
# If +iter_method+ is not given, :each is used.
#
# For example, following 3 code fragments has similar effect.
#
# q.seplist([1,2,3]) {|v| xxx v }
#
# q.seplist([1,2,3], lambda { q.comma_breakable }, :each) {|v| xxx v }
#
# xxx 1
# q.comma_breakable
# xxx 2
# q.comma_breakable
# xxx 3
def seplist(list, sep=nil, iter_method=:each) # :yield: element
sep ||= lambda { comma_breakable }
first = true
list.__send__(iter_method) {|*v|
if first
first = false
else
sep.call
end
RUBY_VERSION >= "3.0" ? yield(*v, **{}) : yield(*v)
}
end
# A present standard failsafe for pretty printing any given Object
def pp_object(obj)
object_address_group(obj) {
seplist(obj.pretty_print_instance_variables, lambda { text ',' }) {|v|
breakable
v = v.to_s if Symbol === v
text v
text '='
group(1) {
breakable ''
pp(obj.instance_eval(v))
}
}
}
end
# A pretty print for a Hash
def pp_hash(obj)
group(1, '{', '}') {
seplist(obj, nil, :each_pair) {|k, v|
group {
pp k
text '=>'
group(1) {
breakable ''
pp v
}
}
}
}
end
end
include PPMethods
class SingleLine < PrettyPrint::SingleLine # :nodoc:
include PPMethods
end
module ObjectMixin # :nodoc:
# 1. specific pretty_print
# 2. specific inspect
# 3. generic pretty_print
# A default pretty printing method for general objects.
# It calls #pretty_print_instance_variables to list instance variables.
#
# If +self+ has a customized (redefined) #inspect method,
# the result of self.inspect is used but it obviously has no
# line break hints.
#
# This module provides predefined #pretty_print methods for some of
# the most commonly used built-in classes for convenience.
def pretty_print(q)
umethod_method = Object.instance_method(:method)
begin
inspect_method = umethod_method.bind_call(self, :inspect)
rescue NameError
end
if inspect_method && inspect_method.owner != Kernel
q.text self.inspect
elsif !inspect_method && self.respond_to?(:inspect)
q.text self.inspect
else
q.pp_object(self)
end
end
# A default pretty printing method for general objects that are
# detected as part of a cycle.
def pretty_print_cycle(q)
q.object_address_group(self) {
q.breakable
q.text '...'
}
end
# Returns a sorted array of instance variable names.
#
# This method should return an array of names of instance variables as symbols or strings as:
# +[:@a, :@b]+.
def pretty_print_instance_variables
instance_variables.sort
end
# Is #inspect implementation using #pretty_print.
# If you implement #pretty_print, it can be used as follows.
#
# alias inspect pretty_print_inspect
#
# However, doing this requires that every class that #inspect is called on
# implement #pretty_print, or a RuntimeError will be raised.
def pretty_print_inspect
if Object.instance_method(:method).bind_call(self, :pretty_print).owner == PP::ObjectMixin
raise "pretty_print is not overridden for #{self.class}"
end
PP.singleline_pp(self, ''.dup)
end
end
end
class Array # :nodoc:
def pretty_print(q) # :nodoc:
q.group(1, '[', ']') {
q.seplist(self) {|v|
q.pp v
}
}
end
def pretty_print_cycle(q) # :nodoc:
q.text(empty? ? '[]' : '[...]')
end
end
class Hash # :nodoc:
def pretty_print(q) # :nodoc:
q.pp_hash self
end
def pretty_print_cycle(q) # :nodoc:
q.text(empty? ? '{}' : '{...}')
end
end
class << ENV # :nodoc:
def pretty_print(q) # :nodoc:
h = {}
ENV.keys.sort.each {|k|
h[k] = ENV[k]
}
q.pp_hash h
end
end
class Struct # :nodoc:
def pretty_print(q) # :nodoc:
q.group(1, sprintf("#<struct %s", PP.mcall(self, Kernel, :class).name), '>') {
q.seplist(PP.mcall(self, Struct, :members), lambda { q.text "," }) {|member|
q.breakable
q.text member.to_s
q.text '='
q.group(1) {
q.breakable ''
q.pp self[member]
}
}
}
end
def pretty_print_cycle(q) # :nodoc:
q.text sprintf("#<struct %s:...>", PP.mcall(self, Kernel, :class).name)
end
end
class Data # :nodoc:
def pretty_print(q) # :nodoc:
q.group(1, sprintf("#<data %s", PP.mcall(self, Kernel, :class).name), '>') {
q.seplist(PP.mcall(self, Data, :members), lambda { q.text "," }) {|member|
q.breakable
q.text member.to_s
q.text '='
q.group(1) {
q.breakable ''
q.pp public_send(member)
}
}
}
end
def pretty_print_cycle(q) # :nodoc:
q.text sprintf("#<data %s:...>", PP.mcall(self, Kernel, :class).name)
end
end if "3.2" <= RUBY_VERSION
class Range # :nodoc:
def pretty_print(q) # :nodoc:
q.pp self.begin
q.breakable ''
q.text(self.exclude_end? ? '...' : '..')
q.breakable ''
q.pp self.end if self.end
end
end
class String # :nodoc:
def pretty_print(q) # :nodoc:
lines = self.lines
if lines.size > 1
q.group(0, '', '') do
q.seplist(lines, lambda { q.text ' +'; q.breakable }) do |v|
q.pp v
end
end
else
q.text inspect
end
end
end
class File < IO # :nodoc:
class Stat # :nodoc:
def pretty_print(q) # :nodoc:
require 'etc'
q.object_group(self) {
q.breakable
q.text sprintf("dev=0x%x", self.dev); q.comma_breakable
q.text "ino="; q.pp self.ino; q.comma_breakable
q.group {
m = self.mode
q.text sprintf("mode=0%o", m)
q.breakable
q.text sprintf("(%s %c%c%c%c%c%c%c%c%c)",
self.ftype,
(m & 0400 == 0 ? ?- : ?r),
(m & 0200 == 0 ? ?- : ?w),
(m & 0100 == 0 ? (m & 04000 == 0 ? ?- : ?S) :
(m & 04000 == 0 ? ?x : ?s)),
(m & 0040 == 0 ? ?- : ?r),
(m & 0020 == 0 ? ?- : ?w),
(m & 0010 == 0 ? (m & 02000 == 0 ? ?- : ?S) :
(m & 02000 == 0 ? ?x : ?s)),
(m & 0004 == 0 ? ?- : ?r),
(m & 0002 == 0 ? ?- : ?w),
(m & 0001 == 0 ? (m & 01000 == 0 ? ?- : ?T) :
(m & 01000 == 0 ? ?x : ?t)))
}
q.comma_breakable
q.text "nlink="; q.pp self.nlink; q.comma_breakable
q.group {
q.text "uid="; q.pp self.uid
begin
pw = Etc.getpwuid(self.uid)
rescue ArgumentError
end
if pw
q.breakable; q.text "(#{pw.name})"
end
}
q.comma_breakable
q.group {
q.text "gid="; q.pp self.gid
begin
gr = Etc.getgrgid(self.gid)
rescue ArgumentError
end
if gr
q.breakable; q.text "(#{gr.name})"
end
}
q.comma_breakable
q.group {
q.text sprintf("rdev=0x%x", self.rdev)
if self.rdev_major && self.rdev_minor
q.breakable
q.text sprintf('(%d, %d)', self.rdev_major, self.rdev_minor)
end
}
q.comma_breakable
q.text "size="; q.pp self.size; q.comma_breakable
q.text "blksize="; q.pp self.blksize; q.comma_breakable
q.text "blocks="; q.pp self.blocks; q.comma_breakable
q.group {
t = self.atime
q.text "atime="; q.pp t
q.breakable; q.text "(#{t.tv_sec})"
}
q.comma_breakable
q.group {
t = self.mtime
q.text "mtime="; q.pp t
q.breakable; q.text "(#{t.tv_sec})"
}
q.comma_breakable
q.group {
t = self.ctime
q.text "ctime="; q.pp t
q.breakable; q.text "(#{t.tv_sec})"
}
}
end
end
end
class MatchData # :nodoc:
def pretty_print(q) # :nodoc:
nc = []
self.regexp.named_captures.each {|name, indexes|
indexes.each {|i| nc[i] = name }
}
q.object_group(self) {
q.breakable
q.seplist(0...self.size, lambda { q.breakable }) {|i|
if i == 0
q.pp self[i]
else
if nc[i]
q.text nc[i]
else
q.pp i
end
q.text ':'
q.pp self[i]
end
}
}
end
end
if defined?(RubyVM::AbstractSyntaxTree)
class RubyVM::AbstractSyntaxTree::Node
def pretty_print_children(q, names = [])
children.zip(names) do |c, n|
if n
q.breakable
q.text "#{n}:"
end
q.group(2) do
q.breakable
q.pp c
end
end
end
def pretty_print(q)
q.group(1, "(#{type}@#{first_lineno}:#{first_column}-#{last_lineno}:#{last_column}", ")") {
case type
when :SCOPE
pretty_print_children(q, %w"tbl args body")
when :ARGS
pretty_print_children(q, %w[pre_num pre_init opt first_post post_num post_init rest kw kwrest block])
when :DEFN
pretty_print_children(q, %w[mid body])
when :ARYPTN
pretty_print_children(q, %w[const pre rest post])
when :HSHPTN
pretty_print_children(q, %w[const kw kwrest])
else
pretty_print_children(q)
end
}
end
end
end
class Object < BasicObject # :nodoc:
include PP::ObjectMixin
end
[Numeric, Symbol, FalseClass, TrueClass, NilClass, Module].each {|c|
c.class_eval {
def pretty_print_cycle(q)
q.text inspect
end
}
}
[Numeric, FalseClass, TrueClass, Module].each {|c|
c.class_eval {
def pretty_print(q)
q.text inspect
end
}
}
module Kernel
# Returns a pretty printed object as a string.
#
# See the PP module for more information.
def pretty_inspect
PP.pp(self, ''.dup)
end
# prints arguments in pretty form.
#
# pp returns argument(s).
def pp(*objs)
objs.each {|obj|
PP.pp(obj)
}
objs.size <= 1 ? objs.first : objs
end
module_function :pp
end
share/ruby/erb.rb 0000644 00000035043 15173517736 0007750 0 ustar 00 # -*- coding: us-ascii -*-
# frozen_string_literal: true
# = ERB -- Ruby Templating
#
# Author:: Masatoshi SEKI
# Documentation:: James Edward Gray II, Gavin Sinclair, and Simon Chiang
#
# See ERB for primary documentation and ERB::Util for a couple of utility
# routines.
#
# Copyright (c) 1999-2000,2002,2003 Masatoshi SEKI
#
# You can redistribute it and/or modify it under the same terms as Ruby.
require 'cgi/util'
require 'erb/version'
require 'erb/compiler'
require 'erb/def_method'
require 'erb/util'
#
# = 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)
#
# <em>Prints:</em> 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 %> (`<% #` doesn't work. Don't use Ruby comments.)
# % 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 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
#
# <em>Prints:</em> \_\_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
# <tt>%q{...}</tt> 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
#
# <i>Generates:</i>
#
# 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 <tt>.rhtml</tt> 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)
#
# <i>Generates (some blank lines removed):</i>
#
# <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.
# For example, RDoc, distributed with Ruby, uses its own template engine, which
# can be reused elsewhere.
#
# Other popular engines could be found in the corresponding
# {Category}[https://www.ruby-toolbox.com/categories/template_engines] of
# The Ruby Toolbox.
#
class ERB
Revision = '$Date:: $' # :nodoc: #'
deprecate_constant :Revision
# Returns revision information for the erb.rb module.
def self.version
VERSION
end
#
# 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 _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', trim_mode: "", eoutvar: "@product").result b
# <%= PRODUCT[:name] %>
# <%= PRODUCT[:desc] %>
# END_PRODUCT
# ERB.new(<<~'END_PRICE', 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(str, safe_level=NOT_GIVEN, legacy_trim_mode=NOT_GIVEN, legacy_eoutvar=NOT_GIVEN, trim_mode: nil, eoutvar: '_erbout')
# Complex initializer for $SAFE deprecation at [Feature #14256]. Use keyword arguments to pass trim_mode or eoutvar.
if safe_level != NOT_GIVEN
warn 'Passing safe_level with the 2nd argument of ERB.new is deprecated. Do not use it, and specify other arguments as keyword arguments.', uplevel: 1
end
if legacy_trim_mode != NOT_GIVEN
warn 'Passing trim_mode with the 3rd argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, trim_mode: ...) instead.', uplevel: 1
trim_mode = legacy_trim_mode
end
if legacy_eoutvar != NOT_GIVEN
warn 'Passing eoutvar with the 4th argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, eoutvar: ...) instead.', uplevel: 1
eoutvar = legacy_eoutvar
end
compiler = make_compiler(trim_mode)
set_eoutvar(compiler, eoutvar)
@src, @encoding, @frozen_string = *compiler.compile(str)
@filename = nil
@lineno = 0
@_init = self.class.singleton_class
end
NOT_GIVEN = Object.new
private_constant :NOT_GIVEN
##
# Creates a new compiler for ERB. See ERB::Compiler.new for details
def make_compiler(trim_mode)
ERB::Compiler.new(trim_mode)
end
# The Ruby code generated by ERB
attr_reader :src
# The encoding to eval
attr_reader :encoding
# The optional _filename_ argument passed to Kernel#eval when the ERB code
# is run
attr_accessor :filename
# The optional _lineno_ argument passed to Kernel#eval when the ERB code
# is run
attr_accessor :lineno
#
# Sets optional filename and line number that will be used in ERB code
# evaluation and error reporting. See also #filename= and #lineno=
#
# erb = ERB.new('<%= some_x %>')
# erb.render
# # undefined local variable or method `some_x'
# # from (erb):1
#
# erb.location = ['file.erb', 3]
# # All subsequent error reporting would use new location
# erb.render
# # undefined local variable or method `some_x'
# # from file.erb:4
#
def location=((filename, lineno))
@filename = filename
@lineno = lineno if lineno
end
#
# Can be used to set _eoutvar_ as described in ERB::new. It's probably
# easier to just use the constructor though, since calling this method
# requires the setup of an ERB _compiler_ object.
#
def set_eoutvar(compiler, eoutvar = '_erbout')
compiler.put_cmd = "#{eoutvar}.<<"
compiler.insert_cmd = "#{eoutvar}.<<"
compiler.pre_cmd = ["#{eoutvar} = +''"]
compiler.post_cmd = [eoutvar]
end
# Generate results and print them. (see ERB#result)
def run(b=new_toplevel)
print self.result(b)
end
#
# 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(b=new_toplevel)
unless @_init.equal?(self.class.singleton_class)
raise ArgumentError, "not initialized"
end
eval(@src, b, (@filename || '(erb)'), @lineno)
end
# Render a template on a new toplevel binding with local variables specified
# by a Hash object.
def result_with_hash(hash)
b = new_toplevel(hash.keys)
hash.each_pair do |key, value|
b.local_variable_set(key, value)
end
result(b)
end
##
# Returns a new binding each time *near* TOPLEVEL_BINDING for runs that do
# not specify a binding.
def new_toplevel(vars = nil)
b = TOPLEVEL_BINDING
if vars
vars = vars.select {|v| b.local_variable_defined?(v)}
unless vars.empty?
return b.eval("tap {|;#{vars.join(',')}| break binding}")
end
end
b.dup
end
private :new_toplevel
# 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(mod, methodname, fname='(ERB)')
src = self.src.sub(/^(?!#|$)/) {"def #{methodname}\n"} << "\nend\n"
mod.module_eval do
eval(src, binding, fname, -1)
end
end
# 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(methodname='erb')
mod = Module.new
def_method(mod, methodname, @filename || '(ERB)')
mod
end
# 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(superklass=Object, methodname='result')
cls = Class.new(superklass)
def_method(cls, methodname, @filename || '(ERB)')
cls
end
end
share/gems/gems/bigdecimal-3.1.5/lib/bigdecimal 0000755 00000000000 15173517736 0015037 0 ustar 00 share/ruby/yaml.rb 0000644 00000004210 15173517736 0010132 0 ustar 00 # frozen_string_literal: false
begin
require 'psych'
rescue LoadError
case RUBY_ENGINE
when 'jruby'
warn "The Psych YAML extension failed to load.\n" \
"Check your env for conflicting versions of SnakeYAML\n" \
"See https://github.com/jruby/jruby/wiki/FAQs#why-does-the-psych-yaml-extension-fail-to-load-in-my-environment",
uplevel: 1
else
warn "It seems your ruby installation is missing psych (for YAML output).\n" \
"To eliminate this warning, please install libyaml and reinstall your ruby.\n",
uplevel: 1
end
raise
end
YAML = Psych # :nodoc:
# YAML Ain't Markup Language
#
# This module provides a Ruby interface for data serialization in YAML format.
#
# The YAML module is an alias of Psych, the YAML engine for Ruby.
#
# == Usage
#
# Working with YAML can be very simple, for example:
#
# require 'yaml'
# # Parse a YAML string
# YAML.load("--- foo") #=> "foo"
#
# # Emit some YAML
# YAML.dump("foo") # => "--- foo\n...\n"
# { :a => 'b'}.to_yaml # => "---\n:a: b\n"
#
# As the implementation is provided by the Psych library, detailed documentation
# can be found in that library's docs (also part of standard library).
#
# == Security
#
# Do not use YAML to load untrusted data. Doing so is unsafe and could allow
# malicious input to execute arbitrary code inside your application. Please see
# doc/security.rdoc for more information.
#
# == History
#
# Syck was the original YAML implementation in Ruby's standard library
# developed by why the lucky stiff.
#
# You can still use Syck, if you prefer, for parsing and emitting YAML, but you
# must install the 'syck' gem now in order to use it.
#
# In older Ruby versions, ie. <= 1.9, Syck is still provided, however it was
# completely removed with the release of Ruby 2.0.0.
#
# == More info
#
# For more advanced details on the implementation see Psych, and also check out
# http://yaml.org for spec details and other helpful information.
#
# Psych is maintained by Aaron Patterson on github: https://github.com/ruby/psych
#
# Syck can also be found on github: https://github.com/ruby/syck
module YAML
LOADER_VERSION = "0.3.0"
end
share/ruby/bigdecimal.rb 0000644 00000000202 15173517736 0011245 0 ustar 00 if RUBY_ENGINE == 'jruby'
JRuby::Util.load_ext("org.jruby.ext.bigdecimal.BigDecimalLibrary")
else
require 'bigdecimal.so'
end
share/ruby/drb.rb 0000644 00000000062 15173517736 0007740 0 ustar 00 # frozen_string_literal: false
require 'drb/drb'
share/ruby/getoptlong.rb 0000644 00000050417 15173517736 0011364 0 ustar 00 # frozen_string_literal: true
#
# GetoptLong for Ruby
#
# Copyright (C) 1998, 1999, 2000 Motoyuki Kasahara.
#
# You may redistribute and/or modify this library under the same license
# terms as Ruby.
# \Class \GetoptLong provides parsing both for options
# and for regular arguments.
#
# Using \GetoptLong, you can define options for your program.
# The program can then capture and respond to whatever options
# are included in the command that executes the program.
#
# A simple example: file <tt>simple.rb</tt>:
#
# :include: ../sample/getoptlong/simple.rb
#
# If you are somewhat familiar with options,
# you may want to skip to this
# {full example}[#class-GetoptLong-label-Full+Example].
#
# == Options
#
# A \GetoptLong option has:
#
# - A string <em>option name</em>.
# - Zero or more string <em>aliases</em> for the name.
# - An <em>option type</em>.
#
# Options may be defined by calling singleton method GetoptLong.new,
# which returns a new \GetoptLong object.
# Options may then be processed by calling other methods
# such as GetoptLong#each.
#
# === Option Name and Aliases
#
# In the array that defines an option,
# the first element is the string option name.
# Often the name takes the 'long' form, beginning with two hyphens.
#
# The option name may have any number of aliases,
# which are defined by additional string elements.
#
# The name and each alias must be of one of two forms:
#
# - Two hyphens, followed by one or more letters.
# - One hyphen, followed by a single letter.
#
# File <tt>aliases.rb</tt>:
#
# :include: ../sample/getoptlong/aliases.rb
#
# An option may be cited by its name,
# or by any of its aliases;
# the parsed option always reports the name, not an alias:
#
# $ ruby aliases.rb -a -p --xxx --aaa -x
#
# Output:
#
# ["--xxx", ""]
# ["--xxx", ""]
# ["--xxx", ""]
# ["--xxx", ""]
# ["--xxx", ""]
#
#
# An option may also be cited by an abbreviation of its name or any alias,
# as long as that abbreviation is unique among the options.
#
# File <tt>abbrev.rb</tt>:
#
# :include: ../sample/getoptlong/abbrev.rb
#
# Command line:
#
# $ ruby abbrev.rb --xxx --xx --xyz --xy
#
# Output:
#
# ["--xxx", ""]
# ["--xxx", ""]
# ["--xyz", ""]
# ["--xyz", ""]
#
# This command line raises GetoptLong::AmbiguousOption:
#
# $ ruby abbrev.rb --x
#
# === Repetition
#
# An option may be cited more than once:
#
# $ ruby abbrev.rb --xxx --xyz --xxx --xyz
#
# Output:
#
# ["--xxx", ""]
# ["--xyz", ""]
# ["--xxx", ""]
# ["--xyz", ""]
#
# === Treating Remaining Options as Arguments
#
# A option-like token that appears
# anywhere after the token <tt>--</tt> is treated as an ordinary argument,
# and is not processed as an option:
#
# $ ruby abbrev.rb --xxx --xyz -- --xxx --xyz
#
# Output:
#
# ["--xxx", ""]
# ["--xyz", ""]
#
# === Option Types
#
# Each option definition includes an option type,
# which controls whether the option takes an argument.
#
# File <tt>types.rb</tt>:
#
# :include: ../sample/getoptlong/types.rb
#
# Note that an option type has to do with the <em>option argument</em>
# (whether it is required, optional, or forbidden),
# not with whether the option itself is required.
#
# ==== Option with Required Argument
#
# An option of type <tt>GetoptLong::REQUIRED_ARGUMENT</tt>
# must be followed by an argument, which is associated with that option:
#
# $ ruby types.rb --xxx foo
#
# Output:
#
# ["--xxx", "foo"]
#
# If the option is not last, its argument is whatever follows it
# (even if the argument looks like another option):
#
# $ ruby types.rb --xxx --yyy
#
# Output:
#
# ["--xxx", "--yyy"]
#
# If the option is last, an exception is raised:
#
# $ ruby types.rb
# # Raises GetoptLong::MissingArgument
#
# ==== Option with Optional Argument
#
# An option of type <tt>GetoptLong::OPTIONAL_ARGUMENT</tt>
# may be followed by an argument, which if given is associated with that option.
#
# If the option is last, it does not have an argument:
#
# $ ruby types.rb --yyy
#
# Output:
#
# ["--yyy", ""]
#
# If the option is followed by another option, it does not have an argument:
#
# $ ruby types.rb --yyy --zzz
#
# Output:
#
# ["--yyy", ""]
# ["--zzz", ""]
#
# Otherwise the option is followed by its argument, which is associated
# with that option:
#
# $ ruby types.rb --yyy foo
#
# Output:
#
# ["--yyy", "foo"]
#
# ==== Option with No Argument
#
# An option of type <tt>GetoptLong::NO_ARGUMENT</tt> takes no argument:
#
# ruby types.rb --zzz foo
#
# Output:
#
# ["--zzz", ""]
#
# === ARGV
#
# You can process options either with method #each and a block,
# or with method #get.
#
# During processing, each found option is removed, along with its argument
# if there is one.
# After processing, each remaining element was neither an option
# nor the argument for an option.
#
# File <tt>argv.rb</tt>:
#
# :include: ../sample/getoptlong/argv.rb
#
# Command line:
#
# $ ruby argv.rb --xxx Foo --yyy Bar Baz --zzz Bat Bam
#
# Output:
#
# Original ARGV: ["--xxx", "Foo", "--yyy", "Bar", "Baz", "--zzz", "Bat", "Bam"]
# ["--xxx", "Foo"]
# ["--yyy", "Bar"]
# ["--zzz", ""]
# Remaining ARGV: ["Baz", "Bat", "Bam"]
#
# === Ordering
#
# There are three settings that control the way the options
# are interpreted:
#
# - +PERMUTE+.
# - +REQUIRE_ORDER+.
# - +RETURN_IN_ORDER+.
#
# The initial setting for a new \GetoptLong object is +REQUIRE_ORDER+
# if environment variable +POSIXLY_CORRECT+ is defined, +PERMUTE+ otherwise.
#
# ==== PERMUTE Ordering
#
# In the +PERMUTE+ ordering, options and other, non-option,
# arguments may appear in any order and any mixture.
#
# File <tt>permute.rb</tt>:
#
# :include: ../sample/getoptlong/permute.rb
#
# Command line:
#
# $ ruby permute.rb Foo --zzz Bar --xxx Baz --yyy Bat Bam --xxx Bag Bah
#
# Output:
#
# Original ARGV: ["Foo", "--zzz", "Bar", "--xxx", "Baz", "--yyy", "Bat", "Bam", "--xxx", "Bag", "Bah"]
# ["--zzz", ""]
# ["--xxx", "Baz"]
# ["--yyy", "Bat"]
# ["--xxx", "Bag"]
# Remaining ARGV: ["Foo", "Bar", "Bam", "Bah"]
#
# ==== REQUIRE_ORDER Ordering
#
# In the +REQUIRE_ORDER+ ordering, all options precede all non-options;
# that is, each word after the first non-option word
# is treated as a non-option word (even if it begins with a hyphen).
#
# File <tt>require_order.rb</tt>:
#
# :include: ../sample/getoptlong/require_order.rb
#
# Command line:
#
# $ ruby require_order.rb --xxx Foo Bar --xxx Baz --yyy Bat -zzz
#
# Output:
#
# Original ARGV: ["--xxx", "Foo", "Bar", "--xxx", "Baz", "--yyy", "Bat", "-zzz"]
# ["--xxx", "Foo"]
# Remaining ARGV: ["Bar", "--xxx", "Baz", "--yyy", "Bat", "-zzz"]
#
# ==== RETURN_IN_ORDER Ordering
#
# In the +RETURN_IN_ORDER+ ordering, every word is treated as an option.
# A word that begins with a hyphen (or two) is treated in the usual way;
# a word +word+ that does not so begin is treated as an option
# whose name is an empty string, and whose value is +word+.
#
# File <tt>return_in_order.rb</tt>:
#
# :include: ../sample/getoptlong/return_in_order.rb
#
# Command line:
#
# $ ruby return_in_order.rb Foo --xxx Bar Baz --zzz Bat Bam
#
# Output:
#
# Original ARGV: ["Foo", "--xxx", "Bar", "Baz", "--zzz", "Bat", "Bam"]
# ["", "Foo"]
# ["--xxx", "Bar"]
# ["", "Baz"]
# ["--zzz", ""]
# ["", "Bat"]
# ["", "Bam"]
# Remaining ARGV: []
#
# === Full Example
#
# File <tt>fibonacci.rb</tt>:
#
# :include: ../sample/getoptlong/fibonacci.rb
#
# Command line:
#
# $ ruby fibonacci.rb
#
# Output:
#
# Option --number is required.
# Usage:
#
# -n n, --number n:
# Compute Fibonacci number for n.
# -v [boolean], --verbose [boolean]:
# Show intermediate results; default is 'false'.
# -h, --help:
# Show this help.
#
# Command line:
#
# $ ruby fibonacci.rb --number
#
# Raises GetoptLong::MissingArgument:
#
# fibonacci.rb: option `--number' requires an argument
#
# Command line:
#
# $ ruby fibonacci.rb --number 6
#
# Output:
#
# 8
#
# Command line:
#
# $ ruby fibonacci.rb --number 6 --verbose
#
# Output:
# 1
# 2
# 3
# 5
# 8
#
# Command line:
#
# $ ruby fibonacci.rb --number 6 --verbose yes
#
# Output:
#
# --verbose argument must be true or false
# Usage:
#
# -n n, --number n:
# Compute Fibonacci number for n.
# -v [boolean], --verbose [boolean]:
# Show intermediate results; default is 'false'.
# -h, --help:
# Show this help.
#
class GetoptLong
# Version.
VERSION = "0.2.1"
#
# Orderings.
#
ORDERINGS = [REQUIRE_ORDER = 0, PERMUTE = 1, RETURN_IN_ORDER = 2]
#
# Argument flags.
#
ARGUMENT_FLAGS = [NO_ARGUMENT = 0, REQUIRED_ARGUMENT = 1,
OPTIONAL_ARGUMENT = 2]
#
# Status codes.
#
STATUS_YET, STATUS_STARTED, STATUS_TERMINATED = 0, 1, 2
#
# Error types.
#
class Error < StandardError; end
class AmbiguousOption < Error; end
class NeedlessArgument < Error; end
class MissingArgument < Error; end
class InvalidOption < Error; end
#
# Returns a new \GetoptLong object based on the given +arguments+.
# See {Options}[#class-GetoptLong-label-Options].
#
# Example:
#
# :include: ../sample/getoptlong/simple.rb
#
# Raises an exception if:
#
# - Any of +arguments+ is not an array.
# - Any option name or alias is not a string.
# - Any option type is invalid.
#
def initialize(*arguments)
#
# Current ordering.
#
if ENV.include?('POSIXLY_CORRECT')
@ordering = REQUIRE_ORDER
else
@ordering = PERMUTE
end
#
# Hash table of option names.
# Keys of the table are option names, and their values are canonical
# names of the options.
#
@canonical_names = Hash.new
#
# Hash table of argument flags.
# Keys of the table are option names, and their values are argument
# flags of the options.
#
@argument_flags = Hash.new
#
# Whether error messages are output to $stderr.
#
@quiet = false
#
# Status code.
#
@status = STATUS_YET
#
# Error code.
#
@error = nil
#
# Error message.
#
@error_message = nil
#
# Rest of catenated short options.
#
@rest_singles = ''
#
# List of non-option-arguments.
# Append them to ARGV when option processing is terminated.
#
@non_option_arguments = Array.new
if 0 < arguments.length
set_options(*arguments)
end
end
# Sets the ordering; see {Ordering}[#class-GetoptLong-label-Ordering];
# returns the new ordering.
#
# If the given +ordering+ is +PERMUTE+ and environment variable
# +POSIXLY_CORRECT+ is defined, sets the ordering to +REQUIRE_ORDER+;
# otherwise sets the ordering to +ordering+:
#
# options = GetoptLong.new
# options.ordering == GetoptLong::PERMUTE # => true
# options.ordering = GetoptLong::RETURN_IN_ORDER
# options.ordering == GetoptLong::RETURN_IN_ORDER # => true
# ENV['POSIXLY_CORRECT'] = 'true'
# options.ordering = GetoptLong::PERMUTE
# options.ordering == GetoptLong::REQUIRE_ORDER # => true
#
# Raises an exception if +ordering+ is invalid.
#
def ordering=(ordering)
#
# The method is failed if option processing has already started.
#
if @status != STATUS_YET
set_error(ArgumentError, "argument error")
raise RuntimeError,
"invoke ordering=, but option processing has already started"
end
#
# Check ordering.
#
if !ORDERINGS.include?(ordering)
raise ArgumentError, "invalid ordering `#{ordering}'"
end
if ordering == PERMUTE && ENV.include?('POSIXLY_CORRECT')
@ordering = REQUIRE_ORDER
else
@ordering = ordering
end
end
#
# Returns the ordering setting.
#
attr_reader :ordering
#
# Replaces existing options with those given by +arguments+,
# which have the same form as the arguments to ::new;
# returns +self+.
#
# Raises an exception if option processing has begun.
#
def set_options(*arguments)
#
# The method is failed if option processing has already started.
#
if @status != STATUS_YET
raise RuntimeError,
"invoke set_options, but option processing has already started"
end
#
# Clear tables of option names and argument flags.
#
@canonical_names.clear
@argument_flags.clear
arguments.each do |arg|
if !arg.is_a?(Array)
raise ArgumentError, "the option list contains non-Array argument"
end
#
# Find an argument flag and it set to `argument_flag'.
#
argument_flag = nil
arg.each do |i|
if ARGUMENT_FLAGS.include?(i)
if argument_flag != nil
raise ArgumentError, "too many argument-flags"
end
argument_flag = i
end
end
raise ArgumentError, "no argument-flag" if argument_flag == nil
canonical_name = nil
arg.each do |i|
#
# Check an option name.
#
next if i == argument_flag
begin
if !i.is_a?(String) || i !~ /\A-([^-]|-.+)\z/
raise ArgumentError, "an invalid option `#{i}'"
end
if (@canonical_names.include?(i))
raise ArgumentError, "option redefined `#{i}'"
end
rescue
@canonical_names.clear
@argument_flags.clear
raise
end
#
# Register the option (`i') to the `@canonical_names' and
# `@canonical_names' Hashes.
#
if canonical_name == nil
canonical_name = i
end
@canonical_names[i] = canonical_name
@argument_flags[i] = argument_flag
end
raise ArgumentError, "no option name" if canonical_name == nil
end
return self
end
#
# Sets quiet mode and returns the given argument:
#
# - When +false+ or +nil+, error messages are written to <tt>$stdout</tt>.
# - Otherwise, error messages are not written.
#
attr_writer :quiet
#
# Returns the quiet mode setting.
#
attr_reader :quiet
alias quiet? quiet
#
# Terminate option processing;
# returns +nil+ if processing has already terminated;
# otherwise returns +self+.
#
def terminate
return nil if @status == STATUS_TERMINATED
raise RuntimeError, "an error has occurred" if @error != nil
@status = STATUS_TERMINATED
@non_option_arguments.reverse_each do |argument|
ARGV.unshift(argument)
end
@canonical_names = nil
@argument_flags = nil
@rest_singles = nil
@non_option_arguments = nil
return self
end
#
# Returns +true+ if option processing has terminated, +false+ otherwise.
#
def terminated?
return @status == STATUS_TERMINATED
end
#
# \Set an error (a protected method).
#
def set_error(type, message)
$stderr.print("#{$0}: #{message}\n") if !@quiet
@error = type
@error_message = message
@canonical_names = nil
@argument_flags = nil
@rest_singles = nil
@non_option_arguments = nil
raise type, message
end
protected :set_error
#
# Returns whether option processing has failed.
#
attr_reader :error
alias error? error
# Return the appropriate error message in POSIX-defined format.
# If no error has occurred, returns +nil+.
#
def error_message
return @error_message
end
#
# Returns the next option as a 2-element array containing:
#
# - The option name (the name itself, not an alias).
# - The option value.
#
# Returns +nil+ if there are no more options.
#
def get
option_name, option_argument = nil, ''
#
# Check status.
#
return nil if @error != nil
case @status
when STATUS_YET
@status = STATUS_STARTED
when STATUS_TERMINATED
return nil
end
#
# Get next option argument.
#
if 0 < @rest_singles.length
argument = '-' + @rest_singles
elsif (ARGV.length == 0)
terminate
return nil
elsif @ordering == PERMUTE
while 0 < ARGV.length && ARGV[0] !~ /\A-./
@non_option_arguments.push(ARGV.shift)
end
if ARGV.length == 0
terminate
return nil
end
argument = ARGV.shift
elsif @ordering == REQUIRE_ORDER
if (ARGV[0] !~ /\A-./)
terminate
return nil
end
argument = ARGV.shift
else
argument = ARGV.shift
end
#
# Check the special argument `--'.
# `--' indicates the end of the option list.
#
if argument == '--' && @rest_singles.length == 0
terminate
return nil
end
#
# Check for long and short options.
#
if argument =~ /\A(--[^=]+)/ && @rest_singles.length == 0
#
# This is a long style option, which start with `--'.
#
pattern = $1
if @canonical_names.include?(pattern)
option_name = pattern
else
#
# The option `option_name' is not registered in `@canonical_names'.
# It may be an abbreviated.
#
matches = []
@canonical_names.each_key do |key|
if key.index(pattern) == 0
option_name = key
matches << key
end
end
if 2 <= matches.length
set_error(AmbiguousOption, "option `#{argument}' is ambiguous between #{matches.join(', ')}")
elsif matches.length == 0
set_error(InvalidOption, "unrecognized option `#{argument}'")
end
end
#
# Check an argument to the option.
#
if @argument_flags[option_name] == REQUIRED_ARGUMENT
if argument =~ /=(.*)/m
option_argument = $1
elsif 0 < ARGV.length
option_argument = ARGV.shift
else
set_error(MissingArgument,
"option `#{argument}' requires an argument")
end
elsif @argument_flags[option_name] == OPTIONAL_ARGUMENT
if argument =~ /=(.*)/m
option_argument = $1
elsif 0 < ARGV.length && ARGV[0] !~ /\A-./
option_argument = ARGV.shift
else
option_argument = ''
end
elsif argument =~ /=(.*)/m
set_error(NeedlessArgument,
"option `#{option_name}' doesn't allow an argument")
end
elsif argument =~ /\A(-(.))(.*)/m
#
# This is a short style option, which start with `-' (not `--').
# Short options may be catenated (e.g. `-l -g' is equivalent to
# `-lg').
#
option_name, ch, @rest_singles = $1, $2, $3
if @canonical_names.include?(option_name)
#
# The option `option_name' is found in `@canonical_names'.
# Check its argument.
#
if @argument_flags[option_name] == REQUIRED_ARGUMENT
if 0 < @rest_singles.length
option_argument = @rest_singles
@rest_singles = ''
elsif 0 < ARGV.length
option_argument = ARGV.shift
else
# 1003.2 specifies the format of this message.
set_error(MissingArgument, "option requires an argument -- #{ch}")
end
elsif @argument_flags[option_name] == OPTIONAL_ARGUMENT
if 0 < @rest_singles.length
option_argument = @rest_singles
@rest_singles = ''
elsif 0 < ARGV.length && ARGV[0] !~ /\A-./
option_argument = ARGV.shift
else
option_argument = ''
end
end
else
#
# This is an invalid option.
# 1003.2 specifies the format of this message.
#
if ENV.include?('POSIXLY_CORRECT')
set_error(InvalidOption, "invalid option -- #{ch}")
else
set_error(InvalidOption, "invalid option -- #{ch}")
end
end
else
#
# This is a non-option argument.
# Only RETURN_IN_ORDER fell into here.
#
return '', argument
end
return @canonical_names[option_name], option_argument
end
alias get_option get
#
# Calls the given block with each option;
# each option is a 2-element array containing:
#
# - The option name (the name itself, not an alias).
# - The option value.
#
# Example:
#
# :include: ../sample/getoptlong/each.rb
#
# Command line:
#
# ruby each.rb -xxx Foo -x Bar --yyy Baz -y Bat --zzz
#
# Output:
#
# Original ARGV: ["-xxx", "Foo", "-x", "Bar", "--yyy", "Baz", "-y", "Bat", "--zzz"]
# ["--xxx", "xx"]
# ["--xxx", "Bar"]
# ["--yyy", "Baz"]
# ["--yyy", "Bat"]
# ["--zzz", ""]
# Remaining ARGV: ["Foo"]
#
def each
loop do
option_name, option_argument = get_option
break if option_name == nil
yield option_name, option_argument
end
end
alias each_option each
end
share/ruby/resolv-replace.rb 0000644 00000003415 15173517736 0012121 0 ustar 00 # frozen_string_literal: true
require 'socket'
require 'resolv'
class << IPSocket
# :stopdoc:
alias original_resolv_getaddress getaddress
# :startdoc:
def getaddress(host)
begin
return Resolv.getaddress(host).to_s
rescue Resolv::ResolvError
raise SocketError, "Hostname not known: #{host}"
end
end
end
class TCPSocket < IPSocket
# :stopdoc:
alias original_resolv_initialize initialize
# :startdoc:
def initialize(host, serv, *rest)
rest[0] = IPSocket.getaddress(rest[0]) if rest[0]
original_resolv_initialize(IPSocket.getaddress(host), serv, *rest)
end
end
class UDPSocket < IPSocket
# :stopdoc:
alias original_resolv_bind bind
# :startdoc:
def bind(host, port)
host = IPSocket.getaddress(host) if host != ""
original_resolv_bind(host, port)
end
# :stopdoc:
alias original_resolv_connect connect
# :startdoc:
def connect(host, port)
original_resolv_connect(IPSocket.getaddress(host), port)
end
# :stopdoc:
alias original_resolv_send send
# :startdoc:
def send(mesg, flags, *rest)
if rest.length == 2
host, port = rest
begin
addrs = Resolv.getaddresses(host)
rescue Resolv::ResolvError
raise SocketError, "Hostname not known: #{host}"
end
addrs[0...-1].each {|addr|
begin
return original_resolv_send(mesg, flags, addr, port)
rescue SystemCallError
end
}
original_resolv_send(mesg, flags, addrs[-1], port)
else
original_resolv_send(mesg, flags, *rest)
end
end
end
class SOCKSSocket < TCPSocket
# :stopdoc:
alias original_resolv_initialize initialize
# :startdoc:
def initialize(host, serv)
original_resolv_initialize(IPSocket.getaddress(host), port)
end
end if defined? SOCKSSocket
share/ruby/reline.rb 0000644 00000035320 15173517736 0010454 0 ustar 00 require 'io/console'
require 'forwardable'
require 'reline/version'
require 'reline/config'
require 'reline/key_actor'
require 'reline/key_stroke'
require 'reline/line_editor'
require 'reline/history'
require 'reline/terminfo'
require 'reline/io'
require 'reline/face'
require 'rbconfig'
module Reline
# NOTE: For making compatible with the rb-readline gem
FILENAME_COMPLETION_PROC = nil
USERNAME_COMPLETION_PROC = nil
class ConfigEncodingConversionError < StandardError; end
Key = Struct.new(:char, :combined_char, :with_meta) do
# For dialog_proc `key.match?(dialog.name)`
def match?(sym)
combined_char.is_a?(Symbol) && combined_char == sym
end
end
CursorPos = Struct.new(:x, :y)
DialogRenderInfo = Struct.new(
:pos,
:contents,
:face,
:bg_color, # For the time being, this line should stay here for the compatibility with IRB.
:width,
:height,
:scrollbar,
keyword_init: true
)
class Core
ATTR_READER_NAMES = %i(
completion_append_character
basic_word_break_characters
completer_word_break_characters
basic_quote_characters
completer_quote_characters
filename_quote_characters
special_prefixes
completion_proc
output_modifier_proc
prompt_proc
auto_indent_proc
pre_input_hook
dig_perfect_match_proc
).each(&method(:attr_reader))
attr_accessor :config
attr_accessor :key_stroke
attr_accessor :line_editor
attr_accessor :last_incremental_search
attr_reader :output
extend Forwardable
def_delegators :config,
:autocompletion,
:autocompletion=
def initialize
self.output = STDOUT
@mutex = Mutex.new
@dialog_proc_list = {}
yield self
@completion_quote_character = nil
end
def io_gate
Reline::IOGate
end
def encoding
io_gate.encoding
end
def completion_append_character=(val)
if val.nil?
@completion_append_character = nil
elsif val.size == 1
@completion_append_character = val.encode(encoding)
elsif val.size > 1
@completion_append_character = val[0].encode(encoding)
else
@completion_append_character = nil
end
end
def basic_word_break_characters=(v)
@basic_word_break_characters = v.encode(encoding)
end
def completer_word_break_characters=(v)
@completer_word_break_characters = v.encode(encoding)
end
def basic_quote_characters=(v)
@basic_quote_characters = v.encode(encoding)
end
def completer_quote_characters=(v)
@completer_quote_characters = v.encode(encoding)
end
def filename_quote_characters=(v)
@filename_quote_characters = v.encode(encoding)
end
def special_prefixes=(v)
@special_prefixes = v.encode(encoding)
end
def completion_case_fold=(v)
@config.completion_ignore_case = v
end
def completion_case_fold
@config.completion_ignore_case
end
def completion_quote_character
@completion_quote_character
end
def completion_proc=(p)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
@completion_proc = p
end
def output_modifier_proc=(p)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
@output_modifier_proc = p
end
def prompt_proc=(p)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
@prompt_proc = p
end
def auto_indent_proc=(p)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
@auto_indent_proc = p
end
def pre_input_hook=(p)
@pre_input_hook = p
end
def dig_perfect_match_proc=(p)
raise ArgumentError unless p.respond_to?(:call) or p.nil?
@dig_perfect_match_proc = p
end
DialogProc = Struct.new(:dialog_proc, :context)
def add_dialog_proc(name_sym, p, context = nil)
raise ArgumentError unless name_sym.instance_of?(Symbol)
if p.nil?
@dialog_proc_list.delete(name_sym)
else
raise ArgumentError unless p.respond_to?(:call)
@dialog_proc_list[name_sym] = DialogProc.new(p, context)
end
end
def dialog_proc(name_sym)
@dialog_proc_list[name_sym]
end
def input=(val)
raise TypeError unless val.respond_to?(:getc) or val.nil?
if val.respond_to?(:getc) && io_gate.respond_to?(:input=)
io_gate.input = val
end
end
def output=(val)
raise TypeError unless val.respond_to?(:write) or val.nil?
@output = val
if io_gate.respond_to?(:output=)
io_gate.output = val
end
end
def vi_editing_mode
config.editing_mode = :vi_insert
nil
end
def emacs_editing_mode
config.editing_mode = :emacs
nil
end
def vi_editing_mode?
config.editing_mode_is?(:vi_insert, :vi_command)
end
def emacs_editing_mode?
config.editing_mode_is?(:emacs)
end
def get_screen_size
io_gate.get_screen_size
end
Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE = ->() {
# autocomplete
return unless config.autocompletion
journey_data = completion_journey_data
return unless journey_data
target = journey_data.list.first
completed = journey_data.list[journey_data.pointer]
result = journey_data.list.drop(1)
pointer = journey_data.pointer - 1
return if completed.empty? || (result == [completed] && pointer < 0)
target_width = Reline::Unicode.calculate_width(target)
completed_width = Reline::Unicode.calculate_width(completed)
if cursor_pos.x <= completed_width - target_width
# When target is rendered on the line above cursor position
x = screen_width - completed_width
y = -1
else
x = [cursor_pos.x - completed_width, 0].max
y = 0
end
cursor_pos_to_render = Reline::CursorPos.new(x, y)
if context and context.is_a?(Array)
context.clear
context.push(cursor_pos_to_render, result, pointer, dialog)
end
dialog.pointer = pointer
DialogRenderInfo.new(
pos: cursor_pos_to_render,
contents: result,
scrollbar: true,
height: [15, preferred_dialog_height].min,
face: :completion_dialog
)
}
Reline::DEFAULT_DIALOG_CONTEXT = Array.new
def readmultiline(prompt = '', add_hist = false, &confirm_multiline_termination)
@mutex.synchronize do
unless confirm_multiline_termination
raise ArgumentError.new('#readmultiline needs block to confirm multiline termination')
end
io_gate.with_raw_input do
inner_readline(prompt, add_hist, true, &confirm_multiline_termination)
end
whole_buffer = line_editor.whole_buffer.dup
whole_buffer.taint if RUBY_VERSION < '2.7'
if add_hist and whole_buffer and whole_buffer.chomp("\n").size > 0
Reline::HISTORY << whole_buffer
end
if line_editor.eof?
line_editor.reset_line
# Return nil if the input is aborted by C-d.
nil
else
whole_buffer
end
end
end
def readline(prompt = '', add_hist = false)
@mutex.synchronize do
io_gate.with_raw_input do
inner_readline(prompt, add_hist, false)
end
line = line_editor.line.dup
line.taint if RUBY_VERSION < '2.7'
if add_hist and line and line.chomp("\n").size > 0
Reline::HISTORY << line.chomp("\n")
end
line_editor.reset_line if line_editor.line.nil?
line
end
end
private def inner_readline(prompt, add_hist, multiline, &confirm_multiline_termination)
if ENV['RELINE_STDERR_TTY']
if io_gate.win?
$stderr = File.open(ENV['RELINE_STDERR_TTY'], 'a')
else
$stderr.reopen(ENV['RELINE_STDERR_TTY'], 'w')
end
$stderr.sync = true
$stderr.puts "Reline is used by #{Process.pid}"
end
unless config.test_mode or config.loaded?
config.read
io_gate.set_default_key_bindings(config)
end
otio = io_gate.prep
may_req_ambiguous_char_width
line_editor.reset(prompt, encoding: encoding)
if multiline
line_editor.multiline_on
if block_given?
line_editor.confirm_multiline_termination_proc = confirm_multiline_termination
end
else
line_editor.multiline_off
end
line_editor.output = output
line_editor.completion_proc = completion_proc
line_editor.completion_append_character = completion_append_character
line_editor.output_modifier_proc = output_modifier_proc
line_editor.prompt_proc = prompt_proc
line_editor.auto_indent_proc = auto_indent_proc
line_editor.dig_perfect_match_proc = dig_perfect_match_proc
# Readline calls pre_input_hook just after printing the first prompt.
line_editor.print_nomultiline_prompt
pre_input_hook&.call
unless Reline::IOGate.dumb?
@dialog_proc_list.each_pair do |name_sym, d|
line_editor.add_dialog_proc(name_sym, d.dialog_proc, d.context)
end
end
line_editor.update_dialogs
line_editor.rerender
begin
line_editor.set_signal_handlers
loop do
read_io(config.keyseq_timeout) { |inputs|
line_editor.set_pasting_state(io_gate.in_pasting?)
inputs.each do |key|
if key.char == :bracketed_paste_start
text = io_gate.read_bracketed_paste
line_editor.insert_multiline_text(text)
line_editor.scroll_into_view
else
line_editor.update(key)
end
end
}
if line_editor.finished?
line_editor.render_finished
break
else
line_editor.set_pasting_state(io_gate.in_pasting?)
line_editor.rerender
end
end
io_gate.move_cursor_column(0)
rescue Errno::EIO
# Maybe the I/O has been closed.
ensure
line_editor.finalize
io_gate.deprep(otio)
end
end
# GNU Readline watis for "keyseq-timeout" milliseconds when the input is
# ambiguous whether it is matching or matched.
# If the next character does not arrive within the specified timeout, input
# is considered as matched.
# `ESC` is ambiguous because it can be a standalone ESC (matched) or part of
# `ESC char` or part of CSI sequence (matching).
private def read_io(keyseq_timeout, &block)
buffer = []
status = KeyStroke::MATCHING
loop do
timeout = status == KeyStroke::MATCHING_MATCHED ? keyseq_timeout.fdiv(1000) : Float::INFINITY
c = io_gate.getc(timeout)
if c.nil? || c == -1
if status == KeyStroke::MATCHING_MATCHED
status = KeyStroke::MATCHED
elsif buffer.empty?
# io_gate is closed and reached EOF
block.call([Key.new(nil, nil, false)])
return
else
status = KeyStroke::UNMATCHED
end
else
buffer << c
status = key_stroke.match_status(buffer)
end
if status == KeyStroke::MATCHED || status == KeyStroke::UNMATCHED
expanded, rest_bytes = key_stroke.expand(buffer)
rest_bytes.reverse_each { |c| io_gate.ungetc(c) }
block.call(expanded)
return
end
end
end
def ambiguous_width
may_req_ambiguous_char_width unless defined? @ambiguous_width
@ambiguous_width
end
private def may_req_ambiguous_char_width
@ambiguous_width = 2 if io_gate.dumb? || !STDIN.tty? || !STDOUT.tty?
return if defined? @ambiguous_width
io_gate.move_cursor_column(0)
begin
output.write "\u{25bd}"
rescue Encoding::UndefinedConversionError
# LANG=C
@ambiguous_width = 1
else
@ambiguous_width = io_gate.cursor_pos.x
end
io_gate.move_cursor_column(0)
io_gate.erase_after_cursor
end
end
extend Forwardable
extend SingleForwardable
#--------------------------------------------------------
# Documented API
#--------------------------------------------------------
(Core::ATTR_READER_NAMES).each { |name|
def_single_delegators :core, :"#{name}", :"#{name}="
}
def_single_delegators :core, :input=, :output=
def_single_delegators :core, :vi_editing_mode, :emacs_editing_mode
def_single_delegators :core, :readline
def_single_delegators :core, :completion_case_fold, :completion_case_fold=
def_single_delegators :core, :completion_quote_character
def_instance_delegators self, :readline
private :readline
#--------------------------------------------------------
# Undocumented API
#--------------------------------------------------------
# Testable in original
def_single_delegators :core, :get_screen_size
def_single_delegators :line_editor, :eof?
def_instance_delegators self, :eof?
def_single_delegators :line_editor, :delete_text
def_single_delegator :line_editor, :line, :line_buffer
def_single_delegator :line_editor, :byte_pointer, :point
def_single_delegator :line_editor, :byte_pointer=, :point=
def self.insert_text(text)
line_editor.insert_multiline_text(text)
self
end
# Untestable in original
def_single_delegator :line_editor, :rerender, :redisplay
def_single_delegators :core, :vi_editing_mode?, :emacs_editing_mode?
def_single_delegators :core, :ambiguous_width
def_single_delegators :core, :last_incremental_search
def_single_delegators :core, :last_incremental_search=
def_single_delegators :core, :add_dialog_proc
def_single_delegators :core, :dialog_proc
def_single_delegators :core, :autocompletion, :autocompletion=
def_single_delegators :core, :readmultiline
def_instance_delegators self, :readmultiline
private :readmultiline
def self.encoding_system_needs
self.core.encoding
end
def self.core
@core ||= Core.new { |core|
core.config = Reline::Config.new
core.key_stroke = Reline::KeyStroke.new(core.config)
core.line_editor = Reline::LineEditor.new(core.config, core.encoding)
core.basic_word_break_characters = " \t\n`><=;|&{("
core.completer_word_break_characters = " \t\n`><=;|&{("
core.basic_quote_characters = '"\''
core.completer_quote_characters = '"\''
core.filename_quote_characters = ""
core.special_prefixes = ""
core.add_dialog_proc(:autocomplete, Reline::DEFAULT_DIALOG_PROC_AUTOCOMPLETE, Reline::DEFAULT_DIALOG_CONTEXT)
}
end
def self.ungetc(c)
core.io_gate.ungetc(c)
end
def self.line_editor
core.line_editor
end
end
Reline::IOGate = Reline::IO.decide_io_gate
# Deprecated
Reline::GeneralIO = Reline::Dumb.new
Reline::Face.load_initial_configs
Reline::HISTORY = Reline::History.new(Reline.core.config)
share/ruby/reline/kill_ring.rb 0000644 00000004575 15173517736 0012436 0 ustar 00 class Reline::KillRing
include Enumerable
module State
FRESH = :fresh
CONTINUED = :continued
PROCESSED = :processed
YANK = :yank
end
RingPoint = Struct.new(:backward, :forward, :str) do
def initialize(str)
super(nil, nil, str)
end
def ==(other)
equal?(other)
end
end
class RingBuffer
attr_reader :size
attr_reader :head
def initialize(max = 1024)
@max = max
@size = 0
@head = nil # reading head of ring-shaped tape
end
def <<(point)
if @size.zero?
@head = point
@head.backward = @head
@head.forward = @head
@size = 1
elsif @size >= @max
tail = @head.forward
new_tail = tail.forward
@head.forward = point
point.backward = @head
new_tail.backward = point
point.forward = new_tail
@head = point
else
tail = @head.forward
@head.forward = point
point.backward = @head
tail.backward = point
point.forward = tail
@head = point
@size += 1
end
end
def empty?
@size.zero?
end
end
def initialize(max = 1024)
@ring = RingBuffer.new(max)
@ring_pointer = nil
@buffer = nil
@state = State::FRESH
end
def append(string, before_p = false)
case @state
when State::FRESH, State::YANK
@ring << RingPoint.new(+string)
@state = State::CONTINUED
when State::CONTINUED, State::PROCESSED
if before_p
@ring.head.str.prepend(string)
else
@ring.head.str.concat(string)
end
@state = State::CONTINUED
end
end
def process
case @state
when State::FRESH
# nothing to do
when State::CONTINUED
@state = State::PROCESSED
when State::PROCESSED
@state = State::FRESH
when State::YANK
# nothing to do
end
end
def yank
unless @ring.empty?
@state = State::YANK
@ring_pointer = @ring.head
@ring_pointer.str
else
nil
end
end
def yank_pop
if @state == State::YANK
prev_yank = @ring_pointer.str
@ring_pointer = @ring_pointer.backward
[@ring_pointer.str, prev_yank]
else
nil
end
end
def each
start = head = @ring.head
loop do
break if head.nil?
yield head.str
head = head.backward
break if head == start
end
end
end
share/ruby/reline/unicode.rb 0000644 00000052204 15173517736 0012102 0 ustar 00 class Reline::Unicode
EscapedPairs = {
0x00 => '^@',
0x01 => '^A', # C-a
0x02 => '^B',
0x03 => '^C',
0x04 => '^D',
0x05 => '^E',
0x06 => '^F',
0x07 => '^G',
0x08 => '^H', # Backspace
0x09 => '^I',
0x0A => '^J',
0x0B => '^K',
0x0C => '^L',
0x0D => '^M', # Enter
0x0E => '^N',
0x0F => '^O',
0x10 => '^P',
0x11 => '^Q',
0x12 => '^R',
0x13 => '^S',
0x14 => '^T',
0x15 => '^U',
0x16 => '^V',
0x17 => '^W',
0x18 => '^X',
0x19 => '^Y',
0x1A => '^Z', # C-z
0x1B => '^[', # C-[ C-3
0x1D => '^]', # C-]
0x1E => '^^', # C-~ C-6
0x1F => '^_', # C-_ C-7
0x7F => '^?', # C-? C-8
}
EscapedChars = EscapedPairs.keys.map(&:chr)
NON_PRINTING_START = "\1"
NON_PRINTING_END = "\2"
CSI_REGEXP = /\e\[[\d;]*[ABCDEFGHJKSTfminsuhl]/
OSC_REGEXP = /\e\]\d+(?:;[^;\a\e]+)*(?:\a|\e\\)/
WIDTH_SCANNER = /\G(?:(#{NON_PRINTING_START})|(#{NON_PRINTING_END})|(#{CSI_REGEXP})|(#{OSC_REGEXP})|(\X))/o
def self.escape_for_print(str)
str.chars.map! { |gr|
case gr
when -"\n"
gr
when -"\t"
-' '
else
EscapedPairs[gr.ord] || gr
end
}.join
end
require 'reline/unicode/east_asian_width'
def self.get_mbchar_width(mbchar)
ord = mbchar.ord
if ord <= 0x1F # in EscapedPairs
return 2
elsif ord <= 0x7E # printable ASCII chars
return 1
end
utf8_mbchar = mbchar.encode(Encoding::UTF_8)
ord = utf8_mbchar.ord
chunk_index = EastAsianWidth::CHUNK_LAST.bsearch_index { |o| ord <= o }
size = EastAsianWidth::CHUNK_WIDTH[chunk_index]
if size == -1
Reline.ambiguous_width
elsif size == 1 && utf8_mbchar.size >= 2
second_char_ord = utf8_mbchar[1].ord
# Halfwidth Dakuten Handakuten
# Only these two character has Letter Modifier category and can be combined in a single grapheme cluster
(second_char_ord == 0xFF9E || second_char_ord == 0xFF9F) ? 2 : 1
else
size
end
end
def self.calculate_width(str, allow_escape_code = false)
if allow_escape_code
width = 0
rest = str.encode(Encoding::UTF_8)
in_zero_width = false
rest.scan(WIDTH_SCANNER) do |non_printing_start, non_printing_end, csi, osc, gc|
case
when non_printing_start
in_zero_width = true
when non_printing_end
in_zero_width = false
when csi, osc
when gc
unless in_zero_width
width += get_mbchar_width(gc)
end
end
end
width
else
str.encode(Encoding::UTF_8).grapheme_clusters.inject(0) { |w, gc|
w + get_mbchar_width(gc)
}
end
end
def self.split_by_width(str, max_width, encoding = str.encoding, offset: 0)
lines = [String.new(encoding: encoding)]
height = 1
width = offset
rest = str.encode(Encoding::UTF_8)
in_zero_width = false
seq = String.new(encoding: encoding)
rest.scan(WIDTH_SCANNER) do |non_printing_start, non_printing_end, csi, osc, gc|
case
when non_printing_start
in_zero_width = true
lines.last << NON_PRINTING_START
when non_printing_end
in_zero_width = false
lines.last << NON_PRINTING_END
when csi
lines.last << csi
unless in_zero_width
if csi == -"\e[m" || csi == -"\e[0m"
seq.clear
else
seq << csi
end
end
when osc
lines.last << osc
seq << osc
when gc
unless in_zero_width
mbchar_width = get_mbchar_width(gc)
if (width += mbchar_width) > max_width
width = mbchar_width
lines << nil
lines << seq.dup
height += 1
end
end
lines.last << gc
end
end
# The cursor moves to next line in first
if width == max_width
lines << nil
lines << String.new(encoding: encoding)
height += 1
end
[lines, height]
end
# Take a chunk of a String cut by width with escape sequences.
def self.take_range(str, start_col, max_width)
take_mbchar_range(str, start_col, max_width).first
end
def self.take_mbchar_range(str, start_col, width, cover_begin: false, cover_end: false, padding: false)
chunk = String.new(encoding: str.encoding)
end_col = start_col + width
total_width = 0
rest = str.encode(Encoding::UTF_8)
in_zero_width = false
chunk_start_col = nil
chunk_end_col = nil
has_csi = false
rest.scan(WIDTH_SCANNER) do |non_printing_start, non_printing_end, csi, osc, gc|
case
when non_printing_start
in_zero_width = true
chunk << NON_PRINTING_START
when non_printing_end
in_zero_width = false
chunk << NON_PRINTING_END
when csi
has_csi = true
chunk << csi
when osc
chunk << osc
when gc
if in_zero_width
chunk << gc
next
end
mbchar_width = get_mbchar_width(gc)
prev_width = total_width
total_width += mbchar_width
if (cover_begin || padding ? total_width <= start_col : prev_width < start_col)
# Current character haven't reached start_col yet
next
elsif padding && !cover_begin && prev_width < start_col && start_col < total_width
# Add preceding padding. This padding might have background color.
chunk << ' '
chunk_start_col ||= start_col
chunk_end_col = total_width
next
elsif (cover_end ? prev_width < end_col : total_width <= end_col)
# Current character is in the range
chunk << gc
chunk_start_col ||= prev_width
chunk_end_col = total_width
break if total_width >= end_col
else
# Current character exceeds end_col
if padding && end_col < total_width
# Add succeeding padding. This padding might have background color.
chunk << ' '
chunk_start_col ||= prev_width
chunk_end_col = end_col
end
break
end
end
end
chunk_start_col ||= start_col
chunk_end_col ||= start_col
if padding && chunk_end_col < end_col
# Append padding. This padding should not include background color.
chunk << "\e[0m" if has_csi
chunk << ' ' * (end_col - chunk_end_col)
chunk_end_col = end_col
end
[chunk, chunk_start_col, chunk_end_col - chunk_start_col]
end
def self.get_next_mbchar_size(line, byte_pointer)
grapheme = line.byteslice(byte_pointer..-1).grapheme_clusters.first
grapheme ? grapheme.bytesize : 0
end
def self.get_prev_mbchar_size(line, byte_pointer)
if byte_pointer.zero?
0
else
grapheme = line.byteslice(0..(byte_pointer - 1)).grapheme_clusters.last
grapheme ? grapheme.bytesize : 0
end
end
def self.em_forward_word(line, byte_pointer)
width = 0
byte_size = 0
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
width += get_mbchar_width(mbchar)
byte_size += size
end
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
def self.em_forward_word_with_capitalization(line, byte_pointer)
width = 0
byte_size = 0
new_str = String.new
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
new_str += mbchar
width += get_mbchar_width(mbchar)
byte_size += size
end
first = true
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
if first
new_str += mbchar.upcase
first = false
else
new_str += mbchar.downcase
end
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width, new_str]
end
def self.em_backward_word(line, byte_pointer)
width = 0
byte_size = 0
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
width += get_mbchar_width(mbchar)
byte_size += size
end
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
def self.em_big_backward_word(line, byte_pointer)
width = 0
byte_size = 0
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
break if mbchar =~ /\S/
width += get_mbchar_width(mbchar)
byte_size += size
end
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
break if mbchar =~ /\s/
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
def self.ed_transpose_words(line, byte_pointer)
right_word_start = nil
size = get_next_mbchar_size(line, byte_pointer)
mbchar = line.byteslice(byte_pointer, size)
if size.zero?
# ' aaa bbb [cursor]'
byte_size = 0
while 0 < (byte_pointer + byte_size)
size = get_prev_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
byte_size -= size
end
while 0 < (byte_pointer + byte_size)
size = get_prev_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
byte_size -= size
end
right_word_start = byte_pointer + byte_size
byte_size = 0
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
byte_size += size
end
after_start = byte_pointer + byte_size
elsif mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
# ' aaa bb[cursor]b'
byte_size = 0
while 0 < (byte_pointer + byte_size)
size = get_prev_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
byte_size -= size
end
right_word_start = byte_pointer + byte_size
byte_size = 0
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
byte_size += size
end
after_start = byte_pointer + byte_size
else
byte_size = 0
while (line.bytesize - 1) > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
byte_size += size
end
if (byte_pointer + byte_size) == (line.bytesize - 1)
# ' aaa bbb [cursor] '
after_start = line.bytesize
while 0 < (byte_pointer + byte_size)
size = get_prev_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
byte_size -= size
end
while 0 < (byte_pointer + byte_size)
size = get_prev_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
byte_size -= size
end
right_word_start = byte_pointer + byte_size
else
# ' aaa [cursor] bbb '
right_word_start = byte_pointer + byte_size
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
byte_size += size
end
after_start = byte_pointer + byte_size
end
end
byte_size = right_word_start - byte_pointer
while 0 < (byte_pointer + byte_size)
size = get_prev_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\p{Word}/
byte_size -= size
end
middle_start = byte_pointer + byte_size
byte_size = middle_start - byte_pointer
while 0 < (byte_pointer + byte_size)
size = get_prev_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size - size, size)
break if mbchar.encode(Encoding::UTF_8) =~ /\P{Word}/
byte_size -= size
end
left_word_start = byte_pointer + byte_size
[left_word_start, middle_start, right_word_start, after_start]
end
def self.vi_big_forward_word(line, byte_pointer)
width = 0
byte_size = 0
while (line.bytesize - 1) > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar =~ /\s/
width += get_mbchar_width(mbchar)
byte_size += size
end
while (line.bytesize - 1) > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar =~ /\S/
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
def self.vi_big_forward_end_word(line, byte_pointer)
if (line.bytesize - 1) > byte_pointer
size = get_next_mbchar_size(line, byte_pointer)
mbchar = line.byteslice(byte_pointer, size)
width = get_mbchar_width(mbchar)
byte_size = size
else
return [0, 0]
end
while (line.bytesize - 1) > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar =~ /\S/
width += get_mbchar_width(mbchar)
byte_size += size
end
prev_width = width
prev_byte_size = byte_size
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar =~ /\s/
prev_width = width
prev_byte_size = byte_size
width += get_mbchar_width(mbchar)
byte_size += size
end
[prev_byte_size, prev_width]
end
def self.vi_big_backward_word(line, byte_pointer)
width = 0
byte_size = 0
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
break if mbchar =~ /\S/
width += get_mbchar_width(mbchar)
byte_size += size
end
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
break if mbchar =~ /\s/
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
def self.vi_forward_word(line, byte_pointer, drop_terminate_spaces = false)
if line.bytesize > byte_pointer
size = get_next_mbchar_size(line, byte_pointer)
mbchar = line.byteslice(byte_pointer, size)
if mbchar =~ /\w/
started_by = :word
elsif mbchar =~ /\s/
started_by = :space
else
started_by = :non_word_printable
end
width = get_mbchar_width(mbchar)
byte_size = size
else
return [0, 0]
end
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
case started_by
when :word
break if mbchar =~ /\W/
when :space
break if mbchar =~ /\S/
when :non_word_printable
break if mbchar =~ /\w|\s/
end
width += get_mbchar_width(mbchar)
byte_size += size
end
return [byte_size, width] if drop_terminate_spaces
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
break if mbchar =~ /\S/
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
def self.vi_forward_end_word(line, byte_pointer)
if (line.bytesize - 1) > byte_pointer
size = get_next_mbchar_size(line, byte_pointer)
mbchar = line.byteslice(byte_pointer, size)
if mbchar =~ /\w/
started_by = :word
elsif mbchar =~ /\s/
started_by = :space
else
started_by = :non_word_printable
end
width = get_mbchar_width(mbchar)
byte_size = size
else
return [0, 0]
end
if (line.bytesize - 1) > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
if mbchar =~ /\w/
second = :word
elsif mbchar =~ /\s/
second = :space
else
second = :non_word_printable
end
second_width = get_mbchar_width(mbchar)
second_byte_size = size
else
return [byte_size, width]
end
if second == :space
width += second_width
byte_size += second_byte_size
while (line.bytesize - 1) > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
if mbchar =~ /\S/
if mbchar =~ /\w/
started_by = :word
else
started_by = :non_word_printable
end
break
end
width += get_mbchar_width(mbchar)
byte_size += size
end
else
case [started_by, second]
when [:word, :non_word_printable], [:non_word_printable, :word]
started_by = second
else
width += second_width
byte_size += second_byte_size
started_by = second
end
end
prev_width = width
prev_byte_size = byte_size
while line.bytesize > (byte_pointer + byte_size)
size = get_next_mbchar_size(line, byte_pointer + byte_size)
mbchar = line.byteslice(byte_pointer + byte_size, size)
case started_by
when :word
break if mbchar =~ /\W/
when :non_word_printable
break if mbchar =~ /[\w\s]/
end
prev_width = width
prev_byte_size = byte_size
width += get_mbchar_width(mbchar)
byte_size += size
end
[prev_byte_size, prev_width]
end
def self.vi_backward_word(line, byte_pointer)
width = 0
byte_size = 0
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
if mbchar =~ /\S/
if mbchar =~ /\w/
started_by = :word
else
started_by = :non_word_printable
end
break
end
width += get_mbchar_width(mbchar)
byte_size += size
end
while 0 < (byte_pointer - byte_size)
size = get_prev_mbchar_size(line, byte_pointer - byte_size)
mbchar = line.byteslice(byte_pointer - byte_size - size, size)
case started_by
when :word
break if mbchar =~ /\W/
when :non_word_printable
break if mbchar =~ /[\w\s]/
end
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
def self.vi_first_print(line)
width = 0
byte_size = 0
while (line.bytesize - 1) > byte_size
size = get_next_mbchar_size(line, byte_size)
mbchar = line.byteslice(byte_size, size)
if mbchar =~ /\S/
break
end
width += get_mbchar_width(mbchar)
byte_size += size
end
[byte_size, width]
end
end
share/ruby/reline/unicode/east_asian_width.rb 0000644 00000052453 15173517736 0015416 0 ustar 00 class Reline::Unicode::EastAsianWidth
# This is based on EastAsianWidth.txt
# UNICODE_VERSION = '15.1.0'
CHUNK_LAST, CHUNK_WIDTH = [
[0x1f, 2],
[0x7e, 1],
[0x7f, 2],
[0xa0, 1],
[0xa1, -1],
[0xa3, 1],
[0xa4, -1],
[0xa6, 1],
[0xa8, -1],
[0xa9, 1],
[0xaa, -1],
[0xac, 1],
[0xae, -1],
[0xaf, 1],
[0xb4, -1],
[0xb5, 1],
[0xba, -1],
[0xbb, 1],
[0xbf, -1],
[0xc5, 1],
[0xc6, -1],
[0xcf, 1],
[0xd0, -1],
[0xd6, 1],
[0xd8, -1],
[0xdd, 1],
[0xe1, -1],
[0xe5, 1],
[0xe6, -1],
[0xe7, 1],
[0xea, -1],
[0xeb, 1],
[0xed, -1],
[0xef, 1],
[0xf0, -1],
[0xf1, 1],
[0xf3, -1],
[0xf6, 1],
[0xfa, -1],
[0xfb, 1],
[0xfc, -1],
[0xfd, 1],
[0xfe, -1],
[0x100, 1],
[0x101, -1],
[0x110, 1],
[0x111, -1],
[0x112, 1],
[0x113, -1],
[0x11a, 1],
[0x11b, -1],
[0x125, 1],
[0x127, -1],
[0x12a, 1],
[0x12b, -1],
[0x130, 1],
[0x133, -1],
[0x137, 1],
[0x138, -1],
[0x13e, 1],
[0x142, -1],
[0x143, 1],
[0x144, -1],
[0x147, 1],
[0x14b, -1],
[0x14c, 1],
[0x14d, -1],
[0x151, 1],
[0x153, -1],
[0x165, 1],
[0x167, -1],
[0x16a, 1],
[0x16b, -1],
[0x1cd, 1],
[0x1ce, -1],
[0x1cf, 1],
[0x1d0, -1],
[0x1d1, 1],
[0x1d2, -1],
[0x1d3, 1],
[0x1d4, -1],
[0x1d5, 1],
[0x1d6, -1],
[0x1d7, 1],
[0x1d8, -1],
[0x1d9, 1],
[0x1da, -1],
[0x1db, 1],
[0x1dc, -1],
[0x250, 1],
[0x251, -1],
[0x260, 1],
[0x261, -1],
[0x2c3, 1],
[0x2c4, -1],
[0x2c6, 1],
[0x2c7, -1],
[0x2c8, 1],
[0x2cb, -1],
[0x2cc, 1],
[0x2cd, -1],
[0x2cf, 1],
[0x2d0, -1],
[0x2d7, 1],
[0x2db, -1],
[0x2dc, 1],
[0x2dd, -1],
[0x2de, 1],
[0x2df, -1],
[0x2ff, 1],
[0x36f, 0],
[0x390, 1],
[0x3a1, -1],
[0x3a2, 1],
[0x3a9, -1],
[0x3b0, 1],
[0x3c1, -1],
[0x3c2, 1],
[0x3c9, -1],
[0x400, 1],
[0x401, -1],
[0x40f, 1],
[0x44f, -1],
[0x450, 1],
[0x451, -1],
[0x482, 1],
[0x487, 0],
[0x590, 1],
[0x5bd, 0],
[0x5be, 1],
[0x5bf, 0],
[0x5c0, 1],
[0x5c2, 0],
[0x5c3, 1],
[0x5c5, 0],
[0x5c6, 1],
[0x5c7, 0],
[0x60f, 1],
[0x61a, 0],
[0x64a, 1],
[0x65f, 0],
[0x66f, 1],
[0x670, 0],
[0x6d5, 1],
[0x6dc, 0],
[0x6de, 1],
[0x6e4, 0],
[0x6e6, 1],
[0x6e8, 0],
[0x6e9, 1],
[0x6ed, 0],
[0x710, 1],
[0x711, 0],
[0x72f, 1],
[0x74a, 0],
[0x7a5, 1],
[0x7b0, 0],
[0x7ea, 1],
[0x7f3, 0],
[0x7fc, 1],
[0x7fd, 0],
[0x815, 1],
[0x819, 0],
[0x81a, 1],
[0x823, 0],
[0x824, 1],
[0x827, 0],
[0x828, 1],
[0x82d, 0],
[0x858, 1],
[0x85b, 0],
[0x897, 1],
[0x89f, 0],
[0x8c9, 1],
[0x8e1, 0],
[0x8e2, 1],
[0x902, 0],
[0x939, 1],
[0x93a, 0],
[0x93b, 1],
[0x93c, 0],
[0x940, 1],
[0x948, 0],
[0x94c, 1],
[0x94d, 0],
[0x950, 1],
[0x957, 0],
[0x961, 1],
[0x963, 0],
[0x980, 1],
[0x981, 0],
[0x9bb, 1],
[0x9bc, 0],
[0x9c0, 1],
[0x9c4, 0],
[0x9cc, 1],
[0x9cd, 0],
[0x9e1, 1],
[0x9e3, 0],
[0x9fd, 1],
[0x9fe, 0],
[0xa00, 1],
[0xa02, 0],
[0xa3b, 1],
[0xa3c, 0],
[0xa40, 1],
[0xa42, 0],
[0xa46, 1],
[0xa48, 0],
[0xa4a, 1],
[0xa4d, 0],
[0xa50, 1],
[0xa51, 0],
[0xa6f, 1],
[0xa71, 0],
[0xa74, 1],
[0xa75, 0],
[0xa80, 1],
[0xa82, 0],
[0xabb, 1],
[0xabc, 0],
[0xac0, 1],
[0xac5, 0],
[0xac6, 1],
[0xac8, 0],
[0xacc, 1],
[0xacd, 0],
[0xae1, 1],
[0xae3, 0],
[0xaf9, 1],
[0xaff, 0],
[0xb00, 1],
[0xb01, 0],
[0xb3b, 1],
[0xb3c, 0],
[0xb3e, 1],
[0xb3f, 0],
[0xb40, 1],
[0xb44, 0],
[0xb4c, 1],
[0xb4d, 0],
[0xb54, 1],
[0xb56, 0],
[0xb61, 1],
[0xb63, 0],
[0xb81, 1],
[0xb82, 0],
[0xbbf, 1],
[0xbc0, 0],
[0xbcc, 1],
[0xbcd, 0],
[0xbff, 1],
[0xc00, 0],
[0xc03, 1],
[0xc04, 0],
[0xc3b, 1],
[0xc3c, 0],
[0xc3d, 1],
[0xc40, 0],
[0xc45, 1],
[0xc48, 0],
[0xc49, 1],
[0xc4d, 0],
[0xc54, 1],
[0xc56, 0],
[0xc61, 1],
[0xc63, 0],
[0xc80, 1],
[0xc81, 0],
[0xcbb, 1],
[0xcbc, 0],
[0xcbe, 1],
[0xcbf, 0],
[0xcc5, 1],
[0xcc6, 0],
[0xccb, 1],
[0xccd, 0],
[0xce1, 1],
[0xce3, 0],
[0xcff, 1],
[0xd01, 0],
[0xd3a, 1],
[0xd3c, 0],
[0xd40, 1],
[0xd44, 0],
[0xd4c, 1],
[0xd4d, 0],
[0xd61, 1],
[0xd63, 0],
[0xd80, 1],
[0xd81, 0],
[0xdc9, 1],
[0xdca, 0],
[0xdd1, 1],
[0xdd4, 0],
[0xdd5, 1],
[0xdd6, 0],
[0xe30, 1],
[0xe31, 0],
[0xe33, 1],
[0xe3a, 0],
[0xe46, 1],
[0xe4e, 0],
[0xeb0, 1],
[0xeb1, 0],
[0xeb3, 1],
[0xebc, 0],
[0xec7, 1],
[0xece, 0],
[0xf17, 1],
[0xf19, 0],
[0xf34, 1],
[0xf35, 0],
[0xf36, 1],
[0xf37, 0],
[0xf38, 1],
[0xf39, 0],
[0xf70, 1],
[0xf7e, 0],
[0xf7f, 1],
[0xf84, 0],
[0xf85, 1],
[0xf87, 0],
[0xf8c, 1],
[0xf97, 0],
[0xf98, 1],
[0xfbc, 0],
[0xfc5, 1],
[0xfc6, 0],
[0x102c, 1],
[0x1030, 0],
[0x1031, 1],
[0x1037, 0],
[0x1038, 1],
[0x103a, 0],
[0x103c, 1],
[0x103e, 0],
[0x1057, 1],
[0x1059, 0],
[0x105d, 1],
[0x1060, 0],
[0x1070, 1],
[0x1074, 0],
[0x1081, 1],
[0x1082, 0],
[0x1084, 1],
[0x1086, 0],
[0x108c, 1],
[0x108d, 0],
[0x109c, 1],
[0x109d, 0],
[0x10ff, 1],
[0x115f, 2],
[0x135c, 1],
[0x135f, 0],
[0x1711, 1],
[0x1714, 0],
[0x1731, 1],
[0x1733, 0],
[0x1751, 1],
[0x1753, 0],
[0x1771, 1],
[0x1773, 0],
[0x17b3, 1],
[0x17b5, 0],
[0x17b6, 1],
[0x17bd, 0],
[0x17c5, 1],
[0x17c6, 0],
[0x17c8, 1],
[0x17d3, 0],
[0x17dc, 1],
[0x17dd, 0],
[0x180a, 1],
[0x180d, 0],
[0x180e, 1],
[0x180f, 0],
[0x1884, 1],
[0x1886, 0],
[0x18a8, 1],
[0x18a9, 0],
[0x191f, 1],
[0x1922, 0],
[0x1926, 1],
[0x1928, 0],
[0x1931, 1],
[0x1932, 0],
[0x1938, 1],
[0x193b, 0],
[0x1a16, 1],
[0x1a18, 0],
[0x1a1a, 1],
[0x1a1b, 0],
[0x1a55, 1],
[0x1a56, 0],
[0x1a57, 1],
[0x1a5e, 0],
[0x1a5f, 1],
[0x1a60, 0],
[0x1a61, 1],
[0x1a62, 0],
[0x1a64, 1],
[0x1a6c, 0],
[0x1a72, 1],
[0x1a7c, 0],
[0x1a7e, 1],
[0x1a7f, 0],
[0x1aaf, 1],
[0x1abd, 0],
[0x1abe, 1],
[0x1ace, 0],
[0x1aff, 1],
[0x1b03, 0],
[0x1b33, 1],
[0x1b34, 0],
[0x1b35, 1],
[0x1b3a, 0],
[0x1b3b, 1],
[0x1b3c, 0],
[0x1b41, 1],
[0x1b42, 0],
[0x1b6a, 1],
[0x1b73, 0],
[0x1b7f, 1],
[0x1b81, 0],
[0x1ba1, 1],
[0x1ba5, 0],
[0x1ba7, 1],
[0x1ba9, 0],
[0x1baa, 1],
[0x1bad, 0],
[0x1be5, 1],
[0x1be6, 0],
[0x1be7, 1],
[0x1be9, 0],
[0x1bec, 1],
[0x1bed, 0],
[0x1bee, 1],
[0x1bf1, 0],
[0x1c2b, 1],
[0x1c33, 0],
[0x1c35, 1],
[0x1c37, 0],
[0x1ccf, 1],
[0x1cd2, 0],
[0x1cd3, 1],
[0x1ce0, 0],
[0x1ce1, 1],
[0x1ce8, 0],
[0x1cec, 1],
[0x1ced, 0],
[0x1cf3, 1],
[0x1cf4, 0],
[0x1cf7, 1],
[0x1cf9, 0],
[0x1dbf, 1],
[0x1dff, 0],
[0x200f, 1],
[0x2010, -1],
[0x2012, 1],
[0x2016, -1],
[0x2017, 1],
[0x2019, -1],
[0x201b, 1],
[0x201d, -1],
[0x201f, 1],
[0x2022, -1],
[0x2023, 1],
[0x2027, -1],
[0x202f, 1],
[0x2030, -1],
[0x2031, 1],
[0x2033, -1],
[0x2034, 1],
[0x2035, -1],
[0x203a, 1],
[0x203b, -1],
[0x203d, 1],
[0x203e, -1],
[0x2073, 1],
[0x2074, -1],
[0x207e, 1],
[0x207f, -1],
[0x2080, 1],
[0x2084, -1],
[0x20ab, 1],
[0x20ac, -1],
[0x20cf, 1],
[0x20dc, 0],
[0x20e0, 1],
[0x20e1, 0],
[0x20e4, 1],
[0x20f0, 0],
[0x2102, 1],
[0x2103, -1],
[0x2104, 1],
[0x2105, -1],
[0x2108, 1],
[0x2109, -1],
[0x2112, 1],
[0x2113, -1],
[0x2115, 1],
[0x2116, -1],
[0x2120, 1],
[0x2122, -1],
[0x2125, 1],
[0x2126, -1],
[0x212a, 1],
[0x212b, -1],
[0x2152, 1],
[0x2154, -1],
[0x215a, 1],
[0x215e, -1],
[0x215f, 1],
[0x216b, -1],
[0x216f, 1],
[0x2179, -1],
[0x2188, 1],
[0x2189, -1],
[0x218f, 1],
[0x2199, -1],
[0x21b7, 1],
[0x21b9, -1],
[0x21d1, 1],
[0x21d2, -1],
[0x21d3, 1],
[0x21d4, -1],
[0x21e6, 1],
[0x21e7, -1],
[0x21ff, 1],
[0x2200, -1],
[0x2201, 1],
[0x2203, -1],
[0x2206, 1],
[0x2208, -1],
[0x220a, 1],
[0x220b, -1],
[0x220e, 1],
[0x220f, -1],
[0x2210, 1],
[0x2211, -1],
[0x2214, 1],
[0x2215, -1],
[0x2219, 1],
[0x221a, -1],
[0x221c, 1],
[0x2220, -1],
[0x2222, 1],
[0x2223, -1],
[0x2224, 1],
[0x2225, -1],
[0x2226, 1],
[0x222c, -1],
[0x222d, 1],
[0x222e, -1],
[0x2233, 1],
[0x2237, -1],
[0x223b, 1],
[0x223d, -1],
[0x2247, 1],
[0x2248, -1],
[0x224b, 1],
[0x224c, -1],
[0x2251, 1],
[0x2252, -1],
[0x225f, 1],
[0x2261, -1],
[0x2263, 1],
[0x2267, -1],
[0x2269, 1],
[0x226b, -1],
[0x226d, 1],
[0x226f, -1],
[0x2281, 1],
[0x2283, -1],
[0x2285, 1],
[0x2287, -1],
[0x2294, 1],
[0x2295, -1],
[0x2298, 1],
[0x2299, -1],
[0x22a4, 1],
[0x22a5, -1],
[0x22be, 1],
[0x22bf, -1],
[0x2311, 1],
[0x2312, -1],
[0x2319, 1],
[0x231b, 2],
[0x2328, 1],
[0x232a, 2],
[0x23e8, 1],
[0x23ec, 2],
[0x23ef, 1],
[0x23f0, 2],
[0x23f2, 1],
[0x23f3, 2],
[0x245f, 1],
[0x24e9, -1],
[0x24ea, 1],
[0x254b, -1],
[0x254f, 1],
[0x2573, -1],
[0x257f, 1],
[0x258f, -1],
[0x2591, 1],
[0x2595, -1],
[0x259f, 1],
[0x25a1, -1],
[0x25a2, 1],
[0x25a9, -1],
[0x25b1, 1],
[0x25b3, -1],
[0x25b5, 1],
[0x25b7, -1],
[0x25bb, 1],
[0x25bd, -1],
[0x25bf, 1],
[0x25c1, -1],
[0x25c5, 1],
[0x25c8, -1],
[0x25ca, 1],
[0x25cb, -1],
[0x25cd, 1],
[0x25d1, -1],
[0x25e1, 1],
[0x25e5, -1],
[0x25ee, 1],
[0x25ef, -1],
[0x25fc, 1],
[0x25fe, 2],
[0x2604, 1],
[0x2606, -1],
[0x2608, 1],
[0x2609, -1],
[0x260d, 1],
[0x260f, -1],
[0x2613, 1],
[0x2615, 2],
[0x261b, 1],
[0x261c, -1],
[0x261d, 1],
[0x261e, -1],
[0x263f, 1],
[0x2640, -1],
[0x2641, 1],
[0x2642, -1],
[0x2647, 1],
[0x2653, 2],
[0x265f, 1],
[0x2661, -1],
[0x2662, 1],
[0x2665, -1],
[0x2666, 1],
[0x266a, -1],
[0x266b, 1],
[0x266d, -1],
[0x266e, 1],
[0x266f, -1],
[0x267e, 1],
[0x267f, 2],
[0x2692, 1],
[0x2693, 2],
[0x269d, 1],
[0x269f, -1],
[0x26a0, 1],
[0x26a1, 2],
[0x26a9, 1],
[0x26ab, 2],
[0x26bc, 1],
[0x26be, 2],
[0x26bf, -1],
[0x26c3, 1],
[0x26c5, 2],
[0x26cd, -1],
[0x26ce, 2],
[0x26d3, -1],
[0x26d4, 2],
[0x26e1, -1],
[0x26e2, 1],
[0x26e3, -1],
[0x26e7, 1],
[0x26e9, -1],
[0x26ea, 2],
[0x26f1, -1],
[0x26f3, 2],
[0x26f4, -1],
[0x26f5, 2],
[0x26f9, -1],
[0x26fa, 2],
[0x26fc, -1],
[0x26fd, 2],
[0x26ff, -1],
[0x2704, 1],
[0x2705, 2],
[0x2709, 1],
[0x270b, 2],
[0x2727, 1],
[0x2728, 2],
[0x273c, 1],
[0x273d, -1],
[0x274b, 1],
[0x274c, 2],
[0x274d, 1],
[0x274e, 2],
[0x2752, 1],
[0x2755, 2],
[0x2756, 1],
[0x2757, 2],
[0x2775, 1],
[0x277f, -1],
[0x2794, 1],
[0x2797, 2],
[0x27af, 1],
[0x27b0, 2],
[0x27be, 1],
[0x27bf, 2],
[0x2b1a, 1],
[0x2b1c, 2],
[0x2b4f, 1],
[0x2b50, 2],
[0x2b54, 1],
[0x2b55, 2],
[0x2b59, -1],
[0x2cee, 1],
[0x2cf1, 0],
[0x2d7e, 1],
[0x2d7f, 0],
[0x2ddf, 1],
[0x2dff, 0],
[0x2e7f, 1],
[0x2e99, 2],
[0x2e9a, 1],
[0x2ef3, 2],
[0x2eff, 1],
[0x2fd5, 2],
[0x2fef, 1],
[0x3029, 2],
[0x302d, 0],
[0x303e, 2],
[0x3040, 1],
[0x3096, 2],
[0x3098, 1],
[0x309a, 0],
[0x30ff, 2],
[0x3104, 1],
[0x312f, 2],
[0x3130, 1],
[0x318e, 2],
[0x318f, 1],
[0x31e3, 2],
[0x31ee, 1],
[0x321e, 2],
[0x321f, 1],
[0x3247, 2],
[0x324f, -1],
[0x4dbf, 2],
[0x4dff, 1],
[0xa48c, 2],
[0xa48f, 1],
[0xa4c6, 2],
[0xa66e, 1],
[0xa66f, 0],
[0xa673, 1],
[0xa67d, 0],
[0xa69d, 1],
[0xa69f, 0],
[0xa6ef, 1],
[0xa6f1, 0],
[0xa801, 1],
[0xa802, 0],
[0xa805, 1],
[0xa806, 0],
[0xa80a, 1],
[0xa80b, 0],
[0xa824, 1],
[0xa826, 0],
[0xa82b, 1],
[0xa82c, 0],
[0xa8c3, 1],
[0xa8c5, 0],
[0xa8df, 1],
[0xa8f1, 0],
[0xa8fe, 1],
[0xa8ff, 0],
[0xa925, 1],
[0xa92d, 0],
[0xa946, 1],
[0xa951, 0],
[0xa95f, 1],
[0xa97c, 2],
[0xa97f, 1],
[0xa982, 0],
[0xa9b2, 1],
[0xa9b3, 0],
[0xa9b5, 1],
[0xa9b9, 0],
[0xa9bb, 1],
[0xa9bd, 0],
[0xa9e4, 1],
[0xa9e5, 0],
[0xaa28, 1],
[0xaa2e, 0],
[0xaa30, 1],
[0xaa32, 0],
[0xaa34, 1],
[0xaa36, 0],
[0xaa42, 1],
[0xaa43, 0],
[0xaa4b, 1],
[0xaa4c, 0],
[0xaa7b, 1],
[0xaa7c, 0],
[0xaaaf, 1],
[0xaab0, 0],
[0xaab1, 1],
[0xaab4, 0],
[0xaab6, 1],
[0xaab8, 0],
[0xaabd, 1],
[0xaabf, 0],
[0xaac0, 1],
[0xaac1, 0],
[0xaaeb, 1],
[0xaaed, 0],
[0xaaf5, 1],
[0xaaf6, 0],
[0xabe4, 1],
[0xabe5, 0],
[0xabe7, 1],
[0xabe8, 0],
[0xabec, 1],
[0xabed, 0],
[0xabff, 1],
[0xd7a3, 2],
[0xdfff, 1],
[0xf8ff, -1],
[0xfaff, 2],
[0xfb1d, 1],
[0xfb1e, 0],
[0xfdff, 1],
[0xfe0f, 0],
[0xfe19, 2],
[0xfe1f, 1],
[0xfe2f, 0],
[0xfe52, 2],
[0xfe53, 1],
[0xfe66, 2],
[0xfe67, 1],
[0xfe6b, 2],
[0xff00, 1],
[0xff60, 2],
[0xffdf, 1],
[0xffe6, 2],
[0xfffc, 1],
[0xfffd, -1],
[0x101fc, 1],
[0x101fd, 0],
[0x102df, 1],
[0x102e0, 0],
[0x10375, 1],
[0x1037a, 0],
[0x10a00, 1],
[0x10a03, 0],
[0x10a04, 1],
[0x10a06, 0],
[0x10a0b, 1],
[0x10a0f, 0],
[0x10a37, 1],
[0x10a3a, 0],
[0x10a3e, 1],
[0x10a3f, 0],
[0x10ae4, 1],
[0x10ae6, 0],
[0x10d23, 1],
[0x10d27, 0],
[0x10eaa, 1],
[0x10eac, 0],
[0x10efc, 1],
[0x10eff, 0],
[0x10f45, 1],
[0x10f50, 0],
[0x10f81, 1],
[0x10f85, 0],
[0x11000, 1],
[0x11001, 0],
[0x11037, 1],
[0x11046, 0],
[0x1106f, 1],
[0x11070, 0],
[0x11072, 1],
[0x11074, 0],
[0x1107e, 1],
[0x11081, 0],
[0x110b2, 1],
[0x110b6, 0],
[0x110b8, 1],
[0x110ba, 0],
[0x110c1, 1],
[0x110c2, 0],
[0x110ff, 1],
[0x11102, 0],
[0x11126, 1],
[0x1112b, 0],
[0x1112c, 1],
[0x11134, 0],
[0x11172, 1],
[0x11173, 0],
[0x1117f, 1],
[0x11181, 0],
[0x111b5, 1],
[0x111be, 0],
[0x111c8, 1],
[0x111cc, 0],
[0x111ce, 1],
[0x111cf, 0],
[0x1122e, 1],
[0x11231, 0],
[0x11233, 1],
[0x11234, 0],
[0x11235, 1],
[0x11237, 0],
[0x1123d, 1],
[0x1123e, 0],
[0x11240, 1],
[0x11241, 0],
[0x112de, 1],
[0x112df, 0],
[0x112e2, 1],
[0x112ea, 0],
[0x112ff, 1],
[0x11301, 0],
[0x1133a, 1],
[0x1133c, 0],
[0x1133f, 1],
[0x11340, 0],
[0x11365, 1],
[0x1136c, 0],
[0x1136f, 1],
[0x11374, 0],
[0x11437, 1],
[0x1143f, 0],
[0x11441, 1],
[0x11444, 0],
[0x11445, 1],
[0x11446, 0],
[0x1145d, 1],
[0x1145e, 0],
[0x114b2, 1],
[0x114b8, 0],
[0x114b9, 1],
[0x114ba, 0],
[0x114be, 1],
[0x114c0, 0],
[0x114c1, 1],
[0x114c3, 0],
[0x115b1, 1],
[0x115b5, 0],
[0x115bb, 1],
[0x115bd, 0],
[0x115be, 1],
[0x115c0, 0],
[0x115db, 1],
[0x115dd, 0],
[0x11632, 1],
[0x1163a, 0],
[0x1163c, 1],
[0x1163d, 0],
[0x1163e, 1],
[0x11640, 0],
[0x116aa, 1],
[0x116ab, 0],
[0x116ac, 1],
[0x116ad, 0],
[0x116af, 1],
[0x116b5, 0],
[0x116b6, 1],
[0x116b7, 0],
[0x1171c, 1],
[0x1171f, 0],
[0x11721, 1],
[0x11725, 0],
[0x11726, 1],
[0x1172b, 0],
[0x1182e, 1],
[0x11837, 0],
[0x11838, 1],
[0x1183a, 0],
[0x1193a, 1],
[0x1193c, 0],
[0x1193d, 1],
[0x1193e, 0],
[0x11942, 1],
[0x11943, 0],
[0x119d3, 1],
[0x119d7, 0],
[0x119d9, 1],
[0x119db, 0],
[0x119df, 1],
[0x119e0, 0],
[0x11a00, 1],
[0x11a0a, 0],
[0x11a32, 1],
[0x11a38, 0],
[0x11a3a, 1],
[0x11a3e, 0],
[0x11a46, 1],
[0x11a47, 0],
[0x11a50, 1],
[0x11a56, 0],
[0x11a58, 1],
[0x11a5b, 0],
[0x11a89, 1],
[0x11a96, 0],
[0x11a97, 1],
[0x11a99, 0],
[0x11c2f, 1],
[0x11c36, 0],
[0x11c37, 1],
[0x11c3d, 0],
[0x11c3e, 1],
[0x11c3f, 0],
[0x11c91, 1],
[0x11ca7, 0],
[0x11ca9, 1],
[0x11cb0, 0],
[0x11cb1, 1],
[0x11cb3, 0],
[0x11cb4, 1],
[0x11cb6, 0],
[0x11d30, 1],
[0x11d36, 0],
[0x11d39, 1],
[0x11d3a, 0],
[0x11d3b, 1],
[0x11d3d, 0],
[0x11d3e, 1],
[0x11d45, 0],
[0x11d46, 1],
[0x11d47, 0],
[0x11d8f, 1],
[0x11d91, 0],
[0x11d94, 1],
[0x11d95, 0],
[0x11d96, 1],
[0x11d97, 0],
[0x11ef2, 1],
[0x11ef4, 0],
[0x11eff, 1],
[0x11f01, 0],
[0x11f35, 1],
[0x11f3a, 0],
[0x11f3f, 1],
[0x11f40, 0],
[0x11f41, 1],
[0x11f42, 0],
[0x1343f, 1],
[0x13440, 0],
[0x13446, 1],
[0x13455, 0],
[0x16aef, 1],
[0x16af4, 0],
[0x16b2f, 1],
[0x16b36, 0],
[0x16f4e, 1],
[0x16f4f, 0],
[0x16f8e, 1],
[0x16f92, 0],
[0x16fdf, 1],
[0x16fe3, 2],
[0x16fe4, 0],
[0x16fef, 1],
[0x16ff1, 2],
[0x16fff, 1],
[0x187f7, 2],
[0x187ff, 1],
[0x18cd5, 2],
[0x18cff, 1],
[0x18d08, 2],
[0x1afef, 1],
[0x1aff3, 2],
[0x1aff4, 1],
[0x1affb, 2],
[0x1affc, 1],
[0x1affe, 2],
[0x1afff, 1],
[0x1b122, 2],
[0x1b131, 1],
[0x1b132, 2],
[0x1b14f, 1],
[0x1b152, 2],
[0x1b154, 1],
[0x1b155, 2],
[0x1b163, 1],
[0x1b167, 2],
[0x1b16f, 1],
[0x1b2fb, 2],
[0x1bc9c, 1],
[0x1bc9e, 0],
[0x1ceff, 1],
[0x1cf2d, 0],
[0x1cf2f, 1],
[0x1cf46, 0],
[0x1d166, 1],
[0x1d169, 0],
[0x1d17a, 1],
[0x1d182, 0],
[0x1d184, 1],
[0x1d18b, 0],
[0x1d1a9, 1],
[0x1d1ad, 0],
[0x1d241, 1],
[0x1d244, 0],
[0x1d9ff, 1],
[0x1da36, 0],
[0x1da3a, 1],
[0x1da6c, 0],
[0x1da74, 1],
[0x1da75, 0],
[0x1da83, 1],
[0x1da84, 0],
[0x1da9a, 1],
[0x1da9f, 0],
[0x1daa0, 1],
[0x1daaf, 0],
[0x1dfff, 1],
[0x1e006, 0],
[0x1e007, 1],
[0x1e018, 0],
[0x1e01a, 1],
[0x1e021, 0],
[0x1e022, 1],
[0x1e024, 0],
[0x1e025, 1],
[0x1e02a, 0],
[0x1e08e, 1],
[0x1e08f, 0],
[0x1e12f, 1],
[0x1e136, 0],
[0x1e2ad, 1],
[0x1e2ae, 0],
[0x1e2eb, 1],
[0x1e2ef, 0],
[0x1e4eb, 1],
[0x1e4ef, 0],
[0x1e8cf, 1],
[0x1e8d6, 0],
[0x1e943, 1],
[0x1e94a, 0],
[0x1f003, 1],
[0x1f004, 2],
[0x1f0ce, 1],
[0x1f0cf, 2],
[0x1f0ff, 1],
[0x1f10a, -1],
[0x1f10f, 1],
[0x1f12d, -1],
[0x1f12f, 1],
[0x1f169, -1],
[0x1f16f, 1],
[0x1f18d, -1],
[0x1f18e, 2],
[0x1f190, -1],
[0x1f19a, 2],
[0x1f1ac, -1],
[0x1f1ff, 1],
[0x1f202, 2],
[0x1f20f, 1],
[0x1f23b, 2],
[0x1f23f, 1],
[0x1f248, 2],
[0x1f24f, 1],
[0x1f251, 2],
[0x1f25f, 1],
[0x1f265, 2],
[0x1f2ff, 1],
[0x1f320, 2],
[0x1f32c, 1],
[0x1f335, 2],
[0x1f336, 1],
[0x1f37c, 2],
[0x1f37d, 1],
[0x1f393, 2],
[0x1f39f, 1],
[0x1f3ca, 2],
[0x1f3ce, 1],
[0x1f3d3, 2],
[0x1f3df, 1],
[0x1f3f0, 2],
[0x1f3f3, 1],
[0x1f3f4, 2],
[0x1f3f7, 1],
[0x1f43e, 2],
[0x1f43f, 1],
[0x1f440, 2],
[0x1f441, 1],
[0x1f4fc, 2],
[0x1f4fe, 1],
[0x1f53d, 2],
[0x1f54a, 1],
[0x1f54e, 2],
[0x1f54f, 1],
[0x1f567, 2],
[0x1f579, 1],
[0x1f57a, 2],
[0x1f594, 1],
[0x1f596, 2],
[0x1f5a3, 1],
[0x1f5a4, 2],
[0x1f5fa, 1],
[0x1f64f, 2],
[0x1f67f, 1],
[0x1f6c5, 2],
[0x1f6cb, 1],
[0x1f6cc, 2],
[0x1f6cf, 1],
[0x1f6d2, 2],
[0x1f6d4, 1],
[0x1f6d7, 2],
[0x1f6db, 1],
[0x1f6df, 2],
[0x1f6ea, 1],
[0x1f6ec, 2],
[0x1f6f3, 1],
[0x1f6fc, 2],
[0x1f7df, 1],
[0x1f7eb, 2],
[0x1f7ef, 1],
[0x1f7f0, 2],
[0x1f90b, 1],
[0x1f93a, 2],
[0x1f93b, 1],
[0x1f945, 2],
[0x1f946, 1],
[0x1f9ff, 2],
[0x1fa6f, 1],
[0x1fa7c, 2],
[0x1fa7f, 1],
[0x1fa88, 2],
[0x1fa8f, 1],
[0x1fabd, 2],
[0x1fabe, 1],
[0x1fac5, 2],
[0x1facd, 1],
[0x1fadb, 2],
[0x1fadf, 1],
[0x1fae8, 2],
[0x1faef, 1],
[0x1faf8, 2],
[0x1ffff, 1],
[0x2fffd, 2],
[0x2ffff, 1],
[0x3fffd, 2],
[0xe00ff, 1],
[0xe01ef, 0],
[0xeffff, 1],
[0xffffd, -1],
[0xfffff, 1],
[0x10fffd, -1],
[0x7fffffff, 1]
].transpose.map(&:freeze)
end
share/ruby/reline/face.rb 0000644 00000011444 15173517736 0011353 0 ustar 00 # frozen_string_literal: true
class Reline::Face
SGR_PARAMETERS = {
foreground: {
black: 30,
red: 31,
green: 32,
yellow: 33,
blue: 34,
magenta: 35,
cyan: 36,
white: 37,
bright_black: 90,
gray: 90,
bright_red: 91,
bright_green: 92,
bright_yellow: 93,
bright_blue: 94,
bright_magenta: 95,
bright_cyan: 96,
bright_white: 97
},
background: {
black: 40,
red: 41,
green: 42,
yellow: 43,
blue: 44,
magenta: 45,
cyan: 46,
white: 47,
bright_black: 100,
gray: 100,
bright_red: 101,
bright_green: 102,
bright_yellow: 103,
bright_blue: 104,
bright_magenta: 105,
bright_cyan: 106,
bright_white: 107,
},
style: {
reset: 0,
bold: 1,
faint: 2,
italicized: 3,
underlined: 4,
slowly_blinking: 5,
blinking: 5,
rapidly_blinking: 6,
negative: 7,
concealed: 8,
crossed_out: 9
}
}.freeze
class Config
ESSENTIAL_DEFINE_NAMES = %i(default enhanced scrollbar).freeze
RESET_SGR = "\e[0m".freeze
def initialize(name, &block)
@definition = {}
block.call(self)
ESSENTIAL_DEFINE_NAMES.each do |name|
@definition[name] ||= { style: :reset, escape_sequence: RESET_SGR }
end
end
attr_reader :definition
def define(name, **values)
values[:escape_sequence] = format_to_sgr(values.to_a).freeze
@definition[name] = values
end
def reconfigure
@definition.each_value do |values|
values.delete(:escape_sequence)
values[:escape_sequence] = format_to_sgr(values.to_a).freeze
end
end
def [](name)
@definition.dig(name, :escape_sequence) or raise ArgumentError, "unknown face: #{name}"
end
private
def sgr_rgb(key, value)
return nil unless rgb_expression?(value)
if Reline::Face.truecolor?
sgr_rgb_truecolor(key, value)
else
sgr_rgb_256color(key, value)
end
end
def sgr_rgb_truecolor(key, value)
case key
when :foreground
"38;2;"
when :background
"48;2;"
end + value[1, 6].scan(/../).map(&:hex).join(";")
end
def sgr_rgb_256color(key, value)
# 256 colors are
# 0..15: standard colors, high intensity colors
# 16..232: 216 colors (R, G, B each 6 steps)
# 233..255: grayscale colors (24 steps)
# This methods converts rgb_expression to 216 colors
rgb = value[1, 6].scan(/../).map(&:hex)
# Color steps are [0, 95, 135, 175, 215, 255]
r, g, b = rgb.map { |v| v <= 95 ? v / 48 : (v - 35) / 40 }
color = (16 + 36 * r + 6 * g + b)
case key
when :foreground
"38;5;#{color}"
when :background
"48;5;#{color}"
end
end
def format_to_sgr(ordered_values)
sgr = "\e[" + ordered_values.map do |key_value|
key, value = key_value
case key
when :foreground, :background
case value
when Symbol
SGR_PARAMETERS[key][value]
when String
sgr_rgb(key, value)
end
when :style
[ value ].flatten.map do |style_name|
SGR_PARAMETERS[:style][style_name]
end.then do |sgr_parameters|
sgr_parameters.include?(nil) ? nil : sgr_parameters
end
end.then do |rendition_expression|
unless rendition_expression
raise ArgumentError, "invalid SGR parameter: #{value.inspect}"
end
rendition_expression
end
end.join(';') + "m"
sgr == RESET_SGR ? RESET_SGR : RESET_SGR + sgr
end
def rgb_expression?(color)
color.respond_to?(:match?) and color.match?(/\A#[0-9a-fA-F]{6}\z/)
end
end
private_constant :SGR_PARAMETERS, :Config
def self.truecolor?
@force_truecolor || %w[truecolor 24bit].include?(ENV['COLORTERM'])
end
def self.force_truecolor
@force_truecolor = true
@configs&.each_value(&:reconfigure)
end
def self.[](name)
@configs[name]
end
def self.config(name, &block)
@configs ||= {}
@configs[name] = Config.new(name, &block)
end
def self.configs
@configs.transform_values(&:definition)
end
def self.load_initial_configs
config(:default) do |conf|
conf.define :default, style: :reset
conf.define :enhanced, style: :reset
conf.define :scrollbar, style: :reset
end
config(:completion_dialog) do |conf|
conf.define :default, foreground: :bright_white, background: :gray
conf.define :enhanced, foreground: :black, background: :white
conf.define :scrollbar, foreground: :white, background: :gray
end
end
def self.reset_to_initial_configs
@configs = {}
load_initial_configs
end
end
share/ruby/reline/key_actor.rb 0000644 00000000316 15173517736 0012431 0 ustar 00 module Reline::KeyActor
end
require 'reline/key_actor/base'
require 'reline/key_actor/composite'
require 'reline/key_actor/emacs'
require 'reline/key_actor/vi_command'
require 'reline/key_actor/vi_insert'
share/ruby/reline/key_stroke.rb 0000644 00000005541 15173517736 0012635 0 ustar 00 class Reline::KeyStroke
ESC_BYTE = 27
CSI_PARAMETER_BYTES_RANGE = 0x30..0x3f
CSI_INTERMEDIATE_BYTES_RANGE = (0x20..0x2f)
def initialize(config)
@config = config
end
# Input exactly matches to a key sequence
MATCHING = :matching
# Input partially matches to a key sequence
MATCHED = :matched
# Input matches to a key sequence and the key sequence is a prefix of another key sequence
MATCHING_MATCHED = :matching_matched
# Input does not match to any key sequence
UNMATCHED = :unmatched
def match_status(input)
matching = key_mapping.matching?(input)
matched = key_mapping.get(input)
# FIXME: Workaround for single byte. remove this after MAPPING is merged into KeyActor.
matched ||= input.size == 1
matching ||= input == [ESC_BYTE]
if matching && matched
MATCHING_MATCHED
elsif matching
MATCHING
elsif matched
MATCHED
elsif input[0] == ESC_BYTE
match_unknown_escape_sequence(input, vi_mode: @config.editing_mode_is?(:vi_insert, :vi_command))
elsif input.size == 1
MATCHED
else
UNMATCHED
end
end
def expand(input)
matched_bytes = nil
(1..input.size).each do |i|
bytes = input.take(i)
status = match_status(bytes)
matched_bytes = bytes if status == MATCHED || status == MATCHING_MATCHED
end
return [[], []] unless matched_bytes
func = key_mapping.get(matched_bytes)
if func.is_a?(Array)
keys = func.map { |c| Reline::Key.new(c, c, false) }
elsif func
keys = [Reline::Key.new(func, func, false)]
elsif matched_bytes.size == 1
keys = [Reline::Key.new(matched_bytes.first, matched_bytes.first, false)]
elsif matched_bytes.size == 2 && matched_bytes[0] == ESC_BYTE
keys = [Reline::Key.new(matched_bytes[1], matched_bytes[1] | 0b10000000, true)]
else
keys = []
end
[keys, input.drop(matched_bytes.size)]
end
private
# returns match status of CSI/SS3 sequence and matched length
def match_unknown_escape_sequence(input, vi_mode: false)
idx = 0
return UNMATCHED unless input[idx] == ESC_BYTE
idx += 1
idx += 1 if input[idx] == ESC_BYTE
case input[idx]
when nil
if idx == 1 # `ESC`
return MATCHING_MATCHED
else # `ESC ESC`
return MATCHING
end
when 91 # == '['.ord
# CSI sequence `ESC [ ... char`
idx += 1
idx += 1 while idx < input.size && CSI_PARAMETER_BYTES_RANGE.cover?(input[idx])
idx += 1 while idx < input.size && CSI_INTERMEDIATE_BYTES_RANGE.cover?(input[idx])
when 79 # == 'O'.ord
# SS3 sequence `ESC O char`
idx += 1
else
# `ESC char` or `ESC ESC char`
return UNMATCHED if vi_mode
end
case input.size
when idx
MATCHING
when idx + 1
MATCHED
else
UNMATCHED
end
end
def key_mapping
@config.key_bindings
end
end
share/ruby/reline/terminfo.rb 0000644 00000011071 15173517736 0012274 0 ustar 00 begin
# Ignore warning `Add fiddle to your Gemfile or gemspec` in Ruby 3.4.
# terminfo.rb and ansi.rb supports fiddle unavailable environment.
verbose, $VERBOSE = $VERBOSE, nil
require 'fiddle'
require 'fiddle/import'
rescue LoadError
module Reline::Terminfo
def self.curses_dl
false
end
end
ensure
$VERBOSE = verbose
end
module Reline::Terminfo
extend Fiddle::Importer
class TerminfoError < StandardError; end
def self.curses_dl_files
case RUBY_PLATFORM
when /mingw/, /mswin/
# aren't supported
[]
when /cygwin/
%w[cygncursesw-10.dll cygncurses-10.dll]
when /darwin/
%w[libncursesw.dylib libcursesw.dylib libncurses.dylib libcurses.dylib]
else
%w[libncursesw.so libcursesw.so libncurses.so libcurses.so]
end
end
@curses_dl = false
def self.curses_dl
return @curses_dl unless @curses_dl == false
if Fiddle.const_defined?(:TYPE_VARIADIC)
curses_dl_files.each do |curses_name|
result = Fiddle::Handle.new(curses_name)
rescue Fiddle::DLError
next
else
@curses_dl = result
break
end
end
@curses_dl = nil if @curses_dl == false
@curses_dl
end
end if not Reline.const_defined?(:Terminfo) or not Reline::Terminfo.respond_to?(:curses_dl)
module Reline::Terminfo
dlload curses_dl
#extern 'int setupterm(char *term, int fildes, int *errret)'
@setupterm = Fiddle::Function.new(curses_dl['setupterm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_INT, Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
#extern 'char *tigetstr(char *capname)'
@tigetstr = Fiddle::Function.new(curses_dl['tigetstr'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_VOIDP)
begin
#extern 'char *tiparm(const char *str, ...)'
@tiparm = Fiddle::Function.new(curses_dl['tiparm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VARIADIC], Fiddle::TYPE_VOIDP)
rescue Fiddle::DLError
# OpenBSD lacks tiparm
#extern 'char *tparm(const char *str, ...)'
@tiparm = Fiddle::Function.new(curses_dl['tparm'], [Fiddle::TYPE_VOIDP, Fiddle::TYPE_VARIADIC], Fiddle::TYPE_VOIDP)
end
begin
#extern 'int tigetflag(char *str)'
@tigetflag = Fiddle::Function.new(curses_dl['tigetflag'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
rescue Fiddle::DLError
# OpenBSD lacks tigetflag
#extern 'int tgetflag(char *str)'
@tigetflag = Fiddle::Function.new(curses_dl['tgetflag'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
end
begin
#extern 'int tigetnum(char *str)'
@tigetnum = Fiddle::Function.new(curses_dl['tigetnum'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
rescue Fiddle::DLError
# OpenBSD lacks tigetnum
#extern 'int tgetnum(char *str)'
@tigetnum = Fiddle::Function.new(curses_dl['tgetnum'], [Fiddle::TYPE_VOIDP], Fiddle::TYPE_INT)
end
def self.setupterm(term, fildes)
errret_int = Fiddle::Pointer.malloc(Fiddle::SIZEOF_INT, Fiddle::RUBY_FREE)
ret = @setupterm.(term, fildes, errret_int)
case ret
when 0 # OK
@term_supported = true
when -1 # ERR
@term_supported = false
end
end
class StringWithTiparm < String
def tiparm(*args) # for method chain
Reline::Terminfo.tiparm(self, *args)
end
end
def self.tigetstr(capname)
raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
capability = @tigetstr.(capname)
case capability.to_i
when 0, -1
raise TerminfoError, "can't find capability: #{capname}"
end
StringWithTiparm.new(capability.to_s)
end
def self.tiparm(str, *args)
new_args = []
args.each do |a|
new_args << Fiddle::TYPE_INT << a
end
@tiparm.(str, *new_args).to_s
end
def self.tigetflag(capname)
raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
flag = @tigetflag.(capname).to_i
case flag
when -1
raise TerminfoError, "not boolean capability: #{capname}"
when 0
raise TerminfoError, "can't find capability: #{capname}"
end
flag
end
def self.tigetnum(capname)
raise TerminfoError, "capname is not String: #{capname.inspect}" unless capname.is_a?(String)
num = @tigetnum.(capname).to_i
case num
when -2
raise TerminfoError, "not numeric capability: #{capname}"
when -1
raise TerminfoError, "can't find capability: #{capname}"
end
num
end
# NOTE: This means Fiddle and curses are enabled.
def self.enabled?
true
end
def self.term_supported?
@term_supported
end
end if Reline::Terminfo.curses_dl
module Reline::Terminfo
def self.enabled?
false
end
end unless Reline::Terminfo.curses_dl
share/ruby/reline/version.rb 0000644 00000000047 15173517736 0012137 0 ustar 00 module Reline
VERSION = '0.5.10'
end
share/ruby/reline/line_editor.rb 0000644 00000242662 15173517736 0012762 0 ustar 00 require 'reline/kill_ring'
require 'reline/unicode'
require 'tempfile'
class Reline::LineEditor
# TODO: Use "private alias_method" idiom after drop Ruby 2.5.
attr_reader :byte_pointer
attr_accessor :confirm_multiline_termination_proc
attr_accessor :completion_proc
attr_accessor :completion_append_character
attr_accessor :output_modifier_proc
attr_accessor :prompt_proc
attr_accessor :auto_indent_proc
attr_accessor :dig_perfect_match_proc
attr_writer :output
VI_MOTIONS = %i{
ed_prev_char
ed_next_char
vi_zero
ed_move_to_beg
ed_move_to_end
vi_to_column
vi_next_char
vi_prev_char
vi_next_word
vi_prev_word
vi_to_next_char
vi_to_prev_char
vi_end_word
vi_next_big_word
vi_prev_big_word
vi_end_big_word
}
module CompletionState
NORMAL = :normal
COMPLETION = :completion
MENU = :menu
MENU_WITH_PERFECT_MATCH = :menu_with_perfect_match
PERFECT_MATCH = :perfect_match
end
RenderedScreen = Struct.new(:base_y, :lines, :cursor_y, keyword_init: true)
CompletionJourneyState = Struct.new(:line_index, :pre, :target, :post, :list, :pointer)
NullActionState = [nil, nil].freeze
class MenuInfo
attr_reader :list
def initialize(list)
@list = list
end
def lines(screen_width)
return [] if @list.empty?
list = @list.sort
sizes = list.map { |item| Reline::Unicode.calculate_width(item) }
item_width = sizes.max + 2
num_cols = [screen_width / item_width, 1].max
num_rows = list.size.fdiv(num_cols).ceil
list_with_padding = list.zip(sizes).map { |item, size| item + ' ' * (item_width - size) }
aligned = (list_with_padding + [nil] * (num_rows * num_cols - list_with_padding.size)).each_slice(num_rows).to_a.transpose
aligned.map do |row|
row.join.rstrip
end
end
end
MINIMUM_SCROLLBAR_HEIGHT = 1
def initialize(config, encoding)
@config = config
@completion_append_character = ''
@screen_size = [0, 0] # Should be initialized with actual winsize in LineEditor#reset
reset_variables(encoding: encoding)
end
def io_gate
Reline::IOGate
end
def set_pasting_state(in_pasting)
# While pasting, text to be inserted is stored to @continuous_insertion_buffer.
# After pasting, this buffer should be force inserted.
process_insert(force: true) if @in_pasting && !in_pasting
@in_pasting = in_pasting
end
private def check_mode_string
if @config.show_mode_in_prompt
if @config.editing_mode_is?(:vi_command)
@config.vi_cmd_mode_string
elsif @config.editing_mode_is?(:vi_insert)
@config.vi_ins_mode_string
elsif @config.editing_mode_is?(:emacs)
@config.emacs_mode_string
else
'?'
end
end
end
private def check_multiline_prompt(buffer, mode_string)
if @vi_arg
prompt = "(arg: #{@vi_arg}) "
elsif @searching_prompt
prompt = @searching_prompt
else
prompt = @prompt
end
if !@is_multiline
mode_string = check_mode_string
prompt = mode_string + prompt if mode_string
[prompt] + [''] * (buffer.size - 1)
elsif @prompt_proc
prompt_list = @prompt_proc.(buffer).map { |pr| pr.gsub("\n", "\\n") }
prompt_list.map!{ prompt } if @vi_arg or @searching_prompt
prompt_list = [prompt] if prompt_list.empty?
prompt_list = prompt_list.map{ |pr| mode_string + pr } if mode_string
prompt = prompt_list[@line_index]
prompt = prompt_list[0] if prompt.nil?
prompt = prompt_list.last if prompt.nil?
if buffer.size > prompt_list.size
(buffer.size - prompt_list.size).times do
prompt_list << prompt_list.last
end
end
prompt_list
else
prompt = mode_string + prompt if mode_string
[prompt] * buffer.size
end
end
def reset(prompt = '', encoding:)
@screen_size = Reline::IOGate.get_screen_size
reset_variables(prompt, encoding: encoding)
@rendered_screen.base_y = Reline::IOGate.cursor_pos.y
if ENV.key?('RELINE_ALT_SCROLLBAR')
@full_block = '::'
@upper_half_block = "''"
@lower_half_block = '..'
@block_elem_width = 2
elsif Reline::IOGate.win?
@full_block = '█'
@upper_half_block = '▀'
@lower_half_block = '▄'
@block_elem_width = 1
elsif @encoding == Encoding::UTF_8
@full_block = '█'
@upper_half_block = '▀'
@lower_half_block = '▄'
@block_elem_width = Reline::Unicode.calculate_width('█')
else
@full_block = '::'
@upper_half_block = "''"
@lower_half_block = '..'
@block_elem_width = 2
end
end
def handle_signal
handle_interrupted
handle_resized
end
private def handle_resized
return unless @resized
@screen_size = Reline::IOGate.get_screen_size
@resized = false
scroll_into_view
Reline::IOGate.move_cursor_up @rendered_screen.cursor_y
@rendered_screen.base_y = Reline::IOGate.cursor_pos.y
clear_rendered_screen_cache
render
end
private def handle_interrupted
return unless @interrupted
@interrupted = false
clear_dialogs
render
cursor_to_bottom_offset = @rendered_screen.lines.size - @rendered_screen.cursor_y
Reline::IOGate.scroll_down cursor_to_bottom_offset
Reline::IOGate.move_cursor_column 0
clear_rendered_screen_cache
case @old_trap
when 'DEFAULT', 'SYSTEM_DEFAULT'
raise Interrupt
when 'IGNORE'
# Do nothing
when 'EXIT'
exit
else
@old_trap.call if @old_trap.respond_to?(:call)
end
end
def set_signal_handlers
Reline::IOGate.set_winch_handler do
@resized = true
end
@old_trap = Signal.trap('INT') do
@interrupted = true
end
end
def finalize
Signal.trap('INT', @old_trap)
end
def eof?
@eof
end
def reset_variables(prompt = '', encoding:)
@prompt = prompt.gsub("\n", "\\n")
@mark_pointer = nil
@encoding = encoding
@is_multiline = false
@finished = false
@history_pointer = nil
@kill_ring ||= Reline::KillRing.new
@vi_clipboard = ''
@vi_arg = nil
@waiting_proc = nil
@vi_waiting_operator = nil
@vi_waiting_operator_arg = nil
@completion_journey_state = nil
@completion_state = CompletionState::NORMAL
@perfect_matched = nil
@menu_info = nil
@searching_prompt = nil
@just_cursor_moving = false
@eof = false
@continuous_insertion_buffer = String.new(encoding: @encoding)
@scroll_partial_screen = 0
@drop_terminate_spaces = false
@in_pasting = false
@auto_indent_proc = nil
@dialogs = []
@interrupted = false
@resized = false
@cache = {}
@rendered_screen = RenderedScreen.new(base_y: 0, lines: [], cursor_y: 0)
@input_lines = [[[""], 0, 0]]
@input_lines_position = 0
@undoing = false
@prev_action_state = NullActionState
@next_action_state = NullActionState
reset_line
end
def reset_line
@byte_pointer = 0
@buffer_of_lines = [String.new(encoding: @encoding)]
@line_index = 0
@cache.clear
@line_backup_in_history = nil
@multibyte_buffer = String.new(encoding: 'ASCII-8BIT')
end
def multiline_on
@is_multiline = true
end
def multiline_off
@is_multiline = false
end
private def insert_new_line(cursor_line, next_line)
@buffer_of_lines.insert(@line_index + 1, String.new(next_line, encoding: @encoding))
@buffer_of_lines[@line_index] = cursor_line
@line_index += 1
@byte_pointer = 0
if @auto_indent_proc && !@in_pasting
if next_line.empty?
(
# For compatibility, use this calculation instead of just `process_auto_indent @line_index - 1, cursor_dependent: false`
indent1 = @auto_indent_proc.(@buffer_of_lines.take(@line_index - 1).push(''), @line_index - 1, 0, true)
indent2 = @auto_indent_proc.(@buffer_of_lines.take(@line_index), @line_index - 1, @buffer_of_lines[@line_index - 1].bytesize, false)
indent = indent2 || indent1
@buffer_of_lines[@line_index - 1] = ' ' * indent + @buffer_of_lines[@line_index - 1].gsub(/\A\s*/, '')
)
process_auto_indent @line_index, add_newline: true
else
process_auto_indent @line_index - 1, cursor_dependent: false
process_auto_indent @line_index, add_newline: true # Need for compatibility
process_auto_indent @line_index, cursor_dependent: false
end
end
end
private def split_by_width(str, max_width, offset: 0)
Reline::Unicode.split_by_width(str, max_width, @encoding, offset: offset)
end
def current_byte_pointer_cursor
calculate_width(current_line.byteslice(0, @byte_pointer))
end
private def calculate_nearest_cursor(cursor)
line_to_calc = current_line
new_cursor_max = calculate_width(line_to_calc)
new_cursor = 0
new_byte_pointer = 0
height = 1
max_width = screen_width
if @config.editing_mode_is?(:vi_command)
last_byte_size = Reline::Unicode.get_prev_mbchar_size(line_to_calc, line_to_calc.bytesize)
if last_byte_size > 0
last_mbchar = line_to_calc.byteslice(line_to_calc.bytesize - last_byte_size, last_byte_size)
last_width = Reline::Unicode.get_mbchar_width(last_mbchar)
end_of_line_cursor = new_cursor_max - last_width
else
end_of_line_cursor = new_cursor_max
end
else
end_of_line_cursor = new_cursor_max
end
line_to_calc.grapheme_clusters.each do |gc|
mbchar = gc.encode(Encoding::UTF_8)
mbchar_width = Reline::Unicode.get_mbchar_width(mbchar)
now = new_cursor + mbchar_width
if now > end_of_line_cursor or now > cursor
break
end
new_cursor += mbchar_width
if new_cursor > max_width * height
height += 1
end
new_byte_pointer += gc.bytesize
end
@byte_pointer = new_byte_pointer
end
def with_cache(key, *deps)
cached_deps, value = @cache[key]
if cached_deps != deps
@cache[key] = [deps, value = yield(*deps, cached_deps, value)]
end
value
end
def modified_lines
with_cache(__method__, whole_lines, finished?) do |whole, complete|
modify_lines(whole, complete)
end
end
def prompt_list
with_cache(__method__, whole_lines, check_mode_string, @vi_arg, @searching_prompt) do |lines, mode_string|
check_multiline_prompt(lines, mode_string)
end
end
def screen_height
@screen_size.first
end
def screen_width
@screen_size.last
end
def screen_scroll_top
@scroll_partial_screen
end
def wrapped_prompt_and_input_lines
with_cache(__method__, @buffer_of_lines.size, modified_lines, prompt_list, screen_width) do |n, lines, prompts, width, prev_cache_key, cached_value|
prev_n, prev_lines, prev_prompts, prev_width = prev_cache_key
cached_wraps = {}
if prev_width == width
prev_n.times do |i|
cached_wraps[[prev_prompts[i], prev_lines[i]]] = cached_value[i]
end
end
n.times.map do |i|
prompt = prompts[i] || ''
line = lines[i] || ''
if (cached = cached_wraps[[prompt, line]])
next cached
end
*wrapped_prompts, code_line_prompt = split_by_width(prompt, width).first.compact
wrapped_lines = split_by_width(line, width, offset: calculate_width(code_line_prompt, true)).first.compact
wrapped_prompts.map { |p| [p, ''] } + [[code_line_prompt, wrapped_lines.first]] + wrapped_lines.drop(1).map { |c| ['', c] }
end
end
end
def calculate_overlay_levels(overlay_levels)
levels = []
overlay_levels.each do |x, w, l|
levels.fill(l, x, w)
end
levels
end
def render_line_differential(old_items, new_items)
old_levels = calculate_overlay_levels(old_items.zip(new_items).each_with_index.map {|((x, w, c), (nx, _nw, nc)), i| [x, w, c == nc && x == nx ? i : -1] if x }.compact)
new_levels = calculate_overlay_levels(new_items.each_with_index.map { |(x, w), i| [x, w, i] if x }.compact).take(screen_width)
base_x = 0
new_levels.zip(old_levels).chunk { |n, o| n == o ? :skip : n || :blank }.each do |level, chunk|
width = chunk.size
if level == :skip
# do nothing
elsif level == :blank
Reline::IOGate.move_cursor_column base_x
@output.write "#{Reline::IOGate.reset_color_sequence}#{' ' * width}"
else
x, w, content = new_items[level]
cover_begin = base_x != 0 && new_levels[base_x - 1] == level
cover_end = new_levels[base_x + width] == level
pos = 0
unless x == base_x && w == width
content, pos = Reline::Unicode.take_mbchar_range(content, base_x - x, width, cover_begin: cover_begin, cover_end: cover_end, padding: true)
end
Reline::IOGate.move_cursor_column x + pos
@output.write "#{Reline::IOGate.reset_color_sequence}#{content}#{Reline::IOGate.reset_color_sequence}"
end
base_x += width
end
if old_levels.size > new_levels.size
Reline::IOGate.move_cursor_column new_levels.size
Reline::IOGate.erase_after_cursor
end
end
# Calculate cursor position in word wrapped content.
def wrapped_cursor_position
prompt_width = calculate_width(prompt_list[@line_index], true)
line_before_cursor = whole_lines[@line_index].byteslice(0, @byte_pointer)
wrapped_line_before_cursor = split_by_width(' ' * prompt_width + line_before_cursor, screen_width).first.compact
wrapped_cursor_y = wrapped_prompt_and_input_lines[0...@line_index].sum(&:size) + wrapped_line_before_cursor.size - 1
wrapped_cursor_x = calculate_width(wrapped_line_before_cursor.last)
[wrapped_cursor_x, wrapped_cursor_y]
end
def clear_dialogs
@dialogs.each do |dialog|
dialog.contents = nil
dialog.trap_key = nil
end
end
def update_dialogs(key = nil)
wrapped_cursor_x, wrapped_cursor_y = wrapped_cursor_position
@dialogs.each do |dialog|
dialog.trap_key = nil
update_each_dialog(dialog, wrapped_cursor_x, wrapped_cursor_y - screen_scroll_top, key)
end
end
def render_finished
render_differential([], 0, 0)
lines = @buffer_of_lines.size.times.map do |i|
line = prompt_list[i] + modified_lines[i]
wrapped_lines, = split_by_width(line, screen_width)
wrapped_lines.last.empty? ? "#{line} " : line
end
@output.puts lines.map { |l| "#{l}\r\n" }.join
end
def print_nomultiline_prompt
# Readline's test `TestRelineAsReadline#test_readline` requires first output to be prompt, not cursor reset escape sequence.
@output.write @prompt if @prompt && !@is_multiline
end
def render
wrapped_cursor_x, wrapped_cursor_y = wrapped_cursor_position
new_lines = wrapped_prompt_and_input_lines.flatten(1)[screen_scroll_top, screen_height].map do |prompt, line|
prompt_width = Reline::Unicode.calculate_width(prompt, true)
[[0, prompt_width, prompt], [prompt_width, Reline::Unicode.calculate_width(line, true), line]]
end
if @menu_info
@menu_info.lines(screen_width).each do |item|
new_lines << [[0, Reline::Unicode.calculate_width(item), item]]
end
@menu_info = nil # TODO: do not change state here
end
@dialogs.each_with_index do |dialog, index|
next unless dialog.contents
x_range, y_range = dialog_range dialog, wrapped_cursor_y - screen_scroll_top
y_range.each do |row|
next if row < 0 || row >= screen_height
dialog_rows = new_lines[row] ||= []
# index 0 is for prompt, index 1 is for line, index 2.. is for dialog
dialog_rows[index + 2] = [x_range.begin, dialog.width, dialog.contents[row - y_range.begin]]
end
end
render_differential new_lines, wrapped_cursor_x, wrapped_cursor_y - screen_scroll_top
end
# Reflects lines to be rendered and new cursor position to the screen
# by calculating the difference from the previous render.
private def render_differential(new_lines, new_cursor_x, new_cursor_y)
rendered_lines = @rendered_screen.lines
cursor_y = @rendered_screen.cursor_y
if new_lines != rendered_lines
# Hide cursor while rendering to avoid cursor flickering.
Reline::IOGate.hide_cursor
num_lines = [[new_lines.size, rendered_lines.size].max, screen_height].min
if @rendered_screen.base_y + num_lines > screen_height
Reline::IOGate.scroll_down(num_lines - cursor_y - 1)
@rendered_screen.base_y = screen_height - num_lines
cursor_y = num_lines - 1
end
num_lines.times do |i|
rendered_line = rendered_lines[i] || []
line_to_render = new_lines[i] || []
next if rendered_line == line_to_render
Reline::IOGate.move_cursor_down i - cursor_y
cursor_y = i
unless rendered_lines[i]
Reline::IOGate.move_cursor_column 0
Reline::IOGate.erase_after_cursor
end
render_line_differential(rendered_line, line_to_render)
end
@rendered_screen.lines = new_lines
Reline::IOGate.show_cursor
end
Reline::IOGate.move_cursor_column new_cursor_x
Reline::IOGate.move_cursor_down new_cursor_y - cursor_y
@rendered_screen.cursor_y = new_cursor_y
end
private def clear_rendered_screen_cache
@rendered_screen.lines = []
@rendered_screen.cursor_y = 0
end
def upper_space_height(wrapped_cursor_y)
wrapped_cursor_y - screen_scroll_top
end
def rest_height(wrapped_cursor_y)
screen_height - wrapped_cursor_y + screen_scroll_top - @rendered_screen.base_y - 1
end
def rerender
render unless @in_pasting
end
class DialogProcScope
CompletionJourneyData = Struct.new(:preposing, :postposing, :list, :pointer)
def initialize(line_editor, config, proc_to_exec, context)
@line_editor = line_editor
@config = config
@proc_to_exec = proc_to_exec
@context = context
@cursor_pos = Reline::CursorPos.new
end
def context
@context
end
def retrieve_completion_block(set_completion_quote_character = false)
@line_editor.retrieve_completion_block(set_completion_quote_character)
end
def call_completion_proc_with_checking_args(pre, target, post)
@line_editor.call_completion_proc_with_checking_args(pre, target, post)
end
def set_dialog(dialog)
@dialog = dialog
end
def dialog
@dialog
end
def set_cursor_pos(col, row)
@cursor_pos.x = col
@cursor_pos.y = row
end
def set_key(key)
@key = key
end
def key
@key
end
def cursor_pos
@cursor_pos
end
def just_cursor_moving
@line_editor.instance_variable_get(:@just_cursor_moving)
end
def screen_width
@line_editor.screen_width
end
def screen_height
@line_editor.screen_height
end
def preferred_dialog_height
_wrapped_cursor_x, wrapped_cursor_y = @line_editor.wrapped_cursor_position
[@line_editor.upper_space_height(wrapped_cursor_y), @line_editor.rest_height(wrapped_cursor_y), (screen_height + 6) / 5].max
end
def completion_journey_data
@line_editor.dialog_proc_scope_completion_journey_data
end
def config
@config
end
def call
instance_exec(&@proc_to_exec)
end
end
class Dialog
attr_reader :name, :contents, :width
attr_accessor :scroll_top, :pointer, :column, :vertical_offset, :trap_key
def initialize(name, config, proc_scope)
@name = name
@config = config
@proc_scope = proc_scope
@width = nil
@scroll_top = 0
@trap_key = nil
end
def set_cursor_pos(col, row)
@proc_scope.set_cursor_pos(col, row)
end
def width=(v)
@width = v
end
def contents=(contents)
@contents = contents
if contents and @width.nil?
@width = contents.map{ |line| Reline::Unicode.calculate_width(line, true) }.max
end
end
def call(key)
@proc_scope.set_dialog(self)
@proc_scope.set_key(key)
dialog_render_info = @proc_scope.call
if @trap_key
if @trap_key.any?{ |i| i.is_a?(Array) } # multiple trap
@trap_key.each do |t|
@config.add_oneshot_key_binding(t, @name)
end
else
@config.add_oneshot_key_binding(@trap_key, @name)
end
end
dialog_render_info
end
end
def add_dialog_proc(name, p, context = nil)
dialog = Dialog.new(name, @config, DialogProcScope.new(self, @config, p, context))
if index = @dialogs.find_index { |d| d.name == name }
@dialogs[index] = dialog
else
@dialogs << dialog
end
end
DIALOG_DEFAULT_HEIGHT = 20
private def dialog_range(dialog, dialog_y)
x_range = dialog.column...dialog.column + dialog.width
y_range = dialog_y + dialog.vertical_offset...dialog_y + dialog.vertical_offset + dialog.contents.size
[x_range, y_range]
end
private def update_each_dialog(dialog, cursor_column, cursor_row, key = nil)
dialog.set_cursor_pos(cursor_column, cursor_row)
dialog_render_info = dialog.call(key)
if dialog_render_info.nil? or dialog_render_info.contents.nil? or dialog_render_info.contents.empty?
dialog.contents = nil
dialog.trap_key = nil
return
end
contents = dialog_render_info.contents
pointer = dialog.pointer
if dialog_render_info.width
dialog.width = dialog_render_info.width
else
dialog.width = contents.map { |l| calculate_width(l, true) }.max
end
height = dialog_render_info.height || DIALOG_DEFAULT_HEIGHT
height = contents.size if contents.size < height
if contents.size > height
if dialog.pointer
if dialog.pointer < 0
dialog.scroll_top = 0
elsif (dialog.pointer - dialog.scroll_top) >= (height - 1)
dialog.scroll_top = dialog.pointer - (height - 1)
elsif (dialog.pointer - dialog.scroll_top) < 0
dialog.scroll_top = dialog.pointer
end
pointer = dialog.pointer - dialog.scroll_top
else
dialog.scroll_top = 0
end
contents = contents[dialog.scroll_top, height]
end
if dialog_render_info.scrollbar and dialog_render_info.contents.size > height
bar_max_height = height * 2
moving_distance = (dialog_render_info.contents.size - height) * 2
position_ratio = dialog.scroll_top.zero? ? 0.0 : ((dialog.scroll_top * 2).to_f / moving_distance)
bar_height = (bar_max_height * ((contents.size * 2).to_f / (dialog_render_info.contents.size * 2))).floor.to_i
bar_height = MINIMUM_SCROLLBAR_HEIGHT if bar_height < MINIMUM_SCROLLBAR_HEIGHT
scrollbar_pos = ((bar_max_height - bar_height) * position_ratio).floor.to_i
else
scrollbar_pos = nil
end
dialog.column = dialog_render_info.pos.x
dialog.width += @block_elem_width if scrollbar_pos
diff = (dialog.column + dialog.width) - screen_width
if diff > 0
dialog.column -= diff
end
if rest_height(screen_scroll_top + cursor_row) - dialog_render_info.pos.y >= height
dialog.vertical_offset = dialog_render_info.pos.y + 1
elsif cursor_row >= height
dialog.vertical_offset = dialog_render_info.pos.y - height
else
dialog.vertical_offset = dialog_render_info.pos.y + 1
end
if dialog.column < 0
dialog.column = 0
dialog.width = screen_width
end
face = Reline::Face[dialog_render_info.face || :default]
scrollbar_sgr = face[:scrollbar]
default_sgr = face[:default]
enhanced_sgr = face[:enhanced]
dialog.contents = contents.map.with_index do |item, i|
line_sgr = i == pointer ? enhanced_sgr : default_sgr
str_width = dialog.width - (scrollbar_pos.nil? ? 0 : @block_elem_width)
str, = Reline::Unicode.take_mbchar_range(item, 0, str_width, padding: true)
colored_content = "#{line_sgr}#{str}"
if scrollbar_pos
if scrollbar_pos <= (i * 2) and (i * 2 + 1) < (scrollbar_pos + bar_height)
colored_content + scrollbar_sgr + @full_block
elsif scrollbar_pos <= (i * 2) and (i * 2) < (scrollbar_pos + bar_height)
colored_content + scrollbar_sgr + @upper_half_block
elsif scrollbar_pos <= (i * 2 + 1) and (i * 2) < (scrollbar_pos + bar_height)
colored_content + scrollbar_sgr + @lower_half_block
else
colored_content + scrollbar_sgr + ' ' * @block_elem_width
end
else
colored_content
end
end
end
private def modify_lines(before, complete)
if after = @output_modifier_proc&.call("#{before.join("\n")}\n", complete: complete)
after.lines("\n").map { |l| l.chomp('') }
else
before.map { |l| Reline::Unicode.escape_for_print(l) }
end
end
def editing_mode
@config.editing_mode
end
private def menu(_target, list)
@menu_info = MenuInfo.new(list)
end
private def complete_internal_proc(list, is_menu)
preposing, target, postposing = retrieve_completion_block
list = list.select { |i|
if i and not Encoding.compatible?(target.encoding, i.encoding)
raise Encoding::CompatibilityError, "#{target.encoding.name} is not compatible with #{i.encoding.name}"
end
if @config.completion_ignore_case
i&.downcase&.start_with?(target.downcase)
else
i&.start_with?(target)
end
}.uniq
if is_menu
menu(target, list)
return nil
end
completed = list.inject { |memo, item|
begin
memo_mbchars = memo.unicode_normalize.grapheme_clusters
item_mbchars = item.unicode_normalize.grapheme_clusters
rescue Encoding::CompatibilityError
memo_mbchars = memo.grapheme_clusters
item_mbchars = item.grapheme_clusters
end
size = [memo_mbchars.size, item_mbchars.size].min
result = +''
size.times do |i|
if @config.completion_ignore_case
if memo_mbchars[i].casecmp?(item_mbchars[i])
result << memo_mbchars[i]
else
break
end
else
if memo_mbchars[i] == item_mbchars[i]
result << memo_mbchars[i]
else
break
end
end
end
result
}
[target, preposing, completed, postposing]
end
private def perform_completion(list, just_show_list)
case @completion_state
when CompletionState::NORMAL
@completion_state = CompletionState::COMPLETION
when CompletionState::PERFECT_MATCH
@dig_perfect_match_proc&.(@perfect_matched)
end
if just_show_list
is_menu = true
elsif @completion_state == CompletionState::MENU
is_menu = true
elsif @completion_state == CompletionState::MENU_WITH_PERFECT_MATCH
is_menu = true
else
is_menu = false
end
result = complete_internal_proc(list, is_menu)
if @completion_state == CompletionState::MENU_WITH_PERFECT_MATCH
@completion_state = CompletionState::PERFECT_MATCH
end
return if result.nil?
target, preposing, completed, postposing = result
return if completed.nil?
if target <= completed and (@completion_state == CompletionState::COMPLETION)
if list.include?(completed)
if list.one?
@completion_state = CompletionState::PERFECT_MATCH
else
@completion_state = CompletionState::MENU_WITH_PERFECT_MATCH
perform_completion(list, true) if @config.show_all_if_ambiguous
end
@perfect_matched = completed
else
@completion_state = CompletionState::MENU
perform_completion(list, true) if @config.show_all_if_ambiguous
end
if not just_show_list and target < completed
@buffer_of_lines[@line_index] = (preposing + completed + completion_append_character.to_s + postposing).split("\n")[@line_index] || String.new(encoding: @encoding)
line_to_pointer = (preposing + completed + completion_append_character.to_s).split("\n")[@line_index] || String.new(encoding: @encoding)
@byte_pointer = line_to_pointer.bytesize
end
end
end
def dialog_proc_scope_completion_journey_data
return nil unless @completion_journey_state
line_index = @completion_journey_state.line_index
pre_lines = @buffer_of_lines[0...line_index].map { |line| line + "\n" }
post_lines = @buffer_of_lines[(line_index + 1)..-1].map { |line| line + "\n" }
DialogProcScope::CompletionJourneyData.new(
pre_lines.join + @completion_journey_state.pre,
@completion_journey_state.post + post_lines.join,
@completion_journey_state.list,
@completion_journey_state.pointer
)
end
private def move_completed_list(direction)
@completion_journey_state ||= retrieve_completion_journey_state
return false unless @completion_journey_state
if (delta = { up: -1, down: +1 }[direction])
@completion_journey_state.pointer = (@completion_journey_state.pointer + delta) % @completion_journey_state.list.size
end
completed = @completion_journey_state.list[@completion_journey_state.pointer]
set_current_line(@completion_journey_state.pre + completed + @completion_journey_state.post, @completion_journey_state.pre.bytesize + completed.bytesize)
true
end
private def retrieve_completion_journey_state
preposing, target, postposing = retrieve_completion_block
list = call_completion_proc
return unless list.is_a?(Array)
candidates = list.select{ |item| item.start_with?(target) }
return if candidates.empty?
pre = preposing.split("\n", -1).last || ''
post = postposing.split("\n", -1).first || ''
CompletionJourneyState.new(
@line_index, pre, target, post, [target] + candidates, 0
)
end
private def run_for_operators(key, method_symbol, &block)
if @vi_waiting_operator
if VI_MOTIONS.include?(method_symbol)
old_byte_pointer = @byte_pointer
@vi_arg = (@vi_arg || 1) * @vi_waiting_operator_arg
block.(true)
unless @waiting_proc
byte_pointer_diff = @byte_pointer - old_byte_pointer
@byte_pointer = old_byte_pointer
method_obj = method(@vi_waiting_operator)
wrap_method_call(@vi_waiting_operator, method_obj, byte_pointer_diff)
cleanup_waiting
end
else
# Ignores operator when not motion is given.
block.(false)
cleanup_waiting
end
@vi_arg = nil
else
block.(false)
end
end
private def argumentable?(method_obj)
method_obj and method_obj.parameters.any? { |param| param[0] == :key and param[1] == :arg }
end
private def inclusive?(method_obj)
# If a motion method with the keyword argument "inclusive" follows the
# operator, it must contain the character at the cursor position.
method_obj and method_obj.parameters.any? { |param| param[0] == :key and param[1] == :inclusive }
end
def wrap_method_call(method_symbol, method_obj, key, with_operator = false)
if @config.editing_mode_is?(:emacs, :vi_insert) and @vi_waiting_operator.nil?
not_insertion = method_symbol != :ed_insert
process_insert(force: not_insertion)
end
if @vi_arg and argumentable?(method_obj)
if with_operator and inclusive?(method_obj)
method_obj.(key, arg: @vi_arg, inclusive: true)
else
method_obj.(key, arg: @vi_arg)
end
else
if with_operator and inclusive?(method_obj)
method_obj.(key, inclusive: true)
else
method_obj.(key)
end
end
end
private def cleanup_waiting
@waiting_proc = nil
@vi_waiting_operator = nil
@vi_waiting_operator_arg = nil
@searching_prompt = nil
@drop_terminate_spaces = false
end
private def process_key(key, method_symbol)
if key.is_a?(Symbol)
cleanup_waiting
elsif @waiting_proc
old_byte_pointer = @byte_pointer
@waiting_proc.call(key)
if @vi_waiting_operator
byte_pointer_diff = @byte_pointer - old_byte_pointer
@byte_pointer = old_byte_pointer
method_obj = method(@vi_waiting_operator)
wrap_method_call(@vi_waiting_operator, method_obj, byte_pointer_diff)
cleanup_waiting
end
@kill_ring.process
return
end
if method_symbol and respond_to?(method_symbol, true)
method_obj = method(method_symbol)
end
if method_symbol and key.is_a?(Symbol)
if @vi_arg and argumentable?(method_obj)
run_for_operators(key, method_symbol) do |with_operator|
wrap_method_call(method_symbol, method_obj, key, with_operator)
end
else
wrap_method_call(method_symbol, method_obj, key) if method_obj
end
@kill_ring.process
if @vi_arg
@vi_arg = nil
end
elsif @vi_arg
if key.chr =~ /[0-9]/
ed_argument_digit(key)
else
if argumentable?(method_obj)
run_for_operators(key, method_symbol) do |with_operator|
wrap_method_call(method_symbol, method_obj, key, with_operator)
end
elsif method_obj
wrap_method_call(method_symbol, method_obj, key)
else
ed_insert(key) unless @config.editing_mode_is?(:vi_command)
end
@kill_ring.process
if @vi_arg
@vi_arg = nil
end
end
elsif method_obj
if method_symbol == :ed_argument_digit
wrap_method_call(method_symbol, method_obj, key)
else
run_for_operators(key, method_symbol) do |with_operator|
wrap_method_call(method_symbol, method_obj, key, with_operator)
end
end
@kill_ring.process
else
ed_insert(key) unless @config.editing_mode_is?(:vi_command)
end
end
private def normal_char(key)
@multibyte_buffer << key.combined_char
if @multibyte_buffer.size > 1
if @multibyte_buffer.dup.force_encoding(@encoding).valid_encoding?
process_key(@multibyte_buffer.dup.force_encoding(@encoding), nil)
@multibyte_buffer.clear
else
# invalid
return
end
else # single byte
return if key.char >= 128 # maybe, first byte of multi byte
method_symbol = @config.editing_mode.get_method(key.combined_char)
process_key(key.combined_char, method_symbol)
@multibyte_buffer.clear
end
if @config.editing_mode_is?(:vi_command) and @byte_pointer > 0 and @byte_pointer == current_line.bytesize
byte_size = Reline::Unicode.get_prev_mbchar_size(@buffer_of_lines[@line_index], @byte_pointer)
@byte_pointer -= byte_size
end
end
def update(key)
modified = input_key(key)
unless @in_pasting
scroll_into_view
@just_cursor_moving = !modified
update_dialogs(key)
@just_cursor_moving = false
end
end
def input_key(key)
save_old_buffer
@config.reset_oneshot_key_bindings
@dialogs.each do |dialog|
if key.char.instance_of?(Symbol) and key.char == dialog.name
return
end
end
if key.char.nil?
process_insert(force: true)
@eof = buffer_empty?
finish
return
end
@completion_occurs = false
if key.char.is_a?(Symbol)
process_key(key.char, key.char)
else
normal_char(key)
end
@prev_action_state, @next_action_state = @next_action_state, NullActionState
unless @completion_occurs
@completion_state = CompletionState::NORMAL
@completion_journey_state = nil
end
push_input_lines unless @undoing
@undoing = false
if @in_pasting
clear_dialogs
return
end
modified = @old_buffer_of_lines != @buffer_of_lines
if !@completion_occurs && modified && !@config.disable_completion && @config.autocompletion
# Auto complete starts only when edited
process_insert(force: true)
@completion_journey_state = retrieve_completion_journey_state
end
modified
end
def save_old_buffer
@old_buffer_of_lines = @buffer_of_lines.dup
end
def push_input_lines
if @old_buffer_of_lines == @buffer_of_lines
@input_lines[@input_lines_position] = [@buffer_of_lines.dup, @byte_pointer, @line_index]
else
@input_lines = @input_lines[0..@input_lines_position]
@input_lines_position += 1
@input_lines.push([@buffer_of_lines.dup, @byte_pointer, @line_index])
end
trim_input_lines
end
MAX_INPUT_LINES = 100
def trim_input_lines
if @input_lines.size > MAX_INPUT_LINES
@input_lines.shift
@input_lines_position -= 1
end
end
def scroll_into_view
_wrapped_cursor_x, wrapped_cursor_y = wrapped_cursor_position
if wrapped_cursor_y < screen_scroll_top
@scroll_partial_screen = wrapped_cursor_y
end
if wrapped_cursor_y >= screen_scroll_top + screen_height
@scroll_partial_screen = wrapped_cursor_y - screen_height + 1
end
end
def call_completion_proc
result = retrieve_completion_block(true)
pre, target, post = result
result = call_completion_proc_with_checking_args(pre, target, post)
Reline.core.instance_variable_set(:@completion_quote_character, nil)
result
end
def call_completion_proc_with_checking_args(pre, target, post)
if @completion_proc and target
argnum = @completion_proc.parameters.inject(0) { |result, item|
case item.first
when :req, :opt
result + 1
when :rest
break 3
end
}
case argnum
when 1
result = @completion_proc.(target)
when 2
result = @completion_proc.(target, pre)
when 3..Float::INFINITY
result = @completion_proc.(target, pre, post)
end
end
result
end
private def process_auto_indent(line_index = @line_index, cursor_dependent: true, add_newline: false)
return if @in_pasting
return unless @auto_indent_proc
line = @buffer_of_lines[line_index]
byte_pointer = cursor_dependent && @line_index == line_index ? @byte_pointer : line.bytesize
new_indent = @auto_indent_proc.(@buffer_of_lines.take(line_index + 1).push(''), line_index, byte_pointer, add_newline)
return unless new_indent
new_line = ' ' * new_indent + line.lstrip
@buffer_of_lines[line_index] = new_line
if @line_index == line_index
indent_diff = new_line.bytesize - line.bytesize
@byte_pointer = [@byte_pointer + indent_diff, 0].max
end
end
def line()
@buffer_of_lines.join("\n") unless eof?
end
def current_line
@buffer_of_lines[@line_index]
end
def set_current_line(line, byte_pointer = nil)
cursor = current_byte_pointer_cursor
@buffer_of_lines[@line_index] = line
if byte_pointer
@byte_pointer = byte_pointer
else
calculate_nearest_cursor(cursor)
end
process_auto_indent
end
def set_current_lines(lines, byte_pointer = nil, line_index = 0)
cursor = current_byte_pointer_cursor
@buffer_of_lines = lines
@line_index = line_index
if byte_pointer
@byte_pointer = byte_pointer
else
calculate_nearest_cursor(cursor)
end
process_auto_indent
end
def retrieve_completion_block(set_completion_quote_character = false)
if Reline.completer_word_break_characters.empty?
word_break_regexp = nil
else
word_break_regexp = /\A[#{Regexp.escape(Reline.completer_word_break_characters)}]/
end
if Reline.completer_quote_characters.empty?
quote_characters_regexp = nil
else
quote_characters_regexp = /\A[#{Regexp.escape(Reline.completer_quote_characters)}]/
end
before = current_line.byteslice(0, @byte_pointer)
rest = nil
break_pointer = nil
quote = nil
closing_quote = nil
escaped_quote = nil
i = 0
while i < @byte_pointer do
slice = current_line.byteslice(i, @byte_pointer - i)
unless slice.valid_encoding?
i += 1
next
end
if quote and slice.start_with?(closing_quote)
quote = nil
i += 1
rest = nil
elsif quote and slice.start_with?(escaped_quote)
# skip
i += 2
elsif quote_characters_regexp and slice =~ quote_characters_regexp # find new "
rest = $'
quote = $&
closing_quote = /(?!\\)#{Regexp.escape(quote)}/
escaped_quote = /\\#{Regexp.escape(quote)}/
i += 1
break_pointer = i - 1
elsif word_break_regexp and not quote and slice =~ word_break_regexp
rest = $'
i += 1
before = current_line.byteslice(i, @byte_pointer - i)
break_pointer = i
else
i += 1
end
end
postposing = current_line.byteslice(@byte_pointer, current_line.bytesize - @byte_pointer)
if rest
preposing = current_line.byteslice(0, break_pointer)
target = rest
if set_completion_quote_character and quote
Reline.core.instance_variable_set(:@completion_quote_character, quote)
if postposing !~ /(?!\\)#{Regexp.escape(quote)}/ # closing quote
insert_text(quote)
end
end
else
preposing = ''
if break_pointer
preposing = current_line.byteslice(0, break_pointer)
else
preposing = ''
end
target = before
end
lines = whole_lines
if @line_index > 0
preposing = lines[0..(@line_index - 1)].join("\n") + "\n" + preposing
end
if (lines.size - 1) > @line_index
postposing = postposing + "\n" + lines[(@line_index + 1)..-1].join("\n")
end
[preposing.encode(@encoding), target.encode(@encoding), postposing.encode(@encoding)]
end
def confirm_multiline_termination
temp_buffer = @buffer_of_lines.dup
@confirm_multiline_termination_proc.(temp_buffer.join("\n") + "\n")
end
def insert_multiline_text(text)
save_old_buffer
pre = @buffer_of_lines[@line_index].byteslice(0, @byte_pointer)
post = @buffer_of_lines[@line_index].byteslice(@byte_pointer..)
lines = (pre + text.gsub(/\r\n?/, "\n") + post).split("\n", -1)
lines << '' if lines.empty?
@buffer_of_lines[@line_index, 1] = lines
@line_index += lines.size - 1
@byte_pointer = @buffer_of_lines[@line_index].bytesize - post.bytesize
push_input_lines
end
def insert_text(text)
if @buffer_of_lines[@line_index].bytesize == @byte_pointer
@buffer_of_lines[@line_index] += text
else
@buffer_of_lines[@line_index] = byteinsert(@buffer_of_lines[@line_index], @byte_pointer, text)
end
@byte_pointer += text.bytesize
process_auto_indent
end
def delete_text(start = nil, length = nil)
if start.nil? and length.nil?
if @buffer_of_lines.size == 1
@buffer_of_lines[@line_index] = ''
@byte_pointer = 0
elsif @line_index == (@buffer_of_lines.size - 1) and @line_index > 0
@buffer_of_lines.pop
@line_index -= 1
@byte_pointer = 0
elsif @line_index < (@buffer_of_lines.size - 1)
@buffer_of_lines.delete_at(@line_index)
@byte_pointer = 0
end
elsif not start.nil? and not length.nil?
if current_line
before = current_line.byteslice(0, start)
after = current_line.byteslice(start + length, current_line.bytesize)
set_current_line(before + after)
end
elsif start.is_a?(Range)
range = start
first = range.first
last = range.last
last = current_line.bytesize - 1 if last > current_line.bytesize
last += current_line.bytesize if last < 0
first += current_line.bytesize if first < 0
range = range.exclude_end? ? first...last : first..last
line = current_line.bytes.reject.with_index{ |c, i| range.include?(i) }.map{ |c| c.chr(Encoding::ASCII_8BIT) }.join.force_encoding(@encoding)
set_current_line(line)
else
set_current_line(current_line.byteslice(0, start))
end
end
def byte_pointer=(val)
@byte_pointer = val
end
def whole_lines
@buffer_of_lines.dup
end
def whole_buffer
whole_lines.join("\n")
end
private def buffer_empty?
current_line.empty? and @buffer_of_lines.size == 1
end
def finished?
@finished
end
def finish
@finished = true
@config.reset
end
private def byteslice!(str, byte_pointer, size)
new_str = str.byteslice(0, byte_pointer)
new_str << str.byteslice(byte_pointer + size, str.bytesize)
[new_str, str.byteslice(byte_pointer, size)]
end
private def byteinsert(str, byte_pointer, other)
new_str = str.byteslice(0, byte_pointer)
new_str << other
new_str << str.byteslice(byte_pointer, str.bytesize)
new_str
end
private def calculate_width(str, allow_escape_code = false)
Reline::Unicode.calculate_width(str, allow_escape_code)
end
private def key_delete(key)
if @config.editing_mode_is?(:vi_insert)
ed_delete_next_char(key)
elsif @config.editing_mode_is?(:emacs)
em_delete(key)
end
end
private def key_newline(key)
if @is_multiline
next_line = current_line.byteslice(@byte_pointer, current_line.bytesize - @byte_pointer)
cursor_line = current_line.byteslice(0, @byte_pointer)
insert_new_line(cursor_line, next_line)
end
end
private def complete(_key)
return if @config.disable_completion
process_insert(force: true)
if @config.autocompletion
@completion_state = CompletionState::NORMAL
@completion_occurs = move_completed_list(:down)
else
@completion_journey_state = nil
result = call_completion_proc
if result.is_a?(Array)
@completion_occurs = true
perform_completion(result, false)
end
end
end
private def completion_journey_move(direction)
return if @config.disable_completion
process_insert(force: true)
@completion_state = CompletionState::NORMAL
@completion_occurs = move_completed_list(direction)
end
private def menu_complete(_key)
completion_journey_move(:down)
end
private def menu_complete_backward(_key)
completion_journey_move(:up)
end
private def completion_journey_up(_key)
completion_journey_move(:up) if @config.autocompletion
end
# Editline:: +ed-unassigned+ This editor command always results in an error.
# GNU Readline:: There is no corresponding macro.
private def ed_unassigned(key) end # do nothing
private def process_insert(force: false)
return if @continuous_insertion_buffer.empty? or (@in_pasting and not force)
insert_text(@continuous_insertion_buffer)
@continuous_insertion_buffer.clear
end
# Editline:: +ed-insert+ (vi input: almost all; emacs: printable characters)
# In insert mode, insert the input character left of the cursor
# position. In replace mode, overwrite the character at the
# cursor and move the cursor to the right by one character
# position. Accept an argument to do this repeatedly. It is an
# error if the input character is the NUL character (+Ctrl-@+).
# Failure to enlarge the edit buffer also results in an error.
# Editline:: +ed-digit+ (emacs: 0 to 9) If in argument input mode, append
# the input digit to the argument being read. Otherwise, call
# +ed-insert+. It is an error if the input character is not a
# digit or if the existing argument is already greater than a
# million.
# GNU Readline:: +self-insert+ (a, b, A, 1, !, …) Insert yourself.
private def ed_insert(key)
if key.instance_of?(String)
begin
key.encode(Encoding::UTF_8)
rescue Encoding::UndefinedConversionError
return
end
str = key
else
begin
key.chr.encode(Encoding::UTF_8)
rescue Encoding::UndefinedConversionError
return
end
str = key.chr
end
if @in_pasting
@continuous_insertion_buffer << str
return
elsif not @continuous_insertion_buffer.empty?
process_insert
end
insert_text(str)
end
alias_method :ed_digit, :ed_insert
alias_method :self_insert, :ed_insert
private def ed_quoted_insert(str, arg: 1)
@waiting_proc = proc { |key|
arg.times do
if key == "\C-j".ord or key == "\C-m".ord
key_newline(key)
elsif key == 0
# Ignore NUL.
else
ed_insert(key)
end
end
@waiting_proc = nil
}
end
alias_method :quoted_insert, :ed_quoted_insert
private def ed_next_char(key, arg: 1)
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
if (@byte_pointer < current_line.bytesize)
@byte_pointer += byte_size
elsif @config.editing_mode_is?(:emacs) and @byte_pointer == current_line.bytesize and @line_index < @buffer_of_lines.size - 1
@byte_pointer = 0
@line_index += 1
end
arg -= 1
ed_next_char(key, arg: arg) if arg > 0
end
alias_method :forward_char, :ed_next_char
private def ed_prev_char(key, arg: 1)
if @byte_pointer > 0
byte_size = Reline::Unicode.get_prev_mbchar_size(current_line, @byte_pointer)
@byte_pointer -= byte_size
elsif @config.editing_mode_is?(:emacs) and @byte_pointer == 0 and @line_index > 0
@line_index -= 1
@byte_pointer = current_line.bytesize
end
arg -= 1
ed_prev_char(key, arg: arg) if arg > 0
end
alias_method :backward_char, :ed_prev_char
private def vi_first_print(key)
@byte_pointer, = Reline::Unicode.vi_first_print(current_line)
end
private def ed_move_to_beg(key)
@byte_pointer = 0
end
alias_method :beginning_of_line, :ed_move_to_beg
alias_method :vi_zero, :ed_move_to_beg
private def ed_move_to_end(key)
@byte_pointer = current_line.bytesize
end
alias_method :end_of_line, :ed_move_to_end
private def generate_searcher(search_key)
search_word = String.new(encoding: @encoding)
multibyte_buf = String.new(encoding: 'ASCII-8BIT')
hit_pointer = nil
lambda do |key|
search_again = false
case key
when "\C-h".ord, "\C-?".ord
grapheme_clusters = search_word.grapheme_clusters
if grapheme_clusters.size > 0
grapheme_clusters.pop
search_word = grapheme_clusters.join
end
when "\C-r".ord, "\C-s".ord
search_again = true if search_key == key
search_key = key
else
multibyte_buf << key
if multibyte_buf.dup.force_encoding(@encoding).valid_encoding?
search_word << multibyte_buf.dup.force_encoding(@encoding)
multibyte_buf.clear
end
end
hit = nil
if not search_word.empty? and @line_backup_in_history&.include?(search_word)
hit_pointer = Reline::HISTORY.size
hit = @line_backup_in_history
else
if search_again
if search_word.empty? and Reline.last_incremental_search
search_word = Reline.last_incremental_search
end
if @history_pointer
case search_key
when "\C-r".ord
history_pointer_base = 0
history = Reline::HISTORY[0..(@history_pointer - 1)]
when "\C-s".ord
history_pointer_base = @history_pointer + 1
history = Reline::HISTORY[(@history_pointer + 1)..-1]
end
else
history_pointer_base = 0
history = Reline::HISTORY
end
elsif @history_pointer
case search_key
when "\C-r".ord
history_pointer_base = 0
history = Reline::HISTORY[0..@history_pointer]
when "\C-s".ord
history_pointer_base = @history_pointer
history = Reline::HISTORY[@history_pointer..-1]
end
else
history_pointer_base = 0
history = Reline::HISTORY
end
case search_key
when "\C-r".ord
hit_index = history.rindex { |item|
item.include?(search_word)
}
when "\C-s".ord
hit_index = history.index { |item|
item.include?(search_word)
}
end
if hit_index
hit_pointer = history_pointer_base + hit_index
hit = Reline::HISTORY[hit_pointer]
end
end
case search_key
when "\C-r".ord
prompt_name = 'reverse-i-search'
when "\C-s".ord
prompt_name = 'i-search'
end
prompt_name = "failed #{prompt_name}" unless hit
[search_word, prompt_name, hit_pointer]
end
end
private def incremental_search_history(key)
unless @history_pointer
@line_backup_in_history = whole_buffer
end
searcher = generate_searcher(key)
@searching_prompt = "(reverse-i-search)`': "
termination_keys = ["\C-j".ord]
termination_keys.concat(@config.isearch_terminators&.chars&.map(&:ord)) if @config.isearch_terminators
@waiting_proc = ->(k) {
case k
when *termination_keys
if @history_pointer
buffer = Reline::HISTORY[@history_pointer]
else
buffer = @line_backup_in_history
end
@buffer_of_lines = buffer.split("\n")
@buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
@line_index = @buffer_of_lines.size - 1
@searching_prompt = nil
@waiting_proc = nil
@byte_pointer = 0
when "\C-g".ord
@buffer_of_lines = @line_backup_in_history.split("\n")
@buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
@line_index = @buffer_of_lines.size - 1
move_history(nil, line: :end, cursor: :end, save_buffer: false)
@searching_prompt = nil
@waiting_proc = nil
@byte_pointer = 0
else
chr = k.is_a?(String) ? k : k.chr(Encoding::ASCII_8BIT)
if chr.match?(/[[:print:]]/) or k == "\C-h".ord or k == "\C-?".ord or k == "\C-r".ord or k == "\C-s".ord
search_word, prompt_name, hit_pointer = searcher.call(k)
Reline.last_incremental_search = search_word
@searching_prompt = "(%s)`%s'" % [prompt_name, search_word]
@searching_prompt += ': ' unless @is_multiline
move_history(hit_pointer, line: :end, cursor: :end, save_buffer: false) if hit_pointer
else
if @history_pointer
line = Reline::HISTORY[@history_pointer]
else
line = @line_backup_in_history
end
@line_backup_in_history = whole_buffer
@buffer_of_lines = line.split("\n")
@buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
@line_index = @buffer_of_lines.size - 1
@searching_prompt = nil
@waiting_proc = nil
@byte_pointer = 0
end
end
}
end
private def vi_search_prev(key)
incremental_search_history(key)
end
alias_method :reverse_search_history, :vi_search_prev
private def vi_search_next(key)
incremental_search_history(key)
end
alias_method :forward_search_history, :vi_search_next
private def search_history(prefix, pointer_range)
pointer_range.each do |pointer|
lines = Reline::HISTORY[pointer].split("\n")
lines.each_with_index do |line, index|
return [pointer, index] if line.start_with?(prefix)
end
end
nil
end
private def ed_search_prev_history(key, arg: 1)
substr = prev_action_state_value(:search_history) == :empty ? '' : current_line.byteslice(0, @byte_pointer)
return if @history_pointer == 0
return if @history_pointer.nil? && substr.empty? && !current_line.empty?
history_range = 0...(@history_pointer || Reline::HISTORY.size)
h_pointer, line_index = search_history(substr, history_range.reverse_each)
return unless h_pointer
move_history(h_pointer, line: line_index || :start, cursor: substr.empty? ? :end : @byte_pointer)
arg -= 1
set_next_action_state(:search_history, :empty) if substr.empty?
ed_search_prev_history(key, arg: arg) if arg > 0
end
alias_method :history_search_backward, :ed_search_prev_history
private def ed_search_next_history(key, arg: 1)
substr = prev_action_state_value(:search_history) == :empty ? '' : current_line.byteslice(0, @byte_pointer)
return if @history_pointer.nil?
history_range = @history_pointer + 1...Reline::HISTORY.size
h_pointer, line_index = search_history(substr, history_range)
return if h_pointer.nil? and not substr.empty?
move_history(h_pointer, line: line_index || :start, cursor: substr.empty? ? :end : @byte_pointer)
arg -= 1
set_next_action_state(:search_history, :empty) if substr.empty?
ed_search_next_history(key, arg: arg) if arg > 0
end
alias_method :history_search_forward, :ed_search_next_history
private def move_history(history_pointer, line:, cursor:, save_buffer: true)
history_pointer ||= Reline::HISTORY.size
return if history_pointer < 0 || history_pointer > Reline::HISTORY.size
old_history_pointer = @history_pointer || Reline::HISTORY.size
if old_history_pointer == Reline::HISTORY.size
@line_backup_in_history = save_buffer ? whole_buffer : ''
else
Reline::HISTORY[old_history_pointer] = whole_buffer if save_buffer
end
if history_pointer == Reline::HISTORY.size
buf = @line_backup_in_history
@history_pointer = @line_backup_in_history = nil
else
buf = Reline::HISTORY[history_pointer]
@history_pointer = history_pointer
end
@buffer_of_lines = buf.split("\n")
@buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
@line_index = line == :start ? 0 : line == :end ? @buffer_of_lines.size - 1 : line
@byte_pointer = cursor == :start ? 0 : cursor == :end ? current_line.bytesize : cursor
end
private def ed_prev_history(key, arg: 1)
if @line_index > 0
cursor = current_byte_pointer_cursor
@line_index -= 1
calculate_nearest_cursor(cursor)
return
end
move_history(
(@history_pointer || Reline::HISTORY.size) - 1,
line: :end,
cursor: @config.editing_mode_is?(:vi_command) ? :start : :end,
)
arg -= 1
ed_prev_history(key, arg: arg) if arg > 0
end
alias_method :previous_history, :ed_prev_history
private def ed_next_history(key, arg: 1)
if @line_index < (@buffer_of_lines.size - 1)
cursor = current_byte_pointer_cursor
@line_index += 1
calculate_nearest_cursor(cursor)
return
end
move_history(
(@history_pointer || Reline::HISTORY.size) + 1,
line: :start,
cursor: @config.editing_mode_is?(:vi_command) ? :start : :end,
)
arg -= 1
ed_next_history(key, arg: arg) if arg > 0
end
alias_method :next_history, :ed_next_history
private def ed_newline(key)
process_insert(force: true)
if @is_multiline
if @config.editing_mode_is?(:vi_command)
if @line_index < (@buffer_of_lines.size - 1)
ed_next_history(key) # means cursor down
else
# should check confirm_multiline_termination to finish?
finish
end
else
if @line_index == (@buffer_of_lines.size - 1)
if confirm_multiline_termination
finish
else
key_newline(key)
end
else
# should check confirm_multiline_termination to finish?
@line_index = @buffer_of_lines.size - 1
@byte_pointer = current_line.bytesize
finish
end
end
else
finish
end
end
private def em_delete_prev_char(key, arg: 1)
arg.times do
if @byte_pointer == 0 and @line_index > 0
@byte_pointer = @buffer_of_lines[@line_index - 1].bytesize
@buffer_of_lines[@line_index - 1] += @buffer_of_lines.delete_at(@line_index)
@line_index -= 1
elsif @byte_pointer > 0
byte_size = Reline::Unicode.get_prev_mbchar_size(current_line, @byte_pointer)
line, = byteslice!(current_line, @byte_pointer - byte_size, byte_size)
set_current_line(line, @byte_pointer - byte_size)
end
end
process_auto_indent
end
alias_method :backward_delete_char, :em_delete_prev_char
# Editline:: +ed-kill-line+ (vi command: +D+, +Ctrl-K+; emacs: +Ctrl-K+,
# +Ctrl-U+) + Kill from the cursor to the end of the line.
# GNU Readline:: +kill-line+ (+C-k+) Kill the text from point to the end of
# the line. With a negative numeric argument, kill backward
# from the cursor to the beginning of the current line.
private def ed_kill_line(key)
if current_line.bytesize > @byte_pointer
line, deleted = byteslice!(current_line, @byte_pointer, current_line.bytesize - @byte_pointer)
set_current_line(line, line.bytesize)
@kill_ring.append(deleted)
elsif @byte_pointer == current_line.bytesize and @buffer_of_lines.size > @line_index + 1
set_current_line(current_line + @buffer_of_lines.delete_at(@line_index + 1), current_line.bytesize)
end
end
alias_method :kill_line, :ed_kill_line
# Editline:: +vi_change_to_eol+ (vi command: +C+) + Kill and change from the cursor to the end of the line.
private def vi_change_to_eol(key)
ed_kill_line(key)
@config.editing_mode = :vi_insert
end
# Editline:: +vi-kill-line-prev+ (vi: +Ctrl-U+) Delete the string from the
# beginning of the edit buffer to the cursor and save it to the
# cut buffer.
# GNU Readline:: +unix-line-discard+ (+C-u+) Kill backward from the cursor
# to the beginning of the current line.
private def vi_kill_line_prev(key)
if @byte_pointer > 0
line, deleted = byteslice!(current_line, 0, @byte_pointer)
set_current_line(line, 0)
@kill_ring.append(deleted, true)
end
end
alias_method :unix_line_discard, :vi_kill_line_prev
# Editline:: +em-kill-line+ (not bound) Delete the entire contents of the
# edit buffer and save it to the cut buffer. +vi-kill-line-prev+
# GNU Readline:: +kill-whole-line+ (not bound) Kill all characters on the
# current line, no matter where point is.
private def em_kill_line(key)
if current_line.size > 0
@kill_ring.append(current_line.dup, true)
set_current_line('', 0)
end
end
alias_method :kill_whole_line, :em_kill_line
private def em_delete(key)
if buffer_empty? and key == "\C-d".ord
@eof = true
finish
elsif @byte_pointer < current_line.bytesize
splitted_last = current_line.byteslice(@byte_pointer, current_line.bytesize)
mbchar = splitted_last.grapheme_clusters.first
line, = byteslice!(current_line, @byte_pointer, mbchar.bytesize)
set_current_line(line)
elsif @byte_pointer == current_line.bytesize and @buffer_of_lines.size > @line_index + 1
set_current_line(current_line + @buffer_of_lines.delete_at(@line_index + 1), current_line.bytesize)
end
end
alias_method :delete_char, :em_delete
private def em_delete_or_list(key)
if current_line.empty? or @byte_pointer < current_line.bytesize
em_delete(key)
elsif !@config.autocompletion # show completed list
result = call_completion_proc
if result.is_a?(Array)
perform_completion(result, true)
end
end
end
alias_method :delete_char_or_list, :em_delete_or_list
private def em_yank(key)
yanked = @kill_ring.yank
insert_text(yanked) if yanked
end
alias_method :yank, :em_yank
private def em_yank_pop(key)
yanked, prev_yank = @kill_ring.yank_pop
if yanked
line, = byteslice!(current_line, @byte_pointer - prev_yank.bytesize, prev_yank.bytesize)
set_current_line(line, @byte_pointer - prev_yank.bytesize)
insert_text(yanked)
end
end
alias_method :yank_pop, :em_yank_pop
private def ed_clear_screen(key)
Reline::IOGate.clear_screen
@screen_size = Reline::IOGate.get_screen_size
@rendered_screen.base_y = 0
clear_rendered_screen_cache
end
alias_method :clear_screen, :ed_clear_screen
private def em_next_word(key)
if current_line.bytesize > @byte_pointer
byte_size, _ = Reline::Unicode.em_forward_word(current_line, @byte_pointer)
@byte_pointer += byte_size
end
end
alias_method :forward_word, :em_next_word
private def ed_prev_word(key)
if @byte_pointer > 0
byte_size, _ = Reline::Unicode.em_backward_word(current_line, @byte_pointer)
@byte_pointer -= byte_size
end
end
alias_method :backward_word, :ed_prev_word
private def em_delete_next_word(key)
if current_line.bytesize > @byte_pointer
byte_size, _ = Reline::Unicode.em_forward_word(current_line, @byte_pointer)
line, word = byteslice!(current_line, @byte_pointer, byte_size)
set_current_line(line)
@kill_ring.append(word)
end
end
alias_method :kill_word, :em_delete_next_word
private def ed_delete_prev_word(key)
if @byte_pointer > 0
byte_size, _ = Reline::Unicode.em_backward_word(current_line, @byte_pointer)
line, word = byteslice!(current_line, @byte_pointer - byte_size, byte_size)
set_current_line(line, @byte_pointer - byte_size)
@kill_ring.append(word, true)
end
end
alias_method :backward_kill_word, :ed_delete_prev_word
private def ed_transpose_chars(key)
if @byte_pointer > 0
if @byte_pointer < current_line.bytesize
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
@byte_pointer += byte_size
end
back1_byte_size = Reline::Unicode.get_prev_mbchar_size(current_line, @byte_pointer)
if (@byte_pointer - back1_byte_size) > 0
back2_byte_size = Reline::Unicode.get_prev_mbchar_size(current_line, @byte_pointer - back1_byte_size)
back2_pointer = @byte_pointer - back1_byte_size - back2_byte_size
line, back2_mbchar = byteslice!(current_line, back2_pointer, back2_byte_size)
set_current_line(byteinsert(line, @byte_pointer - back2_byte_size, back2_mbchar))
end
end
end
alias_method :transpose_chars, :ed_transpose_chars
private def ed_transpose_words(key)
left_word_start, middle_start, right_word_start, after_start = Reline::Unicode.ed_transpose_words(current_line, @byte_pointer)
before = current_line.byteslice(0, left_word_start)
left_word = current_line.byteslice(left_word_start, middle_start - left_word_start)
middle = current_line.byteslice(middle_start, right_word_start - middle_start)
right_word = current_line.byteslice(right_word_start, after_start - right_word_start)
after = current_line.byteslice(after_start, current_line.bytesize - after_start)
return if left_word.empty? or right_word.empty?
from_head_to_left_word = before + right_word + middle + left_word
set_current_line(from_head_to_left_word + after, from_head_to_left_word.bytesize)
end
alias_method :transpose_words, :ed_transpose_words
private def em_capitol_case(key)
if current_line.bytesize > @byte_pointer
byte_size, _, new_str = Reline::Unicode.em_forward_word_with_capitalization(current_line, @byte_pointer)
before = current_line.byteslice(0, @byte_pointer)
after = current_line.byteslice((@byte_pointer + byte_size)..-1)
set_current_line(before + new_str + after, @byte_pointer + new_str.bytesize)
end
end
alias_method :capitalize_word, :em_capitol_case
private def em_lower_case(key)
if current_line.bytesize > @byte_pointer
byte_size, = Reline::Unicode.em_forward_word(current_line, @byte_pointer)
part = current_line.byteslice(@byte_pointer, byte_size).grapheme_clusters.map { |mbchar|
mbchar =~ /[A-Z]/ ? mbchar.downcase : mbchar
}.join
rest = current_line.byteslice((@byte_pointer + byte_size)..-1)
line = current_line.byteslice(0, @byte_pointer) + part
set_current_line(line + rest, line.bytesize)
end
end
alias_method :downcase_word, :em_lower_case
private def em_upper_case(key)
if current_line.bytesize > @byte_pointer
byte_size, = Reline::Unicode.em_forward_word(current_line, @byte_pointer)
part = current_line.byteslice(@byte_pointer, byte_size).grapheme_clusters.map { |mbchar|
mbchar =~ /[a-z]/ ? mbchar.upcase : mbchar
}.join
rest = current_line.byteslice((@byte_pointer + byte_size)..-1)
line = current_line.byteslice(0, @byte_pointer) + part
set_current_line(line + rest, line.bytesize)
end
end
alias_method :upcase_word, :em_upper_case
private def em_kill_region(key)
if @byte_pointer > 0
byte_size, _ = Reline::Unicode.em_big_backward_word(current_line, @byte_pointer)
line, deleted = byteslice!(current_line, @byte_pointer - byte_size, byte_size)
set_current_line(line, @byte_pointer - byte_size)
@kill_ring.append(deleted, true)
end
end
alias_method :unix_word_rubout, :em_kill_region
private def copy_for_vi(text)
if @config.editing_mode_is?(:vi_insert) or @config.editing_mode_is?(:vi_command)
@vi_clipboard = text
end
end
private def vi_insert(key)
@config.editing_mode = :vi_insert
end
private def vi_add(key)
@config.editing_mode = :vi_insert
ed_next_char(key)
end
private def vi_command_mode(key)
ed_prev_char(key)
@config.editing_mode = :vi_command
end
alias_method :vi_movement_mode, :vi_command_mode
private def vi_next_word(key, arg: 1)
if current_line.bytesize > @byte_pointer
byte_size, _ = Reline::Unicode.vi_forward_word(current_line, @byte_pointer, @drop_terminate_spaces)
@byte_pointer += byte_size
end
arg -= 1
vi_next_word(key, arg: arg) if arg > 0
end
private def vi_prev_word(key, arg: 1)
if @byte_pointer > 0
byte_size, _ = Reline::Unicode.vi_backward_word(current_line, @byte_pointer)
@byte_pointer -= byte_size
end
arg -= 1
vi_prev_word(key, arg: arg) if arg > 0
end
private def vi_end_word(key, arg: 1, inclusive: false)
if current_line.bytesize > @byte_pointer
byte_size, _ = Reline::Unicode.vi_forward_end_word(current_line, @byte_pointer)
@byte_pointer += byte_size
end
arg -= 1
if inclusive and arg.zero?
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
if byte_size > 0
@byte_pointer += byte_size
end
end
vi_end_word(key, arg: arg) if arg > 0
end
private def vi_next_big_word(key, arg: 1)
if current_line.bytesize > @byte_pointer
byte_size, _ = Reline::Unicode.vi_big_forward_word(current_line, @byte_pointer)
@byte_pointer += byte_size
end
arg -= 1
vi_next_big_word(key, arg: arg) if arg > 0
end
private def vi_prev_big_word(key, arg: 1)
if @byte_pointer > 0
byte_size, _ = Reline::Unicode.vi_big_backward_word(current_line, @byte_pointer)
@byte_pointer -= byte_size
end
arg -= 1
vi_prev_big_word(key, arg: arg) if arg > 0
end
private def vi_end_big_word(key, arg: 1, inclusive: false)
if current_line.bytesize > @byte_pointer
byte_size, _ = Reline::Unicode.vi_big_forward_end_word(current_line, @byte_pointer)
@byte_pointer += byte_size
end
arg -= 1
if inclusive and arg.zero?
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
if byte_size > 0
@byte_pointer += byte_size
end
end
vi_end_big_word(key, arg: arg) if arg > 0
end
private def vi_delete_prev_char(key)
if @byte_pointer == 0 and @line_index > 0
@byte_pointer = @buffer_of_lines[@line_index - 1].bytesize
@buffer_of_lines[@line_index - 1] += @buffer_of_lines.delete_at(@line_index)
@line_index -= 1
process_auto_indent cursor_dependent: false
elsif @byte_pointer > 0
byte_size = Reline::Unicode.get_prev_mbchar_size(current_line, @byte_pointer)
@byte_pointer -= byte_size
line, _ = byteslice!(current_line, @byte_pointer, byte_size)
set_current_line(line)
end
end
private def vi_insert_at_bol(key)
ed_move_to_beg(key)
@config.editing_mode = :vi_insert
end
private def vi_add_at_eol(key)
ed_move_to_end(key)
@config.editing_mode = :vi_insert
end
private def ed_delete_prev_char(key, arg: 1)
deleted = +''
arg.times do
if @byte_pointer > 0
byte_size = Reline::Unicode.get_prev_mbchar_size(current_line, @byte_pointer)
@byte_pointer -= byte_size
line, mbchar = byteslice!(current_line, @byte_pointer, byte_size)
set_current_line(line)
deleted.prepend(mbchar)
end
end
copy_for_vi(deleted)
end
private def vi_change_meta(key, arg: nil)
if @vi_waiting_operator
set_current_line('', 0) if @vi_waiting_operator == :vi_change_meta_confirm && arg.nil?
@vi_waiting_operator = nil
@vi_waiting_operator_arg = nil
else
@drop_terminate_spaces = true
@vi_waiting_operator = :vi_change_meta_confirm
@vi_waiting_operator_arg = arg || 1
end
end
private def vi_change_meta_confirm(byte_pointer_diff)
vi_delete_meta_confirm(byte_pointer_diff)
@config.editing_mode = :vi_insert
@drop_terminate_spaces = false
end
private def vi_delete_meta(key, arg: nil)
if @vi_waiting_operator
set_current_line('', 0) if @vi_waiting_operator == :vi_delete_meta_confirm && arg.nil?
@vi_waiting_operator = nil
@vi_waiting_operator_arg = nil
else
@vi_waiting_operator = :vi_delete_meta_confirm
@vi_waiting_operator_arg = arg || 1
end
end
private def vi_delete_meta_confirm(byte_pointer_diff)
if byte_pointer_diff > 0
line, cut = byteslice!(current_line, @byte_pointer, byte_pointer_diff)
elsif byte_pointer_diff < 0
line, cut = byteslice!(current_line, @byte_pointer + byte_pointer_diff, -byte_pointer_diff)
else
return
end
copy_for_vi(cut)
set_current_line(line, @byte_pointer + (byte_pointer_diff < 0 ? byte_pointer_diff : 0))
end
private def vi_yank(key, arg: nil)
if @vi_waiting_operator
copy_for_vi(current_line) if @vi_waiting_operator == :vi_yank_confirm && arg.nil?
@vi_waiting_operator = nil
@vi_waiting_operator_arg = nil
else
@vi_waiting_operator = :vi_yank_confirm
@vi_waiting_operator_arg = arg || 1
end
end
private def vi_yank_confirm(byte_pointer_diff)
if byte_pointer_diff > 0
cut = current_line.byteslice(@byte_pointer, byte_pointer_diff)
elsif byte_pointer_diff < 0
cut = current_line.byteslice(@byte_pointer + byte_pointer_diff, -byte_pointer_diff)
else
return
end
copy_for_vi(cut)
end
private def vi_list_or_eof(key)
if buffer_empty?
@eof = true
finish
else
ed_newline(key)
end
end
alias_method :vi_end_of_transmission, :vi_list_or_eof
alias_method :vi_eof_maybe, :vi_list_or_eof
private def ed_delete_next_char(key, arg: 1)
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
unless current_line.empty? || byte_size == 0
line, mbchar = byteslice!(current_line, @byte_pointer, byte_size)
copy_for_vi(mbchar)
if @byte_pointer > 0 && current_line.bytesize == @byte_pointer + byte_size
byte_size = Reline::Unicode.get_prev_mbchar_size(line, @byte_pointer)
set_current_line(line, @byte_pointer - byte_size)
else
set_current_line(line, @byte_pointer)
end
end
arg -= 1
ed_delete_next_char(key, arg: arg) if arg > 0
end
private def vi_to_history_line(key)
if Reline::HISTORY.empty?
return
end
move_history(0, line: :start, cursor: :start)
end
private def vi_histedit(key)
path = Tempfile.open { |fp|
fp.write whole_lines.join("\n")
fp.path
}
system("#{ENV['EDITOR']} #{path}")
@buffer_of_lines = File.read(path).split("\n")
@buffer_of_lines = [String.new(encoding: @encoding)] if @buffer_of_lines.empty?
@line_index = 0
finish
end
private def vi_paste_prev(key, arg: 1)
if @vi_clipboard.size > 0
cursor_point = @vi_clipboard.grapheme_clusters[0..-2].join
set_current_line(byteinsert(current_line, @byte_pointer, @vi_clipboard), @byte_pointer + cursor_point.bytesize)
end
arg -= 1
vi_paste_prev(key, arg: arg) if arg > 0
end
private def vi_paste_next(key, arg: 1)
if @vi_clipboard.size > 0
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
line = byteinsert(current_line, @byte_pointer + byte_size, @vi_clipboard)
set_current_line(line, @byte_pointer + @vi_clipboard.bytesize)
end
arg -= 1
vi_paste_next(key, arg: arg) if arg > 0
end
private def ed_argument_digit(key)
if @vi_arg.nil?
if key.chr.to_i.zero?
if key.anybits?(0b10000000)
unescaped_key = key ^ 0b10000000
unless unescaped_key.chr.to_i.zero?
@vi_arg = unescaped_key.chr.to_i
end
end
else
@vi_arg = key.chr.to_i
end
else
@vi_arg = @vi_arg * 10 + key.chr.to_i
end
end
private def vi_to_column(key, arg: 0)
# Implementing behavior of vi, not Readline's vi-mode.
@byte_pointer, = current_line.grapheme_clusters.inject([0, 0]) { |(total_byte_size, total_width), gc|
mbchar_width = Reline::Unicode.get_mbchar_width(gc)
break [total_byte_size, total_width] if (total_width + mbchar_width) >= arg
[total_byte_size + gc.bytesize, total_width + mbchar_width]
}
end
private def vi_replace_char(key, arg: 1)
@waiting_proc = ->(k) {
if arg == 1
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
before = current_line.byteslice(0, @byte_pointer)
remaining_point = @byte_pointer + byte_size
after = current_line.byteslice(remaining_point, current_line.bytesize - remaining_point)
set_current_line(before + k.chr + after)
@waiting_proc = nil
elsif arg > 1
byte_size = 0
arg.times do
byte_size += Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer + byte_size)
end
before = current_line.byteslice(0, @byte_pointer)
remaining_point = @byte_pointer + byte_size
after = current_line.byteslice(remaining_point, current_line.bytesize - remaining_point)
replaced = k.chr * arg
set_current_line(before + replaced + after, @byte_pointer + replaced.bytesize)
@waiting_proc = nil
end
}
end
private def vi_next_char(key, arg: 1, inclusive: false)
@waiting_proc = ->(key_for_proc) { search_next_char(key_for_proc, arg, inclusive: inclusive) }
end
private def vi_to_next_char(key, arg: 1, inclusive: false)
@waiting_proc = ->(key_for_proc) { search_next_char(key_for_proc, arg, need_prev_char: true, inclusive: inclusive) }
end
private def search_next_char(key, arg, need_prev_char: false, inclusive: false)
if key.instance_of?(String)
inputed_char = key
else
inputed_char = key.chr
end
prev_total = nil
total = nil
found = false
current_line.byteslice(@byte_pointer..-1).grapheme_clusters.each do |mbchar|
# total has [byte_size, cursor]
unless total
# skip cursor point
width = Reline::Unicode.get_mbchar_width(mbchar)
total = [mbchar.bytesize, width]
else
if inputed_char == mbchar
arg -= 1
if arg.zero?
found = true
break
end
end
width = Reline::Unicode.get_mbchar_width(mbchar)
prev_total = total
total = [total.first + mbchar.bytesize, total.last + width]
end
end
if not need_prev_char and found and total
byte_size, _ = total
@byte_pointer += byte_size
elsif need_prev_char and found and prev_total
byte_size, _ = prev_total
@byte_pointer += byte_size
end
if inclusive
byte_size = Reline::Unicode.get_next_mbchar_size(current_line, @byte_pointer)
if byte_size > 0
@byte_pointer += byte_size
end
end
@waiting_proc = nil
end
private def vi_prev_char(key, arg: 1)
@waiting_proc = ->(key_for_proc) { search_prev_char(key_for_proc, arg) }
end
private def vi_to_prev_char(key, arg: 1)
@waiting_proc = ->(key_for_proc) { search_prev_char(key_for_proc, arg, true) }
end
private def search_prev_char(key, arg, need_next_char = false)
if key.instance_of?(String)
inputed_char = key
else
inputed_char = key.chr
end
prev_total = nil
total = nil
found = false
current_line.byteslice(0..@byte_pointer).grapheme_clusters.reverse_each do |mbchar|
# total has [byte_size, cursor]
unless total
# skip cursor point
width = Reline::Unicode.get_mbchar_width(mbchar)
total = [mbchar.bytesize, width]
else
if inputed_char == mbchar
arg -= 1
if arg.zero?
found = true
break
end
end
width = Reline::Unicode.get_mbchar_width(mbchar)
prev_total = total
total = [total.first + mbchar.bytesize, total.last + width]
end
end
if not need_next_char and found and total
byte_size, _ = total
@byte_pointer -= byte_size
elsif need_next_char and found and prev_total
byte_size, _ = prev_total
@byte_pointer -= byte_size
end
@waiting_proc = nil
end
private def vi_join_lines(key, arg: 1)
if @buffer_of_lines.size > @line_index + 1
next_line = @buffer_of_lines.delete_at(@line_index + 1).lstrip
set_current_line(current_line + ' ' + next_line, current_line.bytesize)
end
arg -= 1
vi_join_lines(key, arg: arg) if arg > 0
end
private def em_set_mark(key)
@mark_pointer = [@byte_pointer, @line_index]
end
alias_method :set_mark, :em_set_mark
private def em_exchange_mark(key)
return unless @mark_pointer
new_pointer = [@byte_pointer, @line_index]
@byte_pointer, @line_index = @mark_pointer
@mark_pointer = new_pointer
end
alias_method :exchange_point_and_mark, :em_exchange_mark
private def emacs_editing_mode(key)
@config.editing_mode = :emacs
end
private def vi_editing_mode(key)
@config.editing_mode = :vi_insert
end
private def undo(_key)
@undoing = true
return if @input_lines_position <= 0
@input_lines_position -= 1
target_lines, target_cursor_x, target_cursor_y = @input_lines[@input_lines_position]
set_current_lines(target_lines.dup, target_cursor_x, target_cursor_y)
end
private def redo(_key)
@undoing = true
return if @input_lines_position >= @input_lines.size - 1
@input_lines_position += 1
target_lines, target_cursor_x, target_cursor_y = @input_lines[@input_lines_position]
set_current_lines(target_lines.dup, target_cursor_x, target_cursor_y)
end
private def prev_action_state_value(type)
@prev_action_state[0] == type ? @prev_action_state[1] : nil
end
private def set_next_action_state(type, value)
@next_action_state = [type, value]
end
private def re_read_init_file(_key)
@config.reload
end
end
share/ruby/reline/io.rb 0000644 00000001266 15173517736 0011065 0 ustar 00
module Reline
class IO
RESET_COLOR = "\e[0m"
def self.decide_io_gate
if ENV['TERM'] == 'dumb'
Reline::Dumb.new
else
require 'reline/io/ansi'
case RbConfig::CONFIG['host_os']
when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
require 'reline/io/windows'
io = Reline::Windows.new
if io.msys_tty?
Reline::ANSI.new
else
io
end
else
Reline::ANSI.new
end
end
end
def dumb?
false
end
def win?
false
end
def reset_color_sequence
self.class::RESET_COLOR
end
end
end
require 'reline/io/dumb'
share/ruby/reline/config.rb 0000644 00000024154 15173517736 0011724 0 ustar 00 class Reline::Config
attr_reader :test_mode
KEYSEQ_PATTERN = /\\(?:C|Control)-[A-Za-z_]|\\(?:M|Meta)-[0-9A-Za-z_]|\\(?:C|Control)-(?:M|Meta)-[A-Za-z_]|\\(?:M|Meta)-(?:C|Control)-[A-Za-z_]|\\e|\\[\\\"\'abdfnrtv]|\\\d{1,3}|\\x\h{1,2}|./
class InvalidInputrc < RuntimeError
attr_accessor :file, :lineno
end
VARIABLE_NAMES = %w{
completion-ignore-case
convert-meta
disable-completion
history-size
keyseq-timeout
show-all-if-ambiguous
show-mode-in-prompt
vi-cmd-mode-string
vi-ins-mode-string
emacs-mode-string
enable-bracketed-paste
isearch-terminators
}
VARIABLE_NAME_SYMBOLS = VARIABLE_NAMES.map { |v| :"#{v.tr(?-, ?_)}" }
VARIABLE_NAME_SYMBOLS.each do |v|
attr_accessor v
end
attr_accessor :autocompletion
def initialize
reset_variables
end
def reset
if editing_mode_is?(:vi_command)
@editing_mode_label = :vi_insert
end
@oneshot_key_bindings.clear
end
def reset_variables
@additional_key_bindings = { # from inputrc
emacs: Reline::KeyActor::Base.new,
vi_insert: Reline::KeyActor::Base.new,
vi_command: Reline::KeyActor::Base.new
}
@oneshot_key_bindings = Reline::KeyActor::Base.new
@editing_mode_label = :emacs
@keymap_label = :emacs
@keymap_prefix = []
@default_key_bindings = {
emacs: Reline::KeyActor::Base.new(Reline::KeyActor::EMACS_MAPPING),
vi_insert: Reline::KeyActor::Base.new(Reline::KeyActor::VI_INSERT_MAPPING),
vi_command: Reline::KeyActor::Base.new(Reline::KeyActor::VI_COMMAND_MAPPING)
}
@vi_cmd_mode_string = '(cmd)'
@vi_ins_mode_string = '(ins)'
@emacs_mode_string = '@'
# https://tiswww.case.edu/php/chet/readline/readline.html#IDX25
@history_size = -1 # unlimited
@keyseq_timeout = 500
@test_mode = false
@autocompletion = false
@convert_meta = seven_bit_encoding?(Reline::IOGate.encoding)
@loaded = false
@enable_bracketed_paste = true
@show_mode_in_prompt = false
@default_inputrc_path = nil
end
def editing_mode
@default_key_bindings[@editing_mode_label]
end
def editing_mode=(val)
@editing_mode_label = val
end
def editing_mode_is?(*val)
val.any?(@editing_mode_label)
end
def keymap
@default_key_bindings[@keymap_label]
end
def loaded?
@loaded
end
def inputrc_path
case ENV['INPUTRC']
when nil, ''
else
return File.expand_path(ENV['INPUTRC'])
end
# In the XDG Specification, if ~/.config/readline/inputrc exists, then
# ~/.inputrc should not be read, but for compatibility with GNU Readline,
# if ~/.inputrc exists, then it is given priority.
home_rc_path = File.expand_path('~/.inputrc')
return home_rc_path if File.exist?(home_rc_path)
case path = ENV['XDG_CONFIG_HOME']
when nil, ''
else
path = File.join(path, 'readline/inputrc')
return path if File.exist?(path) and path == File.expand_path(path)
end
path = File.expand_path('~/.config/readline/inputrc')
return path if File.exist?(path)
return home_rc_path
end
private def default_inputrc_path
@default_inputrc_path ||= inputrc_path
end
def read(file = nil)
@loaded = true
file ||= default_inputrc_path
begin
if file.respond_to?(:readlines)
lines = file.readlines
else
lines = File.readlines(file)
end
rescue Errno::ENOENT
return nil
end
read_lines(lines, file)
self
rescue InvalidInputrc => e
warn e.message
nil
end
def key_bindings
# The key bindings for each editing mode will be overwritten by the user-defined ones.
Reline::KeyActor::Composite.new([@oneshot_key_bindings, @additional_key_bindings[@editing_mode_label], @default_key_bindings[@editing_mode_label]])
end
def add_oneshot_key_binding(keystroke, target)
# IRB sets invalid keystroke [Reline::Key]. We should ignore it.
return unless keystroke.all? { |c| c.is_a?(Integer) }
@oneshot_key_bindings.add(keystroke, target)
end
def reset_oneshot_key_bindings
@oneshot_key_bindings.clear
end
def add_default_key_binding_by_keymap(keymap, keystroke, target)
@default_key_bindings[keymap].add(keystroke, target)
end
def add_default_key_binding(keystroke, target)
add_default_key_binding_by_keymap(@keymap_label, keystroke, target)
end
def read_lines(lines, file = nil)
if not lines.empty? and lines.first.encoding != Reline.encoding_system_needs
begin
lines = lines.map do |l|
l.encode(Reline.encoding_system_needs)
rescue Encoding::UndefinedConversionError
mes = "The inputrc encoded in #{lines.first.encoding.name} can't be converted to the locale #{Reline.encoding_system_needs.name}."
raise Reline::ConfigEncodingConversionError.new(mes)
end
end
end
if_stack = []
lines.each_with_index do |line, no|
next if line.match(/\A\s*#/)
no += 1
line = line.chomp.lstrip
if line.start_with?('$')
handle_directive(line[1..-1], file, no, if_stack)
next
end
next if if_stack.any? { |_no, skip| skip }
case line
when /^set +([^ ]+) +(.+)/i
# value ignores everything after a space, raw_value does not.
var, value, raw_value = $1.downcase, $2.partition(' ').first, $2
bind_variable(var, value, raw_value)
next
when /\s*("#{KEYSEQ_PATTERN}+")\s*:\s*(.*)\s*$/o
key, func_name = $1, $2
func_name = func_name.split.first
keystroke, func = bind_key(key, func_name)
next unless keystroke
@additional_key_bindings[@keymap_label].add(@keymap_prefix + keystroke, func)
end
end
unless if_stack.empty?
raise InvalidInputrc, "#{file}:#{if_stack.last[0]}: unclosed if"
end
end
def handle_directive(directive, file, no, if_stack)
directive, args = directive.split(' ')
case directive
when 'if'
condition = false
case args
when /^mode=(vi|emacs)$/i
mode = $1.downcase
# NOTE: mode=vi means vi-insert mode
mode = 'vi_insert' if mode == 'vi'
if @editing_mode_label == mode.to_sym
condition = true
end
when 'term'
when 'version'
else # application name
condition = true if args == 'Ruby'
condition = true if args == 'Reline'
end
if_stack << [no, !condition]
when 'else'
if if_stack.empty?
raise InvalidInputrc, "#{file}:#{no}: unmatched else"
end
if_stack.last[1] = !if_stack.last[1]
when 'endif'
if if_stack.empty?
raise InvalidInputrc, "#{file}:#{no}: unmatched endif"
end
if_stack.pop
when 'include'
read(File.expand_path(args))
end
end
def bind_variable(name, value, raw_value)
case name
when 'history-size'
begin
@history_size = Integer(value)
rescue ArgumentError
@history_size = 500
end
when 'isearch-terminators'
@isearch_terminators = retrieve_string(raw_value)
when 'editing-mode'
case value
when 'emacs'
@editing_mode_label = :emacs
@keymap_label = :emacs
@keymap_prefix = []
when 'vi'
@editing_mode_label = :vi_insert
@keymap_label = :vi_insert
@keymap_prefix = []
end
when 'keymap'
case value
when 'emacs', 'emacs-standard'
@keymap_label = :emacs
@keymap_prefix = []
when 'emacs-ctlx'
@keymap_label = :emacs
@keymap_prefix = [?\C-x.ord]
when 'emacs-meta'
@keymap_label = :emacs
@keymap_prefix = [?\e.ord]
when 'vi', 'vi-move', 'vi-command'
@keymap_label = :vi_command
@keymap_prefix = []
when 'vi-insert'
@keymap_label = :vi_insert
@keymap_prefix = []
end
when 'keyseq-timeout'
@keyseq_timeout = value.to_i
when 'show-mode-in-prompt'
case value
when 'off'
@show_mode_in_prompt = false
when 'on'
@show_mode_in_prompt = true
else
@show_mode_in_prompt = false
end
when 'vi-cmd-mode-string'
@vi_cmd_mode_string = retrieve_string(raw_value)
when 'vi-ins-mode-string'
@vi_ins_mode_string = retrieve_string(raw_value)
when 'emacs-mode-string'
@emacs_mode_string = retrieve_string(raw_value)
when *VARIABLE_NAMES then
variable_name = :"@#{name.tr(?-, ?_)}"
instance_variable_set(variable_name, value.nil? || value == '1' || value == 'on')
end
end
def retrieve_string(str)
str = $1 if str =~ /\A"(.*)"\z/
parse_keyseq(str).map { |c| c.chr(Reline.encoding_system_needs) }.join
end
def bind_key(key, func_name)
if key =~ /\A"(.*)"\z/
keyseq = parse_keyseq($1)
else
keyseq = nil
end
if func_name =~ /"(.*)"/
func = parse_keyseq($1)
else
func = func_name.tr(?-, ?_).to_sym # It must be macro.
end
[keyseq, func]
end
def key_notation_to_code(notation)
case notation
when /\\(?:C|Control)-([A-Za-z_])/
(1 + $1.downcase.ord - ?a.ord)
when /\\(?:M|Meta)-([0-9A-Za-z_])/
modified_key = $1
case $1
when /[0-9]/
?\M-0.bytes.first + (modified_key.ord - ?0.ord)
when /[A-Z]/
?\M-A.bytes.first + (modified_key.ord - ?A.ord)
when /[a-z]/
?\M-a.bytes.first + (modified_key.ord - ?a.ord)
end
when /\\(?:C|Control)-(?:M|Meta)-[A-Za-z_]/, /\\(?:M|Meta)-(?:C|Control)-[A-Za-z_]/
# 129 M-^A
when /\\(\d{1,3})/ then $1.to_i(8) # octal
when /\\x(\h{1,2})/ then $1.to_i(16) # hexadecimal
when "\\e" then ?\e.ord
when "\\\\" then ?\\.ord
when "\\\"" then ?".ord
when "\\'" then ?'.ord
when "\\a" then ?\a.ord
when "\\b" then ?\b.ord
when "\\d" then ?\d.ord
when "\\f" then ?\f.ord
when "\\n" then ?\n.ord
when "\\r" then ?\r.ord
when "\\t" then ?\t.ord
when "\\v" then ?\v.ord
else notation.ord
end
end
def parse_keyseq(str)
ret = []
str.scan(KEYSEQ_PATTERN) do
ret << key_notation_to_code($&)
end
ret
end
def reload
reset_variables
read
end
private def seven_bit_encoding?(encoding)
encoding == Encoding::US_ASCII
end
end
share/ruby/reline/key_actor/emacs.rb 0000644 00000020050 15173517736 0013516 0 ustar 00 module Reline::KeyActor
EMACS_MAPPING = [
# 0 ^@
:em_set_mark,
# 1 ^A
:ed_move_to_beg,
# 2 ^B
:ed_prev_char,
# 3 ^C
:ed_ignore,
# 4 ^D
:em_delete,
# 5 ^E
:ed_move_to_end,
# 6 ^F
:ed_next_char,
# 7 ^G
:ed_unassigned,
# 8 ^H
:em_delete_prev_char,
# 9 ^I
:complete,
# 10 ^J
:ed_newline,
# 11 ^K
:ed_kill_line,
# 12 ^L
:ed_clear_screen,
# 13 ^M
:ed_newline,
# 14 ^N
:ed_next_history,
# 15 ^O
:ed_ignore,
# 16 ^P
:ed_prev_history,
# 17 ^Q
:ed_quoted_insert,
# 18 ^R
:vi_search_prev,
# 19 ^S
:vi_search_next,
# 20 ^T
:ed_transpose_chars,
# 21 ^U
:unix_line_discard,
# 22 ^V
:ed_quoted_insert,
# 23 ^W
:em_kill_region,
# 24 ^X
:ed_unassigned,
# 25 ^Y
:em_yank,
# 26 ^Z
:ed_ignore,
# 27 ^[
:ed_unassigned,
# 28 ^\
:ed_ignore,
# 29 ^]
:ed_ignore,
# 30 ^^
:ed_unassigned,
# 31 ^_
:undo,
# 32 SPACE
:ed_insert,
# 33 !
:ed_insert,
# 34 "
:ed_insert,
# 35 #
:ed_insert,
# 36 $
:ed_insert,
# 37 %
:ed_insert,
# 38 &
:ed_insert,
# 39 '
:ed_insert,
# 40 (
:ed_insert,
# 41 )
:ed_insert,
# 42 *
:ed_insert,
# 43 +
:ed_insert,
# 44 ,
:ed_insert,
# 45 -
:ed_insert,
# 46 .
:ed_insert,
# 47 /
:ed_insert,
# 48 0
:ed_digit,
# 49 1
:ed_digit,
# 50 2
:ed_digit,
# 51 3
:ed_digit,
# 52 4
:ed_digit,
# 53 5
:ed_digit,
# 54 6
:ed_digit,
# 55 7
:ed_digit,
# 56 8
:ed_digit,
# 57 9
:ed_digit,
# 58 :
:ed_insert,
# 59 ;
:ed_insert,
# 60 <
:ed_insert,
# 61 =
:ed_insert,
# 62 >
:ed_insert,
# 63 ?
:ed_insert,
# 64 @
:ed_insert,
# 65 A
:ed_insert,
# 66 B
:ed_insert,
# 67 C
:ed_insert,
# 68 D
:ed_insert,
# 69 E
:ed_insert,
# 70 F
:ed_insert,
# 71 G
:ed_insert,
# 72 H
:ed_insert,
# 73 I
:ed_insert,
# 74 J
:ed_insert,
# 75 K
:ed_insert,
# 76 L
:ed_insert,
# 77 M
:ed_insert,
# 78 N
:ed_insert,
# 79 O
:ed_insert,
# 80 P
:ed_insert,
# 81 Q
:ed_insert,
# 82 R
:ed_insert,
# 83 S
:ed_insert,
# 84 T
:ed_insert,
# 85 U
:ed_insert,
# 86 V
:ed_insert,
# 87 W
:ed_insert,
# 88 X
:ed_insert,
# 89 Y
:ed_insert,
# 90 Z
:ed_insert,
# 91 [
:ed_insert,
# 92 \
:ed_insert,
# 93 ]
:ed_insert,
# 94 ^
:ed_insert,
# 95 _
:ed_insert,
# 96 `
:ed_insert,
# 97 a
:ed_insert,
# 98 b
:ed_insert,
# 99 c
:ed_insert,
# 100 d
:ed_insert,
# 101 e
:ed_insert,
# 102 f
:ed_insert,
# 103 g
:ed_insert,
# 104 h
:ed_insert,
# 105 i
:ed_insert,
# 106 j
:ed_insert,
# 107 k
:ed_insert,
# 108 l
:ed_insert,
# 109 m
:ed_insert,
# 110 n
:ed_insert,
# 111 o
:ed_insert,
# 112 p
:ed_insert,
# 113 q
:ed_insert,
# 114 r
:ed_insert,
# 115 s
:ed_insert,
# 116 t
:ed_insert,
# 117 u
:ed_insert,
# 118 v
:ed_insert,
# 119 w
:ed_insert,
# 120 x
:ed_insert,
# 121 y
:ed_insert,
# 122 z
:ed_insert,
# 123 {
:ed_insert,
# 124 |
:ed_insert,
# 125 }
:ed_insert,
# 126 ~
:ed_insert,
# 127 ^?
:em_delete_prev_char,
# 128 M-^@
:ed_unassigned,
# 129 M-^A
:ed_unassigned,
# 130 M-^B
:ed_unassigned,
# 131 M-^C
:ed_unassigned,
# 132 M-^D
:ed_unassigned,
# 133 M-^E
:ed_unassigned,
# 134 M-^F
:ed_unassigned,
# 135 M-^G
:ed_unassigned,
# 136 M-^H
:ed_delete_prev_word,
# 137 M-^I
:ed_unassigned,
# 138 M-^J
:key_newline,
# 139 M-^K
:ed_unassigned,
# 140 M-^L
:ed_clear_screen,
# 141 M-^M
:key_newline,
# 142 M-^N
:ed_unassigned,
# 143 M-^O
:ed_unassigned,
# 144 M-^P
:ed_unassigned,
# 145 M-^Q
:ed_unassigned,
# 146 M-^R
:ed_unassigned,
# 147 M-^S
:ed_unassigned,
# 148 M-^T
:ed_unassigned,
# 149 M-^U
:ed_unassigned,
# 150 M-^V
:ed_unassigned,
# 151 M-^W
:ed_unassigned,
# 152 M-^X
:ed_unassigned,
# 153 M-^Y
:em_yank_pop,
# 154 M-^Z
:ed_unassigned,
# 155 M-^[
:ed_unassigned,
# 156 M-^\
:ed_unassigned,
# 157 M-^]
:ed_unassigned,
# 158 M-^^
:ed_unassigned,
# 159 M-^_
:redo,
# 160 M-SPACE
:em_set_mark,
# 161 M-!
:ed_unassigned,
# 162 M-"
:ed_unassigned,
# 163 M-#
:ed_unassigned,
# 164 M-$
:ed_unassigned,
# 165 M-%
:ed_unassigned,
# 166 M-&
:ed_unassigned,
# 167 M-'
:ed_unassigned,
# 168 M-(
:ed_unassigned,
# 169 M-)
:ed_unassigned,
# 170 M-*
:ed_unassigned,
# 171 M-+
:ed_unassigned,
# 172 M-,
:ed_unassigned,
# 173 M--
:ed_unassigned,
# 174 M-.
:ed_unassigned,
# 175 M-/
:ed_unassigned,
# 176 M-0
:ed_argument_digit,
# 177 M-1
:ed_argument_digit,
# 178 M-2
:ed_argument_digit,
# 179 M-3
:ed_argument_digit,
# 180 M-4
:ed_argument_digit,
# 181 M-5
:ed_argument_digit,
# 182 M-6
:ed_argument_digit,
# 183 M-7
:ed_argument_digit,
# 184 M-8
:ed_argument_digit,
# 185 M-9
:ed_argument_digit,
# 186 M-:
:ed_unassigned,
# 187 M-;
:ed_unassigned,
# 188 M-<
:ed_unassigned,
# 189 M-=
:ed_unassigned,
# 190 M->
:ed_unassigned,
# 191 M-?
:ed_unassigned,
# 192 M-@
:ed_unassigned,
# 193 M-A
:ed_unassigned,
# 194 M-B
:ed_prev_word,
# 195 M-C
:em_capitol_case,
# 196 M-D
:em_delete_next_word,
# 197 M-E
:ed_unassigned,
# 198 M-F
:em_next_word,
# 199 M-G
:ed_unassigned,
# 200 M-H
:ed_unassigned,
# 201 M-I
:ed_unassigned,
# 202 M-J
:ed_unassigned,
# 203 M-K
:ed_unassigned,
# 204 M-L
:em_lower_case,
# 205 M-M
:ed_unassigned,
# 206 M-N
:vi_search_next,
# 207 M-O
:ed_unassigned,
# 208 M-P
:vi_search_prev,
# 209 M-Q
:ed_unassigned,
# 210 M-R
:ed_unassigned,
# 211 M-S
:ed_unassigned,
# 212 M-T
:ed_unassigned,
# 213 M-U
:em_upper_case,
# 214 M-V
:ed_unassigned,
# 215 M-W
:ed_unassigned,
# 216 M-X
:ed_unassigned,
# 217 M-Y
:em_yank_pop,
# 218 M-Z
:ed_unassigned,
# 219 M-[
:ed_unassigned,
# 220 M-\
:ed_unassigned,
# 221 M-]
:ed_unassigned,
# 222 M-^
:ed_unassigned,
# 223 M-_
:ed_unassigned,
# 224 M-`
:ed_unassigned,
# 225 M-a
:ed_unassigned,
# 226 M-b
:ed_prev_word,
# 227 M-c
:em_capitol_case,
# 228 M-d
:em_delete_next_word,
# 229 M-e
:ed_unassigned,
# 230 M-f
:em_next_word,
# 231 M-g
:ed_unassigned,
# 232 M-h
:ed_unassigned,
# 233 M-i
:ed_unassigned,
# 234 M-j
:ed_unassigned,
# 235 M-k
:ed_unassigned,
# 236 M-l
:em_lower_case,
# 237 M-m
:ed_unassigned,
# 238 M-n
:vi_search_next,
# 239 M-o
:ed_unassigned,
# 240 M-p
:vi_search_prev,
# 241 M-q
:ed_unassigned,
# 242 M-r
:ed_unassigned,
# 243 M-s
:ed_unassigned,
# 244 M-t
:ed_transpose_words,
# 245 M-u
:em_upper_case,
# 246 M-v
:ed_unassigned,
# 247 M-w
:ed_unassigned,
# 248 M-x
:ed_unassigned,
# 249 M-y
:ed_unassigned,
# 250 M-z
:ed_unassigned,
# 251 M-{
:ed_unassigned,
# 252 M-|
:ed_unassigned,
# 253 M-}
:ed_unassigned,
# 254 M-~
:ed_unassigned,
# 255 M-^?
:ed_delete_prev_word
# EOF
]
end
share/ruby/reline/key_actor/composite.rb 0000644 00000000504 15173517736 0014432 0 ustar 00 class Reline::KeyActor::Composite
def initialize(key_actors)
@key_actors = key_actors
end
def matching?(key)
@key_actors.any? { |key_actor| key_actor.matching?(key) }
end
def get(key)
@key_actors.each do |key_actor|
func = key_actor.get(key)
return func if func
end
nil
end
end
share/ruby/reline/key_actor/vi_insert.rb 0000644 00000017746 15173517736 0014452 0 ustar 00 module Reline::KeyActor
VI_INSERT_MAPPING = [
# 0 ^@
:ed_unassigned,
# 1 ^A
:ed_insert,
# 2 ^B
:ed_insert,
# 3 ^C
:ed_insert,
# 4 ^D
:vi_list_or_eof,
# 5 ^E
:ed_insert,
# 6 ^F
:ed_insert,
# 7 ^G
:ed_insert,
# 8 ^H
:vi_delete_prev_char,
# 9 ^I
:complete,
# 10 ^J
:ed_newline,
# 11 ^K
:ed_insert,
# 12 ^L
:ed_insert,
# 13 ^M
:ed_newline,
# 14 ^N
:menu_complete,
# 15 ^O
:ed_insert,
# 16 ^P
:menu_complete_backward,
# 17 ^Q
:ed_ignore,
# 18 ^R
:vi_search_prev,
# 19 ^S
:vi_search_next,
# 20 ^T
:ed_transpose_chars,
# 21 ^U
:vi_kill_line_prev,
# 22 ^V
:ed_quoted_insert,
# 23 ^W
:ed_delete_prev_word,
# 24 ^X
:ed_insert,
# 25 ^Y
:em_yank,
# 26 ^Z
:ed_insert,
# 27 ^[
:vi_command_mode,
# 28 ^\
:ed_ignore,
# 29 ^]
:ed_insert,
# 30 ^^
:ed_insert,
# 31 ^_
:ed_insert,
# 32 SPACE
:ed_insert,
# 33 !
:ed_insert,
# 34 "
:ed_insert,
# 35 #
:ed_insert,
# 36 $
:ed_insert,
# 37 %
:ed_insert,
# 38 &
:ed_insert,
# 39 '
:ed_insert,
# 40 (
:ed_insert,
# 41 )
:ed_insert,
# 42 *
:ed_insert,
# 43 +
:ed_insert,
# 44 ,
:ed_insert,
# 45 -
:ed_insert,
# 46 .
:ed_insert,
# 47 /
:ed_insert,
# 48 0
:ed_insert,
# 49 1
:ed_insert,
# 50 2
:ed_insert,
# 51 3
:ed_insert,
# 52 4
:ed_insert,
# 53 5
:ed_insert,
# 54 6
:ed_insert,
# 55 7
:ed_insert,
# 56 8
:ed_insert,
# 57 9
:ed_insert,
# 58 :
:ed_insert,
# 59 ;
:ed_insert,
# 60 <
:ed_insert,
# 61 =
:ed_insert,
# 62 >
:ed_insert,
# 63 ?
:ed_insert,
# 64 @
:ed_insert,
# 65 A
:ed_insert,
# 66 B
:ed_insert,
# 67 C
:ed_insert,
# 68 D
:ed_insert,
# 69 E
:ed_insert,
# 70 F
:ed_insert,
# 71 G
:ed_insert,
# 72 H
:ed_insert,
# 73 I
:ed_insert,
# 74 J
:ed_insert,
# 75 K
:ed_insert,
# 76 L
:ed_insert,
# 77 M
:ed_insert,
# 78 N
:ed_insert,
# 79 O
:ed_insert,
# 80 P
:ed_insert,
# 81 Q
:ed_insert,
# 82 R
:ed_insert,
# 83 S
:ed_insert,
# 84 T
:ed_insert,
# 85 U
:ed_insert,
# 86 V
:ed_insert,
# 87 W
:ed_insert,
# 88 X
:ed_insert,
# 89 Y
:ed_insert,
# 90 Z
:ed_insert,
# 91 [
:ed_insert,
# 92 \
:ed_insert,
# 93 ]
:ed_insert,
# 94 ^
:ed_insert,
# 95 _
:ed_insert,
# 96 `
:ed_insert,
# 97 a
:ed_insert,
# 98 b
:ed_insert,
# 99 c
:ed_insert,
# 100 d
:ed_insert,
# 101 e
:ed_insert,
# 102 f
:ed_insert,
# 103 g
:ed_insert,
# 104 h
:ed_insert,
# 105 i
:ed_insert,
# 106 j
:ed_insert,
# 107 k
:ed_insert,
# 108 l
:ed_insert,
# 109 m
:ed_insert,
# 110 n
:ed_insert,
# 111 o
:ed_insert,
# 112 p
:ed_insert,
# 113 q
:ed_insert,
# 114 r
:ed_insert,
# 115 s
:ed_insert,
# 116 t
:ed_insert,
# 117 u
:ed_insert,
# 118 v
:ed_insert,
# 119 w
:ed_insert,
# 120 x
:ed_insert,
# 121 y
:ed_insert,
# 122 z
:ed_insert,
# 123 {
:ed_insert,
# 124 |
:ed_insert,
# 125 }
:ed_insert,
# 126 ~
:ed_insert,
# 127 ^?
:vi_delete_prev_char,
# 128 M-^@
:ed_unassigned,
# 129 M-^A
:ed_unassigned,
# 130 M-^B
:ed_unassigned,
# 131 M-^C
:ed_unassigned,
# 132 M-^D
:ed_unassigned,
# 133 M-^E
:ed_unassigned,
# 134 M-^F
:ed_unassigned,
# 135 M-^G
:ed_unassigned,
# 136 M-^H
:ed_unassigned,
# 137 M-^I
:ed_unassigned,
# 138 M-^J
:key_newline,
# 139 M-^K
:ed_unassigned,
# 140 M-^L
:ed_unassigned,
# 141 M-^M
:key_newline,
# 142 M-^N
:ed_unassigned,
# 143 M-^O
:ed_unassigned,
# 144 M-^P
:ed_unassigned,
# 145 M-^Q
:ed_unassigned,
# 146 M-^R
:ed_unassigned,
# 147 M-^S
:ed_unassigned,
# 148 M-^T
:ed_unassigned,
# 149 M-^U
:ed_unassigned,
# 150 M-^V
:ed_unassigned,
# 151 M-^W
:ed_unassigned,
# 152 M-^X
:ed_unassigned,
# 153 M-^Y
:ed_unassigned,
# 154 M-^Z
:ed_unassigned,
# 155 M-^[
:ed_unassigned,
# 156 M-^\
:ed_unassigned,
# 157 M-^]
:ed_unassigned,
# 158 M-^^
:ed_unassigned,
# 159 M-^_
:ed_unassigned,
# 160 M-SPACE
:ed_unassigned,
# 161 M-!
:ed_unassigned,
# 162 M-"
:ed_unassigned,
# 163 M-#
:ed_unassigned,
# 164 M-$
:ed_unassigned,
# 165 M-%
:ed_unassigned,
# 166 M-&
:ed_unassigned,
# 167 M-'
:ed_unassigned,
# 168 M-(
:ed_unassigned,
# 169 M-)
:ed_unassigned,
# 170 M-*
:ed_unassigned,
# 171 M-+
:ed_unassigned,
# 172 M-,
:ed_unassigned,
# 173 M--
:ed_unassigned,
# 174 M-.
:ed_unassigned,
# 175 M-/
:ed_unassigned,
# 176 M-0
:ed_unassigned,
# 177 M-1
:ed_unassigned,
# 178 M-2
:ed_unassigned,
# 179 M-3
:ed_unassigned,
# 180 M-4
:ed_unassigned,
# 181 M-5
:ed_unassigned,
# 182 M-6
:ed_unassigned,
# 183 M-7
:ed_unassigned,
# 184 M-8
:ed_unassigned,
# 185 M-9
:ed_unassigned,
# 186 M-:
:ed_unassigned,
# 187 M-;
:ed_unassigned,
# 188 M-<
:ed_unassigned,
# 189 M-=
:ed_unassigned,
# 190 M->
:ed_unassigned,
# 191 M-?
:ed_unassigned,
# 192 M-@
:ed_unassigned,
# 193 M-A
:ed_unassigned,
# 194 M-B
:ed_unassigned,
# 195 M-C
:ed_unassigned,
# 196 M-D
:ed_unassigned,
# 197 M-E
:ed_unassigned,
# 198 M-F
:ed_unassigned,
# 199 M-G
:ed_unassigned,
# 200 M-H
:ed_unassigned,
# 201 M-I
:ed_unassigned,
# 202 M-J
:ed_unassigned,
# 203 M-K
:ed_unassigned,
# 204 M-L
:ed_unassigned,
# 205 M-M
:ed_unassigned,
# 206 M-N
:ed_unassigned,
# 207 M-O
:ed_unassigned,
# 208 M-P
:ed_unassigned,
# 209 M-Q
:ed_unassigned,
# 210 M-R
:ed_unassigned,
# 211 M-S
:ed_unassigned,
# 212 M-T
:ed_unassigned,
# 213 M-U
:ed_unassigned,
# 214 M-V
:ed_unassigned,
# 215 M-W
:ed_unassigned,
# 216 M-X
:ed_unassigned,
# 217 M-Y
:ed_unassigned,
# 218 M-Z
:ed_unassigned,
# 219 M-[
:ed_unassigned,
# 220 M-\
:ed_unassigned,
# 221 M-]
:ed_unassigned,
# 222 M-^
:ed_unassigned,
# 223 M-_
:ed_unassigned,
# 224 M-`
:ed_unassigned,
# 225 M-a
:ed_unassigned,
# 226 M-b
:ed_unassigned,
# 227 M-c
:ed_unassigned,
# 228 M-d
:ed_unassigned,
# 229 M-e
:ed_unassigned,
# 230 M-f
:ed_unassigned,
# 231 M-g
:ed_unassigned,
# 232 M-h
:ed_unassigned,
# 233 M-i
:ed_unassigned,
# 234 M-j
:ed_unassigned,
# 235 M-k
:ed_unassigned,
# 236 M-l
:ed_unassigned,
# 237 M-m
:ed_unassigned,
# 238 M-n
:ed_unassigned,
# 239 M-o
:ed_unassigned,
# 240 M-p
:ed_unassigned,
# 241 M-q
:ed_unassigned,
# 242 M-r
:ed_unassigned,
# 243 M-s
:ed_unassigned,
# 244 M-t
:ed_unassigned,
# 245 M-u
:ed_unassigned,
# 246 M-v
:ed_unassigned,
# 247 M-w
:ed_unassigned,
# 248 M-x
:ed_unassigned,
# 249 M-y
:ed_unassigned,
# 250 M-z
:ed_unassigned,
# 251 M-{
:ed_unassigned,
# 252 M-|
:ed_unassigned,
# 253 M-}
:ed_unassigned,
# 254 M-~
:ed_unassigned,
# 255 M-^?
:ed_unassigned
# EOF
]
end
share/ruby/reline/key_actor/vi_command.rb 0000644 00000020705 15173517736 0014551 0 ustar 00 module Reline::KeyActor
VI_COMMAND_MAPPING = [
# 0 ^@
:ed_unassigned,
# 1 ^A
:ed_move_to_beg,
# 2 ^B
:ed_unassigned,
# 3 ^C
:ed_ignore,
# 4 ^D
:vi_end_of_transmission,
# 5 ^E
:ed_move_to_end,
# 6 ^F
:ed_unassigned,
# 7 ^G
:ed_unassigned,
# 8 ^H
:ed_prev_char,
# 9 ^I
:ed_unassigned,
# 10 ^J
:ed_newline,
# 11 ^K
:ed_kill_line,
# 12 ^L
:ed_clear_screen,
# 13 ^M
:ed_newline,
# 14 ^N
:ed_next_history,
# 15 ^O
:ed_ignore,
# 16 ^P
:ed_prev_history,
# 17 ^Q
:ed_ignore,
# 18 ^R
:vi_search_prev,
# 19 ^S
:ed_ignore,
# 20 ^T
:ed_transpose_chars,
# 21 ^U
:vi_kill_line_prev,
# 22 ^V
:ed_quoted_insert,
# 23 ^W
:ed_delete_prev_word,
# 24 ^X
:ed_unassigned,
# 25 ^Y
:em_yank,
# 26 ^Z
:ed_unassigned,
# 27 ^[
:ed_unassigned,
# 28 ^\
:ed_ignore,
# 29 ^]
:ed_unassigned,
# 30 ^^
:ed_unassigned,
# 31 ^_
:ed_unassigned,
# 32 SPACE
:ed_next_char,
# 33 !
:ed_unassigned,
# 34 "
:ed_unassigned,
# 35 #
:vi_comment_out,
# 36 $
:ed_move_to_end,
# 37 %
:ed_unassigned,
# 38 &
:ed_unassigned,
# 39 '
:ed_unassigned,
# 40 (
:ed_unassigned,
# 41 )
:ed_unassigned,
# 42 *
:ed_unassigned,
# 43 +
:ed_next_history,
# 44 ,
:ed_unassigned,
# 45 -
:ed_prev_history,
# 46 .
:ed_unassigned,
# 47 /
:vi_search_prev,
# 48 0
:vi_zero,
# 49 1
:ed_argument_digit,
# 50 2
:ed_argument_digit,
# 51 3
:ed_argument_digit,
# 52 4
:ed_argument_digit,
# 53 5
:ed_argument_digit,
# 54 6
:ed_argument_digit,
# 55 7
:ed_argument_digit,
# 56 8
:ed_argument_digit,
# 57 9
:ed_argument_digit,
# 58 :
:ed_unassigned,
# 59 ;
:ed_unassigned,
# 60 <
:ed_unassigned,
# 61 =
:ed_unassigned,
# 62 >
:ed_unassigned,
# 63 ?
:vi_search_next,
# 64 @
:vi_alias,
# 65 A
:vi_add_at_eol,
# 66 B
:vi_prev_big_word,
# 67 C
:vi_change_to_eol,
# 68 D
:ed_kill_line,
# 69 E
:vi_end_big_word,
# 70 F
:vi_prev_char,
# 71 G
:vi_to_history_line,
# 72 H
:ed_unassigned,
# 73 I
:vi_insert_at_bol,
# 74 J
:vi_join_lines,
# 75 K
:vi_search_prev,
# 76 L
:ed_unassigned,
# 77 M
:ed_unassigned,
# 78 N
:ed_unassigned,
# 79 O
:ed_unassigned,
# 80 P
:vi_paste_prev,
# 81 Q
:ed_unassigned,
# 82 R
:ed_unassigned,
# 83 S
:ed_unassigned,
# 84 T
:vi_to_prev_char,
# 85 U
:ed_unassigned,
# 86 V
:ed_unassigned,
# 87 W
:vi_next_big_word,
# 88 X
:ed_delete_prev_char,
# 89 Y
:ed_unassigned,
# 90 Z
:ed_unassigned,
# 91 [
:ed_unassigned,
# 92 \
:ed_unassigned,
# 93 ]
:ed_unassigned,
# 94 ^
:vi_first_print,
# 95 _
:ed_unassigned,
# 96 `
:ed_unassigned,
# 97 a
:vi_add,
# 98 b
:vi_prev_word,
# 99 c
:vi_change_meta,
# 100 d
:vi_delete_meta,
# 101 e
:vi_end_word,
# 102 f
:vi_next_char,
# 103 g
:ed_unassigned,
# 104 h
:ed_prev_char,
# 105 i
:vi_insert,
# 106 j
:ed_next_history,
# 107 k
:ed_prev_history,
# 108 l
:ed_next_char,
# 109 m
:ed_unassigned,
# 110 n
:ed_unassigned,
# 111 o
:ed_unassigned,
# 112 p
:vi_paste_next,
# 113 q
:ed_unassigned,
# 114 r
:vi_replace_char,
# 115 s
:ed_unassigned,
# 116 t
:vi_to_next_char,
# 117 u
:ed_unassigned,
# 118 v
:vi_histedit,
# 119 w
:vi_next_word,
# 120 x
:ed_delete_next_char,
# 121 y
:vi_yank,
# 122 z
:ed_unassigned,
# 123 {
:ed_unassigned,
# 124 |
:vi_to_column,
# 125 }
:ed_unassigned,
# 126 ~
:ed_unassigned,
# 127 ^?
:em_delete_prev_char,
# 128 M-^@
:ed_unassigned,
# 129 M-^A
:ed_unassigned,
# 130 M-^B
:ed_unassigned,
# 131 M-^C
:ed_unassigned,
# 132 M-^D
:ed_unassigned,
# 133 M-^E
:ed_unassigned,
# 134 M-^F
:ed_unassigned,
# 135 M-^G
:ed_unassigned,
# 136 M-^H
:ed_unassigned,
# 137 M-^I
:ed_unassigned,
# 138 M-^J
:ed_unassigned,
# 139 M-^K
:ed_unassigned,
# 140 M-^L
:ed_unassigned,
# 141 M-^M
:ed_unassigned,
# 142 M-^N
:ed_unassigned,
# 143 M-^O
:ed_unassigned,
# 144 M-^P
:ed_unassigned,
# 145 M-^Q
:ed_unassigned,
# 146 M-^R
:ed_unassigned,
# 147 M-^S
:ed_unassigned,
# 148 M-^T
:ed_unassigned,
# 149 M-^U
:ed_unassigned,
# 150 M-^V
:ed_unassigned,
# 151 M-^W
:ed_unassigned,
# 152 M-^X
:ed_unassigned,
# 153 M-^Y
:ed_unassigned,
# 154 M-^Z
:ed_unassigned,
# 155 M-^[
:ed_unassigned,
# 156 M-^\
:ed_unassigned,
# 157 M-^]
:ed_unassigned,
# 158 M-^^
:ed_unassigned,
# 159 M-^_
:ed_unassigned,
# 160 M-SPACE
:ed_unassigned,
# 161 M-!
:ed_unassigned,
# 162 M-"
:ed_unassigned,
# 163 M-#
:ed_unassigned,
# 164 M-$
:ed_unassigned,
# 165 M-%
:ed_unassigned,
# 166 M-&
:ed_unassigned,
# 167 M-'
:ed_unassigned,
# 168 M-(
:ed_unassigned,
# 169 M-)
:ed_unassigned,
# 170 M-*
:ed_unassigned,
# 171 M-+
:ed_unassigned,
# 172 M-,
:ed_unassigned,
# 173 M--
:ed_unassigned,
# 174 M-.
:ed_unassigned,
# 175 M-/
:ed_unassigned,
# 176 M-0
:ed_unassigned,
# 177 M-1
:ed_unassigned,
# 178 M-2
:ed_unassigned,
# 179 M-3
:ed_unassigned,
# 180 M-4
:ed_unassigned,
# 181 M-5
:ed_unassigned,
# 182 M-6
:ed_unassigned,
# 183 M-7
:ed_unassigned,
# 184 M-8
:ed_unassigned,
# 185 M-9
:ed_unassigned,
# 186 M-:
:ed_unassigned,
# 187 M-;
:ed_unassigned,
# 188 M-<
:ed_unassigned,
# 189 M-=
:ed_unassigned,
# 190 M->
:ed_unassigned,
# 191 M-?
:ed_unassigned,
# 192 M-@
:ed_unassigned,
# 193 M-A
:ed_unassigned,
# 194 M-B
:ed_unassigned,
# 195 M-C
:ed_unassigned,
# 196 M-D
:ed_unassigned,
# 197 M-E
:ed_unassigned,
# 198 M-F
:ed_unassigned,
# 199 M-G
:ed_unassigned,
# 200 M-H
:ed_unassigned,
# 201 M-I
:ed_unassigned,
# 202 M-J
:ed_unassigned,
# 203 M-K
:ed_unassigned,
# 204 M-L
:ed_unassigned,
# 205 M-M
:ed_unassigned,
# 206 M-N
:ed_unassigned,
# 207 M-O
:ed_unassigned,
# 208 M-P
:ed_unassigned,
# 209 M-Q
:ed_unassigned,
# 210 M-R
:ed_unassigned,
# 211 M-S
:ed_unassigned,
# 212 M-T
:ed_unassigned,
# 213 M-U
:ed_unassigned,
# 214 M-V
:ed_unassigned,
# 215 M-W
:ed_unassigned,
# 216 M-X
:ed_unassigned,
# 217 M-Y
:ed_unassigned,
# 218 M-Z
:ed_unassigned,
# 219 M-[
:ed_unassigned,
# 220 M-\
:ed_unassigned,
# 221 M-]
:ed_unassigned,
# 222 M-^
:ed_unassigned,
# 223 M-_
:ed_unassigned,
# 224 M-`
:ed_unassigned,
# 225 M-a
:ed_unassigned,
# 226 M-b
:ed_unassigned,
# 227 M-c
:ed_unassigned,
# 228 M-d
:ed_unassigned,
# 229 M-e
:ed_unassigned,
# 230 M-f
:ed_unassigned,
# 231 M-g
:ed_unassigned,
# 232 M-h
:ed_unassigned,
# 233 M-i
:ed_unassigned,
# 234 M-j
:ed_unassigned,
# 235 M-k
:ed_unassigned,
# 236 M-l
:ed_unassigned,
# 237 M-m
:ed_unassigned,
# 238 M-n
:ed_unassigned,
# 239 M-o
:ed_unassigned,
# 240 M-p
:ed_unassigned,
# 241 M-q
:ed_unassigned,
# 242 M-r
:ed_unassigned,
# 243 M-s
:ed_unassigned,
# 244 M-t
:ed_unassigned,
# 245 M-u
:ed_unassigned,
# 246 M-v
:ed_unassigned,
# 247 M-w
:ed_unassigned,
# 248 M-x
:ed_unassigned,
# 249 M-y
:ed_unassigned,
# 250 M-z
:ed_unassigned,
# 251 M-{
:ed_unassigned,
# 252 M-|
:ed_unassigned,
# 253 M-}
:ed_unassigned,
# 254 M-~
:ed_unassigned,
# 255 M-^?
:ed_unassigned
# EOF
]
end
share/ruby/reline/key_actor/base.rb 0000644 00000000764 15173517736 0013352 0 ustar 00 class Reline::KeyActor::Base
def initialize(mapping = [])
@mapping = mapping
@matching_bytes = {}
@key_bindings = {}
end
def get_method(key)
@mapping[key]
end
def add(key, func)
(1...key.size).each do |size|
@matching_bytes[key.take(size)] = true
end
@key_bindings[key] = func
end
def matching?(key)
@matching_bytes[key]
end
def get(key)
@key_bindings[key]
end
def clear
@matching_bytes.clear
@key_bindings.clear
end
end
share/ruby/reline/history.rb 0000644 00000003572 15173517736 0012161 0 ustar 00 class Reline::History < Array
def initialize(config)
@config = config
end
def to_s
'HISTORY'
end
def delete_at(index)
index = check_index(index)
super(index)
end
def [](index)
index = check_index(index) unless index.is_a?(Range)
super(index)
end
def []=(index, val)
index = check_index(index)
super(index, String.new(val, encoding: Reline.encoding_system_needs))
end
def concat(*val)
val.each do |v|
push(*v)
end
end
def push(*val)
# If history_size is zero, all histories are dropped.
return self if @config.history_size.zero?
# If history_size is negative, history size is unlimited.
if @config.history_size.positive?
diff = size + val.size - @config.history_size
if diff > 0
if diff <= size
shift(diff)
else
diff -= size
clear
val.shift(diff)
end
end
end
super(*(val.map{ |v|
String.new(v, encoding: Reline.encoding_system_needs)
}))
end
def <<(val)
# If history_size is zero, all histories are dropped.
return self if @config.history_size.zero?
# If history_size is negative, history size is unlimited.
if @config.history_size.positive?
shift if size + 1 > @config.history_size
end
super(String.new(val, encoding: Reline.encoding_system_needs))
end
private def check_index(index)
index += size if index < 0
if index < -2147483648 or 2147483647 < index
raise RangeError.new("integer #{index} too big to convert to 'int'")
end
# If history_size is negative, history size is unlimited.
if @config.history_size.positive?
if index < -@config.history_size or @config.history_size < index
raise RangeError.new("index=<#{index}>")
end
end
raise IndexError.new("index=<#{index}>") if index < 0 or size <= index
index
end
end
share/ruby/reline/io/dumb.rb 0000644 00000002643 15173517736 0012014 0 ustar 00 require 'io/wait'
class Reline::Dumb < Reline::IO
RESET_COLOR = '' # Do not send color reset sequence
def initialize(encoding: nil)
@input = STDIN
@buf = []
@pasting = false
@encoding = encoding
@screen_size = [24, 80]
end
def dumb?
true
end
def encoding
if @encoding
@encoding
elsif RUBY_PLATFORM =~ /mswin|mingw/
Encoding::UTF_8
else
Encoding::default_external
end
end
def set_default_key_bindings(_)
end
def input=(val)
@input = val
end
def with_raw_input
yield
end
def getc(_timeout_second)
unless @buf.empty?
return @buf.shift
end
c = nil
loop do
Reline.core.line_editor.handle_signal
result = @input.wait_readable(0.1)
next if result.nil?
c = @input.read(1)
break
end
c&.ord
end
def ungetc(c)
@buf.unshift(c)
end
def get_screen_size
@screen_size
end
def cursor_pos
Reline::CursorPos.new(1, 1)
end
def hide_cursor
end
def show_cursor
end
def move_cursor_column(val)
end
def move_cursor_up(val)
end
def move_cursor_down(val)
end
def erase_after_cursor
end
def scroll_down(val)
end
def clear_screen
end
def set_screen_size(rows, columns)
@screen_size = [rows, columns]
end
def set_winch_handler(&handler)
end
def in_pasting?
@pasting
end
def prep
end
def deprep(otio)
end
end
share/ruby/reline/io/ansi.rb 0000644 00000023604 15173517736 0012017 0 ustar 00 require 'io/console'
require 'io/wait'
class Reline::ANSI < Reline::IO
CAPNAME_KEY_BINDINGS = {
'khome' => :ed_move_to_beg,
'kend' => :ed_move_to_end,
'kdch1' => :key_delete,
'kpp' => :ed_search_prev_history,
'knp' => :ed_search_next_history,
'kcuu1' => :ed_prev_history,
'kcud1' => :ed_next_history,
'kcuf1' => :ed_next_char,
'kcub1' => :ed_prev_char,
}
ANSI_CURSOR_KEY_BINDINGS = {
# Up
'A' => [:ed_prev_history, {}],
# Down
'B' => [:ed_next_history, {}],
# Right
'C' => [:ed_next_char, { ctrl: :em_next_word, meta: :em_next_word }],
# Left
'D' => [:ed_prev_char, { ctrl: :ed_prev_word, meta: :ed_prev_word }],
# End
'F' => [:ed_move_to_end, {}],
# Home
'H' => [:ed_move_to_beg, {}],
}
if Reline::Terminfo.enabled?
Reline::Terminfo.setupterm(0, 2)
end
def initialize
@input = STDIN
@output = STDOUT
@buf = []
@old_winch_handler = nil
end
def encoding
Encoding.default_external
end
def set_default_key_bindings(config, allow_terminfo: true)
set_bracketed_paste_key_bindings(config)
set_default_key_bindings_ansi_cursor(config)
if allow_terminfo && Reline::Terminfo.enabled?
set_default_key_bindings_terminfo(config)
else
set_default_key_bindings_comprehensive_list(config)
end
{
[27, 91, 90] => :completion_journey_up, # S-Tab
}.each_pair do |key, func|
config.add_default_key_binding_by_keymap(:emacs, key, func)
config.add_default_key_binding_by_keymap(:vi_insert, key, func)
end
{
# default bindings
[27, 32] => :em_set_mark, # M-<space>
[24, 24] => :em_exchange_mark, # C-x C-x
}.each_pair do |key, func|
config.add_default_key_binding_by_keymap(:emacs, key, func)
end
end
def set_bracketed_paste_key_bindings(config)
[:emacs, :vi_insert, :vi_command].each do |keymap|
config.add_default_key_binding_by_keymap(keymap, START_BRACKETED_PASTE.bytes, :bracketed_paste_start)
end
end
def set_default_key_bindings_ansi_cursor(config)
ANSI_CURSOR_KEY_BINDINGS.each do |char, (default_func, modifiers)|
bindings = [["\e[#{char}", default_func]] # CSI + char
if modifiers[:ctrl]
# CSI + ctrl_key_modifier + char
bindings << ["\e[1;5#{char}", modifiers[:ctrl]]
end
if modifiers[:meta]
# CSI + meta_key_modifier + char
bindings << ["\e[1;3#{char}", modifiers[:meta]]
# Meta(ESC) + CSI + char
bindings << ["\e\e[#{char}", modifiers[:meta]]
end
bindings.each do |sequence, func|
key = sequence.bytes
config.add_default_key_binding_by_keymap(:emacs, key, func)
config.add_default_key_binding_by_keymap(:vi_insert, key, func)
config.add_default_key_binding_by_keymap(:vi_command, key, func)
end
end
end
def set_default_key_bindings_terminfo(config)
key_bindings = CAPNAME_KEY_BINDINGS.map do |capname, key_binding|
begin
key_code = Reline::Terminfo.tigetstr(capname)
[ key_code.bytes, key_binding ]
rescue Reline::Terminfo::TerminfoError
# capname is undefined
end
end.compact.to_h
key_bindings.each_pair do |key, func|
config.add_default_key_binding_by_keymap(:emacs, key, func)
config.add_default_key_binding_by_keymap(:vi_insert, key, func)
config.add_default_key_binding_by_keymap(:vi_command, key, func)
end
end
def set_default_key_bindings_comprehensive_list(config)
{
# xterm
[27, 91, 51, 126] => :key_delete, # kdch1
[27, 91, 53, 126] => :ed_search_prev_history, # kpp
[27, 91, 54, 126] => :ed_search_next_history, # knp
# Console (80x25)
[27, 91, 49, 126] => :ed_move_to_beg, # Home
[27, 91, 52, 126] => :ed_move_to_end, # End
# KDE
# Del is 0x08
[27, 71, 65] => :ed_prev_history, # ↑
[27, 71, 66] => :ed_next_history, # ↓
[27, 71, 67] => :ed_next_char, # →
[27, 71, 68] => :ed_prev_char, # ←
# urxvt / exoterm
[27, 91, 55, 126] => :ed_move_to_beg, # Home
[27, 91, 56, 126] => :ed_move_to_end, # End
# GNOME
[27, 79, 72] => :ed_move_to_beg, # Home
[27, 79, 70] => :ed_move_to_end, # End
# Del is 0x08
# Arrow keys are the same of KDE
[27, 79, 65] => :ed_prev_history, # ↑
[27, 79, 66] => :ed_next_history, # ↓
[27, 79, 67] => :ed_next_char, # →
[27, 79, 68] => :ed_prev_char, # ←
}.each_pair do |key, func|
config.add_default_key_binding_by_keymap(:emacs, key, func)
config.add_default_key_binding_by_keymap(:vi_insert, key, func)
config.add_default_key_binding_by_keymap(:vi_command, key, func)
end
end
def input=(val)
@input = val
end
def output=(val)
@output = val
end
def with_raw_input
if @input.tty?
@input.raw(intr: true) { yield }
else
yield
end
end
def inner_getc(timeout_second)
unless @buf.empty?
return @buf.shift
end
until @input.wait_readable(0.01)
timeout_second -= 0.01
return nil if timeout_second <= 0
Reline.core.line_editor.handle_signal
end
c = @input.getbyte
(c == 0x16 && @input.tty? && @input.raw(min: 0, time: 0, &:getbyte)) || c
rescue Errno::EIO
# Maybe the I/O has been closed.
nil
end
START_BRACKETED_PASTE = String.new("\e[200~", encoding: Encoding::ASCII_8BIT)
END_BRACKETED_PASTE = String.new("\e[201~", encoding: Encoding::ASCII_8BIT)
def read_bracketed_paste
buffer = String.new(encoding: Encoding::ASCII_8BIT)
until buffer.end_with?(END_BRACKETED_PASTE)
c = inner_getc(Float::INFINITY)
break unless c
buffer << c
end
string = buffer.delete_suffix(END_BRACKETED_PASTE).force_encoding(encoding)
string.valid_encoding? ? string : ''
end
# if the usage expects to wait indefinitely, use Float::INFINITY for timeout_second
def getc(timeout_second)
inner_getc(timeout_second)
end
def in_pasting?
not empty_buffer?
end
def empty_buffer?
unless @buf.empty?
return false
end
!@input.wait_readable(0)
end
def ungetc(c)
@buf.unshift(c)
end
def retrieve_keybuffer
begin
return unless @input.wait_readable(0.001)
str = @input.read_nonblock(1024)
str.bytes.each do |c|
@buf.push(c)
end
rescue EOFError
end
end
def get_screen_size
s = @input.winsize
return s if s[0] > 0 && s[1] > 0
s = [ENV["LINES"].to_i, ENV["COLUMNS"].to_i]
return s if s[0] > 0 && s[1] > 0
[24, 80]
rescue Errno::ENOTTY, Errno::ENODEV
[24, 80]
end
def set_screen_size(rows, columns)
@input.winsize = [rows, columns]
self
rescue Errno::ENOTTY, Errno::ENODEV
self
end
def cursor_pos
if both_tty?
res = +''
m = nil
@input.raw do |stdin|
@output << "\e[6n"
@output.flush
loop do
c = stdin.getc
next if c.nil?
res << c
m = res.match(/\e\[(?<row>\d+);(?<column>\d+)R/)
break if m
end
(m.pre_match + m.post_match).chars.reverse_each do |ch|
stdin.ungetc ch
end
end
column = m[:column].to_i - 1
row = m[:row].to_i - 1
else
begin
buf = @output.pread(@output.pos, 0)
row = buf.count("\n")
column = buf.rindex("\n") ? (buf.size - buf.rindex("\n")) - 1 : 0
rescue Errno::ESPIPE, IOError
# Just returns column 1 for ambiguous width because this I/O is not
# tty and can't seek.
row = 0
column = 1
end
end
Reline::CursorPos.new(column, row)
end
def both_tty?
@input.tty? && @output.tty?
end
def move_cursor_column(x)
@output.write "\e[#{x + 1}G"
end
def move_cursor_up(x)
if x > 0
@output.write "\e[#{x}A"
elsif x < 0
move_cursor_down(-x)
end
end
def move_cursor_down(x)
if x > 0
@output.write "\e[#{x}B"
elsif x < 0
move_cursor_up(-x)
end
end
def hide_cursor
seq = "\e[?25l"
if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
begin
seq = Reline::Terminfo.tigetstr('civis')
rescue Reline::Terminfo::TerminfoError
# civis is undefined
end
end
@output.write seq
end
def show_cursor
seq = "\e[?25h"
if Reline::Terminfo.enabled? && Reline::Terminfo.term_supported?
begin
seq = Reline::Terminfo.tigetstr('cnorm')
rescue Reline::Terminfo::TerminfoError
# cnorm is undefined
end
end
@output.write seq
end
def erase_after_cursor
@output.write "\e[K"
end
# This only works when the cursor is at the bottom of the scroll range
# For more details, see https://github.com/ruby/reline/pull/577#issuecomment-1646679623
def scroll_down(x)
return if x.zero?
# We use `\n` instead of CSI + S because CSI + S would cause https://github.com/ruby/reline/issues/576
@output.write "\n" * x
end
def clear_screen
@output.write "\e[2J"
@output.write "\e[1;1H"
end
def set_winch_handler(&handler)
@old_winch_handler = Signal.trap('WINCH', &handler)
@old_cont_handler = Signal.trap('CONT') do
@input.raw!(intr: true) if @input.tty?
# Rerender the screen. Note that screen size might be changed while suspended.
handler.call
end
rescue ArgumentError
# Signal.trap may raise an ArgumentError if the platform doesn't support the signal.
end
def prep
# Enable bracketed paste
@output.write "\e[?2004h" if Reline.core.config.enable_bracketed_paste && both_tty?
retrieve_keybuffer
nil
end
def deprep(otio)
# Disable bracketed paste
@output.write "\e[?2004l" if Reline.core.config.enable_bracketed_paste && both_tty?
Signal.trap('WINCH', @old_winch_handler) if @old_winch_handler
Signal.trap('CONT', @old_cont_handler) if @old_cont_handler
end
end
share/ruby/reline/io/windows.rb 0000644 00000041504 15173517736 0012556 0 ustar 00 require 'fiddle/import'
class Reline::Windows < Reline::IO
def initialize
@input_buf = []
@output_buf = []
@output = STDOUT
@hsg = nil
@getwch = Win32API.new('msvcrt', '_getwch', [], 'I')
@kbhit = Win32API.new('msvcrt', '_kbhit', [], 'I')
@GetKeyState = Win32API.new('user32', 'GetKeyState', ['L'], 'L')
@GetConsoleScreenBufferInfo = Win32API.new('kernel32', 'GetConsoleScreenBufferInfo', ['L', 'P'], 'L')
@SetConsoleCursorPosition = Win32API.new('kernel32', 'SetConsoleCursorPosition', ['L', 'L'], 'L')
@GetStdHandle = Win32API.new('kernel32', 'GetStdHandle', ['L'], 'L')
@FillConsoleOutputCharacter = Win32API.new('kernel32', 'FillConsoleOutputCharacter', ['L', 'L', 'L', 'L', 'P'], 'L')
@ScrollConsoleScreenBuffer = Win32API.new('kernel32', 'ScrollConsoleScreenBuffer', ['L', 'P', 'P', 'L', 'P'], 'L')
@hConsoleHandle = @GetStdHandle.call(STD_OUTPUT_HANDLE)
@hConsoleInputHandle = @GetStdHandle.call(STD_INPUT_HANDLE)
@GetNumberOfConsoleInputEvents = Win32API.new('kernel32', 'GetNumberOfConsoleInputEvents', ['L', 'P'], 'L')
@ReadConsoleInputW = Win32API.new('kernel32', 'ReadConsoleInputW', ['L', 'P', 'L', 'P'], 'L')
@GetFileType = Win32API.new('kernel32', 'GetFileType', ['L'], 'L')
@GetFileInformationByHandleEx = Win32API.new('kernel32', 'GetFileInformationByHandleEx', ['L', 'I', 'P', 'L'], 'I')
@FillConsoleOutputAttribute = Win32API.new('kernel32', 'FillConsoleOutputAttribute', ['L', 'L', 'L', 'L', 'P'], 'L')
@SetConsoleCursorInfo = Win32API.new('kernel32', 'SetConsoleCursorInfo', ['L', 'P'], 'L')
@GetConsoleMode = Win32API.new('kernel32', 'GetConsoleMode', ['L', 'P'], 'L')
@SetConsoleMode = Win32API.new('kernel32', 'SetConsoleMode', ['L', 'L'], 'L')
@WaitForSingleObject = Win32API.new('kernel32', 'WaitForSingleObject', ['L', 'L'], 'L')
@legacy_console = getconsolemode & ENABLE_VIRTUAL_TERMINAL_PROCESSING == 0
end
def encoding
Encoding::UTF_8
end
def win?
true
end
def win_legacy_console?
@legacy_console
end
def set_default_key_bindings(config)
{
[224, 72] => :ed_prev_history, # ↑
[224, 80] => :ed_next_history, # ↓
[224, 77] => :ed_next_char, # →
[224, 75] => :ed_prev_char, # ←
[224, 83] => :key_delete, # Del
[224, 71] => :ed_move_to_beg, # Home
[224, 79] => :ed_move_to_end, # End
[ 0, 41] => :ed_unassigned, # input method on/off
[ 0, 72] => :ed_prev_history, # ↑
[ 0, 80] => :ed_next_history, # ↓
[ 0, 77] => :ed_next_char, # →
[ 0, 75] => :ed_prev_char, # ←
[ 0, 83] => :key_delete, # Del
[ 0, 71] => :ed_move_to_beg, # Home
[ 0, 79] => :ed_move_to_end # End
}.each_pair do |key, func|
config.add_default_key_binding_by_keymap(:emacs, key, func)
config.add_default_key_binding_by_keymap(:vi_insert, key, func)
config.add_default_key_binding_by_keymap(:vi_command, key, func)
end
{
[27, 32] => :em_set_mark, # M-<space>
[24, 24] => :em_exchange_mark, # C-x C-x
}.each_pair do |key, func|
config.add_default_key_binding_by_keymap(:emacs, key, func)
end
# Emulate ANSI key sequence.
{
[27, 91, 90] => :completion_journey_up, # S-Tab
}.each_pair do |key, func|
config.add_default_key_binding_by_keymap(:emacs, key, func)
config.add_default_key_binding_by_keymap(:vi_insert, key, func)
end
end
if defined? JRUBY_VERSION
require 'win32api'
else
class Win32API
DLL = {}
TYPEMAP = {"0" => Fiddle::TYPE_VOID, "S" => Fiddle::TYPE_VOIDP, "I" => Fiddle::TYPE_LONG}
POINTER_TYPE = Fiddle::SIZEOF_VOIDP == Fiddle::SIZEOF_LONG_LONG ? 'q*' : 'l!*'
WIN32_TYPES = "VPpNnLlIi"
DL_TYPES = "0SSI"
def initialize(dllname, func, import, export = "0", calltype = :stdcall)
@proto = [import].join.tr(WIN32_TYPES, DL_TYPES).sub(/^(.)0*$/, '\1')
import = @proto.chars.map {|win_type| TYPEMAP[win_type.tr(WIN32_TYPES, DL_TYPES)]}
export = TYPEMAP[export.tr(WIN32_TYPES, DL_TYPES)]
calltype = Fiddle::Importer.const_get(:CALL_TYPE_TO_ABI)[calltype]
handle = DLL[dllname] ||=
begin
Fiddle.dlopen(dllname)
rescue Fiddle::DLError
raise unless File.extname(dllname).empty?
Fiddle.dlopen(dllname + ".dll")
end
@func = Fiddle::Function.new(handle[func], import, export, calltype)
rescue Fiddle::DLError => e
raise LoadError, e.message, e.backtrace
end
def call(*args)
import = @proto.split("")
args.each_with_index do |x, i|
args[i], = [x == 0 ? nil : +x].pack("p").unpack(POINTER_TYPE) if import[i] == "S"
args[i], = [x].pack("I").unpack("i") if import[i] == "I"
end
ret, = @func.call(*args)
return ret || 0
end
end
end
VK_RETURN = 0x0D
VK_MENU = 0x12 # ALT key
VK_LMENU = 0xA4
VK_CONTROL = 0x11
VK_SHIFT = 0x10
VK_DIVIDE = 0x6F
KEY_EVENT = 0x01
WINDOW_BUFFER_SIZE_EVENT = 0x04
CAPSLOCK_ON = 0x0080
ENHANCED_KEY = 0x0100
LEFT_ALT_PRESSED = 0x0002
LEFT_CTRL_PRESSED = 0x0008
NUMLOCK_ON = 0x0020
RIGHT_ALT_PRESSED = 0x0001
RIGHT_CTRL_PRESSED = 0x0004
SCROLLLOCK_ON = 0x0040
SHIFT_PRESSED = 0x0010
VK_TAB = 0x09
VK_END = 0x23
VK_HOME = 0x24
VK_LEFT = 0x25
VK_UP = 0x26
VK_RIGHT = 0x27
VK_DOWN = 0x28
VK_DELETE = 0x2E
STD_INPUT_HANDLE = -10
STD_OUTPUT_HANDLE = -11
FILE_TYPE_PIPE = 0x0003
FILE_NAME_INFO = 2
ENABLE_VIRTUAL_TERMINAL_PROCESSING = 4
# Calling Win32API with console handle is reported to fail after executing some external command.
# We need to refresh console handle and retry the call again.
private def call_with_console_handle(win32func, *args)
val = win32func.call(@hConsoleHandle, *args)
return val if val != 0
@hConsoleHandle = @GetStdHandle.call(STD_OUTPUT_HANDLE)
win32func.call(@hConsoleHandle, *args)
end
private def getconsolemode
mode = "\000\000\000\000"
call_with_console_handle(@GetConsoleMode, mode)
mode.unpack1('L')
end
private def setconsolemode(mode)
call_with_console_handle(@SetConsoleMode, mode)
end
#if @legacy_console
# setconsolemode(getconsolemode() | ENABLE_VIRTUAL_TERMINAL_PROCESSING)
# @legacy_console = (getconsolemode() & ENABLE_VIRTUAL_TERMINAL_PROCESSING == 0)
#end
def msys_tty?(io = @hConsoleInputHandle)
# check if fd is a pipe
if @GetFileType.call(io) != FILE_TYPE_PIPE
return false
end
bufsize = 1024
p_buffer = "\0" * bufsize
res = @GetFileInformationByHandleEx.call(io, FILE_NAME_INFO, p_buffer, bufsize - 2)
return false if res == 0
# get pipe name: p_buffer layout is:
# struct _FILE_NAME_INFO {
# DWORD FileNameLength;
# WCHAR FileName[1];
# } FILE_NAME_INFO
len = p_buffer[0, 4].unpack1("L")
name = p_buffer[4, len].encode(Encoding::UTF_8, Encoding::UTF_16LE, invalid: :replace)
# Check if this could be a MSYS2 pty pipe ('\msys-XXXX-ptyN-XX')
# or a cygwin pty pipe ('\cygwin-XXXX-ptyN-XX')
name =~ /(msys-|cygwin-).*-pty/ ? true : false
end
KEY_MAP = [
# It's treated as Meta+Enter on Windows.
[ { control_keys: :CTRL, virtual_key_code: 0x0D }, "\e\r".bytes ],
[ { control_keys: :SHIFT, virtual_key_code: 0x0D }, "\e\r".bytes ],
# It's treated as Meta+Space on Windows.
[ { control_keys: :CTRL, char_code: 0x20 }, "\e ".bytes ],
# Emulate getwch() key sequences.
[ { control_keys: [], virtual_key_code: VK_UP }, [0, 72] ],
[ { control_keys: [], virtual_key_code: VK_DOWN }, [0, 80] ],
[ { control_keys: [], virtual_key_code: VK_RIGHT }, [0, 77] ],
[ { control_keys: [], virtual_key_code: VK_LEFT }, [0, 75] ],
[ { control_keys: [], virtual_key_code: VK_DELETE }, [0, 83] ],
[ { control_keys: [], virtual_key_code: VK_HOME }, [0, 71] ],
[ { control_keys: [], virtual_key_code: VK_END }, [0, 79] ],
# Emulate ANSI key sequence.
[ { control_keys: :SHIFT, virtual_key_code: VK_TAB }, [27, 91, 90] ],
]
def process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)
# high-surrogate
if 0xD800 <= char_code and char_code <= 0xDBFF
@hsg = char_code
return
end
# low-surrogate
if 0xDC00 <= char_code and char_code <= 0xDFFF
if @hsg
char_code = 0x10000 + (@hsg - 0xD800) * 0x400 + char_code - 0xDC00
@hsg = nil
else
# no high-surrogate. ignored.
return
end
else
# ignore high-surrogate without low-surrogate if there
@hsg = nil
end
key = KeyEventRecord.new(virtual_key_code, char_code, control_key_state)
match = KEY_MAP.find { |args,| key.matches?(**args) }
unless match.nil?
@output_buf.concat(match.last)
return
end
# no char, only control keys
return if key.char_code == 0 and key.control_keys.any?
@output_buf.push("\e".ord) if key.control_keys.include?(:ALT) and !key.control_keys.include?(:CTRL)
@output_buf.concat(key.char.bytes)
end
def check_input_event
num_of_events = 0.chr * 8
while @output_buf.empty?
Reline.core.line_editor.handle_signal
if @WaitForSingleObject.(@hConsoleInputHandle, 100) != 0 # max 0.1 sec
# prevent for background consolemode change
@legacy_console = getconsolemode & ENABLE_VIRTUAL_TERMINAL_PROCESSING == 0
next
end
next if @GetNumberOfConsoleInputEvents.(@hConsoleInputHandle, num_of_events) == 0 or num_of_events.unpack1('L') == 0
input_records = 0.chr * 20 * 80
read_event = 0.chr * 4
if @ReadConsoleInputW.(@hConsoleInputHandle, input_records, 80, read_event) != 0
read_events = read_event.unpack1('L')
0.upto(read_events) do |idx|
input_record = input_records[idx * 20, 20]
event = input_record[0, 2].unpack1('s*')
case event
when WINDOW_BUFFER_SIZE_EVENT
@winch_handler.()
when KEY_EVENT
key_down = input_record[4, 4].unpack1('l*')
repeat_count = input_record[8, 2].unpack1('s*')
virtual_key_code = input_record[10, 2].unpack1('s*')
virtual_scan_code = input_record[12, 2].unpack1('s*')
char_code = input_record[14, 2].unpack1('S*')
control_key_state = input_record[16, 2].unpack1('S*')
is_key_down = key_down.zero? ? false : true
if is_key_down
process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)
end
end
end
end
end
end
def with_raw_input
yield
end
def getc(_timeout_second)
check_input_event
@output_buf.shift
end
def ungetc(c)
@output_buf.unshift(c)
end
def in_pasting?
not empty_buffer?
end
def empty_buffer?
if not @output_buf.empty?
false
elsif @kbhit.call == 0
true
else
false
end
end
def get_console_screen_buffer_info
# CONSOLE_SCREEN_BUFFER_INFO
# [ 0,2] dwSize.X
# [ 2,2] dwSize.Y
# [ 4,2] dwCursorPositions.X
# [ 6,2] dwCursorPositions.Y
# [ 8,2] wAttributes
# [10,2] srWindow.Left
# [12,2] srWindow.Top
# [14,2] srWindow.Right
# [16,2] srWindow.Bottom
# [18,2] dwMaximumWindowSize.X
# [20,2] dwMaximumWindowSize.Y
csbi = 0.chr * 22
return if call_with_console_handle(@GetConsoleScreenBufferInfo, csbi) == 0
csbi
end
def get_screen_size
unless csbi = get_console_screen_buffer_info
return [1, 1]
end
csbi[0, 4].unpack('SS').reverse
end
def cursor_pos
unless csbi = get_console_screen_buffer_info
return Reline::CursorPos.new(0, 0)
end
x = csbi[4, 2].unpack1('s')
y = csbi[6, 2].unpack1('s')
Reline::CursorPos.new(x, y)
end
def move_cursor_column(val)
call_with_console_handle(@SetConsoleCursorPosition, cursor_pos.y * 65536 + val)
end
def move_cursor_up(val)
if val > 0
y = cursor_pos.y - val
y = 0 if y < 0
call_with_console_handle(@SetConsoleCursorPosition, y * 65536 + cursor_pos.x)
elsif val < 0
move_cursor_down(-val)
end
end
def move_cursor_down(val)
if val > 0
return unless csbi = get_console_screen_buffer_info
screen_height = get_screen_size.first
y = cursor_pos.y + val
y = screen_height - 1 if y > (screen_height - 1)
call_with_console_handle(@SetConsoleCursorPosition, (cursor_pos.y + val) * 65536 + cursor_pos.x)
elsif val < 0
move_cursor_up(-val)
end
end
def erase_after_cursor
return unless csbi = get_console_screen_buffer_info
attributes = csbi[8, 2].unpack1('S')
cursor = csbi[4, 4].unpack1('L')
written = 0.chr * 4
call_with_console_handle(@FillConsoleOutputCharacter, 0x20, get_screen_size.last - cursor_pos.x, cursor, written)
call_with_console_handle(@FillConsoleOutputAttribute, attributes, get_screen_size.last - cursor_pos.x, cursor, written)
end
def scroll_down(val)
return if val < 0
return unless csbi = get_console_screen_buffer_info
buffer_width, buffer_lines, x, y, attributes, window_left, window_top, window_bottom = csbi.unpack('ssssSssx2s')
screen_height = window_bottom - window_top + 1
val = screen_height if val > screen_height
if @legacy_console || window_left != 0
# unless ENABLE_VIRTUAL_TERMINAL,
# if srWindow.Left != 0 then it's conhost.exe hosted console
# and puts "\n" causes horizontal scroll. its glitch.
# FYI irb write from culumn 1, so this gives no gain.
scroll_rectangle = [0, val, buffer_width, buffer_lines - val].pack('s4')
destination_origin = 0 # y * 65536 + x
fill = [' '.ord, attributes].pack('SS')
call_with_console_handle(@ScrollConsoleScreenBuffer, scroll_rectangle, nil, destination_origin, fill)
else
origin_x = x + 1
origin_y = y - window_top + 1
@output.write [
(origin_y != screen_height) ? "\e[#{screen_height};H" : nil,
"\n" * val,
(origin_y != screen_height or !x.zero?) ? "\e[#{origin_y};#{origin_x}H" : nil
].join
end
end
def clear_screen
if @legacy_console
return unless csbi = get_console_screen_buffer_info
buffer_width, _buffer_lines, attributes, window_top, window_bottom = csbi.unpack('ss@8S@12sx2s')
fill_length = buffer_width * (window_bottom - window_top + 1)
screen_topleft = window_top * 65536
written = 0.chr * 4
call_with_console_handle(@FillConsoleOutputCharacter, 0x20, fill_length, screen_topleft, written)
call_with_console_handle(@FillConsoleOutputAttribute, attributes, fill_length, screen_topleft, written)
call_with_console_handle(@SetConsoleCursorPosition, screen_topleft)
else
@output.write "\e[2J" "\e[H"
end
end
def set_screen_size(rows, columns)
raise NotImplementedError
end
def hide_cursor
size = 100
visible = 0 # 0 means false
cursor_info = [size, visible].pack('Li')
call_with_console_handle(@SetConsoleCursorInfo, cursor_info)
end
def show_cursor
size = 100
visible = 1 # 1 means true
cursor_info = [size, visible].pack('Li')
call_with_console_handle(@SetConsoleCursorInfo, cursor_info)
end
def set_winch_handler(&handler)
@winch_handler = handler
end
def prep
# do nothing
nil
end
def deprep(otio)
# do nothing
end
class KeyEventRecord
attr_reader :virtual_key_code, :char_code, :control_key_state, :control_keys
def initialize(virtual_key_code, char_code, control_key_state)
@virtual_key_code = virtual_key_code
@char_code = char_code
@control_key_state = control_key_state
@enhanced = control_key_state & ENHANCED_KEY != 0
(@control_keys = []).tap do |control_keys|
# symbols must be sorted to make comparison is easier later on
control_keys << :ALT if control_key_state & (LEFT_ALT_PRESSED | RIGHT_ALT_PRESSED) != 0
control_keys << :CTRL if control_key_state & (LEFT_CTRL_PRESSED | RIGHT_CTRL_PRESSED) != 0
control_keys << :SHIFT if control_key_state & SHIFT_PRESSED != 0
end.freeze
end
def char
@char_code.chr(Encoding::UTF_8)
end
def enhanced?
@enhanced
end
# Verifies if the arguments match with this key event.
# Nil arguments are ignored, but at least one must be passed as non-nil.
# To verify that no control keys were pressed, pass an empty array: `control_keys: []`.
def matches?(control_keys: nil, virtual_key_code: nil, char_code: nil)
raise ArgumentError, 'No argument was passed to match key event' if control_keys.nil? && virtual_key_code.nil? && char_code.nil?
(control_keys.nil? || [*control_keys].sort == @control_keys) &&
(virtual_key_code.nil? || @virtual_key_code == virtual_key_code) &&
(char_code.nil? || char_code == @char_code)
end
end
end
share/ruby/timeout.rb 0000644 00000013301 15173517736 0010657 0 ustar 00 # frozen_string_literal: true
# Timeout long-running blocks
#
# == Synopsis
#
# require 'timeout'
# status = Timeout::timeout(5) {
# # Something that should be interrupted if it takes more than 5 seconds...
# }
#
# == Description
#
# Timeout provides a way to auto-terminate a potentially long-running
# operation if it hasn't finished in a fixed amount of time.
#
# Previous versions didn't use a module for namespacing, however
# #timeout is provided for backwards compatibility. You
# should prefer Timeout.timeout instead.
#
# == Copyright
#
# Copyright:: (C) 2000 Network Applied Communication Laboratory, Inc.
# Copyright:: (C) 2000 Information-technology Promotion Agency, Japan
module Timeout
VERSION = "0.4.1"
# Internal error raised to when a timeout is triggered.
class ExitException < Exception
def exception(*)
self
end
end
# Raised by Timeout.timeout when the block times out.
class Error < RuntimeError
def self.handle_timeout(message)
exc = ExitException.new(message)
begin
yield exc
rescue ExitException => e
raise new(message) if exc.equal?(e)
raise
end
end
end
# :stopdoc:
CONDVAR = ConditionVariable.new
QUEUE = Queue.new
QUEUE_MUTEX = Mutex.new
TIMEOUT_THREAD_MUTEX = Mutex.new
@timeout_thread = nil
private_constant :CONDVAR, :QUEUE, :QUEUE_MUTEX, :TIMEOUT_THREAD_MUTEX
class Request
attr_reader :deadline
def initialize(thread, timeout, exception_class, message)
@thread = thread
@deadline = GET_TIME.call(Process::CLOCK_MONOTONIC) + timeout
@exception_class = exception_class
@message = message
@mutex = Mutex.new
@done = false # protected by @mutex
end
def done?
@mutex.synchronize do
@done
end
end
def expired?(now)
now >= @deadline
end
def interrupt
@mutex.synchronize do
unless @done
@thread.raise @exception_class, @message
@done = true
end
end
end
def finished
@mutex.synchronize do
@done = true
end
end
end
private_constant :Request
def self.create_timeout_thread
watcher = Thread.new do
requests = []
while true
until QUEUE.empty? and !requests.empty? # wait to have at least one request
req = QUEUE.pop
requests << req unless req.done?
end
closest_deadline = requests.min_by(&:deadline).deadline
now = 0.0
QUEUE_MUTEX.synchronize do
while (now = GET_TIME.call(Process::CLOCK_MONOTONIC)) < closest_deadline and QUEUE.empty?
CONDVAR.wait(QUEUE_MUTEX, closest_deadline - now)
end
end
requests.each do |req|
req.interrupt if req.expired?(now)
end
requests.reject!(&:done?)
end
end
ThreadGroup::Default.add(watcher) unless watcher.group.enclosed?
watcher.name = "Timeout stdlib thread"
watcher.thread_variable_set(:"\0__detached_thread__", true)
watcher
end
private_class_method :create_timeout_thread
def self.ensure_timeout_thread_created
unless @timeout_thread and @timeout_thread.alive?
TIMEOUT_THREAD_MUTEX.synchronize do
unless @timeout_thread and @timeout_thread.alive?
@timeout_thread = create_timeout_thread
end
end
end
end
# We keep a private reference so that time mocking libraries won't break
# Timeout.
GET_TIME = Process.method(:clock_gettime)
private_constant :GET_TIME
# :startdoc:
# Perform an operation in a block, raising an error if it takes longer than
# +sec+ seconds to complete.
#
# +sec+:: Number of seconds to wait for the block to terminate. Any number
# may be used, including Floats to specify fractional seconds. A
# value of 0 or +nil+ will execute the block without any timeout.
# +klass+:: Exception Class to raise if the block fails to terminate
# in +sec+ seconds. Omitting will use the default, Timeout::Error
# +message+:: Error message to raise with Exception Class.
# Omitting will use the default, "execution expired"
#
# Returns the result of the block *if* the block completed before
# +sec+ seconds, otherwise throws an exception, based on the value of +klass+.
#
# The exception thrown to terminate the given block cannot be rescued inside
# the block unless +klass+ is given explicitly. However, the block can use
# ensure to prevent the handling of the exception. For that reason, this
# method cannot be relied on to enforce timeouts for untrusted blocks.
#
# If a scheduler is defined, it will be used to handle the timeout by invoking
# Scheduler#timeout_after.
#
# Note that this is both a method of module Timeout, so you can <tt>include
# Timeout</tt> into your classes so they have a #timeout method, as well as
# a module method, so you can call it directly as Timeout.timeout().
def timeout(sec, klass = nil, message = nil, &block) #:yield: +sec+
return yield(sec) if sec == nil or sec.zero?
message ||= "execution expired"
if Fiber.respond_to?(:current_scheduler) && (scheduler = Fiber.current_scheduler)&.respond_to?(:timeout_after)
return scheduler.timeout_after(sec, klass || Error, message, &block)
end
Timeout.ensure_timeout_thread_created
perform = Proc.new do |exc|
request = Request.new(Thread.current, sec, exc, message)
QUEUE_MUTEX.synchronize do
QUEUE << request
CONDVAR.signal
end
begin
return yield(sec)
ensure
request.finished
end
end
if klass
perform.call(klass)
else
Error.handle_timeout(message, &perform)
end
end
module_function :timeout
end
share/ruby/csv/table.rb 0000644 00000112420 15173517736 0011055 0 ustar 00 # frozen_string_literal: true
require "forwardable"
class CSV
# = \CSV::Table
# A \CSV::Table instance represents \CSV data.
# (see {class CSV}[../CSV.html]).
#
# The instance may have:
# - Rows: each is a Table::Row object.
# - Headers: names for the columns.
#
# === Instance Methods
#
# \CSV::Table has three groups of instance methods:
# - Its own internally defined instance methods.
# - Methods included by module Enumerable.
# - Methods delegated to class Array.:
# * Array#empty?
# * Array#length
# * Array#size
#
# == Creating a \CSV::Table Instance
#
# Commonly, a new \CSV::Table instance is created by parsing \CSV source
# using headers:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.class # => CSV::Table
#
# You can also create an instance directly. See ::new.
#
# == Headers
#
# If a table has headers, the headers serve as labels for the columns of data.
# Each header serves as the label for its column.
#
# The headers for a \CSV::Table object are stored as an \Array of Strings.
#
# Commonly, headers are defined in the first row of \CSV source:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.headers # => ["Name", "Value"]
#
# If no headers are defined, the \Array is empty:
# table = CSV::Table.new([])
# table.headers # => []
#
# == Access Modes
#
# \CSV::Table provides three modes for accessing table data:
# - \Row mode.
# - Column mode.
# - Mixed mode (the default for a new table).
#
# The access mode for a\CSV::Table instance affects the behavior
# of some of its instance methods:
# - #[]
# - #[]=
# - #delete
# - #delete_if
# - #each
# - #values_at
#
# === \Row Mode
#
# Set a table to row mode with method #by_row!:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_row! # => #<CSV::Table mode:row row_count:4>
#
# Specify a single row by an \Integer index:
# # Get a row.
# table[1] # => #<CSV::Row "Name":"bar" "Value":"1">
# # Set a row, then get it.
# table[1] = CSV::Row.new(['Name', 'Value'], ['bam', 3])
# table[1] # => #<CSV::Row "Name":"bam" "Value":3>
#
# Specify a sequence of rows by a \Range:
# # Get rows.
# table[1..2] # => [#<CSV::Row "Name":"bam" "Value":3>, #<CSV::Row "Name":"baz" "Value":"2">]
# # Set rows, then get them.
# table[1..2] = [
# CSV::Row.new(['Name', 'Value'], ['bat', 4]),
# CSV::Row.new(['Name', 'Value'], ['bad', 5]),
# ]
# table[1..2] # => [["Name", #<CSV::Row "Name":"bat" "Value":4>], ["Value", #<CSV::Row "Name":"bad" "Value":5>]]
#
# === Column Mode
#
# Set a table to column mode with method #by_col!:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_col! # => #<CSV::Table mode:col row_count:4>
#
# Specify a column by an \Integer index:
# # Get a column.
# table[0]
# # Set a column, then get it.
# table[0] = ['FOO', 'BAR', 'BAZ']
# table[0] # => ["FOO", "BAR", "BAZ"]
#
# Specify a column by its \String header:
# # Get a column.
# table['Name'] # => ["FOO", "BAR", "BAZ"]
# # Set a column, then get it.
# table['Name'] = ['Foo', 'Bar', 'Baz']
# table['Name'] # => ["Foo", "Bar", "Baz"]
#
# === Mixed Mode
#
# In mixed mode, you can refer to either rows or columns:
# - An \Integer index refers to a row.
# - A \Range index refers to multiple rows.
# - A \String index refers to a column.
#
# Set a table to mixed mode with method #by_col_or_row!:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_col_or_row! # => #<CSV::Table mode:col_or_row row_count:4>
#
# Specify a single row by an \Integer index:
# # Get a row.
# table[1] # => #<CSV::Row "Name":"bar" "Value":"1">
# # Set a row, then get it.
# table[1] = CSV::Row.new(['Name', 'Value'], ['bam', 3])
# table[1] # => #<CSV::Row "Name":"bam" "Value":3>
#
# Specify a sequence of rows by a \Range:
# # Get rows.
# table[1..2] # => [#<CSV::Row "Name":"bam" "Value":3>, #<CSV::Row "Name":"baz" "Value":"2">]
# # Set rows, then get them.
# table[1] = CSV::Row.new(['Name', 'Value'], ['bat', 4])
# table[2] = CSV::Row.new(['Name', 'Value'], ['bad', 5])
# table[1..2] # => [["Name", #<CSV::Row "Name":"bat" "Value":4>], ["Value", #<CSV::Row "Name":"bad" "Value":5>]]
#
# Specify a column by its \String header:
# # Get a column.
# table['Name'] # => ["foo", "bat", "bad"]
# # Set a column, then get it.
# table['Name'] = ['Foo', 'Bar', 'Baz']
# table['Name'] # => ["Foo", "Bar", "Baz"]
class Table
# :call-seq:
# CSV::Table.new(array_of_rows, headers = nil) -> csv_table
#
# Returns a new \CSV::Table object.
#
# - Argument +array_of_rows+ must be an \Array of CSV::Row objects.
# - Argument +headers+, if given, may be an \Array of Strings.
#
# ---
#
# Create an empty \CSV::Table object:
# table = CSV::Table.new([])
# table # => #<CSV::Table mode:col_or_row row_count:1>
#
# Create a non-empty \CSV::Table object:
# rows = [
# CSV::Row.new([], []),
# CSV::Row.new([], []),
# CSV::Row.new([], []),
# ]
# table = CSV::Table.new(rows)
# table # => #<CSV::Table mode:col_or_row row_count:4>
#
# ---
#
# If argument +headers+ is an \Array of Strings,
# those Strings become the table's headers:
# table = CSV::Table.new([], headers: ['Name', 'Age'])
# table.headers # => ["Name", "Age"]
#
# If argument +headers+ is not given and the table has rows,
# the headers are taken from the first row:
# rows = [
# CSV::Row.new(['Foo', 'Bar'], []),
# CSV::Row.new(['foo', 'bar'], []),
# CSV::Row.new(['FOO', 'BAR'], []),
# ]
# table = CSV::Table.new(rows)
# table.headers # => ["Foo", "Bar"]
#
# If argument +headers+ is not given and the table is empty (has no rows),
# the headers are also empty:
# table = CSV::Table.new([])
# table.headers # => []
#
# ---
#
# Raises an exception if argument +array_of_rows+ is not an \Array object:
# # Raises NoMethodError (undefined method `first' for :foo:Symbol):
# CSV::Table.new(:foo)
#
# Raises an exception if an element of +array_of_rows+ is not a \CSV::Table object:
# # Raises NoMethodError (undefined method `headers' for :foo:Symbol):
# CSV::Table.new([:foo])
def initialize(array_of_rows, headers: nil)
@table = array_of_rows
@headers = headers
unless @headers
if @table.empty?
@headers = []
else
@headers = @table.first.headers
end
end
@mode = :col_or_row
end
# The current access mode for indexing and iteration.
attr_reader :mode
# Internal data format used to compare equality.
attr_reader :table
protected :table
### Array Delegation ###
extend Forwardable
def_delegators :@table, :empty?, :length, :size
# :call-seq:
# table.by_col -> table_dup
#
# Returns a duplicate of +self+, in column mode
# (see {Column Mode}[#class-CSV::Table-label-Column+Mode]):
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.mode # => :col_or_row
# dup_table = table.by_col
# dup_table.mode # => :col
# dup_table.equal?(table) # => false # It's a dup
#
# This may be used to chain method calls without changing the mode
# (but also will affect performance and memory usage):
# dup_table.by_col['Name']
#
# Also note that changes to the duplicate table will not affect the original.
def by_col
self.class.new(@table.dup).by_col!
end
# :call-seq:
# table.by_col! -> self
#
# Sets the mode for +self+ to column mode
# (see {Column Mode}[#class-CSV::Table-label-Column+Mode]); returns +self+:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.mode # => :col_or_row
# table1 = table.by_col!
# table.mode # => :col
# table1.equal?(table) # => true # Returned self
def by_col!
@mode = :col
self
end
# :call-seq:
# table.by_col_or_row -> table_dup
#
# Returns a duplicate of +self+, in mixed mode
# (see {Mixed Mode}[#class-CSV::Table-label-Mixed+Mode]):
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true).by_col!
# table.mode # => :col
# dup_table = table.by_col_or_row
# dup_table.mode # => :col_or_row
# dup_table.equal?(table) # => false # It's a dup
#
# This may be used to chain method calls without changing the mode
# (but also will affect performance and memory usage):
# dup_table.by_col_or_row['Name']
#
# Also note that changes to the duplicate table will not affect the original.
def by_col_or_row
self.class.new(@table.dup).by_col_or_row!
end
# :call-seq:
# table.by_col_or_row! -> self
#
# Sets the mode for +self+ to mixed mode
# (see {Mixed Mode}[#class-CSV::Table-label-Mixed+Mode]); returns +self+:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true).by_col!
# table.mode # => :col
# table1 = table.by_col_or_row!
# table.mode # => :col_or_row
# table1.equal?(table) # => true # Returned self
def by_col_or_row!
@mode = :col_or_row
self
end
# :call-seq:
# table.by_row -> table_dup
#
# Returns a duplicate of +self+, in row mode
# (see {Row Mode}[#class-CSV::Table-label-Row+Mode]):
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.mode # => :col_or_row
# dup_table = table.by_row
# dup_table.mode # => :row
# dup_table.equal?(table) # => false # It's a dup
#
# This may be used to chain method calls without changing the mode
# (but also will affect performance and memory usage):
# dup_table.by_row[1]
#
# Also note that changes to the duplicate table will not affect the original.
def by_row
self.class.new(@table.dup).by_row!
end
# :call-seq:
# table.by_row! -> self
#
# Sets the mode for +self+ to row mode
# (see {Row Mode}[#class-CSV::Table-label-Row+Mode]); returns +self+:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.mode # => :col_or_row
# table1 = table.by_row!
# table.mode # => :row
# table1.equal?(table) # => true # Returned self
def by_row!
@mode = :row
self
end
# :call-seq:
# table.headers -> array_of_headers
#
# Returns a new \Array containing the \String headers for the table.
#
# If the table is not empty, returns the headers from the first row:
# rows = [
# CSV::Row.new(['Foo', 'Bar'], []),
# CSV::Row.new(['FOO', 'BAR'], []),
# CSV::Row.new(['foo', 'bar'], []),
# ]
# table = CSV::Table.new(rows)
# table.headers # => ["Foo", "Bar"]
# table.delete(0)
# table.headers # => ["FOO", "BAR"]
# table.delete(0)
# table.headers # => ["foo", "bar"]
#
# If the table is empty, returns a copy of the headers in the table itself:
# table.delete(0)
# table.headers # => ["Foo", "Bar"]
def headers
if @table.empty?
@headers.dup
else
@table.first.headers
end
end
# :call-seq:
# table[n] -> row or column_data
# table[range] -> array_of_rows or array_of_column_data
# table[header] -> array_of_column_data
#
# Returns data from the table; does not modify the table.
#
# ---
#
# Fetch a \Row by Its \Integer Index::
# - Form: <tt>table[n]</tt>, +n+ an integer.
# - Access mode: <tt>:row</tt> or <tt>:col_or_row</tt>.
# - Return value: _nth_ row of the table, if that row exists;
# otherwise +nil+.
#
# Returns the _nth_ row of the table if that row exists:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# table[1] # => #<CSV::Row "Name":"bar" "Value":"1">
# table.by_col_or_row! # => #<CSV::Table mode:col_or_row row_count:4>
# table[1] # => #<CSV::Row "Name":"bar" "Value":"1">
#
# Counts backward from the last row if +n+ is negative:
# table[-1] # => #<CSV::Row "Name":"baz" "Value":"2">
#
# Returns +nil+ if +n+ is too large or too small:
# table[4] # => nil
# table[-4] # => nil
#
# Raises an exception if the access mode is <tt>:row</tt>
# and +n+ is not an \Integer:
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# # Raises TypeError (no implicit conversion of String into Integer):
# table['Name']
#
# ---
#
# Fetch a Column by Its \Integer Index::
# - Form: <tt>table[n]</tt>, +n+ an \Integer.
# - Access mode: <tt>:col</tt>.
# - Return value: _nth_ column of the table, if that column exists;
# otherwise an \Array of +nil+ fields of length <tt>self.size</tt>.
#
# Returns the _nth_ column of the table if that column exists:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_col! # => #<CSV::Table mode:col row_count:4>
# table[1] # => ["0", "1", "2"]
#
# Counts backward from the last column if +n+ is negative:
# table[-2] # => ["foo", "bar", "baz"]
#
# Returns an \Array of +nil+ fields if +n+ is too large or too small:
# table[4] # => [nil, nil, nil]
# table[-4] # => [nil, nil, nil]
#
# ---
#
# Fetch Rows by \Range::
# - Form: <tt>table[range]</tt>, +range+ a \Range object.
# - Access mode: <tt>:row</tt> or <tt>:col_or_row</tt>.
# - Return value: rows from the table, beginning at row <tt>range.start</tt>,
# if those rows exists.
#
# Returns rows from the table, beginning at row <tt>range.first</tt>,
# if those rows exist:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# rows = table[1..2] # => #<CSV::Row "Name":"bar" "Value":"1">
# rows # => [#<CSV::Row "Name":"bar" "Value":"1">, #<CSV::Row "Name":"baz" "Value":"2">]
# table.by_col_or_row! # => #<CSV::Table mode:col_or_row row_count:4>
# rows = table[1..2] # => #<CSV::Row "Name":"bar" "Value":"1">
# rows # => [#<CSV::Row "Name":"bar" "Value":"1">, #<CSV::Row "Name":"baz" "Value":"2">]
#
# If there are too few rows, returns all from <tt>range.start</tt> to the end:
# rows = table[1..50] # => #<CSV::Row "Name":"bar" "Value":"1">
# rows # => [#<CSV::Row "Name":"bar" "Value":"1">, #<CSV::Row "Name":"baz" "Value":"2">]
#
# Special case: if <tt>range.start == table.size</tt>, returns an empty \Array:
# table[table.size..50] # => []
#
# If <tt>range.end</tt> is negative, calculates the ending index from the end:
# rows = table[0..-1]
# rows # => [#<CSV::Row "Name":"foo" "Value":"0">, #<CSV::Row "Name":"bar" "Value":"1">, #<CSV::Row "Name":"baz" "Value":"2">]
#
# If <tt>range.start</tt> is negative, calculates the starting index from the end:
# rows = table[-1..2]
# rows # => [#<CSV::Row "Name":"baz" "Value":"2">]
#
# If <tt>range.start</tt> is larger than <tt>table.size</tt>, returns +nil+:
# table[4..4] # => nil
#
# ---
#
# Fetch Columns by \Range::
# - Form: <tt>table[range]</tt>, +range+ a \Range object.
# - Access mode: <tt>:col</tt>.
# - Return value: column data from the table, beginning at column <tt>range.start</tt>,
# if those columns exist.
#
# Returns column values from the table, if the column exists;
# the values are arranged by row:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_col!
# table[0..1] # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# Special case: if <tt>range.start == headers.size</tt>,
# returns an \Array (size: <tt>table.size</tt>) of empty \Arrays:
# table[table.headers.size..50] # => [[], [], []]
#
# If <tt>range.end</tt> is negative, calculates the ending index from the end:
# table[0..-1] # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# If <tt>range.start</tt> is negative, calculates the starting index from the end:
# table[-2..2] # => [["foo", "0"], ["bar", "1"], ["baz", "2"]]
#
# If <tt>range.start</tt> is larger than <tt>table.size</tt>,
# returns an \Array of +nil+ values:
# table[4..4] # => [nil, nil, nil]
#
# ---
#
# Fetch a Column by Its \String Header::
# - Form: <tt>table[header]</tt>, +header+ a \String header.
# - Access mode: <tt>:col</tt> or <tt>:col_or_row</tt>
# - Return value: column data from the table, if that +header+ exists.
#
# Returns column values from the table, if the column exists:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_col! # => #<CSV::Table mode:col row_count:4>
# table['Name'] # => ["foo", "bar", "baz"]
# table.by_col_or_row! # => #<CSV::Table mode:col_or_row row_count:4>
# col = table['Name']
# col # => ["foo", "bar", "baz"]
#
# Modifying the returned column values does not modify the table:
# col[0] = 'bat'
# col # => ["bat", "bar", "baz"]
# table['Name'] # => ["foo", "bar", "baz"]
#
# Returns an \Array of +nil+ values if there is no such column:
# table['Nosuch'] # => [nil, nil, nil]
def [](index_or_header)
if @mode == :row or # by index
(@mode == :col_or_row and (index_or_header.is_a?(Integer) or index_or_header.is_a?(Range)))
@table[index_or_header]
else # by header
@table.map { |row| row[index_or_header] }
end
end
# :call-seq:
# table[n] = row -> row
# table[n] = field_or_array_of_fields -> field_or_array_of_fields
# table[header] = field_or_array_of_fields -> field_or_array_of_fields
#
# Puts data onto the table.
#
# ---
#
# Set a \Row by Its \Integer Index::
# - Form: <tt>table[n] = row</tt>, +n+ an \Integer,
# +row+ a \CSV::Row instance or an \Array of fields.
# - Access mode: <tt>:row</tt> or <tt>:col_or_row</tt>.
# - Return value: +row+.
#
# If the row exists, it is replaced:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# new_row = CSV::Row.new(['Name', 'Value'], ['bat', 3])
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# return_value = table[0] = new_row
# return_value.equal?(new_row) # => true # Returned the row
# table[0].to_h # => {"Name"=>"bat", "Value"=>3}
#
# With access mode <tt>:col_or_row</tt>:
# table.by_col_or_row! # => #<CSV::Table mode:col_or_row row_count:4>
# table[0] = CSV::Row.new(['Name', 'Value'], ['bam', 4])
# table[0].to_h # => {"Name"=>"bam", "Value"=>4}
#
# With an \Array instead of a \CSV::Row, inherits headers from the table:
# array = ['bad', 5]
# return_value = table[0] = array
# return_value.equal?(array) # => true # Returned the array
# table[0].to_h # => {"Name"=>"bad", "Value"=>5}
#
# If the row does not exist, extends the table by adding rows:
# assigns rows with +nil+ as needed:
# table.size # => 3
# table[5] = ['bag', 6]
# table.size # => 6
# table[3] # => nil
# table[4]# => nil
# table[5].to_h # => {"Name"=>"bag", "Value"=>6}
#
# Note that the +nil+ rows are actually +nil+, not a row of +nil+ fields.
#
# ---
#
# Set a Column by Its \Integer Index::
# - Form: <tt>table[n] = array_of_fields</tt>, +n+ an \Integer,
# +array_of_fields+ an \Array of \String fields.
# - Access mode: <tt>:col</tt>.
# - Return value: +array_of_fields+.
#
# If the column exists, it is replaced:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# new_col = [3, 4, 5]
# table.by_col! # => #<CSV::Table mode:col row_count:4>
# return_value = table[1] = new_col
# return_value.equal?(new_col) # => true # Returned the column
# table[1] # => [3, 4, 5]
# # The rows, as revised:
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# table[0].to_h # => {"Name"=>"foo", "Value"=>3}
# table[1].to_h # => {"Name"=>"bar", "Value"=>4}
# table[2].to_h # => {"Name"=>"baz", "Value"=>5}
# table.by_col! # => #<CSV::Table mode:col row_count:4>
#
# If there are too few values, fills with +nil+ values:
# table[1] = [0]
# table[1] # => [0, nil, nil]
#
# If there are too many values, ignores the extra values:
# table[1] = [0, 1, 2, 3, 4]
# table[1] # => [0, 1, 2]
#
# If a single value is given, replaces all fields in the column with that value:
# table[1] = 'bat'
# table[1] # => ["bat", "bat", "bat"]
#
# ---
#
# Set a Column by Its \String Header::
# - Form: <tt>table[header] = field_or_array_of_fields</tt>,
# +header+ a \String header, +field_or_array_of_fields+ a field value
# or an \Array of \String fields.
# - Access mode: <tt>:col</tt> or <tt>:col_or_row</tt>.
# - Return value: +field_or_array_of_fields+.
#
# If the column exists, it is replaced:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# new_col = [3, 4, 5]
# table.by_col! # => #<CSV::Table mode:col row_count:4>
# return_value = table['Value'] = new_col
# return_value.equal?(new_col) # => true # Returned the column
# table['Value'] # => [3, 4, 5]
# # The rows, as revised:
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# table[0].to_h # => {"Name"=>"foo", "Value"=>3}
# table[1].to_h # => {"Name"=>"bar", "Value"=>4}
# table[2].to_h # => {"Name"=>"baz", "Value"=>5}
# table.by_col! # => #<CSV::Table mode:col row_count:4>
#
# If there are too few values, fills with +nil+ values:
# table['Value'] = [0]
# table['Value'] # => [0, nil, nil]
#
# If there are too many values, ignores the extra values:
# table['Value'] = [0, 1, 2, 3, 4]
# table['Value'] # => [0, 1, 2]
#
# If the column does not exist, extends the table by adding columns:
# table['Note'] = ['x', 'y', 'z']
# table['Note'] # => ["x", "y", "z"]
# # The rows, as revised:
# table.by_row!
# table[0].to_h # => {"Name"=>"foo", "Value"=>0, "Note"=>"x"}
# table[1].to_h # => {"Name"=>"bar", "Value"=>1, "Note"=>"y"}
# table[2].to_h # => {"Name"=>"baz", "Value"=>2, "Note"=>"z"}
# table.by_col!
#
# If a single value is given, replaces all fields in the column with that value:
# table['Value'] = 'bat'
# table['Value'] # => ["bat", "bat", "bat"]
def []=(index_or_header, value)
if @mode == :row or # by index
(@mode == :col_or_row and index_or_header.is_a? Integer)
if value.is_a? Array
@table[index_or_header] = Row.new(headers, value)
else
@table[index_or_header] = value
end
else # set column
unless index_or_header.is_a? Integer
index = @headers.index(index_or_header) || @headers.size
@headers[index] = index_or_header
end
if value.is_a? Array # multiple values
@table.each_with_index do |row, i|
if row.header_row?
row[index_or_header] = index_or_header
else
row[index_or_header] = value[i]
end
end
else # repeated value
@table.each do |row|
if row.header_row?
row[index_or_header] = index_or_header
else
row[index_or_header] = value
end
end
end
end
end
# :call-seq:
# table.values_at(*indexes) -> array_of_rows
# table.values_at(*headers) -> array_of_columns_data
#
# If the access mode is <tt>:row</tt> or <tt>:col_or_row</tt>,
# and each argument is either an \Integer or a \Range,
# returns rows.
# Otherwise, returns columns data.
#
# In either case, the returned values are in the order
# specified by the arguments. Arguments may be repeated.
#
# ---
#
# Returns rows as an \Array of \CSV::Row objects.
#
# No argument:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.values_at # => []
#
# One index:
# values = table.values_at(0)
# values # => [#<CSV::Row "Name":"foo" "Value":"0">]
#
# Two indexes:
# values = table.values_at(2, 0)
# values # => [#<CSV::Row "Name":"baz" "Value":"2">, #<CSV::Row "Name":"foo" "Value":"0">]
#
# One \Range:
# values = table.values_at(1..2)
# values # => [#<CSV::Row "Name":"bar" "Value":"1">, #<CSV::Row "Name":"baz" "Value":"2">]
#
# \Ranges and indexes:
# values = table.values_at(0..1, 1..2, 0, 2)
# pp values
# Output:
# [#<CSV::Row "Name":"foo" "Value":"0">,
# #<CSV::Row "Name":"bar" "Value":"1">,
# #<CSV::Row "Name":"bar" "Value":"1">,
# #<CSV::Row "Name":"baz" "Value":"2">,
# #<CSV::Row "Name":"foo" "Value":"0">,
# #<CSV::Row "Name":"baz" "Value":"2">]
#
# ---
#
# Returns columns data as row Arrays,
# each consisting of the specified columns data for that row:
# values = table.values_at('Name')
# values # => [["foo"], ["bar"], ["baz"]]
# values = table.values_at('Value', 'Name')
# values # => [["0", "foo"], ["1", "bar"], ["2", "baz"]]
def values_at(*indices_or_headers)
if @mode == :row or # by indices
( @mode == :col_or_row and indices_or_headers.all? do |index|
index.is_a?(Integer) or
( index.is_a?(Range) and
index.first.is_a?(Integer) and
index.last.is_a?(Integer) )
end )
@table.values_at(*indices_or_headers)
else # by headers
@table.map { |row| row.values_at(*indices_or_headers) }
end
end
# :call-seq:
# table << row_or_array -> self
#
# If +row_or_array+ is a \CSV::Row object,
# it is appended to the table:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table << CSV::Row.new(table.headers, ['bat', 3])
# table[3] # => #<CSV::Row "Name":"bat" "Value":3>
#
# If +row_or_array+ is an \Array, it is used to create a new
# \CSV::Row object which is then appended to the table:
# table << ['bam', 4]
# table[4] # => #<CSV::Row "Name":"bam" "Value":4>
def <<(row_or_array)
if row_or_array.is_a? Array # append Array
@table << Row.new(headers, row_or_array)
else # append Row
@table << row_or_array
end
self # for chaining
end
#
# :call-seq:
# table.push(*rows_or_arrays) -> self
#
# A shortcut for appending multiple rows. Equivalent to:
# rows.each {|row| self << row }
#
# Each argument may be either a \CSV::Row object or an \Array:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# rows = [
# CSV::Row.new(table.headers, ['bat', 3]),
# ['bam', 4]
# ]
# table.push(*rows)
# table[3..4] # => [#<CSV::Row "Name":"bat" "Value":3>, #<CSV::Row "Name":"bam" "Value":4>]
def push(*rows)
rows.each { |row| self << row }
self # for chaining
end
# :call-seq:
# table.delete(*indexes) -> deleted_values
# table.delete(*headers) -> deleted_values
#
# If the access mode is <tt>:row</tt> or <tt>:col_or_row</tt>,
# and each argument is either an \Integer or a \Range,
# returns deleted rows.
# Otherwise, returns deleted columns data.
#
# In either case, the returned values are in the order
# specified by the arguments. Arguments may be repeated.
#
# ---
#
# Returns rows as an \Array of \CSV::Row objects.
#
# One index:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# deleted_values = table.delete(0)
# deleted_values # => [#<CSV::Row "Name":"foo" "Value":"0">]
#
# Two indexes:
# table = CSV.parse(source, headers: true)
# deleted_values = table.delete(2, 0)
# deleted_values # => [#<CSV::Row "Name":"baz" "Value":"2">, #<CSV::Row "Name":"foo" "Value":"0">]
#
# ---
#
# Returns columns data as column Arrays.
#
# One header:
# table = CSV.parse(source, headers: true)
# deleted_values = table.delete('Name')
# deleted_values # => ["foo", "bar", "baz"]
#
# Two headers:
# table = CSV.parse(source, headers: true)
# deleted_values = table.delete('Value', 'Name')
# deleted_values # => [["0", "1", "2"], ["foo", "bar", "baz"]]
def delete(*indexes_or_headers)
if indexes_or_headers.empty?
raise ArgumentError, "wrong number of arguments (given 0, expected 1+)"
end
deleted_values = indexes_or_headers.map do |index_or_header|
if @mode == :row or # by index
(@mode == :col_or_row and index_or_header.is_a? Integer)
@table.delete_at(index_or_header)
else # by header
if index_or_header.is_a? Integer
@headers.delete_at(index_or_header)
else
@headers.delete(index_or_header)
end
@table.map { |row| row.delete(index_or_header).last }
end
end
if indexes_or_headers.size == 1
deleted_values[0]
else
deleted_values
end
end
# :call-seq:
# table.delete_if {|row_or_column| ... } -> self
#
# Removes rows or columns for which the block returns a truthy value;
# returns +self+.
#
# Removes rows when the access mode is <tt>:row</tt> or <tt>:col_or_row</tt>;
# calls the block with each \CSV::Row object:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# table.size # => 3
# table.delete_if {|row| row['Name'].start_with?('b') }
# table.size # => 1
#
# Removes columns when the access mode is <tt>:col</tt>;
# calls the block with each column as a 2-element array
# containing the header and an \Array of column fields:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_col! # => #<CSV::Table mode:col row_count:4>
# table.headers.size # => 2
# table.delete_if {|column_data| column_data[1].include?('2') }
# table.headers.size # => 1
#
# Returns a new \Enumerator if no block is given:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.delete_if # => #<Enumerator: #<CSV::Table mode:col_or_row row_count:4>:delete_if>
def delete_if(&block)
return enum_for(__method__) { @mode == :row or @mode == :col_or_row ? size : headers.size } unless block_given?
if @mode == :row or @mode == :col_or_row # by index
@table.delete_if(&block)
else # by header
headers.each do |header|
delete(header) if yield([header, self[header]])
end
end
self # for chaining
end
include Enumerable
# :call-seq:
# table.each {|row_or_column| ... ) -> self
#
# Calls the block with each row or column; returns +self+.
#
# When the access mode is <tt>:row</tt> or <tt>:col_or_row</tt>,
# calls the block with each \CSV::Row object:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.by_row! # => #<CSV::Table mode:row row_count:4>
# table.each {|row| p row }
# Output:
# #<CSV::Row "Name":"foo" "Value":"0">
# #<CSV::Row "Name":"bar" "Value":"1">
# #<CSV::Row "Name":"baz" "Value":"2">
#
# When the access mode is <tt>:col</tt>,
# calls the block with each column as a 2-element array
# containing the header and an \Array of column fields:
# table.by_col! # => #<CSV::Table mode:col row_count:4>
# table.each {|column_data| p column_data }
# Output:
# ["Name", ["foo", "bar", "baz"]]
# ["Value", ["0", "1", "2"]]
#
# Returns a new \Enumerator if no block is given:
# table.each # => #<Enumerator: #<CSV::Table mode:col row_count:4>:each>
def each(&block)
return enum_for(__method__) { @mode == :col ? headers.size : size } unless block_given?
if @mode == :col
headers.each.with_index do |header, i|
yield([header, @table.map {|row| row[header, i]}])
end
else
@table.each(&block)
end
self # for chaining
end
# :call-seq:
# table == other_table -> true or false
#
# Returns +true+ if all each row of +self+ <tt>==</tt>
# the corresponding row of +other_table+, otherwise, +false+.
#
# The access mode does no affect the result.
#
# Equal tables:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# other_table = CSV.parse(source, headers: true)
# table == other_table # => true
#
# Different row count:
# other_table.delete(2)
# table == other_table # => false
#
# Different last row:
# other_table << ['bat', 3]
# table == other_table # => false
def ==(other)
return @table == other.table if other.is_a? CSV::Table
@table == other
end
# :call-seq:
# table.to_a -> array_of_arrays
#
# Returns the table as an \Array of \Arrays;
# the headers are in the first row:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.to_a # => [["Name", "Value"], ["foo", "0"], ["bar", "1"], ["baz", "2"]]
def to_a
array = [headers]
@table.each do |row|
array.push(row.fields) unless row.header_row?
end
array
end
# :call-seq:
# table.to_csv(**options) -> csv_string
#
# Returns the table as \CSV string.
# See {Options for Generating}[../CSV.html#class-CSV-label-Options+for+Generating].
#
# Defaults option +write_headers+ to +true+:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.to_csv # => "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
#
# Omits the headers if option +write_headers+ is given as +false+
# (see {Option +write_headers+}[../CSV.html#class-CSV-label-Option+write_headers]):
# table.to_csv(write_headers: false) # => "foo,0\nbar,1\nbaz,2\n"
#
# Limit rows if option +limit+ is given like +2+:
# table.to_csv(limit: 2) # => "Name,Value\nfoo,0\nbar,1\n"
def to_csv(write_headers: true, limit: nil, **options)
array = write_headers ? [headers.to_csv(**options)] : []
limit ||= @table.size
limit = @table.size + 1 + limit if limit < 0
limit = 0 if limit < 0
@table.first(limit).each do |row|
array.push(row.fields.to_csv(**options)) unless row.header_row?
end
array.join("")
end
alias_method :to_s, :to_csv
#
# Extracts the nested value specified by the sequence of +index+ or +header+ objects by calling dig at each step,
# returning nil if any intermediate step is nil.
#
def dig(index_or_header, *index_or_headers)
value = self[index_or_header]
if value.nil?
nil
elsif index_or_headers.empty?
value
else
unless value.respond_to?(:dig)
raise TypeError, "#{value.class} does not have \#dig method"
end
value.dig(*index_or_headers)
end
end
# :call-seq:
# table.inspect => string
#
# Returns a <tt>US-ASCII</tt>-encoded \String showing table:
# - Class: <tt>CSV::Table</tt>.
# - Access mode: <tt>:row</tt>, <tt>:col</tt>, or <tt>:col_or_row</tt>.
# - Size: Row count, including the header row.
#
# Example:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.inspect # => "#<CSV::Table mode:col_or_row row_count:4>\nName,Value\nfoo,0\nbar,1\nbaz,2\n"
#
def inspect
inspected = +"#<#{self.class} mode:#{@mode} row_count:#{to_a.size}>"
summary = to_csv(limit: 5)
inspected << "\n" << summary if summary.encoding.ascii_compatible?
inspected
end
end
end
share/ruby/csv/writer.rb 0000644 00000013570 15173517736 0011310 0 ustar 00 # frozen_string_literal: true
require_relative "input_record_separator"
require_relative "row"
class CSV
# Note: Don't use this class directly. This is an internal class.
class Writer
#
# A CSV::Writer receives an output, prepares the header, format and output.
# It allows us to write new rows in the object and rewind it.
#
attr_reader :lineno
attr_reader :headers
def initialize(output, options)
@output = output
@options = options
@lineno = 0
@fields_converter = nil
prepare
if @options[:write_headers] and @headers
self << @headers
end
@fields_converter = @options[:fields_converter]
end
#
# Adds a new row
#
def <<(row)
case row
when Row
row = row.fields
when Hash
row = @headers.collect {|header| row[header]}
end
@headers ||= row if @use_headers
@lineno += 1
if @fields_converter
quoted_fields = [false] * row.size
row = @fields_converter.convert(row, nil, lineno, quoted_fields)
end
i = -1
converted_row = row.collect do |field|
i += 1
quote(field, i)
end
line = converted_row.join(@column_separator) + @row_separator
if @output_encoding
line = line.encode(@output_encoding)
end
@output << line
self
end
#
# Winds back to the beginning
#
def rewind
@lineno = 0
@headers = nil if @options[:headers].nil?
end
private
def prepare
@encoding = @options[:encoding]
prepare_header
prepare_format
prepare_output
end
def prepare_header
headers = @options[:headers]
case headers
when Array
@headers = headers
@use_headers = true
when String
@headers = CSV.parse_line(headers,
col_sep: @options[:column_separator],
row_sep: @options[:row_separator],
quote_char: @options[:quote_character])
@use_headers = true
when true
@headers = nil
@use_headers = true
else
@headers = nil
@use_headers = false
end
return unless @headers
converter = @options[:header_fields_converter]
@headers = converter.convert(@headers, nil, 0, [])
@headers.each do |header|
header.freeze if header.is_a?(String)
end
end
def prepare_force_quotes_fields(force_quotes)
@force_quotes_fields = {}
force_quotes.each do |name_or_index|
case name_or_index
when Integer
index = name_or_index
@force_quotes_fields[index] = true
when String, Symbol
name = name_or_index.to_s
if @headers.nil?
message = ":headers is required when you use field name " +
"in :force_quotes: " +
"#{name_or_index.inspect}: #{force_quotes.inspect}"
raise ArgumentError, message
end
index = @headers.index(name)
next if index.nil?
@force_quotes_fields[index] = true
else
message = ":force_quotes element must be " +
"field index or field name: " +
"#{name_or_index.inspect}: #{force_quotes.inspect}"
raise ArgumentError, message
end
end
end
def prepare_format
@column_separator = @options[:column_separator].to_s.encode(@encoding)
row_separator = @options[:row_separator]
if row_separator == :auto
@row_separator = InputRecordSeparator.value.encode(@encoding)
else
@row_separator = row_separator.to_s.encode(@encoding)
end
@quote_character = @options[:quote_character]
force_quotes = @options[:force_quotes]
if force_quotes.is_a?(Array)
prepare_force_quotes_fields(force_quotes)
@force_quotes = false
elsif force_quotes
@force_quotes_fields = nil
@force_quotes = true
else
@force_quotes_fields = nil
@force_quotes = false
end
unless @force_quotes
@quotable_pattern =
Regexp.new("[\r\n".encode(@encoding) +
Regexp.escape(@column_separator) +
Regexp.escape(@quote_character.encode(@encoding)) +
"]".encode(@encoding))
end
@quote_empty = @options.fetch(:quote_empty, true)
end
def prepare_output
@output_encoding = nil
return unless @output.is_a?(StringIO)
output_encoding = @output.internal_encoding || @output.external_encoding
if @encoding != output_encoding
if @options[:force_encoding]
@output_encoding = output_encoding
else
compatible_encoding = Encoding.compatible?(@encoding, output_encoding)
if compatible_encoding
@output.set_encoding(compatible_encoding)
@output.seek(0, IO::SEEK_END)
end
end
end
end
def quote_field(field)
field = String(field)
encoded_quote_character = @quote_character.encode(field.encoding)
encoded_quote_character +
field.gsub(encoded_quote_character,
encoded_quote_character * 2) +
encoded_quote_character
end
def quote(field, i)
if @force_quotes
quote_field(field)
elsif @force_quotes_fields and @force_quotes_fields[i]
quote_field(field)
else
if field.nil? # represent +nil+ fields as empty unquoted fields
""
else
field = String(field) # Stringify fields
# represent empty fields as empty quoted fields
if (@quote_empty and field.empty?) or (field.valid_encoding? and @quotable_pattern.match?(field))
quote_field(field)
else
field # unquoted field
end
end
end
end
end
end
share/ruby/csv/core_ext/string.rb 0000644 00000000314 15173517736 0013102 0 ustar 00 class String # :nodoc:
# Equivalent to CSV::parse_line(self, options)
#
# "CSV,data".parse_csv
# #=> ["CSV", "data"]
def parse_csv(**options)
CSV.parse_line(self, **options)
end
end
share/ruby/csv/core_ext/array.rb 0000644 00000000315 15173517736 0012713 0 ustar 00 class Array # :nodoc:
# Equivalent to CSV::generate_line(self, options)
#
# ["CSV", "data"].to_csv
# #=> "CSV,data\n"
def to_csv(**options)
CSV.generate_line(self, **options)
end
end
share/ruby/csv/row.rb 0000644 00000060277 15173517737 0010612 0 ustar 00 # frozen_string_literal: true
require "forwardable"
class CSV
# = \CSV::Row
# A \CSV::Row instance represents a \CSV table row.
# (see {class CSV}[../CSV.html]).
#
# The instance may have:
# - Fields: each is an object, not necessarily a \String.
# - Headers: each serves a key, and also need not be a \String.
#
# === Instance Methods
#
# \CSV::Row has three groups of instance methods:
# - Its own internally defined instance methods.
# - Methods included by module Enumerable.
# - Methods delegated to class Array.:
# * Array#empty?
# * Array#length
# * Array#size
#
# == Creating a \CSV::Row Instance
#
# Commonly, a new \CSV::Row instance is created by parsing \CSV source
# that has headers:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# table.each {|row| p row }
# Output:
# #<CSV::Row "Name":"foo" "Value":"0">
# #<CSV::Row "Name":"bar" "Value":"1">
# #<CSV::Row "Name":"baz" "Value":"2">
#
# You can also create a row directly. See ::new.
#
# == Headers
#
# Like a \CSV::Table, a \CSV::Row has headers.
#
# A \CSV::Row that was created by parsing \CSV source
# inherits its headers from the table:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table.first
# row.headers # => ["Name", "Value"]
#
# You can also create a new row with headers;
# like the keys in a \Hash, the headers need not be Strings:
# row = CSV::Row.new([:name, :value], ['foo', 0])
# row.headers # => [:name, :value]
#
# The new row retains its headers even if added to a table
# that has headers:
# table << row # => #<CSV::Table mode:col_or_row row_count:5>
# row.headers # => [:name, :value]
# row[:name] # => "foo"
# row['Name'] # => nil
#
#
#
# == Accessing Fields
#
# You may access a field in a \CSV::Row with either its \Integer index
# (\Array-style) or its header (\Hash-style).
#
# Fetch a field using method #[]:
# row = CSV::Row.new(['Name', 'Value'], ['foo', 0])
# row[1] # => 0
# row['Value'] # => 0
#
# Set a field using method #[]=:
# row = CSV::Row.new(['Name', 'Value'], ['foo', 0])
# row # => #<CSV::Row "Name":"foo" "Value":0>
# row[0] = 'bar'
# row['Value'] = 1
# row # => #<CSV::Row "Name":"bar" "Value":1>
#
class Row
# :call-seq:
# CSV::Row.new(headers, fields, header_row = false) -> csv_row
#
# Returns the new \CSV::Row instance constructed from
# arguments +headers+ and +fields+; both should be Arrays;
# note that the fields need not be Strings:
# row = CSV::Row.new(['Name', 'Value'], ['foo', 0])
# row # => #<CSV::Row "Name":"foo" "Value":0>
#
# If the \Array lengths are different, the shorter is +nil+-filled:
# row = CSV::Row.new(['Name', 'Value', 'Date', 'Size'], ['foo', 0])
# row # => #<CSV::Row "Name":"foo" "Value":0 "Date":nil "Size":nil>
#
# Each \CSV::Row object is either a <i>field row</i> or a <i>header row</i>;
# by default, a new row is a field row; for the row created above:
# row.field_row? # => true
# row.header_row? # => false
#
# If the optional argument +header_row+ is given as +true+,
# the created row is a header row:
# row = CSV::Row.new(['Name', 'Value'], ['foo', 0], header_row = true)
# row # => #<CSV::Row "Name":"foo" "Value":0>
# row.field_row? # => false
# row.header_row? # => true
def initialize(headers, fields, header_row = false)
@header_row = header_row
headers.each { |h| h.freeze if h.is_a? String }
# handle extra headers or fields
@row = if headers.size >= fields.size
headers.zip(fields)
else
fields.zip(headers).each(&:reverse!)
end
end
# Internal data format used to compare equality.
attr_reader :row
protected :row
### Array Delegation ###
extend Forwardable
def_delegators :@row, :empty?, :length, :size
# :call-seq:
# row.initialize_copy(other_row) -> self
#
# Calls superclass method.
def initialize_copy(other)
super_return_value = super
@row = @row.collect(&:dup)
super_return_value
end
# :call-seq:
# row.header_row? -> true or false
#
# Returns +true+ if this is a header row, +false+ otherwise.
def header_row?
@header_row
end
# :call-seq:
# row.field_row? -> true or false
#
# Returns +true+ if this is a field row, +false+ otherwise.
def field_row?
not header_row?
end
# :call-seq:
# row.headers -> array_of_headers
#
# Returns the headers for this row:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table.first
# row.headers # => ["Name", "Value"]
def headers
@row.map(&:first)
end
# :call-seq:
# field(index) -> value
# field(header) -> value
# field(header, offset) -> value
#
# Returns the field value for the given +index+ or +header+.
#
# ---
#
# Fetch field value by \Integer index:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.field(0) # => "foo"
# row.field(1) # => "bar"
#
# Counts backward from the last column if +index+ is negative:
# row.field(-1) # => "0"
# row.field(-2) # => "foo"
#
# Returns +nil+ if +index+ is out of range:
# row.field(2) # => nil
# row.field(-3) # => nil
#
# ---
#
# Fetch field value by header (first found):
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.field('Name') # => "Foo"
#
# Fetch field value by header, ignoring +offset+ leading fields:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.field('Name', 2) # => "Baz"
#
# Returns +nil+ if the header does not exist.
def field(header_or_index, minimum_index = 0)
# locate the pair
finder = (header_or_index.is_a?(Integer) || header_or_index.is_a?(Range)) ? :[] : :assoc
pair = @row[minimum_index..-1].public_send(finder, header_or_index)
# return the field if we have a pair
if pair.nil?
nil
else
header_or_index.is_a?(Range) ? pair.map(&:last) : pair.last
end
end
alias_method :[], :field
#
# :call-seq:
# fetch(header) -> value
# fetch(header, default) -> value
# fetch(header) {|row| ... } -> value
#
# Returns the field value as specified by +header+.
#
# ---
#
# With the single argument +header+, returns the field value
# for that header (first found):
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.fetch('Name') # => "Foo"
#
# Raises exception +KeyError+ if the header does not exist.
#
# ---
#
# With arguments +header+ and +default+ given,
# returns the field value for the header (first found)
# if the header exists, otherwise returns +default+:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.fetch('Name', '') # => "Foo"
# row.fetch(:nosuch, '') # => ""
#
# ---
#
# With argument +header+ and a block given,
# returns the field value for the header (first found)
# if the header exists; otherwise calls the block
# and returns its return value:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.fetch('Name') {|header| fail 'Cannot happen' } # => "Foo"
# row.fetch(:nosuch) {|header| "Header '#{header} not found'" } # => "Header 'nosuch not found'"
def fetch(header, *varargs)
raise ArgumentError, "Too many arguments" if varargs.length > 1
pair = @row.assoc(header)
if pair
pair.last
else
if block_given?
yield header
elsif varargs.empty?
raise KeyError, "key not found: #{header}"
else
varargs.first
end
end
end
# :call-seq:
# row.has_key?(header) -> true or false
#
# Returns +true+ if there is a field with the given +header+,
# +false+ otherwise.
def has_key?(header)
!!@row.assoc(header)
end
alias_method :include?, :has_key?
alias_method :key?, :has_key?
alias_method :member?, :has_key?
alias_method :header?, :has_key?
#
# :call-seq:
# row[index] = value -> value
# row[header, offset] = value -> value
# row[header] = value -> value
#
# Assigns the field value for the given +index+ or +header+;
# returns +value+.
#
# ---
#
# Assign field value by \Integer index:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row[0] = 'Bat'
# row[1] = 3
# row # => #<CSV::Row "Name":"Bat" "Value":3>
#
# Counts backward from the last column if +index+ is negative:
# row[-1] = 4
# row[-2] = 'Bam'
# row # => #<CSV::Row "Name":"Bam" "Value":4>
#
# Extends the row with <tt>nil:nil</tt> if positive +index+ is not in the row:
# row[4] = 5
# row # => #<CSV::Row "Name":"bad" "Value":4 nil:nil nil:nil nil:5>
#
# Raises IndexError if negative +index+ is too small (too far from zero).
#
# ---
#
# Assign field value by header (first found):
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row['Name'] = 'Bat'
# row # => #<CSV::Row "Name":"Bat" "Name":"Bar" "Name":"Baz">
#
# Assign field value by header, ignoring +offset+ leading fields:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row['Name', 2] = 4
# row # => #<CSV::Row "Name":"Foo" "Name":"Bar" "Name":4>
#
# Append new field by (new) header:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row['New'] = 6
# row# => #<CSV::Row "Name":"foo" "Value":"0" "New":6>
def []=(*args)
value = args.pop
if args.first.is_a? Integer
if @row[args.first].nil? # extending past the end with index
@row[args.first] = [nil, value]
@row.map! { |pair| pair.nil? ? [nil, nil] : pair }
else # normal index assignment
@row[args.first][1] = value
end
else
index = index(*args)
if index.nil? # appending a field
self << [args.first, value]
else # normal header assignment
@row[index][1] = value
end
end
end
#
# :call-seq:
# row << [header, value] -> self
# row << hash -> self
# row << value -> self
#
# Adds a field to +self+; returns +self+:
#
# If the argument is a 2-element \Array <tt>[header, value]</tt>,
# a field is added with the given +header+ and +value+:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row << ['NAME', 'Bat']
# row # => #<CSV::Row "Name":"Foo" "Name":"Bar" "Name":"Baz" "NAME":"Bat">
#
# If the argument is a \Hash, each <tt>key-value</tt> pair is added
# as a field with header +key+ and value +value+.
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row << {NAME: 'Bat', name: 'Bam'}
# row # => #<CSV::Row "Name":"Foo" "Name":"Bar" "Name":"Baz" NAME:"Bat" name:"Bam">
#
# Otherwise, the given +value+ is added as a field with no header.
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row << 'Bag'
# row # => #<CSV::Row "Name":"Foo" "Name":"Bar" "Name":"Baz" nil:"Bag">
def <<(arg)
if arg.is_a?(Array) and arg.size == 2 # appending a header and name
@row << arg
elsif arg.is_a?(Hash) # append header and name pairs
arg.each { |pair| @row << pair }
else # append field value
@row << [nil, arg]
end
self # for chaining
end
# :call-seq:
# row.push(*values) -> self
#
# Appends each of the given +values+ to +self+ as a field; returns +self+:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.push('Bat', 'Bam')
# row # => #<CSV::Row "Name":"Foo" "Name":"Bar" "Name":"Baz" nil:"Bat" nil:"Bam">
def push(*args)
args.each { |arg| self << arg }
self # for chaining
end
#
# :call-seq:
# delete(index) -> [header, value] or nil
# delete(header) -> [header, value] or empty_array
# delete(header, offset) -> [header, value] or empty_array
#
# Removes a specified field from +self+; returns the 2-element \Array
# <tt>[header, value]</tt> if the field exists.
#
# If an \Integer argument +index+ is given,
# removes and returns the field at offset +index+,
# or returns +nil+ if the field does not exist:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.delete(1) # => ["Name", "Bar"]
# row.delete(50) # => nil
#
# Otherwise, if the single argument +header+ is given,
# removes and returns the first-found field with the given header,
# of returns a new empty \Array if the field does not exist:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.delete('Name') # => ["Name", "Foo"]
# row.delete('NAME') # => []
#
# If argument +header+ and \Integer argument +offset+ are given,
# removes and returns the first-found field with the given header
# whose +index+ is at least as large as +offset+:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.delete('Name', 1) # => ["Name", "Bar"]
# row.delete('NAME', 1) # => []
def delete(header_or_index, minimum_index = 0)
if header_or_index.is_a? Integer # by index
@row.delete_at(header_or_index)
elsif i = index(header_or_index, minimum_index) # by header
@row.delete_at(i)
else
[ ]
end
end
# :call-seq:
# row.delete_if {|header, value| ... } -> self
#
# Removes fields from +self+ as selected by the block; returns +self+.
#
# Removes each field for which the block returns a truthy value:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.delete_if {|header, value| value.start_with?('B') } # => true
# row # => #<CSV::Row "Name":"Foo">
# row.delete_if {|header, value| header.start_with?('B') } # => false
#
# If no block is given, returns a new Enumerator:
# row.delete_if # => #<Enumerator: #<CSV::Row "Name":"Foo">:delete_if>
def delete_if(&block)
return enum_for(__method__) { size } unless block_given?
@row.delete_if(&block)
self # for chaining
end
# :call-seq:
# self.fields(*specifiers) -> array_of_fields
#
# Returns field values per the given +specifiers+, which may be any mixture of:
# - \Integer index.
# - \Range of \Integer indexes.
# - 2-element \Array containing a header and offset.
# - Header.
# - \Range of headers.
#
# For +specifier+ in one of the first four cases above,
# returns the result of <tt>self.field(specifier)</tt>; see #field.
#
# Although there may be any number of +specifiers+,
# the examples here will illustrate one at a time.
#
# When the specifier is an \Integer +index+,
# returns <tt>self.field(index)</tt>L
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.fields(1) # => ["Bar"]
#
# When the specifier is a \Range of \Integers +range+,
# returns <tt>self.field(range)</tt>:
# row.fields(1..2) # => ["Bar", "Baz"]
#
# When the specifier is a 2-element \Array +array+,
# returns <tt>self.field(array)</tt>L
# row.fields('Name', 1) # => ["Foo", "Bar"]
#
# When the specifier is a header +header+,
# returns <tt>self.field(header)</tt>L
# row.fields('Name') # => ["Foo"]
#
# When the specifier is a \Range of headers +range+,
# forms a new \Range +new_range+ from the indexes of
# <tt>range.start</tt> and <tt>range.end</tt>,
# and returns <tt>self.field(new_range)</tt>:
# source = "Name,NAME,name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.fields('Name'..'NAME') # => ["Foo", "Bar"]
#
# Returns all fields if no argument given:
# row.fields # => ["Foo", "Bar", "Baz"]
def fields(*headers_and_or_indices)
if headers_and_or_indices.empty? # return all fields--no arguments
@row.map(&:last)
else # or work like values_at()
all = []
headers_and_or_indices.each do |h_or_i|
if h_or_i.is_a? Range
index_begin = h_or_i.begin.is_a?(Integer) ? h_or_i.begin :
index(h_or_i.begin)
index_end = h_or_i.end.is_a?(Integer) ? h_or_i.end :
index(h_or_i.end)
new_range = h_or_i.exclude_end? ? (index_begin...index_end) :
(index_begin..index_end)
all.concat(fields.values_at(new_range))
else
all << field(*Array(h_or_i))
end
end
return all
end
end
alias_method :values_at, :fields
# :call-seq:
# index(header) -> index
# index(header, offset) -> index
#
# Returns the index for the given header, if it exists;
# otherwise returns +nil+.
#
# With the single argument +header+, returns the index
# of the first-found field with the given +header+:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.index('Name') # => 0
# row.index('NAME') # => nil
#
# With arguments +header+ and +offset+,
# returns the index of the first-found field with given +header+,
# but ignoring the first +offset+ fields:
# row.index('Name', 1) # => 1
# row.index('Name', 3) # => nil
def index(header, minimum_index = 0)
# find the pair
index = headers[minimum_index..-1].index(header)
# return the index at the right offset, if we found one
index.nil? ? nil : index + minimum_index
end
# :call-seq:
# row.field?(value) -> true or false
#
# Returns +true+ if +value+ is a field in this row, +false+ otherwise:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.field?('Bar') # => true
# row.field?('BAR') # => false
def field?(data)
fields.include? data
end
include Enumerable
# :call-seq:
# row.each {|header, value| ... } -> self
#
# Calls the block with each header-value pair; returns +self+:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.each {|header, value| p [header, value] }
# Output:
# ["Name", "Foo"]
# ["Name", "Bar"]
# ["Name", "Baz"]
#
# If no block is given, returns a new Enumerator:
# row.each # => #<Enumerator: #<CSV::Row "Name":"Foo" "Name":"Bar" "Name":"Baz">:each>
def each(&block)
return enum_for(__method__) { size } unless block_given?
@row.each(&block)
self # for chaining
end
alias_method :each_pair, :each
# :call-seq:
# row == other -> true or false
#
# Returns +true+ if +other+ is a /CSV::Row that has the same
# fields (headers and values) in the same order as +self+;
# otherwise returns +false+:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# other_row = table[0]
# row == other_row # => true
# other_row = table[1]
# row == other_row # => false
def ==(other)
return @row == other.row if other.is_a? CSV::Row
@row == other
end
# :call-seq:
# row.to_h -> hash
#
# Returns the new \Hash formed by adding each header-value pair in +self+
# as a key-value pair in the \Hash.
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.to_h # => {"Name"=>"foo", "Value"=>"0"}
#
# Header order is preserved, but repeated headers are ignored:
# source = "Name,Name,Name\nFoo,Bar,Baz\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.to_h # => {"Name"=>"Foo"}
def to_h
hash = {}
each do |key, _value|
hash[key] = self[key] unless hash.key?(key)
end
hash
end
alias_method :to_hash, :to_h
# :call-seq:
# row.deconstruct_keys(keys) -> hash
#
# Returns the new \Hash suitable for pattern matching containing only the
# keys specified as an argument.
def deconstruct_keys(keys)
if keys.nil?
to_h
else
keys.to_h { |key| [key, self[key]] }
end
end
alias_method :to_ary, :to_a
# :call-seq:
# row.deconstruct -> array
#
# Returns the new \Array suitable for pattern matching containing the values
# of the row.
def deconstruct
fields
end
# :call-seq:
# row.to_csv -> csv_string
#
# Returns the row as a \CSV String. Headers are not included:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.to_csv # => "foo,0\n"
def to_csv(**options)
fields.to_csv(**options)
end
alias_method :to_s, :to_csv
# :call-seq:
# row.dig(index_or_header, *identifiers) -> object
#
# Finds and returns the object in nested object that is specified
# by +index_or_header+ and +specifiers+.
#
# The nested objects may be instances of various classes.
# See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
#
# Examples:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.dig(1) # => "0"
# row.dig('Value') # => "0"
# row.dig(5) # => nil
def dig(index_or_header, *indexes)
value = field(index_or_header)
if value.nil?
nil
elsif indexes.empty?
value
else
unless value.respond_to?(:dig)
raise TypeError, "#{value.class} does not have \#dig method"
end
value.dig(*indexes)
end
end
# :call-seq:
# row.inspect -> string
#
# Returns an ASCII-compatible \String showing:
# - Class \CSV::Row.
# - Header-value pairs.
# Example:
# source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
# table = CSV.parse(source, headers: true)
# row = table[0]
# row.inspect # => "#<CSV::Row \"Name\":\"foo\" \"Value\":\"0\">"
def inspect
str = ["#<", self.class.to_s]
each do |header, field|
str << " " << (header.is_a?(Symbol) ? header.to_s : header.inspect) <<
":" << field.inspect
end
str << ">"
begin
str.join('')
rescue # any encoding error
str.map do |s|
e = Encoding::Converter.asciicompat_encoding(s.encoding)
e ? s.encode(e) : s.force_encoding("ASCII-8BIT")
end.join('')
end
end
end
end
share/ruby/csv/fields_converter.rb 0000644 00000005072 15173517737 0013330 0 ustar 00 # frozen_string_literal: true
class CSV
# Note: Don't use this class directly. This is an internal class.
class FieldsConverter
include Enumerable
#
# A CSV::FieldsConverter is a data structure for storing the
# fields converter properties to be passed as a parameter
# when parsing a new file (e.g. CSV::Parser.new(@io, parser_options))
#
def initialize(options={})
@converters = []
@nil_value = options[:nil_value]
@empty_value = options[:empty_value]
@empty_value_is_empty_string = (@empty_value == "")
@accept_nil = options[:accept_nil]
@builtin_converters_name = options[:builtin_converters_name]
@need_static_convert = need_static_convert?
end
def add_converter(name=nil, &converter)
if name.nil? # custom converter
@converters << converter
else # named converter
combo = builtin_converters[name]
case combo
when Array # combo converter
combo.each do |sub_name|
add_converter(sub_name)
end
else # individual named converter
@converters << combo
end
end
end
def each(&block)
@converters.each(&block)
end
def empty?
@converters.empty?
end
def convert(fields, headers, lineno, quoted_fields)
return fields unless need_convert?
fields.collect.with_index do |field, index|
if field.nil?
field = @nil_value
elsif field.is_a?(String) and field.empty?
field = @empty_value unless @empty_value_is_empty_string
end
@converters.each do |converter|
break if field.nil? and @accept_nil
if converter.arity == 1 # straight field converter
field = converter[field]
else # FieldInfo converter
if headers
header = headers[index]
else
header = nil
end
quoted = quoted_fields[index]
field = converter[field, FieldInfo.new(index, lineno, header, quoted)]
end
break unless field.is_a?(String) # short-circuit pipeline for speed
end
field # final state of each field, converted or original
end
end
private
def need_static_convert?
not (@nil_value.nil? and @empty_value_is_empty_string)
end
def need_convert?
@need_static_convert or
(not @converters.empty?)
end
def builtin_converters
@builtin_converters ||= ::CSV.const_get(@builtin_converters_name)
end
end
end
share/ruby/csv/input_record_separator.rb 0000644 00000000425 15173517737 0014545 0 ustar 00 require "English"
require "stringio"
class CSV
module InputRecordSeparator
class << self
if RUBY_VERSION >= "3.0.0"
def value
"\n"
end
else
def value
$INPUT_RECORD_SEPARATOR
end
end
end
end
end
share/ruby/csv/version.rb 0000644 00000000153 15173517737 0011453 0 ustar 00 # frozen_string_literal: true
class CSV
# The version of the installed library.
VERSION = "3.2.8"
end
share/ruby/csv/parser.rb 0000644 00000111216 15173517737 0011265 0 ustar 00 # frozen_string_literal: true
require "strscan"
require_relative "input_record_separator"
require_relative "row"
require_relative "table"
class CSV
# Note: Don't use this class directly. This is an internal class.
class Parser
#
# A CSV::Parser is m17n aware. The parser works in the Encoding of the IO
# or String object being read from or written to. Your data is never transcoded
# (unless you ask Ruby to transcode it for you) and will literally be parsed in
# the Encoding it is in. Thus CSV will return Arrays or Rows of Strings in the
# Encoding of your data. This is accomplished by transcoding the parser itself
# into your Encoding.
#
# Raised when encoding is invalid.
class InvalidEncoding < StandardError
end
# Raised when unexpected case is happen.
class UnexpectedError < StandardError
end
#
# CSV::Scanner receives a CSV output, scans it and return the content.
# It also controls the life cycle of the object with its methods +keep_start+,
# +keep_end+, +keep_back+, +keep_drop+.
#
# Uses StringScanner (the official strscan gem). Strscan provides lexical
# scanning operations on a String. We inherit its object and take advantage
# on the methods. For more information, please visit:
# https://ruby-doc.org/stdlib-2.6.1/libdoc/strscan/rdoc/StringScanner.html
#
class Scanner < StringScanner
alias_method :scan_all, :scan
def initialize(*args)
super
@keeps = []
end
def each_line(row_separator)
position = pos
rest.each_line(row_separator) do |line|
position += line.bytesize
self.pos = position
yield(line)
end
end
def keep_start
@keeps.push(pos)
end
def keep_end
start = @keeps.pop
string.byteslice(start, pos - start)
end
def keep_back
self.pos = @keeps.pop
end
def keep_drop
@keeps.pop
end
end
#
# CSV::InputsScanner receives IO inputs, encoding and the chunk_size.
# It also controls the life cycle of the object with its methods +keep_start+,
# +keep_end+, +keep_back+, +keep_drop+.
#
# CSV::InputsScanner.scan() tries to match with pattern at the current position.
# If there's a match, the scanner advances the "scan pointer" and returns the matched string.
# Otherwise, the scanner returns nil.
#
# CSV::InputsScanner.rest() returns the "rest" of the string (i.e. everything after the scan pointer).
# If there is no more data (eos? = true), it returns "".
#
class InputsScanner
def initialize(inputs, encoding, row_separator, chunk_size: 8192)
@inputs = inputs.dup
@encoding = encoding
@row_separator = row_separator
@chunk_size = chunk_size
@last_scanner = @inputs.empty?
@keeps = []
read_chunk
end
def each_line(row_separator)
return enum_for(__method__, row_separator) unless block_given?
buffer = nil
input = @scanner.rest
position = @scanner.pos
offset = 0
n_row_separator_chars = row_separator.size
# trace(__method__, :start, input)
while true
input.each_line(row_separator) do |line|
@scanner.pos += line.bytesize
if buffer
if n_row_separator_chars == 2 and
buffer.end_with?(row_separator[0]) and
line.start_with?(row_separator[1])
buffer << line[0]
line = line[1..-1]
position += buffer.bytesize + offset
@scanner.pos = position
offset = 0
yield(buffer)
buffer = nil
next if line.empty?
else
buffer << line
line = buffer
buffer = nil
end
end
if line.end_with?(row_separator)
position += line.bytesize + offset
@scanner.pos = position
offset = 0
yield(line)
else
buffer = line
end
end
break unless read_chunk
input = @scanner.rest
position = @scanner.pos
offset = -buffer.bytesize if buffer
end
yield(buffer) if buffer
end
def scan(pattern)
# trace(__method__, pattern, :start)
value = @scanner.scan(pattern)
# trace(__method__, pattern, :done, :last, value) if @last_scanner
return value if @last_scanner
read_chunk if value and @scanner.eos?
# trace(__method__, pattern, :done, value)
value
end
def scan_all(pattern)
# trace(__method__, pattern, :start)
value = @scanner.scan(pattern)
# trace(__method__, pattern, :done, :last, value) if @last_scanner
return value if @last_scanner
# trace(__method__, pattern, :done, :nil) if value.nil?
return nil if value.nil?
while @scanner.eos? and read_chunk and (sub_value = @scanner.scan(pattern))
# trace(__method__, pattern, :sub, sub_value)
value << sub_value
end
# trace(__method__, pattern, :done, value)
value
end
def eos?
@scanner.eos?
end
def keep_start
# trace(__method__, :start)
adjust_last_keep
@keeps.push([@scanner, @scanner.pos, nil])
# trace(__method__, :done)
end
def keep_end
# trace(__method__, :start)
scanner, start, buffer = @keeps.pop
if scanner == @scanner
keep = @scanner.string.byteslice(start, @scanner.pos - start)
else
keep = @scanner.string.byteslice(0, @scanner.pos)
end
if buffer
buffer << keep
keep = buffer
end
# trace(__method__, :done, keep)
keep
end
def keep_back
# trace(__method__, :start)
scanner, start, buffer = @keeps.pop
if buffer
# trace(__method__, :rescan, start, buffer)
string = @scanner.string
if scanner == @scanner
keep = string.byteslice(start,
string.bytesize - @scanner.pos - start)
else
keep = string
end
if keep and not keep.empty?
@inputs.unshift(StringIO.new(keep))
@last_scanner = false
end
@scanner = StringScanner.new(buffer)
else
if @scanner != scanner
message = "scanners are different but no buffer: "
message += "#{@scanner.inspect}(#{@scanner.object_id}): "
message += "#{scanner.inspect}(#{scanner.object_id})"
raise UnexpectedError, message
end
# trace(__method__, :repos, start, buffer)
@scanner.pos = start
end
read_chunk if @scanner.eos?
end
def keep_drop
_, _, buffer = @keeps.pop
# trace(__method__, :done, :empty) unless buffer
return unless buffer
last_keep = @keeps.last
# trace(__method__, :done, :no_last_keep) unless last_keep
return unless last_keep
if last_keep[2]
last_keep[2] << buffer
else
last_keep[2] = buffer
end
# trace(__method__, :done)
end
def rest
@scanner.rest
end
def check(pattern)
@scanner.check(pattern)
end
private
def trace(*args)
pp([*args, @scanner, @scanner&.string, @scanner&.pos, @keeps])
end
def adjust_last_keep
# trace(__method__, :start)
keep = @keeps.last
# trace(__method__, :done, :empty) if keep.nil?
return if keep.nil?
scanner, start, buffer = keep
string = @scanner.string
if @scanner != scanner
start = 0
end
if start == 0 and @scanner.eos?
keep_data = string
else
keep_data = string.byteslice(start, @scanner.pos - start)
end
if keep_data
if buffer
buffer << keep_data
else
keep[2] = keep_data.dup
end
end
# trace(__method__, :done)
end
def read_chunk
return false if @last_scanner
adjust_last_keep
input = @inputs.first
case input
when StringIO
string = input.read
raise InvalidEncoding unless string.valid_encoding?
# trace(__method__, :stringio, string)
@scanner = StringScanner.new(string)
@inputs.shift
@last_scanner = @inputs.empty?
true
else
chunk = input.gets(@row_separator, @chunk_size)
if chunk
raise InvalidEncoding unless chunk.valid_encoding?
# trace(__method__, :chunk, chunk)
@scanner = StringScanner.new(chunk)
if input.respond_to?(:eof?) and input.eof?
@inputs.shift
@last_scanner = @inputs.empty?
end
true
else
# trace(__method__, :no_chunk)
@scanner = StringScanner.new("".encode(@encoding))
@inputs.shift
@last_scanner = @inputs.empty?
if @last_scanner
false
else
read_chunk
end
end
end
end
end
def initialize(input, options)
@input = input
@options = options
@samples = []
prepare
end
def column_separator
@column_separator
end
def row_separator
@row_separator
end
def quote_character
@quote_character
end
def field_size_limit
@max_field_size&.succ
end
def max_field_size
@max_field_size
end
def skip_lines
@skip_lines
end
def unconverted_fields?
@unconverted_fields
end
def headers
@headers
end
def header_row?
@use_headers and @headers.nil?
end
def return_headers?
@return_headers
end
def skip_blanks?
@skip_blanks
end
def liberal_parsing?
@liberal_parsing
end
def lineno
@lineno
end
def line
last_line
end
def parse(&block)
return to_enum(__method__) unless block_given?
if @return_headers and @headers and @raw_headers
headers = Row.new(@headers, @raw_headers, true)
if @unconverted_fields
headers = add_unconverted_fields(headers, [])
end
yield headers
end
begin
@scanner ||= build_scanner
if quote_character.nil?
parse_no_quote(&block)
elsif @need_robust_parsing
parse_quotable_robust(&block)
else
parse_quotable_loose(&block)
end
rescue InvalidEncoding
if @scanner
ignore_broken_line
lineno = @lineno
else
lineno = @lineno + 1
end
raise InvalidEncodingError.new(@encoding, lineno)
rescue UnexpectedError => error
if @scanner
ignore_broken_line
lineno = @lineno
else
lineno = @lineno + 1
end
message = "This should not be happen: #{error.message}: "
message += "Please report this to https://github.com/ruby/csv/issues"
raise MalformedCSVError.new(message, lineno)
end
end
def use_headers?
@use_headers
end
private
# A set of tasks to prepare the file in order to parse it
def prepare
prepare_variable
prepare_quote_character
prepare_backslash
prepare_skip_lines
prepare_strip
prepare_separators
validate_strip_and_col_sep_options
prepare_quoted
prepare_unquoted
prepare_line
prepare_header
prepare_parser
end
def prepare_variable
@need_robust_parsing = false
@encoding = @options[:encoding]
liberal_parsing = @options[:liberal_parsing]
if liberal_parsing
@liberal_parsing = true
if liberal_parsing.is_a?(Hash)
@double_quote_outside_quote =
liberal_parsing[:double_quote_outside_quote]
@backslash_quote = liberal_parsing[:backslash_quote]
else
@double_quote_outside_quote = false
@backslash_quote = false
end
@need_robust_parsing = true
else
@liberal_parsing = false
@backslash_quote = false
end
@unconverted_fields = @options[:unconverted_fields]
@max_field_size = @options[:max_field_size]
@skip_blanks = @options[:skip_blanks]
@fields_converter = @options[:fields_converter]
@header_fields_converter = @options[:header_fields_converter]
end
def prepare_quote_character
@quote_character = @options[:quote_character]
if @quote_character.nil?
@escaped_quote_character = nil
@escaped_quote = nil
else
@quote_character = @quote_character.to_s.encode(@encoding)
if @quote_character.length != 1
message = ":quote_char has to be nil or a single character String"
raise ArgumentError, message
end
@escaped_quote_character = Regexp.escape(@quote_character)
@escaped_quote = Regexp.new(@escaped_quote_character)
end
end
def prepare_backslash
return unless @backslash_quote
@backslash_character = "\\".encode(@encoding)
@escaped_backslash_character = Regexp.escape(@backslash_character)
@escaped_backslash = Regexp.new(@escaped_backslash_character)
if @quote_character.nil?
@backslash_quote_character = nil
else
@backslash_quote_character =
@backslash_character + @escaped_quote_character
end
end
def prepare_skip_lines
skip_lines = @options[:skip_lines]
case skip_lines
when String
@skip_lines = skip_lines.encode(@encoding)
when Regexp, nil
@skip_lines = skip_lines
else
unless skip_lines.respond_to?(:match)
message =
":skip_lines has to respond to \#match: #{skip_lines.inspect}"
raise ArgumentError, message
end
@skip_lines = skip_lines
end
end
def prepare_strip
@strip = @options[:strip]
@escaped_strip = nil
@strip_value = nil
@rstrip_value = nil
if @strip.is_a?(String)
case @strip.length
when 0
raise ArgumentError, ":strip must not be an empty String"
when 1
# ok
else
raise ArgumentError, ":strip doesn't support 2 or more characters yet"
end
@strip = @strip.encode(@encoding)
@escaped_strip = Regexp.escape(@strip)
if @quote_character
@strip_value = Regexp.new(@escaped_strip +
"+".encode(@encoding))
@rstrip_value = Regexp.new(@escaped_strip +
"+\\z".encode(@encoding))
end
@need_robust_parsing = true
elsif @strip
strip_values = " \t\f\v"
@escaped_strip = strip_values.encode(@encoding)
if @quote_character
@strip_value = Regexp.new("[#{strip_values}]+".encode(@encoding))
@rstrip_value = Regexp.new("[#{strip_values}]+\\z".encode(@encoding))
end
@need_robust_parsing = true
end
end
begin
StringScanner.new("x").scan("x")
rescue TypeError
STRING_SCANNER_SCAN_ACCEPT_STRING = false
else
STRING_SCANNER_SCAN_ACCEPT_STRING = true
end
def prepare_separators
column_separator = @options[:column_separator]
@column_separator = column_separator.to_s.encode(@encoding)
if @column_separator.size < 1
message = ":col_sep must be 1 or more characters: "
message += column_separator.inspect
raise ArgumentError, message
end
@row_separator =
resolve_row_separator(@options[:row_separator]).encode(@encoding)
@escaped_column_separator = Regexp.escape(@column_separator)
@escaped_first_column_separator = Regexp.escape(@column_separator[0])
if @column_separator.size > 1
@column_end = Regexp.new(@escaped_column_separator)
@column_ends = @column_separator.each_char.collect do |char|
Regexp.new(Regexp.escape(char))
end
@first_column_separators = Regexp.new(@escaped_first_column_separator +
"+".encode(@encoding))
else
if STRING_SCANNER_SCAN_ACCEPT_STRING
@column_end = @column_separator
else
@column_end = Regexp.new(@escaped_column_separator)
end
@column_ends = nil
@first_column_separators = nil
end
escaped_row_separator = Regexp.escape(@row_separator)
@row_end = Regexp.new(escaped_row_separator)
if @row_separator.size > 1
@row_ends = @row_separator.each_char.collect do |char|
Regexp.new(Regexp.escape(char))
end
else
@row_ends = nil
end
@cr = "\r".encode(@encoding)
@lf = "\n".encode(@encoding)
@line_end = Regexp.new("\r\n|\n|\r".encode(@encoding))
@not_line_end = Regexp.new("[^\r\n]+".encode(@encoding))
end
# This method verifies that there are no (obvious) ambiguities with the
# provided +col_sep+ and +strip+ parsing options. For example, if +col_sep+
# and +strip+ were both equal to +\t+, then there would be no clear way to
# parse the input.
def validate_strip_and_col_sep_options
return unless @strip
if @strip.is_a?(String)
if @column_separator.start_with?(@strip) || @column_separator.end_with?(@strip)
raise ArgumentError,
"The provided strip (#{@escaped_strip}) and " \
"col_sep (#{@escaped_column_separator}) options are incompatible."
end
else
if Regexp.new("\\A[#{@escaped_strip}]|[#{@escaped_strip}]\\z").match?(@column_separator)
raise ArgumentError,
"The provided strip (true) and " \
"col_sep (#{@escaped_column_separator}) options are incompatible."
end
end
end
def prepare_quoted
if @quote_character
@quotes = Regexp.new(@escaped_quote_character +
"+".encode(@encoding))
no_quoted_values = @escaped_quote_character.dup
if @backslash_quote
no_quoted_values << @escaped_backslash_character
end
@quoted_value = Regexp.new("[^".encode(@encoding) +
no_quoted_values +
"]+".encode(@encoding))
end
if @escaped_strip
@split_column_separator = Regexp.new(@escaped_strip +
"*".encode(@encoding) +
@escaped_column_separator +
@escaped_strip +
"*".encode(@encoding))
else
if @column_separator == " ".encode(@encoding)
@split_column_separator = Regexp.new(@escaped_column_separator)
else
@split_column_separator = @column_separator
end
end
end
def prepare_unquoted
return if @quote_character.nil?
no_unquoted_values = "\r\n".encode(@encoding)
no_unquoted_values << @escaped_first_column_separator
unless @liberal_parsing
no_unquoted_values << @escaped_quote_character
end
@unquoted_value = Regexp.new("[^".encode(@encoding) +
no_unquoted_values +
"]+".encode(@encoding))
end
def resolve_row_separator(separator)
if separator == :auto
cr = "\r".encode(@encoding)
lf = "\n".encode(@encoding)
if @input.is_a?(StringIO)
pos = @input.pos
separator = detect_row_separator(@input.read, cr, lf)
@input.seek(pos)
elsif @input.respond_to?(:gets)
if @input.is_a?(File)
chunk_size = 32 * 1024
else
chunk_size = 1024
end
begin
while separator == :auto
#
# if we run out of data, it's probably a single line
# (ensure will set default value)
#
break unless sample = @input.gets(nil, chunk_size)
# extend sample if we're unsure of the line ending
if sample.end_with?(cr)
sample << (@input.gets(nil, 1) || "")
end
@samples << sample
separator = detect_row_separator(sample, cr, lf)
end
rescue IOError
# do nothing: ensure will set default
end
end
separator = InputRecordSeparator.value if separator == :auto
end
separator.to_s.encode(@encoding)
end
def detect_row_separator(sample, cr, lf)
lf_index = sample.index(lf)
if lf_index
cr_index = sample[0, lf_index].index(cr)
else
cr_index = sample.index(cr)
end
if cr_index and lf_index
if cr_index + 1 == lf_index
cr + lf
elsif cr_index < lf_index
cr
else
lf
end
elsif cr_index
cr
elsif lf_index
lf
else
:auto
end
end
def prepare_line
@lineno = 0
@last_line = nil
@scanner = nil
end
def last_line
if @scanner
@last_line ||= @scanner.keep_end
else
@last_line
end
end
def prepare_header
@return_headers = @options[:return_headers]
headers = @options[:headers]
case headers
when Array
@raw_headers = headers
quoted_fields = [false] * @raw_headers.size
@use_headers = true
when String
@raw_headers, quoted_fields = parse_headers(headers)
@use_headers = true
when nil, false
@raw_headers = nil
@use_headers = false
else
@raw_headers = nil
@use_headers = true
end
if @raw_headers
@headers = adjust_headers(@raw_headers, quoted_fields)
else
@headers = nil
end
end
def parse_headers(row)
quoted_fields = []
converter = lambda do |field, info|
quoted_fields << info.quoted?
field
end
headers = CSV.parse_line(row,
col_sep: @column_separator,
row_sep: @row_separator,
quote_char: @quote_character,
converters: [converter])
[headers, quoted_fields]
end
def adjust_headers(headers, quoted_fields)
adjusted_headers = @header_fields_converter.convert(headers, nil, @lineno, quoted_fields)
adjusted_headers.each {|h| h.freeze if h.is_a? String}
adjusted_headers
end
def prepare_parser
@may_quoted = may_quoted?
end
def may_quoted?
return false if @quote_character.nil?
if @input.is_a?(StringIO)
pos = @input.pos
sample = @input.read
@input.seek(pos)
else
return false if @samples.empty?
sample = @samples.first
end
sample[0, 128].index(@quote_character)
end
class UnoptimizedStringIO # :nodoc:
def initialize(string)
@io = StringIO.new(string, "rb:#{string.encoding}")
end
def gets(*args)
@io.gets(*args)
end
def each_line(*args, &block)
@io.each_line(*args, &block)
end
def eof?
@io.eof?
end
end
SCANNER_TEST = (ENV["CSV_PARSER_SCANNER_TEST"] == "yes")
if SCANNER_TEST
SCANNER_TEST_CHUNK_SIZE_NAME = "CSV_PARSER_SCANNER_TEST_CHUNK_SIZE"
SCANNER_TEST_CHUNK_SIZE_VALUE = ENV[SCANNER_TEST_CHUNK_SIZE_NAME]
def build_scanner
inputs = @samples.collect do |sample|
UnoptimizedStringIO.new(sample)
end
if @input.is_a?(StringIO)
inputs << UnoptimizedStringIO.new(@input.read)
else
inputs << @input
end
begin
chunk_size_value = ENV[SCANNER_TEST_CHUNK_SIZE_NAME]
rescue # Ractor::IsolationError
# Ractor on Ruby 3.0 can't read ENV value.
chunk_size_value = SCANNER_TEST_CHUNK_SIZE_VALUE
end
chunk_size = Integer((chunk_size_value || "1"), 10)
InputsScanner.new(inputs,
@encoding,
@row_separator,
chunk_size: chunk_size)
end
else
def build_scanner
string = nil
if @samples.empty? and @input.is_a?(StringIO)
string = @input.read
elsif @samples.size == 1 and
@input != ARGF and
@input.respond_to?(:eof?) and
@input.eof?
string = @samples[0]
end
if string
unless string.valid_encoding?
index = string.lines(@row_separator).index do |line|
!line.valid_encoding?
end
if index
raise InvalidEncodingError.new(@encoding, @lineno + index + 1)
end
end
Scanner.new(string)
else
inputs = @samples.collect do |sample|
StringIO.new(sample)
end
inputs << @input
InputsScanner.new(inputs, @encoding, @row_separator)
end
end
end
def skip_needless_lines
return unless @skip_lines
until @scanner.eos?
@scanner.keep_start
line = @scanner.scan_all(@not_line_end) || "".encode(@encoding)
line << @row_separator if parse_row_end
if skip_line?(line)
@lineno += 1
@scanner.keep_drop
else
@scanner.keep_back
return
end
end
end
def skip_line?(line)
line = line.delete_suffix(@row_separator)
case @skip_lines
when String
line.include?(@skip_lines)
when Regexp
@skip_lines.match?(line)
else
@skip_lines.match(line)
end
end
def validate_field_size(field)
return unless @max_field_size
return if field.size <= @max_field_size
ignore_broken_line
message = "Field size exceeded: #{field.size} > #{@max_field_size}"
raise MalformedCSVError.new(message, @lineno)
end
def parse_no_quote(&block)
@scanner.each_line(@row_separator) do |line|
next if @skip_lines and skip_line?(line)
original_line = line
line = line.delete_suffix(@row_separator)
if line.empty?
next if @skip_blanks
row = []
quoted_fields = []
else
line = strip_value(line)
row = line.split(@split_column_separator, -1)
quoted_fields = [false] * row.size
if @max_field_size
row.each do |column|
validate_field_size(column)
end
end
n_columns = row.size
i = 0
while i < n_columns
row[i] = nil if row[i].empty?
i += 1
end
end
@last_line = original_line
emit_row(row, quoted_fields, &block)
end
end
def parse_quotable_loose(&block)
@scanner.keep_start
@scanner.each_line(@row_separator) do |line|
if @skip_lines and skip_line?(line)
@scanner.keep_drop
@scanner.keep_start
next
end
original_line = line
line = line.delete_suffix(@row_separator)
if line.empty?
if @skip_blanks
@scanner.keep_drop
@scanner.keep_start
next
end
row = []
quoted_fields = []
elsif line.include?(@cr) or line.include?(@lf)
@scanner.keep_back
@need_robust_parsing = true
return parse_quotable_robust(&block)
else
row = line.split(@split_column_separator, -1)
quoted_fields = []
n_columns = row.size
i = 0
while i < n_columns
column = row[i]
if column.empty?
quoted_fields << false
row[i] = nil
else
n_quotes = column.count(@quote_character)
if n_quotes.zero?
quoted_fields << false
# no quote
elsif n_quotes == 2 and
column.start_with?(@quote_character) and
column.end_with?(@quote_character)
quoted_fields << true
row[i] = column[1..-2]
else
@scanner.keep_back
@need_robust_parsing = true
return parse_quotable_robust(&block)
end
validate_field_size(row[i])
end
i += 1
end
end
@scanner.keep_drop
@scanner.keep_start
@last_line = original_line
emit_row(row, quoted_fields, &block)
end
@scanner.keep_drop
end
def parse_quotable_robust(&block)
row = []
quoted_fields = []
skip_needless_lines
start_row
while true
@quoted_column_value = false
@unquoted_column_value = false
@scanner.scan_all(@strip_value) if @strip_value
value = parse_column_value
if value
@scanner.scan_all(@strip_value) if @strip_value
validate_field_size(value)
end
if parse_column_end
row << value
quoted_fields << @quoted_column_value
elsif parse_row_end
if row.empty? and value.nil?
emit_row([], [], &block) unless @skip_blanks
else
row << value
quoted_fields << @quoted_column_value
emit_row(row, quoted_fields, &block)
row = []
quoted_fields = []
end
skip_needless_lines
start_row
elsif @scanner.eos?
break if row.empty? and value.nil?
row << value
quoted_fields << @quoted_column_value
emit_row(row, quoted_fields, &block)
break
else
if @quoted_column_value
if liberal_parsing? and (new_line = @scanner.check(@line_end))
message =
"Illegal end-of-line sequence outside of a quoted field " +
"<#{new_line.inspect}>"
else
message = "Any value after quoted field isn't allowed"
end
ignore_broken_line
raise MalformedCSVError.new(message, @lineno)
elsif @unquoted_column_value and
(new_line = @scanner.scan(@line_end))
ignore_broken_line
message = "Unquoted fields do not allow new line " +
"<#{new_line.inspect}>"
raise MalformedCSVError.new(message, @lineno)
elsif @scanner.rest.start_with?(@quote_character)
ignore_broken_line
message = "Illegal quoting"
raise MalformedCSVError.new(message, @lineno)
elsif (new_line = @scanner.scan(@line_end))
ignore_broken_line
message = "New line must be <#{@row_separator.inspect}> " +
"not <#{new_line.inspect}>"
raise MalformedCSVError.new(message, @lineno)
else
ignore_broken_line
raise MalformedCSVError.new("TODO: Meaningful message",
@lineno)
end
end
end
end
def parse_column_value
if @liberal_parsing
quoted_value = parse_quoted_column_value
if quoted_value
@scanner.scan_all(@strip_value) if @strip_value
unquoted_value = parse_unquoted_column_value
if unquoted_value
if @double_quote_outside_quote
unquoted_value = unquoted_value.gsub(@quote_character * 2,
@quote_character)
if quoted_value.empty? # %Q{""...} case
return @quote_character + unquoted_value
end
end
@quote_character + quoted_value + @quote_character + unquoted_value
else
quoted_value
end
else
parse_unquoted_column_value
end
elsif @may_quoted
parse_quoted_column_value ||
parse_unquoted_column_value
else
parse_unquoted_column_value ||
parse_quoted_column_value
end
end
def parse_unquoted_column_value
value = @scanner.scan_all(@unquoted_value)
return nil unless value
@unquoted_column_value = true
if @first_column_separators
while true
@scanner.keep_start
is_column_end = @column_ends.all? do |column_end|
@scanner.scan(column_end)
end
@scanner.keep_back
break if is_column_end
sub_separator = @scanner.scan_all(@first_column_separators)
break if sub_separator.nil?
value << sub_separator
sub_value = @scanner.scan_all(@unquoted_value)
break if sub_value.nil?
value << sub_value
end
end
value.gsub!(@backslash_quote_character, @quote_character) if @backslash_quote
if @rstrip_value
value.gsub!(@rstrip_value, "")
end
value
end
def parse_quoted_column_value
quotes = @scanner.scan_all(@quotes)
return nil unless quotes
@quoted_column_value = true
n_quotes = quotes.size
if (n_quotes % 2).zero?
quotes[0, (n_quotes - 2) / 2]
else
value = quotes[0, n_quotes / 2]
while true
quoted_value = @scanner.scan_all(@quoted_value)
value << quoted_value if quoted_value
if @backslash_quote
if @scanner.scan(@escaped_backslash)
if @scanner.scan(@escaped_quote)
value << @quote_character
else
value << @backslash_character
end
next
end
end
quotes = @scanner.scan_all(@quotes)
unless quotes
ignore_broken_line
message = "Unclosed quoted field"
raise MalformedCSVError.new(message, @lineno)
end
n_quotes = quotes.size
if n_quotes == 1
break
else
value << quotes[0, n_quotes / 2]
break if (n_quotes % 2) == 1
end
end
value
end
end
def parse_column_end
return true if @scanner.scan(@column_end)
return false unless @column_ends
@scanner.keep_start
if @column_ends.all? {|column_end| @scanner.scan(column_end)}
@scanner.keep_drop
true
else
@scanner.keep_back
false
end
end
def parse_row_end
return true if @scanner.scan(@row_end)
return false unless @row_ends
@scanner.keep_start
if @row_ends.all? {|row_end| @scanner.scan(row_end)}
@scanner.keep_drop
true
else
@scanner.keep_back
false
end
end
def strip_value(value)
return value unless @strip
return value if value.nil?
case @strip
when String
while value.delete_prefix!(@strip)
# do nothing
end
while value.delete_suffix!(@strip)
# do nothing
end
else
value.strip!
end
value
end
def ignore_broken_line
@scanner.scan_all(@not_line_end)
@scanner.scan_all(@line_end)
@lineno += 1
end
def start_row
if @last_line
@last_line = nil
else
@scanner.keep_drop
end
@scanner.keep_start
end
def emit_row(row, quoted_fields, &block)
@lineno += 1
raw_row = row
if @use_headers
if @headers.nil?
@headers = adjust_headers(row, quoted_fields)
return unless @return_headers
row = Row.new(@headers, row, true)
else
row = Row.new(@headers,
@fields_converter.convert(raw_row, @headers, @lineno, quoted_fields))
end
else
# convert fields, if needed...
row = @fields_converter.convert(raw_row, nil, @lineno, quoted_fields)
end
# inject unconverted fields and accessor, if requested...
if @unconverted_fields and not row.respond_to?(:unconverted_fields)
add_unconverted_fields(row, raw_row)
end
yield(row)
end
# This method injects an instance variable <tt>unconverted_fields</tt> into
# +row+ and an accessor method for +row+ called unconverted_fields(). The
# variable is set to the contents of +fields+.
def add_unconverted_fields(row, fields)
class << row
attr_reader :unconverted_fields
end
row.instance_variable_set(:@unconverted_fields, fields)
row
end
end
end
share/ruby/rinda/ring.rb 0000644 00000031061 15173517737 0011231 0 ustar 00 # frozen_string_literal: false
#
# Note: Rinda::Ring API is unstable.
#
require 'drb/drb'
require_relative 'rinda'
require 'ipaddr'
module Rinda
##
# The default port Ring discovery will use.
Ring_PORT = 7647
##
# A RingServer allows a Rinda::TupleSpace to be located via UDP broadcasts.
# Default service location uses the following steps:
#
# 1. A RingServer begins listening on the network broadcast UDP address.
# 2. A RingFinger sends a UDP packet containing the DRb URI where it will
# listen for a reply.
# 3. The RingServer receives the UDP packet and connects back to the
# provided DRb URI with the DRb service.
#
# A RingServer requires a TupleSpace:
#
# ts = Rinda::TupleSpace.new
# rs = Rinda::RingServer.new
#
# RingServer can also listen on multicast addresses for announcements. This
# allows multiple RingServers to run on the same host. To use network
# broadcast and multicast:
#
# ts = Rinda::TupleSpace.new
# rs = Rinda::RingServer.new ts, %w[Socket::INADDR_ANY, 239.0.0.1 ff02::1]
class RingServer
include DRbUndumped
##
# Special renewer for the RingServer to allow shutdown
class Renewer # :nodoc:
include DRbUndumped
##
# Set to false to shutdown future requests using this Renewer
attr_writer :renew
def initialize # :nodoc:
@renew = true
end
def renew # :nodoc:
@renew ? 1 : true
end
end
##
# Advertises +ts+ on the given +addresses+ at +port+.
#
# If +addresses+ is omitted only the UDP broadcast address is used.
#
# +addresses+ can contain multiple addresses. If a multicast address is
# given in +addresses+ then the RingServer will listen for multicast
# queries.
#
# If you use IPv4 multicast you may need to set an address of the inbound
# interface which joins a multicast group.
#
# ts = Rinda::TupleSpace.new
# rs = Rinda::RingServer.new(ts, [['239.0.0.1', '9.5.1.1']])
#
# You can set addresses as an Array Object. The first element of the
# Array is a multicast address and the second is an inbound interface
# address. If the second is omitted then '0.0.0.0' is used.
#
# If you use IPv6 multicast you may need to set both the local interface
# address and the inbound interface index:
#
# rs = Rinda::RingServer.new(ts, [['ff02::1', '::1', 1]])
#
# The first element is a multicast address and the second is an inbound
# interface address. The third is an inbound interface index.
#
# At this time there is no easy way to get an interface index by name.
#
# If the second is omitted then '::1' is used.
# If the third is omitted then 0 (default interface) is used.
def initialize(ts, addresses=[Socket::INADDR_ANY], port=Ring_PORT)
@port = port
if Integer === addresses then
addresses, @port = [Socket::INADDR_ANY], addresses
end
@renewer = Renewer.new
@ts = ts
@sockets = []
addresses.each do |address|
if Array === address
make_socket(*address)
else
make_socket(address)
end
end
@w_services = write_services
@r_service = reply_service
end
##
# Creates a socket at +address+
#
# If +address+ is multicast address then +interface_address+ and
# +multicast_interface+ can be set as optional.
#
# A created socket is bound to +interface_address+. If you use IPv4
# multicast then the interface of +interface_address+ is used as the
# inbound interface. If +interface_address+ is omitted or nil then
# '0.0.0.0' or '::1' is used.
#
# If you use IPv6 multicast then +multicast_interface+ is used as the
# inbound interface. +multicast_interface+ is a network interface index.
# If +multicast_interface+ is omitted then 0 (default interface) is used.
def make_socket(address, interface_address=nil, multicast_interface=0)
addrinfo = Addrinfo.udp(address, @port)
socket = Socket.new(addrinfo.pfamily, addrinfo.socktype,
addrinfo.protocol)
if addrinfo.ipv4_multicast? or addrinfo.ipv6_multicast? then
if Socket.const_defined?(:SO_REUSEPORT) then
socket.setsockopt(:SOCKET, :SO_REUSEPORT, true)
else
socket.setsockopt(:SOCKET, :SO_REUSEADDR, true)
end
if addrinfo.ipv4_multicast? then
interface_address = '0.0.0.0' if interface_address.nil?
socket.bind(Addrinfo.udp(interface_address, @port))
mreq = IPAddr.new(addrinfo.ip_address).hton +
IPAddr.new(interface_address).hton
socket.setsockopt(:IPPROTO_IP, :IP_ADD_MEMBERSHIP, mreq)
else
interface_address = '::1' if interface_address.nil?
socket.bind(Addrinfo.udp(interface_address, @port))
mreq = IPAddr.new(addrinfo.ip_address).hton +
[multicast_interface].pack('I')
socket.setsockopt(:IPPROTO_IPV6, :IPV6_JOIN_GROUP, mreq)
end
else
socket.bind(addrinfo)
end
socket
rescue
socket = socket.close if socket
raise
ensure
@sockets << socket if socket
end
##
# Creates threads that pick up UDP packets and passes them to do_write for
# decoding.
def write_services
@sockets.map do |s|
Thread.new(s) do |socket|
loop do
msg = socket.recv(1024)
do_write(msg)
end
end
end
end
##
# Extracts the response URI from +msg+ and adds it to TupleSpace where it
# will be picked up by +reply_service+ for notification.
def do_write(msg)
Thread.new do
begin
tuple, sec = Marshal.load(msg)
@ts.write(tuple, sec)
rescue
end
end
end
##
# Creates a thread that notifies waiting clients from the TupleSpace.
def reply_service
Thread.new do
loop do
do_reply
end
end
end
##
# Pulls lookup tuples out of the TupleSpace and sends their DRb object the
# address of the local TupleSpace.
def do_reply
tuple = @ts.take([:lookup_ring, nil], @renewer)
Thread.new { tuple[1].call(@ts) rescue nil}
rescue
end
##
# Shuts down the RingServer
def shutdown
@renewer.renew = false
@w_services.each do |thread|
thread.kill
thread.join
end
@sockets.each do |socket|
socket.close
end
@r_service.kill
@r_service.join
end
end
##
# RingFinger is used by RingServer clients to discover the RingServer's
# TupleSpace. Typically, all a client needs to do is call
# RingFinger.primary to retrieve the remote TupleSpace, which it can then
# begin using.
#
# To find the first available remote TupleSpace:
#
# Rinda::RingFinger.primary
#
# To create a RingFinger that broadcasts to a custom list:
#
# rf = Rinda::RingFinger.new ['localhost', '192.0.2.1']
# rf.primary
#
# Rinda::RingFinger also understands multicast addresses and sets them up
# properly. This allows you to run multiple RingServers on the same host:
#
# rf = Rinda::RingFinger.new ['239.0.0.1']
# rf.primary
#
# You can set the hop count (or TTL) for multicast searches using
# #multicast_hops.
#
# If you use IPv6 multicast you may need to set both an address and the
# outbound interface index:
#
# rf = Rinda::RingFinger.new ['ff02::1']
# rf.multicast_interface = 1
# rf.primary
#
# At this time there is no easy way to get an interface index by name.
class RingFinger
@@broadcast_list = ['<broadcast>', 'localhost']
@@finger = nil
##
# Creates a singleton RingFinger and looks for a RingServer. Returns the
# created RingFinger.
def self.finger
unless @@finger
@@finger = self.new
@@finger.lookup_ring_any
end
@@finger
end
##
# Returns the first advertised TupleSpace.
def self.primary
finger.primary
end
##
# Contains all discovered TupleSpaces except for the primary.
def self.to_a
finger.to_a
end
##
# The list of addresses where RingFinger will send query packets.
attr_accessor :broadcast_list
##
# Maximum number of hops for sent multicast packets (if using a multicast
# address in the broadcast list). The default is 1 (same as UDP
# broadcast).
attr_accessor :multicast_hops
##
# The interface index to send IPv6 multicast packets from.
attr_accessor :multicast_interface
##
# The port that RingFinger will send query packets to.
attr_accessor :port
##
# Contain the first advertised TupleSpace after lookup_ring_any is called.
attr_accessor :primary
##
# Creates a new RingFinger that will look for RingServers at +port+ on
# the addresses in +broadcast_list+.
#
# If +broadcast_list+ contains a multicast address then multicast queries
# will be made using the given multicast_hops and multicast_interface.
def initialize(broadcast_list=@@broadcast_list, port=Ring_PORT)
@broadcast_list = broadcast_list || ['localhost']
@port = port
@primary = nil
@rings = []
@multicast_hops = 1
@multicast_interface = 0
end
##
# Contains all discovered TupleSpaces except for the primary.
def to_a
@rings
end
##
# Iterates over all discovered TupleSpaces starting with the primary.
def each
lookup_ring_any unless @primary
return unless @primary
yield(@primary)
@rings.each { |x| yield(x) }
end
##
# Looks up RingServers waiting +timeout+ seconds. RingServers will be
# given +block+ as a callback, which will be called with the remote
# TupleSpace.
def lookup_ring(timeout=5, &block)
return lookup_ring_any(timeout) unless block_given?
msg = Marshal.dump([[:lookup_ring, DRbObject.new(block)], timeout])
@broadcast_list.each do |it|
send_message(it, msg)
end
sleep(timeout)
end
##
# Returns the first found remote TupleSpace. Any further recovered
# TupleSpaces can be found by calling +to_a+.
def lookup_ring_any(timeout=5)
queue = Thread::Queue.new
Thread.new do
self.lookup_ring(timeout) do |ts|
queue.push(ts)
end
queue.push(nil)
end
@primary = queue.pop
raise('RingNotFound') if @primary.nil?
Thread.new do
while it = queue.pop
@rings.push(it)
end
end
@primary
end
##
# Creates a socket for +address+ with the appropriate multicast options
# for multicast addresses.
def make_socket(address) # :nodoc:
addrinfo = Addrinfo.udp(address, @port)
soc = Socket.new(addrinfo.pfamily, addrinfo.socktype, addrinfo.protocol)
begin
if addrinfo.ipv4_multicast? then
soc.setsockopt(Socket::Option.ipv4_multicast_loop(1))
soc.setsockopt(Socket::Option.ipv4_multicast_ttl(@multicast_hops))
elsif addrinfo.ipv6_multicast? then
soc.setsockopt(:IPPROTO_IPV6, :IPV6_MULTICAST_LOOP, true)
soc.setsockopt(:IPPROTO_IPV6, :IPV6_MULTICAST_HOPS,
[@multicast_hops].pack('I'))
soc.setsockopt(:IPPROTO_IPV6, :IPV6_MULTICAST_IF,
[@multicast_interface].pack('I'))
else
soc.setsockopt(:SOL_SOCKET, :SO_BROADCAST, true)
end
soc.connect(addrinfo)
rescue Exception
soc.close
raise
end
soc
end
def send_message(address, message) # :nodoc:
soc = make_socket(address)
soc.send(message, 0)
rescue
nil
ensure
soc.close if soc
end
end
##
# RingProvider uses a RingServer advertised TupleSpace as a name service.
# TupleSpace clients can register themselves with the remote TupleSpace and
# look up other provided services via the remote TupleSpace.
#
# Services are registered with a tuple of the format [:name, klass,
# DRbObject, description].
class RingProvider
##
# Creates a RingProvider that will provide a +klass+ service running on
# +front+, with a +description+. +renewer+ is optional.
def initialize(klass, front, desc, renewer = nil)
@tuple = [:name, klass, front, desc]
@renewer = renewer || Rinda::SimpleRenewer.new
end
##
# Advertises this service on the primary remote TupleSpace.
def provide
ts = Rinda::RingFinger.primary
ts.write(@tuple, @renewer)
end
end
end
share/ruby/rinda/tuplespace.rb 0000644 00000033610 15173517737 0012441 0 ustar 00 # frozen_string_literal: false
require 'monitor'
require 'drb/drb'
require_relative 'rinda'
require 'forwardable'
module Rinda
##
# A TupleEntry is a Tuple (i.e. a possible entry in some Tuplespace)
# together with expiry and cancellation data.
class TupleEntry
include DRbUndumped
attr_accessor :expires
##
# Creates a TupleEntry based on +ary+ with an optional renewer or expiry
# time +sec+.
#
# A renewer must implement the +renew+ method which returns a Numeric,
# nil, or true to indicate when the tuple has expired.
def initialize(ary, sec=nil)
@cancel = false
@expires = nil
@tuple = make_tuple(ary)
@renewer = nil
renew(sec)
end
##
# Marks this TupleEntry as canceled.
def cancel
@cancel = true
end
##
# A TupleEntry is dead when it is canceled or expired.
def alive?
!canceled? && !expired?
end
##
# Return the object which makes up the tuple itself: the Array
# or Hash.
def value; @tuple.value; end
##
# Returns the canceled status.
def canceled?; @cancel; end
##
# Has this tuple expired? (true/false).
#
# A tuple has expired when its expiry timer based on the +sec+ argument to
# #initialize runs out.
def expired?
return true unless @expires
return false if @expires > Time.now
return true if @renewer.nil?
renew(@renewer)
return true unless @expires
return @expires < Time.now
end
##
# Reset the expiry time according to +sec_or_renewer+.
#
# +nil+:: it is set to expire in the far future.
# +true+:: it has expired.
# Numeric:: it will expire in that many seconds.
#
# Otherwise the argument refers to some kind of renewer object
# which will reset its expiry time.
def renew(sec_or_renewer)
sec, @renewer = get_renewer(sec_or_renewer)
@expires = make_expires(sec)
end
##
# Returns an expiry Time based on +sec+ which can be one of:
# Numeric:: +sec+ seconds into the future
# +true+:: the expiry time is the start of 1970 (i.e. expired)
# +nil+:: it is Tue Jan 19 03:14:07 GMT Standard Time 2038 (i.e. when
# UNIX clocks will die)
def make_expires(sec=nil)
case sec
when Numeric
Time.now + sec
when true
Time.at(1)
when nil
Time.at(2**31-1)
end
end
##
# Retrieves +key+ from the tuple.
def [](key)
@tuple[key]
end
##
# Fetches +key+ from the tuple.
def fetch(key)
@tuple.fetch(key)
end
##
# The size of the tuple.
def size
@tuple.size
end
##
# Creates a Rinda::Tuple for +ary+.
def make_tuple(ary)
Rinda::Tuple.new(ary)
end
private
##
# Returns a valid argument to make_expires and the renewer or nil.
#
# Given +true+, +nil+, or Numeric, returns that value and +nil+ (no actual
# renewer). Otherwise it returns an expiry value from calling +it.renew+
# and the renewer.
def get_renewer(it)
case it
when Numeric, true, nil
return it, nil
else
begin
return it.renew, it
rescue Exception
return it, nil
end
end
end
end
##
# A TemplateEntry is a Template together with expiry and cancellation data.
class TemplateEntry < TupleEntry
##
# Matches this TemplateEntry against +tuple+. See Template#match for
# details on how a Template matches a Tuple.
def match(tuple)
@tuple.match(tuple)
end
alias === match
def make_tuple(ary) # :nodoc:
Rinda::Template.new(ary)
end
end
##
# <i>Documentation?</i>
class WaitTemplateEntry < TemplateEntry
attr_reader :found
def initialize(place, ary, expires=nil)
super(ary, expires)
@place = place
@cond = place.new_cond
@found = nil
end
def cancel
super
signal
end
def wait
@cond.wait
end
def read(tuple)
@found = tuple
signal
end
def signal
@place.synchronize do
@cond.signal
end
end
end
##
# A NotifyTemplateEntry is returned by TupleSpace#notify and is notified of
# TupleSpace changes. You may receive either your subscribed event or the
# 'close' event when iterating over notifications.
#
# See TupleSpace#notify_event for valid notification types.
#
# == Example
#
# ts = Rinda::TupleSpace.new
# observer = ts.notify 'write', [nil]
#
# Thread.start do
# observer.each { |t| p t }
# end
#
# 3.times { |i| ts.write [i] }
#
# Outputs:
#
# ['write', [0]]
# ['write', [1]]
# ['write', [2]]
class NotifyTemplateEntry < TemplateEntry
##
# Creates a new NotifyTemplateEntry that watches +place+ for +event+s that
# match +tuple+.
def initialize(place, event, tuple, expires=nil)
ary = [event, Rinda::Template.new(tuple)]
super(ary, expires)
@queue = Thread::Queue.new
@done = false
end
##
# Called by TupleSpace to notify this NotifyTemplateEntry of a new event.
def notify(ev)
@queue.push(ev)
end
##
# Retrieves a notification. Raises RequestExpiredError when this
# NotifyTemplateEntry expires.
def pop
raise RequestExpiredError if @done
it = @queue.pop
@done = true if it[0] == 'close'
return it
end
##
# Yields event/tuple pairs until this NotifyTemplateEntry expires.
def each # :yields: event, tuple
while !@done
it = pop
yield(it)
end
rescue
ensure
cancel
end
end
##
# TupleBag is an unordered collection of tuples. It is the basis
# of Tuplespace.
class TupleBag
class TupleBin
extend Forwardable
def_delegators '@bin', :find_all, :delete_if, :each, :empty?
def initialize
@bin = []
end
def add(tuple)
@bin.push(tuple)
end
def delete(tuple)
idx = @bin.rindex(tuple)
@bin.delete_at(idx) if idx
end
def find
@bin.reverse_each do |x|
return x if yield(x)
end
nil
end
end
def initialize # :nodoc:
@hash = {}
@enum = enum_for(:each_entry)
end
##
# +true+ if the TupleBag to see if it has any expired entries.
def has_expires?
@enum.find do |tuple|
tuple.expires
end
end
##
# Add +tuple+ to the TupleBag.
def push(tuple)
key = bin_key(tuple)
@hash[key] ||= TupleBin.new
@hash[key].add(tuple)
end
##
# Removes +tuple+ from the TupleBag.
def delete(tuple)
key = bin_key(tuple)
bin = @hash[key]
return nil unless bin
bin.delete(tuple)
@hash.delete(key) if bin.empty?
tuple
end
##
# Finds all live tuples that match +template+.
def find_all(template)
bin_for_find(template).find_all do |tuple|
tuple.alive? && template.match(tuple)
end
end
##
# Finds a live tuple that matches +template+.
def find(template)
bin_for_find(template).find do |tuple|
tuple.alive? && template.match(tuple)
end
end
##
# Finds all tuples in the TupleBag which when treated as templates, match
# +tuple+ and are alive.
def find_all_template(tuple)
@enum.find_all do |template|
template.alive? && template.match(tuple)
end
end
##
# Delete tuples which dead tuples from the TupleBag, returning the deleted
# tuples.
def delete_unless_alive
deleted = []
@hash.each do |key, bin|
bin.delete_if do |tuple|
if tuple.alive?
false
else
deleted.push(tuple)
true
end
end
end
deleted
end
private
def each_entry(&blk)
@hash.each do |k, v|
v.each(&blk)
end
end
def bin_key(tuple)
head = tuple[0]
if head.class == Symbol
return head
else
false
end
end
def bin_for_find(template)
key = bin_key(template)
key ? @hash.fetch(key, []) : @enum
end
end
##
# The Tuplespace manages access to the tuples it contains,
# ensuring mutual exclusion requirements are met.
#
# The +sec+ option for the write, take, move, read and notify methods may
# either be a number of seconds or a Renewer object.
class TupleSpace
include DRbUndumped
include MonitorMixin
##
# Creates a new TupleSpace. +period+ is used to control how often to look
# for dead tuples after modifications to the TupleSpace.
#
# If no dead tuples are found +period+ seconds after the last
# modification, the TupleSpace will stop looking for dead tuples.
def initialize(period=60)
super()
@bag = TupleBag.new
@read_waiter = TupleBag.new
@take_waiter = TupleBag.new
@notify_waiter = TupleBag.new
@period = period
@keeper = nil
end
##
# Adds +tuple+
def write(tuple, sec=nil)
entry = create_entry(tuple, sec)
synchronize do
if entry.expired?
@read_waiter.find_all_template(entry).each do |template|
template.read(tuple)
end
notify_event('write', entry.value)
notify_event('delete', entry.value)
else
@bag.push(entry)
start_keeper if entry.expires
@read_waiter.find_all_template(entry).each do |template|
template.read(tuple)
end
@take_waiter.find_all_template(entry).each do |template|
template.signal
end
notify_event('write', entry.value)
end
end
entry
end
##
# Removes +tuple+
def take(tuple, sec=nil, &block)
move(nil, tuple, sec, &block)
end
##
# Moves +tuple+ to +port+.
def move(port, tuple, sec=nil)
template = WaitTemplateEntry.new(self, tuple, sec)
yield(template) if block_given?
synchronize do
entry = @bag.find(template)
if entry
port.push(entry.value) if port
@bag.delete(entry)
notify_event('take', entry.value)
return port ? nil : entry.value
end
raise RequestExpiredError if template.expired?
begin
@take_waiter.push(template)
start_keeper if template.expires
while true
raise RequestCanceledError if template.canceled?
raise RequestExpiredError if template.expired?
entry = @bag.find(template)
if entry
port.push(entry.value) if port
@bag.delete(entry)
notify_event('take', entry.value)
return port ? nil : entry.value
end
template.wait
end
ensure
@take_waiter.delete(template)
end
end
end
##
# Reads +tuple+, but does not remove it.
def read(tuple, sec=nil)
template = WaitTemplateEntry.new(self, tuple, sec)
yield(template) if block_given?
synchronize do
entry = @bag.find(template)
return entry.value if entry
raise RequestExpiredError if template.expired?
begin
@read_waiter.push(template)
start_keeper if template.expires
template.wait
raise RequestCanceledError if template.canceled?
raise RequestExpiredError if template.expired?
return template.found
ensure
@read_waiter.delete(template)
end
end
end
##
# Returns all tuples matching +tuple+. Does not remove the found tuples.
def read_all(tuple)
template = WaitTemplateEntry.new(self, tuple, nil)
synchronize do
entry = @bag.find_all(template)
entry.collect do |e|
e.value
end
end
end
##
# Registers for notifications of +event+. Returns a NotifyTemplateEntry.
# See NotifyTemplateEntry for examples of how to listen for notifications.
#
# +event+ can be:
# 'write':: A tuple was added
# 'take':: A tuple was taken or moved
# 'delete':: A tuple was lost after being overwritten or expiring
#
# The TupleSpace will also notify you of the 'close' event when the
# NotifyTemplateEntry has expired.
def notify(event, tuple, sec=nil)
template = NotifyTemplateEntry.new(self, event, tuple, sec)
synchronize do
@notify_waiter.push(template)
end
template
end
private
def create_entry(tuple, sec)
TupleEntry.new(tuple, sec)
end
##
# Removes dead tuples.
def keep_clean
synchronize do
@read_waiter.delete_unless_alive.each do |e|
e.signal
end
@take_waiter.delete_unless_alive.each do |e|
e.signal
end
@notify_waiter.delete_unless_alive.each do |e|
e.notify(['close'])
end
@bag.delete_unless_alive.each do |e|
notify_event('delete', e.value)
end
end
end
##
# Notifies all registered listeners for +event+ of a status change of
# +tuple+.
def notify_event(event, tuple)
ev = [event, tuple]
@notify_waiter.find_all_template(ev).each do |template|
template.notify(ev)
end
end
##
# Creates a thread that scans the tuplespace for expired tuples.
def start_keeper
return if @keeper && @keeper.alive?
@keeper = Thread.new do
while true
sleep(@period)
synchronize do
break unless need_keeper?
keep_clean
end
end
end
end
##
# Checks the tuplespace to see if it needs cleaning.
def need_keeper?
return true if @bag.has_expires?
return true if @read_waiter.has_expires?
return true if @take_waiter.has_expires?
return true if @notify_waiter.has_expires?
end
end
end
share/ruby/rinda/rinda.rb 0000644 00000015150 15173517737 0011370 0 ustar 00 # frozen_string_literal: false
require 'drb/drb'
##
# A module to implement the Linda distributed computing paradigm in Ruby.
#
# Rinda is part of DRb (dRuby).
#
# == Example(s)
#
# See the sample/drb/ directory in the Ruby distribution, from 1.8.2 onwards.
#
#--
# TODO
# == Introduction to Linda/rinda?
#
# == Why is this library separate from DRb?
module Rinda
VERSION = "0.2.0"
##
# Rinda error base class
class RindaError < RuntimeError; end
##
# Raised when a hash-based tuple has an invalid key.
class InvalidHashTupleKey < RindaError; end
##
# Raised when trying to use a canceled tuple.
class RequestCanceledError < ThreadError; end
##
# Raised when trying to use an expired tuple.
class RequestExpiredError < ThreadError; end
##
# A tuple is the elementary object in Rinda programming.
# Tuples may be matched against templates if the tuple and
# the template are the same size.
class Tuple
##
# Creates a new Tuple from +ary_or_hash+ which must be an Array or Hash.
def initialize(ary_or_hash)
if hash?(ary_or_hash)
init_with_hash(ary_or_hash)
else
init_with_ary(ary_or_hash)
end
end
##
# The number of elements in the tuple.
def size
@tuple.size
end
##
# Accessor method for elements of the tuple.
def [](k)
@tuple[k]
end
##
# Fetches item +k+ from the tuple.
def fetch(k)
@tuple.fetch(k)
end
##
# Iterate through the tuple, yielding the index or key, and the
# value, thus ensuring arrays are iterated similarly to hashes.
def each # FIXME
if Hash === @tuple
@tuple.each { |k, v| yield(k, v) }
else
@tuple.each_with_index { |v, k| yield(k, v) }
end
end
##
# Return the tuple itself
def value
@tuple
end
private
def hash?(ary_or_hash)
ary_or_hash.respond_to?(:keys)
end
##
# Munges +ary+ into a valid Tuple.
def init_with_ary(ary)
@tuple = Array.new(ary.size)
@tuple.size.times do |i|
@tuple[i] = ary[i]
end
end
##
# Ensures +hash+ is a valid Tuple.
def init_with_hash(hash)
@tuple = Hash.new
hash.each do |k, v|
raise InvalidHashTupleKey unless String === k
@tuple[k] = v
end
end
end
##
# Templates are used to match tuples in Rinda.
class Template < Tuple
##
# Matches this template against +tuple+. The +tuple+ must be the same
# size as the template. An element with a +nil+ value in a template acts
# as a wildcard, matching any value in the corresponding position in the
# tuple. Elements of the template match the +tuple+ if the are #== or
# #===.
#
# Template.new([:foo, 5]).match Tuple.new([:foo, 5]) # => true
# Template.new([:foo, nil]).match Tuple.new([:foo, 5]) # => true
# Template.new([String]).match Tuple.new(['hello']) # => true
#
# Template.new([:foo]).match Tuple.new([:foo, 5]) # => false
# Template.new([:foo, 6]).match Tuple.new([:foo, 5]) # => false
# Template.new([:foo, nil]).match Tuple.new([:foo]) # => false
# Template.new([:foo, 6]).match Tuple.new([:foo]) # => false
def match(tuple)
return false unless tuple.respond_to?(:size)
return false unless tuple.respond_to?(:fetch)
return false unless self.size == tuple.size
each do |k, v|
begin
it = tuple.fetch(k)
rescue
return false
end
next if v.nil?
next if v == it
next if v === it
return false
end
return true
end
##
# Alias for #match.
def ===(tuple)
match(tuple)
end
end
##
# <i>Documentation?</i>
class DRbObjectTemplate
##
# Creates a new DRbObjectTemplate that will match against +uri+ and +ref+.
def initialize(uri=nil, ref=nil)
@drb_uri = uri
@drb_ref = ref
end
##
# This DRbObjectTemplate matches +ro+ if the remote object's drburi and
# drbref are the same. +nil+ is used as a wildcard.
def ===(ro)
return true if super(ro)
unless @drb_uri.nil?
return false unless (@drb_uri === ro.__drburi rescue false)
end
unless @drb_ref.nil?
return false unless (@drb_ref === ro.__drbref rescue false)
end
true
end
end
##
# TupleSpaceProxy allows a remote Tuplespace to appear as local.
class TupleSpaceProxy
##
# A Port ensures that a moved tuple arrives properly at its destination
# and does not get lost.
#
# See https://bugs.ruby-lang.org/issues/8125
class Port # :nodoc:
attr_reader :value
def self.deliver
port = new
begin
yield(port)
ensure
port.close
end
port.value
end
def initialize
@open = true
@value = nil
end
##
# Don't let the DRb thread push to it when remote sends tuple
def close
@open = false
end
##
# Stores +value+ and ensure it does not get marshaled multiple times.
def push value
raise 'port closed' unless @open
@value = value
nil # avoid Marshal
end
end
##
# Creates a new TupleSpaceProxy to wrap +ts+.
def initialize(ts)
@ts = ts
end
##
# Adds +tuple+ to the proxied TupleSpace. See TupleSpace#write.
def write(tuple, sec=nil)
@ts.write(tuple, sec)
end
##
# Takes +tuple+ from the proxied TupleSpace. See TupleSpace#take.
def take(tuple, sec=nil, &block)
Port.deliver do |port|
@ts.move(DRbObject.new(port), tuple, sec, &block)
end
end
##
# Reads +tuple+ from the proxied TupleSpace. See TupleSpace#read.
def read(tuple, sec=nil, &block)
@ts.read(tuple, sec, &block)
end
##
# Reads all tuples matching +tuple+ from the proxied TupleSpace. See
# TupleSpace#read_all.
def read_all(tuple)
@ts.read_all(tuple)
end
##
# Registers for notifications of event +ev+ on the proxied TupleSpace.
# See TupleSpace#notify
def notify(ev, tuple, sec=nil)
@ts.notify(ev, tuple, sec)
end
end
##
# An SimpleRenewer allows a TupleSpace to check if a TupleEntry is still
# alive.
class SimpleRenewer
include DRbUndumped
##
# Creates a new SimpleRenewer that keeps an object alive for another +sec+
# seconds.
def initialize(sec=180)
@sec = sec
end
##
# Called by the TupleSpace to check if the object is still alive.
def renew
@sec
end
end
end
share/ruby/uri/generic.rb 0000644 00000111744 15173517737 0011417 0 ustar 00 # frozen_string_literal: true
# = uri/generic.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'common'
autoload :IPSocket, 'socket'
autoload :IPAddr, 'ipaddr'
module URI
#
# Base class for all URI classes.
# Implements generic URI syntax as per RFC 2396.
#
class Generic
include URI
#
# A Default port of nil for URI::Generic.
#
DEFAULT_PORT = nil
#
# Returns default port.
#
def self.default_port
self::DEFAULT_PORT
end
#
# Returns default port.
#
def default_port
self.class.default_port
end
#
# An Array of the available components for URI::Generic.
#
COMPONENT = [
:scheme,
:userinfo, :host, :port, :registry,
:path, :opaque,
:query,
:fragment
].freeze
#
# Components of the URI in the order.
#
def self.component
self::COMPONENT
end
USE_REGISTRY = false # :nodoc:
def self.use_registry # :nodoc:
self::USE_REGISTRY
end
#
# == Synopsis
#
# See ::new.
#
# == Description
#
# At first, tries to create a new URI::Generic instance using
# URI::Generic::build. But, if exception URI::InvalidComponentError is raised,
# then it does URI::Escape.escape all URI components and tries again.
#
def self.build2(args)
begin
return self.build(args)
rescue InvalidComponentError
if args.kind_of?(Array)
return self.build(args.collect{|x|
if x.is_a?(String)
DEFAULT_PARSER.escape(x)
else
x
end
})
elsif args.kind_of?(Hash)
tmp = {}
args.each do |key, value|
tmp[key] = if value
DEFAULT_PARSER.escape(value)
else
value
end
end
return self.build(tmp)
end
end
end
#
# == Synopsis
#
# See ::new.
#
# == Description
#
# Creates a new URI::Generic instance from components of URI::Generic
# with check. Components are: scheme, userinfo, host, port, registry, path,
# opaque, query, and fragment. You can provide arguments either by an Array or a Hash.
# See ::new for hash keys to use or for order of array items.
#
def self.build(args)
if args.kind_of?(Array) &&
args.size == ::URI::Generic::COMPONENT.size
tmp = args.dup
elsif args.kind_of?(Hash)
tmp = ::URI::Generic::COMPONENT.collect do |c|
if args.include?(c)
args[c]
else
nil
end
end
else
component = self.class.component rescue ::URI::Generic::COMPONENT
raise ArgumentError,
"expected Array of or Hash of components of #{self.class} (#{component.join(', ')})"
end
tmp << nil
tmp << true
return self.new(*tmp)
end
#
# == Args
#
# +scheme+::
# Protocol scheme, i.e. 'http','ftp','mailto' and so on.
# +userinfo+::
# User name and password, i.e. 'sdmitry:bla'.
# +host+::
# Server host name.
# +port+::
# Server port.
# +registry+::
# Registry of naming authorities.
# +path+::
# Path on server.
# +opaque+::
# Opaque part.
# +query+::
# Query data.
# +fragment+::
# Part of the URI after '#' character.
# +parser+::
# Parser for internal use [URI::DEFAULT_PARSER by default].
# +arg_check+::
# Check arguments [false by default].
#
# == Description
#
# Creates a new URI::Generic instance from ``generic'' components without check.
#
def initialize(scheme,
userinfo, host, port, registry,
path, opaque,
query,
fragment,
parser = DEFAULT_PARSER,
arg_check = false)
@scheme = nil
@user = nil
@password = nil
@host = nil
@port = nil
@path = nil
@query = nil
@opaque = nil
@fragment = nil
@parser = parser == DEFAULT_PARSER ? nil : parser
if arg_check
self.scheme = scheme
self.userinfo = userinfo
self.hostname = host
self.port = port
self.path = path
self.query = query
self.opaque = opaque
self.fragment = fragment
else
self.set_scheme(scheme)
self.set_userinfo(userinfo)
self.set_host(host)
self.set_port(port)
self.set_path(path)
self.query = query
self.set_opaque(opaque)
self.fragment=(fragment)
end
if registry
raise InvalidURIError,
"the scheme #{@scheme} does not accept registry part: #{registry} (or bad hostname?)"
end
@scheme&.freeze
self.set_path('') if !@path && !@opaque # (see RFC2396 Section 5.2)
self.set_port(self.default_port) if self.default_port && !@port
end
#
# Returns the scheme component of the URI.
#
# URI("http://foo/bar/baz").scheme #=> "http"
#
attr_reader :scheme
# Returns the host component of the URI.
#
# URI("http://foo/bar/baz").host #=> "foo"
#
# It returns nil if no host component exists.
#
# URI("mailto:foo@example.org").host #=> nil
#
# The component does not contain the port number.
#
# URI("http://foo:8080/bar/baz").host #=> "foo"
#
# Since IPv6 addresses are wrapped with brackets in URIs,
# this method returns IPv6 addresses wrapped with brackets.
# This form is not appropriate to pass to socket methods such as TCPSocket.open.
# If unwrapped host names are required, use the #hostname method.
#
# URI("http://[::1]/bar/baz").host #=> "[::1]"
# URI("http://[::1]/bar/baz").hostname #=> "::1"
#
attr_reader :host
# Returns the port component of the URI.
#
# URI("http://foo/bar/baz").port #=> 80
# URI("http://foo:8080/bar/baz").port #=> 8080
#
attr_reader :port
def registry # :nodoc:
nil
end
# Returns the path component of the URI.
#
# URI("http://foo/bar/baz").path #=> "/bar/baz"
#
attr_reader :path
# Returns the query component of the URI.
#
# URI("http://foo/bar/baz?search=FooBar").query #=> "search=FooBar"
#
attr_reader :query
# Returns the opaque part of the URI.
#
# URI("mailto:foo@example.org").opaque #=> "foo@example.org"
# URI("http://foo/bar/baz").opaque #=> nil
#
# The portion of the path that does not make use of the slash '/'.
# The path typically refers to an absolute path or an opaque part.
# (See RFC2396 Section 3 and 5.2.)
#
attr_reader :opaque
# Returns the fragment component of the URI.
#
# URI("http://foo/bar/baz?search=FooBar#ponies").fragment #=> "ponies"
#
attr_reader :fragment
# Returns the parser to be used.
#
# Unless a URI::Parser is defined, DEFAULT_PARSER is used.
#
def parser
if !defined?(@parser) || !@parser
DEFAULT_PARSER
else
@parser || DEFAULT_PARSER
end
end
# Replaces self by other URI object.
#
def replace!(oth)
if self.class != oth.class
raise ArgumentError, "expected #{self.class} object"
end
component.each do |c|
self.__send__("#{c}=", oth.__send__(c))
end
end
private :replace!
#
# Components of the URI in the order.
#
def component
self.class.component
end
#
# Checks the scheme +v+ component against the URI::Parser Regexp for :SCHEME.
#
def check_scheme(v)
if v && parser.regexp[:SCHEME] !~ v
raise InvalidComponentError,
"bad component(expected scheme component): #{v}"
end
return true
end
private :check_scheme
# Protected setter for the scheme component +v+.
#
# See also URI::Generic.scheme=.
#
def set_scheme(v)
@scheme = v&.downcase
end
protected :set_scheme
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the scheme component +v+
# (with validation).
#
# See also URI::Generic.check_scheme.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com")
# uri.scheme = "https"
# uri.to_s #=> "https://my.example.com"
#
def scheme=(v)
check_scheme(v)
set_scheme(v)
v
end
#
# Checks the +user+ and +password+.
#
# If +password+ is not provided, then +user+ is
# split, using URI::Generic.split_userinfo, to
# pull +user+ and +password.
#
# See also URI::Generic.check_user, URI::Generic.check_password.
#
def check_userinfo(user, password = nil)
if !password
user, password = split_userinfo(user)
end
check_user(user)
check_password(password, user)
return true
end
private :check_userinfo
#
# Checks the user +v+ component for RFC2396 compliance
# and against the URI::Parser Regexp for :USERINFO.
#
# Can not have a registry or opaque component defined,
# with a user component defined.
#
def check_user(v)
if @opaque
raise InvalidURIError,
"can not set user with opaque"
end
return v unless v
if parser.regexp[:USERINFO] !~ v
raise InvalidComponentError,
"bad component(expected userinfo component or user component): #{v}"
end
return true
end
private :check_user
#
# Checks the password +v+ component for RFC2396 compliance
# and against the URI::Parser Regexp for :USERINFO.
#
# Can not have a registry or opaque component defined,
# with a user component defined.
#
def check_password(v, user = @user)
if @opaque
raise InvalidURIError,
"can not set password with opaque"
end
return v unless v
if !user
raise InvalidURIError,
"password component depends user component"
end
if parser.regexp[:USERINFO] !~ v
raise InvalidComponentError,
"bad password component"
end
return true
end
private :check_password
#
# Sets userinfo, argument is string like 'name:pass'.
#
def userinfo=(userinfo)
if userinfo.nil?
return nil
end
check_userinfo(*userinfo)
set_userinfo(*userinfo)
# returns userinfo
end
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the +user+ component
# (with validation).
#
# See also URI::Generic.check_user.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://john:S3nsit1ve@my.example.com")
# uri.user = "sam"
# uri.to_s #=> "http://sam:V3ry_S3nsit1ve@my.example.com"
#
def user=(user)
check_user(user)
set_user(user)
# returns user
end
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the +password+ component
# (with validation).
#
# See also URI::Generic.check_password.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://john:S3nsit1ve@my.example.com")
# uri.password = "V3ry_S3nsit1ve"
# uri.to_s #=> "http://john:V3ry_S3nsit1ve@my.example.com"
#
def password=(password)
check_password(password)
set_password(password)
# returns password
end
# Protected setter for the +user+ component, and +password+ if available
# (with validation).
#
# See also URI::Generic.userinfo=.
#
def set_userinfo(user, password = nil)
unless password
user, password = split_userinfo(user)
end
@user = user
@password = password if password
[@user, @password]
end
protected :set_userinfo
# Protected setter for the user component +v+.
#
# See also URI::Generic.user=.
#
def set_user(v)
set_userinfo(v, @password)
v
end
protected :set_user
# Protected setter for the password component +v+.
#
# See also URI::Generic.password=.
#
def set_password(v)
@password = v
# returns v
end
protected :set_password
# Returns the userinfo +ui+ as <code>[user, password]</code>
# if properly formatted as 'user:password'.
def split_userinfo(ui)
return nil, nil unless ui
user, password = ui.split(':', 2)
return user, password
end
private :split_userinfo
# Escapes 'user:password' +v+ based on RFC 1738 section 3.1.
def escape_userpass(v)
parser.escape(v, /[@:\/]/o) # RFC 1738 section 3.1 #/
end
private :escape_userpass
# Returns the userinfo, either as 'user' or 'user:password'.
def userinfo
if @user.nil?
nil
elsif @password.nil?
@user
else
@user + ':' + @password
end
end
# Returns the user component (without URI decoding).
def user
@user
end
# Returns the password component (without URI decoding).
def password
@password
end
# Returns the user component after URI decoding.
def decoded_user
URI.decode_uri_component(@user) if @user
end
# Returns the password component after URI decoding.
def decoded_password
URI.decode_uri_component(@password) if @password
end
#
# Checks the host +v+ component for RFC2396 compliance
# and against the URI::Parser Regexp for :HOST.
#
# Can not have a registry or opaque component defined,
# with a host component defined.
#
def check_host(v)
return v unless v
if @opaque
raise InvalidURIError,
"can not set host with registry or opaque"
elsif parser.regexp[:HOST] !~ v
raise InvalidComponentError,
"bad component(expected host component): #{v}"
end
return true
end
private :check_host
# Protected setter for the host component +v+.
#
# See also URI::Generic.host=.
#
def set_host(v)
@host = v
end
protected :set_host
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the host component +v+
# (with validation).
#
# See also URI::Generic.check_host.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com")
# uri.host = "foo.com"
# uri.to_s #=> "http://foo.com"
#
def host=(v)
check_host(v)
set_host(v)
v
end
# Extract the host part of the URI and unwrap brackets for IPv6 addresses.
#
# This method is the same as URI::Generic#host except
# brackets for IPv6 (and future IP) addresses are removed.
#
# uri = URI("http://[::1]/bar")
# uri.hostname #=> "::1"
# uri.host #=> "[::1]"
#
def hostname
v = self.host
v&.start_with?('[') && v.end_with?(']') ? v[1..-2] : v
end
# Sets the host part of the URI as the argument with brackets for IPv6 addresses.
#
# This method is the same as URI::Generic#host= except
# the argument can be a bare IPv6 address.
#
# uri = URI("http://foo/bar")
# uri.hostname = "::1"
# uri.to_s #=> "http://[::1]/bar"
#
# If the argument seems to be an IPv6 address,
# it is wrapped with brackets.
#
def hostname=(v)
v = "[#{v}]" if !(v&.start_with?('[') && v&.end_with?(']')) && v&.index(':')
self.host = v
end
#
# Checks the port +v+ component for RFC2396 compliance
# and against the URI::Parser Regexp for :PORT.
#
# Can not have a registry or opaque component defined,
# with a port component defined.
#
def check_port(v)
return v unless v
if @opaque
raise InvalidURIError,
"can not set port with registry or opaque"
elsif !v.kind_of?(Integer) && parser.regexp[:PORT] !~ v
raise InvalidComponentError,
"bad component(expected port component): #{v.inspect}"
end
return true
end
private :check_port
# Protected setter for the port component +v+.
#
# See also URI::Generic.port=.
#
def set_port(v)
v = v.empty? ? nil : v.to_i unless !v || v.kind_of?(Integer)
@port = v
end
protected :set_port
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the port component +v+
# (with validation).
#
# See also URI::Generic.check_port.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com")
# uri.port = 8080
# uri.to_s #=> "http://my.example.com:8080"
#
def port=(v)
check_port(v)
set_port(v)
port
end
def check_registry(v) # :nodoc:
raise InvalidURIError, "can not set registry"
end
private :check_registry
def set_registry(v) #:nodoc:
raise InvalidURIError, "can not set registry"
end
protected :set_registry
def registry=(v)
raise InvalidURIError, "can not set registry"
end
#
# Checks the path +v+ component for RFC2396 compliance
# and against the URI::Parser Regexp
# for :ABS_PATH and :REL_PATH.
#
# Can not have a opaque component defined,
# with a path component defined.
#
def check_path(v)
# raise if both hier and opaque are not nil, because:
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if v && @opaque
raise InvalidURIError,
"path conflicts with opaque"
end
# If scheme is ftp, path may be relative.
# See RFC 1738 section 3.2.2, and RFC 2396.
if @scheme && @scheme != "ftp"
if v && v != '' && parser.regexp[:ABS_PATH] !~ v
raise InvalidComponentError,
"bad component(expected absolute path component): #{v}"
end
else
if v && v != '' && parser.regexp[:ABS_PATH] !~ v &&
parser.regexp[:REL_PATH] !~ v
raise InvalidComponentError,
"bad component(expected relative path component): #{v}"
end
end
return true
end
private :check_path
# Protected setter for the path component +v+.
#
# See also URI::Generic.path=.
#
def set_path(v)
@path = v
end
protected :set_path
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the path component +v+
# (with validation).
#
# See also URI::Generic.check_path.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com/pub/files")
# uri.path = "/faq/"
# uri.to_s #=> "http://my.example.com/faq/"
#
def path=(v)
check_path(v)
set_path(v)
v
end
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the query component +v+.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com/?id=25")
# uri.query = "id=1"
# uri.to_s #=> "http://my.example.com/?id=1"
#
def query=(v)
return @query = nil unless v
raise InvalidURIError, "query conflicts with opaque" if @opaque
x = v.to_str
v = x.dup if x.equal? v
v.encode!(Encoding::UTF_8) rescue nil
v.delete!("\t\r\n")
v.force_encoding(Encoding::ASCII_8BIT)
raise InvalidURIError, "invalid percent escape: #{$1}" if /(%\H\H)/n.match(v)
v.gsub!(/(?!%\h\h|[!$-&(-;=?-_a-~])./n.freeze){'%%%02X' % $&.ord}
v.force_encoding(Encoding::US_ASCII)
@query = v
end
#
# Checks the opaque +v+ component for RFC2396 compliance and
# against the URI::Parser Regexp for :OPAQUE.
#
# Can not have a host, port, user, or path component defined,
# with an opaque component defined.
#
def check_opaque(v)
return v unless v
# raise if both hier and opaque are not nil, because:
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if @host || @port || @user || @path # userinfo = @user + ':' + @password
raise InvalidURIError,
"can not set opaque with host, port, userinfo or path"
elsif v && parser.regexp[:OPAQUE] !~ v
raise InvalidComponentError,
"bad component(expected opaque component): #{v}"
end
return true
end
private :check_opaque
# Protected setter for the opaque component +v+.
#
# See also URI::Generic.opaque=.
#
def set_opaque(v)
@opaque = v
end
protected :set_opaque
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the opaque component +v+
# (with validation).
#
# See also URI::Generic.check_opaque.
#
def opaque=(v)
check_opaque(v)
set_opaque(v)
v
end
#
# Checks the fragment +v+ component against the URI::Parser Regexp for :FRAGMENT.
#
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the fragment component +v+
# (with validation).
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com/?id=25#time=1305212049")
# uri.fragment = "time=1305212086"
# uri.to_s #=> "http://my.example.com/?id=25#time=1305212086"
#
def fragment=(v)
return @fragment = nil unless v
x = v.to_str
v = x.dup if x.equal? v
v.encode!(Encoding::UTF_8) rescue nil
v.delete!("\t\r\n")
v.force_encoding(Encoding::ASCII_8BIT)
v.gsub!(/(?!%\h\h|[!-~])./n){'%%%02X' % $&.ord}
v.force_encoding(Encoding::US_ASCII)
@fragment = v
end
#
# Returns true if URI is hierarchical.
#
# == Description
#
# URI has components listed in order of decreasing significance from left to right,
# see RFC3986 https://tools.ietf.org/html/rfc3986 1.2.3.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com/")
# uri.hierarchical?
# #=> true
# uri = URI.parse("mailto:joe@example.com")
# uri.hierarchical?
# #=> false
#
def hierarchical?
if @path
true
else
false
end
end
#
# Returns true if URI has a scheme (e.g. http:// or https://) specified.
#
def absolute?
if @scheme
true
else
false
end
end
alias absolute absolute?
#
# Returns true if URI does not have a scheme (e.g. http:// or https://) specified.
#
def relative?
!absolute?
end
#
# Returns an Array of the path split on '/'.
#
def split_path(path)
path.split("/", -1)
end
private :split_path
#
# Merges a base path +base+, with relative path +rel+,
# returns a modified base path.
#
def merge_path(base, rel)
# RFC2396, Section 5.2, 5)
# RFC2396, Section 5.2, 6)
base_path = split_path(base)
rel_path = split_path(rel)
# RFC2396, Section 5.2, 6), a)
base_path << '' if base_path.last == '..'
while i = base_path.index('..')
base_path.slice!(i - 1, 2)
end
if (first = rel_path.first) and first.empty?
base_path.clear
rel_path.shift
end
# RFC2396, Section 5.2, 6), c)
# RFC2396, Section 5.2, 6), d)
rel_path.push('') if rel_path.last == '.' || rel_path.last == '..'
rel_path.delete('.')
# RFC2396, Section 5.2, 6), e)
tmp = []
rel_path.each do |x|
if x == '..' &&
!(tmp.empty? || tmp.last == '..')
tmp.pop
else
tmp << x
end
end
add_trailer_slash = !tmp.empty?
if base_path.empty?
base_path = [''] # keep '/' for root directory
elsif add_trailer_slash
base_path.pop
end
while x = tmp.shift
if x == '..'
# RFC2396, Section 4
# a .. or . in an absolute path has no special meaning
base_path.pop if base_path.size > 1
else
# if x == '..'
# valid absolute (but abnormal) path "/../..."
# else
# valid absolute path
# end
base_path << x
tmp.each {|t| base_path << t}
add_trailer_slash = false
break
end
end
base_path.push('') if add_trailer_slash
return base_path.join('/')
end
private :merge_path
#
# == Args
#
# +oth+::
# URI or String
#
# == Description
#
# Destructive form of #merge.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com")
# uri.merge!("/main.rbx?page=1")
# uri.to_s # => "http://my.example.com/main.rbx?page=1"
#
def merge!(oth)
t = merge(oth)
if self == t
nil
else
replace!(t)
self
end
end
#
# == Args
#
# +oth+::
# URI or String
#
# == Description
#
# Merges two URIs.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com")
# uri.merge("/main.rbx?page=1")
# # => "http://my.example.com/main.rbx?page=1"
#
def merge(oth)
rel = parser.__send__(:convert_to_uri, oth)
if rel.absolute?
#raise BadURIError, "both URI are absolute" if absolute?
# hmm... should return oth for usability?
return rel
end
unless self.absolute?
raise BadURIError, "both URI are relative"
end
base = self.dup
authority = rel.userinfo || rel.host || rel.port
# RFC2396, Section 5.2, 2)
if (rel.path.nil? || rel.path.empty?) && !authority && !rel.query
base.fragment=(rel.fragment) if rel.fragment
return base
end
base.query = nil
base.fragment=(nil)
# RFC2396, Section 5.2, 4)
if authority
base.set_userinfo(rel.userinfo)
base.set_host(rel.host)
base.set_port(rel.port || base.default_port)
base.set_path(rel.path)
elsif base.path && rel.path
base.set_path(merge_path(base.path, rel.path))
end
# RFC2396, Section 5.2, 7)
base.query = rel.query if rel.query
base.fragment=(rel.fragment) if rel.fragment
return base
end # merge
alias + merge
# :stopdoc:
def route_from_path(src, dst)
case dst
when src
# RFC2396, Section 4.2
return ''
when %r{(?:\A|/)\.\.?(?:/|\z)}
# dst has abnormal absolute path,
# like "/./", "/../", "/x/../", ...
return dst.dup
end
src_path = src.scan(%r{[^/]*/})
dst_path = dst.scan(%r{[^/]*/?})
# discard same parts
while !dst_path.empty? && dst_path.first == src_path.first
src_path.shift
dst_path.shift
end
tmp = dst_path.join
# calculate
if src_path.empty?
if tmp.empty?
return './'
elsif dst_path.first.include?(':') # (see RFC2396 Section 5)
return './' + tmp
else
return tmp
end
end
return '../' * src_path.size + tmp
end
private :route_from_path
# :startdoc:
# :stopdoc:
def route_from0(oth)
oth = parser.__send__(:convert_to_uri, oth)
if self.relative?
raise BadURIError,
"relative URI: #{self}"
end
if oth.relative?
raise BadURIError,
"relative URI: #{oth}"
end
if self.scheme != oth.scheme
return self, self.dup
end
rel = URI::Generic.new(nil, # it is relative URI
self.userinfo, self.host, self.port,
nil, self.path, self.opaque,
self.query, self.fragment, parser)
if rel.userinfo != oth.userinfo ||
rel.host.to_s.downcase != oth.host.to_s.downcase ||
rel.port != oth.port
if self.userinfo.nil? && self.host.nil?
return self, self.dup
end
rel.set_port(nil) if rel.port == oth.default_port
return rel, rel
end
rel.set_userinfo(nil)
rel.set_host(nil)
rel.set_port(nil)
if rel.path && rel.path == oth.path
rel.set_path('')
rel.query = nil if rel.query == oth.query
return rel, rel
elsif rel.opaque && rel.opaque == oth.opaque
rel.set_opaque('')
rel.query = nil if rel.query == oth.query
return rel, rel
end
# you can modify `rel', but can not `oth'.
return oth, rel
end
private :route_from0
# :startdoc:
#
# == Args
#
# +oth+::
# URI or String
#
# == Description
#
# Calculates relative path from oth to self.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse('http://my.example.com/main.rbx?page=1')
# uri.route_from('http://my.example.com')
# #=> #<URI::Generic /main.rbx?page=1>
#
def route_from(oth)
# you can modify `rel', but can not `oth'.
begin
oth, rel = route_from0(oth)
rescue
raise $!.class, $!.message
end
if oth == rel
return rel
end
rel.set_path(route_from_path(oth.path, self.path))
if rel.path == './' && self.query
# "./?foo" -> "?foo"
rel.set_path('')
end
return rel
end
alias - route_from
#
# == Args
#
# +oth+::
# URI or String
#
# == Description
#
# Calculates relative path to oth from self.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse('http://my.example.com')
# uri.route_to('http://my.example.com/main.rbx?page=1')
# #=> #<URI::Generic /main.rbx?page=1>
#
def route_to(oth)
parser.__send__(:convert_to_uri, oth).route_from(self)
end
#
# Returns normalized URI.
#
# require 'uri'
#
# URI("HTTP://my.EXAMPLE.com").normalize
# #=> #<URI::HTTP http://my.example.com/>
#
# Normalization here means:
#
# * scheme and host are converted to lowercase,
# * an empty path component is set to "/".
#
def normalize
uri = dup
uri.normalize!
uri
end
#
# Destructive version of #normalize.
#
def normalize!
if path&.empty?
set_path('/')
end
if scheme && scheme != scheme.downcase
set_scheme(self.scheme.downcase)
end
if host && host != host.downcase
set_host(self.host.downcase)
end
end
#
# Constructs String from URI.
#
def to_s
str = ''.dup
if @scheme
str << @scheme
str << ':'
end
if @opaque
str << @opaque
else
if @host || %w[file postgres].include?(@scheme)
str << '//'
end
if self.userinfo
str << self.userinfo
str << '@'
end
if @host
str << @host
end
if @port && @port != self.default_port
str << ':'
str << @port.to_s
end
str << @path
if @query
str << '?'
str << @query
end
end
if @fragment
str << '#'
str << @fragment
end
str
end
alias to_str to_s
#
# Compares two URIs.
#
def ==(oth)
if self.class == oth.class
self.normalize.component_ary == oth.normalize.component_ary
else
false
end
end
def hash
self.component_ary.hash
end
def eql?(oth)
self.class == oth.class &&
parser == oth.parser &&
self.component_ary.eql?(oth.component_ary)
end
=begin
--- URI::Generic#===(oth)
=end
# def ===(oth)
# raise NotImplementedError
# end
=begin
=end
# Returns an Array of the components defined from the COMPONENT Array.
def component_ary
component.collect do |x|
self.__send__(x)
end
end
protected :component_ary
# == Args
#
# +components+::
# Multiple Symbol arguments defined in URI::HTTP.
#
# == Description
#
# Selects specified components from URI.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse('http://myuser:mypass@my.example.com/test.rbx')
# uri.select(:userinfo, :host, :path)
# # => ["myuser:mypass", "my.example.com", "/test.rbx"]
#
def select(*components)
components.collect do |c|
if component.include?(c)
self.__send__(c)
else
raise ArgumentError,
"expected of components of #{self.class} (#{self.class.component.join(', ')})"
end
end
end
def inspect
"#<#{self.class} #{self}>"
end
#
# == Args
#
# +v+::
# URI or String
#
# == Description
#
# Attempts to parse other URI +oth+,
# returns [parsed_oth, self].
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("http://my.example.com")
# uri.coerce("http://foo.com")
# #=> [#<URI::HTTP http://foo.com>, #<URI::HTTP http://my.example.com>]
#
def coerce(oth)
case oth
when String
oth = parser.parse(oth)
else
super
end
return oth, self
end
# Returns a proxy URI.
# The proxy URI is obtained from environment variables such as http_proxy,
# ftp_proxy, no_proxy, etc.
# If there is no proper proxy, nil is returned.
#
# If the optional parameter +env+ is specified, it is used instead of ENV.
#
# Note that capitalized variables (HTTP_PROXY, FTP_PROXY, NO_PROXY, etc.)
# are examined, too.
#
# But http_proxy and HTTP_PROXY is treated specially under CGI environment.
# It's because HTTP_PROXY may be set by Proxy: header.
# So HTTP_PROXY is not used.
# http_proxy is not used too if the variable is case insensitive.
# CGI_HTTP_PROXY can be used instead.
def find_proxy(env=ENV)
raise BadURIError, "relative URI: #{self}" if self.relative?
name = self.scheme.downcase + '_proxy'
proxy_uri = nil
if name == 'http_proxy' && env.include?('REQUEST_METHOD') # CGI?
# HTTP_PROXY conflicts with *_proxy for proxy settings and
# HTTP_* for header information in CGI.
# So it should be careful to use it.
pairs = env.reject {|k, v| /\Ahttp_proxy\z/i !~ k }
case pairs.length
when 0 # no proxy setting anyway.
proxy_uri = nil
when 1
k, _ = pairs.shift
if k == 'http_proxy' && env[k.upcase] == nil
# http_proxy is safe to use because ENV is case sensitive.
proxy_uri = env[name]
else
proxy_uri = nil
end
else # http_proxy is safe to use because ENV is case sensitive.
proxy_uri = env.to_hash[name]
end
if !proxy_uri
# Use CGI_HTTP_PROXY. cf. libwww-perl.
proxy_uri = env["CGI_#{name.upcase}"]
end
elsif name == 'http_proxy'
if RUBY_ENGINE == 'jruby' && p_addr = ENV_JAVA['http.proxyHost']
p_port = ENV_JAVA['http.proxyPort']
if p_user = ENV_JAVA['http.proxyUser']
p_pass = ENV_JAVA['http.proxyPass']
proxy_uri = "http://#{p_user}:#{p_pass}@#{p_addr}:#{p_port}"
else
proxy_uri = "http://#{p_addr}:#{p_port}"
end
else
unless proxy_uri = env[name]
if proxy_uri = env[name.upcase]
warn 'The environment variable HTTP_PROXY is discouraged. Use http_proxy.', uplevel: 1
end
end
end
else
proxy_uri = env[name] || env[name.upcase]
end
if proxy_uri.nil? || proxy_uri.empty?
return nil
end
if self.hostname
begin
addr = IPSocket.getaddress(self.hostname)
return nil if /\A127\.|\A::1\z/ =~ addr
rescue SocketError
end
end
name = 'no_proxy'
if no_proxy = env[name] || env[name.upcase]
return nil unless URI::Generic.use_proxy?(self.hostname, addr, self.port, no_proxy)
end
URI.parse(proxy_uri)
end
def self.use_proxy?(hostname, addr, port, no_proxy) # :nodoc:
hostname = hostname.downcase
dothostname = ".#{hostname}"
no_proxy.scan(/([^:,\s]+)(?::(\d+))?/) {|p_host, p_port|
if !p_port || port == p_port.to_i
if p_host.start_with?('.')
return false if hostname.end_with?(p_host.downcase)
else
return false if dothostname.end_with?(".#{p_host.downcase}")
end
if addr
begin
return false if IPAddr.new(p_host).include?(addr)
rescue IPAddr::InvalidAddressError
next
end
end
end
}
true
end
end
end
share/ruby/uri/wss.rb 0000644 00000001023 15173517737 0010603 0 ustar 00 # frozen_string_literal: false
# = uri/wss.rb
#
# Author:: Matt Muller <mamuller@amazon.com>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'ws'
module URI
# The default port for WSS URIs is 443, and the scheme is 'wss:' rather
# than 'ws:'. Other than that, WSS URIs are identical to WS URIs;
# see URI::WS.
class WSS < WS
# A Default port of 443 for URI::WSS
DEFAULT_PORT = 443
end
register_scheme 'WSS', WSS
end
share/ruby/uri/https.rb 0000644 00000001056 15173517737 0011137 0 ustar 00 # frozen_string_literal: false
# = uri/https.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'http'
module URI
# The default port for HTTPS URIs is 443, and the scheme is 'https:' rather
# than 'http:'. Other than that, HTTPS URIs are identical to HTTP URIs;
# see URI::HTTP.
class HTTPS < HTTP
# A Default port of 443 for URI::HTTPS
DEFAULT_PORT = 443
end
register_scheme 'HTTPS', HTTPS
end
share/ruby/uri/ftp.rb 0000644 00000016033 15173517737 0010567 0 ustar 00 # frozen_string_literal: false
# = uri/ftp.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'generic'
module URI
#
# FTP URI syntax is defined by RFC1738 section 3.2.
#
# This class will be redesigned because of difference of implementations;
# the structure of its path. draft-hoffman-ftp-uri-04 is a draft but it
# is a good summary about the de facto spec.
# http://tools.ietf.org/html/draft-hoffman-ftp-uri-04
#
class FTP < Generic
# A Default port of 21 for URI::FTP.
DEFAULT_PORT = 21
#
# An Array of the available components for URI::FTP.
#
COMPONENT = [
:scheme,
:userinfo, :host, :port,
:path, :typecode
].freeze
#
# Typecode is "a", "i", or "d".
#
# * "a" indicates a text file (the FTP command was ASCII)
# * "i" indicates a binary file (FTP command IMAGE)
# * "d" indicates the contents of a directory should be displayed
#
TYPECODE = ['a', 'i', 'd'].freeze
# Typecode prefix ";type=".
TYPECODE_PREFIX = ';type='.freeze
def self.new2(user, password, host, port, path,
typecode = nil, arg_check = true) # :nodoc:
# Do not use this method! Not tested. [Bug #7301]
# This methods remains just for compatibility,
# Keep it undocumented until the active maintainer is assigned.
typecode = nil if typecode.size == 0
if typecode && !TYPECODE.include?(typecode)
raise ArgumentError,
"bad typecode is specified: #{typecode}"
end
# do escape
self.new('ftp',
[user, password],
host, port, nil,
typecode ? path + TYPECODE_PREFIX + typecode : path,
nil, nil, nil, arg_check)
end
#
# == Description
#
# Creates a new URI::FTP object from components, with syntax checking.
#
# The components accepted are +userinfo+, +host+, +port+, +path+, and
# +typecode+.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[userinfo, host, port, path, typecode]</code>.
#
# If the path supplied is absolute, it will be escaped in order to
# make it absolute in the URI.
#
# Examples:
#
# require 'uri'
#
# uri1 = URI::FTP.build(['user:password', 'ftp.example.com', nil,
# '/path/file.zip', 'i'])
# uri1.to_s # => "ftp://user:password@ftp.example.com/%2Fpath/file.zip;type=i"
#
# uri2 = URI::FTP.build({:host => 'ftp.example.com',
# :path => 'ruby/src'})
# uri2.to_s # => "ftp://ftp.example.com/ruby/src"
#
def self.build(args)
# Fix the incoming path to be generic URL syntax
# FTP path -> URL path
# foo/bar /foo/bar
# /foo/bar /%2Ffoo/bar
#
if args.kind_of?(Array)
args[3] = '/' + args[3].sub(/^\//, '%2F')
else
args[:path] = '/' + args[:path].sub(/^\//, '%2F')
end
tmp = Util::make_components_hash(self, args)
if tmp[:typecode]
if tmp[:typecode].size == 1
tmp[:typecode] = TYPECODE_PREFIX + tmp[:typecode]
end
tmp[:path] << tmp[:typecode]
end
return super(tmp)
end
#
# == Description
#
# Creates a new URI::FTP object from generic URL components with no
# syntax checking.
#
# Unlike build(), this method does not escape the path component as
# required by RFC1738; instead it is treated as per RFC2396.
#
# Arguments are +scheme+, +userinfo+, +host+, +port+, +registry+, +path+,
# +opaque+, +query+, and +fragment+, in that order.
#
def initialize(scheme,
userinfo, host, port, registry,
path, opaque,
query,
fragment,
parser = nil,
arg_check = false)
raise InvalidURIError unless path
path = path.sub(/^\//,'')
path.sub!(/^%2F/,'/')
super(scheme, userinfo, host, port, registry, path, opaque,
query, fragment, parser, arg_check)
@typecode = nil
if tmp = @path.index(TYPECODE_PREFIX)
typecode = @path[tmp + TYPECODE_PREFIX.size..-1]
@path = @path[0..tmp - 1]
if arg_check
self.typecode = typecode
else
self.set_typecode(typecode)
end
end
end
# typecode accessor.
#
# See URI::FTP::COMPONENT.
attr_reader :typecode
# Validates typecode +v+,
# returns +true+ or +false+.
#
def check_typecode(v)
if TYPECODE.include?(v)
return true
else
raise InvalidComponentError,
"bad typecode(expected #{TYPECODE.join(', ')}): #{v}"
end
end
private :check_typecode
# Private setter for the typecode +v+.
#
# See also URI::FTP.typecode=.
#
def set_typecode(v)
@typecode = v
end
protected :set_typecode
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the typecode +v+
# (with validation).
#
# See also URI::FTP.check_typecode.
#
# == Usage
#
# require 'uri'
#
# uri = URI.parse("ftp://john@ftp.example.com/my_file.img")
# #=> #<URI::FTP ftp://john@ftp.example.com/my_file.img>
# uri.typecode = "i"
# uri
# #=> #<URI::FTP ftp://john@ftp.example.com/my_file.img;type=i>
#
def typecode=(typecode)
check_typecode(typecode)
set_typecode(typecode)
typecode
end
def merge(oth) # :nodoc:
tmp = super(oth)
if self != tmp
tmp.set_typecode(oth.typecode)
end
return tmp
end
# Returns the path from an FTP URI.
#
# RFC 1738 specifically states that the path for an FTP URI does not
# include the / which separates the URI path from the URI host. Example:
#
# <code>ftp://ftp.example.com/pub/ruby</code>
#
# The above URI indicates that the client should connect to
# ftp.example.com then cd to pub/ruby from the initial login directory.
#
# If you want to cd to an absolute directory, you must include an
# escaped / (%2F) in the path. Example:
#
# <code>ftp://ftp.example.com/%2Fpub/ruby</code>
#
# This method will then return "/pub/ruby".
#
def path
return @path.sub(/^\//,'').sub(/^%2F/,'/')
end
# Private setter for the path of the URI::FTP.
def set_path(v)
super("/" + v.sub(/^\//, "%2F"))
end
protected :set_path
# Returns a String representation of the URI::FTP.
def to_s
save_path = nil
if @typecode
save_path = @path
@path = @path + TYPECODE_PREFIX + @typecode
end
str = super
if @typecode
@path = save_path
end
return str
end
end
register_scheme 'FTP', FTP
end
share/ruby/uri/rfc3986_parser.rb 0000644 00000011630 15173517737 0012454 0 ustar 00 # frozen_string_literal: true
module URI
class RFC3986_Parser # :nodoc:
# URI defined in RFC3986
HOST = %r[
(?<IP-literal>\[(?:
(?<IPv6address>
(?:\h{1,4}:){6}
(?<ls32>\h{1,4}:\h{1,4}
| (?<IPv4address>(?<dec-octet>[1-9]\d|1\d{2}|2[0-4]\d|25[0-5]|\d)
\.\g<dec-octet>\.\g<dec-octet>\.\g<dec-octet>)
)
| ::(?:\h{1,4}:){5}\g<ls32>
| \h{1,4}?::(?:\h{1,4}:){4}\g<ls32>
| (?:(?:\h{1,4}:)?\h{1,4})?::(?:\h{1,4}:){3}\g<ls32>
| (?:(?:\h{1,4}:){,2}\h{1,4})?::(?:\h{1,4}:){2}\g<ls32>
| (?:(?:\h{1,4}:){,3}\h{1,4})?::\h{1,4}:\g<ls32>
| (?:(?:\h{1,4}:){,4}\h{1,4})?::\g<ls32>
| (?:(?:\h{1,4}:){,5}\h{1,4})?::\h{1,4}
| (?:(?:\h{1,4}:){,6}\h{1,4})?::
)
| (?<IPvFuture>v\h++\.[!$&-.0-9:;=A-Z_a-z~]++)
)\])
| \g<IPv4address>
| (?<reg-name>(?:%\h\h|[!$&-.0-9;=A-Z_a-z~])*+)
]x
USERINFO = /(?:%\h\h|[!$&-.0-9:;=A-Z_a-z~])*+/
SCHEME = %r[[A-Za-z][+\-.0-9A-Za-z]*+].source
SEG = %r[(?:%\h\h|[!$&-.0-9:;=@A-Z_a-z~/])].source
SEG_NC = %r[(?:%\h\h|[!$&-.0-9;=@A-Z_a-z~])].source
FRAGMENT = %r[(?:%\h\h|[!$&-.0-9:;=@A-Z_a-z~/?])*+].source
RFC3986_URI = %r[\A
(?<seg>#{SEG}){0}
(?<URI>
(?<scheme>#{SCHEME}):
(?<hier-part>//
(?<authority>
(?:(?<userinfo>#{USERINFO.source})@)?
(?<host>#{HOST.source.delete(" \n")})
(?::(?<port>\d*+))?
)
(?<path-abempty>(?:/\g<seg>*+)?)
| (?<path-absolute>/((?!/)\g<seg>++)?)
| (?<path-rootless>(?!/)\g<seg>++)
| (?<path-empty>)
)
(?:\?(?<query>[^\#]*+))?
(?:\#(?<fragment>#{FRAGMENT}))?
)\z]x
RFC3986_relative_ref = %r[\A
(?<seg>#{SEG}){0}
(?<relative-ref>
(?<relative-part>//
(?<authority>
(?:(?<userinfo>#{USERINFO.source})@)?
(?<host>#{HOST.source.delete(" \n")}(?<!/))?
(?::(?<port>\d*+))?
)
(?<path-abempty>(?:/\g<seg>*+)?)
| (?<path-absolute>/\g<seg>*+)
| (?<path-noscheme>#{SEG_NC}++(?:/\g<seg>*+)?)
| (?<path-empty>)
)
(?:\?(?<query>[^#]*+))?
(?:\#(?<fragment>#{FRAGMENT}))?
)\z]x
attr_reader :regexp
def initialize
@regexp = default_regexp.each_value(&:freeze).freeze
end
def split(uri) #:nodoc:
begin
uri = uri.to_str
rescue NoMethodError
raise InvalidURIError, "bad URI(is not URI?): #{uri.inspect}"
end
uri.ascii_only? or
raise InvalidURIError, "URI must be ascii only #{uri.dump}"
if m = RFC3986_URI.match(uri)
query = m["query"]
scheme = m["scheme"]
opaque = m["path-rootless"]
if opaque
opaque << "?#{query}" if query
[ scheme,
nil, # userinfo
nil, # host
nil, # port
nil, # registry
nil, # path
opaque,
nil, # query
m["fragment"]
]
else # normal
[ scheme,
m["userinfo"],
m["host"],
m["port"],
nil, # registry
(m["path-abempty"] ||
m["path-absolute"] ||
m["path-empty"]),
nil, # opaque
query,
m["fragment"]
]
end
elsif m = RFC3986_relative_ref.match(uri)
[ nil, # scheme
m["userinfo"],
m["host"],
m["port"],
nil, # registry,
(m["path-abempty"] ||
m["path-absolute"] ||
m["path-noscheme"] ||
m["path-empty"]),
nil, # opaque
m["query"],
m["fragment"]
]
else
raise InvalidURIError, "bad URI(is not URI?): #{uri.inspect}"
end
end
def parse(uri) # :nodoc:
URI.for(*self.split(uri), self)
end
def join(*uris) # :nodoc:
uris[0] = convert_to_uri(uris[0])
uris.inject :merge
end
@@to_s = Kernel.instance_method(:to_s)
if @@to_s.respond_to?(:bind_call)
def inspect
@@to_s.bind_call(self)
end
else
def inspect
@@to_s.bind(self).call
end
end
private
def default_regexp # :nodoc:
{
SCHEME: %r[\A#{SCHEME}\z]o,
USERINFO: %r[\A#{USERINFO}\z]o,
HOST: %r[\A#{HOST}\z]o,
ABS_PATH: %r[\A/#{SEG}*+\z]o,
REL_PATH: %r[\A(?!/)#{SEG}++\z]o,
QUERY: %r[\A(?:%\h\h|[!$&-.0-9:;=@A-Z_a-z~/?])*+\z],
FRAGMENT: %r[\A#{FRAGMENT}\z]o,
OPAQUE: %r[\A(?:[^/].*)?\z],
PORT: /\A[\x09\x0a\x0c\x0d ]*+\d*[\x09\x0a\x0c\x0d ]*\z/,
}
end
def convert_to_uri(uri)
if uri.is_a?(URI::Generic)
uri
elsif uri = String.try_convert(uri)
parse(uri)
else
raise ArgumentError,
"bad argument (expected URI object or URI string)"
end
end
end # class Parser
end # module URI
share/ruby/uri/rfc2396_parser.rb 0000644 00000042046 15173517737 0012453 0 ustar 00 # frozen_string_literal: false
#--
# = uri/common.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License::
# You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
module URI
#
# Includes URI::REGEXP::PATTERN
#
module RFC2396_REGEXP
#
# Patterns used to parse URI's
#
module PATTERN
# :stopdoc:
# RFC 2396 (URI Generic Syntax)
# RFC 2732 (IPv6 Literal Addresses in URL's)
# RFC 2373 (IPv6 Addressing Architecture)
# alpha = lowalpha | upalpha
ALPHA = "a-zA-Z"
# alphanum = alpha | digit
ALNUM = "#{ALPHA}\\d"
# hex = digit | "A" | "B" | "C" | "D" | "E" | "F" |
# "a" | "b" | "c" | "d" | "e" | "f"
HEX = "a-fA-F\\d"
# escaped = "%" hex hex
ESCAPED = "%[#{HEX}]{2}"
# mark = "-" | "_" | "." | "!" | "~" | "*" | "'" |
# "(" | ")"
# unreserved = alphanum | mark
UNRESERVED = "\\-_.!~*'()#{ALNUM}"
# reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
# "$" | ","
# reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
# "$" | "," | "[" | "]" (RFC 2732)
RESERVED = ";/?:@&=+$,\\[\\]"
# domainlabel = alphanum | alphanum *( alphanum | "-" ) alphanum
DOMLABEL = "(?:[#{ALNUM}](?:[-#{ALNUM}]*[#{ALNUM}])?)"
# toplabel = alpha | alpha *( alphanum | "-" ) alphanum
TOPLABEL = "(?:[#{ALPHA}](?:[-#{ALNUM}]*[#{ALNUM}])?)"
# hostname = *( domainlabel "." ) toplabel [ "." ]
HOSTNAME = "(?:#{DOMLABEL}\\.)*#{TOPLABEL}\\.?"
# :startdoc:
end # PATTERN
# :startdoc:
end # REGEXP
# Class that parses String's into URI's.
#
# It contains a Hash set of patterns and Regexp's that match and validate.
#
class RFC2396_Parser
include RFC2396_REGEXP
#
# == Synopsis
#
# URI::Parser.new([opts])
#
# == Args
#
# The constructor accepts a hash as options for parser.
# Keys of options are pattern names of URI components
# and values of options are pattern strings.
# The constructor generates set of regexps for parsing URIs.
#
# You can use the following keys:
#
# * :ESCAPED (URI::PATTERN::ESCAPED in default)
# * :UNRESERVED (URI::PATTERN::UNRESERVED in default)
# * :DOMLABEL (URI::PATTERN::DOMLABEL in default)
# * :TOPLABEL (URI::PATTERN::TOPLABEL in default)
# * :HOSTNAME (URI::PATTERN::HOSTNAME in default)
#
# == Examples
#
# p = URI::Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
# u = p.parse("http://example.jp/%uABCD") #=> #<URI::HTTP http://example.jp/%uABCD>
# URI.parse(u.to_s) #=> raises URI::InvalidURIError
#
# s = "http://example.com/ABCD"
# u1 = p.parse(s) #=> #<URI::HTTP http://example.com/ABCD>
# u2 = URI.parse(s) #=> #<URI::HTTP http://example.com/ABCD>
# u1 == u2 #=> true
# u1.eql?(u2) #=> false
#
def initialize(opts = {})
@pattern = initialize_pattern(opts)
@pattern.each_value(&:freeze)
@pattern.freeze
@regexp = initialize_regexp(@pattern)
@regexp.each_value(&:freeze)
@regexp.freeze
end
# The Hash of patterns.
#
# See also URI::Parser.initialize_pattern.
attr_reader :pattern
# The Hash of Regexp.
#
# See also URI::Parser.initialize_regexp.
attr_reader :regexp
# Returns a split URI against +regexp[:ABS_URI]+.
def split(uri)
case uri
when ''
# null uri
when @regexp[:ABS_URI]
scheme, opaque, userinfo, host, port,
registry, path, query, fragment = $~[1..-1]
# URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
# opaque_part = uric_no_slash *uric
# abs_path = "/" path_segments
# net_path = "//" authority [ abs_path ]
# authority = server | reg_name
# server = [ [ userinfo "@" ] hostport ]
if !scheme
raise InvalidURIError,
"bad URI(absolute but no scheme): #{uri}"
end
if !opaque && (!path && (!host && !registry))
raise InvalidURIError,
"bad URI(absolute but no path): #{uri}"
end
when @regexp[:REL_URI]
scheme = nil
opaque = nil
userinfo, host, port, registry,
rel_segment, abs_path, query, fragment = $~[1..-1]
if rel_segment && abs_path
path = rel_segment + abs_path
elsif rel_segment
path = rel_segment
elsif abs_path
path = abs_path
end
# URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
# relativeURI = ( net_path | abs_path | rel_path ) [ "?" query ]
# net_path = "//" authority [ abs_path ]
# abs_path = "/" path_segments
# rel_path = rel_segment [ abs_path ]
# authority = server | reg_name
# server = [ [ userinfo "@" ] hostport ]
else
raise InvalidURIError, "bad URI(is not URI?): #{uri}"
end
path = '' if !path && !opaque # (see RFC2396 Section 5.2)
ret = [
scheme,
userinfo, host, port, # X
registry, # X
path, # Y
opaque, # Y
query,
fragment
]
return ret
end
#
# == Args
#
# +uri+::
# String
#
# == Description
#
# Parses +uri+ and constructs either matching URI scheme object
# (File, FTP, HTTP, HTTPS, LDAP, LDAPS, or MailTo) or URI::Generic.
#
# == Usage
#
# p = URI::Parser.new
# p.parse("ldap://ldap.example.com/dc=example?user=john")
# #=> #<URI::LDAP ldap://ldap.example.com/dc=example?user=john>
#
def parse(uri)
URI.for(*self.split(uri), self)
end
#
# == Args
#
# +uris+::
# an Array of Strings
#
# == Description
#
# Attempts to parse and merge a set of URIs.
#
def join(*uris)
uris[0] = convert_to_uri(uris[0])
uris.inject :merge
end
#
# :call-seq:
# extract( str )
# extract( str, schemes )
# extract( str, schemes ) {|item| block }
#
# == Args
#
# +str+::
# String to search
# +schemes+::
# Patterns to apply to +str+
#
# == Description
#
# Attempts to parse and merge a set of URIs.
# If no +block+ given, then returns the result,
# else it calls +block+ for each element in result.
#
# See also URI::Parser.make_regexp.
#
def extract(str, schemes = nil)
if block_given?
str.scan(make_regexp(schemes)) { yield $& }
nil
else
result = []
str.scan(make_regexp(schemes)) { result.push $& }
result
end
end
# Returns Regexp that is default +self.regexp[:ABS_URI_REF]+,
# unless +schemes+ is provided. Then it is a Regexp.union with +self.pattern[:X_ABS_URI]+.
def make_regexp(schemes = nil)
unless schemes
@regexp[:ABS_URI_REF]
else
/(?=#{Regexp.union(*schemes)}:)#{@pattern[:X_ABS_URI]}/x
end
end
#
# :call-seq:
# escape( str )
# escape( str, unsafe )
#
# == Args
#
# +str+::
# String to make safe
# +unsafe+::
# Regexp to apply. Defaults to +self.regexp[:UNSAFE]+
#
# == Description
#
# Constructs a safe String from +str+, removing unsafe characters,
# replacing them with codes.
#
def escape(str, unsafe = @regexp[:UNSAFE])
unless unsafe.kind_of?(Regexp)
# perhaps unsafe is String object
unsafe = Regexp.new("[#{Regexp.quote(unsafe)}]", false)
end
str.gsub(unsafe) do
us = $&
tmp = ''
us.each_byte do |uc|
tmp << sprintf('%%%02X', uc)
end
tmp
end.force_encoding(Encoding::US_ASCII)
end
#
# :call-seq:
# unescape( str )
# unescape( str, escaped )
#
# == Args
#
# +str+::
# String to remove escapes from
# +escaped+::
# Regexp to apply. Defaults to +self.regexp[:ESCAPED]+
#
# == Description
#
# Removes escapes from +str+.
#
def unescape(str, escaped = @regexp[:ESCAPED])
enc = str.encoding
enc = Encoding::UTF_8 if enc == Encoding::US_ASCII
str.gsub(escaped) { [$&[1, 2]].pack('H2').force_encoding(enc) }
end
@@to_s = Kernel.instance_method(:to_s)
if @@to_s.respond_to?(:bind_call)
def inspect
@@to_s.bind_call(self)
end
else
def inspect
@@to_s.bind(self).call
end
end
private
# Constructs the default Hash of patterns.
def initialize_pattern(opts = {})
ret = {}
ret[:ESCAPED] = escaped = (opts.delete(:ESCAPED) || PATTERN::ESCAPED)
ret[:UNRESERVED] = unreserved = opts.delete(:UNRESERVED) || PATTERN::UNRESERVED
ret[:RESERVED] = reserved = opts.delete(:RESERVED) || PATTERN::RESERVED
ret[:DOMLABEL] = opts.delete(:DOMLABEL) || PATTERN::DOMLABEL
ret[:TOPLABEL] = opts.delete(:TOPLABEL) || PATTERN::TOPLABEL
ret[:HOSTNAME] = hostname = opts.delete(:HOSTNAME)
# RFC 2396 (URI Generic Syntax)
# RFC 2732 (IPv6 Literal Addresses in URL's)
# RFC 2373 (IPv6 Addressing Architecture)
# uric = reserved | unreserved | escaped
ret[:URIC] = uric = "(?:[#{unreserved}#{reserved}]|#{escaped})"
# uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" |
# "&" | "=" | "+" | "$" | ","
ret[:URIC_NO_SLASH] = uric_no_slash = "(?:[#{unreserved};?:@&=+$,]|#{escaped})"
# query = *uric
ret[:QUERY] = query = "#{uric}*"
# fragment = *uric
ret[:FRAGMENT] = fragment = "#{uric}*"
# hostname = *( domainlabel "." ) toplabel [ "." ]
# reg-name = *( unreserved / pct-encoded / sub-delims ) # RFC3986
unless hostname
ret[:HOSTNAME] = hostname = "(?:[a-zA-Z0-9\\-.]|%\\h\\h)+"
end
# RFC 2373, APPENDIX B:
# IPv6address = hexpart [ ":" IPv4address ]
# IPv4address = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT
# hexpart = hexseq | hexseq "::" [ hexseq ] | "::" [ hexseq ]
# hexseq = hex4 *( ":" hex4)
# hex4 = 1*4HEXDIG
#
# XXX: This definition has a flaw. "::" + IPv4address must be
# allowed too. Here is a replacement.
#
# IPv4address = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT
ret[:IPV4ADDR] = ipv4addr = "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"
# hex4 = 1*4HEXDIG
hex4 = "[#{PATTERN::HEX}]{1,4}"
# lastpart = hex4 | IPv4address
lastpart = "(?:#{hex4}|#{ipv4addr})"
# hexseq1 = *( hex4 ":" ) hex4
hexseq1 = "(?:#{hex4}:)*#{hex4}"
# hexseq2 = *( hex4 ":" ) lastpart
hexseq2 = "(?:#{hex4}:)*#{lastpart}"
# IPv6address = hexseq2 | [ hexseq1 ] "::" [ hexseq2 ]
ret[:IPV6ADDR] = ipv6addr = "(?:#{hexseq2}|(?:#{hexseq1})?::(?:#{hexseq2})?)"
# IPv6prefix = ( hexseq1 | [ hexseq1 ] "::" [ hexseq1 ] ) "/" 1*2DIGIT
# unused
# ipv6reference = "[" IPv6address "]" (RFC 2732)
ret[:IPV6REF] = ipv6ref = "\\[#{ipv6addr}\\]"
# host = hostname | IPv4address
# host = hostname | IPv4address | IPv6reference (RFC 2732)
ret[:HOST] = host = "(?:#{hostname}|#{ipv4addr}|#{ipv6ref})"
# port = *digit
ret[:PORT] = port = '\d*'
# hostport = host [ ":" port ]
ret[:HOSTPORT] = hostport = "#{host}(?::#{port})?"
# userinfo = *( unreserved | escaped |
# ";" | ":" | "&" | "=" | "+" | "$" | "," )
ret[:USERINFO] = userinfo = "(?:[#{unreserved};:&=+$,]|#{escaped})*"
# pchar = unreserved | escaped |
# ":" | "@" | "&" | "=" | "+" | "$" | ","
pchar = "(?:[#{unreserved}:@&=+$,]|#{escaped})"
# param = *pchar
param = "#{pchar}*"
# segment = *pchar *( ";" param )
segment = "#{pchar}*(?:;#{param})*"
# path_segments = segment *( "/" segment )
ret[:PATH_SEGMENTS] = path_segments = "#{segment}(?:/#{segment})*"
# server = [ [ userinfo "@" ] hostport ]
server = "(?:#{userinfo}@)?#{hostport}"
# reg_name = 1*( unreserved | escaped | "$" | "," |
# ";" | ":" | "@" | "&" | "=" | "+" )
ret[:REG_NAME] = reg_name = "(?:[#{unreserved}$,;:@&=+]|#{escaped})+"
# authority = server | reg_name
authority = "(?:#{server}|#{reg_name})"
# rel_segment = 1*( unreserved | escaped |
# ";" | "@" | "&" | "=" | "+" | "$" | "," )
ret[:REL_SEGMENT] = rel_segment = "(?:[#{unreserved};@&=+$,]|#{escaped})+"
# scheme = alpha *( alpha | digit | "+" | "-" | "." )
ret[:SCHEME] = scheme = "[#{PATTERN::ALPHA}][\\-+.#{PATTERN::ALPHA}\\d]*"
# abs_path = "/" path_segments
ret[:ABS_PATH] = abs_path = "/#{path_segments}"
# rel_path = rel_segment [ abs_path ]
ret[:REL_PATH] = rel_path = "#{rel_segment}(?:#{abs_path})?"
# net_path = "//" authority [ abs_path ]
ret[:NET_PATH] = net_path = "//#{authority}(?:#{abs_path})?"
# hier_part = ( net_path | abs_path ) [ "?" query ]
ret[:HIER_PART] = hier_part = "(?:#{net_path}|#{abs_path})(?:\\?(?:#{query}))?"
# opaque_part = uric_no_slash *uric
ret[:OPAQUE_PART] = opaque_part = "#{uric_no_slash}#{uric}*"
# absoluteURI = scheme ":" ( hier_part | opaque_part )
ret[:ABS_URI] = abs_uri = "#{scheme}:(?:#{hier_part}|#{opaque_part})"
# relativeURI = ( net_path | abs_path | rel_path ) [ "?" query ]
ret[:REL_URI] = rel_uri = "(?:#{net_path}|#{abs_path}|#{rel_path})(?:\\?#{query})?"
# URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
ret[:URI_REF] = "(?:#{abs_uri}|#{rel_uri})?(?:##{fragment})?"
ret[:X_ABS_URI] = "
(#{scheme}): (?# 1: scheme)
(?:
(#{opaque_part}) (?# 2: opaque)
|
(?:(?:
//(?:
(?:(?:(#{userinfo})@)? (?# 3: userinfo)
(?:(#{host})(?::(\\d*))?))? (?# 4: host, 5: port)
|
(#{reg_name}) (?# 6: registry)
)
|
(?!//)) (?# XXX: '//' is the mark for hostport)
(#{abs_path})? (?# 7: path)
)(?:\\?(#{query}))? (?# 8: query)
)
(?:\\#(#{fragment}))? (?# 9: fragment)
"
ret[:X_REL_URI] = "
(?:
(?:
//
(?:
(?:(#{userinfo})@)? (?# 1: userinfo)
(#{host})?(?::(\\d*))? (?# 2: host, 3: port)
|
(#{reg_name}) (?# 4: registry)
)
)
|
(#{rel_segment}) (?# 5: rel_segment)
)?
(#{abs_path})? (?# 6: abs_path)
(?:\\?(#{query}))? (?# 7: query)
(?:\\#(#{fragment}))? (?# 8: fragment)
"
ret
end
# Constructs the default Hash of Regexp's.
def initialize_regexp(pattern)
ret = {}
# for URI::split
ret[:ABS_URI] = Regexp.new('\A\s*+' + pattern[:X_ABS_URI] + '\s*\z', Regexp::EXTENDED)
ret[:REL_URI] = Regexp.new('\A\s*+' + pattern[:X_REL_URI] + '\s*\z', Regexp::EXTENDED)
# for URI::extract
ret[:URI_REF] = Regexp.new(pattern[:URI_REF])
ret[:ABS_URI_REF] = Regexp.new(pattern[:X_ABS_URI], Regexp::EXTENDED)
ret[:REL_URI_REF] = Regexp.new(pattern[:X_REL_URI], Regexp::EXTENDED)
# for URI::escape/unescape
ret[:ESCAPED] = Regexp.new(pattern[:ESCAPED])
ret[:UNSAFE] = Regexp.new("[^#{pattern[:UNRESERVED]}#{pattern[:RESERVED]}]")
# for Generic#initialize
ret[:SCHEME] = Regexp.new("\\A#{pattern[:SCHEME]}\\z")
ret[:USERINFO] = Regexp.new("\\A#{pattern[:USERINFO]}\\z")
ret[:HOST] = Regexp.new("\\A#{pattern[:HOST]}\\z")
ret[:PORT] = Regexp.new("\\A#{pattern[:PORT]}\\z")
ret[:OPAQUE] = Regexp.new("\\A#{pattern[:OPAQUE_PART]}\\z")
ret[:REGISTRY] = Regexp.new("\\A#{pattern[:REG_NAME]}\\z")
ret[:ABS_PATH] = Regexp.new("\\A#{pattern[:ABS_PATH]}\\z")
ret[:REL_PATH] = Regexp.new("\\A#{pattern[:REL_PATH]}\\z")
ret[:QUERY] = Regexp.new("\\A#{pattern[:QUERY]}\\z")
ret[:FRAGMENT] = Regexp.new("\\A#{pattern[:FRAGMENT]}\\z")
ret
end
def convert_to_uri(uri)
if uri.is_a?(URI::Generic)
uri
elsif uri = String.try_convert(uri)
parse(uri)
else
raise ArgumentError,
"bad argument (expected URI object or URI string)"
end
end
end # class Parser
end # module URI
share/ruby/uri/common.rb 0000644 00000062541 15173517737 0011273 0 ustar 00 # frozen_string_literal: true
#--
# = uri/common.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License::
# You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative "rfc2396_parser"
require_relative "rfc3986_parser"
module URI
include RFC2396_REGEXP
REGEXP = RFC2396_REGEXP
Parser = RFC2396_Parser
RFC3986_PARSER = RFC3986_Parser.new
Ractor.make_shareable(RFC3986_PARSER) if defined?(Ractor)
RFC2396_PARSER = RFC2396_Parser.new
Ractor.make_shareable(RFC2396_PARSER) if defined?(Ractor)
# URI::Parser.new
DEFAULT_PARSER = Parser.new
DEFAULT_PARSER.pattern.each_pair do |sym, str|
unless REGEXP::PATTERN.const_defined?(sym)
REGEXP::PATTERN.const_set(sym, str)
end
end
DEFAULT_PARSER.regexp.each_pair do |sym, str|
const_set(sym, str)
end
Ractor.make_shareable(DEFAULT_PARSER) if defined?(Ractor)
module Util # :nodoc:
def make_components_hash(klass, array_hash)
tmp = {}
if array_hash.kind_of?(Array) &&
array_hash.size == klass.component.size - 1
klass.component[1..-1].each_index do |i|
begin
tmp[klass.component[i + 1]] = array_hash[i].clone
rescue TypeError
tmp[klass.component[i + 1]] = array_hash[i]
end
end
elsif array_hash.kind_of?(Hash)
array_hash.each do |key, value|
begin
tmp[key] = value.clone
rescue TypeError
tmp[key] = value
end
end
else
raise ArgumentError,
"expected Array of or Hash of components of #{klass} (#{klass.component[1..-1].join(', ')})"
end
tmp[:scheme] = klass.to_s.sub(/\A.*::/, '').downcase
return tmp
end
module_function :make_components_hash
end
module Schemes
end
private_constant :Schemes
# Registers the given +klass+ as the class to be instantiated
# when parsing a \URI with the given +scheme+:
#
# URI.register_scheme('MS_SEARCH', URI::Generic) # => URI::Generic
# URI.scheme_list['MS_SEARCH'] # => URI::Generic
#
# Note that after calling String#upcase on +scheme+, it must be a valid
# constant name.
def self.register_scheme(scheme, klass)
Schemes.const_set(scheme.to_s.upcase, klass)
end
# Returns a hash of the defined schemes:
#
# URI.scheme_list
# # =>
# {"MAILTO"=>URI::MailTo,
# "LDAPS"=>URI::LDAPS,
# "WS"=>URI::WS,
# "HTTP"=>URI::HTTP,
# "HTTPS"=>URI::HTTPS,
# "LDAP"=>URI::LDAP,
# "FILE"=>URI::File,
# "FTP"=>URI::FTP}
#
# Related: URI.register_scheme.
def self.scheme_list
Schemes.constants.map { |name|
[name.to_s.upcase, Schemes.const_get(name)]
}.to_h
end
INITIAL_SCHEMES = scheme_list
private_constant :INITIAL_SCHEMES
Ractor.make_shareable(INITIAL_SCHEMES) if defined?(Ractor)
# Returns a new object constructed from the given +scheme+, +arguments+,
# and +default+:
#
# - The new object is an instance of <tt>URI.scheme_list[scheme.upcase]</tt>.
# - The object is initialized by calling the class initializer
# using +scheme+ and +arguments+.
# See URI::Generic.new.
#
# Examples:
#
# values = ['john.doe', 'www.example.com', '123', nil, '/forum/questions/', nil, 'tag=networking&order=newest', 'top']
# URI.for('https', *values)
# # => #<URI::HTTPS https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
# URI.for('foo', *values, default: URI::HTTP)
# # => #<URI::HTTP foo://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
#
def self.for(scheme, *arguments, default: Generic)
const_name = scheme.to_s.upcase
uri_class = INITIAL_SCHEMES[const_name]
uri_class ||= if /\A[A-Z]\w*\z/.match?(const_name) && Schemes.const_defined?(const_name, false)
Schemes.const_get(const_name, false)
end
uri_class ||= default
return uri_class.new(scheme, *arguments)
end
#
# Base class for all URI exceptions.
#
class Error < StandardError; end
#
# Not a URI.
#
class InvalidURIError < Error; end
#
# Not a URI component.
#
class InvalidComponentError < Error; end
#
# URI is valid, bad usage is not.
#
class BadURIError < Error; end
# Returns a 9-element array representing the parts of the \URI
# formed from the string +uri+;
# each array element is a string or +nil+:
#
# names = %w[scheme userinfo host port registry path opaque query fragment]
# values = URI.split('https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# names.zip(values)
# # =>
# [["scheme", "https"],
# ["userinfo", "john.doe"],
# ["host", "www.example.com"],
# ["port", "123"],
# ["registry", nil],
# ["path", "/forum/questions/"],
# ["opaque", nil],
# ["query", "tag=networking&order=newest"],
# ["fragment", "top"]]
#
def self.split(uri)
RFC3986_PARSER.split(uri)
end
# Returns a new \URI object constructed from the given string +uri+:
#
# URI.parse('https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# # => #<URI::HTTPS https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
# URI.parse('http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# # => #<URI::HTTP http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
#
# It's recommended to first ::escape string +uri+
# if it may contain invalid URI characters.
#
def self.parse(uri)
RFC3986_PARSER.parse(uri)
end
# Merges the given URI strings +str+
# per {RFC 2396}[https://www.rfc-editor.org/rfc/rfc2396.html].
#
# Each string in +str+ is converted to an
# {RFC3986 URI}[https://www.rfc-editor.org/rfc/rfc3986.html] before being merged.
#
# Examples:
#
# URI.join("http://example.com/","main.rbx")
# # => #<URI::HTTP http://example.com/main.rbx>
#
# URI.join('http://example.com', 'foo')
# # => #<URI::HTTP http://example.com/foo>
#
# URI.join('http://example.com', '/foo', '/bar')
# # => #<URI::HTTP http://example.com/bar>
#
# URI.join('http://example.com', '/foo', 'bar')
# # => #<URI::HTTP http://example.com/bar>
#
# URI.join('http://example.com', '/foo/', 'bar')
# # => #<URI::HTTP http://example.com/foo/bar>
#
def self.join(*str)
RFC3986_PARSER.join(*str)
end
#
# == Synopsis
#
# URI::extract(str[, schemes][,&blk])
#
# == Args
#
# +str+::
# String to extract URIs from.
# +schemes+::
# Limit URI matching to specific schemes.
#
# == Description
#
# Extracts URIs from a string. If block given, iterates through all matched URIs.
# Returns nil if block given or array with matches.
#
# == Usage
#
# require "uri"
#
# URI.extract("text here http://foo.example.org/bla and here mailto:test@example.com and here also.")
# # => ["http://foo.example.com/bla", "mailto:test@example.com"]
#
def self.extract(str, schemes = nil, &block) # :nodoc:
warn "URI.extract is obsolete", uplevel: 1 if $VERBOSE
DEFAULT_PARSER.extract(str, schemes, &block)
end
#
# == Synopsis
#
# URI::regexp([match_schemes])
#
# == Args
#
# +match_schemes+::
# Array of schemes. If given, resulting regexp matches to URIs
# whose scheme is one of the match_schemes.
#
# == Description
#
# Returns a Regexp object which matches to URI-like strings.
# The Regexp object returned by this method includes arbitrary
# number of capture group (parentheses). Never rely on its number.
#
# == Usage
#
# require 'uri'
#
# # extract first URI from html_string
# html_string.slice(URI.regexp)
#
# # remove ftp URIs
# html_string.sub(URI.regexp(['ftp']), '')
#
# # You should not rely on the number of parentheses
# html_string.scan(URI.regexp) do |*matches|
# p $&
# end
#
def self.regexp(schemes = nil)# :nodoc:
warn "URI.regexp is obsolete", uplevel: 1 if $VERBOSE
DEFAULT_PARSER.make_regexp(schemes)
end
TBLENCWWWCOMP_ = {} # :nodoc:
256.times do |i|
TBLENCWWWCOMP_[-i.chr] = -('%%%02X' % i)
end
TBLENCURICOMP_ = TBLENCWWWCOMP_.dup.freeze
TBLENCWWWCOMP_[' '] = '+'
TBLENCWWWCOMP_.freeze
TBLDECWWWCOMP_ = {} # :nodoc:
256.times do |i|
h, l = i>>4, i&15
TBLDECWWWCOMP_[-('%%%X%X' % [h, l])] = -i.chr
TBLDECWWWCOMP_[-('%%%x%X' % [h, l])] = -i.chr
TBLDECWWWCOMP_[-('%%%X%x' % [h, l])] = -i.chr
TBLDECWWWCOMP_[-('%%%x%x' % [h, l])] = -i.chr
end
TBLDECWWWCOMP_['+'] = ' '
TBLDECWWWCOMP_.freeze
# Returns a URL-encoded string derived from the given string +str+.
#
# The returned string:
#
# - Preserves:
#
# - Characters <tt>'*'</tt>, <tt>'.'</tt>, <tt>'-'</tt>, and <tt>'_'</tt>.
# - Character in ranges <tt>'a'..'z'</tt>, <tt>'A'..'Z'</tt>,
# and <tt>'0'..'9'</tt>.
#
# Example:
#
# URI.encode_www_form_component('*.-_azAZ09')
# # => "*.-_azAZ09"
#
# - Converts:
#
# - Character <tt>' '</tt> to character <tt>'+'</tt>.
# - Any other character to "percent notation";
# the percent notation for character <i>c</i> is <tt>'%%%X' % c.ord</tt>.
#
# Example:
#
# URI.encode_www_form_component('Here are some punctuation characters: ,;?:')
# # => "Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A"
#
# Encoding:
#
# - If +str+ has encoding Encoding::ASCII_8BIT, argument +enc+ is ignored.
# - Otherwise +str+ is converted first to Encoding::UTF_8
# (with suitable character replacements),
# and then to encoding +enc+.
#
# In either case, the returned string has forced encoding Encoding::US_ASCII.
#
# Related: URI.encode_uri_component (encodes <tt>' '</tt> as <tt>'%20'</tt>).
def self.encode_www_form_component(str, enc=nil)
_encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCWWWCOMP_, str, enc)
end
# Returns a string decoded from the given \URL-encoded string +str+.
#
# The given string is first encoded as Encoding::ASCII-8BIT (using String#b),
# then decoded (as below), and finally force-encoded to the given encoding +enc+.
#
# The returned string:
#
# - Preserves:
#
# - Characters <tt>'*'</tt>, <tt>'.'</tt>, <tt>'-'</tt>, and <tt>'_'</tt>.
# - Character in ranges <tt>'a'..'z'</tt>, <tt>'A'..'Z'</tt>,
# and <tt>'0'..'9'</tt>.
#
# Example:
#
# URI.decode_www_form_component('*.-_azAZ09')
# # => "*.-_azAZ09"
#
# - Converts:
#
# - Character <tt>'+'</tt> to character <tt>' '</tt>.
# - Each "percent notation" to an ASCII character.
#
# Example:
#
# URI.decode_www_form_component('Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A')
# # => "Here are some punctuation characters: ,;?:"
#
# Related: URI.decode_uri_component (preserves <tt>'+'</tt>).
def self.decode_www_form_component(str, enc=Encoding::UTF_8)
_decode_uri_component(/\+|%\h\h/, str, enc)
end
# Like URI.encode_www_form_component, except that <tt>' '</tt> (space)
# is encoded as <tt>'%20'</tt> (instead of <tt>'+'</tt>).
def self.encode_uri_component(str, enc=nil)
_encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCURICOMP_, str, enc)
end
# Like URI.decode_www_form_component, except that <tt>'+'</tt> is preserved.
def self.decode_uri_component(str, enc=Encoding::UTF_8)
_decode_uri_component(/%\h\h/, str, enc)
end
def self._encode_uri_component(regexp, table, str, enc)
str = str.to_s.dup
if str.encoding != Encoding::ASCII_8BIT
if enc && enc != Encoding::ASCII_8BIT
str.encode!(Encoding::UTF_8, invalid: :replace, undef: :replace)
str.encode!(enc, fallback: ->(x){"&##{x.ord};"})
end
str.force_encoding(Encoding::ASCII_8BIT)
end
str.gsub!(regexp, table)
str.force_encoding(Encoding::US_ASCII)
end
private_class_method :_encode_uri_component
def self._decode_uri_component(regexp, str, enc)
raise ArgumentError, "invalid %-encoding (#{str})" if /%(?!\h\h)/.match?(str)
str.b.gsub(regexp, TBLDECWWWCOMP_).force_encoding(enc)
end
private_class_method :_decode_uri_component
# Returns a URL-encoded string derived from the given
# {Enumerable}[rdoc-ref:Enumerable@Enumerable+in+Ruby+Classes]
# +enum+.
#
# The result is suitable for use as form data
# for an \HTTP request whose <tt>Content-Type</tt> is
# <tt>'application/x-www-form-urlencoded'</tt>.
#
# The returned string consists of the elements of +enum+,
# each converted to one or more URL-encoded strings,
# and all joined with character <tt>'&'</tt>.
#
# Simple examples:
#
# URI.encode_www_form([['foo', 0], ['bar', 1], ['baz', 2]])
# # => "foo=0&bar=1&baz=2"
# URI.encode_www_form({foo: 0, bar: 1, baz: 2})
# # => "foo=0&bar=1&baz=2"
#
# The returned string is formed using method URI.encode_www_form_component,
# which converts certain characters:
#
# URI.encode_www_form('f#o': '/', 'b-r': '$', 'b z': '@')
# # => "f%23o=%2F&b-r=%24&b+z=%40"
#
# When +enum+ is Array-like, each element +ele+ is converted to a field:
#
# - If +ele+ is an array of two or more elements,
# the field is formed from its first two elements
# (and any additional elements are ignored):
#
# name = URI.encode_www_form_component(ele[0], enc)
# value = URI.encode_www_form_component(ele[1], enc)
# "#{name}=#{value}"
#
# Examples:
#
# URI.encode_www_form([%w[foo bar], %w[baz bat bah]])
# # => "foo=bar&baz=bat"
# URI.encode_www_form([['foo', 0], ['bar', :baz, 'bat']])
# # => "foo=0&bar=baz"
#
# - If +ele+ is an array of one element,
# the field is formed from <tt>ele[0]</tt>:
#
# URI.encode_www_form_component(ele[0])
#
# Example:
#
# URI.encode_www_form([['foo'], [:bar], [0]])
# # => "foo&bar&0"
#
# - Otherwise the field is formed from +ele+:
#
# URI.encode_www_form_component(ele)
#
# Example:
#
# URI.encode_www_form(['foo', :bar, 0])
# # => "foo&bar&0"
#
# The elements of an Array-like +enum+ may be mixture:
#
# URI.encode_www_form([['foo', 0], ['bar', 1, 2], ['baz'], :bat])
# # => "foo=0&bar=1&baz&bat"
#
# When +enum+ is Hash-like,
# each +key+/+value+ pair is converted to one or more fields:
#
# - If +value+ is
# {Array-convertible}[rdoc-ref:implicit_conversion.rdoc@Array-Convertible+Objects],
# each element +ele+ in +value+ is paired with +key+ to form a field:
#
# name = URI.encode_www_form_component(key, enc)
# value = URI.encode_www_form_component(ele, enc)
# "#{name}=#{value}"
#
# Example:
#
# URI.encode_www_form({foo: [:bar, 1], baz: [:bat, :bam, 2]})
# # => "foo=bar&foo=1&baz=bat&baz=bam&baz=2"
#
# - Otherwise, +key+ and +value+ are paired to form a field:
#
# name = URI.encode_www_form_component(key, enc)
# value = URI.encode_www_form_component(value, enc)
# "#{name}=#{value}"
#
# Example:
#
# URI.encode_www_form({foo: 0, bar: 1, baz: 2})
# # => "foo=0&bar=1&baz=2"
#
# The elements of a Hash-like +enum+ may be mixture:
#
# URI.encode_www_form({foo: [0, 1], bar: 2})
# # => "foo=0&foo=1&bar=2"
#
def self.encode_www_form(enum, enc=nil)
enum.map do |k,v|
if v.nil?
encode_www_form_component(k, enc)
elsif v.respond_to?(:to_ary)
v.to_ary.map do |w|
str = encode_www_form_component(k, enc)
unless w.nil?
str << '='
str << encode_www_form_component(w, enc)
end
end.join('&')
else
str = encode_www_form_component(k, enc)
str << '='
str << encode_www_form_component(v, enc)
end
end.join('&')
end
# Returns name/value pairs derived from the given string +str+,
# which must be an ASCII string.
#
# The method may be used to decode the body of Net::HTTPResponse object +res+
# for which <tt>res['Content-Type']</tt> is <tt>'application/x-www-form-urlencoded'</tt>.
#
# The returned data is an array of 2-element subarrays;
# each subarray is a name/value pair (both are strings).
# Each returned string has encoding +enc+,
# and has had invalid characters removed via
# {String#scrub}[rdoc-ref:String#scrub].
#
# A simple example:
#
# URI.decode_www_form('foo=0&bar=1&baz')
# # => [["foo", "0"], ["bar", "1"], ["baz", ""]]
#
# The returned strings have certain conversions,
# similar to those performed in URI.decode_www_form_component:
#
# URI.decode_www_form('f%23o=%2F&b-r=%24&b+z=%40')
# # => [["f#o", "/"], ["b-r", "$"], ["b z", "@"]]
#
# The given string may contain consecutive separators:
#
# URI.decode_www_form('foo=0&&bar=1&&baz=2')
# # => [["foo", "0"], ["", ""], ["bar", "1"], ["", ""], ["baz", "2"]]
#
# A different separator may be specified:
#
# URI.decode_www_form('foo=0--bar=1--baz', separator: '--')
# # => [["foo", "0"], ["bar", "1"], ["baz", ""]]
#
def self.decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false)
raise ArgumentError, "the input of #{self.name}.#{__method__} must be ASCII only string" unless str.ascii_only?
ary = []
return ary if str.empty?
enc = Encoding.find(enc)
str.b.each_line(separator) do |string|
string.chomp!(separator)
key, sep, val = string.partition('=')
if isindex
if sep.empty?
val = key
key = +''
end
isindex = false
end
if use__charset_ and key == '_charset_' and e = get_encoding(val)
enc = e
use__charset_ = false
end
key.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_)
if val
val.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_)
else
val = +''
end
ary << [key, val]
end
ary.each do |k, v|
k.force_encoding(enc)
k.scrub!
v.force_encoding(enc)
v.scrub!
end
ary
end
private
=begin command for WEB_ENCODINGS_
curl https://encoding.spec.whatwg.org/encodings.json|
ruby -rjson -e 'H={}
h={
"shift_jis"=>"Windows-31J",
"euc-jp"=>"cp51932",
"iso-2022-jp"=>"cp50221",
"x-mac-cyrillic"=>"macCyrillic",
}
JSON($<.read).map{|x|x["encodings"]}.flatten.each{|x|
Encoding.find(n=h.fetch(n=x["name"].downcase,n))rescue next
x["labels"].each{|y|H[y]=n}
}
puts "{"
H.each{|k,v|puts %[ #{k.dump}=>#{v.dump},]}
puts "}"
'
=end
WEB_ENCODINGS_ = {
"unicode-1-1-utf-8"=>"utf-8",
"utf-8"=>"utf-8",
"utf8"=>"utf-8",
"866"=>"ibm866",
"cp866"=>"ibm866",
"csibm866"=>"ibm866",
"ibm866"=>"ibm866",
"csisolatin2"=>"iso-8859-2",
"iso-8859-2"=>"iso-8859-2",
"iso-ir-101"=>"iso-8859-2",
"iso8859-2"=>"iso-8859-2",
"iso88592"=>"iso-8859-2",
"iso_8859-2"=>"iso-8859-2",
"iso_8859-2:1987"=>"iso-8859-2",
"l2"=>"iso-8859-2",
"latin2"=>"iso-8859-2",
"csisolatin3"=>"iso-8859-3",
"iso-8859-3"=>"iso-8859-3",
"iso-ir-109"=>"iso-8859-3",
"iso8859-3"=>"iso-8859-3",
"iso88593"=>"iso-8859-3",
"iso_8859-3"=>"iso-8859-3",
"iso_8859-3:1988"=>"iso-8859-3",
"l3"=>"iso-8859-3",
"latin3"=>"iso-8859-3",
"csisolatin4"=>"iso-8859-4",
"iso-8859-4"=>"iso-8859-4",
"iso-ir-110"=>"iso-8859-4",
"iso8859-4"=>"iso-8859-4",
"iso88594"=>"iso-8859-4",
"iso_8859-4"=>"iso-8859-4",
"iso_8859-4:1988"=>"iso-8859-4",
"l4"=>"iso-8859-4",
"latin4"=>"iso-8859-4",
"csisolatincyrillic"=>"iso-8859-5",
"cyrillic"=>"iso-8859-5",
"iso-8859-5"=>"iso-8859-5",
"iso-ir-144"=>"iso-8859-5",
"iso8859-5"=>"iso-8859-5",
"iso88595"=>"iso-8859-5",
"iso_8859-5"=>"iso-8859-5",
"iso_8859-5:1988"=>"iso-8859-5",
"arabic"=>"iso-8859-6",
"asmo-708"=>"iso-8859-6",
"csiso88596e"=>"iso-8859-6",
"csiso88596i"=>"iso-8859-6",
"csisolatinarabic"=>"iso-8859-6",
"ecma-114"=>"iso-8859-6",
"iso-8859-6"=>"iso-8859-6",
"iso-8859-6-e"=>"iso-8859-6",
"iso-8859-6-i"=>"iso-8859-6",
"iso-ir-127"=>"iso-8859-6",
"iso8859-6"=>"iso-8859-6",
"iso88596"=>"iso-8859-6",
"iso_8859-6"=>"iso-8859-6",
"iso_8859-6:1987"=>"iso-8859-6",
"csisolatingreek"=>"iso-8859-7",
"ecma-118"=>"iso-8859-7",
"elot_928"=>"iso-8859-7",
"greek"=>"iso-8859-7",
"greek8"=>"iso-8859-7",
"iso-8859-7"=>"iso-8859-7",
"iso-ir-126"=>"iso-8859-7",
"iso8859-7"=>"iso-8859-7",
"iso88597"=>"iso-8859-7",
"iso_8859-7"=>"iso-8859-7",
"iso_8859-7:1987"=>"iso-8859-7",
"sun_eu_greek"=>"iso-8859-7",
"csiso88598e"=>"iso-8859-8",
"csisolatinhebrew"=>"iso-8859-8",
"hebrew"=>"iso-8859-8",
"iso-8859-8"=>"iso-8859-8",
"iso-8859-8-e"=>"iso-8859-8",
"iso-ir-138"=>"iso-8859-8",
"iso8859-8"=>"iso-8859-8",
"iso88598"=>"iso-8859-8",
"iso_8859-8"=>"iso-8859-8",
"iso_8859-8:1988"=>"iso-8859-8",
"visual"=>"iso-8859-8",
"csisolatin6"=>"iso-8859-10",
"iso-8859-10"=>"iso-8859-10",
"iso-ir-157"=>"iso-8859-10",
"iso8859-10"=>"iso-8859-10",
"iso885910"=>"iso-8859-10",
"l6"=>"iso-8859-10",
"latin6"=>"iso-8859-10",
"iso-8859-13"=>"iso-8859-13",
"iso8859-13"=>"iso-8859-13",
"iso885913"=>"iso-8859-13",
"iso-8859-14"=>"iso-8859-14",
"iso8859-14"=>"iso-8859-14",
"iso885914"=>"iso-8859-14",
"csisolatin9"=>"iso-8859-15",
"iso-8859-15"=>"iso-8859-15",
"iso8859-15"=>"iso-8859-15",
"iso885915"=>"iso-8859-15",
"iso_8859-15"=>"iso-8859-15",
"l9"=>"iso-8859-15",
"iso-8859-16"=>"iso-8859-16",
"cskoi8r"=>"koi8-r",
"koi"=>"koi8-r",
"koi8"=>"koi8-r",
"koi8-r"=>"koi8-r",
"koi8_r"=>"koi8-r",
"koi8-ru"=>"koi8-u",
"koi8-u"=>"koi8-u",
"dos-874"=>"windows-874",
"iso-8859-11"=>"windows-874",
"iso8859-11"=>"windows-874",
"iso885911"=>"windows-874",
"tis-620"=>"windows-874",
"windows-874"=>"windows-874",
"cp1250"=>"windows-1250",
"windows-1250"=>"windows-1250",
"x-cp1250"=>"windows-1250",
"cp1251"=>"windows-1251",
"windows-1251"=>"windows-1251",
"x-cp1251"=>"windows-1251",
"ansi_x3.4-1968"=>"windows-1252",
"ascii"=>"windows-1252",
"cp1252"=>"windows-1252",
"cp819"=>"windows-1252",
"csisolatin1"=>"windows-1252",
"ibm819"=>"windows-1252",
"iso-8859-1"=>"windows-1252",
"iso-ir-100"=>"windows-1252",
"iso8859-1"=>"windows-1252",
"iso88591"=>"windows-1252",
"iso_8859-1"=>"windows-1252",
"iso_8859-1:1987"=>"windows-1252",
"l1"=>"windows-1252",
"latin1"=>"windows-1252",
"us-ascii"=>"windows-1252",
"windows-1252"=>"windows-1252",
"x-cp1252"=>"windows-1252",
"cp1253"=>"windows-1253",
"windows-1253"=>"windows-1253",
"x-cp1253"=>"windows-1253",
"cp1254"=>"windows-1254",
"csisolatin5"=>"windows-1254",
"iso-8859-9"=>"windows-1254",
"iso-ir-148"=>"windows-1254",
"iso8859-9"=>"windows-1254",
"iso88599"=>"windows-1254",
"iso_8859-9"=>"windows-1254",
"iso_8859-9:1989"=>"windows-1254",
"l5"=>"windows-1254",
"latin5"=>"windows-1254",
"windows-1254"=>"windows-1254",
"x-cp1254"=>"windows-1254",
"cp1255"=>"windows-1255",
"windows-1255"=>"windows-1255",
"x-cp1255"=>"windows-1255",
"cp1256"=>"windows-1256",
"windows-1256"=>"windows-1256",
"x-cp1256"=>"windows-1256",
"cp1257"=>"windows-1257",
"windows-1257"=>"windows-1257",
"x-cp1257"=>"windows-1257",
"cp1258"=>"windows-1258",
"windows-1258"=>"windows-1258",
"x-cp1258"=>"windows-1258",
"x-mac-cyrillic"=>"macCyrillic",
"x-mac-ukrainian"=>"macCyrillic",
"chinese"=>"gbk",
"csgb2312"=>"gbk",
"csiso58gb231280"=>"gbk",
"gb2312"=>"gbk",
"gb_2312"=>"gbk",
"gb_2312-80"=>"gbk",
"gbk"=>"gbk",
"iso-ir-58"=>"gbk",
"x-gbk"=>"gbk",
"gb18030"=>"gb18030",
"big5"=>"big5",
"big5-hkscs"=>"big5",
"cn-big5"=>"big5",
"csbig5"=>"big5",
"x-x-big5"=>"big5",
"cseucpkdfmtjapanese"=>"cp51932",
"euc-jp"=>"cp51932",
"x-euc-jp"=>"cp51932",
"csiso2022jp"=>"cp50221",
"iso-2022-jp"=>"cp50221",
"csshiftjis"=>"Windows-31J",
"ms932"=>"Windows-31J",
"ms_kanji"=>"Windows-31J",
"shift-jis"=>"Windows-31J",
"shift_jis"=>"Windows-31J",
"sjis"=>"Windows-31J",
"windows-31j"=>"Windows-31J",
"x-sjis"=>"Windows-31J",
"cseuckr"=>"euc-kr",
"csksc56011987"=>"euc-kr",
"euc-kr"=>"euc-kr",
"iso-ir-149"=>"euc-kr",
"korean"=>"euc-kr",
"ks_c_5601-1987"=>"euc-kr",
"ks_c_5601-1989"=>"euc-kr",
"ksc5601"=>"euc-kr",
"ksc_5601"=>"euc-kr",
"windows-949"=>"euc-kr",
"utf-16be"=>"utf-16be",
"utf-16"=>"utf-16le",
"utf-16le"=>"utf-16le",
} # :nodoc:
Ractor.make_shareable(WEB_ENCODINGS_) if defined?(Ractor)
# :nodoc:
# return encoding or nil
# http://encoding.spec.whatwg.org/#concept-encoding-get
def self.get_encoding(label)
Encoding.find(WEB_ENCODINGS_[label.to_str.strip.downcase]) rescue nil
end
end # module URI
module Kernel
#
# Returns a \URI object derived from the given +uri+,
# which may be a \URI string or an existing \URI object:
#
# # Returns a new URI.
# uri = URI('http://github.com/ruby/ruby')
# # => #<URI::HTTP http://github.com/ruby/ruby>
# # Returns the given URI.
# URI(uri)
# # => #<URI::HTTP http://github.com/ruby/ruby>
#
def URI(uri)
if uri.is_a?(URI::Generic)
uri
elsif uri = String.try_convert(uri)
URI.parse(uri)
else
raise ArgumentError,
"bad argument (expected URI object or URI string)"
end
end
module_function :URI
end
share/ruby/uri/version.rb 0000644 00000000226 15173517737 0011460 0 ustar 00 module URI
# :stopdoc:
VERSION_CODE = '001302'.freeze
VERSION = VERSION_CODE.scan(/../).collect{|n| n.to_i}.join('.').freeze
# :startdoc:
end
share/ruby/uri/ldap.rb 0000644 00000013437 15173517737 0010723 0 ustar 00 # frozen_string_literal: false
# = uri/ldap.rb
#
# Author::
# Takaaki Tateishi <ttate@jaist.ac.jp>
# Akira Yamada <akira@ruby-lang.org>
# License::
# URI::LDAP is copyrighted free software by Takaaki Tateishi and Akira Yamada.
# You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'generic'
module URI
#
# LDAP URI SCHEMA (described in RFC2255).
#--
# ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>[?<extensions>]]]]
#++
class LDAP < Generic
# A Default port of 389 for URI::LDAP.
DEFAULT_PORT = 389
# An Array of the available components for URI::LDAP.
COMPONENT = [
:scheme,
:host, :port,
:dn,
:attributes,
:scope,
:filter,
:extensions,
].freeze
# Scopes available for the starting point.
#
# * SCOPE_BASE - the Base DN
# * SCOPE_ONE - one level under the Base DN, not including the base DN and
# not including any entries under this
# * SCOPE_SUB - subtrees, all entries at all levels
#
SCOPE = [
SCOPE_ONE = 'one',
SCOPE_SUB = 'sub',
SCOPE_BASE = 'base',
].freeze
#
# == Description
#
# Creates a new URI::LDAP object from components, with syntax checking.
#
# The components accepted are host, port, dn, attributes,
# scope, filter, and extensions.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[host, port, dn, attributes, scope, filter, extensions]</code>.
#
# Example:
#
# uri = URI::LDAP.build({:host => 'ldap.example.com',
# :dn => '/dc=example'})
#
# uri = URI::LDAP.build(["ldap.example.com", nil,
# "/dc=example;dc=com", "query", nil, nil, nil])
#
def self.build(args)
tmp = Util::make_components_hash(self, args)
if tmp[:dn]
tmp[:path] = tmp[:dn]
end
query = []
[:extensions, :filter, :scope, :attributes].collect do |x|
next if !tmp[x] && query.size == 0
query.unshift(tmp[x])
end
tmp[:query] = query.join('?')
return super(tmp)
end
#
# == Description
#
# Creates a new URI::LDAP object from generic URI components as per
# RFC 2396. No LDAP-specific syntax checking is performed.
#
# Arguments are +scheme+, +userinfo+, +host+, +port+, +registry+, +path+,
# +opaque+, +query+, and +fragment+, in that order.
#
# Example:
#
# uri = URI::LDAP.new("ldap", nil, "ldap.example.com", nil, nil,
# "/dc=example;dc=com", nil, "query", nil)
#
# See also URI::Generic.new.
#
def initialize(*arg)
super(*arg)
if @fragment
raise InvalidURIError, 'bad LDAP URL'
end
parse_dn
parse_query
end
# Private method to cleanup +dn+ from using the +path+ component attribute.
def parse_dn
raise InvalidURIError, 'bad LDAP URL' unless @path
@dn = @path[1..-1]
end
private :parse_dn
# Private method to cleanup +attributes+, +scope+, +filter+, and +extensions+
# from using the +query+ component attribute.
def parse_query
@attributes = nil
@scope = nil
@filter = nil
@extensions = nil
if @query
attrs, scope, filter, extensions = @query.split('?')
@attributes = attrs if attrs && attrs.size > 0
@scope = scope if scope && scope.size > 0
@filter = filter if filter && filter.size > 0
@extensions = extensions if extensions && extensions.size > 0
end
end
private :parse_query
# Private method to assemble +query+ from +attributes+, +scope+, +filter+, and +extensions+.
def build_path_query
@path = '/' + @dn
query = []
[@extensions, @filter, @scope, @attributes].each do |x|
next if !x && query.size == 0
query.unshift(x)
end
@query = query.join('?')
end
private :build_path_query
# Returns dn.
def dn
@dn
end
# Private setter for dn +val+.
def set_dn(val)
@dn = val
build_path_query
@dn
end
protected :set_dn
# Setter for dn +val+.
def dn=(val)
set_dn(val)
val
end
# Returns attributes.
def attributes
@attributes
end
# Private setter for attributes +val+.
def set_attributes(val)
@attributes = val
build_path_query
@attributes
end
protected :set_attributes
# Setter for attributes +val+.
def attributes=(val)
set_attributes(val)
val
end
# Returns scope.
def scope
@scope
end
# Private setter for scope +val+.
def set_scope(val)
@scope = val
build_path_query
@scope
end
protected :set_scope
# Setter for scope +val+.
def scope=(val)
set_scope(val)
val
end
# Returns filter.
def filter
@filter
end
# Private setter for filter +val+.
def set_filter(val)
@filter = val
build_path_query
@filter
end
protected :set_filter
# Setter for filter +val+.
def filter=(val)
set_filter(val)
val
end
# Returns extensions.
def extensions
@extensions
end
# Private setter for extensions +val+.
def set_extensions(val)
@extensions = val
build_path_query
@extensions
end
protected :set_extensions
# Setter for extensions +val+.
def extensions=(val)
set_extensions(val)
val
end
# Checks if URI has a path.
# For URI::LDAP this will return +false+.
def hierarchical?
false
end
end
register_scheme 'LDAP', LDAP
end
share/ruby/uri/ws.rb 0000644 00000004365 15173517737 0010434 0 ustar 00 # frozen_string_literal: false
# = uri/ws.rb
#
# Author:: Matt Muller <mamuller@amazon.com>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'generic'
module URI
#
# The syntax of WS URIs is defined in RFC6455 section 3.
#
# Note that the Ruby URI library allows WS URLs containing usernames and
# passwords. This is not legal as per the RFC, but used to be
# supported in Internet Explorer 5 and 6, before the MS04-004 security
# update. See <URL:http://support.microsoft.com/kb/834489>.
#
class WS < Generic
# A Default port of 80 for URI::WS.
DEFAULT_PORT = 80
# An Array of the available components for URI::WS.
COMPONENT = %i[
scheme
userinfo host port
path
query
].freeze
#
# == Description
#
# Creates a new URI::WS object from components, with syntax checking.
#
# The components accepted are userinfo, host, port, path, and query.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[userinfo, host, port, path, query]</code>.
#
# Example:
#
# uri = URI::WS.build(host: 'www.example.com', path: '/foo/bar')
#
# uri = URI::WS.build([nil, "www.example.com", nil, "/path", "query"])
#
# Currently, if passed userinfo components this method generates
# invalid WS URIs as per RFC 1738.
#
def self.build(args)
tmp = Util.make_components_hash(self, args)
super(tmp)
end
#
# == Description
#
# Returns the full path for a WS URI, as required by Net::HTTP::Get.
#
# If the URI contains a query, the full path is URI#path + '?' + URI#query.
# Otherwise, the path is simply URI#path.
#
# Example:
#
# uri = URI::WS.build(path: '/foo/bar', query: 'test=true')
# uri.request_uri # => "/foo/bar?test=true"
#
def request_uri
return unless @path
url = @query ? "#@path?#@query" : @path.dup
url.start_with?(?/.freeze) ? url : ?/ + url
end
end
register_scheme 'WS', WS
end
share/ruby/uri/ldaps.rb 0000644 00000000777 15173517737 0011111 0 ustar 00 # frozen_string_literal: false
# = uri/ldap.rb
#
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'ldap'
module URI
# The default port for LDAPS URIs is 636, and the scheme is 'ldaps:' rather
# than 'ldap:'. Other than that, LDAPS URIs are identical to LDAP URIs;
# see URI::LDAP.
class LDAPS < LDAP
# A Default port of 636 for URI::LDAPS
DEFAULT_PORT = 636
end
register_scheme 'LDAPS', LDAPS
end
share/ruby/uri/mailto.rb 0000644 00000017521 15173517737 0011266 0 ustar 00 # frozen_string_literal: false
# = uri/mailto.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'generic'
module URI
#
# RFC6068, the mailto URL scheme.
#
class MailTo < Generic
include RFC2396_REGEXP
# A Default port of nil for URI::MailTo.
DEFAULT_PORT = nil
# An Array of the available components for URI::MailTo.
COMPONENT = [ :scheme, :to, :headers ].freeze
# :stopdoc:
# "hname" and "hvalue" are encodings of an RFC 822 header name and
# value, respectively. As with "to", all URL reserved characters must
# be encoded.
#
# "#mailbox" is as specified in RFC 822 [RFC822]. This means that it
# consists of zero or more comma-separated mail addresses, possibly
# including "phrase" and "comment" components. Note that all URL
# reserved characters in "to" must be encoded: in particular,
# parentheses, commas, and the percent sign ("%"), which commonly occur
# in the "mailbox" syntax.
#
# Within mailto URLs, the characters "?", "=", "&" are reserved.
# ; RFC 6068
# hfields = "?" hfield *( "&" hfield )
# hfield = hfname "=" hfvalue
# hfname = *qchar
# hfvalue = *qchar
# qchar = unreserved / pct-encoded / some-delims
# some-delims = "!" / "$" / "'" / "(" / ")" / "*"
# / "+" / "," / ";" / ":" / "@"
#
# ; RFC3986
# unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
# pct-encoded = "%" HEXDIG HEXDIG
HEADER_REGEXP = /\A(?<hfield>(?:%\h\h|[!$'-.0-;@-Z_a-z~])*=(?:%\h\h|[!$'-.0-;@-Z_a-z~])*)(?:&\g<hfield>)*\z/
# practical regexp for email address
# https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address
EMAIL_REGEXP = /\A[a-zA-Z0-9.!\#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/
# :startdoc:
#
# == Description
#
# Creates a new URI::MailTo object from components, with syntax checking.
#
# Components can be provided as an Array or Hash. If an Array is used,
# the components must be supplied as <code>[to, headers]</code>.
#
# If a Hash is used, the keys are the component names preceded by colons.
#
# The headers can be supplied as a pre-encoded string, such as
# <code>"subject=subscribe&cc=address"</code>, or as an Array of Arrays
# like <code>[['subject', 'subscribe'], ['cc', 'address']]</code>.
#
# Examples:
#
# require 'uri'
#
# m1 = URI::MailTo.build(['joe@example.com', 'subject=Ruby'])
# m1.to_s # => "mailto:joe@example.com?subject=Ruby"
#
# m2 = URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]])
# m2.to_s # => "mailto:john@example.com?Subject=Ruby&Cc=jack@example.com"
#
# m3 = URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]})
# m3.to_s # => "mailto:listman@example.com?subject=subscribe"
#
def self.build(args)
tmp = Util.make_components_hash(self, args)
case tmp[:to]
when Array
tmp[:opaque] = tmp[:to].join(',')
when String
tmp[:opaque] = tmp[:to].dup
else
tmp[:opaque] = ''
end
if tmp[:headers]
query =
case tmp[:headers]
when Array
tmp[:headers].collect { |x|
if x.kind_of?(Array)
x[0] + '=' + x[1..-1].join
else
x.to_s
end
}.join('&')
when Hash
tmp[:headers].collect { |h,v|
h + '=' + v
}.join('&')
else
tmp[:headers].to_s
end
unless query.empty?
tmp[:opaque] << '?' << query
end
end
super(tmp)
end
#
# == Description
#
# Creates a new URI::MailTo object from generic URL components with
# no syntax checking.
#
# This method is usually called from URI::parse, which checks
# the validity of each component.
#
def initialize(*arg)
super(*arg)
@to = nil
@headers = []
# The RFC3986 parser does not normally populate opaque
@opaque = "?#{@query}" if @query && !@opaque
unless @opaque
raise InvalidComponentError,
"missing opaque part for mailto URL"
end
to, header = @opaque.split('?', 2)
# allow semicolon as a addr-spec separator
# http://support.microsoft.com/kb/820868
unless /\A(?:[^@,;]+@[^@,;]+(?:\z|[,;]))*\z/ =~ to
raise InvalidComponentError,
"unrecognised opaque part for mailtoURL: #{@opaque}"
end
if arg[10] # arg_check
self.to = to
self.headers = header
else
set_to(to)
set_headers(header)
end
end
# The primary e-mail address of the URL, as a String.
attr_reader :to
# E-mail headers set by the URL, as an Array of Arrays.
attr_reader :headers
# Checks the to +v+ component.
def check_to(v)
return true unless v
return true if v.size == 0
v.split(/[,;]/).each do |addr|
# check url safety as path-rootless
if /\A(?:%\h\h|[!$&-.0-;=@-Z_a-z~])*\z/ !~ addr
raise InvalidComponentError,
"an address in 'to' is invalid as URI #{addr.dump}"
end
# check addr-spec
# don't s/\+/ /g
addr.gsub!(/%\h\h/, URI::TBLDECWWWCOMP_)
if EMAIL_REGEXP !~ addr
raise InvalidComponentError,
"an address in 'to' is invalid as uri-escaped addr-spec #{addr.dump}"
end
end
true
end
private :check_to
# Private setter for to +v+.
def set_to(v)
@to = v
end
protected :set_to
# Setter for to +v+.
def to=(v)
check_to(v)
set_to(v)
v
end
# Checks the headers +v+ component against either
# * HEADER_REGEXP
def check_headers(v)
return true unless v
return true if v.size == 0
if HEADER_REGEXP !~ v
raise InvalidComponentError,
"bad component(expected opaque component): #{v}"
end
true
end
private :check_headers
# Private setter for headers +v+.
def set_headers(v)
@headers = []
if v
v.split('&').each do |x|
@headers << x.split(/=/, 2)
end
end
end
protected :set_headers
# Setter for headers +v+.
def headers=(v)
check_headers(v)
set_headers(v)
v
end
# Constructs String from URI.
def to_s
@scheme + ':' +
if @to
@to
else
''
end +
if @headers.size > 0
'?' + @headers.collect{|x| x.join('=')}.join('&')
else
''
end +
if @fragment
'#' + @fragment
else
''
end
end
# Returns the RFC822 e-mail text equivalent of the URL, as a String.
#
# Example:
#
# require 'uri'
#
# uri = URI.parse("mailto:ruby-list@ruby-lang.org?Subject=subscribe&cc=myaddr")
# uri.to_mailtext
# # => "To: ruby-list@ruby-lang.org\nSubject: subscribe\nCc: myaddr\n\n\n"
#
def to_mailtext
to = URI.decode_www_form_component(@to)
head = ''
body = ''
@headers.each do |x|
case x[0]
when 'body'
body = URI.decode_www_form_component(x[1])
when 'to'
to << ', ' + URI.decode_www_form_component(x[1])
else
head << URI.decode_www_form_component(x[0]).capitalize + ': ' +
URI.decode_www_form_component(x[1]) + "\n"
end
end
"To: #{to}
#{head}
#{body}
"
end
alias to_rfc822text to_mailtext
end
register_scheme 'MAILTO', MailTo
end
share/ruby/uri/file.rb 0000644 00000004370 15173517737 0010716 0 ustar 00 # frozen_string_literal: true
require_relative 'generic'
module URI
#
# The "file" URI is defined by RFC8089.
#
class File < Generic
# A Default port of nil for URI::File.
DEFAULT_PORT = nil
#
# An Array of the available components for URI::File.
#
COMPONENT = [
:scheme,
:host,
:path
].freeze
#
# == Description
#
# Creates a new URI::File object from components, with syntax checking.
#
# The components accepted are +host+ and +path+.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[host, path]</code>.
#
# A path from e.g. the File class should be escaped before
# being passed.
#
# Examples:
#
# require 'uri'
#
# uri1 = URI::File.build(['host.example.com', '/path/file.zip'])
# uri1.to_s # => "file://host.example.com/path/file.zip"
#
# uri2 = URI::File.build({:host => 'host.example.com',
# :path => '/ruby/src'})
# uri2.to_s # => "file://host.example.com/ruby/src"
#
# uri3 = URI::File.build({:path => URI::escape('/path/my file.txt')})
# uri3.to_s # => "file:///path/my%20file.txt"
#
def self.build(args)
tmp = Util::make_components_hash(self, args)
super(tmp)
end
# Protected setter for the host component +v+.
#
# See also URI::Generic.host=.
#
def set_host(v)
v = "" if v.nil? || v == "localhost"
@host = v
end
# do nothing
def set_port(v)
end
# raise InvalidURIError
def check_userinfo(user)
raise URI::InvalidURIError, "can not set userinfo for file URI"
end
# raise InvalidURIError
def check_user(user)
raise URI::InvalidURIError, "can not set user for file URI"
end
# raise InvalidURIError
def check_password(user)
raise URI::InvalidURIError, "can not set password for file URI"
end
# do nothing
def set_userinfo(v)
end
# do nothing
def set_user(v)
end
# do nothing
def set_password(v)
end
end
register_scheme 'FILE', File
end
share/ruby/uri/http.rb 0000644 00000007215 15173517737 0010757 0 ustar 00 # frozen_string_literal: false
# = uri/http.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See URI for general documentation
#
require_relative 'generic'
module URI
#
# The syntax of HTTP URIs is defined in RFC1738 section 3.3.
#
# Note that the Ruby URI library allows HTTP URLs containing usernames and
# passwords. This is not legal as per the RFC, but used to be
# supported in Internet Explorer 5 and 6, before the MS04-004 security
# update. See <URL:http://support.microsoft.com/kb/834489>.
#
class HTTP < Generic
# A Default port of 80 for URI::HTTP.
DEFAULT_PORT = 80
# An Array of the available components for URI::HTTP.
COMPONENT = %i[
scheme
userinfo host port
path
query
fragment
].freeze
#
# == Description
#
# Creates a new URI::HTTP object from components, with syntax checking.
#
# The components accepted are userinfo, host, port, path, query, and
# fragment.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[userinfo, host, port, path, query, fragment]</code>.
#
# Example:
#
# uri = URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')
#
# uri = URI::HTTP.build([nil, "www.example.com", nil, "/path",
# "query", 'fragment'])
#
# Currently, if passed userinfo components this method generates
# invalid HTTP URIs as per RFC 1738.
#
def self.build(args)
tmp = Util.make_components_hash(self, args)
super(tmp)
end
#
# == Description
#
# Returns the full path for an HTTP request, as required by Net::HTTP::Get.
#
# If the URI contains a query, the full path is URI#path + '?' + URI#query.
# Otherwise, the path is simply URI#path.
#
# Example:
#
# uri = URI::HTTP.build(path: '/foo/bar', query: 'test=true')
# uri.request_uri # => "/foo/bar?test=true"
#
def request_uri
return unless @path
url = @query ? "#@path?#@query" : @path.dup
url.start_with?(?/.freeze) ? url : ?/ + url
end
#
# == Description
#
# Returns the authority for an HTTP uri, as defined in
# https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.
#
#
# Example:
#
# URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').authority #=> "www.example.com"
# URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').authority #=> "www.example.com:8000"
# URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').authority #=> "www.example.com"
#
def authority
if port == default_port
host
else
"#{host}:#{port}"
end
end
#
# == Description
#
# Returns the origin for an HTTP uri, as defined in
# https://datatracker.ietf.org/doc/html/rfc6454.
#
#
# Example:
#
# URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').origin #=> "http://www.example.com"
# URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').origin #=> "http://www.example.com:8000"
# URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').origin #=> "http://www.example.com"
# URI::HTTPS.build(host: 'www.example.com', path: '/foo/bar').origin #=> "https://www.example.com"
#
def origin
"#{scheme}://#{authority}"
end
end
register_scheme 'HTTP', HTTP
end
share/ruby/open3/version.rb 0000644 00000000045 15173517737 0011704 0 ustar 00 module Open3
VERSION = "0.2.1"
end
share/ruby/ripper.rb 0000644 00000004676 15173517737 0010512 0 ustar 00 # frozen_string_literal: true
require 'ripper/core'
require 'ripper/lexer'
require 'ripper/filter'
require 'ripper/sexp'
# Ripper is a Ruby script parser.
#
# You can get information from the parser with event-based style.
# Information such as abstract syntax trees or simple lexical analysis of the
# Ruby program.
#
# == Usage
#
# Ripper provides an easy interface for parsing your program into a symbolic
# expression tree (or S-expression).
#
# Understanding the output of the parser may come as a challenge, it's
# recommended you use PP to format the output for legibility.
#
# require 'ripper'
# require 'pp'
#
# pp Ripper.sexp('def hello(world) "Hello, #{world}!"; end')
# #=> [:program,
# [[:def,
# [:@ident, "hello", [1, 4]],
# [:paren,
# [:params, [[:@ident, "world", [1, 10]]], nil, nil, nil, nil, nil, nil]],
# [:bodystmt,
# [[:string_literal,
# [:string_content,
# [:@tstring_content, "Hello, ", [1, 18]],
# [:string_embexpr, [[:var_ref, [:@ident, "world", [1, 27]]]]],
# [:@tstring_content, "!", [1, 33]]]]],
# nil,
# nil,
# nil]]]]
#
# You can see in the example above, the expression starts with +:program+.
#
# From here, a method definition at +:def+, followed by the method's identifier
# <code>:@ident</code>. After the method's identifier comes the parentheses
# +:paren+ and the method parameters under +:params+.
#
# Next is the method body, starting at +:bodystmt+ (+stmt+ meaning statement),
# which contains the full definition of the method.
#
# In our case, we're simply returning a String, so next we have the
# +:string_literal+ expression.
#
# Within our +:string_literal+ you'll notice two <code>@tstring_content</code>,
# this is the literal part for <code>Hello, </code> and <code>!</code>. Between
# the two <code>@tstring_content</code> statements is a +:string_embexpr+,
# where _embexpr_ is an embedded expression. Our expression consists of a local
# variable, or +var_ref+, with the identifier (<code>@ident</code>) of +world+.
#
# == Resources
#
# * {Ruby Inside}[http://www.rubyinside.com/using-ripper-to-see-how-ruby-is-parsing-your-code-5270.html]
#
# == Requirements
#
# * ruby 1.9 (support CVS HEAD only)
# * bison 1.28 or later (Other yaccs do not work)
#
# == License
#
# Ruby License.
#
# - Minero Aoki
# - aamine@loveruby.net
# - http://i.loveruby.net
class Ripper; end
share/ruby/net/https.rb 0000644 00000001023 15173517737 0011120 0 ustar 00 # frozen_string_literal: true
=begin
= net/https -- SSL/TLS enhancement for Net::HTTP.
This file has been merged with net/http. There is no longer any need to
require 'net/https' to use HTTPS.
See Net::HTTP for details on how to make HTTPS connections.
== Info
'OpenSSL for Ruby 2' project
Copyright (C) 2001 GOTOU Yuuzou <gotoyuzo@notwork.org>
All rights reserved.
== Licence
This program is licensed under the same licence as Ruby.
(See the file 'LICENCE'.)
=end
require_relative 'http'
require 'openssl'
share/ruby/net/http/requests.rb 0000644 00000031537 15173517737 0012625 0 ustar 00 # frozen_string_literal: true
# HTTP/1.1 methods --- RFC2616
# \Class for representing
# {HTTP method GET}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#GET_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Get.new(uri) # => #<Net::HTTP::Get GET>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: optional.
# - Response body: yes.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: yes.
#
# Related:
#
# - Net::HTTP.get: sends +GET+ request, returns response body.
# - Net::HTTP#get: sends +GET+ request, returns response object.
#
class Net::HTTP::Get < Net::HTTPRequest
METHOD = 'GET'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {HTTP method HEAD}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#HEAD_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Head.new(uri) # => #<Net::HTTP::Head HEAD>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: optional.
# - Response body: no.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: yes.
#
# Related:
#
# - Net::HTTP#head: sends +HEAD+ request, returns response object.
#
class Net::HTTP::Head < Net::HTTPRequest
METHOD = 'HEAD'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = false
end
# \Class for representing
# {HTTP method POST}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#POST_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# uri.path = '/posts'
# req = Net::HTTP::Post.new(uri) # => #<Net::HTTP::Post POST>
# req.body = '{"title": "foo","body": "bar","userId": 1}'
# req.content_type = 'application/json'
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: yes.
# - Response body: yes.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: no.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: yes.
#
# Related:
#
# - Net::HTTP.post: sends +POST+ request, returns response object.
# - Net::HTTP#post: sends +POST+ request, returns response object.
#
class Net::HTTP::Post < Net::HTTPRequest
METHOD = 'POST'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {HTTP method PUT}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#PUT_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# uri.path = '/posts'
# req = Net::HTTP::Put.new(uri) # => #<Net::HTTP::Put PUT>
# req.body = '{"title": "foo","body": "bar","userId": 1}'
# req.content_type = 'application/json'
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: yes.
# - Response body: yes.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no.
#
class Net::HTTP::Put < Net::HTTPRequest
METHOD = 'PUT'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {HTTP method DELETE}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#DELETE_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# uri.path = '/posts/1'
# req = Net::HTTP::Delete.new(uri) # => #<Net::HTTP::Delete DELETE>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: optional.
# - Response body: yes.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no.
#
# Related:
#
# - Net::HTTP#delete: sends +DELETE+ request, returns response object.
#
class Net::HTTP::Delete < Net::HTTPRequest
METHOD = 'DELETE'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {HTTP method OPTIONS}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#OPTIONS_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Options.new(uri) # => #<Net::HTTP::Options OPTIONS>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: optional.
# - Response body: yes.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no.
#
# Related:
#
# - Net::HTTP#options: sends +OPTIONS+ request, returns response object.
#
class Net::HTTP::Options < Net::HTTPRequest
METHOD = 'OPTIONS'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {HTTP method TRACE}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#TRACE_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Trace.new(uri) # => #<Net::HTTP::Trace TRACE>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: no.
# - Response body: yes.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: yes.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: yes.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no.
#
# Related:
#
# - Net::HTTP#trace: sends +TRACE+ request, returns response object.
#
class Net::HTTP::Trace < Net::HTTPRequest
METHOD = 'TRACE'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {HTTP method PATCH}[https://en.wikipedia.org/w/index.php?title=Hypertext_Transfer_Protocol#PATCH_method]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# uri.path = '/posts'
# req = Net::HTTP::Patch.new(uri) # => #<Net::HTTP::Patch PATCH>
# req.body = '{"title": "foo","body": "bar","userId": 1}'
# req.content_type = 'application/json'
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Properties:
#
# - Request body: yes.
# - Response body: yes.
# - {Safe}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Safe_methods]: no.
# - {Idempotent}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Idempotent_methods]: no.
# - {Cacheable}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Cacheable_methods]: no.
#
# Related:
#
# - Net::HTTP#patch: sends +PATCH+ request, returns response object.
#
class Net::HTTP::Patch < Net::HTTPRequest
METHOD = 'PATCH'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
#
# WebDAV methods --- RFC2518
#
# \Class for representing
# {WebDAV method PROPFIND}[http://www.webdav.org/specs/rfc4918.html#METHOD_PROPFIND]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Propfind.new(uri) # => #<Net::HTTP::Propfind PROPFIND>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Related:
#
# - Net::HTTP#propfind: sends +PROPFIND+ request, returns response object.
#
class Net::HTTP::Propfind < Net::HTTPRequest
METHOD = 'PROPFIND'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {WebDAV method PROPPATCH}[http://www.webdav.org/specs/rfc4918.html#METHOD_PROPPATCH]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Proppatch.new(uri) # => #<Net::HTTP::Proppatch PROPPATCH>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Related:
#
# - Net::HTTP#proppatch: sends +PROPPATCH+ request, returns response object.
#
class Net::HTTP::Proppatch < Net::HTTPRequest
METHOD = 'PROPPATCH'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {WebDAV method MKCOL}[http://www.webdav.org/specs/rfc4918.html#METHOD_MKCOL]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Mkcol.new(uri) # => #<Net::HTTP::Mkcol MKCOL>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Related:
#
# - Net::HTTP#mkcol: sends +MKCOL+ request, returns response object.
#
class Net::HTTP::Mkcol < Net::HTTPRequest
METHOD = 'MKCOL'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {WebDAV method COPY}[http://www.webdav.org/specs/rfc4918.html#METHOD_COPY]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Copy.new(uri) # => #<Net::HTTP::Copy COPY>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Related:
#
# - Net::HTTP#copy: sends +COPY+ request, returns response object.
#
class Net::HTTP::Copy < Net::HTTPRequest
METHOD = 'COPY'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {WebDAV method MOVE}[http://www.webdav.org/specs/rfc4918.html#METHOD_MOVE]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Move.new(uri) # => #<Net::HTTP::Move MOVE>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Related:
#
# - Net::HTTP#move: sends +MOVE+ request, returns response object.
#
class Net::HTTP::Move < Net::HTTPRequest
METHOD = 'MOVE'
REQUEST_HAS_BODY = false
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {WebDAV method LOCK}[http://www.webdav.org/specs/rfc4918.html#METHOD_LOCK]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Lock.new(uri) # => #<Net::HTTP::Lock LOCK>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Related:
#
# - Net::HTTP#lock: sends +LOCK+ request, returns response object.
#
class Net::HTTP::Lock < Net::HTTPRequest
METHOD = 'LOCK'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
# \Class for representing
# {WebDAV method UNLOCK}[http://www.webdav.org/specs/rfc4918.html#METHOD_UNLOCK]:
#
# require 'net/http'
# uri = URI('http://example.com')
# hostname = uri.hostname # => "example.com"
# req = Net::HTTP::Unlock.new(uri) # => #<Net::HTTP::Unlock UNLOCK>
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# See {Request Headers}[rdoc-ref:Net::HTTPRequest@Request+Headers].
#
# Related:
#
# - Net::HTTP#unlock: sends +UNLOCK+ request, returns response object.
#
class Net::HTTP::Unlock < Net::HTTPRequest
METHOD = 'UNLOCK'
REQUEST_HAS_BODY = true
RESPONSE_HAS_BODY = true
end
share/ruby/net/http/request.rb 0000644 00000005465 15173517737 0012443 0 ustar 00 # frozen_string_literal: true
# This class is the base class for \Net::HTTP request classes.
# The class should not be used directly;
# instead you should use its subclasses, listed below.
#
# == Creating a Request
#
# An request object may be created with either a URI or a string hostname:
#
# require 'net/http'
# uri = URI('https://jsonplaceholder.typicode.com/')
# req = Net::HTTP::Get.new(uri) # => #<Net::HTTP::Get GET>
# req = Net::HTTP::Get.new(uri.hostname) # => #<Net::HTTP::Get GET>
#
# And with any of the subclasses:
#
# req = Net::HTTP::Head.new(uri) # => #<Net::HTTP::Head HEAD>
# req = Net::HTTP::Post.new(uri) # => #<Net::HTTP::Post POST>
# req = Net::HTTP::Put.new(uri) # => #<Net::HTTP::Put PUT>
# # ...
#
# The new instance is suitable for use as the argument to Net::HTTP#request.
#
# == Request Headers
#
# A new request object has these header fields by default:
#
# req.to_hash
# # =>
# {"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"],
# "accept"=>["*/*"],
# "user-agent"=>["Ruby"],
# "host"=>["jsonplaceholder.typicode.com"]}
#
# See:
#
# - {Request header Accept-Encoding}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Accept-Encoding]
# and {Compression and Decompression}[rdoc-ref:Net::HTTP@Compression+and+Decompression].
# - {Request header Accept}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#accept-request-header].
# - {Request header User-Agent}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#user-agent-request-header].
# - {Request header Host}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#host-request-header].
#
# You can add headers or override default headers:
#
# # res = Net::HTTP::Get.new(uri, {'foo' => '0', 'bar' => '1'})
#
# This class (and therefore its subclasses) also includes (indirectly)
# module Net::HTTPHeader, which gives access to its
# {methods for setting headers}[rdoc-ref:Net::HTTPHeader@Setters].
#
# == Request Subclasses
#
# Subclasses for HTTP requests:
#
# - Net::HTTP::Get
# - Net::HTTP::Head
# - Net::HTTP::Post
# - Net::HTTP::Put
# - Net::HTTP::Delete
# - Net::HTTP::Options
# - Net::HTTP::Trace
# - Net::HTTP::Patch
#
# Subclasses for WebDAV requests:
#
# - Net::HTTP::Propfind
# - Net::HTTP::Proppatch
# - Net::HTTP::Mkcol
# - Net::HTTP::Copy
# - Net::HTTP::Move
# - Net::HTTP::Lock
# - Net::HTTP::Unlock
#
class Net::HTTPRequest < Net::HTTPGenericRequest
# Creates an HTTP request object for +path+.
#
# +initheader+ are the default headers to use. Net::HTTP adds
# Accept-Encoding to enable compression of the response body unless
# Accept-Encoding or Range are supplied in +initheader+.
def initialize(path, initheader = nil)
super self.class::METHOD,
self.class::REQUEST_HAS_BODY,
self.class::RESPONSE_HAS_BODY,
path, initheader
end
end
share/ruby/net/http/generic_request.rb 0000644 00000030160 15173517737 0014125 0 ustar 00 # frozen_string_literal: true
#
# \HTTPGenericRequest is the parent of the Net::HTTPRequest class.
#
# Do not use this directly; instead, use a subclass of Net::HTTPRequest.
#
# == About the Examples
#
# :include: doc/net-http/examples.rdoc
#
class Net::HTTPGenericRequest
include Net::HTTPHeader
def initialize(m, reqbody, resbody, uri_or_path, initheader = nil) # :nodoc:
@method = m
@request_has_body = reqbody
@response_has_body = resbody
if URI === uri_or_path then
raise ArgumentError, "not an HTTP URI" unless URI::HTTP === uri_or_path
hostname = uri_or_path.hostname
raise ArgumentError, "no host component for URI" unless (hostname && hostname.length > 0)
@uri = uri_or_path.dup
host = @uri.hostname.dup
host << ":" << @uri.port.to_s if @uri.port != @uri.default_port
@path = uri_or_path.request_uri
raise ArgumentError, "no HTTP request path given" unless @path
else
@uri = nil
host = nil
raise ArgumentError, "no HTTP request path given" unless uri_or_path
raise ArgumentError, "HTTP request path is empty" if uri_or_path.empty?
@path = uri_or_path.dup
end
@decode_content = false
if Net::HTTP::HAVE_ZLIB then
if !initheader ||
!initheader.keys.any? { |k|
%w[accept-encoding range].include? k.downcase
} then
@decode_content = true if @response_has_body
initheader = initheader ? initheader.dup : {}
initheader["accept-encoding"] =
"gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
end
end
initialize_http_header initheader
self['Accept'] ||= '*/*'
self['User-Agent'] ||= 'Ruby'
self['Host'] ||= host if host
@body = nil
@body_stream = nil
@body_data = nil
end
# Returns the string method name for the request:
#
# Net::HTTP::Get.new(uri).method # => "GET"
# Net::HTTP::Post.new(uri).method # => "POST"
#
attr_reader :method
# Returns the string path for the request:
#
# Net::HTTP::Get.new(uri).path # => "/"
# Net::HTTP::Post.new('example.com').path # => "example.com"
#
attr_reader :path
# Returns the URI object for the request, or +nil+ if none:
#
# Net::HTTP::Get.new(uri).uri
# # => #<URI::HTTPS https://jsonplaceholder.typicode.com/>
# Net::HTTP::Get.new('example.com').uri # => nil
#
attr_reader :uri
# Returns +false+ if the request's header <tt>'Accept-Encoding'</tt>
# has been set manually or deleted
# (indicating that the user intends to handle encoding in the response),
# +true+ otherwise:
#
# req = Net::HTTP::Get.new(uri) # => #<Net::HTTP::Get GET>
# req['Accept-Encoding'] # => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
# req.decode_content # => true
# req['Accept-Encoding'] = 'foo'
# req.decode_content # => false
# req.delete('Accept-Encoding')
# req.decode_content # => false
#
attr_reader :decode_content
# Returns a string representation of the request:
#
# Net::HTTP::Post.new(uri).inspect # => "#<Net::HTTP::Post POST>"
#
def inspect
"\#<#{self.class} #{@method}>"
end
##
# Don't automatically decode response content-encoding if the user indicates
# they want to handle it.
def []=(key, val) # :nodoc:
@decode_content = false if key.downcase == 'accept-encoding'
super key, val
end
# Returns whether the request may have a body:
#
# Net::HTTP::Post.new(uri).request_body_permitted? # => true
# Net::HTTP::Get.new(uri).request_body_permitted? # => false
#
def request_body_permitted?
@request_has_body
end
# Returns whether the response may have a body:
#
# Net::HTTP::Post.new(uri).response_body_permitted? # => true
# Net::HTTP::Head.new(uri).response_body_permitted? # => false
#
def response_body_permitted?
@response_has_body
end
def body_exist? # :nodoc:
warn "Net::HTTPRequest#body_exist? is obsolete; use response_body_permitted?", uplevel: 1 if $VERBOSE
response_body_permitted?
end
# Returns the string body for the request, or +nil+ if there is none:
#
# req = Net::HTTP::Post.new(uri)
# req.body # => nil
# req.body = '{"title": "foo","body": "bar","userId": 1}'
# req.body # => "{\"title\": \"foo\",\"body\": \"bar\",\"userId\": 1}"
#
attr_reader :body
# Sets the body for the request:
#
# req = Net::HTTP::Post.new(uri)
# req.body # => nil
# req.body = '{"title": "foo","body": "bar","userId": 1}'
# req.body # => "{\"title\": \"foo\",\"body\": \"bar\",\"userId\": 1}"
#
def body=(str)
@body = str
@body_stream = nil
@body_data = nil
str
end
# Returns the body stream object for the request, or +nil+ if there is none:
#
# req = Net::HTTP::Post.new(uri) # => #<Net::HTTP::Post POST>
# req.body_stream # => nil
# require 'stringio'
# req.body_stream = StringIO.new('xyzzy') # => #<StringIO:0x0000027d1e5affa8>
# req.body_stream # => #<StringIO:0x0000027d1e5affa8>
#
attr_reader :body_stream
# Sets the body stream for the request:
#
# req = Net::HTTP::Post.new(uri) # => #<Net::HTTP::Post POST>
# req.body_stream # => nil
# require 'stringio'
# req.body_stream = StringIO.new('xyzzy') # => #<StringIO:0x0000027d1e5affa8>
# req.body_stream # => #<StringIO:0x0000027d1e5affa8>
#
def body_stream=(input)
@body = nil
@body_stream = input
@body_data = nil
input
end
def set_body_internal(str) #:nodoc: internal use only
raise ArgumentError, "both of body argument and HTTPRequest#body set" if str and (@body or @body_stream)
self.body = str if str
if @body.nil? && @body_stream.nil? && @body_data.nil? && request_body_permitted?
self.body = ''
end
end
#
# write
#
def exec(sock, ver, path) #:nodoc: internal use only
if @body
send_request_with_body sock, ver, path, @body
elsif @body_stream
send_request_with_body_stream sock, ver, path, @body_stream
elsif @body_data
send_request_with_body_data sock, ver, path, @body_data
else
write_header sock, ver, path
end
end
def update_uri(addr, port, ssl) # :nodoc: internal use only
# reflect the connection and @path to @uri
return unless @uri
if ssl
scheme = 'https'
klass = URI::HTTPS
else
scheme = 'http'
klass = URI::HTTP
end
if host = self['host']
host.sub!(/:.*/m, '')
elsif host = @uri.host
else
host = addr
end
# convert the class of the URI
if @uri.is_a?(klass)
@uri.host = host
@uri.port = port
else
@uri = klass.new(
scheme, @uri.userinfo,
host, port, nil,
@uri.path, nil, @uri.query, nil)
end
end
private
class Chunker #:nodoc:
def initialize(sock)
@sock = sock
@prev = nil
end
def write(buf)
# avoid memcpy() of buf, buf can huge and eat memory bandwidth
rv = buf.bytesize
@sock.write("#{rv.to_s(16)}\r\n", buf, "\r\n")
rv
end
def finish
@sock.write("0\r\n\r\n")
end
end
def send_request_with_body(sock, ver, path, body)
self.content_length = body.bytesize
delete 'Transfer-Encoding'
supply_default_content_type
write_header sock, ver, path
wait_for_continue sock, ver if sock.continue_timeout
sock.write body
end
def send_request_with_body_stream(sock, ver, path, f)
unless content_length() or chunked?
raise ArgumentError,
"Content-Length not given and Transfer-Encoding is not `chunked'"
end
supply_default_content_type
write_header sock, ver, path
wait_for_continue sock, ver if sock.continue_timeout
if chunked?
chunker = Chunker.new(sock)
IO.copy_stream(f, chunker)
chunker.finish
else
IO.copy_stream(f, sock)
end
end
def send_request_with_body_data(sock, ver, path, params)
if /\Amultipart\/form-data\z/i !~ self.content_type
self.content_type = 'application/x-www-form-urlencoded'
return send_request_with_body(sock, ver, path, URI.encode_www_form(params))
end
opt = @form_option.dup
require 'securerandom' unless defined?(SecureRandom)
opt[:boundary] ||= SecureRandom.urlsafe_base64(40)
self.set_content_type(self.content_type, boundary: opt[:boundary])
if chunked?
write_header sock, ver, path
encode_multipart_form_data(sock, params, opt)
else
require 'tempfile'
file = Tempfile.new('multipart')
file.binmode
encode_multipart_form_data(file, params, opt)
file.rewind
self.content_length = file.size
write_header sock, ver, path
IO.copy_stream(file, sock)
file.close(true)
end
end
def encode_multipart_form_data(out, params, opt)
charset = opt[:charset]
boundary = opt[:boundary]
require 'securerandom' unless defined?(SecureRandom)
boundary ||= SecureRandom.urlsafe_base64(40)
chunked_p = chunked?
buf = +''
params.each do |key, value, h={}|
key = quote_string(key, charset)
filename =
h.key?(:filename) ? h[:filename] :
value.respond_to?(:to_path) ? File.basename(value.to_path) :
nil
buf << "--#{boundary}\r\n"
if filename
filename = quote_string(filename, charset)
type = h[:content_type] || 'application/octet-stream'
buf << "Content-Disposition: form-data; " \
"name=\"#{key}\"; filename=\"#{filename}\"\r\n" \
"Content-Type: #{type}\r\n\r\n"
if !out.respond_to?(:write) || !value.respond_to?(:read)
# if +out+ is not an IO or +value+ is not an IO
buf << (value.respond_to?(:read) ? value.read : value)
elsif value.respond_to?(:size) && chunked_p
# if +out+ is an IO and +value+ is a File, use IO.copy_stream
flush_buffer(out, buf, chunked_p)
out << "%x\r\n" % value.size if chunked_p
IO.copy_stream(value, out)
out << "\r\n" if chunked_p
else
# +out+ is an IO, and +value+ is not a File but an IO
flush_buffer(out, buf, chunked_p)
1 while flush_buffer(out, value.read(4096), chunked_p)
end
else
# non-file field:
# HTML5 says, "The parts of the generated multipart/form-data
# resource that correspond to non-file fields must not have a
# Content-Type header specified."
buf << "Content-Disposition: form-data; name=\"#{key}\"\r\n\r\n"
buf << (value.respond_to?(:read) ? value.read : value)
end
buf << "\r\n"
end
buf << "--#{boundary}--\r\n"
flush_buffer(out, buf, chunked_p)
out << "0\r\n\r\n" if chunked_p
end
def quote_string(str, charset)
str = str.encode(charset, fallback:->(c){'&#%d;'%c.encode("UTF-8").ord}) if charset
str.gsub(/[\\"]/, '\\\\\&')
end
def flush_buffer(out, buf, chunked_p)
return unless buf
out << "%x\r\n"%buf.bytesize if chunked_p
out << buf
out << "\r\n" if chunked_p
buf.clear
end
def supply_default_content_type
return if content_type()
warn 'net/http: Content-Type did not set; using application/x-www-form-urlencoded', uplevel: 1 if $VERBOSE
set_content_type 'application/x-www-form-urlencoded'
end
##
# Waits up to the continue timeout for a response from the server provided
# we're speaking HTTP 1.1 and are expecting a 100-continue response.
def wait_for_continue(sock, ver)
if ver >= '1.1' and @header['expect'] and
@header['expect'].include?('100-continue')
if sock.io.to_io.wait_readable(sock.continue_timeout)
res = Net::HTTPResponse.read_new(sock)
unless res.kind_of?(Net::HTTPContinue)
res.decode_content = @decode_content
throw :response, res
end
end
end
end
def write_header(sock, ver, path)
reqline = "#{@method} #{path} HTTP/#{ver}"
if /[\r\n]/ =~ reqline
raise ArgumentError, "A Request-Line must not contain CR or LF"
end
buf = +''
buf << reqline << "\r\n"
each_capitalized do |k,v|
buf << "#{k}: #{v}\r\n"
end
buf << "\r\n"
sock.write buf
end
end
share/ruby/net/http/status.rb 0000644 00000004373 15173517737 0012273 0 ustar 00 # frozen_string_literal: true
require_relative '../http'
if $0 == __FILE__
require 'open-uri'
File.foreach(__FILE__) do |line|
puts line
break if line.start_with?('end')
end
puts
puts "Net::HTTP::STATUS_CODES = {"
url = "https://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv"
URI(url).read.each_line do |line|
code, mes, = line.split(',')
next if ['(Unused)', 'Unassigned', 'Description'].include?(mes)
puts " #{code} => '#{mes}',"
end
puts "} # :nodoc:"
end
Net::HTTP::STATUS_CODES = {
100 => 'Continue',
101 => 'Switching Protocols',
102 => 'Processing',
103 => 'Early Hints',
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
207 => 'Multi-Status',
208 => 'Already Reported',
226 => 'IM Used',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
307 => 'Temporary Redirect',
308 => 'Permanent Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Content Too Large',
414 => 'URI Too Long',
415 => 'Unsupported Media Type',
416 => 'Range Not Satisfiable',
417 => 'Expectation Failed',
421 => 'Misdirected Request',
422 => 'Unprocessable Content',
423 => 'Locked',
424 => 'Failed Dependency',
425 => 'Too Early',
426 => 'Upgrade Required',
428 => 'Precondition Required',
429 => 'Too Many Requests',
431 => 'Request Header Fields Too Large',
451 => 'Unavailable For Legal Reasons',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported',
506 => 'Variant Also Negotiates',
507 => 'Insufficient Storage',
508 => 'Loop Detected',
510 => 'Not Extended (OBSOLETED)',
511 => 'Network Authentication Required',
} # :nodoc:
share/ruby/net/http/proxy_delta.rb 0000644 00000000417 15173517737 0013275 0 ustar 00 # frozen_string_literal: true
module Net::HTTP::ProxyDelta #:nodoc: internal use only
private
def conn_address
proxy_address()
end
def conn_port
proxy_port()
end
def edit_path(path)
use_ssl? ? path : "http://#{addr_port()}#{path}"
end
end
share/ruby/net/http/header.rb 0000644 00000100002 15173517737 0012162 0 ustar 00 # frozen_string_literal: true
#
# The \HTTPHeader module provides access to \HTTP headers.
#
# The module is included in:
#
# - Net::HTTPGenericRequest (and therefore Net::HTTPRequest).
# - Net::HTTPResponse.
#
# The headers are a hash-like collection of key/value pairs called _fields_.
#
# == Request and Response Fields
#
# Headers may be included in:
#
# - A Net::HTTPRequest object:
# the object's headers will be sent with the request.
# Any fields may be defined in the request;
# see {Setters}[rdoc-ref:Net::HTTPHeader@Setters].
# - A Net::HTTPResponse object:
# the objects headers are usually those returned from the host.
# Fields may be retrieved from the object;
# see {Getters}[rdoc-ref:Net::HTTPHeader@Getters]
# and {Iterators}[rdoc-ref:Net::HTTPHeader@Iterators].
#
# Exactly which fields should be sent or expected depends on the host;
# see:
#
# - {Request fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields].
# - {Response fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Response_fields].
#
# == About the Examples
#
# :include: doc/net-http/examples.rdoc
#
# == Fields
#
# A header field is a key/value pair.
#
# === Field Keys
#
# A field key may be:
#
# - A string: Key <tt>'Accept'</tt> is treated as if it were
# <tt>'Accept'.downcase</tt>; i.e., <tt>'accept'</tt>.
# - A symbol: Key <tt>:Accept</tt> is treated as if it were
# <tt>:Accept.to_s.downcase</tt>; i.e., <tt>'accept'</tt>.
#
# Examples:
#
# req = Net::HTTP::Get.new(uri)
# req[:accept] # => "*/*"
# req['Accept'] # => "*/*"
# req['ACCEPT'] # => "*/*"
#
# req['accept'] = 'text/html'
# req[:accept] = 'text/html'
# req['ACCEPT'] = 'text/html'
#
# === Field Values
#
# A field value may be returned as an array of strings or as a string:
#
# - These methods return field values as arrays:
#
# - #get_fields: Returns the array value for the given key,
# or +nil+ if it does not exist.
# - #to_hash: Returns a hash of all header fields:
# each key is a field name; its value is the array value for the field.
#
# - These methods return field values as string;
# the string value for a field is equivalent to
# <tt>self[key.downcase.to_s].join(', '))</tt>:
#
# - #[]: Returns the string value for the given key,
# or +nil+ if it does not exist.
# - #fetch: Like #[], but accepts a default value
# to be returned if the key does not exist.
#
# The field value may be set:
#
# - #[]=: Sets the value for the given key;
# the given value may be a string, a symbol, an array, or a hash.
# - #add_field: Adds a given value to a value for the given key
# (not overwriting the existing value).
# - #delete: Deletes the field for the given key.
#
# Example field values:
#
# - \String:
#
# req['Accept'] = 'text/html' # => "text/html"
# req['Accept'] # => "text/html"
# req.get_fields('Accept') # => ["text/html"]
#
# - \Symbol:
#
# req['Accept'] = :text # => :text
# req['Accept'] # => "text"
# req.get_fields('Accept') # => ["text"]
#
# - Simple array:
#
# req[:foo] = %w[bar baz bat]
# req[:foo] # => "bar, baz, bat"
# req.get_fields(:foo) # => ["bar", "baz", "bat"]
#
# - Simple hash:
#
# req[:foo] = {bar: 0, baz: 1, bat: 2}
# req[:foo] # => "bar, 0, baz, 1, bat, 2"
# req.get_fields(:foo) # => ["bar", "0", "baz", "1", "bat", "2"]
#
# - Nested:
#
# req[:foo] = [%w[bar baz], {bat: 0, bam: 1}]
# req[:foo] # => "bar, baz, bat, 0, bam, 1"
# req.get_fields(:foo) # => ["bar", "baz", "bat", "0", "bam", "1"]
#
# req[:foo] = {bar: %w[baz bat], bam: {bah: 0, bad: 1}}
# req[:foo] # => "bar, baz, bat, bam, bah, 0, bad, 1"
# req.get_fields(:foo) # => ["bar", "baz", "bat", "bam", "bah", "0", "bad", "1"]
#
# == Convenience Methods
#
# Various convenience methods retrieve values, set values, query values,
# set form values, or iterate over fields.
#
# === Setters
#
# \Method #[]= can set any field, but does little to validate the new value;
# some of the other setter methods provide some validation:
#
# - #[]=: Sets the string or array value for the given key.
# - #add_field: Creates or adds to the array value for the given key.
# - #basic_auth: Sets the string authorization header for <tt>'Authorization'</tt>.
# - #content_length=: Sets the integer length for field <tt>'Content-Length</tt>.
# - #content_type=: Sets the string value for field <tt>'Content-Type'</tt>.
# - #proxy_basic_auth: Sets the string authorization header for <tt>'Proxy-Authorization'</tt>.
# - #set_range: Sets the value for field <tt>'Range'</tt>.
#
# === Form Setters
#
# - #set_form: Sets an HTML form data set.
# - #set_form_data: Sets header fields and a body from HTML form data.
#
# === Getters
#
# \Method #[] can retrieve the value of any field that exists,
# but always as a string;
# some of the other getter methods return something different
# from the simple string value:
#
# - #[]: Returns the string field value for the given key.
# - #content_length: Returns the integer value of field <tt>'Content-Length'</tt>.
# - #content_range: Returns the Range value of field <tt>'Content-Range'</tt>.
# - #content_type: Returns the string value of field <tt>'Content-Type'</tt>.
# - #fetch: Returns the string field value for the given key.
# - #get_fields: Returns the array field value for the given +key+.
# - #main_type: Returns first part of the string value of field <tt>'Content-Type'</tt>.
# - #sub_type: Returns second part of the string value of field <tt>'Content-Type'</tt>.
# - #range: Returns an array of Range objects of field <tt>'Range'</tt>, or +nil+.
# - #range_length: Returns the integer length of the range given in field <tt>'Content-Range'</tt>.
# - #type_params: Returns the string parameters for <tt>'Content-Type'</tt>.
#
# === Queries
#
# - #chunked?: Returns whether field <tt>'Transfer-Encoding'</tt> is set to <tt>'chunked'</tt>.
# - #connection_close?: Returns whether field <tt>'Connection'</tt> is set to <tt>'close'</tt>.
# - #connection_keep_alive?: Returns whether field <tt>'Connection'</tt> is set to <tt>'keep-alive'</tt>.
# - #key?: Returns whether a given key exists.
#
# === Iterators
#
# - #each_capitalized: Passes each field capitalized-name/value pair to the block.
# - #each_capitalized_name: Passes each capitalized field name to the block.
# - #each_header: Passes each field name/value pair to the block.
# - #each_name: Passes each field name to the block.
# - #each_value: Passes each string field value to the block.
#
module Net::HTTPHeader
MAX_KEY_LENGTH = 1024
MAX_FIELD_LENGTH = 65536
def initialize_http_header(initheader) #:nodoc:
@header = {}
return unless initheader
initheader.each do |key, value|
warn "net/http: duplicated HTTP header: #{key}", uplevel: 3 if key?(key) and $VERBOSE
if value.nil?
warn "net/http: nil HTTP header: #{key}", uplevel: 3 if $VERBOSE
else
value = value.strip # raise error for invalid byte sequences
if key.to_s.bytesize > MAX_KEY_LENGTH
raise ArgumentError, "too long (#{key.bytesize} bytes) header: #{key[0, 30].inspect}..."
end
if value.to_s.bytesize > MAX_FIELD_LENGTH
raise ArgumentError, "header #{key} has too long field value: #{value.bytesize}"
end
if value.count("\r\n") > 0
raise ArgumentError, "header #{key} has field value #{value.inspect}, this cannot include CR/LF"
end
@header[key.downcase.to_s] = [value]
end
end
end
def size #:nodoc: obsolete
@header.size
end
alias length size #:nodoc: obsolete
# Returns the string field value for the case-insensitive field +key+,
# or +nil+ if there is no such key;
# see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['Connection'] # => "keep-alive"
# res['Nosuch'] # => nil
#
# Note that some field values may be retrieved via convenience methods;
# see {Getters}[rdoc-ref:Net::HTTPHeader@Getters].
def [](key)
a = @header[key.downcase.to_s] or return nil
a.join(', ')
end
# Sets the value for the case-insensitive +key+ to +val+,
# overwriting the previous value if the field exists;
# see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
#
# req = Net::HTTP::Get.new(uri)
# req['Accept'] # => "*/*"
# req['Accept'] = 'text/html'
# req['Accept'] # => "text/html"
#
# Note that some field values may be set via convenience methods;
# see {Setters}[rdoc-ref:Net::HTTPHeader@Setters].
def []=(key, val)
unless val
@header.delete key.downcase.to_s
return val
end
set_field(key, val)
end
# Adds value +val+ to the value array for field +key+ if the field exists;
# creates the field with the given +key+ and +val+ if it does not exist.
# see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
#
# req = Net::HTTP::Get.new(uri)
# req.add_field('Foo', 'bar')
# req['Foo'] # => "bar"
# req.add_field('Foo', 'baz')
# req['Foo'] # => "bar, baz"
# req.add_field('Foo', %w[baz bam])
# req['Foo'] # => "bar, baz, baz, bam"
# req.get_fields('Foo') # => ["bar", "baz", "baz", "bam"]
#
def add_field(key, val)
stringified_downcased_key = key.downcase.to_s
if @header.key?(stringified_downcased_key)
append_field_value(@header[stringified_downcased_key], val)
else
set_field(key, val)
end
end
private def set_field(key, val)
case val
when Enumerable
ary = []
append_field_value(ary, val)
@header[key.downcase.to_s] = ary
else
val = val.to_s # for compatibility use to_s instead of to_str
if val.b.count("\r\n") > 0
raise ArgumentError, 'header field value cannot include CR/LF'
end
@header[key.downcase.to_s] = [val]
end
end
private def append_field_value(ary, val)
case val
when Enumerable
val.each{|x| append_field_value(ary, x)}
else
val = val.to_s
if /[\r\n]/n.match?(val.b)
raise ArgumentError, 'header field value cannot include CR/LF'
end
ary.push val
end
end
# Returns the array field value for the given +key+,
# or +nil+ if there is no such field;
# see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res.get_fields('Connection') # => ["keep-alive"]
# res.get_fields('Nosuch') # => nil
#
def get_fields(key)
stringified_downcased_key = key.downcase.to_s
return nil unless @header[stringified_downcased_key]
@header[stringified_downcased_key].dup
end
# call-seq:
# fetch(key, default_val = nil) {|key| ... } -> object
# fetch(key, default_val = nil) -> value or default_val
#
# With a block, returns the string value for +key+ if it exists;
# otherwise returns the value of the block;
# ignores the +default_val+;
# see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
#
# # Field exists; block not called.
# res.fetch('Connection') do |value|
# fail 'Cannot happen'
# end # => "keep-alive"
#
# # Field does not exist; block called.
# res.fetch('Nosuch') do |value|
# value.downcase
# end # => "nosuch"
#
# With no block, returns the string value for +key+ if it exists;
# otherwise, returns +default_val+ if it was given;
# otherwise raises an exception:
#
# res.fetch('Connection', 'Foo') # => "keep-alive"
# res.fetch('Nosuch', 'Foo') # => "Foo"
# res.fetch('Nosuch') # Raises KeyError.
#
def fetch(key, *args, &block) #:yield: +key+
a = @header.fetch(key.downcase.to_s, *args, &block)
a.kind_of?(Array) ? a.join(', ') : a
end
# Calls the block with each key/value pair:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res.each_header do |key, value|
# p [key, value] if key.start_with?('c')
# end
#
# Output:
#
# ["content-type", "application/json; charset=utf-8"]
# ["connection", "keep-alive"]
# ["cache-control", "max-age=43200"]
# ["cf-cache-status", "HIT"]
# ["cf-ray", "771d17e9bc542cf5-ORD"]
#
# Returns an enumerator if no block is given.
#
# Net::HTTPHeader#each is an alias for Net::HTTPHeader#each_header.
def each_header #:yield: +key+, +value+
block_given? or return enum_for(__method__) { @header.size }
@header.each do |k,va|
yield k, va.join(', ')
end
end
alias each each_header
# Calls the block with each field key:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res.each_key do |key|
# p key if key.start_with?('c')
# end
#
# Output:
#
# "content-type"
# "connection"
# "cache-control"
# "cf-cache-status"
# "cf-ray"
#
# Returns an enumerator if no block is given.
#
# Net::HTTPHeader#each_name is an alias for Net::HTTPHeader#each_key.
def each_name(&block) #:yield: +key+
block_given? or return enum_for(__method__) { @header.size }
@header.each_key(&block)
end
alias each_key each_name
# Calls the block with each capitalized field name:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res.each_capitalized_name do |key|
# p key if key.start_with?('C')
# end
#
# Output:
#
# "Content-Type"
# "Connection"
# "Cache-Control"
# "Cf-Cache-Status"
# "Cf-Ray"
#
# The capitalization is system-dependent;
# see {Case Mapping}[rdoc-ref:case_mapping.rdoc].
#
# Returns an enumerator if no block is given.
def each_capitalized_name #:yield: +key+
block_given? or return enum_for(__method__) { @header.size }
@header.each_key do |k|
yield capitalize(k)
end
end
# Calls the block with each string field value:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res.each_value do |value|
# p value if value.start_with?('c')
# end
#
# Output:
#
# "chunked"
# "cf-q-config;dur=6.0000002122251e-06"
# "cloudflare"
#
# Returns an enumerator if no block is given.
def each_value #:yield: +value+
block_given? or return enum_for(__method__) { @header.size }
@header.each_value do |va|
yield va.join(', ')
end
end
# Removes the header for the given case-insensitive +key+
# (see {Fields}[rdoc-ref:Net::HTTPHeader@Fields]);
# returns the deleted value, or +nil+ if no such field exists:
#
# req = Net::HTTP::Get.new(uri)
# req.delete('Accept') # => ["*/*"]
# req.delete('Nosuch') # => nil
#
def delete(key)
@header.delete(key.downcase.to_s)
end
# Returns +true+ if the field for the case-insensitive +key+ exists, +false+ otherwise:
#
# req = Net::HTTP::Get.new(uri)
# req.key?('Accept') # => true
# req.key?('Nosuch') # => false
#
def key?(key)
@header.key?(key.downcase.to_s)
end
# Returns a hash of the key/value pairs:
#
# req = Net::HTTP::Get.new(uri)
# req.to_hash
# # =>
# {"accept-encoding"=>["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"],
# "accept"=>["*/*"],
# "user-agent"=>["Ruby"],
# "host"=>["jsonplaceholder.typicode.com"]}
#
def to_hash
@header.dup
end
# Like #each_header, but the keys are returned in capitalized form.
#
# Net::HTTPHeader#canonical_each is an alias for Net::HTTPHeader#each_capitalized.
def each_capitalized
block_given? or return enum_for(__method__) { @header.size }
@header.each do |k,v|
yield capitalize(k), v.join(', ')
end
end
alias canonical_each each_capitalized
def capitalize(name)
name.to_s.split(/-/).map {|s| s.capitalize }.join('-')
end
private :capitalize
# Returns an array of Range objects that represent
# the value of field <tt>'Range'</tt>,
# or +nil+ if there is no such field;
# see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]:
#
# req = Net::HTTP::Get.new(uri)
# req['Range'] = 'bytes=0-99,200-299,400-499'
# req.range # => [0..99, 200..299, 400..499]
# req.delete('Range')
# req.range # # => nil
#
def range
return nil unless @header['range']
value = self['Range']
# byte-range-set = *( "," OWS ) ( byte-range-spec / suffix-byte-range-spec )
# *( OWS "," [ OWS ( byte-range-spec / suffix-byte-range-spec ) ] )
# corrected collected ABNF
# http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#section-5.4.1
# http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#appendix-C
# http://tools.ietf.org/html/draft-ietf-httpbis-p1-messaging-19#section-3.2.5
unless /\Abytes=((?:,[ \t]*)*(?:\d+-\d*|-\d+)(?:[ \t]*,(?:[ \t]*\d+-\d*|-\d+)?)*)\z/ =~ value
raise Net::HTTPHeaderSyntaxError, "invalid syntax for byte-ranges-specifier: '#{value}'"
end
byte_range_set = $1
result = byte_range_set.split(/,/).map {|spec|
m = /(\d+)?\s*-\s*(\d+)?/i.match(spec) or
raise Net::HTTPHeaderSyntaxError, "invalid byte-range-spec: '#{spec}'"
d1 = m[1].to_i
d2 = m[2].to_i
if m[1] and m[2]
if d1 > d2
raise Net::HTTPHeaderSyntaxError, "last-byte-pos MUST greater than or equal to first-byte-pos but '#{spec}'"
end
d1..d2
elsif m[1]
d1..-1
elsif m[2]
-d2..-1
else
raise Net::HTTPHeaderSyntaxError, 'range is not specified'
end
}
# if result.empty?
# byte-range-set must include at least one byte-range-spec or suffix-byte-range-spec
# but above regexp already denies it.
if result.size == 1 && result[0].begin == 0 && result[0].end == -1
raise Net::HTTPHeaderSyntaxError, 'only one suffix-byte-range-spec with zero suffix-length'
end
result
end
# call-seq:
# set_range(length) -> length
# set_range(offset, length) -> range
# set_range(begin..length) -> range
#
# Sets the value for field <tt>'Range'</tt>;
# see {Range request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#range-request-header]:
#
# With argument +length+:
#
# req = Net::HTTP::Get.new(uri)
# req.set_range(100) # => 100
# req['Range'] # => "bytes=0-99"
#
# With arguments +offset+ and +length+:
#
# req.set_range(100, 100) # => 100...200
# req['Range'] # => "bytes=100-199"
#
# With argument +range+:
#
# req.set_range(100..199) # => 100..199
# req['Range'] # => "bytes=100-199"
#
# Net::HTTPHeader#range= is an alias for Net::HTTPHeader#set_range.
def set_range(r, e = nil)
unless r
@header.delete 'range'
return r
end
r = (r...r+e) if e
case r
when Numeric
n = r.to_i
rangestr = (n > 0 ? "0-#{n-1}" : "-#{-n}")
when Range
first = r.first
last = r.end
last -= 1 if r.exclude_end?
if last == -1
rangestr = (first > 0 ? "#{first}-" : "-#{-first}")
else
raise Net::HTTPHeaderSyntaxError, 'range.first is negative' if first < 0
raise Net::HTTPHeaderSyntaxError, 'range.last is negative' if last < 0
raise Net::HTTPHeaderSyntaxError, 'must be .first < .last' if first > last
rangestr = "#{first}-#{last}"
end
else
raise TypeError, 'Range/Integer is required'
end
@header['range'] = ["bytes=#{rangestr}"]
r
end
alias range= set_range
# Returns the value of field <tt>'Content-Length'</tt> as an integer,
# or +nil+ if there is no such field;
# see {Content-Length request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-length-request-header]:
#
# res = Net::HTTP.get_response(hostname, '/nosuch/1')
# res.content_length # => 2
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res.content_length # => nil
#
def content_length
return nil unless key?('Content-Length')
len = self['Content-Length'].slice(/\d+/) or
raise Net::HTTPHeaderSyntaxError, 'wrong Content-Length format'
len.to_i
end
# Sets the value of field <tt>'Content-Length'</tt> to the given numeric;
# see {Content-Length response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-length-response-header]:
#
# _uri = uri.dup
# hostname = _uri.hostname # => "jsonplaceholder.typicode.com"
# _uri.path = '/posts' # => "/posts"
# req = Net::HTTP::Post.new(_uri) # => #<Net::HTTP::Post POST>
# req.body = '{"title": "foo","body": "bar","userId": 1}'
# req.content_length = req.body.size # => 42
# req.content_type = 'application/json'
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end # => #<Net::HTTPCreated 201 Created readbody=true>
#
def content_length=(len)
unless len
@header.delete 'content-length'
return nil
end
@header['content-length'] = [len.to_i.to_s]
end
# Returns +true+ if field <tt>'Transfer-Encoding'</tt>
# exists and has value <tt>'chunked'</tt>,
# +false+ otherwise;
# see {Transfer-Encoding response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#transfer-encoding-response-header]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['Transfer-Encoding'] # => "chunked"
# res.chunked? # => true
#
def chunked?
return false unless @header['transfer-encoding']
field = self['Transfer-Encoding']
(/(?:\A|[^\-\w])chunked(?![\-\w])/i =~ field) ? true : false
end
# Returns a Range object representing the value of field
# <tt>'Content-Range'</tt>, or +nil+ if no such field exists;
# see {Content-Range response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-range-response-header]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['Content-Range'] # => nil
# res['Content-Range'] = 'bytes 0-499/1000'
# res['Content-Range'] # => "bytes 0-499/1000"
# res.content_range # => 0..499
#
def content_range
return nil unless @header['content-range']
m = %r<\A\s*(\w+)\s+(\d+)-(\d+)/(\d+|\*)>.match(self['Content-Range']) or
raise Net::HTTPHeaderSyntaxError, 'wrong Content-Range format'
return unless m[1] == 'bytes'
m[2].to_i .. m[3].to_i
end
# Returns the integer representing length of the value of field
# <tt>'Content-Range'</tt>, or +nil+ if no such field exists;
# see {Content-Range response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-range-response-header]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['Content-Range'] # => nil
# res['Content-Range'] = 'bytes 0-499/1000'
# res.range_length # => 500
#
def range_length
r = content_range() or return nil
r.end - r.begin + 1
end
# Returns the {media type}[https://en.wikipedia.org/wiki/Media_type]
# from the value of field <tt>'Content-Type'</tt>,
# or +nil+ if no such field exists;
# see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['content-type'] # => "application/json; charset=utf-8"
# res.content_type # => "application/json"
#
def content_type
main = main_type()
return nil unless main
sub = sub_type()
if sub
"#{main}/#{sub}"
else
main
end
end
# Returns the leading ('type') part of the
# {media type}[https://en.wikipedia.org/wiki/Media_type]
# from the value of field <tt>'Content-Type'</tt>,
# or +nil+ if no such field exists;
# see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['content-type'] # => "application/json; charset=utf-8"
# res.main_type # => "application"
#
def main_type
return nil unless @header['content-type']
self['Content-Type'].split(';').first.to_s.split('/')[0].to_s.strip
end
# Returns the trailing ('subtype') part of the
# {media type}[https://en.wikipedia.org/wiki/Media_type]
# from the value of field <tt>'Content-Type'</tt>,
# or +nil+ if no such field exists;
# see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['content-type'] # => "application/json; charset=utf-8"
# res.sub_type # => "json"
#
def sub_type
return nil unless @header['content-type']
_, sub = *self['Content-Type'].split(';').first.to_s.split('/')
return nil unless sub
sub.strip
end
# Returns the trailing ('parameters') part of the value of field <tt>'Content-Type'</tt>,
# or +nil+ if no such field exists;
# see {Content-Type response header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-response-header]:
#
# res = Net::HTTP.get_response(hostname, '/todos/1')
# res['content-type'] # => "application/json; charset=utf-8"
# res.type_params # => {"charset"=>"utf-8"}
#
def type_params
result = {}
list = self['Content-Type'].to_s.split(';')
list.shift
list.each do |param|
k, v = *param.split('=', 2)
result[k.strip] = v.strip
end
result
end
# Sets the value of field <tt>'Content-Type'</tt>;
# returns the new value;
# see {Content-Type request header}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-type-request-header]:
#
# req = Net::HTTP::Get.new(uri)
# req.set_content_type('application/json') # => ["application/json"]
#
# Net::HTTPHeader#content_type= is an alias for Net::HTTPHeader#set_content_type.
def set_content_type(type, params = {})
@header['content-type'] = [type + params.map{|k,v|"; #{k}=#{v}"}.join('')]
end
alias content_type= set_content_type
# Sets the request body to a URL-encoded string derived from argument +params+,
# and sets request header field <tt>'Content-Type'</tt>
# to <tt>'application/x-www-form-urlencoded'</tt>.
#
# The resulting request is suitable for HTTP request +POST+ or +PUT+.
#
# Argument +params+ must be suitable for use as argument +enum+ to
# {URI.encode_www_form}[rdoc-ref:URI.encode_www_form].
#
# With only argument +params+ given,
# sets the body to a URL-encoded string with the default separator <tt>'&'</tt>:
#
# req = Net::HTTP::Post.new('example.com')
#
# req.set_form_data(q: 'ruby', lang: 'en')
# req.body # => "q=ruby&lang=en"
# req['Content-Type'] # => "application/x-www-form-urlencoded"
#
# req.set_form_data([['q', 'ruby'], ['lang', 'en']])
# req.body # => "q=ruby&lang=en"
#
# req.set_form_data(q: ['ruby', 'perl'], lang: 'en')
# req.body # => "q=ruby&q=perl&lang=en"
#
# req.set_form_data([['q', 'ruby'], ['q', 'perl'], ['lang', 'en']])
# req.body # => "q=ruby&q=perl&lang=en"
#
# With string argument +sep+ also given,
# uses that string as the separator:
#
# req.set_form_data({q: 'ruby', lang: 'en'}, '|')
# req.body # => "q=ruby|lang=en"
#
# Net::HTTPHeader#form_data= is an alias for Net::HTTPHeader#set_form_data.
def set_form_data(params, sep = '&')
query = URI.encode_www_form(params)
query.gsub!(/&/, sep) if sep != '&'
self.body = query
self.content_type = 'application/x-www-form-urlencoded'
end
alias form_data= set_form_data
# Stores form data to be used in a +POST+ or +PUT+ request.
#
# The form data given in +params+ consists of zero or more fields;
# each field is:
#
# - A scalar value.
# - A name/value pair.
# - An IO stream opened for reading.
#
# Argument +params+ should be an
# {Enumerable}[rdoc-ref:Enumerable@Enumerable+in+Ruby+Classes]
# (method <tt>params.map</tt> will be called),
# and is often an array or hash.
#
# First, we set up a request:
#
# _uri = uri.dup
# _uri.path ='/posts'
# req = Net::HTTP::Post.new(_uri)
#
# <b>Argument +params+ As an Array</b>
#
# When +params+ is an array,
# each of its elements is a subarray that defines a field;
# the subarray may contain:
#
# - One string:
#
# req.set_form([['foo'], ['bar'], ['baz']])
#
# - Two strings:
#
# req.set_form([%w[foo 0], %w[bar 1], %w[baz 2]])
#
# - When argument +enctype+ (see below) is given as
# <tt>'multipart/form-data'</tt>:
#
# - A string name and an IO stream opened for reading:
#
# require 'stringio'
# req.set_form([['file', StringIO.new('Ruby is cool.')]])
#
# - A string name, an IO stream opened for reading,
# and an options hash, which may contain these entries:
#
# - +:filename+: The name of the file to use.
# - +:content_type+: The content type of the uploaded file.
#
# Example:
#
# req.set_form([['file', file, {filename: "other-filename.foo"}]]
#
# The various forms may be mixed:
#
# req.set_form(['foo', %w[bar 1], ['file', file]])
#
# <b>Argument +params+ As a Hash</b>
#
# When +params+ is a hash,
# each of its entries is a name/value pair that defines a field:
#
# - The name is a string.
# - The value may be:
#
# - +nil+.
# - Another string.
# - An IO stream opened for reading
# (only when argument +enctype+ -- see below -- is given as
# <tt>'multipart/form-data'</tt>).
#
# Examples:
#
# # Nil-valued fields.
# req.set_form({'foo' => nil, 'bar' => nil, 'baz' => nil})
#
# # String-valued fields.
# req.set_form({'foo' => 0, 'bar' => 1, 'baz' => 2})
#
# # IO-valued field.
# require 'stringio'
# req.set_form({'file' => StringIO.new('Ruby is cool.')})
#
# # Mixture of fields.
# req.set_form({'foo' => nil, 'bar' => 1, 'file' => file})
#
# Optional argument +enctype+ specifies the value to be given
# to field <tt>'Content-Type'</tt>, and must be one of:
#
# - <tt>'application/x-www-form-urlencoded'</tt> (the default).
# - <tt>'multipart/form-data'</tt>;
# see {RFC 7578}[https://www.rfc-editor.org/rfc/rfc7578].
#
# Optional argument +formopt+ is a hash of options
# (applicable only when argument +enctype+
# is <tt>'multipart/form-data'</tt>)
# that may include the following entries:
#
# - +:boundary+: The value is the boundary string for the multipart message.
# If not given, the boundary is a random string.
# See {Boundary}[https://www.rfc-editor.org/rfc/rfc7578#section-4.1].
# - +:charset+: Value is the character set for the form submission.
# Field names and values of non-file fields should be encoded with this charset.
#
def set_form(params, enctype='application/x-www-form-urlencoded', formopt={})
@body_data = params
@body = nil
@body_stream = nil
@form_option = formopt
case enctype
when /\Aapplication\/x-www-form-urlencoded\z/i,
/\Amultipart\/form-data\z/i
self.content_type = enctype
else
raise ArgumentError, "invalid enctype: #{enctype}"
end
end
# Sets header <tt>'Authorization'</tt> using the given
# +account+ and +password+ strings:
#
# req.basic_auth('my_account', 'my_password')
# req['Authorization']
# # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="
#
def basic_auth(account, password)
@header['authorization'] = [basic_encode(account, password)]
end
# Sets header <tt>'Proxy-Authorization'</tt> using the given
# +account+ and +password+ strings:
#
# req.proxy_basic_auth('my_account', 'my_password')
# req['Proxy-Authorization']
# # => "Basic bXlfYWNjb3VudDpteV9wYXNzd29yZA=="
#
def proxy_basic_auth(account, password)
@header['proxy-authorization'] = [basic_encode(account, password)]
end
def basic_encode(account, password)
'Basic ' + ["#{account}:#{password}"].pack('m0')
end
private :basic_encode
# Returns whether the HTTP session is to be closed.
def connection_close?
token = /(?:\A|,)\s*close\s*(?:\z|,)/i
@header['connection']&.grep(token) {return true}
@header['proxy-connection']&.grep(token) {return true}
false
end
# Returns whether the HTTP session is to be kept alive.
def connection_keep_alive?
token = /(?:\A|,)\s*keep-alive\s*(?:\z|,)/i
@header['connection']&.grep(token) {return true}
@header['proxy-connection']&.grep(token) {return true}
false
end
end
share/ruby/net/http/exceptions.rb 0000644 00000001505 15173517737 0013123 0 ustar 00 # frozen_string_literal: true
module Net
# Net::HTTP exception class.
# You cannot use Net::HTTPExceptions directly; instead, you must use
# its subclasses.
module HTTPExceptions
def initialize(msg, res) #:nodoc:
super msg
@response = res
end
attr_reader :response
alias data response #:nodoc: obsolete
end
class HTTPError < ProtocolError
include HTTPExceptions
end
class HTTPRetriableError < ProtoRetriableError
include HTTPExceptions
end
class HTTPClientException < ProtoServerError
include HTTPExceptions
end
class HTTPFatalError < ProtoFatalError
include HTTPExceptions
end
# We cannot use the name "HTTPServerError", it is the name of the response.
HTTPServerException = HTTPClientException # :nodoc:
deprecate_constant(:HTTPServerException)
end
share/ruby/net/http/response.rb 0000644 00000046173 15173517737 0012612 0 ustar 00 # frozen_string_literal: true
# This class is the base class for \Net::HTTP response classes.
#
# == About the Examples
#
# :include: doc/net-http/examples.rdoc
#
# == Returned Responses
#
# \Method Net::HTTP.get_response returns
# an instance of one of the subclasses of \Net::HTTPResponse:
#
# Net::HTTP.get_response(uri)
# # => #<Net::HTTPOK 200 OK readbody=true>
# Net::HTTP.get_response(hostname, '/nosuch')
# # => #<Net::HTTPNotFound 404 Not Found readbody=true>
#
# As does method Net::HTTP#request:
#
# req = Net::HTTP::Get.new(uri)
# Net::HTTP.start(hostname) do |http|
# http.request(req)
# end # => #<Net::HTTPOK 200 OK readbody=true>
#
# \Class \Net::HTTPResponse includes module Net::HTTPHeader,
# which provides access to response header values via (among others):
#
# - \Hash-like method <tt>[]</tt>.
# - Specific reader methods, such as +content_type+.
#
# Examples:
#
# res = Net::HTTP.get_response(uri) # => #<Net::HTTPOK 200 OK readbody=true>
# res['Content-Type'] # => "text/html; charset=UTF-8"
# res.content_type # => "text/html"
#
# == Response Subclasses
#
# \Class \Net::HTTPResponse has a subclass for each
# {HTTP status code}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes].
# You can look up the response class for a given code:
#
# Net::HTTPResponse::CODE_TO_OBJ['200'] # => Net::HTTPOK
# Net::HTTPResponse::CODE_TO_OBJ['400'] # => Net::HTTPBadRequest
# Net::HTTPResponse::CODE_TO_OBJ['404'] # => Net::HTTPNotFound
#
# And you can retrieve the status code for a response object:
#
# Net::HTTP.get_response(uri).code # => "200"
# Net::HTTP.get_response(hostname, '/nosuch').code # => "404"
#
# The response subclasses (indentation shows class hierarchy):
#
# - Net::HTTPUnknownResponse (for unhandled \HTTP extensions).
#
# - Net::HTTPInformation:
#
# - Net::HTTPContinue (100)
# - Net::HTTPSwitchProtocol (101)
# - Net::HTTPProcessing (102)
# - Net::HTTPEarlyHints (103)
#
# - Net::HTTPSuccess:
#
# - Net::HTTPOK (200)
# - Net::HTTPCreated (201)
# - Net::HTTPAccepted (202)
# - Net::HTTPNonAuthoritativeInformation (203)
# - Net::HTTPNoContent (204)
# - Net::HTTPResetContent (205)
# - Net::HTTPPartialContent (206)
# - Net::HTTPMultiStatus (207)
# - Net::HTTPAlreadyReported (208)
# - Net::HTTPIMUsed (226)
#
# - Net::HTTPRedirection:
#
# - Net::HTTPMultipleChoices (300)
# - Net::HTTPMovedPermanently (301)
# - Net::HTTPFound (302)
# - Net::HTTPSeeOther (303)
# - Net::HTTPNotModified (304)
# - Net::HTTPUseProxy (305)
# - Net::HTTPTemporaryRedirect (307)
# - Net::HTTPPermanentRedirect (308)
#
# - Net::HTTPClientError:
#
# - Net::HTTPBadRequest (400)
# - Net::HTTPUnauthorized (401)
# - Net::HTTPPaymentRequired (402)
# - Net::HTTPForbidden (403)
# - Net::HTTPNotFound (404)
# - Net::HTTPMethodNotAllowed (405)
# - Net::HTTPNotAcceptable (406)
# - Net::HTTPProxyAuthenticationRequired (407)
# - Net::HTTPRequestTimeOut (408)
# - Net::HTTPConflict (409)
# - Net::HTTPGone (410)
# - Net::HTTPLengthRequired (411)
# - Net::HTTPPreconditionFailed (412)
# - Net::HTTPRequestEntityTooLarge (413)
# - Net::HTTPRequestURITooLong (414)
# - Net::HTTPUnsupportedMediaType (415)
# - Net::HTTPRequestedRangeNotSatisfiable (416)
# - Net::HTTPExpectationFailed (417)
# - Net::HTTPMisdirectedRequest (421)
# - Net::HTTPUnprocessableEntity (422)
# - Net::HTTPLocked (423)
# - Net::HTTPFailedDependency (424)
# - Net::HTTPUpgradeRequired (426)
# - Net::HTTPPreconditionRequired (428)
# - Net::HTTPTooManyRequests (429)
# - Net::HTTPRequestHeaderFieldsTooLarge (431)
# - Net::HTTPUnavailableForLegalReasons (451)
#
# - Net::HTTPServerError:
#
# - Net::HTTPInternalServerError (500)
# - Net::HTTPNotImplemented (501)
# - Net::HTTPBadGateway (502)
# - Net::HTTPServiceUnavailable (503)
# - Net::HTTPGatewayTimeOut (504)
# - Net::HTTPVersionNotSupported (505)
# - Net::HTTPVariantAlsoNegotiates (506)
# - Net::HTTPInsufficientStorage (507)
# - Net::HTTPLoopDetected (508)
# - Net::HTTPNotExtended (510)
# - Net::HTTPNetworkAuthenticationRequired (511)
#
# There is also the Net::HTTPBadResponse exception which is raised when
# there is a protocol error.
#
class Net::HTTPResponse
class << self
# true if the response has a body.
def body_permitted?
self::HAS_BODY
end
def exception_type # :nodoc: internal use only
self::EXCEPTION_TYPE
end
def read_new(sock) #:nodoc: internal use only
httpv, code, msg = read_status_line(sock)
res = response_class(code).new(httpv, code, msg)
each_response_header(sock) do |k,v|
res.add_field k, v
end
res
end
private
def read_status_line(sock)
str = sock.readline
m = /\AHTTP(?:\/(\d+\.\d+))?\s+(\d\d\d)(?:\s+(.*))?\z/in.match(str) or
raise Net::HTTPBadResponse, "wrong status line: #{str.dump}"
m.captures
end
def response_class(code)
CODE_TO_OBJ[code] or
CODE_CLASS_TO_OBJ[code[0,1]] or
Net::HTTPUnknownResponse
end
def each_response_header(sock)
key = value = nil
while true
line = sock.readuntil("\n", true).sub(/\s+\z/, '')
break if line.empty?
if line[0] == ?\s or line[0] == ?\t and value
value << ' ' unless value.empty?
value << line.strip
else
yield key, value if key
key, value = line.strip.split(/\s*:\s*/, 2)
raise Net::HTTPBadResponse, 'wrong header line format' if value.nil?
end
end
yield key, value if key
end
end
# next is to fix bug in RDoc, where the private inside class << self
# spills out.
public
include Net::HTTPHeader
def initialize(httpv, code, msg) #:nodoc: internal use only
@http_version = httpv
@code = code
@message = msg
initialize_http_header nil
@body = nil
@read = false
@uri = nil
@decode_content = false
@body_encoding = false
@ignore_eof = true
end
# The HTTP version supported by the server.
attr_reader :http_version
# The HTTP result code string. For example, '302'. You can also
# determine the response type by examining which response subclass
# the response object is an instance of.
attr_reader :code
# The HTTP result message sent by the server. For example, 'Not Found'.
attr_reader :message
alias msg message # :nodoc: obsolete
# The URI used to fetch this response. The response URI is only available
# if a URI was used to create the request.
attr_reader :uri
# Set to true automatically when the request did not contain an
# Accept-Encoding header from the user.
attr_accessor :decode_content
# Returns the value set by body_encoding=, or +false+ if none;
# see #body_encoding=.
attr_reader :body_encoding
# Sets the encoding that should be used when reading the body:
#
# - If the given value is an Encoding object, that encoding will be used.
# - Otherwise if the value is a string, the value of
# {Encoding#find(value)}[rdoc-ref:Encoding.find]
# will be used.
# - Otherwise an encoding will be deduced from the body itself.
#
# Examples:
#
# http = Net::HTTP.new(hostname)
# req = Net::HTTP::Get.new('/')
#
# http.request(req) do |res|
# p res.body.encoding # => #<Encoding:ASCII-8BIT>
# end
#
# http.request(req) do |res|
# res.body_encoding = "UTF-8"
# p res.body.encoding # => #<Encoding:UTF-8>
# end
#
def body_encoding=(value)
value = Encoding.find(value) if value.is_a?(String)
@body_encoding = value
end
# Whether to ignore EOF when reading bodies with a specified Content-Length
# header.
attr_accessor :ignore_eof
def inspect
"#<#{self.class} #{@code} #{@message} readbody=#{@read}>"
end
#
# response <-> exception relationship
#
def code_type #:nodoc:
self.class
end
def error! #:nodoc:
message = @code
message = "#{message} #{@message.dump}" if @message
raise error_type().new(message, self)
end
def error_type #:nodoc:
self.class::EXCEPTION_TYPE
end
# Raises an HTTP error if the response is not 2xx (success).
def value
error! unless self.kind_of?(Net::HTTPSuccess)
end
def uri= uri # :nodoc:
@uri = uri.dup if uri
end
#
# header (for backward compatibility only; DO NOT USE)
#
def response #:nodoc:
warn "Net::HTTPResponse#response is obsolete", uplevel: 1 if $VERBOSE
self
end
def header #:nodoc:
warn "Net::HTTPResponse#header is obsolete", uplevel: 1 if $VERBOSE
self
end
def read_header #:nodoc:
warn "Net::HTTPResponse#read_header is obsolete", uplevel: 1 if $VERBOSE
self
end
#
# body
#
def reading_body(sock, reqmethodallowbody) #:nodoc: internal use only
@socket = sock
@body_exist = reqmethodallowbody && self.class.body_permitted?
begin
yield
self.body # ensure to read body
ensure
@socket = nil
end
end
# Gets the entity body returned by the remote HTTP server.
#
# If a block is given, the body is passed to the block, and
# the body is provided in fragments, as it is read in from the socket.
#
# If +dest+ argument is given, response is read into that variable,
# with <code>dest#<<</code> method (it could be String or IO, or any
# other object responding to <code><<</code>).
#
# Calling this method a second or subsequent time for the same
# HTTPResponse object will return the value already read.
#
# http.request_get('/index.html') {|res|
# puts res.read_body
# }
#
# http.request_get('/index.html') {|res|
# p res.read_body.object_id # 538149362
# p res.read_body.object_id # 538149362
# }
#
# # using iterator
# http.request_get('/index.html') {|res|
# res.read_body do |segment|
# print segment
# end
# }
#
def read_body(dest = nil, &block)
if @read
raise IOError, "#{self.class}\#read_body called twice" if dest or block
return @body
end
to = procdest(dest, block)
stream_check
if @body_exist
read_body_0 to
@body = to
else
@body = nil
end
@read = true
return if @body.nil?
case enc = @body_encoding
when Encoding, false, nil
# Encoding: force given encoding
# false/nil: do not force encoding
else
# other value: detect encoding from body
enc = detect_encoding(@body)
end
@body.force_encoding(enc) if enc
@body
end
# Returns the string response body;
# note that repeated calls for the unmodified body return a cached string:
#
# path = '/todos/1'
# Net::HTTP.start(hostname) do |http|
# res = http.get(path)
# p res.body
# p http.head(path).body # No body.
# end
#
# Output:
#
# "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false\n}"
# nil
#
def body
read_body()
end
# Sets the body of the response to the given value.
def body=(value)
@body = value
end
alias entity body #:nodoc: obsolete
private
# :nodoc:
def detect_encoding(str, encoding=nil)
if encoding
elsif encoding = type_params['charset']
elsif encoding = check_bom(str)
else
encoding = case content_type&.downcase
when %r{text/x(?:ht)?ml|application/(?:[^+]+\+)?xml}
/\A<xml[ \t\r\n]+
version[ \t\r\n]*=[ \t\r\n]*(?:"[0-9.]+"|'[0-9.]*')[ \t\r\n]+
encoding[ \t\r\n]*=[ \t\r\n]*
(?:"([A-Za-z][\-A-Za-z0-9._]*)"|'([A-Za-z][\-A-Za-z0-9._]*)')/x =~ str
encoding = $1 || $2 || Encoding::UTF_8
when %r{text/html.*}
sniff_encoding(str)
end
end
return encoding
end
# :nodoc:
def sniff_encoding(str, encoding=nil)
# the encoding sniffing algorithm
# http://www.w3.org/TR/html5/parsing.html#determining-the-character-encoding
if enc = scanning_meta(str)
enc
# 6. last visited page or something
# 7. frequency
elsif str.ascii_only?
Encoding::US_ASCII
elsif str.dup.force_encoding(Encoding::UTF_8).valid_encoding?
Encoding::UTF_8
end
# 8. implementation-defined or user-specified
end
# :nodoc:
def check_bom(str)
case str.byteslice(0, 2)
when "\xFE\xFF"
return Encoding::UTF_16BE
when "\xFF\xFE"
return Encoding::UTF_16LE
end
if "\xEF\xBB\xBF" == str.byteslice(0, 3)
return Encoding::UTF_8
end
nil
end
# :nodoc:
def scanning_meta(str)
require 'strscan'
ss = StringScanner.new(str)
if ss.scan_until(/<meta[\t\n\f\r ]*/)
attrs = {} # attribute_list
got_pragma = false
need_pragma = nil
charset = nil
# step: Attributes
while attr = get_attribute(ss)
name, value = *attr
next if attrs[name]
attrs[name] = true
case name
when 'http-equiv'
got_pragma = true if value == 'content-type'
when 'content'
encoding = extracting_encodings_from_meta_elements(value)
unless charset
charset = encoding
end
need_pragma = true
when 'charset'
need_pragma = false
charset = value
end
end
# step: Processing
return if need_pragma.nil?
return if need_pragma && !got_pragma
charset = Encoding.find(charset) rescue nil
return unless charset
charset = Encoding::UTF_8 if charset == Encoding::UTF_16
return charset # tentative
end
nil
end
def get_attribute(ss)
ss.scan(/[\t\n\f\r \/]*/)
if ss.peek(1) == '>'
ss.getch
return nil
end
name = ss.scan(/[^=\t\n\f\r \/>]*/)
name.downcase!
raise if name.empty?
ss.skip(/[\t\n\f\r ]*/)
if ss.getch != '='
value = ''
return [name, value]
end
ss.skip(/[\t\n\f\r ]*/)
case ss.peek(1)
when '"'
ss.getch
value = ss.scan(/[^"]+/)
value.downcase!
ss.getch
when "'"
ss.getch
value = ss.scan(/[^']+/)
value.downcase!
ss.getch
when '>'
value = ''
else
value = ss.scan(/[^\t\n\f\r >]+/)
value.downcase!
end
[name, value]
end
def extracting_encodings_from_meta_elements(value)
# http://dev.w3.org/html5/spec/fetching-resources.html#algorithm-for-extracting-an-encoding-from-a-meta-element
if /charset[\t\n\f\r ]*=(?:"([^"]*)"|'([^']*)'|["']|\z|([^\t\n\f\r ;]+))/i =~ value
return $1 || $2 || $3
end
return nil
end
##
# Checks for a supported Content-Encoding header and yields an Inflate
# wrapper for this response's socket when zlib is present. If the
# Content-Encoding is not supported or zlib is missing, the plain socket is
# yielded.
#
# If a Content-Range header is present, a plain socket is yielded as the
# bytes in the range may not be a complete deflate block.
def inflater # :nodoc:
return yield @socket unless Net::HTTP::HAVE_ZLIB
return yield @socket unless @decode_content
return yield @socket if self['content-range']
v = self['content-encoding']
case v&.downcase
when 'deflate', 'gzip', 'x-gzip' then
self.delete 'content-encoding'
inflate_body_io = Inflater.new(@socket)
begin
yield inflate_body_io
success = true
ensure
begin
inflate_body_io.finish
if self['content-length']
self['content-length'] = inflate_body_io.bytes_inflated.to_s
end
rescue => err
# Ignore #finish's error if there is an exception from yield
raise err if success
end
end
when 'none', 'identity' then
self.delete 'content-encoding'
yield @socket
else
yield @socket
end
end
def read_body_0(dest)
inflater do |inflate_body_io|
if chunked?
read_chunked dest, inflate_body_io
return
end
@socket = inflate_body_io
clen = content_length()
if clen
@socket.read clen, dest, @ignore_eof
return
end
clen = range_length()
if clen
@socket.read clen, dest
return
end
@socket.read_all dest
end
end
##
# read_chunked reads from +@socket+ for chunk-size, chunk-extension, CRLF,
# etc. and +chunk_data_io+ for chunk-data which may be deflate or gzip
# encoded.
#
# See RFC 2616 section 3.6.1 for definitions
def read_chunked(dest, chunk_data_io) # :nodoc:
total = 0
while true
line = @socket.readline
hexlen = line.slice(/[0-9a-fA-F]+/) or
raise Net::HTTPBadResponse, "wrong chunk size line: #{line}"
len = hexlen.hex
break if len == 0
begin
chunk_data_io.read len, dest
ensure
total += len
@socket.read 2 # \r\n
end
end
until @socket.readline.empty?
# none
end
end
def stream_check
raise IOError, 'attempt to read body out of block' if @socket.nil? || @socket.closed?
end
def procdest(dest, block)
raise ArgumentError, 'both arg and block given for HTTP method' if
dest and block
if block
Net::ReadAdapter.new(block)
else
dest || +''
end
end
##
# Inflater is a wrapper around Net::BufferedIO that transparently inflates
# zlib and gzip streams.
class Inflater # :nodoc:
##
# Creates a new Inflater wrapping +socket+
def initialize socket
@socket = socket
# zlib with automatic gzip detection
@inflate = Zlib::Inflate.new(32 + Zlib::MAX_WBITS)
end
##
# Finishes the inflate stream.
def finish
return if @inflate.total_in == 0
@inflate.finish
end
##
# The number of bytes inflated, used to update the Content-Length of
# the response.
def bytes_inflated
@inflate.total_out
end
##
# Returns a Net::ReadAdapter that inflates each read chunk into +dest+.
#
# This allows a large response body to be inflated without storing the
# entire body in memory.
def inflate_adapter(dest)
if dest.respond_to?(:set_encoding)
dest.set_encoding(Encoding::ASCII_8BIT)
elsif dest.respond_to?(:force_encoding)
dest.force_encoding(Encoding::ASCII_8BIT)
end
block = proc do |compressed_chunk|
@inflate.inflate(compressed_chunk) do |chunk|
compressed_chunk.clear
dest << chunk
end
end
Net::ReadAdapter.new(block)
end
##
# Reads +clen+ bytes from the socket, inflates them, then writes them to
# +dest+. +ignore_eof+ is passed down to Net::BufferedIO#read
#
# Unlike Net::BufferedIO#read, this method returns more than +clen+ bytes.
# At this time there is no way for a user of Net::HTTPResponse to read a
# specific number of bytes from the HTTP response body, so this internal
# API does not return the same number of bytes as were requested.
#
# See https://bugs.ruby-lang.org/issues/6492 for further discussion.
def read clen, dest, ignore_eof = false
temp_dest = inflate_adapter(dest)
@socket.read clen, temp_dest, ignore_eof
end
##
# Reads the rest of the socket, inflates it, then writes it to +dest+.
def read_all dest
temp_dest = inflate_adapter(dest)
@socket.read_all temp_dest
end
end
end
share/ruby/net/http/backward.rb 0000644 00000002065 15173517737 0012522 0 ustar 00 # frozen_string_literal: true
# for backward compatibility
# :enddoc:
class Net::HTTP
ProxyMod = ProxyDelta
deprecate_constant :ProxyMod
end
module Net::NetPrivate
HTTPRequest = ::Net::HTTPRequest
deprecate_constant :HTTPRequest
end
module Net
HTTPSession = HTTP
HTTPInformationCode = HTTPInformation
HTTPSuccessCode = HTTPSuccess
HTTPRedirectionCode = HTTPRedirection
HTTPRetriableCode = HTTPRedirection
HTTPClientErrorCode = HTTPClientError
HTTPFatalErrorCode = HTTPClientError
HTTPServerErrorCode = HTTPServerError
HTTPResponseReceiver = HTTPResponse
HTTPResponceReceiver = HTTPResponse # Typo since 2001
deprecate_constant :HTTPSession,
:HTTPInformationCode,
:HTTPSuccessCode,
:HTTPRedirectionCode,
:HTTPRetriableCode,
:HTTPClientErrorCode,
:HTTPFatalErrorCode,
:HTTPServerErrorCode,
:HTTPResponseReceiver,
:HTTPResponceReceiver
end
share/ruby/net/http/responses.rb 0000644 00000116775 15173517737 0013003 0 ustar 00 # frozen_string_literal: true
#--
# https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
module Net
class HTTPUnknownResponse < HTTPResponse
HAS_BODY = true
EXCEPTION_TYPE = HTTPError #
end
# Parent class for informational (1xx) HTTP response classes.
#
# An informational response indicates that the request was received and understood.
#
# References:
#
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.1xx].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#1xx_informational_response].
#
class HTTPInformation < HTTPResponse
HAS_BODY = false
EXCEPTION_TYPE = HTTPError #
end
# Parent class for success (2xx) HTTP response classes.
#
# A success response indicates the action requested by the client
# was received, understood, and accepted.
#
# References:
#
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.2xx].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#2xx_success].
#
class HTTPSuccess < HTTPResponse
HAS_BODY = true
EXCEPTION_TYPE = HTTPError #
end
# Parent class for redirection (3xx) HTTP response classes.
#
# A redirection response indicates the client must take additional action
# to complete the request.
#
# References:
#
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.3xx].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#3xx_redirection].
#
class HTTPRedirection < HTTPResponse
HAS_BODY = true
EXCEPTION_TYPE = HTTPRetriableError #
end
# Parent class for client error (4xx) HTTP response classes.
#
# A client error response indicates that the client may have caused an error.
#
# References:
#
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.4xx].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#4xx_client_errors].
#
class HTTPClientError < HTTPResponse
HAS_BODY = true
EXCEPTION_TYPE = HTTPClientException #
end
# Parent class for server error (5xx) HTTP response classes.
#
# A server error response indicates that the server failed to fulfill a request.
#
# References:
#
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#status.5xx].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#5xx_server_errors].
#
class HTTPServerError < HTTPResponse
HAS_BODY = true
EXCEPTION_TYPE = HTTPFatalError #
end
# Response class for +Continue+ responses (status code 100).
#
# A +Continue+ response indicates that the server has received the request headers.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#100].
#
class HTTPContinue < HTTPInformation
HAS_BODY = false
end
# Response class for <tt>Switching Protocol</tt> responses (status code 101).
#
# The <tt>Switching Protocol<tt> response indicates that the server has received
# a request to switch protocols, and has agreed to do so.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/101].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#101].
#
class HTTPSwitchProtocol < HTTPInformation
HAS_BODY = false
end
# Response class for +Processing+ responses (status code 102).
#
# The +Processing+ response indicates that the server has received
# and is processing the request, but no response is available yet.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 2518}[https://www.rfc-editor.org/rfc/rfc2518#section-10.1].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#102].
#
class HTTPProcessing < HTTPInformation
HAS_BODY = false
end
# Response class for <tt>Early Hints</tt> responses (status code 103).
#
# The <tt>Early Hints</tt> indicates that the server has received
# and is processing the request, and contains certain headers;
# the final response is not available yet.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103].
# - {RFC 8297}[https://www.rfc-editor.org/rfc/rfc8297.html#section-2].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#103].
#
class HTTPEarlyHints < HTTPInformation
HAS_BODY = false
end
# Response class for +OK+ responses (status code 200).
#
# The +OK+ response indicates that the server has received
# a request and has responded successfully.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#200].
#
class HTTPOK < HTTPSuccess
HAS_BODY = true
end
# Response class for +Created+ responses (status code 201).
#
# The +Created+ response indicates that the server has received
# and has fulfilled a request to create a new resource.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#201].
#
class HTTPCreated < HTTPSuccess
HAS_BODY = true
end
# Response class for +Accepted+ responses (status code 202).
#
# The +Accepted+ response indicates that the server has received
# and is processing a request, but the processing has not yet been completed.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#202].
#
class HTTPAccepted < HTTPSuccess
HAS_BODY = true
end
# Response class for <tt>Non-Authoritative Information</tt> responses (status code 203).
#
# The <tt>Non-Authoritative Information</tt> response indicates that the server
# is a transforming proxy (such as a Web accelerator)
# that received a 200 OK response from its origin,
# and is returning a modified version of the origin's response.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/203].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-infor].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#203].
#
class HTTPNonAuthoritativeInformation < HTTPSuccess
HAS_BODY = true
end
# Response class for <tt>No Content</tt> responses (status code 204).
#
# The <tt>No Content</tt> response indicates that the server
# successfully processed the request, and is not returning any content.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#204].
#
class HTTPNoContent < HTTPSuccess
HAS_BODY = false
end
# Response class for <tt>Reset Content</tt> responses (status code 205).
#
# The <tt>Reset Content</tt> response indicates that the server
# successfully processed the request,
# asks that the client reset its document view, and is not returning any content.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/205].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#205].
#
class HTTPResetContent < HTTPSuccess
HAS_BODY = false
end
# Response class for <tt>Partial Content</tt> responses (status code 206).
#
# The <tt>Partial Content</tt> response indicates that the server is delivering
# only part of the resource (byte serving)
# due to a Range header in the request.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/206].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#206].
#
class HTTPPartialContent < HTTPSuccess
HAS_BODY = true
end
# Response class for <tt>Multi-Status (WebDAV)</tt> responses (status code 207).
#
# The <tt>Multi-Status (WebDAV)</tt> response indicates that the server
# has received the request,
# and that the message body can contain a number of separate response codes.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 4818}[https://www.rfc-editor.org/rfc/rfc4918#section-11.1].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#207].
#
class HTTPMultiStatus < HTTPSuccess
HAS_BODY = true
end
# Response class for <tt>Already Reported (WebDAV)</tt> responses (status code 208).
#
# The <tt>Already Reported (WebDAV)</tt> response indicates that the server
# has received the request,
# and that the members of a DAV binding have already been enumerated
# in a preceding part of the (multi-status) response,
# and are not being included again.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 5842}[https://www.rfc-editor.org/rfc/rfc5842.html#section-7.1].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#208].
#
class HTTPAlreadyReported < HTTPSuccess
HAS_BODY = true
end
# Response class for <tt>IM Used</tt> responses (status code 226).
#
# The <tt>IM Used</tt> response indicates that the server has fulfilled a request
# for the resource, and the response is a representation of the result
# of one or more instance-manipulations applied to the current instance.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 3229}[https://www.rfc-editor.org/rfc/rfc3229.html#section-10.4.1].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#226].
#
class HTTPIMUsed < HTTPSuccess
HAS_BODY = true
end
# Response class for <tt>Multiple Choices</tt> responses (status code 300).
#
# The <tt>Multiple Choices</tt> response indicates that the server
# offers multiple options for the resource from which the client may choose.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/300].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#300].
#
class HTTPMultipleChoices < HTTPRedirection
HAS_BODY = true
end
HTTPMultipleChoice = HTTPMultipleChoices
# Response class for <tt>Moved Permanently</tt> responses (status code 301).
#
# The <tt>Moved Permanently</tt> response indicates that links or records
# returning this response should be updated to use the given URL.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#301].
#
class HTTPMovedPermanently < HTTPRedirection
HAS_BODY = true
end
# Response class for <tt>Found</tt> responses (status code 302).
#
# The <tt>Found</tt> response indicates that the client
# should look at (browse to) another URL.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#302].
#
class HTTPFound < HTTPRedirection
HAS_BODY = true
end
HTTPMovedTemporarily = HTTPFound
# Response class for <tt>See Other</tt> responses (status code 303).
#
# The response to the request can be found under another URI using the GET method.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/303].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#303].
#
class HTTPSeeOther < HTTPRedirection
HAS_BODY = true
end
# Response class for <tt>Not Modified</tt> responses (status code 304).
#
# Indicates that the resource has not been modified since the version
# specified by the request headers.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#304].
#
class HTTPNotModified < HTTPRedirection
HAS_BODY = false
end
# Response class for <tt>Use Proxy</tt> responses (status code 305).
#
# The requested resource is available only through a proxy,
# whose address is provided in the response.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#305].
#
class HTTPUseProxy < HTTPRedirection
HAS_BODY = false
end
# Response class for <tt>Temporary Redirect</tt> responses (status code 307).
#
# The request should be repeated with another URI;
# however, future requests should still use the original URI.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#307].
#
class HTTPTemporaryRedirect < HTTPRedirection
HAS_BODY = true
end
# Response class for <tt>Permanent Redirect</tt> responses (status code 308).
#
# This and all future requests should be directed to the given URI.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#308].
#
class HTTPPermanentRedirect < HTTPRedirection
HAS_BODY = true
end
# Response class for <tt>Bad Request</tt> responses (status code 400).
#
# The server cannot or will not process the request due to an apparent client error.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#400].
#
class HTTPBadRequest < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Unauthorized</tt> responses (status code 401).
#
# Authentication is required, but either was not provided or failed.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#401].
#
class HTTPUnauthorized < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Payment Required</tt> responses (status code 402).
#
# Reserved for future use.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#402].
#
class HTTPPaymentRequired < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Forbidden</tt> responses (status code 403).
#
# The request contained valid data and was understood by the server,
# but the server is refusing action.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#403].
#
class HTTPForbidden < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Not Found</tt> responses (status code 404).
#
# The requested resource could not be found but may be available in the future.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#404].
#
class HTTPNotFound < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Method Not Allowed</tt> responses (status code 405).
#
# The request method is not supported for the requested resource.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#405].
#
class HTTPMethodNotAllowed < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Not Acceptable</tt> responses (status code 406).
#
# The requested resource is capable of generating only content
# that not acceptable according to the Accept headers sent in the request.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#406].
#
class HTTPNotAcceptable < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Proxy Authentication Required</tt> responses (status code 407).
#
# The client must first authenticate itself with the proxy.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-re].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#407].
#
class HTTPProxyAuthenticationRequired < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Request Timeout</tt> responses (status code 408).
#
# The server timed out waiting for the request.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#408].
#
class HTTPRequestTimeout < HTTPClientError
HAS_BODY = true
end
HTTPRequestTimeOut = HTTPRequestTimeout
# Response class for <tt>Conflict</tt> responses (status code 409).
#
# The request could not be processed because of conflict in the current state of the resource.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#409].
#
class HTTPConflict < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Gone</tt> responses (status code 410).
#
# The resource requested was previously in use but is no longer available
# and will not be available again.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#410].
#
class HTTPGone < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Length Required</tt> responses (status code 411).
#
# The request did not specify the length of its content,
# which is required by the requested resource.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#411].
#
class HTTPLengthRequired < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Precondition Failed</tt> responses (status code 412).
#
# The server does not meet one of the preconditions
# specified in the request headers.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#412].
#
class HTTPPreconditionFailed < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Payload Too Large</tt> responses (status code 413).
#
# The request is larger than the server is willing or able to process.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#413].
#
class HTTPPayloadTooLarge < HTTPClientError
HAS_BODY = true
end
HTTPRequestEntityTooLarge = HTTPPayloadTooLarge
# Response class for <tt>URI Too Long</tt> responses (status code 414).
#
# The URI provided was too long for the server to process.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#414].
#
class HTTPURITooLong < HTTPClientError
HAS_BODY = true
end
HTTPRequestURITooLong = HTTPURITooLong
HTTPRequestURITooLarge = HTTPRequestURITooLong
# Response class for <tt>Unsupported Media Type</tt> responses (status code 415).
#
# The request entity has a media type which the server or resource does not support.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#415].
#
class HTTPUnsupportedMediaType < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Range Not Satisfiable</tt> responses (status code 416).
#
# The request entity has a media type which the server or resource does not support.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#416].
#
class HTTPRangeNotSatisfiable < HTTPClientError
HAS_BODY = true
end
HTTPRequestedRangeNotSatisfiable = HTTPRangeNotSatisfiable
# Response class for <tt>Expectation Failed</tt> responses (status code 417).
#
# The server cannot meet the requirements of the Expect request-header field.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#417].
#
class HTTPExpectationFailed < HTTPClientError
HAS_BODY = true
end
# 418 I'm a teapot - RFC 2324; a joke RFC
# See https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#418.
# 420 Enhance Your Calm - Twitter
# Response class for <tt>Misdirected Request</tt> responses (status code 421).
#
# The request was directed at a server that is not able to produce a response.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#421].
#
class HTTPMisdirectedRequest < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Unprocessable Entity</tt> responses (status code 422).
#
# The request was well-formed but had semantic errors.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#422].
#
class HTTPUnprocessableEntity < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Locked (WebDAV)</tt> responses (status code 423).
#
# The requested resource is locked.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.3].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#423].
#
class HTTPLocked < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Failed Dependency (WebDAV)</tt> responses (status code 424).
#
# The request failed because it depended on another request and that request failed.
# See {424 Failed Dependency (WebDAV)}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424].
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.4].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#424].
#
class HTTPFailedDependency < HTTPClientError
HAS_BODY = true
end
# 425 Too Early
# https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#425.
# Response class for <tt>Upgrade Required</tt> responses (status code 426).
#
# The client should switch to the protocol given in the Upgrade header field.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#426].
#
class HTTPUpgradeRequired < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Precondition Required</tt> responses (status code 428).
#
# The origin server requires the request to be conditional.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428].
# - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-3].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#428].
#
class HTTPPreconditionRequired < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Too Many Requests</tt> responses (status code 429).
#
# The user has sent too many requests in a given amount of time.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429].
# - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-4].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#429].
#
class HTTPTooManyRequests < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Request Header Fields Too Large</tt> responses (status code 431).
#
# An individual header field is too large,
# or all the header fields collectively, are too large.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431].
# - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-5].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#431].
#
class HTTPRequestHeaderFieldsTooLarge < HTTPClientError
HAS_BODY = true
end
# Response class for <tt>Unavailable For Legal Reasons</tt> responses (status code 451).
#
# A server operator has received a legal demand to deny access to a resource or to a set of resources
# that includes the requested resource.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451].
# - {RFC 7725}[https://www.rfc-editor.org/rfc/rfc7725.html#section-3].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#451].
#
class HTTPUnavailableForLegalReasons < HTTPClientError
HAS_BODY = true
end
# 444 No Response - Nginx
# 449 Retry With - Microsoft
# 450 Blocked by Windows Parental Controls - Microsoft
# 499 Client Closed Request - Nginx
# Response class for <tt>Internal Server Error</tt> responses (status code 500).
#
# An unexpected condition was encountered and no more specific message is suitable.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#500].
#
class HTTPInternalServerError < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Not Implemented</tt> responses (status code 501).
#
# The server either does not recognize the request method,
# or it lacks the ability to fulfil the request.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#501].
#
class HTTPNotImplemented < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Bad Gateway</tt> responses (status code 502).
#
# The server was acting as a gateway or proxy
# and received an invalid response from the upstream server.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#502].
#
class HTTPBadGateway < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Service Unavailable</tt> responses (status code 503).
#
# The server cannot handle the request
# (because it is overloaded or down for maintenance).
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#503].
#
class HTTPServiceUnavailable < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Gateway Timeout</tt> responses (status code 504).
#
# The server was acting as a gateway or proxy
# and did not receive a timely response from the upstream server.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#504].
#
class HTTPGatewayTimeout < HTTPServerError
HAS_BODY = true
end
HTTPGatewayTimeOut = HTTPGatewayTimeout
# Response class for <tt>HTTP Version Not Supported</tt> responses (status code 505).
#
# The server does not support the HTTP version used in the request.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505].
# - {RFC 9110}[https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-suppor].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#505].
#
class HTTPVersionNotSupported < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Variant Also Negotiates</tt> responses (status code 506).
#
# Transparent content negotiation for the request results in a circular reference.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/506].
# - {RFC 2295}[https://www.rfc-editor.org/rfc/rfc2295#section-8.1].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#506].
#
class HTTPVariantAlsoNegotiates < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Insufficient Storage (WebDAV)</tt> responses (status code 507).
#
# The server is unable to store the representation needed to complete the request.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/507].
# - {RFC 4918}[https://www.rfc-editor.org/rfc/rfc4918#section-11.5].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#507].
#
class HTTPInsufficientStorage < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Loop Detected (WebDAV)</tt> responses (status code 508).
#
# The server detected an infinite loop while processing the request.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/508].
# - {RFC 5942}[https://www.rfc-editor.org/rfc/rfc5842.html#section-7.2].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#508].
#
class HTTPLoopDetected < HTTPServerError
HAS_BODY = true
end
# 509 Bandwidth Limit Exceeded - Apache bw/limited extension
# Response class for <tt>Not Extended</tt> responses (status code 510).
#
# Further extensions to the request are required for the server to fulfill it.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/510].
# - {RFC 2774}[https://www.rfc-editor.org/rfc/rfc2774.html#section-7].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#510].
#
class HTTPNotExtended < HTTPServerError
HAS_BODY = true
end
# Response class for <tt>Network Authentication Required</tt> responses (status code 511).
#
# The client needs to authenticate to gain network access.
#
# :include: doc/net-http/included_getters.rdoc
#
# References:
#
# - {Mozilla}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/511].
# - {RFC 6585}[https://www.rfc-editor.org/rfc/rfc6585#section-6].
# - {Wikipedia}[https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#511].
#
class HTTPNetworkAuthenticationRequired < HTTPServerError
HAS_BODY = true
end
end
class Net::HTTPResponse
CODE_CLASS_TO_OBJ = {
'1' => Net::HTTPInformation,
'2' => Net::HTTPSuccess,
'3' => Net::HTTPRedirection,
'4' => Net::HTTPClientError,
'5' => Net::HTTPServerError
}
CODE_TO_OBJ = {
'100' => Net::HTTPContinue,
'101' => Net::HTTPSwitchProtocol,
'102' => Net::HTTPProcessing,
'103' => Net::HTTPEarlyHints,
'200' => Net::HTTPOK,
'201' => Net::HTTPCreated,
'202' => Net::HTTPAccepted,
'203' => Net::HTTPNonAuthoritativeInformation,
'204' => Net::HTTPNoContent,
'205' => Net::HTTPResetContent,
'206' => Net::HTTPPartialContent,
'207' => Net::HTTPMultiStatus,
'208' => Net::HTTPAlreadyReported,
'226' => Net::HTTPIMUsed,
'300' => Net::HTTPMultipleChoices,
'301' => Net::HTTPMovedPermanently,
'302' => Net::HTTPFound,
'303' => Net::HTTPSeeOther,
'304' => Net::HTTPNotModified,
'305' => Net::HTTPUseProxy,
'307' => Net::HTTPTemporaryRedirect,
'308' => Net::HTTPPermanentRedirect,
'400' => Net::HTTPBadRequest,
'401' => Net::HTTPUnauthorized,
'402' => Net::HTTPPaymentRequired,
'403' => Net::HTTPForbidden,
'404' => Net::HTTPNotFound,
'405' => Net::HTTPMethodNotAllowed,
'406' => Net::HTTPNotAcceptable,
'407' => Net::HTTPProxyAuthenticationRequired,
'408' => Net::HTTPRequestTimeout,
'409' => Net::HTTPConflict,
'410' => Net::HTTPGone,
'411' => Net::HTTPLengthRequired,
'412' => Net::HTTPPreconditionFailed,
'413' => Net::HTTPPayloadTooLarge,
'414' => Net::HTTPURITooLong,
'415' => Net::HTTPUnsupportedMediaType,
'416' => Net::HTTPRangeNotSatisfiable,
'417' => Net::HTTPExpectationFailed,
'421' => Net::HTTPMisdirectedRequest,
'422' => Net::HTTPUnprocessableEntity,
'423' => Net::HTTPLocked,
'424' => Net::HTTPFailedDependency,
'426' => Net::HTTPUpgradeRequired,
'428' => Net::HTTPPreconditionRequired,
'429' => Net::HTTPTooManyRequests,
'431' => Net::HTTPRequestHeaderFieldsTooLarge,
'451' => Net::HTTPUnavailableForLegalReasons,
'500' => Net::HTTPInternalServerError,
'501' => Net::HTTPNotImplemented,
'502' => Net::HTTPBadGateway,
'503' => Net::HTTPServiceUnavailable,
'504' => Net::HTTPGatewayTimeout,
'505' => Net::HTTPVersionNotSupported,
'506' => Net::HTTPVariantAlsoNegotiates,
'507' => Net::HTTPInsufficientStorage,
'508' => Net::HTTPLoopDetected,
'510' => Net::HTTPNotExtended,
'511' => Net::HTTPNetworkAuthenticationRequired,
}
end
share/ruby/net/protocol.rb 0000644 00000026772 15173517737 0011641 0 ustar 00 # frozen_string_literal: true
#
# = net/protocol.rb
#
#--
# Copyright (c) 1999-2004 Yukihiro Matsumoto
# Copyright (c) 1999-2004 Minero Aoki
#
# written and maintained by Minero Aoki <aamine@loveruby.net>
#
# This program is free software. You can re-distribute and/or
# modify this program under the same terms as Ruby itself,
# Ruby Distribute License or GNU General Public License.
#
# $Id$
#++
#
# WARNING: This file is going to remove.
# Do not rely on the implementation written in this file.
#
require 'socket'
require 'timeout'
require 'io/wait'
module Net # :nodoc:
class Protocol #:nodoc: internal use only
VERSION = "0.2.2"
private
def Protocol.protocol_param(name, val)
module_eval(<<-End, __FILE__, __LINE__ + 1)
def #{name}
#{val}
end
End
end
def ssl_socket_connect(s, timeout)
if timeout
while true
raise Net::OpenTimeout if timeout <= 0
start = Process.clock_gettime Process::CLOCK_MONOTONIC
# to_io is required because SSLSocket doesn't have wait_readable yet
case s.connect_nonblock(exception: false)
when :wait_readable; s.to_io.wait_readable(timeout)
when :wait_writable; s.to_io.wait_writable(timeout)
else; break
end
timeout -= Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
end
else
s.connect
end
end
end
class ProtocolError < StandardError; end
class ProtoSyntaxError < ProtocolError; end
class ProtoFatalError < ProtocolError; end
class ProtoUnknownError < ProtocolError; end
class ProtoServerError < ProtocolError; end
class ProtoAuthError < ProtocolError; end
class ProtoCommandError < ProtocolError; end
class ProtoRetriableError < ProtocolError; end
ProtocRetryError = ProtoRetriableError
##
# OpenTimeout, a subclass of Timeout::Error, is raised if a connection cannot
# be created within the open_timeout.
class OpenTimeout < Timeout::Error; end
##
# ReadTimeout, a subclass of Timeout::Error, is raised if a chunk of the
# response cannot be read within the read_timeout.
class ReadTimeout < Timeout::Error
def initialize(io = nil)
@io = io
end
attr_reader :io
def message
msg = super
if @io
msg = "#{msg} with #{@io.inspect}"
end
msg
end
end
##
# WriteTimeout, a subclass of Timeout::Error, is raised if a chunk of the
# response cannot be written within the write_timeout. Not raised on Windows.
class WriteTimeout < Timeout::Error
def initialize(io = nil)
@io = io
end
attr_reader :io
def message
msg = super
if @io
msg = "#{msg} with #{@io.inspect}"
end
msg
end
end
class BufferedIO #:nodoc: internal use only
def initialize(io, read_timeout: 60, write_timeout: 60, continue_timeout: nil, debug_output: nil)
@io = io
@read_timeout = read_timeout
@write_timeout = write_timeout
@continue_timeout = continue_timeout
@debug_output = debug_output
@rbuf = ''.b
@rbuf_empty = true
@rbuf_offset = 0
end
attr_reader :io
attr_accessor :read_timeout
attr_accessor :write_timeout
attr_accessor :continue_timeout
attr_accessor :debug_output
def inspect
"#<#{self.class} io=#{@io}>"
end
def eof?
@io.eof?
end
def closed?
@io.closed?
end
def close
@io.close
end
#
# Read
#
public
def read(len, dest = ''.b, ignore_eof = false)
LOG "reading #{len} bytes..."
read_bytes = 0
begin
while read_bytes + rbuf_size < len
if s = rbuf_consume_all
read_bytes += s.bytesize
dest << s
end
rbuf_fill
end
s = rbuf_consume(len - read_bytes)
read_bytes += s.bytesize
dest << s
rescue EOFError
raise unless ignore_eof
end
LOG "read #{read_bytes} bytes"
dest
end
def read_all(dest = ''.b)
LOG 'reading all...'
read_bytes = 0
begin
while true
if s = rbuf_consume_all
read_bytes += s.bytesize
dest << s
end
rbuf_fill
end
rescue EOFError
;
end
LOG "read #{read_bytes} bytes"
dest
end
def readuntil(terminator, ignore_eof = false)
offset = @rbuf_offset
begin
until idx = @rbuf.index(terminator, offset)
offset = @rbuf.bytesize
rbuf_fill
end
return rbuf_consume(idx + terminator.bytesize - @rbuf_offset)
rescue EOFError
raise unless ignore_eof
return rbuf_consume
end
end
def readline
readuntil("\n").chop
end
private
BUFSIZE = 1024 * 16
def rbuf_fill
tmp = @rbuf_empty ? @rbuf : nil
case rv = @io.read_nonblock(BUFSIZE, tmp, exception: false)
when String
@rbuf_empty = false
if rv.equal?(tmp)
@rbuf_offset = 0
else
@rbuf << rv
rv.clear
end
return
when :wait_readable
(io = @io.to_io).wait_readable(@read_timeout) or raise Net::ReadTimeout.new(io)
# continue looping
when :wait_writable
# OpenSSL::Buffering#read_nonblock may fail with IO::WaitWritable.
# http://www.openssl.org/support/faq.html#PROG10
(io = @io.to_io).wait_writable(@read_timeout) or raise Net::ReadTimeout.new(io)
# continue looping
when nil
raise EOFError, 'end of file reached'
end while true
end
def rbuf_flush
if @rbuf_empty
@rbuf.clear
@rbuf_offset = 0
end
nil
end
def rbuf_size
@rbuf.bytesize - @rbuf_offset
end
def rbuf_consume_all
rbuf_consume if rbuf_size > 0
end
def rbuf_consume(len = nil)
if @rbuf_offset == 0 && (len.nil? || len == @rbuf.bytesize)
s = @rbuf
@rbuf = ''.b
@rbuf_offset = 0
@rbuf_empty = true
elsif len.nil?
s = @rbuf.byteslice(@rbuf_offset..-1)
@rbuf = ''.b
@rbuf_offset = 0
@rbuf_empty = true
else
s = @rbuf.byteslice(@rbuf_offset, len)
@rbuf_offset += len
@rbuf_empty = @rbuf_offset == @rbuf.bytesize
rbuf_flush
end
@debug_output << %Q[-> #{s.dump}\n] if @debug_output
s
end
#
# Write
#
public
def write(*strs)
writing {
write0(*strs)
}
end
alias << write
def writeline(str)
writing {
write0 str + "\r\n"
}
end
private
def writing
@written_bytes = 0
@debug_output << '<- ' if @debug_output
yield
@debug_output << "\n" if @debug_output
bytes = @written_bytes
@written_bytes = nil
bytes
end
def write0(*strs)
@debug_output << strs.map(&:dump).join if @debug_output
orig_written_bytes = @written_bytes
strs.each_with_index do |str, i|
need_retry = true
case len = @io.write_nonblock(str, exception: false)
when Integer
@written_bytes += len
len -= str.bytesize
if len == 0
if strs.size == i+1
return @written_bytes - orig_written_bytes
else
need_retry = false
# next string
end
elsif len < 0
str = str.byteslice(len, -len)
else # len > 0
need_retry = false
# next string
end
# continue looping
when :wait_writable
(io = @io.to_io).wait_writable(@write_timeout) or raise Net::WriteTimeout.new(io)
# continue looping
end while need_retry
end
end
#
# Logging
#
private
def LOG_off
@save_debug_out = @debug_output
@debug_output = nil
end
def LOG_on
@debug_output = @save_debug_out
end
def LOG(msg)
return unless @debug_output
@debug_output << msg + "\n"
end
end
class InternetMessageIO < BufferedIO #:nodoc: internal use only
def initialize(*, **)
super
@wbuf = nil
end
#
# Read
#
def each_message_chunk
LOG 'reading message...'
LOG_off()
read_bytes = 0
while (line = readuntil("\r\n")) != ".\r\n"
read_bytes += line.size
yield line.delete_prefix('.')
end
LOG_on()
LOG "read message (#{read_bytes} bytes)"
end
# *library private* (cannot handle 'break')
def each_list_item
while (str = readuntil("\r\n")) != ".\r\n"
yield str.chop
end
end
def write_message_0(src)
prev = @written_bytes
each_crlf_line(src) do |line|
write0 dot_stuff(line)
end
@written_bytes - prev
end
#
# Write
#
def write_message(src)
LOG "writing message from #{src.class}"
LOG_off()
len = writing {
using_each_crlf_line {
write_message_0 src
}
}
LOG_on()
LOG "wrote #{len} bytes"
len
end
def write_message_by_block(&block)
LOG 'writing message from block'
LOG_off()
len = writing {
using_each_crlf_line {
begin
block.call(WriteAdapter.new(self.method(:write_message_0)))
rescue LocalJumpError
# allow `break' from writer block
end
}
}
LOG_on()
LOG "wrote #{len} bytes"
len
end
private
def dot_stuff(s)
s.sub(/\A\./, '..')
end
def using_each_crlf_line
@wbuf = ''.b
yield
if not @wbuf.empty? # unterminated last line
write0 dot_stuff(@wbuf.chomp) + "\r\n"
elsif @written_bytes == 0 # empty src
write0 "\r\n"
end
write0 ".\r\n"
@wbuf = nil
end
def each_crlf_line(src)
buffer_filling(@wbuf, src) do
while line = @wbuf.slice!(/\A[^\r\n]*(?:\n|\r(?:\n|(?!\z)))/)
yield line.chomp("\n") + "\r\n"
end
end
end
def buffer_filling(buf, src)
case src
when String # for speeding up.
0.step(src.size - 1, 1024) do |i|
buf << src[i, 1024]
yield
end
when File # for speeding up.
while s = src.read(1024)
buf << s
yield
end
else # generic reader
src.each do |str|
buf << str
yield if buf.size > 1024
end
yield unless buf.empty?
end
end
end
#
# The writer adapter class
#
class WriteAdapter
def initialize(writer)
@writer = writer
end
def inspect
"#<#{self.class} writer=#{@writer.inspect}>"
end
def write(str)
@writer.call(str)
end
alias print write
def <<(str)
write str
self
end
def puts(str = '')
write str.chomp("\n") + "\n"
end
def printf(*args)
write sprintf(*args)
end
end
class ReadAdapter #:nodoc: internal use only
def initialize(block)
@block = block
end
def inspect
"#<#{self.class}>"
end
def <<(str)
call_block(str, &@block) if @block
end
private
# This method is needed because @block must be called by yield,
# not Proc#call. You can see difference when using `break' in
# the block.
def call_block(str)
yield str
end
end
module NetPrivate #:nodoc: obsolete
Socket = ::Net::InternetMessageIO
end
end # module Net
share/ruby/net/http.rb 0000644 00000245707 15173517737 0010760 0 ustar 00 # frozen_string_literal: true
#
# = net/http.rb
#
# Copyright (c) 1999-2007 Yukihiro Matsumoto
# Copyright (c) 1999-2007 Minero Aoki
# Copyright (c) 2001 GOTOU Yuuzou
#
# Written and maintained by Minero Aoki <aamine@loveruby.net>.
# HTTPS support added by GOTOU Yuuzou <gotoyuzo@notwork.org>.
#
# This file is derived from "http-access.rb".
#
# Documented by Minero Aoki; converted to RDoc by William Webber.
#
# This program is free software. You can re-distribute and/or
# modify this program under the same terms of ruby itself ---
# Ruby Distribution License or GNU General Public License.
#
# See Net::HTTP for an overview and examples.
#
require 'net/protocol'
require 'uri'
require 'resolv'
autoload :OpenSSL, 'openssl'
module Net #:nodoc:
# :stopdoc:
class HTTPBadResponse < StandardError; end
class HTTPHeaderSyntaxError < StandardError; end
# :startdoc:
# \Class \Net::HTTP provides a rich library that implements the client
# in a client-server model that uses the \HTTP request-response protocol.
# For information about \HTTP, see:
#
# - {Hypertext Transfer Protocol}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol].
# - {Technical overview}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Technical_overview].
#
# == About the Examples
#
# :include: doc/net-http/examples.rdoc
#
# == Strategies
#
# - If you will make only a few GET requests,
# consider using {OpenURI}[rdoc-ref:OpenURI].
# - If you will make only a few requests of all kinds,
# consider using the various singleton convenience methods in this class.
# Each of the following methods automatically starts and finishes
# a {session}[rdoc-ref:Net::HTTP@Sessions] that sends a single request:
#
# # Return string response body.
# Net::HTTP.get(hostname, path)
# Net::HTTP.get(uri)
#
# # Write string response body to $stdout.
# Net::HTTP.get_print(hostname, path)
# Net::HTTP.get_print(uri)
#
# # Return response as Net::HTTPResponse object.
# Net::HTTP.get_response(hostname, path)
# Net::HTTP.get_response(uri)
# data = '{"title": "foo", "body": "bar", "userId": 1}'
# Net::HTTP.post(uri, data)
# params = {title: 'foo', body: 'bar', userId: 1}
# Net::HTTP.post_form(uri, params)
#
# - If performance is important, consider using sessions, which lower request overhead.
# This {session}[rdoc-ref:Net::HTTP@Sessions] has multiple requests for
# {HTTP methods}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods]
# and {WebDAV methods}[https://en.wikipedia.org/wiki/WebDAV#Implementation]:
#
# Net::HTTP.start(hostname) do |http|
# # Session started automatically before block execution.
# http.get(path)
# http.head(path)
# body = 'Some text'
# http.post(path, body) # Can also have a block.
# http.put(path, body)
# http.delete(path)
# http.options(path)
# http.trace(path)
# http.patch(path, body) # Can also have a block.
# http.copy(path)
# http.lock(path, body)
# http.mkcol(path, body)
# http.move(path)
# http.propfind(path, body)
# http.proppatch(path, body)
# http.unlock(path, body)
# # Session finished automatically at block exit.
# end
#
# The methods cited above are convenience methods that, via their few arguments,
# allow minimal control over the requests.
# For greater control, consider using {request objects}[rdoc-ref:Net::HTTPRequest].
#
# == URIs
#
# On the internet, a URI
# ({Universal Resource Identifier}[https://en.wikipedia.org/wiki/Uniform_Resource_Identifier])
# is a string that identifies a particular resource.
# It consists of some or all of: scheme, hostname, path, query, and fragment;
# see {URI syntax}[https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#Syntax].
#
# A Ruby {URI::Generic}[rdoc-ref:URI::Generic] object
# represents an internet URI.
# It provides, among others, methods
# +scheme+, +hostname+, +path+, +query+, and +fragment+.
#
# === Schemes
#
# An internet \URI has
# a {scheme}[https://en.wikipedia.org/wiki/List_of_URI_schemes].
#
# The two schemes supported in \Net::HTTP are <tt>'https'</tt> and <tt>'http'</tt>:
#
# uri.scheme # => "https"
# URI('http://example.com').scheme # => "http"
#
# === Hostnames
#
# A hostname identifies a server (host) to which requests may be sent:
#
# hostname = uri.hostname # => "jsonplaceholder.typicode.com"
# Net::HTTP.start(hostname) do |http|
# # Some HTTP stuff.
# end
#
# === Paths
#
# A host-specific path identifies a resource on the host:
#
# _uri = uri.dup
# _uri.path = '/todos/1'
# hostname = _uri.hostname
# path = _uri.path
# Net::HTTP.get(hostname, path)
#
# === Queries
#
# A host-specific query adds name/value pairs to the URI:
#
# _uri = uri.dup
# params = {userId: 1, completed: false}
# _uri.query = URI.encode_www_form(params)
# _uri # => #<URI::HTTPS https://jsonplaceholder.typicode.com?userId=1&completed=false>
# Net::HTTP.get(_uri)
#
# === Fragments
#
# A {URI fragment}[https://en.wikipedia.org/wiki/URI_fragment] has no effect
# in \Net::HTTP;
# the same data is returned, regardless of whether a fragment is included.
#
# == Request Headers
#
# Request headers may be used to pass additional information to the host,
# similar to arguments passed in a method call;
# each header is a name/value pair.
#
# Each of the \Net::HTTP methods that sends a request to the host
# has optional argument +headers+,
# where the headers are expressed as a hash of field-name/value pairs:
#
# headers = {Accept: 'application/json', Connection: 'Keep-Alive'}
# Net::HTTP.get(uri, headers)
#
# See lists of both standard request fields and common request fields at
# {Request Fields}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields].
# A host may also accept other custom fields.
#
# == \HTTP Sessions
#
# A _session_ is a connection between a server (host) and a client that:
#
# - Is begun by instance method Net::HTTP#start.
# - May contain any number of requests.
# - Is ended by instance method Net::HTTP#finish.
#
# See example sessions at {Strategies}[rdoc-ref:Net::HTTP@Strategies].
#
# === Session Using \Net::HTTP.start
#
# If you have many requests to make to a single host (and port),
# consider using singleton method Net::HTTP.start with a block;
# the method handles the session automatically by:
#
# - Calling #start before block execution.
# - Executing the block.
# - Calling #finish after block execution.
#
# In the block, you can use these instance methods,
# each of which that sends a single request:
#
# - {HTTP methods}[https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol#Request_methods]:
#
# - #get, #request_get: GET.
# - #head, #request_head: HEAD.
# - #post, #request_post: POST.
# - #delete: DELETE.
# - #options: OPTIONS.
# - #trace: TRACE.
# - #patch: PATCH.
#
# - {WebDAV methods}[https://en.wikipedia.org/wiki/WebDAV#Implementation]:
#
# - #copy: COPY.
# - #lock: LOCK.
# - #mkcol: MKCOL.
# - #move: MOVE.
# - #propfind: PROPFIND.
# - #proppatch: PROPPATCH.
# - #unlock: UNLOCK.
#
# === Session Using \Net::HTTP.start and \Net::HTTP.finish
#
# You can manage a session manually using methods #start and #finish:
#
# http = Net::HTTP.new(hostname)
# http.start
# http.get('/todos/1')
# http.get('/todos/2')
# http.delete('/posts/1')
# http.finish # Needed to free resources.
#
# === Single-Request Session
#
# Certain convenience methods automatically handle a session by:
#
# - Creating an \HTTP object
# - Starting a session.
# - Sending a single request.
# - Finishing the session.
# - Destroying the object.
#
# Such methods that send GET requests:
#
# - ::get: Returns the string response body.
# - ::get_print: Writes the string response body to $stdout.
# - ::get_response: Returns a Net::HTTPResponse object.
#
# Such methods that send POST requests:
#
# - ::post: Posts data to the host.
# - ::post_form: Posts form data to the host.
#
# == \HTTP Requests and Responses
#
# Many of the methods above are convenience methods,
# each of which sends a request and returns a string
# without directly using \Net::HTTPRequest and \Net::HTTPResponse objects.
#
# You can, however, directly create a request object, send the request,
# and retrieve the response object; see:
#
# - Net::HTTPRequest.
# - Net::HTTPResponse.
#
# == Following Redirection
#
# Each returned response is an instance of a subclass of Net::HTTPResponse.
# See the {response class hierarchy}[rdoc-ref:Net::HTTPResponse@Response+Subclasses].
#
# In particular, class Net::HTTPRedirection is the parent
# of all redirection classes.
# This allows you to craft a case statement to handle redirections properly:
#
# def fetch(uri, limit = 10)
# # You should choose a better exception.
# raise ArgumentError, 'Too many HTTP redirects' if limit == 0
#
# res = Net::HTTP.get_response(URI(uri))
# case res
# when Net::HTTPSuccess # Any success class.
# res
# when Net::HTTPRedirection # Any redirection class.
# location = res['Location']
# warn "Redirected to #{location}"
# fetch(location, limit - 1)
# else # Any other class.
# res.value
# end
# end
#
# fetch(uri)
#
# == Basic Authentication
#
# Basic authentication is performed according to
# {RFC2617}[http://www.ietf.org/rfc/rfc2617.txt]:
#
# req = Net::HTTP::Get.new(uri)
# req.basic_auth('user', 'pass')
# res = Net::HTTP.start(hostname) do |http|
# http.request(req)
# end
#
# == Streaming Response Bodies
#
# By default \Net::HTTP reads an entire response into memory. If you are
# handling large files or wish to implement a progress bar you can instead
# stream the body directly to an IO.
#
# Net::HTTP.start(hostname) do |http|
# req = Net::HTTP::Get.new(uri)
# http.request(req) do |res|
# open('t.tmp', 'w') do |f|
# res.read_body do |chunk|
# f.write chunk
# end
# end
# end
# end
#
# == HTTPS
#
# HTTPS is enabled for an \HTTP connection by Net::HTTP#use_ssl=:
#
# Net::HTTP.start(hostname, :use_ssl => true) do |http|
# req = Net::HTTP::Get.new(uri)
# res = http.request(req)
# end
#
# Or if you simply want to make a GET request, you may pass in a URI
# object that has an \HTTPS URL. \Net::HTTP automatically turns on TLS
# verification if the URI object has a 'https' URI scheme:
#
# uri # => #<URI::HTTPS https://jsonplaceholder.typicode.com/>
# Net::HTTP.get(uri)
#
# == Proxy Server
#
# An \HTTP object can have
# a {proxy server}[https://en.wikipedia.org/wiki/Proxy_server].
#
# You can create an \HTTP object with a proxy server
# using method Net::HTTP.new or method Net::HTTP.start.
#
# The proxy may be defined either by argument +p_addr+
# or by environment variable <tt>'http_proxy'</tt>.
#
# === Proxy Using Argument +p_addr+ as a \String
#
# When argument +p_addr+ is a string hostname,
# the returned +http+ has the given host as its proxy:
#
# http = Net::HTTP.new(hostname, nil, 'proxy.example')
# http.proxy? # => true
# http.proxy_from_env? # => false
# http.proxy_address # => "proxy.example"
# # These use default values.
# http.proxy_port # => 80
# http.proxy_user # => nil
# http.proxy_pass # => nil
#
# The port, username, and password for the proxy may also be given:
#
# http = Net::HTTP.new(hostname, nil, 'proxy.example', 8000, 'pname', 'ppass')
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
# http.proxy? # => true
# http.proxy_from_env? # => false
# http.proxy_address # => "proxy.example"
# http.proxy_port # => 8000
# http.proxy_user # => "pname"
# http.proxy_pass # => "ppass"
#
# === Proxy Using '<tt>ENV['http_proxy']</tt>'
#
# When environment variable <tt>'http_proxy'</tt>
# is set to a \URI string,
# the returned +http+ will have the server at that URI as its proxy;
# note that the \URI string must have a protocol
# such as <tt>'http'</tt> or <tt>'https'</tt>:
#
# ENV['http_proxy'] = 'http://example.com'
# http = Net::HTTP.new(hostname)
# http.proxy? # => true
# http.proxy_from_env? # => true
# http.proxy_address # => "example.com"
# # These use default values.
# http.proxy_port # => 80
# http.proxy_user # => nil
# http.proxy_pass # => nil
#
# The \URI string may include proxy username, password, and port number:
#
# ENV['http_proxy'] = 'http://pname:ppass@example.com:8000'
# http = Net::HTTP.new(hostname)
# http.proxy? # => true
# http.proxy_from_env? # => true
# http.proxy_address # => "example.com"
# http.proxy_port # => 8000
# http.proxy_user # => "pname"
# http.proxy_pass # => "ppass"
#
# === Filtering Proxies
#
# With method Net::HTTP.new (but not Net::HTTP.start),
# you can use argument +p_no_proxy+ to filter proxies:
#
# - Reject a certain address:
#
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
# http.proxy_address # => nil
#
# - Reject certain domains or subdomains:
#
# http = Net::HTTP.new('example.com', nil, 'my.proxy.example', 8000, 'pname', 'ppass', 'proxy.example')
# http.proxy_address # => nil
#
# - Reject certain addresses and port combinations:
#
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:1234')
# http.proxy_address # => "proxy.example"
#
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'proxy.example:8000')
# http.proxy_address # => nil
#
# - Reject a list of the types above delimited using a comma:
#
# http = Net::HTTP.new('example.com', nil, 'proxy.example', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
# http.proxy_address # => nil
#
# http = Net::HTTP.new('example.com', nil, 'my.proxy', 8000, 'pname', 'ppass', 'my.proxy,proxy.example:8000')
# http.proxy_address # => nil
#
# == Compression and Decompression
#
# \Net::HTTP does not compress the body of a request before sending.
#
# By default, \Net::HTTP adds header <tt>'Accept-Encoding'</tt>
# to a new {request object}[rdoc-ref:Net::HTTPRequest]:
#
# Net::HTTP::Get.new(uri)['Accept-Encoding']
# # => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
#
# This requests the server to zip-encode the response body if there is one;
# the server is not required to do so.
#
# \Net::HTTP does not automatically decompress a response body
# if the response has header <tt>'Content-Range'</tt>.
#
# Otherwise decompression (or not) depends on the value of header
# {Content-Encoding}[https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#content-encoding-response-header]:
#
# - <tt>'deflate'</tt>, <tt>'gzip'</tt>, or <tt>'x-gzip'</tt>:
# decompresses the body and deletes the header.
# - <tt>'none'</tt> or <tt>'identity'</tt>:
# does not decompress the body, but deletes the header.
# - Any other value:
# leaves the body and header unchanged.
#
# == What's Here
#
# This is a categorized summary of methods and attributes.
#
# === \Net::HTTP Objects
#
# - {::new}[rdoc-ref:Net::HTTP.new]:
# Creates a new instance.
# - {#inspect}[rdoc-ref:Net::HTTP#inspect]:
# Returns a string representation of +self+.
#
# === Sessions
#
# - {::start}[rdoc-ref:Net::HTTP.start]:
# Begins a new session in a new \Net::HTTP object.
# - {#started?}[rdoc-ref:Net::HTTP#started?]
# (aliased as {#active?}[rdoc-ref:Net::HTTP#active?]):
# Returns whether in a session.
# - {#finish}[rdoc-ref:Net::HTTP#finish]:
# Ends an active session.
# - {#start}[rdoc-ref:Net::HTTP#start]:
# Begins a new session in an existing \Net::HTTP object (+self+).
#
# === Connections
#
# - {:continue_timeout}[rdoc-ref:Net::HTTP#continue_timeout]:
# Returns the continue timeout.
# - {#continue_timeout=}[rdoc-ref:Net::HTTP#continue_timeout=]:
# Sets the continue timeout seconds.
# - {:keep_alive_timeout}[rdoc-ref:Net::HTTP#keep_alive_timeout]:
# Returns the keep-alive timeout.
# - {:keep_alive_timeout=}[rdoc-ref:Net::HTTP#keep_alive_timeout=]:
# Sets the keep-alive timeout.
# - {:max_retries}[rdoc-ref:Net::HTTP#max_retries]:
# Returns the maximum retries.
# - {#max_retries=}[rdoc-ref:Net::HTTP#max_retries=]:
# Sets the maximum retries.
# - {:open_timeout}[rdoc-ref:Net::HTTP#open_timeout]:
# Returns the open timeout.
# - {:open_timeout=}[rdoc-ref:Net::HTTP#open_timeout=]:
# Sets the open timeout.
# - {:read_timeout}[rdoc-ref:Net::HTTP#read_timeout]:
# Returns the open timeout.
# - {:read_timeout=}[rdoc-ref:Net::HTTP#read_timeout=]:
# Sets the read timeout.
# - {:ssl_timeout}[rdoc-ref:Net::HTTP#ssl_timeout]:
# Returns the ssl timeout.
# - {:ssl_timeout=}[rdoc-ref:Net::HTTP#ssl_timeout=]:
# Sets the ssl timeout.
# - {:write_timeout}[rdoc-ref:Net::HTTP#write_timeout]:
# Returns the write timeout.
# - {write_timeout=}[rdoc-ref:Net::HTTP#write_timeout=]:
# Sets the write timeout.
#
# === Requests
#
# - {::get}[rdoc-ref:Net::HTTP.get]:
# Sends a GET request and returns the string response body.
# - {::get_print}[rdoc-ref:Net::HTTP.get_print]:
# Sends a GET request and write the string response body to $stdout.
# - {::get_response}[rdoc-ref:Net::HTTP.get_response]:
# Sends a GET request and returns a response object.
# - {::post_form}[rdoc-ref:Net::HTTP.post_form]:
# Sends a POST request with form data and returns a response object.
# - {::post}[rdoc-ref:Net::HTTP.post]:
# Sends a POST request with data and returns a response object.
# - {#copy}[rdoc-ref:Net::HTTP#copy]:
# Sends a COPY request and returns a response object.
# - {#delete}[rdoc-ref:Net::HTTP#delete]:
# Sends a DELETE request and returns a response object.
# - {#get}[rdoc-ref:Net::HTTP#get]:
# Sends a GET request and returns a response object.
# - {#head}[rdoc-ref:Net::HTTP#head]:
# Sends a HEAD request and returns a response object.
# - {#lock}[rdoc-ref:Net::HTTP#lock]:
# Sends a LOCK request and returns a response object.
# - {#mkcol}[rdoc-ref:Net::HTTP#mkcol]:
# Sends a MKCOL request and returns a response object.
# - {#move}[rdoc-ref:Net::HTTP#move]:
# Sends a MOVE request and returns a response object.
# - {#options}[rdoc-ref:Net::HTTP#options]:
# Sends a OPTIONS request and returns a response object.
# - {#patch}[rdoc-ref:Net::HTTP#patch]:
# Sends a PATCH request and returns a response object.
# - {#post}[rdoc-ref:Net::HTTP#post]:
# Sends a POST request and returns a response object.
# - {#propfind}[rdoc-ref:Net::HTTP#propfind]:
# Sends a PROPFIND request and returns a response object.
# - {#proppatch}[rdoc-ref:Net::HTTP#proppatch]:
# Sends a PROPPATCH request and returns a response object.
# - {#put}[rdoc-ref:Net::HTTP#put]:
# Sends a PUT request and returns a response object.
# - {#request}[rdoc-ref:Net::HTTP#request]:
# Sends a request and returns a response object.
# - {#request_get}[rdoc-ref:Net::HTTP#request_get]
# (aliased as {#get2}[rdoc-ref:Net::HTTP#get2]):
# Sends a GET request and forms a response object;
# if a block given, calls the block with the object,
# otherwise returns the object.
# - {#request_head}[rdoc-ref:Net::HTTP#request_head]
# (aliased as {#head2}[rdoc-ref:Net::HTTP#head2]):
# Sends a HEAD request and forms a response object;
# if a block given, calls the block with the object,
# otherwise returns the object.
# - {#request_post}[rdoc-ref:Net::HTTP#request_post]
# (aliased as {#post2}[rdoc-ref:Net::HTTP#post2]):
# Sends a POST request and forms a response object;
# if a block given, calls the block with the object,
# otherwise returns the object.
# - {#send_request}[rdoc-ref:Net::HTTP#send_request]:
# Sends a request and returns a response object.
# - {#trace}[rdoc-ref:Net::HTTP#trace]:
# Sends a TRACE request and returns a response object.
# - {#unlock}[rdoc-ref:Net::HTTP#unlock]:
# Sends an UNLOCK request and returns a response object.
#
# === Responses
#
# - {:close_on_empty_response}[rdoc-ref:Net::HTTP#close_on_empty_response]:
# Returns whether to close connection on empty response.
# - {:close_on_empty_response=}[rdoc-ref:Net::HTTP#close_on_empty_response=]:
# Sets whether to close connection on empty response.
# - {:ignore_eof}[rdoc-ref:Net::HTTP#ignore_eof]:
# Returns whether to ignore end-of-file when reading a response body
# with <tt>Content-Length</tt> headers.
# - {:ignore_eof=}[rdoc-ref:Net::HTTP#ignore_eof=]:
# Sets whether to ignore end-of-file when reading a response body
# with <tt>Content-Length</tt> headers.
# - {:response_body_encoding}[rdoc-ref:Net::HTTP#response_body_encoding]:
# Returns the encoding to use for the response body.
# - {#response_body_encoding=}[rdoc-ref:Net::HTTP#response_body_encoding=]:
# Sets the response body encoding.
#
# === Proxies
#
# - {:proxy_address}[rdoc-ref:Net::HTTP#proxy_address]:
# Returns the proxy address.
# - {:proxy_address=}[rdoc-ref:Net::HTTP#proxy_address=]:
# Sets the proxy address.
# - {::proxy_class?}[rdoc-ref:Net::HTTP.proxy_class?]:
# Returns whether +self+ is a proxy class.
# - {#proxy?}[rdoc-ref:Net::HTTP#proxy?]:
# Returns whether +self+ has a proxy.
# - {#proxy_address}[rdoc-ref:Net::HTTP#proxy_address]
# (aliased as {#proxyaddr}[rdoc-ref:Net::HTTP#proxyaddr]):
# Returns the proxy address.
# - {#proxy_from_env?}[rdoc-ref:Net::HTTP#proxy_from_env?]:
# Returns whether the proxy is taken from an environment variable.
# - {:proxy_from_env=}[rdoc-ref:Net::HTTP#proxy_from_env=]:
# Sets whether the proxy is to be taken from an environment variable.
# - {:proxy_pass}[rdoc-ref:Net::HTTP#proxy_pass]:
# Returns the proxy password.
# - {:proxy_pass=}[rdoc-ref:Net::HTTP#proxy_pass=]:
# Sets the proxy password.
# - {:proxy_port}[rdoc-ref:Net::HTTP#proxy_port]:
# Returns the proxy port.
# - {:proxy_port=}[rdoc-ref:Net::HTTP#proxy_port=]:
# Sets the proxy port.
# - {#proxy_user}[rdoc-ref:Net::HTTP#proxy_user]:
# Returns the proxy user name.
# - {:proxy_user=}[rdoc-ref:Net::HTTP#proxy_user=]:
# Sets the proxy user.
#
# === Security
#
# - {:ca_file}[rdoc-ref:Net::HTTP#ca_file]:
# Returns the path to a CA certification file.
# - {:ca_file=}[rdoc-ref:Net::HTTP#ca_file=]:
# Sets the path to a CA certification file.
# - {:ca_path}[rdoc-ref:Net::HTTP#ca_path]:
# Returns the path of to CA directory containing certification files.
# - {:ca_path=}[rdoc-ref:Net::HTTP#ca_path=]:
# Sets the path of to CA directory containing certification files.
# - {:cert}[rdoc-ref:Net::HTTP#cert]:
# Returns the OpenSSL::X509::Certificate object to be used for client certification.
# - {:cert=}[rdoc-ref:Net::HTTP#cert=]:
# Sets the OpenSSL::X509::Certificate object to be used for client certification.
# - {:cert_store}[rdoc-ref:Net::HTTP#cert_store]:
# Returns the X509::Store to be used for verifying peer certificate.
# - {:cert_store=}[rdoc-ref:Net::HTTP#cert_store=]:
# Sets the X509::Store to be used for verifying peer certificate.
# - {:ciphers}[rdoc-ref:Net::HTTP#ciphers]:
# Returns the available SSL ciphers.
# - {:ciphers=}[rdoc-ref:Net::HTTP#ciphers=]:
# Sets the available SSL ciphers.
# - {:extra_chain_cert}[rdoc-ref:Net::HTTP#extra_chain_cert]:
# Returns the extra X509 certificates to be added to the certificate chain.
# - {:extra_chain_cert=}[rdoc-ref:Net::HTTP#extra_chain_cert=]:
# Sets the extra X509 certificates to be added to the certificate chain.
# - {:key}[rdoc-ref:Net::HTTP#key]:
# Returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
# - {:key=}[rdoc-ref:Net::HTTP#key=]:
# Sets the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
# - {:max_version}[rdoc-ref:Net::HTTP#max_version]:
# Returns the maximum SSL version.
# - {:max_version=}[rdoc-ref:Net::HTTP#max_version=]:
# Sets the maximum SSL version.
# - {:min_version}[rdoc-ref:Net::HTTP#min_version]:
# Returns the minimum SSL version.
# - {:min_version=}[rdoc-ref:Net::HTTP#min_version=]:
# Sets the minimum SSL version.
# - {#peer_cert}[rdoc-ref:Net::HTTP#peer_cert]:
# Returns the X509 certificate chain for the session's socket peer.
# - {:ssl_version}[rdoc-ref:Net::HTTP#ssl_version]:
# Returns the SSL version.
# - {:ssl_version=}[rdoc-ref:Net::HTTP#ssl_version=]:
# Sets the SSL version.
# - {#use_ssl=}[rdoc-ref:Net::HTTP#use_ssl=]:
# Sets whether a new session is to use Transport Layer Security.
# - {#use_ssl?}[rdoc-ref:Net::HTTP#use_ssl?]:
# Returns whether +self+ uses SSL.
# - {:verify_callback}[rdoc-ref:Net::HTTP#verify_callback]:
# Returns the callback for the server certification verification.
# - {:verify_callback=}[rdoc-ref:Net::HTTP#verify_callback=]:
# Sets the callback for the server certification verification.
# - {:verify_depth}[rdoc-ref:Net::HTTP#verify_depth]:
# Returns the maximum depth for the certificate chain verification.
# - {:verify_depth=}[rdoc-ref:Net::HTTP#verify_depth=]:
# Sets the maximum depth for the certificate chain verification.
# - {:verify_hostname}[rdoc-ref:Net::HTTP#verify_hostname]:
# Returns the flags for server the certification verification at the beginning of the SSL/TLS session.
# - {:verify_hostname=}[rdoc-ref:Net::HTTP#verify_hostname=]:
# Sets he flags for server the certification verification at the beginning of the SSL/TLS session.
# - {:verify_mode}[rdoc-ref:Net::HTTP#verify_mode]:
# Returns the flags for server the certification verification at the beginning of the SSL/TLS session.
# - {:verify_mode=}[rdoc-ref:Net::HTTP#verify_mode=]:
# Sets the flags for server the certification verification at the beginning of the SSL/TLS session.
#
# === Addresses and Ports
#
# - {:address}[rdoc-ref:Net::HTTP#address]:
# Returns the string host name or host IP.
# - {::default_port}[rdoc-ref:Net::HTTP.default_port]:
# Returns integer 80, the default port to use for HTTP requests.
# - {::http_default_port}[rdoc-ref:Net::HTTP.http_default_port]:
# Returns integer 80, the default port to use for HTTP requests.
# - {::https_default_port}[rdoc-ref:Net::HTTP.https_default_port]:
# Returns integer 443, the default port to use for HTTPS requests.
# - {#ipaddr}[rdoc-ref:Net::HTTP#ipaddr]:
# Returns the IP address for the connection.
# - {#ipaddr=}[rdoc-ref:Net::HTTP#ipaddr=]:
# Sets the IP address for the connection.
# - {:local_host}[rdoc-ref:Net::HTTP#local_host]:
# Returns the string local host used to establish the connection.
# - {:local_host=}[rdoc-ref:Net::HTTP#local_host=]:
# Sets the string local host used to establish the connection.
# - {:local_port}[rdoc-ref:Net::HTTP#local_port]:
# Returns the integer local port used to establish the connection.
# - {:local_port=}[rdoc-ref:Net::HTTP#local_port=]:
# Sets the integer local port used to establish the connection.
# - {:port}[rdoc-ref:Net::HTTP#port]:
# Returns the integer port number.
#
# === \HTTP Version
#
# - {::version_1_2?}[rdoc-ref:Net::HTTP.version_1_2?]
# (aliased as {::is_version_1_2?}[rdoc-ref:Net::HTTP.is_version_1_2?]
# and {::version_1_2}[rdoc-ref:Net::HTTP.version_1_2]):
# Returns true; retained for compatibility.
#
# === Debugging
#
# - {#set_debug_output}[rdoc-ref:Net::HTTP#set_debug_output]:
# Sets the output stream for debugging.
#
class HTTP < Protocol
# :stopdoc:
VERSION = "0.4.1"
HTTPVersion = '1.1'
begin
require 'zlib'
HAVE_ZLIB=true
rescue LoadError
HAVE_ZLIB=false
end
# :startdoc:
# Returns +true+; retained for compatibility.
def HTTP.version_1_2
true
end
# Returns +true+; retained for compatibility.
def HTTP.version_1_2?
true
end
# Returns +false+; retained for compatibility.
def HTTP.version_1_1? #:nodoc:
false
end
class << HTTP
alias is_version_1_1? version_1_1? #:nodoc:
alias is_version_1_2? version_1_2? #:nodoc:
end
# :call-seq:
# Net::HTTP.get_print(hostname, path, port = 80) -> nil
# Net::HTTP:get_print(uri, headers = {}, port = uri.port) -> nil
#
# Like Net::HTTP.get, but writes the returned body to $stdout;
# returns +nil+.
def HTTP.get_print(uri_or_host, path_or_headers = nil, port = nil)
get_response(uri_or_host, path_or_headers, port) {|res|
res.read_body do |chunk|
$stdout.print chunk
end
}
nil
end
# :call-seq:
# Net::HTTP.get(hostname, path, port = 80) -> body
# Net::HTTP:get(uri, headers = {}, port = uri.port) -> body
#
# Sends a GET request and returns the \HTTP response body as a string.
#
# With string arguments +hostname+ and +path+:
#
# hostname = 'jsonplaceholder.typicode.com'
# path = '/todos/1'
# puts Net::HTTP.get(hostname, path)
#
# Output:
#
# {
# "userId": 1,
# "id": 1,
# "title": "delectus aut autem",
# "completed": false
# }
#
# With URI object +uri+ and optional hash argument +headers+:
#
# uri = URI('https://jsonplaceholder.typicode.com/todos/1')
# headers = {'Content-type' => 'application/json; charset=UTF-8'}
# Net::HTTP.get(uri, headers)
#
# Related:
#
# - Net::HTTP::Get: request class for \HTTP method +GET+.
# - Net::HTTP#get: convenience method for \HTTP method +GET+.
#
def HTTP.get(uri_or_host, path_or_headers = nil, port = nil)
get_response(uri_or_host, path_or_headers, port).body
end
# :call-seq:
# Net::HTTP.get_response(hostname, path, port = 80) -> http_response
# Net::HTTP:get_response(uri, headers = {}, port = uri.port) -> http_response
#
# Like Net::HTTP.get, but returns a Net::HTTPResponse object
# instead of the body string.
def HTTP.get_response(uri_or_host, path_or_headers = nil, port = nil, &block)
if path_or_headers && !path_or_headers.is_a?(Hash)
host = uri_or_host
path = path_or_headers
new(host, port || HTTP.default_port).start {|http|
return http.request_get(path, &block)
}
else
uri = uri_or_host
headers = path_or_headers
start(uri.hostname, uri.port,
:use_ssl => uri.scheme == 'https') {|http|
return http.request_get(uri, headers, &block)
}
end
end
# Posts data to a host; returns a Net::HTTPResponse object.
#
# Argument +url+ must be a URL;
# argument +data+ must be a string:
#
# _uri = uri.dup
# _uri.path = '/posts'
# data = '{"title": "foo", "body": "bar", "userId": 1}'
# headers = {'content-type': 'application/json'}
# res = Net::HTTP.post(_uri, data, headers) # => #<Net::HTTPCreated 201 Created readbody=true>
# puts res.body
#
# Output:
#
# {
# "title": "foo",
# "body": "bar",
# "userId": 1,
# "id": 101
# }
#
# Related:
#
# - Net::HTTP::Post: request class for \HTTP method +POST+.
# - Net::HTTP#post: convenience method for \HTTP method +POST+.
#
def HTTP.post(url, data, header = nil)
start(url.hostname, url.port,
:use_ssl => url.scheme == 'https' ) {|http|
http.post(url, data, header)
}
end
# Posts data to a host; returns a Net::HTTPResponse object.
#
# Argument +url+ must be a URI;
# argument +data+ must be a hash:
#
# _uri = uri.dup
# _uri.path = '/posts'
# data = {title: 'foo', body: 'bar', userId: 1}
# res = Net::HTTP.post_form(_uri, data) # => #<Net::HTTPCreated 201 Created readbody=true>
# puts res.body
#
# Output:
#
# {
# "title": "foo",
# "body": "bar",
# "userId": "1",
# "id": 101
# }
#
def HTTP.post_form(url, params)
req = Post.new(url)
req.form_data = params
req.basic_auth url.user, url.password if url.user
start(url.hostname, url.port,
:use_ssl => url.scheme == 'https' ) {|http|
http.request(req)
}
end
#
# \HTTP session management
#
# Returns integer +80+, the default port to use for \HTTP requests:
#
# Net::HTTP.default_port # => 80
#
def HTTP.default_port
http_default_port()
end
# Returns integer +80+, the default port to use for \HTTP requests:
#
# Net::HTTP.http_default_port # => 80
#
def HTTP.http_default_port
80
end
# Returns integer +443+, the default port to use for HTTPS requests:
#
# Net::HTTP.https_default_port # => 443
#
def HTTP.https_default_port
443
end
def HTTP.socket_type #:nodoc: obsolete
BufferedIO
end
# :call-seq:
# HTTP.start(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, opts) -> http
# HTTP.start(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, opts) {|http| ... } -> object
#
# Creates a new \Net::HTTP object, +http+, via \Net::HTTP.new:
#
# - For arguments +address+ and +port+, see Net::HTTP.new.
# - For proxy-defining arguments +p_addr+ through +p_pass+,
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
# - For argument +opts+, see below.
#
# With no block given:
#
# - Calls <tt>http.start</tt> with no block (see #start),
# which opens a TCP connection and \HTTP session.
# - Returns +http+.
# - The caller should call #finish to close the session:
#
# http = Net::HTTP.start(hostname)
# http.started? # => true
# http.finish
# http.started? # => false
#
# With a block given:
#
# - Calls <tt>http.start</tt> with the block (see #start), which:
#
# - Opens a TCP connection and \HTTP session.
# - Calls the block,
# which may make any number of requests to the host.
# - Closes the \HTTP session and TCP connection on block exit.
# - Returns the block's value +object+.
#
# - Returns +object+.
#
# Example:
#
# hostname = 'jsonplaceholder.typicode.com'
# Net::HTTP.start(hostname) do |http|
# puts http.get('/todos/1').body
# puts http.get('/todos/2').body
# end
#
# Output:
#
# {
# "userId": 1,
# "id": 1,
# "title": "delectus aut autem",
# "completed": false
# }
# {
# "userId": 1,
# "id": 2,
# "title": "quis ut nam facilis et officia qui",
# "completed": false
# }
#
# If the last argument given is a hash, it is the +opts+ hash,
# where each key is a method or accessor to be called,
# and its value is the value to be set.
#
# The keys may include:
#
# - #ca_file
# - #ca_path
# - #cert
# - #cert_store
# - #ciphers
# - #close_on_empty_response
# - +ipaddr+ (calls #ipaddr=)
# - #keep_alive_timeout
# - #key
# - #open_timeout
# - #read_timeout
# - #ssl_timeout
# - #ssl_version
# - +use_ssl+ (calls #use_ssl=)
# - #verify_callback
# - #verify_depth
# - #verify_mode
# - #write_timeout
#
# Note: If +port+ is +nil+ and <tt>opts[:use_ssl]</tt> is a truthy value,
# the value passed to +new+ is Net::HTTP.https_default_port, not +port+.
#
def HTTP.start(address, *arg, &block) # :yield: +http+
arg.pop if opt = Hash.try_convert(arg[-1])
port, p_addr, p_port, p_user, p_pass = *arg
p_addr = :ENV if arg.size < 2
port = https_default_port if !port && opt && opt[:use_ssl]
http = new(address, port, p_addr, p_port, p_user, p_pass)
http.ipaddr = opt[:ipaddr] if opt && opt[:ipaddr]
if opt
if opt[:use_ssl]
opt = {verify_mode: OpenSSL::SSL::VERIFY_PEER}.update(opt)
end
http.methods.grep(/\A(\w+)=\z/) do |meth|
key = $1.to_sym
opt.key?(key) or next
http.__send__(meth, opt[key])
end
end
http.start(&block)
end
class << HTTP
alias newobj new # :nodoc:
end
# Returns a new \Net::HTTP object +http+
# (but does not open a TCP connection or \HTTP session).
#
# With only string argument +address+ given
# (and <tt>ENV['http_proxy']</tt> undefined or +nil+),
# the returned +http+:
#
# - Has the given address.
# - Has the default port number, Net::HTTP.default_port (80).
# - Has no proxy.
#
# Example:
#
# http = Net::HTTP.new(hostname)
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
# http.address # => "jsonplaceholder.typicode.com"
# http.port # => 80
# http.proxy? # => false
#
# With integer argument +port+ also given,
# the returned +http+ has the given port:
#
# http = Net::HTTP.new(hostname, 8000)
# # => #<Net::HTTP jsonplaceholder.typicode.com:8000 open=false>
# http.port # => 8000
#
# For proxy-defining arguments +p_addr+ through +p_no_proxy+,
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
#
def HTTP.new(address, port = nil, p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil, p_no_proxy = nil)
http = super address, port
if proxy_class? then # from Net::HTTP::Proxy()
http.proxy_from_env = @proxy_from_env
http.proxy_address = @proxy_address
http.proxy_port = @proxy_port
http.proxy_user = @proxy_user
http.proxy_pass = @proxy_pass
elsif p_addr == :ENV then
http.proxy_from_env = true
else
if p_addr && p_no_proxy && !URI::Generic.use_proxy?(address, address, port, p_no_proxy)
p_addr = nil
p_port = nil
end
http.proxy_address = p_addr
http.proxy_port = p_port || default_port
http.proxy_user = p_user
http.proxy_pass = p_pass
end
http
end
# Creates a new \Net::HTTP object for the specified server address,
# without opening the TCP connection or initializing the \HTTP session.
# The +address+ should be a DNS hostname or IP address.
def initialize(address, port = nil) # :nodoc:
@address = address
@port = (port || HTTP.default_port)
@ipaddr = nil
@local_host = nil
@local_port = nil
@curr_http_version = HTTPVersion
@keep_alive_timeout = 2
@last_communicated = nil
@close_on_empty_response = false
@socket = nil
@started = false
@open_timeout = 60
@read_timeout = 60
@write_timeout = 60
@continue_timeout = nil
@max_retries = 1
@debug_output = nil
@response_body_encoding = false
@ignore_eof = true
@proxy_from_env = false
@proxy_uri = nil
@proxy_address = nil
@proxy_port = nil
@proxy_user = nil
@proxy_pass = nil
@use_ssl = false
@ssl_context = nil
@ssl_session = nil
@sspi_enabled = false
SSL_IVNAMES.each do |ivname|
instance_variable_set ivname, nil
end
end
# Returns a string representation of +self+:
#
# Net::HTTP.new(hostname).inspect
# # => "#<Net::HTTP jsonplaceholder.typicode.com:80 open=false>"
#
def inspect
"#<#{self.class} #{@address}:#{@port} open=#{started?}>"
end
# *WARNING* This method opens a serious security hole.
# Never use this method in production code.
#
# Sets the output stream for debugging:
#
# http = Net::HTTP.new(hostname)
# File.open('t.tmp', 'w') do |file|
# http.set_debug_output(file)
# http.start
# http.get('/nosuch/1')
# http.finish
# end
# puts File.read('t.tmp')
#
# Output:
#
# opening connection to jsonplaceholder.typicode.com:80...
# opened
# <- "GET /nosuch/1 HTTP/1.1\r\nAccept-Encoding: gzip;q=1.0,deflate;q=0.6,identity;q=0.3\r\nAccept: */*\r\nUser-Agent: Ruby\r\nHost: jsonplaceholder.typicode.com\r\n\r\n"
# -> "HTTP/1.1 404 Not Found\r\n"
# -> "Date: Mon, 12 Dec 2022 21:14:11 GMT\r\n"
# -> "Content-Type: application/json; charset=utf-8\r\n"
# -> "Content-Length: 2\r\n"
# -> "Connection: keep-alive\r\n"
# -> "X-Powered-By: Express\r\n"
# -> "X-Ratelimit-Limit: 1000\r\n"
# -> "X-Ratelimit-Remaining: 999\r\n"
# -> "X-Ratelimit-Reset: 1670879660\r\n"
# -> "Vary: Origin, Accept-Encoding\r\n"
# -> "Access-Control-Allow-Credentials: true\r\n"
# -> "Cache-Control: max-age=43200\r\n"
# -> "Pragma: no-cache\r\n"
# -> "Expires: -1\r\n"
# -> "X-Content-Type-Options: nosniff\r\n"
# -> "Etag: W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\"\r\n"
# -> "Via: 1.1 vegur\r\n"
# -> "CF-Cache-Status: MISS\r\n"
# -> "Server-Timing: cf-q-config;dur=1.3000000762986e-05\r\n"
# -> "Report-To: {\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v3?s=yOr40jo%2BwS1KHzhTlVpl54beJ5Wx2FcG4gGV0XVrh3X9OlR5q4drUn2dkt5DGO4GDcE%2BVXT7CNgJvGs%2BZleIyMu8CLieFiDIvOviOY3EhHg94m0ZNZgrEdpKD0S85S507l1vsEwEHkoTm%2Ff19SiO\"}],\"group\":\"cf-nel\",\"max_age\":604800}\r\n"
# -> "NEL: {\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}\r\n"
# -> "Server: cloudflare\r\n"
# -> "CF-RAY: 778977dc484ce591-DFW\r\n"
# -> "alt-svc: h3=\":443\"; ma=86400, h3-29=\":443\"; ma=86400\r\n"
# -> "\r\n"
# reading 2 bytes...
# -> "{}"
# read 2 bytes
# Conn keep-alive
#
def set_debug_output(output)
warn 'Net::HTTP#set_debug_output called after HTTP started', uplevel: 1 if started?
@debug_output = output
end
# Returns the string host name or host IP given as argument +address+ in ::new.
attr_reader :address
# Returns the integer port number given as argument +port+ in ::new.
attr_reader :port
# Sets or returns the string local host used to establish the connection;
# initially +nil+.
attr_accessor :local_host
# Sets or returns the integer local port used to establish the connection;
# initially +nil+.
attr_accessor :local_port
# Returns the encoding to use for the response body;
# see #response_body_encoding=.
attr_reader :response_body_encoding
# Sets the encoding to be used for the response body;
# returns the encoding.
#
# The given +value+ may be:
#
# - An Encoding object.
# - The name of an encoding.
# - An alias for an encoding name.
#
# See {Encoding}[rdoc-ref:Encoding].
#
# Examples:
#
# http = Net::HTTP.new(hostname)
# http.response_body_encoding = Encoding::US_ASCII # => #<Encoding:US-ASCII>
# http.response_body_encoding = 'US-ASCII' # => "US-ASCII"
# http.response_body_encoding = 'ASCII' # => "ASCII"
#
def response_body_encoding=(value)
value = Encoding.find(value) if value.is_a?(String)
@response_body_encoding = value
end
# Sets whether to determine the proxy from environment variable
# '<tt>ENV['http_proxy']</tt>';
# see {Proxy Using ENV['http_proxy']}[rdoc-ref:Net::HTTP@Proxy+Using+-27ENV-5B-27http_proxy-27-5D-27].
attr_writer :proxy_from_env
# Sets the proxy address;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
attr_writer :proxy_address
# Sets the proxy port;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
attr_writer :proxy_port
# Sets the proxy user;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
attr_writer :proxy_user
# Sets the proxy password;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
attr_writer :proxy_pass
# Returns the IP address for the connection.
#
# If the session has not been started,
# returns the value set by #ipaddr=,
# or +nil+ if it has not been set:
#
# http = Net::HTTP.new(hostname)
# http.ipaddr # => nil
# http.ipaddr = '172.67.155.76'
# http.ipaddr # => "172.67.155.76"
#
# If the session has been started,
# returns the IP address from the socket:
#
# http = Net::HTTP.new(hostname)
# http.start
# http.ipaddr # => "172.67.155.76"
# http.finish
#
def ipaddr
started? ? @socket.io.peeraddr[3] : @ipaddr
end
# Sets the IP address for the connection:
#
# http = Net::HTTP.new(hostname)
# http.ipaddr # => nil
# http.ipaddr = '172.67.155.76'
# http.ipaddr # => "172.67.155.76"
#
# The IP address may not be set if the session has been started.
def ipaddr=(addr)
raise IOError, "ipaddr value changed, but session already started" if started?
@ipaddr = addr
end
# Sets or returns the numeric (\Integer or \Float) number of seconds
# to wait for a connection to open;
# initially 60.
# If the connection is not made in the given interval,
# an exception is raised.
attr_accessor :open_timeout
# Returns the numeric (\Integer or \Float) number of seconds
# to wait for one block to be read (via one read(2) call);
# see #read_timeout=.
attr_reader :read_timeout
# Returns the numeric (\Integer or \Float) number of seconds
# to wait for one block to be written (via one write(2) call);
# see #write_timeout=.
attr_reader :write_timeout
# Sets the maximum number of times to retry an idempotent request in case of
# \Net::ReadTimeout, IOError, EOFError, Errno::ECONNRESET,
# Errno::ECONNABORTED, Errno::EPIPE, OpenSSL::SSL::SSLError,
# Timeout::Error.
# The initial value is 1.
#
# Argument +retries+ must be a non-negative numeric value:
#
# http = Net::HTTP.new(hostname)
# http.max_retries = 2 # => 2
# http.max_retries # => 2
#
def max_retries=(retries)
retries = retries.to_int
if retries < 0
raise ArgumentError, 'max_retries should be non-negative integer number'
end
@max_retries = retries
end
# Returns the maximum number of times to retry an idempotent request;
# see #max_retries=.
attr_reader :max_retries
# Sets the read timeout, in seconds, for +self+ to integer +sec+;
# the initial value is 60.
#
# Argument +sec+ must be a non-negative numeric value:
#
# http = Net::HTTP.new(hostname)
# http.read_timeout # => 60
# http.get('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>
# http.read_timeout = 0
# http.get('/todos/1') # Raises Net::ReadTimeout.
#
def read_timeout=(sec)
@socket.read_timeout = sec if @socket
@read_timeout = sec
end
# Sets the write timeout, in seconds, for +self+ to integer +sec+;
# the initial value is 60.
#
# Argument +sec+ must be a non-negative numeric value:
#
# _uri = uri.dup
# _uri.path = '/posts'
# body = 'bar' * 200000
# data = <<EOF
# {"title": "foo", "body": "#{body}", "userId": "1"}
# EOF
# headers = {'content-type': 'application/json'}
# http = Net::HTTP.new(hostname)
# http.write_timeout # => 60
# http.post(_uri.path, data, headers)
# # => #<Net::HTTPCreated 201 Created readbody=true>
# http.write_timeout = 0
# http.post(_uri.path, data, headers) # Raises Net::WriteTimeout.
#
def write_timeout=(sec)
@socket.write_timeout = sec if @socket
@write_timeout = sec
end
# Returns the continue timeout value;
# see continue_timeout=.
attr_reader :continue_timeout
# Sets the continue timeout value,
# which is the number of seconds to wait for an expected 100 Continue response.
# If the \HTTP object does not receive a response in this many seconds
# it sends the request body.
def continue_timeout=(sec)
@socket.continue_timeout = sec if @socket
@continue_timeout = sec
end
# Sets or returns the numeric (\Integer or \Float) number of seconds
# to keep the connection open after a request is sent;
# initially 2.
# If a new request is made during the given interval,
# the still-open connection is used;
# otherwise the connection will have been closed
# and a new connection is opened.
attr_accessor :keep_alive_timeout
# Sets or returns whether to ignore end-of-file when reading a response body
# with <tt>Content-Length</tt> headers;
# initially +true+.
attr_accessor :ignore_eof
# Returns +true+ if the \HTTP session has been started:
#
# http = Net::HTTP.new(hostname)
# http.started? # => false
# http.start
# http.started? # => true
# http.finish # => nil
# http.started? # => false
#
# Net::HTTP.start(hostname) do |http|
# http.started?
# end # => true
# http.started? # => false
#
def started?
@started
end
alias active? started? #:nodoc: obsolete
# Sets or returns whether to close the connection when the response is empty;
# initially +false+.
attr_accessor :close_on_empty_response
# Returns +true+ if +self+ uses SSL, +false+ otherwise.
# See Net::HTTP#use_ssl=.
def use_ssl?
@use_ssl
end
# Sets whether a new session is to use
# {Transport Layer Security}[https://en.wikipedia.org/wiki/Transport_Layer_Security]:
#
# Raises IOError if attempting to change during a session.
#
# Raises OpenSSL::SSL::SSLError if the port is not an HTTPS port.
def use_ssl=(flag)
flag = flag ? true : false
if started? and @use_ssl != flag
raise IOError, "use_ssl value changed, but session already started"
end
@use_ssl = flag
end
SSL_IVNAMES = [
:@ca_file,
:@ca_path,
:@cert,
:@cert_store,
:@ciphers,
:@extra_chain_cert,
:@key,
:@ssl_timeout,
:@ssl_version,
:@min_version,
:@max_version,
:@verify_callback,
:@verify_depth,
:@verify_mode,
:@verify_hostname,
] # :nodoc:
SSL_ATTRIBUTES = [
:ca_file,
:ca_path,
:cert,
:cert_store,
:ciphers,
:extra_chain_cert,
:key,
:ssl_timeout,
:ssl_version,
:min_version,
:max_version,
:verify_callback,
:verify_depth,
:verify_mode,
:verify_hostname,
] # :nodoc:
# Sets or returns the path to a CA certification file in PEM format.
attr_accessor :ca_file
# Sets or returns the path of to CA directory
# containing certification files in PEM format.
attr_accessor :ca_path
# Sets or returns the OpenSSL::X509::Certificate object
# to be used for client certification.
attr_accessor :cert
# Sets or returns the X509::Store to be used for verifying peer certificate.
attr_accessor :cert_store
# Sets or returns the available SSL ciphers.
# See {OpenSSL::SSL::SSLContext#ciphers=}[rdoc-ref:OpenSSL::SSL::SSLContext#ciphers-3D].
attr_accessor :ciphers
# Sets or returns the extra X509 certificates to be added to the certificate chain.
# See {OpenSSL::SSL::SSLContext#add_certificate}[rdoc-ref:OpenSSL::SSL::SSLContext#add_certificate].
attr_accessor :extra_chain_cert
# Sets or returns the OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object.
attr_accessor :key
# Sets or returns the SSL timeout seconds.
attr_accessor :ssl_timeout
# Sets or returns the SSL version.
# See {OpenSSL::SSL::SSLContext#ssl_version=}[rdoc-ref:OpenSSL::SSL::SSLContext#ssl_version-3D].
attr_accessor :ssl_version
# Sets or returns the minimum SSL version.
# See {OpenSSL::SSL::SSLContext#min_version=}[rdoc-ref:OpenSSL::SSL::SSLContext#min_version-3D].
attr_accessor :min_version
# Sets or returns the maximum SSL version.
# See {OpenSSL::SSL::SSLContext#max_version=}[rdoc-ref:OpenSSL::SSL::SSLContext#max_version-3D].
attr_accessor :max_version
# Sets or returns the callback for the server certification verification.
attr_accessor :verify_callback
# Sets or returns the maximum depth for the certificate chain verification.
attr_accessor :verify_depth
# Sets or returns the flags for server the certification verification
# at the beginning of the SSL/TLS session.
# OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable.
attr_accessor :verify_mode
# Sets or returns whether to verify that the server certificate is valid
# for the hostname.
# See {OpenSSL::SSL::SSLContext#verify_hostname=}[rdoc-ref:OpenSSL::SSL::SSLContext#attribute-i-verify_mode].
attr_accessor :verify_hostname
# Returns the X509 certificate chain (an array of strings)
# for the session's socket peer,
# or +nil+ if none.
def peer_cert
if not use_ssl? or not @socket
return nil
end
@socket.io.peer_cert
end
# Starts an \HTTP session.
#
# Without a block, returns +self+:
#
# http = Net::HTTP.new(hostname)
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
# http.start
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=true>
# http.started? # => true
# http.finish
#
# With a block, calls the block with +self+,
# finishes the session when the block exits,
# and returns the block's value:
#
# http.start do |http|
# http
# end
# # => #<Net::HTTP jsonplaceholder.typicode.com:80 open=false>
# http.started? # => false
#
def start # :yield: http
raise IOError, 'HTTP session already opened' if @started
if block_given?
begin
do_start
return yield(self)
ensure
do_finish
end
end
do_start
self
end
def do_start
connect
@started = true
end
private :do_start
def connect
if use_ssl?
# reference early to load OpenSSL before connecting,
# as OpenSSL may take time to load.
@ssl_context = OpenSSL::SSL::SSLContext.new
end
if proxy? then
conn_addr = proxy_address
conn_port = proxy_port
else
conn_addr = conn_address
conn_port = port
end
debug "opening connection to #{conn_addr}:#{conn_port}..."
s = Timeout.timeout(@open_timeout, Net::OpenTimeout) {
begin
TCPSocket.open(conn_addr, conn_port, @local_host, @local_port)
rescue => e
raise e, "Failed to open TCP connection to " +
"#{conn_addr}:#{conn_port} (#{e.message})"
end
}
s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
debug "opened"
if use_ssl?
if proxy?
plain_sock = BufferedIO.new(s, read_timeout: @read_timeout,
write_timeout: @write_timeout,
continue_timeout: @continue_timeout,
debug_output: @debug_output)
buf = +"CONNECT #{conn_address}:#{@port} HTTP/#{HTTPVersion}\r\n" \
"Host: #{@address}:#{@port}\r\n"
if proxy_user
credential = ["#{proxy_user}:#{proxy_pass}"].pack('m0')
buf << "Proxy-Authorization: Basic #{credential}\r\n"
end
buf << "\r\n"
plain_sock.write(buf)
HTTPResponse.read_new(plain_sock).value
# assuming nothing left in buffers after successful CONNECT response
end
ssl_parameters = Hash.new
iv_list = instance_variables
SSL_IVNAMES.each_with_index do |ivname, i|
if iv_list.include?(ivname)
value = instance_variable_get(ivname)
unless value.nil?
ssl_parameters[SSL_ATTRIBUTES[i]] = value
end
end
end
@ssl_context.set_params(ssl_parameters)
unless @ssl_context.session_cache_mode.nil? # a dummy method on JRuby
@ssl_context.session_cache_mode =
OpenSSL::SSL::SSLContext::SESSION_CACHE_CLIENT |
OpenSSL::SSL::SSLContext::SESSION_CACHE_NO_INTERNAL_STORE
end
if @ssl_context.respond_to?(:session_new_cb) # not implemented under JRuby
@ssl_context.session_new_cb = proc {|sock, sess| @ssl_session = sess }
end
# Still do the post_connection_check below even if connecting
# to IP address
verify_hostname = @ssl_context.verify_hostname
# Server Name Indication (SNI) RFC 3546/6066
case @address
when Resolv::IPv4::Regex, Resolv::IPv6::Regex
# don't set SNI, as IP addresses in SNI is not valid
# per RFC 6066, section 3.
# Avoid openssl warning
@ssl_context.verify_hostname = false
else
ssl_host_address = @address
end
debug "starting SSL for #{conn_addr}:#{conn_port}..."
s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context)
s.sync_close = true
s.hostname = ssl_host_address if s.respond_to?(:hostname=) && ssl_host_address
if @ssl_session and
Process.clock_gettime(Process::CLOCK_REALTIME) < @ssl_session.time.to_f + @ssl_session.timeout
s.session = @ssl_session
end
ssl_socket_connect(s, @open_timeout)
if (@ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE) && verify_hostname
s.post_connection_check(@address)
end
debug "SSL established, protocol: #{s.ssl_version}, cipher: #{s.cipher[0]}"
end
@socket = BufferedIO.new(s, read_timeout: @read_timeout,
write_timeout: @write_timeout,
continue_timeout: @continue_timeout,
debug_output: @debug_output)
@last_communicated = nil
on_connect
rescue => exception
if s
debug "Conn close because of connect error #{exception}"
s.close
end
raise
end
private :connect
def on_connect
end
private :on_connect
# Finishes the \HTTP session:
#
# http = Net::HTTP.new(hostname)
# http.start
# http.started? # => true
# http.finish # => nil
# http.started? # => false
#
# Raises IOError if not in a session.
def finish
raise IOError, 'HTTP session not yet started' unless started?
do_finish
end
def do_finish
@started = false
@socket.close if @socket
@socket = nil
end
private :do_finish
#
# proxy
#
public
# no proxy
@is_proxy_class = false
@proxy_from_env = false
@proxy_addr = nil
@proxy_port = nil
@proxy_user = nil
@proxy_pass = nil
# Creates an \HTTP proxy class which behaves like \Net::HTTP, but
# performs all access via the specified proxy.
#
# This class is obsolete. You may pass these same parameters directly to
# \Net::HTTP.new. See Net::HTTP.new for details of the arguments.
def HTTP.Proxy(p_addr = :ENV, p_port = nil, p_user = nil, p_pass = nil) #:nodoc:
return self unless p_addr
Class.new(self) {
@is_proxy_class = true
if p_addr == :ENV then
@proxy_from_env = true
@proxy_address = nil
@proxy_port = nil
else
@proxy_from_env = false
@proxy_address = p_addr
@proxy_port = p_port || default_port
end
@proxy_user = p_user
@proxy_pass = p_pass
}
end
class << HTTP
# Returns true if self is a class which was created by HTTP::Proxy.
def proxy_class?
defined?(@is_proxy_class) ? @is_proxy_class : false
end
# Returns the address of the proxy host, or +nil+ if none;
# see Net::HTTP@Proxy+Server.
attr_reader :proxy_address
# Returns the port number of the proxy host, or +nil+ if none;
# see Net::HTTP@Proxy+Server.
attr_reader :proxy_port
# Returns the user name for accessing the proxy, or +nil+ if none;
# see Net::HTTP@Proxy+Server.
attr_reader :proxy_user
# Returns the password for accessing the proxy, or +nil+ if none;
# see Net::HTTP@Proxy+Server.
attr_reader :proxy_pass
end
# Returns +true+ if a proxy server is defined, +false+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy?
!!(@proxy_from_env ? proxy_uri : @proxy_address)
end
# Returns +true+ if the proxy server is defined in the environment,
# +false+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_from_env?
@proxy_from_env
end
# The proxy URI determined from the environment for this connection.
def proxy_uri # :nodoc:
return if @proxy_uri == false
@proxy_uri ||= URI::HTTP.new(
"http", nil, address, port, nil, nil, nil, nil, nil
).find_proxy || false
@proxy_uri || nil
end
# Returns the address of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_address
if @proxy_from_env then
proxy_uri&.hostname
else
@proxy_address
end
end
# Returns the port number of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_port
if @proxy_from_env then
proxy_uri&.port
else
@proxy_port
end
end
# Returns the user name of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_user
if @proxy_from_env
user = proxy_uri&.user
unescape(user) if user
else
@proxy_user
end
end
# Returns the password of the proxy server, if defined, +nil+ otherwise;
# see {Proxy Server}[rdoc-ref:Net::HTTP@Proxy+Server].
def proxy_pass
if @proxy_from_env
pass = proxy_uri&.password
unescape(pass) if pass
else
@proxy_pass
end
end
alias proxyaddr proxy_address #:nodoc: obsolete
alias proxyport proxy_port #:nodoc: obsolete
private
def unescape(value)
require 'cgi/util'
CGI.unescape(value)
end
# without proxy, obsolete
def conn_address # :nodoc:
@ipaddr || address()
end
def conn_port # :nodoc:
port()
end
def edit_path(path)
if proxy?
if path.start_with?("ftp://") || use_ssl?
path
else
"http://#{addr_port}#{path}"
end
else
path
end
end
#
# HTTP operations
#
public
# :call-seq:
# get(path, initheader = nil) {|res| ... }
#
# Sends a GET request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Get object
# created from string +path+ and initial headers hash +initheader+.
#
# With a block given, calls the block with the response body:
#
# http = Net::HTTP.new(hostname)
# http.get('/todos/1') do |res|
# p res
# end # => #<Net::HTTPOK 200 OK readbody=true>
#
# Output:
#
# "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false\n}"
#
# With no block given, simply returns the response object:
#
# http.get('/') # => #<Net::HTTPOK 200 OK readbody=true>
#
# Related:
#
# - Net::HTTP::Get: request class for \HTTP method GET.
# - Net::HTTP.get: sends GET request, returns response body.
#
def get(path, initheader = nil, dest = nil, &block) # :yield: +body_segment+
res = nil
request(Get.new(path, initheader)) {|r|
r.read_body dest, &block
res = r
}
res
end
# Sends a HEAD request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Head object
# created from string +path+ and initial headers hash +initheader+:
#
# res = http.head('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>
# res.body # => nil
# res.to_hash.take(3)
# # =>
# [["date", ["Wed, 15 Feb 2023 15:25:42 GMT"]],
# ["content-type", ["application/json; charset=utf-8"]],
# ["connection", ["close"]]]
#
def head(path, initheader = nil)
request(Head.new(path, initheader))
end
# :call-seq:
# post(path, data, initheader = nil) {|res| ... }
#
# Sends a POST request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Post object
# created from string +path+, string +data+, and initial headers hash +initheader+.
#
# With a block given, calls the block with the response body:
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http = Net::HTTP.new(hostname)
# http.post('/todos', data) do |res|
# p res
# end # => #<Net::HTTPCreated 201 Created readbody=true>
#
# Output:
#
# "{\n \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\",\n \"id\": 201\n}"
#
# With no block given, simply returns the response object:
#
# http.post('/todos', data) # => #<Net::HTTPCreated 201 Created readbody=true>
#
# Related:
#
# - Net::HTTP::Post: request class for \HTTP method POST.
# - Net::HTTP.post: sends POST request, returns response body.
#
def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
send_entity(path, data, initheader, dest, Post, &block)
end
# :call-seq:
# patch(path, data, initheader = nil) {|res| ... }
#
# Sends a PATCH request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Patch object
# created from string +path+, string +data+, and initial headers hash +initheader+.
#
# With a block given, calls the block with the response body:
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http = Net::HTTP.new(hostname)
# http.patch('/todos/1', data) do |res|
# p res
# end # => #<Net::HTTPOK 200 OK readbody=true>
#
# Output:
#
# "{\n \"userId\": 1,\n \"id\": 1,\n \"title\": \"delectus aut autem\",\n \"completed\": false,\n \"{\\\"userId\\\": 1, \\\"id\\\": 1, \\\"title\\\": \\\"delectus aut autem\\\", \\\"completed\\\": false}\": \"\"\n}"
#
# With no block given, simply returns the response object:
#
# http.patch('/todos/1', data) # => #<Net::HTTPCreated 201 Created readbody=true>
#
def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
send_entity(path, data, initheader, dest, Patch, &block)
end
# Sends a PUT request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Put object
# created from string +path+, string +data+, and initial headers hash +initheader+.
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http = Net::HTTP.new(hostname)
# http.put('/todos/1', data) # => #<Net::HTTPOK 200 OK readbody=true>
#
def put(path, data, initheader = nil)
request(Put.new(path, initheader), data)
end
# Sends a PROPPATCH request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Proppatch object
# created from string +path+, string +body+, and initial headers hash +initheader+.
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http = Net::HTTP.new(hostname)
# http.proppatch('/todos/1', data)
#
def proppatch(path, body, initheader = nil)
request(Proppatch.new(path, initheader), body)
end
# Sends a LOCK request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Lock object
# created from string +path+, string +body+, and initial headers hash +initheader+.
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http = Net::HTTP.new(hostname)
# http.lock('/todos/1', data)
#
def lock(path, body, initheader = nil)
request(Lock.new(path, initheader), body)
end
# Sends an UNLOCK request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Unlock object
# created from string +path+, string +body+, and initial headers hash +initheader+.
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http = Net::HTTP.new(hostname)
# http.unlock('/todos/1', data)
#
def unlock(path, body, initheader = nil)
request(Unlock.new(path, initheader), body)
end
# Sends an Options request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Options object
# created from string +path+ and initial headers hash +initheader+.
#
# http = Net::HTTP.new(hostname)
# http.options('/')
#
def options(path, initheader = nil)
request(Options.new(path, initheader))
end
# Sends a PROPFIND request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Propfind object
# created from string +path+, string +body+, and initial headers hash +initheader+.
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http = Net::HTTP.new(hostname)
# http.propfind('/todos/1', data)
#
def propfind(path, body = nil, initheader = {'Depth' => '0'})
request(Propfind.new(path, initheader), body)
end
# Sends a DELETE request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Delete object
# created from string +path+ and initial headers hash +initheader+.
#
# http = Net::HTTP.new(hostname)
# http.delete('/todos/1')
#
def delete(path, initheader = {'Depth' => 'Infinity'})
request(Delete.new(path, initheader))
end
# Sends a MOVE request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Move object
# created from string +path+ and initial headers hash +initheader+.
#
# http = Net::HTTP.new(hostname)
# http.move('/todos/1')
#
def move(path, initheader = nil)
request(Move.new(path, initheader))
end
# Sends a COPY request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Copy object
# created from string +path+ and initial headers hash +initheader+.
#
# http = Net::HTTP.new(hostname)
# http.copy('/todos/1')
#
def copy(path, initheader = nil)
request(Copy.new(path, initheader))
end
# Sends a MKCOL request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Mkcol object
# created from string +path+, string +body+, and initial headers hash +initheader+.
#
# data = '{"userId": 1, "id": 1, "title": "delectus aut autem", "completed": false}'
# http.mkcol('/todos/1', data)
# http = Net::HTTP.new(hostname)
#
def mkcol(path, body = nil, initheader = nil)
request(Mkcol.new(path, initheader), body)
end
# Sends a TRACE request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Trace object
# created from string +path+ and initial headers hash +initheader+.
#
# http = Net::HTTP.new(hostname)
# http.trace('/todos/1')
#
def trace(path, initheader = nil)
request(Trace.new(path, initheader))
end
# Sends a GET request to the server;
# forms the response into a Net::HTTPResponse object.
#
# The request is based on the Net::HTTP::Get object
# created from string +path+ and initial headers hash +initheader+.
#
# With no block given, returns the response object:
#
# http = Net::HTTP.new(hostname)
# http.request_get('/todos') # => #<Net::HTTPOK 200 OK readbody=true>
#
# With a block given, calls the block with the response object
# and returns the response object:
#
# http.request_get('/todos') do |res|
# p res
# end # => #<Net::HTTPOK 200 OK readbody=true>
#
# Output:
#
# #<Net::HTTPOK 200 OK readbody=false>
#
def request_get(path, initheader = nil, &block) # :yield: +response+
request(Get.new(path, initheader), &block)
end
# Sends a HEAD request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Head object
# created from string +path+ and initial headers hash +initheader+.
#
# http = Net::HTTP.new(hostname)
# http.head('/todos/1') # => #<Net::HTTPOK 200 OK readbody=true>
#
def request_head(path, initheader = nil, &block)
request(Head.new(path, initheader), &block)
end
# Sends a POST request to the server;
# forms the response into a Net::HTTPResponse object.
#
# The request is based on the Net::HTTP::Post object
# created from string +path+, string +data+, and initial headers hash +initheader+.
#
# With no block given, returns the response object:
#
# http = Net::HTTP.new(hostname)
# http.post('/todos', 'xyzzy')
# # => #<Net::HTTPCreated 201 Created readbody=true>
#
# With a block given, calls the block with the response body
# and returns the response object:
#
# http.post('/todos', 'xyzzy') do |res|
# p res
# end # => #<Net::HTTPCreated 201 Created readbody=true>
#
# Output:
#
# "{\n \"xyzzy\": \"\",\n \"id\": 201\n}"
#
def request_post(path, data, initheader = nil, &block) # :yield: +response+
request Post.new(path, initheader), data, &block
end
# Sends a PUT request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTP::Put object
# created from string +path+, string +data+, and initial headers hash +initheader+.
#
# http = Net::HTTP.new(hostname)
# http.put('/todos/1', 'xyzzy')
# # => #<Net::HTTPOK 200 OK readbody=true>
#
def request_put(path, data, initheader = nil, &block) #:nodoc:
request Put.new(path, initheader), data, &block
end
alias get2 request_get #:nodoc: obsolete
alias head2 request_head #:nodoc: obsolete
alias post2 request_post #:nodoc: obsolete
alias put2 request_put #:nodoc: obsolete
# Sends an \HTTP request to the server;
# returns an instance of a subclass of Net::HTTPResponse.
#
# The request is based on the Net::HTTPRequest object
# created from string +path+, string +data+, and initial headers hash +header+.
# That object is an instance of the
# {subclass of Net::HTTPRequest}[rdoc-ref:Net::HTTPRequest@Request+Subclasses],
# that corresponds to the given uppercase string +name+,
# which must be
# an {HTTP request method}[https://en.wikipedia.org/wiki/HTTP#Request_methods]
# or a {WebDAV request method}[https://en.wikipedia.org/wiki/WebDAV#Implementation].
#
# Examples:
#
# http = Net::HTTP.new(hostname)
# http.send_request('GET', '/todos/1')
# # => #<Net::HTTPOK 200 OK readbody=true>
# http.send_request('POST', '/todos', 'xyzzy')
# # => #<Net::HTTPCreated 201 Created readbody=true>
#
def send_request(name, path, data = nil, header = nil)
has_response_body = name != 'HEAD'
r = HTTPGenericRequest.new(name,(data ? true : false),has_response_body,path,header)
request r, data
end
# Sends the given request +req+ to the server;
# forms the response into a Net::HTTPResponse object.
#
# The given +req+ must be an instance of a
# {subclass of Net::HTTPRequest}[rdoc-ref:Net::HTTPRequest@Request+Subclasses].
# Argument +body+ should be given only if needed for the request.
#
# With no block given, returns the response object:
#
# http = Net::HTTP.new(hostname)
#
# req = Net::HTTP::Get.new('/todos/1')
# http.request(req)
# # => #<Net::HTTPOK 200 OK readbody=true>
#
# req = Net::HTTP::Post.new('/todos')
# http.request(req, 'xyzzy')
# # => #<Net::HTTPCreated 201 Created readbody=true>
#
# With a block given, calls the block with the response and returns the response:
#
# req = Net::HTTP::Get.new('/todos/1')
# http.request(req) do |res|
# p res
# end # => #<Net::HTTPOK 200 OK readbody=true>
#
# Output:
#
# #<Net::HTTPOK 200 OK readbody=false>
#
def request(req, body = nil, &block) # :yield: +response+
unless started?
start {
req['connection'] ||= 'close'
return request(req, body, &block)
}
end
if proxy_user()
req.proxy_basic_auth proxy_user(), proxy_pass() unless use_ssl?
end
req.set_body_internal body
res = transport_request(req, &block)
if sspi_auth?(res)
sspi_auth(req)
res = transport_request(req, &block)
end
res
end
private
# Executes a request which uses a representation
# and returns its body.
def send_entity(path, data, initheader, dest, type, &block)
res = nil
request(type.new(path, initheader), data) {|r|
r.read_body dest, &block
res = r
}
res
end
IDEMPOTENT_METHODS_ = %w/GET HEAD PUT DELETE OPTIONS TRACE/ # :nodoc:
def transport_request(req)
count = 0
begin
begin_transport req
res = catch(:response) {
begin
req.exec @socket, @curr_http_version, edit_path(req.path)
rescue Errno::EPIPE
# Failure when writing full request, but we can probably
# still read the received response.
end
begin
res = HTTPResponse.read_new(@socket)
res.decode_content = req.decode_content
res.body_encoding = @response_body_encoding
res.ignore_eof = @ignore_eof
end while res.kind_of?(HTTPInformation)
res.uri = req.uri
res
}
res.reading_body(@socket, req.response_body_permitted?) {
yield res if block_given?
}
rescue Net::OpenTimeout
raise
rescue Net::ReadTimeout, IOError, EOFError,
Errno::ECONNRESET, Errno::ECONNABORTED, Errno::EPIPE, Errno::ETIMEDOUT,
# avoid a dependency on OpenSSL
defined?(OpenSSL::SSL) ? OpenSSL::SSL::SSLError : IOError,
Timeout::Error => exception
if count < max_retries && IDEMPOTENT_METHODS_.include?(req.method)
count += 1
@socket.close if @socket
debug "Conn close because of error #{exception}, and retry"
retry
end
debug "Conn close because of error #{exception}"
@socket.close if @socket
raise
end
end_transport req, res
res
rescue => exception
debug "Conn close because of error #{exception}"
@socket.close if @socket
raise exception
end
def begin_transport(req)
if @socket.closed?
connect
elsif @last_communicated
if @last_communicated + @keep_alive_timeout < Process.clock_gettime(Process::CLOCK_MONOTONIC)
debug 'Conn close because of keep_alive_timeout'
@socket.close
connect
elsif @socket.io.to_io.wait_readable(0) && @socket.eof?
debug "Conn close because of EOF"
@socket.close
connect
end
end
if not req.response_body_permitted? and @close_on_empty_response
req['connection'] ||= 'close'
end
req.update_uri address, port, use_ssl?
req['host'] ||= addr_port()
end
def end_transport(req, res)
@curr_http_version = res.http_version
@last_communicated = nil
if @socket.closed?
debug 'Conn socket closed'
elsif not res.body and @close_on_empty_response
debug 'Conn close'
@socket.close
elsif keep_alive?(req, res)
debug 'Conn keep-alive'
@last_communicated = Process.clock_gettime(Process::CLOCK_MONOTONIC)
else
debug 'Conn close'
@socket.close
end
end
def keep_alive?(req, res)
return false if req.connection_close?
if @curr_http_version <= '1.0'
res.connection_keep_alive?
else # HTTP/1.1 or later
not res.connection_close?
end
end
def sspi_auth?(res)
return false unless @sspi_enabled
if res.kind_of?(HTTPProxyAuthenticationRequired) and
proxy? and res["Proxy-Authenticate"].include?("Negotiate")
begin
require 'win32/sspi'
true
rescue LoadError
false
end
else
false
end
end
def sspi_auth(req)
n = Win32::SSPI::NegotiateAuth.new
req["Proxy-Authorization"] = "Negotiate #{n.get_initial_token}"
# Some versions of ISA will close the connection if this isn't present.
req["Connection"] = "Keep-Alive"
req["Proxy-Connection"] = "Keep-Alive"
res = transport_request(req)
authphrase = res["Proxy-Authenticate"] or return res
req["Proxy-Authorization"] = "Negotiate #{n.complete_authentication(authphrase)}"
rescue => err
raise HTTPAuthenticationError.new('HTTP authentication failed', err)
end
#
# utils
#
private
def addr_port
addr = address
addr = "[#{addr}]" if addr.include?(":")
default_port = use_ssl? ? HTTP.https_default_port : HTTP.http_default_port
default_port == port ? addr : "#{addr}:#{port}"
end
# Adds a message to debugging output
def debug(msg)
return unless @debug_output
@debug_output << msg
@debug_output << "\n"
end
alias_method :D, :debug
end
end
require_relative 'http/exceptions'
require_relative 'http/header'
require_relative 'http/generic_request'
require_relative 'http/request'
require_relative 'http/requests'
require_relative 'http/response'
require_relative 'http/responses'
require_relative 'http/proxy_delta'
require_relative 'http/backward'
share/ruby/mkmf.rb 0000644 00000261304 15173517737 0010134 0 ustar 00 # -*- coding: us-ascii -*-
# frozen-string-literal: false
# module to create Makefile for extension modules
# invoke like: ruby -r mkmf extconf.rb
require 'rbconfig'
require 'fileutils'
require 'shellwords'
class String # :nodoc:
# Wraps a string in escaped quotes if it contains whitespace.
def quote
/\s/ =~ self ? "\"#{self}\"" : "#{self}"
end
# Escape whitespaces for Makefile.
def unspace
gsub(/\s/, '\\\\\\&')
end
# Generates a string used as cpp macro name.
def tr_cpp
strip.upcase.tr_s("^A-Z0-9_*", "_").tr_s("*", "P")
end
def funcall_style
/\)\z/ =~ self ? dup : "#{self}()"
end
def sans_arguments
self[/\A[^()]+/]
end
end
class Array # :nodoc:
# Wraps all strings in escaped quotes if they contain whitespace.
def quote
map {|s| s.quote}
end
end
##
# mkmf.rb is used by Ruby C extensions to generate a Makefile which will
# correctly compile and link the C extension to Ruby and a third-party
# library.
module MakeMakefile
#### defer until this module become global-state free.
# def self.extended(obj)
# obj.init_mkmf
# super
# end
#
# def initialize(*args, rbconfig: RbConfig, **rest)
# init_mkmf(rbconfig::MAKEFILE_CONFIG, rbconfig::CONFIG)
# super(*args, **rest)
# end
##
# The makefile configuration using the defaults from when Ruby was built.
CONFIG = RbConfig::MAKEFILE_CONFIG
ORIG_LIBPATH = ENV['LIB']
##
# Extensions for files compiled with a C compiler
C_EXT = %w[c m]
##
# Extensions for files compiled with a C++ compiler
CXX_EXT = %w[cc mm cxx cpp]
unless File.exist?(File.join(*File.split(__FILE__).tap {|d, b| b.swapcase}))
CXX_EXT.concat(%w[C])
end
##
# Extensions for source files
SRC_EXT = C_EXT + CXX_EXT
##
# Extensions for header files
HDR_EXT = %w[h hpp]
$static = nil
$config_h = '$(arch_hdrdir)/ruby/config.h'
$default_static = $static
unless defined? $configure_args
$configure_args = {}
args = CONFIG["configure_args"].shellsplit
if arg = ENV["CONFIGURE_ARGS"]
args.push(*arg.shellsplit)
end
args.delete_if {|a| /\A--(?:top(?:src)?|src|cur)dir(?=\z|=)/ =~ a}
for arg in args.concat(ARGV)
arg, val = arg.split('=', 2)
next unless arg
arg.tr!('_', '-')
if arg.sub!(/\A(?!--)/, '--')
val or next
arg.downcase!
end
$configure_args[arg] = val || true
end
end
$libdir = CONFIG["libdir"]
$rubylibdir = CONFIG["rubylibdir"]
$archdir = CONFIG["archdir"]
$sitedir = CONFIG["sitedir"]
$sitelibdir = CONFIG["sitelibdir"]
$sitearchdir = CONFIG["sitearchdir"]
$vendordir = CONFIG["vendordir"]
$vendorlibdir = CONFIG["vendorlibdir"]
$vendorarchdir = CONFIG["vendorarchdir"]
$mswin = /mswin/ =~ RUBY_PLATFORM
$mingw = /mingw/ =~ RUBY_PLATFORM
$cygwin = /cygwin/ =~ RUBY_PLATFORM
$netbsd = /netbsd/ =~ RUBY_PLATFORM
$haiku = /haiku/ =~ RUBY_PLATFORM
$solaris = /solaris/ =~ RUBY_PLATFORM
$universal = /universal/ =~ RUBY_PLATFORM
$dest_prefix_pattern = (File::PATH_SEPARATOR == ';' ? /\A([[:alpha:]]:)?/ : /\A/)
# :stopdoc:
def config_string(key, config = CONFIG)
s = config[key] and !s.empty? and block_given? ? yield(s) : s
end
module_function :config_string
def dir_re(dir)
Regexp.new('\$(?:\('+dir+'\)|\{'+dir+'\})(?:\$(?:\(target_prefix\)|\{target_prefix\}))?')
end
module_function :dir_re
def relative_from(path, base)
dir = File.join(path, "")
if File.expand_path(dir) == File.expand_path(dir, base)
path
else
File.join(base, path)
end
end
INSTALL_DIRS = [
[dir_re('commondir'), "$(RUBYCOMMONDIR)"],
[dir_re('sitedir'), "$(RUBYCOMMONDIR)"],
[dir_re('vendordir'), "$(RUBYCOMMONDIR)"],
[dir_re('rubylibdir'), "$(RUBYLIBDIR)"],
[dir_re('archdir'), "$(RUBYARCHDIR)"],
[dir_re('sitelibdir'), "$(RUBYLIBDIR)"],
[dir_re('vendorlibdir'), "$(RUBYLIBDIR)"],
[dir_re('sitearchdir'), "$(RUBYARCHDIR)"],
[dir_re('vendorarchdir'), "$(RUBYARCHDIR)"],
[dir_re('rubyhdrdir'), "$(RUBYHDRDIR)"],
[dir_re('sitehdrdir'), "$(SITEHDRDIR)"],
[dir_re('vendorhdrdir'), "$(VENDORHDRDIR)"],
[dir_re('bindir'), "$(BINDIR)"],
]
def install_dirs(target_prefix = nil)
if $extout and $extmk
dirs = [
['BINDIR', '$(extout)/bin'],
['RUBYCOMMONDIR', '$(extout)/common'],
['RUBYLIBDIR', '$(RUBYCOMMONDIR)$(target_prefix)'],
['RUBYARCHDIR', '$(extout)/$(arch)$(target_prefix)'],
['HDRDIR', '$(extout)/include/ruby$(target_prefix)'],
['ARCHHDRDIR', '$(extout)/include/$(arch)/ruby$(target_prefix)'],
['extout', "#$extout"],
['extout_prefix', "#$extout_prefix"],
]
elsif $extmk
dirs = [
['BINDIR', '$(bindir)'],
['RUBYCOMMONDIR', '$(rubylibdir)'],
['RUBYLIBDIR', '$(rubylibdir)$(target_prefix)'],
['RUBYARCHDIR', '$(archdir)$(target_prefix)'],
['HDRDIR', '$(rubyhdrdir)/ruby$(target_prefix)'],
['ARCHHDRDIR', '$(rubyhdrdir)/$(arch)/ruby$(target_prefix)'],
]
elsif $configure_args.has_key?('--vendor')
dirs = [
['BINDIR', '$(bindir)'],
['RUBYCOMMONDIR', '$(vendordir)$(target_prefix)'],
['RUBYLIBDIR', '$(vendorlibdir)$(target_prefix)'],
['RUBYARCHDIR', '$(vendorarchdir)$(target_prefix)'],
['HDRDIR', '$(vendorhdrdir)$(target_prefix)'],
['ARCHHDRDIR', '$(vendorarchhdrdir)$(target_prefix)'],
]
else
dirs = [
['BINDIR', '$(bindir)'],
['RUBYCOMMONDIR', '$(sitedir)$(target_prefix)'],
['RUBYLIBDIR', '$(sitelibdir)$(target_prefix)'],
['RUBYARCHDIR', '$(sitearchdir)$(target_prefix)'],
['HDRDIR', '$(sitehdrdir)$(target_prefix)'],
['ARCHHDRDIR', '$(sitearchhdrdir)$(target_prefix)'],
]
end
dirs << ['target_prefix', (target_prefix ? "/#{target_prefix}" : "")]
dirs
end
def map_dir(dir, map = nil)
map ||= INSTALL_DIRS
map.inject(dir) {|d, (orig, new)| d.gsub(orig, new)}
end
topdir = File.dirname(File.dirname(__FILE__))
path = File.expand_path($0)
until (dir = File.dirname(path)) == path
if File.identical?(dir, topdir)
$extmk = true if %r"\A(?:ext|enc|tool|test)\z" =~ File.basename(path)
break
end
path = dir
end
$extmk ||= false
if not $extmk and File.exist?(($hdrdir = RbConfig::CONFIG["rubyhdrdir"]) + "/ruby/ruby.h")
$topdir = $hdrdir
$top_srcdir = $hdrdir
$arch_hdrdir = RbConfig::CONFIG["rubyarchhdrdir"]
elsif File.exist?(($hdrdir = ($top_srcdir ||= topdir) + "/include") + "/ruby.h")
$topdir ||= RbConfig::CONFIG["topdir"]
$arch_hdrdir = "$(extout)/include/$(arch)"
else
abort <<MESSAGE
mkmf.rb can't find header files for ruby at #{$hdrdir}/ruby.h
You might have to install separate package for the ruby development
environment, ruby-dev or ruby-devel for example.
MESSAGE
end
CONFTEST = "conftest".freeze
CONFTEST_C = "#{CONFTEST}.c"
OUTFLAG = CONFIG['OUTFLAG']
COUTFLAG = CONFIG['COUTFLAG']
CSRCFLAG = CONFIG['CSRCFLAG']
CPPOUTFILE = config_string('CPPOUTFILE') {|str| str.sub(/\bconftest\b/, CONFTEST)}
def rm_f(*files)
opt = (Hash === files.last ? [files.pop] : [])
FileUtils.rm_f(Dir[*files.flatten], *opt)
end
module_function :rm_f
def rm_rf(*files)
opt = (Hash === files.last ? [files.pop] : [])
FileUtils.rm_rf(Dir[*files.flatten], *opt)
end
module_function :rm_rf
# Returns time stamp of the +target+ file if it exists and is newer than or
# equal to all of +times+.
def modified?(target, times)
(t = File.mtime(target)) rescue return nil
Array === times or times = [times]
t if times.all? {|n| n <= t}
end
def split_libs(*strs)
sep = $mswin ? /\s+/ : /\s+(?=-|\z)/
strs.flat_map {|s| s.lstrip.split(sep)}
end
def merge_libs(*libs)
libs.inject([]) do |x, y|
y = y.inject([]) {|ary, e| ary.last == e ? ary : ary << e}
y.each_with_index do |v, yi|
if xi = x.rindex(v)
x[(xi+1)..-1] = merge_libs(y[(yi+1)..-1], x[(xi+1)..-1])
x[xi, 0] = y[0...yi]
break
end
end and x.concat(y)
x
end
end
# This is a custom logging module. It generates an mkmf.log file when you
# run your extconf.rb script. This can be useful for debugging unexpected
# failures.
#
# This module and its associated methods are meant for internal use only.
#
module Logging
@log = nil
@logfile = 'mkmf.log'
@orgerr = $stderr.dup
@orgout = $stdout.dup
@postpone = 0
@quiet = $extmk
def self::log_open
@log ||= File::open(@logfile, 'wb')
@log.sync = true
end
def self::log_opened?
@log and not @log.closed?
end
def self::open
log_open
$stderr.reopen(@log)
$stdout.reopen(@log)
yield
ensure
$stderr.reopen(@orgerr)
$stdout.reopen(@orgout)
end
def self::message(*s)
log_open
@log.printf(*s)
end
def self::logfile file
@logfile = file
log_close
end
def self::log_close
if @log and not @log.closed?
@log.flush
@log.close
@log = nil
end
end
def self::postpone
tmplog = "mkmftmp#{@postpone += 1}.log"
open do
log, *save = @log, @logfile, @orgout, @orgerr
@log, @logfile, @orgout, @orgerr = nil, tmplog, log, log
begin
log.print(open {yield @log})
ensure
@log.close if @log and not @log.closed?
File::open(tmplog) {|t| FileUtils.copy_stream(t, log)} if File.exist?(tmplog)
@log, @logfile, @orgout, @orgerr = log, *save
@postpone -= 1
MakeMakefile.rm_f tmplog
end
end
end
class << self
attr_accessor :quiet
end
end
def libpath_env
# used only if native compiling
if libpathenv = config_string("LIBPATHENV")
pathenv = ENV[libpathenv]
libpath = RbConfig.expand($DEFLIBPATH.join(File::PATH_SEPARATOR))
{libpathenv => [libpath, pathenv].compact.join(File::PATH_SEPARATOR)}
else
{}
end
end
def expand_command(commands, envs = libpath_env)
varpat = /\$\((\w+)\)|\$\{(\w+)\}/
vars = nil
expand = proc do |command|
case command
when Array
command.map(&expand)
when String
if varpat =~ command
vars ||= Hash.new {|h, k| h[k] = ENV[k]}
command = command.dup
nil while command.gsub!(varpat) {vars[$1||$2]}
end
command
else
command
end
end
if Array === commands
env, *commands = commands if Hash === commands.first
envs.merge!(env) if env
end
return envs, expand[commands]
end
def env_quote(envs)
envs.map {|e, v| "#{e}=#{v.quote}"}
end
def xsystem command, opts = nil
env, command = expand_command(command)
Logging::open do
puts [env_quote(env), command.quote].join(' ')
if opts and opts[:werror]
result = nil
Logging.postpone do |log|
output = IO.popen(env, command, &:read)
result = ($?.success? and File.zero?(log.path))
output
end
result
else
system(env, *command)
end
end
end
def xpopen command, *mode, &block
env, commands = expand_command(command)
command = [env_quote(env), command].join(' ')
Logging::open do
case mode[0]
when nil, Hash, /^r/
puts "#{command} |"
else
puts "| #{command}"
end
IO.popen(env, commands, *mode, &block)
end
end
def log_src(src, heading="checked program was")
src = src.split(/^/)
fmt = "%#{src.size.to_s.size}d: %s"
Logging::message <<"EOM"
#{heading}:
/* begin */
EOM
src.each_with_index {|line, no| Logging::message fmt, no+1, line}
Logging::message <<"EOM"
/* end */
EOM
end
def conftest_source
CONFTEST_C
end
def create_tmpsrc(src)
src = "#{COMMON_HEADERS}\n#{src}"
src = yield(src) if block_given?
src.gsub!(/[ \t]+$/, '')
src.gsub!(/\A\n+|^\n+$/, '')
src.sub!(/[^\n]\z/, "\\&\n")
count = 0
begin
File.open(conftest_source, "wb") do |cfile|
cfile.print src
end
rescue Errno::EACCES
if (count += 1) < 5
sleep 0.2
retry
end
end
src
end
def have_devel?
unless defined? $have_devel
$have_devel = true
$have_devel = try_link(MAIN_DOES_NOTHING)
end
$have_devel
end
def try_do(src, command, *opts, &b)
unless have_devel?
raise <<MSG
The compiler failed to generate an executable file.
You have to install development tools first.
MSG
end
begin
src = create_tmpsrc(src, &b)
xsystem(command, *opts)
ensure
log_src(src)
end
end
def link_config(ldflags, opt="", libpath=$DEFLIBPATH|$LIBPATH)
librubyarg = $extmk ? $LIBRUBYARG_STATIC : "$(LIBRUBYARG)"
conf = RbConfig::CONFIG.merge('hdrdir' => $hdrdir.quote,
'src' => "#{conftest_source}",
'arch_hdrdir' => $arch_hdrdir.quote,
'top_srcdir' => $top_srcdir.quote,
'INCFLAGS' => "#$INCFLAGS",
'CPPFLAGS' => "#$CPPFLAGS",
'CFLAGS' => "#$CFLAGS",
'ARCH_FLAG' => "#$ARCH_FLAG",
'LDFLAGS' => "#$LDFLAGS #{ldflags}",
'LOCAL_LIBS' => "#$LOCAL_LIBS #$libs",
'LIBS' => "#{librubyarg} #{opt} #$LIBS")
conf['LIBPATH'] = libpathflag(libpath.map {|s| RbConfig::expand(s.dup, conf)})
conf
end
def link_command(ldflags, *opts)
conf = link_config(ldflags, *opts)
RbConfig::expand(TRY_LINK.dup, conf)
end
def cc_config(opt="")
conf = RbConfig::CONFIG.merge('hdrdir' => $hdrdir.quote, 'srcdir' => $srcdir.quote,
'arch_hdrdir' => $arch_hdrdir.quote,
'top_srcdir' => $top_srcdir.quote)
conf
end
def cc_command(opt="")
conf = cc_config(opt)
RbConfig::expand("$(CC) #$INCFLAGS #$CPPFLAGS #$CFLAGS #$ARCH_FLAG #{opt} -c #{CONFTEST_C}",
conf)
end
def cpp_command(outfile, opt="")
conf = cc_config(opt)
if $universal and (arch_flag = conf['ARCH_FLAG']) and !arch_flag.empty?
conf['ARCH_FLAG'] = arch_flag.gsub(/(?:\G|\s)-arch\s+\S+/, '')
end
RbConfig::expand("$(CPP) #$INCFLAGS #$CPPFLAGS #$CFLAGS #{opt} #{CONFTEST_C} #{outfile}",
conf)
end
def libpathflag(libpath=$DEFLIBPATH|$LIBPATH)
libpath.map{|x|
case x
when "$(topdir)", /\A\./
LIBPATHFLAG
else
LIBPATHFLAG+RPATHFLAG
end % x.quote
}.join
end
def with_werror(opt, opts = nil)
if opts
if opts[:werror] and config_string("WERRORFLAG") {|flag| opt = opt ? "#{opt} #{flag}" : flag}
(opts = opts.dup).delete(:werror)
end
yield(opt, opts)
else
yield(opt)
end
end
def try_link0(src, opt="", *opts, &b) # :nodoc:
exe = CONFTEST+$EXEEXT
cmd = link_command("", opt)
if $universal
require 'tmpdir'
Dir.mktmpdir("mkmf_", oldtmpdir = ENV["TMPDIR"]) do |tmpdir|
begin
ENV["TMPDIR"] = tmpdir
try_do(src, cmd, *opts, &b)
ensure
ENV["TMPDIR"] = oldtmpdir
end
end
else
try_do(src, cmd, *opts, &b)
end and File.executable?(exe) or return nil
exe
ensure
MakeMakefile.rm_rf(*Dir["#{CONFTEST}*"]-[exe])
end
# Returns whether or not the +src+ can be compiled as a C source and linked
# with its depending libraries successfully. +opt+ is passed to the linker
# as options. Note that +$CFLAGS+ and +$LDFLAGS+ are also passed to the
# linker.
#
# If a block given, it is called with the source before compilation. You can
# modify the source in the block.
#
# [+src+] a String which contains a C source
# [+opt+] a String which contains linker options
def try_link(src, opt="", *opts, &b)
exe = try_link0(src, opt, *opts, &b) or return false
MakeMakefile.rm_f exe
true
end
# Returns whether or not the +src+ can be compiled as a C source. +opt+ is
# passed to the C compiler as options. Note that +$CFLAGS+ is also passed to
# the compiler.
#
# If a block given, it is called with the source before compilation. You can
# modify the source in the block.
#
# [+src+] a String which contains a C source
# [+opt+] a String which contains compiler options
def try_compile(src, opt="", *opts, &b)
with_werror(opt, *opts) {|_opt, *| try_do(src, cc_command(_opt), *opts, &b)} and
File.file?("#{CONFTEST}.#{$OBJEXT}")
ensure
MakeMakefile.rm_f "#{CONFTEST}*"
end
# Returns whether or not the +src+ can be preprocessed with the C
# preprocessor. +opt+ is passed to the preprocessor as options. Note that
# +$CFLAGS+ is also passed to the preprocessor.
#
# If a block given, it is called with the source before preprocessing. You
# can modify the source in the block.
#
# [+src+] a String which contains a C source
# [+opt+] a String which contains preprocessor options
def try_cpp(src, opt="", *opts, &b)
try_do(src, cpp_command(CPPOUTFILE, opt), *opts, &b) and
File.file?("#{CONFTEST}.i")
ensure
MakeMakefile.rm_f "#{CONFTEST}*"
end
alias try_header try_compile
def cpp_include(header)
if header
header = [header] unless header.kind_of? Array
header.map {|h| String === h ? "#include <#{h}>\n" : h}.join
else
""
end
end
def with_cppflags(flags)
cppflags = $CPPFLAGS
$CPPFLAGS = flags.dup
ret = yield
ensure
$CPPFLAGS = cppflags unless ret
end
def try_cppflags(flags, opts = {})
try_header(MAIN_DOES_NOTHING, flags, {:werror => true}.update(opts))
end
def append_cppflags(flags, *opts)
Array(flags).each do |flag|
if checking_for("whether #{flag} is accepted as CPPFLAGS") {
try_cppflags(flag, *opts)
}
$CPPFLAGS << " " << flag
end
end
end
def with_cflags(flags)
cflags = $CFLAGS
$CFLAGS = flags.dup
ret = yield
ensure
$CFLAGS = cflags unless ret
end
def try_cflags(flags, opts = {})
try_compile(MAIN_DOES_NOTHING, flags, {:werror => true}.update(opts))
end
def with_ldflags(flags)
ldflags = $LDFLAGS
$LDFLAGS = flags.dup
ret = yield
ensure
$LDFLAGS = ldflags unless ret
end
def try_ldflags(flags, opts = {})
opts = {:werror => true}.update(opts) if $mswin
try_link(MAIN_DOES_NOTHING, flags, opts)
end
def append_ldflags(flags, *opts)
Array(flags).each do |flag|
if checking_for("whether #{flag} is accepted as LDFLAGS") {
try_ldflags(flag, *opts)
}
$LDFLAGS << " " << flag
end
end
end
def try_static_assert(expr, headers = nil, opt = "", &b)
headers = cpp_include(headers)
try_compile(<<SRC, opt, &b)
#{headers}
/*top*/
int conftest_const[(#{expr}) ? 1 : -1];
SRC
end
def try_constant(const, headers = nil, opt = "", &b)
includes = cpp_include(headers)
neg = try_static_assert("#{const} < 0", headers, opt)
if CROSS_COMPILING
if neg
const = "-(#{const})"
elsif try_static_assert("#{const} > 0", headers, opt)
# positive constant
elsif try_static_assert("#{const} == 0", headers, opt)
return 0
else
# not a constant
return nil
end
upper = 1
until try_static_assert("#{const} <= #{upper}", headers, opt)
lower = upper
upper <<= 1
end
return nil unless lower
while upper > lower + 1
mid = (upper + lower) / 2
if try_static_assert("#{const} > #{mid}", headers, opt)
lower = mid
else
upper = mid
end
end
upper = -upper if neg
return upper
else
src = %{#{includes}
#include <stdio.h>
/*top*/
typedef#{neg ? '' : ' unsigned'}
#ifdef PRI_LL_PREFIX
#define PRI_CONFTEST_PREFIX PRI_LL_PREFIX
LONG_LONG
#else
#define PRI_CONFTEST_PREFIX "l"
long
#endif
conftest_type;
conftest_type conftest_const = (conftest_type)(#{const});
int main() {printf("%"PRI_CONFTEST_PREFIX"#{neg ? 'd' : 'u'}\\n", conftest_const); return 0;}
}
begin
if try_link0(src, opt, &b)
xpopen("./#{CONFTEST}") do |f|
return Integer(f.gets)
end
end
ensure
MakeMakefile.rm_f "#{CONFTEST}#{$EXEEXT}"
end
end
nil
end
# You should use +have_func+ rather than +try_func+.
#
# [+func+] a String which contains a symbol name
# [+libs+] a String which contains library names.
# [+headers+] a String or an Array of strings which contains names of header
# files.
def try_func(func, libs, headers = nil, opt = "", &b)
headers = cpp_include(headers)
prepare = String.new
case func
when /^&/
decltype = proc {|x|"const volatile void *#{x}"}
when /\)$/
strvars = []
call = func.gsub(/""/) {
v = "s#{strvars.size + 1}"
strvars << v
v
}
unless strvars.empty?
prepare << "char " << strvars.map {|v| "#{v}[1024]"}.join(", ") << "; "
end
when nil
call = ""
else
call = "#{func}()"
decltype = proc {|x| "void ((*#{x})())"}
end
if opt and !opt.empty?
[[:to_str], [:join, " "], [:to_s]].each do |meth, *args|
if opt.respond_to?(meth)
break opt = opt.__send__(meth, *args)
end
end
opt = "#{opt} #{libs}"
else
opt = libs
end
decltype && try_link(<<"SRC", opt, &b) or
#{headers}
/*top*/
extern int t(void);
#{MAIN_DOES_NOTHING 't'}
int t(void) { #{decltype["volatile p"]}; p = (#{decltype[]})#{func}; return !p; }
SRC
call && try_link(<<"SRC", opt, &b)
#{headers}
/*top*/
extern int t(void);
#{MAIN_DOES_NOTHING 't'}
#{"extern void #{call};" if decltype}
int t(void) { #{prepare}#{call}; return 0; }
SRC
end
# You should use +have_var+ rather than +try_var+.
def try_var(var, headers = nil, opt = "", &b)
headers = cpp_include(headers)
try_compile(<<"SRC", opt, &b)
#{headers}
/*top*/
extern int t(void);
#{MAIN_DOES_NOTHING 't'}
int t(void) { const volatile void *volatile p; p = &(&#{var})[0]; return !p; }
SRC
end
# Returns whether or not the +src+ can be preprocessed with the C
# preprocessor and matches with +pat+.
#
# If a block given, it is called with the source before compilation. You can
# modify the source in the block.
#
# [+pat+] a Regexp or a String
# [+src+] a String which contains a C source
# [+opt+] a String which contains preprocessor options
#
# NOTE: When pat is a Regexp the matching will be checked in process,
# otherwise egrep(1) will be invoked to check it.
def egrep_cpp(pat, src, opt = "", &b)
src = create_tmpsrc(src, &b)
xpopen(cpp_command('', opt)) do |f|
if Regexp === pat
puts(" ruby -ne 'print if #{pat.inspect}'")
f.grep(pat) {|l|
puts "#{f.lineno}: #{l}"
return true
}
false
else
puts(" egrep '#{pat}'")
begin
stdin = $stdin.dup
$stdin.reopen(f)
system("egrep", pat)
ensure
$stdin.reopen(stdin)
end
end
end
ensure
MakeMakefile.rm_f "#{CONFTEST}*"
log_src(src)
end
# This is used internally by the have_macro? method.
def macro_defined?(macro, src, opt = "", &b)
src = src.sub(/[^\n]\z/, "\\&\n")
try_compile(src + <<"SRC", opt, &b)
/*top*/
#ifndef #{macro}
# error
|:/ === #{macro} undefined === /:|
#endif
SRC
end
# Returns whether or not:
# * the +src+ can be compiled as a C source,
# * the result object can be linked with its depending libraries
# successfully,
# * the linked file can be invoked as an executable
# * and the executable exits successfully
#
# +opt+ is passed to the linker as options. Note that +$CFLAGS+ and
# +$LDFLAGS+ are also passed to the linker.
#
# If a block given, it is called with the source before compilation. You can
# modify the source in the block.
#
# [+src+] a String which contains a C source
# [+opt+] a String which contains linker options
#
# Returns true when the executable exits successfully, false when it fails,
# or nil when preprocessing, compilation or link fails.
def try_run(src, opt = "", &b)
raise "cannot run test program while cross compiling" if CROSS_COMPILING
if try_link0(src, opt, &b)
xsystem("./#{CONFTEST}")
else
nil
end
ensure
MakeMakefile.rm_f "#{CONFTEST}*"
end
def install_files(mfile, ifiles, map = nil, srcprefix = nil)
ifiles or return
ifiles.empty? and return
srcprefix ||= "$(srcdir)/#{srcprefix}".chomp('/')
RbConfig::expand(srcdir = srcprefix.dup)
dirs = []
path = Hash.new {|h, i| h[i] = dirs.push([i])[-1]}
ifiles.each do |files, dir, prefix|
dir = map_dir(dir, map)
prefix &&= %r|\A#{Regexp.quote(prefix)}/?|
if /\A\.\// =~ files
# install files which are in current working directory.
files = files[2..-1]
len = nil
else
# install files which are under the $(srcdir).
files = File.join(srcdir, files)
len = srcdir.size
end
f = nil
Dir.glob(files) do |fx|
f = fx
f[0..len] = "" if len
case File.basename(f)
when *$NONINSTALLFILES
next
end
d = File.dirname(f)
d.sub!(prefix, "") if prefix
d = (d.empty? || d == ".") ? dir : File.join(dir, d)
f = File.join(srcprefix, f) if len
path[d] << f
end
unless len or f
d = File.dirname(files)
d.sub!(prefix, "") if prefix
d = (d.empty? || d == ".") ? dir : File.join(dir, d)
path[d] << files
end
end
dirs
end
def install_rb(mfile, dest, srcdir = nil)
install_files(mfile, [["lib/**/*.rb", dest, "lib"]], nil, srcdir)
end
def append_library(libs, lib) # :no-doc:
format(LIBARG, lib) + " " + libs
end
def message(*s)
unless Logging.quiet and not $VERBOSE
printf(*s)
$stdout.flush
end
end
# This emits a string to stdout that allows users to see the results of the
# various have* and find* methods as they are tested.
#
# Internal use only.
#
def checking_for(m, fmt = nil)
if f = caller_locations(1, 1).first.base_label and /\A\w/ =~ f
f += ": "
else
f = ""
end
m = "checking #{/\Acheck/ =~ f ? '' : 'for '}#{m}... "
message "%s", m
a = r = nil
Logging::postpone do
r = yield
a = (fmt ? "#{fmt % r}" : r ? "yes" : "no")
"#{f}#{m}-------------------- #{a}\n\n"
end
message "%s\n", a
Logging::message "--------------------\n\n"
r
end
def checking_message(target, place = nil, opt = nil)
[["in", place], ["with", opt]].inject("#{target}") do |msg, (pre, noun)|
if noun
[[:to_str], [:join, ","], [:to_s]].each do |meth, *args|
if noun.respond_to?(meth)
break noun = noun.__send__(meth, *args)
end
end
unless noun.empty?
msg << " #{pre} " unless msg.empty?
msg << noun
end
end
msg
end
end
# :startdoc:
# Check whether each given C compiler flag is acceptable and append it
# to <tt>$CFLAGS</tt> if so.
#
# [+flags+] a C compiler flag as a +String+ or an +Array+ of them
#
def append_cflags(flags, *opts)
Array(flags).each do |flag|
if checking_for("whether #{flag} is accepted as CFLAGS") {
try_cflags(flag, *opts)
}
$CFLAGS << " " << flag
end
end
end
# Returns whether or not +macro+ is defined either in the common header
# files or within any +headers+ you provide.
#
# Any options you pass to +opt+ are passed along to the compiler.
#
def have_macro(macro, headers = nil, opt = "", &b)
checking_for checking_message(macro, headers, opt) do
macro_defined?(macro, cpp_include(headers), opt, &b)
end
end
# Returns whether or not the given entry point +func+ can be found within
# +lib+. If +func+ is +nil+, the <code>main()</code> entry point is used by
# default. If found, it adds the library to list of libraries to be used
# when linking your extension.
#
# If +headers+ are provided, it will include those header files as the
# header files it looks in when searching for +func+.
#
# The real name of the library to be linked can be altered by
# <code>--with-FOOlib</code> configuration option.
#
def have_library(lib, func = nil, headers = nil, opt = "", &b)
dir_config(lib)
lib = with_config(lib+'lib', lib)
checking_for checking_message(func && func.funcall_style, LIBARG%lib, opt) do
if COMMON_LIBS.include?(lib)
true
else
libs = append_library($libs, lib)
if try_func(func, libs, headers, opt, &b)
$libs = libs
true
else
false
end
end
end
end
# Returns whether or not the entry point +func+ can be found within the
# library +lib+ in one of the +paths+ specified, where +paths+ is an array
# of strings. If +func+ is +nil+ , then the <code>main()</code> function is
# used as the entry point.
#
# If +lib+ is found, then the path it was found on is added to the list of
# library paths searched and linked against.
#
def find_library(lib, func, *paths, &b)
dir_config(lib)
lib = with_config(lib+'lib', lib)
paths = paths.flat_map {|path| path.split(File::PATH_SEPARATOR)}
checking_for checking_message(func && func.funcall_style, LIBARG%lib) do
libpath = $LIBPATH
libs = append_library($libs, lib)
begin
until r = try_func(func, libs, &b) or paths.empty?
$LIBPATH = libpath | [paths.shift]
end
if r
$libs = libs
libpath = nil
end
ensure
$LIBPATH = libpath if libpath
end
r
end
end
# Returns whether or not the function +func+ can be found in the common
# header files, or within any +headers+ that you provide. If found, a macro
# is passed as a preprocessor constant to the compiler using the function
# name, in uppercase, prepended with +HAVE_+.
#
# To check functions in an additional library, you need to check that
# library first using <code>have_library()</code>. The +func+ shall be
# either mere function name or function name with arguments.
#
# For example, if <code>have_func('foo')</code> returned +true+, then the
# +HAVE_FOO+ preprocessor macro would be passed to the compiler.
#
def have_func(func, headers = nil, opt = "", &b)
checking_for checking_message(func.funcall_style, headers, opt) do
if try_func(func, $libs, headers, opt, &b)
$defs << "-DHAVE_#{func.sans_arguments.tr_cpp}"
true
else
false
end
end
end
# Returns whether or not the variable +var+ can be found in the common
# header files, or within any +headers+ that you provide. If found, a macro
# is passed as a preprocessor constant to the compiler using the variable
# name, in uppercase, prepended with +HAVE_+.
#
# To check variables in an additional library, you need to check that
# library first using <code>have_library()</code>.
#
# For example, if <code>have_var('foo')</code> returned true, then the
# +HAVE_FOO+ preprocessor macro would be passed to the compiler.
#
def have_var(var, headers = nil, opt = "", &b)
checking_for checking_message(var, headers, opt) do
if try_var(var, headers, opt, &b)
$defs.push(format("-DHAVE_%s", var.tr_cpp))
true
else
false
end
end
end
# Returns whether or not the given +header+ file can be found on your system.
# If found, a macro is passed as a preprocessor constant to the compiler
# using the header file name, in uppercase, prepended with +HAVE_+.
#
# For example, if <code>have_header('foo.h')</code> returned true, then the
# +HAVE_FOO_H+ preprocessor macro would be passed to the compiler.
#
def have_header(header, preheaders = nil, opt = "", &b)
dir_config(header[/.*?(?=\/)|.*?(?=\.)/])
checking_for header do
if try_header(cpp_include(preheaders)+cpp_include(header), opt, &b)
$defs.push(format("-DHAVE_%s", header.tr_cpp))
true
else
false
end
end
end
# Returns whether or not the given +framework+ can be found on your system.
# If found, a macro is passed as a preprocessor constant to the compiler
# using the framework name, in uppercase, prepended with +HAVE_FRAMEWORK_+.
#
# For example, if <code>have_framework('Ruby')</code> returned true, then
# the +HAVE_FRAMEWORK_RUBY+ preprocessor macro would be passed to the
# compiler.
#
# If +fw+ is a pair of the framework name and its header file name
# that header file is checked, instead of the normally used header
# file which is named same as the framework.
def have_framework(fw, &b)
if Array === fw
fw, header = *fw
else
header = "#{fw}.h"
end
checking_for fw do
src = cpp_include("#{fw}/#{header}") << "\n" "int main(void){return 0;}"
opt = " -framework #{fw}"
if try_link(src, opt, &b) or (objc = try_link(src, "-ObjC#{opt}", &b))
$defs.push(format("-DHAVE_FRAMEWORK_%s", fw.tr_cpp))
# TODO: non-worse way than this hack, to get rid of separating
# option and its argument.
$LDFLAGS << " -ObjC" if objc and /(\A|\s)-ObjC(\s|\z)/ !~ $LDFLAGS
$LIBS << opt
true
else
false
end
end
end
# Instructs mkmf to search for the given +header+ in any of the +paths+
# provided, and returns whether or not it was found in those paths.
#
# If the header is found then the path it was found on is added to the list
# of included directories that are sent to the compiler (via the
# <code>-I</code> switch).
#
def find_header(header, *paths)
message = checking_message(header, paths)
header = cpp_include(header)
checking_for message do
if try_header(header)
true
else
found = false
paths.each do |dir|
opt = "-I#{dir}".quote
if try_header(header, opt)
$INCFLAGS << " " << opt
found = true
break
end
end
found
end
end
end
# Returns whether or not the struct of type +type+ contains +member+. If
# it does not, or the struct type can't be found, then false is returned.
# You may optionally specify additional +headers+ in which to look for the
# struct (in addition to the common header files).
#
# If found, a macro is passed as a preprocessor constant to the compiler
# using the type name and the member name, in uppercase, prepended with
# +HAVE_+.
#
# For example, if <code>have_struct_member('struct foo', 'bar')</code>
# returned true, then the +HAVE_STRUCT_FOO_BAR+ preprocessor macro would be
# passed to the compiler.
#
# +HAVE_ST_BAR+ is also defined for backward compatibility.
#
def have_struct_member(type, member, headers = nil, opt = "", &b)
checking_for checking_message("#{type}.#{member}", headers) do
if try_compile(<<"SRC", opt, &b)
#{cpp_include(headers)}
/*top*/
int s = (char *)&((#{type}*)0)->#{member} - (char *)0;
#{MAIN_DOES_NOTHING}
SRC
$defs.push(format("-DHAVE_%s_%s", type.tr_cpp, member.tr_cpp))
$defs.push(format("-DHAVE_ST_%s", member.tr_cpp)) # backward compatibility
true
else
false
end
end
end
# Returns whether or not the static type +type+ is defined.
#
# See also +have_type+
#
def try_type(type, headers = nil, opt = "", &b)
if try_compile(<<"SRC", opt, &b)
#{cpp_include(headers)}
/*top*/
typedef #{type} conftest_type;
int conftestval[sizeof(conftest_type)?1:-1];
SRC
$defs.push(format("-DHAVE_TYPE_%s", type.tr_cpp))
true
else
false
end
end
# Returns whether or not the static type +type+ is defined. You may
# optionally pass additional +headers+ to check against in addition to the
# common header files.
#
# You may also pass additional flags to +opt+ which are then passed along to
# the compiler.
#
# If found, a macro is passed as a preprocessor constant to the compiler
# using the type name, in uppercase, prepended with +HAVE_TYPE_+.
#
# For example, if <code>have_type('foo')</code> returned true, then the
# +HAVE_TYPE_FOO+ preprocessor macro would be passed to the compiler.
#
def have_type(type, headers = nil, opt = "", &b)
checking_for checking_message(type, headers, opt) do
try_type(type, headers, opt, &b)
end
end
# Returns where the static type +type+ is defined.
#
# You may also pass additional flags to +opt+ which are then passed along to
# the compiler.
#
# See also +have_type+.
#
def find_type(type, opt, *headers, &b)
opt ||= ""
fmt = "not found"
def fmt.%(x)
x ? x.respond_to?(:join) ? x.join(",") : x : self
end
checking_for checking_message(type, nil, opt), fmt do
headers.find do |h|
try_type(type, h, opt, &b)
end
end
end
# Returns whether or not the constant +const+ is defined.
#
# See also +have_const+
#
def try_const(const, headers = nil, opt = "", &b)
const, type = *const
if try_compile(<<"SRC", opt, &b)
#{cpp_include(headers)}
/*top*/
typedef #{type || 'int'} conftest_type;
conftest_type conftestval = #{type ? '' : '(int)'}#{const};
SRC
$defs.push(format("-DHAVE_CONST_%s", const.tr_cpp))
true
else
false
end
end
# Returns whether or not the constant +const+ is defined. You may
# optionally pass the +type+ of +const+ as <code>[const, type]</code>,
# such as:
#
# have_const(%w[PTHREAD_MUTEX_INITIALIZER pthread_mutex_t], "pthread.h")
#
# You may also pass additional +headers+ to check against in addition to the
# common header files, and additional flags to +opt+ which are then passed
# along to the compiler.
#
# If found, a macro is passed as a preprocessor constant to the compiler
# using the type name, in uppercase, prepended with +HAVE_CONST_+.
#
# For example, if <code>have_const('foo')</code> returned true, then the
# +HAVE_CONST_FOO+ preprocessor macro would be passed to the compiler.
#
def have_const(const, headers = nil, opt = "", &b)
checking_for checking_message([*const].compact.join(' '), headers, opt) do
try_const(const, headers, opt, &b)
end
end
# :stopdoc:
STRING_OR_FAILED_FORMAT = "%s"
class << STRING_OR_FAILED_FORMAT # :nodoc:
def %(x)
x ? super : "failed"
end
end
def typedef_expr(type, headers)
typename, member = type.split('.', 2)
prelude = cpp_include(headers).split(/$/)
prelude << "typedef #{typename} rbcv_typedef_;\n"
return "rbcv_typedef_", member, prelude
end
def try_signedness(type, member, headers = nil, opts = nil)
raise ArgumentError, "don't know how to tell signedness of members" if member
if try_static_assert("(#{type})-1 < 0", headers, opts)
return -1
elsif try_static_assert("(#{type})-1 > 0", headers, opts)
return +1
end
end
# :startdoc:
# Returns the size of the given +type+. You may optionally specify
# additional +headers+ to search in for the +type+.
#
# If found, a macro is passed as a preprocessor constant to the compiler
# using the type name, in uppercase, prepended with +SIZEOF_+, followed by
# the type name, followed by <code>=X</code> where "X" is the actual size.
#
# For example, if <code>check_sizeof('mystruct')</code> returned 12, then
# the <code>SIZEOF_MYSTRUCT=12</code> preprocessor macro would be passed to
# the compiler.
#
def check_sizeof(type, headers = nil, opts = "", &b)
typedef, member, prelude = typedef_expr(type, headers)
prelude << "#{typedef} *rbcv_ptr_;\n"
prelude = [prelude]
expr = "sizeof((*rbcv_ptr_)#{"." << member if member})"
fmt = STRING_OR_FAILED_FORMAT
checking_for checking_message("size of #{type}", headers), fmt do
if size = try_constant(expr, prelude, opts, &b)
$defs.push(format("-DSIZEOF_%s=%s", type.tr_cpp, size))
size
end
end
end
# Returns the signedness of the given +type+. You may optionally specify
# additional +headers+ to search in for the +type+.
#
# If the +type+ is found and is a numeric type, a macro is passed as a
# preprocessor constant to the compiler using the +type+ name, in uppercase,
# prepended with +SIGNEDNESS_OF_+, followed by the +type+ name, followed by
# <code>=X</code> where "X" is positive integer if the +type+ is unsigned
# and a negative integer if the +type+ is signed.
#
# For example, if +size_t+ is defined as unsigned, then
# <code>check_signedness('size_t')</code> would return +1 and the
# <code>SIGNEDNESS_OF_SIZE_T=+1</code> preprocessor macro would be passed to
# the compiler. The <code>SIGNEDNESS_OF_INT=-1</code> macro would be set
# for <code>check_signedness('int')</code>
#
def check_signedness(type, headers = nil, opts = nil, &b)
typedef, member, prelude = typedef_expr(type, headers)
signed = nil
checking_for("signedness of #{type}", STRING_OR_FAILED_FORMAT) do
signed = try_signedness(typedef, member, [prelude], opts, &b) or next nil
$defs.push("-DSIGNEDNESS_OF_%s=%+d" % [type.tr_cpp, signed])
signed < 0 ? "signed" : "unsigned"
end
signed
end
# Returns the convertible integer type of the given +type+. You may
# optionally specify additional +headers+ to search in for the +type+.
# _convertible_ means actually the same type, or typedef'd from the same
# type.
#
# If the +type+ is an integer type and the _convertible_ type is found,
# the following macros are passed as preprocessor constants to the compiler
# using the +type+ name, in uppercase.
#
# * +TYPEOF_+, followed by the +type+ name, followed by <code>=X</code>
# where "X" is the found _convertible_ type name.
# * +TYP2NUM+ and +NUM2TYP+,
# where +TYP+ is the +type+ name in uppercase with replacing an +_t+
# suffix with "T", followed by <code>=X</code> where "X" is the macro name
# to convert +type+ to an Integer object, and vice versa.
#
# For example, if +foobar_t+ is defined as unsigned long, then
# <code>convertible_int("foobar_t")</code> would return "unsigned long", and
# define these macros:
#
# #define TYPEOF_FOOBAR_T unsigned long
# #define FOOBART2NUM ULONG2NUM
# #define NUM2FOOBART NUM2ULONG
#
def convertible_int(type, headers = nil, opts = nil, &b)
type, macname = *type
checking_for("convertible type of #{type}", STRING_OR_FAILED_FORMAT) do
if UNIVERSAL_INTS.include?(type)
type
else
typedef, member, prelude = typedef_expr(type, headers, &b)
if member
prelude << "static rbcv_typedef_ rbcv_var;"
compat = UNIVERSAL_INTS.find {|t|
try_static_assert("sizeof(rbcv_var.#{member}) == sizeof(#{t})", [prelude], opts, &b)
}
else
next unless signed = try_signedness(typedef, member, [prelude])
u = "unsigned " if signed > 0
prelude << "extern rbcv_typedef_ foo();"
compat = UNIVERSAL_INTS.find {|t|
try_compile([prelude, "extern #{u}#{t} foo();"].join("\n"), opts, :werror=>true, &b)
}
end
if compat
macname ||= type.sub(/_(?=t\z)/, '').tr_cpp
conv = (compat == "long long" ? "LL" : compat.upcase)
compat = "#{u}#{compat}"
typename = type.tr_cpp
$defs.push(format("-DSIZEOF_%s=SIZEOF_%s", typename, compat.tr_cpp))
$defs.push(format("-DTYPEOF_%s=%s", typename, compat.quote))
$defs.push(format("-DPRI_%s_PREFIX=PRI_%s_PREFIX", macname, conv))
conv = (u ? "U" : "") + conv
$defs.push(format("-D%s2NUM=%s2NUM", macname, conv))
$defs.push(format("-DNUM2%s=NUM2%s", macname, conv))
compat
end
end
end
end
# :stopdoc:
# Used internally by the what_type? method to determine if +type+ is a scalar
# pointer.
def scalar_ptr_type?(type, member = nil, headers = nil, &b)
try_compile(<<"SRC", &b) # pointer
#{cpp_include(headers)}
/*top*/
volatile #{type} conftestval;
extern int t(void);
#{MAIN_DOES_NOTHING 't'}
int t(void) {return (int)(1-*(conftestval#{member ? ".#{member}" : ""}));}
SRC
end
# Used internally by the what_type? method to determine if +type+ is a scalar
# pointer.
def scalar_type?(type, member = nil, headers = nil, &b)
try_compile(<<"SRC", &b) # pointer
#{cpp_include(headers)}
/*top*/
volatile #{type} conftestval;
extern int t(void);
#{MAIN_DOES_NOTHING 't'}
int t(void) {return (int)(1-(conftestval#{member ? ".#{member}" : ""}));}
SRC
end
# Used internally by the what_type? method to check if the _typeof_ GCC
# extension is available.
def have_typeof?
return $typeof if defined?($typeof)
$typeof = %w[__typeof__ typeof].find do |t|
try_compile(<<SRC)
int rbcv_foo;
#{t}(rbcv_foo) rbcv_bar;
SRC
end
end
def what_type?(type, member = nil, headers = nil, &b)
m = "#{type}"
var = val = "*rbcv_var_"
func = "rbcv_func_(void)"
if member
m << "." << member
else
type, member = type.split('.', 2)
end
if member
val = "(#{var}).#{member}"
end
prelude = [cpp_include(headers).split(/^/)]
prelude << ["typedef #{type} rbcv_typedef_;\n",
"extern rbcv_typedef_ *#{func};\n",
"rbcv_typedef_ #{var};\n",
]
type = "rbcv_typedef_"
fmt = member && !(typeof = have_typeof?) ? "seems %s" : "%s"
if typeof
var = "*rbcv_member_"
func = "rbcv_mem_func_(void)"
member = nil
type = "rbcv_mem_typedef_"
prelude[-1] << "typedef #{typeof}(#{val}) #{type};\n"
prelude[-1] << "extern #{type} *#{func};\n"
prelude[-1] << "#{type} #{var};\n"
val = var
end
def fmt.%(x)
x ? super : "unknown"
end
checking_for checking_message(m, headers), fmt do
if scalar_ptr_type?(type, member, prelude, &b)
if try_static_assert("sizeof(*#{var}) == 1", prelude)
return "string"
end
ptr = "*"
elsif scalar_type?(type, member, prelude, &b)
unless member and !typeof or try_static_assert("(#{type})-1 < 0", prelude)
unsigned = "unsigned"
end
ptr = ""
else
next
end
type = UNIVERSAL_INTS.find do |t|
pre = prelude
unless member
pre += [["#{unsigned} #{t} #{ptr}#{var};\n",
"extern #{unsigned} #{t} #{ptr}*#{func};\n"]]
end
try_static_assert("sizeof(#{ptr}#{val}) == sizeof(#{unsigned} #{t})", pre)
end
type or next
[unsigned, type, ptr].join(" ").strip
end
end
# This method is used internally by the find_executable method.
#
# Internal use only.
#
def find_executable0(bin, path = nil)
executable_file = proc do |name|
begin
stat = File.stat(name)
rescue SystemCallError
else
next name if stat.file? and stat.executable?
end
end
exts = config_string('EXECUTABLE_EXTS') {|s| s.split} || config_string('EXEEXT') {|s| [s]}
if File.expand_path(bin) == bin
return bin if executable_file.call(bin)
if exts
exts.each {|ext| executable_file.call(file = bin + ext) and return file}
end
return nil
end
if path ||= ENV['PATH']
path = path.split(File::PATH_SEPARATOR)
else
path = %w[/usr/local/bin /usr/ucb /usr/bin /bin]
end
file = nil
path.each do |dir|
dir.sub!(/\A"(.*)"\z/m, '\1') if $mswin or $mingw
return file if executable_file.call(file = File.join(dir, bin))
if exts
exts.each {|ext| executable_file.call(ext = file + ext) and return ext}
end
end
nil
end
# :startdoc:
# Searches for the executable +bin+ on +path+. The default path is your
# +PATH+ environment variable. If that isn't defined, it will resort to
# searching /usr/local/bin, /usr/ucb, /usr/bin and /bin.
#
# If found, it will return the full path, including the executable name, of
# where it was found.
#
# Note that this method does not actually affect the generated Makefile.
#
def find_executable(bin, path = nil)
checking_for checking_message(bin, path) do
find_executable0(bin, path)
end
end
# :stopdoc:
def arg_config(config, default=nil, &block)
$arg_config << [config, default]
defaults = []
if default
defaults << default
elsif !block
defaults << nil
end
$configure_args.fetch(config.tr('_', '-'), *defaults, &block)
end
# :startdoc:
# Tests for the presence of a <tt>--with-</tt>_config_ or
# <tt>--without-</tt>_config_ option. Returns +true+ if the with option is
# given, +false+ if the without option is given, and the default value
# otherwise.
#
# This can be useful for adding custom definitions, such as debug
# information.
#
# Example:
#
# if with_config("debug")
# $defs.push("-DOSSL_DEBUG") unless $defs.include? "-DOSSL_DEBUG"
# end
#
def with_config(config, default=nil)
config = config.sub(/^--with[-_]/, '')
val = arg_config("--with-"+config) do
if arg_config("--without-"+config)
false
elsif block_given?
yield(config, default)
else
break default
end
end
case val
when "yes"
true
when "no"
false
else
val
end
end
# Tests for the presence of an <tt>--enable-</tt>_config_ or
# <tt>--disable-</tt>_config_ option. Returns +true+ if the enable option is
# given, +false+ if the disable option is given, and the default value
# otherwise.
#
# This can be useful for adding custom definitions, such as debug
# information.
#
# Example:
#
# if enable_config("debug")
# $defs.push("-DOSSL_DEBUG") unless $defs.include? "-DOSSL_DEBUG"
# end
#
def enable_config(config, default=nil)
if arg_config("--enable-"+config)
true
elsif arg_config("--disable-"+config)
false
elsif block_given?
yield(config, default)
else
return default
end
end
# Generates a header file consisting of the various macro definitions
# generated by other methods such as have_func and have_header. These are
# then wrapped in a custom <code>#ifndef</code> based on the +header+ file
# name, which defaults to "extconf.h".
#
# For example:
#
# # extconf.rb
# require 'mkmf'
# have_func('realpath')
# have_header('sys/utime.h')
# create_header
# create_makefile('foo')
#
# The above script would generate the following extconf.h file:
#
# #ifndef EXTCONF_H
# #define EXTCONF_H
# #define HAVE_REALPATH 1
# #define HAVE_SYS_UTIME_H 1
# #endif
#
# Given that the create_header method generates a file based on definitions
# set earlier in your extconf.rb file, you will probably want to make this
# one of the last methods you call in your script.
#
def create_header(header = "extconf.h")
message "creating %s\n", header
sym = header.tr_cpp
hdr = ["#ifndef #{sym}\n#define #{sym}\n"]
for line in $defs
case line
when /^-D([^=]+)(?:=(.*))?/
hdr << "#define #$1 #{$2 ? Shellwords.shellwords($2)[0].gsub(/(?=\t+)/, "\\\n") : 1}\n"
when /^-U(.*)/
hdr << "#undef #$1\n"
end
end
hdr << "#endif\n"
hdr = hdr.join("")
log_src(hdr, "#{header} is")
unless (File.read(header) == hdr rescue false)
File.open(header, "wb") do |hfile|
hfile.write(hdr)
end
end
$extconf_h = header
end
# call-seq:
# dir_config(target)
# dir_config(target, prefix)
# dir_config(target, idefault, ldefault)
#
# Sets a +target+ name that the user can then use to configure
# various "with" options with on the command line by using that
# name. For example, if the target is set to "foo", then the user
# could use the <code>--with-foo-dir=prefix</code>,
# <code>--with-foo-include=dir</code> and
# <code>--with-foo-lib=dir</code> command line options to tell where
# to search for header/library files.
#
# You may pass along additional parameters to specify default
# values. If one is given it is taken as default +prefix+, and if
# two are given they are taken as "include" and "lib" defaults in
# that order.
#
# In any case, the return value will be an array of determined
# "include" and "lib" directories, either of which can be nil if no
# corresponding command line option is given when no default value
# is specified.
#
# Note that dir_config only adds to the list of places to search for
# libraries and include files. It does not link the libraries into your
# application.
#
def dir_config(target, idefault=nil, ldefault=nil)
key = [target, idefault, ldefault].compact.join("\0")
if conf = $config_dirs[key]
return conf
end
if dir = with_config(target + "-dir", (idefault unless ldefault))
defaults = Array === dir ? dir : dir.split(File::PATH_SEPARATOR)
idefault = ldefault = nil
end
idir = with_config(target + "-include", idefault)
if conf = $arg_config.assoc("--with-#{target}-include")
conf[1] ||= "${#{target}-dir}/include"
end
ldir = with_config(target + "-lib", ldefault)
if conf = $arg_config.assoc("--with-#{target}-lib")
conf[1] ||= "${#{target}-dir}/#{_libdir_basename}"
end
idirs = idir ? Array === idir ? idir.dup : idir.split(File::PATH_SEPARATOR) : []
if defaults
idirs.concat(defaults.collect {|d| d + "/include"})
idir = ([idir] + idirs).compact.join(File::PATH_SEPARATOR)
end
unless idirs.empty?
idirs.collect! {|d| "-I" + d}
idirs -= Shellwords.shellwords($CPPFLAGS)
unless idirs.empty?
$CPPFLAGS = (idirs.quote << $CPPFLAGS).join(" ")
end
end
ldirs = ldir ? Array === ldir ? ldir.dup : ldir.split(File::PATH_SEPARATOR) : []
if defaults
ldirs.concat(defaults.collect {|d| "#{d}/#{_libdir_basename}"})
ldir = ([ldir] + ldirs).compact.join(File::PATH_SEPARATOR)
end
$LIBPATH = ldirs | $LIBPATH
$config_dirs[key] = [idir, ldir]
end
# Returns compile/link information about an installed library in a tuple of <code>[cflags,
# ldflags, libs]</code>, by using the command found first in the following commands:
#
# 1. If <code>--with-{pkg}-config={command}</code> is given via
# command line option: <code>{command} {options}</code>
#
# 2. <code>{pkg}-config {options}</code>
#
# 3. <code>pkg-config {options} {pkg}</code>
#
# Where +options+ is the option name without dashes, for instance <code>"cflags"</code> for the
# <code>--cflags</code> flag.
#
# The values obtained are appended to <code>$INCFLAGS</code>, <code>$CFLAGS</code>,
# <code>$LDFLAGS</code> and <code>$libs</code>.
#
# If one or more <code>options</code> argument is given, the config command is
# invoked with the options and a stripped output string is returned without
# modifying any of the global values mentioned above.
def pkg_config(pkg, *options)
fmt = "not found"
def fmt.%(x)
x ? x.inspect : self
end
checking_for "pkg-config for #{pkg}", fmt do
_, ldir = dir_config(pkg)
if ldir
pkg_config_path = "#{ldir}/pkgconfig"
if File.directory?(pkg_config_path)
Logging.message("PKG_CONFIG_PATH = %s\n", pkg_config_path)
envs = ["PKG_CONFIG_PATH"=>[pkg_config_path, ENV["PKG_CONFIG_PATH"]].compact.join(File::PATH_SEPARATOR)]
end
end
if pkgconfig = with_config("#{pkg}-config") and find_executable0(pkgconfig)
# if and only if package specific config command is given
elsif ($PKGCONFIG ||=
(pkgconfig = with_config("pkg-config") {config_string("PKG_CONFIG") || "pkg-config"}) &&
find_executable0(pkgconfig) && pkgconfig) and
xsystem([*envs, $PKGCONFIG, "--exists", pkg])
# default to pkg-config command
pkgconfig = $PKGCONFIG
args = [pkg]
elsif find_executable0(pkgconfig = "#{pkg}-config")
# default to package specific config command, as a last resort.
else
pkgconfig = nil
end
if pkgconfig
get = proc {|opts|
opts = Array(opts).map { |o| "--#{o}" }
opts = xpopen([*envs, pkgconfig, *opts, *args], err:[:child, :out], &:read)
Logging.open {puts opts.each_line.map{|s|"=> #{s.inspect}"}}
opts.strip if $?.success?
}
end
orig_ldflags = $LDFLAGS
if get and !options.empty?
get[options]
elsif get and try_ldflags(ldflags = get['libs'])
if incflags = get['cflags-only-I']
$INCFLAGS << " " << incflags
cflags = get['cflags-only-other']
else
cflags = get['cflags']
end
libs = get['libs-only-l']
if cflags
$CFLAGS += " " << cflags
$CXXFLAGS += " " << cflags
end
if libs
ldflags = (Shellwords.shellwords(ldflags) - Shellwords.shellwords(libs)).quote.join(" ")
else
libs, ldflags = Shellwords.shellwords(ldflags).partition {|s| s =~ /-l([^ ]+)/ }.map {|l|l.quote.join(" ")}
end
$libs += " " << libs
$LDFLAGS = [orig_ldflags, ldflags].join(' ')
Logging::message "package configuration for %s\n", pkg
Logging::message "incflags: %s\ncflags: %s\nldflags: %s\nlibs: %s\n\n",
incflags, cflags, ldflags, libs
[[incflags, cflags].join(' '), ldflags, libs]
else
Logging::message "package configuration for %s is not found\n", pkg
nil
end
end
end
# :stopdoc:
def with_destdir(dir)
dir = dir.sub($dest_prefix_pattern, '')
/\A\$[\(\{]/ =~ dir ? dir : "$(DESTDIR)"+dir
end
# Converts forward slashes to backslashes. Aimed at MS Windows.
#
# Internal use only.
#
def winsep(s)
s.tr('/', '\\')
end
# Converts native path to format acceptable in Makefile
#
# Internal use only.
#
if !CROSS_COMPILING
case CONFIG['build_os']
when 'mingw32'
def mkintpath(path)
# mingw uses make from msys and it needs special care
# converts from C:\some\path to /C/some/path
path = path.dup
path.tr!('\\', '/')
path.sub!(/\A([A-Za-z]):(?=\/)/, '/\1')
path
end
when 'cygwin', 'msys'
if CONFIG['target_os'] != 'cygwin'
def mkintpath(path)
IO.popen(["cygpath", "-u", path], &:read).chomp
end
end
end
end
unless method_defined?(:mkintpath)
def mkintpath(path)
path
end
end
def configuration(srcdir)
mk = []
verbose = with_config('verbose') ? "1" : (CONFIG['MKMF_VERBOSE'] || "0")
vpath = $VPATH.dup
CONFIG["hdrdir"] ||= $hdrdir
mk << %{
SHELL = /bin/sh
# V=0 quiet, V=1 verbose. other values don't work.
V = 1
V0 = $(V:0=)
Q1 = $(V:1=)
Q = $(Q1:0=@)
ECHO1 = $(V:1=@ #{CONFIG['NULLCMD']})
ECHO = $(ECHO1:0=@ echo)
NULLCMD = #{CONFIG['NULLCMD']}
#### Start of system configuration section. ####
#{"top_srcdir = " + $top_srcdir.sub(%r"\A#{Regexp.quote($topdir)}/", "$(topdir)/") if $extmk}
srcdir = #{srcdir.gsub(/\$\((srcdir)\)|\$\{(srcdir)\}/) {mkintpath(CONFIG[$1||$2]).unspace}}
topdir = #{mkintpath(topdir = $extmk ? CONFIG["topdir"] : $topdir).unspace}
hdrdir = #{(hdrdir = CONFIG["hdrdir"]) == topdir ? "$(topdir)" : mkintpath(hdrdir).unspace}
arch_hdrdir = #{mkintpath($arch_hdrdir).unspace}
PATH_SEPARATOR = #{CONFIG['PATH_SEPARATOR']}
VPATH = #{vpath.join(CONFIG['PATH_SEPARATOR'])}
}
if $extmk
mk << "RUBYLIB =\n""RUBYOPT = -\n"
end
prefix = mkintpath(CONFIG["prefix"])
if destdir = prefix[$dest_prefix_pattern, 1]
mk << "\nDESTDIR = #{destdir}\n"
prefix = prefix[destdir.size..-1]
end
mk << "prefix = #{with_destdir(prefix).unspace}\n"
CONFIG.each do |key, var|
mk << "#{key} = #{with_destdir(mkintpath(var)).unspace}\n" if /.prefix$/ =~ key
end
CONFIG.each do |key, var|
next if /^abs_/ =~ key
next if /^(?:src|top(?:_src)?|build|hdr)dir$/ =~ key
next unless /dir$/ =~ key
mk << "#{key} = #{with_destdir(var)}\n"
end
if !$extmk and !$configure_args.has_key?('--ruby') and
sep = config_string('BUILD_FILE_SEPARATOR')
sep = ":/=#{sep}"
else
sep = ""
end
possible_command = (proc {|s| s if /top_srcdir|tooldir/ !~ s} unless $extmk)
extconf_h = $extconf_h ? "-DRUBY_EXTCONF_H=\\\"$(RUBY_EXTCONF_H)\\\" " : $defs.join(" ") << " "
headers = %w[
$(hdrdir)/ruby.h
$(hdrdir)/ruby/backward.h
$(hdrdir)/ruby/ruby.h
$(hdrdir)/ruby/defines.h
$(hdrdir)/ruby/missing.h
$(hdrdir)/ruby/intern.h
$(hdrdir)/ruby/st.h
$(hdrdir)/ruby/subst.h
]
headers += $headers
if RULE_SUBST
headers.each {|h| h.sub!(/.*/, &RULE_SUBST.method(:%))}
end
headers << $config_h
headers << '$(RUBY_EXTCONF_H)' if $extconf_h
mk << %{
CC_WRAPPER = #{CONFIG['CC_WRAPPER']}
CC = #{CONFIG['CC']}
CXX = #{CONFIG['CXX']}
LIBRUBY = #{CONFIG['LIBRUBY']}
LIBRUBY_A = #{CONFIG['LIBRUBY_A']}
LIBRUBYARG_SHARED = #$LIBRUBYARG_SHARED
LIBRUBYARG_STATIC = #$LIBRUBYARG_STATIC
empty =
OUTFLAG = #{OUTFLAG}$(empty)
COUTFLAG = #{COUTFLAG}$(empty)
CSRCFLAG = #{CSRCFLAG}$(empty)
RUBY_EXTCONF_H = #{$extconf_h}
cflags = #{CONFIG['cflags']}
cxxflags = #{CONFIG['cxxflags']}
optflags = #{CONFIG['optflags']}
debugflags = #{CONFIG['debugflags']}
warnflags = #{$warnflags}
cppflags = #{CONFIG['cppflags']}
CCDLFLAGS = #{$static ? '' : CONFIG['CCDLFLAGS']}
CFLAGS = $(CCDLFLAGS) #$CFLAGS $(ARCH_FLAG)
INCFLAGS = -I. #$INCFLAGS
DEFS = #{CONFIG['DEFS']}
CPPFLAGS = #{extconf_h}#{$CPPFLAGS}
CXXFLAGS = $(CCDLFLAGS) #$CXXFLAGS $(ARCH_FLAG)
ldflags = #{$LDFLAGS}
dldflags = #{$DLDFLAGS} #{CONFIG['EXTDLDFLAGS']}
ARCH_FLAG = #{$ARCH_FLAG}
DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG)
LDSHARED = #{CONFIG['LDSHARED']}
LDSHAREDXX = #{config_string('LDSHAREDXX') || '$(LDSHARED)'}
AR = #{CONFIG['AR']}
EXEEXT = #{CONFIG['EXEEXT']}
}
CONFIG.each do |key, val|
mk << "#{key} = #{val}\n" if /^RUBY.*NAME/ =~ key
end
mk << %{
arch = #{CONFIG['arch']}
sitearch = #{CONFIG['sitearch']}
ruby_version = #{RbConfig::CONFIG['ruby_version']}
ruby = #{$ruby.sub(%r[\A#{Regexp.quote(RbConfig::CONFIG['bindir'])}(?=/|\z)]) {'$(bindir)'}}
RUBY = $(ruby#{sep})
BUILTRUBY = #{if defined?($builtruby) && $builtruby
$builtruby
else
File.join('$(bindir)', CONFIG["RUBY_INSTALL_NAME"] + CONFIG['EXEEXT'])
end}
ruby_headers = #{headers.join(' ')}
RM = #{config_string('RM', &possible_command) || '$(RUBY) -run -e rm -- -f'}
RM_RF = #{config_string('RMALL', &possible_command) || '$(RUBY) -run -e rm -- -rf'}
RMDIRS = #{config_string('RMDIRS', &possible_command) || '$(RUBY) -run -e rmdir -- -p'}
MAKEDIRS = #{config_string('MAKEDIRS', &possible_command) || '@$(RUBY) -run -e mkdir -- -p'}
INSTALL = #{config_string('INSTALL', &possible_command) || '@$(RUBY) -run -e install -- -vp'}
INSTALL_PROG = #{config_string('INSTALL_PROG') || '$(INSTALL) -m 0755'}
INSTALL_DATA = #{config_string('INSTALL_DATA') || '$(INSTALL) -m 0644'}
COPY = #{config_string('CP', &possible_command) || '@$(RUBY) -run -e cp -- -v'}
TOUCH = exit >
#### End of system configuration section. ####
preload = #{defined?($preload) && $preload ? $preload.join(' ') : ''}
}
mk
end
def timestamp_file(name, target_prefix = nil)
pat = {}
name = '$(RUBYARCHDIR)' if name == '$(TARGET_SO_DIR)'
install_dirs.each do |n, d|
pat[n] = $` if /\$\(target_prefix\)\z/ =~ d
end
name = name.gsub(/\$\((#{pat.keys.join("|")})\)/) {pat[$1]+target_prefix}
name.sub!(/(\$\((?:site)?arch\))\/*/, '')
arch = $1 || ''
name.chomp!('/')
name = name.gsub(/(\$[({]|[})])|(\/+)|[^-.\w]+/) {$1 ? "" : $2 ? ".-." : "_"}
File.join("$(TIMESTAMP_DIR)", arch, "#{name.sub(/\A(?=.)/, '.')}.time")
end
# :startdoc:
# Creates a stub Makefile.
#
def dummy_makefile(srcdir)
configuration(srcdir) << <<RULES << CLEANINGS
CLEANFILES = #{$cleanfiles.join(' ')}
DISTCLEANFILES = #{$distcleanfiles.join(' ')}
all install static install-so install-rb: Makefile
@$(NULLCMD)
.PHONY: all install static install-so install-rb
.PHONY: clean clean-so clean-static clean-rb
RULES
end
def each_compile_rules # :nodoc:
vpath_splat = /\$\(\*VPATH\*\)/
COMPILE_RULES.each do |rule|
if vpath_splat =~ rule
$VPATH.each do |path|
yield rule.sub(vpath_splat) {path}
end
else
yield rule
end
end
end
# Processes the data contents of the "depend" file. Each line of this file
# is expected to be a file name.
#
# Returns the output of findings, in Makefile format.
#
def depend_rules(depend)
suffixes = []
depout = []
cont = implicit = nil
impconv = proc do
each_compile_rules {|rule| depout << (rule % implicit[0]) << implicit[1]}
implicit = nil
end
ruleconv = proc do |line|
if implicit
if /\A\t/ =~ line
implicit[1] << line
next
else
impconv[]
end
end
if m = /\A\.(\w+)\.(\w+)(?:\s*:)/.match(line)
suffixes << m[1] << m[2]
implicit = [[m[1], m[2]], [m.post_match]]
next
elsif RULE_SUBST and /\A(?!\s*\w+\s*=)[$\w][^#]*:/ =~ line
line.sub!(/\s*\#.*$/, '')
comment = $&
line.gsub!(%r"(\s)(?!\.)([^$(){}+=:\s\\,]+)(?=\s|\z)") {$1 + RULE_SUBST % $2}
line = line.chomp + comment + "\n" if comment
end
depout << line
end
depend.each_line do |line|
line.gsub!(/\.o\b/, ".#{$OBJEXT}")
line.gsub!(/\{\$\(VPATH\)\}/, "") unless $nmake
line.gsub!(/\$\((?:hdr|top)dir\)\/config.h/, $config_h)
if $nmake && /\A\s*\$\(RM|COPY\)/ =~ line
line.gsub!(%r"[-\w\./]{2,}"){$&.tr("/", "\\")}
line.gsub!(/(\$\((?!RM|COPY)[^:)]+)(?=\))/, '\1:/=\\')
end
if /(?:^|[^\\])(?:\\\\)*\\$/ =~ line
(cont ||= []) << line
next
elsif cont
line = (cont << line).join
cont = nil
end
ruleconv.call(line)
end
if cont
ruleconv.call(cont.join)
elsif implicit
impconv.call
end
unless suffixes.empty?
depout.unshift(".SUFFIXES: ." + suffixes.uniq.join(" .") + "\n\n")
end
if $extconf_h
depout.unshift("$(OBJS): $(RUBY_EXTCONF_H)\n\n")
depout.unshift("$(OBJS): $(hdrdir)/ruby/win32.h\n\n") if $mswin or $mingw
end
depout.flatten!
depout
end
# Generates the Makefile for your extension, passing along any options and
# preprocessor constants that you may have generated through other methods.
#
# The +target+ name should correspond the name of the global function name
# defined within your C extension, minus the +Init_+. For example, if your
# C extension is defined as +Init_foo+, then your target would simply be
# "foo".
#
# If any "/" characters are present in the target name, only the last name
# is interpreted as the target name, and the rest are considered toplevel
# directory names, and the generated Makefile will be altered accordingly to
# follow that directory structure.
#
# For example, if you pass "test/foo" as a target name, your extension will
# be installed under the "test" directory. This means that in order to
# load the file within a Ruby program later, that directory structure will
# have to be followed, e.g. <code>require 'test/foo'</code>.
#
# The +srcprefix+ should be used when your source files are not in the same
# directory as your build script. This will not only eliminate the need for
# you to manually copy the source files into the same directory as your
# build script, but it also sets the proper +target_prefix+ in the generated
# Makefile.
#
# Setting the +target_prefix+ will, in turn, install the generated binary in
# a directory under your <code>RbConfig::CONFIG['sitearchdir']</code> that
# mimics your local filesystem when you run <code>make install</code>.
#
# For example, given the following file tree:
#
# ext/
# extconf.rb
# test/
# foo.c
#
# And given the following code:
#
# create_makefile('test/foo', 'test')
#
# That will set the +target_prefix+ in the generated Makefile to "test".
# That, in turn, will create the following file tree when installed via the
# <code>make install</code> command:
#
# /path/to/ruby/sitearchdir/test/foo.so
#
# It is recommended that you use this approach to generate your makefiles,
# instead of copying files around manually, because some third party
# libraries may depend on the +target_prefix+ being set properly.
#
# The +srcprefix+ argument can be used to override the default source
# directory, i.e. the current directory. It is included as part of the
# +VPATH+ and added to the list of +INCFLAGS+.
#
def create_makefile(target, srcprefix = nil)
$target = target
libpath = $DEFLIBPATH|$LIBPATH
message "creating Makefile\n"
MakeMakefile.rm_f "#{CONFTEST}*"
if CONFIG["DLEXT"] == $OBJEXT
for lib in libs = $libs.split(' ')
lib.sub!(/-l(.*)/, %%"lib\\1.#{$LIBEXT}"%)
end
$defs.push(format("-DEXTLIB='%s'", libs.join(",")))
end
if target.include?('/')
target_prefix, target = File.split(target)
target_prefix[0,0] = '/'
else
target_prefix = ""
end
srcprefix ||= "$(srcdir)/#{srcprefix}".chomp('/')
RbConfig.expand(srcdir = srcprefix.dup)
ext = ".#{$OBJEXT}"
orig_srcs = Dir[File.join(srcdir, "*.{#{SRC_EXT.join(%q{,})}}")]
if not $objs
srcs = $srcs || orig_srcs
$objs = []
objs = srcs.inject(Hash.new {[]}) {|h, f|
h.key?(o = File.basename(f, ".*") << ext) or $objs << o
h[o] <<= f
h
}
unless objs.delete_if {|b, f| f.size == 1}.empty?
dups = objs.map {|b, f|
"#{b[/.*\./]}{#{f.collect {|n| n[/([^.]+)\z/]}.join(',')}}"
}
abort "source files duplication - #{dups.join(", ")}"
end
else
$objs.collect! {|o| File.basename(o, ".*") << ext} unless $OBJEXT == "o"
srcs = $srcs || $objs.collect {|o| o.chomp(ext) << ".c"}
end
$srcs = srcs
hdrs = Dir[File.join(srcdir, "*.{#{HDR_EXT.join(%q{,})}}")]
target = nil if $objs.empty?
if target and EXPORT_PREFIX
if File.exist?(File.join(srcdir, target + '.def'))
deffile = "$(srcdir)/$(TARGET).def"
unless EXPORT_PREFIX.empty?
makedef = %{$(RUBY) -pe "$$_.sub!(/^(?=\\w)/,'#{EXPORT_PREFIX}') unless 1../^EXPORTS$/i" #{deffile}}
end
else
makedef = %{(echo EXPORTS && echo $(TARGET_ENTRY))}
end
if makedef
$cleanfiles << '$(DEFFILE)'
origdef = deffile
deffile = "$(TARGET)-$(arch).def"
end
end
origdef ||= ''
if $extout and $INSTALLFILES
$cleanfiles.concat($INSTALLFILES.collect {|files, dir|File.join(dir, files.delete_prefix('./'))})
$distcleandirs.concat($INSTALLFILES.collect {|files, dir| dir})
end
if $extmk and $static
$defs << "-DRUBY_EXPORT=1"
end
if $extmk and not $extconf_h
create_header
end
libpath = libpathflag(libpath)
dllib = target ? "$(TARGET).#{CONFIG['DLEXT']}" : ""
staticlib = target ? "$(TARGET).#$LIBEXT" : ""
conf = configuration(srcprefix)
conf << "\
libpath = #{($DEFLIBPATH|$LIBPATH).join(" ")}
LIBPATH = #{libpath}
DEFFILE = #{deffile}
CLEANFILES = #{$cleanfiles.join(' ')}
DISTCLEANFILES = #{$distcleanfiles.join(' ')}
DISTCLEANDIRS = #{$distcleandirs.join(' ')}
extout = #{$extout && $extout.quote}
extout_prefix = #{$extout_prefix}
target_prefix = #{target_prefix}
LOCAL_LIBS = #{$LOCAL_LIBS}
LIBS = #{$LIBRUBYARG} #{$libs} #{$LIBS}
ORIG_SRCS = #{orig_srcs.collect(&File.method(:basename)).join(' ')}
SRCS = $(ORIG_SRCS) #{(srcs - orig_srcs).collect(&File.method(:basename)).join(' ')}
OBJS = #{$objs.join(" ")}
HDRS = #{hdrs.map{|h| '$(srcdir)/' + File.basename(h)}.join(' ')}
LOCAL_HDRS = #{$headers.join(' ')}
TARGET = #{target}
TARGET_NAME = #{target && target[/\A\w+/]}
TARGET_ENTRY = #{EXPORT_PREFIX || ''}Init_$(TARGET_NAME)
DLLIB = #{dllib}
EXTSTATIC = #{$static || ""}
STATIC_LIB = #{staticlib unless $static.nil?}
#{!$extout && defined?($installed_list) ? "INSTALLED_LIST = #{$installed_list}\n" : ""}
TIMESTAMP_DIR = #{$extout && $extmk ? '$(extout)/.timestamp' : '.'}
" #"
# TODO: fixme
install_dirs.each {|d| conf << ("%-14s= %s\n" % d) if /^[[:upper:]]/ =~ d[0]}
sodir = $extout ? '$(TARGET_SO_DIR)' : '$(RUBYARCHDIR)'
n = '$(TARGET_SO_DIR)$(TARGET)'
cleanobjs = ["$(OBJS)"]
if $extmk
%w[bc i s].each {|ex| cleanobjs << "$(OBJS:.#{$OBJEXT}=.#{ex})"}
end
if target
config_string('cleanobjs') {|t| cleanobjs << t.gsub(/\$\*/, "$(TARGET)#{deffile ? '-$(arch)': ''}")}
end
conf << "\
TARGET_SO_DIR =#{$extout ? " $(RUBYARCHDIR)/" : ''}
TARGET_SO = $(TARGET_SO_DIR)$(DLLIB)
CLEANLIBS = #{'$(TARGET_SO) ' if target}#{config_string('cleanlibs') {|t| t.gsub(/\$\*/) {n}}}
CLEANOBJS = #{cleanobjs.join(' ')} *.bak
TARGET_SO_DIR_TIMESTAMP = #{timestamp_file(sodir, target_prefix)}
" #"
conf = yield(conf) if block_given?
mfile = File.open("Makefile", "wb")
mfile.puts(conf)
mfile.print "
all: #{$extout ? "install" : target ? "$(DLLIB)" : "Makefile"}
static: #{$extmk && !$static ? "all" : "$(STATIC_LIB)#{$extout ? " install-rb" : ""}"}
.PHONY: all install static install-so install-rb
.PHONY: clean clean-so clean-static clean-rb
" #"
mfile.print CLEANINGS
fsep = config_string('BUILD_FILE_SEPARATOR') {|s| s unless s == "/"}
if fsep
sep = ":/=#{fsep}"
fseprepl = proc {|s|
s = s.gsub("/", fsep)
s = s.gsub(/(\$\(\w+)(\))/) {$1+sep+$2}
s.gsub(/(\$\{\w+)(\})/) {$1+sep+$2}
}
rsep = ":#{fsep}=/"
else
fseprepl = proc {|s| s}
sep = ""
rsep = ""
end
dirs = []
mfile.print "install: install-so install-rb\n\n"
dir = sodir.dup
mfile.print("install-so: ")
if target
f = "$(DLLIB)"
dest = "$(TARGET_SO)"
stamp = '$(TARGET_SO_DIR_TIMESTAMP)'
if $extout
mfile.puts dest
mfile.print "clean-so::\n"
mfile.print "\t-$(Q)$(RM) #{fseprepl[dest]} #{fseprepl[stamp]}\n"
mfile.print "\t-$(Q)$(RMDIRS) #{fseprepl[dir]}#{$ignore_error}\n"
else
mfile.print "#{f} #{stamp}\n"
mfile.print "\t$(INSTALL_PROG) #{fseprepl[f]} #{dir}\n"
if defined?($installed_list)
mfile.print "\t@echo #{dir}/#{File.basename(f)}>>$(INSTALLED_LIST)\n"
end
end
mfile.print "clean-static::\n"
mfile.print "\t-$(Q)$(RM) $(STATIC_LIB)\n"
else
mfile.puts "Makefile"
end
mfile.print("install-rb: pre-install-rb do-install-rb install-rb-default\n")
mfile.print("install-rb-default: pre-install-rb-default do-install-rb-default\n")
mfile.print("pre-install-rb: Makefile\n")
mfile.print("pre-install-rb-default: Makefile\n")
mfile.print("do-install-rb:\n")
mfile.print("do-install-rb-default:\n")
for sfx, i in [["-default", [["lib/**/*.rb", "$(RUBYLIBDIR)", "lib"]]], ["", $INSTALLFILES]]
files = install_files(mfile, i, nil, srcprefix) or next
for dir, *files in files
unless dirs.include?(dir)
dirs << dir
mfile.print "pre-install-rb#{sfx}: #{timestamp_file(dir, target_prefix)}\n"
end
for f in files
dest = "#{dir}/#{File.basename(f)}"
mfile.print("do-install-rb#{sfx}: #{dest}\n")
mfile.print("#{dest}: #{f} #{timestamp_file(dir, target_prefix)}\n")
mfile.print("\t$(Q) $(#{$extout ? 'COPY' : 'INSTALL_DATA'}) #{f} $(@D)\n")
if defined?($installed_list) and !$extout
mfile.print("\t@echo #{dest}>>$(INSTALLED_LIST)\n")
end
if $extout
mfile.print("clean-rb#{sfx}::\n")
mfile.print("\t-$(Q)$(RM) #{fseprepl[dest]}\n")
end
end
end
mfile.print "pre-install-rb#{sfx}:\n"
if files.empty?
mfile.print("\t@$(NULLCMD)\n")
else
q = "$(MAKE) -q do-install-rb#{sfx}"
if $nmake
mfile.print "!if \"$(Q)\" == \"@\"\n\t@#{q} || \\\n!endif\n\t"
else
mfile.print "\t$(Q1:0=@#{q} || )"
end
mfile.print "$(ECHO1:0=echo) installing#{sfx.sub(/^-/, " ")} #{target} libraries\n"
end
if $extout
dirs.uniq!
unless dirs.empty?
mfile.print("clean-rb#{sfx}::\n")
for dir in dirs.sort_by {|d| -d.count('/')}
stamp = timestamp_file(dir, target_prefix)
mfile.print("\t-$(Q)$(RM) #{fseprepl[stamp]}\n")
mfile.print("\t-$(Q)$(RMDIRS) #{fseprepl[dir]}#{$ignore_error}\n")
end
end
end
end
if target and !dirs.include?(sodir)
mfile.print "$(TARGET_SO_DIR_TIMESTAMP):\n\t$(Q) $(MAKEDIRS) $(@D) #{sodir}\n\t$(Q) $(TOUCH) $@\n"
end
dirs.each do |d|
t = timestamp_file(d, target_prefix)
mfile.print "#{t}:\n\t$(Q) $(MAKEDIRS) $(@D) #{d}\n\t$(Q) $(TOUCH) $@\n"
end
mfile.print <<-SITEINSTALL
site-install: site-install-so site-install-rb
site-install-so: install-so
site-install-rb: install-rb
SITEINSTALL
return unless target
mfile.print ".SUFFIXES: .#{(SRC_EXT + [$OBJEXT, $ASMEXT]).compact.join(' .')}\n"
mfile.print "\n"
compile_command = "\n\t$(ECHO) compiling $(<#{rsep})\n\t$(Q) %s\n\n"
command = compile_command % COMPILE_CXX
asm_command = compile_command.sub(/compiling/, 'translating') % ASSEMBLE_CXX
CXX_EXT.each do |e|
each_compile_rules do |rule|
mfile.printf(rule, e, $OBJEXT)
mfile.print(command)
mfile.printf(rule, e, $ASMEXT)
mfile.print(asm_command)
end
end
command = compile_command % COMPILE_C
asm_command = compile_command.sub(/compiling/, 'translating') % ASSEMBLE_C
C_EXT.each do |e|
each_compile_rules do |rule|
mfile.printf(rule, e, $OBJEXT)
mfile.print(command)
mfile.printf(rule, e, $ASMEXT)
mfile.print(asm_command)
end
end
mfile.print "$(TARGET_SO): "
mfile.print "$(DEFFILE) " if makedef
mfile.print "$(OBJS) Makefile"
mfile.print " $(TARGET_SO_DIR_TIMESTAMP)" if $extout
mfile.print "\n"
mfile.print "\t$(ECHO) linking shared-object #{target_prefix.sub(/\A\/(.*)/, '\1/')}$(DLLIB)\n"
mfile.print "\t-$(Q)$(RM) $(@#{sep})\n"
link_so = LINK_SO.gsub(/^/, "\t$(Q) ")
if srcs.any?(&%r"\.(?:#{CXX_EXT.join('|')})\z".method(:===))
link_so = link_so.sub(/\bLDSHARED\b/, '\&XX')
end
mfile.print link_so, "\n\n"
unless $static.nil?
mfile.print "$(STATIC_LIB): $(OBJS)\n\t-$(Q)$(RM) $(@#{sep})\n\t"
mfile.print "$(ECHO) linking static-library $(@#{rsep})\n\t$(Q) "
mfile.print "$(AR) #{config_string('ARFLAGS') || 'cru '}$@ $(OBJS)"
config_string('RANLIB') do |ranlib|
mfile.print "\n\t-$(Q)#{ranlib} $(@)#{$ignore_error}"
end
end
mfile.print "\n\n"
if makedef
mfile.print "$(DEFFILE): #{origdef}\n"
mfile.print "\t$(ECHO) generating $(@#{rsep})\n"
mfile.print "\t$(Q) #{makedef} > $@\n\n"
end
depend = File.join(srcdir, "depend")
if File.exist?(depend)
mfile.print("###\n", *depend_rules(File.read(depend)))
else
mfile.print "$(OBJS): $(HDRS) $(ruby_headers)\n"
end
$makefile_created = true
ensure
mfile.close if mfile
end
# :stopdoc:
def init_mkmf(config = CONFIG, rbconfig = RbConfig::CONFIG)
$makefile_created = false
$arg_config = []
$enable_shared = config['ENABLE_SHARED'] == 'yes'
$defs = []
$extconf_h = nil
$config_dirs = {}
if $warnflags = CONFIG['warnflags'] and CONFIG['GCC'] == 'yes'
# turn warnings into errors only for bundled extensions.
config['warnflags'] = $warnflags.gsub(/(?:\A|\s)-W\Kerror[-=](?!implicit-function-declaration)/, '')
if /icc\z/ =~ config['CC']
config['warnflags'].gsub!(/(\A|\s)-W(?:division-by-zero|deprecated-declarations)/, '\1')
end
RbConfig.expand(rbconfig['warnflags'] = config['warnflags'].dup)
config.each do |key, val|
RbConfig.expand(rbconfig[key] = val.dup) if /warnflags/ =~ val
end
$warnflags = config['warnflags'] unless $extmk
end
if (w = rbconfig['CC_WRAPPER']) and !w.empty? and !File.executable?(w)
rbconfig['CC_WRAPPER'] = config['CC_WRAPPER'] = ''
end
$CFLAGS = with_config("cflags", arg_config("CFLAGS", config["CFLAGS"])).dup
$CXXFLAGS = (with_config("cxxflags", arg_config("CXXFLAGS", config["CXXFLAGS"]))||'').dup
$ARCH_FLAG = with_config("arch_flag", arg_config("ARCH_FLAG", config["ARCH_FLAG"])).dup
$CPPFLAGS = with_config("cppflags", arg_config("CPPFLAGS", config["CPPFLAGS"])).dup
$LDFLAGS = with_config("ldflags", arg_config("LDFLAGS", config["LDFLAGS"])).dup
$INCFLAGS = "-I$(arch_hdrdir)"
$INCFLAGS << " -I$(hdrdir)/ruby/backward" unless $extmk
$INCFLAGS << " -I$(hdrdir) -I$(srcdir)"
$DLDFLAGS = with_config("dldflags", arg_config("DLDFLAGS", config["DLDFLAGS"])).dup
config_string("ADDITIONAL_DLDFLAGS") {|flags| $DLDFLAGS << " " << flags} unless $extmk
$LIBEXT = config['LIBEXT'].dup
$OBJEXT = config["OBJEXT"].dup
$EXEEXT = config["EXEEXT"].dup
$ASMEXT = config_string('ASMEXT', &:dup) || 'S'
$LIBS = "#{config['LIBS']} #{config['DLDLIBS']}"
$LIBRUBYARG = ""
$LIBRUBYARG_STATIC = config['LIBRUBYARG_STATIC']
$LIBRUBYARG_SHARED = config['LIBRUBYARG_SHARED']
$DEFLIBPATH = [$extmk ? "$(topdir)" : "$(#{config["libdirname"] || "libdir"})"]
$DEFLIBPATH.unshift(".")
$LIBPATH = []
$INSTALLFILES = []
$NONINSTALLFILES = [/~\z/, /\A#.*#\z/, /\A\.#/, /\.bak\z/i, /\.orig\z/, /\.rej\z/, /\.l[ao]\z/, /\.o\z/]
$VPATH = %w[$(srcdir) $(arch_hdrdir)/ruby $(hdrdir)/ruby]
$objs = nil
$srcs = nil
$headers = []
$libs = ""
if $enable_shared or RbConfig.expand(config["LIBRUBY"].dup) != RbConfig.expand(config["LIBRUBY_A"].dup)
$LIBRUBYARG = config['LIBRUBYARG']
end
$LOCAL_LIBS = ""
$cleanfiles = config_string('CLEANFILES') {|s| Shellwords.shellwords(s)} || []
$cleanfiles << "mkmf.log"
$distcleanfiles = config_string('DISTCLEANFILES') {|s| Shellwords.shellwords(s)} || []
$distcleandirs = config_string('DISTCLEANDIRS') {|s| Shellwords.shellwords(s)} || []
$extout ||= nil
$extout_prefix ||= nil
$arg_config.clear
$config_dirs.clear
dir_config("opt")
end
FailedMessage = <<MESSAGE
Could not create Makefile due to some reason, probably lack of necessary
libraries and/or headers. Check the mkmf.log file for more details. You may
need configuration options.
Provided configuration options:
MESSAGE
# Returns whether or not the Makefile was successfully generated. If not,
# the script will abort with an error message.
#
# Internal use only.
#
def mkmf_failed(path)
unless $makefile_created or File.exist?("Makefile")
opts = $arg_config.collect {|t, n| "\t#{t}#{n ? "=#{n}" : ""}\n"}
abort "*** #{path} failed ***\n" + FailedMessage + opts.join
end
end
private
def _libdir_basename
@libdir_basename ||= config_string("libdir") {|name| name[/\A\$\(exec_prefix\)\/(.*)/, 1]} || "lib"
end
def MAIN_DOES_NOTHING(*refs)
src = MAIN_DOES_NOTHING
unless refs.empty?
src = src.sub(/\{/) do
$& +
"\n if (argc > 1000000) {\n" +
refs.map {|n|" int (* volatile #{n}p)(void)=(int (*)(void))&#{n};\n"}.join("") +
refs.map {|n|" printf(\"%d\", (*#{n}p)());\n"}.join("") +
" }\n"
end
end
src
end
extend self
init_mkmf
$make = with_config("make-prog", ENV["MAKE"] || "make")
make, = Shellwords.shellwords($make)
$nmake = nil
case
when $mswin
$nmake = ?m if /nmake/i =~ make
end
$ignore_error = " 2> #{File::NULL} || #{$mswin ? 'exit /b0' : 'true'}"
RbConfig::CONFIG["srcdir"] = CONFIG["srcdir"] =
$srcdir = arg_config("--srcdir", File.dirname($0))
$configure_args["--topsrcdir"] ||= $srcdir
if $curdir = arg_config("--curdir")
RbConfig.expand(curdir = $curdir.dup)
else
curdir = $curdir = "."
end
unless File.expand_path(RbConfig::CONFIG["topdir"]) == File.expand_path(curdir)
CONFIG["topdir"] = $curdir
RbConfig::CONFIG["topdir"] = curdir
end
$configure_args["--topdir"] ||= $curdir
$ruby = arg_config("--ruby", File.join(RbConfig::CONFIG["bindir"], CONFIG["ruby_install_name"]))
RbConfig.expand(CONFIG["RUBY_SO_NAME"])
# :startdoc:
split = Shellwords.method(:shellwords).to_proc
EXPORT_PREFIX = config_string('EXPORT_PREFIX') {|s| s.strip}
hdr = ['#include "ruby.h"' "\n"]
config_string('COMMON_MACROS') do |s|
Shellwords.shellwords(s).each do |w|
w, v = w.split(/=/, 2)
hdr << "#ifndef #{w}"
hdr << "#define #{[w, v].compact.join(" ")}"
hdr << "#endif /* #{w} */"
end
end
config_string('COMMON_HEADERS') do |s|
Shellwords.shellwords(s).each {|w| hdr << "#include <#{w}>"}
end
##
# Common headers for Ruby C extensions
COMMON_HEADERS = hdr.join("\n")
##
# Common libraries for Ruby C extensions
COMMON_LIBS = config_string('COMMON_LIBS', &split) || []
##
# make compile rules
COMPILE_RULES = config_string('COMPILE_RULES', &split) || %w[.%s.%s:]
RULE_SUBST = config_string('RULE_SUBST')
##
# Command which will compile C files in the generated Makefile
COMPILE_C = config_string('COMPILE_C') || '$(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<'
##
# Command which will compile C++ files in the generated Makefile
COMPILE_CXX = config_string('COMPILE_CXX') || '$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<'
##
# Command which will translate C files to assembler sources in the generated Makefile
ASSEMBLE_C = config_string('ASSEMBLE_C') || COMPILE_C.sub(/(?<=\s)-c(?=\s)/, '-S')
##
# Command which will translate C++ files to assembler sources in the generated Makefile
ASSEMBLE_CXX = config_string('ASSEMBLE_CXX') || COMPILE_CXX.sub(/(?<=\s)-c(?=\s)/, '-S')
##
# Command which will compile a program in order to test linking a library
TRY_LINK = config_string('TRY_LINK') ||
"$(CC) #{OUTFLAG}#{CONFTEST}#{$EXEEXT} $(INCFLAGS) $(CPPFLAGS) " \
"$(CFLAGS) $(src) $(LIBPATH) $(LDFLAGS) $(ARCH_FLAG) $(LOCAL_LIBS) $(LIBS)"
##
# Command which will link a shared library
LINK_SO = (config_string('LINK_SO') || "").sub(/^$/) do
if CONFIG["DLEXT"] == $OBJEXT
"ld $(DLDFLAGS) -r -o $@ $(OBJS)\n"
else
"$(LDSHARED) #{OUTFLAG}$@ $(OBJS) " \
"$(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)"
end
end
##
# Argument which will add a library path to the linker
LIBPATHFLAG = config_string('LIBPATHFLAG') || ' -L%s'
RPATHFLAG = config_string('RPATHFLAG') || ''
##
# Argument which will add a library to the linker
LIBARG = config_string('LIBARG') || '-l%s'
##
# A C main function which does no work
MAIN_DOES_NOTHING = config_string('MAIN_DOES_NOTHING') || "int main(int argc, char **argv)\n{\n return !!argv[argc];\n}"
UNIVERSAL_INTS = config_string('UNIVERSAL_INTS') {|s| Shellwords.shellwords(s)} ||
%w[int short long long\ long]
sep = config_string('BUILD_FILE_SEPARATOR') {|s| ":/=#{s}" if s != "/"} || ""
##
# Makefile rules that will clean the extension build directory
CLEANINGS = "
clean-static::
clean-rb-default::
clean-rb::
clean-so::
clean: clean-so clean-static clean-rb-default clean-rb
\t\t-$(Q)$(RM_RF) $(CLEANLIBS#{sep}) $(CLEANOBJS#{sep}) $(CLEANFILES#{sep}) .*.time
distclean-rb-default::
distclean-rb::
distclean-so::
distclean-static::
distclean: clean distclean-so distclean-static distclean-rb-default distclean-rb
\t\t-$(Q)$(RM) Makefile $(RUBY_EXTCONF_H) #{CONFTEST}.* mkmf.log#{' exts.mk' if $extmk}
\t\t-$(Q)$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES#{sep})
\t\t-$(Q)$(RMDIRS) $(DISTCLEANDIRS#{sep})#{$ignore_error}
realclean: distclean
"
@lang = Hash.new(self)
def self.[](name)
@lang.fetch(name)
end
def self.[]=(name, mod)
@lang[name] = mod
end
self["C++"] = Module.new do
include MakeMakefile
extend self
CONFTEST_CXX = "#{CONFTEST}.#{config_string('CXX_EXT') || CXX_EXT[0]}"
TRY_LINK_CXX = config_string('TRY_LINK_CXX') ||
((cmd = TRY_LINK.gsub(/\$\(C(?:C|(FLAGS))\)/, '$(CXX\1)')) != TRY_LINK && cmd) ||
"$(CXX) #{OUTFLAG}#{CONFTEST}#{$EXEEXT} $(INCFLAGS) $(CPPFLAGS) " \
"$(CXXFLAGS) $(src) $(LIBPATH) $(LDFLAGS) $(ARCH_FLAG) $(LOCAL_LIBS) $(LIBS)"
def have_devel?
unless defined? @have_devel
@have_devel = true
@have_devel = try_link(MAIN_DOES_NOTHING)
end
@have_devel
end
def conftest_source
CONFTEST_CXX
end
def cc_command(opt="")
conf = cc_config(opt)
RbConfig::expand("$(CXX) #$INCFLAGS #$CPPFLAGS #$CXXFLAGS #$ARCH_FLAG #{opt} -c #{CONFTEST_CXX}",
conf)
end
def link_command(ldflags, *opts)
conf = link_config(ldflags, *opts)
RbConfig::expand(TRY_LINK_CXX.dup, conf)
end
end
end
# MakeMakefile::Global = #
m = Module.new {
include(MakeMakefile)
private(*MakeMakefile.public_instance_methods(false))
}
include m
if not $extmk and /\A(extconf|makefile).rb\z/ =~ File.basename($0)
END {mkmf_failed($0)}
end
share/ruby/yaml/dbm.rb 0000644 00000015451 15173517737 0010706 0 ustar 00 # frozen_string_literal: false
require 'yaml'
require 'dbm'
module YAML
# YAML + DBM = YDBM
#
# YAML::DBM provides the same interface as ::DBM.
#
# However, while DBM only allows strings for both keys and values,
# this library allows one to use most Ruby objects for values
# by first converting them to YAML. Keys must be strings.
#
# Conversion to and from YAML is performed automatically.
#
# See the documentation for ::DBM and ::YAML for more information.
class DBM < ::DBM
VERSION = "0.1" # :nodoc:
# :call-seq:
# ydbm[key] -> value
#
# Return value associated with +key+ from database.
#
# Returns +nil+ if there is no such +key+.
#
# See #fetch for more information.
def []( key )
fetch( key )
end
# :call-seq:
# ydbm[key] = value
#
# Set +key+ to +value+ in database.
#
# +value+ will be converted to YAML before storage.
#
# See #store for more information.
def []=( key, val )
store( key, val )
end
# :call-seq:
# ydbm.fetch( key, ifnone = nil )
# ydbm.fetch( key ) { |key| ... }
#
# Return value associated with +key+.
#
# If there is no value for +key+ and no block is given, returns +ifnone+.
#
# Otherwise, calls block passing in the given +key+.
#
# See ::DBM#fetch for more information.
def fetch( keystr, ifnone = nil )
begin
val = super( keystr )
return YAML.load( val ) if String === val
rescue IndexError
end
if block_given?
yield keystr
else
ifnone
end
end
# Deprecated, used YAML::DBM#key instead.
# ----
# Note:
# YAML::DBM#index makes warning from internal of ::DBM#index.
# It says 'DBM#index is deprecated; use DBM#key', but DBM#key
# behaves not same as DBM#index.
#
def index( keystr )
super( keystr.to_yaml )
end
# :call-seq:
# ydbm.key(value) -> string
#
# Returns the key for the specified value.
def key( keystr )
invert[keystr]
end
# :call-seq:
# ydbm.values_at(*keys)
#
# Returns an array containing the values associated with the given keys.
def values_at( *keys )
keys.collect { |k| fetch( k ) }
end
# :call-seq:
# ydbm.delete(key)
#
# Deletes value from database associated with +key+.
#
# Returns value or +nil+.
def delete( key )
v = super( key )
if String === v
v = YAML.load( v )
end
v
end
# :call-seq:
# ydbm.delete_if { |key, value| ... }
#
# Calls the given block once for each +key+, +value+ pair in the database.
# Deletes all entries for which the block returns true.
#
# Returns +self+.
def delete_if # :yields: [key, value]
del_keys = keys.dup
del_keys.delete_if { |k| yield( k, fetch( k ) ) == false }
del_keys.each { |k| delete( k ) }
self
end
# :call-seq:
# ydbm.reject { |key, value| ... }
#
# Converts the contents of the database to an in-memory Hash, then calls
# Hash#reject with the specified code block, returning a new Hash.
def reject
hsh = self.to_hash
hsh.reject { |k,v| yield k, v }
end
# :call-seq:
# ydbm.each_pair { |key, value| ... }
#
# Calls the given block once for each +key+, +value+ pair in the database.
#
# Returns +self+.
def each_pair # :yields: [key, value]
keys.each { |k| yield k, fetch( k ) }
self
end
# :call-seq:
# ydbm.each_value { |value| ... }
#
# Calls the given block for each value in database.
#
# Returns +self+.
def each_value # :yields: value
super { |v| yield YAML.load( v ) }
self
end
# :call-seq:
# ydbm.values
#
# Returns an array of values from the database.
def values
super.collect { |v| YAML.load( v ) }
end
# :call-seq:
# ydbm.has_value?(value)
#
# Returns true if specified +value+ is found in the database.
def has_value?( val )
each_value { |v| return true if v == val }
return false
end
# :call-seq:
# ydbm.invert -> hash
#
# Returns a Hash (not a DBM database) created by using each value in the
# database as a key, with the corresponding key as its value.
#
# Note that all values in the hash will be Strings, but the keys will be
# actual objects.
def invert
h = {}
keys.each { |k| h[ self.fetch( k ) ] = k }
h
end
# :call-seq:
# ydbm.replace(hash) -> ydbm
#
# Replaces the contents of the database with the contents of the specified
# object. Takes any object which implements the each_pair method, including
# Hash and DBM objects.
def replace( hsh )
clear
update( hsh )
end
# :call-seq:
# ydbm.shift -> [key, value]
#
# Removes a [key, value] pair from the database, and returns it.
# If the database is empty, returns +nil+.
#
# The order in which values are removed/returned is not guaranteed.
def shift
a = super
a[1] = YAML.load( a[1] ) if a
a
end
# :call-seq:
# ydbm.select { |key, value| ... }
# ydbm.select(*keys)
#
# If a block is provided, returns a new array containing [key, value] pairs
# for which the block returns true.
#
# Otherwise, same as #values_at
def select( *keys )
if block_given?
self.keys.collect { |k| v = self[k]; [k, v] if yield k, v }.compact
else
values_at( *keys )
end
end
# :call-seq:
# ydbm.store(key, value) -> value
#
# Stores +value+ in database with +key+ as the index. +value+ is converted
# to YAML before being stored.
#
# Returns +value+
def store( key, val )
super( key, val.to_yaml )
val
end
# :call-seq:
# ydbm.update(hash) -> ydbm
#
# Updates the database with multiple values from the specified object.
# Takes any object which implements the each_pair method, including
# Hash and DBM objects.
#
# Returns +self+.
def update( hsh )
hsh.each_pair do |k,v|
self.store( k, v )
end
self
end
# :call-seq:
# ydbm.to_a -> array
#
# Converts the contents of the database to an array of [key, value] arrays,
# and returns it.
def to_a
a = []
keys.each { |k| a.push [ k, self.fetch( k ) ] }
a
end
# :call-seq:
# ydbm.to_hash -> hash
#
# Converts the contents of the database to an in-memory Hash object, and
# returns it.
def to_hash
h = {}
keys.each { |k| h[ k ] = self.fetch( k ) }
h
end
alias :each :each_pair
end
end
share/ruby/yaml/store.rb 0000644 00000003611 15173517737 0011273 0 ustar 00 # frozen_string_literal: false
#
# YAML::Store
#
require 'yaml'
require 'pstore'
# YAML::Store provides the same functionality as PStore, except it uses YAML
# to dump objects instead of Marshal.
#
# == Example
#
# require 'yaml/store'
#
# Person = Struct.new :first_name, :last_name
#
# people = [Person.new("Bob", "Smith"), Person.new("Mary", "Johnson")]
#
# store = YAML::Store.new "test.store"
#
# store.transaction do
# store["people"] = people
# store["greeting"] = { "hello" => "world" }
# end
#
# After running the above code, the contents of "test.store" will be:
#
# ---
# people:
# - !ruby/struct:Person
# first_name: Bob
# last_name: Smith
# - !ruby/struct:Person
# first_name: Mary
# last_name: Johnson
# greeting:
# hello: world
class YAML::Store < PStore
# :call-seq:
# initialize( file_name, yaml_opts = {} )
# initialize( file_name, thread_safe = false, yaml_opts = {} )
#
# Creates a new YAML::Store object, which will store data in +file_name+.
# If the file does not already exist, it will be created.
#
# YAML::Store objects are always reentrant. But if _thread_safe_ is set to true,
# then it will become thread-safe at the cost of a minor performance hit.
#
# Options passed in through +yaml_opts+ will be used when converting the
# store to YAML via Hash#to_yaml().
def initialize( *o )
@opt = {}
if o.last.is_a? Hash
@opt.update(o.pop)
end
super(*o)
end
# :stopdoc:
def dump(table)
table.to_yaml(@opt)
end
def load(content)
table = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(content) : YAML.load(content)
if table == false
{}
else
table
end
end
def marshal_dump_supports_canonical_option?
false
end
def empty_marshal_data
{}.to_yaml(@opt)
end
def empty_marshal_checksum
CHECKSUM_ALGO.digest(empty_marshal_data)
end
end
share/ruby/fiddle/struct.rb 0000644 00000034320 15173517737 0011751 0 ustar 00 # frozen_string_literal: true
require 'fiddle'
require 'fiddle/value'
require 'fiddle/pack'
module Fiddle
# A base class for objects representing a C structure
class CStruct
include Enumerable
# accessor to Fiddle::CStructEntity
def CStruct.entity_class
CStructEntity
end
def self.offsetof(name, members, types) # :nodoc:
offset = 0
worklist = name.split('.')
this_type = self
while search_name = worklist.shift
index = 0
member_index = members.index(search_name)
unless member_index
# Possibly a sub-structure
member_index = members.index { |member_name, _|
member_name == search_name
}
return unless member_index
end
types.each { |type, count = 1|
orig_offset = offset
if type.respond_to?(:entity_class)
align = type.alignment
type_size = type.size
else
align = PackInfo::ALIGN_MAP[type]
type_size = PackInfo::SIZE_MAP[type]
end
# Unions shouldn't advance the offset
if this_type.entity_class == CUnionEntity
type_size = 0
end
offset = PackInfo.align(orig_offset, align)
if worklist.empty?
return offset if index == member_index
else
if index == member_index
subtype = types[member_index]
members = subtype.members
types = subtype.types
this_type = subtype
break
end
end
offset += (type_size * count)
index += 1
}
end
nil
end
def each
return enum_for(__function__) unless block_given?
self.class.members.each do |name,|
yield(self[name])
end
end
def each_pair
return enum_for(__function__) unless block_given?
self.class.members.each do |name,|
yield(name, self[name])
end
end
def to_h
hash = {}
each_pair do |name, value|
hash[name] = unstruct(value)
end
hash
end
def replace(another)
if another.nil?
self.class.members.each do |name,|
self[name] = nil
end
elsif another.respond_to?(:each_pair)
another.each_pair do |name, value|
self[name] = value
end
else
another.each do |name, value|
self[name] = value
end
end
self
end
private
def unstruct(value)
case value
when CStruct
value.to_h
when Array
value.collect do |v|
unstruct(v)
end
else
value
end
end
end
# A base class for objects representing a C union
class CUnion
# accessor to Fiddle::CUnionEntity
def CUnion.entity_class
CUnionEntity
end
def self.offsetof(name, members, types) # :nodoc:
0
end
end
# Wrapper for arrays within a struct
class StructArray < Array
include ValueUtil
def initialize(ptr, type, initial_values)
@ptr = ptr
@type = type
@is_struct = @type.respond_to?(:entity_class)
if @is_struct
super(initial_values)
else
@size = Fiddle::PackInfo::SIZE_MAP[type]
@pack_format = Fiddle::PackInfo::PACK_MAP[type]
super(initial_values.collect { |v| unsigned_value(v, type) })
end
end
def to_ptr
@ptr
end
def []=(index, value)
if index < 0 || index >= size
raise IndexError, 'index %d outside of array bounds 0...%d' % [index, size]
end
if @is_struct
self[index].replace(value)
else
to_ptr[index * @size, @size] = [value].pack(@pack_format)
super(index, value)
end
end
end
# Used to construct C classes (CUnion, CStruct, etc)
#
# Fiddle::Importer#struct and Fiddle::Importer#union wrap this functionality in an
# easy-to-use manner.
module CStructBuilder
# Construct a new class given a C:
# * class +klass+ (CUnion, CStruct, or other that provide an
# #entity_class)
# * +types+ (Fiddle::TYPE_INT, Fiddle::TYPE_SIZE_T, etc., see the C types
# constants)
# * corresponding +members+
#
# Fiddle::Importer#struct and Fiddle::Importer#union wrap this functionality in an
# easy-to-use manner.
#
# Examples:
#
# require 'fiddle/struct'
# require 'fiddle/cparser'
#
# include Fiddle::CParser
#
# types, members = parse_struct_signature(['int i','char c'])
#
# MyStruct = Fiddle::CStructBuilder.create(Fiddle::CUnion, types, members)
#
# MyStruct.malloc(Fiddle::RUBY_FREE) do |obj|
# ...
# end
#
# obj = MyStruct.malloc(Fiddle::RUBY_FREE)
# begin
# ...
# ensure
# obj.call_free
# end
#
# obj = MyStruct.malloc
# begin
# ...
# ensure
# Fiddle.free obj.to_ptr
# end
#
def create(klass, types, members)
new_class = Class.new(klass){
define_method(:initialize){|addr, func = nil|
if addr.is_a?(self.class.entity_class)
@entity = addr
else
@entity = self.class.entity_class.new(addr, types, func)
end
@entity.assign_names(members)
}
define_method(:[]) { |*args| @entity.send(:[], *args) }
define_method(:[]=) { |*args| @entity.send(:[]=, *args) }
define_method(:to_ptr){ @entity }
define_method(:to_i){ @entity.to_i }
define_singleton_method(:types) { types }
define_singleton_method(:members) { members }
# Return the offset of a struct member given its name.
# For example:
#
# MyStruct = struct [
# "int64_t i",
# "char c",
# ]
#
# MyStruct.offsetof("i") # => 0
# MyStruct.offsetof("c") # => 8
#
define_singleton_method(:offsetof) { |name|
klass.offsetof(name, members, types)
}
members.each{|name|
name = name[0] if name.is_a?(Array) # name is a nested struct
next if method_defined?(name)
define_method(name){ @entity[name] }
define_method(name + "="){|val| @entity[name] = val }
}
entity_class = klass.entity_class
alignment = entity_class.alignment(types)
size = entity_class.size(types)
define_singleton_method(:alignment) { alignment }
define_singleton_method(:size) { size }
define_singleton_method(:malloc) do |func=nil, &block|
if block
entity_class.malloc(types, func, size) do |entity|
block.call(new(entity))
end
else
new(entity_class.malloc(types, func, size))
end
end
}
return new_class
end
module_function :create
end
# A pointer to a C structure
class CStructEntity < Fiddle::Pointer
include PackInfo
include ValueUtil
def CStructEntity.alignment(types)
max = 1
types.each do |type, count = 1|
if type.respond_to?(:entity_class)
n = type.alignment
else
n = ALIGN_MAP[type]
end
max = n if n > max
end
max
end
# Allocates a C struct with the +types+ provided.
#
# See Fiddle::Pointer.malloc for memory management issues.
def CStructEntity.malloc(types, func = nil, size = size(types), &block)
if block_given?
super(size, func) do |struct|
struct.set_ctypes types
yield struct
end
else
struct = super(size, func)
struct.set_ctypes types
struct
end
end
# Returns the offset for the packed sizes for the given +types+.
#
# Fiddle::CStructEntity.size(
# [ Fiddle::TYPE_DOUBLE,
# Fiddle::TYPE_INT,
# Fiddle::TYPE_CHAR,
# Fiddle::TYPE_VOIDP ]) #=> 24
def CStructEntity.size(types)
offset = 0
max_align = types.map { |type, count = 1|
last_offset = offset
if type.respond_to?(:entity_class)
align = type.alignment
type_size = type.size
else
align = PackInfo::ALIGN_MAP[type]
type_size = PackInfo::SIZE_MAP[type]
end
offset = PackInfo.align(last_offset, align) +
(type_size * count)
align
}.max
PackInfo.align(offset, max_align)
end
# Wraps the C pointer +addr+ as a C struct with the given +types+.
#
# When the instance is garbage collected, the C function +func+ is called.
#
# See also Fiddle::Pointer.new
def initialize(addr, types, func = nil)
if func && addr.is_a?(Pointer) && addr.free
raise ArgumentError, 'free function specified on both underlying struct Pointer and when creating a CStructEntity - who do you want to free this?'
end
set_ctypes(types)
super(addr, @size, func)
end
# Set the names of the +members+ in this C struct
def assign_names(members)
@members = []
@nested_structs = {}
members.each_with_index do |member, index|
if member.is_a?(Array) # nested struct
member_name = member[0]
struct_type, struct_count = @ctypes[index]
if struct_count.nil?
struct = struct_type.new(to_i + @offset[index])
else
structs = struct_count.times.map do |i|
struct_type.new(to_i + @offset[index] + i * struct_type.size)
end
struct = StructArray.new(to_i + @offset[index],
struct_type,
structs)
end
@nested_structs[member_name] = struct
else
member_name = member
end
@members << member_name
end
end
# Calculates the offsets and sizes for the given +types+ in the struct.
def set_ctypes(types)
@ctypes = types
@offset = []
offset = 0
max_align = types.map { |type, count = 1|
orig_offset = offset
if type.respond_to?(:entity_class)
align = type.alignment
type_size = type.size
else
align = ALIGN_MAP[type]
type_size = SIZE_MAP[type]
end
offset = PackInfo.align(orig_offset, align)
@offset << offset
offset += (type_size * count)
align
}.max
@size = PackInfo.align(offset, max_align)
end
# Fetch struct member +name+ if only one argument is specified. If two
# arguments are specified, the first is an offset and the second is a
# length and this method returns the string of +length+ bytes beginning at
# +offset+.
#
# Examples:
#
# my_struct = struct(['int id']).malloc
# my_struct.id = 1
# my_struct['id'] # => 1
# my_struct[0, 4] # => "\x01\x00\x00\x00".b
#
def [](*args)
return super(*args) if args.size > 1
name = args[0]
idx = @members.index(name)
if( idx.nil? )
raise(ArgumentError, "no such member: #{name}")
end
ty = @ctypes[idx]
if( ty.is_a?(Array) )
if ty.first.respond_to?(:entity_class)
return @nested_structs[name]
else
r = super(@offset[idx], SIZE_MAP[ty[0]] * ty[1])
end
elsif ty.respond_to?(:entity_class)
return @nested_structs[name]
else
r = super(@offset[idx], SIZE_MAP[ty.abs])
end
packer = Packer.new([ty])
val = packer.unpack([r])
case ty
when Array
case ty[0]
when TYPE_VOIDP
val = val.collect{|v| Pointer.new(v)}
end
when TYPE_VOIDP
val = Pointer.new(val[0])
else
val = val[0]
end
if( ty.is_a?(Integer) && (ty < 0) )
return unsigned_value(val, ty)
elsif( ty.is_a?(Array) && (ty[0] < 0) )
return StructArray.new(self + @offset[idx], ty[0], val)
else
return val
end
end
# Set struct member +name+, to value +val+. If more arguments are
# specified, writes the string of bytes to the memory at the given
# +offset+ and +length+.
#
# Examples:
#
# my_struct = struct(['int id']).malloc
# my_struct['id'] = 1
# my_struct[0, 4] = "\x01\x00\x00\x00".b
# my_struct.id # => 1
#
def []=(*args)
return super(*args) if args.size > 2
name, val = *args
name = name.to_s if name.is_a?(Symbol)
nested_struct = @nested_structs[name]
if nested_struct
if nested_struct.is_a?(StructArray)
if val.nil?
nested_struct.each do |s|
s.replace(nil)
end
else
val.each_with_index do |v, i|
nested_struct[i] = v
end
end
else
nested_struct.replace(val)
end
return val
end
idx = @members.index(name)
if( idx.nil? )
raise(ArgumentError, "no such member: #{name}")
end
ty = @ctypes[idx]
packer = Packer.new([ty])
val = wrap_arg(val, ty, [])
buff = packer.pack([val].flatten())
super(@offset[idx], buff.size, buff)
if( ty.is_a?(Integer) && (ty < 0) )
return unsigned_value(val, ty)
elsif( ty.is_a?(Array) && (ty[0] < 0) )
return val.collect{|v| unsigned_value(v,ty[0])}
else
return val
end
end
undef_method :size=
def to_s() # :nodoc:
super(@size)
end
end
# A pointer to a C union
class CUnionEntity < CStructEntity
include PackInfo
# Returns the size needed for the union with the given +types+.
#
# Fiddle::CUnionEntity.size(
# [ Fiddle::TYPE_DOUBLE,
# Fiddle::TYPE_INT,
# Fiddle::TYPE_CHAR,
# Fiddle::TYPE_VOIDP ]) #=> 8
def CUnionEntity.size(types)
types.map { |type, count = 1|
if type.respond_to?(:entity_class)
type.size * count
else
PackInfo::SIZE_MAP[type] * count
end
}.max
end
# Calculate the necessary offset and for each union member with the given
# +types+
def set_ctypes(types)
@ctypes = types
@offset = Array.new(types.length, 0)
@size = self.class.size types
end
end
end
share/ruby/fiddle/closure.rb 0000644 00000003672 15173517737 0012107 0 ustar 00 # frozen_string_literal: true
module Fiddle
class Closure
class << self
# Create a new closure. If a block is given, the created closure
# is automatically freed after the given block is executed.
#
# The all given arguments are passed to Fiddle::Closure.new. So
# using this method without block equals to Fiddle::Closure.new.
#
# == Example
#
# Fiddle::Closure.create(TYPE_INT, [TYPE_INT]) do |closure|
# # closure is freed automatically when this block is finished.
# end
def create(*args)
if block_given?
closure = new(*args)
begin
yield(closure)
ensure
closure.free
end
else
new(*args)
end
end
end
# the C type of the return of the FFI closure
attr_reader :ctype
# arguments of the FFI closure
attr_reader :args
# Extends Fiddle::Closure to allow for building the closure in a block
class BlockCaller < Fiddle::Closure
# == Description
#
# Construct a new BlockCaller object.
#
# * +ctype+ is the C type to be returned
# * +args+ are passed the callback
# * +abi+ is the abi of the closure
#
# If there is an error in preparing the +ffi_cif+ or +ffi_prep_closure+,
# then a RuntimeError will be raised.
#
# == Example
#
# include Fiddle
#
# cb = Closure::BlockCaller.new(TYPE_INT, [TYPE_INT]) do |one|
# one
# end
#
# func = Function.new(cb, [TYPE_INT], TYPE_INT)
#
def initialize ctype, args, abi = Fiddle::Function::DEFAULT, &block
super(ctype, args, abi)
@block = block
end
# Calls the constructed BlockCaller, with +args+
#
# For an example see Fiddle::Closure::BlockCaller.new
#
def call *args
@block.call(*args)
end
end
end
end
share/ruby/fiddle/function.rb 0000644 00000001033 15173517737 0012245 0 ustar 00 # frozen_string_literal: true
module Fiddle
class Function
# The ABI of the Function.
attr_reader :abi
# The address of this function
attr_reader :ptr
# The name of this function
attr_reader :name
# Whether GVL is needed to call this function
def need_gvl?
@need_gvl
end
# The integer memory location of this function
def to_i
ptr.to_i
end
# Turn this function in to a proc
def to_proc
this = self
lambda { |*args| this.call(*args) }
end
end
end
share/ruby/fiddle/import.rb 0000644 00000021520 15173517737 0011735 0 ustar 00 # frozen_string_literal: true
require 'fiddle'
require 'fiddle/struct'
require 'fiddle/cparser'
module Fiddle
# Used internally by Fiddle::Importer
class CompositeHandler
# Create a new handler with the open +handlers+
#
# Used internally by Fiddle::Importer.dlload
def initialize(handlers)
@handlers = handlers
end
# Array of the currently loaded libraries.
def handlers()
@handlers
end
# Returns the address as an Integer from any handlers with the function
# named +symbol+.
#
# Raises a DLError if the handle is closed.
def sym(symbol)
@handlers.each{|handle|
if( handle )
begin
addr = handle.sym(symbol)
return addr
rescue DLError
end
end
}
return nil
end
# See Fiddle::CompositeHandler.sym
def [](symbol)
sym(symbol)
end
end
# A DSL that provides the means to dynamically load libraries and build
# modules around them including calling extern functions within the C
# library that has been loaded.
#
# == Example
#
# require 'fiddle'
# require 'fiddle/import'
#
# module LibSum
# extend Fiddle::Importer
# dlload './libsum.so'
# extern 'double sum(double*, int)'
# extern 'double split(double)'
# end
#
module Importer
include Fiddle
include CParser
extend Importer
attr_reader :type_alias
private :type_alias
# Creates an array of handlers for the given +libs+, can be an instance of
# Fiddle::Handle, Fiddle::Importer, or will create a new instance of
# Fiddle::Handle using Fiddle.dlopen
#
# Raises a DLError if the library cannot be loaded.
#
# See Fiddle.dlopen
def dlload(*libs)
handles = libs.collect{|lib|
case lib
when nil
nil
when Handle
lib
when Importer
lib.handlers
else
Fiddle.dlopen(lib)
end
}.flatten()
@handler = CompositeHandler.new(handles)
@func_map = {}
@type_alias = {}
end
# Sets the type alias for +alias_type+ as +orig_type+
def typealias(alias_type, orig_type)
@type_alias[alias_type] = orig_type
end
# Returns the sizeof +ty+, using Fiddle::Importer.parse_ctype to determine
# the C type and the appropriate Fiddle constant.
def sizeof(ty)
case ty
when String
ty = parse_ctype(ty, type_alias).abs()
case ty
when TYPE_CHAR
return SIZEOF_CHAR
when TYPE_SHORT
return SIZEOF_SHORT
when TYPE_INT
return SIZEOF_INT
when TYPE_LONG
return SIZEOF_LONG
when TYPE_FLOAT
return SIZEOF_FLOAT
when TYPE_DOUBLE
return SIZEOF_DOUBLE
when TYPE_VOIDP
return SIZEOF_VOIDP
when TYPE_CONST_STRING
return SIZEOF_CONST_STRING
when TYPE_BOOL
return SIZEOF_BOOL
else
if defined?(TYPE_LONG_LONG) and
ty == TYPE_LONG_LONG
return SIZEOF_LONG_LONG
else
raise(DLError, "unknown type: #{ty}")
end
end
when Class
if( ty.instance_methods().include?(:to_ptr) )
return ty.size()
end
end
return Pointer[ty].size()
end
def parse_bind_options(opts)
h = {}
while( opt = opts.shift() )
case opt
when :stdcall, :cdecl
h[:call_type] = opt
when :carried, :temp, :temporal, :bind
h[:callback_type] = opt
h[:carrier] = opts.shift()
else
h[opt] = true
end
end
h
end
private :parse_bind_options
# :stopdoc:
CALL_TYPE_TO_ABI = Hash.new { |h, k|
raise RuntimeError, "unsupported call type: #{k}"
}.merge({ :stdcall => Function.const_defined?(:STDCALL) ? Function::STDCALL :
Function::DEFAULT,
:cdecl => Function::DEFAULT,
nil => Function::DEFAULT
}).freeze
private_constant :CALL_TYPE_TO_ABI
# :startdoc:
# Creates a global method from the given C +signature+.
def extern(signature, *opts)
symname, ctype, argtype = parse_signature(signature, type_alias)
opt = parse_bind_options(opts)
f = import_function(symname, ctype, argtype, opt[:call_type])
name = symname.gsub(/@.+/,'')
@func_map[name] = f
# define_method(name){|*args,&block| f.call(*args,&block)}
begin
/^(.+?):(\d+)/ =~ caller.first
file, line = $1, $2.to_i
rescue
file, line = __FILE__, __LINE__+3
end
module_eval(<<-EOS, file, line)
def #{name}(*args, &block)
@func_map['#{name}'].call(*args,&block)
end
EOS
module_function(name)
f
end
# Creates a global method from the given C +signature+ using the given
# +opts+ as bind parameters with the given block.
def bind(signature, *opts, &blk)
name, ctype, argtype = parse_signature(signature, type_alias)
h = parse_bind_options(opts)
case h[:callback_type]
when :bind, nil
f = bind_function(name, ctype, argtype, h[:call_type], &blk)
else
raise(RuntimeError, "unknown callback type: #{h[:callback_type]}")
end
@func_map[name] = f
#define_method(name){|*args,&block| f.call(*args,&block)}
begin
/^(.+?):(\d+)/ =~ caller.first
file, line = $1, $2.to_i
rescue
file, line = __FILE__, __LINE__+3
end
module_eval(<<-EOS, file, line)
def #{name}(*args,&block)
@func_map['#{name}'].call(*args,&block)
end
EOS
module_function(name)
f
end
# Creates a class to wrap the C struct described by +signature+.
#
# MyStruct = struct ['int i', 'char c']
def struct(signature)
tys, mems = parse_struct_signature(signature, type_alias)
Fiddle::CStructBuilder.create(CStruct, tys, mems)
end
# Creates a class to wrap the C union described by +signature+.
#
# MyUnion = union ['int i', 'char c']
def union(signature)
tys, mems = parse_struct_signature(signature, type_alias)
Fiddle::CStructBuilder.create(CUnion, tys, mems)
end
# Returns the function mapped to +name+, that was created by either
# Fiddle::Importer.extern or Fiddle::Importer.bind
def [](name)
@func_map[name]
end
# Creates a class to wrap the C struct with the value +ty+
#
# See also Fiddle::Importer.struct
def create_value(ty, val=nil)
s = struct([ty + " value"])
ptr = s.malloc()
if( val )
ptr.value = val
end
return ptr
end
alias value create_value
# Returns a new instance of the C struct with the value +ty+ at the +addr+
# address.
def import_value(ty, addr)
s = struct([ty + " value"])
ptr = s.new(addr)
return ptr
end
# The Fiddle::CompositeHandler instance
#
# Will raise an error if no handlers are open.
def handler
(@handler ||= nil) or raise "call dlload before importing symbols and functions"
end
# Returns a new Fiddle::Pointer instance at the memory address of the given
# +name+ symbol.
#
# Raises a DLError if the +name+ doesn't exist.
#
# See Fiddle::CompositeHandler.sym and Fiddle::Handle.sym
def import_symbol(name)
addr = handler.sym(name)
if( !addr )
raise(DLError, "cannot find the symbol: #{name}")
end
Pointer.new(addr)
end
# Returns a new Fiddle::Function instance at the memory address of the given
# +name+ function.
#
# Raises a DLError if the +name+ doesn't exist.
#
# * +argtype+ is an Array of arguments, passed to the +name+ function.
# * +ctype+ is the return type of the function
# * +call_type+ is the ABI of the function
#
# See also Fiddle:Function.new
#
# See Fiddle::CompositeHandler.sym and Fiddle::Handler.sym
def import_function(name, ctype, argtype, call_type = nil)
addr = handler.sym(name)
if( !addr )
raise(DLError, "cannot find the function: #{name}()")
end
Function.new(addr, argtype, ctype, CALL_TYPE_TO_ABI[call_type],
name: name)
end
# Returns a new closure wrapper for the +name+ function.
#
# * +ctype+ is the return type of the function
# * +argtype+ is an Array of arguments, passed to the callback function
# * +call_type+ is the abi of the closure
# * +block+ is passed to the callback
#
# See Fiddle::Closure
def bind_function(name, ctype, argtype, call_type = nil, &block)
abi = CALL_TYPE_TO_ABI[call_type]
closure = Class.new(Fiddle::Closure) {
define_method(:call, block)
}.new(ctype, argtype, abi)
Function.new(closure, argtype, ctype, abi, name: name)
end
end
end
share/ruby/fiddle/types.rb 0000644 00000003626 15173517737 0011576 0 ustar 00 # frozen_string_literal: true
module Fiddle
# Adds Windows type aliases to the including class for use with
# Fiddle::Importer.
#
# The aliases added are:
# * ATOM
# * BOOL
# * BYTE
# * DWORD
# * DWORD32
# * DWORD64
# * HANDLE
# * HDC
# * HINSTANCE
# * HWND
# * LPCSTR
# * LPSTR
# * PBYTE
# * PDWORD
# * PHANDLE
# * PVOID
# * PWORD
# * UCHAR
# * UINT
# * ULONG
# * WORD
module Win32Types
def included(m) # :nodoc:
# https://docs.microsoft.com/en-us/windows/win32/winprog/windows-data-types
m.module_eval{
typealias "ATOM", "WORD"
typealias "BOOL", "int"
typealias "BYTE", "unsigned char"
typealias "DWORD", "unsigned long"
typealias "DWORD32", "uint32_t"
typealias "DWORD64", "uint64_t"
typealias "HANDLE", "PVOID"
typealias "HDC", "HANDLE"
typealias "HINSTANCE", "HANDLE"
typealias "HWND", "HANDLE"
typealias "LPCSTR", "const char *"
typealias "LPSTR", "char *"
typealias "PBYTE", "BYTE *"
typealias "PDWORD", "DWORD *"
typealias "PHANDLE", "HANDLE *"
typealias "PVOID", "void *"
typealias "PWORD", "WORD *"
typealias "UCHAR", "unsigned char"
typealias "UINT", "unsigned int"
typealias "ULONG", "unsigned long"
typealias "WORD", "unsigned short"
}
end
module_function :included
end
# Adds basic type aliases to the including class for use with Fiddle::Importer.
#
# The aliases added are +uint+ and +u_int+ (<tt>unsigned int</tt>) and
# +ulong+ and +u_long+ (<tt>unsigned long</tt>)
module BasicTypes
def included(m) # :nodoc:
m.module_eval{
typealias "uint", "unsigned int"
typealias "u_int", "unsigned int"
typealias "ulong", "unsigned long"
typealias "u_long", "unsigned long"
}
end
module_function :included
end
end
share/ruby/fiddle/version.rb 0000644 00000000046 15173517737 0012110 0 ustar 00 module Fiddle
VERSION = "1.1.2"
end
share/ruby/fiddle/cparser.rb 0000644 00000022426 15173517737 0012070 0 ustar 00 # frozen_string_literal: true
module Fiddle
# A mixin that provides methods for parsing C struct and prototype signatures.
#
# == Example
# require 'fiddle/import'
#
# include Fiddle::CParser
# #=> Object
#
# parse_ctype('int')
# #=> Fiddle::TYPE_INT
#
# parse_struct_signature(['int i', 'char c'])
# #=> [[Fiddle::TYPE_INT, Fiddle::TYPE_CHAR], ["i", "c"]]
#
# parse_signature('double sum(double, double)')
# #=> ["sum", Fiddle::TYPE_DOUBLE, [Fiddle::TYPE_DOUBLE, Fiddle::TYPE_DOUBLE]]
#
module CParser
# Parses a C struct's members
#
# Example:
# require 'fiddle/import'
#
# include Fiddle::CParser
# #=> Object
#
# parse_struct_signature(['int i', 'char c'])
# #=> [[Fiddle::TYPE_INT, Fiddle::TYPE_CHAR], ["i", "c"]]
#
# parse_struct_signature(['char buffer[80]'])
# #=> [[[Fiddle::TYPE_CHAR, 80]], ["buffer"]]
#
def parse_struct_signature(signature, tymap=nil)
if signature.is_a?(String)
signature = split_arguments(signature, /[,;]/)
elsif signature.is_a?(Hash)
signature = [signature]
end
mems = []
tys = []
signature.each{|msig|
msig = compact(msig) if msig.is_a?(String)
case msig
when Hash
msig.each do |struct_name, struct_signature|
struct_name = struct_name.to_s if struct_name.is_a?(Symbol)
struct_name = compact(struct_name)
struct_count = nil
if struct_name =~ /^([\w\*\s]+)\[(\d+)\]$/
struct_count = $2.to_i
struct_name = $1
end
if struct_signature.respond_to?(:entity_class)
struct_type = struct_signature
else
parsed_struct = parse_struct_signature(struct_signature, tymap)
struct_type = CStructBuilder.create(CStruct, *parsed_struct)
end
if struct_count
ty = [struct_type, struct_count]
else
ty = struct_type
end
mems.push([struct_name, struct_type.members])
tys.push(ty)
end
when /^[\w\*\s]+[\*\s](\w+)$/
mems.push($1)
tys.push(parse_ctype(msig, tymap))
when /^[\w\*\s]+\(\*(\w+)\)\(.*?\)$/
mems.push($1)
tys.push(parse_ctype(msig, tymap))
when /^([\w\*\s]+[\*\s])(\w+)\[(\d+)\]$/
mems.push($2)
tys.push([parse_ctype($1.strip, tymap), $3.to_i])
when /^([\w\*\s]+)\[(\d+)\](\w+)$/
mems.push($3)
tys.push([parse_ctype($1.strip, tymap), $2.to_i])
else
raise(RuntimeError,"can't parse the struct member: #{msig}")
end
}
return tys, mems
end
# Parses a C prototype signature
#
# If Hash +tymap+ is provided, the return value and the arguments from the
# +signature+ are expected to be keys, and the value will be the C type to
# be looked up.
#
# Example:
# require 'fiddle/import'
#
# include Fiddle::CParser
# #=> Object
#
# parse_signature('double sum(double, double)')
# #=> ["sum", Fiddle::TYPE_DOUBLE, [Fiddle::TYPE_DOUBLE, Fiddle::TYPE_DOUBLE]]
#
# parse_signature('void update(void (*cb)(int code))')
# #=> ["update", Fiddle::TYPE_VOID, [Fiddle::TYPE_VOIDP]]
#
# parse_signature('char (*getbuffer(void))[80]')
# #=> ["getbuffer", Fiddle::TYPE_VOIDP, []]
#
def parse_signature(signature, tymap=nil)
tymap ||= {}
case compact(signature)
when /^(?:[\w\*\s]+)\(\*(\w+)\((.*?)\)\)(?:\[\w*\]|\(.*?\));?$/
func, args = $1, $2
return [func, TYPE_VOIDP, split_arguments(args).collect {|arg| parse_ctype(arg, tymap)}]
when /^([\w\*\s]+[\*\s])(\w+)\((.*?)\);?$/
ret, func, args = $1.strip, $2, $3
return [func, parse_ctype(ret, tymap), split_arguments(args).collect {|arg| parse_ctype(arg, tymap)}]
else
raise(RuntimeError,"can't parse the function prototype: #{signature}")
end
end
# Given a String of C type +ty+, returns the corresponding Fiddle constant.
#
# +ty+ can also accept an Array of C type Strings, and will be returned in
# a corresponding Array.
#
# If Hash +tymap+ is provided, +ty+ is expected to be the key, and the
# value will be the C type to be looked up.
#
# Example:
# require 'fiddle/import'
#
# include Fiddle::CParser
# #=> Object
#
# parse_ctype('int')
# #=> Fiddle::TYPE_INT
#
# parse_ctype('double diff')
# #=> Fiddle::TYPE_DOUBLE
#
# parse_ctype('unsigned char byte')
# #=> -Fiddle::TYPE_CHAR
#
# parse_ctype('const char* const argv[]')
# #=> -Fiddle::TYPE_VOIDP
#
def parse_ctype(ty, tymap=nil)
tymap ||= {}
if ty.is_a?(Array)
return [parse_ctype(ty[0], tymap), ty[1]]
end
ty = ty.gsub(/\Aconst\s+/, "")
case ty
when 'void'
return TYPE_VOID
when /\A(?:(?:signed\s+)?long\s+long(?:\s+int\s+)?|int64_t)(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_LONG_LONG)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_LONG_LONG
when /\A(?:unsigned\s+long\s+long(?:\s+int\s+)?|uint64_t)(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_LONG_LONG)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_ULONG_LONG
when /\Aunsigned\s+long(?:\s+int\s+)?(?:\s+\w+)?\z/,
/\Aunsigned\s+int\s+long(?:\s+\w+)?\z/,
/\Along(?:\s+int)?\s+unsigned(?:\s+\w+)?\z/,
/\Aint\s+unsigned\s+long(?:\s+\w+)?\z/,
/\A(?:int\s+)?long\s+unsigned(?:\s+\w+)?\z/
return TYPE_ULONG
when /\A(?:signed\s+)?long(?:\s+int\s+)?(?:\s+\w+)?\z/,
/\A(?:signed\s+)?int\s+long(?:\s+\w+)?\z/,
/\Along(?:\s+int)?\s+signed(?:\s+\w+)?\z/
return TYPE_LONG
when /\Aunsigned\s+short(?:\s+int\s+)?(?:\s+\w+)?\z/,
/\Aunsigned\s+int\s+short(?:\s+\w+)?\z/,
/\Ashort(?:\s+int)?\s+unsigned(?:\s+\w+)?\z/,
/\Aint\s+unsigned\s+short(?:\s+\w+)?\z/,
/\A(?:int\s+)?short\s+unsigned(?:\s+\w+)?\z/
return TYPE_USHORT
when /\A(?:signed\s+)?short(?:\s+int\s+)?(?:\s+\w+)?\z/,
/\A(?:signed\s+)?int\s+short(?:\s+\w+)?\z/,
/\Aint\s+(?:signed\s+)?short(?:\s+\w+)?\z/
return TYPE_SHORT
when /\A(?:signed\s+)?int(?:\s+\w+)?\z/
return TYPE_INT
when /\A(?:unsigned\s+int|uint)(?:\s+\w+)?\z/
return TYPE_UINT
when /\A(?:signed\s+)?char(?:\s+\w+)?\z/
return TYPE_CHAR
when /\Aunsigned\s+char(?:\s+\w+)?\z/
return TYPE_UCHAR
when /\Aint8_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT8_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_INT8_T
when /\Auint8_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT8_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_UINT8_T
when /\Aint16_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT16_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_INT16_T
when /\Auint16_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT16_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_UINT16_T
when /\Aint32_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT32_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_INT32_T
when /\Auint32_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT32_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_UINT32_T
when /\Aint64_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT64_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_INT64_T
when /\Auint64_t(?:\s+\w+)?\z/
unless Fiddle.const_defined?(:TYPE_INT64_T)
raise(RuntimeError, "unsupported type: #{ty}")
end
return TYPE_UINT64_T
when /\Afloat(?:\s+\w+)?\z/
return TYPE_FLOAT
when /\Adouble(?:\s+\w+)?\z/
return TYPE_DOUBLE
when /\Asize_t(?:\s+\w+)?\z/
return TYPE_SIZE_T
when /\Assize_t(?:\s+\w+)?\z/
return TYPE_SSIZE_T
when /\Aptrdiff_t(?:\s+\w+)?\z/
return TYPE_PTRDIFF_T
when /\Aintptr_t(?:\s+\w+)?\z/
return TYPE_INTPTR_T
when /\Auintptr_t(?:\s+\w+)?\z/
return TYPE_UINTPTR_T
when "bool"
return TYPE_BOOL
when /\*/, /\[[\s\d]*\]/
return TYPE_VOIDP
when "..."
return TYPE_VARIADIC
else
ty = ty.split(' ', 2)[0]
if( tymap[ty] )
return parse_ctype(tymap[ty], tymap)
else
raise(DLError, "unknown type: #{ty}")
end
end
end
private
def split_arguments(arguments, sep=',')
return [] if arguments.strip == 'void'
arguments.scan(/([\w\*\s]+\(\*\w*\)\(.*?\)|[\w\*\s\[\]]+|\.\.\.)(?:#{sep}\s*|\z)/).collect {|m| m[0]}
end
def compact(signature)
signature.gsub(/\s+/, ' ').gsub(/\s*([\(\)\[\]\*,;])\s*/, '\1').strip
end
end
end
share/ruby/fiddle/pack.rb 0000644 00000007011 15173517737 0011340 0 ustar 00 # frozen_string_literal: true
require 'fiddle'
module Fiddle
module PackInfo # :nodoc: all
ALIGN_MAP = {
TYPE_VOIDP => ALIGN_VOIDP,
TYPE_CHAR => ALIGN_CHAR,
TYPE_SHORT => ALIGN_SHORT,
TYPE_INT => ALIGN_INT,
TYPE_LONG => ALIGN_LONG,
TYPE_FLOAT => ALIGN_FLOAT,
TYPE_DOUBLE => ALIGN_DOUBLE,
TYPE_UCHAR => ALIGN_CHAR,
TYPE_USHORT => ALIGN_SHORT,
TYPE_UINT => ALIGN_INT,
TYPE_ULONG => ALIGN_LONG,
TYPE_BOOL => ALIGN_BOOL,
}
PACK_MAP = {
TYPE_VOIDP => "L!",
TYPE_CHAR => "c",
TYPE_SHORT => "s!",
TYPE_INT => "i!",
TYPE_LONG => "l!",
TYPE_FLOAT => "f",
TYPE_DOUBLE => "d",
TYPE_UCHAR => "C",
TYPE_USHORT => "S!",
TYPE_UINT => "I!",
TYPE_ULONG => "L!",
}
case SIZEOF_BOOL
when SIZEOF_CHAR
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_UCHAR]
when SIZEOF_SHORT
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_USHORT]
when SIZEOF_INT
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_UINT]
when SIZEOF_LONG
PACK_MAP[TYPE_BOOL] = PACK_MAP[TYPE_ULONG]
end
SIZE_MAP = {
TYPE_VOIDP => SIZEOF_VOIDP,
TYPE_CHAR => SIZEOF_CHAR,
TYPE_SHORT => SIZEOF_SHORT,
TYPE_INT => SIZEOF_INT,
TYPE_LONG => SIZEOF_LONG,
TYPE_FLOAT => SIZEOF_FLOAT,
TYPE_DOUBLE => SIZEOF_DOUBLE,
TYPE_UCHAR => SIZEOF_CHAR,
TYPE_USHORT => SIZEOF_SHORT,
TYPE_UINT => SIZEOF_INT,
TYPE_ULONG => SIZEOF_LONG,
TYPE_BOOL => SIZEOF_BOOL,
}
if defined?(TYPE_LONG_LONG)
ALIGN_MAP[TYPE_LONG_LONG] = ALIGN_MAP[TYPE_ULONG_LONG] = ALIGN_LONG_LONG
PACK_MAP[TYPE_LONG_LONG] = "q"
PACK_MAP[TYPE_ULONG_LONG] = "Q"
SIZE_MAP[TYPE_LONG_LONG] = SIZE_MAP[TYPE_ULONG_LONG] = SIZEOF_LONG_LONG
PACK_MAP[TYPE_VOIDP] = "Q" if SIZEOF_LONG_LONG == SIZEOF_VOIDP
end
def align(addr, align)
d = addr % align
if( d == 0 )
addr
else
addr + (align - d)
end
end
module_function :align
end
class Packer # :nodoc: all
include PackInfo
def self.[](*types)
new(types)
end
def initialize(types)
parse_types(types)
end
def size()
@size
end
def pack(ary)
case SIZEOF_VOIDP
when SIZEOF_LONG
ary.pack(@template)
else
if defined?(TYPE_LONG_LONG) and
SIZEOF_VOIDP == SIZEOF_LONG_LONG
ary.pack(@template)
else
raise(RuntimeError, "sizeof(void*)?")
end
end
end
def unpack(ary)
case SIZEOF_VOIDP
when SIZEOF_LONG
ary.join().unpack(@template)
else
if defined?(TYPE_LONG_LONG) and
SIZEOF_VOIDP == SIZEOF_LONG_LONG
ary.join().unpack(@template)
else
raise(RuntimeError, "sizeof(void*)?")
end
end
end
private
def parse_types(types)
@template = "".dup
addr = 0
types.each{|t|
orig_addr = addr
if( t.is_a?(Array) )
addr = align(orig_addr, ALIGN_MAP[TYPE_VOIDP])
else
addr = align(orig_addr, ALIGN_MAP[t])
end
d = addr - orig_addr
if( d > 0 )
@template << "x#{d}"
end
if( t.is_a?(Array) )
@template << (PACK_MAP[t[0]] * t[1])
addr += (SIZE_MAP[t[0]] * t[1])
else
@template << PACK_MAP[t]
addr += SIZE_MAP[t]
end
}
addr = align(addr, ALIGN_MAP[TYPE_VOIDP])
@size = addr
end
end
end
share/ruby/fiddle/value.rb 0000644 00000005474 15173517737 0011551 0 ustar 00 # frozen_string_literal: true
require 'fiddle'
module Fiddle
module ValueUtil #:nodoc: all
def unsigned_value(val, ty)
case ty.abs
when TYPE_CHAR
[val].pack("c").unpack1("C")
when TYPE_SHORT
[val].pack("s!").unpack1("S!")
when TYPE_INT
[val].pack("i!").unpack1("I!")
when TYPE_LONG
[val].pack("l!").unpack1("L!")
else
if defined?(TYPE_LONG_LONG) and
ty.abs == TYPE_LONG_LONG
[val].pack("q").unpack1("Q")
else
val
end
end
end
def signed_value(val, ty)
case ty.abs
when TYPE_CHAR
[val].pack("C").unpack1("c")
when TYPE_SHORT
[val].pack("S!").unpack1("s!")
when TYPE_INT
[val].pack("I!").unpack1("i!")
when TYPE_LONG
[val].pack("L!").unpack1("l!")
else
if defined?(TYPE_LONG_LONG) and
ty.abs == TYPE_LONG_LONG
[val].pack("Q").unpack1("q")
else
val
end
end
end
def wrap_args(args, tys, funcs, &block)
result = []
tys ||= []
args.each_with_index{|arg, idx|
result.push(wrap_arg(arg, tys[idx], funcs, &block))
}
result
end
def wrap_arg(arg, ty, funcs = [], &block)
funcs ||= []
case arg
when nil
return 0
when Pointer
return arg.to_i
when IO
case ty
when TYPE_VOIDP
return Pointer[arg].to_i
else
return arg.to_i
end
when Function
if( block )
arg.bind_at_call(&block)
funcs.push(arg)
elsif !arg.bound?
raise(RuntimeError, "block must be given.")
end
return arg.to_i
when String
if( ty.is_a?(Array) )
return arg.unpack('C*')
else
case SIZEOF_VOIDP
when SIZEOF_LONG
return [arg].pack("p").unpack1("l!")
else
if defined?(SIZEOF_LONG_LONG) and
SIZEOF_VOIDP == SIZEOF_LONG_LONG
return [arg].pack("p").unpack1("q")
else
raise(RuntimeError, "sizeof(void*)?")
end
end
end
when Float, Integer
return arg
when Array
if( ty.is_a?(Array) ) # used only by struct
case ty[0]
when TYPE_VOIDP
return arg.collect{|v| Integer(v)}
when TYPE_CHAR
if( arg.is_a?(String) )
return val.unpack('C*')
end
end
end
return arg
else
if( arg.respond_to?(:to_ptr) )
return arg.to_ptr.to_i
else
begin
return Integer(arg)
rescue
raise(ArgumentError, "unknown argument type: #{arg.class}")
end
end
end
end
end
end
share/ruby/ruby_vm/rjit/context.rb 0000644 00000026223 15173517737 0013320 0 ustar 00 module RubyVM::RJIT
# Maximum number of temp value types we keep track of
MAX_TEMP_TYPES = 8
# Maximum number of local variable types we keep track of
MAX_LOCAL_TYPES = 8
# Operand to a YARV bytecode instruction
SelfOpnd = :SelfOpnd # The value is self
StackOpnd = Data.define(:index) # Temporary stack operand with stack index
# Potential mapping of a value on the temporary stack to self,
# a local variable, or constant so that we can track its type
MapToStack = :MapToStack # Normal stack value
MapToSelf = :MapToSelf # Temp maps to the self operand
MapToLocal = Data.define(:local_index) # Temp maps to a local variable with index
class Context < Struct.new(
:stack_size, # @param [Integer] The number of values on the stack
:sp_offset, # @param [Integer] JIT sp offset relative to the interpreter's sp
:chain_depth, # @param [Integer] jit_chain_guard depth
:local_types, # @param [Array<RubyVM::RJIT::Type>] Local variable types we keep track of
:temp_types, # @param [Array<RubyVM::RJIT::Type>] Temporary variable types we keep track of
:self_type, # @param [RubyVM::RJIT::Type] Type we track for self
:temp_mapping, # @param [Array<Symbol>] Mapping of temp stack entries to types we track
)
def initialize(
stack_size: 0,
sp_offset: 0,
chain_depth: 0,
local_types: [Type::Unknown] * MAX_LOCAL_TYPES,
temp_types: [Type::Unknown] * MAX_TEMP_TYPES,
self_type: Type::Unknown,
temp_mapping: [MapToStack] * MAX_TEMP_TYPES
) = super
# Deep dup by default for safety
def dup
ctx = super
ctx.local_types = ctx.local_types.dup
ctx.temp_types = ctx.temp_types.dup
ctx.temp_mapping = ctx.temp_mapping.dup
ctx
end
# Create a new Context instance with a given stack_size and sp_offset adjusted
# accordingly. This is useful when you want to virtually rewind a stack_size for
# generating a side exit while considering past sp_offset changes on gen_save_sp.
def with_stack_size(stack_size)
ctx = self.dup
ctx.sp_offset -= ctx.stack_size - stack_size
ctx.stack_size = stack_size
ctx
end
def stack_opnd(depth_from_top)
[SP, C.VALUE.size * (self.sp_offset - 1 - depth_from_top)]
end
def sp_opnd(offset_bytes = 0)
[SP, (C.VALUE.size * self.sp_offset) + offset_bytes]
end
# Push one new value on the temp stack with an explicit mapping
# Return a pointer to the new stack top
def stack_push_mapping(mapping_temp_type)
stack_size = self.stack_size
# Keep track of the type and mapping of the value
if stack_size < MAX_TEMP_TYPES
mapping, temp_type = mapping_temp_type
self.temp_mapping[stack_size] = mapping
self.temp_types[stack_size] = temp_type
case mapping
in MapToLocal[idx]
assert(idx < MAX_LOCAL_TYPES)
else
end
end
self.stack_size += 1
self.sp_offset += 1
return self.stack_opnd(0)
end
# Push one new value on the temp stack
# Return a pointer to the new stack top
def stack_push(val_type)
return self.stack_push_mapping([MapToStack, val_type])
end
# Push the self value on the stack
def stack_push_self
return self.stack_push_mapping([MapToStack, Type::Unknown])
end
# Push a local variable on the stack
def stack_push_local(local_idx)
if local_idx >= MAX_LOCAL_TYPES
return self.stack_push(Type::Unknown)
end
return self.stack_push_mapping([MapToLocal[local_idx], Type::Unknown])
end
# Pop N values off the stack
# Return a pointer to the stack top before the pop operation
def stack_pop(n = 1)
assert(n <= self.stack_size)
top = self.stack_opnd(0)
# Clear the types of the popped values
n.times do |i|
idx = self.stack_size - i - 1
if idx < MAX_TEMP_TYPES
self.temp_types[idx] = Type::Unknown
self.temp_mapping[idx] = MapToStack
end
end
self.stack_size -= n
self.sp_offset -= n
return top
end
def shift_stack(argc)
assert(argc < self.stack_size)
method_name_index = self.stack_size - argc - 1
(method_name_index...(self.stack_size - 1)).each do |i|
if i + 1 < MAX_TEMP_TYPES
self.temp_types[i] = self.temp_types[i + 1]
self.temp_mapping[i] = self.temp_mapping[i + 1]
end
end
self.stack_pop(1)
end
# Get the type of an instruction operand
def get_opnd_type(opnd)
case opnd
in SelfOpnd
self.self_type
in StackOpnd[idx]
assert(idx < self.stack_size)
stack_idx = self.stack_size - 1 - idx
# If outside of tracked range, do nothing
if stack_idx >= MAX_TEMP_TYPES
return Type::Unknown
end
mapping = self.temp_mapping[stack_idx]
case mapping
in MapToSelf
self.self_type
in MapToStack
self.temp_types[self.stack_size - 1 - idx]
in MapToLocal[idx]
assert(idx < MAX_LOCAL_TYPES)
self.local_types[idx]
end
end
end
# Get the currently tracked type for a local variable
def get_local_type(idx)
self.local_types[idx] || Type::Unknown
end
# Upgrade (or "learn") the type of an instruction operand
# This value must be compatible and at least as specific as the previously known type.
# If this value originated from self, or an lvar, the learned type will be
# propagated back to its source.
def upgrade_opnd_type(opnd, opnd_type)
case opnd
in SelfOpnd
self.self_type = self.self_type.upgrade(opnd_type)
in StackOpnd[idx]
assert(idx < self.stack_size)
stack_idx = self.stack_size - 1 - idx
# If outside of tracked range, do nothing
if stack_idx >= MAX_TEMP_TYPES
return
end
mapping = self.temp_mapping[stack_idx]
case mapping
in MapToSelf
self.self_type = self.self_type.upgrade(opnd_type)
in MapToStack
self.temp_types[stack_idx] = self.temp_types[stack_idx].upgrade(opnd_type)
in MapToLocal[idx]
assert(idx < MAX_LOCAL_TYPES)
self.local_types[idx] = self.local_types[idx].upgrade(opnd_type)
end
end
end
# Get both the type and mapping (where the value originates) of an operand.
# This is can be used with stack_push_mapping or set_opnd_mapping to copy
# a stack value's type while maintaining the mapping.
def get_opnd_mapping(opnd)
opnd_type = self.get_opnd_type(opnd)
case opnd
in SelfOpnd
return [MapToSelf, opnd_type]
in StackOpnd[idx]
assert(idx < self.stack_size)
stack_idx = self.stack_size - 1 - idx
if stack_idx < MAX_TEMP_TYPES
return [self.temp_mapping[stack_idx], opnd_type]
else
# We can't know the source of this stack operand, so we assume it is
# a stack-only temporary. type will be UNKNOWN
assert(opnd_type == Type::Unknown)
return [MapToStack, opnd_type]
end
end
end
# Overwrite both the type and mapping of a stack operand.
def set_opnd_mapping(opnd, mapping_opnd_type)
case opnd
in SelfOpnd
raise 'self always maps to self'
in StackOpnd[idx]
assert(idx < self.stack_size)
stack_idx = self.stack_size - 1 - idx
# If outside of tracked range, do nothing
if stack_idx >= MAX_TEMP_TYPES
return
end
mapping, opnd_type = mapping_opnd_type
self.temp_mapping[stack_idx] = mapping
# Only used when mapping == MAP_STACK
self.temp_types[stack_idx] = opnd_type
end
end
# Set the type of a local variable
def set_local_type(local_idx, local_type)
if local_idx >= MAX_LOCAL_TYPES
return
end
# If any values on the stack map to this local we must detach them
MAX_TEMP_TYPES.times do |stack_idx|
case self.temp_mapping[stack_idx]
in MapToStack
# noop
in MapToSelf
# noop
in MapToLocal[idx]
if idx == local_idx
self.temp_types[stack_idx] = self.local_types[idx]
self.temp_mapping[stack_idx] = MapToStack
else
# noop
end
end
end
self.local_types[local_idx] = local_type
end
# Erase local variable type information
# eg: because of a call we can't track
def clear_local_types
# When clearing local types we must detach any stack mappings to those
# locals. Even if local values may have changed, stack values will not.
MAX_TEMP_TYPES.times do |stack_idx|
case self.temp_mapping[stack_idx]
in MapToStack
# noop
in MapToSelf
# noop
in MapToLocal[local_idx]
self.temp_types[stack_idx] = self.local_types[local_idx]
self.temp_mapping[stack_idx] = MapToStack
end
end
# Clear the local types
self.local_types = [Type::Unknown] * MAX_LOCAL_TYPES
end
# Compute a difference score for two context objects
def diff(dst)
# Self is the source context (at the end of the predecessor)
src = self
# Can only lookup the first version in the chain
if dst.chain_depth != 0
return TypeDiff::Incompatible
end
# Blocks with depth > 0 always produce new versions
# Sidechains cannot overlap
if src.chain_depth != 0
return TypeDiff::Incompatible
end
if dst.stack_size != src.stack_size
return TypeDiff::Incompatible
end
if dst.sp_offset != src.sp_offset
return TypeDiff::Incompatible
end
# Difference sum
diff = 0
# Check the type of self
diff += case src.self_type.diff(dst.self_type)
in TypeDiff::Compatible[diff] then diff
in TypeDiff::Incompatible then return TypeDiff::Incompatible
end
# For each local type we track
src.local_types.size.times do |i|
t_src = src.local_types[i]
t_dst = dst.local_types[i]
diff += case t_src.diff(t_dst)
in TypeDiff::Compatible[diff] then diff
in TypeDiff::Incompatible then return TypeDiff::Incompatible
end
end
# For each value on the temp stack
src.stack_size.times do |i|
src_mapping, src_type = src.get_opnd_mapping(StackOpnd[i])
dst_mapping, dst_type = dst.get_opnd_mapping(StackOpnd[i])
# If the two mappings aren't the same
if src_mapping != dst_mapping
if dst_mapping == MapToStack
# We can safely drop information about the source of the temp
# stack operand.
diff += 1
else
return TypeDiff::Incompatible
end
end
diff += case src_type.diff(dst_type)
in TypeDiff::Compatible[diff] then diff
in TypeDiff::Incompatible then return TypeDiff::Incompatible
end
end
return TypeDiff::Compatible[diff]
end
private
def assert(cond)
unless cond
raise "'#{cond.inspect}' was not true"
end
end
end
end
share/ruby/ruby_vm/rjit/c_pointer.rb 0000644 00000025266 15173517737 0013624 0 ustar 00 module RubyVM::RJIT
# Every class under this namespace is a pointer. Even if the type is
# immediate, it shouldn't be dereferenced until `*` is called.
module CPointer
# Note: We'd like to avoid alphabetic method names to avoid a conflict
# with member methods. to_i and to_s are considered an exception.
class Struct
# @param name [String]
# @param sizeof [Integer]
# @param members [Hash{ Symbol => [RubyVM::RJIT::CType::*, Integer, TrueClass] }]
def initialize(addr, sizeof, members)
@addr = addr
@sizeof = sizeof
@members = members
end
# Get a raw address
def to_i
@addr
end
# Serialized address for generated code
def to_s
"0x#{@addr.to_s(16)}"
end
# Pointer diff
def -(struct)
raise ArgumentError if self.class != struct.class
(@addr - struct.to_i) / @sizeof
end
# Primitive API that does no automatic dereference
# TODO: remove this?
# @param member [Symbol]
def [](member)
type, offset = @members.fetch(member)
type.new(@addr + offset / 8)
end
private
# @param member [Symbol]
# @param value [Object]
def []=(member, value)
type, offset = @members.fetch(member)
type[@addr + offset / 8] = value
end
# @param size [Integer]
# @param members [Hash{ Symbol => [Integer, RubyVM::RJIT::CType::*] }]
def self.define(size, members)
Class.new(self) do
# Return the size of this type
define_singleton_method(:size) { size }
# Return the offset to a field
define_singleton_method(:offsetof) do |field, *fields|
member, offset = members.fetch(field)
offset /= 8
unless fields.empty?
offset += member.offsetof(*fields)
end
offset
end
# Return member names
define_singleton_method(:members) { members.keys }
define_method(:initialize) do |addr = nil|
if addr.nil? # TODO: get rid of this feature later
addr = Fiddle.malloc(size)
end
super(addr, size, members)
end
members.each do |member, (type, offset, to_ruby)|
# Intelligent API that does automatic dereference
define_method(member) do
value = self[member]
if value.respond_to?(:*)
value = value.*
end
if to_ruby
value = C.to_ruby(value)
end
value
end
define_method("#{member}=") do |value|
if to_ruby
value = C.to_value(value)
end
self[member] = value
end
end
end
end
end
# Note: We'd like to avoid alphabetic method names to avoid a conflict
# with member methods. to_i is considered an exception.
class Union
# @param _name [String] To be used when it starts defining a union pointer class
# @param sizeof [Integer]
# @param members [Hash{ Symbol => RubyVM::RJIT::CType::* }]
def initialize(addr, sizeof, members)
@addr = addr
@sizeof = sizeof
@members = members
end
# Get a raw address
def to_i
@addr
end
# Move addr to access this pointer like an array
def +(index)
raise ArgumentError unless index.is_a?(Integer)
self.class.new(@addr + index * @sizeof)
end
# Pointer diff
def -(union)
raise ArgumentError if self.class != union.class
(@addr - union.instance_variable_get(:@addr)) / @sizeof
end
# @param sizeof [Integer]
# @param members [Hash{ Symbol => RubyVM::RJIT::CType::* }]
def self.define(sizeof, members)
Class.new(self) do
# Return the size of this type
define_singleton_method(:sizeof) { sizeof }
# Part of Struct's offsetof implementation
define_singleton_method(:offsetof) do |field, *fields|
member = members.fetch(field)
offset = 0
unless fields.empty?
offset += member.offsetof(*fields)
end
offset
end
define_method(:initialize) do |addr|
super(addr, sizeof, members)
end
members.each do |member, type|
# Intelligent API that does automatic dereference
define_method(member) do
value = type.new(@addr)
if value.respond_to?(:*)
value = value.*
end
value
end
end
end
end
end
class Immediate
# @param addr [Integer]
# @param size [Integer]
# @param pack [String]
def initialize(addr, size, pack)
@addr = addr
@size = size
@pack = pack
end
# Get a raw address
def to_i
@addr
end
# Move addr to addess this pointer like an array
def +(index)
Immediate.new(@addr + index * @size, @size, @pack)
end
# Dereference
def *
self[0]
end
# Array access
def [](index)
return nil if @addr == 0
Fiddle::Pointer.new(@addr + index * @size)[0, @size].unpack1(@pack)
end
# Array set
def []=(index, value)
Fiddle::Pointer.new(@addr + index * @size)[0, @size] = [value].pack(@pack)
end
# Serialized address for generated code. Used for embedding things like body->iseq_encoded.
def to_s
"0x#{Integer(@addr).to_s(16)}"
end
# @param fiddle_type [Integer] Fiddle::TYPE_*
def self.define(fiddle_type)
size = Fiddle::PackInfo::SIZE_MAP.fetch(fiddle_type)
pack = Fiddle::PackInfo::PACK_MAP.fetch(fiddle_type)
Class.new(self) do
define_method(:initialize) do |addr|
super(addr, size, pack)
end
define_singleton_method(:size) do
size
end
# Type-level []=: Used by struct fields
define_singleton_method(:[]=) do |addr, value|
Fiddle::Pointer.new(addr)[0, size] = [value].pack(pack)
end
end
end
end
# -Fiddle::TYPE_CHAR Immediate with special handling of true/false
class Bool < Immediate.define(-Fiddle::TYPE_CHAR)
# Dereference
def *
return nil if @addr == 0
super != 0
end
def self.[]=(addr, value)
super(addr, value ? 1 : 0)
end
end
# Basically Immediate but without #* to skip auto-dereference of structs.
class Array
attr_reader :type
# @param addr [Integer]
# @param type [Class] RubyVM::RJIT::CType::*
def initialize(addr, type)
@addr = addr
@type = type
end
# Array access
def [](index)
@type.new(@addr)[index]
end
# Array set
# @param index [Integer]
# @param value [Integer, RubyVM::RJIT::CPointer::Struct] an address itself or an object that return an address with to_i
def []=(index, value)
@type.new(@addr)[index] = value
end
private
def self.define(block)
Class.new(self) do
define_method(:initialize) do |addr|
super(addr, block.call)
end
end
end
end
class Pointer
attr_reader :type
# @param addr [Integer]
# @param type [Class] RubyVM::RJIT::CType::*
def initialize(addr, type)
@addr = addr
@type = type
end
# Move addr to addess this pointer like an array
def +(index)
raise ArgumentError unless index.is_a?(Integer)
Pointer.new(@addr + index * Fiddle::SIZEOF_VOIDP, @type)
end
# Dereference
def *
return nil if dest_addr == 0
@type.new(dest_addr)
end
# Array access
def [](index)
(self + index).*
end
# Array set
# @param index [Integer]
# @param value [Integer, RubyVM::RJIT::CPointer::Struct] an address itself or an object that return an address with to_i
def []=(index, value)
Fiddle::Pointer.new(@addr + index * Fiddle::SIZEOF_VOIDP)[0, Fiddle::SIZEOF_VOIDP] =
[value.to_i].pack(Fiddle::PackInfo::PACK_MAP[Fiddle::TYPE_VOIDP])
end
# Get a raw address
def to_i
@addr
end
private
def dest_addr
Fiddle::Pointer.new(@addr)[0, Fiddle::SIZEOF_VOIDP].unpack1(Fiddle::PackInfo::PACK_MAP[Fiddle::TYPE_VOIDP])
end
def self.define(block)
Class.new(self) do
define_method(:initialize) do |addr|
super(addr, block.call)
end
# Type-level []=: Used by struct fields
# @param addr [Integer]
# @param value [Integer, RubyVM::RJIT::CPointer::Struct] an address itself, or an object that return an address with to_i
define_singleton_method(:[]=) do |addr, value|
value = value.to_i
Fiddle::Pointer.new(addr)[0, Fiddle::SIZEOF_VOIDP] = [value].pack(Fiddle::PackInfo::PACK_MAP[Fiddle::TYPE_VOIDP])
end
end
end
end
class BitField
# @param addr [Integer]
# @param width [Integer]
# @param offset [Integer]
def initialize(addr, width, offset)
@addr = addr
@width = width
@offset = offset
end
# Dereference
def *
byte = Fiddle::Pointer.new(@addr)[0, Fiddle::SIZEOF_CHAR].unpack('c').first
if @width == 1
bit = (1 & (byte >> @offset))
bit == 1
elsif @width <= 8 && @offset == 0
bitmask = @width.times.map { |i| 1 << i }.sum
byte & bitmask
else
raise NotImplementedError.new("not-implemented bit field access: width=#{@width} offset=#{@offset}")
end
end
# @param width [Integer]
# @param offset [Integer]
def self.define(width, offset)
Class.new(self) do
define_method(:initialize) do |addr|
super(addr, width, offset)
end
end
end
end
# Give a name to a dynamic CPointer class to see it on inspect
def self.with_class_name(prefix, name, cache: false, &block)
return block.call if !name.nil? && name.empty?
# Use a cached result only if cache: true
class_name = "#{prefix}_#{name}"
klass =
if cache && self.const_defined?(class_name)
self.const_get(class_name)
else
block.call
end
# Give it a name unless it's already defined
unless self.const_defined?(class_name)
self.const_set(class_name, klass)
end
klass
end
end
end
share/ruby/ruby_vm/rjit/invariants.rb 0000644 00000011346 15173517737 0014012 0 ustar 00 require 'set'
module RubyVM::RJIT
class Invariants
class << self
# Called by RubyVM::RJIT::Compiler to lazily initialize this
# @param cb [CodeBlock]
# @param ocb [CodeBlock]
# @param compiler [RubyVM::RJIT::Compiler]
# @param exit_compiler [RubyVM::RJIT::ExitCompiler]
def initialize(cb, ocb, compiler, exit_compiler)
@cb = cb
@ocb = ocb
@compiler = compiler
@exit_compiler = exit_compiler
@bop_blocks = Set.new # TODO: actually invalidate this
@cme_blocks = Hash.new { |h, k| h[k] = Set.new }
@const_blocks = Hash.new { |h, k| h[k] = Set.new }
@patches = {}
# freeze # workaround a binding.irb issue. TODO: resurrect this
end
# @param jit [RubyVM::RJIT::JITState]
# @param klass [Integer]
# @param op [Integer]
def assume_bop_not_redefined(jit, klass, op)
return false unless C.BASIC_OP_UNREDEFINED_P(klass, op)
ensure_block_entry_exit(jit, cause: 'assume_bop_not_redefined')
@bop_blocks << jit.block
true
end
# @param jit [RubyVM::RJIT::JITState]
def assume_method_lookup_stable(jit, cme)
ensure_block_entry_exit(jit, cause: 'assume_method_lookup_stable')
@cme_blocks[cme.to_i] << jit.block
end
# @param jit [RubyVM::RJIT::JITState]
def assume_method_basic_definition(jit, klass, mid)
if C.rb_method_basic_definition_p(klass, mid)
cme = C.rb_callable_method_entry(klass, mid)
assume_method_lookup_stable(jit, cme)
true
else
false
end
end
def assume_stable_constant_names(jit, idlist)
(0..).each do |i|
break if (id = idlist[i]) == 0
@const_blocks[id] << jit.block
end
end
# @param asm [RubyVM::RJIT::Assembler]
def record_global_inval_patch(asm, target)
asm.pos_marker do |address|
if @patches.key?(address)
raise 'multiple patches in the same address'
end
@patches[address] = target
end
end
def on_cme_invalidate(cme)
@cme_blocks.fetch(cme.to_i, []).each do |block|
@cb.with_write_addr(block.start_addr) do
asm = Assembler.new
asm.comment('on_cme_invalidate')
asm.jmp(block.entry_exit)
@cb.write(asm)
end
# TODO: re-generate branches that refer to this block
end
@cme_blocks.delete(cme.to_i)
end
def on_constant_ic_update(iseq, ic, insn_idx)
# TODO: check multi ractor as well
if ic.entry.ic_cref
# No need to recompile the slowpath
return
end
pc = iseq.body.iseq_encoded + insn_idx
insn_name = Compiler.decode_insn(pc.*).name
if insn_name != :opt_getconstant_path && insn_name != :trace_opt_getconstant_path
raise 'insn_idx was not at opt_getconstant_path'
end
if ic.to_i != pc[1]
raise 'insn_idx + 1 was not at the updated IC'
end
@compiler.invalidate_blocks(iseq, pc.to_i)
end
def on_constant_state_changed(id)
@const_blocks.fetch(id, []).each do |block|
@compiler.invalidate_block(block)
end
end
def on_tracing_invalidate_all
invalidate_all
end
def on_update_references
# Give up. In order to support GC.compact, you'd have to update ISEQ
# addresses in BranchStub, etc. Ideally, we'd need to update moved
# pointers in JITed code here, but we just invalidate all for now.
invalidate_all
end
# @param jit [RubyVM::RJIT::JITState]
# @param block [RubyVM::RJIT::Block]
def ensure_block_entry_exit(jit, cause:)
block = jit.block
if block.entry_exit.nil?
block.entry_exit = Assembler.new.then do |asm|
@exit_compiler.compile_entry_exit(block.pc, block.ctx, asm, cause:)
@ocb.write(asm)
end
end
end
private
def invalidate_all
# On-Stack Replacement
@patches.each do |address, target|
# TODO: assert patches don't overlap each other
@cb.with_write_addr(address) do
asm = Assembler.new
asm.comment('on_tracing_invalidate_all')
asm.jmp(target)
@cb.write(asm)
end
end
@patches.clear
C.rjit_for_each_iseq do |iseq|
# Avoid entering past code
iseq.body.jit_entry = 0
# Avoid reusing past code
iseq.body.rjit_blocks.clear if iseq.body.rjit_blocks
# Compile this again if not converted to trace_* insns
iseq.body.jit_entry_calls = 0
end
end
end
end
end
share/ruby/ruby_vm/rjit/type.rb 0000644 00000013642 15173517737 0012616 0 ustar 00 module RubyVM::RJIT
# Represent the type of a value (local/stack/self) in RJIT
Type = Data.define(:type) do
# Check if the type is an immediate
def imm?
case self
in Type::UnknownImm then true
in Type::Nil then true
in Type::True then true
in Type::False then true
in Type::Fixnum then true
in Type::Flonum then true
in Type::ImmSymbol then true
else false
end
end
# Returns true when the type is not specific.
def unknown?
case self
in Type::Unknown | Type::UnknownImm | Type::UnknownHeap then true
else false
end
end
# Returns true when we know the VALUE is a specific handle type,
# such as a static symbol ([Type::ImmSymbol], i.e. true from RB_STATIC_SYM_P()).
# Opposite of [Self::is_unknown].
def specific?
!self.unknown?
end
# Check if the type is a heap object
def heap?
case self
in Type::UnknownHeap then true
in Type::TArray then true
in Type::Hash then true
in Type::HeapSymbol then true
in Type::TString then true
in Type::CString then true
in Type::BlockParamProxy then true
else false
end
end
# Check if it's a T_ARRAY object
def array?
case self
in Type::TArray then true
else false
end
end
# Check if it's a T_STRING object (both TString and CString are T_STRING)
def string?
case self
in Type::TString then true
in Type::CString then true
else false
end
end
# Returns the class if it is known, otherwise nil
def known_class
case self
in Type::Nil then C.rb_cNilClass
in Type::True then C.rb_cTrueClass
in Type::False then C.rb_cFalseClass
in Type::Fixnum then C.rb_cInteger
in Type::Flonum then C.rb_cFloat
in Type::ImmSymbol | Type::HeapSymbol then C.rb_cSymbol
in Type::CString then C.rb_cString
else nil
end
end
# Returns a boolean representing whether the value is truthy if known, otherwise nil
def known_truthy
case self
in Type::Nil then false
in Type::False then false
in Type::UnknownHeap then false
in Type::Unknown | Type::UnknownImm then nil
else true
end
end
# Returns a boolean representing whether the value is equal to nil if known, otherwise nil
def known_nil
case [self, self.known_truthy]
in Type::Nil, _ then true
in Type::False, _ then false # Qfalse is not nil
in _, true then false # if truthy, can't be nil
in _, _ then nil # otherwise unknown
end
end
def diff(dst)
# Perfect match, difference is zero
if self == dst
return TypeDiff::Compatible[0]
end
# Any type can flow into an unknown type
if dst == Type::Unknown
return TypeDiff::Compatible[1]
end
# A CString is also a TString.
if self == Type::CString && dst == Type::TString
return TypeDiff::Compatible[1]
end
# Specific heap type into unknown heap type is imperfect but valid
if self.heap? && dst == Type::UnknownHeap
return TypeDiff::Compatible[1]
end
# Specific immediate type into unknown immediate type is imperfect but valid
if self.imm? && dst == Type::UnknownImm
return TypeDiff::Compatible[1]
end
# Incompatible types
return TypeDiff::Incompatible
end
def upgrade(new_type)
assert(new_type.diff(self) != TypeDiff::Incompatible)
new_type
end
private
def assert(cond)
unless cond
raise "'#{cond.inspect}' was not true"
end
end
end
# This returns an appropriate Type based on a known value
class << Type
def from(val)
if C::SPECIAL_CONST_P(val)
if fixnum?(val)
Type::Fixnum
elsif val.nil?
Type::Nil
elsif val == true
Type::True
elsif val == false
Type::False
elsif static_symbol?(val)
Type::ImmSymbol
elsif flonum?(val)
Type::Flonum
else
raise "Illegal value: #{val.inspect}"
end
else
val_class = C.to_value(C.rb_class_of(val))
if val_class == C.rb_cString && C.rb_obj_frozen_p(val)
return Type::CString
end
if C.to_value(val) == C.rb_block_param_proxy
return Type::BlockParamProxy
end
case C::BUILTIN_TYPE(val)
in C::RUBY_T_ARRAY
Type::TArray
in C::RUBY_T_HASH
Type::Hash
in C::RUBY_T_STRING
Type::TString
else
Type::UnknownHeap
end
end
end
private
def fixnum?(obj)
(C.to_value(obj) & C::RUBY_FIXNUM_FLAG) == C::RUBY_FIXNUM_FLAG
end
def flonum?(obj)
(C.to_value(obj) & C::RUBY_FLONUM_MASK) == C::RUBY_FLONUM_FLAG
end
def static_symbol?(obj)
(C.to_value(obj) & 0xff) == C::RUBY_SYMBOL_FLAG
end
end
# List of types
Type::Unknown = Type[:Unknown]
Type::UnknownImm = Type[:UnknownImm]
Type::UnknownHeap = Type[:UnknownHeap]
Type::Nil = Type[:Nil]
Type::True = Type[:True]
Type::False = Type[:False]
Type::Fixnum = Type[:Fixnum]
Type::Flonum = Type[:Flonum]
Type::Hash = Type[:Hash]
Type::ImmSymbol = Type[:ImmSymbol]
Type::HeapSymbol = Type[:HeapSymbol]
Type::TString = Type[:TString] # An object with the T_STRING flag set, possibly an rb_cString
Type::CString = Type[:CString] # An un-subclassed string of type rb_cString (can have instance vars in some cases)
Type::TArray = Type[:TArray] # An object with the T_ARRAY flag set, possibly an rb_cArray
Type::BlockParamProxy = Type[:BlockParamProxy] # A special sentinel value indicating the block parameter should be read from
module TypeDiff
Compatible = Data.define(:diversion) # The smaller, the more compatible.
Incompatible = :Incompatible
end
end
share/ruby/ruby_vm/rjit/stats.rb 0000644 00000016632 15173517737 0012775 0 ustar 00 # frozen_string_literal: true
module RubyVM::RJIT
# Return a Hash for \RJIT statistics. \--rjit-stats makes more information available.
def self.runtime_stats
stats = {}
# Insn exits
INSNS.each_value do |insn|
exits = C.rjit_insn_exits[insn.bin]
if exits > 0
stats[:"exit_#{insn.name}"] = exits
end
end
# Runtime stats
C.rb_rjit_runtime_counters.members.each do |member|
stats[member] = C.rb_rjit_counters.public_send(member)
end
stats[:vm_insns_count] = C.rb_vm_insns_count
# Other stats are calculated here
stats[:side_exit_count] = stats.select { |name, _count| name.start_with?('exit_') }.sum(&:last)
if stats[:vm_insns_count] > 0
retired_in_rjit = stats[:rjit_insns_count] - stats[:side_exit_count]
stats[:total_insns_count] = retired_in_rjit + stats[:vm_insns_count]
stats[:ratio_in_rjit] = 100.0 * retired_in_rjit / stats[:total_insns_count]
else
stats.delete(:vm_insns_count)
end
stats
end
# :nodoc: all
class << self
private
# --yjit-stats at_exit
def print_stats
stats = runtime_stats
$stderr.puts("***RJIT: Printing RJIT statistics on exit***")
print_counters(stats, prefix: 'send_', prompt: 'method call exit reasons')
print_counters(stats, prefix: 'invokeblock_', prompt: 'invokeblock exit reasons')
print_counters(stats, prefix: 'invokesuper_', prompt: 'invokesuper exit reasons')
print_counters(stats, prefix: 'getblockpp_', prompt: 'getblockparamproxy exit reasons')
print_counters(stats, prefix: 'getivar_', prompt: 'getinstancevariable exit reasons')
print_counters(stats, prefix: 'setivar_', prompt: 'setinstancevariable exit reasons')
print_counters(stats, prefix: 'optaref_', prompt: 'opt_aref exit reasons')
print_counters(stats, prefix: 'optgetconst_', prompt: 'opt_getconstant_path exit reasons')
print_counters(stats, prefix: 'expandarray_', prompt: 'expandarray exit reasons')
$stderr.puts "compiled_block_count: #{format_number(13, stats[:compiled_block_count])}"
$stderr.puts "side_exit_count: #{format_number(13, stats[:side_exit_count])}"
$stderr.puts "total_insns_count: #{format_number(13, stats[:total_insns_count])}" if stats.key?(:total_insns_count)
$stderr.puts "vm_insns_count: #{format_number(13, stats[:vm_insns_count])}" if stats.key?(:vm_insns_count)
$stderr.puts "rjit_insns_count: #{format_number(13, stats[:rjit_insns_count])}"
$stderr.puts "ratio_in_rjit: #{format('%12.1f', stats[:ratio_in_rjit])}%" if stats.key?(:ratio_in_rjit)
print_exit_counts(stats)
end
def print_counters(stats, prefix:, prompt:)
$stderr.puts("#{prompt}: ")
counters = stats.filter { |key, _| key.start_with?(prefix) }
counters.filter! { |_, value| value != 0 }
counters.transform_keys! { |key| key.to_s.delete_prefix(prefix) }
if counters.empty?
$stderr.puts(" (all relevant counters are zero)")
return
end
counters = counters.to_a
counters.sort_by! { |(_, counter_value)| counter_value }
longest_name_length = counters.max_by { |(name, _)| name.length }.first.length
total = counters.sum { |(_, counter_value)| counter_value }
counters.reverse_each do |(name, value)|
percentage = value.fdiv(total) * 100
$stderr.printf(" %*s %s (%4.1f%%)\n", longest_name_length, name, format_number(10, value), percentage)
end
end
def print_exit_counts(stats, how_many: 20, padding: 2)
exits = stats.filter_map { |name, count| [name.to_s.delete_prefix('exit_'), count] if name.start_with?('exit_') }.to_h
return if exits.empty?
top_exits = exits.sort_by { |_name, count| -count }.first(how_many).to_h
total_exits = exits.values.sum
$stderr.puts "Top-#{top_exits.size} most frequent exit ops (#{format("%.1f", 100.0 * top_exits.values.sum / total_exits)}% of exits):"
name_width = top_exits.map { |name, _count| name.length }.max + padding
count_width = top_exits.map { |_name, count| format_number(10, count).length }.max + padding
top_exits.each do |name, count|
ratio = 100.0 * count / total_exits
$stderr.puts "#{format("%#{name_width}s", name)}: #{format_number(count_width, count)} (#{format('%4.1f', ratio)}%)"
end
end
# Format large numbers with comma separators for readability
def format_number(pad, number)
integer, decimal = number.to_s.split('.')
d_groups = integer.chars.reverse.each_slice(3)
with_commas = d_groups.map(&:join).join(',').reverse
[with_commas, decimal].compact.join('.').rjust(pad, ' ')
end
# --yjit-trace-exits at_exit
def dump_trace_exits
filename = "#{Dir.pwd}/rjit_exit_locations.dump"
File.binwrite(filename, Marshal.dump(exit_traces))
$stderr.puts("RJIT exit locations dumped to:\n#{filename}")
end
# Convert rb_rjit_raw_samples and rb_rjit_line_samples into a StackProf format.
def exit_traces
results = C.rjit_exit_traces
raw_samples = results[:raw].dup
line_samples = results[:lines].dup
frames = results[:frames].dup
samples_count = 0
# Loop through the instructions and set the frame hash with the data.
# We use nonexistent.def for the file name, otherwise insns.def will be displayed
# and that information isn't useful in this context.
RubyVM::INSTRUCTION_NAMES.each_with_index do |name, frame_id|
frame_hash = { samples: 0, total_samples: 0, edges: {}, name: name, file: "nonexistent.def", line: nil, lines: {} }
results[:frames][frame_id] = frame_hash
frames[frame_id] = frame_hash
end
# Loop through the raw_samples and build the hashes for StackProf.
# The loop is based off an example in the StackProf documentation and therefore
# this functionality can only work with that library.
#
# Raw Samples:
# [ length, frame1, frame2, frameN, ..., instruction, count
#
# Line Samples
# [ length, line_1, line_2, line_n, ..., dummy value, count
i = 0
while i < raw_samples.length
stack_length = raw_samples[i] + 1
i += 1 # consume the stack length
prev_frame_id = nil
stack_length.times do |idx|
idx += i
frame_id = raw_samples[idx]
if prev_frame_id
prev_frame = frames[prev_frame_id]
prev_frame[:edges][frame_id] ||= 0
prev_frame[:edges][frame_id] += 1
end
frame_info = frames[frame_id]
frame_info[:total_samples] += 1
frame_info[:lines][line_samples[idx]] ||= [0, 0]
frame_info[:lines][line_samples[idx]][0] += 1
prev_frame_id = frame_id
end
i += stack_length # consume the stack
top_frame_id = prev_frame_id
top_frame_line = 1
sample_count = raw_samples[i]
frames[top_frame_id][:samples] += sample_count
frames[top_frame_id][:lines] ||= {}
frames[top_frame_id][:lines][top_frame_line] ||= [0, 0]
frames[top_frame_id][:lines][top_frame_line][1] += sample_count
samples_count += sample_count
i += 1
end
results[:samples] = samples_count
# Set missed_samples and gc_samples to 0 as their values
# don't matter to us in this context.
results[:missed_samples] = 0
results[:gc_samples] = 0
results
end
end
end
share/ruby/ruby_vm/rjit/c_type.rb 0000644 00000005235 15173517737 0013117 0 ustar 00 require 'fiddle'
require 'fiddle/pack'
require_relative 'c_pointer'
module RubyVM::RJIT
module CType
module Struct
# @param name [String]
# @param members [Hash{ Symbol => [Integer, RubyVM::RJIT::CType::*] }]
def self.new(name, sizeof, **members)
name = members.keys.join('_') if name.empty?
CPointer.with_class_name('Struct', name) do
CPointer::Struct.define(sizeof, members)
end
end
end
module Union
# @param name [String]
# @param members [Hash{ Symbol => RubyVM::RJIT::CType::* }]
def self.new(name, sizeof, **members)
name = members.keys.join('_') if name.empty?
CPointer.with_class_name('Union', name) do
CPointer::Union.define(sizeof, members)
end
end
end
module Immediate
# @param fiddle_type [Integer]
def self.new(fiddle_type)
name = Fiddle.constants.find do |const|
const.start_with?('TYPE_') && Fiddle.const_get(const) == fiddle_type.abs
end&.to_s
name.delete_prefix!('TYPE_')
if fiddle_type.negative?
name.prepend('U')
end
CPointer.with_class_name('Immediate', name, cache: true) do
CPointer::Immediate.define(fiddle_type)
end
end
# @param type [String]
def self.parse(ctype)
new(Fiddle::Importer.parse_ctype(ctype))
end
def self.find(size, signed)
fiddle_type = TYPE_MAP.fetch(size)
fiddle_type = -fiddle_type unless signed
new(fiddle_type)
end
TYPE_MAP = Fiddle::PackInfo::SIZE_MAP.map { |type, size| [size, type.abs] }.to_h
private_constant :TYPE_MAP
end
module Bool
def self.new
CPointer::Bool
end
end
class Array
def self.new(&block)
CPointer.with_class_name('Array', block.object_id.to_s) do
CPointer::Array.define(block)
end
end
end
class Pointer
# This takes a block to avoid "stack level too deep" on a cyclic reference
# @param block [Proc]
def self.new(&block)
CPointer.with_class_name('Pointer', block.object_id.to_s) do
CPointer::Pointer.define(block)
end
end
end
module BitField
# @param width [Integer]
# @param offset [Integer]
def self.new(width, offset)
CPointer.with_class_name('BitField', "#{offset}_#{width}") do
CPointer::BitField.define(width, offset)
end
end
end
# Types that are referenced but not part of code generation targets
Stub = ::Struct.new(:name)
# Types that it failed to figure out from the header
Unknown = Module.new
end
end
share/ruby/ruby_vm/rjit/jit_state.rb 0000644 00000003727 15173517737 0013626 0 ustar 00 module RubyVM::RJIT
class JITState < Struct.new(
:iseq, # @param `RubyVM::RJIT::CPointer::Struct_rb_iseq_t`
:pc, # @param [Integer] The JIT target PC
:cfp, # @param `RubyVM::RJIT::CPointer::Struct_rb_control_frame_t` The JIT source CFP (before RJIT is called)
:block, # @param [RubyVM::RJIT::Block]
:stack_size_for_pc, # @param [Integer]
:side_exit_for_pc, # @param [Hash{ Integer => Integer }] { sp_offset => address }
:record_boundary_patch_point, # @param [TrueClass,FalseClass]
)
def initialize(side_exit_for_pc: {}, record_boundary_patch_point: false, **) = super
def insn
Compiler.decode_insn(C.VALUE.new(pc).*)
end
def operand(index, signed: false, ruby: false)
addr = pc + (index + 1) * Fiddle::SIZEOF_VOIDP
value = Fiddle::Pointer.new(addr)[0, Fiddle::SIZEOF_VOIDP].unpack(signed ? 'q' : 'Q')[0]
if ruby
value = C.to_ruby(value)
end
value
end
def at_current_insn?
pc == cfp.pc.to_i
end
def peek_at_local(n)
local_table_size = iseq.body.local_table_size
offset = -C::VM_ENV_DATA_SIZE - local_table_size + n + 1
value = (cfp.ep + offset).*
C.to_ruby(value)
end
def peek_at_stack(depth_from_top)
raise 'not at current insn' unless at_current_insn?
offset = -(1 + depth_from_top)
# rb_rjit_branch_stub_hit updates SP, so you don't need to worry about sp_offset
value = (cfp.sp + offset).*
C.to_ruby(value)
end
def peek_at_self
C.to_ruby(cfp.self)
end
def peek_at_block_handler(level)
ep = ep_at_level(cfp, level:)
ep[C::VM_ENV_DATA_INDEX_SPECVAL]
end
private
def ep_at_level(cfp, level:)
ep = cfp.ep
level.times do
# VM_ENV_PREV_EP
ep = C.VALUE.new(ep[C::VM_ENV_DATA_INDEX_SPECVAL] & ~0x03)
end
ep
end
end
end
share/ruby/ruby_vm/rjit/branch_stub.rb 0000644 00000001557 15173517737 0014131 0 ustar 00 module RubyVM::RJIT
# Branch shapes
Next0 = :Next0 # target0 is a fallthrough
Next1 = :Next1 # target1 is a fallthrough
Default = :Default # neither targets is a fallthrough
class BranchStub < Struct.new(
:iseq, # @param [RubyVM::RJIT::CPointer::Struct_rb_iseq_struct] Branch target ISEQ
:shape, # @param [Symbol] Next0, Next1, or Default
:target0, # @param [RubyVM::RJIT::BranchTarget] First branch target
:target1, # @param [RubyVM::RJIT::BranchTarget,NilClass] Second branch target (optional)
:compile, # @param [Proc] A callback to (re-)generate this branch stub
:start_addr, # @param [Integer] Stub source start address to be re-generated
:end_addr, # @param [Integer] Stub source end address to be re-generated
)
end
class BranchTarget < Struct.new(
:pc,
:ctx,
:address,
)
end
end
share/ruby/ruby_vm/rjit/insn_compiler.rb 0000644 00000625267 15173517737 0014512 0 ustar 00 # frozen_string_literal: true
module RubyVM::RJIT
class InsnCompiler
# struct rb_calling_info. Storing flags instead of ci.
CallingInfo = Struct.new(:argc, :flags, :kwarg, :ci_addr, :send_shift, :block_handler) do
def kw_splat = flags & C::VM_CALL_KW_SPLAT != 0
end
# @param ocb [CodeBlock]
# @param exit_compiler [RubyVM::RJIT::ExitCompiler]
def initialize(cb, ocb, exit_compiler)
@ocb = ocb
@exit_compiler = exit_compiler
@cfunc_codegen_table = {}
register_cfunc_codegen_funcs
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
# @param insn `RubyVM::RJIT::Instruction`
def compile(jit, ctx, asm, insn)
asm.incr_counter(:rjit_insns_count)
stack = ctx.stack_size.times.map do |stack_idx|
ctx.get_opnd_type(StackOpnd[ctx.stack_size - stack_idx - 1]).type
end
locals = jit.iseq.body.local_table_size.times.map do |local_idx|
(ctx.local_types[local_idx] || Type::Unknown).type
end
insn_idx = format('%04d', (jit.pc.to_i - jit.iseq.body.iseq_encoded.to_i) / C.VALUE.size)
asm.comment("Insn: #{insn_idx} #{insn.name} (stack: [#{stack.join(', ')}], locals: [#{locals.join(', ')}])")
# 83/102
case insn.name
when :nop then nop(jit, ctx, asm)
when :getlocal then getlocal(jit, ctx, asm)
when :setlocal then setlocal(jit, ctx, asm)
when :getblockparam then getblockparam(jit, ctx, asm)
# setblockparam
when :getblockparamproxy then getblockparamproxy(jit, ctx, asm)
when :getspecial then getspecial(jit, ctx, asm)
# setspecial
when :getinstancevariable then getinstancevariable(jit, ctx, asm)
when :setinstancevariable then setinstancevariable(jit, ctx, asm)
when :getclassvariable then getclassvariable(jit, ctx, asm)
when :setclassvariable then setclassvariable(jit, ctx, asm)
when :opt_getconstant_path then opt_getconstant_path(jit, ctx, asm)
when :getconstant then getconstant(jit, ctx, asm)
# setconstant
when :getglobal then getglobal(jit, ctx, asm)
# setglobal
when :putnil then putnil(jit, ctx, asm)
when :putself then putself(jit, ctx, asm)
when :putobject then putobject(jit, ctx, asm)
when :putspecialobject then putspecialobject(jit, ctx, asm)
when :putstring then putstring(jit, ctx, asm)
when :concatstrings then concatstrings(jit, ctx, asm)
when :anytostring then anytostring(jit, ctx, asm)
when :toregexp then toregexp(jit, ctx, asm)
when :intern then intern(jit, ctx, asm)
when :newarray then newarray(jit, ctx, asm)
# newarraykwsplat
when :duparray then duparray(jit, ctx, asm)
# duphash
when :expandarray then expandarray(jit, ctx, asm)
when :concatarray then concatarray(jit, ctx, asm)
when :splatarray then splatarray(jit, ctx, asm)
when :newhash then newhash(jit, ctx, asm)
when :newrange then newrange(jit, ctx, asm)
when :pop then pop(jit, ctx, asm)
when :dup then dup(jit, ctx, asm)
when :dupn then dupn(jit, ctx, asm)
when :swap then swap(jit, ctx, asm)
# opt_reverse
when :topn then topn(jit, ctx, asm)
when :setn then setn(jit, ctx, asm)
when :adjuststack then adjuststack(jit, ctx, asm)
when :defined then defined(jit, ctx, asm)
when :definedivar then definedivar(jit, ctx, asm)
# checkmatch
when :checkkeyword then checkkeyword(jit, ctx, asm)
# checktype
# defineclass
# definemethod
# definesmethod
when :send then send(jit, ctx, asm)
when :opt_send_without_block then opt_send_without_block(jit, ctx, asm)
when :objtostring then objtostring(jit, ctx, asm)
when :opt_str_freeze then opt_str_freeze(jit, ctx, asm)
when :opt_nil_p then opt_nil_p(jit, ctx, asm)
# opt_str_uminus
when :opt_newarray_send then opt_newarray_send(jit, ctx, asm)
when :invokesuper then invokesuper(jit, ctx, asm)
when :invokeblock then invokeblock(jit, ctx, asm)
when :leave then leave(jit, ctx, asm)
when :throw then throw(jit, ctx, asm)
when :jump then jump(jit, ctx, asm)
when :branchif then branchif(jit, ctx, asm)
when :branchunless then branchunless(jit, ctx, asm)
when :branchnil then branchnil(jit, ctx, asm)
# once
when :opt_case_dispatch then opt_case_dispatch(jit, ctx, asm)
when :opt_plus then opt_plus(jit, ctx, asm)
when :opt_minus then opt_minus(jit, ctx, asm)
when :opt_mult then opt_mult(jit, ctx, asm)
when :opt_div then opt_div(jit, ctx, asm)
when :opt_mod then opt_mod(jit, ctx, asm)
when :opt_eq then opt_eq(jit, ctx, asm)
when :opt_neq then opt_neq(jit, ctx, asm)
when :opt_lt then opt_lt(jit, ctx, asm)
when :opt_le then opt_le(jit, ctx, asm)
when :opt_gt then opt_gt(jit, ctx, asm)
when :opt_ge then opt_ge(jit, ctx, asm)
when :opt_ltlt then opt_ltlt(jit, ctx, asm)
when :opt_and then opt_and(jit, ctx, asm)
when :opt_or then opt_or(jit, ctx, asm)
when :opt_aref then opt_aref(jit, ctx, asm)
when :opt_aset then opt_aset(jit, ctx, asm)
# opt_aset_with
# opt_aref_with
when :opt_length then opt_length(jit, ctx, asm)
when :opt_size then opt_size(jit, ctx, asm)
when :opt_empty_p then opt_empty_p(jit, ctx, asm)
when :opt_succ then opt_succ(jit, ctx, asm)
when :opt_not then opt_not(jit, ctx, asm)
when :opt_regexpmatch2 then opt_regexpmatch2(jit, ctx, asm)
# invokebuiltin
when :opt_invokebuiltin_delegate then opt_invokebuiltin_delegate(jit, ctx, asm)
when :opt_invokebuiltin_delegate_leave then opt_invokebuiltin_delegate_leave(jit, ctx, asm)
when :getlocal_WC_0 then getlocal_WC_0(jit, ctx, asm)
when :getlocal_WC_1 then getlocal_WC_1(jit, ctx, asm)
when :setlocal_WC_0 then setlocal_WC_0(jit, ctx, asm)
when :setlocal_WC_1 then setlocal_WC_1(jit, ctx, asm)
when :putobject_INT2FIX_0_ then putobject_INT2FIX_0_(jit, ctx, asm)
when :putobject_INT2FIX_1_ then putobject_INT2FIX_1_(jit, ctx, asm)
else CantCompile
end
end
private
#
# Insns
#
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def nop(jit, ctx, asm)
# Do nothing
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getlocal(jit, ctx, asm)
idx = jit.operand(0)
level = jit.operand(1)
jit_getlocal_generic(jit, ctx, asm, idx:, level:)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getlocal_WC_0(jit, ctx, asm)
idx = jit.operand(0)
jit_getlocal_generic(jit, ctx, asm, idx:, level: 0)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getlocal_WC_1(jit, ctx, asm)
idx = jit.operand(0)
jit_getlocal_generic(jit, ctx, asm, idx:, level: 1)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def setlocal(jit, ctx, asm)
idx = jit.operand(0)
level = jit.operand(1)
jit_setlocal_generic(jit, ctx, asm, idx:, level:)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def setlocal_WC_0(jit, ctx, asm)
idx = jit.operand(0)
jit_setlocal_generic(jit, ctx, asm, idx:, level: 0)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def setlocal_WC_1(jit, ctx, asm)
idx = jit.operand(0)
jit_setlocal_generic(jit, ctx, asm, idx:, level: 1)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getblockparam(jit, ctx, asm)
# EP level
level = jit.operand(1)
# Save the PC and SP because we might allocate
jit_prepare_routine_call(jit, ctx, asm)
# A mirror of the interpreter code. Checking for the case
# where it's pushing rb_block_param_proxy.
side_exit = side_exit(jit, ctx)
# Load environment pointer EP from CFP
ep_reg = :rax
jit_get_ep(asm, level, reg: ep_reg)
# Bail when VM_ENV_FLAGS(ep, VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM) is non zero
# FIXME: This is testing bits in the same place that the WB check is testing.
# We should combine these at some point
asm.test([ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_FLAGS], C::VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM)
# If the frame flag has been modified, then the actual proc value is
# already in the EP and we should just use the value.
frame_flag_modified = asm.new_label('frame_flag_modified')
asm.jnz(frame_flag_modified)
# This instruction writes the block handler to the EP. If we need to
# fire a write barrier for the write, then exit (we'll let the
# interpreter handle it so it can fire the write barrier).
# flags & VM_ENV_FLAG_WB_REQUIRED
asm.test([ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_FLAGS], C::VM_ENV_FLAG_WB_REQUIRED)
# if (flags & VM_ENV_FLAG_WB_REQUIRED) != 0
asm.jnz(side_exit)
# Convert the block handler in to a proc
# call rb_vm_bh_to_procval(const rb_execution_context_t *ec, VALUE block_handler)
asm.mov(C_ARGS[0], EC)
# The block handler for the current frame
# note, VM_ASSERT(VM_ENV_LOCAL_P(ep))
asm.mov(C_ARGS[1], [ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL])
asm.call(C.rb_vm_bh_to_procval)
# Load environment pointer EP from CFP (again)
ep_reg = :rcx
jit_get_ep(asm, level, reg: ep_reg)
# Write the value at the environment pointer
idx = jit.operand(0)
offs = -(C.VALUE.size * idx)
asm.mov([ep_reg, offs], C_RET);
# Set the frame modified flag
asm.mov(:rax, [ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_FLAGS]) # flag_check
asm.or(:rax, C::VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM) # modified_flag
asm.mov([ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_FLAGS], :rax)
asm.write_label(frame_flag_modified)
# Push the proc on the stack
stack_ret = ctx.stack_push(Type::Unknown)
ep_reg = :rax
jit_get_ep(asm, level, reg: ep_reg)
asm.mov(:rax, [ep_reg, offs])
asm.mov(stack_ret, :rax)
KeepCompiling
end
# setblockparam
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getblockparamproxy(jit, ctx, asm)
# To get block_handler
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
starting_context = ctx.dup # make a copy for use with jit_chain_guard
# A mirror of the interpreter code. Checking for the case
# where it's pushing rb_block_param_proxy.
side_exit = side_exit(jit, ctx)
# EP level
level = jit.operand(1)
# Peek at the block handler so we can check whether it's nil
comptime_handler = jit.peek_at_block_handler(level)
# When a block handler is present, it should always be a GC-guarded
# pointer (VM_BH_ISEQ_BLOCK_P)
if comptime_handler != 0 && comptime_handler & 0x3 != 0x1
asm.incr_counter(:getblockpp_not_gc_guarded)
return CantCompile
end
# Load environment pointer EP from CFP
ep_reg = :rax
jit_get_ep(asm, level, reg: ep_reg)
# Bail when VM_ENV_FLAGS(ep, VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM) is non zero
asm.test([ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_FLAGS], C::VM_FRAME_FLAG_MODIFIED_BLOCK_PARAM)
asm.jnz(counted_exit(side_exit, :getblockpp_block_param_modified))
# Load the block handler for the current frame
# note, VM_ASSERT(VM_ENV_LOCAL_P(ep))
block_handler = :rax
asm.mov(block_handler, [ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL])
# Specialize compilation for the case where no block handler is present
if comptime_handler == 0
# Bail if there is a block handler
asm.cmp(block_handler, 0)
jit_chain_guard(:jnz, jit, starting_context, asm, counted_exit(side_exit, :getblockpp_block_handler_none))
putobject(jit, ctx, asm, val: Qnil)
else
# Block handler is a tagged pointer. Look at the tag. 0x03 is from VM_BH_ISEQ_BLOCK_P().
asm.and(block_handler, 0x3)
# Bail unless VM_BH_ISEQ_BLOCK_P(bh). This also checks for null.
asm.cmp(block_handler, 0x1)
jit_chain_guard(:jnz, jit, starting_context, asm, counted_exit(side_exit, :getblockpp_not_iseq_block))
# Push rb_block_param_proxy. It's a root, so no need to use jit_mov_gc_ptr.
top = ctx.stack_push(Type::BlockParamProxy)
asm.mov(:rax, C.rb_block_param_proxy)
asm.mov(top, :rax)
end
jump_to_next_insn(jit, ctx, asm)
EndBlock
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getspecial(jit, ctx, asm)
# This takes two arguments, key and type
# key is only used when type == 0
# A non-zero type determines which type of backref to fetch
#rb_num_t key = jit.jit_get_arg(0);
rtype = jit.operand(1)
if rtype == 0
# not yet implemented
return CantCompile;
elsif rtype & 0x01 != 0
# Fetch a "special" backref based on a char encoded by shifting by 1
# Can raise if matchdata uninitialized
jit_prepare_routine_call(jit, ctx, asm)
# call rb_backref_get()
asm.comment('rb_backref_get')
asm.call(C.rb_backref_get)
asm.mov(C_ARGS[0], C_RET) # backref
case [rtype >> 1].pack('c')
in ?&
asm.comment("rb_reg_last_match")
asm.call(C.rb_reg_last_match)
in ?`
asm.comment("rb_reg_match_pre")
asm.call(C.rb_reg_match_pre)
in ?'
asm.comment("rb_reg_match_post")
asm.call(C.rb_reg_match_post)
in ?+
asm.comment("rb_reg_match_last")
asm.call(C.rb_reg_match_last)
end
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
KeepCompiling
else
# Fetch the N-th match from the last backref based on type shifted by 1
# Can raise if matchdata uninitialized
jit_prepare_routine_call(jit, ctx, asm)
# call rb_backref_get()
asm.comment('rb_backref_get')
asm.call(C.rb_backref_get)
# rb_reg_nth_match((int)(type >> 1), backref);
asm.comment('rb_reg_nth_match')
asm.mov(C_ARGS[0], rtype >> 1)
asm.mov(C_ARGS[1], C_RET) # backref
asm.call(C.rb_reg_nth_match)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
end
# setspecial
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getinstancevariable(jit, ctx, asm)
# Specialize on a compile-time receiver, and split a block for chain guards
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
id = jit.operand(0)
comptime_obj = jit.peek_at_self
jit_getivar(jit, ctx, asm, comptime_obj, id, nil, SelfOpnd)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def setinstancevariable(jit, ctx, asm)
starting_context = ctx.dup # make a copy for use with jit_chain_guard
# Defer compilation so we can specialize on a runtime `self`
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
ivar_name = jit.operand(0)
comptime_receiver = jit.peek_at_self
# If the comptime receiver is frozen, writing an IV will raise an exception
# and we don't want to JIT code to deal with that situation.
if C.rb_obj_frozen_p(comptime_receiver)
asm.incr_counter(:setivar_frozen)
return CantCompile
end
# Check if the comptime receiver is a T_OBJECT
receiver_t_object = C::BUILTIN_TYPE(comptime_receiver) == C::T_OBJECT
# If the receiver isn't a T_OBJECT, or uses a custom allocator,
# then just write out the IV write as a function call.
# too-complex shapes can't use index access, so we use rb_ivar_get for them too.
if !receiver_t_object || shape_too_complex?(comptime_receiver) || ctx.chain_depth >= 10
asm.comment('call rb_vm_setinstancevariable')
ic = jit.operand(1)
# The function could raise exceptions.
# Note that this modifies REG_SP, which is why we do it first
jit_prepare_routine_call(jit, ctx, asm)
# Get the operands from the stack
val_opnd = ctx.stack_pop(1)
# Call rb_vm_setinstancevariable(iseq, obj, id, val, ic);
asm.mov(:rdi, jit.iseq.to_i)
asm.mov(:rsi, [CFP, C.rb_control_frame_t.offsetof(:self)])
asm.mov(:rdx, ivar_name)
asm.mov(:rcx, val_opnd)
asm.mov(:r8, ic)
asm.call(C.rb_vm_setinstancevariable)
else
# Get the iv index
shape_id = C.rb_shape_get_shape_id(comptime_receiver)
ivar_index = C.rb_shape_get_iv_index(shape_id, ivar_name)
# Get the receiver
asm.mov(:rax, [CFP, C.rb_control_frame_t.offsetof(:self)])
# Generate a side exit
side_exit = side_exit(jit, ctx)
# Upgrade type
guard_object_is_heap(jit, ctx, asm, :rax, SelfOpnd, :setivar_not_heap)
asm.comment('guard shape')
asm.cmp(DwordPtr[:rax, C.rb_shape_id_offset], shape_id)
megamorphic_side_exit = counted_exit(side_exit, :setivar_megamorphic)
jit_chain_guard(:jne, jit, starting_context, asm, megamorphic_side_exit)
# If we don't have an instance variable index, then we need to
# transition out of the current shape.
if ivar_index.nil?
shape = C.rb_shape_get_shape_by_id(shape_id)
current_capacity = shape.capacity
dest_shape = C.rb_shape_get_next_no_warnings(shape, comptime_receiver, ivar_name)
new_shape_id = C.rb_shape_id(dest_shape)
if new_shape_id == C::OBJ_TOO_COMPLEX_SHAPE_ID
asm.incr_counter(:setivar_too_complex)
return CantCompile
end
ivar_index = shape.next_iv_index
# If the new shape has a different capacity, we need to
# reallocate the object.
needs_extension = dest_shape.capacity != shape.capacity
if needs_extension
# Generate the C call so that runtime code will increase
# the capacity and set the buffer.
asm.mov(C_ARGS[0], :rax)
asm.mov(C_ARGS[1], current_capacity)
asm.mov(C_ARGS[2], dest_shape.capacity)
asm.call(C.rb_ensure_iv_list_size)
# Load the receiver again after the function call
asm.mov(:rax, [CFP, C.rb_control_frame_t.offsetof(:self)])
end
write_val = ctx.stack_pop(1)
jit_write_iv(asm, comptime_receiver, :rax, :rcx, ivar_index, write_val, needs_extension)
# Store the new shape
asm.comment('write shape')
asm.mov(:rax, [CFP, C.rb_control_frame_t.offsetof(:self)]) # reload after jit_write_iv
asm.mov(DwordPtr[:rax, C.rb_shape_id_offset], new_shape_id)
else
# If the iv index already exists, then we don't need to
# transition to a new shape. The reason is because we find
# the iv index by searching up the shape tree. If we've
# made the transition already, then there's no reason to
# update the shape on the object. Just set the IV.
write_val = ctx.stack_pop(1)
jit_write_iv(asm, comptime_receiver, :rax, :rcx, ivar_index, write_val, false)
end
skip_wb = asm.new_label('skip_wb')
# If the value we're writing is an immediate, we don't need to WB
asm.test(write_val, C::RUBY_IMMEDIATE_MASK)
asm.jnz(skip_wb)
# If the value we're writing is nil or false, we don't need to WB
asm.cmp(write_val, Qnil)
asm.jbe(skip_wb)
asm.comment('write barrier')
asm.mov(C_ARGS[0], [CFP, C.rb_control_frame_t.offsetof(:self)]) # reload after jit_write_iv
asm.mov(C_ARGS[1], write_val)
asm.call(C.rb_gc_writebarrier)
asm.write_label(skip_wb)
end
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getclassvariable(jit, ctx, asm)
# rb_vm_getclassvariable can raise exceptions.
jit_prepare_routine_call(jit, ctx, asm)
asm.mov(C_ARGS[0], [CFP, C.rb_control_frame_t.offsetof(:iseq)])
asm.mov(C_ARGS[1], CFP)
asm.mov(C_ARGS[2], jit.operand(0))
asm.mov(C_ARGS[3], jit.operand(1))
asm.call(C.rb_vm_getclassvariable)
top = ctx.stack_push(Type::Unknown)
asm.mov(top, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def setclassvariable(jit, ctx, asm)
# rb_vm_setclassvariable can raise exceptions.
jit_prepare_routine_call(jit, ctx, asm)
asm.mov(C_ARGS[0], [CFP, C.rb_control_frame_t.offsetof(:iseq)])
asm.mov(C_ARGS[1], CFP)
asm.mov(C_ARGS[2], jit.operand(0))
asm.mov(C_ARGS[3], ctx.stack_pop(1))
asm.mov(C_ARGS[4], jit.operand(1))
asm.call(C.rb_vm_setclassvariable)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_getconstant_path(jit, ctx, asm)
# Cut the block for invalidation
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
ic = C.iseq_inline_constant_cache.new(jit.operand(0))
idlist = ic.segments
# Make sure there is an exit for this block as the interpreter might want
# to invalidate this block from rb_rjit_constant_ic_update().
# For now, we always take an entry exit even if it was a side exit.
Invariants.ensure_block_entry_exit(jit, cause: 'opt_getconstant_path')
# See vm_ic_hit_p(). The same conditions are checked in yjit_constant_ic_update().
ice = ic.entry
if ice.nil?
# In this case, leave a block that unconditionally side exits
# for the interpreter to invalidate.
asm.incr_counter(:optgetconst_not_cached)
return CantCompile
end
if ice.ic_cref # with cref
# Cache is keyed on a certain lexical scope. Use the interpreter's cache.
side_exit = side_exit(jit, ctx)
# Call function to verify the cache. It doesn't allocate or call methods.
asm.mov(C_ARGS[0], ic.to_i)
asm.mov(C_ARGS[1], [CFP, C.rb_control_frame_t.offsetof(:ep)])
asm.call(C.rb_vm_ic_hit_p)
# Check the result. SysV only specifies one byte for _Bool return values,
# so it's important we only check one bit to ignore the higher bits in the register.
asm.test(C_RET, 1)
asm.jz(counted_exit(side_exit, :optgetconst_cache_miss))
asm.mov(:rax, ic.to_i) # inline_cache
asm.mov(:rax, [:rax, C.iseq_inline_constant_cache.offsetof(:entry)]) # ic_entry
asm.mov(:rax, [:rax, C.iseq_inline_constant_cache_entry.offsetof(:value)]) # ic_entry_val
# Push ic->entry->value
stack_top = ctx.stack_push(Type::Unknown)
asm.mov(stack_top, :rax)
else # without cref
# TODO: implement this
# Optimize for single ractor mode.
# if !assume_single_ractor_mode(jit, ocb)
# return CantCompile
# end
# Invalidate output code on any constant writes associated with
# constants referenced within the current block.
Invariants.assume_stable_constant_names(jit, idlist)
putobject(jit, ctx, asm, val: ice.value)
end
jump_to_next_insn(jit, ctx, asm)
EndBlock
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getconstant(jit, ctx, asm)
id = jit.operand(0)
# vm_get_ev_const can raise exceptions.
jit_prepare_routine_call(jit, ctx, asm)
allow_nil_opnd = ctx.stack_pop(1)
klass_opnd = ctx.stack_pop(1)
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], klass_opnd)
asm.mov(C_ARGS[2], id)
asm.mov(C_ARGS[3], allow_nil_opnd)
asm.call(C.rb_vm_get_ev_const)
top = ctx.stack_push(Type::Unknown)
asm.mov(top, C_RET)
KeepCompiling
end
# setconstant
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def getglobal(jit, ctx, asm)
gid = jit.operand(0)
# Save the PC and SP because we might make a Ruby call for warning
jit_prepare_routine_call(jit, ctx, asm)
asm.mov(C_ARGS[0], gid)
asm.call(C.rb_gvar_get)
top = ctx.stack_push(Type::Unknown)
asm.mov(top, C_RET)
KeepCompiling
end
# setglobal
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def putnil(jit, ctx, asm)
putobject(jit, ctx, asm, val: Qnil)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def putself(jit, ctx, asm)
stack_top = ctx.stack_push_self
asm.mov(:rax, [CFP, C.rb_control_frame_t.offsetof(:self)])
asm.mov(stack_top, :rax)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def putobject(jit, ctx, asm, val: jit.operand(0))
# Push it to the stack
val_type = Type.from(C.to_ruby(val))
stack_top = ctx.stack_push(val_type)
if asm.imm32?(val)
asm.mov(stack_top, val)
else # 64-bit immediates can't be directly written to memory
asm.mov(:rax, val)
asm.mov(stack_top, :rax)
end
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def putspecialobject(jit, ctx, asm)
object_type = jit.operand(0)
if object_type == C::VM_SPECIAL_OBJECT_VMCORE
stack_top = ctx.stack_push(Type::UnknownHeap)
asm.mov(:rax, C.rb_mRubyVMFrozenCore)
asm.mov(stack_top, :rax)
KeepCompiling
else
# TODO: implement for VM_SPECIAL_OBJECT_CBASE and
# VM_SPECIAL_OBJECT_CONST_BASE
CantCompile
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def putstring(jit, ctx, asm)
put_val = jit.operand(0, ruby: true)
# Save the PC and SP because the callee will allocate
jit_prepare_routine_call(jit, ctx, asm)
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], to_value(put_val))
asm.call(C.rb_ec_str_resurrect)
stack_top = ctx.stack_push(Type::TString)
asm.mov(stack_top, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def concatstrings(jit, ctx, asm)
n = jit.operand(0)
# Save the PC and SP because we are allocating
jit_prepare_routine_call(jit, ctx, asm)
asm.lea(:rax, ctx.sp_opnd(-C.VALUE.size * n))
# call rb_str_concat_literals(size_t n, const VALUE *strings);
asm.mov(C_ARGS[0], n)
asm.mov(C_ARGS[1], :rax)
asm.call(C.rb_str_concat_literals)
ctx.stack_pop(n)
stack_ret = ctx.stack_push(Type::TString)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def anytostring(jit, ctx, asm)
# Save the PC and SP since we might call #to_s
jit_prepare_routine_call(jit, ctx, asm)
str = ctx.stack_pop(1)
val = ctx.stack_pop(1)
asm.mov(C_ARGS[0], str)
asm.mov(C_ARGS[1], val)
asm.call(C.rb_obj_as_string_result)
# Push the return value
stack_ret = ctx.stack_push(Type::TString)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def toregexp(jit, ctx, asm)
opt = jit.operand(0, signed: true)
cnt = jit.operand(1)
# Save the PC and SP because this allocates an object and could
# raise an exception.
jit_prepare_routine_call(jit, ctx, asm)
asm.lea(:rax, ctx.sp_opnd(-C.VALUE.size * cnt)) # values_ptr
ctx.stack_pop(cnt)
asm.mov(C_ARGS[0], 0)
asm.mov(C_ARGS[1], cnt)
asm.mov(C_ARGS[2], :rax) # values_ptr
asm.call(C.rb_ary_tmp_new_from_values)
# Save the array so we can clear it later
asm.push(C_RET)
asm.push(C_RET) # Alignment
asm.mov(C_ARGS[0], C_RET)
asm.mov(C_ARGS[1], opt)
asm.call(C.rb_reg_new_ary)
# The actual regex is in RAX now. Pop the temp array from
# rb_ary_tmp_new_from_values into C arg regs so we can clear it
asm.pop(:rcx) # Alignment
asm.pop(:rcx) # ary
# The value we want to push on the stack is in RAX right now
stack_ret = ctx.stack_push(Type::UnknownHeap)
asm.mov(stack_ret, C_RET)
# Clear the temp array.
asm.mov(C_ARGS[0], :rcx) # ary
asm.call(C.rb_ary_clear)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def intern(jit, ctx, asm)
# Save the PC and SP because we might allocate
jit_prepare_routine_call(jit, ctx, asm);
str = ctx.stack_pop(1)
asm.mov(C_ARGS[0], str)
asm.call(C.rb_str_intern)
# Push the return value
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def newarray(jit, ctx, asm)
n = jit.operand(0)
# Save the PC and SP because we are allocating
jit_prepare_routine_call(jit, ctx, asm)
# If n is 0, then elts is never going to be read, so we can just pass null
if n == 0
values_ptr = 0
else
asm.comment('load pointer to array elts')
offset_magnitude = C.VALUE.size * n
values_opnd = ctx.sp_opnd(-(offset_magnitude))
asm.lea(:rax, values_opnd)
values_ptr = :rax
end
# call rb_ec_ary_new_from_values(struct rb_execution_context_struct *ec, long n, const VALUE *elts);
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], n)
asm.mov(C_ARGS[2], values_ptr)
asm.call(C.rb_ec_ary_new_from_values)
ctx.stack_pop(n)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# newarraykwsplat
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def duparray(jit, ctx, asm)
ary = jit.operand(0)
# Save the PC and SP because we are allocating
jit_prepare_routine_call(jit, ctx, asm)
# call rb_ary_resurrect(VALUE ary);
asm.comment('call rb_ary_resurrect')
asm.mov(C_ARGS[0], ary)
asm.call(C.rb_ary_resurrect)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# duphash
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def expandarray(jit, ctx, asm)
# Both arguments are rb_num_t which is unsigned
num = jit.operand(0)
flag = jit.operand(1)
# If this instruction has the splat flag, then bail out.
if flag & 0x01 != 0
asm.incr_counter(:expandarray_splat)
return CantCompile
end
# If this instruction has the postarg flag, then bail out.
if flag & 0x02 != 0
asm.incr_counter(:expandarray_postarg)
return CantCompile
end
side_exit = side_exit(jit, ctx)
array_opnd = ctx.stack_opnd(0)
array_stack_opnd = StackOpnd[0]
# num is the number of requested values. If there aren't enough in the
# array then we're going to push on nils.
if ctx.get_opnd_type(array_stack_opnd) == Type::Nil
ctx.stack_pop(1) # pop after using the type info
# special case for a, b = nil pattern
# push N nils onto the stack
num.times do
push_opnd = ctx.stack_push(Type::Nil)
asm.mov(push_opnd, Qnil)
end
return KeepCompiling
end
# Move the array from the stack and check that it's an array.
asm.mov(:rax, array_opnd)
guard_object_is_array(jit, ctx, asm, :rax, :rcx, array_stack_opnd, :expandarray_not_array)
ctx.stack_pop(1) # pop after using the type info
# If we don't actually want any values, then just return.
if num == 0
return KeepCompiling
end
jit_array_len(asm, :rax, :rcx)
# Only handle the case where the number of values in the array is greater
# than or equal to the number of values requested.
asm.cmp(:rcx, num)
asm.jl(counted_exit(side_exit, :expandarray_rhs_too_small))
# Conditionally load the address of the heap array into REG1.
# (struct RArray *)(obj)->as.heap.ptr
#asm.mov(:rax, array_opnd)
asm.mov(:rcx, [:rax, C.RBasic.offsetof(:flags)])
asm.test(:rcx, C::RARRAY_EMBED_FLAG);
asm.mov(:rcx, [:rax, C.RArray.offsetof(:as, :heap, :ptr)])
# Load the address of the embedded array into REG1.
# (struct RArray *)(obj)->as.ary
asm.lea(:rax, [:rax, C.RArray.offsetof(:as, :ary)])
asm.cmovnz(:rcx, :rax)
# Loop backward through the array and push each element onto the stack.
(num - 1).downto(0).each do |i|
top = ctx.stack_push(Type::Unknown)
asm.mov(:rax, [:rcx, i * C.VALUE.size])
asm.mov(top, :rax)
end
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def concatarray(jit, ctx, asm)
# Save the PC and SP because the callee may allocate
# Note that this modifies REG_SP, which is why we do it first
jit_prepare_routine_call(jit, ctx, asm)
# Get the operands from the stack
ary2st_opnd = ctx.stack_pop(1)
ary1_opnd = ctx.stack_pop(1)
# Call rb_vm_concat_array(ary1, ary2st)
asm.mov(C_ARGS[0], ary1_opnd)
asm.mov(C_ARGS[1], ary2st_opnd)
asm.call(C.rb_vm_concat_array)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def splatarray(jit, ctx, asm)
flag = jit.operand(0)
# Save the PC and SP because the callee may allocate
# Note that this modifies REG_SP, which is why we do it first
jit_prepare_routine_call(jit, ctx, asm)
# Get the operands from the stack
ary_opnd = ctx.stack_pop(1)
# Call rb_vm_splat_array(flag, ary)
asm.mov(C_ARGS[0], flag)
asm.mov(C_ARGS[1], ary_opnd)
asm.call(C.rb_vm_splat_array)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def newhash(jit, ctx, asm)
num = jit.operand(0)
# Save the PC and SP because we are allocating
jit_prepare_routine_call(jit, ctx, asm)
if num != 0
# val = rb_hash_new_with_size(num / 2);
asm.mov(C_ARGS[0], num / 2)
asm.call(C.rb_hash_new_with_size)
# Save the allocated hash as we want to push it after insertion
asm.push(C_RET)
asm.push(C_RET) # x86 alignment
# Get a pointer to the values to insert into the hash
asm.lea(:rcx, ctx.stack_opnd(num - 1))
# rb_hash_bulk_insert(num, STACK_ADDR_FROM_TOP(num), val);
asm.mov(C_ARGS[0], num)
asm.mov(C_ARGS[1], :rcx)
asm.mov(C_ARGS[2], C_RET)
asm.call(C.rb_hash_bulk_insert)
asm.pop(:rax)
asm.pop(:rax)
ctx.stack_pop(num)
stack_ret = ctx.stack_push(Type::Hash)
asm.mov(stack_ret, :rax)
else
# val = rb_hash_new();
asm.call(C.rb_hash_new)
stack_ret = ctx.stack_push(Type::Hash)
asm.mov(stack_ret, C_RET)
end
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def newrange(jit, ctx, asm)
flag = jit.operand(0)
# rb_range_new() allocates and can raise
jit_prepare_routine_call(jit, ctx, asm)
# val = rb_range_new(low, high, (int)flag);
asm.mov(C_ARGS[0], ctx.stack_opnd(1))
asm.mov(C_ARGS[1], ctx.stack_opnd(0))
asm.mov(C_ARGS[2], flag)
asm.call(C.rb_range_new)
ctx.stack_pop(2)
stack_ret = ctx.stack_push(Type::UnknownHeap)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def pop(jit, ctx, asm)
ctx.stack_pop
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def dup(jit, ctx, asm)
dup_val = ctx.stack_opnd(0)
mapping, tmp_type = ctx.get_opnd_mapping(StackOpnd[0])
loc0 = ctx.stack_push_mapping([mapping, tmp_type])
asm.mov(:rax, dup_val)
asm.mov(loc0, :rax)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def dupn(jit, ctx, asm)
n = jit.operand(0)
# In practice, seems to be only used for n==2
if n != 2
return CantCompile
end
opnd1 = ctx.stack_opnd(1)
opnd0 = ctx.stack_opnd(0)
mapping1 = ctx.get_opnd_mapping(StackOpnd[1])
mapping0 = ctx.get_opnd_mapping(StackOpnd[0])
dst1 = ctx.stack_push_mapping(mapping1)
asm.mov(:rax, opnd1)
asm.mov(dst1, :rax)
dst0 = ctx.stack_push_mapping(mapping0)
asm.mov(:rax, opnd0)
asm.mov(dst0, :rax)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def swap(jit, ctx, asm)
stack_swap(jit, ctx, asm, 0, 1)
KeepCompiling
end
# opt_reverse
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def topn(jit, ctx, asm)
n = jit.operand(0)
top_n_val = ctx.stack_opnd(n)
mapping = ctx.get_opnd_mapping(StackOpnd[n])
loc0 = ctx.stack_push_mapping(mapping)
asm.mov(:rax, top_n_val)
asm.mov(loc0, :rax)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def setn(jit, ctx, asm)
n = jit.operand(0)
top_val = ctx.stack_pop(0)
dst_opnd = ctx.stack_opnd(n)
asm.mov(:rax, top_val)
asm.mov(dst_opnd, :rax)
mapping = ctx.get_opnd_mapping(StackOpnd[0])
ctx.set_opnd_mapping(StackOpnd[n], mapping)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def adjuststack(jit, ctx, asm)
n = jit.operand(0)
ctx.stack_pop(n)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def defined(jit, ctx, asm)
op_type = jit.operand(0)
obj = jit.operand(1, ruby: true)
pushval = jit.operand(2, ruby: true)
# Save the PC and SP because the callee may allocate
# Note that this modifies REG_SP, which is why we do it first
jit_prepare_routine_call(jit, ctx, asm)
# Get the operands from the stack
v_opnd = ctx.stack_pop(1)
# Call vm_defined(ec, reg_cfp, op_type, obj, v)
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], CFP)
asm.mov(C_ARGS[2], op_type)
asm.mov(C_ARGS[3], to_value(obj))
asm.mov(C_ARGS[4], v_opnd)
asm.call(C.rb_vm_defined)
asm.test(C_RET, 255)
asm.mov(:rax, Qnil)
asm.mov(:rcx, to_value(pushval))
asm.cmovnz(:rax, :rcx)
# Push the return value onto the stack
out_type = if C::SPECIAL_CONST_P(pushval)
Type::UnknownImm
else
Type::Unknown
end
stack_ret = ctx.stack_push(out_type)
asm.mov(stack_ret, :rax)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def definedivar(jit, ctx, asm)
# Defer compilation so we can specialize base on a runtime receiver
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
ivar_name = jit.operand(0)
# Value that will be pushed on the stack if the ivar is defined. In practice this is always the
# string "instance-variable". If the ivar is not defined, nil will be pushed instead.
pushval = jit.operand(2, ruby: true)
# Get the receiver
recv = :rcx
asm.mov(recv, [CFP, C.rb_control_frame_t.offsetof(:self)])
# Specialize base on compile time values
comptime_receiver = jit.peek_at_self
if shape_too_complex?(comptime_receiver)
# Fall back to calling rb_ivar_defined
# Save the PC and SP because the callee may allocate
# Note that this modifies REG_SP, which is why we do it first
jit_prepare_routine_call(jit, ctx, asm) # clobbers :rax
# Call rb_ivar_defined(recv, ivar_name)
asm.mov(C_ARGS[0], recv)
asm.mov(C_ARGS[1], ivar_name)
asm.call(C.rb_ivar_defined)
# if (rb_ivar_defined(recv, ivar_name)) {
# val = pushval;
# }
asm.test(C_RET, 255)
asm.mov(:rax, Qnil)
asm.mov(:rcx, to_value(pushval))
asm.cmovnz(:rax, :rcx)
# Push the return value onto the stack
out_type = C::SPECIAL_CONST_P(pushval) ? Type::UnknownImm : Type::Unknown
stack_ret = ctx.stack_push(out_type)
asm.mov(stack_ret, :rax)
return KeepCompiling
end
shape_id = C.rb_shape_get_shape_id(comptime_receiver)
ivar_exists = C.rb_shape_get_iv_index(shape_id, ivar_name)
side_exit = side_exit(jit, ctx)
# Guard heap object (recv_opnd must be used before stack_pop)
guard_object_is_heap(jit, ctx, asm, recv, SelfOpnd)
shape_opnd = DwordPtr[recv, C.rb_shape_id_offset]
asm.comment('guard shape')
asm.cmp(shape_opnd, shape_id)
jit_chain_guard(:jne, jit, ctx, asm, side_exit)
result = ivar_exists ? C.to_value(pushval) : Qnil
putobject(jit, ctx, asm, val: result)
# Jump to next instruction. This allows guard chains to share the same successor.
jump_to_next_insn(jit, ctx, asm)
return EndBlock
end
# checkmatch
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def checkkeyword(jit, ctx, asm)
# When a keyword is unspecified past index 32, a hash will be used
# instead. This can only happen in iseqs taking more than 32 keywords.
if jit.iseq.body.param.keyword.num >= 32
return CantCompile
end
# The EP offset to the undefined bits local
bits_offset = jit.operand(0)
# The index of the keyword we want to check
index = jit.operand(1, signed: true)
# Load environment pointer EP
ep_reg = :rax
jit_get_ep(asm, 0, reg: ep_reg)
# VALUE kw_bits = *(ep - bits)
bits_opnd = [ep_reg, C.VALUE.size * -bits_offset]
# unsigned int b = (unsigned int)FIX2ULONG(kw_bits);
# if ((b & (0x01 << idx))) {
#
# We can skip the FIX2ULONG conversion by shifting the bit we test
bit_test = 0x01 << (index + 1)
asm.test(bits_opnd, bit_test)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.cmovz(:rax, :rcx)
stack_ret = ctx.stack_push(Type::UnknownImm)
asm.mov(stack_ret, :rax)
KeepCompiling
end
# checktype
# defineclass
# definemethod
# definesmethod
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def send(jit, ctx, asm)
# Specialize on a compile-time receiver, and split a block for chain guards
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
cd = C.rb_call_data.new(jit.operand(0))
blockiseq = jit.operand(1)
# calling->ci
mid = C.vm_ci_mid(cd.ci)
calling = build_calling(ci: cd.ci, block_handler: blockiseq)
# vm_sendish
cme, comptime_recv_klass = jit_search_method(jit, ctx, asm, mid, calling)
if cme == CantCompile
return CantCompile
end
jit_call_general(jit, ctx, asm, mid, calling, cme, comptime_recv_klass)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_send_without_block(jit, ctx, asm, cd: C.rb_call_data.new(jit.operand(0)))
# Specialize on a compile-time receiver, and split a block for chain guards
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
# calling->ci
mid = C.vm_ci_mid(cd.ci)
calling = build_calling(ci: cd.ci, block_handler: C::VM_BLOCK_HANDLER_NONE)
# vm_sendish
cme, comptime_recv_klass = jit_search_method(jit, ctx, asm, mid, calling)
if cme == CantCompile
return CantCompile
end
jit_call_general(jit, ctx, asm, mid, calling, cme, comptime_recv_klass)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def objtostring(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
recv = ctx.stack_opnd(0)
comptime_recv = jit.peek_at_stack(0)
if C.RB_TYPE_P(comptime_recv, C::RUBY_T_STRING)
side_exit = side_exit(jit, ctx)
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_recv), recv, StackOpnd[0], comptime_recv, side_exit)
# No work needed. The string value is already on the top of the stack.
KeepCompiling
else
cd = C.rb_call_data.new(jit.operand(0))
opt_send_without_block(jit, ctx, asm, cd:)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_str_freeze(jit, ctx, asm)
unless Invariants.assume_bop_not_redefined(jit, C::STRING_REDEFINED_OP_FLAG, C::BOP_FREEZE)
return CantCompile;
end
str = jit.operand(0, ruby: true)
# Push the return value onto the stack
stack_ret = ctx.stack_push(Type::CString)
asm.mov(:rax, to_value(str))
asm.mov(stack_ret, :rax)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_nil_p(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# opt_str_uminus
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_newarray_send(jit, ctx, asm)
type = C.ID2SYM jit.operand(1)
case type
when :min then opt_newarray_min(jit, ctx, asm)
when :max then opt_newarray_max(jit, ctx, asm)
when :hash then opt_newarray_hash(jit, ctx, asm)
else
return CantCompile
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_newarray_min(jit, ctx, asm)
num = jit.operand(0)
# Save the PC and SP because we may allocate
jit_prepare_routine_call(jit, ctx, asm)
offset_magnitude = C.VALUE.size * num
values_opnd = ctx.sp_opnd(-offset_magnitude)
asm.lea(:rax, values_opnd)
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], num)
asm.mov(C_ARGS[2], :rax)
asm.call(C.rb_vm_opt_newarray_min)
ctx.stack_pop(num)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_newarray_max(jit, ctx, asm)
num = jit.operand(0)
# Save the PC and SP because we may allocate
jit_prepare_routine_call(jit, ctx, asm)
offset_magnitude = C.VALUE.size * num
values_opnd = ctx.sp_opnd(-offset_magnitude)
asm.lea(:rax, values_opnd)
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], num)
asm.mov(C_ARGS[2], :rax)
asm.call(C.rb_vm_opt_newarray_max)
ctx.stack_pop(num)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_newarray_hash(jit, ctx, asm)
num = jit.operand(0)
# Save the PC and SP because we may allocate
jit_prepare_routine_call(jit, ctx, asm)
offset_magnitude = C.VALUE.size * num
values_opnd = ctx.sp_opnd(-offset_magnitude)
asm.lea(:rax, values_opnd)
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], num)
asm.mov(C_ARGS[2], :rax)
asm.call(C.rb_vm_opt_newarray_hash)
ctx.stack_pop(num)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def invokesuper(jit, ctx, asm)
cd = C.rb_call_data.new(jit.operand(0))
block = jit.operand(1)
# Defer compilation so we can specialize on class of receiver
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
me = C.rb_vm_frame_method_entry(jit.cfp)
if me.nil?
return CantCompile
end
# FIXME: We should track and invalidate this block when this cme is invalidated
current_defined_class = me.defined_class
mid = me.def.original_id
if me.to_i != C.rb_callable_method_entry(current_defined_class, me.called_id).to_i
# Though we likely could generate this call, as we are only concerned
# with the method entry remaining valid, assume_method_lookup_stable
# below requires that the method lookup matches as well
return CantCompile
end
# vm_search_normal_superclass
rbasic_klass = C.to_ruby(C.RBasic.new(C.to_value(current_defined_class)).klass)
if C::BUILTIN_TYPE(current_defined_class) == C::RUBY_T_ICLASS && C::BUILTIN_TYPE(rbasic_klass) == C::RUBY_T_MODULE && \
C::FL_TEST_RAW(rbasic_klass, C::RMODULE_IS_REFINEMENT)
return CantCompile
end
comptime_superclass = C.rb_class_get_superclass(C.RCLASS_ORIGIN(current_defined_class))
ci = cd.ci
argc = C.vm_ci_argc(ci)
ci_flags = C.vm_ci_flag(ci)
# Don't JIT calls that aren't simple
# Note, not using VM_CALL_ARGS_SIMPLE because sometimes we pass a block.
if ci_flags & C::VM_CALL_KWARG != 0
asm.incr_counter(:send_keywords)
return CantCompile
end
if ci_flags & C::VM_CALL_KW_SPLAT != 0
asm.incr_counter(:send_kw_splat)
return CantCompile
end
if ci_flags & C::VM_CALL_ARGS_BLOCKARG != 0
asm.incr_counter(:send_block_arg)
return CantCompile
end
# Ensure we haven't rebound this method onto an incompatible class.
# In the interpreter we try to avoid making this check by performing some
# cheaper calculations first, but since we specialize on the method entry
# and so only have to do this once at compile time this is fine to always
# check and side exit.
comptime_recv = jit.peek_at_stack(argc)
unless C.obj_is_kind_of(comptime_recv, current_defined_class)
return CantCompile
end
# Do method lookup
cme = C.rb_callable_method_entry(comptime_superclass, mid)
if cme.nil?
return CantCompile
end
# Check that we'll be able to write this method dispatch before generating checks
cme_def_type = cme.def.type
if cme_def_type != C::VM_METHOD_TYPE_ISEQ && cme_def_type != C::VM_METHOD_TYPE_CFUNC
# others unimplemented
return CantCompile
end
asm.comment('guard known me')
lep_opnd = :rax
jit_get_lep(jit, asm, reg: lep_opnd)
ep_me_opnd = [lep_opnd, C.VALUE.size * C::VM_ENV_DATA_INDEX_ME_CREF]
asm.mov(:rcx, me.to_i)
asm.cmp(ep_me_opnd, :rcx)
asm.jne(counted_exit(side_exit(jit, ctx), :invokesuper_me_changed))
if block == C::VM_BLOCK_HANDLER_NONE
# Guard no block passed
# rb_vm_frame_block_handler(GET_EC()->cfp) == VM_BLOCK_HANDLER_NONE
# note, we assume VM_ASSERT(VM_ENV_LOCAL_P(ep))
#
# TODO: this could properly forward the current block handler, but
# would require changes to gen_send_*
asm.comment('guard no block given')
ep_specval_opnd = [lep_opnd, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL]
asm.cmp(ep_specval_opnd, C::VM_BLOCK_HANDLER_NONE)
asm.jne(counted_exit(side_exit(jit, ctx), :invokesuper_block))
end
# We need to assume that both our current method entry and the super
# method entry we invoke remain stable
Invariants.assume_method_lookup_stable(jit, me)
Invariants.assume_method_lookup_stable(jit, cme)
# Method calls may corrupt types
ctx.clear_local_types
calling = build_calling(ci:, block_handler: block)
case cme_def_type
in C::VM_METHOD_TYPE_ISEQ
iseq = def_iseq_ptr(cme.def)
frame_type = C::VM_FRAME_MAGIC_METHOD | C::VM_ENV_FLAG_LOCAL
jit_call_iseq(jit, ctx, asm, cme, calling, iseq, frame_type:)
in C::VM_METHOD_TYPE_CFUNC
jit_call_cfunc(jit, ctx, asm, cme, calling)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def invokeblock(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
# Get call info
cd = C.rb_call_data.new(jit.operand(0))
calling = build_calling(ci: cd.ci, block_handler: :captured)
# Get block_handler
cfp = jit.cfp
lep = C.rb_vm_ep_local_ep(cfp.ep)
comptime_handler = lep[C::VM_ENV_DATA_INDEX_SPECVAL]
# Handle each block_handler type
if comptime_handler == C::VM_BLOCK_HANDLER_NONE # no block given
asm.incr_counter(:invokeblock_none)
CantCompile
elsif comptime_handler & 0x3 == 0x1 # VM_BH_ISEQ_BLOCK_P
asm.comment('get local EP')
ep_reg = :rax
jit_get_lep(jit, asm, reg: ep_reg)
asm.mov(:rax, [ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL]) # block_handler_opnd
asm.comment('guard block_handler type')
side_exit = side_exit(jit, ctx)
asm.mov(:rcx, :rax)
asm.and(:rcx, 0x3) # block_handler is a tagged pointer
asm.cmp(:rcx, 0x1) # VM_BH_ISEQ_BLOCK_P
tag_changed_exit = counted_exit(side_exit, :invokeblock_tag_changed)
jit_chain_guard(:jne, jit, ctx, asm, tag_changed_exit)
comptime_captured = C.rb_captured_block.new(comptime_handler & ~0x3)
comptime_iseq = comptime_captured.code.iseq
asm.comment('guard known ISEQ')
asm.and(:rax, ~0x3) # captured
asm.mov(:rax, [:rax, C.VALUE.size * 2]) # captured->iseq
asm.mov(:rcx, comptime_iseq.to_i)
asm.cmp(:rax, :rcx)
block_changed_exit = counted_exit(side_exit, :invokeblock_iseq_block_changed)
jit_chain_guard(:jne, jit, ctx, asm, block_changed_exit)
jit_call_iseq(jit, ctx, asm, nil, calling, comptime_iseq, frame_type: C::VM_FRAME_MAGIC_BLOCK)
elsif comptime_handler & 0x3 == 0x3 # VM_BH_IFUNC_P
# We aren't handling CALLER_SETUP_ARG and CALLER_REMOVE_EMPTY_KW_SPLAT yet.
if calling.flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:invokeblock_ifunc_args_splat)
return CantCompile
end
if calling.flags & C::VM_CALL_KW_SPLAT != 0
asm.incr_counter(:invokeblock_ifunc_kw_splat)
return CantCompile
end
asm.comment('get local EP')
jit_get_lep(jit, asm, reg: :rax)
asm.mov(:rcx, [:rax, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL]) # block_handler_opnd
asm.comment('guard block_handler type');
side_exit = side_exit(jit, ctx)
asm.mov(:rax, :rcx) # block_handler_opnd
asm.and(:rax, 0x3) # tag_opnd: block_handler is a tagged pointer
asm.cmp(:rax, 0x3) # VM_BH_IFUNC_P
tag_changed_exit = counted_exit(side_exit, :invokeblock_tag_changed)
jit_chain_guard(:jne, jit, ctx, asm, tag_changed_exit)
# The cfunc may not be leaf
jit_prepare_routine_call(jit, ctx, asm) # clobbers :rax
asm.comment('call ifunc')
asm.and(:rcx, ~0x3) # captured_opnd
asm.lea(:rax, ctx.sp_opnd(-calling.argc * C.VALUE.size)) # argv
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], :rcx) # captured_opnd
asm.mov(C_ARGS[2], calling.argc)
asm.mov(C_ARGS[3], :rax) # argv
asm.call(C.rb_vm_yield_with_cfunc)
ctx.stack_pop(calling.argc)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
# cfunc calls may corrupt types
ctx.clear_local_types
# Share the successor with other chains
jump_to_next_insn(jit, ctx, asm)
EndBlock
elsif symbol?(comptime_handler)
asm.incr_counter(:invokeblock_symbol)
CantCompile
else # Proc
asm.incr_counter(:invokeblock_proc)
CantCompile
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def leave(jit, ctx, asm)
assert_equal(ctx.stack_size, 1)
jit_check_ints(jit, ctx, asm)
asm.comment('pop stack frame')
asm.lea(:rax, [CFP, C.rb_control_frame_t.size])
asm.mov(CFP, :rax)
asm.mov([EC, C.rb_execution_context_t.offsetof(:cfp)], :rax)
# Return a value (for compile_leave_exit)
ret_opnd = ctx.stack_pop
asm.mov(:rax, ret_opnd)
# Set caller's SP and push a value to its stack (for JIT)
asm.mov(SP, [CFP, C.rb_control_frame_t.offsetof(:sp)]) # Note: SP is in the position after popping a receiver and arguments
asm.mov([SP], :rax)
# Jump to cfp->jit_return
asm.jmp([CFP, -C.rb_control_frame_t.size + C.rb_control_frame_t.offsetof(:jit_return)])
EndBlock
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def throw(jit, ctx, asm)
throw_state = jit.operand(0)
asm.mov(:rcx, ctx.stack_pop(1)) # throwobj
# THROW_DATA_NEW allocates. Save SP for GC and PC for allocation tracing as
# well as handling the catch table. However, not using jit_prepare_routine_call
# since we don't need a patch point for this implementation.
jit_save_pc(jit, asm) # clobbers rax
jit_save_sp(ctx, asm)
# rb_vm_throw verifies it's a valid throw, sets ec->tag->state, and returns throw
# data, which is throwobj or a vm_throw_data wrapping it. When ec->tag->state is
# set, JIT code callers will handle the throw with vm_exec_handle_exception.
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], CFP)
asm.mov(C_ARGS[2], throw_state)
# asm.mov(C_ARGS[3], :rcx) # same reg
asm.call(C.rb_vm_throw)
asm.comment('exit from throw')
asm.pop(SP)
asm.pop(EC)
asm.pop(CFP)
# return C_RET as C_RET
asm.ret
EndBlock
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jump(jit, ctx, asm)
# Check for interrupts, but only on backward branches that may create loops
jump_offset = jit.operand(0, signed: true)
if jump_offset < 0
jit_check_ints(jit, ctx, asm)
end
pc = jit.pc + C.VALUE.size * (jit.insn.len + jump_offset)
jit_direct_jump(jit.iseq, pc, ctx, asm)
EndBlock
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def branchif(jit, ctx, asm)
# Check for interrupts, but only on backward branches that may create loops
jump_offset = jit.operand(0, signed: true)
if jump_offset < 0
jit_check_ints(jit, ctx, asm)
end
# Get the branch target instruction offsets
next_pc = jit.pc + C.VALUE.size * jit.insn.len
jump_pc = jit.pc + C.VALUE.size * (jit.insn.len + jump_offset)
val_type = ctx.get_opnd_type(StackOpnd[0])
val_opnd = ctx.stack_pop(1)
if (result = val_type.known_truthy) != nil
target_pc = result ? jump_pc : next_pc
jit_direct_jump(jit.iseq, target_pc, ctx, asm)
else
# This `test` sets ZF only for Qnil and Qfalse, which let jz jump.
asm.test(val_opnd, ~Qnil)
# Set stubs
branch_stub = BranchStub.new(
iseq: jit.iseq,
shape: Default,
target0: BranchTarget.new(ctx:, pc: jump_pc), # branch target
target1: BranchTarget.new(ctx:, pc: next_pc), # fallthrough
)
branch_stub.target0.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(ctx, ocb_asm, branch_stub, true)
@ocb.write(ocb_asm)
end
branch_stub.target1.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(ctx, ocb_asm, branch_stub, false)
@ocb.write(ocb_asm)
end
# Jump to target0 on jnz
branch_stub.compile = compile_branchif(branch_stub)
branch_stub.compile.call(asm)
end
EndBlock
end
def compile_branchif(branch_stub) # Proc escapes arguments in memory
proc do |branch_asm|
branch_asm.comment("branchif #{branch_stub.shape}")
branch_asm.stub(branch_stub) do
case branch_stub.shape
in Default
branch_asm.jnz(branch_stub.target0.address)
branch_asm.jmp(branch_stub.target1.address)
in Next0
branch_asm.jz(branch_stub.target1.address)
in Next1
branch_asm.jnz(branch_stub.target0.address)
end
end
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def branchunless(jit, ctx, asm)
# Check for interrupts, but only on backward branches that may create loops
jump_offset = jit.operand(0, signed: true)
if jump_offset < 0
jit_check_ints(jit, ctx, asm)
end
# Get the branch target instruction offsets
next_pc = jit.pc + C.VALUE.size * jit.insn.len
jump_pc = jit.pc + C.VALUE.size * (jit.insn.len + jump_offset)
val_type = ctx.get_opnd_type(StackOpnd[0])
val_opnd = ctx.stack_pop(1)
if (result = val_type.known_truthy) != nil
target_pc = result ? next_pc : jump_pc
jit_direct_jump(jit.iseq, target_pc, ctx, asm)
else
# This `test` sets ZF only for Qnil and Qfalse, which let jz jump.
asm.test(val_opnd, ~Qnil)
# Set stubs
branch_stub = BranchStub.new(
iseq: jit.iseq,
shape: Default,
target0: BranchTarget.new(ctx:, pc: jump_pc), # branch target
target1: BranchTarget.new(ctx:, pc: next_pc), # fallthrough
)
branch_stub.target0.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(ctx, ocb_asm, branch_stub, true)
@ocb.write(ocb_asm)
end
branch_stub.target1.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(ctx, ocb_asm, branch_stub, false)
@ocb.write(ocb_asm)
end
# Jump to target0 on jz
branch_stub.compile = compile_branchunless(branch_stub)
branch_stub.compile.call(asm)
end
EndBlock
end
def compile_branchunless(branch_stub) # Proc escapes arguments in memory
proc do |branch_asm|
branch_asm.comment("branchunless #{branch_stub.shape}")
branch_asm.stub(branch_stub) do
case branch_stub.shape
in Default
branch_asm.jz(branch_stub.target0.address)
branch_asm.jmp(branch_stub.target1.address)
in Next0
branch_asm.jnz(branch_stub.target1.address)
in Next1
branch_asm.jz(branch_stub.target0.address)
end
end
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def branchnil(jit, ctx, asm)
# Check for interrupts, but only on backward branches that may create loops
jump_offset = jit.operand(0, signed: true)
if jump_offset < 0
jit_check_ints(jit, ctx, asm)
end
# Get the branch target instruction offsets
next_pc = jit.pc + C.VALUE.size * jit.insn.len
jump_pc = jit.pc + C.VALUE.size * (jit.insn.len + jump_offset)
val_type = ctx.get_opnd_type(StackOpnd[0])
val_opnd = ctx.stack_pop(1)
if (result = val_type.known_nil) != nil
target_pc = result ? jump_pc : next_pc
jit_direct_jump(jit.iseq, target_pc, ctx, asm)
else
asm.cmp(val_opnd, Qnil)
# Set stubs
branch_stub = BranchStub.new(
iseq: jit.iseq,
shape: Default,
target0: BranchTarget.new(ctx:, pc: jump_pc), # branch target
target1: BranchTarget.new(ctx:, pc: next_pc), # fallthrough
)
branch_stub.target0.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(ctx, ocb_asm, branch_stub, true)
@ocb.write(ocb_asm)
end
branch_stub.target1.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(ctx, ocb_asm, branch_stub, false)
@ocb.write(ocb_asm)
end
# Jump to target0 on je
branch_stub.compile = compile_branchnil(branch_stub)
branch_stub.compile.call(asm)
end
EndBlock
end
def compile_branchnil(branch_stub) # Proc escapes arguments in memory
proc do |branch_asm|
branch_asm.comment("branchnil #{branch_stub.shape}")
branch_asm.stub(branch_stub) do
case branch_stub.shape
in Default
branch_asm.je(branch_stub.target0.address)
branch_asm.jmp(branch_stub.target1.address)
in Next0
branch_asm.jne(branch_stub.target1.address)
in Next1
branch_asm.je(branch_stub.target0.address)
end
end
end
end
# once
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_case_dispatch(jit, ctx, asm)
# Normally this instruction would lookup the key in a hash and jump to an
# offset based on that.
# Instead we can take the fallback case and continue with the next
# instruction.
# We'd hope that our jitted code will be sufficiently fast without the
# hash lookup, at least for small hashes, but it's worth revisiting this
# assumption in the future.
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
starting_context = ctx.dup
case_hash = jit.operand(0, ruby: true)
else_offset = jit.operand(1)
# Try to reorder case/else branches so that ones that are actually used come first.
# Supporting only Fixnum for now so that the implementation can be an equality check.
key_opnd = ctx.stack_pop(1)
comptime_key = jit.peek_at_stack(0)
# Check that all cases are fixnums to avoid having to register BOP assumptions on
# all the types that case hashes support. This spends compile time to save memory.
if fixnum?(comptime_key) && comptime_key <= 2**32 && C.rb_hash_keys(case_hash).all? { |key| fixnum?(key) }
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, C::BOP_EQQ)
return CantCompile
end
# Check if the key is the same value
asm.cmp(key_opnd, to_value(comptime_key))
side_exit = side_exit(jit, starting_context)
jit_chain_guard(:jne, jit, starting_context, asm, side_exit)
# Get the offset for the compile-time key
offset = C.rb_hash_stlike_lookup(case_hash, comptime_key)
# NOTE: If we hit the else branch with various values, it could negatively impact the performance.
jump_offset = offset || else_offset
# Jump to the offset of case or else
target_pc = jit.pc + (jit.insn.len + jump_offset) * C.VALUE.size
jit_direct_jump(jit.iseq, target_pc, ctx, asm)
EndBlock
else
KeepCompiling # continue with === branches
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_plus(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
comptime_recv = jit.peek_at_stack(1)
comptime_obj = jit.peek_at_stack(0)
if fixnum?(comptime_recv) && fixnum?(comptime_obj)
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, C::BOP_PLUS)
return CantCompile
end
# Check that both operands are fixnums
guard_two_fixnums(jit, ctx, asm)
obj_opnd = ctx.stack_pop
recv_opnd = ctx.stack_pop
asm.mov(:rax, recv_opnd)
asm.sub(:rax, 1) # untag
asm.mov(:rcx, obj_opnd)
asm.add(:rax, :rcx)
asm.jo(side_exit(jit, ctx))
dst_opnd = ctx.stack_push(Type::Fixnum)
asm.mov(dst_opnd, :rax)
KeepCompiling
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_minus(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
comptime_recv = jit.peek_at_stack(1)
comptime_obj = jit.peek_at_stack(0)
if fixnum?(comptime_recv) && fixnum?(comptime_obj)
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, C::BOP_MINUS)
return CantCompile
end
# Check that both operands are fixnums
guard_two_fixnums(jit, ctx, asm)
obj_opnd = ctx.stack_pop
recv_opnd = ctx.stack_pop
asm.mov(:rax, recv_opnd)
asm.mov(:rcx, obj_opnd)
asm.sub(:rax, :rcx)
asm.jo(side_exit(jit, ctx))
asm.add(:rax, 1) # re-tag
dst_opnd = ctx.stack_push(Type::Fixnum)
asm.mov(dst_opnd, :rax)
KeepCompiling
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_mult(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_div(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_mod(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
if two_fixnums_on_stack?(jit)
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, C::BOP_MOD)
return CantCompile
end
# Check that both operands are fixnums
guard_two_fixnums(jit, ctx, asm)
# Get the operands and destination from the stack
arg1 = ctx.stack_pop(1)
arg0 = ctx.stack_pop(1)
# Check for arg0 % 0
asm.cmp(arg1, 0)
asm.je(side_exit(jit, ctx))
# Call rb_fix_mod_fix(VALUE recv, VALUE obj)
asm.mov(C_ARGS[0], arg0)
asm.mov(C_ARGS[1], arg1)
asm.call(C.rb_fix_mod_fix)
# Push the return value onto the stack
stack_ret = ctx.stack_push(Type::Fixnum)
asm.mov(stack_ret, C_RET)
KeepCompiling
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_eq(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
if jit_equality_specialized(jit, ctx, asm, true)
jump_to_next_insn(jit, ctx, asm)
EndBlock
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_neq(jit, ctx, asm)
# opt_neq is passed two rb_call_data as arguments:
# first for ==, second for !=
neq_cd = C.rb_call_data.new(jit.operand(1))
opt_send_without_block(jit, ctx, asm, cd: neq_cd)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_lt(jit, ctx, asm)
jit_fixnum_cmp(jit, ctx, asm, opcode: :cmovl, bop: C::BOP_LT)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_le(jit, ctx, asm)
jit_fixnum_cmp(jit, ctx, asm, opcode: :cmovle, bop: C::BOP_LE)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_gt(jit, ctx, asm)
jit_fixnum_cmp(jit, ctx, asm, opcode: :cmovg, bop: C::BOP_GT)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_ge(jit, ctx, asm)
jit_fixnum_cmp(jit, ctx, asm, opcode: :cmovge, bop: C::BOP_GE)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_ltlt(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_and(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
if two_fixnums_on_stack?(jit)
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, C::BOP_AND)
return CantCompile
end
# Check that both operands are fixnums
guard_two_fixnums(jit, ctx, asm)
# Get the operands and destination from the stack
arg1 = ctx.stack_pop(1)
arg0 = ctx.stack_pop(1)
asm.comment('bitwise and')
asm.mov(:rax, arg0)
asm.and(:rax, arg1)
# Push the return value onto the stack
dst = ctx.stack_push(Type::Fixnum)
asm.mov(dst, :rax)
KeepCompiling
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_or(jit, ctx, asm)
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
if two_fixnums_on_stack?(jit)
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, C::BOP_OR)
return CantCompile
end
# Check that both operands are fixnums
guard_two_fixnums(jit, ctx, asm)
# Get the operands and destination from the stack
asm.comment('bitwise or')
arg1 = ctx.stack_pop(1)
arg0 = ctx.stack_pop(1)
# Do the bitwise or arg0 | arg1
asm.mov(:rax, arg0)
asm.or(:rax, arg1)
# Push the return value onto the stack
dst = ctx.stack_push(Type::Fixnum)
asm.mov(dst, :rax)
KeepCompiling
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_aref(jit, ctx, asm)
cd = C.rb_call_data.new(jit.operand(0))
argc = C.vm_ci_argc(cd.ci)
if argc != 1
asm.incr_counter(:optaref_argc_not_one)
return CantCompile
end
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
comptime_recv = jit.peek_at_stack(1)
comptime_obj = jit.peek_at_stack(0)
side_exit = side_exit(jit, ctx)
if C.rb_class_of(comptime_recv) == Array && fixnum?(comptime_obj)
unless Invariants.assume_bop_not_redefined(jit, C::ARRAY_REDEFINED_OP_FLAG, C::BOP_AREF)
return CantCompile
end
idx_opnd = ctx.stack_opnd(0)
recv_opnd = ctx.stack_opnd(1)
not_array_exit = counted_exit(side_exit, :optaref_recv_not_array)
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_recv), recv_opnd, StackOpnd[1], comptime_recv, not_array_exit)
# Bail if idx is not a FIXNUM
asm.mov(:rax, idx_opnd)
asm.test(:rax, C::RUBY_FIXNUM_FLAG)
asm.jz(counted_exit(side_exit, :optaref_arg_not_fixnum))
# Call VALUE rb_ary_entry_internal(VALUE ary, long offset).
# It never raises or allocates, so we don't need to write to cfp->pc.
asm.sar(:rax, 1) # Convert fixnum to int
asm.mov(C_ARGS[0], recv_opnd)
asm.mov(C_ARGS[1], :rax)
asm.call(C.rb_ary_entry_internal)
# Pop the argument and the receiver
ctx.stack_pop(2)
# Push the return value onto the stack
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
# Let guard chains share the same successor
jump_to_next_insn(jit, ctx, asm)
EndBlock
elsif C.rb_class_of(comptime_recv) == Hash
unless Invariants.assume_bop_not_redefined(jit, C::HASH_REDEFINED_OP_FLAG, C::BOP_AREF)
return CantCompile
end
recv_opnd = ctx.stack_opnd(1)
# Guard that the receiver is a Hash
not_hash_exit = counted_exit(side_exit, :optaref_recv_not_hash)
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_recv), recv_opnd, StackOpnd[1], comptime_recv, not_hash_exit)
# Prepare to call rb_hash_aref(). It might call #hash on the key.
jit_prepare_routine_call(jit, ctx, asm)
asm.comment('call rb_hash_aref')
key_opnd = ctx.stack_opnd(0)
recv_opnd = ctx.stack_opnd(1)
asm.mov(:rdi, recv_opnd)
asm.mov(:rsi, key_opnd)
asm.call(C.rb_hash_aref)
# Pop the key and the receiver
ctx.stack_pop(2)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
# Let guard chains share the same successor
jump_to_next_insn(jit, ctx, asm)
EndBlock
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_aset(jit, ctx, asm)
# Defer compilation so we can specialize on a runtime `self`
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
comptime_recv = jit.peek_at_stack(2)
comptime_key = jit.peek_at_stack(1)
# Get the operands from the stack
recv = ctx.stack_opnd(2)
key = ctx.stack_opnd(1)
_val = ctx.stack_opnd(0)
if C.rb_class_of(comptime_recv) == Array && fixnum?(comptime_key)
side_exit = side_exit(jit, ctx)
# Guard receiver is an Array
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_recv), recv, StackOpnd[2], comptime_recv, side_exit)
# Guard key is a fixnum
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_key), key, StackOpnd[1], comptime_key, side_exit)
# We might allocate or raise
jit_prepare_routine_call(jit, ctx, asm)
asm.comment('call rb_ary_store')
recv = ctx.stack_opnd(2)
key = ctx.stack_opnd(1)
val = ctx.stack_opnd(0)
asm.mov(:rax, key)
asm.sar(:rax, 1) # FIX2LONG(key)
asm.mov(C_ARGS[0], recv)
asm.mov(C_ARGS[1], :rax)
asm.mov(C_ARGS[2], val)
asm.call(C.rb_ary_store)
# rb_ary_store returns void
# stored value should still be on stack
val = ctx.stack_opnd(0)
# Push the return value onto the stack
ctx.stack_pop(3)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(:rax, val)
asm.mov(stack_ret, :rax)
jump_to_next_insn(jit, ctx, asm)
EndBlock
elsif C.rb_class_of(comptime_recv) == Hash
side_exit = side_exit(jit, ctx)
# Guard receiver is a Hash
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_recv), recv, StackOpnd[2], comptime_recv, side_exit)
# We might allocate or raise
jit_prepare_routine_call(jit, ctx, asm)
# Call rb_hash_aset
recv = ctx.stack_opnd(2)
key = ctx.stack_opnd(1)
val = ctx.stack_opnd(0)
asm.mov(C_ARGS[0], recv)
asm.mov(C_ARGS[1], key)
asm.mov(C_ARGS[2], val)
asm.call(C.rb_hash_aset)
# Push the return value onto the stack
ctx.stack_pop(3)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
jump_to_next_insn(jit, ctx, asm)
EndBlock
else
opt_send_without_block(jit, ctx, asm)
end
end
# opt_aset_with
# opt_aref_with
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_length(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_size(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_empty_p(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_succ(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_not(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_regexpmatch2(jit, ctx, asm)
opt_send_without_block(jit, ctx, asm)
end
# invokebuiltin
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_invokebuiltin_delegate(jit, ctx, asm)
bf = C.rb_builtin_function.new(jit.operand(0))
bf_argc = bf.argc
start_index = jit.operand(1)
# ec, self, and arguments
if bf_argc + 2 > C_ARGS.size
return CantCompile
end
# If the calls don't allocate, do they need up to date PC, SP?
jit_prepare_routine_call(jit, ctx, asm)
# Call the builtin func (ec, recv, arg1, arg2, ...)
asm.comment('call builtin func')
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], [CFP, C.rb_control_frame_t.offsetof(:self)])
# Copy arguments from locals
if bf_argc > 0
# Load environment pointer EP from CFP
asm.mov(:rax, [CFP, C.rb_control_frame_t.offsetof(:ep)])
bf_argc.times do |i|
table_size = jit.iseq.body.local_table_size
offs = -table_size - C::VM_ENV_DATA_SIZE + 1 + start_index + i
asm.mov(C_ARGS[2 + i], [:rax, offs * C.VALUE.size])
end
end
asm.call(bf.func_ptr)
# Push the return value
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
KeepCompiling
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def opt_invokebuiltin_delegate_leave(jit, ctx, asm)
opt_invokebuiltin_delegate(jit, ctx, asm)
# opt_invokebuiltin_delegate is always followed by leave insn
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def putobject_INT2FIX_0_(jit, ctx, asm)
putobject(jit, ctx, asm, val: C.to_value(0))
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def putobject_INT2FIX_1_(jit, ctx, asm)
putobject(jit, ctx, asm, val: C.to_value(1))
end
#
# C func
#
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_true(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 0
asm.comment('nil? == true')
ctx.stack_pop(1)
stack_ret = ctx.stack_push(Type::True)
asm.mov(stack_ret, Qtrue)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_false(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 0
asm.comment('nil? == false')
ctx.stack_pop(1)
stack_ret = ctx.stack_push(Type::False)
asm.mov(stack_ret, Qfalse)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_kernel_is_a(jit, ctx, asm, argc, known_recv_class)
if argc != 1
return false
end
# If this is a super call we might not know the class
if known_recv_class.nil?
return false
end
# Important note: The output code will simply `return true/false`.
# Correctness follows from:
# - `known_recv_class` implies there is a guard scheduled before here
# for a particular `CLASS_OF(lhs)`.
# - We guard that rhs is identical to the compile-time sample
# - In general, for any two Class instances A, B, `A < B` does not change at runtime.
# Class#superclass is stable.
sample_rhs = jit.peek_at_stack(0)
sample_lhs = jit.peek_at_stack(1)
# We are not allowing module here because the module hierarchy can change at runtime.
if C.RB_TYPE_P(sample_rhs, C::RUBY_T_CLASS)
return false
end
sample_is_a = C.obj_is_kind_of(sample_lhs, sample_rhs)
side_exit = side_exit(jit, ctx)
asm.comment('Kernel#is_a?')
asm.mov(:rax, to_value(sample_rhs))
asm.cmp(ctx.stack_opnd(0), :rax)
asm.jne(counted_exit(side_exit, :send_is_a_class_mismatch))
ctx.stack_pop(2)
if sample_is_a
stack_ret = ctx.stack_push(Type::True)
asm.mov(stack_ret, Qtrue)
else
stack_ret = ctx.stack_push(Type::False)
asm.mov(stack_ret, Qfalse)
end
return true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_kernel_instance_of(jit, ctx, asm, argc, known_recv_class)
if argc != 1
return false
end
# If this is a super call we might not know the class
if known_recv_class.nil?
return false
end
# Important note: The output code will simply `return true/false`.
# Correctness follows from:
# - `known_recv_class` implies there is a guard scheduled before here
# for a particular `CLASS_OF(lhs)`.
# - We guard that rhs is identical to the compile-time sample
# - For a particular `CLASS_OF(lhs)`, `rb_obj_class(lhs)` does not change.
# (because for any singleton class `s`, `s.superclass.equal?(s.attached_object.class)`)
sample_rhs = jit.peek_at_stack(0)
sample_lhs = jit.peek_at_stack(1)
# Filters out cases where the C implementation raises
unless C.RB_TYPE_P(sample_rhs, C::RUBY_T_CLASS) || C.RB_TYPE_P(sample_rhs, C::RUBY_T_MODULE)
return false
end
# We need to grab the class here to deal with singleton classes.
# Instance of grabs the "real class" of the object rather than the
# singleton class.
sample_lhs_real_class = C.rb_obj_class(sample_lhs)
sample_instance_of = (sample_lhs_real_class == sample_rhs)
side_exit = side_exit(jit, ctx)
asm.comment('Kernel#instance_of?')
asm.mov(:rax, to_value(sample_rhs))
asm.cmp(ctx.stack_opnd(0), :rax)
asm.jne(counted_exit(side_exit, :send_instance_of_class_mismatch))
ctx.stack_pop(2)
if sample_instance_of
stack_ret = ctx.stack_push(Type::True)
asm.mov(stack_ret, Qtrue)
else
stack_ret = ctx.stack_push(Type::False)
asm.mov(stack_ret, Qfalse)
end
return true;
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_obj_not(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 0
recv_type = ctx.get_opnd_type(StackOpnd[0])
case recv_type.known_truthy
in false
asm.comment('rb_obj_not(nil_or_false)')
ctx.stack_pop(1)
out_opnd = ctx.stack_push(Type::True)
asm.mov(out_opnd, Qtrue)
in true
# Note: recv_type != Type::Nil && recv_type != Type::False.
asm.comment('rb_obj_not(truthy)')
ctx.stack_pop(1)
out_opnd = ctx.stack_push(Type::False)
asm.mov(out_opnd, Qfalse)
in nil
asm.comment('rb_obj_not')
recv = ctx.stack_pop
# This `test` sets ZF only for Qnil and Qfalse, which let cmovz set.
asm.test(recv, ~Qnil)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.cmovz(:rax, :rcx)
stack_ret = ctx.stack_push(Type::UnknownImm)
asm.mov(stack_ret, :rax)
end
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_obj_equal(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
asm.comment('equal?')
obj1 = ctx.stack_pop(1)
obj2 = ctx.stack_pop(1)
asm.mov(:rax, obj1)
asm.mov(:rcx, obj2)
asm.cmp(:rax, :rcx)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.cmove(:rax, :rcx)
stack_ret = ctx.stack_push(Type::UnknownImm)
asm.mov(stack_ret, :rax)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_obj_not_equal(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
jit_equality_specialized(jit, ctx, asm, false)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_mod_eqq(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
asm.comment('Module#===')
# By being here, we know that the receiver is a T_MODULE or a T_CLASS, because Module#=== can
# only live on these objects. With that, we can call rb_obj_is_kind_of() without
# jit_prepare_routine_call() or a control frame push because it can't raise, allocate, or call
# Ruby methods with these inputs.
# Note the difference in approach from Kernel#is_a? because we don't get a free guard for the
# right hand side.
lhs = ctx.stack_opnd(1) # the module
rhs = ctx.stack_opnd(0)
asm.mov(C_ARGS[0], rhs);
asm.mov(C_ARGS[1], lhs);
asm.call(C.rb_obj_is_kind_of)
# Return the result
ctx.stack_pop(2)
stack_ret = ctx.stack_push(Type::UnknownImm)
asm.mov(stack_ret, C_RET)
return true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_int_equal(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
return false unless two_fixnums_on_stack?(jit)
guard_two_fixnums(jit, ctx, asm)
# Compare the arguments
asm.comment('rb_int_equal')
arg1 = ctx.stack_pop(1)
arg0 = ctx.stack_pop(1)
asm.mov(:rax, arg1)
asm.cmp(arg0, :rax)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.cmove(:rax, :rcx)
stack_ret = ctx.stack_push(Type::UnknownImm)
asm.mov(stack_ret, :rax)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_int_mul(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
return false unless two_fixnums_on_stack?(jit)
guard_two_fixnums(jit, ctx, asm)
asm.comment('rb_int_mul')
y_opnd = ctx.stack_pop
x_opnd = ctx.stack_pop
asm.mov(C_ARGS[0], x_opnd)
asm.mov(C_ARGS[1], y_opnd)
asm.call(C.rb_fix_mul_fix)
ret_opnd = ctx.stack_push(Type::Unknown)
asm.mov(ret_opnd, C_RET)
true
end
def jit_rb_int_div(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
return false unless two_fixnums_on_stack?(jit)
guard_two_fixnums(jit, ctx, asm)
asm.comment('rb_int_div')
y_opnd = ctx.stack_pop
x_opnd = ctx.stack_pop
asm.mov(:rax, y_opnd)
asm.cmp(:rax, C.to_value(0))
asm.je(side_exit(jit, ctx))
asm.mov(C_ARGS[0], x_opnd)
asm.mov(C_ARGS[1], :rax)
asm.call(C.rb_fix_div_fix)
ret_opnd = ctx.stack_push(Type::Unknown)
asm.mov(ret_opnd, C_RET)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_int_aref(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
return false unless two_fixnums_on_stack?(jit)
guard_two_fixnums(jit, ctx, asm)
asm.comment('rb_int_aref')
y_opnd = ctx.stack_pop
x_opnd = ctx.stack_pop
asm.mov(C_ARGS[0], x_opnd)
asm.mov(C_ARGS[1], y_opnd)
asm.call(C.rb_fix_aref)
ret_opnd = ctx.stack_push(Type::UnknownImm)
asm.mov(ret_opnd, C_RET)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_str_empty_p(jit, ctx, asm, argc, known_recv_class)
recv_opnd = ctx.stack_pop(1)
out_opnd = ctx.stack_push(Type::UnknownImm)
asm.comment('get string length')
asm.mov(:rax, recv_opnd)
str_len_opnd = [:rax, C.RString.offsetof(:len)]
asm.cmp(str_len_opnd, 0)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.cmove(:rax, :rcx)
asm.mov(out_opnd, :rax)
return true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_str_to_s(jit, ctx, asm, argc, known_recv_class)
return false if argc != 0
if known_recv_class == String
asm.comment('to_s on plain string')
# The method returns the receiver, which is already on the stack.
# No stack movement.
return true
end
false
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_str_bytesize(jit, ctx, asm, argc, known_recv_class)
asm.comment('String#bytesize')
recv = ctx.stack_pop(1)
asm.mov(C_ARGS[0], recv)
asm.call(C.rb_str_bytesize)
out_opnd = ctx.stack_push(Type::Fixnum)
asm.mov(out_opnd, C_RET)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_str_concat(jit, ctx, asm, argc, known_recv_class)
# The << operator can accept integer codepoints for characters
# as the argument. We only specially optimise string arguments.
# If the peeked-at compile time argument is something other than
# a string, assume it won't be a string later either.
comptime_arg = jit.peek_at_stack(0)
unless C.RB_TYPE_P(comptime_arg, C::RUBY_T_STRING)
return false
end
# Guard that the concat argument is a string
asm.mov(:rax, ctx.stack_opnd(0))
guard_object_is_string(jit, ctx, asm, :rax, :rcx, StackOpnd[0])
# Guard buffers from GC since rb_str_buf_append may allocate. During the VM lock on GC,
# other Ractors may trigger global invalidation, so we need ctx.clear_local_types.
# PC is used on errors like Encoding::CompatibilityError raised by rb_str_buf_append.
jit_prepare_routine_call(jit, ctx, asm)
concat_arg = ctx.stack_pop(1)
recv = ctx.stack_pop(1)
# Test if string encodings differ. If different, use rb_str_append. If the same,
# use rb_yjit_str_simple_append, which calls rb_str_cat.
asm.comment('<< on strings')
# Take receiver's object flags XOR arg's flags. If any
# string-encoding flags are different between the two,
# the encodings don't match.
recv_reg = :rax
asm.mov(recv_reg, recv)
concat_arg_reg = :rcx
asm.mov(concat_arg_reg, concat_arg)
asm.mov(recv_reg, [recv_reg, C.RBasic.offsetof(:flags)])
asm.mov(concat_arg_reg, [concat_arg_reg, C.RBasic.offsetof(:flags)])
asm.xor(recv_reg, concat_arg_reg)
asm.test(recv_reg, C::RUBY_ENCODING_MASK)
# Push once, use the resulting operand in both branches below.
stack_ret = ctx.stack_push(Type::TString)
enc_mismatch = asm.new_label('enc_mismatch')
asm.jnz(enc_mismatch)
# If encodings match, call the simple append function and jump to return
asm.mov(C_ARGS[0], recv)
asm.mov(C_ARGS[1], concat_arg)
asm.call(C.rjit_str_simple_append)
ret_label = asm.new_label('func_return')
asm.mov(stack_ret, C_RET)
asm.jmp(ret_label)
# If encodings are different, use a slower encoding-aware concatenate
asm.write_label(enc_mismatch)
asm.mov(C_ARGS[0], recv)
asm.mov(C_ARGS[1], concat_arg)
asm.call(C.rb_str_buf_append)
asm.mov(stack_ret, C_RET)
# Drop through to return
asm.write_label(ret_label)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_str_uplus(jit, ctx, asm, argc, _known_recv_class)
if argc != 0
return false
end
# We allocate when we dup the string
jit_prepare_routine_call(jit, ctx, asm)
asm.comment('Unary plus on string')
asm.mov(:rax, ctx.stack_pop(1)) # recv_opnd
asm.mov(:rcx, [:rax, C.RBasic.offsetof(:flags)]) # flags_opnd
asm.test(:rcx, C::RUBY_FL_FREEZE)
ret_label = asm.new_label('stack_ret')
# String#+@ can only exist on T_STRING
stack_ret = ctx.stack_push(Type::TString)
# If the string isn't frozen, we just return it.
asm.mov(stack_ret, :rax) # recv_opnd
asm.jz(ret_label)
# Str is frozen - duplicate it
asm.mov(C_ARGS[0], :rax) # recv_opnd
asm.call(C.rb_str_dup)
asm.mov(stack_ret, C_RET)
asm.write_label(ret_label)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_str_getbyte(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
asm.comment('rb_str_getbyte')
index_opnd = ctx.stack_pop
str_opnd = ctx.stack_pop
asm.mov(C_ARGS[0], str_opnd)
asm.mov(C_ARGS[1], index_opnd)
asm.call(C.rb_str_getbyte)
ret_opnd = ctx.stack_push(Type::Fixnum)
asm.mov(ret_opnd, C_RET)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_ary_empty_p(jit, ctx, asm, argc, _known_recv_class)
array_reg = :rax
asm.mov(array_reg, ctx.stack_pop(1))
jit_array_len(asm, array_reg, :rcx)
asm.test(:rcx, :rcx)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.cmovz(:rax, :rcx)
out_opnd = ctx.stack_push(Type::UnknownImm)
asm.mov(out_opnd, :rax)
return true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_ary_push(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 1
asm.comment('rb_ary_push')
jit_prepare_routine_call(jit, ctx, asm)
item_opnd = ctx.stack_pop
ary_opnd = ctx.stack_pop
asm.mov(C_ARGS[0], ary_opnd)
asm.mov(C_ARGS[1], item_opnd)
asm.call(C.rb_ary_push)
ret_opnd = ctx.stack_push(Type::TArray)
asm.mov(ret_opnd, C_RET)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_obj_respond_to(jit, ctx, asm, argc, known_recv_class)
# respond_to(:sym) or respond_to(:sym, true)
if argc != 1 && argc != 2
return false
end
if known_recv_class.nil?
return false
end
recv_class = known_recv_class
# Get the method_id from compile time. We will later add a guard against it.
mid_sym = jit.peek_at_stack(argc - 1)
unless static_symbol?(mid_sym)
return false
end
mid = C.rb_sym2id(mid_sym)
# This represents the value of the "include_all" argument and whether it's known
allow_priv = if argc == 1
# Default is false
false
else
# Get value from type information (may or may not be known)
ctx.get_opnd_type(StackOpnd[0]).known_truthy
end
target_cme = C.rb_callable_method_entry_or_negative(recv_class, mid)
# Should never be null, as in that case we will be returned a "negative CME"
assert_equal(false, target_cme.nil?)
cme_def_type = C.UNDEFINED_METHOD_ENTRY_P(target_cme) ? C::VM_METHOD_TYPE_UNDEF : target_cme.def.type
if cme_def_type == C::VM_METHOD_TYPE_REFINED
return false
end
visibility = if cme_def_type == C::VM_METHOD_TYPE_UNDEF
C::METHOD_VISI_UNDEF
else
C.METHOD_ENTRY_VISI(target_cme)
end
result =
case [visibility, allow_priv]
in C::METHOD_VISI_UNDEF, _ then Qfalse # No method => false
in C::METHOD_VISI_PUBLIC, _ then Qtrue # Public method => true regardless of include_all
in _, true then Qtrue # include_all => always true
else return false # not public and include_all not known, can't compile
end
if result != Qtrue
# Only if respond_to_missing? hasn't been overridden
# In the future, we might want to jit the call to respond_to_missing?
unless Invariants.assume_method_basic_definition(jit, recv_class, C.idRespond_to_missing)
return false
end
end
# Invalidate this block if method lookup changes for the method being queried. This works
# both for the case where a method does or does not exist, as for the latter we asked for a
# "negative CME" earlier.
Invariants.assume_method_lookup_stable(jit, target_cme)
# Generate a side exit
side_exit = side_exit(jit, ctx)
if argc == 2
# pop include_all argument (we only use its type info)
ctx.stack_pop(1)
end
sym_opnd = ctx.stack_pop(1)
_recv_opnd = ctx.stack_pop(1)
# This is necessary because we have no guarantee that sym_opnd is a constant
asm.comment('guard known mid')
asm.mov(:rax, to_value(mid_sym))
asm.cmp(sym_opnd, :rax)
asm.jne(side_exit)
putobject(jit, ctx, asm, val: result)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_rb_f_block_given_p(jit, ctx, asm, argc, _known_recv_class)
asm.comment('block_given?')
# Same as rb_vm_frame_block_handler
jit_get_lep(jit, asm, reg: :rax)
asm.mov(:rax, [:rax, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL]) # block_handler
ctx.stack_pop(1)
out_opnd = ctx.stack_push(Type::UnknownImm)
# Return `block_handler != VM_BLOCK_HANDLER_NONE`
asm.cmp(:rax, C::VM_BLOCK_HANDLER_NONE)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.cmovne(:rax, :rcx) # block_given
asm.mov(out_opnd, :rax)
true
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_thread_s_current(jit, ctx, asm, argc, _known_recv_class)
return false if argc != 0
asm.comment('Thread.current')
ctx.stack_pop(1)
# ec->thread_ptr
asm.mov(:rax, [EC, C.rb_execution_context_t.offsetof(:thread_ptr)])
# thread->self
asm.mov(:rax, [:rax, C.rb_thread_struct.offsetof(:self)])
stack_ret = ctx.stack_push(Type::UnknownHeap)
asm.mov(stack_ret, :rax)
true
end
#
# Helpers
#
def register_cfunc_codegen_funcs
# Specialization for C methods. See register_cfunc_method for details.
register_cfunc_method(BasicObject, :!, :jit_rb_obj_not)
register_cfunc_method(NilClass, :nil?, :jit_rb_true)
register_cfunc_method(Kernel, :nil?, :jit_rb_false)
register_cfunc_method(Kernel, :is_a?, :jit_rb_kernel_is_a)
register_cfunc_method(Kernel, :kind_of?, :jit_rb_kernel_is_a)
register_cfunc_method(Kernel, :instance_of?, :jit_rb_kernel_instance_of)
register_cfunc_method(BasicObject, :==, :jit_rb_obj_equal)
register_cfunc_method(BasicObject, :equal?, :jit_rb_obj_equal)
register_cfunc_method(BasicObject, :!=, :jit_rb_obj_not_equal)
register_cfunc_method(Kernel, :eql?, :jit_rb_obj_equal)
register_cfunc_method(Module, :==, :jit_rb_obj_equal)
register_cfunc_method(Module, :===, :jit_rb_mod_eqq)
register_cfunc_method(Symbol, :==, :jit_rb_obj_equal)
register_cfunc_method(Symbol, :===, :jit_rb_obj_equal)
register_cfunc_method(Integer, :==, :jit_rb_int_equal)
register_cfunc_method(Integer, :===, :jit_rb_int_equal)
# rb_str_to_s() methods in string.c
register_cfunc_method(String, :empty?, :jit_rb_str_empty_p)
register_cfunc_method(String, :to_s, :jit_rb_str_to_s)
register_cfunc_method(String, :to_str, :jit_rb_str_to_s)
register_cfunc_method(String, :bytesize, :jit_rb_str_bytesize)
register_cfunc_method(String, :<<, :jit_rb_str_concat)
register_cfunc_method(String, :+@, :jit_rb_str_uplus)
# rb_ary_empty_p() method in array.c
register_cfunc_method(Array, :empty?, :jit_rb_ary_empty_p)
register_cfunc_method(Kernel, :respond_to?, :jit_obj_respond_to)
register_cfunc_method(Kernel, :block_given?, :jit_rb_f_block_given_p)
# Thread.current
register_cfunc_method(C.rb_singleton_class(Thread), :current, :jit_thread_s_current)
#---
register_cfunc_method(Array, :<<, :jit_rb_ary_push)
register_cfunc_method(Integer, :*, :jit_rb_int_mul)
register_cfunc_method(Integer, :/, :jit_rb_int_div)
register_cfunc_method(Integer, :[], :jit_rb_int_aref)
register_cfunc_method(String, :getbyte, :jit_rb_str_getbyte)
end
def register_cfunc_method(klass, mid_sym, func)
mid = C.rb_intern(mid_sym.to_s)
me = C.rb_method_entry_at(klass, mid)
assert_equal(false, me.nil?)
# Only cfuncs are supported
method_serial = me.def.method_serial
@cfunc_codegen_table[method_serial] = method(func)
end
def lookup_cfunc_codegen(cme_def)
@cfunc_codegen_table[cme_def.method_serial]
end
def stack_swap(_jit, ctx, asm, offset0, offset1)
stack0_mem = ctx.stack_opnd(offset0)
stack1_mem = ctx.stack_opnd(offset1)
mapping0 = ctx.get_opnd_mapping(StackOpnd[offset0])
mapping1 = ctx.get_opnd_mapping(StackOpnd[offset1])
asm.mov(:rax, stack0_mem)
asm.mov(:rcx, stack1_mem)
asm.mov(stack0_mem, :rcx)
asm.mov(stack1_mem, :rax)
ctx.set_opnd_mapping(StackOpnd[offset0], mapping1)
ctx.set_opnd_mapping(StackOpnd[offset1], mapping0)
end
def jit_getlocal_generic(jit, ctx, asm, idx:, level:)
# Load environment pointer EP (level 0) from CFP
ep_reg = :rax
jit_get_ep(asm, level, reg: ep_reg)
# Load the local from the block
# val = *(vm_get_ep(GET_EP(), level) - idx);
asm.mov(:rax, [ep_reg, -idx * C.VALUE.size])
# Write the local at SP
stack_top = if level == 0
local_idx = ep_offset_to_local_idx(jit.iseq, idx)
ctx.stack_push_local(local_idx)
else
ctx.stack_push(Type::Unknown)
end
asm.mov(stack_top, :rax)
KeepCompiling
end
def jit_setlocal_generic(jit, ctx, asm, idx:, level:)
value_type = ctx.get_opnd_type(StackOpnd[0])
# Load environment pointer EP at level
ep_reg = :rax
jit_get_ep(asm, level, reg: ep_reg)
# Write barriers may be required when VM_ENV_FLAG_WB_REQUIRED is set, however write barriers
# only affect heap objects being written. If we know an immediate value is being written we
# can skip this check.
unless value_type.imm?
# flags & VM_ENV_FLAG_WB_REQUIRED
flags_opnd = [ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_FLAGS]
asm.test(flags_opnd, C::VM_ENV_FLAG_WB_REQUIRED)
# if (flags & VM_ENV_FLAG_WB_REQUIRED) != 0
asm.jnz(side_exit(jit, ctx))
end
if level == 0
local_idx = ep_offset_to_local_idx(jit.iseq, idx)
ctx.set_local_type(local_idx, value_type)
end
# Pop the value to write from the stack
stack_top = ctx.stack_pop(1)
# Write the value at the environment pointer
asm.mov(:rcx, stack_top)
asm.mov([ep_reg, -(C.VALUE.size * idx)], :rcx)
KeepCompiling
end
# Compute the index of a local variable from its slot index
def ep_offset_to_local_idx(iseq, ep_offset)
# Layout illustration
# This is an array of VALUE
# | VM_ENV_DATA_SIZE |
# v v
# low addr <+-------+-------+-------+-------+------------------+
# |local 0|local 1| ... |local n| .... |
# +-------+-------+-------+-------+------------------+
# ^ ^ ^ ^
# +-------+---local_table_size----+ cfp->ep--+
# | |
# +------------------ep_offset---------------+
#
# See usages of local_var_name() from iseq.c for similar calculation.
# Equivalent of iseq->body->local_table_size
local_table_size = iseq.body.local_table_size
op = ep_offset - C::VM_ENV_DATA_SIZE
local_idx = local_table_size - op - 1
assert_equal(true, local_idx >= 0 && local_idx < local_table_size)
local_idx
end
# Compute the index of a local variable from its slot index
def slot_to_local_idx(iseq, slot_idx)
# Layout illustration
# This is an array of VALUE
# | VM_ENV_DATA_SIZE |
# v v
# low addr <+-------+-------+-------+-------+------------------+
# |local 0|local 1| ... |local n| .... |
# +-------+-------+-------+-------+------------------+
# ^ ^ ^ ^
# +-------+---local_table_size----+ cfp->ep--+
# | |
# +------------------slot_idx----------------+
#
# See usages of local_var_name() from iseq.c for similar calculation.
local_table_size = iseq.body.local_table_size
op = slot_idx - C::VM_ENV_DATA_SIZE
local_table_size - op - 1
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def guard_object_is_heap(jit, ctx, asm, object, object_opnd, counter = nil)
object_type = ctx.get_opnd_type(object_opnd)
if object_type.heap?
return
end
side_exit = side_exit(jit, ctx)
side_exit = counted_exit(side_exit, counter) if counter
asm.comment('guard object is heap')
# Test that the object is not an immediate
asm.test(object, C::RUBY_IMMEDIATE_MASK)
asm.jnz(side_exit)
# Test that the object is not false
asm.cmp(object, Qfalse)
asm.je(side_exit)
if object_type.diff(Type::UnknownHeap) != TypeDiff::Incompatible
ctx.upgrade_opnd_type(object_opnd, Type::UnknownHeap)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def guard_object_is_array(jit, ctx, asm, object_reg, flags_reg, object_opnd, counter = nil)
object_type = ctx.get_opnd_type(object_opnd)
if object_type.array?
return
end
guard_object_is_heap(jit, ctx, asm, object_reg, object_opnd, counter)
side_exit = side_exit(jit, ctx)
side_exit = counted_exit(side_exit, counter) if counter
asm.comment('guard object is array')
# Pull out the type mask
asm.mov(flags_reg, [object_reg, C.RBasic.offsetof(:flags)])
asm.and(flags_reg, C::RUBY_T_MASK)
# Compare the result with T_ARRAY
asm.cmp(flags_reg, C::RUBY_T_ARRAY)
asm.jne(side_exit)
if object_type.diff(Type::TArray) != TypeDiff::Incompatible
ctx.upgrade_opnd_type(object_opnd, Type::TArray)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def guard_object_is_string(jit, ctx, asm, object_reg, flags_reg, object_opnd, counter = nil)
object_type = ctx.get_opnd_type(object_opnd)
if object_type.string?
return
end
guard_object_is_heap(jit, ctx, asm, object_reg, object_opnd, counter)
side_exit = side_exit(jit, ctx)
side_exit = counted_exit(side_exit, counter) if counter
asm.comment('guard object is string')
# Pull out the type mask
asm.mov(flags_reg, [object_reg, C.RBasic.offsetof(:flags)])
asm.and(flags_reg, C::RUBY_T_MASK)
# Compare the result with T_STRING
asm.cmp(flags_reg, C::RUBY_T_STRING)
asm.jne(side_exit)
if object_type.diff(Type::TString) != TypeDiff::Incompatible
ctx.upgrade_opnd_type(object_opnd, Type::TString)
end
end
# clobbers object_reg
def guard_object_is_not_ruby2_keyword_hash(asm, object_reg, flags_reg, side_exit)
asm.comment('guard object is not ruby2 keyword hash')
not_ruby2_keyword = asm.new_label('not_ruby2_keyword')
asm.test(object_reg, C::RUBY_IMMEDIATE_MASK)
asm.jnz(not_ruby2_keyword)
asm.cmp(object_reg, Qfalse)
asm.je(not_ruby2_keyword)
asm.mov(flags_reg, [object_reg, C.RBasic.offsetof(:flags)])
type_reg = object_reg
asm.mov(type_reg, flags_reg)
asm.and(type_reg, C::RUBY_T_MASK)
asm.cmp(type_reg, C::RUBY_T_HASH)
asm.jne(not_ruby2_keyword)
asm.test(flags_reg, C::RHASH_PASS_AS_KEYWORDS)
asm.jnz(side_exit)
asm.write_label(not_ruby2_keyword)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_chain_guard(opcode, jit, ctx, asm, side_exit, limit: 20)
opcode => :je | :jne | :jnz | :jz
if ctx.chain_depth < limit
deeper = ctx.dup
deeper.chain_depth += 1
branch_stub = BranchStub.new(
iseq: jit.iseq,
shape: Default,
target0: BranchTarget.new(ctx: deeper, pc: jit.pc),
)
branch_stub.target0.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(deeper, ocb_asm, branch_stub, true)
@ocb.write(ocb_asm)
end
branch_stub.compile = compile_jit_chain_guard(branch_stub, opcode:)
branch_stub.compile.call(asm)
else
asm.public_send(opcode, side_exit)
end
end
def compile_jit_chain_guard(branch_stub, opcode:) # Proc escapes arguments in memory
proc do |branch_asm|
# Not using `asm.comment` here since it's usually put before cmp/test before this.
branch_asm.stub(branch_stub) do
case branch_stub.shape
in Default
branch_asm.public_send(opcode, branch_stub.target0.address)
end
end
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_guard_known_klass(jit, ctx, asm, known_klass, obj_opnd, insn_opnd, comptime_obj, side_exit, limit: 10)
# Only memory operand is supported for now
assert_equal(true, obj_opnd.is_a?(Array))
known_klass = C.to_value(known_klass)
val_type = ctx.get_opnd_type(insn_opnd)
if val_type.known_class == known_klass
# We already know from type information that this is a match
return
end
# Touching this as Ruby could crash for FrozenCore
if known_klass == C.rb_cNilClass
assert(!val_type.heap?)
assert(val_type.unknown?)
asm.comment('guard object is nil')
asm.cmp(obj_opnd, Qnil)
jit_chain_guard(:jne, jit, ctx, asm, side_exit, limit:)
ctx.upgrade_opnd_type(insn_opnd, Type::Nil)
elsif known_klass == C.rb_cTrueClass
assert(!val_type.heap?)
assert(val_type.unknown?)
asm.comment('guard object is true')
asm.cmp(obj_opnd, Qtrue)
jit_chain_guard(:jne, jit, ctx, asm, side_exit, limit:)
ctx.upgrade_opnd_type(insn_opnd, Type::True)
elsif known_klass == C.rb_cFalseClass
assert(!val_type.heap?)
assert(val_type.unknown?)
asm.comment('guard object is false')
asm.cmp(obj_opnd, Qfalse)
jit_chain_guard(:jne, jit, ctx, asm, side_exit, limit:)
ctx.upgrade_opnd_type(insn_opnd, Type::False)
elsif known_klass == C.rb_cInteger && fixnum?(comptime_obj)
# We will guard fixnum and bignum as though they were separate classes
# BIGNUM can be handled by the general else case below
assert(val_type.unknown?)
asm.comment('guard object is fixnum')
asm.test(obj_opnd, C::RUBY_FIXNUM_FLAG)
jit_chain_guard(:jz, jit, ctx, asm, side_exit, limit:)
ctx.upgrade_opnd_type(insn_opnd, Type::Fixnum)
elsif known_klass == C.rb_cSymbol && static_symbol?(comptime_obj)
assert(!val_type.heap?)
# We will guard STATIC vs DYNAMIC as though they were separate classes
# DYNAMIC symbols can be handled by the general else case below
if val_type != Type::ImmSymbol || !val_type.imm?
assert(val_type.unknown?)
asm.comment('guard object is static symbol')
assert_equal(8, C::RUBY_SPECIAL_SHIFT)
asm.cmp(BytePtr[*obj_opnd], C::RUBY_SYMBOL_FLAG)
jit_chain_guard(:jne, jit, ctx, asm, side_exit, limit:)
ctx.upgrade_opnd_type(insn_opnd, Type::ImmSymbol)
end
elsif known_klass == C.rb_cFloat && flonum?(comptime_obj)
assert(!val_type.heap?)
if val_type != Type::Flonum || !val_type.imm?
assert(val_type.unknown?)
# We will guard flonum vs heap float as though they were separate classes
asm.comment('guard object is flonum')
asm.mov(:rax, obj_opnd)
asm.and(:rax, C::RUBY_FLONUM_MASK)
asm.cmp(:rax, C::RUBY_FLONUM_FLAG)
jit_chain_guard(:jne, jit, ctx, asm, side_exit, limit:)
ctx.upgrade_opnd_type(insn_opnd, Type::Flonum)
end
elsif C.FL_TEST(known_klass, C::RUBY_FL_SINGLETON) && comptime_obj == C.rb_class_attached_object(known_klass)
# Singleton classes are attached to one specific object, so we can
# avoid one memory access (and potentially the is_heap check) by
# looking for the expected object directly.
# Note that in case the sample instance has a singleton class that
# doesn't attach to the sample instance, it means the sample instance
# has an empty singleton class that hasn't been materialized yet. In
# this case, comparing against the sample instance doesn't guarantee
# that its singleton class is empty, so we can't avoid the memory
# access. As an example, `Object.new.singleton_class` is an object in
# this situation.
asm.comment('guard known object with singleton class')
asm.mov(:rax, to_value(comptime_obj))
asm.cmp(obj_opnd, :rax)
jit_chain_guard(:jne, jit, ctx, asm, side_exit, limit:)
elsif val_type == Type::CString && known_klass == C.rb_cString
# guard elided because the context says we've already checked
assert_equal(C.to_value(C.rb_class_of(comptime_obj)), C.rb_cString)
else
assert(!val_type.imm?)
# Load memory to a register
asm.mov(:rax, obj_opnd)
obj_opnd = :rax
# Check that the receiver is a heap object
# Note: if we get here, the class doesn't have immediate instances.
unless val_type.heap?
asm.comment('guard not immediate')
asm.test(obj_opnd, C::RUBY_IMMEDIATE_MASK)
jit_chain_guard(:jnz, jit, ctx, asm, side_exit, limit:)
asm.cmp(obj_opnd, Qfalse)
jit_chain_guard(:je, jit, ctx, asm, side_exit, limit:)
end
# Bail if receiver class is different from known_klass
klass_opnd = [obj_opnd, C.RBasic.offsetof(:klass)]
asm.comment("guard known class #{known_klass}")
asm.mov(:rcx, known_klass)
asm.cmp(klass_opnd, :rcx)
jit_chain_guard(:jne, jit, ctx, asm, side_exit, limit:)
if known_klass == C.rb_cString
# Upgrading to Type::CString here is incorrect.
# The guard we put only checks RBASIC_CLASS(obj),
# which adding a singleton class can change. We
# additionally need to know the string is frozen
# to claim Type::CString.
ctx.upgrade_opnd_type(insn_opnd, Type::TString)
elsif known_klass == C.rb_cArray
ctx.upgrade_opnd_type(insn_opnd, Type::TArray)
end
end
end
# @param jit [RubyVM::RJIT::JITState]
def two_fixnums_on_stack?(jit)
comptime_recv = jit.peek_at_stack(1)
comptime_arg = jit.peek_at_stack(0)
return fixnum?(comptime_recv) && fixnum?(comptime_arg)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def guard_two_fixnums(jit, ctx, asm)
# Get stack operands without popping them
arg1 = ctx.stack_opnd(0)
arg0 = ctx.stack_opnd(1)
# Get the stack operand types
arg1_type = ctx.get_opnd_type(StackOpnd[0])
arg0_type = ctx.get_opnd_type(StackOpnd[1])
if arg0_type.heap? || arg1_type.heap?
asm.comment('arg is heap object')
asm.jmp(side_exit(jit, ctx))
return
end
if arg0_type != Type::Fixnum && arg0_type.specific?
asm.comment('arg0 not fixnum')
asm.jmp(side_exit(jit, ctx))
return
end
if arg1_type != Type::Fixnum && arg1_type.specific?
asm.comment('arg1 not fixnum')
asm.jmp(side_exit(jit, ctx))
return
end
assert(!arg0_type.heap?)
assert(!arg1_type.heap?)
assert(arg0_type == Type::Fixnum || arg0_type.unknown?)
assert(arg1_type == Type::Fixnum || arg1_type.unknown?)
# If not fixnums at run-time, fall back
if arg0_type != Type::Fixnum
asm.comment('guard arg0 fixnum')
asm.test(arg0, C::RUBY_FIXNUM_FLAG)
jit_chain_guard(:jz, jit, ctx, asm, side_exit(jit, ctx))
end
if arg1_type != Type::Fixnum
asm.comment('guard arg1 fixnum')
asm.test(arg1, C::RUBY_FIXNUM_FLAG)
jit_chain_guard(:jz, jit, ctx, asm, side_exit(jit, ctx))
end
# Set stack types in context
ctx.upgrade_opnd_type(StackOpnd[0], Type::Fixnum)
ctx.upgrade_opnd_type(StackOpnd[1], Type::Fixnum)
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_fixnum_cmp(jit, ctx, asm, opcode:, bop:)
opcode => :cmovl | :cmovle | :cmovg | :cmovge
unless jit.at_current_insn?
defer_compilation(jit, ctx, asm)
return EndBlock
end
comptime_recv = jit.peek_at_stack(1)
comptime_obj = jit.peek_at_stack(0)
if fixnum?(comptime_recv) && fixnum?(comptime_obj)
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, bop)
return CantCompile
end
# Check that both operands are fixnums
guard_two_fixnums(jit, ctx, asm)
obj_opnd = ctx.stack_pop
recv_opnd = ctx.stack_pop
asm.mov(:rax, obj_opnd)
asm.cmp(recv_opnd, :rax)
asm.mov(:rax, Qfalse)
asm.mov(:rcx, Qtrue)
asm.public_send(opcode, :rax, :rcx)
dst_opnd = ctx.stack_push(Type::UnknownImm)
asm.mov(dst_opnd, :rax)
KeepCompiling
else
opt_send_without_block(jit, ctx, asm)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_equality_specialized(jit, ctx, asm, gen_eq)
# Create a side-exit to fall back to the interpreter
side_exit = side_exit(jit, ctx)
a_opnd = ctx.stack_opnd(1)
b_opnd = ctx.stack_opnd(0)
comptime_a = jit.peek_at_stack(1)
comptime_b = jit.peek_at_stack(0)
if two_fixnums_on_stack?(jit)
unless Invariants.assume_bop_not_redefined(jit, C::INTEGER_REDEFINED_OP_FLAG, C::BOP_EQ)
return false
end
guard_two_fixnums(jit, ctx, asm)
asm.comment('check fixnum equality')
asm.mov(:rax, a_opnd)
asm.mov(:rcx, b_opnd)
asm.cmp(:rax, :rcx)
asm.mov(:rax, gen_eq ? Qfalse : Qtrue)
asm.mov(:rcx, gen_eq ? Qtrue : Qfalse)
asm.cmove(:rax, :rcx)
# Push the output on the stack
ctx.stack_pop(2)
dst = ctx.stack_push(Type::UnknownImm)
asm.mov(dst, :rax)
true
elsif C.rb_class_of(comptime_a) == String && C.rb_class_of(comptime_b) == String
unless Invariants.assume_bop_not_redefined(jit, C::STRING_REDEFINED_OP_FLAG, C::BOP_EQ)
# if overridden, emit the generic version
return false
end
# Guard that a is a String
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_a), a_opnd, StackOpnd[1], comptime_a, side_exit)
equal_label = asm.new_label(:equal)
ret_label = asm.new_label(:ret)
# If they are equal by identity, return true
asm.mov(:rax, a_opnd)
asm.mov(:rcx, b_opnd)
asm.cmp(:rax, :rcx)
asm.je(equal_label)
# Otherwise guard that b is a T_STRING (from type info) or String (from runtime guard)
btype = ctx.get_opnd_type(StackOpnd[0])
unless btype.string?
# Note: any T_STRING is valid here, but we check for a ::String for simplicity
# To pass a mutable static variable (rb_cString) requires an unsafe block
jit_guard_known_klass(jit, ctx, asm, C.rb_class_of(comptime_b), b_opnd, StackOpnd[0], comptime_b, side_exit)
end
asm.comment('call rb_str_eql_internal')
asm.mov(C_ARGS[0], a_opnd)
asm.mov(C_ARGS[1], b_opnd)
asm.call(gen_eq ? C.rb_str_eql_internal : C.rjit_str_neq_internal)
# Push the output on the stack
ctx.stack_pop(2)
dst = ctx.stack_push(Type::UnknownImm)
asm.mov(dst, C_RET)
asm.jmp(ret_label)
asm.write_label(equal_label)
asm.mov(dst, gen_eq ? Qtrue : Qfalse)
asm.write_label(ret_label)
true
else
false
end
end
# NOTE: This clobbers :rax
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_prepare_routine_call(jit, ctx, asm)
jit.record_boundary_patch_point = true
jit_save_pc(jit, asm)
jit_save_sp(ctx, asm)
# In case the routine calls Ruby methods, it can set local variables
# through Kernel#binding and other means.
ctx.clear_local_types
end
# NOTE: This clobbers :rax
# @param jit [RubyVM::RJIT::JITState]
# @param asm [RubyVM::RJIT::Assembler]
def jit_save_pc(jit, asm, comment: 'save PC to CFP')
next_pc = jit.pc + jit.insn.len * C.VALUE.size # Use the next one for backtrace and side exits
asm.comment(comment)
asm.mov(:rax, next_pc)
asm.mov([CFP, C.rb_control_frame_t.offsetof(:pc)], :rax)
end
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_save_sp(ctx, asm)
if ctx.sp_offset != 0
asm.comment('save SP to CFP')
asm.lea(SP, ctx.sp_opnd)
asm.mov([CFP, C.rb_control_frame_t.offsetof(:sp)], SP)
ctx.sp_offset = 0
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jump_to_next_insn(jit, ctx, asm)
reset_depth = ctx.dup
reset_depth.chain_depth = 0
next_pc = jit.pc + jit.insn.len * C.VALUE.size
# We are at the end of the current instruction. Record the boundary.
if jit.record_boundary_patch_point
exit_pos = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_side_exit(next_pc, ctx, ocb_asm)
@ocb.write(ocb_asm)
end
Invariants.record_global_inval_patch(asm, exit_pos)
jit.record_boundary_patch_point = false
end
jit_direct_jump(jit.iseq, next_pc, reset_depth, asm, comment: 'jump_to_next_insn')
end
# rb_vm_check_ints
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_check_ints(jit, ctx, asm)
asm.comment('RUBY_VM_CHECK_INTS(ec)')
asm.mov(:eax, DwordPtr[EC, C.rb_execution_context_t.offsetof(:interrupt_flag)])
asm.test(:eax, :eax)
asm.jnz(side_exit(jit, ctx))
end
# See get_lvar_level in compile.c
def get_lvar_level(iseq)
level = 0
while iseq.to_i != iseq.body.local_iseq.to_i
level += 1
iseq = iseq.body.parent_iseq
end
return level
end
# GET_LEP
# @param jit [RubyVM::RJIT::JITState]
# @param asm [RubyVM::RJIT::Assembler]
def jit_get_lep(jit, asm, reg:)
level = get_lvar_level(jit.iseq)
jit_get_ep(asm, level, reg:)
end
# vm_get_ep
# @param asm [RubyVM::RJIT::Assembler]
def jit_get_ep(asm, level, reg:)
asm.mov(reg, [CFP, C.rb_control_frame_t.offsetof(:ep)])
level.times do
# GET_PREV_EP: ep[VM_ENV_DATA_INDEX_SPECVAL] & ~0x03
asm.mov(reg, [reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL])
asm.and(reg, ~0x03)
end
end
# vm_getivar
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_getivar(jit, ctx, asm, comptime_obj, ivar_id, obj_opnd, obj_yarv_opnd)
side_exit = side_exit(jit, ctx)
starting_ctx = ctx.dup # copy for jit_chain_guard
# Guard not special const
if C::SPECIAL_CONST_P(comptime_obj)
asm.incr_counter(:getivar_special_const)
return CantCompile
end
case C::BUILTIN_TYPE(comptime_obj)
when C::T_OBJECT
# This is the only supported case for now (ROBJECT_IVPTR)
else
# General case. Call rb_ivar_get().
# VALUE rb_ivar_get(VALUE obj, ID id)
asm.comment('call rb_ivar_get()')
asm.mov(C_ARGS[0], obj_opnd ? obj_opnd : [CFP, C.rb_control_frame_t.offsetof(:self)])
asm.mov(C_ARGS[1], ivar_id)
# The function could raise exceptions.
jit_prepare_routine_call(jit, ctx, asm) # clobbers obj_opnd and :rax
asm.call(C.rb_ivar_get)
if obj_opnd # attr_reader
ctx.stack_pop
end
# Push the ivar on the stack
out_opnd = ctx.stack_push(Type::Unknown)
asm.mov(out_opnd, C_RET)
# Jump to next instruction. This allows guard chains to share the same successor.
jump_to_next_insn(jit, ctx, asm)
return EndBlock
end
asm.mov(:rax, obj_opnd ? obj_opnd : [CFP, C.rb_control_frame_t.offsetof(:self)])
guard_object_is_heap(jit, ctx, asm, :rax, obj_yarv_opnd, :getivar_not_heap)
shape_id = C.rb_shape_get_shape_id(comptime_obj)
if shape_id == C::OBJ_TOO_COMPLEX_SHAPE_ID
asm.incr_counter(:getivar_too_complex)
return CantCompile
end
asm.comment('guard shape')
asm.cmp(DwordPtr[:rax, C.rb_shape_id_offset], shape_id)
jit_chain_guard(:jne, jit, starting_ctx, asm, counted_exit(side_exit, :getivar_megamorphic))
if obj_opnd
ctx.stack_pop # pop receiver for attr_reader
end
index = C.rb_shape_get_iv_index(shape_id, ivar_id)
# If there is no IVAR index, then the ivar was undefined
# when we entered the compiler. That means we can just return
# nil for this shape + iv name
if index.nil?
stack_opnd = ctx.stack_push(Type::Nil)
val_opnd = Qnil
else
asm.comment('ROBJECT_IVPTR')
if C::FL_TEST_RAW(comptime_obj, C::ROBJECT_EMBED)
# Access embedded array
asm.mov(:rax, [:rax, C.RObject.offsetof(:as, :ary) + (index * C.VALUE.size)])
else
# Pull out an ivar table on heap
asm.mov(:rax, [:rax, C.RObject.offsetof(:as, :heap, :ivptr)])
# Read the table
asm.mov(:rax, [:rax, index * C.VALUE.size])
end
stack_opnd = ctx.stack_push(Type::Unknown)
val_opnd = :rax
end
asm.mov(stack_opnd, val_opnd)
# Let guard chains share the same successor
jump_to_next_insn(jit, ctx, asm)
EndBlock
end
def jit_write_iv(asm, comptime_receiver, recv_reg, temp_reg, ivar_index, set_value, needs_extension)
# Compile time self is embedded and the ivar index lands within the object
embed_test_result = C::FL_TEST_RAW(comptime_receiver, C::ROBJECT_EMBED) && !needs_extension
if embed_test_result
# Find the IV offset
offs = C.RObject.offsetof(:as, :ary) + ivar_index * C.VALUE.size
# Write the IV
asm.comment('write IV')
asm.mov(temp_reg, set_value)
asm.mov([recv_reg, offs], temp_reg)
else
# Compile time value is *not* embedded.
# Get a pointer to the extended table
asm.mov(recv_reg, [recv_reg, C.RObject.offsetof(:as, :heap, :ivptr)])
# Write the ivar in to the extended table
asm.comment("write IV");
asm.mov(temp_reg, set_value)
asm.mov([recv_reg, C.VALUE.size * ivar_index], temp_reg)
end
end
# vm_caller_setup_arg_block: Handle VM_CALL_ARGS_BLOCKARG cases.
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def guard_block_arg(jit, ctx, asm, calling)
if calling.flags & C::VM_CALL_ARGS_BLOCKARG != 0
block_arg_type = ctx.get_opnd_type(StackOpnd[0])
case block_arg_type
in Type::Nil
calling.block_handler = C::VM_BLOCK_HANDLER_NONE
in Type::BlockParamProxy
calling.block_handler = C.rb_block_param_proxy
else
asm.incr_counter(:send_block_arg)
return CantCompile
end
end
end
# vm_search_method
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_search_method(jit, ctx, asm, mid, calling)
assert_equal(true, jit.at_current_insn?)
# Generate a side exit
side_exit = side_exit(jit, ctx)
# kw_splat is not supported yet
if calling.flags & C::VM_CALL_KW_SPLAT != 0
asm.incr_counter(:send_kw_splat)
return CantCompile
end
# Get a compile-time receiver and its class
recv_idx = calling.argc + (calling.flags & C::VM_CALL_ARGS_BLOCKARG != 0 ? 1 : 0) # blockarg is not popped yet
recv_idx += calling.send_shift
comptime_recv = jit.peek_at_stack(recv_idx)
comptime_recv_klass = C.rb_class_of(comptime_recv)
# Guard the receiver class (part of vm_search_method_fastpath)
recv_opnd = ctx.stack_opnd(recv_idx)
megamorphic_exit = counted_exit(side_exit, :send_klass_megamorphic)
jit_guard_known_klass(jit, ctx, asm, comptime_recv_klass, recv_opnd, StackOpnd[recv_idx], comptime_recv, megamorphic_exit)
# Do method lookup (vm_cc_cme(cc) != NULL)
cme = C.rb_callable_method_entry(comptime_recv_klass, mid)
if cme.nil?
asm.incr_counter(:send_missing_cme)
return CantCompile # We don't support vm_call_method_name
end
# Invalidate on redefinition (part of vm_search_method_fastpath)
Invariants.assume_method_lookup_stable(jit, cme)
return cme, comptime_recv_klass
end
# vm_call_general
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_general(jit, ctx, asm, mid, calling, cme, known_recv_class)
jit_call_method(jit, ctx, asm, mid, calling, cme, known_recv_class)
end
# vm_call_method
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
# @param send_shift [Integer] The number of shifts needed for VM_CALL_OPT_SEND
def jit_call_method(jit, ctx, asm, mid, calling, cme, known_recv_class)
# The main check of vm_call_method before vm_call_method_each_type
case C::METHOD_ENTRY_VISI(cme)
in C::METHOD_VISI_PUBLIC
# You can always call public methods
in C::METHOD_VISI_PRIVATE
# Allow only callsites without a receiver
if calling.flags & C::VM_CALL_FCALL == 0
asm.incr_counter(:send_private)
return CantCompile
end
in C::METHOD_VISI_PROTECTED
# If the method call is an FCALL, it is always valid
if calling.flags & C::VM_CALL_FCALL == 0
# otherwise we need an ancestry check to ensure the receiver is valid to be called as protected
jit_protected_callee_ancestry_guard(asm, cme, side_exit(jit, ctx))
end
end
# Get a compile-time receiver
recv_idx = calling.argc + (calling.flags & C::VM_CALL_ARGS_BLOCKARG != 0 ? 1 : 0) # blockarg is not popped yet
recv_idx += calling.send_shift
comptime_recv = jit.peek_at_stack(recv_idx)
recv_opnd = ctx.stack_opnd(recv_idx)
jit_call_method_each_type(jit, ctx, asm, calling, cme, comptime_recv, recv_opnd, known_recv_class)
end
# Generate ancestry guard for protected callee.
# Calls to protected callees only go through when self.is_a?(klass_that_defines_the_callee).
def jit_protected_callee_ancestry_guard(asm, cme, side_exit)
# See vm_call_method().
def_class = cme.defined_class
# Note: PC isn't written to current control frame as rb_is_kind_of() shouldn't raise.
# VALUE rb_obj_is_kind_of(VALUE obj, VALUE klass);
asm.mov(C_ARGS[0], [CFP, C.rb_control_frame_t.offsetof(:self)])
asm.mov(C_ARGS[1], to_value(def_class))
asm.call(C.rb_obj_is_kind_of)
asm.test(C_RET, C_RET)
asm.jz(counted_exit(side_exit, :send_protected_check_failed))
end
# vm_call_method_each_type
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_method_each_type(jit, ctx, asm, calling, cme, comptime_recv, recv_opnd, known_recv_class)
case cme.def.type
in C::VM_METHOD_TYPE_ISEQ
iseq = def_iseq_ptr(cme.def)
jit_call_iseq(jit, ctx, asm, cme, calling, iseq)
in C::VM_METHOD_TYPE_NOTIMPLEMENTED
asm.incr_counter(:send_notimplemented)
return CantCompile
in C::VM_METHOD_TYPE_CFUNC
jit_call_cfunc(jit, ctx, asm, cme, calling, known_recv_class:)
in C::VM_METHOD_TYPE_ATTRSET
jit_call_attrset(jit, ctx, asm, cme, calling, comptime_recv, recv_opnd)
in C::VM_METHOD_TYPE_IVAR
jit_call_ivar(jit, ctx, asm, cme, calling, comptime_recv, recv_opnd)
in C::VM_METHOD_TYPE_MISSING
asm.incr_counter(:send_missing)
return CantCompile
in C::VM_METHOD_TYPE_BMETHOD
jit_call_bmethod(jit, ctx, asm, calling, cme, comptime_recv, recv_opnd, known_recv_class)
in C::VM_METHOD_TYPE_ALIAS
jit_call_alias(jit, ctx, asm, calling, cme, comptime_recv, recv_opnd, known_recv_class)
in C::VM_METHOD_TYPE_OPTIMIZED
jit_call_optimized(jit, ctx, asm, cme, calling, known_recv_class)
in C::VM_METHOD_TYPE_UNDEF
asm.incr_counter(:send_undef)
return CantCompile
in C::VM_METHOD_TYPE_ZSUPER
asm.incr_counter(:send_zsuper)
return CantCompile
in C::VM_METHOD_TYPE_REFINED
asm.incr_counter(:send_refined)
return CantCompile
end
end
# vm_call_iseq_setup
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_iseq(jit, ctx, asm, cme, calling, iseq, frame_type: nil, prev_ep: nil)
argc = calling.argc
flags = calling.flags
send_shift = calling.send_shift
# When you have keyword arguments, there is an extra object that gets
# placed on the stack the represents a bitmap of the keywords that were not
# specified at the call site. We need to keep track of the fact that this
# value is present on the stack in order to properly set up the callee's
# stack pointer.
doing_kw_call = iseq.body.param.flags.has_kw
supplying_kws = flags & C::VM_CALL_KWARG != 0
if flags & C::VM_CALL_TAILCALL != 0
# We can't handle tailcalls
asm.incr_counter(:send_tailcall)
return CantCompile
end
# No support for callees with these parameters yet as they require allocation
# or complex handling.
if iseq.body.param.flags.has_post
asm.incr_counter(:send_iseq_has_opt)
return CantCompile
end
if iseq.body.param.flags.has_kwrest
asm.incr_counter(:send_iseq_has_kwrest)
return CantCompile
end
# In order to handle backwards compatibility between ruby 3 and 2
# ruby2_keywords was introduced. It is called only on methods
# with splat and changes they way they handle them.
# We are just going to not compile these.
# https://www.rubydoc.info/stdlib/core/Proc:ruby2_keywords
if iseq.body.param.flags.ruby2_keywords && flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:send_iseq_ruby2_keywords)
return CantCompile
end
iseq_has_rest = iseq.body.param.flags.has_rest
if iseq_has_rest && calling.block_handler == :captured
asm.incr_counter(:send_iseq_has_rest_and_captured)
return CantCompile
end
if iseq_has_rest && iseq.body.param.flags.has_kw && supplying_kws
asm.incr_counter(:send_iseq_has_rest_and_kw_supplied)
return CantCompile
end
# If we have keyword arguments being passed to a callee that only takes
# positionals, then we need to allocate a hash. For now we're going to
# call that too complex and bail.
if supplying_kws && !iseq.body.param.flags.has_kw
asm.incr_counter(:send_iseq_has_no_kw)
return CantCompile
end
# If we have a method accepting no kwargs (**nil), exit if we have passed
# it any kwargs.
if supplying_kws && iseq.body.param.flags.accepts_no_kwarg
asm.incr_counter(:send_iseq_accepts_no_kwarg)
return CantCompile
end
# For computing number of locals to set up for the callee
num_params = iseq.body.param.size
# Block parameter handling. This mirrors setup_parameters_complex().
if iseq.body.param.flags.has_block
if iseq.body.local_iseq.to_i == iseq.to_i
num_params -= 1
else
# In this case (param.flags.has_block && local_iseq != iseq),
# the block argument is setup as a local variable and requires
# materialization (allocation). Bail.
asm.incr_counter(:send_iseq_materialized_block)
return CantCompile
end
end
if flags & C::VM_CALL_ARGS_SPLAT != 0 && flags & C::VM_CALL_ZSUPER != 0
# zsuper methods are super calls without any arguments.
# They are also marked as splat, but don't actually have an array
# they pull arguments from, instead we need to change to call
# a different method with the current stack.
asm.incr_counter(:send_iseq_zsuper)
return CantCompile
end
start_pc_offset = 0
required_num = iseq.body.param.lead_num
# This struct represents the metadata about the caller-specified
# keyword arguments.
kw_arg = calling.kwarg
kw_arg_num = if kw_arg.nil?
0
else
kw_arg.keyword_len
end
# Arity handling and optional parameter setup
opts_filled = argc - required_num - kw_arg_num
opt_num = iseq.body.param.opt_num
opts_missing = opt_num - opts_filled
if doing_kw_call && flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:send_iseq_splat_with_kw)
return CantCompile
end
if iseq_has_rest && opt_num != 0
asm.incr_counter(:send_iseq_has_rest_and_optional)
return CantCompile
end
if opts_filled < 0 && flags & C::VM_CALL_ARGS_SPLAT == 0
# Too few arguments and no splat to make up for it
asm.incr_counter(:send_iseq_arity_error)
return CantCompile
end
if opts_filled > opt_num && !iseq_has_rest
# Too many arguments and no place to put them (i.e. rest arg)
asm.incr_counter(:send_iseq_arity_error)
return CantCompile
end
block_arg = flags & C::VM_CALL_ARGS_BLOCKARG != 0
# Guard block_arg_type
if guard_block_arg(jit, ctx, asm, calling) == CantCompile
return CantCompile
end
# If we have unfilled optional arguments and keyword arguments then we
# would need to adjust the arguments location to account for that.
# For now we aren't handling this case.
if doing_kw_call && opts_missing > 0
asm.incr_counter(:send_iseq_missing_optional_kw)
return CantCompile
end
# We will handle splat case later
if opt_num > 0 && flags & C::VM_CALL_ARGS_SPLAT == 0
num_params -= opts_missing
start_pc_offset = iseq.body.param.opt_table[opts_filled]
end
if doing_kw_call
# Here we're calling a method with keyword arguments and specifying
# keyword arguments at this call site.
# This struct represents the metadata about the callee-specified
# keyword parameters.
keyword = iseq.body.param.keyword
keyword_num = keyword.num
keyword_required_num = keyword.required_num
required_kwargs_filled = 0
if keyword_num > 30
# We have so many keywords that (1 << num) encoded as a FIXNUM
# (which shifts it left one more) no longer fits inside a 32-bit
# immediate.
asm.incr_counter(:send_iseq_too_many_kwargs)
return CantCompile
end
# Check that the kwargs being passed are valid
if supplying_kws
# This is the list of keyword arguments that the callee specified
# in its initial declaration.
# SAFETY: see compile.c for sizing of this slice.
callee_kwargs = keyword_num.times.map { |i| keyword.table[i] }
# Here we're going to build up a list of the IDs that correspond to
# the caller-specified keyword arguments. If they're not in the
# same order as the order specified in the callee declaration, then
# we're going to need to generate some code to swap values around
# on the stack.
caller_kwargs = []
kw_arg.keyword_len.times do |kwarg_idx|
sym = C.to_ruby(kw_arg[:keywords][kwarg_idx])
caller_kwargs << C.rb_sym2id(sym)
end
# First, we're going to be sure that the names of every
# caller-specified keyword argument correspond to a name in the
# list of callee-specified keyword parameters.
caller_kwargs.each do |caller_kwarg|
search_result = callee_kwargs.map.with_index.find { |kwarg, _| kwarg == caller_kwarg }
case search_result
in nil
# If the keyword was never found, then we know we have a
# mismatch in the names of the keyword arguments, so we need to
# bail.
asm.incr_counter(:send_iseq_kwargs_mismatch)
return CantCompile
in _, callee_idx if callee_idx < keyword_required_num
# Keep a count to ensure all required kwargs are specified
required_kwargs_filled += 1
else
end
end
end
assert_equal(true, required_kwargs_filled <= keyword_required_num)
if required_kwargs_filled != keyword_required_num
asm.incr_counter(:send_iseq_kwargs_mismatch)
return CantCompile
end
end
# Check if we need the arg0 splat handling of vm_callee_setup_block_arg
arg_setup_block = (calling.block_handler == :captured) # arg_setup_type: arg_setup_block (invokeblock)
block_arg0_splat = arg_setup_block && argc == 1 &&
(iseq.body.param.flags.has_lead || opt_num > 1) &&
!iseq.body.param.flags.ambiguous_param0
if block_arg0_splat
# If block_arg0_splat, we still need side exits after splat, but
# doing push_splat_args here disallows it. So bail out.
if flags & C::VM_CALL_ARGS_SPLAT != 0 && !iseq_has_rest
asm.incr_counter(:invokeblock_iseq_arg0_args_splat)
return CantCompile
end
# The block_arg0_splat implementation is for the rb_simple_iseq_p case,
# but doing_kw_call means it's not a simple ISEQ.
if doing_kw_call
asm.incr_counter(:invokeblock_iseq_arg0_has_kw)
return CantCompile
end
# The block_arg0_splat implementation cannot deal with optional parameters.
# This is a setup_parameters_complex() situation and interacts with the
# starting position of the callee.
if opt_num > 1
asm.incr_counter(:invokeblock_iseq_arg0_optional)
return CantCompile
end
end
if flags & C::VM_CALL_ARGS_SPLAT != 0 && !iseq_has_rest
array = jit.peek_at_stack(block_arg ? 1 : 0)
splat_array_length = if array.nil?
0
else
array.length
end
if opt_num == 0 && required_num != splat_array_length + argc - 1
asm.incr_counter(:send_iseq_splat_arity_error)
return CantCompile
end
end
# We will not have CantCompile from here.
if block_arg
ctx.stack_pop(1)
end
if calling.block_handler == C::VM_BLOCK_HANDLER_NONE && iseq.body.builtin_attrs & C::BUILTIN_ATTR_LEAF != 0
if jit_leaf_builtin_func(jit, ctx, asm, flags, iseq)
return KeepCompiling
end
end
# Number of locals that are not parameters
num_locals = iseq.body.local_table_size - num_params
# Stack overflow check
# Note that vm_push_frame checks it against a decremented cfp, hence the multiply by 2.
# #define CHECK_VM_STACK_OVERFLOW0(cfp, sp, margin)
asm.comment('stack overflow check')
locals_offs = C.VALUE.size * (num_locals + iseq.body.stack_max) + 2 * C.rb_control_frame_t.size
asm.lea(:rax, ctx.sp_opnd(locals_offs))
asm.cmp(CFP, :rax)
asm.jbe(counted_exit(side_exit(jit, ctx), :send_stackoverflow))
# push_splat_args does stack manipulation so we can no longer side exit
if splat_array_length
remaining_opt = (opt_num + required_num) - (splat_array_length + (argc - 1))
if opt_num > 0
# We are going to jump to the correct offset based on how many optional
# params are remaining.
offset = opt_num - remaining_opt
start_pc_offset = iseq.body.param.opt_table[offset]
end
# We are going to assume that the splat fills
# all the remaining arguments. In the generated code
# we test if this is true and if not side exit.
argc = argc - 1 + splat_array_length + remaining_opt
push_splat_args(splat_array_length, jit, ctx, asm)
remaining_opt.times do
# We need to push nil for the optional arguments
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, Qnil)
end
end
# This is a .send call and we need to adjust the stack
if flags & C::VM_CALL_OPT_SEND != 0
handle_opt_send_shift_stack(asm, argc, ctx, send_shift:)
end
if iseq_has_rest
# We are going to allocate so setting pc and sp.
jit_save_pc(jit, asm) # clobbers rax
jit_save_sp(ctx, asm)
if flags & C::VM_CALL_ARGS_SPLAT != 0
non_rest_arg_count = argc - 1
# We start by dupping the array because someone else might have
# a reference to it.
array = ctx.stack_pop(1)
asm.mov(C_ARGS[0], array)
asm.call(C.rb_ary_dup)
array = C_RET
if non_rest_arg_count > required_num
# If we have more arguments than required, we need to prepend
# the items from the stack onto the array.
diff = (non_rest_arg_count - required_num)
# diff is >0 so no need to worry about null pointer
asm.comment('load pointer to array elements')
offset_magnitude = C.VALUE.size * diff
values_opnd = ctx.sp_opnd(-offset_magnitude)
values_ptr = :rcx
asm.lea(values_ptr, values_opnd)
asm.comment('prepend stack values to rest array')
asm.mov(C_ARGS[0], diff)
asm.mov(C_ARGS[1], values_ptr)
asm.mov(C_ARGS[2], array)
asm.call(C.rb_ary_unshift_m)
ctx.stack_pop(diff)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, C_RET)
# We now should have the required arguments
# and an array of all the rest arguments
argc = required_num + 1
elsif non_rest_arg_count < required_num
# If we have fewer arguments than required, we need to take some
# from the array and move them to the stack.
diff = (required_num - non_rest_arg_count)
# This moves the arguments onto the stack. But it doesn't modify the array.
move_rest_args_to_stack(array, diff, jit, ctx, asm)
# We will now slice the array to give us a new array of the correct size
asm.mov(C_ARGS[0], array)
asm.mov(C_ARGS[1], diff)
asm.call(C.rjit_rb_ary_subseq_length)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, C_RET)
# We now should have the required arguments
# and an array of all the rest arguments
argc = required_num + 1
else
# The arguments are equal so we can just push to the stack
assert_equal(non_rest_arg_count, required_num)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, array)
end
else
assert_equal(true, argc >= required_num)
n = (argc - required_num)
argc = required_num + 1
# If n is 0, then elts is never going to be read, so we can just pass null
if n == 0
values_ptr = 0
else
asm.comment('load pointer to array elements')
offset_magnitude = C.VALUE.size * n
values_opnd = ctx.sp_opnd(-offset_magnitude)
values_ptr = :rcx
asm.lea(values_ptr, values_opnd)
end
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], n)
asm.mov(C_ARGS[2], values_ptr)
asm.call(C.rb_ec_ary_new_from_values)
ctx.stack_pop(n)
stack_ret = ctx.stack_push(Type::TArray)
asm.mov(stack_ret, C_RET)
end
end
if doing_kw_call
# Here we're calling a method with keyword arguments and specifying
# keyword arguments at this call site.
# Number of positional arguments the callee expects before the first
# keyword argument
args_before_kw = required_num + opt_num
# This struct represents the metadata about the caller-specified
# keyword arguments.
ci_kwarg = calling.kwarg
caller_keyword_len = if ci_kwarg.nil?
0
else
ci_kwarg.keyword_len
end
# This struct represents the metadata about the callee-specified
# keyword parameters.
keyword = iseq.body.param.keyword
asm.comment('keyword args')
# This is the list of keyword arguments that the callee specified
# in its initial declaration.
callee_kwargs = keyword.table
total_kwargs = keyword.num
# Here we're going to build up a list of the IDs that correspond to
# the caller-specified keyword arguments. If they're not in the
# same order as the order specified in the callee declaration, then
# we're going to need to generate some code to swap values around
# on the stack.
caller_kwargs = []
caller_keyword_len.times do |kwarg_idx|
sym = C.to_ruby(ci_kwarg[:keywords][kwarg_idx])
caller_kwargs << C.rb_sym2id(sym)
end
kwarg_idx = caller_keyword_len
unspecified_bits = 0
keyword_required_num = keyword.required_num
(keyword_required_num...total_kwargs).each do |callee_idx|
already_passed = false
callee_kwarg = callee_kwargs[callee_idx]
caller_keyword_len.times do |caller_idx|
if caller_kwargs[caller_idx] == callee_kwarg
already_passed = true
break
end
end
unless already_passed
# Reserve space on the stack for each default value we'll be
# filling in (which is done in the next loop). Also increments
# argc so that the callee's SP is recorded correctly.
argc += 1
default_arg = ctx.stack_push(Type::Unknown)
# callee_idx - keyword->required_num is used in a couple of places below.
req_num = keyword.required_num
extra_args = callee_idx - req_num
# VALUE default_value = keyword->default_values[callee_idx - keyword->required_num];
default_value = keyword.default_values[extra_args]
if default_value == Qundef
# Qundef means that this value is not constant and must be
# recalculated at runtime, so we record it in unspecified_bits
# (Qnil is then used as a placeholder instead of Qundef).
unspecified_bits |= 0x01 << extra_args
default_value = Qnil
end
asm.mov(:rax, default_value)
asm.mov(default_arg, :rax)
caller_kwargs[kwarg_idx] = callee_kwarg
kwarg_idx += 1
end
end
assert_equal(kwarg_idx, total_kwargs)
# Next, we're going to loop through every keyword that was
# specified by the caller and make sure that it's in the correct
# place. If it's not we're going to swap it around with another one.
total_kwargs.times do |kwarg_idx|
callee_kwarg = callee_kwargs[kwarg_idx]
# If the argument is already in the right order, then we don't
# need to generate any code since the expected value is already
# in the right place on the stack.
if callee_kwarg == caller_kwargs[kwarg_idx]
next
end
# In this case the argument is not in the right place, so we
# need to find its position where it _should_ be and swap with
# that location.
((kwarg_idx + 1)...total_kwargs).each do |swap_idx|
if callee_kwarg == caller_kwargs[swap_idx]
# First we're going to generate the code that is going
# to perform the actual swapping at runtime.
offset0 = argc - 1 - swap_idx - args_before_kw
offset1 = argc - 1 - kwarg_idx - args_before_kw
stack_swap(jit, ctx, asm, offset0, offset1)
# Next we're going to do some bookkeeping on our end so
# that we know the order that the arguments are
# actually in now.
caller_kwargs[kwarg_idx], caller_kwargs[swap_idx] =
caller_kwargs[swap_idx], caller_kwargs[kwarg_idx]
break
end
end
end
# Keyword arguments cause a special extra local variable to be
# pushed onto the stack that represents the parameters that weren't
# explicitly given a value and have a non-constant default.
asm.mov(ctx.stack_opnd(-1), C.to_value(unspecified_bits))
end
# Same as vm_callee_setup_block_arg_arg0_check and vm_callee_setup_block_arg_arg0_splat
# on vm_callee_setup_block_arg for arg_setup_block. This is done after CALLER_SETUP_ARG
# and CALLER_REMOVE_EMPTY_KW_SPLAT, so this implementation is put here. This may need
# side exits, so you still need to allow side exits here if block_arg0_splat is true.
# Note that you can't have side exits after this arg0 splat.
if block_arg0_splat
asm.incr_counter(:send_iseq_block_arg0_splat)
return CantCompile
end
# Create a context for the callee
callee_ctx = Context.new
# Set the argument types in the callee's context
argc.times do |arg_idx|
stack_offs = argc - arg_idx - 1
arg_type = ctx.get_opnd_type(StackOpnd[stack_offs])
callee_ctx.set_local_type(arg_idx, arg_type)
end
recv_type = if calling.block_handler == :captured
Type::Unknown # we don't track the type information of captured->self for now
else
ctx.get_opnd_type(StackOpnd[argc])
end
callee_ctx.upgrade_opnd_type(SelfOpnd, recv_type)
# Setup the new frame
frame_type ||= C::VM_FRAME_MAGIC_METHOD | C::VM_ENV_FLAG_LOCAL
jit_push_frame(
jit, ctx, asm, cme, flags, argc, frame_type, calling.block_handler,
iseq: iseq,
local_size: num_locals,
stack_max: iseq.body.stack_max,
prev_ep:,
doing_kw_call:,
)
# Directly jump to the entry point of the callee
pc = (iseq.body.iseq_encoded + start_pc_offset).to_i
jit_direct_jump(iseq, pc, callee_ctx, asm)
EndBlock
end
def jit_leaf_builtin_func(jit, ctx, asm, flags, iseq)
builtin_func = builtin_function(iseq)
if builtin_func.nil?
return false
end
# this is a .send call not currently supported for builtins
if flags & C::VM_CALL_OPT_SEND != 0
return false
end
builtin_argc = builtin_func.argc
if builtin_argc + 1 >= C_ARGS.size
return false
end
asm.comment('inlined leaf builtin')
# Skip this if it doesn't trigger GC
if iseq.body.builtin_attrs & C::BUILTIN_ATTR_NO_GC == 0
# The callee may allocate, e.g. Integer#abs on a Bignum.
# Save SP for GC, save PC for allocation tracing, and prepare
# for global invalidation after GC's VM lock contention.
jit_prepare_routine_call(jit, ctx, asm)
end
# Call the builtin func (ec, recv, arg1, arg2, ...)
asm.mov(C_ARGS[0], EC)
# Copy self and arguments
(0..builtin_argc).each do |i|
stack_opnd = ctx.stack_opnd(builtin_argc - i)
asm.mov(C_ARGS[i + 1], stack_opnd)
end
ctx.stack_pop(builtin_argc + 1)
asm.call(builtin_func.func_ptr)
# Push the return value
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
return true
end
# vm_call_cfunc
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_cfunc(jit, ctx, asm, cme, calling, known_recv_class: nil)
argc = calling.argc
flags = calling.flags
cfunc = cme.def.body.cfunc
cfunc_argc = cfunc.argc
# If the function expects a Ruby array of arguments
if cfunc_argc < 0 && cfunc_argc != -1
asm.incr_counter(:send_cfunc_ruby_array_varg)
return CantCompile
end
# We aren't handling a vararg cfuncs with splat currently.
if flags & C::VM_CALL_ARGS_SPLAT != 0 && cfunc_argc == -1
asm.incr_counter(:send_args_splat_cfunc_var_args)
return CantCompile
end
if flags & C::VM_CALL_ARGS_SPLAT != 0 && flags & C::VM_CALL_ZSUPER != 0
# zsuper methods are super calls without any arguments.
# They are also marked as splat, but don't actually have an array
# they pull arguments from, instead we need to change to call
# a different method with the current stack.
asm.incr_counter(:send_args_splat_cfunc_zuper)
return CantCompile;
end
# In order to handle backwards compatibility between ruby 3 and 2
# ruby2_keywords was introduced. It is called only on methods
# with splat and changes they way they handle them.
# We are just going to not compile these.
# https://docs.ruby-lang.org/en/3.2/Module.html#method-i-ruby2_keywords
if jit.iseq.body.param.flags.ruby2_keywords && flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:send_args_splat_cfunc_ruby2_keywords)
return CantCompile;
end
kw_arg = calling.kwarg
kw_arg_num = if kw_arg.nil?
0
else
kw_arg.keyword_len
end
if kw_arg_num != 0 && flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:send_cfunc_splat_with_kw)
return CantCompile
end
if c_method_tracing_currently_enabled?
# Don't JIT if tracing c_call or c_return
asm.incr_counter(:send_cfunc_tracing)
return CantCompile
end
# Delegate to codegen for C methods if we have it.
if kw_arg.nil? && flags & C::VM_CALL_OPT_SEND == 0 && flags & C::VM_CALL_ARGS_SPLAT == 0 && (cfunc_argc == -1 || argc == cfunc_argc)
known_cfunc_codegen = lookup_cfunc_codegen(cme.def)
if known_cfunc_codegen&.call(jit, ctx, asm, argc, known_recv_class)
# cfunc codegen generated code. Terminate the block so
# there isn't multiple calls in the same block.
jump_to_next_insn(jit, ctx, asm)
return EndBlock
end
end
# Check for interrupts
jit_check_ints(jit, ctx, asm)
# Stack overflow check
# #define CHECK_VM_STACK_OVERFLOW0(cfp, sp, margin)
# REG_CFP <= REG_SP + 4 * SIZEOF_VALUE + sizeof(rb_control_frame_t)
asm.comment('stack overflow check')
asm.lea(:rax, ctx.sp_opnd(C.VALUE.size * 4 + 2 * C.rb_control_frame_t.size))
asm.cmp(CFP, :rax)
asm.jbe(counted_exit(side_exit(jit, ctx), :send_stackoverflow))
# Number of args which will be passed through to the callee
# This is adjusted by the kwargs being combined into a hash.
passed_argc = if kw_arg.nil?
argc
else
argc - kw_arg_num + 1
end
# If the argument count doesn't match
if cfunc_argc >= 0 && cfunc_argc != passed_argc && flags & C::VM_CALL_ARGS_SPLAT == 0
asm.incr_counter(:send_cfunc_argc_mismatch)
return CantCompile
end
# Don't JIT functions that need C stack arguments for now
if cfunc_argc >= 0 && passed_argc + 1 > C_ARGS.size
asm.incr_counter(:send_cfunc_toomany_args)
return CantCompile
end
block_arg = flags & C::VM_CALL_ARGS_BLOCKARG != 0
# Guard block_arg_type
if guard_block_arg(jit, ctx, asm, calling) == CantCompile
return CantCompile
end
if block_arg
ctx.stack_pop(1)
end
# push_splat_args does stack manipulation so we can no longer side exit
if flags & C::VM_CALL_ARGS_SPLAT != 0
assert_equal(true, cfunc_argc >= 0)
required_args = cfunc_argc - (argc - 1)
# + 1 because we pass self
if required_args + 1 >= C_ARGS.size
asm.incr_counter(:send_cfunc_toomany_args)
return CantCompile
end
# We are going to assume that the splat fills
# all the remaining arguments. So the number of args
# should just equal the number of args the cfunc takes.
# In the generated code we test if this is true
# and if not side exit.
argc = cfunc_argc
passed_argc = argc
push_splat_args(required_args, jit, ctx, asm)
end
# This is a .send call and we need to adjust the stack
if flags & C::VM_CALL_OPT_SEND != 0
handle_opt_send_shift_stack(asm, argc, ctx, send_shift: calling.send_shift)
end
# Points to the receiver operand on the stack
# Store incremented PC into current control frame in case callee raises.
jit_save_pc(jit, asm)
# Increment the stack pointer by 3 (in the callee)
# sp += 3
frame_type = C::VM_FRAME_MAGIC_CFUNC | C::VM_FRAME_FLAG_CFRAME | C::VM_ENV_FLAG_LOCAL
if kw_arg
frame_type |= C::VM_FRAME_FLAG_CFRAME_KW
end
jit_push_frame(jit, ctx, asm, cme, flags, argc, frame_type, calling.block_handler)
if kw_arg
# Build a hash from all kwargs passed
asm.comment('build_kwhash')
imemo_ci = calling.ci_addr
# we assume all callinfos with kwargs are on the GC heap
assert_equal(true, C.imemo_type_p(imemo_ci, C.imemo_callinfo))
asm.mov(C_ARGS[0], imemo_ci)
asm.lea(C_ARGS[1], ctx.sp_opnd(0))
asm.call(C.rjit_build_kwhash)
# Replace the stack location at the start of kwargs with the new hash
stack_opnd = ctx.stack_opnd(argc - passed_argc)
asm.mov(stack_opnd, C_RET)
end
# Copy SP because REG_SP will get overwritten
sp = :rax
asm.lea(sp, ctx.sp_opnd(0))
# Pop the C function arguments from the stack (in the caller)
ctx.stack_pop(argc + 1)
# Write interpreter SP into CFP.
# Needed in case the callee yields to the block.
jit_save_sp(ctx, asm)
# Non-variadic method
case cfunc_argc
in (0..) # Non-variadic method
# Copy the arguments from the stack to the C argument registers
# self is the 0th argument and is at index argc from the stack top
(0..passed_argc).each do |i|
asm.mov(C_ARGS[i], [sp, -(argc + 1 - i) * C.VALUE.size])
end
in -1 # Variadic method: rb_f_puts(int argc, VALUE *argv, VALUE recv)
# The method gets a pointer to the first argument
# rb_f_puts(int argc, VALUE *argv, VALUE recv)
asm.mov(C_ARGS[0], passed_argc)
asm.lea(C_ARGS[1], [sp, -argc * C.VALUE.size]) # argv
asm.mov(C_ARGS[2], [sp, -(argc + 1) * C.VALUE.size]) # recv
end
# Call the C function
# VALUE ret = (cfunc->func)(recv, argv[0], argv[1]);
# cfunc comes from compile-time cme->def, which we assume to be stable.
# Invalidation logic is in yjit_method_lookup_change()
asm.comment('call C function')
asm.mov(:rax, cfunc.func)
asm.call(:rax) # TODO: use rel32 if close enough
# Record code position for TracePoint patching. See full_cfunc_return().
Invariants.record_global_inval_patch(asm, full_cfunc_return)
# Push the return value on the Ruby stack
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
# Pop the stack frame (ec->cfp++)
# Instead of recalculating, we can reuse the previous CFP, which is stored in a callee-saved
# register
asm.mov([EC, C.rb_execution_context_t.offsetof(:cfp)], CFP)
# cfunc calls may corrupt types
ctx.clear_local_types
# Note: the return block of jit_call_iseq has ctx->sp_offset == 1
# which allows for sharing the same successor.
# Jump (fall through) to the call continuation block
# We do this to end the current block after the call
assert_equal(1, ctx.sp_offset)
jump_to_next_insn(jit, ctx, asm)
EndBlock
end
# vm_call_attrset
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_attrset(jit, ctx, asm, cme, calling, comptime_recv, recv_opnd)
argc = calling.argc
flags = calling.flags
send_shift = calling.send_shift
if flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:send_attrset_splat)
return CantCompile
end
if flags & C::VM_CALL_KWARG != 0
asm.incr_counter(:send_attrset_kwarg)
return CantCompile
elsif argc != 1 || !C.RB_TYPE_P(comptime_recv, C::RUBY_T_OBJECT)
asm.incr_counter(:send_attrset_method)
return CantCompile
elsif c_method_tracing_currently_enabled?
# Can't generate code for firing c_call and c_return events
# See :attr-tracing:
asm.incr_counter(:send_c_tracingg)
return CantCompile
elsif flags & C::VM_CALL_ARGS_BLOCKARG != 0
asm.incr_counter(:send_block_arg)
return CantCompile
end
ivar_name = cme.def.body.attr.id
# This is a .send call and we need to adjust the stack
if flags & C::VM_CALL_OPT_SEND != 0
handle_opt_send_shift_stack(asm, argc, ctx, send_shift:)
end
# Save the PC and SP because the callee may allocate
# Note that this modifies REG_SP, which is why we do it first
jit_prepare_routine_call(jit, ctx, asm)
# Get the operands from the stack
val_opnd = ctx.stack_pop(1)
recv_opnd = ctx.stack_pop(1)
# Call rb_vm_set_ivar_id with the receiver, the ivar name, and the value
asm.mov(C_ARGS[0], recv_opnd)
asm.mov(C_ARGS[1], ivar_name)
asm.mov(C_ARGS[2], val_opnd)
asm.call(C.rb_vm_set_ivar_id)
out_opnd = ctx.stack_push(Type::Unknown)
asm.mov(out_opnd, C_RET)
KeepCompiling
end
# vm_call_ivar (+ part of vm_call_method_each_type)
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_ivar(jit, ctx, asm, cme, calling, comptime_recv, recv_opnd)
argc = calling.argc
flags = calling.flags
if flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:send_ivar_splat)
return CantCompile
end
if argc != 0
asm.incr_counter(:send_arity)
return CantCompile
end
# We don't support handle_opt_send_shift_stack for this yet.
if flags & C::VM_CALL_OPT_SEND != 0
asm.incr_counter(:send_ivar_opt_send)
return CantCompile
end
ivar_id = cme.def.body.attr.id
# Not handling block_handler
if flags & C::VM_CALL_ARGS_BLOCKARG != 0
asm.incr_counter(:send_block_arg)
return CantCompile
end
jit_getivar(jit, ctx, asm, comptime_recv, ivar_id, recv_opnd, StackOpnd[0])
end
# vm_call_bmethod
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_bmethod(jit, ctx, asm, calling, cme, comptime_recv, recv_opnd, known_recv_class)
proc_addr = cme.def.body.bmethod.proc
proc_t = C.rb_yjit_get_proc_ptr(proc_addr)
proc_block = proc_t.block
if proc_block.type != C.block_type_iseq
asm.incr_counter(:send_bmethod_not_iseq)
return CantCompile
end
capture = proc_block.as.captured
iseq = capture.code.iseq
# TODO: implement this
# Optimize for single ractor mode and avoid runtime check for
# "defined with an un-shareable Proc in a different Ractor"
# if !assume_single_ractor_mode(jit, ocb)
# return CantCompile;
# end
# Passing a block to a block needs logic different from passing
# a block to a method and sometimes requires allocation. Bail for now.
if calling.block_handler != C::VM_BLOCK_HANDLER_NONE
asm.incr_counter(:send_bmethod_blockarg)
return CantCompile
end
jit_call_iseq(
jit, ctx, asm, cme, calling, iseq,
frame_type: C::VM_FRAME_MAGIC_BLOCK | C::VM_FRAME_FLAG_BMETHOD | C::VM_FRAME_FLAG_LAMBDA,
prev_ep: capture.ep,
)
end
# vm_call_alias
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_alias(jit, ctx, asm, calling, cme, comptime_recv, recv_opnd, known_recv_class)
cme = C.rb_aliased_callable_method_entry(cme)
jit_call_method_each_type(jit, ctx, asm, calling, cme, comptime_recv, recv_opnd, known_recv_class)
end
# vm_call_optimized
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_optimized(jit, ctx, asm, cme, calling, known_recv_class)
if calling.flags & C::VM_CALL_ARGS_BLOCKARG != 0
# Not working yet
asm.incr_counter(:send_block_arg)
return CantCompile
end
case cme.def.body.optimized.type
in C::OPTIMIZED_METHOD_TYPE_SEND
jit_call_opt_send(jit, ctx, asm, cme, calling, known_recv_class)
in C::OPTIMIZED_METHOD_TYPE_CALL
jit_call_opt_call(jit, ctx, asm, cme, calling.flags, calling.argc, calling.block_handler, known_recv_class, send_shift: calling.send_shift)
in C::OPTIMIZED_METHOD_TYPE_BLOCK_CALL
asm.incr_counter(:send_optimized_block_call)
return CantCompile
in C::OPTIMIZED_METHOD_TYPE_STRUCT_AREF
jit_call_opt_struct_aref(jit, ctx, asm, cme, calling.flags, calling.argc, calling.block_handler, known_recv_class, send_shift: calling.send_shift)
in C::OPTIMIZED_METHOD_TYPE_STRUCT_ASET
asm.incr_counter(:send_optimized_struct_aset)
return CantCompile
end
end
# vm_call_opt_send
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_opt_send(jit, ctx, asm, cme, calling, known_recv_class)
if jit_caller_setup_arg(jit, ctx, asm, calling.flags) == CantCompile
return CantCompile
end
if calling.argc == 0
asm.incr_counter(:send_optimized_send_no_args)
return CantCompile
end
calling.argc -= 1
# We aren't handling `send(:send, ...)` yet. This might work, but not tested yet.
if calling.send_shift > 0
asm.incr_counter(:send_optimized_send_send)
return CantCompile
end
# Lazily handle stack shift in handle_opt_send_shift_stack
calling.send_shift += 1
jit_call_symbol(jit, ctx, asm, cme, calling, known_recv_class, C::VM_CALL_FCALL)
end
# vm_call_opt_call
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_opt_call(jit, ctx, asm, cme, flags, argc, block_handler, known_recv_class, send_shift:)
if block_handler != C::VM_BLOCK_HANDLER_NONE
asm.incr_counter(:send_optimized_call_block)
return CantCompile
end
if flags & C::VM_CALL_KWARG != 0
asm.incr_counter(:send_optimized_call_kwarg)
return CantCompile
end
if flags & C::VM_CALL_ARGS_SPLAT != 0
asm.incr_counter(:send_optimized_call_splat)
return CantCompile
end
# TODO: implement this
# Optimize for single ractor mode and avoid runtime check for
# "defined with an un-shareable Proc in a different Ractor"
# if !assume_single_ractor_mode(jit, ocb)
# return CantCompile
# end
# If this is a .send call we need to adjust the stack
if flags & C::VM_CALL_OPT_SEND != 0
handle_opt_send_shift_stack(asm, argc, ctx, send_shift:)
end
# About to reset the SP, need to load this here
recv_idx = argc # blockarg is not supported. send_shift is already handled.
asm.mov(:rcx, ctx.stack_opnd(recv_idx)) # recv
# Save the PC and SP because the callee can make Ruby calls
jit_prepare_routine_call(jit, ctx, asm) # NOTE: clobbers rax
asm.lea(:rax, ctx.sp_opnd(0)) # sp
kw_splat = flags & C::VM_CALL_KW_SPLAT
asm.mov(C_ARGS[0], :rcx)
asm.mov(C_ARGS[1], EC)
asm.mov(C_ARGS[2], argc)
asm.lea(C_ARGS[3], [:rax, -argc * C.VALUE.size]) # stack_argument_pointer. NOTE: C_ARGS[3] is rcx
asm.mov(C_ARGS[4], kw_splat)
asm.mov(C_ARGS[5], C::VM_BLOCK_HANDLER_NONE)
asm.call(C.rjit_optimized_call)
ctx.stack_pop(argc + 1)
stack_ret = ctx.stack_push(Type::Unknown)
asm.mov(stack_ret, C_RET)
return KeepCompiling
end
# vm_call_opt_struct_aref
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_opt_struct_aref(jit, ctx, asm, cme, flags, argc, block_handler, known_recv_class, send_shift:)
if argc != 0
asm.incr_counter(:send_optimized_struct_aref_error)
return CantCompile
end
off = cme.def.body.optimized.index
recv_idx = argc # blockarg is not supported
recv_idx += send_shift
comptime_recv = jit.peek_at_stack(recv_idx)
# This is a .send call and we need to adjust the stack
if flags & C::VM_CALL_OPT_SEND != 0
handle_opt_send_shift_stack(asm, argc, ctx, send_shift:)
end
# All structs from the same Struct class should have the same
# length. So if our comptime_recv is embedded all runtime
# structs of the same class should be as well, and the same is
# true of the converse.
embedded = C::FL_TEST_RAW(comptime_recv, C::RSTRUCT_EMBED_LEN_MASK)
asm.comment('struct aref')
asm.mov(:rax, ctx.stack_pop(1)) # recv
if embedded
asm.mov(:rax, [:rax, C.RStruct.offsetof(:as, :ary) + (C.VALUE.size * off)])
else
asm.mov(:rax, [:rax, C.RStruct.offsetof(:as, :heap, :ptr)])
asm.mov(:rax, [:rax, C.VALUE.size * off])
end
ret = ctx.stack_push(Type::Unknown)
asm.mov(ret, :rax)
jump_to_next_insn(jit, ctx, asm)
EndBlock
end
# vm_call_opt_send (lazy part)
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def handle_opt_send_shift_stack(asm, argc, ctx, send_shift:)
# We don't support `send(:send, ...)` for now.
assert_equal(1, send_shift)
asm.comment('shift stack')
(0...argc).reverse_each do |i|
opnd = ctx.stack_opnd(i)
opnd2 = ctx.stack_opnd(i + 1)
asm.mov(:rax, opnd)
asm.mov(opnd2, :rax)
end
ctx.shift_stack(argc)
end
# vm_call_symbol
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_call_symbol(jit, ctx, asm, cme, calling, known_recv_class, flags)
flags |= C::VM_CALL_OPT_SEND | (calling.kw_splat ? C::VM_CALL_KW_SPLAT : 0)
comptime_symbol = jit.peek_at_stack(calling.argc)
if comptime_symbol.class != String && !static_symbol?(comptime_symbol)
asm.incr_counter(:send_optimized_send_not_sym_or_str)
return CantCompile
end
mid = C.get_symbol_id(comptime_symbol)
if mid == 0
asm.incr_counter(:send_optimized_send_null_mid)
return CantCompile
end
asm.comment("Guard #{comptime_symbol.inspect} is on stack")
class_changed_exit = counted_exit(side_exit(jit, ctx), :send_optimized_send_mid_class_changed)
jit_guard_known_klass(
jit, ctx, asm, C.rb_class_of(comptime_symbol), ctx.stack_opnd(calling.argc),
StackOpnd[calling.argc], comptime_symbol, class_changed_exit,
)
asm.mov(C_ARGS[0], ctx.stack_opnd(calling.argc))
asm.call(C.rb_get_symbol_id)
asm.cmp(C_RET, mid)
id_changed_exit = counted_exit(side_exit(jit, ctx), :send_optimized_send_mid_id_changed)
jit_chain_guard(:jne, jit, ctx, asm, id_changed_exit)
# rb_callable_method_entry_with_refinements
calling.flags = flags
cme, _ = jit_search_method(jit, ctx, asm, mid, calling)
if cme == CantCompile
return CantCompile
end
if flags & C::VM_CALL_FCALL != 0
return jit_call_method(jit, ctx, asm, mid, calling, cme, known_recv_class)
end
raise NotImplementedError # unreachable for now
end
# vm_push_frame
#
# Frame structure:
# | args | locals | cme/cref | block_handler/prev EP | frame type (EP here) | stack bottom (SP here)
#
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_push_frame(jit, ctx, asm, cme, flags, argc, frame_type, block_handler, iseq: nil, local_size: 0, stack_max: 0, prev_ep: nil, doing_kw_call: nil)
# Save caller SP and PC before pushing a callee frame for backtrace and side exits
asm.comment('save SP to caller CFP')
recv_idx = argc # blockarg is already popped
recv_idx += (block_handler == :captured) ? 0 : 1 # receiver is not on stack when captured->self is used
if iseq
# Skip setting this to SP register. This cfp->sp will be copied to SP on leave insn.
asm.lea(:rax, ctx.sp_opnd(C.VALUE.size * -recv_idx)) # Pop receiver and arguments to prepare for side exits
asm.mov([CFP, C.rb_control_frame_t.offsetof(:sp)], :rax)
else
asm.lea(SP, ctx.sp_opnd(C.VALUE.size * -recv_idx))
asm.mov([CFP, C.rb_control_frame_t.offsetof(:sp)], SP)
ctx.sp_offset = recv_idx
end
jit_save_pc(jit, asm, comment: 'save PC to caller CFP')
sp_offset = ctx.sp_offset + 3 + local_size + (doing_kw_call ? 1 : 0) # callee_sp
local_size.times do |i|
asm.comment('set local variables') if i == 0
local_index = sp_offset + i - local_size - 3
asm.mov([SP, C.VALUE.size * local_index], Qnil)
end
asm.comment('set up EP with managing data')
ep_offset = sp_offset - 1
# ep[-2]: cref_or_me
asm.mov(:rax, cme.to_i)
asm.mov([SP, C.VALUE.size * (ep_offset - 2)], :rax)
# ep[-1]: block handler or prev env ptr (specval)
if prev_ep
asm.mov(:rax, prev_ep.to_i | 1) # tagged prev ep
asm.mov([SP, C.VALUE.size * (ep_offset - 1)], :rax)
elsif block_handler == :captured
# Set captured->ep, saving captured in :rcx for captured->self
ep_reg = :rcx
jit_get_lep(jit, asm, reg: ep_reg)
asm.mov(:rcx, [ep_reg, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL]) # block_handler
asm.and(:rcx, ~0x3) # captured
asm.mov(:rax, [:rcx, C.VALUE.size]) # captured->ep
asm.or(:rax, 0x1) # GC_GUARDED_PTR
asm.mov([SP, C.VALUE.size * (ep_offset - 1)], :rax)
elsif block_handler == C::VM_BLOCK_HANDLER_NONE
asm.mov([SP, C.VALUE.size * (ep_offset - 1)], C::VM_BLOCK_HANDLER_NONE)
elsif block_handler == C.rb_block_param_proxy
# vm_caller_setup_arg_block: block_code == rb_block_param_proxy
jit_get_lep(jit, asm, reg: :rax) # VM_CF_BLOCK_HANDLER: VM_CF_LEP
asm.mov(:rax, [:rax, C.VALUE.size * C::VM_ENV_DATA_INDEX_SPECVAL]) # VM_CF_BLOCK_HANDLER: VM_ENV_BLOCK_HANDLER
asm.mov([CFP, C.rb_control_frame_t.offsetof(:block_code)], :rax) # reg_cfp->block_code = handler
asm.mov([SP, C.VALUE.size * (ep_offset - 1)], :rax) # return handler;
else # assume blockiseq
asm.mov(:rax, block_handler)
asm.mov([CFP, C.rb_control_frame_t.offsetof(:block_code)], :rax)
asm.lea(:rax, [CFP, C.rb_control_frame_t.offsetof(:self)]) # VM_CFP_TO_CAPTURED_BLOCK
asm.or(:rax, 1) # VM_BH_FROM_ISEQ_BLOCK
asm.mov([SP, C.VALUE.size * (ep_offset - 1)], :rax)
end
# ep[-0]: ENV_FLAGS
asm.mov([SP, C.VALUE.size * (ep_offset - 0)], frame_type)
asm.comment('set up new frame')
cfp_offset = -C.rb_control_frame_t.size # callee CFP
# For ISEQ, JIT code will set it as needed. However, C func needs 0 there for svar frame detection.
if iseq.nil?
asm.mov([CFP, cfp_offset + C.rb_control_frame_t.offsetof(:pc)], 0)
end
asm.mov(:rax, iseq.to_i)
asm.mov([CFP, cfp_offset + C.rb_control_frame_t.offsetof(:iseq)], :rax)
if block_handler == :captured
asm.mov(:rax, [:rcx]) # captured->self
else
self_index = ctx.sp_offset - (1 + argc) # blockarg has been popped
asm.mov(:rax, [SP, C.VALUE.size * self_index])
end
asm.mov([CFP, cfp_offset + C.rb_control_frame_t.offsetof(:self)], :rax)
asm.lea(:rax, [SP, C.VALUE.size * ep_offset])
asm.mov([CFP, cfp_offset + C.rb_control_frame_t.offsetof(:ep)], :rax)
asm.mov([CFP, cfp_offset + C.rb_control_frame_t.offsetof(:block_code)], 0)
# Update SP register only for ISEQ calls. SP-relative operations should be done above this.
sp_reg = iseq ? SP : :rax
asm.lea(sp_reg, [SP, C.VALUE.size * sp_offset])
asm.mov([CFP, cfp_offset + C.rb_control_frame_t.offsetof(:sp)], sp_reg)
# cfp->jit_return is used only for ISEQs
if iseq
# The callee might change locals through Kernel#binding and other means.
ctx.clear_local_types
# Stub cfp->jit_return
return_ctx = ctx.dup
return_ctx.stack_pop(argc + ((block_handler == :captured) ? 0 : 1)) # Pop args and receiver. blockarg has been popped
return_ctx.stack_push(Type::Unknown) # push callee's return value
return_ctx.sp_offset = 1 # SP is in the position after popping a receiver and arguments
return_ctx.chain_depth = 0
branch_stub = BranchStub.new(
iseq: jit.iseq,
shape: Default,
target0: BranchTarget.new(ctx: return_ctx, pc: jit.pc + jit.insn.len * C.VALUE.size),
)
branch_stub.target0.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(return_ctx, ocb_asm, branch_stub, true)
@ocb.write(ocb_asm)
end
branch_stub.compile = compile_jit_return(branch_stub, cfp_offset:)
branch_stub.compile.call(asm)
end
asm.comment('switch to callee CFP')
# Update CFP register only for ISEQ calls
cfp_reg = iseq ? CFP : :rax
asm.lea(cfp_reg, [CFP, cfp_offset])
asm.mov([EC, C.rb_execution_context_t.offsetof(:cfp)], cfp_reg)
end
def compile_jit_return(branch_stub, cfp_offset:) # Proc escapes arguments in memory
proc do |branch_asm|
branch_asm.comment('set jit_return to callee CFP')
branch_asm.stub(branch_stub) do
case branch_stub.shape
in Default
branch_asm.mov(:rax, branch_stub.target0.address)
branch_asm.mov([CFP, cfp_offset + C.rb_control_frame_t.offsetof(:jit_return)], :rax)
end
end
end
end
# CALLER_SETUP_ARG: Return CantCompile if not supported
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def jit_caller_setup_arg(jit, ctx, asm, flags)
if flags & C::VM_CALL_ARGS_SPLAT != 0 && flags & C::VM_CALL_KW_SPLAT != 0
asm.incr_counter(:send_args_splat_kw_splat)
return CantCompile
elsif flags & C::VM_CALL_ARGS_SPLAT != 0
# splat is not supported in this path
asm.incr_counter(:send_args_splat)
return CantCompile
elsif flags & C::VM_CALL_KW_SPLAT != 0
asm.incr_counter(:send_args_kw_splat)
return CantCompile
elsif flags & C::VM_CALL_KWARG != 0
asm.incr_counter(:send_kwarg)
return CantCompile
end
end
# Pushes arguments from an array to the stack. Differs from push splat because
# the array can have items left over.
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def move_rest_args_to_stack(array, num_args, jit, ctx, asm)
side_exit = side_exit(jit, ctx)
asm.comment('move_rest_args_to_stack')
# array is :rax
array_len_opnd = :rcx
jit_array_len(asm, array, array_len_opnd)
asm.comment('Side exit if length is less than required')
asm.cmp(array_len_opnd, num_args)
asm.jl(counted_exit(side_exit, :send_iseq_has_rest_and_splat_not_equal))
asm.comment('Push arguments from array')
# Load the address of the embedded array
# (struct RArray *)(obj)->as.ary
array_reg = array
# Conditionally load the address of the heap array
# (struct RArray *)(obj)->as.heap.ptr
flags_opnd = [array_reg, C.RBasic.offsetof(:flags)]
asm.test(flags_opnd, C::RARRAY_EMBED_FLAG)
heap_ptr_opnd = [array_reg, C.RArray.offsetof(:as, :heap, :ptr)]
# Load the address of the embedded array
# (struct RArray *)(obj)->as.ary
ary_opnd = :rdx # NOTE: array :rax is used after move_rest_args_to_stack too
asm.lea(:rcx, [array_reg, C.RArray.offsetof(:as, :ary)])
asm.mov(ary_opnd, heap_ptr_opnd)
asm.cmovnz(ary_opnd, :rcx)
num_args.times do |i|
top = ctx.stack_push(Type::Unknown)
asm.mov(:rcx, [ary_opnd, i * C.VALUE.size])
asm.mov(top, :rcx)
end
end
# vm_caller_setup_arg_splat (+ CALLER_SETUP_ARG):
# Pushes arguments from an array to the stack that are passed with a splat (i.e. *args).
# It optimistically compiles to a static size that is the exact number of arguments needed for the function.
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def push_splat_args(required_args, jit, ctx, asm)
side_exit = side_exit(jit, ctx)
asm.comment('push_splat_args')
array_opnd = ctx.stack_opnd(0)
array_stack_opnd = StackOpnd[0]
array_reg = :rax
asm.mov(array_reg, array_opnd)
guard_object_is_array(jit, ctx, asm, array_reg, :rcx, array_stack_opnd, :send_args_splat_not_array)
array_len_opnd = :rcx
jit_array_len(asm, array_reg, array_len_opnd)
asm.comment('Side exit if length is not equal to remaining args')
asm.cmp(array_len_opnd, required_args)
asm.jne(counted_exit(side_exit, :send_args_splat_length_not_equal))
asm.comment('Check last argument is not ruby2keyword hash')
ary_opnd = :rcx
jit_array_ptr(asm, array_reg, ary_opnd) # clobbers array_reg
last_array_value = :rax
asm.mov(last_array_value, [ary_opnd, (required_args - 1) * C.VALUE.size])
ruby2_exit = counted_exit(side_exit, :send_args_splat_ruby2_hash);
guard_object_is_not_ruby2_keyword_hash(asm, last_array_value, :rcx, ruby2_exit) # clobbers :rax
asm.comment('Push arguments from array')
array_opnd = ctx.stack_pop(1)
if required_args > 0
# Load the address of the embedded array
# (struct RArray *)(obj)->as.ary
array_reg = :rax
asm.mov(array_reg, array_opnd)
# Conditionally load the address of the heap array
# (struct RArray *)(obj)->as.heap.ptr
flags_opnd = [array_reg, C.RBasic.offsetof(:flags)]
asm.test(flags_opnd, C::RARRAY_EMBED_FLAG)
heap_ptr_opnd = [array_reg, C.RArray.offsetof(:as, :heap, :ptr)]
# Load the address of the embedded array
# (struct RArray *)(obj)->as.ary
asm.lea(:rcx, [array_reg, C.RArray.offsetof(:as, :ary)])
asm.mov(:rax, heap_ptr_opnd)
asm.cmovnz(:rax, :rcx)
ary_opnd = :rax
(0...required_args).each do |i|
top = ctx.stack_push(Type::Unknown)
asm.mov(:rcx, [ary_opnd, i * C.VALUE.size])
asm.mov(top, :rcx)
end
asm.comment('end push_each')
end
end
# Generate RARRAY_LEN. For array_opnd, use Opnd::Reg to reduce memory access,
# and use Opnd::Mem to save registers.
def jit_array_len(asm, array_reg, len_reg)
asm.comment('get array length for embedded or heap')
# Pull out the embed flag to check if it's an embedded array.
asm.mov(len_reg, [array_reg, C.RBasic.offsetof(:flags)])
# Get the length of the array
asm.and(len_reg, C::RARRAY_EMBED_LEN_MASK)
asm.sar(len_reg, C::RARRAY_EMBED_LEN_SHIFT)
# Conditionally move the length of the heap array
asm.test([array_reg, C.RBasic.offsetof(:flags)], C::RARRAY_EMBED_FLAG)
# Select the array length value
asm.cmovz(len_reg, [array_reg, C.RArray.offsetof(:as, :heap, :len)])
end
# Generate RARRAY_CONST_PTR (part of RARRAY_AREF)
def jit_array_ptr(asm, array_reg, ary_opnd) # clobbers array_reg
asm.comment('get array pointer for embedded or heap')
flags_opnd = [array_reg, C.RBasic.offsetof(:flags)]
asm.test(flags_opnd, C::RARRAY_EMBED_FLAG)
# Load the address of the embedded array
# (struct RArray *)(obj)->as.ary
asm.mov(ary_opnd, [array_reg, C.RArray.offsetof(:as, :heap, :ptr)])
asm.lea(array_reg, [array_reg, C.RArray.offsetof(:as, :ary)]) # clobbers array_reg
asm.cmovnz(ary_opnd, array_reg)
end
def assert(cond)
assert_equal(cond, true)
end
def assert_equal(left, right)
if left != right
raise "'#{left.inspect}' was not '#{right.inspect}'"
end
end
def fixnum?(obj)
(C.to_value(obj) & C::RUBY_FIXNUM_FLAG) == C::RUBY_FIXNUM_FLAG
end
def flonum?(obj)
(C.to_value(obj) & C::RUBY_FLONUM_MASK) == C::RUBY_FLONUM_FLAG
end
def symbol?(obj)
static_symbol?(obj) || dynamic_symbol?(obj)
end
def static_symbol?(obj)
(C.to_value(obj) & 0xff) == C::RUBY_SYMBOL_FLAG
end
def dynamic_symbol?(obj)
return false if C::SPECIAL_CONST_P(obj)
C.RB_TYPE_P(obj, C::RUBY_T_SYMBOL)
end
def shape_too_complex?(obj)
C.rb_shape_get_shape_id(obj) == C::OBJ_TOO_COMPLEX_SHAPE_ID
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def defer_compilation(jit, ctx, asm)
# Make a stub to compile the current insn
if ctx.chain_depth != 0
raise "double defer!"
end
ctx.chain_depth += 1
jit_direct_jump(jit.iseq, jit.pc, ctx, asm, comment: 'defer_compilation')
end
def jit_direct_jump(iseq, pc, ctx, asm, comment: 'jit_direct_jump')
branch_stub = BranchStub.new(
iseq:,
shape: Default,
target0: BranchTarget.new(ctx:, pc:),
)
branch_stub.target0.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(ctx, ocb_asm, branch_stub, true)
@ocb.write(ocb_asm)
end
branch_stub.compile = compile_jit_direct_jump(branch_stub, comment:)
branch_stub.compile.call(asm)
end
def compile_jit_direct_jump(branch_stub, comment:) # Proc escapes arguments in memory
proc do |branch_asm|
branch_asm.comment(comment)
branch_asm.stub(branch_stub) do
case branch_stub.shape
in Default
branch_asm.jmp(branch_stub.target0.address)
in Next0
# Just write the block without a jump
end
end
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
def side_exit(jit, ctx)
# We use the latest ctx.sp_offset to generate a side exit to tolerate sp_offset changes by jit_save_sp.
# However, we want to simulate an old stack_size when we take a side exit. We do that by adjusting the
# sp_offset because gen_outlined_exit uses ctx.sp_offset to move SP.
ctx = ctx.with_stack_size(jit.stack_size_for_pc)
jit.side_exit_for_pc[ctx.sp_offset] ||= Assembler.new.then do |asm|
@exit_compiler.compile_side_exit(jit.pc, ctx, asm)
@ocb.write(asm)
end
end
def counted_exit(side_exit, name)
asm = Assembler.new
asm.incr_counter(name)
asm.jmp(side_exit)
@ocb.write(asm)
end
def def_iseq_ptr(cme_def)
C.rb_iseq_check(cme_def.body.iseq.iseqptr)
end
def to_value(obj)
GC_REFS << obj
C.to_value(obj)
end
def full_cfunc_return
@full_cfunc_return ||= Assembler.new.then do |asm|
@exit_compiler.compile_full_cfunc_return(asm)
@ocb.write(asm)
end
end
def c_method_tracing_currently_enabled?
C.rb_rjit_global_events & (C::RUBY_EVENT_C_CALL | C::RUBY_EVENT_C_RETURN) != 0
end
# Return a builtin function if a given iseq consists of only that builtin function
def builtin_function(iseq)
opt_invokebuiltin_delegate_leave = INSNS.values.find { |i| i.name == :opt_invokebuiltin_delegate_leave }
leave = INSNS.values.find { |i| i.name == :leave }
if iseq.body.iseq_size == opt_invokebuiltin_delegate_leave.len + leave.len &&
C.rb_vm_insn_decode(iseq.body.iseq_encoded[0]) == opt_invokebuiltin_delegate_leave.bin &&
C.rb_vm_insn_decode(iseq.body.iseq_encoded[opt_invokebuiltin_delegate_leave.len]) == leave.bin
C.rb_builtin_function.new(iseq.body.iseq_encoded[1])
end
end
def build_calling(ci:, block_handler:)
CallingInfo.new(
argc: C.vm_ci_argc(ci),
flags: C.vm_ci_flag(ci),
kwarg: C.vm_ci_kwarg(ci),
ci_addr: ci.to_i,
send_shift: 0,
block_handler:,
)
end
end
end
share/ruby/ruby_vm/rjit/hooks.rb 0000644 00000001665 15173517737 0012762 0 ustar 00 module RubyVM::RJIT
module Hooks # :nodoc: all
def self.on_bop_redefined(_redefined_flag, _bop)
# C.rjit_cancel_all("BOP is redefined")
end
def self.on_cme_invalidate(cme)
cme = C.rb_callable_method_entry_struct.new(cme)
Invariants.on_cme_invalidate(cme)
end
def self.on_ractor_spawn
# C.rjit_cancel_all("Ractor is spawned")
end
# Global constant changes like const_set
def self.on_constant_state_changed(id)
Invariants.on_constant_state_changed(id)
end
# ISEQ-specific constant invalidation
def self.on_constant_ic_update(iseq, ic, insn_idx)
iseq = C.rb_iseq_t.new(iseq)
ic = C.IC.new(ic)
Invariants.on_constant_ic_update(iseq, ic, insn_idx)
end
def self.on_tracing_invalidate_all(_new_iseq_events)
Invariants.on_tracing_invalidate_all
end
def self.on_update_references
Invariants.on_update_references
end
end
end
share/ruby/ruby_vm/rjit/entry_stub.rb 0000644 00000000342 15173517737 0014024 0 ustar 00 module RubyVM::RJIT
class EntryStub < Struct.new(
:start_addr, # @param [Integer] Stub source start address to be re-generated
:end_addr, # @param [Integer] Stub source end address to be re-generated
)
end
end
share/ruby/ruby_vm/rjit/code_block.rb 0000644 00000004433 15173517737 0013717 0 ustar 00 module RubyVM::RJIT
class CodeBlock
# @param mem_block [Integer] JIT buffer address
# @param mem_size [Integer] JIT buffer size
# @param outliend [TrueClass,FalseClass] true for outlined CodeBlock
def initialize(mem_block:, mem_size:, outlined: false)
@comments = Hash.new { |h, k| h[k] = [] } if dump_disasm?
@mem_block = mem_block
@mem_size = mem_size
@write_pos = 0
@outlined = outlined
end
# @param asm [RubyVM::RJIT::Assembler]
def write(asm)
return 0 if @write_pos + asm.size >= @mem_size
start_addr = write_addr
# Write machine code
C.mprotect_write(@mem_block, @mem_size)
@write_pos += asm.assemble(start_addr)
C.mprotect_exec(@mem_block, @mem_size)
end_addr = write_addr
# Convert comment indexes to addresses
asm.comments.each do |index, comments|
@comments[start_addr + index] += comments if dump_disasm?
end
asm.comments.clear
# Dump disasm if --rjit-dump-disasm
if C.rjit_opts.dump_disasm && start_addr < end_addr
dump_disasm(start_addr, end_addr)
end
start_addr
end
def set_write_addr(addr)
@write_pos = addr - @mem_block
@comments.delete(addr) if dump_disasm?
end
def with_write_addr(addr)
old_write_pos = @write_pos
set_write_addr(addr)
yield
ensure
@write_pos = old_write_pos
end
def write_addr
@mem_block + @write_pos
end
def include?(addr)
(@mem_block...(@mem_block + @mem_size)).include?(addr)
end
def dump_disasm(from, to, io: STDOUT, color: true, test: false)
C.dump_disasm(from, to, test:).each do |address, mnemonic, op_str|
@comments.fetch(address, []).each do |comment|
io.puts colorize(" # #{comment}", bold: true, color:)
end
io.puts colorize(" 0x#{format("%x", address)}: #{mnemonic} #{op_str}", color:)
end
io.puts
end
private
def colorize(text, bold: false, color:)
return text unless color
buf = +''
buf << "\e[1m" if bold
buf << "\e[34m" if @outlined
buf << text
buf << "\e[0m"
buf
end
def bold(text)
"\e[1m#{text}\e[0m"
end
def dump_disasm?
C.rjit_opts.dump_disasm
end
end
end
share/ruby/ruby_vm/rjit/block.rb 0000644 00000001070 15173517737 0012717 0 ustar 00 class RubyVM::RJIT::Block < Struct.new(
:iseq, # @param ``
:pc, # @param [Integer] Starting PC
:ctx, # @param [RubyVM::RJIT::Context] **Starting** Context (TODO: freeze?)
:start_addr, # @param [Integer] Starting address of this block's JIT code
:entry_exit, # @param [Integer] Address of entry exit (optional)
:incoming, # @param [Array<RubyVM::RJIT::BranchStub>] Incoming branches
:invalidated, # @param [TrueClass,FalseClass] true if already invalidated
)
def initialize(incoming: [], invalidated: false, **) = super
end
share/ruby/ruby_vm/rjit/compiler.rb 0000644 00000041335 15173517737 0013447 0 ustar 00 require 'ruby_vm/rjit/assembler'
require 'ruby_vm/rjit/block'
require 'ruby_vm/rjit/branch_stub'
require 'ruby_vm/rjit/code_block'
require 'ruby_vm/rjit/context'
require 'ruby_vm/rjit/entry_stub'
require 'ruby_vm/rjit/exit_compiler'
require 'ruby_vm/rjit/insn_compiler'
require 'ruby_vm/rjit/instruction'
require 'ruby_vm/rjit/invariants'
require 'ruby_vm/rjit/jit_state'
require 'ruby_vm/rjit/type'
module RubyVM::RJIT
# Compilation status
KeepCompiling = :KeepCompiling
CantCompile = :CantCompile
EndBlock = :EndBlock
# Ruby constants
Qtrue = Fiddle::Qtrue
Qfalse = Fiddle::Qfalse
Qnil = Fiddle::Qnil
Qundef = Fiddle::Qundef
# Callee-saved registers
# TODO: support using r12/r13 here
EC = :r14
CFP = :r15
SP = :rbx
# Scratch registers: rax, rcx, rdx
# Mark objects in this Array during GC
GC_REFS = []
# Maximum number of versions per block
# 1 means always create generic versions
MAX_VERSIONS = 4
class Compiler
attr_accessor :write_pos
def self.decode_insn(encoded)
INSNS.fetch(C.rb_vm_insn_decode(encoded))
end
def initialize
mem_size = C.rjit_opts.exec_mem_size * 1024 * 1024
mem_block = C.mmap(mem_size)
@cb = CodeBlock.new(mem_block: mem_block, mem_size: mem_size / 2)
@ocb = CodeBlock.new(mem_block: mem_block + mem_size / 2, mem_size: mem_size / 2, outlined: true)
@exit_compiler = ExitCompiler.new
@insn_compiler = InsnCompiler.new(@cb, @ocb, @exit_compiler)
Invariants.initialize(@cb, @ocb, self, @exit_compiler)
end
# Compile an ISEQ from its entry point.
# @param iseq `RubyVM::RJIT::CPointer::Struct_rb_iseq_t`
# @param cfp `RubyVM::RJIT::CPointer::Struct_rb_control_frame_t`
def compile(iseq, cfp)
return unless supported_platform?
pc = cfp.pc.to_i
jit = JITState.new(iseq:, cfp:)
asm = Assembler.new
compile_prologue(asm, iseq, pc)
compile_block(asm, jit:, pc:)
iseq.body.jit_entry = @cb.write(asm)
rescue Exception => e
STDERR.puts "#{e.class}: #{e.message}"
STDERR.puts e.backtrace
exit 1
end
# Compile an entry.
# @param entry [RubyVM::RJIT::EntryStub]
def entry_stub_hit(entry_stub, cfp)
# Compile a new entry guard as a next entry
pc = cfp.pc.to_i
next_entry = Assembler.new.then do |asm|
compile_entry_chain_guard(asm, cfp.iseq, pc)
@cb.write(asm)
end
# Try to find an existing compiled version of this block
ctx = Context.new
block = find_block(cfp.iseq, pc, ctx)
if block
# If an existing block is found, generate a jump to the block.
asm = Assembler.new
asm.jmp(block.start_addr)
@cb.write(asm)
else
# If this block hasn't yet been compiled, generate blocks after the entry guard.
asm = Assembler.new
jit = JITState.new(iseq: cfp.iseq, cfp:)
compile_block(asm, jit:, pc:, ctx:)
@cb.write(asm)
block = jit.block
end
# Regenerate the previous entry
@cb.with_write_addr(entry_stub.start_addr) do
# The last instruction of compile_entry_chain_guard is jne
asm = Assembler.new
asm.jne(next_entry)
@cb.write(asm)
end
return block.start_addr
rescue Exception => e
STDERR.puts e.full_message
exit 1
end
# Compile a branch stub.
# @param branch_stub [RubyVM::RJIT::BranchStub]
# @param cfp `RubyVM::RJIT::CPointer::Struct_rb_control_frame_t`
# @param target0_p [TrueClass,FalseClass]
# @return [Integer] The starting address of the compiled branch stub
def branch_stub_hit(branch_stub, cfp, target0_p)
# Update cfp->pc for `jit.at_current_insn?`
target = target0_p ? branch_stub.target0 : branch_stub.target1
cfp.pc = target.pc
# Reuse an existing block if it already exists
block = find_block(branch_stub.iseq, target.pc, target.ctx)
# If the branch stub's jump is the last code, allow overwriting part of
# the old branch code with the new block code.
fallthrough = block.nil? && @cb.write_addr == branch_stub.end_addr
if fallthrough
# If the branch stub's jump is the last code, allow overwriting part of
# the old branch code with the new block code.
@cb.set_write_addr(branch_stub.start_addr)
branch_stub.shape = target0_p ? Next0 : Next1
Assembler.new.tap do |branch_asm|
branch_stub.compile.call(branch_asm)
@cb.write(branch_asm)
end
end
# Reuse or generate a block
if block
target.address = block.start_addr
else
jit = JITState.new(iseq: branch_stub.iseq, cfp:)
target.address = Assembler.new.then do |asm|
compile_block(asm, jit:, pc: target.pc, ctx: target.ctx.dup)
@cb.write(asm)
end
block = jit.block
end
block.incoming << branch_stub # prepare for invalidate_block
# Re-generate the branch code for non-fallthrough cases
unless fallthrough
@cb.with_write_addr(branch_stub.start_addr) do
branch_asm = Assembler.new
branch_stub.compile.call(branch_asm)
@cb.write(branch_asm)
end
end
return target.address
rescue Exception => e
STDERR.puts e.full_message
exit 1
end
# @param iseq `RubyVM::RJIT::CPointer::Struct_rb_iseq_t`
# @param pc [Integer]
def invalidate_blocks(iseq, pc)
list_blocks(iseq, pc).each do |block|
invalidate_block(block)
end
# If they were the ISEQ's first blocks, re-compile RJIT entry as well
if iseq.body.iseq_encoded.to_i == pc
iseq.body.jit_entry = 0
iseq.body.jit_entry_calls = 0
end
end
def invalidate_block(block)
iseq = block.iseq
# Avoid touching GCed ISEQs. We assume it won't be re-entered.
return unless C.imemo_type_p(iseq, C.imemo_iseq)
# Remove this block from the version array
remove_block(iseq, block)
# Invalidate the block with entry exit
unless block.invalidated
@cb.with_write_addr(block.start_addr) do
asm = Assembler.new
asm.comment('invalidate_block')
asm.jmp(block.entry_exit)
@cb.write(asm)
end
block.invalidated = true
end
# Re-stub incoming branches
block.incoming.each do |branch_stub|
target = [branch_stub.target0, branch_stub.target1].compact.find do |target|
target.pc == block.pc && target.ctx == block.ctx
end
next if target.nil?
# TODO: Could target.address be a stub address? Is invalidation not needed in that case?
# If the target being re-generated is currently a fallthrough block,
# the fallthrough code must be rewritten with a jump to the stub.
if target.address == branch_stub.end_addr
branch_stub.shape = Default
end
target.address = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_branch_stub(block.ctx, ocb_asm, branch_stub, target == branch_stub.target0)
@ocb.write(ocb_asm)
end
@cb.with_write_addr(branch_stub.start_addr) do
branch_asm = Assembler.new
branch_stub.compile.call(branch_asm)
@cb.write(branch_asm)
end
end
end
private
# Callee-saved: rbx, rsp, rbp, r12, r13, r14, r15
# Caller-saved: rax, rdi, rsi, rdx, rcx, r8, r9, r10, r11
#
# @param asm [RubyVM::RJIT::Assembler]
def compile_prologue(asm, iseq, pc)
asm.comment('RJIT entry point')
# Save callee-saved registers used by JITed code
asm.push(CFP)
asm.push(EC)
asm.push(SP)
# Move arguments EC and CFP to dedicated registers
asm.mov(EC, :rdi)
asm.mov(CFP, :rsi)
# Load sp to a dedicated register
asm.mov(SP, [CFP, C.rb_control_frame_t.offsetof(:sp)]) # rbx = cfp->sp
# Setup cfp->jit_return
asm.mov(:rax, leave_exit)
asm.mov([CFP, C.rb_control_frame_t.offsetof(:jit_return)], :rax)
# We're compiling iseqs that we *expect* to start at `insn_idx`. But in
# the case of optional parameters, the interpreter can set the pc to a
# different location depending on the optional parameters. If an iseq
# has optional parameters, we'll add a runtime check that the PC we've
# compiled for is the same PC that the interpreter wants us to run with.
# If they don't match, then we'll take a side exit.
if iseq.body.param.flags.has_opt
compile_entry_chain_guard(asm, iseq, pc)
end
end
def compile_entry_chain_guard(asm, iseq, pc)
entry_stub = EntryStub.new
stub_addr = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_entry_stub(ocb_asm, entry_stub)
@ocb.write(ocb_asm)
end
asm.comment('guard expected PC')
asm.mov(:rax, pc)
asm.cmp([CFP, C.rb_control_frame_t.offsetof(:pc)], :rax)
asm.stub(entry_stub) do
asm.jne(stub_addr)
end
end
# @param asm [RubyVM::RJIT::Assembler]
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
def compile_block(asm, jit:, pc:, ctx: Context.new)
# Mark the block start address and prepare an exit code storage
ctx = limit_block_versions(jit.iseq, pc, ctx)
block = Block.new(iseq: jit.iseq, pc:, ctx: ctx.dup)
jit.block = block
asm.block(block)
iseq = jit.iseq
asm.comment("Block: #{iseq.body.location.label}@#{C.rb_iseq_path(iseq)}:#{iseq_lineno(iseq, pc)}")
# Compile each insn
index = (pc - iseq.body.iseq_encoded.to_i) / C.VALUE.size
while index < iseq.body.iseq_size
# Set the current instruction
insn = self.class.decode_insn(iseq.body.iseq_encoded[index])
jit.pc = (iseq.body.iseq_encoded + index).to_i
jit.stack_size_for_pc = ctx.stack_size
jit.side_exit_for_pc.clear
# If previous instruction requested to record the boundary
if jit.record_boundary_patch_point
# Generate an exit to this instruction and record it
exit_pos = Assembler.new.then do |ocb_asm|
@exit_compiler.compile_side_exit(jit.pc, ctx, ocb_asm)
@ocb.write(ocb_asm)
end
Invariants.record_global_inval_patch(asm, exit_pos)
jit.record_boundary_patch_point = false
end
# In debug mode, verify our existing assumption
if C.rjit_opts.verify_ctx && jit.at_current_insn?
verify_ctx(jit, ctx)
end
case status = @insn_compiler.compile(jit, ctx, asm, insn)
when KeepCompiling
# For now, reset the chain depth after each instruction as only the
# first instruction in the block can concern itself with the depth.
ctx.chain_depth = 0
index += insn.len
when EndBlock
# TODO: pad nops if entry exit exists (not needed for x86_64?)
break
when CantCompile
# Rewind stack_size using ctx.with_stack_size to allow stack_size changes
# before you return CantCompile.
@exit_compiler.compile_side_exit(jit.pc, ctx.with_stack_size(jit.stack_size_for_pc), asm)
# If this is the first instruction, this block never needs to be invalidated.
if block.pc == iseq.body.iseq_encoded.to_i + index * C.VALUE.size
block.invalidated = true
end
break
else
raise "compiling #{insn.name} returned unexpected status: #{status.inspect}"
end
end
incr_counter(:compiled_block_count)
add_block(iseq, block)
end
def leave_exit
@leave_exit ||= Assembler.new.then do |asm|
@exit_compiler.compile_leave_exit(asm)
@ocb.write(asm)
end
end
def incr_counter(name)
if C.rjit_opts.stats
C.rb_rjit_counters[name][0] += 1
end
end
# Produce a generic context when the block version limit is hit for the block
def limit_block_versions(iseq, pc, ctx)
# Guard chains implement limits separately, do nothing
if ctx.chain_depth > 0
return ctx.dup
end
# If this block version we're about to add will hit the version limit
if list_blocks(iseq, pc).size + 1 >= MAX_VERSIONS
# Produce a generic context that stores no type information,
# but still respects the stack_size and sp_offset constraints.
# This new context will then match all future requests.
generic_ctx = Context.new
generic_ctx.stack_size = ctx.stack_size
generic_ctx.sp_offset = ctx.sp_offset
if ctx.diff(generic_ctx) == TypeDiff::Incompatible
raise 'should substitute a compatible context'
end
return generic_ctx
end
return ctx.dup
end
def list_blocks(iseq, pc)
rjit_blocks(iseq)[pc]
end
# @param [Integer] pc
# @param [RubyVM::RJIT::Context] ctx
# @return [RubyVM::RJIT::Block,NilClass]
def find_block(iseq, pc, ctx)
versions = rjit_blocks(iseq)[pc]
best_version = nil
best_diff = Float::INFINITY
versions.each do |block|
# Note that we always prefer the first matching
# version found because of inline-cache chains
case ctx.diff(block.ctx)
in TypeDiff::Compatible[diff] if diff < best_diff
best_version = block
best_diff = diff
else
end
end
return best_version
end
# @param [RubyVM::RJIT::Block] block
def add_block(iseq, block)
rjit_blocks(iseq)[block.pc] << block
end
# @param [RubyVM::RJIT::Block] block
def remove_block(iseq, block)
rjit_blocks(iseq)[block.pc].delete(block)
end
def rjit_blocks(iseq)
# Guard against ISEQ GC at random moments
unless C.imemo_type_p(iseq, C.imemo_iseq)
return Hash.new { |h, k| h[k] = [] }
end
unless iseq.body.rjit_blocks
iseq.body.rjit_blocks = Hash.new { |blocks, pc| blocks[pc] = [] }
# For some reason, rb_rjit_iseq_mark didn't protect this Hash
# from being freed. So we rely on GC_REFS to keep the Hash.
GC_REFS << iseq.body.rjit_blocks
end
iseq.body.rjit_blocks
end
def iseq_lineno(iseq, pc)
C.rb_iseq_line_no(iseq, (pc - iseq.body.iseq_encoded.to_i) / C.VALUE.size)
rescue RangeError # bignum too big to convert into `unsigned long long' (RangeError)
-1
end
# Verify the ctx's types and mappings against the compile-time stack, self, and locals.
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
def verify_ctx(jit, ctx)
# Only able to check types when at current insn
assert(jit.at_current_insn?)
self_val = jit.peek_at_self
self_val_type = Type.from(self_val)
# Verify self operand type
assert_compatible(self_val_type, ctx.get_opnd_type(SelfOpnd))
# Verify stack operand types
[ctx.stack_size, MAX_TEMP_TYPES].min.times do |i|
learned_mapping, learned_type = ctx.get_opnd_mapping(StackOpnd[i])
stack_val = jit.peek_at_stack(i)
val_type = Type.from(stack_val)
case learned_mapping
in MapToSelf
if C.to_value(self_val) != C.to_value(stack_val)
raise "verify_ctx: stack value was mapped to self, but values did not match:\n"\
"stack: #{stack_val.inspect}, self: #{self_val.inspect}"
end
in MapToLocal[local_idx]
local_val = jit.peek_at_local(local_idx)
if C.to_value(local_val) != C.to_value(stack_val)
raise "verify_ctx: stack value was mapped to local, but values did not match:\n"\
"stack: #{stack_val.inspect}, local: #{local_val.inspect}"
end
in MapToStack
# noop
end
# If the actual type differs from the learned type
assert_compatible(val_type, learned_type)
end
# Verify local variable types
local_table_size = jit.iseq.body.local_table_size
[local_table_size, MAX_TEMP_TYPES].min.times do |i|
learned_type = ctx.get_local_type(i)
local_val = jit.peek_at_local(i)
local_type = Type.from(local_val)
assert_compatible(local_type, learned_type)
end
end
def assert_compatible(actual_type, ctx_type)
if actual_type.diff(ctx_type) == TypeDiff::Incompatible
raise "verify_ctx: ctx type (#{ctx_type.type.inspect}) is incompatible with actual type (#{actual_type.type.inspect})"
end
end
def assert(cond)
unless cond
raise "'#{cond.inspect}' was not true"
end
end
def supported_platform?
return @supported_platform if defined?(@supported_platform)
@supported_platform = RUBY_PLATFORM.match?(/x86_64/).tap do |supported|
warn "warning: RJIT does not support #{RUBY_PLATFORM} yet" unless supported
end
end
end
end
share/ruby/ruby_vm/rjit/instruction.rb 0000644 00000107121 15173517737 0014212 0 ustar 00 module RubyVM::RJIT # :nodoc: all
Instruction = Data.define(:name, :bin, :len, :operands)
INSNS = {
0 => Instruction.new(
name: :nop,
bin: 0, # BIN(nop)
len: 1, # insn_len
operands: [],
),
1 => Instruction.new(
name: :getlocal,
bin: 1, # BIN(getlocal)
len: 3, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}, {:decl=>"rb_num_t level", :type=>"rb_num_t", :name=>"level"}],
),
2 => Instruction.new(
name: :setlocal,
bin: 2, # BIN(setlocal)
len: 3, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}, {:decl=>"rb_num_t level", :type=>"rb_num_t", :name=>"level"}],
),
3 => Instruction.new(
name: :getblockparam,
bin: 3, # BIN(getblockparam)
len: 3, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}, {:decl=>"rb_num_t level", :type=>"rb_num_t", :name=>"level"}],
),
4 => Instruction.new(
name: :setblockparam,
bin: 4, # BIN(setblockparam)
len: 3, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}, {:decl=>"rb_num_t level", :type=>"rb_num_t", :name=>"level"}],
),
5 => Instruction.new(
name: :getblockparamproxy,
bin: 5, # BIN(getblockparamproxy)
len: 3, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}, {:decl=>"rb_num_t level", :type=>"rb_num_t", :name=>"level"}],
),
6 => Instruction.new(
name: :getspecial,
bin: 6, # BIN(getspecial)
len: 3, # insn_len
operands: [{:decl=>"rb_num_t key", :type=>"rb_num_t", :name=>"key"}, {:decl=>"rb_num_t type", :type=>"rb_num_t", :name=>"type"}],
),
7 => Instruction.new(
name: :setspecial,
bin: 7, # BIN(setspecial)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t key", :type=>"rb_num_t", :name=>"key"}],
),
8 => Instruction.new(
name: :getinstancevariable,
bin: 8, # BIN(getinstancevariable)
len: 3, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"IVC ic", :type=>"IVC", :name=>"ic"}],
),
9 => Instruction.new(
name: :setinstancevariable,
bin: 9, # BIN(setinstancevariable)
len: 3, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"IVC ic", :type=>"IVC", :name=>"ic"}],
),
10 => Instruction.new(
name: :getclassvariable,
bin: 10, # BIN(getclassvariable)
len: 3, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"ICVARC ic", :type=>"ICVARC", :name=>"ic"}],
),
11 => Instruction.new(
name: :setclassvariable,
bin: 11, # BIN(setclassvariable)
len: 3, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"ICVARC ic", :type=>"ICVARC", :name=>"ic"}],
),
12 => Instruction.new(
name: :opt_getconstant_path,
bin: 12, # BIN(opt_getconstant_path)
len: 2, # insn_len
operands: [{:decl=>"IC ic", :type=>"IC", :name=>"ic"}],
),
13 => Instruction.new(
name: :getconstant,
bin: 13, # BIN(getconstant)
len: 2, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}],
),
14 => Instruction.new(
name: :setconstant,
bin: 14, # BIN(setconstant)
len: 2, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}],
),
15 => Instruction.new(
name: :getglobal,
bin: 15, # BIN(getglobal)
len: 2, # insn_len
operands: [{:decl=>"ID gid", :type=>"ID", :name=>"gid"}],
),
16 => Instruction.new(
name: :setglobal,
bin: 16, # BIN(setglobal)
len: 2, # insn_len
operands: [{:decl=>"ID gid", :type=>"ID", :name=>"gid"}],
),
17 => Instruction.new(
name: :putnil,
bin: 17, # BIN(putnil)
len: 1, # insn_len
operands: [],
),
18 => Instruction.new(
name: :putself,
bin: 18, # BIN(putself)
len: 1, # insn_len
operands: [],
),
19 => Instruction.new(
name: :putobject,
bin: 19, # BIN(putobject)
len: 2, # insn_len
operands: [{:decl=>"VALUE val", :type=>"VALUE", :name=>"val"}],
),
20 => Instruction.new(
name: :putspecialobject,
bin: 20, # BIN(putspecialobject)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t value_type", :type=>"rb_num_t", :name=>"value_type"}],
),
21 => Instruction.new(
name: :putstring,
bin: 21, # BIN(putstring)
len: 2, # insn_len
operands: [{:decl=>"VALUE str", :type=>"VALUE", :name=>"str"}],
),
22 => Instruction.new(
name: :concatstrings,
bin: 22, # BIN(concatstrings)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t num", :type=>"rb_num_t", :name=>"num"}],
),
23 => Instruction.new(
name: :anytostring,
bin: 23, # BIN(anytostring)
len: 1, # insn_len
operands: [],
),
24 => Instruction.new(
name: :toregexp,
bin: 24, # BIN(toregexp)
len: 3, # insn_len
operands: [{:decl=>"rb_num_t opt", :type=>"rb_num_t", :name=>"opt"}, {:decl=>"rb_num_t cnt", :type=>"rb_num_t", :name=>"cnt"}],
),
25 => Instruction.new(
name: :intern,
bin: 25, # BIN(intern)
len: 1, # insn_len
operands: [],
),
26 => Instruction.new(
name: :newarray,
bin: 26, # BIN(newarray)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t num", :type=>"rb_num_t", :name=>"num"}],
),
27 => Instruction.new(
name: :newarraykwsplat,
bin: 27, # BIN(newarraykwsplat)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t num", :type=>"rb_num_t", :name=>"num"}],
),
28 => Instruction.new(
name: :duparray,
bin: 28, # BIN(duparray)
len: 2, # insn_len
operands: [{:decl=>"VALUE ary", :type=>"VALUE", :name=>"ary"}],
),
29 => Instruction.new(
name: :duphash,
bin: 29, # BIN(duphash)
len: 2, # insn_len
operands: [{:decl=>"VALUE hash", :type=>"VALUE", :name=>"hash"}],
),
30 => Instruction.new(
name: :expandarray,
bin: 30, # BIN(expandarray)
len: 3, # insn_len
operands: [{:decl=>"rb_num_t num", :type=>"rb_num_t", :name=>"num"}, {:decl=>"rb_num_t flag", :type=>"rb_num_t", :name=>"flag"}],
),
31 => Instruction.new(
name: :concatarray,
bin: 31, # BIN(concatarray)
len: 1, # insn_len
operands: [],
),
32 => Instruction.new(
name: :splatarray,
bin: 32, # BIN(splatarray)
len: 2, # insn_len
operands: [{:decl=>"VALUE flag", :type=>"VALUE", :name=>"flag"}],
),
33 => Instruction.new(
name: :splatkw,
bin: 33, # BIN(splatkw)
len: 1, # insn_len
operands: [],
),
34 => Instruction.new(
name: :newhash,
bin: 34, # BIN(newhash)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t num", :type=>"rb_num_t", :name=>"num"}],
),
35 => Instruction.new(
name: :newrange,
bin: 35, # BIN(newrange)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t flag", :type=>"rb_num_t", :name=>"flag"}],
),
36 => Instruction.new(
name: :pop,
bin: 36, # BIN(pop)
len: 1, # insn_len
operands: [],
),
37 => Instruction.new(
name: :dup,
bin: 37, # BIN(dup)
len: 1, # insn_len
operands: [],
),
38 => Instruction.new(
name: :dupn,
bin: 38, # BIN(dupn)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t n", :type=>"rb_num_t", :name=>"n"}],
),
39 => Instruction.new(
name: :swap,
bin: 39, # BIN(swap)
len: 1, # insn_len
operands: [],
),
40 => Instruction.new(
name: :opt_reverse,
bin: 40, # BIN(opt_reverse)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t n", :type=>"rb_num_t", :name=>"n"}],
),
41 => Instruction.new(
name: :topn,
bin: 41, # BIN(topn)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t n", :type=>"rb_num_t", :name=>"n"}],
),
42 => Instruction.new(
name: :setn,
bin: 42, # BIN(setn)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t n", :type=>"rb_num_t", :name=>"n"}],
),
43 => Instruction.new(
name: :adjuststack,
bin: 43, # BIN(adjuststack)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t n", :type=>"rb_num_t", :name=>"n"}],
),
44 => Instruction.new(
name: :defined,
bin: 44, # BIN(defined)
len: 4, # insn_len
operands: [{:decl=>"rb_num_t op_type", :type=>"rb_num_t", :name=>"op_type"}, {:decl=>"VALUE obj", :type=>"VALUE", :name=>"obj"}, {:decl=>"VALUE pushval", :type=>"VALUE", :name=>"pushval"}],
),
45 => Instruction.new(
name: :definedivar,
bin: 45, # BIN(definedivar)
len: 4, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"IVC ic", :type=>"IVC", :name=>"ic"}, {:decl=>"VALUE pushval", :type=>"VALUE", :name=>"pushval"}],
),
46 => Instruction.new(
name: :checkmatch,
bin: 46, # BIN(checkmatch)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t flag", :type=>"rb_num_t", :name=>"flag"}],
),
47 => Instruction.new(
name: :checkkeyword,
bin: 47, # BIN(checkkeyword)
len: 3, # insn_len
operands: [{:decl=>"lindex_t kw_bits_index", :type=>"lindex_t", :name=>"kw_bits_index"}, {:decl=>"lindex_t keyword_index", :type=>"lindex_t", :name=>"keyword_index"}],
),
48 => Instruction.new(
name: :checktype,
bin: 48, # BIN(checktype)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t type", :type=>"rb_num_t", :name=>"type"}],
),
49 => Instruction.new(
name: :defineclass,
bin: 49, # BIN(defineclass)
len: 4, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"ISEQ class_iseq", :type=>"ISEQ", :name=>"class_iseq"}, {:decl=>"rb_num_t flags", :type=>"rb_num_t", :name=>"flags"}],
),
50 => Instruction.new(
name: :definemethod,
bin: 50, # BIN(definemethod)
len: 3, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"ISEQ iseq", :type=>"ISEQ", :name=>"iseq"}],
),
51 => Instruction.new(
name: :definesmethod,
bin: 51, # BIN(definesmethod)
len: 3, # insn_len
operands: [{:decl=>"ID id", :type=>"ID", :name=>"id"}, {:decl=>"ISEQ iseq", :type=>"ISEQ", :name=>"iseq"}],
),
52 => Instruction.new(
name: :send,
bin: 52, # BIN(send)
len: 3, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}, {:decl=>"ISEQ blockiseq", :type=>"ISEQ", :name=>"blockiseq"}],
),
53 => Instruction.new(
name: :opt_send_without_block,
bin: 53, # BIN(opt_send_without_block)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
54 => Instruction.new(
name: :objtostring,
bin: 54, # BIN(objtostring)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
55 => Instruction.new(
name: :opt_str_freeze,
bin: 55, # BIN(opt_str_freeze)
len: 3, # insn_len
operands: [{:decl=>"VALUE str", :type=>"VALUE", :name=>"str"}, {:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
56 => Instruction.new(
name: :opt_nil_p,
bin: 56, # BIN(opt_nil_p)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
57 => Instruction.new(
name: :opt_str_uminus,
bin: 57, # BIN(opt_str_uminus)
len: 3, # insn_len
operands: [{:decl=>"VALUE str", :type=>"VALUE", :name=>"str"}, {:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
58 => Instruction.new(
name: :opt_newarray_send,
bin: 58, # BIN(opt_newarray_send)
len: 3, # insn_len
operands: [{:decl=>"rb_num_t num", :type=>"rb_num_t", :name=>"num"}, {:decl=>"ID method", :type=>"ID", :name=>"method"}],
),
59 => Instruction.new(
name: :invokesuper,
bin: 59, # BIN(invokesuper)
len: 3, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}, {:decl=>"ISEQ blockiseq", :type=>"ISEQ", :name=>"blockiseq"}],
),
60 => Instruction.new(
name: :invokeblock,
bin: 60, # BIN(invokeblock)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
61 => Instruction.new(
name: :leave,
bin: 61, # BIN(leave)
len: 1, # insn_len
operands: [],
),
62 => Instruction.new(
name: :throw,
bin: 62, # BIN(throw)
len: 2, # insn_len
operands: [{:decl=>"rb_num_t throw_state", :type=>"rb_num_t", :name=>"throw_state"}],
),
63 => Instruction.new(
name: :jump,
bin: 63, # BIN(jump)
len: 2, # insn_len
operands: [{:decl=>"OFFSET dst", :type=>"OFFSET", :name=>"dst"}],
),
64 => Instruction.new(
name: :branchif,
bin: 64, # BIN(branchif)
len: 2, # insn_len
operands: [{:decl=>"OFFSET dst", :type=>"OFFSET", :name=>"dst"}],
),
65 => Instruction.new(
name: :branchunless,
bin: 65, # BIN(branchunless)
len: 2, # insn_len
operands: [{:decl=>"OFFSET dst", :type=>"OFFSET", :name=>"dst"}],
),
66 => Instruction.new(
name: :branchnil,
bin: 66, # BIN(branchnil)
len: 2, # insn_len
operands: [{:decl=>"OFFSET dst", :type=>"OFFSET", :name=>"dst"}],
),
67 => Instruction.new(
name: :once,
bin: 67, # BIN(once)
len: 3, # insn_len
operands: [{:decl=>"ISEQ iseq", :type=>"ISEQ", :name=>"iseq"}, {:decl=>"ISE ise", :type=>"ISE", :name=>"ise"}],
),
68 => Instruction.new(
name: :opt_case_dispatch,
bin: 68, # BIN(opt_case_dispatch)
len: 3, # insn_len
operands: [{:decl=>"CDHASH hash", :type=>"CDHASH", :name=>"hash"}, {:decl=>"OFFSET else_offset", :type=>"OFFSET", :name=>"else_offset"}],
),
69 => Instruction.new(
name: :opt_plus,
bin: 69, # BIN(opt_plus)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
70 => Instruction.new(
name: :opt_minus,
bin: 70, # BIN(opt_minus)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
71 => Instruction.new(
name: :opt_mult,
bin: 71, # BIN(opt_mult)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
72 => Instruction.new(
name: :opt_div,
bin: 72, # BIN(opt_div)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
73 => Instruction.new(
name: :opt_mod,
bin: 73, # BIN(opt_mod)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
74 => Instruction.new(
name: :opt_eq,
bin: 74, # BIN(opt_eq)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
75 => Instruction.new(
name: :opt_neq,
bin: 75, # BIN(opt_neq)
len: 3, # insn_len
operands: [{:decl=>"CALL_DATA cd_eq", :type=>"CALL_DATA", :name=>"cd_eq"}, {:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
76 => Instruction.new(
name: :opt_lt,
bin: 76, # BIN(opt_lt)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
77 => Instruction.new(
name: :opt_le,
bin: 77, # BIN(opt_le)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
78 => Instruction.new(
name: :opt_gt,
bin: 78, # BIN(opt_gt)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
79 => Instruction.new(
name: :opt_ge,
bin: 79, # BIN(opt_ge)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
80 => Instruction.new(
name: :opt_ltlt,
bin: 80, # BIN(opt_ltlt)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
81 => Instruction.new(
name: :opt_and,
bin: 81, # BIN(opt_and)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
82 => Instruction.new(
name: :opt_or,
bin: 82, # BIN(opt_or)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
83 => Instruction.new(
name: :opt_aref,
bin: 83, # BIN(opt_aref)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
84 => Instruction.new(
name: :opt_aset,
bin: 84, # BIN(opt_aset)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
85 => Instruction.new(
name: :opt_aset_with,
bin: 85, # BIN(opt_aset_with)
len: 3, # insn_len
operands: [{:decl=>"VALUE key", :type=>"VALUE", :name=>"key"}, {:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
86 => Instruction.new(
name: :opt_aref_with,
bin: 86, # BIN(opt_aref_with)
len: 3, # insn_len
operands: [{:decl=>"VALUE key", :type=>"VALUE", :name=>"key"}, {:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
87 => Instruction.new(
name: :opt_length,
bin: 87, # BIN(opt_length)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
88 => Instruction.new(
name: :opt_size,
bin: 88, # BIN(opt_size)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
89 => Instruction.new(
name: :opt_empty_p,
bin: 89, # BIN(opt_empty_p)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
90 => Instruction.new(
name: :opt_succ,
bin: 90, # BIN(opt_succ)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
91 => Instruction.new(
name: :opt_not,
bin: 91, # BIN(opt_not)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
92 => Instruction.new(
name: :opt_regexpmatch2,
bin: 92, # BIN(opt_regexpmatch2)
len: 2, # insn_len
operands: [{:decl=>"CALL_DATA cd", :type=>"CALL_DATA", :name=>"cd"}],
),
93 => Instruction.new(
name: :invokebuiltin,
bin: 93, # BIN(invokebuiltin)
len: 2, # insn_len
operands: [{:decl=>"RB_BUILTIN bf", :type=>"RB_BUILTIN", :name=>"bf"}],
),
94 => Instruction.new(
name: :opt_invokebuiltin_delegate,
bin: 94, # BIN(opt_invokebuiltin_delegate)
len: 3, # insn_len
operands: [{:decl=>"RB_BUILTIN bf", :type=>"RB_BUILTIN", :name=>"bf"}, {:decl=>"rb_num_t index", :type=>"rb_num_t", :name=>"index"}],
),
95 => Instruction.new(
name: :opt_invokebuiltin_delegate_leave,
bin: 95, # BIN(opt_invokebuiltin_delegate_leave)
len: 3, # insn_len
operands: [{:decl=>"RB_BUILTIN bf", :type=>"RB_BUILTIN", :name=>"bf"}, {:decl=>"rb_num_t index", :type=>"rb_num_t", :name=>"index"}],
),
96 => Instruction.new(
name: :getlocal_WC_0,
bin: 96, # BIN(getlocal_WC_0)
len: 2, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}],
),
97 => Instruction.new(
name: :getlocal_WC_1,
bin: 97, # BIN(getlocal_WC_1)
len: 2, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}],
),
98 => Instruction.new(
name: :setlocal_WC_0,
bin: 98, # BIN(setlocal_WC_0)
len: 2, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}],
),
99 => Instruction.new(
name: :setlocal_WC_1,
bin: 99, # BIN(setlocal_WC_1)
len: 2, # insn_len
operands: [{:decl=>"lindex_t idx", :type=>"lindex_t", :name=>"idx"}],
),
100 => Instruction.new(
name: :putobject_INT2FIX_0_,
bin: 100, # BIN(putobject_INT2FIX_0_)
len: 1, # insn_len
operands: [],
),
101 => Instruction.new(
name: :putobject_INT2FIX_1_,
bin: 101, # BIN(putobject_INT2FIX_1_)
len: 1, # insn_len
operands: [],
),
102 => Instruction.new(
name: :trace_nop,
bin: 102, # BIN(trace_nop)
len: 1, # insn_len
operands: nil,
),
103 => Instruction.new(
name: :trace_getlocal,
bin: 103, # BIN(trace_getlocal)
len: 3, # insn_len
operands: nil,
),
104 => Instruction.new(
name: :trace_setlocal,
bin: 104, # BIN(trace_setlocal)
len: 3, # insn_len
operands: nil,
),
105 => Instruction.new(
name: :trace_getblockparam,
bin: 105, # BIN(trace_getblockparam)
len: 3, # insn_len
operands: nil,
),
106 => Instruction.new(
name: :trace_setblockparam,
bin: 106, # BIN(trace_setblockparam)
len: 3, # insn_len
operands: nil,
),
107 => Instruction.new(
name: :trace_getblockparamproxy,
bin: 107, # BIN(trace_getblockparamproxy)
len: 3, # insn_len
operands: nil,
),
108 => Instruction.new(
name: :trace_getspecial,
bin: 108, # BIN(trace_getspecial)
len: 3, # insn_len
operands: nil,
),
109 => Instruction.new(
name: :trace_setspecial,
bin: 109, # BIN(trace_setspecial)
len: 2, # insn_len
operands: nil,
),
110 => Instruction.new(
name: :trace_getinstancevariable,
bin: 110, # BIN(trace_getinstancevariable)
len: 3, # insn_len
operands: nil,
),
111 => Instruction.new(
name: :trace_setinstancevariable,
bin: 111, # BIN(trace_setinstancevariable)
len: 3, # insn_len
operands: nil,
),
112 => Instruction.new(
name: :trace_getclassvariable,
bin: 112, # BIN(trace_getclassvariable)
len: 3, # insn_len
operands: nil,
),
113 => Instruction.new(
name: :trace_setclassvariable,
bin: 113, # BIN(trace_setclassvariable)
len: 3, # insn_len
operands: nil,
),
114 => Instruction.new(
name: :trace_opt_getconstant_path,
bin: 114, # BIN(trace_opt_getconstant_path)
len: 2, # insn_len
operands: nil,
),
115 => Instruction.new(
name: :trace_getconstant,
bin: 115, # BIN(trace_getconstant)
len: 2, # insn_len
operands: nil,
),
116 => Instruction.new(
name: :trace_setconstant,
bin: 116, # BIN(trace_setconstant)
len: 2, # insn_len
operands: nil,
),
117 => Instruction.new(
name: :trace_getglobal,
bin: 117, # BIN(trace_getglobal)
len: 2, # insn_len
operands: nil,
),
118 => Instruction.new(
name: :trace_setglobal,
bin: 118, # BIN(trace_setglobal)
len: 2, # insn_len
operands: nil,
),
119 => Instruction.new(
name: :trace_putnil,
bin: 119, # BIN(trace_putnil)
len: 1, # insn_len
operands: nil,
),
120 => Instruction.new(
name: :trace_putself,
bin: 120, # BIN(trace_putself)
len: 1, # insn_len
operands: nil,
),
121 => Instruction.new(
name: :trace_putobject,
bin: 121, # BIN(trace_putobject)
len: 2, # insn_len
operands: nil,
),
122 => Instruction.new(
name: :trace_putspecialobject,
bin: 122, # BIN(trace_putspecialobject)
len: 2, # insn_len
operands: nil,
),
123 => Instruction.new(
name: :trace_putstring,
bin: 123, # BIN(trace_putstring)
len: 2, # insn_len
operands: nil,
),
124 => Instruction.new(
name: :trace_concatstrings,
bin: 124, # BIN(trace_concatstrings)
len: 2, # insn_len
operands: nil,
),
125 => Instruction.new(
name: :trace_anytostring,
bin: 125, # BIN(trace_anytostring)
len: 1, # insn_len
operands: nil,
),
126 => Instruction.new(
name: :trace_toregexp,
bin: 126, # BIN(trace_toregexp)
len: 3, # insn_len
operands: nil,
),
127 => Instruction.new(
name: :trace_intern,
bin: 127, # BIN(trace_intern)
len: 1, # insn_len
operands: nil,
),
128 => Instruction.new(
name: :trace_newarray,
bin: 128, # BIN(trace_newarray)
len: 2, # insn_len
operands: nil,
),
129 => Instruction.new(
name: :trace_newarraykwsplat,
bin: 129, # BIN(trace_newarraykwsplat)
len: 2, # insn_len
operands: nil,
),
130 => Instruction.new(
name: :trace_duparray,
bin: 130, # BIN(trace_duparray)
len: 2, # insn_len
operands: nil,
),
131 => Instruction.new(
name: :trace_duphash,
bin: 131, # BIN(trace_duphash)
len: 2, # insn_len
operands: nil,
),
132 => Instruction.new(
name: :trace_expandarray,
bin: 132, # BIN(trace_expandarray)
len: 3, # insn_len
operands: nil,
),
133 => Instruction.new(
name: :trace_concatarray,
bin: 133, # BIN(trace_concatarray)
len: 1, # insn_len
operands: nil,
),
134 => Instruction.new(
name: :trace_splatarray,
bin: 134, # BIN(trace_splatarray)
len: 2, # insn_len
operands: nil,
),
135 => Instruction.new(
name: :trace_splatkw,
bin: 135, # BIN(trace_splatkw)
len: 1, # insn_len
operands: nil,
),
136 => Instruction.new(
name: :trace_newhash,
bin: 136, # BIN(trace_newhash)
len: 2, # insn_len
operands: nil,
),
137 => Instruction.new(
name: :trace_newrange,
bin: 137, # BIN(trace_newrange)
len: 2, # insn_len
operands: nil,
),
138 => Instruction.new(
name: :trace_pop,
bin: 138, # BIN(trace_pop)
len: 1, # insn_len
operands: nil,
),
139 => Instruction.new(
name: :trace_dup,
bin: 139, # BIN(trace_dup)
len: 1, # insn_len
operands: nil,
),
140 => Instruction.new(
name: :trace_dupn,
bin: 140, # BIN(trace_dupn)
len: 2, # insn_len
operands: nil,
),
141 => Instruction.new(
name: :trace_swap,
bin: 141, # BIN(trace_swap)
len: 1, # insn_len
operands: nil,
),
142 => Instruction.new(
name: :trace_opt_reverse,
bin: 142, # BIN(trace_opt_reverse)
len: 2, # insn_len
operands: nil,
),
143 => Instruction.new(
name: :trace_topn,
bin: 143, # BIN(trace_topn)
len: 2, # insn_len
operands: nil,
),
144 => Instruction.new(
name: :trace_setn,
bin: 144, # BIN(trace_setn)
len: 2, # insn_len
operands: nil,
),
145 => Instruction.new(
name: :trace_adjuststack,
bin: 145, # BIN(trace_adjuststack)
len: 2, # insn_len
operands: nil,
),
146 => Instruction.new(
name: :trace_defined,
bin: 146, # BIN(trace_defined)
len: 4, # insn_len
operands: nil,
),
147 => Instruction.new(
name: :trace_definedivar,
bin: 147, # BIN(trace_definedivar)
len: 4, # insn_len
operands: nil,
),
148 => Instruction.new(
name: :trace_checkmatch,
bin: 148, # BIN(trace_checkmatch)
len: 2, # insn_len
operands: nil,
),
149 => Instruction.new(
name: :trace_checkkeyword,
bin: 149, # BIN(trace_checkkeyword)
len: 3, # insn_len
operands: nil,
),
150 => Instruction.new(
name: :trace_checktype,
bin: 150, # BIN(trace_checktype)
len: 2, # insn_len
operands: nil,
),
151 => Instruction.new(
name: :trace_defineclass,
bin: 151, # BIN(trace_defineclass)
len: 4, # insn_len
operands: nil,
),
152 => Instruction.new(
name: :trace_definemethod,
bin: 152, # BIN(trace_definemethod)
len: 3, # insn_len
operands: nil,
),
153 => Instruction.new(
name: :trace_definesmethod,
bin: 153, # BIN(trace_definesmethod)
len: 3, # insn_len
operands: nil,
),
154 => Instruction.new(
name: :trace_send,
bin: 154, # BIN(trace_send)
len: 3, # insn_len
operands: nil,
),
155 => Instruction.new(
name: :trace_opt_send_without_block,
bin: 155, # BIN(trace_opt_send_without_block)
len: 2, # insn_len
operands: nil,
),
156 => Instruction.new(
name: :trace_objtostring,
bin: 156, # BIN(trace_objtostring)
len: 2, # insn_len
operands: nil,
),
157 => Instruction.new(
name: :trace_opt_str_freeze,
bin: 157, # BIN(trace_opt_str_freeze)
len: 3, # insn_len
operands: nil,
),
158 => Instruction.new(
name: :trace_opt_nil_p,
bin: 158, # BIN(trace_opt_nil_p)
len: 2, # insn_len
operands: nil,
),
159 => Instruction.new(
name: :trace_opt_str_uminus,
bin: 159, # BIN(trace_opt_str_uminus)
len: 3, # insn_len
operands: nil,
),
160 => Instruction.new(
name: :trace_opt_newarray_send,
bin: 160, # BIN(trace_opt_newarray_send)
len: 3, # insn_len
operands: nil,
),
161 => Instruction.new(
name: :trace_invokesuper,
bin: 161, # BIN(trace_invokesuper)
len: 3, # insn_len
operands: nil,
),
162 => Instruction.new(
name: :trace_invokeblock,
bin: 162, # BIN(trace_invokeblock)
len: 2, # insn_len
operands: nil,
),
163 => Instruction.new(
name: :trace_leave,
bin: 163, # BIN(trace_leave)
len: 1, # insn_len
operands: nil,
),
164 => Instruction.new(
name: :trace_throw,
bin: 164, # BIN(trace_throw)
len: 2, # insn_len
operands: nil,
),
165 => Instruction.new(
name: :trace_jump,
bin: 165, # BIN(trace_jump)
len: 2, # insn_len
operands: nil,
),
166 => Instruction.new(
name: :trace_branchif,
bin: 166, # BIN(trace_branchif)
len: 2, # insn_len
operands: nil,
),
167 => Instruction.new(
name: :trace_branchunless,
bin: 167, # BIN(trace_branchunless)
len: 2, # insn_len
operands: nil,
),
168 => Instruction.new(
name: :trace_branchnil,
bin: 168, # BIN(trace_branchnil)
len: 2, # insn_len
operands: nil,
),
169 => Instruction.new(
name: :trace_once,
bin: 169, # BIN(trace_once)
len: 3, # insn_len
operands: nil,
),
170 => Instruction.new(
name: :trace_opt_case_dispatch,
bin: 170, # BIN(trace_opt_case_dispatch)
len: 3, # insn_len
operands: nil,
),
171 => Instruction.new(
name: :trace_opt_plus,
bin: 171, # BIN(trace_opt_plus)
len: 2, # insn_len
operands: nil,
),
172 => Instruction.new(
name: :trace_opt_minus,
bin: 172, # BIN(trace_opt_minus)
len: 2, # insn_len
operands: nil,
),
173 => Instruction.new(
name: :trace_opt_mult,
bin: 173, # BIN(trace_opt_mult)
len: 2, # insn_len
operands: nil,
),
174 => Instruction.new(
name: :trace_opt_div,
bin: 174, # BIN(trace_opt_div)
len: 2, # insn_len
operands: nil,
),
175 => Instruction.new(
name: :trace_opt_mod,
bin: 175, # BIN(trace_opt_mod)
len: 2, # insn_len
operands: nil,
),
176 => Instruction.new(
name: :trace_opt_eq,
bin: 176, # BIN(trace_opt_eq)
len: 2, # insn_len
operands: nil,
),
177 => Instruction.new(
name: :trace_opt_neq,
bin: 177, # BIN(trace_opt_neq)
len: 3, # insn_len
operands: nil,
),
178 => Instruction.new(
name: :trace_opt_lt,
bin: 178, # BIN(trace_opt_lt)
len: 2, # insn_len
operands: nil,
),
179 => Instruction.new(
name: :trace_opt_le,
bin: 179, # BIN(trace_opt_le)
len: 2, # insn_len
operands: nil,
),
180 => Instruction.new(
name: :trace_opt_gt,
bin: 180, # BIN(trace_opt_gt)
len: 2, # insn_len
operands: nil,
),
181 => Instruction.new(
name: :trace_opt_ge,
bin: 181, # BIN(trace_opt_ge)
len: 2, # insn_len
operands: nil,
),
182 => Instruction.new(
name: :trace_opt_ltlt,
bin: 182, # BIN(trace_opt_ltlt)
len: 2, # insn_len
operands: nil,
),
183 => Instruction.new(
name: :trace_opt_and,
bin: 183, # BIN(trace_opt_and)
len: 2, # insn_len
operands: nil,
),
184 => Instruction.new(
name: :trace_opt_or,
bin: 184, # BIN(trace_opt_or)
len: 2, # insn_len
operands: nil,
),
185 => Instruction.new(
name: :trace_opt_aref,
bin: 185, # BIN(trace_opt_aref)
len: 2, # insn_len
operands: nil,
),
186 => Instruction.new(
name: :trace_opt_aset,
bin: 186, # BIN(trace_opt_aset)
len: 2, # insn_len
operands: nil,
),
187 => Instruction.new(
name: :trace_opt_aset_with,
bin: 187, # BIN(trace_opt_aset_with)
len: 3, # insn_len
operands: nil,
),
188 => Instruction.new(
name: :trace_opt_aref_with,
bin: 188, # BIN(trace_opt_aref_with)
len: 3, # insn_len
operands: nil,
),
189 => Instruction.new(
name: :trace_opt_length,
bin: 189, # BIN(trace_opt_length)
len: 2, # insn_len
operands: nil,
),
190 => Instruction.new(
name: :trace_opt_size,
bin: 190, # BIN(trace_opt_size)
len: 2, # insn_len
operands: nil,
),
191 => Instruction.new(
name: :trace_opt_empty_p,
bin: 191, # BIN(trace_opt_empty_p)
len: 2, # insn_len
operands: nil,
),
192 => Instruction.new(
name: :trace_opt_succ,
bin: 192, # BIN(trace_opt_succ)
len: 2, # insn_len
operands: nil,
),
193 => Instruction.new(
name: :trace_opt_not,
bin: 193, # BIN(trace_opt_not)
len: 2, # insn_len
operands: nil,
),
194 => Instruction.new(
name: :trace_opt_regexpmatch2,
bin: 194, # BIN(trace_opt_regexpmatch2)
len: 2, # insn_len
operands: nil,
),
195 => Instruction.new(
name: :trace_invokebuiltin,
bin: 195, # BIN(trace_invokebuiltin)
len: 2, # insn_len
operands: nil,
),
196 => Instruction.new(
name: :trace_opt_invokebuiltin_delegate,
bin: 196, # BIN(trace_opt_invokebuiltin_delegate)
len: 3, # insn_len
operands: nil,
),
197 => Instruction.new(
name: :trace_opt_invokebuiltin_delegate_leave,
bin: 197, # BIN(trace_opt_invokebuiltin_delegate_leave)
len: 3, # insn_len
operands: nil,
),
198 => Instruction.new(
name: :trace_getlocal_WC_0,
bin: 198, # BIN(trace_getlocal_WC_0)
len: 2, # insn_len
operands: nil,
),
199 => Instruction.new(
name: :trace_getlocal_WC_1,
bin: 199, # BIN(trace_getlocal_WC_1)
len: 2, # insn_len
operands: nil,
),
200 => Instruction.new(
name: :trace_setlocal_WC_0,
bin: 200, # BIN(trace_setlocal_WC_0)
len: 2, # insn_len
operands: nil,
),
201 => Instruction.new(
name: :trace_setlocal_WC_1,
bin: 201, # BIN(trace_setlocal_WC_1)
len: 2, # insn_len
operands: nil,
),
202 => Instruction.new(
name: :trace_putobject_INT2FIX_0_,
bin: 202, # BIN(trace_putobject_INT2FIX_0_)
len: 1, # insn_len
operands: nil,
),
203 => Instruction.new(
name: :trace_putobject_INT2FIX_1_,
bin: 203, # BIN(trace_putobject_INT2FIX_1_)
len: 1, # insn_len
operands: nil,
),
}
end
share/ruby/ruby_vm/rjit/exit_compiler.rb 0000644 00000011516 15173517737 0014476 0 ustar 00 module RubyVM::RJIT
class ExitCompiler
def initialize = freeze
# Used for invalidating a block on entry.
# @param pc [Integer]
# @param asm [RubyVM::RJIT::Assembler]
def compile_entry_exit(pc, ctx, asm, cause:)
# Fix pc/sp offsets for the interpreter
save_pc_and_sp(pc, ctx, asm, reset_sp_offset: false)
# Increment per-insn exit counter
count_insn_exit(pc, asm)
# Restore callee-saved registers
asm.comment("#{cause}: entry exit")
asm.pop(SP)
asm.pop(EC)
asm.pop(CFP)
asm.mov(C_RET, Qundef)
asm.ret
end
# Set to cfp->jit_return by default for leave insn
# @param asm [RubyVM::RJIT::Assembler]
def compile_leave_exit(asm)
asm.comment('default cfp->jit_return')
# Restore callee-saved registers
asm.pop(SP)
asm.pop(EC)
asm.pop(CFP)
# :rax is written by #leave
asm.ret
end
# Fire cfunc events on invalidation by TracePoint
# @param asm [RubyVM::RJIT::Assembler]
def compile_full_cfunc_return(asm)
# This chunk of code expects REG_EC to be filled properly and
# RAX to contain the return value of the C method.
asm.comment('full cfunc return')
asm.mov(C_ARGS[0], EC)
asm.mov(C_ARGS[1], :rax)
asm.call(C.rjit_full_cfunc_return)
# TODO: count the exit
# Restore callee-saved registers
asm.pop(SP)
asm.pop(EC)
asm.pop(CFP)
asm.mov(C_RET, Qundef)
asm.ret
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def compile_side_exit(pc, ctx, asm)
# Fix pc/sp offsets for the interpreter
save_pc_and_sp(pc, ctx.dup, asm) # dup to avoid sp_offset update
# Increment per-insn exit counter
count_insn_exit(pc, asm)
# Restore callee-saved registers
asm.comment("exit to interpreter on #{pc_to_insn(pc).name}")
asm.pop(SP)
asm.pop(EC)
asm.pop(CFP)
asm.mov(C_RET, Qundef)
asm.ret
end
# @param asm [RubyVM::RJIT::Assembler]
# @param entry_stub [RubyVM::RJIT::EntryStub]
def compile_entry_stub(asm, entry_stub)
# Call rb_rjit_entry_stub_hit
asm.comment('entry stub hit')
asm.mov(C_ARGS[0], to_value(entry_stub))
asm.call(C.rb_rjit_entry_stub_hit)
# Jump to the address returned by rb_rjit_entry_stub_hit
asm.jmp(:rax)
end
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
# @param branch_stub [RubyVM::RJIT::BranchStub]
# @param target0_p [TrueClass,FalseClass]
def compile_branch_stub(ctx, asm, branch_stub, target0_p)
# Call rb_rjit_branch_stub_hit
iseq = branch_stub.iseq
if C.rjit_opts.dump_disasm && C.imemo_type_p(iseq, C.imemo_iseq) # Guard against ISEQ GC at random moments
asm.comment("branch stub hit: #{iseq.body.location.label}@#{C.rb_iseq_path(iseq)}:#{iseq_lineno(iseq, target0_p ? branch_stub.target0.pc : branch_stub.target1.pc)}")
end
asm.mov(:rdi, to_value(branch_stub))
asm.mov(:esi, ctx.sp_offset)
asm.mov(:edx, target0_p ? 1 : 0)
asm.call(C.rb_rjit_branch_stub_hit)
# Jump to the address returned by rb_rjit_branch_stub_hit
asm.jmp(:rax)
end
private
def pc_to_insn(pc)
Compiler.decode_insn(C.VALUE.new(pc).*)
end
# @param pc [Integer]
# @param asm [RubyVM::RJIT::Assembler]
def count_insn_exit(pc, asm)
if C.rjit_opts.stats
insn = Compiler.decode_insn(C.VALUE.new(pc).*)
asm.comment("increment insn exit: #{insn.name}")
asm.mov(:rax, (C.rjit_insn_exits + insn.bin).to_i)
asm.add([:rax], 1) # TODO: lock
end
if C.rjit_opts.trace_exits
asm.comment('rjit_record_exit_stack')
asm.mov(C_ARGS[0], pc)
asm.call(C.rjit_record_exit_stack)
end
end
# @param jit [RubyVM::RJIT::JITState]
# @param ctx [RubyVM::RJIT::Context]
# @param asm [RubyVM::RJIT::Assembler]
def save_pc_and_sp(pc, ctx, asm, reset_sp_offset: true)
# Update pc (TODO: manage PC offset?)
asm.comment("save PC#{' and SP' if ctx.sp_offset != 0} to CFP")
asm.mov(:rax, pc) # rax = jit.pc
asm.mov([CFP, C.rb_control_frame_t.offsetof(:pc)], :rax) # cfp->pc = rax
# Update sp
if ctx.sp_offset != 0
asm.add(SP, C.VALUE.size * ctx.sp_offset) # sp += stack_size
asm.mov([CFP, C.rb_control_frame_t.offsetof(:sp)], SP) # cfp->sp = sp
if reset_sp_offset
ctx.sp_offset = 0
end
end
end
def to_value(obj)
GC_REFS << obj
C.to_value(obj)
end
def iseq_lineno(iseq, pc)
C.rb_iseq_line_no(iseq, (pc - iseq.body.iseq_encoded.to_i) / C.VALUE.size)
rescue RangeError # bignum too big to convert into `unsigned long long' (RangeError)
-1
end
end
end
share/ruby/ruby_vm/rjit/assembler.rb 0000644 00000100113 15173517737 0013600 0 ustar 00 # frozen_string_literal: true
module RubyVM::RJIT
# 8-bit memory access
class BytePtr < Data.define(:reg, :disp); end
# 32-bit memory access
class DwordPtr < Data.define(:reg, :disp); end
# 64-bit memory access
QwordPtr = Array
# SystemV x64 calling convention
C_ARGS = [:rdi, :rsi, :rdx, :rcx, :r8, :r9]
C_RET = :rax
# https://cdrdv2.intel.com/v1/dl/getContent/671110
# Mostly an x86_64 assembler, but this also has some stuff that is useful for any architecture.
class Assembler
# rel8 jumps are made with labels
class Label < Data.define(:id, :name); end
# rel32 is inserted as [Rel32, Rel32Pad..] and converted on #resolve_rel32
class Rel32 < Data.define(:addr); end
Rel32Pad = Object.new
# A set of ModR/M values encoded on #insn
class ModRM < Data.define(:mod, :reg, :rm); end
Mod00 = 0b00 # Mod 00: [reg]
Mod01 = 0b01 # Mod 01: [reg]+disp8
Mod10 = 0b10 # Mod 10: [reg]+disp32
Mod11 = 0b11 # Mod 11: reg
# REX = 0100WR0B
REX_B = 0b01000001
REX_R = 0b01000100
REX_W = 0b01001000
# Operand matchers
R32 = -> (op) { op.is_a?(Symbol) && r32?(op) }
R64 = -> (op) { op.is_a?(Symbol) && r64?(op) }
IMM8 = -> (op) { op.is_a?(Integer) && imm8?(op) }
IMM32 = -> (op) { op.is_a?(Integer) && imm32?(op) }
IMM64 = -> (op) { op.is_a?(Integer) && imm64?(op) }
def initialize
@bytes = []
@labels = {}
@label_id = 0
@comments = Hash.new { |h, k| h[k] = [] }
@blocks = Hash.new { |h, k| h[k] = [] }
@stub_starts = Hash.new { |h, k| h[k] = [] }
@stub_ends = Hash.new { |h, k| h[k] = [] }
@pos_markers = Hash.new { |h, k| h[k] = [] }
end
def assemble(addr)
set_code_addrs(addr)
resolve_rel32(addr)
resolve_labels
write_bytes(addr)
@pos_markers.each do |write_pos, markers|
markers.each { |marker| marker.call(addr + write_pos) }
end
@bytes.size
ensure
@bytes.clear
end
def size
@bytes.size
end
#
# Instructions
#
def add(dst, src)
case [dst, src]
# ADD r/m64, imm8 (Mod 00: [reg])
in [QwordPtr[R64 => dst_reg], IMM8 => src_imm]
# REX.W + 83 /0 ib
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod00, reg: 0, rm: dst_reg],
imm: imm8(src_imm),
)
# ADD r/m64, imm8 (Mod 11: reg)
in [R64 => dst_reg, IMM8 => src_imm]
# REX.W + 83 /0 ib
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod11, reg: 0, rm: dst_reg],
imm: imm8(src_imm),
)
# ADD r/m64 imm32 (Mod 11: reg)
in [R64 => dst_reg, IMM32 => src_imm]
# REX.W + 81 /0 id
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x81,
mod_rm: ModRM[mod: Mod11, reg: 0, rm: dst_reg],
imm: imm32(src_imm),
)
# ADD r/m64, r64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 01 /r
# MR: Operand 1: ModRM:r/m (r, w), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x01,
mod_rm: ModRM[mod: Mod11, reg: src_reg, rm: dst_reg],
)
end
end
def and(dst, src)
case [dst, src]
# AND r/m64, imm8 (Mod 11: reg)
in [R64 => dst_reg, IMM8 => src_imm]
# REX.W + 83 /4 ib
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod11, reg: 4, rm: dst_reg],
imm: imm8(src_imm),
)
# AND r/m64, imm32 (Mod 11: reg)
in [R64 => dst_reg, IMM32 => src_imm]
# REX.W + 81 /4 id
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x81,
mod_rm: ModRM[mod: Mod11, reg: 4, rm: dst_reg],
imm: imm32(src_imm),
)
# AND r64, r/m64 (Mod 01: [reg]+disp8)
in [R64 => dst_reg, QwordPtr[R64 => src_reg, IMM8 => src_disp]]
# REX.W + 23 /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x23,
mod_rm: ModRM[mod: Mod01, reg: dst_reg, rm: src_reg],
disp: imm8(src_disp),
)
end
end
def call(dst)
case dst
# CALL rel32
in Integer => dst_addr
# E8 cd
# D: Operand 1: Offset
insn(opcode: 0xe8, imm: rel32(dst_addr))
# CALL r/m64 (Mod 11: reg)
in R64 => dst_reg
# FF /2
# M: Operand 1: ModRM:r/m (r)
insn(
opcode: 0xff,
mod_rm: ModRM[mod: Mod11, reg: 2, rm: dst_reg],
)
end
end
def cmove(dst, src)
case [dst, src]
# CMOVE r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 44 /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x44],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
end
end
def cmovg(dst, src)
case [dst, src]
# CMOVG r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 4F /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x4f],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
end
end
def cmovge(dst, src)
case [dst, src]
# CMOVGE r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 4D /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x4d],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
end
end
def cmovl(dst, src)
case [dst, src]
# CMOVL r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 4C /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x4c],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
end
end
def cmovle(dst, src)
case [dst, src]
# CMOVLE r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 4E /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x4e],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
end
end
def cmovne(dst, src)
case [dst, src]
# CMOVNE r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 45 /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x45],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
end
end
def cmovnz(dst, src)
case [dst, src]
# CMOVNZ r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 45 /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x45],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
end
end
def cmovz(dst, src)
case [dst, src]
# CMOVZ r64, r/m64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 0F 44 /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x44],
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
# CMOVZ r64, r/m64 (Mod 01: [reg]+disp8)
in [R64 => dst_reg, QwordPtr[R64 => src_reg, IMM8 => src_disp]]
# REX.W + 0F 44 /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: [0x0f, 0x44],
mod_rm: ModRM[mod: Mod01, reg: dst_reg, rm: src_reg],
disp: imm8(src_disp),
)
end
end
def cmp(left, right)
case [left, right]
# CMP r/m8, imm8 (Mod 01: [reg]+disp8)
in [BytePtr[R64 => left_reg, IMM8 => left_disp], IMM8 => right_imm]
# 80 /7 ib
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
opcode: 0x80,
mod_rm: ModRM[mod: Mod01, reg: 7, rm: left_reg],
disp: left_disp,
imm: imm8(right_imm),
)
# CMP r/m32, imm32 (Mod 01: [reg]+disp8)
in [DwordPtr[R64 => left_reg, IMM8 => left_disp], IMM32 => right_imm]
# 81 /7 id
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
opcode: 0x81,
mod_rm: ModRM[mod: Mod01, reg: 7, rm: left_reg],
disp: left_disp,
imm: imm32(right_imm),
)
# CMP r/m64, imm8 (Mod 01: [reg]+disp8)
in [QwordPtr[R64 => left_reg, IMM8 => left_disp], IMM8 => right_imm]
# REX.W + 83 /7 ib
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod01, reg: 7, rm: left_reg],
disp: left_disp,
imm: imm8(right_imm),
)
# CMP r/m64, imm32 (Mod 01: [reg]+disp8)
in [QwordPtr[R64 => left_reg, IMM8 => left_disp], IMM32 => right_imm]
# REX.W + 81 /7 id
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x81,
mod_rm: ModRM[mod: Mod01, reg: 7, rm: left_reg],
disp: left_disp,
imm: imm32(right_imm),
)
# CMP r/m64, imm8 (Mod 10: [reg]+disp32)
in [QwordPtr[R64 => left_reg, IMM32 => left_disp], IMM8 => right_imm]
# REX.W + 83 /7 ib
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod10, reg: 7, rm: left_reg],
disp: imm32(left_disp),
imm: imm8(right_imm),
)
# CMP r/m64, imm8 (Mod 11: reg)
in [R64 => left_reg, IMM8 => right_imm]
# REX.W + 83 /7 ib
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod11, reg: 7, rm: left_reg],
imm: imm8(right_imm),
)
# CMP r/m64, imm32 (Mod 11: reg)
in [R64 => left_reg, IMM32 => right_imm]
# REX.W + 81 /7 id
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x81,
mod_rm: ModRM[mod: Mod11, reg: 7, rm: left_reg],
imm: imm32(right_imm),
)
# CMP r/m64, r64 (Mod 01: [reg]+disp8)
in [QwordPtr[R64 => left_reg, IMM8 => left_disp], R64 => right_reg]
# REX.W + 39 /r
# MR: Operand 1: ModRM:r/m (r), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x39,
mod_rm: ModRM[mod: Mod01, reg: right_reg, rm: left_reg],
disp: left_disp,
)
# CMP r/m64, r64 (Mod 10: [reg]+disp32)
in [QwordPtr[R64 => left_reg, IMM32 => left_disp], R64 => right_reg]
# REX.W + 39 /r
# MR: Operand 1: ModRM:r/m (r), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x39,
mod_rm: ModRM[mod: Mod10, reg: right_reg, rm: left_reg],
disp: imm32(left_disp),
)
# CMP r/m64, r64 (Mod 11: reg)
in [R64 => left_reg, R64 => right_reg]
# REX.W + 39 /r
# MR: Operand 1: ModRM:r/m (r), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x39,
mod_rm: ModRM[mod: Mod11, reg: right_reg, rm: left_reg],
)
end
end
def jbe(dst)
case dst
# JBE rel8
in Label => dst_label
# 76 cb
insn(opcode: 0x76, imm: dst_label)
# JBE rel32
in Integer => dst_addr
# 0F 86 cd
insn(opcode: [0x0f, 0x86], imm: rel32(dst_addr))
end
end
def je(dst)
case dst
# JE rel8
in Label => dst_label
# 74 cb
insn(opcode: 0x74, imm: dst_label)
# JE rel32
in Integer => dst_addr
# 0F 84 cd
insn(opcode: [0x0f, 0x84], imm: rel32(dst_addr))
end
end
def jl(dst)
case dst
# JL rel32
in Integer => dst_addr
# 0F 8C cd
insn(opcode: [0x0f, 0x8c], imm: rel32(dst_addr))
end
end
def jmp(dst)
case dst
# JZ rel8
in Label => dst_label
# EB cb
insn(opcode: 0xeb, imm: dst_label)
# JMP rel32
in Integer => dst_addr
# E9 cd
insn(opcode: 0xe9, imm: rel32(dst_addr))
# JMP r/m64 (Mod 01: [reg]+disp8)
in QwordPtr[R64 => dst_reg, IMM8 => dst_disp]
# FF /4
insn(opcode: 0xff, mod_rm: ModRM[mod: Mod01, reg: 4, rm: dst_reg], disp: dst_disp)
# JMP r/m64 (Mod 11: reg)
in R64 => dst_reg
# FF /4
insn(opcode: 0xff, mod_rm: ModRM[mod: Mod11, reg: 4, rm: dst_reg])
end
end
def jne(dst)
case dst
# JNE rel8
in Label => dst_label
# 75 cb
insn(opcode: 0x75, imm: dst_label)
# JNE rel32
in Integer => dst_addr
# 0F 85 cd
insn(opcode: [0x0f, 0x85], imm: rel32(dst_addr))
end
end
def jnz(dst)
case dst
# JE rel8
in Label => dst_label
# 75 cb
insn(opcode: 0x75, imm: dst_label)
# JNZ rel32
in Integer => dst_addr
# 0F 85 cd
insn(opcode: [0x0f, 0x85], imm: rel32(dst_addr))
end
end
def jo(dst)
case dst
# JO rel32
in Integer => dst_addr
# 0F 80 cd
insn(opcode: [0x0f, 0x80], imm: rel32(dst_addr))
end
end
def jz(dst)
case dst
# JZ rel8
in Label => dst_label
# 74 cb
insn(opcode: 0x74, imm: dst_label)
# JZ rel32
in Integer => dst_addr
# 0F 84 cd
insn(opcode: [0x0f, 0x84], imm: rel32(dst_addr))
end
end
def lea(dst, src)
case [dst, src]
# LEA r64,m (Mod 01: [reg]+disp8)
in [R64 => dst_reg, QwordPtr[R64 => src_reg, IMM8 => src_disp]]
# REX.W + 8D /r
# RM: Operand 1: ModRM:reg (w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x8d,
mod_rm: ModRM[mod: Mod01, reg: dst_reg, rm: src_reg],
disp: imm8(src_disp),
)
# LEA r64,m (Mod 10: [reg]+disp32)
in [R64 => dst_reg, QwordPtr[R64 => src_reg, IMM32 => src_disp]]
# REX.W + 8D /r
# RM: Operand 1: ModRM:reg (w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x8d,
mod_rm: ModRM[mod: Mod10, reg: dst_reg, rm: src_reg],
disp: imm32(src_disp),
)
end
end
def mov(dst, src)
case dst
in R32 => dst_reg
case src
# MOV r32 r/m32 (Mod 01: [reg]+disp8)
in DwordPtr[R64 => src_reg, IMM8 => src_disp]
# 8B /r
# RM: Operand 1: ModRM:reg (w), Operand 2: ModRM:r/m (r)
insn(
opcode: 0x8b,
mod_rm: ModRM[mod: Mod01, reg: dst_reg, rm: src_reg],
disp: src_disp,
)
# MOV r32, imm32 (Mod 11: reg)
in IMM32 => src_imm
# B8+ rd id
# OI: Operand 1: opcode + rd (w), Operand 2: imm8/16/32/64
insn(
opcode: 0xb8,
rd: dst_reg,
imm: imm32(src_imm),
)
end
in R64 => dst_reg
case src
# MOV r64, r/m64 (Mod 00: [reg])
in QwordPtr[R64 => src_reg]
# REX.W + 8B /r
# RM: Operand 1: ModRM:reg (w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x8b,
mod_rm: ModRM[mod: Mod00, reg: dst_reg, rm: src_reg],
)
# MOV r64, r/m64 (Mod 01: [reg]+disp8)
in QwordPtr[R64 => src_reg, IMM8 => src_disp]
# REX.W + 8B /r
# RM: Operand 1: ModRM:reg (w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x8b,
mod_rm: ModRM[mod: Mod01, reg: dst_reg, rm: src_reg],
disp: src_disp,
)
# MOV r64, r/m64 (Mod 10: [reg]+disp32)
in QwordPtr[R64 => src_reg, IMM32 => src_disp]
# REX.W + 8B /r
# RM: Operand 1: ModRM:reg (w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x8b,
mod_rm: ModRM[mod: Mod10, reg: dst_reg, rm: src_reg],
disp: imm32(src_disp),
)
# MOV r64, r/m64 (Mod 11: reg)
in R64 => src_reg
# REX.W + 8B /r
# RM: Operand 1: ModRM:reg (w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x8b,
mod_rm: ModRM[mod: Mod11, reg: dst_reg, rm: src_reg],
)
# MOV r/m64, imm32 (Mod 11: reg)
in IMM32 => src_imm
# REX.W + C7 /0 id
# MI: Operand 1: ModRM:r/m (w), Operand 2: imm8/16/32/64
insn(
prefix: REX_W,
opcode: 0xc7,
mod_rm: ModRM[mod: Mod11, reg: 0, rm: dst_reg],
imm: imm32(src_imm),
)
# MOV r64, imm64
in IMM64 => src_imm
# REX.W + B8+ rd io
# OI: Operand 1: opcode + rd (w), Operand 2: imm8/16/32/64
insn(
prefix: REX_W,
opcode: 0xb8,
rd: dst_reg,
imm: imm64(src_imm),
)
end
in DwordPtr[R64 => dst_reg, IMM8 => dst_disp]
case src
# MOV r/m32, imm32 (Mod 01: [reg]+disp8)
in IMM32 => src_imm
# C7 /0 id
# MI: Operand 1: ModRM:r/m (w), Operand 2: imm8/16/32/64
insn(
opcode: 0xc7,
mod_rm: ModRM[mod: Mod01, reg: 0, rm: dst_reg],
disp: dst_disp,
imm: imm32(src_imm),
)
end
in QwordPtr[R64 => dst_reg]
case src
# MOV r/m64, imm32 (Mod 00: [reg])
in IMM32 => src_imm
# REX.W + C7 /0 id
# MI: Operand 1: ModRM:r/m (w), Operand 2: imm8/16/32/64
insn(
prefix: REX_W,
opcode: 0xc7,
mod_rm: ModRM[mod: Mod00, reg: 0, rm: dst_reg],
imm: imm32(src_imm),
)
# MOV r/m64, r64 (Mod 00: [reg])
in R64 => src_reg
# REX.W + 89 /r
# MR: Operand 1: ModRM:r/m (w), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x89,
mod_rm: ModRM[mod: Mod00, reg: src_reg, rm: dst_reg],
)
end
in QwordPtr[R64 => dst_reg, IMM8 => dst_disp]
# Optimize encoding when disp is 0
return mov([dst_reg], src) if dst_disp == 0
case src
# MOV r/m64, imm32 (Mod 01: [reg]+disp8)
in IMM32 => src_imm
# REX.W + C7 /0 id
# MI: Operand 1: ModRM:r/m (w), Operand 2: imm8/16/32/64
insn(
prefix: REX_W,
opcode: 0xc7,
mod_rm: ModRM[mod: Mod01, reg: 0, rm: dst_reg],
disp: dst_disp,
imm: imm32(src_imm),
)
# MOV r/m64, r64 (Mod 01: [reg]+disp8)
in R64 => src_reg
# REX.W + 89 /r
# MR: Operand 1: ModRM:r/m (w), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x89,
mod_rm: ModRM[mod: Mod01, reg: src_reg, rm: dst_reg],
disp: dst_disp,
)
end
in QwordPtr[R64 => dst_reg, IMM32 => dst_disp]
case src
# MOV r/m64, imm32 (Mod 10: [reg]+disp32)
in IMM32 => src_imm
# REX.W + C7 /0 id
# MI: Operand 1: ModRM:r/m (w), Operand 2: imm8/16/32/64
insn(
prefix: REX_W,
opcode: 0xc7,
mod_rm: ModRM[mod: Mod10, reg: 0, rm: dst_reg],
disp: imm32(dst_disp),
imm: imm32(src_imm),
)
# MOV r/m64, r64 (Mod 10: [reg]+disp32)
in R64 => src_reg
# REX.W + 89 /r
# MR: Operand 1: ModRM:r/m (w), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x89,
mod_rm: ModRM[mod: Mod10, reg: src_reg, rm: dst_reg],
disp: imm32(dst_disp),
)
end
end
end
def or(dst, src)
case [dst, src]
# OR r/m64, imm8 (Mod 11: reg)
in [R64 => dst_reg, IMM8 => src_imm]
# REX.W + 83 /1 ib
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod11, reg: 1, rm: dst_reg],
imm: imm8(src_imm),
)
# OR r/m64, imm32 (Mod 11: reg)
in [R64 => dst_reg, IMM32 => src_imm]
# REX.W + 81 /1 id
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x81,
mod_rm: ModRM[mod: Mod11, reg: 1, rm: dst_reg],
imm: imm32(src_imm),
)
# OR r64, r/m64 (Mod 01: [reg]+disp8)
in [R64 => dst_reg, QwordPtr[R64 => src_reg, IMM8 => src_disp]]
# REX.W + 0B /r
# RM: Operand 1: ModRM:reg (r, w), Operand 2: ModRM:r/m (r)
insn(
prefix: REX_W,
opcode: 0x0b,
mod_rm: ModRM[mod: Mod01, reg: dst_reg, rm: src_reg],
disp: imm8(src_disp),
)
end
end
def push(src)
case src
# PUSH r64
in R64 => src_reg
# 50+rd
# O: Operand 1: opcode + rd (r)
insn(opcode: 0x50, rd: src_reg)
end
end
def pop(dst)
case dst
# POP r64
in R64 => dst_reg
# 58+ rd
# O: Operand 1: opcode + rd (r)
insn(opcode: 0x58, rd: dst_reg)
end
end
def ret
# RET
# Near return: A return to a procedure within the current code segment
insn(opcode: 0xc3)
end
def sar(dst, src)
case [dst, src]
in [R64 => dst_reg, IMM8 => src_imm]
# REX.W + C1 /7 ib
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8
insn(
prefix: REX_W,
opcode: 0xc1,
mod_rm: ModRM[mod: Mod11, reg: 7, rm: dst_reg],
imm: imm8(src_imm),
)
end
end
def sub(dst, src)
case [dst, src]
# SUB r/m64, imm8 (Mod 11: reg)
in [R64 => dst_reg, IMM8 => src_imm]
# REX.W + 83 /5 ib
# MI: Operand 1: ModRM:r/m (r, w), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0x83,
mod_rm: ModRM[mod: Mod11, reg: 5, rm: dst_reg],
imm: imm8(src_imm),
)
# SUB r/m64, r64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 29 /r
# MR: Operand 1: ModRM:r/m (r, w), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x29,
mod_rm: ModRM[mod: Mod11, reg: src_reg, rm: dst_reg],
)
end
end
def test(left, right)
case [left, right]
# TEST r/m8*, imm8 (Mod 01: [reg]+disp8)
in [BytePtr[R64 => left_reg, IMM8 => left_disp], IMM8 => right_imm]
# REX + F6 /0 ib
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
opcode: 0xf6,
mod_rm: ModRM[mod: Mod01, reg: 0, rm: left_reg],
disp: left_disp,
imm: imm8(right_imm),
)
# TEST r/m64, imm32 (Mod 01: [reg]+disp8)
in [QwordPtr[R64 => left_reg, IMM8 => left_disp], IMM32 => right_imm]
# REX.W + F7 /0 id
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0xf7,
mod_rm: ModRM[mod: Mod01, reg: 0, rm: left_reg],
disp: left_disp,
imm: imm32(right_imm),
)
# TEST r/m64, imm32 (Mod 10: [reg]+disp32)
in [QwordPtr[R64 => left_reg, IMM32 => left_disp], IMM32 => right_imm]
# REX.W + F7 /0 id
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0xf7,
mod_rm: ModRM[mod: Mod10, reg: 0, rm: left_reg],
disp: imm32(left_disp),
imm: imm32(right_imm),
)
# TEST r/m64, imm32 (Mod 11: reg)
in [R64 => left_reg, IMM32 => right_imm]
# REX.W + F7 /0 id
# MI: Operand 1: ModRM:r/m (r), Operand 2: imm8/16/32
insn(
prefix: REX_W,
opcode: 0xf7,
mod_rm: ModRM[mod: Mod11, reg: 0, rm: left_reg],
imm: imm32(right_imm),
)
# TEST r/m32, r32 (Mod 11: reg)
in [R32 => left_reg, R32 => right_reg]
# 85 /r
# MR: Operand 1: ModRM:r/m (r), Operand 2: ModRM:reg (r)
insn(
opcode: 0x85,
mod_rm: ModRM[mod: Mod11, reg: right_reg, rm: left_reg],
)
# TEST r/m64, r64 (Mod 11: reg)
in [R64 => left_reg, R64 => right_reg]
# REX.W + 85 /r
# MR: Operand 1: ModRM:r/m (r), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x85,
mod_rm: ModRM[mod: Mod11, reg: right_reg, rm: left_reg],
)
end
end
def xor(dst, src)
case [dst, src]
# XOR r/m64, r64 (Mod 11: reg)
in [R64 => dst_reg, R64 => src_reg]
# REX.W + 31 /r
# MR: Operand 1: ModRM:r/m (r, w), Operand 2: ModRM:reg (r)
insn(
prefix: REX_W,
opcode: 0x31,
mod_rm: ModRM[mod: Mod11, reg: src_reg, rm: dst_reg],
)
end
end
#
# Utilities
#
attr_reader :comments
def comment(message)
@comments[@bytes.size] << message
end
# Mark the starting address of a block
def block(block)
@blocks[@bytes.size] << block
end
# Mark the starting/ending addresses of a stub
def stub(stub)
@stub_starts[@bytes.size] << stub
yield
ensure
@stub_ends[@bytes.size] << stub
end
def pos_marker(&block)
@pos_markers[@bytes.size] << block
end
def new_label(name)
Label.new(id: @label_id += 1, name:)
end
# @param [RubyVM::RJIT::Assembler::Label] label
def write_label(label)
@labels[label] = @bytes.size
end
def incr_counter(name)
if C.rjit_opts.stats
comment("increment counter #{name}")
mov(:rax, C.rb_rjit_counters[name].to_i)
add([:rax], 1) # TODO: lock
end
end
private
def insn(prefix: 0, opcode:, rd: nil, mod_rm: nil, disp: nil, imm: nil)
# Determine prefix
if rd
prefix |= REX_B if extended_reg?(rd)
opcode += reg_code(rd)
end
if mod_rm
prefix |= REX_R if mod_rm.reg.is_a?(Symbol) && extended_reg?(mod_rm.reg)
prefix |= REX_B if mod_rm.rm.is_a?(Symbol) && extended_reg?(mod_rm.rm)
end
# Encode insn
if prefix > 0
@bytes.push(prefix)
end
@bytes.push(*Array(opcode))
if mod_rm
mod_rm_byte = encode_mod_rm(
mod: mod_rm.mod,
reg: mod_rm.reg.is_a?(Symbol) ? reg_code(mod_rm.reg) : mod_rm.reg,
rm: mod_rm.rm.is_a?(Symbol) ? reg_code(mod_rm.rm) : mod_rm.rm,
)
@bytes.push(mod_rm_byte)
end
if disp
@bytes.push(*Array(disp))
end
if imm
@bytes.push(*imm)
end
end
def reg_code(reg)
reg_code_extended(reg).first
end
# Table 2-2. 32-Bit Addressing Forms with the ModR/M Byte
#
# 7 6 5 4 3 2 1 0
# +--+--+--+--+--+--+--+--+
# | Mod | Reg/ | R/M |
# | | Opcode | |
# +--+--+--+--+--+--+--+--+
#
# The r/m field can specify a register as an operand or it can be combined
# with the mod field to encode an addressing mode.
#
# /0: R/M is 0 (not used)
# /r: R/M is a register
def encode_mod_rm(mod:, reg: 0, rm: 0)
if mod > 0b11
raise ArgumentError, "too large Mod: #{mod}"
end
if reg > 0b111
raise ArgumentError, "too large Reg/Opcode: #{reg}"
end
if rm > 0b111
raise ArgumentError, "too large R/M: #{rm}"
end
(mod << 6) + (reg << 3) + rm
end
# ib: 1 byte
def imm8(imm)
unless imm8?(imm)
raise ArgumentError, "unexpected imm8: #{imm}"
end
[imm].pack('c').unpack('c*') # TODO: consider uimm
end
# id: 4 bytes
def imm32(imm)
unless imm32?(imm)
raise ArgumentError, "unexpected imm32: #{imm}"
end
[imm].pack('l').unpack('c*') # TODO: consider uimm
end
# io: 8 bytes
def imm64(imm)
unless imm64?(imm)
raise ArgumentError, "unexpected imm64: #{imm}"
end
imm_bytes(imm, 8)
end
def imm_bytes(imm, num_bytes)
bytes = []
bits = imm
num_bytes.times do
bytes << (bits & 0xff)
bits >>= 8
end
if bits != 0
raise ArgumentError, "unexpected imm with #{num_bytes} bytes: #{imm}"
end
bytes
end
def rel32(addr)
[Rel32.new(addr), Rel32Pad, Rel32Pad, Rel32Pad]
end
def set_code_addrs(write_addr)
(@bytes.size + 1).times do |index|
@blocks.fetch(index, []).each do |block|
block.start_addr = write_addr + index
end
@stub_starts.fetch(index, []).each do |stub|
stub.start_addr = write_addr + index
end
@stub_ends.fetch(index, []).each do |stub|
stub.end_addr = write_addr + index
end
end
end
def resolve_rel32(write_addr)
@bytes.each_with_index do |byte, index|
if byte.is_a?(Rel32)
src_addr = write_addr + index + 4 # offset 4 bytes for rel32 itself
dst_addr = byte.addr
rel32 = dst_addr - src_addr
raise "unexpected offset: #{rel32}" unless imm32?(rel32)
imm32(rel32).each_with_index do |rel_byte, rel_index|
@bytes[index + rel_index] = rel_byte
end
end
end
end
def resolve_labels
@bytes.each_with_index do |byte, index|
if byte.is_a?(Label)
src_index = index + 1 # offset 1 byte for rel8 itself
dst_index = @labels.fetch(byte)
rel8 = dst_index - src_index
raise "unexpected offset: #{rel8}" unless imm8?(rel8)
@bytes[index] = rel8
end
end
end
def write_bytes(addr)
Fiddle::Pointer.new(addr)[0, @bytes.size] = @bytes.pack('c*')
end
end
module OperandMatcher
def imm8?(imm)
(-0x80..0x7f).include?(imm)
end
def imm32?(imm)
(-0x8000_0000..0x7fff_ffff).include?(imm) # TODO: consider uimm
end
def imm64?(imm)
(-0x8000_0000_0000_0000..0xffff_ffff_ffff_ffff).include?(imm)
end
def r32?(reg)
if extended_reg?(reg)
reg.end_with?('d')
else
reg.start_with?('e')
end
end
def r64?(reg)
if extended_reg?(reg)
reg.match?(/\Ar\d+\z/)
else
reg.start_with?('r')
end
end
def extended_reg?(reg)
reg_code_extended(reg).last
end
def reg_code_extended(reg)
case reg
# Not extended
when :al, :ax, :eax, :rax then [0, false]
when :cl, :cx, :ecx, :rcx then [1, false]
when :dl, :dx, :edx, :rdx then [2, false]
when :bl, :bx, :ebx, :rbx then [3, false]
when :ah, :sp, :esp, :rsp then [4, false]
when :ch, :bp, :ebp, :rbp then [5, false]
when :dh, :si, :esi, :rsi then [6, false]
when :bh, :di, :edi, :rdi then [7, false]
# Extended
when :r8b, :r8w, :r8d, :r8 then [0, true]
when :r9b, :r9w, :r9d, :r9 then [1, true]
when :r10b, :r10w, :r10d, :r10 then [2, true]
when :r11b, :r11w, :r11d, :r11 then [3, true]
when :r12b, :r12w, :r12d, :r12 then [4, true]
when :r13b, :r13w, :r13d, :r13 then [5, true]
when :r14b, :r14w, :r14d, :r14 then [6, true]
when :r15b, :r15w, :r15d, :r15 then [7, true]
else raise ArgumentError, "unexpected reg: #{reg.inspect}"
end
end
end
class Assembler
include OperandMatcher
extend OperandMatcher
end
end
share/ruby/pathname.rb 0000644 00000041547 15173517737 0011004 0 ustar 00 # frozen_string_literal: true
#
# = pathname.rb
#
# Object-Oriented Pathname Class
#
# Author:: Tanaka Akira <akr@m17n.org>
# Documentation:: Author and Gavin Sinclair
#
# For documentation, see class Pathname.
#
require 'pathname.so'
class Pathname
VERSION = "0.3.0"
# :stopdoc:
# to_path is implemented so Pathname objects are usable with File.open, etc.
TO_PATH = :to_path
SAME_PATHS = if File::FNM_SYSCASE.nonzero?
# Avoid #zero? here because #casecmp can return nil.
proc {|a, b| a.casecmp(b) == 0}
else
proc {|a, b| a == b}
end
if File::ALT_SEPARATOR
SEPARATOR_LIST = "#{Regexp.quote File::ALT_SEPARATOR}#{Regexp.quote File::SEPARATOR}"
SEPARATOR_PAT = /[#{SEPARATOR_LIST}]/
else
SEPARATOR_LIST = "#{Regexp.quote File::SEPARATOR}"
SEPARATOR_PAT = /#{Regexp.quote File::SEPARATOR}/
end
if File.dirname('A:') == 'A:.' # DOSish drive letter
ABSOLUTE_PATH = /\A(?:[A-Za-z]:|#{SEPARATOR_PAT})/o
else
ABSOLUTE_PATH = /\A#{SEPARATOR_PAT}/o
end
private_constant :ABSOLUTE_PATH
# :startdoc:
# chop_basename(path) -> [pre-basename, basename] or nil
def chop_basename(path) # :nodoc:
base = File.basename(path)
if /\A#{SEPARATOR_PAT}?\z/o.match?(base)
return nil
else
return path[0, path.rindex(base)], base
end
end
private :chop_basename
# split_names(path) -> prefix, [name, ...]
def split_names(path) # :nodoc:
names = []
while r = chop_basename(path)
path, basename = r
names.unshift basename
end
return path, names
end
private :split_names
def prepend_prefix(prefix, relpath) # :nodoc:
if relpath.empty?
File.dirname(prefix)
elsif /#{SEPARATOR_PAT}/o.match?(prefix)
prefix = File.dirname(prefix)
prefix = File.join(prefix, "") if File.basename(prefix + 'a') != 'a'
prefix + relpath
else
prefix + relpath
end
end
private :prepend_prefix
# Returns clean pathname of +self+ with consecutive slashes and useless dots
# removed. The filesystem is not accessed.
#
# If +consider_symlink+ is +true+, then a more conservative algorithm is used
# to avoid breaking symbolic linkages. This may retain more +..+
# entries than absolutely necessary, but without accessing the filesystem,
# this can't be avoided.
#
# See Pathname#realpath.
#
def cleanpath(consider_symlink=false)
if consider_symlink
cleanpath_conservative
else
cleanpath_aggressive
end
end
#
# Clean the path simply by resolving and removing excess +.+ and +..+ entries.
# Nothing more, nothing less.
#
def cleanpath_aggressive # :nodoc:
path = @path
names = []
pre = path
while r = chop_basename(pre)
pre, base = r
case base
when '.'
when '..'
names.unshift base
else
if names[0] == '..'
names.shift
else
names.unshift base
end
end
end
pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
if /#{SEPARATOR_PAT}/o.match?(File.basename(pre))
names.shift while names[0] == '..'
end
self.class.new(prepend_prefix(pre, File.join(*names)))
end
private :cleanpath_aggressive
# has_trailing_separator?(path) -> bool
def has_trailing_separator?(path) # :nodoc:
if r = chop_basename(path)
pre, basename = r
pre.length + basename.length < path.length
else
false
end
end
private :has_trailing_separator?
# add_trailing_separator(path) -> path
def add_trailing_separator(path) # :nodoc:
if File.basename(path + 'a') == 'a'
path
else
File.join(path, "") # xxx: Is File.join is appropriate to add separator?
end
end
private :add_trailing_separator
def del_trailing_separator(path) # :nodoc:
if r = chop_basename(path)
pre, basename = r
pre + basename
elsif /#{SEPARATOR_PAT}+\z/o =~ path
$` + File.dirname(path)[/#{SEPARATOR_PAT}*\z/o]
else
path
end
end
private :del_trailing_separator
def cleanpath_conservative # :nodoc:
path = @path
names = []
pre = path
while r = chop_basename(pre)
pre, base = r
names.unshift base if base != '.'
end
pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
if /#{SEPARATOR_PAT}/o.match?(File.basename(pre))
names.shift while names[0] == '..'
end
if names.empty?
self.class.new(File.dirname(pre))
else
if names.last != '..' && File.basename(path) == '.'
names << '.'
end
result = prepend_prefix(pre, File.join(*names))
if /\A(?:\.|\.\.)\z/ !~ names.last && has_trailing_separator?(path)
self.class.new(add_trailing_separator(result))
else
self.class.new(result)
end
end
end
private :cleanpath_conservative
# Returns the parent directory.
#
# This is same as <code>self + '..'</code>.
def parent
self + '..'
end
# Returns +true+ if +self+ points to a mountpoint.
def mountpoint?
begin
stat1 = self.lstat
stat2 = self.parent.lstat
stat1.dev != stat2.dev || stat1.ino == stat2.ino
rescue Errno::ENOENT
false
end
end
#
# Predicate method for root directories. Returns +true+ if the
# pathname consists of consecutive slashes.
#
# It doesn't access the filesystem. So it may return +false+ for some
# pathnames which points to roots such as <tt>/usr/..</tt>.
#
def root?
chop_basename(@path) == nil && /#{SEPARATOR_PAT}/o.match?(@path)
end
# Predicate method for testing whether a path is absolute.
#
# It returns +true+ if the pathname begins with a slash.
#
# p = Pathname.new('/im/sure')
# p.absolute?
# #=> true
#
# p = Pathname.new('not/so/sure')
# p.absolute?
# #=> false
def absolute?
ABSOLUTE_PATH.match? @path
end
# The opposite of Pathname#absolute?
#
# It returns +false+ if the pathname begins with a slash.
#
# p = Pathname.new('/im/sure')
# p.relative?
# #=> false
#
# p = Pathname.new('not/so/sure')
# p.relative?
# #=> true
def relative?
!absolute?
end
#
# Iterates over each component of the path.
#
# Pathname.new("/usr/bin/ruby").each_filename {|filename| ... }
# # yields "usr", "bin", and "ruby".
#
# Returns an Enumerator if no block was given.
#
# enum = Pathname.new("/usr/bin/ruby").each_filename
# # ... do stuff ...
# enum.each { |e| ... }
# # yields "usr", "bin", and "ruby".
#
def each_filename # :yield: filename
return to_enum(__method__) unless block_given?
_, names = split_names(@path)
names.each {|filename| yield filename }
nil
end
# Iterates over and yields a new Pathname object
# for each element in the given path in descending order.
#
# Pathname.new('/path/to/some/file.rb').descend {|v| p v}
# #<Pathname:/>
# #<Pathname:/path>
# #<Pathname:/path/to>
# #<Pathname:/path/to/some>
# #<Pathname:/path/to/some/file.rb>
#
# Pathname.new('path/to/some/file.rb').descend {|v| p v}
# #<Pathname:path>
# #<Pathname:path/to>
# #<Pathname:path/to/some>
# #<Pathname:path/to/some/file.rb>
#
# Returns an Enumerator if no block was given.
#
# enum = Pathname.new("/usr/bin/ruby").descend
# # ... do stuff ...
# enum.each { |e| ... }
# # yields Pathnames /, /usr, /usr/bin, and /usr/bin/ruby.
#
# It doesn't access the filesystem.
#
def descend
return to_enum(__method__) unless block_given?
vs = []
ascend {|v| vs << v }
vs.reverse_each {|v| yield v }
nil
end
# Iterates over and yields a new Pathname object
# for each element in the given path in ascending order.
#
# Pathname.new('/path/to/some/file.rb').ascend {|v| p v}
# #<Pathname:/path/to/some/file.rb>
# #<Pathname:/path/to/some>
# #<Pathname:/path/to>
# #<Pathname:/path>
# #<Pathname:/>
#
# Pathname.new('path/to/some/file.rb').ascend {|v| p v}
# #<Pathname:path/to/some/file.rb>
# #<Pathname:path/to/some>
# #<Pathname:path/to>
# #<Pathname:path>
#
# Returns an Enumerator if no block was given.
#
# enum = Pathname.new("/usr/bin/ruby").ascend
# # ... do stuff ...
# enum.each { |e| ... }
# # yields Pathnames /usr/bin/ruby, /usr/bin, /usr, and /.
#
# It doesn't access the filesystem.
#
def ascend
return to_enum(__method__) unless block_given?
path = @path
yield self
while r = chop_basename(path)
path, = r
break if path.empty?
yield self.class.new(del_trailing_separator(path))
end
end
#
# Appends a pathname fragment to +self+ to produce a new Pathname object.
# Since +other+ is considered as a path relative to +self+, if +other+ is
# an absolute path, the new Pathname object is created from just +other+.
#
# p1 = Pathname.new("/usr") # Pathname:/usr
# p2 = p1 + "bin/ruby" # Pathname:/usr/bin/ruby
# p3 = p1 + "/etc/passwd" # Pathname:/etc/passwd
#
# # / is aliased to +.
# p4 = p1 / "bin/ruby" # Pathname:/usr/bin/ruby
# p5 = p1 / "/etc/passwd" # Pathname:/etc/passwd
#
# This method doesn't access the file system; it is pure string manipulation.
#
def +(other)
other = Pathname.new(other) unless Pathname === other
Pathname.new(plus(@path, other.to_s))
end
alias / +
def plus(path1, path2) # -> path # :nodoc:
prefix2 = path2
index_list2 = []
basename_list2 = []
while r2 = chop_basename(prefix2)
prefix2, basename2 = r2
index_list2.unshift prefix2.length
basename_list2.unshift basename2
end
return path2 if prefix2 != ''
prefix1 = path1
while true
while !basename_list2.empty? && basename_list2.first == '.'
index_list2.shift
basename_list2.shift
end
break unless r1 = chop_basename(prefix1)
prefix1, basename1 = r1
next if basename1 == '.'
if basename1 == '..' || basename_list2.empty? || basename_list2.first != '..'
prefix1 = prefix1 + basename1
break
end
index_list2.shift
basename_list2.shift
end
r1 = chop_basename(prefix1)
if !r1 && (r1 = /#{SEPARATOR_PAT}/o.match?(File.basename(prefix1)))
while !basename_list2.empty? && basename_list2.first == '..'
index_list2.shift
basename_list2.shift
end
end
if !basename_list2.empty?
suffix2 = path2[index_list2.first..-1]
r1 ? File.join(prefix1, suffix2) : prefix1 + suffix2
else
r1 ? prefix1 : File.dirname(prefix1)
end
end
private :plus
#
# Joins the given pathnames onto +self+ to create a new Pathname object.
# This is effectively the same as using Pathname#+ to append +self+ and
# all arguments sequentially.
#
# path0 = Pathname.new("/usr") # Pathname:/usr
# path0 = path0.join("bin/ruby") # Pathname:/usr/bin/ruby
# # is the same as
# path1 = Pathname.new("/usr") + "bin/ruby" # Pathname:/usr/bin/ruby
# path0 == path1
# #=> true
#
def join(*args)
return self if args.empty?
result = args.pop
result = Pathname.new(result) unless Pathname === result
return result if result.absolute?
args.reverse_each {|arg|
arg = Pathname.new(arg) unless Pathname === arg
result = arg + result
return result if result.absolute?
}
self + result
end
#
# Returns the children of the directory (files and subdirectories, not
# recursive) as an array of Pathname objects.
#
# By default, the returned pathnames will have enough information to access
# the files. If you set +with_directory+ to +false+, then the returned
# pathnames will contain the filename only.
#
# For example:
# pn = Pathname("/usr/lib/ruby/1.8")
# pn.children
# # -> [ Pathname:/usr/lib/ruby/1.8/English.rb,
# Pathname:/usr/lib/ruby/1.8/Env.rb,
# Pathname:/usr/lib/ruby/1.8/abbrev.rb, ... ]
# pn.children(false)
# # -> [ Pathname:English.rb, Pathname:Env.rb, Pathname:abbrev.rb, ... ]
#
# Note that the results never contain the entries +.+ and +..+ in
# the directory because they are not children.
#
def children(with_directory=true)
with_directory = false if @path == '.'
result = []
Dir.foreach(@path) {|e|
next if e == '.' || e == '..'
if with_directory
result << self.class.new(File.join(@path, e))
else
result << self.class.new(e)
end
}
result
end
# Iterates over the children of the directory
# (files and subdirectories, not recursive).
#
# It yields Pathname object for each child.
#
# By default, the yielded pathnames will have enough information to access
# the files.
#
# If you set +with_directory+ to +false+, then the returned pathnames will
# contain the filename only.
#
# Pathname("/usr/local").each_child {|f| p f }
# #=> #<Pathname:/usr/local/share>
# # #<Pathname:/usr/local/bin>
# # #<Pathname:/usr/local/games>
# # #<Pathname:/usr/local/lib>
# # #<Pathname:/usr/local/include>
# # #<Pathname:/usr/local/sbin>
# # #<Pathname:/usr/local/src>
# # #<Pathname:/usr/local/man>
#
# Pathname("/usr/local").each_child(false) {|f| p f }
# #=> #<Pathname:share>
# # #<Pathname:bin>
# # #<Pathname:games>
# # #<Pathname:lib>
# # #<Pathname:include>
# # #<Pathname:sbin>
# # #<Pathname:src>
# # #<Pathname:man>
#
# Note that the results never contain the entries +.+ and +..+ in
# the directory because they are not children.
#
# See Pathname#children
#
def each_child(with_directory=true, &b)
children(with_directory).each(&b)
end
#
# Returns a relative path from the given +base_directory+ to the receiver.
#
# If +self+ is absolute, then +base_directory+ must be absolute too.
#
# If +self+ is relative, then +base_directory+ must be relative too.
#
# This method doesn't access the filesystem. It assumes no symlinks.
#
# ArgumentError is raised when it cannot find a relative path.
#
# Note that this method does not handle situations where the case sensitivity
# of the filesystem in use differs from the operating system default.
#
def relative_path_from(base_directory)
base_directory = Pathname.new(base_directory) unless base_directory.is_a? Pathname
dest_directory = self.cleanpath.to_s
base_directory = base_directory.cleanpath.to_s
dest_prefix = dest_directory
dest_names = []
while r = chop_basename(dest_prefix)
dest_prefix, basename = r
dest_names.unshift basename if basename != '.'
end
base_prefix = base_directory
base_names = []
while r = chop_basename(base_prefix)
base_prefix, basename = r
base_names.unshift basename if basename != '.'
end
unless SAME_PATHS[dest_prefix, base_prefix]
raise ArgumentError, "different prefix: #{dest_prefix.inspect} and #{base_directory.inspect}"
end
while !dest_names.empty? &&
!base_names.empty? &&
SAME_PATHS[dest_names.first, base_names.first]
dest_names.shift
base_names.shift
end
if base_names.include? '..'
raise ArgumentError, "base_directory has ..: #{base_directory.inspect}"
end
base_names.fill('..')
relpath_names = base_names + dest_names
if relpath_names.empty?
Pathname.new('.')
else
Pathname.new(File.join(*relpath_names))
end
end
end
class Pathname # * Find *
#
# Iterates over the directory tree in a depth first manner, yielding a
# Pathname for each file under "this" directory.
#
# Returns an Enumerator if no block is given.
#
# Since it is implemented by the standard library module Find, Find.prune can
# be used to control the traversal.
#
# If +self+ is +.+, yielded pathnames begin with a filename in the
# current directory, not +./+.
#
# See Find.find
#
def find(ignore_error: true) # :yield: pathname
return to_enum(__method__, ignore_error: ignore_error) unless block_given?
require 'find'
if @path == '.'
Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f.sub(%r{\A\./}, '')) }
else
Find.find(@path, ignore_error: ignore_error) {|f| yield self.class.new(f) }
end
end
end
autoload(:FileUtils, 'fileutils')
class Pathname # * FileUtils *
# Creates a full path, including any intermediate directories that don't yet
# exist.
#
# See FileUtils.mkpath and FileUtils.mkdir_p
def mkpath(mode: nil)
FileUtils.mkpath(@path, mode: mode)
nil
end
# Recursively deletes a directory, including all directories beneath it.
#
# See FileUtils.rm_rf
def rmtree(noop: nil, verbose: nil, secure: nil)
# The name "rmtree" is borrowed from File::Path of Perl.
# File::Path provides "mkpath" and "rmtree".
require 'fileutils'
FileUtils.rm_rf(@path, noop: noop, verbose: verbose, secure: secure)
nil
end
end
share/ruby/expect.rb 0000644 00000004304 15173517737 0010465 0 ustar 00 # frozen_string_literal: true
$expect_verbose = false
class IO
# call-seq:
# IO#expect(pattern,timeout=9999999) -> Array
# IO#expect(pattern,timeout=9999999) { |result| ... } -> nil
#
# The +expect+ library adds instance method IO#expect,
# which is similar to the
# {TCL expect extension}[https://www.tcl.tk/man/expect5.31/expect.1.html].
#
# To use this method, you must require +expect+:
#
# require 'expect'
#
# Reads from the IO until the given +pattern+ matches or the +timeout+ is over.
#
# It returns an array with the read buffer, followed by the matches.
# If a block is given, the result is yielded to the block and returns nil.
#
# When called without a block, it waits until the input that matches the
# given +pattern+ is obtained from the IO or the time specified as the
# timeout passes. An array is returned when the pattern is obtained from the
# IO. The first element of the array is the entire string obtained from the
# IO until the pattern matches, followed by elements indicating which the
# pattern which matched to the anchor in the regular expression.
#
# The optional timeout parameter defines, in seconds, the total time to wait
# for the pattern. If the timeout expires or eof is found, nil is returned
# or yielded. However, the buffer in a timeout session is kept for the next
# expect call. The default timeout is 9999999 seconds.
def expect(pat,timeout=9999999)
buf = ''.dup
case pat
when String
e_pat = Regexp.new(Regexp.quote(pat))
when Regexp
e_pat = pat
else
raise TypeError, "unsupported pattern class: #{pat.class}"
end
@unusedBuf ||= ''
while true
if not @unusedBuf.empty?
c = @unusedBuf.slice!(0)
elsif !IO.select([self],nil,nil,timeout) or eof? then
result = nil
@unusedBuf = buf
break
else
c = getc
end
buf << c
if $expect_verbose
STDOUT.print c
STDOUT.flush
end
if mat=e_pat.match(buf) then
result = [buf,*mat.captures]
break
end
end
if block_given? then
yield result
else
return result
end
nil
end
end
share/ruby/error_highlight/version.rb 0000644 00000000056 15173517737 0014042 0 ustar 00 module ErrorHighlight
VERSION = "0.6.0"
end
share/ruby/error_highlight/core_ext.rb 0000644 00000002610 15173517737 0014163 0 ustar 00 require_relative "formatter"
module ErrorHighlight
module CoreExt
private def generate_snippet
spot = ErrorHighlight.spot(self)
return "" unless spot
return ErrorHighlight.formatter.message_for(spot)
end
if Exception.method_defined?(:detailed_message)
def detailed_message(highlight: false, error_highlight: true, **)
return super unless error_highlight
snippet = generate_snippet
if highlight
snippet = snippet.gsub(/.+/) { "\e[1m" + $& + "\e[m" }
end
super + snippet
end
else
# This is a marker to let `DidYouMean::Correctable#original_message` skip
# the following method definition of `to_s`.
# See https://github.com/ruby/did_you_mean/pull/152
SKIP_TO_S_FOR_SUPER_LOOKUP = true
private_constant :SKIP_TO_S_FOR_SUPER_LOOKUP
def to_s
msg = super
snippet = generate_snippet
if snippet != "" && !msg.include?(snippet)
msg + snippet
else
msg
end
end
end
end
NameError.prepend(CoreExt)
if Exception.method_defined?(:detailed_message)
# ErrorHighlight is enabled for TypeError and ArgumentError only when Exception#detailed_message is available.
# This is because changing ArgumentError#message is highly incompatible.
TypeError.prepend(CoreExt)
ArgumentError.prepend(CoreExt)
end
end
share/ruby/error_highlight/formatter.rb 0000644 00000001176 15173517740 0014356 0 ustar 00 module ErrorHighlight
class DefaultFormatter
def self.message_for(spot)
# currently only a one-line code snippet is supported
if spot[:first_lineno] == spot[:last_lineno]
indent = spot[:snippet][0...spot[:first_column]].gsub(/[^\t]/, " ")
marker = indent + "^" * (spot[:last_column] - spot[:first_column])
"\n\n#{ spot[:snippet] }#{ marker }"
else
""
end
end
end
def self.formatter
Ractor.current[:__error_highlight_formatter__] || DefaultFormatter
end
def self.formatter=(formatter)
Ractor.current[:__error_highlight_formatter__] = formatter
end
end
share/ruby/error_highlight/base.rb 0000644 00000036116 15173517740 0013267 0 ustar 00 require_relative "version"
module ErrorHighlight
# Identify the code fragment at that a given exception occurred.
#
# Options:
#
# point_type: :name | :args
# :name (default) points the method/variable name that the exception occurred.
# :args points the arguments of the method call that the exception occurred.
#
# backtrace_location: Thread::Backtrace::Location
# It locates the code fragment of the given backtrace_location.
# By default, it uses the first frame of backtrace_locations of the given exception.
#
# Returns:
# {
# first_lineno: Integer,
# first_column: Integer,
# last_lineno: Integer,
# last_column: Integer,
# snippet: String,
# script_lines: [String],
# } | nil
#
# Limitations:
#
# Currently, ErrorHighlight.spot only supports a single-line code fragment.
# Therefore, if the return value is not nil, first_lineno and last_lineno will have
# the same value. If the relevant code fragment spans multiple lines
# (e.g., Array#[] of +ary[(newline)expr(newline)]+), the method will return nil.
# This restriction may be removed in the future.
def self.spot(obj, **opts)
case obj
when Exception
exc = obj
loc = opts[:backtrace_location]
opts = { point_type: opts.fetch(:point_type, :name) }
unless loc
case exc
when TypeError, ArgumentError
opts[:point_type] = :args
end
locs = exc.backtrace_locations
return nil unless locs
loc = locs.first
return nil unless loc
opts[:name] = exc.name if NameError === obj
end
return nil unless Thread::Backtrace::Location === loc
node = RubyVM::AbstractSyntaxTree.of(loc, keep_script_lines: true)
Spotter.new(node, **opts).spot
when RubyVM::AbstractSyntaxTree::Node
Spotter.new(obj, **opts).spot
else
raise TypeError, "Exception is expected"
end
rescue SyntaxError,
SystemCallError, # file not found or something
ArgumentError # eval'ed code
return nil
end
class Spotter
class NonAscii < Exception; end
private_constant :NonAscii
def initialize(node, point_type: :name, name: nil)
@node = node
@point_type = point_type
@name = name
# Not-implemented-yet options
@arg = nil # Specify the index or keyword at which argument caused the TypeError/ArgumentError
@multiline = false # Allow multiline spot
@fetch = -> (lineno, last_lineno = lineno) do
snippet = @node.script_lines[lineno - 1 .. last_lineno - 1].join("")
snippet += "\n" unless snippet.end_with?("\n")
# It require some work to support Unicode (or multibyte) characters.
# Tentatively, we stop highlighting if the code snippet has non-ascii characters.
# See https://github.com/ruby/error_highlight/issues/4
raise NonAscii unless snippet.ascii_only?
snippet
end
end
OPT_GETCONSTANT_PATH = (RUBY_VERSION.split(".").map {|s| s.to_i } <=> [3, 2]) >= 0
private_constant :OPT_GETCONSTANT_PATH
def spot
return nil unless @node
if OPT_GETCONSTANT_PATH && @node.type == :COLON2
# In Ruby 3.2 or later, a nested constant access (like `Foo::Bar::Baz`)
# is compiled to one instruction (opt_getconstant_path).
# @node points to the node of the whole `Foo::Bar::Baz` even if `Foo`
# or `Foo::Bar` causes NameError.
# So we try to spot the sub-node that causes the NameError by using
# `NameError#name`.
subnodes = []
node = @node
while node.type == :COLON2
node2, const = node.children
subnodes << node if const == @name
node = node2
end
if node.type == :CONST || node.type == :COLON3
if node.children.first == @name
subnodes << node
end
# If we found only one sub-node whose name is equal to @name, use it
return nil if subnodes.size != 1
@node = subnodes.first
else
# Do nothing; opt_getconstant_path is used only when the const base is
# NODE_CONST (`Foo`) or NODE_COLON3 (`::Foo`)
end
end
case @node.type
when :CALL, :QCALL
case @point_type
when :name
spot_call_for_name
when :args
spot_call_for_args
end
when :ATTRASGN
case @point_type
when :name
spot_attrasgn_for_name
when :args
spot_attrasgn_for_args
end
when :OPCALL
case @point_type
when :name
spot_opcall_for_name
when :args
spot_opcall_for_args
end
when :FCALL
case @point_type
when :name
spot_fcall_for_name
when :args
spot_fcall_for_args
end
when :VCALL
spot_vcall
when :OP_ASGN1
case @point_type
when :name
spot_op_asgn1_for_name
when :args
spot_op_asgn1_for_args
end
when :OP_ASGN2
case @point_type
when :name
spot_op_asgn2_for_name
when :args
spot_op_asgn2_for_args
end
when :CONST
spot_vcall
when :COLON2
spot_colon2
when :COLON3
spot_vcall
when :OP_CDECL
spot_op_cdecl
end
if @snippet && @beg_column && @end_column && @beg_column < @end_column
return {
first_lineno: @beg_lineno,
first_column: @beg_column,
last_lineno: @end_lineno,
last_column: @end_column,
snippet: @snippet,
script_lines: @node.script_lines,
}
else
return nil
end
rescue NonAscii
nil
end
private
# Example:
# x.foo
# ^^^^
# x.foo(42)
# ^^^^
# x&.foo
# ^^^^^
# x[42]
# ^^^^
# x += 1
# ^
def spot_call_for_name
nd_recv, mid, nd_args = @node.children
lineno = nd_recv.last_lineno
lines = @fetch[lineno, @node.last_lineno]
if mid == :[] && lines.match(/\G[\s)]*(\[(?:\s*\])?)/, nd_recv.last_column)
@beg_column = $~.begin(1)
@snippet = lines[/.*\n/]
@beg_lineno = @end_lineno = lineno
if nd_args
if nd_recv.last_lineno == nd_args.last_lineno && @snippet.match(/\s*\]/, nd_args.last_column)
@end_column = $~.end(0)
end
else
if lines.match(/\G[\s)]*?\[\s*\]/, nd_recv.last_column)
@end_column = $~.end(0)
end
end
elsif lines.match(/\G[\s)]*?(\&?\.)(\s*?)(#{ Regexp.quote(mid) }).*\n/, nd_recv.last_column)
lines = $` + $&
@beg_column = $~.begin($2.include?("\n") ? 3 : 1)
@end_column = $~.end(3)
if i = lines[..@beg_column].rindex("\n")
@beg_lineno = @end_lineno = lineno + lines[..@beg_column].count("\n")
@snippet = lines[i + 1..]
@beg_column -= i + 1
@end_column -= i + 1
else
@snippet = lines
@beg_lineno = @end_lineno = lineno
end
elsif mid.to_s =~ /\A\W+\z/ && lines.match(/\G\s*(#{ Regexp.quote(mid) })=.*\n/, nd_recv.last_column)
@snippet = $` + $&
@beg_column = $~.begin(1)
@end_column = $~.end(1)
end
end
# Example:
# x.foo(42)
# ^^
# x[42]
# ^^
# x += 1
# ^
def spot_call_for_args
_nd_recv, _mid, nd_args = @node.children
if nd_args && nd_args.first_lineno == nd_args.last_lineno
fetch_line(nd_args.first_lineno)
@beg_column = nd_args.first_column
@end_column = nd_args.last_column
end
# TODO: support @arg
end
# Example:
# x.foo = 1
# ^^^^^^
# x[42] = 1
# ^^^^^^
def spot_attrasgn_for_name
nd_recv, mid, nd_args = @node.children
*nd_args, _nd_last_arg, _nil = nd_args.children
fetch_line(nd_recv.last_lineno)
if mid == :[]= && @snippet.match(/\G[\s)]*(\[)/, nd_recv.last_column)
@beg_column = $~.begin(1)
args_last_column = $~.end(0)
if nd_args.last && nd_recv.last_lineno == nd_args.last.last_lineno
args_last_column = nd_args.last.last_column
end
if @snippet.match(/[\s)]*\]\s*=/, args_last_column)
@end_column = $~.end(0)
end
elsif @snippet.match(/\G[\s)]*(\.\s*#{ Regexp.quote(mid.to_s.sub(/=\z/, "")) }\s*=)/, nd_recv.last_column)
@beg_column = $~.begin(1)
@end_column = $~.end(1)
end
end
# Example:
# x.foo = 1
# ^
# x[42] = 1
# ^^^^^^^
# x[] = 1
# ^^^^^
def spot_attrasgn_for_args
nd_recv, mid, nd_args = @node.children
fetch_line(nd_recv.last_lineno)
if mid == :[]= && @snippet.match(/\G[\s)]*\[/, nd_recv.last_column)
@beg_column = $~.end(0)
if nd_recv.last_lineno == nd_args.last_lineno
@end_column = nd_args.last_column
end
elsif nd_args && nd_args.first_lineno == nd_args.last_lineno
@beg_column = nd_args.first_column
@end_column = nd_args.last_column
end
# TODO: support @arg
end
# Example:
# x + 1
# ^
# +x
# ^
def spot_opcall_for_name
nd_recv, op, nd_arg = @node.children
fetch_line(nd_recv.last_lineno)
if nd_arg
# binary operator
if @snippet.match(/\G[\s)]*(#{ Regexp.quote(op) })/, nd_recv.last_column)
@beg_column = $~.begin(1)
@end_column = $~.end(1)
end
else
# unary operator
if @snippet[...nd_recv.first_column].match(/(#{ Regexp.quote(op.to_s.sub(/@\z/, "")) })\s*\(?\s*\z/)
@beg_column = $~.begin(1)
@end_column = $~.end(1)
end
end
end
# Example:
# x + 1
# ^
def spot_opcall_for_args
_nd_recv, _op, nd_arg = @node.children
if nd_arg && nd_arg.first_lineno == nd_arg.last_lineno
# binary operator
fetch_line(nd_arg.first_lineno)
@beg_column = nd_arg.first_column
@end_column = nd_arg.last_column
end
end
# Example:
# foo(42)
# ^^^
# foo 42
# ^^^
def spot_fcall_for_name
mid, _nd_args = @node.children
fetch_line(@node.first_lineno)
if @snippet.match(/(#{ Regexp.quote(mid) })/, @node.first_column)
@beg_column = $~.begin(1)
@end_column = $~.end(1)
end
end
# Example:
# foo(42)
# ^^
# foo 42
# ^^
def spot_fcall_for_args
_mid, nd_args = @node.children
if nd_args && nd_args.first_lineno == nd_args.last_lineno
# binary operator
fetch_line(nd_args.first_lineno)
@beg_column = nd_args.first_column
@end_column = nd_args.last_column
end
end
# Example:
# foo
# ^^^
def spot_vcall
if @node.first_lineno == @node.last_lineno
fetch_line(@node.last_lineno)
@beg_column = @node.first_column
@end_column = @node.last_column
end
end
# Example:
# x[1] += 42
# ^^^ (for [])
# x[1] += 42
# ^ (for +)
# x[1] += 42
# ^^^^^^ (for []=)
def spot_op_asgn1_for_name
nd_recv, op, nd_args, _nd_rhs = @node.children
fetch_line(nd_recv.last_lineno)
if @snippet.match(/\G[\s)]*(\[)/, nd_recv.last_column)
bracket_beg_column = $~.begin(1)
args_last_column = $~.end(0)
if nd_args && nd_recv.last_lineno == nd_args.last_lineno
args_last_column = nd_args.last_column
end
if @snippet.match(/\s*\](\s*)(#{ Regexp.quote(op) })=()/, args_last_column)
case @name
when :[], :[]=
@beg_column = bracket_beg_column
@end_column = $~.begin(@name == :[] ? 1 : 3)
when op
@beg_column = $~.begin(2)
@end_column = $~.end(2)
end
end
end
end
# Example:
# x[1] += 42
# ^^^^^^^^
def spot_op_asgn1_for_args
nd_recv, mid, nd_args, nd_rhs = @node.children
fetch_line(nd_recv.last_lineno)
if mid == :[]= && @snippet.match(/\G\s*\[/, nd_recv.last_column)
@beg_column = $~.end(0)
if nd_recv.last_lineno == nd_rhs.last_lineno
@end_column = nd_rhs.last_column
end
elsif nd_args && nd_args.first_lineno == nd_rhs.last_lineno
@beg_column = nd_args.first_column
@end_column = nd_rhs.last_column
end
# TODO: support @arg
end
# Example:
# x.foo += 42
# ^^^ (for foo)
# x.foo += 42
# ^ (for +)
# x.foo += 42
# ^^^^^^^ (for foo=)
def spot_op_asgn2_for_name
nd_recv, _qcall, attr, op, _nd_rhs = @node.children
fetch_line(nd_recv.last_lineno)
if @snippet.match(/\G[\s)]*(\.)\s*#{ Regexp.quote(attr) }()\s*(#{ Regexp.quote(op) })(=)/, nd_recv.last_column)
case @name
when attr
@beg_column = $~.begin(1)
@end_column = $~.begin(2)
when op
@beg_column = $~.begin(3)
@end_column = $~.end(3)
when :"#{ attr }="
@beg_column = $~.begin(1)
@end_column = $~.end(4)
end
end
end
# Example:
# x.foo += 42
# ^^
def spot_op_asgn2_for_args
_nd_recv, _qcall, _attr, _op, nd_rhs = @node.children
if nd_rhs.first_lineno == nd_rhs.last_lineno
fetch_line(nd_rhs.first_lineno)
@beg_column = nd_rhs.first_column
@end_column = nd_rhs.last_column
end
end
# Example:
# Foo::Bar
# ^^^^^
def spot_colon2
nd_parent, const = @node.children
if nd_parent.last_lineno == @node.last_lineno
fetch_line(nd_parent.last_lineno)
@beg_column = nd_parent.last_column
@end_column = @node.last_column
else
@snippet = @fetch[@node.last_lineno]
if @snippet[...@node.last_column].match(/#{ Regexp.quote(const) }\z/)
@beg_column = $~.begin(0)
@end_column = $~.end(0)
end
end
end
# Example:
# Foo::Bar += 1
# ^^^^^^^^
def spot_op_cdecl
nd_lhs, op, _nd_rhs = @node.children
*nd_parent_lhs, _const = nd_lhs.children
if @name == op
@snippet = @fetch[nd_lhs.last_lineno]
if @snippet.match(/\G\s*(#{ Regexp.quote(op) })=/, nd_lhs.last_column)
@beg_column = $~.begin(1)
@end_column = $~.end(1)
end
else
# constant access error
@end_column = nd_lhs.last_column
if nd_parent_lhs.empty? # example: ::C += 1
if nd_lhs.first_lineno == nd_lhs.last_lineno
@snippet = @fetch[nd_lhs.last_lineno]
@beg_column = nd_lhs.first_column
end
else # example: Foo::Bar::C += 1
if nd_parent_lhs.last.last_lineno == nd_lhs.last_lineno
@snippet = @fetch[nd_lhs.last_lineno]
@beg_column = nd_parent_lhs.last.last_column
end
end
end
end
def fetch_line(lineno)
@beg_lineno = @end_lineno = lineno
@snippet = @fetch[lineno]
end
end
private_constant :Spotter
end
share/ruby/English.rb 0000644 00000013050 15173517740 0010556 0 ustar 00 # frozen_string_literal: true
# Include the English library file in a Ruby script, and you can
# reference the global variables such as <code>$_</code> using less
# cryptic names, listed below.
#
# Without 'English':
#
# $\ = ' -- '
# "waterbuffalo" =~ /buff/
# print $', $$, "\n"
#
# With English:
#
# require "English"
#
# $OUTPUT_FIELD_SEPARATOR = ' -- '
# "waterbuffalo" =~ /buff/
# print $POSTMATCH, $PID, "\n"
#
# Below is a full list of descriptive aliases and their associated global
# variable:
#
# $ERROR_INFO:: $!
# $ERROR_POSITION:: $@
# $FS:: $;
# $FIELD_SEPARATOR:: $;
# $OFS:: $,
# $OUTPUT_FIELD_SEPARATOR:: $,
# $RS:: $/
# $INPUT_RECORD_SEPARATOR:: $/
# $ORS:: $\
# $OUTPUT_RECORD_SEPARATOR:: $\
# $INPUT_LINE_NUMBER:: $.
# $NR:: $.
# $LAST_READ_LINE:: $_
# $DEFAULT_OUTPUT:: $>
# $DEFAULT_INPUT:: $<
# $PID:: $$
# $PROCESS_ID:: $$
# $CHILD_STATUS:: $?
# $LAST_MATCH_INFO:: $~
# $ARGV:: $*
# $MATCH:: $&
# $PREMATCH:: $`
# $POSTMATCH:: $'
# $LAST_PAREN_MATCH:: $+
#
module English end if false
# The exception object passed to +raise+.
alias $ERROR_INFO $!
# The stack backtrace generated by the last
# exception. See Kernel#caller for details. Thread local.
alias $ERROR_POSITION $@
# The default separator pattern used by String#split. May be set from
# the command line using the <code>-F</code> flag.
alias $FS $;
alias $FIELD_SEPARATOR $;
# The separator string output between the parameters to methods such
# as Kernel#print and Array#join. Defaults to +nil+, which adds no
# text.
# The separator string output between the parameters to methods such
# as Kernel#print and Array#join. Defaults to +nil+, which adds no
# text.
alias $OFS $,
alias $OUTPUT_FIELD_SEPARATOR $,
# The input record separator (newline by default). This is the value
# that routines such as Kernel#gets use to determine record
# boundaries. If set to +nil+, +gets+ will read the entire file.
alias $RS $/
alias $INPUT_RECORD_SEPARATOR $/
# The string appended to the output of every call to methods such as
# Kernel#print and IO#write. The default value is +nil+.
alias $ORS $\
alias $OUTPUT_RECORD_SEPARATOR $\
# The number of the last line read from the current input file.
alias $NR $.
alias $INPUT_LINE_NUMBER $.
# The last line read by Kernel#gets or
# Kernel#readline. Many string-related functions in the
# Kernel module operate on <code>$_</code> by default. The variable is
# local to the current scope. Thread local.
alias $LAST_READ_LINE $_
# The destination of output for Kernel#print
# and Kernel#printf. The default value is
# <code>$stdout</code>.
alias $DEFAULT_OUTPUT $>
# An object that provides access to the concatenation
# of the contents of all the files
# given as command-line arguments, or <code>$stdin</code>
# (in the case where there are no
# arguments). <code>$<</code> supports methods similar to a
# File object:
# +inmode+, +close+,
# <code>closed?</code>, +each+,
# <code>each_byte</code>, <code>each_line</code>,
# +eof+, <code>eof?</code>, +file+,
# +filename+, +fileno+,
# +getc+, +gets+, +lineno+,
# <code>lineno=</code>, +path+,
# +pos+, <code>pos=</code>,
# +read+, +readchar+,
# +readline+, +readlines+,
# +rewind+, +seek+, +skip+,
# +tell+, <code>to_a</code>, <code>to_i</code>,
# <code>to_io</code>, <code>to_s</code>, along with the
# methods in Enumerable. The method +file+
# returns a File object for the file currently
# being read. This may change as <code>$<</code> reads
# through the files on the command line. Read only.
alias $DEFAULT_INPUT $<
# The process number of the program being executed. Read only.
alias $PID $$
alias $PROCESS_ID $$
# The exit status of the last child process to terminate. Read
# only. Thread local.
alias $CHILD_STATUS $?
# A +MatchData+ object that encapsulates the results of a successful
# pattern match. The variables <code>$&</code>, <code>$`</code>, <code>$'</code>,
# and <code>$1</code> to <code>$9</code> are all derived from
# <code>$~</code>. Assigning to <code>$~</code> changes the values of these
# derived variables. This variable is local to the current
# scope.
alias $LAST_MATCH_INFO $~
# An array of strings containing the command-line
# options from the invocation of the program. Options
# used by the Ruby interpreter will have been
# removed. Read only. Also known simply as +ARGV+.
alias $ARGV $*
# The string matched by the last successful pattern
# match. This variable is local to the current
# scope. Read only.
alias $MATCH $&
# The string preceding the match in the last
# successful pattern match. This variable is local to
# the current scope. Read only.
alias $PREMATCH $`
# The string following the match in the last
# successful pattern match. This variable is local to
# the current scope. Read only.
alias $POSTMATCH $'
# The contents of the highest-numbered group matched in the last
# successful pattern match. Thus, in <code>"cat" =~ /(c|a)(t|z)/</code>,
# <code>$+</code> will be set to "t". This variable is local to the
# current scope. Read only.
alias $LAST_PAREN_MATCH $+
share/ruby/objspace/trace.rb 0000644 00000002235 15173517740 0012054 0 ustar 00 # This is a simple tool to enable the object allocation tracer.
# When you have an object of unknown provenance, you can use this
# to investigate where the object in question is created.
#
# = Important notice
#
# This is only for debugging purpose. Do not use this in production.
# Require'ing this file immediately starts tracing the object allocation,
# which brings a large performance overhead.
#
# = Usage
#
# 1. Add `require "objspace/trace"` into your code (or add `-robjspace/trace` into the command line)
# 2. `p obj` will show the allocation site of `obj`
#
# Note: This redefines `Kernel#p` method, but not `Object#inspect`.
#
# = Examples
#
# 1: require "objspace/trace"
# 2:
# 3: obj = "str"
# 4:
# 5: p obj #=> "str" @ test.rb:3
require 'objspace.so'
module Kernel
remove_method :p
define_method(:p) do |*objs|
objs.each do |obj|
file = ObjectSpace.allocation_sourcefile(obj)
line = ObjectSpace.allocation_sourceline(obj)
if file
puts "#{ obj.inspect } @ #{ file }:#{ line }"
else
puts obj.inspect
end
end
end
end
ObjectSpace.trace_object_allocations_start
warn "objspace/trace is enabled"
share/ruby/tmpdir.rb 0000644 00000011672 15173517740 0010474 0 ustar 00 # frozen_string_literal: true
#
# tmpdir - retrieve temporary directory path
#
# $Id$
#
require 'fileutils'
begin
require 'etc.so'
rescue LoadError # rescue LoadError for miniruby
end
class Dir
# Class variables are inaccessible from non-main Ractor.
# And instance variables too, in Ruby 3.0.
# System-wide temporary directory path
SYSTMPDIR = (defined?(Etc.systmpdir) ? Etc.systmpdir.freeze : '/tmp')
private_constant :SYSTMPDIR
##
# Returns the operating system's temporary file path.
def self.tmpdir
['TMPDIR', 'TMP', 'TEMP', ['system temporary path', SYSTMPDIR], ['/tmp']*2, ['.']*2].find do |name, dir|
unless dir
next if !(dir = ENV[name] rescue next) or dir.empty?
end
dir = File.expand_path(dir)
stat = File.stat(dir) rescue next
case
when !stat.directory?
warn "#{name} is not a directory: #{dir}"
when !stat.writable?
warn "#{name} is not writable: #{dir}"
when stat.world_writable? && !stat.sticky?
warn "#{name} is world-writable: #{dir}"
else
break dir
end
end or raise ArgumentError, "could not find a temporary directory"
end
# Dir.mktmpdir creates a temporary directory.
#
# The directory is created with 0700 permission.
# Application should not change the permission to make the temporary directory accessible from other users.
#
# The prefix and suffix of the name of the directory is specified by
# the optional first argument, <i>prefix_suffix</i>.
# - If it is not specified or nil, "d" is used as the prefix and no suffix is used.
# - If it is a string, it is used as the prefix and no suffix is used.
# - If it is an array, first element is used as the prefix and second element is used as a suffix.
#
# Dir.mktmpdir {|dir| dir is ".../d..." }
# Dir.mktmpdir("foo") {|dir| dir is ".../foo..." }
# Dir.mktmpdir(["foo", "bar"]) {|dir| dir is ".../foo...bar" }
#
# The directory is created under Dir.tmpdir or
# the optional second argument <i>tmpdir</i> if non-nil value is given.
#
# Dir.mktmpdir {|dir| dir is "#{Dir.tmpdir}/d..." }
# Dir.mktmpdir(nil, "/var/tmp") {|dir| dir is "/var/tmp/d..." }
#
# If a block is given,
# it is yielded with the path of the directory.
# The directory and its contents are removed
# using FileUtils.remove_entry before Dir.mktmpdir returns.
# The value of the block is returned.
#
# Dir.mktmpdir {|dir|
# # use the directory...
# open("#{dir}/foo", "w") { something using the file }
# }
#
# If a block is not given,
# The path of the directory is returned.
# In this case, Dir.mktmpdir doesn't remove the directory.
#
# dir = Dir.mktmpdir
# begin
# # use the directory...
# open("#{dir}/foo", "w") { something using the file }
# ensure
# # remove the directory.
# FileUtils.remove_entry dir
# end
#
def self.mktmpdir(prefix_suffix=nil, *rest, **options)
base = nil
path = Tmpname.create(prefix_suffix || "d", *rest, **options) {|path, _, _, d|
base = d
mkdir(path, 0700)
}
if block_given?
begin
yield path.dup
ensure
unless base
stat = File.stat(File.dirname(path))
if stat.world_writable? and !stat.sticky?
raise ArgumentError, "parent directory is world writable but not sticky"
end
end
FileUtils.remove_entry path
end
else
path
end
end
# Temporary name generator
module Tmpname # :nodoc:
module_function
def tmpdir
Dir.tmpdir
end
# Unusable characters as path name
UNUSABLE_CHARS = "^,-.0-9A-Z_a-z~"
# Dedicated random number generator
RANDOM = Object.new
class << RANDOM # :nodoc:
# Maximum random number
MAX = 36**6 # < 0x100000000
# Returns new random string upto 6 bytes
def next
(::Random.urandom(4).unpack1("L")%MAX).to_s(36)
end
end
RANDOM.freeze
private_constant :RANDOM
# Generates and yields random names to create a temporary name
def create(basename, tmpdir=nil, max_try: nil, **opts)
origdir = tmpdir
tmpdir ||= tmpdir()
n = nil
prefix, suffix = basename
prefix = (String.try_convert(prefix) or
raise ArgumentError, "unexpected prefix: #{prefix.inspect}")
prefix = prefix.delete(UNUSABLE_CHARS)
suffix &&= (String.try_convert(suffix) or
raise ArgumentError, "unexpected suffix: #{suffix.inspect}")
suffix &&= suffix.delete(UNUSABLE_CHARS)
begin
t = Time.now.strftime("%Y%m%d")
path = "#{prefix}#{t}-#{$$}-#{RANDOM.next}"\
"#{n ? %[-#{n}] : ''}#{suffix||''}"
path = File.join(tmpdir, path)
yield(path, n, opts, origdir)
rescue Errno::EEXIST
n ||= 0
n += 1
retry if !max_try or n < max_try
raise "cannot generate temporary name using `#{basename}' under `#{tmpdir}'"
end
path
end
end
end
share/ruby/erb/util.rb 0000644 00000002647 15173517740 0010724 0 ustar 00 # frozen_string_literal: true
#--
# ERB::Escape
#
# A subset of ERB::Util. Unlike ERB::Util#html_escape, we expect/hope
# Rails will not monkey-patch ERB::Escape#html_escape.
begin
# We don't build the C extension for JRuby, TruffleRuby, and WASM
if $LOAD_PATH.resolve_feature_path('erb/escape')
require 'erb/escape'
end
rescue LoadError # resolve_feature_path raises LoadError on TruffleRuby 22.3.0
end
unless defined?(ERB::Escape)
module ERB::Escape
def html_escape(s)
CGI.escapeHTML(s.to_s)
end
module_function :html_escape
end
end
#--
# ERB::Util
#
# A utility module for conversion routines, often handy in HTML generation.
module ERB::Util
#
# A utility method for escaping HTML tag characters in _s_.
#
# require "erb"
# include ERB::Util
#
# puts html_escape("is a > 0 & a < 10?")
#
# _Generates_
#
# is a > 0 & a < 10?
#
include ERB::Escape # html_escape
module_function :html_escape
alias h html_escape
module_function :h
#
# A utility method for encoding the String _s_ as a URL.
#
# require "erb"
# include ERB::Util
#
# puts url_encode("Programming Ruby: The Pragmatic Programmer's Guide")
#
# _Generates_
#
# Programming%20Ruby%3A%20%20The%20Pragmatic%20Programmer%27s%20Guide
#
def url_encode(s)
CGI.escapeURIComponent(s.to_s)
end
alias u url_encode
module_function :u
module_function :url_encode
end
share/ruby/erb/def_method.rb 0000644 00000001725 15173517740 0012041 0 ustar 00 # frozen_string_literal: true
#--
# ERB::DefMethod
#
# Utility module to define eRuby script as instance method.
#
# === Example
#
# example.rhtml:
# <% for item in @items %>
# <b><%= item %></b>
# <% end %>
#
# example.rb:
# require 'erb'
# class MyClass
# extend ERB::DefMethod
# def_erb_method('render()', 'example.rhtml')
# def initialize(items)
# @items = items
# end
# end
# print MyClass.new([10,20,30]).render()
#
# result:
#
# <b>10</b>
#
# <b>20</b>
#
# <b>30</b>
#
module ERB::DefMethod
# define _methodname_ as instance method of current module, using ERB
# object or eRuby file
def def_erb_method(methodname, erb_or_fname)
if erb_or_fname.kind_of? String
fname = erb_or_fname
erb = ERB.new(File.read(fname))
erb.def_method(self, methodname, fname)
else
erb = erb_or_fname
erb.def_method(self, methodname, erb.filename || '(ERB)')
end
end
module_function :def_erb_method
end
share/ruby/erb/version.rb 0000644 00000000134 15173517740 0011421 0 ustar 00 # frozen_string_literal: true
class ERB
VERSION = '4.0.3'
private_constant :VERSION
end
share/ruby/erb/compiler.rb 0000644 00000026560 15173517740 0011561 0 ustar 00 # frozen_string_literal: true
#--
# ERB::Compiler
#
# Compiles ERB templates into Ruby code; the compiled code produces the
# template result when evaluated. ERB::Compiler provides hooks to define how
# generated output is handled.
#
# Internally ERB does something like this to generate the code returned by
# ERB#src:
#
# compiler = ERB::Compiler.new('<>')
# compiler.pre_cmd = ["_erbout=+''"]
# compiler.put_cmd = "_erbout.<<"
# compiler.insert_cmd = "_erbout.<<"
# compiler.post_cmd = ["_erbout"]
#
# code, enc = compiler.compile("Got <%= obj %>!\n")
# puts code
#
# <i>Generates</i>:
#
# #coding:UTF-8
# _erbout=+''; _erbout.<< "Got ".freeze; _erbout.<<(( obj ).to_s); _erbout.<< "!\n".freeze; _erbout
#
# By default the output is sent to the print method. For example:
#
# compiler = ERB::Compiler.new('<>')
# code, enc = compiler.compile("Got <%= obj %>!\n")
# puts code
#
# <i>Generates</i>:
#
# #coding:UTF-8
# print "Got ".freeze; print(( obj ).to_s); print "!\n".freeze
#
# == Evaluation
#
# The compiled code can be used in any context where the names in the code
# correctly resolve. Using the last example, each of these print 'Got It!'
#
# Evaluate using a variable:
#
# obj = 'It'
# eval code
#
# Evaluate using an input:
#
# mod = Module.new
# mod.module_eval %{
# def get(obj)
# #{code}
# end
# }
# extend mod
# get('It')
#
# Evaluate using an accessor:
#
# klass = Class.new Object
# klass.class_eval %{
# attr_accessor :obj
# def initialize(obj)
# @obj = obj
# end
# def get_it
# #{code}
# end
# }
# klass.new('It').get_it
#
# Good! See also ERB#def_method, ERB#def_module, and ERB#def_class.
class ERB::Compiler # :nodoc:
class PercentLine # :nodoc:
def initialize(str)
@value = str
end
attr_reader :value
alias :to_s :value
end
class Scanner # :nodoc:
@scanner_map = {}
class << self
def register_scanner(klass, trim_mode, percent)
@scanner_map[[trim_mode, percent]] = klass
end
alias :regist_scanner :register_scanner
end
def self.default_scanner=(klass)
@default_scanner = klass
end
def self.make_scanner(src, trim_mode, percent)
klass = @scanner_map.fetch([trim_mode, percent], @default_scanner)
klass.new(src, trim_mode, percent)
end
DEFAULT_STAGS = %w(<%% <%= <%# <%).freeze
DEFAULT_ETAGS = %w(%%> %>).freeze
def initialize(src, trim_mode, percent)
@src = src
@stag = nil
@stags = DEFAULT_STAGS
@etags = DEFAULT_ETAGS
end
attr_accessor :stag
attr_reader :stags, :etags
def scan; end
end
class TrimScanner < Scanner # :nodoc:
def initialize(src, trim_mode, percent)
super
@trim_mode = trim_mode
@percent = percent
if @trim_mode == '>'
@scan_reg = /(.*?)(%>\r?\n|#{(stags + etags).join('|')}|\n|\z)/m
@scan_line = self.method(:trim_line1)
elsif @trim_mode == '<>'
@scan_reg = /(.*?)(%>\r?\n|#{(stags + etags).join('|')}|\n|\z)/m
@scan_line = self.method(:trim_line2)
elsif @trim_mode == '-'
@scan_reg = /(.*?)(^[ \t]*<%\-|<%\-|-%>\r?\n|-%>|#{(stags + etags).join('|')}|\z)/m
@scan_line = self.method(:explicit_trim_line)
else
@scan_reg = /(.*?)(#{(stags + etags).join('|')}|\n|\z)/m
@scan_line = self.method(:scan_line)
end
end
def scan(&block)
@stag = nil
if @percent
@src.each_line do |line|
percent_line(line, &block)
end
else
@scan_line.call(@src, &block)
end
nil
end
def percent_line(line, &block)
if @stag || line[0] != ?%
return @scan_line.call(line, &block)
end
line[0] = ''
if line[0] == ?%
@scan_line.call(line, &block)
else
yield(PercentLine.new(line.chomp))
end
end
def scan_line(line)
line.scan(@scan_reg) do |tokens|
tokens.each do |token|
next if token.empty?
yield(token)
end
end
end
def trim_line1(line)
line.scan(@scan_reg) do |tokens|
tokens.each do |token|
next if token.empty?
if token == "%>\n" || token == "%>\r\n"
yield('%>')
yield(:cr)
else
yield(token)
end
end
end
end
def trim_line2(line)
head = nil
line.scan(@scan_reg) do |tokens|
tokens.each do |token|
next if token.empty?
head = token unless head
if token == "%>\n" || token == "%>\r\n"
yield('%>')
if is_erb_stag?(head)
yield(:cr)
else
yield("\n")
end
head = nil
else
yield(token)
head = nil if token == "\n"
end
end
end
end
def explicit_trim_line(line)
line.scan(@scan_reg) do |tokens|
tokens.each do |token|
next if token.empty?
if @stag.nil? && /[ \t]*<%-/ =~ token
yield('<%')
elsif @stag && (token == "-%>\n" || token == "-%>\r\n")
yield('%>')
yield(:cr)
elsif @stag && token == '-%>'
yield('%>')
else
yield(token)
end
end
end
end
ERB_STAG = %w(<%= <%# <%)
def is_erb_stag?(s)
ERB_STAG.member?(s)
end
end
Scanner.default_scanner = TrimScanner
begin
require 'strscan'
rescue LoadError
else
class SimpleScanner < Scanner # :nodoc:
def scan
stag_reg = (stags == DEFAULT_STAGS) ? /(.*?)(<%[%=#]?|\z)/m : /(.*?)(#{stags.join('|')}|\z)/m
etag_reg = (etags == DEFAULT_ETAGS) ? /(.*?)(%%?>|\z)/m : /(.*?)(#{etags.join('|')}|\z)/m
scanner = StringScanner.new(@src)
while ! scanner.eos?
scanner.scan(@stag ? etag_reg : stag_reg)
yield(scanner[1])
yield(scanner[2])
end
end
end
Scanner.register_scanner(SimpleScanner, nil, false)
class ExplicitScanner < Scanner # :nodoc:
def scan
stag_reg = /(.*?)(^[ \t]*<%-|<%-|#{stags.join('|')}|\z)/m
etag_reg = /(.*?)(-%>|#{etags.join('|')}|\z)/m
scanner = StringScanner.new(@src)
while ! scanner.eos?
scanner.scan(@stag ? etag_reg : stag_reg)
yield(scanner[1])
elem = scanner[2]
if /[ \t]*<%-/ =~ elem
yield('<%')
elsif elem == '-%>'
yield('%>')
yield(:cr) if scanner.scan(/(\r?\n|\z)/)
else
yield(elem)
end
end
end
end
Scanner.register_scanner(ExplicitScanner, '-', false)
end
class Buffer # :nodoc:
def initialize(compiler, enc=nil, frozen=nil)
@compiler = compiler
@line = []
@script = +''
@script << "#coding:#{enc}\n" if enc
@script << "#frozen-string-literal:#{frozen}\n" unless frozen.nil?
@compiler.pre_cmd.each do |x|
push(x)
end
end
attr_reader :script
def push(cmd)
@line << cmd
end
def cr
@script << (@line.join('; '))
@line = []
@script << "\n"
end
def close
return unless @line
@compiler.post_cmd.each do |x|
push(x)
end
@script << (@line.join('; '))
@line = nil
end
end
def add_put_cmd(out, content)
out.push("#{@put_cmd} #{content.dump}.freeze#{"\n" * content.count("\n")}")
end
def add_insert_cmd(out, content)
out.push("#{@insert_cmd}((#{content}).to_s)")
end
# Compiles an ERB template into Ruby code. Returns an array of the code
# and encoding like ["code", Encoding].
def compile(s)
enc = s.encoding
raise ArgumentError, "#{enc} is not ASCII compatible" if enc.dummy?
s = s.b # see String#b
magic_comment = detect_magic_comment(s, enc)
out = Buffer.new(self, *magic_comment)
self.content = +''
scanner = make_scanner(s)
scanner.scan do |token|
next if token.nil?
next if token == ''
if scanner.stag.nil?
compile_stag(token, out, scanner)
else
compile_etag(token, out, scanner)
end
end
add_put_cmd(out, content) if content.size > 0
out.close
return out.script, *magic_comment
end
def compile_stag(stag, out, scanner)
case stag
when PercentLine
add_put_cmd(out, content) if content.size > 0
self.content = +''
out.push(stag.to_s)
out.cr
when :cr
out.cr
when '<%', '<%=', '<%#'
scanner.stag = stag
add_put_cmd(out, content) if content.size > 0
self.content = +''
when "\n"
content << "\n"
add_put_cmd(out, content)
self.content = +''
when '<%%'
content << '<%'
else
content << stag
end
end
def compile_etag(etag, out, scanner)
case etag
when '%>'
compile_content(scanner.stag, out)
scanner.stag = nil
self.content = +''
when '%%>'
content << '%>'
else
content << etag
end
end
def compile_content(stag, out)
case stag
when '<%'
if content[-1] == ?\n
content.chop!
out.push(content)
out.cr
else
out.push(content)
end
when '<%='
add_insert_cmd(out, content)
when '<%#'
out.push("\n" * content.count("\n")) # only adjust lineno
end
end
def prepare_trim_mode(mode) # :nodoc:
case mode
when 1
return [false, '>']
when 2
return [false, '<>']
when 0, nil
return [false, nil]
when String
unless mode.match?(/\A(%|-|>|<>){1,2}\z/)
warn_invalid_trim_mode(mode, uplevel: 5)
end
perc = mode.include?('%')
if mode.include?('-')
return [perc, '-']
elsif mode.include?('<>')
return [perc, '<>']
elsif mode.include?('>')
return [perc, '>']
else
[perc, nil]
end
else
warn_invalid_trim_mode(mode, uplevel: 5)
return [false, nil]
end
end
def make_scanner(src) # :nodoc:
Scanner.make_scanner(src, @trim_mode, @percent)
end
# Construct a new compiler using the trim_mode. See ERB::new for available
# trim modes.
def initialize(trim_mode)
@percent, @trim_mode = prepare_trim_mode(trim_mode)
@put_cmd = 'print'
@insert_cmd = @put_cmd
@pre_cmd = []
@post_cmd = []
end
attr_reader :percent, :trim_mode
# The command to handle text that ends with a newline
attr_accessor :put_cmd
# The command to handle text that is inserted prior to a newline
attr_accessor :insert_cmd
# An array of commands prepended to compiled code
attr_accessor :pre_cmd
# An array of commands appended to compiled code
attr_accessor :post_cmd
private
# A buffered text in #compile
attr_accessor :content
def detect_magic_comment(s, enc = nil)
re = @percent ? /\G(?:<%#(.*)%>|%#(.*)\n)/ : /\G<%#(.*)%>/
frozen = nil
s.scan(re) do
comment = $+
comment = $1 if comment[/-\*-\s*([^\s].*?)\s*-\*-$/]
case comment
when %r"coding\s*[=:]\s*([[:alnum:]\-_]+)"
enc = Encoding.find($1.sub(/-(?:mac|dos|unix)/i, ''))
when %r"frozen[-_]string[-_]literal\s*:\s*([[:alnum:]]+)"
frozen = $1
end
end
return enc, frozen
end
def warn_invalid_trim_mode(mode, uplevel:)
warn "Invalid ERB trim mode: #{mode.inspect} (trim_mode: nil, 0, 1, 2, or String composed of '%' and/or '-', '>', '<>')", uplevel: uplevel + 1
end
end
share/ruby/delegate.rb 0000644 00000027264 15173517740 0010753 0 ustar 00 # frozen_string_literal: true
# = delegate -- Support for the Delegation Pattern
#
# Documentation by James Edward Gray II and Gavin Sinclair
##
# This library provides three different ways to delegate method calls to an
# object. The easiest to use is SimpleDelegator. Pass an object to the
# constructor and all methods supported by the object will be delegated. This
# object can be changed later.
#
# Going a step further, the top level DelegateClass method allows you to easily
# setup delegation through class inheritance. This is considerably more
# flexible and thus probably the most common use for this library.
#
# Finally, if you need full control over the delegation scheme, you can inherit
# from the abstract class Delegator and customize as needed. (If you find
# yourself needing this control, have a look at Forwardable which is also in
# the standard library. It may suit your needs better.)
#
# SimpleDelegator's implementation serves as a nice example of the use of
# Delegator:
#
# require 'delegate'
#
# class SimpleDelegator < Delegator
# def __getobj__
# @delegate_sd_obj # return object we are delegating to, required
# end
#
# def __setobj__(obj)
# @delegate_sd_obj = obj # change delegation object,
# # a feature we're providing
# end
# end
#
# == Notes
#
# Be advised, RDoc will not detect delegated methods.
#
class Delegator < BasicObject
VERSION = "0.3.1"
kernel = ::Kernel.dup
kernel.class_eval do
alias __raise__ raise
[:to_s, :inspect, :!~, :===, :<=>, :hash].each do |m|
undef_method m
end
private_instance_methods.each do |m|
if /\Ablock_given\?\z|\Aiterator\?\z|\A__.*__\z/ =~ m
next
end
undef_method m
end
end
include kernel
# :stopdoc:
def self.const_missing(n)
::Object.const_get(n)
end
# :startdoc:
##
# :method: raise
# Use #__raise__ if your Delegator does not have a object to delegate the
# #raise method call.
#
#
# Pass in the _obj_ to delegate method calls to. All methods supported by
# _obj_ will be delegated to.
#
def initialize(obj)
__setobj__(obj)
end
#
# Handles the magic of delegation through \_\_getobj\_\_.
#
ruby2_keywords def method_missing(m, *args, &block)
r = true
target = self.__getobj__ {r = false}
if r && target_respond_to?(target, m, false)
target.__send__(m, *args, &block)
elsif ::Kernel.method_defined?(m) || ::Kernel.private_method_defined?(m)
::Kernel.instance_method(m).bind_call(self, *args, &block)
else
super(m, *args, &block)
end
end
#
# Checks for a method provided by this the delegate object by forwarding the
# call through \_\_getobj\_\_.
#
def respond_to_missing?(m, include_private)
r = true
target = self.__getobj__ {r = false}
r &&= target_respond_to?(target, m, include_private)
if r && include_private && !target_respond_to?(target, m, false)
warn "delegator does not forward private method \##{m}", uplevel: 3
return false
end
r
end
KERNEL_RESPOND_TO = ::Kernel.instance_method(:respond_to?)
private_constant :KERNEL_RESPOND_TO
# Handle BasicObject instances
private def target_respond_to?(target, m, include_private)
case target
when Object
target.respond_to?(m, include_private)
else
if KERNEL_RESPOND_TO.bind_call(target, :respond_to?)
target.respond_to?(m, include_private)
else
KERNEL_RESPOND_TO.bind_call(target, m, include_private)
end
end
end
#
# Returns the methods available to this delegate object as the union
# of this object's and \_\_getobj\_\_ methods.
#
def methods(all=true)
__getobj__.methods(all) | super
end
#
# Returns the methods available to this delegate object as the union
# of this object's and \_\_getobj\_\_ public methods.
#
def public_methods(all=true)
__getobj__.public_methods(all) | super
end
#
# Returns the methods available to this delegate object as the union
# of this object's and \_\_getobj\_\_ protected methods.
#
def protected_methods(all=true)
__getobj__.protected_methods(all) | super
end
# Note: no need to specialize private_methods, since they are not forwarded
#
# Returns true if two objects are considered of equal value.
#
def ==(obj)
return true if obj.equal?(self)
self.__getobj__ == obj
end
#
# Returns true if two objects are not considered of equal value.
#
def !=(obj)
return false if obj.equal?(self)
__getobj__ != obj
end
#
# Returns true if two objects are considered of equal value.
#
def eql?(obj)
return true if obj.equal?(self)
obj.eql?(__getobj__)
end
#
# Delegates ! to the \_\_getobj\_\_
#
def !
!__getobj__
end
#
# This method must be overridden by subclasses and should return the object
# method calls are being delegated to.
#
def __getobj__
__raise__ ::NotImplementedError, "need to define `__getobj__'"
end
#
# This method must be overridden by subclasses and change the object delegate
# to _obj_.
#
def __setobj__(obj)
__raise__ ::NotImplementedError, "need to define `__setobj__'"
end
#
# Serialization support for the object returned by \_\_getobj\_\_.
#
def marshal_dump
ivars = instance_variables.reject {|var| /\A@delegate_/ =~ var}
[
:__v2__,
ivars, ivars.map {|var| instance_variable_get(var)},
__getobj__
]
end
#
# Reinitializes delegation from a serialized object.
#
def marshal_load(data)
version, vars, values, obj = data
if version == :__v2__
vars.each_with_index {|var, i| instance_variable_set(var, values[i])}
__setobj__(obj)
else
__setobj__(data)
end
end
def initialize_clone(obj, freeze: nil) # :nodoc:
self.__setobj__(obj.__getobj__.clone(freeze: freeze))
end
def initialize_dup(obj) # :nodoc:
self.__setobj__(obj.__getobj__.dup)
end
private :initialize_clone, :initialize_dup
##
# :method: freeze
# Freeze both the object returned by \_\_getobj\_\_ and self.
#
def freeze
__getobj__.freeze
super()
end
@delegator_api = self.public_instance_methods
def self.public_api # :nodoc:
@delegator_api
end
end
##
# A concrete implementation of Delegator, this class provides the means to
# delegate all supported method calls to the object passed into the constructor
# and even to change the object being delegated to at a later time with
# #__setobj__.
#
# class User
# def born_on
# Date.new(1989, 9, 10)
# end
# end
#
# require 'delegate'
#
# class UserDecorator < SimpleDelegator
# def birth_year
# born_on.year
# end
# end
#
# decorated_user = UserDecorator.new(User.new)
# decorated_user.birth_year #=> 1989
# decorated_user.__getobj__ #=> #<User: ...>
#
# A SimpleDelegator instance can take advantage of the fact that SimpleDelegator
# is a subclass of +Delegator+ to call <tt>super</tt> to have methods called on
# the object being delegated to.
#
# class SuperArray < SimpleDelegator
# def [](*args)
# super + 1
# end
# end
#
# SuperArray.new([1])[0] #=> 2
#
# Here's a simple example that takes advantage of the fact that
# SimpleDelegator's delegation object can be changed at any time.
#
# class Stats
# def initialize
# @source = SimpleDelegator.new([])
# end
#
# def stats(records)
# @source.__setobj__(records)
#
# "Elements: #{@source.size}\n" +
# " Non-Nil: #{@source.compact.size}\n" +
# " Unique: #{@source.uniq.size}\n"
# end
# end
#
# s = Stats.new
# puts s.stats(%w{James Edward Gray II})
# puts
# puts s.stats([1, 2, 3, nil, 4, 5, 1, 2])
#
# Prints:
#
# Elements: 4
# Non-Nil: 4
# Unique: 4
#
# Elements: 8
# Non-Nil: 7
# Unique: 6
#
class SimpleDelegator < Delegator
# Returns the current object method calls are being delegated to.
def __getobj__
unless defined?(@delegate_sd_obj)
return yield if block_given?
__raise__ ::ArgumentError, "not delegated"
end
@delegate_sd_obj
end
#
# Changes the delegate object to _obj_.
#
# It's important to note that this does *not* cause SimpleDelegator's methods
# to change. Because of this, you probably only want to change delegation
# to objects of the same type as the original delegate.
#
# Here's an example of changing the delegation object.
#
# names = SimpleDelegator.new(%w{James Edward Gray II})
# puts names[1] # => Edward
# names.__setobj__(%w{Gavin Sinclair})
# puts names[1] # => Sinclair
#
def __setobj__(obj)
__raise__ ::ArgumentError, "cannot delegate to self" if self.equal?(obj)
@delegate_sd_obj = obj
end
end
def Delegator.delegating_block(mid) # :nodoc:
lambda do |*args, &block|
target = self.__getobj__
target.__send__(mid, *args, &block)
end.ruby2_keywords
end
#
# The primary interface to this library. Use to setup delegation when defining
# your class.
#
# class MyClass < DelegateClass(ClassToDelegateTo) # Step 1
# def initialize
# super(obj_of_ClassToDelegateTo) # Step 2
# end
# end
#
# or:
#
# MyClass = DelegateClass(ClassToDelegateTo) do # Step 1
# def initialize
# super(obj_of_ClassToDelegateTo) # Step 2
# end
# end
#
# Here's a sample of use from Tempfile which is really a File object with a
# few special rules about storage location and when the File should be
# deleted. That makes for an almost textbook perfect example of how to use
# delegation.
#
# class Tempfile < DelegateClass(File)
# # constant and class member data initialization...
#
# def initialize(basename, tmpdir=Dir::tmpdir)
# # build up file path/name in var tmpname...
#
# @tmpfile = File.open(tmpname, File::RDWR|File::CREAT|File::EXCL, 0600)
#
# # ...
#
# super(@tmpfile)
#
# # below this point, all methods of File are supported...
# end
#
# # ...
# end
#
def DelegateClass(superclass, &block)
klass = Class.new(Delegator)
ignores = [*::Delegator.public_api, :to_s, :inspect, :=~, :!~, :===]
protected_instance_methods = superclass.protected_instance_methods
protected_instance_methods -= ignores
public_instance_methods = superclass.public_instance_methods
public_instance_methods -= ignores
klass.module_eval do
def __getobj__ # :nodoc:
unless defined?(@delegate_dc_obj)
return yield if block_given?
__raise__ ::ArgumentError, "not delegated"
end
@delegate_dc_obj
end
def __setobj__(obj) # :nodoc:
__raise__ ::ArgumentError, "cannot delegate to self" if self.equal?(obj)
@delegate_dc_obj = obj
end
protected_instance_methods.each do |method|
define_method(method, Delegator.delegating_block(method))
protected method
end
public_instance_methods.each do |method|
define_method(method, Delegator.delegating_block(method))
end
end
klass.define_singleton_method :public_instance_methods do |all=true|
super(all) | superclass.public_instance_methods
end
klass.define_singleton_method :protected_instance_methods do |all=true|
super(all) | superclass.protected_instance_methods
end
klass.define_singleton_method :instance_methods do |all=true|
super(all) | superclass.instance_methods
end
klass.define_singleton_method :public_instance_method do |name|
super(name)
rescue NameError
raise unless self.public_instance_methods.include?(name)
superclass.public_instance_method(name)
end
klass.define_singleton_method :instance_method do |name|
super(name)
rescue NameError
raise unless self.instance_methods.include?(name)
superclass.instance_method(name)
end
klass.module_eval(&block) if block
return klass
end
share/ruby/syntax_suggest/display_invalid_blocks.rb 0000644 00000003405 15173517740 0016767 0 ustar 00 # frozen_string_literal: true
require_relative "capture_code_context"
require_relative "display_code_with_line_numbers"
module SyntaxSuggest
# Used for formatting invalid blocks
class DisplayInvalidBlocks
attr_reader :filename
def initialize(code_lines:, blocks:, io: $stderr, filename: nil, terminal: DEFAULT_VALUE)
@io = io
@blocks = Array(blocks)
@filename = filename
@code_lines = code_lines
@terminal = (terminal == DEFAULT_VALUE) ? io.isatty : terminal
end
def document_ok?
@blocks.none? { |b| !b.hidden? }
end
def call
if document_ok?
return self
end
if filename
@io.puts("--> #{filename}")
@io.puts
end
@blocks.each do |block|
display_block(block)
end
self
end
private def display_block(block)
# Build explanation
explain = ExplainSyntax.new(
code_lines: block.lines
).call
# Enhance code output
# Also handles several ambiguious cases
lines = CaptureCodeContext.new(
blocks: block,
code_lines: @code_lines
).call
# Build code output
document = DisplayCodeWithLineNumbers.new(
lines: lines,
terminal: @terminal,
highlight_lines: block.lines
).call
# Output syntax error explanation
explain.errors.each do |e|
@io.puts e
end
@io.puts
# Output code
@io.puts(document)
end
private def code_with_context
lines = CaptureCodeContext.new(
blocks: @blocks,
code_lines: @code_lines
).call
DisplayCodeWithLineNumbers.new(
lines: lines,
terminal: @terminal,
highlight_lines: @invalid_lines
).call
end
end
end
share/ruby/syntax_suggest/left_right_lex_count.rb 0000644 00000010074 15173517740 0016466 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Find mis-matched syntax based on lexical count
#
# Used for detecting missing pairs of elements
# each keyword needs an end, each '{' needs a '}'
# etc.
#
# Example:
#
# left_right = LeftRightLexCount.new
# left_right.count_kw
# left_right.missing.first
# # => "end"
#
# left_right = LeftRightLexCount.new
# source = "{ a: b, c: d" # Note missing '}'
# LexAll.new(source: source).each do |lex|
# left_right.count_lex(lex)
# end
# left_right.missing.first
# # => "}"
class LeftRightLexCount
def initialize
@kw_count = 0
@end_count = 0
@count_for_char = {
"{" => 0,
"}" => 0,
"[" => 0,
"]" => 0,
"(" => 0,
")" => 0,
"|" => 0
}
end
def count_kw
@kw_count += 1
end
def count_end
@end_count += 1
end
# Count source code characters
#
# Example:
#
# left_right = LeftRightLexCount.new
# left_right.count_lex(LexValue.new(1, :on_lbrace, "{", Ripper::EXPR_BEG))
# left_right.count_for_char("{")
# # => 1
# left_right.count_for_char("}")
# # => 0
def count_lex(lex)
case lex.type
when :on_tstring_content
# ^^^
# Means it's a string or a symbol `"{"` rather than being
# part of a data structure (like a hash) `{ a: b }`
# ignore it.
when :on_words_beg, :on_symbos_beg, :on_qwords_beg,
:on_qsymbols_beg, :on_regexp_beg, :on_tstring_beg
# ^^^
# Handle shorthand syntaxes like `%Q{ i am a string }`
#
# The start token will be the full thing `%Q{` but we
# need to count it as if it's a `{`. Any token
# can be used
char = lex.token[-1]
@count_for_char[char] += 1 if @count_for_char.key?(char)
when :on_embexpr_beg
# ^^^
# Embedded string expressions like `"#{foo} <-embed"`
# are parsed with chars:
#
# `#{` as :on_embexpr_beg
# `}` as :on_embexpr_end
#
# We cannot ignore both :on_emb_expr_beg and :on_embexpr_end
# because sometimes the lexer thinks something is an embed
# string end, when it is not like `lol = }` (no clue why).
#
# When we see `#{` count it as a `{` or we will
# have a mis-match count.
#
case lex.token
when "\#{"
@count_for_char["{"] += 1
end
else
@end_count += 1 if lex.is_end?
@kw_count += 1 if lex.is_kw?
@count_for_char[lex.token] += 1 if @count_for_char.key?(lex.token)
end
end
def count_for_char(char)
@count_for_char[char]
end
# Returns an array of missing syntax characters
# or `"end"` or `"keyword"`
#
# left_right.missing
# # => ["}"]
def missing
out = missing_pairs
out << missing_pipe
out << missing_keyword_end
out.compact!
out
end
PAIRS = {
"{" => "}",
"[" => "]",
"(" => ")"
}.freeze
# Opening characters like `{` need closing characters # like `}`.
#
# When a mis-match count is detected, suggest the
# missing member.
#
# For example if there are 3 `}` and only two `{`
# return `"{"`
private def missing_pairs
PAIRS.map do |(left, right)|
case @count_for_char[left] <=> @count_for_char[right]
when 1
right
when 0
nil
when -1
left
end
end
end
# Keywords need ends and ends need keywords
#
# If we have more keywords, there's a missing `end`
# if we have more `end`-s, there's a missing keyword
private def missing_keyword_end
case @kw_count <=> @end_count
when 1
"end"
when 0
nil
when -1
"keyword"
end
end
# Pipes come in pairs.
# If there's an odd number of pipes then we
# are missing one
private def missing_pipe
if @count_for_char["|"].odd?
"|"
end
end
end
end
share/ruby/syntax_suggest/around_block_scan.rb 0000644 00000015635 15173517740 0015735 0 ustar 00 # frozen_string_literal: true
require_relative "scan_history"
module SyntaxSuggest
# This class is useful for exploring contents before and after
# a block
#
# It searches above and below the passed in block to match for
# whatever criteria you give it:
#
# Example:
#
# def dog # 1
# puts "bark" # 2
# puts "bark" # 3
# end # 4
#
# scan = AroundBlockScan.new(
# code_lines: code_lines
# block: CodeBlock.new(lines: code_lines[1])
# )
#
# scan.scan_while { true }
#
# puts scan.before_index # => 0
# puts scan.after_index # => 3
#
class AroundBlockScan
def initialize(code_lines:, block:)
@code_lines = code_lines
@orig_indent = block.current_indent
@stop_after_kw = false
@force_add_empty = false
@force_add_hidden = false
@target_indent = nil
@scanner = ScanHistory.new(code_lines: code_lines, block: block)
end
# When using this flag, `scan_while` will
# bypass the block it's given and always add a
# line that responds truthy to `CodeLine#hidden?`
#
# Lines are hidden when they've been evaluated by
# the parser as part of a block and found to contain
# valid code.
def force_add_hidden
@force_add_hidden = true
self
end
# When using this flag, `scan_while` will
# bypass the block it's given and always add a
# line that responds truthy to `CodeLine#empty?`
#
# Empty lines contain no code, only whitespace such
# as leading spaces a newline.
def force_add_empty
@force_add_empty = true
self
end
# Tells `scan_while` to look for mismatched keyword/end-s
#
# When scanning up, if we see more keywords then end-s it will
# stop. This might happen when scanning outside of a method body.
# the first scan line up would be a keyword and this setting would
# trigger a stop.
#
# When scanning down, stop if there are more end-s than keywords.
def stop_after_kw
@stop_after_kw = true
self
end
# Main work method
#
# The scan_while method takes a block that yields lines above and
# below the block. If the yield returns true, the @before_index
# or @after_index are modified to include the matched line.
#
# In addition to yielding individual lines, the internals of this
# object give a mini DSL to handle common situations such as
# stopping if we've found a keyword/end mis-match in one direction
# or the other.
def scan_while
stop_next_up = false
stop_next_down = false
@scanner.scan(
up: ->(line, kw_count, end_count) {
next false if stop_next_up
next true if @force_add_hidden && line.hidden?
next true if @force_add_empty && line.empty?
if @stop_after_kw && kw_count > end_count
stop_next_up = true
end
yield line
},
down: ->(line, kw_count, end_count) {
next false if stop_next_down
next true if @force_add_hidden && line.hidden?
next true if @force_add_empty && line.empty?
if @stop_after_kw && end_count > kw_count
stop_next_down = true
end
yield line
}
)
self
end
# Scanning is intentionally conservative because
# we have no way of rolling back an aggressive block (at this time)
#
# If a block was stopped for some trivial reason, (like an empty line)
# but the next line would have caused it to be balanced then we
# can check that condition and grab just one more line either up or
# down.
#
# For example, below if we're scanning up, line 2 might cause
# the scanning to stop. This is because empty lines might
# denote logical breaks where the user intended to chunk code
# which is a good place to stop and check validity. Unfortunately
# it also means we might have a "dangling" keyword or end.
#
# 1 def bark
# 2
# 3 end
#
# If lines 2 and 3 are in the block, then when this method is
# run it would see it is unbalanced, but that acquiring line 1
# would make it balanced, so that's what it does.
def lookahead_balance_one_line
kw_count = 0
end_count = 0
lines.each do |line|
kw_count += 1 if line.is_kw?
end_count += 1 if line.is_end?
end
return self if kw_count == end_count # nothing to balance
@scanner.commit_if_changed # Rollback point if we don't find anything to optimize
# Try to eat up empty lines
@scanner.scan(
up: ->(line, _, _) { line.hidden? || line.empty? },
down: ->(line, _, _) { line.hidden? || line.empty? }
)
# More ends than keywords, check if we can balance expanding up
next_up = @scanner.next_up
next_down = @scanner.next_down
case end_count - kw_count
when 1
if next_up&.is_kw? && next_up.indent >= @target_indent
@scanner.scan(
up: ->(line, _, _) { line == next_up },
down: ->(line, _, _) { false }
)
@scanner.commit_if_changed
end
when -1
if next_down&.is_end? && next_down.indent >= @target_indent
@scanner.scan(
up: ->(line, _, _) { false },
down: ->(line, _, _) { line == next_down }
)
@scanner.commit_if_changed
end
end
# Rollback any uncommitted changes
@scanner.stash_changes
self
end
# Finds code lines at the same or greater indentation and adds them
# to the block
def scan_neighbors_not_empty
@target_indent = @orig_indent
scan_while { |line| line.not_empty? && line.indent >= @target_indent }
end
# Scan blocks based on indentation of next line above/below block
#
# Determines indentaion of the next line above/below the current block.
#
# Normally this is called when a block has expanded to capture all "neighbors"
# at the same (or greater) indentation and needs to expand out. For example
# the `def/end` lines surrounding a method.
def scan_adjacent_indent
before_after_indent = []
before_after_indent << (@scanner.next_up&.indent || 0)
before_after_indent << (@scanner.next_down&.indent || 0)
@target_indent = before_after_indent.min
scan_while { |line| line.not_empty? && line.indent >= @target_indent }
self
end
# Return the currently matched lines as a `CodeBlock`
#
# When a `CodeBlock` is created it will gather metadata about
# itself, so this is not a free conversion. Avoid allocating
# more CodeBlock's than needed
def code_block
CodeBlock.new(lines: lines)
end
# Returns the lines matched by the current scan as an
# array of CodeLines
def lines
@scanner.lines
end
# Manageable rspec errors
def inspect
"#<#{self.class}:0x0000123843lol >"
end
end
end
share/ruby/syntax_suggest/block_expand.rb 0000644 00000011600 15173517740 0014704 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# This class is responsible for taking a code block that exists
# at a far indentaion and then iteratively increasing the block
# so that it captures everything within the same indentation block.
#
# def dog
# puts "bow"
# puts "wow"
# end
#
# block = BlockExpand.new(code_lines: code_lines)
# .call(CodeBlock.new(lines: code_lines[1]))
#
# puts block.to_s
# # => puts "bow"
# puts "wow"
#
#
# Once a code block has captured everything at a given indentation level
# then it will expand to capture surrounding indentation.
#
# block = BlockExpand.new(code_lines: code_lines)
# .call(block)
#
# block.to_s
# # => def dog
# puts "bow"
# puts "wow"
# end
#
class BlockExpand
def initialize(code_lines:)
@code_lines = code_lines
end
# Main interface. Expand current indentation, before
# expanding to a lower indentation
def call(block)
if (next_block = expand_neighbors(block))
next_block
else
expand_indent(block)
end
end
# Expands code to the next lowest indentation
#
# For example:
#
# 1 def dog
# 2 print "dog"
# 3 end
#
# If a block starts on line 2 then it has captured all it's "neighbors" (code at
# the same indentation or higher). To continue expanding, this block must capture
# lines one and three which are at a different indentation level.
#
# This method allows fully expanded blocks to decrease their indentation level (so
# they can expand to capture more code up and down). It does this conservatively
# as there's no undo (currently).
def expand_indent(block)
now = AroundBlockScan.new(code_lines: @code_lines, block: block)
.force_add_hidden
.stop_after_kw
.scan_adjacent_indent
now.lookahead_balance_one_line
now.code_block
end
# A neighbor is code that is at or above the current indent line.
#
# First we build a block with all neighbors. If we can't go further
# then we decrease the indentation threshold and expand via indentation
# i.e. `expand_indent`
#
# Handles two general cases.
#
# ## Case #1: Check code inside of methods/classes/etc.
#
# It's important to note, that not everything in a given indentation level can be parsed
# as valid code even if it's part of valid code. For example:
#
# 1 hash = {
# 2 name: "richard",
# 3 dog: "cinco",
# 4 }
#
# In this case lines 2 and 3 will be neighbors, but they're invalid until `expand_indent`
# is called on them.
#
# When we are adding code within a method or class (at the same indentation level),
# use the empty lines to denote the programmer intended logical chunks.
# Stop and check each one. For example:
#
# 1 def dog
# 2 print "dog"
# 3
# 4 hash = {
# 5 end
#
# If we did not stop parsing at empty newlines then the block might mistakenly grab all
# the contents (lines 2, 3, and 4) and report them as being problems, instead of only
# line 4.
#
# ## Case #2: Expand/grab other logical blocks
#
# Once the search algorithm has converted all lines into blocks at a given indentation
# it will then `expand_indent`. Once the blocks that generates are expanded as neighbors
# we then begin seeing neighbors being other logical blocks i.e. a block's neighbors
# may be another method or class (something with keywords/ends).
#
# For example:
#
# 1 def bark
# 2
# 3 end
# 4
# 5 def sit
# 6 end
#
# In this case if lines 4, 5, and 6 are in a block when it tries to expand neighbors
# it will expand up. If it stops after line 2 or 3 it may cause problems since there's a
# valid kw/end pair, but the block will be checked without it.
#
# We try to resolve this edge case with `lookahead_balance_one_line` below.
def expand_neighbors(block)
now = AroundBlockScan.new(code_lines: @code_lines, block: block)
# Initial scan
now
.force_add_hidden
.stop_after_kw
.scan_neighbors_not_empty
# Slurp up empties
now
.scan_while { |line| line.empty? }
# If next line is kw and it will balance us, take it
expanded_lines = now
.lookahead_balance_one_line
.lines
# Don't allocate a block if it won't be used
#
# If nothing was taken, return nil to indicate that status
# used in `def call` to determine if
# we need to expand up/out (`expand_indent`)
if block.lines == expanded_lines
nil
else
CodeBlock.new(lines: expanded_lines)
end
end
# Manageable rspec errors
def inspect
"#<SyntaxSuggest::CodeBlock:0x0000123843lol >"
end
end
end
share/ruby/syntax_suggest/pathname_from_message.rb 0000644 00000002660 15173517740 0016605 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Converts a SyntaxError message to a path
#
# Handles the case where the filename has a colon in it
# such as on a windows file system: https://github.com/ruby/syntax_suggest/issues/111
#
# Example:
#
# message = "/tmp/scratch:2:in `require_relative': /private/tmp/bad.rb:1: syntax error, unexpected `end' (SyntaxError)"
# puts PathnameFromMessage.new(message).call.name
# # => "/tmp/scratch.rb"
#
class PathnameFromMessage
EVAL_RE = /^\(eval.*\):\d+/
STREAMING_RE = /^-:\d+/
attr_reader :name
def initialize(message, io: $stderr)
@line = message.lines.first
@parts = @line.split(":")
@guess = []
@name = nil
@io = io
end
def call
if skip_missing_file_name?
if ENV["SYNTAX_SUGGEST_DEBUG"]
@io.puts "SyntaxSuggest: Could not find filename from #{@line.inspect}"
end
else
until stop?
@guess << @parts.shift
@name = Pathname(@guess.join(":"))
end
if @parts.empty?
@io.puts "SyntaxSuggest: Could not find filename from #{@line.inspect}"
@name = nil
end
end
self
end
def stop?
return true if @parts.empty?
return false if @guess.empty?
@name&.exist?
end
def skip_missing_file_name?
@line.match?(EVAL_RE) || @line.match?(STREAMING_RE)
end
end
end
share/ruby/syntax_suggest/parse_blocks_from_indent_line.rb 0000644 00000003001 15173517740 0020311 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# This class is responsible for generating initial code blocks
# that will then later be expanded.
#
# The biggest concern when guessing code blocks, is accidentally
# grabbing one that contains only an "end". In this example:
#
# def dog
# begonn # misspelled `begin`
# puts "bark"
# end
# end
#
# The following lines would be matched (from bottom to top):
#
# 1) end
#
# 2) puts "bark"
# end
#
# 3) begonn
# puts "bark"
# end
#
# At this point it has no where else to expand, and it will yield this inner
# code as a block
class ParseBlocksFromIndentLine
attr_reader :code_lines
def initialize(code_lines:)
@code_lines = code_lines
end
# Builds blocks from bottom up
def each_neighbor_block(target_line)
scan = AroundBlockScan.new(code_lines: code_lines, block: CodeBlock.new(lines: target_line))
.force_add_empty
.force_add_hidden
.scan_while { |line| line.indent >= target_line.indent }
neighbors = scan.code_block.lines
block = CodeBlock.new(lines: neighbors)
if neighbors.length <= 2 || block.valid?
yield block
else
until neighbors.empty?
lines = [neighbors.pop]
while (block = CodeBlock.new(lines: lines)) && block.invalid? && neighbors.any?
lines.prepend neighbors.pop
end
yield block if block
end
end
end
end
end
share/ruby/syntax_suggest/api.rb 0000644 00000014114 15173517740 0013027 0 ustar 00 # frozen_string_literal: true
require_relative "version"
require "tmpdir"
require "stringio"
require "pathname"
require "timeout"
# We need Ripper loaded for `Prism.lex_compat` even if we're using Prism
# for lexing and parsing
require "ripper"
# Prism is the new parser, replacing Ripper
#
# We need to "dual boot" both for now because syntax_suggest
# supports older rubies that do not ship with syntax suggest.
#
# We also need the ability to control loading of this library
# so we can test that both modes work correctly in CI.
if (value = ENV["SYNTAX_SUGGEST_DISABLE_PRISM"])
warn "Skipping loading prism due to SYNTAX_SUGGEST_DISABLE_PRISM=#{value}"
else
begin
require "prism"
rescue LoadError
end
end
module SyntaxSuggest
# Used to indicate a default value that cannot
# be confused with another input.
DEFAULT_VALUE = Object.new.freeze
class Error < StandardError; end
TIMEOUT_DEFAULT = ENV.fetch("SYNTAX_SUGGEST_TIMEOUT", 1).to_i
# SyntaxSuggest.use_prism_parser? [Private]
#
# Tells us if the prism parser is available for use
# or if we should fallback to `Ripper`
def self.use_prism_parser?
defined?(Prism)
end
# SyntaxSuggest.handle_error [Public]
#
# Takes a `SyntaxError` exception, uses the
# error message to locate the file. Then the file
# will be analyzed to find the location of the syntax
# error and emit that location to stderr.
#
# Example:
#
# begin
# require 'bad_file'
# rescue => e
# SyntaxSuggest.handle_error(e)
# end
#
# By default it will re-raise the exception unless
# `re_raise: false`. The message output location
# can be configured using the `io: $stderr` input.
#
# If a valid filename cannot be determined, the original
# exception will be re-raised (even with
# `re_raise: false`).
def self.handle_error(e, re_raise: true, io: $stderr)
unless e.is_a?(SyntaxError)
io.puts("SyntaxSuggest: Must pass a SyntaxError, got: #{e.class}")
raise e
end
file = PathnameFromMessage.new(e.message, io: io).call.name
raise e unless file
io.sync = true
call(
io: io,
source: file.read,
filename: file
)
raise e if re_raise
end
# SyntaxSuggest.call [Private]
#
# Main private interface
def self.call(source:, filename: DEFAULT_VALUE, terminal: DEFAULT_VALUE, record_dir: DEFAULT_VALUE, timeout: TIMEOUT_DEFAULT, io: $stderr)
search = nil
filename = nil if filename == DEFAULT_VALUE
Timeout.timeout(timeout) do
record_dir ||= ENV["DEBUG"] ? "tmp" : nil
search = CodeSearch.new(source, record_dir: record_dir).call
end
blocks = search.invalid_blocks
DisplayInvalidBlocks.new(
io: io,
blocks: blocks,
filename: filename,
terminal: terminal,
code_lines: search.code_lines
).call
rescue Timeout::Error => e
io.puts "Search timed out SYNTAX_SUGGEST_TIMEOUT=#{timeout}, run with SYNTAX_SUGGEST_DEBUG=1 for more info"
io.puts e.backtrace.first(3).join($/)
end
# SyntaxSuggest.record_dir [Private]
#
# Used to generate a unique directory to record
# search steps for debugging
def self.record_dir(dir)
time = Time.now.strftime("%Y-%m-%d-%H-%M-%s-%N")
dir = Pathname(dir)
dir.join(time).tap { |path|
path.mkpath
alias_dir = dir.join("last")
FileUtils.rm_rf(alias_dir) if alias_dir.exist?
FileUtils.ln_sf(time, alias_dir)
}
end
# SyntaxSuggest.valid_without? [Private]
#
# This will tell you if the `code_lines` would be valid
# if you removed the `without_lines`. In short it's a
# way to detect if we've found the lines with syntax errors
# in our document yet.
#
# code_lines = [
# CodeLine.new(line: "def foo\n", index: 0)
# CodeLine.new(line: " def bar\n", index: 1)
# CodeLine.new(line: "end\n", index: 2)
# ]
#
# SyntaxSuggest.valid_without?(
# without_lines: code_lines[1],
# code_lines: code_lines
# ) # => true
#
# SyntaxSuggest.valid?(code_lines) # => false
def self.valid_without?(without_lines:, code_lines:)
lines = code_lines - Array(without_lines).flatten
if lines.empty?
true
else
valid?(lines)
end
end
# SyntaxSuggest.invalid? [Private]
#
# Opposite of `SyntaxSuggest.valid?`
if defined?(Prism)
def self.invalid?(source)
source = source.join if source.is_a?(Array)
source = source.to_s
Prism.parse(source).failure?
end
else
def self.invalid?(source)
source = source.join if source.is_a?(Array)
source = source.to_s
Ripper.new(source).tap(&:parse).error?
end
end
# SyntaxSuggest.valid? [Private]
#
# Returns truthy if a given input source is valid syntax
#
# SyntaxSuggest.valid?(<<~EOM) # => true
# def foo
# end
# EOM
#
# SyntaxSuggest.valid?(<<~EOM) # => false
# def foo
# def bar # Syntax error here
# end
# EOM
#
# You can also pass in an array of lines and they'll be
# joined before evaluating
#
# SyntaxSuggest.valid?(
# [
# "def foo\n",
# "end\n"
# ]
# ) # => true
#
# SyntaxSuggest.valid?(
# [
# "def foo\n",
# " def bar\n", # Syntax error here
# "end\n"
# ]
# ) # => false
#
# As an FYI the CodeLine class instances respond to `to_s`
# so passing a CodeLine in as an object or as an array
# will convert it to it's code representation.
def self.valid?(source)
!invalid?(source)
end
end
# Integration
require_relative "cli"
# Core logic
require_relative "code_search"
require_relative "code_frontier"
require_relative "explain_syntax"
require_relative "clean_document"
# Helpers
require_relative "lex_all"
require_relative "code_line"
require_relative "code_block"
require_relative "block_expand"
require_relative "priority_queue"
require_relative "unvisited_lines"
require_relative "around_block_scan"
require_relative "priority_engulf_queue"
require_relative "pathname_from_message"
require_relative "display_invalid_blocks"
require_relative "parse_blocks_from_indent_line"
share/ruby/syntax_suggest/explain_syntax.rb 0000644 00000005304 15173517740 0015325 0 ustar 00 # frozen_string_literal: true
require_relative "left_right_lex_count"
if !SyntaxSuggest.use_prism_parser?
require_relative "ripper_errors"
end
module SyntaxSuggest
class GetParseErrors
def self.errors(source)
if SyntaxSuggest.use_prism_parser?
Prism.parse(source).errors.map(&:message)
else
RipperErrors.new(source).call.errors
end
end
end
# Explains syntax errors based on their source
#
# example:
#
# source = "def foo; puts 'lol'" # Note missing end
# explain ExplainSyntax.new(
# code_lines: CodeLine.from_source(source)
# ).call
# explain.errors.first
# # => "Unmatched keyword, missing `end' ?"
#
# When the error cannot be determined by lexical counting
# then the parser is run against the input and the raw
# errors are returned.
#
# Example:
#
# source = "1 * " # Note missing a second number
# explain ExplainSyntax.new(
# code_lines: CodeLine.from_source(source)
# ).call
# explain.errors.first
# # => "syntax error, unexpected end-of-input"
class ExplainSyntax
INVERSE = {
"{" => "}",
"}" => "{",
"[" => "]",
"]" => "[",
"(" => ")",
")" => "(",
"|" => "|"
}.freeze
def initialize(code_lines:)
@code_lines = code_lines
@left_right = LeftRightLexCount.new
@missing = nil
end
def call
@code_lines.each do |line|
line.lex.each do |lex|
@left_right.count_lex(lex)
end
end
self
end
# Returns an array of missing elements
#
# For example this:
#
# ExplainSyntax.new(code_lines: lines).missing
# # => ["}"]
#
# Would indicate that the source is missing
# a `}` character in the source code
def missing
@missing ||= @left_right.missing
end
# Converts a missing string to
# an human understandable explanation.
#
# Example:
#
# explain.why("}")
# # => "Unmatched `{', missing `}' ?"
#
def why(miss)
case miss
when "keyword"
"Unmatched `end', missing keyword (`do', `def`, `if`, etc.) ?"
when "end"
"Unmatched keyword, missing `end' ?"
else
inverse = INVERSE.fetch(miss) {
raise "Unknown explain syntax char or key: #{miss.inspect}"
}
"Unmatched `#{inverse}', missing `#{miss}' ?"
end
end
# Returns an array of syntax error messages
#
# If no missing pairs are found it falls back
# on the original error messages
def errors
if missing.empty?
return GetParseErrors.errors(@code_lines.map(&:original).join).uniq
end
missing.map { |miss| why(miss) }
end
end
end
share/ruby/syntax_suggest/cli.rb 0000644 00000006166 15173517740 0013035 0 ustar 00 # frozen_string_literal: true
require "pathname"
require "optparse"
module SyntaxSuggest
# All the logic of the exe/syntax_suggest CLI in one handy spot
#
# Cli.new(argv: ["--help"]).call
# Cli.new(argv: ["<path/to/file>.rb"]).call
# Cli.new(argv: ["<path/to/file>.rb", "--record=tmp"]).call
# Cli.new(argv: ["<path/to/file>.rb", "--terminal"]).call
#
class Cli
attr_accessor :options
# ARGV is Everything passed to the executable, does not include executable name
#
# All other intputs are dependency injection for testing
def initialize(argv:, exit_obj: Kernel, io: $stdout, env: ENV)
@options = {}
@parser = nil
options[:record_dir] = env["SYNTAX_SUGGEST_RECORD_DIR"]
options[:record_dir] = "tmp" if env["DEBUG"]
options[:terminal] = SyntaxSuggest::DEFAULT_VALUE
@io = io
@argv = argv
@exit_obj = exit_obj
end
def call
if @argv.empty?
# Display help if raw command
parser.parse! %w[--help]
return
else
# Mutates @argv
parse
return if options[:exit]
end
file_name = @argv.first
if file_name.nil?
@io.puts "No file given"
@exit_obj.exit(1)
return
end
file = Pathname(file_name)
if !file.exist?
@io.puts "file not found: #{file.expand_path} "
@exit_obj.exit(1)
return
end
@io.puts "Record dir: #{options[:record_dir]}" if options[:record_dir]
display = SyntaxSuggest.call(
io: @io,
source: file.read,
filename: file.expand_path,
terminal: options.fetch(:terminal, SyntaxSuggest::DEFAULT_VALUE),
record_dir: options[:record_dir]
)
if display.document_ok?
@io.puts "Syntax OK"
@exit_obj.exit(0)
else
@exit_obj.exit(1)
end
end
def parse
parser.parse!(@argv)
self
end
def parser
@parser ||= OptionParser.new do |opts|
opts.banner = <<~EOM
Usage: syntax_suggest <file> [options]
Parses a ruby source file and searches for syntax error(s) such as
unexpected `end', expecting end-of-input.
Example:
$ syntax_suggest dog.rb
# ...
> 10 defdog
> 15 end
ENV options:
SYNTAX_SUGGEST_RECORD_DIR=<dir>
Records the steps used to search for a syntax error
to the given directory
Options:
EOM
opts.version = SyntaxSuggest::VERSION
opts.on("--help", "Help - displays this message") do |v|
@io.puts opts
options[:exit] = true
@exit_obj.exit
end
opts.on("--record <dir>", "Records the steps used to search for a syntax error to the given directory") do |v|
options[:record_dir] = v
end
opts.on("--terminal", "Enable terminal highlighting") do |v|
options[:terminal] = true
end
opts.on("--no-terminal", "Disable terminal highlighting") do |v|
options[:terminal] = false
end
end
end
end
end
share/ruby/syntax_suggest/version.rb 0000644 00000000114 15173517740 0013736 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
VERSION = "2.0.1"
end
share/ruby/syntax_suggest/core_ext.rb 0000644 00000006025 15173517740 0014070 0 ustar 00 # frozen_string_literal: true
# Ruby 3.2+ has a cleaner way to hook into Ruby that doesn't use `require`
if SyntaxError.method_defined?(:detailed_message)
module SyntaxSuggest
# Mini String IO [Private]
#
# Acts like a StringIO with reduced API, but without having to require that
# class.
class MiniStringIO
def initialize(isatty: $stderr.isatty)
@string = +""
@isatty = isatty
end
attr_reader :isatty
def puts(value = $/, **)
@string << value
end
attr_reader :string
end
# SyntaxSuggest.module_for_detailed_message [Private]
#
# Used to monkeypatch SyntaxError via Module.prepend
def self.module_for_detailed_message
Module.new {
def detailed_message(highlight: true, syntax_suggest: true, **kwargs)
return super unless syntax_suggest
require "syntax_suggest/api" unless defined?(SyntaxSuggest::DEFAULT_VALUE)
message = super
if path
file = Pathname.new(path)
io = SyntaxSuggest::MiniStringIO.new
SyntaxSuggest.call(
io: io,
source: file.read,
filename: file,
terminal: highlight
)
annotation = io.string
annotation += "\n" unless annotation.end_with?("\n")
annotation + message
else
message
end
rescue => e
if ENV["SYNTAX_SUGGEST_DEBUG"]
$stderr.warn(e.message)
$stderr.warn(e.backtrace)
end
# Ignore internal errors
message
end
}
end
end
SyntaxError.prepend(SyntaxSuggest.module_for_detailed_message)
else
autoload :Pathname, "pathname"
#--
# Monkey patch kernel to ensure that all `require` calls call the same
# method
#++
module Kernel
# :stopdoc:
module_function
alias_method :syntax_suggest_original_require, :require
alias_method :syntax_suggest_original_require_relative, :require_relative
alias_method :syntax_suggest_original_load, :load
def load(file, wrap = false)
syntax_suggest_original_load(file)
rescue SyntaxError => e
require "syntax_suggest/api" unless defined?(SyntaxSuggest::DEFAULT_VALUE)
SyntaxSuggest.handle_error(e)
end
def require(file)
syntax_suggest_original_require(file)
rescue SyntaxError => e
require "syntax_suggest/api" unless defined?(SyntaxSuggest::DEFAULT_VALUE)
SyntaxSuggest.handle_error(e)
end
def require_relative(file)
if Pathname.new(file).absolute?
syntax_suggest_original_require file
else
relative_from = caller_locations(1..1).first
relative_from_path = relative_from.absolute_path || relative_from.path
syntax_suggest_original_require File.expand_path("../#{file}", relative_from_path)
end
rescue SyntaxError => e
require "syntax_suggest/api" unless defined?(SyntaxSuggest::DEFAULT_VALUE)
SyntaxSuggest.handle_error(e)
end
end
end
share/ruby/syntax_suggest/lex_value.rb 0000644 00000002775 15173517740 0014254 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Value object for accessing lex values
#
# This lex:
#
# [1, 0], :on_ident, "describe", CMDARG
#
# Would translate into:
#
# lex.line # => 1
# lex.type # => :on_indent
# lex.token # => "describe"
class LexValue
attr_reader :line, :type, :token, :state
def initialize(line, type, token, state, last_lex = nil)
@line = line
@type = type
@token = token
@state = state
set_kw_end(last_lex)
end
private def set_kw_end(last_lex)
@is_end = false
@is_kw = false
return if type != :on_kw
return if last_lex && last_lex.fname? # https://github.com/ruby/ruby/commit/776759e300e4659bb7468e2b97c8c2d4359a2953
case token
when "if", "unless", "while", "until"
# Only count if/unless when it's not a "trailing" if/unless
# https://github.com/ruby/ruby/blob/06b44f819eb7b5ede1ff69cecb25682b56a1d60c/lib/irb/ruby-lex.rb#L374-L375
@is_kw = true unless expr_label?
when "def", "case", "for", "begin", "class", "module", "do"
@is_kw = true
when "end"
@is_end = true
end
end
def fname?
state.allbits?(Ripper::EXPR_FNAME)
end
def ignore_newline?
type == :on_ignored_nl
end
def is_end?
@is_end
end
def is_kw?
@is_kw
end
def expr_beg?
state.anybits?(Ripper::EXPR_BEG)
end
def expr_label?
state.allbits?(Ripper::EXPR_LABEL)
end
end
end
share/ruby/syntax_suggest/lex_all.rb 0000644 00000003250 15173517740 0013675 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Ripper.lex is not guaranteed to lex the entire source document
#
# This class guarantees the whole document is lex-ed by iteratively
# lexing the document where ripper stopped.
#
# Prism likely doesn't have the same problem. Once ripper support is removed
# we can likely reduce the complexity here if not remove the whole concept.
#
# Example usage:
#
# lex = LexAll.new(source: source)
# lex.each do |value|
# puts value.line
# end
class LexAll
include Enumerable
def initialize(source:, source_lines: nil)
@lex = self.class.lex(source, 1)
lineno = @lex.last[0][0] + 1
source_lines ||= source.lines
last_lineno = source_lines.length
until lineno >= last_lineno
lines = source_lines[lineno..]
@lex.concat(
self.class.lex(lines.join, lineno + 1)
)
lineno = @lex.last[0].first + 1
end
last_lex = nil
@lex.map! { |elem|
last_lex = LexValue.new(elem[0].first, elem[1], elem[2], elem[3], last_lex)
}
end
if SyntaxSuggest.use_prism_parser?
def self.lex(source, line_number)
Prism.lex_compat(source, line: line_number).value.sort_by { |values| values[0] }
end
else
def self.lex(source, line_number)
Ripper::Lexer.new(source, "-", line_number).parse.sort_by(&:pos)
end
end
def to_a
@lex
end
def each
return @lex.each unless block_given?
@lex.each do |x|
yield x
end
end
def [](index)
@lex[index]
end
def last
@lex.last
end
end
end
require_relative "lex_value"
share/ruby/syntax_suggest/display_code_with_line_numbers.rb 0000644 00000003424 15173517740 0020514 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Outputs code with highlighted lines
#
# Whatever is passed to this class will be rendered
# even if it is "marked invisible" any filtering of
# output should be done before calling this class.
#
# DisplayCodeWithLineNumbers.new(
# lines: lines,
# highlight_lines: [lines[2], lines[3]]
# ).call
# # =>
# 1
# 2 def cat
# > 3 Dir.chdir
# > 4 end
# 5 end
# 6
class DisplayCodeWithLineNumbers
TERMINAL_HIGHLIGHT = "\e[1;3m" # Bold, italics
TERMINAL_END = "\e[0m"
def initialize(lines:, highlight_lines: [], terminal: false)
@lines = Array(lines).sort
@terminal = terminal
@highlight_line_hash = Array(highlight_lines).each_with_object({}) { |line, h| h[line] = true }
@digit_count = @lines.last&.line_number.to_s.length
end
def call
@lines.map do |line|
format_line(line)
end.join
end
private def format_line(code_line)
# Handle trailing slash lines
code_line.original.lines.map.with_index do |contents, i|
format(
empty: code_line.empty?,
number: (code_line.number + i).to_s,
contents: contents,
highlight: @highlight_line_hash[code_line]
)
end.join
end
private def format(contents:, number:, empty:, highlight: false)
string = +""
string << if highlight
"> "
else
" "
end
string << number.rjust(@digit_count).to_s
if empty
string << contents
else
string << " "
string << TERMINAL_HIGHLIGHT if @terminal && highlight
string << contents
string << TERMINAL_END if @terminal
end
string
end
end
end
share/ruby/syntax_suggest/scan_history.rb 0000644 00000005655 15173517740 0014775 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Scans up/down from the given block
#
# You can try out a change, stash it, or commit it to save for later
#
# Example:
#
# scanner = ScanHistory.new(code_lines: code_lines, block: block)
# scanner.scan(
# up: ->(_, _, _) { true },
# down: ->(_, _, _) { true }
# )
# scanner.changed? # => true
# expect(scanner.lines).to eq(code_lines)
#
# scanner.stash_changes
#
# expect(scanner.lines).to_not eq(code_lines)
class ScanHistory
attr_reader :before_index, :after_index
def initialize(code_lines:, block:)
@code_lines = code_lines
@history = [block]
refresh_index
end
def commit_if_changed
if changed?
@history << CodeBlock.new(lines: @code_lines[before_index..after_index])
end
self
end
# Discards any changes that have not been committed
def stash_changes
refresh_index
self
end
# Discard changes that have not been committed and revert the last commit
#
# Cannot revert the first commit
def revert_last_commit
if @history.length > 1
@history.pop
refresh_index
end
self
end
def changed?
@before_index != current.lines.first.index ||
@after_index != current.lines.last.index
end
# Iterates up and down
#
# Returns line, kw_count, end_count for each iteration
def scan(up:, down:)
kw_count = 0
end_count = 0
up_index = before_lines.reverse_each.take_while do |line|
kw_count += 1 if line.is_kw?
end_count += 1 if line.is_end?
up.call(line, kw_count, end_count)
end.last&.index
kw_count = 0
end_count = 0
down_index = after_lines.each.take_while do |line|
kw_count += 1 if line.is_kw?
end_count += 1 if line.is_end?
down.call(line, kw_count, end_count)
end.last&.index
@before_index = if up_index && up_index < @before_index
up_index
else
@before_index
end
@after_index = if down_index && down_index > @after_index
down_index
else
@after_index
end
self
end
def next_up
return nil if @before_index <= 0
@code_lines[@before_index - 1]
end
def next_down
return nil if @after_index >= @code_lines.length
@code_lines[@after_index + 1]
end
def lines
@code_lines[@before_index..@after_index]
end
private def before_lines
@code_lines[0...@before_index] || []
end
# Returns an array of all the CodeLines that exist after
# the currently scanned block
private def after_lines
@code_lines[@after_index.next..] || []
end
private def current
@history.last
end
private def refresh_index
@before_index = current.lines.first.index
@after_index = current.lines.last.index
self
end
end
end
share/ruby/syntax_suggest/priority_engulf_queue.rb 0000644 00000002417 15173517740 0016706 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Keeps track of what elements are in the queue in
# priority and also ensures that when one element
# engulfs/covers/eats another that the larger element
# evicts the smaller element
class PriorityEngulfQueue
def initialize
@queue = PriorityQueue.new
end
def to_a
@queue.to_a
end
def empty?
@queue.empty?
end
def length
@queue.length
end
def peek
@queue.peek
end
def pop
@queue.pop
end
def push(block)
prune_engulf(block)
@queue << block
flush_deleted
self
end
private def flush_deleted
while @queue&.peek&.deleted?
@queue.pop
end
end
private def prune_engulf(block)
# If we're about to pop off the same block, we can skip deleting
# things from the frontier this iteration since we'll get it
# on the next iteration
return if @queue.peek && (block <=> @queue.peek) == 1
if block.starts_at != block.ends_at # A block of size 1 cannot engulf another
@queue.to_a.each { |b|
if b.starts_at >= block.starts_at && b.ends_at <= block.ends_at
b.delete
true
end
}
end
end
end
end
share/ruby/syntax_suggest/capture/before_after_keyword_ends.rb 0000644 00000004244 15173517740 0021124 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
module Capture
# Shows surrounding kw/end pairs
#
# The purpose of showing these extra pairs is due to cases
# of ambiguity when only one visible line is matched.
#
# For example:
#
# 1 class Dog
# 2 def bark
# 4 def eat
# 5 end
# 6 end
#
# In this case either line 2 could be missing an `end` or
# line 4 was an extra line added by mistake (it happens).
#
# When we detect the above problem it shows the issue
# as only being on line 2
#
# 2 def bark
#
# Showing "neighbor" keyword pairs gives extra context:
#
# 2 def bark
# 4 def eat
# 5 end
#
#
# Example:
#
# lines = BeforeAfterKeywordEnds.new(
# block: block,
# code_lines: code_lines
# ).call()
#
class BeforeAfterKeywordEnds
def initialize(code_lines:, block:)
@scanner = ScanHistory.new(code_lines: code_lines, block: block)
@original_indent = block.current_indent
end
def call
lines = []
@scanner.scan(
up: ->(line, kw_count, end_count) {
next true if line.empty?
break if line.indent < @original_indent
next true if line.indent != @original_indent
# If we're going up and have one complete kw/end pair, stop
if kw_count != 0 && kw_count == end_count
lines << line
break
end
lines << line if line.is_kw? || line.is_end?
true
},
down: ->(line, kw_count, end_count) {
next true if line.empty?
break if line.indent < @original_indent
next true if line.indent != @original_indent
# if we're going down and have one complete kw/end pair,stop
if kw_count != 0 && kw_count == end_count
lines << line
break
end
lines << line if line.is_kw? || line.is_end?
true
}
)
@scanner.stash_changes
lines
end
end
end
end
share/ruby/syntax_suggest/capture/falling_indent_lines.rb 0000644 00000003127 15173517740 0020072 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
module Capture
# Shows the context around code provided by "falling" indentation
#
# If this is the original code lines:
#
# class OH
# def hello
# it "foo" do
# end
# end
#
# And this is the line that is captured
#
# it "foo" do
#
# It will yield its surrounding context:
#
# class OH
# def hello
# end
# end
#
# Example:
#
# FallingIndentLines.new(
# block: block,
# code_lines: @code_lines
# ).call do |line|
# @lines_to_output << line
# end
#
class FallingIndentLines
def initialize(code_lines:, block:)
@lines = nil
@scanner = ScanHistory.new(code_lines: code_lines, block: block)
@original_indent = block.current_indent
end
def call(&yieldable)
last_indent_up = @original_indent
last_indent_down = @original_indent
@scanner.commit_if_changed
@scanner.scan(
up: ->(line, _, _) {
next true if line.empty?
if line.indent < last_indent_up
yieldable.call(line)
last_indent_up = line.indent
end
true
},
down: ->(line, _, _) {
next true if line.empty?
if line.indent < last_indent_down
yieldable.call(line)
last_indent_down = line.indent
end
true
}
)
@scanner.stash_changes
end
end
end
end
share/ruby/syntax_suggest/code_line.rb 0000644 00000015176 15173517740 0014210 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Represents a single line of code of a given source file
#
# This object contains metadata about the line such as
# amount of indentation, if it is empty or not, and
# lexical data, such as if it has an `end` or a keyword
# in it.
#
# Visibility of lines can be toggled off. Marking a line as invisible
# indicates that it should not be used for syntax checks.
# It's functionally the same as commenting it out.
#
# Example:
#
# line = CodeLine.from_source("def foo\n").first
# line.number => 1
# line.empty? # => false
# line.visible? # => true
# line.mark_invisible
# line.visible? # => false
#
class CodeLine
TRAILING_SLASH = ("\\" + $/).freeze
# Returns an array of CodeLine objects
# from the source string
def self.from_source(source, lines: nil)
lines ||= source.lines
lex_array_for_line = LexAll.new(source: source, source_lines: lines).each_with_object(Hash.new { |h, k| h[k] = [] }) { |lex, hash| hash[lex.line] << lex }
lines.map.with_index do |line, index|
CodeLine.new(
line: line,
index: index,
lex: lex_array_for_line[index + 1]
)
end
end
attr_reader :line, :index, :lex, :line_number, :indent
def initialize(line:, index:, lex:)
@lex = lex
@line = line
@index = index
@original = line
@line_number = @index + 1
strip_line = line.dup
strip_line.lstrip!
@indent = if (@empty = strip_line.empty?)
line.length - 1 # Newline removed from strip_line is not "whitespace"
else
line.length - strip_line.length
end
set_kw_end
end
# Used for stable sort via indentation level
#
# Ruby's sort is not "stable" meaning that when
# multiple elements have the same value, they are
# not guaranteed to return in the same order they
# were put in.
#
# So when multiple code lines have the same indentation
# level, they're sorted by their index value which is unique
# and consistent.
#
# This is mostly needed for consistency of the test suite
def indent_index
@indent_index ||= [indent, index]
end
alias_method :number, :line_number
# Returns true if the code line is determined
# to contain a keyword that matches with an `end`
#
# For example: `def`, `do`, `begin`, `ensure`, etc.
def is_kw?
@is_kw
end
# Returns true if the code line is determined
# to contain an `end` keyword
def is_end?
@is_end
end
# Used to hide lines
#
# The search alorithm will group lines into blocks
# then if those blocks are determined to represent
# valid code they will be hidden
def mark_invisible
@line = ""
end
# Means the line was marked as "invisible"
# Confusingly, "empty" lines are visible...they
# just don't contain any source code other than a newline ("\n").
def visible?
!line.empty?
end
# Opposite or `visible?` (note: different than `empty?`)
def hidden?
!visible?
end
# An `empty?` line is one that was originally left
# empty in the source code, while a "hidden" line
# is one that we've since marked as "invisible"
def empty?
@empty
end
# Opposite of `empty?` (note: different than `visible?`)
def not_empty?
!empty?
end
# Renders the given line
#
# Also allows us to represent source code as
# an array of code lines.
#
# When we have an array of code line elements
# calling `join` on the array will call `to_s`
# on each element, which essentially converts
# it back into it's original source string.
def to_s
line
end
# When the code line is marked invisible
# we retain the original value of it's line
# this is useful for debugging and for
# showing extra context
#
# DisplayCodeWithLineNumbers will render
# all lines given to it, not just visible
# lines, it uses the original method to
# obtain them.
attr_reader :original
# Comparison operator, needed for equality
# and sorting
def <=>(other)
index <=> other.index
end
# [Not stable API]
#
# Lines that have a `on_ignored_nl` type token and NOT
# a `BEG` type seem to be a good proxy for the ability
# to join multiple lines into one.
#
# This predicate method is used to determine when those
# two criteria have been met.
#
# The one known case this doesn't handle is:
#
# Ripper.lex <<~EOM
# a &&
# b ||
# c
# EOM
#
# For some reason this introduces `on_ignore_newline` but with BEG type
def ignore_newline_not_beg?
@ignore_newline_not_beg
end
# Determines if the given line has a trailing slash
#
# lines = CodeLine.from_source(<<~EOM)
# it "foo" \
# EOM
# expect(lines.first.trailing_slash?).to eq(true)
#
if SyntaxSuggest.use_prism_parser?
def trailing_slash?
last = @lex.last
last&.type == :on_tstring_end
end
else
def trailing_slash?
last = @lex.last
return false unless last
return false unless last.type == :on_sp
last.token == TRAILING_SLASH
end
end
# Endless method detection
#
# From https://github.com/ruby/irb/commit/826ae909c9c93a2ddca6f9cfcd9c94dbf53d44ab
# Detecting a "oneliner" seems to need a state machine.
# This can be done by looking mostly at the "state" (last value):
#
# ENDFN -> BEG (token = '=' ) -> END
#
private def set_kw_end
oneliner_count = 0
in_oneliner_def = nil
kw_count = 0
end_count = 0
@ignore_newline_not_beg = false
@lex.each do |lex|
kw_count += 1 if lex.is_kw?
end_count += 1 if lex.is_end?
if lex.type == :on_ignored_nl
@ignore_newline_not_beg = !lex.expr_beg?
end
if in_oneliner_def.nil?
in_oneliner_def = :ENDFN if lex.state.allbits?(Ripper::EXPR_ENDFN)
elsif lex.state.allbits?(Ripper::EXPR_ENDFN)
# Continue
elsif lex.state.allbits?(Ripper::EXPR_BEG)
in_oneliner_def = :BODY if lex.token == "="
elsif lex.state.allbits?(Ripper::EXPR_END)
# We found an endless method, count it
oneliner_count += 1 if in_oneliner_def == :BODY
in_oneliner_def = nil
else
in_oneliner_def = nil
end
end
kw_count -= oneliner_count
@is_kw = (kw_count - end_count) > 0
@is_end = (end_count - kw_count) > 0
end
end
end
share/ruby/syntax_suggest/code_block.rb 0000644 00000004207 15173517740 0014344 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Multiple lines form a singular CodeBlock
#
# Source code is made of multiple CodeBlocks.
#
# Example:
#
# code_block.to_s # =>
# # def foo
# # puts "foo"
# # end
#
# code_block.valid? # => true
# code_block.in_valid? # => false
#
#
class CodeBlock
UNSET = Object.new.freeze
attr_reader :lines, :starts_at, :ends_at
def initialize(lines: [])
@lines = Array(lines)
@valid = UNSET
@deleted = false
@starts_at = @lines.first.number
@ends_at = @lines.last.number
end
def delete
@deleted = true
end
def deleted?
@deleted
end
def visible_lines
@lines.select(&:visible?).select(&:not_empty?)
end
def mark_invisible
@lines.map(&:mark_invisible)
end
def is_end?
to_s.strip == "end"
end
def hidden?
@lines.all?(&:hidden?)
end
# This is used for frontier ordering, we are searching from
# the largest indentation to the smallest. This allows us to
# populate an array with multiple code blocks then call `sort!`
# on it without having to specify the sorting criteria
def <=>(other)
out = current_indent <=> other.current_indent
return out if out != 0
# Stable sort
starts_at <=> other.starts_at
end
def current_indent
@current_indent ||= lines.select(&:not_empty?).map(&:indent).min || 0
end
def invalid?
!valid?
end
def valid?
if @valid == UNSET
# Performance optimization
#
# If all the lines were previously hidden
# and we expand to capture additional empty
# lines then the result cannot be invalid
#
# That means there's no reason to re-check all
# lines with the parser (which is expensive).
# Benchmark in commit message
@valid = if lines.all? { |l| l.hidden? || l.empty? }
true
else
SyntaxSuggest.valid?(lines.map(&:original).join)
end
else
@valid
end
end
def to_s
@lines.join
end
end
end
share/ruby/syntax_suggest/ripper_errors.rb 0000644 00000001700 15173517740 0015150 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Capture parse errors from Ripper
#
# Prism returns the errors with their messages, but Ripper
# does not. To get them we must make a custom subclass.
#
# Example:
#
# puts RipperErrors.new(" def foo").call.errors
# # => ["syntax error, unexpected end-of-input, expecting ';' or '\\n'"]
class RipperErrors < Ripper
attr_reader :errors
# Comes from ripper, called
# on every parse error, msg
# is a string
def on_parse_error(msg)
@errors ||= []
@errors << msg
end
alias_method :on_alias_error, :on_parse_error
alias_method :on_assign_error, :on_parse_error
alias_method :on_class_name_error, :on_parse_error
alias_method :on_param_error, :on_parse_error
alias_method :compile_error, :on_parse_error
def call
@run_once ||= begin
@errors = []
parse
true
end
self
end
end
end
share/ruby/syntax_suggest/code_search.rb 0000644 00000007501 15173517740 0014517 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Searches code for a syntax error
#
# There are three main phases in the algorithm:
#
# 1. Sanitize/format input source
# 2. Search for invalid blocks
# 3. Format invalid blocks into something meaninful
#
# This class handles the part.
#
# The bulk of the heavy lifting is done in:
#
# - CodeFrontier (Holds information for generating blocks and determining if we can stop searching)
# - ParseBlocksFromLine (Creates blocks into the frontier)
# - BlockExpand (Expands existing blocks to search more code)
#
# ## Syntax error detection
#
# When the frontier holds the syntax error, we can stop searching
#
# search = CodeSearch.new(<<~EOM)
# def dog
# def lol
# end
# EOM
#
# search.call
#
# search.invalid_blocks.map(&:to_s) # =>
# # => ["def lol\n"]
#
class CodeSearch
private
attr_reader :frontier
public
attr_reader :invalid_blocks, :record_dir, :code_lines
def initialize(source, record_dir: DEFAULT_VALUE)
record_dir = if record_dir == DEFAULT_VALUE
(ENV["SYNTAX_SUGGEST_RECORD_DIR"] || ENV["SYNTAX_SUGGEST_DEBUG"]) ? "tmp" : nil
else
record_dir
end
if record_dir
@record_dir = SyntaxSuggest.record_dir(record_dir)
@write_count = 0
end
@tick = 0
@source = source
@name_tick = Hash.new { |hash, k| hash[k] = 0 }
@invalid_blocks = []
@code_lines = CleanDocument.new(source: source).call.lines
@frontier = CodeFrontier.new(code_lines: @code_lines)
@block_expand = BlockExpand.new(code_lines: @code_lines)
@parse_blocks_from_indent_line = ParseBlocksFromIndentLine.new(code_lines: @code_lines)
end
# Used for debugging
def record(block:, name: "record")
return unless @record_dir
@name_tick[name] += 1
filename = "#{@write_count += 1}-#{name}-#{@name_tick[name]}-(#{block.starts_at}__#{block.ends_at}).txt"
if ENV["SYNTAX_SUGGEST_DEBUG"]
puts "\n\n==== #{filename} ===="
puts "\n```#{block.starts_at}..#{block.ends_at}"
puts block
puts "```"
puts " block indent: #{block.current_indent}"
end
@record_dir.join(filename).open(mode: "a") do |f|
document = DisplayCodeWithLineNumbers.new(
lines: @code_lines.select(&:visible?),
terminal: false,
highlight_lines: block.lines
).call
f.write(" Block lines: #{block.starts_at..block.ends_at} (#{name}) \n\n#{document}")
end
end
def push(block, name:)
record(block: block, name: name)
block.mark_invisible if block.valid?
frontier << block
end
# Parses the most indented lines into blocks that are marked
# and added to the frontier
def create_blocks_from_untracked_lines
max_indent = frontier.next_indent_line&.indent
while (line = frontier.next_indent_line) && (line.indent == max_indent)
@parse_blocks_from_indent_line.each_neighbor_block(frontier.next_indent_line) do |block|
push(block, name: "add")
end
end
end
# Given an already existing block in the frontier, expand it to see
# if it contains our invalid syntax
def expand_existing
block = frontier.pop
return unless block
record(block: block, name: "before-expand")
block = @block_expand.call(block)
push(block, name: "expand")
end
# Main search loop
def call
until frontier.holds_all_syntax_errors?
@tick += 1
if frontier.expand?
expand_existing
else
create_blocks_from_untracked_lines
end
end
@invalid_blocks.concat(frontier.detect_invalid_blocks)
@invalid_blocks.sort_by! { |block| block.starts_at }
self
end
end
end
share/ruby/syntax_suggest/code_frontier.rb 0000644 00000013163 15173517740 0015103 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# The main function of the frontier is to hold the edges of our search and to
# evaluate when we can stop searching.
# There are three main phases in the algorithm:
#
# 1. Sanitize/format input source
# 2. Search for invalid blocks
# 3. Format invalid blocks into something meaninful
#
# The Code frontier is a critical part of the second step
#
# ## Knowing where we've been
#
# Once a code block is generated it is added onto the frontier. Then it will be
# sorted by indentation and frontier can be filtered. Large blocks that fully enclose a
# smaller block will cause the smaller block to be evicted.
#
# CodeFrontier#<<(block) # Adds block to frontier
# CodeFrontier#pop # Removes block from frontier
#
# ## Knowing where we can go
#
# Internally the frontier keeps track of "unvisited" lines which are exposed via `next_indent_line`
# when called, this method returns, a line of code with the highest indentation.
#
# The returned line of code can be used to build a CodeBlock and then that code block
# is added back to the frontier. Then, the lines are removed from the
# "unvisited" so we don't double-create the same block.
#
# CodeFrontier#next_indent_line # Shows next line
# CodeFrontier#register_indent_block(block) # Removes lines from unvisited
#
# ## Knowing when to stop
#
# The frontier knows how to check the entire document for a syntax error. When blocks
# are added onto the frontier, they're removed from the document. When all code containing
# syntax errors has been added to the frontier, the document will be parsable without a
# syntax error and the search can stop.
#
# CodeFrontier#holds_all_syntax_errors? # Returns true when frontier holds all syntax errors
#
# ## Filtering false positives
#
# Once the search is completed, the frontier may have multiple blocks that do not contain
# the syntax error. To limit the result to the smallest subset of "invalid blocks" call:
#
# CodeFrontier#detect_invalid_blocks
#
class CodeFrontier
def initialize(code_lines:, unvisited: UnvisitedLines.new(code_lines: code_lines))
@code_lines = code_lines
@unvisited = unvisited
@queue = PriorityEngulfQueue.new
@check_next = true
end
def count
@queue.length
end
# Performance optimization
#
# Parsing with ripper is expensive
# If we know we don't have any blocks with invalid
# syntax, then we know we cannot have found
# the incorrect syntax yet.
#
# When an invalid block is added onto the frontier
# check document state
private def can_skip_check?
check_next = @check_next
@check_next = false
if check_next
false
else
true
end
end
# Returns true if the document is valid with all lines
# removed. By default it checks all blocks in present in
# the frontier array, but can be used for arbitrary arrays
# of codeblocks as well
def holds_all_syntax_errors?(block_array = @queue, can_cache: true)
return false if can_cache && can_skip_check?
without_lines = block_array.to_a.flat_map do |block|
block.lines
end
SyntaxSuggest.valid_without?(
without_lines: without_lines,
code_lines: @code_lines
)
end
# Returns a code block with the largest indentation possible
def pop
@queue.pop
end
def next_indent_line
@unvisited.peek
end
def expand?
return false if @queue.empty?
return true if @unvisited.empty?
frontier_indent = @queue.peek.current_indent
unvisited_indent = next_indent_line.indent
if ENV["SYNTAX_SUGGEST_DEBUG"]
puts "```"
puts @queue.peek
puts "```"
puts " @frontier indent: #{frontier_indent}"
puts " @unvisited indent: #{unvisited_indent}"
end
# Expand all blocks before moving to unvisited lines
frontier_indent >= unvisited_indent
end
# Keeps track of what lines have been added to blocks and which are not yet
# visited.
def register_indent_block(block)
@unvisited.visit_block(block)
self
end
# When one element fully encapsulates another we remove the smaller
# block from the frontier. This prevents double expansions and all-around
# weird behavior. However this guarantee is quite expensive to maintain
def register_engulf_block(block)
end
# Add a block to the frontier
#
# This method ensures the frontier always remains sorted (in indentation order)
# and that each code block's lines are removed from the indentation hash so we
# don't re-evaluate the same line multiple times.
def <<(block)
@unvisited.visit_block(block)
@queue.push(block)
@check_next = true if block.invalid?
self
end
# Example:
#
# combination([:a, :b, :c, :d])
# # => [[:a], [:b], [:c], [:d], [:a, :b], [:a, :c], [:a, :d], [:b, :c], [:b, :d], [:c, :d], [:a, :b, :c], [:a, :b, :d], [:a, :c, :d], [:b, :c, :d], [:a, :b, :c, :d]]
def self.combination(array)
guesses = []
1.upto(array.length).each do |size|
guesses.concat(array.combination(size).to_a)
end
guesses
end
# Given that we know our syntax error exists somewhere in our frontier, we want to find
# the smallest possible set of blocks that contain all the syntax errors
def detect_invalid_blocks
self.class.combination(@queue.to_a.select(&:invalid?)).detect do |block_array|
holds_all_syntax_errors?(block_array, can_cache: false)
end || []
end
end
end
share/ruby/syntax_suggest/clean_document.rb 0000644 00000021356 15173517740 0015244 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Parses and sanitizes source into a lexically aware document
#
# Internally the document is represented by an array with each
# index containing a CodeLine correlating to a line from the source code.
#
# There are three main phases in the algorithm:
#
# 1. Sanitize/format input source
# 2. Search for invalid blocks
# 3. Format invalid blocks into something meaninful
#
# This class handles the first part.
#
# The reason this class exists is to format input source
# for better/easier/cleaner exploration.
#
# The CodeSearch class operates at the line level so
# we must be careful to not introduce lines that look
# valid by themselves, but when removed will trigger syntax errors
# or strange behavior.
#
# ## Join Trailing slashes
#
# Code with a trailing slash is logically treated as a single line:
#
# 1 it "code can be split" \
# 2 "across multiple lines" do
#
# In this case removing line 2 would add a syntax error. We get around
# this by internally joining the two lines into a single "line" object
#
# ## Logically Consecutive lines
#
# Code that can be broken over multiple
# lines such as method calls are on different lines:
#
# 1 User.
# 2 where(name: "schneems").
# 3 first
#
# Removing line 2 can introduce a syntax error. To fix this, all lines
# are joined into one.
#
# ## Heredocs
#
# A heredoc is an way of defining a multi-line string. They can cause many
# problems. If left as a single line, the parser would try to parse the contents
# as ruby code rather than as a string. Even without this problem, we still
# hit an issue with indentation:
#
# 1 foo = <<~HEREDOC
# 2 "Be yourself; everyone else is already taken.""
# 3 ― Oscar Wilde
# 4 puts "I look like ruby code" # but i'm still a heredoc
# 5 HEREDOC
#
# If we didn't join these lines then our algorithm would think that line 4
# is separate from the rest, has a higher indentation, then look at it first
# and remove it.
#
# If the code evaluates line 5 by itself it will think line 5 is a constant,
# remove it, and introduce a syntax errror.
#
# All of these problems are fixed by joining the whole heredoc into a single
# line.
#
# ## Comments and whitespace
#
# Comments can throw off the way the lexer tells us that the line
# logically belongs with the next line. This is valid ruby but
# results in a different lex output than before:
#
# 1 User.
# 2 where(name: "schneems").
# 3 # Comment here
# 4 first
#
# To handle this we can replace comment lines with empty lines
# and then re-lex the source. This removal and re-lexing preserves
# line index and document size, but generates an easier to work with
# document.
#
class CleanDocument
def initialize(source:)
lines = clean_sweep(source: source)
@document = CodeLine.from_source(lines.join, lines: lines)
end
# Call all of the document "cleaners"
# and return self
def call
join_trailing_slash!
join_consecutive!
join_heredoc!
self
end
# Return an array of CodeLines in the
# document
def lines
@document
end
# Renders the document back to a string
def to_s
@document.join
end
# Remove comments
#
# replace with empty newlines
#
# source = <<~'EOM'
# # Comment 1
# puts "hello"
# # Comment 2
# puts "world"
# EOM
#
# lines = CleanDocument.new(source: source).lines
# expect(lines[0].to_s).to eq("\n")
# expect(lines[1].to_s).to eq("puts "hello")
# expect(lines[2].to_s).to eq("\n")
# expect(lines[3].to_s).to eq("puts "world")
#
# Important: This must be done before lexing.
#
# After this change is made, we lex the document because
# removing comments can change how the doc is parsed.
#
# For example:
#
# values = LexAll.new(source: <<~EOM))
# User.
# # comment
# where(name: 'schneems')
# EOM
# expect(
# values.count {|v| v.type == :on_ignored_nl}
# ).to eq(1)
#
# After the comment is removed:
#
# values = LexAll.new(source: <<~EOM))
# User.
#
# where(name: 'schneems')
# EOM
# expect(
# values.count {|v| v.type == :on_ignored_nl}
# ).to eq(2)
#
def clean_sweep(source:)
# Match comments, but not HEREDOC strings with #{variable} interpolation
# https://rubular.com/r/HPwtW9OYxKUHXQ
source.lines.map do |line|
if line.match?(/^\s*#([^{].*|)$/)
$/
else
line
end
end
end
# Smushes all heredoc lines into one line
#
# source = <<~'EOM'
# foo = <<~HEREDOC
# lol
# hehehe
# HEREDOC
# EOM
#
# lines = CleanDocument.new(source: source).join_heredoc!.lines
# expect(lines[0].to_s).to eq(source)
# expect(lines[1].to_s).to eq("")
def join_heredoc!
start_index_stack = []
heredoc_beg_end_index = []
lines.each do |line|
line.lex.each do |lex_value|
case lex_value.type
when :on_heredoc_beg
start_index_stack << line.index
when :on_heredoc_end
start_index = start_index_stack.pop
end_index = line.index
heredoc_beg_end_index << [start_index, end_index]
end
end
end
heredoc_groups = heredoc_beg_end_index.map { |start_index, end_index| @document[start_index..end_index] }
join_groups(heredoc_groups)
self
end
# Smushes logically "consecutive" lines
#
# source = <<~'EOM'
# User.
# where(name: 'schneems').
# first
# EOM
#
# lines = CleanDocument.new(source: source).join_consecutive!.lines
# expect(lines[0].to_s).to eq(source)
# expect(lines[1].to_s).to eq("")
#
# The one known case this doesn't handle is:
#
# Ripper.lex <<~EOM
# a &&
# b ||
# c
# EOM
#
# For some reason this introduces `on_ignore_newline` but with BEG type
#
def join_consecutive!
consecutive_groups = @document.select(&:ignore_newline_not_beg?).map do |code_line|
take_while_including(code_line.index..) do |line|
line.ignore_newline_not_beg?
end
end
join_groups(consecutive_groups)
self
end
# Join lines with a trailing slash
#
# source = <<~'EOM'
# it "code can be split" \
# "across multiple lines" do
# EOM
#
# lines = CleanDocument.new(source: source).join_consecutive!.lines
# expect(lines[0].to_s).to eq(source)
# expect(lines[1].to_s).to eq("")
def join_trailing_slash!
trailing_groups = @document.select(&:trailing_slash?).map do |code_line|
take_while_including(code_line.index..) { |x| x.trailing_slash? }
end
join_groups(trailing_groups)
self
end
# Helper method for joining "groups" of lines
#
# Input is expected to be type Array<Array<CodeLine>>
#
# The outer array holds the various "groups" while the
# inner array holds code lines.
#
# All code lines are "joined" into the first line in
# their group.
#
# To preserve document size, empty lines are placed
# in the place of the lines that were "joined"
def join_groups(groups)
groups.each do |lines|
line = lines.first
# Handle the case of multiple groups in a row
# if one is already replaced, move on
next if @document[line.index].empty?
# Join group into the first line
@document[line.index] = CodeLine.new(
lex: lines.map(&:lex).flatten,
line: lines.join,
index: line.index
)
# Hide the rest of the lines
lines[1..].each do |line|
# The above lines already have newlines in them, if add more
# then there will be double newline, use an empty line instead
@document[line.index] = CodeLine.new(line: "", index: line.index, lex: [])
end
end
self
end
# Helper method for grabbing elements from document
#
# Like `take_while` except when it stops
# iterating, it also returns the line
# that caused it to stop
def take_while_including(range = 0..)
take_next_and_stop = false
@document[range].take_while do |line|
next if take_next_and_stop
take_next_and_stop = !(yield line)
true
end
end
end
end
share/ruby/syntax_suggest/capture_code_context.rb 0000644 00000015251 15173517740 0016462 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
module Capture
end
end
require_relative "capture/falling_indent_lines"
require_relative "capture/before_after_keyword_ends"
module SyntaxSuggest
# Turns a "invalid block(s)" into useful context
#
# There are three main phases in the algorithm:
#
# 1. Sanitize/format input source
# 2. Search for invalid blocks
# 3. Format invalid blocks into something meaninful
#
# This class handles the third part.
#
# The algorithm is very good at capturing all of a syntax
# error in a single block in number 2, however the results
# can contain ambiguities. Humans are good at pattern matching
# and filtering and can mentally remove extraneous data, but
# they can't add extra data that's not present.
#
# In the case of known ambiguious cases, this class adds context
# back to the ambiguity so the programmer has full information.
#
# Beyond handling these ambiguities, it also captures surrounding
# code context information:
#
# puts block.to_s # => "def bark"
#
# context = CaptureCodeContext.new(
# blocks: block,
# code_lines: code_lines
# )
#
# lines = context.call.map(&:original)
# puts lines.join
# # =>
# class Dog
# def bark
# end
#
class CaptureCodeContext
attr_reader :code_lines
def initialize(blocks:, code_lines:)
@blocks = Array(blocks)
@code_lines = code_lines
@visible_lines = @blocks.map(&:visible_lines).flatten
@lines_to_output = @visible_lines.dup
end
def call
@blocks.each do |block|
capture_first_kw_end_same_indent(block)
capture_last_end_same_indent(block)
capture_before_after_kws(block)
capture_falling_indent(block)
end
sorted_lines
end
def sorted_lines
@lines_to_output.select!(&:not_empty?)
@lines_to_output.uniq!
@lines_to_output.sort!
@lines_to_output
end
# Shows the context around code provided by "falling" indentation
#
# Converts:
#
# it "foo" do
#
# into:
#
# class OH
# def hello
# it "foo" do
# end
# end
#
def capture_falling_indent(block)
Capture::FallingIndentLines.new(
block: block,
code_lines: @code_lines
).call do |line|
@lines_to_output << line
end
end
# Shows surrounding kw/end pairs
#
# The purpose of showing these extra pairs is due to cases
# of ambiguity when only one visible line is matched.
#
# For example:
#
# 1 class Dog
# 2 def bark
# 4 def eat
# 5 end
# 6 end
#
# In this case either line 2 could be missing an `end` or
# line 4 was an extra line added by mistake (it happens).
#
# When we detect the above problem it shows the issue
# as only being on line 2
#
# 2 def bark
#
# Showing "neighbor" keyword pairs gives extra context:
#
# 2 def bark
# 4 def eat
# 5 end
#
def capture_before_after_kws(block)
return unless block.visible_lines.count == 1
around_lines = Capture::BeforeAfterKeywordEnds.new(
code_lines: @code_lines,
block: block
).call
around_lines -= block.lines
@lines_to_output.concat(around_lines)
end
# When there is an invalid block with a keyword
# missing an end right before another end,
# it is unclear where which keyword is missing the
# end
#
# Take this example:
#
# class Dog # 1
# def bark # 2
# puts "woof" # 3
# end # 4
#
# However due to https://github.com/ruby/syntax_suggest/issues/32
# the problem line will be identified as:
#
# > class Dog # 1
#
# Because lines 2, 3, and 4 are technically valid code and are expanded
# first, deemed valid, and hidden. We need to un-hide the matching end
# line 4. Also work backwards and if there's a mis-matched keyword, show it
# too
def capture_last_end_same_indent(block)
return if block.visible_lines.length != 1
return unless block.visible_lines.first.is_kw?
visible_line = block.visible_lines.first
lines = @code_lines[visible_line.index..block.lines.last.index]
# Find first end with same indent
# (this would return line 4)
#
# end # 4
matching_end = lines.detect { |line| line.indent == block.current_indent && line.is_end? }
return unless matching_end
@lines_to_output << matching_end
# Work backwards from the end to
# see if there are mis-matched
# keyword/end pairs
#
# Return the first mis-matched keyword
# this would find line 2
#
# def bark # 2
# puts "woof" # 3
# end # 4
end_count = 0
kw_count = 0
kw_line = @code_lines[visible_line.index..matching_end.index].reverse.detect do |line|
end_count += 1 if line.is_end?
kw_count += 1 if line.is_kw?
!kw_count.zero? && kw_count >= end_count
end
return unless kw_line
@lines_to_output << kw_line
end
# The logical inverse of `capture_last_end_same_indent`
#
# When there is an invalid block with an `end`
# missing a keyword right after another `end`,
# it is unclear where which end is missing the
# keyword.
#
# Take this example:
#
# class Dog # 1
# puts "woof" # 2
# end # 3
# end # 4
#
# the problem line will be identified as:
#
# > end # 4
#
# This happens because lines 1, 2, and 3 are technically valid code and are expanded
# first, deemed valid, and hidden. We need to un-hide the matching keyword on
# line 1. Also work backwards and if there's a mis-matched end, show it
# too
def capture_first_kw_end_same_indent(block)
return if block.visible_lines.length != 1
return unless block.visible_lines.first.is_end?
visible_line = block.visible_lines.first
lines = @code_lines[block.lines.first.index..visible_line.index]
matching_kw = lines.reverse.detect { |line| line.indent == block.current_indent && line.is_kw? }
return unless matching_kw
@lines_to_output << matching_kw
kw_count = 0
end_count = 0
orphan_end = @code_lines[matching_kw.index..visible_line.index].detect do |line|
kw_count += 1 if line.is_kw?
end_count += 1 if line.is_end?
end_count >= kw_count
end
return unless orphan_end
@lines_to_output << orphan_end
end
end
end
share/ruby/syntax_suggest/unvisited_lines.rb 0000644 00000001301 15173517740 0015454 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Tracks which lines various code blocks have expanded to
# and which are still unexplored
class UnvisitedLines
def initialize(code_lines:)
@unvisited = code_lines.sort_by(&:indent_index)
@visited_lines = {}
@visited_lines.compare_by_identity
end
def empty?
@unvisited.empty?
end
def peek
@unvisited.last
end
def pop
@unvisited.pop
end
def visit_block(block)
block.lines.each do |line|
next if @visited_lines[line]
@visited_lines[line] = true
end
while @visited_lines[@unvisited.last]
@unvisited.pop
end
end
end
end
share/ruby/syntax_suggest/priority_queue.rb 0000644 00000003776 15173517740 0015357 0 ustar 00 # frozen_string_literal: true
module SyntaxSuggest
# Holds elements in a priority heap on insert
#
# Instead of constantly calling `sort!`, put
# the element where it belongs the first time
# around
#
# Example:
#
# queue = PriorityQueue.new
# queue << 33
# queue << 44
# queue << 1
#
# puts queue.peek # => 44
#
class PriorityQueue
attr_reader :elements
def initialize
@elements = []
end
def <<(element)
@elements << element
bubble_up(last_index, element)
end
def pop
exchange(0, last_index)
max = @elements.pop
bubble_down(0)
max
end
def length
@elements.length
end
def empty?
@elements.empty?
end
def peek
@elements.first
end
def to_a
@elements
end
# Used for testing, extremely not performant
def sorted
out = []
elements = @elements.dup
while (element = pop)
out << element
end
@elements = elements
out.reverse
end
private def last_index
@elements.size - 1
end
private def bubble_up(index, element)
return if index <= 0
parent_index = (index - 1) / 2
parent = @elements[parent_index]
return if (parent <=> element) >= 0
exchange(index, parent_index)
bubble_up(parent_index, element)
end
private def bubble_down(index)
child_index = (index * 2) + 1
return if child_index > last_index
not_the_last_element = child_index < last_index
left_element = @elements[child_index]
right_element = @elements[child_index + 1]
child_index += 1 if not_the_last_element && (right_element <=> left_element) == 1
return if (@elements[index] <=> @elements[child_index]) >= 0
exchange(index, child_index)
bubble_down(child_index)
end
def exchange(source, target)
a = @elements[source]
b = @elements[target]
@elements[source] = b
@elements[target] = a
end
end
end
share/ruby/tsort.rb 0000644 00000034445 15173517740 0010353 0 ustar 00 # frozen_string_literal: true
#--
# tsort.rb - provides a module for topological sorting and strongly connected components.
#++
#
#
# TSort implements topological sorting using Tarjan's algorithm for
# strongly connected components.
#
# TSort is designed to be able to be used with any object which can be
# interpreted as a directed graph.
#
# TSort requires two methods to interpret an object as a graph,
# tsort_each_node and tsort_each_child.
#
# * tsort_each_node is used to iterate for all nodes over a graph.
# * tsort_each_child is used to iterate for child nodes of a given node.
#
# The equality of nodes are defined by eql? and hash since
# TSort uses Hash internally.
#
# == A Simple Example
#
# The following example demonstrates how to mix the TSort module into an
# existing class (in this case, Hash). Here, we're treating each key in
# the hash as a node in the graph, and so we simply alias the required
# #tsort_each_node method to Hash's #each_key method. For each key in the
# hash, the associated value is an array of the node's child nodes. This
# choice in turn leads to our implementation of the required #tsort_each_child
# method, which fetches the array of child nodes and then iterates over that
# array using the user-supplied block.
#
# require 'tsort'
#
# class Hash
# include TSort
# alias tsort_each_node each_key
# def tsort_each_child(node, &block)
# fetch(node).each(&block)
# end
# end
#
# {1=>[2, 3], 2=>[3], 3=>[], 4=>[]}.tsort
# #=> [3, 2, 1, 4]
#
# {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}.strongly_connected_components
# #=> [[4], [2, 3], [1]]
#
# == A More Realistic Example
#
# A very simple `make' like tool can be implemented as follows:
#
# require 'tsort'
#
# class Make
# def initialize
# @dep = {}
# @dep.default = []
# end
#
# def rule(outputs, inputs=[], &block)
# triple = [outputs, inputs, block]
# outputs.each {|f| @dep[f] = [triple]}
# @dep[triple] = inputs
# end
#
# def build(target)
# each_strongly_connected_component_from(target) {|ns|
# if ns.length != 1
# fs = ns.delete_if {|n| Array === n}
# raise TSort::Cyclic.new("cyclic dependencies: #{fs.join ', '}")
# end
# n = ns.first
# if Array === n
# outputs, inputs, block = n
# inputs_time = inputs.map {|f| File.mtime f}.max
# begin
# outputs_time = outputs.map {|f| File.mtime f}.min
# rescue Errno::ENOENT
# outputs_time = nil
# end
# if outputs_time == nil ||
# inputs_time != nil && outputs_time <= inputs_time
# sleep 1 if inputs_time != nil && inputs_time.to_i == Time.now.to_i
# block.call
# end
# end
# }
# end
#
# def tsort_each_child(node, &block)
# @dep[node].each(&block)
# end
# include TSort
# end
#
# def command(arg)
# print arg, "\n"
# system arg
# end
#
# m = Make.new
# m.rule(%w[t1]) { command 'date > t1' }
# m.rule(%w[t2]) { command 'date > t2' }
# m.rule(%w[t3]) { command 'date > t3' }
# m.rule(%w[t4], %w[t1 t3]) { command 'cat t1 t3 > t4' }
# m.rule(%w[t5], %w[t4 t2]) { command 'cat t4 t2 > t5' }
# m.build('t5')
#
# == Bugs
#
# * 'tsort.rb' is wrong name because this library uses
# Tarjan's algorithm for strongly connected components.
# Although 'strongly_connected_components.rb' is correct but too long.
#
# == References
#
# R. E. Tarjan, "Depth First Search and Linear Graph Algorithms",
# <em>SIAM Journal on Computing</em>, Vol. 1, No. 2, pp. 146-160, June 1972.
#
module TSort
VERSION = "0.2.0"
class Cyclic < StandardError
end
# Returns a topologically sorted array of nodes.
# The array is sorted from children to parents, i.e.
# the first element has no child and the last node has no parent.
#
# If there is a cycle, TSort::Cyclic is raised.
#
# class G
# include TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# p graph.tsort #=> [4, 2, 3, 1]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# p graph.tsort # raises TSort::Cyclic
#
def tsort
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
TSort.tsort(each_node, each_child)
end
# Returns a topologically sorted array of nodes.
# The array is sorted from children to parents, i.e.
# the first element has no child and the last node has no parent.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# If there is a cycle, TSort::Cyclic is raised.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p TSort.tsort(each_node, each_child) #=> [4, 2, 3, 1]
#
# g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p TSort.tsort(each_node, each_child) # raises TSort::Cyclic
#
def self.tsort(each_node, each_child)
tsort_each(each_node, each_child).to_a
end
# The iterator version of the #tsort method.
# <tt><em>obj</em>.tsort_each</tt> is similar to <tt><em>obj</em>.tsort.each</tt>, but
# modification of _obj_ during the iteration may lead to unexpected results.
#
# #tsort_each returns +nil+.
# If there is a cycle, TSort::Cyclic is raised.
#
# class G
# include TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# graph.tsort_each {|n| p n }
# #=> 4
# # 2
# # 3
# # 1
#
def tsort_each(&block) # :yields: node
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
TSort.tsort_each(each_node, each_child, &block)
end
# The iterator version of the TSort.tsort method.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# TSort.tsort_each(each_node, each_child) {|n| p n }
# #=> 4
# # 2
# # 3
# # 1
#
def self.tsort_each(each_node, each_child) # :yields: node
return to_enum(__method__, each_node, each_child) unless block_given?
each_strongly_connected_component(each_node, each_child) {|component|
if component.size == 1
yield component.first
else
raise Cyclic.new("topological sort failed: #{component.inspect}")
end
}
end
# Returns strongly connected components as an array of arrays of nodes.
# The array is sorted from children to parents.
# Each elements of the array represents a strongly connected component.
#
# class G
# include TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# p graph.strongly_connected_components #=> [[4], [2], [3], [1]]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# p graph.strongly_connected_components #=> [[4], [2, 3], [1]]
#
def strongly_connected_components
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
TSort.strongly_connected_components(each_node, each_child)
end
# Returns strongly connected components as an array of arrays of nodes.
# The array is sorted from children to parents.
# Each elements of the array represents a strongly connected component.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p TSort.strongly_connected_components(each_node, each_child)
# #=> [[4], [2], [3], [1]]
#
# g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p TSort.strongly_connected_components(each_node, each_child)
# #=> [[4], [2, 3], [1]]
#
def self.strongly_connected_components(each_node, each_child)
each_strongly_connected_component(each_node, each_child).to_a
end
# The iterator version of the #strongly_connected_components method.
# <tt><em>obj</em>.each_strongly_connected_component</tt> is similar to
# <tt><em>obj</em>.strongly_connected_components.each</tt>, but
# modification of _obj_ during the iteration may lead to unexpected results.
#
# #each_strongly_connected_component returns +nil+.
#
# class G
# include TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# graph.each_strongly_connected_component {|scc| p scc }
# #=> [4]
# # [2]
# # [3]
# # [1]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# graph.each_strongly_connected_component {|scc| p scc }
# #=> [4]
# # [2, 3]
# # [1]
#
def each_strongly_connected_component(&block) # :yields: nodes
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
TSort.each_strongly_connected_component(each_node, each_child, &block)
end
# The iterator version of the TSort.strongly_connected_components method.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# TSort.each_strongly_connected_component(each_node, each_child) {|scc| p scc }
# #=> [4]
# # [2]
# # [3]
# # [1]
#
# g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# TSort.each_strongly_connected_component(each_node, each_child) {|scc| p scc }
# #=> [4]
# # [2, 3]
# # [1]
#
def self.each_strongly_connected_component(each_node, each_child) # :yields: nodes
return to_enum(__method__, each_node, each_child) unless block_given?
id_map = {}
stack = []
each_node.call {|node|
unless id_map.include? node
each_strongly_connected_component_from(node, each_child, id_map, stack) {|c|
yield c
}
end
}
nil
end
# Iterates over strongly connected component in the subgraph reachable from
# _node_.
#
# Return value is unspecified.
#
# #each_strongly_connected_component_from doesn't call #tsort_each_node.
#
# class G
# include TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# graph.each_strongly_connected_component_from(2) {|scc| p scc }
# #=> [4]
# # [2]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# graph.each_strongly_connected_component_from(2) {|scc| p scc }
# #=> [4]
# # [2, 3]
#
def each_strongly_connected_component_from(node, id_map={}, stack=[], &block) # :yields: nodes
TSort.each_strongly_connected_component_from(node, method(:tsort_each_child), id_map, stack, &block)
end
# Iterates over strongly connected components in a graph.
# The graph is represented by _node_ and _each_child_.
#
# _node_ is the first node.
# _each_child_ should have +call+ method which takes a node argument
# and yields for each child node.
#
# Return value is unspecified.
#
# #TSort.each_strongly_connected_component_from is a class method and
# it doesn't need a class to represent a graph which includes TSort.
#
# graph = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_child = lambda {|n, &b| graph[n].each(&b) }
# TSort.each_strongly_connected_component_from(1, each_child) {|scc|
# p scc
# }
# #=> [4]
# # [2, 3]
# # [1]
#
def self.each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) # :yields: nodes
return to_enum(__method__, node, each_child, id_map, stack) unless block_given?
minimum_id = node_id = id_map[node] = id_map.size
stack_length = stack.length
stack << node
each_child.call(node) {|child|
if id_map.include? child
child_id = id_map[child]
minimum_id = child_id if child_id && child_id < minimum_id
else
sub_minimum_id =
each_strongly_connected_component_from(child, each_child, id_map, stack) {|c|
yield c
}
minimum_id = sub_minimum_id if sub_minimum_id < minimum_id
end
}
if node_id == minimum_id
component = stack.slice!(stack_length .. -1)
component.each {|n| id_map[n] = nil}
yield component
end
minimum_id
end
# Should be implemented by a extended class.
#
# #tsort_each_node is used to iterate for all nodes over a graph.
#
def tsort_each_node # :yields: node
raise NotImplementedError.new
end
# Should be implemented by a extended class.
#
# #tsort_each_child is used to iterate for child nodes of _node_.
#
def tsort_each_child(node) # :yields: child
raise NotImplementedError.new
end
end
share/ruby/resolv.rb 0000644 00000252033 15173517740 0010505 0 ustar 00 # frozen_string_literal: true
require 'socket'
require 'timeout'
require 'io/wait'
begin
require 'securerandom'
rescue LoadError
end
# Resolv is a thread-aware DNS resolver library written in Ruby. Resolv can
# handle multiple DNS requests concurrently without blocking the entire Ruby
# interpreter.
#
# See also resolv-replace.rb to replace the libc resolver with Resolv.
#
# Resolv can look up various DNS resources using the DNS module directly.
#
# Examples:
#
# p Resolv.getaddress "www.ruby-lang.org"
# p Resolv.getname "210.251.121.214"
#
# Resolv::DNS.open do |dns|
# ress = dns.getresources "www.ruby-lang.org", Resolv::DNS::Resource::IN::A
# p ress.map(&:address)
# ress = dns.getresources "ruby-lang.org", Resolv::DNS::Resource::IN::MX
# p ress.map { |r| [r.exchange.to_s, r.preference] }
# end
#
#
# == Bugs
#
# * NIS is not supported.
# * /etc/nsswitch.conf is not supported.
class Resolv
VERSION = "0.3.0"
##
# Looks up the first IP address for +name+.
def self.getaddress(name)
DefaultResolver.getaddress(name)
end
##
# Looks up all IP address for +name+.
def self.getaddresses(name)
DefaultResolver.getaddresses(name)
end
##
# Iterates over all IP addresses for +name+.
def self.each_address(name, &block)
DefaultResolver.each_address(name, &block)
end
##
# Looks up the hostname of +address+.
def self.getname(address)
DefaultResolver.getname(address)
end
##
# Looks up all hostnames for +address+.
def self.getnames(address)
DefaultResolver.getnames(address)
end
##
# Iterates over all hostnames for +address+.
def self.each_name(address, &proc)
DefaultResolver.each_name(address, &proc)
end
##
# Creates a new Resolv using +resolvers+.
def initialize(resolvers=nil, use_ipv6: nil)
@resolvers = resolvers || [Hosts.new, DNS.new(DNS::Config.default_config_hash.merge(use_ipv6: use_ipv6))]
end
##
# Looks up the first IP address for +name+.
def getaddress(name)
each_address(name) {|address| return address}
raise ResolvError.new("no address for #{name}")
end
##
# Looks up all IP address for +name+.
def getaddresses(name)
ret = []
each_address(name) {|address| ret << address}
return ret
end
##
# Iterates over all IP addresses for +name+.
def each_address(name)
if AddressRegex =~ name
yield name
return
end
yielded = false
@resolvers.each {|r|
r.each_address(name) {|address|
yield address.to_s
yielded = true
}
return if yielded
}
end
##
# Looks up the hostname of +address+.
def getname(address)
each_name(address) {|name| return name}
raise ResolvError.new("no name for #{address}")
end
##
# Looks up all hostnames for +address+.
def getnames(address)
ret = []
each_name(address) {|name| ret << name}
return ret
end
##
# Iterates over all hostnames for +address+.
def each_name(address)
yielded = false
@resolvers.each {|r|
r.each_name(address) {|name|
yield name.to_s
yielded = true
}
return if yielded
}
end
##
# Indicates a failure to resolve a name or address.
class ResolvError < StandardError; end
##
# Indicates a timeout resolving a name or address.
class ResolvTimeout < Timeout::Error; end
##
# Resolv::Hosts is a hostname resolver that uses the system hosts file.
class Hosts
if /mswin|mingw|cygwin/ =~ RUBY_PLATFORM and
begin
require 'win32/resolv'
DefaultFileName = Win32::Resolv.get_hosts_path || IO::NULL
rescue LoadError
end
end
DefaultFileName ||= '/etc/hosts'
##
# Creates a new Resolv::Hosts, using +filename+ for its data source.
def initialize(filename = DefaultFileName)
@filename = filename
@mutex = Thread::Mutex.new
@initialized = nil
end
def lazy_initialize # :nodoc:
@mutex.synchronize {
unless @initialized
@name2addr = {}
@addr2name = {}
File.open(@filename, 'rb') {|f|
f.each {|line|
line.sub!(/#.*/, '')
addr, hostname, *aliases = line.split(/\s+/)
next unless addr
@addr2name[addr] = [] unless @addr2name.include? addr
@addr2name[addr] << hostname
@addr2name[addr].concat(aliases)
@name2addr[hostname] = [] unless @name2addr.include? hostname
@name2addr[hostname] << addr
aliases.each {|n|
@name2addr[n] = [] unless @name2addr.include? n
@name2addr[n] << addr
}
}
}
@name2addr.each {|name, arr| arr.reverse!}
@initialized = true
end
}
self
end
##
# Gets the IP address of +name+ from the hosts file.
def getaddress(name)
each_address(name) {|address| return address}
raise ResolvError.new("#{@filename} has no name: #{name}")
end
##
# Gets all IP addresses for +name+ from the hosts file.
def getaddresses(name)
ret = []
each_address(name) {|address| ret << address}
return ret
end
##
# Iterates over all IP addresses for +name+ retrieved from the hosts file.
def each_address(name, &proc)
lazy_initialize
@name2addr[name]&.each(&proc)
end
##
# Gets the hostname of +address+ from the hosts file.
def getname(address)
each_name(address) {|name| return name}
raise ResolvError.new("#{@filename} has no address: #{address}")
end
##
# Gets all hostnames for +address+ from the hosts file.
def getnames(address)
ret = []
each_name(address) {|name| ret << name}
return ret
end
##
# Iterates over all hostnames for +address+ retrieved from the hosts file.
def each_name(address, &proc)
lazy_initialize
@addr2name[address]&.each(&proc)
end
end
##
# Resolv::DNS is a DNS stub resolver.
#
# Information taken from the following places:
#
# * STD0013
# * RFC 1035
# * ftp://ftp.isi.edu/in-notes/iana/assignments/dns-parameters
# * etc.
class DNS
##
# Default DNS Port
Port = 53
##
# Default DNS UDP packet size
UDPSize = 512
##
# Creates a new DNS resolver. See Resolv::DNS.new for argument details.
#
# Yields the created DNS resolver to the block, if given, otherwise
# returns it.
def self.open(*args)
dns = new(*args)
return dns unless block_given?
begin
yield dns
ensure
dns.close
end
end
##
# Creates a new DNS resolver.
#
# +config_info+ can be:
#
# nil:: Uses /etc/resolv.conf.
# String:: Path to a file using /etc/resolv.conf's format.
# Hash:: Must contain :nameserver, :search and :ndots keys.
# :nameserver_port can be used to specify port number of nameserver address.
# :raise_timeout_errors can be used to raise timeout errors
# as exceptions instead of treating the same as an NXDOMAIN response.
#
# The value of :nameserver should be an address string or
# an array of address strings.
# - :nameserver => '8.8.8.8'
# - :nameserver => ['8.8.8.8', '8.8.4.4']
#
# The value of :nameserver_port should be an array of
# pair of nameserver address and port number.
# - :nameserver_port => [['8.8.8.8', 53], ['8.8.4.4', 53]]
#
# Example:
#
# Resolv::DNS.new(:nameserver => ['210.251.121.21'],
# :search => ['ruby-lang.org'],
# :ndots => 1)
def initialize(config_info=nil)
@mutex = Thread::Mutex.new
@config = Config.new(config_info)
@initialized = nil
end
# Sets the resolver timeouts. This may be a single positive number
# or an array of positive numbers representing timeouts in seconds.
# If an array is specified, a DNS request will retry and wait for
# each successive interval in the array until a successful response
# is received. Specifying +nil+ reverts to the default timeouts:
# [ 5, second = 5 * 2 / nameserver_count, 2 * second, 4 * second ]
#
# Example:
#
# dns.timeouts = 3
#
def timeouts=(values)
@config.timeouts = values
end
def lazy_initialize # :nodoc:
@mutex.synchronize {
unless @initialized
@config.lazy_initialize
@initialized = true
end
}
self
end
##
# Closes the DNS resolver.
def close
@mutex.synchronize {
if @initialized
@initialized = false
end
}
end
##
# Gets the IP address of +name+ from the DNS resolver.
#
# +name+ can be a Resolv::DNS::Name or a String. Retrieved address will
# be a Resolv::IPv4 or Resolv::IPv6
def getaddress(name)
each_address(name) {|address| return address}
raise ResolvError.new("DNS result has no information for #{name}")
end
##
# Gets all IP addresses for +name+ from the DNS resolver.
#
# +name+ can be a Resolv::DNS::Name or a String. Retrieved addresses will
# be a Resolv::IPv4 or Resolv::IPv6
def getaddresses(name)
ret = []
each_address(name) {|address| ret << address}
return ret
end
##
# Iterates over all IP addresses for +name+ retrieved from the DNS
# resolver.
#
# +name+ can be a Resolv::DNS::Name or a String. Retrieved addresses will
# be a Resolv::IPv4 or Resolv::IPv6
def each_address(name)
each_resource(name, Resource::IN::A) {|resource| yield resource.address}
if use_ipv6?
each_resource(name, Resource::IN::AAAA) {|resource| yield resource.address}
end
end
def use_ipv6? # :nodoc:
use_ipv6 = @config.use_ipv6?
unless use_ipv6.nil?
return use_ipv6
end
begin
list = Socket.ip_address_list
rescue NotImplementedError
return true
end
list.any? {|a| a.ipv6? && !a.ipv6_loopback? && !a.ipv6_linklocal? }
end
private :use_ipv6?
##
# Gets the hostname for +address+ from the DNS resolver.
#
# +address+ must be a Resolv::IPv4, Resolv::IPv6 or a String. Retrieved
# name will be a Resolv::DNS::Name.
def getname(address)
each_name(address) {|name| return name}
raise ResolvError.new("DNS result has no information for #{address}")
end
##
# Gets all hostnames for +address+ from the DNS resolver.
#
# +address+ must be a Resolv::IPv4, Resolv::IPv6 or a String. Retrieved
# names will be Resolv::DNS::Name instances.
def getnames(address)
ret = []
each_name(address) {|name| ret << name}
return ret
end
##
# Iterates over all hostnames for +address+ retrieved from the DNS
# resolver.
#
# +address+ must be a Resolv::IPv4, Resolv::IPv6 or a String. Retrieved
# names will be Resolv::DNS::Name instances.
def each_name(address)
case address
when Name
ptr = address
when IPv4, IPv6
ptr = address.to_name
when IPv4::Regex
ptr = IPv4.create(address).to_name
when IPv6::Regex
ptr = IPv6.create(address).to_name
else
raise ResolvError.new("cannot interpret as address: #{address}")
end
each_resource(ptr, Resource::IN::PTR) {|resource| yield resource.name}
end
##
# Look up the +typeclass+ DNS resource of +name+.
#
# +name+ must be a Resolv::DNS::Name or a String.
#
# +typeclass+ should be one of the following:
#
# * Resolv::DNS::Resource::IN::A
# * Resolv::DNS::Resource::IN::AAAA
# * Resolv::DNS::Resource::IN::ANY
# * Resolv::DNS::Resource::IN::CNAME
# * Resolv::DNS::Resource::IN::HINFO
# * Resolv::DNS::Resource::IN::MINFO
# * Resolv::DNS::Resource::IN::MX
# * Resolv::DNS::Resource::IN::NS
# * Resolv::DNS::Resource::IN::PTR
# * Resolv::DNS::Resource::IN::SOA
# * Resolv::DNS::Resource::IN::TXT
# * Resolv::DNS::Resource::IN::WKS
#
# Returned resource is represented as a Resolv::DNS::Resource instance,
# i.e. Resolv::DNS::Resource::IN::A.
def getresource(name, typeclass)
each_resource(name, typeclass) {|resource| return resource}
raise ResolvError.new("DNS result has no information for #{name}")
end
##
# Looks up all +typeclass+ DNS resources for +name+. See #getresource for
# argument details.
def getresources(name, typeclass)
ret = []
each_resource(name, typeclass) {|resource| ret << resource}
return ret
end
##
# Iterates over all +typeclass+ DNS resources for +name+. See
# #getresource for argument details.
def each_resource(name, typeclass, &proc)
fetch_resource(name, typeclass) {|reply, reply_name|
extract_resources(reply, reply_name, typeclass, &proc)
}
end
def fetch_resource(name, typeclass)
lazy_initialize
begin
requester = make_udp_requester
rescue Errno::EACCES
# fall back to TCP
end
senders = {}
begin
@config.resolv(name) {|candidate, tout, nameserver, port|
requester ||= make_tcp_requester(nameserver, port)
msg = Message.new
msg.rd = 1
msg.add_question(candidate, typeclass)
unless sender = senders[[candidate, nameserver, port]]
sender = requester.sender(msg, candidate, nameserver, port)
next if !sender
senders[[candidate, nameserver, port]] = sender
end
reply, reply_name = requester.request(sender, tout)
case reply.rcode
when RCode::NoError
if reply.tc == 1 and not Requester::TCP === requester
requester.close
# Retry via TCP:
requester = make_tcp_requester(nameserver, port)
senders = {}
# This will use TCP for all remaining candidates (assuming the
# current candidate does not already respond successfully via
# TCP). This makes sense because we already know the full
# response will not fit in an untruncated UDP packet.
redo
else
yield(reply, reply_name)
end
return
when RCode::NXDomain
raise Config::NXDomain.new(reply_name.to_s)
else
raise Config::OtherResolvError.new(reply_name.to_s)
end
}
ensure
requester&.close
end
end
def make_udp_requester # :nodoc:
nameserver_port = @config.nameserver_port
if nameserver_port.length == 1
Requester::ConnectedUDP.new(*nameserver_port[0])
else
Requester::UnconnectedUDP.new(*nameserver_port)
end
end
def make_tcp_requester(host, port) # :nodoc:
return Requester::TCP.new(host, port)
end
def extract_resources(msg, name, typeclass) # :nodoc:
if typeclass < Resource::ANY
n0 = Name.create(name)
msg.each_resource {|n, ttl, data|
yield data if n0 == n
}
end
yielded = false
n0 = Name.create(name)
msg.each_resource {|n, ttl, data|
if n0 == n
case data
when typeclass
yield data
yielded = true
when Resource::CNAME
n0 = data.name
end
end
}
return if yielded
msg.each_resource {|n, ttl, data|
if n0 == n
case data
when typeclass
yield data
end
end
}
end
if defined? SecureRandom
def self.random(arg) # :nodoc:
begin
SecureRandom.random_number(arg)
rescue NotImplementedError
rand(arg)
end
end
else
def self.random(arg) # :nodoc:
rand(arg)
end
end
RequestID = {} # :nodoc:
RequestIDMutex = Thread::Mutex.new # :nodoc:
def self.allocate_request_id(host, port) # :nodoc:
id = nil
RequestIDMutex.synchronize {
h = (RequestID[[host, port]] ||= {})
begin
id = random(0x0000..0xffff)
end while h[id]
h[id] = true
}
id
end
def self.free_request_id(host, port, id) # :nodoc:
RequestIDMutex.synchronize {
key = [host, port]
if h = RequestID[key]
h.delete id
if h.empty?
RequestID.delete key
end
end
}
end
def self.bind_random_port(udpsock, bind_host="0.0.0.0") # :nodoc:
begin
port = random(1024..65535)
udpsock.bind(bind_host, port)
rescue Errno::EADDRINUSE, # POSIX
Errno::EACCES, # SunOS: See PRIV_SYS_NFS in privileges(5)
Errno::EPERM # FreeBSD: security.mac.portacl.port_high is configurable. See mac_portacl(4).
retry
end
end
class Requester # :nodoc:
def initialize
@senders = {}
@socks = nil
end
def request(sender, tout)
start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
timelimit = start + tout
begin
sender.send
rescue Errno::EHOSTUNREACH, # multi-homed IPv6 may generate this
Errno::ENETUNREACH
raise ResolvTimeout
end
while true
before_select = Process.clock_gettime(Process::CLOCK_MONOTONIC)
timeout = timelimit - before_select
if timeout <= 0
raise ResolvTimeout
end
if @socks.size == 1
select_result = @socks[0].wait_readable(timeout) ? [ @socks ] : nil
else
select_result = IO.select(@socks, nil, nil, timeout)
end
if !select_result
after_select = Process.clock_gettime(Process::CLOCK_MONOTONIC)
next if after_select < timelimit
raise ResolvTimeout
end
begin
reply, from = recv_reply(select_result[0])
rescue Errno::ECONNREFUSED, # GNU/Linux, FreeBSD
Errno::ECONNRESET # Windows
# No name server running on the server?
# Don't wait anymore.
raise ResolvTimeout
end
begin
msg = Message.decode(reply)
rescue DecodeError
next # broken DNS message ignored
end
if sender == sender_for(from, msg)
break
else
# unexpected DNS message ignored
end
end
return msg, sender.data
end
def sender_for(addr, msg)
@senders[[addr,msg.id]]
end
def close
socks = @socks
@socks = nil
socks&.each(&:close)
end
class Sender # :nodoc:
def initialize(msg, data, sock)
@msg = msg
@data = data
@sock = sock
end
end
class UnconnectedUDP < Requester # :nodoc:
def initialize(*nameserver_port)
super()
@nameserver_port = nameserver_port
@initialized = false
@mutex = Thread::Mutex.new
end
def lazy_initialize
@mutex.synchronize {
next if @initialized
@initialized = true
@socks_hash = {}
@socks = []
@nameserver_port.each {|host, port|
if host.index(':')
bind_host = "::"
af = Socket::AF_INET6
else
bind_host = "0.0.0.0"
af = Socket::AF_INET
end
next if @socks_hash[bind_host]
begin
sock = UDPSocket.new(af)
rescue Errno::EAFNOSUPPORT, Errno::EPROTONOSUPPORT
next # The kernel doesn't support the address family.
end
@socks << sock
@socks_hash[bind_host] = sock
sock.do_not_reverse_lookup = true
DNS.bind_random_port(sock, bind_host)
}
}
self
end
def recv_reply(readable_socks)
lazy_initialize
reply, from = readable_socks[0].recvfrom(UDPSize)
return reply, [from[3],from[1]]
end
def sender(msg, data, host, port=Port)
host = Addrinfo.ip(host).ip_address
lazy_initialize
sock = @socks_hash[host.index(':') ? "::" : "0.0.0.0"]
return nil if !sock
service = [host, port]
id = DNS.allocate_request_id(host, port)
request = msg.encode
request[0,2] = [id].pack('n')
return @senders[[service, id]] =
Sender.new(request, data, sock, host, port)
end
def close
@mutex.synchronize {
if @initialized
super
@senders.each_key {|service, id|
DNS.free_request_id(service[0], service[1], id)
}
@initialized = false
end
}
end
class Sender < Requester::Sender # :nodoc:
def initialize(msg, data, sock, host, port)
super(msg, data, sock)
@host = host
@port = port
end
attr_reader :data
def send
raise "@sock is nil." if @sock.nil?
@sock.send(@msg, 0, @host, @port)
end
end
end
class ConnectedUDP < Requester # :nodoc:
def initialize(host, port=Port)
super()
@host = host
@port = port
@mutex = Thread::Mutex.new
@initialized = false
end
def lazy_initialize
@mutex.synchronize {
next if @initialized
@initialized = true
is_ipv6 = @host.index(':')
sock = UDPSocket.new(is_ipv6 ? Socket::AF_INET6 : Socket::AF_INET)
@socks = [sock]
sock.do_not_reverse_lookup = true
DNS.bind_random_port(sock, is_ipv6 ? "::" : "0.0.0.0")
sock.connect(@host, @port)
}
self
end
def recv_reply(readable_socks)
lazy_initialize
reply = readable_socks[0].recv(UDPSize)
return reply, nil
end
def sender(msg, data, host=@host, port=@port)
lazy_initialize
unless host == @host && port == @port
raise RequestError.new("host/port don't match: #{host}:#{port}")
end
id = DNS.allocate_request_id(@host, @port)
request = msg.encode
request[0,2] = [id].pack('n')
return @senders[[nil,id]] = Sender.new(request, data, @socks[0])
end
def close
@mutex.synchronize do
if @initialized
super
@senders.each_key {|from, id|
DNS.free_request_id(@host, @port, id)
}
@initialized = false
end
end
end
class Sender < Requester::Sender # :nodoc:
def send
raise "@sock is nil." if @sock.nil?
@sock.send(@msg, 0)
end
attr_reader :data
end
end
class MDNSOneShot < UnconnectedUDP # :nodoc:
def sender(msg, data, host, port=Port)
lazy_initialize
id = DNS.allocate_request_id(host, port)
request = msg.encode
request[0,2] = [id].pack('n')
sock = @socks_hash[host.index(':') ? "::" : "0.0.0.0"]
return @senders[id] =
UnconnectedUDP::Sender.new(request, data, sock, host, port)
end
def sender_for(addr, msg)
lazy_initialize
@senders[msg.id]
end
end
class TCP < Requester # :nodoc:
def initialize(host, port=Port)
super()
@host = host
@port = port
sock = TCPSocket.new(@host, @port)
@socks = [sock]
@senders = {}
end
def recv_reply(readable_socks)
len = readable_socks[0].read(2).unpack('n')[0]
reply = @socks[0].read(len)
return reply, nil
end
def sender(msg, data, host=@host, port=@port)
unless host == @host && port == @port
raise RequestError.new("host/port don't match: #{host}:#{port}")
end
id = DNS.allocate_request_id(@host, @port)
request = msg.encode
request[0,2] = [request.length, id].pack('nn')
return @senders[[nil,id]] = Sender.new(request, data, @socks[0])
end
class Sender < Requester::Sender # :nodoc:
def send
@sock.print(@msg)
@sock.flush
end
attr_reader :data
end
def close
super
@senders.each_key {|from,id|
DNS.free_request_id(@host, @port, id)
}
end
end
##
# Indicates a problem with the DNS request.
class RequestError < StandardError
end
end
class Config # :nodoc:
def initialize(config_info=nil)
@mutex = Thread::Mutex.new
@config_info = config_info
@initialized = nil
@timeouts = nil
end
def timeouts=(values)
if values
values = Array(values)
values.each do |t|
Numeric === t or raise ArgumentError, "#{t.inspect} is not numeric"
t > 0.0 or raise ArgumentError, "timeout=#{t} must be positive"
end
@timeouts = values
else
@timeouts = nil
end
end
def Config.parse_resolv_conf(filename)
nameserver = []
search = nil
ndots = 1
File.open(filename, 'rb') {|f|
f.each {|line|
line.sub!(/[#;].*/, '')
keyword, *args = line.split(/\s+/)
next unless keyword
case keyword
when 'nameserver'
nameserver.concat(args)
when 'domain'
next if args.empty?
search = [args[0]]
when 'search'
next if args.empty?
search = args
when 'options'
args.each {|arg|
case arg
when /\Andots:(\d+)\z/
ndots = $1.to_i
end
}
end
}
}
return { :nameserver => nameserver, :search => search, :ndots => ndots }
end
def Config.default_config_hash(filename="/etc/resolv.conf")
if File.exist? filename
config_hash = Config.parse_resolv_conf(filename)
else
if /mswin|cygwin|mingw|bccwin/ =~ RUBY_PLATFORM
require 'win32/resolv'
search, nameserver = Win32::Resolv.get_resolv_info
config_hash = {}
config_hash[:nameserver] = nameserver if nameserver
config_hash[:search] = [search].flatten if search
end
end
config_hash || {}
end
def lazy_initialize
@mutex.synchronize {
unless @initialized
@nameserver_port = []
@use_ipv6 = nil
@search = nil
@ndots = 1
case @config_info
when nil
config_hash = Config.default_config_hash
when String
config_hash = Config.parse_resolv_conf(@config_info)
when Hash
config_hash = @config_info.dup
if String === config_hash[:nameserver]
config_hash[:nameserver] = [config_hash[:nameserver]]
end
if String === config_hash[:search]
config_hash[:search] = [config_hash[:search]]
end
else
raise ArgumentError.new("invalid resolv configuration: #{@config_info.inspect}")
end
if config_hash.include? :nameserver
@nameserver_port = config_hash[:nameserver].map {|ns| [ns, Port] }
end
if config_hash.include? :nameserver_port
@nameserver_port = config_hash[:nameserver_port].map {|ns, port| [ns, (port || Port)] }
end
if config_hash.include? :use_ipv6
@use_ipv6 = config_hash[:use_ipv6]
end
@search = config_hash[:search] if config_hash.include? :search
@ndots = config_hash[:ndots] if config_hash.include? :ndots
@raise_timeout_errors = config_hash[:raise_timeout_errors]
if @nameserver_port.empty?
@nameserver_port << ['0.0.0.0', Port]
end
if @search
@search = @search.map {|arg| Label.split(arg) }
else
hostname = Socket.gethostname
if /\./ =~ hostname
@search = [Label.split($')]
else
@search = [[]]
end
end
if !@nameserver_port.kind_of?(Array) ||
@nameserver_port.any? {|ns_port|
!(Array === ns_port) ||
ns_port.length != 2
!(String === ns_port[0]) ||
!(Integer === ns_port[1])
}
raise ArgumentError.new("invalid nameserver config: #{@nameserver_port.inspect}")
end
if !@search.kind_of?(Array) ||
!@search.all? {|ls| ls.all? {|l| Label::Str === l } }
raise ArgumentError.new("invalid search config: #{@search.inspect}")
end
if !@ndots.kind_of?(Integer)
raise ArgumentError.new("invalid ndots config: #{@ndots.inspect}")
end
@initialized = true
end
}
self
end
def single?
lazy_initialize
if @nameserver_port.length == 1
return @nameserver_port[0]
else
return nil
end
end
def nameserver_port
@nameserver_port
end
def use_ipv6?
@use_ipv6
end
def generate_candidates(name)
candidates = nil
name = Name.create(name)
if name.absolute?
candidates = [name]
else
if @ndots <= name.length - 1
candidates = [Name.new(name.to_a)]
else
candidates = []
end
candidates.concat(@search.map {|domain| Name.new(name.to_a + domain)})
fname = Name.create("#{name}.")
if !candidates.include?(fname)
candidates << fname
end
end
return candidates
end
InitialTimeout = 5
def generate_timeouts
ts = [InitialTimeout]
ts << ts[-1] * 2 / @nameserver_port.length
ts << ts[-1] * 2
ts << ts[-1] * 2
return ts
end
def resolv(name)
candidates = generate_candidates(name)
timeouts = @timeouts || generate_timeouts
timeout_error = false
begin
candidates.each {|candidate|
begin
timeouts.each {|tout|
@nameserver_port.each {|nameserver, port|
begin
yield candidate, tout, nameserver, port
rescue ResolvTimeout
end
}
}
timeout_error = true
raise ResolvError.new("DNS resolv timeout: #{name}")
rescue NXDomain
end
}
rescue ResolvError
raise if @raise_timeout_errors && timeout_error
end
end
##
# Indicates no such domain was found.
class NXDomain < ResolvError
end
##
# Indicates some other unhandled resolver error was encountered.
class OtherResolvError < ResolvError
end
end
module OpCode # :nodoc:
Query = 0
IQuery = 1
Status = 2
Notify = 4
Update = 5
end
module RCode # :nodoc:
NoError = 0
FormErr = 1
ServFail = 2
NXDomain = 3
NotImp = 4
Refused = 5
YXDomain = 6
YXRRSet = 7
NXRRSet = 8
NotAuth = 9
NotZone = 10
BADVERS = 16
BADSIG = 16
BADKEY = 17
BADTIME = 18
BADMODE = 19
BADNAME = 20
BADALG = 21
end
##
# Indicates that the DNS response was unable to be decoded.
class DecodeError < StandardError
end
##
# Indicates that the DNS request was unable to be encoded.
class EncodeError < StandardError
end
module Label # :nodoc:
def self.split(arg)
labels = []
arg.scan(/[^\.]+/) {labels << Str.new($&)}
return labels
end
class Str # :nodoc:
def initialize(string)
@string = string
# case insensivity of DNS labels doesn't apply non-ASCII characters. [RFC 4343]
# This assumes @string is given in ASCII compatible encoding.
@downcase = string.b.downcase
end
attr_reader :string, :downcase
def to_s
return @string
end
def inspect
return "#<#{self.class} #{self}>"
end
def ==(other)
return self.class == other.class && @downcase == other.downcase
end
def eql?(other)
return self == other
end
def hash
return @downcase.hash
end
end
end
##
# A representation of a DNS name.
class Name
##
# Creates a new DNS name from +arg+. +arg+ can be:
#
# Name:: returns +arg+.
# String:: Creates a new Name.
def self.create(arg)
case arg
when Name
return arg
when String
return Name.new(Label.split(arg), /\.\z/ =~ arg ? true : false)
else
raise ArgumentError.new("cannot interpret as DNS name: #{arg.inspect}")
end
end
def initialize(labels, absolute=true) # :nodoc:
labels = labels.map {|label|
case label
when String then Label::Str.new(label)
when Label::Str then label
else
raise ArgumentError, "unexpected label: #{label.inspect}"
end
}
@labels = labels
@absolute = absolute
end
def inspect # :nodoc:
"#<#{self.class}: #{self}#{@absolute ? '.' : ''}>"
end
##
# True if this name is absolute.
def absolute?
return @absolute
end
def ==(other) # :nodoc:
return false unless Name === other
return false unless @absolute == other.absolute?
return @labels == other.to_a
end
alias eql? == # :nodoc:
##
# Returns true if +other+ is a subdomain.
#
# Example:
#
# domain = Resolv::DNS::Name.create("y.z")
# p Resolv::DNS::Name.create("w.x.y.z").subdomain_of?(domain) #=> true
# p Resolv::DNS::Name.create("x.y.z").subdomain_of?(domain) #=> true
# p Resolv::DNS::Name.create("y.z").subdomain_of?(domain) #=> false
# p Resolv::DNS::Name.create("z").subdomain_of?(domain) #=> false
# p Resolv::DNS::Name.create("x.y.z.").subdomain_of?(domain) #=> false
# p Resolv::DNS::Name.create("w.z").subdomain_of?(domain) #=> false
#
def subdomain_of?(other)
raise ArgumentError, "not a domain name: #{other.inspect}" unless Name === other
return false if @absolute != other.absolute?
other_len = other.length
return false if @labels.length <= other_len
return @labels[-other_len, other_len] == other.to_a
end
def hash # :nodoc:
return @labels.hash ^ @absolute.hash
end
def to_a # :nodoc:
return @labels
end
def length # :nodoc:
return @labels.length
end
def [](i) # :nodoc:
return @labels[i]
end
##
# returns the domain name as a string.
#
# The domain name doesn't have a trailing dot even if the name object is
# absolute.
#
# Example:
#
# p Resolv::DNS::Name.create("x.y.z.").to_s #=> "x.y.z"
# p Resolv::DNS::Name.create("x.y.z").to_s #=> "x.y.z"
def to_s
return @labels.join('.')
end
end
class Message # :nodoc:
@@identifier = -1
def initialize(id = (@@identifier += 1) & 0xffff)
@id = id
@qr = 0
@opcode = 0
@aa = 0
@tc = 0
@rd = 0 # recursion desired
@ra = 0 # recursion available
@rcode = 0
@question = []
@answer = []
@authority = []
@additional = []
end
attr_accessor :id, :qr, :opcode, :aa, :tc, :rd, :ra, :rcode
attr_reader :question, :answer, :authority, :additional
def ==(other)
return @id == other.id &&
@qr == other.qr &&
@opcode == other.opcode &&
@aa == other.aa &&
@tc == other.tc &&
@rd == other.rd &&
@ra == other.ra &&
@rcode == other.rcode &&
@question == other.question &&
@answer == other.answer &&
@authority == other.authority &&
@additional == other.additional
end
def add_question(name, typeclass)
@question << [Name.create(name), typeclass]
end
def each_question
@question.each {|name, typeclass|
yield name, typeclass
}
end
def add_answer(name, ttl, data)
@answer << [Name.create(name), ttl, data]
end
def each_answer
@answer.each {|name, ttl, data|
yield name, ttl, data
}
end
def add_authority(name, ttl, data)
@authority << [Name.create(name), ttl, data]
end
def each_authority
@authority.each {|name, ttl, data|
yield name, ttl, data
}
end
def add_additional(name, ttl, data)
@additional << [Name.create(name), ttl, data]
end
def each_additional
@additional.each {|name, ttl, data|
yield name, ttl, data
}
end
def each_resource
each_answer {|name, ttl, data| yield name, ttl, data}
each_authority {|name, ttl, data| yield name, ttl, data}
each_additional {|name, ttl, data| yield name, ttl, data}
end
def encode
return MessageEncoder.new {|msg|
msg.put_pack('nnnnnn',
@id,
(@qr & 1) << 15 |
(@opcode & 15) << 11 |
(@aa & 1) << 10 |
(@tc & 1) << 9 |
(@rd & 1) << 8 |
(@ra & 1) << 7 |
(@rcode & 15),
@question.length,
@answer.length,
@authority.length,
@additional.length)
@question.each {|q|
name, typeclass = q
msg.put_name(name)
msg.put_pack('nn', typeclass::TypeValue, typeclass::ClassValue)
}
[@answer, @authority, @additional].each {|rr|
rr.each {|r|
name, ttl, data = r
msg.put_name(name)
msg.put_pack('nnN', data.class::TypeValue, data.class::ClassValue, ttl)
msg.put_length16 {data.encode_rdata(msg)}
}
}
}.to_s
end
class MessageEncoder # :nodoc:
def initialize
@data = ''.dup
@names = {}
yield self
end
def to_s
return @data
end
def put_bytes(d)
@data << d
end
def put_pack(template, *d)
@data << d.pack(template)
end
def put_length16
length_index = @data.length
@data << "\0\0"
data_start = @data.length
yield
data_end = @data.length
@data[length_index, 2] = [data_end - data_start].pack("n")
end
def put_string(d)
self.put_pack("C", d.length)
@data << d
end
def put_string_list(ds)
ds.each {|d|
self.put_string(d)
}
end
def put_name(d, compress: true)
put_labels(d.to_a, compress: compress)
end
def put_labels(d, compress: true)
d.each_index {|i|
domain = d[i..-1]
if compress && idx = @names[domain]
self.put_pack("n", 0xc000 | idx)
return
else
if @data.length < 0x4000
@names[domain] = @data.length
end
self.put_label(d[i])
end
}
@data << "\0"
end
def put_label(d)
self.put_string(d.to_s)
end
end
def Message.decode(m)
o = Message.new(0)
MessageDecoder.new(m) {|msg|
id, flag, qdcount, ancount, nscount, arcount =
msg.get_unpack('nnnnnn')
o.id = id
o.tc = (flag >> 9) & 1
o.rcode = flag & 15
return o unless o.tc.zero?
o.qr = (flag >> 15) & 1
o.opcode = (flag >> 11) & 15
o.aa = (flag >> 10) & 1
o.rd = (flag >> 8) & 1
o.ra = (flag >> 7) & 1
(1..qdcount).each {
name, typeclass = msg.get_question
o.add_question(name, typeclass)
}
(1..ancount).each {
name, ttl, data = msg.get_rr
o.add_answer(name, ttl, data)
}
(1..nscount).each {
name, ttl, data = msg.get_rr
o.add_authority(name, ttl, data)
}
(1..arcount).each {
name, ttl, data = msg.get_rr
o.add_additional(name, ttl, data)
}
}
return o
end
class MessageDecoder # :nodoc:
def initialize(data)
@data = data
@index = 0
@limit = data.bytesize
yield self
end
def inspect
"\#<#{self.class}: #{@data.byteslice(0, @index).inspect} #{@data.byteslice(@index..-1).inspect}>"
end
def get_length16
len, = self.get_unpack('n')
save_limit = @limit
@limit = @index + len
d = yield(len)
if @index < @limit
raise DecodeError.new("junk exists")
elsif @limit < @index
raise DecodeError.new("limit exceeded")
end
@limit = save_limit
return d
end
def get_bytes(len = @limit - @index)
raise DecodeError.new("limit exceeded") if @limit < @index + len
d = @data.byteslice(@index, len)
@index += len
return d
end
def get_unpack(template)
len = 0
template.each_byte {|byte|
byte = "%c" % byte
case byte
when ?c, ?C
len += 1
when ?n
len += 2
when ?N
len += 4
else
raise StandardError.new("unsupported template: '#{byte.chr}' in '#{template}'")
end
}
raise DecodeError.new("limit exceeded") if @limit < @index + len
arr = @data.unpack("@#{@index}#{template}")
@index += len
return arr
end
def get_string
raise DecodeError.new("limit exceeded") if @limit <= @index
len = @data.getbyte(@index)
raise DecodeError.new("limit exceeded") if @limit < @index + 1 + len
d = @data.byteslice(@index + 1, len)
@index += 1 + len
return d
end
def get_string_list
strings = []
while @index < @limit
strings << self.get_string
end
strings
end
def get_list
[].tap do |values|
while @index < @limit
values << yield
end
end
end
def get_name
return Name.new(self.get_labels)
end
def get_labels
prev_index = @index
save_index = nil
d = []
while true
raise DecodeError.new("limit exceeded") if @limit <= @index
case @data.getbyte(@index)
when 0
@index += 1
if save_index
@index = save_index
end
return d
when 192..255
idx = self.get_unpack('n')[0] & 0x3fff
if prev_index <= idx
raise DecodeError.new("non-backward name pointer")
end
prev_index = idx
if !save_index
save_index = @index
end
@index = idx
else
d << self.get_label
end
end
end
def get_label
return Label::Str.new(self.get_string)
end
def get_question
name = self.get_name
type, klass = self.get_unpack("nn")
return name, Resource.get_class(type, klass)
end
def get_rr
name = self.get_name
type, klass, ttl = self.get_unpack('nnN')
typeclass = Resource.get_class(type, klass)
res = self.get_length16 do
begin
typeclass.decode_rdata self
rescue => e
raise DecodeError, e.message, e.backtrace
end
end
res.instance_variable_set :@ttl, ttl
return name, ttl, res
end
end
end
##
# SvcParams for service binding RRs. [RFC9460]
class SvcParams
include Enumerable
##
# Create a list of SvcParams with the given initial content.
#
# +params+ has to be an enumerable of +SvcParam+s.
# If its content has +SvcParam+s with the duplicate key,
# the one appears last takes precedence.
def initialize(params = [])
@params = {}
params.each do |param|
add param
end
end
##
# Get SvcParam for the given +key+ in this list.
def [](key)
@params[canonical_key(key)]
end
##
# Get the number of SvcParams in this list.
def count
@params.count
end
##
# Get whether this list is empty.
def empty?
@params.empty?
end
##
# Add the SvcParam +param+ to this list, overwriting the existing one with the same key.
def add(param)
@params[param.class.key_number] = param
end
##
# Remove the +SvcParam+ with the given +key+ and return it.
def delete(key)
@params.delete(canonical_key(key))
end
##
# Enumerate the +SvcParam+s in this list.
def each(&block)
return enum_for(:each) unless block
@params.each_value(&block)
end
def encode(msg) # :nodoc:
@params.keys.sort.each do |key|
msg.put_pack('n', key)
msg.put_length16 do
@params.fetch(key).encode(msg)
end
end
end
def self.decode(msg) # :nodoc:
params = msg.get_list do
key, = msg.get_unpack('n')
msg.get_length16 do
SvcParam::ClassHash[key].decode(msg)
end
end
return self.new(params)
end
private
def canonical_key(key) # :nodoc:
case key
when Integer
key
when /\Akey(\d+)\z/
Integer($1)
when Symbol
SvcParam::ClassHash[key].key_number
else
raise TypeError, 'key must be either String or Symbol'
end
end
end
##
# Base class for SvcParam. [RFC9460]
class SvcParam
##
# Get the presentation name of the SvcParamKey.
def self.key_name
const_get(:KeyName)
end
##
# Get the registered number of the SvcParamKey.
def self.key_number
const_get(:KeyNumber)
end
ClassHash = Hash.new do |h, key| # :nodoc:
case key
when Integer
Generic.create(key)
when /\Akey(?<key>\d+)\z/
Generic.create(key.to_int)
when Symbol
raise KeyError, "unknown key #{key}"
else
raise TypeError, 'key must be either String or Symbol'
end
end
##
# Generic SvcParam abstract class.
class Generic < SvcParam
##
# SvcParamValue in wire-format byte string.
attr_reader :value
##
# Create generic SvcParam
def initialize(value)
@value = value
end
def encode(msg) # :nodoc:
msg.put_bytes(@value)
end
def self.decode(msg) # :nodoc:
return self.new(msg.get_bytes)
end
def self.create(key_number)
c = Class.new(Generic)
key_name = :"key#{key_number}"
c.const_set(:KeyName, key_name)
c.const_set(:KeyNumber, key_number)
self.const_set(:"Key#{key_number}", c)
ClassHash[key_name] = ClassHash[key_number] = c
return c
end
end
##
# "mandatory" SvcParam -- Mandatory keys in service binding RR
class Mandatory < SvcParam
KeyName = :mandatory
KeyNumber = 0
ClassHash[KeyName] = ClassHash[KeyNumber] = self # :nodoc:
##
# Mandatory keys.
attr_reader :keys
##
# Initialize "mandatory" ScvParam.
def initialize(keys)
@keys = keys.map(&:to_int)
end
def encode(msg) # :nodoc:
@keys.sort.each do |key|
msg.put_pack('n', key)
end
end
def self.decode(msg) # :nodoc:
keys = msg.get_list { msg.get_unpack('n')[0] }
return self.new(keys)
end
end
##
# "alpn" SvcParam -- Additional supported protocols
class ALPN < SvcParam
KeyName = :alpn
KeyNumber = 1
ClassHash[KeyName] = ClassHash[KeyNumber] = self # :nodoc:
##
# Supported protocol IDs.
attr_reader :protocol_ids
##
# Initialize "alpn" ScvParam.
def initialize(protocol_ids)
@protocol_ids = protocol_ids.map(&:to_str)
end
def encode(msg) # :nodoc:
msg.put_string_list(@protocol_ids)
end
def self.decode(msg) # :nodoc:
return self.new(msg.get_string_list)
end
end
##
# "no-default-alpn" SvcParam -- No support for default protocol
class NoDefaultALPN < SvcParam
KeyName = :'no-default-alpn'
KeyNumber = 2
ClassHash[KeyName] = ClassHash[KeyNumber] = self # :nodoc:
def encode(msg) # :nodoc:
# no payload
end
def self.decode(msg) # :nodoc:
return self.new
end
end
##
# "port" SvcParam -- Port for alternative endpoint
class Port < SvcParam
KeyName = :port
KeyNumber = 3
ClassHash[KeyName] = ClassHash[KeyNumber] = self # :nodoc:
##
# Port number.
attr_reader :port
##
# Initialize "port" ScvParam.
def initialize(port)
@port = port.to_int
end
def encode(msg) # :nodoc:
msg.put_pack('n', @port)
end
def self.decode(msg) # :nodoc:
port, = msg.get_unpack('n')
return self.new(port)
end
end
##
# "ipv4hint" SvcParam -- IPv4 address hints
class IPv4Hint < SvcParam
KeyName = :ipv4hint
KeyNumber = 4
ClassHash[KeyName] = ClassHash[KeyNumber] = self # :nodoc:
##
# Set of IPv4 addresses.
attr_reader :addresses
##
# Initialize "ipv4hint" ScvParam.
def initialize(addresses)
@addresses = addresses.map {|address| IPv4.create(address) }
end
def encode(msg) # :nodoc:
@addresses.each do |address|
msg.put_bytes(address.address)
end
end
def self.decode(msg) # :nodoc:
addresses = msg.get_list { IPv4.new(msg.get_bytes(4)) }
return self.new(addresses)
end
end
##
# "ipv6hint" SvcParam -- IPv6 address hints
class IPv6Hint < SvcParam
KeyName = :ipv6hint
KeyNumber = 6
ClassHash[KeyName] = ClassHash[KeyNumber] = self # :nodoc:
##
# Set of IPv6 addresses.
attr_reader :addresses
##
# Initialize "ipv6hint" ScvParam.
def initialize(addresses)
@addresses = addresses.map {|address| IPv6.create(address) }
end
def encode(msg) # :nodoc:
@addresses.each do |address|
msg.put_bytes(address.address)
end
end
def self.decode(msg) # :nodoc:
addresses = msg.get_list { IPv6.new(msg.get_bytes(16)) }
return self.new(addresses)
end
end
##
# "dohpath" SvcParam -- DNS over HTTPS path template [RFC9461]
class DoHPath < SvcParam
KeyName = :dohpath
KeyNumber = 7
ClassHash[KeyName] = ClassHash[KeyNumber] = self # :nodoc:
##
# URI template for DoH queries.
attr_reader :template
##
# Initialize "dohpath" ScvParam.
def initialize(template)
@template = template.encode('utf-8')
end
def encode(msg) # :nodoc:
msg.put_bytes(@template)
end
def self.decode(msg) # :nodoc:
template = msg.get_bytes.force_encoding('utf-8')
return self.new(template)
end
end
end
##
# A DNS query abstract class.
class Query
def encode_rdata(msg) # :nodoc:
raise EncodeError.new("#{self.class} is query.")
end
def self.decode_rdata(msg) # :nodoc:
raise DecodeError.new("#{self.class} is query.")
end
end
##
# A DNS resource abstract class.
class Resource < Query
##
# Remaining Time To Live for this Resource.
attr_reader :ttl
ClassHash = {} # :nodoc:
def encode_rdata(msg) # :nodoc:
raise NotImplementedError.new
end
def self.decode_rdata(msg) # :nodoc:
raise NotImplementedError.new
end
def ==(other) # :nodoc:
return false unless self.class == other.class
s_ivars = self.instance_variables
s_ivars.sort!
s_ivars.delete :@ttl
o_ivars = other.instance_variables
o_ivars.sort!
o_ivars.delete :@ttl
return s_ivars == o_ivars &&
s_ivars.collect {|name| self.instance_variable_get name} ==
o_ivars.collect {|name| other.instance_variable_get name}
end
def eql?(other) # :nodoc:
return self == other
end
def hash # :nodoc:
h = 0
vars = self.instance_variables
vars.delete :@ttl
vars.each {|name|
h ^= self.instance_variable_get(name).hash
}
return h
end
def self.get_class(type_value, class_value) # :nodoc:
return ClassHash[[type_value, class_value]] ||
Generic.create(type_value, class_value)
end
##
# A generic resource abstract class.
class Generic < Resource
##
# Creates a new generic resource.
def initialize(data)
@data = data
end
##
# Data for this generic resource.
attr_reader :data
def encode_rdata(msg) # :nodoc:
msg.put_bytes(data)
end
def self.decode_rdata(msg) # :nodoc:
return self.new(msg.get_bytes)
end
def self.create(type_value, class_value) # :nodoc:
c = Class.new(Generic)
c.const_set(:TypeValue, type_value)
c.const_set(:ClassValue, class_value)
Generic.const_set("Type#{type_value}_Class#{class_value}", c)
ClassHash[[type_value, class_value]] = c
return c
end
end
##
# Domain Name resource abstract class.
class DomainName < Resource
##
# Creates a new DomainName from +name+.
def initialize(name)
@name = name
end
##
# The name of this DomainName.
attr_reader :name
def encode_rdata(msg) # :nodoc:
msg.put_name(@name)
end
def self.decode_rdata(msg) # :nodoc:
return self.new(msg.get_name)
end
end
# Standard (class generic) RRs
ClassValue = nil # :nodoc:
##
# An authoritative name server.
class NS < DomainName
TypeValue = 2 # :nodoc:
end
##
# The canonical name for an alias.
class CNAME < DomainName
TypeValue = 5 # :nodoc:
end
##
# Start Of Authority resource.
class SOA < Resource
TypeValue = 6 # :nodoc:
##
# Creates a new SOA record. See the attr documentation for the
# details of each argument.
def initialize(mname, rname, serial, refresh, retry_, expire, minimum)
@mname = mname
@rname = rname
@serial = serial
@refresh = refresh
@retry = retry_
@expire = expire
@minimum = minimum
end
##
# Name of the host where the master zone file for this zone resides.
attr_reader :mname
##
# The person responsible for this domain name.
attr_reader :rname
##
# The version number of the zone file.
attr_reader :serial
##
# How often, in seconds, a secondary name server is to check for
# updates from the primary name server.
attr_reader :refresh
##
# How often, in seconds, a secondary name server is to retry after a
# failure to check for a refresh.
attr_reader :retry
##
# Time in seconds that a secondary name server is to use the data
# before refreshing from the primary name server.
attr_reader :expire
##
# The minimum number of seconds to be used for TTL values in RRs.
attr_reader :minimum
def encode_rdata(msg) # :nodoc:
msg.put_name(@mname)
msg.put_name(@rname)
msg.put_pack('NNNNN', @serial, @refresh, @retry, @expire, @minimum)
end
def self.decode_rdata(msg) # :nodoc:
mname = msg.get_name
rname = msg.get_name
serial, refresh, retry_, expire, minimum = msg.get_unpack('NNNNN')
return self.new(
mname, rname, serial, refresh, retry_, expire, minimum)
end
end
##
# A Pointer to another DNS name.
class PTR < DomainName
TypeValue = 12 # :nodoc:
end
##
# Host Information resource.
class HINFO < Resource
TypeValue = 13 # :nodoc:
##
# Creates a new HINFO running +os+ on +cpu+.
def initialize(cpu, os)
@cpu = cpu
@os = os
end
##
# CPU architecture for this resource.
attr_reader :cpu
##
# Operating system for this resource.
attr_reader :os
def encode_rdata(msg) # :nodoc:
msg.put_string(@cpu)
msg.put_string(@os)
end
def self.decode_rdata(msg) # :nodoc:
cpu = msg.get_string
os = msg.get_string
return self.new(cpu, os)
end
end
##
# Mailing list or mailbox information.
class MINFO < Resource
TypeValue = 14 # :nodoc:
def initialize(rmailbx, emailbx)
@rmailbx = rmailbx
@emailbx = emailbx
end
##
# Domain name responsible for this mail list or mailbox.
attr_reader :rmailbx
##
# Mailbox to use for error messages related to the mail list or mailbox.
attr_reader :emailbx
def encode_rdata(msg) # :nodoc:
msg.put_name(@rmailbx)
msg.put_name(@emailbx)
end
def self.decode_rdata(msg) # :nodoc:
rmailbx = msg.get_string
emailbx = msg.get_string
return self.new(rmailbx, emailbx)
end
end
##
# Mail Exchanger resource.
class MX < Resource
TypeValue= 15 # :nodoc:
##
# Creates a new MX record with +preference+, accepting mail at
# +exchange+.
def initialize(preference, exchange)
@preference = preference
@exchange = exchange
end
##
# The preference for this MX.
attr_reader :preference
##
# The host of this MX.
attr_reader :exchange
def encode_rdata(msg) # :nodoc:
msg.put_pack('n', @preference)
msg.put_name(@exchange)
end
def self.decode_rdata(msg) # :nodoc:
preference, = msg.get_unpack('n')
exchange = msg.get_name
return self.new(preference, exchange)
end
end
##
# Unstructured text resource.
class TXT < Resource
TypeValue = 16 # :nodoc:
def initialize(first_string, *rest_strings)
@strings = [first_string, *rest_strings]
end
##
# Returns an Array of Strings for this TXT record.
attr_reader :strings
##
# Returns the concatenated string from +strings+.
def data
@strings.join("")
end
def encode_rdata(msg) # :nodoc:
msg.put_string_list(@strings)
end
def self.decode_rdata(msg) # :nodoc:
strings = msg.get_string_list
return self.new(*strings)
end
end
##
# Location resource
class LOC < Resource
TypeValue = 29 # :nodoc:
def initialize(version, ssize, hprecision, vprecision, latitude, longitude, altitude)
@version = version
@ssize = Resolv::LOC::Size.create(ssize)
@hprecision = Resolv::LOC::Size.create(hprecision)
@vprecision = Resolv::LOC::Size.create(vprecision)
@latitude = Resolv::LOC::Coord.create(latitude)
@longitude = Resolv::LOC::Coord.create(longitude)
@altitude = Resolv::LOC::Alt.create(altitude)
end
##
# Returns the version value for this LOC record which should always be 00
attr_reader :version
##
# The spherical size of this LOC
# in meters using scientific notation as 2 integers of XeY
attr_reader :ssize
##
# The horizontal precision using ssize type values
# in meters using scientific notation as 2 integers of XeY
# for precision use value/2 e.g. 2m = +/-1m
attr_reader :hprecision
##
# The vertical precision using ssize type values
# in meters using scientific notation as 2 integers of XeY
# for precision use value/2 e.g. 2m = +/-1m
attr_reader :vprecision
##
# The latitude for this LOC where 2**31 is the equator
# in thousandths of an arc second as an unsigned 32bit integer
attr_reader :latitude
##
# The longitude for this LOC where 2**31 is the prime meridian
# in thousandths of an arc second as an unsigned 32bit integer
attr_reader :longitude
##
# The altitude of the LOC above a reference sphere whose surface sits 100km below the WGS84 spheroid
# in centimeters as an unsigned 32bit integer
attr_reader :altitude
def encode_rdata(msg) # :nodoc:
msg.put_bytes(@version)
msg.put_bytes(@ssize.scalar)
msg.put_bytes(@hprecision.scalar)
msg.put_bytes(@vprecision.scalar)
msg.put_bytes(@latitude.coordinates)
msg.put_bytes(@longitude.coordinates)
msg.put_bytes(@altitude.altitude)
end
def self.decode_rdata(msg) # :nodoc:
version = msg.get_bytes(1)
ssize = msg.get_bytes(1)
hprecision = msg.get_bytes(1)
vprecision = msg.get_bytes(1)
latitude = msg.get_bytes(4)
longitude = msg.get_bytes(4)
altitude = msg.get_bytes(4)
return self.new(
version,
Resolv::LOC::Size.new(ssize),
Resolv::LOC::Size.new(hprecision),
Resolv::LOC::Size.new(vprecision),
Resolv::LOC::Coord.new(latitude,"lat"),
Resolv::LOC::Coord.new(longitude,"lon"),
Resolv::LOC::Alt.new(altitude)
)
end
end
##
# A Query type requesting any RR.
class ANY < Query
TypeValue = 255 # :nodoc:
end
ClassInsensitiveTypes = [ # :nodoc:
NS, CNAME, SOA, PTR, HINFO, MINFO, MX, TXT, LOC, ANY
]
##
# module IN contains ARPA Internet specific RRs.
module IN
ClassValue = 1 # :nodoc:
ClassInsensitiveTypes.each {|s|
c = Class.new(s)
c.const_set(:TypeValue, s::TypeValue)
c.const_set(:ClassValue, ClassValue)
ClassHash[[s::TypeValue, ClassValue]] = c
self.const_set(s.name.sub(/.*::/, ''), c)
}
##
# IPv4 Address resource
class A < Resource
TypeValue = 1
ClassValue = IN::ClassValue
ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
##
# Creates a new A for +address+.
def initialize(address)
@address = IPv4.create(address)
end
##
# The Resolv::IPv4 address for this A.
attr_reader :address
def encode_rdata(msg) # :nodoc:
msg.put_bytes(@address.address)
end
def self.decode_rdata(msg) # :nodoc:
return self.new(IPv4.new(msg.get_bytes(4)))
end
end
##
# Well Known Service resource.
class WKS < Resource
TypeValue = 11
ClassValue = IN::ClassValue
ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
def initialize(address, protocol, bitmap)
@address = IPv4.create(address)
@protocol = protocol
@bitmap = bitmap
end
##
# The host these services run on.
attr_reader :address
##
# IP protocol number for these services.
attr_reader :protocol
##
# A bit map of enabled services on this host.
#
# If protocol is 6 (TCP) then the 26th bit corresponds to the SMTP
# service (port 25). If this bit is set, then an SMTP server should
# be listening on TCP port 25; if zero, SMTP service is not
# supported.
attr_reader :bitmap
def encode_rdata(msg) # :nodoc:
msg.put_bytes(@address.address)
msg.put_pack("n", @protocol)
msg.put_bytes(@bitmap)
end
def self.decode_rdata(msg) # :nodoc:
address = IPv4.new(msg.get_bytes(4))
protocol, = msg.get_unpack("n")
bitmap = msg.get_bytes
return self.new(address, protocol, bitmap)
end
end
##
# An IPv6 address record.
class AAAA < Resource
TypeValue = 28
ClassValue = IN::ClassValue
ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
##
# Creates a new AAAA for +address+.
def initialize(address)
@address = IPv6.create(address)
end
##
# The Resolv::IPv6 address for this AAAA.
attr_reader :address
def encode_rdata(msg) # :nodoc:
msg.put_bytes(@address.address)
end
def self.decode_rdata(msg) # :nodoc:
return self.new(IPv6.new(msg.get_bytes(16)))
end
end
##
# SRV resource record defined in RFC 2782
#
# These records identify the hostname and port that a service is
# available at.
class SRV < Resource
TypeValue = 33
ClassValue = IN::ClassValue
ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
# Create a SRV resource record.
#
# See the documentation for #priority, #weight, #port and #target
# for +priority+, +weight+, +port and +target+ respectively.
def initialize(priority, weight, port, target)
@priority = priority.to_int
@weight = weight.to_int
@port = port.to_int
@target = Name.create(target)
end
# The priority of this target host.
#
# A client MUST attempt to contact the target host with the
# lowest-numbered priority it can reach; target hosts with the same
# priority SHOULD be tried in an order defined by the weight field.
# The range is 0-65535. Note that it is not widely implemented and
# should be set to zero.
attr_reader :priority
# A server selection mechanism.
#
# The weight field specifies a relative weight for entries with the
# same priority. Larger weights SHOULD be given a proportionately
# higher probability of being selected. The range of this number is
# 0-65535. Domain administrators SHOULD use Weight 0 when there
# isn't any server selection to do, to make the RR easier to read
# for humans (less noisy). Note that it is not widely implemented
# and should be set to zero.
attr_reader :weight
# The port on this target host of this service.
#
# The range is 0-65535.
attr_reader :port
# The domain name of the target host.
#
# A target of "." means that the service is decidedly not available
# at this domain.
attr_reader :target
def encode_rdata(msg) # :nodoc:
msg.put_pack("n", @priority)
msg.put_pack("n", @weight)
msg.put_pack("n", @port)
msg.put_name(@target, compress: false)
end
def self.decode_rdata(msg) # :nodoc:
priority, = msg.get_unpack("n")
weight, = msg.get_unpack("n")
port, = msg.get_unpack("n")
target = msg.get_name
return self.new(priority, weight, port, target)
end
end
##
# Common implementation for SVCB-compatible resource records.
class ServiceBinding
##
# Create a service binding resource record.
def initialize(priority, target, params = [])
@priority = priority.to_int
@target = Name.create(target)
@params = SvcParams.new(params)
end
##
# The priority of this target host.
#
# The range is 0-65535.
# If set to 0, this RR is in AliasMode. Otherwise, it is in ServiceMode.
attr_reader :priority
##
# The domain name of the target host.
attr_reader :target
##
# The service paramters for the target host.
attr_reader :params
##
# Whether this RR is in AliasMode.
def alias_mode?
self.priority == 0
end
##
# Whether this RR is in ServiceMode.
def service_mode?
!alias_mode?
end
def encode_rdata(msg) # :nodoc:
msg.put_pack("n", @priority)
msg.put_name(@target, compress: false)
@params.encode(msg)
end
def self.decode_rdata(msg) # :nodoc:
priority, = msg.get_unpack("n")
target = msg.get_name
params = SvcParams.decode(msg)
return self.new(priority, target, params)
end
end
##
# SVCB resource record [RFC9460]
class SVCB < ServiceBinding
TypeValue = 64
ClassValue = IN::ClassValue
ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
end
##
# HTTPS resource record [RFC9460]
class HTTPS < ServiceBinding
TypeValue = 65
ClassValue = IN::ClassValue
ClassHash[[TypeValue, ClassValue]] = self # :nodoc:
end
end
end
end
##
# A Resolv::DNS IPv4 address.
class IPv4
##
# Regular expression IPv4 addresses must match.
Regex256 = /0
|1(?:[0-9][0-9]?)?
|2(?:[0-4][0-9]?|5[0-5]?|[6-9])?
|[3-9][0-9]?/x
Regex = /\A(#{Regex256})\.(#{Regex256})\.(#{Regex256})\.(#{Regex256})\z/
def self.create(arg)
case arg
when IPv4
return arg
when Regex
if (0..255) === (a = $1.to_i) &&
(0..255) === (b = $2.to_i) &&
(0..255) === (c = $3.to_i) &&
(0..255) === (d = $4.to_i)
return self.new([a, b, c, d].pack("CCCC"))
else
raise ArgumentError.new("IPv4 address with invalid value: " + arg)
end
else
raise ArgumentError.new("cannot interpret as IPv4 address: #{arg.inspect}")
end
end
def initialize(address) # :nodoc:
unless address.kind_of?(String)
raise ArgumentError, 'IPv4 address must be a string'
end
unless address.length == 4
raise ArgumentError, "IPv4 address expects 4 bytes but #{address.length} bytes"
end
@address = address
end
##
# A String representation of this IPv4 address.
##
# The raw IPv4 address as a String.
attr_reader :address
def to_s # :nodoc:
return sprintf("%d.%d.%d.%d", *@address.unpack("CCCC"))
end
def inspect # :nodoc:
return "#<#{self.class} #{self}>"
end
##
# Turns this IPv4 address into a Resolv::DNS::Name.
def to_name
return DNS::Name.create(
'%d.%d.%d.%d.in-addr.arpa.' % @address.unpack('CCCC').reverse)
end
def ==(other) # :nodoc:
return @address == other.address
end
def eql?(other) # :nodoc:
return self == other
end
def hash # :nodoc:
return @address.hash
end
end
##
# A Resolv::DNS IPv6 address.
class IPv6
##
# IPv6 address format a:b:c:d:e:f:g:h
Regex_8Hex = /\A
(?:[0-9A-Fa-f]{1,4}:){7}
[0-9A-Fa-f]{1,4}
\z/x
##
# Compressed IPv6 address format a::b
Regex_CompressedHex = /\A
((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?) ::
((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)
\z/x
##
# IPv4 mapped IPv6 address format a:b:c:d:e:f:w.x.y.z
Regex_6Hex4Dec = /\A
((?:[0-9A-Fa-f]{1,4}:){6,6})
(\d+)\.(\d+)\.(\d+)\.(\d+)
\z/x
##
# Compressed IPv4 mapped IPv6 address format a::b:w.x.y.z
Regex_CompressedHex4Dec = /\A
((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?) ::
((?:[0-9A-Fa-f]{1,4}:)*)
(\d+)\.(\d+)\.(\d+)\.(\d+)
\z/x
##
# IPv6 link local address format fe80:b:c:d:e:f:g:h%em1
Regex_8HexLinkLocal = /\A
[Ff][Ee]80
(?::[0-9A-Fa-f]{1,4}){7}
%[-0-9A-Za-z._~]+
\z/x
##
# Compressed IPv6 link local address format fe80::b%em1
Regex_CompressedHexLinkLocal = /\A
[Ff][Ee]80:
(?:
((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?) ::
((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)
|
:((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)
)?
:[0-9A-Fa-f]{1,4}%[-0-9A-Za-z._~]+
\z/x
##
# A composite IPv6 address Regexp.
Regex = /
(?:#{Regex_8Hex}) |
(?:#{Regex_CompressedHex}) |
(?:#{Regex_6Hex4Dec}) |
(?:#{Regex_CompressedHex4Dec}) |
(?:#{Regex_8HexLinkLocal}) |
(?:#{Regex_CompressedHexLinkLocal})
/x
##
# Creates a new IPv6 address from +arg+ which may be:
#
# IPv6:: returns +arg+.
# String:: +arg+ must match one of the IPv6::Regex* constants
def self.create(arg)
case arg
when IPv6
return arg
when String
address = ''.b
if Regex_8Hex =~ arg
arg.scan(/[0-9A-Fa-f]+/) {|hex| address << [hex.hex].pack('n')}
elsif Regex_CompressedHex =~ arg
prefix = $1
suffix = $2
a1 = ''.b
a2 = ''.b
prefix.scan(/[0-9A-Fa-f]+/) {|hex| a1 << [hex.hex].pack('n')}
suffix.scan(/[0-9A-Fa-f]+/) {|hex| a2 << [hex.hex].pack('n')}
omitlen = 16 - a1.length - a2.length
address << a1 << "\0" * omitlen << a2
elsif Regex_6Hex4Dec =~ arg
prefix, a, b, c, d = $1, $2.to_i, $3.to_i, $4.to_i, $5.to_i
if (0..255) === a && (0..255) === b && (0..255) === c && (0..255) === d
prefix.scan(/[0-9A-Fa-f]+/) {|hex| address << [hex.hex].pack('n')}
address << [a, b, c, d].pack('CCCC')
else
raise ArgumentError.new("not numeric IPv6 address: " + arg)
end
elsif Regex_CompressedHex4Dec =~ arg
prefix, suffix, a, b, c, d = $1, $2, $3.to_i, $4.to_i, $5.to_i, $6.to_i
if (0..255) === a && (0..255) === b && (0..255) === c && (0..255) === d
a1 = ''.b
a2 = ''.b
prefix.scan(/[0-9A-Fa-f]+/) {|hex| a1 << [hex.hex].pack('n')}
suffix.scan(/[0-9A-Fa-f]+/) {|hex| a2 << [hex.hex].pack('n')}
omitlen = 12 - a1.length - a2.length
address << a1 << "\0" * omitlen << a2 << [a, b, c, d].pack('CCCC')
else
raise ArgumentError.new("not numeric IPv6 address: " + arg)
end
else
raise ArgumentError.new("not numeric IPv6 address: " + arg)
end
return IPv6.new(address)
else
raise ArgumentError.new("cannot interpret as IPv6 address: #{arg.inspect}")
end
end
def initialize(address) # :nodoc:
unless address.kind_of?(String) && address.length == 16
raise ArgumentError.new('IPv6 address must be 16 bytes')
end
@address = address
end
##
# The raw IPv6 address as a String.
attr_reader :address
def to_s # :nodoc:
sprintf("%x:%x:%x:%x:%x:%x:%x:%x", *@address.unpack("nnnnnnnn")).sub(/(^|:)0(:0)+(:|$)/, '::')
end
def inspect # :nodoc:
return "#<#{self.class} #{self}>"
end
##
# Turns this IPv6 address into a Resolv::DNS::Name.
#--
# ip6.arpa should be searched too. [RFC3152]
def to_name
return DNS::Name.new(
@address.unpack("H32")[0].split(//).reverse + ['ip6', 'arpa'])
end
def ==(other) # :nodoc:
return @address == other.address
end
def eql?(other) # :nodoc:
return self == other
end
def hash # :nodoc:
return @address.hash
end
end
##
# Resolv::MDNS is a one-shot Multicast DNS (mDNS) resolver. It blindly
# makes queries to the mDNS addresses without understanding anything about
# multicast ports.
#
# Information taken form the following places:
#
# * RFC 6762
class MDNS < DNS
##
# Default mDNS Port
Port = 5353
##
# Default IPv4 mDNS address
AddressV4 = '224.0.0.251'
##
# Default IPv6 mDNS address
AddressV6 = 'ff02::fb'
##
# Default mDNS addresses
Addresses = [
[AddressV4, Port],
[AddressV6, Port],
]
##
# Creates a new one-shot Multicast DNS (mDNS) resolver.
#
# +config_info+ can be:
#
# nil::
# Uses the default mDNS addresses
#
# Hash::
# Must contain :nameserver or :nameserver_port like
# Resolv::DNS#initialize.
def initialize(config_info=nil)
if config_info then
super({ nameserver_port: Addresses }.merge(config_info))
else
super(nameserver_port: Addresses)
end
end
##
# Iterates over all IP addresses for +name+ retrieved from the mDNS
# resolver, provided name ends with "local". If the name does not end in
# "local" no records will be returned.
#
# +name+ can be a Resolv::DNS::Name or a String. Retrieved addresses will
# be a Resolv::IPv4 or Resolv::IPv6
def each_address(name)
name = Resolv::DNS::Name.create(name)
return unless name[-1].to_s == 'local'
super(name)
end
def make_udp_requester # :nodoc:
nameserver_port = @config.nameserver_port
Requester::MDNSOneShot.new(*nameserver_port)
end
end
module LOC
##
# A Resolv::LOC::Size
class Size
Regex = /^(\d+\.*\d*)[m]$/
##
# Creates a new LOC::Size from +arg+ which may be:
#
# LOC::Size:: returns +arg+.
# String:: +arg+ must match the LOC::Size::Regex constant
def self.create(arg)
case arg
when Size
return arg
when String
scalar = ''
if Regex =~ arg
scalar = [(($1.to_f*(1e2)).to_i.to_s[0].to_i*(2**4)+(($1.to_f*(1e2)).to_i.to_s.length-1))].pack("C")
else
raise ArgumentError.new("not a properly formed Size string: " + arg)
end
return Size.new(scalar)
else
raise ArgumentError.new("cannot interpret as Size: #{arg.inspect}")
end
end
def initialize(scalar)
@scalar = scalar
end
##
# The raw size
attr_reader :scalar
def to_s # :nodoc:
s = @scalar.unpack("H2").join.to_s
return ((s[0].to_i)*(10**(s[1].to_i-2))).to_s << "m"
end
def inspect # :nodoc:
return "#<#{self.class} #{self}>"
end
def ==(other) # :nodoc:
return @scalar == other.scalar
end
def eql?(other) # :nodoc:
return self == other
end
def hash # :nodoc:
return @scalar.hash
end
end
##
# A Resolv::LOC::Coord
class Coord
Regex = /^(\d+)\s(\d+)\s(\d+\.\d+)\s([NESW])$/
##
# Creates a new LOC::Coord from +arg+ which may be:
#
# LOC::Coord:: returns +arg+.
# String:: +arg+ must match the LOC::Coord::Regex constant
def self.create(arg)
case arg
when Coord
return arg
when String
coordinates = ''
if Regex =~ arg && $1.to_f < 180
m = $~
hemi = (m[4][/[NE]/]) || (m[4][/[SW]/]) ? 1 : -1
coordinates = [ ((m[1].to_i*(36e5)) + (m[2].to_i*(6e4)) +
(m[3].to_f*(1e3))) * hemi+(2**31) ].pack("N")
orientation = m[4][/[NS]/] ? 'lat' : 'lon'
else
raise ArgumentError.new("not a properly formed Coord string: " + arg)
end
return Coord.new(coordinates,orientation)
else
raise ArgumentError.new("cannot interpret as Coord: #{arg.inspect}")
end
end
def initialize(coordinates,orientation)
unless coordinates.kind_of?(String)
raise ArgumentError.new("Coord must be a 32bit unsigned integer in hex format: #{coordinates.inspect}")
end
unless orientation.kind_of?(String) && orientation[/^lon$|^lat$/]
raise ArgumentError.new('Coord expects orientation to be a String argument of "lat" or "lon"')
end
@coordinates = coordinates
@orientation = orientation
end
##
# The raw coordinates
attr_reader :coordinates
## The orientation of the hemisphere as 'lat' or 'lon'
attr_reader :orientation
def to_s # :nodoc:
c = @coordinates.unpack("N").join.to_i
val = (c - (2**31)).abs
fracsecs = (val % 1e3).to_i.to_s
val = val / 1e3
secs = (val % 60).to_i.to_s
val = val / 60
mins = (val % 60).to_i.to_s
degs = (val / 60).to_i.to_s
posi = (c >= 2**31)
case posi
when true
hemi = @orientation[/^lat$/] ? "N" : "E"
else
hemi = @orientation[/^lon$/] ? "W" : "S"
end
return degs << " " << mins << " " << secs << "." << fracsecs << " " << hemi
end
def inspect # :nodoc:
return "#<#{self.class} #{self}>"
end
def ==(other) # :nodoc:
return @coordinates == other.coordinates
end
def eql?(other) # :nodoc:
return self == other
end
def hash # :nodoc:
return @coordinates.hash
end
end
##
# A Resolv::LOC::Alt
class Alt
Regex = /^([+-]*\d+\.*\d*)[m]$/
##
# Creates a new LOC::Alt from +arg+ which may be:
#
# LOC::Alt:: returns +arg+.
# String:: +arg+ must match the LOC::Alt::Regex constant
def self.create(arg)
case arg
when Alt
return arg
when String
altitude = ''
if Regex =~ arg
altitude = [($1.to_f*(1e2))+(1e7)].pack("N")
else
raise ArgumentError.new("not a properly formed Alt string: " + arg)
end
return Alt.new(altitude)
else
raise ArgumentError.new("cannot interpret as Alt: #{arg.inspect}")
end
end
def initialize(altitude)
@altitude = altitude
end
##
# The raw altitude
attr_reader :altitude
def to_s # :nodoc:
a = @altitude.unpack("N").join.to_i
return ((a.to_f/1e2)-1e5).to_s + "m"
end
def inspect # :nodoc:
return "#<#{self.class} #{self}>"
end
def ==(other) # :nodoc:
return @altitude == other.altitude
end
def eql?(other) # :nodoc:
return self == other
end
def hash # :nodoc:
return @altitude.hash
end
end
end
##
# Default resolver to use for Resolv class methods.
DefaultResolver = self.new
##
# Replaces the resolvers in the default resolver with +new_resolvers+. This
# allows resolvers to be changed for resolv-replace.
def DefaultResolver.replace_resolvers new_resolvers
@resolvers = new_resolvers
end
##
# Address Regexp to use for matching IP addresses.
AddressRegex = /(?:#{IPv4::Regex})|(?:#{IPv6::Regex})/
end
share/ruby/date.rb 0000644 00000002251 15173517740 0010103 0 ustar 00 # frozen_string_literal: true
# date.rb: Written by Tadayoshi Funaba 1998-2011
require 'date_core'
class Date
VERSION = "3.3.4" # :nodoc:
# call-seq:
# infinite? -> false
#
# Returns +false+
def infinite?
false
end
class Infinity < Numeric # :nodoc:
def initialize(d=1) @d = d <=> 0 end
def d() @d end
protected :d
def zero?() false end
def finite?() false end
def infinite?() d.nonzero? end
def nan?() d.zero? end
def abs() self.class.new end
def -@() self.class.new(-d) end
def +@() self.class.new(+d) end
def <=>(other)
case other
when Infinity; return d <=> other.d
when Float::INFINITY; return d <=> 1
when -Float::INFINITY; return d <=> -1
when Numeric; return d
else
begin
l, r = other.coerce(self)
return l <=> r
rescue NoMethodError
end
end
nil
end
def coerce(other)
case other
when Numeric; return -d, d
else
super
end
end
def to_f
return 0 if @d == 0
if @d > 0
Float::INFINITY
else
-Float::INFINITY
end
end
end
end
share/ruby/logger/severity.rb 0000644 00000001556 15173517740 0012326 0 ustar 00 # frozen_string_literal: true
class Logger
# Logging severity.
module Severity
# Low-level information, mostly for developers.
DEBUG = 0
# Generic (useful) information about system operation.
INFO = 1
# A warning.
WARN = 2
# A handleable error condition.
ERROR = 3
# An unhandleable error that results in a program crash.
FATAL = 4
# An unknown message that should always be logged.
UNKNOWN = 5
LEVELS = {
"debug" => DEBUG,
"info" => INFO,
"warn" => WARN,
"error" => ERROR,
"fatal" => FATAL,
"unknown" => UNKNOWN,
}
private_constant :LEVELS
def self.coerce(severity)
if severity.is_a?(Integer)
severity
else
key = severity.to_s.downcase
LEVELS[key] || raise(ArgumentError, "invalid log level: #{severity}")
end
end
end
end
share/ruby/logger/log_device.rb 0000644 00000013216 15173517740 0012550 0 ustar 00 # frozen_string_literal: true
require_relative 'period'
class Logger
# Device used for logging messages.
class LogDevice
include Period
attr_reader :dev
attr_reader :filename
include MonitorMixin
def initialize(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false)
@dev = @filename = @shift_age = @shift_size = @shift_period_suffix = nil
@binmode = binmode
mon_initialize
set_dev(log)
if @filename
@shift_age = shift_age || 7
@shift_size = shift_size || 1048576
@shift_period_suffix = shift_period_suffix || '%Y%m%d'
unless @shift_age.is_a?(Integer)
base_time = @dev.respond_to?(:stat) ? @dev.stat.mtime : Time.now
@next_rotate_time = next_rotate_time(base_time, @shift_age)
end
end
end
def write(message)
begin
synchronize do
if @shift_age and @dev.respond_to?(:stat)
begin
check_shift_log
rescue
warn("log shifting failed. #{$!}")
end
end
begin
@dev.write(message)
rescue
warn("log writing failed. #{$!}")
end
end
rescue Exception => ignored
warn("log writing failed. #{ignored}")
end
end
def close
begin
synchronize do
@dev.close rescue nil
end
rescue Exception
@dev.close rescue nil
end
end
def reopen(log = nil)
# reopen the same filename if no argument, do nothing for IO
log ||= @filename if @filename
if log
synchronize do
if @filename and @dev
@dev.close rescue nil # close only file opened by Logger
@filename = nil
end
set_dev(log)
end
end
self
end
private
def set_dev(log)
if log.respond_to?(:write) and log.respond_to?(:close)
@dev = log
if log.respond_to?(:path) and path = log.path
if File.exist?(path)
@filename = path
end
end
else
@dev = open_logfile(log)
@dev.sync = true
@dev.binmode if @binmode
@filename = log
end
end
def open_logfile(filename)
begin
File.open(filename, (File::WRONLY | File::APPEND))
rescue Errno::ENOENT
create_logfile(filename)
end
end
def create_logfile(filename)
begin
logdev = File.open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
logdev.flock(File::LOCK_EX)
logdev.sync = true
logdev.binmode if @binmode
add_log_header(logdev)
logdev.flock(File::LOCK_UN)
rescue Errno::EEXIST
# file is created by another process
logdev = open_logfile(filename)
logdev.sync = true
end
logdev
end
def add_log_header(file)
file.write(
"# Logfile created on %s by %s\n" % [Time.now.to_s, Logger::ProgName]
) if file.size == 0
end
def check_shift_log
if @shift_age.is_a?(Integer)
# Note: always returns false if '0'.
if @filename && (@shift_age > 0) && (@dev.stat.size > @shift_size)
lock_shift_log { shift_log_age }
end
else
now = Time.now
if now >= @next_rotate_time
@next_rotate_time = next_rotate_time(now, @shift_age)
lock_shift_log { shift_log_period(previous_period_end(now, @shift_age)) }
end
end
end
if /mswin|mingw|cygwin/ =~ RbConfig::CONFIG['host_os']
def lock_shift_log
yield
end
else
def lock_shift_log
retry_limit = 8
retry_sleep = 0.1
begin
File.open(@filename, File::WRONLY | File::APPEND) do |lock|
lock.flock(File::LOCK_EX) # inter-process locking. will be unlocked at closing file
if File.identical?(@filename, lock) and File.identical?(lock, @dev)
yield # log shifting
else
# log shifted by another process (i-node before locking and i-node after locking are different)
@dev.close rescue nil
@dev = open_logfile(@filename)
@dev.sync = true
end
end
rescue Errno::ENOENT
# @filename file would not exist right after #rename and before #create_logfile
if retry_limit <= 0
warn("log rotation inter-process lock failed. #{$!}")
else
sleep retry_sleep
retry_limit -= 1
retry_sleep *= 2
retry
end
end
rescue
warn("log rotation inter-process lock failed. #{$!}")
end
end
def shift_log_age
(@shift_age-3).downto(0) do |i|
if FileTest.exist?("#{@filename}.#{i}")
File.rename("#{@filename}.#{i}", "#{@filename}.#{i+1}")
end
end
@dev.close rescue nil
File.rename("#{@filename}", "#{@filename}.0")
@dev = create_logfile(@filename)
return true
end
def shift_log_period(period_end)
suffix = period_end.strftime(@shift_period_suffix)
age_file = "#{@filename}.#{suffix}"
if FileTest.exist?(age_file)
# try to avoid filename crash caused by Timestamp change.
idx = 0
# .99 can be overridden; avoid too much file search with 'loop do'
while idx < 100
idx += 1
age_file = "#{@filename}.#{suffix}.#{idx}"
break unless FileTest.exist?(age_file)
end
end
@dev.close rescue nil
File.rename("#{@filename}", age_file)
@dev = create_logfile(@filename)
return true
end
end
end
share/ruby/logger/version.rb 0000644 00000000104 15173517740 0012125 0 ustar 00 # frozen_string_literal: true
class Logger
VERSION = "1.6.0"
end
share/ruby/logger/formatter.rb 0000644 00000001426 15173517740 0012453 0 ustar 00 # frozen_string_literal: true
class Logger
# Default formatter for log messages.
class Formatter
Format = "%.1s, [%s #%d] %5s -- %s: %s\n"
DatetimeFormat = "%Y-%m-%dT%H:%M:%S.%6N"
attr_accessor :datetime_format
def initialize
@datetime_format = nil
end
def call(severity, time, progname, msg)
sprintf(Format, severity, format_datetime(time), Process.pid, severity, progname, msg2str(msg))
end
private
def format_datetime(time)
time.strftime(@datetime_format || DatetimeFormat)
end
def msg2str(msg)
case msg
when ::String
msg
when ::Exception
"#{ msg.message } (#{ msg.class })\n#{ msg.backtrace.join("\n") if msg.backtrace }"
else
msg.inspect
end
end
end
end
share/ruby/logger/period.rb 0000644 00000002644 15173517740 0011735 0 ustar 00 # frozen_string_literal: true
class Logger
module Period
module_function
SiD = 24 * 60 * 60
def next_rotate_time(now, shift_age)
case shift_age
when 'daily'
t = Time.mktime(now.year, now.month, now.mday) + SiD
when 'weekly'
t = Time.mktime(now.year, now.month, now.mday) + SiD * (7 - now.wday)
when 'monthly'
t = Time.mktime(now.year, now.month, 1) + SiD * 32
return Time.mktime(t.year, t.month, 1)
when 'now', 'everytime'
return now
else
raise ArgumentError, "invalid :shift_age #{shift_age.inspect}, should be daily, weekly, monthly, or everytime"
end
if t.hour.nonzero? or t.min.nonzero? or t.sec.nonzero?
hour = t.hour
t = Time.mktime(t.year, t.month, t.mday)
t += SiD if hour > 12
end
t
end
def previous_period_end(now, shift_age)
case shift_age
when 'daily'
t = Time.mktime(now.year, now.month, now.mday) - SiD / 2
when 'weekly'
t = Time.mktime(now.year, now.month, now.mday) - (SiD * now.wday + SiD / 2)
when 'monthly'
t = Time.mktime(now.year, now.month, 1) - SiD / 2
when 'now', 'everytime'
return now
else
raise ArgumentError, "invalid :shift_age #{shift_age.inspect}, should be daily, weekly, monthly, or everytime"
end
Time.mktime(t.year, t.month, t.mday, 23, 59, 59)
end
end
end
share/ruby/logger/errors.rb 0000644 00000000266 15173517740 0011765 0 ustar 00 # frozen_string_literal: true
class Logger
# not used after 1.2.7. just for compat.
class Error < RuntimeError # :nodoc:
end
class ShiftingError < Error # :nodoc:
end
end
share/ruby/socket.rb 0000644 00000130055 15173517740 0010462 0 ustar 00 # frozen_string_literal: true
require 'socket.so'
unless IO.method_defined?(:wait_writable, false)
# It's only required on older Rubies < v3.2:
require 'io/wait'
end
class Addrinfo
# creates an Addrinfo object from the arguments.
#
# The arguments are interpreted as similar to self.
#
# Addrinfo.tcp("0.0.0.0", 4649).family_addrinfo("www.ruby-lang.org", 80)
# #=> #<Addrinfo: 221.186.184.68:80 TCP (www.ruby-lang.org:80)>
#
# Addrinfo.unix("/tmp/sock").family_addrinfo("/tmp/sock2")
# #=> #<Addrinfo: /tmp/sock2 SOCK_STREAM>
#
def family_addrinfo(*args)
if args.empty?
raise ArgumentError, "no address specified"
elsif Addrinfo === args.first
raise ArgumentError, "too many arguments" if args.length != 1
addrinfo = args.first
if (self.pfamily != addrinfo.pfamily) ||
(self.socktype != addrinfo.socktype)
raise ArgumentError, "Addrinfo type mismatch"
end
addrinfo
elsif self.ip?
raise ArgumentError, "IP address needs host and port but #{args.length} arguments given" if args.length != 2
host, port = args
Addrinfo.getaddrinfo(host, port, self.pfamily, self.socktype, self.protocol)[0]
elsif self.unix?
raise ArgumentError, "UNIX socket needs single path argument but #{args.length} arguments given" if args.length != 1
path, = args
Addrinfo.unix(path)
else
raise ArgumentError, "unexpected family"
end
end
# creates a new Socket connected to the address of +local_addrinfo+.
#
# If _local_addrinfo_ is nil, the address of the socket is not bound.
#
# The _timeout_ specify the seconds for timeout.
# Errno::ETIMEDOUT is raised when timeout occur.
#
# If a block is given the created socket is yielded for each address.
#
def connect_internal(local_addrinfo, timeout=nil) # :yields: socket
sock = Socket.new(self.pfamily, self.socktype, self.protocol)
begin
sock.ipv6only! if self.ipv6?
sock.bind local_addrinfo if local_addrinfo
if timeout
case sock.connect_nonblock(self, exception: false)
when 0 # success or EISCONN, other errors raise
break
when :wait_writable
sock.wait_writable(timeout) or
raise Errno::ETIMEDOUT, 'user specified timeout'
end while true
else
sock.connect(self)
end
rescue Exception
sock.close
raise
end
if block_given?
begin
yield sock
ensure
sock.close
end
else
sock
end
end
protected :connect_internal
# :call-seq:
# addrinfo.connect_from([local_addr_args], [opts]) {|socket| ... }
# addrinfo.connect_from([local_addr_args], [opts])
#
# creates a socket connected to the address of self.
#
# If one or more arguments given as _local_addr_args_,
# it is used as the local address of the socket.
# _local_addr_args_ is given for family_addrinfo to obtain actual address.
#
# If _local_addr_args_ is not given, the local address of the socket is not bound.
#
# The optional last argument _opts_ is options represented by a hash.
# _opts_ may have following options:
#
# [:timeout] specify the timeout in seconds.
#
# If a block is given, it is called with the socket and the value of the block is returned.
# The socket is returned otherwise.
#
# Addrinfo.tcp("www.ruby-lang.org", 80).connect_from("0.0.0.0", 4649) {|s|
# s.print "GET / HTTP/1.0\r\nHost: www.ruby-lang.org\r\n\r\n"
# puts s.read
# }
#
# # Addrinfo object can be taken for the argument.
# Addrinfo.tcp("www.ruby-lang.org", 80).connect_from(Addrinfo.tcp("0.0.0.0", 4649)) {|s|
# s.print "GET / HTTP/1.0\r\nHost: www.ruby-lang.org\r\n\r\n"
# puts s.read
# }
#
def connect_from(*args, timeout: nil, &block)
connect_internal(family_addrinfo(*args), timeout, &block)
end
# :call-seq:
# addrinfo.connect([opts]) {|socket| ... }
# addrinfo.connect([opts])
#
# creates a socket connected to the address of self.
#
# The optional argument _opts_ is options represented by a hash.
# _opts_ may have following options:
#
# [:timeout] specify the timeout in seconds.
#
# If a block is given, it is called with the socket and the value of the block is returned.
# The socket is returned otherwise.
#
# Addrinfo.tcp("www.ruby-lang.org", 80).connect {|s|
# s.print "GET / HTTP/1.0\r\nHost: www.ruby-lang.org\r\n\r\n"
# puts s.read
# }
#
def connect(timeout: nil, &block)
connect_internal(nil, timeout, &block)
end
# :call-seq:
# addrinfo.connect_to([remote_addr_args], [opts]) {|socket| ... }
# addrinfo.connect_to([remote_addr_args], [opts])
#
# creates a socket connected to _remote_addr_args_ and bound to self.
#
# The optional last argument _opts_ is options represented by a hash.
# _opts_ may have following options:
#
# [:timeout] specify the timeout in seconds.
#
# If a block is given, it is called with the socket and the value of the block is returned.
# The socket is returned otherwise.
#
# Addrinfo.tcp("0.0.0.0", 4649).connect_to("www.ruby-lang.org", 80) {|s|
# s.print "GET / HTTP/1.0\r\nHost: www.ruby-lang.org\r\n\r\n"
# puts s.read
# }
#
def connect_to(*args, timeout: nil, &block)
remote_addrinfo = family_addrinfo(*args)
remote_addrinfo.connect_internal(self, timeout, &block)
end
# creates a socket bound to self.
#
# If a block is given, it is called with the socket and the value of the block is returned.
# The socket is returned otherwise.
#
# Addrinfo.udp("0.0.0.0", 9981).bind {|s|
# s.local_address.connect {|s| s.send "hello", 0 }
# p s.recv(10) #=> "hello"
# }
#
def bind
sock = Socket.new(self.pfamily, self.socktype, self.protocol)
begin
sock.ipv6only! if self.ipv6?
sock.setsockopt(:SOCKET, :REUSEADDR, 1)
sock.bind(self)
rescue Exception
sock.close
raise
end
if block_given?
begin
yield sock
ensure
sock.close
end
else
sock
end
end
# creates a listening socket bound to self.
def listen(backlog=Socket::SOMAXCONN)
sock = Socket.new(self.pfamily, self.socktype, self.protocol)
begin
sock.ipv6only! if self.ipv6?
sock.setsockopt(:SOCKET, :REUSEADDR, 1) unless self.pfamily == Socket::PF_UNIX
sock.bind(self)
sock.listen(backlog)
rescue Exception
sock.close
raise
end
if block_given?
begin
yield sock
ensure
sock.close
end
else
sock
end
end
# iterates over the list of Addrinfo objects obtained by Addrinfo.getaddrinfo.
#
# Addrinfo.foreach(nil, 80) {|x| p x }
# #=> #<Addrinfo: 127.0.0.1:80 TCP (:80)>
# # #<Addrinfo: 127.0.0.1:80 UDP (:80)>
# # #<Addrinfo: [::1]:80 TCP (:80)>
# # #<Addrinfo: [::1]:80 UDP (:80)>
#
def self.foreach(nodename, service, family=nil, socktype=nil, protocol=nil, flags=nil, timeout: nil, &block)
Addrinfo.getaddrinfo(nodename, service, family, socktype, protocol, flags, timeout: timeout).each(&block)
end
end
class BasicSocket < IO
# Returns an address of the socket suitable for connect in the local machine.
#
# This method returns _self_.local_address, except following condition.
#
# - IPv4 unspecified address (0.0.0.0) is replaced by IPv4 loopback address (127.0.0.1).
# - IPv6 unspecified address (::) is replaced by IPv6 loopback address (::1).
#
# If the local address is not suitable for connect, SocketError is raised.
# IPv4 and IPv6 address which port is 0 is not suitable for connect.
# Unix domain socket which has no path is not suitable for connect.
#
# Addrinfo.tcp("0.0.0.0", 0).listen {|serv|
# p serv.connect_address #=> #<Addrinfo: 127.0.0.1:53660 TCP>
# serv.connect_address.connect {|c|
# s, _ = serv.accept
# p [c, s] #=> [#<Socket:fd 4>, #<Socket:fd 6>]
# }
# }
#
def connect_address
addr = local_address
afamily = addr.afamily
if afamily == Socket::AF_INET
raise SocketError, "unbound IPv4 socket" if addr.ip_port == 0
if addr.ip_address == "0.0.0.0"
addr = Addrinfo.new(["AF_INET", addr.ip_port, nil, "127.0.0.1"], addr.pfamily, addr.socktype, addr.protocol)
end
elsif defined?(Socket::AF_INET6) && afamily == Socket::AF_INET6
raise SocketError, "unbound IPv6 socket" if addr.ip_port == 0
if addr.ip_address == "::"
addr = Addrinfo.new(["AF_INET6", addr.ip_port, nil, "::1"], addr.pfamily, addr.socktype, addr.protocol)
elsif addr.ip_address == "0.0.0.0" # MacOS X 10.4 returns "a.b.c.d" for IPv4-mapped IPv6 address.
addr = Addrinfo.new(["AF_INET6", addr.ip_port, nil, "::1"], addr.pfamily, addr.socktype, addr.protocol)
elsif addr.ip_address == "::ffff:0.0.0.0" # MacOS X 10.6 returns "::ffff:a.b.c.d" for IPv4-mapped IPv6 address.
addr = Addrinfo.new(["AF_INET6", addr.ip_port, nil, "::1"], addr.pfamily, addr.socktype, addr.protocol)
end
elsif defined?(Socket::AF_UNIX) && afamily == Socket::AF_UNIX
raise SocketError, "unbound Unix socket" if addr.unix_path == ""
end
addr
end
# call-seq:
# basicsocket.sendmsg(mesg, flags=0, dest_sockaddr=nil, *controls) => numbytes_sent
#
# sendmsg sends a message using sendmsg(2) system call in blocking manner.
#
# _mesg_ is a string to send.
#
# _flags_ is bitwise OR of MSG_* constants such as Socket::MSG_OOB.
#
# _dest_sockaddr_ is a destination socket address for connection-less socket.
# It should be a sockaddr such as a result of Socket.sockaddr_in.
# An Addrinfo object can be used too.
#
# _controls_ is a list of ancillary data.
# The element of _controls_ should be Socket::AncillaryData or
# 3-elements array.
# The 3-element array should contains cmsg_level, cmsg_type and data.
#
# The return value, _numbytes_sent_ is an integer which is the number of bytes sent.
#
# sendmsg can be used to implement send_io as follows:
#
# # use Socket::AncillaryData.
# ancdata = Socket::AncillaryData.int(:UNIX, :SOCKET, :RIGHTS, io.fileno)
# sock.sendmsg("a", 0, nil, ancdata)
#
# # use 3-element array.
# ancdata = [:SOCKET, :RIGHTS, [io.fileno].pack("i!")]
# sock.sendmsg("\0", 0, nil, ancdata)
def sendmsg(mesg, flags = 0, dest_sockaddr = nil, *controls)
__sendmsg(mesg, flags, dest_sockaddr, controls)
end
# call-seq:
# basicsocket.sendmsg_nonblock(mesg, flags=0, dest_sockaddr=nil, *controls, opts={}) => numbytes_sent
#
# sendmsg_nonblock sends a message using sendmsg(2) system call in non-blocking manner.
#
# It is similar to BasicSocket#sendmsg
# but the non-blocking flag is set before the system call
# and it doesn't retry the system call.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that sendmsg_nonblock should not raise an IO::WaitWritable exception, but
# return the symbol +:wait_writable+ instead.
def sendmsg_nonblock(mesg, flags = 0, dest_sockaddr = nil, *controls,
exception: true)
__sendmsg_nonblock(mesg, flags, dest_sockaddr, controls, exception)
end
# call-seq:
# basicsocket.recv_nonblock(maxlen [, flags [, buf [, options ]]]) => mesg
#
# Receives up to _maxlen_ bytes from +socket+ using recvfrom(2) after
# O_NONBLOCK is set for the underlying file descriptor.
# _flags_ is zero or more of the +MSG_+ options.
# The result, _mesg_, is the data received.
#
# When recvfrom(2) returns 0, Socket#recv_nonblock returns nil.
# In most cases it means the connection was closed, but for UDP connections
# it may mean an empty packet was received, as the underlying API makes
# it impossible to distinguish these two cases.
#
# === Parameters
# * +maxlen+ - the number of bytes to receive from the socket
# * +flags+ - zero or more of the +MSG_+ options
# * +buf+ - destination String buffer
# * +options+ - keyword hash, supporting `exception: false`
#
# === Example
# serv = TCPServer.new("127.0.0.1", 0)
# af, port, host, addr = serv.addr
# c = TCPSocket.new(addr, port)
# s = serv.accept
# c.send "aaa", 0
# begin # emulate blocking recv.
# p s.recv_nonblock(10) #=> "aaa"
# rescue IO::WaitReadable
# IO.select([s])
# retry
# end
#
# Refer to Socket#recvfrom for the exceptions that may be thrown if the call
# to _recv_nonblock_ fails.
#
# BasicSocket#recv_nonblock may raise any error corresponding to recvfrom(2) failure,
# including Errno::EWOULDBLOCK.
#
# If the exception is Errno::EWOULDBLOCK or Errno::EAGAIN,
# it is extended by IO::WaitReadable.
# So IO::WaitReadable can be used to rescue the exceptions for retrying recv_nonblock.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that recv_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol +:wait_readable+ instead.
#
# === See
# * Socket#recvfrom
def recv_nonblock(len, flag = 0, str = nil, exception: true)
__recv_nonblock(len, flag, str, exception)
end
# call-seq:
# basicsocket.recvmsg(maxmesglen=nil, flags=0, maxcontrollen=nil, opts={}) => [mesg, sender_addrinfo, rflags, *controls]
#
# recvmsg receives a message using recvmsg(2) system call in blocking manner.
#
# _maxmesglen_ is the maximum length of mesg to receive.
#
# _flags_ is bitwise OR of MSG_* constants such as Socket::MSG_PEEK.
#
# _maxcontrollen_ is the maximum length of controls (ancillary data) to receive.
#
# _opts_ is option hash.
# Currently :scm_rights=>bool is the only option.
#
# :scm_rights option specifies that application expects SCM_RIGHTS control message.
# If the value is nil or false, application don't expects SCM_RIGHTS control message.
# In this case, recvmsg closes the passed file descriptors immediately.
# This is the default behavior.
#
# If :scm_rights value is neither nil nor false, application expects SCM_RIGHTS control message.
# In this case, recvmsg creates IO objects for each file descriptors for
# Socket::AncillaryData#unix_rights method.
#
# The return value is 4-elements array.
#
# _mesg_ is a string of the received message.
#
# _sender_addrinfo_ is a sender socket address for connection-less socket.
# It is an Addrinfo object.
# For connection-oriented socket such as TCP, sender_addrinfo is platform dependent.
#
# _rflags_ is a flags on the received message which is bitwise OR of MSG_* constants such as Socket::MSG_TRUNC.
# It will be nil if the system uses 4.3BSD style old recvmsg system call.
#
# _controls_ is ancillary data which is an array of Socket::AncillaryData objects such as:
#
# #<Socket::AncillaryData: AF_UNIX SOCKET RIGHTS 7>
#
# _maxmesglen_ and _maxcontrollen_ can be nil.
# In that case, the buffer will be grown until the message is not truncated.
# Internally, MSG_PEEK is used.
# Buffer full and MSG_CTRUNC are checked for truncation.
#
# recvmsg can be used to implement recv_io as follows:
#
# mesg, sender_sockaddr, rflags, *controls = sock.recvmsg(:scm_rights=>true)
# controls.each {|ancdata|
# if ancdata.cmsg_is?(:SOCKET, :RIGHTS)
# return ancdata.unix_rights[0]
# end
# }
def recvmsg(dlen = nil, flags = 0, clen = nil, scm_rights: false)
__recvmsg(dlen, flags, clen, scm_rights)
end
# call-seq:
# basicsocket.recvmsg_nonblock(maxdatalen=nil, flags=0, maxcontrollen=nil, opts={}) => [data, sender_addrinfo, rflags, *controls]
#
# recvmsg receives a message using recvmsg(2) system call in non-blocking manner.
#
# It is similar to BasicSocket#recvmsg
# but non-blocking flag is set before the system call
# and it doesn't retry the system call.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that recvmsg_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol +:wait_readable+ instead.
def recvmsg_nonblock(dlen = nil, flags = 0, clen = nil,
scm_rights: false, exception: true)
__recvmsg_nonblock(dlen, flags, clen, scm_rights, exception)
end
# Linux-specific optimizations to avoid fcntl for IO#read_nonblock
# and IO#write_nonblock using MSG_DONTWAIT
# Do other platforms support MSG_DONTWAIT reliably?
if RUBY_PLATFORM =~ /linux/ && Socket.const_defined?(:MSG_DONTWAIT)
def read_nonblock(len, str = nil, exception: true) # :nodoc:
__read_nonblock(len, str, exception)
end
def write_nonblock(buf, exception: true) # :nodoc:
__write_nonblock(buf, exception)
end
end
end
class Socket < BasicSocket
# enable the socket option IPV6_V6ONLY if IPV6_V6ONLY is available.
def ipv6only!
if defined? Socket::IPV6_V6ONLY
self.setsockopt(:IPV6, :V6ONLY, 1)
end
end
# call-seq:
# socket.recvfrom_nonblock(maxlen[, flags[, outbuf[, opts]]]) => [mesg, sender_addrinfo]
#
# Receives up to _maxlen_ bytes from +socket+ using recvfrom(2) after
# O_NONBLOCK is set for the underlying file descriptor.
# _flags_ is zero or more of the +MSG_+ options.
# The first element of the results, _mesg_, is the data received.
# The second element, _sender_addrinfo_, contains protocol-specific address
# information of the sender.
#
# When recvfrom(2) returns 0, Socket#recv_nonblock returns nil.
# In most cases it means the connection was closed, but for UDP connections
# it may mean an empty packet was received, as the underlying API makes
# it impossible to distinguish these two cases.
#
# === Parameters
# * +maxlen+ - the maximum number of bytes to receive from the socket
# * +flags+ - zero or more of the +MSG_+ options
# * +outbuf+ - destination String buffer
# * +opts+ - keyword hash, supporting `exception: false`
#
# === Example
# # In one file, start this first
# require 'socket'
# include Socket::Constants
# socket = Socket.new(AF_INET, SOCK_STREAM, 0)
# sockaddr = Socket.sockaddr_in(2200, 'localhost')
# socket.bind(sockaddr)
# socket.listen(5)
# client, client_addrinfo = socket.accept
# begin # emulate blocking recvfrom
# pair = client.recvfrom_nonblock(20)
# rescue IO::WaitReadable
# IO.select([client])
# retry
# end
# data = pair[0].chomp
# puts "I only received 20 bytes '#{data}'"
# sleep 1
# socket.close
#
# # In another file, start this second
# require 'socket'
# include Socket::Constants
# socket = Socket.new(AF_INET, SOCK_STREAM, 0)
# sockaddr = Socket.sockaddr_in(2200, 'localhost')
# socket.connect(sockaddr)
# socket.puts "Watch this get cut short!"
# socket.close
#
# Refer to Socket#recvfrom for the exceptions that may be thrown if the call
# to _recvfrom_nonblock_ fails.
#
# Socket#recvfrom_nonblock may raise any error corresponding to recvfrom(2) failure,
# including Errno::EWOULDBLOCK.
#
# If the exception is Errno::EWOULDBLOCK or Errno::EAGAIN,
# it is extended by IO::WaitReadable.
# So IO::WaitReadable can be used to rescue the exceptions for retrying
# recvfrom_nonblock.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol +:wait_readable+ instead.
#
# === See
# * Socket#recvfrom
def recvfrom_nonblock(len, flag = 0, str = nil, exception: true)
__recvfrom_nonblock(len, flag, str, exception)
end
# call-seq:
# socket.accept_nonblock([options]) => [client_socket, client_addrinfo]
#
# Accepts an incoming connection using accept(2) after
# O_NONBLOCK is set for the underlying file descriptor.
# It returns an array containing the accepted socket
# for the incoming connection, _client_socket_,
# and an Addrinfo, _client_addrinfo_.
#
# === Example
# # In one script, start this first
# require 'socket'
# include Socket::Constants
# socket = Socket.new(AF_INET, SOCK_STREAM, 0)
# sockaddr = Socket.sockaddr_in(2200, 'localhost')
# socket.bind(sockaddr)
# socket.listen(5)
# begin # emulate blocking accept
# client_socket, client_addrinfo = socket.accept_nonblock
# rescue IO::WaitReadable, Errno::EINTR
# IO.select([socket])
# retry
# end
# puts "The client said, '#{client_socket.readline.chomp}'"
# client_socket.puts "Hello from script one!"
# socket.close
#
# # In another script, start this second
# require 'socket'
# include Socket::Constants
# socket = Socket.new(AF_INET, SOCK_STREAM, 0)
# sockaddr = Socket.sockaddr_in(2200, 'localhost')
# socket.connect(sockaddr)
# socket.puts "Hello from script 2."
# puts "The server said, '#{socket.readline.chomp}'"
# socket.close
#
# Refer to Socket#accept for the exceptions that may be thrown if the call
# to _accept_nonblock_ fails.
#
# Socket#accept_nonblock may raise any error corresponding to accept(2) failure,
# including Errno::EWOULDBLOCK.
#
# If the exception is Errno::EWOULDBLOCK, Errno::EAGAIN, Errno::ECONNABORTED or Errno::EPROTO,
# it is extended by IO::WaitReadable.
# So IO::WaitReadable can be used to rescue the exceptions for retrying accept_nonblock.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that accept_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol +:wait_readable+ instead.
#
# === See
# * Socket#accept
def accept_nonblock(exception: true)
__accept_nonblock(exception)
end
# :call-seq:
# Socket.tcp(host, port, local_host=nil, local_port=nil, [opts]) {|socket| ... }
# Socket.tcp(host, port, local_host=nil, local_port=nil, [opts])
#
# creates a new socket object connected to host:port using TCP/IP.
#
# If local_host:local_port is given,
# the socket is bound to it.
#
# The optional last argument _opts_ is options represented by a hash.
# _opts_ may have following options:
#
# [:connect_timeout] specify the timeout in seconds.
#
# If a block is given, the block is called with the socket.
# The value of the block is returned.
# The socket is closed when this method returns.
#
# If no block is given, the socket is returned.
#
# Socket.tcp("www.ruby-lang.org", 80) {|sock|
# sock.print "GET / HTTP/1.0\r\nHost: www.ruby-lang.org\r\n\r\n"
# sock.close_write
# puts sock.read
# }
#
def self.tcp(host, port, local_host = nil, local_port = nil, connect_timeout: nil, resolv_timeout: nil) # :yield: socket
last_error = nil
ret = nil
local_addr_list = nil
if local_host != nil || local_port != nil
local_addr_list = Addrinfo.getaddrinfo(local_host, local_port, nil, :STREAM, nil)
end
Addrinfo.foreach(host, port, nil, :STREAM, timeout: resolv_timeout) {|ai|
if local_addr_list
local_addr = local_addr_list.find {|local_ai| local_ai.afamily == ai.afamily }
next unless local_addr
else
local_addr = nil
end
begin
sock = local_addr ?
ai.connect_from(local_addr, timeout: connect_timeout) :
ai.connect(timeout: connect_timeout)
rescue SystemCallError
last_error = $!
next
end
ret = sock
break
}
unless ret
if last_error
raise last_error
else
raise SocketError, "no appropriate local address"
end
end
if block_given?
begin
yield ret
ensure
ret.close
end
else
ret
end
end
# :stopdoc:
def self.ip_sockets_port0(ai_list, reuseaddr)
sockets = []
begin
sockets.clear
port = nil
ai_list.each {|ai|
begin
s = Socket.new(ai.pfamily, ai.socktype, ai.protocol)
rescue SystemCallError
next
end
sockets << s
s.ipv6only! if ai.ipv6?
if reuseaddr
s.setsockopt(:SOCKET, :REUSEADDR, 1)
end
unless port
s.bind(ai)
port = s.local_address.ip_port
else
s.bind(ai.family_addrinfo(ai.ip_address, port))
end
}
rescue Errno::EADDRINUSE
sockets.each(&:close)
retry
rescue Exception
sockets.each(&:close)
raise
end
sockets
end
class << self
private :ip_sockets_port0
end
def self.tcp_server_sockets_port0(host)
ai_list = Addrinfo.getaddrinfo(host, 0, nil, :STREAM, nil, Socket::AI_PASSIVE)
sockets = ip_sockets_port0(ai_list, true)
begin
sockets.each {|s|
s.listen(Socket::SOMAXCONN)
}
rescue Exception
sockets.each(&:close)
raise
end
sockets
end
class << self
private :tcp_server_sockets_port0
end
# :startdoc:
# creates TCP/IP server sockets for _host_ and _port_.
# _host_ is optional.
#
# If no block given,
# it returns an array of listening sockets.
#
# If a block is given, the block is called with the sockets.
# The value of the block is returned.
# The socket is closed when this method returns.
#
# If _port_ is 0, actual port number is chosen dynamically.
# However all sockets in the result has same port number.
#
# # tcp_server_sockets returns two sockets.
# sockets = Socket.tcp_server_sockets(1296)
# p sockets #=> [#<Socket:fd 3>, #<Socket:fd 4>]
#
# # The sockets contains IPv6 and IPv4 sockets.
# sockets.each {|s| p s.local_address }
# #=> #<Addrinfo: [::]:1296 TCP>
# # #<Addrinfo: 0.0.0.0:1296 TCP>
#
# # IPv6 and IPv4 socket has same port number, 53114, even if it is chosen dynamically.
# sockets = Socket.tcp_server_sockets(0)
# sockets.each {|s| p s.local_address }
# #=> #<Addrinfo: [::]:53114 TCP>
# # #<Addrinfo: 0.0.0.0:53114 TCP>
#
# # The block is called with the sockets.
# Socket.tcp_server_sockets(0) {|sockets|
# p sockets #=> [#<Socket:fd 3>, #<Socket:fd 4>]
# }
#
def self.tcp_server_sockets(host=nil, port)
if port == 0
sockets = tcp_server_sockets_port0(host)
else
last_error = nil
sockets = []
begin
Addrinfo.foreach(host, port, nil, :STREAM, nil, Socket::AI_PASSIVE) {|ai|
begin
s = ai.listen
rescue SystemCallError
last_error = $!
next
end
sockets << s
}
if sockets.empty?
raise last_error
end
rescue Exception
sockets.each(&:close)
raise
end
end
if block_given?
begin
yield sockets
ensure
sockets.each(&:close)
end
else
sockets
end
end
# yield socket and client address for each a connection accepted via given sockets.
#
# The arguments are a list of sockets.
# The individual argument should be a socket or an array of sockets.
#
# This method yields the block sequentially.
# It means that the next connection is not accepted until the block returns.
# So concurrent mechanism, thread for example, should be used to service multiple clients at a time.
#
def self.accept_loop(*sockets) # :yield: socket, client_addrinfo
sockets.flatten!(1)
if sockets.empty?
raise ArgumentError, "no sockets"
end
loop {
readable, _, _ = IO.select(sockets)
readable.each {|r|
sock, addr = r.accept_nonblock(exception: false)
next if sock == :wait_readable
yield sock, addr
}
}
end
# creates a TCP/IP server on _port_ and calls the block for each connection accepted.
# The block is called with a socket and a client_address as an Addrinfo object.
#
# If _host_ is specified, it is used with _port_ to determine the server addresses.
#
# The socket is *not* closed when the block returns.
# So application should close it explicitly.
#
# This method calls the block sequentially.
# It means that the next connection is not accepted until the block returns.
# So concurrent mechanism, thread for example, should be used to service multiple clients at a time.
#
# Note that Addrinfo.getaddrinfo is used to determine the server socket addresses.
# When Addrinfo.getaddrinfo returns two or more addresses,
# IPv4 and IPv6 address for example,
# all of them are used.
# Socket.tcp_server_loop succeeds if one socket can be used at least.
#
# # Sequential echo server.
# # It services only one client at a time.
# Socket.tcp_server_loop(16807) {|sock, client_addrinfo|
# begin
# IO.copy_stream(sock, sock)
# ensure
# sock.close
# end
# }
#
# # Threaded echo server
# # It services multiple clients at a time.
# # Note that it may accept connections too much.
# Socket.tcp_server_loop(16807) {|sock, client_addrinfo|
# Thread.new {
# begin
# IO.copy_stream(sock, sock)
# ensure
# sock.close
# end
# }
# }
#
def self.tcp_server_loop(host=nil, port, &b) # :yield: socket, client_addrinfo
tcp_server_sockets(host, port) {|sockets|
accept_loop(sockets, &b)
}
end
# :call-seq:
# Socket.udp_server_sockets([host, ] port)
#
# Creates UDP/IP sockets for a UDP server.
#
# If no block given, it returns an array of sockets.
#
# If a block is given, the block is called with the sockets.
# The value of the block is returned.
# The sockets are closed when this method returns.
#
# If _port_ is zero, some port is chosen.
# But the chosen port is used for the all sockets.
#
# # UDP/IP echo server
# Socket.udp_server_sockets(0) {|sockets|
# p sockets.first.local_address.ip_port #=> 32963
# Socket.udp_server_loop_on(sockets) {|msg, msg_src|
# msg_src.reply msg
# }
# }
#
def self.udp_server_sockets(host=nil, port)
last_error = nil
sockets = []
ipv6_recvpktinfo = nil
if defined? Socket::AncillaryData
if defined? Socket::IPV6_RECVPKTINFO # RFC 3542
ipv6_recvpktinfo = Socket::IPV6_RECVPKTINFO
elsif defined? Socket::IPV6_PKTINFO # RFC 2292
ipv6_recvpktinfo = Socket::IPV6_PKTINFO
end
end
local_addrs = Socket.ip_address_list
ip_list = []
Addrinfo.foreach(host, port, nil, :DGRAM, nil, Socket::AI_PASSIVE) {|ai|
if ai.ipv4? && ai.ip_address == "0.0.0.0"
local_addrs.each {|a|
next unless a.ipv4?
ip_list << Addrinfo.new(a.to_sockaddr, :INET, :DGRAM, 0);
}
elsif ai.ipv6? && ai.ip_address == "::" && !ipv6_recvpktinfo
local_addrs.each {|a|
next unless a.ipv6?
ip_list << Addrinfo.new(a.to_sockaddr, :INET6, :DGRAM, 0);
}
else
ip_list << ai
end
}
ip_list.uniq!(&:to_sockaddr)
if port == 0
sockets = ip_sockets_port0(ip_list, false)
else
ip_list.each {|ip|
ai = Addrinfo.udp(ip.ip_address, port)
begin
s = ai.bind
rescue SystemCallError
last_error = $!
next
end
sockets << s
}
if sockets.empty?
raise last_error
end
end
sockets.each {|s|
ai = s.local_address
if ipv6_recvpktinfo && ai.ipv6? && ai.ip_address == "::"
s.setsockopt(:IPV6, ipv6_recvpktinfo, 1)
end
}
if block_given?
begin
yield sockets
ensure
sockets.each(&:close) if sockets
end
else
sockets
end
end
# :call-seq:
# Socket.udp_server_recv(sockets) {|msg, msg_src| ... }
#
# Receive UDP/IP packets from the given _sockets_.
# For each packet received, the block is called.
#
# The block receives _msg_ and _msg_src_.
# _msg_ is a string which is the payload of the received packet.
# _msg_src_ is a Socket::UDPSource object which is used for reply.
#
# Socket.udp_server_loop can be implemented using this method as follows.
#
# udp_server_sockets(host, port) {|sockets|
# loop {
# readable, _, _ = IO.select(sockets)
# udp_server_recv(readable) {|msg, msg_src| ... }
# }
# }
#
def self.udp_server_recv(sockets)
sockets.each {|r|
msg, sender_addrinfo, _, *controls = r.recvmsg_nonblock(exception: false)
next if msg == :wait_readable
ai = r.local_address
if ai.ipv6? and pktinfo = controls.find {|c| c.cmsg_is?(:IPV6, :PKTINFO) }
ai = Addrinfo.udp(pktinfo.ipv6_pktinfo_addr.ip_address, ai.ip_port)
yield msg, UDPSource.new(sender_addrinfo, ai) {|reply_msg|
r.sendmsg reply_msg, 0, sender_addrinfo, pktinfo
}
else
yield msg, UDPSource.new(sender_addrinfo, ai) {|reply_msg|
r.send reply_msg, 0, sender_addrinfo
}
end
}
end
# :call-seq:
# Socket.udp_server_loop_on(sockets) {|msg, msg_src| ... }
#
# Run UDP/IP server loop on the given sockets.
#
# The return value of Socket.udp_server_sockets is appropriate for the argument.
#
# It calls the block for each message received.
#
def self.udp_server_loop_on(sockets, &b) # :yield: msg, msg_src
loop {
readable, _, _ = IO.select(sockets)
udp_server_recv(readable, &b)
}
end
# :call-seq:
# Socket.udp_server_loop(port) {|msg, msg_src| ... }
# Socket.udp_server_loop(host, port) {|msg, msg_src| ... }
#
# creates a UDP/IP server on _port_ and calls the block for each message arrived.
# The block is called with the message and its source information.
#
# This method allocates sockets internally using _port_.
# If _host_ is specified, it is used conjunction with _port_ to determine the server addresses.
#
# The _msg_ is a string.
#
# The _msg_src_ is a Socket::UDPSource object.
# It is used for reply.
#
# # UDP/IP echo server.
# Socket.udp_server_loop(9261) {|msg, msg_src|
# msg_src.reply msg
# }
#
def self.udp_server_loop(host=nil, port, &b) # :yield: message, message_source
udp_server_sockets(host, port) {|sockets|
udp_server_loop_on(sockets, &b)
}
end
# UDP/IP address information used by Socket.udp_server_loop.
class UDPSource
# +remote_address+ is an Addrinfo object.
#
# +local_address+ is an Addrinfo object.
#
# +reply_proc+ is a Proc used to send reply back to the source.
def initialize(remote_address, local_address, &reply_proc)
@remote_address = remote_address
@local_address = local_address
@reply_proc = reply_proc
end
# Address of the source
attr_reader :remote_address
# Local address
attr_reader :local_address
def inspect # :nodoc:
"\#<#{self.class}: #{@remote_address.inspect_sockaddr} to #{@local_address.inspect_sockaddr}>".dup
end
# Sends the String +msg+ to the source
def reply(msg)
@reply_proc.call msg
end
end
# creates a new socket connected to path using UNIX socket socket.
#
# If a block is given, the block is called with the socket.
# The value of the block is returned.
# The socket is closed when this method returns.
#
# If no block is given, the socket is returned.
#
# # talk to /tmp/sock socket.
# Socket.unix("/tmp/sock") {|sock|
# t = Thread.new { IO.copy_stream(sock, STDOUT) }
# IO.copy_stream(STDIN, sock)
# t.join
# }
#
def self.unix(path) # :yield: socket
addr = Addrinfo.unix(path)
sock = addr.connect
if block_given?
begin
yield sock
ensure
sock.close
end
else
sock
end
end
# creates a UNIX server socket on _path_
#
# If no block given, it returns a listening socket.
#
# If a block is given, it is called with the socket and the block value is returned.
# When the block exits, the socket is closed and the socket file is removed.
#
# socket = Socket.unix_server_socket("/tmp/s")
# p socket #=> #<Socket:fd 3>
# p socket.local_address #=> #<Addrinfo: /tmp/s SOCK_STREAM>
#
# Socket.unix_server_socket("/tmp/sock") {|s|
# p s #=> #<Socket:fd 3>
# p s.local_address #=> # #<Addrinfo: /tmp/sock SOCK_STREAM>
# }
#
def self.unix_server_socket(path)
unless unix_socket_abstract_name?(path)
begin
st = File.lstat(path)
rescue Errno::ENOENT
end
if st&.socket? && st.owned?
File.unlink path
end
end
s = Addrinfo.unix(path).listen
if block_given?
begin
yield s
ensure
s.close
unless unix_socket_abstract_name?(path)
File.unlink path
end
end
else
s
end
end
class << self
private
def unix_socket_abstract_name?(path)
/linux/ =~ RUBY_PLATFORM && /\A(\0|\z)/ =~ path
end
end
# creates a UNIX socket server on _path_.
# It calls the block for each socket accepted.
#
# If _host_ is specified, it is used with _port_ to determine the server ports.
#
# The socket is *not* closed when the block returns.
# So application should close it.
#
# This method deletes the socket file pointed by _path_ at first if
# the file is a socket file and it is owned by the user of the application.
# This is safe only if the directory of _path_ is not changed by a malicious user.
# So don't use /tmp/malicious-users-directory/socket.
# Note that /tmp/socket and /tmp/your-private-directory/socket is safe assuming that /tmp has sticky bit.
#
# # Sequential echo server.
# # It services only one client at a time.
# Socket.unix_server_loop("/tmp/sock") {|sock, client_addrinfo|
# begin
# IO.copy_stream(sock, sock)
# ensure
# sock.close
# end
# }
#
def self.unix_server_loop(path, &b) # :yield: socket, client_addrinfo
unix_server_socket(path) {|serv|
accept_loop(serv, &b)
}
end
# call-seq:
# socket.connect_nonblock(remote_sockaddr, [options]) => 0
#
# Requests a connection to be made on the given +remote_sockaddr+ after
# O_NONBLOCK is set for the underlying file descriptor.
# Returns 0 if successful, otherwise an exception is raised.
#
# === Parameter
# # +remote_sockaddr+ - the +struct+ sockaddr contained in a string or Addrinfo object
#
# === Example:
# # Pull down Google's web page
# require 'socket'
# include Socket::Constants
# socket = Socket.new(AF_INET, SOCK_STREAM, 0)
# sockaddr = Socket.sockaddr_in(80, 'www.google.com')
# begin # emulate blocking connect
# socket.connect_nonblock(sockaddr)
# rescue IO::WaitWritable
# IO.select(nil, [socket]) # wait 3-way handshake completion
# begin
# socket.connect_nonblock(sockaddr) # check connection failure
# rescue Errno::EISCONN
# end
# end
# socket.write("GET / HTTP/1.0\r\n\r\n")
# results = socket.read
#
# Refer to Socket#connect for the exceptions that may be thrown if the call
# to _connect_nonblock_ fails.
#
# Socket#connect_nonblock may raise any error corresponding to connect(2) failure,
# including Errno::EINPROGRESS.
#
# If the exception is Errno::EINPROGRESS,
# it is extended by IO::WaitWritable.
# So IO::WaitWritable can be used to rescue the exceptions for retrying connect_nonblock.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that connect_nonblock should not raise an IO::WaitWritable exception, but
# return the symbol +:wait_writable+ instead.
#
# === See
# # Socket#connect
def connect_nonblock(addr, exception: true)
__connect_nonblock(addr, exception)
end
end
class UDPSocket < IPSocket
# call-seq:
# udpsocket.recvfrom_nonblock(maxlen [, flags[, outbuf [, options]]]) => [mesg, sender_inet_addr]
#
# Receives up to _maxlen_ bytes from +udpsocket+ using recvfrom(2) after
# O_NONBLOCK is set for the underlying file descriptor.
# _flags_ is zero or more of the +MSG_+ options.
# The first element of the results, _mesg_, is the data received.
# The second element, _sender_inet_addr_, is an array to represent the sender address.
#
# When recvfrom(2) returns 0, Socket#recv_nonblock returns nil.
# In most cases it means the connection was closed, but it may also mean
# an empty packet was received, as the underlying API makes
# it impossible to distinguish these two cases.
#
# === Parameters
# * +maxlen+ - the number of bytes to receive from the socket
# * +flags+ - zero or more of the +MSG_+ options
# * +outbuf+ - destination String buffer
# * +options+ - keyword hash, supporting `exception: false`
#
# === Example
# require 'socket'
# s1 = UDPSocket.new
# s1.bind("127.0.0.1", 0)
# s2 = UDPSocket.new
# s2.bind("127.0.0.1", 0)
# s2.connect(*s1.addr.values_at(3,1))
# s1.connect(*s2.addr.values_at(3,1))
# s1.send "aaa", 0
# begin # emulate blocking recvfrom
# p s2.recvfrom_nonblock(10) #=> ["aaa", ["AF_INET", 33302, "localhost.localdomain", "127.0.0.1"]]
# rescue IO::WaitReadable
# IO.select([s2])
# retry
# end
#
# Refer to Socket#recvfrom for the exceptions that may be thrown if the call
# to _recvfrom_nonblock_ fails.
#
# UDPSocket#recvfrom_nonblock may raise any error corresponding to recvfrom(2) failure,
# including Errno::EWOULDBLOCK.
#
# If the exception is Errno::EWOULDBLOCK or Errno::EAGAIN,
# it is extended by IO::WaitReadable.
# So IO::WaitReadable can be used to rescue the exceptions for retrying recvfrom_nonblock.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that recvfrom_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol +:wait_readable+ instead.
#
# === See
# * Socket#recvfrom
def recvfrom_nonblock(len, flag = 0, outbuf = nil, exception: true)
__recvfrom_nonblock(len, flag, outbuf, exception)
end
end
class TCPServer < TCPSocket
# call-seq:
# tcpserver.accept_nonblock([options]) => tcpsocket
#
# Accepts an incoming connection using accept(2) after
# O_NONBLOCK is set for the underlying file descriptor.
# It returns an accepted TCPSocket for the incoming connection.
#
# === Example
# require 'socket'
# serv = TCPServer.new(2202)
# begin # emulate blocking accept
# sock = serv.accept_nonblock
# rescue IO::WaitReadable, Errno::EINTR
# IO.select([serv])
# retry
# end
# # sock is an accepted socket.
#
# Refer to Socket#accept for the exceptions that may be thrown if the call
# to TCPServer#accept_nonblock fails.
#
# TCPServer#accept_nonblock may raise any error corresponding to accept(2) failure,
# including Errno::EWOULDBLOCK.
#
# If the exception is Errno::EWOULDBLOCK, Errno::EAGAIN, Errno::ECONNABORTED, Errno::EPROTO,
# it is extended by IO::WaitReadable.
# So IO::WaitReadable can be used to rescue the exceptions for retrying accept_nonblock.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that accept_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol +:wait_readable+ instead.
#
# === See
# * TCPServer#accept
# * Socket#accept
def accept_nonblock(exception: true)
__accept_nonblock(exception)
end
end
class UNIXServer < UNIXSocket
# call-seq:
# unixserver.accept_nonblock([options]) => unixsocket
#
# Accepts an incoming connection using accept(2) after
# O_NONBLOCK is set for the underlying file descriptor.
# It returns an accepted UNIXSocket for the incoming connection.
#
# === Example
# require 'socket'
# serv = UNIXServer.new("/tmp/sock")
# begin # emulate blocking accept
# sock = serv.accept_nonblock
# rescue IO::WaitReadable, Errno::EINTR
# IO.select([serv])
# retry
# end
# # sock is an accepted socket.
#
# Refer to Socket#accept for the exceptions that may be thrown if the call
# to UNIXServer#accept_nonblock fails.
#
# UNIXServer#accept_nonblock may raise any error corresponding to accept(2) failure,
# including Errno::EWOULDBLOCK.
#
# If the exception is Errno::EWOULDBLOCK, Errno::EAGAIN, Errno::ECONNABORTED or Errno::EPROTO,
# it is extended by IO::WaitReadable.
# So IO::WaitReadable can be used to rescue the exceptions for retrying accept_nonblock.
#
# By specifying a keyword argument _exception_ to +false+, you can indicate
# that accept_nonblock should not raise an IO::WaitReadable exception, but
# return the symbol +:wait_readable+ instead.
#
# === See
# * UNIXServer#accept
# * Socket#accept
def accept_nonblock(exception: true)
__accept_nonblock(exception)
end
end if defined?(UNIXSocket)
share/ruby/did_you_mean/experimental.rb 0000644 00000000213 15173517740 0014313 0 ustar 00 warn "Experimental features in the did_you_mean gem has been removed " \
"and `require \"did_you_mean/experimental\"' has no effect."
share/ruby/did_you_mean/core_ext/name_error.rb 0000644 00000002420 15173517740 0015561 0 ustar 00 module DidYouMean
module Correctable
if Exception.method_defined?(:detailed_message)
# just for compatibility
def original_message
# we cannot use alias here because
to_s
end
def detailed_message(highlight: true, did_you_mean: true, **)
msg = super.dup
return msg unless did_you_mean
suggestion = DidYouMean.formatter.message_for(corrections)
if highlight
suggestion = suggestion.gsub(/.+/) { "\e[1m" + $& + "\e[m" }
end
msg << suggestion
msg
rescue
super
end
else
SKIP_TO_S_FOR_SUPER_LOOKUP = true
private_constant :SKIP_TO_S_FOR_SUPER_LOOKUP
def original_message
meth = method(:to_s)
while meth.owner.const_defined?(:SKIP_TO_S_FOR_SUPER_LOOKUP)
meth = meth.super_method
end
meth.call
end
def to_s
msg = super.dup
suggestion = DidYouMean.formatter.message_for(corrections)
msg << suggestion if !msg.include?(suggestion)
msg
rescue
super
end
end
def corrections
@corrections ||= spell_checker.corrections
end
def spell_checker
DidYouMean.spell_checkers[self.class.to_s].new(self)
end
end
end
share/ruby/did_you_mean/tree_spell_checker.rb 0000644 00000005471 15173517740 0015453 0 ustar 00 # frozen_string_literal: true
module DidYouMean
# spell checker for a dictionary that has a tree
# structure, see doc/tree_spell_checker_api.md
class TreeSpellChecker
attr_reader :dictionary, :separator, :augment
def initialize(dictionary:, separator: '/', augment: nil)
@dictionary = dictionary
@separator = separator
@augment = augment
end
def correct(input)
plausibles = plausible_dimensions(input)
return fall_back_to_normal_spell_check(input) if plausibles.empty?
suggestions = find_suggestions(input, plausibles)
return fall_back_to_normal_spell_check(input) if suggestions.empty?
suggestions
end
def dictionary_without_leaves
@dictionary_without_leaves ||= dictionary.map { |word| word.split(separator)[0..-2] }.uniq
end
def tree_depth
@tree_depth ||= dictionary_without_leaves.max { |a, b| a.size <=> b.size }.size
end
def dimensions
@dimensions ||= tree_depth.times.map do |index|
dictionary_without_leaves.map { |element| element[index] }.compact.uniq
end
end
def find_leaves(path)
path_with_separator = "#{path}#{separator}"
dictionary
.select {|str| str.include?(path_with_separator) }
.map {|str| str.gsub(path_with_separator, '') }
end
def plausible_dimensions(input)
input.split(separator)[0..-2]
.map
.with_index { |element, index| correct_element(dimensions[index], element) if dimensions[index] }
.compact
end
def possible_paths(states)
states.map { |state| state.join(separator) }
end
private
def find_suggestions(input, plausibles)
states = plausibles[0].product(*plausibles[1..-1])
paths = possible_paths(states)
leaf = input.split(separator).last
find_ideas(paths, leaf)
end
def fall_back_to_normal_spell_check(input)
return [] unless augment
::DidYouMean::SpellChecker.new(dictionary: dictionary).correct(input)
end
def find_ideas(paths, leaf)
paths.flat_map do |path|
names = find_leaves(path)
ideas = correct_element(names, leaf)
ideas_to_paths(ideas, leaf, names, path)
end.compact
end
def ideas_to_paths(ideas, leaf, names, path)
if ideas.empty?
nil
elsif names.include?(leaf)
["#{path}#{separator}#{leaf}"]
else
ideas.map {|str| "#{path}#{separator}#{str}" }
end
end
def correct_element(names, element)
return names if names.size == 1
str = normalize(element)
return [str] if names.include?(str)
::DidYouMean::SpellChecker.new(dictionary: names).correct(str)
end
def normalize(str)
str.downcase!
str.tr!('@', ' ') if str.include?('@')
str
end
end
end
share/ruby/did_you_mean/levenshtein.rb 0000644 00000002537 15173517740 0014155 0 ustar 00 module DidYouMean
module Levenshtein # :nodoc:
# This code is based directly on the Text gem implementation
# Copyright (c) 2006-2013 Paul Battley, Michael Neumann, Tim Fletcher.
#
# Returns a value representing the "cost" of transforming str1 into str2
def distance(str1, str2)
n = str1.length
m = str2.length
return m if n.zero?
return n if m.zero?
d = (0..m).to_a
x = nil
# to avoid duplicating an enumerable object, create it outside of the loop
str2_codepoints = str2.codepoints
str1.each_codepoint.with_index(1) do |char1, i|
j = 0
while j < m
cost = (char1 == str2_codepoints[j]) ? 0 : 1
x = min3(
d[j+1] + 1, # insertion
i + 1, # deletion
d[j] + cost # substitution
)
d[j] = i
i = x
j += 1
end
d[m] = x
end
x
end
module_function :distance
private
# detects the minimum value out of three arguments. This method is
# faster than `[a, b, c].min` and puts less GC pressure.
# See https://github.com/ruby/did_you_mean/pull/1 for a performance
# benchmark.
def min3(a, b, c)
if a < b && a < c
a
elsif b < c
b
else
c
end
end
module_function :min3
end
end
share/ruby/did_you_mean/version.rb 0000644 00000000061 15173517740 0013304 0 ustar 00 module DidYouMean
VERSION = "1.6.3".freeze
end
share/ruby/did_you_mean/jaro_winkler.rb 0000644 00000003451 15173517740 0014313 0 ustar 00 module DidYouMean
module Jaro
module_function
def distance(str1, str2)
str1, str2 = str2, str1 if str1.length > str2.length
length1, length2 = str1.length, str2.length
m = 0.0
t = 0.0
range = (length2 / 2).floor - 1
range = 0 if range < 0
flags1 = 0
flags2 = 0
# Avoid duplicating enumerable objects
str1_codepoints = str1.codepoints
str2_codepoints = str2.codepoints
i = 0
while i < length1
last = i + range
j = (i >= range) ? i - range : 0
while j <= last
if flags2[j] == 0 && str1_codepoints[i] == str2_codepoints[j]
flags2 |= (1 << j)
flags1 |= (1 << i)
m += 1
break
end
j += 1
end
i += 1
end
k = i = 0
while i < length1
if flags1[i] != 0
j = index = k
k = while j < length2
index = j
break(j + 1) if flags2[j] != 0
j += 1
end
t += 1 if str1_codepoints[i] != str2_codepoints[index]
end
i += 1
end
t = (t / 2).floor
m == 0 ? 0 : (m / length1 + m / length2 + (m - t) / m) / 3
end
end
module JaroWinkler
WEIGHT = 0.1
THRESHOLD = 0.7
module_function
def distance(str1, str2)
jaro_distance = Jaro.distance(str1, str2)
if jaro_distance > THRESHOLD
codepoints2 = str2.codepoints
prefix_bonus = 0
i = 0
str1.each_codepoint do |char1|
char1 == codepoints2[i] && i < 4 ? prefix_bonus += 1 : break
i += 1
end
jaro_distance + (prefix_bonus * WEIGHT * (1 - jaro_distance))
else
jaro_distance
end
end
end
end
share/ruby/did_you_mean/formatter.rb 0000644 00000002430 15173517740 0013624 0 ustar 00 # frozen-string-literal: true
module DidYouMean
# The +DidYouMean::Formatter+ is the basic, default formatter for the
# gem. The formatter responds to the +message_for+ method and it returns a
# human readable string.
class Formatter
# Returns a human readable string that contains +corrections+. This
# formatter is designed to be less verbose to not take too much screen
# space while being helpful enough to the user.
#
# @example
#
# formatter = DidYouMean::Formatter.new
#
# # displays suggestions in two lines with the leading empty line
# puts formatter.message_for(["methods", "method"])
#
# Did you mean? methods
# method
# # => nil
#
# # displays an empty line
# puts formatter.message_for([])
#
# # => nil
#
def self.message_for(corrections)
corrections.empty? ? "" : "\nDid you mean? #{corrections.join("\n ")}"
end
def message_for(corrections)
warn "The instance method #message_for has been deprecated. Please use the class method " \
"DidYouMean::Formatter.message_for(...) instead."
self.class.message_for(corrections)
end
end
PlainFormatter = Formatter
deprecate_constant :PlainFormatter
end
share/ruby/did_you_mean/spell_checker.rb 0000644 00000002421 15173517740 0014424 0 ustar 00 # frozen-string-literal: true
require_relative "levenshtein"
require_relative "jaro_winkler"
module DidYouMean
class SpellChecker
def initialize(dictionary:)
@dictionary = dictionary
end
def correct(input)
normalized_input = normalize(input)
threshold = normalized_input.length > 3 ? 0.834 : 0.77
words = @dictionary.select { |word| JaroWinkler.distance(normalize(word), normalized_input) >= threshold }
words.reject! { |word| input.to_s == word.to_s }
words.sort_by! { |word| JaroWinkler.distance(word.to_s, normalized_input) }
words.reverse!
# Correct mistypes
threshold = (normalized_input.length * 0.25).ceil
corrections = words.select { |c| Levenshtein.distance(normalize(c), normalized_input) <= threshold }
# Correct misspells
if corrections.empty?
corrections = words.select do |word|
word = normalize(word)
length = normalized_input.length < word.length ? normalized_input.length : word.length
Levenshtein.distance(word, normalized_input) < length
end.first(1)
end
corrections
end
private
def normalize(str_or_symbol) #:nodoc:
str = str_or_symbol.to_s.downcase
str.tr!("@", "")
str
end
end
end
share/ruby/did_you_mean/spell_checkers/pattern_key_name_checker.rb 0000644 00000001033 15173517740 0021616 0 ustar 00 require_relative "../spell_checker"
module DidYouMean
class PatternKeyNameChecker
def initialize(no_matching_pattern_key_error)
@key = no_matching_pattern_key_error.key
@keys = no_matching_pattern_key_error.matchee.keys
end
def corrections
@corrections ||= exact_matches.empty? ? SpellChecker.new(dictionary: @keys).correct(@key).map(&:inspect) : exact_matches
end
private
def exact_matches
@exact_matches ||= @keys.select { |word| @key == word.to_s }.map(&:inspect)
end
end
end
share/ruby/did_you_mean/spell_checkers/name_error_checkers.rb 0000644 00000001067 15173517740 0020614 0 ustar 00 require_relative 'name_error_checkers/class_name_checker'
require_relative 'name_error_checkers/variable_name_checker'
module DidYouMean
class << (NameErrorCheckers = Object.new)
def new(exception)
case exception.original_message
when /uninitialized constant/
ClassNameChecker
when /undefined local variable or method/,
/undefined method/,
/uninitialized class variable/,
/no member '.*' in struct/
VariableNameChecker
else
NullChecker
end.new(exception)
end
end
end
share/ruby/did_you_mean/spell_checkers/null_checker.rb 0000644 00000000150 15173517740 0017242 0 ustar 00 module DidYouMean
class NullChecker
def initialize(*); end
def corrections; [] end
end
end
share/ruby/did_you_mean/spell_checkers/key_error_checker.rb 0000644 00000000732 15173517740 0020277 0 ustar 00 require_relative "../spell_checker"
module DidYouMean
class KeyErrorChecker
def initialize(key_error)
@key = key_error.key
@keys = key_error.receiver.keys
end
def corrections
@corrections ||= exact_matches.empty? ? SpellChecker.new(dictionary: @keys).correct(@key).map(&:inspect) : exact_matches
end
private
def exact_matches
@exact_matches ||= @keys.select { |word| @key == word.to_s }.map(&:inspect)
end
end
end
share/ruby/did_you_mean/spell_checkers/require_path_checker.rb 0000644 00000002356 15173517740 0020772 0 ustar 00 # frozen-string-literal: true
require_relative "../spell_checker"
require_relative "../tree_spell_checker"
require "rbconfig"
module DidYouMean
class RequirePathChecker
attr_reader :path
INITIAL_LOAD_PATH = $LOAD_PATH.dup.freeze
Ractor.make_shareable(INITIAL_LOAD_PATH) if defined?(Ractor)
ENV_SPECIFIC_EXT = ".#{RbConfig::CONFIG["DLEXT"]}"
Ractor.make_shareable(ENV_SPECIFIC_EXT) if defined?(Ractor)
private_constant :INITIAL_LOAD_PATH, :ENV_SPECIFIC_EXT
def self.requireables
@requireables ||= INITIAL_LOAD_PATH
.flat_map {|path| Dir.glob("**/???*{.rb,#{ENV_SPECIFIC_EXT}}", base: path) }
.map {|path| path.chomp!(".rb") || path.chomp!(ENV_SPECIFIC_EXT) }
end
def initialize(exception)
@path = exception.path
end
def corrections
@corrections ||= begin
threshold = path.size * 2
dictionary = self.class.requireables.reject {|str| str.size >= threshold }
spell_checker = path.include?("/") ? TreeSpellChecker : SpellChecker
spell_checker.new(dictionary: dictionary).correct(path).uniq
end
end
end
end
share/ruby/did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb 0000644 00000004115 15173517740 0025062 0 ustar 00 # frozen-string-literal: true
require_relative "../../spell_checker"
module DidYouMean
class VariableNameChecker
attr_reader :name, :method_names, :lvar_names, :ivar_names, :cvar_names
NAMES_TO_EXCLUDE = { 'foo' => [:fork, :for] }
NAMES_TO_EXCLUDE.default = []
Ractor.make_shareable(NAMES_TO_EXCLUDE) if defined?(Ractor)
# +VariableNameChecker::RB_RESERVED_WORDS+ is the list of all reserved
# words in Ruby. They could be declared like methods are, and a typo would
# cause Ruby to raise a +NameError+ because of the way they are declared.
#
# The +:VariableNameChecker+ will use this list to suggest a reversed word
# if a +NameError+ is raised and found closest matches, excluding:
#
# * +do+
# * +if+
# * +in+
# * +or+
#
# Also see +MethodNameChecker::RB_RESERVED_WORDS+.
RB_RESERVED_WORDS = %i(
BEGIN
END
alias
and
begin
break
case
class
def
defined?
else
elsif
end
ensure
false
for
module
next
nil
not
redo
rescue
retry
return
self
super
then
true
undef
unless
until
when
while
yield
__LINE__
__FILE__
__ENCODING__
)
Ractor.make_shareable(RB_RESERVED_WORDS) if defined?(Ractor)
def initialize(exception)
@name = exception.name.to_s.tr("@", "")
@lvar_names = exception.respond_to?(:local_variables) ? exception.local_variables : []
receiver = exception.receiver
@method_names = receiver.methods + receiver.private_methods
@ivar_names = receiver.instance_variables
@cvar_names = receiver.class.class_variables
@cvar_names += receiver.class_variables if receiver.kind_of?(Module)
end
def corrections
@corrections ||= SpellChecker
.new(dictionary: (RB_RESERVED_WORDS + lvar_names + method_names + ivar_names + cvar_names))
.correct(name).uniq - NAMES_TO_EXCLUDE[@name]
end
end
end
share/ruby/did_you_mean/spell_checkers/name_error_checkers/class_name_checker.rb 0000644 00000002300 15173517740 0024374 0 ustar 00 # frozen-string-literal: true
require_relative "../../spell_checker"
module DidYouMean
class ClassNameChecker
attr_reader :class_name
def initialize(exception)
@class_name, @receiver, @original_message = exception.name, exception.receiver, exception.original_message
end
def corrections
@corrections ||= SpellChecker.new(dictionary: class_names)
.correct(class_name)
.map(&:full_name)
.reject {|qualified_name| @original_message.include?(qualified_name) }
end
def class_names
scopes.flat_map do |scope|
scope.constants.map do |c|
ClassName.new(c, scope == Object ? "" : "#{scope}::")
end
end
end
def scopes
@scopes ||= @receiver.to_s.split("::").inject([Object]) do |_scopes, scope|
_scopes << _scopes.last.const_get(scope)
end.uniq
end
class ClassName < String
attr :namespace
def initialize(name, namespace = '')
super(name.to_s)
@namespace = namespace
end
def full_name
self.class.new("#{namespace}#{self}")
end
end
private_constant :ClassName
end
end
share/ruby/did_you_mean/spell_checkers/method_name_checker.rb 0000644 00000004345 15173517740 0020562 0 ustar 00 require_relative "../spell_checker"
module DidYouMean
class MethodNameChecker
attr_reader :method_name, :receiver
NAMES_TO_EXCLUDE = { NilClass => nil.methods }
NAMES_TO_EXCLUDE.default = []
Ractor.make_shareable(NAMES_TO_EXCLUDE) if defined?(Ractor)
# +MethodNameChecker::RB_RESERVED_WORDS+ is the list of reserved words in
# Ruby that take an argument. Unlike
# +VariableNameChecker::RB_RESERVED_WORDS+, these reserved words require
# an argument, and a +NoMethodError+ is raised due to the presence of the
# argument.
#
# The +MethodNameChecker+ will use this list to suggest a reversed word if
# a +NoMethodError+ is raised and found closest matches.
#
# Also see +VariableNameChecker::RB_RESERVED_WORDS+.
RB_RESERVED_WORDS = %i(
alias
case
def
defined?
elsif
end
ensure
for
rescue
super
undef
unless
until
when
while
yield
)
Ractor.make_shareable(RB_RESERVED_WORDS) if defined?(Ractor)
def initialize(exception)
@method_name = exception.name
@receiver = exception.receiver
@private_call = exception.respond_to?(:private_call?) ? exception.private_call? : false
end
def corrections
@corrections ||= begin
dictionary = method_names
dictionary = RB_RESERVED_WORDS + dictionary if @private_call
SpellChecker.new(dictionary: dictionary).correct(method_name) - names_to_exclude
end
end
def method_names
if Object === receiver
method_names = receiver.methods + receiver.singleton_methods
method_names += receiver.private_methods if @private_call
method_names.uniq!
# Assume that people trying to use a writer are not interested in a reader
# and vice versa
if method_name.match?(/=\Z/)
method_names.select! { |name| name.match?(/=\Z/) }
else
method_names.reject! { |name| name.match?(/=\Z/) }
end
method_names
else
[]
end
end
def names_to_exclude
Object === receiver ? NAMES_TO_EXCLUDE[receiver.class] : []
end
end
end
share/ruby/did_you_mean/formatters/verbose_formatter.rb 0000644 00000000402 15173517740 0017534 0 ustar 00 # frozen-string-literal: true
warn "`require 'did_you_mean/formatters/verbose_formatter'` is deprecated and falls back to the default formatter. "
require_relative '../formatter'
module DidYouMean
# For compatibility:
VerboseFormatter = Formatter
end
share/ruby/did_you_mean/formatters/plain_formatter.rb 0000644 00000000250 15173517740 0017173 0 ustar 00 require_relative '../formatter'
warn "`require 'did_you_mean/formatters/plain_formatter'` is deprecated. Please `require 'did_you_mean/formatter'` " \
"instead."
share/ruby/did_you_mean/verbose.rb 0000644 00000000211 15173517740 0013261 0 ustar 00 warn "The verbose formatter has been removed and now `require 'did_you_mean/verbose'` has no effect. Please " \
"remove this call."
share/gems/gems/io-console-0.7.1/lib/io 0000755 00000000000 15173517740 0013347 0 ustar 00 share/ruby/tempfile.rb 0000644 00000035347 15173517740 0011007 0 ustar 00 # frozen_string_literal: true
#
# tempfile - manipulates temporary files
#
# $Id$
#
require 'delegate'
require 'tmpdir'
# A utility class for managing temporary files. When you create a Tempfile
# object, it will create a temporary file with a unique filename. A Tempfile
# objects behaves just like a File object, and you can perform all the usual
# file operations on it: reading data, writing data, changing its permissions,
# etc. So although this class does not explicitly document all instance methods
# supported by File, you can in fact call any File instance method on a
# Tempfile object.
#
# == Synopsis
#
# require 'tempfile'
#
# file = Tempfile.new('foo')
# file.path # => A unique filename in the OS's temp directory,
# # e.g.: "/tmp/foo.24722.0"
# # This filename contains 'foo' in its basename.
# file.write("hello world")
# file.rewind
# file.read # => "hello world"
# file.close
# file.unlink # deletes the temp file
#
# == Good practices
#
# === Explicit close
#
# When a Tempfile object is garbage collected, or when the Ruby interpreter
# exits, its associated temporary file is automatically deleted. This means
# that it's unnecessary to explicitly delete a Tempfile after use, though
# it's a good practice to do so: not explicitly deleting unused Tempfiles can
# potentially leave behind a large number of temp files on the filesystem
# until they're garbage collected. The existence of these temp files can make
# it harder to determine a new Tempfile filename.
#
# Therefore, one should always call #unlink or close in an ensure block, like
# this:
#
# file = Tempfile.new('foo')
# begin
# # ...do something with file...
# ensure
# file.close
# file.unlink # deletes the temp file
# end
#
# Tempfile.create { ... } exists for this purpose and is more convenient to use.
# Note that Tempfile.create returns a File instance instead of a Tempfile, which
# also avoids the overhead and complications of delegation.
#
# Tempfile.create('foo') do |file|
# # ...do something with file...
# end
#
# === Unlink after creation
#
# On POSIX systems, it's possible to unlink a file right after creating it,
# and before closing it. This removes the filesystem entry without closing
# the file handle, so it ensures that only the processes that already had
# the file handle open can access the file's contents. It's strongly
# recommended that you do this if you do not want any other processes to
# be able to read from or write to the Tempfile, and you do not need to
# know the Tempfile's filename either.
#
# For example, a practical use case for unlink-after-creation would be this:
# you need a large byte buffer that's too large to comfortably fit in RAM,
# e.g. when you're writing a web server and you want to buffer the client's
# file upload data.
#
# Please refer to #unlink for more information and a code example.
#
# == Minor notes
#
# Tempfile's filename picking method is both thread-safe and inter-process-safe:
# it guarantees that no other threads or processes will pick the same filename.
#
# Tempfile itself however may not be entirely thread-safe. If you access the
# same Tempfile object from multiple threads then you should protect it with a
# mutex.
class Tempfile < DelegateClass(File)
VERSION = "0.2.1"
# Creates a file in the underlying file system;
# returns a new \Tempfile object based on that file.
#
# If possible, consider instead using Tempfile.create, which:
#
# - Avoids the performance cost of delegation,
# incurred when Tempfile.new calls its superclass <tt>DelegateClass(File)</tt>.
# - Does not rely on a finalizer to close and unlink the file,
# which can be unreliable.
#
# Creates and returns file whose:
#
# - Class is \Tempfile (not \File, as in Tempfile.create).
# - Directory is the system temporary directory (system-dependent).
# - Generated filename is unique in that directory.
# - Permissions are <tt>0600</tt>;
# see {File Permissions}[rdoc-ref:File@File+Permissions].
# - Mode is <tt>'w+'</tt> (read/write mode, positioned at the end).
#
# The underlying file is removed when the \Tempfile object dies
# and is reclaimed by the garbage collector.
#
# Example:
#
# f = Tempfile.new # => #<Tempfile:/tmp/20220505-17839-1s0kt30>
# f.class # => Tempfile
# f.path # => "/tmp/20220505-17839-1s0kt30"
# f.stat.mode.to_s(8) # => "100600"
# File.exist?(f.path) # => true
# File.unlink(f.path) #
# File.exist?(f.path) # => false
#
# Argument +basename+, if given, may be one of:
#
# - A string: the generated filename begins with +basename+:
#
# Tempfile.new('foo') # => #<Tempfile:/tmp/foo20220505-17839-1whk2f>
#
# - An array of two strings <tt>[prefix, suffix]</tt>:
# the generated filename begins with +prefix+ and ends with +suffix+:
#
# Tempfile.new(%w/foo .jpg/) # => #<Tempfile:/tmp/foo20220505-17839-58xtfi.jpg>
#
# With arguments +basename+ and +tmpdir+, the file is created in directory +tmpdir+:
#
# Tempfile.new('foo', '.') # => #<Tempfile:./foo20220505-17839-xfstr8>
#
# Keyword arguments +mode+ and +options+ are passed directly to method
# {File.open}[rdoc-ref:File.open]:
#
# - The value given with +mode+ must be an integer,
# and may be expressed as the logical OR of constants defined in
# {File::Constants}[rdoc-ref:File::Constants].
# - For +options+, see {Open Options}[rdoc-ref:IO@Open+Options].
#
# Related: Tempfile.create.
#
def initialize(basename="", tmpdir=nil, mode: 0, **options)
warn "Tempfile.new doesn't call the given block.", uplevel: 1 if block_given?
@unlinked = false
@mode = mode|File::RDWR|File::CREAT|File::EXCL
@finalizer_obj = Object.new
tmpfile = nil
::Dir::Tmpname.create(basename, tmpdir, **options) do |tmpname, n, opts|
opts[:perm] = 0600
tmpfile = File.open(tmpname, @mode, **opts)
@opts = opts.freeze
end
ObjectSpace.define_finalizer(@finalizer_obj, Remover.new(tmpfile.path))
ObjectSpace.define_finalizer(self, Closer.new(tmpfile))
super(tmpfile)
end
def initialize_dup(other)
initialize_copy_iv(other)
super(other)
ObjectSpace.define_finalizer(self, Closer.new(__getobj__))
end
def initialize_clone(other)
initialize_copy_iv(other)
super(other)
ObjectSpace.define_finalizer(self, Closer.new(__getobj__))
end
private def initialize_copy_iv(other)
@unlinked = other.unlinked
@mode = other.mode
@opts = other.opts
@finalizer_obj = other.finalizer_obj
end
# Opens or reopens the file with mode "r+".
def open
_close
ObjectSpace.undefine_finalizer(self)
mode = @mode & ~(File::CREAT|File::EXCL)
__setobj__(File.open(__getobj__.path, mode, **@opts))
ObjectSpace.define_finalizer(self, Closer.new(__getobj__))
__getobj__
end
def _close # :nodoc:
__getobj__.close
end
protected :_close
# Closes the file. If +unlink_now+ is true, then the file will be unlinked
# (deleted) after closing. Of course, you can choose to later call #unlink
# if you do not unlink it now.
#
# If you don't explicitly unlink the temporary file, the removal
# will be delayed until the object is finalized.
def close(unlink_now=false)
_close
unlink if unlink_now
end
# Closes and unlinks (deletes) the file. Has the same effect as called
# <tt>close(true)</tt>.
def close!
close(true)
end
# Unlinks (deletes) the file from the filesystem. One should always unlink
# the file after using it, as is explained in the "Explicit close" good
# practice section in the Tempfile overview:
#
# file = Tempfile.new('foo')
# begin
# # ...do something with file...
# ensure
# file.close
# file.unlink # deletes the temp file
# end
#
# === Unlink-before-close
#
# On POSIX systems it's possible to unlink a file before closing it. This
# practice is explained in detail in the Tempfile overview (section
# "Unlink after creation"); please refer there for more information.
#
# However, unlink-before-close may not be supported on non-POSIX operating
# systems. Microsoft Windows is the most notable case: unlinking a non-closed
# file will result in an error, which this method will silently ignore. If
# you want to practice unlink-before-close whenever possible, then you should
# write code like this:
#
# file = Tempfile.new('foo')
# file.unlink # On Windows this silently fails.
# begin
# # ... do something with file ...
# ensure
# file.close! # Closes the file handle. If the file wasn't unlinked
# # because #unlink failed, then this method will attempt
# # to do so again.
# end
def unlink
return if @unlinked
begin
File.unlink(__getobj__.path)
rescue Errno::ENOENT
rescue Errno::EACCES
# may not be able to unlink on Windows; just ignore
return
end
ObjectSpace.undefine_finalizer(@finalizer_obj)
@unlinked = true
end
alias delete unlink
# Returns the full path name of the temporary file.
# This will be nil if #unlink has been called.
def path
@unlinked ? nil : __getobj__.path
end
# Returns the size of the temporary file. As a side effect, the IO
# buffer is flushed before determining the size.
def size
if !__getobj__.closed?
__getobj__.size # File#size calls rb_io_flush_raw()
else
File.size(__getobj__.path)
end
end
alias length size
# :stopdoc:
def inspect
if __getobj__.closed?
"#<#{self.class}:#{path} (closed)>"
else
"#<#{self.class}:#{path}>"
end
end
alias to_s inspect
protected
attr_reader :unlinked, :mode, :opts, :finalizer_obj
class Closer # :nodoc:
def initialize(tmpfile)
@tmpfile = tmpfile
end
def call(*args)
@tmpfile.close
end
end
class Remover # :nodoc:
def initialize(path)
@pid = Process.pid
@path = path
end
def call(*args)
return if @pid != Process.pid
$stderr.puts "removing #{@path}..." if $DEBUG
begin
File.unlink(@path)
rescue Errno::ENOENT
end
$stderr.puts "done" if $DEBUG
end
end
class << self
# :startdoc:
# Creates a new Tempfile.
#
# This method is not recommended and exists mostly for backward compatibility.
# Please use Tempfile.create instead, which avoids the cost of delegation,
# does not rely on a finalizer, and also unlinks the file when given a block.
#
# Tempfile.open is still appropriate if you need the Tempfile to be unlinked
# by a finalizer and you cannot explicitly know where in the program the
# Tempfile can be unlinked safely.
#
# If no block is given, this is a synonym for Tempfile.new.
#
# If a block is given, then a Tempfile object will be constructed,
# and the block is run with the Tempfile object as argument. The Tempfile
# object will be automatically closed after the block terminates.
# However, the file will *not* be unlinked and needs to be manually unlinked
# with Tempfile#close! or Tempfile#unlink. The finalizer will try to unlink
# but should not be relied upon as it can keep the file on the disk much
# longer than intended. For instance, on CRuby, finalizers can be delayed
# due to conservative stack scanning and references left in unused memory.
#
# The call returns the value of the block.
#
# In any case, all arguments (<code>*args</code>) will be passed to Tempfile.new.
#
# Tempfile.open('foo', '/home/temp') do |f|
# # ... do something with f ...
# end
#
# # Equivalent:
# f = Tempfile.open('foo', '/home/temp')
# begin
# # ... do something with f ...
# ensure
# f.close
# end
def open(*args, **kw)
tempfile = new(*args, **kw)
if block_given?
begin
yield(tempfile)
ensure
tempfile.close
end
else
tempfile
end
end
end
end
# Creates a file in the underlying file system;
# returns a new \File object based on that file.
#
# With no block given and no arguments, creates and returns file whose:
#
# - Class is {File}[rdoc-ref:File] (not \Tempfile).
# - Directory is the system temporary directory (system-dependent).
# - Generated filename is unique in that directory.
# - Permissions are <tt>0600</tt>;
# see {File Permissions}[rdoc-ref:File@File+Permissions].
# - Mode is <tt>'w+'</tt> (read/write mode, positioned at the end).
#
# With no block, the file is not removed automatically,
# and so should be explicitly removed.
#
# Example:
#
# f = Tempfile.create # => #<File:/tmp/20220505-9795-17ky6f6>
# f.class # => File
# f.path # => "/tmp/20220505-9795-17ky6f6"
# f.stat.mode.to_s(8) # => "100600"
# File.exist?(f.path) # => true
# File.unlink(f.path)
# File.exist?(f.path) # => false
#
# Argument +basename+, if given, may be one of:
#
# - A string: the generated filename begins with +basename+:
#
# Tempfile.create('foo') # => #<File:/tmp/foo20220505-9795-1gok8l9>
#
# - An array of two strings <tt>[prefix, suffix]</tt>:
# the generated filename begins with +prefix+ and ends with +suffix+:
#
# Tempfile.create(%w/foo .jpg/) # => #<File:/tmp/foo20220505-17839-tnjchh.jpg>
#
# With arguments +basename+ and +tmpdir+, the file is created in directory +tmpdir+:
#
# Tempfile.create('foo', '.') # => #<File:./foo20220505-9795-1emu6g8>
#
# Keyword arguments +mode+ and +options+ are passed directly to method
# {File.open}[rdoc-ref:File.open]:
#
# - The value given with +mode+ must be an integer,
# and may be expressed as the logical OR of constants defined in
# {File::Constants}[rdoc-ref:File::Constants].
# - For +options+, see {Open Options}[rdoc-ref:IO@Open+Options].
#
# With a block given, creates the file as above, passes it to the block,
# and returns the block's value;
# before the return, the file object is closed and the underlying file is removed:
#
# Tempfile.create {|file| file.path } # => "/tmp/20220505-9795-rkists"
#
# Related: Tempfile.new.
#
def Tempfile.create(basename="", tmpdir=nil, mode: 0, **options)
tmpfile = nil
Dir::Tmpname.create(basename, tmpdir, **options) do |tmpname, n, opts|
mode |= File::RDWR|File::CREAT|File::EXCL
opts[:perm] = 0600
tmpfile = File.open(tmpname, mode, **opts)
end
if block_given?
begin
yield tmpfile
ensure
unless tmpfile.closed?
if File.identical?(tmpfile, tmpfile.path)
unlinked = File.unlink tmpfile.path rescue nil
end
tmpfile.close
end
unless unlinked
begin
File.unlink tmpfile.path
rescue Errno::ENOENT
end
end
end
else
tmpfile
end
end
share/ruby/ostruct.rb 0000644 00000034335 15173517740 0010701 0 ustar 00 # frozen_string_literal: true
#
# = ostruct.rb: OpenStruct implementation
#
# Author:: Yukihiro Matsumoto
# Documentation:: Gavin Sinclair
#
# OpenStruct allows the creation of data objects with arbitrary attributes.
# See OpenStruct for an example.
#
#
# An OpenStruct is a data structure, similar to a Hash, that allows the
# definition of arbitrary attributes with their accompanying values. This is
# accomplished by using Ruby's metaprogramming to define methods on the class
# itself.
#
# == Examples
#
# require "ostruct"
#
# person = OpenStruct.new
# person.name = "John Smith"
# person.age = 70
#
# person.name # => "John Smith"
# person.age # => 70
# person.address # => nil
#
# An OpenStruct employs a Hash internally to store the attributes and values
# and can even be initialized with one:
#
# australia = OpenStruct.new(:country => "Australia", :capital => "Canberra")
# # => #<OpenStruct country="Australia", capital="Canberra">
#
# Hash keys with spaces or characters that could normally not be used for
# method calls (e.g. <code>()[]*</code>) will not be immediately available
# on the OpenStruct object as a method for retrieval or assignment, but can
# still be reached through the Object#send method or using [].
#
# measurements = OpenStruct.new("length (in inches)" => 24)
# measurements[:"length (in inches)"] # => 24
# measurements.send("length (in inches)") # => 24
#
# message = OpenStruct.new(:queued? => true)
# message.queued? # => true
# message.send("queued?=", false)
# message.queued? # => false
#
# Removing the presence of an attribute requires the execution of the
# delete_field method as setting the property value to +nil+ will not
# remove the attribute.
#
# first_pet = OpenStruct.new(:name => "Rowdy", :owner => "John Smith")
# second_pet = OpenStruct.new(:name => "Rowdy")
#
# first_pet.owner = nil
# first_pet # => #<OpenStruct name="Rowdy", owner=nil>
# first_pet == second_pet # => false
#
# first_pet.delete_field(:owner)
# first_pet # => #<OpenStruct name="Rowdy">
# first_pet == second_pet # => true
#
# Ractor compatibility: A frozen OpenStruct with shareable values is itself shareable.
#
# == Caveats
#
# An OpenStruct utilizes Ruby's method lookup structure to find and define the
# necessary methods for properties. This is accomplished through the methods
# method_missing and define_singleton_method.
#
# This should be a consideration if there is a concern about the performance of
# the objects that are created, as there is much more overhead in the setting
# of these properties compared to using a Hash or a Struct.
# Creating an open struct from a small Hash and accessing a few of the
# entries can be 200 times slower than accessing the hash directly.
#
# This is a potential security issue; building OpenStruct from untrusted user data
# (e.g. JSON web request) may be susceptible to a "symbol denial of service" attack
# since the keys create methods and names of methods are never garbage collected.
#
# This may also be the source of incompatibilities between Ruby versions:
#
# o = OpenStruct.new
# o.then # => nil in Ruby < 2.6, enumerator for Ruby >= 2.6
#
# Builtin methods may be overwritten this way, which may be a source of bugs
# or security issues:
#
# o = OpenStruct.new
# o.methods # => [:to_h, :marshal_load, :marshal_dump, :each_pair, ...
# o.methods = [:foo, :bar]
# o.methods # => [:foo, :bar]
#
# To help remedy clashes, OpenStruct uses only protected/private methods ending with <code>!</code>
# and defines aliases for builtin public methods by adding a <code>!</code>:
#
# o = OpenStruct.new(make: 'Bentley', class: :luxury)
# o.class # => :luxury
# o.class! # => OpenStruct
#
# It is recommended (but not enforced) to not use fields ending in <code>!</code>;
# Note that a subclass' methods may not be overwritten, nor can OpenStruct's own methods
# ending with <code>!</code>.
#
# For all these reasons, consider not using OpenStruct at all.
#
class OpenStruct
VERSION = "0.6.0"
HAS_PERFORMANCE_WARNINGS = begin
Warning[:performance]
true
rescue NoMethodError, ArgumentError
false
end
private_constant :HAS_PERFORMANCE_WARNINGS
#
# Creates a new OpenStruct object. By default, the resulting OpenStruct
# object will have no attributes.
#
# The optional +hash+, if given, will generate attributes and values
# (can be a Hash, an OpenStruct or a Struct).
# For example:
#
# require "ostruct"
# hash = { "country" => "Australia", :capital => "Canberra" }
# data = OpenStruct.new(hash)
#
# data # => #<OpenStruct country="Australia", capital="Canberra">
#
def initialize(hash=nil)
if HAS_PERFORMANCE_WARNINGS && Warning[:performance]
warn "OpenStruct use is discouraged for performance reasons", uplevel: 1, category: :performance
end
if hash
update_to_values!(hash)
else
@table = {}
end
end
# Duplicates an OpenStruct object's Hash table.
private def initialize_clone(orig) # :nodoc:
super # clones the singleton class for us
@table = @table.dup unless @table.frozen?
end
private def initialize_dup(orig) # :nodoc:
super
update_to_values!(@table)
end
private def update_to_values!(hash) # :nodoc:
@table = {}
hash.each_pair do |k, v|
set_ostruct_member_value!(k, v)
end
end
#
# call-seq:
# ostruct.to_h -> hash
# ostruct.to_h {|name, value| block } -> hash
#
# Converts the OpenStruct to a hash with keys representing
# each attribute (as symbols) and their corresponding values.
#
# If a block is given, the results of the block on each pair of
# the receiver will be used as pairs.
#
# require "ostruct"
# data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
# data.to_h # => {:country => "Australia", :capital => "Canberra" }
# data.to_h {|name, value| [name.to_s, value.upcase] }
# # => {"country" => "AUSTRALIA", "capital" => "CANBERRA" }
#
if {test: :to_h}.to_h{ [:works, true] }[:works] # RUBY_VERSION < 2.6 compatibility
def to_h(&block)
if block
@table.to_h(&block)
else
@table.dup
end
end
else
def to_h(&block)
if block
@table.map(&block).to_h
else
@table.dup
end
end
end
#
# :call-seq:
# ostruct.each_pair {|name, value| block } -> ostruct
# ostruct.each_pair -> Enumerator
#
# Yields all attributes (as symbols) along with the corresponding values
# or returns an enumerator if no block is given.
#
# require "ostruct"
# data = OpenStruct.new("country" => "Australia", :capital => "Canberra")
# data.each_pair.to_a # => [[:country, "Australia"], [:capital, "Canberra"]]
#
def each_pair
return to_enum(__method__) { @table.size } unless defined?(yield)
@table.each_pair{|p| yield p}
self
end
#
# Provides marshalling support for use by the Marshal library.
#
def marshal_dump # :nodoc:
@table
end
#
# Provides marshalling support for use by the Marshal library.
#
alias_method :marshal_load, :update_to_values! # :nodoc:
#
# Used internally to defined properties on the
# OpenStruct. It does this by using the metaprogramming function
# define_singleton_method for both the getter method and the setter method.
#
def new_ostruct_member!(name) # :nodoc:
unless @table.key?(name) || is_method_protected!(name)
if defined?(::Ractor)
getter_proc = nil.instance_eval{ Proc.new { @table[name] } }
setter_proc = nil.instance_eval{ Proc.new {|x| @table[name] = x} }
::Ractor.make_shareable(getter_proc)
::Ractor.make_shareable(setter_proc)
else
getter_proc = Proc.new { @table[name] }
setter_proc = Proc.new {|x| @table[name] = x}
end
define_singleton_method!(name, &getter_proc)
define_singleton_method!("#{name}=", &setter_proc)
end
end
private :new_ostruct_member!
private def is_method_protected!(name) # :nodoc:
if !respond_to?(name, true)
false
elsif name.match?(/!$/)
true
else
owner = method!(name).owner
if owner.class == ::Class
owner < ::OpenStruct
else
self.class!.ancestors.any? do |mod|
return false if mod == ::OpenStruct
mod == owner
end
end
end
end
def freeze
@table.freeze
super
end
private def method_missing(mid, *args) # :nodoc:
len = args.length
if mname = mid[/.*(?==\z)/m]
if len != 1
raise! ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1)
end
set_ostruct_member_value!(mname, args[0])
elsif len == 0
@table[mid]
else
begin
super
rescue NoMethodError => err
err.backtrace.shift
raise!
end
end
end
#
# :call-seq:
# ostruct[name] -> object
#
# Returns the value of an attribute, or +nil+ if there is no such attribute.
#
# require "ostruct"
# person = OpenStruct.new("name" => "John Smith", "age" => 70)
# person[:age] # => 70, same as person.age
#
def [](name)
@table[name.to_sym]
end
#
# :call-seq:
# ostruct[name] = obj -> obj
#
# Sets the value of an attribute.
#
# require "ostruct"
# person = OpenStruct.new("name" => "John Smith", "age" => 70)
# person[:age] = 42 # equivalent to person.age = 42
# person.age # => 42
#
def []=(name, value)
name = name.to_sym
new_ostruct_member!(name)
@table[name] = value
end
alias_method :set_ostruct_member_value!, :[]=
private :set_ostruct_member_value!
# :call-seq:
# ostruct.dig(name, *identifiers) -> object
#
# Finds and returns the object in nested objects
# that is specified by +name+ and +identifiers+.
# The nested objects may be instances of various classes.
# See {Dig Methods}[rdoc-ref:dig_methods.rdoc].
#
# Examples:
# require "ostruct"
# address = OpenStruct.new("city" => "Anytown NC", "zip" => 12345)
# person = OpenStruct.new("name" => "John Smith", "address" => address)
# person.dig(:address, "zip") # => 12345
# person.dig(:business_address, "zip") # => nil
def dig(name, *names)
begin
name = name.to_sym
rescue NoMethodError
raise! TypeError, "#{name} is not a symbol nor a string"
end
@table.dig(name, *names)
end
#
# Removes the named field from the object and returns the value the field
# contained if it was defined. You may optionally provide a block.
# If the field is not defined, the result of the block is returned,
# or a NameError is raised if no block was given.
#
# require "ostruct"
#
# person = OpenStruct.new(name: "John", age: 70, pension: 300)
#
# person.delete_field!("age") # => 70
# person # => #<OpenStruct name="John", pension=300>
#
# Setting the value to +nil+ will not remove the attribute:
#
# person.pension = nil
# person # => #<OpenStruct name="John", pension=nil>
#
# person.delete_field('number') # => NameError
#
# person.delete_field('number') { 8675_309 } # => 8675309
#
def delete_field(name, &block)
sym = name.to_sym
begin
singleton_class.remove_method(sym, "#{sym}=")
rescue NameError
end
@table.delete(sym) do
return yield if block
raise! NameError.new("no field `#{sym}' in #{self}", sym)
end
end
InspectKey = :__inspect_key__ # :nodoc:
#
# Returns a string containing a detailed summary of the keys and values.
#
def inspect
ids = (Thread.current[InspectKey] ||= [])
if ids.include?(object_id)
detail = ' ...'
else
ids << object_id
begin
detail = @table.map do |key, value|
" #{key}=#{value.inspect}"
end.join(',')
ensure
ids.pop
end
end
['#<', self.class!, detail, '>'].join
end
alias :to_s :inspect
attr_reader :table # :nodoc:
alias table! table
protected :table!
#
# Compares this object and +other+ for equality. An OpenStruct is equal to
# +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
# equal.
#
# require "ostruct"
# first_pet = OpenStruct.new("name" => "Rowdy")
# second_pet = OpenStruct.new(:name => "Rowdy")
# third_pet = OpenStruct.new("name" => "Rowdy", :age => nil)
#
# first_pet == second_pet # => true
# first_pet == third_pet # => false
#
def ==(other)
return false unless other.kind_of?(OpenStruct)
@table == other.table!
end
#
# Compares this object and +other+ for equality. An OpenStruct is eql? to
# +other+ when +other+ is an OpenStruct and the two objects' Hash tables are
# eql?.
#
def eql?(other)
return false unless other.kind_of?(OpenStruct)
@table.eql?(other.table!)
end
# Computes a hash code for this OpenStruct.
def hash # :nodoc:
@table.hash
end
#
# Provides marshalling support for use by the YAML library.
#
def encode_with(coder) # :nodoc:
@table.each_pair do |key, value|
coder[key.to_s] = value
end
if @table.size == 1 && @table.key?(:table) # support for legacy format
# in the very unlikely case of a single entry called 'table'
coder['legacy_support!'] = true # add a bogus second entry
end
end
#
# Provides marshalling support for use by the YAML library.
#
def init_with(coder) # :nodoc:
h = coder.map
if h.size == 1 # support for legacy format
key, val = h.first
if key == 'table'
h = val
end
end
update_to_values!(h)
end
# Make all public methods (builtin or our own) accessible with <code>!</code>:
give_access = instance_methods
# See https://github.com/ruby/ostruct/issues/30
give_access -= %i[instance_exec instance_eval eval] if RUBY_ENGINE == 'jruby'
give_access.each do |method|
next if method.match(/\W$/)
new_name = "#{method}!"
alias_method new_name, method
end
# Other builtin private methods we use:
alias_method :raise!, :raise
private :raise!
# See https://github.com/ruby/ostruct/issues/40
if RUBY_ENGINE != 'jruby'
alias_method :block_given!, :block_given?
private :block_given!
end
end
share/doc/alt-ruby33-libs/NEWS.md 0000644 00000051271 15173517740 0012365 0 ustar 00 # NEWS for Ruby 3.3.0
This document is a list of user-visible feature changes
since the **3.2.0** release, except for bug fixes.
Note that each entry is kept to a minimum, see links for details.
## Command line options
* A new `performance` warning category was introduced.
They are not displayed by default even in verbose mode.
Turn them on with `-W:performance` or `Warning[:performance] = true`. [[Feature #19538]]
* A new `RUBY_CRASH_REPORT` environment variable was introduced to allow
redirecting Ruby crash reports to a file or sub command. See the `BUG REPORT ENVIRONMENT`
section of the ruby manpage for further details. [[Feature #19790]]
## Core classes updates
Note: We're only listing outstanding class updates.
* Array
* Array#pack now raises ArgumentError for unknown directives. [[Bug #19150]]
* Dir
* Dir.for_fd added for returning a Dir object for the directory specified
by the provided directory file descriptor. [[Feature #19347]]
* Dir.fchdir added for changing the directory to the directory specified
by the provided directory file descriptor. [[Feature #19347]]
* Dir#chdir added for changing the directory to the directory specified by
the provided `Dir` object. [[Feature #19347]]
* Encoding
* `Encoding#replicate` has been removed, it was already deprecated. [[Feature #18949]]
* Fiber
* Introduce Fiber#kill. [[Bug #595]]
```ruby
fiber = Fiber.new do
while true
puts "Yielding..."
Fiber.yield
end
ensure
puts "Exiting..."
end
fiber.resume
# Yielding...
fiber.kill
# Exiting...
```
* MatchData
* MatchData#named_captures now accepts optional `symbolize_names`
keyword. [[Feature #19591]]
* Module
* Module#set_temporary_name added for setting a temporary name for a
module. [[Feature #19521]]
* ObjectSpace::WeakKeyMap
* New core class to build collections with weak references.
The class use equality semantic to lookup keys like a regular hash,
but it doesn't hold strong references on the keys. [[Feature #18498]]
* ObjectSpace::WeakMap
* ObjectSpace::WeakMap#delete was added to eagerly clear weak map
entries. [[Feature #19561]]
* Proc
* Now Proc#dup and Proc#clone call `#initialize_dup` and `#initialize_clone`
hooks respectively. [[Feature #19362]]
* Process
* New Process.warmup method that notify the Ruby virtual machine that the boot sequence is finished,
and that now is a good time to optimize the application. This is useful
for long-running applications. The actual optimizations performed are entirely
implementation-specific and may change in the future without notice. [[Feature #18885]]
* Process::Status
* Process::Status#& and Process::Status#>> are deprecated. [[Bug #19868]]
* Range
* Range#reverse_each can now process beginless ranges with an Integer endpoint. [[Feature #18515]]
* Range#reverse_each now raises TypeError for endless ranges. [[Feature #18551]]
* Range#overlap? added for checking if two ranges overlap. [[Feature #19839]]
* Refinement
* Add Refinement#target as an alternative of Refinement#refined_class.
Refinement#refined_class is deprecated and will be removed in Ruby
3.4. [[Feature #19714]]
* Regexp
* The cache-based optimization now supports lookarounds and atomic groupings. That is, match
for Regexp containing these extensions can now also be performed in linear time to the length
of the input string. However, these cannot contain captures and cannot be nested. [[Feature #19725]]
* String
* String#unpack now raises ArgumentError for unknown directives. [[Bug #19150]]
* String#bytesplice now accepts new arguments index/length or range of the
source string to be copied. [[Feature #19314]]
* Thread::Queue
* Thread::Queue#freeze now raises TypeError. [[Bug #17146]]
* Thread::SizedQueue
* Thread::SizedQueue#freeze now raises TypeError. [[Bug #17146]]
* Time
* Time.new with a string argument became stricter. [[Bug #19293]]
```ruby
Time.new('2023-12-20')
# no time information (ArgumentError)
```
* TracePoint
* TracePoint supports `rescue` event. When the raised exception was rescued,
the TracePoint will fire the hook. `rescue` event only supports Ruby-level
`rescue`. [[Feature #19572]]
## Stdlib updates
* RubyGems and Bundler warn if users do `require` the following gems without adding them to Gemfile or gemspec.
This is because they will become the bundled gems in the future version of Ruby. This warning is suppressed
if you use bootsnap gem. We recommend to run your application with `DISABLE_BOOTSNAP=1` environmental variable
at least once. This is limitation of this version.
[[Feature #19351]] [[Feature #19776]] [[Feature #19843]]
* abbrev
* base64
* bigdecimal
* csv
* drb
* getoptlong
* mutex_m
* nkf
* observer
* racc
* resolv-replace
* rinda
* syslog
* Socket#recv and Socket#recv_nonblock returns `nil` instead of an empty string on closed
connections. Socket#recvmsg and Socket#recvmsg_nonblock returns `nil` instead of an empty packet on closed
connections. [[Bug #19012]]
* Name resolution such as Socket.getaddrinfo, Socket.getnameinfo, Addrinfo.getaddrinfo, etc.
can now be interrupted. [[Feature #19965]]
* Random::Formatter#alphanumeric is extended to accept optional `chars`
keyword argument. [[Feature #18183]]
The following default gem is added.
* prism 0.19.0
The following default gems are updated.
* RubyGems 3.5.3
* abbrev 0.1.2
* base64 0.2.0
* benchmark 0.3.0
* bigdecimal 3.1.5
* bundler 2.5.3
* cgi 0.4.1
* csv 3.2.8
* date 3.3.4
* delegate 0.3.1
* drb 2.2.0
* english 0.8.0
* erb 4.0.3
* error_highlight 0.6.0
* etc 1.4.3
* fcntl 1.1.0
* fiddle 1.1.2
* fileutils 1.7.2
* find 0.2.0
* getoptlong 0.2.1
* io-console 0.7.1
* io-nonblock 0.3.0
* io-wait 0.3.1
* ipaddr 1.2.6
* irb 1.11.0
* json 2.7.1
* logger 1.6.0
* mutex_m 0.2.0
* net-http 0.4.0
* net-protocol 0.2.2
* nkf 0.1.3
* observer 0.1.2
* open-uri 0.4.1
* open3 0.2.1
* openssl 3.2.0
* optparse 0.4.0
* ostruct 0.6.0
* pathname 0.3.0
* pp 0.5.0
* prettyprint 0.2.0
* pstore 0.1.3
* psych 5.1.2
* rdoc 6.6.2
* readline 0.0.4
* reline 0.4.1
* resolv 0.3.0
* rinda 0.2.0
* securerandom 0.3.1
* set 1.1.0
* shellwords 0.2.0
* singleton 0.2.0
* stringio 3.1.0
* strscan 3.0.7
* syntax_suggest 2.0.0
* syslog 0.1.2
* tempfile 0.2.1
* time 0.3.0
* timeout 0.4.1
* tmpdir 0.2.0
* tsort 0.2.0
* un 0.3.0
* uri 0.13.0
* weakref 0.1.3
* win32ole 1.8.10
* yaml 0.3.0
* zlib 3.1.0
The following bundled gem is promoted from default gems.
* racc 1.7.3
The following bundled gems are updated.
* minitest 5.20.0
* rake 13.1.0
* test-unit 3.6.1
* rexml 3.2.6
* rss 0.3.0
* net-ftp 0.3.3
* net-imap 0.4.9
* net-smtp 0.4.0
* rbs 3.4.0
* typeprof 0.21.9
* debug 1.9.1
See GitHub releases like [Logger](https://github.com/ruby/logger/releases) or
changelog for details of the default gems or bundled gems.
### Prism
* Introduced [the Prism parser](https://github.com/ruby/prism) as a default gem
* Prism is a portable, error tolerant, and maintainable recursive descent parser for the Ruby language
* Prism is production ready and actively maintained, you can use it in place of Ripper
* There is [extensive documentation](https://ruby.github.io/prism/) on how to use Prism
* Prism is both a C library that will be used internally by CRuby and a Ruby gem that can be used by any tooling which needs to parse Ruby code
* Notable methods in the Prism API are:
* `Prism.parse(source)` which returns the AST as part of a parse result object
* `Prism.parse_comments(source)` which returns the comments
* `Prism.parse_success?(source)` which returns true if there are no errors
* You can make pull requests or issues directly on [the Prism repository](https://github.com/ruby/prism) if you are interested in contributing
* You can now use `ruby --parser=prism` or `RUBYOPT="--parser=prism"` to experiment with the Prism compiler. Please note that this flag is for debugging only.
## Compatibility issues
* Subprocess creation/forking via the following file open methods is deprecated. [[Feature #19630]]
* Kernel#open
* URI.open
* IO.binread
* IO.foreach
* IO.readlines
* IO.read
* IO.write
* When given a non-lambda, non-literal block, Kernel#lambda with now raises
ArgumentError instead of returning it unmodified. These usages have been
issuing warnings under the `Warning[:deprecated]` category since Ruby 3.0.0.
[[Feature #19777]]
* The `RUBY_GC_HEAP_INIT_SLOTS` environment variable has been deprecated and
removed. Environment variables `RUBY_GC_HEAP_%d_INIT_SLOTS` should be
used instead. [[Feature #19785]]
* `it` calls without arguments in a block with no ordinary parameters are
deprecated. `it` will be a reference to the first block parameter in Ruby 3.4.
[[Feature #18980]]
* Error message for NoMethodError have changed to not use the target object's `#inspect`
for efficiency, and says "instance of ClassName" instead. [[Feature #18285]]
```ruby
([1] * 100).nonexisting
# undefined method `nonexisting' for an instance of Array (NoMethodError)
```
* Now anonymous parameters forwarding is disallowed inside a block
that uses anonymous parameters. [[Feature #19370]]
## Stdlib compatibility issues
* `racc` is promoted to bundled gems.
* You need to add `racc` to your `Gemfile` if you use `racc` under bundler environment.
* `ext/readline` is retired
* We have `reline` that is pure Ruby implementation compatible with `ext/readline` API.
We rely on `reline` in the future. If you need to use `ext/readline`, you can install
`ext/readline` via rubygems.org with `gem install readline-ext`.
* We no longer need to install libraries like `libreadline` or `libedit`.
## C API updates
* `rb_postponed_job` updates
* New APIs and deprecated APIs (see comments for details)
* added: `rb_postponed_job_preregister()`
* added: `rb_postponed_job_trigger()`
* deprecated: `rb_postponed_job_register()` (and semantic change. see below)
* deprecated: `rb_postponed_job_register_one()`
* The postponed job APIs have been changed to address some rare crashes.
To solve the issue, we introduced new two APIs and deprecated current APIs.
The semantics of these functions have also changed slightly; `rb_postponed_job_register`
now behaves like the `once` variant in that multiple calls with the same
`func` might be coalesced into a single execution of the `func`
[[Feature #20057]]
* Some updates for internal thread event hook APIs
* `rb_internal_thread_event_data_t` with a target Ruby thread (VALUE)
and callback functions (`rb_internal_thread_event_callback`) receive it.
https://github.com/ruby/ruby/pull/8885
* The following functions are introduced to manipulate Ruby thread local data
from internal thread event hook APIs (they are introduced since Ruby 3.2).
https://github.com/ruby/ruby/pull/8936
* `rb_internal_thread_specific_key_create()`
* `rb_internal_thread_specific_get()`
* `rb_internal_thread_specific_set()`
* `rb_profile_thread_frames()` is introduced to get a frames from
a specific thread.
[[Feature #10602]]
* `rb_data_define()` is introduced to define `Data`. [[Feature #19757]]
* `rb_ext_resolve_symbol()` is introduced to search a function from
extension libraries. [[Feature #20005]]
* IO related updates:
* The details of `rb_io_t` will be hidden and deprecated attributes
are added for each members. [[Feature #19057]]
* `rb_io_path(VALUE io)` is introduced to get a path of `io`.
* `rb_io_closed_p(VALUE io)` to get opening or closing of `io`.
* `rb_io_mode(VALUE io)` to get the mode of `io`.
* `rb_io_open_descriptor()` is introduced to make an IO object from a file
descriptor.
## Implementation improvements
### Parser
* Replace Bison with [Lrama LALR parser generator](https://github.com/ruby/lrama).
No need to install Bison to build Ruby from source code anymore.
We will no longer suffer bison compatibility issues and we can use new features by just implementing it to Lrama. [[Feature #19637]]
* See [The future vision of Ruby Parser](https://rubykaigi.org/2023/presentations/spikeolaf.html) for detail.
* Lrama internal parser is a LR parser generated by Racc for maintainability.
* Parameterizing Rules `(?, *, +)` are supported, it will be used in Ruby parse.y.
### GC / Memory management
* Major performance improvements over Ruby 3.2
* Young objects referenced by old objects are no longer immediately
promoted to the old generation. This significantly reduces the frequency of
major GC collections. [[Feature #19678]]
* A new `REMEMBERED_WB_UNPROTECTED_OBJECTS_LIMIT_RATIO` tuning variable was
introduced to control the number of unprotected objects cause a major GC
collection to trigger. The default is set to `0.01` (1%). This significantly
reduces the frequency of major GC collection. [[Feature #19571]]
* Write Barriers were implemented for many core types that were missing them,
notably `Time`, `Enumerator`, `MatchData`, `Method`, `File::Stat`, `BigDecimal`
and several others. This significantly reduces minor GC collection time and major
GC collection frequency.
* Most core classes are now using Variable Width Allocation, notably `Hash`, `Time`,
`Thread::Backtrace`, `Thread::Backtrace::Location`, `File::Stat`, `Method`.
This makes these classes faster to allocate and free, use less memory and reduce
heap fragmentation.
* `defined?(@ivar)` is optimized with Object Shapes.
### YJIT
* Major performance improvements over Ruby 3.2
* Support for splat and rest arguments has been improved.
* Registers are allocated for stack operations of the virtual machine.
* More calls with optional arguments are compiled. Exception handlers are also compiled.
* Unsupported call types and megamorphic call sites no longer exit to the interpreter.
* Basic methods like Rails `#blank?` and
[specialized `#present?`](https://github.com/rails/rails/pull/49909) are inlined.
* `Integer#*`, `Integer#!=`, `String#!=`, `String#getbyte`,
`Kernel#block_given?`, `Kernel#is_a?`, `Kernel#instance_of?`, and `Module#===`
are specially optimized.
* Compilation speed is now slightly faster than Ruby 3.2.
* Now more than 3x faster than the interpreter on Optcarrot!
* Significantly improved memory usage over Ruby 3.2
* Metadata for compiled code uses a lot less memory.
* `--yjit-call-threshold` is automatically raised from 30 to 120
when the application has more than 40,000 ISEQs.
* `--yjit-cold-threshold` is added to skip compiling cold ISEQs.
* More compact code is generated on Arm64.
* Code GC is now disabled by default
* `--yjit-exec-mem-size` is treated as a hard limit where compilation of new code stops.
* No sudden drops in performance due to code GC.
Better copy-on-write behavior on servers reforking with
[Pitchfork](https://github.com/shopify/pitchfork).
* You can still enable code GC if desired with `--yjit-code-gc`
* Add `RubyVM::YJIT.enable` that can enable YJIT at run-time
* You can start YJIT without modifying command-line arguments or environment variables.
Rails 7.2 will [enable YJIT by default](https://github.com/rails/rails/pull/49947)
using this method.
* This can also be used to enable YJIT only once your application is
done booting. `--yjit-disable` can be used if you want to use other
YJIT options while disabling YJIT at boot.
* More YJIT stats are available by default
* `yjit_alloc_size` and several more metadata-related stats are now available by default.
* `ratio_in_yjit` stat produced by `--yjit-stats` is now available in release builds,
a special stats or dev build is no longer required to access most stats.
* Add more profiling capabilities
* `--yjit-perf` is added to facilitate profiling with Linux perf.
* `--yjit-trace-exits` now supports sampling with `--yjit-trace-exits-sample-rate=N`
* More thorough testing and multiple bug fixes
* `--yjit-stats=quiet` is added to avoid printing stats on exit.
### MJIT
* MJIT is removed.
* `--disable-jit-support` is removed. Consider using `--disable-yjit --disable-rjit` instead.
### RJIT
* Introduced a pure-Ruby JIT compiler RJIT.
* RJIT supports only x86\_64 architecture on Unix platforms.
* Unlike MJIT, it doesn't require a C compiler at runtime.
* RJIT exists only for experimental purposes.
* You should keep using YJIT in production.
### M:N Thread scheduler
* M:N Thread scheduler is introduced. [[Feature #19842]]
* Background: Ruby 1.8 and before, M:1 thread scheduler (M Ruby threads
with 1 native thread. Called as User level threads or Green threads)
is used. Ruby 1.9 and later, 1:1 thread scheduler (1 Ruby thread with
1 native thread). M:1 threads takes lower resources compare with 1:1
threads because it needs only 1 native threads. However it is difficult
to support context switching for all of blocking operation so 1:1
threads are employed from Ruby 1.9. M:N thread scheduler uses N native
threads for M Ruby threads (N is small number in general). It doesn't
need same number of native threads as Ruby threads (similar to the M:1
thread scheduler). Also our M:N threads supports blocking operations
well same as 1:1 threads. See the ticket for more details.
Our M:N thread scheduler refers on the goroutine scheduler in the
Go language.
* In a ractor, only 1 thread can run in a same time because of
implementation. Therefore, applications that use only one Ractor
(most applications) M:N thread scheduler works as M:1 thread scheduler
with further extension from Ruby 1.8.
* M:N thread scheduler can introduce incompatibility for C-extensions,
so it is disabled by default on the main Ractors.
`RUBY_MN_THREADS=1` environment variable will enable it.
On non-main Ractors, M:N thread scheduler is enabled (and can not
disable it now).
* `N` (the number of native threads) can be specified with `RUBY_MAX_CPU`
environment variable. The default is 8.
Note that more than `N` native threads are used to support many kind of
blocking operations.
[Bug #595]: https://bugs.ruby-lang.org/issues/595
[Feature #10602]: https://bugs.ruby-lang.org/issues/10602
[Bug #17146]: https://bugs.ruby-lang.org/issues/17146
[Feature #18183]: https://bugs.ruby-lang.org/issues/18183
[Feature #18285]: https://bugs.ruby-lang.org/issues/18285
[Feature #18498]: https://bugs.ruby-lang.org/issues/18498
[Feature #18515]: https://bugs.ruby-lang.org/issues/18515
[Feature #18551]: https://bugs.ruby-lang.org/issues/18551
[Feature #18885]: https://bugs.ruby-lang.org/issues/18885
[Feature #18949]: https://bugs.ruby-lang.org/issues/18949
[Feature #18980]: https://bugs.ruby-lang.org/issues/18980
[Bug #19012]: https://bugs.ruby-lang.org/issues/19012
[Feature #19057]: https://bugs.ruby-lang.org/issues/19057
[Bug #19150]: https://bugs.ruby-lang.org/issues/19150
[Bug #19293]: https://bugs.ruby-lang.org/issues/19293
[Feature #19314]: https://bugs.ruby-lang.org/issues/19314
[Feature #19347]: https://bugs.ruby-lang.org/issues/19347
[Feature #19351]: https://bugs.ruby-lang.org/issues/19351
[Feature #19362]: https://bugs.ruby-lang.org/issues/19362
[Feature #19370]: https://bugs.ruby-lang.org/issues/19370
[Feature #19521]: https://bugs.ruby-lang.org/issues/19521
[Feature #19538]: https://bugs.ruby-lang.org/issues/19538
[Feature #19561]: https://bugs.ruby-lang.org/issues/19561
[Feature #19571]: https://bugs.ruby-lang.org/issues/19571
[Feature #19572]: https://bugs.ruby-lang.org/issues/19572
[Feature #19591]: https://bugs.ruby-lang.org/issues/19591
[Feature #19630]: https://bugs.ruby-lang.org/issues/19630
[Feature #19637]: https://bugs.ruby-lang.org/issues/19637
[Feature #19678]: https://bugs.ruby-lang.org/issues/19678
[Feature #19714]: https://bugs.ruby-lang.org/issues/19714
[Feature #19725]: https://bugs.ruby-lang.org/issues/19725
[Feature #19757]: https://bugs.ruby-lang.org/issues/19757
[Feature #19776]: https://bugs.ruby-lang.org/issues/19776
[Feature #19777]: https://bugs.ruby-lang.org/issues/19777
[Feature #19785]: https://bugs.ruby-lang.org/issues/19785
[Feature #19790]: https://bugs.ruby-lang.org/issues/19790
[Feature #19839]: https://bugs.ruby-lang.org/issues/19839
[Feature #19842]: https://bugs.ruby-lang.org/issues/19842
[Feature #19843]: https://bugs.ruby-lang.org/issues/19843
[Bug #19868]: https://bugs.ruby-lang.org/issues/19868
[Feature #19965]: https://bugs.ruby-lang.org/issues/19965
[Feature #20005]: https://bugs.ruby-lang.org/issues/20005
[Feature #20057]: https://bugs.ruby-lang.org/issues/20057
share/doc/alt-ruby33-libs/README.md 0000644 00000007216 15173517740 0012546 0 ustar 00 [](https://github.com/ruby/ruby/actions?query=workflow%3A"MinGW")
[](https://github.com/ruby/ruby/actions?query=workflow%3A"RJIT")
[](https://github.com/ruby/ruby/actions?query=workflow%3A"Ubuntu")
[](https://github.com/ruby/ruby/actions?query=workflow%3A"Windows")
[](https://ci.appveyor.com/project/ruby/ruby/branch/master)
[](https://app.travis-ci.com/ruby/ruby)
# What is Ruby?
Ruby is an interpreted object-oriented programming language often
used for web development. It also offers many scripting features
to process plain text and serialized files, or manage system tasks.
It is simple, straightforward, and extensible.
## Features of Ruby
* Simple Syntax
* **Normal** Object-oriented Features (e.g. class, method calls)
* **Advanced** Object-oriented Features (e.g. mix-in, singleton-method)
* Operator Overloading
* Exception Handling
* Iterators and Closures
* Garbage Collection
* Dynamic Loading of Object Files (on some architectures)
* Highly Portable (works on many Unix-like/POSIX compatible platforms as
well as Windows, macOS, etc.) cf.
https://docs.ruby-lang.org/en/master/maintainers_md.html#label-Platform+Maintainers
## How to get Ruby
For a complete list of ways to install Ruby, including using third-party tools
like rvm, see:
https://www.ruby-lang.org/en/downloads/
You can download release packages and the snapshot of the repository. If you want to
download whole versions of Ruby, please visit https://www.ruby-lang.org/en/downloads/releases/.
### Download with Git
The mirror of the Ruby source tree can be checked out with the following command:
$ git clone https://github.com/ruby/ruby.git
There are some other branches under development. Try the following command
to see the list of branches:
$ git ls-remote https://github.com/ruby/ruby.git
You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source)
if you are a committer.
## How to build
See [Building Ruby](https://docs.ruby-lang.org/en/master/contributing/building_ruby_md.html)
## Ruby home page
https://www.ruby-lang.org/
## Documentation
- [English](https://docs.ruby-lang.org/en/master/index.html)
- [Japanese](https://docs.ruby-lang.org/ja/master/index.html)
## Mailing list
There is a mailing list to discuss Ruby. To subscribe to this list, please
send the following phrase:
join
in the mail subject (not body) to the address [ruby-talk-request@ml.ruby-lang.org].
[ruby-talk-request@ml.ruby-lang.org]: mailto:ruby-talk-request@ml.ruby-lang.org?subject=join
## Copying
See the file [COPYING](rdoc-ref:COPYING).
## Feedback
Questions about the Ruby language can be asked on the [Ruby-Talk](https://www.ruby-lang.org/en/community/mailing-lists) mailing list
or on websites like https://stackoverflow.com.
Bugs should be reported at https://bugs.ruby-lang.org. Read ["Reporting Issues"](https://docs.ruby-lang.org/en/master/contributing/reporting_issues_md.html) for more information.
## Contributing
See ["Contributing to Ruby"](https://docs.ruby-lang.org/en/master/contributing_md.html), which includes setup and build instructions.
## The Author
Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.
<matz@ruby-lang.org>
share/licenses/alt-ruby33/COPYING 0000644 00000004573 15173517740 0012436 0 ustar 00 Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
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.
share/licenses/alt-ruby33/COPYING.ja 0000644 00000004776 15173517740 0013034 0 ustar 00 本プログラムはフリーソフトウェアです．2-clause BSDL
または以下に示す条件で本プログラムを再配布できます
2-clause BSDLについてはBSDLファイルを参照して下さい．
1. 複製は制限なく自由です．
2. 以下の条件のいずれかを満たす時に本プログラムのソースを
自由に変更できます．
a. ネットニューズにポストしたり，作者に変更を送付する
などの方法で，変更を公開する．
b. 変更した本プログラムを自分の所属する組織内部だけで
使う．
c. 変更点を明示したうえ，ソフトウェアの名前を変更する．
そのソフトウェアを配布する時には変更前の本プログラ
ムも同時に配布する．または変更前の本プログラムのソー
スの入手法を明示する．
d. その他の変更条件を作者と合意する．
3. 以下の条件のいずれかを満たす時に本プログラムをコンパイ
ルしたオブジェクトコードや実行形式でも配布できます．
a. バイナリを受け取った人がソースを入手できるように，
ソースの入手法を明示する．
b. 機械可読なソースコードを添付する．
c. 変更を行ったバイナリは名前を変更したうえ，オリジナ
ルのソースコードの入手法を明示する．
d. その他の配布条件を作者と合意する．
4. 他のプログラムへの引用はいかなる目的であれ自由です．た
だし，本プログラムに含まれる他の作者によるコードは，そ
れぞれの作者の意向による制限が加えられる場合があります．
それらファイルの一覧とそれぞれの配布条件などに付いては
LEGALファイルを参照してください．
5. 本プログラムへの入力となるスクリプトおよび，本プログラ
ムからの出力の権利は本プログラムの作者ではなく，それぞ
れの入出力を生成した人に属します．また，本プログラムに
組み込まれるための拡張ライブラリについても同様です．
6. 本プログラムは無保証です．作者は本プログラムをサポート
する意志はありますが，プログラム自身のバグあるいは本プ
ログラムの実行などから発生するいかなる損害に対しても責
任を持ちません．
share/licenses/alt-ruby33/BSDL 0000644 00000002413 15173517740 0012041 0 ustar 00 Copyright (C) 1993-2013 Yukihiro 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.
share/licenses/alt-ruby33/LEGAL 0000644 00000125255 15173517740 0012153 0 ustar 00 # -*- rdoc -*-
= LEGAL NOTICE INFORMATION
--------------------------
All the files in this distribution are covered under either the Ruby's
license (see the file COPYING) or public-domain except some files
mentioned below.
[addr2line.c]
A part of this file is from FreeBSD.
>>>
Copyright (c) 1986, 1988, 1991, 1993::
The Regents of the University of California. All rights reserved.
(c) UNIX System Laboratories, Inc.
All or some portions of this file are derived from material licensed
to the University of California by American Telephone and Telegraph
Co. or Unix System Laboratories, Inc. and are reproduced herein with
the permission of UNIX System Laboratories, Inc.
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.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
@(#)subr_prf.c 8.3 (Berkeley) 1/21/94
[ccan/build_assert/build_assert.h]
[ccan/check_type/check_type.h]
[ccan/container_of/container_of.h]
[ccan/str/str.h]
These files are licensed under the {CC0}[https://creativecommons.org/choose/zero/].
[ccan/list/list.h]
This file is licensed under the {MIT License}[rdoc-label:label-MIT+License].
[coroutine]
Unless otherwise specified, these files are licensed under the
{MIT License}[rdoc-label:label-MIT+License].
[include/ruby/onigmo.h]
[include/ruby/oniguruma.h]
[regcomp.c]
[regenc.c]
[regenc.h]
[regerror.c]
[regexec.c]
[regint.h]
[regparse.c]
[regparse.h]
[enc/ascii.c]
[enc/big5.c]
[enc/cp949.c]
[enc/emacs_mule.c]
[enc/encdb.c]
[enc/euc_jp.c]
[enc/euc_kr.c]
[enc/euc_tw.c]
[enc/gb18030.c]
[enc/gb2312.c]
[enc/gbk.c]
[enc/iso_8859_1.c]
[enc/iso_8859_10.c]
[enc/iso_8859_11.c]
[enc/iso_8859_13.c]
[enc/iso_8859_14.c]
[enc/iso_8859_15.c]
[enc/iso_8859_16.c]
[enc/iso_8859_2.c]
[enc/iso_8859_3.c]
[enc/iso_8859_4.c]
[enc/iso_8859_5.c]
[enc/iso_8859_6.c]
[enc/iso_8859_7.c]
[enc/iso_8859_8.c]
[enc/iso_8859_9.c]
[enc/koi8_r.c]
[enc/koi8_u.c]
[enc/shift_jis.c]
[enc/unicode.c]
[enc/us_ascii.c]
[enc/utf_16be.c]
[enc/utf_16le.c]
[enc/utf_32be.c]
[enc/utf_32le.c]
[enc/utf_8.c]
[enc/windows_1251.c]
[enc/windows_31j.c]
Onigmo (Oniguruma-mod) LICENSE
>>>
Copyright (c) 2002-2009:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
Copyright (c) 2011-2014:: K.Takata <kentkt AT csc DOT jp>
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.
Oniguruma LICENSE
>>>
Copyright (c) 2002-2009:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
* https://github.com/k-takata/Onigmo/
* https://github.com/kkos/oniguruma
* https://svnweb.freebsd.org/ports/head/devel/oniguruma/
When this software is partly used or it is distributed with Ruby,
this of Ruby follows the license of Ruby.
[enc/windows_1250.c]
[enc/windows_1252.c]
>>>
Copyright (c) 2006-2007:: Byte <byte AT mail DOT kna DOT ru>
K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
[enc/cesu_8.c]
[enc/windows_1253.c]
[enc/windows_1254.c]
[enc/windows_1257.c]
>>>
Copyright (c) 2002-2007:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
[enc/trans/GB/GB12345%UCS.src]
[enc/trans/GB/UCS%GB12345.src]
[enc/trans/GB/GB2312%UCS.src]
[enc/trans/GB/UCS%GB2312.src]
These files have this explanatory texts.
>>>
This mapping data was created from files provided by Unicode, Inc.
(The Unicode Consortium). The files were used to create a product supporting
Unicode, as explicitly permitted in the files' copyright notices.
Please note that Unicode, Inc. never made any claims as to fitness of these
files for any particular purpose, and has ceased to publish the files many
years ago.
[enc/trans/JIS/JISX0201-KANA%UCS.src]
[enc/trans/JIS/JISX0208\@1990%UCS.src]
[enc/trans/JIS/JISX0212%UCS.src]
[enc/trans/JIS/UCS%JISX0201-KANA.src]
[enc/trans/JIS/UCS%JISX0208@1990.src]
[enc/trans/JIS/UCS%JISX0212.src]
These files are copyrighted as the following.
>>>
© 2015 Unicode®, Inc.
For terms of use, see http://www.unicode.org/terms_of_use.html
[enc/trans/JIS/JISX0213-1%UCS@BMP.src]
[enc/trans/JIS/JISX0213-1%UCS@SIP.src]
[enc/trans/JIS/JISX0213-2%UCS@BMP.src]
[enc/trans/JIS/JISX0213-2%UCS@SIP.src]
These files are copyrighted as the following.
>>>
Copyright (C) 2001:: earthian@tama.or.jp, All Rights Reserved.
Copyright (C) 2001:: I'O, All Rights Reserved.
Copyright (C) 2006:: Project X0213, All Rights Reserved.
You can use, modify, distribute this table freely.
[enc/trans/JIS/UCS@BMP%JISX0213-1.src]
[enc/trans/JIS/UCS@BMP%JISX0213-2.src]
[enc/trans/JIS/UCS@SIP%JISX0213-1.src]
[enc/trans/JIS/UCS@SIP%JISX0213-2.src]
These files are copyrighted as the following.
>>>
Copyright (C) 2001:: earthian@tama.or.jp, All Rights Reserved.
Copyright (C) 2001:: I'O, All Rights Reserved.
You can use, modify, distribute this table freely.
[enc/trans/ucm/glibc-BIG5-2.3.3.ucm]
[enc/trans/ucm/glibc-BIG5HKSCS-2.3.3.ucm]
>>>
Copyright (C) 2001-2005:: International Business Machines
Corporation and others. All Rights Reserved.
[enc/trans/ucm/windows-950-2000.ucm]
[enc/trans/ucm/windows-950_hkscs-2001.ucm]
>>>
Copyright (C) 2001-2002:: International Business Machines
Corporation and others. All Rights Reserved.
[configure]
This file is free software.
>>>
Copyright (C) 1992-1996, 1998-2012:: Free Software Foundation, Inc.
This configure script is free software; the Free Software Foundation
gives unlimited permission to copy, distribute and modify it.
[tool/config.guess]
[tool/config.sub]
As long as you distribute these files with the file configure, they
are covered under the Ruby's license.
>>>
Copyright 1992-2018:: Free Software Foundation, Inc.
This file is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses/>.
As a special exception to the GNU General Public License, if you
distribute this file as part of a program that contains a
configuration script generated by Autoconf, you may include it under
the same distribution terms that you use for the rest of that
program. This Exception is an additional permission under section 7
of the GNU General Public License, version 3 ("GPLv3").
[tool/lib/test/*]
[tool/lib/core_assertions.rb]
Some of methods on these files are based on MiniTest 4. MiniTest 4 is
distributed under the MIT License.
>>>
Copyright (c) Ryan Davis, seattle.rb
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[parse.c]
[parse.h]
These files are licensed under the GPL, but are incorporated into Ruby and
redistributed under the terms of the Ruby license, as permitted by the
exception to the GPL below.
>>>
Copyright (C) 1984, 1989-1990, 2000-2015, 2018:: Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
As a special exception, you may create a larger work that contains
part or all of the Bison parser skeleton and distribute that work
under terms of your choice, so long as that work isn't itself a
parser generator using the skeleton or a modified version thereof
as a parser skeleton. Alternatively, if you modify or redistribute
the parser skeleton itself, you may (at your option) remove this
special exception, which will cause the skeleton and the resulting
Bison output files to be licensed under the GNU General Public
License without this special exception.
This special exception was added by the Free Software Foundation in
version 2.2 of Bison.
[missing/dtoa.c]
This file is under these licenses.
>>>
Copyright (c) 1991, 2000, 2001:: by Lucent Technologies.
Permission to use, copy, modify, and distribute this software for any
purpose without fee is hereby granted, provided that this entire notice
is included in all copies of any software which is or includes a copy
or modification of this software and in all copies of the supporting
documentation for such software.
THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY
REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY
OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
>>>
Copyright (c) 2004-2008:: David Schultz <das@FreeBSD.ORG>
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.
[win32/win32.c]
[include/ruby/win32.h]
You can apply the Artistic License to these files. (or GPL,
alternatively)
>>>
Copyright (c) 1993:: Intergraph Corporation
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the perl README file.
[missing/mt19937.c]
This file is under the new-style BSD license.
>>>
A C-program for MT19937, with initialization improved 2002/2/10.::
Coded by Takuji Nishimura and Makoto Matsumoto.
This is a faster version by taking Shawn Cokus's optimization,
Matthe Bellew's simplification, Isaku Wada's real version.
Before using, initialize the state by using init_genrand(seed)
or init_by_array(init_key, key_length).
Copyright (C) 1997 - 2002:: Makoto Matsumoto and Takuji Nishimura,
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.
3. The names of its contributors may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
Any feedback is very welcome.
http://www.math.keio.ac.jp/matumoto/emt.html
email: matumoto@math.keio.ac.jp
The Wayback Machine url: http://web.archive.org/web/19990429082237/http://www.math.keio.ac.jp/matumoto/emt.html
[missing/procstat_vm.c]
This file is under the new-style BSD license.
>>>
Copyright (c) 2007:: Robert N. M. Watson
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.
$FreeBSD: head/usr.bin/procstat/procstat_vm.c 261780 2014-02-11 21:57:37Z jhb $
[vsnprintf.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright (c) 1990, 1993::
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Chris Torek.
[st.c]
[strftime.c]
[include/ruby/st.h]
[missing/acosh.c]
[missing/alloca.c]
[missing/erf.c]
[missing/hypot.c]
[missing/lgamma_r.c]
[missing/memcmp.c]
[missing/memmove.c]
[missing/strchr.c]
[missing/strerror.c]
[missing/strstr.c]
[missing/tgamma.c]
[ext/date/date_strftime.c]
[ext/digest/sha1/sha1.c]
[ext/digest/sha1/sha1.h]
These files are all under public domain.
[missing/crypt.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright (c) 1989, 1993::
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Tom Truscott.
[missing/setproctitle.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright 2003:: Damien Miller
Copyright (c) 1983, 1995-1997:: Eric P. Allman
Copyright (c) 1988, 1993::
The Regents of the University of California. All rights reserved.
[missing/strlcat.c]
[missing/strlcpy.c]
These files are under an ISC-style license.
>>>
Copyright (c) 1998, 2015:: Todd C. Miller <Todd.Miller@courtesan.com>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
[missing/langinfo.c]
This file is from http://www.cl.cam.ac.uk/~mgk25/ucs/langinfo.c.
Ruby uses a modified version. The file contains the following
author/copyright notice:
>>>
Markus.Kuhn@cl.cam.ac.uk -- 2002-03-11::
Permission to use, copy, modify, and distribute this software
for any purpose and without fee is hereby granted. The author
disclaims all warranties with regard to this software.
[ext/digest/md5/md5.c]
[ext/digest/md5/md5.h]
These files are under the following license. Ruby uses modified
versions of them.
>>>
Copyright (C) 1999, 2000:: Aladdin Enterprises. All rights reserved.
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
L. Peter Deutsch
ghost@aladdin.com
[ext/digest/rmd160/rmd160.c]
[ext/digest/rmd160/rmd160.h]
These files have the following copyright information, and by the
author we are allowed to use it under the new-style BSD license.
>>>
AUTHOR:: Antoon Bosselaers, ESAT-COSIC
(Arranged for libc by Todd C. Miller)
DATE:: 1 March 1996
Copyright (c):: Katholieke Universiteit Leuven
1996, All Rights Reserved
[ext/digest/sha2/sha2.c]
[ext/digest/sha2/sha2.h]
These files are under the new-style BSD license.
>>>
Copyright 2000:: Aaron D. Gifford. 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.
3. Neither the name of the copyright holder nor the names of contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) AND CONTRIBUTOR(S) ``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(S) OR CONTRIBUTOR(S) 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.
[ext/json/generator/generator.c]
The file contains the following copyright notice.
>>>
Copyright 2001-2004:: Unicode, Inc.
Disclaimer::
This source code is provided as is by Unicode, Inc. No claims are
made as to fitness for any particular purpose. No warranties of any
kind are expressed or implied. The recipient agrees to determine
applicability of information provided. If this file has been
purchased on magnetic or optical media from Unicode, Inc., the
sole remedy for any claim will be exchange of defective media
within 90 days of receipt.
Limitations on Rights to Redistribute This Code::
Unicode, Inc. hereby grants the right to freely use the information
supplied in this file in the creation of products supporting the
Unicode Standard, and to make copies of this file in any form
for internal or external distribution as long as this notice
remains attached.
[ext/nkf/nkf-utf8/config.h]
[ext/nkf/nkf-utf8/nkf.c]
[ext/nkf/nkf-utf8/utf8tbl.c]
These files are under the following license. So to speak, it is
copyrighted semi-public-domain software.
>>>
Copyright (C) 1987:: Fujitsu LTD. (Itaru ICHIKAWA)
Everyone is permitted to do anything on this program
including copying, modifying, improving,
as long as you don't try to pretend that you wrote it.
i.e., the above copyright notice has to appear in all copies.
Binary distribution requires original version messages.
You don't have to ask before copying, redistribution or publishing.
THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE.
[ext/psych]
[test/psych]
The files under these directories are under the following license.
>>>
Copyright 2009:: Aaron Patterson, et al.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[ext/pty/pty.c]
>>>
C) Copyright 1998:: by Akinori Ito.
This software may be redistributed freely for this purpose, in full
or in part, provided that this entire copyright notice is included
on any copies of this software and applications and derivations thereof.
This software is provided on an "as is" basis, without warranty of any
kind, either expressed or implied, as to any matter including, but not
limited to warranty of fitness of purpose, or merchantability, or
results obtained from use of this software.
[ext/socket/addrinfo.h]
[ext/socket/getaddrinfo.c]
[ext/socket/getnameinfo.c]
These files are under the new-style BSD license.
>>>
Copyright (C) 1995, 1996, 1997, 1998, and 1999:: WIDE Project.
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.
3. Neither the name of the project nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE PROJECT 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 PROJECT 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.
[ext/win32ole/win32ole.c]
You can apply the Artistic License to this file. (or GPL,
alternatively)
>>>
(c) 1995:: Microsoft Corporation. All rights reserved.
Developed by ActiveWare Internet Corp., http://www.ActiveWare.com
Other modifications Copyright (c) 1997, 1998:: by Gurusamy Sarathy
<gsar@umich.edu> and Jan Dubois <jan.dubois@ibm.net>
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the README file
of the Perl distribution.
The Wayback Machine url: http://web.archive.org/web/19970607104352/http://www.activeware.com:80/
[lib/rdoc/generator/template/darkfish/css/fonts.css]
This file is licensed under the {SIL Open Font License}[http://scripts.sil.org/OFL].
[spec/mspec]
[spec/ruby]
The files under these directories are under the following license.
>>>
Copyright (c) 2008:: Engine Yard, Inc. All rights reserved.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[lib/rubygems.rb]
[lib/rubygems]
[test/rubygems]
RubyGems is under the following license.
>>>
RubyGems is copyrighted free software by Chad Fowler, Rich Kilmer, Jim
Weirich and others. You can redistribute it and/or modify it under
either the terms of the {MIT license}[rdoc-label:label-MIT+License], 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 executables 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 executable
form, provided that you do at least ONE of the following:
a. distribute the executables 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 executables 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).
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.
[lib/bundler]
[lib/bundler.rb]
[spec/bundler]
Bundler is under the following license.
>>>
Portions copyright (c) 2010:: Andre Arko
Portions copyright (c) 2009:: Engine Yard
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/thor]
Thor is under the following license.
>>>
Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
{MIT License}[rdoc-label:label-MIT+License]
[lib/rubygems/resolver/molinillo]
molinillo is under the following license.
>>>
Copyright (c) 2014 Samuel E. Giddins segiddins@segiddins.me
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/pub_grub]
pub_grub is under the following license.
>>>
Copyright (c) 2018 John Hawthorn
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/connection_pool]
connection_pool is under the following license.
>>>
Copyright (c) 2011 Mike Perham
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/net-http-persistent]
net-http-persistent is under the following license.
>>>
Copyright (c) Eric Hodel, Aaron Patterson
{MIT License}[rdoc-label:label-MIT+License]
[lib/did_you_mean]
[lib/did_you_mean.rb]
[test/did_you_mean]
did_you_mean is under the following license.
>>>
Copyright (c) 2014-2016 Yuki Nishijima
{MIT License}[rdoc-label:label-MIT+License]
[lib/error_highlight]
[lib/error_highlight.rb]
[test/error_highlight]
error_highlight is under the following license.
>>>
Copyright (c) 2021 Yusuke Endoh
{MIT License}[rdoc-label:label-MIT+License]
[benchmark/so_ackermann.rb]
[benchmark/so_array.rb]
[benchmark/so_binary_trees.rb]
[benchmark/so_concatenate.rb]
[benchmark/so_count_words.yml]
[benchmark/so_exception.rb]
[benchmark/so_fannkuch.rb]
[benchmark/so_fasta.rb]
[benchmark/so_k_nucleotide.yml]
[benchmark/so_lists.rb]
[benchmark/so_mandelbrot.rb]
[benchmark/so_matrix.rb]
[benchmark/so_meteor_contest.rb]
[benchmark/so_nbody.rb]
[benchmark/so_nested_loop.rb]
[benchmark/so_nsieve.rb]
[benchmark/so_nsieve_bits.rb]
[benchmark/so_object.rb]
[benchmark/so_partial_sums.rb]
[benchmark/so_pidigits.rb]
[benchmark/so_random.rb]
[benchmark/so_reverse_complement.yml]
[benchmark/so_sieve.rb]
[benchmark/so_spectralnorm.rb]
These files are very old copy of then-called "The Great Computer Language
Shootout". LEGAL SITUATION OF THESE FILES ARE UNCLEAR because the original
site has been lost. Upstream diverged to delete several benchmarks listed
above.
== MIT License
>>>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
== Old-style BSD license
>>>
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.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
IMPORTANT NOTE::
From ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change
paragraph 3 above is now null and void.
share/licenses/alt-ruby33/GPL 0000644 00000043254 15173517740 0011747 0 ustar 00 GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
share/licenses/alt-ruby33-libs/COPYING 0000644 00000004573 15173517740 0013365 0 ustar 00 Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
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.
share/licenses/alt-ruby33-libs/COPYING.ja 0000644 00000004776 15173517740 0013763 0 ustar 00 本プログラムはフリーソフトウェアです．2-clause BSDL
または以下に示す条件で本プログラムを再配布できます
2-clause BSDLについてはBSDLファイルを参照して下さい．
1. 複製は制限なく自由です．
2. 以下の条件のいずれかを満たす時に本プログラムのソースを
自由に変更できます．
a. ネットニューズにポストしたり，作者に変更を送付する
などの方法で，変更を公開する．
b. 変更した本プログラムを自分の所属する組織内部だけで
使う．
c. 変更点を明示したうえ，ソフトウェアの名前を変更する．
そのソフトウェアを配布する時には変更前の本プログラ
ムも同時に配布する．または変更前の本プログラムのソー
スの入手法を明示する．
d. その他の変更条件を作者と合意する．
3. 以下の条件のいずれかを満たす時に本プログラムをコンパイ
ルしたオブジェクトコードや実行形式でも配布できます．
a. バイナリを受け取った人がソースを入手できるように，
ソースの入手法を明示する．
b. 機械可読なソースコードを添付する．
c. 変更を行ったバイナリは名前を変更したうえ，オリジナ
ルのソースコードの入手法を明示する．
d. その他の配布条件を作者と合意する．
4. 他のプログラムへの引用はいかなる目的であれ自由です．た
だし，本プログラムに含まれる他の作者によるコードは，そ
れぞれの作者の意向による制限が加えられる場合があります．
それらファイルの一覧とそれぞれの配布条件などに付いては
LEGALファイルを参照してください．
5. 本プログラムへの入力となるスクリプトおよび，本プログラ
ムからの出力の権利は本プログラムの作者ではなく，それぞ
れの入出力を生成した人に属します．また，本プログラムに
組み込まれるための拡張ライブラリについても同様です．
6. 本プログラムは無保証です．作者は本プログラムをサポート
する意志はありますが，プログラム自身のバグあるいは本プ
ログラムの実行などから発生するいかなる損害に対しても責
任を持ちません．
share/licenses/alt-ruby33-libs/LEGAL 0000644 00000125255 15173517740 0013102 0 ustar 00 # -*- rdoc -*-
= LEGAL NOTICE INFORMATION
--------------------------
All the files in this distribution are covered under either the Ruby's
license (see the file COPYING) or public-domain except some files
mentioned below.
[addr2line.c]
A part of this file is from FreeBSD.
>>>
Copyright (c) 1986, 1988, 1991, 1993::
The Regents of the University of California. All rights reserved.
(c) UNIX System Laboratories, Inc.
All or some portions of this file are derived from material licensed
to the University of California by American Telephone and Telegraph
Co. or Unix System Laboratories, Inc. and are reproduced herein with
the permission of UNIX System Laboratories, Inc.
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.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
@(#)subr_prf.c 8.3 (Berkeley) 1/21/94
[ccan/build_assert/build_assert.h]
[ccan/check_type/check_type.h]
[ccan/container_of/container_of.h]
[ccan/str/str.h]
These files are licensed under the {CC0}[https://creativecommons.org/choose/zero/].
[ccan/list/list.h]
This file is licensed under the {MIT License}[rdoc-label:label-MIT+License].
[coroutine]
Unless otherwise specified, these files are licensed under the
{MIT License}[rdoc-label:label-MIT+License].
[include/ruby/onigmo.h]
[include/ruby/oniguruma.h]
[regcomp.c]
[regenc.c]
[regenc.h]
[regerror.c]
[regexec.c]
[regint.h]
[regparse.c]
[regparse.h]
[enc/ascii.c]
[enc/big5.c]
[enc/cp949.c]
[enc/emacs_mule.c]
[enc/encdb.c]
[enc/euc_jp.c]
[enc/euc_kr.c]
[enc/euc_tw.c]
[enc/gb18030.c]
[enc/gb2312.c]
[enc/gbk.c]
[enc/iso_8859_1.c]
[enc/iso_8859_10.c]
[enc/iso_8859_11.c]
[enc/iso_8859_13.c]
[enc/iso_8859_14.c]
[enc/iso_8859_15.c]
[enc/iso_8859_16.c]
[enc/iso_8859_2.c]
[enc/iso_8859_3.c]
[enc/iso_8859_4.c]
[enc/iso_8859_5.c]
[enc/iso_8859_6.c]
[enc/iso_8859_7.c]
[enc/iso_8859_8.c]
[enc/iso_8859_9.c]
[enc/koi8_r.c]
[enc/koi8_u.c]
[enc/shift_jis.c]
[enc/unicode.c]
[enc/us_ascii.c]
[enc/utf_16be.c]
[enc/utf_16le.c]
[enc/utf_32be.c]
[enc/utf_32le.c]
[enc/utf_8.c]
[enc/windows_1251.c]
[enc/windows_31j.c]
Onigmo (Oniguruma-mod) LICENSE
>>>
Copyright (c) 2002-2009:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
Copyright (c) 2011-2014:: K.Takata <kentkt AT csc DOT jp>
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.
Oniguruma LICENSE
>>>
Copyright (c) 2002-2009:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
* https://github.com/k-takata/Onigmo/
* https://github.com/kkos/oniguruma
* https://svnweb.freebsd.org/ports/head/devel/oniguruma/
When this software is partly used or it is distributed with Ruby,
this of Ruby follows the license of Ruby.
[enc/windows_1250.c]
[enc/windows_1252.c]
>>>
Copyright (c) 2006-2007:: Byte <byte AT mail DOT kna DOT ru>
K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
[enc/cesu_8.c]
[enc/windows_1253.c]
[enc/windows_1254.c]
[enc/windows_1257.c]
>>>
Copyright (c) 2002-2007:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
[enc/trans/GB/GB12345%UCS.src]
[enc/trans/GB/UCS%GB12345.src]
[enc/trans/GB/GB2312%UCS.src]
[enc/trans/GB/UCS%GB2312.src]
These files have this explanatory texts.
>>>
This mapping data was created from files provided by Unicode, Inc.
(The Unicode Consortium). The files were used to create a product supporting
Unicode, as explicitly permitted in the files' copyright notices.
Please note that Unicode, Inc. never made any claims as to fitness of these
files for any particular purpose, and has ceased to publish the files many
years ago.
[enc/trans/JIS/JISX0201-KANA%UCS.src]
[enc/trans/JIS/JISX0208\@1990%UCS.src]
[enc/trans/JIS/JISX0212%UCS.src]
[enc/trans/JIS/UCS%JISX0201-KANA.src]
[enc/trans/JIS/UCS%JISX0208@1990.src]
[enc/trans/JIS/UCS%JISX0212.src]
These files are copyrighted as the following.
>>>
© 2015 Unicode®, Inc.
For terms of use, see http://www.unicode.org/terms_of_use.html
[enc/trans/JIS/JISX0213-1%UCS@BMP.src]
[enc/trans/JIS/JISX0213-1%UCS@SIP.src]
[enc/trans/JIS/JISX0213-2%UCS@BMP.src]
[enc/trans/JIS/JISX0213-2%UCS@SIP.src]
These files are copyrighted as the following.
>>>
Copyright (C) 2001:: earthian@tama.or.jp, All Rights Reserved.
Copyright (C) 2001:: I'O, All Rights Reserved.
Copyright (C) 2006:: Project X0213, All Rights Reserved.
You can use, modify, distribute this table freely.
[enc/trans/JIS/UCS@BMP%JISX0213-1.src]
[enc/trans/JIS/UCS@BMP%JISX0213-2.src]
[enc/trans/JIS/UCS@SIP%JISX0213-1.src]
[enc/trans/JIS/UCS@SIP%JISX0213-2.src]
These files are copyrighted as the following.
>>>
Copyright (C) 2001:: earthian@tama.or.jp, All Rights Reserved.
Copyright (C) 2001:: I'O, All Rights Reserved.
You can use, modify, distribute this table freely.
[enc/trans/ucm/glibc-BIG5-2.3.3.ucm]
[enc/trans/ucm/glibc-BIG5HKSCS-2.3.3.ucm]
>>>
Copyright (C) 2001-2005:: International Business Machines
Corporation and others. All Rights Reserved.
[enc/trans/ucm/windows-950-2000.ucm]
[enc/trans/ucm/windows-950_hkscs-2001.ucm]
>>>
Copyright (C) 2001-2002:: International Business Machines
Corporation and others. All Rights Reserved.
[configure]
This file is free software.
>>>
Copyright (C) 1992-1996, 1998-2012:: Free Software Foundation, Inc.
This configure script is free software; the Free Software Foundation
gives unlimited permission to copy, distribute and modify it.
[tool/config.guess]
[tool/config.sub]
As long as you distribute these files with the file configure, they
are covered under the Ruby's license.
>>>
Copyright 1992-2018:: Free Software Foundation, Inc.
This file is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses/>.
As a special exception to the GNU General Public License, if you
distribute this file as part of a program that contains a
configuration script generated by Autoconf, you may include it under
the same distribution terms that you use for the rest of that
program. This Exception is an additional permission under section 7
of the GNU General Public License, version 3 ("GPLv3").
[tool/lib/test/*]
[tool/lib/core_assertions.rb]
Some of methods on these files are based on MiniTest 4. MiniTest 4 is
distributed under the MIT License.
>>>
Copyright (c) Ryan Davis, seattle.rb
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[parse.c]
[parse.h]
These files are licensed under the GPL, but are incorporated into Ruby and
redistributed under the terms of the Ruby license, as permitted by the
exception to the GPL below.
>>>
Copyright (C) 1984, 1989-1990, 2000-2015, 2018:: Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
As a special exception, you may create a larger work that contains
part or all of the Bison parser skeleton and distribute that work
under terms of your choice, so long as that work isn't itself a
parser generator using the skeleton or a modified version thereof
as a parser skeleton. Alternatively, if you modify or redistribute
the parser skeleton itself, you may (at your option) remove this
special exception, which will cause the skeleton and the resulting
Bison output files to be licensed under the GNU General Public
License without this special exception.
This special exception was added by the Free Software Foundation in
version 2.2 of Bison.
[missing/dtoa.c]
This file is under these licenses.
>>>
Copyright (c) 1991, 2000, 2001:: by Lucent Technologies.
Permission to use, copy, modify, and distribute this software for any
purpose without fee is hereby granted, provided that this entire notice
is included in all copies of any software which is or includes a copy
or modification of this software and in all copies of the supporting
documentation for such software.
THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY
REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY
OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
>>>
Copyright (c) 2004-2008:: David Schultz <das@FreeBSD.ORG>
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.
[win32/win32.c]
[include/ruby/win32.h]
You can apply the Artistic License to these files. (or GPL,
alternatively)
>>>
Copyright (c) 1993:: Intergraph Corporation
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the perl README file.
[missing/mt19937.c]
This file is under the new-style BSD license.
>>>
A C-program for MT19937, with initialization improved 2002/2/10.::
Coded by Takuji Nishimura and Makoto Matsumoto.
This is a faster version by taking Shawn Cokus's optimization,
Matthe Bellew's simplification, Isaku Wada's real version.
Before using, initialize the state by using init_genrand(seed)
or init_by_array(init_key, key_length).
Copyright (C) 1997 - 2002:: Makoto Matsumoto and Takuji Nishimura,
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.
3. The names of its contributors may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
Any feedback is very welcome.
http://www.math.keio.ac.jp/matumoto/emt.html
email: matumoto@math.keio.ac.jp
The Wayback Machine url: http://web.archive.org/web/19990429082237/http://www.math.keio.ac.jp/matumoto/emt.html
[missing/procstat_vm.c]
This file is under the new-style BSD license.
>>>
Copyright (c) 2007:: Robert N. M. Watson
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.
$FreeBSD: head/usr.bin/procstat/procstat_vm.c 261780 2014-02-11 21:57:37Z jhb $
[vsnprintf.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright (c) 1990, 1993::
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Chris Torek.
[st.c]
[strftime.c]
[include/ruby/st.h]
[missing/acosh.c]
[missing/alloca.c]
[missing/erf.c]
[missing/hypot.c]
[missing/lgamma_r.c]
[missing/memcmp.c]
[missing/memmove.c]
[missing/strchr.c]
[missing/strerror.c]
[missing/strstr.c]
[missing/tgamma.c]
[ext/date/date_strftime.c]
[ext/digest/sha1/sha1.c]
[ext/digest/sha1/sha1.h]
These files are all under public domain.
[missing/crypt.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright (c) 1989, 1993::
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Tom Truscott.
[missing/setproctitle.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright 2003:: Damien Miller
Copyright (c) 1983, 1995-1997:: Eric P. Allman
Copyright (c) 1988, 1993::
The Regents of the University of California. All rights reserved.
[missing/strlcat.c]
[missing/strlcpy.c]
These files are under an ISC-style license.
>>>
Copyright (c) 1998, 2015:: Todd C. Miller <Todd.Miller@courtesan.com>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
[missing/langinfo.c]
This file is from http://www.cl.cam.ac.uk/~mgk25/ucs/langinfo.c.
Ruby uses a modified version. The file contains the following
author/copyright notice:
>>>
Markus.Kuhn@cl.cam.ac.uk -- 2002-03-11::
Permission to use, copy, modify, and distribute this software
for any purpose and without fee is hereby granted. The author
disclaims all warranties with regard to this software.
[ext/digest/md5/md5.c]
[ext/digest/md5/md5.h]
These files are under the following license. Ruby uses modified
versions of them.
>>>
Copyright (C) 1999, 2000:: Aladdin Enterprises. All rights reserved.
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
L. Peter Deutsch
ghost@aladdin.com
[ext/digest/rmd160/rmd160.c]
[ext/digest/rmd160/rmd160.h]
These files have the following copyright information, and by the
author we are allowed to use it under the new-style BSD license.
>>>
AUTHOR:: Antoon Bosselaers, ESAT-COSIC
(Arranged for libc by Todd C. Miller)
DATE:: 1 March 1996
Copyright (c):: Katholieke Universiteit Leuven
1996, All Rights Reserved
[ext/digest/sha2/sha2.c]
[ext/digest/sha2/sha2.h]
These files are under the new-style BSD license.
>>>
Copyright 2000:: Aaron D. Gifford. 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.
3. Neither the name of the copyright holder nor the names of contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) AND CONTRIBUTOR(S) ``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(S) OR CONTRIBUTOR(S) 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.
[ext/json/generator/generator.c]
The file contains the following copyright notice.
>>>
Copyright 2001-2004:: Unicode, Inc.
Disclaimer::
This source code is provided as is by Unicode, Inc. No claims are
made as to fitness for any particular purpose. No warranties of any
kind are expressed or implied. The recipient agrees to determine
applicability of information provided. If this file has been
purchased on magnetic or optical media from Unicode, Inc., the
sole remedy for any claim will be exchange of defective media
within 90 days of receipt.
Limitations on Rights to Redistribute This Code::
Unicode, Inc. hereby grants the right to freely use the information
supplied in this file in the creation of products supporting the
Unicode Standard, and to make copies of this file in any form
for internal or external distribution as long as this notice
remains attached.
[ext/nkf/nkf-utf8/config.h]
[ext/nkf/nkf-utf8/nkf.c]
[ext/nkf/nkf-utf8/utf8tbl.c]
These files are under the following license. So to speak, it is
copyrighted semi-public-domain software.
>>>
Copyright (C) 1987:: Fujitsu LTD. (Itaru ICHIKAWA)
Everyone is permitted to do anything on this program
including copying, modifying, improving,
as long as you don't try to pretend that you wrote it.
i.e., the above copyright notice has to appear in all copies.
Binary distribution requires original version messages.
You don't have to ask before copying, redistribution or publishing.
THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE.
[ext/psych]
[test/psych]
The files under these directories are under the following license.
>>>
Copyright 2009:: Aaron Patterson, et al.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[ext/pty/pty.c]
>>>
C) Copyright 1998:: by Akinori Ito.
This software may be redistributed freely for this purpose, in full
or in part, provided that this entire copyright notice is included
on any copies of this software and applications and derivations thereof.
This software is provided on an "as is" basis, without warranty of any
kind, either expressed or implied, as to any matter including, but not
limited to warranty of fitness of purpose, or merchantability, or
results obtained from use of this software.
[ext/socket/addrinfo.h]
[ext/socket/getaddrinfo.c]
[ext/socket/getnameinfo.c]
These files are under the new-style BSD license.
>>>
Copyright (C) 1995, 1996, 1997, 1998, and 1999:: WIDE Project.
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.
3. Neither the name of the project nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE PROJECT 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 PROJECT 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.
[ext/win32ole/win32ole.c]
You can apply the Artistic License to this file. (or GPL,
alternatively)
>>>
(c) 1995:: Microsoft Corporation. All rights reserved.
Developed by ActiveWare Internet Corp., http://www.ActiveWare.com
Other modifications Copyright (c) 1997, 1998:: by Gurusamy Sarathy
<gsar@umich.edu> and Jan Dubois <jan.dubois@ibm.net>
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the README file
of the Perl distribution.
The Wayback Machine url: http://web.archive.org/web/19970607104352/http://www.activeware.com:80/
[lib/rdoc/generator/template/darkfish/css/fonts.css]
This file is licensed under the {SIL Open Font License}[http://scripts.sil.org/OFL].
[spec/mspec]
[spec/ruby]
The files under these directories are under the following license.
>>>
Copyright (c) 2008:: Engine Yard, Inc. All rights reserved.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[lib/rubygems.rb]
[lib/rubygems]
[test/rubygems]
RubyGems is under the following license.
>>>
RubyGems is copyrighted free software by Chad Fowler, Rich Kilmer, Jim
Weirich and others. You can redistribute it and/or modify it under
either the terms of the {MIT license}[rdoc-label:label-MIT+License], 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 executables 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 executable
form, provided that you do at least ONE of the following:
a. distribute the executables 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 executables 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).
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.
[lib/bundler]
[lib/bundler.rb]
[spec/bundler]
Bundler is under the following license.
>>>
Portions copyright (c) 2010:: Andre Arko
Portions copyright (c) 2009:: Engine Yard
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/thor]
Thor is under the following license.
>>>
Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
{MIT License}[rdoc-label:label-MIT+License]
[lib/rubygems/resolver/molinillo]
molinillo is under the following license.
>>>
Copyright (c) 2014 Samuel E. Giddins segiddins@segiddins.me
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/pub_grub]
pub_grub is under the following license.
>>>
Copyright (c) 2018 John Hawthorn
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/connection_pool]
connection_pool is under the following license.
>>>
Copyright (c) 2011 Mike Perham
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/net-http-persistent]
net-http-persistent is under the following license.
>>>
Copyright (c) Eric Hodel, Aaron Patterson
{MIT License}[rdoc-label:label-MIT+License]
[lib/did_you_mean]
[lib/did_you_mean.rb]
[test/did_you_mean]
did_you_mean is under the following license.
>>>
Copyright (c) 2014-2016 Yuki Nishijima
{MIT License}[rdoc-label:label-MIT+License]
[lib/error_highlight]
[lib/error_highlight.rb]
[test/error_highlight]
error_highlight is under the following license.
>>>
Copyright (c) 2021 Yusuke Endoh
{MIT License}[rdoc-label:label-MIT+License]
[benchmark/so_ackermann.rb]
[benchmark/so_array.rb]
[benchmark/so_binary_trees.rb]
[benchmark/so_concatenate.rb]
[benchmark/so_count_words.yml]
[benchmark/so_exception.rb]
[benchmark/so_fannkuch.rb]
[benchmark/so_fasta.rb]
[benchmark/so_k_nucleotide.yml]
[benchmark/so_lists.rb]
[benchmark/so_mandelbrot.rb]
[benchmark/so_matrix.rb]
[benchmark/so_meteor_contest.rb]
[benchmark/so_nbody.rb]
[benchmark/so_nested_loop.rb]
[benchmark/so_nsieve.rb]
[benchmark/so_nsieve_bits.rb]
[benchmark/so_object.rb]
[benchmark/so_partial_sums.rb]
[benchmark/so_pidigits.rb]
[benchmark/so_random.rb]
[benchmark/so_reverse_complement.yml]
[benchmark/so_sieve.rb]
[benchmark/so_spectralnorm.rb]
These files are very old copy of then-called "The Great Computer Language
Shootout". LEGAL SITUATION OF THESE FILES ARE UNCLEAR because the original
site has been lost. Upstream diverged to delete several benchmarks listed
above.
== MIT License
>>>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
== Old-style BSD license
>>>
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.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
IMPORTANT NOTE::
From ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change
paragraph 3 above is now null and void.
share/licenses/alt-ruby33-libs/GPL 0000644 00000043254 15173517740 0012676 0 ustar 00 GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
share/licenses/alt-ruby33-devel/COPYING 0000644 00000004573 15173517740 0013533 0 ustar 00 Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
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.
share/licenses/alt-ruby33-devel/COPYING.ja 0000644 00000004776 15173517740 0014131 0 ustar 00 本プログラムはフリーソフトウェアです．2-clause BSDL
または以下に示す条件で本プログラムを再配布できます
2-clause BSDLについてはBSDLファイルを参照して下さい．
1. 複製は制限なく自由です．
2. 以下の条件のいずれかを満たす時に本プログラムのソースを
自由に変更できます．
a. ネットニューズにポストしたり，作者に変更を送付する
などの方法で，変更を公開する．
b. 変更した本プログラムを自分の所属する組織内部だけで
使う．
c. 変更点を明示したうえ，ソフトウェアの名前を変更する．
そのソフトウェアを配布する時には変更前の本プログラ
ムも同時に配布する．または変更前の本プログラムのソー
スの入手法を明示する．
d. その他の変更条件を作者と合意する．
3. 以下の条件のいずれかを満たす時に本プログラムをコンパイ
ルしたオブジェクトコードや実行形式でも配布できます．
a. バイナリを受け取った人がソースを入手できるように，
ソースの入手法を明示する．
b. 機械可読なソースコードを添付する．
c. 変更を行ったバイナリは名前を変更したうえ，オリジナ
ルのソースコードの入手法を明示する．
d. その他の配布条件を作者と合意する．
4. 他のプログラムへの引用はいかなる目的であれ自由です．た
だし，本プログラムに含まれる他の作者によるコードは，そ
れぞれの作者の意向による制限が加えられる場合があります．
それらファイルの一覧とそれぞれの配布条件などに付いては
LEGALファイルを参照してください．
5. 本プログラムへの入力となるスクリプトおよび，本プログラ
ムからの出力の権利は本プログラムの作者ではなく，それぞ
れの入出力を生成した人に属します．また，本プログラムに
組み込まれるための拡張ライブラリについても同様です．
6. 本プログラムは無保証です．作者は本プログラムをサポート
する意志はありますが，プログラム自身のバグあるいは本プ
ログラムの実行などから発生するいかなる損害に対しても責
任を持ちません．
share/licenses/alt-ruby33-devel/BSDL 0000644 00000002413 15173517740 0013136 0 ustar 00 Copyright (C) 1993-2013 Yukihiro 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.
share/licenses/alt-ruby33-devel/LEGAL 0000644 00000125255 15173517740 0013250 0 ustar 00 # -*- rdoc -*-
= LEGAL NOTICE INFORMATION
--------------------------
All the files in this distribution are covered under either the Ruby's
license (see the file COPYING) or public-domain except some files
mentioned below.
[addr2line.c]
A part of this file is from FreeBSD.
>>>
Copyright (c) 1986, 1988, 1991, 1993::
The Regents of the University of California. All rights reserved.
(c) UNIX System Laboratories, Inc.
All or some portions of this file are derived from material licensed
to the University of California by American Telephone and Telegraph
Co. or Unix System Laboratories, Inc. and are reproduced herein with
the permission of UNIX System Laboratories, Inc.
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.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
@(#)subr_prf.c 8.3 (Berkeley) 1/21/94
[ccan/build_assert/build_assert.h]
[ccan/check_type/check_type.h]
[ccan/container_of/container_of.h]
[ccan/str/str.h]
These files are licensed under the {CC0}[https://creativecommons.org/choose/zero/].
[ccan/list/list.h]
This file is licensed under the {MIT License}[rdoc-label:label-MIT+License].
[coroutine]
Unless otherwise specified, these files are licensed under the
{MIT License}[rdoc-label:label-MIT+License].
[include/ruby/onigmo.h]
[include/ruby/oniguruma.h]
[regcomp.c]
[regenc.c]
[regenc.h]
[regerror.c]
[regexec.c]
[regint.h]
[regparse.c]
[regparse.h]
[enc/ascii.c]
[enc/big5.c]
[enc/cp949.c]
[enc/emacs_mule.c]
[enc/encdb.c]
[enc/euc_jp.c]
[enc/euc_kr.c]
[enc/euc_tw.c]
[enc/gb18030.c]
[enc/gb2312.c]
[enc/gbk.c]
[enc/iso_8859_1.c]
[enc/iso_8859_10.c]
[enc/iso_8859_11.c]
[enc/iso_8859_13.c]
[enc/iso_8859_14.c]
[enc/iso_8859_15.c]
[enc/iso_8859_16.c]
[enc/iso_8859_2.c]
[enc/iso_8859_3.c]
[enc/iso_8859_4.c]
[enc/iso_8859_5.c]
[enc/iso_8859_6.c]
[enc/iso_8859_7.c]
[enc/iso_8859_8.c]
[enc/iso_8859_9.c]
[enc/koi8_r.c]
[enc/koi8_u.c]
[enc/shift_jis.c]
[enc/unicode.c]
[enc/us_ascii.c]
[enc/utf_16be.c]
[enc/utf_16le.c]
[enc/utf_32be.c]
[enc/utf_32le.c]
[enc/utf_8.c]
[enc/windows_1251.c]
[enc/windows_31j.c]
Onigmo (Oniguruma-mod) LICENSE
>>>
Copyright (c) 2002-2009:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
Copyright (c) 2011-2014:: K.Takata <kentkt AT csc DOT jp>
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.
Oniguruma LICENSE
>>>
Copyright (c) 2002-2009:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
* https://github.com/k-takata/Onigmo/
* https://github.com/kkos/oniguruma
* https://svnweb.freebsd.org/ports/head/devel/oniguruma/
When this software is partly used or it is distributed with Ruby,
this of Ruby follows the license of Ruby.
[enc/windows_1250.c]
[enc/windows_1252.c]
>>>
Copyright (c) 2006-2007:: Byte <byte AT mail DOT kna DOT ru>
K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
[enc/cesu_8.c]
[enc/windows_1253.c]
[enc/windows_1254.c]
[enc/windows_1257.c]
>>>
Copyright (c) 2002-2007:: K.Kosako <sndgk393 AT ybb DOT ne DOT jp>
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.
[enc/trans/GB/GB12345%UCS.src]
[enc/trans/GB/UCS%GB12345.src]
[enc/trans/GB/GB2312%UCS.src]
[enc/trans/GB/UCS%GB2312.src]
These files have this explanatory texts.
>>>
This mapping data was created from files provided by Unicode, Inc.
(The Unicode Consortium). The files were used to create a product supporting
Unicode, as explicitly permitted in the files' copyright notices.
Please note that Unicode, Inc. never made any claims as to fitness of these
files for any particular purpose, and has ceased to publish the files many
years ago.
[enc/trans/JIS/JISX0201-KANA%UCS.src]
[enc/trans/JIS/JISX0208\@1990%UCS.src]
[enc/trans/JIS/JISX0212%UCS.src]
[enc/trans/JIS/UCS%JISX0201-KANA.src]
[enc/trans/JIS/UCS%JISX0208@1990.src]
[enc/trans/JIS/UCS%JISX0212.src]
These files are copyrighted as the following.
>>>
© 2015 Unicode®, Inc.
For terms of use, see http://www.unicode.org/terms_of_use.html
[enc/trans/JIS/JISX0213-1%UCS@BMP.src]
[enc/trans/JIS/JISX0213-1%UCS@SIP.src]
[enc/trans/JIS/JISX0213-2%UCS@BMP.src]
[enc/trans/JIS/JISX0213-2%UCS@SIP.src]
These files are copyrighted as the following.
>>>
Copyright (C) 2001:: earthian@tama.or.jp, All Rights Reserved.
Copyright (C) 2001:: I'O, All Rights Reserved.
Copyright (C) 2006:: Project X0213, All Rights Reserved.
You can use, modify, distribute this table freely.
[enc/trans/JIS/UCS@BMP%JISX0213-1.src]
[enc/trans/JIS/UCS@BMP%JISX0213-2.src]
[enc/trans/JIS/UCS@SIP%JISX0213-1.src]
[enc/trans/JIS/UCS@SIP%JISX0213-2.src]
These files are copyrighted as the following.
>>>
Copyright (C) 2001:: earthian@tama.or.jp, All Rights Reserved.
Copyright (C) 2001:: I'O, All Rights Reserved.
You can use, modify, distribute this table freely.
[enc/trans/ucm/glibc-BIG5-2.3.3.ucm]
[enc/trans/ucm/glibc-BIG5HKSCS-2.3.3.ucm]
>>>
Copyright (C) 2001-2005:: International Business Machines
Corporation and others. All Rights Reserved.
[enc/trans/ucm/windows-950-2000.ucm]
[enc/trans/ucm/windows-950_hkscs-2001.ucm]
>>>
Copyright (C) 2001-2002:: International Business Machines
Corporation and others. All Rights Reserved.
[configure]
This file is free software.
>>>
Copyright (C) 1992-1996, 1998-2012:: Free Software Foundation, Inc.
This configure script is free software; the Free Software Foundation
gives unlimited permission to copy, distribute and modify it.
[tool/config.guess]
[tool/config.sub]
As long as you distribute these files with the file configure, they
are covered under the Ruby's license.
>>>
Copyright 1992-2018:: Free Software Foundation, Inc.
This file is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, see <https://www.gnu.org/licenses/>.
As a special exception to the GNU General Public License, if you
distribute this file as part of a program that contains a
configuration script generated by Autoconf, you may include it under
the same distribution terms that you use for the rest of that
program. This Exception is an additional permission under section 7
of the GNU General Public License, version 3 ("GPLv3").
[tool/lib/test/*]
[tool/lib/core_assertions.rb]
Some of methods on these files are based on MiniTest 4. MiniTest 4 is
distributed under the MIT License.
>>>
Copyright (c) Ryan Davis, seattle.rb
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[parse.c]
[parse.h]
These files are licensed under the GPL, but are incorporated into Ruby and
redistributed under the terms of the Ruby license, as permitted by the
exception to the GPL below.
>>>
Copyright (C) 1984, 1989-1990, 2000-2015, 2018:: Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
As a special exception, you may create a larger work that contains
part or all of the Bison parser skeleton and distribute that work
under terms of your choice, so long as that work isn't itself a
parser generator using the skeleton or a modified version thereof
as a parser skeleton. Alternatively, if you modify or redistribute
the parser skeleton itself, you may (at your option) remove this
special exception, which will cause the skeleton and the resulting
Bison output files to be licensed under the GNU General Public
License without this special exception.
This special exception was added by the Free Software Foundation in
version 2.2 of Bison.
[missing/dtoa.c]
This file is under these licenses.
>>>
Copyright (c) 1991, 2000, 2001:: by Lucent Technologies.
Permission to use, copy, modify, and distribute this software for any
purpose without fee is hereby granted, provided that this entire notice
is included in all copies of any software which is or includes a copy
or modification of this software and in all copies of the supporting
documentation for such software.
THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
WARRANTY. IN PARTICULAR, NEITHER THE AUTHOR NOR LUCENT MAKES ANY
REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY
OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.
>>>
Copyright (c) 2004-2008:: David Schultz <das@FreeBSD.ORG>
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.
[win32/win32.c]
[include/ruby/win32.h]
You can apply the Artistic License to these files. (or GPL,
alternatively)
>>>
Copyright (c) 1993:: Intergraph Corporation
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the perl README file.
[missing/mt19937.c]
This file is under the new-style BSD license.
>>>
A C-program for MT19937, with initialization improved 2002/2/10.::
Coded by Takuji Nishimura and Makoto Matsumoto.
This is a faster version by taking Shawn Cokus's optimization,
Matthe Bellew's simplification, Isaku Wada's real version.
Before using, initialize the state by using init_genrand(seed)
or init_by_array(init_key, key_length).
Copyright (C) 1997 - 2002:: Makoto Matsumoto and Takuji Nishimura,
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.
3. The names of its contributors may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
Any feedback is very welcome.
http://www.math.keio.ac.jp/matumoto/emt.html
email: matumoto@math.keio.ac.jp
The Wayback Machine url: http://web.archive.org/web/19990429082237/http://www.math.keio.ac.jp/matumoto/emt.html
[missing/procstat_vm.c]
This file is under the new-style BSD license.
>>>
Copyright (c) 2007:: Robert N. M. Watson
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.
$FreeBSD: head/usr.bin/procstat/procstat_vm.c 261780 2014-02-11 21:57:37Z jhb $
[vsnprintf.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright (c) 1990, 1993::
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Chris Torek.
[st.c]
[strftime.c]
[include/ruby/st.h]
[missing/acosh.c]
[missing/alloca.c]
[missing/erf.c]
[missing/hypot.c]
[missing/lgamma_r.c]
[missing/memcmp.c]
[missing/memmove.c]
[missing/strchr.c]
[missing/strerror.c]
[missing/strstr.c]
[missing/tgamma.c]
[ext/date/date_strftime.c]
[ext/digest/sha1/sha1.c]
[ext/digest/sha1/sha1.h]
These files are all under public domain.
[missing/crypt.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright (c) 1989, 1993::
The Regents of the University of California. All rights reserved.
This code is derived from software contributed to Berkeley by
Tom Truscott.
[missing/setproctitle.c]
This file is under the {old-style BSD license}[rdoc-label:label-Old-style+BSD+license].
>>>
Copyright 2003:: Damien Miller
Copyright (c) 1983, 1995-1997:: Eric P. Allman
Copyright (c) 1988, 1993::
The Regents of the University of California. All rights reserved.
[missing/strlcat.c]
[missing/strlcpy.c]
These files are under an ISC-style license.
>>>
Copyright (c) 1998, 2015:: Todd C. Miller <Todd.Miller@courtesan.com>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
[missing/langinfo.c]
This file is from http://www.cl.cam.ac.uk/~mgk25/ucs/langinfo.c.
Ruby uses a modified version. The file contains the following
author/copyright notice:
>>>
Markus.Kuhn@cl.cam.ac.uk -- 2002-03-11::
Permission to use, copy, modify, and distribute this software
for any purpose and without fee is hereby granted. The author
disclaims all warranties with regard to this software.
[ext/digest/md5/md5.c]
[ext/digest/md5/md5.h]
These files are under the following license. Ruby uses modified
versions of them.
>>>
Copyright (C) 1999, 2000:: Aladdin Enterprises. All rights reserved.
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
L. Peter Deutsch
ghost@aladdin.com
[ext/digest/rmd160/rmd160.c]
[ext/digest/rmd160/rmd160.h]
These files have the following copyright information, and by the
author we are allowed to use it under the new-style BSD license.
>>>
AUTHOR:: Antoon Bosselaers, ESAT-COSIC
(Arranged for libc by Todd C. Miller)
DATE:: 1 March 1996
Copyright (c):: Katholieke Universiteit Leuven
1996, All Rights Reserved
[ext/digest/sha2/sha2.c]
[ext/digest/sha2/sha2.h]
These files are under the new-style BSD license.
>>>
Copyright 2000:: Aaron D. Gifford. 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.
3. Neither the name of the copyright holder nor the names of contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) AND CONTRIBUTOR(S) ``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(S) OR CONTRIBUTOR(S) 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.
[ext/json/generator/generator.c]
The file contains the following copyright notice.
>>>
Copyright 2001-2004:: Unicode, Inc.
Disclaimer::
This source code is provided as is by Unicode, Inc. No claims are
made as to fitness for any particular purpose. No warranties of any
kind are expressed or implied. The recipient agrees to determine
applicability of information provided. If this file has been
purchased on magnetic or optical media from Unicode, Inc., the
sole remedy for any claim will be exchange of defective media
within 90 days of receipt.
Limitations on Rights to Redistribute This Code::
Unicode, Inc. hereby grants the right to freely use the information
supplied in this file in the creation of products supporting the
Unicode Standard, and to make copies of this file in any form
for internal or external distribution as long as this notice
remains attached.
[ext/nkf/nkf-utf8/config.h]
[ext/nkf/nkf-utf8/nkf.c]
[ext/nkf/nkf-utf8/utf8tbl.c]
These files are under the following license. So to speak, it is
copyrighted semi-public-domain software.
>>>
Copyright (C) 1987:: Fujitsu LTD. (Itaru ICHIKAWA)
Everyone is permitted to do anything on this program
including copying, modifying, improving,
as long as you don't try to pretend that you wrote it.
i.e., the above copyright notice has to appear in all copies.
Binary distribution requires original version messages.
You don't have to ask before copying, redistribution or publishing.
THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE.
[ext/psych]
[test/psych]
The files under these directories are under the following license.
>>>
Copyright 2009:: Aaron Patterson, et al.
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[ext/pty/pty.c]
>>>
C) Copyright 1998:: by Akinori Ito.
This software may be redistributed freely for this purpose, in full
or in part, provided that this entire copyright notice is included
on any copies of this software and applications and derivations thereof.
This software is provided on an "as is" basis, without warranty of any
kind, either expressed or implied, as to any matter including, but not
limited to warranty of fitness of purpose, or merchantability, or
results obtained from use of this software.
[ext/socket/addrinfo.h]
[ext/socket/getaddrinfo.c]
[ext/socket/getnameinfo.c]
These files are under the new-style BSD license.
>>>
Copyright (C) 1995, 1996, 1997, 1998, and 1999:: WIDE Project.
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.
3. Neither the name of the project nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE PROJECT 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 PROJECT 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.
[ext/win32ole/win32ole.c]
You can apply the Artistic License to this file. (or GPL,
alternatively)
>>>
(c) 1995:: Microsoft Corporation. All rights reserved.
Developed by ActiveWare Internet Corp., http://www.ActiveWare.com
Other modifications Copyright (c) 1997, 1998:: by Gurusamy Sarathy
<gsar@umich.edu> and Jan Dubois <jan.dubois@ibm.net>
You may distribute under the terms of either the GNU General Public
License or the Artistic License, as specified in the README file
of the Perl distribution.
The Wayback Machine url: http://web.archive.org/web/19970607104352/http://www.activeware.com:80/
[lib/rdoc/generator/template/darkfish/css/fonts.css]
This file is licensed under the {SIL Open Font License}[http://scripts.sil.org/OFL].
[spec/mspec]
[spec/ruby]
The files under these directories are under the following license.
>>>
Copyright (c) 2008:: Engine Yard, Inc. All rights reserved.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[lib/rubygems.rb]
[lib/rubygems]
[test/rubygems]
RubyGems is under the following license.
>>>
RubyGems is copyrighted free software by Chad Fowler, Rich Kilmer, Jim
Weirich and others. You can redistribute it and/or modify it under
either the terms of the {MIT license}[rdoc-label:label-MIT+License], 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 executables 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 executable
form, provided that you do at least ONE of the following:
a. distribute the executables 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 executables 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).
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.
[lib/bundler]
[lib/bundler.rb]
[spec/bundler]
Bundler is under the following license.
>>>
Portions copyright (c) 2010:: Andre Arko
Portions copyright (c) 2009:: Engine Yard
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/thor]
Thor is under the following license.
>>>
Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
{MIT License}[rdoc-label:label-MIT+License]
[lib/rubygems/resolver/molinillo]
molinillo is under the following license.
>>>
Copyright (c) 2014 Samuel E. Giddins segiddins@segiddins.me
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/pub_grub]
pub_grub is under the following license.
>>>
Copyright (c) 2018 John Hawthorn
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/connection_pool]
connection_pool is under the following license.
>>>
Copyright (c) 2011 Mike Perham
{MIT License}[rdoc-label:label-MIT+License]
[lib/bundler/vendor/net-http-persistent]
net-http-persistent is under the following license.
>>>
Copyright (c) Eric Hodel, Aaron Patterson
{MIT License}[rdoc-label:label-MIT+License]
[lib/did_you_mean]
[lib/did_you_mean.rb]
[test/did_you_mean]
did_you_mean is under the following license.
>>>
Copyright (c) 2014-2016 Yuki Nishijima
{MIT License}[rdoc-label:label-MIT+License]
[lib/error_highlight]
[lib/error_highlight.rb]
[test/error_highlight]
error_highlight is under the following license.
>>>
Copyright (c) 2021 Yusuke Endoh
{MIT License}[rdoc-label:label-MIT+License]
[benchmark/so_ackermann.rb]
[benchmark/so_array.rb]
[benchmark/so_binary_trees.rb]
[benchmark/so_concatenate.rb]
[benchmark/so_count_words.yml]
[benchmark/so_exception.rb]
[benchmark/so_fannkuch.rb]
[benchmark/so_fasta.rb]
[benchmark/so_k_nucleotide.yml]
[benchmark/so_lists.rb]
[benchmark/so_mandelbrot.rb]
[benchmark/so_matrix.rb]
[benchmark/so_meteor_contest.rb]
[benchmark/so_nbody.rb]
[benchmark/so_nested_loop.rb]
[benchmark/so_nsieve.rb]
[benchmark/so_nsieve_bits.rb]
[benchmark/so_object.rb]
[benchmark/so_partial_sums.rb]
[benchmark/so_pidigits.rb]
[benchmark/so_random.rb]
[benchmark/so_reverse_complement.yml]
[benchmark/so_sieve.rb]
[benchmark/so_spectralnorm.rb]
These files are very old copy of then-called "The Great Computer Language
Shootout". LEGAL SITUATION OF THESE FILES ARE UNCLEAR because the original
site has been lost. Upstream diverged to delete several benchmarks listed
above.
== MIT License
>>>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
== Old-style BSD license
>>>
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.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
IMPORTANT NOTE::
From ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change
paragraph 3 above is now null and void.
share/licenses/alt-ruby33-devel/GPL 0000644 00000043254 15173517740 0013044 0 ustar 00 GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
share/systemtap/tapset/libruby.so.3.3.stp 0000644 00000020726 15173517740 0014342 0 ustar 00 /* SystemTap tapset to make it easier to trace Ruby 2.0
*
* All probes provided by Ruby can be listed using following command
* (the path to the library must be adjuste appropriately):
*
* stap -L 'process("/opt/alt/ruby33/lib*\/libruby.so.3.3").mark("*")'
*/
/**
* probe ruby.array.create - Allocation of new array.
*
* @size: Number of elements (an int)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.array.create =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("array__create")
{
size = $arg1
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.cmethod.entry - Fired just before a method implemented in C is entered.
*
* @classname: Name of the class (string)
* @methodname: The method about bo be executed (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.cmethod.entry =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("cmethod__entry")
{
classname = user_string($arg1)
methodname = user_string($arg2)
file = user_string($arg3)
line = $arg4
}
/**
* probe ruby.cmethod.return - Fired just after a method implemented in C has returned.
*
* @classname: Name of the class (string)
* @methodname: The executed method (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.cmethod.return =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("cmethod__return")
{
classname = user_string($arg1)
methodname = user_string($arg2)
file = user_string($arg3)
line = $arg4
}
/**
* probe ruby.find.require.entry - Fired when require starts to search load
* path for suitable file to require.
*
* @requiredfile: The name of the file to be required (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.find.require.entry =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("find__require__entry")
{
requiredfile = user_string($arg1)
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.find.require.return - Fired just after require has finished
* search of load path for suitable file to require.
*
* @requiredfile: The name of the file to be required (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.find.require.return =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("find__require__return")
{
requiredfile = user_string($arg1)
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.gc.mark.begin - Fired when a GC mark phase is about to start.
*
* It takes no arguments.
*/
probe ruby.gc.mark.begin =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("gc__mark__begin")
{
}
/**
* probe ruby.gc.mark.end - Fired when a GC mark phase has ended.
*
* It takes no arguments.
*/
probe ruby.gc.mark.end =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("gc__mark__end")
{
}
/**
* probe ruby.gc.sweep.begin - Fired when a GC sweep phase is about to start.
*
* It takes no arguments.
*/
probe ruby.gc.sweep.begin =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("gc__sweep__begin")
{
}
/**
* probe ruby.gc.sweep.end - Fired when a GC sweep phase has ended.
*
* It takes no arguments.
*/
probe ruby.gc.sweep.end =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("gc__sweep__end")
{
}
/**
* probe ruby.hash.create - Allocation of new hash.
*
* @size: Number of elements (int)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.hash.create =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("hash__create")
{
size = $arg1
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.load.entry - Fired when calls to "load" are made.
*
* @loadedfile: The name of the file to be loaded (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.load.entry =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("load__entry")
{
loadedfile = user_string($arg1)
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.load.return - Fired just after require has finished
* search of load path for suitable file to require.
*
* @loadedfile: The name of the file that was loaded (string)
*/
probe ruby.load.return =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("load__return")
{
loadedfile = user_string($arg1)
}
/**
* probe ruby.method.entry - Fired just before a method implemented in Ruby is entered.
*
* @classname: Name of the class (string)
* @methodname: The method about bo be executed (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.method.entry =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("method__entry")
{
classname = user_string($arg1)
methodname = user_string($arg2)
file = user_string($arg3)
line = $arg4
}
/**
* probe ruby.method.return - Fired just after a method implemented in Ruby has returned.
*
* @classname: Name of the class (string)
* @methodname: The executed method (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.method.return =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("method__return")
{
classname = user_string($arg1)
methodname = user_string($arg2)
file = user_string($arg3)
line = $arg4
}
/**
* probe ruby.object.create - Allocation of new object.
*
* @classname: Name of the class (string)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.object.create =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("object__create")
{
classname = user_string($arg1)
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.parse.begin - Fired just before a Ruby source file is parsed.
*
* @parsedfile: The name of the file to be parsed (string)
* @parsedline: The line number of beginning of parsing (int)
*/
probe ruby.parse.begin =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("parse__begin")
{
parsedfile = user_string($arg1)
parsedline = $arg2
}
/**
* probe ruby.parse.end - Fired just after a Ruby source file was parsed.
*
* @parsedfile: The name of parsed the file (string)
* @parsedline: The line number of beginning of parsing (int)
*/
probe ruby.parse.end =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("parse__end")
{
parsedfile = user_string($arg1)
parsedline = $arg2
}
/**
* probe ruby.raise - Fired when an exception is raised.
*
* @classname: The class name of the raised exception (string)
* @file: The name of the file where the exception was raised (string)
* @line: The line number in the file where the exception was raised (int)
*/
probe ruby.raise =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("raise")
{
classname = user_string($arg1)
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.require.entry - Fired on calls to rb_require_safe (when a file
* is required).
*
* @requiredfile: The name of the file to be required (string)
* @file: The file that called "require" (string)
* @line: The line number where the call to require was made(int)
*/
probe ruby.require.entry =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("require__entry")
{
requiredfile = user_string($arg1)
file = user_string($arg2)
line = $arg3
}
/**
* probe ruby.require.return - Fired just after require has finished
* search of load path for suitable file to require.
*
* @requiredfile: The file that was required (string)
*/
probe ruby.require.return =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("require__return")
{
requiredfile = user_string($arg1)
}
/**
* probe ruby.string.create - Allocation of new string.
*
* @size: Number of elements (an int)
* @file: The file name where the method is being called (string)
* @line: The line number where the method is being called (int)
*/
probe ruby.string.create =
process("/opt/alt/ruby33/lib*/libruby.so.3.3").mark("string__create")
{
size = $arg1
file = user_string($arg2)
line = $arg3
}
share/gems/cache/rackup-2.1.0.gem 0000644 00000037000 15173517740 0012271 0 ustar 00 metadata.gz 0000444 0000000 0000000 00000001271 14364637605 013455 0 ustar 00wheel wheel 0000000 0000000 � �?�c�W]o�0}��0{�S>�
�,1 �@�eC �Pt��&f�cl��B�۹��ڮe�+K+%���>>>��(���拤�?a� �B�Y,�Ldc���;(�[���<�bG��C�2iO�Ya�8M�P m�����'���=!�С^��s0��l ~n�C�riJ��;+Ѕ��AR >�1��ӣ(�D�G<ME�����߳-�M!��|{ϖ �j��,4��k觫bJ�H��:$��ɓ�>�����K� K|�kM� ���R��(�+�
{!|C}�`��_�����O����(�P�5�B�w'�k"�8G�ر�����e��Ȁ>����*�G�S�RM*� Z�B�d�{�ߍ�#o�4�^�+��s����K�.����m�\
;�qo�MW��J
d�l�l&�� ��mC��^ĕ� ��_gc��� �*�ګ���+<)*�Ӳq �UN�F v���R�C�[�(�/H&�u�I�P��ٓ�N�EՍF 9��z�$� u��E�QF���zM_�|�4��<�����4>�R�F�Y?%M?�ä���,��o��/�2��]snٴ�Un����[;� ��g�D���=�� �| ;Ŷ� � �2�T�9.���U�1����?�t���'N��ɑ��{��&���jl�Ǭ[3�^� �t��~ data.tar.gz 0000444 0000000 0000000 00000026114 14364637605 013376 0 ustar 00wheel wheel 0000000 0000000 � �?�c�}�v7�`�.��2!�Pԇ�/ �6%�mIԐ� G��M;jv���9�߾��9�o�>��}��$[U ������q�L�4K�( ��P�*T�lwͷ���⛯�������o��O���ƃ�o6��?�zx���u�۸�7l��?�'
B�T.g�;��T� �?��ʽ�(��F� �{��h�,����}��0}�=:v�}�i�Џx����l�}�X�}�Y��Xs�\G�R�~7�}�_p��K���#��y[�Y�ā��G_�� nm����o=z�y��_��+�� n|�"w�}�8;� =�n� ��-��}6 �ls}ss��_g�%�[�;��8�5�ҥ廬���� ������V��K��c���P�DB��ҧ�GH ��+��7� N�K�Mu�͚�Ts%�NJw��� a��F��O�Ç[w����� ܒ���/Vp��e/:�Ww�o���*��� �R����Gw����,��w�B�݅ P؞[����K>���y�f��])���g��� �����������9Z�[a�KM<���=���w2������7�j���v�N4�S
���� �l�#v_u�Z1TD��,��sf���I� l��(������b�ȭΗ�bQ{�� k~��y�D�尙̠��8[X�+��r4�����=�6���>�| [�f%m�e����La��>_�� �ș �,1��� z�Pl�@�
���)��L��"h��#H�@���aC�y�O+@2&��]I���7,��bb���\ ��i�jkr�vH���x�� �m�wK(�� ���3 V�u�M-'�
GT��8<����7 �sU� O��*
��:9%J�nlv�wc�ӝ|���_��@��8��Jھ�qk+�s�z>oh��GW��4F0k�� �: ��7ɞ�E* /�#$� Y⛴P��$I�l�/0�&�D�Ϛ�D�m��
�Uc1@���f��:�;h�`���C�=N�$o*��~���� ��} ��]]Ds '�I
�֘���TcᓰҚ�ܐ5�6w�Aނ��~2�² k$Ef��g��� ��ǖ�[ˏ̋��,e �J; �1&�G�h��Pl�d�5d=ƞ��ѓ
�Rg�2�� ���2�ٔ��\��RU�7$�Ԭ�4�`d�[��x��K�l̵��eM��UK����~Жc�:Ͳk°����H��l�"g�Vp��D��>�d+��1���n�v�(��Ê�0�hd�>@��ѻs)' G�s���mK�:���
&&rP�A�ǐ�D
*�+l�[n ��j3&Y�X1���)��M�smPp � �v8�B]6�.�G6�jRN��9E! ~��3m�煂� n��;'�\��@3Ō/=~�U��W�_�X~R2 Y��� �^�)�vGz9���'v�O&�O1����� V���.��`F�7,������Y��k;i��t��Z�}f_��/ Vyc�]�c�R�U^���
�� ��R��M���6�/�s�m
AD�V+% ��� e�?�y_��o��z�{�����_��˱y�R@�M�c҆��\�.*`��mVg�/L� �ѿ
�6F� ��0��ݠ�f �i;����P���������`p<��
�G��A���`�\�!O�����+4E�eک�%P�fVmD� l�UM�=�st�v�ހ㮧�ڽ^��7���g������a[����< u���F��!��yu r��ƞ��, A�5�_Ɏ^3I��އa�� �BK �` �� � �[�} ��6���q F ���h ��@#�
mԮ���PVM7����
� ������ރI��*.<� z�Y�ʮW �u��VM�f.l/
`O�Q� i������nBPY]hͰg���E�E�E����2T��p:L�ӕ��W��E�7ƮJٿR��*�p�D1W�[�� F�+�� ꈛ=ciN��s�vF��O<��C֥��gWr�i�~:�����}��S����w���?K`����K־ -�%G����U4(:��J�����^�9�b�[��o�^�)�S �4��Q�b�B��A��8�/~�^���{� lE&�pq�U��2�CUo� ���< μ �zz3�mu`3�8 �[�
ݵ�d��m��ꤹc���d[^@}��P�T��5��{�BU�^
[����?��=?z����:�1H��v� MG)���H���%'�AI��S�7\~Y�̕�Ԙ�� �S/<3�k:)cK�;��OT,`>·t�<Ӽ��,�:/,Ǟ %v�� ��ޠ�U�~�f�������ʨ{�# Ԅ sp�u�粪� ��ZYWg˸.���=�>5� G�}u�"2�B<@�ڋ�i�67ih})!_ݨڮ �0���<����,� Z@c)^ �Љ�������yc�� �P(ڕ�B����g϶���-���EH��$Đ�Z� �� �%}��#� �t�η%���H� �x���h���'��Y䞛
-���ӪP3 �O�������F��T����H"�ϸ)Ό��J��`��l%�u�=�{(i.&�`�h��i �^H�6�n�.�5�� =�V���N| ��&6�o�yh
/,?�1���mҌ��.0���Jۜh�n�EIB��dH��0�71�AbP[�"0iP���fR�`P����օ u���k� �A�^d��j���҃�ãIz�G�ᷰ�Y��r
�*F��%z3�YG���Y83�"�C��ĭ�oY��2����OI+���"t�ݟҩ�ͧ/nw +�!�@����X�iGx.;81fZL�!dlo�X��ĂJT�(���yv�O-���"�k����ܮvn���m��숕JX x�:��s�W�N��� �c+�
'"�T��f���qΗu����X�� �tZ䇸SR�
X� xi�� �w��())Ƃ/��6�zϫd�4*���b ف/=t Z�1_��)NE��T�9��D�
!X��eO� `�
j~l���0**��o�@�TC�����yk �~�:�Yh�Y�W����Bo�9�tQB�ˢřVNM�A��BjwGO:��q�,�o�>P�YR���2�.�;��T3��$̽��*�(����7v�s�,WԖ�My �� XCV��
<2�p��E�)�"��� &��>C�Zx�4}�v��E�B}��(5�@TT+�0
N�eWgId�}�{��9�����n�_���|�qw�����f�O��nq�' �2�}-dv%/��Ōq�`� {B��ŁX�Jʆ�/J� GY*�'ȵ� �f��N ؔA{���2���v�{�l �t�<�u��5^�og����/�����_�O��'�._�� �o��ww���G?��O��[�?����������𧋳����'?X���_��\���7�{[���G� \���~�<�\ ����
g��a���z�j�錬7����q ��X<8�\�t ��5��y��� 8���Ï�u��`���a{�q��� o�n���e���vAYhD�(U-Ͽ/�N�O�^s@��� �Lj�`��^�% R�xk�<u�E9��Nܘ1!��J�O���sl�a�o�����Y��}�xƄ��$�3 LV0t����
�֦�d�aX�! ��Q�4�C�?�
�cۋ�{O���r=� ���Ӆ�%
Pܞ��Wy�a�]Y����*�'�zVVf����^0���T]�` ,�/�;?0��OH;�ˑuO6��� ��߃�d�CXrk�p� ��g �e�Wuէ��* mK�R Þ<�A_+�050>_�'b�3��Ӱ���� ԅh�h��_F�VM�G���p�A��R�+_�b �-�jP��_�ˮ��D�`�Гl��6���Cȱo���"�����J��?�*����ͽ���:�oc�|�O,�y�h� ��_zv
�A��*��+��Wnͩ���]-I�4��ڷ�8Q����A{8�����r��Mֽ�nU�ͼ�!�
P��C�k /�8a��&��,�b;n��W @+�#6#���ju�G�M�d� �5cTw�������7�o>J���N����"\X>���+���B� 2v�(���潏ͅ��s��wv�WH��P(�Ҍh3��P3߅|�@A�Y �/U~]A\�-�#2&�0L��[O��^\Ԑ������9S��W\ �^ �a��1=��-������� �7B��1�\�(�
�3�dB|�� ��=�G4��G���N˥t�̬��M�B���u�4ZA�� ��tut�U�'�����r�A稍����!�B��؛�r-�̓.����l�=>h�k w:G{`�`�@¨%�D쪔��D`9�� � x��� -O�3�Vŗ��w�k ��5D��5�|��xRK ����)��+ �]���=@�9��.��g�طaq�X�ֽ���x��q��tʐ����n�Jn?� uDG��G�N��t���K��A��Gn#V�[K���0�{t���0�� ? ��3s�TcDe��tZS�
reIˣY6\c����9���Z�����: ����̧�=���#rg�&�>��E����e�kѿ-�k��YΥ�H�@n l�m�`����^������l<���%8�5��y�����הKc z ��[V
g���W�T�\QA2�Q�%�O B�:Z�I ��a�h ��Y�Ex��F�*�b!�X`��#�ÿ��Q�W��E]���m� 7w�]�� ��'��ZoۧX�=�K`� ��J�u��$A�& � *�`��e`�}�~�V5���
B��'��p ��e�\4^� ���[��ttJ���6X���\g �{S)>"���%�<?^)�ru/0^��� ����^����j�ar��N�+Co�ܞ�<-z���v| �%~1a�K3<s��M<�ä ����u��dV�FE��m!������A���ؒk���m2�SQCH Kv�' �
���j
B� �;{�6��@���-�]�&K��{lǾ!%r�=��3���~�u�F�����k-�_Ɣc�.�mN��B��8ܸ��y��#�#��k1����Z� ����Bl;�=~�`��0o��)(�D����;ey�n�P�4���\�KR찻Gx K��eu���\Z����yp 2Z�/�' �� x=���v�� �n��_��U�K�,��]�1�) ��W�k ��`E"�J~p=}n�Nw� �v�C�v��3b��r?��x( �� ��� ��Bڋ��[i?bpo�� �t��o\
�Ui�Ƙ��|�����Y�Y �[�vz^�����J�Ն0q��� � t0�L@�yC�Y+�F��h�i���,��V
��)�'y�ȩ��< .�����̟�$�q�V��i)�� ��oѧuF��O���t 0
u.��b�:Sv`,�웉p UHe<h�fre���
�ɉ%Qɤx0�ܓp�DM����Kn���ߪ��~Aղv�7k�]o̭p<{^�ե[a6�{P�T H��C ���:��ZW �Lg�"I@7Ӧ�2c�]����
��Lob�m�N�")�Ĕ�2�E�L77���a��X�_�NUS�M�"�y/� ���[��z~ 9��UW>gLq퀖c媆;�ܟ�ͥZȬ�rq�>:"0S���*����}�(e��<ª5D`��
{I��z�+[����ƄN!����(�G[�K�)���ʚ��
?���V��E��=Dd�X���
E?�����R$��[es��T��7k��b�Us��UE2[�eɸ�Β9V�1���DM匯�\�� ���U��=u7�
E+ӭ�g*@�"V 7rE ߮���Pr�؏\����
잎�.=ߙTN��48�u�?%�J�'Kj�/# B?&�u�r�6��Z" C�1�$�̄b� �ҕ%s��B��x�Za��C賦bV��<�ex%�^� ��諑�K^�?JX�H��}�ɝ�V�:�%-�7F�2��������S�N�4"��`��4h"��1�T�e4l4�Pk����'��+s{����t��X�>���Iq�
��F��3�H[�jS_�lU�jQ�Bx@n�:3}�u"3�;3-, o�m �z.�.��з�qjp 撒�$�6�y0u�H�K5a��A!ŵ{E�����M��R8�M�A�:k0�$=��V�hl�j����X8[�u�i�bp�:�UA
���
a����q�lI�ٶp�"ȴ?�� ���v���v�֖Z��_o14�i�ZS���@���:Sk�K�@�y��F� ��*����p�搓gO[���+ix!���}
��c@V�֪�*
<d /6�Af��k�\:�t��
G�C!^ѩJ�P^�ڨ��T���oW/���m�D�d"�� ݓ���<��*��q�m��6Z��-�?�z�">���.� ���Jlu��!�g�B Bs]��� k�xv1��v� GI���ְvP�����5yQ-i|�F-���4�Ed�������&
�={�Pʹ��i�Z�����j� �:� `��� Zd;�H
2���X?��S�J1�ȋt*��Pѵ~I�TpU��j�e}4Ѥ{ ���Ο�ԛի*,j�c��0�~8Wɽ��\$<�5��3�Nu_���?�]o λ �� �Z�� ]�O�$QI�;��Mɤ,��MX��k�5Y9��=�C��B/-P<�κ�� �� ������@� OkeM��hq�"� �T�u�
� ���1q���uuk{
��آV����&Ҧ�s���r�ᄚi�X���Mմ$hG�aZ���Kk �0�^�� ��_����N�Ş��ͭL��xcdɘ9�P�S�Q��c=[} en�O�A��X��+�a*��9�֞��$#ȟ���u�9̕���D�^J��*3�k�-� %a����%(�!�h+(�Q�8��Zc] ���*��
f�4�~�*�d�� 3 �Zr ���+5��ܛ���H�t�-�be�H�E,2^�h� ����^�-��|b�������^F�(��0�J� C�rQ+1�V��2SLD܊R녶T����&Ƴ�� �C��c�a��U�N�z�7�^�1N۳D��DY CR7�y�AK:#R���`T.����@ >6�Uj�Z�,6��"u'�� ��
P FnU����t~L���ra�J���O��N��U�D@�n?UYsb_� ��3���C�l �h����U�Q��ﮐg��ٌ��:���K7[��-�-s���L_�8anM �a�� �@���3�� L��&�A�G�1�PO|��ў_�6� �5�d �K���5���j�i�a�,�y1�4�R��BB�r^��� ?��:W�)5n5�5 y�d�8�!+9d�����n���n5gؓ�H�� �3����͌r ÑB��
�kݻ���y��I+��ԧQ�L/�lAJ�5�{���|AΣ��閠�֖��P����3gCt%���0�
���B] *%�iQ L#D^a{�� >*F�B��9�k��a\!�b�+��t�p�_a��ؼ4�y ���=��m���8�Ջ GnN(K�hdd����Z>Օ9=r)�a>t�
���
�kf�M�ؓ\�Nխ�a�&U�ŧ �ok"� .�����JW ��*cDr�z����q���}��d�GKЉ"4sfu�(L�w��^���� C�Җ�����<Bm��j(� �u��%w�䑂��AC�[� >��^I�W���̠��W�� }�.��j�[�%~n��{�=��u�>���;��^[���Y�Z�*뻦Q\�n+�x�w>�|85QH�H�s�]h����ӓ�*Е�<{�n��B��$�����*�gA��� X)H��S�$����>���6[/e&��[�#����f�@��jE)�`����S�ɭ~�� ��g���pL �4Ć�ҽQn��t�����!��ʋ8_մ�D`��
���w�������������3��x�'�����Z�$��:�U
�6 ��٠�`P�e����[� S�c��0�B��ޣ�[z�Gh�� t@��>:�;�(�f �5�����V��Y}������O���Τ�q[��#۵�%���3����x8�AQ�G`��Fv8ԖT��U Pr8��Q��/�^��L�� �����P.�m�Cy����K��2 jk�9_�U� 槉Z���� y�*��� *�+��R<�: m���0g��<G8��C��L!I?���?*��E��*���ԛ��3bd��'��a�`'������:9�b
&��� 8��"�H��_�6�Zd���%}�����gثU-2���S6��� ~��� ���A�����2Ŧ��ɖ|�=S��:��
�k(ꋿe+�n�KF ��g�Ё��%�7XX$��\ � ��'u�Dܛ��1/������U��(ƥ���L\j� q1��� ԛƺ�rŕ.g9�(s�`F4I��;�`�>y&� �=�&-�
1�iFߠ�;Z�0�8�������(��z��XƑ �+kw_J�I
��9������˾ad�?�&�Hv!�vSIU���ż�*J~Zֿ�s��r�NE�$,zqV1Q�#�p#^N/�lW���>7.D�ko*��dY�tU���@Ԕ���d �bkI+Ri�T%�5�4��J\[����uqSK���FxSG���<L��5@�����L�-�h6w:G�އ��ww`�a�&�vbv��H
pA3�#� �\%�(�ad��$ړ@���0�,����l�c
�93�[a 5�
�? �z���9��sS
�� ����"��� �h`r X� P���&z ���1��O`ܩ�( E
�S.eЅ��T�ɁhU��M�)��`F����'�{��Nd b��j�VB#}/����u9%%�) �Jb]�NS���Q��u�6���B �[��Hk�.<[�{�x�`H v��~��W����� ��9x����!zj�a\������%o�o%(�c�����,�� �}����M<s�kKy 1u>�J������P J�0�Y9�� S�0t����k��eW���<�����w��D�p����BT���,�u����}/
Wϋµ��T�73l.�ݩO�{v�o\�`��R�^C|h\5��ii%�
a恧0�I�=),�NW٠��T �_e�ƶ/�� qЊ��s�|]�iM���"n�}��'�3^'&�a��Яm�Ь��}&�N���n r1�A".�d-�Y4{��0��䵹�%����ƒs� �w �5�p$�D<�>YO�W9}/אD2N+E<�T)W�12M'�
q쒆+�qt(��K,�����5
ʫD�������H2S�Z�fH{� I)}�g�6��"�#�64r�a��Ex3wbS��ͽ-s���9��7����뛛[��-(�;�����]���t�0��fc��^��8��y�O�^ 7��ͭ�)�����G��ͥ���돀�ן/ pkƎxtn��w��` ء�W[������}�[�m�, t��)���@�ƺh��Y.۱B�]g�g������_q��ƣX;��"��^0�,v�y�>�&{c���l�� ����u r�#�>���z9`8�֚�
��y�`e{{ �H�� �l���AW���"�Y~�v<?�T��7é�] ��Z�~4'�#���{���y�Nra �t��} ��"� O����A/�Q��#�&�R߭�5�EA`��^
|~��{��9/k��o��c�^Z�@���� g���s����,��u��؛��^�;�`�� �� Dg��A�n�ΛL
�x�q��@�Ȳ����_´�ܺE @5�)�AH� ���g�o��ʖ�K�bL^�E{օ=a�ܱ ��YS.���x�o���E���凍߀�� ����'�?�� � b<s�a��Lͽ0,��< ��/r�N
�LA �� zE@���d!���8!���bfs��?��)zc}��ۇvr�H�h�^�<� ��X!U�� ��{�gE0 @��K��ؾ
��� �u��dE䉾p
���z�Z�Bo
�� �l[�\�����jg �ܴ� ��� ����w�Z�����~��o>�" < �,u�P � X�̑�
Hl1�ޙB��1�O���r� �3D'���2�<Ä���~���� [�+�H�M�Kq ����7���2�$ I���Y�/k�ku���rJ2��*��8� �H�#�VՇ�� .{ 7=� (A��u �u�*����Ӱ�DӬ�&66=�0�#����Qx�fh է-7�5�N�`@/ $h(ID7�/g���JS��l��
��Q��%]�S��6�\�!h�Je�� ���� �*P���dVeQ0��KU�!�8!K�O�%��-��_P�j�`g�۬�}9x��Y����u��{����s���w�ݷ�����d���M�h���? ��>�J���N�u�v�b�o�����5w@w�F]� ʦ:�>6v�����ck�s�|��^vG���n���q�7��=h�����q�߆�٣��K�R��6�Wx���0�j�up�]�Zo� ��v�� z�W����L�}���Z;m� j���9����a�U�ju��^ �v�~_a-�ow�f9 ?�ӃGLy��U�w��:k�� �+���=����P�K�@���hI͌|~�o�
��v� ��ce �n� |� <��]�&�����ol�}�����a\�8��L�'6(> ��1�*l_$�ZUq���sD�ɽ��$7�- ��J��n������P}M|�O�Ec��v�`m ;��Ț��FpqV���E�n�\��=��˗VVXmD�!�`� ?��o��S n?�,�:�R���f�0a} �r�}�o�dF�҅yϜ��4�қ��J:��|\���c����X˅M��H�B�ߤ�yH>6i��@*^�+��]oNW�e��C!+�J�o��1�6�a��P�\Ĉ�@��X�#̀�P�*��͗�.�\�p k��}l� ���h�*T��(Y��ҚL@� e�
V߂��Q0Sچ�� ��<%!��yL�q �Ԫ����(�O�Ǒ���_q�������6��� �ߗ+� { ��`n�� N�k�7��2����:)����� ������� �� ZC
� � checksums.yaml.gz 0000444 0000000 0000000 00000000450 14364637605 014621 0 ustar 00wheel wheel 0000000 0000000 � �?�ce�=V@���"�o�[���� �Z�Ryz7)� �cfn����
e�^�ׯ�NJ{�|��^c$A+���4��2�a��� 0�h����n)�rm�V��{|?y3=}�kMG�^���Th�LF�W����]����f��)��|"D�e�YK ��ljZu-i���P��G��d�u�3�q��/j���RF3�m��.�4цaB��Z��oN+9p-^���� �r.qT�m2K�uB���YN3�5�G�S?�`�R��[�I[@8� ��As��*u_~�
��� share/gems/cache/ruby-lsapi-5.6.gem 0000644 00000146000 15173517741 0012747 0 ustar 00 metadata.gz 0000444 0000000 0000000 00000001055 14611460537 013446 0 ustar 00wheel wheel 0000000 0000000 � _a&f�TMo�0��W�^���-KTT�BHpi+�@(r�I2�v�V�����v��U/ H��g�f�ef�,�/�T���*�w���Aa�J���A��/Gd��y�G"?�[����<�b� Ck��19��:/X�?` *
��;���F�f ���V�i� No���J����o����r}��/�����HO^n/��50�i�(*0��Wǐ���9=2Q�p��#p��[�WV��,��
�~��g��
8:w�@K G��7!|D:^N)܁������C��YEҹ�����] !NV���j1������+�Ԏ� �9��"�Ju��m�� [�������@�����\ w?EGmv�݁&q��H2_4�GH���2> �DVn2�N�<�i���jeG Ї0���l6���P�Ћ���������F�C��9 ��S6���?栥+��'��[gS%��L� �`M��Y����'���s��݀�������Ɯ+�u@�4?�O��Π� pO2���� �Ik�r��3�}���/��q�� data.tar.gz 0000444 0000000 0000000 00000135216 14611460537 013373 0 ustar 00wheel wheel 0000000 0000000 � _a&f�{_�Ȳ(��=� f���M 3+��C|� �6�X�\��-�Nl�K�!����oU��/�2��Y��a�`������������� ��� ��j�Z/�?���1��w_�l�G���6��^<����i�ǟ�H3?T�n�`ZRnY�ٹ�!?�i��C�EN�� >eA��qD&qB�������Z�w6vNOk[�V#�?IuId��vrEFq4 � ��g����tZ�]:'�|DA�O��I���$�gi�jÛ���4#�d�� �ȝO��,Ҁw5�� �����)���q8�'��"Q�o��o�DA0�R�� �I<��wat
]�cV|�tH�.�$ O)��B
�wN9�h�3�d�D�k��k�K����A4�a�xK�F7~t P�hgo����wP݆I ͐�~�W� %5 �\� �#MP�����h�G>pD�I��6G �h $��R�N
Y� ( `���1P��#�8z�#��X��4C�(<� ��Ik!N8�X���pN�8r� 7��&c�P�2���"�)�9���4 �̋&�7�l� �����YK��H� ���t���p��q��lt� C��K�ݰ���. �$^�����6�I<���bF�S?��fl�R�
~�q0��8��
L�15�� ���k���!�O'���A�~z/��)�� ���I Ι��wd9 Sʿw�K +V+� ��}��(�APZ �Q$���$�g�]�|V
�П��2�f��`n��s�C6[L��IJy=�lp�&�1š ��'��c G�S^�/�� Uf�M/0Xa�t����m�S���N?@�}l�@� �B0�D�(�8[�ԝ�n�l�jg���n{fA:�~d��f{�v��| '��]�1�� �8��ȸ%�o�] Ĥ�Q�(Pc8��l�^x�o{�G��1~��`��_�V�V3��gI<e�9�?Q��+�� t?��;��5A��{��a�f���]��Lr���dXe�W����ZAu:hlbS! @��4�N�t�pXh+t6E�5��$
k��0H�6�kK�`&£B��6���;?�:&�@�5q��0�h�.
]��ʐ�\�L��CN D�֟.`Mjk�O�0�8��aM'lS]��~��ą���� ��2]�r~O�n�\XA�d�Ce(��0�^c
���rV�a���ޑw|�i9*ea
��I0N�ǀ�="�ߨ���!xcF%)%��Z�r|,�y����9��`Rb�
�4 f��LRm��
�4Lk�$� �!\�n(?��lU�����Ѭ9���B��q81 ����E��l�� !:Q��8 �o2�.��`�� p���o��a��6���w���(Q� �D
�N����V3� ��P�fϕ�,EA �3�ED�Pf �o� �
p1��Ȕ���6����?�&N���+ ���
""Uʤ�E�bNc>W!��:o��Zn�e���Z�H��� -(��+�
�|he-}Fۣʅ:�D���5��
@�
�<�O�E�@t�P�q��������vL�l\pHg�,�y�Ha 1��J��`����4@L�� :9���e�x�2
���)�KB5M���q�0�q&S-�Q��.w>�uO �]�82:!�8UPaΣ�%j4��uѕR�-���X�ζ ���]srB���S���hJ'D�h�`V��`�m����������� �o�� 7�R&U���Y�l����\�����7��~�� :E��K�*�Iҳi�d��K� �8�,��� ��az�'yU1?�a@#��<H�5��TJm^`�tn\]%XUk��8��ȵ��q#���
�/N�.�`� ��s�O�]g ��C��L�"蘪gt�U���F՚�$��g��ßj�7��� {y��b�LX�q��c�b^ 9��9�? '�q��>����b�4�n2�e%�d �r% C��:�M�/S�� 9�
� �i� �aJ?g��$�ak#�.`1�9d�eٜ�o�@�F�\<�ўQ�rF�8h �d��D}��_C+�����m+�@eM��6h$Q�C��4�J���Bahz38� V�����j����jYa���/�����3Vߚ��v�\�o�w�=t��O�A�A�?��
��U�]OA��̫ ���_�W�L$���m�^�S�ѓn����Q<��Q��E#$�7��J� 5Pz���F��vr�m�?�xQ`�o����5�/��_��?��';�4ٙ� �v��hY�V3���;��S��b6.@P�죵v4D��~ I��)~~���� Q��n`� �<m�m k9��3~xB^_%d
�-&(��Z�b�}�� Zux�x�<`��Z
m���O��`ᡃ�M�~�����Ҙ�/^��:��w���� � X��Ik�l���yB������N{��K9����JX����9���;7�l�Y��&�/q2 ?!���g�"����V�_ݳ��q���0!��| �L�Bx��}��� ��Ls���d/��M��\6�0�1ށOh����?��?<7���?�GN�����im & ; ����FXv��ƿ
<����Z�>�i4�jl�F���܂��7�y� ����� ۡ��� ^\ �vNds ��#Z���5�O� v�V��G�gm`�� H-��v ��k�W�?�v��7��O���� ~�k��?;� tD���[������hg:%��Y��b ��~0��~^Q'z"��! ��#uL5���Đ6�_@"�Tk�Gz[�n?�Y��Ղ{C��9���Cz6��j� {�i�@_�*EKG�� f <�
2_���[��ufU��,DG jp�M}FOf�F#�3 M�p� 1nD�A��%5I\8��q�r��9s �x���ډ�+� �&����
1ZY���Y�ژOw}�����
�BC�T����<��G�"e�� �!� �����3��%!0&� Rb��$�C��'��h�d�� &�o�4�ݫ
�dp~<�����|�?��w�="o~#÷]rx~�[�w�vHޞ� �jE:gG�z6��\���Zg 5�hF��7���� �y���]�� @�wΆ��Izg���G���& ��|X;��
���I����c��?| _;oz���o����� �:>��:�� �/O;}rqٿ8 t v�78<���u���uh�t�
��m��T�e��n QW�H�t�i��洋
�N ����!�&�t��N���E�� �]�K��[�� t�~ � � u�uN�k�%�C��~� � d\� {��a���� Q:���{�� 9= Pb]���Qgء
�d��7�� �Y�l��//���4`x���T=����
<�=�@���M���.�����R $� (v8T�A{@�a-�#9랜�N�g�]�=G(��� Uo�z�Y|h�v���я
�6�@��1� ��C�ya�A�� %��[N����N�V�.�D��� �Q��{�վ��0
�T( �� ��a?�[�t��� ��Vo>]��� _���7�5��&Y;\#�k�T'h�Y�j��$}�u�Cܒ6�ؾ?��$��9e%�|� �=����0Rg��z����v�5�N�g'÷y�O���mW|}{>��]�;'�:�[�{��w��+�"dt �s��� ��"�w콃� � � �jFgx�V�~vn%��8Q�\�4 �O���9�,S�J���!�HA�$���N��
�_rj��=�=�ap~��w�"�+�X��Q�o �7-� ���Ӣrm���i���A~F�@JO�g�d�_�RȬ�s �4 3F`~ n�W�̃�2T��Z�Roz'j��RC��:S`B��~|�y�/_D�O���9q%z lk\
�^��$���굡�r~��EP��o�'�3t�����i��5J��z��v`V�~�*���y��z�*��i����!��7���`� ~�0�x?�P�x���&+??��t�9���s�Ϳ��i�G��(�$f/^<{�(��w�9��;���/�����$�p(��u���?�4�� ~4Ay-�� \Ən��μ� A-�Mk�a����mf�(�^��]��gd s�i(X�"b.Ʉ|� ����l�ˠ\xD �E,zT��[���_�gA�����Ìw��X� T�Lz p��(�Ӵ��F=(�)g(�F6 Y�|/��-�l[d��x2���
��(����d�M�|��k�� �h����( �sq���x$L��"lq�9h6��1L�X��Q@lX%�� ��T 9�m�8��� ���{�����\�-�Ѭ}����8%�sܡ^�{�w0
�Iܴ� ���lm�k�� Ӑ�y �����֮�I�.�f�X�� E٥6����֑:�ݐ?��dϜ�6 ��[ ��K6&b<�;���QV :QX�⡣��+GA@���X�#���(Me��j7 ҹ�j�IIW@jt�\�lv�\��9
�y`���1�3� =��Z^]�~�������ix�=�S��^�^<o[�?�?� �� u�\���
�e��*��U�/��_V�B��0�p#�V�<i<��"=)H�(֓�L6Փ�!��TOK�� Ԣ���
�-zRx ��4�Nc�����'�fn�l\�S�N�W�lܩ����w�ԅ�$����z�����A
�"�l�˿ �WV�����l4w�&����&�̛5��9
��'u?ۑ�4�3R����1P�'#�e|�[X�� x38B˩�,�h��|>"��;]�ܙ?��_��u:�] K=<�Q�_ gױ�8�Y��������I ���� �)#� j]-&�>%�`J��iN3X=�Q+��ҸǤ�B%�^f��7F�CcϨu9 �~��^�@�A�� ܛ5�b* M��j�T�i]�3��4{�~��I*�N�u�^gf:z�� �1���sz��^
}7�:: �} �A����G��M�� ݳ,�jW��mw�7�G�X�i �h���D�G�ě��O'��Kn.o�t��\ {��?�y���v-�vOC�������R;�v�]zg�i��C��N� 2�s�%n��M>�2�lF��Q̢<�n�����?O�:�d�@�S8�@���K��0�`�c
K�;�Fn�U��y����\* �x� ʛ�:���� �eEN�4;��>q��z�ل�v/�0� *L���X A"R�����i^ �v�a��Z�X�x-���'m-'��t��$�\'���Y�Rϝ��f���gi0J >�ܛ�kN�ű1/fso \-�����p�R���<�D�c8�p�X���yv��أ�c>zx�Q��`w � ���$"����5��ף#̫5���zW��}>�z�Z����4��ވ�=Z7he�i�2���nj�4�
�� lH=z8�h[
q�cL`q�㜥����
<,��]h��# ��ȣg)��0qڭ��fi$�Vt]k`Oܒ��k�ٯ}&�3o2>�<Lm���<�'�����$��� ��&�#o�&o>A���x1�2�:������t�� b��b�%u�c�A��44�
�w : �:S� �
�J��I�/,��S� exz��/kM�p5YkZ%%(W ��\�F*���h5r',�:��b���|N���l�C��#��ϽQdtG�?��"sJ� ��c9�HP�;�,~v~�u�P�3���h��qE��pa��~��4�Xe���K���pHJ��jG0��k���E�j������&ˇ��?�� �0�ńg� ��}� px���Kg�k(��˧A��b A�i�`�A&��S��( ��6�O��z��_d��]��ed!����2�M;
��솕�?�A�)g�8��^$����}�7$�q��V��I��&�:dw�Ebo�������� 6`�-L�HnJ��8
��>�S�_F3� ����4��)Z�_�����O`c��D�ϡ��0������I�Mc)S����>c�$X�h��vvHO �ɜ�5�?P���?2 ǒ &���VĖ)]ri��}���!=�Xk��Ύ����Ǥ Lc*)�G �~�
��ΰs�Ö�����u��}45,�d�����ꋂ�c\w?(~#sX� � �NH�N���E�'4�l;�]��נ!U��u�nj�FM�v�$�p�SB2~r����l���� �����zvۤ n#/@o�aXo!;���Iֳ�R
�Tңc�) ���9^�I#z9oR�7����}�x��.���?��?�߷^�ɚ�pf��l��@�M�>�I3�]o�%�+�M�Hd�0 i��� ��#����-���w�� �R�����[�>Ho
j�X8�v�R�̹��d ^�+��G�ɣ����>� �!����?p��.�^�6v�;z����{��F����h� ��֜ ���k�A� �㲽��q�[�x��˷�>�.��u �"����x��9� ��j�D[�z"+
$GoN�H�z�|�b ��Š��ȴ���u ŝ4��lTk���u�'4Xro� �ψ�L��ۨ�@�l^5�́������;���Ԥ �k Q��}�$�d�� ��ߧ��Q�k����Z��@ٛ�g�0�O]���C��� ����$�7�Fw��ۄ�0'�0���:����'̢�P��ŸE"�
��% %��zKr� h�CT������2�l�qG�0�V�d���E���,���PWRqJa�ȧ)�=� ���x�9���#��5w�aF�L)E�����:��x� �~�c�0`^��]g{����Em������b�j 1@�P���2i��5�A�Ԟb�w��Fo�4�k��d��Ѡ�OUs��ܦ(�� *�7�~c/�������� �1�(:������=l'����O?*+Kĥ���� ل�
[���s � ��m����r�YG��Y�Y��x��'L�x= ��a7M�ݑb�ą��0��� ��R�j�� ���1H��tq �)M�$ K! ��'0�-b�>��İ<ZD5Q�h��|��a�j6�h���1QN��W���y(ڧ��<e�i]��� :��@�
r��'k��؊)��'�j6
�5�P�>`(��S��'�~�`�wv> ����=�|w��O1��,'MK�N�o���������~�ݡ�}C����f ��FZ�2d2VD0_3��� �j���Z�����e�2owP\X���v���j��:~$�c�@�8A��[T{�Q8@�mP�G������'�E � ��y�>�UPސ�f�.�<�W
�� ��`c�����1#h^4U�(�q���P��w� �<!
E�)�� !���)�ur���7��?�����)z��$���wtb�@Á��pX��w�Q��*P�G�8
�h4�� "
"T'm�� �� ��W�:+@&��u�+���a��I]�� ~<�1�b��C��F��(�LY7�'�tBv�|�l>6�kqOى���5x�U��(���ӫ ����I��n�tqem��Ԃ��!��߽�����b ��f��@MӋ"��`�Yp*�q�b��T()��6Vrf���f1i*ʌd8Q�*�1����
����pgÞY�|7� ��jt0Vu��[��E�H�F̯�
���Z�6�E�M�zS��\ ���&���u�.X�5��`m}�i#û�]ƲM|�χ�"�5P�Q�ΰ��I��
� L
�1XT �4�ʖ� �o�=����r� �o�ـ�m��K��Gz�{�p�&ZL�n�`�� (�����SR) �)Tg
k����W��ؿ
�!kB�aSY�X�h�[�*ӑf��a��N�((5
,9�hm *�S+3م:�\c� F�ù��.fH�³���X:lB�s������+E*ˑ�Z��E�g�m�m�����q����Q�qYO � ��.�(Z,��N��@���UX�pD BpS"�)��x_��C����� �RuCl�RK�)�_!�0p�J\NQ����FZ���2��o2`�T���tK^�Z�l��"���Y��n��&��+ �I![�������R�ÿRoѶ��u�WC��uV�Oh� a2��]�o���kٸh��Y�Jk���Qc; ��/#���<����$1-�X��Ҥ�To �H���9�=1�t���^7~��n���T' �CT�� \�|Zl>
�kb|���cX} �+� �^����8�v�xV���<��z.�J��
!�
�,+ �'�AN�W�1�?f� C�-f��b�i��HR�nG�qWk�zij�i a-� T��v�u;*N��$��=1��@BO�{ ������@=�
��Z�vU��H�V�� � ��[��F��?*ٚ����ޣ!X��
��ӂ�v��;Z$����!��r�� ea��'@�0�^Θ��:�WJ�_�K����la�I}�r�m,�dk�� �A$=�WwM5UhP ���B �*�?�s� �\A��8��G A_�2yy�K=�
�q�7�`M����`�qi����SE�����k ��w��m[���$����)���[��e��ؘ�;M� S��a���J1�y�Zw�g�y�z���l�%�V��.�s��d_Vq�̅���4���Nű�]٨`#Z������N�z���� �W�!��:u���2��)�)��)` (��2����Wg��QX9_?��n �
�s�R4 �}�➫2
����jf���q� �H�Ռ$��ػ*�` � ��0��h6��n���[쿵&�&�$E�C���� 5֦w���Q�ơ 1Y 3R|n�D�eD;���R�s�F�.sM9a��2��R��K%��'���ʆ+Ɨ�՜�;S�$�$Z�c -�X�%�_�Ŵ``J�_�%��^˰�By���z-+
���H �8��`pYS=��Ui��
�ڜ��{H ���
t�eX�F�LA1�, #�� J9 v Ӫ�^� 4 ?�U}�Iq$&\��h��T��v碛�q �8�1�iQ�j�����d�Z#��V�����E~@T8�%���A�O��O�þ��"��
� �aYq�xz&T�n<'P�I(-��.��c'�3�����V=;/p �g�|!U&�����z��]��9Zu���m�Ҿk�r�0je7�>I�ԕst�Ę�+�wټ.T�^�]��E:��2 ��֎�n(�`�ބ��v�W;����˞����w���ޑ s�g<ӊTq�9� d�]w�ٹ7���=$�dX��jz�9]y!C�����U4*��_]gn��h��1�c ��%�� x���|��(�!u��c��I|�b� o�[u�2^L�� D�2���
J`/����r
iJ��iz7�\Ks��9�1� ��~�̧�c�O�S�(^_c �i��ۻ������|a ON��tN5�(V�Ǝ����3Yv�f�5c�����J�W�J.ӱÒFk,?�Z1�"�E�϶�PUJ� K�dW�h��{�u*�Cӫ���ګ�E�����]
}.+�K���_�~�r���`����Կg���I�.4K�$L!�����b��*�6*<��
�4*P�QT�f��Fo����գaNV�/�60}���W����ׄg�EBܸf+�;HF�]�RH���m(�d�� ��;��+r���c�O��Gs?0皺��$A �� ��2�z]I�P�=*4HH��3d�hx1MDX���/����[��$�^����7�$��-�g[8��M���Zy1 � ,�
���|�>a7Ut������`'����#�a��S�Z |Z !�۴�%f��y��fT@gqI� Il6��X"�[�'"���0$�:i�~��*z��BǯGQq[>�" N��_��Vo�$�c���m��J��oL��.P���`G�z�N8��ˬ ��8Sk���N)�}&ԊB5M��$i�i������M���Xr t�Xy�\��C"�a�1�>}��q�-� t<����y����?�0܅z�]<��m)��i�S_�V&s�tS��H2:S'&o�bR$uN�*҂�
&��N�) ���Q3����6��>��X.9����N��D��z��W5��^���f�O��D����JaЃ�FO�o)Lă�Լ>���[� (Q��K��:Gye[)��:{=����D��~���#O���w�����i��������wv��G,kw����=�}� _��`�k�C����i��E�G��s�)�%�R����;��f�Bx�Q(1�J`@�`x���*EO�0��q�'��,�ڄ����T�������ӈ�
Z��5r
k
��{�_c�)�M�6�7�F;(#� ����7*I�
�)�g%Я)��)N
.� ���yqL<k�P� T�"�ˬQLK�lj���,���$q�aL��_.�cv�>�1���#�#�Iw``T�K�� ���~����:�h��Ύ�J�} �Կ 7`�þ�f4^�th�ԭ_�\�#�X�%���z �<kr�Z��At��@�*�+0n���BӴؐ��y5%߱3O F�Yz�"*A�ښdPu��Mh~���h��>�e�#��C�$�+9S�-Fف�c��>ڴM9Ю-�_QW}�5K�����y��V�T �3 P�.Kk�E�sR��5, ~O�Ǐ��@�y�
(E(�����U��Q����� -�d��s�3ۂ� ��V��AJ'R}�4dF��pl�LJ7(��)y��#��\�q�Fi~' iH�?�ο0GX�uky�}7��K\��_0��l)B�%C�F�T���h-6%E�"�Ǯ �̾_t��h�Պ>aB7�q�Z L��ǃ&,� r��l7��L�L��i�U�Z/s�*�f�rS+�~�+f��z�6O��8C��8BS� A���e�%��;;�ߘ,�H�o4 �d�Q�HnQ��_�`g�fx�^A�\���pH�5+h`�%�ͬ��n�`~�Q&٧�b��#�(iH���:x��dU�Y�����Ҿ(
9�S���a���fpQ�̩�M�;���~��'NJ�h�R�T�o�\�,E�C i QH,� �.*�� ��}͜^�����S0�Evc��(N�7��+C�^�Te�G��I�X�==Af����%ع@!|:C�7�h�ı|�f�mP� C���Q�bj�no��ѥu������MbyesJ!��e�Ѫ�� )h����U78�=��FF�� C��� ��<�Uz�OY�v@�h�M��O�kG �N����C�rH/�Ǎ�R��['��}�.e>����,�Z-��S�Q|��=��,a/ &a�O�E���\����i:B�qk�WK�+|3/&�)��M�B>��uB�(�К2�t �/"�T� ��� ��K/zJ���ְ�'������EB�J��$�쓧��Z���u veƖr^|��5���kr
-`[[�zi����.�lm��j�W��I����~�jOr�~��x�pT赌"�^/��WY���A������$ �P�� ��[Ѯ�v �( 6���)`t���I7E\ZQS%�~\���
n��ͦ[ �l��LS��%�(���*M��X|�uL)��>
�4�����9j_G\M���*U�*��2[�� �V
� Y%H/G1�5,+q���*�9.�Rٮ�h��F�� �B# e�ʍB�Q�� R�/�9�Ta�(ǐ\PGQ˛[��� ��*[�v� �
�\;� U'^b1-� ?b<=?Q�������۫9<Y����T
��1L'~ߥ,���yu�_ L�����~�W��p��w��q����T�#��[�S�üWe� �!���q,����Q�%�}+�ɦ<�*�#��qgu � ����H�D�+� �Xm��+�F�l�r ��̩�6����jz���z��f�!�%��E�>�X/ƤY�zb���0B�>����+�a�;�ڣ�]Qf�� ^��˨�$~q�]��Ddb�6���&M;���0_�V��6�]�`߾�QVO\�ڎ(_� �
��
�[�n�.o˪��Vr��� K_.��}j�6�E�l�9�˱�v,I�l�\q�V���ր��|8V���?H�ze��Xq�R����"wˑ�L�uR��֧ f$��]-��fY6w�BZd�4���%x�rn�ʗ�r��̸�R�j�FAؕj�� ��[�4̊ ��w/Y Z��(u���Ӑ ���2 /��s�g��v9_��4�;ep! ���S�����R��A�y����s�j�jw���������
�Z�ݵ-f�; �˽B7����Ű����=�)^M��8 '��EB^ E ��4()�rd�qa�_��q�2�#���J~z��I����x&���{���=jj�v�|f_/:�?u���v��X ��#z�n_ �� ���+!�
��ј�@+��3( "�yݩQ�?f5 �^�W4��� �MZ���6�{e�����g�$�9��)#�Ս�\�S�j�?����f: 0g~�`M��嘍�=��}����+�-y z嚺h��^��� j��AZ�M].X��2��.�8�v�E�^\$r#�� � `�`J7��ݝխ"�X���VFM�2��;#��k.�&)�K _ ��I��Gݧf�����+��#聅�8p]���FE�� ��H<�Q�>&���ڻ ��]1u
+��yOf�2.��2Y��r�Ʒ�� � ��5�f���Z��f���3�+\�U�A ��4}���Ѵ�L��O+�'�6ئ ���G�S��4o-��3�����Բ�۾�b���� �[��Ң���Y���x�=�!���`�V%�%.�Z�
�]���]���!s5x �� ���&���Q� ���lA���j��{&�|#+�hO�w�n�����&-�&��B����V��8g^5!_Դ��>�Ě�:�b���G� ]N8X]�܁�����i��KV �/�x�)U"i��ʴ��� }[� ��-�%��J��(�y �h��� ���K�d+^���ߡn�C;�7b:��15 �� �����j��,ť/�v�x̲aD��b� ��@2+i^�䬡���Ab�&48:�0�2�Ux~9$�E� ��S~�P�s��"�
d�ׯP�@^����2�ދ���g����%
�A��w���R�:?��_t��.Gs_
O� U�U�3��� ^J���4�LN;����R�x
�g��$N>zH`"A��^rMhw. ^yd}��s���N���Y�V��5�F�<ޟwq�̽a8����p]���'��O�O��*�3��QW[/��#$��j�17+���E��d\]�䒑��ŢѠ~�h<���
���-�=U�H�8�y�D �Bi`�xsy�
z��1�Mȕq�wY�MW�%�*�۠���I ,h�Bh� �ug� #`<��F���YO[e�a��" f2 �X!mL�*�
�̌@�O��X��;�b:]c�3~髅�(�U�Fs�F)�|c{�ϕ8�=���&�rg{�ɸ �ڊ�$$��� ��?� k��į!��B���F��(����rcB�0�f�E��®�d�>�8���l�Zm���:��.����e"� 3� ���cr�)��0!���_�w�=�+(�t&T��i�v��Ͽ:B߯�� b{�Pby�/��C &n���(��e?{X����s_��Y髗��
�`.}�W;]`�e�C�p�� ot��w?Z�<{ �f��A���I�NO'�poc� �y�g�X�s �fwX�sq�� C�1L-�Pл��Ͻ��E��?��Q���[��*�:�R5��}~p���Ы�� �cp��X�U�ͭs��{�b��/��J�GO�%nǥ���%HZ��V��� �*N����� �U_��� �=q��9�.Jl�xN�D�2
�ϗ�R�u�g� �6ݐ u~Y�'��Ƒ/���Y� �\a�5�W��]-[ԟT_ԥ9l�i�Z�^/)Ac���~��x(�E�b=qly��r<]�p����לN.b�����
�C���G�CZ-^r��ě+nnZ��"�0�8����I�O�zJ�2e��
�V`u�/� 9N��gGe�U�O�۵�^���W�jk��״�� %j?zn:j���*?��@0^���A{U,�R ��o.>?6�����Ίƪ�W1��|����48�\:o]5�I��}�k�N'R��h`��46'�?���B��'�u�{��0�r.XK���.qVg /��,��8n��o�aQ���dbY��|!u���Z��� H�����І�@�xXCCR5�>A%
����.��Ml�V�y|D��6mn��� �ؾ�a����[�)B��a�&Œy �����U���^�-Z����,ֈ�p�
G �&�����X�Ӥ�E3��⋻e&"
��uX�|��%�PF�Y��l���M� `����.��e�oJ29� �*I�\�h�ǭ�CbtϏ �Sc�����"2*�>���سC�Φ^��X�"�ka<��q�����f����a��<Ο�g�'��� �ڧ~x� �8b��dsj�ɮ@�o q5����lR���\��'�l&���ۋ6I�|!�ů,��I �m��)�� [Ɇ�ʙ1�V�ke�A��S��PĂN ����s�a�*� ���.v)#Y�����j��A0�$u� ��ߣ�� ʧ��9 {}J��aؐ69t�pU�z
�BE��5qX��>`E�e ��j#�K-����Ⓦ.�|�
�@M���c�E��`� �� c ��s> sDJ5�U��u�X���Z<c�:�f��VY��u��}]I-g!�W� �� j-���H-�k��(4�`�4+�c{>��Q���r�#Q,&�{$�<�E�%��Ϟ��Ų�݁�Nt�9��R�"Q9Th�8)�b�T�0/�R����ނ*U��H)��@��}�@�cW�����.�2f.�M7���1�+�V\TH�vکz���o T0���Bw6�g�Q�c ��i!�nn" O� �*@�RRp+�˾�o�\V�}]
�)] |C��8�m9�w& s)jn
�a��5��j#L���{��"b )]�g|'��s�xvW͒-p!V���`j궘p��R�B��)��;�Ҧ�d)�Bx��3�c3�2�`�8Jm�О!�e ��&j����z�\�hB9t�+ �w�� �@8���#���2�� �� @�� �K p�y��8��պf2CѼ.2�W>�Zf��y{ZuĴ�r)~s�C�*�n�K���b��-�.��B�P�$*�Q�y�'U VD�}�q���
C�K��/�N��e���Lx���&ۮm� ��������/H�;��)�>�Y4� �6$hAl�WV����ά@�gMh�� 0Z�7�s�\�^��:��x���� �GM�ښ�� �/����.9�Bx9�s�AQh` |�3����Oޠ;�/����WGiG�q�ƐК�
�#[5��_^�/�^yĭ[ I ��ɇ�D7Ft��0f�u����)��;�-A]l? �w������w����9>���J(��$e�ʸ�<���P���������.W���<��&�k<,R)�
(7�n�0u��H�i�Ed�S�H4�.�y�ާ;�C�7�QT��&E��-�� ��P�}��9�D ���-n ���� U�0���*J���[%���nn
㥘R*�*|� �m]� 7I��z}���(��o��GS�˷�t��Z*��c�w;
��s�x~^r�������6V��)�������չ�\.�g�4��R�)PQ�T��kd�Áe �TĥZ0�?�Z�H넮-r�� ���CS��� ���fTX��[���O�I�ޯب/.q�̬"ap�� ��˥n�_͚Q�o˪ZIV�o� ۥ�� aY]3�]u�W
����m0�\�V��Ռ�J7ߦa� ��KC�h�/R������rD�g�.�EUOh��褋˷��Į���G�ߚ
���+���sV�G�6�m��2��#��Dn� �/����T��2����Q� _�S�v��U5����K,�< �8�˟����n���8����(�\�i� ��]�}�������Z�6s����<�����AO3�Zm�h��,���{��-������C#��G=mYr � �T9�Y�Ѵ��!� qd�L��Nj�q[ � j��y\�]�Tiu�N��=W!ؘ��t��� x�o�V��P�E��&Y"����Pl�W��n��_M�ⓗ���N�� M|�;���y�r���2,�P�~ ~(wV�X�W:Oz���f��X4�n��^<�6+a_�`���� ~�{ۧ���V
��2|�J$�p�g� JN�*2w�k�5��9��Sp�J��s:�cp����(�ܡsc��1�P5ܵ����2���]��(�X��oݱ�7�
.a��0R ?� AV�>Qf�B�ʦE<�^���i�!�ȃv��j����kc��99:��z0���q���ZA�ea~ �/_�3x���{ʚd�O��6
�8<��>E��c�{�����jgI�I�ޖI 9������Ry�W���Br�����4�� ���ݨr]1�p���-y��zĂ_�����X>�P8��{���� Dz�F )+������[k��jg���J �k��u�����*�'�ˮ�#�
� FP^�(` N|O�O�Į����v�(�.�^�6�F�#�/<1�gs? hNc ~��c:+�m �c ����I�W�{*�m��u�Z&[*�k��Z�U��$���<�^r+�q1����֏�S�G��):�'�. �G�V�l�Q� 3�."��� �����`o�q�L�e랸��
�� Tm���=����(/YKVVX��`��4 �C���6�dP���\_^�i%J5�!.�y+��Xi�eO���t������-E��oL�F��SӁmӨoN�=rNgϞQ:�?��RMh���P��ҞWԞaʨZ��3���*�g+LN[�-��.��B �� i��|��'�8�1 ʼ1���Mޯ*�UG�N�e*�?S�&h�d}o��d���O��ƈ�\�4��Q 9o4��Ӣ �j�[FQ+�E�2�����E�8N���SQ��KI���h�� U��s_e /�Z��'����a��/^~��f+���_���:����}�b � a��K��>躥�a��Y���g��*[�(�ln�ñ5�DYۘonj�۫YW�$m��Hi����-8�Pl���H��D�1�. ��c�TE [ܪ�W#v��|�/��guԩ���:^ͺ�mo�Y?_�����[L(,[`gӵV(��kM��l�yi1���-J�+�,>�Ҁ��sT�s��i �pUאJ�O��A��T彯z��*j:��Cz�f�o���\�����
T6��vX[ P����C,'�<�
������̪��<�W��*q �y���E�B�.#�V����a���|�=����(�����f_p�M�[h�9�8��<� \�տ��&��9��o�cwFW/�u��U�ܷ�H�v@��9��Vu*T4�%��]��f�����"��O*K����W]5�O�U���=T�7� %.�Ң�e�/ب��<s+�ӌ2���� �_�+Y�p�mQ�*F��֖��ܱР"x�L|�H%���ڲ6�֖E1Z>�},
Ż�)W��b��k}uo��j d�#�C�����DKR��r����x=a�"h�pt |��Ӧ� '�筿���rq�[������S�k^��
���ɨ�hj�PUcY��M9�<DbaQ���toU����Vs�,�He�%�ĕ �4? �8
��=�9|�G�&qB~o��s�X��K�ꡤ�sY������%�H��1�dP1�y� �?h��vZE�Jo�����G� �e+�_"��H�D���_(��9���4ģ��u�91�/n�� Hn��ߘ�R��ym07��WL�3 R��S��J�� �fԧ�TN�/��^IN�h �Jd>��z/��=��F/U�yy�u%� �n�"���G��.��(���"b��(�����f��D|�� b3��X'՛��V�o��{ �j��pʞ�<�h4�G��_���=$
�
֕��h�)})�;�� �/ �����O>8A�)�5�<~m0oG��*�Ƭ9����fXƢ�X��V��"P9? �|�A���6�+qVh
�~xC�>���Yx
+2��(}" g<��n*@��K`a��Pt��ʩ� Bߪ��z�<Z��vH�$A~5�
�*���AP� �>�<N2�}�.aF� �i:�G�=I+(U��5�Dh`��;���^4]v_����;���G$D���[Ow��snJ�}!J��Z�E�h0��iO>#*�h�,k�]�N�_� *c5;�uP�>�4�w�<��Ԟms� ��U�uٌ.Ju���Ȣ�?�eC���՚� V�d�pRcж%��"��h�dz����\+���P�0�WC���&n�8��{g(ʽ��o�҈�O��oԓ ���
��&N�5���G�B8.����W%���Ɛ=0��m��. (�bh��Iq� �� ��'$Y�� �-��v+����S�>w.?�B�tz�?� vÆ�T�bP49\�ъ7Kl*� ��u
i��N�,�V
-A�ن �s��y��ų�ڞU�{�?��NW-| K�Z��h(s��l�����H�{vi ��~��uEs�'q�b 4��Zk��� n}.#4r��an�i8��5ïe��( �: �|�(V
G�KV l�~4���W~+p4���)� �6�3���e ���Ls��V�\+Z"����c˥\FfڢS��9 V��Ѵ}Ea��V��,n���a0*����$��`�2���M��B�ᇽN��喇�H�X��.��)��w��CPlj#һ���w� .g:@ꍧ�3�m2x /���,0����`�v��z��*�&f �k��E+���BYy�Z�8���Q�c��X�f�>�a�N� >�}��1��hy3�C.��<�m&s6�|A+�pj5[j�S��EeY�9���o�O^E����&�����Z���t���Z�A�{83j��K+��XC��i)�#��4k� iI��-b�i�Q��4I1��͙7��(�`%�O�}oH��J*|���,��KA��Ɩ,�*�0�����p$�V�I� zox��� q�50��h���E��(,�HA��
���d$��:������
n|� �x�2�S���p6�W<��
���ȵK���P�Y�U�}]�c��R$���1h�Ӵ�0���&�H�R��B�����LO���G� �w� �h��\i�o�F�8���91Qg M���a�bA���E]H9�b��Wk�t�p�9�u^��,6M�O�Q�� �Vc��j�% s���7 �㝝 uO;��]`� ���R��S���9��������-�=����8 '�
��K��A� �m@m����E�ñ|58(�.{gC< �S��a>w�R1��i���itZ��>� -�uZ Zŷ��{1�DY�5>w�= ��Z�~�Bp��zs�%�b�f��4n � D�\�_3Ǡ,� /C��,4Y8.
����;��>o@[�7f
W8%�]�� ;*�@+���tŊ�j{{� ��8onj�a����B�-��(V�/��>TN(�@�s�d�ʷ8��u�#�b��^9ՙޭ��9Kx��ųp��" ��(H���:��w�Co��w86Ը�L���u%�V�Ty�<�f��L81٦-�)��@e�
>�q�ă��N0� ����Y�p�=��H��*���.,0g'% �~�IfoX��on,4�p�z�C�T��K��/g�o;g'_~�<�;��#�R�]�<��=Y����wr�9� �9�U��g�n ��-f��/�n� T��� k�/����廋Z���x1�EM�̡�"�v �k�;�E�ڞ��살�`���\6`6����F�,�3E�܅�
��~ �����t
|uuϙ�p{�}?F�$�!�=Z� �tj2���W'���7��^�v �
Mi���^�/j
��Ӹl�t��մ��2� ���Q�ָ��*[㥀�ؽ�pGt��j]����.I�ܴ��uS�V]�7���n��W`�կ��4�X�:��d����KW֪�.\u�ڑ<f���TW�8<�W�7��u�X;��U� J����Z� �o������J����c��j��o�?l�mKK]g�s���f�M���$D*j[�a͆!���B+N�i��u zE�iÎ���W+����Ч�d�7 ӭ��@6ڢ��ŀ��ʠ��$@�
���P7�Wc��
2���:?�dO۠���w;G� ��K�7��3�]��뜝�A6~ ��nԤ���&ާ�Rǝ�)ꅦV$ ��X�Dqt?������0'�ko˕�����j+ͤ��3����t#g����o �m���ڬ����@��Xe/萒h��!�}y�]O�+�����@)��J�|���h�-Ph��̵��Vݬi�t��$��Wٌ+t���}�������D�5�>��T���8|�vv��.�4
��I��ߋ-A�\��p; �B~ ��Z����rŮ" g�Lq�p�>�c�%H�d0Y��#�} �f~(�4l���d�}���وl���
�� g�S?��#ؑ�ڧF~���}t@�X� �r��4�'�:��;���Cr=������l���k~�A���x
ڙn��&#-H��tk��U��{�����_�,�d'�
#`�xB��W�2k�%�@s��
Nz�f�Lt�ࢁ�tC���0����C�������r�V�j<
t��,�
ؾ8O�3[J�0"տ�QNz T3��}u8 �e��#y�]�l|Q��'��I���/5�n��*ԭ ��}��ҡd�h���I��c1L��<�x
z'��~�J�ig 7B���<�9 �BbC8��/~����a�&y��v}.ևW �*�r���xO\(4
F5��E�[�
�^�����W;�n��uW��0�LFH͕�Q���jI����BD���ڵ"S�,�SOw�(��q�����`�TB}Z[n�XcY�4����� Z�: ��]�?�w�u�
x�_��e'�J7�,1B7 ��^��� �C����[Ҩ:��N�t;�cq�j�����ܤ+�^�yX~�G���N*,�L�7��c&�kd�?��,��.m�AI#���Űk�%��A��>ў�G��ZE ��@ƪE� ������ >�in��-����}��|�1?n��%xOI����DJe����*�3ZVX�y�i<��K�_A�_ @��@���*�����N){J�t�:�q��#��� �
��T<���x�I�-��^'s��r�7�[!vv�Ku%���[[¦�bd2��b�|��^ŋ�=��l��1���ٙ�Q8[�H��
�`�� ��hf@TШ'�ګ� ��x�%O�:�YeZB��� *���l���#*=�
<������U^:N�k�>ib1�m$3�韋��� ��.f�^�͊Q�_�T_}�g%L0���r�^�5NQYN;Oɛ�i�eI�]b�H�@5�Ԇ��d�j�Vȭ?e��E&���8�P� ��8 �=��P�y� ,;06��78����� Bp�����yvOo'�yl�!-B�� �(#ߞ 51�, �� Vy��a�>�(ڥ[�� c P��ӣr�7wS" ��K YL���
�9�*Z`���J��N�&
*�ip�S��L��;6�Z�2lI�!j-��*����P���V�y�*�0.|�|�=#]����$^�=� �7��
ӭ�U���z;�]S�9J�U�鯛�Dh[N����T��l+�x��4 ��F��
5���B&��tq�n U�0��� .R�� .��r��"M��ގ;�+n
V ���G� �y�<Rojt~��j�#� ��:
{����f����|�=|�Z�����P� �42�S�ej/��n\�G�?���:��K�ʲ�9�5����:��q;�����z�*y ��ڳB+�7xu���vޢ��ʯ�r��p���Z�ǝ�ز'i%�t���ȗ���Y& � ¾%��`�3���H��Z�[ $��-�dE�xc�> ���e�hs.�� ��v�#���VݾC����#?�L��{���ԭӈ��A�ViD�����v֦��9f��hL�N �=c���
���M�Y��
�-4M0��"�����sv~: ��b4J�~G�~�l��jQ��fq+ R
�҆�����R^Q.�h!��x_�e斲���qJ�s�r^�I��(Y"�{���)�T�����l����8�o�-qI4,� �%�P�{sz~�SST]���y]�h9�]`����ƣ��5�� �S�8@w �ˍ��燵��¢��3�I�{�+ѯ�d���D�Fhד��&� �F��\F�� ��q_�5�8.��%��>A��ٽ�(F��ڜ�u��s8��
��bӾO��M�h]�AtKZ�Ѣu�c�@zW[経�����>�μR �}�/BH���GU�)�w�a�G����� �)@�6� �a
R8o��LS�z,&p2=%TѮ *��@_�Օ�� �6������[WU��jV�4����Y�D�p�8�]���,��
��H�*�_q�8F�Ĉ:ŋD�&L �6pc�4Sp�ӌ�[;+��v��.Z��� *�R��r�j�l`�8�� M!(�o�j.��T^>eeC���n;Q(��� �ϸ��#�;7/�� ��Xl���(|�\c�<�յ5WM-^k��F�(U��ܬ䂿�� g.qկr�g�Pp�.��ˊ�N9F���߱�Z��%ͬ�~�2.�E~K]�qzښ�9W�w2�sC����I�w֨�K�' ߤH�v�|p
��*�`�w eb��H��t�Eg �Ir��w�{[
���1B��:��ۜ�i�W㔩�t��]gv���W;�B�غ'� � �ao
T;[ӶA9��K7�z
�
�ۃZ%��j�W���.�?FM���WW�WT��j� 9K ��o�S/ӣ�w�
cn��*h��t�^g�ry9A��[��-�(��j�ԬT�mnV�hHg�%U,_rv����-��&E��Z�C����f�F�� l�� �|s�c)=��9>|�;���E�/�/��m�����WP��k:������+ �8}+
�<+��;�*��;�*��S�<�Tу���`�o������^�z���y� /�.�r�����n±�v�(�������7�.e �}�/���-� ���6���3ė�i�G {��t�h��G�t��iA
!�l���dk��D�ٝ�Z��� }2Z���P��\���<W)���U�6\!��� ����a��~�k�ƞ�:�7�d ��7�j��? ��b=:��wz�=d=R��ĝ6���v e�5�����Z�#�½�\&MSl�9���|���]t�m��X�� 8�FI�Gj���ÑOܲ]�,Z����=9�yn�T�>/y7�<u����w��g�q�j��E�;����U��芓�.}쪚ӆ��ܫ�� �E�����I�
�N��SD6���ْX͗z�� �En��YK�Z��M�ܠR,A�K������yR%����h�����x�m� ���+�k����Q �}���\:h�����V�
�r[�K���@����Cy� ��� ��`�ߒ�ŀ?�6��']O���~i����NK�o�[�ƍ�MV���v���p ��K�~ry�����J��̧� ��zmc}]�Y��AK��j����G�u��D�,�XT�Q.��?�ݐZ����X=J��2�n�XY �]��蚼L]_E.WX<��E��Wh5��NJg��V�����Z J�_*�R�Hg겻�]0Wt�_��|eP�e��V���B����ol�k\c��{����i��Ah�0����ʄY�$�qx�Ptt�O��cZa�+��+ߟ������+U� ���t���VjC }�_�� ˷�� 9�V[ĝ��-�-��qNQX*� ��m�*��<�ß;�&;)Jy����b�W9���B]���Q�T�q��M�XytW���j/b澉D�9��J����"���8�k �Tz�3�#�ЌOoH͡�,�1�,'�Ӎm3
�B��G�y��+!�����DN�P����w =� r���tߞ} ��i|��{�J�fژ�^�eP��Ԛ��AO�����&8 ��أ�z�k����M[�Y�uV����nF3���p �\\�v-�"�zx�^E߅�h��(�<�9A��7�1,��_�� At&q$����
T&����Y�
H�F��>�nxg�Z��Vo�y�&ڊ� ����_��:�x�fI4���X�I�ؠ�B� �y6�o/<Y�mZ��0�U��� �~B]������S�U}� ��j���¿�� �Ҝ*Xbs����Umn�F �_�,��v5������wc<�>�0��b�]�ڍ�z��r�K�{��)�������.�{ܹ< z�=ݯ���>|Y7�CZ�m=dRء3i] ]�.���O��d%,��~wh!��#خ�jX7|U�* b-[M J�R��5�Q��쩡�[���*z
m�r����u� ٦E�.vHHˣ���7���Y �C�����[r �5����w[�;��{e�N�a������#��VE�za}=��{�*��ʼ��~vSW�ڼ�?���O����Oc��8 �xz�� �{|{_���mG}��
�KC�9��Ow��VI`��ݸα��Lq��y��Da�
�B6 ��8����ҹ�
}�c�F��}}��}e>4 P��ﭧM" �����FW{�m���KЄ�s�t�u�9sy��sGJ���A�G���ZJw�λgC= O��" ����ZC�c� 퀊�_(������%��xS�K�1 �ոu��NY��
��k�e�&9�~韟��F��GX\:C� T���Q��^>� ��{.~6���>�vؽvL}��n��9Z�Y<# k2���V9�K(�# ��k�?^�wYv2��k�4CI��w��ݰ�gfء�-E yC�M[%LT�(Ն��n���T�o�e�� �I�UXE�k��`���^X�;&�%F�� ���
��[
�[�C(��Ш6��3G%��e� �?x�ԟ�"���w5������<%M��"�G7���>��x�R����{B� u�}��dM��s�� �(�-�~R����x3�v�0��u��q�e��T݉��z���/���`M{��@;�Z^Өe����6;;ph�.�b�x���S� }�
�ݳGbd_"��5���w� ��Z֦�<ԐE
�4-w�p~h��A �
�'�H۵ɡ�Aa8y�*1�r�ԡ��o���ߨk���WpV-`�S��Ҁ�u^�@+�r��F@$����<!j9�����yg����o���<D�F�����/8��w�k|��*6��H5=��i�]o����N;,�����B�3d$�^ ��@?㳦-�L� ce4<�d�Ui�~�
���y��Ex��I�ί��JD:�}5}�s SBQ�|IJ=v4[o8[Pv=BZ�ޱ7���.�mqm��2Q]��,��b3ZCEP&@��� {�d�@�s��dL}��n����K=v�����:^|p#ɡE`*�G��8����I����
f�e���h\��a'6�w�Ui��C�I�lJ
.`>�����!.�K���E,�ҹ7��_`����[bEm�Y57���wD�ΡBfG���3��S��Q����;;>_>T��aYEZ� �{�����h��U� �ӟ�u�� ��X�6KB�t�� �s�DE����q��v47��
�1�B��\L;��x|�@�I�T9E������y~����tJ�֒$�= ���Sg��q^>oZ��Z� �\
67��.���^A��ܢ����r�85%%U-���Z��]y��ыa�G),�����.�ZL�?��$�+�0z�~�g��F
��,W$� S6b��}6E_�6�a�M�-�Z?"3t�n��Ҵ���}���i�_�b t����4|�8 �1�DZP �J���K�
ګg ����G�~�����6�f��V��A3irT6hQt��31as���UR��b}aC¨�B2�`��l1��ٶ ��s����Ə�z������$��?v����i�/Z�
� e���S�Z�L<��,�a�}�������:*��^�������6�
&����ߌ�]��� ���h��Xn��l��� ^r�̲�,�-���� ���r>�H4#� �r��`T�<���&� %cHO5�N�P ��I4�B)��e:Lv��Ip�
c�p����e������Q��4�`w]�������Sq�VI���g��n�C?I��$�g07���
������^�o=äg
��l�� ��&���1�{z��`��:���P�-
�wm�c����[i�/J�E�1���K�j0!C�̩����+!FN�-;��9�R�75F��� Y4 f��6@�$ ��U/�ˮ/��z�K�� �&�/��C��I�$�������Ü-�� �@x,ұJ�|��x����n�|�^>Wi$�(�@�{�������V_E҃��`���(('�۲��n���e�1=�K���b��T���B��
f�؇�F F����g�σ�ۤ�A�X\� (�`��y�$�o�&a��,��E��qx
� .�MReUP�E�M]s����0����h1�q'�,��c�\B�� ���$�":����pH!�Q� @�Rɀ�� [��QM��S�4�FVKPk �O�{Bx~��8
(z,��m.�.J�7曛t��������M ���>E#�hdd�|�ƀ1tbl����v$�lI��H���WU}��Ɛ�}��o������u��=�T"A�?U���Ι# 6sb45��W��%�ӱ���E3�� ��[
ڵ�C`�3�]F�i��,#D�6P��1, p��H��oT�c8n��� #rXi{ ҠU� ̛�[��Ѓ�P�_С1}X� Kw#a����:�\�@?�aQ��I��1=N�k�C�]yӮ���o���RNL�@�o�9K)5]�E"�� �=�/ES4h�K�f�?D �~���*lm a��ZU���Q�C�5���d6�x�����R�\�wp��p��
. ���܀�� ��7����'���_�����W���o%�?��uk�2ރ.�0�o�8 �!&�yI���g�C��]"��!� �FesPr�j��` �9P0F��0X�"���J�k< ����C{��Ǐ# ��o���3�̊�k��
+<'U���!>x� ��!�jW~�^����;2.)�Õ
�P��G\m \���)��i�as�Vp��8� {��s4b5:���8- -yc��{s����E��]���%���-
|��w]����r��E~Y+�� �чpD���|c{�Ķ�f4��f;o�t�;ۛ[���F]� 4��F��zu�ڃo5�H � 4Z獺�N�A��]#Ŧ���7��վ��4�M�0��ݪ�٦���;�Ս��z�)m �z[�6��lS�፶ �T ���#�f�����F4d�RM�C �mv:�ls� ��y���mw2�SM��V�Q�V�׳��ߣ��ڣ���4�om?�X� 2NKRţ�Fu�.��nVO�K@�U �[u4��K��MK�R��Q�o����&>)1P}k3��7kB����MJ,p����[��h��@Do�ޯU7{��$I�Z�بml�g�� iǯ[;�$V7��;ݝls��^ j�^��mNb��vu���iN�b7z����v�)� �����6��eJrs�����Qu3Ӝ�.�w������4%�Ķ����z�Q�)��ӫ�� Izv��4���?ڨk��l�����v�ϩ��h����z�z[ď�dj���J 7�`s}�
E�uG+7��7:A�old��h�� �}�Q�I��f����lU3�Il�NЁ��]�8'A}��G���iR� �~����MJ ����՝�l�,����S����2'�$�"6z�G��$�<��u =
63R���Z߯owq f�����w7����ViB_���^G�K����� ������?B.Vu4J;w;�s�}l��h�����G�>!�^s4J�&67;����&%i�_�v���'�d������e���6w66{�Z�II����l�Ls�����`+�f���e����F�9 �m՝Z��8)�0�7��z�I �uz�~����mR���{�N'ۤĖ:;[��GrN9�#����=���nt�:}����}G��S�%�'�̴�z ֘�~u�U��r�Q�DJ���R؉7^�0id�%���R9L�v18�����t9 ;���I��]�+���C�����g]�; t�W���Z��V�b��oooo��H��*l ��/�c�?�h�O�� .���<>������a8��.�f��A$�������G�Y��&A�c��{5��� ��r�`8d�*B� �>�s�Ӡ7�f�Ag��{�C�^/���w���rPK���:���,7
{*p-��i���G�� ��L�Oz-@�%)���0�F-Y7 s]X��r�`�˙�*��"� ��40� �w_( �N� �Z�-����ҡ7vc:�� �A�C s��S !��B�fٛ��KNZɅ�3,�
�T����|�ח�U��� # m(0�D��E�����S<Ԛ &���u. &���V�F��V 4D8� �� (+ >K� |
�x �Q8�=pB� L �?����?�F��ƢI�Ez�F�p*g8Ezsʋ"�^���y��N^�~98m0���������{�z�`�'oߟ6_�n��'G/�g��|=n�6��k�����g�2O��Y� oOgg��5=jBg��q��8+����ѻ�:`�'� YWC��I�M6c'/ٛ���k�y�y�l���^6[�8�˓��{{p�j �;:8eoߝ�=9k0�����A�M�EF�Y�gt�;{}ptd�2w��q�A7�Ȟ7�Q��Q�I�h�6[8��! �;*���6���s98}_}��S L��8x�9`��#h����A4��{~�j����� ��Y����a�l� ���ޝ5J��� LA1����Y�p�<n5NO߽m5O����� V �h���{r�Si����N����u��"> S��3��aˬ�[9=Gv�xu�|�8>l`� ��K�Q��j�a�&
�c��)�T9�� �-$k�d/~n"آ2,�YS� ���@w9��Bh�9�}Ƹ)�Q�y�u[���_MP8Nړ�<�7�;��nwU��ɑ?̳/��_�����e�*o|~ �z���&�`P&�כI@a@r�� � ���'8�0�b{��O�͞��g�iE�G���ѧ�=5���3��J�~Xgoۯ�7ȕ:�C��VGSn���T��x$qw
���9+ b���.>)�W�᳤U"� �u���Ɣ����{�&��E5ҡ{Q��a�l0n��|HUo���*
ox�$��2� tU�M����\A�^�p>]V��Q�v�~����QO ���ۏ3>u"��
��䐼��k����'$�;�8Ã� Z
�D�D��j�6��� ���q5�M:�-l4�xD���W�@�ջ��qx=��L'г�t0�� ��e���ѢJ�ӛ3�Ɨ j��i� ��;�ͽ @L륳J�v����T��`�=s�!nB���)��>T�� �/��&�Nb�t�y��I�$��DSk3]���b�m %��#J����|�&����p��G|���hANb{�r��]vٓ���Yb��U�Y3K�}��1�@��#b�[�r��w���jZ�b�p�s� ~v�r��5���
��^�S^�;�%��� �yD�=;����եSa��I�:�.�y��h���éىlXU ��ʺg�\���i@Y��XW��+J�|�4o��N1UےN �06 ��k��dz�g �A����_�E���4�E��pmML�9��؉�C�&d�%uP B���, �7�� ��V/���q>B��P�p�Z���#��N���a^�>p�Ż��k��DW�)�'�3 ��;`5��ɬ����Mjq���}��(W-���jG�S ��N�{F@�!�t�g ��q1�v��"�^J��[���Ly�7b�g�0 �& `��Ȧ�[`�rƲ$�i tb<�U� � &
I|��#�ݍK@6Xܠ���
V+� }��]����1}D�34�jvGh��V�,zx W�H1����I��~��w����)99�������Q_.mM�>�
�vkp^3�$�� �|,�Xx�vH�&�#]�Xq/=GE�(�� #����w����>x�kBrX�G.ŮY�f�8�Lұ�k��Oϡ�wE]L�;��Y���C�8���E��' �����w'7TKI��p܀�Jܕ�a�'lھL���n��'�{����1Z�p���2�u�-�^��M�6�i�x0�HMg�w:���O�; �z��/�I bJ�MxS~��&l�@ڄ�Z��t3����yߴ� �*�ĄKL��B��b����X��|�b�b�s���R{,Z�L H���E�a[ &T&�����F$ "�����5, в�D�J�K��RQm�q͉��nqȣ5N�4o3�#<K� 0������L�&l�g�lz�,1��ƴ@&��X�0JK�7� i���d���r��;�MAښ�JsF�c��{;~�#�+��S�M�Hk�;�
�U�_�
�K>�C&�6���(��wE@�R,�q)�8�jdGRt���!����㳗)-�^��_{w��M����=��ޝ2h��98��]�9�eJ�d1����k��Q8vTYf[ol U>���i���_�ʫH`��I�M��B��~{9�����p�{�Kv������ I=���Go�k��0���
�K�������ɫ�Q���Q�y�u�| �b �^ �j � 7��U�jP0G�QK��� ��z�(��!���V㗃�c�c#�F����kl��8<m�����/ZGXcۅ5�-z�:x�c�C�U�Ņ5_b+#�-���
�T�/���S�
�����G�S]c ��D���;��#8]��r�l#��W���휙e�[8�� �?�&p˞� S/a\������}���2��п���t)w �� ���[�1���퍿�?����--?��5Ê�{���s��yr�><y�`E�̑����v�Fw��`����u� ����'��M��)a��� ��F;��bw50Hɬ2��Ϻ������I��(Ds��k�: �)�K� ��}8�h(mXM�D.b�Sq"g)��� ����*����1/L���à
Ui��ՀS�烣w
���Lc��=��rT�`2 �N+ 糽�-g���X�/n-�<�.%X�j�,��~ ��^c�&+P�A�;|j��O���q�ge�� �'/�?���W��4�V��=� 3H!< L�!j`/3�T���,@��i{ \C9�;�$WD�:ޤ4,2N ��7)��a�"FǬ�ίp�6�~n�U�r �b��H{!�>J�
?�WQ�G����]�Nz�B�$�t]�%���D�b�}<*�ԝ@�<���G^"�,�B$�Ὀ* ԣ>��R������GB�|�w4�g�R����Fp�h�Ij���M���]"nQ2_������K ie� E3 p���~_��#��?�h)�m� |�^�|���,Pa�.�w����������p>�ۀ��Ɏ:7���+�P��
��C�/hI����z��{�(%���&�r�{c�}�ު���(\Ĭ# )ޤO| �)���1&�[U��bQc]eF!5�Բ�1M� ���D[��cU��cu��.`�[]a�B���s�|� �dm�� ?��ZX�����5
c͒�r���C��g�'Fqd�S0��Y!/�:^`f?NZ KV��=t����|B��d&at ������ý�2�bt=@�w���'�b(��� �� E�?(0�p�������v�
S<ymݱ鵹��D��91!t�5;�����^ �S� �_� ���w�&ݞ�H��~w��sY6� �&�b� O �� ܽ�$��\�5]ci:u�٬���o5Ag��}�㽔�"�kZq%�T�ƿ$�2�ϜBV���b�� ^:� �%� f���>���BW�!��)� ��Rˬ9]� �ࢃ.���Q-O��0��\1|�>'h�8 N�oBI��SҤ���;� \���(YN6�&�t��+�$F�V�;C{�`M�np� U���M��'��(�� iO��� I�w��M'5/�`�ע�$f�O�q��>��G����GE�L �����[=,\L� ���ٳE��0�X�I|�OY��!��Jb"?#n�c�� l��5�����4� �n@Mk%u]� � 4X��ݽ�N �� ��I1�.=�x*i!5�VX�-mx��8�Ĉ��z�>3#5� LF���3�|Nd��ȯ�� `�������w�� ����`� ��2sNJ9W6s{���hK�
�R�5�N�E�oL[o'���s O�L��좱 X#P����i8�[�#����Ѥa��`�T�Q[�ZnM+t5!k�}3 {��L��ԇ@NGw!�$���M� �}:@s>5
�,ƚy� |\:�x�\2�uߥ�ի�`���M6�F��u�U%��"�,/IAS��˪��0�$9-W]/�aw|D? �ȓ��r��f��[�p)A�t��
�R1������R�)"2]�X�<UV�N�b����`�Q'���r�������ZB.M&;5����g�?�����(:�g$� ��ΦԲ�_�9P\��� �H� �c�3�Y�\��Z�t� �[w��1!�1,��^u(!)�C�X^H��L"6{�q�U��U+���)�6��u�j���y�0�{��d�J.�kR��d>�:�kil�< �����S�+Fq��]�OH�V9n
e�!�ؽ*ajXĠ��v�yh�U�=�8y)����Y�sg*�=UK}u�y ڦ�8f#jL��o��֩�H��Q㘾!����m���X�y3c2��v~!^�[cws��G&�r�e��i\ �ɍ�@���5X� ����f�s�-��{ `d boE�]>�E�b�z�.���1龙ȬN�e�L �C?��6F�T�0C� 5H|���p1k�{��>|XtȐ���G���aҰC��^�O�i�I�Ј�(��%;qݩ �|pQL���6����+�������w�ebJ�ԋ�s ��n�Y=��F��� P9�� �B�˦�w�[F�6���#� ���.� !��"�<�(��U����7�Z�Q���i۟ވ��Ǘ45�����v��-/��&F����mI���%�Q�u������'/!��}�GhR"������ܧmy��
�3���eNhDU�X�1+,�9'4d�'�]Q��^�If�睧)��HaF��ăV�\$�2��� �x붵0�ɺ��|��a�r�3Ƶ�'�&#���*� �W�_��g��g"��,\ǡ8 >�6q�p��C
�TV��5�
\<fh-�wy?� 7A��� d {���v[z���}-�ʑW=K���%��ok$x�,Y�0.�E�pR��sӵi�^&���umv�Zi M���b���\C�r�"���� �z)e=�A��*:�W{��O[�����n `��4\B��S�Ep��}0�i�ݸ���q�_�]N��H=f�xT`͓�:&���շ�~��n����2� �/:�+� )�I��V��/��y1�. ,i9W|ʼZq�y�" �R����,�35d����b}�}�HS� �w"�z<��D#3�l� s
\o>�)P1&�y�r�1B�<hSڐ����x��`��v�чq �4:��H\7B��Ť2K'��}��L�-d�7��~O P>4!�4 �Hb��P�d�k�#LI�3О���`���Ϲ�> ���Rλ�P� �-�+�
� �P�o��b%��8 �0\;���[��=b Q���{g����:
�k4��l�q��Uc��9U*� =�X
HXݱӖ�|�MD��4߳�np
��mt�U��.7q�
��?����.��J1�
Q3��
�Xy�cQ��2�
Xt[�t�a�c��e:�����C�q|bI��>m �`_�߿�6[��ɷ������J���,��˃�Q��]�� �?c�+�\�%Rec��q��A ��`��FB:��|m�I�څ]/�>"90V*f^���r��&� δ�߉�ۄ�j�:�t��~0 �PI�S��8�g��*�e�T����Jl��]W*3��,$�`ɲ�E� q�&�e@� �hޥ�;?=���'͊�8wF���Wo����bpi ��ڣ�)Gt�>eO�h�[k6�v�c��
f0��p@'z`�ìb�^���`P�!��e���xxî�`=�0
���
���K��2P�b�~��߿o(�h��j��f̌WA�IBU��mk) �O���0C�5c�H'|\����y�'� n�~�/�ƤP�)�:9�3궷� (IN�G[U��5�,&�{�-RL������ �\{A��p��*����B��C$a�`�mA�UJ)���'���}b�����ƄR�!(� ��2)� _�1�P���፵k$��$U���Ι$M���rl�Xg C��9�ye:0��WO���=Nw���m
E��� N5Q.�'�� �J2�,�e� �F;1���-��$�p3�Y��5MZb\��+�)�<����dLs��O/�Yz<�����vE�? �c�V� �JK^BG+L�u�
t�z �j�I+�Y��HA&���&=r��J��TI^��Kl��ۡ�wl��}� #
�F��^��l�{�Q�81
� &��&adq��}ܹ(�\ ��Q���
PB�~���m^����fM��'�3�4{�M�b���EBD[:c��4�}��i���8��u�� ocl[���UA�D1q&S�
���"m� �T]#TA�,{��U,�yH;�C�ٰ%o�d�"�=�s����B��s4-:�=y,<���E�������'�M�����ǜ գh�@����Jښ�T�;�H��^�Q!�F�<¾c�
���F�$���Ϧ� (��} �t�:��(��C.� �g����n��on h���ğ�N=q S��o�*�T�j��Aio�����Y���؎�A0�6�o����;K1�o.s��3�T�%� L�+�3��G�I�9�f{�0@��*�O��*�,�� ���X�%��L;a� ������^�u �
�xw�w?�n�f��ǹE9gY�*�l]זuL��:�\� �����%3����"6��(������ u� 'KA^
ڔ��a�]�h�m��4�g���Hn����Ik� �� ��Οe?/�7�Iba���Y8�����zR��w6�� \T��)2��e�/&u��!c;l�^B� ��` �<�^n� ��}R"p,�|M�� �Ң��_������Q�Z��T��I���&p��H[c���'��9Mx���?�_ޖ�����[bc,�= �[b@�꜀�d���- ���h�r �1�����`<��5� �����(�"��[�4YJ܃ �<Ӄ��$r�Y�R�k�全$%��*/AA��_7�^�6�����#��j�:i�k�nT�ٹ¡E��a)�e����Y��@I3�K->e�?=8��}zr�Z��G�& ���(����[�g������T�; I)ԅ1 4J^)~�Y�F�fX+����� EJũG�c��T >/�@̌,���I�WXO�|�#r���Zݷ<e���: �A��暳`8$��ҟvP}�
�HKh!�ok�g\`P�FJ�қ�4��t�p��ʆ��/dm�G ��U-�iY�@��A����v���O��d>+O;���aU��K#%dp�� �jVj�:t�]��
�zD/ w���nW7������;�H�|ɠ��:m��զ�]�����
��F�8 �G<��Gw�TPJ�Nm @̎�4�b&c��I4 4%�S�QB�lOO�g��;:掝��y��Z>���}r_>�m�F��� ϻE�W=�O����@�Ϻz|�� 1���V�+K32X3&K�k��l-�Ȝ]����Ǫ
���29��U�藦��fh��Z��h����VK���\��g2nj��B�j��v�XE3 �;ȨB�5Tp����� ���y* N Sv� 7 >dA�1Ȱ��l0�]SL���*@ͬ��U G Z��T��L����wmC�&Ո~e$ ��{j��e�Bǧ��Y �>ͪ�g��P��74Cu�f��#k�}݊�����(Y�#Jsm���y�H2#Iڑ3ٛiK�c�H�Vrk�_����1&K��jܓVM����j��nX ��_鄔&(F��Ԙ��п �FM�K��V���|-&b9�&�{�'�T��l�PM�UE�� 4 7�5��r�$��6��]�� ��$wl�f�z l�;p���i p�2O��0��l�$�xJB7[N�f���Ze�a*FR�����͕Q��ݳ��1��ֶj�x��j��W��?�߫`��K� ��.���a��k�(7*SZ�}�ÿ� ����R��֎����V������]��7֪��z�����-Z���- >ς1����������*v=�]�#� l�c� ����|L���}�ݝr������� }��p�OQSy��m[A�j ��A��[�_Pm| �1v��!ԏ�� ���U8
���]�f��J����]��qr0�� �~x��vzux%��@Z{<O�K^�A5G>��&P����x�i�*77@ƀR�3� ^n���_�L����6� L�|�A��)��y�
�J�<�G�7�&� �������|<�U�PR�+�[�����'2hk�
���"��q�������l��ׅ)�s �o�
.T��{s3��W��?6��ο���y4� î?������!�q��!�+fp�g�SoU��P���t T;���<��.�͂V D�9A� �Mʽ�����w�v���r��;fpY1D�<:���B<�N�Gg�9{X��n�y���)LN����G�\>�x�x ��+�Y�� 3��� ����q �{��`�����K�� _���;��Ok��N�JU��
�y���#���AA ��8u��`4���BV��B�>G&C�
Q�jP|��<w�jW�]$9M ���V���V}�?���_�Y�謐��;; {��$������"E��ݻ7B�&�����d9+����-M�ڳ.�u.+\�A:S1'c�� � ����^z�zs � Z@����q��]&VY��B��Z���{AN�@���Y�� &�'�ys
#Z�.^
x�����n��]p�
��@�x�+�E&�G���� �ґ�u�%��EY�h�j�dcyL�Gb��c��Eg�b���%cբ��� �&��0"{�9aE.�yN2+:�=�*�s��3
>�bI�{���QQp^A���ۅ ]E��l� ����?������ʪw��������{���\sZ����/wo� �dCv��{�n���A�rTY�Ra�'����'��p�e�8T����wY�� �(�7�,
���<�f}�5�{Ϩ ���O���u��/b�}1V��@����_�O�u��1�jխM����Z��S�k%
���!����Ռy�"��T��6���!;?� �o&��r�P��`�Q؟]�Ӡ އs�ydO�߲�����p����w
{�9����w���ۣ;��S�* �!{�y�Ѡ ��I-T�\�as9qUh��#��A9� ]���;�'E�t+tO`��Fy �5@7��I7$ '�Oi��)K�8��X$�X��)9GC� ��EU8O���'�; �����g�e�*N|i� �A �ŏ�b�M[�9��I ^GO�ib3���CI5�C�@�� _��3�Ԁ��T�^ϸ.
�.����� ��A��Q�Pb�i�`�!��[��
���t:��Ŷ�`��]{�� �� u8��B&I7O=*8_��j���R@�:w� �Gq���/�-"� �Ԏ��⢠7��k-_�g�'���?yܝG�a��3zѲ�
�
� ���3 �Ѷf�� �9��6�6���
����#C�)T�K��� ջ�X�r=�jL� (�J���O-�b�ʦ:�T�|j�������(B_� ����3 ~
��L��>֡�Ɇ�
�&H���de�_���ט���9�G��P4�ž-`짞����W�� 8^��_c`}x�~te�xE�q�(�C�f��|���y�o����|2����9�.˛�(4:��V@�UБ)< ��c��:`bo�
/fU�G�$��0�\�qA i��_#��f&d� �|�Z_E�L �{*�i�g �T"Fc����TZ(��*��7+v��X ���?<Y�+�k%��|Um a��W)�f4f^e�RbuÄ&u�W�S��IN&�� n u��p��C�q�ʙ�#>��r��C��_�?�����Z���I���t �7�$���/;�N�F 6���5;A
4v�enB�!�E�4N`%5Љ��)� ŏ�n]����h� h�%��S�FQ�eHب�$IAT�3�H�G�zߞ��_���H+0-\�� ��<� XO(h���G�pQ䝍�_C4c�JT\�(����
ƪ ��e� ��2JTl��+_h��2��� �%=� y�����T8R_��ڔ=���a��"0ˤ寬A�����`�C�^6ݽ�:��O�H��3��OE�� :�m%������zN�,�� �?�4��t��V���v @�l� K��@l� �iV��6ƧJ��UI�*�F4�ѐ��=j0�0.�\A�Z^���FRZ���A���T�eh\�*� *�����$�uu�����B|�1��=�f�)"�7c6I��/ߎo�`&�)�a��Nχ�
�^2}�� �;^��ʗ��2�<)�{ �ϘK����hZ�c���%�,��Ӡ
�"`�$�t�A�a`���U���`
�y�� �_AU#v"#�a��(� �BP(ڒ�y�"NaF��]����Z�s�m�� �VA A�+� �z�P��(8]9��.�B�� -Y�P-� �^��^��i� ���|���
پ&#t�K��GQ �B ^.\�Ř6=���)���U���5(�-è�f6F��qiyb=��!�]�\� �� L/�� 74�����1������ Xr$CL"�)W�D�;�@R���M�$��+?�� ��\΅�{(!��L�B�|�*P��AZ��D�(mXq�/V���E��Q�M-m3 ,�e 9��A������Y>���}dh�cG���D��3�mԼ��o0�4����UT����2*�,4`U�)`;R� WE0B �%�@$.,%<�9'F����-nlw ���kd,��ѵ�[*� no ,?�C:F��� .�=4��3N�<��C���4d ձ�;
�w���'���;Q���I�c�`$>뻌F�3[D?R�`�)?��DG�,D� ��r�RqC�W��(�G!uŒQ�@4 �fEFf87! \0�i�Q姅���� �����H:J��s�Xū��i\ ��eƁ�*|��Ǘ-yJo�~�O��C��d`�y�xx/�5�
G� ��8�Y�)�� .؉�U�T��#5��I�Jް݄��ԫ����`�w?¡i��\�7��R8WTNe|e`&6�$E��r�\���GG�� �1.��
o�9��c���[ ,\8�'Ǎo�G<#&�J[Q'N��Q��q��a9y�[#*�ʇ'�:~U=�ZJ=C ���TG��g�G:,�5���MP]��Z���M:0�k<rq/ O� �|�`i ~��f- ��d�3�ĪP q< �CWq��*� gU�*Jn�F'�5�:.�Z�c����Z�f]��b��K3q]+ٗ��
dpS�s5� a�g��D�E=A�&|�ۥ��g���K�]KC�f~��m
k^�p���|�/������E���W^-�~��b�8�գ _v=��k����<B�b*v=6��.��?���x�f+_����^�?������N�����^�����U̷S�}Q<��M�)_2c���O�)ɜc�Gԕ�bτe"1M��&�%>��?e2ڗ]��⧫�t��_�b����Y�����W� ��~�7G�/W�p"3�)���_�9���5 /zB�G:6����ZҩHc�d Y�:�Q�H�hU._����������"�"�7j�a���c�
��D ]����*�ԝ��"DI�H%9T�Z?(���N�R�b�m�����a�U �I�/b����:(����)=IL�� "b:����j�y�y�-�f�F����+Ej"ڀ��sD�[� |Ό�"G,Č\��w4�<��\ǚȋM�5�#,�M�� �p��\en� Ϋ��AA?ѓo�y�5���f�o<Y&�k�zӷ�xg � IQ6�5G�I _b��PM�d���O@��'�a�{���|���2�gR�*\˾@O��8I�0�3 (��'wCp�-1ӈI�%��Ò>��� *�]q�Q��S�� -Ҧ-˹_��E{�[v��׀ �jP�5!��P1.Iᴰ/=Z��1D�~�c���Z�r�#䒋H'�dc�iГ�YT�t�<$&�� �#�T�쓀6��%�K)�!L�R�c���R��U��>JV�Ŝ���_ۢ�EOQ�/K~9��z�%�QKO[+���k���%yM�j�*�U�bU[�hã�N��rR�X�� -LI^7��GZ�P�i/jl]���S0EL"[�o��q�/��d�3�p@�lɫv��K�g)��DCybú�<Fg�PXq+՟ܑO�X�˕�Fg Tg��% ���6.�$ �]�"��Z�A�Ws>� v��=W�(j*� ��D��d�_8� p��n��mפvn�@le )���8z������ ����8�E� ��'�7�*����LQ� �<�^ <��&P��H��7M:��9y4�D �2��@\8� �Ípސ�= Ҙ��V�q���GΉ�N��⣏p
�'��/1�y��Ta�,^�0y u�h>�\{��$�1l"��Xlm畨�����4 �~A/�� ���Ҭ�Y2�3F��aY� ICU�B�a��{�_)>Qv�p}<��~�إ�����4�
"�\�c9��g�;բ"���j&�cj���6>m~�ŽϦ��Z.CɅP�)��Q9�rB�H�����F��0�[�ê`y�%!a:�v���g��W\%�a��ǝ�}`1� }� C�Rc`i� 0Q�m�4+u!ׂ�j���a*n\Kctf���--��k�!j |�1� OBE��V�J0�'��@:H��QɎ 4�f^&='Q�U+�Қr�%��AȋU�t-��bm:�[���l��Ә^ LF M�#I�O��E�.���Ien �)��V=����E��9�c{'��h��A��fW�+8��W �+�
Q�'sG��HL� [s�N�7&��b]�W���
�$'G��y�$K�O8y�ٌI�:�|���x`A�;�V�Cl�ͧ�NO$!�
BP͵���Xb�o �X,2k�ɺE#w��l��$g�
��� )�29�v��a��4�@ʑ�� ��ǎQ!����p�ɘ/��'��[�E�iμ�m�)� V _?>�-�(? �9�.�Jd��K�Lk�Kڀw _
�|F���F�F'��_ ^W4����ZyY�T�lz��(r��,dV(&67�����1Ɗ�92���u�O�|��2 ��&hV~�G�-���1D|�5��
�a�S,Q��HH�Dm s�(,��~��m5_�Nj2��wg1��yK����XbU�$��V� 7_6�ZyB��� .6 �T� �#�9��d܋����"m�L�E9�8��F�<1��i���?��P��X������3vvxx�N��ܴG� }���^~�~h�z,,[3�!�n٩�#8�$G���� ��4�"Z��[�=��P��R��O��������� �n�E+,Đbz�ָ��I�ZnY��⊉�w� � k@VhD>�
�1���G�53n8�o�J*R[� ��i��A�D��E�~�*5�#��1μ�1 ��'G�Û��C�e�+�{�깘hk��'�t�V�E�&��KF��gBN�>���1��YhH{�1����T�� 4OQoӾi�b���
5��X��i@��@�5�H̸�pBY��J��~N���UX/o�kx��QR�k��)�up��q�s2��_hɤ�Y"ݺ��c�Z '��I���m�6���Ux-ơ�#���nc5Ax��0̌���J
��$��X� �Ƙ�0M�cJ=��"bP�GŚ�0�Ǽz� F�E���3i�ȞJ��7�b���l�?����2Qj�0@t�~ d�8�(b(�H M���bI��T:�4�o���e1�S���3�H��<����M�y�U�2�((�hFV���b�Iot�c{'���;�y��)�T��˺��m�5 ���9��p�v�{Q��#S�K� �H^�ȿ1��([<��89Hz���H�Z��
��cw����e�U�ƫ�퀒�tc���rT���
��o�uU��g��Fɘ���2��"��$����.��$�`�/'��w�
��{���S[G[KSb������n�G����9eCD
Ā�2VԵ�6�m����,��fף/�4��a|���Q�f�7��Ӟ]KpB�����,�"�\��겒,/��qΞ��m�1�R���V�༴rщ>ݎ�d���c%\�V���v9��Vt�|r���ޯ5GA��L ɼ�Rr ��R�K�x�`�2A�M���L����-j�j��"�K!�:*��Uȁ8�V oai�Ks�ضЩ�M�i>v�BY���Cn*�� W-��[ӶQ0��&�URll��ڿ���րU�$��V��G5]���)T�
-C
FF�x֞S��<Ǎ��| �X59(
�F�htƹ��LV�� �v��yW����(�n��Rg������OQ�'N seŹb� ��q;Kk5\G�ׯd��=�]�Br����%|�ʙ��i��6dG� �m3�� J"|zP�� ���W-�)Q9�>&�K��n(��t�8~��[���� ���`�XG\���C9��N.kR�� ��t���(�C}u|�����8lј���1��O�;ۊ'�8��8 ^[C�b$�A�UX rQ ��Q�����ץ���J�S �z|œRM��4%C�Yѥ̽-�ĥ�s����>^M� �-.:Q�*F?_�H{G^�$+Y���Cz� �c��q8ȵ5��
z>�X���gqER�p����uY"�b�`����f�u��5 #y���& w_��B_��5ܦܦ5�6�$�JL<�7) PC�ۏ�Њ��I�� ��"P�|��'
��� }���.Z�w��|���y��q�E�e�2�\�.Mh��+�-���O��ʇ� ��B�ˠhw�� �i�e��C�8f�:�c�D�����n=�`��{%t4��"�ZD���a��1
��hR����I�X{� �}�.Iɏk�� F�]AZ`)�ᛖ�7�-G�ikx��=I�%ᾀ��) ��c�$�dC)� &5[�X�y%5����!�����,��b���'� �P���^b���Œ��7���m\���bGG:�pt��Y0J��B�J�%��po3+�-3�4��A2
������kJyL�B nѕ4�<���YKO�1�<�@�s� �W\�5 ���r�) Z
��Ԯ�Q!�� D��qح�#�
{
$&.�+����~��"C�@g�h ��M0�Gԍ�P�ʒx ����e�V3�D o"
p���B�ʚOF]�W�[ �}�q �`�ƭ(��Pⴳ�Y�4u�{���pU�c�S� ��;͠���Z� S����摕��0 ��u�t^Q��DYټ�=Cڿ���U�Fշ�`s������2!�ۘR,~�4}b��vζ2�7��%�� EwB.! ����]�]�U^ t���Ђ�?�Q$]l�ѐ/�n�I�����H�ew,~������E*�- ���j�3�?o��;I4��C�1��r vgm��I�
b" �D���1Јh�� �v���N� |Mj���bo��P����U����)�@�p�b��n@��� b�7�RE|w�Zhv��K��'� "�#��~��ǹ��]+4Lj���BX�� I���G�t��VF�o%�u^�� # �Y�ahE/i�ؒ�~|���)��<��0�Y]~�pb�� ��
&��9�T .vl�]������T�C?]��5:�ݥ Hd��rђ~*� )���MI��ŢXV�b�yw�QkR�pZ [�r8�X{1eȜ�RPo��c�`����}*�ؤ��(��i��/q4X�\N�c��%���η����N�~D��A0�%�D�r�"]0��b}�A��B�jF��t��a P �̯b?u=��.�+���i�[� ��º9`���� �O;�1�' �ϓn ���ࢡ �Ɯ�h�巐���3�g��֥N������Q/6�|*�2/�KL#�DX�Pb �o 3=O3�$k�+��]�L�LY~�<Uˉǡ:Ι�H���@����6��A�_r<:ǁ,Y���m��� ��v�R�X�F�^g?i2N��9�o� բ�2P)n�6.:nS�2Wn_*� ��v��K �L��{M�[֛��kH�zM+DVbB'�PyO V�V&��䳠�Rd\I$]xwI�� p����l���ֲ��O aA[D�lSdO�mq?�)� ���k���2��N�˫˒����똷�p�I������*c�題GQ��!�^�x1�cl7�p�sJ<�5ɻ� vW�����Ì{;Ün�Wc͙L�7�%�û,Y�`�ұ-���P����I<a5�;z��|��D�5c�x�4,�p�����d��B�r��0��#K���r��bA^jm�Ѻ��(F�M��� '>4�o��p4�Ls�M��W�8�5�_�m�c� ���2�E�½4�S ��wɁ�hL�ӎ��%�t�Dr��^��h�`� �;R+��%E&ŸKt�CZ�`���
�%y�� �� �{^+�פm���Y�+;a�⌛2�W�фL+�����p� 5
n7`"&������2��UE�@I�t��0��?���@ni*�F
Wc�E�Ԓ��$�6�+1'O����[,-f��O���L]?8b�H0�`Z��p ԩ�(֖H��F2��(U�'���� ԼP�jdm�㻌�d��U��xᡘ�J6�>R5��C�+�1�4N��y4�T�>���]�g�/6�:meoRtѺ��t j7
��m!U�q���yIB��$�,'�i ��-bO���ү ��W�77�G�%m(r
��[#lml��`�?���*�AAV��m�ɥ�7�䡕 J˛!q�
T7� 寻/��ޜ [�R���^6�� �z8 r=�s[�үh� �9���{ �y��J9�&�YgadG�>��/�&�(�|[0�1�����[��8� �}e��"(,�0q��mD�hB\�נ;�~��V�7l��� �6SLz}[@9���1W1z��2�@"��L��D��ȶ�u<���n�)y�K5�M�X!���Ch�ŀD\�&���[ [c��s�Bև�5��"&v�C�<�ȝwOڿf8�r��y=$�l���ӳ���ɠ�1 �m�/0҇
cQ��h�V���U����r N�2�ϻ�ڨ��@��6
����`����3V��%�7�By �^0��![Yee�i^�WY ~����*R�C
V�C?z� �#�����8�*�a��������X��cV^�/E}6ʅL��N�y)Wv�U_�ɦ ���0�w� ��1R���'�*�/�gQH��
��_���o���+��E�GVE34�� �\ĬP̽�_�iB%G1,���;�� ���0 X�?D����>��(} ,5��m�����y�����Y���4|(�h�ć�Ê��"?���U+�.�ǠÀɍ ~��<vy�C�Ã+ V/*(Ow����w�.ح����z0:�dG�\�q�z�<E�3cs���^O�<oRt�4����(� ��8��
����SaiG~���$щ zH�Q���|,�"E0�#��P`7�X� �́7��Wf�}8�� p�S��Z` �)Of��|�(�m�M�$â���=���S*��)�{�ڨ @��Ǐ�:��� ��W�9����:U���q�Ce��oke����*R��d�C��� �\U��o��IW)�K�^xe�g��\ ��we���k!bϿ߹�7����q%�]�=X4\�3`�[�*��$e��&u���(�yD&��b��<�����z���4��5�1 3b13d��*�뮌<qV} L&� �ve�u(�T�ͻ�+� �p�QG~s]Iy���o��Cl� � ��k�Cu
�� �{�OAĉ��I[�[�Oz���<������S8B+_?�V�0�r�lEӞEzZ3�H�_�@���a4�%p�����֞�c�&� Ru���d� T�i���D��ʄ�b���\�r�ɂ��m�[[[{BF_0^�Ȍl(��O��g1�����}��ʌ%����y{����j���.t�� zVX-� �b{Y�c�)���=�mt��Z^�U�Ajjɰ��<���E�W)7V�H�$b��~�B�pSY p8i�}�c��� �3��~����E�i�@�`+E�<�Τ� �M��v;g�iA�!��Nsi��,6�
�5�����ч\6z���&˂%�?uM`��o����_����_�� �� ��� D checksums.yaml.gz 0000444 0000000 0000000 00000000450 14611460537 014612 0 ustar 00wheel wheel 0000000 0000000 � _a&fe�-�@ ���b/�T��y���$��P�8=Ó�Z��u�^��o_I���|��wv��ˏ� ON��l ��W
kO�F
�˽VP�Kz��Jg��s�>����O�&F��JW���̢�G�l�1;ަT3+�d%K��T��8��eY)C܀�ZY�� �r�<&@�%sj�[�Dͥ��Y�ʼ���(��TCb̝�v���8�u�WG���EJ� dy.�Xx$nn�;a�m���m�Aa�2z� �� ��᧳ћ ��lٹ���f�4$
���0�?+��� share/gems/cache/rack-3.0.8.gem 0000644 00000324000 15173517741 0011734 0 ustar 00 metadata.gz 0000444 0000000 0000000 00000002304 14442217575 013450 0 ustar 00wheel wheel 0000000 0000000 � } �d�X[O�F~����%���-!me�Q Y$B�>�����=ݹ�saY��o��,��]�� ��9gf�s�s>�1��b���7(]v
2ˮ(����q�"E%d��r݂�(�&�ԩ"B6F/�Y�]���H��DԻZ�E19Z� �Kn�TPi�{n �
�7��Q ��eM9n�˯� �_ijo⯏�l��?��� 1h@1P%���1�7�kD�y)���CA�D�rS�^=��x� � ������Y� ���ڄ��d� �n� ���-��5 �U *,<=߂�`��XǕ�9�aٹ����W��#�4�� �ƾ� 0��߆��%|��G�f`K��
�@�+ A�Y�rT�6I���yA
���h�h!�p�,h ��=�VP�4� qm��K��5YT� y{ss��Mʶ��
�CX�Z�\6
Ȋ�I���x��x�3���[Dž���˳��M,��A ja�nV�,�9��z�V�gHn�ȗ�:.��p�^�`�UpZch,��H�a�H�L"����`�� n��O��"��ҷ��l�;*�`�hhn�.�� �� �y7O$��'o�/N���O��7Wg��9�h%�5O�����M|~v2��������$~�HIL��)
�"��E��Kk���6}V�l
jy9�`�ڱ�Ӥ��ܣUZ��G�P̽�c0���l�㥸[� 6
CImI�GY{�6�j)�]U�}4ҳpwppW�����B�(��� k��T�� �п* ��#d���h3�8:D�-a '��hhVe"����+9�Q OY�t��^���lJ.G��A�O�T��z�P��X�n�<�@��������n�o��H�|"� 1]���0�5��r #y{��|*(;�a`�o*���\5~��+7N�E�0ᜭ�
ip �гSZ�AΏ4�5{�ل30���荐�
qF
��Gr��ZBC+$ �s��Ҵ�E����6�$�T�0#���GX�8�
���U :�L�
߿Sʭ�D�2|�S&���E�M�8�T�5t��=iG��F���:�j��] 9�3Z{SB^jO#��8,�
֪kC̢v��.��l�����`a��,��=���kȾ�����ks�ar�̶AT �$�m
"6���~Y^)$<��Yd ����(�^Jj�9�����8�cL��b�S�p�_�u:�( data.tar.gz 0000444 0000000 0000000 00000312574 14442217575 013403 0 ustar 00wheel wheel 0000000 0000000 � } �d��vٕ6��QT�-2��M��L�)���DIY�_�"@ �$GHAU�V��?�{ܫ=�I�z�7�'���%��]]��U�L"��7��^ ���nO��+����t���#��������t�[�����[�{�{�~gko�A���yf���qM�i�������Qp4�Q4IG���d$i�&Q���H�b �,K��EpS�^ �|%E4�D� �I�^��2L�4 �� ��4,��z��<��p0��8M�� �&Q�GA
�,J�Q��(��n����E1�67o�K�7����t3J6�ڝvgs��h<z|ܡ��?�`�����촶�6��mx�G�"��Y8��(�ig�8�A��n0o���ēnpN�Q��?>���=w Q�y�'�����l>�l��F3����h�Et&��
����Ңv���G�;n�O�{;�?��i<.���%�x ��(Â�8y�-u8��Ωu�=��9:]�^���a2��o�~�}O�"� ����w�����E������.g��`�ش��k���]�E43k�y��5�<�5���nP��|���[����mt>'I���9��t>)bZqq]�[�\�N�)m�Vo���`[E�b���־?�vkwwo���?���'I����Nk�3�E�R��ߝ:\�� �/�I� E�uoQD�?쥾۟�t{r�{� ��۠��䲸7'���I��,�9.o�+ ��������U7��Mx�<�{N��"��}�eiF�~D��EPG��ϳ�ppBK�Mo ,���D�� &�R<� G!�`�^��:��N�[|�:�)AlWVL�<G����룳wW�ﮮ�~<?���*�� �{}���K��?lI�}^Ro��iQ�E>m`�ǟ�f�o#Bq��[Zp< D@��x *����s`�*M_�=��t�f�O �ԧ^�� ����6=>|x�#� D��8}κ�<'pLҤ5�fY�A��W�tHM�Q�y�N�;9��� �JЎ�}�_�ݨ�����_g��~y��y<\'���q`7�=���l��Q��$D����� �O ��DG{XuD�X2!rk_E>�&w< s��,��ƄZ�(�b�^:���іw x4;+1���9!�g՝W�o����$Mo��ЛM�s��~ۮ� B$��� 3+���:�*>d�l�ӌ`hF�=� π0��]&�A�H�C��fЍ���}bX����YX�W��.�� ��z�϶ v�϶V b� b�y���ʻ�pc^�v��*5ݕ�<?>Rv)gZ�� �و�5�!t��8-������<`�{�q��I
��� `W A)1z]4m��l^<p���{e
���8��q4���sy�A�9�� �9�G ��ٛ�t�9� �`y�*���EE��3�?=S�=#��|�2 �҂<��tBۧ�_ _9f�>� E�[�;{]Ԯ�o\�W��f3:-�ք�? ��0K�DI�o�%I����R�� D�#9W�C:t� ��ķ�@.�4OdZ�Ƹ�E�כh�3iN�QJ�j^� o��߱ uC(���{��i��I� �v O�͘�T)1fA� �5Ƹ >�(͉���SX`��#�
�%d�ؠ��L~ 1 ֣�^^�x�1a��i�x���r�����$wE�q:�B�9$&,�m<��ށ���a]v�4����X#m�8�o�K �n6��j��}����ܛ�:�"> �^�]� �mo� Qw����>qO�l�\�$���u넋��n�(���4a�� /�/~w|q}~qvuvtv���S�RׯIx��
����H� .��:L�ܾ�ƈ���;����/B=�6�dHO�}� �����&�p:�p N�3\�iס:�D.�I��dѾ���u��批��c�W概Y2- �i: ����~?�� �o�����yQM� 7��b���+_F�P� ��{�8pl �y����@��K������J�� v ^Q��H� P%( ��T^M��1���
MF�����n��[�O�L-��� ��l<
c� �^A���?���� �0�q�y0� W�8 t�Ҕe#}��t�J��;#\�9i��m�mx�zI�;8�<zs����Û���ӓ�+,�B �( [ �O�c�Q�
h�q�Į�}�M� ����:�atG��
�
B���&���XD���W��һ °�j�8K�<"D=H1�,
F%�,�F��|�����v�rg
N�e%SV֭���;�}T�R���H��L=����N���㾌2ZP����(�7�E�l��X�)"X���?p��5��#(�J"�ä���1�Ĥ(k1���%���4(��`��~]Fݎ���~8��i��`NT�
Y��� &�=s]X�y"ˎ��_"^e8N�������� �`�(h�R�G� �[0P�ū�`{�9tG��,'eȭ� �>Q�}�?{ z�Ð0��u bC� Ce��L��d�&ΕՖ=�Sŷ�o��[��Ӯ(��C��z��)��.��<gu�Uw"��a<"�_�� Q���$g ѱ Ȼ�_c��<�m�e
�o$���2+��ّfO;���U���x�y�#���a�=/���� �8�f�_�(�p�}�J t/��a�0���0����DS��{��4��w�
/����GD'��0
�Ao�`y|<3BB�Q�n? Q�n/ 2��Wqh�=�����æ�v< m�CL�$��rf� �⽚�1<U%=��YHЮ����x�����'�^Gl�<.�ow��P9��ae O�>l�Ԏ��N&���ڎ~ƬK+���hF({�y)qkK4��z�Ƈ�$�ȏME ��T��� ��D Բ�\�����A(��0K�N�l���4/T5���J����Hu�3Zˠ� ��I��1 dGX�� xu��^~�l���Wĉ� �>��*l�2�*Y:���6+%�a�,���<IÁ|5���@`�Y^��t`S Y����]�x�U V��v$�V��Q���G#���q�Q/� -�3�?��<�n�a-�U@��'=1��"z��-[}X�ELf���`J�� ��!�Z�.�e����lؑd�Ω�2( �nZ�D.~��3��֛��<�w���$B�Zf@"��~���О ������+W���vpp�fG�9�>�V zq;~�;�]��4r�Qt
e��l�9�E����cz+a���DC�;h�o�xbxL��[ӡS;�-
�����K�qcc�1�և�1w
�%���3�"W,f�<5��5��>��Q��S\�&�g�h�"����$�ϋ�ޱ8�
� ��֝�gAwiv�G�@3ľ�!�Lϸ��~S[������ͩ�b�'l�](�#�@r���6��j z�U��{�2b��g.�0�� }��)Z���0�����T,�q�z�U������|�j=k�����1�i�0� VQsR�Ԯ���u?����b�f�"���YDm#!~��^ v�; v$��p2��՛.Ia��}9,�a�*�=�< ��� S�Ή�����a�NՎ�2.�P_���u�g�PSB1��I5��P�aE�n�,!7���F���0��r!�Ō;C } ��ݧ� |��vE4��N�
��[FbSB�l�?z��h��% �h�<�� � ����&�Ô�E�=�j�F�Јz݃uV�
��#�E��>�8�T)������gG7�a� ���l��n:?�ug�ۀ��ԙvpu��@��JR�p'}9���]���&k7�����Y���z��#�ֳ�iڨ݆ȏ�T�m �����S=���K��%��M�h`T�Zwj�Y�
}UK�ѡjs0�����OkEc�I����g!�4 �Y�cn��Z�� �\D� ��5����{p���"gxR�V�a)��t=�^�~�zD�l_;3�j�e �'¦��{�����SU;M�7a��v�O��](�xG�O���ᒱx�� �5{�+�c�q���@��g~7�E��9!4�ل��"����ΚO0֞��̸�Fb�&L�Io�(H@���/<�Yg7�g6���S Cn� C �wy�8�w� �&��]_�{�]7�?���N\ �W����"L��~�0G-y�MJ^�K�/��u��nu��v:�¹'��{�n"1�v|�� �P,��@\�U�eu���
C�D�H�o���d�=
�� ��=���L�Ny<����� ߎ�l��c7Aߟu����#���8"�7����
�x�N�5�.u�'b��U�������cp $7B�ͽu�:�֭�e���f�N��
n�����_���Mx�nsM��f���'��J� >3����bQ>�������>�Ў7����y� x��� ���s�Ќ��A&<�#�nĬ6$2� ��z�t��;�vg ��
��Ɖ`�ՓL �i�a�&��S��1����݊BCg{�0����k��9XÐnb$@]P7�Ě � |"Һ6O�=�X��XqƆFY��.GP�M8�g��O>m��|�r���<&�[�_�/���Y�N�R� ���/�̖0����� �UH�g����Nģ�R�mo��+�߯���;�>�w��17J
����g*M�|���� TԹ佁K^�;��$y �@n?º�P+�U��*
�,����ɉ S�� %i={qre�J�'S�Vn#>�M� �,P}��{�;|{�4��]\�i��͙x��e>} :x��_�a�����ʺ�R�50�e�(�Ɯ��@}*�оK��Y6���b&�o�)���wğ�!
]u3�{|� V� 7tY�a�W�SG���
De����5�o�����O��=h� �0m��� �D �OO��h����hA�b�U�����6u�^��/e���6F�i �����$���
�s��U�ʚ8�� r�o��։Q���A����a/g� �E�x4�G��0*k���Ɨ@�W^����
�b��Ւo ;V�}�� � ѷX����)㍾�S1۰}�{�����]C1����
y X��5�, �K��U�H�K�-f)m���ʊ1c<��X8:V����`*��c��w�%�k���:U��&���X=M�OP�|���9;h9
�M� �x���Y� tث�.�xDwp1�W��d�/�uT ����3i�R��&���K�4�ɰ��d��[�� �藷P�Ő&c�5TN| Q-���ͻ���o�Q�ϖX� ��Dt�(� �������d��Oj�+�z7� h(^U�̊�G�B4�R<%y��r& �# ף �� �*_?�8�o��v�q�Ɨ���q�� ^j��%��� qUm�òӯ*���N�Ҿ��D�4���8(�ˉ"�*�n=X�������D���ݧ���g���
e�
T����X�5n�#�P�s�A�p�b��x��I�C���h���|�Fyy^J�r�r��� K�*B߳���U^�� �JL@ 2��-��E��b�ܢ��2ޘlc�|j�J�_�� ��P�u%#��*�TK�̓�m��e�Rݥ�k9
�n�O0t�-U�IVQK�l��Y]ds�Sc��h��u�IwQ/O9�o�>�Tqn}��>�;��i���T����: ���Q:x��,� 2���͇Z!k��z��D�x
W�t旄*@ k����K���̈9"g��_� �rJZ�{�m˒K��&�
�o��Y�^�4.Q������T�Rb_������l!k�@|Ì7��Ǔ�ۧ`F �5�O-< �TBHٖH�'G ���<�)~ ��v �v��6��t��
�h�(����� (n6��RV��7�uZ8E_@�� u �� ~��_Z`���J� ��ᘨG���� �(�V��.\�zP�œ����p�9<;4Zˍ���iz���P���.�tG�n���wꇗ郃�w�Nޝ\���d~~w�����w��;L�0�%��W��
�;�� o�;�Jn��! Ur � �\Dڈ�qF"�1 Fl��iDX&f��aM�D4���t
6|_f�Z>)�(LPr�� v���e�g�,<��G�[����w'*bE5{�R��� ��8|���w�I�[�R��e�� 1�@E��&G_�X�f�/ �M᥎&i2Z�t�s�F�U� �eU�n�!�د�Y1,�L�T�1*��[���(,�:iߋ�6KHJ�O���E4�;+#���5S��M���+�OUgV����y�fW2]�gMn��xU���87a��(��_٨ �aq��s���a�� "t���� c�u������+�&,e42
��,�� >�1�/d��
��3;����z!ZS����X.��m�5��M/QJ�>X�E!a_��"��ć��#���*�y�!t-��#��`3��PQC�aφ��r?�����x vM<'�q�:�W�9��^UnU (a0��f��c�t��`��kߋ�4 ����eè6 ����J����@��ރ����ܤ�Xԅ\S"R:!��2���ß��b=�$i{�{�O���O��ˣ��Ѻ/�dp(����^��qzwlTFFbe���8�J��Z%F��}���C�^+���aǠ
͒��
��ϵ~i%��9� ���N A( ~5�z/���4F�}yyz���g� ��r�4�k(���m4!A$a-+�+��$.�7 �g��F��_�Y�3p�&�W]%8V�i� ���:<�4 GQ�+�O N�e�G�I"� �%����� 0Oy���X����������o>ȩ��ʄI������tOk| � Ϛ��!��\�}Hwc�Y�/�]/5� � �ud�4(q��Y�S�uT>mh�=ُH:uq���ɻן���Ӂ( �V;�|r��N�y�<��#3��X`���"d�ya�`�vI�L-�ð�!�K��5d� ��"�G6���^�\d~ p�x:Xo(���f>Y����(�|O�-�E);v�/���q/�(ψ?��A9��"&��덡�X�`�nTr����9��,�����_��3h&ƞ���/�' �aP�H���=q�]��T�ȖC/��i�b�1 �����ۨ�2���@��,2g�M�L�uF�"�}:�ƭ�/L�a~����,�[���gk��$� ���
�C�p3�LL�R�
lw�a�/jW'z�E���b���Nņ�W{�
�f�'��7�����.� ����3Q���΄���Ţ>�$>,��|8�|˝9%\VD+q�g;P�8���b2���������K7;�#��&����4�!�w��V �h-�Q�i�VH�on��\���SΊ .
�z}��|�G��!� �]�~�� �/�)~��x�����-=U���A�x��4-Zln�e)
�LK8�4���m�� �b�M�����>���0Xn���o�o�z+ s㽪�Y>���+$4��?_$}��
$u�[8&.1�@X�]���aE_�kZ ߖ�Y�����[�6����mA�U�xp���w+�c�!֨Eo=)��7���/��q���!t..�Z'-c�22<
��l\2ꅲ��f�a���Ȭf �p��1A���~��=�Qs����N��qC,���<J�i��!�M��G����Hd7� Y� �$,�`�����L�� }�I�o��J��Q�ޱ��[�H�
���7ßLС `�jF�`b$��(zG���H�I�P�b�z��Uq����F���%�ϋU�7�X�i=
�?��k�Oar�����$�ؤ^�^��/� r�A�6�կ�8{��tD���"~�7�(����s=%�W���ع� {0�₄ޢ^�r�� u��>B[7]�0 �� �8[���\�S�ޱ�3&a.�Q�|��W����\}�"N��7$y��:�i/���3*?��^�#* �Sb�&��u�Y���ݕ��4 ��|xzz���4��\|�!�".�7�����ܳw�tչ'�Xr�O�D o��q��
|�XZ�*���� Kj�;��_�|J�3�� xj�-I�
��z�d%��5np�^s-m�սF9QB+$�:!�}M�Qr���#�66���s6���i����[�8�{ͫ�r �h�֯ˑ�Bl��}-I ����(�!�'
�3�x�vq迢�������pcC���_��������JZ��Ed�j��
Y�����j�ue|M�u�[6cVZ��冷b��F����f-[Ǝ��J� ���}��>�W��S�( J�Q��}c�
Hߊ��D�C����xs����
�i�������n��y8�ו��=�s�7�C���: ���[��o贊/��j��\�[�@3�\���|4IZ]9<[����̤LdH�����
��}�Yg8 v��=���= �E���K�K��W"E9~�� 9�(���R A8��A%+B�^�'ɉS E5{��㞉�����?[ z�O��m?8��t����*@+���"(��f��jDN^rJ���&��ҵ�YY�>�Y�JV��ª� �2pz?�{�Ot E:��~��#�v�X����+mTBt�����t�=�p��B���x�nS|2bx`D�Xl +<�:�GF;^^���7U� ZN�W�X-����2 &�Ǵ�8Z�e���/U��F�����k�a1�\��$fA#�O�qb���I:�,�*��jH��8op�OD٠DU�t ��_õ̰��YEZ/�i4���h�� � ���=�-:�c�1�rnhXt�N��[ g�C�
�Lj��>u��y���j>ɉ˪�K��7{n�Qm�,=�>t�F� NB|�Lh�HC��3yZ�2
͎"~d�� Y�D�O�jw�j�Z;[K��c��?M�B�`&
���S�����P2���p�B���
?�le,n��E�c�*; ��$��)��%B�̗h�1����21�K8��<&nһ(��p�7R��Pj��\�毹=�N ��A�6i:�j���J���*���P��
��}^�MBH��� ���p2���xj�H]���)��% ���|ّ Q����Z8��Ұ�,Pq��7� �ƒo�#��Ē/?�f�H��V/.Lu�?��Q>iä�� ��"�H|��s��8��7��z�D`9��U�\�� ȶ � sf$I�ж!"ͅ��Z�d|U�1��p֦E��L�!�͢ D�M6�"j�z{Z ^�8fɆK4R�%���rW����Y=$�J�E$�,=6���d�g�d�z�ܜy4o�$��}*�Zf�-�20lw��j�
c��j{� ���H�[4
��&�d��v���˨T߽?=�r8_^.�fS���XH�l��U��o���V'1��vms"�B�$�+���z�����y
�뛸;���%��=Og�8D_�F|��};�l�Pi�i����o���04@ �3`�+�Q �4��a<��M4%��ߧk����|·+��|�/�p��V�p��dx��##VE˨ѤtE�X�.����H�u'ї<�R�����)Ԧ�u�A�q�U�̑@I�>tz@ �K��1k�\ֈ�fz�0�tE����S!���zj2�T����o/�ޭ`����8\�&I�a�ƣ�M�e,6�Ewyp���F��"�"M"0 �%� �{7Ń&� ����Sx1�Qu�r|n�ZbL���Zd���M�Iz5��\j�J|���+����di�p2���=�� ��E �r�O�5��~a�t��80
�6f:�l�c�[�S����A
�1��$��������r��k3� pX_7XN:-zwC� �y�<]���0M 7��8 �����)���&��9���3M@�����?o�(N�R�M����� ��.Gz�ML�s�������øM��5t���hu���8T���ܫ0������ETĒ�E� NSxR��G��^b� �����/���~�0b�0 4��?�h�c*�x=> ��o��
�a�BP�#@�m�K ���NJ�H<��U}B�$奱D��l�A'�0�/�RL�ۓ�6x�H��-D4rq�s�d��Zw��*��w����Di��'w� ��8�*i�U�8pҝ�� �)�Z+ɪ^���w$��+ş9Y�PKI�`j�{��E:ϪqA�WqH:Ϗ�Ĵ����Ҥt<\b��]9�- �{0�pa�4�w�T���G� E�Eawz�)�rA1��94ʡ���q�8w��y�da'��*"�1ۈI /�"��|5�����Wts���2xy|~q|txu���^�B~ �!�>��m?��� 3�G㶲�O���vY`6%
ϑ^�{��w&�� e� �MH�)�H
]~'l�ba]ġ^���c�T�ez��t&�&c�Y����k�k���4�-
���a��oV�E����=bN�K�(*J�Qˇ`v-���Hi���@^�-6�1�ջĞ�_�٫'�N�z���� �o��^.8�Ðk]J���.^&`<��sޯ�'E���l|ٟ7�-'!��g��D�=��*d�fp�&E���8kȆ�2ߴ��m����=/ݪ(u���$�1g���� ��K� �E��#m�����!�� ~� j���ܽ\pH� �0�_�� �����b˸Ꭱ�ˀ�5~�yx������s����?��<�#z�
�7~���0��c~�G�3��>��U��a1.��
�A��Jq� X�{�FS���"$��u_]o�n��.�=0u�ck;oc#4 a�ڥ��$����Ϝ��+˥��Cɵ3瑘��l��j��OV�pb3GZ��N��#kᖠ��}�Ko�+42R؍\�pB+ȗs�$d��R��h�
Ns��=�e�?B� {�+�N����r^��6~�_E�s&=W)H�p <�0��D������4����� � �` ��4�J��dG��~�=#
!�_��W�-}d$��3���}#W��$�I��g�;P.�wG2�l.���d# ��bԕ5�k{���Y}��_��dN!x�݉~�S�[��Ҋ��ǝG3�2SZa�u��ǽ����瑠°����j������fM,�Ȯ@g7��ӄ{���2)�2iB`�ϋ]��
� ~i�J�pNjã �߾?�:9?���>=y{r�!�|���v-c1�)�K�~����ow�o� �#��xA?��
�5$�U��{����8�Ϻ�a,��0 ��'*f}��3;H�6R�}2����IK�A�A�̠EXXh��A*\~H��L�������4���t��������9 V����g"uxtt|N�C����c ��s���d���Mo30�OZ�F L4rl*�Oڣt �k4���\�z j3�c� �-͌�%:o?ݒk��s���>�݅}�^�4�Gsv�^!<�y���ms�%
oJ������s ��j���HXOk���? &k뛨L6
?��4H��^�I�O� i@��xK�
g�v �3���0=�Ay xҙT��n� 3./N�/�����%a�%���旰ñ�������4�.M�⅖S��D�T;�v�ל����tS���y�{��XR�������C#พE�~�u���2o#&)�>�I�L\ngg��RXQ��(4:]4a��O�A&Wo2\e��2�N�#Wi�yRw/�n�;�`1���a[�9�%��V@�=�9] t�H�Q D! ��Q�����9�p� _�������λI���~��:�E�g�eF�jm+���<%��Q����0���#���f ���c�<�-%+��AU�DE{�5�;�>I[���2��ꪂ�3-W�&���� 1�����*��0I����w��Р�A���q�-�
��J<Q���Ph�7�!k�E*�l��,�h2��#o��WA�a��G?�'r�<�ưD� ��l{[?U7�N�-��"��b&����^�8��p�y ���k��&�O3��R������ �\�"��^�A4����-�u3}�O�{��H ����#�Ǫ���תq��3����.
�t��ztq����.v�PY��G�\���d���0yܩWվ�#�ϧ��1�;�;� n �K*B�M�hMU͍����
�" S"��8 P�/�EBnK��� *����JMZv&j���4�P�(�X]�w~�F$�_���QN&���{�-�fRc2����L��e���)���֍�#�� �$�qB {�2���5|�f�[Bdٰ���y�AQ����ʾ�X@��*� �+.��@g �q[�g�DD�?wO��(vI {�Qk�
�;�+��P�}�k�Qd�Yvxꏗ�G��Ã~1XFy\��)"|·]Z؉"� ���yd��X��$����JI��?��<�!�!K��b�D�&�
B� B�u��u\:��Y'ͽ��>�*-恄Vӕ��la��s�l�L�8O M&Ŏ@%��^��b���ү֔k� R����v�<ȑ:Q:�j��Bb�=yƴW��u�8 z2b�W��Z�ƙ�N�g�D�ʉ� � �.���,vv�V8Nә� sڤ�D��??S��roN��&����;��
.q�"�E�
��@�G
��/���ٔ�חeRs�VX7y���u80��u��B����� j�2s(E��ih�9S��ޠ*�9I'��>=�Z.�����������i���� L{,���]��U����5�j��{/�>[�f��+p҆O8h<8�T�,H ��>yv���HV��M|}@ n���z�t�h8E~��q�㍟��Jm=�kj�;Q�1��+��J�� �g1�;�D1���[�2h�|�a-쑗s64��yR��m)���y_��^� �Z\�.z��R��9Ѱ�k��w��.�iQ���`�W����2İ�똑A1"��[8�F+Jr�d�b�@�@��"~�^`�ё������
��籍 ����a�=��UX�O�:۬�VbPDr �j��� W]�� �z����&4脮C6b�jbU\B��rL�LP�C0�ۚG]W9)���}�֊u�w;{u: #��vvy]�..��2 ����J��& ��7LJ/7I�W�y�EV�+qE�&�#�M�+az�z�q��x ��iUM�Y@�',��)��.$%f�ޟ�b���di>x)|�����!��p�I�� ���`e,��YsKI���$��$����Q:÷���k�]�Z � ȔY�Y��!�%f��W�٭���h9u2� �ˮ`�f.�j��D��txV���e�RΥ7���b���j�,E
�v�NJd*����3#�K A�d/S�-)���6M��X3��=�o\�=�q��Js�]�}8͛��DM��)xN��8'�x�\�ڀ�Y��)��1�s:�ѓ8����Ć����KZ�6眓�����#���� �iI�3pDPU����| �K� j�Q�_Ei�L����� "kŊ@#�\m�'�������!��{D��R�0T� �����R�^�]�蝼
Q<y�c_E� w�W��� gn��OL>�uN�Fh
���Q���%���ׯ�.> ^��y��['����P��Mud���$�eh �^����<Ӽ��yg�q� �i0� ln��ݵ�>IN�M n�e�M���Ct:;m���c�+�$�\r�z) �fğh%
�7��7�����V�ik���8�=��Nk˙�P�`Zn�q� ��f�����p�
��*� ����� D�&y�G�ic�$�v��!�_�p
tW'+{�����G8%f@K��]ˤ�2zM�A�
!�j�c��-w��³D��zK�
�F���b� ߃�u�ۤ#�'1� {�;���� f�m����V�F[m(��
�S�!/0��Y����ܐ{a��c�aů�BD�q.�0�s(�����m�3�U�ct�NiۜҾJ�������YRzYA�q\{�ny���Q�[<쯿�m������r�� ��^ ���#Ӌ�!���ke�65 �53oc>��R;��dB�&c_����e�9(]�/�r�ܢM���G�QV�+]��:a��U�t�@Y�]Έ�w"B���y�C�����2�e�)�O./�rR�{��E�1���n�
�$��jdz�84.���
Pʾ0�$X���r^\��hշ��!v���Z���Z}��r���v #�H. �%�{�n?�0�Ĥ��T�&�9�4��T�x�iv��u�
[I>g�-; �a�!%�|�R� N�άcaֶ6����F[l��Dg�9�]�a"$@��Lо���(��s���1OM�A��c>9u\���� �د���7�$���(�M�fm{���zs�] �ɼ�v�<(�:�bC+��Of ����?
�]`�e�4fδ������?G����>�h��?�d|B����p��h L�*���-ߣ�W:q4 �V�-3����g�ط�<h�Î��>7�prk�}�w�'�*g�cY����`���FY�N6í���v+��A|�֞��69%��f�*�q(��\�E�p� ����l�_�f� ��,XMֈV��ҞF��-eG�5�Q8�Z�pF t`�N���+�[q^��i�T��N ��n�\ �{!N�����-D�Va��]�S=q�}K ��{�����K
�bw�9p)�m�Gĵ��� ��x�/g�(9y�z0�l�{m�i�.Q�t��)�$ ��Čh��SP�kD�B�$Y!sy����B�%����eWV��U����� �bS����˺W�.����R��e�X�������#A�n�~暹�>�������� ��A8��H����v:+� |��[/D= ��~*����IBH�
* ��=��������� �Oq�L�����=�0�������5x�K��sb��6��yb��~���Ü� *��P_�� QR#�&V!)J$��4o��R�ᓶ���i� �0$�����4�ȵ ʒ1S�E������Qqn��S6��lڹ�:�Ra����Y���9#:|M�_�L\�mHߪ�hՑ<�[u��4"��R���� �k;�%>_8�!2ޥ8�a�=�3,���rć |���ͳuy-LJMlP�a3 ���
.D���id
��7h�f��!
%<��'2��|X0�"���v�HnS3�s"�@��h��;B�!iwL�Ë�t�)I���Q͎�n5������e�W �2H%є=�٬��\�n�@|��k���iji �ma}���،<�R�Ѧ1�f�U��8�L� ��K��K�U��49;C�N�Ap
���=�l\���M�}
�ڷ߮� �y���.���`� ���L� �R�!to��U�0�����S:`�qO��=UQ<��� �� ���{U�{������;Vճ~�����ǭf�S{��:#�K�Qp�H3��cDSA�0�� ���!*�<b�.�"�pYJNO��u)D� �{_ �<����%� O*R��> ��)� j��T)b�3�L�qUK��^��)N#ʔ�.���4���ڛ\Fs\�#��� ��#�2Ѯ��ή�}V��� hd �s�� �;�w�������c+|Z^�i�B�Ϟ�,+꛱�H&��d��DN����%��% +7]� վ����W5~S3.����@Ԋ�Wc��M���6�,ʱ>9+��( }� h��+��բ����Ic3�;��5���ڛ2�L�e8r�u�t�yE�y�[�2�j��(jM�5lC��^h�&���zT��^��r#W�sE�Q�� NkŧrJ��F��^ P�y��8�E�Zjg�r)q�\���� �Fc�/Xב� � ���gjd-U*���!�B`Xց�N}`C�
�і �ɨ�53�U�,�d�B�Y��OTʸ�YQ�4GG� ��8��exG$0� ��Z��B�y�d��R�x@�Δ 0���g�!0����f���C�܀ /7�-
7��y��D��3�?���u,��M��l)���+ ��a4E�Q�o��9�f� �D����t��PbӚ�$� �p�X�i�
�t��Z4��;�D �e\���1�����pJ���,�H(wt��,�]�E�C�<-� /�Ф
Oz^�O��j!������]ArFu��b(!�*� �Ec�C��gk� e�cW�-�x,��1Z������ X��"�'e����I�C�v6� ������L=�N����+vZ��@��h��V "z�H�ۧn5u%z۞>�(?��!vv��UT�F�V�ͧ��G������4�X��SI�j���J��;l�t�j��OMV�)t`�qhOj˜��n
/}�X�+��WΘ7'�!�LbB�k�r����^�`�O� N�"����k�vxg!����w�m
¤��~ ְPB���^L��1���Zj���~��*u��*st�:�������?����m�bkwww{{ko�����o�"�-`� Z
����v_�^��� 1J���ܤP�k4 'ι
IR�Hr� /�}�%]�@�U� ��;�7� ���t�8����Y�yC�y� Q��za=��m� " 5Ys0�;g6�Wޟ#�;�|e4i�!X�v��,e�z���8�1�ķ���� X2Xr�7T��ɰ�$D4S��m��7<A¤�Q�Ѻ%?���� �����F_Դ<bD�F H��>�oa< V�
��(�U:#���[ƍ�Sq�!z�Y�H[,+��L�;��3H�%w�YC����`p.�%�/ v�g۰� ���ڒ��>^�٩�D\�xu�4�� �F�֗�"D=~J3��Ͳ[� �C�\+Oѓ�գ.h���&�P1����{����vm�C���m�a� �-� �%���d� x��Vm�<�V)�,W��W5�����6�����7��8�y+�����H���C�ks��(MC>NZׇH,h���`|$y�JO\���јM~�FtQ��+j6�U�|d��>��7�&Ѭ�]��K-{ �N}�-ʌ���ON�e���5IY��LJ/� Z��Ut�V.��6IG��L�/�- �iݯH���ZD/D��&�p�6�G"� �����zF�k�d�%��9T�ͽ�~� ��?�V��a�<���9�z�� q���Q��a$�4;�p���I���flu �;��ռۜ5j��S�v�� �(�����5�JZ��߃T�<C�j���.�C�&)�% � 2F)����&�^�Q�?�c�Zb�d�e�-˰�G�=搲H�M2߀
�l����N.��&=�!?��H�� �r04v(�%�d��B3)��j��7���#�<p��$�V��SZ��_#����) �LM�s,�����'a $��� i�j���-�Hy�{X ��Y��1��D�+��ɼ�� �+�˅��lR�Wh:��"m���E�Y��Y��
7�(iJ*�;�9���
�E
ݡ�����v} �� ���쬍�� �gHlX,,pD��Q+�Gr�E��7�a~�D�=4X3� 8�bz#�_qPG�Ch�oBV�78��?�Z98�����4 0���e�5 �%9'o��(��;h �5p5�[S;��?*8�=�j�� ��<�����o{k{�"�m�?������F#$a<���?6�#N2��֏6DմM�F�8x�o�c�ZA�n�؟9�a������� �3z ���H����EM�� �� � �j�h��y:,��ǺH���'^��Gk��cm�4����f�e2�3b���]ċ����fS�|^&�n��ل> ��o��m��&�R��ǜSp�9F{��� 1�4Bl����$�~8�B���k�n��8o �Y�;a�<�Y��8d1�i6 M�F !`�i�E�A�M+��s߽S?��P�wj�[(��� �s�y�U��ﹼM�CWo��˳WW /��G����w'/�_k���Z3�pr���U@-.�]���
��p��e38������epv�8y{~zrL���;:}��S_P�wg�HBJ�^��P�:9��`o�/�l_ �89=����xur�c�:� �YLO�ޟ ^��/��.�i��4컓w�.h�����4+� ���.� �������/.�Ǵ����2*������m3xy���5r�Q� n& >�9�O
�����
~�bV�џM��ŕ���� ^�\b�.�hx� ��&'���ݱ��S
J�OM��c���LJ�4�%6�7n�]�_� +��縟�o?%�J��n���m����O�*�o"/ ��g��:��k���1�����R�L�� �n��S�WU��ADC��ǃ������/�[��.�C�r�!��Ɖv��-�ytS-�FR ��, �+�H�«�xt3rQ�����4�
�M՚0�4 -k[��D�$���pҔa&�
x� ����f�P=�Q���� �
�Vlu�~2���b�� �?�
-1܄(9O``���"�P>D�e�`ĉI�X��z�T��! �8��l
����,�-�#
?��
�g�Ě 5�Zȗl�M��l��;���)��Sb(�s2n�6����IU} �g�� �G�Ԋ�6D�'�'3A�%6�1���?ڴ{|$��>�?�_Z��pC�k=�W�E�rFI�.��+4:e^r 2(���h3qa��vK[���b,�^��e���E�h����5�H��RJ�.W!��ɦ8�t��<��
����
����]�W�x,�hV�� s<� a()�8��k3,t5�O�i�S�*1�Ӏ�x����i�G�`��?�k3����X�4��f��ڧO
h�R��tn���� � ]X"9z� Аg�t���6�= �?���[��Xu�����톷h{b�%H4)I��έ��^e��G���[�R
�7���QZ_�8 O�loo3�h�*��WT���l�9�6DD�yU;PS����7�`�8��W_��<E��17�i߽>y���}�!������,xr��� ��"�I��H,0��3�'����\���ΐ]�g�祪ŀ'�y���
=���q*K�#݊��0{&�"�6�����ޞy � �**6��E��|}�m�. �-�v�6��>��i Q� ���~���D���v������M��XچS:�p�� $ �GvX˧uW�� W�<([��Z�p��h�}�l�I�Z� %���mDbRbpb���Lo�"�'6��9K�R%��/�ϙ�K��(K�Z�T �!7 ϔ0���-���F``����~��gj� �*)cNľS���0e�� �_\��n3���oy}Rŋ����/�S�D
a�����S���R�
�,B]�VT��o�� wo�$�Ʈ����z�K��^�a����ɠ��" ��Uk�fF���5 ː&�a��HQm|��U]�p�M������� ޏ����e}8|1���ޅ�y��o���+�����6�. ���E��,��xENv^_��У3�J�C������l�6'� y����$�/�-P|tM|�"�/�d�E���'�g���л"�&C^H^�"4���8��r>��$���zF�-I F"���� �]u�G� z|�"�w�V��4�B�,d�����M`��Qo ���n�tv��%�rũLj�P둊-��Hb��*`Ai8���f�"D�C��H4��-�� �Ec�Љ~Vo֞�,� �P�zyL��VG4 �v�y^��P�]�gS!�M��lqԕ����t�r��';� Df%��t��,{N3m�paND.Mo�]�X����>��tN��Ħ�w�i��z%�Z��^���}<m*��r�'?���z��M�t��C��u�� ���]+�`�ꤙ'��E��ͽK}M3k���R�y��Eڗ_��_-���Vp�2��}!��nuXg�m,E�� (����Ϛ��`"9P4HL�FlpPiR�7�irP�y�TN+%F��� ���:��~t8�M�E�lC ��H�hG��s��x�`������xdM� �-�S�i�,��N
��X�<����8*Q'I� q����X5
�$�P��p�`��>'d��AP�,@��GW�M.(O���y�}���/���b6��=��s+��� z�3-Ӕ�!@#�,��G�P��<3����8�����f��-���nӲ�e�h��4jE ��M��ͥhv��N���^��,Fy=f���z vA��p�4��6����_��}ȸ\m�͆��-91�YjRiIKJ�{NZ�N �5���)�ư�"�}���5��<uː0t[gT���b�] �7ժֆ~��e�-C��D��<����T3���@+q/g���"�4'���{)ih�%ʙj rdUH��B���&I8���n!�6�겎e��F`�)��o
9-+G{0�ജV�r�� ob" ˄[ޡ�f'2�����i�M��Q��
���P�}��$k�{YB`rp,u��ѰN�K)dY�Vx�bwprf�pۖMK�-2%��Py�K�״����\����<�e���(�2�^{����pk��_�J%/c�W��T��
�DSMf�x��c\�����_�i(�LwK����E�w� �|\d(��h2g.e�.6���R�\).
v�
�u��� k� ��X��}����c��w�z�+b}g�� ����w��q�]\�7i� ��BAXg���R���U,�{�uM�з���w��b�Zn�F��glk�)�0rIMn�VQ* ������\^ [��[Q0ǒ
�Fab2�ˌ� ���|��Tp�e���"�f ֆ���z:��L�˅�=:�� �����墮�NN���k�$f�4�4Ժ�B�e<ۭ͐+�ihƪ����rw�%�(�"������??��&'.�;���
N�34A�(>���j���oo���ï�,��_�e�4���ήOK��� �:�#��o%]���L�r�u+� �aWH�d �X���l��
h�0n BgHmқ��_> !���4�<\��Ͷq��b�J6op� m�����+#��3n���t��4Iٙ_����i�$����/��(|�lUSתI��mJR l]Y:�0+�L L�<���_��J��5
���z�J ����8I#[��7�W�!gq.��J���
@rH����O!�ϗ��.��T��xzI�E�(vNvi71>�;|���1�# kP��^,�j ��0xQ��k��lq)M���DqK�6>o�^�]�8Y6{
0f���X-��0ԖJ�q�T��p�h�6�~VܯϦ�����*y8��.�0���ۅ���!M �k �� �t%>9�h���kFO?09��5�p��DŽ���x� #V� �cĿp������-�wL��2�� |��߃@����0�
����O�[�� "� \�8\�sF��r8�O��p� ��N��
!����� P?��`�A?�,=��� ?�:��V}�?�m03�5r֯�y�ǘ��Q��� wH��r���H�Q��A��~G ǔ[G�0NWu��|�D����܇\0��l��~���3�\G) Ѩ%Fd�c>3�]��3�A 5ѥ� Ag>f7���� ��R��U��e�A)WF�f�]J�٫&O��!��JY
|��*�1��� ����bz%�J�ӕ���(N�X�G9_��?�9;L��J�^�I>��!�$�W 7����D���F��0�B{�/! �?��ߨu�! ��s�S�D3�[�4�[B�����ee��^���X?ZѩI���N ���9���B��G�+���c��
�� �6��v�"�t���i�I�E�ӫ~K;���� ��O��h } ���ī?��i3x %7qpE�����{�"Hܯ3��ǥ�~;�^�J'��I��?��H�Z�x1 ��u�� �"�d����9���y�*��G��|L�c�.�v �桻~���K��D�<�\ҡ�l�vrj��AV���!G�Oi��1�4�8#�2���71 /�b�Ѭ ���Fq9:�T\:L8�ъ����i��l� R���RL �#TJ�C45�%�t�̹p�)�Ac ��BCu� �1�b�_��Q�M���V�p�$�s�V��G|d�۠a�%
-_gt=S�C����Iq2.�F��"�g��$�搄��)~ē@���#���E��(w43ʒbѪhی���%�s3�R^���8���5�&MS�B�T�m��ۤ+�DT��f����/4k��T��u4U�K�U�_QdN��T�roìO�~�dK�J`5!�f�@� ���ъ#���h�]���構3�
խZ��o �P5�� ��6`�{ ��䢠�w� ���}?7+p0]p9"P���q�U�%��H�O�^hĤZ��P��h[��O�Ǟ���������R�������6����2c�P�V~�qk� d
KIbf����:k$� {C2���(u���Y��:+Z��dHٱ8�,���� <
���,bS�nXv�����8\�A�(Im�,����y�U
M�ʇ�.�Oڍ����8�s5T�16��O[�MC���%�a�~�L T6>�HH�i�������k�@IO��4��7p����Ʊ�Y��=ŝ�O s{�����`� 9J>,�r�q��"��V� &�mB
ǎl ��n/��)�Iٟ�)���Jѭ��t�>�K�������ο~�N��,o��8�hS��ա��6�j�R��l�`��Tlɣ��#�k7�-�__ ���˫��Wo�^~�I? �� ��A��������>�Z�ip
I��p|�p8�E��f�� �)?I�V�M���9�Τ9\������'�����,^𥉽�l����_�>5�a��Y�?S��nu��+���dY��C�I��%h*��dU�58ϣ�9xx{Ǻ��9m�)��mtUo��eiZ����܅����D)���ć]?��@��( -�zﱸC��DWZ �zŵk �ʁT��o��
��+�Y� �2�Z�]������~q(@�땔��n$�!��%�=q�Ӥ �z����!�$WM������+� ��]���(@yV�m?�1��m��¢M��� �{��F���A�Y0�k){j|{�P�-RQ��2�7��ޯ�P�������"8gTx%�a���6W�J ,��pG��`+�j���$��H\ ��t�8U��� Y�-+����Ϛ����@~���e
�I��.� h &�]�� ���({�<�
��0�ں�s7a�K{�6�=��}GU7�2\`qa6ൔ�rqvuvtvj�c��x��D�ͥ>t���fe�H xr;�3@OS��= K[4��=�ƥB�e�:�<�}��� ��v�nz/�A|���J ���, p��`���P���-����ϭц|��r� �������+W�̬N���4��}�������a����z��[�I�Q1d�)T6�a } i����5���s������� �ŪS����P��Y���:``礒�lr����42�� ������?ij�C}�;VG_]�
3L���75��3$��E|�W�ݥ>�'��5� �ؖl� 0,�jV���R�e���\��Ț��*�]�s�3� vUd[�rKj� �M��J&[�nxe�}�)�r��f& |�0����=���Iڞ8�Q���@n�o�
D���_��x�+D�-�牵m�IY�3�t���$���a�H �Y�� �z�&Z4�Aݰ_�=ߨ�����jF6ø}���1�B�ba�{�'Q���\��\nl��X����%! � �e@�|W&��ϰ��t���RD�����d�� Wo>zxsT xk�Eo>$��,7�'<�j���{�0,��S� ub�B��e\� ><�c��nΓ���tW�߆1,p�ټ]� S �Z�[ ����..G��$ �.�*7%X��}��vͮ��Gm82���u�kNG�QQ'g� t%� �)8 }��� g�r�#�kVS7%��Fp`5�&�R Ɩ�`�w�&�V8�����6 �H�ֲ�s#d�%����h��M�� @I�A��%,e �� ��Ǒ#-m�k"Ġ�l=���U��҉M��,�<� �N:�� X�`h�fPJKi(M�$R��Ę�i��Ge�mCJ` ��Ly$�!/�k���32UAY'�zS�>ā�]���/�Gc��吲� g� �(M�����ݎ�,����� 82ڔ��"�p�:3�� �h�a�!<Nq3��,��&c!��7bŭD É�S��v�VZ��20
bNh�7��� �x *��� �{}�F@h�'�*�6>�*��zP���z 8d�%�& (N�Jf^�:����� �vL�/H���G''���(��� �R�hn�z����V��5f���xy ��&X�y��Č7���p5;^�8��^��Ww�9�Rg���z�Q; cɩ_8������`�B}���"����ש��bNw��2 ����ՙ���?c�0�q�~5-����x֎�O��&8>�V/����Fs0 fI�jM ��݂E S;
<[������UU�Z�Ҙh<��Q]#�<rXz�Bh�h�Q 7HIЌ�K���m��tdh�x�����s
���!e�\��p�-�RF7��X�t�0�HL�����bI�m�몃����J(5���m�J�
� Y$��fqTOl������8[����� a�V�j�QS�y��#�@�Ys��E�~h၀=�'���� ԣ(� ��NM�R�RR�7�*2>+/��7QH*"�5�� �t\mZ$9Vt+����r���5(e���5u�n�o��%��*��;���Z�Ti/o���
r>���I�.���'µ>���[���i�,K�Jהi
j��EL%��@ s|��G�E]I�o:�G��<����4������G�� >����ӆ�zt�(�4{��h �$ѩ�F��Z��wAgî�8�=����J�%���pz���l�D� �S�QS�KP��r�$�*z�S��{��dI[V3-υd>D䬞
[C�0�П�]�� ������:hV���<S㚝�ٽ�(�VmYZg���� ����d���&$�8H�k����!� P�Tc3����2�1�? �A��#S!�G�
�OlbA+���Kf��s�h�v�YV�_fb6�����t̸��J%�g�)�X��Y@~"�<���e�\�uf1��p��H���3����/FΐG�E=�ʍ��m���g9�*��(�Y�K$c�*�ZY7���hI�ܭ��KP����u T
�fNkl�_�Ͳ�~KD��<f�.�d�I��yn�V�z��U!\���j�R���4����i.e� �)^��`���6��������8�r�ڔ@���� ^�w��Q��1��t��Η6U�<�-J�]b�#Q?���� ��q-�}q���y�.�y���bRN�%9lm�z@�woCੴ'_+n �p�H���J�X�����ܝu_[X�痗�̢�
��^2z�"m}M%a��]�r�N��;d�N��I8�j���y�w ��iq�МQ��6�< ls�'��ē���">qj ѱi��3 ����<S����JX
bC�k�0�,4=�.O��焰M"9%�o!)���
�[.���h�z�[�nA�+^����p�w���R��2�0�[4*9�<��_A� ��x�v-&��Ͽ��>v���}���W1^@�W�$`�8�X-��Ҩ�b�Y
.��R�*��T-��<�;Yk�彚�w)�r��DE
� �w0,MI(��U�s�i�S�@eGDs�d�vi!
W�k��E�+jx7�P���@�b� �űQ~�գv����`O� �IþKIH�N� G� }�
`" �捊˗�
�P�fm��j�< �%I��M �������(l9��(͡jMe���t<6NJ�k���'_�LXm����E����2#���ƻ]c�I �H�*��QvkJ���)/��-�U d��`��ƛ��]mV'o�tD[V֤�oGm�am���Y��N`X0n/����1K��̓_}�ݯ����?|��]���_,��(wTU���a�o��q5G�:N+
h�M��t]��7�����0��K��&�����?����&5
��~+ђ9�r) ��!������vg�%���n͔"�}}Ri�r�Fuڠ~Z /y1L��eug���XX�$���;vF@ !PNj�b�$��u��<K��7^O "�|F�t Z�ID��>A��g , ?��*N��Vz� a�x���<�2����\����l�� ۭr�{����a�2� �[1
3��"�1eT�Z
�����Fem�@""*�A�m���Q���֛ٳ :���g�.�a�*L��0�砤uG�t��� �aϱI/E�� ն �˻} ̩$e�%����ud�� cA�1�N�e֖��T���� �W���:˩ָZ_7Io�J"ր EIpV�M7�g��G�ro��XS����r.ڀ��۬ӎ����@� 2e��$��T��R%�V�e��3�a��ܡ�R5}��D7|HG\�R�P��'v,d���JR�#+��I r砬���ak��-��f-�g%�u=�l�S��5��^ ;�Tʏ�~���h�c?Q�`B �JKe@���˲���ș
#�0�N�F��m6
5�$r���^u��In��� ���j2�[� o�A��pD%���
��\%����|R�ȥyA ����N�vòdK�Gk�H��J]ʍV���4Nع ?ĎF�P�)��;'9ǓxWd9�L� ����D⛥�8a�˂�ړP � >aJޔ=��#X�i�����蠤�p�XqH�����.�U��c҉k�l �3i�&l b�ڳ�� )C���֙��e�i��U�:ް JniL ��2�e�Zz�� ��ɺ k��ʜ������"<�%!���g�NM�5�o�m��n�D��ki$��Me!���� Y�ӓ3�K� KXM�i�1����ʫE��,��B 6�MtV60���ES��Ͼ�� m0Iγp$�WZ4fl�M$�M� �y��h�i� ɳ/&H�p�
QtBP��ھ�V�t�M�)���L�m���ٲ��b�@��9�����sg�x�c��!��A��jw ��8y\�}�і ��A�3�5e�Bs��?/W8�{��j�Ϫ����]�����������M�?Qm]�K���i�䀣P}�����@%�G�G�I"�����t2 �� -q.�6Q�ؔ� #�d�� �,W ��x�)ߤ��h�"ڧ�Rs�)�LRf�Qr��̸�K
�Lz� ��Ot����!ي��ca�Y�d� �#�Y8/R��2YB� m�4ĭ��F�b�K���#��xɏ�-+1�ޑX��M� N�˂�n�%���}Mє?n4dK&ÌYnp��f��d��fO�\+�!��<K?/l+��z�_�
5O�i֗?+m�}?m#V�x�]lC��Z�
��r.����zK]��re��_K-\��!;�����'�-7����KL+�*��{��6�,Qt��S��q$Q�e;��1��Ӷ� �L�JI*��B�QI�3�� �7����~V�$ '��g:@ծ�_k����{�����=��@ՙz�Rd�mf���Vi�T����2i̥�z���n+I�U�*��6~��_q+�f�!�O����f��nL?��l�m>�4�o�w���vE��3��F�`��"&�5>���$97
�w���`�oO
�b~����R�����uE������f����I+o�� ���>��&�1��QJT�L��[�F����v��I@�/;�k�r �Vs6`yM)��nF�-� ����c�N���NF����k���u���,���K=�,�
M�� uD�W)h̪!�5?��DL �J.���[�T��eǘ�f�T�f;]tP퍽������U�G��o-���S��>=X���e�� ��T0��_}�� ?\{t���- �&�9_� �E��Z>��N��>����K,��(p�Oyp�d���q�8u��X ��_���h< u�
�n\��.)�-��� �9��6���#����>����i�@��y' �(�1\����\�C� %$췸_����X0b �;C��46��Q���j�<��@�`�IP ǟ�͋FU7;��BmW�&UͲ=�*6���jpczdR ۋ`&ݍ� ?х5���:��S�/��ߊ�����C��?Zٸ���0�W��fQ��
�TBZ��G�z�_@��Ť�'O�����[�����S �C����=ET��頿����8�p����`�G9P��d(�>7�am:N� Tv;U��F�V2=5@�o��c(��w!fJFk~�ȢswhX��@� Ͼ�v� ��������ޛ�_ۿ �� U)$�y���r��N��c{�����c��!?�����p�|�F�i³(�O�);FpSt�k^.�'i竛f���G� ���x��������kBk���࣍[J
$�۲y��� G^ ?
tE��, �z� ����2K8�4䋨
�b���5��R���V~⊑�� �$h�E_�%���n
G$�Yl��&H�Ж�ގxX�~ҷ�(]w��g�ma���> �
�b���D!�扺�j���P�Wu��z��yw�ޯ �ԃ0�-,�9��[��|�;)pf3����!
���N��V�~V����i7�7GW��a?��F1��D���r捗]íwD�}��a��V����z�`kK�ydQ�^C6/��U�u1 X��Z����,܋hKz�Qc��x��̓���"e�����#��_�gm��f ���+������Gw���-�ư�y��l� S��`8�Z���N�@9X�ʜ������j��y���@+X-R��� [����V�M*Rv��!=�ee��T@��?�����|��_�
�%��#�@)�J+I
�����x;�V
�W�/�2��,�g���6����f ��d��M�*��R��+���\�ps3@/Y�v�Ա�A�L���Ax!)k�(6_�\��J�f�X=�N��8 � `o�p�i9)UB��]21�W���<���W�"M\H�Bu�Ձ̏���*�צϛ`���T`�X*� ��q8X �ş���Ek�v��8���,��S��Z�-w��l�8�6�{�0 �h�NMm�v�lmM=x~\�;�u{w�c}�c߲fe�� �!��I���B�{2t��Z���E�O��ij}v�� ���B�-��#�L)�& �>֏ � ���8 �8�
� �� ����#�k�P�#ӳ+��j�;�Z��^y��f��?}� ��ՠ����Ʌ�Qx�M������l���W+u�͌��,傓8=̀�B7�K�jۭ��?�W��*����8^�7�s����Z��8��"@�"y�C�`� ��q�IJ`��C
�ڪ!6�} ��@x���=��Bo�CE a����(��ر��@I>�l-^��P2Po��`�y0�
)�7-�;M�5 ɔ}�%FVAF\��G�5��-o��c�d���u�o#����}y�dͥ�)����������ݟv�켒�� �Ic'A��,b���``$�)�$&g�;�Q���O��iQ(� @A�r8�;�f EQ� ��
(�Ϫ�Sv��a�Zl��������Ј�8ݮeW��A��`-D�T�4�qŭ�<�0@`G�Ӭ�הp7���B-5�F�a�ײvhJ ��R:_؛�9esۑ0�v�~����%�t@��k
�X�ze�p?�C�~�\�<8�4�g�&Cz��VPD��Ԃ6�\����ǷP�i��J1F�� mT�\���o)MI�^Dp�,�_� \��&0epy��sN_R 0�-�<�p ���Bj�I��d��;.g�� w�; Z���j�����.�)�Nl��8��WnG\1��Fag K.�"
�2��Upn��uo��L��^ ف)t����D�=- ]���4�Z�\�lJT��*�����I�P�%���}��S :�'��롋T�S�,�g�;�.�0'i�̯���5��U+ut<�B���|�=���� 7�֬�t�A�{oaTU��Zt�֨�Vp}�Z��l��<����t��m��F�@� 7�MӘ��~Y�?�
��L�]h�RH�B��{��)������珙ƌ�e��]�xm-�����9������ڥ�C��{*G�U�a�#����`8����M�fQ���<*&�S6��)^@�Kد" �sD�/`y��!�"��E>�P��(��"4�u� u�)�p�X�<��9�4n;U
Z/� t{����v��1~G/Q`㗨����ptgU�P�#����"��ǿ�WS�X�m��,� �4@��W=���� �jV�Ȝ��s���� ��N8��=��_{�
�8��RϿxj�$�v�;�ڝ��i�3_�8�gee��|�����O�W���hP�# ���揾�����û�w��Sο��������q�ww��s�W������������οI���l<Z����ο���C�b@9��د�|�`,U�R��T6pL+N����`_N�[�R����\�,6��9)q -�I�rLI��A\T
K�0
U�� �l�O9K�N��0JCa��g��R�T�^�S�x����-�]=���
N"e�z��`��{0B� �L.0��8�j ��ی�����vM<NPՎ���˪�� cPS�N-4۞^
����3�0%��d���&-�"��ͱ���#.^F����E�̙�/8���D-tn� �a7>M�&҇f�#��s�Тw&�k[Y_��:T���Y�lm+�L�]5�R- �� �y�ȴ.���� �d#���;o��%�^ k|����b���Q���3�=�&Wȳ�𬄝�e�tf~k,i
�^�����&ݫ5�"SL�厢�[�l�۾�� ��$s�sھ?"��mu��c����w��7p����Vͳlؖd�v�~�6�UN�`
O'�i Ԟ ��sm�!t?�
4�\�F�y4J�U���i3X���h�D��3.�Dp8�+,����f��fg�Jon��qM'lq�fc���\ G�lgE�5��-R��][�A���y�^#��%�v�J���+��C�&��ǃ�ۏ� % ~� ���4��]d��g��iGս�V���_eѺ��o�v3�O�F3�����W���q/M�"C�Ǥ� �D���K�&��.0�w�Ip�Ska�"EJpnK�9K.&G�Ӄ��T� �~���@�ŹVe��a��`�C��&�e�H4���ֿ�~�yy��e�r?�Z��/w��%�˓���ˀ���\��H���E�Ώ{�ч���n�wRUC�� �E �|Ҹ�L�4V��NJ���0���T,#�G�!y��4���� �F��*�
���KN�C�5�EB�n(�� ٬q���W D 9
q_�Ȫ�C.�� 9���N'�.��T���Wan�q� �P���<
�I����ת�^V�b�3d ƒ�>G��� �G]�'Y4J;�n-�hx�ee��E5�>�D�E\#�aI
,�;@|�rZ��:�D�J�<��L���@M�.zn ��?�Qf}2!U��q��g}�&��ʞ� �qd<#\H�yc�\Wd��Pl�|5��!��bUѽ����źh�Y�֢�á:.�Ti�UlZ�J�l��Z��"��W�H�j�^.Z�B�14�� r&}i0 �R��@B�=���H!W%H c� ^�t�o�w:@X2.m"�N���~ϔ� ��c�S�+��O\ ��.��S�>��_p�Ʀ��־��d����r.�+�{w..\�+���[��U��73L�};���i�@'M(�w����p c�������E�|Po����(����+'�5�E���� kzrmp LC����[�;>�>xv�L�"�!��~>x���9�}U��yz�!�^�I�q�F��1B�+�+�_鮓�F��xI�B6r~�X��b�n�hX�W|��G���`+�� �u��b�s�5�_Ag ���Gp �j��������o~�h ���3�\UZ
m�\�R��N �V�ZLu����H7k|�5���j�W
p���%$�`po�!�Q�ݤ�3�40��S)ukb.\�QR=���hk�L��*Y� X�leI�̢�* �SO�D�i�*#E�(Q< �=QJb��_K &��J���ib���"WՄ�e2{>E �)z�$l+� � 6�O��X��X�c�"8��
cz��yFl��}��Vq��$e *����
_�^,u�햺M z h4q�-����zW����/�P����S�rj]�Vz���E+ꆫ�f�y,Q���d�x�J'��Z� A5Jʢ��j̶\&*�P\A��b��J�Rqe���M_X�D�_ ���� �\�h?���+6Ք���Qj�O����(��c�YXXB�!�Wu5p��Q:�딫�&T��t�(hAK�[M <J�$1�ݰ�53��3����/Xa�DM� �gHtcs���>��Y9T:��9�)�3��X ͧ�.�Lѭ6SJ����TU)6��wY��E�4)u=[�>m�*үϬ��1<���xi�s:��)=�j4T�S��0,>�E�ʇ�����h�Ηq4w�h<Ż�8�&l�(z(�ʀ쑓a��)<���7d�"̤��^��3��w߹��{�c�ϟ-�ú���>�#;��]���_���#AX�Z�7h�#^G`w㓴�N.���"�D`�*�/Ea8��XX{�fp���*o(2RϵQ�6- F�J�&R=����.F�VK3Lؤl��!�<��9?O�q��יU'�m��]B���W���KozXx����� }�UV_� � p���C� �q8�rnen-�M�ns������e�����T����-%K���iSL�4�isBdkFHSrUY��4J�F�r�q��1=�u5 �[��p�_�m�P�F��_$1F�V�yB:zZ�钙ƒ9�g :.�a.���MJj� 7*�2�� 5�ښ�eKHm����s�Z�aX��M��D:*9�� "�7=�[� i�o�'G���q�(� �9� j����0�:[7��Sq{:�~@���#R_�>�g"�
�څ&�TH��pJ�E���t���k���g�� ���_�Uz�o�����N]a���HD�M[��% �]~&C���%��ğ��(:��<��9�T 4��b�ܕL���)?4}��N� 5�
ws� }.�mI\ 5̊���a2�r�c�������J� T���R���[�R�F3i<�T='XJY�m&�S�l�;?�����X����b1�I���6ϊJ�H qE�^ wr�
1Iؾa
;��P���`�O�E�52ۀ<���j?�4��B����.w? ��R+�a�"G)q4 ��PS�R���o�-�V�|�����������w�_ߤ�Wy�7�&%|B�$;DyH<���d
K}� ��u�n�J��ace/�A- 1�5H2��Al2O-��I�QVK�`�Rq �V�c���v )հ��$��dig ���
U��e%�([�x_��ݣ ��(([�����=��գG�_v��)ܺ r:}�T��H� �p<Gy|Ʃ�ic��8�BO#Y�83&he*�Y�h��瑂�[8�x�GT�>����w�m�D�;��odeOҨC L/��;b���-���4�!��L7
�J������^� �Oi)-����fR�F�~���v����X���|v������6�Hh�
=���][h�E��^.��7��%4'� T��3G7�Fjhs; 2G��?U�o��C�4o��j["��mz�{G�7𩽻��B��o�ς,���#)��Oؤ"�� \��.!�;��-*�K&%���+=�ab=��#ǭ�ǚ2��զO23&����k0|���<��h\�D��� `��9�L����$���&+"�)�
{8$� �7�F�}ats��i%�6�0��n�B��y���nb=�#'�$�X~M�<Ź�I��Ț��5�����1%$��F���ZA�L~� �ξ�;���Td_q��f�%��Vaˍ�1�Ș�1+·�Y$��.�@jk]��X�W�
�����7�[Ji�-\ks�W_�N�)��&�p�|���ƣ�|��]��7��`Zéu\�1���.����o%� ��R�G�0;j� Q��Ƭ �i^�+M�
;�%C�j�W��� z)�|�B�� ��d��%�@Yj$��FH��]� �d:j@�_��1q��U�8 cf��h8�tĬ�"? ��y5�(X�g�d=��(�NU���)�t��[�&ر�elb�e�Qeˮ �!�Z�KyO��VC�q#צk �]�#�#B�<�b��&
�O��<@ͨE��}Y`�.F+���w�Y���/z|��
�j9�k�谽������C�Iz���
��,^�뛊I�~0Vv�\�sWcSX\�ݐW7h�I�B��A�9ڹ\�qr�o�[SD�� �sXn
����� ���q�^���� ��S���s_a�j gn^��[�����8�w�]��G�
�� ��䐾P���a�湏:
�s��/l�<Ӂ�^T�I�C}ԓ���v|��9�K�..�S$�gd`˘H1nk�*#ҤR(�=:wy� �oq��&��zET�PL^���7��2�Ue97��@��w}��諒��cf{U��QL����?�I��bDᮔ}Ձ@̾��;F�)7�K��!��I@#�
6mb�Â_��
��n��n�+�T��w��jQ>5TD��?�ش�/B�`R�iγ�D���0�>q>u j�n5\��P�t��b �]�_tD;���&� ��Pvs5\ jɐLf���BOW¿T�<&���'lkCT1+�k�4dz��!�)UU��;�TU_U+���9!AV~��S�tP��Ά�v���%�NƆ��{�q��|�.��PgL����w�)���\.�V�z�h
s��Ϡ�|�a+J%��|��[{��v�p��ޫc��n����ể�ϻ�/;o�:�7����t~�{�KH�axD�]p��1 ) ګ���_ 7:��ys���~�l��jO�m0�TV�j�V_h��ةY�ku���[ԇ��.��Rp?-���,������i�
�� (2��jf���Wr����a�?��d+z��ĖY���E����ijDYE�)�n��t >%�^��j[��0q�����B�7G��j6�G?��Y��N�������D���|��_�بRSib ���n���{x�Bt�
nݽ�
8H� ��h,� �<n�LN�p� k뭇߷Vւ啍����S�0hr��V��++��� ���g�
�r?��T��}��~x��yAF����Z�l�����I�Atx���o7t�Ob׳6�1!혫}�w� v��nW�v.��7/�*�Q����.2m�c ���iK�E,��D��0���/��_� Q2m{��p����%��%+�݉�p4EKTAk Y���Mŀkn�] ������.wG �&���:1���^�)�6�X Ua l�3p gYt��3�-�BK<2}�h!��u�u� ��P�"��"�OV=�l��2�jC��[(���n50�lj�>��p��Z�ך�A6�E��n�=��n�/�� �e &ڡ�p���Ԣc����ۉ�T��ϔK�2ݍ�
�a ׯ�$@�-�$V[qCA���W
u,x �l� �{LG�?-�v��Ke��3�D/gv��K%H�Ejˠd���W�U�`�\u7>��X�m+�J:=����{��<�H9
�\���FA/20���#� s하v��䆠���Dz����>�JnbhdQi v��vD���ߑ^�� C�3��p|Rc
�X�&�SY��_�ƪ�n�b>!�Bkz�����*�����_Z�_��n�?�V��;��b̿�j�8�{��� ��+�ı �*��T�����L_Oγ�bD��h% �+�$�<�.3xa6N�M>��Q�6�u�~x�$?��g�����?�Ti�K�M��� +�U�m���� �-��w� ��U�(���d�ĺC77U�.�4W. ��}⇒ o�~�1�q|Q
�b� FR%��O�cY� =��fA���(��
�x�8���Ǩ�EV�Jw�N%��<̈́�;�"�9F��R�.C7J������%iu���V�/lv� �
�_]��ӛ;����X���'�z��Q���õ�;���T�w��Bc~<D�'%M�yPFe�wr�<L���9���2><%�m���F� zI��� �8!�=�bH1�+�����
�qt�Ӊ�mӃP�
������Zu�}�y"$u���Fq6l�� �o��'
�� ��xf���W6P` ^�؍{�� ��d
^�*�%�pC�G�!X�T�ˢ�
m�Z�t��i�/�� 3p�
�L>�(���q�y?�ЉK^�- Ń$;K�0���k��SO�;��)�¤K�/�`��9|���n� 6: уe�˸���ED��V�����W?��/�$I� ��w�ό��Z5����̄��RdUBy}���������×{Ϗm�*��/�e{�y��B�@�"K��� �?��ζY���G.[A� ��z�l��q�f� �g7c��^j5��ZG<:���Y�ϵ��0���{/b' k;{��'[��/D�ň4e�=���R�Lh����Gt����a�H��lqEl�Rvv_t��iw@�|�Ҳ!��ٮ��s#�E�55����������睃�7��U2�|l�褷��ښ�Ϊ����7=?|ѕ��''�r�_ �����zY�h���� �]]%6�w��em�i�W���cec�f|�$o�S䖭�� ��i:�B4����ӓ-d�%�
Di��T��Q��
��á ,�{�S0� _��^���(��Ț#�>���h��|�f�Ǧ"�(�π��n�"�m���| ��8X�K���`�8$ ��u��XUO���
ٍ�VD��!��L;O%a#��JKɷ,OՐ�8��A
�{��Ȋ+x�w�n!��J�`>�U�Y���AB�1�[j)���,�bz�@��`\%�m�!W���}�3��܄h�z.��(��w��Y���� ��h���X�G��|�B�21��<n�39�s4��`�q�3��s��s��O+�����z~��!���� f�[&�S��l��u Uj���r�P��=��ϝY�_����
�l
�}�Y���$`V���
_��p����&Ͽ0Q����oY�_� j�f���aU�x���o�U�'<WZ �[m����]����n��j@�Cld��F�Cl_��98��Ī��� ���>��y ��6,��,k;������� Vd ��~�|�_y��<{��L�Oc��{�y����Q:�>\�Y�r�,�f�x�(I4B� �7 e z�_ow���K ՠ9t�J�? �`� ��y b��리
�Ɋg6�]\TI d��0Q� �O���;�~t}�R#�3B���W��6=�_i��;
W�W|���pw��>�_���7���+>z�� �#�Uf�����W���a�ϔN5�x&�$ht �%� 9s�jU}v�~�������дEuy�l f�'�#�W{?��ޟ����W�o�M�*^L�����< r�� �YGm���B�.o>�����>oS�O��g饘��p^���n�U� α�$� &�A'��} �/_�o�1s�Β�� fm�~�~��?�o?{��6lγW�?Ž ��X�j �߽:�}����� <��o��O���q؝��Y�w
�(<��yv���K �ǝ���tX�9x �
���=x�~^6 �8�3;ch�w:M ��:8�;.�:^� � fC@)���v��Y �HV ��l t�s���f�C`J_< a��S@0��zn1} ��Q8�<�0�7
f[��4��>ow��w�}��J�8=��B��(飗hr�Ŀ�:K����!�
3�`� ���G����I1��,n$5��=�P� $����^8g4���p̰�
:I>� r8�P�����l�������2��Ê�yBN��� ��� �v8+ 9䦹�#\�:��k��_�t��_�3���t��U@���#��룕G���3�G4+��l���I49 �FA�J�C/�&�);�
'���:h�Q~�4]ڂ��rD�� �l*b�Z���?vz[���c�9 L��
h���/�9:�\���67G)qF��1e�~�� A�g�����-����:������w��o���� Q*�O %��[�)V���Ϩ�
��;���dETYޤD�����| \w��hj��E���=���N�'ϸr���T~� d&s҃���B~��e8FW���C� ��攲��&���hl$�K=!��J��J����(c�\����1� �� �=u�Q5Z\p�}u�.�V���90,�B����ڏU�?��8���`a /� �1jp�z�����Yv#���D�]R�N�\(YA���B��n�V����^M��5h;�n���n��Z��)'DH�������;�rZFEG��*���V�P���8<�0K���5��'V5�, ~�U8�Z�!0i��eB���� Q�.7?У'��յ��6�; �� �[��6�&N�W�ů�:'��
V���\��Fү�a�S<�
��l�~߂���E�����e��mf���d���_�$����Q��hPd��!ؚ֪��j��t OfyV��9��L�u :<LP,�� ��9�����0]�%`Jҋ3?�1����� ��2��,�S��4�#�A�FgJUcH�x�S����8�y��BVKxY,�G��*���x*[�n��X�8l>6�ep��w�n��[�.��I<��ho�w��E�eƩ���Q'��� �L�����7ucUY���x t��ŰG��v���W������y�)�u�C�6
�n�����Ð>2���>�sbV��+��6��ߕFEU�F�D+�dy������D�i4�ھ���
���|�10�Gkl�79!E�#@p�j� �LՓ�H�q _Aqgv�禎=�w%ף���QQ���Ƴ\��)��ZT��r�k�n5zJ�IֹO�+�~�� =ё�
���g�^���k�Ю2��]��tSN�
�������M�2Wq������r��
g���\��͑�\��_r:�`p:����7P��� f�� �e�2�c���/� 0�{���hV����U���p�L�G��^��%�Ճ�Cd��,��AuH�l���}��jgem�P�<5y7c?|�� P�/ \��~�Kusp ���;�B� �A�h1z!�[�ުdƔm���:����KCw��b����2+�9������R��3��=�_M��O�{ Rzb�1!�iW�'�(J>ə�x��ҙ��d<V��))=������������Am��~��tr0�a�i���Ĩ��3�E;U(� ]����� $�� ��/��mÈ^`
����Z�� �v��\��o�v��;�� ��#N�uԯ9G��\�4 �/��
^2��Ȭ���9ў: �� ����h�C>kpO��L���?P�L'c� ��'�}e`�W� P�W�� ''T�5t@����{�j�ݫsS��-��b��Q�0�����R�)1�H K�F�� '
_*�Ҹ�i�0?i�*I��l�:��j��iyK�� N3[$F�r�f�5�Q�Rx�]-SB2>�pl�R��D�Kn�ne�l���
�}�R�Ҷ�r�+��`La� �O
�P� �� N�M]h�p� �'d��,\.�R�e�ܻ�� �w����gQ֡ut�3�M����/� 5������q�^8S%H�n=�E���k-[�� ���S |�ȫ��&�C�H�� �]Mو)��A~�\�`W�,,m� ��q�9�9��)w������)ȼr�����J.�c�߷d��"]�z� �VE�ϩ��sq /�G{�p��;e� P�n�jm,��t���@��ޡ �T= �{)�o�s�������)�;��{.��{R*���Sl'�&�0@�(��a?�$���l$c�bA!+]\�ҝ�fl�'J����e�Pt��<��\/��7cQ����~��Qo�9 =� ���VM0�'�Qp6�O������f3z�� ���M��� R�d8� ݪ��8��;?�;E�އQmn.ヅM\�'��mO��&pO��a�o��< Gd\&Ap�+[/mό @,Lj���d|��}%h�l|� �$�m/��/�>��?>k%���?B\(x�-�Ar? ��ɘ^��4d�&#̝Jm�CC]���D ?��0�&����f��b9��l�~��#��&��k�w����o�g�������'S�Zv�f�PIlTC�o�����{{��7ejNM��&�%��Bu�9�BE(�\��d�'�0i�S������$�ϰi�ᑊ @[{��o�k-.�"2W�U>�trv��^yZ��f�!��q.�. ���I����5����պW��� �����ܰ:9��8E[O}��U��:�ؓ_���i�}Mf:<��3��0��)� ��^@j&�NQ�Hq?�|Q�Bd� ��m�Z���dN`�Ѩ�뷚M��f��J� �UyD�����#e� ��a;+����Tş p�RI�Q��G۳��Q��* X����"��"�|��;��Ŵ���"tE[� QP��pϫ����a8 �/�,@�_d����M;�1��a� �tX苼UmYtK�x�4B�0���S�G�u��s�5 .�jA %�8"��=�#/�+�7�h(����U8�1l�Ar� ��sD�B�s,(��X���Hp}i
��� ì��*9{��\e�йZ5ɛ ai��3 D|���$�H�I ���;�{ :ݨߑ�t dz�0�n���C�>G���= �t!s�SF���נ'�-�v
{��d�wJ Iɓ*#'�n< ��3;w ���|��ڔ����P��� Є��� &p 9� ��
��9��oS�az��F1R��H�ә֕O�R��B � ��T8� ����S�7:���3
6��x
��
[w1��j��jC�ٍb5!��)4�۵j�Ξ��{f�< ��Lj�6�9�H�:�� ��!��
9�Y���8�%k��c� �Ƶ�873!�/� �4H�]��HF�Nb���l�F��>8�v ���Ʀ0���ߚ�J�z��a��y�;E #�pЊ�ҟ2gs`���c� �|�v)8ʭ��q�yA�$e�Z�ą��d�$%��U���/?X]� �77�O�ŏ��X]7Ѡ~T�FTA�yQ����0��k�L�5.jgH?_Ӕa� k��gL���a'W2���[� ᪘�o,�)����rP���(X+���2��H�� Gpr��"��[Mps�*���&� )��p�)�Ѳ{!��$"����K���h4L[���=�FC��jo�K��'�<�K3�3 �b�n�\2�-�a& .��
�-' ��84� 7��� Y� {��m�@�D�"B 5�m� �����ϵ�
�.?��u��CJ<��g�&�Z{+7㌾��f�)��bK����8��Ʒr+ ��V#�4���y$�[)����� ]��H
�z?\=9�6�U�v+�D��I�Y�Vo�7UoV՛c5�� 4�MΣa�w�T�8��dM��a2�b�7Sʖ�2!��3�rU��X r��|4�%�,� �lV�[ _+�����ʝE��������3�� ��7���}[��~r
k3;�֪_%,�һ;1M�����&6UG��n����� ��p�p�b��ݼ�:���jU��Er"&2��۲f�Ge ��1G���O �^��yv�r�b���Ε����d��nf�7�b6��tB���b Ɨ)
q�����R1Z*/��Ӓ�5��Oqa8��ui��ϴ����1QrɄ�dDU�t�3y�P�7�a�*_�㴨�G����x �p�M7���(&�<�h�b�0b�xL�R�(�h|�F����w�;nv��9�*
H� ZZ�-������),���ߪQQ�ޣ?6���f ʩ�8�҄ ��F �p��K�?%9�xɿt��W��N.��A�k?7�I��n*��� yfF��w��� p�ӝOp�}"��� ͉�� s{�0 w��� � ����f�v�����`5�+I��1@��������w^z ���ݕc�F(� 4<���\��0�s��;k �ª�l=�U��4�s�h) � �-<�?�o$� �^\[i���
�o��6���I�;�ku��F.���;��o3�˜���^1���hw���<M?wыG���D=2�:E � \�An�Ar��z����u3K9��+6ũf�1;V��ߋnD;��G��r`V1�I0� #�YW#k(D H���=v�C �"]�Gio�C��j�8"�j'Hq��4�dަ�I 3& \
y��* l\G4�n�� A k�d�{g� ��
��������3l��"8.U�.T�+?P���kx�ƒ��.��L��Fxl'��dDr ]�Z�����A�GwU�>D2sY�|�� �r�ǰ�
���*_à�O&QH8�˸K�* ��Y�Wk�� �ݞ��O��(ҡ��*�E0a�{`���s���3�� жdc�.�|2M�%a ��{ۄ�j�&��õ%�G�pL��0��G�q��L(M�1�K��Tec��e2�Zs�co�����1ۢ6��m��w�r�ݫ�X�d�d r�
E
I`E���+��R�����CL.?*�̮���=�b�v�)��]�J���O2F_�1�H*�ܔ&i�Cl���Ў7R �$�+�5�=�/����7�#�{��Z��c� H����U�3��x����ݒLB��ݕ$�B6za���ЩV�i�� o�گ�B�t������� ڷ��m2r�!g�k �u��c"�̠�/#U������Q��rz�<��*Y_�ь4[���.�G�
pjdy_k�@ ��Z3o(b���q�WƼ_�����*Ulu�i>2� f��|D}Fn!�U������=1{ĝN�Q4 ���p��ĕ��*-��UI-iVԄK Yc�Tn��1��5���,o�Gq���jdw��-��C�"$.�#��}FCu��hfHь���Q;8`��W����l��0��0�=��z5����cZ�x P����;�H>�o+�H*(��wZ'�y������-�u�j:���P�JG�3ˋ�
Z(����LS��3?R���s ��Q��r��P�}�~��
�k�5��� ��~�
�9�!?�"��ZsG�)��-%hَN�g��6�чXy
j��@�v�����&ÙuI�BT���9�!8��<p�3M]�fv�ա��S�;�c����b�S�S��8�� >u�2��7�qښ=
��<Ү j
���2}B�[�������`� �ݗ�LI�Sd~��T0w|Jz��h�~�e�RԹ}�m�(��w��F�>g��I�O� h�I�����_
Z���W�6r�L ~�����ő���hTLl)����b�l��
�} Y�! $��z�Zi���w�3���;w�?�1柙���r� 76 nܝ�����0�/�̩J2 p<�D���s.��x�~y N ���=cuN�t��{rB7 �ǃ�A����_�!��QF��f$�hp�f��_����Z{�RIU��?Kz�D�8���iB����X����5���I�_K8�%KÄ9��W��~n?�
�?bY��GX����ݱih"��8$s12�e�o�{���/˰����IRՔk[*�.L/�P.I�s��w� �Y+��ĥ�E\�L˿�^o��^�&�4 ���1)C1���\�N�d� �y{FC�8!~o|���]m� ��,����ϖ����� j�Β��Je��Vɠ���T^��
��'3��cz�2�WQ�v��(Vzz0� �n�P4���u]f:O�b�yw��� ��CA�OuW�~���F�CHl�wߩ�:�UQ���l �c�;�`X��P�u6_R p�(+cS�Q
#�"���&��B�)�2���,FJ��!cph}����cK?��y��[�`��ވc���k����%��@�jI,E�T�K�TӺKt@�*� _9�x��cP��B1OG��9]
�du����6��bt���0�)L������abY�*Ļ/:������p���Y��@8=�
�Hz�%1��h�"W���O��<O (sqa�[L���p3[��oLϽ�@y��ǣ�^M�t��?\<t�[( ���k�?��o�U�h��۬�ok�K����'Xn!�q�� ��`�9��e)���������`�
�s��h� 8��*�@; m�,3���dZE�X>k�����T����J>�����N�C�PN�
�������MeV�u����F�y��@V�>=�4�[�=[^��:��[����3ڒ&G+����sY��G!��e�'��,� U�P�5o�� +GLP�}��x����^lGI � ���?FY�Kn)����5��k�_�[�@*'� 9�S��*�:Dm!O�m�G.���0�o�&iͣČSh��V��$%y��`ZrٔX�ܑK[� %�
�-c�S�c� N䅩
�z�m��k)��U�xeԭp� �#��s��`��MuL�v��D4�NƦD�����K��d��ok �)�9 ��x�|�wz�7����������/+�h�:��z�D "Y�d�>&��M69���s��1e맏b��4 &Y�`�5!�l�E��e1a�y���_�, y�6a��Η�����r{����Bɼ��L]�DӋc�An��������xJb�֘���C��ؾ��A'ES<TȆ�~� X�nH:r�|�Xh$I�O�S;�~�/k
����� I E�,��v8�-oq@��^�z��W@�=6 �� �2 g�z�}�X$u'��o�D� p:FÊ�J|����ښ� ����������7��VL����\wA>w:Խ�}���*}��̩�z�t�ʍ�c���%Q'��K� �rNψA"Sч� �X}G�F��c��|L"�F��Q�(�VtWy&{Fw�p�sʣP#�e�D?����#y��@S�z�)�/c��n�9INŽ:��{E��9E�˳T�'C���s�#������g[� �s ���� ��S쿫+�������;��7i��j�Z��(�E�f�Q� �h5*��$�p_r�
0�+��� {���7U ��G���ݩ�N��61�ÏG��|�>8�n ��{N��qf%�
�B ;�W���PA�-�1_�� ����B�ɧ��g����r��� ʿr"M��6��@R�2e��I.��9�_e��b�MN�R~�c (!��hH�+��� �%����� �m?#@5�|�q���2� GTf�ѱ> G̬[+Ye��a2z)M�w.��&M�2� N£��� �3K�N�ҹ����ޖ%��
P�7~H�6��X
{s�M_*�j\/��r5-U���J����y����G��ѕ�;��� q` Ge�Φ�w;�@]0g[V��@�";KNl��J8���1 ��\�SUE��Eg�S�+w��& �G� �:c}"z[/�n _5�k�{x�댆'�8Ƅ�V;5��1F�< 0/�}ٸ��PLX����C-�8��>���
�p) �* T����7#jV� K)�/t?9��|��4qg*�� t�f7*�-p�����p)њ?��\�w��|�C.r��E�n�LU�τ�c��?����
�ze� c���M��H_h7j�h��ş����x���͂w�\Ol�\5|��Jr�;���QL
h�s5@� ���^A�"��A�z�[�J�6�R��g� �;(n:ߠP�7J{���Aן?}��9�t\�+���)lͯ��� �͚��c4mD���r��A
aF���6]v���u躠��$=T
ƣ��ˮ����T�qbēɚ���t�q�1��P�9�zx7���v3�����y:��{���k���B�G
ae�y`��,=�0�P�&�ȣ��KlZS��Z�ăi�Y抱�M|<�
��7�L�`l�g��g�:��c�U_t� ���ڞ�p�|{�w�ٟ�\�Jh�eXrE!W��!g��ہ�i-��w��Z�`8� ��{��a�������������N������l_F#r�z� � }�IjUҾ ]�GN^�!C�}\fѮ��yr� �u�,�f�� u�@�k���^˒�9�s3؟ �W��4���λ×{��`v9�"���Q4l/����<��)��(: Eg${�P��pU�
8�^BJ�K0
��@�Ŵᱯ��s�3�n�d��J&&��6 9�b��jX�c�%�e $s���<k�k<�:I�^c��! �AI����~��6��x 1M "�TĞ� !�c !�'���-��8��3c� 0A�8�� �M�yu�^��\ �O@d�T 5�ѢNz
��� ��YBfg)̩��RA?�~]H}�y���8� #�|R쵣A�?s%<�a��v�J5�]�;���n�����+�[��ǢSw����~ /T籘p;J���D/[��S�jY)�[rc����)p�G�� �|�<�uJF��<p��
Q ��MJN�� W���S{��r����6%�� ��<�kg���w��
���:X|���2����?�FV�����F 6�����`GS 5>ű�ӭB<2��F�N$E,#�=��5T�+o��� �a���l�s��s#o*� n��+�a� {�䇩��Q!�1�`�� ��D�s���RC���EH�����A��6~\{�����vK��ql6��%�
D��X])K��lk����b>�� �#���
?��Z;ns��4\��7EK�u#�����Ly���i��i�@�2��Dͫȏ���zL�J� ���B��h~�̯��, ��+u�[*���M�?̡L�B�YB����U���
(@Q �qA�E� .�j�P@��)pe�I��<̥�U��`%ģ��f Y5� !��̆���e
�Sf1�_����v�F��0B
�Q8�z�%�x
�
a��{�o4٣�*��-<r��4�{i��eݸ�#/�dR�*b���Κʴ�N�@�~�+% �k��u0"/}g}kQ?�й�߶����7Gc���͋�" /��g�0LG����
�h �"�s&���R�ur$�d�� :�as<~� ��&<j�hn3�C�T�*�BrfQ���S����*o�+� P4�5c>0���"��Ldi��9�D��'� V�D{
�� P��nN��9�~�����W���
d4���J�� s�CT�r�=�����e`/���
� ��j1㞵3s�P{����Y�2 o+�W��)�a~guuK{_ٳ��&A;�.���!�~6���4ʼ�i�� pe Lv<�0�f>���73���*�-� g���l�)g��Z�&+p4�R dԹ��&�Ӛ 8� ����^�We �Qr��V!�� %���� ��/���ƨb
�K��d�$�F�,�]m|ڕhx�盾�Uu����^�������w� ) z�y7���EdR��(��H���f7�d�E�+����b����<��'��_�%e�\���Ɣ9��a~�Q������s.�� R$U��d��Sr�/���q;���_H�=���}���?T�3�p(�{����i<ZB�^�J����y�I&\d�&�!y� �<л&�>��3���@&9�h����;�{��J�XV�9�y�R!> S�!yA����N�:k�?Bz��c#��9��Vv҃��9�x^���\X����ҕՒ0��<K�yǁa��*f&^'�fNX�/(8���PO�]�{8fB3�����!�/ ͜@� �0���* 5��\�A<�'�/����!VO�+s#\
W�7b�8MY����z�hist��o�e��GAi��IR�U� �2=�t�)E�4��?'S;ҝ
�/��~�r��X�7��<Vt` Wa 7�~˖�˼� ��lM1C�'�BU ����ӦwH����s�^�J��D+S�g�v s��k4�1�K ��x.�O'~B���q���E{�:upSdž��2}:9���FQ�d����Kp��L�e<Lw;}]Z��[ǜ� ;�4���!�+,�
^Y%0v��f�f
ᣬK���U9�V�~�&�Ѳgq����ѭ��P ��]��3�k��A���XH��z.-��@�
��}�~v
�)�P�W�)�D;����d��h�T ��݊e���FPN�u^G�&�x� h� -������X̎8�Jy�4��1�����{����d�_6}ˇt� �'_q ���O���Ł�/�8�gV�u�x�j%9)ƕ�|�m���3��f'w�&�5�
l�{q� ��d���ٓ4� �� �2����n�#���Ϻ6ms��
�)��Ga��W{?��ޟ��R�1U>���j���i;5Y�F���@�6!�/% ���N���js h_6 L���s�O��ؗ̀��t���2����0�E�/�}��&A�nM�tz��Ky�;�@`)�D�,��.��A� S*�J������G��
���q*�:��6=����F$+�ɻ/� ,n�_U�T|]e�\�V����B���e�
�j �J��;| �_`��|�-k��|�s��ꤏ���:&���R�ކV�Q�Z�J�e6�d��nXw v���c�AFB"�m�[�ܤ���qp,��K��� �ҹ���Ɨ�(T�PV�H>����� ��j��HYDl�Q�/{���u(@ <��ۯ߾�}���yv������-�'ׅHi��o�1}д���[��Z!N4 �pSK%�N47�*��~��[a��8���^�$u�cs��|γwh4r +*V� K��\��[�ҳp��Tj�a��� ]F�w +�
1fԵ��V<h�H>�٘ ��W���A�C�4�>� ��L ������'�"�N�?4e@p��C�,���:����Q'X'{��Q��/=������0�T� R)=[`�̎M�ҹ~�z2�a�<�2������s�Ƅ��K�K(�IEƗ���� ��c`�,0Ly*���3ZV��)�&��QW\�zYWiv�{�>kQ��N�-I�\�z�
�^z�쉏!�g)\�W� i&ch�*����Í�Пh��nH�D�" ��]����Y��D ��s��]K� 7c�ϗ����̶������'��c�� �8����}�Ί�<��`~�뢚���k�MH�o�<��#��ul�+x:�v=aW�+�{�� h�%�W+s* w"8�h��)ZX�E���!W���-z|o�_ۙ aC�V��X�R�Q%g��p��r/�O�p�v��Dp�{�� �
�u7�[s��VJ�V��5��Ʋ{����������y�gG�py���L��_C�~�eƣ�,Z_/B��$�2Xp�xׇ��
����Ն��~����.���z���_)��F����q�0 �"�Y��^뢸�ʉӪS,�Z�JX�<� �� Z���J�j��g�[y��-e{���Pu)��� f�� �W�xٮ�,��:��r[~o�h�:�Pe����'h �����O''���N��/{�����J���x�6��ߴ�+�d~� �U�dY��b�
��מ5�A�=X(oB2"܀9�p�>��o��
��:�\K\�_u��l Q�-��@�6:l�vX�������ۦfU
��~����ӗm�v����~g�� T؛�]Jgl�� �.�b�gٗ���
�r}��l��9N?�� v�a�y|�s������G˿�{����W}������Y>^z�[s*�xb��(nar~1 I
}
���X�i�\�Q{�4��n�������"�J�Z����Ka}�_�R����w���3� �|�o����?����F4]�J�tY��ʕ���X<>,�l�Z�s�_�)�g"��� A!w�T��c��BGZa]P��5��,^��hb b�< ;��4�b��9 ���2u�d���yz����8�a�R�]�Y�
��Uì��W�ؑ�h}�IZ"U ��u��Ӭ�M $��ôT��j�gҕيwK(ee㾥o�T8*�:�j8� ]�n�B&��N� ���c����_]HN9��(e�����YL-�*�gaE�,��[A$�w���ZR&9�O�!��������O4�DX�X;�9�C�@h dr��Z.�U�З^�:G#� D� m��������R�"�0*EC��Z���(�+ ���a��E k!�-���� bN3l�v��>x����y��f��e�� &� 2�� 6�&�K=�|Q�r�6Y�:S�z�y ~~�" �\I$Aٖ�s��e��O�B�F�r(���� jA�C�5� �s6.v���: �����9�p&Ĕz����R�
�C� ��눝
E�RP1W��<q|�U3�c���M����>�����]b5� ��'�d��]�F��eD 5�:g��wH�gH�%���xM?o�@'K،��u*�Ŋ�+���͎C�@=��HEU^���e��g Ŗ@��.�%v ���<ja�F��6Xs^]G�~�+r+x��`�l[��5Û"��E�XXi(L�07��w�(��i��5�c�%�')�� sn�FF*��Pg0LK�C��{:c�^j \V���{<f0�J"<���]� +��[htEl&�1���� a?�cb]�6 �\�q�f.s� ��ݽE|깴펱F�R���Y7�����{g �=��d �^Sd�%�v��Q8 Ƨ�aJ��jO(߁�q�Tr�6$Q����l�V�#�C�9�s���Kⵆ\��������4(��C!�@�9ǂ#��*L��4���� �X
�c�wHW!�`�5�/,t���d1�;���J�wE/F�W���)%��Q{�:�k��y��ߥ ��(EeL ��%���s~��� f>\�BH��,9�����i�6��)`���"B�'<9��}�!tGƙ��߮���z����N��2���ὯL)�V4\e_7�p�+�k���Bcfj�j��
�h��,��z���*��(\��ܜuA��]T|��
� �f�W��G+�yD�1��E8Z� �)��(�m�q�mJ\�|�
����/H�RuK��X�/�_5�:H��$�<e��T��g��<�"��Sn��[�o���[�|�, m����qx��G��q�\^�8��}w������[�朔Œ��M�\�='l�`�r���� �^b��d0�� q[��C��'5�C��*�_&�����Wx��yeOΧ�)�i�Ӽ`"�jU@�pj`��]y���ޒ�b�{� N��p{��Gv����|Lݑ((�0[�Ot&2ӱP�`7 M�32[�5c����Qe���;�������#�D#���]#�??v�q9c� ��¥cnD� Th��p*۫���R�Tq�%�> �l��2S�0�
��%:��v��7�P 8J*C
��ó!Gԇ���eJζɰ7�,X�y5�)[#�$�W2�M?*�Ct�I�guQ.:{&L�q+ � ���
� �n:>#+��I� $�tŗ �Z�xd�b� ��m/�U!��2 }`�.v�[
u uk�a#'Þ
C0��c4�9p�{&�6�'8ҭ"@iΊc��wv�6���Xg�Z����ؒrK �qw�g��E��u�c�U� L����0����A�]�Qـt��+� Q��X��h���L8��' �� dª��Q�D��I�
�Kt �°��Rn嗖���ϑ�!��.)��o�����U���|DY�r)Y��7� �jɸq� � �ϒ$k�|P,Ӑ� �M ��"㊾��~��(E�"&�)eXu�.I����5˝\��wK�{K&)��N�V(K����s���Wx.�vJ�.�� 8��8�eN�,C���c�m�{��dv�LL�}"Qe{����Nf]][���R ��i"�4��,sFUNTah��@�,�!�L٩&�PcЖ���W@ �U�
�.ِ�(����X�ҌN�
��.ł��C�d&M0م��r:��.$*����;s���A!��\��AF�ZK Ł ���94��h��PQ
�ch��E"v�"1}j4Ch��'R�W/W�*��&��K� �S�� |����7�"b(���<�"٧��,E3��{��@���wI�I�x@>��T��r�Tziǟ�`I�^[�]�Ƒ�tQ�� ��=+����`+<���B�(���%bV}��'��謼.����9�a�.��U�ϹD^KހԕEL�@',+�o�ἇ�Q��X�����l&$�N )�O� v�[��6Y�{Fpf�aL��E͵ D�b�xW牾4u�+Q���w��)��`��r�H��;[�d��Ab7� � \��2T��� ��fZ]��r �|��h4��Lϡ�S,�6߂o+���I��)7����e�W�� c�tR��VA㣓�e�Ur�Ϭ(8�y˓ ո��t�Ce2Ic�dI
���:(�,1�8�yq����5�E��q^S���`ng-1�}T�F/�����S�_ �SKD~�Hm����HR?P�ɐX�CH<�w�ii�����E�x?��48nC�خ�0� ����P�{��A�3�0��WdDH�*�� �K� %7��b���
�1� ��q(~�ޝo�e]����O�����|�wH^ÕZ��l����d�������&�-�в���YR,R�}��A��~���{��
ǣA�9c�e� WEu�r�H���ק��|��C6e� 2��p���#�7s,���PLDý�ݘ�B{�M}��fAe`aC�����~Y��+�xc�\�]����h�>�wP� ��u��;خ20Xo��T��o�M����fSVL��^���7e͑0MzR���y����\+� 7K�JMfeee�=48n����C\�֔�ùYI屌�<��ȍ��[/��v#W� �w�=:��,%:
ذ��SÅ���A�?�+ ��H�kƚ�T\� �l�w� t~�=|�y��i�9�=������_��V��8�$3M�v�jZ'�dH2��5���BD�1�D�f�K�,��o����2�~��D�)Uw U������g|p>
�a͟�R��"E�Ɲ[�x&�P9�x��\�6=�-vJn9��
�<x�@:&'dHM�*�r��c�̣�K��8��ȏ1�\[4l��l�Kv��i�?t�b,�V���x)�}����#T׳.��r�Z[�8ҙ '���H[��MV�Y��v��̳�_�H1�VX�(�ͱp�9K �:�G.�$� Yc��� �>���
D�+�x�{��8��$��I���"y[�����TO��:��u)�O�X4��p���{)����7|!,�0P�-O�.�A(����N��?���KOm����U�V�!�79�s�*�N� ���?�����]�B�����B/�G`�0��P�"���������0Y�uX�ȚNF� ˑ��T��K���9]��pO��Іއ��zHq3+_Y/���kHZe}w�r����L]����BG�'��r����W�tаM��rh�$�e~��I;��8��V^m���/|�)�F!zy�5zE� .�g�Tv>!�2B螥`=Y�ɓ\�16V��w�4\vD��?[�ӟf����vٯ�n���O�b�*�# ��'t�ڒ�W
:�}�a�j��J��C�vp����ρ �k��R�tN�q�%�鈪�k���YM�lV��*�%Ha��^)A�ݲ���#@kԥ��C[��K�
8fv���s���w ��cᛞ[Bm,��.Fi"��w���y��7����U�T�^R�G:����Px�p0���$�%d[x��|<�@^��C�|%6��D�h���_a֦sA :
̂�V y�0��d�m����b�9� ���T��ˆ`��B����&�]�E� w�W�{��0U�
�� L����{�0�2�(c��0����e�DA
�nypc���#v�/��(\7&O" ��u��˕�)����BQurZ��HmL��y!�~c�v�����Npni4�='�q�(��,�|5�rʷ��ϼ�%vTA���Z�]p]XoJ����)}�V)�N�)V^�?:DF*��jؕ]�Yմ\�6a0�4�X`�v���8��mV s��*��ޢ�h��BS�gG 0���ĕS��U$z��s9� ����s,q�SE HQdF��Cg���aiK0��"�ɂ �A��Mx�*����[�W��C��� ��5K�-)ʄX�~GDQ� 8����@�;�����(s��� "�`+��?G�� �d;�a�-7�_B�=�.5�]�N�aynh��l] u���7| N���dnH �ms�GE��K��V(X��$/�kGق����՜Xw����T �'P����?
]$��y ���8�્�� xG� 5���0�bƭ���aw@�FP��<l�\��s� 9��su+��(�Na笜��u��4e ǵ�H�s ��ظB6���Qq��TODWr$9(�WV�G�"fD"�67 ��ˏ7�ߥ)�f�O�� ���y�G��zY���9I��� �HG?A*�|z~��K���Hh{!u�YdM&%�+j�t���>`�`aTc��u)xv2ׅgu���� ��iig�R��H�1E�d��V/ý�r%{�E�ƅC�N
���>=C�.~��C*#(Ѣ��Xt��$FT�*0e[A3k�0���~��ř Yԯ���.�Z�V��M�-�Z���t��;t��u�N�q
��z�8܉?���@I�b"���[�m�>X#f1zu�����8�U��;���lzj��]���E~N���$�[���\�N
?d��Az ��� &�q���W�~J5 (c���`}}=�����7x{# ?�]A��h �VgW{\
WL�ً�" /�3�= /� ��1g���/̎
?ix��1��>�W1�]�����߷�o�t�(6��U8�}����<�����\]y��?V766��V ?��WV7��u��g,�O& ��,�S��z�O�_�ߢ��vXC���.��]� b�YP��>�[��Uua� ��~�̱��+@%TzȘJh�� /�;ǟA&��ӊ Q
�3��{*qs5읍�a:�8'.�-��B�M�n�{���5�D6H��zo/8D\s�VtR �A��
���-�%�L��-�xs�x����įi]�EzQ��~��)l�\b���v�Ӻ% �b0s��� Z�܋�|�;��m���ʣ�G>���zG�� � T=�E7��`Vp! `&��E`UΥ*����"�uZ �r��K � .
�D��
6l�(K�U#��l��+�*�D��n�Pu�=.,x��R� ��YE�M`��?��ID��_��8�kx���p����
��b�5��!�DS���p' iIe2y�c� ́m�2��A��� �}�{�y�sx����}����1�s
��e1c�5����M�T�2@���ʩ"唁Z49�W6@3�0��Ӱ���$�K%� �4n^ �d��d�xk2>Y���?� �A��Z�� ��F�{h$CΕ@3a3Ƅuef��qEZ#`�㸥�H������r�d��Rt,k�Nzk�V ���Y�[���E��m �h��Z�V
?� б�a�] �՜]oku��8�.jߵ������Ջt+[�'ɂH5�l�辤 E� � s�x,@�~��`v���2� ���5 l4�!���>�hhnbU1iBSd �l�: 9�* ��֓�Jp�Zj��`8�l�^^�P�|{�\%��ͬ �RU4��Q�_�U���:i�0!;��w ��2xխ*�����>��u��E��N��T�q��>�H��Ajq
�x���o'~�Z�J��(�?{���6�$
�g�
�<Ӗ����n%nǝ( ?��Yۙ�YۣP%1�-$uq�o�
� %gһ}��>g'Q(�
��BUA�ڲ0� ��ػ���\d�k��t��mS%@��RXu�?�����?�=��C�$i�\�M8��F�4! �pң�@;7 ]\��;g%oߝ� ��^��{�����7g��̳�֫�7������?�;����{��N�^���'�m��7�F pl�w��T��� ��?z���7�f��]�ڨ�cd}��)�L|˂�x�S�;�ٱ�e�S���j�����Y-�c��O�����o�^/���_�鯳�y?���B��'�f�@���)#Y��ª��ӡل��
[~
�z���A�����Y<,����G�2��eU5Q��3��{��IV)H{ ۟FU��F�+�X��b�m��;�
��P��czv��_H� 7q��!���#+�1~��K�Ϩa����[D�p��<���n,O5�>q3 tܔ漥�9��Er?ƛ�lՐ��;yq7�8��t. k
_�o#.����?�;��;���`�џ�?<���z�q��M����Lz RS�`SS\l���-�B ��c��>a�2�/�X��>^��[�=�-|�h�� ��
���<2 ��M�"��ySy����3�d�P�7�# �
�� E�Y�V����� irgJ�w�3�J7�7��a�[�颭�R3Ou��d�Y��Q�����c7N9ʶ�%E`mG���:̲�Ւxv����%�λ��l�K-
v� M�@(5��E�W��wcC�'�>��≙�:Ms !6 �(��D,�+4�Z���ז��S�E:Bpf��=P�@�����&�X�N�D{�R|H���QHK�j���/7�S绠J�8r�Oo3}�K! ��q�f�K����`�ӏ`���f������r(�c���h �^�gO� JD�u%�K�&- 6*=e�x�,�x�%�� �Q�^B�F/A�3��!{L �g�0 ����Q��ϭq ��*m�G��9�5��.����yx���F�"�uu:��k�K�鋶9�!P���� �t�(`�Tc��b��<),l�� ���q��M&�wMlD�Co�_l�$��
fa6c��bp>��Hq倅�� ��ʞ���}yB��J.s���,�0���Sc�x�o~:�4e*�AW|N�
{wo��Y?l���c��&*�����^g?��5�Q�7�J��� �G�P����
�e/�ޟ����$���;zOe6+��� tᄣ8�aJ�rm����� Xz�T�5�ms8F�H� Ǎkk�F^4I�x*�����
$2t���U��H��g
�Xi��#��cj�X
x�+�M ���JA^� @,ئ�2 h}�s ҇N���~8YM��T��VRQ<�;�cmJ�q���� �ʴ�� G���K"N�z����f~�,W]�l��f���(h�+`�����6*��OC�t>�� E�
������'��i�F!ȡr홺1��N�)�`��R�e�ŏ̀͆��)��xB�5����\�J���n:�+��Qp1P�q0ݫ�8�}�tfGNz��I*����ݘ�% f0~�&?J Q-
��{�ŏ�-�� kdܧJ
���S��i�Q +�C�l�@���I��~^#P��^ �A]5` a>Ɋó�Oå�t�T����h0 �I�j�On��#vo�#��Ĕ�� V��� �D�0FK�j �3�7J�Ei<7�K� � ��[y�� ��Md�4�e�Ǐ�4g&e:�B6XA
�9M]_!�iR� V� ��5ޔ*
���<�ʆz�rA�od|���� /Mg�t��
>� ���O*��ܠ�Z#Mw�vC���f��� �/(�@ă�IFj�x��Y�v�:[�:0HP������cp� ���u�+��s*(�Ԋ1�(
"
�S�F2�)Kd@���U�Ԋ�7.^$� {8KA��b<S,�{ [Q8V�Q��d�����e$�\�0�U��qc��WJ9�3�C�=��r ����]�
�Rï稉�:I��a�'8KL8�V�BTQ�e"IU*I�zZE�M�*WJKS��d��b.C��n'���Z,*'s�C��\����3�e����%י�,��:�H;�Gäz�X�`$��ѨV�A�FF�U���M�%J��AM�܁� X�k��J���T;;Ú� � 0�Y8R�y��#U� y�:��ɔ9�0/s5�ȇ�L��5ց�;2�Q0���2
k,�����'H�HTa�F���lqgb�L�^���#{wO�Tw�F�ݲ˞�a~*7G���t ^8A���(
dwV�ΰ�|Q;��� Ќ�JM�H' ��j�/(�Lt#�l��[��Ljg��㌲�S/�;X,�e� �!KU��a��
¹2´1�+0^
ߚ˺�h�0� �>kx�0�Ť�!,��Y�+��
�e�y��Q6�OpE-ש� ����p
��\c�у wvڬ�37q�b�ʣ��P�V姇��P�\%p*v ���n��(���ț'�Z�YKVݱb^)�f�a��g��=�5�L`:�/��J��}$�d<�qOf,n�Wl o�e��Y�֞*��8
3v�-W�+�H���Mk�a��>"�� !nZ+OA'����*�IHK]�C[�w<^��Z���SmQsB�Q��C��Қ�)���3�n?�T���F� F�'��7� =j����zp�����N�
�Q:u�9�j�`�(�c��;��O2�*�Ǹ'��h�u�Ēu��䇵���ێ}� }�ld�U6��G��JT�o��K����� �+@�:�d��枊���h*��e��c�� �˒�8��P�蕇���a�d ��)�I��d=���D��~��! � w�)P��U`W.��WUc���]3
��5�����j �'��q<��dD�ϕ�~J�ɧO7�F��+��fa�?v��8�s0I�h�vБc���o̰@s�;�IP �ڙBg���2YO��5:���'�A�(<a�k�eYѲ�dA�h3Q�o�xZO����S��㊑;c�� ;�BjJ�I�@��{�A�|L��{lB�6&Y..�e*�a�Y�,�|�Rd�
B�d{�d^���3O��'���n�^�MW��M� �6t@ �}̾
��@� �ٙ�%�jA`ٙ*b������>�0�=G�Ǚ*�I�>6!� �����. �� �O 2�'u��i�!��7ZU�)j>U������>>�����7͆& ���a�]�u�v� �8���4+{��}�
Rr��A浆�'p�@uF*����#O��y�^Œ��ջ�Aq�D�m��:��� ( ��JD>(��J��,א��F� AB�����.�ݓ�\Ù� %��`-L�zw��:6 �vGa�>�2�I�+G���H� ޛ���\S�GH��7��p�q�!|SN ��Ou��?/HW B�����ݲ��%�*W�ěL�}⠪f��zO�č���[Ѷ&x�i⢗�w�7��^��2>tT�8[��|��նt� �@� T���،"f}pj��2; �l����;f��2���P��g+N���LM B?��G�ј�h��u*�Ҍ�L����l��\�!v˞��Q�����0�V� ʺ!~�@�JYg�tLa�B��PQy�$[i�` R�q��܁[p��1]{�7c��(��DW����sbE��N�MVc4��;Ԗ���Э�m����Q�rJ��;S*�{S%���r^�;P�4��r��v*��ie� ,F+[�.��.�<NY�<��� �1�x�7`c�3p||���y�E���J\� ��n�\>u$�7�}�FY 4}>|X���h�� r0��hR� � n|�l\��c��1Y徇|6^� �`R%�`�oH��oWu��_ī���T-؟�� `��
�Xy�� 8e�A��A�
@�1 e��SN6u1���Q*�^�CL5c�Β ��%�c�°x�u" �s�՚�]��z
���DU7��\ wk��#�I��J k
K��A�eH��%��
� ��h�)�Ѱ�jmܲ��S�cA���ɧz_�(sqE���� ��x#�{��X S贈Xu0�����k�
� %����"pC@R���T@`��Y����Dװa�v�zm1P�тj Ƽ����V#�sG{�AH�^81F�(�OAxSG�A*��Ad`x g��oLT@�m�O'^�I���*"1��U�6~�4 L[I���X��u�a=�����I.�J�Jj9�T_U����gb� �4A��F���.{<]�K ��O�±o��y���R5\c6��J�x�D�Ns�⛕��^�T����:G�G�NR���� ��q�ê��B� `L��H�~�u�S.��u�B�T�ܴl�>>U`�;����Τ��P������k�b@��|a(.q���47K����y�Zɂ���*���s�(��:P ܂e�\�k)��I\6
�|�A���r��ڲv��_�]��k��W�e=��f~Bמc�� ��vz�G��Z2�aͅ^�fC�+��D���65A4�kͅ�;��
J� �"�T����>&ݐ+��z�����r ��n�V��u� �0\�Uq��ZU� �:����)�!&��*E���{J�����+�ҵ�����*
��G�v3,�kE臗�t�k�Q�O�C���&w�! 3
�H�� � 1pK�.nD��MwӉF� �h���`��&�:\A4�:�rM\�d�^ �R;�*z�nv��+ �k)،m�뮱�(���`�O�5� �4�V����}�1b�w+F ,���Γ�Ib�;�0CG(�ݝ�0�a����ք��|$ŏ�Џ���T���Q'P��Q�NK��a+��LINb'm�3��Wq�p�����|�T LQ��� �:/ ��6��_qW�
��&�/��\�,��H)Kd�J.+�k�w���Ǖ���
�l���~��'�h�= kbb�n
��Dن��.���|�O��
���s �,���`���_{uQ�C�\ _��FU�(�j�&�6�1�����)<0KNBg��N�N�?\CG(�θ~����$��� ��H�`��;,ŝR�vs�!�a ��}5}T ֓��T feO�a�x�[
��Tg�y�i'�\pD,3��W�^�։����LY�6�_Ʊ�U����G�F^X7ĸ��`�X�Hq=���R#�8��a��3�A�O�Ѣv��7[ͼ=��m|���Q;�oG�jd�Բ���$qW�T��uɉA�X-"����|U\L��/N�>X�@5����l�qF���i�E@"�V�jݩ�G �}<���B��
�H2��4W�~�E�-�~`� v��d�*�#L�=�@;f�
$v߹���YV+��k�+l���rH��z�Cv!@7���+��A�wl��H5���5Ʋ���G�Uv�3r� �|�*r���n��hJ��A��'�Ǚ�\��]R�4�j�� �v�s��@+n���S����0��Ph��8�9�� �hF�dPC�z�sWz3Uij0�g� 0���u�T+KP���ɨ�y� ��K�R�D��Y��R�`�\q20�~���=*|�b ���+�9�9�v0�pZ�7\�� Q�� 5�j����G�&�H�9)��U$�A�P|�z�Ø<�)]���.Q���Y|lg� '"5U'���_�Ut���7�k�� M�L��s�|eW�i�Xu=�843(����ٝ*�u?V�`;�G 8��\9%��F� �>tK�V�Y:*��%�Ն�DqqL 9o8Ռ��l}���j&ߴ>��TB������A�
.i�k7#zH��p�`:\ p�j�R��N+ N]M;O��j ��uábeI� �*��y��;���R��{�[�5��S5��'�6@�Y}��*�R�V·���nP�@�
� z�B���
t��2�1�ȭnP;2G�@�Lu�lK3
P�`\+lMoFID ^��J�v?��ӵ� �TkRu�o�
R
u�A�5N�� ʯ�jHEI�#�H�Nor���W�1�f�g*���\>"���Hq�I�#��j�:�ң���PTb���#V��]İ�k N㵙y<�YY��&w�x�� �JA�]���ʰq-���o���յJ̸���, /-���j
N��i��E��/I���ԓ�ȹ6G��̥��\�V �i�H���^d!�W��Oob7���IY�"g3y�U��ᠸc�N�D�X?�*8�3��H���c� l���G}��7}-آ&uB:��� g�v��\�g�A�9q����E]�ȜZ� S�2 ������ �| ��S}�z�^�W�gF�Mn{ H�S�3�6�B3�*Qh��kԀ������
J6�g�(g�D5��=5SS��a���Ǜ; ��ɖ>�j�f�!
�L�K5b�D-�k����%ވ`��jW�,q��\5sE��f���$�B�+!K
V� �S�jH��9Pl�q� 6=
&˕Y5���#����� 2w8�@�G*�ZVo���a�ܜ͖�H���:��3�9[f+�g��<ˋ0 >�B�;�7 ʠl��b<
�2�`�v��4D�Ff/,�9k��X�\ �;�>�J(滋��0�8�H�ש�Ñ��o> v�C����p�C(�JK��|X{A0W�i����Q�Rs��
�-0O��1�B�t��y�vW��q���~�!f�,�����)V�����)&N��B5r��d2��ghi �M; �ܺ(�QM� 'f�2l-��̏��>�d)�s2�}�5�UqA)��>*0��G &0�_��PPNդ)��EPk��,C�"�G�d�v�P}qrM��H����KA�+ �i�w�
��5V������US�j���S5��b�勦�z�Pr�[����kԃ� �z���w��U��W���2�*�h�Z�� �Q!ˤ6� �9t��R[��|����$� �#(�i��Y�^#�u=�M���|1����L]�z 駰�?�`:1=#�ҩ�
@��9��uߴ��3Z^��4��.K���u �SgyY �O �Tmqǡɕݰ��a��T�_�Ro'�ӎ���ǣ:�= ���y9 �ɸKU�^��J�"�C^E���.�U�|�r�dx�+ ���J�����멶e
m@�鲾_�m&Q�Eu�~O뺘�y��o5(��`Y�˫�_T�F� ;�l�h˨�Ű����˒�>���vB�_E� axle/V8OQ�8�rC�X�u'��q)B�>C�L�T' W��X�ي�O��;�W\����8D��LQ�7�*�2����qʗ~�M1���'�V���;�ֆ�y�+�)�?��2u���G J6��HgRc��9y������?�l'��z;���v2�=�����y����wv =��� ���>��� �`g�?���� {te ߯�[U���6�q}r�~�%^8��$�ߵ�J���7�^�ѵ,�段�t���[�_���ߘ��ݽ �k��������om�o��ŀ�h��!@9
�t��}0�
��.�S A8�7�n�5@�2Z��-����OhҺ�f Y��`-�l�2�� ���7�;O����om,�£1 �B�Q�wj˱8�[�Ʊޝ�"d���(�d;�eL�� ����m�c�$n6K�*�!�ڳ� �|�:4�лQjA��;F�L��*���hf
��� U�y�S�5I ��[��ݛ̘O��EV6e�*�L��'Y�s� ���6�ٵ��3ZH :v|��k�
\ ��rR Y�Mu$ c's|����`Ԏ�?��$!����)\"�L])�%\d8H%d>h��Ȯ
��X`���b��
�6 �dmI�B�!����u: 1L�� (� M�n�Ց;�`�is���6�>�Р�����#ghh���?K��"�'sԍ���?�8z���{�w��N�������sIie�q|b��-�NOON�� om� ��6���{�>�MXV1 O�Hp��^nZ��k$�_{� ŀ�;m��֙�Z���ۄ-��ն�8Kq��-6� � ��V�R&,�ۓ�� �#M}]@�z �]x���`V? �|�I8:�����#C/�> z��><������{!:��(u�e���wa�:�:j@쫨!�Nޞ ��9��n n`�i�'���'�)�g'-�� �˿���ν��c ���sAa�գ�OX�ykH$x^���v�y /�-��;v`��6�L��s�S� �tJ���ف�L\��ˇ�j ���\�t�]�ܙ1=�0��|*�E�O]
���
�g*C�.$�,�B��Y�&�s�c�nõ� '5��hT�k쑱r���� ;�%��X ���_L����٥����_ }L=|e�Z�HN
=����¥�B:�amO_<���z(����q���IR��/ A�>��/<�`���r�d<D(\� ��/_d�8
*CST�rʈ��DT�Z/��z�$*� Ŷ��4��p�|_lL��dD��XO�o�Ӷ���Ԋ�A��'��,��~�}�(I #�-��| 3 k\Hó E Mn�H"D|�|�2�S7P�,��s��́�z��ߞ���<;y���â�����������RA��y ߋ�����y�����~N'� �� �����OӦ ������mÚ���?�ع����
��Hb�=��R��i�?����{�/O�_�f5�a�te Z�o;���=��,y�^� H���\1��¡�S�]`GX
w�����=9=W�bR ��z M7~ܩ@�)�]&�+������%U��8�g���ͯWR��G��́����'WBz��P!���B�?{����!1� � ���
�xve�A-3�V?m�45��� �@|��Z̍D�45 �����я@%i<�SN C-Y�/ G�XlC�U���@�h���b�r4�2�O9����>-n�A��6m/�;�M��V l���_%�=�d$ej}��_ƾ����Hb ����yH\Sn�������y��y���o{
lFLY,�۠3K|�T9jHH�x�S���8�\y��b�6eC ���8�n��c�� " ȫޛ_�_6��tEh�=ɦ�?kkS��i���X ��1C�̛����H�O��o�N����{���
�-�ҍ[{ye1����a�0W/����� '�ѹ�aY�A���@��,��>;�խܔ��R�RՀ\�j��}�Qh���t�� ��i�� 8=�� J�m��'��7��H��<��-y~m�N��֗���E �_vH%�E*�'�J9����bY�P7���� ���`����%���ޟ�(��p�m���s�k ��� �4�s�y�D�;��fsf/W�p
r��l�m�n��p+���7f.�F
v�=�r�A�e\9�T,�-��}»+>H��'OHY�;��='�.�,��%��%S�闓eI?�V�� ��s��˦8U{��E5�S@0-]������J;���s�W��$�N��Rar`�|F:��ciL9Q
L��ZX.f@M�ymL9�~�',W��>Pu�%l�1�t;�#���E�<��f��qK�e�G�>��2h�j��B�#��
�*�"�� {�� 6բ|ț���uq78
GW]�v�X�^w��L2�#+�d�M���q�������-���Fl-J%�#7bH� ����#[��h�L�{}���V�n �`���� Z�}g�#�[�o5�5��:�e۶��l�pt�}��軆UH]l���.�"s $�$7�"��p: � ��cnAQ�� �+S����!�����m[{;��+� ��l� ��Q��vC�DA�|��c�K�G�+lj7n�!���wW�Q�PeR�is������43��"��1��wV�V��GI��4K�[Œ�}M��,�;&5�f�2lH5�/� �[a3��=�' ��ض�`�Z����=8�h��� 3o|�/�
(�hIF�`y��q��������la���N��ҔȰE��Z0�V�*�Q�k#�R�Q8^X_��T` ��HZ�B U�`م�Qp��5v��U�ش�xLF��T�GY��Zʠ����I�������,�*� ��[�B�چ/�8��������@Co�Q��]i7��/� ~,��F�.k[��l�C��z�>�������ǣжZjF ����p�Z����ު�xc Ƈgف�h���bǜ��o��º_���1��ٓ���^�w��Oɢg� -lxҔ����ʳ��s�7w^������?�?|�����h(���u�f�� ���á� `�l����gpT�u|��Q�[�� �NO��&y�d�5
[x�
Zދ3���
� �m��Eټ�z������Qi)(������vq���L� � �:�� v�EV��!�/� �>��s�-Ո�u� 8Z�1u���kf7��7�F�-�gU�Q�r��<�~��U�������?邋��w�z��h�5�w/^�N�g��S��w�&�Y8�9}+��{Q[���2�v>���X�V�"M ��Ұ9; b�ܴ�W
�X�(�|��e�;�H�_�9�d�n4-s���"���$�[U:�U�jROؖ�O��?}�����~+I`�����C���p���y��b|%�VdY���xR�c0�������(~*�x��� �o}��� �y@ %�c%[{�j0�0 �`�P�ըװȷ��_9�=_�P��u�1L0 )0��ss/��� u8;pbҎ�EW�� ��T�|n��"�8��AC�f�v_` �P7s���� �Zԋ���x�;��]_ ��1[�*�W�z7�웑�*�+.�e�d�o�i� �C�(6:���'�N�21\��lArb�� v������%�'���W�#p��YR�!2�� 6�'�-��C�Y��f�_� �,Ha
JbE���YDMӥX
u'�J{� �ʁl=.���n�V�k���G��]�� � � r�����UcC%7ӺU��X�H�mY��3F��"�
h�a$|>.��ۋ��� ���vD�R�ۍ��f��5��=�^\[�-W���U ��^!ulD�5]}��$&n��m�Q��P��[�c���(@%�q�����.=���J c���l46�<��N^lT0��d��3��HJ)��kI>]�.4���¿�\�����lYC���
��!�_P|6p�� �E6�����e(s�o<h�@ �&ʽ����A��n��� X/�������? ����b��Ѷg����6�{ ��� <&[O��%����k��<֣4�z�Q��g����#��X��y�2�|����p�t� ͓?AnZL�x�M��R�u�Ɩz���gl{�n@�O^��� ��6��!<��tw���C'Q�q�b6�ef�NFxm �� �����;y�' �I�� ���|�<*�}/w��l 6/�u�xܾ�߂ _Bf&<?�[�
�܆´�z�s�q��q�}yqyuxpu�����y~|��Lv�K��2����P�� �ߏ^��a�F�q~��W�u��E�2Կ��.�k�3o�־��\s�3a�mq��M�r��� j�Z��a�n�ê�����1��U���_�+�ޛJ���e\��q�`X_���5���l�܊<Fcd �`*�wt~~z�˻�^��ˣSZ����.�;;����r�h�j���)[?�|[��zu���nm~V���U>�=�py�b��X��ޯ�^ ��a�G�{�<ECu���#�=���5`���n[��2b�L�����ˊF����Q���{�z9%������������D���7�����=},�o�֎^G�;��N�4Q) ʅ�t�/�e��ޖ���/X+G(�U�ң҂)
��r\����ˁ��FT� a� 4� *���!1j|�lo��}������� �������E@�� �?<z�KΡ��WGǸu���y�z'��ɩw�t�U
��_4�����F[��&"i
l�Φf�r@������j�A�N�� ������h
�y�
�|�"[
�z��p X^$���R@g z� X;��,+쌚�2'�e��Xu���i�9Ɵ�~�J���t���#�˰ p�Ǭ� {bк�r݅�DOKpuU�,�\Y��B�(1��Xdn2W�n��"qHȅ1����gQS58� g�]D�7�l�B�j[� �C�3jc�rD�p�jx�!����C��!��Q�k<V 6�?%bU��njj[W-%�G�,����q[�ݘ��e���Y��\����DQ�O �� �WyG� �sSZ�(����f�l�t������;�`� 7 ���\ ��<D��z���.N�?��Zg��D�G���ky�s.z<?ڱ�S/f1����Y�'A��+8_c�����ћ�О g� ����.�`�/�|*�ޓE �ĵ�4҆w+an5�ܐ� r6N�k��e�
�f��=XE
�z �����-�w�;�"߇����5H/pQo$%H��f��t�'�)NͮJ�]ݺϳ��K1�|�I.���
��I�1�� ���נ�zé��@�;1u���6 �� ix��VK�u
�gk�����
���Q��9f!���: ��O�p+���0o�.#��h1�������(j��c�"����:�Ġ��Y�%4��I ]��M�N�r�y�D�P c%,g�;�%�YK˥yX3� �Y����o~��c��AQ�<L�/@彼�n�@��>��T>絺���
�q���a+l�] ��ݥ��m��)hY7������n����~[K� ؛���2�X3��i��<^ՒT�j �W5MyJj�厹V/�n���7�W1犸*y9�?�� ��K�w}!;a=��U&Kԋ�x�aF���/|e�h��F�}�@9��/̎�d$Զ̚D�������|^X�3�V�&�2�w̼��ծ�n�Q�Vi�AvݭX��?����P-nJ�tQ�2� ���b뮚w�fw�� q�G�h�z�� e�y���p*
lbUV7��t*5�2�Q���[98vwž�1��,�/
ՄYe� M�RSe��u��^�������2��|`�bں���\I��Wa<U���6���#J1w�P��V�Q��IdŘ�_�1Kc!����Ʒ���/����~�>�D����avj�Dݲ��� �G���� �2hy�nɭA���U�ɇ����/���/NN;:}��.m]�`z:�6����I?�O>�
fKa��l�<�L��DG�T ��y�Ps�d�C���ˣ�bIl�EY1խ���im�d�m��݄sEH�+���C� ��ӁEư�$k[�G�#~�L���13��Ȭ���Y/�A`V� �&O"�M����T
��t�Q��E�7��J�ֺ�ta^z�@�y 2,^��]����7g�^��t
cƀQ U��vC���P s!���bJU�_N����jI)�� ֞ax~2�2I��0c[�T �D�v�ׇ���;�p,"�N;�l����:�dΤp�)|�j!g�OUؠO����Y�Yv�� �� ��;o� 1�\�l5� �����c��<E�7G}.�'E���nP���Wz��ޜ.�*i��0� /�~�x賆)�Hf��K��k��W������T��ˮ�%�(�q����;�uٴ[�m�qy��P�aU�ab�["��ɺ�|� 9:,�d���k�d@b�HC'�K���x~
� ۲~�L# S2��uiPױ��Bߴ�#7'�b~�,qBvy*�!��2���
N�bF�.�C-�@�#�N�/Xʐk-��L�h�C�΄E
��G K= ��p�`bK�.��H�q.��zo�,�p@Y��L�7�b���t� ���d.<�'��\y^p�0������B�:s�=r}o�>ڈ~�8㌒UJ�O�#����7�r����Uf�t(;�� m��뎔��X��/q~�\��Wڥ-@��m��
ZR�\. ����!���{�_ѝz����2 �p�b��*2Sl��i
aXZD���%�yŀ6��k<*Y�W'���%6%H� ����Pr�-i�0=����5[s���� �tREm�
j��� �M� �2}�MI�lii+Ў��ŭ�!/̮,mK��s�ϊ:��V�5őYr� �����Z��%����#~6]k�<&;�C\n���SQ����l������O� ���UC9���B�Mj����mg���(ҭN�w2+Eb�;2A�����6. �-�i���PT�2ګ܉�͝p���qDo�Y7�lr�6:lo~�ڸ��� ���բ�CA�-��CQ�I�j�7, ��,���������o�[{Ё�ڋ�^���"خn�W�J3�k��-�u�g�OӅ��4��N����>ᣀ�<���Ч�
�$$�u��g�u��Ԅ�1��J�b�WL�[�#��d3��#<q�J�'���T1��n�ҥ�����_+I"�&p�ӛ`����@�c15aq�,�]]� ���w�D��4��m�|{\�(�_��$i���/�eC/i 6{'�P�ɏTP��ҐF�U�P��B d5[3� ��CFE2�r �%��eJJ��)��
�NS8y�l �3}��p�Y�jc��#����m]iV����~[���/6�mk_;v�[�� A_U�����/��e�b�t1Wۍ
�_ߖr��~*�Mӆa~��l��>��[��$�1A_J����/氙��[R���`�q0���tU�G�����w0��ˋ]^6���M�^w��`�rw��eJ|�(ǀ ` ������d:i���*�>tr=롫x�JR7k�2N�!l�H �!���n�}�NLbgv�U��q�Jz�|�V���E��
��6;�ll� ���gt@�(�d�WܲJ��Hs��>,9��)�" 6ðlSߩ�F� =P�5 �ª�
̼�܆�b���z(�uۚ >S� ���Ŋ�Tw�k�+ �!q�#f�� hos��o�GJ�N�eFk�#=��&��%���L (�A#���+�k�֤f�v}�YqXe7,�B����%E����45Y�L��P2<|�0�U�� @����������=����9�O ��
\�r/��{�J<,��Lp��!H�aI^U�����$t���Z��V�v�?V�����0��6@b��G �*\�A��T�� ( �n]��-9R�^�Uc�fU8�������*}�����gz�9��"7%��j� =��I��a����m �^]8��H�R#[ʨK�-�쪝�]�.WI��&{�ѢHP� � �Q|Cm7ي��Aȧ�S͢k,K�R�����/���܃�}Jj�or�ѐ����TA��α�s�����Ҹ���ܶ�
�5���s�{<u.�k[��_�-kS-*Z�S�
�u��ϊ�� �|��G��7
�_/�'��Z�χ �y����j�>;�� �"2�ʇ�@�=L�gO|u�믽�+�&��I{�R͉ ��f�D���o����} f��@�� )�m=Pz�m=�Yx F�5��3ph=�ʃů��J�4 ���$��Y� ��T]������#����]_��O��#'s3�>F��L�}ī�{���Ωi�L� 4韖����j{s��>�*�w��l����@�ì�7g4�:n�e7m��h ΌÓ'� �h �����;硷�����_q�@�����ã�_;�ϟ� H��%^Ł��H8R&�n�Y��\|e��y��ׯO���V�q��ؾxL m��_���� C#� lb��+�Y��²�� �A g�t����@� Т�R�� ʱ�[j5٣ fX~"�E*��� ƾG1�dEHm5��'V���蘹��5��"�� ���n2�r�y�¡+���'��[%���Q��u�5���Z1'{��]� �7 !��O��(ʤ�j��[8)�F �N�<Yv�,꧱3�;�0���ֈ'�}�ޒa���l�����D�\ܠ�<�x�B:|"��y�l\�q����?�0 n
Ƅ
�j[o}�|%A2f^�Q��X�*�y`+��\�o�z�:�xt�Z��hL��F'E~�֮AqG �÷:�p�X�ʰ�i����m�tiRw���d�(ǟ� ��T���)��T@�Yp� �i�e�{���^ÈAal����i���ӯ9���tt`����;� �"�PzX�b�[��[�e�3�� ����;�r�\m�v��d�k8��.l�E��:b.��G��9���l87���-[{�� �V-u �bB�pH
z� (�,�K5��k~ќ{���\� ��7ѡ'쮵h��j'�E��^>ؾ����3�eu�C[zp).�x�%��;q��b��wMy�ʥ�,) R�5GT(�9y ��0�t^�gZ@ X�:zUuk�֕k���'@�2�wF��Ň �%�Ѽm�9+��Y G�`H��3 �4;@q茄��zN�
�;���1��q���'G�0�'�܅�mYI���eI��v��2�)�V"c'����k4��&, �O�c=��x9B
��
�a����:��L�[i�S#���U���ϒ�L�GI��/E\��+DڶvZ_E�&w���
���( �-�� ��R�C%��7�˂^�K$j��!��<M�[*�GCa(0& � ��� �x���%�r�͜��@���M��t<�"
lA=��B4�� ϡ6k�4u�<i�r|���\ ����|�m*i�]� y�c�@�<�Օv��R�kT�&[
!�T�1�ӟMH��w���&�������V�(��h� n���)$
`+ҝ�0��`�#v�Cr�3J?�;yd�܅�5q�:�E Q������TJz5�.l�N�ܺ v��R]��F
�ײ�$�LP��H
�(\�^ �/�D��
]�Y��)� x44��y�_U���śn�gt���衡�f��L����?^*9�]\I^_��l,5��!�q�{��U6�<Ϛ�庢��g��>̭�za��5�2y��U��ԑbdʫt�j$�6y�Dg �6+�$
�3\c�]��+��V�BB��R5�|�A�W'#6.|yǕ�(��Gu��yE�`�� �6.۷� (�*8��W��D y�
�*Q�]�qU�r}Ez��Hb��Զ�oX-F�� ,zbpLL�����- Y��/��go���F��-��v+��b5 1�dyquqse51b[��C-I�|^�w��ػb�I��ڔ<>��^ N�Q$A�/�� �m�+��.���}��n�\p��2���3���C#3
S���S�ye���҇7��`|�O9lu0��HJ�����i�!��"�u_>5+�6u��9��[f nŊ�Ҳ��ttx�[+g\�>��hN��9�3*CT����+�<ՉR >�r_�ҊG�� ��z�-���6o��h
���1�D4>l*
��4ϒVH4.�C�@�O�c=�K!@�l(O+@W��[��> �Z�ה���L8S��I;.��+)gJ�xj�]+�zO/bIx�h!�W�PfIn�Dg�6ޝ �#8JFn�XЅy E�(m��G[�*��)��� IJ��ܜ���vq�T��S�gܛ����m(sM�=!
���U[/Q O% {.̐�O��l��#}51�y��NMlV�#㾳�a�S'vY��,�V�iˢ�ߐ�Up}�فsT��hbS�e���h[�-p<6i�,;��
�G/U�ijG��q� ��<�:O����b������ 0�6�o� "���91�M�]L�����c�J��60��X�F�Vn�� �
f껉f�HB7���% �� R�>N�W�6��{�fa�:���_ܡ#T�f������I���|6M�ل%y� ��=�ca���S f*wƮB�XE�� �#��:�r�8!��8V��q Gņ̟�F��,,�m��E� �� ��~�O�r�$͡� g�� �Z���2v���X�SM�m�տ�y���p�Ӂ�|9�b͋�����s�fu��viHjr< ѐ�7ٔ���ӆ���^m9S�:�xa z� �{�dTOKo1� ���T]�V�潔����o��w����������G�;�&��K�t���B���F��34�2�\$�I F�ȐR�2�>�&,y'C4� ��|���q�nn0��T*�a�ar�E�r"Q��͍܍I���'��*�*@{���pntQ�R($i1�v��D~z��W�cb_.� ��� �yqr� c}��F���w�����O��z%��+=����0�]���ٹ�Q����?K�ޞ����vR��?�j���U������ޕ���n����O1,j��3�Ï@��ۆ�K%Z����E�� �r�����E(� ��1�`��X�oJ�Hn LBP04�bI��*O��g�[t�RpP�k��¶�'� �7 �, ���]�2���'<�s��G�
��G������
O�a��Y�{���=;=~{N8]����M&n�h�������{@��^�{���D��ō��Q�&� �yP���j �ܶ�X�\�ͦܰ'�E�<dWD� ��2�I�p��"/���B������Qp!o!A�h 6���I�<$��t�y���<'���*�$�8�ʍVU9��:;�<y��~�W7D&�W�7���$���3Ր��ύ��ގ}w�p,�.���h��G�/9�K� �&�^�[%�=��{��� �)���M�Y�$ Jk�g-kog������k�O^���Ó� � O'��0
~�(gFa���3��qAuj�] �����f7>zU�]�6�3ץ�W��zo�zx�N�,N���&�F�d�/RO�y�t�mI�E�Fi�T9��0>|,� �A�d�,�%rɒ�?�<v���X�7� *��BC ��)Z�� �
�hB!g�8�.1�8��D�� AUu�y�ܰ�jr%�?pY�=�FC���%L c ���&��`��V =��*�̝R��py�V p�W�͇�^3�N�hp�$,ɨ����IT�>Y`����I`E��5��<�_؈87��7C?O��N`�э����f}A�i\t���Q���\0wN���m�\;�& !m�+o�ڄ�P X�;m�LΆ9�B�p�S��>�0g%�� $�7ħ d#�� ��إ������2ѿ��bE ���%GA��j)�^7�F�{�3�@�<'ۚM��;JN!��vz�@� ���w�[5Z�`�z#�R����"`��o�� z$����_�Dܘ�&=��-�� w�E��O�Q�a+u��.?Q����c�M �zP�8� ��jC�:w
;"����,��ei��؏��F�5�����V�v4���E@D]��s�C�rTl�3ؔ
��t�]�aGxgIo�o I5���W �0s��;����'�,q��@^�|�ɀ�XNn��[I�F�6������:9�Ga_��ߝ�ή�Y�}ܐE}��x �m��E��g"*Y���ۗv3�� fhn�%� � '� J�o�<Tyٻ�r&8Ʊ�� ��"� S�Җ��s��h�ZD��_A��fӪ�]E��O;Ֆ��q�&��.��yEc�y:]�[�� �A��Q����}����E^�i���Z���z�<@|��6 xA*=MG)5� b��niFd�,�P�ܐ_'[1�lj�9+��n����-�nH�!b��L n���5� ��
� ����e�~�Dh���畆�>JA�px���6X���UI�E/�T/"i�����|fi<z��I�L<쟊WN��R�[�F�!?�R ��.#�Y�C�jņ�U�]u��7'�����ϏO��g��^n�;� �����G ���3�ڟ��\�� �����ݝ�������?|��r!OW.ܑ�Q�=���.<�C�ip��
�2�� ���u%u�g�>I�֑ ���F} ~܇C)MY�;�7 �()TB2ǣ{4�-�z+r�ە����
�γC�7�Oo�-C�J6�
�U����_�B��S���d��/J(B�nҤ�{5hD�O��;��� � �h\ts���]��_�"�-?F���e�� Q�>oϢ�f8^#���j��6�� � E� �=a����� �.��zp�����I@���=��職§)��-|���T ���(8�xg��|�~2d+�> .��\$g��Bt�Id�,Һ;)YuX�6 G��� %4 �����@��10,�f�@y�b�f( MF?��!yX��$�3� �w�p��e~ :VDK-��uFW�2E� ��0�m�K�� "'0 pv�(hYBr��suWE x�M]�r�a��v�gM ���Z}A��x�� b�e���{�>믲 ���K���� PX�1� �MG�&�W�1:#�rl�I�KL�O�)�@��� �J�*Uc���±�(�����h��kl�*�p����� ���
S�_}��ٽ:�?���
`�Z*6pw��$(�Q��3�}y���h�����}|��]}�iQE�c?~;`%���l��_��@g�h��ݭG�VsA�-��/��+� ��7���N��m ����k+HE� �d#wv,۶ƣ�X�����$��|�v�I� ���^<��c ��+�2��'Z5c�g�>�wl��ߵ�~��Oj�'hq�Ᏽ�� �O���������nل��-uj���<B|\�[�r ��CQh����� ��� #������ ��ɋ���W�N~�=�n g�ᯋ&���� )f���q⺟\����[P���>���S��vU� 18�ǘj�y�51.�%{���&S�� �]���!S����� R���Y�P�L9�%���y5�l.��n�#�̕`�w-x ��������{i��� ��<<� %�i������hDo��c���AJ6$z���;!5]l��]d0�Z�`�iͽgR�Lb��S���K��$v%�xM�+�4���cy��>;��w�pɭ�2�|�i���������QLa}���jXs��Xࠩ�cz���M��� ���S� ��X/`x�,f��B���҅����g��3CpF �篢(Nso�F�m��q�X�H\*�kX[���'��xug��[0��{��.��K䕓C>�f�F#�Z`{8c��7�)/�����e��-� ʻ���X4�k�S���]��֖8w;'[kW��}o��*3>��q����F�v�R�h��UB��Cw{{�X؋}���e�t;� �>�vRw���f��I�I�Pt���(�s���Eה�j�*m|->>U���
K�t���QuU�ן�z��9 2we%�h��&�\���㣏� Mr,�"��&�����G~��t��{eg2�%6퐫%Y�:<�?`�ۃx@� ח�U D�y� �'���vr��]ߛxr� Neѓm ?�s8��}qr�������������P�)��$ ��e�CXg�O�h�h��S�* �ț��j�4W��3�̊���8��u �YC l�nT��O,�[|���W��XL �
�f�$ Ì=�>� k��LU� D#�����S�kˊ��b�Y�ެ�
�!i���
C9�H�~�g��r ��^M���f�R���~
�����"�[r�i ^$���4��m�! �'<�湉�����j��蔮�ON1����1��UT#��� d,Һ9�"�Y�it-7��y�T��Y��X[j��]�E�!s"_�oL[1��m�,v4�Tq�_��Z{{zr~bl�J�Ծ� �>s3P �r���K�Ζ�'Ls��pXn��i<{e�óW[K=��UIB(�t[��mqH��U�?ֱI~�-z��.��i�,�I��%�J[&l��}�`��<�ܻ��kz�rl�k� Q`��Z�s\��Aj��uPܳ[kt�%�fWF����A)U�U��WMX� �o[�7�Vke����)��!�Z��`$}�u��q ��wg��ѯ�ǭ�e��z
�k&*�W�� ���<��N�V-E%2|� G�85�Q��5�� ��Y����
�(p��,�ʐmai���+�k�(��kz�?y�����+Q�]�IV������t�b8�94#ʶ6hIVн�a��;=�{�z罒p~��Ҷ!��0�oއ_{窡��1�&�; ���$�� =�-+�(� � �����R'8�A?ʝ��ߺ���MfN^x]5
�;L �K?X�S�C� �;t�>�x)^1 �{L�;����!C�C �,��aV��~�.�{��,�X�.�j�)�Y�� �uFAs[Q�%qe�i6��.F����.ԺgUiV]F(�U[�� R�r]� �yz~�L��c/d��/���衭��0�%�"?�=7�]
_h
��LJh C���ϭ`�I�8$���m3͞'����{�2���Ӡ ����luԪdv0�I.���R#�/ K�Q��0�L�:m�I��J���K|AU�H�2wS���"j;`Q_��R6RR�f��S����pi����汍��궻��nu9/4|�%Y��wYG*�U�@�yNu�t��Y�r`������oǽ�ˣ��-�#�,�13oS����%��Z�R�so]Qᠴ���qeF���N\�������S�� l���y8�M�-��2R)�Oi�
/�k�H��+4�I
��ɵ���G�4�r�v�x�r9MM�༟��ߎ�_6��7���K���٨���:�#�S�C�>�ի��F �i��E�`O�#� Z
Ci[�v�90_[ы�TeC�L+�����p�
����x+�/��䏍�x�1P9(����V�%8�T�P���jst�sUۑ0��z@��ȟ3G� V9�H��HF�(.�� � �Ֆ"��)��sϟ�8����� `��!��&�#N?Μ�@V$��'m�ak�O�¹WM�nEj9�{{ґ]"X9���j�HT
x��_��Ĝ�]�gFʒH �XK�q,%u*;�9����k) �'�*�Дs��,Q����--� �h*�Y
,�W>��l��}�{�Q2��ʂ���C�����j�o��bl��� �\�#�� 1� �P=��z���Ua=��M%5){�������f�%*�3̬��ݩI��ا
rj~�IӼ�k��T��@�_1C /���J���[ִh��.W�J��Z
-�>ώ��"M�*�b)�.�2�Ϗjr�U�" Ƨ��'����[R ���L
���\}�1��EiSo����Q�o��K` U�B�XX�~���|dY����<�� "Fd��4C L�Q��g��u�.�w�V �����g�"�AL�fO�ۤ��Z<' �@�c�}_Q�`m�� ���X��(t��~)����&HJ�^���d��:�jc�*1o>>��3�M\�ޓ��A�o2��q�/�]�G�'D��.Kvb�7-oe0%M��6������l���HB�R�ʊ'��rD�iE��R�H�D������X���+��l���!y�/���}0�Ɲ ��1��jP�e��@�ADQ7L���0J�1}@���}
��|�������ۏ$�V���k�?a�x?7ee���JI,��;R���%JCߖ�KD�KP���Dj5��b������VmK^���ˤ/�t�Z$iƈ� ���KX��&�*�}�=)?[[ %9�lޭ< �:�z�b x��!�P�zɞ��:Aڛ��jH�&����qro`ti�|�"Eu��_J��7��3�ey
!l��{
i���A��]�{���8XD9�"z�_Z:>;��?uvm�ъW��4��]�='Yn�³�4�<�o*����,BM��g�x��ɧ;�1��+��>
�#`�"3sL�W���K�a_�މG��i��`L�����#��R�T�I�Y�{%Q��K�Wè y��]�'q��J�s���U�=�c�,�M� �h��%������wzz���?9=����ѫ����jO��n2�~D��2J(��,Ҁ 6+y�](v-b-&�r&X
�� �m?2Q��n��a @��6��.�� ��[u�=�-� q�.0���U� J�
O��Q��+nG�R��R�M�Z�n!�l� #��P^}��j��k����ޮ_�ۖ��Z��[�
2�U5�
��gIY��J���>Gc�|�K������[�}��U�K�Jum� ��?LIot�0���A��yxݧ�� �b���jq<1���s��1� %� �>�� Ak�WIV�y���@_��[ ��n"�m��̦��f1 Ն 6�Ve�N� .<J�C��,T�Ѣxՙ]�k���Ҫ� e���ڒ!�~�哮^EJ������ʷ���a�&�5��S�s��$GImcC� }�-I�9s�N�YG �%9��K�$�9�¹���3�r��"o�M�����nma6�<�&%Ӥ�R �V��N1{�w��n+��x�q��h�#�]���.pݥ�<����hJl�D��Q]�0{LWt�Ή����A��<���CV��&Z��i��:^9���3�8R�4��Ӧ8���9O�G�� f��H�K � %�e{9P)�n, �0rY���Z�o/����_����u�Ϸ�k+�&X�0ˬ�۹��z� mC�I
��&1@��QrgM�-e ���U)�x�h���Zi�L+��3��.Q ���� �D����20����`�g� E3������p)�#�,��&$����察��X��h����رZ z9��zVCb#����J���< Ө@T^b.M)�I�w:3�ўgMd�/_�vG�2V��X�롋(dl��E�\�߈��I,:h��1Ɓ�L��<o�5�2Ԗ3��l͓q�W�R���ƮQn����;��t�5{�Pr� A�Lt��Ԗx /��_L�xw����ʝ��7�>%ؔ ;1�H7Cœ�����+@���]�O%������ ���e8Ӭ�c$�;����ۚ00��� �&�u��Y��y�����s�
��
�-�N8��&�-�:z�뻣_{�-�Y@n(�Gޘ��,O$��*�
�S���%J��Sxu�19 ��eE|�����n^\���Ɛ� �,�ܸ�
�X�:���8[$=G3�֛+<p2��F�����i��T��✮�v��i5%� W4�z�R_���qi�6�Oin��f��d��J��[� `����/��̜V-yI
�*O̊�A �z R�c-]D��(�l�>�� ��11+�g����_J~��^�5شzs�k��E.�j+�!��uX?f�ż�ro���+��D���¯ �s�cEt�Fa�w'��f�Xpq��&��/�)![d�AY%�����
n)uN@�M�L9E
��/7K#dW��j�=I;�n\IG�D�8g���ap*�(�5���IMq߸��W��!T �*��J����N��+R<"��n�x*�.�_�w�Ö�>0�.�
f�ۖ���֙ t�a���#��3O�]{Gs�/p"+ؾ<�xм� �W�[����J�Q�e�6ި�']H#൮VI���G$ċ�v� 9�KO_<� ��d���\�)� |���
�Ybㅏ k��;��n9��6 �
�B��Bt�h� c 1��i�m U ��!�����`�R�yn������.16*+ I�m+mW/� �6��H��Qz���6D�}��� �]�p��2/d|t��m��Ȑ��y$xV�p ����Y�^Jl
�W!�C���Z�v��� u^P�����n��#��T�x{ٮ�.R���Z�Z�VW��ݡު�����_��_���^]����ŋ��EϽ�qGAYnW���^t�����'���WU8�~�\�k�{��r5���UH�K��)�ų�w�/ON���y:s �G�}��<V.^��ax�N"Ϟ�KkZg�b��rYV��]^@\�y�3��֥�&���8�$� ̅,8�w��҃�z�-�גo?�Q�qqѝ��5�^}��ſ./.��{�S��_MX�'��� �ے���H&��$ξH�mu�/��Zo��N$��7- �11vwP,7�"Y���/� ��-~�Y*>�课GQ�ۨ�vQ�'��2�I_m�hȄy#2`������1��wJ)��g��,�V��ikޮݪ�5�m�Y�j���d���cg�視��/��Z(i���M��rM��3��*�s=\�n>�Չ���Z���Ѣ�R栒p.Xի
7��e��x�GI��y'�8M��zc}��?-㻚��f���o���Q\�Y%j k ��JuȈ��DWn���c ��f�(W���e"���]d���llZ�0F��!vo .��`���ޒ���￠�l������� �_�v ���� �k �z[��{0�Rn
�y*���:oŐ���O��.?C�3V�n��:{��)��B1�Fg�;�����XR������6�ݖ���C�0�;E[�$#�$�ؑ�1���?�I�aE;H�Z��jF 1|����9�#�&�N���tW_���u� Ѽ�J���8��[
n�
�=
��D
�U JN ��i��y���
�?�����㎸�7�`}H�J���>L.V<��f����Cԡ���dح�ST 2�
Y��Ԟ(��f���"�?�,c�j"V�E��I�w�N�� LKT���k�h )��+�d�1���lV�L�Н7 ����
EdËy�I%=:�>�pDQ ���c�� �?x��]��u��ev&��Ü�G]��R. ��� �J�^�Y
���[��si� jqD�Ŕec�}�>��v��Tm͌b�T��D�}|Xy�3�Ɯ&Z��Q���4�
��ʒ�H�O�� ��c7�q(+�R�4L�'��R�>��� Kp���>����x��� Zd{z��Pb�&)�d{�Xv������Iq��I��K��~�=�U��\�W�D�b�iN���S?+�0� N���ԏ��@�'
�/�9;^�� RVl�R �K�+x�Y� �ٚ�*.�2�YTfJڀaV��-i�jƁ�J
K ��Ym�W$��� *�p|-� �x�C���Ï�` �(%�S%���b�^{�HEWP縂C��4e�~�i
?1��t8����?M�
n�az��T_d�j��0cE� �&��K��Q�Ԣy�FmɊ��%� �J��H)<��k�Ji�u�]��tgɱYRc
���U{��٪���AD��I�Ӫ1X���E���3��6cz#{�9�u�6�Nf�E��z�Rّ3�4 G2����TH���M#X@35s�Wͻ�[v��@�>�l�_�a��˾�s�3���-�������
8ig^
F�rF�c�ѶAȱ�]��K�#'}땢r�|
�k%�g�k�*�� ��j]���|+���D��wz���|�@��Z��r>:�- �xK�����|7��k[0D���݃V��j@�~[E �9ya
�6�Aj�����dv�� �
]��!0���Q �Y"���p{��k*ȸ ����� �p˱4u� �I�cZ ��g�ip %B��E�BJ)-�|�� �]��/g�N$��/�R�%�K�ܹoz͊er�LR�殘��I�������C�Tu��} ��L)����~:)�i�?I(�|ӕ�-��ێ!�p4Wȳ��Lf\�G�'��ch<3ۙ�*a�"
77���{O��l���ckϩ�y���R����/ڥE�&C���|��Fp����:�{�R!�*�� �ȏ/��uހs���2���0W��7�ø^�-C͊�t�� "
ƒ;�l��3S/Բ�fg�B�u���r e2��P�ǻ]�^L�k!��X���XfxtmzdUf�'(\#z����M�(sP�H�<GX/ ~:���� i�oP�`
�� :$�͔q���,I�|۞�ϑ����� ���#��P��Ƕ�
�Z�L��ߧ-���5�
��q��� #@�U7}��4��*^�����I_tͤ�_zp�7�ʓ�0�M�箖��M�i�)X?�艍v�yI� +��?� MU�X�a�f@Y*�9mó������V
I�2�' ������^
��� ȡȀ2��3������֕Bz���`��O���A�z�ߓF�$�%x@�:��6�YP6��B�@�4 H��D���ď �� Hk ݩ?H�<B�zݓ "�� ���ʆ��>��;�+��)�!�=x�����Bz��7@���F�6�'_�'�)�?U�lH���F�:"�Q�mH� �p8S~�� �ix��ꃱ@aۃ�!�.�T@�܍w������=ſ���[��<O� 5��� J��@�B)�3^���;��T�3Շ�c��) 3��^�@���\�B�V�����l��������o# �ƀ��uC�+��2`V)�M����$���q��2O� ?��y ��`,����I�Ʊgt�&��Z{�r�.�����z�� �o���v��8c�o��|�(K.�`d��@l�_$XƐ�%�DJ�U������n��~.���6� ǟʐ�k�ã]C�!�M�r��4'�A� I����f�
� Z� �j%�
,h��0�[����36pԚ�:�v ��u'H��5��ۡ?� ��t� ��Λ�"����X�'V����H�Se3`�+�9_47<��\{fd���z��r(N��8?��?r�t��M*� }Us���5��ڻ�|�w�{��zQ|��=2�P {S6Tk��
�r���E�'{P�<��I2�~ H�b&iQ�q�� �ΊN��sPI�Z���Aޗ�ԇ�_���PC�D+��8 ݨH{ߊ5i W��4�/�9�jz pa�@U�n��a׳���Y�>:l�T˭� l��]��ۻCk�� ��얓�h�kj�Ŋ^�zv�8��^��v��(��h�a͒
�v��1w<�]���6i9l����R�J�;�)�8Дtns��(���\r(�| �p�: �
��#H~�EY��/i��0١����@ �eD�@�q� �'iks���-*��'(�+(.�gzZ��,��nВ����Z�����if����[gT��a{�X,���5T��d��{t����.1�H�c���*���>�-�V-̳^+40+2�����l6cM�f���r�\���]Nt_�:-�k�J��x���P�a����W3��_�шB�q���|��w{��t#c�����?c��|�J(��a��n��҃MÃ��, �k �3��!b������� (�F��
I��m����q��(�h�2�鍱�4O%Ǡ:�0���G~ː���k�Q/���&簛x^�I� �GE�<��FM�3�M�� �|�bCv�� ��oCI�(�s�C�����nd%=A�ųpIy�b�+�ʙ�|� 2M�̯�X�H�p� �#�"�g���T�D�o5�g7~E�� EX�� �^I�M �;��� =��LxBw����,
Z,����<��3�d �)�6�e��،L��X��C�z U���6�� ��ĉZ3,��¹qn�]4�v���\���zJƘ� � ��s͠��&��\[�Oq̊~CS9h�Qa��c@���gt
Ų��Az #�dɈe���s�t(꧈�F�ɐ>�� ��x!.#`�MK��x*Et�ڄ�F% [P\d4I9Hr�^�58\�N�E)��x�F8x�,�S��6�}q'۵/�ܬ��>* ��`'稃��.�h��t�Q���c�G2�!�˗ v�`}+;J1�P����$&k�$��b����9�{%Mt�5AR0O����)���&��$������4h�(���Z
+��Tl��ea�
�H�f���E��W��$
�c���nc��i@a������s�I��+#��j��T ��$j}aWpBk���;�b�j���~���}�cI `� ��~�k��Y�(܃)P��AL� ��VF�X���Úp���ȫ�c�u��O(K@X1�U� �;(^�x��:���Ux�ΉN{u]<�
Y�>�S�3�� 1F5���ԃA>*�`{��[��e�l �B�)�)�{H��|� �m�y��&ƽ+�d=�z� ~��������Y<�?�U�$ ��q�n�7����[_/��?�.&���}��Γ��I{m����w��]�(�q$*�M�J��3^�Gt��,��x�.��I�ՠN�Z�J#�G:p�x��az6J�g���$�6�2uk �k�|��gn��7����E��B� �\�ql�y�K2 л�c��Ϲo���Y�O�Q<䓚c� ����bk�L���o�3Z{�y�� Xʋ���\Q��Bs�3�fU�(����B� *~�k��s�L�*������@O
��ʠ)���U+3l�� ,�����A�x��� ��}�c��N/�B���s��r�i��@?���O�謵�����+��S�_�/� @-st��ا�<��K�1���ѐ3�
Eȱ� x("Of��M^$9�,���!K<�A������ꑲh�^]��8;�G�'!
w���X�qԪr��G�Ȭ�$�m4�����g�h>��� ��m<��� �㆝��(�ƀ��L�Gr_t +��s���D�pj(5�Q01k��a��Q"N�K]'!� %;z�nZ��b��T8 ����Ȟ��̅�1�є�fEإ�5^V��(Վ#�ԁ�I�̂*/� z=FG�8a@�(`�O�b1� �"�б
d(abV !�~Lre���I%��>E��h��d��7��0��o�I�g��M������h�� *�}Z� րp.!+�j�aإt�b��c�=}8|�Se�
/n<g����[��9�w�G�̓�@`I#�2�UZԱV��
8�Iꚝ��6 Y�� 8�����:�;k�� ���zhB[v
�s�j��:E�\�� P�~�_�K�&�o:��]ܖ�h�@//���Ξ[�T�v ��8I�> �`���j��y����{���(���N�z���М�|�� Av�(0cf��/�.,EPU+Г+W�
B �B�c@g��׆�u����ڭ���[�rDQ� l�a�ԉ��_E�?�/�6K"T��ʤ1�&���K�*x��]�w"G�B�y�@�p �Z��0�� ����1o
b�J'�,� 7 �7� ���( N��~~��a:���� ��ؐz�q7��qwi��!�@{��VZ���Oa�.�4���$�IZ�I��@z:�Ke: �o� �oH�
��(��o�67��V�,k]=��Y� �C<�T �[ӂr� ����$�Yg����`��
��J ��9f���E9Xs�`o*�Y�.���:��3t5k���0*+L�-�j��{��ەF�ǎ���<�Xw6��0��5��)�������ļMŅd��٫�gW�x����g�� � �X H D
�x
�(Hc՛֫x�t�ţ��x�"�-p�+gl\�t��X��e�(�}��9
���9�ԶJ��*;;A���1-]� ����쑡 5 �� ��k�`s�:�Ô�A`�� �k�/V[���*��o��}��h�����=��C�Zj�&�q���dy���0S�NY����d�{�Y��TLA�0�M�с�@b(�\�"B�6�d,:�6&��� Ē)vB���V�I��*�[L|�[SDϑ� ��3ND�A�R��xy&4*4���T����P��F)��YW�b2H�D�����z���h�P?u�5
=5Ƣ�����Ϫ�]+4e��,;�¯A&
�Cd[e1��32* d� �k�BI�,��
-�e6� �1y ����PGn��;��F�Iv�c.-7D����F�(L������VU�:S��G�=Y��5A}��t)�l�t/vR�ٽ�,�J�٧��������{�Ԡ[
Q�v�u&�k\������
5�="�C�b@g����x욂� c����g�쥱%O=�{�9��*%L�$$�x�D{��IQ���:��]�N�߆^ŗ�ͬ}�"��%� ���j��, d-� ��C�)B^�:�����g�����1�,��DҎщIpV@N,2{{��U����s�eڂ��W�����i��'��Q��L�p�������C�49 ܚ��H�-�H�٩k�%��?�4aw $� ��~�~o��� �$K��A�F��i�LXu�02��E�'T�W��Z6 �. �@�+=��ê�����>�a��B�L�ͯ���y�?
��E���h��gmmm#���x�t����=�(�U�&�����孻4����N������ -۲Y
�����]O�u)˗}��D��4��L��H)�X�2����Jʜ� W��, �,�HאQi�rE&�� �h�8�(G
�Mڔ���y��pJ`Y�����R2v�QbE�>i<E�(�OS����R�L#�1G���p�<-35(��-� X�72���c��Fפ!�ƾ�yD�N�w�{!��]uX")ta4�L
����B����P/+}6�'�Ō��$ ���x([B�ha9ÒI^.�iz�MP/�LY��e���C8�U���&*�g�5�c��L��7
�1W�%�V��d$b�ߙ� jW=�~0'g��$י�G%��(]��w��� 8�.�����o�o�N��ݨ�J��uZ2 �"��e�{o)��&6�ܺB��B{�ҵ ���M��Ʈ�8UI����,6��d�u��gY��������i����J�<�������]E�y?�aT� ���?̞�N,PU}�S ���N��S��tϑf�@�s&�!��H;�P��<��A S,q+Q�����X�~� �� z}US� M��`<&�j
��j[�;ʔ�� ��u/��@w+�ʟo0g(�D��h���J:F5��4�����"��f��U��=ުwk�߰�
#�*N��-;����m�tr_`���߬�����h(%�߬�>���y9�
��t�=s��H@Њ�^���2 ��8���@7v�ۑ�tC��0�� �� ���� �E5$Y�^ēiQ�!����c $3�yP��P��J[�"��<� �erGd��䝎�!_�Up��Ш����,\�=S%e���wh5�[ӷ��\�G
t�F�<�.Y¦#�#PQ����.]tV������P��$���HuY�#�S$��ُ�c��j����br4�i|�����
��ֆuU�(>KIK�Ջ�ٲ"i^����`B��c�3~Y|H��Kj�8W�G�:ND� G��F��g��Z�ּ���� �~xs���,�k(�{�= 8�����wo�,9n�K&`m�jU'��|��`�8-,*����ގ�4[���Z��_�u���3?JB��j��WX�� <>$ve�5��$�F騢2�n�1�Y�U��z
��d�ݜ KAs�ě�e��Bo�jS>� S�\ /0�vڛ�g�g��BC�֫���8M,�������Ý7{�u�a:^l~ۻ�C|� �D'�/6[\�TOқ1�DdG�IR�S�\<��h�ȥ��\L��v�u�� c�촧�b�*,���+�Y������ �h3 f�Y�� �g(}J�uM��4�t;�tcF���h�V��H�ͫ�8@κ�)�
�x�
��,��
%S�$8$��g�o�S��Ywycc�-�閺�`"��{��dJ��Rm��
]��|�3��-{����s5��1\���P�����L�Wp�δBk����tӵ��^n��Q��s����Z5R�bT7�]�RPk���V�����s�x,� gd�� ��a���!����a�5N�A"��˾7�S`�<`6��O��9Z�� �<�7=";��"���p|ӝ�Q �9 �0" y�&�*W�(���
�[^�7*����U��"-u��><1�4�� 喻d�wMz�?��|�Af��G|5� tl &��H��Z D�*�C�r$��]L�&���D ��%�q�7��k�z�w��z�^�� .li ���s8�%�0�I���E��I�06/��ar�=ܔ
-����c ��܃�����VTzin v�S��v�Z Ø
�
pg9�C��a}�ggÒ�t�ث �e($��%�ka/�d�(�-ij>^ve� ����� x<.���,����Օ�@�W�n�g��y1W��L��q���3p�k�D��:������0?�Q�6�k��L�
�_ ��|l�6�/�,�hq ���%=r�C��15��WG��1Eny
�(]Љ��F�r-��(%�sgk5�L�+�ŴfI<Jq�^��>w��5ʉao��x� �f�p�f�I�d���{�o-ָ��|�lڗa%9�]��H��� M�pv������͎�s|A���z�&�Z� �;��F�.3�P��(�?5�W�o���9���l�FM��`����� es@��C���e� ��A!PgFAf��+��C�U��h}�yݬ�L��L��g��?/��!)��5�#P�rU�)�P��ѓ>L���f�!* ?6+�mƇ���T���J�_� ?&��Xq[Y�|���z 8�<c:��8nZS�q�Fx���C9��ӳW�$�?/( ��䈼vbMU�k#�|a#�]��~o:O.4�zQ{wK����E-����4�B�mT�A���ak�f�� f4��
�� `6s�9 � �o&�%�5�"鬺�+�!ƃ���8���BN� ײ��� ���Jt ����33�p8�� � ���+�X᪥�8���W���z�2��rk�VY� ��o�F5
vDE�3Q �0r(�{��Bl�*Eɪ�n!�d��n�`�"��� � "���(�y9���*#��v'+a��b\E~�Z?i��5�K�ٔĤ �(w.��\k���'����3��I�0��I�z�S�;��0�����j6_�, �Z�ײ%}�$cR��M���^E�WC�y�y� �*��~��*[
�f�_�ɭ�Z�SL��`� 4_79U�H��Lg�q3�x����pޏ�I8 g�41� �}�,�&J#��ݨ��s�o�����X�� c7�S�.�$������iA�Jm�q &�`���͑5�s�
2 `~"�(za��'P=̢�[�PK֢����|2�х5^�*����� ���8|�鋋Yp֫,9i"g_y����fˇ��{iq:9�����T���=$��
�KYew��⛭���}��ݮonw� ��&��5"U\B�:�|oo�R"
E�}$2� �gqK���� Wd �
T^d {�����jtu����(7l^��|Y�E�UY�B�:���y����۴�ߖ�� ѤW����qW:ؤ��q'�ŗu�,�ݘ^M����5��R�C ��}P�W��z�WV�Mv�dz}W:��x\�(��-=t 4y�d���ye����K!�^�<O�^$'4�#��x�3��i!l�jl�Xk���z >Z���G�| ���`w,ۑ ��+sdHc+��O�,&���9� ��ȇO��G�.�,s g8�J���l�L]��z;+�0`Q�.m����]b</�L Hf� �L��.X.5�$���S���=��Vp�iq�q[�O(���I� Q*��|TR̐��-\{�
*�@
��� �dv>4gcr�Oݜ�؏� Oo��n� �Vȗc���W#��:�/$
֕�r-�D|(�nOT�8Რ��������+�> m�S���[Q\68UJ:���݁�� ��Z:x�Zq����J��#�/F�?�f�|�4WM�g����b�[$
F������~�RP����#�AI��߅�`էr�W�M|c/r�u�bU�%�j� �&(�
Z-�T��H�ٯ~���lc�w�{�??�tr=��g��=� R�� z� � ?P�u���N�O��,��p�O� �F*T',㡹=ICl�� Ӊ�J0�49�L��߈\Jy�pY ���Y�n��92�[Bt
�Q�D2ǀ>�4LgĔ����Y� _�7�ޡ�;�R�,���= s�O���Td�>�L&�{x� e0dY�+C����A� G�/i-{e�A8��fO����SŐ�2:k�N�1�5�C F��5P.�{���6Z�P�u�ٵ��ћ� o 8��=��{k|M~G��|� �!g�Z.��.yHʱ� ��=:�f �}�,�9��w��Տ+�CR���8��(��! �=��
�M���/�<î�n���-�m�n�=闸(������t�_��e�K����=���[��T��d����R�H{ �^>G�א��k+�{�k]G�/�\Z�t�w�� ��-v.*1�B?�R��CѺ�u�*9W����[��{�X>
��|������B��z�,/�t�KĎ�5�@�g�H�RszY�~����]L���@�+k�Mu�.1!��Cֆ�F(���o_XvҐ�+�4�x��q�
� Y�t]ِ��ښ�[nR�Ƈ÷Nx��XӒ�iŝ�:K�Ƃb���Uii�F `~��o���m_�Y���t�X��b�?"��_�>}����o<���0� �/�0 'AQ��L, �_i�"� K�1��O���q�po��)���
�c ,]
A
����,� ��4 #��By�A��y�X��_FZ��`,���$g`ђ�m�#!h*�.]�e@h.�〿)E��896�>��~K~�ȥve�S ;�'���d�^�I0
}�B� �w��)e�H���U��10���� N�u<\�Ul�.�l��N*�t�oz�l���@ �Q:tJ�$���g�
���^�%��jyu��D�v�Ӳc�#�\28�+� /�r:�[1���L <�p@�S���̷��
Gu��?�\� s�~���p��Y��8���[=*$�h����(��kf�tpr` 5o�� ����s�E���r��O�aW��o �F�z���[�(`6]@t g�|�J��X ]}�"9��F��x���#�F�Bo��J������)�l�P��.�`gA]�"�`Qϝ�B���,˝��xd��S��܇�~�� ��C� �(�a��Sۀ��' ����w�v}39��;�� ��Z��re9�C�j]�&l*+1�|)|J~��^ru[\��dD=����zm5�Ԑ� �ދ��������X%�� ۺ �,B9�F�?�A ɟ�j {��U
���I=ߩ�d��7O�D�g��S����r�� Px �\ ���з�� ��V���|����]j�~��izv�W���*�}�\���� �/� ���S�/�� ��LD̓f�������6h�ČA]� xvHt �E���D�, �0�!���nB��L��N�Α�P��\3�����C�\��6A� ��R�"<7(�"Q����%�(�@a�j��2���~���8!�̤tCET^ � �-���|� w D��2�=�I��8��<g'F���� ɤ�u�Y�p����8��º,v(u �%�� a��EB�Z��xT���hs���z:�T�UF�D�J�ɜ{���80o�u��Z����}����ZUH�� �YDfq�4c@ �eCLӫjJ�D~ ��<>��Mj:|�"�i�Ɓs�6k���x�� �)fT̍���c��3
q?y WKN!�v�e*M�"/�'>ߕ+`�EP�O�e �0vg�e��ொ�G�� ��A/����S�+>돚�5��+U���|�g�Ϋp�M�FF!k3"�l��
�=���l��q>��
2耋�,�S:��o��| ���v�H����7����,�)�;�;ov�;<x�+n͊Յ����)ED�g5'/q��z�g�I�SY�v4���V�N� ���� `\ �Q� �5�m�U����1,e��ʜ��i�
Ⳮ�?a��=fU�a�ʻ�4��kqK�jʏn��$ nyh�enA�ڶ}g "�p���dA���B+�5�﷏� ��_ �(�ŝ�O�;�Rm�b��y[ܑ�]��|ۯۡ.�a�h렳^pP���+�z��[ O���ӖG�9EZ.�P���LJ�Vz���Z���������e�p�iU|�⭷� �p:*7�N��Z���x��
f�m ��/�#�dQ�
���i�߅��C�E���:)�-y�1���Zd��*�+eY��V)��o�$��cX�xI���ޖ.�����A�hi�W|��P��ea��_e_`����왜-|���(�m&��%��[�N�P7�[mMA�qn�ˁ��cH���b����5���3��[/��W�4���kg� �=�C̱�jX& x�ڡ�f�l���tS�0���b��t�Ȇ��He��Gl,����`[���!���)��w� ���l�h�3�����j��a�k�F�^X>CK(P�Pq��N��̉��,������;��\����W������x�.I�nC|b�!��p :���Ȥ�Ju� rcJ�����B/Pw�w�s �vo�I ���o��}�(��� ����2�bl�n�b��|�:�)LL�<��9mn .!�Ik�Q`"�0��� ���6��|:�۳���Vr�щ��ם �U�Ոi���W��#ځa��>��'�'u����Z�J�H��KegZ����wl���-��SnWȶ���$vϱ�|x{�,��n���?�&����d h~V���J��L� I���Q�����;*R��]1���ιH����!į�{V�K�[2U �a<�+���H�GG������@(��$�G��3�����' ��e��!MZ�U{��%� �AH�\�~ � ��w��. (�J�> J4MYje��qp�2@�
��RklX�(ނ֨�V`H)`�B�G�U ��:�X�a�.Ђa�5-\
�cy�Rx�$7zk9�+�� u �+��ד�P�PL��HB�,�E��,Q�O-�n��P��2��t`�L��H��~�c��^
.�%��T _�D�HU ���y�d��_0c
��� u� w(}M��=�;A�c ��%��4�7�V �s��T���'d���,��^� ����j'� �p]��2[��N⌽cZ�▬���$��9q*"{O^m�H��k��|�e �AM�W��[�nl��} U�r���dN�H�ĝ�7I �� \��/�gk�
��o]�bK4�_�X#��5Ň�����;��!�zԔ��K����T�)�ئ�\Ģ�b ���C�7G�Ib 8���=t��BDZ�B���@3$ �ȱ��?�L�j�
���� 8�je��U��� �_w&)�+ 8�]��> +�-37K�}n�>�xs��OE�ſ��3��[S�Li��#Z�����¢�����~ ]�.P��`(�7uVY���f�?�)���,I�a�;�G�aU�'�+9="�� �*HTA>DuG��5�s6�GT ��� �ѐ1�`o ���h��T*,F�vI�X&Si���#��R��760��sV��
���k���~���f�����& �d> �
{+ܤ�㷆�8�F�K8�.W�Z�F.g@��x!J<��Ɯr��:�'�|!Lj5/;�F��K6� $%< � ��<QC;*�V�R>*���V��U�����+<�cACK�) x3�{ y9]����Д��L���`o�o^��$���ߓ��Z������������5 7��u�i�c�\z��p> ���(�r����Q?)I��������_��f0E/�Y�]y��TPTݍ5%_�8B�:��������*�4�������d ���?�Wظ� �Ư5)��N�/���3 `��K��:@�潏Qaޏo��L�,� ���4'�n�U�1���º��L��q �
�iy�N ��j�����ǃ����'�x�ݻ����� �[ps��o;tu�5 ��Iq���k$ܢ�`|&ɺ���������H�$ f��2�8�S\���#����S`ya)I�1Us���% �r'�^���y�B��,<?'�7�<��$<e�:8�T�* �n��],�m���̝,`�>Y���*4F�����t� ���8�w~�c�
A^�8
+u�TH՚N� u=�/����j���L�G0vU��g�E�~� iӑS�;跫m�Q`�#��0 � ���pRݾ�L�
��t�M.toQ^�gp���!\��o�H�}� �,z�a=~,��>̀GA ���HB$8�
GA+g-.ra8uvbF�@=h,���� �<ϴ+ꨀ�7�u��R���� �' �1Y ��7 bB��d$�p���,7�z�(h=����. <��
�[�`�������R7
�8���9'��:�V ŪStY���� �V�1��$�ĩ+E�B�#���#�C�U � ������� @�����=��V��Z/�eHR'�u8�OD4��e����{k�}nG Þئ$�Lvc k�G7�� SF��J��l��9x�U�\ M��w*���N�(�y��iѸ𞹻���*��ۃ
F��x�v���q� �ʠ��.�Y}V��sD�f�ԯ�${z07�/���5A�4V& #y� ;V8�,�M�����T����a�w75@d�iz��Z�1VRؑ���LX��d�7�Y���|ӟ�� ��h0�M��}d
�D�n`� ���4��(���(_�!��������`A/�H�| N�!��1�����&`�ɓ����ޚ��G��
���^ ם� ?�9���Y�� l����������" ���� �ZKyd5�?��Y�$����q<ŶƗ��� 㦊�+� gKY� ��(�}���_��ܿ!�SG�L��^������C)h��`���6�S���< �2��#-�'���x��>�Rf��r&X6�K�V� �뾸+���$���RL��|Z?���e��R�3���*�UJ�� ��Jv�����R��}VC���M�� ۹���~��C�ײ-4�.n�]���䨶�f�?��W`^?�͏t��g��2 �4����t�рI�>�\*�X���u2���e�8�
�C�Ŏ�Z~َ���A���Jj�4�T�uߒ��K�c8nZ ��
��U�IG��ķ�4�KC����s���f��GG��:^��O��� ����_z���#��Roi!�*X�m)
���ӷɞkb|"�-+,Ԡ���pJN�y�N���)�B������N�W����|$��s����L6���考�>��i���0��,#�ί�VWM�pv�7����%P-
�uk�7��KRs�Ngq��m��l�N�U���l����Z`���o:�(�����D�L�5Y �K���ڴ@��f��:*Ɨs(�.���/+� `[�Km����9:�\Ldmd ^�Ս�p��Tg��l�6 `�bg� ��h ��j�ݐ����H̬sdN������4Lg���\̱��/�'��n �J1�1�hXJ(�,�:��r�*�̀@�-u���g�&;o$��VW��[ ���P@�-���âfOK j~O� %��wK���X��{��V� ]mk��պx,��v]���V3� ��D}��\��{���~w ��T�p�;2}^i�����8�^��/��U�r�z��y]�T�5�;X�[����|x��ש����}cC1�0+�c� ��J,vY�c ڌ��a����"��� ���k�&��0
�$'+��,�1^)1�!�]�� ��c9�����]@�F�ijU�+�#�0p�9�v�
S� )�0 '���I����C�8&��`Vab�*e� �x6��f�%��E� HZ;�MBz�M�q��GN��Wl邊���"ZA}��n�I2Yu
3J�t�d�
�kX�ꗹ �<�b��0��D�亃!� G~J䯬�%�^�� p���7�߾E�p� �yRmJ�Vд62�U�홛�md��@������� ˊZa�1 ��r�Ԭ��T�h6�+BE̦� �����~��B^eByZI�X4_�~�������*�X9ʋ_93��c� ��Ս'XII���(��I�'�_(o0��&l3� ��#;F�'����d�">��d� �+d)��'�3��qW'7WtrC��k/����,�҆�Vz/*�4�<�mW�&ͽ�p�]��B`�8�L��1��ǭh���4�Jݺ�?���i������ ᨈ<�{U�"�@
���"�<��@>)S,���<���{:�r��Tr�#f:�
��*�� .²���%D�d�Z͚!%A�z!�]��߷5�� �����Ƀ <�!B������G%Bb4�<�ʃip�����<NŲ��"<�_��Rd������ps�s�4!���<��-������9 �p�N�.KjdUX�ZD\\{����)��!�B|��`}��63S���qI�#;Ŭ�7z�x^q��S$���U�;c�6�}jr�VN� 8�Ŀ!�Q�/�hZ2$���x[aL^A^A�RfQ�j�Yw�NF8�K�т%��MF��W�$$�Eb�� �[�+�x�@X��e ' �v����MKJ�T��������
�3�G�x��۫�i�̴'^c�x�@�$�i̖ �hi��"N��$�W�!�e���j��[�ה�f�"�B$ AzF��( R�Zd���r�U�P���v��f~~�V��PIe QF[�� �W7�F�"f�
ɳA!�����S ��2j\iX�t ����A�� �R턚���=�t�]AK� A��DŌ "�� ��D�� ?S���� ��p>��7dX�N��!Y9$���H緧���S8��I�`�!��ּ��<��\>�?˚�ܿ�He���
� $|0 (�Uzo�wh6��.
C~E0�z�d]�(����|�p������D2��ؽ�W}+�F:%n�*�'j��Af��� =��ԫ��گ�JY�I4��%�A�I��/��+�ލLt�y�L ��}��8�N��s��z��P�ؿ o�k���V�"�ڸ���� �I!$�U
L\����SIQ$!��F 3�9�-+AP�Y��)d3s�5�U�X��W��J��=�^$y���g�v�����d[�Ri�P u���72l��������?� ��C�D|���ߩ��Lԣ�β�a�l �=�SL�=�hy��4Y���N9\���%�X�������3��������hH�1r�-�G[�H�к� ���Qe+3�Kg�W~pϢ�夵D*�����:�0�*����P���+�oQ��n|���_ �!�|�L�vd�_p�D�����}[�uF_ ����0�]�77 �E�^ �;5�.�pTrW(`�9}"����yP
!\3&�'[�ޢ��4�>�^A?0���vO���u�] OuE
�>j�p�D���� 7��Kӈ���ٺ����b�~6�1 P0��q[��� �Y�C��,a%-1��m�/�
��;y��v��/~xw��4 ���Ԭ��7 f���,Y�jNh٫. �i�]o�ôZ�X�HSn���}�Қ_&�j�a��<R&��Ұ�j��w_�B�J1���+Ny�_9��b$O�CD�Nw�<���z}�q�tR�4h͋��v���16�� �=�Y ��i�M�ą�2�p�a(���C�ݣ E������ ~#��0k�lp�iR�K���aDbL�� ��dЅ�-��N~���n���=4 ݷ�5#���K#ǚk�d3�8�����jX������l��lu�����6���Y�AbxtV�NɊa)�@/����WŬ'�:,,ӯhS%~G[�0��*��
@U�2�N
�j��8"�&]9�@9�̰}����i��Q�S�4�� ���A�6Ռ��������?�V�\<?��� ��~�
,�;�毳�X�kO^�ۙv�x�zB�4J�ګ���9Z*<Ҟ���MG)(�pTv�T�v��
Δ2��j�jG!� ��~�)�n�YG;i���sߛ��V#���P�{X��ڔ�d~v^7qr��@{��W���R�[.� Z�f�2s�hb#�k��ږ���m똚��{'��e��� d�D��7�]gָ�4�f ��\fܿ����C
⋞�K��o |!'�́7��Tb�s6�\>�Yv���4����z��j4�yz1`1y�%1�wG:1�T�^.&q�\��u����ݮ1_Lda�2�Q�Nи��2�S"�'�����H��i�.��;�7�7�w<'B�RW$�qz�+�J-[9ch�fu CR}!�q�R�1��w�8#�]g���z�ɬ�
qZ���'!)���9���� ���i�x;� fC�A��L־7��0'���� �NO�
�4���A��|��mO\���I�Ѻ;��Ԍ��)�%��(� U|�Ĕܝ��o>&�:#��TL�P� ^�7J�N�|Dq�=�]�ԛ��$�����Eh.�c��m��o���,e�9b-�6���JGa��m9� ��]7S��dB��j
������H�]`�l�^�3fs��!�F�B87���b
f�x����)�̍� �m-S��GMkU#'B����%�� �E�^���y��(��$T�^Z�S3�) ���H�@�?
N�}*���=�s�yH$�mq5C!5���@N�eũ�'�{���C'�cC@#���O6�v�;�+)���Ge�����Z�P�]�"���\�Α2�%���Ҕ��J
�� '�H.b��`�&�gE�D?�~j ��*�|Ba��]�bd� F����� �3м=e���H�
/
9�K�?�#��pI ow�R �F@9�=ʿ)�h�=��a��@�2?��Q!���Ȥ�hS�Lt$h� �~�� �UxN4=iQ:{No�Ħ �4;�0��R5�,��Ԍ0�
�U���q�y�ިm=�q��c�C����z nK
���A����i���ñUY��1�(���է��������F�ռt�<:�>�p4�9x�{d9Bt�m2�%��A��?t��!
��h�Y�2ҧ�M�Ok�iן��Ow�mU�y�7���á������; �~ 5���� q����S���j�^��U�(���t�qN���П�Z�)}�H�Mηm}|Ɲ�<�a��� V��;L�fޯ� z� �v.�f�*���� Ƌ�/�7V �8�?g��YC��2Y_� ���Y y����v[_x������ ����3lZExzt��E��D|��n}�9����o���
3�� C�(Qv�59?�S`"��bf�u9
�� �q�*솮�8�7 ��S�a�o�-:
H6����$j2[���xn�_��=���ux�~ �����-_��u�f&6�>��ñSfMM�8�59�c��X%x�0� }�-��ޑxI[}@�w���
�O"K�p*����*�s��~awW�6 F�� �VWe��햮���a�q���� �<XnV�
� �y�8D
�/<�����ɯ��z���n� �U� �X_�8X�'�xM&�E+�D�+��u�o�s ����đ��D��=��Ā6G ���}�TGo�=L������]q�� ��c}S4kv DPX����BȺ���D�\� �� �%!��C�(���Qj�Ob� ��)����ʁ��nH��hݹݯgo�)�GJ(h}�� u4�
G�)�R�L���r?c�)ѫ�Q�-';,�*��!ʸ9O�T���0SC VRK��Ҡ�]o(���|�?��� ����{�?�?x�#���ߝ�j�dx^�/��0>���@��ԩ{��F�aZ;A��~]�� �������sQ �Xe���o(.P �OW���ɑ��1�m�V[
Q T���A�g��w6��u�-F����oK��/��ҫ�{@ሼ� �= F� �
k���gզ2��BG
+KY� �M!h�v� � PO8'Y� _���B��������VLlL�B��(ʫ�_��A�Ș���?ڭ!9��T�v���%(�%��`� �#
��^�2�UＪ�↼)�ٮlpUF��܁������`n��
��t`�*�J]u4��4a�fW�``�+������? �>�|lW�"���j�饨 �Q9n�\�_�Z
�^�c������|������t#�����_Pr?���:�͟6�6�� `|���%�J� ��"үI`�D{��+*�_,-/q�]�m���� �t$v.U_B_&+h컽�&G ��L ����Zl��vogw�hu�Jf�L�lP'd���= ���JV�h�s2
q� .g1��p�˲�Jb�ɦ��>�q��/����,3G��� �<��oM�y�,�fA����.�0+��iLUu e��U�g��B6��G:֣�J���@E
�Ҳ�� � `�NC��=\9Қj��@EV]Yz�T��po�<y:�Z�A�e��_�a-}�Ŗ\Y�z�e�GyA��>�w��n ��浽gl��a`2 t:!D�i������bԔ���h���럯~�?� �� �Ke� B checksums.yaml.gz 0000444 0000000 0000000 00000000450 14442217575 014616 0 ustar 00wheel wheel 0000000 0000000 � } �de�;r@ D�=�^`���Μ�s}�H(G���CH�@�O�z� ?������ ^���~�y{���-�y��x�r�L��N5"1���vNy��}�>��O|� ���2�Q�SL
cqD\v Y �9�- 3����ٟ>i�>tM�o8�[x͉]'?Ղ)�<I�u���%K�d�FGn6UQ�an�h��2u;�ZA��4h�Ap( ݃ �͉s�i��̫m�R��b;��M�|oK���Vv�J4h��]��Xs3 �魄#ԫ�n�is�'�ޅ����1e�� share/gems/specifications/bundler-2.5.22.gemspec 0000644 00000026142 15173517741 0015350 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: bundler 2.5.22 ruby lib
Gem::Specification.new do |s|
s.name = "bundler".freeze
s.version = "2.5.22".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 3.2.3".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "bug_tracker_uri" => "https://github.com/rubygems/rubygems/issues?q=is%3Aopen+is%3Aissue+label%3ABundler", "changelog_uri" => "https://github.com/rubygems/rubygems/blob/master/bundler/CHANGELOG.md", "homepage_uri" => "https://bundler.io/", "source_code_uri" => "https://github.com/rubygems/rubygems/tree/master/bundler" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Andr\u00E9 Arko".freeze, "Samuel Giddins".freeze, "Colby Swandale".freeze, "Hiroshi Shibata".freeze, "David Rodr\u00EDguez".freeze, "Grey Baker".freeze, "Stephanie Morillo".freeze, "Chris Morris".freeze, "James Wen".freeze, "Tim Moore".freeze, "Andr\u00E9 Medeiros".freeze, "Jessica Lynn Suttles".freeze, "Terence Lee".freeze, "Carl Lerche".freeze, "Yehuda Katz".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Bundler manages an application's dependencies through its entire life, across many machines, systematically and repeatably".freeze
s.email = ["team@bundler.io".freeze]
s.executables = ["bundle".freeze, "bundler".freeze]
s.files = ["bundler.rb".freeze, "bundler/build_metadata.rb".freeze, "bundler/capistrano.rb".freeze, "bundler/checksum.rb".freeze, "bundler/ci_detector.rb".freeze, "bundler/cli.rb".freeze, "bundler/cli/add.rb".freeze, "bundler/cli/binstubs.rb".freeze, "bundler/cli/cache.rb".freeze, "bundler/cli/check.rb".freeze, "bundler/cli/clean.rb".freeze, "bundler/cli/common.rb".freeze, "bundler/cli/config.rb".freeze, "bundler/cli/console.rb".freeze, "bundler/cli/doctor.rb".freeze, "bundler/cli/exec.rb".freeze, "bundler/cli/fund.rb".freeze, "bundler/cli/gem.rb".freeze, "bundler/cli/info.rb".freeze, "bundler/cli/init.rb".freeze, "bundler/cli/inject.rb".freeze, "bundler/cli/install.rb".freeze, "bundler/cli/issue.rb".freeze, "bundler/cli/list.rb".freeze, "bundler/cli/lock.rb".freeze, "bundler/cli/open.rb".freeze, "bundler/cli/outdated.rb".freeze, "bundler/cli/platform.rb".freeze, "bundler/cli/plugin.rb".freeze, "bundler/cli/pristine.rb".freeze, "bundler/cli/remove.rb".freeze, "bundler/cli/show.rb".freeze, "bundler/cli/update.rb".freeze, "bundler/cli/viz.rb".freeze, "bundler/compact_index_client.rb".freeze, "bundler/compact_index_client/cache.rb".freeze, "bundler/compact_index_client/cache_file.rb".freeze, "bundler/compact_index_client/gem_parser.rb".freeze, "bundler/compact_index_client/parser.rb".freeze, "bundler/compact_index_client/updater.rb".freeze, "bundler/constants.rb".freeze, "bundler/current_ruby.rb".freeze, "bundler/definition.rb".freeze, "bundler/dependency.rb".freeze, "bundler/deployment.rb".freeze, "bundler/deprecate.rb".freeze, "bundler/digest.rb".freeze, "bundler/dsl.rb".freeze, "bundler/endpoint_specification.rb".freeze, "bundler/env.rb".freeze, "bundler/environment_preserver.rb".freeze, "bundler/errors.rb".freeze, "bundler/feature_flag.rb".freeze, "bundler/fetcher.rb".freeze, "bundler/fetcher/base.rb".freeze, "bundler/fetcher/compact_index.rb".freeze, "bundler/fetcher/dependency.rb".freeze, "bundler/fetcher/downloader.rb".freeze, "bundler/fetcher/gem_remote_fetcher.rb".freeze, "bundler/fetcher/index.rb".freeze, "bundler/force_platform.rb".freeze, "bundler/friendly_errors.rb".freeze, "bundler/gem_helper.rb".freeze, "bundler/gem_helpers.rb".freeze, "bundler/gem_tasks.rb".freeze, "bundler/gem_version_promoter.rb".freeze, "bundler/graph.rb".freeze, "bundler/index.rb".freeze, "bundler/injector.rb".freeze, "bundler/inline.rb".freeze, "bundler/installer.rb".freeze, "bundler/installer/gem_installer.rb".freeze, "bundler/installer/parallel_installer.rb".freeze, "bundler/installer/standalone.rb".freeze, "bundler/lazy_specification.rb".freeze, "bundler/lockfile_generator.rb".freeze, "bundler/lockfile_parser.rb".freeze, "bundler/match_metadata.rb".freeze, "bundler/match_platform.rb".freeze, "bundler/match_remote_metadata.rb".freeze, "bundler/mirror.rb".freeze, "bundler/plugin.rb".freeze, "bundler/plugin/api.rb".freeze, "bundler/plugin/api/source.rb".freeze, "bundler/plugin/dsl.rb".freeze, "bundler/plugin/events.rb".freeze, "bundler/plugin/index.rb".freeze, "bundler/plugin/installer.rb".freeze, "bundler/plugin/installer/git.rb".freeze, "bundler/plugin/installer/path.rb".freeze, "bundler/plugin/installer/rubygems.rb".freeze, "bundler/plugin/source_list.rb".freeze, "bundler/process_lock.rb".freeze, "bundler/remote_specification.rb".freeze, "bundler/resolver.rb".freeze, "bundler/resolver/base.rb".freeze, "bundler/resolver/candidate.rb".freeze, "bundler/resolver/incompatibility.rb".freeze, "bundler/resolver/package.rb".freeze, "bundler/resolver/root.rb".freeze, "bundler/resolver/spec_group.rb".freeze, "bundler/retry.rb".freeze, "bundler/ruby_dsl.rb".freeze, "bundler/ruby_version.rb".freeze, "bundler/rubygems_ext.rb".freeze, "bundler/rubygems_gem_installer.rb".freeze, "bundler/rubygems_integration.rb".freeze, "bundler/runtime.rb".freeze, "bundler/safe_marshal.rb".freeze, "bundler/self_manager.rb".freeze, "bundler/settings.rb".freeze, "bundler/settings/validator.rb".freeze, "bundler/setup.rb".freeze, "bundler/shared_helpers.rb".freeze, "bundler/similarity_detector.rb".freeze, "bundler/source.rb".freeze, "bundler/source/gemspec.rb".freeze, "bundler/source/git.rb".freeze, "bundler/source/git/git_proxy.rb".freeze, "bundler/source/metadata.rb".freeze, "bundler/source/path.rb".freeze, "bundler/source/path/installer.rb".freeze, "bundler/source/rubygems.rb".freeze, "bundler/source/rubygems/remote.rb".freeze, "bundler/source/rubygems_aggregate.rb".freeze, "bundler/source_list.rb".freeze, "bundler/source_map.rb".freeze, "bundler/spec_set.rb".freeze, "bundler/stub_specification.rb".freeze, "bundler/ui.rb".freeze, "bundler/ui/rg_proxy.rb".freeze, "bundler/ui/shell.rb".freeze, "bundler/ui/silent.rb".freeze, "bundler/uri_credentials_filter.rb".freeze, "bundler/uri_normalizer.rb".freeze, "bundler/vendor/connection_pool/lib/connection_pool.rb".freeze, "bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb".freeze, "bundler/vendor/connection_pool/lib/connection_pool/version.rb".freeze, "bundler/vendor/connection_pool/lib/connection_pool/wrapper.rb".freeze, "bundler/vendor/fileutils/lib/fileutils.rb".freeze, "bundler/vendor/net-http-persistent/lib/net/http/persistent.rb".freeze, "bundler/vendor/net-http-persistent/lib/net/http/persistent/connection.rb".freeze, "bundler/vendor/net-http-persistent/lib/net/http/persistent/pool.rb".freeze, "bundler/vendor/net-http-persistent/lib/net/http/persistent/timed_stack_multi.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/assignment.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/basic_package_source.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/failure_writer.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/package.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/partial_solution.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/rubygems.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/solve_failure.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/static_package_source.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/term.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/version.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/version_constraint.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/version_range.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/version_solver.rb".freeze, "bundler/vendor/pub_grub/lib/pub_grub/version_union.rb".freeze, "bundler/vendor/securerandom/lib/random/formatter.rb".freeze, "bundler/vendor/securerandom/lib/securerandom.rb".freeze, "bundler/vendor/thor/lib/thor.rb".freeze, "bundler/vendor/thor/lib/thor/actions.rb".freeze, "bundler/vendor/thor/lib/thor/actions/create_file.rb".freeze, "bundler/vendor/thor/lib/thor/actions/create_link.rb".freeze, "bundler/vendor/thor/lib/thor/actions/directory.rb".freeze, "bundler/vendor/thor/lib/thor/actions/empty_directory.rb".freeze, "bundler/vendor/thor/lib/thor/actions/file_manipulation.rb".freeze, "bundler/vendor/thor/lib/thor/actions/inject_into_file.rb".freeze, "bundler/vendor/thor/lib/thor/base.rb".freeze, "bundler/vendor/thor/lib/thor/command.rb".freeze, "bundler/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb".freeze, "bundler/vendor/thor/lib/thor/error.rb".freeze, "bundler/vendor/thor/lib/thor/group.rb".freeze, "bundler/vendor/thor/lib/thor/invocation.rb".freeze, "bundler/vendor/thor/lib/thor/line_editor.rb".freeze, "bundler/vendor/thor/lib/thor/line_editor/basic.rb".freeze, "bundler/vendor/thor/lib/thor/line_editor/readline.rb".freeze, "bundler/vendor/thor/lib/thor/nested_context.rb".freeze, "bundler/vendor/thor/lib/thor/parser.rb".freeze, "bundler/vendor/thor/lib/thor/parser/argument.rb".freeze, "bundler/vendor/thor/lib/thor/parser/arguments.rb".freeze, "bundler/vendor/thor/lib/thor/parser/option.rb".freeze, "bundler/vendor/thor/lib/thor/parser/options.rb".freeze, "bundler/vendor/thor/lib/thor/rake_compat.rb".freeze, "bundler/vendor/thor/lib/thor/runner.rb".freeze, "bundler/vendor/thor/lib/thor/shell.rb".freeze, "bundler/vendor/thor/lib/thor/shell/basic.rb".freeze, "bundler/vendor/thor/lib/thor/shell/color.rb".freeze, "bundler/vendor/thor/lib/thor/shell/column_printer.rb".freeze, "bundler/vendor/thor/lib/thor/shell/html.rb".freeze, "bundler/vendor/thor/lib/thor/shell/table_printer.rb".freeze, "bundler/vendor/thor/lib/thor/shell/terminal.rb".freeze, "bundler/vendor/thor/lib/thor/shell/wrapped_printer.rb".freeze, "bundler/vendor/thor/lib/thor/util.rb".freeze, "bundler/vendor/thor/lib/thor/version.rb".freeze, "bundler/vendor/tsort/lib/tsort.rb".freeze, "bundler/vendor/uri/lib/uri.rb".freeze, "bundler/vendor/uri/lib/uri/common.rb".freeze, "bundler/vendor/uri/lib/uri/file.rb".freeze, "bundler/vendor/uri/lib/uri/ftp.rb".freeze, "bundler/vendor/uri/lib/uri/generic.rb".freeze, "bundler/vendor/uri/lib/uri/http.rb".freeze, "bundler/vendor/uri/lib/uri/https.rb".freeze, "bundler/vendor/uri/lib/uri/ldap.rb".freeze, "bundler/vendor/uri/lib/uri/ldaps.rb".freeze, "bundler/vendor/uri/lib/uri/mailto.rb".freeze, "bundler/vendor/uri/lib/uri/rfc2396_parser.rb".freeze, "bundler/vendor/uri/lib/uri/rfc3986_parser.rb".freeze, "bundler/vendor/uri/lib/uri/version.rb".freeze, "bundler/vendor/uri/lib/uri/ws.rb".freeze, "bundler/vendor/uri/lib/uri/wss.rb".freeze, "bundler/vendored_fileutils.rb".freeze, "bundler/vendored_net_http.rb".freeze, "bundler/vendored_persistent.rb".freeze, "bundler/vendored_pub_grub.rb".freeze, "bundler/vendored_securerandom.rb".freeze, "bundler/vendored_thor.rb".freeze, "bundler/vendored_timeout.rb".freeze, "bundler/vendored_tsort.rb".freeze, "bundler/vendored_uri.rb".freeze, "bundler/version.rb".freeze, "bundler/vlad.rb".freeze, "bundler/worker.rb".freeze, "bundler/yaml_serializer.rb".freeze, "exe/bundle".freeze, "exe/bundler".freeze]
s.homepage = "https://bundler.io".freeze
s.licenses = ["MIT".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "The best way to manage your application's dependencies".freeze
end
share/gems/specifications/ruby-lsapi-5.6.gemspec 0000644 00000001707 15173517741 0015566 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: ruby-lsapi 5.6 ruby lib
# stub: ext/lsapi/extconf.rb
Gem::Specification.new do |s|
s.name = "ruby-lsapi".freeze
s.version = "5.6".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["LiteSpeed Technologies Inc.".freeze]
s.date = "2024-01-22"
s.description = "This is a ruby extension for fast communication with LiteSpeed Web Server.".freeze
s.email = "info@litespeedtech.com".freeze
s.extensions = ["ext/lsapi/extconf.rb".freeze]
s.extra_rdoc_files = ["README".freeze]
s.files = ["README".freeze, "ext/lsapi/extconf.rb".freeze]
s.homepage = "http://www.litespeedtech.com/".freeze
s.rubygems_version = "3.5.3".freeze
s.summary = "A ruby extension for fast communication with LiteSpeed Web Server.".freeze
s.installed_by_version = "3.5.3".freeze if s.respond_to? :installed_by_version
end
share/gems/specifications/io-console-0.7.1.gemspec 0000644 00000002003 15173517741 0015667 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: io-console 0.7.1 ruby lib
# stub: ext/io/console/extconf.rb
Gem::Specification.new do |s|
s.name = "io-console".freeze
s.version = "0.7.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "source_code_url" => "https://github.com/ruby/io-console" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Nobu Nakada".freeze]
s.date = "2025-04-09"
s.description = "add console capabilities to IO instances.".freeze
s.email = "nobu@ruby-lang.org".freeze
s.extensions = ["ext/io/console/extconf.rb".freeze]
s.files = ["console/size.rb".freeze, "ext/io/console/extconf.rb".freeze, "io/console.so".freeze]
s.homepage = "https://github.com/ruby/io-console".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Console interface".freeze
end
share/gems/specifications/bigdecimal-3.1.5.gemspec 0000644 00000002257 15173517741 0015714 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: bigdecimal 3.1.5 ruby lib
# stub: ext/bigdecimal/extconf.rb
Gem::Specification.new do |s|
s.name = "bigdecimal".freeze
s.version = "3.1.5".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Kenta Murata".freeze, "Zachary Scott".freeze, "Shigeo Kobayashi".freeze]
s.date = "2025-04-09"
s.description = "This library provides arbitrary-precision decimal floating-point number class.".freeze
s.email = ["mrkn@mrkn.jp".freeze]
s.extensions = ["ext/bigdecimal/extconf.rb".freeze]
s.files = ["bigdecimal.rb".freeze, "bigdecimal.so".freeze, "bigdecimal/jacobian.rb".freeze, "bigdecimal/ludcmp.rb".freeze, "bigdecimal/math.rb".freeze, "bigdecimal/newton.rb".freeze, "bigdecimal/util.rb".freeze, "ext/bigdecimal/extconf.rb".freeze]
s.homepage = "https://github.com/ruby/bigdecimal".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Arbitrary-precision decimal floating-point number library.".freeze
end
share/gems/specifications/rake-13.1.0.gemspec 0000644 00000003501 15173517741 0014623 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: rake 13.1.0 ruby lib
Gem::Specification.new do |s|
s.name = "rake".freeze
s.version = "13.1.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "bug_tracker_uri" => "https://github.com/ruby/rake/issues", "changelog_uri" => "https://github.com/ruby/rake/blob/v13.1.0/History.rdoc", "documentation_uri" => "https://ruby.github.io/rake", "source_code_uri" => "https://github.com/ruby/rake/tree/v13.1.0" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Hiroshi SHIBATA".freeze, "Eric Hodel".freeze, "Jim Weirich".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Rake is a Make-like program implemented in Ruby. Tasks and dependencies are\nspecified in standard Ruby syntax.\nRake has the following features:\n * Rakefiles (rake's version of Makefiles) are completely defined in standard Ruby syntax.\n No XML files to edit. No quirky Makefile syntax to worry about (is that a tab or a space?)\n * Users can specify tasks with prerequisites.\n * Rake supports rule patterns to synthesize implicit tasks.\n * Flexible FileLists that act like arrays but know about manipulating file names and paths.\n * Supports parallel execution of tasks.\n".freeze
s.email = ["hsbt@ruby-lang.org".freeze, "drbrain@segment7.net".freeze, "".freeze]
s.executables = ["rake".freeze]
s.files = ["exe/rake".freeze]
s.homepage = "https://github.com/ruby/rake".freeze
s.licenses = ["MIT".freeze]
s.rdoc_options = ["--main".freeze, "README.rdoc".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Rake is a Make-like program implemented in Ruby".freeze
s.installed_by_version = "3.5.22".freeze
end
share/gems/specifications/rdoc-6.6.3.1.gemspec 0000644 00000013026 15173517741 0014724 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: rdoc 6.6.3.1 ruby lib
Gem::Specification.new do |s|
s.name = "rdoc".freeze
s.version = "6.6.3.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 2.2".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "changelog_uri" => "https://github.com/ruby/rdoc/releases", "homepage_uri" => "https://ruby.github.io/rdoc", "source_code_uri" => "https://github.com/ruby/rdoc" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Eric Hodel".freeze, "Dave Thomas".freeze, "Phil Hagelberg".freeze, "Tony Strauss".freeze, "Zachary Scott".freeze, "Hiroshi SHIBATA".freeze, "ITOYANAGI Sakura".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "RDoc produces HTML and command-line documentation for Ruby projects.\nRDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.\n".freeze
s.email = ["drbrain@segment7.net".freeze, "".freeze, "".freeze, "".freeze, "mail@zzak.io".freeze, "hsbt@ruby-lang.org".freeze, "aycabta@gmail.com".freeze]
s.executables = ["rdoc".freeze, "ri".freeze]
s.extra_rdoc_files = ["CONTRIBUTING.rdoc".freeze, "CVE-2013-0256.rdoc".freeze, "ExampleMarkdown.md".freeze, "ExampleRDoc.rdoc".freeze, "History.rdoc".freeze, "LEGAL.rdoc".freeze, "LICENSE.rdoc".freeze, "README.rdoc".freeze, "RI.rdoc".freeze, "TODO.rdoc".freeze]
s.files = ["CONTRIBUTING.rdoc".freeze, "CVE-2013-0256.rdoc".freeze, "ExampleMarkdown.md".freeze, "ExampleRDoc.rdoc".freeze, "History.rdoc".freeze, "LEGAL.rdoc".freeze, "LICENSE.rdoc".freeze, "README.rdoc".freeze, "RI.rdoc".freeze, "TODO.rdoc".freeze, "exe/rdoc".freeze, "exe/ri".freeze, "rdoc.rb".freeze, "rdoc/alias.rb".freeze, "rdoc/anon_class.rb".freeze, "rdoc/any_method.rb".freeze, "rdoc/attr.rb".freeze, "rdoc/class_module.rb".freeze, "rdoc/code_object.rb".freeze, "rdoc/code_objects.rb".freeze, "rdoc/comment.rb".freeze, "rdoc/constant.rb".freeze, "rdoc/context.rb".freeze, "rdoc/context/section.rb".freeze, "rdoc/cross_reference.rb".freeze, "rdoc/encoding.rb".freeze, "rdoc/erb_partial.rb".freeze, "rdoc/erbio.rb".freeze, "rdoc/extend.rb".freeze, "rdoc/generator.rb".freeze, "rdoc/generator/darkfish.rb".freeze, "rdoc/generator/json_index.rb".freeze, "rdoc/generator/markup.rb".freeze, "rdoc/generator/pot.rb".freeze, "rdoc/generator/pot/message_extractor.rb".freeze, "rdoc/generator/pot/po.rb".freeze, "rdoc/generator/pot/po_entry.rb".freeze, "rdoc/generator/ri.rb".freeze, "rdoc/ghost_method.rb".freeze, "rdoc/i18n.rb".freeze, "rdoc/i18n/locale.rb".freeze, "rdoc/i18n/text.rb".freeze, "rdoc/include.rb".freeze, "rdoc/known_classes.rb".freeze, "rdoc/markdown.rb".freeze, "rdoc/markdown/entities.rb".freeze, "rdoc/markdown/literals.rb".freeze, "rdoc/markup.rb".freeze, "rdoc/markup/attr_changer.rb".freeze, "rdoc/markup/attr_span.rb".freeze, "rdoc/markup/attribute_manager.rb".freeze, "rdoc/markup/attributes.rb".freeze, "rdoc/markup/blank_line.rb".freeze, "rdoc/markup/block_quote.rb".freeze, "rdoc/markup/document.rb".freeze, "rdoc/markup/formatter.rb".freeze, "rdoc/markup/hard_break.rb".freeze, "rdoc/markup/heading.rb".freeze, "rdoc/markup/include.rb".freeze, "rdoc/markup/indented_paragraph.rb".freeze, "rdoc/markup/list.rb".freeze, "rdoc/markup/list_item.rb".freeze, "rdoc/markup/paragraph.rb".freeze, "rdoc/markup/parser.rb".freeze, "rdoc/markup/pre_process.rb".freeze, "rdoc/markup/raw.rb".freeze, "rdoc/markup/regexp_handling.rb".freeze, "rdoc/markup/rule.rb".freeze, "rdoc/markup/table.rb".freeze, "rdoc/markup/to_ansi.rb".freeze, "rdoc/markup/to_bs.rb".freeze, "rdoc/markup/to_html.rb".freeze, "rdoc/markup/to_html_crossref.rb".freeze, "rdoc/markup/to_html_snippet.rb".freeze, "rdoc/markup/to_joined_paragraph.rb".freeze, "rdoc/markup/to_label.rb".freeze, "rdoc/markup/to_markdown.rb".freeze, "rdoc/markup/to_rdoc.rb".freeze, "rdoc/markup/to_table_of_contents.rb".freeze, "rdoc/markup/to_test.rb".freeze, "rdoc/markup/to_tt_only.rb".freeze, "rdoc/markup/verbatim.rb".freeze, "rdoc/meta_method.rb".freeze, "rdoc/method_attr.rb".freeze, "rdoc/mixin.rb".freeze, "rdoc/normal_class.rb".freeze, "rdoc/normal_module.rb".freeze, "rdoc/options.rb".freeze, "rdoc/parser.rb".freeze, "rdoc/parser/c.rb".freeze, "rdoc/parser/changelog.rb".freeze, "rdoc/parser/markdown.rb".freeze, "rdoc/parser/rd.rb".freeze, "rdoc/parser/ripper_state_lex.rb".freeze, "rdoc/parser/ruby.rb".freeze, "rdoc/parser/ruby_tools.rb".freeze, "rdoc/parser/simple.rb".freeze, "rdoc/parser/text.rb".freeze, "rdoc/rd.rb".freeze, "rdoc/rd/block_parser.rb".freeze, "rdoc/rd/inline.rb".freeze, "rdoc/rd/inline_parser.rb".freeze, "rdoc/rdoc.rb".freeze, "rdoc/require.rb".freeze, "rdoc/ri.rb".freeze, "rdoc/ri/driver.rb".freeze, "rdoc/ri/formatter.rb".freeze, "rdoc/ri/paths.rb".freeze, "rdoc/ri/store.rb".freeze, "rdoc/ri/task.rb".freeze, "rdoc/rubygems_hook.rb".freeze, "rdoc/servlet.rb".freeze, "rdoc/single_class.rb".freeze, "rdoc/stats.rb".freeze, "rdoc/stats/normal.rb".freeze, "rdoc/stats/quiet.rb".freeze, "rdoc/stats/verbose.rb".freeze, "rdoc/store.rb".freeze, "rdoc/task.rb".freeze, "rdoc/text.rb".freeze, "rdoc/token_stream.rb".freeze, "rdoc/tom_doc.rb".freeze, "rdoc/top_level.rb".freeze, "rdoc/version.rb".freeze]
s.homepage = "https://ruby.github.io/rdoc".freeze
s.licenses = ["Ruby".freeze]
s.rdoc_options = ["--main".freeze, "README.rdoc".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "RDoc produces HTML and command-line documentation for Ruby projects".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<psych>.freeze, [">= 4.0.0".freeze])
end
share/gems/specifications/rackup-2.1.0.gemspec 0000644 00000002456 15173517741 0015114 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: rackup 2.1.0 ruby lib
Gem::Specification.new do |s|
s.name = "rackup".freeze
s.version = "2.1.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Samuel Williams".freeze, "Jeremy Evans".freeze]
s.date = "2023-01-27"
s.executables = ["rackup".freeze]
s.files = ["bin/rackup".freeze]
s.homepage = "https://github.com/rack/rackup".freeze
s.licenses = ["MIT".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.4.0".freeze)
s.rubygems_version = "3.5.3".freeze
s.summary = "A general server command for Rack applications.".freeze
s.installed_by_version = "3.5.3".freeze if s.respond_to? :installed_by_version
s.specification_version = 4
s.add_runtime_dependency(%q<rack>.freeze, [">= 3".freeze])
s.add_runtime_dependency(%q<webrick>.freeze, ["~> 1.8".freeze])
s.add_development_dependency(%q<bundler>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<minitest>.freeze, ["~> 5.0".freeze])
s.add_development_dependency(%q<minitest-global_expectations>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<minitest-sprint>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
end
share/gems/specifications/psych-5.1.2.gemspec 0000644 00000005173 15173517741 0014761 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: psych 5.1.2 ruby lib
# stub: ext/psych/extconf.rb
Gem::Specification.new do |s|
s.name = "psych".freeze
s.version = "5.1.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "msys2_mingw_dependencies" => "libyaml" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Aaron Patterson".freeze, "SHIBATA Hiroshi".freeze, "Charles Oliver Nutter".freeze]
s.date = "2025-04-09"
s.description = "Psych is a YAML parser and emitter. Psych leverages libyaml[https://pyyaml.org/wiki/LibYAML]\nfor its YAML parsing and emitting capabilities. In addition to wrapping libyaml,\nPsych also knows how to serialize and de-serialize most Ruby objects to and from the YAML format.\n".freeze
s.email = ["aaron@tenderlovemaking.com".freeze, "hsbt@ruby-lang.org".freeze, "headius@headius.com".freeze]
s.extensions = ["ext/psych/extconf.rb".freeze]
s.extra_rdoc_files = ["README.md".freeze]
s.files = ["README.md".freeze, "ext/psych/extconf.rb".freeze, "psych.rb".freeze, "psych.so".freeze, "psych/class_loader.rb".freeze, "psych/coder.rb".freeze, "psych/core_ext.rb".freeze, "psych/exception.rb".freeze, "psych/handler.rb".freeze, "psych/handlers/document_stream.rb".freeze, "psych/handlers/recorder.rb".freeze, "psych/json/ruby_events.rb".freeze, "psych/json/stream.rb".freeze, "psych/json/tree_builder.rb".freeze, "psych/json/yaml_events.rb".freeze, "psych/nodes.rb".freeze, "psych/nodes/alias.rb".freeze, "psych/nodes/document.rb".freeze, "psych/nodes/mapping.rb".freeze, "psych/nodes/node.rb".freeze, "psych/nodes/scalar.rb".freeze, "psych/nodes/sequence.rb".freeze, "psych/nodes/stream.rb".freeze, "psych/omap.rb".freeze, "psych/parser.rb".freeze, "psych/scalar_scanner.rb".freeze, "psych/set.rb".freeze, "psych/stream.rb".freeze, "psych/streaming.rb".freeze, "psych/syntax_error.rb".freeze, "psych/tree_builder.rb".freeze, "psych/versions.rb".freeze, "psych/visitors.rb".freeze, "psych/visitors/depth_first.rb".freeze, "psych/visitors/emitter.rb".freeze, "psych/visitors/json_tree.rb".freeze, "psych/visitors/to_ruby.rb".freeze, "psych/visitors/visitor.rb".freeze, "psych/visitors/yaml_tree.rb".freeze, "psych/y.rb".freeze]
s.homepage = "https://github.com/ruby/psych".freeze
s.licenses = ["MIT".freeze]
s.rdoc_options = ["--main".freeze, "README.md".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Psych is a YAML parser and emitter".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<stringio>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/singleton-0.2.0.gemspec 0000644 00000001660 15173517741 0017250 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: singleton 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "singleton".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/singleton", "source_code_uri" => "https://github.com/ruby/singleton" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "The Singleton module implements the Singleton pattern.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["singleton.rb".freeze]
s.homepage = "https://github.com/ruby/singleton".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "The Singleton module implements the Singleton pattern.".freeze
end
share/gems/specifications/default/ostruct-0.6.0.gemspec 0000644 00000001500 15173517741 0016746 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: ostruct 0.6.0 ruby lib
Gem::Specification.new do |s|
s.name = "ostruct".freeze
s.version = "0.6.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Marc-Andre Lafortune".freeze]
s.date = "2025-04-09"
s.description = "Class to build custom data structures, similar to a Hash.".freeze
s.email = ["ruby-core@marc-andre.ca".freeze]
s.files = ["ostruct.rb".freeze]
s.homepage = "https://github.com/ruby/ostruct".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Class to build custom data structures, similar to a Hash.".freeze
end
share/gems/specifications/default/pstore-0.1.3.gemspec 0000644 00000001610 15173517741 0016557 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: pstore 0.1.3 ruby lib
Gem::Specification.new do |s|
s.name = "pstore".freeze
s.version = "0.1.3".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/pstore", "source_code_uri" => "https://github.com/ruby/pstore" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Transactional File Storage for Ruby Objects".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["pstore.rb".freeze]
s.homepage = "https://github.com/ruby/pstore".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "Transactional File Storage for Ruby Objects".freeze
end
share/gems/specifications/default/fiddle-1.1.2.gemspec 0000644 00000002401 15173517741 0016471 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: fiddle 1.1.2 ruby lib
# stub: ext/fiddle/extconf.rb
Gem::Specification.new do |s|
s.name = "fiddle".freeze
s.version = "1.1.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "msys2_mingw_dependencies" => "libffi" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Aaron Patterson".freeze, "SHIBATA Hiroshi".freeze]
s.date = "2025-04-09"
s.description = "A libffi wrapper for Ruby.".freeze
s.email = ["aaron@tenderlovemaking.com".freeze, "hsbt@ruby-lang.org".freeze]
s.extensions = ["ext/fiddle/extconf.rb".freeze]
s.files = ["ext/fiddle/extconf.rb".freeze, "fiddle.rb".freeze, "fiddle.so".freeze, "fiddle/closure.rb".freeze, "fiddle/cparser.rb".freeze, "fiddle/function.rb".freeze, "fiddle/import.rb".freeze, "fiddle/pack.rb".freeze, "fiddle/struct.rb".freeze, "fiddle/types.rb".freeze, "fiddle/value.rb".freeze, "fiddle/version.rb".freeze]
s.homepage = "https://github.com/ruby/fiddle".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "A libffi wrapper for Ruby.".freeze
end
share/gems/specifications/default/fileutils-1.7.2.gemspec 0000644 00000001630 15173517741 0017253 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: fileutils 1.7.2 ruby lib
Gem::Specification.new do |s|
s.name = "fileutils".freeze
s.version = "1.7.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "source_code_uri" => "https://github.com/ruby/fileutils" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Minero Aoki".freeze]
s.date = "2025-04-09"
s.description = "Several file utility methods for copying, moving, removing, etc.".freeze
s.email = [nil]
s.files = ["fileutils.rb".freeze]
s.homepage = "https://github.com/ruby/fileutils".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Several file utility methods for copying, moving, removing, etc.".freeze
end
share/gems/specifications/default/syntax_suggest-2.0.1.gemspec 0000644 00000004413 15173517741 0020335 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: syntax_suggest 2.0.1 ruby lib
Gem::Specification.new do |s|
s.name = "syntax_suggest".freeze
s.version = "2.0.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/syntax_suggest.git", "source_code_uri" => "https://github.com/ruby/syntax_suggest.git" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["schneems".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "When you get an \"unexpected end\" in your syntax this gem helps you find it".freeze
s.email = ["richard.schneeman+foo@gmail.com".freeze]
s.executables = ["syntax_suggest".freeze]
s.files = ["exe/syntax_suggest".freeze, "syntax_suggest.rb".freeze, "syntax_suggest/api.rb".freeze, "syntax_suggest/around_block_scan.rb".freeze, "syntax_suggest/block_expand.rb".freeze, "syntax_suggest/capture/before_after_keyword_ends.rb".freeze, "syntax_suggest/capture/falling_indent_lines.rb".freeze, "syntax_suggest/capture_code_context.rb".freeze, "syntax_suggest/clean_document.rb".freeze, "syntax_suggest/cli.rb".freeze, "syntax_suggest/code_block.rb".freeze, "syntax_suggest/code_frontier.rb".freeze, "syntax_suggest/code_line.rb".freeze, "syntax_suggest/code_search.rb".freeze, "syntax_suggest/core_ext.rb".freeze, "syntax_suggest/display_code_with_line_numbers.rb".freeze, "syntax_suggest/display_invalid_blocks.rb".freeze, "syntax_suggest/explain_syntax.rb".freeze, "syntax_suggest/left_right_lex_count.rb".freeze, "syntax_suggest/lex_all.rb".freeze, "syntax_suggest/lex_value.rb".freeze, "syntax_suggest/parse_blocks_from_indent_line.rb".freeze, "syntax_suggest/pathname_from_message.rb".freeze, "syntax_suggest/priority_engulf_queue.rb".freeze, "syntax_suggest/priority_queue.rb".freeze, "syntax_suggest/ripper_errors.rb".freeze, "syntax_suggest/scan_history.rb".freeze, "syntax_suggest/unvisited_lines.rb".freeze, "syntax_suggest/version.rb".freeze]
s.homepage = "https://github.com/ruby/syntax_suggest.git".freeze
s.licenses = ["MIT".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Find syntax errors in your source in a snap".freeze
end
share/gems/specifications/default/find-0.2.0.gemspec 0000644 00000001745 15173517741 0016172 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: find 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "find".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/find", "source_code_uri" => "https://github.com/ruby/find" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Kazuki Tsujimoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "This module supports top-down traversal of a set of file paths.".freeze
s.email = ["kazuki@callcc.net".freeze]
s.files = ["find.rb".freeze]
s.homepage = "https://github.com/ruby/find".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "This module supports top-down traversal of a set of file paths.".freeze
end
share/gems/specifications/default/zlib-3.1.1.gemspec 0000644 00000001727 15173517741 0016215 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: zlib 3.1.1 ruby lib
# stub: ext/zlib/extconf.rb
Gem::Specification.new do |s|
s.name = "zlib".freeze
s.version = "3.1.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze, "UENO Katsuhiro".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Ruby interface for the zlib compression/decompression library".freeze
s.email = ["matz@ruby-lang.org".freeze, nil]
s.extensions = ["ext/zlib/extconf.rb".freeze]
s.files = ["ext/zlib/extconf.rb".freeze, "zlib.so".freeze]
s.homepage = "https://github.com/ruby/zlib".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Ruby interface for the zlib compression/decompression library".freeze
end
share/gems/specifications/default/stringio-3.1.1.gemspec 0000644 00000001654 15173517741 0017112 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: stringio 3.1.1 ruby lib
# stub: ext/stringio/extconf.rb
Gem::Specification.new do |s|
s.name = "stringio".freeze
s.version = "3.1.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Nobu Nakada".freeze, "Charles Oliver Nutter".freeze]
s.date = "2025-04-09"
s.description = "Pseudo `IO` class from/to `String`.".freeze
s.email = ["nobu@ruby-lang.org".freeze, "headius@headius.com".freeze]
s.extensions = ["ext/stringio/extconf.rb".freeze]
s.files = ["ext/stringio/extconf.rb".freeze, "stringio.so".freeze]
s.homepage = "https://github.com/ruby/stringio".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Pseudo IO on String".freeze
end
share/gems/specifications/default/net-http-0.4.1.gemspec 0000644 00000002535 15173517741 0017016 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: net-http 0.4.1 ruby lib
Gem::Specification.new do |s|
s.name = "net-http".freeze
s.version = "0.4.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/net-http", "source_code_uri" => "https://github.com/ruby/net-http" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["NARUSE, Yui".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "HTTP client api for Ruby.".freeze
s.email = ["naruse@airemix.jp".freeze]
s.files = ["net/http.rb".freeze, "net/http/backward.rb".freeze, "net/http/exceptions.rb".freeze, "net/http/generic_request.rb".freeze, "net/http/header.rb".freeze, "net/http/proxy_delta.rb".freeze, "net/http/request.rb".freeze, "net/http/requests.rb".freeze, "net/http/response.rb".freeze, "net/http/responses.rb".freeze, "net/http/status.rb".freeze, "net/https.rb".freeze]
s.homepage = "https://github.com/ruby/net-http".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "HTTP client api for Ruby.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<uri>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/getoptlong-0.2.1.gemspec 0000644 00000001526 15173517741 0017432 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: getoptlong 0.2.1 ruby lib
Gem::Specification.new do |s|
s.name = "getoptlong".freeze
s.version = "0.2.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/getoptlong", "source_code_uri" => "https://github.com/ruby/getoptlong" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.date = "2025-04-09"
s.description = "GetoptLong for Ruby".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["getoptlong.rb".freeze]
s.homepage = "https://github.com/ruby/getoptlong".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "GetoptLong for Ruby".freeze
end
share/gems/specifications/default/openssl-3.2.0.gemspec 0000644 00000003242 15173517741 0016732 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: openssl 3.2.0 ruby lib
# stub: ext/openssl/extconf.rb
Gem::Specification.new do |s|
s.name = "openssl".freeze
s.version = "3.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "msys2_mingw_dependencies" => "openssl" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Martin Bosslet".freeze, "SHIBATA Hiroshi".freeze, "Zachary Scott".freeze, "Kazuki Yamaguchi".freeze]
s.date = "2025-04-09"
s.description = "OpenSSL for Ruby provides access to SSL/TLS and general-purpose cryptography based on the OpenSSL library.".freeze
s.email = ["ruby-core@ruby-lang.org".freeze]
s.extensions = ["ext/openssl/extconf.rb".freeze]
s.extra_rdoc_files = ["CONTRIBUTING.md".freeze, "NEWS.md".freeze, "README.ja.md".freeze, "README.md".freeze]
s.files = ["CONTRIBUTING.md".freeze, "NEWS.md".freeze, "README.ja.md".freeze, "README.md".freeze, "ext/openssl/extconf.rb".freeze, "openssl.rb".freeze, "openssl.so".freeze, "openssl/bn.rb".freeze, "openssl/buffering.rb".freeze, "openssl/cipher.rb".freeze, "openssl/digest.rb".freeze, "openssl/hmac.rb".freeze, "openssl/marshal.rb".freeze, "openssl/pkcs5.rb".freeze, "openssl/pkey.rb".freeze, "openssl/ssl.rb".freeze, "openssl/version.rb".freeze, "openssl/x509.rb".freeze]
s.homepage = "https://github.com/ruby/openssl".freeze
s.licenses = ["Ruby".freeze]
s.rdoc_options = ["--main".freeze, "README.md".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "SSL/TLS and general-purpose cryptography for Ruby".freeze
end
share/gems/specifications/default/tempfile-0.2.1.gemspec 0000644 00000001702 15173517741 0017051 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: tempfile 0.2.1 ruby lib
Gem::Specification.new do |s|
s.name = "tempfile".freeze
s.version = "0.2.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/tempfile", "source_code_uri" => "https://github.com/ruby/tempfile" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.date = "2025-04-09"
s.description = "A utility class for managing temporary files.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["tempfile.rb".freeze]
s.homepage = "https://github.com/ruby/tempfile".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "A utility class for managing temporary files.".freeze
end
share/gems/specifications/default/time-0.3.0.gemspec 0000644 00000002071 15173517741 0016202 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: time 0.3.0 ruby lib
Gem::Specification.new do |s|
s.name = "time".freeze
s.version = "0.3.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/time", "source_code_uri" => "https://github.com/ruby/time" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Extends the Time class with methods for parsing and conversion.".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["time.rb".freeze]
s.homepage = "https://github.com/ruby/time".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.4.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Extends the Time class with methods for parsing and conversion.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<date>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/yaml-0.3.0.gemspec 0000644 00000001704 15173517741 0016210 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: yaml 0.3.0 ruby lib
Gem::Specification.new do |s|
s.name = "yaml".freeze
s.version = "0.3.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/yaml", "source_code_uri" => "https://github.com/ruby/yaml" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Aaron Patterson".freeze, "SHIBATA Hiroshi".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "YAML Ain't Markup Language".freeze
s.email = ["aaron@tenderlovemaking.com".freeze, "hsbt@ruby-lang.org".freeze]
s.files = ["yaml.rb".freeze, "yaml/dbm.rb".freeze, "yaml/store.rb".freeze]
s.homepage = "https://github.com/ruby/yaml".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "YAML Ain't Markup Language".freeze
end
share/gems/specifications/default/ruby2_keywords-0.0.5.gemspec 0000644 00000001606 15173517741 0020243 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: ruby2_keywords 0.0.5 ruby lib
Gem::Specification.new do |s|
s.name = "ruby2_keywords".freeze
s.version = "0.0.5".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Nobuyoshi Nakada".freeze]
s.date = "2025-04-09"
s.extra_rdoc_files = ["LICENSE".freeze, "README.md".freeze, "ChangeLog".freeze]
s.files = ["ChangeLog".freeze, "LICENSE".freeze, "README.md".freeze, "ruby2_keywords.rb".freeze]
s.homepage = "https://github.com/ruby/ruby2_keywords".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rdoc_options = ["--main".freeze, "README.md".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.0.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Shim library for Module#ruby2_keywords".freeze
end
share/gems/specifications/default/error_highlight-0.6.0.gemspec 0000644 00000002005 15173517741 0020424 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: error_highlight 0.6.0 ruby lib
Gem::Specification.new do |s|
s.name = "error_highlight".freeze
s.version = "0.6.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Yusuke Endoh".freeze]
s.date = "2025-04-09"
s.description = "The gem enhances Exception#message by adding a short explanation where the exception is raised".freeze
s.email = ["mame@ruby-lang.org".freeze]
s.files = ["error_highlight.rb".freeze, "error_highlight/base.rb".freeze, "error_highlight/core_ext.rb".freeze, "error_highlight/formatter.rb".freeze, "error_highlight/version.rb".freeze]
s.homepage = "https://github.com/ruby/error_highlight".freeze
s.licenses = ["MIT".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 3.1.0.dev".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Shows a one-line code snippet with an underline in the error backtrace".freeze
end
share/gems/specifications/default/erb-4.0.3.gemspec 0000644 00000002634 15173517741 0016025 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: erb 4.0.3 ruby lib
# stub: ext/erb/escape/extconf.rb
Gem::Specification.new do |s|
s.name = "erb".freeze
s.version = "4.0.3".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/erb", "source_code_uri" => "https://github.com/ruby/erb" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Masatoshi SEKI".freeze, "Takashi Kokubun".freeze]
s.bindir = "libexec".freeze
s.date = "2025-04-09"
s.description = "An easy to use but powerful templating system for Ruby.".freeze
s.email = ["seki@ruby-lang.org".freeze, "k0kubun@ruby-lang.org".freeze]
s.executables = ["erb".freeze]
s.extensions = ["ext/erb/escape/extconf.rb".freeze]
s.files = ["erb.rb".freeze, "erb/compiler.rb".freeze, "erb/def_method.rb".freeze, "erb/escape.so".freeze, "erb/util.rb".freeze, "erb/version.rb".freeze, "ext/erb/escape/extconf.rb".freeze, "libexec/erb".freeze]
s.homepage = "https://github.com/ruby/erb".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "An easy to use but powerful templating system for Ruby.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<cgi>.freeze, [">= 0.3.3".freeze])
end
share/gems/specifications/default/tmpdir-0.2.0.gemspec 0000644 00000002116 15173517741 0016542 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: tmpdir 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "tmpdir".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/tmpdir", "source_code_uri" => "https://github.com/ruby/tmpdir" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Extends the Dir class to manage the OS temporary file path.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["tmpdir.rb".freeze]
s.homepage = "https://github.com/ruby/tmpdir".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Extends the Dir class to manage the OS temporary file path.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<fileutils>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/date-3.3.4.gemspec 0000644 00000001650 15173517741 0016172 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: date 3.3.4 ruby lib
# stub: ext/date/extconf.rb
Gem::Specification.new do |s|
s.name = "date".freeze
s.version = "3.3.4".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Tadayoshi Funaba".freeze]
s.date = "2025-04-09"
s.description = "A subclass of Object includes Comparable module for handling dates.".freeze
s.email = [nil]
s.extensions = ["ext/date/extconf.rb".freeze]
s.files = ["date.rb".freeze, "date_core.so".freeze, "ext/date/extconf.rb".freeze]
s.homepage = "https://github.com/ruby/date".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "A subclass of Object includes Comparable module for handling dates.".freeze
end
share/gems/specifications/default/securerandom-0.3.1.gemspec 0000644 00000001750 15173517741 0017737 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: securerandom 0.3.1 ruby lib
Gem::Specification.new do |s|
s.name = "securerandom".freeze
s.version = "0.3.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/securerandom", "source_code_uri" => "https://github.com/ruby/securerandom" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Interface for secure random number generator.".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["securerandom.rb".freeze]
s.homepage = "https://github.com/ruby/securerandom".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Interface for secure random number generator.".freeze
end
share/gems/specifications/default/delegate-0.3.1.gemspec 0000644 00000001744 15173517741 0017025 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: delegate 0.3.1 ruby lib
Gem::Specification.new do |s|
s.name = "delegate".freeze
s.version = "0.3.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/delegate", "source_code_uri" => "https://github.com/ruby/delegate" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.date = "2025-04-09"
s.description = "Provides three abilities to delegate method calls to an object.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["delegate.rb".freeze]
s.homepage = "https://github.com/ruby/delegate".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides three abilities to delegate method calls to an object.".freeze
end
share/gems/specifications/default/benchmark-0.3.0.gemspec 0000644 00000001610 15173517741 0017174 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: benchmark 0.3.0 ruby lib
Gem::Specification.new do |s|
s.name = "benchmark".freeze
s.version = "0.3.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/benchmark", "source_code_uri" => "https://github.com/ruby/benchmark" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "a performance benchmarking library".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["benchmark.rb".freeze]
s.homepage = "https://github.com/ruby/benchmark".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "a performance benchmarking library".freeze
end
share/gems/specifications/default/set-1.1.0.gemspec 0000644 00000002064 15173517741 0016040 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: set 1.1.0 ruby lib
Gem::Specification.new do |s|
s.name = "set".freeze
s.version = "1.1.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "changelog_uri" => "https://github.com/ruby/set/blob/v1.1.0/CHANGELOG.md", "homepage_uri" => "https://github.com/ruby/set", "source_code_uri" => "https://github.com/ruby/set" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Akinori MUSHA".freeze]
s.date = "2025-04-09"
s.description = "Provides a class to deal with collections of unordered, unique values".freeze
s.email = ["knu@idaemons.org".freeze]
s.files = ["set.rb".freeze, "set/sorted_set.rb".freeze]
s.homepage = "https://github.com/ruby/set".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides a class to deal with collections of unordered, unique values".freeze
end
share/gems/specifications/default/cgi-0.4.2.gemspec 0000644 00000002325 15173517741 0016013 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: cgi 0.4.2 ruby lib
# stub: ext/cgi/escape/extconf.rb
Gem::Specification.new do |s|
s.name = "cgi".freeze
s.version = "0.4.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/cgi", "source_code_uri" => "https://github.com/ruby/cgi" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.date = "2025-04-09"
s.description = "Support for the Common Gateway Interface protocol.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.extensions = ["ext/cgi/escape/extconf.rb".freeze]
s.files = ["cgi.rb".freeze, "cgi/cookie.rb".freeze, "cgi/core.rb".freeze, "cgi/escape.so".freeze, "cgi/html.rb".freeze, "cgi/session.rb".freeze, "cgi/session/pstore.rb".freeze, "cgi/util.rb".freeze, "ext/cgi/escape/extconf.rb".freeze]
s.homepage = "https://github.com/ruby/cgi".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Support for the Common Gateway Interface protocol.".freeze
end
share/gems/specifications/default/english-0.8.0.gemspec 0000644 00000001770 15173517741 0016707 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: english 0.8.0 ruby lib
Gem::Specification.new do |s|
s.name = "english".freeze
s.version = "0.8.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/English", "source_code_uri" => "https://github.com/ruby/English" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.date = "2025-04-09"
s.description = "Require 'English.rb' to reference global variables with less cryptic names.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["English.rb".freeze]
s.homepage = "https://github.com/ruby/English".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Require 'English.rb' to reference global variables with less cryptic names.".freeze
end
share/gems/specifications/default/pathname-0.3.0.gemspec 0000644 00000002210 15173517741 0017034 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: pathname 0.3.0 ruby lib
# stub: ext/pathname/extconf.rb
Gem::Specification.new do |s|
s.name = "pathname".freeze
s.version = "0.3.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/pathname", "source_code_uri" => "https://github.com/ruby/pathname" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Representation of the name of a file or directory on the filesystem".freeze
s.email = ["akr@fsij.org".freeze]
s.extensions = ["ext/pathname/extconf.rb".freeze]
s.files = ["ext/pathname/extconf.rb".freeze, "pathname.rb".freeze, "pathname.so".freeze]
s.homepage = "https://github.com/ruby/pathname".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Representation of the name of a file or directory on the filesystem".freeze
end
share/gems/specifications/default/pp-0.5.0.gemspec 0000644 00000002010 15173517741 0015656 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: pp 0.5.0 ruby lib
Gem::Specification.new do |s|
s.name = "pp".freeze
s.version = "0.5.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/pp", "source_code_uri" => "https://github.com/ruby/pp" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Provides a PrettyPrinter for Ruby objects".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["pp.rb".freeze]
s.homepage = "https://github.com/ruby/pp".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides a PrettyPrinter for Ruby objects".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<prettyprint>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/digest-3.1.1.gemspec 0000644 00000003140 15173517741 0016523 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: digest 3.1.1 ruby lib
# stub: ext/digest/bubblebabble/extconf.rb ext/digest/extconf.rb ext/digest/md5/extconf.rb ext/digest/rmd160/extconf.rb ext/digest/sha1/extconf.rb ext/digest/sha2/extconf.rb
Gem::Specification.new do |s|
s.name = "digest".freeze
s.version = "3.1.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "msys2_mingw_dependencies" => "openssl" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Akinori MUSHA".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Provides a framework for message digest libraries.".freeze
s.email = ["knu@idaemons.org".freeze]
s.extensions = ["ext/digest/bubblebabble/extconf.rb".freeze, "ext/digest/extconf.rb".freeze, "ext/digest/md5/extconf.rb".freeze, "ext/digest/rmd160/extconf.rb".freeze, "ext/digest/sha1/extconf.rb".freeze, "ext/digest/sha2/extconf.rb".freeze]
s.files = ["digest.rb".freeze, "digest.so".freeze, "digest/loader.rb".freeze, "digest/version.rb".freeze, "ext/digest/bubblebabble/extconf.rb".freeze, "ext/digest/extconf.rb".freeze, "ext/digest/md5/extconf.rb".freeze, "ext/digest/rmd160/extconf.rb".freeze, "ext/digest/sha1/extconf.rb".freeze, "ext/digest/sha2/extconf.rb".freeze]
s.homepage = "https://github.com/ruby/digest".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides a framework for message digest libraries.".freeze
end
share/gems/specifications/default/resolv-replace-0.1.1.gemspec 0000644 00000002035 15173517741 0020166 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: resolv-replace 0.1.1 ruby lib
Gem::Specification.new do |s|
s.name = "resolv-replace".freeze
s.version = "0.1.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/resolv-replace", "source_code_uri" => "https://github.com/ruby/resolv-replace" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.date = "2025-04-09"
s.description = "Replace Socket DNS with Resolv.".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["resolv-replace.rb".freeze]
s.homepage = "https://github.com/ruby/resolv-replace".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Replace Socket DNS with Resolv.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<resolv>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/shellwords-0.2.0.gemspec 0000644 00000002011 15173517741 0017423 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: shellwords 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "shellwords".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/shellwords", "source_code_uri" => "https://github.com/ruby/shellwords" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Akinori MUSHA".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Manipulates strings with word parsing rules of UNIX Bourne shell.".freeze
s.email = ["knu@idaemons.org".freeze]
s.files = ["shellwords.rb".freeze]
s.homepage = "https://github.com/ruby/shellwords".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Manipulates strings with word parsing rules of UNIX Bourne shell.".freeze
end
share/gems/specifications/default/weakref-0.1.3.gemspec 0000644 00000001777 15173517741 0016705 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: weakref 0.1.3 ruby lib
Gem::Specification.new do |s|
s.name = "weakref".freeze
s.version = "0.1.3".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/weakref", "source_code_uri" => "https://github.com/ruby/weakref" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Allows a referenced object to be garbage-collected.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["weakref.rb".freeze]
s.homepage = "https://github.com/ruby/weakref".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "Allows a referenced object to be garbage-collected.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<delegate>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/ipaddr-1.2.6.gemspec 0000644 00000001573 15173517741 0016523 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: ipaddr 1.2.6 ruby lib
Gem::Specification.new do |s|
s.name = "ipaddr".freeze
s.version = "1.2.6".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Akinori MUSHA".freeze, "Hajimu UMEMOTO".freeze]
s.date = "2025-04-09"
s.description = "IPAddr provides a set of methods to manipulate an IP address.\nBoth IPv4 and IPv6 are supported.\n".freeze
s.email = ["knu@idaemons.org".freeze, "ume@mahoroba.org".freeze]
s.files = ["ipaddr.rb".freeze]
s.homepage = "https://github.com/ruby/ipaddr".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "A class to manipulate an IP address in ruby".freeze
end
share/gems/specifications/default/un-0.3.0.gemspec 0000644 00000001657 15173517741 0015677 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: un 0.3.0 ruby lib
Gem::Specification.new do |s|
s.name = "un".freeze
s.version = "0.3.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/un", "source_code_uri" => "https://github.com/ruby/un" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["WATANABE Hirofumi".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Utilities to replace common UNIX commands".freeze
s.email = ["eban@ruby-lang.org".freeze]
s.files = ["un.rb".freeze]
s.homepage = "https://github.com/ruby/un".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Utilities to replace common UNIX commands".freeze
end
share/gems/specifications/default/reline-0.5.10.gemspec 0000644 00000003343 15173517741 0016610 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: reline 0.5.10 ruby lib
Gem::Specification.new do |s|
s.name = "reline".freeze
s.version = "0.5.10".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "bug_tracker_uri" => "https://github.com/ruby/reline/issues", "changelog_uri" => "https://github.com/ruby/reline/releases", "source_code_uri" => "https://github.com/ruby/reline" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["aycabta".freeze]
s.date = "2025-04-09"
s.description = "Alternative GNU Readline or Editline implementation by pure Ruby.".freeze
s.email = ["aycabta@gmail.com".freeze]
s.files = ["reline.rb".freeze, "reline/config.rb".freeze, "reline/face.rb".freeze, "reline/history.rb".freeze, "reline/io.rb".freeze, "reline/io/ansi.rb".freeze, "reline/io/dumb.rb".freeze, "reline/io/windows.rb".freeze, "reline/key_actor.rb".freeze, "reline/key_actor/base.rb".freeze, "reline/key_actor/composite.rb".freeze, "reline/key_actor/emacs.rb".freeze, "reline/key_actor/vi_command.rb".freeze, "reline/key_actor/vi_insert.rb".freeze, "reline/key_stroke.rb".freeze, "reline/kill_ring.rb".freeze, "reline/line_editor.rb".freeze, "reline/terminfo.rb".freeze, "reline/unicode.rb".freeze, "reline/unicode/east_asian_width.rb".freeze, "reline/version.rb".freeze]
s.homepage = "https://github.com/ruby/reline".freeze
s.licenses = ["Ruby".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Alternative GNU Readline or Editline implementation by pure Ruby.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<io-console>.freeze, ["~> 0.5".freeze])
end
share/gems/specifications/default/resolv-0.3.0.gemspec 0000644 00000001676 15173517741 0016570 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: resolv 0.3.0 ruby lib
Gem::Specification.new do |s|
s.name = "resolv".freeze
s.version = "0.3.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/resolv", "source_code_uri" => "https://github.com/ruby/resolv" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Thread-aware DNS resolver library in Ruby.".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["resolv.rb".freeze]
s.homepage = "https://github.com/ruby/resolv".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Thread-aware DNS resolver library in Ruby.".freeze
end
share/gems/specifications/default/observer-0.1.2.gemspec 0000644 00000001672 15173517741 0017101 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: observer 0.1.2 ruby lib
Gem::Specification.new do |s|
s.name = "observer".freeze
s.version = "0.1.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/observer", "source_code_uri" => "https://github.com/ruby/observer" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Implementation of the Observer object-oriented design pattern.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["observer.rb".freeze]
s.homepage = "https://github.com/ruby/observer".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "Implementation of the Observer object-oriented design pattern.".freeze
end
share/gems/specifications/default/net-protocol-0.2.2.gemspec 0000644 00000002060 15173517741 0017670 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: net-protocol 0.2.2 ruby lib
Gem::Specification.new do |s|
s.name = "net-protocol".freeze
s.version = "0.2.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/net-protocol", "source_code_uri" => "https://github.com/ruby/net-protocol" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.date = "2025-04-09"
s.description = "The abstract interface for net-* client.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["net/protocol.rb".freeze]
s.homepage = "https://github.com/ruby/net-protocol".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "The abstract interface for net-* client.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<timeout>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/drb-2.2.0.gemspec 0000644 00000002453 15173517741 0016020 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: drb 2.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "drb".freeze
s.version = "2.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/drb", "source_code_uri" => "https://github.com/ruby/drb" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Masatoshi SEKI".freeze]
s.date = "2025-04-09"
s.description = "Distributed object system for Ruby".freeze
s.email = ["seki@ruby-lang.org".freeze]
s.files = ["drb.rb".freeze, "drb/acl.rb".freeze, "drb/drb.rb".freeze, "drb/eq.rb".freeze, "drb/extserv.rb".freeze, "drb/extservm.rb".freeze, "drb/gw.rb".freeze, "drb/invokemethod.rb".freeze, "drb/observer.rb".freeze, "drb/ssl.rb".freeze, "drb/timeridconv.rb".freeze, "drb/unix.rb".freeze, "drb/version.rb".freeze, "drb/weakidconv.rb".freeze]
s.homepage = "https://github.com/ruby/drb".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.7.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Distributed object system for Ruby".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<ruby2_keywords>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/base64-0.2.0.gemspec 0000644 00000002006 15173517741 0016325 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: base64 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "base64".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/base64", "source_code_uri" => "https://github.com/ruby/base64" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yusuke Endoh".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Support for encoding and decoding binary data using a Base64 representation.".freeze
s.email = ["mame@ruby-lang.org".freeze]
s.files = ["base64.rb".freeze]
s.homepage = "https://github.com/ruby/base64".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.4".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Support for encoding and decoding binary data using a Base64 representation.".freeze
end
share/gems/specifications/default/nkf-0.1.3.gemspec 0000644 00000002043 15173517741 0016022 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: nkf 0.1.3 ruby lib
# stub: ext/nkf/extconf.rb
Gem::Specification.new do |s|
s.name = "nkf".freeze
s.version = "0.1.3".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/nkf", "source_code_uri" => "https://github.com/ruby/nkf" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["NARUSE Yui".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Ruby extension for Network Kanji Filter".freeze
s.email = ["naruse@airemix.jp".freeze]
s.extensions = ["ext/nkf/extconf.rb".freeze]
s.files = ["ext/nkf/extconf.rb".freeze, "kconv.rb".freeze, "nkf.so".freeze]
s.homepage = "https://github.com/ruby/nkf".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Ruby extension for Network Kanji Filter".freeze
end
share/gems/specifications/default/io-nonblock-0.3.0.gemspec 0000644 00000002100 15173517741 0017447 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: io-nonblock 0.3.0 ruby lib
# stub: ext/io/nonblock/extconf.rb
Gem::Specification.new do |s|
s.name = "io-nonblock".freeze
s.version = "0.3.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/io-nonblock", "source_code_uri" => "https://github.com/ruby/io-nonblock" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Nobu Nakada".freeze]
s.date = "2025-04-09"
s.description = "Enables non-blocking mode with IO class".freeze
s.email = ["nobu@ruby-lang.org".freeze]
s.extensions = ["ext/io/nonblock/extconf.rb".freeze]
s.files = ["ext/io/nonblock/extconf.rb".freeze, "io/nonblock.so".freeze]
s.homepage = "https://github.com/ruby/io-nonblock".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Enables non-blocking mode with IO class".freeze
end
share/gems/specifications/default/forwardable-1.3.3.gemspec 0000644 00000001615 15173517741 0017543 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: forwardable 1.3.3 ruby lib
Gem::Specification.new do |s|
s.name = "forwardable".freeze
s.version = "1.3.3".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Keiju ISHITSUKA".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Provides delegation of specified methods to a designated object.".freeze
s.email = ["keiju@ruby-lang.org".freeze]
s.files = ["forwardable.rb".freeze, "forwardable/impl.rb".freeze]
s.homepage = "https://github.com/ruby/forwardable".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.4.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides delegation of specified methods to a designated object.".freeze
end
share/gems/specifications/default/optparse-0.4.0.gemspec 0000644 00000002450 15173517741 0017103 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: optparse 0.4.0 ruby lib
Gem::Specification.new do |s|
s.name = "optparse".freeze
s.version = "0.4.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/optparse", "source_code_uri" => "https://github.com/ruby/optparse" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Nobu Nakada".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "OptionParser is a class for command-line option analysis.".freeze
s.email = ["nobu@ruby-lang.org".freeze]
s.files = ["optionparser.rb".freeze, "optparse.rb".freeze, "optparse/ac.rb".freeze, "optparse/date.rb".freeze, "optparse/kwargs.rb".freeze, "optparse/shellwords.rb".freeze, "optparse/time.rb".freeze, "optparse/uri.rb".freeze, "optparse/version.rb".freeze]
s.homepage = "https://github.com/ruby/optparse".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rdoc_options = ["--main=README.md".freeze, "--op=rdoc".freeze, "--page-dir=doc".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "OptionParser is a class for command-line option analysis.".freeze
end
share/gems/specifications/default/prettyprint-0.2.0.gemspec 0000644 00000002004 15173517741 0017643 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: prettyprint 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "prettyprint".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/prettyprint", "source_code_uri" => "https://github.com/ruby/prettyprint" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Implements a pretty printing algorithm for readable structure.".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["prettyprint.rb".freeze]
s.homepage = "https://github.com/ruby/prettyprint".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Implements a pretty printing algorithm for readable structure.".freeze
end
share/gems/specifications/default/etc-1.4.3.gemspec 0000644 00000002634 15173517741 0016031 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: etc 1.4.3 ruby lib
# stub: ext/etc/extconf.rb
Gem::Specification.new do |s|
s.name = "etc".freeze
s.version = "1.4.3".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Provides access to information typically stored in UNIX /etc directory.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.extensions = ["ext/etc/extconf.rb".freeze]
s.extra_rdoc_files = ["ChangeLog".freeze, "LICENSE.txt".freeze, "README.md".freeze, "ext/etc/constdefs.h".freeze, "ext/etc/etc.c".freeze, "ext/etc/extconf.rb".freeze, "ext/etc/mkconstants.rb".freeze, "test/etc/test_etc.rb".freeze]
s.files = ["ChangeLog".freeze, "LICENSE.txt".freeze, "README.md".freeze, "etc.so".freeze, "ext/etc/constdefs.h".freeze, "ext/etc/etc.c".freeze, "ext/etc/extconf.rb".freeze, "ext/etc/mkconstants.rb".freeze, "test/etc/test_etc.rb".freeze]
s.homepage = "https://github.com/ruby/etc".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rdoc_options = ["--main".freeze, "README.md".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides access to information typically stored in UNIX /etc directory.".freeze
end
share/gems/specifications/default/strscan-3.0.9.gemspec 0000644 00000001755 15173517741 0016742 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: strscan 3.0.9 ruby lib
# stub: ext/strscan/extconf.rb
Gem::Specification.new do |s|
s.name = "strscan".freeze
s.version = "3.0.9".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Minero Aoki".freeze, "Sutou Kouhei".freeze, "Charles Oliver Nutter".freeze]
s.date = "2025-04-09"
s.description = "Provides lexical scanning operations on a String.".freeze
s.email = [nil, "kou@cozmixng.org".freeze, "headius@headius.com".freeze]
s.extensions = ["ext/strscan/extconf.rb".freeze]
s.files = ["ext/strscan/extconf.rb".freeze, "strscan.so".freeze]
s.homepage = "https://github.com/ruby/strscan".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.4.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides lexical scanning operations on a String.".freeze
end
share/gems/specifications/default/timeout-0.4.1.gemspec 0000644 00000001730 15173517741 0016735 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: timeout 0.4.1 ruby lib
Gem::Specification.new do |s|
s.name = "timeout".freeze
s.version = "0.4.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/timeout", "source_code_uri" => "https://github.com/ruby/timeout" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.date = "2025-04-09"
s.description = "Auto-terminate potentially long-running operations in Ruby.".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["timeout.rb".freeze]
s.homepage = "https://github.com/ruby/timeout".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Auto-terminate potentially long-running operations in Ruby.".freeze
end
share/gems/specifications/default/syslog-0.1.2.gemspec 0000644 00000002144 15173517741 0016565 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: syslog 0.1.2 ruby lib
# stub: ext/syslog/extconf.rb
Gem::Specification.new do |s|
s.name = "syslog".freeze
s.version = "0.1.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/syslog", "source_code_uri" => "https://github.com/ruby/syslog" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Akinori MUSHA".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Ruby interface for the POSIX system logging facility.".freeze
s.email = ["knu@idaemons.org".freeze]
s.extensions = ["ext/syslog/extconf.rb".freeze]
s.files = ["ext/syslog/extconf.rb".freeze, "syslog.so".freeze, "syslog/logger.rb".freeze]
s.homepage = "https://github.com/ruby/syslog".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Ruby interface for the POSIX system logging facility.".freeze
end
share/gems/specifications/default/io-wait-0.3.1.gemspec 0000644 00000002122 15173517741 0016613 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: io-wait 0.3.1 ruby lib
# stub: ext/io/wait/extconf.rb
Gem::Specification.new do |s|
s.name = "io-wait".freeze
s.version = "0.3.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/io-wait", "source_code_uri" => "https://github.com/ruby/io-wait" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Nobu Nakada".freeze, "Charles Oliver Nutter".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Waits until IO is readable or writable without blocking.".freeze
s.email = ["nobu@ruby-lang.org".freeze, "headius@headius.com".freeze]
s.extensions = ["ext/io/wait/extconf.rb".freeze]
s.files = ["ext/io/wait/extconf.rb".freeze, "io/wait.so".freeze]
s.homepage = "https://github.com/ruby/io-wait".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "Waits until IO is readable or writable without blocking.".freeze
end
share/gems/specifications/default/rinda-0.2.0.gemspec 0000644 00000002351 15173517741 0016341 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: rinda 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "rinda".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/rinda", "source_code_uri" => "https://github.com/ruby/rinda" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Masatoshi SEKI".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "The Linda distributed computing paradigm in Ruby.".freeze
s.email = ["seki@ruby-lang.org".freeze]
s.files = ["rinda/rinda.rb".freeze, "rinda/ring.rb".freeze, "rinda/tuplespace.rb".freeze]
s.homepage = "https://github.com/ruby/rinda".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "The Linda distributed computing paradigm in Ruby.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<drb>.freeze, [">= 0".freeze])
s.add_runtime_dependency(%q<ipaddr>.freeze, [">= 0".freeze])
s.add_runtime_dependency(%q<forwardable>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/did_you_mean-1.6.3.gemspec 0000644 00000003533 15173517741 0017713 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: did_you_mean 1.6.3 ruby lib
Gem::Specification.new do |s|
s.name = "did_you_mean".freeze
s.version = "1.6.3".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Yuki Nishijima".freeze]
s.date = "2025-04-09"
s.description = "The gem that has been saving people from typos since 2014.".freeze
s.email = ["mail@yukinishijima.net".freeze]
s.files = ["did_you_mean.rb".freeze, "did_you_mean/core_ext/name_error.rb".freeze, "did_you_mean/experimental.rb".freeze, "did_you_mean/formatter.rb".freeze, "did_you_mean/formatters/plain_formatter.rb".freeze, "did_you_mean/formatters/verbose_formatter.rb".freeze, "did_you_mean/jaro_winkler.rb".freeze, "did_you_mean/levenshtein.rb".freeze, "did_you_mean/spell_checker.rb".freeze, "did_you_mean/spell_checkers/key_error_checker.rb".freeze, "did_you_mean/spell_checkers/method_name_checker.rb".freeze, "did_you_mean/spell_checkers/name_error_checkers.rb".freeze, "did_you_mean/spell_checkers/name_error_checkers/class_name_checker.rb".freeze, "did_you_mean/spell_checkers/name_error_checkers/variable_name_checker.rb".freeze, "did_you_mean/spell_checkers/null_checker.rb".freeze, "did_you_mean/spell_checkers/pattern_key_name_checker.rb".freeze, "did_you_mean/spell_checkers/require_path_checker.rb".freeze, "did_you_mean/tree_spell_checker.rb".freeze, "did_you_mean/verbose.rb".freeze, "did_you_mean/version.rb".freeze]
s.homepage = "https://github.com/ruby/did_you_mean".freeze
s.licenses = ["MIT".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "\"Did you mean?\" experience in Ruby".freeze
s.specification_version = 4
s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/open3-0.2.1.gemspec 0000644 00000001701 15173517741 0016267 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: open3 0.2.1 ruby lib
Gem::Specification.new do |s|
s.name = "open3".freeze
s.version = "0.2.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/open3", "source_code_uri" => "https://github.com/ruby/open3" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Popen, but with stderr, too".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.files = ["open3.rb".freeze, "open3/version.rb".freeze]
s.homepage = "https://github.com/ruby/open3".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.6.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Popen, but with stderr, too".freeze
end
share/gems/specifications/default/abbrev-0.1.2.gemspec 0000644 00000001765 15173517741 0016516 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: abbrev 0.1.2 ruby lib
Gem::Specification.new do |s|
s.name = "abbrev".freeze
s.version = "0.1.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/abbrev", "source_code_uri" => "https://github.com/ruby/abbrev" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Akinori MUSHA".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Calculates a set of unique abbreviations for a given set of strings".freeze
s.email = ["knu@idaemons.org".freeze]
s.files = ["abbrev.rb".freeze]
s.homepage = "https://github.com/ruby/abbrev".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Calculates a set of unique abbreviations for a given set of strings".freeze
end
share/gems/specifications/default/logger-1.6.0.gemspec 0000644 00000002022 15173517741 0016523 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: logger 1.6.0 ruby lib
Gem::Specification.new do |s|
s.name = "logger".freeze
s.version = "1.6.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Naotoshi Seo".freeze, "SHIBATA Hiroshi".freeze]
s.date = "2025-04-09"
s.description = "Provides a simple logging utility for outputting messages.".freeze
s.email = ["sonots@gmail.com".freeze, "hsbt@ruby-lang.org".freeze]
s.files = ["logger.rb".freeze, "logger/errors.rb".freeze, "logger/formatter.rb".freeze, "logger/log_device.rb".freeze, "logger/period.rb".freeze, "logger/severity.rb".freeze, "logger/version.rb".freeze]
s.homepage = "https://github.com/ruby/logger".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Provides a simple logging utility for outputting messages.".freeze
end
share/gems/specifications/default/csv-3.2.8.gemspec 0000644 00000003221 15173517741 0016047 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: csv 3.2.8 ruby lib
Gem::Specification.new do |s|
s.name = "csv".freeze
s.version = "3.2.8".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["James Edward Gray II".freeze, "Kouhei Sutou".freeze]
s.date = "2025-04-09"
s.description = "The CSV library provides a complete interface to CSV files and data. It offers tools to enable you to read and write to and from Strings or IO objects, as needed.".freeze
s.email = [nil, "kou@cozmixng.org".freeze]
s.extra_rdoc_files = ["LICENSE.txt".freeze, "NEWS.md".freeze, "README.md".freeze]
s.files = ["LICENSE.txt".freeze, "NEWS.md".freeze, "README.md".freeze, "csv.rb".freeze, "csv/core_ext/array.rb".freeze, "csv/core_ext/string.rb".freeze, "csv/fields_converter.rb".freeze, "csv/input_record_separator.rb".freeze, "csv/parser.rb".freeze, "csv/row.rb".freeze, "csv/table.rb".freeze, "csv/version.rb".freeze, "csv/writer.rb".freeze]
s.homepage = "https://github.com/ruby/csv".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.rdoc_options = ["--main".freeze, "README.md".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "CSV Reading and Writing".freeze
s.specification_version = 4
s.add_development_dependency(%q<bundler>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<benchmark_driver>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<test-unit>.freeze, [">= 3.4.8".freeze])
end
share/gems/specifications/default/fcntl-1.1.0.gemspec 0000644 00000001664 15173517741 0016360 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: fcntl 1.1.0 ruby lib
# stub: ext/fcntl/extconf.rb
Gem::Specification.new do |s|
s.name = "fcntl".freeze
s.version = "1.1.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Yukihiro Matsumoto".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Loads constants defined in the OS fcntl.h C header file".freeze
s.email = ["matz@ruby-lang.org".freeze]
s.extensions = ["ext/fcntl/extconf.rb".freeze]
s.files = ["ext/fcntl/extconf.rb".freeze, "fcntl.so".freeze]
s.homepage = "https://github.com/ruby/fcntl".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Loads constants defined in the OS fcntl.h C header file".freeze
end
share/gems/specifications/default/mutex_m-0.2.0.gemspec 0000644 00000002056 15173517741 0016724 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: mutex_m 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "mutex_m".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["Keiju ISHITSUKA".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Mixin to extend objects to be handled like a Mutex.".freeze
s.email = ["keiju@ruby-lang.org".freeze]
s.files = ["mutex_m.rb".freeze]
s.homepage = "https://github.com/ruby/mutex_m".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Mixin to extend objects to be handled like a Mutex.".freeze
s.specification_version = 4
s.add_development_dependency(%q<bundler>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<test-unit>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/uri-0.13.2.gemspec 0000644 00000002753 15173517741 0016135 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: uri 0.13.2 ruby lib
Gem::Specification.new do |s|
s.name = "uri".freeze
s.version = "0.13.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "bug_tracker_uri" => "https://github.com/ruby/uri/issues", "changelog_uri" => "https://github.com/ruby/uri/releases", "documentation_uri" => "https://ruby.github.io/uri/", "homepage_uri" => "https://github.com/ruby/uri", "source_code_uri" => "https://github.com/ruby/uri" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Akira Yamada".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "URI is a module providing classes to handle Uniform Resource Identifiers".freeze
s.email = ["akira@ruby-lang.org".freeze]
s.files = ["uri.rb".freeze, "uri/common.rb".freeze, "uri/file.rb".freeze, "uri/ftp.rb".freeze, "uri/generic.rb".freeze, "uri/http.rb".freeze, "uri/https.rb".freeze, "uri/ldap.rb".freeze, "uri/ldaps.rb".freeze, "uri/mailto.rb".freeze, "uri/rfc2396_parser.rb".freeze, "uri/rfc3986_parser.rb".freeze, "uri/version.rb".freeze, "uri/ws.rb".freeze, "uri/wss.rb".freeze]
s.homepage = "https://github.com/ruby/uri".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.5".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "URI is a module providing classes to handle Uniform Resource Identifiers".freeze
end
share/gems/specifications/default/readline-0.0.4.gemspec 0000644 00000002006 15173517741 0017026 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: readline 0.0.4 ruby lib
Gem::Specification.new do |s|
s.name = "readline".freeze
s.version = "0.0.4".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.require_paths = ["lib".freeze]
s.authors = ["aycabta".freeze]
s.date = "2025-04-09"
s.description = "This is just a loader for \"readline\". If Ruby has the \"readline-ext\" gem\nthat is a native extension, this gem will load it. If Ruby does not have\nthe \"readline-ext\" gem this gem will load \"reline\", a library that is\ncompatible with the \"readline-ext\" gem and implemented in pure Ruby.\n".freeze
s.email = ["aycabta@gmail.com".freeze]
s.files = ["readline.rb".freeze]
s.homepage = "https://github.com/ruby/readline".freeze
s.licenses = ["Ruby".freeze]
s.rubygems_version = "3.5.22".freeze
s.summary = "Loader for \"readline\".".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<reline>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/prism-0.19.0.gemspec 0000644 00000003030 15173517741 0016461 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: prism 0.19.0 ruby lib
# stub: ext/prism/extconf.rb
Gem::Specification.new do |s|
s.name = "prism".freeze
s.version = "0.19.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "allowed_push_host" => "https://rubygems.org", "changelog_uri" => "https://github.com/ruby/prism/blob/main/CHANGELOG.md", "source_code_uri" => "https://github.com/ruby/prism" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Shopify".freeze]
s.date = "2025-04-09"
s.email = ["ruby@shopify.com".freeze]
s.extensions = ["ext/prism/extconf.rb".freeze]
s.files = ["ext/prism/extconf.rb".freeze, "prism.rb".freeze, "prism/compiler.rb".freeze, "prism/debug.rb".freeze, "prism/desugar_compiler.rb".freeze, "prism/dispatcher.rb".freeze, "prism/dsl.rb".freeze, "prism/ffi.rb".freeze, "prism/lex_compat.rb".freeze, "prism/mutation_compiler.rb".freeze, "prism/node.rb".freeze, "prism/node_ext.rb".freeze, "prism/node_inspector.rb".freeze, "prism/pack.rb".freeze, "prism/parse_result.rb".freeze, "prism/parse_result/comments.rb".freeze, "prism/parse_result/newlines.rb".freeze, "prism/pattern.rb".freeze, "prism/ripper_compat.rb".freeze, "prism/serialize.rb".freeze, "prism/visitor.rb".freeze]
s.homepage = "https://github.com/ruby/prism".freeze
s.licenses = ["MIT".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Prism Ruby parser".freeze
end
share/gems/specifications/default/open-uri-0.4.1.gemspec 0000644 00000002262 15173517741 0017006 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: open-uri 0.4.1 ruby lib
Gem::Specification.new do |s|
s.name = "open-uri".freeze
s.version = "0.4.1".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/open-uri", "source_code_uri" => "https://github.com/ruby/open-uri" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.date = "2025-04-09"
s.description = "An easy-to-use wrapper for Net::HTTP, Net::HTTPS and Net::FTP.".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["open-uri.rb".freeze]
s.homepage = "https://github.com/ruby/open-uri".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "An easy-to-use wrapper for Net::HTTP, Net::HTTPS and Net::FTP.".freeze
s.specification_version = 4
s.add_runtime_dependency(%q<uri>.freeze, [">= 0".freeze])
s.add_runtime_dependency(%q<stringio>.freeze, [">= 0".freeze])
s.add_runtime_dependency(%q<time>.freeze, [">= 0".freeze])
end
share/gems/specifications/default/tsort-0.2.0.gemspec 0000644 00000001674 15173517741 0016426 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: tsort 0.2.0 ruby lib
Gem::Specification.new do |s|
s.name = "tsort".freeze
s.version = "0.2.0".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "homepage_uri" => "https://github.com/ruby/tsort", "source_code_uri" => "https://github.com/ruby/tsort" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Tanaka Akira".freeze]
s.bindir = "exe".freeze
s.date = "2025-04-09"
s.description = "Topological sorting using Tarjan's algorithm".freeze
s.email = ["akr@fsij.org".freeze]
s.files = ["tsort.rb".freeze]
s.homepage = "https://github.com/ruby/tsort".freeze
s.licenses = ["Ruby".freeze, "BSD-2-Clause".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3.0".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "Topological sorting using Tarjan's algorithm".freeze
end
share/gems/specifications/json-2.7.2.gemspec 0000644 00000004214 15173517741 0014602 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: json 2.7.2 ruby lib
# stub: ext/json/ext/generator/extconf.rb ext/json/ext/parser/extconf.rb ext/json/extconf.rb
Gem::Specification.new do |s|
s.name = "json".freeze
s.version = "2.7.2".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "bug_tracker_uri" => "https://github.com/flori/json/issues", "changelog_uri" => "https://github.com/flori/json/blob/master/CHANGES.md", "documentation_uri" => "https://flori.github.io/json/doc/index.html", "homepage_uri" => "https://flori.github.io/json", "source_code_uri" => "https://github.com/flori/json", "wiki_uri" => "https://github.com/flori/json/wiki" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Florian Frank".freeze]
s.date = "2025-04-09"
s.description = "This is a JSON implementation as a Ruby extension in C.".freeze
s.email = "flori@ping.de".freeze
s.extensions = ["ext/json/ext/generator/extconf.rb".freeze, "ext/json/ext/parser/extconf.rb".freeze, "ext/json/extconf.rb".freeze]
s.extra_rdoc_files = ["README.md".freeze]
s.files = ["README.md".freeze, "ext/json/ext/generator/extconf.rb".freeze, "ext/json/ext/parser/extconf.rb".freeze, "ext/json/extconf.rb".freeze, "json.rb".freeze, "json/add/bigdecimal.rb".freeze, "json/add/complex.rb".freeze, "json/add/core.rb".freeze, "json/add/date.rb".freeze, "json/add/date_time.rb".freeze, "json/add/exception.rb".freeze, "json/add/ostruct.rb".freeze, "json/add/range.rb".freeze, "json/add/rational.rb".freeze, "json/add/regexp.rb".freeze, "json/add/set.rb".freeze, "json/add/struct.rb".freeze, "json/add/symbol.rb".freeze, "json/add/time.rb".freeze, "json/common.rb".freeze, "json/ext.rb".freeze, "json/generic_object.rb".freeze, "json/version.rb".freeze]
s.homepage = "https://flori.github.io/json".freeze
s.licenses = ["Ruby".freeze]
s.rdoc_options = ["--title".freeze, "JSON implementation for Ruby".freeze, "--main".freeze, "README.md".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.3".freeze)
s.rubygems_version = "3.5.22".freeze
s.summary = "JSON Implementation for Ruby".freeze
end
share/gems/specifications/rack-3.0.8.gemspec 0000644 00000003507 15173517741 0014555 0 ustar 00 # -*- encoding: utf-8 -*-
# stub: rack 3.0.8 ruby lib
Gem::Specification.new do |s|
s.name = "rack".freeze
s.version = "3.0.8".freeze
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
s.metadata = { "bug_tracker_uri" => "https://github.com/rack/rack/issues", "changelog_uri" => "https://github.com/rack/rack/blob/main/CHANGELOG.md", "documentation_uri" => "https://rubydoc.info/github/rack/rack", "source_code_uri" => "https://github.com/rack/rack" } if s.respond_to? :metadata=
s.require_paths = ["lib".freeze]
s.authors = ["Leah Neukirchen".freeze]
s.date = "2023-06-14"
s.description = "Rack provides a minimal, modular and adaptable interface for developing\nweb applications in Ruby. By wrapping HTTP requests and responses in\nthe simplest way possible, it unifies and distills the API for web\nservers, web frameworks, and software in between (the so-called\nmiddleware) into a single method call.\n".freeze
s.email = "leah@vuxu.org".freeze
s.extra_rdoc_files = ["README.md".freeze, "CHANGELOG.md".freeze, "CONTRIBUTING.md".freeze]
s.files = ["CHANGELOG.md".freeze, "CONTRIBUTING.md".freeze, "README.md".freeze]
s.homepage = "https://github.com/rack/rack".freeze
s.licenses = ["MIT".freeze]
s.required_ruby_version = Gem::Requirement.new(">= 2.4.0".freeze)
s.rubygems_version = "3.5.3".freeze
s.summary = "A modular Ruby webserver interface.".freeze
s.installed_by_version = "3.5.3".freeze if s.respond_to? :installed_by_version
s.specification_version = 4
s.add_development_dependency(%q<minitest>.freeze, ["~> 5.0".freeze])
s.add_development_dependency(%q<minitest-global_expectations>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<bundler>.freeze, [">= 0".freeze])
s.add_development_dependency(%q<rake>.freeze, [">= 0".freeze])
end
share/gems/gems/bigdecimal-3.1.5/lib/bigdecimal/util.rb 0000644 00000007617 15173517741 0016434 0 ustar 00 # frozen_string_literal: false
#
#--
# bigdecimal/util extends various native classes to provide the #to_d method,
# and provides BigDecimal#to_d and BigDecimal#to_digits.
#++
require 'bigdecimal'
class Integer < Numeric
# call-seq:
# int.to_d -> bigdecimal
#
# Returns the value of +int+ as a BigDecimal.
#
# require 'bigdecimal'
# require 'bigdecimal/util'
#
# 42.to_d # => 0.42e2
#
# See also Kernel.BigDecimal.
#
def to_d
BigDecimal(self)
end
end
class Float < Numeric
# call-seq:
# float.to_d -> bigdecimal
# float.to_d(precision) -> bigdecimal
#
# Returns the value of +float+ as a BigDecimal.
# The +precision+ parameter is used to determine the number of
# significant digits for the result. When +precision+ is set to +0+,
# the number of digits to represent the float being converted is determined
# automatically.
# The default +precision+ is +0+.
#
# require 'bigdecimal'
# require 'bigdecimal/util'
#
# 0.5.to_d # => 0.5e0
# 1.234.to_d # => 0.1234e1
# 1.234.to_d(2) # => 0.12e1
#
# See also Kernel.BigDecimal.
#
def to_d(precision=0)
BigDecimal(self, precision)
end
end
class String
# call-seq:
# str.to_d -> bigdecimal
#
# Returns the result of interpreting leading characters in +str+
# as a BigDecimal.
#
# require 'bigdecimal'
# require 'bigdecimal/util'
#
# "0.5".to_d # => 0.5e0
# "123.45e1".to_d # => 0.12345e4
# "45.67 degrees".to_d # => 0.4567e2
#
# See also Kernel.BigDecimal.
#
def to_d
BigDecimal.interpret_loosely(self)
end
end
class BigDecimal < Numeric
# call-seq:
# a.to_digits -> string
#
# Converts a BigDecimal to a String of the form "nnnnnn.mmm".
# This method is deprecated; use BigDecimal#to_s("F") instead.
#
# require 'bigdecimal/util'
#
# d = BigDecimal("3.14")
# d.to_digits # => "3.14"
#
def to_digits
if self.nan? || self.infinite? || self.zero?
self.to_s
else
i = self.to_i.to_s
_,f,_,z = self.frac.split
i + "." + ("0"*(-z)) + f
end
end
# call-seq:
# a.to_d -> bigdecimal
#
# Returns self.
#
# require 'bigdecimal/util'
#
# d = BigDecimal("3.14")
# d.to_d # => 0.314e1
#
def to_d
self
end
end
class Rational < Numeric
# call-seq:
# rat.to_d(precision) -> bigdecimal
#
# Returns the value as a BigDecimal.
#
# The required +precision+ parameter is used to determine the number of
# significant digits for the result.
#
# require 'bigdecimal'
# require 'bigdecimal/util'
#
# Rational(22, 7).to_d(3) # => 0.314e1
#
# See also Kernel.BigDecimal.
#
def to_d(precision)
BigDecimal(self, precision)
end
end
class Complex < Numeric
# call-seq:
# cmp.to_d -> bigdecimal
# cmp.to_d(precision) -> bigdecimal
#
# Returns the value as a BigDecimal.
#
# The +precision+ parameter is required for a rational complex number.
# This parameter is used to determine the number of significant digits
# for the result.
#
# require 'bigdecimal'
# require 'bigdecimal/util'
#
# Complex(0.1234567, 0).to_d(4) # => 0.1235e0
# Complex(Rational(22, 7), 0).to_d(3) # => 0.314e1
#
# See also Kernel.BigDecimal.
#
def to_d(*args)
BigDecimal(self) unless self.imag.zero? # to raise eerror
if args.length == 0
case self.real
when Rational
BigDecimal(self.real) # to raise error
end
end
self.real.to_d(*args)
end
end
class NilClass
# call-seq:
# nil.to_d -> bigdecimal
#
# Returns nil represented as a BigDecimal.
#
# require 'bigdecimal'
# require 'bigdecimal/util'
#
# nil.to_d # => 0.0
#
def to_d
BigDecimal(0)
end
end
share/gems/gems/bigdecimal-3.1.5/lib/bigdecimal/math.rb 0000644 00000013231 15173517742 0016376 0 ustar 00 # frozen_string_literal: false
require 'bigdecimal'
#
#--
# Contents:
# sqrt(x, prec)
# sin (x, prec)
# cos (x, prec)
# atan(x, prec) Note: |x|<1, x=0.9999 may not converge.
# PI (prec)
# E (prec) == exp(1.0,prec)
#
# where:
# x ... BigDecimal number to be computed.
# |x| must be small enough to get convergence.
# prec ... Number of digits to be obtained.
#++
#
# Provides mathematical functions.
#
# Example:
#
# require "bigdecimal/math"
#
# include BigMath
#
# a = BigDecimal((PI(100)/2).to_s)
# puts sin(a,100) # => 0.99999999999999999999......e0
#
module BigMath
module_function
# call-seq:
# sqrt(decimal, numeric) -> BigDecimal
#
# Computes the square root of +decimal+ to the specified number of digits of
# precision, +numeric+.
#
# BigMath.sqrt(BigDecimal('2'), 16).to_s
# #=> "0.1414213562373095048801688724e1"
#
def sqrt(x, prec)
x.sqrt(prec)
end
# call-seq:
# sin(decimal, numeric) -> BigDecimal
#
# Computes the sine of +decimal+ to the specified number of digits of
# precision, +numeric+.
#
# If +decimal+ is Infinity or NaN, returns NaN.
#
# BigMath.sin(BigMath.PI(5)/4, 5).to_s
# #=> "0.70710678118654752440082036563292800375e0"
#
def sin(x, prec)
raise ArgumentError, "Zero or negative precision for sin" if prec <= 0
return BigDecimal("NaN") if x.infinite? || x.nan?
n = prec + BigDecimal.double_fig
one = BigDecimal("1")
two = BigDecimal("2")
x = -x if neg = x < 0
if x > (twopi = two * BigMath.PI(prec))
if x > 30
x %= twopi
else
x -= twopi while x > twopi
end
end
x1 = x
x2 = x.mult(x,n)
sign = 1
y = x
d = y
i = one
z = one
while d.nonzero? && ((m = n - (y.exponent - d.exponent).abs) > 0)
m = BigDecimal.double_fig if m < BigDecimal.double_fig
sign = -sign
x1 = x2.mult(x1,n)
i += two
z *= (i-one) * i
d = sign * x1.div(z,m)
y += d
end
neg ? -y : y
end
# call-seq:
# cos(decimal, numeric) -> BigDecimal
#
# Computes the cosine of +decimal+ to the specified number of digits of
# precision, +numeric+.
#
# If +decimal+ is Infinity or NaN, returns NaN.
#
# BigMath.cos(BigMath.PI(4), 16).to_s
# #=> "-0.999999999999999999999999999999856613163740061349e0"
#
def cos(x, prec)
raise ArgumentError, "Zero or negative precision for cos" if prec <= 0
return BigDecimal("NaN") if x.infinite? || x.nan?
n = prec + BigDecimal.double_fig
one = BigDecimal("1")
two = BigDecimal("2")
x = -x if x < 0
if x > (twopi = two * BigMath.PI(prec))
if x > 30
x %= twopi
else
x -= twopi while x > twopi
end
end
x1 = one
x2 = x.mult(x,n)
sign = 1
y = one
d = y
i = BigDecimal("0")
z = one
while d.nonzero? && ((m = n - (y.exponent - d.exponent).abs) > 0)
m = BigDecimal.double_fig if m < BigDecimal.double_fig
sign = -sign
x1 = x2.mult(x1,n)
i += two
z *= (i-one) * i
d = sign * x1.div(z,m)
y += d
end
y
end
# call-seq:
# atan(decimal, numeric) -> BigDecimal
#
# Computes the arctangent of +decimal+ to the specified number of digits of
# precision, +numeric+.
#
# If +decimal+ is NaN, returns NaN.
#
# BigMath.atan(BigDecimal('-1'), 16).to_s
# #=> "-0.785398163397448309615660845819878471907514682065e0"
#
def atan(x, prec)
raise ArgumentError, "Zero or negative precision for atan" if prec <= 0
return BigDecimal("NaN") if x.nan?
pi = PI(prec)
x = -x if neg = x < 0
return pi.div(neg ? -2 : 2, prec) if x.infinite?
return pi / (neg ? -4 : 4) if x.round(prec) == 1
x = BigDecimal("1").div(x, prec) if inv = x > 1
x = (-1 + sqrt(1 + x**2, prec))/x if dbl = x > 0.5
n = prec + BigDecimal.double_fig
y = x
d = y
t = x
r = BigDecimal("3")
x2 = x.mult(x,n)
while d.nonzero? && ((m = n - (y.exponent - d.exponent).abs) > 0)
m = BigDecimal.double_fig if m < BigDecimal.double_fig
t = -t.mult(x2,n)
d = t.div(r,m)
y += d
r += 2
end
y *= 2 if dbl
y = pi / 2 - y if inv
y = -y if neg
y
end
# call-seq:
# PI(numeric) -> BigDecimal
#
# Computes the value of pi to the specified number of digits of precision,
# +numeric+.
#
# BigMath.PI(10).to_s
# #=> "0.3141592653589793238462643388813853786957412e1"
#
def PI(prec)
raise ArgumentError, "Zero or negative precision for PI" if prec <= 0
n = prec + BigDecimal.double_fig
zero = BigDecimal("0")
one = BigDecimal("1")
two = BigDecimal("2")
m25 = BigDecimal("-0.04")
m57121 = BigDecimal("-57121")
pi = zero
d = one
k = one
t = BigDecimal("-80")
while d.nonzero? && ((m = n - (pi.exponent - d.exponent).abs) > 0)
m = BigDecimal.double_fig if m < BigDecimal.double_fig
t = t*m25
d = t.div(k,m)
k = k+two
pi = pi + d
end
d = one
k = one
t = BigDecimal("956")
while d.nonzero? && ((m = n - (pi.exponent - d.exponent).abs) > 0)
m = BigDecimal.double_fig if m < BigDecimal.double_fig
t = t.div(m57121,n)
d = t.div(k,m)
pi = pi + d
k = k+two
end
pi
end
# call-seq:
# E(numeric) -> BigDecimal
#
# Computes e (the base of natural logarithms) to the specified number of
# digits of precision, +numeric+.
#
# BigMath.E(10).to_s
# #=> "0.271828182845904523536028752390026306410273e1"
#
def E(prec)
raise ArgumentError, "Zero or negative precision for E" if prec <= 0
BigMath.exp(1, prec)
end
end
share/gems/gems/bigdecimal-3.1.5/lib/bigdecimal/jacobian.rb 0000644 00000004161 15173517742 0017215 0 ustar 00 # frozen_string_literal: false
require 'bigdecimal'
# require 'bigdecimal/jacobian'
#
# Provides methods to compute the Jacobian matrix of a set of equations at a
# point x. In the methods below:
#
# f is an Object which is used to compute the Jacobian matrix of the equations.
# It must provide the following methods:
#
# f.values(x):: returns the values of all functions at x
#
# f.zero:: returns 0.0
# f.one:: returns 1.0
# f.two:: returns 2.0
# f.ten:: returns 10.0
#
# f.eps:: returns the convergence criterion (epsilon value) used to determine whether two values are considered equal. If |a-b| < epsilon, the two values are considered equal.
#
# x is the point at which to compute the Jacobian.
#
# fx is f.values(x).
#
module Jacobian
module_function
# Determines the equality of two numbers by comparing to zero, or using the epsilon value
def isEqual(a,b,zero=0.0,e=1.0e-8)
aa = a.abs
bb = b.abs
if aa == zero && bb == zero then
true
else
if ((a-b)/(aa+bb)).abs < e then
true
else
false
end
end
end
# Computes the derivative of +f[i]+ at +x[i]+.
# +fx+ is the value of +f+ at +x+.
def dfdxi(f,fx,x,i)
nRetry = 0
n = x.size
xSave = x[i]
ok = 0
ratio = f.ten*f.ten*f.ten
dx = x[i].abs/ratio
dx = fx[i].abs/ratio if isEqual(dx,f.zero,f.zero,f.eps)
dx = f.one/f.ten if isEqual(dx,f.zero,f.zero,f.eps)
until ok>0 do
deriv = []
nRetry += 1
if nRetry > 100
raise "Singular Jacobian matrix. No change at x[" + i.to_s + "]"
end
dx = dx*f.two
x[i] += dx
fxNew = f.values(x)
for j in 0...n do
if !isEqual(fxNew[j],fx[j],f.zero,f.eps) then
ok += 1
deriv <<= (fxNew[j]-fx[j])/dx
else
deriv <<= f.zero
end
end
x[i] = xSave
end
deriv
end
# Computes the Jacobian of +f+ at +x+. +fx+ is the value of +f+ at +x+.
def jacobian(f,fx,x)
n = x.size
dfdx = Array.new(n*n)
for i in 0...n do
df = dfdxi(f,fx,x,i)
for j in 0...n do
dfdx[j*n+i] = df[j]
end
end
dfdx
end
end
share/gems/gems/bigdecimal-3.1.5/lib/bigdecimal/ludcmp.rb 0000644 00000004201 15173517742 0016726 0 ustar 00 # frozen_string_literal: false
require 'bigdecimal'
#
# Solves a*x = b for x, using LU decomposition.
#
module LUSolve
module_function
# Performs LU decomposition of the n by n matrix a.
def ludecomp(a,n,zero=0,one=1)
prec = BigDecimal.limit(nil)
ps = []
scales = []
for i in 0...n do # pick up largest(abs. val.) element in each row.
ps <<= i
nrmrow = zero
ixn = i*n
for j in 0...n do
biggst = a[ixn+j].abs
nrmrow = biggst if biggst>nrmrow
end
if nrmrow>zero then
scales <<= one.div(nrmrow,prec)
else
raise "Singular matrix"
end
end
n1 = n - 1
for k in 0...n1 do # Gaussian elimination with partial pivoting.
biggst = zero;
for i in k...n do
size = a[ps[i]*n+k].abs*scales[ps[i]]
if size>biggst then
biggst = size
pividx = i
end
end
raise "Singular matrix" if biggst<=zero
if pividx!=k then
j = ps[k]
ps[k] = ps[pividx]
ps[pividx] = j
end
pivot = a[ps[k]*n+k]
for i in (k+1)...n do
psin = ps[i]*n
a[psin+k] = mult = a[psin+k].div(pivot,prec)
if mult!=zero then
pskn = ps[k]*n
for j in (k+1)...n do
a[psin+j] -= mult.mult(a[pskn+j],prec)
end
end
end
end
raise "Singular matrix" if a[ps[n1]*n+n1] == zero
ps
end
# Solves a*x = b for x, using LU decomposition.
#
# a is a matrix, b is a constant vector, x is the solution vector.
#
# ps is the pivot, a vector which indicates the permutation of rows performed
# during LU decomposition.
def lusolve(a,b,ps,zero=0.0)
prec = BigDecimal.limit(nil)
n = ps.size
x = []
for i in 0...n do
dot = zero
psin = ps[i]*n
for j in 0...i do
dot = a[psin+j].mult(x[j],prec) + dot
end
x <<= b[ps[i]] - dot
end
(n-1).downto(0) do |i|
dot = zero
psin = ps[i]*n
for j in (i+1)...n do
dot = a[psin+j].mult(x[j],prec) + dot
end
x[i] = (x[i]-dot).div(a[psin+i],prec)
end
x
end
end
share/gems/gems/bigdecimal-3.1.5/lib/bigdecimal/newton.rb 0000644 00000003532 15173517742 0016762 0 ustar 00 # frozen_string_literal: false
require "bigdecimal/ludcmp"
require "bigdecimal/jacobian"
#
# newton.rb
#
# Solves the nonlinear algebraic equation system f = 0 by Newton's method.
# This program is not dependent on BigDecimal.
#
# To call:
# n = nlsolve(f,x)
# where n is the number of iterations required,
# x is the initial value vector
# f is an Object which is used to compute the values of the equations to be solved.
# It must provide the following methods:
#
# f.values(x):: returns the values of all functions at x
#
# f.zero:: returns 0.0
# f.one:: returns 1.0
# f.two:: returns 2.0
# f.ten:: returns 10.0
#
# f.eps:: returns the convergence criterion (epsilon value) used to determine whether two values are considered equal. If |a-b| < epsilon, the two values are considered equal.
#
# On exit, x is the solution vector.
#
module Newton
include LUSolve
include Jacobian
module_function
def norm(fv,zero=0.0) # :nodoc:
s = zero
n = fv.size
for i in 0...n do
s += fv[i]*fv[i]
end
s
end
# See also Newton
def nlsolve(f,x)
nRetry = 0
n = x.size
f0 = f.values(x)
zero = f.zero
one = f.one
two = f.two
p5 = one/two
d = norm(f0,zero)
minfact = f.ten*f.ten*f.ten
minfact = one/minfact
e = f.eps
while d >= e do
nRetry += 1
# Not yet converged. => Compute Jacobian matrix
dfdx = jacobian(f,f0,x)
# Solve dfdx*dx = -f0 to estimate dx
dx = lusolve(dfdx,f0,ludecomp(dfdx,n,zero,one),zero)
fact = two
xs = x.dup
begin
fact *= p5
if fact < minfact then
raise "Failed to reduce function values."
end
for i in 0...n do
x[i] = xs[i] - dx[i]*fact
end
f0 = f.values(x)
dn = norm(f0,zero)
end while(dn>=d)
d = dn
end
nRetry
end
end
share/gems/gems/syntax_suggest-2.0.1/exe/syntax_suggest 0000755 00000000146 15173517742 0017072 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
require "syntax_suggest/api"
SyntaxSuggest::Cli.new(
argv: ARGV
).call
share/gems/gems/rackup-2.1.0/bin/rackup 0000755 00000000151 15173517742 0013451 0 ustar 00 #!/usr/bin/env ruby
# frozen_string_literal: true
require_relative "../lib/rackup"
Rackup::Server.start
share/gems/gems/rackup-2.1.0/security.md 0000644 00000000145 15173517742 0013662 0 ustar 00 # Security Policy
Please see our main security policy: https://github.com/rack/rack/security/policy
share/gems/gems/rackup-2.1.0/lib/rackup/handler/cgi.rb 0000644 00000002510 15173517742 0016226 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2022-2023, by Samuel Williams.
module Rackup
module Handler
class CGI
include Rack
def self.run(app, **options)
$stdin.binmode
serve app
end
def self.serve(app)
env = ENV.to_hash
env.delete "HTTP_CONTENT_LENGTH"
env[SCRIPT_NAME] = "" if env[SCRIPT_NAME] == "/"
env.update(
RACK_INPUT => $stdin,
RACK_ERRORS => $stderr,
RACK_URL_SCHEME => ["yes", "on", "1"].include?(ENV[HTTPS]) ? "https" : "http"
)
env[QUERY_STRING] ||= ""
env[REQUEST_PATH] ||= "/"
status, headers, body = app.call(env)
begin
send_headers status, headers
send_body body
ensure
body.close if body.respond_to? :close
end
end
def self.send_headers(status, headers)
$stdout.print "Status: #{status}\r\n"
headers.each { |k, vs|
vs.split("\n").each { |v|
$stdout.print "#{k}: #{v}\r\n"
}
}
$stdout.print "\r\n"
$stdout.flush
end
def self.send_body(body)
body.each { |part|
$stdout.print part
$stdout.flush
}
end
end
register :cgi, CGI
end
end
share/gems/gems/rackup-2.1.0/lib/rackup/handler/webrick.rb 0000644 00000010372 15173517742 0017117 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2022-2023, by Samuel Williams.
# Copyright, 2022, by Jeremy Evans.
require 'webrick'
require 'stringio'
require 'rack/constants'
require_relative '../handler'
require_relative '../version'
require_relative '../stream'
module Rackup
module Handler
class WEBrick < ::WEBrick::HTTPServlet::AbstractServlet
def self.run(app, **options)
environment = ENV['RACK_ENV'] || 'development'
default_host = environment == 'development' ? 'localhost' : nil
if !options[:BindAddress] || options[:Host]
options[:BindAddress] = options.delete(:Host) || default_host
end
options[:Port] ||= 8080
if options[:SSLEnable]
require 'webrick/https'
end
@server = ::WEBrick::HTTPServer.new(options)
@server.mount "/", Rackup::Handler::WEBrick, app
yield @server if block_given?
@server.start
end
def self.valid_options
environment = ENV['RACK_ENV'] || 'development'
default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
{
"Host=HOST" => "Hostname to listen on (default: #{default_host})",
"Port=PORT" => "Port to listen on (default: 8080)",
}
end
def self.shutdown
if @server
@server.shutdown
@server = nil
end
end
def initialize(server, app)
super server
@app = app
end
# This handles mapping the WEBrick request to a Rack input stream.
class Input
include Stream::Reader
def initialize(request)
@request = request
@reader = Fiber.new do
@request.body do |chunk|
Fiber.yield(chunk)
end
Fiber.yield(nil)
# End of stream:
@reader = nil
end
end
def close
@request = nil
@reader = nil
end
private
# Read one chunk from the request body.
def read_next
@reader&.resume
end
end
def service(req, res)
env = req.meta_vars
env.delete_if { |k, v| v.nil? }
input = Input.new(req)
env.update(
::Rack::RACK_INPUT => input,
::Rack::RACK_ERRORS => $stderr,
::Rack::RACK_URL_SCHEME => ["yes", "on", "1"].include?(env[::Rack::HTTPS]) ? "https" : "http",
::Rack::RACK_IS_HIJACK => true,
)
env[::Rack::QUERY_STRING] ||= ""
unless env[::Rack::PATH_INFO] == ""
path, n = req.request_uri.path, env[::Rack::SCRIPT_NAME].length
env[::Rack::PATH_INFO] = path[n, path.length - n]
end
env[::Rack::REQUEST_PATH] ||= [env[::Rack::SCRIPT_NAME], env[::Rack::PATH_INFO]].join
status, headers, body = @app.call(env)
begin
res.status = status
if value = headers[::Rack::RACK_HIJACK]
io_lambda = value
body = nil
elsif !body.respond_to?(:to_path) && !body.respond_to?(:each)
io_lambda = body
body = nil
end
if value = headers.delete('set-cookie')
res.cookies.concat(Array(value))
end
headers.each do |key, value|
# Skip keys starting with rack., per Rack SPEC
next if key.start_with?('rack.')
# Since WEBrick won't accept repeated headers,
# merge the values per RFC 1945 section 4.2.
value = value.join(", ") if Array === value
res[key] = value
end
if io_lambda
protocol = headers['rack.protocol'] || headers['upgrade']
if protocol
# Set all the headers correctly for an upgrade response:
res.upgrade!(protocol)
end
res.body = io_lambda
elsif body.respond_to?(:to_path)
res.body = ::File.open(body.to_path, 'rb')
else
buffer = String.new
body.each do |part|
buffer << part
end
res.body = buffer
end
ensure
body.close if body.respond_to?(:close)
end
end
end
register :webrick, WEBrick
end
end
share/gems/gems/rackup-2.1.0/lib/rackup/version.rb 0000644 00000000224 15173517742 0015534 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2022-2023, by Samuel Williams.
module Rackup
VERSION = "2.1.0"
end
share/gems/gems/rackup-2.1.0/lib/rackup/server.rb 0000644 00000032327 15173517742 0015366 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2022-2023, by Samuel Williams.
require 'optparse'
require 'fileutils'
require 'rack/builder'
require 'rack/common_logger'
require 'rack/content_length'
require 'rack/show_exceptions'
require 'rack/lint'
require 'rack/tempfile_reaper'
require 'rack/version'
require_relative 'version'
require_relative 'handler'
module Rackup
class Server
class Options
def parse!(args)
options = {}
opt_parser = OptionParser.new("", 24, ' ') do |opts|
opts.banner = "Usage: rackup [ruby options] [rack options] [rackup config]"
opts.separator ""
opts.separator "Ruby options:"
lineno = 1
opts.on("-e", "--eval LINE", "evaluate a LINE of code") { |line|
eval line, TOPLEVEL_BINDING, "-e", lineno
lineno += 1
}
opts.on("-d", "--debug", "set debugging flags (set $DEBUG to true)") {
options[:debug] = true
}
opts.on("-w", "--warn", "turn warnings on for your script") {
options[:warn] = true
}
opts.on("-q", "--quiet", "turn off logging") {
options[:quiet] = true
}
opts.on("-I", "--include PATH",
"specify $LOAD_PATH (may be used more than once)") { |path|
(options[:include] ||= []).concat(path.split(":"))
}
opts.on("-r", "--require LIBRARY",
"require the library, before executing your script") { |library|
(options[:require] ||= []) << library
}
opts.separator ""
opts.separator "Rack options:"
opts.on("-b", "--builder BUILDER_LINE", "evaluate a BUILDER_LINE of code as a builder script") { |line|
options[:builder] = line
}
opts.on("-s", "--server SERVER", "serve using SERVER (thin/puma/webrick)") { |s|
options[:server] = s
}
opts.on("-o", "--host HOST", "listen on HOST (default: localhost)") { |host|
options[:Host] = host
}
opts.on("-p", "--port PORT", "use PORT (default: 9292)") { |port|
options[:Port] = port
}
opts.on("-O", "--option NAME[=VALUE]", "pass VALUE to the server as option NAME. If no VALUE, sets it to true. Run '#{$0} -s SERVER -h' to get a list of options for SERVER") { |name|
name, value = name.split('=', 2)
value = true if value.nil?
options[name.to_sym] = value
}
opts.on("-E", "--env ENVIRONMENT", "use ENVIRONMENT for defaults (default: development)") { |e|
options[:environment] = e
}
opts.on("-D", "--daemonize", "run daemonized in the background") { |d|
options[:daemonize] ||= true
}
opts.on("--daemonize-noclose", "run daemonized in the background without closing stdout/stderr") {
options[:daemonize] = :noclose
}
opts.on("-P", "--pid FILE", "file to store PID") { |f|
options[:pid] = ::File.expand_path(f)
}
opts.separator ""
opts.separator "Profiling options:"
opts.on("--heap HEAPFILE", "Build the application, then dump the heap to HEAPFILE") do |e|
options[:heapfile] = e
end
opts.on("--profile PROFILE", "Dump CPU or Memory profile to PROFILE (defaults to a tempfile)") do |e|
options[:profile_file] = e
end
opts.on("--profile-mode MODE", "Profile mode (cpu|wall|object)") do |e|
unless %w[cpu wall object].include?(e)
raise OptionParser::InvalidOption, "unknown profile mode: #{e}"
end
options[:profile_mode] = e.to_sym
end
opts.separator ""
opts.separator "Common options:"
opts.on_tail("-h", "-?", "--help", "Show this message") do
puts opts
puts handler_opts(options)
exit
end
opts.on_tail("--version", "Show version") do
puts "Rack #{Rack::RELEASE}"
exit
end
end
begin
opt_parser.parse! args
rescue OptionParser::InvalidOption => e
warn e.message
abort opt_parser.to_s
end
options[:config] = args.last if args.last && !args.last.empty?
options
end
def handler_opts(options)
info = []
server = Rackup::Handler.get(options[:server]) || Rackup::Handler.default
if server && server.respond_to?(:valid_options)
info << ""
info << "Server-specific options for #{server.name}:"
has_options = false
server.valid_options.each do |name, description|
next if /^(Host|Port)[^a-zA-Z]/.match?(name.to_s) # ignore handler's host and port options, we do our own.
info << sprintf(" -O %-21s %s", name, description)
has_options = true
end
return "" if !has_options
end
info.join("\n")
rescue NameError, LoadError
return "Warning: Could not find handler specified (#{options[:server] || 'default'}) to determine handler-specific options"
end
end
# Start a new rack server (like running rackup). This will parse ARGV and
# provide standard ARGV rackup options, defaulting to load 'config.ru'.
#
# Providing an options hash will prevent ARGV parsing and will not include
# any default options.
#
# This method can be used to very easily launch a CGI application, for
# example:
#
# Rack::Server.start(
# :app => lambda do |e|
# [200, {'content-type' => 'text/html'}, ['hello world']]
# end,
# :server => 'cgi'
# )
#
# Further options available here are documented on Rack::Server#initialize
def self.start(options = nil)
new(options).start
end
attr_writer :options
# Options may include:
# * :app
# a rack application to run (overrides :config and :builder)
# * :builder
# a string to evaluate a Rack::Builder from
# * :config
# a rackup configuration file path to load (.ru)
# * :environment
# this selects the middleware that will be wrapped around
# your application. Default options available are:
# - development: CommonLogger, ShowExceptions, and Lint
# - deployment: CommonLogger
# - none: no extra middleware
# note: when the server is a cgi server, CommonLogger is not included.
# * :server
# choose a specific Rackup::Handler, e.g. cgi, fcgi, webrick
# * :daemonize
# if truthy, the server will daemonize itself (fork, detach, etc)
# if :noclose, the server will not close STDOUT/STDERR
# * :pid
# path to write a pid file after daemonize
# * :Host
# the host address to bind to (used by supporting Rackup::Handler)
# * :Port
# the port to bind to (used by supporting Rackup::Handler)
# * :AccessLog
# webrick access log options (or supporting Rackup::Handler)
# * :debug
# turn on debug output ($DEBUG = true)
# * :warn
# turn on warnings ($-w = true)
# * :include
# add given paths to $LOAD_PATH
# * :require
# require the given libraries
#
# Additional options for profiling app initialization include:
# * :heapfile
# location for ObjectSpace.dump_all to write the output to
# * :profile_file
# location for CPU/Memory (StackProf) profile output (defaults to a tempfile)
# * :profile_mode
# StackProf profile mode (cpu|wall|object)
def initialize(options = nil)
@ignore_options = []
if options
@use_default_options = false
@options = options
@app = options[:app] if options[:app]
else
@use_default_options = true
@options = parse_options(ARGV)
end
end
def options
merged_options = @use_default_options ? default_options.merge(@options) : @options
merged_options.reject { |k, v| @ignore_options.include?(k) }
end
def default_options
environment = ENV['RACK_ENV'] || 'development'
default_host = environment == 'development' ? 'localhost' : '0.0.0.0'
{
environment: environment,
pid: nil,
Port: 9292,
Host: default_host,
AccessLog: [],
config: "config.ru"
}
end
def app
@app ||= options[:builder] ? build_app_from_string : build_app_and_options_from_config
end
class << self
def logging_middleware
lambda { |server|
/CGI/.match?(server.server.name) || server.options[:quiet] ? nil : [Rack::CommonLogger, $stderr]
}
end
def default_middleware_by_environment
m = Hash.new {|h, k| h[k] = []}
m["deployment"] = [
[Rack::ContentLength],
logging_middleware,
[Rack::TempfileReaper]
]
m["development"] = [
[Rack::ContentLength],
logging_middleware,
[Rack::ShowExceptions],
[Rack::Lint],
[Rack::TempfileReaper]
]
m
end
def middleware
default_middleware_by_environment
end
end
def middleware
self.class.middleware
end
def start(&block)
if options[:warn]
$-w = true
end
if includes = options[:include]
$LOAD_PATH.unshift(*includes)
end
Array(options[:require]).each do |library|
require library
end
if options[:debug]
$DEBUG = true
require 'pp'
p options[:server]
pp wrapped_app
pp app
end
check_pid! if options[:pid]
# Touch the wrapped app, so that the config.ru is loaded before
# daemonization (i.e. before chdir, etc).
handle_profiling(options[:heapfile], options[:profile_mode], options[:profile_file]) do
wrapped_app
end
daemonize_app if options[:daemonize]
write_pid if options[:pid]
trap(:INT) do
if server.respond_to?(:shutdown)
server.shutdown
else
exit
end
end
server.run(wrapped_app, **options, &block)
end
def server
@_server ||= Handler.get(options[:server]) || Handler.default
end
private
def build_app_and_options_from_config
if !::File.exist? options[:config]
abort "configuration #{options[:config]} not found"
end
return Rack::Builder.parse_file(self.options[:config])
end
def handle_profiling(heapfile, profile_mode, filename)
if heapfile
require "objspace"
ObjectSpace.trace_object_allocations_start
yield
GC.start
::File.open(heapfile, "w") { |f| ObjectSpace.dump_all(output: f) }
exit
end
if profile_mode
require "stackprof"
require "tempfile"
make_profile_name(filename) do |filename|
::File.open(filename, "w") do |f|
StackProf.run(mode: profile_mode, out: f) do
yield
end
puts "Profile written to: #{filename}"
end
end
exit
end
yield
end
def make_profile_name(filename)
if filename
yield filename
else
::Dir::Tmpname.create("profile.dump") do |tmpname, _, _|
yield tmpname
end
end
end
def build_app_from_string
Rack::Builder.new_from_string(self.options[:builder])
end
def parse_options(args)
# Don't evaluate CGI ISINDEX parameters.
args.clear if ENV.include?(Rack::REQUEST_METHOD)
@options = opt_parser.parse!(args)
@options[:config] = ::File.expand_path(options[:config])
ENV["RACK_ENV"] = options[:environment]
@options
end
def opt_parser
Options.new
end
def build_app(app)
middleware[options[:environment]].reverse_each do |middleware|
middleware = middleware.call(self) if middleware.respond_to?(:call)
next unless middleware
klass, *args = middleware
app = klass.new(app, *args)
end
app
end
def wrapped_app
@wrapped_app ||= build_app app
end
def daemonize_app
# Cannot be covered as it forks
# :nocov:
Process.daemon(true, options[:daemonize] == :noclose)
# :nocov:
end
def write_pid
::File.open(options[:pid], ::File::CREAT | ::File::EXCL | ::File::WRONLY ){ |f| f.write("#{Process.pid}") }
at_exit { ::FileUtils.rm_f(options[:pid]) }
rescue Errno::EEXIST
check_pid!
retry
end
def check_pid!
return unless ::File.exist?(options[:pid])
pid = ::File.read(options[:pid]).to_i
raise Errno::ESRCH if pid == 0
Process.kill(0, pid)
exit_with_pid(pid)
rescue Errno::ESRCH
::File.delete(options[:pid])
rescue Errno::EPERM
exit_with_pid(pid)
end
def exit_with_pid(pid)
$stderr.puts "A server is already running (pid: #{pid}, file: #{options[:pid]})."
exit(1)
end
end
end
share/gems/gems/rackup-2.1.0/lib/rackup/stream.rb 0000644 00000012212 15173517742 0015342 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2019-2022, by Samuel Williams.
module Rackup
# The input stream is an IO-like object which contains the raw HTTP POST data. When applicable, its external encoding must be “ASCII-8BIT” and it must be opened in binary mode, for Ruby 1.9 compatibility. The input stream must respond to gets, each, read and rewind.
class Stream
def initialize(input = nil, output = Buffered.new)
@input = input
@output = output
raise ArgumentError, "Non-writable output!" unless output.respond_to?(:write)
# Will hold remaining data in `#read`.
@buffer = nil
@closed = false
end
attr :input
attr :output
# This provides a read-only interface for data, which is surprisingly tricky to implement correctly.
module Reader
# rack.hijack_io must respond to:
# read, write, read_nonblock, write_nonblock, flush, close, close_read, close_write, closed?
# read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be a non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.
# @param length [Integer] the amount of data to read
# @param buffer [String] the buffer which will receive the data
# @return a buffer containing the data
def read(length = nil, buffer = nil)
return '' if length == 0
buffer ||= String.new.force_encoding(Encoding::BINARY)
# Take any previously buffered data and replace it into the given buffer.
if @buffer
buffer.replace(@buffer)
@buffer = nil
else
buffer.clear
end
if length
while buffer.bytesize < length and chunk = read_next
buffer << chunk
end
# This ensures the subsequent `slice!` works correctly.
buffer.force_encoding(Encoding::BINARY)
# This will be at least one copy:
@buffer = buffer.byteslice(length, buffer.bytesize)
# This should be zero-copy:
buffer.slice!(length, buffer.bytesize)
if buffer.empty?
return nil
else
return buffer
end
else
while chunk = read_next
buffer << chunk
end
return buffer
end
end
# Read at most `length` bytes from the stream. Will avoid reading from the underlying stream if possible.
def read_partial(length = nil)
if @buffer
buffer = @buffer
@buffer = nil
else
buffer = read_next
end
if buffer and length
if buffer.bytesize > length
# This ensures the subsequent `slice!` works correctly.
buffer.force_encoding(Encoding::BINARY)
@buffer = buffer.byteslice(length, buffer.bytesize)
buffer.slice!(length, buffer.bytesize)
end
end
return buffer
end
def gets
read_partial
end
def each
while chunk = read_partial
yield chunk
end
end
def read_nonblock(length, buffer = nil)
@buffer ||= read_next
chunk = nil
unless @buffer
buffer&.clear
return
end
if @buffer.bytesize > length
chunk = @buffer.byteslice(0, length)
@buffer = @buffer.byteslice(length, @buffer.bytesize)
else
chunk = @buffer
@buffer = nil
end
if buffer
buffer.replace(chunk)
else
buffer = chunk
end
return buffer
end
end
include Reader
def write(buffer)
if @output
@output.write(buffer)
return buffer.bytesize
else
raise IOError, "Stream is not writable, output has been closed!"
end
end
def write_nonblock(buffer)
write(buffer)
end
def <<(buffer)
write(buffer)
end
def flush
end
def close_read
@input&.close
@input = nil
end
# close must never be called on the input stream. huh?
def close_write
if @output.respond_to?(:close)
@output&.close
end
@output = nil
end
# Close the input and output bodies.
def close(error = nil)
self.close_read
self.close_write
return nil
ensure
@closed = true
end
# Whether the stream has been closed.
def closed?
@closed
end
# Whether there are any output chunks remaining?
def empty?
@output.empty?
end
private
def read_next
if @input
return @input.read
else
@input = nil
raise IOError, "Stream is not readable, input has been closed!"
end
end
end
end
share/gems/gems/rackup-2.1.0/lib/rackup/handler.rb 0000644 00000005473 15173517742 0015477 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2022-2023, by Samuel Williams.
module Rackup
# *Handlers* connect web servers with Rack.
#
# Rackup includes Handlers for WEBrick and CGI.
#
# Handlers usually are activated by calling <tt>MyHandler.run(myapp)</tt>.
# A second optional hash can be passed to include server-specific
# configuration.
module Handler
@handlers = {}
# Register a named handler class.
def self.register(name, klass)
if klass.is_a?(String)
warn "Calling Rackup::Handler.register with a string is deprecated, use the class/module itself.", uplevel: 1
klass = self.const_get(klass, false)
end
name = name.to_sym
@handlers[name] = klass
end
def self.[](name)
name = name.to_sym
begin
@handlers[name] || self.const_get(name, false)
rescue NameError
# Ignore.
end
end
def self.get(name)
return nil unless name
name = name.to_sym
if server = self[name]
return server
end
begin
require_handler("rackup/handler", name)
rescue LoadError
require_handler("rack/handler", name)
end
return self[name]
end
RACK_HANDLER = 'RACK_HANDLER'
RACKUP_HANDLER = 'RACKUP_HANDLER'
SERVER_NAMES = %i(puma falcon webrick).freeze
private_constant :SERVER_NAMES
# Select first available Rack handler given an `Array` of server names.
# Raises `LoadError` if no handler was found.
#
# > pick ['puma', 'webrick']
# => Rackup::Handler::WEBrick
def self.pick(server_names)
server_names = Array(server_names)
server_names.each do |server_name|
begin
server = self.get(server_name)
return server if server
rescue LoadError
# Ignore.
end
end
raise LoadError, "Couldn't find handler for: #{server_names.join(', ')}."
end
def self.default
if rack_handler = ENV[RACKUP_HANDLER]
self.get(rack_handler)
elsif rack_handler = ENV[RACK_HANDLER]
warn "RACK_HANDLER is deprecated, use RACKUP_HANDLER."
self.get(rack_handler)
else
pick SERVER_NAMES
end
end
# Transforms server-name constants to their canonical form as filenames,
# then tries to require them but silences the LoadError if not found
#
# Naming convention:
#
# Foo # => 'foo'
# FooBar # => 'foo_bar.rb'
# FooBAR # => 'foobar.rb'
# FOObar # => 'foobar.rb'
# FOOBAR # => 'foobar.rb'
# FooBarBaz # => 'foo_bar_baz.rb'
def self.require_handler(prefix, const_name)
file = const_name.to_s.gsub(/^[A-Z]+/) { |pre| pre.downcase }.
gsub(/[A-Z]+[^A-Z]/, '_\&').downcase
require(::File.join(prefix, file))
end
end
end
share/gems/gems/rackup-2.1.0/lib/rackup/lobster.rb 0000644 00000004305 15173517742 0015525 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2022-2023, by Samuel Williams.
require 'zlib'
require 'rack/constants'
require 'rack/request'
require 'rack/response'
module Rackup
# Paste has a Pony, Rack has a Lobster!
class Lobster
include Rack
LobsterString = Zlib::Inflate.inflate("eJx9kEEOwyAMBO99xd7MAcytUhPlJyj2
P6jy9i4k9EQyGAnBarEXeCBqSkntNXsi/ZCvC48zGQoZKikGrFMZvgS5ZHd+aGWVuWwhVF0
t1drVmiR42HcWNz5w3QanT+2gIvTVCiE1lm1Y0eU4JGmIIbaKwextKn8rvW+p5PIwFl8ZWJ
I8jyiTlhTcYXkekJAzTyYN6E08A+dk8voBkAVTJQ==".delete("\n ").unpack("m*")[0])
LambdaLobster = lambda { |env|
if env[QUERY_STRING].include?("flip")
lobster = LobsterString.split("\n").
map { |line| line.ljust(42).reverse }.
join("\n")
href = "?"
else
lobster = LobsterString
href = "?flip"
end
content = ["<title>Lobstericious!</title>",
"<pre>", lobster, "</pre>",
"<a href='#{href}'>flip!</a>"]
length = content.inject(0) { |a, e| a + e.size }.to_s
[200, { CONTENT_TYPE => "text/html", CONTENT_LENGTH => length }, content]
}
def call(env)
req = Request.new(env)
if req.GET["flip"] == "left"
lobster = LobsterString.split("\n").map do |line|
line.ljust(42).reverse.
gsub('\\', 'TEMP').
gsub('/', '\\').
gsub('TEMP', '/').
gsub('{', '}').
gsub('(', ')')
end.join("\n")
href = "?flip=right"
elsif req.GET["flip"] == "crash"
raise "Lobster crashed"
else
lobster = LobsterString
href = "?flip=left"
end
res = Response.new
res.write "<title>Lobstericious!</title>"
res.write "<pre>"
res.write lobster
res.write "</pre>"
res.write "<p><a href='#{href}'>flip!</a></p>"
res.write "<p><a href='?flip=crash'>crash!</a></p>"
res.finish
end
end
end
if $0 == __FILE__
# :nocov:
require_relative 'server'
require_relative 'show_exceptions'
require_relative 'lint'
Rackup::Server.start(
app: Rack::ShowExceptions.new(Rack::Lint.new(Rackup::Lobster.new)), Port: 9292
)
# :nocov:
end
share/gems/gems/rackup-2.1.0/lib/rackup.rb 0000644 00000000444 15173517742 0014053 0 ustar 00 # frozen_string_literal: true
# Released under the MIT License.
# Copyright, 2022-2023, by Samuel Williams.
require_relative 'rackup/handler'
require_relative 'rackup/server'
require_relative 'rackup/version'
require_relative 'rackup/handler/webrick'
require_relative 'rackup/handler/cgi'
share/gems/gems/rackup-2.1.0/license.md 0000644 00000006243 15173517742 0013442 0 ustar 00 # MIT License
Copyright, 2007-2009, by Leah Neukirchen.
Copyright, 2008, by Marc-André Cournoyer.
Copyright, 2009, by Aaron Pfeifer.
Copyright, 2009-2010, by Megan Batty.
Copyright, 2009-2010, by Michael Fellinger.
Copyright, 2009, by Genki Takiuchi.
Copyright, 2009, by Joshua Peek.
Copyright, 2009, by Yehuda Katz + Carl Lerche.
Copyright, 2009, by Carl Lerche.
Copyright, 2010, by Julik Tarkhanov.
Copyright, 2010-2016, by James Tucker.
Copyright, 2010, by Timur Batyrshin.
Copyright, 2010, by Loren Segal.
Copyright, 2010, by Andrew Bortz.
Copyright, 2010, by John Barnette.
Copyright, 2010, by John Sumsion.
Copyright, 2011-2018, by Aaron Patterson.
Copyright, 2011, by Konstantin Haase.
Copyright, 2011, by Blake Mizerany.
Copyright, 2011, by Tsutomu Kuroda.
Copyright, 2012, by Jean Boussier.
Copyright, 2012, by Trevor Wennblom.
Copyright, 2012, by Anurag Priyam.
Copyright, 2012, by Hrvoje Šimić.
Copyright, 2013, by Uchio KONDO.
Copyright, 2013, by Tim Moore.
Copyright, 2013, by Postmodern.
Copyright, 2013, by Bas Vodde.
Copyright, 2013, by Joe Fiorini.
Copyright, 2014, by Wyatt Pan.
Copyright, 2014, by Lenny Marks.
Copyright, 2014, by Igor Bochkariov.
Copyright, 2014, by Max Cantor.
Copyright, 2014, by David Celis.
Copyright, 2014, by Rafael Mendonça França.
Copyright, 2014, by Jeremy Kemper.
Copyright, 2014, by Richard Schneeman.
Copyright, 2015, by Peter Wilmott.
Copyright, 2015, by Sean McGivern.
Copyright, 2015, by Tadashi Saito.
Copyright, 2015, by deepj.
Copyright, 2015, by Zachary Scott.
Copyright, 2016, by Sophie Deziel.
Copyright, 2016, by Kazuya Hotta.
Copyright, 2017, by Ryunosuke Sato.
Copyright, 2017-2023, by Samuel Williams.
Copyright, 2018, by Dillon Welch.
Copyright, 2018, by Yoshiyuki Hirano.
Copyright, 2018, by Nick LaMuro.
Copyright, 2019, by Rafael França.
Copyright, 2019, by Krzysztof Rybka.
Copyright, 2019, by Misaki Shioi.
Copyright, 2020-2022, by Jeremy Evans.
Copyright, 2021, by Katsuhiko YOSHIDA.
Copyright, 2021, by KS.
Copyright, 2021, by Stephen Paul Weber.
Copyright, 2022, by Akira Matsuda.
Copyright, 2022, by Andrew Hoglund.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
share/gems/gems/rackup-2.1.0/readme.md 0000644 00000001365 15173517742 0013255 0 ustar 00 # Rackup
`rackup` provides a command line interface for running a Rack-compatible application.
[](https://github.com/rack/rackup/actions?workflow=Test)
## Installation
``` bash
$ gem install rackup
```
## Usage
In a directory with your `config.ru` simply run the command:
``` bash
$ rackup
```
Your application should now be available locally, typically `http://localhost:9292`.
## Contributing
We welcome contributions to this project.
1. Fork it.
2. Create your feature branch (`git checkout -b my-new-feature`).
3. Commit your changes (`git commit -am 'Add some feature'`).
4. Push to the branch (`git push origin my-new-feature`).
5. Create new Pull Request.
share/gems/gems/json-2.7.2/lib/json/ext.rb 0000644 00000000607 15173517742 0014034 0 ustar 00 require 'json/common'
module JSON
# This module holds all the modules/classes that implement JSON's
# functionality as C extensions.
module Ext
require 'json/ext/parser'
require 'json/ext/generator'
$DEBUG and warn "Using Ext extension for JSON."
JSON.parser = Parser
JSON.generator = Generator
end
JSON_LOADED = true unless defined?(::JSON::JSON_LOADED)
end
share/gems/gems/json-2.7.2/lib/json/generic_object.rb 0000644 00000003052 15173517742 0016173 0 ustar 00 #frozen_string_literal: false
begin
require 'ostruct'
rescue LoadError
warn "JSON::GenericObject requires 'ostruct'. Please install it with `gem install ostruct`."
end
module JSON
class GenericObject < OpenStruct
class << self
alias [] new
def json_creatable?
@json_creatable
end
attr_writer :json_creatable
def json_create(data)
data = data.dup
data.delete JSON.create_id
self[data]
end
def from_hash(object)
case
when object.respond_to?(:to_hash)
result = new
object.to_hash.each do |key, value|
result[key] = from_hash(value)
end
result
when object.respond_to?(:to_ary)
object.to_ary.map { |a| from_hash(a) }
else
object
end
end
def load(source, proc = nil, opts = {})
result = ::JSON.load(source, proc, opts.merge(:object_class => self))
result.nil? ? new : result
end
def dump(obj, *args)
::JSON.dump(obj, *args)
end
end
self.json_creatable = false
def to_hash
table
end
def [](name)
__send__(name)
end unless method_defined?(:[])
def []=(name, value)
__send__("#{name}=", value)
end unless method_defined?(:[]=)
def |(other)
self.class[other.to_hash.merge(to_hash)]
end
def as_json(*)
{ JSON.create_id => self.class.name }.merge to_hash
end
def to_json(*a)
as_json.to_json(*a)
end
end if defined?(::OpenStruct)
end
share/gems/gems/json-2.7.2/lib/json/common.rb 0000644 00000051424 15173517742 0014527 0 ustar 00 #frozen_string_literal: false
require 'json/version'
module JSON
autoload :GenericObject, 'json/generic_object'
NOT_SET = Object.new.freeze
private_constant :NOT_SET
class << self
# :call-seq:
# JSON[object] -> new_array or new_string
#
# If +object+ is a \String,
# calls JSON.parse with +object+ and +opts+ (see method #parse):
# json = '[0, 1, null]'
# JSON[json]# => [0, 1, nil]
#
# Otherwise, calls JSON.generate with +object+ and +opts+ (see method #generate):
# ruby = [0, 1, nil]
# JSON[ruby] # => '[0,1,null]'
def [](object, opts = {})
if object.respond_to? :to_str
JSON.parse(object.to_str, opts)
else
JSON.generate(object, opts)
end
end
# Returns the JSON parser class that is used by JSON. This is either
# JSON::Ext::Parser or JSON::Pure::Parser:
# JSON.parser # => JSON::Ext::Parser
attr_reader :parser
# Set the JSON parser class _parser_ to be used by JSON.
def parser=(parser) # :nodoc:
@parser = parser
remove_const :Parser if const_defined?(:Parser, false)
const_set :Parser, parser
end
# Return the constant located at _path_. The format of _path_ has to be
# either ::A::B::C or A::B::C. In any case, A has to be located at the top
# level (absolute namespace path?). If there doesn't exist a constant at
# the given path, an ArgumentError is raised.
def deep_const_get(path) # :nodoc:
path.to_s.split(/::/).inject(Object) do |p, c|
case
when c.empty? then p
when p.const_defined?(c, true) then p.const_get(c)
else
begin
p.const_missing(c)
rescue NameError => e
raise ArgumentError, "can't get const #{path}: #{e}"
end
end
end
end
# Set the module _generator_ to be used by JSON.
def generator=(generator) # :nodoc:
old, $VERBOSE = $VERBOSE, nil
@generator = generator
generator_methods = generator::GeneratorMethods
for const in generator_methods.constants
klass = deep_const_get(const)
modul = generator_methods.const_get(const)
klass.class_eval do
instance_methods(false).each do |m|
m.to_s == 'to_json' and remove_method m
end
include modul
end
end
self.state = generator::State
const_set :State, self.state
const_set :SAFE_STATE_PROTOTYPE, State.new # for JRuby
const_set :FAST_STATE_PROTOTYPE, create_fast_state
const_set :PRETTY_STATE_PROTOTYPE, create_pretty_state
ensure
$VERBOSE = old
end
def create_fast_state
State.new(
:indent => '',
:space => '',
:object_nl => "",
:array_nl => "",
:max_nesting => false
)
end
def create_pretty_state
State.new(
:indent => ' ',
:space => ' ',
:object_nl => "\n",
:array_nl => "\n"
)
end
# Returns the JSON generator module that is used by JSON. This is
# either JSON::Ext::Generator or JSON::Pure::Generator:
# JSON.generator # => JSON::Ext::Generator
attr_reader :generator
# Sets or Returns the JSON generator state class that is used by JSON. This is
# either JSON::Ext::Generator::State or JSON::Pure::Generator::State:
# JSON.state # => JSON::Ext::Generator::State
attr_accessor :state
end
DEFAULT_CREATE_ID = 'json_class'.freeze
private_constant :DEFAULT_CREATE_ID
CREATE_ID_TLS_KEY = "JSON.create_id".freeze
private_constant :CREATE_ID_TLS_KEY
# Sets create identifier, which is used to decide if the _json_create_
# hook of a class should be called; initial value is +json_class+:
# JSON.create_id # => 'json_class'
def self.create_id=(new_value)
Thread.current[CREATE_ID_TLS_KEY] = new_value.dup.freeze
end
# Returns the current create identifier.
# See also JSON.create_id=.
def self.create_id
Thread.current[CREATE_ID_TLS_KEY] || DEFAULT_CREATE_ID
end
NaN = 0.0/0
Infinity = 1.0/0
MinusInfinity = -Infinity
# The base exception for JSON errors.
class JSONError < StandardError
def self.wrap(exception)
obj = new("Wrapped(#{exception.class}): #{exception.message.inspect}")
obj.set_backtrace exception.backtrace
obj
end
end
# This exception is raised if a parser error occurs.
class ParserError < JSONError; end
# This exception is raised if the nesting of parsed data structures is too
# deep.
class NestingError < ParserError; end
# :stopdoc:
class CircularDatastructure < NestingError; end
# :startdoc:
# This exception is raised if a generator or unparser error occurs.
class GeneratorError < JSONError; end
# For backwards compatibility
UnparserError = GeneratorError # :nodoc:
# This exception is raised if the required unicode support is missing on the
# system. Usually this means that the iconv library is not installed.
class MissingUnicodeSupport < JSONError; end
module_function
# :call-seq:
# JSON.parse(source, opts) -> object
#
# Returns the Ruby objects created by parsing the given +source+.
#
# Argument +source+ contains the \String to be parsed.
#
# Argument +opts+, if given, contains a \Hash of options for the parsing.
# See {Parsing Options}[#module-JSON-label-Parsing+Options].
#
# ---
#
# When +source+ is a \JSON array, returns a Ruby \Array:
# source = '["foo", 1.0, true, false, null]'
# ruby = JSON.parse(source)
# ruby # => ["foo", 1.0, true, false, nil]
# ruby.class # => Array
#
# When +source+ is a \JSON object, returns a Ruby \Hash:
# source = '{"a": "foo", "b": 1.0, "c": true, "d": false, "e": null}'
# ruby = JSON.parse(source)
# ruby # => {"a"=>"foo", "b"=>1.0, "c"=>true, "d"=>false, "e"=>nil}
# ruby.class # => Hash
#
# For examples of parsing for all \JSON data types, see
# {Parsing \JSON}[#module-JSON-label-Parsing+JSON].
#
# Parses nested JSON objects:
# source = <<-EOT
# {
# "name": "Dave",
# "age" :40,
# "hats": [
# "Cattleman's",
# "Panama",
# "Tophat"
# ]
# }
# EOT
# ruby = JSON.parse(source)
# ruby # => {"name"=>"Dave", "age"=>40, "hats"=>["Cattleman's", "Panama", "Tophat"]}
#
# ---
#
# Raises an exception if +source+ is not valid JSON:
# # Raises JSON::ParserError (783: unexpected token at ''):
# JSON.parse('')
#
def parse(source, opts = {})
Parser.new(source, **(opts||{})).parse
end
# :call-seq:
# JSON.parse!(source, opts) -> object
#
# Calls
# parse(source, opts)
# with +source+ and possibly modified +opts+.
#
# Differences from JSON.parse:
# - Option +max_nesting+, if not provided, defaults to +false+,
# which disables checking for nesting depth.
# - Option +allow_nan+, if not provided, defaults to +true+.
def parse!(source, opts = {})
opts = {
:max_nesting => false,
:allow_nan => true
}.merge(opts)
Parser.new(source, **(opts||{})).parse
end
# :call-seq:
# JSON.load_file(path, opts={}) -> object
#
# Calls:
# parse(File.read(path), opts)
#
# See method #parse.
def load_file(filespec, opts = {})
parse(File.read(filespec), opts)
end
# :call-seq:
# JSON.load_file!(path, opts = {})
#
# Calls:
# JSON.parse!(File.read(path, opts))
#
# See method #parse!
def load_file!(filespec, opts = {})
parse!(File.read(filespec), opts)
end
# :call-seq:
# JSON.generate(obj, opts = nil) -> new_string
#
# Returns a \String containing the generated \JSON data.
#
# See also JSON.fast_generate, JSON.pretty_generate.
#
# Argument +obj+ is the Ruby object to be converted to \JSON.
#
# Argument +opts+, if given, contains a \Hash of options for the generation.
# See {Generating Options}[#module-JSON-label-Generating+Options].
#
# ---
#
# When +obj+ is an \Array, returns a \String containing a \JSON array:
# obj = ["foo", 1.0, true, false, nil]
# json = JSON.generate(obj)
# json # => '["foo",1.0,true,false,null]'
#
# When +obj+ is a \Hash, returns a \String containing a \JSON object:
# obj = {foo: 0, bar: 's', baz: :bat}
# json = JSON.generate(obj)
# json # => '{"foo":0,"bar":"s","baz":"bat"}'
#
# For examples of generating from other Ruby objects, see
# {Generating \JSON from Other Objects}[#module-JSON-label-Generating+JSON+from+Other+Objects].
#
# ---
#
# Raises an exception if any formatting option is not a \String.
#
# Raises an exception if +obj+ contains circular references:
# a = []; b = []; a.push(b); b.push(a)
# # Raises JSON::NestingError (nesting of 100 is too deep):
# JSON.generate(a)
#
def generate(obj, opts = nil)
if State === opts
state = opts
else
state = State.new(opts)
end
state.generate(obj)
end
# :stopdoc:
# I want to deprecate these later, so I'll first be silent about them, and
# later delete them.
alias unparse generate
module_function :unparse
# :startdoc:
# :call-seq:
# JSON.fast_generate(obj, opts) -> new_string
#
# Arguments +obj+ and +opts+ here are the same as
# arguments +obj+ and +opts+ in JSON.generate.
#
# By default, generates \JSON data without checking
# for circular references in +obj+ (option +max_nesting+ set to +false+, disabled).
#
# Raises an exception if +obj+ contains circular references:
# a = []; b = []; a.push(b); b.push(a)
# # Raises SystemStackError (stack level too deep):
# JSON.fast_generate(a)
def fast_generate(obj, opts = nil)
if State === opts
state = opts
else
state = JSON.create_fast_state.configure(opts)
end
state.generate(obj)
end
# :stopdoc:
# I want to deprecate these later, so I'll first be silent about them, and later delete them.
alias fast_unparse fast_generate
module_function :fast_unparse
# :startdoc:
# :call-seq:
# JSON.pretty_generate(obj, opts = nil) -> new_string
#
# Arguments +obj+ and +opts+ here are the same as
# arguments +obj+ and +opts+ in JSON.generate.
#
# Default options are:
# {
# indent: ' ', # Two spaces
# space: ' ', # One space
# array_nl: "\n", # Newline
# object_nl: "\n" # Newline
# }
#
# Example:
# obj = {foo: [:bar, :baz], bat: {bam: 0, bad: 1}}
# json = JSON.pretty_generate(obj)
# puts json
# Output:
# {
# "foo": [
# "bar",
# "baz"
# ],
# "bat": {
# "bam": 0,
# "bad": 1
# }
# }
#
def pretty_generate(obj, opts = nil)
if State === opts
state, opts = opts, nil
else
state = JSON.create_pretty_state
end
if opts
if opts.respond_to? :to_hash
opts = opts.to_hash
elsif opts.respond_to? :to_h
opts = opts.to_h
else
raise TypeError, "can't convert #{opts.class} into Hash"
end
state.configure(opts)
end
state.generate(obj)
end
# :stopdoc:
# I want to deprecate these later, so I'll first be silent about them, and later delete them.
alias pretty_unparse pretty_generate
module_function :pretty_unparse
# :startdoc:
class << self
# Sets or returns default options for the JSON.load method.
# Initially:
# opts = JSON.load_default_options
# opts # => {:max_nesting=>false, :allow_nan=>true, :allow_blank=>true, :create_additions=>true}
attr_accessor :load_default_options
end
self.load_default_options = {
:max_nesting => false,
:allow_nan => true,
:allow_blank => true,
:create_additions => true,
}
# :call-seq:
# JSON.load(source, proc = nil, options = {}) -> object
#
# Returns the Ruby objects created by parsing the given +source+.
#
# - Argument +source+ must be, or be convertible to, a \String:
# - If +source+ responds to instance method +to_str+,
# <tt>source.to_str</tt> becomes the source.
# - If +source+ responds to instance method +to_io+,
# <tt>source.to_io.read</tt> becomes the source.
# - If +source+ responds to instance method +read+,
# <tt>source.read</tt> becomes the source.
# - If both of the following are true, source becomes the \String <tt>'null'</tt>:
# - Option +allow_blank+ specifies a truthy value.
# - The source, as defined above, is +nil+ or the empty \String <tt>''</tt>.
# - Otherwise, +source+ remains the source.
# - Argument +proc+, if given, must be a \Proc that accepts one argument.
# It will be called recursively with each result (depth-first order).
# See details below.
# BEWARE: This method is meant to serialise data from trusted user input,
# like from your own database server or clients under your control, it could
# be dangerous to allow untrusted users to pass JSON sources into it.
# - Argument +opts+, if given, contains a \Hash of options for the parsing.
# See {Parsing Options}[#module-JSON-label-Parsing+Options].
# The default options can be changed via method JSON.load_default_options=.
#
# ---
#
# When no +proc+ is given, modifies +source+ as above and returns the result of
# <tt>parse(source, opts)</tt>; see #parse.
#
# Source for following examples:
# source = <<-EOT
# {
# "name": "Dave",
# "age" :40,
# "hats": [
# "Cattleman's",
# "Panama",
# "Tophat"
# ]
# }
# EOT
#
# Load a \String:
# ruby = JSON.load(source)
# ruby # => {"name"=>"Dave", "age"=>40, "hats"=>["Cattleman's", "Panama", "Tophat"]}
#
# Load an \IO object:
# require 'stringio'
# object = JSON.load(StringIO.new(source))
# object # => {"name"=>"Dave", "age"=>40, "hats"=>["Cattleman's", "Panama", "Tophat"]}
#
# Load a \File object:
# path = 't.json'
# File.write(path, source)
# File.open(path) do |file|
# JSON.load(file)
# end # => {"name"=>"Dave", "age"=>40, "hats"=>["Cattleman's", "Panama", "Tophat"]}
#
# ---
#
# When +proc+ is given:
# - Modifies +source+ as above.
# - Gets the +result+ from calling <tt>parse(source, opts)</tt>.
# - Recursively calls <tt>proc(result)</tt>.
# - Returns the final result.
#
# Example:
# require 'json'
#
# # Some classes for the example.
# class Base
# def initialize(attributes)
# @attributes = attributes
# end
# end
# class User < Base; end
# class Account < Base; end
# class Admin < Base; end
# # The JSON source.
# json = <<-EOF
# {
# "users": [
# {"type": "User", "username": "jane", "email": "jane@example.com"},
# {"type": "User", "username": "john", "email": "john@example.com"}
# ],
# "accounts": [
# {"account": {"type": "Account", "paid": true, "account_id": "1234"}},
# {"account": {"type": "Account", "paid": false, "account_id": "1235"}}
# ],
# "admins": {"type": "Admin", "password": "0wn3d"}
# }
# EOF
# # Deserializer method.
# def deserialize_obj(obj, safe_types = %w(User Account Admin))
# type = obj.is_a?(Hash) && obj["type"]
# safe_types.include?(type) ? Object.const_get(type).new(obj) : obj
# end
# # Call to JSON.load
# ruby = JSON.load(json, proc {|obj|
# case obj
# when Hash
# obj.each {|k, v| obj[k] = deserialize_obj v }
# when Array
# obj.map! {|v| deserialize_obj v }
# end
# })
# pp ruby
# Output:
# {"users"=>
# [#<User:0x00000000064c4c98
# @attributes=
# {"type"=>"User", "username"=>"jane", "email"=>"jane@example.com"}>,
# #<User:0x00000000064c4bd0
# @attributes=
# {"type"=>"User", "username"=>"john", "email"=>"john@example.com"}>],
# "accounts"=>
# [{"account"=>
# #<Account:0x00000000064c4928
# @attributes={"type"=>"Account", "paid"=>true, "account_id"=>"1234"}>},
# {"account"=>
# #<Account:0x00000000064c4680
# @attributes={"type"=>"Account", "paid"=>false, "account_id"=>"1235"}>}],
# "admins"=>
# #<Admin:0x00000000064c41f8
# @attributes={"type"=>"Admin", "password"=>"0wn3d"}>}
#
def load(source, proc = nil, options = {})
opts = load_default_options.merge options
if source.respond_to? :to_str
source = source.to_str
elsif source.respond_to? :to_io
source = source.to_io.read
elsif source.respond_to?(:read)
source = source.read
end
if opts[:allow_blank] && (source.nil? || source.empty?)
source = 'null'
end
result = parse(source, opts)
recurse_proc(result, &proc) if proc
result
end
# Recursively calls passed _Proc_ if the parsed data structure is an _Array_ or _Hash_
def recurse_proc(result, &proc) # :nodoc:
case result
when Array
result.each { |x| recurse_proc x, &proc }
proc.call result
when Hash
result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
proc.call result
else
proc.call result
end
end
alias restore load
module_function :restore
class << self
# Sets or returns the default options for the JSON.dump method.
# Initially:
# opts = JSON.dump_default_options
# opts # => {:max_nesting=>false, :allow_nan=>true, :script_safe=>false}
attr_accessor :dump_default_options
end
self.dump_default_options = {
:max_nesting => false,
:allow_nan => true,
:script_safe => false,
}
# :call-seq:
# JSON.dump(obj, io = nil, limit = nil)
#
# Dumps +obj+ as a \JSON string, i.e. calls generate on the object and returns the result.
#
# The default options can be changed via method JSON.dump_default_options.
#
# - Argument +io+, if given, should respond to method +write+;
# the \JSON \String is written to +io+, and +io+ is returned.
# If +io+ is not given, the \JSON \String is returned.
# - Argument +limit+, if given, is passed to JSON.generate as option +max_nesting+.
#
# ---
#
# When argument +io+ is not given, returns the \JSON \String generated from +obj+:
# obj = {foo: [0, 1], bar: {baz: 2, bat: 3}, bam: :bad}
# json = JSON.dump(obj)
# json # => "{\"foo\":[0,1],\"bar\":{\"baz\":2,\"bat\":3},\"bam\":\"bad\"}"
#
# When argument +io+ is given, writes the \JSON \String to +io+ and returns +io+:
# path = 't.json'
# File.open(path, 'w') do |file|
# JSON.dump(obj, file)
# end # => #<File:t.json (closed)>
# puts File.read(path)
# Output:
# {"foo":[0,1],"bar":{"baz":2,"bat":3},"bam":"bad"}
def dump(obj, anIO = nil, limit = nil, kwargs = nil)
io_limit_opt = [anIO, limit, kwargs].compact
kwargs = io_limit_opt.pop if io_limit_opt.last.is_a?(Hash)
anIO, limit = io_limit_opt
if anIO.respond_to?(:to_io)
anIO = anIO.to_io
elsif limit.nil? && !anIO.respond_to?(:write)
anIO, limit = nil, anIO
end
opts = JSON.dump_default_options
opts = opts.merge(:max_nesting => limit) if limit
opts = merge_dump_options(opts, **kwargs) if kwargs
result = generate(obj, opts)
if anIO
anIO.write result
anIO
else
result
end
rescue JSON::NestingError
raise ArgumentError, "exceed depth limit"
end
# Encodes string using String.encode.
def self.iconv(to, from, string)
string.encode(to, from)
end
def merge_dump_options(opts, strict: NOT_SET)
opts = opts.merge(strict: strict) if NOT_SET != strict
opts
end
class << self
private :merge_dump_options
end
end
module ::Kernel
private
# Outputs _objs_ to STDOUT as JSON strings in the shortest form, that is in
# one line.
def j(*objs)
objs.each do |obj|
puts JSON::generate(obj, :allow_nan => true, :max_nesting => false)
end
nil
end
# Outputs _objs_ to STDOUT as JSON strings in a pretty format, with
# indentation and over many lines.
def jj(*objs)
objs.each do |obj|
puts JSON::pretty_generate(obj, :allow_nan => true, :max_nesting => false)
end
nil
end
# If _object_ is string-like, parse the string and return the parsed result as
# a Ruby data structure. Otherwise, generate a JSON text from the Ruby data
# structure object and return it.
#
# The _opts_ argument is passed through to generate/parse respectively. See
# generate and parse for their documentation.
def JSON(object, *args)
if object.respond_to? :to_str
JSON.parse(object.to_str, args.first)
else
JSON.generate(object, args.first)
end
end
end
# Extends any Class to include _json_creatable?_ method.
class ::Class
# Returns true if this class can be used to create an instance
# from a serialised JSON string. The class has to implement a class
# method _json_create_ that expects a hash as first parameter. The hash
# should include the required data.
def json_creatable?
respond_to?(:json_create)
end
end
share/gems/gems/json-2.7.2/lib/json/version.rb 0000644 00000000456 15173517742 0014723 0 ustar 00 # frozen_string_literal: false
module JSON
# JSON version
VERSION = '2.7.2'
VERSION_ARRAY = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
VERSION_MAJOR = VERSION_ARRAY[0] # :nodoc:
VERSION_MINOR = VERSION_ARRAY[1] # :nodoc:
VERSION_BUILD = VERSION_ARRAY[2] # :nodoc:
end
share/gems/gems/json-2.7.2/lib/json/add/symbol.rb 0000644 00000002014 15173517742 0015263 0 ustar 00
#frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Symbol
# Methods <tt>Symbol#as_json</tt> and +Symbol.json_create+ may be used
# to serialize and deserialize a \Symbol object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Symbol#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/symbol'
# x = :foo.as_json
# # => {"json_class"=>"Symbol", "s"=>"foo"}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Symbol object:
#
# Symbol.json_create(x) # => :foo
#
def as_json(*)
{
JSON.create_id => self.class.name,
's' => to_s,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/symbol'
# puts :foo.to_json
#
# Output:
#
# # {"json_class":"Symbol","s":"foo"}
#
def to_json(*a)
as_json.to_json(*a)
end
# See #as_json.
def self.json_create(o)
o['s'].to_sym
end
end
share/gems/gems/json-2.7.2/lib/json/add/time.rb 0000644 00000002736 15173517742 0014727 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Time
# See #as_json.
def self.json_create(object)
if usec = object.delete('u') # used to be tv_usec -> tv_nsec
object['n'] = usec * 1000
end
if method_defined?(:tv_nsec)
at(object['s'], Rational(object['n'], 1000))
else
at(object['s'], object['n'] / 1000)
end
end
# Methods <tt>Time#as_json</tt> and +Time.json_create+ may be used
# to serialize and deserialize a \Time object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Time#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/time'
# x = Time.now.as_json
# # => {"json_class"=>"Time", "s"=>1700931656, "n"=>472846644}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Time object:
#
# Time.json_create(x)
# # => 2023-11-25 11:00:56.472846644 -0600
#
def as_json(*)
nanoseconds = [ tv_usec * 1000 ]
respond_to?(:tv_nsec) and nanoseconds << tv_nsec
nanoseconds = nanoseconds.max
{
JSON.create_id => self.class.name,
's' => tv_sec,
'n' => nanoseconds,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/time'
# puts Time.now.to_json
#
# Output:
#
# {"json_class":"Time","s":1700931678,"n":980650786}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/exception.rb 0000644 00000002321 15173517742 0015755 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Exception
# See #as_json.
def self.json_create(object)
result = new(object['m'])
result.set_backtrace object['b']
result
end
# Methods <tt>Exception#as_json</tt> and +Exception.json_create+ may be used
# to serialize and deserialize a \Exception object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Exception#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/exception'
# x = Exception.new('Foo').as_json # => {"json_class"=>"Exception", "m"=>"Foo", "b"=>nil}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Exception object:
#
# Exception.json_create(x) # => #<Exception: Foo>
#
def as_json(*)
{
JSON.create_id => self.class.name,
'm' => message,
'b' => backtrace,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/exception'
# puts Exception.new('Foo').to_json
#
# Output:
#
# {"json_class":"Exception","m":"Foo","b":null}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/struct.rb 0000644 00000002616 15173517742 0015312 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Struct
# See #as_json.
def self.json_create(object)
new(*object['v'])
end
# Methods <tt>Struct#as_json</tt> and +Struct.json_create+ may be used
# to serialize and deserialize a \Struct object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Struct#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/struct'
# Customer = Struct.new('Customer', :name, :address, :zip)
# x = Struct::Customer.new.as_json
# # => {"json_class"=>"Struct::Customer", "v"=>[nil, nil, nil]}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Struct object:
#
# Struct::Customer.json_create(x)
# # => #<struct Struct::Customer name=nil, address=nil, zip=nil>
#
def as_json(*)
klass = self.class.name
klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
{
JSON.create_id => klass,
'v' => values,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/struct'
# Customer = Struct.new('Customer', :name, :address, :zip)
# puts Struct::Customer.new.to_json
#
# Output:
#
# {"json_class":"Struct","t":{'name':'Rowdy',"age":null}}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/regexp.rb 0000644 00000002131 15173517742 0015250 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Regexp
# See #as_json.
def self.json_create(object)
new(object['s'], object['o'])
end
# Methods <tt>Regexp#as_json</tt> and +Regexp.json_create+ may be used
# to serialize and deserialize a \Regexp object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Regexp#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/regexp'
# x = /foo/.as_json
# # => {"json_class"=>"Regexp", "o"=>0, "s"=>"foo"}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Regexp object:
#
# Regexp.json_create(x) # => /foo/
#
def as_json(*)
{
JSON.create_id => self.class.name,
'o' => options,
's' => source,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/regexp'
# puts /foo/.to_json
#
# Output:
#
# {"json_class":"Regexp","o":0,"s":"foo"}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/range.rb 0000644 00000002673 15173517742 0015065 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Range
# See #as_json.
def self.json_create(object)
new(*object['a'])
end
# Methods <tt>Range#as_json</tt> and +Range.json_create+ may be used
# to serialize and deserialize a \Range object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Range#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/range'
# x = (1..4).as_json # => {"json_class"=>"Range", "a"=>[1, 4, false]}
# y = (1...4).as_json # => {"json_class"=>"Range", "a"=>[1, 4, true]}
# z = ('a'..'d').as_json # => {"json_class"=>"Range", "a"=>["a", "d", false]}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Range object:
#
# Range.json_create(x) # => 1..4
# Range.json_create(y) # => 1...4
# Range.json_create(z) # => "a".."d"
#
def as_json(*)
{
JSON.create_id => self.class.name,
'a' => [ first, last, exclude_end? ]
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/range'
# puts (1..4).to_json
# puts (1...4).to_json
# puts ('a'..'d').to_json
#
# Output:
#
# {"json_class":"Range","a":[1,4,false]}
# {"json_class":"Range","a":[1,4,true]}
# {"json_class":"Range","a":["a","d",false]}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/rational.rb 0000644 00000002212 15173517742 0015567 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Rational
# See #as_json.
def self.json_create(object)
Rational(object['n'], object['d'])
end
# Methods <tt>Rational#as_json</tt> and +Rational.json_create+ may be used
# to serialize and deserialize a \Rational object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Rational#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/rational'
# x = Rational(2, 3).as_json
# # => {"json_class"=>"Rational", "n"=>2, "d"=>3}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Rational object:
#
# Rational.json_create(x)
# # => (2/3)
#
def as_json(*)
{
JSON.create_id => self.class.name,
'n' => numerator,
'd' => denominator,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/rational'
# puts Rational(2, 3).to_json
#
# Output:
#
# {"json_class":"Rational","n":2,"d":3}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/set.rb 0000644 00000002130 15173517742 0014550 0 ustar 00 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
defined?(::Set) or require 'set'
class Set
# See #as_json.
def self.json_create(object)
new object['a']
end
# Methods <tt>Set#as_json</tt> and +Set.json_create+ may be used
# to serialize and deserialize a \Set object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Set#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/set'
# x = Set.new(%w/foo bar baz/).as_json
# # => {"json_class"=>"Set", "a"=>["foo", "bar", "baz"]}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Set object:
#
# Set.json_create(x) # => #<Set: {"foo", "bar", "baz"}>
#
def as_json(*)
{
JSON.create_id => self.class.name,
'a' => to_a,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/set'
# puts Set.new(%w/foo bar baz/).to_json
#
# Output:
#
# {"json_class":"Set","a":["foo","bar","baz"]}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/date_time.rb 0000644 00000003103 15173517742 0015711 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
require 'date'
class DateTime
# See #as_json.
def self.json_create(object)
args = object.values_at('y', 'm', 'd', 'H', 'M', 'S')
of_a, of_b = object['of'].split('/')
if of_b and of_b != '0'
args << Rational(of_a.to_i, of_b.to_i)
else
args << of_a
end
args << object['sg']
civil(*args)
end
alias start sg unless method_defined?(:start)
# Methods <tt>DateTime#as_json</tt> and +DateTime.json_create+ may be used
# to serialize and deserialize a \DateTime object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>DateTime#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/datetime'
# x = DateTime.now.as_json
# # => {"json_class"=>"DateTime", "y"=>2023, "m"=>11, "d"=>21, "sg"=>2299161.0}
#
# \Method +JSON.create+ deserializes such a hash, returning a \DateTime object:
#
# DateTime.json_create(x) # BUG? Raises Date::Error "invalid date"
#
def as_json(*)
{
JSON.create_id => self.class.name,
'y' => year,
'm' => month,
'd' => day,
'H' => hour,
'M' => min,
'S' => sec,
'of' => offset.to_s,
'sg' => start,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/datetime'
# puts DateTime.now.to_json
#
# Output:
#
# {"json_class":"DateTime","y":2023,"m":11,"d":21,"sg":2299161.0}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/bigdecimal.rb 0000644 00000003210 15173517742 0016035 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
begin
require 'bigdecimal'
rescue LoadError
end
class BigDecimal
# See #as_json.
def self.json_create(object)
BigDecimal._load object['b']
end
# Methods <tt>BigDecimal#as_json</tt> and +BigDecimal.json_create+ may be used
# to serialize and deserialize a \BigDecimal object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>BigDecimal#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/bigdecimal'
# x = BigDecimal(2).as_json # => {"json_class"=>"BigDecimal", "b"=>"27:0.2e1"}
# y = BigDecimal(2.0, 4).as_json # => {"json_class"=>"BigDecimal", "b"=>"36:0.2e1"}
# z = BigDecimal(Complex(2, 0)).as_json # => {"json_class"=>"BigDecimal", "b"=>"27:0.2e1"}
#
# \Method +JSON.create+ deserializes such a hash, returning a \BigDecimal object:
#
# BigDecimal.json_create(x) # => 0.2e1
# BigDecimal.json_create(y) # => 0.2e1
# BigDecimal.json_create(z) # => 0.2e1
#
def as_json(*)
{
JSON.create_id => self.class.name,
'b' => _dump,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/bigdecimal'
# puts BigDecimal(2).to_json
# puts BigDecimal(2.0, 4).to_json
# puts BigDecimal(Complex(2, 0)).to_json
#
# Output:
#
# {"json_class":"BigDecimal","b":"27:0.2e1"}
# {"json_class":"BigDecimal","b":"36:0.2e1"}
# {"json_class":"BigDecimal","b":"27:0.2e1"}
#
def to_json(*args)
as_json.to_json(*args)
end
end if defined?(::BigDecimal)
share/gems/gems/json-2.7.2/lib/json/add/complex.rb 0000644 00000002462 15173517742 0015434 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
class Complex
# See #as_json.
def self.json_create(object)
Complex(object['r'], object['i'])
end
# Methods <tt>Complex#as_json</tt> and +Complex.json_create+ may be used
# to serialize and deserialize a \Complex object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Complex#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/complex'
# x = Complex(2).as_json # => {"json_class"=>"Complex", "r"=>2, "i"=>0}
# y = Complex(2.0, 4).as_json # => {"json_class"=>"Complex", "r"=>2.0, "i"=>4}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Complex object:
#
# Complex.json_create(x) # => (2+0i)
# Complex.json_create(y) # => (2.0+4i)
#
def as_json(*)
{
JSON.create_id => self.class.name,
'r' => real,
'i' => imag,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/complex'
# puts Complex(2).to_json
# puts Complex(2.0, 4).to_json
#
# Output:
#
# {"json_class":"Complex","r":2,"i":0}
# {"json_class":"Complex","r":2.0,"i":4}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/core.rb 0000644 00000000534 15173517742 0014713 0 ustar 00 #frozen_string_literal: false
# This file requires the implementations of ruby core's custom objects for
# serialisation/deserialisation.
require 'json/add/date'
require 'json/add/date_time'
require 'json/add/exception'
require 'json/add/range'
require 'json/add/regexp'
require 'json/add/struct'
require 'json/add/symbol'
require 'json/add/time'
share/gems/gems/json-2.7.2/lib/json/add/date.rb 0000644 00000002415 15173517742 0014700 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
require 'date'
class Date
# See #as_json.
def self.json_create(object)
civil(*object.values_at('y', 'm', 'd', 'sg'))
end
alias start sg unless method_defined?(:start)
# Methods <tt>Date#as_json</tt> and +Date.json_create+ may be used
# to serialize and deserialize a \Date object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>Date#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/date'
# x = Date.today.as_json
# # => {"json_class"=>"Date", "y"=>2023, "m"=>11, "d"=>21, "sg"=>2299161.0}
#
# \Method +JSON.create+ deserializes such a hash, returning a \Date object:
#
# Date.json_create(x)
# # => #<Date: 2023-11-21 ((2460270j,0s,0n),+0s,2299161j)>
#
def as_json(*)
{
JSON.create_id => self.class.name,
'y' => year,
'm' => month,
'd' => day,
'sg' => start,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/date'
# puts Date.today.to_json
#
# Output:
#
# {"json_class":"Date","y":2023,"m":11,"d":21,"sg":2299161.0}
#
def to_json(*args)
as_json.to_json(*args)
end
end
share/gems/gems/json-2.7.2/lib/json/add/ostruct.rb 0000644 00000002641 15173517742 0015467 0 ustar 00 #frozen_string_literal: false
unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
require 'json'
end
begin
require 'ostruct'
rescue LoadError
end
class OpenStruct
# See #as_json.
def self.json_create(object)
new(object['t'] || object[:t])
end
# Methods <tt>OpenStruct#as_json</tt> and +OpenStruct.json_create+ may be used
# to serialize and deserialize a \OpenStruct object;
# see Marshal[rdoc-ref:Marshal].
#
# \Method <tt>OpenStruct#as_json</tt> serializes +self+,
# returning a 2-element hash representing +self+:
#
# require 'json/add/ostruct'
# x = OpenStruct.new('name' => 'Rowdy', :age => nil).as_json
# # => {"json_class"=>"OpenStruct", "t"=>{:name=>'Rowdy', :age=>nil}}
#
# \Method +JSON.create+ deserializes such a hash, returning a \OpenStruct object:
#
# OpenStruct.json_create(x)
# # => #<OpenStruct name='Rowdy', age=nil>
#
def as_json(*)
klass = self.class.name
klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
{
JSON.create_id => klass,
't' => table,
}
end
# Returns a JSON string representing +self+:
#
# require 'json/add/ostruct'
# puts OpenStruct.new('name' => 'Rowdy', :age => nil).to_json
#
# Output:
#
# {"json_class":"OpenStruct","t":{'name':'Rowdy',"age":null}}
#
def to_json(*args)
as_json.to_json(*args)
end
end if defined?(::OpenStruct)
share/gems/gems/rack-3.0.8/CHANGELOG.md 0000644 00000143361 15173517742 0012755 0 ustar 00 # Changelog
All notable changes to this project will be documented in this file. For info on how to format all future additions to this file please reference [Keep A Changelog](https://keepachangelog.com/en/1.0.0/).
## [3.0.7] - 2023-03-16
- Make query parameters without `=` have `nil` values. ([#2059](https://github.com/rack/rack/pull/2059), [@jeremyevans])
## [3.0.6.1] - 2023-03-13
- [CVE-2023-27539] Avoid ReDoS in header parsing
## [3.0.6] - 2023-03-13
- Add `QueryParser#missing_value` for handling missing values + tests. ([#2052](https://github.com/rack/rack/pull/2052), [@ioquatix])
## [3.0.5] - 2023-03-13
- Split form/query parsing into two steps. ([#2038](https://github.com/rack/rack/pull/2038), [@matthewd](https://github.com/matthewd))
## [3.0.4.1] - 2023-03-02
- [CVE-2023-27530] Introduce multipart_total_part_limit to limit total parts
## [3.0.4.1] - 2023-01-17
- [CVE-2022-44571] Fix ReDoS vulnerability in multipart parser
- [CVE-2022-44570] Fix ReDoS in Rack::Utils.get_byte_ranges
- [CVE-2022-44572] Forbid control characters in attributes (also ReDoS)
## [3.0.4] - 2023-01-17
- `Rack::Request#POST` should consistently raise errors. Cache errors that occur when invoking `Rack::Request#POST` so they can be raised again later. ([#2010](https://github.com/rack/rack/pull/2010), [@ioquatix])
- Fix `Rack::Lint` error message for `HTTP_CONTENT_TYPE` and `HTTP_CONTENT_LENGTH`. ([#2007](https://github.com/rack/rack/pull/2007), [@byroot](https://github.com/byroot))
- Extend `Rack::MethodOverride` to handle `QueryParser::ParamsTooDeepError` error. ([#2006](https://github.com/rack/rack/pull/2006), [@byroot](https://github.com/byroot))
## [3.0.3] - 2022-12-27
### Fixed
- `Rack::URLMap` uses non-deprecated form of `Regexp.new`. ([#1998](https://github.com/rack/rack/pull/1998), [@weizheheng](https://github.com/weizheheng))
## [3.0.2] - 2022-12-05
### Fixed
- `Utils.build_nested_query` URL-encodes nested field names including the square brackets.
- Allow `Rack::Response` to pass through streaming bodies. ([#1993](https://github.com/rack/rack/pull/1993), [@ioquatix])
## [3.0.1] - 2022-11-18
### Fixed
- `MethodOverride` does not look for an override if a request does not include form/parseable data.
- `Rack::Lint::Wrapper` correctly handles `respond_to?` with `to_ary`, `each`, `call` and `to_path`, forwarding to the body. ([#1981](https://github.com/rack/rack/pull/1981), [@ioquatix])
## [3.0.0] - 2022-09-06
- No changes
## [3.0.0.rc1] - 2022-09-04
### SPEC Changes
- Stream argument must implement `<<` https://github.com/rack/rack/pull/1959
- `close` may be called on `rack.input` https://github.com/rack/rack/pull/1956
- `rack.response_finished` may be used for executing code after the response has been finished https://github.com/rack/rack/pull/1952
## [3.0.0.beta1] - 2022-08-08
### Security
- Do not use semicolon as GET parameter separator. ([#1733](https://github.com/rack/rack/pull/1733), [@jeremyevans])
### SPEC Changes
- Response array must now be non-frozen.
- Response `status` must now be an integer greater than or equal to 100.
- Response `headers` must now be an unfrozen hash.
- Response header keys can no longer include uppercase characters.
- Response header values can be an `Array` to handle multiple values (and no longer supports `\n` encoded headers).
- Response body can now respond to `#call` (streaming body) instead of `#each` (enumerable body), for the equivalent of response hijacking in previous versions.
- Middleware must no longer call `#each` on the body, but they can call `#to_ary` on the body if it responds to `#to_ary`.
- `rack.input` is no longer required to be rewindable.
- `rack.multithread`/`rack.multiprocess`/`rack.run_once`/`rack.version` are no longer required environment keys.
- `SERVER_PROTOCOL` is now a required environment key, matching the HTTP protocol used in the request.
- `rack.hijack?` (partial hijack) and `rack.hijack` (full hijack) are now independently optional.
- `rack.hijack_io` has been removed completely.
- `rack.response_finished` is an optional environment key which contains an array of callable objects that must accept `#call(env, status, headers, error)` and are invoked after the response is finished (either successfully or unsuccessfully).
- It is okay to call `#close` on `rack.input` to indicate that you no longer need or care about the input.
- The stream argument supplied to the streaming body and hijack must support `#<<` for writing output.
### Removed
- Remove `rack.multithread`/`rack.multiprocess`/`rack.run_once`. These variables generally come too late to be useful. ([#1720](https://github.com/rack/rack/pull/1720), [@ioquatix], [@jeremyevans]))
- Remove deprecated Rack::Request::SCHEME_WHITELIST. ([@jeremyevans])
- Remove internal cookie deletion using pattern matching, there are very few practical cases where it would be useful and browsers handle it correctly without us doing anything special. ([#1844](https://github.com/rack/rack/pull/1844), [@ioquatix])
- Remove `rack.version` as it comes too late to be useful. ([#1938](https://github.com/rack/rack/pull/1938), [@ioquatix])
- Extract `rackup` command, `Rack::Server`, `Rack::Handler` and related code into a separate gem. ([#1937](https://github.com/rack/rack/pull/1937), [@ioquatix])
### Added
- `Rack::Headers` added to support lower-case header keys. ([@jeremyevans])
- `Rack::Utils#set_cookie_header` now supports `escape_key: false` to avoid key escaping. ([@jeremyevans])
- `Rack::RewindableInput` supports size. ([@ahorek](https://github.com/ahorek))
- `Rack::RewindableInput::Middleware` added for making `rack.input` rewindable. ([@jeremyevans])
- The RFC 7239 Forwarded header is now supported and considered by default when looking for information on forwarding, falling back to the X-Forwarded-* headers. `Rack::Request.forwarded_priority` accessor has been added for configuring the priority of which header to check. ([#1423](https://github.com/rack/rack/issues/1423), [@jeremyevans])
- Allow response headers to contain array of values. ([#1598](https://github.com/rack/rack/issues/1598), [@ioquatix])
- Support callable body for explicit streaming support and clarify streaming response body behaviour. ([#1745](https://github.com/rack/rack/pull/1745), [@ioquatix], [#1748](https://github.com/rack/rack/pull/1748), [@wjordan])
- Allow `Rack::Builder#run` to take a block instead of an argument. ([#1942](https://github.com/rack/rack/pull/1942), [@ioquatix])
- Add `rack.response_finished` to `Rack::Lint`. ([#1802](https://github.com/rack/rack/pull/1802), [@BlakeWilliams], [#1952](https://github.com/rack/rack/pull/1952), [@ioquatix])
- The stream argument must implement `#<<`. ([#1959](https://github.com/rack/rack/pull/1959), [@ioquatix])
### Changed
- BREAKING CHANGE: Require `status` to be an Integer. ([#1662](https://github.com/rack/rack/pull/1662), [@olleolleolle](https://github.com/olleolleolle))
- BREAKING CHANGE: Query parsing now treats parameters without `=` as having the empty string value instead of nil value, to conform to the URL spec. ([#1696](https://github.com/rack/rack/issues/1696), [@jeremyevans])
- Relax validations around `Rack::Request#host` and `Rack::Request#hostname`. ([#1606](https://github.com/rack/rack/issues/1606), [@pvande](https://github.com/pvande))
- Removed antiquated handlers: FCGI, LSWS, SCGI, Thin. ([#1658](https://github.com/rack/rack/pull/1658), [@ioquatix])
- Removed options from `Rack::Builder.parse_file` and `Rack::Builder.load_file`. ([#1663](https://github.com/rack/rack/pull/1663), [@ioquatix])
- `Rack::HTTP_VERSION` has been removed and the `HTTP_VERSION` env setting is no longer set in the CGI and Webrick handlers. ([#970](https://github.com/rack/rack/issues/970), [@jeremyevans])
- `Rack::Request#[]` and `#[]=` now warn even in non-verbose mode. ([#1277](https://github.com/rack/rack/issues/1277), [@jeremyevans])
- Decrease default allowed parameter recursion level from 100 to 32. ([#1640](https://github.com/rack/rack/issues/1640), [@jeremyevans])
- Attempting to parse a multipart response with an empty body now raises Rack::Multipart::EmptyContentError. ([#1603](https://github.com/rack/rack/issues/1603), [@jeremyevans])
- `Rack::Utils.secure_compare` uses OpenSSL's faster implementation if available. ([#1711](https://github.com/rack/rack/pull/1711), [@bdewater](https://github.com/bdewater))
- `Rack::Request#POST` now caches an empty hash if input content type is not parseable. ([#749](https://github.com/rack/rack/pull/749), [@jeremyevans])
- BREAKING CHANGE: Updated `trusted_proxy?` to match full 127.0.0.0/8 network. ([#1781](https://github.com/rack/rack/pull/1781), [@snbloch](https://github.com/snbloch))
- Explicitly deprecate `Rack::File` which was an alias for `Rack::Files`. ([#1811](https://github.com/rack/rack/pull/1720), [@ioquatix]).
- Moved `Rack::Session` into [separate gem](https://github.com/rack/rack-session). ([#1805](https://github.com/rack/rack/pull/1805), [@ioquatix])
- `rackup -D` option to daemonizes no longer changes the working directory to the root. ([#1813](https://github.com/rack/rack/pull/1813), [@jeremyevans])
- The `x-forwarded-proto` header is now considered before the `x-forwarded-scheme` header for determining the forwarded protocol. `Rack::Request.x_forwarded_proto_priority` accessor has been added for configuring the priority of which header to check. ([#1809](https://github.com/rack/rack/issues/1809), [@jeremyevans])
- `Rack::Request.forwarded_authority` (and methods that call it, such as `host`) now returns the last authority in the forwarded header, instead of the first, as earlier forwarded authorities can be forged by clients. This restores the Rack 2.1 behavior. ([#1829](https://github.com/rack/rack/issues/1809), [@jeremyevans])
- Use lower case cookie attributes when creating cookies, and fold cookie attributes to lower case when reading cookies (specifically impacting `secure` and `httponly` attributes). ([#1849](https://github.com/rack/rack/pull/1849), [@ioquatix])
- The response array must now be mutable (non-frozen) so middleware can modify it without allocating a new Array,therefore reducing object allocations. ([#1887](https://github.com/rack/rack/pull/1887), [#1927](https://github.com/rack/rack/pull/1927), [@amatsuda], [@ioquatix])
- `rack.hijack?` (partial hijack) and `rack.hijack` (full hijack) are now independently optional. `rack.hijack_io` is no longer required/specified. ([#1939](https://github.com/rack/rack/pull/1939), [@ioquatix])
- Allow calling close on `rack.input`. ([#1956](https://github.com/rack/rack/pull/1956), [@ioquatix])
### Fixed
- Make Rack::MockResponse handle non-hash headers. ([#1629](https://github.com/rack/rack/issues/1629), [@jeremyevans])
- TempfileReaper now deletes temp files if application raises an exception. ([#1679](https://github.com/rack/rack/issues/1679), [@jeremyevans])
- Handle cookies with values that end in '=' ([#1645](https://github.com/rack/rack/pull/1645), [@lukaso](https://github.com/lukaso))
- Make `Rack::NullLogger` respond to `#fatal!` [@jeremyevans])
- Fix multipart filename generation for filenames that contain spaces. Encode spaces as "%20" instead of "+" which will be decoded properly by the multipart parser. ([#1736](https://github.com/rack/rack/pull/1645), [@muirdm](https://github.com/muirdm))
- `Rack::Request#scheme` returns `ws` or `wss` when one of the `X-Forwarded-Scheme` / `X-Forwarded-Proto` headers is set to `ws` or `wss`, respectively. ([#1730](https://github.com/rack/rack/issues/1730), [@erwanst](https://github.com/erwanst))
## [2.2.4] - 2022-06-30
- Better support for lower case headers in `Rack::ETag` middleware. ([#1919](https://github.com/rack/rack/pull/1919), [@ioquatix](https://github.com/ioquatix))
- Use custom exception on params too deep error. ([#1838](https://github.com/rack/rack/pull/1838), [@simi](https://github.com/simi))
## [2.2.3.1] - 2022-05-27
- [CVE-2022-30123] Fix shell escaping issue in Common Logger
- [CVE-2022-30122] Restrict parsing of broken MIME attachments
## [2.2.3] - 2020-06-15
### Security
- [[CVE-2020-8184](https://nvd.nist.gov/vuln/detail/CVE-2020-8184)] Do not allow percent-encoded cookie name to override existing cookie names. BREAKING CHANGE: Accessing cookie names that require URL encoding with decoded name no longer works. ([@fletchto99](https://github.com/fletchto99))
## [2.2.2] - 2020-02-11
### Fixed
- Fix incorrect `Rack::Request#host` value. ([#1591](https://github.com/rack/rack/pull/1591), [@ioquatix])
- Revert `Rack::Handler::Thin` implementation. ([#1583](https://github.com/rack/rack/pull/1583), [@jeremyevans])
- Double assignment is still needed to prevent an "unused variable" warning. ([#1589](https://github.com/rack/rack/pull/1589), [@kamipo](https://github.com/kamipo))
- Fix to handle same_site option for session pool. ([#1587](https://github.com/rack/rack/pull/1587), [@kamipo](https://github.com/kamipo))
## [2.2.1] - 2020-02-09
### Fixed
- Rework `Rack::Request#ip` to handle empty `forwarded_for`. ([#1577](https://github.com/rack/rack/pull/1577), [@ioquatix])
## [2.2.0] - 2020-02-08
### SPEC Changes
- `rack.session` request environment entry must respond to `to_hash` and return unfrozen Hash. ([@jeremyevans])
- Request environment cannot be frozen. ([@jeremyevans])
- CGI values in the request environment with non-ASCII characters must use ASCII-8BIT encoding. ([@jeremyevans])
- Improve SPEC/lint relating to SERVER_NAME, SERVER_PORT and HTTP_HOST. ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix])
### Added
- `rackup` supports multiple `-r` options and will require all arguments. ([@jeremyevans])
- `Server` supports an array of paths to require for the `:require` option. ([@khotta](https://github.com/khotta))
- `Files` supports multipart range requests. ([@fatkodima](https://github.com/fatkodima))
- `Multipart::UploadedFile` supports an IO-like object instead of using the filesystem, using `:filename` and `:io` options. ([@jeremyevans])
- `Multipart::UploadedFile` supports keyword arguments `:path`, `:content_type`, and `:binary` in addition to positional arguments. ([@jeremyevans])
- `Static` supports a `:cascade` option for calling the app if there is no matching file. ([@jeremyevans])
- `Session::Abstract::SessionHash#dig`. ([@jeremyevans])
- `Response.[]` and `MockResponse.[]` for creating instances using status, headers, and body. ([@ioquatix])
- Convenient cache and content type methods for `Rack::Response`. ([#1555](https://github.com/rack/rack/pull/1555), [@ioquatix])
### Changed
- `Request#params` no longer rescues EOFError. ([@jeremyevans])
- `Directory` uses a streaming approach, significantly improving time to first byte for large directories. ([@jeremyevans])
- `Directory` no longer includes a Parent directory link in the root directory index. ([@jeremyevans])
- `QueryParser#parse_nested_query` uses original backtrace when reraising exception with new class. ([@jeremyevans])
- `ConditionalGet` follows RFC 7232 precedence if both If-None-Match and If-Modified-Since headers are provided. ([@jeremyevans])
- `.ru` files supports the `frozen-string-literal` magic comment. ([@eregon](https://github.com/eregon))
- Rely on autoload to load constants instead of requiring internal files, make sure to require 'rack' and not just 'rack/...'. ([@jeremyevans])
- BREAKING CHANGE: `Etag` will continue sending ETag even if the response should not be cached. Streaming no longer works without a workaround, see [#1619](https://github.com/rack/rack/issues/1619#issuecomment-848460528). ([@henm](https://github.com/henm))
- `Request#host_with_port` no longer includes a colon for a missing or empty port. ([@AlexWayfer](https://github.com/AlexWayfer))
- All handlers uses keywords arguments instead of an options hash argument. ([@ioquatix])
- `Files` handling of range requests no longer return a body that supports `to_path`, to ensure range requests are handled correctly. ([@jeremyevans])
- `Multipart::Generator` only includes `Content-Length` for files with paths, and `Content-Disposition` `filename` if the `UploadedFile` instance has one. ([@jeremyevans])
- `Request#ssl?` is true for the `wss` scheme (secure websockets). ([@jeremyevans])
- `Rack::HeaderHash` is memoized by default. ([#1549](https://github.com/rack/rack/pull/1549), [@ioquatix])
- `Rack::Directory` allow directory traversal inside root directory. ([#1417](https://github.com/rack/rack/pull/1417), [@ThomasSevestre](https://github.com/ThomasSevestre))
- Sort encodings by server preference. ([#1184](https://github.com/rack/rack/pull/1184), [@ioquatix], [@wjordan](https://github.com/wjordan))
- Rework host/hostname/authority implementation in `Rack::Request`. `#host` and `#host_with_port` have been changed to correctly return IPv6 addresses formatted with square brackets, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-3.2.2). ([#1561](https://github.com/rack/rack/pull/1561), [@ioquatix])
- `Rack::Builder` parsing options on first `#\` line is deprecated. ([#1574](https://github.com/rack/rack/pull/1574), [@ioquatix])
### Removed
- `Directory#path` as it was not used and always returned nil. ([@jeremyevans])
- `BodyProxy#each` as it was only needed to work around a bug in Ruby <1.9.3. ([@jeremyevans])
- `URLMap::INFINITY` and `URLMap::NEGATIVE_INFINITY`, in favor of `Float::INFINITY`. ([@ch1c0t](https://github.com/ch1c0t))
- Deprecation of `Rack::File`. It will be deprecated again in rack 2.2 or 3.0. ([@rafaelfranca](https://github.com/rafaelfranca))
- Support for Ruby 2.2 as it is well past EOL. ([@ioquatix])
- Remove `Rack::Files#response_body` as the implementation was broken. ([#1153](https://github.com/rack/rack/pull/1153), [@ioquatix])
- Remove `SERVER_ADDR` which was never part of the original SPEC. ([#1573](https://github.com/rack/rack/pull/1573), [@ioquatix])
### Fixed
- `Directory` correctly handles root paths containing glob metacharacters. ([@jeremyevans])
- `Cascade` uses a new response object for each call if initialized with no apps. ([@jeremyevans])
- `BodyProxy` correctly delegates keyword arguments to the body object on Ruby 2.7+. ([@jeremyevans])
- `BodyProxy#method` correctly handles methods delegated to the body object. ([@jeremyevans])
- `Request#host` and `Request#host_with_port` handle IPv6 addresses correctly. ([@AlexWayfer](https://github.com/AlexWayfer))
- `Lint` checks when response hijacking that `rack.hijack` is called with a valid object. ([@jeremyevans])
- `Response#write` correctly updates `Content-Length` if initialized with a body. ([@jeremyevans])
- `CommonLogger` includes `SCRIPT_NAME` when logging. ([@Erol](https://github.com/Erol))
- `Utils.parse_nested_query` correctly handles empty queries, using an empty instance of the params class instead of a hash. ([@jeremyevans])
- `Directory` correctly escapes paths in links. ([@yous](https://github.com/yous))
- `Request#delete_cookie` and related `Utils` methods handle `:domain` and `:path` options in same call. ([@jeremyevans])
- `Request#delete_cookie` and related `Utils` methods do an exact match on `:domain` and `:path` options. ([@jeremyevans])
- `Static` no longer adds headers when a gzipped file request has a 304 response. ([@chooh](https://github.com/chooh))
- `ContentLength` sets `Content-Length` response header even for bodies not responding to `to_ary`. ([@jeremyevans])
- Thin handler supports options passed directly to `Thin::Controllers::Controller`. ([@jeremyevans])
- WEBrick handler no longer ignores `:BindAddress` option. ([@jeremyevans])
- `ShowExceptions` handles invalid POST data. ([@jeremyevans])
- Basic authentication requires a password, even if the password is empty. ([@jeremyevans])
- `Lint` checks response is array with 3 elements, per SPEC. ([@jeremyevans])
- Support for using `:SSLEnable` option when using WEBrick handler. (Gregor Melhorn)
- Close response body after buffering it when buffering. ([@ioquatix])
- Only accept `;` as delimiter when parsing cookies. ([@mrageh](https://github.com/mrageh))
- `Utils::HeaderHash#clear` clears the name mapping as well. ([@raxoft](https://github.com/raxoft))
- Support for passing `nil` `Rack::Files.new`, which notably fixes Rails' current `ActiveStorage::FileServer` implementation. ([@ioquatix])
### Documentation
- CHANGELOG updates. ([@aupajo](https://github.com/aupajo))
- Added [CONTRIBUTING](CONTRIBUTING.md). ([@dblock](https://github.com/dblock))
## [2.0.9] - 2020-02-08
- Handle case where session id key is requested but missing ([@jeremyevans])
- Restore support for code relying on `SessionId#to_s`. ([@jeremyevans])
- Add support for `SameSite=None` cookie value. ([@hennikul](https://github.com/hennikul))
## [2.1.2] - 2020-01-27
- Fix multipart parser for some files to prevent denial of service ([@aiomaster](https://github.com/aiomaster))
- Fix `Rack::Builder#use` with keyword arguments ([@kamipo](https://github.com/kamipo))
- Skip deflating in Rack::Deflater if Content-Length is 0 ([@jeremyevans])
- Remove `SessionHash#transform_keys`, no longer needed ([@pavel](https://github.com/pavel))
- Add to_hash to wrap Hash and Session classes ([@oleh-demyanyuk](https://github.com/oleh-demyanyuk))
- Handle case where session id key is requested but missing ([@jeremyevans])
## [2.1.1] - 2020-01-12
- Remove `Rack::Chunked` from `Rack::Server` default middleware. ([#1475](https://github.com/rack/rack/pull/1475), [@ioquatix])
- Restore support for code relying on `SessionId#to_s`. ([@jeremyevans])
## [2.1.0] - 2020-01-10
### Added
- Add support for `SameSite=None` cookie value. ([@hennikul](https://github.com/hennikul))
- Add trailer headers. ([@eileencodes](https://github.com/eileencodes))
- Add MIME Types for video streaming. ([@styd](https://github.com/styd))
- Add MIME Type for WASM. ([@buildrtech](https://github.com/buildrtech))
- Add `Early Hints(103)` to status codes. ([@egtra](https://github.com/egtra))
- Add `Too Early(425)` to status codes. ([@y-yagi]((https://github.com/y-yagi)))
- Add `Bandwidth Limit Exceeded(509)` to status codes. ([@CJKinni](https://github.com/CJKinni))
- Add method for custom `ip_filter`. ([@svcastaneda](https://github.com/svcastaneda))
- Add boot-time profiling capabilities to `rackup`. ([@tenderlove](https://github.com/tenderlove))
- Add multi mapping support for `X-Accel-Mappings` header. ([@yoshuki](https://github.com/yoshuki))
- Add `sync: false` option to `Rack::Deflater`. (Eric Wong)
- Add `Builder#freeze_app` to freeze application and all middleware instances. ([@jeremyevans])
- Add API to extract cookies from `Rack::MockResponse`. ([@petercline](https://github.com/petercline))
### Changed
- Don't propagate nil values from middleware. ([@ioquatix])
- Lazily initialize the response body and only buffer it if required. ([@ioquatix])
- Fix deflater zlib buffer errors on empty body part. ([@felixbuenemann](https://github.com/felixbuenemann))
- Set `X-Accel-Redirect` to percent-encoded path. ([@diskkid](https://github.com/diskkid))
- Remove unnecessary buffer growing when parsing multipart. ([@tainoe](https://github.com/tainoe))
- Expand the root path in `Rack::Static` upon initialization. ([@rosenfeld](https://github.com/rosenfeld))
- Make `ShowExceptions` work with binary data. ([@axyjo](https://github.com/axyjo))
- Use buffer string when parsing multipart requests. ([@janko-m](https://github.com/janko-m))
- Support optional UTF-8 Byte Order Mark (BOM) in config.ru. ([@mikegee](https://github.com/mikegee))
- Handle `X-Forwarded-For` with optional port. ([@dpritchett](https://github.com/dpritchett))
- Use `Time#httpdate` format for Expires, as proposed by RFC 7231. ([@nanaya](https://github.com/nanaya))
- Make `Utils.status_code` raise an error when the status symbol is invalid instead of `500`. ([@adambutler](https://github.com/adambutler))
- Rename `Request::SCHEME_WHITELIST` to `Request::ALLOWED_SCHEMES`.
- Make `Multipart::Parser.get_filename` accept files with `+` in their name. ([@lucaskanashiro](https://github.com/lucaskanashiro))
- Add Falcon to the default handler fallbacks. ([@ioquatix])
- Update codebase to avoid string mutations in preparation for `frozen_string_literals`. ([@pat](https://github.com/pat))
- Change `MockRequest#env_for` to rely on the input optionally responding to `#size` instead of `#length`. ([@janko](https://github.com/janko))
- Rename `Rack::File` -> `Rack::Files` and add deprecation notice. ([@postmodern](https://github.com/postmodern))
- Prefer Base64 “strict encoding” for Base64 cookies. ([@ioquatix])
### Removed
- BREAKING CHANGE: Remove `to_ary` from Response ([@tenderlove](https://github.com/tenderlove))
- Deprecate `Rack::Session::Memcache` in favor of `Rack::Session::Dalli` from dalli gem ([@fatkodima](https://github.com/fatkodima))
### Fixed
- Eliminate warnings for Ruby 2.7. ([@osamtimizer](https://github.com/osamtimizer]))
### Documentation
- Update broken example in `Session::Abstract::ID` documentation. ([tonytonyjan](https://github.com/tonytonyjan))
- Add Padrino to the list of frameworks implementing Rack. ([@wikimatze](https://github.com/wikimatze))
- Remove Mongrel from the suggested server options in the help output. ([@tricknotes](https://github.com/tricknotes))
- Replace `HISTORY.md` and `NEWS.md` with `CHANGELOG.md`. ([@twitnithegirl](https://github.com/twitnithegirl))
- CHANGELOG updates. ([@drenmi](https://github.com/Drenmi), [@p8](https://github.com/p8))
## [2.0.8] - 2019-12-08
### Security
- [[CVE-2019-16782](https://nvd.nist.gov/vuln/detail/CVE-2019-16782)] Prevent timing attacks targeted at session ID lookup. BREAKING CHANGE: Session ID is now a SessionId instance instead of a String. ([@tenderlove](https://github.com/tenderlove), [@rafaelfranca](https://github.com/rafaelfranca))
## [1.6.12] - 2019-12-08
### Security
- [[CVE-2019-16782](https://nvd.nist.gov/vuln/detail/CVE-2019-16782)] Prevent timing attacks targeted at session ID lookup. BREAKING CHANGE: Session ID is now a SessionId instance instead of a String. ([@tenderlove](https://github.com/tenderlove), [@rafaelfranca](https://github.com/rafaelfranca))
## [2.0.7] - 2019-04-02
### Fixed
- Remove calls to `#eof?` on Rack input in `Multipart::Parser`, as this breaks the specification. ([@matthewd](https://github.com/matthewd))
- Preserve forwarded IP addresses for trusted proxy chains. ([@SamSaffron](https://github.com/SamSaffron))
## [2.0.6] - 2018-11-05
### Fixed
- [[CVE-2018-16470](https://nvd.nist.gov/vuln/detail/CVE-2018-16470)] Reduce buffer size of `Multipart::Parser` to avoid pathological parsing. ([@tenderlove](https://github.com/tenderlove))
- Fix a call to a non-existing method `#accepts_html` in the `ShowExceptions` middleware. ([@tomelm](https://github.com/tomelm))
- [[CVE-2018-16471](https://nvd.nist.gov/vuln/detail/CVE-2018-16471)] Whitelist HTTP and HTTPS schemes in `Request#scheme` to prevent a possible XSS attack. ([@PatrickTulskie](https://github.com/PatrickTulskie))
## [2.0.5] - 2018-04-23
### Fixed
- Record errors originating from invalid UTF8 in `MethodOverride` middleware instead of breaking. ([@mclark](https://github.com/mclark))
## [2.0.4] - 2018-01-31
### Changed
- Ensure the `Lock` middleware passes the original `env` object. ([@lugray](https://github.com/lugray))
- Improve performance of `Multipart::Parser` when uploading large files. ([@tompng](https://github.com/tompng))
- Increase buffer size in `Multipart::Parser` for better performance. ([@jkowens](https://github.com/jkowens))
- Reduce memory usage of `Multipart::Parser` when uploading large files. ([@tompng](https://github.com/tompng))
- Replace ConcurrentRuby dependency with native `Queue`. ([@devmchakan](https://github.com/devmchakan))
### Fixed
- Require the correct digest algorithm in the `ETag` middleware. ([@matthewd](https://github.com/matthewd))
### Documentation
- Update homepage links to use SSL. ([@hugoabonizio](https://github.com/hugoabonizio))
## [2.0.3] - 2017-05-15
### Changed
- Ensure `env` values are ASCII 8-bit encoded. ([@eileencodes](https://github.com/eileencodes))
### Fixed
- Prevent exceptions when a class with mixins inherits from `Session::Abstract::ID`. ([@jnraine](https://github.com/jnraine))
## [2.0.2] - 2017-05-08
### Added
- Allow `Session::Abstract::SessionHash#fetch` to accept a block with a default value. ([@yannvanhalewyn](https://github.com/yannvanhalewyn))
- Add `Builder#freeze_app` to freeze application and all middleware. ([@jeremyevans])
### Changed
- Freeze default session options to avoid accidental mutation. ([@kirs](https://github.com/kirs))
- Detect partial hijack without hash headers. ([@devmchakan](https://github.com/devmchakan))
- Update tests to use MiniTest 6 matchers. ([@tonytonyjan](https://github.com/tonytonyjan))
- Allow 205 Reset Content responses to set a Content-Length, as RFC 7231 proposes setting this to 0. ([@devmchakan](https://github.com/devmchakan))
### Fixed
- Handle `NULL` bytes in multipart filenames. ([@casperisfine](https://github.com/casperisfine))
- Remove warnings due to miscapitalized global. ([@ioquatix])
- Prevent exceptions caused by a race condition on multi-threaded servers. ([@sophiedeziel](https://github.com/sophiedeziel))
- Add RDoc as an explicit dependency for `doc` group. ([@tonytonyjan](https://github.com/tonytonyjan))
- Record errors originating from `Multipart::Parser` in the `MethodOverride` middleware instead of letting them bubble up. ([@carlzulauf](https://github.com/carlzulauf))
- Remove remaining use of removed `Utils#bytesize` method from the `File` middleware. ([@brauliomartinezlm](https://github.com/brauliomartinezlm))
### Removed
- Remove `deflate` encoding support to reduce caching overhead. ([@devmchakan](https://github.com/devmchakan))
### Documentation
- Update broken example in `Deflater` documentation. ([@mwpastore](https://github.com/mwpastore))
## [2.0.1] - 2016-06-30
### Changed
- Remove JSON as an explicit dependency. ([@mperham](https://github.com/mperham))
# History/News Archive
Items below this line are from the previously maintained HISTORY.md and NEWS.md files.
## [2.0.0.rc1] 2016-05-06
- Rack::Session::Abstract::ID is deprecated. Please change to use Rack::Session::Abstract::Persisted
## [2.0.0.alpha] 2015-12-04
- First-party "SameSite" cookies. Browsers omit SameSite cookies from third-party requests, closing the door on many CSRF attacks.
- Pass `same_site: true` (or `:strict`) to enable: response.set_cookie 'foo', value: 'bar', same_site: true or `same_site: :lax` to use Lax enforcement: response.set_cookie 'foo', value: 'bar', same_site: :lax
- Based on version 7 of the Same-site Cookies internet draft:
https://tools.ietf.org/html/draft-west-first-party-cookies-07
- Thanks to Ben Toews (@mastahyeti) and Bob Long (@bobjflong) for updating to drafts 5 and 7.
- Add `Rack::Events` middleware for adding event based middleware: middleware that does not care about the response body, but only cares about doing work at particular points in the request / response lifecycle.
- Add `Rack::Request#authority` to calculate the authority under which the response is being made (this will be handy for h2 pushes).
- Add `Rack::Response::Helpers#cache_control` and `cache_control=`. Use this for setting cache control headers on your response objects.
- Add `Rack::Response::Helpers#etag` and `etag=`. Use this for setting etag values on the response.
- Introduce `Rack::Response::Helpers#add_header` to add a value to a multi-valued response header. Implemented in terms of other `Response#*_header` methods, so it's available to any response-like class that includes the `Helpers` module.
- Add `Rack::Request#add_header` to match.
- `Rack::Session::Abstract::ID` IS DEPRECATED. Please switch to `Rack::Session::Abstract::Persisted`. `Rack::Session::Abstract::Persisted` uses a request object rather than the `env` hash.
- Pull `ENV` access inside the request object in to a module. This will help with legacy Request objects that are ENV based but don't want to inherit from Rack::Request
- Move most methods on the `Rack::Request` to a module `Rack::Request::Helpers` and use public API to get values from the request object. This enables users to mix `Rack::Request::Helpers` in to their own objects so they can implement `(get|set|fetch|each)_header` as they see fit (for example a proxy object).
- Files and directories with + in the name are served correctly. Rather than unescaping paths like a form, we unescape with a URI parser using `Rack::Utils.unescape_path`. Fixes #265
- Tempfiles are automatically closed in the case that there were too
many posted.
- Added methods for manipulating response headers that don't assume
they're stored as a Hash. Response-like classes may include the
Rack::Response::Helpers module if they define these methods:
- Rack::Response#has_header?
- Rack::Response#get_header
- Rack::Response#set_header
- Rack::Response#delete_header
- Introduce Util.get_byte_ranges that will parse the value of the HTTP_RANGE string passed to it without depending on the `env` hash. `byte_ranges` is deprecated in favor of this method.
- Change Session internals to use Request objects for looking up session information. This allows us to only allocate one request object when dealing with session objects (rather than doing it every time we need to manipulate cookies, etc).
- Add `Rack::Request#initialize_copy` so that the env is duped when the request gets duped.
- Added methods for manipulating request specific data. This includes
data set as CGI parameters, and just any arbitrary data the user wants
to associate with a particular request. New methods:
- Rack::Request#has_header?
- Rack::Request#get_header
- Rack::Request#fetch_header
- Rack::Request#each_header
- Rack::Request#set_header
- Rack::Request#delete_header
- lib/rack/utils.rb: add a method for constructing "delete" cookie
headers. This allows us to construct cookie headers without depending
on the side effects of mutating a hash.
- Prevent extremely deep parameters from being parsed. CVE-2015-3225
## [1.6.1] 2015-05-06
- Fix CVE-2014-9490, denial of service attack in OkJson
- Use a monotonic time for Rack::Runtime, if available
- RACK_MULTIPART_LIMIT changed to RACK_MULTIPART_PART_LIMIT (RACK_MULTIPART_LIMIT is deprecated and will be removed in 1.7.0)
## [1.5.3] 2015-05-06
- Fix CVE-2014-9490, denial of service attack in OkJson
- Backport bug fixes to 1.5 series
## [1.6.0] 2014-01-18
- Response#unauthorized? helper
- Deflater now accepts an options hash to control compression on a per-request level
- Builder#warmup method for app preloading
- Request#accept_language method to extract HTTP_ACCEPT_LANGUAGE
- Add quiet mode of rack server, rackup --quiet
- Update HTTP Status Codes to RFC 7231
- Less strict header name validation according to RFC 2616
- SPEC updated to specify headers conform to RFC7230 specification
- Etag correctly marks etags as weak
- Request#port supports multiple x-http-forwarded-proto values
- Utils#multipart_part_limit configures the maximum number of parts a request can contain
- Default host to localhost when in development mode
- Various bugfixes and performance improvements
## [1.5.2] 2013-02-07
- Fix CVE-2013-0263, timing attack against Rack::Session::Cookie
- Fix CVE-2013-0262, symlink path traversal in Rack::File
- Add various methods to Session for enhanced Rails compatibility
- Request#trusted_proxy? now only matches whole strings
- Add JSON cookie coder, to be default in Rack 1.6+ due to security concerns
- URLMap host matching in environments that don't set the Host header fixed
- Fix a race condition that could result in overwritten pidfiles
- Various documentation additions
## [1.4.5] 2013-02-07
- Fix CVE-2013-0263, timing attack against Rack::Session::Cookie
- Fix CVE-2013-0262, symlink path traversal in Rack::File
## [1.1.6, 1.2.8, 1.3.10] 2013-02-07
- Fix CVE-2013-0263, timing attack against Rack::Session::Cookie
## [1.5.1] 2013-01-28
- Rack::Lint check_hijack now conforms to other parts of SPEC
- Added hash-like methods to Abstract::ID::SessionHash for compatibility
- Various documentation corrections
## [1.5.0] 2013-01-21
- Introduced hijack SPEC, for before-response and after-response hijacking
- SessionHash is no longer a Hash subclass
- Rack::File cache_control parameter is removed, in place of headers options
- Rack::Auth::AbstractRequest#scheme now yields strings, not symbols
- Rack::Utils cookie functions now format expires in RFC 2822 format
- Rack::File now has a default mime type
- rackup -b 'run Rack::Files.new(".")', option provides command line configs
- Rack::Deflater will no longer double encode bodies
- Rack::Mime#match? provides convenience for Accept header matching
- Rack::Utils#q_values provides splitting for Accept headers
- Rack::Utils#best_q_match provides a helper for Accept headers
- Rack::Handler.pick provides convenience for finding available servers
- Puma added to the list of default servers (preferred over Webrick)
- Various middleware now correctly close body when replacing it
- Rack::Request#params is no longer persistent with only GET params
- Rack::Request#update_param and #delete_param provide persistent operations
- Rack::Request#trusted_proxy? now returns true for local unix sockets
- Rack::Response no longer forces Content-Types
- Rack::Sendfile provides local mapping configuration options
- Rack::Utils#rfc2109 provides old netscape style time output
- Updated HTTP status codes
- Ruby 1.8.6 likely no longer passes tests, and is no longer fully supported
## [1.4.4, 1.3.9, 1.2.7, 1.1.5] 2013-01-13
- [SEC] Rack::Auth::AbstractRequest no longer symbolizes arbitrary strings
- Fixed erroneous test case in the 1.3.x series
## [1.4.3] 2013-01-07
- Security: Prevent unbounded reads in large multipart boundaries
## [1.3.8] 2013-01-07
- Security: Prevent unbounded reads in large multipart boundaries
## [1.4.2] 2013-01-06
- Add warnings when users do not provide a session secret
- Fix parsing performance for unquoted filenames
- Updated URI backports
- Fix URI backport version matching, and silence constant warnings
- Correct parameter parsing with empty values
- Correct rackup '-I' flag, to allow multiple uses
- Correct rackup pidfile handling
- Report rackup line numbers correctly
- Fix request loops caused by non-stale nonces with time limits
- Fix reloader on Windows
- Prevent infinite recursions from Response#to_ary
- Various middleware better conforms to the body close specification
- Updated language for the body close specification
- Additional notes regarding ECMA escape compatibility issues
- Fix the parsing of multiple ranges in range headers
- Prevent errors from empty parameter keys
- Added PATCH verb to Rack::Request
- Various documentation updates
- Fix session merge semantics (fixes rack-test)
- Rack::Static :index can now handle multiple directories
- All tests now utilize Rack::Lint (special thanks to Lars Gierth)
- Rack::File cache_control parameter is now deprecated, and removed by 1.5
- Correct Rack::Directory script name escaping
- Rack::Static supports header rules for sophisticated configurations
- Multipart parsing now works without a Content-Length header
- New logos courtesy of Zachary Scott!
- Rack::BodyProxy now explicitly defines #each, useful for C extensions
- Cookies that are not URI escaped no longer cause exceptions
## [1.3.7] 2013-01-06
- Add warnings when users do not provide a session secret
- Fix parsing performance for unquoted filenames
- Updated URI backports
- Fix URI backport version matching, and silence constant warnings
- Correct parameter parsing with empty values
- Correct rackup '-I' flag, to allow multiple uses
- Correct rackup pidfile handling
- Report rackup line numbers correctly
- Fix request loops caused by non-stale nonces with time limits
- Fix reloader on Windows
- Prevent infinite recursions from Response#to_ary
- Various middleware better conforms to the body close specification
- Updated language for the body close specification
- Additional notes regarding ECMA escape compatibility issues
- Fix the parsing of multiple ranges in range headers
## [1.2.6] 2013-01-06
- Add warnings when users do not provide a session secret
- Fix parsing performance for unquoted filenames
## [1.1.4] 2013-01-06
- Add warnings when users do not provide a session secret
## [1.4.1] 2012-01-22
- Alter the keyspace limit calculations to reduce issues with nested params
- Add a workaround for multipart parsing where files contain unescaped "%"
- Added Rack::Response::Helpers#method_not_allowed? (code 405)
- Rack::File now returns 404 for illegal directory traversals
- Rack::File now returns 405 for illegal methods (non HEAD/GET)
- Rack::Cascade now catches 405 by default, as well as 404
- Cookies missing '--' no longer cause an exception to be raised
- Various style changes and documentation spelling errors
- Rack::BodyProxy always ensures to execute its block
- Additional test coverage around cookies and secrets
- Rack::Session::Cookie can now be supplied either secret or old_secret
- Tests are no longer dependent on set order
- Rack::Static no longer defaults to serving index files
- Rack.release was fixed
## [1.4.0] 2011-12-28
- Ruby 1.8.6 support has officially been dropped. Not all tests pass.
- Raise sane error messages for broken config.ru
- Allow combining run and map in a config.ru
- Rack::ContentType will not set Content-Type for responses without a body
- Status code 205 does not send a response body
- Rack::Response::Helpers will not rely on instance variables
- Rack::Utils.build_query no longer outputs '=' for nil query values
- Various mime types added
- Rack::MockRequest now supports HEAD
- Rack::Directory now supports files that contain RFC3986 reserved chars
- Rack::File now only supports GET and HEAD requests
- Rack::Server#start now passes the block to Rack::Handler::<h>#run
- Rack::Static now supports an index option
- Added the Teapot status code
- rackup now defaults to Thin instead of Mongrel (if installed)
- Support added for HTTP_X_FORWARDED_SCHEME
- Numerous bug fixes, including many fixes for new and alternate rubies
## [1.1.3] 2011-12-28
- Security fix. http://www.ocert.org/advisories/ocert-2011-003.html
Further information here: http://jruby.org/2011/12/27/jruby-1-6-5-1
## [1.3.5] 2011-10-17
- Fix annoying warnings caused by the backport in 1.3.4
## [1.3.4] 2011-10-01
- Backport security fix from 1.9.3, also fixes some roundtrip issues in URI
- Small documentation update
- Fix an issue where BodyProxy could cause an infinite recursion
- Add some supporting files for travis-ci
## [1.2.4] 2011-09-16
- Fix a bug with MRI regex engine to prevent XSS by malformed unicode
## [1.3.3] 2011-09-16
- Fix bug with broken query parameters in Rack::ShowExceptions
- Rack::Request#cookies no longer swallows exceptions on broken input
- Prevents XSS attacks enabled by bug in Ruby 1.8's regexp engine
- Rack::ConditionalGet handles broken If-Modified-Since helpers
## [1.3.2] 2011-07-16
- Fix for Rails and rack-test, Rack::Utils#escape calls to_s
## [1.3.1] 2011-07-13
- Fix 1.9.1 support
- Fix JRuby support
- Properly handle $KCODE in Rack::Utils.escape
- Make method_missing/respond_to behavior consistent for Rack::Lock,
Rack::Auth::Digest::Request and Rack::Multipart::UploadedFile
- Reenable passing rack.session to session middleware
- Rack::CommonLogger handles streaming responses correctly
- Rack::MockResponse calls close on the body object
- Fix a DOS vector from MRI stdlib backport
## [1.2.3] 2011-05-22
- Pulled in relevant bug fixes from 1.3
- Fixed 1.8.6 support
## [1.3.0] 2011-05-22
- Various performance optimizations
- Various multipart fixes
- Various multipart refactors
- Infinite loop fix for multipart
- Test coverage for Rack::Server returns
- Allow files with '..', but not path components that are '..'
- rackup accepts handler-specific options on the command line
- Request#params no longer merges POST into GET (but returns the same)
- Use URI.encode_www_form_component instead. Use core methods for escaping.
- Allow multi-line comments in the config file
- Bug L#94 reported by Nikolai Lugovoi, query parameter unescaping.
- Rack::Response now deletes Content-Length when appropriate
- Rack::Deflater now supports streaming
- Improved Rack::Handler loading and searching
- Support for the PATCH verb
- env['rack.session.options'] now contains session options
- Cookies respect renew
- Session middleware uses SecureRandom.hex
## [1.2.2, 1.1.2] 2011-03-13
- Security fix in Rack::Auth::Digest::MD5: when authenticator
returned nil, permission was granted on empty password.
## [1.2.1] 2010-06-15
- Make CGI handler rewindable
- Rename spec/ to test/ to not conflict with SPEC on lesser
operating systems
## [1.2.0] 2010-06-13
- Removed Camping adapter: Camping 2.0 supports Rack as-is
- Removed parsing of quoted values
- Add Request.trace? and Request.options?
- Add mime-type for .webm and .htc
- Fix HTTP_X_FORWARDED_FOR
- Various multipart fixes
- Switch test suite to bacon
## [1.1.0] 2010-01-03
- Moved Auth::OpenID to rack-contrib.
- SPEC change that relaxes Lint slightly to allow subclasses of the
required types
- SPEC change to document rack.input binary mode in greater detail
- SPEC define optional rack.logger specification
- File servers support X-Cascade header
- Imported Config middleware
- Imported ETag middleware
- Imported Runtime middleware
- Imported Sendfile middleware
- New Logger and NullLogger middlewares
- Added mime type for .ogv and .manifest.
- Don't squeeze PATH_INFO slashes
- Use Content-Type to determine POST params parsing
- Update Rack::Utils::HTTP_STATUS_CODES hash
- Add status code lookup utility
- Response should call #to_i on the status
- Add Request#user_agent
- Request#host knows about forwarded host
- Return an empty string for Request#host if HTTP_HOST and
SERVER_NAME are both missing
- Allow MockRequest to accept hash params
- Optimizations to HeaderHash
- Refactored rackup into Rack::Server
- Added Utils.build_nested_query to complement Utils.parse_nested_query
- Added Utils::Multipart.build_multipart to complement
Utils::Multipart.parse_multipart
- Extracted set and delete cookie helpers into Utils so they can be
used outside Response
- Extract parse_query and parse_multipart in Request so subclasses
can change their behavior
- Enforce binary encoding in RewindableInput
- Set correct external_encoding for handlers that don't use RewindableInput
## [1.0.1] 2009-10-18
- Bump remainder of rack.versions.
- Support the pure Ruby FCGI implementation.
- Fix for form names containing "=": split first then unescape components
- Fixes the handling of the filename parameter with semicolons in names.
- Add anchor to nested params parsing regexp to prevent stack overflows
- Use more compatible gzip write api instead of "<<".
- Make sure that Reloader doesn't break when executed via ruby -e
- Make sure WEBrick respects the :Host option
- Many Ruby 1.9 fixes.
## [1.0.0] 2009-04-25
- SPEC change: Rack::VERSION has been pushed to [1,0].
- SPEC change: header values must be Strings now, split on "\n".
- SPEC change: Content-Length can be missing, in this case chunked transfer
encoding is used.
- SPEC change: rack.input must be rewindable and support reading into
a buffer, wrap with Rack::RewindableInput if it isn't.
- SPEC change: rack.session is now specified.
- SPEC change: Bodies can now additionally respond to #to_path with
a filename to be served.
- NOTE: String bodies break in 1.9, use an Array consisting of a
single String instead.
- New middleware Rack::Lock.
- New middleware Rack::ContentType.
- Rack::Reloader has been rewritten.
- Major update to Rack::Auth::OpenID.
- Support for nested parameter parsing in Rack::Response.
- Support for redirects in Rack::Response.
- HttpOnly cookie support in Rack::Response.
- The Rakefile has been rewritten.
- Many bugfixes and small improvements.
## [0.9.1] 2009-01-09
- Fix directory traversal exploits in Rack::File and Rack::Directory.
## [0.9] 2009-01-06
- Rack is now managed by the Rack Core Team.
- Rack::Lint is stricter and follows the HTTP RFCs more closely.
- Added ConditionalGet middleware.
- Added ContentLength middleware.
- Added Deflater middleware.
- Added Head middleware.
- Added MethodOverride middleware.
- Rack::Mime now provides popular MIME-types and their extension.
- Mongrel Header now streams.
- Added Thin handler.
- Official support for swiftiplied Mongrel.
- Secure cookies.
- Made HeaderHash case-preserving.
- Many bugfixes and small improvements.
## [0.4] 2008-08-21
- New middleware, Rack::Deflater, by Christoffer Sawicki.
- OpenID authentication now needs ruby-openid 2.
- New Memcache sessions, by blink.
- Explicit EventedMongrel handler, by Joshua Peek <josh@joshpeek.com>
- Rack::Reloader is not loaded in rackup development mode.
- rackup can daemonize with -D.
- Many bugfixes, especially for pool sessions, URLMap, thread safety
and tempfile handling.
- Improved tests.
- Rack moved to Git.
## [0.3] 2008-02-26
- LiteSpeed handler, by Adrian Madrid.
- SCGI handler, by Jeremy Evans.
- Pool sessions, by blink.
- OpenID authentication, by blink.
- :Port and :File options for opening FastCGI sockets, by blink.
- Last-Modified HTTP header for Rack::File, by blink.
- Rack::Builder#use now accepts blocks, by Corey Jewett.
(See example/protectedlobster.ru)
- HTTP status 201 can contain a Content-Type and a body now.
- Many bugfixes, especially related to Cookie handling.
## [0.2] 2007-05-16
- HTTP Basic authentication.
- Cookie Sessions.
- Static file handler.
- Improved Rack::Request.
- Improved Rack::Response.
- Added Rack::ShowStatus, for better default error messages.
- Bug fixes in the Camping adapter.
- Removed Rails adapter, was too alpha.
## [0.1] 2007-03-03
[@ioquatix]: https://github.com/ioquatix "Samuel Williams"
[@jeremyevans]: https://github.com/jeremyevans "Jeremy Evans"
[@amatsuda]: https://github.com/amatsuda "Akira Matsuda"
[@wjordan]: https://github.com/wjordan "Will Jordan"
[@BlakeWilliams]: https://github.com/BlakeWilliams "Blake Williams"
share/gems/gems/rack-3.0.8/README.md 0000644 00000026212 15173517742 0012416 0 ustar 00 # 
> **_NOTE:_** Rack v3.0.0 was recently released. Please check the [Upgrade
> Guide](UPGRADE-GUIDE.md) for more details about migrating your existing
> servers, middlewares and applications. For detailed information on specific
> changes, check the [Change Log](CHANGELOG.md).
Rack provides a minimal, modular, and adaptable interface for developing web
applications in Ruby. By wrapping HTTP requests and responses in the simplest
way possible, it unifies and distills the bridge between web servers, web
frameworks, and web application into a single method call.
The exact details of this are described in the [Rack Specification], which all
Rack applications should conform to.
## Installation
Add the rack gem to your application bundle, or follow the instructions provided
by a [supported web framework](#supported-web-frameworks):
```bash
# Install it generally:
$ gem install rack --pre
# or, add it to your current application gemfile:
$ bundle add rack --version 3.0.0
```
If you need features from `Rack::Session` or `bin/rackup` please add those gems separately.
```bash
$ gem install rack-session rackup
```
## Usage
Create a file called `config.ru` with the following contents:
```ruby
run do |env|
[200, {}, ["Hello World"]]
end
```
Run this using the rackup gem or another [supported web
server](#supported-web-servers).
```bash
$ gem install rackup
$ rackup
$ curl http://localhost:9292
Hello World
```
## Supported web servers
Rack is supported by a wide range of servers, including:
* [Agoo](https://github.com/ohler55/agoo)
* [Falcon](https://github.com/socketry/falcon) **(Rack 3 Compatible)**
* [Iodine](https://github.com/boazsegev/iodine)
* [NGINX Unit](https://unit.nginx.org/)
* [Phusion Passenger](https://www.phusionpassenger.com/) (which is mod_rack for
Apache and for nginx)
* [Puma](https://puma.io/)
* [Thin](https://github.com/macournoyer/thin)
* [Unicorn](https://yhbt.net/unicorn/)
* [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/)
* [Lamby](https://lamby.custominktech.com) (for AWS Lambda)
You will need to consult the server documentation to find out what features and
limitations they may have. In general, any valid Rack app will run the same on
all these servers, without changing anything.
### Rackup
Rack provides a separate gem, [rackup](https://github.com/rack/rackup) which is
a generic interface for running a Rack application on supported servers, which
include `WEBRick`, `Puma`, `Falcon` and others.
## Supported web frameworks
These frameworks and many others support the [Rack Specification]:
* [Camping](https://github.com/camping/camping)
* [Hanami](https://hanamirb.org/)
* [Padrino](https://padrinorb.com/)
* [Roda](https://github.com/jeremyevans/roda) **(Rack 3 Compatible)**
* [Ruby on Rails](https://rubyonrails.org/)
* [Sinatra](https://sinatrarb.com/)
* [Utopia](https://github.com/socketry/utopia) **(Rack 3 Compatible)**
* [WABuR](https://github.com/ohler55/wabur)
### Older (possibly unsupported) web frameworks
* [Ramaze](http://ramaze.net/)
* [Rum](https://github.com/leahneukirchen/rum)
## Available middleware shipped with Rack
Between the server and the framework, Rack can be customized to your
applications needs using middleware. Rack itself ships with the following
middleware:
* `Rack::CommonLogger` for creating Apache-style logfiles.
* `Rack::ConditionalGet` for returning [Not
Modified](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304)
responses when the response has not changed.
* `Rack::Config` for modifying the environment before processing the request.
* `Rack::ContentLength` for setting a `content-length` header based on body
size.
* `Rack::ContentType` for setting a default `content-type` header for responses.
* `Rack::Deflater` for compressing responses with gzip.
* `Rack::ETag` for setting `etag` header on bodies that can be buffered.
* `Rack::Events` for providing easy hooks when a request is received and when
the response is sent.
* `Rack::Files` for serving static files.
* `Rack::Head` for returning an empty body for HEAD requests.
* `Rack::Lint` for checking conformance to the [Rack Specification].
* `Rack::Lock` for serializing requests using a mutex.
* `Rack::Logger` for setting a logger to handle logging errors.
* `Rack::MethodOverride` for modifying the request method based on a submitted
parameter.
* `Rack::Recursive` for including data from other paths in the application, and
for performing internal redirects.
* `Rack::Reloader` for reloading files if they have been modified.
* `Rack::Runtime` for including a response header with the time taken to process
the request.
* `Rack::Sendfile` for working with web servers that can use optimized file
serving for file system paths.
* `Rack::ShowException` for catching unhandled exceptions and presenting them in
a nice and helpful way with clickable backtrace.
* `Rack::ShowStatus` for using nice error pages for empty client error
responses.
* `Rack::Static` for more configurable serving of static files.
* `Rack::TempfileReaper` for removing temporary files creating during a request.
All these components use the same interface, which is described in detail in the
[Rack Specification]. These optional components can be used in any way you wish.
### Convenience interfaces
If you want to develop outside of existing frameworks, implement your own ones,
or develop middleware, Rack provides many helpers to create Rack applications
quickly and without doing the same web stuff all over:
* `Rack::Request` which also provides query string parsing and multipart
handling.
* `Rack::Response` for convenient generation of HTTP replies and cookie
handling.
* `Rack::MockRequest` and `Rack::MockResponse` for efficient and quick testing
of Rack application without real HTTP round-trips.
* `Rack::Cascade` for trying additional Rack applications if an application
returns a not found or method not supported response.
* `Rack::Directory` for serving files under a given directory, with directory
indexes.
* `Rack::MediaType` for parsing content-type headers.
* `Rack::Mime` for determining content-type based on file extension.
* `Rack::RewindableInput` for making any IO object rewindable, using a temporary
file buffer.
* `Rack::URLMap` to route to multiple applications inside the same process.
## Configuration
Rack exposes several configuration parameters to control various features of the
implementation.
### `param_depth_limit`
```ruby
Rack::Utils.param_depth_limit = 32 # default
```
The maximum amount of nesting allowed in parameters. For example, if set to 3,
this query string would be allowed:
```
?a[b][c]=d
```
but this query string would not be allowed:
```
?a[b][c][d]=e
```
Limiting the depth prevents a possible stack overflow when parsing parameters.
### `multipart_file_limit`
```ruby
Rack::Utils.multipart_file_limit = 128 # default
```
The maximum number of parts with a filename a request can contain. Accepting
too many parts can lead to the server running out of file handles.
The default is 128, which means that a single request can't upload more than 128
files at once. Set to 0 for no limit.
Can also be set via the `RACK_MULTIPART_FILE_LIMIT` environment variable.
(This is also aliased as `multipart_part_limit` and `RACK_MULTIPART_PART_LIMIT` for compatibility)
### `multipart_total_part_limit`
The maximum total number of parts a request can contain of any type, including
both file and non-file form fields.
The default is 4096, which means that a single request can't contain more than
4096 parts.
Set to 0 for no limit.
Can also be set via the `RACK_MULTIPART_TOTAL_PART_LIMIT` environment variable.
## Changelog
See [CHANGELOG.md](CHANGELOG.md).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for specific details about how to make a
contribution to Rack.
Please post bugs, suggestions and patches to [GitHub
Issues](https://github.com/rack/rack/issues).
Please check our [Security Policy](https://github.com/rack/rack/security/policy)
for responsible disclosure and security bug reporting process. Due to wide usage
of the library, it is strongly preferred that we manage timing in order to
provide viable patches at the time of disclosure. Your assistance in this matter
is greatly appreciated.
## See Also
### `rack-contrib`
The plethora of useful middleware created the need for a project that collects
fresh Rack middleware. `rack-contrib` includes a variety of add-on components
for Rack and it is easy to contribute new modules.
* https://github.com/rack/rack-contrib
### `rack-session`
Provides convenient session management for Rack.
* https://github.com/rack/rack-session
## Thanks
The Rack Core Team, consisting of
* Aaron Patterson [tenderlove](https://github.com/tenderlove)
* Samuel Williams [ioquatix](https://github.com/ioquatix)
* Jeremy Evans [jeremyevans](https://github.com/jeremyevans)
* Eileen Uchitelle [eileencodes](https://github.com/eileencodes)
* Matthew Draper [matthewd](https://github.com/matthewd)
* Rafael França [rafaelfranca](https://github.com/rafaelfranca)
and the Rack Alumni
* Ryan Tomayko [rtomayko](https://github.com/rtomayko)
* Scytrin dai Kinthra [scytrin](https://github.com/scytrin)
* Leah Neukirchen [leahneukirchen](https://github.com/leahneukirchen)
* James Tucker [raggi](https://github.com/raggi)
* Josh Peek [josh](https://github.com/josh)
* José Valim [josevalim](https://github.com/josevalim)
* Michael Fellinger [manveru](https://github.com/manveru)
* Santiago Pastorino [spastorino](https://github.com/spastorino)
* Konstantin Haase [rkh](https://github.com/rkh)
would like to thank:
* Adrian Madrid, for the LiteSpeed handler.
* Christoffer Sawicki, for the first Rails adapter and `Rack::Deflater`.
* Tim Fletcher, for the HTTP authentication code.
* Luc Heinrich for the Cookie sessions, the static file handler and bugfixes.
* Armin Ronacher, for the logo and racktools.
* Alex Beregszaszi, Alexander Kahn, Anil Wadghule, Aredridel, Ben Alpert, Dan
Kubb, Daniel Roethlisberger, Matt Todd, Tom Robinson, Phil Hagelberg, S. Brent
Faulkner, Bosko Milekic, Daniel Rodríguez Troitiño, Genki Takiuchi, Geoffrey
Grosenbach, Julien Sanchez, Kamal Fariz Mahyuddin, Masayoshi Takahashi,
Patrick Aljordm, Mig, Kazuhiro Nishiyama, Jon Bardin, Konstantin Haase, Larry
Siden, Matias Korhonen, Sam Ruby, Simon Chiang, Tim Connor, Timur Batyrshin,
and Zach Brock for bug fixing and other improvements.
* Eric Wong, Hongli Lai, Jeremy Kemper for their continuous support and API
improvements.
* Yehuda Katz and Carl Lerche for refactoring rackup.
* Brian Candler, for `Rack::ContentType`.
* Graham Batty, for improved handler loading.
* Stephen Bannasch, for bug reports and documentation.
* Gary Wright, for proposing a better `Rack::Response` interface.
* Jonathan Buch, for improvements regarding `Rack::Response`.
* Armin Röhrl, for tracking down bugs in the Cookie generator.
* Alexander Kellett for testing the Gem and reviewing the announcement.
* Marcus Rückert, for help with configuring and debugging lighttpd.
* The WSGI team for the well-done and documented work they've done and Rack
builds up on.
* All bug reporters and patch contributors not mentioned above.
## License
Rack is released under the [MIT License](MIT-LICENSE).
[Rack Specification]: SPEC.rdoc
share/gems/gems/rack-3.0.8/MIT-LICENSE 0000644 00000002124 15173517742 0012567 0 ustar 00 The MIT License (MIT)
Copyright (C) 2007-2021 Leah Neukirchen <http://leahneukirchen.org/infopage.html>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
share/gems/gems/rack-3.0.8/SPEC.rdoc 0000644 00000036403 15173517742 0012545 0 ustar 00 This specification aims to formalize the Rack protocol. You
can (and should) use Rack::Lint to enforce it.
When you develop middleware, be sure to add a Lint before and
after to catch all mistakes.
= Rack applications
A Rack application is a Ruby object (not a class) that
responds to +call+.
It takes exactly one argument, the *environment*
and returns a non-frozen Array of exactly three values:
The *status*,
the *headers*,
and the *body*.
== The Environment
The environment must be an unfrozen instance of Hash that includes
CGI-like headers. The Rack application is free to modify the
environment.
The environment is required to include these variables
(adopted from {PEP 333}[https://peps.python.org/pep-0333/]), except when they'd be empty, but see
below.
<tt>REQUEST_METHOD</tt>:: The HTTP request method, such as
"GET" or "POST". This cannot ever
be an empty string, and so is
always required.
<tt>SCRIPT_NAME</tt>:: The initial portion of the request
URL's "path" that corresponds to the
application object, so that the
application knows its virtual
"location". This may be an empty
string, if the application corresponds
to the "root" of the server.
<tt>PATH_INFO</tt>:: The remainder of the request URL's
"path", designating the virtual
"location" of the request's target
within the application. This may be an
empty string, if the request URL targets
the application root and does not have a
trailing slash. This value may be
percent-encoded when originating from
a URL.
<tt>QUERY_STRING</tt>:: The portion of the request URL that
follows the <tt>?</tt>, if any. May be
empty, but is always required!
<tt>SERVER_NAME</tt>:: When combined with <tt>SCRIPT_NAME</tt> and
<tt>PATH_INFO</tt>, these variables can be
used to complete the URL. Note, however,
that <tt>HTTP_HOST</tt>, if present,
should be used in preference to
<tt>SERVER_NAME</tt> for reconstructing
the request URL.
<tt>SERVER_NAME</tt> can never be an empty
string, and so is always required.
<tt>SERVER_PORT</tt>:: An optional +Integer+ which is the port the
server is running on. Should be specified if
the server is running on a non-standard port.
<tt>SERVER_PROTOCOL</tt>:: A string representing the HTTP version used
for the request.
<tt>HTTP_</tt> Variables:: Variables corresponding to the
client-supplied HTTP request
headers (i.e., variables whose
names begin with <tt>HTTP_</tt>). The
presence or absence of these
variables should correspond with
the presence or absence of the
appropriate HTTP header in the
request. See
{RFC3875 section 4.1.18}[https://tools.ietf.org/html/rfc3875#section-4.1.18]
for specific behavior.
In addition to this, the Rack environment must include these
Rack-specific variables:
<tt>rack.url_scheme</tt>:: +http+ or +https+, depending on the
request URL.
<tt>rack.input</tt>:: See below, the input stream.
<tt>rack.errors</tt>:: See below, the error stream.
<tt>rack.hijack?</tt>:: See below, if present and true, indicates
that the server supports partial hijacking.
<tt>rack.hijack</tt>:: See below, if present, an object responding
to +call+ that is used to perform a full
hijack.
Additional environment specifications have approved to
standardized middleware APIs. None of these are required to
be implemented by the server.
<tt>rack.session</tt>:: A hash-like interface for storing
request session data.
The store must implement:
store(key, value) (aliased as []=);
fetch(key, default = nil) (aliased as []);
delete(key);
clear;
to_hash (returning unfrozen Hash instance);
<tt>rack.logger</tt>:: A common object interface for logging messages.
The object must implement:
info(message, &block)
debug(message, &block)
warn(message, &block)
error(message, &block)
fatal(message, &block)
<tt>rack.multipart.buffer_size</tt>:: An Integer hint to the multipart parser as to what chunk size to use for reads and writes.
<tt>rack.multipart.tempfile_factory</tt>:: An object responding to #call with two arguments, the filename and content_type given for the multipart form field, and returning an IO-like object that responds to #<< and optionally #rewind. This factory will be used to instantiate the tempfile for each multipart form file upload field, rather than the default class of Tempfile.
The server or the application can store their own data in the
environment, too. The keys must contain at least one dot,
and should be prefixed uniquely. The prefix <tt>rack.</tt>
is reserved for use with the Rack core distribution and other
accepted specifications and must not be used otherwise.
The <tt>SERVER_PORT</tt> must be an Integer if set.
The <tt>SERVER_NAME</tt> must be a valid authority as defined by RFC7540.
The <tt>HTTP_HOST</tt> must be a valid authority as defined by RFC7540.
The <tt>SERVER_PROTOCOL</tt> must match the regexp <tt>HTTP/\d(\.\d)?</tt>.
If the <tt>HTTP_VERSION</tt> is present, it must equal the <tt>SERVER_PROTOCOL</tt>.
The environment must not contain the keys
<tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>
(use the versions without <tt>HTTP_</tt>).
The CGI keys (named without a period) must have String values.
If the string values for CGI keys contain non-ASCII characters,
they should use ASCII-8BIT encoding.
There are the following restrictions:
* <tt>rack.url_scheme</tt> must either be +http+ or +https+.
* There must be a valid input stream in <tt>rack.input</tt>.
* There must be a valid error stream in <tt>rack.errors</tt>.
* There may be a valid hijack callback in <tt>rack.hijack</tt>
* The <tt>REQUEST_METHOD</tt> must be a valid token.
* The <tt>SCRIPT_NAME</tt>, if non-empty, must start with <tt>/</tt>
* The <tt>PATH_INFO</tt>, if non-empty, must start with <tt>/</tt>
* The <tt>CONTENT_LENGTH</tt>, if given, must consist of digits only.
* One of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be
set. <tt>PATH_INFO</tt> should be <tt>/</tt> if
<tt>SCRIPT_NAME</tt> is empty.
<tt>SCRIPT_NAME</tt> never should be <tt>/</tt>, but instead be empty.
<tt>rack.response_finished</tt>:: An array of callables run by the server after the response has been
processed. This would typically be invoked after sending the response to the client, but it could also be
invoked if an error occurs while generating the response or sending the response; in that case, the error
argument will be a subclass of +Exception+.
The callables are invoked with +env, status, headers, error+ arguments and should not raise any
exceptions. They should be invoked in reverse order of registration.
=== The Input Stream
The input stream is an IO-like object which contains the raw HTTP
POST data.
When applicable, its external encoding must be "ASCII-8BIT" and it
must be opened in binary mode, for Ruby 1.9 compatibility.
The input stream must respond to +gets+, +each+, and +read+.
* +gets+ must be called without arguments and return a string,
or +nil+ on EOF.
* +read+ behaves like IO#read.
Its signature is <tt>read([length, [buffer]])</tt>.
If given, +length+ must be a non-negative Integer (>= 0) or +nil+,
and +buffer+ must be a String and may not be nil.
If +length+ is given and not nil, then this method reads at most
+length+ bytes from the input stream.
If +length+ is not given or nil, then this method reads
all data until EOF.
When EOF is reached, this method returns nil if +length+ is given
and not nil, or "" if +length+ is not given or is nil.
If +buffer+ is given, then the read data will be placed
into +buffer+ instead of a newly created String object.
* +each+ must be called without arguments and only yield Strings.
* +close+ can be called on the input stream to indicate that the
any remaining input is not needed.
=== The Error Stream
The error stream must respond to +puts+, +write+ and +flush+.
* +puts+ must be called with a single argument that responds to +to_s+.
* +write+ must be called with a single argument that is a String.
* +flush+ must be called without arguments and must be called
in order to make the error appear for sure.
* +close+ must never be called on the error stream.
=== Hijacking
The hijacking interfaces provides a means for an application to take
control of the HTTP connection. There are two distinct hijack
interfaces: full hijacking where the application takes over the raw
connection, and partial hijacking where the application takes over
just the response body stream. In both cases, the application is
responsible for closing the hijacked stream.
Full hijacking only works with HTTP/1. Partial hijacking is functionally
equivalent to streaming bodies, and is still optionally supported for
backwards compatibility with older Rack versions.
==== Full Hijack
Full hijack is used to completely take over an HTTP/1 connection. It
occurs before any headers are written and causes the request to
ignores any response generated by the application.
It is intended to be used when applications need access to raw HTTP/1
connection.
If +rack.hijack+ is present in +env+, it must respond to +call+
and return an +IO+ instance which can be used to read and write
to the underlying connection using HTTP/1 semantics and
formatting.
==== Partial Hijack
Partial hijack is used for bi-directional streaming of the request and
response body. It occurs after the status and headers are written by
the server and causes the server to ignore the Body of the response.
It is intended to be used when applications need bi-directional
streaming.
If +rack.hijack?+ is present in +env+ and truthy,
an application may set the special response header +rack.hijack+
to an object that responds to +call+,
accepting a +stream+ argument.
After the response status and headers have been sent, this hijack
callback will be invoked with a +stream+ argument which follows the
same interface as outlined in "Streaming Body". Servers must
ignore the +body+ part of the response tuple when the
+rack.hijack+ response header is present. Using an empty +Array+
instance is recommended.
The special response header +rack.hijack+ must only be set
if the request +env+ has a truthy +rack.hijack?+.
== The Response
=== The Status
This is an HTTP status. It must be an Integer greater than or equal to
100.
=== The Headers
The headers must be a unfrozen Hash.
The header keys must be Strings.
Special headers starting "rack." are for communicating with the
server, and must not be sent back to the client.
The header must not contain a +Status+ key.
Header keys must conform to RFC7230 token specification, i.e. cannot
contain non-printable ASCII, DQUOTE or "(),/:;<=>?@[\]{}".
Header keys must not contain uppercase ASCII characters (A-Z).
Header values must be either a String instance,
or an Array of String instances,
such that each String instance must not contain characters below 037.
=== The content-type
There must not be a <tt>content-type</tt> header key when the +Status+ is 1xx,
204, or 304.
=== The content-length
There must not be a <tt>content-length</tt> header key when the
+Status+ is 1xx, 204, or 304.
=== The Body
The Body is typically an +Array+ of +String+ instances, an enumerable
that yields +String+ instances, a +Proc+ instance, or a File-like
object.
The Body must respond to +each+ or +call+. It may optionally respond
to +to_path+ or +to_ary+. A Body that responds to +each+ is considered
to be an Enumerable Body. A Body that responds to +call+ is considered
to be a Streaming Body.
A Body that responds to both +each+ and +call+ must be treated as an
Enumerable Body, not a Streaming Body. If it responds to +each+, you
must call +each+ and not +call+. If the Body doesn't respond to
+each+, then you can assume it responds to +call+.
The Body must either be consumed or returned. The Body is consumed by
optionally calling either +each+ or +call+.
Then, if the Body responds to +close+, it must be called to release
any resources associated with the generation of the body.
In other words, +close+ must always be called at least once; typically
after the web server has sent the response to the client, but also in
cases where the Rack application makes internal/virtual requests and
discards the response.
After calling +close+, the Body is considered closed and should not
be consumed again.
If the original Body is replaced by a new Body, the new Body must
also consume the original Body by calling +close+ if possible.
If the Body responds to +to_path+, it must return a +String+
path for the local file system whose contents are identical
to that produced by calling +each+; this may be used by the
server as an alternative, possibly more efficient way to
transport the response. The +to_path+ method does not consume
the body.
==== Enumerable Body
The Enumerable Body must respond to +each+.
It must only be called once.
It must not be called after being closed.
and must only yield String values.
The Body itself should not be an instance of String, as this will
break in Ruby 1.9.
Middleware must not call +each+ directly on the Body.
Instead, middleware can return a new Body that calls +each+ on the
original Body, yielding at least once per iteration.
If the Body responds to +to_ary+, it must return an +Array+ whose
contents are identical to that produced by calling +each+.
Middleware may call +to_ary+ directly on the Body and return a new
Body in its place. In other words, middleware can only process the
Body directly if it responds to +to_ary+. If the Body responds to both
+to_ary+ and +close+, its implementation of +to_ary+ must call
+close+.
==== Streaming Body
The Streaming Body must respond to +call+.
It must only be called once.
It must not be called after being closed.
It takes a +stream+ argument.
The +stream+ argument must implement:
<tt>read, write, <<, flush, close, close_read, close_write, closed?</tt>
The semantics of these IO methods must be a best effort match to
those of a normal Ruby IO or Socket object, using standard arguments
and raising standard exceptions. Servers are encouraged to simply
pass on real IO objects, although it is recognized that this approach
is not directly compatible with HTTP/2.
== Thanks
Some parts of this specification are adopted from {PEP 333 – Python Web Server Gateway Interface v1.0}[https://peps.python.org/pep-0333/]
I'd like to thank everyone involved in that effort.
share/gems/gems/rack-3.0.8/lib/rack.rb 0000644 00000004722 15173517742 0013154 0 ustar 00 # frozen_string_literal: true
# Copyright (C) 2007-2019 Leah Neukirchen <http://leahneukirchen.org/infopage.html>
#
# Rack is freely distributable under the terms of an MIT-style license.
# See MIT-LICENSE or https://opensource.org/licenses/MIT.
# The Rack main module, serving as a namespace for all core Rack
# modules and classes.
#
# All modules meant for use in your application are <tt>autoload</tt>ed here,
# so it should be enough just to <tt>require 'rack'</tt> in your code.
require_relative 'rack/version'
require_relative 'rack/constants'
module Rack
autoload :Builder, "rack/builder"
autoload :BodyProxy, "rack/body_proxy"
autoload :Cascade, "rack/cascade"
autoload :Chunked, "rack/chunked"
autoload :CommonLogger, "rack/common_logger"
autoload :ConditionalGet, "rack/conditional_get"
autoload :Config, "rack/config"
autoload :ContentLength, "rack/content_length"
autoload :ContentType, "rack/content_type"
autoload :ETag, "rack/etag"
autoload :Events, "rack/events"
autoload :File, "rack/file"
autoload :Files, "rack/files"
autoload :Deflater, "rack/deflater"
autoload :Directory, "rack/directory"
autoload :ForwardRequest, "rack/recursive"
autoload :Handler, "rack/handler"
autoload :Head, "rack/head"
autoload :Headers, "rack/headers"
autoload :Lint, "rack/lint"
autoload :Lock, "rack/lock"
autoload :Logger, "rack/logger"
autoload :MediaType, "rack/media_type"
autoload :MethodOverride, "rack/method_override"
autoload :Mime, "rack/mime"
autoload :NullLogger, "rack/null_logger"
autoload :QueryParser, "rack/query_parser"
autoload :Recursive, "rack/recursive"
autoload :Reloader, "rack/reloader"
autoload :RewindableInput, "rack/rewindable_input"
autoload :Runtime, "rack/runtime"
autoload :Sendfile, "rack/sendfile"
autoload :Server, "rack/server"
autoload :ShowExceptions, "rack/show_exceptions"
autoload :ShowStatus, "rack/show_status"
autoload :Static, "rack/static"
autoload :TempfileReaper, "rack/tempfile_reaper"
autoload :URLMap, "rack/urlmap"
autoload :Utils, "rack/utils"
autoload :Multipart, "rack/multipart"
autoload :MockRequest, "rack/mock_request"
autoload :MockResponse, "rack/mock_response"
autoload :Request, "rack/request"
autoload :Response, "rack/response"
module Auth
autoload :Basic, "rack/auth/basic"
autoload :AbstractRequest, "rack/auth/abstract/request"
autoload :AbstractHandler, "rack/auth/abstract/handler"
autoload :Digest, "rack/auth/digest"
end
end
share/gems/gems/rack-3.0.8/lib/rack/tempfile_reaper.rb 0000644 00000001412 15173517742 0016310 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'body_proxy'
module Rack
# Middleware tracks and cleans Tempfiles created throughout a request (i.e. Rack::Multipart)
# Ideas/strategy based on posts by Eric Wong and Charles Oliver Nutter
# https://groups.google.com/forum/#!searchin/rack-devel/temp/rack-devel/brK8eh-MByw/sw61oJJCGRMJ
class TempfileReaper
def initialize(app)
@app = app
end
def call(env)
env[RACK_TEMPFILES] ||= []
begin
_, _, body = response = @app.call(env)
rescue Exception
env[RACK_TEMPFILES]&.each(&:close!)
raise
end
response[2] = BodyProxy.new(body) do
env[RACK_TEMPFILES]&.each(&:close!)
end
response
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/etag.rb 0000644 00000003567 15173517742 0014102 0 ustar 00 # frozen_string_literal: true
require 'digest/sha2'
require_relative 'constants'
require_relative 'utils'
module Rack
# Automatically sets the etag header on all String bodies.
#
# The etag header is skipped if etag or last-modified headers are sent or if
# a sendfile body (body.responds_to :to_path) is given (since such cases
# should be handled by apache/nginx).
#
# On initialization, you can pass two parameters: a cache-control directive
# used when etag is absent and a directive when it is present. The first
# defaults to nil, while the second defaults to "max-age=0, private, must-revalidate"
class ETag
ETAG_STRING = Rack::ETAG
DEFAULT_CACHE_CONTROL = "max-age=0, private, must-revalidate"
def initialize(app, no_cache_control = nil, cache_control = DEFAULT_CACHE_CONTROL)
@app = app
@cache_control = cache_control
@no_cache_control = no_cache_control
end
def call(env)
status, headers, body = response = @app.call(env)
if etag_status?(status) && body.respond_to?(:to_ary) && !skip_caching?(headers)
body = body.to_ary
digest = digest_body(body)
headers[ETAG_STRING] = %(W/"#{digest}") if digest
end
unless headers[CACHE_CONTROL]
if digest
headers[CACHE_CONTROL] = @cache_control if @cache_control
else
headers[CACHE_CONTROL] = @no_cache_control if @no_cache_control
end
end
response
end
private
def etag_status?(status)
status == 200 || status == 201
end
def skip_caching?(headers)
headers.key?(ETAG_STRING) || headers.key?('last-modified')
end
def digest_body(body)
digest = nil
body.each do |part|
(digest ||= Digest::SHA256.new) << part unless part.empty?
end
digest && digest.hexdigest.byteslice(0,32)
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/logger.rb 0000644 00000000636 15173517742 0014433 0 ustar 00 # frozen_string_literal: true
require 'logger'
require_relative 'constants'
module Rack
# Sets up rack.logger to write to rack.errors stream
class Logger
def initialize(app, level = ::Logger::INFO)
@app, @level = app, level
end
def call(env)
logger = ::Logger.new(env[RACK_ERRORS])
logger.level = @level
env[RACK_LOGGER] = logger
@app.call(env)
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/show_exceptions.rb 0000644 00000033360 15173517742 0016375 0 ustar 00 # frozen_string_literal: true
require 'ostruct'
require 'erb'
require_relative 'constants'
require_relative 'utils'
require_relative 'request'
module Rack
# Rack::ShowExceptions catches all exceptions raised from the app it
# wraps. It shows a useful backtrace with the sourcefile and
# clickable context, the whole Rack environment and the request
# data.
#
# Be careful when you use this on public-facing sites as it could
# reveal information helpful to attackers.
class ShowExceptions
CONTEXT = 7
def initialize(app)
@app = app
end
def call(env)
@app.call(env)
rescue StandardError, LoadError, SyntaxError => e
exception_string = dump_exception(e)
env[RACK_ERRORS].puts(exception_string)
env[RACK_ERRORS].flush
if accepts_html?(env)
content_type = "text/html"
body = pretty(env, e)
else
content_type = "text/plain"
body = exception_string
end
[
500,
{
CONTENT_TYPE => content_type,
CONTENT_LENGTH => body.bytesize.to_s,
},
[body],
]
end
def prefers_plaintext?(env)
!accepts_html?(env)
end
def accepts_html?(env)
Rack::Utils.best_q_match(env["HTTP_ACCEPT"], %w[text/html])
end
private :accepts_html?
def dump_exception(exception)
if exception.respond_to?(:detailed_message)
message = exception.detailed_message(highlight: false)
else
message = exception.message
end
string = "#{exception.class}: #{message}\n".dup
string << exception.backtrace.map { |l| "\t#{l}" }.join("\n")
string
end
def pretty(env, exception)
req = Rack::Request.new(env)
# This double assignment is to prevent an "unused variable" warning.
# Yes, it is dumb, but I don't like Ruby yelling at me.
path = path = (req.script_name + req.path_info).squeeze("/")
# This double assignment is to prevent an "unused variable" warning.
# Yes, it is dumb, but I don't like Ruby yelling at me.
frames = frames = exception.backtrace.map { |line|
frame = OpenStruct.new
if line =~ /(.*?):(\d+)(:in `(.*)')?/
frame.filename = $1
frame.lineno = $2.to_i
frame.function = $4
begin
lineno = frame.lineno - 1
lines = ::File.readlines(frame.filename)
frame.pre_context_lineno = [lineno - CONTEXT, 0].max
frame.pre_context = lines[frame.pre_context_lineno...lineno]
frame.context_line = lines[lineno].chomp
frame.post_context_lineno = [lineno + CONTEXT, lines.size].min
frame.post_context = lines[lineno + 1..frame.post_context_lineno]
rescue
end
frame
else
nil
end
}.compact
template.result(binding)
end
def template
TEMPLATE
end
def h(obj) # :nodoc:
case obj
when String
Utils.escape_html(obj)
else
Utils.escape_html(obj.inspect)
end
end
# :stopdoc:
# adapted from Django <www.djangoproject.com>
# Copyright (c) Django Software Foundation and individual contributors.
# Used under the modified BSD license:
# http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5
TEMPLATE = ERB.new(<<-'HTML'.gsub(/^ /, ''))
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<meta name="robots" content="NONE,NOARCHIVE" />
<title><%=h exception.class %> at <%=h path %></title>
<style type="text/css">
html * { padding:0; margin:0; }
body * { padding:10px 20px; }
body * * { padding:0; }
body { font:small sans-serif; }
body>div { border-bottom:1px solid #ddd; }
h1 { font-weight:normal; }
h2 { margin-bottom:.8em; }
h2 span { font-size:80%; color:#666; font-weight:normal; }
h3 { margin:1em 0 .5em 0; }
h4 { margin:0 0 .5em 0; font-weight: normal; }
table {
border:1px solid #ccc; border-collapse: collapse; background:white; }
tbody td, tbody th { vertical-align:top; padding:2px 3px; }
thead th {
padding:1px 6px 1px 3px; background:#fefefe; text-align:left;
font-weight:normal; font-size:11px; border:1px solid #ddd; }
tbody th { text-align:right; color:#666; padding-right:.5em; }
table.vars { margin:5px 0 2px 40px; }
table.vars td, table.req td { font-family:monospace; }
table td.code { width:100%;}
table td.code div { overflow:hidden; }
table.source th { color:#666; }
table.source td {
font-family:monospace; white-space:pre; border-bottom:1px solid #eee; }
ul.traceback { list-style-type:none; }
ul.traceback li.frame { margin-bottom:1em; }
div.context { margin: 10px 0; }
div.context ol {
padding-left:30px; margin:0 10px; list-style-position: inside; }
div.context ol li {
font-family:monospace; white-space:pre; color:#666; cursor:pointer; }
div.context ol.context-line li { color:black; background-color:#ccc; }
div.context ol.context-line li span { float: right; }
div.commands { margin-left: 40px; }
div.commands a { color:black; text-decoration:none; }
#summary { background: #ffc; }
#summary h2 { font-family: monospace; font-weight: normal; color: #666; white-space: pre-wrap; }
#summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
#summary ul#quicklinks li { float: left; padding: 0 1em; }
#summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
#explanation { background:#eee; }
#template, #template-not-exist { background:#f6f6f6; }
#template-not-exist ul { margin: 0 0 0 20px; }
#traceback { background:#eee; }
#requestinfo { background:#f6f6f6; padding-left:120px; }
#summary table { border:none; background:transparent; }
#requestinfo h2, #requestinfo h3 { position:relative; margin-left:-100px; }
#requestinfo h3 { margin-bottom:-1em; }
.error { background: #ffc; }
.specific { color:#cc3300; font-weight:bold; }
</style>
<script type="text/javascript">
//<!--
function getElementsByClassName(oElm, strTagName, strClassName){
// Written by Jonathan Snook, http://www.snook.ca/jon;
// Add-ons by Robert Nyman, http://www.robertnyman.com
var arrElements = (strTagName == "*" && document.all)? document.all :
oElm.getElementsByTagName(strTagName);
var arrReturnElements = new Array();
strClassName = strClassName.replace(/\-/g, "\\-");
var oRegExp = new RegExp("(^|\\s)" + strClassName + "(\\s|$$)");
var oElement;
for(var i=0; i<arrElements.length; i++){
oElement = arrElements[i];
if(oRegExp.test(oElement.className)){
arrReturnElements.push(oElement);
}
}
return (arrReturnElements)
}
function hideAll(elems) {
for (var e = 0; e < elems.length; e++) {
elems[e].style.display = 'none';
}
}
window.onload = function() {
hideAll(getElementsByClassName(document, 'table', 'vars'));
hideAll(getElementsByClassName(document, 'ol', 'pre-context'));
hideAll(getElementsByClassName(document, 'ol', 'post-context'));
}
function toggle() {
for (var i = 0; i < arguments.length; i++) {
var e = document.getElementById(arguments[i]);
if (e) {
e.style.display = e.style.display == 'none' ? 'block' : 'none';
}
}
return false;
}
function varToggle(link, id) {
toggle('v' + id);
var s = link.getElementsByTagName('span')[0];
var uarr = String.fromCharCode(0x25b6);
var darr = String.fromCharCode(0x25bc);
s.innerHTML = s.innerHTML == uarr ? darr : uarr;
return false;
}
//-->
</script>
</head>
<body>
<div id="summary">
<h1><%=h exception.class %> at <%=h path %></h1>
<% if exception.respond_to?(:detailed_message) %>
<h2><%=h exception.detailed_message(highlight: false) %></h2>
<% else %>
<h2><%=h exception.message %></h2>
<% end %>
<table><tr>
<th>Ruby</th>
<td>
<% if first = frames.first %>
<code><%=h first.filename %></code>: in <code><%=h first.function %></code>, line <%=h frames.first.lineno %>
<% else %>
unknown location
<% end %>
</td>
</tr><tr>
<th>Web</th>
<td><code><%=h req.request_method %> <%=h(req.host + path)%></code></td>
</tr></table>
<h3>Jump to:</h3>
<ul id="quicklinks">
<li><a href="#get-info">GET</a></li>
<li><a href="#post-info">POST</a></li>
<li><a href="#cookie-info">Cookies</a></li>
<li><a href="#env-info">ENV</a></li>
</ul>
</div>
<div id="traceback">
<h2>Traceback <span>(innermost first)</span></h2>
<ul class="traceback">
<% frames.each { |frame| %>
<li class="frame">
<code><%=h frame.filename %></code>: in <code><%=h frame.function %></code>
<% if frame.context_line %>
<div class="context" id="c<%=h frame.object_id %>">
<% if frame.pre_context %>
<ol start="<%=h frame.pre_context_lineno+1 %>" class="pre-context" id="pre<%=h frame.object_id %>">
<% frame.pre_context.each { |line| %>
<li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h line %></li>
<% } %>
</ol>
<% end %>
<ol start="<%=h frame.lineno %>" class="context-line">
<li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h frame.context_line %><span>...</span></li></ol>
<% if frame.post_context %>
<ol start='<%=h frame.lineno+1 %>' class="post-context" id="post<%=h frame.object_id %>">
<% frame.post_context.each { |line| %>
<li onclick="toggle('pre<%=h frame.object_id %>', 'post<%=h frame.object_id %>')"><%=h line %></li>
<% } %>
</ol>
<% end %>
</div>
<% end %>
</li>
<% } %>
</ul>
</div>
<div id="requestinfo">
<h2>Request information</h2>
<h3 id="get-info">GET</h3>
<% if req.GET and not req.GET.empty? %>
<table class="req">
<thead>
<tr>
<th>Variable</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<% req.GET.sort_by { |k, v| k.to_s }.each { |key, val| %>
<tr>
<td><%=h key %></td>
<td class="code"><div><%=h val.inspect %></div></td>
</tr>
<% } %>
</tbody>
</table>
<% else %>
<p>No GET data.</p>
<% end %>
<h3 id="post-info">POST</h3>
<% if ((req.POST and not req.POST.empty?) rescue (no_post_data = "Invalid POST data"; nil)) %>
<table class="req">
<thead>
<tr>
<th>Variable</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<% req.POST.sort_by { |k, v| k.to_s }.each { |key, val| %>
<tr>
<td><%=h key %></td>
<td class="code"><div><%=h val.inspect %></div></td>
</tr>
<% } %>
</tbody>
</table>
<% else %>
<p><%= no_post_data || "No POST data" %>.</p>
<% end %>
<h3 id="cookie-info">COOKIES</h3>
<% unless req.cookies.empty? %>
<table class="req">
<thead>
<tr>
<th>Variable</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<% req.cookies.each { |key, val| %>
<tr>
<td><%=h key %></td>
<td class="code"><div><%=h val.inspect %></div></td>
</tr>
<% } %>
</tbody>
</table>
<% else %>
<p>No cookie data.</p>
<% end %>
<h3 id="env-info">Rack ENV</h3>
<table class="req">
<thead>
<tr>
<th>Variable</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<% env.sort_by { |k, v| k.to_s }.each { |key, val| %>
<tr>
<td><%=h key %></td>
<td class="code"><div><%=h val.inspect %></div></td>
</tr>
<% } %>
</tbody>
</table>
</div>
<div id="explanation">
<p>
You're seeing this error because you use <code>Rack::ShowExceptions</code>.
</p>
</div>
</body>
</html>
HTML
# :startdoc:
end
end
share/gems/gems/rack-3.0.8/lib/rack/request.rb 0000644 00000061107 15173517742 0014644 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
require_relative 'media_type'
module Rack
# Rack::Request provides a convenient interface to a Rack
# environment. It is stateless, the environment +env+ passed to the
# constructor will be directly modified.
#
# req = Rack::Request.new(env)
# req.post?
# req.params["data"]
class Request
class << self
attr_accessor :ip_filter
# The priority when checking forwarded headers. The default
# is <tt>[:forwarded, :x_forwarded]</tt>, which means, check the
# +Forwarded+ header first, followed by the appropriate
# <tt>X-Forwarded-*</tt> header. You can revert the priority by
# reversing the priority, or remove checking of either
# or both headers by removing elements from the array.
#
# This should be set as appropriate in your environment
# based on what reverse proxies are in use. If you are not
# using reverse proxies, you should probably use an empty
# array.
attr_accessor :forwarded_priority
# The priority when checking either the <tt>X-Forwarded-Proto</tt>
# or <tt>X-Forwarded-Scheme</tt> header for the forwarded protocol.
# The default is <tt>[:proto, :scheme]</tt>, to try the
# <tt>X-Forwarded-Proto</tt> header before the
# <tt>X-Forwarded-Scheme</tt> header. Rack 2 had behavior
# similar to <tt>[:scheme, :proto]</tt>. You can remove either or
# both of the entries in array to ignore that respective header.
attr_accessor :x_forwarded_proto_priority
end
@forwarded_priority = [:forwarded, :x_forwarded]
@x_forwarded_proto_priority = [:proto, :scheme]
valid_ipv4_octet = /\.(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])/
trusted_proxies = Regexp.union(
/\A127#{valid_ipv4_octet}{3}\z/, # localhost IPv4 range 127.x.x.x, per RFC-3330
/\A::1\z/, # localhost IPv6 ::1
/\Af[cd][0-9a-f]{2}(?::[0-9a-f]{0,4}){0,7}\z/i, # private IPv6 range fc00 .. fdff
/\A10#{valid_ipv4_octet}{3}\z/, # private IPv4 range 10.x.x.x
/\A172\.(1[6-9]|2[0-9]|3[01])#{valid_ipv4_octet}{2}\z/, # private IPv4 range 172.16.0.0 .. 172.31.255.255
/\A192\.168#{valid_ipv4_octet}{2}\z/, # private IPv4 range 192.168.x.x
/\Alocalhost\z|\Aunix(\z|:)/i, # localhost hostname, and unix domain sockets
)
self.ip_filter = lambda { |ip| trusted_proxies.match?(ip) }
ALLOWED_SCHEMES = %w(https http wss ws).freeze
def initialize(env)
@env = env
@params = nil
end
def params
@params ||= super
end
def update_param(k, v)
super
@params = nil
end
def delete_param(k)
v = super
@params = nil
v
end
module Env
# The environment of the request.
attr_reader :env
def initialize(env)
@env = env
# This module is included at least in `ActionDispatch::Request`
# The call to `super()` allows additional mixed-in initializers are called
super()
end
# Predicate method to test to see if `name` has been set as request
# specific data
def has_header?(name)
@env.key? name
end
# Get a request specific value for `name`.
def get_header(name)
@env[name]
end
# If a block is given, it yields to the block if the value hasn't been set
# on the request.
def fetch_header(name, &block)
@env.fetch(name, &block)
end
# Loops through each key / value pair in the request specific data.
def each_header(&block)
@env.each(&block)
end
# Set a request specific value for `name` to `v`
def set_header(name, v)
@env[name] = v
end
# Add a header that may have multiple values.
#
# Example:
# request.add_header 'Accept', 'image/png'
# request.add_header 'Accept', '*/*'
#
# assert_equal 'image/png,*/*', request.get_header('Accept')
#
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
def add_header(key, v)
if v.nil?
get_header key
elsif has_header? key
set_header key, "#{get_header key},#{v}"
else
set_header key, v
end
end
# Delete a request specific value for `name`.
def delete_header(name)
@env.delete name
end
def initialize_copy(other)
@env = other.env.dup
end
end
module Helpers
# The set of form-data media-types. Requests that do not indicate
# one of the media types present in this list will not be eligible
# for form-data / param parsing.
FORM_DATA_MEDIA_TYPES = [
'application/x-www-form-urlencoded',
'multipart/form-data'
]
# The set of media-types. Requests that do not indicate
# one of the media types present in this list will not be eligible
# for param parsing like soap attachments or generic multiparts
PARSEABLE_DATA_MEDIA_TYPES = [
'multipart/related',
'multipart/mixed'
]
# Default ports depending on scheme. Used to decide whether or not
# to include the port in a generated URI.
DEFAULT_PORTS = { 'http' => 80, 'https' => 443, 'coffee' => 80 }
# The address of the client which connected to the proxy.
HTTP_X_FORWARDED_FOR = 'HTTP_X_FORWARDED_FOR'
# The contents of the host/:authority header sent to the proxy.
HTTP_X_FORWARDED_HOST = 'HTTP_X_FORWARDED_HOST'
HTTP_FORWARDED = 'HTTP_FORWARDED'
# The value of the scheme sent to the proxy.
HTTP_X_FORWARDED_SCHEME = 'HTTP_X_FORWARDED_SCHEME'
# The protocol used to connect to the proxy.
HTTP_X_FORWARDED_PROTO = 'HTTP_X_FORWARDED_PROTO'
# The port used to connect to the proxy.
HTTP_X_FORWARDED_PORT = 'HTTP_X_FORWARDED_PORT'
# Another way for specifying https scheme was used.
HTTP_X_FORWARDED_SSL = 'HTTP_X_FORWARDED_SSL'
def body; get_header(RACK_INPUT) end
def script_name; get_header(SCRIPT_NAME).to_s end
def script_name=(s); set_header(SCRIPT_NAME, s.to_s) end
def path_info; get_header(PATH_INFO).to_s end
def path_info=(s); set_header(PATH_INFO, s.to_s) end
def request_method; get_header(REQUEST_METHOD) end
def query_string; get_header(QUERY_STRING).to_s end
def content_length; get_header('CONTENT_LENGTH') end
def logger; get_header(RACK_LOGGER) end
def user_agent; get_header('HTTP_USER_AGENT') end
# the referer of the client
def referer; get_header('HTTP_REFERER') end
alias referrer referer
def session
fetch_header(RACK_SESSION) do |k|
set_header RACK_SESSION, default_session
end
end
def session_options
fetch_header(RACK_SESSION_OPTIONS) do |k|
set_header RACK_SESSION_OPTIONS, {}
end
end
# Checks the HTTP request method (or verb) to see if it was of type DELETE
def delete?; request_method == DELETE end
# Checks the HTTP request method (or verb) to see if it was of type GET
def get?; request_method == GET end
# Checks the HTTP request method (or verb) to see if it was of type HEAD
def head?; request_method == HEAD end
# Checks the HTTP request method (or verb) to see if it was of type OPTIONS
def options?; request_method == OPTIONS end
# Checks the HTTP request method (or verb) to see if it was of type LINK
def link?; request_method == LINK end
# Checks the HTTP request method (or verb) to see if it was of type PATCH
def patch?; request_method == PATCH end
# Checks the HTTP request method (or verb) to see if it was of type POST
def post?; request_method == POST end
# Checks the HTTP request method (or verb) to see if it was of type PUT
def put?; request_method == PUT end
# Checks the HTTP request method (or verb) to see if it was of type TRACE
def trace?; request_method == TRACE end
# Checks the HTTP request method (or verb) to see if it was of type UNLINK
def unlink?; request_method == UNLINK end
def scheme
if get_header(HTTPS) == 'on'
'https'
elsif get_header(HTTP_X_FORWARDED_SSL) == 'on'
'https'
elsif forwarded_scheme
forwarded_scheme
else
get_header(RACK_URL_SCHEME)
end
end
# The authority of the incoming request as defined by RFC3976.
# https://tools.ietf.org/html/rfc3986#section-3.2
#
# In HTTP/1, this is the `host` header.
# In HTTP/2, this is the `:authority` pseudo-header.
def authority
forwarded_authority || host_authority || server_authority
end
# The authority as defined by the `SERVER_NAME` and `SERVER_PORT`
# variables.
def server_authority
host = self.server_name
port = self.server_port
if host
if port
"#{host}:#{port}"
else
host
end
end
end
def server_name
get_header(SERVER_NAME)
end
def server_port
get_header(SERVER_PORT)
end
def cookies
hash = fetch_header(RACK_REQUEST_COOKIE_HASH) do |key|
set_header(key, {})
end
string = get_header(HTTP_COOKIE)
unless string == get_header(RACK_REQUEST_COOKIE_STRING)
hash.replace Utils.parse_cookies_header(string)
set_header(RACK_REQUEST_COOKIE_STRING, string)
end
hash
end
def content_type
content_type = get_header('CONTENT_TYPE')
content_type.nil? || content_type.empty? ? nil : content_type
end
def xhr?
get_header("HTTP_X_REQUESTED_WITH") == "XMLHttpRequest"
end
# The `HTTP_HOST` header.
def host_authority
get_header(HTTP_HOST)
end
def host_with_port(authority = self.authority)
host, _, port = split_authority(authority)
if port == DEFAULT_PORTS[self.scheme]
host
else
authority
end
end
# Returns a formatted host, suitable for being used in a URI.
def host
split_authority(self.authority)[0]
end
# Returns an address suitable for being to resolve to an address.
# In the case of a domain name or IPv4 address, the result is the same
# as +host+. In the case of IPv6 or future address formats, the square
# brackets are removed.
def hostname
split_authority(self.authority)[1]
end
def port
if authority = self.authority
_, _, port = split_authority(authority)
end
port || forwarded_port&.last || DEFAULT_PORTS[scheme] || server_port
end
def forwarded_for
forwarded_priority.each do |type|
case type
when :forwarded
if forwarded_for = get_http_forwarded(:for)
return(forwarded_for.map! do |authority|
split_authority(authority)[1]
end)
end
when :x_forwarded
if value = get_header(HTTP_X_FORWARDED_FOR)
return(split_header(value).map do |authority|
split_authority(wrap_ipv6(authority))[1]
end)
end
end
end
nil
end
def forwarded_port
forwarded_priority.each do |type|
case type
when :forwarded
if forwarded = get_http_forwarded(:for)
return(forwarded.map do |authority|
split_authority(authority)[2]
end.compact)
end
when :x_forwarded
if value = get_header(HTTP_X_FORWARDED_PORT)
return split_header(value).map(&:to_i)
end
end
end
nil
end
def forwarded_authority
forwarded_priority.each do |type|
case type
when :forwarded
if forwarded = get_http_forwarded(:host)
return forwarded.last
end
when :x_forwarded
if value = get_header(HTTP_X_FORWARDED_HOST)
return wrap_ipv6(split_header(value).last)
end
end
end
nil
end
def ssl?
scheme == 'https' || scheme == 'wss'
end
def ip
remote_addresses = split_header(get_header('REMOTE_ADDR'))
external_addresses = reject_trusted_ip_addresses(remote_addresses)
unless external_addresses.empty?
return external_addresses.last
end
if (forwarded_for = self.forwarded_for) && !forwarded_for.empty?
# The forwarded for addresses are ordered: client, proxy1, proxy2.
# So we reject all the trusted addresses (proxy*) and return the
# last client. Or if we trust everyone, we just return the first
# address.
return reject_trusted_ip_addresses(forwarded_for).last || forwarded_for.first
end
# If all the addresses are trusted, and we aren't forwarded, just return
# the first remote address, which represents the source of the request.
remote_addresses.first
end
# The media type (type/subtype) portion of the CONTENT_TYPE header
# without any media type parameters. e.g., when CONTENT_TYPE is
# "text/plain;charset=utf-8", the media-type is "text/plain".
#
# For more information on the use of media types in HTTP, see:
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
def media_type
MediaType.type(content_type)
end
# The media type parameters provided in CONTENT_TYPE as a Hash, or
# an empty Hash if no CONTENT_TYPE or media-type parameters were
# provided. e.g., when the CONTENT_TYPE is "text/plain;charset=utf-8",
# this method responds with the following Hash:
# { 'charset' => 'utf-8' }
def media_type_params
MediaType.params(content_type)
end
# The character set of the request body if a "charset" media type
# parameter was given, or nil if no "charset" was specified. Note
# that, per RFC2616, text/* media types that specify no explicit
# charset are to be considered ISO-8859-1.
def content_charset
media_type_params['charset']
end
# Determine whether the request body contains form-data by checking
# the request content-type for one of the media-types:
# "application/x-www-form-urlencoded" or "multipart/form-data". The
# list of form-data media types can be modified through the
# +FORM_DATA_MEDIA_TYPES+ array.
#
# A request body is also assumed to contain form-data when no
# content-type header is provided and the request_method is POST.
def form_data?
type = media_type
meth = get_header(RACK_METHODOVERRIDE_ORIGINAL_METHOD) || get_header(REQUEST_METHOD)
(meth == POST && type.nil?) || FORM_DATA_MEDIA_TYPES.include?(type)
end
# Determine whether the request body contains data by checking
# the request media_type against registered parse-data media-types
def parseable_data?
PARSEABLE_DATA_MEDIA_TYPES.include?(media_type)
end
# Returns the data received in the query string.
def GET
if get_header(RACK_REQUEST_QUERY_STRING) == query_string
get_header(RACK_REQUEST_QUERY_HASH)
else
query_hash = parse_query(query_string, '&')
set_header(RACK_REQUEST_QUERY_STRING, query_string)
set_header(RACK_REQUEST_QUERY_HASH, query_hash)
end
end
# Returns the data received in the request body.
#
# This method support both application/x-www-form-urlencoded and
# multipart/form-data.
def POST
if error = get_header(RACK_REQUEST_FORM_ERROR)
raise error.class, error.message, cause: error.cause
end
begin
rack_input = get_header(RACK_INPUT)
# If the form hash was already memoized:
if form_hash = get_header(RACK_REQUEST_FORM_HASH)
# And it was memoized from the same input:
if get_header(RACK_REQUEST_FORM_INPUT).equal?(rack_input)
return form_hash
end
end
# Otherwise, figure out how to parse the input:
if rack_input.nil?
set_header RACK_REQUEST_FORM_INPUT, nil
set_header(RACK_REQUEST_FORM_HASH, {})
elsif form_data? || parseable_data?
unless set_header(RACK_REQUEST_FORM_HASH, parse_multipart)
form_vars = get_header(RACK_INPUT).read
# Fix for Safari Ajax postings that always append \0
# form_vars.sub!(/\0\z/, '') # performance replacement:
form_vars.slice!(-1) if form_vars.end_with?("\0")
set_header RACK_REQUEST_FORM_VARS, form_vars
set_header RACK_REQUEST_FORM_HASH, parse_query(form_vars, '&')
end
set_header RACK_REQUEST_FORM_INPUT, get_header(RACK_INPUT)
get_header RACK_REQUEST_FORM_HASH
else
set_header RACK_REQUEST_FORM_INPUT, get_header(RACK_INPUT)
set_header(RACK_REQUEST_FORM_HASH, {})
end
rescue => error
set_header(RACK_REQUEST_FORM_ERROR, error)
raise
end
end
# The union of GET and POST data.
#
# Note that modifications will not be persisted in the env. Use update_param or delete_param if you want to destructively modify params.
def params
self.GET.merge(self.POST)
end
# Destructively update a parameter, whether it's in GET and/or POST. Returns nil.
#
# The parameter is updated wherever it was previous defined, so GET, POST, or both. If it wasn't previously defined, it's inserted into GET.
#
# <tt>env['rack.input']</tt> is not touched.
def update_param(k, v)
found = false
if self.GET.has_key?(k)
found = true
self.GET[k] = v
end
if self.POST.has_key?(k)
found = true
self.POST[k] = v
end
unless found
self.GET[k] = v
end
end
# Destructively delete a parameter, whether it's in GET or POST. Returns the value of the deleted parameter.
#
# If the parameter is in both GET and POST, the POST value takes precedence since that's how #params works.
#
# <tt>env['rack.input']</tt> is not touched.
def delete_param(k)
post_value, get_value = self.POST.delete(k), self.GET.delete(k)
post_value || get_value
end
def base_url
"#{scheme}://#{host_with_port}"
end
# Tries to return a remake of the original request URL as a string.
def url
base_url + fullpath
end
def path
script_name + path_info
end
def fullpath
query_string.empty? ? path : "#{path}?#{query_string}"
end
def accept_encoding
parse_http_accept_header(get_header("HTTP_ACCEPT_ENCODING"))
end
def accept_language
parse_http_accept_header(get_header("HTTP_ACCEPT_LANGUAGE"))
end
def trusted_proxy?(ip)
Rack::Request.ip_filter.call(ip)
end
# shortcut for <tt>request.params[key]</tt>
def [](key)
warn("Request#[] is deprecated and will be removed in a future version of Rack. Please use request.params[] instead", uplevel: 1)
params[key.to_s]
end
# shortcut for <tt>request.params[key] = value</tt>
#
# Note that modifications will not be persisted in the env. Use update_param or delete_param if you want to destructively modify params.
def []=(key, value)
warn("Request#[]= is deprecated and will be removed in a future version of Rack. Please use request.params[]= instead", uplevel: 1)
params[key.to_s] = value
end
# like Hash#values_at
def values_at(*keys)
keys.map { |key| params[key] }
end
private
def default_session; {}; end
# Assist with compatibility when processing `X-Forwarded-For`.
def wrap_ipv6(host)
# Even thought IPv6 addresses should be wrapped in square brackets,
# sometimes this is not done in various legacy/underspecified headers.
# So we try to fix this situation for compatibility reasons.
# Try to detect IPv6 addresses which aren't escaped yet:
if !host.start_with?('[') && host.count(':') > 1
"[#{host}]"
else
host
end
end
def parse_http_accept_header(header)
header.to_s.split(",").each(&:strip!).map do |part|
attribute, parameters = part.split(";", 2).each(&:strip!)
quality = 1.0
if parameters and /\Aq=([\d.]+)/ =~ parameters
quality = $1.to_f
end
[attribute, quality]
end
end
# Get an array of values set in the RFC 7239 `Forwarded` request header.
def get_http_forwarded(token)
Utils.forwarded_values(get_header(HTTP_FORWARDED))&.[](token)
end
def query_parser
Utils.default_query_parser
end
def parse_query(qs, d = '&')
query_parser.parse_nested_query(qs, d)
end
def parse_multipart
Rack::Multipart.extract_multipart(self, query_parser)
end
def split_header(value)
value ? value.strip.split(/[,\s]+/) : []
end
# ipv6 extracted from resolv stdlib, simplified
# to remove numbered match group creation.
ipv6 = Regexp.union(
/(?:[0-9A-Fa-f]{1,4}:){7}
[0-9A-Fa-f]{1,4}/x,
/(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)? ::
(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?/x,
/(?:[0-9A-Fa-f]{1,4}:){6,6}
\d+\.\d+\.\d+\.\d+/x,
/(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)? ::
(?:[0-9A-Fa-f]{1,4}:)*
\d+\.\d+\.\d+\.\d+/x,
/[Ff][Ee]80
(?::[0-9A-Fa-f]{1,4}){7}
%[-0-9A-Za-z._~]+/x,
/[Ff][Ee]80:
(?:
(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)? ::
(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?
|
:(?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?
)?
:[0-9A-Fa-f]{1,4}%[-0-9A-Za-z._~]+/x)
AUTHORITY = /
\A
(?<host>
# Match IPv6 as a string of hex digits and colons in square brackets
\[(?<address>#{ipv6})\]
|
# Match any other printable string (except square brackets) as a hostname
(?<address>[[[:graph:]&&[^\[\]]]]*?)
)
(:(?<port>\d+))?
\z
/x
private_constant :AUTHORITY
def split_authority(authority)
return [] if authority.nil?
return [] unless match = AUTHORITY.match(authority)
return match[:host], match[:address], match[:port]&.to_i
end
def reject_trusted_ip_addresses(ip_addresses)
ip_addresses.reject { |ip| trusted_proxy?(ip) }
end
FORWARDED_SCHEME_HEADERS = {
proto: HTTP_X_FORWARDED_PROTO,
scheme: HTTP_X_FORWARDED_SCHEME
}.freeze
private_constant :FORWARDED_SCHEME_HEADERS
def forwarded_scheme
forwarded_priority.each do |type|
case type
when :forwarded
if (forwarded_proto = get_http_forwarded(:proto)) &&
(scheme = allowed_scheme(forwarded_proto.last))
return scheme
end
when :x_forwarded
x_forwarded_proto_priority.each do |x_type|
if header = FORWARDED_SCHEME_HEADERS[x_type]
split_header(get_header(header)).reverse_each do |scheme|
if allowed_scheme(scheme)
return scheme
end
end
end
end
end
end
nil
end
def allowed_scheme(header)
header if ALLOWED_SCHEMES.include?(header)
end
def forwarded_priority
Request.forwarded_priority
end
def x_forwarded_proto_priority
Request.x_forwarded_proto_priority
end
end
include Env
include Helpers
end
end
# :nocov:
require_relative 'multipart' unless defined?(Rack::Multipart)
# :nocov:
share/gems/gems/rack-3.0.8/lib/rack/cascade.rb 0000644 00000004401 15173517742 0014531 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
module Rack
# Rack::Cascade tries a request on several apps, and returns the
# first response that is not 404 or 405 (or in a list of configured
# status codes). If all applications tried return one of the configured
# status codes, return the last response.
class Cascade
# deprecated, no longer used
NotFound = [404, { CONTENT_TYPE => "text/plain" }, []]
# An array of applications to try in order.
attr_reader :apps
# Set the apps to send requests to, and what statuses result in
# cascading. Arguments:
#
# apps: An enumerable of rack applications.
# cascade_for: The statuses to use cascading for. If a response is received
# from an app, the next app is tried.
def initialize(apps, cascade_for = [404, 405])
@apps = []
apps.each { |app| add app }
@cascade_for = {}
[*cascade_for].each { |status| @cascade_for[status] = true }
end
# Call each app in order. If the responses uses a status that requires
# cascading, try the next app. If all responses require cascading,
# return the response from the last app.
def call(env)
return [404, { CONTENT_TYPE => "text/plain" }, []] if @apps.empty?
result = nil
last_body = nil
@apps.each do |app|
# The SPEC says that the body must be closed after it has been iterated
# by the server, or if it is replaced by a middleware action. Cascade
# replaces the body each time a cascade happens. It is assumed that nil
# does not respond to close, otherwise the previous application body
# will be closed. The final application body will not be closed, as it
# will be passed to the server as a result.
last_body.close if last_body.respond_to? :close
result = app.call(env)
return result unless @cascade_for.include?(result[0].to_i)
last_body = result[2]
end
result
end
# Append an app to the list of apps to cascade. This app will
# be tried last.
def add(app)
@apps << app
end
# Whether the given app is one of the apps to cascade to.
def include?(app)
@apps.include?(app)
end
alias_method :<<, :add
end
end
share/gems/gems/rack-3.0.8/lib/rack/rewindable_input.rb 0000644 00000006176 15173517742 0016514 0 ustar 00 # -*- encoding: binary -*-
# frozen_string_literal: true
require 'tempfile'
require_relative 'constants'
module Rack
# Class which can make any IO object rewindable, including non-rewindable ones. It does
# this by buffering the data into a tempfile, which is rewindable.
#
# Don't forget to call #close when you're done. This frees up temporary resources that
# RewindableInput uses, though it does *not* close the original IO object.
class RewindableInput
# Makes rack.input rewindable, for compatibility with applications and middleware
# designed for earlier versions of Rack (where rack.input was required to be
# rewindable).
class Middleware
def initialize(app)
@app = app
end
def call(env)
env[RACK_INPUT] = RewindableInput.new(env[RACK_INPUT])
@app.call(env)
end
end
def initialize(io)
@io = io
@rewindable_io = nil
@unlinked = false
end
def gets
make_rewindable unless @rewindable_io
@rewindable_io.gets
end
def read(*args)
make_rewindable unless @rewindable_io
@rewindable_io.read(*args)
end
def each(&block)
make_rewindable unless @rewindable_io
@rewindable_io.each(&block)
end
def rewind
make_rewindable unless @rewindable_io
@rewindable_io.rewind
end
def size
make_rewindable unless @rewindable_io
@rewindable_io.size
end
# Closes this RewindableInput object without closing the originally
# wrapped IO object. Cleans up any temporary resources that this RewindableInput
# has created.
#
# This method may be called multiple times. It does nothing on subsequent calls.
def close
if @rewindable_io
if @unlinked
@rewindable_io.close
else
@rewindable_io.close!
end
@rewindable_io = nil
end
end
private
def make_rewindable
# Buffer all data into a tempfile. Since this tempfile is private to this
# RewindableInput object, we chmod it so that nobody else can read or write
# it. On POSIX filesystems we also unlink the file so that it doesn't
# even have a file entry on the filesystem anymore, though we can still
# access it because we have the file handle open.
@rewindable_io = Tempfile.new('RackRewindableInput')
@rewindable_io.chmod(0000)
@rewindable_io.set_encoding(Encoding::BINARY)
@rewindable_io.binmode
# :nocov:
if filesystem_has_posix_semantics?
raise 'Unlink failed. IO closed.' if @rewindable_io.closed?
@unlinked = true
end
# :nocov:
buffer = "".dup
while @io.read(1024 * 4, buffer)
entire_buffer_written_out = false
while !entire_buffer_written_out
written = @rewindable_io.write(buffer)
entire_buffer_written_out = written == buffer.bytesize
if !entire_buffer_written_out
buffer.slice!(0 .. written - 1)
end
end
end
@rewindable_io.rewind
end
def filesystem_has_posix_semantics?
RUBY_PLATFORM !~ /(mswin|mingw|cygwin|java)/
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/constants.rb 0000644 00000004745 15173517742 0015175 0 ustar 00 # frozen_string_literal: true
module Rack
# Request env keys
HTTP_HOST = 'HTTP_HOST'
HTTP_PORT = 'HTTP_PORT'
HTTPS = 'HTTPS'
PATH_INFO = 'PATH_INFO'
REQUEST_METHOD = 'REQUEST_METHOD'
REQUEST_PATH = 'REQUEST_PATH'
SCRIPT_NAME = 'SCRIPT_NAME'
QUERY_STRING = 'QUERY_STRING'
SERVER_PROTOCOL = 'SERVER_PROTOCOL'
SERVER_NAME = 'SERVER_NAME'
SERVER_PORT = 'SERVER_PORT'
HTTP_COOKIE = 'HTTP_COOKIE'
# Response Header Keys
CACHE_CONTROL = 'cache-control'
CONTENT_LENGTH = 'content-length'
CONTENT_TYPE = 'content-type'
ETAG = 'etag'
EXPIRES = 'expires'
SET_COOKIE = 'set-cookie'
TRANSFER_ENCODING = 'transfer-encoding'
# HTTP method verbs
GET = 'GET'
POST = 'POST'
PUT = 'PUT'
PATCH = 'PATCH'
DELETE = 'DELETE'
HEAD = 'HEAD'
OPTIONS = 'OPTIONS'
LINK = 'LINK'
UNLINK = 'UNLINK'
TRACE = 'TRACE'
# Rack environment variables
RACK_VERSION = 'rack.version'
RACK_TEMPFILES = 'rack.tempfiles'
RACK_ERRORS = 'rack.errors'
RACK_LOGGER = 'rack.logger'
RACK_INPUT = 'rack.input'
RACK_SESSION = 'rack.session'
RACK_SESSION_OPTIONS = 'rack.session.options'
RACK_SHOWSTATUS_DETAIL = 'rack.showstatus.detail'
RACK_URL_SCHEME = 'rack.url_scheme'
RACK_HIJACK = 'rack.hijack'
RACK_IS_HIJACK = 'rack.hijack?'
RACK_RECURSIVE_INCLUDE = 'rack.recursive.include'
RACK_MULTIPART_BUFFER_SIZE = 'rack.multipart.buffer_size'
RACK_MULTIPART_TEMPFILE_FACTORY = 'rack.multipart.tempfile_factory'
RACK_RESPONSE_FINISHED = 'rack.response_finished'
RACK_REQUEST_FORM_INPUT = 'rack.request.form_input'
RACK_REQUEST_FORM_HASH = 'rack.request.form_hash'
RACK_REQUEST_FORM_VARS = 'rack.request.form_vars'
RACK_REQUEST_FORM_ERROR = 'rack.request.form_error'
RACK_REQUEST_COOKIE_HASH = 'rack.request.cookie_hash'
RACK_REQUEST_COOKIE_STRING = 'rack.request.cookie_string'
RACK_REQUEST_QUERY_HASH = 'rack.request.query_hash'
RACK_REQUEST_QUERY_STRING = 'rack.request.query_string'
RACK_METHODOVERRIDE_ORIGINAL_METHOD = 'rack.methodoverride.original_method'
end
share/gems/gems/rack-3.0.8/lib/rack/utils.rb 0000644 00000052143 15173517742 0014314 0 ustar 00 # -*- encoding: binary -*-
# frozen_string_literal: true
require 'uri'
require 'fileutils'
require 'set'
require 'tempfile'
require 'time'
require_relative 'query_parser'
require_relative 'mime'
require_relative 'headers'
require_relative 'constants'
module Rack
# Rack::Utils contains a grab-bag of useful methods for writing web
# applications adopted from all kinds of Ruby libraries.
module Utils
ParameterTypeError = QueryParser::ParameterTypeError
InvalidParameterError = QueryParser::InvalidParameterError
ParamsTooDeepError = QueryParser::ParamsTooDeepError
DEFAULT_SEP = QueryParser::DEFAULT_SEP
COMMON_SEP = QueryParser::COMMON_SEP
KeySpaceConstrainedParams = QueryParser::Params
class << self
attr_accessor :default_query_parser
end
# The default amount of nesting to allowed by hash parameters.
# This helps prevent a rogue client from triggering a possible stack overflow
# when parsing parameters.
self.default_query_parser = QueryParser.make_default(32)
module_function
# URI escapes. (CGI style space to +)
def escape(s)
URI.encode_www_form_component(s)
end
# Like URI escaping, but with %20 instead of +. Strictly speaking this is
# true URI escaping.
def escape_path(s)
::URI::DEFAULT_PARSER.escape s
end
# Unescapes the **path** component of a URI. See Rack::Utils.unescape for
# unescaping query parameters or form components.
def unescape_path(s)
::URI::DEFAULT_PARSER.unescape s
end
# Unescapes a URI escaped string with +encoding+. +encoding+ will be the
# target encoding of the string returned, and it defaults to UTF-8
def unescape(s, encoding = Encoding::UTF_8)
URI.decode_www_form_component(s, encoding)
end
class << self
attr_accessor :multipart_total_part_limit
attr_accessor :multipart_file_limit
# multipart_part_limit is the original name of multipart_file_limit, but
# the limit only counts parts with filenames.
alias multipart_part_limit multipart_file_limit
alias multipart_part_limit= multipart_file_limit=
end
# The maximum number of file parts a request can contain. Accepting too
# many parts can lead to the server running out of file handles.
# Set to `0` for no limit.
self.multipart_file_limit = (ENV['RACK_MULTIPART_PART_LIMIT'] || ENV['RACK_MULTIPART_FILE_LIMIT'] || 128).to_i
# The maximum total number of parts a request can contain. Accepting too
# many can lead to excessive memory use and parsing time.
self.multipart_total_part_limit = (ENV['RACK_MULTIPART_TOTAL_PART_LIMIT'] || 4096).to_i
def self.param_depth_limit
default_query_parser.param_depth_limit
end
def self.param_depth_limit=(v)
self.default_query_parser = self.default_query_parser.new_depth_limit(v)
end
def self.key_space_limit
warn("`Rack::Utils.key_space_limit` is deprecated as this value no longer has an effect. It will be removed in Rack 3.1", uplevel: 1)
65536
end
def self.key_space_limit=(v)
warn("`Rack::Utils.key_space_limit=` is deprecated and no longer has an effect. It will be removed in Rack 3.1", uplevel: 1)
end
if defined?(Process::CLOCK_MONOTONIC)
def clock_time
Process.clock_gettime(Process::CLOCK_MONOTONIC)
end
else
# :nocov:
def clock_time
Time.now.to_f
end
# :nocov:
end
def parse_query(qs, d = nil, &unescaper)
Rack::Utils.default_query_parser.parse_query(qs, d, &unescaper)
end
def parse_nested_query(qs, d = nil)
Rack::Utils.default_query_parser.parse_nested_query(qs, d)
end
def build_query(params)
params.map { |k, v|
if v.class == Array
build_query(v.map { |x| [k, x] })
else
v.nil? ? escape(k) : "#{escape(k)}=#{escape(v)}"
end
}.join("&")
end
def build_nested_query(value, prefix = nil)
case value
when Array
value.map { |v|
build_nested_query(v, "#{prefix}[]")
}.join("&")
when Hash
value.map { |k, v|
build_nested_query(v, prefix ? "#{prefix}[#{k}]" : k)
}.delete_if(&:empty?).join('&')
when nil
escape(prefix)
else
raise ArgumentError, "value must be a Hash" if prefix.nil?
"#{escape(prefix)}=#{escape(value)}"
end
end
def q_values(q_value_header)
q_value_header.to_s.split(/\s*,\s*/).map do |part|
value, parameters = part.split(/\s*;\s*/, 2)
quality = 1.0
if parameters && (md = /\Aq=([\d.]+)/.match(parameters))
quality = md[1].to_f
end
[value, quality]
end
end
def forwarded_values(forwarded_header)
return nil unless forwarded_header
forwarded_header = forwarded_header.to_s.gsub("\n", ";")
forwarded_header.split(/\s*;\s*/).each_with_object({}) do |field, values|
field.split(/\s*,\s*/).each do |pair|
return nil unless pair =~ /\A\s*(by|for|host|proto)\s*=\s*"?([^"]+)"?\s*\Z/i
(values[$1.downcase.to_sym] ||= []) << $2
end
end
end
module_function :forwarded_values
# Return best accept value to use, based on the algorithm
# in RFC 2616 Section 14. If there are multiple best
# matches (same specificity and quality), the value returned
# is arbitrary.
def best_q_match(q_value_header, available_mimes)
values = q_values(q_value_header)
matches = values.map do |req_mime, quality|
match = available_mimes.find { |am| Rack::Mime.match?(am, req_mime) }
next unless match
[match, quality]
end.compact.sort_by do |match, quality|
(match.split('/', 2).count('*') * -10) + quality
end.last
matches&.first
end
ESCAPE_HTML = {
"&" => "&",
"<" => "<",
">" => ">",
"'" => "'",
'"' => """,
"/" => "/"
}
ESCAPE_HTML_PATTERN = Regexp.union(*ESCAPE_HTML.keys)
# Escape ampersands, brackets and quotes to their HTML/XML entities.
def escape_html(string)
string.to_s.gsub(ESCAPE_HTML_PATTERN){|c| ESCAPE_HTML[c] }
end
def select_best_encoding(available_encodings, accept_encoding)
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
expanded_accept_encoding = []
accept_encoding.each do |m, q|
preference = available_encodings.index(m) || available_encodings.size
if m == "*"
(available_encodings - accept_encoding.map(&:first)).each do |m2|
expanded_accept_encoding << [m2, q, preference]
end
else
expanded_accept_encoding << [m, q, preference]
end
end
encoding_candidates = expanded_accept_encoding
.sort_by { |_, q, p| [-q, p] }
.map!(&:first)
unless encoding_candidates.include?("identity")
encoding_candidates.push("identity")
end
expanded_accept_encoding.each do |m, q|
encoding_candidates.delete(m) if q == 0.0
end
(encoding_candidates & available_encodings)[0]
end
# :call-seq:
# parse_cookies_header(value) -> hash
#
# Parse cookies from the provided header +value+ according to RFC6265. The
# syntax for cookie headers only supports semicolons. Returns a map of
# cookie +key+ to cookie +value+.
#
# parse_cookies_header('myname=myvalue; max-age=0')
# # => {"myname"=>"myvalue", "max-age"=>"0"}
#
def parse_cookies_header(value)
return {} unless value
value.split(/; */n).each_with_object({}) do |cookie, cookies|
next if cookie.empty?
key, value = cookie.split('=', 2)
cookies[key] = (unescape(value) rescue value) unless cookies.key?(key)
end
end
def add_cookie_to_header(header, key, value)
warn("add_cookie_to_header is deprecated and will be removed in Rack 3.1", uplevel: 1)
case header
when nil, ''
return set_cookie_header(key, value)
when String
[header, set_cookie_header(key, value)]
when Array
header + [set_cookie_header(key, value)]
else
raise ArgumentError, "Unrecognized cookie header value. Expected String, Array, or nil, got #{header.inspect}"
end
end
# :call-seq:
# parse_cookies(env) -> hash
#
# Parse cookies from the provided request environment using
# parse_cookies_header. Returns a map of cookie +key+ to cookie +value+.
#
# parse_cookies({'HTTP_COOKIE' => 'myname=myvalue'})
# # => {'myname' => 'myvalue'}
#
def parse_cookies(env)
parse_cookies_header env[HTTP_COOKIE]
end
# :call-seq:
# set_cookie_header(key, value) -> encoded string
#
# Generate an encoded string using the provided +key+ and +value+ suitable
# for the +set-cookie+ header according to RFC6265. The +value+ may be an
# instance of either +String+ or +Hash+.
#
# If the cookie +value+ is an instance of +Hash+, it considers the following
# cookie attribute keys: +domain+, +max_age+, +expires+ (must be instance
# of +Time+), +secure+, +http_only+, +same_site+ and +value+. For more
# details about the interpretation of these fields, consult
# [RFC6265 Section 5.2](https://datatracker.ietf.org/doc/html/rfc6265#section-5.2).
#
# An extra cookie attribute +escape_key+ can be provided to control whether
# or not the cookie key is URL encoded. If explicitly set to +false+, the
# cookie key name will not be url encoded (escaped). The default is +true+.
#
# set_cookie_header("myname", "myvalue")
# # => "myname=myvalue"
#
# set_cookie_header("myname", {value: "myvalue", max_age: 10})
# # => "myname=myvalue; max-age=10"
#
def set_cookie_header(key, value)
case value
when Hash
key = escape(key) unless value[:escape_key] == false
domain = "; domain=#{value[:domain]}" if value[:domain]
path = "; path=#{value[:path]}" if value[:path]
max_age = "; max-age=#{value[:max_age]}" if value[:max_age]
expires = "; expires=#{value[:expires].httpdate}" if value[:expires]
secure = "; secure" if value[:secure]
httponly = "; httponly" if (value.key?(:httponly) ? value[:httponly] : value[:http_only])
same_site =
case value[:same_site]
when false, nil
nil
when :none, 'None', :None
'; SameSite=None'
when :lax, 'Lax', :Lax
'; SameSite=Lax'
when true, :strict, 'Strict', :Strict
'; SameSite=Strict'
else
raise ArgumentError, "Invalid SameSite value: #{value[:same_site].inspect}"
end
value = value[:value]
else
key = escape(key)
end
value = [value] unless Array === value
return "#{key}=#{value.map { |v| escape v }.join('&')}#{domain}" \
"#{path}#{max_age}#{expires}#{secure}#{httponly}#{same_site}"
end
# :call-seq:
# set_cookie_header!(headers, key, value) -> header value
#
# Append a cookie in the specified headers with the given cookie +key+ and
# +value+ using set_cookie_header.
#
# If the headers already contains a +set-cookie+ key, it will be converted
# to an +Array+ if not already, and appended to.
def set_cookie_header!(headers, key, value)
if header = headers[SET_COOKIE]
if header.is_a?(Array)
header << set_cookie_header(key, value)
else
headers[SET_COOKIE] = [header, set_cookie_header(key, value)]
end
else
headers[SET_COOKIE] = set_cookie_header(key, value)
end
end
# :call-seq:
# delete_set_cookie_header(key, value = {}) -> encoded string
#
# Generate an encoded string based on the given +key+ and +value+ using
# set_cookie_header for the purpose of causing the specified cookie to be
# deleted. The +value+ may be an instance of +Hash+ and can include
# attributes as outlined by set_cookie_header. The encoded cookie will have
# a +max_age+ of 0 seconds, an +expires+ date in the past and an empty
# +value+. When used with the +set-cookie+ header, it will cause the client
# to *remove* any matching cookie.
#
# delete_set_cookie_header("myname")
# # => "myname=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 GMT"
#
def delete_set_cookie_header(key, value = {})
set_cookie_header(key, value.merge(max_age: '0', expires: Time.at(0), value: ''))
end
def make_delete_cookie_header(header, key, value)
warn("make_delete_cookie_header is deprecated and will be removed in Rack 3.1, use delete_set_cookie_header! instead", uplevel: 1)
delete_set_cookie_header!(header, key, value)
end
def delete_cookie_header!(headers, key, value = {})
headers[SET_COOKIE] = delete_set_cookie_header!(headers[SET_COOKIE], key, value)
return nil
end
def add_remove_cookie_to_header(header, key, value = {})
warn("add_remove_cookie_to_header is deprecated and will be removed in Rack 3.1, use delete_set_cookie_header! instead", uplevel: 1)
delete_set_cookie_header!(header, key, value)
end
# :call-seq:
# delete_set_cookie_header!(header, key, value = {}) -> header value
#
# Set an expired cookie in the specified headers with the given cookie
# +key+ and +value+ using delete_set_cookie_header. This causes
# the client to immediately delete the specified cookie.
#
# delete_set_cookie_header!(nil, "mycookie")
# # => "mycookie=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 GMT"
#
# If the header is non-nil, it will be modified in place.
#
# header = []
# delete_set_cookie_header!(header, "mycookie")
# # => ["mycookie=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 GMT"]
# header
# # => ["mycookie=; max-age=0; expires=Thu, 01 Jan 1970 00:00:00 GMT"]
#
def delete_set_cookie_header!(header, key, value = {})
if header
header = Array(header)
header << delete_set_cookie_header(key, value)
else
header = delete_set_cookie_header(key, value)
end
return header
end
def rfc2822(time)
time.rfc2822
end
# Parses the "Range:" header, if present, into an array of Range objects.
# Returns nil if the header is missing or syntactically invalid.
# Returns an empty array if none of the ranges are satisfiable.
def byte_ranges(env, size)
get_byte_ranges env['HTTP_RANGE'], size
end
def get_byte_ranges(http_range, size)
# See <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35>
return nil unless http_range && http_range =~ /bytes=([^;]+)/
ranges = []
$1.split(/,\s*/).each do |range_spec|
return nil unless range_spec.include?('-')
range = range_spec.split('-')
r0, r1 = range[0], range[1]
if r0.nil? || r0.empty?
return nil if r1.nil?
# suffix-byte-range-spec, represents trailing suffix of file
r0 = size - r1.to_i
r0 = 0 if r0 < 0
r1 = size - 1
else
r0 = r0.to_i
if r1.nil?
r1 = size - 1
else
r1 = r1.to_i
return nil if r1 < r0 # backwards range is syntactically invalid
r1 = size - 1 if r1 >= size
end
end
ranges << (r0..r1) if r0 <= r1
end
ranges
end
# :nocov:
if defined?(OpenSSL.fixed_length_secure_compare)
# Constant time string comparison.
#
# NOTE: the values compared should be of fixed length, such as strings
# that have already been processed by HMAC. This should not be used
# on variable length plaintext strings because it could leak length info
# via timing attacks.
def secure_compare(a, b)
return false unless a.bytesize == b.bytesize
OpenSSL.fixed_length_secure_compare(a, b)
end
# :nocov:
else
def secure_compare(a, b)
return false unless a.bytesize == b.bytesize
l = a.unpack("C*")
r, i = 0, -1
b.each_byte { |v| r |= v ^ l[i += 1] }
r == 0
end
end
# Context allows the use of a compatible middleware at different points
# in a request handling stack. A compatible middleware must define
# #context which should take the arguments env and app. The first of which
# would be the request environment. The second of which would be the rack
# application that the request would be forwarded to.
class Context
attr_reader :for, :app
def initialize(app_f, app_r)
raise 'running context does not respond to #context' unless app_f.respond_to? :context
@for, @app = app_f, app_r
end
def call(env)
@for.context(env, @app)
end
def recontext(app)
self.class.new(@for, app)
end
def context(env, app = @app)
recontext(app).call(env)
end
end
# A wrapper around Headers
# header when set.
#
# @api private
class HeaderHash < Hash # :nodoc:
def self.[](headers)
warn "Rack::Utils::HeaderHash is deprecated and will be removed in Rack 3.1, switch to Rack::Headers", uplevel: 1
if headers.is_a?(Headers) && !headers.frozen?
return headers
end
new_headers = Headers.new
headers.each{|k,v| new_headers[k] = v}
new_headers
end
def self.new(hash = {})
warn "Rack::Utils::HeaderHash is deprecated and will be removed in Rack 3.1, switch to Rack::Headers", uplevel: 1
headers = Headers.new
hash.each{|k,v| headers[k] = v}
headers
end
def self.allocate
raise TypeError, "cannot allocate HeaderHash"
end
end
# Every standard HTTP code mapped to the appropriate message.
# Generated with:
# curl -s https://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv | \
# ruby -ne 'm = /^(\d{3}),(?!Unassigned|\(Unused\))([^,]+)/.match($_) and \
# puts "#{m[1]} => \x27#{m[2].strip}\x27,"'
HTTP_STATUS_CODES = {
100 => 'Continue',
101 => 'Switching Protocols',
102 => 'Processing',
103 => 'Early Hints',
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
207 => 'Multi-Status',
208 => 'Already Reported',
226 => 'IM Used',
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
306 => '(Unused)',
307 => 'Temporary Redirect',
308 => 'Permanent Redirect',
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Payload Too Large',
414 => 'URI Too Long',
415 => 'Unsupported Media Type',
416 => 'Range Not Satisfiable',
417 => 'Expectation Failed',
421 => 'Misdirected Request',
422 => 'Unprocessable Entity',
423 => 'Locked',
424 => 'Failed Dependency',
425 => 'Too Early',
426 => 'Upgrade Required',
428 => 'Precondition Required',
429 => 'Too Many Requests',
431 => 'Request Header Fields Too Large',
451 => 'Unavailable for Legal Reasons',
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported',
506 => 'Variant Also Negotiates',
507 => 'Insufficient Storage',
508 => 'Loop Detected',
509 => 'Bandwidth Limit Exceeded',
510 => 'Not Extended',
511 => 'Network Authentication Required'
}
# Responses with HTTP status codes that should not have an entity body
STATUS_WITH_NO_ENTITY_BODY = Hash[((100..199).to_a << 204 << 304).product([true])]
SYMBOL_TO_STATUS_CODE = Hash[*HTTP_STATUS_CODES.map { |code, message|
[message.downcase.gsub(/\s|-|'/, '_').to_sym, code]
}.flatten]
def status_code(status)
if status.is_a?(Symbol)
SYMBOL_TO_STATUS_CODE.fetch(status) { raise ArgumentError, "Unrecognized status code #{status.inspect}" }
else
status.to_i
end
end
PATH_SEPS = Regexp.union(*[::File::SEPARATOR, ::File::ALT_SEPARATOR].compact)
def clean_path_info(path_info)
parts = path_info.split PATH_SEPS
clean = []
parts.each do |part|
next if part.empty? || part == '.'
part == '..' ? clean.pop : clean << part
end
clean_path = clean.join(::File::SEPARATOR)
clean_path.prepend("/") if parts.empty? || parts.first.empty?
clean_path
end
NULL_BYTE = "\0"
def valid_path?(path)
path.valid_encoding? && !path.include?(NULL_BYTE)
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/content_type.rb 0000644 00000001267 15173517742 0015670 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
module Rack
# Sets the content-type header on responses which don't have one.
#
# Builder Usage:
# use Rack::ContentType, "text/plain"
#
# When no content type argument is provided, "text/html" is the
# default.
class ContentType
include Rack::Utils
def initialize(app, content_type = "text/html")
@app = app
@content_type = content_type
end
def call(env)
status, headers, _ = response = @app.call(env)
unless STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i)
headers[CONTENT_TYPE] ||= @content_type
end
response
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/reloader.rb 0000644 00000006027 15173517742 0014751 0 ustar 00 # frozen_string_literal: true
# Copyright (C) 2009-2018 Michael Fellinger <m.fellinger@gmail.com>
# Rack::Reloader is subject to the terms of an MIT-style license.
# See MIT-LICENSE or https://opensource.org/licenses/MIT.
require 'pathname'
module Rack
# High performant source reloader
#
# This class acts as Rack middleware.
#
# What makes it especially suited for use in a production environment is that
# any file will only be checked once and there will only be made one system
# call stat(2).
#
# Please note that this will not reload files in the background, it does so
# only when actively called.
#
# It is performing a check/reload cycle at the start of every request, but
# also respects a cool down time, during which nothing will be done.
class Reloader
def initialize(app, cooldown = 10, backend = Stat)
@app = app
@cooldown = cooldown
@last = (Time.now - cooldown)
@cache = {}
@mtimes = {}
@reload_mutex = Mutex.new
extend backend
end
def call(env)
if @cooldown and Time.now > @last + @cooldown
if Thread.list.size > 1
@reload_mutex.synchronize{ reload! }
else
reload!
end
@last = Time.now
end
@app.call(env)
end
def reload!(stderr = $stderr)
rotation do |file, mtime|
previous_mtime = @mtimes[file] ||= mtime
safe_load(file, mtime, stderr) if mtime > previous_mtime
end
end
# A safe Kernel::load, issuing the hooks depending on the results
def safe_load(file, mtime, stderr = $stderr)
load(file)
stderr.puts "#{self.class}: reloaded `#{file}'"
file
rescue LoadError, SyntaxError => ex
stderr.puts ex
ensure
@mtimes[file] = mtime
end
module Stat
def rotation
files = [$0, *$LOADED_FEATURES].uniq
paths = ['./', *$LOAD_PATH].uniq
files.map{|file|
next if /\.(so|bundle)$/.match?(file) # cannot reload compiled files
found, stat = figure_path(file, paths)
next unless found && stat && mtime = stat.mtime
@cache[file] = found
yield(found, mtime)
}.compact
end
# Takes a relative or absolute +file+ name, a couple possible +paths+ that
# the +file+ might reside in. Returns the full path and File::Stat for the
# path.
def figure_path(file, paths)
found = @cache[file]
found = file if !found and Pathname.new(file).absolute?
found, stat = safe_stat(found)
return found, stat if found
paths.find do |possible_path|
path = ::File.join(possible_path, file)
found, stat = safe_stat(path)
return ::File.expand_path(found), stat if found
end
return false, false
end
def safe_stat(file)
return unless file
stat = ::File.stat(file)
return file, stat if stat.file?
rescue Errno::ENOENT, Errno::ENOTDIR, Errno::ESRCH
@cache.delete(file) and false
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/multipart.rb 0000644 00000002252 15173517742 0015171 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
require_relative 'multipart/parser'
require_relative 'multipart/generator'
module Rack
# A multipart form data parser, adapted from IOWA.
#
# Usually, Rack::Request#POST takes care of calling this.
module Multipart
MULTIPART_BOUNDARY = "AaB03x"
class << self
def parse_multipart(env, params = Rack::Utils.default_query_parser)
io = env[RACK_INPUT]
if content_length = env['CONTENT_LENGTH']
content_length = content_length.to_i
end
content_type = env['CONTENT_TYPE']
tempfile = env[RACK_MULTIPART_TEMPFILE_FACTORY] || Parser::TEMPFILE_FACTORY
bufsize = env[RACK_MULTIPART_BUFFER_SIZE] || Parser::BUFSIZE
info = Parser.parse(io, content_length, content_type, tempfile, bufsize, params)
env[RACK_TEMPFILES] = info.tmp_files
return info.params
end
def extract_multipart(request, params = Rack::Utils.default_query_parser)
parse_multipart(request.env)
end
def build_multipart(params, first = true)
Generator.new(params, first).dump
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/recursive.rb 0000644 00000003436 15173517742 0015164 0 ustar 00 # frozen_string_literal: true
require 'uri'
require_relative 'constants'
module Rack
# Rack::ForwardRequest gets caught by Rack::Recursive and redirects
# the current request to the app at +url+.
#
# raise ForwardRequest.new("/not-found")
#
class ForwardRequest < Exception
attr_reader :url, :env
def initialize(url, env = {})
@url = URI(url)
@env = env
@env[PATH_INFO] = @url.path
@env[QUERY_STRING] = @url.query if @url.query
@env[HTTP_HOST] = @url.host if @url.host
@env[HTTP_PORT] = @url.port if @url.port
@env[RACK_URL_SCHEME] = @url.scheme if @url.scheme
super "forwarding to #{url}"
end
end
# Rack::Recursive allows applications called down the chain to
# include data from other applications (by using
# <tt>rack['rack.recursive.include'][...]</tt> or raise a
# ForwardRequest to redirect internally.
class Recursive
def initialize(app)
@app = app
end
def call(env)
dup._call(env)
end
def _call(env)
@script_name = env[SCRIPT_NAME]
@app.call(env.merge(RACK_RECURSIVE_INCLUDE => method(:include)))
rescue ForwardRequest => req
call(env.merge(req.env))
end
def include(env, path)
unless path.index(@script_name) == 0 && (path[@script_name.size] == ?/ ||
path[@script_name.size].nil?)
raise ArgumentError, "can only include below #{@script_name}, not #{path}"
end
env = env.merge(PATH_INFO => path,
SCRIPT_NAME => @script_name,
REQUEST_METHOD => GET,
"CONTENT_LENGTH" => "0", "CONTENT_TYPE" => "",
RACK_INPUT => StringIO.new(""))
@app.call(env)
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/content_length.rb 0000644 00000001446 15173517742 0016167 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
module Rack
# Sets the content-length header on responses that do not specify
# a content-length or transfer-encoding header. Note that this
# does not fix responses that have an invalid content-length
# header specified.
class ContentLength
include Rack::Utils
def initialize(app)
@app = app
end
def call(env)
status, headers, body = response = @app.call(env)
if !STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) &&
!headers[CONTENT_LENGTH] &&
!headers[TRANSFER_ENCODING] &&
body.respond_to?(:to_ary)
response[2] = body = body.to_ary
headers[CONTENT_LENGTH] = body.sum(&:bytesize).to_s
end
response
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/runtime.rb 0000644 00000001546 15173517742 0014640 0 ustar 00 # frozen_string_literal: true
require_relative 'utils'
module Rack
# Sets an "x-runtime" response header, indicating the response
# time of the request, in seconds
#
# You can put it right before the application to see the processing
# time, or before all the other middlewares to include time for them,
# too.
class Runtime
FORMAT_STRING = "%0.6f" # :nodoc:
HEADER_NAME = "x-runtime" # :nodoc:
def initialize(app, name = nil)
@app = app
@header_name = HEADER_NAME
@header_name += "-#{name.to_s.downcase}" if name
end
def call(env)
start_time = Utils.clock_time
_, headers, _ = response = @app.call(env)
request_time = Utils.clock_time - start_time
unless headers.key?(@header_name)
headers[@header_name] = FORMAT_STRING % request_time
end
response
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/mock_response.rb 0000644 00000006433 15173517742 0016024 0 ustar 00 # frozen_string_literal: true
require 'cgi/cookie'
require 'time'
require_relative 'response'
module Rack
# Rack::MockResponse provides useful helpers for testing your apps.
# Usually, you don't create the MockResponse on your own, but use
# MockRequest.
class MockResponse < Rack::Response
class << self
alias [] new
end
# Headers
attr_reader :original_headers, :cookies
# Errors
attr_accessor :errors
def initialize(status, headers, body, errors = nil)
@original_headers = headers
if errors
@errors = errors.string if errors.respond_to?(:string)
else
@errors = ""
end
super(body, status, headers)
@cookies = parse_cookies_from_header
buffered_body!
end
def =~(other)
body =~ other
end
def match(other)
body.match other
end
def body
return @buffered_body if defined?(@buffered_body)
# FIXME: apparently users of MockResponse expect the return value of
# MockResponse#body to be a string. However, the real response object
# returns the body as a list.
#
# See spec_showstatus.rb:
#
# should "not replace existing messages" do
# ...
# res.body.should == "foo!"
# end
buffer = @buffered_body = String.new
@body.each do |chunk|
buffer << chunk
end
return buffer
end
def empty?
[201, 204, 304].include? status
end
def cookie(name)
cookies.fetch(name, nil)
end
private
def parse_cookies_from_header
cookies = Hash.new
if headers.has_key? 'set-cookie'
set_cookie_header = headers.fetch('set-cookie')
Array(set_cookie_header).each do |header_value|
header_value.split("\n").each do |cookie|
cookie_name, cookie_filling = cookie.split('=', 2)
cookie_attributes = identify_cookie_attributes cookie_filling
parsed_cookie = CGI::Cookie.new(
'name' => cookie_name.strip,
'value' => cookie_attributes.fetch('value'),
'path' => cookie_attributes.fetch('path', nil),
'domain' => cookie_attributes.fetch('domain', nil),
'expires' => cookie_attributes.fetch('expires', nil),
'secure' => cookie_attributes.fetch('secure', false)
)
cookies.store(cookie_name, parsed_cookie)
end
end
end
cookies
end
def identify_cookie_attributes(cookie_filling)
cookie_bits = cookie_filling.split(';')
cookie_attributes = Hash.new
cookie_attributes.store('value', cookie_bits[0].strip)
cookie_bits.drop(1).each do |bit|
if bit.include? '='
cookie_attribute, attribute_value = bit.split('=', 2)
cookie_attributes.store(cookie_attribute.strip.downcase, attribute_value.strip)
end
if bit.include? 'secure'
cookie_attributes.store('secure', true)
end
end
if cookie_attributes.key? 'max-age'
cookie_attributes.store('expires', Time.now + cookie_attributes['max-age'].to_i)
elsif cookie_attributes.key? 'expires'
cookie_attributes.store('expires', Time.httpdate(cookie_attributes['expires']))
end
cookie_attributes
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/mime.rb 0000644 00000101301 15173517742 0014072 0 ustar 00 # frozen_string_literal: true
module Rack
module Mime
# Returns String with mime type if found, otherwise use +fallback+.
# +ext+ should be filename extension in the '.ext' format that
# File.extname(file) returns.
# +fallback+ may be any object
#
# Also see the documentation for MIME_TYPES
#
# Usage:
# Rack::Mime.mime_type('.foo')
#
# This is a shortcut for:
# Rack::Mime::MIME_TYPES.fetch('.foo', 'application/octet-stream')
def mime_type(ext, fallback = 'application/octet-stream')
MIME_TYPES.fetch(ext.to_s.downcase, fallback)
end
module_function :mime_type
# Returns true if the given value is a mime match for the given mime match
# specification, false otherwise.
#
# Rack::Mime.match?('text/html', 'text/*') => true
# Rack::Mime.match?('text/plain', '*') => true
# Rack::Mime.match?('text/html', 'application/json') => false
def match?(value, matcher)
v1, v2 = value.split('/', 2)
m1, m2 = matcher.split('/', 2)
(m1 == '*' || v1 == m1) && (m2.nil? || m2 == '*' || m2 == v2)
end
module_function :match?
# List of most common mime-types, selected various sources
# according to their usefulness in a webserving scope for Ruby
# users.
#
# To amend this list with your local mime.types list you can use:
#
# require 'webrick/httputils'
# list = WEBrick::HTTPUtils.load_mime_types('/etc/mime.types')
# Rack::Mime::MIME_TYPES.merge!(list)
#
# N.B. On Ubuntu the mime.types file does not include the leading period, so
# users may need to modify the data before merging into the hash.
MIME_TYPES = {
".123" => "application/vnd.lotus-1-2-3",
".3dml" => "text/vnd.in3d.3dml",
".3g2" => "video/3gpp2",
".3gp" => "video/3gpp",
".a" => "application/octet-stream",
".acc" => "application/vnd.americandynamics.acc",
".ace" => "application/x-ace-compressed",
".acu" => "application/vnd.acucobol",
".aep" => "application/vnd.audiograph",
".afp" => "application/vnd.ibm.modcap",
".ai" => "application/postscript",
".aif" => "audio/x-aiff",
".aiff" => "audio/x-aiff",
".ami" => "application/vnd.amiga.ami",
".apng" => "image/apng",
".appcache" => "text/cache-manifest",
".apr" => "application/vnd.lotus-approach",
".asc" => "application/pgp-signature",
".asf" => "video/x-ms-asf",
".asm" => "text/x-asm",
".aso" => "application/vnd.accpac.simply.aso",
".asx" => "video/x-ms-asf",
".atc" => "application/vnd.acucorp",
".atom" => "application/atom+xml",
".atomcat" => "application/atomcat+xml",
".atomsvc" => "application/atomsvc+xml",
".atx" => "application/vnd.antix.game-component",
".au" => "audio/basic",
".avi" => "video/x-msvideo",
".avif" => "image/avif",
".bat" => "application/x-msdownload",
".bcpio" => "application/x-bcpio",
".bdm" => "application/vnd.syncml.dm+wbxml",
".bh2" => "application/vnd.fujitsu.oasysprs",
".bin" => "application/octet-stream",
".bmi" => "application/vnd.bmi",
".bmp" => "image/bmp",
".box" => "application/vnd.previewsystems.box",
".btif" => "image/prs.btif",
".bz" => "application/x-bzip",
".bz2" => "application/x-bzip2",
".c" => "text/x-c",
".c4g" => "application/vnd.clonk.c4group",
".cab" => "application/vnd.ms-cab-compressed",
".cc" => "text/x-c",
".ccxml" => "application/ccxml+xml",
".cdbcmsg" => "application/vnd.contact.cmsg",
".cdkey" => "application/vnd.mediastation.cdkey",
".cdx" => "chemical/x-cdx",
".cdxml" => "application/vnd.chemdraw+xml",
".cdy" => "application/vnd.cinderella",
".cer" => "application/pkix-cert",
".cgm" => "image/cgm",
".chat" => "application/x-chat",
".chm" => "application/vnd.ms-htmlhelp",
".chrt" => "application/vnd.kde.kchart",
".cif" => "chemical/x-cif",
".cii" => "application/vnd.anser-web-certificate-issue-initiation",
".cil" => "application/vnd.ms-artgalry",
".cla" => "application/vnd.claymore",
".class" => "application/octet-stream",
".clkk" => "application/vnd.crick.clicker.keyboard",
".clkp" => "application/vnd.crick.clicker.palette",
".clkt" => "application/vnd.crick.clicker.template",
".clkw" => "application/vnd.crick.clicker.wordbank",
".clkx" => "application/vnd.crick.clicker",
".clp" => "application/x-msclip",
".cmc" => "application/vnd.cosmocaller",
".cmdf" => "chemical/x-cmdf",
".cml" => "chemical/x-cml",
".cmp" => "application/vnd.yellowriver-custom-menu",
".cmx" => "image/x-cmx",
".com" => "application/x-msdownload",
".conf" => "text/plain",
".cpio" => "application/x-cpio",
".cpp" => "text/x-c",
".cpt" => "application/mac-compactpro",
".crd" => "application/x-mscardfile",
".crl" => "application/pkix-crl",
".crt" => "application/x-x509-ca-cert",
".csh" => "application/x-csh",
".csml" => "chemical/x-csml",
".csp" => "application/vnd.commonspace",
".css" => "text/css",
".csv" => "text/csv",
".curl" => "application/vnd.curl",
".cww" => "application/prs.cww",
".cxx" => "text/x-c",
".daf" => "application/vnd.mobius.daf",
".davmount" => "application/davmount+xml",
".dcr" => "application/x-director",
".dd2" => "application/vnd.oma.dd2+xml",
".ddd" => "application/vnd.fujixerox.ddd",
".deb" => "application/x-debian-package",
".der" => "application/x-x509-ca-cert",
".dfac" => "application/vnd.dreamfactory",
".diff" => "text/x-diff",
".dis" => "application/vnd.mobius.dis",
".djv" => "image/vnd.djvu",
".djvu" => "image/vnd.djvu",
".dll" => "application/x-msdownload",
".dmg" => "application/octet-stream",
".dna" => "application/vnd.dna",
".doc" => "application/msword",
".docm" => "application/vnd.ms-word.document.macroEnabled.12",
".docx" => "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
".dot" => "application/msword",
".dotm" => "application/vnd.ms-word.template.macroEnabled.12",
".dotx" => "application/vnd.openxmlformats-officedocument.wordprocessingml.template",
".dp" => "application/vnd.osgi.dp",
".dpg" => "application/vnd.dpgraph",
".dsc" => "text/prs.lines.tag",
".dtd" => "application/xml-dtd",
".dts" => "audio/vnd.dts",
".dtshd" => "audio/vnd.dts.hd",
".dv" => "video/x-dv",
".dvi" => "application/x-dvi",
".dwf" => "model/vnd.dwf",
".dwg" => "image/vnd.dwg",
".dxf" => "image/vnd.dxf",
".dxp" => "application/vnd.spotfire.dxp",
".ear" => "application/java-archive",
".ecelp4800" => "audio/vnd.nuera.ecelp4800",
".ecelp7470" => "audio/vnd.nuera.ecelp7470",
".ecelp9600" => "audio/vnd.nuera.ecelp9600",
".ecma" => "application/ecmascript",
".edm" => "application/vnd.novadigm.edm",
".edx" => "application/vnd.novadigm.edx",
".efif" => "application/vnd.picsel",
".ei6" => "application/vnd.pg.osasli",
".eml" => "message/rfc822",
".eol" => "audio/vnd.digital-winds",
".eot" => "application/vnd.ms-fontobject",
".eps" => "application/postscript",
".es3" => "application/vnd.eszigno3+xml",
".esf" => "application/vnd.epson.esf",
".etx" => "text/x-setext",
".exe" => "application/x-msdownload",
".ext" => "application/vnd.novadigm.ext",
".ez" => "application/andrew-inset",
".ez2" => "application/vnd.ezpix-album",
".ez3" => "application/vnd.ezpix-package",
".f" => "text/x-fortran",
".f77" => "text/x-fortran",
".f90" => "text/x-fortran",
".fbs" => "image/vnd.fastbidsheet",
".fdf" => "application/vnd.fdf",
".fe_launch" => "application/vnd.denovo.fcselayout-link",
".fg5" => "application/vnd.fujitsu.oasysgp",
".fli" => "video/x-fli",
".flif" => "image/flif",
".flo" => "application/vnd.micrografx.flo",
".flv" => "video/x-flv",
".flw" => "application/vnd.kde.kivio",
".flx" => "text/vnd.fmi.flexstor",
".fly" => "text/vnd.fly",
".fm" => "application/vnd.framemaker",
".fnc" => "application/vnd.frogans.fnc",
".for" => "text/x-fortran",
".fpx" => "image/vnd.fpx",
".fsc" => "application/vnd.fsc.weblaunch",
".fst" => "image/vnd.fst",
".ftc" => "application/vnd.fluxtime.clip",
".fti" => "application/vnd.anser-web-funds-transfer-initiation",
".fvt" => "video/vnd.fvt",
".fzs" => "application/vnd.fuzzysheet",
".g3" => "image/g3fax",
".gac" => "application/vnd.groove-account",
".gdl" => "model/vnd.gdl",
".gem" => "application/octet-stream",
".gemspec" => "text/x-script.ruby",
".ghf" => "application/vnd.groove-help",
".gif" => "image/gif",
".gim" => "application/vnd.groove-identity-message",
".gmx" => "application/vnd.gmx",
".gph" => "application/vnd.flographit",
".gqf" => "application/vnd.grafeq",
".gram" => "application/srgs",
".grv" => "application/vnd.groove-injector",
".grxml" => "application/srgs+xml",
".gtar" => "application/x-gtar",
".gtm" => "application/vnd.groove-tool-message",
".gtw" => "model/vnd.gtw",
".gv" => "text/vnd.graphviz",
".gz" => "application/x-gzip",
".h" => "text/x-c",
".h261" => "video/h261",
".h263" => "video/h263",
".h264" => "video/h264",
".hbci" => "application/vnd.hbci",
".hdf" => "application/x-hdf",
".heic" => "image/heic",
".heics" => "image/heic-sequence",
".heif" => "image/heif",
".heifs" => "image/heif-sequence",
".hh" => "text/x-c",
".hlp" => "application/winhlp",
".hpgl" => "application/vnd.hp-hpgl",
".hpid" => "application/vnd.hp-hpid",
".hps" => "application/vnd.hp-hps",
".hqx" => "application/mac-binhex40",
".htc" => "text/x-component",
".htke" => "application/vnd.kenameaapp",
".htm" => "text/html",
".html" => "text/html",
".hvd" => "application/vnd.yamaha.hv-dic",
".hvp" => "application/vnd.yamaha.hv-voice",
".hvs" => "application/vnd.yamaha.hv-script",
".icc" => "application/vnd.iccprofile",
".ice" => "x-conference/x-cooltalk",
".ico" => "image/vnd.microsoft.icon",
".ics" => "text/calendar",
".ief" => "image/ief",
".ifb" => "text/calendar",
".ifm" => "application/vnd.shana.informed.formdata",
".igl" => "application/vnd.igloader",
".igs" => "model/iges",
".igx" => "application/vnd.micrografx.igx",
".iif" => "application/vnd.shana.informed.interchange",
".imp" => "application/vnd.accpac.simply.imp",
".ims" => "application/vnd.ms-ims",
".ipk" => "application/vnd.shana.informed.package",
".irm" => "application/vnd.ibm.rights-management",
".irp" => "application/vnd.irepository.package+xml",
".iso" => "application/octet-stream",
".itp" => "application/vnd.shana.informed.formtemplate",
".ivp" => "application/vnd.immervision-ivp",
".ivu" => "application/vnd.immervision-ivu",
".jad" => "text/vnd.sun.j2me.app-descriptor",
".jam" => "application/vnd.jam",
".jar" => "application/java-archive",
".java" => "text/x-java-source",
".jisp" => "application/vnd.jisp",
".jlt" => "application/vnd.hp-jlyt",
".jnlp" => "application/x-java-jnlp-file",
".joda" => "application/vnd.joost.joda-archive",
".jp2" => "image/jp2",
".jpeg" => "image/jpeg",
".jpg" => "image/jpeg",
".jpgv" => "video/jpeg",
".jpm" => "video/jpm",
".js" => "application/javascript",
".json" => "application/json",
".karbon" => "application/vnd.kde.karbon",
".kfo" => "application/vnd.kde.kformula",
".kia" => "application/vnd.kidspiration",
".kml" => "application/vnd.google-earth.kml+xml",
".kmz" => "application/vnd.google-earth.kmz",
".kne" => "application/vnd.kinar",
".kon" => "application/vnd.kde.kontour",
".kpr" => "application/vnd.kde.kpresenter",
".ksp" => "application/vnd.kde.kspread",
".ktz" => "application/vnd.kahootz",
".kwd" => "application/vnd.kde.kword",
".latex" => "application/x-latex",
".lbd" => "application/vnd.llamagraphics.life-balance.desktop",
".lbe" => "application/vnd.llamagraphics.life-balance.exchange+xml",
".les" => "application/vnd.hhe.lesson-player",
".link66" => "application/vnd.route66.link66+xml",
".log" => "text/plain",
".lostxml" => "application/lost+xml",
".lrm" => "application/vnd.ms-lrm",
".ltf" => "application/vnd.frogans.ltf",
".lvp" => "audio/vnd.lucent.voice",
".lwp" => "application/vnd.lotus-wordpro",
".m3u" => "audio/x-mpegurl",
".m3u8" => "application/x-mpegurl",
".m4a" => "audio/mp4a-latm",
".m4v" => "video/mp4",
".ma" => "application/mathematica",
".mag" => "application/vnd.ecowin.chart",
".man" => "text/troff",
".manifest" => "text/cache-manifest",
".mathml" => "application/mathml+xml",
".mbk" => "application/vnd.mobius.mbk",
".mbox" => "application/mbox",
".mc1" => "application/vnd.medcalcdata",
".mcd" => "application/vnd.mcd",
".mdb" => "application/x-msaccess",
".mdi" => "image/vnd.ms-modi",
".mdoc" => "text/troff",
".me" => "text/troff",
".mfm" => "application/vnd.mfmp",
".mgz" => "application/vnd.proteus.magazine",
".mid" => "audio/midi",
".midi" => "audio/midi",
".mif" => "application/vnd.mif",
".mime" => "message/rfc822",
".mj2" => "video/mj2",
".mlp" => "application/vnd.dolby.mlp",
".mmd" => "application/vnd.chipnuts.karaoke-mmd",
".mmf" => "application/vnd.smaf",
".mml" => "application/mathml+xml",
".mmr" => "image/vnd.fujixerox.edmics-mmr",
".mng" => "video/x-mng",
".mny" => "application/x-msmoney",
".mov" => "video/quicktime",
".movie" => "video/x-sgi-movie",
".mp3" => "audio/mpeg",
".mp4" => "video/mp4",
".mp4a" => "audio/mp4",
".mp4s" => "application/mp4",
".mp4v" => "video/mp4",
".mpc" => "application/vnd.mophun.certificate",
".mpd" => "application/dash+xml",
".mpeg" => "video/mpeg",
".mpg" => "video/mpeg",
".mpga" => "audio/mpeg",
".mpkg" => "application/vnd.apple.installer+xml",
".mpm" => "application/vnd.blueice.multipass",
".mpn" => "application/vnd.mophun.application",
".mpp" => "application/vnd.ms-project",
".mpy" => "application/vnd.ibm.minipay",
".mqy" => "application/vnd.mobius.mqy",
".mrc" => "application/marc",
".ms" => "text/troff",
".mscml" => "application/mediaservercontrol+xml",
".mseq" => "application/vnd.mseq",
".msf" => "application/vnd.epson.msf",
".msh" => "model/mesh",
".msi" => "application/x-msdownload",
".msl" => "application/vnd.mobius.msl",
".msty" => "application/vnd.muvee.style",
".mts" => "model/vnd.mts",
".mus" => "application/vnd.musician",
".mvb" => "application/x-msmediaview",
".mwf" => "application/vnd.mfer",
".mxf" => "application/mxf",
".mxl" => "application/vnd.recordare.musicxml",
".mxml" => "application/xv+xml",
".mxs" => "application/vnd.triscape.mxs",
".mxu" => "video/vnd.mpegurl",
".n" => "application/vnd.nokia.n-gage.symbian.install",
".nc" => "application/x-netcdf",
".ngdat" => "application/vnd.nokia.n-gage.data",
".nlu" => "application/vnd.neurolanguage.nlu",
".nml" => "application/vnd.enliven",
".nnd" => "application/vnd.noblenet-directory",
".nns" => "application/vnd.noblenet-sealer",
".nnw" => "application/vnd.noblenet-web",
".npx" => "image/vnd.net-fpx",
".nsf" => "application/vnd.lotus-notes",
".oa2" => "application/vnd.fujitsu.oasys2",
".oa3" => "application/vnd.fujitsu.oasys3",
".oas" => "application/vnd.fujitsu.oasys",
".obd" => "application/x-msbinder",
".oda" => "application/oda",
".odc" => "application/vnd.oasis.opendocument.chart",
".odf" => "application/vnd.oasis.opendocument.formula",
".odg" => "application/vnd.oasis.opendocument.graphics",
".odi" => "application/vnd.oasis.opendocument.image",
".odp" => "application/vnd.oasis.opendocument.presentation",
".ods" => "application/vnd.oasis.opendocument.spreadsheet",
".odt" => "application/vnd.oasis.opendocument.text",
".oga" => "audio/ogg",
".ogg" => "application/ogg",
".ogv" => "video/ogg",
".ogx" => "application/ogg",
".org" => "application/vnd.lotus-organizer",
".otc" => "application/vnd.oasis.opendocument.chart-template",
".otf" => "application/vnd.oasis.opendocument.formula-template",
".otg" => "application/vnd.oasis.opendocument.graphics-template",
".oth" => "application/vnd.oasis.opendocument.text-web",
".oti" => "application/vnd.oasis.opendocument.image-template",
".otm" => "application/vnd.oasis.opendocument.text-master",
".ots" => "application/vnd.oasis.opendocument.spreadsheet-template",
".ott" => "application/vnd.oasis.opendocument.text-template",
".oxt" => "application/vnd.openofficeorg.extension",
".p" => "text/x-pascal",
".p10" => "application/pkcs10",
".p12" => "application/x-pkcs12",
".p7b" => "application/x-pkcs7-certificates",
".p7m" => "application/pkcs7-mime",
".p7r" => "application/x-pkcs7-certreqresp",
".p7s" => "application/pkcs7-signature",
".pas" => "text/x-pascal",
".pbd" => "application/vnd.powerbuilder6",
".pbm" => "image/x-portable-bitmap",
".pcl" => "application/vnd.hp-pcl",
".pclxl" => "application/vnd.hp-pclxl",
".pcx" => "image/x-pcx",
".pdb" => "chemical/x-pdb",
".pdf" => "application/pdf",
".pem" => "application/x-x509-ca-cert",
".pfr" => "application/font-tdpfr",
".pgm" => "image/x-portable-graymap",
".pgn" => "application/x-chess-pgn",
".pgp" => "application/pgp-encrypted",
".pic" => "image/x-pict",
".pict" => "image/pict",
".pkg" => "application/octet-stream",
".pki" => "application/pkixcmp",
".pkipath" => "application/pkix-pkipath",
".pl" => "text/x-script.perl",
".plb" => "application/vnd.3gpp.pic-bw-large",
".plc" => "application/vnd.mobius.plc",
".plf" => "application/vnd.pocketlearn",
".pls" => "application/pls+xml",
".pm" => "text/x-script.perl-module",
".pml" => "application/vnd.ctc-posml",
".png" => "image/png",
".pnm" => "image/x-portable-anymap",
".pntg" => "image/x-macpaint",
".portpkg" => "application/vnd.macports.portpkg",
".pot" => "application/vnd.ms-powerpoint",
".potm" => "application/vnd.ms-powerpoint.template.macroEnabled.12",
".potx" => "application/vnd.openxmlformats-officedocument.presentationml.template",
".ppa" => "application/vnd.ms-powerpoint",
".ppam" => "application/vnd.ms-powerpoint.addin.macroEnabled.12",
".ppd" => "application/vnd.cups-ppd",
".ppm" => "image/x-portable-pixmap",
".pps" => "application/vnd.ms-powerpoint",
".ppsm" => "application/vnd.ms-powerpoint.slideshow.macroEnabled.12",
".ppsx" => "application/vnd.openxmlformats-officedocument.presentationml.slideshow",
".ppt" => "application/vnd.ms-powerpoint",
".pptm" => "application/vnd.ms-powerpoint.presentation.macroEnabled.12",
".pptx" => "application/vnd.openxmlformats-officedocument.presentationml.presentation",
".prc" => "application/vnd.palm",
".pre" => "application/vnd.lotus-freelance",
".prf" => "application/pics-rules",
".ps" => "application/postscript",
".psb" => "application/vnd.3gpp.pic-bw-small",
".psd" => "image/vnd.adobe.photoshop",
".ptid" => "application/vnd.pvi.ptid1",
".pub" => "application/x-mspublisher",
".pvb" => "application/vnd.3gpp.pic-bw-var",
".pwn" => "application/vnd.3m.post-it-notes",
".py" => "text/x-script.python",
".pya" => "audio/vnd.ms-playready.media.pya",
".pyv" => "video/vnd.ms-playready.media.pyv",
".qam" => "application/vnd.epson.quickanime",
".qbo" => "application/vnd.intu.qbo",
".qfx" => "application/vnd.intu.qfx",
".qps" => "application/vnd.publishare-delta-tree",
".qt" => "video/quicktime",
".qtif" => "image/x-quicktime",
".qxd" => "application/vnd.quark.quarkxpress",
".ra" => "audio/x-pn-realaudio",
".rake" => "text/x-script.ruby",
".ram" => "audio/x-pn-realaudio",
".rar" => "application/x-rar-compressed",
".ras" => "image/x-cmu-raster",
".rb" => "text/x-script.ruby",
".rcprofile" => "application/vnd.ipunplugged.rcprofile",
".rdf" => "application/rdf+xml",
".rdz" => "application/vnd.data-vision.rdz",
".rep" => "application/vnd.businessobjects",
".rgb" => "image/x-rgb",
".rif" => "application/reginfo+xml",
".rl" => "application/resource-lists+xml",
".rlc" => "image/vnd.fujixerox.edmics-rlc",
".rld" => "application/resource-lists-diff+xml",
".rm" => "application/vnd.rn-realmedia",
".rmp" => "audio/x-pn-realaudio-plugin",
".rms" => "application/vnd.jcp.javame.midlet-rms",
".rnc" => "application/relax-ng-compact-syntax",
".roff" => "text/troff",
".rpm" => "application/x-redhat-package-manager",
".rpss" => "application/vnd.nokia.radio-presets",
".rpst" => "application/vnd.nokia.radio-preset",
".rq" => "application/sparql-query",
".rs" => "application/rls-services+xml",
".rsd" => "application/rsd+xml",
".rss" => "application/rss+xml",
".rtf" => "application/rtf",
".rtx" => "text/richtext",
".ru" => "text/x-script.ruby",
".s" => "text/x-asm",
".saf" => "application/vnd.yamaha.smaf-audio",
".sbml" => "application/sbml+xml",
".sc" => "application/vnd.ibm.secure-container",
".scd" => "application/x-msschedule",
".scm" => "application/vnd.lotus-screencam",
".scq" => "application/scvp-cv-request",
".scs" => "application/scvp-cv-response",
".sdkm" => "application/vnd.solent.sdkm+xml",
".sdp" => "application/sdp",
".see" => "application/vnd.seemail",
".sema" => "application/vnd.sema",
".semd" => "application/vnd.semd",
".semf" => "application/vnd.semf",
".setpay" => "application/set-payment-initiation",
".setreg" => "application/set-registration-initiation",
".sfd" => "application/vnd.hydrostatix.sof-data",
".sfs" => "application/vnd.spotfire.sfs",
".sgm" => "text/sgml",
".sgml" => "text/sgml",
".sh" => "application/x-sh",
".shar" => "application/x-shar",
".shf" => "application/shf+xml",
".sig" => "application/pgp-signature",
".sit" => "application/x-stuffit",
".sitx" => "application/x-stuffitx",
".skp" => "application/vnd.koan",
".slt" => "application/vnd.epson.salt",
".smi" => "application/smil+xml",
".snd" => "audio/basic",
".so" => "application/octet-stream",
".spf" => "application/vnd.yamaha.smaf-phrase",
".spl" => "application/x-futuresplash",
".spot" => "text/vnd.in3d.spot",
".spp" => "application/scvp-vp-response",
".spq" => "application/scvp-vp-request",
".src" => "application/x-wais-source",
".srt" => "text/srt",
".srx" => "application/sparql-results+xml",
".sse" => "application/vnd.kodak-descriptor",
".ssf" => "application/vnd.epson.ssf",
".ssml" => "application/ssml+xml",
".stf" => "application/vnd.wt.stf",
".stk" => "application/hyperstudio",
".str" => "application/vnd.pg.format",
".sus" => "application/vnd.sus-calendar",
".sv4cpio" => "application/x-sv4cpio",
".sv4crc" => "application/x-sv4crc",
".svd" => "application/vnd.svd",
".svg" => "image/svg+xml",
".svgz" => "image/svg+xml",
".swf" => "application/x-shockwave-flash",
".swi" => "application/vnd.arastra.swi",
".t" => "text/troff",
".tao" => "application/vnd.tao.intent-module-archive",
".tar" => "application/x-tar",
".tbz" => "application/x-bzip-compressed-tar",
".tcap" => "application/vnd.3gpp2.tcap",
".tcl" => "application/x-tcl",
".tex" => "application/x-tex",
".texi" => "application/x-texinfo",
".texinfo" => "application/x-texinfo",
".text" => "text/plain",
".tif" => "image/tiff",
".tiff" => "image/tiff",
".tmo" => "application/vnd.tmobile-livetv",
".torrent" => "application/x-bittorrent",
".tpl" => "application/vnd.groove-tool-template",
".tpt" => "application/vnd.trid.tpt",
".tr" => "text/troff",
".tra" => "application/vnd.trueapp",
".trm" => "application/x-msterminal",
".ts" => "video/mp2t",
".tsv" => "text/tab-separated-values",
".ttf" => "application/octet-stream",
".twd" => "application/vnd.simtech-mindmapper",
".txd" => "application/vnd.genomatix.tuxedo",
".txf" => "application/vnd.mobius.txf",
".txt" => "text/plain",
".ufd" => "application/vnd.ufdl",
".umj" => "application/vnd.umajin",
".unityweb" => "application/vnd.unity",
".uoml" => "application/vnd.uoml+xml",
".uri" => "text/uri-list",
".ustar" => "application/x-ustar",
".utz" => "application/vnd.uiq.theme",
".uu" => "text/x-uuencode",
".vcd" => "application/x-cdlink",
".vcf" => "text/x-vcard",
".vcg" => "application/vnd.groove-vcard",
".vcs" => "text/x-vcalendar",
".vcx" => "application/vnd.vcx",
".vis" => "application/vnd.visionary",
".viv" => "video/vnd.vivo",
".vrml" => "model/vrml",
".vsd" => "application/vnd.visio",
".vsf" => "application/vnd.vsf",
".vtt" => "text/vtt",
".vtu" => "model/vnd.vtu",
".vxml" => "application/voicexml+xml",
".war" => "application/java-archive",
".wasm" => "application/wasm",
".wav" => "audio/x-wav",
".wax" => "audio/x-ms-wax",
".wbmp" => "image/vnd.wap.wbmp",
".wbs" => "application/vnd.criticaltools.wbs+xml",
".wbxml" => "application/vnd.wap.wbxml",
".webm" => "video/webm",
".webp" => "image/webp",
".wm" => "video/x-ms-wm",
".wma" => "audio/x-ms-wma",
".wmd" => "application/x-ms-wmd",
".wmf" => "application/x-msmetafile",
".wml" => "text/vnd.wap.wml",
".wmlc" => "application/vnd.wap.wmlc",
".wmls" => "text/vnd.wap.wmlscript",
".wmlsc" => "application/vnd.wap.wmlscriptc",
".wmv" => "video/x-ms-wmv",
".wmx" => "video/x-ms-wmx",
".wmz" => "application/x-ms-wmz",
".woff" => "application/font-woff",
".woff2" => "application/font-woff2",
".wpd" => "application/vnd.wordperfect",
".wpl" => "application/vnd.ms-wpl",
".wps" => "application/vnd.ms-works",
".wqd" => "application/vnd.wqd",
".wri" => "application/x-mswrite",
".wrl" => "model/vrml",
".wsdl" => "application/wsdl+xml",
".wspolicy" => "application/wspolicy+xml",
".wtb" => "application/vnd.webturbo",
".wvx" => "video/x-ms-wvx",
".x3d" => "application/vnd.hzn-3d-crossword",
".xar" => "application/vnd.xara",
".xbd" => "application/vnd.fujixerox.docuworks.binder",
".xbm" => "image/x-xbitmap",
".xdm" => "application/vnd.syncml.dm+xml",
".xdp" => "application/vnd.adobe.xdp+xml",
".xdw" => "application/vnd.fujixerox.docuworks",
".xenc" => "application/xenc+xml",
".xer" => "application/patch-ops-error+xml",
".xfdf" => "application/vnd.adobe.xfdf",
".xfdl" => "application/vnd.xfdl",
".xhtml" => "application/xhtml+xml",
".xif" => "image/vnd.xiff",
".xla" => "application/vnd.ms-excel",
".xlam" => "application/vnd.ms-excel.addin.macroEnabled.12",
".xls" => "application/vnd.ms-excel",
".xlsb" => "application/vnd.ms-excel.sheet.binary.macroEnabled.12",
".xlsx" => "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
".xlsm" => "application/vnd.ms-excel.sheet.macroEnabled.12",
".xlt" => "application/vnd.ms-excel",
".xltx" => "application/vnd.openxmlformats-officedocument.spreadsheetml.template",
".xml" => "application/xml",
".xo" => "application/vnd.olpc-sugar",
".xop" => "application/xop+xml",
".xpm" => "image/x-xpixmap",
".xpr" => "application/vnd.is-xpr",
".xps" => "application/vnd.ms-xpsdocument",
".xpw" => "application/vnd.intercon.formnet",
".xsl" => "application/xml",
".xslt" => "application/xslt+xml",
".xsm" => "application/vnd.syncml+xml",
".xspf" => "application/xspf+xml",
".xul" => "application/vnd.mozilla.xul+xml",
".xwd" => "image/x-xwindowdump",
".xyz" => "chemical/x-xyz",
".yaml" => "text/yaml",
".yml" => "text/yaml",
".zaz" => "application/vnd.zzazz.deck+xml",
".zip" => "application/zip",
".zmm" => "application/vnd.handheld-entertainment+xml",
}
end
end
share/gems/gems/rack-3.0.8/lib/rack/conditional_get.rb 0000644 00000005765 15173517742 0016326 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
require_relative 'body_proxy'
module Rack
# Middleware that enables conditional GET using if-none-match and
# if-modified-since. The application should set either or both of the
# last-modified or etag response headers according to RFC 2616. When
# either of the conditions is met, the response body is set to be zero
# length and the response status is set to 304 Not Modified.
#
# Applications that defer response body generation until the body's each
# message is received will avoid response body generation completely when
# a conditional GET matches.
#
# Adapted from Michael Klishin's Merb implementation:
# https://github.com/wycats/merb/blob/master/merb-core/lib/merb-core/rack/middleware/conditional_get.rb
class ConditionalGet
def initialize(app)
@app = app
end
# Return empty 304 response if the response has not been
# modified since the last request.
def call(env)
case env[REQUEST_METHOD]
when "GET", "HEAD"
status, headers, body = response = @app.call(env)
if status == 200 && fresh?(env, headers)
response[0] = 304
headers.delete(CONTENT_TYPE)
headers.delete(CONTENT_LENGTH)
response[2] = Rack::BodyProxy.new([]) do
body.close if body.respond_to?(:close)
end
end
response
else
@app.call(env)
end
end
private
# Return whether the response has not been modified since the
# last request.
def fresh?(env, headers)
# if-none-match has priority over if-modified-since per RFC 7232
if none_match = env['HTTP_IF_NONE_MATCH']
etag_matches?(none_match, headers)
elsif (modified_since = env['HTTP_IF_MODIFIED_SINCE']) && (modified_since = to_rfc2822(modified_since))
modified_since?(modified_since, headers)
end
end
# Whether the etag response header matches the if-none-match request header.
# If so, the request has not been modified.
def etag_matches?(none_match, headers)
headers[ETAG] == none_match
end
# Whether the last-modified response header matches the if-modified-since
# request header. If so, the request has not been modified.
def modified_since?(modified_since, headers)
last_modified = to_rfc2822(headers['last-modified']) and
modified_since >= last_modified
end
# Return a Time object for the given string (which should be in RFC2822
# format), or nil if the string cannot be parsed.
def to_rfc2822(since)
# shortest possible valid date is the obsolete: 1 Nov 97 09:55 A
# anything shorter is invalid, this avoids exceptions for common cases
# most common being the empty string
if since && since.length >= 16
# NOTE: there is no trivial way to write this in a non exception way
# _rfc2822 returns a hash but is not that usable
Time.rfc2822(since) rescue nil
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/auth/basic.rb 0000644 00000002261 15173517742 0015172 0 ustar 00 # frozen_string_literal: true
require_relative 'abstract/handler'
require_relative 'abstract/request'
require 'base64'
module Rack
module Auth
# Rack::Auth::Basic implements HTTP Basic Authentication, as per RFC 2617.
#
# Initialize with the Rack application that you want protecting,
# and a block that checks if a username and password pair are valid.
class Basic < AbstractHandler
def call(env)
auth = Basic::Request.new(env)
return unauthorized unless auth.provided?
return bad_request unless auth.basic?
if valid?(auth)
env['REMOTE_USER'] = auth.username
return @app.call(env)
end
unauthorized
end
private
def challenge
'Basic realm="%s"' % realm
end
def valid?(auth)
@authenticator.call(*auth.credentials)
end
class Request < Auth::AbstractRequest
def basic?
"basic" == scheme && credentials.length == 2
end
def credentials
@credentials ||= Base64.decode64(params).split(':', 2)
end
def username
credentials.first
end
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/auth/digest/request.rb 0000644 00000000035 15173517742 0017055 0 ustar 00 require_relative '../digest'
share/gems/gems/rack-3.0.8/lib/rack/auth/digest/nonce.rb 0000644 00000000035 15173517742 0016467 0 ustar 00 require_relative '../digest'
share/gems/gems/rack-3.0.8/lib/rack/auth/digest/params.rb 0000644 00000000035 15173517742 0016650 0 ustar 00 require_relative '../digest'
share/gems/gems/rack-3.0.8/lib/rack/auth/digest/md5.rb 0000644 00000000035 15173517742 0016052 0 ustar 00 require_relative '../digest'
share/gems/gems/rack-3.0.8/lib/rack/auth/digest.rb 0000644 00000014012 15173517742 0015365 0 ustar 00 # frozen_string_literal: true
require_relative 'abstract/handler'
require_relative 'abstract/request'
require 'digest/md5'
require 'base64'
module Rack
warn "Rack::Auth::Digest is deprecated and will be removed in Rack 3.1", uplevel: 1
module Auth
module Digest
# Rack::Auth::Digest::Nonce is the default nonce generator for the
# Rack::Auth::Digest::MD5 authentication handler.
#
# +private_key+ needs to set to a constant string.
#
# +time_limit+ can be optionally set to an integer (number of seconds),
# to limit the validity of the generated nonces.
class Nonce
class << self
attr_accessor :private_key, :time_limit
end
def self.parse(string)
new(*Base64.decode64(string).split(' ', 2))
end
def initialize(timestamp = Time.now, given_digest = nil)
@timestamp, @given_digest = timestamp.to_i, given_digest
end
def to_s
Base64.encode64("#{@timestamp} #{digest}").strip
end
def digest
::Digest::MD5.hexdigest("#{@timestamp}:#{self.class.private_key}")
end
def valid?
digest == @given_digest
end
def stale?
!self.class.time_limit.nil? && (Time.now.to_i - @timestamp) > self.class.time_limit
end
def fresh?
!stale?
end
end
class Params < Hash
def self.parse(str)
Params[*split_header_value(str).map do |param|
k, v = param.split('=', 2)
[k, dequote(v)]
end.flatten]
end
def self.dequote(str) # From WEBrick::HTTPUtils
ret = (/\A"(.*)"\Z/ =~ str) ? $1 : str.dup
ret.gsub!(/\\(.)/, "\\1")
ret
end
def self.split_header_value(str)
str.scan(/\w+\=(?:"[^\"]+"|[^,]+)/n)
end
def initialize
super()
yield self if block_given?
end
def [](k)
super k.to_s
end
def []=(k, v)
super k.to_s, v.to_s
end
UNQUOTED = ['nc', 'stale']
def to_s
map do |k, v|
"#{k}=#{(UNQUOTED.include?(k) ? v.to_s : quote(v))}"
end.join(', ')
end
def quote(str) # From WEBrick::HTTPUtils
'"' + str.gsub(/[\\\"]/o, "\\\1") + '"'
end
end
class Request < Auth::AbstractRequest
def method
@env[RACK_METHODOVERRIDE_ORIGINAL_METHOD] || @env[REQUEST_METHOD]
end
def digest?
"digest" == scheme
end
def correct_uri?
request.fullpath == uri
end
def nonce
@nonce ||= Nonce.parse(params['nonce'])
end
def params
@params ||= Params.parse(parts.last)
end
def respond_to?(sym, *)
super or params.has_key? sym.to_s
end
def method_missing(sym, *args)
return super unless params.has_key?(key = sym.to_s)
return params[key] if args.size == 0
raise ArgumentError, "wrong number of arguments (#{args.size} for 0)"
end
end
# Rack::Auth::Digest::MD5 implements the MD5 algorithm version of
# HTTP Digest Authentication, as per RFC 2617.
#
# Initialize with the [Rack] application that you want protecting,
# and a block that looks up a plaintext password for a given username.
#
# +opaque+ needs to be set to a constant base64/hexadecimal string.
#
class MD5 < AbstractHandler
attr_accessor :opaque
attr_writer :passwords_hashed
def initialize(app, realm = nil, opaque = nil, &authenticator)
@passwords_hashed = nil
if opaque.nil? and realm.respond_to? :values_at
realm, opaque, @passwords_hashed = realm.values_at :realm, :opaque, :passwords_hashed
end
super(app, realm, &authenticator)
@opaque = opaque
end
def passwords_hashed?
!!@passwords_hashed
end
def call(env)
auth = Request.new(env)
unless auth.provided?
return unauthorized
end
if !auth.digest? || !auth.correct_uri? || !valid_qop?(auth)
return bad_request
end
if valid?(auth)
if auth.nonce.stale?
return unauthorized(challenge(stale: true))
else
env['REMOTE_USER'] = auth.username
return @app.call(env)
end
end
unauthorized
end
private
QOP = 'auth'
def params(hash = {})
Params.new do |params|
params['realm'] = realm
params['nonce'] = Nonce.new.to_s
params['opaque'] = H(opaque)
params['qop'] = QOP
hash.each { |k, v| params[k] = v }
end
end
def challenge(hash = {})
"Digest #{params(hash)}"
end
def valid?(auth)
valid_opaque?(auth) && valid_nonce?(auth) && valid_digest?(auth)
end
def valid_qop?(auth)
QOP == auth.qop
end
def valid_opaque?(auth)
H(opaque) == auth.opaque
end
def valid_nonce?(auth)
auth.nonce.valid?
end
def valid_digest?(auth)
pw = @authenticator.call(auth.username)
pw && Rack::Utils.secure_compare(digest(auth, pw), auth.response)
end
def md5(data)
::Digest::MD5.hexdigest(data)
end
alias :H :md5
def KD(secret, data)
H "#{secret}:#{data}"
end
def A1(auth, password)
"#{auth.username}:#{auth.realm}:#{password}"
end
def A2(auth)
"#{auth.method}:#{auth.uri}"
end
def digest(auth, password)
password_hash = passwords_hashed? ? password : H(A1(auth, password))
KD password_hash, "#{auth.nonce}:#{auth.nc}:#{auth.cnonce}:#{QOP}:#{H A2(auth)}"
end
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/auth/abstract/request.rb 0000644 00000001525 15173517742 0017406 0 ustar 00 # frozen_string_literal: true
require_relative '../../request'
module Rack
module Auth
class AbstractRequest
def initialize(env)
@env = env
end
def request
@request ||= Request.new(@env)
end
def provided?
!authorization_key.nil? && valid?
end
def valid?
!@env[authorization_key].nil?
end
def parts
@parts ||= @env[authorization_key].split(' ', 2)
end
def scheme
@scheme ||= parts.first&.downcase
end
def params
@params ||= parts.last
end
private
AUTHORIZATION_KEYS = ['HTTP_AUTHORIZATION', 'X-HTTP_AUTHORIZATION', 'X_HTTP_AUTHORIZATION']
def authorization_key
@authorization_key ||= AUTHORIZATION_KEYS.detect { |key| @env.has_key?(key) }
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/auth/abstract/handler.rb 0000644 00000001522 15173517742 0017330 0 ustar 00 # frozen_string_literal: true
require_relative '../../constants'
module Rack
module Auth
# Rack::Auth::AbstractHandler implements common authentication functionality.
#
# +realm+ should be set for all handlers.
class AbstractHandler
attr_accessor :realm
def initialize(app, realm = nil, &authenticator)
@app, @realm, @authenticator = app, realm, authenticator
end
private
def unauthorized(www_authenticate = challenge)
return [ 401,
{ CONTENT_TYPE => 'text/plain',
CONTENT_LENGTH => '0',
'www-authenticate' => www_authenticate.to_s },
[]
]
end
def bad_request
return [ 400,
{ CONTENT_TYPE => 'text/plain',
CONTENT_LENGTH => '0' },
[]
]
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/deflater.rb 0000644 00000013006 15173517742 0014735 0 ustar 00 # frozen_string_literal: true
require "zlib"
require "time" # for Time.httpdate
require_relative 'constants'
require_relative 'utils'
require_relative 'request'
require_relative 'body_proxy'
module Rack
# This middleware enables content encoding of http responses,
# usually for purposes of compression.
#
# Currently supported encodings:
#
# * gzip
# * identity (no transformation)
#
# This middleware automatically detects when encoding is supported
# and allowed. For example no encoding is made when a cache
# directive of 'no-transform' is present, when the response status
# code is one that doesn't allow an entity body, or when the body
# is empty.
#
# Note that despite the name, Deflater does not support the +deflate+
# encoding.
class Deflater
# Creates Rack::Deflater middleware. Options:
#
# :if :: a lambda enabling / disabling deflation based on returned boolean value
# (e.g <tt>use Rack::Deflater, :if => lambda { |*, body| sum=0; body.each { |i| sum += i.length }; sum > 512 }</tt>).
# However, be aware that calling `body.each` inside the block will break cases where `body.each` is not idempotent,
# such as when it is an +IO+ instance.
# :include :: a list of content types that should be compressed. By default, all content types are compressed.
# :sync :: determines if the stream is going to be flushed after every chunk. Flushing after every chunk reduces
# latency for time-sensitive streaming applications, but hurts compression and throughput.
# Defaults to +true+.
def initialize(app, options = {})
@app = app
@condition = options[:if]
@compressible_types = options[:include]
@sync = options.fetch(:sync, true)
end
def call(env)
status, headers, body = response = @app.call(env)
unless should_deflate?(env, status, headers, body)
return response
end
request = Request.new(env)
encoding = Utils.select_best_encoding(%w(gzip identity),
request.accept_encoding)
# Set the Vary HTTP header.
vary = headers["vary"].to_s.split(",").map(&:strip)
unless vary.include?("*") || vary.any?{|v| v.downcase == 'accept-encoding'}
headers["vary"] = vary.push("Accept-Encoding").join(",")
end
case encoding
when "gzip"
headers['content-encoding'] = "gzip"
headers.delete(CONTENT_LENGTH)
mtime = headers["last-modified"]
mtime = Time.httpdate(mtime).to_i if mtime
response[2] = GzipStream.new(body, mtime, @sync)
response
when "identity"
response
else # when nil
# Only possible encoding values here are 'gzip', 'identity', and nil
message = "An acceptable encoding for the requested resource #{request.fullpath} could not be found."
bp = Rack::BodyProxy.new([message]) { body.close if body.respond_to?(:close) }
[406, { CONTENT_TYPE => "text/plain", CONTENT_LENGTH => message.length.to_s }, bp]
end
end
# Body class used for gzip encoded responses.
class GzipStream
BUFFER_LENGTH = 128 * 1_024
# Initialize the gzip stream. Arguments:
# body :: Response body to compress with gzip
# mtime :: The modification time of the body, used to set the
# modification time in the gzip header.
# sync :: Whether to flush each gzip chunk as soon as it is ready.
def initialize(body, mtime, sync)
@body = body
@mtime = mtime
@sync = sync
end
# Yield gzip compressed strings to the given block.
def each(&block)
@writer = block
gzip = ::Zlib::GzipWriter.new(self)
gzip.mtime = @mtime if @mtime
# @body.each is equivalent to @body.gets (slow)
if @body.is_a? ::File # XXX: Should probably be ::IO
while part = @body.read(BUFFER_LENGTH)
gzip.write(part)
gzip.flush if @sync
end
else
@body.each { |part|
# Skip empty strings, as they would result in no output,
# and flushing empty parts would raise Zlib::BufError.
next if part.empty?
gzip.write(part)
gzip.flush if @sync
}
end
ensure
gzip.finish
end
# Call the block passed to #each with the gzipped data.
def write(data)
@writer.call(data)
end
# Close the original body if possible.
def close
@body.close if @body.respond_to?(:close)
end
end
private
# Whether the body should be compressed.
def should_deflate?(env, status, headers, body)
# Skip compressing empty entity body responses and responses with
# no-transform set.
if Utils::STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) ||
/\bno-transform\b/.match?(headers[CACHE_CONTROL].to_s) ||
headers['content-encoding']&.!~(/\bidentity\b/)
return false
end
# Skip if @compressible_types are given and does not include request's content type
return false if @compressible_types && !(headers.has_key?(CONTENT_TYPE) && @compressible_types.include?(headers[CONTENT_TYPE][/[^;]*/]))
# Skip if @condition lambda is given and evaluates to false
return false if @condition && !@condition.call(env, status, headers, body)
# No point in compressing empty body, also handles usage with
# Rack::Sendfile.
return false if headers[CONTENT_LENGTH] == '0'
true
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/events.rb 0000644 00000011464 15173517742 0014461 0 ustar 00 # frozen_string_literal: true
require_relative 'body_proxy'
require_relative 'request'
require_relative 'response'
module Rack
### This middleware provides hooks to certain places in the request /
# response lifecycle. This is so that middleware that don't need to filter
# the response data can safely leave it alone and not have to send messages
# down the traditional "rack stack".
#
# The events are:
#
# * on_start(request, response)
#
# This event is sent at the start of the request, before the next
# middleware in the chain is called. This method is called with a request
# object, and a response object. Right now, the response object is always
# nil, but in the future it may actually be a real response object.
#
# * on_commit(request, response)
#
# The response has been committed. The application has returned, but the
# response has not been sent to the webserver yet. This method is always
# called with a request object and the response object. The response
# object is constructed from the rack triple that the application returned.
# Changes may still be made to the response object at this point.
#
# * on_send(request, response)
#
# The webserver has started iterating over the response body and presumably
# has started sending data over the wire. This method is always called with
# a request object and the response object. The response object is
# constructed from the rack triple that the application returned. Changes
# SHOULD NOT be made to the response object as the webserver has already
# started sending data. Any mutations will likely result in an exception.
#
# * on_finish(request, response)
#
# The webserver has closed the response, and all data has been written to
# the response socket. The request and response object should both be
# read-only at this point. The body MAY NOT be available on the response
# object as it may have been flushed to the socket.
#
# * on_error(request, response, error)
#
# An exception has occurred in the application or an `on_commit` event.
# This method will get the request, the response (if available) and the
# exception that was raised.
#
# ## Order
#
# `on_start` is called on the handlers in the order that they were passed to
# the constructor. `on_commit`, on_send`, `on_finish`, and `on_error` are
# called in the reverse order. `on_finish` handlers are called inside an
# `ensure` block, so they are guaranteed to be called even if something
# raises an exception. If something raises an exception in a `on_finish`
# method, then nothing is guaranteed.
class Events
module Abstract
def on_start(req, res)
end
def on_commit(req, res)
end
def on_send(req, res)
end
def on_finish(req, res)
end
def on_error(req, res, e)
end
end
class EventedBodyProxy < Rack::BodyProxy # :nodoc:
attr_reader :request, :response
def initialize(body, request, response, handlers, &block)
super(body, &block)
@request = request
@response = response
@handlers = handlers
end
def each
@handlers.reverse_each { |handler| handler.on_send request, response }
super
end
end
class BufferedResponse < Rack::Response::Raw # :nodoc:
attr_reader :body
def initialize(status, headers, body)
super(status, headers)
@body = body
end
def to_a; [status, headers, body]; end
end
def initialize(app, handlers)
@app = app
@handlers = handlers
end
def call(env)
request = make_request env
on_start request, nil
begin
status, headers, body = @app.call request.env
response = make_response status, headers, body
on_commit request, response
rescue StandardError => e
on_error request, response, e
on_finish request, response
raise
end
body = EventedBodyProxy.new(body, request, response, @handlers) do
on_finish request, response
end
[response.status, response.headers, body]
end
private
def on_error(request, response, e)
@handlers.reverse_each { |handler| handler.on_error request, response, e }
end
def on_commit(request, response)
@handlers.reverse_each { |handler| handler.on_commit request, response }
end
def on_start(request, response)
@handlers.each { |handler| handler.on_start request, nil }
end
def on_finish(request, response)
@handlers.reverse_each { |handler| handler.on_finish request, response }
end
def make_request(env)
Rack::Request.new env
end
def make_response(status, headers, body)
BufferedResponse.new status, headers, body
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/body_proxy.rb 0000644 00000002463 15173517742 0015352 0 ustar 00 # frozen_string_literal: true
module Rack
# Proxy for response bodies allowing calling a block when
# the response body is closed (after the response has been fully
# sent to the client).
class BodyProxy
# Set the response body to wrap, and the block to call when the
# response has been fully sent.
def initialize(body, &block)
@body = body
@block = block
@closed = false
end
# Return whether the wrapped body responds to the method.
def respond_to_missing?(method_name, include_all = false)
super or @body.respond_to?(method_name, include_all)
end
# If not already closed, close the wrapped body and
# then call the block the proxy was initialized with.
def close
return if @closed
@closed = true
begin
@body.close if @body.respond_to?(:close)
ensure
@block.call
end
end
# Whether the proxy is closed. The proxy starts as not closed,
# and becomes closed on the first call to close.
def closed?
@closed
end
# Delegate missing methods to the wrapped body.
def method_missing(method_name, *args, &block)
@body.__send__(method_name, *args, &block)
end
# :nocov:
ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
# :nocov:
end
end
share/gems/gems/rack-3.0.8/lib/rack/static.rb 0000644 00000013777 15173517742 0014455 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'files'
require_relative 'mime'
module Rack
# The Rack::Static middleware intercepts requests for static files
# (javascript files, images, stylesheets, etc) based on the url prefixes or
# route mappings passed in the options, and serves them using a Rack::Files
# object. This allows a Rack stack to serve both static and dynamic content.
#
# Examples:
#
# Serve all requests beginning with /media from the "media" folder located
# in the current directory (ie media/*):
#
# use Rack::Static, :urls => ["/media"]
#
# Same as previous, but instead of returning 404 for missing files under
# /media, call the next middleware:
#
# use Rack::Static, :urls => ["/media"], :cascade => true
#
# Serve all requests beginning with /css or /images from the folder "public"
# in the current directory (ie public/css/* and public/images/*):
#
# use Rack::Static, :urls => ["/css", "/images"], :root => "public"
#
# Serve all requests to / with "index.html" from the folder "public" in the
# current directory (ie public/index.html):
#
# use Rack::Static, :urls => {"/" => 'index.html'}, :root => 'public'
#
# Serve all requests normally from the folder "public" in the current
# directory but uses index.html as default route for "/"
#
# use Rack::Static, :urls => [""], :root => 'public', :index =>
# 'index.html'
#
# Set custom HTTP Headers for based on rules:
#
# use Rack::Static, :root => 'public',
# :header_rules => [
# [rule, {header_field => content, header_field => content}],
# [rule, {header_field => content}]
# ]
#
# Rules for selecting files:
#
# 1) All files
# Provide the :all symbol
# :all => Matches every file
#
# 2) Folders
# Provide the folder path as a string
# '/folder' or '/folder/subfolder' => Matches files in a certain folder
#
# 3) File Extensions
# Provide the file extensions as an array
# ['css', 'js'] or %w(css js) => Matches files ending in .css or .js
#
# 4) Regular Expressions / Regexp
# Provide a regular expression
# %r{\.(?:css|js)\z} => Matches files ending in .css or .js
# /\.(?:eot|ttf|otf|woff2|woff|svg)\z/ => Matches files ending in
# the most common web font formats (.eot, .ttf, .otf, .woff2, .woff, .svg)
# Note: This Regexp is available as a shortcut, using the :fonts rule
#
# 5) Font Shortcut
# Provide the :fonts symbol
# :fonts => Uses the Regexp rule stated right above to match all common web font endings
#
# Rule Ordering:
# Rules are applied in the order that they are provided.
# List rather general rules above special ones.
#
# Complete example use case including HTTP header rules:
#
# use Rack::Static, :root => 'public',
# :header_rules => [
# # Cache all static files in public caches (e.g. Rack::Cache)
# # as well as in the browser
# [:all, {'cache-control' => 'public, max-age=31536000'}],
#
# # Provide web fonts with cross-origin access-control-headers
# # Firefox requires this when serving assets using a Content Delivery Network
# [:fonts, {'access-control-allow-origin' => '*'}]
# ]
#
class Static
def initialize(app, options = {})
@app = app
@urls = options[:urls] || ["/favicon.ico"]
@index = options[:index]
@gzip = options[:gzip]
@cascade = options[:cascade]
root = options[:root] || Dir.pwd
# HTTP Headers
@header_rules = options[:header_rules] || []
# Allow for legacy :cache_control option while prioritizing global header_rules setting
@header_rules.unshift([:all, { CACHE_CONTROL => options[:cache_control] }]) if options[:cache_control]
@file_server = Rack::Files.new(root)
end
def add_index_root?(path)
@index && route_file(path) && path.end_with?('/')
end
def overwrite_file_path(path)
@urls.kind_of?(Hash) && @urls.key?(path) || add_index_root?(path)
end
def route_file(path)
@urls.kind_of?(Array) && @urls.any? { |url| path.index(url) == 0 }
end
def can_serve(path)
route_file(path) || overwrite_file_path(path)
end
def call(env)
path = env[PATH_INFO]
if can_serve(path)
if overwrite_file_path(path)
env[PATH_INFO] = (add_index_root?(path) ? path + @index : @urls[path])
elsif @gzip && env['HTTP_ACCEPT_ENCODING'] && /\bgzip\b/.match?(env['HTTP_ACCEPT_ENCODING'])
path = env[PATH_INFO]
env[PATH_INFO] += '.gz'
response = @file_server.call(env)
env[PATH_INFO] = path
if response[0] == 404
response = nil
elsif response[0] == 304
# Do nothing, leave headers as is
else
response[1][CONTENT_TYPE] = Mime.mime_type(::File.extname(path), 'text/plain')
response[1]['content-encoding'] = 'gzip'
end
end
path = env[PATH_INFO]
response ||= @file_server.call(env)
if @cascade && response[0] == 404
return @app.call(env)
end
headers = response[1]
applicable_rules(path).each do |rule, new_headers|
new_headers.each { |field, content| headers[field] = content }
end
response
else
@app.call(env)
end
end
# Convert HTTP header rules to HTTP headers
def applicable_rules(path)
@header_rules.find_all do |rule, new_headers|
case rule
when :all
true
when :fonts
/\.(?:ttf|otf|eot|woff2|woff|svg)\z/.match?(path)
when String
path = ::Rack::Utils.unescape(path)
path.start_with?(rule) || path.start_with?('/' + rule)
when Array
/\.(#{rule.join('|')})\z/.match?(path)
when Regexp
rule.match?(path)
else
false
end
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/directory.rb 0000644 00000014030 15173517742 0015151 0 ustar 00 # frozen_string_literal: true
require 'time'
require_relative 'constants'
require_relative 'utils'
require_relative 'head'
require_relative 'mime'
require_relative 'files'
module Rack
# Rack::Directory serves entries below the +root+ given, according to the
# path info of the Rack request. If a directory is found, the file's contents
# will be presented in an html based index. If a file is found, the env will
# be passed to the specified +app+.
#
# If +app+ is not specified, a Rack::Files of the same +root+ will be used.
class Directory
DIR_FILE = "<tr><td class='name'><a href='%s'>%s</a></td><td class='size'>%s</td><td class='type'>%s</td><td class='mtime'>%s</td></tr>\n"
DIR_PAGE_HEADER = <<-PAGE
<html><head>
<title>%s</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<style type='text/css'>
table { width:100%%; }
.name { text-align:left; }
.size, .mtime { text-align:right; }
.type { width:11em; }
.mtime { width:15em; }
</style>
</head><body>
<h1>%s</h1>
<hr />
<table>
<tr>
<th class='name'>Name</th>
<th class='size'>Size</th>
<th class='type'>Type</th>
<th class='mtime'>Last Modified</th>
</tr>
PAGE
DIR_PAGE_FOOTER = <<-PAGE
</table>
<hr />
</body></html>
PAGE
# Body class for directory entries, showing an index page with links
# to each file.
class DirectoryBody < Struct.new(:root, :path, :files)
# Yield strings for each part of the directory entry
def each
show_path = Utils.escape_html(path.sub(/^#{root}/, ''))
yield(DIR_PAGE_HEADER % [ show_path, show_path ])
unless path.chomp('/') == root
yield(DIR_FILE % DIR_FILE_escape(files.call('..')))
end
Dir.foreach(path) do |basename|
next if basename.start_with?('.')
next unless f = files.call(basename)
yield(DIR_FILE % DIR_FILE_escape(f))
end
yield(DIR_PAGE_FOOTER)
end
private
# Escape each element in the array of html strings.
def DIR_FILE_escape(htmls)
htmls.map { |e| Utils.escape_html(e) }
end
end
# The root of the directory hierarchy. Only requests for files and
# directories inside of the root directory are supported.
attr_reader :root
# Set the root directory and application for serving files.
def initialize(root, app = nil)
@root = ::File.expand_path(root)
@app = app || Files.new(@root)
@head = Head.new(method(:get))
end
def call(env)
# strip body if this is a HEAD call
@head.call env
end
# Internals of request handling. Similar to call but does
# not remove body for HEAD requests.
def get(env)
script_name = env[SCRIPT_NAME]
path_info = Utils.unescape_path(env[PATH_INFO])
if client_error_response = check_bad_request(path_info) || check_forbidden(path_info)
client_error_response
else
path = ::File.join(@root, path_info)
list_path(env, path, path_info, script_name)
end
end
# Rack response to use for requests with invalid paths, or nil if path is valid.
def check_bad_request(path_info)
return if Utils.valid_path?(path_info)
body = "Bad Request\n"
[400, { CONTENT_TYPE => "text/plain",
CONTENT_LENGTH => body.bytesize.to_s,
"x-cascade" => "pass" }, [body]]
end
# Rack response to use for requests with paths outside the root, or nil if path is inside the root.
def check_forbidden(path_info)
return unless path_info.include? ".."
return if ::File.expand_path(::File.join(@root, path_info)).start_with?(@root)
body = "Forbidden\n"
[403, { CONTENT_TYPE => "text/plain",
CONTENT_LENGTH => body.bytesize.to_s,
"x-cascade" => "pass" }, [body]]
end
# Rack response to use for directories under the root.
def list_directory(path_info, path, script_name)
url_head = (script_name.split('/') + path_info.split('/')).map do |part|
Utils.escape_path part
end
# Globbing not safe as path could contain glob metacharacters
body = DirectoryBody.new(@root, path, ->(basename) do
stat = stat(::File.join(path, basename))
next unless stat
url = ::File.join(*url_head + [Utils.escape_path(basename)])
mtime = stat.mtime.httpdate
if stat.directory?
type = 'directory'
size = '-'
url << '/'
if basename == '..'
basename = 'Parent Directory'
else
basename << '/'
end
else
type = Mime.mime_type(::File.extname(basename))
size = filesize_format(stat.size)
end
[ url, basename, size, type, mtime ]
end)
[ 200, { CONTENT_TYPE => 'text/html; charset=utf-8' }, body ]
end
# File::Stat for the given path, but return nil for missing/bad entries.
def stat(path)
::File.stat(path)
rescue Errno::ENOENT, Errno::ELOOP
return nil
end
# Rack response to use for files and directories under the root.
# Unreadable and non-file, non-directory entries will get a 404 response.
def list_path(env, path, path_info, script_name)
if (stat = stat(path)) && stat.readable?
return @app.call(env) if stat.file?
return list_directory(path_info, path, script_name) if stat.directory?
end
entity_not_found(path_info)
end
# Rack response to use for unreadable and non-file, non-directory entries.
def entity_not_found(path_info)
body = "Entity not found: #{path_info}\n"
[404, { CONTENT_TYPE => "text/plain",
CONTENT_LENGTH => body.bytesize.to_s,
"x-cascade" => "pass" }, [body]]
end
# Stolen from Ramaze
FILESIZE_FORMAT = [
['%.1fT', 1 << 40],
['%.1fG', 1 << 30],
['%.1fM', 1 << 20],
['%.1fK', 1 << 10],
]
# Provide human readable file sizes
def filesize_format(int)
FILESIZE_FORMAT.each do |format, size|
return format % (int.to_f / size) if int >= size
end
"#{int}B"
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/mock_request.rb 0000644 00000012573 15173517742 0015660 0 ustar 00 # frozen_string_literal: true
require 'uri'
require 'stringio'
require_relative 'constants'
require_relative 'mock_response'
module Rack
# Rack::MockRequest helps testing your Rack application without
# actually using HTTP.
#
# After performing a request on a URL with get/post/put/patch/delete, it
# returns a MockResponse with useful helper methods for effective
# testing.
#
# You can pass a hash with additional configuration to the
# get/post/put/patch/delete.
# <tt>:input</tt>:: A String or IO-like to be used as rack.input.
# <tt>:fatal</tt>:: Raise a FatalWarning if the app writes to rack.errors.
# <tt>:lint</tt>:: If true, wrap the application in a Rack::Lint.
class MockRequest
class FatalWarning < RuntimeError
end
class FatalWarner
def puts(warning)
raise FatalWarning, warning
end
def write(warning)
raise FatalWarning, warning
end
def flush
end
def string
""
end
end
DEFAULT_ENV = {
RACK_INPUT => StringIO.new,
RACK_ERRORS => StringIO.new,
}.freeze
def initialize(app)
@app = app
end
# Make a GET request and return a MockResponse. See #request.
def get(uri, opts = {}) request(GET, uri, opts) end
# Make a POST request and return a MockResponse. See #request.
def post(uri, opts = {}) request(POST, uri, opts) end
# Make a PUT request and return a MockResponse. See #request.
def put(uri, opts = {}) request(PUT, uri, opts) end
# Make a PATCH request and return a MockResponse. See #request.
def patch(uri, opts = {}) request(PATCH, uri, opts) end
# Make a DELETE request and return a MockResponse. See #request.
def delete(uri, opts = {}) request(DELETE, uri, opts) end
# Make a HEAD request and return a MockResponse. See #request.
def head(uri, opts = {}) request(HEAD, uri, opts) end
# Make an OPTIONS request and return a MockResponse. See #request.
def options(uri, opts = {}) request(OPTIONS, uri, opts) end
# Make a request using the given request method for the given
# uri to the rack application and return a MockResponse.
# Options given are passed to MockRequest.env_for.
def request(method = GET, uri = "", opts = {})
env = self.class.env_for(uri, opts.merge(method: method))
if opts[:lint]
app = Rack::Lint.new(@app)
else
app = @app
end
errors = env[RACK_ERRORS]
status, headers, body = app.call(env)
MockResponse.new(status, headers, body, errors)
ensure
body.close if body.respond_to?(:close)
end
# For historical reasons, we're pinning to RFC 2396.
# URI::Parser = URI::RFC2396_Parser
def self.parse_uri_rfc2396(uri)
@parser ||= URI::Parser.new
@parser.parse(uri)
end
# Return the Rack environment used for a request to +uri+.
# All options that are strings are added to the returned environment.
# Options:
# :fatal :: Whether to raise an exception if request outputs to rack.errors
# :input :: The rack.input to set
# :http_version :: The SERVER_PROTOCOL to set
# :method :: The HTTP request method to use
# :params :: The params to use
# :script_name :: The SCRIPT_NAME to set
def self.env_for(uri = "", opts = {})
uri = parse_uri_rfc2396(uri)
uri.path = "/#{uri.path}" unless uri.path[0] == ?/
env = DEFAULT_ENV.dup
env[REQUEST_METHOD] = (opts[:method] ? opts[:method].to_s.upcase : GET).b
env[SERVER_NAME] = (uri.host || "example.org").b
env[SERVER_PORT] = (uri.port ? uri.port.to_s : "80").b
env[SERVER_PROTOCOL] = opts[:http_version] || 'HTTP/1.1'
env[QUERY_STRING] = (uri.query.to_s).b
env[PATH_INFO] = (uri.path).b
env[RACK_URL_SCHEME] = (uri.scheme || "http").b
env[HTTPS] = (env[RACK_URL_SCHEME] == "https" ? "on" : "off").b
env[SCRIPT_NAME] = opts[:script_name] || ""
if opts[:fatal]
env[RACK_ERRORS] = FatalWarner.new
else
env[RACK_ERRORS] = StringIO.new
end
if params = opts[:params]
if env[REQUEST_METHOD] == GET
params = Utils.parse_nested_query(params) if params.is_a?(String)
params.update(Utils.parse_nested_query(env[QUERY_STRING]))
env[QUERY_STRING] = Utils.build_nested_query(params)
elsif !opts.has_key?(:input)
opts["CONTENT_TYPE"] = "application/x-www-form-urlencoded"
if params.is_a?(Hash)
if data = Rack::Multipart.build_multipart(params)
opts[:input] = data
opts["CONTENT_LENGTH"] ||= data.length.to_s
opts["CONTENT_TYPE"] = "multipart/form-data; boundary=#{Rack::Multipart::MULTIPART_BOUNDARY}"
else
opts[:input] = Utils.build_nested_query(params)
end
else
opts[:input] = params
end
end
end
opts[:input] ||= String.new
if String === opts[:input]
rack_input = StringIO.new(opts[:input])
else
rack_input = opts[:input]
end
rack_input.set_encoding(Encoding::BINARY)
env[RACK_INPUT] = rack_input
env["CONTENT_LENGTH"] ||= env[RACK_INPUT].size.to_s if env[RACK_INPUT].respond_to?(:size)
opts.each { |field, value|
env[field] = value if String === field
}
env
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/version.rb 0000644 00000001676 15173517742 0014646 0 ustar 00 # frozen_string_literal: true
# Copyright (C) 2007-2019 Leah Neukirchen <http://leahneukirchen.org/infopage.html>
#
# Rack is freely distributable under the terms of an MIT-style license.
# See MIT-LICENSE or https://opensource.org/licenses/MIT.
# The Rack main module, serving as a namespace for all core Rack
# modules and classes.
#
# All modules meant for use in your application are <tt>autoload</tt>ed here,
# so it should be enough just to <tt>require 'rack'</tt> in your code.
module Rack
# The Rack protocol version number implemented.
VERSION = [1, 3].freeze
deprecate_constant :VERSION
VERSION_STRING = "1.3".freeze
deprecate_constant :VERSION_STRING
# The Rack protocol version number implemented.
def self.version
warn "Rack.version is deprecated and will be removed in Rack 3.1!", uplevel: 1
VERSION
end
RELEASE = "3.0.8"
# Return the Rack release as a dotted string.
def self.release
RELEASE
end
end
share/gems/gems/rack-3.0.8/lib/rack/common_logger.rb 0000644 00000006170 15173517742 0016002 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
require_relative 'body_proxy'
require_relative 'request'
module Rack
# Rack::CommonLogger forwards every request to the given +app+, and
# logs a line in the
# {Apache common log format}[http://httpd.apache.org/docs/1.3/logs.html#common]
# to the configured logger.
class CommonLogger
# Common Log Format: http://httpd.apache.org/docs/1.3/logs.html#common
#
# lilith.local - - [07/Aug/2006 23:58:02 -0400] "GET / HTTP/1.1" 500 -
#
# %{%s - %s [%s] "%s %s%s %s" %d %s\n} %
#
# The actual format is slightly different than the above due to the
# separation of SCRIPT_NAME and PATH_INFO, and because the elapsed
# time in seconds is included at the end.
FORMAT = %{%s - %s [%s] "%s %s%s%s %s" %d %s %0.4f\n}
# +logger+ can be any object that supports the +write+ or +<<+ methods,
# which includes the standard library Logger. These methods are called
# with a single string argument, the log message.
# If +logger+ is nil, CommonLogger will fall back <tt>env['rack.errors']</tt>.
def initialize(app, logger = nil)
@app = app
@logger = logger
end
# Log all requests in common_log format after a response has been
# returned. Note that if the app raises an exception, the request
# will not be logged, so if exception handling middleware are used,
# they should be loaded after this middleware. Additionally, because
# the logging happens after the request body has been fully sent, any
# exceptions raised during the sending of the response body will
# cause the request not to be logged.
def call(env)
began_at = Utils.clock_time
status, headers, body = response = @app.call(env)
response[2] = BodyProxy.new(body) { log(env, status, headers, began_at) }
response
end
private
# Log the request to the configured logger.
def log(env, status, response_headers, began_at)
request = Rack::Request.new(env)
length = extract_content_length(response_headers)
msg = sprintf(FORMAT,
request.ip || "-",
request.get_header("REMOTE_USER") || "-",
Time.now.strftime("%d/%b/%Y:%H:%M:%S %z"),
request.request_method,
request.script_name,
request.path_info,
request.query_string.empty? ? "" : "?#{request.query_string}",
request.get_header(SERVER_PROTOCOL),
status.to_s[0..3],
length,
Utils.clock_time - began_at)
msg.gsub!(/[^[:print:]\n]/) { |c| sprintf("\\x%x", c.ord) }
logger = @logger || request.get_header(RACK_ERRORS)
# Standard library logger doesn't support write but it supports << which actually
# calls to write on the log device without formatting
if logger.respond_to?(:write)
logger.write(msg)
else
logger << msg
end
end
# Attempt to determine the content length for the response to
# include it in the logged data.
def extract_content_length(headers)
value = headers[CONTENT_LENGTH]
!value || value.to_s == '0' ? '-' : value
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/null_logger.rb 0000644 00000002275 15173517742 0015466 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
module Rack
class NullLogger
def initialize(app)
@app = app
end
def call(env)
env[RACK_LOGGER] = self
@app.call(env)
end
def info(progname = nil, &block); end
def debug(progname = nil, &block); end
def warn(progname = nil, &block); end
def error(progname = nil, &block); end
def fatal(progname = nil, &block); end
def unknown(progname = nil, &block); end
def info? ; end
def debug? ; end
def warn? ; end
def error? ; end
def fatal? ; end
def debug! ; end
def error! ; end
def fatal! ; end
def info! ; end
def warn! ; end
def level ; end
def progname ; end
def datetime_format ; end
def formatter ; end
def sev_threshold ; end
def level=(level); end
def progname=(progname); end
def datetime_format=(datetime_format); end
def formatter=(formatter); end
def sev_threshold=(sev_threshold); end
def close ; end
def add(severity, message = nil, progname = nil, &block); end
def log(severity, message = nil, progname = nil, &block); end
def <<(msg); end
def reopen(logdev = nil); end
end
end
share/gems/gems/rack-3.0.8/lib/rack/chunked.rb 0000644 00000006464 15173517742 0014602 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
module Rack
warn "Rack::Chunked is deprecated and will be removed in Rack 3.1", uplevel: 1
# Middleware that applies chunked transfer encoding to response bodies
# when the response does not include a content-length header.
#
# This supports the trailer response header to allow the use of trailing
# headers in the chunked encoding. However, using this requires you manually
# specify a response body that supports a +trailers+ method. Example:
#
# [200, { 'trailer' => 'expires'}, ["Hello", "World"]]
# # error raised
#
# body = ["Hello", "World"]
# def body.trailers
# { 'expires' => Time.now.to_s }
# end
# [200, { 'trailer' => 'expires'}, body]
# # No exception raised
class Chunked
include Rack::Utils
# A body wrapper that emits chunked responses.
class Body
TERM = "\r\n"
TAIL = "0#{TERM}"
# Store the response body to be chunked.
def initialize(body)
@body = body
end
# For each element yielded by the response body, yield
# the element in chunked encoding.
def each(&block)
term = TERM
@body.each do |chunk|
size = chunk.bytesize
next if size == 0
yield [size.to_s(16), term, chunk.b, term].join
end
yield TAIL
yield_trailers(&block)
yield term
end
# Close the response body if the response body supports it.
def close
@body.close if @body.respond_to?(:close)
end
private
# Do nothing as this class does not support trailer headers.
def yield_trailers
end
end
# A body wrapper that emits chunked responses and also supports
# sending Trailer headers. Note that the response body provided to
# initialize must have a +trailers+ method that returns a hash
# of trailer headers, and the rack response itself should have a
# Trailer header listing the headers that the +trailers+ method
# will return.
class TrailerBody < Body
private
# Yield strings for each trailer header.
def yield_trailers
@body.trailers.each_pair do |k, v|
yield "#{k}: #{v}\r\n"
end
end
end
def initialize(app)
@app = app
end
# Whether the HTTP version supports chunked encoding (HTTP 1.1 does).
def chunkable_version?(ver)
case ver
# pre-HTTP/1.0 (informally "HTTP/0.9") HTTP requests did not have
# a version (nor response headers)
when 'HTTP/1.0', nil, 'HTTP/0.9'
false
else
true
end
end
# If the rack app returns a response that should have a body,
# but does not have content-length or transfer-encoding headers,
# modify the response to use chunked transfer-encoding.
def call(env)
status, headers, body = response = @app.call(env)
if chunkable_version?(env[SERVER_PROTOCOL]) &&
!STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) &&
!headers[CONTENT_LENGTH] &&
!headers[TRANSFER_ENCODING]
headers[TRANSFER_ENCODING] = 'chunked'
if headers['trailer']
response[2] = TrailerBody.new(body)
else
response[2] = Body.new(body)
end
end
response
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/media_type.rb 0000644 00000002631 15173517742 0015271 0 ustar 00 # frozen_string_literal: true
module Rack
# Rack::MediaType parse media type and parameters out of content_type string
class MediaType
SPLIT_PATTERN = %r{\s*[;,]\s*}
class << self
# The media type (type/subtype) portion of the CONTENT_TYPE header
# without any media type parameters. e.g., when CONTENT_TYPE is
# "text/plain;charset=utf-8", the media-type is "text/plain".
#
# For more information on the use of media types in HTTP, see:
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
def type(content_type)
return nil unless content_type
content_type.split(SPLIT_PATTERN, 2).first.tap(&:downcase!)
end
# The media type parameters provided in CONTENT_TYPE as a Hash, or
# an empty Hash if no CONTENT_TYPE or media-type parameters were
# provided. e.g., when the CONTENT_TYPE is "text/plain;charset=utf-8",
# this method responds with the following Hash:
# { 'charset' => 'utf-8' }
def params(content_type)
return {} if content_type.nil?
content_type.split(SPLIT_PATTERN)[1..-1].each_with_object({}) do |s, hsh|
k, v = s.split('=', 2)
hsh[k.tap(&:downcase!)] = strip_doublequotes(v)
end
end
private
def strip_doublequotes(str)
(str.start_with?('"') && str.end_with?('"')) ? str[1..-2] : str
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/show_status.rb 0000644 00000007116 15173517742 0015537 0 ustar 00 # frozen_string_literal: true
require 'erb'
require_relative 'constants'
require_relative 'utils'
require_relative 'request'
require_relative 'body_proxy'
module Rack
# Rack::ShowStatus catches all empty responses and replaces them
# with a site explaining the error.
#
# Additional details can be put into <tt>rack.showstatus.detail</tt>
# and will be shown as HTML. If such details exist, the error page
# is always rendered, even if the reply was not empty.
class ShowStatus
def initialize(app)
@app = app
@template = ERB.new(TEMPLATE)
end
def call(env)
status, headers, body = response = @app.call(env)
empty = headers[CONTENT_LENGTH].to_i <= 0
# client or server error, or explicit message
if (status.to_i >= 400 && empty) || env[RACK_SHOWSTATUS_DETAIL]
# This double assignment is to prevent an "unused variable" warning.
# Yes, it is dumb, but I don't like Ruby yelling at me.
req = req = Rack::Request.new(env)
message = Rack::Utils::HTTP_STATUS_CODES[status.to_i] || status.to_s
# This double assignment is to prevent an "unused variable" warning.
# Yes, it is dumb, but I don't like Ruby yelling at me.
detail = detail = env[RACK_SHOWSTATUS_DETAIL] || message
html = @template.result(binding)
size = html.bytesize
response[2] = Rack::BodyProxy.new([html]) do
body.close if body.respond_to?(:close)
end
headers[CONTENT_TYPE] = "text/html"
headers[CONTENT_LENGTH] = size.to_s
end
response
end
def h(obj) # :nodoc:
case obj
when String
Utils.escape_html(obj)
else
Utils.escape_html(obj.inspect)
end
end
# :stopdoc:
# adapted from Django <www.djangoproject.com>
# Copyright (c) Django Software Foundation and individual contributors.
# Used under the modified BSD license:
# http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5
TEMPLATE = <<'HTML'
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title><%=h message %> at <%=h req.script_name + req.path_info %></title>
<meta name="robots" content="NONE,NOARCHIVE" />
<style type="text/css">
html * { padding:0; margin:0; }
body * { padding:10px 20px; }
body * * { padding:0; }
body { font:small sans-serif; background:#eee; }
body>div { border-bottom:1px solid #ddd; }
h1 { font-weight:normal; margin-bottom:.4em; }
h1 span { font-size:60%; color:#666; font-weight:normal; }
table { border:none; border-collapse: collapse; width:100%; }
td, th { vertical-align:top; padding:2px 3px; }
th { width:12em; text-align:right; color:#666; padding-right:.5em; }
#info { background:#f6f6f6; }
#info ol { margin: 0.5em 4em; }
#info ol li { font-family: monospace; }
#summary { background: #ffc; }
#explanation { background:#eee; border-bottom: 0px none; }
</style>
</head>
<body>
<div id="summary">
<h1><%=h message %> <span>(<%= status.to_i %>)</span></h1>
<table class="meta">
<tr>
<th>Request Method:</th>
<td><%=h req.request_method %></td>
</tr>
<tr>
<th>Request URL:</th>
<td><%=h req.url %></td>
</tr>
</table>
</div>
<div id="info">
<p><%=h detail %></p>
</div>
<div id="explanation">
<p>
You're seeing this error because you use <code>Rack::ShowStatus</code>.
</p>
</div>
</body>
</html>
HTML
# :startdoc:
end
end
share/gems/gems/rack-3.0.8/lib/rack/urlmap.rb 0000644 00000005475 15173517742 0014462 0 ustar 00 # frozen_string_literal: true
require 'set'
require_relative 'constants'
module Rack
# Rack::URLMap takes a hash mapping urls or paths to apps, and
# dispatches accordingly. Support for HTTP/1.1 host names exists if
# the URLs start with <tt>http://</tt> or <tt>https://</tt>.
#
# URLMap modifies the SCRIPT_NAME and PATH_INFO such that the part
# relevant for dispatch is in the SCRIPT_NAME, and the rest in the
# PATH_INFO. This should be taken care of when you need to
# reconstruct the URL in order to create links.
#
# URLMap dispatches in such a way that the longest paths are tried
# first, since they are most specific.
class URLMap
def initialize(map = {})
remap(map)
end
def remap(map)
@known_hosts = Set[]
@mapping = map.map { |location, app|
if location =~ %r{\Ahttps?://(.*?)(/.*)}
host, location = $1, $2
@known_hosts << host
else
host = nil
end
unless location[0] == ?/
raise ArgumentError, "paths need to start with /"
end
location = location.chomp('/')
match = Regexp.new("^#{Regexp.quote(location).gsub('/', '/+')}(.*)", Regexp::NOENCODING)
[host, location, match, app]
}.sort_by do |(host, location, _, _)|
[host ? -host.size : Float::INFINITY, -location.size]
end
end
def call(env)
path = env[PATH_INFO]
script_name = env[SCRIPT_NAME]
http_host = env[HTTP_HOST]
server_name = env[SERVER_NAME]
server_port = env[SERVER_PORT]
is_same_server = casecmp?(http_host, server_name) ||
casecmp?(http_host, "#{server_name}:#{server_port}")
is_host_known = @known_hosts.include? http_host
@mapping.each do |host, location, match, app|
unless casecmp?(http_host, host) \
|| casecmp?(server_name, host) \
|| (!host && is_same_server) \
|| (!host && !is_host_known) # If we don't have a matching host, default to the first without a specified host
next
end
next unless m = match.match(path.to_s)
rest = m[1]
next unless !rest || rest.empty? || rest[0] == ?/
env[SCRIPT_NAME] = (script_name + location)
env[PATH_INFO] = rest
return app.call(env)
end
[404, { CONTENT_TYPE => "text/plain", "x-cascade" => "pass" }, ["Not Found: #{path}"]]
ensure
env[PATH_INFO] = path
env[SCRIPT_NAME] = script_name
end
private
def casecmp?(v1, v2)
# if both nil, or they're the same string
return true if v1 == v2
# if either are nil... (but they're not the same)
return false if v1.nil?
return false if v2.nil?
# otherwise check they're not case-insensitive the same
v1.casecmp(v2).zero?
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/config.rb 0000644 00000000632 15173517742 0014415 0 ustar 00 # frozen_string_literal: true
module Rack
# Rack::Config modifies the environment using the block given during
# initialization.
#
# Example:
# use Rack::Config do |env|
# env['my-key'] = 'some-value'
# end
class Config
def initialize(app, &block)
@app = app
@block = block
end
def call(env)
@block.call(env)
@app.call(env)
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/sendfile.rb 0000644 00000013070 15173517742 0014741 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'utils'
require_relative 'body_proxy'
module Rack
# = Sendfile
#
# The Sendfile middleware intercepts responses whose body is being
# served from a file and replaces it with a server specific x-sendfile
# header. The web server is then responsible for writing the file contents
# to the client. This can dramatically reduce the amount of work required
# by the Ruby backend and takes advantage of the web server's optimized file
# delivery code.
#
# In order to take advantage of this middleware, the response body must
# respond to +to_path+ and the request must include an x-sendfile-type
# header. Rack::Files and other components implement +to_path+ so there's
# rarely anything you need to do in your application. The x-sendfile-type
# header is typically set in your web servers configuration. The following
# sections attempt to document
#
# === Nginx
#
# Nginx supports the x-accel-redirect header. This is similar to x-sendfile
# but requires parts of the filesystem to be mapped into a private URL
# hierarchy.
#
# The following example shows the Nginx configuration required to create
# a private "/files/" area, enable x-accel-redirect, and pass the special
# x-sendfile-type and x-accel-mapping headers to the backend:
#
# location ~ /files/(.*) {
# internal;
# alias /var/www/$1;
# }
#
# location / {
# proxy_redirect off;
#
# proxy_set_header Host $host;
# proxy_set_header X-Real-IP $remote_addr;
# proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
#
# proxy_set_header x-sendfile-type x-accel-redirect;
# proxy_set_header x-accel-mapping /var/www/=/files/;
#
# proxy_pass http://127.0.0.1:8080/;
# }
#
# Note that the x-sendfile-type header must be set exactly as shown above.
# The x-accel-mapping header should specify the location on the file system,
# followed by an equals sign (=), followed name of the private URL pattern
# that it maps to. The middleware performs a simple substitution on the
# resulting path.
#
# See Also: https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile
#
# === lighttpd
#
# Lighttpd has supported some variation of the x-sendfile header for some
# time, although only recent version support x-sendfile in a reverse proxy
# configuration.
#
# $HTTP["host"] == "example.com" {
# proxy-core.protocol = "http"
# proxy-core.balancer = "round-robin"
# proxy-core.backends = (
# "127.0.0.1:8000",
# "127.0.0.1:8001",
# ...
# )
#
# proxy-core.allow-x-sendfile = "enable"
# proxy-core.rewrite-request = (
# "x-sendfile-type" => (".*" => "x-sendfile")
# )
# }
#
# See Also: http://redmine.lighttpd.net/wiki/lighttpd/Docs:ModProxyCore
#
# === Apache
#
# x-sendfile is supported under Apache 2.x using a separate module:
#
# https://tn123.org/mod_xsendfile/
#
# Once the module is compiled and installed, you can enable it using
# XSendFile config directive:
#
# RequestHeader Set x-sendfile-type x-sendfile
# ProxyPassReverse / http://localhost:8001/
# XSendFile on
#
# === Mapping parameter
#
# The third parameter allows for an overriding extension of the
# x-accel-mapping header. Mappings should be provided in tuples of internal to
# external. The internal values may contain regular expression syntax, they
# will be matched with case indifference.
class Sendfile
def initialize(app, variation = nil, mappings = [])
@app = app
@variation = variation
@mappings = mappings.map do |internal, external|
[/^#{internal}/i, external]
end
end
def call(env)
_, headers, body = response = @app.call(env)
if body.respond_to?(:to_path)
case type = variation(env)
when /x-accel-redirect/i
path = ::File.expand_path(body.to_path)
if url = map_accel_path(env, path)
headers[CONTENT_LENGTH] = '0'
# '?' must be percent-encoded because it is not query string but a part of path
headers[type.downcase] = ::Rack::Utils.escape_path(url).gsub('?', '%3F')
obody = body
response[2] = Rack::BodyProxy.new([]) do
obody.close if obody.respond_to?(:close)
end
else
env[RACK_ERRORS].puts "x-accel-mapping header missing"
end
when /x-sendfile|x-lighttpd-send-file/i
path = ::File.expand_path(body.to_path)
headers[CONTENT_LENGTH] = '0'
headers[type.downcase] = path
obody = body
response[2] = Rack::BodyProxy.new([]) do
obody.close if obody.respond_to?(:close)
end
when '', nil
else
env[RACK_ERRORS].puts "Unknown x-sendfile variation: '#{type}'.\n"
end
end
response
end
private
def variation(env)
@variation ||
env['sendfile.type'] ||
env['HTTP_X_SENDFILE_TYPE']
end
def map_accel_path(env, path)
if mapping = @mappings.find { |internal, _| internal =~ path }
path.sub(*mapping)
elsif mapping = env['HTTP_X_ACCEL_MAPPING']
mapping.split(',').map(&:strip).each do |m|
internal, external = m.split('=', 2).map(&:strip)
new_path = path.sub(/^#{internal}/i, external)
return new_path unless path == new_path
end
path
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/file.rb 0000644 00000000247 15173517742 0014071 0 ustar 00 # frozen_string_literal: true
require_relative 'files'
module Rack
warn "Rack::File is deprecated and will be removed in Rack 3.1", uplevel: 1
File = Files
end
share/gems/gems/rack-3.0.8/lib/rack/lock.rb 0000644 00000001075 15173517742 0014102 0 ustar 00 # frozen_string_literal: true
require_relative 'body_proxy'
module Rack
# Rack::Lock locks every request inside a mutex, so that every request
# will effectively be executed synchronously.
class Lock
def initialize(app, mutex = Mutex.new)
@app, @mutex = app, mutex
end
def call(env)
@mutex.lock
begin
response = @app.call(env)
returned = response << BodyProxy.new(response.pop) { unlock }
ensure
unlock unless returned
end
end
private
def unlock
@mutex.unlock
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/method_override.rb 0000644 00000002710 15173517742 0016326 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'request'
require_relative 'utils'
module Rack
class MethodOverride
HTTP_METHODS = %w[GET HEAD PUT POST DELETE OPTIONS PATCH LINK UNLINK]
METHOD_OVERRIDE_PARAM_KEY = "_method"
HTTP_METHOD_OVERRIDE_HEADER = "HTTP_X_HTTP_METHOD_OVERRIDE"
ALLOWED_METHODS = %w[POST]
def initialize(app)
@app = app
end
def call(env)
if allowed_methods.include?(env[REQUEST_METHOD])
method = method_override(env)
if HTTP_METHODS.include?(method)
env[RACK_METHODOVERRIDE_ORIGINAL_METHOD] = env[REQUEST_METHOD]
env[REQUEST_METHOD] = method
end
end
@app.call(env)
end
def method_override(env)
req = Request.new(env)
method = method_override_param(req) ||
env[HTTP_METHOD_OVERRIDE_HEADER]
begin
method.to_s.upcase
rescue ArgumentError
env[RACK_ERRORS].puts "Invalid string for method"
end
end
private
def allowed_methods
ALLOWED_METHODS
end
def method_override_param(req)
req.POST[METHOD_OVERRIDE_PARAM_KEY] if req.form_data? || req.parseable_data?
rescue Utils::InvalidParameterError, Utils::ParameterTypeError, QueryParser::ParamsTooDeepError
req.get_header(RACK_ERRORS).puts "Invalid or incomplete POST params"
rescue EOFError
req.get_header(RACK_ERRORS).puts "Bad request content body"
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/files.rb 0000644 00000013245 15173517742 0014256 0 ustar 00 # frozen_string_literal: true
require 'time'
require_relative 'constants'
require_relative 'head'
require_relative 'utils'
require_relative 'request'
require_relative 'mime'
module Rack
# Rack::Files serves files below the +root+ directory given, according to the
# path info of the Rack request.
# e.g. when Rack::Files.new("/etc") is used, you can access 'passwd' file
# as http://localhost:9292/passwd
#
# Handlers can detect if bodies are a Rack::Files, and use mechanisms
# like sendfile on the +path+.
class Files
ALLOWED_VERBS = %w[GET HEAD OPTIONS]
ALLOW_HEADER = ALLOWED_VERBS.join(', ')
MULTIPART_BOUNDARY = 'AaB03x'
attr_reader :root
def initialize(root, headers = {}, default_mime = 'text/plain')
@root = (::File.expand_path(root) if root)
@headers = headers
@default_mime = default_mime
@head = Rack::Head.new(lambda { |env| get env })
end
def call(env)
# HEAD requests drop the response body, including 4xx error messages.
@head.call env
end
def get(env)
request = Rack::Request.new env
unless ALLOWED_VERBS.include? request.request_method
return fail(405, "Method Not Allowed", { 'allow' => ALLOW_HEADER })
end
path_info = Utils.unescape_path request.path_info
return fail(400, "Bad Request") unless Utils.valid_path?(path_info)
clean_path_info = Utils.clean_path_info(path_info)
path = ::File.join(@root, clean_path_info)
available = begin
::File.file?(path) && ::File.readable?(path)
rescue SystemCallError
# Not sure in what conditions this exception can occur, but this
# is a safe way to handle such an error.
# :nocov:
false
# :nocov:
end
if available
serving(request, path)
else
fail(404, "File not found: #{path_info}")
end
end
def serving(request, path)
if request.options?
return [200, { 'allow' => ALLOW_HEADER, CONTENT_LENGTH => '0' }, []]
end
last_modified = ::File.mtime(path).httpdate
return [304, {}, []] if request.get_header('HTTP_IF_MODIFIED_SINCE') == last_modified
headers = { "last-modified" => last_modified }
mime_type = mime_type path, @default_mime
headers[CONTENT_TYPE] = mime_type if mime_type
# Set custom headers
headers.merge!(@headers) if @headers
status = 200
size = filesize path
ranges = Rack::Utils.get_byte_ranges(request.get_header('HTTP_RANGE'), size)
if ranges.nil?
# No ranges:
ranges = [0..size - 1]
elsif ranges.empty?
# Unsatisfiable. Return error, and file size:
response = fail(416, "Byte range unsatisfiable")
response[1]["content-range"] = "bytes */#{size}"
return response
else
# Partial content
partial_content = true
if ranges.size == 1
range = ranges[0]
headers["content-range"] = "bytes #{range.begin}-#{range.end}/#{size}"
else
headers[CONTENT_TYPE] = "multipart/byteranges; boundary=#{MULTIPART_BOUNDARY}"
end
status = 206
body = BaseIterator.new(path, ranges, mime_type: mime_type, size: size)
size = body.bytesize
end
headers[CONTENT_LENGTH] = size.to_s
if request.head?
body = []
elsif !partial_content
body = Iterator.new(path, ranges, mime_type: mime_type, size: size)
end
[status, headers, body]
end
class BaseIterator
attr_reader :path, :ranges, :options
def initialize(path, ranges, options)
@path = path
@ranges = ranges
@options = options
end
def each
::File.open(path, "rb") do |file|
ranges.each do |range|
yield multipart_heading(range) if multipart?
each_range_part(file, range) do |part|
yield part
end
end
yield "\r\n--#{MULTIPART_BOUNDARY}--\r\n" if multipart?
end
end
def bytesize
size = ranges.inject(0) do |sum, range|
sum += multipart_heading(range).bytesize if multipart?
sum += range.size
end
size += "\r\n--#{MULTIPART_BOUNDARY}--\r\n".bytesize if multipart?
size
end
def close; end
private
def multipart?
ranges.size > 1
end
def multipart_heading(range)
<<-EOF
\r
--#{MULTIPART_BOUNDARY}\r
content-type: #{options[:mime_type]}\r
content-range: bytes #{range.begin}-#{range.end}/#{options[:size]}\r
\r
EOF
end
def each_range_part(file, range)
file.seek(range.begin)
remaining_len = range.end - range.begin + 1
while remaining_len > 0
part = file.read([8192, remaining_len].min)
break unless part
remaining_len -= part.length
yield part
end
end
end
class Iterator < BaseIterator
alias :to_path :path
end
private
def fail(status, body, headers = {})
body += "\n"
[
status,
{
CONTENT_TYPE => "text/plain",
CONTENT_LENGTH => body.size.to_s,
"x-cascade" => "pass"
}.merge!(headers),
[body]
]
end
# The MIME type for the contents of the file located at @path
def mime_type(path, default_mime)
Mime.mime_type(::File.extname(path), default_mime)
end
def filesize(path)
# We check via File::size? whether this file provides size info
# via stat (e.g. /proc files often don't), otherwise we have to
# figure it out by reading the whole file into memory.
::File.size?(path) || ::File.read(path).bytesize
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/head.rb 0000644 00000001014 15173517742 0014044 0 ustar 00 # frozen_string_literal: true
require_relative 'constants'
require_relative 'body_proxy'
module Rack
# Rack::Head returns an empty body for all HEAD requests. It leaves
# all other requests unchanged.
class Head
def initialize(app)
@app = app
end
def call(env)
_, _, body = response = @app.call(env)
if env[REQUEST_METHOD] == HEAD
response[2] = Rack::BodyProxy.new([]) do
body.close if body.respond_to? :close
end
end
response
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/builder.rb 0000644 00000021077 15173517742 0014604 0 ustar 00 # frozen_string_literal: true
require_relative 'urlmap'
module Rack
# Rack::Builder provides a domain-specific language (DSL) to construct Rack
# applications. It is primarily used to parse +config.ru+ files which
# instantiate several middleware and a final application which are hosted
# by a Rack-compatible web server.
#
# Example:
#
# app = Rack::Builder.new do
# use Rack::CommonLogger
# map "/ok" do
# run lambda { |env| [200, {'content-type' => 'text/plain'}, ['OK']] }
# end
# end
#
# run app
#
# Or
#
# app = Rack::Builder.app do
# use Rack::CommonLogger
# run lambda { |env| [200, {'content-type' => 'text/plain'}, ['OK']] }
# end
#
# run app
#
# +use+ adds middleware to the stack, +run+ dispatches to an application.
# You can use +map+ to construct a Rack::URLMap in a convenient way.
class Builder
# https://stackoverflow.com/questions/2223882/whats-the-difference-between-utf-8-and-utf-8-without-bom
UTF_8_BOM = '\xef\xbb\xbf'
# Parse the given config file to get a Rack application.
#
# If the config file ends in +.ru+, it is treated as a
# rackup file and the contents will be treated as if
# specified inside a Rack::Builder block.
#
# If the config file does not end in +.ru+, it is
# required and Rack will use the basename of the file
# to guess which constant will be the Rack application to run.
#
# Examples:
#
# Rack::Builder.parse_file('config.ru')
# # Rack application built using Rack::Builder.new
#
# Rack::Builder.parse_file('app.rb')
# # requires app.rb, which can be anywhere in Ruby's
# # load path. After requiring, assumes App constant
# # contains Rack application
#
# Rack::Builder.parse_file('./my_app.rb')
# # requires ./my_app.rb, which should be in the
# # process's current directory. After requiring,
# # assumes MyApp constant contains Rack application
def self.parse_file(path)
if path.end_with?('.ru')
return self.load_file(path)
else
require path
return Object.const_get(::File.basename(path, '.rb').split('_').map(&:capitalize).join(''))
end
end
# Load the given file as a rackup file, treating the
# contents as if specified inside a Rack::Builder block.
#
# Ignores content in the file after +__END__+, so that
# use of +__END__+ will not result in a syntax error.
#
# Example config.ru file:
#
# $ cat config.ru
#
# use Rack::ContentLength
# require './app.rb'
# run App
def self.load_file(path)
config = ::File.read(path)
config.slice!(/\A#{UTF_8_BOM}/) if config.encoding == Encoding::UTF_8
if config[/^#\\(.*)/]
fail "Parsing options from the first comment line is no longer supported: #{path}"
end
config.sub!(/^__END__\n.*\Z/m, '')
return new_from_string(config, path)
end
# Evaluate the given +builder_script+ string in the context of
# a Rack::Builder block, returning a Rack application.
def self.new_from_string(builder_script, file = "(rackup)")
# We want to build a variant of TOPLEVEL_BINDING with self as a Rack::Builder instance.
# We cannot use instance_eval(String) as that would resolve constants differently.
binding, builder = TOPLEVEL_BINDING.eval('Rack::Builder.new.instance_eval { [binding, self] }')
eval builder_script, binding, file
return builder.to_app
end
# Initialize a new Rack::Builder instance. +default_app+ specifies the
# default application if +run+ is not called later. If a block
# is given, it is evaluated in the context of the instance.
def initialize(default_app = nil, &block)
@use = []
@map = nil
@run = default_app
@warmup = nil
@freeze_app = false
instance_eval(&block) if block_given?
end
# Create a new Rack::Builder instance and return the Rack application
# generated from it.
def self.app(default_app = nil, &block)
self.new(default_app, &block).to_app
end
# Specifies middleware to use in a stack.
#
# class Middleware
# def initialize(app)
# @app = app
# end
#
# def call(env)
# env["rack.some_header"] = "setting an example"
# @app.call(env)
# end
# end
#
# use Middleware
# run lambda { |env| [200, { "content-type" => "text/plain" }, ["OK"]] }
#
# All requests through to this application will first be processed by the middleware class.
# The +call+ method in this example sets an additional environment key which then can be
# referenced in the application if required.
def use(middleware, *args, &block)
if @map
mapping, @map = @map, nil
@use << proc { |app| generate_map(app, mapping) }
end
@use << proc { |app| middleware.new(app, *args, &block) }
end
# :nocov:
ruby2_keywords(:use) if respond_to?(:ruby2_keywords, true)
# :nocov:
# Takes a block or argument that is an object that responds to #call and
# returns a Rack response.
#
# You can use a block:
#
# run do |env|
# [200, { "content-type" => "text/plain" }, ["Hello World!"]]
# end
#
# You can also provide a lambda:
#
# run lambda { |env| [200, { "content-type" => "text/plain" }, ["OK"]] }
#
# You can also provide a class instance:
#
# class Heartbeat
# def call(env)
# [200, { "content-type" => "text/plain" }, ["OK"]]
# end
# end
#
# run Heartbeat.new
#
def run(app = nil, &block)
raise ArgumentError, "Both app and block given!" if app && block_given?
@run = app || block
end
# Takes a lambda or block that is used to warm-up the application. This block is called
# before the Rack application is returned by to_app.
#
# warmup do |app|
# client = Rack::MockRequest.new(app)
# client.get('/')
# end
#
# use SomeMiddleware
# run MyApp
def warmup(prc = nil, &block)
@warmup = prc || block
end
# Creates a route within the application. Routes under the mapped path will be sent to
# the Rack application specified by run inside the block. Other requests will be sent to the
# default application specified by run outside the block.
#
# class App
# def call(env)
# [200, {'content-type' => 'text/plain'}, ["Hello World"]]
# end
# end
#
# class Heartbeat
# def call(env)
# [200, { "content-type" => "text/plain" }, ["OK"]]
# end
# end
#
# app = Rack::Builder.app do
# map '/heartbeat' do
# run Heartbeat.new
# end
# run App.new
# end
#
# run app
#
# The +use+ method can also be used inside the block to specify middleware to run under a specific path:
#
# app = Rack::Builder.app do
# map '/heartbeat' do
# use Middleware
# run Heartbeat.new
# end
# run App.new
# end
#
# This example includes a piece of middleware which will run before +/heartbeat+ requests hit +Heartbeat+.
#
# Note that providing a +path+ of +/+ will ignore any default application given in a +run+ statement
# outside the block.
def map(path, &block)
@map ||= {}
@map[path] = block
end
# Freeze the app (set using run) and all middleware instances when building the application
# in to_app.
def freeze_app
@freeze_app = true
end
# Return the Rack application generated by this instance.
def to_app
app = @map ? generate_map(@run, @map) : @run
fail "missing run or map statement" unless app
app.freeze if @freeze_app
app = @use.reverse.inject(app) { |a, e| e[a].tap { |x| x.freeze if @freeze_app } }
@warmup.call(app) if @warmup
app
end
# Call the Rack application generated by this builder instance. Note that
# this rebuilds the Rack application and runs the warmup code (if any)
# every time it is called, so it should not be used if performance is important.
def call(env)
to_app.call(env)
end
private
# Generate a URLMap instance by generating new Rack applications for each
# map block in this instance.
def generate_map(default_app, mapping)
mapped = default_app ? { '/' => default_app } : {}
mapping.each { |r, b| mapped[r] = self.class.new(default_app, &b).to_app }
URLMap.new(mapped)
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/response.rb 0000644 00000025345 15173517742 0015016 0 ustar 00 # frozen_string_literal: true
require 'time'
require_relative 'constants'
require_relative 'utils'
require_relative 'media_type'
require_relative 'headers'
module Rack
# Rack::Response provides a convenient interface to create a Rack
# response.
#
# It allows setting of headers and cookies, and provides useful
# defaults (an OK response with empty headers and body).
#
# You can use Response#write to iteratively generate your response,
# but note that this is buffered by Rack::Response until you call
# +finish+. +finish+ however can take a block inside which calls to
# +write+ are synchronous with the Rack response.
#
# Your application's +call+ should end returning Response#finish.
class Response
def self.[](status, headers, body)
self.new(body, status, headers)
end
CHUNKED = 'chunked'
STATUS_WITH_NO_ENTITY_BODY = Utils::STATUS_WITH_NO_ENTITY_BODY
attr_accessor :length, :status, :body
attr_reader :headers
# Deprecated, use headers instead.
def header
warn 'Rack::Response#header is deprecated and will be removed in Rack 3.1', uplevel: 1
headers
end
# Initialize the response object with the specified +body+, +status+
# and +headers+.
#
# If the +body+ is +nil+, construct an empty response object with internal
# buffering.
#
# If the +body+ responds to +to_str+, assume it's a string-like object and
# construct a buffered response object containing using that string as the
# initial contents of the buffer.
#
# Otherwise it is expected +body+ conforms to the normal requirements of a
# Rack response body, typically implementing one of +each+ (enumerable
# body) or +call+ (streaming body).
#
# The +status+ defaults to +200+ which is the "OK" HTTP status code. You
# can provide any other valid status code.
#
# The +headers+ must be a +Hash+ of key-value header pairs which conform to
# the Rack specification for response headers. The key must be a +String+
# instance and the value can be either a +String+ or +Array+ instance.
def initialize(body = nil, status = 200, headers = {})
@status = status.to_i
unless headers.is_a?(Hash)
warn "Providing non-hash headers to Rack::Response is deprecated and will be removed in Rack 3.1", uplevel: 1
end
@headers = Headers.new
# Convert headers input to a plain hash with lowercase keys.
headers.each do |k, v|
@headers[k] = v
end
@writer = self.method(:append)
@block = nil
# Keep track of whether we have expanded the user supplied body.
if body.nil?
@body = []
@buffered = true
@length = 0
elsif body.respond_to?(:to_str)
@body = [body]
@buffered = true
@length = body.to_str.bytesize
else
@body = body
@buffered = nil # undetermined as of yet.
@length = 0
end
yield self if block_given?
end
def redirect(target, status = 302)
self.status = status
self.location = target
end
def chunked?
CHUNKED == get_header(TRANSFER_ENCODING)
end
def no_entity_body?
# The response body is an enumerable body and it is not allowed to have an entity body.
@body.respond_to?(:each) && STATUS_WITH_NO_ENTITY_BODY[@status]
end
# Generate a response array consistent with the requirements of the SPEC.
# @return [Array] a 3-tuple suitable of `[status, headers, body]`
# which is suitable to be returned from the middleware `#call(env)` method.
def finish(&block)
if no_entity_body?
delete_header CONTENT_TYPE
delete_header CONTENT_LENGTH
close
return [@status, @headers, []]
else
if block_given?
@block = block
return [@status, @headers, self]
else
return [@status, @headers, @body]
end
end
end
alias to_a finish # For *response
def each(&callback)
@body.each(&callback)
@buffered = true
if @block
@writer = callback
@block.call(self)
end
end
# Append to body and update content-length.
#
# NOTE: Do not mix #write and direct #body access!
#
def write(chunk)
buffered_body!
@writer.call(chunk.to_s)
end
def close
@body.close if @body.respond_to?(:close)
end
def empty?
@block == nil && @body.empty?
end
def has_header?(key)
raise ArgumentError unless key.is_a?(String)
@headers.key?(key)
end
def get_header(key)
raise ArgumentError unless key.is_a?(String)
@headers[key]
end
def set_header(key, value)
raise ArgumentError unless key.is_a?(String)
@headers[key] = value
end
def delete_header(key)
raise ArgumentError unless key.is_a?(String)
@headers.delete key
end
alias :[] :get_header
alias :[]= :set_header
module Helpers
def invalid?; status < 100 || status >= 600; end
def informational?; status >= 100 && status < 200; end
def successful?; status >= 200 && status < 300; end
def redirection?; status >= 300 && status < 400; end
def client_error?; status >= 400 && status < 500; end
def server_error?; status >= 500 && status < 600; end
def ok?; status == 200; end
def created?; status == 201; end
def accepted?; status == 202; end
def no_content?; status == 204; end
def moved_permanently?; status == 301; end
def bad_request?; status == 400; end
def unauthorized?; status == 401; end
def forbidden?; status == 403; end
def not_found?; status == 404; end
def method_not_allowed?; status == 405; end
def not_acceptable?; status == 406; end
def request_timeout?; status == 408; end
def precondition_failed?; status == 412; end
def unprocessable?; status == 422; end
def redirect?; [301, 302, 303, 307, 308].include? status; end
def include?(header)
has_header?(header)
end
# Add a header that may have multiple values.
#
# Example:
# response.add_header 'vary', 'accept-encoding'
# response.add_header 'vary', 'cookie'
#
# assert_equal 'accept-encoding,cookie', response.get_header('vary')
#
# http://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
def add_header(key, value)
raise ArgumentError unless key.is_a?(String)
if value.nil?
return get_header(key)
end
value = value.to_s
if header = get_header(key)
if header.is_a?(Array)
header << value
else
set_header(key, [header, value])
end
else
set_header(key, value)
end
end
# Get the content type of the response.
def content_type
get_header CONTENT_TYPE
end
# Set the content type of the response.
def content_type=(content_type)
set_header CONTENT_TYPE, content_type
end
def media_type
MediaType.type(content_type)
end
def media_type_params
MediaType.params(content_type)
end
def content_length
cl = get_header CONTENT_LENGTH
cl ? cl.to_i : cl
end
def location
get_header "location"
end
def location=(location)
set_header "location", location
end
def set_cookie(key, value)
add_header SET_COOKIE, Utils.set_cookie_header(key, value)
end
def delete_cookie(key, value = {})
set_header(SET_COOKIE,
Utils.delete_set_cookie_header!(
get_header(SET_COOKIE), key, value
)
)
end
def set_cookie_header
get_header SET_COOKIE
end
def set_cookie_header=(value)
set_header SET_COOKIE, value
end
def cache_control
get_header CACHE_CONTROL
end
def cache_control=(value)
set_header CACHE_CONTROL, value
end
# Specifies that the content shouldn't be cached. Overrides `cache!` if already called.
def do_not_cache!
set_header CACHE_CONTROL, "no-cache, must-revalidate"
set_header EXPIRES, Time.now.httpdate
end
# Specify that the content should be cached.
# @param duration [Integer] The number of seconds until the cache expires.
# @option directive [String] The cache control directive, one of "public", "private", "no-cache" or "no-store".
def cache!(duration = 3600, directive: "public")
unless headers[CACHE_CONTROL] =~ /no-cache/
set_header CACHE_CONTROL, "#{directive}, max-age=#{duration}"
set_header EXPIRES, (Time.now + duration).httpdate
end
end
def etag
get_header ETAG
end
def etag=(value)
set_header ETAG, value
end
protected
def buffered_body!
if @buffered.nil?
if @body.is_a?(Array)
# The user supplied body was an array:
@body = @body.compact
@body.each do |part|
@length += part.to_s.bytesize
end
elsif @body.respond_to?(:each)
# Turn the user supplied body into a buffered array:
body = @body
@body = Array.new
body.each do |part|
@writer.call(part.to_s)
end
body.close if body.respond_to?(:close)
@buffered = true
else
@buffered = false
end
end
return @buffered
end
def append(chunk)
@body << chunk
unless chunked?
@length += chunk.bytesize
set_header(CONTENT_LENGTH, @length.to_s)
end
return chunk
end
end
include Helpers
class Raw
include Helpers
attr_reader :headers
attr_accessor :status
def initialize(status, headers)
@status = status
@headers = headers
end
def has_header?(key)
headers.key?(key)
end
def get_header(key)
headers[key]
end
def set_header(key, value)
headers[key] = value
end
def delete_header(key)
headers.delete(key)
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/mock.rb 0000644 00000000077 15173517742 0014104 0 ustar 00 # frozen_string_literal: true
require_relative 'mock_request'
share/gems/gems/rack-3.0.8/lib/rack/multipart/generator.rb 0000644 00000004706 15173517742 0017165 0 ustar 00 # frozen_string_literal: true
require_relative 'uploaded_file'
module Rack
module Multipart
class Generator
def initialize(params, first = true)
@params, @first = params, first
if @first && !@params.is_a?(Hash)
raise ArgumentError, "value must be a Hash"
end
end
def dump
return nil if @first && !multipart?
return flattened_params unless @first
flattened_params.map do |name, file|
if file.respond_to?(:original_filename)
if file.path
::File.open(file.path, 'rb') do |f|
f.set_encoding(Encoding::BINARY)
content_for_tempfile(f, file, name)
end
else
content_for_tempfile(file, file, name)
end
else
content_for_other(file, name)
end
end.join << "--#{MULTIPART_BOUNDARY}--\r"
end
private
def multipart?
query = lambda { |value|
case value
when Array
value.any?(&query)
when Hash
value.values.any?(&query)
when Rack::Multipart::UploadedFile
true
end
}
@params.values.any?(&query)
end
def flattened_params
@flattened_params ||= begin
h = Hash.new
@params.each do |key, value|
k = @first ? key.to_s : "[#{key}]"
case value
when Array
value.map { |v|
Multipart.build_multipart(v, false).each { |subkey, subvalue|
h["#{k}[]#{subkey}"] = subvalue
}
}
when Hash
Multipart.build_multipart(value, false).each { |subkey, subvalue|
h[k + subkey] = subvalue
}
else
h[k] = value
end
end
h
end
end
def content_for_tempfile(io, file, name)
length = ::File.stat(file.path).size if file.path
filename = "; filename=\"#{Utils.escape_path(file.original_filename)}\""
<<-EOF
--#{MULTIPART_BOUNDARY}\r
content-disposition: form-data; name="#{name}"#{filename}\r
content-type: #{file.content_type}\r
#{"content-length: #{length}\r\n" if length}\r
#{io.read}\r
EOF
end
def content_for_other(file, name)
<<-EOF
--#{MULTIPART_BOUNDARY}\r
content-disposition: form-data; name="#{name}"\r
\r
#{file}\r
EOF
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/multipart/uploaded_file.rb 0000644 00000002444 15173517742 0017770 0 ustar 00 # frozen_string_literal: true
require 'tempfile'
require 'fileutils'
module Rack
module Multipart
class UploadedFile
# The filename, *not* including the path, of the "uploaded" file
attr_reader :original_filename
# The content type of the "uploaded" file
attr_accessor :content_type
def initialize(filepath = nil, ct = "text/plain", bin = false,
path: filepath, content_type: ct, binary: bin, filename: nil, io: nil)
if io
@tempfile = io
@original_filename = filename
else
raise "#{path} file does not exist" unless ::File.exist?(path)
@original_filename = filename || ::File.basename(path)
@tempfile = Tempfile.new([@original_filename, ::File.extname(path)], encoding: Encoding::BINARY)
@tempfile.binmode if binary
FileUtils.copy_file(path, @tempfile.path)
end
@content_type = content_type
end
def path
@tempfile.path if @tempfile.respond_to?(:path)
end
alias_method :local_path, :path
def respond_to?(*args)
super or @tempfile.respond_to?(*args)
end
def method_missing(method_name, *args, &block) #:nodoc:
@tempfile.__send__(method_name, *args, &block)
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/multipart/parser.rb 0000644 00000032311 15173517742 0016464 0 ustar 00 # frozen_string_literal: true
require 'strscan'
require_relative '../utils'
module Rack
module Multipart
class MultipartPartLimitError < Errno::EMFILE; end
class MultipartTotalPartLimitError < StandardError; end
# Use specific error class when parsing multipart request
# that ends early.
class EmptyContentError < ::EOFError; end
# Base class for multipart exceptions that do not subclass from
# other exception classes for backwards compatibility.
class Error < StandardError; end
EOL = "\r\n"
MULTIPART = %r|\Amultipart/.*boundary=\"?([^\";,]+)\"?|ni
TOKEN = /[^\s()<>,;:\\"\/\[\]?=]+/
CONDISP = /Content-Disposition:\s*#{TOKEN}\s*/i
VALUE = /"(?:\\"|[^"])*"|#{TOKEN}/
BROKEN = /^#{CONDISP}.*;\s*filename=(#{VALUE})/i
MULTIPART_CONTENT_TYPE = /Content-Type: (.*)#{EOL}/ni
MULTIPART_CONTENT_DISPOSITION = /Content-Disposition:[^:]*;\s*name=(#{VALUE})/ni
MULTIPART_CONTENT_ID = /Content-ID:\s*([^#{EOL}]*)/ni
# Updated definitions from RFC 2231
ATTRIBUTE_CHAR = %r{[^ \x00-\x1f\x7f)(><@,;:\\"/\[\]?='*%]}
ATTRIBUTE = /#{ATTRIBUTE_CHAR}+/
SECTION = /\*[0-9]+/
REGULAR_PARAMETER_NAME = /#{ATTRIBUTE}#{SECTION}?/
REGULAR_PARAMETER = /(#{REGULAR_PARAMETER_NAME})=(#{VALUE})/
EXTENDED_OTHER_NAME = /#{ATTRIBUTE}\*[1-9][0-9]*\*/
EXTENDED_OTHER_VALUE = /%[0-9a-fA-F]{2}|#{ATTRIBUTE_CHAR}/
EXTENDED_OTHER_PARAMETER = /(#{EXTENDED_OTHER_NAME})=(#{EXTENDED_OTHER_VALUE}*)/
EXTENDED_INITIAL_NAME = /#{ATTRIBUTE}(?:\*0)?\*/
EXTENDED_INITIAL_VALUE = /[a-zA-Z0-9\-]*'[a-zA-Z0-9\-]*'#{EXTENDED_OTHER_VALUE}*/
EXTENDED_INITIAL_PARAMETER = /(#{EXTENDED_INITIAL_NAME})=(#{EXTENDED_INITIAL_VALUE})/
EXTENDED_PARAMETER = /#{EXTENDED_INITIAL_PARAMETER}|#{EXTENDED_OTHER_PARAMETER}/
DISPPARM = /;\s*(?:#{REGULAR_PARAMETER}|#{EXTENDED_PARAMETER})\s*/
RFC2183 = /^#{CONDISP}(#{DISPPARM})+$/i
class Parser
BUFSIZE = 1_048_576
TEXT_PLAIN = "text/plain"
TEMPFILE_FACTORY = lambda { |filename, content_type|
Tempfile.new(["RackMultipart", ::File.extname(filename.gsub("\0", '%00'))])
}
class BoundedIO # :nodoc:
def initialize(io, content_length)
@io = io
@content_length = content_length
@cursor = 0
end
def read(size, outbuf = nil)
return if @cursor >= @content_length
left = @content_length - @cursor
str = if left < size
@io.read left, outbuf
else
@io.read size, outbuf
end
if str
@cursor += str.bytesize
else
# Raise an error for mismatching content-length and actual contents
raise EOFError, "bad content body"
end
str
end
end
MultipartInfo = Struct.new :params, :tmp_files
EMPTY = MultipartInfo.new(nil, [])
def self.parse_boundary(content_type)
return unless content_type
data = content_type.match(MULTIPART)
return unless data
data[1]
end
def self.parse(io, content_length, content_type, tmpfile, bufsize, qp)
return EMPTY if 0 == content_length
boundary = parse_boundary content_type
return EMPTY unless boundary
if boundary.length > 70
# RFC 1521 Section 7.2.1 imposes a 70 character maximum for the boundary.
# Most clients use no more than 55 characters.
raise Error, "multipart boundary size too large (#{boundary.length} characters)"
end
io = BoundedIO.new(io, content_length) if content_length
parser = new(boundary, tmpfile, bufsize, qp)
parser.parse(io)
parser.result
end
class Collector
class MimePart < Struct.new(:body, :head, :filename, :content_type, :name)
def get_data
data = body
if filename == ""
# filename is blank which means no file has been selected
return
elsif filename
body.rewind if body.respond_to?(:rewind)
# Take the basename of the upload's original filename.
# This handles the full Windows paths given by Internet Explorer
# (and perhaps other broken user agents) without affecting
# those which give the lone filename.
fn = filename.split(/[\/\\]/).last
data = { filename: fn, type: content_type,
name: name, tempfile: body, head: head }
end
yield data
end
end
class BufferPart < MimePart
def file?; false; end
def close; end
end
class TempfilePart < MimePart
def file?; true; end
def close; body.close; end
end
include Enumerable
def initialize(tempfile)
@tempfile = tempfile
@mime_parts = []
@open_files = 0
end
def each
@mime_parts.each { |part| yield part }
end
def on_mime_head(mime_index, head, filename, content_type, name)
if filename
body = @tempfile.call(filename, content_type)
body.binmode if body.respond_to?(:binmode)
klass = TempfilePart
@open_files += 1
else
body = String.new
klass = BufferPart
end
@mime_parts[mime_index] = klass.new(body, head, filename, content_type, name)
check_part_limits
end
def on_mime_body(mime_index, content)
@mime_parts[mime_index].body << content
end
def on_mime_finish(mime_index)
end
private
def check_part_limits
file_limit = Utils.multipart_file_limit
part_limit = Utils.multipart_total_part_limit
if file_limit && file_limit > 0
if @open_files >= file_limit
@mime_parts.each(&:close)
raise MultipartPartLimitError, 'Maximum file multiparts in content reached'
end
end
if part_limit && part_limit > 0
if @mime_parts.size >= part_limit
@mime_parts.each(&:close)
raise MultipartTotalPartLimitError, 'Maximum total multiparts in content reached'
end
end
end
end
attr_reader :state
def initialize(boundary, tempfile, bufsize, query_parser)
@query_parser = query_parser
@params = query_parser.make_params
@bufsize = bufsize
@state = :FAST_FORWARD
@mime_index = 0
@collector = Collector.new tempfile
@sbuf = StringScanner.new("".dup)
@body_regex = /(?:#{EOL}|\A)--#{Regexp.quote(boundary)}(?:#{EOL}|--)/m
@rx_max_size = boundary.bytesize + 6 # (\r\n-- at start, either \r\n or -- at finish)
@head_regex = /(.*?#{EOL})#{EOL}/m
end
def parse(io)
outbuf = String.new
read_data(io, outbuf)
loop do
status =
case @state
when :FAST_FORWARD
handle_fast_forward
when :CONSUME_TOKEN
handle_consume_token
when :MIME_HEAD
handle_mime_head
when :MIME_BODY
handle_mime_body
else # when :DONE
return
end
read_data(io, outbuf) if status == :want_read
end
end
def result
@collector.each do |part|
part.get_data do |data|
tag_multipart_encoding(part.filename, part.content_type, part.name, data)
@query_parser.normalize_params(@params, part.name, data)
end
end
MultipartInfo.new @params.to_params_hash, @collector.find_all(&:file?).map(&:body)
end
private
def dequote(str) # From WEBrick::HTTPUtils
ret = (/\A"(.*)"\Z/ =~ str) ? $1 : str.dup
ret.gsub!(/\\(.)/, "\\1")
ret
end
def read_data(io, outbuf)
content = io.read(@bufsize, outbuf)
handle_empty_content!(content)
@sbuf.concat(content)
end
# This handles the initial parser state. We read until we find the starting
# boundary, then we can transition to the next state. If we find the ending
# boundary, this is an invalid multipart upload, but keep scanning for opening
# boundary in that case. If no boundary found, we need to keep reading data
# and retry. It's highly unlikely the initial read will not consume the
# boundary. The client would have to deliberately craft a response
# with the opening boundary beyond the buffer size for that to happen.
def handle_fast_forward
while true
case consume_boundary
when :BOUNDARY
# found opening boundary, transition to next state
@state = :MIME_HEAD
return
when :END_BOUNDARY
# invalid multipart upload, but retry for opening boundary
else
# no boundary found, keep reading data
return :want_read
end
end
end
def handle_consume_token
tok = consume_boundary
# break if we're at the end of a buffer, but not if it is the end of a field
@state = if tok == :END_BOUNDARY || (@sbuf.eos? && tok != :BOUNDARY)
:DONE
else
:MIME_HEAD
end
end
def handle_mime_head
if @sbuf.scan_until(@head_regex)
head = @sbuf[1]
content_type = head[MULTIPART_CONTENT_TYPE, 1]
if name = head[MULTIPART_CONTENT_DISPOSITION, 1]
name = dequote(name)
else
name = head[MULTIPART_CONTENT_ID, 1]
end
filename = get_filename(head)
if name.nil? || name.empty?
name = filename || "#{content_type || TEXT_PLAIN}[]".dup
end
@collector.on_mime_head @mime_index, head, filename, content_type, name
@state = :MIME_BODY
else
:want_read
end
end
def handle_mime_body
if (body_with_boundary = @sbuf.check_until(@body_regex)) # check but do not advance the pointer yet
body = body_with_boundary.sub(/#{@body_regex}\z/m, '') # remove the boundary from the string
@collector.on_mime_body @mime_index, body
@sbuf.pos += body.length + 2 # skip \r\n after the content
@state = :CONSUME_TOKEN
@mime_index += 1
else
# Save what we have so far
if @rx_max_size < @sbuf.rest_size
delta = @sbuf.rest_size - @rx_max_size
@collector.on_mime_body @mime_index, @sbuf.peek(delta)
@sbuf.pos += delta
@sbuf.string = @sbuf.rest
end
:want_read
end
end
# Scan until the we find the start or end of the boundary.
# If we find it, return the appropriate symbol for the start or
# end of the boundary. If we don't find the start or end of the
# boundary, clear the buffer and return nil.
def consume_boundary
if read_buffer = @sbuf.scan_until(@body_regex)
read_buffer.end_with?(EOL) ? :BOUNDARY : :END_BOUNDARY
else
@sbuf.terminate
nil
end
end
def get_filename(head)
filename = nil
case head
when RFC2183
params = Hash[*head.scan(DISPPARM).flat_map(&:compact)]
if filename = params['filename*']
encoding, _, filename = filename.split("'", 3)
elsif filename = params['filename']
filename = $1 if filename =~ /^"(.*)"$/
end
when BROKEN
filename = $1
filename = $1 if filename =~ /^"(.*)"$/
end
return unless filename
if filename.scan(/%.?.?/).all? { |s| /%[0-9a-fA-F]{2}/.match?(s) }
filename = Utils.unescape_path(filename)
end
filename.scrub!
if filename !~ /\\[^\\"]/
filename = filename.gsub(/\\(.)/, '\1')
end
if encoding
filename.force_encoding ::Encoding.find(encoding)
end
filename
end
CHARSET = "charset"
deprecate_constant :CHARSET
def tag_multipart_encoding(filename, content_type, name, body)
name = name.to_s
encoding = Encoding::UTF_8
name.force_encoding(encoding)
return if filename
if content_type
list = content_type.split(';')
type_subtype = list.first
type_subtype.strip!
if TEXT_PLAIN == type_subtype
rest = list.drop 1
rest.each do |param|
k, v = param.split('=', 2)
k.strip!
v.strip!
v = v[1..-2] if v.start_with?('"') && v.end_with?('"')
if k == "charset"
encoding = begin
Encoding.find v
rescue ArgumentError
Encoding::BINARY
end
end
end
end
end
name.force_encoding(encoding)
body.force_encoding(encoding)
end
def handle_empty_content!(content)
if content.nil? || content.empty?
raise EmptyContentError
end
end
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/headers.rb 0000644 00000005724 15173517742 0014572 0 ustar 00 module Rack
# Rack::Headers is a Hash subclass that downcases all keys. It's designed
# to be used by rack applications that don't implement the Rack 3 SPEC
# (by using non-lowercase response header keys), automatically handling
# the downcasing of keys.
class Headers < Hash
def self.[](*items)
if items.length % 2 != 0
if items.length == 1 && items.first.is_a?(Hash)
new.merge!(items.first)
else
raise ArgumentError, "odd number of arguments for Rack::Headers"
end
else
hash = new
loop do
break if items.length == 0
key = items.shift
value = items.shift
hash[key] = value
end
hash
end
end
def [](key)
super(downcase_key(key))
end
def []=(key, value)
super(key.downcase.freeze, value)
end
alias store []=
def assoc(key)
super(downcase_key(key))
end
def compare_by_identity
raise TypeError, "Rack::Headers cannot compare by identity, use regular Hash"
end
def delete(key)
super(downcase_key(key))
end
def dig(key, *a)
super(downcase_key(key), *a)
end
def fetch(key, *default, &block)
key = downcase_key(key)
super
end
def fetch_values(*a)
super(*a.map!{|key| downcase_key(key)})
end
def has_key?(key)
super(downcase_key(key))
end
alias include? has_key?
alias key? has_key?
alias member? has_key?
def invert
hash = self.class.new
each{|key, value| hash[value] = key}
hash
end
def merge(hash, &block)
dup.merge!(hash, &block)
end
def reject(&block)
hash = dup
hash.reject!(&block)
hash
end
def replace(hash)
clear
update(hash)
end
def select(&block)
hash = dup
hash.select!(&block)
hash
end
def to_proc
lambda{|x| self[x]}
end
def transform_values(&block)
dup.transform_values!(&block)
end
def update(hash, &block)
hash.each do |key, value|
self[key] = if block_given? && include?(key)
block.call(key, self[key], value)
else
value
end
end
self
end
alias merge! update
def values_at(*keys)
keys.map{|key| self[key]}
end
# :nocov:
if RUBY_VERSION >= '2.5'
# :nocov:
def slice(*a)
h = self.class.new
a.each{|k| h[k] = self[k] if has_key?(k)}
h
end
def transform_keys(&block)
dup.transform_keys!(&block)
end
def transform_keys!
hash = self.class.new
each do |k, v|
hash[yield k] = v
end
replace(hash)
end
end
# :nocov:
if RUBY_VERSION >= '3.0'
# :nocov:
def except(*a)
super(*a.map!{|key| downcase_key(key)})
end
end
private
def downcase_key(key)
key.is_a?(String) ? key.downcase : key
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/query_parser.rb 0000644 00000020573 15173517742 0015677 0 ustar 00 # frozen_string_literal: true
require 'uri'
module Rack
class QueryParser
DEFAULT_SEP = /[&] */n
COMMON_SEP = { ";" => /[;] */n, ";," => /[;,] */n, "&" => /[&] */n }
# ParameterTypeError is the error that is raised when incoming structural
# parameters (parsed by parse_nested_query) contain conflicting types.
class ParameterTypeError < TypeError; end
# InvalidParameterError is the error that is raised when incoming structural
# parameters (parsed by parse_nested_query) contain invalid format or byte
# sequence.
class InvalidParameterError < ArgumentError; end
# ParamsTooDeepError is the error that is raised when params are recursively
# nested over the specified limit.
class ParamsTooDeepError < RangeError; end
def self.make_default(_key_space_limit=(not_deprecated = true; nil), param_depth_limit)
unless not_deprecated
warn("`first argument `key_space limit` is deprecated and no longer has an effect. Please call with only one argument, which will be required in a future version of Rack", uplevel: 1)
end
new Params, param_depth_limit
end
attr_reader :param_depth_limit
def initialize(params_class, _key_space_limit=(not_deprecated = true; nil), param_depth_limit)
unless not_deprecated
warn("`second argument `key_space limit` is deprecated and no longer has an effect. Please call with only two arguments, which will be required in a future version of Rack", uplevel: 1)
end
@params_class = params_class
@param_depth_limit = param_depth_limit
end
# Stolen from Mongrel, with some small modifications:
# Parses a query string by breaking it up at the '&'. You can also use this
# to parse cookies by changing the characters used in the second parameter
# (which defaults to '&').
def parse_query(qs, separator = nil, &unescaper)
unescaper ||= method(:unescape)
params = make_params
(qs || '').split(separator ? (COMMON_SEP[separator] || /[#{separator}] */n) : DEFAULT_SEP).each do |p|
next if p.empty?
k, v = p.split('=', 2).map!(&unescaper)
if cur = params[k]
if cur.class == Array
params[k] << v
else
params[k] = [cur, v]
end
else
params[k] = v
end
end
return params.to_h
end
# parse_nested_query expands a query string into structural types. Supported
# types are Arrays, Hashes and basic value types. It is possible to supply
# query strings with parameters of conflicting types, in this case a
# ParameterTypeError is raised. Users are encouraged to return a 400 in this
# case.
def parse_nested_query(qs, separator = nil)
params = make_params
unless qs.nil? || qs.empty?
(qs || '').split(separator ? (COMMON_SEP[separator] || /[#{separator}] */n) : DEFAULT_SEP).each do |p|
k, v = p.split('=', 2).map! { |s| unescape(s) }
_normalize_params(params, k, v, 0)
end
end
return params.to_h
rescue ArgumentError => e
raise InvalidParameterError, e.message, e.backtrace
end
# normalize_params recursively expands parameters into structural types. If
# the structural types represented by two different parameter names are in
# conflict, a ParameterTypeError is raised. The depth argument is deprecated
# and should no longer be used, it is kept for backwards compatibility with
# earlier versions of rack.
def normalize_params(params, name, v, _depth=nil)
_normalize_params(params, name, v, 0)
end
private def _normalize_params(params, name, v, depth)
raise ParamsTooDeepError if depth >= param_depth_limit
if !name
# nil name, treat same as empty string (required by tests)
k = after = ''
elsif depth == 0
# Start of parsing, don't treat [] or [ at start of string specially
if start = name.index('[', 1)
# Start of parameter nesting, use part before brackets as key
k = name[0, start]
after = name[start, name.length]
else
# Plain parameter with no nesting
k = name
after = ''
end
elsif name.start_with?('[]')
# Array nesting
k = '[]'
after = name[2, name.length]
elsif name.start_with?('[') && (start = name.index(']', 1))
# Hash nesting, use the part inside brackets as the key
k = name[1, start-1]
after = name[start+1, name.length]
else
# Probably malformed input, nested but not starting with [
# treat full name as key for backwards compatibility.
k = name
after = ''
end
return if k.empty?
if after == ''
if k == '[]' && depth != 0
return [v]
else
params[k] = v
end
elsif after == "["
params[name] = v
elsif after == "[]"
params[k] ||= []
raise ParameterTypeError, "expected Array (got #{params[k].class.name}) for param `#{k}'" unless params[k].is_a?(Array)
params[k] << v
elsif after.start_with?('[]')
# Recognize x[][y] (hash inside array) parameters
unless after[2] == '[' && after.end_with?(']') && (child_key = after[3, after.length-4]) && !child_key.empty? && !child_key.index('[') && !child_key.index(']')
# Handle other nested array parameters
child_key = after[2, after.length]
end
params[k] ||= []
raise ParameterTypeError, "expected Array (got #{params[k].class.name}) for param `#{k}'" unless params[k].is_a?(Array)
if params_hash_type?(params[k].last) && !params_hash_has_key?(params[k].last, child_key)
_normalize_params(params[k].last, child_key, v, depth + 1)
else
params[k] << _normalize_params(make_params, child_key, v, depth + 1)
end
else
params[k] ||= make_params
raise ParameterTypeError, "expected Hash (got #{params[k].class.name}) for param `#{k}'" unless params_hash_type?(params[k])
params[k] = _normalize_params(params[k], after, v, depth + 1)
end
params
end
def make_params
@params_class.new
end
def new_depth_limit(param_depth_limit)
self.class.new @params_class, param_depth_limit
end
private
def params_hash_type?(obj)
obj.kind_of?(@params_class)
end
def params_hash_has_key?(hash, key)
return false if /\[\]/.match?(key)
key.split(/[\[\]]+/).inject(hash) do |h, part|
next h if part == ''
return false unless params_hash_type?(h) && h.key?(part)
h[part]
end
true
end
def unescape(string, encoding = Encoding::UTF_8)
URI.decode_www_form_component(string, encoding)
end
class Params
def initialize
@size = 0
@params = {}
end
def [](key)
@params[key]
end
def []=(key, value)
@params[key] = value
end
def key?(key)
@params.key?(key)
end
# Recursively unwraps nested `Params` objects and constructs an object
# of the same shape, but using the objects' internal representations
# (Ruby hashes) in place of the objects. The result is a hash consisting
# purely of Ruby primitives.
#
# Mutation warning!
#
# 1. This method mutates the internal representation of the `Params`
# objects in order to save object allocations.
#
# 2. The value you get back is a reference to the internal hash
# representation, not a copy.
#
# 3. Because the `Params` object's internal representation is mutable
# through the `#[]=` method, it is not thread safe. The result of
# getting the hash representation while another thread is adding a
# key to it is non-deterministic.
#
def to_h
@params.each do |key, value|
case value
when self
# Handle circular references gracefully.
@params[key] = @params
when Params
@params[key] = value.to_h
when Array
value.map! { |v| v.kind_of?(Params) ? v.to_h : v }
else
# Ignore anything that is not a `Params` object or
# a collection that can contain one.
end
end
@params
end
alias_method :to_params_hash, :to_h
end
end
end
share/gems/gems/rack-3.0.8/lib/rack/lint.rb 0000755 00000110133 15173517743 0014120 0 ustar 00 # frozen_string_literal: true
require 'forwardable'
require_relative 'constants'
require_relative 'utils'
module Rack
# Rack::Lint validates your application and the requests and
# responses according to the Rack spec.
class Lint
def initialize(app)
@app = app
end
# :stopdoc:
class LintError < RuntimeError; end
# AUTHORS: n.b. The trailing whitespace between paragraphs is important and
# should not be removed. The whitespace creates paragraphs in the RDoc
# output.
#
## This specification aims to formalize the Rack protocol. You
## can (and should) use Rack::Lint to enforce it.
##
## When you develop middleware, be sure to add a Lint before and
## after to catch all mistakes.
##
## = Rack applications
##
## A Rack application is a Ruby object (not a class) that
## responds to +call+.
def call(env = nil)
Wrapper.new(@app, env).response
end
class Wrapper
def initialize(app, env)
@app = app
@env = env
@response = nil
@head_request = false
@status = nil
@headers = nil
@body = nil
@invoked = nil
@content_length = nil
@closed = false
@size = 0
end
def response
## It takes exactly one argument, the *environment*
raise LintError, "No env given" unless @env
check_environment(@env)
@env[RACK_INPUT] = InputWrapper.new(@env[RACK_INPUT])
@env[RACK_ERRORS] = ErrorWrapper.new(@env[RACK_ERRORS])
## and returns a non-frozen Array of exactly three values:
@response = @app.call(@env)
raise LintError, "response is not an Array, but #{@response.class}" unless @response.kind_of? Array
raise LintError, "response is frozen" if @response.frozen?
raise LintError, "response array has #{@response.size} elements instead of 3" unless @response.size == 3
@status, @headers, @body = @response
## The *status*,
check_status(@status)
## the *headers*,
check_headers(@headers)
hijack_proc = check_hijack_response(@headers, @env)
if hijack_proc
@headers[RACK_HIJACK] = hijack_proc
end
## and the *body*.
check_content_type(@status, @headers)
check_content_length(@status, @headers)
@head_request = @env[REQUEST_METHOD] == HEAD
@lint = (@env['rack.lint'] ||= []) << self
if (@env['rack.lint.body_iteration'] ||= 0) > 0
raise LintError, "Middleware must not call #each directly"
end
return [@status, @headers, self]
end
##
## == The Environment
##
def check_environment(env)
## The environment must be an unfrozen instance of Hash that includes
## CGI-like headers. The Rack application is free to modify the
## environment.
raise LintError, "env #{env.inspect} is not a Hash, but #{env.class}" unless env.kind_of? Hash
raise LintError, "env should not be frozen, but is" if env.frozen?
##
## The environment is required to include these variables
## (adopted from {PEP 333}[https://peps.python.org/pep-0333/]), except when they'd be empty, but see
## below.
## <tt>REQUEST_METHOD</tt>:: The HTTP request method, such as
## "GET" or "POST". This cannot ever
## be an empty string, and so is
## always required.
## <tt>SCRIPT_NAME</tt>:: The initial portion of the request
## URL's "path" that corresponds to the
## application object, so that the
## application knows its virtual
## "location". This may be an empty
## string, if the application corresponds
## to the "root" of the server.
## <tt>PATH_INFO</tt>:: The remainder of the request URL's
## "path", designating the virtual
## "location" of the request's target
## within the application. This may be an
## empty string, if the request URL targets
## the application root and does not have a
## trailing slash. This value may be
## percent-encoded when originating from
## a URL.
## <tt>QUERY_STRING</tt>:: The portion of the request URL that
## follows the <tt>?</tt>, if any. May be
## empty, but is always required!
## <tt>SERVER_NAME</tt>:: When combined with <tt>SCRIPT_NAME</tt> and
## <tt>PATH_INFO</tt>, these variables can be
## used to complete the URL. Note, however,
## that <tt>HTTP_HOST</tt>, if present,
## should be used in preference to
## <tt>SERVER_NAME</tt> for reconstructing
## the request URL.
## <tt>SERVER_NAME</tt> can never be an empty
## string, and so is always required.
## <tt>SERVER_PORT</tt>:: An optional +Integer+ which is the port the
## server is running on. Should be specified if
## the server is running on a non-standard port.
## <tt>SERVER_PROTOCOL</tt>:: A string representing the HTTP version used
## for the request.
## <tt>HTTP_</tt> Variables:: Variables corresponding to the
## client-supplied HTTP request
## headers (i.e., variables whose
## names begin with <tt>HTTP_</tt>). The
## presence or absence of these
## variables should correspond with
## the presence or absence of the
## appropriate HTTP header in the
## request. See
## {RFC3875 section 4.1.18}[https://tools.ietf.org/html/rfc3875#section-4.1.18]
## for specific behavior.
## In addition to this, the Rack environment must include these
## Rack-specific variables:
## <tt>rack.url_scheme</tt>:: +http+ or +https+, depending on the
## request URL.
## <tt>rack.input</tt>:: See below, the input stream.
## <tt>rack.errors</tt>:: See below, the error stream.
## <tt>rack.hijack?</tt>:: See below, if present and true, indicates
## that the server supports partial hijacking.
## <tt>rack.hijack</tt>:: See below, if present, an object responding
## to +call+ that is used to perform a full
## hijack.
## Additional environment specifications have approved to
## standardized middleware APIs. None of these are required to
## be implemented by the server.
## <tt>rack.session</tt>:: A hash-like interface for storing
## request session data.
## The store must implement:
if session = env[RACK_SESSION]
## store(key, value) (aliased as []=);
unless session.respond_to?(:store) && session.respond_to?(:[]=)
raise LintError, "session #{session.inspect} must respond to store and []="
end
## fetch(key, default = nil) (aliased as []);
unless session.respond_to?(:fetch) && session.respond_to?(:[])
raise LintError, "session #{session.inspect} must respond to fetch and []"
end
## delete(key);
unless session.respond_to?(:delete)
raise LintError, "session #{session.inspect} must respond to delete"
end
## clear;
unless session.respond_to?(:clear)
raise LintError, "session #{session.inspect} must respond to clear"
end
## to_hash (returning unfrozen Hash instance);
unless session.respond_to?(:to_hash) && session.to_hash.kind_of?(Hash) && !session.to_hash.frozen?
raise LintError, "session #{session.inspect} must respond to to_hash and return unfrozen Hash instance"
end
end
## <tt>rack.logger</tt>:: A common object interface for logging messages.
## The object must implement:
if logger = env[RACK_LOGGER]
## info(message, &block)
unless logger.respond_to?(:info)
raise LintError, "logger #{logger.inspect} must respond to info"
end
## debug(message, &block)
unless logger.respond_to?(:debug)
raise LintError, "logger #{logger.inspect} must respond to debug"
end
## warn(message, &block)
unless logger.respond_to?(:warn)
raise LintError, "logger #{logger.inspect} must respond to warn"
end
## error(message, &block)
unless logger.respond_to?(:error)
raise LintError, "logger #{logger.inspect} must respond to error"
end
## fatal(message, &block)
unless logger.respond_to?(:fatal)
raise LintError, "logger #{logger.inspect} must respond to fatal"
end
end
## <tt>rack.multipart.buffer_size</tt>:: An Integer hint to the multipart parser as to what chunk size to use for reads and writes.
if bufsize = env[RACK_MULTIPART_BUFFER_SIZE]
unless bufsize.is_a?(Integer) && bufsize > 0
raise LintError, "rack.multipart.buffer_size must be an Integer > 0 if specified"
end
end
## <tt>rack.multipart.tempfile_factory</tt>:: An object responding to #call with two arguments, the filename and content_type given for the multipart form field, and returning an IO-like object that responds to #<< and optionally #rewind. This factory will be used to instantiate the tempfile for each multipart form file upload field, rather than the default class of Tempfile.
if tempfile_factory = env[RACK_MULTIPART_TEMPFILE_FACTORY]
raise LintError, "rack.multipart.tempfile_factory must respond to #call" unless tempfile_factory.respond_to?(:call)
env[RACK_MULTIPART_TEMPFILE_FACTORY] = lambda do |filename, content_type|
io = tempfile_factory.call(filename, content_type)
raise LintError, "rack.multipart.tempfile_factory return value must respond to #<<" unless io.respond_to?(:<<)
io
end
end
## The server or the application can store their own data in the
## environment, too. The keys must contain at least one dot,
## and should be prefixed uniquely. The prefix <tt>rack.</tt>
## is reserved for use with the Rack core distribution and other
## accepted specifications and must not be used otherwise.
##
%w[REQUEST_METHOD SERVER_NAME QUERY_STRING SERVER_PROTOCOL
rack.input rack.errors].each { |header|
raise LintError, "env missing required key #{header}" unless env.include? header
}
## The <tt>SERVER_PORT</tt> must be an Integer if set.
server_port = env["SERVER_PORT"]
unless server_port.nil? || (Integer(server_port) rescue false)
raise LintError, "env[SERVER_PORT] is not an Integer"
end
## The <tt>SERVER_NAME</tt> must be a valid authority as defined by RFC7540.
unless (URI.parse("http://#{env[SERVER_NAME]}/") rescue false)
raise LintError, "#{env[SERVER_NAME]} must be a valid authority"
end
## The <tt>HTTP_HOST</tt> must be a valid authority as defined by RFC7540.
unless (URI.parse("http://#{env[HTTP_HOST]}/") rescue false)
raise LintError, "#{env[HTTP_HOST]} must be a valid authority"
end
## The <tt>SERVER_PROTOCOL</tt> must match the regexp <tt>HTTP/\d(\.\d)?</tt>.
server_protocol = env['SERVER_PROTOCOL']
unless %r{HTTP/\d(\.\d)?}.match?(server_protocol)
raise LintError, "env[SERVER_PROTOCOL] does not match HTTP/\\d(\\.\\d)?"
end
## If the <tt>HTTP_VERSION</tt> is present, it must equal the <tt>SERVER_PROTOCOL</tt>.
if env['HTTP_VERSION'] && env['HTTP_VERSION'] != server_protocol
raise LintError, "env[HTTP_VERSION] does not equal env[SERVER_PROTOCOL]"
end
## The environment must not contain the keys
## <tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>
## (use the versions without <tt>HTTP_</tt>).
%w[HTTP_CONTENT_TYPE HTTP_CONTENT_LENGTH].each { |header|
if env.include? header
raise LintError, "env contains #{header}, must use #{header[5..-1]}"
end
}
## The CGI keys (named without a period) must have String values.
## If the string values for CGI keys contain non-ASCII characters,
## they should use ASCII-8BIT encoding.
env.each { |key, value|
next if key.include? "." # Skip extensions
unless value.kind_of? String
raise LintError, "env variable #{key} has non-string value #{value.inspect}"
end
next if value.encoding == Encoding::ASCII_8BIT
unless value.b !~ /[\x80-\xff]/n
raise LintError, "env variable #{key} has value containing non-ASCII characters and has non-ASCII-8BIT encoding #{value.inspect} encoding: #{value.encoding}"
end
}
## There are the following restrictions:
## * <tt>rack.url_scheme</tt> must either be +http+ or +https+.
unless %w[http https].include?(env[RACK_URL_SCHEME])
raise LintError, "rack.url_scheme unknown: #{env[RACK_URL_SCHEME].inspect}"
end
## * There must be a valid input stream in <tt>rack.input</tt>.
check_input env[RACK_INPUT]
## * There must be a valid error stream in <tt>rack.errors</tt>.
check_error env[RACK_ERRORS]
## * There may be a valid hijack callback in <tt>rack.hijack</tt>
check_hijack env
## * The <tt>REQUEST_METHOD</tt> must be a valid token.
unless env[REQUEST_METHOD] =~ /\A[0-9A-Za-z!\#$%&'*+.^_`|~-]+\z/
raise LintError, "REQUEST_METHOD unknown: #{env[REQUEST_METHOD].dump}"
end
## * The <tt>SCRIPT_NAME</tt>, if non-empty, must start with <tt>/</tt>
if env.include?(SCRIPT_NAME) && env[SCRIPT_NAME] != "" && env[SCRIPT_NAME] !~ /\A\//
raise LintError, "SCRIPT_NAME must start with /"
end
## * The <tt>PATH_INFO</tt>, if non-empty, must start with <tt>/</tt>
if env.include?(PATH_INFO) && env[PATH_INFO] != "" && env[PATH_INFO] !~ /\A\//
raise LintError, "PATH_INFO must start with /"
end
## * The <tt>CONTENT_LENGTH</tt>, if given, must consist of digits only.
if env.include?("CONTENT_LENGTH") && env["CONTENT_LENGTH"] !~ /\A\d+\z/
raise LintError, "Invalid CONTENT_LENGTH: #{env["CONTENT_LENGTH"]}"
end
## * One of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be
## set. <tt>PATH_INFO</tt> should be <tt>/</tt> if
## <tt>SCRIPT_NAME</tt> is empty.
unless env[SCRIPT_NAME] || env[PATH_INFO]
raise LintError, "One of SCRIPT_NAME or PATH_INFO must be set (make PATH_INFO '/' if SCRIPT_NAME is empty)"
end
## <tt>SCRIPT_NAME</tt> never should be <tt>/</tt>, but instead be empty.
unless env[SCRIPT_NAME] != "/"
raise LintError, "SCRIPT_NAME cannot be '/', make it '' and PATH_INFO '/'"
end
## <tt>rack.response_finished</tt>:: An array of callables run by the server after the response has been
## processed. This would typically be invoked after sending the response to the client, but it could also be
## invoked if an error occurs while generating the response or sending the response; in that case, the error
## argument will be a subclass of +Exception+.
## The callables are invoked with +env, status, headers, error+ arguments and should not raise any
## exceptions. They should be invoked in reverse order of registration.
if callables = env[RACK_RESPONSE_FINISHED]
raise LintError, "rack.response_finished must be an array of callable objects" unless callables.is_a?(Array)
callables.each do |callable|
raise LintError, "rack.response_finished values must respond to call(env, status, headers, error)" unless callable.respond_to?(:call)
end
end
end
##
## === The Input Stream
##
## The input stream is an IO-like object which contains the raw HTTP
## POST data.
def check_input(input)
## When applicable, its external encoding must be "ASCII-8BIT" and it
## must be opened in binary mode, for Ruby 1.9 compatibility.
if input.respond_to?(:external_encoding) && input.external_encoding != Encoding::ASCII_8BIT
raise LintError, "rack.input #{input} does not have ASCII-8BIT as its external encoding"
end
if input.respond_to?(:binmode?) && !input.binmode?
raise LintError, "rack.input #{input} is not opened in binary mode"
end
## The input stream must respond to +gets+, +each+, and +read+.
[:gets, :each, :read].each { |method|
unless input.respond_to? method
raise LintError, "rack.input #{input} does not respond to ##{method}"
end
}
end
class InputWrapper
def initialize(input)
@input = input
end
## * +gets+ must be called without arguments and return a string,
## or +nil+ on EOF.
def gets(*args)
raise LintError, "rack.input#gets called with arguments" unless args.size == 0
v = @input.gets
unless v.nil? or v.kind_of? String
raise LintError, "rack.input#gets didn't return a String"
end
v
end
## * +read+ behaves like IO#read.
## Its signature is <tt>read([length, [buffer]])</tt>.
##
## If given, +length+ must be a non-negative Integer (>= 0) or +nil+,
## and +buffer+ must be a String and may not be nil.
##
## If +length+ is given and not nil, then this method reads at most
## +length+ bytes from the input stream.
##
## If +length+ is not given or nil, then this method reads
## all data until EOF.
##
## When EOF is reached, this method returns nil if +length+ is given
## and not nil, or "" if +length+ is not given or is nil.
##
## If +buffer+ is given, then the read data will be placed
## into +buffer+ instead of a newly created String object.
def read(*args)
unless args.size <= 2
raise LintError, "rack.input#read called with too many arguments"
end
if args.size >= 1
unless args.first.kind_of?(Integer) || args.first.nil?
raise LintError, "rack.input#read called with non-integer and non-nil length"
end
unless args.first.nil? || args.first >= 0
raise LintError, "rack.input#read called with a negative length"
end
end
if args.size >= 2
unless args[1].kind_of?(String)
raise LintError, "rack.input#read called with non-String buffer"
end
end
v = @input.read(*args)
unless v.nil? or v.kind_of? String
raise LintError, "rack.input#read didn't return nil or a String"
end
if args[0].nil?
unless !v.nil?
raise LintError, "rack.input#read(nil) returned nil on EOF"
end
end
v
end
## * +each+ must be called without arguments and only yield Strings.
def each(*args)
raise LintError, "rack.input#each called with arguments" unless args.size == 0
@input.each { |line|
unless line.kind_of? String
raise LintError, "rack.input#each didn't yield a String"
end
yield line
}
end
## * +close+ can be called on the input stream to indicate that the
## any remaining input is not needed.
def close(*args)
@input.close(*args)
end
end
##
## === The Error Stream
##
def check_error(error)
## The error stream must respond to +puts+, +write+ and +flush+.
[:puts, :write, :flush].each { |method|
unless error.respond_to? method
raise LintError, "rack.error #{error} does not respond to ##{method}"
end
}
end
class ErrorWrapper
def initialize(error)
@error = error
end
## * +puts+ must be called with a single argument that responds to +to_s+.
def puts(str)
@error.puts str
end
## * +write+ must be called with a single argument that is a String.
def write(str)
raise LintError, "rack.errors#write not called with a String" unless str.kind_of? String
@error.write str
end
## * +flush+ must be called without arguments and must be called
## in order to make the error appear for sure.
def flush
@error.flush
end
## * +close+ must never be called on the error stream.
def close(*args)
raise LintError, "rack.errors#close must not be called"
end
end
##
## === Hijacking
##
## The hijacking interfaces provides a means for an application to take
## control of the HTTP connection. There are two distinct hijack
## interfaces: full hijacking where the application takes over the raw
## connection, and partial hijacking where the application takes over
## just the response body stream. In both cases, the application is
## responsible for closing the hijacked stream.
##
## Full hijacking only works with HTTP/1. Partial hijacking is functionally
## equivalent to streaming bodies, and is still optionally supported for
## backwards compatibility with older Rack versions.
##
## ==== Full Hijack
##
## Full hijack is used to completely take over an HTTP/1 connection. It
## occurs before any headers are written and causes the request to
## ignores any response generated by the application.
##
## It is intended to be used when applications need access to raw HTTP/1
## connection.
##
def check_hijack(env)
## If +rack.hijack+ is present in +env+, it must respond to +call+
if original_hijack = env[RACK_HIJACK]
raise LintError, "rack.hijack must respond to call" unless original_hijack.respond_to?(:call)
env[RACK_HIJACK] = proc do
io = original_hijack.call
## and return an +IO+ instance which can be used to read and write
## to the underlying connection using HTTP/1 semantics and
## formatting.
raise LintError, "rack.hijack must return an IO instance" unless io.is_a?(IO)
io
end
end
end
##
## ==== Partial Hijack
##
## Partial hijack is used for bi-directional streaming of the request and
## response body. It occurs after the status and headers are written by
## the server and causes the server to ignore the Body of the response.
##
## It is intended to be used when applications need bi-directional
## streaming.
##
def check_hijack_response(headers, env)
## If +rack.hijack?+ is present in +env+ and truthy,
if env[RACK_IS_HIJACK]
## an application may set the special response header +rack.hijack+
if original_hijack = headers[RACK_HIJACK]
## to an object that responds to +call+,
unless original_hijack.respond_to?(:call)
raise LintError, 'rack.hijack header must respond to #call'
end
## accepting a +stream+ argument.
return proc do |io|
original_hijack.call StreamWrapper.new(io)
end
end
##
## After the response status and headers have been sent, this hijack
## callback will be invoked with a +stream+ argument which follows the
## same interface as outlined in "Streaming Body". Servers must
## ignore the +body+ part of the response tuple when the
## +rack.hijack+ response header is present. Using an empty +Array+
## instance is recommended.
else
##
## The special response header +rack.hijack+ must only be set
## if the request +env+ has a truthy +rack.hijack?+.
if headers.key?(RACK_HIJACK)
raise LintError, 'rack.hijack header must not be present if server does not support hijacking'
end
end
nil
end
## == The Response
##
## === The Status
##
def check_status(status)
## This is an HTTP status. It must be an Integer greater than or equal to
## 100.
unless status.is_a?(Integer) && status >= 100
raise LintError, "Status must be an Integer >=100"
end
end
##
## === The Headers
##
def check_headers(headers)
## The headers must be a unfrozen Hash.
unless headers.kind_of?(Hash)
raise LintError, "headers object should be a hash, but isn't (got #{headers.class} as headers)"
end
if headers.frozen?
raise LintError, "headers object should not be frozen, but is"
end
headers.each do |key, value|
## The header keys must be Strings.
unless key.kind_of? String
raise LintError, "header key must be a string, was #{key.class}"
end
## Special headers starting "rack." are for communicating with the
## server, and must not be sent back to the client.
next if key.start_with?("rack.")
## The header must not contain a +Status+ key.
raise LintError, "header must not contain status" if key == "status"
## Header keys must conform to RFC7230 token specification, i.e. cannot
## contain non-printable ASCII, DQUOTE or "(),/:;<=>?@[\]{}".
raise LintError, "invalid header name: #{key}" if key =~ /[\(\),\/:;<=>\?@\[\\\]{}[:cntrl:]]/
## Header keys must not contain uppercase ASCII characters (A-Z).
raise LintError, "uppercase character in header name: #{key}" if key =~ /[A-Z]/
## Header values must be either a String instance,
if value.kind_of?(String)
check_header_value(key, value)
elsif value.kind_of?(Array)
## or an Array of String instances,
value.each{|value| check_header_value(key, value)}
else
raise LintError, "a header value must be a String or Array of Strings, but the value of '#{key}' is a #{value.class}"
end
end
end
def check_header_value(key, value)
## such that each String instance must not contain characters below 037.
if value =~ /[\000-\037]/
raise LintError, "invalid header value #{key}: #{value.inspect}"
end
end
##
## === The content-type
##
def check_content_type(status, headers)
headers.each { |key, value|
## There must not be a <tt>content-type</tt> header key when the +Status+ is 1xx,
## 204, or 304.
if key == "content-type"
if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
raise LintError, "content-type header found in #{status} response, not allowed"
end
return
end
}
end
##
## === The content-length
##
def check_content_length(status, headers)
headers.each { |key, value|
if key == 'content-length'
## There must not be a <tt>content-length</tt> header key when the
## +Status+ is 1xx, 204, or 304.
if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
raise LintError, "content-length header found in #{status} response, not allowed"
end
@content_length = value
end
}
end
def verify_content_length(size)
if @head_request
unless size == 0
raise LintError, "Response body was given for HEAD request, but should be empty"
end
elsif @content_length
unless @content_length == size.to_s
raise LintError, "content-length header was #{@content_length}, but should be #{size}"
end
end
end
##
## === The Body
##
## The Body is typically an +Array+ of +String+ instances, an enumerable
## that yields +String+ instances, a +Proc+ instance, or a File-like
## object.
##
## The Body must respond to +each+ or +call+. It may optionally respond
## to +to_path+ or +to_ary+. A Body that responds to +each+ is considered
## to be an Enumerable Body. A Body that responds to +call+ is considered
## to be a Streaming Body.
##
## A Body that responds to both +each+ and +call+ must be treated as an
## Enumerable Body, not a Streaming Body. If it responds to +each+, you
## must call +each+ and not +call+. If the Body doesn't respond to
## +each+, then you can assume it responds to +call+.
##
## The Body must either be consumed or returned. The Body is consumed by
## optionally calling either +each+ or +call+.
## Then, if the Body responds to +close+, it must be called to release
## any resources associated with the generation of the body.
## In other words, +close+ must always be called at least once; typically
## after the web server has sent the response to the client, but also in
## cases where the Rack application makes internal/virtual requests and
## discards the response.
##
def close
##
## After calling +close+, the Body is considered closed and should not
## be consumed again.
@closed = true
## If the original Body is replaced by a new Body, the new Body must
## also consume the original Body by calling +close+ if possible.
@body.close if @body.respond_to?(:close)
index = @lint.index(self)
unless @env['rack.lint'][0..index].all? {|lint| lint.instance_variable_get(:@closed)}
raise LintError, "Body has not been closed"
end
end
def verify_to_path
##
## If the Body responds to +to_path+, it must return a +String+
## path for the local file system whose contents are identical
## to that produced by calling +each+; this may be used by the
## server as an alternative, possibly more efficient way to
## transport the response. The +to_path+ method does not consume
## the body.
if @body.respond_to?(:to_path)
unless ::File.exist? @body.to_path
raise LintError, "The file identified by body.to_path does not exist"
end
end
end
##
## ==== Enumerable Body
##
def each
## The Enumerable Body must respond to +each+.
raise LintError, "Enumerable Body must respond to each" unless @body.respond_to?(:each)
## It must only be called once.
raise LintError, "Response body must only be invoked once (#{@invoked})" unless @invoked.nil?
## It must not be called after being closed.
raise LintError, "Response body is already closed" if @closed
@invoked = :each
@body.each do |chunk|
## and must only yield String values.
unless chunk.kind_of? String
raise LintError, "Body yielded non-string value #{chunk.inspect}"
end
##
## The Body itself should not be an instance of String, as this will
## break in Ruby 1.9.
##
## Middleware must not call +each+ directly on the Body.
## Instead, middleware can return a new Body that calls +each+ on the
## original Body, yielding at least once per iteration.
if @lint[0] == self
@env['rack.lint.body_iteration'] += 1
else
if (@env['rack.lint.body_iteration'] -= 1) > 0
raise LintError, "New body must yield at least once per iteration of old body"
end
end
@size += chunk.bytesize
yield chunk
end
verify_content_length(@size)
verify_to_path
end
BODY_METHODS = {to_ary: true, each: true, call: true, to_path: true}
def to_path
@body.to_path
end
def respond_to?(name, *)
if BODY_METHODS.key?(name)
@body.respond_to?(name)
else
super
end
end
##
## If the Body responds to +to_ary+, it must return an +Array+ whose
## contents are identical to that produced by calling +each+.
## Middleware may call +to_ary+ directly on the Body and return a new
## Body in its place. In other words, middleware can only process the
## Body directly if it responds to +to_ary+. If the Body responds to both
## +to_ary+ and +close+, its implementation of +to_ary+ must call
## +close+.
def to_ary
@body.to_ary.tap do |content|
unless content == @body.enum_for.to_a
raise LintError, "#to_ary not identical to contents produced by calling #each"
end
end
ensure
close
end
##
## ==== Streaming Body
##
def call(stream)
## The Streaming Body must respond to +call+.
raise LintError, "Streaming Body must respond to call" unless @body.respond_to?(:call)
## It must only be called once.
raise LintError, "Response body must only be invoked once (#{@invoked})" unless @invoked.nil?
## It must not be called after being closed.
raise LintError, "Response body is already closed" if @closed
@invoked = :call
## It takes a +stream+ argument.
##
## The +stream+ argument must implement:
## <tt>read, write, <<, flush, close, close_read, close_write, closed?</tt>
##
@body.call(StreamWrapper.new(stream))
end
class StreamWrapper
extend Forwardable
## The semantics of these IO methods must be a best effort match to
## those of a normal Ruby IO or Socket object, using standard arguments
## and raising standard exceptions. Servers are encouraged to simply
## pass on real IO objects, although it is recognized that this approach
## is not directly compatible with HTTP/2.
REQUIRED_METHODS = [
:read, :write, :<<, :flush, :close,
:close_read, :close_write, :closed?
]
def_delegators :@stream, *REQUIRED_METHODS
def initialize(stream)
@stream = stream
REQUIRED_METHODS.each do |method_name|
raise LintError, "Stream must respond to #{method_name}" unless stream.respond_to?(method_name)
end
end
end
# :startdoc:
end
end
end
##
## == Thanks
## Some parts of this specification are adopted from {PEP 333 – Python Web Server Gateway Interface v1.0}[https://peps.python.org/pep-0333/]
## I'd like to thank everyone involved in that effort.
share/gems/gems/rack-3.0.8/CONTRIBUTING.md 0000644 00000005452 15173517743 0013374 0 ustar 00 # Contributing to Rack
Rack is work of [hundreds of
contributors](https://github.com/rack/rack/graphs/contributors). You're
encouraged to submit [pull requests](https://github.com/rack/rack/pulls) and
[propose features and discuss issues](https://github.com/rack/rack/issues).
## Fork the Project
Fork the [project on GitHub](https://github.com/rack/rack) and check out your
copy.
```
git clone https://github.com/(your-github-username)/rack.git
cd rack
git remote add upstream https://github.com/rack/rack.git
```
## Create a Topic Branch
Make sure your fork is up-to-date and create a topic branch for your feature or
bug fix.
```
git checkout main
git pull upstream main
git checkout -b my-feature-branch
```
## Bundle Install and Quick Test
Ensure that you can build the project and run quick tests.
```
bundle install --without extra
bundle exec rake test
```
## Running All Tests
Install all dependencies.
```
bundle install
```
Run all tests.
```
rake test
```
## Write Tests
Try to write a test that reproduces the problem you're trying to fix or
describes a feature that you want to build.
We definitely appreciate pull requests that highlight or reproduce a problem,
even without a fix.
## Write Code
Implement your feature or bug fix.
Make sure that all tests pass:
```
bundle exec rake test
```
## Write Documentation
Document any external behavior in the [README](README.md).
## Update Changelog
Add a line to [CHANGELOG](CHANGELOG.md).
## Commit Changes
Make sure git knows your name and email address:
```
git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"
```
Writing good commit logs is important. A commit log should describe what changed
and why.
```
git add ...
git commit
```
## Push
```
git push origin my-feature-branch
```
## Make a Pull Request
Go to your fork of rack on GitHub and select your feature branch. Click the
'Pull Request' button and fill out the form. Pull requests are usually
reviewed within a few days.
## Rebase
If you've been working on a change for a while, rebase with upstream/main.
```
git fetch upstream
git rebase upstream/main
git push origin my-feature-branch -f
```
## Make Required Changes
Amend your previous commit and force push the changes.
```
git commit --amend
git push origin my-feature-branch -f
```
## Check on Your Pull Request
Go back to your pull request after a few minutes and see whether it passed
tests with GitHub Actions. Everything should look green, otherwise fix issues and
amend your commit as described above.
## Be Patient
It's likely that your change will not be merged and that the nitpicky
maintainers will ask you to do more, or fix seemingly benign problems. Hang in
there!
## Thank You
Please do know that we really appreciate and value your time and work. We love
you, really.
share/gems/gems/bundler-2.5.22/exe/bundle 0000755 00000001273 15173517743 0013713 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
# frozen_string_literal: true
# Exit cleanly from an early interrupt
Signal.trap("INT") do
Bundler.ui.debug("\n#{caller.join("\n")}") if defined?(Bundler)
exit 1
end
base_path = File.expand_path("../lib", __dir__)
if File.exist?(base_path)
$LOAD_PATH.unshift(base_path)
end
require "bundler"
require "bundler/friendly_errors"
Bundler.with_friendly_errors do
require "bundler/cli"
# Allow any command to use --help flag to show help for that command
help_flags = %w[--help -h]
help_flag_used = ARGV.any? {|a| help_flags.include? a }
args = help_flag_used ? Bundler::CLI.reformatted_help_args(ARGV) : ARGV
Bundler::CLI.start(args, debug: true)
end
share/gems/gems/bundler-2.5.22/exe/bundler 0000755 00000000143 15173517743 0014070 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
# frozen_string_literal: true
load File.expand_path("bundle", __dir__)
share/gems/gems/bundler-2.5.22/lib/bundler.rb 0000644 00000057545 15173517743 0014476 0 ustar 00 # frozen_string_literal: true
require_relative "bundler/vendored_fileutils"
require "pathname"
require "rbconfig"
require_relative "bundler/errors"
require_relative "bundler/environment_preserver"
require_relative "bundler/plugin"
require_relative "bundler/rubygems_ext"
require_relative "bundler/rubygems_integration"
require_relative "bundler/version"
require_relative "bundler/constants"
require_relative "bundler/current_ruby"
require_relative "bundler/build_metadata"
# Bundler provides a consistent environment for Ruby projects by
# tracking and installing the exact gems and versions that are needed.
#
# Bundler is a part of Ruby's standard library.
#
# Bundler is used by creating _gemfiles_ listing all the project dependencies
# and (optionally) their versions and then using
#
# require 'bundler/setup'
#
# or Bundler.setup to setup environment where only specified gems and their
# specified versions could be used.
#
# See {Bundler website}[https://bundler.io/docs.html] for extensive documentation
# on gemfiles creation and Bundler usage.
#
# As a standard library inside project, Bundler could be used for introspection
# of loaded and required modules.
#
module Bundler
environment_preserver = EnvironmentPreserver.from_env
ORIGINAL_ENV = environment_preserver.restore
environment_preserver.replace_with_backup
SUDO_MUTEX = Thread::Mutex.new
autoload :Checksum, File.expand_path("bundler/checksum", __dir__)
autoload :CLI, File.expand_path("bundler/cli", __dir__)
autoload :CIDetector, File.expand_path("bundler/ci_detector", __dir__)
autoload :CompactIndexClient, File.expand_path("bundler/compact_index_client", __dir__)
autoload :Definition, File.expand_path("bundler/definition", __dir__)
autoload :Dependency, File.expand_path("bundler/dependency", __dir__)
autoload :Deprecate, File.expand_path("bundler/deprecate", __dir__)
autoload :Digest, File.expand_path("bundler/digest", __dir__)
autoload :Dsl, File.expand_path("bundler/dsl", __dir__)
autoload :EndpointSpecification, File.expand_path("bundler/endpoint_specification", __dir__)
autoload :Env, File.expand_path("bundler/env", __dir__)
autoload :Fetcher, File.expand_path("bundler/fetcher", __dir__)
autoload :FeatureFlag, File.expand_path("bundler/feature_flag", __dir__)
autoload :GemHelper, File.expand_path("bundler/gem_helper", __dir__)
autoload :GemHelpers, File.expand_path("bundler/gem_helpers", __dir__)
autoload :GemVersionPromoter, File.expand_path("bundler/gem_version_promoter", __dir__)
autoload :Graph, File.expand_path("bundler/graph", __dir__)
autoload :Index, File.expand_path("bundler/index", __dir__)
autoload :Injector, File.expand_path("bundler/injector", __dir__)
autoload :Installer, File.expand_path("bundler/installer", __dir__)
autoload :LazySpecification, File.expand_path("bundler/lazy_specification", __dir__)
autoload :LockfileParser, File.expand_path("bundler/lockfile_parser", __dir__)
autoload :MatchRemoteMetadata, File.expand_path("bundler/match_remote_metadata", __dir__)
autoload :ProcessLock, File.expand_path("bundler/process_lock", __dir__)
autoload :RemoteSpecification, File.expand_path("bundler/remote_specification", __dir__)
autoload :Resolver, File.expand_path("bundler/resolver", __dir__)
autoload :Retry, File.expand_path("bundler/retry", __dir__)
autoload :RubyDsl, File.expand_path("bundler/ruby_dsl", __dir__)
autoload :RubyVersion, File.expand_path("bundler/ruby_version", __dir__)
autoload :Runtime, File.expand_path("bundler/runtime", __dir__)
autoload :SelfManager, File.expand_path("bundler/self_manager", __dir__)
autoload :Settings, File.expand_path("bundler/settings", __dir__)
autoload :SharedHelpers, File.expand_path("bundler/shared_helpers", __dir__)
autoload :Source, File.expand_path("bundler/source", __dir__)
autoload :SourceList, File.expand_path("bundler/source_list", __dir__)
autoload :SourceMap, File.expand_path("bundler/source_map", __dir__)
autoload :SpecSet, File.expand_path("bundler/spec_set", __dir__)
autoload :StubSpecification, File.expand_path("bundler/stub_specification", __dir__)
autoload :UI, File.expand_path("bundler/ui", __dir__)
autoload :URICredentialsFilter, File.expand_path("bundler/uri_credentials_filter", __dir__)
autoload :URINormalizer, File.expand_path("bundler/uri_normalizer", __dir__)
autoload :SafeMarshal, File.expand_path("bundler/safe_marshal", __dir__)
class << self
def configure
@configure ||= configure_gem_home_and_path
end
def ui
(defined?(@ui) && @ui) || (self.ui = UI::Shell.new)
end
def ui=(ui)
Bundler.rubygems.ui = UI::RGProxy.new(ui)
@ui = ui
end
# Returns absolute path of where gems are installed on the filesystem.
def bundle_path
@bundle_path ||= Pathname.new(configured_bundle_path.path).expand_path(root)
end
def create_bundle_path
mkdir_p(bundle_path) unless bundle_path.exist?
@bundle_path = bundle_path.realpath
rescue Errno::EEXIST
raise PathError, "Could not install to path `#{bundle_path}` " \
"because a file already exists at that path. Either remove or rename the file so the directory can be created."
end
def configured_bundle_path
@configured_bundle_path ||= settings.path.tap(&:validate!)
end
# Returns absolute location of where binstubs are installed to.
def bin_path
@bin_path ||= begin
path = settings[:bin] || "bin"
path = Pathname.new(path).expand_path(root).expand_path
mkdir_p(path)
path
end
end
# Turns on the Bundler runtime. After +Bundler.setup+ call, all +load+ or
# +require+ of the gems would be allowed only if they are part of
# the Gemfile or Ruby's standard library. If the versions specified
# in Gemfile, only those versions would be loaded.
#
# Assuming Gemfile
#
# gem 'first_gem', '= 1.0'
# group :test do
# gem 'second_gem', '= 1.0'
# end
#
# The code using Bundler.setup works as follows:
#
# require 'third_gem' # allowed, required from global gems
# require 'first_gem' # allowed, loads the last installed version
# Bundler.setup
# require 'fourth_gem' # fails with LoadError
# require 'second_gem' # loads exactly version 1.0
#
# +Bundler.setup+ can be called only once, all subsequent calls are no-op.
#
# If _groups_ list is provided, only gems from specified groups would
# be allowed (gems specified outside groups belong to special +:default+ group).
#
# To require all gems from Gemfile (or only some groups), see Bundler.require.
#
def setup(*groups)
# Return if all groups are already loaded
return @setup if defined?(@setup) && @setup
definition.validate_runtime!
SharedHelpers.print_major_deprecations!
if groups.empty?
# Load all groups, but only once
@setup = load.setup
else
load.setup(*groups)
end
end
def auto_switch
self_manager.restart_with_locked_bundler_if_needed
end
# Automatically install dependencies if Bundler.settings[:auto_install] exists.
# This is set through config cmd `bundle config set --global auto_install 1`.
#
# Note that this method `nil`s out the global Definition object, so it
# should be called first, before you instantiate anything like an
# `Installer` that'll keep a reference to the old one instead.
def auto_install
return unless settings[:auto_install]
begin
definition.specs
rescue GemNotFound, GitError
ui.info "Automatically installing missing gems."
reset!
CLI::Install.new({}).run
reset!
end
end
# Setups Bundler environment (see Bundler.setup) if it is not already set,
# and loads all gems from groups specified. Unlike ::setup, can be called
# multiple times with different groups (if they were allowed by setup).
#
# Assuming Gemfile
#
# gem 'first_gem', '= 1.0'
# group :test do
# gem 'second_gem', '= 1.0'
# end
#
# The code will work as follows:
#
# Bundler.setup # allow all groups
# Bundler.require(:default) # requires only first_gem
# # ...later
# Bundler.require(:test) # requires second_gem
#
def require(*groups)
setup(*groups).require(*groups)
end
def load
@load ||= Runtime.new(root, definition)
end
def environment
SharedHelpers.major_deprecation 2, "Bundler.environment has been removed in favor of Bundler.load", print_caller_location: true
load
end
# Returns an instance of Bundler::Definition for given Gemfile and lockfile
#
# @param unlock [Hash, Boolean, nil] Gems that have been requested
# to be updated or true if all gems should be updated
# @param lockfile [Pathname] Path to Gemfile.lock
# @return [Bundler::Definition]
def definition(unlock = nil, lockfile = default_lockfile)
@definition = nil if unlock
@definition ||= begin
configure
Definition.build(default_gemfile, lockfile, unlock)
end
end
def frozen_bundle?
frozen = settings[:frozen]
return frozen unless frozen.nil?
settings[:deployment]
end
def locked_gems
@locked_gems ||=
if defined?(@definition) && @definition
definition.locked_gems
elsif Bundler.default_lockfile.file?
lock = Bundler.read_file(Bundler.default_lockfile)
LockfileParser.new(lock)
end
end
def most_specific_locked_platform?(platform)
return false unless defined?(@definition) && @definition
definition.most_specific_locked_platform == platform
end
def ruby_scope
"#{Bundler.rubygems.ruby_engine}/#{RbConfig::CONFIG["ruby_version"]}"
end
def user_home
@user_home ||= begin
home = Bundler.rubygems.user_home
bundle_home = home ? File.join(home, ".bundle") : nil
warning = if home.nil?
"Your home directory is not set."
elsif !File.directory?(home)
"`#{home}` is not a directory."
elsif !File.writable?(home) && (!File.directory?(bundle_home) || !File.writable?(bundle_home))
"`#{home}` is not writable."
end
if warning
Bundler.ui.warn "#{warning}\n"
user_home = tmp_home_path
Bundler.ui.warn "Bundler will use `#{user_home}' as your home directory temporarily.\n"
user_home
else
Pathname.new(home)
end
end
end
def user_bundle_path(dir = "home")
env_var, fallback = case dir
when "home"
["BUNDLE_USER_HOME", proc { Pathname.new(user_home).join(".bundle") }]
when "cache"
["BUNDLE_USER_CACHE", proc { user_bundle_path.join("cache") }]
when "config"
["BUNDLE_USER_CONFIG", proc { user_bundle_path.join("config") }]
when "plugin"
["BUNDLE_USER_PLUGIN", proc { user_bundle_path.join("plugin") }]
else
raise BundlerError, "Unknown user path requested: #{dir}"
end
# `fallback` will already be a Pathname, but Pathname.new() is
# idempotent so it's OK
Pathname.new(ENV.fetch(env_var, &fallback))
end
def user_cache
user_bundle_path("cache")
end
def home
bundle_path.join("bundler")
end
def install_path
home.join("gems")
end
def specs_path
bundle_path.join("specifications")
end
def root
@root ||= begin
SharedHelpers.root
rescue GemfileNotFound
bundle_dir = default_bundle_dir
raise GemfileNotFound, "Could not locate Gemfile or .bundle/ directory" unless bundle_dir
Pathname.new(File.expand_path("..", bundle_dir))
end
end
def app_config_path
if app_config = ENV["BUNDLE_APP_CONFIG"]
app_config_pathname = Pathname.new(app_config)
if app_config_pathname.absolute?
app_config_pathname
else
app_config_pathname.expand_path(root)
end
else
root.join(".bundle")
end
end
def app_cache(custom_path = nil)
path = custom_path || root
Pathname.new(path).join(settings.app_cache_path)
end
def tmp(name = Process.pid.to_s)
Kernel.send(:require, "tmpdir")
Pathname.new(Dir.mktmpdir(["bundler", name]))
end
def rm_rf(path)
FileUtils.remove_entry_secure(path) if path && File.exist?(path)
end
def settings
@settings ||= Settings.new(app_config_path)
rescue GemfileNotFound
@settings = Settings.new
end
# @return [Hash] Environment present before Bundler was activated
def original_env
ORIGINAL_ENV.clone
end
# @deprecated Use `unbundled_env` instead
def clean_env
message =
"`Bundler.clean_env` has been deprecated in favor of `Bundler.unbundled_env`. " \
"If you instead want the environment before bundler was originally loaded, use `Bundler.original_env`"
removed_message =
"`Bundler.clean_env` has been removed in favor of `Bundler.unbundled_env`. " \
"If you instead want the environment before bundler was originally loaded, use `Bundler.original_env`"
Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
unbundled_env
end
# @return [Hash] Environment with all bundler-related variables removed
def unbundled_env
unbundle_env(original_env)
end
# Remove all bundler-related variables from ENV
def unbundle_env!
ENV.replace(unbundle_env(ENV))
end
# Run block with environment present before Bundler was activated
def with_original_env
with_env(original_env) { yield }
end
# @deprecated Use `with_unbundled_env` instead
def with_clean_env
message =
"`Bundler.with_clean_env` has been deprecated in favor of `Bundler.with_unbundled_env`. " \
"If you instead want the environment before bundler was originally loaded, use `Bundler.with_original_env`"
removed_message =
"`Bundler.with_clean_env` has been removed in favor of `Bundler.with_unbundled_env`. " \
"If you instead want the environment before bundler was originally loaded, use `Bundler.with_original_env`"
Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
with_env(unbundled_env) { yield }
end
# Run block with all bundler-related variables removed
def with_unbundled_env
with_env(unbundled_env) { yield }
end
# Run subcommand with the environment present before Bundler was activated
def original_system(*args)
with_original_env { Kernel.system(*args) }
end
# @deprecated Use `unbundled_system` instead
def clean_system(*args)
message =
"`Bundler.clean_system` has been deprecated in favor of `Bundler.unbundled_system`. " \
"If you instead want to run the command in the environment before bundler was originally loaded, use `Bundler.original_system`"
removed_message =
"`Bundler.clean_system` has been removed in favor of `Bundler.unbundled_system`. " \
"If you instead want to run the command in the environment before bundler was originally loaded, use `Bundler.original_system`"
Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
with_env(unbundled_env) { Kernel.system(*args) }
end
# Run subcommand in an environment with all bundler related variables removed
def unbundled_system(*args)
with_unbundled_env { Kernel.system(*args) }
end
# Run a `Kernel.exec` to a subcommand with the environment present before Bundler was activated
def original_exec(*args)
with_original_env { Kernel.exec(*args) }
end
# @deprecated Use `unbundled_exec` instead
def clean_exec(*args)
message =
"`Bundler.clean_exec` has been deprecated in favor of `Bundler.unbundled_exec`. " \
"If you instead want to exec to a command in the environment before bundler was originally loaded, use `Bundler.original_exec`"
removed_message =
"`Bundler.clean_exec` has been removed in favor of `Bundler.unbundled_exec`. " \
"If you instead want to exec to a command in the environment before bundler was originally loaded, use `Bundler.original_exec`"
Bundler::SharedHelpers.major_deprecation(2, message, removed_message: removed_message, print_caller_location: true)
with_env(unbundled_env) { Kernel.exec(*args) }
end
# Run a `Kernel.exec` to a subcommand in an environment with all bundler related variables removed
def unbundled_exec(*args)
with_env(unbundled_env) { Kernel.exec(*args) }
end
def local_platform
return Gem::Platform::RUBY if settings[:force_ruby_platform]
Gem::Platform.local
end
def default_gemfile
SharedHelpers.default_gemfile
end
def default_lockfile
SharedHelpers.default_lockfile
end
def default_bundle_dir
SharedHelpers.default_bundle_dir
end
def system_bindir
# Gem.bindir doesn't always return the location that RubyGems will install
# system binaries. If you put '-n foo' in your .gemrc, RubyGems will
# install binstubs there instead. Unfortunately, RubyGems doesn't expose
# that directory at all, so rather than parse .gemrc ourselves, we allow
# the directory to be set as well, via `bundle config set --local bindir foo`.
Bundler.settings[:system_bindir] || Bundler.rubygems.gem_bindir
end
def preferred_gemfile_name
Bundler.settings[:init_gems_rb] ? "gems.rb" : "Gemfile"
end
def use_system_gems?
configured_bundle_path.use_system_gems?
end
def mkdir_p(path)
SharedHelpers.filesystem_access(path, :write) do |p|
FileUtils.mkdir_p(p)
end
end
def which(executable)
if File.file?(executable) && File.executable?(executable)
executable
elsif paths = ENV["PATH"]
quote = '"'
paths.split(File::PATH_SEPARATOR).find do |path|
path = path[1..-2] if path.start_with?(quote) && path.end_with?(quote)
executable_path = File.expand_path(executable, path)
return executable_path if File.file?(executable_path) && File.executable?(executable_path)
end
end
end
def read_file(file)
SharedHelpers.filesystem_access(file, :read) do
File.open(file, "r:UTF-8", &:read)
end
end
def safe_load_marshal(data)
if Gem.respond_to?(:load_safe_marshal)
Gem.load_safe_marshal
begin
Gem::SafeMarshal.safe_load(data)
rescue Gem::SafeMarshal::Reader::Error, Gem::SafeMarshal::Visitors::ToRuby::Error => e
raise MarshalError, "#{e.class}: #{e.message}"
end
else
load_marshal(data, marshal_proc: SafeMarshal.proc)
end
end
def load_gemspec(file, validate = false)
@gemspec_cache ||= {}
key = File.expand_path(file)
@gemspec_cache[key] ||= load_gemspec_uncached(file, validate)
# Protect against caching side-effected gemspecs by returning a
# new instance each time.
@gemspec_cache[key]&.dup
end
def load_gemspec_uncached(file, validate = false)
path = Pathname.new(file)
contents = read_file(file)
spec = if contents.start_with?("---") # YAML header
eval_yaml_gemspec(path, contents)
else
# Eval the gemspec from its parent directory, because some gemspecs
# depend on "./" relative paths.
SharedHelpers.chdir(path.dirname.to_s) do
eval_gemspec(path, contents)
end
end
return unless spec
spec.loaded_from = path.expand_path.to_s
Bundler.rubygems.validate(spec) if validate
spec
end
def clear_gemspec_cache
@gemspec_cache = {}
end
def git_present?
return @git_present if defined?(@git_present)
@git_present = Bundler.which("git#{RbConfig::CONFIG["EXEEXT"]}")
end
def feature_flag
@feature_flag ||= FeatureFlag.new(VERSION)
end
def reset!
reset_paths!
Plugin.reset!
reset_rubygems!
end
def reset_settings_and_root!
@settings = nil
@root = nil
end
def reset_paths!
@bin_path = nil
@bundler_major_version = nil
@bundle_path = nil
@configure = nil
@configured_bundle_path = nil
@definition = nil
@load = nil
@locked_gems = nil
@root = nil
@settings = nil
@setup = nil
@user_home = nil
end
def reset_rubygems!
return unless defined?(@rubygems) && @rubygems
rubygems.undo_replacements
rubygems.reset
@rubygems = nil
end
def configure_gem_home_and_path(path = bundle_path)
configure_gem_path
configure_gem_home(path)
Bundler.rubygems.clear_paths
end
def self_manager
@self_manager ||= begin
require_relative "bundler/self_manager"
Bundler::SelfManager.new
end
end
private
def unbundle_env(env)
if env.key?("BUNDLER_ORIG_MANPATH")
env["MANPATH"] = env["BUNDLER_ORIG_MANPATH"]
end
env.delete_if {|k, _| k[0, 7] == "BUNDLE_" }
env.delete("BUNDLER_SETUP")
if env.key?("RUBYOPT")
rubyopt = env["RUBYOPT"].split(" ")
rubyopt.delete("-r#{File.expand_path("bundler/setup", __dir__)}")
rubyopt.delete("-rbundler/setup")
env["RUBYOPT"] = rubyopt.join(" ")
end
if env.key?("RUBYLIB")
rubylib = env["RUBYLIB"].split(File::PATH_SEPARATOR)
rubylib.delete(__dir__)
env["RUBYLIB"] = rubylib.join(File::PATH_SEPARATOR)
end
env
end
def load_marshal(data, marshal_proc: nil)
Marshal.load(data, marshal_proc)
rescue TypeError => e
raise MarshalError, "#{e.class}: #{e.message}"
end
def eval_yaml_gemspec(path, contents)
Kernel.require "psych"
Gem::Specification.from_yaml(contents)
rescue ::Psych::SyntaxError, ArgumentError, Gem::EndOfYAMLException, Gem::Exception
eval_gemspec(path, contents)
end
def eval_gemspec(path, contents)
eval(contents, TOPLEVEL_BINDING.dup, path.expand_path.to_s)
rescue ScriptError, StandardError => e
msg = "There was an error while loading `#{path.basename}`: #{e.message}"
raise GemspecError, Dsl::DSLError.new(msg, path.to_s, e.backtrace, contents)
end
def configure_gem_path
unless use_system_gems?
# this needs to be empty string to cause
# PathSupport.split_gem_path to only load up the
# Bundler --path setting as the GEM_PATH.
Bundler::SharedHelpers.set_env "GEM_PATH", ""
end
end
def configure_gem_home(path)
Bundler::SharedHelpers.set_env "GEM_HOME", path.to_s
end
def tmp_home_path
Kernel.send(:require, "tmpdir")
SharedHelpers.filesystem_access(Dir.tmpdir) do
path = Bundler.tmp
at_exit { Bundler.rm_rf(path) }
path
end
end
# @param env [Hash]
def with_env(env)
backup = ENV.to_hash
ENV.replace(env)
yield
ensure
ENV.replace(backup)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/self_manager.rb 0000644 00000014720 15173517743 0017105 0 ustar 00 # frozen_string_literal: true
module Bundler
#
# This class handles installing and switching to the version of bundler needed
# by an application.
#
class SelfManager
def restart_with_locked_bundler_if_needed
return unless needs_switching? && installed?
restart_with(restart_version)
end
def install_locked_bundler_and_restart_with_it_if_needed
return unless needs_switching?
if restart_version == lockfile_version
Bundler.ui.info \
"Bundler #{current_version} is running, but your lockfile was generated with #{lockfile_version}. " \
"Installing Bundler #{lockfile_version} and restarting using that version."
else
Bundler.ui.info \
"Bundler #{current_version} is running, but your configuration was #{restart_version}. " \
"Installing Bundler #{restart_version} and restarting using that version."
end
install_and_restart_with(restart_version)
end
def update_bundler_and_restart_with_it_if_needed(target)
return unless autoswitching_applies?
spec = resolve_update_version_from(target)
return unless spec
version = spec.version
Bundler.ui.info "Updating bundler to #{version}."
install(spec)
restart_with(version)
end
private
def install_and_restart_with(version)
requirement = Gem::Requirement.new(version)
spec = find_latest_matching_spec(requirement)
if spec.nil?
Bundler.ui.warn "Your lockfile is locked to a version of bundler (#{lockfile_version}) that doesn't exist at https://rubygems.org/. Going on using #{current_version}"
return
end
install(spec)
rescue StandardError => e
Bundler.ui.trace e
Bundler.ui.warn "There was an error installing the locked bundler version (#{lockfile_version}), rerun with the `--verbose` flag for more details. Going on using bundler #{current_version}."
else
restart_with(version)
end
def install(spec)
spec.source.install(spec)
end
def restart_with(version)
configured_gem_home = ENV["GEM_HOME"]
configured_gem_path = ENV["GEM_PATH"]
# Bundler specs need some stuff to be required before Bundler starts
# running, for example, for faking the compact index API. However, these
# flags are lost when we reexec to a different version of Bundler. In the
# future, we may be able to properly reconstruct the original Ruby
# invocation (see https://bugs.ruby-lang.org/issues/6648), but for now
# there's no way to do it, so we need to be explicit about how to re-exec.
# This may be a feature end users request at some point, but maybe by that
# time, we have builtin tools to do. So for now, we use an undocumented
# ENV variable only for our specs.
bundler_spec_original_cmd = ENV["BUNDLER_SPEC_ORIGINAL_CMD"]
if bundler_spec_original_cmd
require "shellwords"
cmd = [*Shellwords.shellsplit(bundler_spec_original_cmd), *ARGV]
else
cmd = [$PROGRAM_NAME, *ARGV]
cmd.unshift(Gem.ruby) unless File.executable?($PROGRAM_NAME)
end
Bundler.with_original_env do
Kernel.exec(
{ "GEM_HOME" => configured_gem_home, "GEM_PATH" => configured_gem_path, "BUNDLER_VERSION" => version.to_s },
*cmd
)
end
end
def needs_switching?
autoswitching_applies? &&
Bundler.settings[:version] != "system" &&
released?(restart_version) &&
!running?(restart_version) &&
!updating?
end
def autoswitching_applies?
ENV["BUNDLER_VERSION"].nil? &&
Bundler.rubygems.supports_bundler_trampolining? &&
ruby_can_restart_with_same_arguments? &&
SharedHelpers.in_bundle? &&
lockfile_version
end
def resolve_update_version_from(target)
requirement = Gem::Requirement.new(target)
update_candidate = find_latest_matching_spec(requirement)
if update_candidate.nil?
raise InvalidOption, "The `bundle update --bundler` target version (#{target}) does not exist"
end
resolved_version = update_candidate.version
needs_update = requirement.specific? ? !running?(resolved_version) : running_older_than?(resolved_version)
return unless needs_update
update_candidate
end
def local_specs
@local_specs ||= Bundler::Source::Rubygems.new("allow_local" => true).specs.select {|spec| spec.name == "bundler" }
end
def remote_specs
@remote_specs ||= begin
source = Bundler::Source::Rubygems.new("remotes" => "https://rubygems.org")
source.remote!
source.add_dependency_names("bundler")
source.specs.select(&:matches_current_metadata?)
end
end
def find_latest_matching_spec(requirement)
local_result = find_latest_matching_spec_from_collection(local_specs, requirement)
return local_result if local_result && requirement.specific?
remote_result = find_latest_matching_spec_from_collection(remote_specs, requirement)
return remote_result if local_result.nil?
[local_result, remote_result].max
end
def find_latest_matching_spec_from_collection(specs, requirement)
specs.sort.reverse_each.find {|spec| requirement.satisfied_by?(spec.version) }
end
def running?(version)
version == current_version
end
def running_older_than?(version)
current_version < version
end
def released?(version)
!version.to_s.end_with?(".dev")
end
def ruby_can_restart_with_same_arguments?
$PROGRAM_NAME != "-e"
end
def updating?
"update".start_with?(ARGV.first || " ") && ARGV[1..-1].any? {|a| a.start_with?("--bundler") }
end
def installed?
Bundler.configure
Bundler.rubygems.find_bundler(restart_version.to_s)
end
def current_version
@current_version ||= Gem::Version.new(Bundler::VERSION)
end
def lockfile_version
return @lockfile_version if defined?(@lockfile_version)
parsed_version = Bundler::LockfileParser.bundled_with
@lockfile_version = parsed_version ? Gem::Version.new(parsed_version) : nil
rescue ArgumentError
@lockfile_version = nil
end
def restart_version
return @restart_version if defined?(@restart_version)
# BUNDLE_VERSION=x.y.z
@restart_version = Gem::Version.new(Bundler.settings[:version])
rescue ArgumentError
# BUNDLE_VERSION=lockfile
@restart_version = lockfile_version
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_net_http.rb 0000644 00000001337 15173517743 0020175 0 ustar 00 # frozen_string_literal: true
# This defined? guard can be removed once RubyGems 3.4 support is dropped.
#
# Bundler specs load this code from `spec/support/vendored_net_http.rb` to avoid
# activating the Bundler gem too early. Without this guard, we get redefinition
# warnings once Bundler is actually activated and
# `lib/bundler/vendored_net_http.rb` is required. This is not an issue in
# RubyGems versions including `rubygems/vendored_net_http` since `require` takes
# care of avoiding the double load.
#
unless defined?(Gem::Net)
begin
require "rubygems/vendored_net_http"
rescue LoadError
begin
require "rubygems/net/http"
rescue LoadError
require "net/http"
Gem::Net = Net
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/similarity_detector.rb 0000644 00000003534 15173517743 0020542 0 ustar 00 # frozen_string_literal: true
module Bundler
class SimilarityDetector
SimilarityScore = Struct.new(:string, :distance)
# initialize with an array of words to be matched against
def initialize(corpus)
@corpus = corpus
end
# return an array of words similar to 'word' from the corpus
def similar_words(word, limit = 3)
words_by_similarity = @corpus.map {|w| SimilarityScore.new(w, levenshtein_distance(word, w)) }
words_by_similarity.select {|s| s.distance <= limit }.sort_by(&:distance).map(&:string)
end
# return the result of 'similar_words', concatenated into a list
# (eg "a, b, or c")
def similar_word_list(word, limit = 3)
words = similar_words(word, limit)
if words.length == 1
words[0]
elsif words.length > 1
[words[0..-2].join(", "), words[-1]].join(" or ")
end
end
protected
# https://www.informit.com/articles/article.aspx?p=683059&seqNum=36
def levenshtein_distance(this, that, ins = 2, del = 2, sub = 1)
# ins, del, sub are weighted costs
return nil if this.nil?
return nil if that.nil?
dm = [] # distance matrix
# Initialize first row values
dm[0] = (0..this.length).collect {|i| i * ins }
fill = [0] * (this.length - 1)
# Initialize first column values
(1..that.length).each do |i|
dm[i] = [i * del, fill.flatten]
end
# populate matrix
(1..that.length).each do |i|
(1..this.length).each do |j|
# critical comparison
dm[i][j] = [
dm[i - 1][j - 1] + (this[j - 1] == that[i - 1] ? 0 : sub),
dm[i][j - 1] + ins,
dm[i - 1][j] + del,
].min
end
end
# The last value in matrix is the Levenshtein distance between the strings
dm[that.length][this.length]
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_securerandom.rb 0000644 00000000701 15173517743 0021031 0 ustar 00 # frozen_string_literal: true
# Use RubyGems vendored copy when available. Otherwise fallback to Bundler
# vendored copy. The vendored copy in Bundler can be removed once support for
# RubyGems 3.5.18 is dropped.
begin
require "rubygems/vendored_securerandom"
rescue LoadError
module Bundler::Random; end
require_relative "vendor/securerandom/lib/securerandom"
Gem::SecureRandom = Bundler::SecureRandom
Gem::Random = Bundler::Random
end
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-plugin.1.ronn 0000644 00000003627 15173517743 0020516 0 ustar 00 bundle-plugin(1) -- Manage Bundler plugins
==========================================
## SYNOPSIS
`bundle plugin` install PLUGINS [--source=<SOURCE>] [--version=<version>]
[--git=<git-url>] [--branch=<branch>|--ref=<rev>]
[--path=<path>]<br>
`bundle plugin` uninstall PLUGINS<br>
`bundle plugin` list<br>
`bundle plugin` help [COMMAND]
## DESCRIPTION
You can install, uninstall, and list plugin(s) with this command to extend functionalities of Bundler.
## SUB-COMMANDS
### install
Install the given plugin(s).
* `bundle plugin install bundler-graph`:
Install bundler-graph gem from globally configured sources (defaults to RubyGems.org). The global source, specified in source in Gemfile is ignored.
* `bundle plugin install bundler-graph --source https://example.com`:
Install bundler-graph gem from example.com. The global source, specified in source in Gemfile is not considered.
* `bundle plugin install bundler-graph --version 0.2.1`:
You can specify the version of the gem via `--version`.
* `bundle plugin install bundler-graph --git https://github.com/rubygems/bundler-graph`:
Install bundler-graph gem from Git repository. You can use standard Git URLs like:
`ssh://[user@]host.xz[:port]/path/to/repo.git`<br>
`http[s]://host.xz[:port]/path/to/repo.git`<br>
`/path/to/repo`<br>
`file:///path/to/repo`
When you specify `--git`, you can use `--branch` or `--ref` to specify any branch, tag, or commit hash (revision) to use.
* `bundle plugin install bundler-graph --path ../bundler-graph`:
Install bundler-graph gem from a local path.
### uninstall
Uninstall the plugin(s) specified in PLUGINS.
### list
List the installed plugins and available commands.
No options.
### help
Describe subcommands or one specific subcommand.
No options.
## SEE ALSO
* [How to write a Bundler plugin](https://bundler.io/guides/bundler_plugins.html)
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-remove.1.ronn 0000644 00000001332 15173517743 0020504 0 ustar 00 bundle-remove(1) -- Removes gems from the Gemfile
===========================================================================
## SYNOPSIS
`bundle remove [GEM [GEM ...]] [--install]`
## DESCRIPTION
Removes the given gems from the Gemfile while ensuring that the resulting Gemfile is still valid. If a gem cannot be removed, a warning is printed. If a gem is already absent from the Gemfile, and error is raised.
## OPTIONS
* `--install`:
Runs `bundle install` after the given gems have been removed from the Gemfile, which ensures that both the lockfile and the installed gems on disk are also updated to remove the given gem(s).
Example:
bundle remove rails
bundle remove rails rack
bundle remove rails rack --install
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-inject.1.ronn 0000644 00000001265 15173517743 0020470 0 ustar 00 bundle-inject(1) -- Add named gem(s) with version requirements to Gemfile
=========================================================================
## SYNOPSIS
`bundle inject` [GEM] [VERSION]
## DESCRIPTION
Adds the named gem(s) with their version requirements to the resolved
[`Gemfile(5)`][Gemfile(5)].
This command will add the gem to both your [`Gemfile(5)`][Gemfile(5)] and Gemfile.lock if it
isn't listed yet.
Example:
bundle install
bundle inject 'rack' '> 0'
This will inject the 'rack' gem with a version greater than 0 in your
[`Gemfile(5)`][Gemfile(5)] and Gemfile.lock.
The `bundle inject` command was deprecated in Bundler 2.1 and will be removed in Bundler 3.0.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-outdated.1.ronn 0000644 00000006076 15173517743 0021032 0 ustar 00 bundle-outdated(1) -- List installed gems with newer versions available
=======================================================================
## SYNOPSIS
`bundle outdated` [GEM] [--local]
[--pre]
[--source]
[--strict]
[--parseable | --porcelain]
[--group=GROUP]
[--groups]
[--patch|--minor|--major]
[--filter-major]
[--filter-minor]
[--filter-patch]
[--only-explicit]
## DESCRIPTION
Outdated lists the names and versions of gems that have a newer version available
in the given source. Calling outdated with [GEM [GEM]] will only check for newer
versions of the given gems. Prerelease gems are ignored by default. If your gems
are up to date, Bundler will exit with a status of 0. Otherwise, it will exit 1.
## OPTIONS
* `--local`:
Do not attempt to fetch gems remotely and use the gem cache instead.
* `--pre`:
Check for newer pre-release gems.
* `--source`:
Check against a specific source.
* `--strict`:
Only list newer versions allowed by your Gemfile requirements, also respecting conservative update flags (--patch, --minor, --major).
* `--parseable`, `--porcelain`:
Use minimal formatting for more parseable output.
* `--group`:
List gems from a specific group.
* `--groups`:
List gems organized by groups.
* `--minor`:
Prefer updating only to next minor version.
* `--major`:
Prefer updating to next major version (default).
* `--patch`:
Prefer updating only to next patch version.
* `--filter-major`:
Only list major newer versions.
* `--filter-minor`:
Only list minor newer versions.
* `--filter-patch`:
Only list patch newer versions.
* `--only-explicit`:
Only list gems specified in your Gemfile, not their dependencies.
## PATCH LEVEL OPTIONS
See [bundle update(1)](bundle-update.1.html) for details.
## FILTERING OUTPUT
The 3 filtering options do not affect the resolution of versions, merely what versions are shown
in the output.
If the regular output shows the following:
* Gem Current Latest Requested Groups
* faker 1.6.5 1.6.6 ~> 1.4 development, test
* hashie 1.2.0 3.4.6 = 1.2.0 default
* headless 2.2.3 2.3.1 = 2.2.3 test
`--filter-major` would only show:
* Gem Current Latest Requested Groups
* hashie 1.2.0 3.4.6 = 1.2.0 default
`--filter-minor` would only show:
* Gem Current Latest Requested Groups
* headless 2.2.3 2.3.1 = 2.2.3 test
`--filter-patch` would only show:
* Gem Current Latest Requested Groups
* faker 1.6.5 1.6.6 ~> 1.4 development, test
Filter options can be combined. `--filter-minor` and `--filter-patch` would show:
* Gem Current Latest Requested Groups
* faker 1.6.5 1.6.6 ~> 1.4 development, test
Combining all three `filter` options would be the same result as providing none of them.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-doctor.1.ronn 0000644 00000001717 15173517743 0020510 0 ustar 00 bundle-doctor(1) -- Checks the bundle for common problems
=========================================================
## SYNOPSIS
`bundle doctor` [--quiet]
[--gemfile=GEMFILE]
## DESCRIPTION
Checks your Gemfile and gem environment for common problems. If issues
are detected, Bundler prints them and exits status 1. Otherwise,
Bundler prints a success message and exits status 0.
Examples of common problems caught by bundle-doctor include:
* Invalid Bundler settings
* Mismatched Ruby versions
* Mismatched platforms
* Uninstalled gems
* Missing dependencies
## OPTIONS
* `--quiet`:
Only output warnings and errors.
* `--gemfile=<gemfile>`:
The location of the Gemfile(5) which Bundler should use. This defaults
to a Gemfile(5) in the current working directory. In general, Bundler
will assume that the location of the Gemfile(5) is also the project's
root and will try to find `Gemfile.lock` and `vendor/cache` relative
to this location.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-version.1.ronn 0000644 00000000731 15173517743 0020676 0 ustar 00 bundle-version(1) -- Prints Bundler version information
=======================================================
## SYNOPSIS
`bundle version`
## DESCRIPTION
Prints Bundler version information.
## OPTIONS
No options.
## EXAMPLE
Print the version of Bundler with build date and commit hash of the in the Git source.
bundle version
shows `Bundler version 2.3.21 (2022-08-24 commit d54be5fdd8)` for example.
cf. `bundle --version` shows `Bundler version 2.3.21`.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-list.1 0000644 00000001664 15173517743 0017217 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-LIST" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-list\fR \- List all the gems in the bundle
.SH "SYNOPSIS"
\fBbundle list\fR [\-\-name\-only] [\-\-paths] [\-\-without\-group=GROUP[ GROUP\|\.\|\.\|\.]] [\-\-only\-group=GROUP[ GROUP\|\.\|\.\|\.]]
.SH "DESCRIPTION"
Prints a list of all the gems in the bundle including their version\.
.P
Example:
.P
bundle list \-\-name\-only
.P
bundle list \-\-paths
.P
bundle list \-\-without\-group test
.P
bundle list \-\-only\-group dev
.P
bundle list \-\-only\-group dev test \-\-paths
.SH "OPTIONS"
.TP
\fB\-\-name\-only\fR
Print only the name of each gem\.
.TP
\fB\-\-paths\fR
Print the path to each gem in the bundle\.
.TP
\fB\-\-without\-group=<list>\fR
A space\-separated list of groups of gems to skip during printing\.
.TP
\fB\-\-only\-group=<list>\fR
A space\-separated list of groups of gems to print\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-lock.1 0000644 00000006106 15173517743 0017170 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-LOCK" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-lock\fR \- Creates / Updates a lockfile without installing
.SH "SYNOPSIS"
\fBbundle lock\fR [\-\-update] [\-\-local] [\-\-print] [\-\-lockfile=PATH] [\-\-full\-index] [\-\-add\-platform] [\-\-remove\-platform] [\-\-patch] [\-\-minor] [\-\-major] [\-\-strict] [\-\-conservative]
.SH "DESCRIPTION"
Lock the gems specified in Gemfile\.
.SH "OPTIONS"
.TP
\fB\-\-update=<*gems>\fR
Ignores the existing lockfile\. Resolve then updates lockfile\. Taking a list of gems or updating all gems if no list is given\.
.TP
\fB\-\-local\fR
Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the gems already present in Rubygems' cache or in \fBvendor/cache\fR\. Note that if a appropriate platform\-specific gem exists on \fBrubygems\.org\fR it will not be found\.
.TP
\fB\-\-print\fR
Prints the lockfile to STDOUT instead of writing to the file system\.
.TP
\fB\-\-lockfile=<path>\fR
The path where the lockfile should be written to\.
.TP
\fB\-\-full\-index\fR
Fall back to using the single\-file index of all gems\.
.TP
\fB\-\-add\-platform\fR
Add a new platform to the lockfile, re\-resolving for the addition of that platform\.
.TP
\fB\-\-remove\-platform\fR
Remove a platform from the lockfile\.
.TP
\fB\-\-patch\fR
If updating, prefer updating only to next patch version\.
.TP
\fB\-\-minor\fR
If updating, prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
If updating, prefer updating to next major version (default)\.
.TP
\fB\-\-strict\fR
If updating, do not allow any gem to be updated past latest \-\-patch | \-\-minor | \-\-major\.
.TP
\fB\-\-conservative\fR
If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated\.
.SH "UPDATING ALL GEMS"
If you run \fBbundle lock\fR with \fB\-\-update\fR option without list of gems, bundler will ignore any previously installed gems and resolve all dependencies again based on the latest versions of all gems available in the sources\.
.SH "UPDATING A LIST OF GEMS"
Sometimes, you want to update a single gem in the Gemfile(5), and leave the rest of the gems that you specified locked to the versions in the \fBGemfile\.lock\fR\.
.P
For instance, you only want to update \fBnokogiri\fR, run \fBbundle lock \-\-update nokogiri\fR\.
.P
Bundler will update \fBnokogiri\fR and any of its dependencies, but leave the rest of the gems that you specified locked to the versions in the \fBGemfile\.lock\fR\.
.SH "SUPPORTING OTHER PLATFORMS"
If you want your bundle to support platforms other than the one you're running locally, you can run \fBbundle lock \-\-add\-platform PLATFORM\fR to add PLATFORM to the lockfile, force bundler to re\-resolve and consider the new platform when picking gems, all without needing to have a machine that matches PLATFORM handy to install those platform\-specific gems on\.
.P
For a full explanation of gem platforms, see \fBgem help platform\fR\.
.SH "PATCH LEVEL OPTIONS"
See bundle update(1) \fIbundle\-update\.1\.html\fR for details\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-cache.1.ronn 0000644 00000006046 15173517743 0020261 0 ustar 00 bundle-cache(1) -- Package your needed `.gem` files into your application
===========================================================================
## SYNOPSIS
`bundle cache`
alias: `package`, `pack`
## DESCRIPTION
Copy all of the `.gem` files needed to run the application into the
`vendor/cache` directory. In the future, when running [`bundle install(1)`](bundle-install.1.html),
use the gems in the cache in preference to the ones on `rubygems.org`.
## GIT AND PATH GEMS
The `bundle cache` command can also package `:git` and `:path` dependencies
besides .gem files. This needs to be explicitly enabled via the `--all` option.
Once used, the `--all` option will be remembered.
## SUPPORT FOR MULTIPLE PLATFORMS
When using gems that have different packages for different platforms, Bundler
supports caching of gems for other platforms where the Gemfile has been resolved
(i.e. present in the lockfile) in `vendor/cache`. This needs to be enabled via
the `--all-platforms` option. This setting will be remembered in your local
bundler configuration.
## REMOTE FETCHING
By default, if you run [`bundle install(1)`](bundle-install.1.html) after running
[bundle cache(1)](bundle-cache.1.html), bundler will still connect to `rubygems.org`
to check whether a platform-specific gem exists for any of the gems
in `vendor/cache`.
For instance, consider this Gemfile(5):
source "https://rubygems.org"
gem "nokogiri"
If you run `bundle cache` under C Ruby, bundler will retrieve
the version of `nokogiri` for the `"ruby"` platform. If you deploy
to JRuby and run `bundle install`, bundler is forced to check to
see whether a `"java"` platformed `nokogiri` exists.
Even though the `nokogiri` gem for the Ruby platform is
_technically_ acceptable on JRuby, it has a C extension
that does not run on JRuby. As a result, bundler will, by default,
still connect to `rubygems.org` to check whether it has a version
of one of your gems more specific to your platform.
This problem is also not limited to the `"java"` platform.
A similar (common) problem can happen when developing on Windows
and deploying to Linux, or even when developing on OSX and
deploying to Linux.
If you know for sure that the gems packaged in `vendor/cache`
are appropriate for the platform you are on, you can run
`bundle install --local` to skip checking for more appropriate
gems, and use the ones in `vendor/cache`.
One way to be sure that you have the right platformed versions
of all your gems is to run `bundle cache` on an identical
machine and check in the gems. For instance, you can run
`bundle cache` on an identical staging box during your
staging process, and check in the `vendor/cache` before
deploying to production.
By default, [bundle cache(1)](bundle-cache.1.html) fetches and also
installs the gems to the default location. To package the
dependencies to `vendor/cache` without installing them to the
local install location, you can run `bundle cache --no-install`.
## HISTORY
In Bundler 2.1, `cache` took in the functionalities of `package` and now
`package` and `pack` are aliases of `cache`.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-help.1.ronn 0000644 00000000535 15173517743 0020143 0 ustar 00 bundle-help(1) -- Displays detailed help for each subcommand
============================================================
## SYNOPSIS
`bundle help` [COMMAND]
## DESCRIPTION
Displays detailed help for the given subcommand.
You can specify a single `COMMAND` at the same time.
When `COMMAND` is omitted, help for `help` command will be displayed.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-update.1 0000644 00000032551 15173517743 0017525 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-UPDATE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-update\fR \- Update your gems to the latest available versions
.SH "SYNOPSIS"
\fBbundle update\fR \fI*gems\fR [\-\-all] [\-\-group=NAME] [\-\-source=NAME] [\-\-local] [\-\-ruby] [\-\-bundler[=VERSION]] [\-\-full\-index] [\-\-jobs=JOBS] [\-\-quiet] [\-\-patch|\-\-minor|\-\-major] [\-\-redownload] [\-\-strict] [\-\-conservative]
.SH "DESCRIPTION"
Update the gems specified (all gems, if \fB\-\-all\fR flag is used), ignoring the previously installed gems specified in the \fBGemfile\.lock\fR\. In general, you should use bundle install(1) \fIbundle\-install\.1\.html\fR to install the same exact gems and versions across machines\.
.P
You would use \fBbundle update\fR to explicitly update the version of a gem\.
.SH "OPTIONS"
.TP
\fB\-\-all\fR
Update all gems specified in Gemfile\.
.TP
\fB\-\-group=<name>\fR, \fB\-g=[<name>]\fR
Only update the gems in the specified group\. For instance, you can update all gems in the development group with \fBbundle update \-\-group development\fR\. You can also call \fBbundle update rails \-\-group test\fR to update the rails gem and all gems in the test group, for example\.
.TP
\fB\-\-source=<name>\fR
The name of a \fB:git\fR or \fB:path\fR source used in the Gemfile(5)\. For instance, with a \fB:git\fR source of \fBhttp://github\.com/rails/rails\.git\fR, you would call \fBbundle update \-\-source rails\fR
.TP
\fB\-\-local\fR
Do not attempt to fetch gems remotely and use the gem cache instead\.
.TP
\fB\-\-ruby\fR
Update the locked version of Ruby to the current version of Ruby\.
.TP
\fB\-\-bundler\fR
Update the locked version of bundler to the invoked bundler version\.
.TP
\fB\-\-full\-index\fR
Fall back to using the single\-file index of all gems\.
.TP
\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR
Specify the number of jobs to run in parallel\. The default is the number of available processors\.
.TP
\fB\-\-retry=[<number>]\fR
Retry failed network or git requests for \fInumber\fR times\.
.TP
\fB\-\-quiet\fR
Only output warnings and errors\.
.TP
\fB\-\-redownload\fR
Force downloading every gem\.
.TP
\fB\-\-patch\fR
Prefer updating only to next patch version\.
.TP
\fB\-\-minor\fR
Prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
Prefer updating to next major version (default)\.
.TP
\fB\-\-strict\fR
Do not allow any gem to be updated past latest \fB\-\-patch\fR | \fB\-\-minor\fR | \fB\-\-major\fR\.
.TP
\fB\-\-conservative\fR
Use bundle install conservative update behavior and do not allow indirect dependencies to be updated\.
.SH "UPDATING ALL GEMS"
If you run \fBbundle update \-\-all\fR, bundler will ignore any previously installed gems and resolve all dependencies again based on the latest versions of all gems available in the sources\.
.P
Consider the following Gemfile(5):
.IP "" 4
.nf
source "https://rubygems\.org"
gem "rails", "3\.0\.0\.rc"
gem "nokogiri"
.fi
.IP "" 0
.P
When you run bundle install(1) \fIbundle\-install\.1\.html\fR the first time, bundler will resolve all of the dependencies, all the way down, and install what you need:
.IP "" 4
.nf
Fetching gem metadata from https://rubygems\.org/\|\.\|\.\|\.\|\.\|\.\|\.\|\.\|\.\|\.
Resolving dependencies\|\.\|\.\|\.
Installing builder 2\.1\.2
Installing abstract 1\.0\.0
Installing rack 1\.2\.8
Using bundler 1\.7\.6
Installing rake 10\.4\.0
Installing polyglot 0\.3\.5
Installing mime\-types 1\.25\.1
Installing i18n 0\.4\.2
Installing mini_portile 0\.6\.1
Installing tzinfo 0\.3\.42
Installing rack\-mount 0\.6\.14
Installing rack\-test 0\.5\.7
Installing treetop 1\.4\.15
Installing thor 0\.14\.6
Installing activesupport 3\.0\.0\.rc
Installing erubis 2\.6\.6
Installing activemodel 3\.0\.0\.rc
Installing arel 0\.4\.0
Installing mail 2\.2\.20
Installing activeresource 3\.0\.0\.rc
Installing actionpack 3\.0\.0\.rc
Installing activerecord 3\.0\.0\.rc
Installing actionmailer 3\.0\.0\.rc
Installing railties 3\.0\.0\.rc
Installing rails 3\.0\.0\.rc
Installing nokogiri 1\.6\.5
Bundle complete! 2 Gemfile dependencies, 26 gems total\.
Use `bundle show [gemname]` to see where a bundled gem is installed\.
.fi
.IP "" 0
.P
As you can see, even though you have two gems in the Gemfile(5), your application needs 26 different gems in order to run\. Bundler remembers the exact versions it installed in \fBGemfile\.lock\fR\. The next time you run bundle install(1) \fIbundle\-install\.1\.html\fR, bundler skips the dependency resolution and installs the same gems as it installed last time\.
.P
After checking in the \fBGemfile\.lock\fR into version control and cloning it on another machine, running bundle install(1) \fIbundle\-install\.1\.html\fR will \fIstill\fR install the gems that you installed last time\. You don't need to worry that a new release of \fBerubis\fR or \fBmail\fR changes the gems you use\.
.P
However, from time to time, you might want to update the gems you are using to the newest versions that still match the gems in your Gemfile(5)\.
.P
To do this, run \fBbundle update \-\-all\fR, which will ignore the \fBGemfile\.lock\fR, and resolve all the dependencies again\. Keep in mind that this process can result in a significantly different set of the 25 gems, based on the requirements of new gems that the gem authors released since the last time you ran \fBbundle update \-\-all\fR\.
.SH "UPDATING A LIST OF GEMS"
Sometimes, you want to update a single gem in the Gemfile(5), and leave the rest of the gems that you specified locked to the versions in the \fBGemfile\.lock\fR\.
.P
For instance, in the scenario above, imagine that \fBnokogiri\fR releases version \fB1\.4\.4\fR, and you want to update it \fIwithout\fR updating Rails and all of its dependencies\. To do this, run \fBbundle update nokogiri\fR\.
.P
Bundler will update \fBnokogiri\fR and any of its dependencies, but leave alone Rails and its dependencies\.
.SH "OVERLAPPING DEPENDENCIES"
Sometimes, multiple gems declared in your Gemfile(5) are satisfied by the same second\-level dependency\. For instance, consider the case of \fBthin\fR and \fBrack\-perftools\-profiler\fR\.
.IP "" 4
.nf
source "https://rubygems\.org"
gem "thin"
gem "rack\-perftools\-profiler"
.fi
.IP "" 0
.P
The \fBthin\fR gem depends on \fBrack >= 1\.0\fR, while \fBrack\-perftools\-profiler\fR depends on \fBrack ~> 1\.0\fR\. If you run bundle install, you get:
.IP "" 4
.nf
Fetching source index for https://rubygems\.org/
Installing daemons (1\.1\.0)
Installing eventmachine (0\.12\.10) with native extensions
Installing open4 (1\.0\.1)
Installing perftools\.rb (0\.4\.7) with native extensions
Installing rack (1\.2\.1)
Installing rack\-perftools_profiler (0\.0\.2)
Installing thin (1\.2\.7) with native extensions
Using bundler (1\.0\.0\.rc\.3)
.fi
.IP "" 0
.P
In this case, the two gems have their own set of dependencies, but they share \fBrack\fR in common\. If you run \fBbundle update thin\fR, bundler will update \fBdaemons\fR, \fBeventmachine\fR and \fBrack\fR, which are dependencies of \fBthin\fR, but not \fBopen4\fR or \fBperftools\.rb\fR, which are dependencies of \fBrack\-perftools_profiler\fR\. Note that \fBbundle update thin\fR will update \fBrack\fR even though it's \fIalso\fR a dependency of \fBrack\-perftools_profiler\fR\.
.P
In short, by default, when you update a gem using \fBbundle update\fR, bundler will update all dependencies of that gem, including those that are also dependencies of another gem\.
.P
To prevent updating indirect dependencies, prior to version 1\.14 the only option was the \fBCONSERVATIVE UPDATING\fR behavior in bundle install(1) \fIbundle\-install\.1\.html\fR:
.P
In this scenario, updating the \fBthin\fR version manually in the Gemfile(5), and then running bundle install(1) \fIbundle\-install\.1\.html\fR will only update \fBdaemons\fR and \fBeventmachine\fR, but not \fBrack\fR\. For more information, see the \fBCONSERVATIVE UPDATING\fR section of bundle install(1) \fIbundle\-install\.1\.html\fR\.
.P
Starting with 1\.14, specifying the \fB\-\-conservative\fR option will also prevent indirect dependencies from being updated\.
.SH "PATCH LEVEL OPTIONS"
Version 1\.14 introduced 4 patch\-level options that will influence how gem versions are resolved\. One of the following options can be used: \fB\-\-patch\fR, \fB\-\-minor\fR or \fB\-\-major\fR\. \fB\-\-strict\fR can be added to further influence resolution\.
.TP
\fB\-\-patch\fR
Prefer updating only to next patch version\.
.TP
\fB\-\-minor\fR
Prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
Prefer updating to next major version (default)\.
.TP
\fB\-\-strict\fR
Do not allow any gem to be updated past latest \fB\-\-patch\fR | \fB\-\-minor\fR | \fB\-\-major\fR\.
.P
When Bundler is resolving what versions to use to satisfy declared requirements in the Gemfile or in parent gems, it looks up all available versions, filters out any versions that don't satisfy the requirement, and then, by default, sorts them from newest to oldest, considering them in that order\.
.P
Providing one of the patch level options (e\.g\. \fB\-\-patch\fR) changes the sort order of the satisfying versions, causing Bundler to consider the latest \fB\-\-patch\fR or \fB\-\-minor\fR version available before other versions\. Note that versions outside the stated patch level could still be resolved to if necessary to find a suitable dependency graph\.
.P
For example, if gem 'foo' is locked at 1\.0\.2, with no gem requirement defined in the Gemfile, and versions 1\.0\.3, 1\.0\.4, 1\.1\.0, 1\.1\.1, 2\.0\.0 all exist, the default order of preference by default (\fB\-\-major\fR) will be "2\.0\.0, 1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2"\.
.P
If the \fB\-\-patch\fR option is used, the order of preference will change to "1\.0\.4, 1\.0\.3, 1\.0\.2, 1\.1\.1, 1\.1\.0, 2\.0\.0"\.
.P
If the \fB\-\-minor\fR option is used, the order of preference will change to "1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2, 2\.0\.0"\.
.P
Combining the \fB\-\-strict\fR option with any of the patch level options will remove any versions beyond the scope of the patch level option, to ensure that no gem is updated that far\.
.P
To continue the previous example, if both \fB\-\-patch\fR and \fB\-\-strict\fR options are used, the available versions for resolution would be "1\.0\.4, 1\.0\.3, 1\.0\.2"\. If \fB\-\-minor\fR and \fB\-\-strict\fR are used, it would be "1\.1\.1, 1\.1\.0, 1\.0\.4, 1\.0\.3, 1\.0\.2"\.
.P
Gem requirements as defined in the Gemfile will still be the first determining factor for what versions are available\. If the gem requirement for \fBfoo\fR in the Gemfile is '~> 1\.0', that will accomplish the same thing as providing the \fB\-\-minor\fR and \fB\-\-strict\fR options\.
.SH "PATCH LEVEL EXAMPLES"
Given the following gem specifications:
.IP "" 4
.nf
foo 1\.4\.3, requires: ~> bar 2\.0
foo 1\.4\.4, requires: ~> bar 2\.0
foo 1\.4\.5, requires: ~> bar 2\.1
foo 1\.5\.0, requires: ~> bar 2\.1
foo 1\.5\.1, requires: ~> bar 3\.0
bar with versions 2\.0\.3, 2\.0\.4, 2\.1\.0, 2\.1\.1, 3\.0\.0
.fi
.IP "" 0
.P
Gemfile:
.IP "" 4
.nf
gem 'foo'
.fi
.IP "" 0
.P
Gemfile\.lock:
.IP "" 4
.nf
foo (1\.4\.3)
bar (~> 2\.0)
bar (2\.0\.3)
.fi
.IP "" 0
.P
Cases:
.IP "" 4
.nf
# Command Line Result
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
1 bundle update \-\-patch 'foo 1\.4\.5', 'bar 2\.1\.1'
2 bundle update \-\-patch foo 'foo 1\.4\.5', 'bar 2\.1\.1'
3 bundle update \-\-minor 'foo 1\.5\.1', 'bar 3\.0\.0'
4 bundle update \-\-minor \-\-strict 'foo 1\.5\.0', 'bar 2\.1\.1'
5 bundle update \-\-patch \-\-strict 'foo 1\.4\.4', 'bar 2\.0\.4'
.fi
.IP "" 0
.P
In case 1, bar is upgraded to 2\.1\.1, a minor version increase, because the dependency from foo 1\.4\.5 required it\.
.P
In case 2, only foo is requested to be unlocked, but bar is also allowed to move because it's not a declared dependency in the Gemfile\.
.P
In case 3, bar goes up a whole major release, because a minor increase is preferred now for foo, and when it goes to 1\.5\.1, it requires 3\.0\.0 of bar\.
.P
In case 4, foo is preferred up to a minor version, but 1\.5\.1 won't work because the \-\-strict flag removes bar 3\.0\.0 from consideration since it's a major increment\.
.P
In case 5, both foo and bar have any minor or major increments removed from consideration because of the \-\-strict flag, so the most they can move is up to 1\.4\.4 and 2\.0\.4\.
.SH "RECOMMENDED WORKFLOW"
In general, when working with an application managed with bundler, you should use the following workflow:
.IP "\(bu" 4
After you create your Gemfile(5) for the first time, run
.IP
$ bundle install
.IP "\(bu" 4
Check the resulting \fBGemfile\.lock\fR into version control
.IP
$ git add Gemfile\.lock
.IP "\(bu" 4
When checking out this repository on another development machine, run
.IP
$ bundle install
.IP "\(bu" 4
When checking out this repository on a deployment machine, run
.IP
$ bundle install \-\-deployment
.IP "\(bu" 4
After changing the Gemfile(5) to reflect a new or update dependency, run
.IP
$ bundle install
.IP "\(bu" 4
Make sure to check the updated \fBGemfile\.lock\fR into version control
.IP
$ git add Gemfile\.lock
.IP "\(bu" 4
If bundle install(1) \fIbundle\-install\.1\.html\fR reports a conflict, manually update the specific gems that you changed in the Gemfile(5)
.IP
$ bundle update rails thin
.IP "\(bu" 4
If you want to update all the gems to the latest possible versions that still match the gems listed in the Gemfile(5), run
.IP
$ bundle update \-\-all
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-clean.1 0000644 00000001326 15173517743 0017321 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CLEAN" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-clean\fR \- Cleans up unused gems in your bundler directory
.SH "SYNOPSIS"
\fBbundle clean\fR [\-\-dry\-run] [\-\-force]
.SH "DESCRIPTION"
This command will remove all unused gems in your bundler directory\. This is useful when you have made many changes to your gem dependencies\.
.SH "OPTIONS"
.TP
\fB\-\-dry\-run\fR
Print the changes, but do not clean the unused gems\.
.TP
\fB\-\-force\fR
Forces cleaning up unused gems even if Bundler is configured to use globally installed gems\. As a consequence, removes all system gems except for the ones in the current application\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-pristine.1.ronn 0000644 00000002723 15173517743 0021051 0 ustar 00 bundle-pristine(1) -- Restores installed gems to their pristine condition
===========================================================================
## SYNOPSIS
`bundle pristine`
## DESCRIPTION
`pristine` restores the installed gems in the bundle to their pristine condition
using the local gem cache from RubyGems. For git gems, a forced checkout will be performed.
For further explanation, `bundle pristine` ignores unpacked files on disk. In other
words, this command utilizes the local `.gem` cache or the gem's git repository
as if one were installing from scratch.
Note: the Bundler gem cannot be restored to its original state with `pristine`.
One also cannot use `bundle pristine` on gems with a 'path' option in the Gemfile,
because bundler has no original copy it can restore from.
When is it practical to use `bundle pristine`?
It comes in handy when a developer is debugging a gem. `bundle pristine` is a
great way to get rid of experimental changes to a gem that one may not want.
Why use `bundle pristine` over `gem pristine --all`?
Both commands are very similar.
For context: `bundle pristine`, without arguments, cleans all gems from the lockfile.
Meanwhile, `gem pristine --all` cleans all installed gems for that Ruby version.
If a developer forgets which gems in their project they might
have been debugging, the Rubygems `gem pristine [GEMNAME]` command may be inconvenient.
One can avoid waiting for `gem pristine --all`, and instead run `bundle pristine`.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-plugin.1 0000644 00000004162 15173517743 0017536 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-PLUGIN" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-plugin\fR \- Manage Bundler plugins
.SH "SYNOPSIS"
\fBbundle plugin\fR install PLUGINS [\-\-source=\fISOURCE\fR] [\-\-version=\fIversion\fR] [\-\-git=\fIgit\-url\fR] [\-\-branch=\fIbranch\fR|\-\-ref=\fIrev\fR] [\-\-path=\fIpath\fR]
.br
\fBbundle plugin\fR uninstall PLUGINS
.br
\fBbundle plugin\fR list
.br
\fBbundle plugin\fR help [COMMAND]
.SH "DESCRIPTION"
You can install, uninstall, and list plugin(s) with this command to extend functionalities of Bundler\.
.SH "SUB\-COMMANDS"
.SS "install"
Install the given plugin(s)\.
.TP
\fBbundle plugin install bundler\-graph\fR
Install bundler\-graph gem from globally configured sources (defaults to RubyGems\.org)\. The global source, specified in source in Gemfile is ignored\.
.TP
\fBbundle plugin install bundler\-graph \-\-source https://example\.com\fR
Install bundler\-graph gem from example\.com\. The global source, specified in source in Gemfile is not considered\.
.TP
\fBbundle plugin install bundler\-graph \-\-version 0\.2\.1\fR
You can specify the version of the gem via \fB\-\-version\fR\.
.TP
\fBbundle plugin install bundler\-graph \-\-git https://github\.com/rubygems/bundler\-graph\fR
Install bundler\-graph gem from Git repository\. You can use standard Git URLs like:
.IP
\fBssh://[user@]host\.xz[:port]/path/to/repo\.git\fR
.br
\fBhttp[s]://host\.xz[:port]/path/to/repo\.git\fR
.br
\fB/path/to/repo\fR
.br
\fBfile:///path/to/repo\fR
.IP
When you specify \fB\-\-git\fR, you can use \fB\-\-branch\fR or \fB\-\-ref\fR to specify any branch, tag, or commit hash (revision) to use\.
.TP
\fBbundle plugin install bundler\-graph \-\-path \.\./bundler\-graph\fR
Install bundler\-graph gem from a local path\.
.SS "uninstall"
Uninstall the plugin(s) specified in PLUGINS\.
.SS "list"
List the installed plugins and available commands\.
.P
No options\.
.SS "help"
Describe subcommands or one specific subcommand\.
.P
No options\.
.SH "SEE ALSO"
.IP "\(bu" 4
How to write a Bundler plugin \fIhttps://bundler\.io/guides/bundler_plugins\.html\fR
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-viz.1.ronn 0000644 00000002073 15173517743 0020022 0 ustar 00 bundle-viz(1) -- Generates a visual dependency graph for your Gemfile
=====================================================================
## SYNOPSIS
`bundle viz` [--file=FILE]
[--format=FORMAT]
[--requirements]
[--version]
[--without=GROUP GROUP]
## DESCRIPTION
`viz` generates a PNG file of the current `Gemfile(5)` as a dependency graph.
`viz` requires the ruby-graphviz gem (and its dependencies).
The associated gems must also be installed via [`bundle install(1)`](bundle-install.1.html).
`viz` command was deprecated in Bundler 2.2. Use [bundler-graph plugin](https://github.com/rubygems/bundler-graph) instead.
## OPTIONS
* `--file`, `-f`:
The name to use for the generated file. See `--format` option
* `--format`, `-F`:
This is output format option. Supported format is png, jpg, svg, dot ...
* `--requirements`, `-R`:
Set to show the version of each required dependency.
* `--version`, `-v`:
Set to show each gem version.
* `--without`, `-W`:
Exclude gems that are part of the specified named group.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle.1.ronn 0000644 00000006453 15173517743 0017222 0 ustar 00 bundle(1) -- Ruby Dependency Management
=======================================
## SYNOPSIS
`bundle` COMMAND [--no-color] [--verbose] [ARGS]
## DESCRIPTION
Bundler manages an `application's dependencies` through its entire life
across many machines systematically and repeatably.
See [the bundler website](https://bundler.io) for information on getting
started, and Gemfile(5) for more information on the `Gemfile` format.
## OPTIONS
* `--no-color`:
Print all output without color
* `--retry`, `-r`:
Specify the number of times you wish to attempt network commands
* `--verbose`, `-V`:
Print out additional logging information
## BUNDLE COMMANDS
We divide `bundle` subcommands into primary commands and utilities:
## PRIMARY COMMANDS
* [`bundle install(1)`](bundle-install.1.html):
Install the gems specified by the `Gemfile` or `Gemfile.lock`
* [`bundle update(1)`](bundle-update.1.html):
Update dependencies to their latest versions
* [`bundle cache(1)`](bundle-cache.1.html):
Package the .gem files required by your application into the
`vendor/cache` directory (aliases: `bundle package`, `bundle pack`)
* [`bundle exec(1)`](bundle-exec.1.html):
Execute a script in the current bundle
* [`bundle config(1)`](bundle-config.1.html):
Specify and read configuration options for Bundler
* [`bundle help(1)`](bundle-help.1.html):
Display detailed help for each subcommand
## UTILITIES
* [`bundle add(1)`](bundle-add.1.html):
Add the named gem to the Gemfile and run `bundle install`
* [`bundle binstubs(1)`](bundle-binstubs.1.html):
Generate binstubs for executables in a gem
* [`bundle check(1)`](bundle-check.1.html):
Determine whether the requirements for your application are installed
and available to Bundler
* [`bundle show(1)`](bundle-show.1.html):
Show the source location of a particular gem in the bundle
* [`bundle outdated(1)`](bundle-outdated.1.html):
Show all of the outdated gems in the current bundle
* `bundle console(1)` (deprecated):
Start an IRB session in the current bundle
* [`bundle open(1)`](bundle-open.1.html):
Open an installed gem in the editor
* [`bundle lock(1)`](bundle-lock.1.html):
Generate a lockfile for your dependencies
* [`bundle viz(1)`](bundle-viz.1.html) (deprecated):
Generate a visual representation of your dependencies
* [`bundle init(1)`](bundle-init.1.html):
Generate a simple `Gemfile`, placed in the current directory
* [`bundle gem(1)`](bundle-gem.1.html):
Create a simple gem, suitable for development with Bundler
* [`bundle platform(1)`](bundle-platform.1.html):
Display platform compatibility information
* [`bundle clean(1)`](bundle-clean.1.html):
Clean up unused gems in your Bundler directory
* [`bundle doctor(1)`](bundle-doctor.1.html):
Display warnings about common problems
* [`bundle remove(1)`](bundle-remove.1.html):
Removes gems from the Gemfile
* [`bundle plugin(1)`](bundle-plugin.1.html):
Manage Bundler plugins
* [`bundle version(1)`](bundle-version.1.html):
Prints Bundler version information
## PLUGINS
When running a command that isn't listed in PRIMARY COMMANDS or UTILITIES,
Bundler will try to find an executable on your path named `bundler-<command>`
and execute it, passing down any extra arguments to it.
## OBSOLETE
These commands are obsolete and should no longer be used:
* `bundle inject(1)`
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-binstubs.1.ronn 0000644 00000002612 15173517743 0021042 0 ustar 00 bundle-binstubs(1) -- Install the binstubs of the listed gems
=============================================================
## SYNOPSIS
`bundle binstubs` <GEM_NAME> [--force] [--path PATH] [--standalone]
## DESCRIPTION
Binstubs are scripts that wrap around executables. Bundler creates a
small Ruby file (a binstub) that loads Bundler, runs the command,
and puts it into `bin/`. Binstubs are a shortcut-or alternative-
to always using `bundle exec`. This gives you a file that can be run
directly, and one that will always run the correct gem version
used by the application.
For example, if you run `bundle binstubs rspec-core`, Bundler will create
the file `bin/rspec`. That file will contain enough code to load Bundler,
tell it to load the bundled gems, and then run rspec.
This command generates binstubs for executables in `GEM_NAME`.
Binstubs are put into `bin`, or the `--path` directory if one has been set.
Calling binstubs with [GEM [GEM]] will create binstubs for all given gems.
## OPTIONS
* `--force`:
Overwrite existing binstubs if they exist.
* `--path`:
The location to install the specified binstubs to. This defaults to `bin`.
* `--standalone`:
Makes binstubs that can work without depending on Rubygems or Bundler at
runtime.
* `--shebang`:
Specify a different shebang executable name than the default (default 'ruby')
* `--all`:
Create binstubs for all gems in the bundle.
share/gems/gems/bundler-2.5.22/lib/bundler/man/gemfile.5.ronn 0000644 00000052637 15173517743 0017372 0 ustar 00 Gemfile(5) -- A format for describing gem dependencies for Ruby programs
========================================================================
## SYNOPSIS
A `Gemfile` describes the gem dependencies required to execute associated
Ruby code.
Place the `Gemfile` in the root of the directory containing the associated
code. For instance, in a Rails application, place the `Gemfile` in the same
directory as the `Rakefile`.
## SYNTAX
A `Gemfile` is evaluated as Ruby code, in a context which makes available
a number of methods used to describe the gem requirements.
## GLOBAL SOURCE
At the top of the `Gemfile`, add a single line for the `RubyGems` source that
contains the gems listed in the `Gemfile`.
source "https://rubygems.org"
You can add only one global source. In Bundler 1.13, adding multiple global
sources was deprecated. The `source` `MUST` be a valid RubyGems repository.
To use more than one source of RubyGems, you should use [`source` block
](#BLOCK-FORM-OF-SOURCE-GIT-PATH-GROUP-and-PLATFORMS).
A source is checked for gems following the heuristics described in
[SOURCE PRIORITY][].
**Note about a behavior of the feature deprecated in Bundler 1.13**:
If a gem is found in more than one global source, Bundler
will print a warning after installing the gem indicating which source was used,
and listing the other sources where the gem is available. A specific source can
be selected for gems that need to use a non-standard repository, suppressing
this warning, by using the [`:source` option](#SOURCE) or `source` block.
### CREDENTIALS
Some gem sources require a username and password. Use [bundle config(1)](bundle-config.1.html) to set
the username and password for any of the sources that need it. The command must
be run once on each computer that will install the Gemfile, but this keeps the
credentials from being stored in plain text in version control.
bundle config gems.example.com user:password
For some sources, like a company Gemfury account, it may be easier to
include the credentials in the Gemfile as part of the source URL.
source "https://user:password@gems.example.com"
Credentials in the source URL will take precedence over credentials set using
`config`.
## RUBY
If your application requires a specific Ruby version or engine, specify your
requirements using the `ruby` method, with the following arguments.
All parameters are `OPTIONAL` unless otherwise specified.
### VERSION (required)
The version of Ruby that your application requires. If your application
requires an alternate Ruby engine, such as JRuby, TruffleRuby, etc., this
should be the Ruby version that the engine is compatible with.
ruby "3.1.2"
If you wish to derive your Ruby version from a version file (ie .ruby-version),
you can use the `file` option instead.
ruby file: ".ruby-version"
The version file should conform to any of the following formats:
- `3.1.2` (.ruby-version)
- `ruby 3.1.2` (.tool-versions, read: https://asdf-vm.com/manage/configuration.html#tool-versions)
### ENGINE
Each application _may_ specify a Ruby engine. If an engine is specified, an
engine version _must_ also be specified.
What exactly is an Engine?
- A Ruby engine is an implementation of the Ruby language.
- For background: the reference or original implementation of the Ruby
programming language is called
[Matz's Ruby Interpreter](https://en.wikipedia.org/wiki/Ruby_MRI), or MRI
for short. This is named after Ruby creator Yukihiro Matsumoto,
also known as Matz. MRI is also known as CRuby, because it is written in C.
MRI is the most widely used Ruby engine.
- [Other implementations](https://www.ruby-lang.org/en/about/) of Ruby exist.
Some of the more well-known implementations include
[JRuby](https://www.jruby.org/) and [TruffleRuby](https://www.graalvm.org/ruby/).
Rubinius is an alternative implementation of Ruby written in Ruby.
JRuby is an implementation of Ruby on the JVM, short for Java Virtual Machine.
TruffleRuby is a Ruby implementation on the GraalVM, a language toolkit built on the JVM.
### ENGINE VERSION
Each application _may_ specify a Ruby engine version. If an engine version is
specified, an engine _must_ also be specified. If the engine is "ruby" the
engine version specified _must_ match the Ruby version.
ruby "2.6.8", engine: "jruby", engine_version: "9.3.8.0"
### PATCHLEVEL
Each application _may_ specify a Ruby patchlevel. Specifying the patchlevel has
been meaningless since Ruby 2.1.0 was released as the patchlevel is now
uniquely determined by a combination of major, minor, and teeny version numbers.
This option was implemented in Bundler 1.4.0 for Ruby 2.0 or earlier.
ruby "3.1.2", patchlevel: "20"
## GEMS
Specify gem requirements using the `gem` method, with the following arguments.
All parameters are `OPTIONAL` unless otherwise specified.
### NAME (required)
For each gem requirement, list a single _gem_ line.
gem "nokogiri"
### VERSION
Each _gem_ `MAY` have one or more version specifiers.
gem "nokogiri", ">= 1.4.2"
gem "RedCloth", ">= 4.1.0", "< 4.2.0"
### REQUIRE AS
Each _gem_ `MAY` specify files that should be used when autorequiring via
`Bundler.require`. You may pass an array with multiple files or `true` if the file
you want `required` has the same name as _gem_ or `false` to
prevent any file from being autorequired.
gem "redis", require: ["redis/connection/hiredis", "redis"]
gem "webmock", require: false
gem "byebug", require: true
The argument defaults to the name of the gem. For example, these are identical:
gem "nokogiri"
gem "nokogiri", require: "nokogiri"
gem "nokogiri", require: true
### GROUPS
Each _gem_ `MAY` specify membership in one or more groups. Any _gem_ that does
not specify membership in any group is placed in the `default` group.
gem "rspec", group: :test
gem "wirble", groups: [:development, :test]
The Bundler runtime allows its two main methods, `Bundler.setup` and
`Bundler.require`, to limit their impact to particular groups.
# setup adds gems to Ruby's load path
Bundler.setup # defaults to all groups
require "bundler/setup" # same as Bundler.setup
Bundler.setup(:default) # only set up the _default_ group
Bundler.setup(:test) # only set up the _test_ group (but `not` _default_)
Bundler.setup(:default, :test) # set up the _default_ and _test_ groups, but no others
# require requires all of the gems in the specified groups
Bundler.require # defaults to the _default_ group
Bundler.require(:default) # identical
Bundler.require(:default, :test) # requires the _default_ and _test_ groups
Bundler.require(:test) # requires the _test_ group
The Bundler CLI allows you to specify a list of groups whose gems `bundle install` should
not install with the `without` configuration.
To specify multiple groups to ignore, specify a list of groups separated by spaces.
bundle config set --local without test
bundle config set --local without development test
Also, calling `Bundler.setup` with no parameters, or calling `require "bundler/setup"`
will setup all groups except for the ones you excluded via `--without` (since they
are not available).
Note that on `bundle install`, bundler downloads and evaluates all gems, in order to
create a single canonical list of all of the required gems and their dependencies.
This means that you cannot list different versions of the same gems in different
groups. For more details, see [Understanding Bundler](https://bundler.io/rationale.html).
### PLATFORMS
If a gem should only be used in a particular platform or set of platforms, you can
specify them. Platforms are essentially identical to groups, except that you do not
need to use the `--without` install-time flag to exclude groups of gems for other
platforms.
There are a number of `Gemfile` platforms:
* `ruby`:
C Ruby (MRI), Rubinius, or TruffleRuby, but not Windows
* `mri`:
C Ruby (MRI) only, but not Windows
* `windows`:
Windows C Ruby (MRI), including RubyInstaller 32-bit and 64-bit versions
* `mswin`:
Windows C Ruby (MRI), including RubyInstaller 32-bit versions
* `mswin64`:
Windows C Ruby (MRI), including RubyInstaller 64-bit versions
* `rbx`:
Rubinius
* `jruby`:
JRuby
* `truffleruby`:
TruffleRuby
On platforms `ruby`, `mri`, `mswin`, `mswin64`, and `windows`, you may
additionally specify a version by appending the major and minor version numbers
without a delimiter. For example, to specify that a gem should only be used on
platform `ruby` version 3.1, use:
ruby_31
As with groups (above), you may specify one or more platforms:
gem "weakling", platforms: :jruby
gem "ruby-debug", platforms: :mri_31
gem "nokogiri", platforms: [:windows_31, :jruby]
All operations involving groups ([`bundle install`](bundle-install.1.html), `Bundler.setup`,
`Bundler.require`) behave exactly the same as if any groups not
matching the current platform were explicitly excluded.
The following platform values are deprecated and should be replaced with `windows`:
* `mswin`, `mswin64`, `mingw32`, `x64_mingw`
Note that, while unfortunately using the same terminology, the values of this
option are different from the values that `bundle lock --add-platform` can take.
The values of this option are more closer to "Ruby Implementation" while the
values that `bundle lock --add-platform` understands are more related to OS and
architecture of the different systems where your lockfile will be used.
### FORCE_RUBY_PLATFORM
If you always want the pure ruby variant of a gem to be chosen over platform
specific variants, you can use the `force_ruby_platform` option:
gem "ffi", force_ruby_platform: true
This can be handy (assuming the pure ruby variant works fine) when:
* You're having issues with the platform specific variant.
* The platform specific variant does not yet support a newer ruby (and thus has
a `required_ruby_version` upper bound), but you still want your Gemfile{.lock}
files to resolve under that ruby.
### SOURCE
You can select an alternate RubyGems repository for a gem using the ':source'
option.
gem "some_internal_gem", source: "https://gems.example.com"
This forces the gem to be loaded from this source and ignores the global source
declared at the top level of the file. If the gem does not exist in this source,
it will not be installed.
Bundler will search for child dependencies of this gem by first looking in the
source selected for the parent, but if they are not found there, it will fall
back on the global source.
**Note about a behavior of the feature deprecated in Bundler 1.13**:
Selecting a specific source repository this way also suppresses the ambiguous
gem warning described above in [GLOBAL SOURCE](#GLOBAL-SOURCE).
Using the `:source` option for an individual gem will also make that source
available as a possible global source for any other gems which do not specify
explicit sources. Thus, when adding gems with explicit sources, it is
recommended that you also ensure all other gems in the Gemfile are using
explicit sources.
### GIT
If necessary, you can specify that a gem is located at a particular
git repository using the `:git` parameter. The repository can be accessed via
several protocols:
* `HTTP(S)`:
gem "rails", git: "https://github.com/rails/rails.git"
* `SSH`:
gem "rails", git: "git@github.com:rails/rails.git"
* `git`:
gem "rails", git: "git://github.com/rails/rails.git"
If using SSH, the user that you use to run `bundle install` `MUST` have the
appropriate keys available in their `$HOME/.ssh`.
`NOTE`: `http://` and `git://` URLs should be avoided if at all possible. These
protocols are unauthenticated, so a man-in-the-middle attacker can deliver
malicious code and compromise your system. HTTPS and SSH are strongly
preferred.
The `group`, `platforms`, and `require` options are available and behave
exactly the same as they would for a normal gem.
A git repository `SHOULD` have at least one file, at the root of the
directory containing the gem, with the extension `.gemspec`. This file
`MUST` contain a valid gem specification, as expected by the `gem build`
command.
If a git repository does not have a `.gemspec`, bundler will attempt to
create one, but it will not contain any dependencies, executables, or
C extension compilation instructions. As a result, it may fail to properly
integrate into your application.
If a git repository does have a `.gemspec` for the gem you attached it
to, a version specifier, if provided, means that the git repository is
only valid if the `.gemspec` specifies a version matching the version
specifier. If not, bundler will print a warning.
gem "rails", "2.3.8", git: "https://github.com/rails/rails.git"
# bundle install will fail, because the .gemspec in the rails
# repository's master branch specifies version 3.0.0
If a git repository does `not` have a `.gemspec` for the gem you attached
it to, a version specifier `MUST` be provided. Bundler will use this
version in the simple `.gemspec` it creates.
Git repositories support a number of additional options.
* `branch`, `tag`, and `ref`:
You `MUST` only specify at most one of these options. The default
is `branch: "master"`. For example:
gem "rails", git: "https://github.com/rails/rails.git", branch: "5-0-stable"
gem "rails", git: "https://github.com/rails/rails.git", tag: "v5.0.0"
gem "rails", git: "https://github.com/rails/rails.git", ref: "4aded"
* `submodules`:
For reference, a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
lets you have another git repository within a subfolder of your repository.
Specify `submodules: true` to cause bundler to expand any
submodules included in the git repository
If a git repository contains multiple `.gemspecs`, each `.gemspec`
represents a gem located at the same place in the file system as
the `.gemspec`.
|~rails [git root]
| |-rails.gemspec [rails gem located here]
|~actionpack
| |-actionpack.gemspec [actionpack gem located here]
|~activesupport
| |-activesupport.gemspec [activesupport gem located here]
|...
To install a gem located in a git repository, bundler changes to
the directory containing the gemspec, runs `gem build name.gemspec`
and then installs the resulting gem. The `gem build` command,
which comes standard with Rubygems, evaluates the `.gemspec` in
the context of the directory in which it is located.
### GIT SOURCE
A custom git source can be defined via the `git_source` method. Provide the source's name
as an argument, and a block which receives a single argument and interpolates it into a
string to return the full repo address:
git_source(:stash){ |repo_name| "https://stash.corp.acme.pl/#{repo_name}.git" }
gem 'rails', stash: 'forks/rails'
In addition, if you wish to choose a specific branch:
gem "rails", stash: "forks/rails", branch: "branch_name"
### GITHUB
`NOTE`: This shorthand should be avoided until Bundler 2.0, since it
currently expands to an insecure `git://` URL. This allows a
man-in-the-middle attacker to compromise your system.
If the git repository you want to use is hosted on GitHub and is public, you can use the
:github shorthand to specify the github username and repository name (without the
trailing ".git"), separated by a slash. If both the username and repository name are the
same, you can omit one.
gem "rails", github: "rails/rails"
gem "rails", github: "rails"
Are both equivalent to
gem "rails", git: "https://github.com/rails/rails.git"
Since the `github` method is a specialization of `git_source`, it accepts a `:branch` named argument.
You can also directly pass a pull request URL:
gem "rails", github: "https://github.com/rails/rails/pull/43753"
Which is equivalent to:
gem "rails", github: "rails/rails", branch: "refs/pull/43753/head"
### GIST
If the git repository you want to use is hosted as a GitHub Gist and is public, you can use
the :gist shorthand to specify the gist identifier (without the trailing ".git").
gem "the_hatch", gist: "4815162342"
Is equivalent to:
gem "the_hatch", git: "https://gist.github.com/4815162342.git"
Since the `gist` method is a specialization of `git_source`, it accepts a `:branch` named argument.
### BITBUCKET
If the git repository you want to use is hosted on Bitbucket and is public, you can use the
:bitbucket shorthand to specify the bitbucket username and repository name (without the
trailing ".git"), separated by a slash. If both the username and repository name are the
same, you can omit one.
gem "rails", bitbucket: "rails/rails"
gem "rails", bitbucket: "rails"
Are both equivalent to
gem "rails", git: "https://rails@bitbucket.org/rails/rails.git"
Since the `bitbucket` method is a specialization of `git_source`, it accepts a `:branch` named argument.
### PATH
You can specify that a gem is located in a particular location
on the file system. Relative paths are resolved relative to the
directory containing the `Gemfile`.
Similar to the semantics of the `:git` option, the `:path`
option requires that the directory in question either contains
a `.gemspec` for the gem, or that you specify an explicit
version that bundler should use.
Unlike `:git`, bundler does not compile C extensions for
gems specified as paths.
gem "rails", path: "vendor/rails"
If you would like to use multiple local gems directly from the filesystem, you can set a global `path` option to the path containing the gem's files. This will automatically load gemspec files from subdirectories.
path 'components' do
gem 'admin_ui'
gem 'public_ui'
end
## BLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS
The `:source`, `:git`, `:path`, `:group`, and `:platforms` options may be
applied to a group of gems by using block form.
source "https://gems.example.com" do
gem "some_internal_gem"
gem "another_internal_gem"
end
git "https://github.com/rails/rails.git" do
gem "activesupport"
gem "actionpack"
end
platforms :ruby do
gem "ruby-debug"
gem "sqlite3"
end
group :development, optional: true do
gem "wirble"
gem "faker"
end
In the case of the group block form the :optional option can be given
to prevent a group from being installed unless listed in the `--with`
option given to the `bundle install` command.
In the case of the `git` block form, the `:ref`, `:branch`, `:tag`,
and `:submodules` options may be passed to the `git` method, and
all gems in the block will inherit those options.
The presence of a `source` block in a Gemfile also makes that source
available as a possible global source for any other gems which do not specify
explicit sources. Thus, when defining source blocks, it is
recommended that you also ensure all other gems in the Gemfile are using
explicit sources, either via source blocks or `:source` directives on
individual gems.
## INSTALL_IF
The `install_if` method allows gems to be installed based on a proc or lambda.
This is especially useful for optional gems that can only be used if certain
software is installed or some other conditions are met.
install_if -> { RUBY_PLATFORM =~ /darwin/ } do
gem "pasteboard"
end
## GEMSPEC
The [`.gemspec`](https://guides.rubygems.org/specification-reference/) file is where
you provide metadata about your gem to Rubygems. Some required Gemspec
attributes include the name, description, and homepage of your gem. This is
also where you specify the dependencies your gem needs to run.
If you wish to use Bundler to help install dependencies for a gem while it is
being developed, use the `gemspec` method to pull in the dependencies listed in
the `.gemspec` file.
The `gemspec` method adds any runtime dependencies as gem requirements in the
default group. It also adds development dependencies as gem requirements in the
`development` group. Finally, it adds a gem requirement on your project (`path:
'.'`). In conjunction with `Bundler.setup`, this allows you to require project
files in your test code as you would if the project were installed as a gem; you
need not manipulate the load path manually or require project files via relative
paths.
The `gemspec` method supports optional `:path`, `:glob`, `:name`, and `:development_group`
options, which control where bundler looks for the `.gemspec`, the glob it uses to look
for the gemspec (defaults to: `{,*,*/*}.gemspec`), what named `.gemspec` it uses
(if more than one is present), and which group development dependencies are included in.
When a `gemspec` dependency encounters version conflicts during resolution, the
local version under development will always be selected -- even if there are
remote versions that better match other requirements for the `gemspec` gem.
## SOURCE PRIORITY
When attempting to locate a gem to satisfy a gem requirement,
bundler uses the following priority order:
1. The source explicitly attached to the gem (using `:source`, `:path`, or
`:git`)
2. For implicit gems (dependencies of explicit gems), any source, git, or path
repository declared on the parent. This results in bundler prioritizing the
ActiveSupport gem from the Rails git repository over ones from
`rubygems.org`
3. If neither of the above conditions are met, the global source will be used.
If multiple global sources are specified, they will be prioritized from
last to first, but this is deprecated since Bundler 1.13, so Bundler prints
a warning and will abort with an error in the future.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-add.1.ronn 0000644 00000004301 15173517743 0017736 0 ustar 00 bundle-add(1) -- Add gem to the Gemfile and run bundle install
==============================================================
## SYNOPSIS
`bundle add` <GEM_NAME> [--group=GROUP] [--version=VERSION] [--source=SOURCE]
[--path=PATH] [--git=GIT|--github=GITHUB] [--branch=BRANCH] [--ref=REF]
[--skip-install] [--strict|--optimistic]
## DESCRIPTION
Adds the named gem to the [`Gemfile(5)`][Gemfile(5)] and run `bundle install`.
`bundle install` can be avoided by using the flag `--skip-install`.
## OPTIONS
* `--version`, `-v`:
Specify version requirements(s) for the added gem.
* `--group`, `-g`:
Specify the group(s) for the added gem. Multiple groups should be separated by commas.
* `--source`, `-s`:
Specify the source for the added gem.
* `--require`, `-r`:
Adds require path to gem. Provide false, or a path as a string.
* `--path`:
Specify the file system path for the added gem.
* `--git`:
Specify the git source for the added gem.
* `--github`:
Specify the github source for the added gem.
* `--branch`:
Specify the git branch for the added gem.
* `--ref`:
Specify the git ref for the added gem.
* `--skip-install`:
Adds the gem to the Gemfile but does not install it.
* `--optimistic`:
Adds optimistic declaration of version.
* `--strict`:
Adds strict declaration of version.
## EXAMPLES
1. You can add the `rails` gem to the Gemfile without any version restriction.
The source of the gem will be the global source.
`bundle add rails`
2. You can add the `rails` gem with version greater than 1.1 (not including 1.1) and less than 3.0.
`bundle add rails --version "> 1.1, < 3.0"`
3. You can use the `https://gems.example.com` custom source and assign the gem
to a group.
`bundle add rails --version "~> 5.0.0" --source "https://gems.example.com" --group "development"`
4. The following adds the `gem` entry to the Gemfile without installing the
gem. You can install gems later via `bundle install`.
`bundle add rails --skip-install`
5. You can assign the gem to more than one group.
`bundle add rails --group "development, test"`
## SEE ALSO
[Gemfile(5)](https://bundler.io/man/gemfile.5.html),
[bundle-remove(1)](bundle-remove.1.html)
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-info.1 0000644 00000000726 15173517743 0017175 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INFO" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-info\fR \- Show information for the given gem in your bundle
.SH "SYNOPSIS"
\fBbundle info\fR [GEM_NAME] [\-\-path]
.SH "DESCRIPTION"
Given a gem name present in your bundle, print the basic information about it such as homepage, version, path and summary\.
.SH "OPTIONS"
.TP
\fB\-\-path\fR
Print the path of the given gem
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-open.1 0000644 00000001426 15173517743 0017201 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-OPEN" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-open\fR \- Opens the source directory for a gem in your bundle
.SH "SYNOPSIS"
\fBbundle open\fR [GEM] [\-\-path=PATH]
.SH "DESCRIPTION"
Opens the source directory of the provided GEM in your editor\.
.P
For this to work the \fBEDITOR\fR or \fBBUNDLER_EDITOR\fR environment variable has to be set\.
.P
Example:
.IP "" 4
.nf
bundle open 'rack'
.fi
.IP "" 0
.P
Will open the source directory for the 'rack' gem in your bundle\.
.IP "" 4
.nf
bundle open 'rack' \-\-path 'README\.md'
.fi
.IP "" 0
.P
Will open the README\.md file of the 'rack' gem source in your bundle\.
.SH "OPTIONS"
.TP
\fB\-\-path\fR
Specify GEM source relative path to open\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-inject.1 0000644 00000001457 15173517743 0017520 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INJECT" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-inject\fR \- Add named gem(s) with version requirements to Gemfile
.SH "SYNOPSIS"
\fBbundle inject\fR [GEM] [VERSION]
.SH "DESCRIPTION"
Adds the named gem(s) with their version requirements to the resolved [\fBGemfile(5)\fR][Gemfile(5)]\.
.P
This command will add the gem to both your [\fBGemfile(5)\fR][Gemfile(5)] and Gemfile\.lock if it isn't listed yet\.
.P
Example:
.IP "" 4
.nf
bundle install
bundle inject 'rack' '> 0'
.fi
.IP "" 0
.P
This will inject the 'rack' gem with a version greater than 0 in your [\fBGemfile(5)\fR][Gemfile(5)] and Gemfile\.lock\.
.P
The \fBbundle inject\fR command was deprecated in Bundler 2\.1 and will be removed in Bundler 3\.0\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/gemfile.5 0000644 00000056000 15173517743 0016403 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "GEMFILE" "5" "September 2024" ""
.SH "NAME"
\fBGemfile\fR \- A format for describing gem dependencies for Ruby programs
.SH "SYNOPSIS"
A \fBGemfile\fR describes the gem dependencies required to execute associated Ruby code\.
.P
Place the \fBGemfile\fR in the root of the directory containing the associated code\. For instance, in a Rails application, place the \fBGemfile\fR in the same directory as the \fBRakefile\fR\.
.SH "SYNTAX"
A \fBGemfile\fR is evaluated as Ruby code, in a context which makes available a number of methods used to describe the gem requirements\.
.SH "GLOBAL SOURCE"
At the top of the \fBGemfile\fR, add a single line for the \fBRubyGems\fR source that contains the gems listed in the \fBGemfile\fR\.
.IP "" 4
.nf
source "https://rubygems\.org"
.fi
.IP "" 0
.P
You can add only one global source\. In Bundler 1\.13, adding multiple global sources was deprecated\. The \fBsource\fR \fBMUST\fR be a valid RubyGems repository\.
.P
To use more than one source of RubyGems, you should use \fI\fBsource\fR block\fR\.
.P
A source is checked for gems following the heuristics described in \fISOURCE PRIORITY\fR\.
.P
\fBNote about a behavior of the feature deprecated in Bundler 1\.13\fR: If a gem is found in more than one global source, Bundler will print a warning after installing the gem indicating which source was used, and listing the other sources where the gem is available\. A specific source can be selected for gems that need to use a non\-standard repository, suppressing this warning, by using the \fI\fB:source\fR option\fR or \fBsource\fR block\.
.SS "CREDENTIALS"
Some gem sources require a username and password\. Use bundle config(1) \fIbundle\-config\.1\.html\fR to set the username and password for any of the sources that need it\. The command must be run once on each computer that will install the Gemfile, but this keeps the credentials from being stored in plain text in version control\.
.IP "" 4
.nf
bundle config gems\.example\.com user:password
.fi
.IP "" 0
.P
For some sources, like a company Gemfury account, it may be easier to include the credentials in the Gemfile as part of the source URL\.
.IP "" 4
.nf
source "https://user:password@gems\.example\.com"
.fi
.IP "" 0
.P
Credentials in the source URL will take precedence over credentials set using \fBconfig\fR\.
.SH "RUBY"
If your application requires a specific Ruby version or engine, specify your requirements using the \fBruby\fR method, with the following arguments\. All parameters are \fBOPTIONAL\fR unless otherwise specified\.
.SS "VERSION (required)"
The version of Ruby that your application requires\. If your application requires an alternate Ruby engine, such as JRuby, TruffleRuby, etc\., this should be the Ruby version that the engine is compatible with\.
.IP "" 4
.nf
ruby "3\.1\.2"
.fi
.IP "" 0
.P
If you wish to derive your Ruby version from a version file (ie \.ruby\-version), you can use the \fBfile\fR option instead\.
.IP "" 4
.nf
ruby file: "\.ruby\-version"
.fi
.IP "" 0
.P
The version file should conform to any of the following formats:
.IP "\(bu" 4
\fB3\.1\.2\fR (\.ruby\-version)
.IP "\(bu" 4
\fBruby 3\.1\.2\fR (\.tool\-versions, read: https://asdf\-vm\.com/manage/configuration\.html#tool\-versions)
.IP "" 0
.SS "ENGINE"
Each application \fImay\fR specify a Ruby engine\. If an engine is specified, an engine version \fImust\fR also be specified\.
.P
What exactly is an Engine?
.IP "\(bu" 4
A Ruby engine is an implementation of the Ruby language\.
.IP "\(bu" 4
For background: the reference or original implementation of the Ruby programming language is called Matz's Ruby Interpreter \fIhttps://en\.wikipedia\.org/wiki/Ruby_MRI\fR, or MRI for short\. This is named after Ruby creator Yukihiro Matsumoto, also known as Matz\. MRI is also known as CRuby, because it is written in C\. MRI is the most widely used Ruby engine\.
.IP "\(bu" 4
Other implementations \fIhttps://www\.ruby\-lang\.org/en/about/\fR of Ruby exist\. Some of the more well\-known implementations include JRuby \fIhttps://www\.jruby\.org/\fR and TruffleRuby \fIhttps://www\.graalvm\.org/ruby/\fR\. Rubinius is an alternative implementation of Ruby written in Ruby\. JRuby is an implementation of Ruby on the JVM, short for Java Virtual Machine\. TruffleRuby is a Ruby implementation on the GraalVM, a language toolkit built on the JVM\.
.IP "" 0
.SS "ENGINE VERSION"
Each application \fImay\fR specify a Ruby engine version\. If an engine version is specified, an engine \fImust\fR also be specified\. If the engine is "ruby" the engine version specified \fImust\fR match the Ruby version\.
.IP "" 4
.nf
ruby "2\.6\.8", engine: "jruby", engine_version: "9\.3\.8\.0"
.fi
.IP "" 0
.SS "PATCHLEVEL"
Each application \fImay\fR specify a Ruby patchlevel\. Specifying the patchlevel has been meaningless since Ruby 2\.1\.0 was released as the patchlevel is now uniquely determined by a combination of major, minor, and teeny version numbers\.
.P
This option was implemented in Bundler 1\.4\.0 for Ruby 2\.0 or earlier\.
.IP "" 4
.nf
ruby "3\.1\.2", patchlevel: "20"
.fi
.IP "" 0
.SH "GEMS"
Specify gem requirements using the \fBgem\fR method, with the following arguments\. All parameters are \fBOPTIONAL\fR unless otherwise specified\.
.SS "NAME (required)"
For each gem requirement, list a single \fIgem\fR line\.
.IP "" 4
.nf
gem "nokogiri"
.fi
.IP "" 0
.SS "VERSION"
Each \fIgem\fR \fBMAY\fR have one or more version specifiers\.
.IP "" 4
.nf
gem "nokogiri", ">= 1\.4\.2"
gem "RedCloth", ">= 4\.1\.0", "< 4\.2\.0"
.fi
.IP "" 0
.SS "REQUIRE AS"
Each \fIgem\fR \fBMAY\fR specify files that should be used when autorequiring via \fBBundler\.require\fR\. You may pass an array with multiple files or \fBtrue\fR if the file you want \fBrequired\fR has the same name as \fIgem\fR or \fBfalse\fR to prevent any file from being autorequired\.
.IP "" 4
.nf
gem "redis", require: ["redis/connection/hiredis", "redis"]
gem "webmock", require: false
gem "byebug", require: true
.fi
.IP "" 0
.P
The argument defaults to the name of the gem\. For example, these are identical:
.IP "" 4
.nf
gem "nokogiri"
gem "nokogiri", require: "nokogiri"
gem "nokogiri", require: true
.fi
.IP "" 0
.SS "GROUPS"
Each \fIgem\fR \fBMAY\fR specify membership in one or more groups\. Any \fIgem\fR that does not specify membership in any group is placed in the \fBdefault\fR group\.
.IP "" 4
.nf
gem "rspec", group: :test
gem "wirble", groups: [:development, :test]
.fi
.IP "" 0
.P
The Bundler runtime allows its two main methods, \fBBundler\.setup\fR and \fBBundler\.require\fR, to limit their impact to particular groups\.
.IP "" 4
.nf
# setup adds gems to Ruby's load path
Bundler\.setup # defaults to all groups
require "bundler/setup" # same as Bundler\.setup
Bundler\.setup(:default) # only set up the _default_ group
Bundler\.setup(:test) # only set up the _test_ group (but `not` _default_)
Bundler\.setup(:default, :test) # set up the _default_ and _test_ groups, but no others
# require requires all of the gems in the specified groups
Bundler\.require # defaults to the _default_ group
Bundler\.require(:default) # identical
Bundler\.require(:default, :test) # requires the _default_ and _test_ groups
Bundler\.require(:test) # requires the _test_ group
.fi
.IP "" 0
.P
The Bundler CLI allows you to specify a list of groups whose gems \fBbundle install\fR should not install with the \fBwithout\fR configuration\.
.P
To specify multiple groups to ignore, specify a list of groups separated by spaces\.
.IP "" 4
.nf
bundle config set \-\-local without test
bundle config set \-\-local without development test
.fi
.IP "" 0
.P
Also, calling \fBBundler\.setup\fR with no parameters, or calling \fBrequire "bundler/setup"\fR will setup all groups except for the ones you excluded via \fB\-\-without\fR (since they are not available)\.
.P
Note that on \fBbundle install\fR, bundler downloads and evaluates all gems, in order to create a single canonical list of all of the required gems and their dependencies\. This means that you cannot list different versions of the same gems in different groups\. For more details, see Understanding Bundler \fIhttps://bundler\.io/rationale\.html\fR\.
.SS "PLATFORMS"
If a gem should only be used in a particular platform or set of platforms, you can specify them\. Platforms are essentially identical to groups, except that you do not need to use the \fB\-\-without\fR install\-time flag to exclude groups of gems for other platforms\.
.P
There are a number of \fBGemfile\fR platforms:
.TP
\fBruby\fR
C Ruby (MRI), Rubinius, or TruffleRuby, but not Windows
.TP
\fBmri\fR
C Ruby (MRI) only, but not Windows
.TP
\fBwindows\fR
Windows C Ruby (MRI), including RubyInstaller 32\-bit and 64\-bit versions
.TP
\fBmswin\fR
Windows C Ruby (MRI), including RubyInstaller 32\-bit versions
.TP
\fBmswin64\fR
Windows C Ruby (MRI), including RubyInstaller 64\-bit versions
.TP
\fBrbx\fR
Rubinius
.TP
\fBjruby\fR
JRuby
.TP
\fBtruffleruby\fR
TruffleRuby
.P
On platforms \fBruby\fR, \fBmri\fR, \fBmswin\fR, \fBmswin64\fR, and \fBwindows\fR, you may additionally specify a version by appending the major and minor version numbers without a delimiter\. For example, to specify that a gem should only be used on platform \fBruby\fR version 3\.1, use:
.IP "" 4
.nf
ruby_31
.fi
.IP "" 0
.P
As with groups (above), you may specify one or more platforms:
.IP "" 4
.nf
gem "weakling", platforms: :jruby
gem "ruby\-debug", platforms: :mri_31
gem "nokogiri", platforms: [:windows_31, :jruby]
.fi
.IP "" 0
.P
All operations involving groups (\fBbundle install\fR \fIbundle\-install\.1\.html\fR, \fBBundler\.setup\fR, \fBBundler\.require\fR) behave exactly the same as if any groups not matching the current platform were explicitly excluded\.
.P
The following platform values are deprecated and should be replaced with \fBwindows\fR:
.IP "\(bu" 4
\fBmswin\fR, \fBmswin64\fR, \fBmingw32\fR, \fBx64_mingw\fR
.IP "" 0
.P
Note that, while unfortunately using the same terminology, the values of this option are different from the values that \fBbundle lock \-\-add\-platform\fR can take\. The values of this option are more closer to "Ruby Implementation" while the values that \fBbundle lock \-\-add\-platform\fR understands are more related to OS and architecture of the different systems where your lockfile will be used\.
.SS "FORCE_RUBY_PLATFORM"
If you always want the pure ruby variant of a gem to be chosen over platform specific variants, you can use the \fBforce_ruby_platform\fR option:
.IP "" 4
.nf
gem "ffi", force_ruby_platform: true
.fi
.IP "" 0
.P
This can be handy (assuming the pure ruby variant works fine) when:
.IP "\(bu" 4
You're having issues with the platform specific variant\.
.IP "\(bu" 4
The platform specific variant does not yet support a newer ruby (and thus has a \fBrequired_ruby_version\fR upper bound), but you still want your Gemfile{\.lock} files to resolve under that ruby\.
.IP "" 0
.SS "SOURCE"
You can select an alternate RubyGems repository for a gem using the ':source' option\.
.IP "" 4
.nf
gem "some_internal_gem", source: "https://gems\.example\.com"
.fi
.IP "" 0
.P
This forces the gem to be loaded from this source and ignores the global source declared at the top level of the file\. If the gem does not exist in this source, it will not be installed\.
.P
Bundler will search for child dependencies of this gem by first looking in the source selected for the parent, but if they are not found there, it will fall back on the global source\.
.P
\fBNote about a behavior of the feature deprecated in Bundler 1\.13\fR: Selecting a specific source repository this way also suppresses the ambiguous gem warning described above in \fIGLOBAL SOURCE\fR\.
.P
Using the \fB:source\fR option for an individual gem will also make that source available as a possible global source for any other gems which do not specify explicit sources\. Thus, when adding gems with explicit sources, it is recommended that you also ensure all other gems in the Gemfile are using explicit sources\.
.SS "GIT"
If necessary, you can specify that a gem is located at a particular git repository using the \fB:git\fR parameter\. The repository can be accessed via several protocols:
.TP
\fBHTTP(S)\fR
gem "rails", git: "https://github\.com/rails/rails\.git"
.TP
\fBSSH\fR
gem "rails", git: "git@github\.com:rails/rails\.git"
.TP
\fBgit\fR
gem "rails", git: "git://github\.com/rails/rails\.git"
.P
If using SSH, the user that you use to run \fBbundle install\fR \fBMUST\fR have the appropriate keys available in their \fB$HOME/\.ssh\fR\.
.P
\fBNOTE\fR: \fBhttp://\fR and \fBgit://\fR URLs should be avoided if at all possible\. These protocols are unauthenticated, so a man\-in\-the\-middle attacker can deliver malicious code and compromise your system\. HTTPS and SSH are strongly preferred\.
.P
The \fBgroup\fR, \fBplatforms\fR, and \fBrequire\fR options are available and behave exactly the same as they would for a normal gem\.
.P
A git repository \fBSHOULD\fR have at least one file, at the root of the directory containing the gem, with the extension \fB\.gemspec\fR\. This file \fBMUST\fR contain a valid gem specification, as expected by the \fBgem build\fR command\.
.P
If a git repository does not have a \fB\.gemspec\fR, bundler will attempt to create one, but it will not contain any dependencies, executables, or C extension compilation instructions\. As a result, it may fail to properly integrate into your application\.
.P
If a git repository does have a \fB\.gemspec\fR for the gem you attached it to, a version specifier, if provided, means that the git repository is only valid if the \fB\.gemspec\fR specifies a version matching the version specifier\. If not, bundler will print a warning\.
.IP "" 4
.nf
gem "rails", "2\.3\.8", git: "https://github\.com/rails/rails\.git"
# bundle install will fail, because the \.gemspec in the rails
# repository's master branch specifies version 3\.0\.0
.fi
.IP "" 0
.P
If a git repository does \fBnot\fR have a \fB\.gemspec\fR for the gem you attached it to, a version specifier \fBMUST\fR be provided\. Bundler will use this version in the simple \fB\.gemspec\fR it creates\.
.P
Git repositories support a number of additional options\.
.TP
\fBbranch\fR, \fBtag\fR, and \fBref\fR
You \fBMUST\fR only specify at most one of these options\. The default is \fBbranch: "master"\fR\. For example:
.IP
gem "rails", git: "https://github\.com/rails/rails\.git", branch: "5\-0\-stable"
.IP
gem "rails", git: "https://github\.com/rails/rails\.git", tag: "v5\.0\.0"
.IP
gem "rails", git: "https://github\.com/rails/rails\.git", ref: "4aded"
.TP
\fBsubmodules\fR
For reference, a git submodule \fIhttps://git\-scm\.com/book/en/v2/Git\-Tools\-Submodules\fR lets you have another git repository within a subfolder of your repository\. Specify \fBsubmodules: true\fR to cause bundler to expand any submodules included in the git repository
.P
If a git repository contains multiple \fB\.gemspecs\fR, each \fB\.gemspec\fR represents a gem located at the same place in the file system as the \fB\.gemspec\fR\.
.IP "" 4
.nf
|~rails [git root]
| |\-rails\.gemspec [rails gem located here]
|~actionpack
| |\-actionpack\.gemspec [actionpack gem located here]
|~activesupport
| |\-activesupport\.gemspec [activesupport gem located here]
|\|\.\|\.\|\.
.fi
.IP "" 0
.P
To install a gem located in a git repository, bundler changes to the directory containing the gemspec, runs \fBgem build name\.gemspec\fR and then installs the resulting gem\. The \fBgem build\fR command, which comes standard with Rubygems, evaluates the \fB\.gemspec\fR in the context of the directory in which it is located\.
.SS "GIT SOURCE"
A custom git source can be defined via the \fBgit_source\fR method\. Provide the source's name as an argument, and a block which receives a single argument and interpolates it into a string to return the full repo address:
.IP "" 4
.nf
git_source(:stash){ |repo_name| "https://stash\.corp\.acme\.pl/#{repo_name}\.git" }
gem 'rails', stash: 'forks/rails'
.fi
.IP "" 0
.P
In addition, if you wish to choose a specific branch:
.IP "" 4
.nf
gem "rails", stash: "forks/rails", branch: "branch_name"
.fi
.IP "" 0
.SS "GITHUB"
\fBNOTE\fR: This shorthand should be avoided until Bundler 2\.0, since it currently expands to an insecure \fBgit://\fR URL\. This allows a man\-in\-the\-middle attacker to compromise your system\.
.P
If the git repository you want to use is hosted on GitHub and is public, you can use the :github shorthand to specify the github username and repository name (without the trailing "\.git"), separated by a slash\. If both the username and repository name are the same, you can omit one\.
.IP "" 4
.nf
gem "rails", github: "rails/rails"
gem "rails", github: "rails"
.fi
.IP "" 0
.P
Are both equivalent to
.IP "" 4
.nf
gem "rails", git: "https://github\.com/rails/rails\.git"
.fi
.IP "" 0
.P
Since the \fBgithub\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\.
.P
You can also directly pass a pull request URL:
.IP "" 4
.nf
gem "rails", github: "https://github\.com/rails/rails/pull/43753"
.fi
.IP "" 0
.P
Which is equivalent to:
.IP "" 4
.nf
gem "rails", github: "rails/rails", branch: "refs/pull/43753/head"
.fi
.IP "" 0
.SS "GIST"
If the git repository you want to use is hosted as a GitHub Gist and is public, you can use the :gist shorthand to specify the gist identifier (without the trailing "\.git")\.
.IP "" 4
.nf
gem "the_hatch", gist: "4815162342"
.fi
.IP "" 0
.P
Is equivalent to:
.IP "" 4
.nf
gem "the_hatch", git: "https://gist\.github\.com/4815162342\.git"
.fi
.IP "" 0
.P
Since the \fBgist\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\.
.SS "BITBUCKET"
If the git repository you want to use is hosted on Bitbucket and is public, you can use the :bitbucket shorthand to specify the bitbucket username and repository name (without the trailing "\.git"), separated by a slash\. If both the username and repository name are the same, you can omit one\.
.IP "" 4
.nf
gem "rails", bitbucket: "rails/rails"
gem "rails", bitbucket: "rails"
.fi
.IP "" 0
.P
Are both equivalent to
.IP "" 4
.nf
gem "rails", git: "https://rails@bitbucket\.org/rails/rails\.git"
.fi
.IP "" 0
.P
Since the \fBbitbucket\fR method is a specialization of \fBgit_source\fR, it accepts a \fB:branch\fR named argument\.
.SS "PATH"
You can specify that a gem is located in a particular location on the file system\. Relative paths are resolved relative to the directory containing the \fBGemfile\fR\.
.P
Similar to the semantics of the \fB:git\fR option, the \fB:path\fR option requires that the directory in question either contains a \fB\.gemspec\fR for the gem, or that you specify an explicit version that bundler should use\.
.P
Unlike \fB:git\fR, bundler does not compile C extensions for gems specified as paths\.
.IP "" 4
.nf
gem "rails", path: "vendor/rails"
.fi
.IP "" 0
.P
If you would like to use multiple local gems directly from the filesystem, you can set a global \fBpath\fR option to the path containing the gem's files\. This will automatically load gemspec files from subdirectories\.
.IP "" 4
.nf
path 'components' do
gem 'admin_ui'
gem 'public_ui'
end
.fi
.IP "" 0
.SH "BLOCK FORM OF SOURCE, GIT, PATH, GROUP and PLATFORMS"
The \fB:source\fR, \fB:git\fR, \fB:path\fR, \fB:group\fR, and \fB:platforms\fR options may be applied to a group of gems by using block form\.
.IP "" 4
.nf
source "https://gems\.example\.com" do
gem "some_internal_gem"
gem "another_internal_gem"
end
git "https://github\.com/rails/rails\.git" do
gem "activesupport"
gem "actionpack"
end
platforms :ruby do
gem "ruby\-debug"
gem "sqlite3"
end
group :development, optional: true do
gem "wirble"
gem "faker"
end
.fi
.IP "" 0
.P
In the case of the group block form the :optional option can be given to prevent a group from being installed unless listed in the \fB\-\-with\fR option given to the \fBbundle install\fR command\.
.P
In the case of the \fBgit\fR block form, the \fB:ref\fR, \fB:branch\fR, \fB:tag\fR, and \fB:submodules\fR options may be passed to the \fBgit\fR method, and all gems in the block will inherit those options\.
.P
The presence of a \fBsource\fR block in a Gemfile also makes that source available as a possible global source for any other gems which do not specify explicit sources\. Thus, when defining source blocks, it is recommended that you also ensure all other gems in the Gemfile are using explicit sources, either via source blocks or \fB:source\fR directives on individual gems\.
.SH "INSTALL_IF"
The \fBinstall_if\fR method allows gems to be installed based on a proc or lambda\. This is especially useful for optional gems that can only be used if certain software is installed or some other conditions are met\.
.IP "" 4
.nf
install_if \-> { RUBY_PLATFORM =~ /darwin/ } do
gem "pasteboard"
end
.fi
.IP "" 0
.SH "GEMSPEC"
The \fB\.gemspec\fR \fIhttps://guides\.rubygems\.org/specification\-reference/\fR file is where you provide metadata about your gem to Rubygems\. Some required Gemspec attributes include the name, description, and homepage of your gem\. This is also where you specify the dependencies your gem needs to run\.
.P
If you wish to use Bundler to help install dependencies for a gem while it is being developed, use the \fBgemspec\fR method to pull in the dependencies listed in the \fB\.gemspec\fR file\.
.P
The \fBgemspec\fR method adds any runtime dependencies as gem requirements in the default group\. It also adds development dependencies as gem requirements in the \fBdevelopment\fR group\. Finally, it adds a gem requirement on your project (\fBpath: '\.'\fR)\. In conjunction with \fBBundler\.setup\fR, this allows you to require project files in your test code as you would if the project were installed as a gem; you need not manipulate the load path manually or require project files via relative paths\.
.P
The \fBgemspec\fR method supports optional \fB:path\fR, \fB:glob\fR, \fB:name\fR, and \fB:development_group\fR options, which control where bundler looks for the \fB\.gemspec\fR, the glob it uses to look for the gemspec (defaults to: \fB{,*,*/*}\.gemspec\fR), what named \fB\.gemspec\fR it uses (if more than one is present), and which group development dependencies are included in\.
.P
When a \fBgemspec\fR dependency encounters version conflicts during resolution, the local version under development will always be selected \-\- even if there are remote versions that better match other requirements for the \fBgemspec\fR gem\.
.SH "SOURCE PRIORITY"
When attempting to locate a gem to satisfy a gem requirement, bundler uses the following priority order:
.IP "1." 4
The source explicitly attached to the gem (using \fB:source\fR, \fB:path\fR, or \fB:git\fR)
.IP "2." 4
For implicit gems (dependencies of explicit gems), any source, git, or path repository declared on the parent\. This results in bundler prioritizing the ActiveSupport gem from the Rails git repository over ones from \fBrubygems\.org\fR
.IP "3." 4
If neither of the above conditions are met, the global source will be used\. If multiple global sources are specified, they will be prioritized from last to first, but this is deprecated since Bundler 1\.13, so Bundler prints a warning and will abort with an error in the future\.
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-viz.1 0000644 00000002316 15173517743 0017047 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-VIZ" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-viz\fR \- Generates a visual dependency graph for your Gemfile
.SH "SYNOPSIS"
\fBbundle viz\fR [\-\-file=FILE] [\-\-format=FORMAT] [\-\-requirements] [\-\-version] [\-\-without=GROUP GROUP]
.SH "DESCRIPTION"
\fBviz\fR generates a PNG file of the current \fBGemfile(5)\fR as a dependency graph\. \fBviz\fR requires the ruby\-graphviz gem (and its dependencies)\.
.P
The associated gems must also be installed via \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR\.
.P
\fBviz\fR command was deprecated in Bundler 2\.2\. Use bundler\-graph plugin \fIhttps://github\.com/rubygems/bundler\-graph\fR instead\.
.SH "OPTIONS"
.TP
\fB\-\-file\fR, \fB\-f\fR
The name to use for the generated file\. See \fB\-\-format\fR option
.TP
\fB\-\-format\fR, \fB\-F\fR
This is output format option\. Supported format is png, jpg, svg, dot \|\.\|\.\|\.
.TP
\fB\-\-requirements\fR, \fB\-R\fR
Set to show the version of each required dependency\.
.TP
\fB\-\-version\fR, \fB\-v\fR
Set to show each gem version\.
.TP
\fB\-\-without\fR, \fB\-W\fR
Exclude gems that are part of the specified named group\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-console.1.ronn 0000644 00000002652 15173517743 0020657 0 ustar 00 bundle-console(1) -- Deprecated way to open an IRB session with the bundle pre-loaded
=====================================================================================
## SYNOPSIS
`bundle console` [GROUP]
## DESCRIPTION
Starts an interactive Ruby console session in the context of the current bundle.
If no `GROUP` is specified, all gems in the `default` group in the [Gemfile(5)](https://bundler.io/man/gemfile.5.html) are
preliminarily loaded.
If `GROUP` is specified, all gems in the given group in the Gemfile in addition
to the gems in `default` group are loaded. Even if the given group does not
exist in the Gemfile, IRB console starts without any warning or error.
The environment variable `BUNDLE_CONSOLE` or `bundle config set console` can be used to change
the shell from the following:
* `irb` (default)
* `pry` (https://github.com/pry/pry)
* `ripl` (https://github.com/cldwalker/ripl)
`bundle console` uses irb by default. An alternative Pry or Ripl can be used with
`bundle console` by adjusting the `console` Bundler setting. Also make sure that
`pry` or `ripl` is in your Gemfile.
## EXAMPLE
$ bundle config set console pry
$ bundle console
Resolving dependencies...
[1] pry(main)>
## NOTES
This command was deprecated in Bundler 2.1 and will be removed in 3.0.
Use `bin/console` script, which can be generated by `bundle gem <NAME>`.
## SEE ALSO
[Gemfile(5)](https://bundler.io/man/gemfile.5.html)
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-init.1.ronn 0000644 00000001770 15173517743 0020160 0 ustar 00 bundle-init(1) -- Generates a Gemfile into the current working directory
========================================================================
## SYNOPSIS
`bundle init` [--gemspec=FILE]
## DESCRIPTION
Init generates a default [`Gemfile(5)`][Gemfile(5)] in the current working directory. When
adding a [`Gemfile(5)`][Gemfile(5)] to a gem with a gemspec, the `--gemspec` option will
automatically add each dependency listed in the gemspec file to the newly
created [`Gemfile(5)`][Gemfile(5)].
## OPTIONS
* `--gemspec`:
Use the specified .gemspec to create the [`Gemfile(5)`][Gemfile(5)]
* `--gemfile`:
Use the specified name for the gemfile instead of `Gemfile`
## FILES
Included in the default [`Gemfile(5)`][Gemfile(5)]
generated is the line `# frozen_string_literal: true`. This is a magic comment
supported for the first time in Ruby 2.3. The presence of this line
results in all string literals in the file being implicitly frozen.
## SEE ALSO
[Gemfile(5)](https://bundler.io/man/gemfile.5.html)
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-show.1.ronn 0000644 00000001124 15173517743 0020166 0 ustar 00 bundle-show(1) -- Shows all the gems in your bundle, or the path to a gem
=========================================================================
## SYNOPSIS
`bundle show` [GEM]
[--paths]
## DESCRIPTION
Without the [GEM] option, `show` will print a list of the names and versions of
all gems that are required by your [`Gemfile(5)`][Gemfile(5)], sorted by name.
Calling show with [GEM] will list the exact location of that gem on your
machine.
## OPTIONS
* `--paths`:
List the paths of all gems that are required by your [`Gemfile(5)`][Gemfile(5)],
sorted by gem name.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-console.1 0000644 00000003167 15173517743 0017706 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CONSOLE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-console\fR \- Deprecated way to open an IRB session with the bundle pre\-loaded
.SH "SYNOPSIS"
\fBbundle console\fR [GROUP]
.SH "DESCRIPTION"
Starts an interactive Ruby console session in the context of the current bundle\.
.P
If no \fBGROUP\fR is specified, all gems in the \fBdefault\fR group in the Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR are preliminarily loaded\.
.P
If \fBGROUP\fR is specified, all gems in the given group in the Gemfile in addition to the gems in \fBdefault\fR group are loaded\. Even if the given group does not exist in the Gemfile, IRB console starts without any warning or error\.
.P
The environment variable \fBBUNDLE_CONSOLE\fR or \fBbundle config set console\fR can be used to change the shell from the following:
.IP "\(bu" 4
\fBirb\fR (default)
.IP "\(bu" 4
\fBpry\fR (https://github\.com/pry/pry)
.IP "\(bu" 4
\fBripl\fR (https://github\.com/cldwalker/ripl)
.IP "" 0
.P
\fBbundle console\fR uses irb by default\. An alternative Pry or Ripl can be used with \fBbundle console\fR by adjusting the \fBconsole\fR Bundler setting\. Also make sure that \fBpry\fR or \fBripl\fR is in your Gemfile\.
.SH "EXAMPLE"
.nf
$ bundle config set console pry
$ bundle console
Resolving dependencies\|\.\|\.\|\.
[1] pry(main)>
.fi
.SH "NOTES"
This command was deprecated in Bundler 2\.1 and will be removed in 3\.0\. Use \fBbin/console\fR script, which can be generated by \fBbundle gem <NAME>\fR\.
.SH "SEE ALSO"
Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-version.1 0000644 00000001152 15173517743 0017721 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-VERSION" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-version\fR \- Prints Bundler version information
.SH "SYNOPSIS"
\fBbundle version\fR
.SH "DESCRIPTION"
Prints Bundler version information\.
.SH "OPTIONS"
No options\.
.SH "EXAMPLE"
Print the version of Bundler with build date and commit hash of the in the Git source\.
.IP "" 4
.nf
bundle version
.fi
.IP "" 0
.P
shows \fBBundler version 2\.3\.21 (2022\-08\-24 commit d54be5fdd8)\fR for example\.
.P
cf\. \fBbundle \-\-version\fR shows \fBBundler version 2\.3\.21\fR\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-check.1 0000644 00000002107 15173517743 0017312 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CHECK" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-check\fR \- Verifies if dependencies are satisfied by installed gems
.SH "SYNOPSIS"
\fBbundle check\fR [\-\-dry\-run] [\-\-gemfile=FILE] [\-\-path=PATH]
.SH "DESCRIPTION"
\fBcheck\fR searches the local machine for each of the gems requested in the Gemfile\. If all gems are found, Bundler prints a success message and exits with a status of 0\.
.P
If not, the first missing gem is listed and Bundler exits status 1\.
.P
If the lockfile needs to be updated then it will be resolved using the gems installed on the local machine, if they satisfy the requirements\.
.SH "OPTIONS"
.TP
\fB\-\-dry\-run\fR
Locks the [\fBGemfile(5)\fR][Gemfile(5)] before running the command\.
.TP
\fB\-\-gemfile\fR
Use the specified gemfile instead of the [\fBGemfile(5)\fR][Gemfile(5)]\.
.TP
\fB\-\-path\fR
Specify a different path than the system default (\fB$BUNDLE_PATH\fR or \fB$GEM_HOME\fR)\. Bundler will remember this value for future installs on this machine\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-config.1.ronn 0000644 00000045674 15173517743 0020475 0 ustar 00 bundle-config(1) -- Set bundler configuration options
=====================================================
## SYNOPSIS
`bundle config` list<br>
`bundle config` [get] NAME<br>
`bundle config` [set] NAME VALUE<br>
`bundle config` unset NAME
## DESCRIPTION
This command allows you to interact with Bundler's configuration system.
Bundler loads configuration settings in this order:
1. Local config (`<project_root>/.bundle/config` or `$BUNDLE_APP_CONFIG/config`)
2. Environmental variables (`ENV`)
3. Global config (`~/.bundle/config`)
4. Bundler default config
Executing `bundle config list` will print a list of all bundler
configuration for the current bundle, and where that configuration
was set.
Executing `bundle config get <name>` will print the value of that configuration
setting, and where it was set.
Executing `bundle config set <name> <value>` defaults to setting `local`
configuration if executing from within a local application, otherwise it will
set `global` configuration. See `--local` and `--global` options below.
Executing `bundle config set --local <name> <value>` will set that configuration
in the directory for the local application. The configuration will be stored in
`<project_root>/.bundle/config`. If `BUNDLE_APP_CONFIG` is set, the configuration
will be stored in `$BUNDLE_APP_CONFIG/config`.
Executing `bundle config set --global <name> <value>` will set that
configuration to the value specified for all bundles executed as the current
user. The configuration will be stored in `~/.bundle/config`. If <name> already
is set, <name> will be overridden and user will be warned.
Executing `bundle config unset <name>` will delete the configuration in both
local and global sources.
Executing `bundle config unset --global <name>` will delete the configuration
only from the user configuration.
Executing `bundle config unset --local <name>` will delete the configuration
only from the local application.
Executing bundle with the `BUNDLE_IGNORE_CONFIG` environment variable set will
cause it to ignore all configuration.
## REMEMBERING OPTIONS
Flags passed to `bundle install` or the Bundler runtime, such as `--path foo` or
`--without production`, are remembered between commands and saved to your local
application's configuration (normally, `./.bundle/config`).
However, this will be changed in bundler 3, so it's better not to rely on this
behavior. If these options must be remembered, it's better to set them using
`bundle config` (e.g., `bundle config set --local path foo`).
The options that can be configured are:
* `bin`:
Creates a directory (defaults to `~/bin`) and place any executables from the
gem there. These executables run in Bundler's context. If used, you might add
this directory to your environment's `PATH` variable. For instance, if the
`rails` gem comes with a `rails` executable, this flag will create a
`bin/rails` executable that ensures that all referred dependencies will be
resolved using the bundled gems.
* `deployment`:
In deployment mode, Bundler will 'roll-out' the bundle for
`production` use. Please check carefully if you want to have this option
enabled in `development` or `test` environments.
* `only`:
A space-separated list of groups to install only gems of the specified groups.
* `path`:
The location to install the specified gems to. This defaults to Rubygems'
setting. Bundler shares this location with Rubygems, `gem install ...` will
have gem installed there, too. Therefore, gems installed without a
`--path ...` setting will show up by calling `gem list`. Accordingly, gems
installed to other locations will not get listed.
* `without`:
A space-separated list of groups referencing gems to skip during installation.
* `with`:
A space-separated list of **optional** groups referencing gems to include during installation.
## BUILD OPTIONS
You can use `bundle config` to give Bundler the flags to pass to the gem
installer every time bundler tries to install a particular gem.
A very common example, the `mysql` gem, requires Snow Leopard users to
pass configuration flags to `gem install` to specify where to find the
`mysql_config` executable.
gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
Since the specific location of that executable can change from machine
to machine, you can specify these flags on a per-machine basis.
bundle config set --global build.mysql --with-mysql-config=/usr/local/mysql/bin/mysql_config
After running this command, every time bundler needs to install the
`mysql` gem, it will pass along the flags you specified.
## CONFIGURATION KEYS
Configuration keys in bundler have two forms: the canonical form and the
environment variable form.
For instance, passing the `--without` flag to [bundle install(1)](bundle-install.1.html)
prevents Bundler from installing certain groups specified in the Gemfile(5). Bundler
persists this value in `app/.bundle/config` so that calls to `Bundler.setup`
do not try to find gems from the `Gemfile` that you didn't install. Additionally,
subsequent calls to [bundle install(1)](bundle-install.1.html) remember this setting
and skip those groups.
The canonical form of this configuration is `"without"`. To convert the canonical
form to the environment variable form, capitalize it, and prepend `BUNDLE_`. The
environment variable form of `"without"` is `BUNDLE_WITHOUT`.
Any periods in the configuration keys must be replaced with two underscores when
setting it via environment variables. The configuration key `local.rack` becomes
the environment variable `BUNDLE_LOCAL__RACK`.
## LIST OF AVAILABLE KEYS
The following is a list of all configuration keys and their purpose. You can
learn more about their operation in [bundle install(1)](bundle-install.1.html).
* `allow_offline_install` (`BUNDLE_ALLOW_OFFLINE_INSTALL`):
Allow Bundler to use cached data when installing without network access.
* `auto_clean_without_path` (`BUNDLE_AUTO_CLEAN_WITHOUT_PATH`):
Automatically run `bundle clean` after installing when an explicit `path`
has not been set and Bundler is not installing into the system gems.
* `auto_install` (`BUNDLE_AUTO_INSTALL`):
Automatically run `bundle install` when gems are missing.
* `bin` (`BUNDLE_BIN`):
Install executables from gems in the bundle to the specified directory.
Defaults to `false`.
* `cache_all` (`BUNDLE_CACHE_ALL`):
Cache all gems, including path and git gems. This needs to be explicitly
configured on bundler 1 and bundler 2, but will be the default on bundler 3.
* `cache_all_platforms` (`BUNDLE_CACHE_ALL_PLATFORMS`):
Cache gems for all platforms.
* `cache_path` (`BUNDLE_CACHE_PATH`):
The directory that bundler will place cached gems in when running
<code>bundle package</code>, and that bundler will look in when installing gems.
Defaults to `vendor/cache`.
* `clean` (`BUNDLE_CLEAN`):
Whether Bundler should run `bundle clean` automatically after
`bundle install`.
* `console` (`BUNDLE_CONSOLE`):
The console that `bundle console` starts. Defaults to `irb`.
* `default_install_uses_path` (`BUNDLE_DEFAULT_INSTALL_USES_PATH`):
Whether a `bundle install` without an explicit `--path` argument defaults
to installing gems in `.bundle`.
* `deployment` (`BUNDLE_DEPLOYMENT`):
Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the
lockfile has not been updated, running Bundler commands will be blocked.
* `disable_checksum_validation` (`BUNDLE_DISABLE_CHECKSUM_VALIDATION`):
Allow installing gems even if they do not match the checksum provided by
RubyGems.
* `disable_exec_load` (`BUNDLE_DISABLE_EXEC_LOAD`):
Stop Bundler from using `load` to launch an executable in-process in
`bundle exec`.
* `disable_local_branch_check` (`BUNDLE_DISABLE_LOCAL_BRANCH_CHECK`):
Allow Bundler to use a local git override without a branch specified in the
Gemfile.
* `disable_local_revision_check` (`BUNDLE_DISABLE_LOCAL_REVISION_CHECK`):
Allow Bundler to use a local git override without checking if the revision
present in the lockfile is present in the repository.
* `disable_shared_gems` (`BUNDLE_DISABLE_SHARED_GEMS`):
Stop Bundler from accessing gems installed to RubyGems' normal location.
* `disable_version_check` (`BUNDLE_DISABLE_VERSION_CHECK`):
Stop Bundler from checking if a newer Bundler version is available on
rubygems.org.
* `force_ruby_platform` (`BUNDLE_FORCE_RUBY_PLATFORM`):
Ignore the current machine's platform and install only `ruby` platform gems.
As a result, gems with native extensions will be compiled from source.
* `frozen` (`BUNDLE_FROZEN`):
Disallow changes to the `Gemfile`. When the `Gemfile` is changed and the
lockfile has not been updated, running Bundler commands will be blocked.
Defaults to `true` when `--deployment` is used.
* `gem.github_username` (`BUNDLE_GEM__GITHUB_USERNAME`):
Sets a GitHub username or organization to be used in `README` file when you
create a new gem via `bundle gem` command. It can be overridden by passing an
explicit `--github-username` flag to `bundle gem`.
* `gem.push_key` (`BUNDLE_GEM__PUSH_KEY`):
Sets the `--key` parameter for `gem push` when using the `rake release`
command with a private gemstash server.
* `gemfile` (`BUNDLE_GEMFILE`):
The name of the file that bundler should use as the `Gemfile`. This location
of this file also sets the root of the project, which is used to resolve
relative paths in the `Gemfile`, among other things. By default, bundler
will search up from the current working directory until it finds a
`Gemfile`.
* `global_gem_cache` (`BUNDLE_GLOBAL_GEM_CACHE`):
Whether Bundler should cache all gems globally, rather than locally to the
installing Ruby installation.
* `ignore_funding_requests` (`BUNDLE_IGNORE_FUNDING_REQUESTS`):
When set, no funding requests will be printed.
* `ignore_messages` (`BUNDLE_IGNORE_MESSAGES`):
When set, no post install messages will be printed. To silence a single gem,
use dot notation like `ignore_messages.httparty true`.
* `init_gems_rb` (`BUNDLE_INIT_GEMS_RB`):
Generate a `gems.rb` instead of a `Gemfile` when running `bundle init`.
* `jobs` (`BUNDLE_JOBS`):
The number of gems Bundler can install in parallel. Defaults to the number of
available processors.
* `no_install` (`BUNDLE_NO_INSTALL`):
Whether `bundle package` should skip installing gems.
* `no_prune` (`BUNDLE_NO_PRUNE`):
Whether Bundler should leave outdated gems unpruned when caching.
* `only` (`BUNDLE_ONLY`):
A space-separated list of groups to install only gems of the specified groups.
* `path` (`BUNDLE_PATH`):
The location on disk where all gems in your bundle will be located regardless
of `$GEM_HOME` or `$GEM_PATH` values. Bundle gems not found in this location
will be installed by `bundle install`. Defaults to `Gem.dir`. When --deployment
is used, defaults to vendor/bundle.
* `path.system` (`BUNDLE_PATH__SYSTEM`):
Whether Bundler will install gems into the default system path (`Gem.dir`).
* `path_relative_to_cwd` (`BUNDLE_PATH_RELATIVE_TO_CWD`)
Makes `--path` relative to the CWD instead of the `Gemfile`.
* `plugins` (`BUNDLE_PLUGINS`):
Enable Bundler's experimental plugin system.
* `prefer_patch` (BUNDLE_PREFER_PATCH):
Prefer updating only to next patch version during updates. Makes `bundle update` calls equivalent to `bundler update --patch`.
* `print_only_version_number` (`BUNDLE_PRINT_ONLY_VERSION_NUMBER`):
Print only version number from `bundler --version`.
* `redirect` (`BUNDLE_REDIRECT`):
The number of redirects allowed for network requests. Defaults to `5`.
* `retry` (`BUNDLE_RETRY`):
The number of times to retry failed network requests. Defaults to `3`.
* `setup_makes_kernel_gem_public` (`BUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC`):
Have `Bundler.setup` make the `Kernel#gem` method public, even though
RubyGems declares it as private.
* `shebang` (`BUNDLE_SHEBANG`):
The program name that should be invoked for generated binstubs. Defaults to
the ruby install name used to generate the binstub.
* `silence_deprecations` (`BUNDLE_SILENCE_DEPRECATIONS`):
Whether Bundler should silence deprecation warnings for behavior that will
be changed in the next major version.
* `silence_root_warning` (`BUNDLE_SILENCE_ROOT_WARNING`):
Silence the warning Bundler prints when installing gems as root.
* `ssl_ca_cert` (`BUNDLE_SSL_CA_CERT`):
Path to a designated CA certificate file or folder containing multiple
certificates for trusted CAs in PEM format.
* `ssl_client_cert` (`BUNDLE_SSL_CLIENT_CERT`):
Path to a designated file containing a X.509 client certificate
and key in PEM format.
* `ssl_verify_mode` (`BUNDLE_SSL_VERIFY_MODE`):
The SSL verification mode Bundler uses when making HTTPS requests.
Defaults to verify peer.
* `system_bindir` (`BUNDLE_SYSTEM_BINDIR`):
The location where RubyGems installs binstubs. Defaults to `Gem.bindir`.
* `timeout` (`BUNDLE_TIMEOUT`):
The seconds allowed before timing out for network requests. Defaults to `10`.
* `update_requires_all_flag` (`BUNDLE_UPDATE_REQUIRES_ALL_FLAG`):
Require passing `--all` to `bundle update` when everything should be updated,
and disallow passing no options to `bundle update`.
* `user_agent` (`BUNDLE_USER_AGENT`):
The custom user agent fragment Bundler includes in API requests.
* `version` (`BUNDLE_VERSION`):
The version of Bundler to use when running under Bundler environment.
Defaults to `lockfile`. You can also specify `system` or `x.y.z`.
`lockfile` will use the Bundler version specified in the `Gemfile.lock`,
`system` will use the system version of Bundler, and `x.y.z` will use
the specified version of Bundler.
* `with` (`BUNDLE_WITH`):
A `:`-separated list of groups whose gems bundler should install.
* `without` (`BUNDLE_WITHOUT`):
A `:`-separated list of groups whose gems bundler should not install.
In general, you should set these settings per-application by using the applicable
flag to the [bundle install(1)](bundle-install.1.html) or [bundle cache(1)](bundle-cache.1.html) command.
You can set them globally either via environment variables or `bundle config`,
whichever is preferable for your setup. If you use both, environment variables
will take preference over global settings.
## LOCAL GIT REPOS
Bundler also allows you to work against a git repository locally
instead of using the remote version. This can be achieved by setting
up a local override:
bundle config set --local local.GEM_NAME /path/to/local/git/repository
For example, in order to use a local Rack repository, a developer could call:
bundle config set --local local.rack ~/Work/git/rack
Now instead of checking out the remote git repository, the local
override will be used. Similar to a path source, every time the local
git repository change, changes will be automatically picked up by
Bundler. This means a commit in the local git repo will update the
revision in the `Gemfile.lock` to the local git repo revision. This
requires the same attention as git submodules. Before pushing to
the remote, you need to ensure the local override was pushed, otherwise
you may point to a commit that only exists in your local machine.
You'll also need to CGI escape your usernames and passwords as well.
Bundler does many checks to ensure a developer won't work with
invalid references. Particularly, we force a developer to specify
a branch in the `Gemfile` in order to use this feature. If the branch
specified in the `Gemfile` and the current branch in the local git
repository do not match, Bundler will abort. This ensures that
a developer is always working against the correct branches, and prevents
accidental locking to a different branch.
Finally, Bundler also ensures that the current revision in the
`Gemfile.lock` exists in the local git repository. By doing this, Bundler
forces you to fetch the latest changes in the remotes.
## MIRRORS OF GEM SOURCES
Bundler supports overriding gem sources with mirrors. This allows you to
configure rubygems.org as the gem source in your Gemfile while still using your
mirror to fetch gems.
bundle config set --global mirror.SOURCE_URL MIRROR_URL
For example, to use a mirror of https://rubygems.org hosted at https://example.org:
bundle config set --global mirror.https://rubygems.org https://example.org
Each mirror also provides a fallback timeout setting. If the mirror does not
respond within the fallback timeout, Bundler will try to use the original
server instead of the mirror.
bundle config set --global mirror.SOURCE_URL.fallback_timeout TIMEOUT
For example, to fall back to rubygems.org after 3 seconds:
bundle config set --global mirror.https://rubygems.org.fallback_timeout 3
The default fallback timeout is 0.1 seconds, but the setting can currently
only accept whole seconds (for example, 1, 15, or 30).
## CREDENTIALS FOR GEM SOURCES
Bundler allows you to configure credentials for any gem source, which allows
you to avoid putting secrets into your Gemfile.
bundle config set --global SOURCE_HOSTNAME USERNAME:PASSWORD
For example, to save the credentials of user `claudette` for the gem source at
`gems.longerous.com`, you would run:
bundle config set --global gems.longerous.com claudette:s00pers3krit
Or you can set the credentials as an environment variable like this:
export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
For gems with a git source with HTTP(S) URL you can specify credentials like so:
bundle config set --global https://github.com/rubygems/rubygems.git username:password
Or you can set the credentials as an environment variable like so:
export BUNDLE_GITHUB__COM=username:password
This is especially useful for private repositories on hosts such as GitHub,
where you can use personal OAuth tokens:
export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x-oauth-basic
Note that any configured credentials will be redacted by informative commands
such as `bundle config list` or `bundle config get`, unless you use the
`--parseable` flag. This is to avoid unintentionally leaking credentials when
copy-pasting bundler output.
Also note that to guarantee a sane mapping between valid environment variable
names and valid host names, bundler makes the following transformations:
* Any `-` characters in a host name are mapped to a triple underscore (`___`) in the
corresponding environment variable.
* Any `.` characters in a host name are mapped to a double underscore (`__`) in the
corresponding environment variable.
This means that if you have a gem server named `my.gem-host.com`, you'll need to
use the `BUNDLE_MY__GEM___HOST__COM` variable to configure credentials for it
through ENV.
## CONFIGURE BUNDLER DIRECTORIES
Bundler's home, cache and plugin directories and config file can be configured
through environment variables. The default location for Bundler's home directory is
`~/.bundle`, which all directories inherit from by default. The following
outlines the available environment variables and their default values
BUNDLE_USER_HOME : $HOME/.bundle
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-doctor.1 0000644 00000002161 15173517743 0017527 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-DOCTOR" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-doctor\fR \- Checks the bundle for common problems
.SH "SYNOPSIS"
\fBbundle doctor\fR [\-\-quiet] [\-\-gemfile=GEMFILE]
.SH "DESCRIPTION"
Checks your Gemfile and gem environment for common problems\. If issues are detected, Bundler prints them and exits status 1\. Otherwise, Bundler prints a success message and exits status 0\.
.P
Examples of common problems caught by bundle\-doctor include:
.IP "\(bu" 4
Invalid Bundler settings
.IP "\(bu" 4
Mismatched Ruby versions
.IP "\(bu" 4
Mismatched platforms
.IP "\(bu" 4
Uninstalled gems
.IP "\(bu" 4
Missing dependencies
.IP "" 0
.SH "OPTIONS"
.TP
\fB\-\-quiet\fR
Only output warnings and errors\.
.TP
\fB\-\-gemfile=<gemfile>\fR
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project's root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-platform.1 0000644 00000002613 15173517743 0020063 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-PLATFORM" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-platform\fR \- Displays platform compatibility information
.SH "SYNOPSIS"
\fBbundle platform\fR [\-\-ruby]
.SH "DESCRIPTION"
\fBplatform\fR displays information from your Gemfile, Gemfile\.lock, and Ruby VM about your platform\.
.P
For instance, using this Gemfile(5):
.IP "" 4
.nf
source "https://rubygems\.org"
ruby "3\.1\.2"
gem "rack"
.fi
.IP "" 0
.P
If you run \fBbundle platform\fR on Ruby 3\.1\.2, it displays the following output:
.IP "" 4
.nf
Your platform is: x86_64\-linux
Your app has gems that work on these platforms:
* arm64\-darwin\-21
* ruby
* x64\-mingw\-ucrt
* x86_64\-linux
Your Gemfile specifies a Ruby version requirement:
* ruby 3\.1\.2
Your current platform satisfies the Ruby version requirement\.
.fi
.IP "" 0
.P
\fBplatform\fR lists all the platforms in your \fBGemfile\.lock\fR as well as the \fBruby\fR directive if applicable from your Gemfile(5)\. It also lets you know if the \fBruby\fR directive requirement has been met\. If \fBruby\fR directive doesn't match the running Ruby VM, it tells you what part does not\.
.SH "OPTIONS"
.TP
\fB\-\-ruby\fR
It will display the ruby directive information, so you don't have to parse it from the Gemfile(5)\.
.SH "SEE ALSO"
.IP "\(bu" 4
bundle\-lock(1) \fIbundle\-lock\.1\.html\fR
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-check.1.ronn 0000644 00000001750 15173517743 0020270 0 ustar 00 bundle-check(1) -- Verifies if dependencies are satisfied by installed gems
===========================================================================
## SYNOPSIS
`bundle check` [--dry-run]
[--gemfile=FILE]
[--path=PATH]
## DESCRIPTION
`check` searches the local machine for each of the gems requested in the
Gemfile. If all gems are found, Bundler prints a success message and exits with
a status of 0.
If not, the first missing gem is listed and Bundler exits status 1.
If the lockfile needs to be updated then it will be resolved using the gems
installed on the local machine, if they satisfy the requirements.
## OPTIONS
* `--dry-run`:
Locks the [`Gemfile(5)`][Gemfile(5)] before running the command.
* `--gemfile`:
Use the specified gemfile instead of the [`Gemfile(5)`][Gemfile(5)].
* `--path`:
Specify a different path than the system default (`$BUNDLE_PATH` or `$GEM_HOME`).
Bundler will remember this value for future installs on this machine.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-config.1 0000644 00000052017 15173517743 0017507 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CONFIG" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-config\fR \- Set bundler configuration options
.SH "SYNOPSIS"
\fBbundle config\fR list
.br
\fBbundle config\fR [get] NAME
.br
\fBbundle config\fR [set] NAME VALUE
.br
\fBbundle config\fR unset NAME
.SH "DESCRIPTION"
This command allows you to interact with Bundler's configuration system\.
.P
Bundler loads configuration settings in this order:
.IP "1." 4
Local config (\fB<project_root>/\.bundle/config\fR or \fB$BUNDLE_APP_CONFIG/config\fR)
.IP "2." 4
Environmental variables (\fBENV\fR)
.IP "3." 4
Global config (\fB~/\.bundle/config\fR)
.IP "4." 4
Bundler default config
.IP "" 0
.P
Executing \fBbundle config list\fR will print a list of all bundler configuration for the current bundle, and where that configuration was set\.
.P
Executing \fBbundle config get <name>\fR will print the value of that configuration setting, and where it was set\.
.P
Executing \fBbundle config set <name> <value>\fR defaults to setting \fBlocal\fR configuration if executing from within a local application, otherwise it will set \fBglobal\fR configuration\. See \fB\-\-local\fR and \fB\-\-global\fR options below\.
.P
Executing \fBbundle config set \-\-local <name> <value>\fR will set that configuration in the directory for the local application\. The configuration will be stored in \fB<project_root>/\.bundle/config\fR\. If \fBBUNDLE_APP_CONFIG\fR is set, the configuration will be stored in \fB$BUNDLE_APP_CONFIG/config\fR\.
.P
Executing \fBbundle config set \-\-global <name> <value>\fR will set that configuration to the value specified for all bundles executed as the current user\. The configuration will be stored in \fB~/\.bundle/config\fR\. If \fIname\fR already is set, \fIname\fR will be overridden and user will be warned\.
.P
Executing \fBbundle config unset <name>\fR will delete the configuration in both local and global sources\.
.P
Executing \fBbundle config unset \-\-global <name>\fR will delete the configuration only from the user configuration\.
.P
Executing \fBbundle config unset \-\-local <name>\fR will delete the configuration only from the local application\.
.P
Executing bundle with the \fBBUNDLE_IGNORE_CONFIG\fR environment variable set will cause it to ignore all configuration\.
.SH "REMEMBERING OPTIONS"
Flags passed to \fBbundle install\fR or the Bundler runtime, such as \fB\-\-path foo\fR or \fB\-\-without production\fR, are remembered between commands and saved to your local application's configuration (normally, \fB\./\.bundle/config\fR)\.
.P
However, this will be changed in bundler 3, so it's better not to rely on this behavior\. If these options must be remembered, it's better to set them using \fBbundle config\fR (e\.g\., \fBbundle config set \-\-local path foo\fR)\.
.P
The options that can be configured are:
.TP
\fBbin\fR
Creates a directory (defaults to \fB~/bin\fR) and place any executables from the gem there\. These executables run in Bundler's context\. If used, you might add this directory to your environment's \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
.TP
\fBdeployment\fR
In deployment mode, Bundler will 'roll\-out' the bundle for \fBproduction\fR use\. Please check carefully if you want to have this option enabled in \fBdevelopment\fR or \fBtest\fR environments\.
.TP
\fBonly\fR
A space\-separated list of groups to install only gems of the specified groups\.
.TP
\fBpath\fR
The location to install the specified gems to\. This defaults to Rubygems' setting\. Bundler shares this location with Rubygems, \fBgem install \|\.\|\.\|\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \|\.\|\.\|\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
.TP
\fBwithout\fR
A space\-separated list of groups referencing gems to skip during installation\.
.TP
\fBwith\fR
A space\-separated list of \fBoptional\fR groups referencing gems to include during installation\.
.SH "BUILD OPTIONS"
You can use \fBbundle config\fR to give Bundler the flags to pass to the gem installer every time bundler tries to install a particular gem\.
.P
A very common example, the \fBmysql\fR gem, requires Snow Leopard users to pass configuration flags to \fBgem install\fR to specify where to find the \fBmysql_config\fR executable\.
.IP "" 4
.nf
gem install mysql \-\- \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
.fi
.IP "" 0
.P
Since the specific location of that executable can change from machine to machine, you can specify these flags on a per\-machine basis\.
.IP "" 4
.nf
bundle config set \-\-global build\.mysql \-\-with\-mysql\-config=/usr/local/mysql/bin/mysql_config
.fi
.IP "" 0
.P
After running this command, every time bundler needs to install the \fBmysql\fR gem, it will pass along the flags you specified\.
.SH "CONFIGURATION KEYS"
Configuration keys in bundler have two forms: the canonical form and the environment variable form\.
.P
For instance, passing the \fB\-\-without\fR flag to bundle install(1) \fIbundle\-install\.1\.html\fR prevents Bundler from installing certain groups specified in the Gemfile(5)\. Bundler persists this value in \fBapp/\.bundle/config\fR so that calls to \fBBundler\.setup\fR do not try to find gems from the \fBGemfile\fR that you didn't install\. Additionally, subsequent calls to bundle install(1) \fIbundle\-install\.1\.html\fR remember this setting and skip those groups\.
.P
The canonical form of this configuration is \fB"without"\fR\. To convert the canonical form to the environment variable form, capitalize it, and prepend \fBBUNDLE_\fR\. The environment variable form of \fB"without"\fR is \fBBUNDLE_WITHOUT\fR\.
.P
Any periods in the configuration keys must be replaced with two underscores when setting it via environment variables\. The configuration key \fBlocal\.rack\fR becomes the environment variable \fBBUNDLE_LOCAL__RACK\fR\.
.SH "LIST OF AVAILABLE KEYS"
The following is a list of all configuration keys and their purpose\. You can learn more about their operation in bundle install(1) \fIbundle\-install\.1\.html\fR\.
.IP "\(bu" 4
\fBallow_offline_install\fR (\fBBUNDLE_ALLOW_OFFLINE_INSTALL\fR): Allow Bundler to use cached data when installing without network access\.
.IP "\(bu" 4
\fBauto_clean_without_path\fR (\fBBUNDLE_AUTO_CLEAN_WITHOUT_PATH\fR): Automatically run \fBbundle clean\fR after installing when an explicit \fBpath\fR has not been set and Bundler is not installing into the system gems\.
.IP "\(bu" 4
\fBauto_install\fR (\fBBUNDLE_AUTO_INSTALL\fR): Automatically run \fBbundle install\fR when gems are missing\.
.IP "\(bu" 4
\fBbin\fR (\fBBUNDLE_BIN\fR): Install executables from gems in the bundle to the specified directory\. Defaults to \fBfalse\fR\.
.IP "\(bu" 4
\fBcache_all\fR (\fBBUNDLE_CACHE_ALL\fR): Cache all gems, including path and git gems\. This needs to be explicitly configured on bundler 1 and bundler 2, but will be the default on bundler 3\.
.IP "\(bu" 4
\fBcache_all_platforms\fR (\fBBUNDLE_CACHE_ALL_PLATFORMS\fR): Cache gems for all platforms\.
.IP "\(bu" 4
\fBcache_path\fR (\fBBUNDLE_CACHE_PATH\fR): The directory that bundler will place cached gems in when running \fBbundle package\fR, and that bundler will look in when installing gems\. Defaults to \fBvendor/cache\fR\.
.IP "\(bu" 4
\fBclean\fR (\fBBUNDLE_CLEAN\fR): Whether Bundler should run \fBbundle clean\fR automatically after \fBbundle install\fR\.
.IP "\(bu" 4
\fBconsole\fR (\fBBUNDLE_CONSOLE\fR): The console that \fBbundle console\fR starts\. Defaults to \fBirb\fR\.
.IP "\(bu" 4
\fBdefault_install_uses_path\fR (\fBBUNDLE_DEFAULT_INSTALL_USES_PATH\fR): Whether a \fBbundle install\fR without an explicit \fB\-\-path\fR argument defaults to installing gems in \fB\.bundle\fR\.
.IP "\(bu" 4
\fBdeployment\fR (\fBBUNDLE_DEPLOYMENT\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\.
.IP "\(bu" 4
\fBdisable_checksum_validation\fR (\fBBUNDLE_DISABLE_CHECKSUM_VALIDATION\fR): Allow installing gems even if they do not match the checksum provided by RubyGems\.
.IP "\(bu" 4
\fBdisable_exec_load\fR (\fBBUNDLE_DISABLE_EXEC_LOAD\fR): Stop Bundler from using \fBload\fR to launch an executable in\-process in \fBbundle exec\fR\.
.IP "\(bu" 4
\fBdisable_local_branch_check\fR (\fBBUNDLE_DISABLE_LOCAL_BRANCH_CHECK\fR): Allow Bundler to use a local git override without a branch specified in the Gemfile\.
.IP "\(bu" 4
\fBdisable_local_revision_check\fR (\fBBUNDLE_DISABLE_LOCAL_REVISION_CHECK\fR): Allow Bundler to use a local git override without checking if the revision present in the lockfile is present in the repository\.
.IP "\(bu" 4
\fBdisable_shared_gems\fR (\fBBUNDLE_DISABLE_SHARED_GEMS\fR): Stop Bundler from accessing gems installed to RubyGems' normal location\.
.IP "\(bu" 4
\fBdisable_version_check\fR (\fBBUNDLE_DISABLE_VERSION_CHECK\fR): Stop Bundler from checking if a newer Bundler version is available on rubygems\.org\.
.IP "\(bu" 4
\fBforce_ruby_platform\fR (\fBBUNDLE_FORCE_RUBY_PLATFORM\fR): Ignore the current machine's platform and install only \fBruby\fR platform gems\. As a result, gems with native extensions will be compiled from source\.
.IP "\(bu" 4
\fBfrozen\fR (\fBBUNDLE_FROZEN\fR): Disallow changes to the \fBGemfile\fR\. When the \fBGemfile\fR is changed and the lockfile has not been updated, running Bundler commands will be blocked\. Defaults to \fBtrue\fR when \fB\-\-deployment\fR is used\.
.IP "\(bu" 4
\fBgem\.github_username\fR (\fBBUNDLE_GEM__GITHUB_USERNAME\fR): Sets a GitHub username or organization to be used in \fBREADME\fR file when you create a new gem via \fBbundle gem\fR command\. It can be overridden by passing an explicit \fB\-\-github\-username\fR flag to \fBbundle gem\fR\.
.IP "\(bu" 4
\fBgem\.push_key\fR (\fBBUNDLE_GEM__PUSH_KEY\fR): Sets the \fB\-\-key\fR parameter for \fBgem push\fR when using the \fBrake release\fR command with a private gemstash server\.
.IP "\(bu" 4
\fBgemfile\fR (\fBBUNDLE_GEMFILE\fR): The name of the file that bundler should use as the \fBGemfile\fR\. This location of this file also sets the root of the project, which is used to resolve relative paths in the \fBGemfile\fR, among other things\. By default, bundler will search up from the current working directory until it finds a \fBGemfile\fR\.
.IP "\(bu" 4
\fBglobal_gem_cache\fR (\fBBUNDLE_GLOBAL_GEM_CACHE\fR): Whether Bundler should cache all gems globally, rather than locally to the installing Ruby installation\.
.IP "\(bu" 4
\fBignore_funding_requests\fR (\fBBUNDLE_IGNORE_FUNDING_REQUESTS\fR): When set, no funding requests will be printed\.
.IP "\(bu" 4
\fBignore_messages\fR (\fBBUNDLE_IGNORE_MESSAGES\fR): When set, no post install messages will be printed\. To silence a single gem, use dot notation like \fBignore_messages\.httparty true\fR\.
.IP "\(bu" 4
\fBinit_gems_rb\fR (\fBBUNDLE_INIT_GEMS_RB\fR): Generate a \fBgems\.rb\fR instead of a \fBGemfile\fR when running \fBbundle init\fR\.
.IP "\(bu" 4
\fBjobs\fR (\fBBUNDLE_JOBS\fR): The number of gems Bundler can install in parallel\. Defaults to the number of available processors\.
.IP "\(bu" 4
\fBno_install\fR (\fBBUNDLE_NO_INSTALL\fR): Whether \fBbundle package\fR should skip installing gems\.
.IP "\(bu" 4
\fBno_prune\fR (\fBBUNDLE_NO_PRUNE\fR): Whether Bundler should leave outdated gems unpruned when caching\.
.IP "\(bu" 4
\fBonly\fR (\fBBUNDLE_ONLY\fR): A space\-separated list of groups to install only gems of the specified groups\.
.IP "\(bu" 4
\fBpath\fR (\fBBUNDLE_PATH\fR): The location on disk where all gems in your bundle will be located regardless of \fB$GEM_HOME\fR or \fB$GEM_PATH\fR values\. Bundle gems not found in this location will be installed by \fBbundle install\fR\. Defaults to \fBGem\.dir\fR\. When \-\-deployment is used, defaults to vendor/bundle\.
.IP "\(bu" 4
\fBpath\.system\fR (\fBBUNDLE_PATH__SYSTEM\fR): Whether Bundler will install gems into the default system path (\fBGem\.dir\fR)\.
.IP "\(bu" 4
\fBpath_relative_to_cwd\fR (\fBBUNDLE_PATH_RELATIVE_TO_CWD\fR) Makes \fB\-\-path\fR relative to the CWD instead of the \fBGemfile\fR\.
.IP "\(bu" 4
\fBplugins\fR (\fBBUNDLE_PLUGINS\fR): Enable Bundler's experimental plugin system\.
.IP "\(bu" 4
\fBprefer_patch\fR (BUNDLE_PREFER_PATCH): Prefer updating only to next patch version during updates\. Makes \fBbundle update\fR calls equivalent to \fBbundler update \-\-patch\fR\.
.IP "\(bu" 4
\fBprint_only_version_number\fR (\fBBUNDLE_PRINT_ONLY_VERSION_NUMBER\fR): Print only version number from \fBbundler \-\-version\fR\.
.IP "\(bu" 4
\fBredirect\fR (\fBBUNDLE_REDIRECT\fR): The number of redirects allowed for network requests\. Defaults to \fB5\fR\.
.IP "\(bu" 4
\fBretry\fR (\fBBUNDLE_RETRY\fR): The number of times to retry failed network requests\. Defaults to \fB3\fR\.
.IP "\(bu" 4
\fBsetup_makes_kernel_gem_public\fR (\fBBUNDLE_SETUP_MAKES_KERNEL_GEM_PUBLIC\fR): Have \fBBundler\.setup\fR make the \fBKernel#gem\fR method public, even though RubyGems declares it as private\.
.IP "\(bu" 4
\fBshebang\fR (\fBBUNDLE_SHEBANG\fR): The program name that should be invoked for generated binstubs\. Defaults to the ruby install name used to generate the binstub\.
.IP "\(bu" 4
\fBsilence_deprecations\fR (\fBBUNDLE_SILENCE_DEPRECATIONS\fR): Whether Bundler should silence deprecation warnings for behavior that will be changed in the next major version\.
.IP "\(bu" 4
\fBsilence_root_warning\fR (\fBBUNDLE_SILENCE_ROOT_WARNING\fR): Silence the warning Bundler prints when installing gems as root\.
.IP "\(bu" 4
\fBssl_ca_cert\fR (\fBBUNDLE_SSL_CA_CERT\fR): Path to a designated CA certificate file or folder containing multiple certificates for trusted CAs in PEM format\.
.IP "\(bu" 4
\fBssl_client_cert\fR (\fBBUNDLE_SSL_CLIENT_CERT\fR): Path to a designated file containing a X\.509 client certificate and key in PEM format\.
.IP "\(bu" 4
\fBssl_verify_mode\fR (\fBBUNDLE_SSL_VERIFY_MODE\fR): The SSL verification mode Bundler uses when making HTTPS requests\. Defaults to verify peer\.
.IP "\(bu" 4
\fBsystem_bindir\fR (\fBBUNDLE_SYSTEM_BINDIR\fR): The location where RubyGems installs binstubs\. Defaults to \fBGem\.bindir\fR\.
.IP "\(bu" 4
\fBtimeout\fR (\fBBUNDLE_TIMEOUT\fR): The seconds allowed before timing out for network requests\. Defaults to \fB10\fR\.
.IP "\(bu" 4
\fBupdate_requires_all_flag\fR (\fBBUNDLE_UPDATE_REQUIRES_ALL_FLAG\fR): Require passing \fB\-\-all\fR to \fBbundle update\fR when everything should be updated, and disallow passing no options to \fBbundle update\fR\.
.IP "\(bu" 4
\fBuser_agent\fR (\fBBUNDLE_USER_AGENT\fR): The custom user agent fragment Bundler includes in API requests\.
.IP "\(bu" 4
\fBversion\fR (\fBBUNDLE_VERSION\fR): The version of Bundler to use when running under Bundler environment\. Defaults to \fBlockfile\fR\. You can also specify \fBsystem\fR or \fBx\.y\.z\fR\. \fBlockfile\fR will use the Bundler version specified in the \fBGemfile\.lock\fR, \fBsystem\fR will use the system version of Bundler, and \fBx\.y\.z\fR will use the specified version of Bundler\.
.IP "\(bu" 4
\fBwith\fR (\fBBUNDLE_WITH\fR): A \fB:\fR\-separated list of groups whose gems bundler should install\.
.IP "\(bu" 4
\fBwithout\fR (\fBBUNDLE_WITHOUT\fR): A \fB:\fR\-separated list of groups whose gems bundler should not install\.
.IP "" 0
.P
In general, you should set these settings per\-application by using the applicable flag to the bundle install(1) \fIbundle\-install\.1\.html\fR or bundle cache(1) \fIbundle\-cache\.1\.html\fR command\.
.P
You can set them globally either via environment variables or \fBbundle config\fR, whichever is preferable for your setup\. If you use both, environment variables will take preference over global settings\.
.SH "LOCAL GIT REPOS"
Bundler also allows you to work against a git repository locally instead of using the remote version\. This can be achieved by setting up a local override:
.IP "" 4
.nf
bundle config set \-\-local local\.GEM_NAME /path/to/local/git/repository
.fi
.IP "" 0
.P
For example, in order to use a local Rack repository, a developer could call:
.IP "" 4
.nf
bundle config set \-\-local local\.rack ~/Work/git/rack
.fi
.IP "" 0
.P
Now instead of checking out the remote git repository, the local override will be used\. Similar to a path source, every time the local git repository change, changes will be automatically picked up by Bundler\. This means a commit in the local git repo will update the revision in the \fBGemfile\.lock\fR to the local git repo revision\. This requires the same attention as git submodules\. Before pushing to the remote, you need to ensure the local override was pushed, otherwise you may point to a commit that only exists in your local machine\. You'll also need to CGI escape your usernames and passwords as well\.
.P
Bundler does many checks to ensure a developer won't work with invalid references\. Particularly, we force a developer to specify a branch in the \fBGemfile\fR in order to use this feature\. If the branch specified in the \fBGemfile\fR and the current branch in the local git repository do not match, Bundler will abort\. This ensures that a developer is always working against the correct branches, and prevents accidental locking to a different branch\.
.P
Finally, Bundler also ensures that the current revision in the \fBGemfile\.lock\fR exists in the local git repository\. By doing this, Bundler forces you to fetch the latest changes in the remotes\.
.SH "MIRRORS OF GEM SOURCES"
Bundler supports overriding gem sources with mirrors\. This allows you to configure rubygems\.org as the gem source in your Gemfile while still using your mirror to fetch gems\.
.IP "" 4
.nf
bundle config set \-\-global mirror\.SOURCE_URL MIRROR_URL
.fi
.IP "" 0
.P
For example, to use a mirror of https://rubygems\.org hosted at https://example\.org:
.IP "" 4
.nf
bundle config set \-\-global mirror\.https://rubygems\.org https://example\.org
.fi
.IP "" 0
.P
Each mirror also provides a fallback timeout setting\. If the mirror does not respond within the fallback timeout, Bundler will try to use the original server instead of the mirror\.
.IP "" 4
.nf
bundle config set \-\-global mirror\.SOURCE_URL\.fallback_timeout TIMEOUT
.fi
.IP "" 0
.P
For example, to fall back to rubygems\.org after 3 seconds:
.IP "" 4
.nf
bundle config set \-\-global mirror\.https://rubygems\.org\.fallback_timeout 3
.fi
.IP "" 0
.P
The default fallback timeout is 0\.1 seconds, but the setting can currently only accept whole seconds (for example, 1, 15, or 30)\.
.SH "CREDENTIALS FOR GEM SOURCES"
Bundler allows you to configure credentials for any gem source, which allows you to avoid putting secrets into your Gemfile\.
.IP "" 4
.nf
bundle config set \-\-global SOURCE_HOSTNAME USERNAME:PASSWORD
.fi
.IP "" 0
.P
For example, to save the credentials of user \fBclaudette\fR for the gem source at \fBgems\.longerous\.com\fR, you would run:
.IP "" 4
.nf
bundle config set \-\-global gems\.longerous\.com claudette:s00pers3krit
.fi
.IP "" 0
.P
Or you can set the credentials as an environment variable like this:
.IP "" 4
.nf
export BUNDLE_GEMS__LONGEROUS__COM="claudette:s00pers3krit"
.fi
.IP "" 0
.P
For gems with a git source with HTTP(S) URL you can specify credentials like so:
.IP "" 4
.nf
bundle config set \-\-global https://github\.com/rubygems/rubygems\.git username:password
.fi
.IP "" 0
.P
Or you can set the credentials as an environment variable like so:
.IP "" 4
.nf
export BUNDLE_GITHUB__COM=username:password
.fi
.IP "" 0
.P
This is especially useful for private repositories on hosts such as GitHub, where you can use personal OAuth tokens:
.IP "" 4
.nf
export BUNDLE_GITHUB__COM=abcd0123generatedtoken:x\-oauth\-basic
.fi
.IP "" 0
.P
Note that any configured credentials will be redacted by informative commands such as \fBbundle config list\fR or \fBbundle config get\fR, unless you use the \fB\-\-parseable\fR flag\. This is to avoid unintentionally leaking credentials when copy\-pasting bundler output\.
.P
Also note that to guarantee a sane mapping between valid environment variable names and valid host names, bundler makes the following transformations:
.IP "\(bu" 4
Any \fB\-\fR characters in a host name are mapped to a triple underscore (\fB___\fR) in the corresponding environment variable\.
.IP "\(bu" 4
Any \fB\.\fR characters in a host name are mapped to a double underscore (\fB__\fR) in the corresponding environment variable\.
.IP "" 0
.P
This means that if you have a gem server named \fBmy\.gem\-host\.com\fR, you'll need to use the \fBBUNDLE_MY__GEM___HOST__COM\fR variable to configure credentials for it through ENV\.
.SH "CONFIGURE BUNDLER DIRECTORIES"
Bundler's home, cache and plugin directories and config file can be configured through environment variables\. The default location for Bundler's home directory is \fB~/\.bundle\fR, which all directories inherit from by default\. The following outlines the available environment variables and their default values
.IP "" 4
.nf
BUNDLE_USER_HOME : $HOME/\.bundle
BUNDLE_USER_CACHE : $BUNDLE_USER_HOME/cache
BUNDLE_USER_CONFIG : $BUNDLE_USER_HOME/config
BUNDLE_USER_PLUGIN : $BUNDLE_USER_HOME/plugin
.fi
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-clean.1.ronn 0000644 00000001160 15173517743 0020270 0 ustar 00 bundle-clean(1) -- Cleans up unused gems in your bundler directory
==================================================================
## SYNOPSIS
`bundle clean` [--dry-run] [--force]
## DESCRIPTION
This command will remove all unused gems in your bundler directory. This is
useful when you have made many changes to your gem dependencies.
## OPTIONS
* `--dry-run`:
Print the changes, but do not clean the unused gems.
* `--force`:
Forces cleaning up unused gems even if Bundler is configured to use globally installed gems. As a consequence, removes all system gems except for the ones in the current application.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-install.1.ronn 0000644 00000037353 15173517743 0020671 0 ustar 00 bundle-install(1) -- Install the dependencies specified in your Gemfile
=======================================================================
## SYNOPSIS
`bundle install` [--binstubs[=DIRECTORY]]
[--clean]
[--deployment]
[--frozen]
[--full-index]
[--gemfile=GEMFILE]
[--jobs=NUMBER]
[--local]
[--no-cache]
[--no-prune]
[--path PATH]
[--prefer-local]
[--quiet]
[--redownload]
[--retry=NUMBER]
[--shebang]
[--standalone[=GROUP[ GROUP...]]]
[--system]
[--trust-policy=POLICY]
[--with=GROUP[ GROUP...]]
[--without=GROUP[ GROUP...]]
## DESCRIPTION
Install the gems specified in your Gemfile(5). If this is the first
time you run bundle install (and a `Gemfile.lock` does not exist),
Bundler will fetch all remote sources, resolve dependencies and
install all needed gems.
If a `Gemfile.lock` does exist, and you have not updated your Gemfile(5),
Bundler will fetch all remote sources, but use the dependencies
specified in the `Gemfile.lock` instead of resolving dependencies.
If a `Gemfile.lock` does exist, and you have updated your Gemfile(5),
Bundler will use the dependencies in the `Gemfile.lock` for all gems
that you did not update, but will re-resolve the dependencies of
gems that you did update. You can find more information about this
update process below under [CONSERVATIVE UPDATING][].
## OPTIONS
The `--clean`, `--deployment`, `--frozen`, `--no-prune`, `--path`, `--shebang`,
`--system`, `--without` and `--with` options are deprecated because they only
make sense if they are applied to every subsequent `bundle install` run
automatically and that requires `bundler` to silently remember them. Since
`bundler` will no longer remember CLI flags in future versions, `bundle config`
(see bundle-config(1)) should be used to apply them permanently.
* `--binstubs[=<directory>]`:
Binstubs are scripts that wrap around executables. Bundler creates a small Ruby
file (a binstub) that loads Bundler, runs the command, and puts it in `bin/`.
This lets you link the binstub inside of an application to the exact gem
version the application needs.
Creates a directory (defaults to `~/bin`) and places any executables from the
gem there. These executables run in Bundler's context. If used, you might add
this directory to your environment's `PATH` variable. For instance, if the
`rails` gem comes with a `rails` executable, this flag will create a
`bin/rails` executable that ensures that all referred dependencies will be
resolved using the bundled gems.
* `--clean`:
On finishing the installation Bundler is going to remove any gems not present
in the current Gemfile(5). Don't worry, gems currently in use will not be
removed.
This option is deprecated in favor of the `clean` setting.
* `--deployment`:
In [deployment mode][DEPLOYMENT MODE], Bundler will 'roll-out' the bundle for
production or CI use. Please check carefully if you want to have this option
enabled in your development environment.
This option is deprecated in favor of the `deployment` setting.
* `--redownload`:
Force download every gem, even if the required versions are already available
locally.
* `--frozen`:
Do not allow the Gemfile.lock to be updated after this install. Exits
non-zero if there are going to be changes to the Gemfile.lock.
This option is deprecated in favor of the `frozen` setting.
* `--full-index`:
Bundler will not call Rubygems' API endpoint (default) but download and cache
a (currently big) index file of all gems. Performance can be improved for
large bundles that seldom change by enabling this option.
* `--gemfile=<gemfile>`:
The location of the Gemfile(5) which Bundler should use. This defaults
to a Gemfile(5) in the current working directory. In general, Bundler
will assume that the location of the Gemfile(5) is also the project's
root and will try to find `Gemfile.lock` and `vendor/cache` relative
to this location.
* `--jobs=[<number>]`, `-j[<number>]`:
The maximum number of parallel download and install jobs. The default is the
number of available processors.
* `--local`:
Do not attempt to connect to `rubygems.org`. Instead, Bundler will use the
gems already present in Rubygems' cache or in `vendor/cache`. Note that if an
appropriate platform-specific gem exists on `rubygems.org` it will not be
found.
* `--prefer-local`:
Force using locally installed gems, or gems already present in Rubygems' cache
or in `vendor/cache`, when resolving, even if newer versions are available
remotely. Only attempt to connect to `rubygems.org` for gems that are not
present locally.
* `--no-cache`:
Do not update the cache in `vendor/cache` with the newly bundled gems. This
does not remove any gems in the cache but keeps the newly bundled gems from
being cached during the install.
* `--no-prune`:
Don't remove stale gems from the cache when the installation finishes.
This option is deprecated in favor of the `no_prune` setting.
* `--path=<path>`:
The location to install the specified gems to. This defaults to Rubygems'
setting. Bundler shares this location with Rubygems, `gem install ...` will
have gem installed there, too. Therefore, gems installed without a
`--path ...` setting will show up by calling `gem list`. Accordingly, gems
installed to other locations will not get listed.
This option is deprecated in favor of the `path` setting.
* `--quiet`:
Do not print progress information to the standard output. Instead, Bundler
will exit using a status code (`$?`).
* `--retry=[<number>]`:
Retry failed network or git requests for <number> times.
* `--shebang=<ruby-executable>`:
Uses the specified ruby executable (usually `ruby`) to execute the scripts
created with `--binstubs`. In addition, if you use `--binstubs` together with
`--shebang jruby` these executables will be changed to execute `jruby`
instead.
This option is deprecated in favor of the `shebang` setting.
* `--standalone[=<list>]`:
Makes a bundle that can work without depending on Rubygems or Bundler at
runtime. A space separated list of groups to install has to be specified.
Bundler creates a directory named `bundle` and installs the bundle there. It
also generates a `bundle/bundler/setup.rb` file to replace Bundler's own setup
in the manner required. Using this option implicitly sets `path`, which is a
[remembered option][REMEMBERED OPTIONS].
* `--system`:
Installs the gems specified in the bundle to the system's Rubygems location.
This overrides any previous configuration of `--path`.
This option is deprecated in favor of the `system` setting.
* `--trust-policy=[<policy>]`:
Apply the Rubygems security policy <policy>, where policy is one of
`HighSecurity`, `MediumSecurity`, `LowSecurity`, `AlmostNoSecurity`, or
`NoSecurity`. For more details, please see the Rubygems signing documentation
linked below in [SEE ALSO][].
* `--with=<list>`:
A space-separated list of groups referencing gems to install. If an
optional group is given it is installed. If a group is given that is
in the remembered list of groups given to --without, it is removed
from that list.
This option is deprecated in favor of the `with` setting.
* `--without=<list>`:
A space-separated list of groups referencing gems to skip during installation.
If a group is given that is in the remembered list of groups given
to --with, it is removed from that list.
This option is deprecated in favor of the `without` setting.
## DEPLOYMENT MODE
Bundler's defaults are optimized for development. To switch to
defaults optimized for deployment and for CI, use the `--deployment`
flag. Do not activate deployment mode on development machines, as it
will cause an error when the Gemfile(5) is modified.
1. A `Gemfile.lock` is required.
To ensure that the same versions of the gems you developed with
and tested with are also used in deployments, a `Gemfile.lock`
is required.
This is mainly to ensure that you remember to check your
`Gemfile.lock` into version control.
2. The `Gemfile.lock` must be up to date
In development, you can modify your Gemfile(5) and re-run
`bundle install` to [conservatively update][CONSERVATIVE UPDATING]
your `Gemfile.lock` snapshot.
In deployment, your `Gemfile.lock` should be up-to-date with
changes made in your Gemfile(5).
3. Gems are installed to `vendor/bundle` not your default system location
In development, it's convenient to share the gems used in your
application with other applications and other scripts that run on
the system.
In deployment, isolation is a more important default. In addition,
the user deploying the application may not have permission to install
gems to the system, or the web server may not have permission to
read them.
As a result, `bundle install --deployment` installs gems to
the `vendor/bundle` directory in the application. This may be
overridden using the `--path` option.
## INSTALLING GROUPS
By default, `bundle install` will install all gems in all groups
in your Gemfile(5), except those declared for a different platform.
However, you can explicitly tell Bundler to skip installing
certain groups with the `--without` option. This option takes
a space-separated list of groups.
While the `--without` option will skip _installing_ the gems in the
specified groups, it will still _download_ those gems and use them to
resolve the dependencies of every gem in your Gemfile(5).
This is so that installing a different set of groups on another
machine (such as a production server) will not change the
gems and versions that you have already developed and tested against.
`Bundler offers a rock-solid guarantee that the third-party
code you are running in development and testing is also the
third-party code you are running in production. You can choose
to exclude some of that code in different environments, but you
will never be caught flat-footed by different versions of
third-party code being used in different environments.`
For a simple illustration, consider the following Gemfile(5):
source 'https://rubygems.org'
gem 'sinatra'
group :production do
gem 'rack-perftools-profiler'
end
In this case, `sinatra` depends on any version of Rack (`>= 1.0`), while
`rack-perftools-profiler` depends on 1.x (`~> 1.0`).
When you run `bundle install --without production` in development, we
look at the dependencies of `rack-perftools-profiler` as well. That way,
you do not spend all your time developing against Rack 2.0, using new
APIs unavailable in Rack 1.x, only to have Bundler switch to Rack 1.2
when the `production` group _is_ used.
This should not cause any problems in practice, because we do not
attempt to `install` the gems in the excluded groups, and only evaluate
as part of the dependency resolution process.
This also means that you cannot include different versions of the same
gem in different groups, because doing so would result in different
sets of dependencies used in development and production. Because of
the vagaries of the dependency resolution process, this usually
affects more than the gems you list in your Gemfile(5), and can
(surprisingly) radically change the gems you are using.
## THE GEMFILE.LOCK
When you run `bundle install`, Bundler will persist the full names
and versions of all gems that you used (including dependencies of
the gems specified in the Gemfile(5)) into a file called `Gemfile.lock`.
Bundler uses this file in all subsequent calls to `bundle install`,
which guarantees that you always use the same exact code, even
as your application moves across machines.
Because of the way dependency resolution works, even a
seemingly small change (for instance, an update to a point-release
of a dependency of a gem in your Gemfile(5)) can result in radically
different gems being needed to satisfy all dependencies.
As a result, you `SHOULD` check your `Gemfile.lock` into version
control, in both applications and gems. If you do not, every machine that
checks out your repository (including your production server) will resolve all
dependencies again, which will result in different versions of
third-party code being used if `any` of the gems in the Gemfile(5)
or any of their dependencies have been updated.
When Bundler first shipped, the `Gemfile.lock` was included in the `.gitignore`
file included with generated gems. Over time, however, it became clear that
this practice forces the pain of broken dependencies onto new contributors,
while leaving existing contributors potentially unaware of the problem. Since
`bundle install` is usually the first step towards a contribution, the pain of
broken dependencies would discourage new contributors from contributing. As a
result, we have revised our guidance for gem authors to now recommend checking
in the lock for gems.
## CONSERVATIVE UPDATING
When you make a change to the Gemfile(5) and then run `bundle install`,
Bundler will update only the gems that you modified.
In other words, if a gem that you `did not modify` worked before
you called `bundle install`, it will continue to use the exact
same versions of all dependencies as it used before the update.
Let's take a look at an example. Here's your original Gemfile(5):
source 'https://rubygems.org'
gem 'actionpack', '2.3.8'
gem 'activemerchant'
In this case, both `actionpack` and `activemerchant` depend on
`activesupport`. The `actionpack` gem depends on `activesupport 2.3.8`
and `rack ~> 1.1.0`, while the `activemerchant` gem depends on
`activesupport >= 2.3.2`, `braintree >= 2.0.0`, and `builder >= 2.0.0`.
When the dependencies are first resolved, Bundler will select
`activesupport 2.3.8`, which satisfies the requirements of both
gems in your Gemfile(5).
Next, you modify your Gemfile(5) to:
source 'https://rubygems.org'
gem 'actionpack', '3.0.0.rc'
gem 'activemerchant'
The `actionpack 3.0.0.rc` gem has a number of new dependencies,
and updates the `activesupport` dependency to `= 3.0.0.rc` and
the `rack` dependency to `~> 1.2.1`.
When you run `bundle install`, Bundler notices that you changed
the `actionpack` gem, but not the `activemerchant` gem. It
evaluates the gems currently being used to satisfy its requirements:
* `activesupport 2.3.8`:
also used to satisfy a dependency in `activemerchant`,
which is not being updated
* `rack ~> 1.1.0`:
not currently being used to satisfy another dependency
Because you did not explicitly ask to update `activemerchant`,
you would not expect it to suddenly stop working after updating
`actionpack`. However, satisfying the new `activesupport 3.0.0.rc`
dependency of actionpack requires updating one of its dependencies.
Even though `activemerchant` declares a very loose dependency
that theoretically matches `activesupport 3.0.0.rc`, Bundler treats
gems in your Gemfile(5) that have not changed as an atomic unit
together with their dependencies. In this case, the `activemerchant`
dependency is treated as `activemerchant 1.7.1 + activesupport 2.3.8`,
so `bundle install` will report that it cannot update `actionpack`.
To explicitly update `actionpack`, including its dependencies
which other gems in the Gemfile(5) still depend on, run
`bundle update actionpack` (see `bundle update(1)`).
`Summary`: In general, after making a change to the Gemfile(5) , you
should first try to run `bundle install`, which will guarantee that no
other gem in the Gemfile(5) is impacted by the change. If that
does not work, run [bundle update(1)](bundle-update.1.html).
## SEE ALSO
* [Gem install docs](https://guides.rubygems.org/rubygems-basics/#installing-gems)
* [Rubygems signing docs](https://guides.rubygems.org/security/)
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-outdated.1 0000644 00000006265 15173517743 0020057 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-OUTDATED" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-outdated\fR \- List installed gems with newer versions available
.SH "SYNOPSIS"
\fBbundle outdated\fR [GEM] [\-\-local] [\-\-pre] [\-\-source] [\-\-strict] [\-\-parseable | \-\-porcelain] [\-\-group=GROUP] [\-\-groups] [\-\-patch|\-\-minor|\-\-major] [\-\-filter\-major] [\-\-filter\-minor] [\-\-filter\-patch] [\-\-only\-explicit]
.SH "DESCRIPTION"
Outdated lists the names and versions of gems that have a newer version available in the given source\. Calling outdated with [GEM [GEM]] will only check for newer versions of the given gems\. Prerelease gems are ignored by default\. If your gems are up to date, Bundler will exit with a status of 0\. Otherwise, it will exit 1\.
.SH "OPTIONS"
.TP
\fB\-\-local\fR
Do not attempt to fetch gems remotely and use the gem cache instead\.
.TP
\fB\-\-pre\fR
Check for newer pre\-release gems\.
.TP
\fB\-\-source\fR
Check against a specific source\.
.TP
\fB\-\-strict\fR
Only list newer versions allowed by your Gemfile requirements, also respecting conservative update flags (\-\-patch, \-\-minor, \-\-major)\.
.TP
\fB\-\-parseable\fR, \fB\-\-porcelain\fR
Use minimal formatting for more parseable output\.
.TP
\fB\-\-group\fR
List gems from a specific group\.
.TP
\fB\-\-groups\fR
List gems organized by groups\.
.TP
\fB\-\-minor\fR
Prefer updating only to next minor version\.
.TP
\fB\-\-major\fR
Prefer updating to next major version (default)\.
.TP
\fB\-\-patch\fR
Prefer updating only to next patch version\.
.TP
\fB\-\-filter\-major\fR
Only list major newer versions\.
.TP
\fB\-\-filter\-minor\fR
Only list minor newer versions\.
.TP
\fB\-\-filter\-patch\fR
Only list patch newer versions\.
.TP
\fB\-\-only\-explicit\fR
Only list gems specified in your Gemfile, not their dependencies\.
.SH "PATCH LEVEL OPTIONS"
See bundle update(1) \fIbundle\-update\.1\.html\fR for details\.
.SH "FILTERING OUTPUT"
The 3 filtering options do not affect the resolution of versions, merely what versions are shown in the output\.
.P
If the regular output shows the following:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* faker 1\.6\.5 1\.6\.6 ~> 1\.4 development, test
* hashie 1\.2\.0 3\.4\.6 = 1\.2\.0 default
* headless 2\.2\.3 2\.3\.1 = 2\.2\.3 test
.fi
.IP "" 0
.P
\fB\-\-filter\-major\fR would only show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* hashie 1\.2\.0 3\.4\.6 = 1\.2\.0 default
.fi
.IP "" 0
.P
\fB\-\-filter\-minor\fR would only show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* headless 2\.2\.3 2\.3\.1 = 2\.2\.3 test
.fi
.IP "" 0
.P
\fB\-\-filter\-patch\fR would only show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* faker 1\.6\.5 1\.6\.6 ~> 1\.4 development, test
.fi
.IP "" 0
.P
Filter options can be combined\. \fB\-\-filter\-minor\fR and \fB\-\-filter\-patch\fR would show:
.IP "" 4
.nf
* Gem Current Latest Requested Groups
* faker 1\.6\.5 1\.6\.6 ~> 1\.4 development, test
.fi
.IP "" 0
.P
Combining all three \fBfilter\fR options would be the same result as providing none of them\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-platform.1.ronn 0000644 00000002334 15173517743 0021036 0 ustar 00 bundle-platform(1) -- Displays platform compatibility information
=================================================================
## SYNOPSIS
`bundle platform` [--ruby]
## DESCRIPTION
`platform` displays information from your Gemfile, Gemfile.lock, and Ruby
VM about your platform.
For instance, using this Gemfile(5):
source "https://rubygems.org"
ruby "3.1.2"
gem "rack"
If you run `bundle platform` on Ruby 3.1.2, it displays the following output:
Your platform is: x86_64-linux
Your app has gems that work on these platforms:
* arm64-darwin-21
* ruby
* x64-mingw-ucrt
* x86_64-linux
Your Gemfile specifies a Ruby version requirement:
* ruby 3.1.2
Your current platform satisfies the Ruby version requirement.
`platform` lists all the platforms in your `Gemfile.lock` as well as the
`ruby` directive if applicable from your Gemfile(5). It also lets you know
if the `ruby` directive requirement has been met. If `ruby` directive doesn't
match the running Ruby VM, it tells you what part does not.
## OPTIONS
* `--ruby`:
It will display the ruby directive information, so you don't have to
parse it from the Gemfile(5).
## SEE ALSO
* [bundle-lock(1)](bundle-lock.1.html)
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-pristine.1 0000644 00000003166 15173517743 0020100 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-PRISTINE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-pristine\fR \- Restores installed gems to their pristine condition
.SH "SYNOPSIS"
\fBbundle pristine\fR
.SH "DESCRIPTION"
\fBpristine\fR restores the installed gems in the bundle to their pristine condition using the local gem cache from RubyGems\. For git gems, a forced checkout will be performed\.
.P
For further explanation, \fBbundle pristine\fR ignores unpacked files on disk\. In other words, this command utilizes the local \fB\.gem\fR cache or the gem's git repository as if one were installing from scratch\.
.P
Note: the Bundler gem cannot be restored to its original state with \fBpristine\fR\. One also cannot use \fBbundle pristine\fR on gems with a 'path' option in the Gemfile, because bundler has no original copy it can restore from\.
.P
When is it practical to use \fBbundle pristine\fR?
.P
It comes in handy when a developer is debugging a gem\. \fBbundle pristine\fR is a great way to get rid of experimental changes to a gem that one may not want\.
.P
Why use \fBbundle pristine\fR over \fBgem pristine \-\-all\fR?
.P
Both commands are very similar\. For context: \fBbundle pristine\fR, without arguments, cleans all gems from the lockfile\. Meanwhile, \fBgem pristine \-\-all\fR cleans all installed gems for that Ruby version\.
.P
If a developer forgets which gems in their project they might have been debugging, the Rubygems \fBgem pristine [GEMNAME]\fR command may be inconvenient\. One can avoid waiting for \fBgem pristine \-\-all\fR, and instead run \fBbundle pristine\fR\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-show.1 0000644 00000001245 15173517743 0017217 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-SHOW" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-show\fR \- Shows all the gems in your bundle, or the path to a gem
.SH "SYNOPSIS"
\fBbundle show\fR [GEM] [\-\-paths]
.SH "DESCRIPTION"
Without the [GEM] option, \fBshow\fR will print a list of the names and versions of all gems that are required by your [\fBGemfile(5)\fR][Gemfile(5)], sorted by name\.
.P
Calling show with [GEM] will list the exact location of that gem on your machine\.
.SH "OPTIONS"
.TP
\fB\-\-paths\fR
List the paths of all gems that are required by your [\fBGemfile(5)\fR][Gemfile(5)], sorted by gem name\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-install.1 0000644 00000040672 15173517743 0017714 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INSTALL" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-install\fR \- Install the dependencies specified in your Gemfile
.SH "SYNOPSIS"
\fBbundle install\fR [\-\-binstubs[=DIRECTORY]] [\-\-clean] [\-\-deployment] [\-\-frozen] [\-\-full\-index] [\-\-gemfile=GEMFILE] [\-\-jobs=NUMBER] [\-\-local] [\-\-no\-cache] [\-\-no\-prune] [\-\-path PATH] [\-\-prefer\-local] [\-\-quiet] [\-\-redownload] [\-\-retry=NUMBER] [\-\-shebang] [\-\-standalone[=GROUP[ GROUP\|\.\|\.\|\.]]] [\-\-system] [\-\-trust\-policy=POLICY] [\-\-with=GROUP[ GROUP\|\.\|\.\|\.]] [\-\-without=GROUP[ GROUP\|\.\|\.\|\.]]
.SH "DESCRIPTION"
Install the gems specified in your Gemfile(5)\. If this is the first time you run bundle install (and a \fBGemfile\.lock\fR does not exist), Bundler will fetch all remote sources, resolve dependencies and install all needed gems\.
.P
If a \fBGemfile\.lock\fR does exist, and you have not updated your Gemfile(5), Bundler will fetch all remote sources, but use the dependencies specified in the \fBGemfile\.lock\fR instead of resolving dependencies\.
.P
If a \fBGemfile\.lock\fR does exist, and you have updated your Gemfile(5), Bundler will use the dependencies in the \fBGemfile\.lock\fR for all gems that you did not update, but will re\-resolve the dependencies of gems that you did update\. You can find more information about this update process below under \fICONSERVATIVE UPDATING\fR\.
.SH "OPTIONS"
The \fB\-\-clean\fR, \fB\-\-deployment\fR, \fB\-\-frozen\fR, \fB\-\-no\-prune\fR, \fB\-\-path\fR, \fB\-\-shebang\fR, \fB\-\-system\fR, \fB\-\-without\fR and \fB\-\-with\fR options are deprecated because they only make sense if they are applied to every subsequent \fBbundle install\fR run automatically and that requires \fBbundler\fR to silently remember them\. Since \fBbundler\fR will no longer remember CLI flags in future versions, \fBbundle config\fR (see bundle\-config(1)) should be used to apply them permanently\.
.TP
\fB\-\-binstubs[=<directory>]\fR
Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it in \fBbin/\fR\. This lets you link the binstub inside of an application to the exact gem version the application needs\.
.IP
Creates a directory (defaults to \fB~/bin\fR) and places any executables from the gem there\. These executables run in Bundler's context\. If used, you might add this directory to your environment's \fBPATH\fR variable\. For instance, if the \fBrails\fR gem comes with a \fBrails\fR executable, this flag will create a \fBbin/rails\fR executable that ensures that all referred dependencies will be resolved using the bundled gems\.
.TP
\fB\-\-clean\fR
On finishing the installation Bundler is going to remove any gems not present in the current Gemfile(5)\. Don't worry, gems currently in use will not be removed\.
.IP
This option is deprecated in favor of the \fBclean\fR setting\.
.TP
\fB\-\-deployment\fR
In \fIdeployment mode\fR, Bundler will 'roll\-out' the bundle for production or CI use\. Please check carefully if you want to have this option enabled in your development environment\.
.IP
This option is deprecated in favor of the \fBdeployment\fR setting\.
.TP
\fB\-\-redownload\fR
Force download every gem, even if the required versions are already available locally\.
.TP
\fB\-\-frozen\fR
Do not allow the Gemfile\.lock to be updated after this install\. Exits non\-zero if there are going to be changes to the Gemfile\.lock\.
.IP
This option is deprecated in favor of the \fBfrozen\fR setting\.
.TP
\fB\-\-full\-index\fR
Bundler will not call Rubygems' API endpoint (default) but download and cache a (currently big) index file of all gems\. Performance can be improved for large bundles that seldom change by enabling this option\.
.TP
\fB\-\-gemfile=<gemfile>\fR
The location of the Gemfile(5) which Bundler should use\. This defaults to a Gemfile(5) in the current working directory\. In general, Bundler will assume that the location of the Gemfile(5) is also the project's root and will try to find \fBGemfile\.lock\fR and \fBvendor/cache\fR relative to this location\.
.TP
\fB\-\-jobs=[<number>]\fR, \fB\-j[<number>]\fR
The maximum number of parallel download and install jobs\. The default is the number of available processors\.
.TP
\fB\-\-local\fR
Do not attempt to connect to \fBrubygems\.org\fR\. Instead, Bundler will use the gems already present in Rubygems' cache or in \fBvendor/cache\fR\. Note that if an appropriate platform\-specific gem exists on \fBrubygems\.org\fR it will not be found\.
.TP
\fB\-\-prefer\-local\fR
Force using locally installed gems, or gems already present in Rubygems' cache or in \fBvendor/cache\fR, when resolving, even if newer versions are available remotely\. Only attempt to connect to \fBrubygems\.org\fR for gems that are not present locally\.
.TP
\fB\-\-no\-cache\fR
Do not update the cache in \fBvendor/cache\fR with the newly bundled gems\. This does not remove any gems in the cache but keeps the newly bundled gems from being cached during the install\.
.TP
\fB\-\-no\-prune\fR
Don't remove stale gems from the cache when the installation finishes\.
.IP
This option is deprecated in favor of the \fBno_prune\fR setting\.
.TP
\fB\-\-path=<path>\fR
The location to install the specified gems to\. This defaults to Rubygems' setting\. Bundler shares this location with Rubygems, \fBgem install \|\.\|\.\|\.\fR will have gem installed there, too\. Therefore, gems installed without a \fB\-\-path \|\.\|\.\|\.\fR setting will show up by calling \fBgem list\fR\. Accordingly, gems installed to other locations will not get listed\.
.IP
This option is deprecated in favor of the \fBpath\fR setting\.
.TP
\fB\-\-quiet\fR
Do not print progress information to the standard output\. Instead, Bundler will exit using a status code (\fB$?\fR)\.
.TP
\fB\-\-retry=[<number>]\fR
Retry failed network or git requests for \fInumber\fR times\.
.TP
\fB\-\-shebang=<ruby\-executable>\fR
Uses the specified ruby executable (usually \fBruby\fR) to execute the scripts created with \fB\-\-binstubs\fR\. In addition, if you use \fB\-\-binstubs\fR together with \fB\-\-shebang jruby\fR these executables will be changed to execute \fBjruby\fR instead\.
.IP
This option is deprecated in favor of the \fBshebang\fR setting\.
.TP
\fB\-\-standalone[=<list>]\fR
Makes a bundle that can work without depending on Rubygems or Bundler at runtime\. A space separated list of groups to install has to be specified\. Bundler creates a directory named \fBbundle\fR and installs the bundle there\. It also generates a \fBbundle/bundler/setup\.rb\fR file to replace Bundler's own setup in the manner required\. Using this option implicitly sets \fBpath\fR, which is a [remembered option][REMEMBERED OPTIONS]\.
.TP
\fB\-\-system\fR
Installs the gems specified in the bundle to the system's Rubygems location\. This overrides any previous configuration of \fB\-\-path\fR\.
.IP
This option is deprecated in favor of the \fBsystem\fR setting\.
.TP
\fB\-\-trust\-policy=[<policy>]\fR
Apply the Rubygems security policy \fIpolicy\fR, where policy is one of \fBHighSecurity\fR, \fBMediumSecurity\fR, \fBLowSecurity\fR, \fBAlmostNoSecurity\fR, or \fBNoSecurity\fR\. For more details, please see the Rubygems signing documentation linked below in \fISEE ALSO\fR\.
.TP
\fB\-\-with=<list>\fR
A space\-separated list of groups referencing gems to install\. If an optional group is given it is installed\. If a group is given that is in the remembered list of groups given to \-\-without, it is removed from that list\.
.IP
This option is deprecated in favor of the \fBwith\fR setting\.
.TP
\fB\-\-without=<list>\fR
A space\-separated list of groups referencing gems to skip during installation\. If a group is given that is in the remembered list of groups given to \-\-with, it is removed from that list\.
.IP
This option is deprecated in favor of the \fBwithout\fR setting\.
.SH "DEPLOYMENT MODE"
Bundler's defaults are optimized for development\. To switch to defaults optimized for deployment and for CI, use the \fB\-\-deployment\fR flag\. Do not activate deployment mode on development machines, as it will cause an error when the Gemfile(5) is modified\.
.IP "1." 4
A \fBGemfile\.lock\fR is required\.
.IP
To ensure that the same versions of the gems you developed with and tested with are also used in deployments, a \fBGemfile\.lock\fR is required\.
.IP
This is mainly to ensure that you remember to check your \fBGemfile\.lock\fR into version control\.
.IP "2." 4
The \fBGemfile\.lock\fR must be up to date
.IP
In development, you can modify your Gemfile(5) and re\-run \fBbundle install\fR to \fIconservatively update\fR your \fBGemfile\.lock\fR snapshot\.
.IP
In deployment, your \fBGemfile\.lock\fR should be up\-to\-date with changes made in your Gemfile(5)\.
.IP "3." 4
Gems are installed to \fBvendor/bundle\fR not your default system location
.IP
In development, it's convenient to share the gems used in your application with other applications and other scripts that run on the system\.
.IP
In deployment, isolation is a more important default\. In addition, the user deploying the application may not have permission to install gems to the system, or the web server may not have permission to read them\.
.IP
As a result, \fBbundle install \-\-deployment\fR installs gems to the \fBvendor/bundle\fR directory in the application\. This may be overridden using the \fB\-\-path\fR option\.
.IP "" 0
.SH "INSTALLING GROUPS"
By default, \fBbundle install\fR will install all gems in all groups in your Gemfile(5), except those declared for a different platform\.
.P
However, you can explicitly tell Bundler to skip installing certain groups with the \fB\-\-without\fR option\. This option takes a space\-separated list of groups\.
.P
While the \fB\-\-without\fR option will skip \fIinstalling\fR the gems in the specified groups, it will still \fIdownload\fR those gems and use them to resolve the dependencies of every gem in your Gemfile(5)\.
.P
This is so that installing a different set of groups on another machine (such as a production server) will not change the gems and versions that you have already developed and tested against\.
.P
\fBBundler offers a rock\-solid guarantee that the third\-party code you are running in development and testing is also the third\-party code you are running in production\. You can choose to exclude some of that code in different environments, but you will never be caught flat\-footed by different versions of third\-party code being used in different environments\.\fR
.P
For a simple illustration, consider the following Gemfile(5):
.IP "" 4
.nf
source 'https://rubygems\.org'
gem 'sinatra'
group :production do
gem 'rack\-perftools\-profiler'
end
.fi
.IP "" 0
.P
In this case, \fBsinatra\fR depends on any version of Rack (\fB>= 1\.0\fR), while \fBrack\-perftools\-profiler\fR depends on 1\.x (\fB~> 1\.0\fR)\.
.P
When you run \fBbundle install \-\-without production\fR in development, we look at the dependencies of \fBrack\-perftools\-profiler\fR as well\. That way, you do not spend all your time developing against Rack 2\.0, using new APIs unavailable in Rack 1\.x, only to have Bundler switch to Rack 1\.2 when the \fBproduction\fR group \fIis\fR used\.
.P
This should not cause any problems in practice, because we do not attempt to \fBinstall\fR the gems in the excluded groups, and only evaluate as part of the dependency resolution process\.
.P
This also means that you cannot include different versions of the same gem in different groups, because doing so would result in different sets of dependencies used in development and production\. Because of the vagaries of the dependency resolution process, this usually affects more than the gems you list in your Gemfile(5), and can (surprisingly) radically change the gems you are using\.
.SH "THE GEMFILE\.LOCK"
When you run \fBbundle install\fR, Bundler will persist the full names and versions of all gems that you used (including dependencies of the gems specified in the Gemfile(5)) into a file called \fBGemfile\.lock\fR\.
.P
Bundler uses this file in all subsequent calls to \fBbundle install\fR, which guarantees that you always use the same exact code, even as your application moves across machines\.
.P
Because of the way dependency resolution works, even a seemingly small change (for instance, an update to a point\-release of a dependency of a gem in your Gemfile(5)) can result in radically different gems being needed to satisfy all dependencies\.
.P
As a result, you \fBSHOULD\fR check your \fBGemfile\.lock\fR into version control, in both applications and gems\. If you do not, every machine that checks out your repository (including your production server) will resolve all dependencies again, which will result in different versions of third\-party code being used if \fBany\fR of the gems in the Gemfile(5) or any of their dependencies have been updated\.
.P
When Bundler first shipped, the \fBGemfile\.lock\fR was included in the \fB\.gitignore\fR file included with generated gems\. Over time, however, it became clear that this practice forces the pain of broken dependencies onto new contributors, while leaving existing contributors potentially unaware of the problem\. Since \fBbundle install\fR is usually the first step towards a contribution, the pain of broken dependencies would discourage new contributors from contributing\. As a result, we have revised our guidance for gem authors to now recommend checking in the lock for gems\.
.SH "CONSERVATIVE UPDATING"
When you make a change to the Gemfile(5) and then run \fBbundle install\fR, Bundler will update only the gems that you modified\.
.P
In other words, if a gem that you \fBdid not modify\fR worked before you called \fBbundle install\fR, it will continue to use the exact same versions of all dependencies as it used before the update\.
.P
Let's take a look at an example\. Here's your original Gemfile(5):
.IP "" 4
.nf
source 'https://rubygems\.org'
gem 'actionpack', '2\.3\.8'
gem 'activemerchant'
.fi
.IP "" 0
.P
In this case, both \fBactionpack\fR and \fBactivemerchant\fR depend on \fBactivesupport\fR\. The \fBactionpack\fR gem depends on \fBactivesupport 2\.3\.8\fR and \fBrack ~> 1\.1\.0\fR, while the \fBactivemerchant\fR gem depends on \fBactivesupport >= 2\.3\.2\fR, \fBbraintree >= 2\.0\.0\fR, and \fBbuilder >= 2\.0\.0\fR\.
.P
When the dependencies are first resolved, Bundler will select \fBactivesupport 2\.3\.8\fR, which satisfies the requirements of both gems in your Gemfile(5)\.
.P
Next, you modify your Gemfile(5) to:
.IP "" 4
.nf
source 'https://rubygems\.org'
gem 'actionpack', '3\.0\.0\.rc'
gem 'activemerchant'
.fi
.IP "" 0
.P
The \fBactionpack 3\.0\.0\.rc\fR gem has a number of new dependencies, and updates the \fBactivesupport\fR dependency to \fB= 3\.0\.0\.rc\fR and the \fBrack\fR dependency to \fB~> 1\.2\.1\fR\.
.P
When you run \fBbundle install\fR, Bundler notices that you changed the \fBactionpack\fR gem, but not the \fBactivemerchant\fR gem\. It evaluates the gems currently being used to satisfy its requirements:
.TP
\fBactivesupport 2\.3\.8\fR
also used to satisfy a dependency in \fBactivemerchant\fR, which is not being updated
.TP
\fBrack ~> 1\.1\.0\fR
not currently being used to satisfy another dependency
.P
Because you did not explicitly ask to update \fBactivemerchant\fR, you would not expect it to suddenly stop working after updating \fBactionpack\fR\. However, satisfying the new \fBactivesupport 3\.0\.0\.rc\fR dependency of actionpack requires updating one of its dependencies\.
.P
Even though \fBactivemerchant\fR declares a very loose dependency that theoretically matches \fBactivesupport 3\.0\.0\.rc\fR, Bundler treats gems in your Gemfile(5) that have not changed as an atomic unit together with their dependencies\. In this case, the \fBactivemerchant\fR dependency is treated as \fBactivemerchant 1\.7\.1 + activesupport 2\.3\.8\fR, so \fBbundle install\fR will report that it cannot update \fBactionpack\fR\.
.P
To explicitly update \fBactionpack\fR, including its dependencies which other gems in the Gemfile(5) still depend on, run \fBbundle update actionpack\fR (see \fBbundle update(1)\fR)\.
.P
\fBSummary\fR: In general, after making a change to the Gemfile(5) , you should first try to run \fBbundle install\fR, which will guarantee that no other gem in the Gemfile(5) is impacted by the change\. If that does not work, run bundle update(1) \fIbundle\-update\.1\.html\fR\.
.SH "SEE ALSO"
.IP "\(bu" 4
Gem install docs \fIhttps://guides\.rubygems\.org/rubygems\-basics/#installing\-gems\fR
.IP "\(bu" 4
Rubygems signing docs \fIhttps://guides\.rubygems\.org/security/\fR
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-cache.1 0000644 00000006564 15173517743 0017313 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-CACHE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-cache\fR \- Package your needed \fB\.gem\fR files into your application
.SH "SYNOPSIS"
\fBbundle cache\fR
.P
alias: \fBpackage\fR, \fBpack\fR
.SH "DESCRIPTION"
Copy all of the \fB\.gem\fR files needed to run the application into the \fBvendor/cache\fR directory\. In the future, when running \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR, use the gems in the cache in preference to the ones on \fBrubygems\.org\fR\.
.SH "GIT AND PATH GEMS"
The \fBbundle cache\fR command can also package \fB:git\fR and \fB:path\fR dependencies besides \.gem files\. This needs to be explicitly enabled via the \fB\-\-all\fR option\. Once used, the \fB\-\-all\fR option will be remembered\.
.SH "SUPPORT FOR MULTIPLE PLATFORMS"
When using gems that have different packages for different platforms, Bundler supports caching of gems for other platforms where the Gemfile has been resolved (i\.e\. present in the lockfile) in \fBvendor/cache\fR\. This needs to be enabled via the \fB\-\-all\-platforms\fR option\. This setting will be remembered in your local bundler configuration\.
.SH "REMOTE FETCHING"
By default, if you run \fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR after running bundle cache(1) \fIbundle\-cache\.1\.html\fR, bundler will still connect to \fBrubygems\.org\fR to check whether a platform\-specific gem exists for any of the gems in \fBvendor/cache\fR\.
.P
For instance, consider this Gemfile(5):
.IP "" 4
.nf
source "https://rubygems\.org"
gem "nokogiri"
.fi
.IP "" 0
.P
If you run \fBbundle cache\fR under C Ruby, bundler will retrieve the version of \fBnokogiri\fR for the \fB"ruby"\fR platform\. If you deploy to JRuby and run \fBbundle install\fR, bundler is forced to check to see whether a \fB"java"\fR platformed \fBnokogiri\fR exists\.
.P
Even though the \fBnokogiri\fR gem for the Ruby platform is \fItechnically\fR acceptable on JRuby, it has a C extension that does not run on JRuby\. As a result, bundler will, by default, still connect to \fBrubygems\.org\fR to check whether it has a version of one of your gems more specific to your platform\.
.P
This problem is also not limited to the \fB"java"\fR platform\. A similar (common) problem can happen when developing on Windows and deploying to Linux, or even when developing on OSX and deploying to Linux\.
.P
If you know for sure that the gems packaged in \fBvendor/cache\fR are appropriate for the platform you are on, you can run \fBbundle install \-\-local\fR to skip checking for more appropriate gems, and use the ones in \fBvendor/cache\fR\.
.P
One way to be sure that you have the right platformed versions of all your gems is to run \fBbundle cache\fR on an identical machine and check in the gems\. For instance, you can run \fBbundle cache\fR on an identical staging box during your staging process, and check in the \fBvendor/cache\fR before deploying to production\.
.P
By default, bundle cache(1) \fIbundle\-cache\.1\.html\fR fetches and also installs the gems to the default location\. To package the dependencies to \fBvendor/cache\fR without installing them to the local install location, you can run \fBbundle cache \-\-no\-install\fR\.
.SH "HISTORY"
In Bundler 2\.1, \fBcache\fR took in the functionalities of \fBpackage\fR and now \fBpackage\fR and \fBpack\fR are aliases of \fBcache\fR\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-update.1.ronn 0000644 00000031002 15173517743 0020466 0 ustar 00 bundle-update(1) -- Update your gems to the latest available versions
=====================================================================
## SYNOPSIS
`bundle update` <*gems> [--all]
[--group=NAME]
[--source=NAME]
[--local]
[--ruby]
[--bundler[=VERSION]]
[--full-index]
[--jobs=JOBS]
[--quiet]
[--patch|--minor|--major]
[--redownload]
[--strict]
[--conservative]
## DESCRIPTION
Update the gems specified (all gems, if `--all` flag is used), ignoring
the previously installed gems specified in the `Gemfile.lock`. In
general, you should use [bundle install(1)](bundle-install.1.html) to install the same exact
gems and versions across machines.
You would use `bundle update` to explicitly update the version of a
gem.
## OPTIONS
* `--all`:
Update all gems specified in Gemfile.
* `--group=<name>`, `-g=[<name>]`:
Only update the gems in the specified group. For instance, you can update all gems
in the development group with `bundle update --group development`. You can also
call `bundle update rails --group test` to update the rails gem and all gems in
the test group, for example.
* `--source=<name>`:
The name of a `:git` or `:path` source used in the Gemfile(5). For
instance, with a `:git` source of `http://github.com/rails/rails.git`,
you would call `bundle update --source rails`
* `--local`:
Do not attempt to fetch gems remotely and use the gem cache instead.
* `--ruby`:
Update the locked version of Ruby to the current version of Ruby.
* `--bundler`:
Update the locked version of bundler to the invoked bundler version.
* `--full-index`:
Fall back to using the single-file index of all gems.
* `--jobs=[<number>]`, `-j[<number>]`:
Specify the number of jobs to run in parallel. The default is the number of
available processors.
* `--retry=[<number>]`:
Retry failed network or git requests for <number> times.
* `--quiet`:
Only output warnings and errors.
* `--redownload`:
Force downloading every gem.
* `--patch`:
Prefer updating only to next patch version.
* `--minor`:
Prefer updating only to next minor version.
* `--major`:
Prefer updating to next major version (default).
* `--strict`:
Do not allow any gem to be updated past latest `--patch` | `--minor` | `--major`.
* `--conservative`:
Use bundle install conservative update behavior and do not allow indirect dependencies to be updated.
## UPDATING ALL GEMS
If you run `bundle update --all`, bundler will ignore
any previously installed gems and resolve all dependencies again
based on the latest versions of all gems available in the sources.
Consider the following Gemfile(5):
source "https://rubygems.org"
gem "rails", "3.0.0.rc"
gem "nokogiri"
When you run [bundle install(1)](bundle-install.1.html) the first time, bundler will resolve
all of the dependencies, all the way down, and install what you need:
Fetching gem metadata from https://rubygems.org/.........
Resolving dependencies...
Installing builder 2.1.2
Installing abstract 1.0.0
Installing rack 1.2.8
Using bundler 1.7.6
Installing rake 10.4.0
Installing polyglot 0.3.5
Installing mime-types 1.25.1
Installing i18n 0.4.2
Installing mini_portile 0.6.1
Installing tzinfo 0.3.42
Installing rack-mount 0.6.14
Installing rack-test 0.5.7
Installing treetop 1.4.15
Installing thor 0.14.6
Installing activesupport 3.0.0.rc
Installing erubis 2.6.6
Installing activemodel 3.0.0.rc
Installing arel 0.4.0
Installing mail 2.2.20
Installing activeresource 3.0.0.rc
Installing actionpack 3.0.0.rc
Installing activerecord 3.0.0.rc
Installing actionmailer 3.0.0.rc
Installing railties 3.0.0.rc
Installing rails 3.0.0.rc
Installing nokogiri 1.6.5
Bundle complete! 2 Gemfile dependencies, 26 gems total.
Use `bundle show [gemname]` to see where a bundled gem is installed.
As you can see, even though you have two gems in the Gemfile(5), your application
needs 26 different gems in order to run. Bundler remembers the exact versions
it installed in `Gemfile.lock`. The next time you run [bundle install(1)](bundle-install.1.html), bundler skips
the dependency resolution and installs the same gems as it installed last time.
After checking in the `Gemfile.lock` into version control and cloning it on another
machine, running [bundle install(1)](bundle-install.1.html) will _still_ install the gems that you installed
last time. You don't need to worry that a new release of `erubis` or `mail` changes
the gems you use.
However, from time to time, you might want to update the gems you are using to the
newest versions that still match the gems in your Gemfile(5).
To do this, run `bundle update --all`, which will ignore the `Gemfile.lock`, and resolve
all the dependencies again. Keep in mind that this process can result in a significantly
different set of the 25 gems, based on the requirements of new gems that the gem
authors released since the last time you ran `bundle update --all`.
## UPDATING A LIST OF GEMS
Sometimes, you want to update a single gem in the Gemfile(5), and leave the rest of the
gems that you specified locked to the versions in the `Gemfile.lock`.
For instance, in the scenario above, imagine that `nokogiri` releases version `1.4.4`, and
you want to update it _without_ updating Rails and all of its dependencies. To do this,
run `bundle update nokogiri`.
Bundler will update `nokogiri` and any of its dependencies, but leave alone Rails and
its dependencies.
## OVERLAPPING DEPENDENCIES
Sometimes, multiple gems declared in your Gemfile(5) are satisfied by the same
second-level dependency. For instance, consider the case of `thin` and
`rack-perftools-profiler`.
source "https://rubygems.org"
gem "thin"
gem "rack-perftools-profiler"
The `thin` gem depends on `rack >= 1.0`, while `rack-perftools-profiler` depends
on `rack ~> 1.0`. If you run bundle install, you get:
Fetching source index for https://rubygems.org/
Installing daemons (1.1.0)
Installing eventmachine (0.12.10) with native extensions
Installing open4 (1.0.1)
Installing perftools.rb (0.4.7) with native extensions
Installing rack (1.2.1)
Installing rack-perftools_profiler (0.0.2)
Installing thin (1.2.7) with native extensions
Using bundler (1.0.0.rc.3)
In this case, the two gems have their own set of dependencies, but they share
`rack` in common. If you run `bundle update thin`, bundler will update `daemons`,
`eventmachine` and `rack`, which are dependencies of `thin`, but not `open4` or
`perftools.rb`, which are dependencies of `rack-perftools_profiler`. Note that
`bundle update thin` will update `rack` even though it's _also_ a dependency of
`rack-perftools_profiler`.
In short, by default, when you update a gem using `bundle update`, bundler will
update all dependencies of that gem, including those that are also dependencies
of another gem.
To prevent updating indirect dependencies, prior to version 1.14 the only option
was the `CONSERVATIVE UPDATING` behavior in [bundle install(1)](bundle-install.1.html):
In this scenario, updating the `thin` version manually in the Gemfile(5),
and then running [bundle install(1)](bundle-install.1.html) will only update `daemons` and `eventmachine`,
but not `rack`. For more information, see the `CONSERVATIVE UPDATING` section
of [bundle install(1)](bundle-install.1.html).
Starting with 1.14, specifying the `--conservative` option will also prevent indirect
dependencies from being updated.
## PATCH LEVEL OPTIONS
Version 1.14 introduced 4 patch-level options that will influence how gem
versions are resolved. One of the following options can be used: `--patch`,
`--minor` or `--major`. `--strict` can be added to further influence resolution.
* `--patch`:
Prefer updating only to next patch version.
* `--minor`:
Prefer updating only to next minor version.
* `--major`:
Prefer updating to next major version (default).
* `--strict`:
Do not allow any gem to be updated past latest `--patch` | `--minor` | `--major`.
When Bundler is resolving what versions to use to satisfy declared
requirements in the Gemfile or in parent gems, it looks up all
available versions, filters out any versions that don't satisfy
the requirement, and then, by default, sorts them from newest to
oldest, considering them in that order.
Providing one of the patch level options (e.g. `--patch`) changes the
sort order of the satisfying versions, causing Bundler to consider the
latest `--patch` or `--minor` version available before other versions.
Note that versions outside the stated patch level could still be
resolved to if necessary to find a suitable dependency graph.
For example, if gem 'foo' is locked at 1.0.2, with no gem requirement
defined in the Gemfile, and versions 1.0.3, 1.0.4, 1.1.0, 1.1.1, 2.0.0
all exist, the default order of preference by default (`--major`) will
be "2.0.0, 1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2".
If the `--patch` option is used, the order of preference will change to
"1.0.4, 1.0.3, 1.0.2, 1.1.1, 1.1.0, 2.0.0".
If the `--minor` option is used, the order of preference will change to
"1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2, 2.0.0".
Combining the `--strict` option with any of the patch level options
will remove any versions beyond the scope of the patch level option,
to ensure that no gem is updated that far.
To continue the previous example, if both `--patch` and `--strict`
options are used, the available versions for resolution would be
"1.0.4, 1.0.3, 1.0.2". If `--minor` and `--strict` are used, it would
be "1.1.1, 1.1.0, 1.0.4, 1.0.3, 1.0.2".
Gem requirements as defined in the Gemfile will still be the first
determining factor for what versions are available. If the gem
requirement for `foo` in the Gemfile is '~> 1.0', that will accomplish
the same thing as providing the `--minor` and `--strict` options.
## PATCH LEVEL EXAMPLES
Given the following gem specifications:
foo 1.4.3, requires: ~> bar 2.0
foo 1.4.4, requires: ~> bar 2.0
foo 1.4.5, requires: ~> bar 2.1
foo 1.5.0, requires: ~> bar 2.1
foo 1.5.1, requires: ~> bar 3.0
bar with versions 2.0.3, 2.0.4, 2.1.0, 2.1.1, 3.0.0
Gemfile:
gem 'foo'
Gemfile.lock:
foo (1.4.3)
bar (~> 2.0)
bar (2.0.3)
Cases:
# Command Line Result
------------------------------------------------------------
1 bundle update --patch 'foo 1.4.5', 'bar 2.1.1'
2 bundle update --patch foo 'foo 1.4.5', 'bar 2.1.1'
3 bundle update --minor 'foo 1.5.1', 'bar 3.0.0'
4 bundle update --minor --strict 'foo 1.5.0', 'bar 2.1.1'
5 bundle update --patch --strict 'foo 1.4.4', 'bar 2.0.4'
In case 1, bar is upgraded to 2.1.1, a minor version increase, because
the dependency from foo 1.4.5 required it.
In case 2, only foo is requested to be unlocked, but bar is also
allowed to move because it's not a declared dependency in the Gemfile.
In case 3, bar goes up a whole major release, because a minor increase
is preferred now for foo, and when it goes to 1.5.1, it requires 3.0.0
of bar.
In case 4, foo is preferred up to a minor version, but 1.5.1 won't work
because the --strict flag removes bar 3.0.0 from consideration since
it's a major increment.
In case 5, both foo and bar have any minor or major increments removed
from consideration because of the --strict flag, so the most they can
move is up to 1.4.4 and 2.0.4.
## RECOMMENDED WORKFLOW
In general, when working with an application managed with bundler, you should
use the following workflow:
* After you create your Gemfile(5) for the first time, run
$ bundle install
* Check the resulting `Gemfile.lock` into version control
$ git add Gemfile.lock
* When checking out this repository on another development machine, run
$ bundle install
* When checking out this repository on a deployment machine, run
$ bundle install --deployment
* After changing the Gemfile(5) to reflect a new or update dependency, run
$ bundle install
* Make sure to check the updated `Gemfile.lock` into version control
$ git add Gemfile.lock
* If [bundle install(1)](bundle-install.1.html) reports a conflict, manually update the specific
gems that you changed in the Gemfile(5)
$ bundle update rails thin
* If you want to update all the gems to the latest possible versions that
still match the gems listed in the Gemfile(5), run
$ bundle update --all
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-add.1 0000644 00000004773 15173517743 0017000 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-ADD" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-add\fR \- Add gem to the Gemfile and run bundle install
.SH "SYNOPSIS"
\fBbundle add\fR \fIGEM_NAME\fR [\-\-group=GROUP] [\-\-version=VERSION] [\-\-source=SOURCE] [\-\-path=PATH] [\-\-git=GIT|\-\-github=GITHUB] [\-\-branch=BRANCH] [\-\-ref=REF] [\-\-skip\-install] [\-\-strict|\-\-optimistic]
.SH "DESCRIPTION"
Adds the named gem to the [\fBGemfile(5)\fR][Gemfile(5)] and run \fBbundle install\fR\. \fBbundle install\fR can be avoided by using the flag \fB\-\-skip\-install\fR\.
.SH "OPTIONS"
.TP
\fB\-\-version\fR, \fB\-v\fR
Specify version requirements(s) for the added gem\.
.TP
\fB\-\-group\fR, \fB\-g\fR
Specify the group(s) for the added gem\. Multiple groups should be separated by commas\.
.TP
\fB\-\-source\fR, \fB\-s\fR
Specify the source for the added gem\.
.TP
\fB\-\-require\fR, \fB\-r\fR
Adds require path to gem\. Provide false, or a path as a string\.
.TP
\fB\-\-path\fR
Specify the file system path for the added gem\.
.TP
\fB\-\-git\fR
Specify the git source for the added gem\.
.TP
\fB\-\-github\fR
Specify the github source for the added gem\.
.TP
\fB\-\-branch\fR
Specify the git branch for the added gem\.
.TP
\fB\-\-ref\fR
Specify the git ref for the added gem\.
.TP
\fB\-\-skip\-install\fR
Adds the gem to the Gemfile but does not install it\.
.TP
\fB\-\-optimistic\fR
Adds optimistic declaration of version\.
.TP
\fB\-\-strict\fR
Adds strict declaration of version\.
.SH "EXAMPLES"
.IP "1." 4
You can add the \fBrails\fR gem to the Gemfile without any version restriction\. The source of the gem will be the global source\.
.IP
\fBbundle add rails\fR
.IP "2." 4
You can add the \fBrails\fR gem with version greater than 1\.1 (not including 1\.1) and less than 3\.0\.
.IP
\fBbundle add rails \-\-version "> 1\.1, < 3\.0"\fR
.IP "3." 4
You can use the \fBhttps://gems\.example\.com\fR custom source and assign the gem to a group\.
.IP
\fBbundle add rails \-\-version "~> 5\.0\.0" \-\-source "https://gems\.example\.com" \-\-group "development"\fR
.IP "4." 4
The following adds the \fBgem\fR entry to the Gemfile without installing the gem\. You can install gems later via \fBbundle install\fR\.
.IP
\fBbundle add rails \-\-skip\-install\fR
.IP "5." 4
You can assign the gem to more than one group\.
.IP
\fBbundle add rails \-\-group "development, test"\fR
.IP "" 0
.SH "SEE ALSO"
Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR, bundle\-remove(1) \fIbundle\-remove\.1\.html\fR
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-open.1.ronn 0000644 00000001176 15173517743 0020156 0 ustar 00 bundle-open(1) -- Opens the source directory for a gem in your bundle
=====================================================================
## SYNOPSIS
`bundle open` [GEM] [--path=PATH]
## DESCRIPTION
Opens the source directory of the provided GEM in your editor.
For this to work the `EDITOR` or `BUNDLER_EDITOR` environment variable has to
be set.
Example:
bundle open 'rack'
Will open the source directory for the 'rack' gem in your bundle.
bundle open 'rack' --path 'README.md'
Will open the README.md file of the 'rack' gem source in your bundle.
## OPTIONS
* `--path`:
Specify GEM source relative path to open.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-remove.1 0000644 00000001504 15173517743 0017532 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-REMOVE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-remove\fR \- Removes gems from the Gemfile
.SH "SYNOPSIS"
\fBbundle remove [GEM [GEM \|\.\|\.\|\.]] [\-\-install]\fR
.SH "DESCRIPTION"
Removes the given gems from the Gemfile while ensuring that the resulting Gemfile is still valid\. If a gem cannot be removed, a warning is printed\. If a gem is already absent from the Gemfile, and error is raised\.
.SH "OPTIONS"
.TP
\fB\-\-install\fR
Runs \fBbundle install\fR after the given gems have been removed from the Gemfile, which ensures that both the lockfile and the installed gems on disk are also updated to remove the given gem(s)\.
.P
Example:
.P
bundle remove rails
.P
bundle remove rails rack
.P
bundle remove rails rack \-\-install
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-lock.1.ronn 0000644 00000005735 15173517743 0020152 0 ustar 00 bundle-lock(1) -- Creates / Updates a lockfile without installing
=================================================================
## SYNOPSIS
`bundle lock` [--update]
[--local]
[--print]
[--lockfile=PATH]
[--full-index]
[--add-platform]
[--remove-platform]
[--patch]
[--minor]
[--major]
[--strict]
[--conservative]
## DESCRIPTION
Lock the gems specified in Gemfile.
## OPTIONS
* `--update=<*gems>`:
Ignores the existing lockfile. Resolve then updates lockfile. Taking a list
of gems or updating all gems if no list is given.
* `--local`:
Do not attempt to connect to `rubygems.org`. Instead, Bundler will use the
gems already present in Rubygems' cache or in `vendor/cache`. Note that if a
appropriate platform-specific gem exists on `rubygems.org` it will not be
found.
* `--print`:
Prints the lockfile to STDOUT instead of writing to the file system.
* `--lockfile=<path>`:
The path where the lockfile should be written to.
* `--full-index`:
Fall back to using the single-file index of all gems.
* `--add-platform`:
Add a new platform to the lockfile, re-resolving for the addition of that
platform.
* `--remove-platform`:
Remove a platform from the lockfile.
* `--patch`:
If updating, prefer updating only to next patch version.
* `--minor`:
If updating, prefer updating only to next minor version.
* `--major`:
If updating, prefer updating to next major version (default).
* `--strict`:
If updating, do not allow any gem to be updated past latest --patch | --minor | --major.
* `--conservative`:
If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated.
## UPDATING ALL GEMS
If you run `bundle lock` with `--update` option without list of gems, bundler will
ignore any previously installed gems and resolve all dependencies again based
on the latest versions of all gems available in the sources.
## UPDATING A LIST OF GEMS
Sometimes, you want to update a single gem in the Gemfile(5), and leave the rest of
the gems that you specified locked to the versions in the `Gemfile.lock`.
For instance, you only want to update `nokogiri`, run `bundle lock --update nokogiri`.
Bundler will update `nokogiri` and any of its dependencies, but leave the rest of the
gems that you specified locked to the versions in the `Gemfile.lock`.
## SUPPORTING OTHER PLATFORMS
If you want your bundle to support platforms other than the one you're running
locally, you can run `bundle lock --add-platform PLATFORM` to add PLATFORM to
the lockfile, force bundler to re-resolve and consider the new platform when
picking gems, all without needing to have a machine that matches PLATFORM handy
to install those platform-specific gems on.
For a full explanation of gem platforms, see `gem help platform`.
## PATCH LEVEL OPTIONS
See [bundle update(1)](bundle-update.1.html) for details.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-help.1 0000644 00000000700 15173517743 0017162 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-HELP" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-help\fR \- Displays detailed help for each subcommand
.SH "SYNOPSIS"
\fBbundle help\fR [COMMAND]
.SH "DESCRIPTION"
Displays detailed help for the given subcommand\. You can specify a single \fBCOMMAND\fR at the same time\. When \fBCOMMAND\fR is omitted, help for \fBhelp\fR command will be displayed\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-info.1.ronn 0000644 00000000622 15173517743 0020143 0 ustar 00 bundle-info(1) -- Show information for the given gem in your bundle
=========================================================================
## SYNOPSIS
`bundle info` [GEM_NAME]
[--path]
## DESCRIPTION
Given a gem name present in your bundle, print the basic information about it
such as homepage, version, path and summary.
## OPTIONS
* `--path`:
Print the path of the given gem
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-exec.1.ronn 0000644 00000013524 15173517743 0020141 0 ustar 00 bundle-exec(1) -- Execute a command in the context of the bundle
================================================================
## SYNOPSIS
`bundle exec` [--keep-file-descriptors] <command>
## DESCRIPTION
This command executes the command, making all gems specified in the
[`Gemfile(5)`][Gemfile(5)] available to `require` in Ruby programs.
Essentially, if you would normally have run something like
`rspec spec/my_spec.rb`, and you want to use the gems specified
in the [`Gemfile(5)`][Gemfile(5)] and installed via [bundle install(1)](bundle-install.1.html), you
should run `bundle exec rspec spec/my_spec.rb`.
Note that `bundle exec` does not require that an executable is
available on your shell's `$PATH`.
## OPTIONS
* `--keep-file-descriptors`:
Passes all file descriptors to the new processes. Default is true from
bundler version 2.2.26. Setting it to false is now deprecated.
## BUNDLE INSTALL --BINSTUBS
If you use the `--binstubs` flag in [bundle install(1)](bundle-install.1.html), Bundler will
automatically create a directory (which defaults to `app_root/bin`)
containing all of the executables available from gems in the bundle.
After using `--binstubs`, `bin/rspec spec/my_spec.rb` is identical
to `bundle exec rspec spec/my_spec.rb`.
## ENVIRONMENT MODIFICATIONS
`bundle exec` makes a number of changes to the shell environment,
then executes the command you specify in full.
* make sure that it's still possible to shell out to `bundle`
from inside a command invoked by `bundle exec` (using
`$BUNDLE_BIN_PATH`)
* put the directory containing executables (like `rails`, `rspec`,
`rackup`) for your bundle on `$PATH`
* make sure that if bundler is invoked in the subshell, it uses
the same `Gemfile` (by setting `BUNDLE_GEMFILE`)
* add `-rbundler/setup` to `$RUBYOPT`, which makes sure that
Ruby programs invoked in the subshell can see the gems in
the bundle
It also modifies Rubygems:
* disallow loading additional gems not in the bundle
* modify the `gem` method to be a no-op if a gem matching
the requirements is in the bundle, and to raise a
`Gem::LoadError` if it's not
* Define `Gem.refresh` to be a no-op, since the source
index is always frozen when using bundler, and to
prevent gems from the system leaking into the environment
* Override `Gem.bin_path` to use the gems in the bundle,
making system executables work
* Add all gems in the bundle into Gem.loaded_specs
Finally, `bundle exec` also implicitly modifies `Gemfile.lock` if the lockfile
and the Gemfile do not match. Bundler needs the Gemfile to determine things
such as a gem's groups, `autorequire`, and platforms, etc., and that
information isn't stored in the lockfile. The Gemfile and lockfile must be
synced in order to `bundle exec` successfully, so `bundle exec`
updates the lockfile beforehand.
### Loading
By default, when attempting to `bundle exec` to a file with a ruby shebang,
Bundler will `Kernel.load` that file instead of using `Kernel.exec`. For the
vast majority of cases, this is a performance improvement. In a rare few cases,
this could cause some subtle side-effects (such as dependence on the exact
contents of `$0` or `__FILE__`) and the optimization can be disabled by enabling
the `disable_exec_load` setting.
### Shelling out
Any Ruby code that opens a subshell (like `system`, backticks, or `%x{}`) will
automatically use the current Bundler environment. If you need to shell out to
a Ruby command that is not part of your current bundle, use the
`with_unbundled_env` method with a block. Any subshells created inside the block
will be given the environment present before Bundler was activated. For
example, Homebrew commands run Ruby, but don't work inside a bundle:
Bundler.with_unbundled_env do
`brew install wget`
end
Using `with_unbundled_env` is also necessary if you are shelling out to a different
bundle. Any Bundler commands run in a subshell will inherit the current
Gemfile, so commands that need to run in the context of a different bundle also
need to use `with_unbundled_env`.
Bundler.with_unbundled_env do
Dir.chdir "/other/bundler/project" do
`bundle exec ./script`
end
end
Bundler provides convenience helpers that wrap `system` and `exec`, and they
can be used like this:
Bundler.clean_system('brew install wget')
Bundler.clean_exec('brew install wget')
## RUBYGEMS PLUGINS
At present, the Rubygems plugin system requires all files
named `rubygems_plugin.rb` on the load path of _any_ installed
gem when any Ruby code requires `rubygems.rb`. This includes
executables installed into the system, like `rails`, `rackup`,
and `rspec`.
Since Rubygems plugins can contain arbitrary Ruby code, they
commonly end up activating themselves or their dependencies.
For instance, the `gemcutter 0.5` gem depended on `json_pure`.
If you had that version of gemcutter installed (even if
you _also_ had a newer version without this problem), Rubygems
would activate `gemcutter 0.5` and `json_pure <latest>`.
If your Gemfile(5) also contained `json_pure` (or a gem
with a dependency on `json_pure`), the latest version on
your system might conflict with the version in your
Gemfile(5), or the snapshot version in your `Gemfile.lock`.
If this happens, bundler will say:
You have already activated json_pure 1.4.6 but your Gemfile
requires json_pure 1.4.3. Consider using bundle exec.
In this situation, you almost certainly want to remove the
underlying gem with the problematic gem plugin. In general,
the authors of these plugins (in this case, the `gemcutter`
gem) have released newer versions that are more careful in
their plugins.
You can find a list of all the gems containing gem plugins
by running
ruby -e "puts Gem.find_files('rubygems_plugin.rb')"
At the very least, you should remove all but the newest
version of each gem plugin, and also remove all gem plugins
that you aren't using (`gem uninstall gem_name`).
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-binstubs.1 0000644 00000003067 15173517743 0020074 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-BINSTUBS" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-binstubs\fR \- Install the binstubs of the listed gems
.SH "SYNOPSIS"
\fBbundle binstubs\fR \fIGEM_NAME\fR [\-\-force] [\-\-path PATH] [\-\-standalone]
.SH "DESCRIPTION"
Binstubs are scripts that wrap around executables\. Bundler creates a small Ruby file (a binstub) that loads Bundler, runs the command, and puts it into \fBbin/\fR\. Binstubs are a shortcut\-or alternative\- to always using \fBbundle exec\fR\. This gives you a file that can be run directly, and one that will always run the correct gem version used by the application\.
.P
For example, if you run \fBbundle binstubs rspec\-core\fR, Bundler will create the file \fBbin/rspec\fR\. That file will contain enough code to load Bundler, tell it to load the bundled gems, and then run rspec\.
.P
This command generates binstubs for executables in \fBGEM_NAME\fR\. Binstubs are put into \fBbin\fR, or the \fB\-\-path\fR directory if one has been set\. Calling binstubs with [GEM [GEM]] will create binstubs for all given gems\.
.SH "OPTIONS"
.TP
\fB\-\-force\fR
Overwrite existing binstubs if they exist\.
.TP
\fB\-\-path\fR
The location to install the specified binstubs to\. This defaults to \fBbin\fR\.
.TP
\fB\-\-standalone\fR
Makes binstubs that can work without depending on Rubygems or Bundler at runtime\.
.TP
\fB\-\-shebang\fR
Specify a different shebang executable name than the default (default 'ruby')
.TP
\fB\-\-all\fR
Create binstubs for all gems in the bundle\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-gem.1.ronn 0000644 00000011566 15173517743 0017771 0 ustar 00 bundle-gem(1) -- Generate a project skeleton for creating a rubygem
====================================================================
## SYNOPSIS
`bundle gem` <GEM_NAME> [OPTIONS]
## DESCRIPTION
Generates a directory named `GEM_NAME` with a `Rakefile`, `GEM_NAME.gemspec`,
and other supporting files and directories that can be used to develop a
rubygem with that name.
Run `rake -T` in the resulting project for a list of Rake tasks that can be used
to test and publish the gem to rubygems.org.
The generated project skeleton can be customized with OPTIONS, as explained
below. Note that these options can also be specified via Bundler's global
configuration file using the following names:
* `gem.coc`
* `gem.mit`
* `gem.test`
## OPTIONS
* `--exe` or `-b` or `--bin`:
Specify that Bundler should create a binary executable (as `exe/GEM_NAME`)
in the generated rubygem project. This binary will also be added to the
`GEM_NAME.gemspec` manifest. This behavior is disabled by default.
* `--no-exe`:
Do not create a binary (overrides `--exe` specified in the global config).
* `--coc`:
Add a `CODE_OF_CONDUCT.md` file to the root of the generated project. If
this option is unspecified, an interactive prompt will be displayed and the
answer will be saved in Bundler's global config for future `bundle gem` use.
* `--no-coc`:
Do not create a `CODE_OF_CONDUCT.md` (overrides `--coc` specified in the
global config).
* `--ext=c`, `--ext=rust`
Add boilerplate for C or Rust (currently [magnus](https://docs.rs/magnus) based) extension code to the generated project. This behavior
is disabled by default.
* `--no-ext`:
Do not add extension code (overrides `--ext` specified in the global
config).
* `--mit`:
Add an MIT license to a `LICENSE.txt` file in the root of the generated
project. Your name from the global git config is used for the copyright
statement. If this option is unspecified, an interactive prompt will be
displayed and the answer will be saved in Bundler's global config for future
`bundle gem` use.
* `--no-mit`:
Do not create a `LICENSE.txt` (overrides `--mit` specified in the global
config).
* `-t`, `--test=minitest`, `--test=rspec`, `--test=test-unit`:
Specify the test framework that Bundler should use when generating the
project. Acceptable values are `minitest`, `rspec` and `test-unit`. The
`GEM_NAME.gemspec` will be configured and a skeleton test/spec directory will
be created based on this option. Given no option is specified:
When Bundler is configured to generate tests, this defaults to Bundler's
global config setting `gem.test`.
When Bundler is configured to not generate tests, an interactive prompt will
be displayed and the answer will be used for the current rubygem project.
When Bundler is unconfigured, an interactive prompt will be displayed and
the answer will be saved in Bundler's global config for future `bundle gem`
use.
* `--no-test`:
Do not use a test framework (overrides `--test` specified in the global
config).
* `--ci`, `--ci=github`, `--ci=gitlab`, `--ci=circle`:
Specify the continuous integration service that Bundler should use when
generating the project. Acceptable values are `github`, `gitlab`
and `circle`. A configuration file will be generated in the project directory.
Given no option is specified:
When Bundler is configured to generate CI files, this defaults to Bundler's
global config setting `gem.ci`.
When Bundler is configured to not generate CI files, an interactive prompt
will be displayed and the answer will be used for the current rubygem project.
When Bundler is unconfigured, an interactive prompt will be displayed and
the answer will be saved in Bundler's global config for future `bundle gem`
use.
* `--no-ci`:
Do not use a continuous integration service (overrides `--ci` specified in
the global config).
* `--linter`, `--linter=rubocop`, `--linter=standard`:
Specify the linter and code formatter that Bundler should add to the
project's development dependencies. Acceptable values are `rubocop` and
`standard`. A configuration file will be generated in the project directory.
Given no option is specified:
When Bundler is configured to add a linter, this defaults to Bundler's
global config setting `gem.linter`.
When Bundler is configured not to add a linter, an interactive prompt
will be displayed and the answer will be used for the current rubygem project.
When Bundler is unconfigured, an interactive prompt will be displayed and
the answer will be saved in Bundler's global config for future `bundle gem`
use.
* `--no-linter`:
Do not add a linter (overrides `--linter` specified in the global config).
* `-e`, `--edit[=EDITOR]`:
Open the resulting GEM_NAME.gemspec in EDITOR, or the default editor if not
specified. The default is `$BUNDLER_EDITOR`, `$VISUAL`, or `$EDITOR`.
## SEE ALSO
* [bundle config(1)](bundle-config.1.html)
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-list.1.ronn 0000644 00000001424 15173517743 0020164 0 ustar 00 bundle-list(1) -- List all the gems in the bundle
=========================================================================
## SYNOPSIS
`bundle list` [--name-only] [--paths] [--without-group=GROUP[ GROUP...]] [--only-group=GROUP[ GROUP...]]
## DESCRIPTION
Prints a list of all the gems in the bundle including their version.
Example:
bundle list --name-only
bundle list --paths
bundle list --without-group test
bundle list --only-group dev
bundle list --only-group dev test --paths
## OPTIONS
* `--name-only`:
Print only the name of each gem.
* `--paths`:
Print the path to each gem in the bundle.
* `--without-group=<list>`:
A space-separated list of groups of gems to skip during printing.
* `--only-group=<list>`:
A space-separated list of groups of gems to print.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-exec.1 0000644 00000014702 15173517743 0017165 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-EXEC" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-exec\fR \- Execute a command in the context of the bundle
.SH "SYNOPSIS"
\fBbundle exec\fR [\-\-keep\-file\-descriptors] \fIcommand\fR
.SH "DESCRIPTION"
This command executes the command, making all gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] available to \fBrequire\fR in Ruby programs\.
.P
Essentially, if you would normally have run something like \fBrspec spec/my_spec\.rb\fR, and you want to use the gems specified in the [\fBGemfile(5)\fR][Gemfile(5)] and installed via bundle install(1) \fIbundle\-install\.1\.html\fR, you should run \fBbundle exec rspec spec/my_spec\.rb\fR\.
.P
Note that \fBbundle exec\fR does not require that an executable is available on your shell's \fB$PATH\fR\.
.SH "OPTIONS"
.TP
\fB\-\-keep\-file\-descriptors\fR
Passes all file descriptors to the new processes\. Default is true from bundler version 2\.2\.26\. Setting it to false is now deprecated\.
.SH "BUNDLE INSTALL \-\-BINSTUBS"
If you use the \fB\-\-binstubs\fR flag in bundle install(1) \fIbundle\-install\.1\.html\fR, Bundler will automatically create a directory (which defaults to \fBapp_root/bin\fR) containing all of the executables available from gems in the bundle\.
.P
After using \fB\-\-binstubs\fR, \fBbin/rspec spec/my_spec\.rb\fR is identical to \fBbundle exec rspec spec/my_spec\.rb\fR\.
.SH "ENVIRONMENT MODIFICATIONS"
\fBbundle exec\fR makes a number of changes to the shell environment, then executes the command you specify in full\.
.IP "\(bu" 4
make sure that it's still possible to shell out to \fBbundle\fR from inside a command invoked by \fBbundle exec\fR (using \fB$BUNDLE_BIN_PATH\fR)
.IP "\(bu" 4
put the directory containing executables (like \fBrails\fR, \fBrspec\fR, \fBrackup\fR) for your bundle on \fB$PATH\fR
.IP "\(bu" 4
make sure that if bundler is invoked in the subshell, it uses the same \fBGemfile\fR (by setting \fBBUNDLE_GEMFILE\fR)
.IP "\(bu" 4
add \fB\-rbundler/setup\fR to \fB$RUBYOPT\fR, which makes sure that Ruby programs invoked in the subshell can see the gems in the bundle
.IP "" 0
.P
It also modifies Rubygems:
.IP "\(bu" 4
disallow loading additional gems not in the bundle
.IP "\(bu" 4
modify the \fBgem\fR method to be a no\-op if a gem matching the requirements is in the bundle, and to raise a \fBGem::LoadError\fR if it's not
.IP "\(bu" 4
Define \fBGem\.refresh\fR to be a no\-op, since the source index is always frozen when using bundler, and to prevent gems from the system leaking into the environment
.IP "\(bu" 4
Override \fBGem\.bin_path\fR to use the gems in the bundle, making system executables work
.IP "\(bu" 4
Add all gems in the bundle into Gem\.loaded_specs
.IP "" 0
.P
Finally, \fBbundle exec\fR also implicitly modifies \fBGemfile\.lock\fR if the lockfile and the Gemfile do not match\. Bundler needs the Gemfile to determine things such as a gem's groups, \fBautorequire\fR, and platforms, etc\., and that information isn't stored in the lockfile\. The Gemfile and lockfile must be synced in order to \fBbundle exec\fR successfully, so \fBbundle exec\fR updates the lockfile beforehand\.
.SS "Loading"
By default, when attempting to \fBbundle exec\fR to a file with a ruby shebang, Bundler will \fBKernel\.load\fR that file instead of using \fBKernel\.exec\fR\. For the vast majority of cases, this is a performance improvement\. In a rare few cases, this could cause some subtle side\-effects (such as dependence on the exact contents of \fB$0\fR or \fB__FILE__\fR) and the optimization can be disabled by enabling the \fBdisable_exec_load\fR setting\.
.SS "Shelling out"
Any Ruby code that opens a subshell (like \fBsystem\fR, backticks, or \fB%x{}\fR) will automatically use the current Bundler environment\. If you need to shell out to a Ruby command that is not part of your current bundle, use the \fBwith_unbundled_env\fR method with a block\. Any subshells created inside the block will be given the environment present before Bundler was activated\. For example, Homebrew commands run Ruby, but don't work inside a bundle:
.IP "" 4
.nf
Bundler\.with_unbundled_env do
`brew install wget`
end
.fi
.IP "" 0
.P
Using \fBwith_unbundled_env\fR is also necessary if you are shelling out to a different bundle\. Any Bundler commands run in a subshell will inherit the current Gemfile, so commands that need to run in the context of a different bundle also need to use \fBwith_unbundled_env\fR\.
.IP "" 4
.nf
Bundler\.with_unbundled_env do
Dir\.chdir "/other/bundler/project" do
`bundle exec \./script`
end
end
.fi
.IP "" 0
.P
Bundler provides convenience helpers that wrap \fBsystem\fR and \fBexec\fR, and they can be used like this:
.IP "" 4
.nf
Bundler\.clean_system('brew install wget')
Bundler\.clean_exec('brew install wget')
.fi
.IP "" 0
.SH "RUBYGEMS PLUGINS"
At present, the Rubygems plugin system requires all files named \fBrubygems_plugin\.rb\fR on the load path of \fIany\fR installed gem when any Ruby code requires \fBrubygems\.rb\fR\. This includes executables installed into the system, like \fBrails\fR, \fBrackup\fR, and \fBrspec\fR\.
.P
Since Rubygems plugins can contain arbitrary Ruby code, they commonly end up activating themselves or their dependencies\.
.P
For instance, the \fBgemcutter 0\.5\fR gem depended on \fBjson_pure\fR\. If you had that version of gemcutter installed (even if you \fIalso\fR had a newer version without this problem), Rubygems would activate \fBgemcutter 0\.5\fR and \fBjson_pure <latest>\fR\.
.P
If your Gemfile(5) also contained \fBjson_pure\fR (or a gem with a dependency on \fBjson_pure\fR), the latest version on your system might conflict with the version in your Gemfile(5), or the snapshot version in your \fBGemfile\.lock\fR\.
.P
If this happens, bundler will say:
.IP "" 4
.nf
You have already activated json_pure 1\.4\.6 but your Gemfile
requires json_pure 1\.4\.3\. Consider using bundle exec\.
.fi
.IP "" 0
.P
In this situation, you almost certainly want to remove the underlying gem with the problematic gem plugin\. In general, the authors of these plugins (in this case, the \fBgemcutter\fR gem) have released newer versions that are more careful in their plugins\.
.P
You can find a list of all the gems containing gem plugins by running
.IP "" 4
.nf
ruby \-e "puts Gem\.find_files('rubygems_plugin\.rb')"
.fi
.IP "" 0
.P
At the very least, you should remove all but the newest version of each gem plugin, and also remove all gem plugins that you aren't using (\fBgem uninstall gem_name\fR)\.
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-gem.1 0000644 00000012750 15173517743 0017012 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-GEM" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-gem\fR \- Generate a project skeleton for creating a rubygem
.SH "SYNOPSIS"
\fBbundle gem\fR \fIGEM_NAME\fR \fIOPTIONS\fR
.SH "DESCRIPTION"
Generates a directory named \fBGEM_NAME\fR with a \fBRakefile\fR, \fBGEM_NAME\.gemspec\fR, and other supporting files and directories that can be used to develop a rubygem with that name\.
.P
Run \fBrake \-T\fR in the resulting project for a list of Rake tasks that can be used to test and publish the gem to rubygems\.org\.
.P
The generated project skeleton can be customized with OPTIONS, as explained below\. Note that these options can also be specified via Bundler's global configuration file using the following names:
.IP "\(bu" 4
\fBgem\.coc\fR
.IP "\(bu" 4
\fBgem\.mit\fR
.IP "\(bu" 4
\fBgem\.test\fR
.IP "" 0
.SH "OPTIONS"
.IP "\(bu" 4
\fB\-\-exe\fR or \fB\-b\fR or \fB\-\-bin\fR: Specify that Bundler should create a binary executable (as \fBexe/GEM_NAME\fR) in the generated rubygem project\. This binary will also be added to the \fBGEM_NAME\.gemspec\fR manifest\. This behavior is disabled by default\.
.IP "\(bu" 4
\fB\-\-no\-exe\fR: Do not create a binary (overrides \fB\-\-exe\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-coc\fR: Add a \fBCODE_OF_CONDUCT\.md\fR file to the root of the generated project\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-coc\fR: Do not create a \fBCODE_OF_CONDUCT\.md\fR (overrides \fB\-\-coc\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-ext=c\fR, \fB\-\-ext=rust\fR Add boilerplate for C or Rust (currently magnus \fIhttps://docs\.rs/magnus\fR based) extension code to the generated project\. This behavior is disabled by default\.
.IP "\(bu" 4
\fB\-\-no\-ext\fR: Do not add extension code (overrides \fB\-\-ext\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-mit\fR: Add an MIT license to a \fBLICENSE\.txt\fR file in the root of the generated project\. Your name from the global git config is used for the copyright statement\. If this option is unspecified, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-mit\fR: Do not create a \fBLICENSE\.txt\fR (overrides \fB\-\-mit\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-t\fR, \fB\-\-test=minitest\fR, \fB\-\-test=rspec\fR, \fB\-\-test=test\-unit\fR: Specify the test framework that Bundler should use when generating the project\. Acceptable values are \fBminitest\fR, \fBrspec\fR and \fBtest\-unit\fR\. The \fBGEM_NAME\.gemspec\fR will be configured and a skeleton test/spec directory will be created based on this option\. Given no option is specified:
.IP
When Bundler is configured to generate tests, this defaults to Bundler's global config setting \fBgem\.test\fR\.
.IP
When Bundler is configured to not generate tests, an interactive prompt will be displayed and the answer will be used for the current rubygem project\.
.IP
When Bundler is unconfigured, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-test\fR: Do not use a test framework (overrides \fB\-\-test\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-ci\fR, \fB\-\-ci=github\fR, \fB\-\-ci=gitlab\fR, \fB\-\-ci=circle\fR: Specify the continuous integration service that Bundler should use when generating the project\. Acceptable values are \fBgithub\fR, \fBgitlab\fR and \fBcircle\fR\. A configuration file will be generated in the project directory\. Given no option is specified:
.IP
When Bundler is configured to generate CI files, this defaults to Bundler's global config setting \fBgem\.ci\fR\.
.IP
When Bundler is configured to not generate CI files, an interactive prompt will be displayed and the answer will be used for the current rubygem project\.
.IP
When Bundler is unconfigured, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-ci\fR: Do not use a continuous integration service (overrides \fB\-\-ci\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-\-linter\fR, \fB\-\-linter=rubocop\fR, \fB\-\-linter=standard\fR: Specify the linter and code formatter that Bundler should add to the project's development dependencies\. Acceptable values are \fBrubocop\fR and \fBstandard\fR\. A configuration file will be generated in the project directory\. Given no option is specified:
.IP
When Bundler is configured to add a linter, this defaults to Bundler's global config setting \fBgem\.linter\fR\.
.IP
When Bundler is configured not to add a linter, an interactive prompt will be displayed and the answer will be used for the current rubygem project\.
.IP
When Bundler is unconfigured, an interactive prompt will be displayed and the answer will be saved in Bundler's global config for future \fBbundle gem\fR use\.
.IP "\(bu" 4
\fB\-\-no\-linter\fR: Do not add a linter (overrides \fB\-\-linter\fR specified in the global config)\.
.IP "\(bu" 4
\fB\-e\fR, \fB\-\-edit[=EDITOR]\fR: Open the resulting GEM_NAME\.gemspec in EDITOR, or the default editor if not specified\. The default is \fB$BUNDLER_EDITOR\fR, \fB$VISUAL\fR, or \fB$EDITOR\fR\.
.IP "" 0
.SH "SEE ALSO"
.IP "\(bu" 4
bundle config(1) \fIbundle\-config\.1\.html\fR
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle.1 0000644 00000007260 15173517743 0016244 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE" "1" "September 2024" ""
.SH "NAME"
\fBbundle\fR \- Ruby Dependency Management
.SH "SYNOPSIS"
\fBbundle\fR COMMAND [\-\-no\-color] [\-\-verbose] [ARGS]
.SH "DESCRIPTION"
Bundler manages an \fBapplication's dependencies\fR through its entire life across many machines systematically and repeatably\.
.P
See the bundler website \fIhttps://bundler\.io\fR for information on getting started, and Gemfile(5) for more information on the \fBGemfile\fR format\.
.SH "OPTIONS"
.TP
\fB\-\-no\-color\fR
Print all output without color
.TP
\fB\-\-retry\fR, \fB\-r\fR
Specify the number of times you wish to attempt network commands
.TP
\fB\-\-verbose\fR, \fB\-V\fR
Print out additional logging information
.SH "BUNDLE COMMANDS"
We divide \fBbundle\fR subcommands into primary commands and utilities:
.SH "PRIMARY COMMANDS"
.TP
\fBbundle install(1)\fR \fIbundle\-install\.1\.html\fR
Install the gems specified by the \fBGemfile\fR or \fBGemfile\.lock\fR
.TP
\fBbundle update(1)\fR \fIbundle\-update\.1\.html\fR
Update dependencies to their latest versions
.TP
\fBbundle cache(1)\fR \fIbundle\-cache\.1\.html\fR
Package the \.gem files required by your application into the \fBvendor/cache\fR directory (aliases: \fBbundle package\fR, \fBbundle pack\fR)
.TP
\fBbundle exec(1)\fR \fIbundle\-exec\.1\.html\fR
Execute a script in the current bundle
.TP
\fBbundle config(1)\fR \fIbundle\-config\.1\.html\fR
Specify and read configuration options for Bundler
.TP
\fBbundle help(1)\fR \fIbundle\-help\.1\.html\fR
Display detailed help for each subcommand
.SH "UTILITIES"
.TP
\fBbundle add(1)\fR \fIbundle\-add\.1\.html\fR
Add the named gem to the Gemfile and run \fBbundle install\fR
.TP
\fBbundle binstubs(1)\fR \fIbundle\-binstubs\.1\.html\fR
Generate binstubs for executables in a gem
.TP
\fBbundle check(1)\fR \fIbundle\-check\.1\.html\fR
Determine whether the requirements for your application are installed and available to Bundler
.TP
\fBbundle show(1)\fR \fIbundle\-show\.1\.html\fR
Show the source location of a particular gem in the bundle
.TP
\fBbundle outdated(1)\fR \fIbundle\-outdated\.1\.html\fR
Show all of the outdated gems in the current bundle
.TP
\fBbundle console(1)\fR (deprecated)
Start an IRB session in the current bundle
.TP
\fBbundle open(1)\fR \fIbundle\-open\.1\.html\fR
Open an installed gem in the editor
.TP
\fBbundle lock(1)\fR \fIbundle\-lock\.1\.html\fR
Generate a lockfile for your dependencies
.TP
\fBbundle viz(1)\fR \fIbundle\-viz\.1\.html\fR (deprecated)
Generate a visual representation of your dependencies
.TP
\fBbundle init(1)\fR \fIbundle\-init\.1\.html\fR
Generate a simple \fBGemfile\fR, placed in the current directory
.TP
\fBbundle gem(1)\fR \fIbundle\-gem\.1\.html\fR
Create a simple gem, suitable for development with Bundler
.TP
\fBbundle platform(1)\fR \fIbundle\-platform\.1\.html\fR
Display platform compatibility information
.TP
\fBbundle clean(1)\fR \fIbundle\-clean\.1\.html\fR
Clean up unused gems in your Bundler directory
.TP
\fBbundle doctor(1)\fR \fIbundle\-doctor\.1\.html\fR
Display warnings about common problems
.TP
\fBbundle remove(1)\fR \fIbundle\-remove\.1\.html\fR
Removes gems from the Gemfile
.TP
\fBbundle plugin(1)\fR \fIbundle\-plugin\.1\.html\fR
Manage Bundler plugins
.TP
\fBbundle version(1)\fR \fIbundle\-version\.1\.html\fR
Prints Bundler version information
.SH "PLUGINS"
When running a command that isn't listed in PRIMARY COMMANDS or UTILITIES, Bundler will try to find an executable on your path named \fBbundler\-<command>\fR and execute it, passing down any extra arguments to it\.
.SH "OBSOLETE"
These commands are obsolete and should no longer be used:
.IP "\(bu" 4
\fBbundle inject(1)\fR
.IP "" 0
share/gems/gems/bundler-2.5.22/lib/bundler/man/bundle-init.1 0000644 00000002176 15173517743 0017206 0 ustar 00 .\" generated with nRonn/v0.11.1
.\" https://github.com/n-ronn/nronn/tree/0.11.1
.TH "BUNDLE\-INIT" "1" "September 2024" ""
.SH "NAME"
\fBbundle\-init\fR \- Generates a Gemfile into the current working directory
.SH "SYNOPSIS"
\fBbundle init\fR [\-\-gemspec=FILE]
.SH "DESCRIPTION"
Init generates a default [\fBGemfile(5)\fR][Gemfile(5)] in the current working directory\. When adding a [\fBGemfile(5)\fR][Gemfile(5)] to a gem with a gemspec, the \fB\-\-gemspec\fR option will automatically add each dependency listed in the gemspec file to the newly created [\fBGemfile(5)\fR][Gemfile(5)]\.
.SH "OPTIONS"
.TP
\fB\-\-gemspec\fR
Use the specified \.gemspec to create the [\fBGemfile(5)\fR][Gemfile(5)]
.TP
\fB\-\-gemfile\fR
Use the specified name for the gemfile instead of \fBGemfile\fR
.SH "FILES"
Included in the default [\fBGemfile(5)\fR][Gemfile(5)] generated is the line \fB# frozen_string_literal: true\fR\. This is a magic comment supported for the first time in Ruby 2\.3\. The presence of this line results in all string literals in the file being implicitly frozen\.
.SH "SEE ALSO"
Gemfile(5) \fIhttps://bundler\.io/man/gemfile\.5\.html\fR
share/gems/gems/bundler-2.5.22/lib/bundler/constants.rb 0000644 00000000467 15173517743 0016501 0 ustar 00 # frozen_string_literal: true
require "rbconfig"
module Bundler
WINDOWS = RbConfig::CONFIG["host_os"] =~ /(msdos|mswin|djgpp|mingw)/
deprecate_constant :WINDOWS
FREEBSD = RbConfig::CONFIG["host_os"].to_s.include?("bsd")
deprecate_constant :FREEBSD
NULL = File::NULL
deprecate_constant :NULL
end
share/gems/gems/bundler-2.5.22/lib/bundler/safe_marshal.rb 0000644 00000001125 15173517743 0017102 0 ustar 00 # frozen_string_literal: true
module Bundler
module SafeMarshal
ALLOWED_CLASSES = [
Array,
FalseClass,
Gem::Specification,
Gem::Version,
Hash,
String,
Symbol,
Time,
TrueClass,
].freeze
ERROR = "Unexpected class %s present in marshaled data. Only %s are allowed."
PROC = proc do |object|
object.tap do
unless ALLOWED_CLASSES.include?(object.class)
raise TypeError, format(ERROR, object.class, ALLOWED_CLASSES.join(", "))
end
end
end
def self.proc
PROC
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/ci_detector.rb 0000644 00000007335 15173517743 0016752 0 ustar 00 # frozen_string_literal: true
module Bundler
module CIDetector
# NOTE: Any changes made here will need to be made to both lib/rubygems/ci_detector.rb and
# bundler/lib/bundler/ci_detector.rb (which are enforced duplicates).
# TODO: Drop that duplication once bundler drops support for RubyGems 3.4
#
# ## Recognized CI providers, their signifiers, and the relevant docs ##
#
# Travis CI - CI, TRAVIS https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
# Cirrus CI - CI, CIRRUS_CI https://cirrus-ci.org/guide/writing-tasks/#environment-variables
# Circle CI - CI, CIRCLECI https://circleci.com/docs/variables/#built-in-environment-variables
# Gitlab CI - CI, GITLAB_CI https://docs.gitlab.com/ee/ci/variables/
# AppVeyor - CI, APPVEYOR https://www.appveyor.com/docs/environment-variables/
# CodeShip - CI_NAME https://docs.cloudbees.com/docs/cloudbees-codeship/latest/pro-builds-and-configuration/environment-variables#_default_environment_variables
# dsari - CI, DSARI https://github.com/rfinnie/dsari#running
# Jenkins - BUILD_NUMBER https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#using-environment-variables
# TeamCity - TEAMCITY_VERSION https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html#Predefined+Server+Build+Parameters
# Appflow - CI_BUILD_ID https://ionic.io/docs/appflow/automation/environments#predefined-environments
# TaskCluster - TASKCLUSTER_ROOT_URL https://docs.taskcluster.net/docs/manual/design/env-vars
# Semaphore - CI, SEMAPHORE https://docs.semaphoreci.com/ci-cd-environment/environment-variables/
# BuildKite - CI, BUILDKITE https://buildkite.com/docs/pipelines/environment-variables
# GoCD - GO_SERVER_URL https://docs.gocd.org/current/faq/dev_use_current_revision_in_build.html
# GH Actions - CI, GITHUB_ACTIONS https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
#
# ### Some "standard" ENVs that multiple providers may set ###
#
# * CI - this is set by _most_ (but not all) CI providers now; it's approaching a standard.
# * CI_NAME - Not as frequently used, but some providers set this to specify their own name
# Any of these being set is a reasonably reliable indicator that we are
# executing in a CI environment.
ENV_INDICATORS = [
"CI",
"CI_NAME",
"CONTINUOUS_INTEGRATION",
"BUILD_NUMBER",
"CI_APP_ID",
"CI_BUILD_ID",
"CI_BUILD_NUMBER",
"RUN_ID",
"TASKCLUSTER_ROOT_URL",
].freeze
# For each CI, this env suffices to indicate that we're on _that_ CI's
# containers. (A few of them only supply a CI_NAME variable, which is also
# nice). And if they set "CI" but we can't tell which one they are, we also
# want to know that - a bare "ci" without another token tells us as much.
ENV_DESCRIPTORS = {
"TRAVIS" => "travis",
"CIRCLECI" => "circle",
"CIRRUS_CI" => "cirrus",
"DSARI" => "dsari",
"SEMAPHORE" => "semaphore",
"JENKINS_URL" => "jenkins",
"BUILDKITE" => "buildkite",
"GO_SERVER_URL" => "go",
"GITLAB_CI" => "gitlab",
"GITHUB_ACTIONS" => "github",
"TASKCLUSTER_ROOT_URL" => "taskcluster",
"CI" => "ci",
}.freeze
def self.ci?
ENV_INDICATORS.any? {|var| ENV.include?(var) }
end
def self.ci_strings
matching_names = ENV_DESCRIPTORS.select {|env, _| ENV[env] }.values
matching_names << ENV["CI_NAME"].downcase if ENV["CI_NAME"]
matching_names.reject(&:empty?).sort.uniq
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/mirror.rb 0000644 00000013424 15173517743 0015774 0 ustar 00 # frozen_string_literal: true
require "socket"
module Bundler
class Settings
# Class used to build the mirror set and then find a mirror for a given URI
#
# @param prober [Prober object, nil] by default a TCPSocketProbe, this object
# will be used to probe the mirror address to validate that the mirror replies.
class Mirrors
def initialize(prober = nil)
@all = Mirror.new
@prober = prober || TCPSocketProbe.new
@mirrors = {}
end
# Returns a mirror for the given uri.
#
# Depending on the uri having a valid mirror or not, it may be a
# mirror that points to the provided uri
def for(uri)
if @all.validate!(@prober).valid?
@all
else
fetch_valid_mirror_for(Settings.normalize_uri(uri))
end
end
def each
@mirrors.each do |k, v|
yield k, v.uri.to_s
end
end
def parse(key, value)
config = MirrorConfig.new(key, value)
mirror = if config.all?
@all
else
@mirrors[config.uri] ||= Mirror.new
end
config.update_mirror(mirror)
end
private
def fetch_valid_mirror_for(uri)
downcased = uri.to_s.downcase
mirror = @mirrors[downcased] || @mirrors[Gem::URI(downcased).host] || Mirror.new(uri)
mirror.validate!(@prober)
mirror = Mirror.new(uri) unless mirror.valid?
mirror
end
end
# A mirror
#
# Contains both the uri that should be used as a mirror and the
# fallback timeout which will be used for probing if the mirror
# replies on time or not.
class Mirror
DEFAULT_FALLBACK_TIMEOUT = 0.1
attr_reader :uri, :fallback_timeout
def initialize(uri = nil, fallback_timeout = 0)
self.uri = uri
self.fallback_timeout = fallback_timeout
@valid = nil
end
def uri=(uri)
@uri = if uri.nil?
nil
else
Gem::URI(uri.to_s)
end
@valid = nil
end
def fallback_timeout=(timeout)
case timeout
when true, "true"
@fallback_timeout = DEFAULT_FALLBACK_TIMEOUT
when false, "false"
@fallback_timeout = 0
else
@fallback_timeout = timeout.to_i
end
@valid = nil
end
def ==(other)
!other.nil? && uri == other.uri && fallback_timeout == other.fallback_timeout
end
def valid?
return false if @uri.nil?
return @valid unless @valid.nil?
false
end
def validate!(probe = nil)
@valid = false if uri.nil?
if @valid.nil?
@valid = fallback_timeout == 0 || (probe || TCPSocketProbe.new).replies?(self)
end
self
end
end
# Class used to parse one configuration line
#
# Gets the configuration line and the value.
# This object provides a `update_mirror` method
# used to setup the given mirror value.
class MirrorConfig
attr_accessor :uri, :value
def initialize(config_line, value)
uri, fallback =
config_line.match(%r{\Amirror\.(all|.+?)(\.fallback_timeout)?\/?\z}).captures
@fallback = !fallback.nil?
@all = false
if uri == "all"
@all = true
else
@uri = Gem::URI(uri).absolute? ? Settings.normalize_uri(uri) : uri
end
@value = value
end
def all?
@all
end
def update_mirror(mirror)
if @fallback
mirror.fallback_timeout = @value
else
mirror.uri = Settings.normalize_uri(@value)
end
end
end
# Class used for probing TCP availability for a given mirror.
class TCPSocketProbe
def replies?(mirror)
MirrorSockets.new(mirror).any? do |socket, address, timeout|
socket.connect_nonblock(address)
rescue Errno::EINPROGRESS
wait_for_writtable_socket(socket, address, timeout)
rescue RuntimeError # Connection failed somehow, again
false
end
end
private
def wait_for_writtable_socket(socket, address, timeout)
if IO.select(nil, [socket], nil, timeout)
probe_writtable_socket(socket, address)
else # TCP Handshake timed out, or there is something dropping packets
false
end
end
def probe_writtable_socket(socket, address)
socket.connect_nonblock(address)
rescue Errno::EISCONN
true
rescue StandardError # Connection failed
false
end
end
end
# Class used to build the list of sockets that correspond to
# a given mirror.
#
# One mirror may correspond to many different addresses, both
# because of it having many dns entries or because
# the network interface is both ipv4 and ipv5
class MirrorSockets
def initialize(mirror)
@timeout = mirror.fallback_timeout
@addresses = Socket.getaddrinfo(mirror.uri.host, mirror.uri.port).map do |address|
SocketAddress.new(address[0], address[3], address[1])
end
end
def any?
@addresses.any? do |address|
socket = Socket.new(Socket.const_get(address.type), Socket::SOCK_STREAM, 0)
socket.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
value = yield socket, address.to_socket_address, @timeout
socket.close unless socket.closed?
value
end
end
end
# Socket address builder.
#
# Given a socket type, a host and a port,
# provides a method to build sockaddr string
class SocketAddress
attr_reader :type, :host, :port
def initialize(type, host, port)
@type = type
@host = host
@port = port
end
def to_socket_address
Socket.pack_sockaddr_in(@port, @host)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/remote_specification.rb 0000644 00000007442 15173517743 0020660 0 ustar 00 # frozen_string_literal: true
module Bundler
# Represents a lazily loaded gem specification, where the full specification
# is on the source server in rubygems' "quick" index. The proxy object is to
# be seeded with what we're given from the source's abbreviated index - the
# full specification will only be fetched when necessary.
class RemoteSpecification
include MatchRemoteMetadata
include MatchPlatform
include Comparable
attr_reader :name, :version, :platform
attr_writer :dependencies
attr_accessor :source, :remote
def initialize(name, version, platform, spec_fetcher)
@name = name
@version = Gem::Version.create version
@original_platform = platform || Gem::Platform::RUBY
@platform = Gem::Platform.new(platform)
@spec_fetcher = spec_fetcher
@dependencies = nil
end
# Needed before installs, since the arch matters then and quick
# specs don't bother to include the arch in the platform string
def fetch_platform
@platform = _remote_specification.platform
end
def full_name
@full_name ||= if @platform == Gem::Platform::RUBY
"#{@name}-#{@version}"
else
"#{@name}-#{@version}-#{@platform}"
end
end
# Compare this specification against another object. Using sort_obj
# is compatible with Gem::Specification and other Bundler or RubyGems
# objects. Otherwise, use the default Object comparison.
def <=>(other)
if other.respond_to?(:sort_obj)
sort_obj <=> other.sort_obj
else
super
end
end
# Because Rubyforge cannot be trusted to provide valid specifications
# once the remote gem is downloaded, the backend specification will
# be swapped out.
def __swap__(spec)
raise APIResponseInvalidDependenciesError unless spec.dependencies.all? {|d| d.is_a?(Gem::Dependency) }
SharedHelpers.ensure_same_dependencies(self, dependencies, spec.dependencies)
@_remote_specification = spec
end
# Create a delegate used for sorting. This strategy is copied from
# RubyGems 2.23 and ensures that Bundler's specifications can be
# compared and sorted with RubyGems' own specifications.
#
# @see #<=>
# @see Gem::Specification#sort_obj
#
# @return [Array] an object you can use to compare and sort this
# specification against other specifications
def sort_obj
[@name, @version, @platform == Gem::Platform::RUBY ? -1 : 1]
end
def to_s
"#<#{self.class} name=#{name} version=#{version} platform=#{platform}>"
end
def dependencies
@dependencies ||= begin
deps = method_missing(:dependencies)
# allow us to handle when the specs dependencies are an array of array of string
# in order to delay the crash to `#__swap__` where it results in a friendlier error
# see https://github.com/rubygems/bundler/issues/5797
deps = deps.map {|d| d.is_a?(Gem::Dependency) ? d : Gem::Dependency.new(*d) }
deps
end
end
def runtime_dependencies
dependencies.select(&:runtime?)
end
def git_version
return unless loaded_from && source.is_a?(Bundler::Source::Git)
" #{source.revision[0..6]}"
end
private
def to_ary
nil
end
def _remote_specification
@_remote_specification ||= @spec_fetcher.fetch_spec([@name, @version, @original_platform])
@_remote_specification || raise(GemspecError, "Gemspec data for #{full_name} was" \
" missing from the server!")
end
def method_missing(method, *args, &blk)
_remote_specification.send(method, *args, &blk)
end
def respond_to?(method, include_all = false)
super || _remote_specification.respond_to?(method, include_all)
end
public :respond_to?
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/env.rb 0000644 00000011656 15173517743 0015257 0 ustar 00 # frozen_string_literal: true
require_relative "rubygems_integration"
require_relative "source/git/git_proxy"
module Bundler
class Env
def self.write(io)
io.write report
end
def self.report(options = {})
print_gemfile = options.delete(:print_gemfile) { true }
print_gemspecs = options.delete(:print_gemspecs) { true }
out = String.new
append_formatted_table("Environment", environment, out)
append_formatted_table("Bundler Build Metadata", BuildMetadata.to_h, out)
unless Bundler.settings.all.empty?
out << "\n## Bundler settings\n\n```\n"
Bundler.settings.all.each do |setting|
out << setting << "\n"
Bundler.settings.pretty_values_for(setting).each do |line|
out << " " << line << "\n"
end
end
out << "```\n"
end
return out unless SharedHelpers.in_bundle?
if print_gemfile
gemfiles = [Bundler.default_gemfile]
begin
gemfiles = Bundler.definition.gemfiles
rescue GemfileNotFound
nil
end
out << "\n## Gemfile\n"
gemfiles.each do |gemfile|
out << "\n### #{SharedHelpers.relative_path_to(gemfile)}\n\n"
out << "```ruby\n" << read_file(gemfile).chomp << "\n```\n"
end
out << "\n### #{SharedHelpers.relative_path_to(Bundler.default_lockfile)}\n\n"
out << "```\n" << read_file(Bundler.default_lockfile).chomp << "\n```\n"
end
if print_gemspecs
dsl = Dsl.new.tap {|d| d.eval_gemfile(Bundler.default_gemfile) }
out << "\n## Gemspecs\n" unless dsl.gemspecs.empty?
dsl.gemspecs.each do |gs|
out << "\n### #{File.basename(gs.loaded_from)}"
out << "\n\n```ruby\n" << read_file(gs.loaded_from).chomp << "\n```\n"
end
end
out
end
def self.read_file(filename)
Bundler.read_file(filename.to_s).strip
rescue Errno::ENOENT
"<No #{filename} found>"
rescue RuntimeError => e
"#{e.class}: #{e.message}"
end
def self.ruby_version
"#{RUBY_VERSION}p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE} revision #{RUBY_REVISION}) [#{Gem::Platform.local}]"
end
def self.git_version
Bundler::Source::Git::GitProxy.new(nil, nil).full_version
rescue Bundler::Source::Git::GitNotInstalledError
"not installed"
end
def self.version_of(script)
return "not installed" unless Bundler.which(script)
`#{script} --version`.chomp
end
def self.chruby_version
return "not installed" unless Bundler.which("chruby-exec")
`chruby-exec -- chruby --version`.
sub(/.*^chruby: (#{Gem::Version::VERSION_PATTERN}).*/m, '\1')
end
def self.environment
out = []
out << ["Bundler", Bundler::VERSION]
out << [" Platforms", Gem.platforms.join(", ")]
out << ["Ruby", ruby_version]
out << [" Full Path", Gem.ruby]
out << [" Config Dir", Pathname.new(Gem::ConfigFile::SYSTEM_WIDE_CONFIG_FILE).dirname]
out << ["RubyGems", Gem::VERSION]
out << [" Gem Home", Gem.dir]
out << [" Gem Path", Gem.path.join(File::PATH_SEPARATOR)]
out << [" User Home", Gem.user_home]
out << [" User Path", Gem.user_dir]
out << [" Bin Dir", Gem.bindir]
if defined?(OpenSSL::SSL)
out << ["OpenSSL"]
out << [" Compiled", OpenSSL::OPENSSL_VERSION] if defined?(OpenSSL::OPENSSL_VERSION)
out << [" Loaded", OpenSSL::OPENSSL_LIBRARY_VERSION] if defined?(OpenSSL::OPENSSL_LIBRARY_VERSION)
out << [" Cert File", OpenSSL::X509::DEFAULT_CERT_FILE] if defined?(OpenSSL::X509::DEFAULT_CERT_FILE)
out << [" Cert Dir", OpenSSL::X509::DEFAULT_CERT_DIR] if defined?(OpenSSL::X509::DEFAULT_CERT_DIR)
end
out << ["Tools"]
out << [" Git", git_version]
out << [" RVM", ENV.fetch("rvm_version") { version_of("rvm") }]
out << [" rbenv", version_of("rbenv")]
out << [" chruby", chruby_version]
%w[rubygems-bundler open_gem].each do |name|
specs = Bundler.rubygems.find_name(name)
out << [" #{name}", "(#{specs.map(&:version).join(",")})"] unless specs.empty?
end
if (exe = caller_locations.last.absolute_path)&.match? %r{(exe|bin)/bundler?\z}
shebang = File.read(exe).lines.first
shebang.sub!(/^#!\s*/, "")
unless shebang.start_with?(Gem.ruby, "/usr/bin/env ruby")
out << ["Gem.ruby", Gem.ruby]
out << ["bundle #!", shebang]
end
end
out
end
def self.append_formatted_table(title, pairs, out)
return if pairs.empty?
out << "\n" unless out.empty?
out << "## #{title}\n\n```\n"
ljust = pairs.map {|k, _v| k.to_s.length }.max
pairs.each do |k, v|
out << "#{k.to_s.ljust(ljust)} #{v}\n"
end
out << "```\n"
end
private_class_method :read_file, :ruby_version, :git_version, :append_formatted_table, :version_of, :chruby_version
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_pub_grub.rb 0000644 00000000143 15173517743 0020147 0 ustar 00 # frozen_string_literal: true
module Bundler; end
require_relative "vendor/pub_grub/lib/pub_grub"
share/gems/gems/bundler-2.5.22/lib/bundler/setup.rb 0000644 00000002561 15173517743 0015622 0 ustar 00 # frozen_string_literal: true
require_relative "shared_helpers"
if Bundler::SharedHelpers.in_bundle?
require_relative "../bundler"
# autoswitch to locked Bundler version if available
Bundler.auto_switch
# try to auto_install first before we get to the `Bundler.ui.silence`, so user knows what is happening
Bundler.auto_install
if STDOUT.tty? || ENV["BUNDLER_FORCE_TTY"]
begin
Bundler.ui.silence { Bundler.setup }
rescue Bundler::BundlerError => e
Bundler.ui.error e.message
Bundler.ui.warn e.backtrace.join("\n") if ENV["DEBUG"]
if e.is_a?(Bundler::GemNotFound)
default_bundle = Gem.bin_path("bundler", "bundle")
current_bundle = Bundler::SharedHelpers.bundle_bin_path
suggested_bundle = default_bundle == current_bundle ? "bundle" : current_bundle
suggested_cmd = "#{suggested_bundle} install"
original_gemfile = Bundler.original_env["BUNDLE_GEMFILE"]
suggested_cmd += " --gemfile #{original_gemfile}" if original_gemfile
Bundler.ui.warn "Run `#{suggested_cmd}` to install missing gems."
end
exit e.status_code
end
else
Bundler.ui.silence { Bundler.setup }
end
# We might be in the middle of shelling out to rubygems
# (RUBYOPT=-rbundler/setup), so we need to give rubygems the opportunity of
# not being silent.
Gem::DefaultUserInteraction.ui = nil
end
share/gems/gems/bundler-2.5.22/lib/bundler/resolver/spec_group.rb 0000644 00000004033 15173517743 0020465 0 ustar 00 # frozen_string_literal: true
module Bundler
class Resolver
class SpecGroup
attr_reader :specs
def initialize(specs)
@specs = specs
end
def empty?
@specs.empty?
end
def name
@name ||= exemplary_spec.name
end
def version
@version ||= exemplary_spec.version
end
def source
@source ||= exemplary_spec.source
end
def to_specs(force_ruby_platform)
@specs.map do |s|
lazy_spec = LazySpecification.from_spec(s)
lazy_spec.force_ruby_platform = force_ruby_platform
lazy_spec
end
end
def to_s
sorted_spec_names.join(", ")
end
def dependencies
@dependencies ||= @specs.map do |spec|
__dependencies(spec) + metadata_dependencies(spec)
end.flatten.uniq.sort
end
def ==(other)
sorted_spec_names == other.sorted_spec_names
end
def merge(other)
return false unless equivalent?(other)
@specs |= other.specs
true
end
protected
def sorted_spec_names
@specs.map(&:full_name).sort
end
private
def equivalent?(other)
name == other.name && version == other.version && source == other.source && dependencies == other.dependencies
end
def exemplary_spec
@specs.first
end
def __dependencies(spec)
dependencies = []
spec.dependencies.each do |dep|
next if dep.type == :development
dependencies << Dependency.new(dep.name, dep.requirement)
end
dependencies
end
def metadata_dependencies(spec)
[
metadata_dependency("Ruby", spec.required_ruby_version),
metadata_dependency("RubyGems", spec.required_rubygems_version),
].compact
end
def metadata_dependency(name, requirement)
return if requirement.nil? || requirement.none?
Dependency.new("#{name}\0", requirement)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/resolver/package.rb 0000644 00000004231 15173517743 0017712 0 ustar 00 # frozen_string_literal: true
module Bundler
class Resolver
#
# Represents a gem being resolved, in a format PubGrub likes.
#
# The class holds the following information:
#
# * Platforms this gem will be resolved on.
# * The locked version of this gem resolution should favor (if any).
# * Whether the gem should be unlocked to its latest version.
# * The dependency explicit set in the Gemfile for this gem (if any).
#
class Package
attr_reader :name, :platforms, :dependency, :locked_version
def initialize(name, platforms, locked_specs:, unlock:, prerelease: false, prefer_local: false, dependency: nil)
@name = name
@platforms = platforms
@locked_version = locked_specs[name].first&.version
@unlock = unlock
@dependency = dependency || Dependency.new(name, @locked_version)
@top_level = !dependency.nil?
@prerelease = @dependency.prerelease? || @locked_version&.prerelease? || prerelease ? :consider_first : :ignore
@prefer_local = prefer_local
end
def platform_specs(specs)
platforms.map {|platform| GemHelpers.select_best_platform_match(specs, platform, prefer_locked: !unlock?) }
end
def to_s
@name.delete("\0")
end
def root?
false
end
def top_level?
@top_level
end
def meta?
@name.end_with?("\0")
end
def ==(other)
self.class == other.class && @name == other.name
end
def hash
@name.hash
end
def unlock?
@unlock.empty? || @unlock.include?(name)
end
def ignores_prereleases?
@prerelease == :ignore
end
def prerelease_specified?
@prerelease == :consider_first
end
def consider_prereleases!
@prerelease = :consider_last
end
def prefer_local?
@prefer_local
end
def consider_remote_versions!
@prefer_local = false
end
def force_ruby_platform?
@dependency.force_ruby_platform
end
def current_platform?
@dependency.current_platform?
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/resolver/incompatibility.rb 0000644 00000000622 15173517743 0021517 0 ustar 00 # frozen_string_literal: true
module Bundler
class Resolver
class Incompatibility < PubGrub::Incompatibility
attr_reader :extended_explanation
def initialize(terms, cause:, custom_explanation: nil, extended_explanation: nil)
@extended_explanation = extended_explanation
super(terms, cause: cause, custom_explanation: custom_explanation)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/resolver/candidate.rb 0000644 00000003707 15173517743 0020242 0 ustar 00 # frozen_string_literal: true
require_relative "spec_group"
module Bundler
class Resolver
#
# This class is a PubGrub compatible "Version" class that takes Bundler
# resolution complexities into account.
#
# Each Resolver::Candidate has a underlying `Gem::Version` plus a set of
# platforms. For example, 1.1.0-x86_64-linux is a different resolution candidate
# from 1.1.0 (generic). This is because different platform variants of the
# same gem version can bring different dependencies, so they need to be
# considered separately.
#
# Some candidates may also keep some information explicitly about the
# package they refer to. These candidates are referred to as "canonical" and
# are used when materializing resolution results back into RubyGems
# specifications that can be installed, written to lock files, and so on.
#
class Candidate
include Comparable
attr_reader :version
def initialize(version, group: nil, priority: -1)
@spec_group = group || SpecGroup.new([])
@version = Gem::Version.new(version)
@priority = priority
end
def dependencies
@spec_group.dependencies
end
def to_specs(package)
return [] if package.meta?
@spec_group.to_specs(package.force_ruby_platform?)
end
def prerelease?
@version.prerelease?
end
def segments
@version.segments
end
def sort_obj
[@version, @priority]
end
def <=>(other)
return unless other.is_a?(self.class)
sort_obj <=> other.sort_obj
end
def ==(other)
return unless other.is_a?(self.class)
sort_obj == other.sort_obj
end
def eql?(other)
return unless other.is_a?(self.class)
sort_obj.eql?(other.sort_obj)
end
def hash
sort_obj.hash
end
def to_s
@version.to_s
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/resolver/root.rb 0000644 00000000630 15173517743 0017301 0 ustar 00 # frozen_string_literal: true
require_relative "package"
module Bundler
class Resolver
#
# Represents the Gemfile from the resolver's perspective. It's the root
# package and Gemfile entries depend on it.
#
class Root < Package
def initialize(name)
@name = name
end
def meta?
true
end
def root?
true
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/resolver/base.rb 0000644 00000005230 15173517743 0017231 0 ustar 00 # frozen_string_literal: true
require_relative "package"
module Bundler
class Resolver
class Base
attr_reader :packages, :requirements, :source_requirements
def initialize(source_requirements, dependencies, base, platforms, options)
@source_requirements = source_requirements
@base = base
@packages = Hash.new do |hash, name|
hash[name] = Package.new(name, platforms, **options)
end
@requirements = dependencies.map do |dep|
dep_platforms = dep.gem_platforms(platforms)
# Dependencies scoped to external platforms are ignored
next if dep_platforms.empty?
name = dep.name
@packages[name] = Package.new(name, dep_platforms, **options.merge(dependency: dep))
dep
end.compact
end
def specs_compatible_with(result)
@base.specs_compatible_with(result)
end
def [](name)
@base[name]
end
def delete(specs)
@base.delete(specs)
end
def get_package(name)
@packages[name]
end
def base_requirements
@base_requirements ||= build_base_requirements
end
def unlock_names(names)
indirect_pins = indirect_pins(names)
if indirect_pins.any?
loosen_names(indirect_pins)
else
pins = pins(names)
if pins.any?
loosen_names(pins)
else
unrestrict_names(names)
end
end
end
def include_prereleases(names)
names.each do |name|
get_package(name).consider_prereleases!
end
end
def include_remote_specs(names)
names.each do |name|
get_package(name).consider_remote_versions!
end
end
private
def indirect_pins(names)
names.select {|name| @base_requirements[name].exact? && @requirements.none? {|dep| dep.name == name } }
end
def pins(names)
names.select {|name| @base_requirements[name].exact? }
end
def loosen_names(names)
names.each do |name|
version = @base_requirements[name].requirements.first[1]
@base_requirements[name] = Gem::Requirement.new(">= #{version}")
@base.delete_by_name(name)
end
end
def unrestrict_names(names)
names.each do |name|
@base_requirements.delete(name)
end
end
def build_base_requirements
base_requirements = {}
@base.each do |ls|
req = Gem::Requirement.new(ls.version)
base_requirements[ls.name] = req
end
base_requirements
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/feature_flag.rb 0000644 00000003453 15173517743 0017107 0 ustar 00 # frozen_string_literal: true
module Bundler
class FeatureFlag
def self.settings_flag(flag, &default)
unless Bundler::Settings::BOOL_KEYS.include?(flag.to_s)
raise "Cannot use `#{flag}` as a settings feature flag since it isn't a bool key"
end
settings_method("#{flag}?", flag, &default)
end
private_class_method :settings_flag
def self.settings_option(key, &default)
settings_method(key, key, &default)
end
private_class_method :settings_option
def self.settings_method(name, key, &default)
define_method(name) do
value = Bundler.settings[key]
value = instance_eval(&default) if value.nil?
value
end
end
private_class_method :settings_method
(1..10).each {|v| define_method("bundler_#{v}_mode?") { major_version >= v } }
settings_flag(:allow_offline_install) { bundler_3_mode? }
settings_flag(:auto_clean_without_path) { bundler_3_mode? }
settings_flag(:cache_all) { bundler_3_mode? }
settings_flag(:default_install_uses_path) { bundler_3_mode? }
settings_flag(:forget_cli_options) { bundler_3_mode? }
settings_flag(:global_gem_cache) { bundler_3_mode? }
settings_flag(:path_relative_to_cwd) { bundler_3_mode? }
settings_flag(:plugins) { @bundler_version >= Gem::Version.new("1.14") }
settings_flag(:print_only_version_number) { bundler_3_mode? }
settings_flag(:setup_makes_kernel_gem_public) { !bundler_3_mode? }
settings_flag(:update_requires_all_flag) { bundler_4_mode? }
settings_option(:default_cli_command) { bundler_3_mode? ? :cli_help : :install }
def initialize(bundler_version)
@bundler_version = Gem::Version.create(bundler_version)
end
def major_version
@bundler_version.segments.first
end
private :major_version
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/runtime.rb 0000644 00000023655 15173517743 0016154 0 ustar 00 # frozen_string_literal: true
module Bundler
class Runtime
include SharedHelpers
def initialize(root, definition)
@root = root
@definition = definition
end
def setup(*groups)
@definition.ensure_equivalent_gemfile_and_lockfile
# Has to happen first
clean_load_path
specs = @definition.specs_for(groups)
SharedHelpers.set_bundle_environment
Bundler.rubygems.replace_entrypoints(specs)
# Activate the specs
load_paths = specs.map do |spec|
check_for_activated_spec!(spec)
Bundler.rubygems.mark_loaded(spec)
spec.load_paths.reject {|path| $LOAD_PATH.include?(path) }
end.reverse.flatten
Gem.add_to_load_path(*load_paths)
setup_manpath
lock(preserve_unknown_sections: true)
self
end
def require(*groups)
groups.map!(&:to_sym)
groups = [:default] if groups.empty?
@definition.dependencies.each do |dep|
# Skip the dependency if it is not in any of the requested groups, or
# not for the current platform, or doesn't match the gem constraints.
next unless (dep.groups & groups).any? && dep.should_include?
required_file = nil
begin
# Loop through all the specified autorequires for the
# dependency. If there are none, use the dependency's name
# as the autorequire.
Array(dep.autorequire || dep.name).each do |file|
# Allow `require: true` as an alias for `require: <name>`
file = dep.name if file == true
required_file = file
begin
Kernel.require file
rescue RuntimeError => e
raise e if e.is_a?(LoadError) # we handle this a little later
raise Bundler::GemRequireError.new e,
"There was an error while trying to load the gem '#{file}'."
end
end
rescue LoadError => e
raise if dep.autorequire || e.path != required_file
if dep.autorequire.nil? && dep.name.include?("-")
begin
namespaced_file = dep.name.tr("-", "/")
Kernel.require namespaced_file
rescue LoadError => e
raise if e.path != namespaced_file
end
end
end
end
end
def self.definition_method(meth)
define_method(meth) do
raise ArgumentError, "no definition when calling Runtime##{meth}" unless @definition
@definition.send(meth)
end
end
private_class_method :definition_method
definition_method :requested_specs
definition_method :specs
definition_method :dependencies
definition_method :current_dependencies
definition_method :requires
def lock(opts = {})
return if @definition.no_resolve_needed?
@definition.lock(opts[:preserve_unknown_sections])
end
alias_method :gems, :specs
def cache(custom_path = nil, local = false)
cache_path = Bundler.app_cache(custom_path)
SharedHelpers.filesystem_access(cache_path) do |p|
FileUtils.mkdir_p(p)
end unless File.exist?(cache_path)
Bundler.ui.info "Updating files in #{Bundler.settings.app_cache_path}"
specs_to_cache = if Bundler.settings[:cache_all_platforms]
@definition.resolve.materialized_for_all_platforms
else
begin
specs
rescue GemNotFound
if local
Bundler.ui.warn "Some gems seem to be missing from your #{Bundler.settings.app_cache_path} directory."
end
raise
end
end
specs_to_cache.each do |spec|
next if spec.name == "bundler"
next if spec.source.is_a?(Source::Gemspec)
spec.source.cache(spec, custom_path) if spec.source.respond_to?(:cache)
end
prune_cache(cache_path) unless Bundler.settings[:no_prune]
end
def prune_cache(cache_path)
SharedHelpers.filesystem_access(cache_path) do |p|
FileUtils.mkdir_p(p)
end unless File.exist?(cache_path)
resolve = @definition.resolve
prune_gem_cache(resolve, cache_path)
prune_git_and_path_cache(resolve, cache_path)
end
def clean(dry_run = false)
gem_bins = Dir["#{Gem.dir}/bin/*"]
git_dirs = Dir["#{Gem.dir}/bundler/gems/*"]
git_cache_dirs = Dir["#{Gem.dir}/cache/bundler/git/*"]
gem_dirs = Dir["#{Gem.dir}/gems/*"]
gem_files = Dir["#{Gem.dir}/cache/*.gem"]
gemspec_files = Dir["#{Gem.dir}/specifications/*.gemspec"]
extension_dirs = Dir["#{Gem.dir}/extensions/*/*/*"] + Dir["#{Gem.dir}/bundler/gems/extensions/*/*/*"]
spec_gem_paths = []
# need to keep git sources around
spec_git_paths = @definition.spec_git_paths
spec_git_cache_dirs = []
spec_gem_executables = []
spec_cache_paths = []
spec_gemspec_paths = []
spec_extension_paths = []
Bundler.rubygems.add_default_gems_to(specs).values.each do |spec|
spec_gem_paths << spec.full_gem_path
# need to check here in case gems are nested like for the rails git repo
md = %r{(.+bundler/gems/.+-[a-f0-9]{7,12})}.match(spec.full_gem_path)
spec_git_paths << md[1] if md
spec_gem_executables << spec.executables.collect do |executable|
e = "#{Bundler.rubygems.gem_bindir}/#{executable}"
[e, "#{e}.bat"]
end
spec_cache_paths << spec.cache_file
spec_gemspec_paths << spec.spec_file
spec_extension_paths << spec.extension_dir if spec.respond_to?(:extension_dir)
spec_git_cache_dirs << spec.source.cache_path.to_s if spec.source.is_a?(Bundler::Source::Git)
end
spec_gem_paths.uniq!
spec_gem_executables.flatten!
stale_gem_bins = gem_bins - spec_gem_executables
stale_git_dirs = git_dirs - spec_git_paths - ["#{Gem.dir}/bundler/gems/extensions"]
stale_git_cache_dirs = git_cache_dirs - spec_git_cache_dirs
stale_gem_dirs = gem_dirs - spec_gem_paths
stale_gem_files = gem_files - spec_cache_paths
stale_gemspec_files = gemspec_files - spec_gemspec_paths
stale_extension_dirs = extension_dirs - spec_extension_paths
removed_stale_gem_dirs = stale_gem_dirs.collect {|dir| remove_dir(dir, dry_run) }
removed_stale_git_dirs = stale_git_dirs.collect {|dir| remove_dir(dir, dry_run) }
output = removed_stale_gem_dirs + removed_stale_git_dirs
unless dry_run
stale_files = stale_gem_bins + stale_gem_files + stale_gemspec_files
stale_files.each do |file|
SharedHelpers.filesystem_access(File.dirname(file)) do |_p|
FileUtils.rm(file) if File.exist?(file)
end
end
stale_dirs = stale_git_cache_dirs + stale_extension_dirs
stale_dirs.each do |stale_dir|
SharedHelpers.filesystem_access(stale_dir) do |dir|
FileUtils.rm_rf(dir) if File.exist?(dir)
end
end
end
output
end
private
def prune_gem_cache(resolve, cache_path)
cached = Dir["#{cache_path}/*.gem"]
cached = cached.delete_if do |path|
spec = Bundler.rubygems.spec_from_gem path
resolve.any? do |s|
s.name == spec.name && s.version == spec.version && !s.source.is_a?(Bundler::Source::Git)
end
end
if cached.any?
Bundler.ui.info "Removing outdated .gem files from #{Bundler.settings.app_cache_path}"
cached.each do |path|
Bundler.ui.info " * #{File.basename(path)}"
File.delete(path)
end
end
end
def prune_git_and_path_cache(resolve, cache_path)
cached = Dir["#{cache_path}/*/.bundlecache"]
cached = cached.delete_if do |path|
name = File.basename(File.dirname(path))
resolve.any? do |s|
source = s.source
source.respond_to?(:app_cache_dirname) && source.app_cache_dirname == name
end
end
if cached.any?
Bundler.ui.info "Removing outdated git and path gems from #{Bundler.settings.app_cache_path}"
cached.each do |path|
path = File.dirname(path)
Bundler.ui.info " * #{File.basename(path)}"
FileUtils.rm_rf(path)
end
end
end
def setup_manpath
# Add man/ subdirectories from activated bundles to MANPATH for man(1)
manuals = $LOAD_PATH.map do |path|
man_subdir = path.sub(/lib$/, "man")
man_subdir unless Dir[man_subdir + "/man?/"].empty?
end.compact
return if manuals.empty?
Bundler::SharedHelpers.set_env "MANPATH", manuals.concat(
ENV["MANPATH"] ? ENV["MANPATH"].to_s.split(File::PATH_SEPARATOR) : [""]
).uniq.join(File::PATH_SEPARATOR)
end
def remove_dir(dir, dry_run)
full_name = Pathname.new(dir).basename.to_s
parts = full_name.split("-")
name = parts[0..-2].join("-")
version = parts.last
output = "#{name} (#{version})"
if dry_run
Bundler.ui.info "Would have removed #{output}"
else
Bundler.ui.info "Removing #{output}"
FileUtils.rm_rf(dir)
end
output
end
def check_for_activated_spec!(spec)
return unless activated_spec = Bundler.rubygems.loaded_specs(spec.name)
return if activated_spec.version == spec.version
suggestion = if activated_spec.default_gem?
"Since #{spec.name} is a default gem, you can either remove your dependency on it" \
" or try updating to a newer version of bundler that supports #{spec.name} as a default gem."
else
"Prepending `bundle exec` to your command may solve this."
end
e = Gem::LoadError.new "You have already activated #{activated_spec.name} #{activated_spec.version}, " \
"but your Gemfile requires #{spec.name} #{spec.version}. #{suggestion}"
e.name = spec.name
e.requirement = Gem::Requirement.new(spec.version.to_s)
raise e
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/friendly_errors.rb 0000644 00000007306 15173517743 0017674 0 ustar 00 # frozen_string_literal: true
require_relative "vendored_thor"
module Bundler
module FriendlyErrors
module_function
def enable!
@disabled = false
end
def disabled?
@disabled
end
def disable!
@disabled = true
end
def log_error(error)
case error
when YamlSyntaxError
Bundler.ui.error error.message
Bundler.ui.trace error.orig_exception
when Dsl::DSLError, GemspecError
Bundler.ui.error error.message
when GemRequireError
Bundler.ui.error error.message
Bundler.ui.trace error.orig_exception
when BundlerError
if Bundler.ui.debug?
Bundler.ui.trace error
else
Bundler.ui.error error.message, wrap: true
end
when Thor::Error
Bundler.ui.error error.message
when Interrupt
Bundler.ui.error "\nQuitting..."
Bundler.ui.trace error
when Gem::InvalidSpecificationException
Bundler.ui.error error.message, wrap: true
when SystemExit
when *[defined?(Java::JavaLang::OutOfMemoryError) && Java::JavaLang::OutOfMemoryError].compact
Bundler.ui.error "\nYour JVM has run out of memory, and Bundler cannot continue. " \
"You can decrease the amount of memory Bundler needs by removing gems from your Gemfile, " \
"especially large gems. (Gems can be as large as hundreds of megabytes, and Bundler has to read those files!). " \
"Alternatively, you can increase the amount of memory the JVM is able to use by running Bundler with jruby -J-Xmx1024m -S bundle (JRuby defaults to 500MB)."
else request_issue_report_for(error)
end
end
def exit_status(error)
case error
when BundlerError then error.status_code
when Thor::Error then 15
when SystemExit then error.status
else 1
end
end
def request_issue_report_for(e)
Bundler.ui.error <<~EOS, nil, nil
--- ERROR REPORT TEMPLATE -------------------------------------------------------
```
#{exception_message(e)}
```
#{Bundler::Env.report}
--- TEMPLATE END ----------------------------------------------------------------
EOS
Bundler.ui.error "Unfortunately, an unexpected error occurred, and Bundler cannot continue."
Bundler.ui.error <<~EOS, nil, :yellow
First, try this link to see if there are any existing issue reports for this error:
#{issues_url(e)}
If there aren't any reports for this error yet, please fill in the new issue form located at #{new_issue_url}, and copy and paste the report template above in there.
EOS
end
def exception_message(error)
message = serialized_exception_for(error)
cause = error.cause
return message unless cause
message + serialized_exception_for(cause)
end
def serialized_exception_for(e)
<<~EOS
#{e.class}: #{e.message}
#{e.backtrace&.join("\n ")&.chomp}
EOS
end
def issues_url(exception)
message = exception.message.lines.first.tr(":", " ").chomp
message = message.split("-").first if exception.is_a?(Errno)
require "cgi"
"https://github.com/rubygems/rubygems/search?q=" \
"#{CGI.escape(message)}&type=Issues"
end
def new_issue_url
"https://github.com/rubygems/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md"
end
end
def self.with_friendly_errors
FriendlyErrors.enable!
yield
rescue SignalException
raise
rescue Exception => e # rubocop:disable Lint/RescueException
raise if FriendlyErrors.disabled?
FriendlyErrors.log_error(e)
exit FriendlyErrors.exit_status(e)
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/rubygems_integration.rb 0000644 00000033155 15173517743 0020725 0 ustar 00 # frozen_string_literal: true
require "rubygems" unless defined?(Gem)
module Bundler
class RubygemsIntegration
require "monitor"
EXT_LOCK = Monitor.new
def initialize
@replaced_methods = {}
end
def version
@version ||= Gem.rubygems_version
end
def provides?(req_str)
Gem::Requirement.new(req_str).satisfied_by?(version)
end
def supports_bundler_trampolining?
provides?(">= 3.3.0.a")
end
def build_args
require "rubygems/command"
Gem::Command.build_args
end
def build_args=(args)
require "rubygems/command"
Gem::Command.build_args = args
end
def loaded_specs(name)
Gem.loaded_specs[name]
end
def mark_loaded(spec)
if spec.respond_to?(:activated=)
current = Gem.loaded_specs[spec.name]
current.activated = false if current
spec.activated = true
end
Gem.loaded_specs[spec.name] = spec
end
def validate(spec)
Bundler.ui.silence { spec.validate_for_resolution }
rescue Gem::InvalidSpecificationException => e
error_message = "The gemspec at #{spec.loaded_from} is not valid. Please fix this gemspec.\n" \
"The validation error was '#{e.message}'\n"
raise Gem::InvalidSpecificationException.new(error_message)
rescue Errno::ENOENT
nil
end
def stub_set_spec(stub, spec)
stub.instance_variable_set(:@spec, spec)
end
def path(obj)
obj.to_s
end
def ruby_engine
Gem.ruby_engine
end
def read_binary(path)
Gem.read_binary(path)
end
def inflate(obj)
Gem::Util.inflate(obj)
end
def gem_dir
Gem.dir
end
def gem_bindir
Gem.bindir
end
def user_home
Gem.user_home
end
def gem_path
Gem.path
end
def reset
Gem::Specification.reset
end
def post_reset_hooks
Gem.post_reset_hooks
end
def suffix_pattern
Gem.suffix_pattern
end
def gem_cache
gem_path.map {|p| File.expand_path("cache", p) }
end
def spec_cache_dirs
@spec_cache_dirs ||= begin
dirs = gem_path.map {|dir| File.join(dir, "specifications") }
dirs << Gem.spec_cache_dir
dirs.uniq.select {|dir| File.directory? dir }
end
end
def marshal_spec_dir
Gem::MARSHAL_SPEC_DIR
end
def clear_paths
Gem.clear_paths
end
def bin_path(gem, bin, ver)
Gem.bin_path(gem, bin, ver)
end
def loaded_gem_paths
loaded_gem_paths = Gem.loaded_specs.map {|_, s| s.full_require_paths }
loaded_gem_paths.flatten
end
def ui=(obj)
Gem::DefaultUserInteraction.ui = obj
end
def ext_lock
EXT_LOCK
end
def spec_from_gem(path)
require "rubygems/package"
Gem::Package.new(path).spec
end
def build_gem(gem_dir, spec)
build(spec)
end
def security_policy_keys
%w[High Medium Low AlmostNo No].map {|level| "#{level}Security" }
end
def security_policies
@security_policies ||= begin
require "rubygems/security"
Gem::Security::Policies
rescue LoadError, NameError
{}
end
end
def reverse_rubygems_kernel_mixin
# Disable rubygems' gem activation system
if Gem.respond_to?(:discover_gems_on_require=)
Gem.discover_gems_on_require = false
else
[::Kernel.singleton_class, ::Kernel].each do |k|
if k.private_method_defined?(:gem_original_require)
redefine_method(k, :require, k.instance_method(:gem_original_require))
end
end
end
end
def replace_gem(specs, specs_by_name)
executables = nil
[::Kernel.singleton_class, ::Kernel].each do |kernel_class|
redefine_method(kernel_class, :gem) do |dep, *reqs|
if executables&.include?(File.basename(caller_locations(1, 1).first.path))
break
end
reqs.pop if reqs.last.is_a?(Hash)
unless dep.respond_to?(:name) && dep.respond_to?(:requirement)
dep = Gem::Dependency.new(dep, reqs)
end
if spec = specs_by_name[dep.name]
return true if dep.matches_spec?(spec)
end
message = if spec.nil?
target_file = begin
Bundler.default_gemfile.basename
rescue GemfileNotFound
"inline Gemfile"
end
"#{dep.name} is not part of the bundle." \
" Add it to your #{target_file}."
else
"can't activate #{dep}, already activated #{spec.full_name}. " \
"Make sure all dependencies are added to Gemfile."
end
e = Gem::LoadError.new(message)
e.name = dep.name
e.requirement = dep.requirement
raise e
end
# backwards compatibility shim, see https://github.com/rubygems/bundler/issues/5102
kernel_class.send(:public, :gem) if Bundler.feature_flag.setup_makes_kernel_gem_public?
end
end
# Used to make bin stubs that are not created by bundler work
# under bundler. The new Gem.bin_path only considers gems in
# +specs+
def replace_bin_path(specs_by_name)
gem_class = (class << Gem; self; end)
redefine_method(gem_class, :find_spec_for_exe) do |gem_name, *args|
exec_name = args.first
raise ArgumentError, "you must supply exec_name" unless exec_name
spec_with_name = specs_by_name[gem_name]
matching_specs_by_exec_name = specs_by_name.values.select {|s| s.executables.include?(exec_name) }
spec = matching_specs_by_exec_name.delete(spec_with_name)
unless spec || !matching_specs_by_exec_name.empty?
message = "can't find executable #{exec_name} for gem #{gem_name}"
if spec_with_name.nil?
message += ". #{gem_name} is not currently included in the bundle, " \
"perhaps you meant to add it to your #{Bundler.default_gemfile.basename}?"
end
raise Gem::Exception, message
end
unless spec
spec = matching_specs_by_exec_name.shift
warn \
"Bundler is using a binstub that was created for a different gem (#{spec.name}).\n" \
"You should run `bundle binstub #{gem_name}` " \
"to work around a system/bundle conflict."
end
unless matching_specs_by_exec_name.empty?
conflicting_names = matching_specs_by_exec_name.map(&:name).join(", ")
warn \
"The `#{exec_name}` executable in the `#{spec.name}` gem is being loaded, but it's also present in other gems (#{conflicting_names}).\n" \
"If you meant to run the executable for another gem, make sure you use a project specific binstub (`bundle binstub <gem_name>`).\n" \
"If you plan to use multiple conflicting executables, generate binstubs for them and disambiguate their names."
end
spec
end
redefine_method(gem_class, :activate_bin_path) do |name, *args|
exec_name = args.first
return ENV["BUNDLE_BIN_PATH"] if exec_name == "bundle"
# Copy of Rubygems activate_bin_path impl
requirement = args.last
spec = find_spec_for_exe name, exec_name, [requirement]
gem_bin = File.join(spec.full_gem_path, spec.bindir, exec_name)
gem_from_path_bin = File.join(File.dirname(spec.loaded_from), spec.bindir, exec_name)
File.exist?(gem_bin) ? gem_bin : gem_from_path_bin
end
redefine_method(gem_class, :bin_path) do |name, *args|
exec_name = args.first
return ENV["BUNDLE_BIN_PATH"] if exec_name == "bundle"
spec = find_spec_for_exe(name, *args)
exec_name ||= spec.default_executable
gem_bin = File.join(spec.full_gem_path, spec.bindir, exec_name)
gem_from_path_bin = File.join(File.dirname(spec.loaded_from), spec.bindir, exec_name)
File.exist?(gem_bin) ? gem_bin : gem_from_path_bin
end
end
# Replace or hook into RubyGems to provide a bundlerized view
# of the world.
def replace_entrypoints(specs)
specs_by_name = add_default_gems_to(specs)
reverse_rubygems_kernel_mixin
begin
# bundled_gems only provide with Ruby 3.3 or later
require "bundled_gems"
rescue LoadError
else
Gem::BUNDLED_GEMS.replace_require(specs) if Gem::BUNDLED_GEMS.respond_to?(:replace_require)
end
replace_gem(specs, specs_by_name)
stub_rubygems(specs)
replace_bin_path(specs_by_name)
Gem.clear_paths
end
# Add default gems not already present in specs, and return them as a hash.
def add_default_gems_to(specs)
specs_by_name = specs.reduce({}) do |h, s|
h[s.name] = s
h
end
Bundler.rubygems.default_stubs.each do |stub|
default_spec = stub.to_spec
default_spec_name = default_spec.name
next if specs_by_name.key?(default_spec_name)
specs << default_spec
specs_by_name[default_spec_name] = default_spec
end
specs_by_name
end
def undo_replacements
@replaced_methods.each do |(sym, klass), method|
redefine_method(klass, sym, method)
end
if Binding.public_method_defined?(:source_location)
post_reset_hooks.reject! {|proc| proc.binding.source_location[0] == __FILE__ }
else
post_reset_hooks.reject! {|proc| proc.binding.eval("__FILE__") == __FILE__ }
end
@replaced_methods.clear
end
def redefine_method(klass, method, unbound_method = nil, &block)
visibility = method_visibility(klass, method)
begin
if (instance_method = klass.instance_method(method)) && method != :initialize
# doing this to ensure we also get private methods
klass.send(:remove_method, method)
end
rescue NameError
# method isn't defined
nil
end
@replaced_methods[[method, klass]] = instance_method
if unbound_method
klass.send(:define_method, method, unbound_method)
klass.send(visibility, method)
elsif block
klass.send(:define_method, method, &block)
klass.send(visibility, method)
end
end
def method_visibility(klass, method)
if klass.private_method_defined?(method)
:private
elsif klass.protected_method_defined?(method)
:protected
else
:public
end
end
def stub_rubygems(specs)
Gem::Specification.all = specs
Gem.post_reset do
Gem::Specification.all = specs
end
redefine_method((class << Gem; self; end), :finish_resolve) do |*|
[]
end
end
def plain_specs
Gem::Specification._all
end
def plain_specs=(specs)
Gem::Specification.all = specs
end
def fetch_specs(remote, name, fetcher)
require "rubygems/remote_fetcher"
path = remote.uri.to_s + "#{name}.#{Gem.marshal_version}.gz"
string = fetcher.fetch_path(path)
specs = Bundler.safe_load_marshal(string)
raise MarshalError, "Specs #{name} from #{remote} is expected to be an Array but was unexpected class #{specs.class}" unless specs.is_a?(Array)
specs
rescue Gem::RemoteFetcher::FetchError
# it's okay for prerelease to fail
raise unless name == "prerelease_specs"
end
def fetch_all_remote_specs(remote, gem_remote_fetcher)
specs = fetch_specs(remote, "specs", gem_remote_fetcher)
pres = fetch_specs(remote, "prerelease_specs", gem_remote_fetcher) || []
specs.concat(pres)
end
def download_gem(spec, uri, cache_dir, fetcher)
require "rubygems/remote_fetcher"
uri = Bundler.settings.mirror_for(uri)
Bundler::Retry.new("download gem from #{uri}").attempts do
gem_file_name = spec.file_name
local_gem_path = File.join cache_dir, gem_file_name
return if File.exist? local_gem_path
begin
remote_gem_path = uri + "gems/#{gem_file_name}"
SharedHelpers.filesystem_access(local_gem_path) do
fetcher.cache_update_path remote_gem_path, local_gem_path
end
rescue Gem::RemoteFetcher::FetchError
raise if spec.original_platform == spec.platform
original_gem_file_name = "#{spec.original_name}.gem"
raise if gem_file_name == original_gem_file_name
gem_file_name = original_gem_file_name
retry
end
end
rescue Gem::RemoteFetcher::FetchError => e
raise Bundler::HTTPError, "Could not download gem from #{uri} due to underlying error <#{e.message}>"
end
def build(spec, skip_validation = false)
require "rubygems/package"
Gem::Package.build(spec, skip_validation)
end
def path_separator
Gem.path_separator
end
def all_specs
SharedHelpers.major_deprecation 2, "Bundler.rubygems.all_specs has been removed in favor of Bundler.rubygems.installed_specs"
Gem::Specification.stubs.map do |stub|
StubSpecification.from_stub(stub)
end
end
def installed_specs
Gem::Specification.stubs.reject(&:default_gem?).map do |stub|
StubSpecification.from_stub(stub)
end
end
def default_specs
Gem::Specification.default_stubs.map do |stub|
StubSpecification.from_stub(stub)
end
end
def find_bundler(version)
find_name("bundler").find {|s| s.version.to_s == version }
end
def find_name(name)
Gem::Specification.stubs_for(name).map(&:to_spec)
end
def default_stubs
Gem::Specification.default_stubs("*.gemspec")
end
end
def self.rubygems
@rubygems ||= RubygemsIntegration.new
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/ruby_dsl.rb 0000644 00000003517 15173517743 0016307 0 ustar 00 # frozen_string_literal: true
module Bundler
module RubyDsl
def ruby(*ruby_version)
options = ruby_version.pop if ruby_version.last.is_a?(Hash)
ruby_version.flatten!
if options
patchlevel = options[:patchlevel]
engine = options[:engine]
engine_version = options[:engine_version]
raise GemfileError, "Please define :engine_version" if engine && engine_version.nil?
raise GemfileError, "Please define :engine" if engine_version && engine.nil?
if options[:file]
raise GemfileError, "Do not pass version argument when using :file option" unless ruby_version.empty?
ruby_version << normalize_ruby_file(options[:file])
end
if engine == "ruby" && engine_version && ruby_version != Array(engine_version)
raise GemfileEvalError, "ruby_version must match the :engine_version for MRI"
end
end
@ruby_version = RubyVersion.new(ruby_version, patchlevel, engine, engine_version)
end
# Support the various file formats found in .ruby-version files.
#
# 3.2.2
# ruby-3.2.2
#
# Also supports .tool-versions files for asdf. Lines not starting with "ruby" are ignored.
#
# ruby 2.5.1 # comment is ignored
# ruby 2.5.1# close comment and extra spaces doesn't confuse
#
# Intentionally does not support `3.2.1@gemset` since rvm recommends using .ruby-gemset instead
#
# Loads the file relative to the dirname of the Gemfile itself.
def normalize_ruby_file(filename)
file_content = Bundler.read_file(gemfile.dirname.join(filename))
# match "ruby-3.2.2" or "ruby 3.2.2" capturing version string up to the first space or comment
if /^ruby(-|\s+)([^\s#]+)/.match(file_content)
$2
else
file_content.strip
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/settings.rb 0000644 00000036020 15173517743 0016317 0 ustar 00 # frozen_string_literal: true
module Bundler
class Settings
autoload :Mirror, File.expand_path("mirror", __dir__)
autoload :Mirrors, File.expand_path("mirror", __dir__)
autoload :Validator, File.expand_path("settings/validator", __dir__)
BOOL_KEYS = %w[
allow_offline_install
auto_clean_without_path
auto_install
cache_all
cache_all_platforms
clean
default_install_uses_path
deployment
disable_checksum_validation
disable_exec_load
disable_local_branch_check
disable_local_revision_check
disable_shared_gems
disable_version_check
force_ruby_platform
forget_cli_options
frozen
gem.changelog
gem.coc
gem.mit
git.allow_insecure
global_gem_cache
ignore_messages
init_gems_rb
inline
no_install
no_prune
path_relative_to_cwd
path.system
plugins
prefer_patch
print_only_version_number
setup_makes_kernel_gem_public
silence_deprecations
silence_root_warning
update_requires_all_flag
].freeze
REMEMBERED_KEYS = %w[
bin
cache_all
clean
deployment
frozen
no_prune
path
shebang
path.system
without
with
].freeze
NUMBER_KEYS = %w[
jobs
redirect
retry
ssl_verify_mode
timeout
].freeze
ARRAY_KEYS = %w[
only
with
without
].freeze
STRING_KEYS = %w[
bin
cache_path
console
gem.ci
gem.github_username
gem.linter
gem.rubocop
gem.test
gemfile
path
shebang
system_bindir
trust-policy
version
].freeze
DEFAULT_CONFIG = {
"BUNDLE_SILENCE_DEPRECATIONS" => false,
"BUNDLE_DISABLE_VERSION_CHECK" => true,
"BUNDLE_PREFER_PATCH" => false,
"BUNDLE_REDIRECT" => 5,
"BUNDLE_RETRY" => 3,
"BUNDLE_TIMEOUT" => 10,
"BUNDLE_VERSION" => "lockfile",
}.freeze
def initialize(root = nil)
@root = root
@local_config = load_config(local_config_file)
@local_root = root || Pathname.new(".bundle").expand_path
@env_config = ENV.to_h
@env_config.select! {|key, _value| key.start_with?("BUNDLE_") }
@env_config.delete("BUNDLE_")
@global_config = load_config(global_config_file)
@temporary = {}
@key_cache = {}
end
def [](name)
key = key_for(name)
value = nil
configs.each do |_, config|
value = config[key]
next if value.nil?
break
end
converted_value(value, name)
end
def set_command_option(key, value)
if !is_remembered(key) || Bundler.feature_flag.forget_cli_options?
temporary(key => value)
value
else
set_local(key, value)
end
end
def set_command_option_if_given(key, value)
return if value.nil?
set_command_option(key, value)
end
def set_local(key, value)
local_config_file = @local_root.join("config")
set_key(key, value, @local_config, local_config_file)
end
def temporary(update)
existing = Hash[update.map {|k, _| [k, @temporary[key_for(k)]] }]
update.each do |k, v|
set_key(k, v, @temporary, nil)
end
return unless block_given?
begin
yield
ensure
existing.each {|k, v| set_key(k, v, @temporary, nil) }
end
end
def set_global(key, value)
set_key(key, value, @global_config, global_config_file)
end
def all
keys = @temporary.keys.union(@global_config.keys, @local_config.keys, @env_config.keys)
keys.map! do |key|
key = key.delete_prefix("BUNDLE_")
key.gsub!("___", "-")
key.gsub!("__", ".")
key.downcase!
key
end.sort!
keys
end
def local_overrides
repos = {}
all.each do |k|
repos[k.delete_prefix("local.")] = self[k] if k.start_with?("local.")
end
repos
end
def mirror_for(uri)
if uri.is_a?(String)
require_relative "vendored_uri"
uri = Gem::URI(uri)
end
gem_mirrors.for(uri.to_s).uri
end
def credentials_for(uri)
self[uri.to_s] || self[uri.host]
end
def gem_mirrors
all.inject(Mirrors.new) do |mirrors, k|
mirrors.parse(k, self[k]) if k.start_with?("mirror.")
mirrors
end
end
def locations(key)
key = key_for(key)
configs.keys.inject({}) do |partial_locations, level|
value_on_level = configs[level][key]
partial_locations[level] = value_on_level unless value_on_level.nil?
partial_locations
end
end
def pretty_values_for(exposed_key)
key = key_for(exposed_key)
locations = []
if value = @temporary[key]
locations << "Set for the current command: #{printable_value(value, exposed_key).inspect}"
end
if value = @local_config[key]
locations << "Set for your local app (#{local_config_file}): #{printable_value(value, exposed_key).inspect}"
end
if value = @env_config[key]
locations << "Set via #{key}: #{printable_value(value, exposed_key).inspect}"
end
if value = @global_config[key]
locations << "Set for the current user (#{global_config_file}): #{printable_value(value, exposed_key).inspect}"
end
return ["You have not configured a value for `#{exposed_key}`"] if locations.empty?
locations
end
def processor_count
require "etc"
Etc.nprocessors
rescue StandardError
1
end
# for legacy reasons, in Bundler 2, we do not respect :disable_shared_gems
def path
configs.each do |_level, settings|
path = value_for("path", settings)
path_system = value_for("path.system", settings)
disabled_shared_gems = value_for("disable_shared_gems", settings)
next if path.nil? && path_system.nil? && disabled_shared_gems.nil?
system_path = path_system || (disabled_shared_gems == false)
return Path.new(path, system_path)
end
path = "vendor/bundle" if self[:deployment]
Path.new(path, false)
end
Path = Struct.new(:explicit_path, :system_path) do
def path
path = base_path
path = File.join(path, Bundler.ruby_scope) unless use_system_gems?
path
end
def use_system_gems?
return true if system_path
return false if explicit_path
!Bundler.feature_flag.default_install_uses_path?
end
def base_path
path = explicit_path
path ||= ".bundle" unless use_system_gems?
path ||= Bundler.rubygems.gem_dir
path
end
def base_path_relative_to_pwd
base_path = Pathname.new(self.base_path)
expanded_base_path = base_path.expand_path(Bundler.root)
relative_path = expanded_base_path.relative_path_from(Pathname.pwd)
if relative_path.to_s.start_with?("..")
relative_path = base_path if base_path.absolute?
else
relative_path = Pathname.new(File.join(".", relative_path))
end
relative_path
rescue ArgumentError
expanded_base_path
end
def validate!
return unless explicit_path && system_path
path = Bundler.settings.pretty_values_for(:path)
path.unshift(nil, "path:") unless path.empty?
system_path = Bundler.settings.pretty_values_for("path.system")
system_path.unshift(nil, "path.system:") unless system_path.empty?
disable_shared_gems = Bundler.settings.pretty_values_for(:disable_shared_gems)
disable_shared_gems.unshift(nil, "disable_shared_gems:") unless disable_shared_gems.empty?
raise InvalidOption,
"Using a custom path while using system gems is unsupported.\n#{path.join("\n")}\n#{system_path.join("\n")}\n#{disable_shared_gems.join("\n")}"
end
end
def ignore_config?
ENV["BUNDLE_IGNORE_CONFIG"]
end
def app_cache_path
@app_cache_path ||= self[:cache_path] || "vendor/cache"
end
def validate!
all.each do |raw_key|
[@local_config, @env_config, @global_config].each do |settings|
value = value_for(raw_key, settings)
Validator.validate!(raw_key, value, settings.dup)
end
end
end
def key_for(key)
@key_cache[key] ||= self.class.key_for(key)
end
private
def configs
@configs ||= {
temporary: @temporary,
local: @local_config,
env: @env_config,
global: @global_config,
default: DEFAULT_CONFIG,
}
end
def value_for(name, config)
converted_value(config[key_for(name)], name)
end
def parent_setting_for(name)
split_specific_setting_for(name)[0]
end
def specific_gem_for(name)
split_specific_setting_for(name)[1]
end
def split_specific_setting_for(name)
name.split(".")
end
def is_bool(name)
name = self.class.key_to_s(name)
BOOL_KEYS.include?(name) || BOOL_KEYS.include?(parent_setting_for(name))
end
def is_string(name)
name = self.class.key_to_s(name)
STRING_KEYS.include?(name) || name.start_with?("local.") || name.start_with?("mirror.") || name.start_with?("build.")
end
def to_bool(value)
case value
when String
value.match?(/\A(false|f|no|n|0|)\z/i) ? false : true
when nil, false
false
else
true
end
end
def is_num(key)
NUMBER_KEYS.include?(self.class.key_to_s(key))
end
def is_array(key)
ARRAY_KEYS.include?(self.class.key_to_s(key))
end
def is_remembered(key)
REMEMBERED_KEYS.include?(self.class.key_to_s(key))
end
def is_credential(key)
key == "gem.push_key"
end
def is_userinfo(value)
value.include?(":")
end
def to_array(value)
return [] unless value
value.tr(" ", ":").split(":").map(&:to_sym)
end
def array_to_s(array)
array = Array(array)
return nil if array.empty?
array.join(":").tr(" ", ":")
end
def set_key(raw_key, value, hash, file)
raw_key = self.class.key_to_s(raw_key)
value = array_to_s(value) if is_array(raw_key)
key = key_for(raw_key)
return if hash[key] == value
hash[key] = value
hash.delete(key) if value.nil?
Validator.validate!(raw_key, converted_value(value, raw_key), hash)
return unless file
SharedHelpers.filesystem_access(file) do |p|
FileUtils.mkdir_p(p.dirname)
p.open("w") {|f| f.write(serializer_class.dump(hash)) }
end
end
def converted_value(value, key)
key = self.class.key_to_s(key)
if is_array(key)
to_array(value)
elsif value.nil?
nil
elsif is_bool(key) || value == "false"
to_bool(value)
elsif is_num(key)
value.to_i
else
value.to_s
end
end
def printable_value(value, key)
converted = converted_value(value, key)
return converted unless converted.is_a?(String)
if is_string(key)
converted
elsif is_credential(key)
"[REDACTED]"
elsif is_userinfo(converted)
username, pass = converted.split(":", 2)
if pass == "x-oauth-basic"
username = "[REDACTED]"
else
pass = "[REDACTED]"
end
[username, pass].join(":")
else
converted
end
end
def global_config_file
if ENV["BUNDLE_CONFIG"] && !ENV["BUNDLE_CONFIG"].empty?
Pathname.new(ENV["BUNDLE_CONFIG"])
elsif ENV["BUNDLE_USER_CONFIG"] && !ENV["BUNDLE_USER_CONFIG"].empty?
Pathname.new(ENV["BUNDLE_USER_CONFIG"])
elsif ENV["BUNDLE_USER_HOME"] && !ENV["BUNDLE_USER_HOME"].empty?
Pathname.new(ENV["BUNDLE_USER_HOME"]).join("config")
elsif Bundler.rubygems.user_home && !Bundler.rubygems.user_home.empty?
Pathname.new(Bundler.rubygems.user_home).join(".bundle/config")
end
end
def local_config_file
Pathname.new(@root).join("config") if @root
end
def load_config(config_file)
return {} if !config_file || ignore_config?
SharedHelpers.filesystem_access(config_file, :read) do |file|
valid_file = file.exist? && !file.size.zero?
return {} unless valid_file
serializer_class.load(file.read).inject({}) do |config, (k, v)|
k = k.dup
k << "/" if /https?:/i.match?(k) && !k.end_with?("/", "__#{FALLBACK_TIMEOUT_URI_OPTION.upcase}")
k.gsub!(".", "__")
unless k.start_with?("#")
if k.include?("-")
Bundler.ui.warn "Your #{file} config includes `#{k}`, which contains the dash character (`-`).\n" \
"This is deprecated, because configuration through `ENV` should be possible, but `ENV` keys cannot include dashes.\n" \
"Please edit #{file} and replace any dashes in configuration keys with a triple underscore (`___`)."
# string hash keys are frozen
k = k.gsub("-", "___")
end
config[k] = v
end
config
end
end
end
def serializer_class
require "rubygems/yaml_serializer"
Gem::YAMLSerializer
rescue LoadError
# TODO: Remove this when RubyGems 3.4 is EOL
require_relative "yaml_serializer"
YAMLSerializer
end
FALLBACK_TIMEOUT_URI_OPTION = "fallback_timeout"
NORMALIZE_URI_OPTIONS_PATTERN =
/
\A
(\w+\.)? # optional prefix key
(https?.*?) # URI
(\.#{FALLBACK_TIMEOUT_URI_OPTION})? # optional suffix key
\z
/ix
def self.key_for(key)
key = key_to_s(key)
key = normalize_uri(key) if key.start_with?("http", "mirror.http")
key = key.gsub(".", "__")
key.gsub!("-", "___")
key.upcase!
key.gsub(/\A([ #]*)/, '\1BUNDLE_')
end
# TODO: duplicates Rubygems#normalize_uri
# TODO: is this the correct place to validate mirror URIs?
def self.normalize_uri(uri)
uri = uri.to_s
if uri =~ NORMALIZE_URI_OPTIONS_PATTERN
prefix = $1
uri = $2
suffix = $3
end
uri = URINormalizer.normalize_suffix(uri)
require_relative "vendored_uri"
uri = Gem::URI(uri)
unless uri.absolute?
raise ArgumentError, format("Gem sources must be absolute. You provided '%s'.", uri)
end
"#{prefix}#{uri}#{suffix}"
end
# This is a hot method, so avoid respond_to? checks on every invocation
if :read.respond_to?(:name)
def self.key_to_s(key)
case key
when String
key
when Symbol
key.name
when Gem::URI::HTTP
key.to_s
else
raise ArgumentError, "Invalid key: #{key.inspect}"
end
end
else
def self.key_to_s(key)
case key
when String
key
when Symbol
key.to_s
when Gem::URI::HTTP
key.to_s
else
raise ArgumentError, "Invalid key: #{key.inspect}"
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/graph.rb 0000644 00000011715 15173517743 0015564 0 ustar 00 # frozen_string_literal: true
require "set"
module Bundler
class Graph
GRAPH_NAME = :Gemfile
def initialize(env, output_file, show_version = false, show_requirements = false, output_format = "png", without = [])
@env = env
@output_file = output_file
@show_version = show_version
@show_requirements = show_requirements
@output_format = output_format
@without_groups = without.map(&:to_sym)
@groups = []
@relations = Hash.new {|h, k| h[k] = Set.new }
@node_options = {}
@edge_options = {}
_populate_relations
end
attr_reader :groups, :relations, :node_options, :edge_options, :output_file, :output_format
def viz
GraphVizClient.new(self).run
end
private
def _populate_relations
parent_dependencies = _groups.values.to_set.flatten
loop do
break if parent_dependencies.empty?
tmp = Set.new
parent_dependencies.each do |dependency|
child_dependencies = spec_for_dependency(dependency).runtime_dependencies.to_set
@relations[dependency.name] += child_dependencies.map(&:name).to_set
tmp += child_dependencies
@node_options[dependency.name] = _make_label(dependency, :node)
child_dependencies.each do |c_dependency|
@edge_options["#{dependency.name}_#{c_dependency.name}"] = _make_label(c_dependency, :edge)
end
end
parent_dependencies = tmp
end
end
def _groups
relations = Hash.new {|h, k| h[k] = Set.new }
@env.current_dependencies.each do |dependency|
dependency.groups.each do |group|
next if @without_groups.include?(group)
relations[group.to_s].add(dependency)
@relations[group.to_s].add(dependency.name)
@node_options[group.to_s] ||= _make_label(group, :node)
@edge_options["#{group}_#{dependency.name}"] = _make_label(dependency, :edge)
end
end
@groups = relations.keys
relations
end
def _make_label(symbol_or_string_or_dependency, element_type)
case element_type.to_sym
when :node
if symbol_or_string_or_dependency.is_a?(Gem::Dependency)
label = symbol_or_string_or_dependency.name.dup
label << "\n#{spec_for_dependency(symbol_or_string_or_dependency).version}" if @show_version
else
label = symbol_or_string_or_dependency.to_s
end
when :edge
label = nil
if symbol_or_string_or_dependency.respond_to?(:requirements_list) && @show_requirements
tmp = symbol_or_string_or_dependency.requirements_list.join(", ")
label = tmp if tmp != ">= 0"
end
else
raise ArgumentError, "2nd argument is invalid"
end
label.nil? ? {} : { label: label }
end
def spec_for_dependency(dependency)
@env.requested_specs.find {|s| s.name == dependency.name }
end
class GraphVizClient
def initialize(graph_instance)
@graph_name = graph_instance.class::GRAPH_NAME
@groups = graph_instance.groups
@relations = graph_instance.relations
@node_options = graph_instance.node_options
@edge_options = graph_instance.edge_options
@output_file = graph_instance.output_file
@output_format = graph_instance.output_format
end
def g
@g ||= ::GraphViz.digraph(@graph_name, concentrate: true, normalize: true, nodesep: 0.55) do |g|
g.edge[:weight] = 2
g.edge[:fontname] = g.node[:fontname] = "Arial, Helvetica, SansSerif"
g.edge[:fontsize] = 12
end
end
def run
@groups.each do |group|
g.add_nodes(
group, {
style: "filled",
fillcolor: "#B9B9D5",
shape: "box3d",
fontsize: 16,
}.merge(@node_options[group])
)
end
@relations.each do |parent, children|
children.each do |child|
if @groups.include?(parent)
g.add_nodes(child, { style: "filled", fillcolor: "#B9B9D5" }.merge(@node_options[child]))
g.add_edges(parent, child, { constraint: false }.merge(@edge_options["#{parent}_#{child}"]))
else
g.add_nodes(child, @node_options[child])
g.add_edges(parent, child, @edge_options["#{parent}_#{child}"])
end
end
end
if @output_format.to_s == "debug"
$stdout.puts g.output none: String
Bundler.ui.info "debugging bundle viz..."
else
begin
g.output @output_format.to_sym => "#{@output_file}.#{@output_format}"
Bundler.ui.info "#{@output_file}.#{@output_format}"
rescue ArgumentError => e
warn "Unsupported output format. See Ruby-Graphviz/lib/graphviz/constants.rb"
raise e
end
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_timeout.rb 0000644 00000000321 15173517743 0020026 0 ustar 00 # frozen_string_literal: true
begin
require "rubygems/vendored_timeout"
rescue LoadError
begin
require "rubygems/timeout"
rescue LoadError
require "timeout"
Gem::Timeout = Timeout
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/rubygems_ext.rb 0000644 00000033205 15173517743 0017176 0 ustar 00 # frozen_string_literal: true
require "rubygems" unless defined?(Gem)
# We can't let `Gem::Source` be autoloaded in the `Gem::Specification#source`
# redefinition below, so we need to load it upfront. The reason is that if
# Bundler monkeypatches are loaded before RubyGems activates an executable (for
# example, through `ruby -rbundler -S irb`), gem activation might end up calling
# the redefined `Gem::Specification#source` and triggering the `Gem::Source`
# autoload. That would result in requiring "rubygems/source" inside another
# require, which would trigger a monitor error and cause the `autoload` to
# eventually fail. A better solution is probably to completely avoid autoloading
# `Gem::Source` from the redefined `Gem::Specification#source`.
require "rubygems/source"
# Cherry-pick fixes to `Gem.ruby_version` to be useful for modern Bundler
# versions and ignore patchlevels
# (https://github.com/rubygems/rubygems/pull/5472,
# https://github.com/rubygems/rubygems/pull/5486). May be removed once RubyGems
# 3.3.12 support is dropped.
unless Gem.ruby_version.to_s == RUBY_VERSION || RUBY_PATCHLEVEL == -1
Gem.instance_variable_set(:@ruby_version, Gem::Version.new(RUBY_VERSION))
end
module Gem
# Can be removed once RubyGems 3.5.11 support is dropped
unless Gem.respond_to?(:freebsd_platform?)
def self.freebsd_platform?
RbConfig::CONFIG["host_os"].to_s.include?("bsd")
end
end
# Can be removed once RubyGems 3.5.18 support is dropped
unless Gem.respond_to?(:open_file_with_lock)
class << self
remove_method :open_file_with_flock if Gem.respond_to?(:open_file_with_flock)
def open_file_with_flock(path, &block)
# read-write mode is used rather than read-only in order to support NFS
mode = IO::RDWR | IO::APPEND | IO::CREAT | IO::BINARY
mode |= IO::SHARE_DELETE if IO.const_defined?(:SHARE_DELETE)
File.open(path, mode) do |io|
begin
io.flock(File::LOCK_EX)
rescue Errno::ENOSYS, Errno::ENOTSUP
end
yield io
end
end
def open_file_with_lock(path, &block)
file_lock = "#{path}.lock"
open_file_with_flock(file_lock, &block)
ensure
FileUtils.rm_f file_lock
end
end
end
require "rubygems/specification"
# Can be removed once RubyGems 3.5.14 support is dropped
VALIDATES_FOR_RESOLUTION = Specification.new.respond_to?(:validate_for_resolution).freeze
# Can be removed once RubyGems 3.3.15 support is dropped
FLATTENS_REQUIRED_PATHS = Specification.new.respond_to?(:flatten_require_paths).freeze
class Specification
# Can be removed once RubyGems 3.5.15 support is dropped
correct_array_attributes = @@default_value.select {|_k,v| v.is_a?(Array) }.keys
unless @@array_attributes == correct_array_attributes
@@array_attributes = correct_array_attributes # rubocop:disable Style/ClassVars
end
require_relative "match_metadata"
require_relative "match_platform"
include ::Bundler::MatchMetadata
include ::Bundler::MatchPlatform
attr_accessor :remote, :location, :relative_loaded_from
remove_method :source
attr_writer :source
def source
(defined?(@source) && @source) || Gem::Source::Installed.new
end
alias_method :rg_full_gem_path, :full_gem_path
alias_method :rg_loaded_from, :loaded_from
def full_gem_path
if source.respond_to?(:root)
File.expand_path(File.dirname(loaded_from), source.root)
else
rg_full_gem_path
end
end
def loaded_from
if relative_loaded_from
source.path.join(relative_loaded_from).to_s
else
rg_loaded_from
end
end
def load_paths
full_require_paths
end
alias_method :rg_extension_dir, :extension_dir
def extension_dir
# following instance variable is already used in original method
# and that is the reason to prefix it with bundler_ and add rubocop exception
@bundler_extension_dir ||= if source.respond_to?(:extension_dir_name) # rubocop:disable Naming/MemoizedInstanceVariableName
unique_extension_dir = [source.extension_dir_name, File.basename(full_gem_path)].uniq.join("-")
File.expand_path(File.join(extensions_dir, unique_extension_dir))
else
rg_extension_dir
end
end
remove_method :gem_dir
def gem_dir
full_gem_path
end
unless const_defined?(:LATEST_RUBY_WITHOUT_PATCH_VERSIONS)
LATEST_RUBY_WITHOUT_PATCH_VERSIONS = Gem::Version.new("2.1")
alias_method :rg_required_ruby_version=, :required_ruby_version=
def required_ruby_version=(req)
self.rg_required_ruby_version = req
@required_ruby_version.requirements.map! do |op, v|
if v >= LATEST_RUBY_WITHOUT_PATCH_VERSIONS && v.release.segments.size == 4
[op == "~>" ? "=" : op, Gem::Version.new(v.segments.tap {|s| s.delete_at(3) }.join("."))]
else
[op, v]
end
end
end
end
def groups
@groups ||= []
end
def git_version
return unless loaded_from && source.is_a?(Bundler::Source::Git)
" #{source.revision[0..6]}"
end
def to_gemfile(path = nil)
gemfile = String.new("source 'https://rubygems.org'\n")
gemfile << dependencies_to_gemfile(nondevelopment_dependencies)
unless development_dependencies.empty?
gemfile << "\n"
gemfile << dependencies_to_gemfile(development_dependencies, :development)
end
gemfile
end
def nondevelopment_dependencies
dependencies - development_dependencies
end
def deleted_gem?
!default_gem? && !File.directory?(full_gem_path)
end
unless VALIDATES_FOR_RESOLUTION
def validate_for_resolution
SpecificationPolicy.new(self).validate_for_resolution
end
end
unless FLATTENS_REQUIRED_PATHS
def flatten_require_paths
return unless raw_require_paths.first.is_a?(Array)
warn "#{name} #{version} includes a gemspec with `require_paths` set to an array of arrays. Newer versions of this gem might've already fixed this"
raw_require_paths.flatten!
end
class << self
module RequirePathFlattener
def from_yaml(input)
spec = super(input)
spec.flatten_require_paths
spec
end
end
prepend RequirePathFlattener
end
end
private
def dependencies_to_gemfile(dependencies, group = nil)
gemfile = String.new
if dependencies.any?
gemfile << "group :#{group} do\n" if group
dependencies.each do |dependency|
gemfile << " " if group
gemfile << %(gem "#{dependency.name}")
req = dependency.requirements_list.first
gemfile << %(, "#{req}") if req
gemfile << "\n"
end
gemfile << "end\n" if group
end
gemfile
end
end
unless VALIDATES_FOR_RESOLUTION
class SpecificationPolicy
def validate_for_resolution
validate_required!
end
end
end
module BetterPermissionError
def data
super
rescue Errno::EACCES
raise Bundler::PermissionError.new(loaded_from, :read)
end
end
require "rubygems/stub_specification"
class StubSpecification
prepend BetterPermissionError
end
class Dependency
require_relative "force_platform"
include ::Bundler::ForcePlatform
attr_reader :force_ruby_platform
attr_accessor :source, :groups
alias_method :eql?, :==
unless method_defined?(:encode_with, false)
def encode_with(coder)
[:@name, :@requirement, :@type, :@prerelease, :@version_requirements].each do |ivar|
coder[ivar.to_s.sub(/^@/, "")] = instance_variable_get(ivar)
end
end
end
def to_lock
out = String.new(" #{name}")
unless requirement.none?
reqs = requirement.requirements.map {|o, v| "#{o} #{v}" }.sort.reverse
out << " (#{reqs.join(", ")})"
end
out
end
if Gem.rubygems_version < Gem::Version.new("3.5.22")
module FilterIgnoredSpecs
def matching_specs(platform_only = false)
super.reject(&:ignored?)
end
end
prepend FilterIgnoredSpecs
end
end
# Requirements using lambda operator differentiate trailing zeros since rubygems 3.2.6
if Gem::Requirement.new("~> 2.0").hash == Gem::Requirement.new("~> 2.0.0").hash
class Requirement
module CorrectHashForLambdaOperator
def hash
if requirements.any? {|r| r.first == "~>" }
requirements.map {|r| r.first == "~>" ? [r[0], r[1].to_s] : r }.sort.hash
else
super
end
end
end
prepend CorrectHashForLambdaOperator
end
end
require "rubygems/platform"
class Platform
JAVA = Gem::Platform.new("java")
MSWIN = Gem::Platform.new("mswin32")
MSWIN64 = Gem::Platform.new("mswin64")
MINGW = Gem::Platform.new("x86-mingw32")
X64_MINGW = [Gem::Platform.new("x64-mingw32"),
Gem::Platform.new("x64-mingw-ucrt")].freeze
WINDOWS = [MSWIN, MSWIN64, MINGW, X64_MINGW].flatten.freeze
X64_LINUX = Gem::Platform.new("x86_64-linux")
X64_LINUX_MUSL = Gem::Platform.new("x86_64-linux-musl")
if X64_LINUX === X64_LINUX_MUSL
remove_method :===
def ===(other)
return nil unless Gem::Platform === other
# universal-mingw32 matches x64-mingw-ucrt
return true if (@cpu == "universal" || other.cpu == "universal") &&
@os.start_with?("mingw") && other.os.start_with?("mingw")
# cpu
([nil,"universal"].include?(@cpu) || [nil, "universal"].include?(other.cpu) || @cpu == other.cpu ||
(@cpu == "arm" && other.cpu.start_with?("armv"))) &&
# os
@os == other.os &&
# version
(
(@os != "linux" && (@version.nil? || other.version.nil?)) ||
(@os == "linux" && (normalized_linux_version_ext == other.normalized_linux_version_ext || ["musl#{@version}", "musleabi#{@version}", "musleabihf#{@version}"].include?(other.version))) ||
@version == other.version
)
end
# This is a copy of RubyGems 3.3.23 or higher `normalized_linux_method`.
# Once only 3.3.23 is supported, we can use the method in RubyGems.
def normalized_linux_version_ext
return nil unless @version
without_gnu_nor_abi_modifiers = @version.sub(/\Agnu/, "").sub(/eabi(hf)?\Z/, "")
return nil if without_gnu_nor_abi_modifiers.empty?
without_gnu_nor_abi_modifiers
end
end
if RUBY_ENGINE == "truffleruby" && !defined?(REUSE_AS_BINARY_ON_TRUFFLERUBY)
REUSE_AS_BINARY_ON_TRUFFLERUBY = %w[libv8 libv8-node sorbet-static].freeze
end
end
Platform.singleton_class.module_eval do
unless Platform.singleton_methods.include?(:match_spec?)
def match_spec?(spec)
match_gem?(spec.platform, spec.name)
end
def match_gem?(platform, gem_name)
match_platforms?(platform, Gem.platforms)
end
end
match_platforms_defined = Gem::Platform.respond_to?(:match_platforms?, true)
if !match_platforms_defined || Gem::Platform.send(:match_platforms?, Gem::Platform::X64_LINUX_MUSL, [Gem::Platform::X64_LINUX])
private
remove_method :match_platforms? if match_platforms_defined
def match_platforms?(platform, platforms)
platforms.any? do |local_platform|
platform.nil? ||
local_platform == platform ||
(local_platform != Gem::Platform::RUBY && platform =~ local_platform)
end
end
end
end
# On universal Rubies, resolve the "universal" arch to the real CPU arch, without changing the extension directory.
class BasicSpecification
if /^universal\.(?<arch>.*?)-/ =~ (CROSS_COMPILING || RUBY_PLATFORM)
local_platform = Platform.local
if local_platform.cpu == "universal"
ORIGINAL_LOCAL_PLATFORM = local_platform.to_s.freeze
local_platform.cpu = if arch == "arm64e" # arm64e is only permitted for Apple system binaries
"arm64"
else
arch
end
def extensions_dir
@extensions_dir ||=
Gem.default_ext_dir_for(base_dir) || File.join(base_dir, "extensions", ORIGINAL_LOCAL_PLATFORM, Gem.extension_api_version)
end
end
end
# Can be removed once RubyGems 3.5.22 support is dropped
unless new.respond_to?(:ignored?)
def ignored?
return @ignored unless @ignored.nil?
@ignored = missing_extensions?
end
end
end
require "rubygems/name_tuple"
class NameTuple
# Versions of RubyGems before about 3.5.0 don't to_s the platform.
unless Gem::NameTuple.new("a", Gem::Version.new("1"), Gem::Platform.new("x86_64-linux")).platform.is_a?(String)
alias_method :initialize_with_platform, :initialize
def initialize(name, version, platform=Gem::Platform::RUBY)
if Gem::Platform === platform
initialize_with_platform(name, version, platform.to_s)
else
initialize_with_platform(name, version, platform)
end
end
end
def lock_name
if platform == Gem::Platform::RUBY
"#{name} (#{version})"
else
"#{name} (#{version}-#{platform})"
end
end
end
unless Gem.rubygems_version >= Gem::Version.new("3.5.19")
class Resolver::ActivationRequest
remove_method :installed?
def installed?
case @spec
when Gem::Resolver::VendorSpecification then
true
else
this_spec = full_spec
Gem::Specification.any? do |s|
s == this_spec && s.base_dir == this_spec.base_dir
end
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/injector.rb 0000644 00000024041 15173517743 0016274 0 ustar 00 # frozen_string_literal: true
module Bundler
class Injector
INJECTED_GEMS = "injected gems"
def self.inject(new_deps, options = {})
injector = new(new_deps, options)
injector.inject(Bundler.default_gemfile, Bundler.default_lockfile)
end
def self.remove(gems, options = {})
injector = new(gems, options)
injector.remove(Bundler.default_gemfile, Bundler.default_lockfile)
end
def initialize(deps, options = {})
@deps = deps
@options = options
end
# @param [Pathname] gemfile_path The Gemfile in which to inject the new dependency.
# @param [Pathname] lockfile_path The lockfile in which to inject the new dependency.
# @return [Array]
def inject(gemfile_path, lockfile_path)
Bundler.definition.ensure_equivalent_gemfile_and_lockfile(true)
# temporarily unfreeze
Bundler.settings.temporary(deployment: false, frozen: false) do
# evaluate the Gemfile we have now
builder = Dsl.new
builder.eval_gemfile(gemfile_path)
# don't inject any gems that are already in the Gemfile
@deps -= builder.dependencies
# add new deps to the end of the in-memory Gemfile
# Set conservative versioning to false because
# we want to let the resolver resolve the version first
builder.eval_gemfile(INJECTED_GEMS, build_gem_lines(false)) if @deps.any?
# resolve to see if the new deps broke anything
@definition = builder.to_definition(lockfile_path, {})
@definition.resolve_remotely!
# since nothing broke, we can add those gems to the gemfile
append_to(gemfile_path, build_gem_lines(@options[:conservative_versioning])) if @deps.any?
# since we resolved successfully, write out the lockfile
@definition.lock
# invalidate the cached Bundler.definition
Bundler.reset_paths!
# return an array of the deps that we added
@deps
end
end
# @param [Pathname] gemfile_path The Gemfile from which to remove dependencies.
# @param [Pathname] lockfile_path The lockfile from which to remove dependencies.
# @return [Array]
def remove(gemfile_path, lockfile_path)
# remove gems from each gemfiles we have
Bundler.definition.gemfiles.each do |path|
deps = remove_deps(path)
show_warning("No gems were removed from the gemfile.") if deps.empty?
deps.each {|dep| Bundler.ui.confirm "#{SharedHelpers.pretty_dependency(dep)} was removed." }
end
# Invalidate the cached Bundler.definition.
# This prevents e.g. `bundle remove ...` from using outdated information.
Bundler.reset_paths!
end
private
def conservative_version(spec)
version = spec.version
return ">= 0" if version.nil?
segments = version.segments
seg_end_index = version >= Gem::Version.new("1.0") ? 1 : 2
prerelease_suffix = version.to_s.delete_prefix(version.release.to_s) if version.prerelease?
"#{version_prefix}#{segments[0..seg_end_index].join(".")}#{prerelease_suffix}"
end
def version_prefix
if @options[:strict]
"= "
elsif @options[:optimistic]
">= "
else
"~> "
end
end
def build_gem_lines(conservative_versioning)
@deps.map do |d|
name = d.name.dump
requirement = if conservative_versioning
", \"#{conservative_version(@definition.specs[d.name][0])}\""
else
", #{d.requirement.as_list.map(&:dump).join(", ")}"
end
if d.groups != Array(:default)
group = d.groups.size == 1 ? ", :group => #{d.groups.first.inspect}" : ", :groups => #{d.groups.inspect}"
end
source = ", :source => \"#{d.source}\"" unless d.source.nil?
path = ", :path => \"#{d.path}\"" unless d.path.nil?
git = ", :git => \"#{d.git}\"" unless d.git.nil?
github = ", :github => \"#{d.github}\"" unless d.github.nil?
branch = ", :branch => \"#{d.branch}\"" unless d.branch.nil?
ref = ", :ref => \"#{d.ref}\"" unless d.ref.nil?
glob = ", :glob => \"#{d.glob}\"" unless d.glob.nil?
require_path = ", :require => #{convert_autorequire(d.autorequire)}" unless d.autorequire.nil?
%(gem #{name}#{requirement}#{group}#{source}#{path}#{git}#{github}#{branch}#{ref}#{glob}#{require_path})
end.join("\n")
end
def append_to(gemfile_path, new_gem_lines)
gemfile_path.open("a") do |f|
f.puts
f.puts new_gem_lines
end
end
# evaluates a gemfile to remove the specified gem
# from it.
def remove_deps(gemfile_path)
initial_gemfile = File.readlines(gemfile_path)
Bundler.ui.info "Removing gems from #{gemfile_path}"
# evaluate the Gemfile we have
builder = Dsl.new
builder.eval_gemfile(gemfile_path)
removed_deps = remove_gems_from_dependencies(builder, @deps, gemfile_path)
# abort the operation if no gems were removed
# no need to operate on gemfile further
return [] if removed_deps.empty?
cleaned_gemfile = remove_gems_from_gemfile(@deps, gemfile_path)
SharedHelpers.write_to_gemfile(gemfile_path, cleaned_gemfile)
# check for errors
# including extra gems being removed
# or some gems not being removed
# and return the actual removed deps
cross_check_for_errors(gemfile_path, builder.dependencies, removed_deps, initial_gemfile)
end
# @param [Dsl] builder Dsl object of current Gemfile.
# @param [Array] gems Array of names of gems to be removed.
# @param [Pathname] gemfile_path Path of the Gemfile.
# @return [Array] Array of removed dependencies.
def remove_gems_from_dependencies(builder, gems, gemfile_path)
removed_deps = []
gems.each do |gem_name|
deleted_dep = builder.dependencies.find {|d| d.name == gem_name }
if deleted_dep.nil?
raise GemfileError, "`#{gem_name}` is not specified in #{gemfile_path} so it could not be removed."
end
builder.dependencies.delete(deleted_dep)
removed_deps << deleted_dep
end
removed_deps
end
# @param [Array] gems Array of names of gems to be removed.
# @param [Pathname] gemfile_path The Gemfile from which to remove dependencies.
def remove_gems_from_gemfile(gems, gemfile_path)
patterns = /gem\s+(['"])#{Regexp.union(gems)}\1|gem\s*\((['"])#{Regexp.union(gems)}\2\)/
new_gemfile = []
multiline_removal = false
File.readlines(gemfile_path).each do |line|
match_data = line.match(patterns)
if match_data && is_not_within_comment?(line, match_data)
multiline_removal = line.rstrip.end_with?(",")
# skip lines which match the regex
next
end
# skip followup lines until line does not end with ','
new_gemfile << line unless multiline_removal
multiline_removal = line.rstrip.end_with?(",") if multiline_removal
end
# remove line \n and append them with other strings
new_gemfile.each_with_index do |_line, index|
if new_gemfile[index + 1] == "\n"
new_gemfile[index] += new_gemfile[index + 1]
new_gemfile.delete_at(index + 1)
end
end
%w[group source env install_if].each {|block| remove_nested_blocks(new_gemfile, block) }
new_gemfile.join.chomp
end
# @param [String] line Individual line of gemfile content.
# @param [MatchData] match_data Data about Regex match.
def is_not_within_comment?(line, match_data)
match_start_index = match_data.offset(0).first
!line[0..match_start_index].include?("#")
end
# @param [Array] gemfile Array of gemfile contents.
# @param [String] block_name Name of block name to look for.
def remove_nested_blocks(gemfile, block_name)
nested_blocks = 0
# count number of nested blocks
gemfile.each_with_index {|line, index| nested_blocks += 1 if !gemfile[index + 1].nil? && gemfile[index + 1].include?(block_name) && line.include?(block_name) }
while nested_blocks >= 0
nested_blocks -= 1
gemfile.each_with_index do |line, index|
next unless !line.nil? && line.strip.start_with?(block_name)
if /^\s*end\s*$/.match?(gemfile[index + 1])
gemfile[index] = nil
gemfile[index + 1] = nil
end
end
gemfile.compact!
end
end
# @param [Pathname] gemfile_path The Gemfile from which to remove dependencies.
# @param [Array] original_deps Array of original dependencies.
# @param [Array] removed_deps Array of removed dependencies.
# @param [Array] initial_gemfile Contents of original Gemfile before any operation.
def cross_check_for_errors(gemfile_path, original_deps, removed_deps, initial_gemfile)
# evaluate the new gemfile to look for any failure cases
builder = Dsl.new
builder.eval_gemfile(gemfile_path)
# record gems which were removed but not requested
extra_removed_gems = original_deps - builder.dependencies
# if some extra gems were removed then raise error
# and revert Gemfile to original
unless extra_removed_gems.empty?
SharedHelpers.write_to_gemfile(gemfile_path, initial_gemfile.join)
raise InvalidOption, "Gems could not be removed. #{extra_removed_gems.join(", ")} would also have been removed. Bundler cannot continue."
end
# record gems which could not be removed due to some reasons
errored_deps = builder.dependencies.select {|d| d.gemfile == gemfile_path } & removed_deps.select {|d| d.gemfile == gemfile_path }
show_warning "#{errored_deps.map(&:name).join(", ")} could not be removed." unless errored_deps.empty?
# return actual removed dependencies
removed_deps - errored_deps
end
def show_warning(message)
Bundler.ui.info Bundler.ui.add_color(message, :yellow)
end
def convert_autorequire(autorequire)
autorequire = autorequire.first
return autorequire if autorequire == "false"
autorequire.inspect
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/dsl.rb 0000644 00000054411 15173517743 0015245 0 ustar 00 # frozen_string_literal: true
require_relative "dependency"
require_relative "ruby_dsl"
module Bundler
class Dsl
include RubyDsl
def self.evaluate(gemfile, lockfile, unlock)
builder = new
builder.eval_gemfile(gemfile)
builder.to_definition(lockfile, unlock)
end
VALID_PLATFORMS = Bundler::Dependency::PLATFORM_MAP.keys.freeze
VALID_KEYS = %w[group groups git path glob name branch ref tag require submodules
platform platforms type source install_if gemfile force_ruby_platform].freeze
GITHUB_PULL_REQUEST_URL = %r{\Ahttps://github\.com/([A-Za-z0-9_\-\.]+/[A-Za-z0-9_\-\.]+)/pull/(\d+)\z}
GITLAB_MERGE_REQUEST_URL = %r{\Ahttps://gitlab\.com/([A-Za-z0-9_\-\./]+)/-/merge_requests/(\d+)\z}
attr_reader :gemspecs, :gemfile
attr_accessor :dependencies
def initialize
@source = nil
@sources = SourceList.new
@git_sources = {}
@dependencies = []
@groups = []
@install_conditionals = []
@optional_groups = []
@platforms = []
@env = nil
@ruby_version = nil
@gemspecs = []
@gemfile = nil
@gemfiles = []
add_git_sources
end
def eval_gemfile(gemfile, contents = nil)
with_gemfile(gemfile) do |current_gemfile|
contents ||= Bundler.read_file(current_gemfile)
instance_eval(contents, current_gemfile, 1)
rescue GemfileEvalError => e
message = "There was an error evaluating `#{File.basename current_gemfile}`: #{e.message}"
raise DSLError.new(message, current_gemfile, e.backtrace, contents)
rescue GemfileError, InvalidArgumentError, InvalidOption, DeprecatedError, ScriptError => e
message = "There was an error parsing `#{File.basename current_gemfile}`: #{e.message}"
raise DSLError.new(message, current_gemfile, e.backtrace, contents)
rescue StandardError => e
raise unless e.backtrace_locations.first.path == current_gemfile
message = "There was an error parsing `#{File.basename current_gemfile}`: #{e.message}"
raise DSLError.new(message, current_gemfile, e.backtrace, contents)
end
end
def gemspec(opts = nil)
opts ||= {}
path = opts[:path] || "."
glob = opts[:glob]
name = opts[:name]
development_group = opts[:development_group] || :development
expanded_path = gemfile_root.join(path)
gemspecs = Gem::Util.glob_files_in_dir("{,*}.gemspec", expanded_path).map {|g| Bundler.load_gemspec(g) }.compact
gemspecs.reject! {|s| s.name != name } if name
specs_by_name_and_version = gemspecs.group_by {|s| [s.name, s.version] }
case specs_by_name_and_version.size
when 1
specs = specs_by_name_and_version.values.first
spec = specs.find {|s| s.match_platform(Bundler.local_platform) } || specs.first
@gemspecs << spec
gem spec.name, name: spec.name, path: path, glob: glob
group(development_group) do
spec.development_dependencies.each do |dep|
gem dep.name, *(dep.requirement.as_list + [type: :development])
end
end
when 0
raise InvalidOption, "There are no gemspecs at #{expanded_path}"
else
raise InvalidOption, "There are multiple gemspecs at #{expanded_path}. " \
"Please use the :name option to specify which one should be used"
end
end
def gem(name, *args)
options = args.last.is_a?(Hash) ? args.pop.dup : {}
options["gemfile"] = @gemfile
version = args || [">= 0"]
normalize_options(name, version, options)
dep = Dependency.new(name, version, options)
# if there's already a dependency with this name we try to prefer one
if current = @dependencies.find {|d| d.name == dep.name }
if current.requirement != dep.requirement
current_requirement_open = current.requirements_list.include?(">= 0")
gemspec_dep = [dep, current].find(&:gemspec_dev_dep?)
if gemspec_dep
gemfile_dep = [dep, current].find(&:runtime?)
unless current_requirement_open
Bundler.ui.warn "A gemspec development dependency (#{gemspec_dep.name}, #{gemspec_dep.requirement}) is being overridden by a Gemfile dependency (#{gemfile_dep.name}, #{gemfile_dep.requirement}).\n" \
"This behaviour may change in the future. Please remove either of them, or make sure they both have the same requirement\n"
end
else
update_prompt = ""
if File.basename(@gemfile) == Injector::INJECTED_GEMS
if dep.requirements_list.include?(">= 0") && !current_requirement_open
update_prompt = ". Gem already added"
else
update_prompt = ". If you want to update the gem version, run `bundle update #{current.name}`"
update_prompt += ". You may also need to change the version requirement specified in the Gemfile if it's too restrictive." unless current_requirement_open
end
end
raise GemfileError, "You cannot specify the same gem twice with different version requirements.\n" \
"You specified: #{current.name} (#{current.requirement}) and #{dep.name} (#{dep.requirement})" \
"#{update_prompt}"
end
end
# Always prefer the dependency from the Gemfile
if current.gemspec_dev_dep?
@dependencies.delete(current)
elsif dep.gemspec_dev_dep?
return
elsif current.source != dep.source
raise GemfileError, "You cannot specify the same gem twice coming from different sources.\n" \
"You specified that #{dep.name} (#{dep.requirement}) should come from " \
"#{current.source || "an unspecified source"} and #{dep.source}\n"
else
Bundler.ui.warn "Your Gemfile lists the gem #{current.name} (#{current.requirement}) more than once.\n" \
"You should probably keep only one of them.\n" \
"Remove any duplicate entries and specify the gem only once.\n" \
"While it's not a problem now, it could cause errors if you change the version of one of them later."
end
end
@dependencies << dep
end
def source(source, *args, &blk)
options = args.last.is_a?(Hash) ? args.pop.dup : {}
options = normalize_hash(options)
source = normalize_source(source)
if options.key?("type")
options["type"] = options["type"].to_s
unless Plugin.source?(options["type"])
raise InvalidOption, "No plugin sources available for #{options["type"]}"
end
unless block_given?
raise InvalidOption, "You need to pass a block to #source with :type option"
end
source_opts = options.merge("uri" => source)
with_source(@sources.add_plugin_source(options["type"], source_opts), &blk)
elsif block_given?
with_source(@sources.add_rubygems_source("remotes" => source), &blk)
else
@sources.add_global_rubygems_remote(source)
end
end
def git_source(name, &block)
unless block_given?
raise InvalidOption, "You need to pass a block to #git_source"
end
if valid_keys.include?(name.to_s)
raise InvalidOption, "You cannot use #{name} as a git source. It " \
"is a reserved key. Reserved keys are: #{valid_keys.join(", ")}"
end
@git_sources[name.to_s] = block
end
def path(path, options = {}, &blk)
source_options = normalize_hash(options).merge(
"path" => Pathname.new(path),
"root_path" => gemfile_root,
"gemspec" => gemspecs.find {|g| g.name == options["name"] }
)
source_options["global"] = true unless block_given?
source = @sources.add_path_source(source_options)
with_source(source, &blk)
end
def git(uri, options = {}, &blk)
unless block_given?
msg = "You can no longer specify a git source by itself. Instead, \n" \
"either use the :git option on a gem, or specify the gems that \n" \
"bundler should find in the git source by passing a block to \n" \
"the git method, like: \n\n" \
" git 'git://github.com/rails/rails.git' do\n" \
" gem 'rails'\n" \
" end"
raise DeprecatedError, msg
end
with_source(@sources.add_git_source(normalize_hash(options).merge("uri" => uri)), &blk)
end
def github(repo, options = {})
raise InvalidArgumentError, "GitHub sources require a block" unless block_given?
github_uri = @git_sources["github"].call(repo)
git_options = normalize_hash(options).merge("uri" => github_uri)
git_source = @sources.add_git_source(git_options)
with_source(git_source) { yield }
end
def to_definition(lockfile, unlock)
check_primary_source_safety
Definition.new(lockfile, @dependencies, @sources, unlock, @ruby_version, @optional_groups, @gemfiles)
end
def group(*args, &blk)
options = args.last.is_a?(Hash) ? args.pop.dup : {}
normalize_group_options(options, args)
@groups.concat args
if options["optional"]
optional_groups = args - @optional_groups
@optional_groups.concat optional_groups
end
yield
ensure
args.each { @groups.pop }
end
def install_if(*args)
@install_conditionals.concat args
yield
ensure
args.each { @install_conditionals.pop }
end
def platforms(*platforms)
@platforms.concat platforms
yield
ensure
platforms.each { @platforms.pop }
end
alias_method :platform, :platforms
def env(name)
old = @env
@env = name
yield
ensure
@env = old
end
def plugin(*args)
# Pass on
end
def method_missing(name, *args)
raise GemfileError, "Undefined local variable or method `#{name}' for Gemfile"
end
def check_primary_source_safety
check_path_source_safety
check_rubygems_source_safety
end
private
def with_gemfile(gemfile)
expanded_gemfile_path = Pathname.new(gemfile).expand_path(@gemfile&.parent)
original_gemfile = @gemfile
@gemfile = expanded_gemfile_path
@gemfiles << expanded_gemfile_path
yield @gemfile.to_s
ensure
@gemfile = original_gemfile
end
def add_git_sources
git_source(:github) do |repo_name|
if repo_name =~ GITHUB_PULL_REQUEST_URL
{
"git" => "https://github.com/#{$1}.git",
"branch" => nil,
"ref" => "refs/pull/#{$2}/head",
"tag" => nil,
}
else
repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
"https://github.com/#{repo_name}.git"
end
end
git_source(:gist) do |repo_name|
"https://gist.github.com/#{repo_name}.git"
end
git_source(:bitbucket) do |repo_name|
user_name, repo_name = repo_name.split("/")
repo_name ||= user_name
"https://#{user_name}@bitbucket.org/#{user_name}/#{repo_name}.git"
end
git_source(:gitlab) do |repo_name|
if repo_name =~ GITLAB_MERGE_REQUEST_URL
{
"git" => "https://gitlab.com/#{$1}.git",
"branch" => nil,
"ref" => "refs/merge-requests/#{$2}/head",
"tag" => nil,
}
else
repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
"https://gitlab.com/#{repo_name}.git"
end
end
end
def with_source(source)
old_source = @source
if block_given?
@source = source
yield
end
source
ensure
@source = old_source
end
def normalize_hash(opts)
opts.keys.each do |k|
opts[k.to_s] = opts.delete(k) unless k.is_a?(String)
end
opts
end
def valid_keys
@valid_keys ||= VALID_KEYS
end
def normalize_options(name, version, opts)
if name.is_a?(Symbol)
raise GemfileError, %(You need to specify gem names as Strings. Use 'gem "#{name}"' instead)
end
if /\s/.match?(name)
raise GemfileError, %('#{name}' is not a valid gem name because it contains whitespace)
end
raise GemfileError, %(an empty gem name is not valid) if name.empty?
normalize_hash(opts)
git_names = @git_sources.keys.map(&:to_s)
validate_keys("gem '#{name}'", opts, valid_keys + git_names)
groups = @groups.dup
opts["group"] = opts.delete("groups") || opts["group"]
groups.concat Array(opts.delete("group"))
groups = [:default] if groups.empty?
install_if = @install_conditionals.dup
install_if.concat Array(opts.delete("install_if"))
install_if = install_if.reduce(true) do |memo, val|
memo && (val.respond_to?(:call) ? val.call : val)
end
platforms = @platforms.dup
opts["platforms"] = opts["platform"] || opts["platforms"]
platforms.concat Array(opts.delete("platforms"))
platforms.map!(&:to_sym)
platforms.each do |p|
next if VALID_PLATFORMS.include?(p)
raise GemfileError, "`#{p}` is not a valid platform. The available options are: #{VALID_PLATFORMS.inspect}"
end
# Save sources passed in a key
if opts.key?("source")
source = normalize_source(opts["source"])
opts["source"] = @sources.add_rubygems_source("remotes" => source)
end
git_name = (git_names & opts.keys).last
if @git_sources[git_name]
git_opts = @git_sources[git_name].call(opts[git_name])
git_opts = { "git" => git_opts } if git_opts.is_a?(String)
opts.merge!(git_opts) do |key, _gemfile_value, _git_source_value|
raise GemfileError, %(The :#{key} option can't be used with `#{git_name}: #{opts[git_name].inspect}`)
end
end
%w[git path].each do |type|
next unless param = opts[type]
if version.first && version.first =~ /^\s*=?\s*(\d[^\s]*)\s*$/
options = opts.merge("name" => name, "version" => $1)
else
options = opts.dup
end
source = send(type, param, options) {}
opts["source"] = source
end
opts["source"] ||= @source
opts["env"] ||= @env
opts["platforms"] = platforms.dup
opts["group"] = groups
opts["should_include"] = install_if
end
def normalize_group_options(opts, groups)
normalize_hash(opts)
groups = groups.map {|group| ":#{group}" }.join(", ")
validate_keys("group #{groups}", opts, %w[optional])
opts["optional"] ||= false
end
def validate_keys(command, opts, valid_keys)
if opts["branch"] && !(opts["git"] || opts["github"] || (opts.keys & @git_sources.keys.map(&:to_s)).any?)
raise GemfileError, %(The `branch` option for `#{command}` is not allowed. Only gems with a git source can specify a branch)
end
invalid_keys = opts.keys - valid_keys
return true unless invalid_keys.any?
message = String.new
message << "You passed #{invalid_keys.map {|k| ":" + k }.join(", ")} "
message << if invalid_keys.size > 1
"as options for #{command}, but they are invalid."
else
"as an option for #{command}, but it is invalid."
end
message << " Valid options are: #{valid_keys.join(", ")}."
message << " You may be able to resolve this by upgrading Bundler to the newest version."
raise InvalidOption, message
end
def normalize_source(source)
case source
when :gemcutter, :rubygems, :rubyforge
message =
"The source :#{source} is deprecated because HTTP requests are insecure.\n" \
"Please change your source to 'https://rubygems.org' if possible, or 'http://rubygems.org' if not."
removed_message =
"The source :#{source} is disallowed because HTTP requests are insecure.\n" \
"Please change your source to 'https://rubygems.org' if possible, or 'http://rubygems.org' if not."
Bundler::SharedHelpers.major_deprecation 2, message, removed_message: removed_message
"http://rubygems.org"
when String
source
else
raise GemfileError, "Unknown source '#{source}'"
end
end
def check_path_source_safety
return if @sources.global_path_source.nil?
msg = "You can no longer specify a path source by itself. Instead, \n" \
"either use the :path option on a gem, or specify the gems that \n" \
"bundler should find in the path source by passing a block to \n" \
"the path method, like: \n\n" \
" path 'dir/containing/rails' do\n" \
" gem 'rails'\n" \
" end\n\n"
SharedHelpers.major_deprecation(2, msg.strip)
end
def check_rubygems_source_safety
if @sources.implicit_global_source?
implicit_global_source_warning
elsif @sources.aggregate_global_source?
multiple_global_source_warning
end
end
def implicit_global_source_warning
Bundler::SharedHelpers.major_deprecation 2, "This Gemfile does not include an explicit global source. " \
"Not using an explicit global source may result in a different lockfile being generated depending on " \
"the gems you have installed locally before bundler is run. " \
"Instead, define a global source in your Gemfile like this: source \"https://rubygems.org\"."
end
def multiple_global_source_warning
if Bundler.feature_flag.bundler_3_mode?
msg = "This Gemfile contains multiple global sources. " \
"Each source after the first must include a block to indicate which gems " \
"should come from that source"
raise GemfileEvalError, msg
else
message =
"Your Gemfile contains multiple global sources. " \
"Using `source` more than once without a block is a security risk, and " \
"may result in installing unexpected gems. To resolve this warning, use " \
"a block to indicate which gems should come from the secondary source."
removed_message =
"Your Gemfile contains multiple global sources. " \
"Using `source` more than once without a block is a security risk, and " \
"may result in installing unexpected gems. To resolve this error, use " \
"a block to indicate which gems should come from the secondary source."
Bundler::SharedHelpers.major_deprecation 2, message, removed_message: removed_message
end
end
class DSLError < GemfileError
# @return [String] the description that should be presented to the user.
#
attr_reader :description
# @return [String] the path of the dsl file that raised the exception.
#
attr_reader :dsl_path
# @return [Exception] the backtrace of the exception raised by the
# evaluation of the dsl file.
#
attr_reader :backtrace
# @param [Exception] backtrace @see backtrace
# @param [String] dsl_path @see dsl_path
#
def initialize(description, dsl_path, backtrace, contents = nil)
@status_code = $!.respond_to?(:status_code) && $!.status_code
@description = description
@dsl_path = dsl_path
@backtrace = backtrace
@contents = contents
end
def status_code
@status_code || super
end
# @return [String] the contents of the DSL that cause the exception to
# be raised.
#
def contents
@contents ||= dsl_path && File.exist?(dsl_path) && File.read(dsl_path)
end
# The message of the exception reports the content of podspec for the
# line that generated the original exception.
#
# @example Output
#
# Invalid podspec at `RestKit.podspec` - undefined method
# `exclude_header_search_paths=' for #<Pod::Specification for
# `RestKit/Network (0.9.3)`>
#
# from spec-repos/master/RestKit/0.9.3/RestKit.podspec:36
# -------------------------------------------
# # because it would break: #import <CoreData/CoreData.h>
# > ns.exclude_header_search_paths = 'Code/RestKit.h'
# end
# -------------------------------------------
#
# @return [String] the message of the exception.
#
def to_s
@to_s ||= begin
trace_line, description = parse_line_number_from_description
m = String.new("\n[!] ")
m << description
m << ". Bundler cannot continue.\n"
return m unless backtrace && dsl_path && contents
trace_line = backtrace.find {|l| l.include?(dsl_path) } || trace_line
return m unless trace_line
line_number = trace_line.split(":")[1].to_i - 1
return m unless line_number
lines = contents.lines.to_a
indent = " # "
indicator = indent.tr("#", ">")
first_line = line_number.zero?
last_line = (line_number == (lines.count - 1))
m << "\n"
m << "#{indent}from #{trace_line.gsub(/:in.*$/, "")}\n"
m << "#{indent}-------------------------------------------\n"
m << "#{indent}#{lines[line_number - 1]}" unless first_line
m << "#{indicator}#{lines[line_number]}"
m << "#{indent}#{lines[line_number + 1]}" unless last_line
m << "\n" unless m.end_with?("\n")
m << "#{indent}-------------------------------------------\n"
end
end
private
def parse_line_number_from_description
description = self.description
if dsl_path && description =~ /((#{Regexp.quote File.expand_path(dsl_path)}|#{Regexp.quote dsl_path}):\d+)/
trace_line = Regexp.last_match[1]
description = description.sub(/\n.*\n(\.\.\.)? *\^~+$/, "").sub(/#{Regexp.quote trace_line}:\s*/, "").sub("\n", " - ")
end
[trace_line, description]
end
end
def gemfile_root
@gemfile ||= Bundler.default_gemfile
@gemfile.dirname
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/fetcher.rb 0000644 00000026775 15173517743 0016117 0 ustar 00 # frozen_string_literal: true
require_relative "vendored_persistent"
require_relative "vendored_timeout"
require "cgi"
require_relative "vendored_securerandom"
require "zlib"
module Bundler
# Handles all the fetching with the rubygems server
class Fetcher
autoload :Base, File.expand_path("fetcher/base", __dir__)
autoload :CompactIndex, File.expand_path("fetcher/compact_index", __dir__)
autoload :Downloader, File.expand_path("fetcher/downloader", __dir__)
autoload :Dependency, File.expand_path("fetcher/dependency", __dir__)
autoload :Index, File.expand_path("fetcher/index", __dir__)
# This error is raised when it looks like the network is down
class NetworkDownError < HTTPError; end
# This error is raised if we should rate limit our requests to the API
class TooManyRequestsError < HTTPError; end
# This error is raised if the API returns a 413 (only printed in verbose)
class FallbackError < HTTPError; end
# This is the error raised if OpenSSL fails the cert verification
class CertificateFailureError < HTTPError
def initialize(remote_uri)
remote_uri = filter_uri(remote_uri)
super "Could not verify the SSL certificate for #{remote_uri}.\nThere" \
" is a chance you are experiencing a man-in-the-middle attack, but" \
" most likely your system doesn't have the CA certificates needed" \
" for verification. For information about OpenSSL certificates, see" \
" https://railsapps.github.io/openssl-certificate-verify-failed.html."
end
end
# This is the error raised when a source is HTTPS and OpenSSL didn't load
class SSLError < HTTPError
def initialize(msg = nil)
super msg || "Could not load OpenSSL.\n" \
"You must recompile Ruby with OpenSSL support."
end
end
# This error is raised if HTTP authentication is required, but not provided.
class AuthenticationRequiredError < HTTPError
def initialize(remote_uri)
remote_uri = filter_uri(remote_uri)
super "Authentication is required for #{remote_uri}.\n" \
"Please supply credentials for this source. You can do this by running:\n" \
"`bundle config set --global #{remote_uri} username:password`\n" \
"or by storing the credentials in the `#{Settings.key_for(remote_uri)}` environment variable"
end
end
# This error is raised if HTTP authentication is provided, but incorrect.
class BadAuthenticationError < HTTPError
def initialize(remote_uri)
remote_uri = filter_uri(remote_uri)
super "Bad username or password for #{remote_uri}.\n" \
"Please double-check your credentials and correct them."
end
end
# This error is raised if HTTP authentication is correct, but lacks
# necessary permissions.
class AuthenticationForbiddenError < HTTPError
def initialize(remote_uri)
remote_uri = filter_uri(remote_uri)
super "Access token could not be authenticated for #{remote_uri}.\n" \
"Make sure it's valid and has the necessary scopes configured."
end
end
# Exceptions classes that should bypass retry attempts. If your password didn't work the
# first time, it's not going to the third time.
NET_ERRORS = [:HTTPBadGateway, :HTTPBadRequest, :HTTPFailedDependency,
:HTTPForbidden, :HTTPInsufficientStorage, :HTTPMethodNotAllowed,
:HTTPMovedPermanently, :HTTPNoContent, :HTTPNotFound,
:HTTPNotImplemented, :HTTPPreconditionFailed, :HTTPRequestEntityTooLarge,
:HTTPRequestURITooLong, :HTTPUnauthorized, :HTTPUnprocessableEntity,
:HTTPUnsupportedMediaType, :HTTPVersionNotSupported].freeze
FAIL_ERRORS = begin
fail_errors = [AuthenticationRequiredError, BadAuthenticationError, AuthenticationForbiddenError, FallbackError, SecurityError]
fail_errors << Gem::Requirement::BadRequirementError
fail_errors.concat(NET_ERRORS.map {|e| Gem::Net.const_get(e) })
end.freeze
class << self
attr_accessor :disable_endpoint, :api_timeout, :redirect_limit, :max_retries
end
self.redirect_limit = Bundler.settings[:redirect] # How many redirects to allow in one request
self.api_timeout = Bundler.settings[:timeout] # How long to wait for each API call
self.max_retries = Bundler.settings[:retry] # How many retries for the API call
def initialize(remote)
@cis = nil
@remote = remote
Socket.do_not_reverse_lookup = true
connection # create persistent connection
end
def uri
@remote.anonymized_uri
end
# fetch a gem specification
def fetch_spec(spec)
spec -= [nil, "ruby", ""]
spec_file_name = "#{spec.join "-"}.gemspec"
uri = Gem::URI.parse("#{remote_uri}#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}.rz")
spec = if uri.scheme == "file"
path = Gem::Util.correct_for_windows_path(uri.path)
Bundler.safe_load_marshal Bundler.rubygems.inflate(Gem.read_binary(path))
elsif cached_spec_path = gemspec_cached_path(spec_file_name)
Bundler.load_gemspec(cached_spec_path)
else
Bundler.safe_load_marshal Bundler.rubygems.inflate(downloader.fetch(uri).body)
end
raise MarshalError, "is #{spec.inspect}" unless spec.is_a?(Gem::Specification)
spec
rescue MarshalError
raise HTTPError, "Gemspec #{spec} contained invalid data.\n" \
"Your network or your gem server is probably having issues right now."
end
# return the specs in the bundler format as an index with retries
def specs_with_retry(gem_names, source)
Bundler::Retry.new("fetcher", FAIL_ERRORS).attempts do
specs(gem_names, source)
end
end
# return the specs in the bundler format as an index
def specs(gem_names, source)
index = Bundler::Index.new
fetch_specs(gem_names).each do |name, version, platform, dependencies, metadata|
spec = if dependencies
EndpointSpecification.new(name, version, platform, self, dependencies, metadata).tap do |es|
source.checksum_store.replace(es, es.checksum)
end
else
RemoteSpecification.new(name, version, platform, self)
end
spec.source = source
spec.remote = @remote
index << spec
end
index
rescue CertificateFailureError
Bundler.ui.info "" if gem_names && api_fetcher? # newline after dots
raise
end
def user_agent
@user_agent ||= begin
ruby = Bundler::RubyVersion.system
agent = String.new("bundler/#{Bundler::VERSION}")
agent << " rubygems/#{Gem::VERSION}"
agent << " ruby/#{ruby.versions_string(ruby.versions)}"
agent << " (#{ruby.host})"
agent << " command/#{ARGV.first}"
if ruby.engine != "ruby"
# engine_version raises on unknown engines
engine_version = begin
ruby.engine_versions
rescue RuntimeError
"???"
end
agent << " #{ruby.engine}/#{ruby.versions_string(engine_version)}"
end
agent << " options/#{Bundler.settings.all.join(",")}"
agent << " ci/#{cis.join(",")}" if cis.any?
# add a random ID so we can consolidate runs server-side
agent << " " << Gem::SecureRandom.hex(8)
# add any user agent strings set in the config
extra_ua = Bundler.settings[:user_agent]
agent << " " << extra_ua if extra_ua
agent
end
end
def http_proxy
return unless uri = connection.proxy_uri
uri.to_s
end
def inspect
"#<#{self.class}:0x#{object_id} uri=#{uri}>"
end
def api_fetcher?
fetchers.first.api_fetcher?
end
def gem_remote_fetcher
@gem_remote_fetcher ||= begin
require_relative "fetcher/gem_remote_fetcher"
fetcher = GemRemoteFetcher.new Gem.configuration[:http_proxy]
fetcher.headers["User-Agent"] = user_agent
fetcher.headers["X-Gemfile-Source"] = @remote.original_uri.to_s if @remote.original_uri
fetcher
end
end
private
def available_fetchers
if Bundler::Fetcher.disable_endpoint
[Index]
elsif remote_uri.scheme == "file"
Bundler.ui.debug("Using a local server, bundler won't use the CompactIndex API")
[Index]
else
[CompactIndex, Dependency, Index]
end
end
def fetchers
@fetchers ||= available_fetchers.map {|f| f.new(downloader, @remote, uri, gem_remote_fetcher) }.drop_while {|f| !f.available? }
end
def fetch_specs(gem_names)
fetchers.reject!(&:api_fetcher?) unless gem_names
fetchers.reject! do |f|
specs = f.specs(gem_names)
return specs if specs
true
end
[]
end
def cis
@cis ||= Bundler::CIDetector.ci_strings
end
def connection
@connection ||= begin
needs_ssl = remote_uri.scheme == "https" ||
Bundler.settings[:ssl_verify_mode] ||
Bundler.settings[:ssl_client_cert]
raise SSLError if needs_ssl && !defined?(OpenSSL::SSL)
con = Gem::Net::HTTP::Persistent.new name: "bundler", proxy: :ENV
if gem_proxy = Gem.configuration[:http_proxy]
con.proxy = Gem::URI.parse(gem_proxy) if gem_proxy != :no_proxy
end
if remote_uri.scheme == "https"
con.verify_mode = (Bundler.settings[:ssl_verify_mode] ||
OpenSSL::SSL::VERIFY_PEER)
con.cert_store = bundler_cert_store
end
ssl_client_cert = Bundler.settings[:ssl_client_cert] ||
(Gem.configuration.ssl_client_cert if
Gem.configuration.respond_to?(:ssl_client_cert))
if ssl_client_cert
pem = File.read(ssl_client_cert)
con.cert = OpenSSL::X509::Certificate.new(pem)
con.key = OpenSSL::PKey::RSA.new(pem)
end
con.read_timeout = Fetcher.api_timeout
con.open_timeout = Fetcher.api_timeout
con.override_headers["User-Agent"] = user_agent
con.override_headers["X-Gemfile-Source"] = @remote.original_uri.to_s if @remote.original_uri
con
end
end
# cached gem specification path, if one exists
def gemspec_cached_path(spec_file_name)
paths = Bundler.rubygems.spec_cache_dirs.map {|dir| File.join(dir, spec_file_name) }
paths.find {|path| File.file? path }
end
HTTP_ERRORS = [
Gem::Timeout::Error, EOFError, SocketError, Errno::ENETDOWN, Errno::ENETUNREACH,
Errno::EINVAL, Errno::ECONNRESET, Errno::ETIMEDOUT, Errno::EAGAIN,
Gem::Net::HTTPBadResponse, Gem::Net::HTTPHeaderSyntaxError, Gem::Net::ProtocolError,
Gem::Net::HTTP::Persistent::Error, Zlib::BufError, Errno::EHOSTUNREACH
].freeze
def bundler_cert_store
store = OpenSSL::X509::Store.new
ssl_ca_cert = Bundler.settings[:ssl_ca_cert] ||
(Gem.configuration.ssl_ca_cert if
Gem.configuration.respond_to?(:ssl_ca_cert))
if ssl_ca_cert
if File.directory? ssl_ca_cert
store.add_path ssl_ca_cert
else
store.add_file ssl_ca_cert
end
else
store.set_default_paths
require "rubygems/request"
Gem::Request.get_cert_files.each {|c| store.add_file c }
end
store
end
def remote_uri
@remote.uri
end
def downloader
@downloader ||= Downloader.new(connection, self.class.redirect_limit)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/ui.rb 0000644 00000000377 15173517743 0015102 0 ustar 00 # frozen_string_literal: true
module Bundler
module UI
autoload :RGProxy, File.expand_path("ui/rg_proxy", __dir__)
autoload :Shell, File.expand_path("ui/shell", __dir__)
autoload :Silent, File.expand_path("ui/silent", __dir__)
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/definition.rb 0000644 00000111612 15173517743 0016610 0 ustar 00 # frozen_string_literal: true
require_relative "lockfile_parser"
module Bundler
class Definition
include GemHelpers
class << self
# Do not create or modify a lockfile (Makes #lock a noop)
attr_accessor :no_lock
end
attr_reader(
:dependencies,
:locked_deps,
:locked_gems,
:platforms,
:ruby_version,
:lockfile,
:gemfiles,
:locked_checksums
)
# Given a gemfile and lockfile creates a Bundler definition
#
# @param gemfile [Pathname] Path to Gemfile
# @param lockfile [Pathname,nil] Path to Gemfile.lock
# @param unlock [Hash, Boolean, nil] Gems that have been requested
# to be updated or true if all gems should be updated
# @return [Bundler::Definition]
def self.build(gemfile, lockfile, unlock)
unlock ||= {}
gemfile = Pathname.new(gemfile).expand_path
raise GemfileNotFound, "#{gemfile} not found" unless gemfile.file?
Dsl.evaluate(gemfile, lockfile, unlock)
end
#
# How does the new system work?
#
# * Load information from Gemfile and Lockfile
# * Invalidate stale locked specs
# * All specs from stale source are stale
# * All specs that are reachable only through a stale
# dependency are stale.
# * If all fresh dependencies are satisfied by the locked
# specs, then we can try to resolve locally.
#
# @param lockfile [Pathname] Path to Gemfile.lock
# @param dependencies [Array(Bundler::Dependency)] array of dependencies from Gemfile
# @param sources [Bundler::SourceList]
# @param unlock [Hash, Boolean, nil] Gems that have been requested
# to be updated or true if all gems should be updated
# @param ruby_version [Bundler::RubyVersion, nil] Requested Ruby Version
# @param optional_groups [Array(String)] A list of optional groups
def initialize(lockfile, dependencies, sources, unlock, ruby_version = nil, optional_groups = [], gemfiles = [])
if [true, false].include?(unlock)
@unlocking_bundler = false
@unlocking = unlock
else
@unlocking_bundler = unlock.delete(:bundler)
@unlocking = unlock.any? {|_k, v| !Array(v).empty? }
end
@dependencies = dependencies
@sources = sources
@unlock = unlock
@optional_groups = optional_groups
@prefer_local = false
@specs = nil
@ruby_version = ruby_version
@gemfiles = gemfiles
@lockfile = lockfile
@lockfile_contents = String.new
@locked_bundler_version = nil
@resolved_bundler_version = nil
@locked_ruby_version = nil
@new_platforms = []
@removed_platform = nil
if lockfile_exists?
@lockfile_contents = Bundler.read_file(lockfile)
@locked_gems = LockfileParser.new(@lockfile_contents)
@locked_platforms = @locked_gems.platforms
@platforms = @locked_platforms.dup
@locked_bundler_version = @locked_gems.bundler_version
@locked_ruby_version = @locked_gems.ruby_version
@originally_locked_deps = @locked_gems.dependencies
@originally_locked_specs = SpecSet.new(@locked_gems.specs)
@locked_checksums = @locked_gems.checksums
if unlock != true
@locked_deps = @originally_locked_deps
@locked_specs = @originally_locked_specs
@locked_sources = @locked_gems.sources
else
@unlock = {}
@locked_deps = {}
@locked_specs = SpecSet.new([])
@locked_sources = []
end
else
@unlock = {}
@platforms = []
@locked_gems = nil
@locked_deps = {}
@locked_specs = SpecSet.new([])
@originally_locked_deps = {}
@originally_locked_specs = @locked_specs
@locked_sources = []
@locked_platforms = []
@locked_checksums = Bundler.feature_flag.bundler_3_mode?
end
locked_gem_sources = @locked_sources.select {|s| s.is_a?(Source::Rubygems) }
@multisource_allowed = locked_gem_sources.size == 1 && locked_gem_sources.first.multiple_remotes? && Bundler.frozen_bundle?
if @multisource_allowed
unless sources.aggregate_global_source?
msg = "Your lockfile contains a single rubygems source section with multiple remotes, which is insecure. Make sure you run `bundle install` in non frozen mode and commit the result to make your lockfile secure."
Bundler::SharedHelpers.major_deprecation 2, msg
end
@sources.merged_gem_lockfile_sections!(locked_gem_sources.first)
end
@sources_to_unlock = @unlock.delete(:sources) || []
@unlock[:ruby] ||= if @ruby_version && locked_ruby_version_object
@ruby_version.diff(locked_ruby_version_object)
end
@unlocking ||= @unlock[:ruby] ||= (!@locked_ruby_version ^ !@ruby_version)
@current_platform_missing = add_current_platform unless Bundler.frozen_bundle?
converge_path_sources_to_gemspec_sources
@path_changes = converge_paths
@source_changes = converge_sources
@explicit_unlocks = @unlock.delete(:gems) || []
if @unlock[:conservative]
@gems_to_unlock = @explicit_unlocks.any? ? @explicit_unlocks : @dependencies.map(&:name)
else
eager_unlock = @explicit_unlocks.map {|name| Dependency.new(name, ">= 0") }
@gems_to_unlock = @locked_specs.for(eager_unlock, false, platforms).map(&:name).uniq
end
@dependency_changes = converge_dependencies
@local_changes = converge_locals
check_lockfile
end
def gem_version_promoter
@gem_version_promoter ||= GemVersionPromoter.new
end
def resolve_only_locally!
sources.local_only!
resolve
end
def resolve_with_cache!
sources.local!
sources.cached!
resolve
end
def resolve_remotely!
sources.cached!
sources.remote!
resolve
end
def prefer_local!
@prefer_local = true
end
# For given dependency list returns a SpecSet with Gemspec of all the required
# dependencies.
# 1. The method first resolves the dependencies specified in Gemfile
# 2. After that it tries and fetches gemspec of resolved dependencies
#
# @return [Bundler::SpecSet]
def specs
@specs ||= materialize(requested_dependencies)
end
def new_specs
specs - @locked_specs
end
def removed_specs
@locked_specs - specs
end
def missing_specs
resolve.materialize(requested_dependencies).missing_specs
end
def missing_specs?
missing = missing_specs
return false if missing.empty?
Bundler.ui.debug "The definition is missing #{missing.map(&:full_name)}"
true
rescue BundlerError => e
@resolve = nil
@resolver = nil
@resolution_packages = nil
@source_requirements = nil
@specs = nil
Bundler.ui.debug "The definition is missing dependencies, failed to resolve & materialize locally (#{e})"
true
end
def requested_specs
specs_for(requested_groups)
end
def requested_dependencies
dependencies_for(requested_groups)
end
def current_dependencies
filter_relevant(dependencies)
end
def current_locked_dependencies
filter_relevant(locked_dependencies)
end
def filter_relevant(dependencies)
platforms_array = [generic_local_platform].freeze
dependencies.select do |d|
d.should_include? && !d.gem_platforms(platforms_array).empty?
end
end
def locked_dependencies
@locked_deps.values
end
def new_deps
@new_deps ||= @dependencies - locked_dependencies
end
def deleted_deps
@deleted_deps ||= locked_dependencies - @dependencies
end
def specs_for(groups)
return specs if groups.empty?
deps = dependencies_for(groups)
materialize(deps)
end
def dependencies_for(groups)
groups.map!(&:to_sym)
deps = current_dependencies # always returns a new array
deps.select! do |d|
if RUBY_VERSION >= "3.1"
d.groups.intersect?(groups)
else
!(d.groups & groups).empty?
end
end
deps
end
# Resolve all the dependencies specified in Gemfile. It ensures that
# dependencies that have been already resolved via locked file and are fresh
# are reused when resolving dependencies
#
# @return [SpecSet] resolved dependencies
def resolve
@resolve ||= if Bundler.frozen_bundle?
Bundler.ui.debug "Frozen, using resolution from the lockfile"
@locked_specs
elsif no_resolve_needed?
if deleted_deps.any?
Bundler.ui.debug "Some dependencies were deleted, using a subset of the resolution from the lockfile"
SpecSet.new(filter_specs(@locked_specs, @dependencies - deleted_deps))
else
Bundler.ui.debug "Found no changes, using resolution from the lockfile"
if @removed_platform || @locked_gems.may_include_redundant_platform_specific_gems?
SpecSet.new(filter_specs(@locked_specs, @dependencies))
else
@locked_specs
end
end
else
if lockfile_exists?
Bundler.ui.debug "Found changes from the lockfile, re-resolving dependencies because #{change_reason}"
else
Bundler.ui.debug "Resolving dependencies because there's no lockfile"
end
start_resolution
end
end
def spec_git_paths
sources.git_sources.map {|s| File.realpath(s.path) if File.exist?(s.path) }.compact
end
def groups
dependencies.map(&:groups).flatten.uniq
end
def lock(file_or_preserve_unknown_sections = false, preserve_unknown_sections_or_unused = false)
if [true, false, nil].include?(file_or_preserve_unknown_sections)
target_lockfile = lockfile
preserve_unknown_sections = file_or_preserve_unknown_sections
else
target_lockfile = file_or_preserve_unknown_sections
preserve_unknown_sections = preserve_unknown_sections_or_unused
suggestion = if target_lockfile == lockfile
"To fix this warning, remove it from the `Definition#lock` call."
else
"Instead, instantiate a new definition passing `#{target_lockfile}`, and call `lock` without a file argument on that definition"
end
msg = "`Definition#lock` was passed a target file argument. #{suggestion}"
Bundler::SharedHelpers.major_deprecation 2, msg
end
write_lock(target_lockfile, preserve_unknown_sections)
end
def locked_ruby_version
return unless ruby_version
if @unlock[:ruby] || !@locked_ruby_version
Bundler::RubyVersion.system
else
@locked_ruby_version
end
end
def locked_ruby_version_object
return unless @locked_ruby_version
@locked_ruby_version_object ||= begin
unless version = RubyVersion.from_string(@locked_ruby_version)
raise LockfileError, "The Ruby version #{@locked_ruby_version} from " \
"#{@lockfile} could not be parsed. " \
"Try running bundle update --ruby to resolve this."
end
version
end
end
def bundler_version_to_lock
@resolved_bundler_version || Bundler.gem_version
end
def to_lock
require_relative "lockfile_generator"
LockfileGenerator.generate(self)
end
def ensure_equivalent_gemfile_and_lockfile(explicit_flag = false)
return unless Bundler.frozen_bundle?
raise ProductionError, "Frozen mode is set, but there's no lockfile" unless lockfile_exists?
added = []
deleted = []
changed = []
new_platforms = @platforms - @locked_platforms
deleted_platforms = @locked_platforms - @platforms
added.concat new_platforms.map {|p| "* platform: #{p}" }
deleted.concat deleted_platforms.map {|p| "* platform: #{p}" }
added.concat new_deps.map {|d| "* #{pretty_dep(d)}" } if new_deps.any?
deleted.concat deleted_deps.map {|d| "* #{pretty_dep(d)}" } if deleted_deps.any?
both_sources = Hash.new {|h, k| h[k] = [] }
current_dependencies.each {|d| both_sources[d.name][0] = d }
current_locked_dependencies.each {|d| both_sources[d.name][1] = d }
both_sources.each do |name, (dep, lock_dep)|
next if dep.nil? || lock_dep.nil?
gemfile_source = dep.source || default_source
lock_source = lock_dep.source || default_source
next if lock_source.include?(gemfile_source)
gemfile_source_name = dep.source ? gemfile_source.to_gemfile : "no specified source"
lockfile_source_name = lock_dep.source ? lock_source.to_gemfile : "no specified source"
changed << "* #{name} from `#{lockfile_source_name}` to `#{gemfile_source_name}`"
end
reason = nothing_changed? ? "some dependencies were deleted from your gemfile" : change_reason
msg = String.new
msg << "#{reason.capitalize.strip}, but the lockfile can't be updated because frozen mode is set"
msg << "\n\nYou have added to the Gemfile:\n" << added.join("\n") if added.any?
msg << "\n\nYou have deleted from the Gemfile:\n" << deleted.join("\n") if deleted.any?
msg << "\n\nYou have changed in the Gemfile:\n" << changed.join("\n") if changed.any?
msg << "\n\nRun `bundle install` elsewhere and add the updated #{SharedHelpers.relative_gemfile_path} to version control.\n"
unless explicit_flag
suggested_command = unless Bundler.settings.locations("frozen").keys.include?(:env)
"bundle config set frozen false"
end
msg << "If this is a development machine, remove the #{SharedHelpers.relative_lockfile_path} " \
"freeze by running `#{suggested_command}`." if suggested_command
end
raise ProductionError, msg if added.any? || deleted.any? || changed.any? || !nothing_changed?
end
def validate_runtime!
validate_ruby!
validate_platforms!
end
def validate_ruby!
return unless ruby_version
if diff = ruby_version.diff(Bundler::RubyVersion.system)
problem, expected, actual = diff
msg = case problem
when :engine
"Your Ruby engine is #{actual}, but your Gemfile specified #{expected}"
when :version
"Your Ruby version is #{actual}, but your Gemfile specified #{expected}"
when :engine_version
"Your #{Bundler::RubyVersion.system.engine} version is #{actual}, but your Gemfile specified #{ruby_version.engine} #{expected}"
when :patchlevel
if !expected.is_a?(String)
"The Ruby patchlevel in your Gemfile must be a string"
else
"Your Ruby patchlevel is #{actual}, but your Gemfile specified #{expected}"
end
end
raise RubyVersionMismatch, msg
end
end
def validate_platforms!
return if current_platform_locked?
raise ProductionError, "Your bundle only supports platforms #{@platforms.map(&:to_s)} " \
"but your local platform is #{local_platform}. " \
"Add the current platform to the lockfile with\n`bundle lock --add-platform #{local_platform}` and try again."
end
def add_platform(platform)
return if @platforms.include?(platform)
@new_platforms << platform
@platforms << platform
end
def remove_platform(platform)
removed_platform = @platforms.delete(Gem::Platform.new(platform))
@removed_platform ||= removed_platform
return if removed_platform
raise InvalidOption, "Unable to remove the platform `#{platform}` since the only platforms are #{@platforms.join ", "}"
end
def most_specific_locked_platform
@platforms.min_by do |bundle_platform|
platform_specificity_match(bundle_platform, local_platform)
end
end
def nothing_changed?
return false unless lockfile_exists?
!@source_changes &&
!@dependency_changes &&
!@current_platform_missing &&
@new_platforms.empty? &&
!@path_changes &&
!@local_changes &&
!@missing_lockfile_dep &&
!@unlocking_bundler &&
!@locked_spec_with_missing_deps &&
!@locked_spec_with_invalid_deps
end
def no_resolve_needed?
!unlocking? && nothing_changed?
end
def unlocking?
@unlocking
end
attr_writer :source_requirements
private
attr_reader :sources
def should_add_extra_platforms?
!lockfile_exists? && generic_local_platform_is_ruby? && !Bundler.settings[:force_ruby_platform]
end
def lockfile_exists?
lockfile && File.exist?(lockfile)
end
def write_lock(file, preserve_unknown_sections)
return if Definition.no_lock || file.nil?
contents = to_lock
# Convert to \r\n if the existing lock has them
# i.e., Windows with `git config core.autocrlf=true`
contents.gsub!(/\n/, "\r\n") if @lockfile_contents.match?("\r\n")
if @locked_bundler_version
locked_major = @locked_bundler_version.segments.first
current_major = bundler_version_to_lock.segments.first
updating_major = locked_major < current_major
end
preserve_unknown_sections ||= !updating_major && (Bundler.frozen_bundle? || !(unlocking? || @unlocking_bundler))
if File.exist?(file) && lockfiles_equal?(@lockfile_contents, contents, preserve_unknown_sections)
return if Bundler.frozen_bundle?
SharedHelpers.filesystem_access(file) { FileUtils.touch(file) }
return
end
if Bundler.frozen_bundle?
Bundler.ui.error "Cannot write a changed lockfile while frozen."
return
end
SharedHelpers.filesystem_access(file) do |p|
File.open(p, "wb") {|f| f.puts(contents) }
end
end
def resolver
@resolver ||= Resolver.new(resolution_packages, gem_version_promoter)
end
def expanded_dependencies
dependencies_with_bundler + metadata_dependencies
end
def dependencies_with_bundler
return dependencies unless @unlocking_bundler
return dependencies if dependencies.map(&:name).include?("bundler")
[Dependency.new("bundler", @unlocking_bundler)] + dependencies
end
def resolution_packages
@resolution_packages ||= begin
last_resolve = converge_locked_specs
remove_invalid_platforms!
packages = Resolver::Base.new(source_requirements, expanded_dependencies, last_resolve, @platforms, locked_specs: @originally_locked_specs, unlock: @gems_to_unlock, prerelease: gem_version_promoter.pre?, prefer_local: @prefer_local)
packages = additional_base_requirements_to_prevent_downgrades(packages, last_resolve)
packages = additional_base_requirements_to_force_updates(packages)
packages
end
end
def filter_specs(specs, deps)
SpecSet.new(specs).for(deps, false, platforms)
end
def materialize(dependencies)
specs = resolve.materialize(dependencies)
missing_specs = specs.missing_specs
if missing_specs.any?
missing_specs.each do |s|
locked_gem = @locked_specs[s.name].last
next if locked_gem.nil? || locked_gem.version != s.version || sources.local_mode?
raise GemNotFound, "Your bundle is locked to #{locked_gem} from #{locked_gem.source}, but that version can " \
"no longer be found in that source. That means the author of #{locked_gem} has removed it. " \
"You'll need to update your bundle to a version other than #{locked_gem} that hasn't been " \
"removed in order to install."
end
missing_specs_list = missing_specs.group_by(&:source).map do |source, missing_specs_for_source|
"#{missing_specs_for_source.map(&:full_name).join(", ")} in #{source}"
end
raise GemNotFound, "Could not find #{missing_specs_list.join(" nor ")}"
end
incomplete_specs = specs.incomplete_specs
loop do
break if incomplete_specs.empty?
Bundler.ui.debug("The lockfile does not have all gems needed for the current platform though, Bundler will still re-resolve dependencies")
sources.remote!
resolution_packages.delete(incomplete_specs)
@resolve = start_resolution
specs = resolve.materialize(dependencies)
still_incomplete_specs = specs.incomplete_specs
if still_incomplete_specs == incomplete_specs
package = resolution_packages.get_package(incomplete_specs.first.name)
resolver.raise_not_found! package
end
incomplete_specs = still_incomplete_specs
end
bundler = sources.metadata_source.specs.search(["bundler", Bundler.gem_version]).last
specs["bundler"] = bundler
specs
end
def start_resolution
local_platform_needed_for_resolvability = @most_specific_non_local_locked_ruby_platform && !@platforms.include?(local_platform)
@platforms << local_platform if local_platform_needed_for_resolvability
add_platform(Gem::Platform::RUBY) if RUBY_ENGINE == "truffleruby"
result = SpecSet.new(resolver.start)
@resolved_bundler_version = result.find {|spec| spec.name == "bundler" }&.version
if @most_specific_non_local_locked_ruby_platform
if spec_set_incomplete_for_platform?(result, @most_specific_non_local_locked_ruby_platform)
@platforms.delete(@most_specific_non_local_locked_ruby_platform)
elsif local_platform_needed_for_resolvability
@platforms.delete(local_platform)
end
end
@platforms = result.add_extra_platforms!(platforms) if should_add_extra_platforms?
SpecSet.new(result.for(dependencies, false, @platforms))
end
def precompute_source_requirements_for_indirect_dependencies?
sources.non_global_rubygems_sources.all?(&:dependency_api_available?) && !sources.aggregate_global_source?
end
def current_platform_locked?
@platforms.any? do |bundle_platform|
MatchPlatform.platforms_match?(bundle_platform, local_platform)
end
end
def add_current_platform
return if @platforms.include?(local_platform)
@most_specific_non_local_locked_ruby_platform = find_most_specific_locked_ruby_platform
return if @most_specific_non_local_locked_ruby_platform
@platforms << local_platform
true
end
def find_most_specific_locked_ruby_platform
return unless generic_local_platform_is_ruby? && current_platform_locked?
most_specific_locked_platform
end
def change_reason
if unlocking?
unlock_targets = if @gems_to_unlock.any?
["gems", @gems_to_unlock]
elsif @sources_to_unlock.any?
["sources", @sources_to_unlock]
end
unlock_reason = if unlock_targets
"#{unlock_targets.first}: (#{unlock_targets.last.join(", ")})"
else
@unlock[:ruby] ? "ruby" : ""
end
return "bundler is unlocking #{unlock_reason}"
end
[
[@source_changes, "the list of sources changed"],
[@dependency_changes, "the dependencies in your gemfile changed"],
[@current_platform_missing, "your lockfile does not include the current platform"],
[@new_platforms.any?, "you added a new platform to your gemfile"],
[@path_changes, "the gemspecs for path gems changed"],
[@local_changes, "the gemspecs for git local gems changed"],
[@missing_lockfile_dep, "your lock file is missing \"#{@missing_lockfile_dep}\""],
[@unlocking_bundler, "an update to the version of Bundler itself was requested"],
[@locked_spec_with_missing_deps, "your lock file includes \"#{@locked_spec_with_missing_deps}\" but not some of its dependencies"],
[@locked_spec_with_invalid_deps, "your lockfile does not satisfy dependencies of \"#{@locked_spec_with_invalid_deps}\""],
].select(&:first).map(&:last).join(", ")
end
def pretty_dep(dep)
SharedHelpers.pretty_dependency(dep)
end
# Check if the specs of the given source changed
# according to the locked source.
def specs_changed?(source)
locked = @locked_sources.find {|s| s == source }
!locked || dependencies_for_source_changed?(source, locked) || specs_for_source_changed?(source)
end
def dependencies_for_source_changed?(source, locked_source = source)
deps_for_source = @dependencies.select {|s| s.source == source }
locked_deps_for_source = locked_dependencies.select {|dep| dep.source == locked_source }
deps_for_source.uniq.sort != locked_deps_for_source.sort
end
def specs_for_source_changed?(source)
locked_index = Index.new
locked_index.use(@locked_specs.select {|s| source.can_lock?(s) })
!locked_index.subset?(source.specs)
rescue PathError, GitError => e
Bundler.ui.debug "Assuming that #{source} has not changed since fetching its specs errored (#{e})"
false
end
# Get all locals and override their matching sources.
# Return true if any of the locals changed (for example,
# they point to a new revision) or depend on new specs.
def converge_locals
locals = []
Bundler.settings.local_overrides.map do |k, v|
spec = @dependencies.find {|s| s.name == k }
source = spec&.source
if source&.respond_to?(:local_override!)
source.unlock! if @gems_to_unlock.include?(spec.name)
locals << [source, source.local_override!(v)]
end
end
sources_with_changes = locals.select do |source, changed|
changed || specs_changed?(source)
end.map(&:first)
!sources_with_changes.each {|source| @sources_to_unlock << source.name }.empty?
end
def check_lockfile
@missing_lockfile_dep = nil
@locked_spec_with_invalid_deps = nil
@locked_spec_with_missing_deps = nil
missing = []
invalid = []
@locked_specs.each do |s|
validation = @locked_specs.validate_deps(s)
missing << s if validation == :missing
invalid << s if validation == :invalid
end
if missing.any?
@locked_specs.delete(missing)
@locked_spec_with_missing_deps = missing.first.name
elsif !@dependency_changes
@missing_lockfile_dep = current_dependencies.find do |d|
@locked_specs[d.name].empty? && d.name != "bundler"
end&.name
end
if invalid.any?
@locked_specs.delete(invalid)
@locked_spec_with_invalid_deps = invalid.first.name
end
end
def converge_paths
sources.path_sources.any? do |source|
specs_changed?(source)
end
end
def converge_path_source_to_gemspec_source(source)
return source unless source.instance_of?(Source::Path)
gemspec_source = sources.path_sources.find {|s| s.is_a?(Source::Gemspec) && s.as_path_source == source }
gemspec_source || source
end
def converge_path_sources_to_gemspec_sources
@locked_sources.map! do |source|
converge_path_source_to_gemspec_source(source)
end
@locked_specs.each do |spec|
spec.source &&= converge_path_source_to_gemspec_source(spec.source)
end
@locked_deps.each do |_, dep|
dep.source &&= converge_path_source_to_gemspec_source(dep.source)
end
end
def converge_sources
# Replace the sources from the Gemfile with the sources from the Gemfile.lock,
# if they exist in the Gemfile.lock and are `==`. If you can't find an equivalent
# source in the Gemfile.lock, use the one from the Gemfile.
changes = sources.replace_sources!(@locked_sources)
sources.all_sources.each do |source|
# has to be done separately, because we want to keep the locked checksum
# store for a source, even when doing a full update
if @locked_checksums && @locked_gems && locked_source = @locked_gems.sources.find {|s| s == source && !s.equal?(source) }
source.checksum_store.merge!(locked_source.checksum_store)
end
# If the source is unlockable and the current command allows an unlock of
# the source (for example, you are doing a `bundle update <foo>` of a git-pinned
# gem), unlock it. For git sources, this means to unlock the revision, which
# will cause the `ref` used to be the most recent for the branch (or master) if
# an explicit `ref` is not used.
if source.respond_to?(:unlock!) && @sources_to_unlock.include?(source.name)
source.unlock!
changes = true
end
end
changes
end
def converge_dependencies
changes = false
@dependencies.each do |dep|
if dep.source
dep.source = sources.get(dep.source)
end
unless locked_dep = @originally_locked_deps[dep.name]
changes = true
next
end
# Gem::Dependency#== matches Gem::Dependency#type. As the lockfile
# doesn't carry a notion of the dependency type, if you use
# add_development_dependency in a gemspec that's loaded with the gemspec
# directive, the lockfile dependencies and resolved dependencies end up
# with a mismatch on #type. Work around that by setting the type on the
# dep from the lockfile.
locked_dep.instance_variable_set(:@type, dep.type)
# We already know the name matches from the hash lookup
# so we only need to check the requirement now
changes ||= dep.requirement != locked_dep.requirement
end
changes
end
# Remove elements from the locked specs that are expired. This will most
# commonly happen if the Gemfile has changed since the lockfile was last
# generated
def converge_locked_specs
converged = converge_specs(@locked_specs)
resolve = SpecSet.new(converged.reject {|s| @gems_to_unlock.include?(s.name) })
diff = nil
# Now, we unlock any sources that do not have anymore gems pinned to it
sources.all_sources.each do |source|
next unless source.respond_to?(:unlock!)
unless resolve.any? {|s| s.source == source }
diff ||= @locked_specs.to_a - resolve.to_a
source.unlock! if diff.any? {|s| s.source == source }
end
end
resolve
end
def converge_specs(specs)
converged = []
deps = []
@specs_that_changed_sources = []
specs.each do |s|
name = s.name
dep = @dependencies.find {|d| s.satisfies?(d) }
lockfile_source = s.source
if dep
gemfile_source = dep.source || default_source
@specs_that_changed_sources << s if gemfile_source != lockfile_source
deps << dep if !dep.source || lockfile_source.include?(dep.source)
@gems_to_unlock << name if lockfile_source.include?(dep.source) && lockfile_source != gemfile_source
# Replace the locked dependency's source with the equivalent source from the Gemfile
s.source = gemfile_source
else
# Replace the locked dependency's source with the default source, if the locked source is no longer in the Gemfile
s.source = default_source unless sources.get(lockfile_source)
end
next if @sources_to_unlock.include?(s.source.name)
# Path sources have special logic
if s.source.instance_of?(Source::Path) || s.source.instance_of?(Source::Gemspec)
new_specs = begin
s.source.specs
rescue PathError
# if we won't need the source (according to the lockfile),
# don't error if the path source isn't available
next if specs.
for(requested_dependencies, false).
none? {|locked_spec| locked_spec.source == s.source }
raise
end
new_spec = new_specs[s].first
if new_spec
s.dependencies.replace(new_spec.dependencies)
else
# If the spec is no longer in the path source, unlock it. This
# commonly happens if the version changed in the gemspec
@gems_to_unlock << name
end
end
if dep.nil? && requested_dependencies.find {|d| name == d.name }
@gems_to_unlock << s.name
else
converged << s
end
end
filter_specs(converged, deps)
end
def metadata_dependencies
@metadata_dependencies ||= [
Dependency.new("Ruby\0", Bundler::RubyVersion.system.gem_version),
Dependency.new("RubyGems\0", Gem::VERSION),
]
end
def source_requirements
@source_requirements ||= find_source_requirements
end
def find_source_requirements
# Record the specs available in each gem's source, so that those
# specs will be available later when the resolver knows where to
# look for that gemspec (or its dependencies)
source_requirements = if precompute_source_requirements_for_indirect_dependencies?
all_requirements = source_map.all_requirements
{ default: default_source }.merge(all_requirements)
else
{ default: Source::RubygemsAggregate.new(sources, source_map) }.merge(source_map.direct_requirements)
end
source_requirements.merge!(source_map.locked_requirements) if nothing_changed?
metadata_dependencies.each do |dep|
source_requirements[dep.name] = sources.metadata_source
end
default_bundler_source = source_requirements["bundler"] || default_source
if @unlocking_bundler
default_bundler_source.add_dependency_names("bundler")
else
source_requirements[:default_bundler] = default_bundler_source
source_requirements["bundler"] = sources.metadata_source # needs to come last to override
end
verify_changed_sources!
source_requirements
end
def default_source
sources.default_source
end
def verify_changed_sources!
@specs_that_changed_sources.each do |s|
if s.source.specs.search(s.name).empty?
raise GemNotFound, "Could not find gem '#{s.name}' in #{s.source}"
end
end
end
def requested_groups
values = groups - Bundler.settings[:without] - @optional_groups + Bundler.settings[:with]
values &= Bundler.settings[:only] unless Bundler.settings[:only].empty?
values
end
def lockfiles_equal?(current, proposed, preserve_unknown_sections)
if preserve_unknown_sections
sections_to_ignore = LockfileParser.sections_to_ignore(@locked_bundler_version)
sections_to_ignore += LockfileParser.unknown_sections_in_lockfile(current)
sections_to_ignore << LockfileParser::RUBY
sections_to_ignore << LockfileParser::BUNDLED unless @unlocking_bundler
pattern = /#{Regexp.union(sections_to_ignore)}\n(\s{2,}.*\n)+/
whitespace_cleanup = /\n{2,}/
current = current.gsub(pattern, "\n").gsub(whitespace_cleanup, "\n\n").strip
proposed = proposed.gsub(pattern, "\n").gsub(whitespace_cleanup, "\n\n").strip
end
current == proposed
end
def additional_base_requirements_to_prevent_downgrades(resolution_packages, last_resolve)
return resolution_packages unless @locked_gems && !sources.expired_sources?(@locked_gems.sources)
converge_specs(@originally_locked_specs - last_resolve).each do |locked_spec|
next if locked_spec.source.is_a?(Source::Path)
resolution_packages.base_requirements[locked_spec.name] = Gem::Requirement.new(">= #{locked_spec.version}")
end
resolution_packages
end
def additional_base_requirements_to_force_updates(resolution_packages)
return resolution_packages if @explicit_unlocks.empty?
full_update = dup_for_full_unlock.resolve
@explicit_unlocks.each do |name|
version = full_update[name].first&.version
resolution_packages.base_requirements[name] = Gem::Requirement.new("= #{version}") if version
end
resolution_packages
end
def dup_for_full_unlock
unlocked_definition = self.class.new(@lockfile, @dependencies, @sources, true, @ruby_version, @optional_groups, @gemfiles)
unlocked_definition.source_requirements = source_requirements
unlocked_definition.gem_version_promoter.tap do |gvp|
gvp.level = gem_version_promoter.level
gvp.strict = gem_version_promoter.strict
gvp.pre = gem_version_promoter.pre
end
unlocked_definition
end
def remove_invalid_platforms!
return if Bundler.frozen_bundle?
platforms.reverse_each do |platform|
next if local_platform == platform ||
@new_platforms.include?(platform) ||
@path_changes ||
@dependency_changes ||
@locked_spec_with_invalid_deps ||
!spec_set_incomplete_for_platform?(@originally_locked_specs, platform)
remove_platform(platform)
end
end
def spec_set_incomplete_for_platform?(spec_set, platform)
spec_set.incomplete_for_platform?(current_dependencies, platform)
end
def source_map
@source_map ||= SourceMap.new(sources, dependencies, @locked_specs)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/current_ruby.rb 0000644 00000003451 15173517743 0017204 0 ustar 00 # frozen_string_literal: true
module Bundler
# Returns current version of Ruby
#
# @return [CurrentRuby] Current version of Ruby
def self.current_ruby
@current_ruby ||= CurrentRuby.new
end
class CurrentRuby
KNOWN_MINOR_VERSIONS = %w[
1.8
1.9
2.0
2.1
2.2
2.3
2.4
2.5
2.6
2.7
3.0
3.1
3.2
3.3
].freeze
KNOWN_MAJOR_VERSIONS = KNOWN_MINOR_VERSIONS.map {|v| v.split(".", 2).first }.uniq.freeze
KNOWN_PLATFORMS = %w[
jruby
maglev
mingw
mri
mswin
mswin64
rbx
ruby
truffleruby
windows
x64_mingw
].freeze
def ruby?
return true if Bundler::GemHelpers.generic_local_platform_is_ruby?
!windows? && (RUBY_ENGINE == "ruby" || RUBY_ENGINE == "rbx" || RUBY_ENGINE == "maglev" || RUBY_ENGINE == "truffleruby")
end
def mri?
!windows? && RUBY_ENGINE == "ruby"
end
def rbx?
ruby? && RUBY_ENGINE == "rbx"
end
def jruby?
RUBY_ENGINE == "jruby"
end
def maglev?
RUBY_ENGINE == "maglev"
end
def truffleruby?
RUBY_ENGINE == "truffleruby"
end
def windows?
Gem.win_platform?
end
alias_method :mswin?, :windows?
alias_method :mswin64?, :windows?
alias_method :mingw?, :windows?
alias_method :x64_mingw?, :windows?
(KNOWN_MINOR_VERSIONS + KNOWN_MAJOR_VERSIONS).each do |version|
trimmed_version = version.tr(".", "")
define_method(:"on_#{trimmed_version}?") do
RUBY_VERSION.start_with?("#{version}.")
end
KNOWN_PLATFORMS.each do |platform|
define_method(:"#{platform}_#{trimmed_version}?") do
send(:"#{platform}?") && send(:"on_#{trimmed_version}?")
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli.rb 0000644 00000121637 15173517743 0015237 0 ustar 00 # frozen_string_literal: true
require_relative "vendored_thor"
module Bundler
class CLI < Thor
require_relative "cli/common"
require_relative "cli/install"
package_name "Bundler"
AUTO_INSTALL_CMDS = %w[show binstubs outdated exec open console licenses clean].freeze
PARSEABLE_COMMANDS = %w[check config help exec platform show version].freeze
EXTENSIONS = ["c", "rust"].freeze
COMMAND_ALIASES = {
"check" => "c",
"install" => "i",
"plugin" => "",
"list" => "ls",
"exec" => ["e", "ex", "exe"],
"cache" => ["package", "pack"],
"version" => ["-v", "--version"],
}.freeze
def self.start(*)
check_deprecated_ext_option(ARGV) if ARGV.include?("--ext")
super
ensure
Bundler::SharedHelpers.print_major_deprecations!
end
def self.dispatch(*)
super do |i|
i.send(:print_command)
i.send(:warn_on_outdated_bundler)
end
end
def self.all_aliases
@all_aliases ||= begin
command_aliases = {}
COMMAND_ALIASES.each do |name, aliases|
Array(aliases).each do |one_alias|
command_aliases[one_alias] = name
end
end
command_aliases
end
end
def self.aliases_for(command_name)
COMMAND_ALIASES.select {|k, _| k == command_name }.invert
end
def initialize(*args)
super
custom_gemfile = options[:gemfile] || Bundler.settings[:gemfile]
if custom_gemfile && !custom_gemfile.empty?
Bundler::SharedHelpers.set_env "BUNDLE_GEMFILE", File.expand_path(custom_gemfile)
Bundler.reset_settings_and_root!
end
Bundler.auto_switch
Bundler.settings.set_command_option_if_given :retry, options[:retry]
current_cmd = args.last[:current_command].name
Bundler.auto_install if AUTO_INSTALL_CMDS.include?(current_cmd)
rescue UnknownArgumentError => e
raise InvalidOption, e.message
ensure
self.options ||= {}
unprinted_warnings = Bundler.ui.unprinted_warnings
Bundler.ui = UI::Shell.new(options)
Bundler.ui.level = "debug" if options["verbose"]
unprinted_warnings.each {|w| Bundler.ui.warn(w) }
end
check_unknown_options!(except: [:config, :exec])
stop_on_unknown_option! :exec
desc "cli_help", "Prints a summary of bundler commands", hide: true
def cli_help
version
Bundler.ui.info "\n"
primary_commands = ["install", "update", "cache", "exec", "config", "help"]
list = self.class.printable_commands(true)
by_name = list.group_by {|name, _message| name.match(/^bundle (\w+)/)[1] }
utilities = by_name.keys.sort - primary_commands
primary_commands.map! {|name| (by_name[name] || raise("no primary command #{name}")).first }
utilities.map! {|name| by_name[name].first }
shell.say "Bundler commands:\n\n"
shell.say " Primary commands:\n"
shell.print_table(primary_commands, indent: 4, truncate: true)
shell.say
shell.say " Utilities:\n"
shell.print_table(utilities, indent: 4, truncate: true)
shell.say
self.class.send(:class_options_help, shell)
end
default_task(Bundler.feature_flag.default_cli_command)
class_option "no-color", type: :boolean, desc: "Disable colorization in output"
class_option "retry", type: :numeric, aliases: "-r", banner: "NUM",
desc: "Specify the number of times you wish to attempt network commands"
class_option "verbose", type: :boolean, desc: "Enable verbose output mode", aliases: "-V"
def help(cli = nil)
cli = self.class.all_aliases[cli] if self.class.all_aliases[cli]
case cli
when "gemfile" then command = "gemfile"
when nil then command = "bundle"
else command = "bundle-#{cli}"
end
man_path = File.expand_path("man", __dir__)
man_pages = Hash[Dir.glob(File.join(man_path, "**", "*")).grep(/.*\.\d*\Z/).collect do |f|
[File.basename(f, ".*"), f]
end]
if man_pages.include?(command)
man_page = man_pages[command]
if Bundler.which("man") && !man_path.match?(%r{^file:/.+!/META-INF/jruby.home/.+})
Kernel.exec("man", man_page)
else
puts File.read("#{man_path}/#{File.basename(man_page)}.ronn")
end
elsif command_path = Bundler.which("bundler-#{cli}")
Kernel.exec(command_path, "--help")
else
super
end
end
def self.handle_no_command_error(command, has_namespace = $thor_runner)
if Bundler.feature_flag.plugins? && Bundler::Plugin.command?(command)
return Bundler::Plugin.exec_command(command, ARGV[1..-1])
end
return super unless command_path = Bundler.which("bundler-#{command}")
Kernel.exec(command_path, *ARGV[1..-1])
end
desc "init [OPTIONS]", "Generates a Gemfile into the current working directory"
long_desc <<-D
Init generates a default Gemfile in the current working directory. When adding a
Gemfile to a gem with a gemspec, the --gemspec option will automatically add each
dependency listed in the gemspec file to the newly created Gemfile.
D
method_option "gemspec", type: :string, banner: "Use the specified .gemspec to create the Gemfile"
method_option "gemfile", type: :string, banner: "Use the specified name for the gemfile instead of 'Gemfile'"
def init
require_relative "cli/init"
Init.new(options.dup).run
end
desc "check [OPTIONS]", "Checks if the dependencies listed in Gemfile are satisfied by currently installed gems"
long_desc <<-D
Check searches the local machine for each of the gems requested in the Gemfile. If
all gems are found, Bundler prints a success message and exits with a status of 0.
If not, the first missing gem is listed and Bundler exits status 1.
D
method_option "dry-run", type: :boolean, default: false, banner: "Lock the Gemfile"
method_option "gemfile", type: :string, banner: "Use the specified gemfile instead of Gemfile"
method_option "path", type: :string, banner: "Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME).#{" Bundler will remember this value for future installs on this machine" unless Bundler.feature_flag.forget_cli_options?}"
def check
remembered_flag_deprecation("path")
require_relative "cli/check"
Check.new(options).run
end
map aliases_for("check")
desc "remove [GEM [GEM ...]]", "Removes gems from the Gemfile"
long_desc <<-D
Removes the given gems from the Gemfile while ensuring that the resulting Gemfile is still valid. If the gem is not found, Bundler prints a error message and if gem could not be removed due to any reason Bundler will display a warning.
D
method_option "install", type: :boolean, banner: "Runs 'bundle install' after removing the gems from the Gemfile"
def remove(*gems)
if ARGV.include?("--install")
message = "The `--install` flag has been deprecated. `bundle install` is triggered by default."
removed_message = "The `--install` flag has been removed. `bundle install` is triggered by default."
SharedHelpers.major_deprecation(2, message, removed_message: removed_message)
end
require_relative "cli/remove"
Remove.new(gems, options).run
end
desc "install [OPTIONS]", "Install the current environment to the system"
long_desc <<-D
Install will install all of the gems in the current bundle, making them available
for use. In a freshly checked out repository, this command will give you the same
gem versions as the last person who updated the Gemfile and ran `bundle update`.
Passing [DIR] to install (e.g. vendor) will cause the unpacked gems to be installed
into the [DIR] directory rather than into system gems.
If the bundle has already been installed, bundler will tell you so and then exit.
D
method_option "binstubs", type: :string, lazy_default: "bin", banner: "Generate bin stubs for bundled gems to ./bin"
method_option "clean", type: :boolean, banner: "Run bundle clean automatically after install"
method_option "deployment", type: :boolean, banner: "Install using defaults tuned for deployment environments"
method_option "frozen", type: :boolean, banner: "Do not allow the Gemfile.lock to be updated after this install"
method_option "full-index", type: :boolean, banner: "Fall back to using the single-file index of all gems"
method_option "gemfile", type: :string, banner: "Use the specified gemfile instead of Gemfile"
method_option "jobs", aliases: "-j", type: :numeric, banner: "Specify the number of jobs to run in parallel"
method_option "local", type: :boolean, banner: "Do not attempt to fetch gems remotely and use the gem cache instead"
method_option "prefer-local", type: :boolean, banner: "Only attempt to fetch gems remotely if not present locally, even if newer versions are available remotely"
method_option "no-cache", type: :boolean, banner: "Don't update the existing gem cache."
method_option "redownload", type: :boolean, aliases: "--force", banner: "Force downloading every gem."
method_option "no-prune", type: :boolean, banner: "Don't remove stale gems from the cache."
method_option "path", type: :string, banner: "Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME).#{" Bundler will remember this value for future installs on this machine" unless Bundler.feature_flag.forget_cli_options?}"
method_option "quiet", type: :boolean, banner: "Only output warnings and errors."
method_option "shebang", type: :string, banner: "Specify a different shebang executable name than the default (usually 'ruby')"
method_option "standalone", type: :array, lazy_default: [], banner: "Make a bundle that can work without the Bundler runtime"
method_option "system", type: :boolean, banner: "Install to the system location ($BUNDLE_PATH or $GEM_HOME) even if the bundle was previously installed somewhere else for this application"
method_option "trust-policy", alias: "P", type: :string, banner: "Gem trust policy (like gem install -P). Must be one of " +
Bundler.rubygems.security_policy_keys.join("|")
method_option "without", type: :array, banner: "Exclude gems that are part of the specified named group."
method_option "with", type: :array, banner: "Include gems that are part of the specified named group."
def install
SharedHelpers.major_deprecation(2, "The `--force` option has been renamed to `--redownload`") if ARGV.include?("--force")
%w[clean deployment frozen no-prune path shebang without with].each do |option|
remembered_flag_deprecation(option)
end
print_remembered_flag_deprecation("--system", "path.system", "true") if ARGV.include?("--system")
remembered_negative_flag_deprecation("no-deployment")
require_relative "cli/install"
Bundler.settings.temporary(no_install: false) do
Install.new(options.dup).run
end
end
map aliases_for("install")
desc "update [OPTIONS]", "Update the current environment"
long_desc <<-D
Update will install the newest versions of the gems listed in the Gemfile. Use
update when you have changed the Gemfile, or if you want to get the newest
possible versions of the gems in the bundle.
D
method_option "full-index", type: :boolean, banner: "Fall back to using the single-file index of all gems"
method_option "gemfile", type: :string, banner: "Use the specified gemfile instead of Gemfile"
method_option "group", aliases: "-g", type: :array, banner: "Update a specific group"
method_option "jobs", aliases: "-j", type: :numeric, banner: "Specify the number of jobs to run in parallel"
method_option "local", type: :boolean, banner: "Do not attempt to fetch gems remotely and use the gem cache instead"
method_option "quiet", type: :boolean, banner: "Only output warnings and errors."
method_option "source", type: :array, banner: "Update a specific source (and all gems associated with it)"
method_option "redownload", type: :boolean, aliases: "--force", banner: "Force downloading every gem."
method_option "ruby", type: :boolean, banner: "Update ruby specified in Gemfile.lock"
method_option "bundler", type: :string, lazy_default: "> 0.a", banner: "Update the locked version of bundler"
method_option "patch", type: :boolean, banner: "Prefer updating only to next patch version"
method_option "minor", type: :boolean, banner: "Prefer updating only to next minor version"
method_option "major", type: :boolean, banner: "Prefer updating to next major version (default)"
method_option "pre", type: :boolean, banner: "Always choose the highest allowed version when updating gems, regardless of prerelease status"
method_option "strict", type: :boolean, banner: "Do not allow any gem to be updated past latest --patch | --minor | --major"
method_option "conservative", type: :boolean, banner: "Use bundle install conservative update behavior and do not allow shared dependencies to be updated."
method_option "all", type: :boolean, banner: "Update everything."
def update(*gems)
SharedHelpers.major_deprecation(2, "The `--force` option has been renamed to `--redownload`") if ARGV.include?("--force")
require_relative "cli/update"
Bundler.settings.temporary(no_install: false) do
Update.new(options, gems).run
end
end
desc "show GEM [OPTIONS]", "Shows all gems that are part of the bundle, or the path to a given gem"
long_desc <<-D
Show lists the names and versions of all gems that are required by your Gemfile.
Calling show with [GEM] will list the exact location of that gem on your machine.
D
method_option "paths", type: :boolean,
banner: "List the paths of all gems that are required by your Gemfile."
method_option "outdated", type: :boolean,
banner: "Show verbose output including whether gems are outdated."
def show(gem_name = nil)
if ARGV.include?("--outdated")
message = "the `--outdated` flag to `bundle show` was undocumented and will be removed without replacement"
removed_message = "the `--outdated` flag to `bundle show` was undocumented and has been removed without replacement"
SharedHelpers.major_deprecation(2, message, removed_message: removed_message)
end
require_relative "cli/show"
Show.new(options, gem_name).run
end
desc "list", "List all gems in the bundle"
method_option "name-only", type: :boolean, banner: "print only the gem names"
method_option "only-group", type: :array, default: [], banner: "print gems from a given set of groups"
method_option "without-group", type: :array, default: [], banner: "print all gems except from a given set of groups"
method_option "paths", type: :boolean, banner: "print the path to each gem in the bundle"
def list
require_relative "cli/list"
List.new(options).run
end
map aliases_for("list")
desc "info GEM [OPTIONS]", "Show information for the given gem"
method_option "path", type: :boolean, banner: "Print full path to gem"
method_option "version", type: :boolean, banner: "Print gem version"
def info(gem_name)
require_relative "cli/info"
Info.new(options, gem_name).run
end
desc "binstubs GEM [OPTIONS]", "Install the binstubs of the listed gem"
long_desc <<-D
Generate binstubs for executables in [GEM]. Binstubs are put into bin,
or the --binstubs directory if one has been set. Calling binstubs with [GEM [GEM]]
will create binstubs for all given gems.
D
method_option "force", type: :boolean, default: false, banner: "Overwrite existing binstubs if they exist"
method_option "path", type: :string, lazy_default: "bin", banner: "Binstub destination directory (default bin)"
method_option "shebang", type: :string, banner: "Specify a different shebang executable name than the default (usually 'ruby')"
method_option "standalone", type: :boolean, banner: "Make binstubs that can work without the Bundler runtime"
method_option "all", type: :boolean, banner: "Install binstubs for all gems"
method_option "all-platforms", type: :boolean, default: false, banner: "Install binstubs for all platforms"
def binstubs(*gems)
require_relative "cli/binstubs"
Binstubs.new(options, gems).run
end
desc "add GEM VERSION", "Add gem to Gemfile and run bundle install"
long_desc <<-D
Adds the specified gem to Gemfile (if valid) and run 'bundle install' in one step.
D
method_option "version", aliases: "-v", type: :string
method_option "group", aliases: "-g", type: :string
method_option "source", aliases: "-s", type: :string
method_option "require", aliases: "-r", type: :string, banner: "Adds require path to gem. Provide false, or a path as a string."
method_option "path", type: :string
method_option "git", type: :string
method_option "github", type: :string
method_option "branch", type: :string
method_option "ref", type: :string
method_option "glob", type: :string, banner: "The location of a dependency's .gemspec, expanded within Ruby (single quotes recommended)"
method_option "skip-install", type: :boolean, banner: "Adds gem to the Gemfile but does not install it"
method_option "optimistic", type: :boolean, banner: "Adds optimistic declaration of version to gem"
method_option "strict", type: :boolean, banner: "Adds strict declaration of version to gem"
def add(*gems)
require_relative "cli/add"
Add.new(options.dup, gems).run
end
desc "outdated GEM [OPTIONS]", "List installed gems with newer versions available"
long_desc <<-D
Outdated lists the names and versions of gems that have a newer version available
in the given source. Calling outdated with [GEM [GEM]] will only check for newer
versions of the given gems. Prerelease gems are ignored by default. If your gems
are up to date, Bundler will exit with a status of 0. Otherwise, it will exit 1.
For more information on patch level options (--major, --minor, --patch,
--strict) see documentation on the same options on the update command.
D
method_option "group", type: :string, banner: "List gems from a specific group"
method_option "groups", type: :boolean, banner: "List gems organized by groups"
method_option "local", type: :boolean, banner: "Do not attempt to fetch gems remotely and use the gem cache instead"
method_option "pre", type: :boolean, banner: "Check for newer pre-release gems"
method_option "source", type: :array, banner: "Check against a specific source"
method_option "filter-strict", type: :boolean, aliases: "--strict", banner: "Only list newer versions allowed by your Gemfile requirements"
method_option "update-strict", type: :boolean, banner: "Strict conservative resolution, do not allow any gem to be updated past latest --patch | --minor | --major"
method_option "minor", type: :boolean, banner: "Prefer updating only to next minor version"
method_option "major", type: :boolean, banner: "Prefer updating to next major version (default)"
method_option "patch", type: :boolean, banner: "Prefer updating only to next patch version"
method_option "filter-major", type: :boolean, banner: "Only list major newer versions"
method_option "filter-minor", type: :boolean, banner: "Only list minor newer versions"
method_option "filter-patch", type: :boolean, banner: "Only list patch newer versions"
method_option "parseable", aliases: "--porcelain", type: :boolean, banner: "Use minimal formatting for more parseable output"
method_option "only-explicit", type: :boolean, banner: "Only list gems specified in your Gemfile, not their dependencies"
def outdated(*gems)
require_relative "cli/outdated"
Outdated.new(options, gems).run
end
desc "fund [OPTIONS]", "Lists information about gems seeking funding assistance"
method_option "group", aliases: "-g", type: :array, banner: "Fetch funding information for a specific group"
def fund
require_relative "cli/fund"
Fund.new(options).run
end
desc "cache [OPTIONS]", "Locks and then caches all of the gems into vendor/cache"
method_option "all", type: :boolean,
default: Bundler.feature_flag.cache_all?,
banner: "Include all sources (including path and git)."
method_option "all-platforms", type: :boolean, banner: "Include gems for all platforms present in the lockfile, not only the current one"
method_option "cache-path", type: :string, banner: "Specify a different cache path than the default (vendor/cache)."
method_option "gemfile", type: :string, banner: "Use the specified gemfile instead of Gemfile"
method_option "no-install", type: :boolean, banner: "Don't install the gems, only update the cache."
method_option "no-prune", type: :boolean, banner: "Don't remove stale gems from the cache."
method_option "path", type: :string, banner: "Specify a different path than the system default ($BUNDLE_PATH or $GEM_HOME).#{" Bundler will remember this value for future installs on this machine" unless Bundler.feature_flag.forget_cli_options?}"
method_option "quiet", type: :boolean, banner: "Only output warnings and errors."
method_option "frozen", type: :boolean, banner: "Do not allow the Gemfile.lock to be updated after this bundle cache operation's install"
long_desc <<-D
The cache command will copy the .gem files for every gem in the bundle into the
directory ./vendor/cache. If you then check that directory into your source
control repository, others who check out your source will be able to install the
bundle without having to download any additional gems.
D
def cache
print_remembered_flag_deprecation("--all", "cache_all", "true") if ARGV.include?("--all")
if ARGV.include?("--path")
message =
"The `--path` flag is deprecated because its semantics are unclear. " \
"Use `bundle config cache_path` to configure the path of your cache of gems, " \
"and `bundle config path` to configure the path where your gems are installed, " \
"and stop using this flag"
removed_message =
"The `--path` flag has been removed because its semantics were unclear. " \
"Use `bundle config cache_path` to configure the path of your cache of gems, " \
"and `bundle config path` to configure the path where your gems are installed."
SharedHelpers.major_deprecation 2, message, removed_message: removed_message
end
require_relative "cli/cache"
Cache.new(options).run
end
map aliases_for("cache")
desc "exec [OPTIONS]", "Run the command in context of the bundle"
method_option :keep_file_descriptors, type: :boolean, default: true
method_option :gemfile, type: :string, required: false
long_desc <<-D
Exec runs a command, providing it access to the gems in the bundle. While using
bundle exec you can require and call the bundled gems as if they were installed
into the system wide RubyGems repository.
D
def exec(*args)
if ARGV.include?("--no-keep-file-descriptors")
message = "The `--no-keep-file-descriptors` has been deprecated. `bundle exec` no longer mess with your file descriptors. Close them in the exec'd script if you need to"
removed_message = "The `--no-keep-file-descriptors` has been removed. `bundle exec` no longer mess with your file descriptors. Close them in the exec'd script if you need to"
SharedHelpers.major_deprecation(2, message, removed_message: removed_message)
end
require_relative "cli/exec"
Exec.new(options, args).run
end
map aliases_for("exec")
desc "config NAME [VALUE]", "Retrieve or set a configuration value"
long_desc <<-D
Retrieves or sets a configuration value. If only one parameter is provided, retrieve the value. If two parameters are provided, replace the
existing value with the newly provided one.
By default, setting a configuration value sets it for all projects
on the machine.
If a global setting is superseded by local configuration, this command
will show the current value, as well as any superseded values and
where they were specified.
D
require_relative "cli/config"
subcommand "config", Config
desc "open GEM", "Opens the source directory of the given bundled gem"
method_option "path", type: :string, lazy_default: "", banner: "Open relative path of the gem source."
def open(name)
require_relative "cli/open"
Open.new(options, name).run
end
unless Bundler.feature_flag.bundler_3_mode?
desc "console [GROUP]", "Opens an IRB session with the bundle pre-loaded"
def console(group = nil)
require_relative "cli/console"
Console.new(options, group).run
end
end
desc "version", "Prints Bundler version information"
def version
cli_help = current_command.name == "cli_help"
if cli_help || ARGV.include?("version")
build_info = " (#{BuildMetadata.built_at} commit #{BuildMetadata.git_commit_sha})"
end
if !cli_help && Bundler.feature_flag.print_only_version_number?
Bundler.ui.info "#{Bundler::VERSION}#{build_info}"
else
Bundler.ui.info "Bundler version #{Bundler::VERSION}#{build_info}"
end
end
map aliases_for("version")
desc "licenses", "Prints the license of all gems in the bundle"
def licenses
Bundler.load.specs.sort_by {|s| s.license.to_s }.reverse_each do |s|
gem_name = s.name
license = s.license || s.licenses
if license.empty?
Bundler.ui.warn "#{gem_name}: Unknown"
else
Bundler.ui.info "#{gem_name}: #{license}"
end
end
end
unless Bundler.feature_flag.bundler_3_mode?
desc "viz [OPTIONS]", "Generates a visual dependency graph", hide: true
long_desc <<-D
Viz generates a PNG file of the current Gemfile as a dependency graph.
Viz requires the ruby-graphviz gem (and its dependencies).
The associated gems must also be installed via 'bundle install'.
D
method_option :file, type: :string, default: "gem_graph", aliases: "-f", desc: "The name to use for the generated file. see format option"
method_option :format, type: :string, default: "png", aliases: "-F", desc: "This is output format option. Supported format is png, jpg, svg, dot ..."
method_option :requirements, type: :boolean, default: false, aliases: "-R", desc: "Set to show the version of each required dependency."
method_option :version, type: :boolean, default: false, aliases: "-v", desc: "Set to show each gem version."
method_option :without, type: :array, default: [], aliases: "-W", banner: "GROUP[ GROUP...]", desc: "Exclude gems that are part of the specified named group."
def viz
SharedHelpers.major_deprecation 2, "The `viz` command has been renamed to `graph` and moved to a plugin. See https://github.com/rubygems/bundler-graph"
require_relative "cli/viz"
Viz.new(options.dup).run
end
end
old_gem = instance_method(:gem)
desc "gem NAME [OPTIONS]", "Creates a skeleton for creating a rubygem"
method_option :exe, type: :boolean, default: false, aliases: ["--bin", "-b"], desc: "Generate a binary executable for your library."
method_option :coc, type: :boolean, desc: "Generate a code of conduct file. Set a default with `bundle config set --global gem.coc true`."
method_option :edit, type: :string, aliases: "-e", required: false, banner: "EDITOR",
lazy_default: [ENV["BUNDLER_EDITOR"], ENV["VISUAL"], ENV["EDITOR"]].find {|e| !e.nil? && !e.empty? },
desc: "Open generated gemspec in the specified editor (defaults to $EDITOR or $BUNDLER_EDITOR)"
method_option :ext, type: :string, desc: "Generate the boilerplate for C extension code.", enum: EXTENSIONS
method_option :git, type: :boolean, default: true, desc: "Initialize a git repo inside your library."
method_option :mit, type: :boolean, desc: "Generate an MIT license file. Set a default with `bundle config set --global gem.mit true`."
method_option :rubocop, type: :boolean, desc: "Add rubocop to the generated Rakefile and gemspec. Set a default with `bundle config set --global gem.rubocop true`."
method_option :changelog, type: :boolean, desc: "Generate changelog file. Set a default with `bundle config set --global gem.changelog true`."
method_option :test, type: :string, lazy_default: Bundler.settings["gem.test"] || "", aliases: "-t", banner: "Use the specified test framework for your library",
enum: %w[rspec minitest test-unit],
desc: "Generate a test directory for your library, either rspec, minitest or test-unit. Set a default with `bundle config set --global gem.test (rspec|minitest|test-unit)`."
method_option :ci, type: :string, lazy_default: Bundler.settings["gem.ci"] || "",
enum: %w[github gitlab circle],
desc: "Generate CI configuration, either GitHub Actions, GitLab CI or CircleCI. Set a default with `bundle config set --global gem.ci (github|gitlab|circle)`"
method_option :linter, type: :string, lazy_default: Bundler.settings["gem.linter"] || "",
enum: %w[rubocop standard],
desc: "Add a linter and code formatter, either RuboCop or Standard. Set a default with `bundle config set --global gem.linter (rubocop|standard)`"
method_option :github_username, type: :string, default: Bundler.settings["gem.github_username"], banner: "Set your username on GitHub", desc: "Fill in GitHub username on README so that you don't have to do it manually. Set a default with `bundle config set --global gem.github_username <your_username>`."
def gem(name)
end
commands["gem"].tap do |gem_command|
def gem_command.run(instance, args = [])
arity = 1 # name
require_relative "cli/gem"
cmd_args = args + [instance]
cmd_args.unshift(instance.options)
cmd = begin
Gem.new(*cmd_args)
rescue ArgumentError => e
instance.class.handle_argument_error(self, e, args, arity)
end
cmd.run
end
end
undef_method(:gem)
define_method(:gem, old_gem)
private :gem
def self.source_root
File.expand_path("templates", __dir__)
end
desc "clean [OPTIONS]", "Cleans up unused gems in your bundler directory", hide: true
method_option "dry-run", type: :boolean, default: false, banner: "Only print out changes, do not clean gems"
method_option "force", type: :boolean, default: false, banner: "Forces cleaning up unused gems even if Bundler is configured to use globally installed gems. As a consequence, removes all system gems except for the ones in the current application."
def clean
require_relative "cli/clean"
Clean.new(options.dup).run
end
desc "platform [OPTIONS]", "Displays platform compatibility information"
method_option "ruby", type: :boolean, default: false, banner: "only display ruby related platform information"
def platform
require_relative "cli/platform"
Platform.new(options).run
end
desc "inject GEM VERSION", "Add the named gem, with version requirements, to the resolved Gemfile", hide: true
method_option "source", type: :string, banner: "Install gem from the given source"
method_option "group", type: :string, banner: "Install gem into a bundler group"
def inject(name, version)
SharedHelpers.major_deprecation 2, "The `inject` command has been replaced by the `add` command"
require_relative "cli/inject"
Inject.new(options.dup, name, version).run
end
desc "lock", "Creates a lockfile without installing"
method_option "update", type: :array, lazy_default: true, banner: "ignore the existing lockfile, update all gems by default, or update list of given gems"
method_option "local", type: :boolean, default: false, banner: "do not attempt to fetch remote gemspecs and use the local gem cache only"
method_option "print", type: :boolean, default: false, banner: "print the lockfile to STDOUT instead of writing to the file system"
method_option "gemfile", type: :string, banner: "Use the specified gemfile instead of Gemfile"
method_option "lockfile", type: :string, default: nil, banner: "the path the lockfile should be written to"
method_option "full-index", type: :boolean, default: false, banner: "Fall back to using the single-file index of all gems"
method_option "add-platform", type: :array, default: [], banner: "Add a new platform to the lockfile"
method_option "remove-platform", type: :array, default: [], banner: "Remove a platform from the lockfile"
method_option "patch", type: :boolean, banner: "If updating, prefer updating only to next patch version"
method_option "minor", type: :boolean, banner: "If updating, prefer updating only to next minor version"
method_option "major", type: :boolean, banner: "If updating, prefer updating to next major version (default)"
method_option "pre", type: :boolean, banner: "If updating, always choose the highest allowed version, regardless of prerelease status"
method_option "strict", type: :boolean, banner: "If updating, do not allow any gem to be updated past latest --patch | --minor | --major"
method_option "conservative", type: :boolean, banner: "If updating, use bundle install conservative update behavior and do not allow shared dependencies to be updated"
method_option "bundler", type: :string, lazy_default: "> 0.a", banner: "Update the locked version of bundler"
def lock
require_relative "cli/lock"
Lock.new(options).run
end
desc "env", "Print information about the environment Bundler is running under"
def env
Env.write($stdout)
end
desc "doctor [OPTIONS]", "Checks the bundle for common problems"
long_desc <<-D
Doctor scans the OS dependencies of each of the gems requested in the Gemfile. If
missing dependencies are detected, Bundler prints them and exits status 1.
Otherwise, Bundler prints a success message and exits with a status of 0.
D
method_option "gemfile", type: :string, banner: "Use the specified gemfile instead of Gemfile"
method_option "quiet", type: :boolean, banner: "Only output warnings and errors."
def doctor
require_relative "cli/doctor"
Doctor.new(options).run
end
desc "issue", "Learn how to report an issue in Bundler"
def issue
require_relative "cli/issue"
Issue.new.run
end
desc "pristine [GEMS...]", "Restores installed gems to pristine condition"
long_desc <<-D
Restores installed gems to pristine condition from files located in the
gem cache. Gems installed from a git repository will be issued `git
checkout --force`.
D
def pristine(*gems)
require_relative "cli/pristine"
Bundler.settings.temporary(no_install: false) do
Pristine.new(gems).run
end
end
if Bundler.feature_flag.plugins?
require_relative "cli/plugin"
desc "plugin", "Manage the bundler plugins"
subcommand "plugin", Plugin
end
# Reformat the arguments passed to bundle that include a --help flag
# into the corresponding `bundle help #{command}` call
def self.reformatted_help_args(args)
bundler_commands = (COMMAND_ALIASES.keys + COMMAND_ALIASES.values).flatten
help_flags = %w[--help -h]
exec_commands = ["exec"] + COMMAND_ALIASES["exec"]
help_used = args.index {|a| help_flags.include? a }
exec_used = args.index {|a| exec_commands.include? a }
command = args.find {|a| bundler_commands.include? a }
if exec_used && help_used
if exec_used + help_used == 1
%w[help exec]
else
args
end
elsif help_used
args = args.dup
args.delete_at(help_used)
["help", command || args].flatten.compact
else
args
end
end
def self.check_deprecated_ext_option(arguments)
# when deprecated version of `--ext` is called
# print out deprecation warning and pretend `--ext=c` was provided
if deprecated_ext_value?(arguments)
message = "Extensions can now be generated using C or Rust, so `--ext` with no arguments has been deprecated. Please select a language, e.g. `--ext=rust` to generate a Rust extension. This gem will now be generated as if `--ext=c` was used."
removed_message = "Extensions can now be generated using C or Rust, so `--ext` with no arguments has been removed. Please select a language, e.g. `--ext=rust` to generate a Rust extension."
SharedHelpers.major_deprecation 2, message, removed_message: removed_message
arguments[arguments.index("--ext")] = "--ext=c"
end
end
def self.deprecated_ext_value?(arguments)
index = arguments.index("--ext")
next_argument = arguments[index + 1]
# it is ok when --ext is followed with valid extension value
# for example `bundle gem hello --ext c`
return false if EXTENSIONS.include?(next_argument)
# deprecated call when --ext is called with no value in last position
# for example `bundle gem hello_gem --ext`
return true if next_argument.nil?
# deprecated call when --ext is followed by other parameter
# for example `bundle gem --ext --no-ci hello_gem`
return true if next_argument.start_with?("-")
# deprecated call when --ext is followed by gem name
# for example `bundle gem --ext hello_gem`
return true if next_argument
false
end
private
def current_command
_, _, config = @_initializer
config[:current_command]
end
def print_command
return unless Bundler.ui.debug?
cmd = current_command
command_name = cmd.name
return if PARSEABLE_COMMANDS.include?(command_name)
command = ["bundle", command_name] + args
options_to_print = options.dup
options_to_print.delete_if do |k, v|
next unless o = cmd.options[k]
o.default == v
end
command << Thor::Options.to_switches(options_to_print.sort_by(&:first)).strip
command.reject!(&:empty?)
Bundler.ui.info "Running `#{command * " "}` with bundler #{Bundler::VERSION}"
end
def warn_on_outdated_bundler
return if Bundler.settings[:disable_version_check]
command_name = current_command.name
return if PARSEABLE_COMMANDS.include?(command_name)
return unless SharedHelpers.md5_available?
require_relative "vendored_uri"
remote = Source::Rubygems::Remote.new(Gem::URI("https://rubygems.org"))
cache_path = Bundler.user_cache.join("compact_index", remote.cache_slug)
latest = Bundler::CompactIndexClient.new(cache_path).latest_version("bundler")
return unless latest
current = Gem::Version.new(VERSION)
return if current >= latest
Bundler.ui.warn \
"The latest bundler is #{latest}, but you are currently running #{current}.\n" \
"To update to the most recent version, run `bundle update --bundler`"
rescue RuntimeError
nil
end
def remembered_negative_flag_deprecation(name)
positive_name = name.gsub(/\Ano-/, "")
option = current_command.options[positive_name]
flag_name = "--no-" + option.switch_name.gsub(/\A--/, "")
flag_deprecation(positive_name, flag_name, option)
end
def remembered_flag_deprecation(name)
option = current_command.options[name]
flag_name = option.switch_name
flag_deprecation(name, flag_name, option)
end
def flag_deprecation(name, flag_name, option)
name_index = ARGV.find {|arg| flag_name == arg.split("=")[0] }
return unless name_index
value = options[name]
value = value.join(" ").to_s if option.type == :array
value = "'#{value}'" unless option.type == :boolean
print_remembered_flag_deprecation(flag_name, name.tr("-", "_"), value)
end
def print_remembered_flag_deprecation(flag_name, option_name, option_value)
message =
"The `#{flag_name}` flag is deprecated because it relies on being " \
"remembered across bundler invocations, which bundler will no longer " \
"do in future versions. Instead please use `bundle config set #{option_name} " \
"#{option_value}`, and stop using this flag"
removed_message =
"The `#{flag_name}` flag has been removed because it relied on being " \
"remembered across bundler invocations, which bundler will no longer " \
"do. Instead please use `bundle config set #{option_name} " \
"#{option_value}`, and stop using this flag"
Bundler::SharedHelpers.major_deprecation 2, message, removed_message: removed_message
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/stub_specification.rb 0000644 00000006431 15173517743 0020337 0 ustar 00 # frozen_string_literal: true
module Bundler
class StubSpecification < RemoteSpecification
def self.from_stub(stub)
return stub if stub.is_a?(Bundler::StubSpecification)
spec = new(stub.name, stub.version, stub.platform, nil)
spec.stub = stub
spec
end
attr_reader :checksum
attr_accessor :stub, :ignored
def source=(source)
super
# Stub has no concept of source, which means that extension_dir may be wrong
# This is the case for git-based gems. So, instead manually assign the extension dir
return unless source.respond_to?(:extension_dir_name)
unique_extension_dir = [source.extension_dir_name, File.basename(full_gem_path)].uniq.join("-")
path = File.join(stub.extensions_dir, unique_extension_dir)
stub.extension_dir = File.expand_path(path)
end
def to_yaml
_remote_specification.to_yaml
end
# @!group Stub Delegates
def ignored?
return @ignored unless @ignored.nil?
@ignored = missing_extensions?
return false unless @ignored
warn "Source #{source} is ignoring #{self} because it is missing extensions"
true
end
def manually_installed?
# This is for manually installed gems which are gems that were fixed in place after a
# failed installation. Once the issue was resolved, the user then manually created
# the gem specification using the instructions provided by `gem help install`
installed_by_version == Gem::Version.new(0)
end
# This is defined directly to avoid having to loading the full spec
def missing_extensions?
return false if default_gem?
return false if extensions.empty?
return false if File.exist? gem_build_complete_path
return false if manually_installed?
true
end
def activated?
stub.activated?
end
def activated=(activated)
stub.instance_variable_set(:@activated, activated)
end
def extensions
stub.extensions
end
def gem_build_complete_path
stub.gem_build_complete_path
end
def default_gem?
stub.default_gem?
end
def full_gem_path
stub.full_gem_path
end
def full_gem_path=(path)
stub.full_gem_path = path
end
def full_require_paths
stub.full_require_paths
end
def require_paths
stub.require_paths
end
def base_dir=(path)
stub.base_dir = path
end
def load_paths
full_require_paths
end
def loaded_from
stub.loaded_from
end
def matches_for_glob(glob)
stub.matches_for_glob(glob)
end
def raw_require_paths
stub.raw_require_paths
end
private
def _remote_specification
@_remote_specification ||= begin
rs = stub.to_spec
if rs.equal?(self) # happens when to_spec gets the spec from Gem.loaded_specs
rs = Gem::Specification.load(loaded_from)
Bundler.rubygems.stub_set_spec(stub, rs)
end
unless rs
raise GemspecError, "The gemspec for #{full_name} at #{loaded_from}" \
" was missing or broken. Try running `gem pristine #{name} -v #{version}`" \
" to fix the cached spec."
end
rs.source = source
rs.base_dir = stub.base_dir
rs
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/installer/gem_installer.rb 0000644 00000005012 15173517743 0021276 0 ustar 00 # frozen_string_literal: true
module Bundler
class GemInstaller
attr_reader :spec, :standalone, :worker, :force, :local, :installer
def initialize(spec, installer, standalone = false, worker = 0, force = false, local = false)
@spec = spec
@installer = installer
@standalone = standalone
@worker = worker
@force = force
@local = local
end
def install_from_spec
post_install_message = install
Bundler.ui.debug "#{worker}: #{spec.name} (#{spec.version}) from #{spec.loaded_from}"
generate_executable_stubs
[true, post_install_message]
rescue Bundler::InstallHookError, Bundler::SecurityError, Bundler::APIResponseMismatchError, Bundler::InsecureInstallPathError
raise
rescue Errno::ENOSPC
[false, out_of_space_message]
rescue Bundler::BundlerError, Gem::InstallError => e
[false, specific_failure_message(e)]
end
private
def specific_failure_message(e)
message = "#{e.class}: #{e.message}\n"
message += " " + e.backtrace.join("\n ") + "\n\n"
message = message.lines.first + Bundler.ui.add_color(message.lines.drop(1).join, :clear)
message + Bundler.ui.add_color(failure_message, :red)
end
def failure_message
install_error_message
end
def install_error_message
"An error occurred while installing #{spec.name} (#{spec.version}), and Bundler cannot continue."
end
def spec_settings
# Fetch the build settings, if there are any
if settings = Bundler.settings["build.#{spec.name}"]
require "shellwords"
Shellwords.shellsplit(settings)
end
end
def install
spec.source.install(
spec,
force: force,
local: local,
build_args: Array(spec_settings),
previous_spec: previous_spec,
)
end
def previous_spec
locked_gems = installer.definition.locked_gems
return unless locked_gems
locked_gems.specs.find {|s| s.name == spec.name }
end
def out_of_space_message
"#{install_error_message}\nYour disk is out of space. Free some space to be able to install your bundle."
end
def generate_executable_stubs
return if Bundler.feature_flag.forget_cli_options?
return if Bundler.settings[:inline]
if Bundler.settings[:bin] && standalone
installer.generate_standalone_bundler_executable_stubs(spec)
elsif Bundler.settings[:bin]
installer.generate_bundler_executable_stubs(spec, force: true)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/installer/standalone.rb 0000644 00000006105 15173517743 0020605 0 ustar 00 # frozen_string_literal: true
module Bundler
class Standalone
def initialize(groups, definition)
@specs = definition.specs_for(groups)
end
def generate
SharedHelpers.filesystem_access(bundler_path) do |p|
FileUtils.mkdir_p(p)
end
File.open File.join(bundler_path, "setup.rb"), "w" do |file|
file.puts "require 'rbconfig'"
file.puts prevent_gem_activation
file.puts define_path_helpers
file.puts reverse_rubygems_kernel_mixin
paths.each do |path|
if Pathname.new(path).absolute?
file.puts %($:.unshift "#{path}")
else
file.puts %($:.unshift File.expand_path("\#{__dir__}/#{path}"))
end
end
end
end
private
def paths
@specs.map do |spec|
next if spec.name == "bundler"
Array(spec.require_paths).map do |path|
gem_path(path, spec).
sub(version_dir, '#{RUBY_ENGINE}/#{Gem.ruby_api_version}').
sub(extensions_dir, 'extensions/\k<platform>/#{Gem.extension_api_version}')
# This is a static string intentionally. It's interpolated at a later time.
end
end.flatten.compact
end
def version_dir
"#{RUBY_ENGINE}/#{Gem.ruby_api_version}"
end
def extensions_dir
%r{extensions/(?<platform>[^/]+)/#{Regexp.escape(Gem.extension_api_version)}}
end
def bundler_path
Bundler.root.join(Bundler.settings[:path].to_s, "bundler")
end
def gem_path(path, spec)
full_path = Pathname.new(path).absolute? ? path : File.join(spec.full_gem_path, path)
if spec.source.instance_of?(Source::Path) && spec.source.path.absolute?
full_path
else
SharedHelpers.relative_path_to(full_path, from: Bundler.root.join(bundler_path))
end
end
def prevent_gem_activation
<<~'END'
module Kernel
remove_method(:gem) if private_method_defined?(:gem)
def gem(*)
end
private :gem
end
END
end
def define_path_helpers
<<~'END'
unless defined?(Gem)
module Gem
def self.ruby_api_version
RbConfig::CONFIG["ruby_version"]
end
def self.extension_api_version
if 'no' == RbConfig::CONFIG['ENABLE_SHARED']
"#{ruby_api_version}-static"
else
ruby_api_version
end
end
end
end
END
end
def reverse_rubygems_kernel_mixin
<<~END
if Gem.respond_to?(:discover_gems_on_require=)
Gem.discover_gems_on_require = false
else
[::Kernel.singleton_class, ::Kernel].each do |k|
if k.private_method_defined?(:gem_original_require)
private_require = k.private_method_defined?(:require)
k.send(:remove_method, :require)
k.send(:define_method, :require, k.instance_method(:gem_original_require))
k.send(:private, :require) if private_require
end
end
end
END
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/installer/parallel_installer.rb 0000644 00000012641 15173517743 0022330 0 ustar 00 # frozen_string_literal: true
require_relative "../worker"
require_relative "gem_installer"
module Bundler
class ParallelInstaller
class SpecInstallation
attr_accessor :spec, :name, :full_name, :post_install_message, :state, :error
def initialize(spec)
@spec = spec
@name = spec.name
@full_name = spec.full_name
@state = :none
@post_install_message = ""
@error = nil
end
def installed?
state == :installed
end
def enqueued?
state == :enqueued
end
def failed?
state == :failed
end
def ready_to_enqueue?
state == :none
end
def has_post_install_message?
!post_install_message.empty?
end
def ignorable_dependency?(dep)
dep.type == :development || dep.name == @name
end
# Checks installed dependencies against spec's dependencies to make
# sure needed dependencies have been installed.
def dependencies_installed?(installed_specs)
dependencies.all? {|d| installed_specs.include? d.name }
end
# Represents only the non-development dependencies, the ones that are
# itself and are in the total list.
def dependencies
@dependencies ||= all_dependencies.reject {|dep| ignorable_dependency? dep }
end
# Represents all dependencies
def all_dependencies
@spec.dependencies
end
def to_s
"#<#{self.class} #{full_name} (#{state})>"
end
end
def self.call(*args, **kwargs)
new(*args, **kwargs).call
end
attr_reader :size
def initialize(installer, all_specs, size, standalone, force, local: false, skip: nil)
@installer = installer
@size = size
@standalone = standalone
@force = force
@local = local
@specs = all_specs.map {|s| SpecInstallation.new(s) }
@specs.each do |spec_install|
spec_install.state = :installed if skip.include?(spec_install.name)
end if skip
@spec_set = all_specs
@rake = @specs.find {|s| s.name == "rake" unless s.installed? }
end
def call
if @rake
do_install(@rake, 0)
Gem::Specification.reset
end
if @size > 1
install_with_worker
else
install_serially
end
handle_error if failed_specs.any?
@specs
ensure
worker_pool&.stop
end
private
def failed_specs
@specs.select(&:failed?)
end
def install_with_worker
enqueue_specs
process_specs until finished_installing?
end
def install_serially
until finished_installing?
raise "failed to find a spec to enqueue while installing serially" unless spec_install = @specs.find(&:ready_to_enqueue?)
spec_install.state = :enqueued
do_install(spec_install, 0)
end
end
def worker_pool
@worker_pool ||= Bundler::Worker.new @size, "Parallel Installer", lambda {|spec_install, worker_num|
do_install(spec_install, worker_num)
}
end
def do_install(spec_install, worker_num)
Plugin.hook(Plugin::Events::GEM_BEFORE_INSTALL, spec_install)
gem_installer = Bundler::GemInstaller.new(
spec_install.spec, @installer, @standalone, worker_num, @force, @local
)
success, message = gem_installer.install_from_spec
if success
spec_install.state = :installed
spec_install.post_install_message = message unless message.nil?
else
spec_install.error = "#{message}\n\n#{require_tree_for_spec(spec_install.spec)}"
spec_install.state = :failed
end
Plugin.hook(Plugin::Events::GEM_AFTER_INSTALL, spec_install)
spec_install
end
# Dequeue a spec and save its post-install message and then enqueue the
# remaining specs.
# Some specs might've had to wait til this spec was installed to be
# processed so the call to `enqueue_specs` is important after every
# dequeue.
def process_specs
worker_pool.deq
enqueue_specs
end
def finished_installing?
@specs.all? do |spec|
return true if spec.failed?
spec.installed?
end
end
def handle_error
errors = failed_specs.map(&:error)
if exception = errors.find {|e| e.is_a?(Bundler::BundlerError) }
raise exception
end
raise Bundler::InstallError, errors.join("\n\n")
end
def require_tree_for_spec(spec)
tree = @spec_set.what_required(spec)
t = String.new("In #{File.basename(SharedHelpers.default_gemfile)}:\n")
tree.each_with_index do |s, depth|
t << " " * depth.succ << s.name
unless tree.last == s
t << %( was resolved to #{s.version}, which depends on)
end
t << %(\n)
end
t
end
# Keys in the remains hash represent uninstalled gems specs.
# We enqueue all gem specs that do not have any dependencies.
# Later we call this lambda again to install specs that depended on
# previously installed specifications. We continue until all specs
# are installed.
def enqueue_specs
installed_specs = {}
@specs.each do |spec|
next unless spec.installed?
installed_specs[spec.name] = true
end
@specs.each do |spec|
if spec.ready_to_enqueue? && spec.dependencies_installed?(installed_specs)
spec.state = :enqueued
worker_pool.enq spec
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/worker.rb 0000644 00000005550 15173517743 0015774 0 ustar 00 # frozen_string_literal: true
module Bundler
class Worker
POISON = Object.new
class WrappedException < StandardError
attr_reader :exception
def initialize(exn)
@exception = exn
end
end
# @return [String] the name of the worker
attr_reader :name
# Creates a worker pool of specified size
#
# @param size [Integer] Size of pool
# @param name [String] name the name of the worker
# @param func [Proc] job to run in inside the worker pool
def initialize(size, name, func)
@name = name
@request_queue = Thread::Queue.new
@response_queue = Thread::Queue.new
@func = func
@size = size
@threads = nil
@previous_interrupt_handler = nil
end
# Enqueue a request to be executed in the worker pool
#
# @param obj [String] mostly it is name of spec that should be downloaded
def enq(obj)
create_threads unless @threads
@request_queue.enq obj
end
# Retrieves results of job function being executed in worker pool
def deq
result = @response_queue.deq
raise result.exception if result.is_a?(WrappedException)
result
end
def stop
stop_threads
end
private
def process_queue(i)
loop do
obj = @request_queue.deq
break if obj.equal? POISON
@response_queue.enq apply_func(obj, i)
end
end
def apply_func(obj, i)
@func.call(obj, i)
rescue Exception => e # rubocop:disable Lint/RescueException
WrappedException.new(e)
end
# Stop the worker threads by sending a poison object down the request queue
# so as worker threads after retrieving it, shut themselves down
def stop_threads
return unless @threads
@threads.each { @request_queue.enq POISON }
@threads.each(&:join)
remove_interrupt_handler
@threads = nil
end
def abort_threads
Bundler.ui.debug("\n#{caller.join("\n")}")
@threads.each(&:exit)
exit 1
end
def create_threads
creation_errors = []
@threads = Array.new(@size) do |i|
Thread.start { process_queue(i) }.tap do |thread|
thread.name = "#{name} Worker ##{i}" if thread.respond_to?(:name=)
end
rescue ThreadError => e
creation_errors << e
nil
end.compact
add_interrupt_handler unless @threads.empty?
return if creation_errors.empty?
message = "Failed to create threads for the #{name} worker: #{creation_errors.map(&:to_s).uniq.join(", ")}"
raise ThreadCreationError, message if @threads.empty?
Bundler.ui.info message
end
def add_interrupt_handler
@previous_interrupt_handler = trap("INT") { abort_threads }
end
def remove_interrupt_handler
return unless @previous_interrupt_handler
trap "INT", @previous_interrupt_handler
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/ui/rg_proxy.rb 0000644 00000000460 15173517744 0016745 0 ustar 00 # frozen_string_literal: true
require_relative "../ui"
require "rubygems/user_interaction"
module Bundler
module UI
class RGProxy < ::Gem::SilentUI
def initialize(ui)
@ui = ui
super()
end
def say(message)
@ui&.debug(message)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/ui/shell.rb 0000644 00000010424 15173517744 0016204 0 ustar 00 # frozen_string_literal: true
require_relative "../vendored_thor"
module Bundler
module UI
class Shell
LEVELS = %w[silent error warn confirm info debug].freeze
OUTPUT_STREAMS = [:stdout, :stderr].freeze
attr_writer :shell
attr_reader :output_stream
def initialize(options = {})
Thor::Base.shell = options["no-color"] ? Thor::Shell::Basic : nil
@shell = Thor::Base.shell.new
@level = ENV["DEBUG"] ? "debug" : "info"
@warning_history = []
@output_stream = :stdout
end
def add_color(string, *color)
@shell.set_color(string, *color)
end
def info(msg = nil, newline = nil)
return unless info?
tell_me(msg || yield, nil, newline)
end
def confirm(msg = nil, newline = nil)
return unless confirm?
tell_me(msg || yield, :green, newline)
end
def warn(msg = nil, newline = nil, color = :yellow)
return unless warn?
return if @warning_history.include? msg
@warning_history << msg
tell_err(msg || yield, color, newline)
end
def error(msg = nil, newline = nil, color = :red)
return unless error?
tell_err(msg || yield, color, newline)
end
def debug(msg = nil, newline = nil)
return unless debug?
tell_me(msg || yield, nil, newline)
end
def info?
level("info")
end
def confirm?
level("confirm")
end
def warn?
level("warn")
end
def error?
level("error")
end
def debug?
level("debug")
end
def quiet?
level("quiet")
end
def ask(msg)
@shell.ask(msg)
end
def yes?(msg)
@shell.yes?(msg)
end
def no?(msg)
@shell.no?(msg)
end
def level=(level)
raise ArgumentError unless LEVELS.include?(level.to_s)
@level = level.to_s
end
def level(name = nil)
return @level unless name
unless index = LEVELS.index(name)
raise "#{name.inspect} is not a valid level"
end
index <= LEVELS.index(@level)
end
def output_stream=(symbol)
raise ArgumentError unless OUTPUT_STREAMS.include?(symbol)
@output_stream = symbol
end
def trace(e, newline = nil, force = false)
return unless debug? || force
msg = "#{e.class}: #{e.message}\n#{e.backtrace.join("\n ")}"
tell_err(msg, nil, newline)
end
def silence(&blk)
with_level("silent", &blk)
end
def progress(&blk)
with_output_stream(:stderr, &blk)
end
def unprinted_warnings
[]
end
private
# valimism
def tell_me(msg, color = nil, newline = nil)
return tell_err(msg, color, newline) if output_stream == :stderr
msg = word_wrap(msg) if newline.is_a?(Hash) && newline[:wrap]
if newline.nil?
@shell.say(msg, color)
else
@shell.say(msg, color, newline)
end
end
def tell_err(message, color = nil, newline = nil)
return if @shell.send(:stderr).closed?
newline = !message.to_s.match?(/( |\t)\Z/) if newline.nil?
message = word_wrap(message) if newline.is_a?(Hash) && newline[:wrap]
color = nil if color && !$stderr.tty?
buffer = @shell.send(:prepare_message, message, *color)
buffer << "\n" if newline && !message.to_s.end_with?("\n")
@shell.send(:stderr).print(buffer)
@shell.send(:stderr).flush
end
def strip_leading_spaces(text)
spaces = text[/\A\s+/, 0]
spaces ? text.gsub(/#{spaces}/, "") : text
end
def word_wrap(text, line_width = Thor::Terminal.terminal_width)
strip_leading_spaces(text).split("\n").collect do |line|
line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip : line
end * "\n"
end
def with_level(level)
original = @level
@level = level
yield
ensure
@level = original
end
def with_output_stream(symbol)
original = output_stream
self.output_stream = symbol
yield
ensure
@output_stream = original
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/ui/silent.rb 0000644 00000002540 15173517744 0016373 0 ustar 00 # frozen_string_literal: true
module Bundler
module UI
class Silent
attr_writer :shell
def initialize
@warnings = []
end
def add_color(string, color)
string
end
def info(message = nil, newline = nil)
end
def confirm(message = nil, newline = nil)
end
def warn(message = nil, newline = nil)
@warnings |= [message]
end
def error(message = nil, newline = nil)
end
def debug(message = nil, newline = nil)
end
def confirm?
false
end
def error?
false
end
def debug?
false
end
def info?
false
end
def quiet?
false
end
def warn?
false
end
def output_stream=(_symbol)
end
def output_stream
nil
end
def ask(message)
end
def yes?(msg)
raise "Cannot ask yes? with a silent shell"
end
def no?(msg)
raise "Cannot ask no? with a silent shell"
end
def level=(name)
end
def level(name = nil)
end
def trace(message, newline = nil, force = false)
end
def silence
yield
end
def progress
yield
end
def unprinted_warnings
@warnings
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/dependency.rb 0000644 00000006462 15173517744 0016605 0 ustar 00 # frozen_string_literal: true
require "rubygems/dependency"
require_relative "shared_helpers"
require_relative "rubygems_ext"
module Bundler
class Dependency < Gem::Dependency
attr_reader :autorequire
attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref, :glob
ALL_RUBY_VERSIONS = (18..27).to_a.concat((30..34).to_a).freeze
PLATFORM_MAP = {
ruby: [Gem::Platform::RUBY, ALL_RUBY_VERSIONS],
mri: [Gem::Platform::RUBY, ALL_RUBY_VERSIONS],
rbx: [Gem::Platform::RUBY],
truffleruby: [Gem::Platform::RUBY],
jruby: [Gem::Platform::JAVA, [18, 19]],
windows: [Gem::Platform::WINDOWS, ALL_RUBY_VERSIONS],
# deprecated
mswin: [Gem::Platform::MSWIN, ALL_RUBY_VERSIONS],
mswin64: [Gem::Platform::MSWIN64, ALL_RUBY_VERSIONS - [18]],
mingw: [Gem::Platform::MINGW, ALL_RUBY_VERSIONS],
x64_mingw: [Gem::Platform::X64_MINGW, ALL_RUBY_VERSIONS - [18, 19]],
}.each_with_object({}) do |(platform, spec), hash|
hash[platform] = spec[0]
spec[1]&.each {|version| hash[:"#{platform}_#{version}"] = spec[0] }
end.freeze
def initialize(name, version, options = {}, &blk)
type = options["type"] || :runtime
super(name, version, type)
@autorequire = nil
@groups = Array(options["group"] || :default).map(&:to_sym)
@source = options["source"]
@path = options["path"]
@git = options["git"]
@github = options["github"]
@branch = options["branch"]
@ref = options["ref"]
@glob = options["glob"]
@platforms = Array(options["platforms"])
@env = options["env"]
@should_include = options.fetch("should_include", true)
@gemfile = options["gemfile"]
@force_ruby_platform = options["force_ruby_platform"] if options.key?("force_ruby_platform")
@autorequire = Array(options["require"] || []) if options.key?("require")
end
RUBY_PLATFORM_ARRAY = [Gem::Platform::RUBY].freeze
private_constant :RUBY_PLATFORM_ARRAY
# Returns the platforms this dependency is valid for, in the same order as
# passed in the `valid_platforms` parameter
def gem_platforms(valid_platforms)
return RUBY_PLATFORM_ARRAY if force_ruby_platform
return valid_platforms if @platforms.empty?
valid_platforms.select {|p| expanded_platforms.include?(GemHelpers.generic(p)) }
end
def expanded_platforms
@expanded_platforms ||= @platforms.map {|pl| PLATFORM_MAP[pl] }.compact.flatten.uniq
end
def should_include?
@should_include && current_env? && current_platform?
end
def gemspec_dev_dep?
type == :development
end
def current_env?
return true unless @env
if @env.is_a?(Hash)
@env.all? do |key, val|
ENV[key.to_s] && (val.is_a?(String) ? ENV[key.to_s] == val : ENV[key.to_s] =~ val)
end
else
ENV[@env.to_s]
end
end
def current_platform?
return true if @platforms.empty?
@platforms.any? do |p|
Bundler.current_ruby.send("#{p}?")
end
end
def to_lock
out = super
out << "!" if source
out
end
def specific?
super
rescue NoMethodError
requirement != ">= 0"
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/git.rb 0000644 00000027556 15173517744 0016561 0 ustar 00 # frozen_string_literal: true
require_relative "../vendored_fileutils"
module Bundler
class Source
class Git < Path
autoload :GitProxy, File.expand_path("git/git_proxy", __dir__)
attr_reader :uri, :ref, :branch, :options, :glob, :submodules
def initialize(options)
@options = options
@checksum_store = Checksum::Store.new
@glob = options["glob"] || DEFAULT_GLOB
@allow_cached = false
@allow_remote = false
# Stringify options that could be set as symbols
%w[ref branch tag revision].each {|k| options[k] = options[k].to_s if options[k] }
@uri = URINormalizer.normalize_suffix(options["uri"] || "", trailing_slash: false)
@safe_uri = URICredentialsFilter.credential_filtered_uri(@uri)
@branch = options["branch"]
@ref = options["ref"] || options["branch"] || options["tag"]
@submodules = options["submodules"]
@name = options["name"]
@version = options["version"].to_s.strip.gsub("-", ".pre.")
@copied = false
@local = false
end
def remote!
return if @allow_remote
@local_specs = nil
@allow_remote = true
end
def cached!
return if @allow_cached
@local_specs = nil
@allow_cached = true
end
def self.from_lock(options)
new(options.merge("uri" => options.delete("remote")))
end
def to_lock
out = String.new("GIT\n")
out << " remote: #{@uri}\n"
out << " revision: #{revision}\n"
%w[ref branch tag submodules].each do |opt|
out << " #{opt}: #{options[opt]}\n" if options[opt]
end
out << " glob: #{@glob}\n" unless default_glob?
out << " specs:\n"
end
def to_gemfile
specifiers = %w[ref branch tag submodules glob].map do |opt|
"#{opt}: #{options[opt]}" if options[opt]
end
uri_with_specifiers(specifiers)
end
def hash
[self.class, uri, ref, branch, name, glob, submodules].hash
end
def eql?(other)
other.is_a?(Git) && uri == other.uri && ref == other.ref &&
branch == other.branch && name == other.name &&
glob == other.glob &&
submodules == other.submodules
end
alias_method :==, :eql?
def include?(other)
other.is_a?(Git) && uri == other.uri &&
name == other.name &&
glob == other.glob &&
submodules == other.submodules
end
def to_s
begin
at = humanized_ref || current_branch
rev = "at #{at}@#{shortref_for_display(revision)}"
rescue GitError
""
end
uri_with_specifiers([rev, glob_for_display])
end
def identifier
uri_with_specifiers([humanized_ref, cached_revision, glob_for_display])
end
def uri_with_specifiers(specifiers)
specifiers.compact!
suffix =
if specifiers.any?
" (#{specifiers.join(", ")})"
else
""
end
"#{@safe_uri}#{suffix}"
end
def name
File.basename(@uri, ".git")
end
# This is the path which is going to contain a specific
# checkout of the git repository. When using local git
# repos, this is set to the local repo.
def install_path
@install_path ||= begin
git_scope = "#{base_name}-#{shortref_for_path(revision)}"
Bundler.install_path.join(git_scope)
end
end
alias_method :path, :install_path
def extension_dir_name
"#{base_name}-#{shortref_for_path(revision)}"
end
def unlock!
git_proxy.revision = nil
options["revision"] = nil
@unlocked = true
end
def local_override!(path)
return false if local?
original_path = path
path = Pathname.new(path)
path = path.expand_path(Bundler.root) unless path.relative?
unless branch || Bundler.settings[:disable_local_branch_check]
raise GitError, "Cannot use local override for #{name} at #{path} because " \
":branch is not specified in Gemfile. Specify a branch or run " \
"`bundle config unset local.#{override_for(original_path)}` to remove the local override"
end
unless path.exist?
raise GitError, "Cannot use local override for #{name} because #{path} " \
"does not exist. Run `bundle config unset local.#{override_for(original_path)}` to remove the local override"
end
@local = true
set_paths!(path)
# Create a new git proxy without the cached revision
# so the Gemfile.lock always picks up the new revision.
@git_proxy = GitProxy.new(path, uri, options)
if current_branch != branch && !Bundler.settings[:disable_local_branch_check]
raise GitError, "Local override for #{name} at #{path} is using branch " \
"#{current_branch} but Gemfile specifies #{branch}"
end
changed = cached_revision && cached_revision != revision
if !Bundler.settings[:disable_local_revision_check] && changed && !@unlocked && !git_proxy.contains?(cached_revision)
raise GitError, "The Gemfile lock is pointing to revision #{shortref_for_display(cached_revision)} " \
"but the current branch in your local override for #{name} does not contain such commit. " \
"Please make sure your branch is up to date."
end
changed
end
def specs(*)
set_up_app_cache!(app_cache_path) if use_app_cache?
if requires_checkout? && !@copied
FileUtils.rm_rf(app_cache_path) if use_app_cache? && git_proxy.not_a_repository?
fetch
checkout
end
local_specs
end
def install(spec, options = {})
return if Bundler.settings[:no_install]
force = options[:force]
print_using_message "Using #{version_message(spec, options[:previous_spec])} from #{self}"
if (requires_checkout? && !@copied) || force
checkout
end
generate_bin_options = { disable_extensions: !spec.missing_extensions?, build_args: options[:build_args] }
generate_bin(spec, generate_bin_options)
requires_checkout? ? spec.post_install_message : nil
end
def cache(spec, custom_path = nil)
app_cache_path = app_cache_path(custom_path)
return unless Bundler.feature_flag.cache_all?
return if install_path == app_cache_path
return if cache_path == app_cache_path
cached!
FileUtils.rm_rf(app_cache_path)
git_proxy.checkout if requires_checkout?
FileUtils.cp_r("#{cache_path}/.", app_cache_path)
FileUtils.touch(app_cache_path.join(".bundlecache"))
FileUtils.rm_rf(Dir.glob(app_cache_path.join("hooks/*.sample")))
end
def load_spec_files
super
rescue PathError => e
Bundler.ui.trace e
raise GitError, "#{self} is not yet checked out. Run `bundle install` first."
end
# This is the path which is going to contain a cache
# of the git repository. When using the same git repository
# across different projects, this cache will be shared.
# When using local git repos, this is set to the local repo.
def cache_path
@cache_path ||= if Bundler.feature_flag.global_gem_cache?
Bundler.user_cache
else
Bundler.bundle_path.join("cache", "bundler")
end.join("git", git_scope)
end
def app_cache_dirname
"#{base_name}-#{shortref_for_path(cached_revision || revision)}"
end
def revision
git_proxy.revision
end
def current_branch
git_proxy.current_branch
end
def allow_git_ops?
@allow_remote || @allow_cached
end
def local?
@local
end
private
def checkout
Bundler.ui.debug " * Checking out revision: #{ref}"
git_proxy.copy_to(install_path, submodules)
serialize_gemspecs_in(install_path)
@copied = true
end
def humanized_ref
if local?
path
elsif user_ref = options["ref"]
if /\A[a-z0-9]{4,}\z/i.match?(ref)
shortref_for_display(user_ref)
else
user_ref
end
elsif ref
ref
end
end
def serialize_gemspecs_in(destination)
destination = destination.expand_path(Bundler.root) if destination.relative?
Dir["#{destination}/#{@glob}"].each do |spec_path|
# Evaluate gemspecs and cache the result. Gemspecs
# in git might require git or other dependencies.
# The gemspecs we cache should already be evaluated.
spec = Bundler.load_gemspec(spec_path)
next unless spec
spec.installed_by_version = Gem::VERSION
Bundler.rubygems.validate(spec)
File.open(spec_path, "wb") {|file| file.write(spec.to_ruby) }
end
end
def set_paths!(path)
set_cache_path!(path)
set_install_path!(path)
end
def set_cache_path!(path)
@git_proxy = nil
@cache_path = path
end
def set_install_path!(path)
@local_specs = nil
@install_path = path
end
def set_up_app_cache!(path)
FileUtils.mkdir_p(path.join("refs"))
set_cache_path!(path)
end
def has_app_cache?
cached_revision && super
end
def use_app_cache?
has_app_cache? && !local?
end
def requires_checkout?
allow_git_ops? && !local? && !cached_revision_checked_out?
end
def cached_revision_checked_out?
cached_revision && cached_revision == revision && install_path.exist?
end
def base_name
File.basename(uri.sub(%r{^(\w+://)?([^/:]+:)?(//\w*/)?(\w*/)*}, ""), ".git")
end
def shortref_for_display(ref)
ref[0..6]
end
def shortref_for_path(ref)
ref[0..11]
end
def glob_for_display
default_glob? ? nil : "glob: #{@glob}"
end
def default_glob?
@glob == DEFAULT_GLOB
end
def uri_hash
if %r{^\w+://(\w+@)?}.match?(uri)
# Downcase the domain component of the URI
# and strip off a trailing slash, if one is present
input = Gem::URI.parse(uri).normalize.to_s.sub(%r{/$}, "")
else
# If there is no URI scheme, assume it is an ssh/git URI
input = uri
end
# We use SHA1 here for historical reason and to preserve backward compatibility.
# But a transition to a simpler mangling algorithm would be welcome.
Bundler::Digest.sha1(input)
end
def cached_revision
options["revision"]
end
def cached?
cache_path.exist?
end
def git_proxy
@git_proxy ||= GitProxy.new(cache_path, uri, options, cached_revision, self)
end
def fetch
git_proxy.checkout
rescue GitError => e
raise unless Bundler.feature_flag.allow_offline_install?
Bundler.ui.warn "Using cached git data because of network errors:\n#{e}"
end
# no-op, since we validate when re-serializing the gemspec
def validate_spec(_spec); end
def load_gemspec(file)
dirname = Pathname.new(file).dirname
SharedHelpers.chdir(dirname.to_s) do
stub = Gem::StubSpecification.gemspec_stub(file, install_path.parent, install_path.parent)
stub.full_gem_path = dirname.expand_path(root).to_s
StubSpecification.from_stub(stub)
end
end
def git_scope
"#{base_name}-#{uri_hash}"
end
def extension_cache_slug(_)
extension_dir_name
end
def override_for(path)
Bundler.settings.local_overrides.key(path)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/gemspec.rb 0000644 00000000436 15173517744 0017405 0 ustar 00 # frozen_string_literal: true
module Bundler
class Source
class Gemspec < Path
attr_reader :gemspec
def initialize(options)
super
@gemspec = options["gemspec"]
end
def as_path_source
Path.new(options)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/metadata.rb 0000644 00000003320 15173517744 0017535 0 ustar 00 # frozen_string_literal: true
module Bundler
class Source
class Metadata < Source
def specs
@specs ||= Index.build do |idx|
idx << Gem::Specification.new("Ruby\0", Bundler::RubyVersion.system.gem_version)
idx << Gem::Specification.new("RubyGems\0", Gem::VERSION) do |s|
s.required_rubygems_version = Gem::Requirement.default
end
if local_spec = Gem.loaded_specs["bundler"]
raise CorruptBundlerInstallError.new(local_spec) if local_spec.version.to_s != Bundler::VERSION
idx << local_spec
else
idx << Gem::Specification.new do |s|
s.name = "bundler"
s.version = VERSION
s.license = "MIT"
s.platform = Gem::Platform::RUBY
s.authors = ["bundler team"]
s.bindir = "exe"
s.homepage = "https://bundler.io"
s.summary = "The best way to manage your application's dependencies"
s.executables = %w[bundle]
# can't point to the actual gemspec or else the require paths will be wrong
s.loaded_from = __dir__
end
end
idx.each {|s| s.source = self }
end
end
def options
{}
end
def install(spec, _opts = {})
print_using_message "Using #{version_message(spec)}"
nil
end
def to_s
"the local ruby installation"
end
def ==(other)
self.class == other.class
end
alias_method :eql?, :==
def hash
self.class.hash
end
def version_message(spec)
"#{spec.name} #{spec.version}"
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/git/git_proxy.rb 0000644 00000035523 15173517744 0020576 0 ustar 00 # frozen_string_literal: true
module Bundler
class Source
class Git
class GitNotInstalledError < GitError
def initialize
msg = String.new
msg << "You need to install git to be able to use gems from git repositories. "
msg << "For help installing git, please refer to GitHub's tutorial at https://help.github.com/articles/set-up-git"
super msg
end
end
class GitNotAllowedError < GitError
def initialize(command)
msg = String.new
msg << "Bundler is trying to run `#{command}` at runtime. You probably need to run `bundle install`. However, "
msg << "this error message could probably be more useful. Please submit a ticket at https://github.com/rubygems/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md "
msg << "with steps to reproduce as well as the following\n\nCALLER: #{caller.join("\n")}"
super msg
end
end
class GitCommandError < GitError
attr_reader :command
def initialize(command, path, extra_info = nil)
@command = command
msg = String.new("Git error: command `#{command}`")
msg << " in directory #{path}" if path
msg << " has failed."
msg << "\n#{extra_info}" if extra_info
super msg
end
end
class MissingGitRevisionError < GitCommandError
def initialize(command, destination_path, ref, repo)
msg = "Revision #{ref} does not exist in the repository #{repo}. Maybe you misspelled it?"
super command, destination_path, msg
end
end
class AmbiguousGitReference < GitError
def initialize(options)
msg = "Specification of branch or ref with tag is ambiguous. You specified #{options.inspect}"
super msg
end
end
# The GitProxy is responsible to interact with git repositories.
# All actions required by the Git source is encapsulated in this
# object.
class GitProxy
attr_accessor :path, :uri, :branch, :tag, :ref, :explicit_ref
attr_writer :revision
def initialize(path, uri, options = {}, revision = nil, git = nil)
@path = path
@uri = uri
@tag = options["tag"]
@branch = options["branch"]
@ref = options["ref"]
if @tag
raise AmbiguousGitReference.new(options) if @branch || @ref
@explicit_ref = @tag
else
@explicit_ref = @ref || @branch
end
@revision = revision
@git = git
@commit_ref = nil
end
def revision
@revision ||= allowed_with_path { find_local_revision }
end
def current_branch
@current_branch ||= with_path do
git_local("rev-parse", "--abbrev-ref", "HEAD", dir: path).strip
end
end
def not_a_repository?
_, status = git_null("rev-parse", "--resolve-git-dir", path.to_s, dir: path)
!status.success?
end
def contains?(commit)
allowed_with_path do
result, status = git_null("branch", "--contains", commit, dir: path)
status.success? && result.match?(/^\* (.*)$/)
end
end
def version
@version ||= full_version.match(/((\.?\d+)+).*/)[1]
end
def full_version
@full_version ||= git_local("--version").sub(/git version\s*/, "").strip
end
def checkout
return if has_revision_cached?
Bundler.ui.info "Fetching #{credential_filtered_uri}"
extra_fetch_needed = clone_needs_extra_fetch?
unshallow_needed = clone_needs_unshallow?
return unless extra_fetch_needed || unshallow_needed
git_remote_fetch(unshallow_needed ? ["--unshallow"] : depth_args)
end
def copy_to(destination, submodules = false)
unless File.exist?(destination.join(".git"))
begin
SharedHelpers.filesystem_access(destination.dirname) do |p|
FileUtils.mkdir_p(p)
end
SharedHelpers.filesystem_access(destination) do |p|
FileUtils.rm_rf(p)
end
git "clone", "--no-checkout", "--quiet", path.to_s, destination.to_s
File.chmod(((File.stat(destination).mode | 0o777) & ~File.umask), destination)
rescue Errno::EEXIST => e
file_path = e.message[%r{.*?((?:[a-zA-Z]:)?/.*)}, 1]
raise GitError, "Bundler could not install a gem because it needs to " \
"create a directory, but a file exists - #{file_path}. Please delete " \
"this file and try again."
end
end
ref = @commit_ref || (locked_to_full_sha? && @revision)
if ref
git "config", "uploadpack.allowAnySHA1InWant", "true", dir: path.to_s if @commit_ref.nil? && needs_allow_any_sha1_in_want?
git "fetch", "--force", "--quiet", *extra_fetch_args(ref), dir: destination
end
git "reset", "--hard", @revision, dir: destination
if submodules
git_retry "submodule", "update", "--init", "--recursive", dir: destination
elsif Gem::Version.create(version) >= Gem::Version.create("2.9.0")
inner_command = "git -C $toplevel submodule deinit --force $sm_path"
git_retry "submodule", "foreach", "--quiet", inner_command, dir: destination
end
end
private
def git_remote_fetch(args)
command = ["fetch", "--force", "--quiet", "--no-tags", *args, "--", configured_uri, refspec].compact
command_with_no_credentials = check_allowed(command)
Bundler::Retry.new("`#{command_with_no_credentials}` at #{path}", [MissingGitRevisionError]).attempts do
out, err, status = capture(command, path)
return out if status.success?
if err.include?("couldn't find remote ref") || err.include?("not our ref")
raise MissingGitRevisionError.new(command_with_no_credentials, path, commit || explicit_ref, credential_filtered_uri)
else
raise GitCommandError.new(command_with_no_credentials, path, err)
end
end
end
def clone_needs_extra_fetch?
return true if path.exist?
SharedHelpers.filesystem_access(path.dirname) do |p|
FileUtils.mkdir_p(p)
end
command = ["clone", "--bare", "--no-hardlinks", "--quiet", *extra_clone_args, "--", configured_uri, path.to_s]
command_with_no_credentials = check_allowed(command)
Bundler::Retry.new("`#{command_with_no_credentials}`", [MissingGitRevisionError]).attempts do
_, err, status = capture(command, nil)
return extra_ref if status.success?
if err.include?("Could not find remote branch") || # git up to 2.49
err.include?("Remote branch #{branch_option} not found") # git 2.49 or higher
raise MissingGitRevisionError.new(command_with_no_credentials, nil, explicit_ref, credential_filtered_uri)
else
idx = command.index("--depth")
if idx
command.delete_at(idx)
command.delete_at(idx)
command_with_no_credentials = check_allowed(command)
err += "Retrying without --depth argument."
end
raise GitCommandError.new(command_with_no_credentials, path, err)
end
end
end
def clone_needs_unshallow?
return false unless path.join("shallow").exist?
return true if full_clone?
@revision && @revision != head_revision
end
def extra_ref
return false if not_pinned?
return true unless full_clone?
ref.start_with?("refs/")
end
def depth
return @depth if defined?(@depth)
@depth = if !supports_fetching_unreachable_refs?
nil
elsif not_pinned? || pinned_to_full_sha?
1
elsif ref.include?("~")
parsed_depth = ref.split("~").last
parsed_depth.to_i + 1
end
end
def refspec
if commit
@commit_ref = "refs/#{commit}-sha"
return "#{commit}:#{@commit_ref}"
end
reference = fully_qualified_ref
reference ||= if ref.include?("~")
ref.split("~").first
elsif ref.start_with?("refs/")
ref
else
"refs/*"
end
"#{reference}:#{reference}"
end
def commit
@commit ||= pinned_to_full_sha? ? ref : @revision
end
def fully_qualified_ref
if branch
"refs/heads/#{branch}"
elsif tag
"refs/tags/#{tag}"
elsif ref.nil?
"refs/heads/#{current_branch}"
end
end
def not_pinned?
branch_option || ref.nil?
end
def pinned_to_full_sha?
full_sha_revision?(ref)
end
def locked_to_full_sha?
full_sha_revision?(@revision)
end
def full_sha_revision?(ref)
ref&.match?(/\A\h{40}\z/)
end
def git_null(*command, dir: nil)
check_allowed(command)
capture(command, dir, ignore_err: true)
end
def git_retry(*command, dir: nil)
command_with_no_credentials = check_allowed(command)
Bundler::Retry.new("`#{command_with_no_credentials}` at #{dir || SharedHelpers.pwd}").attempts do
git(*command, dir: dir)
end
end
def git(*command, dir: nil)
run_command(*command, dir: dir) do |unredacted_command|
check_allowed(unredacted_command)
end
end
def git_local(*command, dir: nil)
run_command(*command, dir: dir) do |unredacted_command|
redact_and_check_presence(unredacted_command)
end
end
def has_revision_cached?
return unless @revision && path.exist?
git("cat-file", "-e", @revision, dir: path)
true
rescue GitError
false
end
def find_local_revision
return head_revision if explicit_ref.nil?
find_revision_for(explicit_ref)
end
def head_revision
verify("HEAD")
end
def find_revision_for(reference)
verify(reference)
rescue GitCommandError => e
raise MissingGitRevisionError.new(e.command, path, reference, credential_filtered_uri)
end
def verify(reference)
git("rev-parse", "--verify", reference, dir: path).strip
end
# Adds credentials to the URI
def configured_uri
if /https?:/.match?(uri)
remote = Gem::URI(uri)
config_auth = Bundler.settings[remote.to_s] || Bundler.settings[remote.host]
remote.userinfo ||= config_auth
remote.to_s
else
uri.to_s
end
end
# Removes credentials from the URI
def credential_filtered_uri
URICredentialsFilter.credential_filtered_uri(uri)
end
def allow?
allowed = @git ? @git.allow_git_ops? : true
raise GitNotInstalledError.new if allowed && !Bundler.git_present?
allowed
end
def with_path(&blk)
checkout unless path.exist?
blk.call
end
def allowed_with_path
return with_path { yield } if allow?
raise GitError, "The git source #{uri} is not yet checked out. Please run `bundle install` before trying to start your application"
end
def check_allowed(command)
command_with_no_credentials = redact_and_check_presence(command)
raise GitNotAllowedError.new(command_with_no_credentials) unless allow?
command_with_no_credentials
end
def redact_and_check_presence(command)
raise GitNotInstalledError.new unless Bundler.git_present?
require "shellwords"
URICredentialsFilter.credential_filtered_string("git #{command.shelljoin}", uri)
end
def run_command(*command, dir: nil)
command_with_no_credentials = yield(command)
out, err, status = capture(command, dir)
raise GitCommandError.new(command_with_no_credentials, dir || SharedHelpers.pwd, err) unless status.success?
Bundler.ui.warn err unless err.empty?
out
end
def capture(cmd, dir, ignore_err: false)
SharedHelpers.with_clean_git_env do
require "open3"
out, err, status = Open3.capture3(*capture3_args_for(cmd, dir))
filtered_out = URICredentialsFilter.credential_filtered_string(out, uri)
return [filtered_out, status] if ignore_err
filtered_err = URICredentialsFilter.credential_filtered_string(err, uri)
[filtered_out, filtered_err, status]
end
end
def capture3_args_for(cmd, dir)
return ["git", *cmd] unless dir
if Bundler.feature_flag.bundler_3_mode? || supports_minus_c?
["git", "-C", dir.to_s, *cmd]
else
["git", *cmd, { chdir: dir.to_s }]
end
end
def extra_clone_args
args = depth_args
return [] if args.empty?
args += ["--single-branch"]
args.unshift("--no-tags") if supports_cloning_with_no_tags?
# If there's a locked revision, no need to clone any specific branch
# or tag, since we will end up checking out that locked revision
# anyways.
return args if @revision
args += ["--branch", branch_option] if branch_option
args
end
def depth_args
return [] if full_clone?
["--depth", depth.to_s]
end
def extra_fetch_args(ref)
extra_args = [path.to_s, *depth_args]
extra_args.push(ref)
extra_args
end
def branch_option
branch || tag
end
def full_clone?
depth.nil?
end
def supports_minus_c?
@supports_minus_c ||= Gem::Version.new(version) >= Gem::Version.new("1.8.5")
end
def needs_allow_any_sha1_in_want?
@needs_allow_any_sha1_in_want ||= Gem::Version.new(version) <= Gem::Version.new("2.13.7")
end
def supports_fetching_unreachable_refs?
@supports_fetching_unreachable_refs ||= Gem::Version.new(version) >= Gem::Version.new("2.5.0")
end
def supports_cloning_with_no_tags?
@supports_cloning_with_no_tags ||= Gem::Version.new(version) >= Gem::Version.new("2.14.0-rc0")
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/rubygems.rb 0000644 00000035365 15173517744 0017630 0 ustar 00 # frozen_string_literal: true
require "rubygems/user_interaction"
module Bundler
class Source
class Rubygems < Source
autoload :Remote, File.expand_path("rubygems/remote", __dir__)
# Ask for X gems per API request
API_REQUEST_SIZE = 50
attr_accessor :remotes
def initialize(options = {})
@options = options
@remotes = []
@dependency_names = []
@allow_remote = false
@allow_cached = false
@allow_local = options["allow_local"] || false
@checksum_store = Checksum::Store.new
Array(options["remotes"]).reverse_each {|r| add_remote(r) }
@lockfile_remotes = @remotes if options["from_lockfile"]
end
def caches
@caches ||= [cache_path, *Bundler.rubygems.gem_cache]
end
def local_only!
@specs = nil
@allow_local = true
@allow_cached = false
@allow_remote = false
end
def local!
return if @allow_local
@specs = nil
@allow_local = true
end
def remote!
return if @allow_remote
@specs = nil
@allow_remote = true
end
def cached!
return unless File.exist?(cache_path)
return if @allow_cached
@specs = nil
@allow_cached = true
end
def hash
@remotes.hash
end
def eql?(other)
other.is_a?(Rubygems) && other.credless_remotes == credless_remotes
end
alias_method :==, :eql?
def include?(o)
o.is_a?(Rubygems) && (o.credless_remotes - credless_remotes).empty?
end
def multiple_remotes?
@remotes.size > 1
end
def no_remotes?
@remotes.size == 0
end
def can_lock?(spec)
return super unless multiple_remotes?
include?(spec.source)
end
def options
{ "remotes" => @remotes.map(&:to_s) }
end
def self.from_lock(options)
options["remotes"] = Array(options.delete("remote")).reverse
new(options.merge("from_lockfile" => true))
end
def to_lock
out = String.new("GEM\n")
lockfile_remotes.reverse_each do |remote|
out << " remote: #{remote}\n"
end
out << " specs:\n"
end
def to_s
if remotes.empty?
"locally installed gems"
elsif @allow_remote && @allow_cached && @allow_local
"rubygems repository #{remote_names}, cached gems or installed locally"
elsif @allow_remote && @allow_local
"rubygems repository #{remote_names} or installed locally"
elsif @allow_remote
"rubygems repository #{remote_names}"
elsif @allow_cached && @allow_local
"cached gems or installed locally"
else
"locally installed gems"
end
end
def identifier
if remotes.empty?
"locally installed gems"
else
"rubygems repository #{remote_names}"
end
end
alias_method :name, :identifier
alias_method :to_gemfile, :identifier
def specs
@specs ||= begin
# remote_specs usually generates a way larger Index than the other
# sources, and large_idx.merge! small_idx is way faster than
# small_idx.merge! large_idx.
index = @allow_remote ? remote_specs.dup : Index.new
index.merge!(cached_specs) if @allow_cached
index.merge!(installed_specs) if @allow_local
# complete with default specs, only if not already available in the
# index through remote, cached, or installed specs
index.use(default_specs) if @allow_local
index
end
end
def install(spec, options = {})
if (spec.default_gem? && !cached_built_in_gem(spec, local: options[:local])) || (installed?(spec) && !options[:force])
print_using_message "Using #{version_message(spec, options[:previous_spec])}"
return nil # no post-install message
end
if spec.remote
# Check for this spec from other sources
uris = [spec.remote, *remotes_for_spec(spec)].map(&:anonymized_uri).uniq
Installer.ambiguous_gems << [spec.name, *uris] if uris.length > 1
end
path = fetch_gem_if_possible(spec, options[:previous_spec])
raise GemNotFound, "Could not find #{spec.file_name} for installation" unless path
return if Bundler.settings[:no_install]
install_path = rubygems_dir
bin_path = Bundler.system_bindir
require_relative "../rubygems_gem_installer"
installer = Bundler::RubyGemsGemInstaller.at(
path,
security_policy: Bundler.rubygems.security_policies[Bundler.settings["trust-policy"]],
install_dir: install_path.to_s,
bin_dir: bin_path.to_s,
ignore_dependencies: true,
wrappers: true,
env_shebang: true,
build_args: options[:build_args],
bundler_extension_cache_path: extension_cache_path(spec)
)
if spec.remote
s = begin
installer.spec
rescue Gem::Package::FormatError
Bundler.rm_rf(path)
raise
rescue Gem::Security::Exception => e
raise SecurityError,
"The gem #{File.basename(path, ".gem")} can't be installed because " \
"the security policy didn't allow it, with the message: #{e.message}"
end
spec.__swap__(s)
end
spec.source.checksum_store.register(spec, installer.gem_checksum)
message = "Installing #{version_message(spec, options[:previous_spec])}"
message += " with native extensions" if spec.extensions.any?
Bundler.ui.confirm message
installed_spec = installer.install
spec.full_gem_path = installed_spec.full_gem_path
spec.loaded_from = installed_spec.loaded_from
spec.base_dir = installed_spec.base_dir
spec.post_install_message
end
def cache(spec, custom_path = nil)
cached_path = Bundler.settings[:cache_all_platforms] ? fetch_gem_if_possible(spec) : cached_gem(spec)
raise GemNotFound, "Missing gem file '#{spec.file_name}'." unless cached_path
return if File.dirname(cached_path) == Bundler.app_cache.to_s
Bundler.ui.info " * #{File.basename(cached_path)}"
FileUtils.cp(cached_path, Bundler.app_cache(custom_path))
rescue Errno::EACCES => e
Bundler.ui.debug(e)
raise InstallError, e.message
end
def cached_built_in_gem(spec, local: false)
cached_path = cached_gem(spec)
if cached_path.nil? && !local
remote_spec = remote_specs.search(spec).first
if remote_spec
cached_path = fetch_gem(remote_spec)
spec.remote = remote_spec.remote
else
Bundler.ui.warn "#{spec.full_name} is built in to Ruby, and can't be cached because your Gemfile doesn't have any sources that contain it."
end
end
cached_path
end
def add_remote(source)
uri = normalize_uri(source)
@remotes.unshift(uri) unless @remotes.include?(uri)
end
def spec_names
if dependency_api_available?
remote_specs.spec_names
else
[]
end
end
def unmet_deps
if dependency_api_available?
remote_specs.unmet_dependency_names
else
[]
end
end
def remote_fetchers
@remote_fetchers ||= remotes.to_h do |uri|
remote = Source::Rubygems::Remote.new(uri)
[remote, Bundler::Fetcher.new(remote)]
end.freeze
end
def fetchers
@fetchers ||= remote_fetchers.values.freeze
end
def double_check_for(unmet_dependency_names)
return unless dependency_api_available?
unmet_dependency_names = unmet_dependency_names.call
unless unmet_dependency_names.nil?
if api_fetchers.size <= 1
# can't do this when there are multiple fetchers because then we might not fetch from _all_
# of them
unmet_dependency_names -= remote_specs.spec_names # avoid re-fetching things we've already gotten
end
return if unmet_dependency_names.empty?
end
Bundler.ui.debug "Double checking for #{unmet_dependency_names || "all specs (due to the size of the request)"} in #{self}"
fetch_names(api_fetchers, unmet_dependency_names, remote_specs)
specs.use remote_specs
end
def dependency_names_to_double_check
names = []
remote_specs.each do |spec|
case spec
when EndpointSpecification, Gem::Specification, StubSpecification, LazySpecification
names.concat(spec.runtime_dependencies.map(&:name))
when RemoteSpecification # from the full index
return nil
else
raise "unhandled spec type (#{spec.inspect})"
end
end
names
end
def dependency_api_available?
@allow_remote && api_fetchers.any?
end
protected
def remote_names
remotes.map(&:to_s).join(", ")
end
def credless_remotes
remotes.map(&method(:remove_auth))
end
def remotes_for_spec(spec)
specs.search_all(spec.name).inject([]) do |uris, s|
uris << s.remote if s.remote
uris
end
end
def cached_gem(spec)
global_cache_path = download_cache_path(spec)
caches << global_cache_path if global_cache_path
possibilities = caches.map {|p| package_path(p, spec) }
possibilities.find {|p| File.exist?(p) }
end
def package_path(cache_path, spec)
"#{cache_path}/#{spec.file_name}"
end
def normalize_uri(uri)
uri = URINormalizer.normalize_suffix(uri.to_s)
require_relative "../vendored_uri"
uri = Gem::URI(uri)
raise ArgumentError, "The source must be an absolute URI. For example:\n" \
"source 'https://rubygems.org'" if !uri.absolute? || (uri.is_a?(Gem::URI::HTTP) && uri.host.nil?)
uri
end
def remove_auth(remote)
if remote.user || remote.password
remote.dup.tap {|uri| uri.user = uri.password = nil }.to_s
else
remote.to_s
end
end
def installed_specs
@installed_specs ||= Index.build do |idx|
Bundler.rubygems.installed_specs.reverse_each do |spec|
spec.source = self
next if spec.ignored?
idx << spec
end
end
end
def default_specs
@default_specs ||= Index.build do |idx|
Bundler.rubygems.default_specs.each do |spec|
spec.source = self
idx << spec
end
end
end
def cached_specs
@cached_specs ||= begin
idx = Index.new
Dir["#{cache_path}/*.gem"].each do |gemfile|
s ||= Bundler.rubygems.spec_from_gem(gemfile)
s.source = self
idx << s
end
idx
end
end
def api_fetchers
fetchers.select(&:api_fetcher?)
end
def remote_specs
@remote_specs ||= Index.build do |idx|
index_fetchers = fetchers - api_fetchers
if index_fetchers.empty?
fetch_names(api_fetchers, dependency_names, idx)
else
fetch_names(fetchers, nil, idx)
end
end
end
def fetch_names(fetchers, dependency_names, index)
fetchers.each do |f|
if dependency_names
Bundler.ui.info "Fetching gem metadata from #{URICredentialsFilter.credential_filtered_uri(f.uri)}", Bundler.ui.debug?
index.use f.specs_with_retry(dependency_names, self)
Bundler.ui.info "" unless Bundler.ui.debug? # new line now that the dots are over
else
Bundler.ui.info "Fetching source index from #{URICredentialsFilter.credential_filtered_uri(f.uri)}"
index.use f.specs_with_retry(nil, self)
end
end
end
def fetch_gem_if_possible(spec, previous_spec = nil)
if spec.remote
fetch_gem(spec, previous_spec)
else
cached_gem(spec)
end
end
def fetch_gem(spec, previous_spec = nil)
spec.fetch_platform
cache_path = download_cache_path(spec) || default_cache_path_for(rubygems_dir)
gem_path = package_path(cache_path, spec)
return gem_path if File.exist?(gem_path)
SharedHelpers.filesystem_access(cache_path) do |p|
FileUtils.mkdir_p(p)
end
download_gem(spec, cache_path, previous_spec)
gem_path
end
def installed?(spec)
installed_specs[spec].any? && !spec.deleted_gem?
end
def rubygems_dir
Bundler.bundle_path
end
def default_cache_path_for(dir)
"#{dir}/cache"
end
def cache_path
Bundler.app_cache
end
private
def lockfile_remotes
@lockfile_remotes || credless_remotes
end
# Checks if the requested spec exists in the global cache. If it does,
# we copy it to the download path, and if it does not, we download it.
#
# @param [Specification] spec
# the spec we want to download or retrieve from the cache.
#
# @param [String] download_cache_path
# the local directory the .gem will end up in.
#
# @param [Specification] previous_spec
# the spec previously locked
#
def download_gem(spec, download_cache_path, previous_spec = nil)
uri = spec.remote.uri
Bundler.ui.confirm("Fetching #{version_message(spec, previous_spec)}")
gem_remote_fetcher = remote_fetchers.fetch(spec.remote).gem_remote_fetcher
Bundler.rubygems.download_gem(spec, uri, download_cache_path, gem_remote_fetcher)
end
# Returns the global cache path of the calling Rubygems::Source object.
#
# Note that the Source determines the path's subdirectory. We use this
# subdirectory in the global cache path so that gems with the same name
# -- and possibly different versions -- from different sources are saved
# to their respective subdirectories and do not override one another.
#
# @param [Gem::Specification] specification
#
# @return [Pathname] The global cache path.
#
def download_cache_path(spec)
return unless Bundler.feature_flag.global_gem_cache?
return unless remote = spec.remote
return unless cache_slug = remote.cache_slug
Bundler.user_cache.join("gems", cache_slug)
end
def extension_cache_slug(spec)
return unless remote = spec.remote
remote.cache_slug
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/path.rb 0000644 00000017245 15173517744 0016724 0 ustar 00 # frozen_string_literal: true
module Bundler
class Source
class Path < Source
autoload :Installer, File.expand_path("path/installer", __dir__)
attr_reader :path, :options, :root_path, :original_path
attr_writer :name
attr_accessor :version
protected :original_path
DEFAULT_GLOB = "{,*,*/*}.gemspec"
def initialize(options)
@checksum_store = Checksum::Store.new
@options = options.dup
@glob = options["glob"] || DEFAULT_GLOB
@root_path = options["root_path"] || root
if options["path"]
@path = Pathname.new(options["path"])
expanded_path = expand(@path)
@path = if @path.relative?
expanded_path.relative_path_from(root_path.expand_path)
else
expanded_path
end
end
@name = options["name"]
@version = options["version"]
# Stores the original path. If at any point we move to the
# cached directory, we still have the original path to copy from.
@original_path = @path
end
def self.from_lock(options)
new(options.merge("path" => options.delete("remote")))
end
def to_lock
out = String.new("PATH\n")
out << " remote: #{lockfile_path}\n"
out << " glob: #{@glob}\n" unless @glob == DEFAULT_GLOB
out << " specs:\n"
end
def to_s
"source at `#{@path}`"
end
alias_method :to_gemfile, :path
def hash
[self.class, expanded_path, version].hash
end
def eql?(other)
return unless other.class == self.class
expanded_original_path == other.expanded_original_path &&
version == other.version
end
alias_method :==, :eql?
def name
File.basename(expanded_path.to_s)
end
def install(spec, options = {})
using_message = "Using #{version_message(spec, options[:previous_spec])} from #{self}"
using_message += " and installing its executables" unless spec.executables.empty?
print_using_message using_message
generate_bin(spec, disable_extensions: true)
nil # no post-install message
end
def cache(spec, custom_path = nil)
app_cache_path = app_cache_path(custom_path)
return unless Bundler.feature_flag.cache_all?
return if expand(@original_path).to_s.index(root_path.to_s + "/") == 0
unless @original_path.exist?
raise GemNotFound, "Can't cache gem #{version_message(spec)} because #{self} is missing!"
end
FileUtils.rm_rf(app_cache_path)
FileUtils.cp_r("#{@original_path}/.", app_cache_path)
FileUtils.touch(app_cache_path.join(".bundlecache"))
end
def local_specs(*)
@local_specs ||= load_spec_files
end
def specs
if has_app_cache?
@path = app_cache_path
@expanded_path = nil # Invalidate
end
local_specs
end
def app_cache_dirname
name
end
def root
Bundler.root
end
def expanded_original_path
@expanded_original_path ||= expand(original_path)
end
private
def expanded_path
@expanded_path ||= expand(path)
end
def expand(somepath)
if Bundler.current_ruby.jruby? # TODO: Unify when https://github.com/rubygems/bundler/issues/7598 fixed upstream and all supported jrubies include the fix
somepath.expand_path(root_path).expand_path
else
somepath.expand_path(root_path)
end
rescue ArgumentError => e
Bundler.ui.debug(e)
raise PathError, "There was an error while trying to use the path " \
"`#{somepath}`.\nThe error message was: #{e.message}."
end
def lockfile_path
return relative_path(original_path) if original_path.absolute?
expand(original_path).relative_path_from(root)
end
def app_cache_path(custom_path = nil)
@app_cache_path ||= Bundler.app_cache(custom_path).join(app_cache_dirname)
end
def has_app_cache?
SharedHelpers.in_bundle? && app_cache_path.exist?
end
def load_gemspec(file)
return unless spec = Bundler.load_gemspec(file)
spec.installed_by_version = Gem::VERSION
spec
end
def validate_spec(spec)
Bundler.rubygems.validate(spec)
end
def load_spec_files
index = Index.new
if File.directory?(expanded_path)
# We sort depth-first since `<<` will override the earlier-found specs
Gem::Util.glob_files_in_dir(@glob, expanded_path).sort_by {|p| -p.split(File::SEPARATOR).size }.each do |file|
next unless spec = load_gemspec(file)
spec.source = self
# Validation causes extension_dir to be calculated, which depends
# on #source, so we validate here instead of load_gemspec
validate_spec(spec)
index << spec
end
if index.empty? && @name && @version
index << Gem::Specification.new do |s|
s.name = @name
s.source = self
s.version = Gem::Version.new(@version)
s.platform = Gem::Platform::RUBY
s.summary = "Fake gemspec for #{@name}"
s.relative_loaded_from = "#{@name}.gemspec"
s.authors = ["no one"]
if expanded_path.join("bin").exist?
executables = expanded_path.join("bin").children
executables.reject! {|p| File.directory?(p) }
s.executables = executables.map {|c| c.basename.to_s }
end
end
end
else
message = String.new("The path `#{expanded_path}` ")
message << if File.exist?(expanded_path)
"is not a directory."
else
"does not exist."
end
raise PathError, message
end
index
end
def relative_path(path = self.path)
if path.to_s.start_with?(root_path.to_s)
return path.relative_path_from(root_path)
end
path
end
def generate_bin(spec, options = {})
gem_dir = Pathname.new(spec.full_gem_path)
# Some gem authors put absolute paths in their gemspec
# and we have to save them from themselves
spec.files = spec.files.map do |path|
next path unless /\A#{Pathname::SEPARATOR_PAT}/o.match?(path)
next if File.directory?(path)
begin
Pathname.new(path).relative_path_from(gem_dir).to_s
rescue ArgumentError
path
end
end.compact
installer = Path::Installer.new(
spec,
env_shebang: false,
disable_extensions: options[:disable_extensions],
build_args: options[:build_args],
bundler_extension_cache_path: extension_cache_path(spec)
)
installer.post_install
rescue Gem::InvalidSpecificationException => e
Bundler.ui.warn "\n#{spec.name} at #{spec.full_gem_path} did not have a valid gemspec.\n" \
"This prevents bundler from installing bins or native extensions, but " \
"that may not affect its functionality."
if !spec.extensions.empty? && !spec.email.empty?
Bundler.ui.warn "If you need to use this package without installing it from a gem " \
"repository, please contact #{spec.email} and ask them " \
"to modify their .gemspec so it can work with `gem build`."
end
Bundler.ui.warn "The validation message from RubyGems was:\n #{e.message}"
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/rubygems_aggregate.rb 0000644 00000004134 15173517744 0021624 0 ustar 00 # frozen_string_literal: true
module Bundler
class Source
class RubygemsAggregate
attr_reader :source_map, :sources
def initialize(sources, source_map)
@sources = sources
@source_map = source_map
@index = build_index
end
def specs
@index
end
def identifier
to_s
end
def to_s
"any of the sources"
end
private
def build_index
Index.build do |idx|
dependency_names = source_map.pinned_spec_names
sources.all_sources.each do |source|
source.dependency_names = dependency_names - source_map.pinned_spec_names(source)
idx.add_source source.specs
dependency_names.concat(source.unmet_deps).uniq!
end
double_check_for_index(idx, dependency_names)
end
end
# Suppose the gem Foo depends on the gem Bar. Foo exists in Source A. Bar has some versions that exist in both
# sources A and B. At this point, the API request will have found all the versions of Bar in source A,
# but will not have found any versions of Bar from source B, which is a problem if the requested version
# of Foo specifically depends on a version of Bar that is only found in source B. This ensures that for
# each spec we found, we add all possible versions from all sources to the index.
def double_check_for_index(idx, dependency_names)
pinned_names = source_map.pinned_spec_names
names = :names # do this so we only have to traverse to get dependency_names from the index once
unmet_dependency_names = lambda do
return names unless names == :names
new_names = sources.all_sources.map(&:dependency_names_to_double_check)
return names = nil if new_names.compact!
names = new_names.flatten(1).concat(dependency_names)
names.uniq!
names -= pinned_names
names
end
sources.all_sources.each do |source|
source.double_check_for(unmet_dependency_names)
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/path/installer.rb 0000644 00000003054 15173517744 0020712 0 ustar 00 # frozen_string_literal: true
require_relative "../../rubygems_gem_installer"
module Bundler
class Source
class Path
class Installer < Bundler::RubyGemsGemInstaller
attr_reader :spec
def initialize(spec, options = {})
@options = options
@spec = spec
@gem_dir = Bundler.rubygems.path(spec.full_gem_path)
@wrappers = true
@env_shebang = true
@format_executable = options[:format_executable] || false
@build_args = options[:build_args] || Bundler.rubygems.build_args
@gem_bin_dir = "#{Bundler.rubygems.gem_dir}/bin"
@disable_extensions = options[:disable_extensions]
@bin_dir = @gem_bin_dir
end
def post_install
run_hooks(:pre_install)
unless @disable_extensions
build_extensions
run_hooks(:post_build)
end
generate_bin unless spec.executables.empty?
run_hooks(:post_install)
end
private
def run_hooks(type)
hooks_meth = "#{type}_hooks"
return unless Gem.respond_to?(hooks_meth)
Gem.send(hooks_meth).each do |hook|
result = hook.call(self)
next unless result == false
location = " at #{$1}" if hook.inspect =~ /@(.*:\d+)/
message = "#{type} hook#{location} failed for #{spec.full_name}"
raise InstallHookError, message
end
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source/rubygems/remote.rb 0000644 00000003443 15173517744 0021113 0 ustar 00 # frozen_string_literal: true
module Bundler
class Source
class Rubygems
class Remote
attr_reader :uri, :anonymized_uri, :original_uri
def initialize(uri)
orig_uri = uri
uri = Bundler.settings.mirror_for(uri)
@original_uri = orig_uri if orig_uri != uri
fallback_auth = Bundler.settings.credentials_for(uri)
@uri = apply_auth(uri, fallback_auth).freeze
@anonymized_uri = remove_auth(@uri).freeze
end
# @return [String] A slug suitable for use as a cache key for this
# remote.
#
def cache_slug
@cache_slug ||= begin
return nil unless SharedHelpers.md5_available?
cache_uri = original_uri || uri
host = cache_uri.to_s.start_with?("file://") ? nil : cache_uri.host
uri_parts = [host, cache_uri.user, cache_uri.port, cache_uri.path]
uri_digest = SharedHelpers.digest(:MD5).hexdigest(uri_parts.compact.join("."))
uri_parts[-1] = uri_digest
uri_parts.compact.join(".")
end
end
def to_s
"rubygems remote at #{anonymized_uri}"
end
private
def apply_auth(uri, auth)
if auth && uri.userinfo.nil?
uri = uri.dup
uri.userinfo = auth
end
uri
rescue Gem::URI::InvalidComponentError
error_message = "Please CGI escape your usernames and passwords before " \
"setting them for authentication."
raise HTTPError.new(error_message)
end
def remove_auth(uri)
if uri.userinfo
uri = uri.dup
uri.user = uri.password = nil
end
uri
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/environment_preserver.rb 0000644 00000002660 15173517744 0021124 0 ustar 00 # frozen_string_literal: true
module Bundler
class EnvironmentPreserver
INTENTIONALLY_NIL = "BUNDLER_ENVIRONMENT_PRESERVER_INTENTIONALLY_NIL"
BUNDLER_KEYS = %w[
BUNDLE_BIN_PATH
BUNDLE_GEMFILE
BUNDLER_VERSION
BUNDLER_SETUP
GEM_HOME
GEM_PATH
MANPATH
PATH
RB_USER_INSTALL
RUBYLIB
RUBYOPT
].map(&:freeze).freeze
BUNDLER_PREFIX = "BUNDLER_ORIG_"
def self.from_env
new(ENV.to_hash, BUNDLER_KEYS)
end
# @param env [Hash]
# @param keys [Array<String>]
def initialize(env, keys)
@original = env
@keys = keys
@prefix = BUNDLER_PREFIX
end
# Replaces `ENV` with the bundler environment variables backed up
def replace_with_backup
ENV.replace(backup)
end
# @return [Hash]
def backup
env = @original.clone
@keys.each do |key|
value = env[key]
if !value.nil?
env[@prefix + key] ||= value
else
env[@prefix + key] ||= INTENTIONALLY_NIL
end
end
env
end
# @return [Hash]
def restore
env = @original.clone
@keys.each do |key|
value_original = env[@prefix + key]
next if value_original.nil?
if value_original == INTENTIONALLY_NIL
env.delete(key)
else
env[key] = value_original
end
env.delete(@prefix + key)
end
env
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/digest.rb 0000644 00000004242 15173517744 0015740 0 ustar 00 # frozen_string_literal: true
# This code was extracted from https://github.com/Solistra/ruby-digest which is under public domain
module Bundler
module Digest
# The initial constant values for the 32-bit constant words A, B, C, D, and
# E, respectively.
SHA1_WORDS = [0x67452301, 0xEFCDAB89, 0x98BADCFE, 0x10325476, 0xC3D2E1F0].freeze
# The 8-bit field used for bitwise `AND` masking. Defaults to `0xFFFFFFFF`.
SHA1_MASK = 0xFFFFFFFF
class << self
def sha1(string)
unless string.is_a?(String)
raise TypeError, "can't convert #{string.class.inspect} into String"
end
buffer = string.b
words = SHA1_WORDS.dup
generate_split_buffer(buffer) do |chunk|
w = []
chunk.each_slice(4) do |a, b, c, d|
w << (((a << 8 | b) << 8 | c) << 8 | d)
end
a, b, c, d, e = *words
(16..79).each do |i|
w[i] = SHA1_MASK & rotate((w[i - 3] ^ w[i - 8] ^ w[i - 14] ^ w[i - 16]), 1)
end
0.upto(79) do |i|
case i
when 0..19
f = ((b & c) | (~b & d))
k = 0x5A827999
when 20..39
f = (b ^ c ^ d)
k = 0x6ED9EBA1
when 40..59
f = ((b & c) | (b & d) | (c & d))
k = 0x8F1BBCDC
when 60..79
f = (b ^ c ^ d)
k = 0xCA62C1D6
end
t = SHA1_MASK & rotate(a, 5) + f + e + k + w[i]
a, b, c, d, e = t, a, SHA1_MASK & rotate(b, 30), c, d # rubocop:disable Style/ParallelAssignment
end
mutated = [a, b, c, d, e]
words.map!.with_index {|word, index| SHA1_MASK & (word + mutated[index]) }
end
words.pack("N*").unpack1("H*")
end
private
def generate_split_buffer(string, &block)
size = string.bytesize * 8
buffer = string.bytes << 128
buffer << 0 while buffer.size % 64 != 56
buffer.concat([size].pack("Q>").bytes)
buffer.each_slice(64, &block)
end
def rotate(value, spaces)
value << spaces | value >> (32 - spaces)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/version.rb 0000644 00000000404 15173517744 0016142 0 ustar 00 # frozen_string_literal: false
module Bundler
VERSION = "2.5.22".freeze
def self.bundler_major_version
@bundler_major_version ||= VERSION.split(".").first.to_i
end
def self.gem_version
@gem_version ||= Gem::Version.create(VERSION)
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/gem_tasks.rb 0000644 00000000212 15173517744 0016427 0 ustar 00 # frozen_string_literal: true
require "rake/clean"
CLOBBER.include "pkg"
require_relative "gem_helper"
Bundler::GemHelper.install_tasks
share/gems/gems/bundler-2.5.22/lib/bundler/spec_set.rb 0000644 00000015677 15173517744 0016304 0 ustar 00 # frozen_string_literal: true
require_relative "vendored_tsort"
module Bundler
class SpecSet
include Enumerable
include TSort
attr_reader :incomplete_specs
def initialize(specs, incomplete_specs = [])
@specs = specs
@incomplete_specs = incomplete_specs
end
def for(dependencies, check = false, platforms = [nil])
handled = ["bundler"].product(platforms).map {|k| [k, true] }.to_h
deps = dependencies.product(platforms)
specs = []
loop do
break unless dep = deps.shift
name = dep[0].name
platform = dep[1]
incomplete = false
key = [name, platform]
next if handled.key?(key)
handled[key] = true
specs_for_dep = specs_for_dependency(*dep)
if specs_for_dep.any?
specs.concat(specs_for_dep)
specs_for_dep.first.dependencies.each do |d|
next if d.type == :development
incomplete = true if d.name != "bundler" && lookup[d.name].nil?
deps << [d, dep[1]]
end
else
incomplete = true
end
if incomplete && check
@incomplete_specs += lookup[name] || [LazySpecification.new(name, nil, nil)]
end
end
specs.uniq
end
def add_extra_platforms!(platforms)
return platforms.concat([Gem::Platform::RUBY]).uniq if @specs.empty?
new_platforms = all_platforms.select do |platform|
next if platforms.include?(platform)
next unless GemHelpers.generic(platform) == Gem::Platform::RUBY
complete_platform(platform)
end
return platforms if new_platforms.empty?
platforms.concat(new_platforms)
less_specific_platform = new_platforms.find {|platform| platform != Gem::Platform::RUBY && Bundler.local_platform === platform && platform === Bundler.local_platform }
platforms.delete(Bundler.local_platform) if less_specific_platform
platforms
end
def validate_deps(s)
s.runtime_dependencies.each do |dep|
next if dep.name == "bundler"
return :missing unless names.include?(dep.name)
return :invalid if none? {|spec| dep.matches_spec?(spec) }
end
:valid
end
def [](key)
key = key.name if key.respond_to?(:name)
lookup[key]&.reverse || []
end
def []=(key, value)
@specs << value
reset!
end
def delete(specs)
Array(specs).each {|spec| @specs.delete(spec) }
reset!
end
def sort!
self
end
def to_a
sorted.dup
end
def to_hash
lookup.dup
end
def materialize(deps)
materialized = self.for(deps, true)
SpecSet.new(materialized, incomplete_specs)
end
# Materialize for all the specs in the spec set, regardless of what platform they're for
# This is in contrast to how for does platform filtering (and specifically different from how `materialize` calls `for` only for the current platform)
# @return [Array<Gem::Specification>]
def materialized_for_all_platforms
@specs.map do |s|
next s unless s.is_a?(LazySpecification)
s.source.remote!
spec = s.materialize_for_installation
raise GemNotFound, "Could not find #{s.full_name} in any of the sources" unless spec
spec
end
end
def incomplete_for_platform?(deps, platform)
return false if @specs.empty?
@incomplete_specs = []
self.for(deps, true, [platform])
@incomplete_specs.any?
end
def missing_specs
@specs.select {|s| s.is_a?(LazySpecification) }
end
def -(other)
SpecSet.new(to_a - other.to_a)
end
def find_by_name_and_platform(name, platform)
@specs.detect {|spec| spec.name == name && spec.match_platform(platform) }
end
def specs_compatible_with(other)
select do |spec|
other.valid?(spec)
end
end
def delete_by_name(name)
@specs.reject! {|spec| spec.name == name }
reset!
end
def what_required(spec)
unless req = find {|s| s.runtime_dependencies.any? {|d| d.name == spec.name } }
return [spec]
end
what_required(req) << spec
end
def <<(spec)
@specs << spec
end
def length
@specs.length
end
def size
@specs.size
end
def empty?
@specs.empty?
end
def each(&b)
sorted.each(&b)
end
def names
lookup.keys
end
def valid?(s)
s.matches_current_metadata? && valid_dependencies?(s)
end
private
def reset!
@sorted = nil
@lookup = nil
end
def complete_platform(platform)
new_specs = []
valid_platform = lookup.all? do |_, specs|
spec = specs.first
matching_specs = spec.source.specs.search([spec.name, spec.version])
platform_spec = GemHelpers.select_best_platform_match(matching_specs, platform).find do |s|
valid?(s)
end
if platform_spec
new_specs << LazySpecification.from_spec(platform_spec) unless specs.include?(platform_spec)
true
else
false
end
end
if valid_platform && new_specs.any?
@specs.concat(new_specs)
reset!
end
valid_platform
end
def all_platforms
@specs.flat_map {|spec| spec.source.specs.search([spec.name, spec.version]).map(&:platform) }.uniq
end
def valid_dependencies?(s)
validate_deps(s) == :valid
end
def sorted
rake = @specs.find {|s| s.name == "rake" }
begin
@sorted ||= ([rake] + tsort).compact.uniq
rescue TSort::Cyclic => error
cgems = extract_circular_gems(error)
raise CyclicDependencyError, "Your bundle requires gems that depend" \
" on each other, creating an infinite loop. Please remove either" \
" gem '#{cgems[0]}' or gem '#{cgems[1]}' and try again."
end
end
def extract_circular_gems(error)
error.message.scan(/@name="(.*?)"/).flatten
end
def lookup
@lookup ||= begin
lookup = {}
@specs.each do |s|
lookup[s.name] ||= []
lookup[s.name] << s
end
lookup
end
end
def tsort_each_node
# MUST sort by name for backwards compatibility
@specs.sort_by(&:name).each {|s| yield s }
end
def specs_for_dependency(dep, platform)
specs_for_name = lookup[dep.name]
return [] unless specs_for_name
if platform
GemHelpers.select_best_platform_match(specs_for_name, platform, force_ruby: dep.force_ruby_platform)
else
GemHelpers.select_best_local_platform_match(specs_for_name, force_ruby: dep.force_ruby_platform || dep.default_force_ruby_platform)
end
end
def tsort_each_child(s)
s.dependencies.sort_by(&:name).each do |d|
next if d.type == :development
specs_for_name = lookup[d.name]
next unless specs_for_name
specs_for_name.each {|s2| yield s2 }
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_thor.rb 0000644 00000000264 15173517744 0017323 0 ustar 00 # frozen_string_literal: true
module Bundler
def self.require_thor_actions
require_relative "vendor/thor/lib/thor/actions"
end
end
require_relative "vendor/thor/lib/thor"
share/gems/gems/bundler-2.5.22/lib/bundler/retry.rb 0000644 00000003140 15173517744 0015622 0 ustar 00 # frozen_string_literal: true
module Bundler
# General purpose class for retrying code that may fail
class Retry
attr_accessor :name, :total_runs, :current_run
class << self
def default_attempts
default_retries + 1
end
alias_method :attempts, :default_attempts
def default_retries
Bundler.settings[:retry]
end
end
def initialize(name, exceptions = nil, retries = self.class.default_retries)
@name = name
@retries = retries
@exceptions = Array(exceptions) || []
@total_runs = @retries + 1 # will run once, then upto attempts.times
end
def attempt(&block)
@current_run = 0
@failed = false
@error = nil
run(&block) while keep_trying?
@result
end
alias_method :attempts, :attempt
private
def run(&block)
@failed = false
@current_run += 1
@result = block.call
rescue StandardError => e
fail_attempt(e)
end
def fail_attempt(e)
@failed = true
if last_attempt? || @exceptions.any? {|k| e.is_a?(k) }
Bundler.ui.info "" unless Bundler.ui.debug?
raise e
end
return true unless name
Bundler.ui.info "" unless Bundler.ui.debug? # Add new line in case dots preceded this
Bundler.ui.warn "Retrying #{name} due to error (#{current_run.next}/#{total_runs}): #{e.class} #{e.message}", true
end
def keep_trying?
return true if current_run.zero?
return false if last_attempt?
true if @failed
end
def last_attempt?
current_run >= total_runs
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/build_metadata.rb 0000644 00000002337 15173517744 0017423 0 ustar 00 # frozen_string_literal: true
module Bundler
# Represents metadata from when the Bundler gem was built.
module BuildMetadata
# begin ivars
@release = false
# end ivars
# A hash representation of the build metadata.
def self.to_h
{
"Built At" => built_at,
"Git SHA" => git_commit_sha,
"Released Version" => release?,
}
end
# A string representing the date the bundler gem was built.
def self.built_at
@built_at ||= Time.now.utc.strftime("%Y-%m-%d").freeze
end
# The SHA for the git commit the bundler gem was built from.
def self.git_commit_sha
return @git_commit_sha if instance_variable_defined? :@git_commit_sha
# If Bundler has been installed without its .git directory and without a
# commit instance variable then we can't determine its commits SHA.
git_dir = File.expand_path("../../../.git", __dir__)
if File.directory?(git_dir)
return @git_commit_sha = IO.popen(%w[git rev-parse --short HEAD], { chdir: git_dir }, &:read).strip.freeze
end
@git_commit_sha ||= "unknown"
end
# Whether this is an official release build of Bundler.
def self.release?
@release
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/capistrano.rb 0000644 00000001555 15173517744 0016630 0 ustar 00 # frozen_string_literal: true
require_relative "shared_helpers"
Bundler::SharedHelpers.major_deprecation 2,
"The Bundler task for Capistrano. Please use https://github.com/capistrano/bundler"
# Capistrano task for Bundler.
#
# Add "require 'bundler/capistrano'" in your Capistrano deploy.rb, and
# Bundler will be activated after each new deployment.
require_relative "deployment"
require "capistrano/version"
if defined?(Capistrano::Version) && Gem::Version.new(Capistrano::Version).release >= Gem::Version.new("3.0")
raise "For Capistrano 3.x integration, please use https://github.com/capistrano/bundler"
end
Capistrano::Configuration.instance(:must_exist).load do
before "deploy:finalize_update", "bundle:install"
Bundler::Deployment.define_task(self, :task, except: { no_release: true })
set :rake, lambda { "#{fetch(:bundle_cmd, "bundle")} exec rake" }
end
share/gems/gems/bundler-2.5.22/lib/bundler/gem_helper.rb 0000644 00000015610 15173517744 0016571 0 ustar 00 # frozen_string_literal: true
require_relative "../bundler"
require "shellwords"
module Bundler
class GemHelper
include Rake::DSL if defined? Rake::DSL
class << self
# set when install'd.
attr_accessor :instance
def install_tasks(opts = {})
new(opts[:dir], opts[:name]).install
end
def tag_prefix=(prefix)
instance.tag_prefix = prefix
end
def gemspec(&block)
gemspec = instance.gemspec
block&.call(gemspec)
gemspec
end
end
attr_reader :spec_path, :base, :gemspec
attr_writer :tag_prefix
def initialize(base = nil, name = nil)
@base = File.expand_path(base || SharedHelpers.pwd)
gemspecs = name ? [File.join(@base, "#{name}.gemspec")] : Gem::Util.glob_files_in_dir("{,*}.gemspec", @base)
raise "Unable to determine name from existing gemspec. Use :name => 'gemname' in #install_tasks to manually set it." unless gemspecs.size == 1
@spec_path = gemspecs.first
@gemspec = Bundler.load_gemspec(@spec_path)
@tag_prefix = ""
end
def install
built_gem_path = nil
desc "Build #{name}-#{version}.gem into the pkg directory."
task "build" do
built_gem_path = build_gem
end
desc "Generate SHA512 checksum of #{name}-#{version}.gem into the checksums directory."
task "build:checksum" => "build" do
build_checksum(built_gem_path)
end
desc "Build and install #{name}-#{version}.gem into system gems."
task "install" => "build" do
install_gem(built_gem_path)
end
desc "Build and install #{name}-#{version}.gem into system gems without network access."
task "install:local" => "build" do
install_gem(built_gem_path, :local)
end
desc "Create tag #{version_tag} and build and push #{name}-#{version}.gem to #{gem_push_host}\n" \
"To prevent publishing in RubyGems use `gem_push=no rake release`"
task "release", [:remote] => ["build", "release:guard_clean",
"release:source_control_push", "release:rubygem_push"] do
end
task "release:guard_clean" do
guard_clean
end
task "release:source_control_push", [:remote] do |_, args|
tag_version { git_push(args[:remote]) } unless already_tagged?
end
task "release:rubygem_push" => "build" do
rubygem_push(built_gem_path) if gem_push?
end
GemHelper.instance = self
end
def build_gem
file_name = nil
sh([*gem_command, "build", "-V", spec_path]) do
file_name = File.basename(built_gem_path)
SharedHelpers.filesystem_access(File.join(base, "pkg")) {|p| FileUtils.mkdir_p(p) }
FileUtils.mv(built_gem_path, "pkg")
Bundler.ui.confirm "#{name} #{version} built to pkg/#{file_name}."
end
File.join(base, "pkg", file_name)
end
def install_gem(built_gem_path = nil, local = false)
built_gem_path ||= build_gem
cmd = [*gem_command, "install", built_gem_path.to_s]
cmd << "--local" if local
sh(cmd)
Bundler.ui.confirm "#{name} (#{version}) installed."
end
def build_checksum(built_gem_path = nil)
built_gem_path ||= build_gem
SharedHelpers.filesystem_access(File.join(base, "checksums")) {|p| FileUtils.mkdir_p(p) }
file_name = "#{File.basename(built_gem_path)}.sha512"
require "digest/sha2"
checksum = ::Digest::SHA512.file(built_gem_path).hexdigest
target = File.join(base, "checksums", file_name)
File.write(target, checksum + "\n")
Bundler.ui.confirm "#{name} #{version} checksum written to checksums/#{file_name}."
end
protected
def rubygem_push(path)
cmd = [*gem_command, "push", path]
cmd << "--key" << gem_key if gem_key
cmd << "--host" << allowed_push_host if allowed_push_host
sh_with_input(cmd)
Bundler.ui.confirm "Pushed #{name} #{version} to #{gem_push_host}"
end
def built_gem_path
Gem::Util.glob_files_in_dir("#{name}-*.gem", base).sort_by {|f| File.mtime(f) }.last
end
def git_push(remote = nil)
remote ||= default_remote
sh("git push #{remote} refs/heads/#{current_branch}".shellsplit)
sh("git push #{remote} refs/tags/#{version_tag}".shellsplit)
Bundler.ui.confirm "Pushed git commits and release tag."
end
def default_remote
remote_for_branch, status = sh_with_status(%W[git config --get branch.#{current_branch}.remote])
return "origin" unless status.success?
remote_for_branch.strip
end
def current_branch
# We can replace this with `git branch --show-current` once we drop support for git < 2.22.0
sh(%w[git rev-parse --abbrev-ref HEAD]).gsub(%r{\Aheads/}, "").strip
end
def allowed_push_host
@gemspec.metadata["allowed_push_host"] if @gemspec.respond_to?(:metadata)
end
def gem_push_host
env_rubygems_host = ENV["RUBYGEMS_HOST"]
env_rubygems_host = nil if env_rubygems_host&.empty?
allowed_push_host || env_rubygems_host || "rubygems.org"
end
def already_tagged?
return false unless sh(%w[git tag]).split(/\n/).include?(version_tag)
Bundler.ui.confirm "Tag #{version_tag} has already been created."
true
end
def guard_clean
clean? && committed? || raise("There are files that need to be committed first.")
end
def clean?
sh_with_status(%w[git diff --exit-code])[1].success?
end
def committed?
sh_with_status(%w[git diff-index --quiet --cached HEAD])[1].success?
end
def tag_version
sh %W[git tag -m Version\ #{version} #{version_tag}]
Bundler.ui.confirm "Tagged #{version_tag}."
yield if block_given?
rescue RuntimeError
Bundler.ui.error "Untagging #{version_tag} due to error."
sh_with_status %W[git tag -d #{version_tag}]
raise
end
def version
gemspec.version
end
def version_tag
"#{@tag_prefix}v#{version}"
end
def name
gemspec.name
end
def sh_with_input(cmd)
Bundler.ui.debug(cmd)
SharedHelpers.chdir(base) do
abort unless Kernel.system(*cmd)
end
end
def sh(cmd, &block)
out, status = sh_with_status(cmd, &block)
unless status.success?
raise("Running `#{cmd.shelljoin}` failed with the following output:\n\n#{out}\n")
end
out
end
def sh_with_status(cmd, &block)
Bundler.ui.debug(cmd)
SharedHelpers.chdir(base) do
outbuf = IO.popen(cmd, err: [:child, :out], &:read)
status = $?
block&.call(outbuf) if status.success?
[outbuf, status]
end
end
def gem_key
Bundler.settings["gem.push_key"].to_s.downcase if Bundler.settings["gem.push_key"]
end
def gem_push?
!%w[n no nil false off 0].include?(ENV["gem_push"].to_s.downcase)
end
def gem_command
ENV["GEM_COMMAND"]&.shellsplit || ["gem"]
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/cache.rb 0000644 00000002146 15173517744 0016274 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Cache
attr_reader :options
def initialize(options)
@options = options
end
def run
Bundler.ui.level = "warn" if options[:quiet]
Bundler.settings.set_command_option_if_given :path, options[:path]
Bundler.settings.set_command_option_if_given :cache_path, options["cache-path"]
setup_cache_all
install
# TODO: move cache contents here now that all bundles are locked
custom_path = Bundler.settings[:path] if options[:path]
Bundler.settings.temporary(cache_all_platforms: options["all-platforms"]) do
Bundler.load.cache(custom_path)
end
end
private
def install
require_relative "install"
options = self.options.dup
options["local"] = false if Bundler.settings[:cache_all_platforms]
options["no-cache"] = true
Bundler::CLI::Install.new(options).run
end
def setup_cache_all
all = options.fetch(:all, Bundler.feature_flag.cache_all? || nil)
Bundler.settings.set_command_option_if_given :cache_all, all
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/platform.rb 0000644 00000002422 15173517744 0017052 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Platform
attr_reader :options
def initialize(options)
@options = options
end
def run
ruby_version = if Bundler.locked_gems
Bundler.locked_gems.ruby_version&.gsub(/p\d+\Z/, "")
else
Bundler.definition.ruby_version&.single_version_string
end
output = []
if options[:ruby]
if ruby_version
output << ruby_version
else
output << "No ruby version specified"
end
else
platforms = Bundler.definition.platforms.map {|p| "* #{p}" }
output << "Your platform is: #{Gem::Platform.local}"
output << "Your app has gems that work on these platforms:\n#{platforms.join("\n")}"
if ruby_version
output << "Your Gemfile specifies a Ruby version requirement:\n* #{ruby_version}"
begin
Bundler.definition.validate_runtime!
output << "Your current platform satisfies the Ruby version requirement."
rescue RubyVersionMismatch => e
output << e.message
end
else
output << "Your Gemfile does not specify a Ruby version requirement."
end
end
Bundler.ui.info output.join("\n\n")
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/add.rb 0000644 00000002724 15173517744 0015763 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Add
attr_reader :gems, :options, :version
def initialize(options, gems)
@gems = gems
@options = options
@options[:group] = options[:group].split(",").map(&:strip) unless options[:group].nil?
@version = options[:version].split(",").map(&:strip) unless options[:version].nil?
end
def run
validate_options!
inject_dependencies
perform_bundle_install unless options["skip-install"]
end
private
def perform_bundle_install
Installer.install(Bundler.root, Bundler.definition)
Bundler.load.cache if Bundler.app_cache.exist?
end
def inject_dependencies
dependencies = gems.map {|g| Bundler::Dependency.new(g, version, options) }
Injector.inject(dependencies,
conservative_versioning: options[:version].nil?, # Perform conservative versioning only when version is not specified
optimistic: options[:optimistic],
strict: options[:strict])
end
def validate_options!
raise InvalidOption, "You cannot specify `--strict` and `--optimistic` at the same time." if options[:strict] && options[:optimistic]
# raise error when no gems are specified
raise InvalidOption, "Please specify gems to add." if gems.empty?
version.to_a.each do |v|
raise InvalidOption, "Invalid gem requirement pattern '#{v}'" unless Gem::Requirement::PATTERN.match?(v.to_s)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/pristine.rb 0000644 00000004043 15173517744 0017064 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Pristine
def initialize(gems)
@gems = gems
end
def run
CLI::Common.ensure_all_gems_in_lockfile!(@gems)
definition = Bundler.definition
definition.validate_runtime!
installer = Bundler::Installer.new(Bundler.root, definition)
ProcessLock.lock do
installed_specs = definition.specs.reject do |spec|
next if spec.name == "bundler" # Source::Rubygems doesn't install bundler
next if !@gems.empty? && !@gems.include?(spec.name)
gem_name = "#{spec.name} (#{spec.version}#{spec.git_version})"
gem_name += " (#{spec.platform})" if !spec.platform.nil? && spec.platform != Gem::Platform::RUBY
case source = spec.source
when Source::Rubygems
cached_gem = spec.cache_file
unless File.exist?(cached_gem)
Bundler.ui.error("Failed to pristine #{gem_name}. Cached gem #{cached_gem} does not exist.")
next
end
FileUtils.rm_rf spec.full_gem_path
when Source::Git
if source.local?
Bundler.ui.warn("Cannot pristine #{gem_name}. Gem is locally overridden.")
next
end
source.remote!
if extension_cache_path = source.extension_cache_path(spec)
FileUtils.rm_rf extension_cache_path
end
FileUtils.rm_rf spec.extension_dir
FileUtils.rm_rf spec.full_gem_path
else
Bundler.ui.warn("Cannot pristine #{gem_name}. Gem is sourced from local path.")
next
end
true
end.map(&:name)
jobs = installer.send(:installation_parallelization, {})
pristine_count = definition.specs.count - installed_specs.count
# allow a pristining a single gem to skip the parallel worker
jobs = [jobs, pristine_count].min
ParallelInstaller.call(installer, definition.specs, jobs, false, true, skip: installed_specs)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/issue.rb 0000644 00000002464 15173517744 0016364 0 ustar 00 # frozen_string_literal: true
require "rbconfig"
module Bundler
class CLI::Issue
def run
Bundler.ui.info <<~EOS
Did you find an issue with Bundler? Before filing a new issue,
be sure to check out these resources:
1. Check out our troubleshooting guide for quick fixes to common issues:
https://github.com/rubygems/rubygems/blob/master/bundler/doc/TROUBLESHOOTING.md
2. Instructions for common Bundler uses can be found on the documentation
site: https://bundler.io/
3. Information about each Bundler command can be found in the Bundler
man pages: https://bundler.io/man/bundle.1.html
Hopefully the troubleshooting steps above resolved your problem! If things
still aren't working the way you expect them to, please let us know so
that we can diagnose and help fix the problem you're having, by filling
in the new issue form located at
https://github.com/rubygems/rubygems/issues/new?labels=Bundler&template=bundler-related-issue.md,
and copy and pasting the information below.
EOS
Bundler.ui.info Bundler::Env.report
Bundler.ui.info "\n## Bundle Doctor"
doctor
end
def doctor
require_relative "doctor"
Bundler::CLI::Doctor.new({}).run
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/inject.rb 0000644 00000004167 15173517744 0016512 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Inject
attr_reader :options, :name, :version, :group, :source, :gems
def initialize(options, name, version)
@options = options
@name = name
@version = version || last_version_number
@group = options[:group].split(",") unless options[:group].nil?
@source = options[:source]
@gems = []
end
def run
# The required arguments allow Thor to give useful feedback when the arguments
# are incorrect. This adds those first two arguments onto the list as a whole.
gems.unshift(source).unshift(group).unshift(version).unshift(name)
# Build an array of Dependency objects out of the arguments
deps = []
# when `inject` support addition of more than one gem, then this loop will
# help. Currently this loop is running once.
gems.each_slice(4) do |gem_name, gem_version, gem_group, gem_source|
ops = Gem::Requirement::OPS.map {|key, _val| key }
has_op = ops.any? {|op| gem_version.start_with? op }
gem_version = "~> #{gem_version}" unless has_op
deps << Bundler::Dependency.new(gem_name, gem_version, "group" => gem_group, "source" => gem_source)
end
added = Injector.inject(deps, options)
if added.any?
Bundler.ui.confirm "Added to Gemfile:"
Bundler.ui.confirm(added.map do |d|
name = "'#{d.name}'"
requirement = ", '#{d.requirement}'"
group = ", :group => #{d.groups.inspect}" if d.groups != Array(:default)
source = ", :source => '#{d.source}'" unless d.source.nil?
%(gem #{name}#{requirement}#{group}#{source})
end.join("\n"))
else
Bundler.ui.confirm "All gems were already present in the Gemfile"
end
end
private
def last_version_number
definition = Bundler.definition(true)
definition.resolve_remotely!
specs = definition.index[name].sort_by(&:version)
unless options[:pre]
specs.delete_if {|b| b.respond_to?(:version) && b.version.prerelease? }
end
spec = specs.last
spec.version.to_s
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/update.rb 0000644 00000010213 15173517744 0016505 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Update
attr_reader :options, :gems
def initialize(options, gems)
@options = options
@gems = gems
end
def run
Bundler.ui.level = "warn" if options[:quiet]
update_bundler = options[:bundler]
Bundler.self_manager.update_bundler_and_restart_with_it_if_needed(update_bundler) if update_bundler
Plugin.gemfile_install(Bundler.default_gemfile) if Bundler.feature_flag.plugins?
sources = Array(options[:source])
groups = Array(options[:group]).map(&:to_sym)
full_update = gems.empty? && sources.empty? && groups.empty? && !options[:ruby] && !update_bundler
if full_update && !options[:all]
if Bundler.feature_flag.update_requires_all_flag?
raise InvalidOption, "To update everything, pass the `--all` flag."
end
SharedHelpers.major_deprecation 3, "Pass --all to `bundle update` to update everything"
elsif !full_update && options[:all]
raise InvalidOption, "Cannot specify --all along with specific options."
end
conservative = options[:conservative]
if full_update
if conservative
Bundler.definition(conservative: conservative)
else
Bundler.definition(true)
end
else
unless Bundler.default_lockfile.exist?
raise GemfileLockNotFound, "This Bundle hasn't been installed yet. " \
"Run `bundle install` to update and install the bundled gems."
end
Bundler::CLI::Common.ensure_all_gems_in_lockfile!(gems)
if groups.any?
deps = Bundler.definition.dependencies.select {|d| (d.groups & groups).any? }
gems.concat(deps.map(&:name))
end
Bundler.definition(gems: gems, sources: sources, ruby: options[:ruby],
conservative: conservative,
bundler: update_bundler)
end
Bundler::CLI::Common.configure_gem_version_promoter(Bundler.definition, options)
Bundler::Fetcher.disable_endpoint = options["full-index"]
opts = options.dup
opts["update"] = true
opts["local"] = options[:local]
opts["force"] = options[:redownload]
Bundler.settings.set_command_option_if_given :jobs, opts["jobs"]
Bundler.definition.validate_runtime!
if locked_gems = Bundler.definition.locked_gems
previous_locked_info = locked_gems.specs.reduce({}) do |h, s|
h[s.name] = { spec: s, version: s.version, source: s.source.identifier }
h
end
end
installer = Installer.install Bundler.root, Bundler.definition, opts
Bundler.load.cache if Bundler.app_cache.exist?
if CLI::Common.clean_after_install?
require_relative "clean"
Bundler::CLI::Clean.new(options).run
end
if locked_gems
gems.each do |name|
locked_info = previous_locked_info[name]
next unless locked_info
locked_spec = locked_info[:spec]
new_spec = Bundler.definition.specs[name].first
unless new_spec
unless locked_spec.match_platform(Bundler.local_platform)
Bundler.ui.warn "Bundler attempted to update #{name} but it was not considered because it is for a different platform from the current one"
end
next
end
locked_source = locked_info[:source]
new_source = new_spec.source.identifier
next if locked_source != new_source
new_version = new_spec.version
locked_version = locked_info[:version]
if new_version < locked_version
Bundler.ui.warn "Note: #{name} version regressed from #{locked_version} to #{new_version}"
elsif new_version == locked_version
Bundler.ui.warn "Bundler attempted to update #{name} but its version stayed the same"
end
end
end
Bundler.ui.confirm "Bundle updated!"
Bundler::CLI::Common.output_without_groups_message(:update)
Bundler::CLI::Common.output_post_install_messages installer.post_install_messages
Bundler::CLI::Common.output_fund_metadata_summary
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/outdated.rb 0000644 00000022042 15173517744 0017037 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Outdated
attr_reader :options, :gems, :options_include_groups, :filter_options_patch, :sources, :strict
attr_accessor :outdated_gems
def initialize(options, gems)
@options = options
@gems = gems
@sources = Array(options[:source])
@filter_options_patch = options.keys & %w[filter-major filter-minor filter-patch]
@outdated_gems = []
@options_include_groups = [:group, :groups].any? do |v|
options.keys.include?(v.to_s)
end
# the patch level options imply strict is also true. It wouldn't make
# sense otherwise.
@strict = options["filter-strict"] || Bundler::CLI::Common.patch_level_options(options).any?
end
def run
check_for_deployment_mode!
gems.each do |gem_name|
Bundler::CLI::Common.select_spec(gem_name)
end
Bundler.definition.validate_runtime!
current_specs = Bundler.ui.silence { Bundler.definition.resolve }
current_dependencies = Bundler.ui.silence do
Bundler.load.dependencies.map {|dep| [dep.name, dep] }.to_h
end
definition = if gems.empty? && sources.empty?
# We're doing a full update
Bundler.definition(true)
else
Bundler.definition(gems: gems, sources: sources)
end
Bundler::CLI::Common.configure_gem_version_promoter(
Bundler.definition,
options.merge(strict: @strict)
)
definition_resolution = proc do
options[:local] ? definition.resolve_with_cache! : definition.resolve_remotely!
end
if options[:parseable]
Bundler.ui.progress(&definition_resolution)
else
definition_resolution.call
end
Bundler.ui.info ""
# Loop through the current specs
gemfile_specs, dependency_specs = current_specs.partition do |spec|
current_dependencies.key? spec.name
end
specs = if options["only-explicit"]
gemfile_specs
else
gemfile_specs + dependency_specs
end
specs.sort_by(&:name).uniq(&:name).each do |current_spec|
next unless gems.empty? || gems.include?(current_spec.name)
active_spec = retrieve_active_spec(definition, current_spec)
next unless active_spec
next unless filter_options_patch.empty? || update_present_via_semver_portions(current_spec, active_spec, options)
gem_outdated = Gem::Version.new(active_spec.version) > Gem::Version.new(current_spec.version)
next unless gem_outdated || (current_spec.git_version != active_spec.git_version)
dependency = current_dependencies[current_spec.name]
groups = ""
if dependency && !options[:parseable]
groups = dependency.groups.join(", ")
end
outdated_gems << {
active_spec: active_spec,
current_spec: current_spec,
dependency: dependency,
groups: groups,
}
end
relevant_outdated_gems = if options_include_groups
outdated_gems.group_by {|g| g[:groups] }.sort.flat_map do |groups, gems|
contains_group = groups.split(", ").include?(options[:group])
next unless options[:groups] || contains_group
gems
end.compact
else
outdated_gems
end
if relevant_outdated_gems.empty?
unless options[:parseable]
Bundler.ui.info(nothing_outdated_message)
end
else
if options[:parseable]
print_gems(relevant_outdated_gems)
else
print_gems_table(relevant_outdated_gems)
end
exit 1
end
end
private
def loaded_from_for(spec)
return unless spec.respond_to?(:loaded_from)
spec.loaded_from
end
def groups_text(group_text, groups)
"#{group_text}#{groups.split(",").size > 1 ? "s" : ""} \"#{groups}\""
end
def nothing_outdated_message
if filter_options_patch.any?
display = filter_options_patch.map do |o|
o.sub("filter-", "")
end.join(" or ")
"No #{display} updates to display.\n"
else
"Bundle up to date!\n"
end
end
def retrieve_active_spec(definition, current_spec)
active_spec = definition.resolve.find_by_name_and_platform(current_spec.name, current_spec.platform)
return unless active_spec
return active_spec if strict
active_specs = active_spec.source.specs.search(current_spec.name).select {|spec| spec.match_platform(current_spec.platform) }.sort_by(&:version)
if !current_spec.version.prerelease? && !options[:pre] && active_specs.size > 1
active_specs.delete_if {|b| b.respond_to?(:version) && b.version.prerelease? }
end
active_specs.last
end
def print_gems(gems_list)
gems_list.each do |gem|
print_gem(
gem[:current_spec],
gem[:active_spec],
gem[:dependency],
gem[:groups],
)
end
end
def print_gems_table(gems_list)
data = gems_list.map do |gem|
gem_column_for(
gem[:current_spec],
gem[:active_spec],
gem[:dependency],
gem[:groups],
)
end
print_indented([table_header] + data)
end
def print_gem(current_spec, active_spec, dependency, groups)
spec_version = "#{active_spec.version}#{active_spec.git_version}"
if Bundler.ui.debug?
loaded_from = loaded_from_for(active_spec)
spec_version += " (from #{loaded_from})" if loaded_from
end
current_version = "#{current_spec.version}#{current_spec.git_version}"
if dependency&.specific?
dependency_version = %(, requested #{dependency.requirement})
end
spec_outdated_info = "#{active_spec.name} (newest #{spec_version}, " \
"installed #{current_version}#{dependency_version})"
output_message = if options[:parseable]
spec_outdated_info.to_s
elsif options_include_groups || groups.empty?
" * #{spec_outdated_info}"
else
" * #{spec_outdated_info} in #{groups_text("group", groups)}"
end
Bundler.ui.info output_message.rstrip
end
def gem_column_for(current_spec, active_spec, dependency, groups)
current_version = "#{current_spec.version}#{current_spec.git_version}"
spec_version = "#{active_spec.version}#{active_spec.git_version}"
dependency = dependency.requirement if dependency
ret_val = [active_spec.name, current_version, spec_version, dependency.to_s, groups.to_s]
ret_val << loaded_from_for(active_spec).to_s if Bundler.ui.debug?
ret_val
end
def check_for_deployment_mode!
return unless Bundler.frozen_bundle?
suggested_command = if Bundler.settings.locations("frozen").keys.&([:global, :local]).any?
"bundle config unset frozen"
elsif Bundler.settings.locations("deployment").keys.&([:global, :local]).any?
"bundle config unset deployment"
end
raise ProductionError, "You are trying to check outdated gems in " \
"deployment mode. Run `bundle outdated` elsewhere.\n" \
"\nIf this is a development machine, remove the " \
"#{Bundler.default_gemfile} freeze" \
"\nby running `#{suggested_command}`."
end
def update_present_via_semver_portions(current_spec, active_spec, options)
current_major = current_spec.version.segments.first
active_major = active_spec.version.segments.first
update_present = false
update_present = active_major > current_major if options["filter-major"]
if !update_present && (options["filter-minor"] || options["filter-patch"]) && current_major == active_major
current_minor = get_version_semver_portion_value(current_spec, 1)
active_minor = get_version_semver_portion_value(active_spec, 1)
update_present = active_minor > current_minor if options["filter-minor"]
if !update_present && options["filter-patch"] && current_minor == active_minor
current_patch = get_version_semver_portion_value(current_spec, 2)
active_patch = get_version_semver_portion_value(active_spec, 2)
update_present = active_patch > current_patch
end
end
update_present
end
def get_version_semver_portion_value(spec, version_portion_index)
version_section = spec.version.segments[version_portion_index, 1]
version_section.to_a[0].to_i
end
def print_indented(matrix)
header = matrix[0]
data = matrix[1..-1]
column_sizes = Array.new(header.size) do |index|
matrix.max_by {|row| row[index].length }[index].length
end
Bundler.ui.info justify(header, column_sizes)
data.sort_by! {|row| row[0] }
data.each do |row|
Bundler.ui.info justify(row, column_sizes)
end
end
def table_header
header = ["Gem", "Current", "Latest", "Requested", "Groups"]
header << "Path" if Bundler.ui.debug?
header
end
def justify(row, sizes)
row.each_with_index.map do |element, index|
element.ljust(sizes[index])
end.join(" ").strip + "\n"
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/fund.rb 0000644 00000001606 15173517744 0016165 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Fund
attr_reader :options
def initialize(options)
@options = options
end
def run
Bundler.definition.validate_runtime!
groups = Array(options[:group]).map(&:to_sym)
deps = if groups.any?
Bundler.definition.dependencies_for(groups)
else
Bundler.definition.requested_dependencies
end
fund_info = deps.each_with_object([]) do |dep, arr|
spec = Bundler.definition.specs[dep.name].first
if spec.metadata.key?("funding_uri")
arr << "* #{spec.name} (#{spec.version})\n Funding: #{spec.metadata["funding_uri"]}"
end
end
if fund_info.empty?
Bundler.ui.info "None of the installed gems you directly depend on are looking for funding."
else
Bundler.ui.info fund_info.join("\n")
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/console.rb 0000644 00000002275 15173517744 0016676 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Console
attr_reader :options, :group
def initialize(options, group)
@options = options
@group = group
end
def run
message = "bundle console will be replaced by `bin/console` generated by `bundle gem <name>`"
removed_message = "bundle console has been replaced by `bin/console` generated by `bundle gem <name>`"
Bundler::SharedHelpers.major_deprecation 2, message, removed_message: removed_message
group ? Bundler.require(:default, *group.split(" ").map!(&:to_sym)) : Bundler.require
ARGV.clear
console = get_console(Bundler.settings[:console] || "irb")
console.start
end
def get_console(name)
require name
get_constant(name)
rescue LoadError
Bundler.ui.error "Couldn't load console #{name}, falling back to irb"
require "irb"
get_constant("irb")
end
def get_constant(name)
const_name = {
"pry" => :Pry,
"ripl" => :Ripl,
"irb" => :IRB,
}[name]
Object.const_get(const_name)
rescue NameError
Bundler.ui.error "Could not find constant #{const_name}"
exit 1
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/common.rb 0000644 00000011513 15173517744 0016517 0 ustar 00 # frozen_string_literal: true
module Bundler
module CLI::Common
def self.output_post_install_messages(messages)
return if Bundler.settings["ignore_messages"]
messages.to_a.each do |name, msg|
print_post_install_message(name, msg) unless Bundler.settings["ignore_messages.#{name}"]
end
end
def self.print_post_install_message(name, msg)
Bundler.ui.confirm "Post-install message from #{name}:"
Bundler.ui.info msg
end
def self.output_fund_metadata_summary
return if Bundler.settings["ignore_funding_requests"]
definition = Bundler.definition
current_dependencies = definition.requested_dependencies
current_specs = definition.specs
count = current_dependencies.count {|dep| current_specs[dep.name].first.metadata.key?("funding_uri") }
return if count.zero?
intro = count > 1 ? "#{count} installed gems you directly depend on are" : "#{count} installed gem you directly depend on is"
message = "#{intro} looking for funding.\n Run `bundle fund` for details"
Bundler.ui.info message
end
def self.output_without_groups_message(command)
return if Bundler.settings[:without].empty?
Bundler.ui.confirm without_groups_message(command)
end
def self.without_groups_message(command)
command_in_past_tense = command == :install ? "installed" : "updated"
groups = Bundler.settings[:without]
"Gems in the #{verbalize_groups(groups)} were not #{command_in_past_tense}."
end
def self.verbalize_groups(groups)
groups.map! {|g| "'#{g}'" }
group_list = [groups[0...-1].join(", "), groups[-1..-1]].
reject {|s| s.to_s.empty? }.join(" and ")
group_str = groups.size == 1 ? "group" : "groups"
"#{group_str} #{group_list}"
end
def self.select_spec(name, regex_match = nil)
specs = []
regexp = Regexp.new(name) if regex_match
Bundler.definition.specs.each do |spec|
return spec if spec.name == name
specs << spec if regexp && spec.name.match?(regexp)
end
default_spec = default_gem_spec(name)
specs << default_spec if default_spec
case specs.count
when 0
dep_in_other_group = Bundler.definition.current_dependencies.find {|dep|dep.name == name }
if dep_in_other_group
raise GemNotFound, "Could not find gem '#{name}', because it's in the #{verbalize_groups(dep_in_other_group.groups)}, configured to be ignored."
else
raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
end
when 1
specs.first
else
ask_for_spec_from(specs)
end
rescue RegexpError
raise GemNotFound, gem_not_found_message(name, Bundler.definition.dependencies)
end
def self.default_gem_spec(name)
gem_spec = Gem::Specification.find_all_by_name(name).last
gem_spec if gem_spec&.default_gem?
end
def self.ask_for_spec_from(specs)
specs.each_with_index do |spec, index|
Bundler.ui.info "#{index.succ} : #{spec.name}", true
end
Bundler.ui.info "0 : - exit -", true
num = Bundler.ui.ask("> ").to_i
num > 0 ? specs[num - 1] : nil
end
def self.gem_not_found_message(missing_gem_name, alternatives)
require_relative "../similarity_detector"
message = "Could not find gem '#{missing_gem_name}'."
alternate_names = alternatives.map {|a| a.respond_to?(:name) ? a.name : a }
suggestions = SimilarityDetector.new(alternate_names).similar_word_list(missing_gem_name)
message += "\nDid you mean #{suggestions}?" if suggestions
message
end
def self.ensure_all_gems_in_lockfile!(names, locked_gems = Bundler.locked_gems)
return unless locked_gems
locked_names = locked_gems.specs.map(&:name).uniq
names.-(locked_names).each do |g|
raise GemNotFound, gem_not_found_message(g, locked_names)
end
end
def self.configure_gem_version_promoter(definition, options)
patch_level = patch_level_options(options)
patch_level << :patch if patch_level.empty? && Bundler.settings[:prefer_patch]
raise InvalidOption, "Provide only one of the following options: #{patch_level.join(", ")}" unless patch_level.length <= 1
definition.gem_version_promoter.tap do |gvp|
gvp.level = patch_level.first || :major
gvp.strict = options[:strict] || options["filter-strict"]
gvp.pre = options[:pre]
end
end
def self.patch_level_options(options)
[:major, :minor, :patch].select {|v| options.keys.include?(v.to_s) }
end
def self.clean_after_install?
clean = Bundler.settings[:clean]
return clean unless clean.nil?
clean ||= Bundler.feature_flag.auto_clean_without_path? && Bundler.settings[:path].nil?
clean &&= !Bundler.use_system_gems?
clean
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/viz.rb 0000644 00000002112 15173517744 0016032 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Viz
attr_reader :options, :gem_name
def initialize(options)
@options = options
end
def run
# make sure we get the right `graphviz`. There is also a `graphviz`
# gem we're not built to support
gem "ruby-graphviz"
require "graphviz"
options[:without] = options[:without].join(":").tr(" ", ":").split(":")
output_file = File.expand_path(options[:file])
graph = Graph.new(Bundler.load, output_file, options[:version], options[:requirements], options[:format], options[:without])
graph.viz
rescue LoadError => e
Bundler.ui.error e.inspect
Bundler.ui.warn "Make sure you have the graphviz ruby gem. You can install it with:"
Bundler.ui.warn "`gem install ruby-graphviz`"
rescue StandardError => e
raise unless e.message.to_s.include?("GraphViz not installed or dot not in PATH")
Bundler.ui.error e.message
Bundler.ui.warn "Please install GraphViz. On a Mac with Homebrew, you can run `brew install graphviz`."
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/remove.rb 0000644 00000000537 15173517744 0016530 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Remove
def initialize(gems, options)
@gems = gems
@options = options
end
def run
raise InvalidOption, "Please specify gems to remove." if @gems.empty?
Injector.remove(@gems, {})
Installer.install(Bundler.root, Bundler.definition)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/open.rb 0000644 00000002215 15173517744 0016167 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Open
attr_reader :options, :name, :path
def initialize(options, name)
@options = options
@name = name
@path = options[:path] unless options[:path].nil?
end
def run
raise InvalidOption, "Cannot specify `--path` option without a value" if !@path.nil? && @path.empty?
editor = [ENV["BUNDLER_EDITOR"], ENV["VISUAL"], ENV["EDITOR"]].find {|e| !e.nil? && !e.empty? }
return Bundler.ui.info("To open a bundled gem, set $EDITOR or $BUNDLER_EDITOR") unless editor
return unless spec = Bundler::CLI::Common.select_spec(name, :regex_match)
if spec.default_gem?
Bundler.ui.info "Unable to open #{name} because it's a default gem, so the directory it would normally be installed to does not exist."
else
root_path = spec.full_gem_path
require "shellwords"
command = Shellwords.split(editor) << File.join([root_path, path].compact)
Bundler.with_original_env do
system(*command, { chdir: root_path })
end || Bundler.ui.info("Could not run '#{command.join(" ")}'")
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/gem.rb 0000644 00000040464 15173517744 0016006 0 ustar 00 # frozen_string_literal: true
require "pathname"
module Bundler
class CLI
Bundler.require_thor_actions
include Thor::Actions
end
class CLI::Gem
TEST_FRAMEWORK_VERSIONS = {
"rspec" => "3.0",
"minitest" => "5.16",
"test-unit" => "3.0",
}.freeze
attr_reader :options, :gem_name, :thor, :name, :target, :extension
def initialize(options, gem_name, thor)
@options = options
@gem_name = resolve_name(gem_name)
@thor = thor
thor.behavior = :invoke
thor.destination_root = nil
@name = @gem_name
@target = SharedHelpers.pwd.join(gem_name)
@extension = options[:ext]
validate_ext_name if @extension
validate_rust_builder_rubygems_version if @extension == "rust"
end
def run
Bundler.ui.confirm "Creating gem '#{name}'..."
underscored_name = name.tr("-", "_")
namespaced_path = name.tr("-", "/")
constant_name = name.gsub(/-[_-]*(?![_-]|$)/) { "::" }.gsub(/([_-]+|(::)|^)(.|$)/) { $2.to_s + $3.upcase }
constant_array = constant_name.split("::")
minitest_constant_name = constant_array.clone.tap {|a| a[-1] = "Test#{a[-1]}" }.join("::") # Foo::Bar => Foo::TestBar
use_git = Bundler.git_present? && options[:git]
git_author_name = use_git ? `git config user.name`.chomp : ""
git_username = use_git ? `git config github.user`.chomp : ""
git_user_email = use_git ? `git config user.email`.chomp : ""
github_username = if options[:github_username].nil?
git_username
elsif options[:github_username] == false
""
else
options[:github_username]
end
config = {
name: name,
underscored_name: underscored_name,
namespaced_path: namespaced_path,
makefile_path: "#{underscored_name}/#{underscored_name}",
constant_name: constant_name,
constant_array: constant_array,
author: git_author_name.empty? ? "TODO: Write your name" : git_author_name,
email: git_user_email.empty? ? "TODO: Write your email address" : git_user_email,
test: options[:test],
ext: extension,
exe: options[:exe],
bundler_version: bundler_dependency_version,
git: use_git,
github_username: github_username.empty? ? "[USERNAME]" : github_username,
required_ruby_version: required_ruby_version,
rust_builder_required_rubygems_version: rust_builder_required_rubygems_version,
minitest_constant_name: minitest_constant_name,
}
ensure_safe_gem_name(name, constant_array)
templates = {
"Gemfile.tt" => Bundler.preferred_gemfile_name,
"lib/newgem.rb.tt" => "lib/#{namespaced_path}.rb",
"lib/newgem/version.rb.tt" => "lib/#{namespaced_path}/version.rb",
"sig/newgem.rbs.tt" => "sig/#{namespaced_path}.rbs",
"newgem.gemspec.tt" => "#{name}.gemspec",
"Rakefile.tt" => "Rakefile",
"README.md.tt" => "README.md",
"bin/console.tt" => "bin/console",
"bin/setup.tt" => "bin/setup",
}
executables = %w[
bin/console
bin/setup
]
templates.merge!("gitignore.tt" => ".gitignore") if use_git
if test_framework = ask_and_set_test_framework
config[:test] = test_framework
config[:test_framework_version] = TEST_FRAMEWORK_VERSIONS[test_framework]
case test_framework
when "rspec"
templates.merge!(
"rspec.tt" => ".rspec",
"spec/spec_helper.rb.tt" => "spec/spec_helper.rb",
"spec/newgem_spec.rb.tt" => "spec/#{namespaced_path}_spec.rb"
)
config[:test_task] = :spec
when "minitest"
# Generate path for minitest target file (FileList["test/**/test_*.rb"])
# foo => test/test_foo.rb
# foo-bar => test/foo/test_bar.rb
# foo_bar => test/test_foo_bar.rb
paths = namespaced_path.rpartition("/")
paths[2] = "test_#{paths[2]}"
minitest_namespaced_path = paths.join("")
templates.merge!(
"test/minitest/test_helper.rb.tt" => "test/test_helper.rb",
"test/minitest/test_newgem.rb.tt" => "test/#{minitest_namespaced_path}.rb"
)
config[:test_task] = :test
when "test-unit"
templates.merge!(
"test/test-unit/test_helper.rb.tt" => "test/test_helper.rb",
"test/test-unit/newgem_test.rb.tt" => "test/#{namespaced_path}_test.rb"
)
config[:test_task] = :test
end
end
config[:ci] = ask_and_set_ci
case config[:ci]
when "github"
templates.merge!("github/workflows/main.yml.tt" => ".github/workflows/main.yml")
config[:ci_config_path] = ".github "
when "gitlab"
templates.merge!("gitlab-ci.yml.tt" => ".gitlab-ci.yml")
config[:ci_config_path] = ".gitlab-ci.yml "
when "circle"
templates.merge!("circleci/config.yml.tt" => ".circleci/config.yml")
config[:ci_config_path] = ".circleci "
end
if ask_and_set(:mit, "Do you want to license your code permissively under the MIT license?",
"This means that any other developer or company will be legally allowed to use your code " \
"for free as long as they admit you created it. You can read more about the MIT license " \
"at https://choosealicense.com/licenses/mit.")
config[:mit] = true
Bundler.ui.info "MIT License enabled in config"
templates.merge!("LICENSE.txt.tt" => "LICENSE.txt")
end
if ask_and_set(:coc, "Do you want to include a code of conduct in gems you generate?",
"Codes of conduct can increase contributions to your project by contributors who " \
"prefer collaborative, safe spaces. You can read more about the code of conduct at " \
"contributor-covenant.org. Having a code of conduct means agreeing to the responsibility " \
"of enforcing it, so be sure that you are prepared to do that. Be sure that your email " \
"address is specified as a contact in the generated code of conduct so that people know " \
"who to contact in case of a violation. For suggestions about " \
"how to enforce codes of conduct, see https://bit.ly/coc-enforcement.")
config[:coc] = true
Bundler.ui.info "Code of conduct enabled in config"
templates.merge!("CODE_OF_CONDUCT.md.tt" => "CODE_OF_CONDUCT.md")
end
if ask_and_set(:changelog, "Do you want to include a changelog?",
"A changelog is a file which contains a curated, chronologically ordered list of notable " \
"changes for each version of a project. To make it easier for users and contributors to" \
" see precisely what notable changes have been made between each release (or version) of" \
" the project. Whether consumers or developers, the end users of software are" \
" human beings who care about what's in the software. When the software changes, people " \
"want to know why and how. see https://keepachangelog.com")
config[:changelog] = true
Bundler.ui.info "Changelog enabled in config"
templates.merge!("CHANGELOG.md.tt" => "CHANGELOG.md")
end
config[:linter] = ask_and_set_linter
case config[:linter]
when "rubocop"
config[:linter_version] = rubocop_version
Bundler.ui.info "RuboCop enabled in config"
templates.merge!("rubocop.yml.tt" => ".rubocop.yml")
when "standard"
config[:linter_version] = standard_version
Bundler.ui.info "Standard enabled in config"
templates.merge!("standard.yml.tt" => ".standard.yml")
end
if config[:exe]
templates.merge!("exe/newgem.tt" => "exe/#{name}")
executables.push("exe/#{name}")
end
if extension == "c"
templates.merge!(
"ext/newgem/extconf-c.rb.tt" => "ext/#{name}/extconf.rb",
"ext/newgem/newgem.h.tt" => "ext/#{name}/#{underscored_name}.h",
"ext/newgem/newgem.c.tt" => "ext/#{name}/#{underscored_name}.c"
)
end
if extension == "rust"
templates.merge!(
"Cargo.toml.tt" => "Cargo.toml",
"ext/newgem/Cargo.toml.tt" => "ext/#{name}/Cargo.toml",
"ext/newgem/extconf-rust.rb.tt" => "ext/#{name}/extconf.rb",
"ext/newgem/src/lib.rs.tt" => "ext/#{name}/src/lib.rs",
)
end
if target.exist? && !target.directory?
Bundler.ui.error "Couldn't create a new gem named `#{gem_name}` because there's an existing file named `#{gem_name}`."
exit Bundler::BundlerError.all_errors[Bundler::GenericSystemCallError]
end
if use_git
Bundler.ui.info "Initializing git repo in #{target}"
require "shellwords"
`git init #{target.to_s.shellescape}`
config[:git_default_branch] = File.read("#{target}/.git/HEAD").split("/").last.chomp
end
templates.each do |src, dst|
destination = target.join(dst)
thor.template("newgem/#{src}", destination, config)
end
executables.each do |file|
path = target.join(file)
executable = (path.stat.mode | 0o111)
path.chmod(executable)
end
if use_git
IO.popen(%w[git add .], { chdir: target }, &:read)
end
# Open gemspec in editor
open_editor(options["edit"], target.join("#{name}.gemspec")) if options[:edit]
Bundler.ui.info "Gem '#{name}' was successfully created. " \
"For more information on making a RubyGem visit https://bundler.io/guides/creating_gem.html"
end
private
def resolve_name(name)
SharedHelpers.pwd.join(name).basename.to_s
end
def ask_and_set(key, header, message)
choice = options[key]
choice = Bundler.settings["gem.#{key}"] if choice.nil?
if choice.nil?
Bundler.ui.confirm header
choice = Bundler.ui.yes? "#{message} y/(n):"
Bundler.settings.set_global("gem.#{key}", choice)
end
choice
end
def validate_ext_name
return unless gem_name.index("-")
Bundler.ui.error "You have specified a gem name which does not conform to the \n" \
"naming guidelines for C extensions. For more information, \n" \
"see the 'Extension Naming' section at the following URL:\n" \
"https://guides.rubygems.org/gems-with-extensions/\n"
exit 1
end
def ask_and_set_test_framework
return if skip?(:test)
test_framework = options[:test] || Bundler.settings["gem.test"]
if test_framework.to_s.empty?
Bundler.ui.confirm "Do you want to generate tests with your gem?"
Bundler.ui.info hint_text("test")
result = Bundler.ui.ask "Enter a test framework. rspec/minitest/test-unit/(none):"
if /rspec|minitest|test-unit/.match?(result)
test_framework = result
else
test_framework = false
end
end
if Bundler.settings["gem.test"].nil?
Bundler.settings.set_global("gem.test", test_framework)
end
if options[:test] == Bundler.settings["gem.test"]
Bundler.ui.info "#{options[:test]} is already configured, ignoring --test flag."
end
test_framework
end
def skip?(option)
options.key?(option) && options[option].nil?
end
def hint_text(setting)
if Bundler.settings["gem.#{setting}"] == false
"Your choice will only be applied to this gem."
else
"Future `bundle gem` calls will use your choice. " \
"This setting can be changed anytime with `bundle config gem.#{setting}`."
end
end
def ask_and_set_ci
return if skip?(:ci)
ci_template = options[:ci] || Bundler.settings["gem.ci"]
if ci_template.to_s.empty?
Bundler.ui.confirm "Do you want to set up continuous integration for your gem? " \
"Supported services:\n" \
"* CircleCI: https://circleci.com/\n" \
"* GitHub Actions: https://github.com/features/actions\n" \
"* GitLab CI: https://docs.gitlab.com/ee/ci/\n" \
"\n"
Bundler.ui.info hint_text("ci")
result = Bundler.ui.ask "Enter a CI service. github/gitlab/circle/(none):"
if /github|gitlab|circle/.match?(result)
ci_template = result
else
ci_template = false
end
end
if Bundler.settings["gem.ci"].nil?
Bundler.settings.set_global("gem.ci", ci_template)
end
if options[:ci] == Bundler.settings["gem.ci"]
Bundler.ui.info "#{options[:ci]} is already configured, ignoring --ci flag."
end
ci_template
end
def ask_and_set_linter
return if skip?(:linter)
linter_template = options[:linter] || Bundler.settings["gem.linter"]
linter_template = deprecated_rubocop_option if linter_template.nil?
if linter_template.to_s.empty?
Bundler.ui.confirm "Do you want to add a code linter and formatter to your gem? " \
"Supported Linters:\n" \
"* RuboCop: https://rubocop.org\n" \
"* Standard: https://github.com/standardrb/standard\n" \
"\n"
Bundler.ui.info hint_text("linter")
result = Bundler.ui.ask "Enter a linter. rubocop/standard/(none):"
if /rubocop|standard/.match?(result)
linter_template = result
else
linter_template = false
end
end
if Bundler.settings["gem.linter"].nil?
Bundler.settings.set_global("gem.linter", linter_template)
end
# Once gem.linter safely set, unset the deprecated gem.rubocop
unless Bundler.settings["gem.rubocop"].nil?
Bundler.settings.set_global("gem.rubocop", nil)
end
if options[:linter] == Bundler.settings["gem.linter"]
Bundler.ui.info "#{options[:linter]} is already configured, ignoring --linter flag."
end
linter_template
end
def deprecated_rubocop_option
if !options[:rubocop].nil?
if options[:rubocop]
Bundler::SharedHelpers.major_deprecation 2,
"--rubocop is deprecated, use --linter=rubocop",
removed_message: "--rubocop has been removed, use --linter=rubocop"
"rubocop"
else
Bundler::SharedHelpers.major_deprecation 2,
"--no-rubocop is deprecated, use --linter",
removed_message: "--no-rubocop has been removed, use --linter"
false
end
elsif !Bundler.settings["gem.rubocop"].nil?
Bundler::SharedHelpers.major_deprecation 2,
"config gem.rubocop is deprecated; we've updated your config to use gem.linter instead",
removed_message: "config gem.rubocop has been removed; we've updated your config to use gem.linter instead"
Bundler.settings["gem.rubocop"] ? "rubocop" : false
end
end
def bundler_dependency_version
v = Gem::Version.new(Bundler::VERSION)
req = v.segments[0..1]
req << "a" if v.prerelease?
req.join(".")
end
def ensure_safe_gem_name(name, constant_array)
if /^\d/.match?(name)
Bundler.ui.error "Invalid gem name #{name} Please give a name which does not start with numbers."
exit 1
end
constant_name = constant_array.join("::")
existing_constant = constant_array.inject(Object) do |c, s|
defined = begin
c.const_defined?(s)
rescue NameError
Bundler.ui.error "Invalid gem name #{name} -- `#{constant_name}` is an invalid constant name"
exit 1
end
(defined && c.const_get(s)) || break
end
return unless existing_constant
Bundler.ui.error "Invalid gem name #{name} constant #{constant_name} is already in use. Please choose another gem name."
exit 1
end
def open_editor(editor, file)
thor.run(%(#{editor} "#{file}"))
end
def rust_builder_required_rubygems_version
"3.3.11"
end
def required_ruby_version
"3.0.0"
end
def rubocop_version
"1.21"
end
def standard_version
"1.3"
end
def validate_rust_builder_rubygems_version
if Gem::Version.new(rust_builder_required_rubygems_version) > Gem.rubygems_version
Bundler.ui.error "Your RubyGems version (#{Gem.rubygems_version}) is too old to build Rust extension. Please update your RubyGems using `gem update --system` or any other way and try again."
exit 1
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/check.rb 0000644 00000002406 15173517744 0016305 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Check
attr_reader :options
def initialize(options)
@options = options
end
def run
Bundler.settings.set_command_option_if_given :path, options[:path]
definition = Bundler.definition
definition.validate_runtime!
begin
definition.resolve_only_locally!
not_installed = definition.missing_specs
rescue GemNotFound, GitError, SolveFailure
Bundler.ui.error "Bundler can't satisfy your Gemfile's dependencies."
Bundler.ui.warn "Install missing gems with `bundle install`."
exit 1
end
if not_installed.any?
Bundler.ui.error "The following gems are missing"
not_installed.each {|s| Bundler.ui.error " * #{s.name} (#{s.version})" }
Bundler.ui.warn "Install missing gems with `bundle install`"
exit 1
elsif !Bundler.default_lockfile.file? && Bundler.frozen_bundle?
Bundler.ui.error "This bundle has been frozen, but there is no #{SharedHelpers.relative_lockfile_path} present"
exit 1
else
Bundler.load.lock(preserve_unknown_sections: true) unless options[:"dry-run"]
Bundler.ui.info "The Gemfile's dependencies are satisfied"
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/config.rb 0000644 00000014314 15173517744 0016476 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Config < Thor
class_option :parseable, type: :boolean, banner: "Use minimal formatting for more parseable output"
def self.scope_options
method_option :global, type: :boolean, banner: "Only change the global config"
method_option :local, type: :boolean, banner: "Only change the local config"
end
private_class_method :scope_options
desc "base NAME [VALUE]", "The Bundler 1 config interface", hide: true
scope_options
method_option :delete, type: :boolean, banner: "delete"
def base(name = nil, *value)
new_args =
if ARGV.size == 1
["config", "list"]
elsif ARGV.include?("--delete")
ARGV.map {|arg| arg == "--delete" ? "unset" : arg }
elsif ARGV.include?("--global") || ARGV.include?("--local") || ARGV.size == 3
["config", "set", *ARGV[1..-1]]
else
["config", "get", ARGV[1]]
end
message = "Using the `config` command without a subcommand [list, get, set, unset] is deprecated and will be removed in the future. Use `bundle #{new_args.join(" ")}` instead."
removed_message = "Using the `config` command without a subcommand [list, get, set, unset] is has been removed. Use `bundle #{new_args.join(" ")}` instead."
SharedHelpers.major_deprecation 3, message, removed_message: removed_message
Base.new(options, name, value, self).run
end
desc "list", "List out all configured settings"
def list
Base.new(options, nil, nil, self).run
end
desc "get NAME", "Returns the value for the given key"
def get(name)
Base.new(options, name, nil, self).run
end
desc "set NAME VALUE", "Sets the given value for the given key"
scope_options
def set(name, value, *value_)
Base.new(options, name, value_.unshift(value), self).run
end
desc "unset NAME", "Unsets the value for the given key"
scope_options
def unset(name)
options[:delete] = true
Base.new(options, name, nil, self).run
end
default_task :base
class Base
attr_reader :name, :value, :options, :scope, :thor
def initialize(options, name, value, thor)
@options = options
@name = name
value = Array(value)
@value = value.empty? ? nil : value.join(" ")
@thor = thor
validate_scope!
end
def run
unless name
warn_unused_scope "Ignoring --#{scope}"
confirm_all
return
end
if options[:delete]
if !explicit_scope? || scope != "global"
Bundler.settings.set_local(name, nil)
end
if !explicit_scope? || scope != "local"
Bundler.settings.set_global(name, nil)
end
return
end
if value.nil?
warn_unused_scope "Ignoring --#{scope} since no value to set was given"
if options[:parseable]
if value = Bundler.settings[name]
Bundler.ui.info("#{name}=#{value}")
end
return
end
confirm(name)
return
end
Bundler.ui.info(message) if message
Bundler.settings.send("set_#{scope}", name, new_value)
end
def confirm_all
if @options[:parseable]
thor.with_padding do
Bundler.settings.all.each do |setting|
val = Bundler.settings[setting]
Bundler.ui.info "#{setting}=#{val}"
end
end
else
Bundler.ui.confirm "Settings are listed in order of priority. The top value will be used.\n"
Bundler.settings.all.each do |setting|
Bundler.ui.confirm setting
show_pretty_values_for(setting)
Bundler.ui.confirm ""
end
end
end
def confirm(name)
Bundler.ui.confirm "Settings for `#{name}` in order of priority. The top value will be used"
show_pretty_values_for(name)
end
def new_value
pathname = Pathname.new(value)
if name.start_with?("local.") && pathname.directory?
pathname.expand_path.to_s
else
value
end
end
def message
locations = Bundler.settings.locations(name)
if @options[:parseable]
"#{name}=#{new_value}" if new_value
elsif scope == "global"
if !locations[:local].nil?
"Your application has set #{name} to #{locations[:local].inspect}. " \
"This will override the global value you are currently setting"
elsif locations[:env]
"You have a bundler environment variable for #{name} set to " \
"#{locations[:env].inspect}. This will take precedence over the global value you are setting"
elsif !locations[:global].nil? && locations[:global] != value
"You are replacing the current global value of #{name}, which is currently " \
"#{locations[:global].inspect}"
end
elsif scope == "local" && !locations[:local].nil? && locations[:local] != value
"You are replacing the current local value of #{name}, which is currently " \
"#{locations[:local].inspect}"
end
end
def show_pretty_values_for(setting)
thor.with_padding do
Bundler.settings.pretty_values_for(setting).each do |line|
Bundler.ui.info line
end
end
end
def explicit_scope?
@explicit_scope
end
def warn_unused_scope(msg)
return unless explicit_scope?
return if options[:parseable]
Bundler.ui.warn(msg)
end
def validate_scope!
@explicit_scope = true
scopes = %w[global local].select {|s| options[s] }
case scopes.size
when 0
@scope = inside_app? ? "local" : "global"
@explicit_scope = false
when 1
@scope = scopes.first
else
raise InvalidOption,
"The options #{scopes.join " and "} were specified. Please only use one of the switches at a time."
end
end
private
def inside_app?
Bundler.root
true
rescue GemfileNotFound
false
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/plugin.rb 0000644 00000003334 15173517744 0016527 0 ustar 00 # frozen_string_literal: true
require_relative "../vendored_thor"
module Bundler
class CLI::Plugin < Thor
desc "install PLUGINS", "Install the plugin from the source"
long_desc <<-D
Install plugins either from the rubygems source provided (with --source option), from a git source provided with --git, or a local path provided with --path. If no sources are provided, it uses Gem.sources
D
method_option "source", type: :string, default: nil, banner: "URL of the RubyGems source to fetch the plugin from"
method_option "version", type: :string, default: nil, banner: "The version of the plugin to fetch"
method_option "git", type: :string, default: nil, banner: "URL of the git repo to fetch from"
method_option "local_git", type: :string, default: nil, banner: "Path of the local git repo to fetch from (deprecated)"
method_option "branch", type: :string, default: nil, banner: "The git branch to checkout"
method_option "ref", type: :string, default: nil, banner: "The git revision to check out"
method_option "path", type: :string, default: nil, banner: "Path of a local gem to directly use"
def install(*plugins)
Bundler::Plugin.install(plugins, options)
end
desc "uninstall PLUGINS", "Uninstall the plugins"
long_desc <<-D
Uninstall given list of plugins. To uninstall all the plugins, use -all option.
D
method_option "all", type: :boolean, default: nil, banner: "Uninstall all the installed plugins. If no plugin is installed, then it does nothing."
def uninstall(*plugins)
Bundler::Plugin.uninstall(plugins, options)
end
desc "list", "List the installed plugins and available commands"
def list
Bundler::Plugin.list
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/install.rb 0000644 00000017244 15173517744 0016704 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Install
attr_reader :options
def initialize(options)
@options = options
end
def run
Bundler.ui.level = "warn" if options[:quiet]
warn_if_root
if options[:local]
Bundler.self_manager.restart_with_locked_bundler_if_needed
else
Bundler.self_manager.install_locked_bundler_and_restart_with_it_if_needed
end
Bundler::SharedHelpers.set_env "RB_USER_INSTALL", "1" if Gem.freebsd_platform?
# Disable color in deployment mode
Bundler.ui.shell = Thor::Shell::Basic.new if options[:deployment]
check_for_options_conflicts
check_trust_policy
if options[:deployment] || options[:frozen] || Bundler.frozen_bundle?
unless Bundler.default_lockfile.exist?
flag = "--deployment flag" if options[:deployment]
flag ||= "--frozen flag" if options[:frozen]
flag ||= "deployment setting" if Bundler.settings[:deployment]
flag ||= "frozen setting" if Bundler.settings[:frozen]
raise ProductionError, "The #{flag} requires a lockfile. Please make " \
"sure you have checked your #{SharedHelpers.relative_lockfile_path} into version control " \
"before deploying."
end
options[:local] = true if Bundler.app_cache.exist?
Bundler.settings.set_command_option :deployment, true if options[:deployment]
Bundler.settings.set_command_option :frozen, true if options[:frozen]
end
# When install is called with --no-deployment, disable deployment mode
if options[:deployment] == false
Bundler.settings.set_command_option :frozen, nil
options[:system] = true
end
normalize_settings
Bundler::Fetcher.disable_endpoint = options["full-index"]
if options["binstubs"]
Bundler::SharedHelpers.major_deprecation 2,
"The --binstubs option will be removed in favor of `bundle binstubs --all`",
removed_message: "The --binstubs option have been removed in favor of `bundle binstubs --all`"
end
Plugin.gemfile_install(Bundler.default_gemfile) if Bundler.feature_flag.plugins?
definition = Bundler.definition
definition.validate_runtime!
installer = Installer.install(Bundler.root, definition, options)
Bundler.settings.temporary(cache_all_platforms: options[:local] ? false : Bundler.settings[:cache_all_platforms]) do
Bundler.load.cache(nil, options[:local]) if Bundler.app_cache.exist? && !options["no-cache"] && !Bundler.frozen_bundle?
end
Bundler.ui.confirm "Bundle complete! #{dependencies_count_for(definition)}, #{gems_installed_for(definition)}."
Bundler::CLI::Common.output_without_groups_message(:install)
if Bundler.use_system_gems?
Bundler.ui.confirm "Use `bundle info [gemname]` to see where a bundled gem is installed."
else
relative_path = Bundler.configured_bundle_path.base_path_relative_to_pwd
Bundler.ui.confirm "Bundled gems are installed into `#{relative_path}`"
end
Bundler::CLI::Common.output_post_install_messages installer.post_install_messages
warn_ambiguous_gems
if CLI::Common.clean_after_install?
require_relative "clean"
Bundler::CLI::Clean.new(options).run
end
Bundler::CLI::Common.output_fund_metadata_summary
rescue Gem::InvalidSpecificationException
Bundler.ui.warn "You have one or more invalid gemspecs that need to be fixed."
raise
end
private
def warn_if_root
return if Bundler.settings[:silence_root_warning] || Gem.win_platform? || !Process.uid.zero?
Bundler.ui.warn "Don't run Bundler as root. Installing your bundle as root " \
"will break this application for all non-root users on this machine.", wrap: true
end
def dependencies_count_for(definition)
count = definition.dependencies.count
"#{count} Gemfile #{count == 1 ? "dependency" : "dependencies"}"
end
def gems_installed_for(definition)
count = definition.specs.count
"#{count} #{count == 1 ? "gem" : "gems"} now installed"
end
def check_for_group_conflicts_in_cli_options
conflicting_groups = Array(options[:without]) & Array(options[:with])
return if conflicting_groups.empty?
raise InvalidOption, "You can't list a group in both with and without." \
" The offending groups are: #{conflicting_groups.join(", ")}."
end
def check_for_options_conflicts
if (options[:path] || options[:deployment]) && options[:system]
error_message = String.new
error_message << "You have specified both --path as well as --system. Please choose only one option.\n" if options[:path]
error_message << "You have specified both --deployment as well as --system. Please choose only one option.\n" if options[:deployment]
raise InvalidOption.new(error_message)
end
end
def check_trust_policy
trust_policy = options["trust-policy"]
unless Bundler.rubygems.security_policies.keys.unshift(nil).include?(trust_policy)
raise InvalidOption, "RubyGems doesn't know about trust policy '#{trust_policy}'. " \
"The known policies are: #{Bundler.rubygems.security_policies.keys.join(", ")}."
end
Bundler.settings.set_command_option_if_given :"trust-policy", trust_policy
end
def normalize_groups
check_for_group_conflicts_in_cli_options
# need to nil them out first to get around validation for backwards compatibility
Bundler.settings.set_command_option :without, nil
Bundler.settings.set_command_option :with, nil
Bundler.settings.set_command_option :without, options[:without]
Bundler.settings.set_command_option :with, options[:with]
end
def normalize_settings
Bundler.settings.set_command_option :path, nil if options[:system]
Bundler.settings.set_command_option_if_given :path, options[:path]
if options["standalone"] && Bundler.settings[:path].nil? && !options["local"]
Bundler.settings.temporary(path_relative_to_cwd: false) do
Bundler.settings.set_command_option :path, "bundle"
end
end
bin_option = options["binstubs"]
bin_option = nil if bin_option&.empty?
Bundler.settings.set_command_option :bin, bin_option if options["binstubs"]
Bundler.settings.set_command_option_if_given :shebang, options["shebang"]
Bundler.settings.set_command_option_if_given :jobs, options["jobs"]
Bundler.settings.set_command_option_if_given :no_prune, options["no-prune"]
Bundler.settings.set_command_option_if_given :no_install, options["no-install"]
Bundler.settings.set_command_option_if_given :clean, options["clean"]
normalize_groups if options[:without] || options[:with]
options[:force] = options[:redownload]
end
def warn_ambiguous_gems
# TODO: remove this when we drop Bundler 1.x support
Installer.ambiguous_gems.to_a.each do |name, installed_from_uri, *also_found_in_uris|
Bundler.ui.warn "Warning: the gem '#{name}' was found in multiple sources."
Bundler.ui.warn "Installed from: #{installed_from_uri}"
Bundler.ui.warn "Also found in:"
also_found_in_uris.each {|uri| Bundler.ui.warn " * #{uri}" }
Bundler.ui.warn "You should add a source requirement to restrict this gem to your preferred source."
Bundler.ui.warn "For example:"
Bundler.ui.warn " gem '#{name}', :source => '#{installed_from_uri}'"
Bundler.ui.warn "Then uninstall the gem '#{name}' (or delete all bundled gems) and then install again."
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/lock.rb 0000644 00000004202 15173517744 0016154 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Lock
attr_reader :options
def initialize(options)
@options = options
end
def run
unless Bundler.default_gemfile
Bundler.ui.error "Unable to find a Gemfile to lock"
exit 1
end
print = options[:print]
previous_output_stream = Bundler.ui.output_stream
Bundler.ui.output_stream = :stderr if print
Bundler::Fetcher.disable_endpoint = options["full-index"]
update = options[:update]
conservative = options[:conservative]
bundler = options[:bundler]
if update.is_a?(Array) # unlocking specific gems
Bundler::CLI::Common.ensure_all_gems_in_lockfile!(update)
update = { gems: update, conservative: conservative }
elsif update && conservative
update = { conservative: conservative }
elsif update && bundler
update = { bundler: bundler }
end
file = options[:lockfile]
file = file ? Pathname.new(file).expand_path : Bundler.default_lockfile
Bundler.settings.temporary(frozen: false) do
definition = Bundler.definition(update, file)
Bundler::CLI::Common.configure_gem_version_promoter(definition, options) if options[:update]
options["remove-platform"].each do |platform|
definition.remove_platform(platform)
end
options["add-platform"].each do |platform_string|
platform = Gem::Platform.new(platform_string)
if platform.to_s == "unknown"
Bundler.ui.error "The platform `#{platform_string}` is unknown to RubyGems and can't be added to the lockfile."
exit 1
end
definition.add_platform(platform)
end
if definition.platforms.empty?
raise InvalidOption, "Removing all platforms from the bundle is not allowed"
end
definition.resolve_remotely! unless options[:local]
if print
puts definition.to_lock
else
puts "Writing lockfile to #{file}"
definition.lock
end
end
Bundler.ui.output_stream = previous_output_stream
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/init.rb 0000644 00000002437 15173517744 0016177 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Init
attr_reader :options
def initialize(options)
@options = options
end
def run
if File.exist?(gemfile)
Bundler.ui.error "#{gemfile} already exists at #{File.expand_path(gemfile)}"
exit 1
end
unless File.writable?(Dir.pwd)
Bundler.ui.error "Can not create #{gemfile} as the current directory is not writable."
exit 1
end
if options[:gemspec]
gemspec = File.expand_path(options[:gemspec])
unless File.exist?(gemspec)
Bundler.ui.error "Gem specification #{gemspec} doesn't exist"
exit 1
end
spec = Bundler.load_gemspec_uncached(gemspec)
File.open(gemfile, "wb") do |file|
file << "# Generated from #{gemspec}\n"
file << spec.to_gemfile
end
else
File.open(File.expand_path("../templates/Gemfile", __dir__), "r") do |template|
File.open(gemfile, "wb") do |destination|
IO.copy_stream(template, destination)
end
end
end
puts "Writing new #{gemfile} to #{SharedHelpers.pwd}/#{gemfile}"
end
private
def gemfile
@gemfile ||= options[:gemfile] || Bundler.preferred_gemfile_name
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/exec.rb 0000644 00000004537 15173517744 0016163 0 ustar 00 # frozen_string_literal: true
require_relative "../current_ruby"
module Bundler
class CLI::Exec
attr_reader :options, :args, :cmd
TRAPPED_SIGNALS = %w[INT].freeze
def initialize(options, args)
@options = options
@cmd = args.shift
@args = args
@args << { close_others: !options.keep_file_descriptors? } unless Bundler.current_ruby.jruby?
end
def run
validate_cmd!
SharedHelpers.set_bundle_environment
if bin_path = Bundler.which(cmd)
if !Bundler.settings[:disable_exec_load] && ruby_shebang?(bin_path)
return kernel_load(bin_path, *args)
end
kernel_exec(bin_path, *args)
else
# exec using the given command
kernel_exec(cmd, *args)
end
end
private
def validate_cmd!
return unless cmd.nil?
Bundler.ui.error "bundler: exec needs a command to run"
exit 128
end
def kernel_exec(*args)
Kernel.exec(*args)
rescue Errno::EACCES, Errno::ENOEXEC
Bundler.ui.error "bundler: not executable: #{cmd}"
exit 126
rescue Errno::ENOENT
Bundler.ui.error "bundler: command not found: #{cmd}"
Bundler.ui.warn "Install missing gem executables with `bundle install`"
exit 127
end
def kernel_load(file, *args)
args.pop if args.last.is_a?(Hash)
ARGV.replace(args)
$0 = file
Process.setproctitle(process_title(file, args)) if Process.respond_to?(:setproctitle)
require_relative "../setup"
TRAPPED_SIGNALS.each {|s| trap(s, "DEFAULT") }
Kernel.load(file)
rescue SystemExit, SignalException
raise
rescue Exception # rubocop:disable Lint/RescueException
Bundler.ui.error "bundler: failed to load command: #{cmd} (#{file})"
Bundler::FriendlyErrors.disable!
raise
end
def process_title(file, args)
"#{file} #{args.join(" ")}".strip
end
def ruby_shebang?(file)
possibilities = [
"#!/opt/alt/ruby33/bin/ruby\n",
"#!/usr/bin/env jruby\n",
"#!/usr/bin/env truffleruby\n",
"#!#{Gem.ruby}\n",
]
if File.zero?(file)
Bundler.ui.warn "#{file} is empty"
return false
end
first_line = File.open(file, "rb") {|f| f.read(possibilities.map(&:size).max) }
possibilities.any? {|shebang| first_line.start_with?(shebang) }
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/list.rb 0000644 00000004014 15173517744 0016200 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::List
def initialize(options)
@options = options
@without_group = options["without-group"].map(&:to_sym)
@only_group = options["only-group"].map(&:to_sym)
end
def run
raise InvalidOption, "The `--only-group` and `--without-group` options cannot be used together" if @only_group.any? && @without_group.any?
raise InvalidOption, "The `--name-only` and `--paths` options cannot be used together" if @options["name-only"] && @options[:paths]
specs = if @only_group.any? || @without_group.any?
filtered_specs_by_groups
else
begin
Bundler.load.specs
rescue GemNotFound => e
Bundler.ui.error e.message
Bundler.ui.warn "Install missing gems with `bundle install`."
exit 1
end
end.reject {|s| s.name == "bundler" }.sort_by(&:name)
return Bundler.ui.info "No gems in the Gemfile" if specs.empty?
return specs.each {|s| Bundler.ui.info s.name } if @options["name-only"]
return specs.each {|s| Bundler.ui.info s.full_gem_path } if @options["paths"]
Bundler.ui.info "Gems included by the bundle:"
specs.each {|s| Bundler.ui.info " * #{s.name} (#{s.version}#{s.git_version})" }
Bundler.ui.info "Use `bundle info` to print more detailed information about a gem"
end
private
def verify_group_exists(groups)
(@without_group + @only_group).each do |group|
raise InvalidOption, "`#{group}` group could not be found." unless groups.include?(group)
end
end
def filtered_specs_by_groups
definition = Bundler.definition
groups = definition.groups
verify_group_exists(groups)
show_groups =
if @without_group.any?
groups.reject {|g| @without_group.include?(g) }
elsif @only_group.any?
groups.select {|g| @only_group.include?(g) }
else
groups
end.map(&:to_sym)
definition.specs_for(show_groups)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/clean.rb 0000644 00000001140 15173517744 0016304 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Clean
attr_reader :options
def initialize(options)
@options = options
end
def run
require_path_or_force unless options[:"dry-run"]
Bundler.load.clean(options[:"dry-run"])
end
protected
def require_path_or_force
return unless Bundler.use_system_gems? && !options[:force]
raise InvalidOption, "Cleaning all the gems on your system is dangerous! " \
"If you're sure you want to remove every system gem not in this " \
"bundle, run `bundle clean --force`."
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/show.rb 0000644 00000004333 15173517744 0016211 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Show
attr_reader :options, :gem_name, :latest_specs
def initialize(options, gem_name)
@options = options
@gem_name = gem_name
@verbose = options[:verbose] || options[:outdated]
@latest_specs = fetch_latest_specs if @verbose
end
def run
Bundler.ui.silence do
Bundler.definition.validate_runtime!
Bundler.load.lock
end
if gem_name
if gem_name == "bundler"
path = File.expand_path("../../..", __dir__)
else
spec = Bundler::CLI::Common.select_spec(gem_name, :regex_match)
return unless spec
path = spec.full_gem_path
unless File.directory?(path)
return Bundler.ui.warn "The gem #{gem_name} has been deleted. It was installed at: #{path}"
end
end
return Bundler.ui.info(path)
end
if options[:paths]
Bundler.load.specs.sort_by(&:name).map do |s|
Bundler.ui.info s.full_gem_path
end
else
Bundler.ui.info "Gems included by the bundle:"
Bundler.load.specs.sort_by(&:name).each do |s|
desc = " * #{s.name} (#{s.version}#{s.git_version})"
if @verbose
latest = latest_specs.find {|l| l.name == s.name }
Bundler.ui.info <<~END
#{desc.lstrip}
\tSummary: #{s.summary || "No description available."}
\tHomepage: #{s.homepage || "No website available."}
\tStatus: #{outdated?(s, latest) ? "Outdated - #{s.version} < #{latest.version}" : "Up to date"}
END
else
Bundler.ui.info desc
end
end
end
end
private
def fetch_latest_specs
definition = Bundler.definition(true)
if options[:outdated]
Bundler.ui.info "Fetching remote specs for outdated check...\n\n"
Bundler.ui.silence { definition.resolve_remotely! }
else
definition.resolve_with_cache!
end
Bundler.reset!
definition.specs
end
def outdated?(current, latest)
return false unless latest
Gem::Version.new(current.version) < Gem::Version.new(latest.version)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/info.rb 0000644 00000005566 15173517744 0016175 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Info
attr_reader :gem_name, :options
def initialize(options, gem_name)
@options = options
@gem_name = gem_name
end
def run
Bundler.ui.silence do
Bundler.definition.validate_runtime!
Bundler.load.lock
end
spec = spec_for_gem(gem_name)
if spec
return print_gem_path(spec) if @options[:path]
return print_gem_version(spec) if @options[:version]
print_gem_info(spec)
end
end
private
def spec_for_gem(name)
Bundler::CLI::Common.select_spec(name, :regex_match)
end
def print_gem_version(spec)
Bundler.ui.info spec.version.to_s
end
def print_gem_path(spec)
name = spec.name
if name == "bundler"
path = File.expand_path("../../..", __dir__)
else
path = spec.full_gem_path
if spec.deleted_gem?
return Bundler.ui.warn "The gem #{name} has been deleted. It was installed at: #{path}"
end
end
Bundler.ui.info path
end
def print_gem_info(spec)
metadata = spec.metadata
name = spec.name
gem_info = String.new
gem_info << " * #{name} (#{spec.version}#{spec.git_version})\n"
gem_info << "\tSummary: #{spec.summary}\n" if spec.summary
gem_info << "\tHomepage: #{spec.homepage}\n" if spec.homepage
gem_info << "\tDocumentation: #{metadata["documentation_uri"]}\n" if metadata.key?("documentation_uri")
gem_info << "\tSource Code: #{metadata["source_code_uri"]}\n" if metadata.key?("source_code_uri")
gem_info << "\tFunding: #{metadata["funding_uri"]}\n" if metadata.key?("funding_uri")
gem_info << "\tWiki: #{metadata["wiki_uri"]}\n" if metadata.key?("wiki_uri")
gem_info << "\tChangelog: #{metadata["changelog_uri"]}\n" if metadata.key?("changelog_uri")
gem_info << "\tBug Tracker: #{metadata["bug_tracker_uri"]}\n" if metadata.key?("bug_tracker_uri")
gem_info << "\tMailing List: #{metadata["mailing_list_uri"]}\n" if metadata.key?("mailing_list_uri")
gem_info << "\tPath: #{spec.full_gem_path}\n"
gem_info << "\tDefault Gem: yes\n" if spec.respond_to?(:default_gem?) && spec.default_gem?
gem_info << "\tReverse Dependencies: \n\t\t#{gem_dependencies.join("\n\t\t")}" if gem_dependencies.any?
if name != "bundler" && spec.deleted_gem?
return Bundler.ui.warn "The gem #{name} has been deleted. Gemspec information is still available though:\n#{gem_info}"
end
Bundler.ui.info gem_info
end
def gem_dependencies
@gem_dependencies ||= Bundler.definition.specs.map do |spec|
dependency = spec.dependencies.find {|dep| dep.name == gem_name }
next unless dependency
"#{spec.name} (#{spec.version}) depends on #{gem_name} (#{dependency.requirements_list.join(", ")})"
end.compact.sort
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/binstubs.rb 0000644 00000003424 15173517744 0017062 0 ustar 00 # frozen_string_literal: true
module Bundler
class CLI::Binstubs
attr_reader :options, :gems
def initialize(options, gems)
@options = options
@gems = gems
end
def run
Bundler.definition.validate_runtime!
path_option = options["path"]
path_option = nil if path_option&.empty?
Bundler.settings.set_command_option :bin, path_option if options["path"]
Bundler.settings.set_command_option_if_given :shebang, options["shebang"]
installer = Installer.new(Bundler.root, Bundler.definition)
installer_opts = {
force: options[:force],
binstubs_cmd: true,
all_platforms: options["all-platforms"],
}
if options[:all]
raise InvalidOption, "Cannot specify --all with specific gems" unless gems.empty?
@gems = Bundler.definition.specs.map(&:name)
installer_opts.delete(:binstubs_cmd)
elsif gems.empty?
Bundler.ui.error "`bundle binstubs` needs at least one gem to run."
exit 1
end
gems.each do |gem_name|
spec = Bundler.definition.specs.find {|s| s.name == gem_name }
unless spec
raise GemNotFound, Bundler::CLI::Common.gem_not_found_message(
gem_name, Bundler.definition.specs
)
end
if options[:standalone]
if gem_name == "bundler"
Bundler.ui.warn("Sorry, Bundler can only be run via RubyGems.") unless options[:all]
next
end
Bundler.settings.temporary(path: Bundler.settings[:path] || Bundler.root) do
installer.generate_standalone_bundler_executable_stubs(spec, installer_opts)
end
else
installer.generate_bundler_executable_stubs(spec, installer_opts)
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/cli/doctor.rb 0000644 00000010526 15173517744 0016524 0 ustar 00 # frozen_string_literal: true
require "rbconfig"
require "shellwords"
require "fiddle"
module Bundler
class CLI::Doctor
DARWIN_REGEX = /\s+(.+) \(compatibility /
LDD_REGEX = /\t\S+ => (\S+) \(\S+\)/
attr_reader :options
def initialize(options)
@options = options
end
def otool_available?
Bundler.which("otool")
end
def ldd_available?
Bundler.which("ldd")
end
def dylibs_darwin(path)
output = `/usr/bin/otool -L #{path.shellescape}`.chomp
dylibs = output.split("\n")[1..-1].map {|l| l.match(DARWIN_REGEX).captures[0] }.uniq
# ignore @rpath and friends
dylibs.reject {|dylib| dylib.start_with? "@" }
end
def dylibs_ldd(path)
output = `/usr/bin/ldd #{path.shellescape}`.chomp
output.split("\n").map do |l|
match = l.match(LDD_REGEX)
next if match.nil?
match.captures[0]
end.compact
end
def dylibs(path)
case RbConfig::CONFIG["host_os"]
when /darwin/
return [] unless otool_available?
dylibs_darwin(path)
when /(linux|solaris|bsd)/
return [] unless ldd_available?
dylibs_ldd(path)
else # Windows, etc.
Bundler.ui.warn("Dynamic library check not supported on this platform.")
[]
end
end
def bundles_for_gem(spec)
Dir.glob("#{spec.full_gem_path}/**/*.bundle")
end
def check!
require_relative "check"
Bundler::CLI::Check.new({}).run
end
def run
Bundler.ui.level = "warn" if options[:quiet]
Bundler.settings.validate!
check!
definition = Bundler.definition
broken_links = {}
definition.specs.each do |spec|
bundles_for_gem(spec).each do |bundle|
bad_paths = dylibs(bundle).select do |f|
Fiddle.dlopen(f)
false
rescue Fiddle::DLError
true
end
if bad_paths.any?
broken_links[spec] ||= []
broken_links[spec].concat(bad_paths)
end
end
end
permissions_valid = check_home_permissions
if broken_links.any?
message = "The following gems are missing OS dependencies:"
broken_links.map do |spec, paths|
paths.uniq.map do |path|
"\n * #{spec.name}: #{path}"
end
end.flatten.sort.each {|m| message += m }
raise ProductionError, message
elsif !permissions_valid
Bundler.ui.info "No issues found with the installed bundle"
end
end
private
def check_home_permissions
require "find"
files_not_readable_or_writable = []
files_not_rw_and_owned_by_different_user = []
files_not_owned_by_current_user_but_still_rw = []
broken_symlinks = []
Find.find(Bundler.bundle_path.to_s).each do |f|
if !File.exist?(f)
broken_symlinks << f
elsif !File.writable?(f) || !File.readable?(f)
if File.stat(f).uid != Process.uid
files_not_rw_and_owned_by_different_user << f
else
files_not_readable_or_writable << f
end
elsif File.stat(f).uid != Process.uid
files_not_owned_by_current_user_but_still_rw << f
end
end
ok = true
if broken_symlinks.any?
Bundler.ui.warn "Broken links exist in the Bundler home. Please report them to the offending gem's upstream repo. These files are:\n - #{broken_symlinks.join("\n - ")}"
ok = false
end
if files_not_owned_by_current_user_but_still_rw.any?
Bundler.ui.warn "Files exist in the Bundler home that are owned by another " \
"user, but are still readable/writable. These files are:\n - #{files_not_owned_by_current_user_but_still_rw.join("\n - ")}"
ok = false
end
if files_not_rw_and_owned_by_different_user.any?
Bundler.ui.warn "Files exist in the Bundler home that are owned by another " \
"user, and are not readable/writable. These files are:\n - #{files_not_rw_and_owned_by_different_user.join("\n - ")}"
ok = false
end
if files_not_readable_or_writable.any?
Bundler.ui.warn "Files exist in the Bundler home that are not " \
"readable/writable by the current user. These files are:\n - #{files_not_readable_or_writable.join("\n - ")}"
ok = false
end
ok
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/uri_credentials_filter.rb 0000644 00000002424 15173517744 0021202 0 ustar 00 # frozen_string_literal: true
module Bundler
module URICredentialsFilter
module_function
def credential_filtered_uri(uri_to_anonymize)
return uri_to_anonymize if uri_to_anonymize.nil?
uri = uri_to_anonymize.dup
if uri.is_a?(String)
return uri if File.exist?(uri)
require_relative "vendored_uri"
uri = Gem::URI(uri)
end
if uri.userinfo
# oauth authentication
if uri.password == "x-oauth-basic" || uri.password == "x"
# URI as string does not display with password if no user is set
oauth_designation = uri.password
uri.user = oauth_designation
end
uri.password = nil
end
return uri.to_s if uri_to_anonymize.is_a?(String)
uri
rescue Gem::URI::InvalidURIError # uri is not canonical uri scheme
uri
end
def credential_filtered_string(str_to_filter, uri)
return str_to_filter if uri.nil? || str_to_filter.nil?
str_with_no_credentials = str_to_filter.dup
anonymous_uri_str = credential_filtered_uri(uri).to_s
uri_str = uri.to_s
if anonymous_uri_str != uri_str
str_with_no_credentials = str_with_no_credentials.gsub(uri_str, anonymous_uri_str)
end
str_with_no_credentials
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_fileutils.rb 0000644 00000000145 15173517744 0020345 0 ustar 00 # frozen_string_literal: true
module Bundler; end
require_relative "vendor/fileutils/lib/fileutils"
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/solve_failure.rb 0000644 00000000622 15173517744 0024773 0 ustar 00 require_relative 'failure_writer'
module Bundler::PubGrub
class SolveFailure < StandardError
attr_reader :incompatibility
def initialize(incompatibility)
@incompatibility = incompatibility
end
def to_s
"Could not find compatible versions\n\n#{explanation}"
end
def explanation
@explanation ||= FailureWriter.new(@incompatibility).write
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/version_solver.rb 0000644 00000016041 15173517744 0025215 0 ustar 00 require_relative 'partial_solution'
require_relative 'term'
require_relative 'incompatibility'
require_relative 'solve_failure'
module Bundler::PubGrub
class VersionSolver
attr_reader :logger
attr_reader :source
attr_reader :solution
def initialize(source:, root: Package.root, logger: Bundler::PubGrub.logger)
@logger = logger
@source = source
# { package => [incompatibility, ...]}
@incompatibilities = Hash.new do |h, k|
h[k] = []
end
@seen_incompatibilities = {}
@solution = PartialSolution.new
add_incompatibility Incompatibility.new([
Term.new(VersionConstraint.any(root), false)
], cause: :root)
propagate(root)
end
def solved?
solution.unsatisfied.empty?
end
# Returns true if there is more work to be done, false otherwise
def work
return false if solved?
next_package = choose_package_version
propagate(next_package)
if solved?
logger.info { "Solution found after #{solution.attempted_solutions} attempts:" }
solution.decisions.each do |package, version|
next if Package.root?(package)
logger.info { "* #{package} #{version}" }
end
false
else
true
end
end
def solve
work until solved?
solution.decisions
end
alias_method :result, :solve
private
def propagate(initial_package)
changed = [initial_package]
while package = changed.shift
@incompatibilities[package].reverse_each do |incompatibility|
result = propagate_incompatibility(incompatibility)
if result == :conflict
root_cause = resolve_conflict(incompatibility)
changed.clear
changed << propagate_incompatibility(root_cause)
elsif result # should be a Package
changed << result
end
end
changed.uniq!
end
end
def propagate_incompatibility(incompatibility)
unsatisfied = nil
incompatibility.terms.each do |term|
relation = solution.relation(term)
if relation == :disjoint
return nil
elsif relation == :overlap
# If more than one term is inconclusive, we can't deduce anything
return nil if unsatisfied
unsatisfied = term
end
end
if !unsatisfied
return :conflict
end
logger.debug { "derived: #{unsatisfied.invert}" }
solution.derive(unsatisfied.invert, incompatibility)
unsatisfied.package
end
def next_package_to_try
solution.unsatisfied.min_by do |term|
package = term.package
range = term.constraint.range
matching_versions = source.versions_for(package, range)
higher_versions = source.versions_for(package, range.upper_invert)
[matching_versions.count <= 1 ? 0 : 1, higher_versions.count]
end.package
end
def choose_package_version
if solution.unsatisfied.empty?
logger.info "No packages unsatisfied. Solving complete!"
return nil
end
package = next_package_to_try
unsatisfied_term = solution.unsatisfied.find { |t| t.package == package }
version = source.versions_for(package, unsatisfied_term.constraint.range).first
logger.debug { "attempting #{package} #{version}" }
if version.nil?
add_incompatibility source.no_versions_incompatibility_for(package, unsatisfied_term)
return package
end
conflict = false
source.incompatibilities_for(package, version).each do |incompatibility|
if @seen_incompatibilities.include?(incompatibility)
logger.debug { "knew: #{incompatibility}" }
next
end
@seen_incompatibilities[incompatibility] = true
add_incompatibility incompatibility
conflict ||= incompatibility.terms.all? do |term|
term.package == package || solution.satisfies?(term)
end
end
unless conflict
logger.info { "selected #{package} #{version}" }
solution.decide(package, version)
else
logger.info { "conflict: #{conflict.inspect}" }
end
package
end
def resolve_conflict(incompatibility)
logger.info { "conflict: #{incompatibility}" }
new_incompatibility = nil
while !incompatibility.failure?
most_recent_term = nil
most_recent_satisfier = nil
difference = nil
previous_level = 1
incompatibility.terms.each do |term|
satisfier = solution.satisfier(term)
if most_recent_satisfier.nil?
most_recent_term = term
most_recent_satisfier = satisfier
elsif most_recent_satisfier.index < satisfier.index
previous_level = [previous_level, most_recent_satisfier.decision_level].max
most_recent_term = term
most_recent_satisfier = satisfier
difference = nil
else
previous_level = [previous_level, satisfier.decision_level].max
end
if most_recent_term == term
difference = most_recent_satisfier.term.difference(most_recent_term)
if difference.empty?
difference = nil
else
difference_satisfier = solution.satisfier(difference.inverse)
previous_level = [previous_level, difference_satisfier.decision_level].max
end
end
end
if previous_level < most_recent_satisfier.decision_level ||
most_recent_satisfier.decision?
logger.info { "backtracking to #{previous_level}" }
solution.backtrack(previous_level)
if new_incompatibility
add_incompatibility(new_incompatibility)
end
return incompatibility
end
new_terms = []
new_terms += incompatibility.terms - [most_recent_term]
new_terms += most_recent_satisfier.cause.terms.reject { |term|
term.package == most_recent_satisfier.term.package
}
if difference
new_terms << difference.invert
end
new_incompatibility = Incompatibility.new(new_terms, cause: Incompatibility::ConflictCause.new(incompatibility, most_recent_satisfier.cause))
if incompatibility.to_s == new_incompatibility.to_s
logger.info { "!! failed to resolve conflicts, this shouldn't have happened" }
break
end
incompatibility = new_incompatibility
partially = difference ? " partially" : ""
logger.info { "! #{most_recent_term} is#{partially} satisfied by #{most_recent_satisfier.term}" }
logger.info { "! which is caused by #{most_recent_satisfier.cause}" }
logger.info { "! thus #{incompatibility}" }
end
raise SolveFailure.new(incompatibility)
end
def add_incompatibility(incompatibility)
logger.debug { "fact: #{incompatibility}" }
incompatibility.terms.each do |term|
package = term.package
@incompatibilities[package] << incompatibility
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/assignment.rb 0000644 00000001004 15173517744 0024277 0 ustar 00 module Bundler::PubGrub
class Assignment
attr_reader :term, :cause, :decision_level, :index
def initialize(term, cause, decision_level, index)
@term = term
@cause = cause
@decision_level = decision_level
@index = index
end
def self.decision(package, version, decision_level, index)
term = Term.new(VersionConstraint.exact(package, version), true)
new(term, :decision, decision_level, index)
end
def decision?
cause == :decision
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/failure_writer.rb 0000644 00000013130 15173517744 0025155 0 ustar 00 module Bundler::PubGrub
class FailureWriter
def initialize(root)
@root = root
# { Incompatibility => Integer }
@derivations = {}
# [ [ String, Integer or nil ] ]
@lines = []
# { Incompatibility => Integer }
@line_numbers = {}
count_derivations(root)
end
def write
return @root.to_s unless @root.conflict?
visit(@root)
padding = @line_numbers.empty? ? 0 : "(#{@line_numbers.values.last}) ".length
@lines.map do |message, number|
next "" if message.empty?
lead = number ? "(#{number}) " : ""
lead = lead.ljust(padding)
message = message.gsub("\n", "\n" + " " * (padding + 2))
"#{lead}#{message}"
end.join("\n")
end
private
def write_line(incompatibility, message, numbered:)
if numbered
number = @line_numbers.length + 1
@line_numbers[incompatibility] = number
end
@lines << [message, number]
end
def visit(incompatibility, conclusion: false)
raise unless incompatibility.conflict?
numbered = conclusion || @derivations[incompatibility] > 1;
conjunction = conclusion || incompatibility == @root ? "So," : "And"
cause = incompatibility.cause
if cause.conflict.conflict? && cause.other.conflict?
conflict_line = @line_numbers[cause.conflict]
other_line = @line_numbers[cause.other]
if conflict_line && other_line
write_line(
incompatibility,
"Because #{cause.conflict} (#{conflict_line})\nand #{cause.other} (#{other_line}),\n#{incompatibility}.",
numbered: numbered
)
elsif conflict_line || other_line
with_line = conflict_line ? cause.conflict : cause.other
without_line = conflict_line ? cause.other : cause.conflict
line = @line_numbers[with_line]
visit(without_line);
write_line(
incompatibility,
"#{conjunction} because #{with_line} (#{line}),\n#{incompatibility}.",
numbered: numbered
)
else
single_line_conflict = single_line?(cause.conflict.cause)
single_line_other = single_line?(cause.other.cause)
if single_line_conflict || single_line_other
first = single_line_other ? cause.conflict : cause.other
second = single_line_other ? cause.other : cause.conflict
visit(first)
visit(second)
write_line(
incompatibility,
"Thus, #{incompatibility}.",
numbered: numbered
)
else
visit(cause.conflict, conclusion: true)
@lines << ["", nil]
visit(cause.other)
write_line(
incompatibility,
"#{conjunction} because #{cause.conflict} (#{@line_numbers[cause.conflict]}),\n#{incompatibility}.",
numbered: numbered
)
end
end
elsif cause.conflict.conflict? || cause.other.conflict?
derived = cause.conflict.conflict? ? cause.conflict : cause.other
ext = cause.conflict.conflict? ? cause.other : cause.conflict
derived_line = @line_numbers[derived]
if derived_line
write_line(
incompatibility,
"Because #{ext}\nand #{derived} (#{derived_line}),\n#{incompatibility}.",
numbered: numbered
)
elsif collapsible?(derived)
derived_cause = derived.cause
if derived_cause.conflict.conflict?
collapsed_derived = derived_cause.conflict
collapsed_ext = derived_cause.other
else
collapsed_derived = derived_cause.other
collapsed_ext = derived_cause.conflict
end
visit(collapsed_derived)
write_line(
incompatibility,
"#{conjunction} because #{collapsed_ext}\nand #{ext},\n#{incompatibility}.",
numbered: numbered
)
else
visit(derived)
write_line(
incompatibility,
"#{conjunction} because #{ext},\n#{incompatibility}.",
numbered: numbered
)
end
else
write_line(
incompatibility,
"Because #{cause.conflict}\nand #{cause.other},\n#{incompatibility}.",
numbered: numbered
)
end
end
def single_line?(cause)
!cause.conflict.conflict? && !cause.other.conflict?
end
def collapsible?(incompatibility)
return false if @derivations[incompatibility] > 1
cause = incompatibility.cause
# If incompatibility is derived from two derived incompatibilities,
# there are too many transitive causes to display concisely.
return false if cause.conflict.conflict? && cause.other.conflict?
# If incompatibility is derived from two external incompatibilities, it
# tends to be confusing to collapse it.
return false unless cause.conflict.conflict? || cause.other.conflict?
# If incompatibility's internal cause is numbered, collapsing it would
# get too noisy.
complex = cause.conflict.conflict? ? cause.conflict : cause.other
!@line_numbers.has_key?(complex)
end
def count_derivations(incompatibility)
if @derivations.has_key?(incompatibility)
@derivations[incompatibility] += 1
else
@derivations[incompatibility] = 1
if incompatibility.conflict?
cause = incompatibility.cause
count_derivations(cause.conflict)
count_derivations(cause.other)
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/version_constraint.rb 0000644 00000005042 15173517744 0026066 0 ustar 00 require_relative 'version_range'
module Bundler::PubGrub
class VersionConstraint
attr_reader :package, :range
# @param package [Bundler::PubGrub::Package]
# @param range [Bundler::PubGrub::VersionRange]
def initialize(package, range: nil)
@package = package
@range = range
end
def hash
package.hash ^ range.hash
end
def ==(other)
package == other.package &&
range == other.range
end
def eql?(other)
package.eql?(other.package) &&
range.eql?(other.range)
end
class << self
def exact(package, version)
range = VersionRange.new(min: version, max: version, include_min: true, include_max: true)
new(package, range: range)
end
def any(package)
new(package, range: VersionRange.any)
end
def empty(package)
new(package, range: VersionRange.empty)
end
end
def intersect(other)
unless package == other.package
raise ArgumentError, "Can only intersect between VersionConstraint of the same package"
end
self.class.new(package, range: range.intersect(other.range))
end
def union(other)
unless package == other.package
raise ArgumentError, "Can only intersect between VersionConstraint of the same package"
end
self.class.new(package, range: range.union(other.range))
end
def invert
new_range = range.invert
self.class.new(package, range: new_range)
end
def difference(other)
intersect(other.invert)
end
def allows_all?(other)
range.allows_all?(other.range)
end
def allows_any?(other)
range.intersects?(other.range)
end
def subset?(other)
other.allows_all?(self)
end
def overlap?(other)
other.allows_any?(self)
end
def disjoint?(other)
!overlap?(other)
end
def relation(other)
if subset?(other)
:subset
elsif overlap?(other)
:overlap
else
:disjoint
end
end
def to_s(allow_every: false)
if Package.root?(package)
package.to_s
elsif allow_every && any?
"every version of #{package}"
else
"#{package} #{constraint_string}"
end
end
def constraint_string
if any?
">= 0"
else
range.to_s
end
end
def empty?
range.empty?
end
# Does this match every version of the package
def any?
range.any?
end
def inspect
"#<#{self.class} #{self}>"
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/static_package_source.rb 0000644 00000002740 15173517744 0026461 0 ustar 00 require_relative 'package'
require_relative 'rubygems'
require_relative 'version_constraint'
require_relative 'incompatibility'
require_relative 'basic_package_source'
module Bundler::PubGrub
class StaticPackageSource < BasicPackageSource
class DSL
def initialize(packages, root_deps)
@packages = packages
@root_deps = root_deps
end
def root(deps:)
@root_deps.update(deps)
end
def add(name, version, deps: {})
version = Gem::Version.new(version)
@packages[name] ||= {}
raise ArgumentError, "#{name} #{version} declared twice" if @packages[name].key?(version)
@packages[name][version] = clean_deps(name, version, deps)
end
private
# Exclude redundant self-referencing dependencies
def clean_deps(name, version, deps)
deps.reject {|dep_name, req| name == dep_name && Bundler::PubGrub::RubyGems.parse_range(req).include?(version) }
end
end
def initialize
@root_deps = {}
@packages = {}
yield DSL.new(@packages, @root_deps)
super()
end
def all_versions_for(package)
@packages[package].keys
end
def root_dependencies
@root_deps
end
def dependencies_for(package, version)
@packages[package][version]
end
def parse_dependency(package, dependency)
return false unless @packages.key?(package)
Bundler::PubGrub::RubyGems.parse_constraint(package, dependency)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/version.rb 0000644 00000000060 15173517744 0023615 0 ustar 00 module Bundler::PubGrub
VERSION = "0.5.0"
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/partial_solution.rb 0000644 00000005325 15173517744 0025531 0 ustar 00 require_relative 'assignment'
module Bundler::PubGrub
class PartialSolution
attr_reader :assignments, :decisions
attr_reader :attempted_solutions
def initialize
reset!
@attempted_solutions = 1
@backtracking = false
end
def decision_level
@decisions.length
end
def relation(term)
package = term.package
return :overlap if !@terms.key?(package)
@relation_cache[package][term] ||=
@terms[package].relation(term)
end
def satisfies?(term)
relation(term) == :subset
end
def derive(term, cause)
add_assignment(Assignment.new(term, cause, decision_level, assignments.length))
end
def satisfier(term)
assignment =
@assignments_by[term.package].bsearch do |assignment_by|
@cumulative_assignments[assignment_by].satisfies?(term)
end
assignment || raise("#{term} unsatisfied")
end
# A list of unsatisfied terms
def unsatisfied
@required.keys.reject do |package|
@decisions.key?(package)
end.map do |package|
@terms[package]
end
end
def decide(package, version)
@attempted_solutions += 1 if @backtracking
@backtracking = false;
decisions[package] = version
assignment = Assignment.decision(package, version, decision_level, assignments.length)
add_assignment(assignment)
end
def backtrack(previous_level)
@backtracking = true
new_assignments = assignments.select do |assignment|
assignment.decision_level <= previous_level
end
new_decisions = Hash[decisions.first(previous_level)]
reset!
@decisions = new_decisions
new_assignments.each do |assignment|
add_assignment(assignment)
end
end
private
def reset!
# { Array<Assignment> }
@assignments = []
# { Package => Array<Assignment> }
@assignments_by = Hash.new { |h,k| h[k] = [] }
@cumulative_assignments = {}.compare_by_identity
# { Package => Package::Version }
@decisions = {}
# { Package => Term }
@terms = {}
@relation_cache = Hash.new { |h,k| h[k] = {} }
# { Package => Boolean }
@required = {}
end
def add_assignment(assignment)
term = assignment.term
package = term.package
@assignments << assignment
@assignments_by[package] << assignment
@required[package] = true if term.positive?
if @terms.key?(package)
old_term = @terms[package]
@terms[package] = old_term.intersect(term)
else
@terms[package] = term
end
@relation_cache[package].clear
@cumulative_assignments[assignment] = @terms[package]
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/rubygems.rb 0000644 00000002513 15173517744 0023772 0 ustar 00 module Bundler::PubGrub
module RubyGems
extend self
def requirement_to_range(requirement)
ranges = requirement.requirements.map do |(op, ver)|
case op
when "~>"
name = "~> #{ver}"
bump = ver.class.new(ver.bump.to_s + ".A")
VersionRange.new(name: name, min: ver, max: bump, include_min: true)
when ">"
VersionRange.new(min: ver)
when ">="
VersionRange.new(min: ver, include_min: true)
when "<"
VersionRange.new(max: ver)
when "<="
VersionRange.new(max: ver, include_max: true)
when "="
VersionRange.new(min: ver, max: ver, include_min: true, include_max: true)
when "!="
VersionRange.new(min: ver, max: ver, include_min: true, include_max: true).invert
else
raise "bad version specifier: #{op}"
end
end
ranges.inject(&:intersect)
end
def requirement_to_constraint(package, requirement)
Bundler::PubGrub::VersionConstraint.new(package, range: requirement_to_range(requirement))
end
def parse_range(dep)
requirement_to_range(Gem::Requirement.new(dep))
end
def parse_constraint(package, dep)
range = parse_range(dep)
Bundler::PubGrub::VersionConstraint.new(package, range: range)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/package.rb 0000644 00000001130 15173517744 0023522 0 ustar 00 # frozen_string_literal: true
module Bundler::PubGrub
class Package
attr_reader :name
def initialize(name)
@name = name
end
def inspect
"#<#{self.class} #{name.inspect}>"
end
def <=>(other)
name <=> other.name
end
ROOT = Package.new(:root)
ROOT_VERSION = 0
def self.root
ROOT
end
def self.root_version
ROOT_VERSION
end
def self.root?(package)
if package.respond_to?(:root?)
package.root?
else
package == root
end
end
def to_s
name.to_s
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/term.rb 0000644 00000004604 15173517744 0023107 0 ustar 00 module Bundler::PubGrub
class Term
attr_reader :package, :constraint, :positive
def initialize(constraint, positive)
@constraint = constraint
@package = @constraint.package
@positive = positive
end
def to_s(allow_every: false)
if positive
@constraint.to_s(allow_every: allow_every)
else
"not #{@constraint}"
end
end
def hash
constraint.hash ^ positive.hash
end
def eql?(other)
positive == other.positive &&
constraint.eql?(other.constraint)
end
def invert
self.class.new(@constraint, !@positive)
end
alias_method :inverse, :invert
def intersect(other)
raise ArgumentError, "packages must match" if package != other.package
if positive? && other.positive?
self.class.new(constraint.intersect(other.constraint), true)
elsif negative? && other.negative?
self.class.new(constraint.union(other.constraint), false)
else
positive = positive? ? self : other
negative = negative? ? self : other
self.class.new(positive.constraint.intersect(negative.constraint.invert), true)
end
end
def difference(other)
intersect(other.invert)
end
def relation(other)
if positive? && other.positive?
constraint.relation(other.constraint)
elsif negative? && other.positive?
if constraint.allows_all?(other.constraint)
:disjoint
else
:overlap
end
elsif positive? && other.negative?
if !other.constraint.allows_any?(constraint)
:subset
elsif other.constraint.allows_all?(constraint)
:disjoint
else
:overlap
end
elsif negative? && other.negative?
if constraint.allows_all?(other.constraint)
:subset
else
:overlap
end
else
raise
end
end
def normalized_constraint
@normalized_constraint ||= positive ? constraint : constraint.invert
end
def satisfies?(other)
raise ArgumentError, "packages must match" unless package == other.package
relation(other) == :subset
end
def positive?
@positive
end
def negative?
!positive?
end
def empty?
@empty ||= normalized_constraint.empty?
end
def inspect
"#<#{self.class} #{self}>"
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb 0000644 00000010110 15173517744 0025325 0 ustar 00 module Bundler::PubGrub
class Incompatibility
ConflictCause = Struct.new(:incompatibility, :satisfier) do
alias_method :conflict, :incompatibility
alias_method :other, :satisfier
end
InvalidDependency = Struct.new(:package, :constraint) do
end
NoVersions = Struct.new(:constraint) do
end
attr_reader :terms, :cause
def initialize(terms, cause:, custom_explanation: nil)
@cause = cause
@terms = cleanup_terms(terms)
@custom_explanation = custom_explanation
if cause == :dependency && @terms.length != 2
raise ArgumentError, "a dependency Incompatibility must have exactly two terms. Got #{@terms.inspect}"
end
end
def hash
cause.hash ^ terms.hash
end
def eql?(other)
cause.eql?(other.cause) &&
terms.eql?(other.terms)
end
def failure?
terms.empty? || (terms.length == 1 && Package.root?(terms[0].package) && terms[0].positive?)
end
def conflict?
ConflictCause === cause
end
# Returns all external incompatibilities in this incompatibility's
# derivation graph
def external_incompatibilities
if conflict?
[
cause.conflict,
cause.other
].flat_map(&:external_incompatibilities)
else
[this]
end
end
def to_s
return @custom_explanation if @custom_explanation
case cause
when :root
"(root dependency)"
when :dependency
"#{terms[0].to_s(allow_every: true)} depends on #{terms[1].invert}"
when Bundler::PubGrub::Incompatibility::InvalidDependency
"#{terms[0].to_s(allow_every: true)} depends on unknown package #{cause.package}"
when Bundler::PubGrub::Incompatibility::NoVersions
"no versions satisfy #{cause.constraint}"
when Bundler::PubGrub::Incompatibility::ConflictCause
if failure?
"version solving has failed"
elsif terms.length == 1
term = terms[0]
if term.positive?
if term.constraint.any?
"#{term.package} cannot be used"
else
"#{term.to_s(allow_every: true)} cannot be used"
end
else
"#{term.invert} is required"
end
else
if terms.all?(&:positive?)
if terms.length == 2
"#{terms[0].to_s(allow_every: true)} is incompatible with #{terms[1]}"
else
"one of #{terms.map(&:to_s).join(" or ")} must be false"
end
elsif terms.all?(&:negative?)
if terms.length == 2
"either #{terms[0].invert} or #{terms[1].invert}"
else
"one of #{terms.map(&:invert).join(" or ")} must be true";
end
else
positive = terms.select(&:positive?)
negative = terms.select(&:negative?).map(&:invert)
if positive.length == 1
"#{positive[0].to_s(allow_every: true)} requires #{negative.join(" or ")}"
else
"if #{positive.join(" and ")} then #{negative.join(" or ")}"
end
end
end
else
raise "unhandled cause: #{cause.inspect}"
end
end
def inspect
"#<#{self.class} #{to_s}>"
end
def pretty_print(q)
q.group 2, "#<#{self.class}", ">" do
q.breakable
q.text to_s
q.breakable
q.text " caused by "
q.pp @cause
end
end
private
def cleanup_terms(terms)
terms.each do |term|
raise "#{term.inspect} must be a term" unless term.is_a?(Term)
end
if terms.length != 1 && ConflictCause === cause
terms = terms.reject do |term|
term.positive? && Package.root?(term.package)
end
end
# Optimized simple cases
return terms if terms.length <= 1
return terms if terms.length == 2 && terms[0].package != terms[1].package
terms.group_by(&:package).map do |package, common_terms|
common_terms.inject do |acc, term|
acc.intersect(term)
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/basic_package_source.rb 0000644 00000014021 15173517744 0026246 0 ustar 00 require_relative 'version_constraint'
require_relative 'incompatibility'
module Bundler::PubGrub
# Types:
#
# Where possible, Bundler::PubGrub will accept user-defined types, so long as they quack.
#
# ## "Package":
#
# This class will be used to represent the various packages being solved for.
# .to_s will be called when displaying errors and debugging info, it should
# probably return the package's name.
# It must also have a reasonable definition of #== and #hash
#
# Example classes: String ("rails")
#
#
# ## "Version":
#
# This class will be used to represent a single version number.
#
# Versions don't need to store their associated package, however they will
# only be compared against other versions of the same package.
#
# It must be Comparible (and implement <=> reasonably)
#
# Example classes: Gem::Version, Integer
#
#
# ## "Dependency"
#
# This class represents the requirement one package has on another. It is
# returned by dependencies_for(package, version) and will be passed to
# parse_dependency to convert it to a format Bundler::PubGrub understands.
#
# It must also have a reasonable definition of #==
#
# Example classes: String ("~> 1.0"), Gem::Requirement
#
class BasicPackageSource
# Override me!
#
# This is called per package to find all possible versions of a package.
#
# It is called at most once per-package
#
# Returns: Array of versions for a package, in preferred order of selection
def all_versions_for(package)
raise NotImplementedError
end
# Override me!
#
# Returns: Hash in the form of { package => requirement, ... }
def dependencies_for(package, version)
raise NotImplementedError
end
# Override me!
#
# Convert a (user-defined) dependency into a format Bundler::PubGrub understands.
#
# Package is passed to this method but for many implementations is not
# needed.
#
# Returns: either a Bundler::PubGrub::VersionRange, Bundler::PubGrub::VersionUnion, or a
# Bundler::PubGrub::VersionConstraint
def parse_dependency(package, dependency)
raise NotImplementedError
end
# Override me!
#
# If not overridden, this will call dependencies_for with the root package.
#
# Returns: Hash in the form of { package => requirement, ... } (see dependencies_for)
def root_dependencies
dependencies_for(@root_package, @root_version)
end
# Override me (maybe)
#
# If not overridden, the order returned by all_versions_for will be used
#
# Returns: Array of versions in preferred order
def sort_versions_by_preferred(package, sorted_versions)
indexes = @version_indexes[package]
sorted_versions.sort_by { |version| indexes[version] }
end
def initialize
@root_package = Package.root
@root_version = Package.root_version
@cached_versions = Hash.new do |h,k|
if k == @root_package
h[k] = [@root_version]
else
h[k] = all_versions_for(k)
end
end
@sorted_versions = Hash.new { |h,k| h[k] = @cached_versions[k].sort }
@version_indexes = Hash.new { |h,k| h[k] = @cached_versions[k].each.with_index.to_h }
@cached_dependencies = Hash.new do |packages, package|
if package == @root_package
packages[package] = {
@root_version => root_dependencies
}
else
packages[package] = Hash.new do |versions, version|
versions[version] = dependencies_for(package, version)
end
end
end
end
def versions_for(package, range=VersionRange.any)
versions = range.select_versions(@sorted_versions[package])
# Conditional avoids (among other things) calling
# sort_versions_by_preferred with the root package
if versions.size > 1
sort_versions_by_preferred(package, versions)
else
versions
end
end
def no_versions_incompatibility_for(_package, unsatisfied_term)
cause = Incompatibility::NoVersions.new(unsatisfied_term)
Incompatibility.new([unsatisfied_term], cause: cause)
end
def incompatibilities_for(package, version)
package_deps = @cached_dependencies[package]
sorted_versions = @sorted_versions[package]
package_deps[version].map do |dep_package, dep_constraint_name|
low = high = sorted_versions.index(version)
# find version low such that all >= low share the same dep
while low > 0 &&
package_deps[sorted_versions[low - 1]][dep_package] == dep_constraint_name
low -= 1
end
low =
if low == 0
nil
else
sorted_versions[low]
end
# find version high such that all < high share the same dep
while high < sorted_versions.length &&
package_deps[sorted_versions[high]][dep_package] == dep_constraint_name
high += 1
end
high =
if high == sorted_versions.length
nil
else
sorted_versions[high]
end
range = VersionRange.new(min: low, max: high, include_min: true)
self_constraint = VersionConstraint.new(package, range: range)
if !@packages.include?(dep_package)
# no such package -> this version is invalid
end
dep_constraint = parse_dependency(dep_package, dep_constraint_name)
if !dep_constraint
# falsey indicates this dependency was invalid
cause = Bundler::PubGrub::Incompatibility::InvalidDependency.new(dep_package, dep_constraint_name)
return [Incompatibility.new([Term.new(self_constraint, true)], cause: cause)]
elsif !dep_constraint.is_a?(VersionConstraint)
# Upgrade range/union to VersionConstraint
dep_constraint = VersionConstraint.new(dep_package, range: dep_constraint)
end
Incompatibility.new([Term.new(self_constraint, true), Term.new(dep_constraint, false)], cause: :dependency)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/version_range.rb 0000644 00000020257 15173517744 0025003 0 ustar 00 # frozen_string_literal: true
module Bundler::PubGrub
class VersionRange
attr_reader :min, :max, :include_min, :include_max
alias_method :include_min?, :include_min
alias_method :include_max?, :include_max
class Empty < VersionRange
undef_method :min, :max
undef_method :include_min, :include_min?
undef_method :include_max, :include_max?
def initialize
end
def empty?
true
end
def eql?(other)
other.empty?
end
def hash
[].hash
end
def intersects?(_)
false
end
def intersect(other)
self
end
def allows_all?(other)
other.empty?
end
def include?(_)
false
end
def any?
false
end
def to_s
"(no versions)"
end
def ==(other)
other.class == self.class
end
def invert
VersionRange.any
end
def select_versions(_)
[]
end
end
EMPTY = Empty.new
Empty.singleton_class.undef_method(:new)
def self.empty
EMPTY
end
def self.any
new
end
def initialize(min: nil, max: nil, include_min: false, include_max: false, name: nil)
@min = min
@max = max
@include_min = include_min
@include_max = include_max
@name = name
end
def hash
@hash ||= min.hash ^ max.hash ^ include_min.hash ^ include_max.hash
end
def eql?(other)
if other.is_a?(VersionRange)
!other.empty? &&
min.eql?(other.min) &&
max.eql?(other.max) &&
include_min.eql?(other.include_min) &&
include_max.eql?(other.include_max)
else
ranges.eql?(other.ranges)
end
end
def ranges
[self]
end
def include?(version)
compare_version(version) == 0
end
# Partitions passed versions into [lower, within, higher]
#
# versions must be sorted
def partition_versions(versions)
min_index =
if !min || versions.empty?
0
elsif include_min?
(0..versions.size).bsearch { |i| versions[i].nil? || versions[i] >= min }
else
(0..versions.size).bsearch { |i| versions[i].nil? || versions[i] > min }
end
lower = versions.slice(0, min_index)
versions = versions.slice(min_index, versions.size)
max_index =
if !max || versions.empty?
versions.size
elsif include_max?
(0..versions.size).bsearch { |i| versions[i].nil? || versions[i] > max }
else
(0..versions.size).bsearch { |i| versions[i].nil? || versions[i] >= max }
end
[
lower,
versions.slice(0, max_index),
versions.slice(max_index, versions.size)
]
end
# Returns versions which are included by this range.
#
# versions must be sorted
def select_versions(versions)
return versions if any?
partition_versions(versions)[1]
end
def compare_version(version)
if min
case version <=> min
when -1
return -1
when 0
return -1 if !include_min
when 1
end
end
if max
case version <=> max
when -1
when 0
return 1 if !include_max
when 1
return 1
end
end
0
end
def strictly_lower?(other)
return false if !max || !other.min
case max <=> other.min
when 0
!include_max || !other.include_min
when -1
true
when 1
false
end
end
def strictly_higher?(other)
other.strictly_lower?(self)
end
def intersects?(other)
return false if other.empty?
return other.intersects?(self) if other.is_a?(VersionUnion)
!strictly_lower?(other) && !strictly_higher?(other)
end
alias_method :allows_any?, :intersects?
def intersect(other)
return other if other.empty?
return other.intersect(self) if other.is_a?(VersionUnion)
min_range =
if !min
other
elsif !other.min
self
else
case min <=> other.min
when 0
include_min ? other : self
when -1
other
when 1
self
end
end
max_range =
if !max
other
elsif !other.max
self
else
case max <=> other.max
when 0
include_max ? other : self
when -1
self
when 1
other
end
end
if !min_range.equal?(max_range) && min_range.min && max_range.max
case min_range.min <=> max_range.max
when -1
when 0
if !min_range.include_min || !max_range.include_max
return EMPTY
end
when 1
return EMPTY
end
end
VersionRange.new(
min: min_range.min,
include_min: min_range.include_min,
max: max_range.max,
include_max: max_range.include_max
)
end
# The span covered by two ranges
#
# If self and other are contiguous, this builds a union of the two ranges.
# (if they aren't you are probably calling the wrong method)
def span(other)
return self if other.empty?
min_range =
if !min
self
elsif !other.min
other
else
case min <=> other.min
when 0
include_min ? self : other
when -1
self
when 1
other
end
end
max_range =
if !max
self
elsif !other.max
other
else
case max <=> other.max
when 0
include_max ? self : other
when -1
other
when 1
self
end
end
VersionRange.new(
min: min_range.min,
include_min: min_range.include_min,
max: max_range.max,
include_max: max_range.include_max
)
end
def union(other)
return other.union(self) if other.is_a?(VersionUnion)
if contiguous_to?(other)
span(other)
else
VersionUnion.union([self, other])
end
end
def contiguous_to?(other)
return false if other.empty?
intersects?(other) ||
(min == other.max && (include_min || other.include_max)) ||
(max == other.min && (include_max || other.include_min))
end
def allows_all?(other)
return true if other.empty?
if other.is_a?(VersionUnion)
return VersionUnion.new([self]).allows_all?(other)
end
return false if max && !other.max
return false if min && !other.min
if min
case min <=> other.min
when -1
when 0
return false if !include_min && other.include_min
when 1
return false
end
end
if max
case max <=> other.max
when -1
return false
when 0
return false if !include_max && other.include_max
when 1
end
end
true
end
def any?
!min && !max
end
def empty?
false
end
def to_s
@name ||= constraints.join(", ")
end
def inspect
"#<#{self.class} #{to_s}>"
end
def upper_invert
return self.class.empty unless max
VersionRange.new(min: max, include_min: !include_max)
end
def invert
return self.class.empty if any?
low = VersionRange.new(max: min, include_max: !include_min)
high = VersionRange.new(min: max, include_min: !include_max)
if !min
high
elsif !max
low
else
low.union(high)
end
end
def ==(other)
self.class == other.class &&
min == other.min &&
max == other.max &&
include_min == other.include_min &&
include_max == other.include_max
end
private
def constraints
return ["any"] if any?
return ["= #{min}"] if min.to_s == max.to_s
c = []
c << "#{include_min ? ">=" : ">"} #{min}" if min
c << "#{include_max ? "<=" : "<"} #{max}" if max
c
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub/version_union.rb 0000644 00000007527 15173517744 0025044 0 ustar 00 # frozen_string_literal: true
module Bundler::PubGrub
class VersionUnion
attr_reader :ranges
def self.normalize_ranges(ranges)
ranges = ranges.flat_map do |range|
range.ranges
end
ranges.reject!(&:empty?)
return [] if ranges.empty?
mins, ranges = ranges.partition { |r| !r.min }
original_ranges = mins + ranges.sort_by { |r| [r.min, r.include_min ? 0 : 1] }
ranges = [original_ranges.shift]
original_ranges.each do |range|
if ranges.last.contiguous_to?(range)
ranges << ranges.pop.span(range)
else
ranges << range
end
end
ranges
end
def self.union(ranges, normalize: true)
ranges = normalize_ranges(ranges) if normalize
if ranges.size == 0
VersionRange.empty
elsif ranges.size == 1
ranges[0]
else
new(ranges)
end
end
def initialize(ranges)
raise ArgumentError unless ranges.all? { |r| r.instance_of?(VersionRange) }
@ranges = ranges
end
def hash
ranges.hash
end
def eql?(other)
ranges.eql?(other.ranges)
end
def include?(version)
!!ranges.bsearch {|r| r.compare_version(version) }
end
def select_versions(all_versions)
versions = []
ranges.inject(all_versions) do |acc, range|
_, matching, higher = range.partition_versions(acc)
versions.concat matching
higher
end
versions
end
def intersects?(other)
my_ranges = ranges.dup
other_ranges = other.ranges.dup
my_range = my_ranges.shift
other_range = other_ranges.shift
while my_range && other_range
if my_range.intersects?(other_range)
return true
end
if !my_range.max || other_range.empty? || (other_range.max && other_range.max < my_range.max)
other_range = other_ranges.shift
else
my_range = my_ranges.shift
end
end
end
alias_method :allows_any?, :intersects?
def allows_all?(other)
my_ranges = ranges.dup
my_range = my_ranges.shift
other.ranges.all? do |other_range|
while my_range
break if my_range.allows_all?(other_range)
my_range = my_ranges.shift
end
!!my_range
end
end
def empty?
false
end
def any?
false
end
def intersect(other)
my_ranges = ranges.dup
other_ranges = other.ranges.dup
new_ranges = []
my_range = my_ranges.shift
other_range = other_ranges.shift
while my_range && other_range
new_ranges << my_range.intersect(other_range)
if !my_range.max || other_range.empty? || (other_range.max && other_range.max < my_range.max)
other_range = other_ranges.shift
else
my_range = my_ranges.shift
end
end
new_ranges.reject!(&:empty?)
VersionUnion.union(new_ranges, normalize: false)
end
def upper_invert
ranges.last.upper_invert
end
def invert
ranges.map(&:invert).inject(:intersect)
end
def union(other)
VersionUnion.union([self, other])
end
def to_s
output = []
ranges = self.ranges.dup
while !ranges.empty?
ne = []
range = ranges.shift
while !ranges.empty? && ranges[0].min.to_s == range.max.to_s
ne << range.max
range = range.span(ranges.shift)
end
ne.map! {|x| "!= #{x}" }
if ne.empty?
output << range.to_s
elsif range.any?
output << ne.join(', ')
else
output << "#{range}, #{ne.join(', ')}"
end
end
output.join(" OR ")
end
def inspect
"#<#{self.class} #{to_s}>"
end
def ==(other)
self.class == other.class &&
self.ranges == other.ranges
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/pub_grub/lib/pub_grub.rb 0000644 00000001414 15173517744 0022134 0 ustar 00 require_relative "pub_grub/package"
require_relative "pub_grub/static_package_source"
require_relative "pub_grub/term"
require_relative "pub_grub/version_range"
require_relative "pub_grub/version_constraint"
require_relative "pub_grub/version_union"
require_relative "pub_grub/version_solver"
require_relative "pub_grub/incompatibility"
require_relative 'pub_grub/solve_failure'
require_relative 'pub_grub/failure_writer'
require_relative 'pub_grub/version'
module Bundler::PubGrub
class << self
attr_writer :logger
def logger
@logger || default_logger
end
private
def default_logger
require "logger"
logger = ::Logger.new(STDERR)
logger.level = $DEBUG ? ::Logger::DEBUG : ::Logger::WARN
@logger = logger
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/connection_pool/lib/connection_pool.rb 0000644 00000011536 15173517744 0025110 0 ustar 00 require_relative "../../../vendored_timeout"
require_relative "connection_pool/version"
class Bundler::ConnectionPool
class Error < ::RuntimeError; end
class PoolShuttingDownError < ::Bundler::ConnectionPool::Error; end
class TimeoutError < ::Gem::Timeout::Error; end
end
# Generic connection pool class for sharing a limited number of objects or network connections
# among many threads. Note: pool elements are lazily created.
#
# Example usage with block (faster):
#
# @pool = Bundler::ConnectionPool.new { Redis.new }
# @pool.with do |redis|
# redis.lpop('my-list') if redis.llen('my-list') > 0
# end
#
# Using optional timeout override (for that single invocation)
#
# @pool.with(timeout: 2.0) do |redis|
# redis.lpop('my-list') if redis.llen('my-list') > 0
# end
#
# Example usage replacing an existing connection (slower):
#
# $redis = Bundler::ConnectionPool.wrap { Redis.new }
#
# def do_work
# $redis.lpop('my-list') if $redis.llen('my-list') > 0
# end
#
# Accepts the following options:
# - :size - number of connections to pool, defaults to 5
# - :timeout - amount of time to wait for a connection if none currently available, defaults to 5 seconds
# - :auto_reload_after_fork - automatically drop all connections after fork, defaults to true
#
class Bundler::ConnectionPool
DEFAULTS = {size: 5, timeout: 5, auto_reload_after_fork: true}
def self.wrap(options, &block)
Wrapper.new(options, &block)
end
if Process.respond_to?(:fork)
INSTANCES = ObjectSpace::WeakMap.new
private_constant :INSTANCES
def self.after_fork
INSTANCES.values.each do |pool|
next unless pool.auto_reload_after_fork
# We're on after fork, so we know all other threads are dead.
# All we need to do is to ensure the main thread doesn't have a
# checked out connection
pool.checkin(force: true)
pool.reload do |connection|
# Unfortunately we don't know what method to call to close the connection,
# so we try the most common one.
connection.close if connection.respond_to?(:close)
end
end
nil
end
if ::Process.respond_to?(:_fork) # MRI 3.1+
module ForkTracker
def _fork
pid = super
if pid == 0
Bundler::ConnectionPool.after_fork
end
pid
end
end
Process.singleton_class.prepend(ForkTracker)
end
else
INSTANCES = nil
private_constant :INSTANCES
def self.after_fork
# noop
end
end
def initialize(options = {}, &block)
raise ArgumentError, "Connection pool requires a block" unless block
options = DEFAULTS.merge(options)
@size = Integer(options.fetch(:size))
@timeout = options.fetch(:timeout)
@auto_reload_after_fork = options.fetch(:auto_reload_after_fork)
@available = TimedStack.new(@size, &block)
@key = :"pool-#{@available.object_id}"
@key_count = :"pool-#{@available.object_id}-count"
INSTANCES[self] = self if INSTANCES
end
def with(options = {})
Thread.handle_interrupt(Exception => :never) do
conn = checkout(options)
begin
Thread.handle_interrupt(Exception => :immediate) do
yield conn
end
ensure
checkin
end
end
end
alias_method :then, :with
def checkout(options = {})
if ::Thread.current[@key]
::Thread.current[@key_count] += 1
::Thread.current[@key]
else
::Thread.current[@key_count] = 1
::Thread.current[@key] = @available.pop(options[:timeout] || @timeout)
end
end
def checkin(force: false)
if ::Thread.current[@key]
if ::Thread.current[@key_count] == 1 || force
@available.push(::Thread.current[@key])
::Thread.current[@key] = nil
::Thread.current[@key_count] = nil
else
::Thread.current[@key_count] -= 1
end
elsif !force
raise Bundler::ConnectionPool::Error, "no connections are checked out"
end
nil
end
##
# Shuts down the Bundler::ConnectionPool by passing each connection to +block+ and
# then removing it from the pool. Attempting to checkout a connection after
# shutdown will raise +Bundler::ConnectionPool::PoolShuttingDownError+.
def shutdown(&block)
@available.shutdown(&block)
end
##
# Reloads the Bundler::ConnectionPool by passing each connection to +block+ and then
# removing it the pool. Subsequent checkouts will create new connections as
# needed.
def reload(&block)
@available.shutdown(reload: true, &block)
end
# Size of this connection pool
attr_reader :size
# Automatically drop all connections after fork
attr_reader :auto_reload_after_fork
# Number of pool entries available for checkout at this instant.
def available
@available.length
end
end
require_relative "connection_pool/timed_stack"
require_relative "connection_pool/wrapper"
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/connection_pool/lib/connection_pool/timed_stack.rb0000644 00000010573 15173517744 0027377 0 ustar 00 ##
# The TimedStack manages a pool of homogeneous connections (or any resource
# you wish to manage). Connections are created lazily up to a given maximum
# number.
# Examples:
#
# ts = TimedStack.new(1) { MyConnection.new }
#
# # fetch a connection
# conn = ts.pop
#
# # return a connection
# ts.push conn
#
# conn = ts.pop
# ts.pop timeout: 5
# #=> raises Bundler::ConnectionPool::TimeoutError after 5 seconds
class Bundler::ConnectionPool::TimedStack
attr_reader :max
##
# Creates a new pool with +size+ connections that are created from the given
# +block+.
def initialize(size = 0, &block)
@create_block = block
@created = 0
@que = []
@max = size
@mutex = Thread::Mutex.new
@resource = Thread::ConditionVariable.new
@shutdown_block = nil
end
##
# Returns +obj+ to the stack. +options+ is ignored in TimedStack but may be
# used by subclasses that extend TimedStack.
def push(obj, options = {})
@mutex.synchronize do
if @shutdown_block
@shutdown_block.call(obj)
else
store_connection obj, options
end
@resource.broadcast
end
end
alias_method :<<, :push
##
# Retrieves a connection from the stack. If a connection is available it is
# immediately returned. If no connection is available within the given
# timeout a Bundler::ConnectionPool::TimeoutError is raised.
#
# +:timeout+ is the only checked entry in +options+ and is preferred over
# the +timeout+ argument (which will be removed in a future release). Other
# options may be used by subclasses that extend TimedStack.
def pop(timeout = 0.5, options = {})
options, timeout = timeout, 0.5 if Hash === timeout
timeout = options.fetch :timeout, timeout
deadline = current_time + timeout
@mutex.synchronize do
loop do
raise Bundler::ConnectionPool::PoolShuttingDownError if @shutdown_block
return fetch_connection(options) if connection_stored?(options)
connection = try_create(options)
return connection if connection
to_wait = deadline - current_time
raise Bundler::ConnectionPool::TimeoutError, "Waited #{timeout} sec, #{length}/#{@max} available" if to_wait <= 0
@resource.wait(@mutex, to_wait)
end
end
end
##
# Shuts down the TimedStack by passing each connection to +block+ and then
# removing it from the pool. Attempting to checkout a connection after
# shutdown will raise +Bundler::ConnectionPool::PoolShuttingDownError+ unless
# +:reload+ is +true+.
def shutdown(reload: false, &block)
raise ArgumentError, "shutdown must receive a block" unless block
@mutex.synchronize do
@shutdown_block = block
@resource.broadcast
shutdown_connections
@shutdown_block = nil if reload
end
end
##
# Returns +true+ if there are no available connections.
def empty?
(@created - @que.length) >= @max
end
##
# The number of connections available on the stack.
def length
@max - @created + @que.length
end
private
def current_time
Process.clock_gettime(Process::CLOCK_MONOTONIC)
end
##
# This is an extension point for TimedStack and is called with a mutex.
#
# This method must returns true if a connection is available on the stack.
def connection_stored?(options = nil)
!@que.empty?
end
##
# This is an extension point for TimedStack and is called with a mutex.
#
# This method must return a connection from the stack.
def fetch_connection(options = nil)
@que.pop
end
##
# This is an extension point for TimedStack and is called with a mutex.
#
# This method must shut down all connections on the stack.
def shutdown_connections(options = nil)
while connection_stored?(options)
conn = fetch_connection(options)
@shutdown_block.call(conn)
end
@created = 0
end
##
# This is an extension point for TimedStack and is called with a mutex.
#
# This method must return +obj+ to the stack.
def store_connection(obj, options = nil)
@que.push obj
end
##
# This is an extension point for TimedStack and is called with a mutex.
#
# This method must create a connection if and only if the total number of
# connections allowed has not been met.
def try_create(options = nil)
unless @created == @max
object = @create_block.call
@created += 1
object
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/connection_pool/lib/connection_pool/version.rb 0000644 00000000066 15173517744 0026571 0 ustar 00 class Bundler::ConnectionPool
VERSION = "2.4.1"
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/connection_pool/lib/connection_pool/wrapper.rb 0000644 00000002467 15173517744 0026573 0 ustar 00 class Bundler::ConnectionPool
class Wrapper < ::BasicObject
METHODS = [:with, :pool_shutdown, :wrapped_pool]
def initialize(options = {}, &block)
@pool = options.fetch(:pool) { ::Bundler::ConnectionPool.new(options, &block) }
end
def wrapped_pool
@pool
end
def with(&block)
@pool.with(&block)
end
def pool_shutdown(&block)
@pool.shutdown(&block)
end
def pool_size
@pool.size
end
def pool_available
@pool.available
end
def respond_to?(id, *args)
METHODS.include?(id) || with { |c| c.respond_to?(id, *args) }
end
# rubocop:disable Style/MissingRespondToMissing
if ::RUBY_VERSION >= "3.0.0"
def method_missing(name, *args, **kwargs, &block)
with do |connection|
connection.send(name, *args, **kwargs, &block)
end
end
elsif ::RUBY_VERSION >= "2.7.0"
ruby2_keywords def method_missing(name, *args, &block)
with do |connection|
connection.send(name, *args, &block)
end
end
else
def method_missing(name, *args, &block)
with do |connection|
connection.send(name, *args, &block)
end
end
end
# rubocop:enable Style/MethodMissingSuper
# rubocop:enable Style/MissingRespondToMissing
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/securerandom/lib/random/formatter.rb 0000644 00000031256 15173517744 0024503 0 ustar 00 # -*- coding: us-ascii -*-
# frozen_string_literal: true
# == \Random number formatter.
#
# Formats generated random numbers in many manners. When <tt>'random/formatter'</tt>
# is required, several methods are added to empty core module <tt>Bundler::Random::Formatter</tt>,
# making them available as Random's instance and module methods.
#
# Standard library Bundler::SecureRandom is also extended with the module, and the methods
# described below are available as a module methods in it.
#
# === Examples
#
# Generate random hexadecimal strings:
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# prng = Random.new
# prng.hex(10) #=> "52750b30ffbc7de3b362"
# prng.hex(10) #=> "92b15d6c8dc4beb5f559"
# prng.hex(13) #=> "39b290146bea6ce975c37cfc23"
# # or just
# Random.hex #=> "1aed0c631e41be7f77365415541052ee"
#
# Generate random base64 strings:
#
# prng.base64(10) #=> "EcmTPZwWRAozdA=="
# prng.base64(10) #=> "KO1nIU+p9DKxGg=="
# prng.base64(12) #=> "7kJSM/MzBJI+75j8"
# Random.base64(4) #=> "bsQ3fQ=="
#
# Generate random binary strings:
#
# prng.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
# prng.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
# Random.random_bytes(6) #=> "\xA1\xE6Lr\xC43"
#
# Generate alphanumeric strings:
#
# prng.alphanumeric(10) #=> "S8baxMJnPl"
# prng.alphanumeric(10) #=> "aOxAg8BAJe"
# Random.alphanumeric #=> "TmP9OsJHJLtaZYhP"
#
# Generate UUIDs:
#
# prng.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
# prng.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
# Random.uuid #=> "f14e0271-de96-45cc-8911-8910292a42cd"
#
# All methods are available in the standard library Bundler::SecureRandom, too:
#
# Bundler::SecureRandom.hex #=> "05b45376a30c67238eb93b16499e50cf"
module Bundler::Random::Formatter
# Generate a random binary string.
#
# The argument _n_ specifies the length of the result string.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in future.
#
# The result may contain any byte: "\x00" - "\xff".
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# Random.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
# # or
# prng = Random.new
# prng.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
def random_bytes(n=nil)
n = n ? n.to_int : 16
gen_random(n)
end
# Generate a random hexadecimal string.
#
# The argument _n_ specifies the length, in bytes, of the random number to be generated.
# The length of the resulting hexadecimal string is twice of _n_.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The result may contain 0-9 and a-f.
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# Random.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
# # or
# prng = Random.new
# prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
def hex(n=nil)
random_bytes(n).unpack1("H*")
end
# Generate a random base64 string.
#
# The argument _n_ specifies the length, in bytes, of the random number
# to be generated. The length of the result string is about 4/3 of _n_.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# Random.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
# # or
# prng = Random.new
# prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
#
# See RFC 3548 for the definition of base64.
def base64(n=nil)
[random_bytes(n)].pack("m0")
end
# Generate a random URL-safe base64 string.
#
# The argument _n_ specifies the length, in bytes, of the random number
# to be generated. The length of the result string is about 4/3 of _n_.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The boolean argument _padding_ specifies the padding.
# If it is false or nil, padding is not generated.
# Otherwise padding is generated.
# By default, padding is not generated because "=" may be used as a URL delimiter.
#
# The result may contain A-Z, a-z, 0-9, "-" and "_".
# "=" is also used if _padding_ is true.
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# Random.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
# # or
# prng = Random.new
# prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
#
# prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
# prng.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
#
# See RFC 3548 for the definition of URL-safe base64.
def urlsafe_base64(n=nil, padding=false)
s = [random_bytes(n)].pack("m0")
s.tr!("+/", "-_")
s.delete!("=") unless padding
s
end
# Generate a random v4 UUID (Universally Unique IDentifier).
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# Random.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
# Random.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
# # or
# prng = Random.new
# prng.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
#
# The version 4 UUID is purely random (except the version).
# It doesn't contain meaningful information such as MAC addresses, timestamps, etc.
#
# The result contains 122 random bits (15.25 random bytes).
#
# See RFC4122[https://datatracker.ietf.org/doc/html/rfc4122] for details of UUID.
#
def uuid
ary = random_bytes(16).unpack("NnnnnN")
ary[2] = (ary[2] & 0x0fff) | 0x4000
ary[3] = (ary[3] & 0x3fff) | 0x8000
"%08x-%04x-%04x-%04x-%04x%08x" % ary
end
alias uuid_v4 uuid
# Generate a random v7 UUID (Universally Unique IDentifier).
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# Random.uuid_v7 # => "0188d4c3-1311-7f96-85c7-242a7aa58f1e"
# Random.uuid_v7 # => "0188d4c3-16fe-744f-86af-38fa04c62bb5"
# Random.uuid_v7 # => "0188d4c3-1af8-764f-b049-c204ce0afa23"
# Random.uuid_v7 # => "0188d4c3-1e74-7085-b14f-ef6415dc6f31"
# # |<--sorted-->| |<----- random ---->|
#
# # or
# prng = Random.new
# prng.uuid_v7 # => "0188ca51-5e72-7950-a11d-def7ff977c98"
#
# The version 7 UUID starts with the least significant 48 bits of a 64 bit
# Unix timestamp (milliseconds since the epoch) and fills the remaining bits
# with random data, excluding the version and variant bits.
#
# This allows version 7 UUIDs to be sorted by creation time. Time ordered
# UUIDs can be used for better database index locality of newly inserted
# records, which may have a significant performance benefit compared to random
# data inserts.
#
# The result contains 74 random bits (9.25 random bytes).
#
# Note that this method cannot be made reproducable because its output
# includes not only random bits but also timestamp.
#
# See draft-ietf-uuidrev-rfc4122bis[https://datatracker.ietf.org/doc/draft-ietf-uuidrev-rfc4122bis/]
# for details of UUIDv7.
#
# ==== Monotonicity
#
# UUIDv7 has millisecond precision by default, so multiple UUIDs created
# within the same millisecond are not issued in monotonically increasing
# order. To create UUIDs that are time-ordered with sub-millisecond
# precision, up to 12 bits of additional timestamp may added with
# +extra_timestamp_bits+. The extra timestamp precision comes at the expense
# of random bits. Setting <tt>extra_timestamp_bits: 12</tt> provides ~244ns
# of precision, but only 62 random bits (7.75 random bytes).
#
# prng = Random.new
# Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 12) }
# # =>
# ["0188d4c7-13da-74f9-8b53-22a786ffdd5a",
# "0188d4c7-13da-753b-83a5-7fb9b2afaeea",
# "0188d4c7-13da-754a-88ea-ac0baeedd8db",
# "0188d4c7-13da-7557-83e1-7cad9cda0d8d"]
# # |<--- sorted --->| |<-- random --->|
#
# Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 8) }
# # =>
# ["0188d4c7-3333-7a95-850a-de6edb858f7e",
# "0188d4c7-3333-7ae8-842e-bc3a8b7d0cf9", # <- out of order
# "0188d4c7-3333-7ae2-995a-9f135dc44ead", # <- out of order
# "0188d4c7-3333-7af9-87c3-8f612edac82e"]
# # |<--- sorted -->||<---- random --->|
#
# Any rollbacks of the system clock will break monotonicity. UUIDv7 is based
# on UTC, which excludes leap seconds and can rollback the clock. To avoid
# this, the system clock can synchronize with an NTP server configured to use
# a "leap smear" approach. NTP or PTP will also be needed to synchronize
# across distributed nodes.
#
# Counters and other mechanisms for stronger guarantees of monotonicity are
# not implemented. Applications with stricter requirements should follow
# {Section 6.2}[https://www.ietf.org/archive/id/draft-ietf-uuidrev-rfc4122bis-07.html#monotonicity_counters]
# of the specification.
#
def uuid_v7(extra_timestamp_bits: 0)
case (extra_timestamp_bits = Integer(extra_timestamp_bits))
when 0 # min timestamp precision
ms = Process.clock_gettime(Process::CLOCK_REALTIME, :millisecond)
rand = random_bytes(10)
rand.setbyte(0, rand.getbyte(0) & 0x0f | 0x70) # version
rand.setbyte(2, rand.getbyte(2) & 0x3f | 0x80) # variant
"%08x-%04x-%s" % [
(ms & 0x0000_ffff_ffff_0000) >> 16,
(ms & 0x0000_0000_0000_ffff),
rand.unpack("H4H4H12").join("-")
]
when 12 # max timestamp precision
ms, ns = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
.divmod(1_000_000)
extra_bits = ns * 4096 / 1_000_000
rand = random_bytes(8)
rand.setbyte(0, rand.getbyte(0) & 0x3f | 0x80) # variant
"%08x-%04x-7%03x-%s" % [
(ms & 0x0000_ffff_ffff_0000) >> 16,
(ms & 0x0000_0000_0000_ffff),
extra_bits,
rand.unpack("H4H12").join("-")
]
when (0..12) # the generic version is slower than the special cases above
rand_a, rand_b1, rand_b2, rand_b3 = random_bytes(10).unpack("nnnN")
rand_mask_bits = 12 - extra_timestamp_bits
ms, ns = Process.clock_gettime(Process::CLOCK_REALTIME, :nanosecond)
.divmod(1_000_000)
"%08x-%04x-%04x-%04x-%04x%08x" % [
(ms & 0x0000_ffff_ffff_0000) >> 16,
(ms & 0x0000_0000_0000_ffff),
0x7000 |
((ns * (1 << extra_timestamp_bits) / 1_000_000) << rand_mask_bits) |
rand_a & ((1 << rand_mask_bits) - 1),
0x8000 | (rand_b1 & 0x3fff),
rand_b2,
rand_b3
]
else
raise ArgumentError, "extra_timestamp_bits must be in 0..12"
end
end
# Internal interface to Random; Generate random data _n_ bytes.
private def gen_random(n)
self.bytes(n)
end
# Generate a string that randomly draws from a
# source array of characters.
#
# The argument _source_ specifies the array of characters from which
# to generate the string.
# The argument _n_ specifies the length, in characters, of the string to be
# generated.
#
# The result may contain whatever characters are in the source array.
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# prng.choose([*'l'..'r'], 16) #=> "lmrqpoonmmlqlron"
# prng.choose([*'0'..'9'], 5) #=> "27309"
private def choose(source, n)
size = source.size
m = 1
limit = size
while limit * size <= 0x100000000
limit *= size
m += 1
end
result = ''.dup
while m <= n
rs = random_number(limit)
is = rs.digits(size)
(m-is.length).times { is << 0 }
result << source.values_at(*is).join('')
n -= m
end
if 0 < n
rs = random_number(limit)
is = rs.digits(size)
if is.length < n
(n-is.length).times { is << 0 }
else
is.pop while n < is.length
end
result.concat source.values_at(*is).join('')
end
result
end
# The default character list for #alphanumeric.
ALPHANUMERIC = [*'A'..'Z', *'a'..'z', *'0'..'9']
# Generate a random alphanumeric string.
#
# The argument _n_ specifies the length, in characters, of the alphanumeric
# string to be generated.
# The argument _chars_ specifies the character list which the result is
# consist of.
#
# If _n_ is not specified or is nil, 16 is assumed.
# It may be larger in the future.
#
# The result may contain A-Z, a-z and 0-9, unless _chars_ is specified.
#
# require 'bundler/vendor/securerandom/lib/random/formatter'
#
# Random.alphanumeric #=> "2BuBuLf3WfSKyQbR"
# # or
# prng = Random.new
# prng.alphanumeric(10) #=> "i6K93NdqiH"
#
# Random.alphanumeric(4, chars: [*"0".."9"]) #=> "2952"
# # or
# prng = Random.new
# prng.alphanumeric(10, chars: [*"!".."/"]) #=> ",.,++%/''."
def alphanumeric(n = nil, chars: ALPHANUMERIC)
n = 16 if n.nil?
choose(chars, n)
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/securerandom/lib/securerandom.rb 0000644 00000004253 15173517744 0023704 0 ustar 00 # -*- coding: us-ascii -*-
# frozen_string_literal: true
require_relative 'random/formatter'
# == Secure random number generator interface.
#
# This library is an interface to secure random number generators which are
# suitable for generating session keys in HTTP cookies, etc.
#
# You can use this library in your application by requiring it:
#
# require 'bundler/vendor/securerandom/lib/securerandom'
#
# It supports the following secure random number generators:
#
# * openssl
# * /dev/urandom
# * Win32
#
# Bundler::SecureRandom is extended by the Bundler::Random::Formatter module which
# defines the following methods:
#
# * alphanumeric
# * base64
# * choose
# * gen_random
# * hex
# * rand
# * random_bytes
# * random_number
# * urlsafe_base64
# * uuid
#
# These methods are usable as class methods of Bundler::SecureRandom such as
# +Bundler::SecureRandom.hex+.
#
# If a secure random number generator is not available,
# +NotImplementedError+ is raised.
module Bundler::SecureRandom
# The version
VERSION = "0.3.1"
class << self
# Returns a random binary string containing +size+ bytes.
#
# See Random.bytes
def bytes(n)
return gen_random(n)
end
private
# :stopdoc:
# Implementation using OpenSSL
def gen_random_openssl(n)
return OpenSSL::Random.random_bytes(n)
end
# Implementation using system random device
def gen_random_urandom(n)
ret = Random.urandom(n)
unless ret
raise NotImplementedError, "No random device"
end
unless ret.length == n
raise NotImplementedError, "Unexpected partial read from random device: only #{ret.length} for #{n} bytes"
end
ret
end
begin
# Check if Random.urandom is available
Random.urandom(1)
alias gen_random gen_random_urandom
rescue RuntimeError
begin
require 'openssl'
rescue NoMethodError
raise NotImplementedError, "No random device"
else
alias gen_random gen_random_openssl
end
end
# :startdoc:
# Generate random data bytes for Bundler::Random::Formatter
public :gen_random
end
end
Bundler::SecureRandom.extend(Bundler::Random::Formatter)
gems/gems/bundler-2.5.22/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/pool.rb 0000644 00000003163 15173517744 0027325 0 ustar 00 share class Gem::Net::HTTP::Persistent::Pool < Bundler::ConnectionPool # :nodoc:
attr_reader :available # :nodoc:
attr_reader :key # :nodoc:
def initialize(options = {}, &block)
super
@available = Gem::Net::HTTP::Persistent::TimedStackMulti.new(@size, &block)
@key = "current-#{@available.object_id}"
end
def checkin net_http_args
if net_http_args.is_a?(Hash) && net_http_args.size == 1 && net_http_args[:force]
# Bundler::ConnectionPool 2.4+ calls `checkin(force: true)` after fork.
# When this happens, we should remove all connections from Thread.current
if stacks = Thread.current[@key]
stacks.each do |http_args, connections|
connections.each do |conn|
@available.push conn, connection_args: http_args
end
connections.clear
end
end
else
stack = Thread.current[@key][net_http_args] ||= []
raise Bundler::ConnectionPool::Error, 'no connections are checked out' if
stack.empty?
conn = stack.pop
if stack.empty?
@available.push conn, connection_args: net_http_args
Thread.current[@key].delete(net_http_args)
Thread.current[@key] = nil if Thread.current[@key].empty?
end
end
nil
end
def checkout net_http_args
stacks = Thread.current[@key] ||= {}
stack = stacks[net_http_args] ||= []
if stack.empty? then
conn = @available.pop connection_args: net_http_args
else
conn = stack.last
end
stack.push conn
conn
end
def shutdown
Thread.current[@key] = nil
super
end
end
require_relative 'timed_stack_multi'
gems/bundler-2.5.22/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/connection.rb 0000644 00000001314 15173517744 0030507 0 ustar 00 share/gems ##
# A Gem::Net::HTTP connection wrapper that holds extra information for managing the
# connection's lifetime.
class Gem::Net::HTTP::Persistent::Connection # :nodoc:
attr_accessor :http
attr_accessor :last_use
attr_accessor :requests
attr_accessor :ssl_generation
def initialize http_class, http_args, ssl_generation
@http = http_class.new(*http_args)
@ssl_generation = ssl_generation
reset
end
def finish
@http.finish
rescue IOError
ensure
reset
end
alias_method :close, :finish
def reset
@last_use = Gem::Net::HTTP::Persistent::EPOCH
@requests = 0
end
def ressl ssl_generation
@ssl_generation = ssl_generation
finish
end
end
bundler-2.5.22/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent/timed_stack_multi.rb 0000644 00000003126 15173517744 0032054 0 ustar 00 share/gems/gems class Gem::Net::HTTP::Persistent::TimedStackMulti < Bundler::ConnectionPool::TimedStack # :nodoc:
##
# Returns a new hash that has arrays for keys
#
# Using a class method to limit the bindings referenced by the hash's
# default_proc
def self.hash_of_arrays # :nodoc:
Hash.new { |h,k| h[k] = [] }
end
def initialize(size = 0, &block)
super
@enqueued = 0
@ques = self.class.hash_of_arrays
@lru = {}
@key = :"connection_args-#{object_id}"
end
def empty?
(@created - @enqueued) >= @max
end
def length
@max - @created + @enqueued
end
private
def connection_stored? options = {} # :nodoc:
!@ques[options[:connection_args]].empty?
end
def fetch_connection options = {} # :nodoc:
connection_args = options[:connection_args]
@enqueued -= 1
lru_update connection_args
@ques[connection_args].pop
end
def lru_update connection_args # :nodoc:
@lru.delete connection_args
@lru[connection_args] = true
end
def shutdown_connections # :nodoc:
@ques.each_key do |key|
super connection_args: key
end
end
def store_connection obj, options = {} # :nodoc:
@ques[options[:connection_args]].push obj
@enqueued += 1
end
def try_create options = {} # :nodoc:
connection_args = options[:connection_args]
if @created >= @max && @enqueued >= 1
oldest, = @lru.first
@lru.delete oldest
@ques[oldest].pop
@created -= 1
end
if @created < @max
@created += 1
lru_update connection_args
return @create_block.call(connection_args)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb 0000644 00000070527 15173517744 0026443 0 ustar 00 require_relative '../../../../../vendored_net_http'
require_relative '../../../../../vendored_uri'
require 'cgi' # for escaping
require_relative '../../../../connection_pool/lib/connection_pool'
autoload :OpenSSL, 'openssl'
##
# Persistent connections for Gem::Net::HTTP
#
# Gem::Net::HTTP::Persistent maintains persistent connections across all the
# servers you wish to talk to. For each host:port you communicate with a
# single persistent connection is created.
#
# Connections will be shared across threads through a connection pool to
# increase reuse of connections.
#
# You can shut down any remaining HTTP connections when done by calling
# #shutdown.
#
# Example:
#
# require 'bundler/vendor/net-http-persistent/lib/net/http/persistent'
#
# uri = Gem::URI 'http://example.com/awesome/web/service'
#
# http = Gem::Net::HTTP::Persistent.new
#
# # perform a GET
# response = http.request uri
#
# # or
#
# get = Gem::Net::HTTP::Get.new uri.request_uri
# response = http.request get
#
# # create a POST
# post_uri = uri + 'create'
# post = Gem::Net::HTTP::Post.new post_uri.path
# post.set_form_data 'some' => 'cool data'
#
# # perform the POST, the Gem::URI is always required
# response http.request post_uri, post
#
# Note that for GET, HEAD and other requests that do not have a body you want
# to use Gem::URI#request_uri not Gem::URI#path. The request_uri contains the query
# params which are sent in the body for other requests.
#
# == TLS/SSL
#
# TLS connections are automatically created depending upon the scheme of the
# Gem::URI. TLS connections are automatically verified against the default
# certificate store for your computer. You can override this by changing
# verify_mode or by specifying an alternate cert_store.
#
# Here are the TLS settings, see the individual methods for documentation:
#
# #certificate :: This client's certificate
# #ca_file :: The certificate-authorities
# #ca_path :: Directory with certificate-authorities
# #cert_store :: An SSL certificate store
# #ciphers :: List of SSl ciphers allowed
# #private_key :: The client's SSL private key
# #reuse_ssl_sessions :: Reuse a previously opened SSL session for a new
# connection
# #ssl_timeout :: Session lifetime
# #ssl_version :: Which specific SSL version to use
# #verify_callback :: For server certificate verification
# #verify_depth :: Depth of certificate verification
# #verify_mode :: How connections should be verified
# #verify_hostname :: Use hostname verification for server certificate
# during the handshake
#
# == Proxies
#
# A proxy can be set through #proxy= or at initialization time by providing a
# second argument to ::new. The proxy may be the Gem::URI of the proxy server or
# <code>:ENV</code> which will consult environment variables.
#
# See #proxy= and #proxy_from_env for details.
#
# == Headers
#
# Headers may be specified for use in every request. #headers are appended to
# any headers on the request. #override_headers replace existing headers on
# the request.
#
# The difference between the two can be seen in setting the User-Agent. Using
# <code>http.headers['User-Agent'] = 'MyUserAgent'</code> will send "Ruby,
# MyUserAgent" while <code>http.override_headers['User-Agent'] =
# 'MyUserAgent'</code> will send "MyUserAgent".
#
# == Tuning
#
# === Segregation
#
# Each Gem::Net::HTTP::Persistent instance has its own pool of connections. There
# is no sharing with other instances (as was true in earlier versions).
#
# === Idle Timeout
#
# If a connection hasn't been used for this number of seconds it will
# automatically be reset upon the next use to avoid attempting to send to a
# closed connection. The default value is 5 seconds. nil means no timeout.
# Set through #idle_timeout.
#
# Reducing this value may help avoid the "too many connection resets" error
# when sending non-idempotent requests while increasing this value will cause
# fewer round-trips.
#
# === Read Timeout
#
# The amount of time allowed between reading two chunks from the socket. Set
# through #read_timeout
#
# === Max Requests
#
# The number of requests that should be made before opening a new connection.
# Typically many keep-alive capable servers tune this to 100 or less, so the
# 101st request will fail with ECONNRESET. If unset (default), this value has
# no effect, if set, connections will be reset on the request after
# max_requests.
#
# === Open Timeout
#
# The amount of time to wait for a connection to be opened. Set through
# #open_timeout.
#
# === Socket Options
#
# Socket options may be set on newly-created connections. See #socket_options
# for details.
#
# === Connection Termination
#
# If you are done using the Gem::Net::HTTP::Persistent instance you may shut down
# all the connections in the current thread with #shutdown. This is not
# recommended for normal use, it should only be used when it will be several
# minutes before you make another HTTP request.
#
# If you are using multiple threads, call #shutdown in each thread when the
# thread is done making requests. If you don't call shutdown, that's OK.
# Ruby will automatically garbage collect and shutdown your HTTP connections
# when the thread terminates.
class Gem::Net::HTTP::Persistent
##
# The beginning of Time
EPOCH = Time.at 0 # :nodoc:
##
# Is OpenSSL available? This test works with autoload
HAVE_OPENSSL = defined? OpenSSL::SSL # :nodoc:
##
# The default connection pool size is 1/4 the allowed open files
# (<code>ulimit -n</code>) or 256 if your OS does not support file handle
# limits (typically windows).
if Process.const_defined? :RLIMIT_NOFILE
open_file_limits = Process.getrlimit(Process::RLIMIT_NOFILE)
# Under JRuby on Windows Process responds to `getrlimit` but returns something that does not match docs
if open_file_limits.respond_to?(:first)
DEFAULT_POOL_SIZE = open_file_limits.first / 4
else
DEFAULT_POOL_SIZE = 256
end
else
DEFAULT_POOL_SIZE = 256
end
##
# The version of Gem::Net::HTTP::Persistent you are using
VERSION = '4.0.4'
##
# Error class for errors raised by Gem::Net::HTTP::Persistent. Various
# SystemCallErrors are re-raised with a human-readable message under this
# class.
class Error < StandardError; end
##
# Use this method to detect the idle timeout of the host at +uri+. The
# value returned can be used to configure #idle_timeout. +max+ controls the
# maximum idle timeout to detect.
#
# After
#
# Idle timeout detection is performed by creating a connection then
# performing a HEAD request in a loop until the connection terminates
# waiting one additional second per loop.
#
# NOTE: This may not work on ruby > 1.9.
def self.detect_idle_timeout uri, max = 10
uri = Gem::URI uri unless Gem::URI::Generic === uri
uri += '/'
req = Gem::Net::HTTP::Head.new uri.request_uri
http = new 'net-http-persistent detect_idle_timeout'
http.connection_for uri do |connection|
sleep_time = 0
http = connection.http
loop do
response = http.request req
$stderr.puts "HEAD #{uri} => #{response.code}" if $DEBUG
unless Gem::Net::HTTPOK === response then
raise Error, "bad response code #{response.code} detecting idle timeout"
end
break if sleep_time >= max
sleep_time += 1
$stderr.puts "sleeping #{sleep_time}" if $DEBUG
sleep sleep_time
end
end
rescue
# ignore StandardErrors, we've probably found the idle timeout.
ensure
return sleep_time unless $!
end
##
# This client's OpenSSL::X509::Certificate
attr_reader :certificate
##
# For Gem::Net::HTTP parity
alias cert certificate
##
# An SSL certificate authority. Setting this will set verify_mode to
# VERIFY_PEER.
attr_reader :ca_file
##
# A directory of SSL certificates to be used as certificate authorities.
# Setting this will set verify_mode to VERIFY_PEER.
attr_reader :ca_path
##
# An SSL certificate store. Setting this will override the default
# certificate store. See verify_mode for more information.
attr_reader :cert_store
##
# The ciphers allowed for SSL connections
attr_reader :ciphers
##
# Sends debug_output to this IO via Gem::Net::HTTP#set_debug_output.
#
# Never use this method in production code, it causes a serious security
# hole.
attr_accessor :debug_output
##
# Current connection generation
attr_reader :generation # :nodoc:
##
# Headers that are added to every request using Gem::Net::HTTP#add_field
attr_reader :headers
##
# Maps host:port to an HTTP version. This allows us to enable version
# specific features.
attr_reader :http_versions
##
# Maximum time an unused connection can remain idle before being
# automatically closed.
attr_accessor :idle_timeout
##
# Maximum number of requests on a connection before it is considered expired
# and automatically closed.
attr_accessor :max_requests
##
# Number of retries to perform if a request fails.
#
# See also #max_retries=, Gem::Net::HTTP#max_retries=.
attr_reader :max_retries
##
# The value sent in the Keep-Alive header. Defaults to 30. Not needed for
# HTTP/1.1 servers.
#
# This may not work correctly for HTTP/1.0 servers
#
# This method may be removed in a future version as RFC 2616 does not
# require this header.
attr_accessor :keep_alive
##
# The name for this collection of persistent connections.
attr_reader :name
##
# Seconds to wait until a connection is opened. See Gem::Net::HTTP#open_timeout
attr_accessor :open_timeout
##
# Headers that are added to every request using Gem::Net::HTTP#[]=
attr_reader :override_headers
##
# This client's SSL private key
attr_reader :private_key
##
# For Gem::Net::HTTP parity
alias key private_key
##
# The URL through which requests will be proxied
attr_reader :proxy_uri
##
# List of host suffixes which will not be proxied
attr_reader :no_proxy
##
# Test-only accessor for the connection pool
attr_reader :pool # :nodoc:
##
# Seconds to wait until reading one block. See Gem::Net::HTTP#read_timeout
attr_accessor :read_timeout
##
# Seconds to wait until writing one block. See Gem::Net::HTTP#write_timeout
attr_accessor :write_timeout
##
# By default SSL sessions are reused to avoid extra SSL handshakes. Set
# this to false if you have problems communicating with an HTTPS server
# like:
#
# SSL_connect [...] read finished A: unexpected message (OpenSSL::SSL::SSLError)
attr_accessor :reuse_ssl_sessions
##
# An array of options for Socket#setsockopt.
#
# By default the TCP_NODELAY option is set on sockets.
#
# To set additional options append them to this array:
#
# http.socket_options << [Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1]
attr_reader :socket_options
##
# Current SSL connection generation
attr_reader :ssl_generation # :nodoc:
##
# SSL session lifetime
attr_reader :ssl_timeout
##
# SSL version to use.
#
# By default, the version will be negotiated automatically between client
# and server. Ruby 1.9 and newer only. Deprecated since Ruby 2.5.
attr_reader :ssl_version
##
# Minimum SSL version to use, e.g. :TLS1_1
#
# By default, the version will be negotiated automatically between client
# and server. Ruby 2.5 and newer only.
attr_reader :min_version
##
# Maximum SSL version to use, e.g. :TLS1_2
#
# By default, the version will be negotiated automatically between client
# and server. Ruby 2.5 and newer only.
attr_reader :max_version
##
# Where this instance's last-use times live in the thread local variables
attr_reader :timeout_key # :nodoc:
##
# SSL verification callback. Used when ca_file or ca_path is set.
attr_reader :verify_callback
##
# Sets the depth of SSL certificate verification
attr_reader :verify_depth
##
# HTTPS verify mode. Defaults to OpenSSL::SSL::VERIFY_PEER which verifies
# the server certificate.
#
# If no ca_file, ca_path or cert_store is set the default system certificate
# store is used.
#
# You can use +verify_mode+ to override any default values.
attr_reader :verify_mode
##
# HTTPS verify_hostname.
#
# If a client sets this to true and enables SNI with SSLSocket#hostname=,
# the hostname verification on the server certificate is performed
# automatically during the handshake using
# OpenSSL::SSL.verify_certificate_identity().
#
# You can set +verify_hostname+ as true to use hostname verification
# during the handshake.
#
# NOTE: This works with Ruby > 3.0.
attr_reader :verify_hostname
##
# Creates a new Gem::Net::HTTP::Persistent.
#
# Set a +name+ for fun. Your library name should be good enough, but this
# otherwise has no purpose.
#
# +proxy+ may be set to a Gem::URI::HTTP or :ENV to pick up proxy options from
# the environment. See proxy_from_env for details.
#
# In order to use a Gem::URI for the proxy you may need to do some extra work
# beyond Gem::URI parsing if the proxy requires a password:
#
# proxy = Gem::URI 'http://proxy.example'
# proxy.user = 'AzureDiamond'
# proxy.password = 'hunter2'
#
# Set +pool_size+ to limit the maximum number of connections allowed.
# Defaults to 1/4 the number of allowed file handles or 256 if your OS does
# not support a limit on allowed file handles. You can have no more than
# this many threads with active HTTP transactions.
def initialize name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE
@name = name
@debug_output = nil
@proxy_uri = nil
@no_proxy = []
@headers = {}
@override_headers = {}
@http_versions = {}
@keep_alive = 30
@open_timeout = nil
@read_timeout = nil
@write_timeout = nil
@idle_timeout = 5
@max_requests = nil
@max_retries = 1
@socket_options = []
@ssl_generation = 0 # incremented when SSL session variables change
@socket_options << [Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1] if
Socket.const_defined? :TCP_NODELAY
@pool = Gem::Net::HTTP::Persistent::Pool.new size: pool_size do |http_args|
Gem::Net::HTTP::Persistent::Connection.new Gem::Net::HTTP, http_args, @ssl_generation
end
@certificate = nil
@ca_file = nil
@ca_path = nil
@ciphers = nil
@private_key = nil
@ssl_timeout = nil
@ssl_version = nil
@min_version = nil
@max_version = nil
@verify_callback = nil
@verify_depth = nil
@verify_mode = nil
@verify_hostname = nil
@cert_store = nil
@generation = 0 # incremented when proxy Gem::URI changes
if HAVE_OPENSSL then
@verify_mode = OpenSSL::SSL::VERIFY_PEER
@reuse_ssl_sessions = OpenSSL::SSL.const_defined? :Session
end
self.proxy = proxy if proxy
end
##
# Sets this client's OpenSSL::X509::Certificate
def certificate= certificate
@certificate = certificate
reconnect_ssl
end
# For Gem::Net::HTTP parity
alias cert= certificate=
##
# Sets the SSL certificate authority file.
def ca_file= file
@ca_file = file
reconnect_ssl
end
##
# Sets the SSL certificate authority path.
def ca_path= path
@ca_path = path
reconnect_ssl
end
##
# Overrides the default SSL certificate store used for verifying
# connections.
def cert_store= store
@cert_store = store
reconnect_ssl
end
##
# The ciphers allowed for SSL connections
def ciphers= ciphers
@ciphers = ciphers
reconnect_ssl
end
##
# Creates a new connection for +uri+
def connection_for uri
use_ssl = uri.scheme.downcase == 'https'
net_http_args = [uri.hostname, uri.port]
# I'm unsure if uri.host or uri.hostname should be checked against
# the proxy bypass list.
if @proxy_uri and not proxy_bypass? uri.host, uri.port then
net_http_args.concat @proxy_args
else
net_http_args.concat [nil, nil, nil, nil]
end
connection = @pool.checkout net_http_args
http = connection.http
connection.ressl @ssl_generation if
connection.ssl_generation != @ssl_generation
if not http.started? then
ssl http if use_ssl
start http
elsif expired? connection then
reset connection
end
http.keep_alive_timeout = @idle_timeout if @idle_timeout
http.max_retries = @max_retries if http.respond_to?(:max_retries=)
http.read_timeout = @read_timeout if @read_timeout
http.write_timeout = @write_timeout if
@write_timeout && http.respond_to?(:write_timeout=)
return yield connection
rescue Errno::ECONNREFUSED
if http.proxy?
address = http.proxy_address
port = http.proxy_port
else
address = http.address
port = http.port
end
raise Error, "connection refused: #{address}:#{port}"
rescue Errno::EHOSTDOWN
if http.proxy?
address = http.proxy_address
port = http.proxy_port
else
address = http.address
port = http.port
end
raise Error, "host down: #{address}:#{port}"
ensure
@pool.checkin net_http_args
end
##
# CGI::escape wrapper
def escape str
CGI.escape str if str
end
##
# CGI::unescape wrapper
def unescape str
CGI.unescape str if str
end
##
# Returns true if the connection should be reset due to an idle timeout, or
# maximum request count, false otherwise.
def expired? connection
return true if @max_requests && connection.requests >= @max_requests
return false unless @idle_timeout
return true if @idle_timeout.zero?
Time.now - connection.last_use > @idle_timeout
end
##
# Starts the Gem::Net::HTTP +connection+
def start http
http.set_debug_output @debug_output if @debug_output
http.open_timeout = @open_timeout if @open_timeout
http.start
socket = http.instance_variable_get :@socket
if socket then # for fakeweb
@socket_options.each do |option|
socket.io.setsockopt(*option)
end
end
end
##
# Finishes the Gem::Net::HTTP +connection+
def finish connection
connection.finish
connection.http.instance_variable_set :@last_communicated, nil
connection.http.instance_variable_set :@ssl_session, nil unless
@reuse_ssl_sessions
end
##
# Returns the HTTP protocol version for +uri+
def http_version uri
@http_versions["#{uri.hostname}:#{uri.port}"]
end
##
# Adds "http://" to the String +uri+ if it is missing.
def normalize_uri uri
(uri =~ /^https?:/) ? uri : "http://#{uri}"
end
##
# Set the maximum number of retries for a request.
#
# Defaults to one retry.
#
# Set this to 0 to disable retries.
def max_retries= retries
retries = retries.to_int
raise ArgumentError, "max_retries must be positive" if retries < 0
@max_retries = retries
reconnect
end
##
# Sets this client's SSL private key
def private_key= key
@private_key = key
reconnect_ssl
end
# For Gem::Net::HTTP parity
alias key= private_key=
##
# Sets the proxy server. The +proxy+ may be the Gem::URI of the proxy server,
# the symbol +:ENV+ which will read the proxy from the environment or nil to
# disable use of a proxy. See #proxy_from_env for details on setting the
# proxy from the environment.
#
# If the proxy Gem::URI is set after requests have been made, the next request
# will shut-down and re-open all connections.
#
# The +no_proxy+ query parameter can be used to specify hosts which shouldn't
# be reached via proxy; if set it should be a comma separated list of
# hostname suffixes, optionally with +:port+ appended, for example
# <tt>example.com,some.host:8080</tt>.
def proxy= proxy
@proxy_uri = case proxy
when :ENV then proxy_from_env
when Gem::URI::HTTP then proxy
when nil then # ignore
else raise ArgumentError, 'proxy must be :ENV or a Gem::URI::HTTP'
end
@no_proxy.clear
if @proxy_uri then
@proxy_args = [
@proxy_uri.hostname,
@proxy_uri.port,
unescape(@proxy_uri.user),
unescape(@proxy_uri.password),
]
@proxy_connection_id = [nil, *@proxy_args].join ':'
if @proxy_uri.query then
@no_proxy = CGI.parse(@proxy_uri.query)['no_proxy'].join(',').downcase.split(',').map { |x| x.strip }.reject { |x| x.empty? }
end
end
reconnect
reconnect_ssl
end
##
# Creates a Gem::URI for an HTTP proxy server from ENV variables.
#
# If +HTTP_PROXY+ is set a proxy will be returned.
#
# If +HTTP_PROXY_USER+ or +HTTP_PROXY_PASS+ are set the Gem::URI is given the
# indicated user and password unless HTTP_PROXY contains either of these in
# the Gem::URI.
#
# The +NO_PROXY+ ENV variable can be used to specify hosts which shouldn't
# be reached via proxy; if set it should be a comma separated list of
# hostname suffixes, optionally with +:port+ appended, for example
# <tt>example.com,some.host:8080</tt>. When set to <tt>*</tt> no proxy will
# be returned.
#
# For Windows users, lowercase ENV variables are preferred over uppercase ENV
# variables.
def proxy_from_env
env_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
return nil if env_proxy.nil? or env_proxy.empty?
uri = Gem::URI normalize_uri env_proxy
env_no_proxy = ENV['no_proxy'] || ENV['NO_PROXY']
# '*' is special case for always bypass
return nil if env_no_proxy == '*'
if env_no_proxy then
uri.query = "no_proxy=#{escape(env_no_proxy)}"
end
unless uri.user or uri.password then
uri.user = escape ENV['http_proxy_user'] || ENV['HTTP_PROXY_USER']
uri.password = escape ENV['http_proxy_pass'] || ENV['HTTP_PROXY_PASS']
end
uri
end
##
# Returns true when proxy should by bypassed for host.
def proxy_bypass? host, port
host = host.downcase
host_port = [host, port].join ':'
@no_proxy.each do |name|
return true if host[-name.length, name.length] == name or
host_port[-name.length, name.length] == name
end
false
end
##
# Forces reconnection of all HTTP connections, including TLS/SSL
# connections.
def reconnect
@generation += 1
end
##
# Forces reconnection of only TLS/SSL connections.
def reconnect_ssl
@ssl_generation += 1
end
##
# Finishes then restarts the Gem::Net::HTTP +connection+
def reset connection
http = connection.http
finish connection
start http
rescue Errno::ECONNREFUSED
e = Error.new "connection refused: #{http.address}:#{http.port}"
e.set_backtrace $@
raise e
rescue Errno::EHOSTDOWN
e = Error.new "host down: #{http.address}:#{http.port}"
e.set_backtrace $@
raise e
end
##
# Makes a request on +uri+. If +req+ is nil a Gem::Net::HTTP::Get is performed
# against +uri+.
#
# If a block is passed #request behaves like Gem::Net::HTTP#request (the body of
# the response will not have been read).
#
# +req+ must be a Gem::Net::HTTPGenericRequest subclass (see Gem::Net::HTTP for a list).
def request uri, req = nil, &block
uri = Gem::URI uri
req = request_setup req || uri
response = nil
connection_for uri do |connection|
http = connection.http
begin
connection.requests += 1
response = http.request req, &block
if req.connection_close? or
(response.http_version <= '1.0' and
not response.connection_keep_alive?) or
response.connection_close? then
finish connection
end
rescue Exception # make sure to close the connection when it was interrupted
finish connection
raise
ensure
connection.last_use = Time.now
end
end
@http_versions["#{uri.hostname}:#{uri.port}"] ||= response.http_version
response
end
##
# Creates a GET request if +req_or_uri+ is a Gem::URI and adds headers to the
# request.
#
# Returns the request.
def request_setup req_or_uri # :nodoc:
req = if req_or_uri.respond_to? 'request_uri' then
Gem::Net::HTTP::Get.new req_or_uri.request_uri
else
req_or_uri
end
@headers.each do |pair|
req.add_field(*pair)
end
@override_headers.each do |name, value|
req[name] = value
end
unless req['Connection'] then
req.add_field 'Connection', 'keep-alive'
req.add_field 'Keep-Alive', @keep_alive
end
req
end
##
# Shuts down all connections
#
# *NOTE*: Calling shutdown for can be dangerous!
#
# If any thread is still using a connection it may cause an error! Call
# #shutdown when you are completely done making requests!
def shutdown
@pool.shutdown { |http| http.finish }
end
##
# Enables SSL on +connection+
def ssl connection
connection.use_ssl = true
connection.ciphers = @ciphers if @ciphers
connection.ssl_timeout = @ssl_timeout if @ssl_timeout
connection.ssl_version = @ssl_version if @ssl_version
connection.min_version = @min_version if @min_version
connection.max_version = @max_version if @max_version
connection.verify_depth = @verify_depth
connection.verify_mode = @verify_mode
connection.verify_hostname = @verify_hostname if
@verify_hostname != nil && connection.respond_to?(:verify_hostname=)
if OpenSSL::SSL::VERIFY_PEER == OpenSSL::SSL::VERIFY_NONE and
not Object.const_defined?(:I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG) then
warn <<-WARNING
!!!SECURITY WARNING!!!
The SSL HTTP connection to:
#{connection.address}:#{connection.port}
!!!MAY NOT BE VERIFIED!!!
On your platform your OpenSSL implementation is broken.
There is no difference between the values of VERIFY_NONE and VERIFY_PEER.
This means that attempting to verify the security of SSL connections may not
work. This exposes you to man-in-the-middle exploits, snooping on the
contents of your connection and other dangers to the security of your data.
To disable this warning define the following constant at top-level in your
application:
I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG = nil
WARNING
end
connection.ca_file = @ca_file if @ca_file
connection.ca_path = @ca_path if @ca_path
if @ca_file or @ca_path then
connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
connection.verify_callback = @verify_callback if @verify_callback
end
if @certificate and @private_key then
connection.cert = @certificate
connection.key = @private_key
end
connection.cert_store = if @cert_store then
@cert_store
else
store = OpenSSL::X509::Store.new
store.set_default_paths
store
end
end
##
# SSL session lifetime
def ssl_timeout= ssl_timeout
@ssl_timeout = ssl_timeout
reconnect_ssl
end
##
# SSL version to use
def ssl_version= ssl_version
@ssl_version = ssl_version
reconnect_ssl
end
##
# Minimum SSL version to use
def min_version= min_version
@min_version = min_version
reconnect_ssl
end
##
# maximum SSL version to use
def max_version= max_version
@max_version = max_version
reconnect_ssl
end
##
# Sets the depth of SSL certificate verification
def verify_depth= verify_depth
@verify_depth = verify_depth
reconnect_ssl
end
##
# Sets the HTTPS verify mode. Defaults to OpenSSL::SSL::VERIFY_PEER.
#
# Setting this to VERIFY_NONE is a VERY BAD IDEA and should NEVER be used.
# Securely transfer the correct certificate and update the default
# certificate store or set the ca file instead.
def verify_mode= verify_mode
@verify_mode = verify_mode
reconnect_ssl
end
##
# Sets the HTTPS verify_hostname.
def verify_hostname= verify_hostname
@verify_hostname = verify_hostname
reconnect_ssl
end
##
# SSL verification callback.
def verify_callback= callback
@verify_callback = callback
reconnect_ssl
end
end
require_relative 'persistent/connection'
require_relative 'persistent/pool'
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/nested_context.rb 0000644 00000000457 15173517744 0023506 0 ustar 00 class Bundler::Thor
class NestedContext
def initialize
@depth = 0
end
def enter
push
yield
ensure
pop
end
def entered?
@depth.positive?
end
private
def push
@depth += 1
end
def pop
@depth -= 1
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell.rb 0000644 00000004456 15173517744 0021572 0 ustar 00 require "rbconfig"
class Bundler::Thor
module Base
class << self
attr_writer :shell
# Returns the shell used in all Bundler::Thor classes. If you are in a Unix platform
# it will use a colored log, otherwise it will use a basic one without color.
#
def shell
@shell ||= if ENV["THOR_SHELL"] && !ENV["THOR_SHELL"].empty?
Bundler::Thor::Shell.const_get(ENV["THOR_SHELL"])
elsif RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ && !ENV["ANSICON"]
Bundler::Thor::Shell::Basic
else
Bundler::Thor::Shell::Color
end
end
end
end
module Shell
SHELL_DELEGATED_METHODS = [:ask, :error, :set_color, :yes?, :no?, :say, :say_error, :say_status, :print_in_columns, :print_table, :print_wrapped, :file_collision, :terminal_width]
attr_writer :shell
autoload :Basic, File.expand_path("shell/basic", __dir__)
autoload :Color, File.expand_path("shell/color", __dir__)
autoload :HTML, File.expand_path("shell/html", __dir__)
# Add shell to initialize config values.
#
# ==== Configuration
# shell<Object>:: An instance of the shell to be used.
#
# ==== Examples
#
# class MyScript < Bundler::Thor
# argument :first, :type => :numeric
# end
#
# MyScript.new [1.0], { :foo => :bar }, :shell => Bundler::Thor::Shell::Basic.new
#
def initialize(args = [], options = {}, config = {})
super
self.shell = config[:shell]
shell.base ||= self if shell.respond_to?(:base)
end
# Holds the shell for the given Bundler::Thor instance. If no shell is given,
# it gets a default shell from Bundler::Thor::Base.shell.
def shell
@shell ||= Bundler::Thor::Base.shell.new
end
# Common methods that are delegated to the shell.
SHELL_DELEGATED_METHODS.each do |method|
module_eval <<-METHOD, __FILE__, __LINE__ + 1
def #{method}(*args,&block)
shell.#{method}(*args,&block)
end
METHOD
end
# Yields the given block with padding.
def with_padding
shell.padding += 1
yield
ensure
shell.padding -= 1
end
protected
# Allow shell to be shared between invocations.
#
def _shared_configuration #:nodoc:
super.merge!(shell: shell)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/util.rb 0000644 00000021756 15173517744 0021442 0 ustar 00 require "rbconfig"
class Bundler::Thor
module Sandbox #:nodoc:
end
# This module holds several utilities:
#
# 1) Methods to convert thor namespaces to constants and vice-versa.
#
# Bundler::Thor::Util.namespace_from_thor_class(Foo::Bar::Baz) #=> "foo:bar:baz"
#
# 2) Loading thor files and sandboxing:
#
# Bundler::Thor::Util.load_thorfile("~/.thor/foo")
#
module Util
class << self
# Receives a namespace and search for it in the Bundler::Thor::Base subclasses.
#
# ==== Parameters
# namespace<String>:: The namespace to search for.
#
def find_by_namespace(namespace)
namespace = "default#{namespace}" if namespace.empty? || namespace =~ /^:/
Bundler::Thor::Base.subclasses.detect { |klass| klass.namespace == namespace }
end
# Receives a constant and converts it to a Bundler::Thor namespace. Since Bundler::Thor
# commands can be added to a sandbox, this method is also responsible for
# removing the sandbox namespace.
#
# This method should not be used in general because it's used to deal with
# older versions of Bundler::Thor. On current versions, if you need to get the
# namespace from a class, just call namespace on it.
#
# ==== Parameters
# constant<Object>:: The constant to be converted to the thor path.
#
# ==== Returns
# String:: If we receive Foo::Bar::Baz it returns "foo:bar:baz"
#
def namespace_from_thor_class(constant)
constant = constant.to_s.gsub(/^Bundler::Thor::Sandbox::/, "")
constant = snake_case(constant).squeeze(":")
constant
end
# Given the contents, evaluate it inside the sandbox and returns the
# namespaces defined in the sandbox.
#
# ==== Parameters
# contents<String>
#
# ==== Returns
# Array[Object]
#
def namespaces_in_content(contents, file = __FILE__)
old_constants = Bundler::Thor::Base.subclasses.dup
Bundler::Thor::Base.subclasses.clear
load_thorfile(file, contents)
new_constants = Bundler::Thor::Base.subclasses.dup
Bundler::Thor::Base.subclasses.replace(old_constants)
new_constants.map!(&:namespace)
new_constants.compact!
new_constants
end
# Returns the thor classes declared inside the given class.
#
def thor_classes_in(klass)
stringfied_constants = klass.constants.map(&:to_s)
Bundler::Thor::Base.subclasses.select do |subclass|
next unless subclass.name
stringfied_constants.include?(subclass.name.gsub("#{klass.name}::", ""))
end
end
# Receives a string and convert it to snake case. SnakeCase returns snake_case.
#
# ==== Parameters
# String
#
# ==== Returns
# String
#
def snake_case(str)
return str.downcase if str =~ /^[A-Z_]+$/
str.gsub(/\B[A-Z]/, '_\&').squeeze("_") =~ /_*(.*)/
Regexp.last_match(-1).downcase
end
# Receives a string and convert it to camel case. camel_case returns CamelCase.
#
# ==== Parameters
# String
#
# ==== Returns
# String
#
def camel_case(str)
return str if str !~ /_/ && str =~ /[A-Z]+.*/
str.split("_").map(&:capitalize).join
end
# Receives a namespace and tries to retrieve a Bundler::Thor or Bundler::Thor::Group class
# from it. It first searches for a class using the all the given namespace,
# if it's not found, removes the highest entry and searches for the class
# again. If found, returns the highest entry as the class name.
#
# ==== Examples
#
# class Foo::Bar < Bundler::Thor
# def baz
# end
# end
#
# class Baz::Foo < Bundler::Thor::Group
# end
#
# Bundler::Thor::Util.namespace_to_thor_class("foo:bar") #=> Foo::Bar, nil # will invoke default command
# Bundler::Thor::Util.namespace_to_thor_class("baz:foo") #=> Baz::Foo, nil
# Bundler::Thor::Util.namespace_to_thor_class("foo:bar:baz") #=> Foo::Bar, "baz"
#
# ==== Parameters
# namespace<String>
#
def find_class_and_command_by_namespace(namespace, fallback = true)
if namespace.include?(":") # look for a namespaced command
*pieces, command = namespace.split(":")
namespace = pieces.join(":")
namespace = "default" if namespace.empty?
klass = Bundler::Thor::Base.subclasses.detect { |thor| thor.namespace == namespace && thor.commands.keys.include?(command) }
end
unless klass # look for a Bundler::Thor::Group with the right name
klass = Bundler::Thor::Util.find_by_namespace(namespace)
command = nil
end
if !klass && fallback # try a command in the default namespace
command = namespace
klass = Bundler::Thor::Util.find_by_namespace("")
end
[klass, command]
end
alias_method :find_class_and_task_by_namespace, :find_class_and_command_by_namespace
# Receives a path and load the thor file in the path. The file is evaluated
# inside the sandbox to avoid namespacing conflicts.
#
def load_thorfile(path, content = nil, debug = false)
content ||= File.read(path)
begin
Bundler::Thor::Sandbox.class_eval(content, path)
rescue StandardError => e
$stderr.puts("WARNING: unable to load thorfile #{path.inspect}: #{e.message}")
if debug
$stderr.puts(*e.backtrace)
else
$stderr.puts(e.backtrace.first)
end
end
end
def user_home
@@user_home ||= if ENV["HOME"]
ENV["HOME"]
elsif ENV["USERPROFILE"]
ENV["USERPROFILE"]
elsif ENV["HOMEDRIVE"] && ENV["HOMEPATH"]
File.join(ENV["HOMEDRIVE"], ENV["HOMEPATH"])
elsif ENV["APPDATA"]
ENV["APPDATA"]
else
begin
File.expand_path("~")
rescue
if File::ALT_SEPARATOR
"C:/"
else
"/"
end
end
end
end
# Returns the root where thor files are located, depending on the OS.
#
def thor_root
File.join(user_home, ".thor").tr("\\", "/")
end
# Returns the files in the thor root. On Windows thor_root will be something
# like this:
#
# C:\Documents and Settings\james\.thor
#
# If we don't #gsub the \ character, Dir.glob will fail.
#
def thor_root_glob
files = Dir["#{escape_globs(thor_root)}/*"]
files.map! do |file|
File.directory?(file) ? File.join(file, "main.thor") : file
end
end
# Where to look for Bundler::Thor files.
#
def globs_for(path)
path = escape_globs(path)
["#{path}/Thorfile", "#{path}/*.thor", "#{path}/tasks/*.thor", "#{path}/lib/tasks/**/*.thor"]
end
# Return the path to the ruby interpreter taking into account multiple
# installations and windows extensions.
#
def ruby_command
@ruby_command ||= begin
ruby_name = RbConfig::CONFIG["ruby_install_name"]
ruby = File.join(RbConfig::CONFIG["bindir"], ruby_name)
ruby << RbConfig::CONFIG["EXEEXT"]
# avoid using different name than ruby (on platforms supporting links)
if ruby_name != "ruby" && File.respond_to?(:readlink)
begin
alternate_ruby = File.join(RbConfig::CONFIG["bindir"], "ruby")
alternate_ruby << RbConfig::CONFIG["EXEEXT"]
# ruby is a symlink
if File.symlink? alternate_ruby
linked_ruby = File.readlink alternate_ruby
# symlink points to 'ruby_install_name'
ruby = alternate_ruby if linked_ruby == ruby_name || linked_ruby == ruby
end
rescue NotImplementedError # rubocop:disable Lint/HandleExceptions
# just ignore on windows
end
end
# escape string in case path to ruby executable contain spaces.
ruby.sub!(/.*\s.*/m, '"\&"')
ruby
end
end
# Returns a string that has had any glob characters escaped.
# The glob characters are `* ? { } [ ]`.
#
# ==== Examples
#
# Bundler::Thor::Util.escape_globs('[apps]') # => '\[apps\]'
#
# ==== Parameters
# String
#
# ==== Returns
# String
#
def escape_globs(path)
path.to_s.gsub(/[*?{}\[\]]/, '\\\\\\&')
end
# Returns a string that has had any HTML characters escaped.
#
# ==== Examples
#
# Bundler::Thor::Util.escape_html('<div>') # => "<div>"
#
# ==== Parameters
# String
#
# ==== Returns
# String
#
def escape_html(string)
CGI.escapeHTML(string)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/command.rb 0000644 00000012121 15173517744 0022065 0 ustar 00 class Bundler::Thor
class Command < Struct.new(:name, :description, :long_description, :wrap_long_description, :usage, :options, :options_relation, :ancestor_name)
FILE_REGEXP = /^#{Regexp.escape(File.dirname(__FILE__))}/
def initialize(name, description, long_description, wrap_long_description, usage, options = nil, options_relation = nil)
super(name.to_s, description, long_description, wrap_long_description, usage, options || {}, options_relation || {})
end
def initialize_copy(other) #:nodoc:
super(other)
self.options = other.options.dup if other.options
self.options_relation = other.options_relation.dup if other.options_relation
end
def hidden?
false
end
# By default, a command invokes a method in the thor class. You can change this
# implementation to create custom commands.
def run(instance, args = [])
arity = nil
if private_method?(instance)
instance.class.handle_no_command_error(name)
elsif public_method?(instance)
arity = instance.method(name).arity
instance.__send__(name, *args)
elsif local_method?(instance, :method_missing)
instance.__send__(:method_missing, name.to_sym, *args)
else
instance.class.handle_no_command_error(name)
end
rescue ArgumentError => e
handle_argument_error?(instance, e, caller) ? instance.class.handle_argument_error(self, e, args, arity) : (raise e)
rescue NoMethodError => e
handle_no_method_error?(instance, e, caller) ? instance.class.handle_no_command_error(name) : (raise e)
end
# Returns the formatted usage by injecting given required arguments
# and required options into the given usage.
def formatted_usage(klass, namespace = true, subcommand = false)
if ancestor_name
formatted = "#{ancestor_name} ".dup # add space
elsif namespace
namespace = klass.namespace
formatted = "#{namespace.gsub(/^(default)/, '')}:".dup
end
formatted ||= "#{klass.namespace.split(':').last} ".dup if subcommand
formatted ||= "".dup
Array(usage).map do |specific_usage|
formatted_specific_usage = formatted
formatted_specific_usage += required_arguments_for(klass, specific_usage)
# Add required options
formatted_specific_usage += " #{required_options}"
# Strip and go!
formatted_specific_usage.strip
end.join("\n")
end
def method_exclusive_option_names #:nodoc:
self.options_relation[:exclusive_option_names] || []
end
def method_at_least_one_option_names #:nodoc:
self.options_relation[:at_least_one_option_names] || []
end
protected
# Add usage with required arguments
def required_arguments_for(klass, usage)
if klass && !klass.arguments.empty?
usage.to_s.gsub(/^#{name}/) do |match|
match << " " << klass.arguments.map(&:usage).compact.join(" ")
end
else
usage.to_s
end
end
def not_debugging?(instance)
!(instance.class.respond_to?(:debugging) && instance.class.debugging)
end
def required_options
@required_options ||= options.map { |_, o| o.usage if o.required? }.compact.sort.join(" ")
end
# Given a target, checks if this class name is a public method.
def public_method?(instance) #:nodoc:
!(instance.public_methods & [name.to_s, name.to_sym]).empty?
end
def private_method?(instance)
!(instance.private_methods & [name.to_s, name.to_sym]).empty?
end
def local_method?(instance, name)
methods = instance.public_methods(false) + instance.private_methods(false) + instance.protected_methods(false)
!(methods & [name.to_s, name.to_sym]).empty?
end
def sans_backtrace(backtrace, caller) #:nodoc:
saned = backtrace.reject { |frame| frame =~ FILE_REGEXP || (frame =~ /\.java:/ && RUBY_PLATFORM =~ /java/) || (frame =~ %r{^kernel/} && RUBY_ENGINE =~ /rbx/) }
saned - caller
end
def handle_argument_error?(instance, error, caller)
not_debugging?(instance) && (error.message =~ /wrong number of arguments/ || error.message =~ /given \d*, expected \d*/) && begin
saned = sans_backtrace(error.backtrace, caller)
saned.empty? || saned.size == 1
end
end
def handle_no_method_error?(instance, error, caller)
not_debugging?(instance) &&
error.message =~ /^undefined method `#{name}' for #{Regexp.escape(instance.to_s)}$/
end
end
Task = Command
# A command that is hidden in help messages but still invocable.
class HiddenCommand < Command
def hidden?
true
end
end
HiddenTask = HiddenCommand
# A dynamic command that handles method missing scenarios.
class DynamicCommand < Command
def initialize(name, options = nil)
super(name.to_s, "A dynamically-generated command", name.to_s, nil, name.to_s, options)
end
def run(instance, args = [])
if (instance.methods & [name.to_s, name.to_sym]).empty?
super
else
instance.class.handle_no_command_error(name)
end
end
end
DynamicTask = DynamicCommand
end
gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb 0000644 00000004531 15173517745 0030063 0 ustar 00 share class Bundler::Thor
module CoreExt #:nodoc:
# A hash with indifferent access and magic predicates.
#
# hash = Bundler::Thor::CoreExt::HashWithIndifferentAccess.new 'foo' => 'bar', 'baz' => 'bee', 'force' => true
#
# hash[:foo] #=> 'bar'
# hash['foo'] #=> 'bar'
# hash.foo? #=> true
#
class HashWithIndifferentAccess < ::Hash #:nodoc:
def initialize(hash = {})
super()
hash.each do |key, value|
self[convert_key(key)] = value
end
end
def [](key)
super(convert_key(key))
end
def []=(key, value)
super(convert_key(key), value)
end
def delete(key)
super(convert_key(key))
end
def except(*keys)
dup.tap do |hash|
keys.each { |key| hash.delete(convert_key(key)) }
end
end
def fetch(key, *args)
super(convert_key(key), *args)
end
def slice(*keys)
super(*keys.map{ |key| convert_key(key) })
end
def key?(key)
super(convert_key(key))
end
def values_at(*indices)
indices.map { |key| self[convert_key(key)] }
end
def merge(other)
dup.merge!(other)
end
def merge!(other)
other.each do |key, value|
self[convert_key(key)] = value
end
self
end
def reverse_merge(other)
self.class.new(other).merge(self)
end
def reverse_merge!(other_hash)
replace(reverse_merge(other_hash))
end
def replace(other_hash)
super(other_hash)
end
# Convert to a Hash with String keys.
def to_hash
Hash.new(default).merge!(self)
end
protected
def convert_key(key)
key.is_a?(Symbol) ? key.to_s : key
end
# Magic predicates. For instance:
#
# options.force? # => !!options['force']
# options.shebang # => "/usr/lib/local/ruby"
# options.test_framework?(:rspec) # => options[:test_framework] == :rspec
#
def method_missing(method, *args)
method = method.to_s
if method =~ /^(\w+)\?$/
if args.empty?
!!self[$1]
else
self[$1] == args.first
end
else
self[method]
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell/wrapped_printer.rb 0000644 00000002015 15173517745 0024765 0 ustar 00 require_relative "column_printer"
require_relative "terminal"
class Bundler::Thor
module Shell
class WrappedPrinter < ColumnPrinter
def print(message)
width = Terminal.terminal_width - @indent
paras = message.split("\n\n")
paras.map! do |unwrapped|
words = unwrapped.split(" ")
counter = words.first.length
words.inject do |memo, word|
word = word.gsub(/\n\005/, "\n").gsub(/\005/, "\n")
counter = 0 if word.include? "\n"
if (counter + word.length + 1) < width
memo = "#{memo} #{word}"
counter += (word.length + 1)
else
memo = "#{memo}\n#{word}"
counter = word.length
end
memo
end
end.compact!
paras.each do |para|
para.split("\n").each do |line|
stdout.puts line.insert(0, " " * @indent)
end
stdout.puts unless para == paras.last
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell/basic.rb 0000644 00000027005 15173517745 0022647 0 ustar 00 require_relative "column_printer"
require_relative "table_printer"
require_relative "wrapped_printer"
class Bundler::Thor
module Shell
class Basic
attr_accessor :base
attr_reader :padding
# Initialize base, mute and padding to nil.
#
def initialize #:nodoc:
@base = nil
@mute = false
@padding = 0
@always_force = false
end
# Mute everything that's inside given block
#
def mute
@mute = true
yield
ensure
@mute = false
end
# Check if base is muted
#
def mute?
@mute
end
# Sets the output padding, not allowing less than zero values.
#
def padding=(value)
@padding = [0, value].max
end
# Sets the output padding while executing a block and resets it.
#
def indent(count = 1)
orig_padding = padding
self.padding = padding + count
yield
self.padding = orig_padding
end
# Asks something to the user and receives a response.
#
# If a default value is specified it will be presented to the user
# and allows them to select that value with an empty response. This
# option is ignored when limited answers are supplied.
#
# If asked to limit the correct responses, you can pass in an
# array of acceptable answers. If one of those is not supplied,
# they will be shown a message stating that one of those answers
# must be given and re-asked the question.
#
# If asking for sensitive information, the :echo option can be set
# to false to mask user input from $stdin.
#
# If the required input is a path, then set the path option to
# true. This will enable tab completion for file paths relative
# to the current working directory on systems that support
# Readline.
#
# ==== Example
# ask("What is your name?")
#
# ask("What is the planet furthest from the sun?", :default => "Pluto")
#
# ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"])
#
# ask("What is your password?", :echo => false)
#
# ask("Where should the file be saved?", :path => true)
#
def ask(statement, *args)
options = args.last.is_a?(Hash) ? args.pop : {}
color = args.first
if options[:limited_to]
ask_filtered(statement, color, options)
else
ask_simply(statement, color, options)
end
end
# Say (print) something to the user. If the sentence ends with a whitespace
# or tab character, a new line is not appended (print + flush). Otherwise
# are passed straight to puts (behavior got from Highline).
#
# ==== Example
# say("I know you knew that.")
#
def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
return if quiet?
buffer = prepare_message(message, *color)
buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")
stdout.print(buffer)
stdout.flush
end
# Say (print) an error to the user. If the sentence ends with a whitespace
# or tab character, a new line is not appended (print + flush). Otherwise
# are passed straight to puts (behavior got from Highline).
#
# ==== Example
# say_error("error: something went wrong")
#
def say_error(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
return if quiet?
buffer = prepare_message(message, *color)
buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")
stderr.print(buffer)
stderr.flush
end
# Say a status with the given color and appends the message. Since this
# method is used frequently by actions, it allows nil or false to be given
# in log_status, avoiding the message from being shown. If a Symbol is
# given in log_status, it's used as the color.
#
def say_status(status, message, log_status = true)
return if quiet? || log_status == false
spaces = " " * (padding + 1)
status = status.to_s.rjust(12)
margin = " " * status.length + spaces
color = log_status.is_a?(Symbol) ? log_status : :green
status = set_color status, color, true if color
message = message.to_s.chomp.gsub(/(?<!\A)^/, margin)
buffer = "#{status}#{spaces}#{message}\n"
stdout.print(buffer)
stdout.flush
end
# Make a question the to user and returns true if the user replies "y" or
# "yes".
#
def yes?(statement, color = nil)
!!(ask(statement, color, add_to_history: false) =~ is?(:yes))
end
# Make a question the to user and returns true if the user replies "n" or
# "no".
#
def no?(statement, color = nil)
!!(ask(statement, color, add_to_history: false) =~ is?(:no))
end
# Prints values in columns
#
# ==== Parameters
# Array[String, String, ...]
#
def print_in_columns(array)
printer = ColumnPrinter.new(stdout)
printer.print(array)
end
# Prints a table.
#
# ==== Parameters
# Array[Array[String, String, ...]]
#
# ==== Options
# indent<Integer>:: Indent the first column by indent value.
# colwidth<Integer>:: Force the first column to colwidth spaces wide.
# borders<Boolean>:: Adds ascii borders.
#
def print_table(array, options = {}) # rubocop:disable Metrics/MethodLength
printer = TablePrinter.new(stdout, options)
printer.print(array)
end
# Prints a long string, word-wrapping the text to the current width of the
# terminal display. Ideal for printing heredocs.
#
# ==== Parameters
# String
#
# ==== Options
# indent<Integer>:: Indent each line of the printed paragraph by indent value.
#
def print_wrapped(message, options = {})
printer = WrappedPrinter.new(stdout, options)
printer.print(message)
end
# Deals with file collision and returns true if the file should be
# overwritten and false otherwise. If a block is given, it uses the block
# response as the content for the diff.
#
# ==== Parameters
# destination<String>:: the destination file to solve conflicts
# block<Proc>:: an optional block that returns the value to be used in diff and merge
#
def file_collision(destination)
return true if @always_force
options = block_given? ? "[Ynaqdhm]" : "[Ynaqh]"
loop do
answer = ask(
%[Overwrite #{destination}? (enter "h" for help) #{options}],
add_to_history: false
)
case answer
when nil
say ""
return true
when is?(:yes), is?(:force), ""
return true
when is?(:no), is?(:skip)
return false
when is?(:always)
return @always_force = true
when is?(:quit)
say "Aborting..."
raise SystemExit
when is?(:diff)
show_diff(destination, yield) if block_given?
say "Retrying..."
when is?(:merge)
if block_given? && !merge_tool.empty?
merge(destination, yield)
return nil
end
say "Please specify merge tool to `THOR_MERGE` env."
else
say file_collision_help(block_given?)
end
end
end
# Called if something goes wrong during the execution. This is used by Bundler::Thor
# internally and should not be used inside your scripts. If something went
# wrong, you can always raise an exception. If you raise a Bundler::Thor::Error, it
# will be rescued and wrapped in the method below.
#
def error(statement)
stderr.puts statement
end
# Apply color to the given string with optional bold. Disabled in the
# Bundler::Thor::Shell::Basic class.
#
def set_color(string, *) #:nodoc:
string
end
protected
def prepare_message(message, *color)
spaces = " " * padding
spaces + set_color(message.to_s, *color)
end
def can_display_colors?
false
end
def lookup_color(color)
return color unless color.is_a?(Symbol)
self.class.const_get(color.to_s.upcase)
end
def stdout
$stdout
end
def stderr
$stderr
end
def is?(value) #:nodoc:
value = value.to_s
if value.size == 1
/\A#{value}\z/i
else
/\A(#{value}|#{value[0, 1]})\z/i
end
end
def file_collision_help(block_given) #:nodoc:
help = <<-HELP
Y - yes, overwrite
n - no, do not overwrite
a - all, overwrite this and all others
q - quit, abort
h - help, show this help
HELP
if block_given
help << <<-HELP
d - diff, show the differences between the old and the new
m - merge, run merge tool
HELP
end
help
end
def show_diff(destination, content) #:nodoc:
diff_cmd = ENV["THOR_DIFF"] || ENV["RAILS_DIFF"] || "diff -u"
require "tempfile"
Tempfile.open(File.basename(destination), File.dirname(destination)) do |temp|
temp.write content
temp.rewind
system %(#{diff_cmd} "#{destination}" "#{temp.path}")
end
end
def quiet? #:nodoc:
mute? || (base && base.options[:quiet])
end
def unix?
Terminal.unix?
end
def ask_simply(statement, color, options)
default = options[:default]
message = [statement, ("(#{default})" if default), nil].uniq.join(" ")
message = prepare_message(message, *color)
result = Bundler::Thor::LineEditor.readline(message, options)
return unless result
result = result.strip
if default && result == ""
default
else
result
end
end
def ask_filtered(statement, color, options)
answer_set = options[:limited_to]
case_insensitive = options.fetch(:case_insensitive, false)
correct_answer = nil
until correct_answer
answers = answer_set.join(", ")
answer = ask_simply("#{statement} [#{answers}]", color, options)
correct_answer = answer_match(answer_set, answer, case_insensitive)
say("Your response must be one of: [#{answers}]. Please try again.") unless correct_answer
end
correct_answer
end
def answer_match(possibilities, answer, case_insensitive)
if case_insensitive
possibilities.detect{ |possibility| possibility.downcase == answer.downcase }
else
possibilities.detect{ |possibility| possibility == answer }
end
end
def merge(destination, content) #:nodoc:
require "tempfile"
Tempfile.open([File.basename(destination), File.extname(destination)], File.dirname(destination)) do |temp|
temp.write content
temp.rewind
system %(#{merge_tool} "#{temp.path}" "#{destination}")
end
end
def merge_tool #:nodoc:
@merge_tool ||= ENV["THOR_MERGE"] || git_merge_tool
end
def git_merge_tool #:nodoc:
`git config merge.tool`.rstrip rescue ""
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell/table_printer.rb 0000644 00000006517 15173517745 0024425 0 ustar 00 require_relative "column_printer"
require_relative "terminal"
class Bundler::Thor
module Shell
class TablePrinter < ColumnPrinter
BORDER_SEPARATOR = :separator
def initialize(stdout, options = {})
super
@formats = []
@maximas = []
@colwidth = options[:colwidth]
@truncate = options[:truncate] == true ? Terminal.terminal_width : options[:truncate]
@padding = 1
end
def print(array)
return if array.empty?
prepare(array)
print_border_separator if options[:borders]
array.each do |row|
if options[:borders] && row == BORDER_SEPARATOR
print_border_separator
next
end
sentence = "".dup
row.each_with_index do |column, index|
sentence << format_cell(column, row.size, index)
end
sentence = truncate(sentence)
sentence << "|" if options[:borders]
stdout.puts indentation + sentence
end
print_border_separator if options[:borders]
end
private
def prepare(array)
array = array.reject{|row| row == BORDER_SEPARATOR }
@formats << "%-#{@colwidth + 2}s".dup if @colwidth
start = @colwidth ? 1 : 0
colcount = array.max { |a, b| a.size <=> b.size }.size
start.upto(colcount - 1) do |index|
maxima = array.map { |row| row[index] ? row[index].to_s.size : 0 }.max
@maximas << maxima
@formats << if options[:borders]
"%-#{maxima}s".dup
elsif index == colcount - 1
# Don't output 2 trailing spaces when printing the last column
"%-s".dup
else
"%-#{maxima + 2}s".dup
end
end
@formats << "%s"
end
def format_cell(column, row_size, index)
maxima = @maximas[index]
f = if column.is_a?(Numeric)
if options[:borders]
# With borders we handle padding separately
"%#{maxima}s"
elsif index == row_size - 1
# Don't output 2 trailing spaces when printing the last column
"%#{maxima}s"
else
"%#{maxima}s "
end
else
@formats[index]
end
cell = "".dup
cell << "|" + " " * @padding if options[:borders]
cell << f % column.to_s
cell << " " * @padding if options[:borders]
cell
end
def print_border_separator
separator = @maximas.map do |maxima|
"+" + "-" * (maxima + 2 * @padding)
end
stdout.puts indentation + separator.join + "+"
end
def truncate(string)
return string unless @truncate
as_unicode do
chars = string.chars.to_a
if chars.length <= @truncate
chars.join
else
chars[0, @truncate - 3 - @indent].join + "..."
end
end
end
def indentation
" " * @indent
end
if "".respond_to?(:encode)
def as_unicode
yield
end
else
def as_unicode
old = $KCODE # rubocop:disable Style/GlobalVars
$KCODE = "U" # rubocop:disable Style/GlobalVars
yield
ensure
$KCODE = old # rubocop:disable Style/GlobalVars
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell/color.rb 0000644 00000007115 15173517745 0022704 0 ustar 00 require_relative "basic"
class Bundler::Thor
module Shell
# Inherit from Bundler::Thor::Shell::Basic and add set_color behavior. Check
# Bundler::Thor::Shell::Basic to see all available methods.
#
class Color < Basic
# Embed in a String to clear all previous ANSI sequences.
CLEAR = "\e[0m"
# The start of an ANSI bold sequence.
BOLD = "\e[1m"
# Set the terminal's foreground ANSI color to black.
BLACK = "\e[30m"
# Set the terminal's foreground ANSI color to red.
RED = "\e[31m"
# Set the terminal's foreground ANSI color to green.
GREEN = "\e[32m"
# Set the terminal's foreground ANSI color to yellow.
YELLOW = "\e[33m"
# Set the terminal's foreground ANSI color to blue.
BLUE = "\e[34m"
# Set the terminal's foreground ANSI color to magenta.
MAGENTA = "\e[35m"
# Set the terminal's foreground ANSI color to cyan.
CYAN = "\e[36m"
# Set the terminal's foreground ANSI color to white.
WHITE = "\e[37m"
# Set the terminal's background ANSI color to black.
ON_BLACK = "\e[40m"
# Set the terminal's background ANSI color to red.
ON_RED = "\e[41m"
# Set the terminal's background ANSI color to green.
ON_GREEN = "\e[42m"
# Set the terminal's background ANSI color to yellow.
ON_YELLOW = "\e[43m"
# Set the terminal's background ANSI color to blue.
ON_BLUE = "\e[44m"
# Set the terminal's background ANSI color to magenta.
ON_MAGENTA = "\e[45m"
# Set the terminal's background ANSI color to cyan.
ON_CYAN = "\e[46m"
# Set the terminal's background ANSI color to white.
ON_WHITE = "\e[47m"
# Set color by using a string or one of the defined constants. If a third
# option is set to true, it also adds bold to the string. This is based
# on Highline implementation and it automatically appends CLEAR to the end
# of the returned String.
#
# Pass foreground, background and bold options to this method as
# symbols.
#
# Example:
#
# set_color "Hi!", :red, :on_white, :bold
#
# The available colors are:
#
# :bold
# :black
# :red
# :green
# :yellow
# :blue
# :magenta
# :cyan
# :white
# :on_black
# :on_red
# :on_green
# :on_yellow
# :on_blue
# :on_magenta
# :on_cyan
# :on_white
def set_color(string, *colors)
if colors.compact.empty? || !can_display_colors?
string
elsif colors.all? { |color| color.is_a?(Symbol) || color.is_a?(String) }
ansi_colors = colors.map { |color| lookup_color(color) }
"#{ansi_colors.join}#{string}#{CLEAR}"
else
# The old API was `set_color(color, bold=boolean)`. We
# continue to support the old API because you should never
# break old APIs unnecessarily :P
foreground, bold = colors
foreground = self.class.const_get(foreground.to_s.upcase) if foreground.is_a?(Symbol)
bold = bold ? BOLD : ""
"#{bold}#{foreground}#{string}#{CLEAR}"
end
end
protected
def can_display_colors?
are_colors_supported? && !are_colors_disabled?
end
def are_colors_supported?
stdout.tty? && ENV["TERM"] != "dumb"
end
def are_colors_disabled?
!ENV["NO_COLOR"].nil? && !ENV["NO_COLOR"].empty?
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell/html.rb 0000644 00000006161 15173517745 0022532 0 ustar 00 require_relative "basic"
class Bundler::Thor
module Shell
# Inherit from Bundler::Thor::Shell::Basic and add set_color behavior. Check
# Bundler::Thor::Shell::Basic to see all available methods.
#
class HTML < Basic
# The start of an HTML bold sequence.
BOLD = "font-weight: bold"
# Set the terminal's foreground HTML color to black.
BLACK = "color: black"
# Set the terminal's foreground HTML color to red.
RED = "color: red"
# Set the terminal's foreground HTML color to green.
GREEN = "color: green"
# Set the terminal's foreground HTML color to yellow.
YELLOW = "color: yellow"
# Set the terminal's foreground HTML color to blue.
BLUE = "color: blue"
# Set the terminal's foreground HTML color to magenta.
MAGENTA = "color: magenta"
# Set the terminal's foreground HTML color to cyan.
CYAN = "color: cyan"
# Set the terminal's foreground HTML color to white.
WHITE = "color: white"
# Set the terminal's background HTML color to black.
ON_BLACK = "background-color: black"
# Set the terminal's background HTML color to red.
ON_RED = "background-color: red"
# Set the terminal's background HTML color to green.
ON_GREEN = "background-color: green"
# Set the terminal's background HTML color to yellow.
ON_YELLOW = "background-color: yellow"
# Set the terminal's background HTML color to blue.
ON_BLUE = "background-color: blue"
# Set the terminal's background HTML color to magenta.
ON_MAGENTA = "background-color: magenta"
# Set the terminal's background HTML color to cyan.
ON_CYAN = "background-color: cyan"
# Set the terminal's background HTML color to white.
ON_WHITE = "background-color: white"
# Set color by using a string or one of the defined constants. If a third
# option is set to true, it also adds bold to the string. This is based
# on Highline implementation and it automatically appends CLEAR to the end
# of the returned String.
#
def set_color(string, *colors)
if colors.all? { |color| color.is_a?(Symbol) || color.is_a?(String) }
html_colors = colors.map { |color| lookup_color(color) }
"<span style=\"#{html_colors.join('; ')};\">#{Bundler::Thor::Util.escape_html(string)}</span>"
else
color, bold = colors
html_color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
styles = [html_color]
styles << BOLD if bold
"<span style=\"#{styles.join('; ')};\">#{Bundler::Thor::Util.escape_html(string)}</span>"
end
end
# Ask something to the user and receives a response.
#
# ==== Example
# ask("What is your name?")
#
# TODO: Implement #ask for Bundler::Thor::Shell::HTML
def ask(statement, color = nil)
raise NotImplementedError, "Implement #ask for Bundler::Thor::Shell::HTML"
end
protected
def can_display_colors?
true
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell/column_printer.rb 0000644 00000001416 15173517745 0024624 0 ustar 00 require_relative "terminal"
class Bundler::Thor
module Shell
class ColumnPrinter
attr_reader :stdout, :options
def initialize(stdout, options = {})
@stdout = stdout
@options = options
@indent = options[:indent].to_i
end
def print(array)
return if array.empty?
colwidth = (array.map { |el| el.to_s.size }.max || 0) + 2
array.each_with_index do |value, index|
# Don't output trailing spaces when printing the last column
if ((((index + 1) % (Terminal.terminal_width / colwidth))).zero? && !index.zero?) || index + 1 == array.length
stdout.puts value
else
stdout.printf("%-#{colwidth}s", value)
end
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/shell/terminal.rb 0000644 00000002024 15173517745 0023373 0 ustar 00 class Bundler::Thor
module Shell
module Terminal
DEFAULT_TERMINAL_WIDTH = 80
class << self
# This code was copied from Rake, available under MIT-LICENSE
# Copyright (c) 2003, 2004 Jim Weirich
def terminal_width
result = if ENV["THOR_COLUMNS"]
ENV["THOR_COLUMNS"].to_i
else
unix? ? dynamic_width : DEFAULT_TERMINAL_WIDTH
end
result < 10 ? DEFAULT_TERMINAL_WIDTH : result
rescue
DEFAULT_TERMINAL_WIDTH
end
def unix?
RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris)/i
end
private
# Calculate the dynamic width of the terminal
def dynamic_width
@dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
end
def dynamic_width_stty
`stty size 2>/dev/null`.split[1].to_i
end
def dynamic_width_tput
`tput cols 2>/dev/null`.to_i
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/actions.rb 0000644 00000024744 15173517745 0022126 0 ustar 00 require_relative "actions/create_file"
require_relative "actions/create_link"
require_relative "actions/directory"
require_relative "actions/empty_directory"
require_relative "actions/file_manipulation"
require_relative "actions/inject_into_file"
class Bundler::Thor
module Actions
attr_accessor :behavior
def self.included(base) #:nodoc:
super(base)
base.extend ClassMethods
end
module ClassMethods
# Hold source paths for one Bundler::Thor instance. source_paths_for_search is the
# method responsible to gather source_paths from this current class,
# inherited paths and the source root.
#
def source_paths
@_source_paths ||= []
end
# Stores and return the source root for this class
def source_root(path = nil)
@_source_root = path if path
@_source_root ||= nil
end
# Returns the source paths in the following order:
#
# 1) This class source paths
# 2) Source root
# 3) Parents source paths
#
def source_paths_for_search
paths = []
paths += source_paths
paths << source_root if source_root
paths += from_superclass(:source_paths, [])
paths
end
# Add runtime options that help actions execution.
#
def add_runtime_options!
class_option :force, type: :boolean, aliases: "-f", group: :runtime,
desc: "Overwrite files that already exist"
class_option :pretend, type: :boolean, aliases: "-p", group: :runtime,
desc: "Run but do not make any changes"
class_option :quiet, type: :boolean, aliases: "-q", group: :runtime,
desc: "Suppress status output"
class_option :skip, type: :boolean, aliases: "-s", group: :runtime,
desc: "Skip files that already exist"
end
end
# Extends initializer to add more configuration options.
#
# ==== Configuration
# behavior<Symbol>:: The actions default behavior. Can be :invoke or :revoke.
# It also accepts :force, :skip and :pretend to set the behavior
# and the respective option.
#
# destination_root<String>:: The root directory needed for some actions.
#
def initialize(args = [], options = {}, config = {})
self.behavior = case config[:behavior].to_s
when "force", "skip"
_cleanup_options_and_set(options, config[:behavior])
:invoke
when "revoke"
:revoke
else
:invoke
end
super
self.destination_root = config[:destination_root]
end
# Wraps an action object and call it accordingly to the thor class behavior.
#
def action(instance) #:nodoc:
if behavior == :revoke
instance.revoke!
else
instance.invoke!
end
end
# Returns the root for this thor class (also aliased as destination root).
#
def destination_root
@destination_stack.last
end
# Sets the root for this thor class. Relatives path are added to the
# directory where the script was invoked and expanded.
#
def destination_root=(root)
@destination_stack ||= []
@destination_stack[0] = File.expand_path(root || "")
end
# Returns the given path relative to the absolute root (ie, root where
# the script started).
#
def relative_to_original_destination_root(path, remove_dot = true)
root = @destination_stack[0]
if path.start_with?(root) && [File::SEPARATOR, File::ALT_SEPARATOR, nil, ""].include?(path[root.size..root.size])
path = path.dup
path[0...root.size] = "."
remove_dot ? (path[2..-1] || "") : path
else
path
end
end
# Holds source paths in instance so they can be manipulated.
#
def source_paths
@source_paths ||= self.class.source_paths_for_search
end
# Receives a file or directory and search for it in the source paths.
#
def find_in_source_paths(file)
possible_files = [file, file + TEMPLATE_EXTNAME]
relative_root = relative_to_original_destination_root(destination_root, false)
source_paths.each do |source|
possible_files.each do |f|
source_file = File.expand_path(f, File.join(source, relative_root))
return source_file if File.exist?(source_file)
end
end
message = "Could not find #{file.inspect} in any of your source paths. ".dup
unless self.class.source_root
message << "Please invoke #{self.class.name}.source_root(PATH) with the PATH containing your templates. "
end
message << if source_paths.empty?
"Currently you have no source paths."
else
"Your current source paths are: \n#{source_paths.join("\n")}"
end
raise Error, message
end
# Do something in the root or on a provided subfolder. If a relative path
# is given it's referenced from the current root. The full path is yielded
# to the block you provide. The path is set back to the previous path when
# the method exits.
#
# Returns the value yielded by the block.
#
# ==== Parameters
# dir<String>:: the directory to move to.
# config<Hash>:: give :verbose => true to log and use padding.
#
def inside(dir = "", config = {}, &block)
verbose = config.fetch(:verbose, false)
pretend = options[:pretend]
say_status :inside, dir, verbose
shell.padding += 1 if verbose
@destination_stack.push File.expand_path(dir, destination_root)
# If the directory doesn't exist and we're not pretending
if !File.exist?(destination_root) && !pretend
require "fileutils"
FileUtils.mkdir_p(destination_root)
end
result = nil
if pretend
# In pretend mode, just yield down to the block
result = block.arity == 1 ? yield(destination_root) : yield
else
require "fileutils"
FileUtils.cd(destination_root) { result = block.arity == 1 ? yield(destination_root) : yield }
end
@destination_stack.pop
shell.padding -= 1 if verbose
result
end
# Goes to the root and execute the given block.
#
def in_root
inside(@destination_stack.first) { yield }
end
# Loads an external file and execute it in the instance binding.
#
# ==== Parameters
# path<String>:: The path to the file to execute. Can be a web address or
# a relative path from the source root.
#
# ==== Examples
#
# apply "http://gist.github.com/103208"
#
# apply "recipes/jquery.rb"
#
def apply(path, config = {})
verbose = config.fetch(:verbose, true)
is_uri = path =~ %r{^https?\://}
path = find_in_source_paths(path) unless is_uri
say_status :apply, path, verbose
shell.padding += 1 if verbose
contents = if is_uri
require "open-uri"
URI.open(path, "Accept" => "application/x-thor-template", &:read)
else
File.open(path, &:read)
end
instance_eval(contents, path)
shell.padding -= 1 if verbose
end
# Executes a command returning the contents of the command.
#
# ==== Parameters
# command<String>:: the command to be executed.
# config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output. Specify :with
# to append an executable to command execution.
#
# ==== Example
#
# inside('vendor') do
# run('ln -s ~/edge rails')
# end
#
def run(command, config = {})
return unless behavior == :invoke
destination = relative_to_original_destination_root(destination_root, false)
desc = "#{command} from #{destination.inspect}"
if config[:with]
desc = "#{File.basename(config[:with].to_s)} #{desc}"
command = "#{config[:with]} #{command}"
end
say_status :run, desc, config.fetch(:verbose, true)
return if options[:pretend]
env_splat = [config[:env]] if config[:env]
if config[:capture]
require "open3"
result, status = Open3.capture2e(*env_splat, command.to_s)
success = status.success?
else
result = system(*env_splat, command.to_s)
success = result
end
abort if !success && config.fetch(:abort_on_failure, self.class.exit_on_failure?)
result
end
# Executes a ruby script (taking into account WIN32 platform quirks).
#
# ==== Parameters
# command<String>:: the command to be executed.
# config<Hash>:: give :verbose => false to not log the status.
#
def run_ruby_script(command, config = {})
return unless behavior == :invoke
run command, config.merge(with: Bundler::Thor::Util.ruby_command)
end
# Run a thor command. A hash of options can be given and it's converted to
# switches.
#
# ==== Parameters
# command<String>:: the command to be invoked
# args<Array>:: arguments to the command
# config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output.
# Other options are given as parameter to Bundler::Thor.
#
#
# ==== Examples
#
# thor :install, "http://gist.github.com/103208"
# #=> thor install http://gist.github.com/103208
#
# thor :list, :all => true, :substring => 'rails'
# #=> thor list --all --substring=rails
#
def thor(command, *args)
config = args.last.is_a?(Hash) ? args.pop : {}
verbose = config.key?(:verbose) ? config.delete(:verbose) : true
pretend = config.key?(:pretend) ? config.delete(:pretend) : false
capture = config.key?(:capture) ? config.delete(:capture) : false
args.unshift(command)
args.push Bundler::Thor::Options.to_switches(config)
command = args.join(" ").strip
run command, with: :thor, verbose: verbose, pretend: pretend, capture: capture
end
protected
# Allow current root to be shared between invocations.
#
def _shared_configuration #:nodoc:
super.merge!(destination_root: destination_root)
end
def _cleanup_options_and_set(options, key) #:nodoc:
case options
when Array
%w(--force -f --skip -s).each { |i| options.delete(i) }
options << "--#{key}"
when Hash
[:force, :skip, "force", "skip"].each { |i| options.delete(i) }
options.merge!(key => true)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/version.rb 0000644 00000000054 15173517745 0022137 0 ustar 00 class Bundler::Thor
VERSION = "1.3.0"
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/parser.rb 0000644 00000000212 15173517745 0021742 0 ustar 00 require_relative "parser/argument"
require_relative "parser/arguments"
require_relative "parser/option"
require_relative "parser/options"
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/invocation.rb 0000644 00000014106 15173517745 0022626 0 ustar 00 class Bundler::Thor
module Invocation
def self.included(base) #:nodoc:
super(base)
base.extend ClassMethods
end
module ClassMethods
# This method is responsible for receiving a name and find the proper
# class and command for it. The key is an optional parameter which is
# available only in class methods invocations (i.e. in Bundler::Thor::Group).
def prepare_for_invocation(key, name) #:nodoc:
case name
when Symbol, String
Bundler::Thor::Util.find_class_and_command_by_namespace(name.to_s, !key)
else
name
end
end
end
# Make initializer aware of invocations and the initialization args.
def initialize(args = [], options = {}, config = {}, &block) #:nodoc:
@_invocations = config[:invocations] || Hash.new { |h, k| h[k] = [] }
@_initializer = [args, options, config]
super
end
# Make the current command chain accessible with in a Bundler::Thor-(sub)command
def current_command_chain
@_invocations.values.flatten.map(&:to_sym)
end
# Receives a name and invokes it. The name can be a string (either "command" or
# "namespace:command"), a Bundler::Thor::Command, a Class or a Bundler::Thor instance. If the
# command cannot be guessed by name, it can also be supplied as second argument.
#
# You can also supply the arguments, options and configuration values for
# the command to be invoked, if none is given, the same values used to
# initialize the invoker are used to initialize the invoked.
#
# When no name is given, it will invoke the default command of the current class.
#
# ==== Examples
#
# class A < Bundler::Thor
# def foo
# invoke :bar
# invoke "b:hello", ["Erik"]
# end
#
# def bar
# invoke "b:hello", ["Erik"]
# end
# end
#
# class B < Bundler::Thor
# def hello(name)
# puts "hello #{name}"
# end
# end
#
# You can notice that the method "foo" above invokes two commands: "bar",
# which belongs to the same class and "hello" which belongs to the class B.
#
# By using an invocation system you ensure that a command is invoked only once.
# In the example above, invoking "foo" will invoke "b:hello" just once, even
# if it's invoked later by "bar" method.
#
# When class A invokes class B, all arguments used on A initialization are
# supplied to B. This allows lazy parse of options. Let's suppose you have
# some rspec commands:
#
# class Rspec < Bundler::Thor::Group
# class_option :mock_framework, :type => :string, :default => :rr
#
# def invoke_mock_framework
# invoke "rspec:#{options[:mock_framework]}"
# end
# end
#
# As you noticed, it invokes the given mock framework, which might have its
# own options:
#
# class Rspec::RR < Bundler::Thor::Group
# class_option :style, :type => :string, :default => :mock
# end
#
# Since it's not rspec concern to parse mock framework options, when RR
# is invoked all options are parsed again, so RR can extract only the options
# that it's going to use.
#
# If you want Rspec::RR to be initialized with its own set of options, you
# have to do that explicitly:
#
# invoke "rspec:rr", [], :style => :foo
#
# Besides giving an instance, you can also give a class to invoke:
#
# invoke Rspec::RR, [], :style => :foo
#
def invoke(name = nil, *args)
if name.nil?
warn "[Bundler::Thor] Calling invoke() without argument is deprecated. Please use invoke_all instead.\n#{caller.join("\n")}"
return invoke_all
end
args.unshift(nil) if args.first.is_a?(Array) || args.first.nil?
command, args, opts, config = args
klass, command = _retrieve_class_and_command(name, command)
raise "Missing Bundler::Thor class for invoke #{name}" unless klass
raise "Expected Bundler::Thor class, got #{klass}" unless klass <= Bundler::Thor::Base
args, opts, config = _parse_initialization_options(args, opts, config)
klass.send(:dispatch, command, args, opts, config) do |instance|
instance.parent_options = options
end
end
# Invoke the given command if the given args.
def invoke_command(command, *args) #:nodoc:
current = @_invocations[self.class]
unless current.include?(command.name)
current << command.name
command.run(self, *args)
end
end
alias_method :invoke_task, :invoke_command
# Invoke all commands for the current instance.
def invoke_all #:nodoc:
self.class.all_commands.map { |_, command| invoke_command(command) }
end
# Invokes using shell padding.
def invoke_with_padding(*args)
with_padding { invoke(*args) }
end
protected
# Configuration values that are shared between invocations.
def _shared_configuration #:nodoc:
{invocations: @_invocations}
end
# This method simply retrieves the class and command to be invoked.
# If the name is nil or the given name is a command in the current class,
# use the given name and return self as class. Otherwise, call
# prepare_for_invocation in the current class.
def _retrieve_class_and_command(name, sent_command = nil) #:nodoc:
if name.nil?
[self.class, nil]
elsif self.class.all_commands[name.to_s]
[self.class, name.to_s]
else
klass, command = self.class.prepare_for_invocation(nil, name)
[klass, command || sent_command]
end
end
alias_method :_retrieve_class_and_task, :_retrieve_class_and_command
# Initialize klass using values stored in the @_initializer.
def _parse_initialization_options(args, opts, config) #:nodoc:
stored_args, stored_opts, stored_config = @_initializer
args ||= stored_args.dup
opts ||= stored_opts.dup
config ||= {}
config = stored_config.merge(_shared_configuration).merge!(config)
[args, opts, config]
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/line_editor.rb 0000644 00000000607 15173517745 0022753 0 ustar 00 require_relative "line_editor/basic"
require_relative "line_editor/readline"
class Bundler::Thor
module LineEditor
def self.readline(prompt, options = {})
best_available.new(prompt, options).readline
end
def self.best_available
[
Bundler::Thor::LineEditor::Readline,
Bundler::Thor::LineEditor::Basic
].detect(&:available?)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/parser/arguments.rb 0000644 00000011203 15173517745 0023751 0 ustar 00 class Bundler::Thor
class Arguments #:nodoc:
NUMERIC = /[-+]?(\d*\.\d+|\d+)/
# Receives an array of args and returns two arrays, one with arguments
# and one with switches.
#
def self.split(args)
arguments = []
args.each do |item|
break if item.is_a?(String) && item =~ /^-/
arguments << item
end
[arguments, args[Range.new(arguments.size, -1)]]
end
def self.parse(*args)
to_parse = args.pop
new(*args).parse(to_parse)
end
# Takes an array of Bundler::Thor::Argument objects.
#
def initialize(arguments = [])
@assigns = {}
@non_assigned_required = []
@switches = arguments
arguments.each do |argument|
if !argument.default.nil?
@assigns[argument.human_name] = argument.default.dup
elsif argument.required?
@non_assigned_required << argument
end
end
end
def parse(args)
@pile = args.dup
@switches.each do |argument|
break unless peek
@non_assigned_required.delete(argument)
@assigns[argument.human_name] = send(:"parse_#{argument.type}", argument.human_name)
end
check_requirement!
@assigns
end
def remaining
@pile
end
private
def no_or_skip?(arg)
arg =~ /^--(no|skip)-([-\w]+)$/
$2
end
def last?
@pile.empty?
end
def peek
@pile.first
end
def shift
@pile.shift
end
def unshift(arg)
if arg.is_a?(Array)
@pile = arg + @pile
else
@pile.unshift(arg)
end
end
def current_is_value?
peek && peek.to_s !~ /^-{1,2}\S+/
end
# Runs through the argument array getting strings that contains ":" and
# mark it as a hash:
#
# [ "name:string", "age:integer" ]
#
# Becomes:
#
# { "name" => "string", "age" => "integer" }
#
def parse_hash(name)
return shift if peek.is_a?(Hash)
hash = {}
while current_is_value? && peek.include?(":")
key, value = shift.split(":", 2)
raise MalformattedArgumentError, "You can't specify '#{key}' more than once in option '#{name}'; got #{key}:#{hash[key]} and #{key}:#{value}" if hash.include? key
hash[key] = value
end
hash
end
# Runs through the argument array getting all strings until no string is
# found or a switch is found.
#
# ["a", "b", "c"]
#
# And returns it as an array:
#
# ["a", "b", "c"]
#
def parse_array(name)
return shift if peek.is_a?(Array)
array = []
while current_is_value?
value = shift
if !value.empty?
validate_enum_value!(name, value, "Expected all values of '%s' to be one of %s; got %s")
end
array << value
end
array
end
# Check if the peek is numeric format and return a Float or Integer.
# Check if the peek is included in enum if enum is provided.
# Otherwise raises an error.
#
def parse_numeric(name)
return shift if peek.is_a?(Numeric)
unless peek =~ NUMERIC && $& == peek
raise MalformattedArgumentError, "Expected numeric value for '#{name}'; got #{peek.inspect}"
end
value = $&.index(".") ? shift.to_f : shift.to_i
validate_enum_value!(name, value, "Expected '%s' to be one of %s; got %s")
value
end
# Parse string:
# for --string-arg, just return the current value in the pile
# for --no-string-arg, nil
# Check if the peek is included in enum if enum is provided. Otherwise raises an error.
#
def parse_string(name)
if no_or_skip?(name)
nil
else
value = shift
validate_enum_value!(name, value, "Expected '%s' to be one of %s; got %s")
value
end
end
# Raises an error if the switch is an enum and the values aren't included on it.
#
def validate_enum_value!(name, value, message)
return unless @switches.is_a?(Hash)
switch = @switches[name]
return unless switch
if switch.enum && !switch.enum.include?(value)
raise MalformattedArgumentError, message % [name, switch.enum_to_s, value]
end
end
# Raises an error if @non_assigned_required array is not empty.
#
def check_requirement!
return if @non_assigned_required.empty?
names = @non_assigned_required.map do |o|
o.respond_to?(:switch_name) ? o.switch_name : o.human_name
end.join("', '")
class_name = self.class.name.split("::").last.downcase
raise RequiredArgumentMissingError, "No value provided for required #{class_name} '#{names}'"
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/parser/option.rb 0000644 00000011321 15173517745 0023255 0 ustar 00 class Bundler::Thor
class Option < Argument #:nodoc:
attr_reader :aliases, :group, :lazy_default, :hide, :repeatable
VALID_TYPES = [:boolean, :numeric, :hash, :array, :string]
def initialize(name, options = {})
@check_default_type = options[:check_default_type]
options[:required] = false unless options.key?(:required)
@repeatable = options.fetch(:repeatable, false)
super
@lazy_default = options[:lazy_default]
@group = options[:group].to_s.capitalize if options[:group]
@aliases = normalize_aliases(options[:aliases])
@hide = options[:hide]
end
# This parse quick options given as method_options. It makes several
# assumptions, but you can be more specific using the option method.
#
# parse :foo => "bar"
# #=> Option foo with default value bar
#
# parse [:foo, :baz] => "bar"
# #=> Option foo with default value bar and alias :baz
#
# parse :foo => :required
# #=> Required option foo without default value
#
# parse :foo => 2
# #=> Option foo with default value 2 and type numeric
#
# parse :foo => :numeric
# #=> Option foo without default value and type numeric
#
# parse :foo => true
# #=> Option foo with default value true and type boolean
#
# The valid types are :boolean, :numeric, :hash, :array and :string. If none
# is given a default type is assumed. This default type accepts arguments as
# string (--foo=value) or booleans (just --foo).
#
# By default all options are optional, unless :required is given.
#
def self.parse(key, value)
if key.is_a?(Array)
name, *aliases = key
else
name = key
aliases = []
end
name = name.to_s
default = value
type = case value
when Symbol
default = nil
if VALID_TYPES.include?(value)
value
elsif required = (value == :required) # rubocop:disable Lint/AssignmentInCondition
:string
end
when TrueClass, FalseClass
:boolean
when Numeric
:numeric
when Hash, Array, String
value.class.name.downcase.to_sym
end
new(name.to_s, required: required, type: type, default: default, aliases: aliases)
end
def switch_name
@switch_name ||= dasherized? ? name : dasherize(name)
end
def human_name
@human_name ||= dasherized? ? undasherize(name) : name
end
def usage(padding = 0)
sample = if banner && !banner.to_s.empty?
"#{switch_name}=#{banner}".dup
else
switch_name
end
sample = "[#{sample}]".dup unless required?
if boolean?
sample << ", [#{dasherize('no-' + human_name)}]" unless (name == "force") || name.match(/\Ano[\-_]/)
end
aliases_for_usage.ljust(padding) + sample
end
def aliases_for_usage
if aliases.empty?
""
else
"#{aliases.join(', ')}, "
end
end
def show_default?
case default
when TrueClass, FalseClass
true
else
super
end
end
VALID_TYPES.each do |type|
class_eval <<-RUBY, __FILE__, __LINE__ + 1
def #{type}?
self.type == #{type.inspect}
end
RUBY
end
protected
def validate!
raise ArgumentError, "An option cannot be boolean and required." if boolean? && required?
validate_default_type!
end
def validate_default_type!
default_type = case @default
when nil
return
when TrueClass, FalseClass
required? ? :string : :boolean
when Numeric
:numeric
when Symbol
:string
when Hash, Array, String
@default.class.name.downcase.to_sym
end
expected_type = (@repeatable && @type != :hash) ? :array : @type
if default_type != expected_type
err = "Expected #{expected_type} default value for '#{switch_name}'; got #{@default.inspect} (#{default_type})"
if @check_default_type
raise ArgumentError, err
elsif @check_default_type == nil
Bundler::Thor.deprecation_warning "#{err}.\n" +
"This will be rejected in the future unless you explicitly pass the options `check_default_type: false`" +
" or call `allow_incompatible_default_type!` in your code"
end
end
end
def dasherized?
name.index("-") == 0
end
def undasherize(str)
str.sub(/^-{1,2}/, "")
end
def dasherize(str)
(str.length > 1 ? "--" : "-") + str.tr("_", "-")
end
private
def normalize_aliases(aliases)
Array(aliases).map { |short| short.to_s.sub(/^(?!\-)/, "-") }
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/parser/argument.rb 0000644 00000004170 15173517745 0023573 0 ustar 00 class Bundler::Thor
class Argument #:nodoc:
VALID_TYPES = [:numeric, :hash, :array, :string]
attr_reader :name, :description, :enum, :required, :type, :default, :banner
alias_method :human_name, :name
def initialize(name, options = {})
class_name = self.class.name.split("::").last
type = options[:type]
raise ArgumentError, "#{class_name} name can't be nil." if name.nil?
raise ArgumentError, "Type :#{type} is not valid for #{class_name.downcase}s." if type && !valid_type?(type)
@name = name.to_s
@description = options[:desc]
@required = options.key?(:required) ? options[:required] : true
@type = (type || :string).to_sym
@default = options[:default]
@banner = options[:banner] || default_banner
@enum = options[:enum]
validate! # Trigger specific validations
end
def print_default
if @type == :array and @default.is_a?(Array)
@default.map { |x|
p = x.gsub('"','\\"')
"\"#{p}\""
}.join(" ")
else
@default
end
end
def usage
required? ? banner : "[#{banner}]"
end
def required?
required
end
def show_default?
case default
when Array, String, Hash
!default.empty?
else
default
end
end
def enum_to_s
if enum.respond_to? :join
enum.join(", ")
else
"#{enum.first}..#{enum.last}"
end
end
protected
def validate!
raise ArgumentError, "An argument cannot be required and have default value." if required? && !default.nil?
raise ArgumentError, "An argument cannot have an enum other than an enumerable." if @enum && !@enum.is_a?(Enumerable)
end
def valid_type?(type)
self.class::VALID_TYPES.include?(type.to_sym)
end
def default_banner
case type
when :boolean
nil
when :string, :default
human_name.upcase
when :numeric
"N"
when :hash
"key:value"
when :array
"one two three"
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/parser/options.rb 0000644 00000021030 15173517745 0023436 0 ustar 00 class Bundler::Thor
class Options < Arguments #:nodoc:
LONG_RE = /^(--\w+(?:-\w+)*)$/
SHORT_RE = /^(-[a-z])$/i
EQ_RE = /^(--\w+(?:-\w+)*|-[a-z])=(.*)$/i
SHORT_SQ_RE = /^-([a-z]{2,})$/i # Allow either -x -v or -xv style for single char args
SHORT_NUM = /^(-[a-z])#{NUMERIC}$/i
OPTS_END = "--".freeze
# Receives a hash and makes it switches.
def self.to_switches(options)
options.map do |key, value|
case value
when true
"--#{key}"
when Array
"--#{key} #{value.map(&:inspect).join(' ')}"
when Hash
"--#{key} #{value.map { |k, v| "#{k}:#{v}" }.join(' ')}"
when nil, false
nil
else
"--#{key} #{value.inspect}"
end
end.compact.join(" ")
end
# Takes a hash of Bundler::Thor::Option and a hash with defaults.
#
# If +stop_on_unknown+ is true, #parse will stop as soon as it encounters
# an unknown option or a regular argument.
def initialize(hash_options = {}, defaults = {}, stop_on_unknown = false, disable_required_check = false, relations = {})
@stop_on_unknown = stop_on_unknown
@exclusives = (relations[:exclusive_option_names] || []).select{|array| !array.empty?}
@at_least_ones = (relations[:at_least_one_option_names] || []).select{|array| !array.empty?}
@disable_required_check = disable_required_check
options = hash_options.values
super(options)
# Add defaults
defaults.each do |key, value|
@assigns[key.to_s] = value
@non_assigned_required.delete(hash_options[key])
end
@shorts = {}
@switches = {}
@extra = []
@stopped_parsing_after_extra_index = nil
@is_treated_as_value = false
options.each do |option|
@switches[option.switch_name] = option
option.aliases.each do |name|
@shorts[name] ||= option.switch_name
end
end
end
def remaining
@extra
end
def peek
return super unless @parsing_options
result = super
if result == OPTS_END
shift
@parsing_options = false
@stopped_parsing_after_extra_index ||= @extra.size
super
else
result
end
end
def shift
@is_treated_as_value = false
super
end
def unshift(arg, is_value: false)
@is_treated_as_value = is_value
super(arg)
end
def parse(args) # rubocop:disable Metrics/MethodLength
@pile = args.dup
@is_treated_as_value = false
@parsing_options = true
while peek
if parsing_options?
match, is_switch = current_is_switch?
shifted = shift
if is_switch
case shifted
when SHORT_SQ_RE
unshift($1.split("").map { |f| "-#{f}" })
next
when EQ_RE
unshift($2, is_value: true)
switch = $1
when SHORT_NUM
unshift($2)
switch = $1
when LONG_RE, SHORT_RE
switch = $1
end
switch = normalize_switch(switch)
option = switch_option(switch)
result = parse_peek(switch, option)
assign_result!(option, result)
elsif @stop_on_unknown
@parsing_options = false
@extra << shifted
@stopped_parsing_after_extra_index ||= @extra.size
@extra << shift while peek
break
elsif match
@extra << shifted
@extra << shift while peek && peek !~ /^-/
else
@extra << shifted
end
else
@extra << shift
end
end
check_requirement! unless @disable_required_check
check_exclusive!
check_at_least_one!
assigns = Bundler::Thor::CoreExt::HashWithIndifferentAccess.new(@assigns)
assigns.freeze
assigns
end
def check_exclusive!
opts = @assigns.keys
# When option A and B are exclusive, if A and B are given at the same time,
# the diffrence of argument array size will decrease.
found = @exclusives.find{ |ex| (ex - opts).size < ex.size - 1 }
if found
names = names_to_switch_names(found & opts).map{|n| "'#{n}'"}
class_name = self.class.name.split("::").last.downcase
fail ExclusiveArgumentError, "Found exclusive #{class_name} #{names.join(", ")}"
end
end
def check_at_least_one!
opts = @assigns.keys
# When at least one is required of the options A and B,
# if the both options were not given, none? would be true.
found = @at_least_ones.find{ |one_reqs| one_reqs.none?{ |o| opts.include? o} }
if found
names = names_to_switch_names(found).map{|n| "'#{n}'"}
class_name = self.class.name.split("::").last.downcase
fail AtLeastOneRequiredArgumentError, "Not found at least one of required #{class_name} #{names.join(", ")}"
end
end
def check_unknown!
to_check = @stopped_parsing_after_extra_index ? @extra[0...@stopped_parsing_after_extra_index] : @extra
# an unknown option starts with - or -- and has no more --'s afterward.
unknown = to_check.select { |str| str =~ /^--?(?:(?!--).)*$/ }
raise UnknownArgumentError.new(@switches.keys, unknown) unless unknown.empty?
end
protected
# Option names changes to swith name or human name
def names_to_switch_names(names = [])
@switches.map do |_, o|
if names.include? o.name
o.respond_to?(:switch_name) ? o.switch_name : o.human_name
else
nil
end
end.compact
end
def assign_result!(option, result)
if option.repeatable && option.type == :hash
(@assigns[option.human_name] ||= {}).merge!(result)
elsif option.repeatable
(@assigns[option.human_name] ||= []) << result
else
@assigns[option.human_name] = result
end
end
# Check if the current value in peek is a registered switch.
#
# Two booleans are returned. The first is true if the current value
# starts with a hyphen; the second is true if it is a registered switch.
def current_is_switch?
return [false, false] if @is_treated_as_value
case peek
when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM
[true, switch?($1)]
when SHORT_SQ_RE
[true, $1.split("").any? { |f| switch?("-#{f}") }]
else
[false, false]
end
end
def current_is_switch_formatted?
return false if @is_treated_as_value
case peek
when LONG_RE, SHORT_RE, EQ_RE, SHORT_NUM, SHORT_SQ_RE
true
else
false
end
end
def current_is_value?
return true if @is_treated_as_value
peek && (!parsing_options? || super)
end
def switch?(arg)
!switch_option(normalize_switch(arg)).nil?
end
def switch_option(arg)
if match = no_or_skip?(arg) # rubocop:disable Lint/AssignmentInCondition
@switches[arg] || @switches["--#{match}"]
else
@switches[arg]
end
end
# Check if the given argument is actually a shortcut.
#
def normalize_switch(arg)
(@shorts[arg] || arg).tr("_", "-")
end
def parsing_options?
peek
@parsing_options
end
# Parse boolean values which can be given as --foo=true, --foo or --no-foo.
#
def parse_boolean(switch)
if current_is_value?
if ["true", "TRUE", "t", "T", true].include?(peek)
shift
true
elsif ["false", "FALSE", "f", "F", false].include?(peek)
shift
false
else
@switches.key?(switch) || !no_or_skip?(switch)
end
else
@switches.key?(switch) || !no_or_skip?(switch)
end
end
# Parse the value at the peek analyzing if it requires an input or not.
#
def parse_peek(switch, option)
if parsing_options? && (current_is_switch_formatted? || last?)
if option.boolean?
# No problem for boolean types
elsif no_or_skip?(switch)
return nil # User set value to nil
elsif option.string? && !option.required?
# Return the default if there is one, else the human name
return option.lazy_default || option.default || option.human_name
elsif option.lazy_default
return option.lazy_default
else
raise MalformattedArgumentError, "No value provided for option '#{switch}'"
end
end
@non_assigned_required.delete(option)
send(:"parse_#{option.type}", switch)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/group.rb 0000644 00000021512 15173517745 0021610 0 ustar 00 require_relative "base"
# Bundler::Thor has a special class called Bundler::Thor::Group. The main difference to Bundler::Thor class
# is that it invokes all commands at once. It also include some methods that allows
# invocations to be done at the class method, which are not available to Bundler::Thor
# commands.
class Bundler::Thor::Group
class << self
# The description for this Bundler::Thor::Group. If none is provided, but a source root
# exists, tries to find the USAGE one folder above it, otherwise searches
# in the superclass.
#
# ==== Parameters
# description<String>:: The description for this Bundler::Thor::Group.
#
def desc(description = nil)
if description
@desc = description
else
@desc ||= from_superclass(:desc, nil)
end
end
# Prints help information.
#
# ==== Options
# short:: When true, shows only usage.
#
def help(shell)
shell.say "Usage:"
shell.say " #{banner}\n"
shell.say
class_options_help(shell)
shell.say desc if desc
end
# Stores invocations for this class merging with superclass values.
#
def invocations #:nodoc:
@invocations ||= from_superclass(:invocations, {})
end
# Stores invocation blocks used on invoke_from_option.
#
def invocation_blocks #:nodoc:
@invocation_blocks ||= from_superclass(:invocation_blocks, {})
end
# Invoke the given namespace or class given. It adds an instance
# method that will invoke the klass and command. You can give a block to
# configure how it will be invoked.
#
# The namespace/class given will have its options showed on the help
# usage. Check invoke_from_option for more information.
#
def invoke(*names, &block)
options = names.last.is_a?(Hash) ? names.pop : {}
verbose = options.fetch(:verbose, true)
names.each do |name|
invocations[name] = false
invocation_blocks[name] = block if block_given?
class_eval <<-METHOD, __FILE__, __LINE__ + 1
def _invoke_#{name.to_s.gsub(/\W/, '_')}
klass, command = self.class.prepare_for_invocation(nil, #{name.inspect})
if klass
say_status :invoke, #{name.inspect}, #{verbose.inspect}
block = self.class.invocation_blocks[#{name.inspect}]
_invoke_for_class_method klass, command, &block
else
say_status :error, %(#{name.inspect} [not found]), :red
end
end
METHOD
end
end
# Invoke a thor class based on the value supplied by the user to the
# given option named "name". A class option must be created before this
# method is invoked for each name given.
#
# ==== Examples
#
# class GemGenerator < Bundler::Thor::Group
# class_option :test_framework, :type => :string
# invoke_from_option :test_framework
# end
#
# ==== Boolean options
#
# In some cases, you want to invoke a thor class if some option is true or
# false. This is automatically handled by invoke_from_option. Then the
# option name is used to invoke the generator.
#
# ==== Preparing for invocation
#
# In some cases you want to customize how a specified hook is going to be
# invoked. You can do that by overwriting the class method
# prepare_for_invocation. The class method must necessarily return a klass
# and an optional command.
#
# ==== Custom invocations
#
# You can also supply a block to customize how the option is going to be
# invoked. The block receives two parameters, an instance of the current
# class and the klass to be invoked.
#
def invoke_from_option(*names, &block)
options = names.last.is_a?(Hash) ? names.pop : {}
verbose = options.fetch(:verbose, :white)
names.each do |name|
unless class_options.key?(name)
raise ArgumentError, "You have to define the option #{name.inspect} " \
"before setting invoke_from_option."
end
invocations[name] = true
invocation_blocks[name] = block if block_given?
class_eval <<-METHOD, __FILE__, __LINE__ + 1
def _invoke_from_option_#{name.to_s.gsub(/\W/, '_')}
return unless options[#{name.inspect}]
value = options[#{name.inspect}]
value = #{name.inspect} if TrueClass === value
klass, command = self.class.prepare_for_invocation(#{name.inspect}, value)
if klass
say_status :invoke, value, #{verbose.inspect}
block = self.class.invocation_blocks[#{name.inspect}]
_invoke_for_class_method klass, command, &block
else
say_status :error, %(\#{value} [not found]), :red
end
end
METHOD
end
end
# Remove a previously added invocation.
#
# ==== Examples
#
# remove_invocation :test_framework
#
def remove_invocation(*names)
names.each do |name|
remove_command(name)
remove_class_option(name)
invocations.delete(name)
invocation_blocks.delete(name)
end
end
# Overwrite class options help to allow invoked generators options to be
# shown recursively when invoking a generator.
#
def class_options_help(shell, groups = {}) #:nodoc:
get_options_from_invocations(groups, class_options) do |klass|
klass.send(:get_options_from_invocations, groups, class_options)
end
super(shell, groups)
end
# Get invocations array and merge options from invocations. Those
# options are added to group_options hash. Options that already exists
# in base_options are not added twice.
#
def get_options_from_invocations(group_options, base_options) #:nodoc:
invocations.each do |name, from_option|
value = if from_option
option = class_options[name]
option.type == :boolean ? name : option.default
else
name
end
next unless value
klass, _ = prepare_for_invocation(name, value)
next unless klass && klass.respond_to?(:class_options)
value = value.to_s
human_name = value.respond_to?(:classify) ? value.classify : value
group_options[human_name] ||= []
group_options[human_name] += klass.class_options.values.select do |class_option|
base_options[class_option.name.to_sym].nil? && class_option.group.nil? &&
!group_options.values.flatten.any? { |i| i.name == class_option.name }
end
yield klass if block_given?
end
end
# Returns commands ready to be printed.
def printable_commands(*)
item = []
item << banner
item << (desc ? "# #{desc.gsub(/\s+/m, ' ')}" : "")
[item]
end
alias_method :printable_tasks, :printable_commands
def handle_argument_error(command, error, _args, arity) #:nodoc:
msg = "#{basename} #{command.name} takes #{arity} argument".dup
msg << "s" if arity > 1
msg << ", but it should not."
raise error, msg
end
protected
# The method responsible for dispatching given the args.
def dispatch(command, given_args, given_opts, config) #:nodoc:
if Bundler::Thor::HELP_MAPPINGS.include?(given_args.first)
help(config[:shell])
return
end
args, opts = Bundler::Thor::Options.split(given_args)
opts = given_opts || opts
instance = new(args, opts, config)
yield instance if block_given?
if command
instance.invoke_command(all_commands[command])
else
instance.invoke_all
end
end
# The banner for this class. You can customize it if you are invoking the
# thor class by another ways which is not the Bundler::Thor::Runner.
def banner
"#{basename} #{self_command.formatted_usage(self, false)}"
end
# Represents the whole class as a command.
def self_command #:nodoc:
Bundler::Thor::DynamicCommand.new(namespace, class_options)
end
alias_method :self_task, :self_command
def baseclass #:nodoc:
Bundler::Thor::Group
end
def create_command(meth) #:nodoc:
commands[meth.to_s] = Bundler::Thor::Command.new(meth, nil, nil, nil, nil)
true
end
alias_method :create_task, :create_command
end
include Bundler::Thor::Base
protected
# Shortcut to invoke with padding and block handling. Use internally by
# invoke and invoke_from_option class methods.
def _invoke_for_class_method(klass, command = nil, *args, &block) #:nodoc:
with_padding do
if block
case block.arity
when 3
yield(self, klass, command)
when 2
yield(self, klass)
when 1
instance_exec(klass, &block)
end
else
invoke klass, command, *args
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/actions/inject_into_file.rb 0000644 00000007430 15173517745 0025423 0 ustar 00 require_relative "empty_directory"
class Bundler::Thor
module Actions
# Injects the given content into a file. Different from gsub_file, this
# method is reversible.
#
# ==== Parameters
# destination<String>:: Relative path to the destination root
# data<String>:: Data to add to the file. Can be given as a block.
# config<Hash>:: give :verbose => false to not log the status and the flag
# for injection (:after or :before) or :force => true for
# insert two or more times the same content.
#
# ==== Examples
#
# insert_into_file "config/environment.rb", "config.gem :thor", :after => "Rails::Initializer.run do |config|\n"
#
# insert_into_file "config/environment.rb", :after => "Rails::Initializer.run do |config|\n" do
# gems = ask "Which gems would you like to add?"
# gems.split(" ").map{ |gem| " config.gem :#{gem}" }.join("\n")
# end
#
WARNINGS = {unchanged_no_flag: "File unchanged! Either the supplied flag value not found or the content has already been inserted!"}
def insert_into_file(destination, *args, &block)
data = block_given? ? block : args.shift
config = args.shift || {}
config[:after] = /\z/ unless config.key?(:before) || config.key?(:after)
action InjectIntoFile.new(self, destination, data, config)
end
alias_method :inject_into_file, :insert_into_file
class InjectIntoFile < EmptyDirectory #:nodoc:
attr_reader :replacement, :flag, :behavior
def initialize(base, destination, data, config)
super(base, destination, {verbose: true}.merge(config))
@behavior, @flag = if @config.key?(:after)
[:after, @config.delete(:after)]
else
[:before, @config.delete(:before)]
end
@replacement = data.is_a?(Proc) ? data.call : data
@flag = Regexp.escape(@flag) unless @flag.is_a?(Regexp)
end
def invoke!
content = if @behavior == :after
'\0' + replacement
else
replacement + '\0'
end
if exists?
if replace!(/#{flag}/, content, config[:force])
say_status(:invoke)
elsif replacement_present?
say_status(:unchanged, color: :blue)
else
say_status(:unchanged, warning: WARNINGS[:unchanged_no_flag], color: :red)
end
else
unless pretend?
raise Bundler::Thor::Error, "The file #{ destination } does not appear to exist"
end
end
end
def revoke!
say_status :revoke
regexp = if @behavior == :after
content = '\1\2'
/(#{flag})(.*)(#{Regexp.escape(replacement)})/m
else
content = '\2\3'
/(#{Regexp.escape(replacement)})(.*)(#{flag})/m
end
replace!(regexp, content, true)
end
protected
def say_status(behavior, warning: nil, color: nil)
status = if behavior == :invoke
if flag == /\A/
:prepend
elsif flag == /\z/
:append
else
:insert
end
elsif warning
warning
elsif behavior == :unchanged
:unchanged
else
:subtract
end
super(status, (color || config[:verbose]))
end
def content
@content ||= File.read(destination)
end
def replacement_present?
content.include?(replacement)
end
# Adds the content to the file.
#
def replace!(regexp, string, force)
if force || !replacement_present?
success = content.gsub!(regexp, string)
File.open(destination, "wb") { |file| file.write(content) } unless pretend?
success
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/actions/empty_directory.rb 0000644 00000010371 15173517745 0025337 0 ustar 00 class Bundler::Thor
module Actions
# Creates an empty directory.
#
# ==== Parameters
# destination<String>:: the relative path to the destination root.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Examples
#
# empty_directory "doc"
#
def empty_directory(destination, config = {})
action EmptyDirectory.new(self, destination, config)
end
# Class which holds create directory logic. This is the base class for
# other actions like create_file and directory.
#
# This implementation is based in Templater actions, created by Jonas Nicklas
# and Michael S. Klishin under MIT LICENSE.
#
class EmptyDirectory #:nodoc:
attr_reader :base, :destination, :given_destination, :relative_destination, :config
# Initializes given the source and destination.
#
# ==== Parameters
# base<Bundler::Thor::Base>:: A Bundler::Thor::Base instance
# source<String>:: Relative path to the source of this file
# destination<String>:: Relative path to the destination of this file
# config<Hash>:: give :verbose => false to not log the status.
#
def initialize(base, destination, config = {})
@base = base
@config = {verbose: true}.merge(config)
self.destination = destination
end
# Checks if the destination file already exists.
#
# ==== Returns
# Boolean:: true if the file exists, false otherwise.
#
def exists?
::File.exist?(destination)
end
def invoke!
invoke_with_conflict_check do
require "fileutils"
::FileUtils.mkdir_p(destination)
end
end
def revoke!
say_status :remove, :red
require "fileutils"
::FileUtils.rm_rf(destination) if !pretend? && exists?
given_destination
end
protected
# Shortcut for pretend.
#
def pretend?
base.options[:pretend]
end
# Sets the absolute destination value from a relative destination value.
# It also stores the given and relative destination. Let's suppose our
# script is being executed on "dest", it sets the destination root to
# "dest". The destination, given_destination and relative_destination
# are related in the following way:
#
# inside "bar" do
# empty_directory "baz"
# end
#
# destination #=> dest/bar/baz
# relative_destination #=> bar/baz
# given_destination #=> baz
#
def destination=(destination)
return unless destination
@given_destination = convert_encoded_instructions(destination.to_s)
@destination = ::File.expand_path(@given_destination, base.destination_root)
@relative_destination = base.relative_to_original_destination_root(@destination)
end
# Filenames in the encoded form are converted. If you have a file:
#
# %file_name%.rb
#
# It calls #file_name from the base and replaces %-string with the
# return value (should be String) of #file_name:
#
# user.rb
#
# The method referenced can be either public or private.
#
def convert_encoded_instructions(filename)
filename.gsub(/%(.*?)%/) do |initial_string|
method = $1.strip
base.respond_to?(method, true) ? base.send(method) : initial_string
end
end
# Receives a hash of options and just execute the block if some
# conditions are met.
#
def invoke_with_conflict_check(&block)
if exists?
on_conflict_behavior(&block)
else
yield unless pretend?
say_status :create, :green
end
destination
rescue Errno::EISDIR, Errno::EEXIST
on_file_clash_behavior
end
def on_file_clash_behavior
say_status :file_clash, :red
end
# What to do when the destination file already exists.
#
def on_conflict_behavior
say_status :exist, :blue
end
# Shortcut to say_status shell method.
#
def say_status(status, color)
base.shell.say_status status, relative_destination, color if config[:verbose]
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/actions/create_link.rb 0000644 00000003555 15173517745 0024403 0 ustar 00 require_relative "create_file"
class Bundler::Thor
module Actions
# Create a new file relative to the destination root from the given source.
#
# ==== Parameters
# destination<String>:: the relative path to the destination root.
# source<String|NilClass>:: the relative path to the source root.
# config<Hash>:: give :verbose => false to not log the status.
# :: give :symbolic => false for hard link.
#
# ==== Examples
#
# create_link "config/apache.conf", "/etc/apache.conf"
#
def create_link(destination, *args)
config = args.last.is_a?(Hash) ? args.pop : {}
source = args.first
action CreateLink.new(self, destination, source, config)
end
alias_method :add_link, :create_link
# CreateLink is a subset of CreateFile, which instead of taking a block of
# data, just takes a source string from the user.
#
class CreateLink < CreateFile #:nodoc:
attr_reader :data
# Checks if the content of the file at the destination is identical to the rendered result.
#
# ==== Returns
# Boolean:: true if it is identical, false otherwise.
#
def identical?
source = File.expand_path(render, File.dirname(destination))
exists? && File.identical?(source, destination)
end
def invoke!
invoke_with_conflict_check do
require "fileutils"
FileUtils.mkdir_p(File.dirname(destination))
# Create a symlink by default
config[:symbolic] = true if config[:symbolic].nil?
File.unlink(destination) if exists?
if config[:symbolic]
File.symlink(render, destination)
else
File.link(render, destination)
end
end
given_destination
end
def exists?
super || File.symlink?(destination)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/actions/directory.rb 0000644 00000007406 15173517745 0024126 0 ustar 00 require_relative "empty_directory"
class Bundler::Thor
module Actions
# Copies recursively the files from source directory to root directory.
# If any of the files finishes with .tt, it's considered to be a template
# and is placed in the destination without the extension .tt. If any
# empty directory is found, it's copied and all .empty_directory files are
# ignored. If any file name is wrapped within % signs, the text within
# the % signs will be executed as a method and replaced with the returned
# value. Let's suppose a doc directory with the following files:
#
# doc/
# components/.empty_directory
# README
# rdoc.rb.tt
# %app_name%.rb
#
# When invoked as:
#
# directory "doc"
#
# It will create a doc directory in the destination with the following
# files (assuming that the `app_name` method returns the value "blog"):
#
# doc/
# components/
# README
# rdoc.rb
# blog.rb
#
# <b>Encoded path note:</b> Since Bundler::Thor internals use Object#respond_to? to check if it can
# expand %something%, this `something` should be a public method in the class calling
# #directory. If a method is private, Bundler::Thor stack raises PrivateMethodEncodedError.
#
# ==== Parameters
# source<String>:: the relative path to the source root.
# destination<String>:: the relative path to the destination root.
# config<Hash>:: give :verbose => false to not log the status.
# If :recursive => false, does not look for paths recursively.
# If :mode => :preserve, preserve the file mode from the source.
# If :exclude_pattern => /regexp/, prevents copying files that match that regexp.
#
# ==== Examples
#
# directory "doc"
# directory "doc", "docs", :recursive => false
#
def directory(source, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
destination = args.first || source
action Directory.new(self, source, destination || source, config, &block)
end
class Directory < EmptyDirectory #:nodoc:
attr_reader :source
def initialize(base, source, destination = nil, config = {}, &block)
@source = File.expand_path(Dir[Util.escape_globs(base.find_in_source_paths(source.to_s))].first)
@block = block
super(base, destination, {recursive: true}.merge(config))
end
def invoke!
base.empty_directory given_destination, config
execute!
end
def revoke!
execute!
end
protected
def execute!
lookup = Util.escape_globs(source)
lookup = config[:recursive] ? File.join(lookup, "**") : lookup
lookup = file_level_lookup(lookup)
files(lookup).sort.each do |file_source|
next if File.directory?(file_source)
next if config[:exclude_pattern] && file_source.match(config[:exclude_pattern])
file_destination = File.join(given_destination, file_source.gsub(source, "."))
file_destination.gsub!("/./", "/")
case file_source
when /\.empty_directory$/
dirname = File.dirname(file_destination).gsub(%r{/\.$}, "")
next if dirname == given_destination
base.empty_directory(dirname, config)
when /#{TEMPLATE_EXTNAME}$/
base.template(file_source, file_destination[0..-4], config, &@block)
else
base.copy_file(file_source, file_destination, config, &@block)
end
end
end
def file_level_lookup(previous_lookup)
File.join(previous_lookup, "*")
end
def files(lookup)
Dir.glob(lookup, File::FNM_DOTMATCH)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/actions/file_manipulation.rb 0000644 00000031653 15173517745 0025622 0 ustar 00 require "erb"
class Bundler::Thor
module Actions
# Copies the file from the relative source to the relative destination. If
# the destination is not given it's assumed to be equal to the source.
#
# ==== Parameters
# source<String>:: the relative path to the source root.
# destination<String>:: the relative path to the destination root.
# config<Hash>:: give :verbose => false to not log the status, and
# :mode => :preserve, to preserve the file mode from the source.
#
# ==== Examples
#
# copy_file "README", "doc/README"
#
# copy_file "doc/README"
#
def copy_file(source, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
destination = args.first || source
source = File.expand_path(find_in_source_paths(source.to_s))
resulting_destination = create_file destination, nil, config do
content = File.binread(source)
content = yield(content) if block
content
end
if config[:mode] == :preserve
mode = File.stat(source).mode
chmod(resulting_destination, mode, config)
end
end
# Links the file from the relative source to the relative destination. If
# the destination is not given it's assumed to be equal to the source.
#
# ==== Parameters
# source<String>:: the relative path to the source root.
# destination<String>:: the relative path to the destination root.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Examples
#
# link_file "README", "doc/README"
#
# link_file "doc/README"
#
def link_file(source, *args)
config = args.last.is_a?(Hash) ? args.pop : {}
destination = args.first || source
source = File.expand_path(find_in_source_paths(source.to_s))
create_link destination, source, config
end
# Gets the content at the given address and places it at the given relative
# destination. If a block is given instead of destination, the content of
# the url is yielded and used as location.
#
# +get+ relies on open-uri, so passing application user input would provide
# a command injection attack vector.
#
# ==== Parameters
# source<String>:: the address of the given content.
# destination<String>:: the relative path to the destination root.
# config<Hash>:: give :verbose => false to not log the status, and
# :http_headers => <Hash> to add headers to an http request.
#
# ==== Examples
#
# get "http://gist.github.com/103208", "doc/README"
#
# get "http://gist.github.com/103208", "doc/README", :http_headers => {"Content-Type" => "application/json"}
#
# get "http://gist.github.com/103208" do |content|
# content.split("\n").first
# end
#
def get(source, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
destination = args.first
render = if source =~ %r{^https?\://}
require "open-uri"
URI.send(:open, source, config.fetch(:http_headers, {})) { |input| input.binmode.read }
else
source = File.expand_path(find_in_source_paths(source.to_s))
File.open(source) { |input| input.binmode.read }
end
destination ||= if block_given?
block.arity == 1 ? yield(render) : yield
else
File.basename(source)
end
create_file destination, render, config
end
# Gets an ERB template at the relative source, executes it and makes a copy
# at the relative destination. If the destination is not given it's assumed
# to be equal to the source removing .tt from the filename.
#
# ==== Parameters
# source<String>:: the relative path to the source root.
# destination<String>:: the relative path to the destination root.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Examples
#
# template "README", "doc/README"
#
# template "doc/README"
#
def template(source, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
destination = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/, "")
source = File.expand_path(find_in_source_paths(source.to_s))
context = config.delete(:context) || instance_eval("binding")
create_file destination, nil, config do
capturable_erb = CapturableERB.new(::File.binread(source), trim_mode: "-", eoutvar: "@output_buffer")
content = capturable_erb.tap do |erb|
erb.filename = source
end.result(context)
content = yield(content) if block
content
end
end
# Changes the mode of the given file or directory.
#
# ==== Parameters
# mode<Integer>:: the file mode
# path<String>:: the name of the file to change mode
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Example
#
# chmod "script/server", 0755
#
def chmod(path, mode, config = {})
return unless behavior == :invoke
path = File.expand_path(path, destination_root)
say_status :chmod, relative_to_original_destination_root(path), config.fetch(:verbose, true)
unless options[:pretend]
require "fileutils"
FileUtils.chmod_R(mode, path)
end
end
# Prepend text to a file. Since it depends on insert_into_file, it's reversible.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# data<String>:: the data to prepend to the file, can be also given as a block.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Example
#
# prepend_to_file 'config/environments/test.rb', 'config.gem "rspec"'
#
# prepend_to_file 'config/environments/test.rb' do
# 'config.gem "rspec"'
# end
#
def prepend_to_file(path, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
config[:after] = /\A/
insert_into_file(path, *(args << config), &block)
end
alias_method :prepend_file, :prepend_to_file
# Append text to a file. Since it depends on insert_into_file, it's reversible.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# data<String>:: the data to append to the file, can be also given as a block.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Example
#
# append_to_file 'config/environments/test.rb', 'config.gem "rspec"'
#
# append_to_file 'config/environments/test.rb' do
# 'config.gem "rspec"'
# end
#
def append_to_file(path, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
config[:before] = /\z/
insert_into_file(path, *(args << config), &block)
end
alias_method :append_file, :append_to_file
# Injects text right after the class definition. Since it depends on
# insert_into_file, it's reversible.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# klass<String|Class>:: the class to be manipulated
# data<String>:: the data to append to the class, can be also given as a block.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Examples
#
# inject_into_class "app/controllers/application_controller.rb", "ApplicationController", " filter_parameter :password\n"
#
# inject_into_class "app/controllers/application_controller.rb", "ApplicationController" do
# " filter_parameter :password\n"
# end
#
def inject_into_class(path, klass, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
config[:after] = /class #{klass}\n|class #{klass} .*\n/
insert_into_file(path, *(args << config), &block)
end
# Injects text right after the module definition. Since it depends on
# insert_into_file, it's reversible.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# module_name<String|Class>:: the module to be manipulated
# data<String>:: the data to append to the class, can be also given as a block.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Examples
#
# inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper", " def help; 'help'; end\n"
#
# inject_into_module "app/helpers/application_helper.rb", "ApplicationHelper" do
# " def help; 'help'; end\n"
# end
#
def inject_into_module(path, module_name, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
config[:after] = /module #{module_name}\n|module #{module_name} .*\n/
insert_into_file(path, *(args << config), &block)
end
# Run a regular expression replacement on a file.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# flag<Regexp|String>:: the regexp or string to be replaced
# replacement<String>:: the replacement, can be also given as a block
# config<Hash>:: give :verbose => false to not log the status, and
# :force => true, to force the replacement regardless of runner behavior.
#
# ==== Example
#
# gsub_file 'app/controllers/application_controller.rb', /#\s*(filter_parameter_logging :password)/, '\1'
#
# gsub_file 'README', /rake/, :green do |match|
# match << " no more. Use thor!"
# end
#
def gsub_file(path, flag, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
return unless behavior == :invoke || config.fetch(:force, false)
path = File.expand_path(path, destination_root)
say_status :gsub, relative_to_original_destination_root(path), config.fetch(:verbose, true)
unless options[:pretend]
content = File.binread(path)
content.gsub!(flag, *args, &block)
File.open(path, "wb") { |file| file.write(content) }
end
end
# Uncomment all lines matching a given regex. It will leave the space
# which existed before the comment hash in tact but will remove any spacing
# between the comment hash and the beginning of the line.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# flag<Regexp|String>:: the regexp or string used to decide which lines to uncomment
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Example
#
# uncomment_lines 'config/initializers/session_store.rb', /active_record/
#
def uncomment_lines(path, flag, *args)
flag = flag.respond_to?(:source) ? flag.source : flag
gsub_file(path, /^(\s*)#[[:blank:]]*(.*#{flag})/, '\1\2', *args)
end
# Comment all lines matching a given regex. It will leave the space
# which existed before the beginning of the line in tact and will insert
# a single space after the comment hash.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# flag<Regexp|String>:: the regexp or string used to decide which lines to comment
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Example
#
# comment_lines 'config/initializers/session_store.rb', /cookie_store/
#
def comment_lines(path, flag, *args)
flag = flag.respond_to?(:source) ? flag.source : flag
gsub_file(path, /^(\s*)([^#\n]*#{flag})/, '\1# \2', *args)
end
# Removes a file at the given location.
#
# ==== Parameters
# path<String>:: path of the file to be changed
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Example
#
# remove_file 'README'
# remove_file 'app/controllers/application_controller.rb'
#
def remove_file(path, config = {})
return unless behavior == :invoke
path = File.expand_path(path, destination_root)
say_status :remove, relative_to_original_destination_root(path), config.fetch(:verbose, true)
if !options[:pretend] && (File.exist?(path) || File.symlink?(path))
require "fileutils"
::FileUtils.rm_rf(path)
end
end
alias_method :remove_dir, :remove_file
attr_accessor :output_buffer
private :output_buffer, :output_buffer=
private
def concat(string)
@output_buffer.concat(string)
end
def capture(*args)
with_output_buffer { yield(*args) }
end
def with_output_buffer(buf = "".dup) #:nodoc:
raise ArgumentError, "Buffer can not be a frozen object" if buf.frozen?
old_buffer = output_buffer
self.output_buffer = buf
yield
output_buffer
ensure
self.output_buffer = old_buffer
end
# Bundler::Thor::Actions#capture depends on what kind of buffer is used in ERB.
# Thus CapturableERB fixes ERB to use String buffer.
class CapturableERB < ERB
def set_eoutvar(compiler, eoutvar = "_erbout")
compiler.put_cmd = "#{eoutvar}.concat"
compiler.insert_cmd = "#{eoutvar}.concat"
compiler.pre_cmd = ["#{eoutvar} = ''.dup"]
compiler.post_cmd = [eoutvar]
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/actions/create_file.rb 0000644 00000006276 15173517745 0024370 0 ustar 00 require_relative "empty_directory"
class Bundler::Thor
module Actions
# Create a new file relative to the destination root with the given data,
# which is the return value of a block or a data string.
#
# ==== Parameters
# destination<String>:: the relative path to the destination root.
# data<String|NilClass>:: the data to append to the file.
# config<Hash>:: give :verbose => false to not log the status.
#
# ==== Examples
#
# create_file "lib/fun_party.rb" do
# hostname = ask("What is the virtual hostname I should use?")
# "vhost.name = #{hostname}"
# end
#
# create_file "config/apache.conf", "your apache config"
#
def create_file(destination, *args, &block)
config = args.last.is_a?(Hash) ? args.pop : {}
data = args.first
action CreateFile.new(self, destination, block || data.to_s, config)
end
alias_method :add_file, :create_file
# CreateFile is a subset of Template, which instead of rendering a file with
# ERB, it gets the content from the user.
#
class CreateFile < EmptyDirectory #:nodoc:
attr_reader :data
def initialize(base, destination, data, config = {})
@data = data
super(base, destination, config)
end
# Checks if the content of the file at the destination is identical to the rendered result.
#
# ==== Returns
# Boolean:: true if it is identical, false otherwise.
#
def identical?
# binread uses ASCII-8BIT, so to avoid false negatives, the string must use the same
exists? && File.binread(destination) == String.new(render).force_encoding("ASCII-8BIT")
end
# Holds the content to be added to the file.
#
def render
@render ||= if data.is_a?(Proc)
data.call
else
data
end
end
def invoke!
invoke_with_conflict_check do
require "fileutils"
FileUtils.mkdir_p(File.dirname(destination))
File.open(destination, "wb", config[:perm]) { |f| f.write render }
end
given_destination
end
protected
# Now on conflict we check if the file is identical or not.
#
def on_conflict_behavior(&block)
if identical?
say_status :identical, :blue
else
options = base.options.merge(config)
force_or_skip_or_conflict(options[:force], options[:skip], &block)
end
end
# If force is true, run the action, otherwise check if it's not being
# skipped. If both are false, show the file_collision menu, if the menu
# returns true, force it, otherwise skip.
#
def force_or_skip_or_conflict(force, skip, &block)
if force
say_status :force, :yellow
yield unless pretend?
elsif skip
say_status :skip, :yellow
else
say_status :conflict, :red
force_or_skip_or_conflict(force_on_collision?, true, &block)
end
end
# Shows the file collision menu to the user and gets the result.
#
def force_on_collision?
base.shell.file_collision(destination) { render }
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/error.rb 0000644 00000005332 15173517745 0021607 0 ustar 00 class Bundler::Thor
Correctable = if defined?(DidYouMean::SpellChecker) && defined?(DidYouMean::Correctable) # rubocop:disable Naming/ConstantName
Module.new do
def to_s
super + DidYouMean.formatter.message_for(corrections)
end
def corrections
@corrections ||= self.class.const_get(:SpellChecker).new(self).corrections
end
end
end
# Bundler::Thor::Error is raised when it's caused by wrong usage of thor classes. Those
# errors have their backtrace suppressed and are nicely shown to the user.
#
# Errors that are caused by the developer, like declaring a method which
# overwrites a thor keyword, SHOULD NOT raise a Bundler::Thor::Error. This way, we
# ensure that developer errors are shown with full backtrace.
class Error < StandardError
end
# Raised when a command was not found.
class UndefinedCommandError < Error
class SpellChecker
attr_reader :error
def initialize(error)
@error = error
end
def corrections
@corrections ||= spell_checker.correct(error.command).map(&:inspect)
end
def spell_checker
DidYouMean::SpellChecker.new(dictionary: error.all_commands)
end
end
attr_reader :command, :all_commands
def initialize(command, all_commands, namespace)
@command = command
@all_commands = all_commands
message = "Could not find command #{command.inspect}"
message = namespace ? "#{message} in #{namespace.inspect} namespace." : "#{message}."
super(message)
end
prepend Correctable if Correctable
end
UndefinedTaskError = UndefinedCommandError
class AmbiguousCommandError < Error
end
AmbiguousTaskError = AmbiguousCommandError
# Raised when a command was found, but not invoked properly.
class InvocationError < Error
end
class UnknownArgumentError < Error
class SpellChecker
attr_reader :error
def initialize(error)
@error = error
end
def corrections
@corrections ||=
error.unknown.flat_map { |unknown| spell_checker.correct(unknown) }.uniq.map(&:inspect)
end
def spell_checker
@spell_checker ||= DidYouMean::SpellChecker.new(dictionary: error.switches)
end
end
attr_reader :switches, :unknown
def initialize(switches, unknown)
@switches = switches
@unknown = unknown
super("Unknown switches #{unknown.map(&:inspect).join(', ')}")
end
prepend Correctable if Correctable
end
class RequiredArgumentMissingError < InvocationError
end
class MalformattedArgumentError < InvocationError
end
class ExclusiveArgumentError < InvocationError
end
class AtLeastOneRequiredArgumentError < InvocationError
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/line_editor/basic.rb 0000644 00000001175 15173517745 0024035 0 ustar 00 class Bundler::Thor
module LineEditor
class Basic
attr_reader :prompt, :options
def self.available?
true
end
def initialize(prompt, options)
@prompt = prompt
@options = options
end
def readline
$stdout.print(prompt)
get_input
end
private
def get_input
if echo?
$stdin.gets
else
# Lazy-load io/console since it is gem-ified as of 2.3
require "io/console"
$stdin.noecho(&:gets)
end
end
def echo?
options.fetch(:echo, true)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb 0000644 00000003467 15173517745 0024545 0 ustar 00 class Bundler::Thor
module LineEditor
class Readline < Basic
def self.available?
begin
require "readline"
rescue LoadError
end
Object.const_defined?(:Readline)
end
def readline
if echo?
::Readline.completion_append_character = nil
# rb-readline does not allow Readline.completion_proc= to receive nil.
if complete = completion_proc
::Readline.completion_proc = complete
end
::Readline.readline(prompt, add_to_history?)
else
super
end
end
private
def add_to_history?
options.fetch(:add_to_history, true)
end
def completion_proc
if use_path_completion?
proc { |text| PathCompletion.new(text).matches }
elsif completion_options.any?
proc do |text|
completion_options.select { |option| option.start_with?(text) }
end
end
end
def completion_options
options.fetch(:limited_to, [])
end
def use_path_completion?
options.fetch(:path, false)
end
class PathCompletion
attr_reader :text
private :text
def initialize(text)
@text = text
end
def matches
relative_matches
end
private
def relative_matches
absolute_matches.map { |path| path.sub(base_path, "") }
end
def absolute_matches
Dir[glob_pattern].map do |path|
if File.directory?(path)
"#{path}/"
else
path
end
end
end
def glob_pattern
"#{base_path}#{text}*"
end
def base_path
"#{Dir.pwd}/"
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/rake_compat.rb 0000644 00000004200 15173517745 0022734 0 ustar 00 require "rake"
require "rake/dsl_definition"
class Bundler::Thor
# Adds a compatibility layer to your Bundler::Thor classes which allows you to use
# rake package tasks. For example, to use rspec rake tasks, one can do:
#
# require 'bundler/vendor/thor/lib/thor/rake_compat'
# require 'rspec/core/rake_task'
#
# class Default < Bundler::Thor
# include Bundler::Thor::RakeCompat
#
# RSpec::Core::RakeTask.new(:spec) do |t|
# t.spec_opts = ['--options', './.rspec']
# t.spec_files = FileList['spec/**/*_spec.rb']
# end
# end
#
module RakeCompat
include Rake::DSL if defined?(Rake::DSL)
def self.rake_classes
@rake_classes ||= []
end
def self.included(base)
super(base)
# Hack. Make rakefile point to invoker, so rdoc task is generated properly.
rakefile = File.basename(caller[0].match(/(.*):\d+/)[1])
Rake.application.instance_variable_set(:@rakefile, rakefile)
rake_classes << base
end
end
end
# override task on (main), for compatibility with Rake 0.9
instance_eval do
alias rake_namespace namespace
def task(*)
task = super
if klass = Bundler::Thor::RakeCompat.rake_classes.last # rubocop:disable Lint/AssignmentInCondition
non_namespaced_name = task.name.split(":").last
description = non_namespaced_name
description << task.arg_names.map { |n| n.to_s.upcase }.join(" ")
description.strip!
klass.desc description, Rake.application.last_description || non_namespaced_name
Rake.application.last_description = nil
klass.send :define_method, non_namespaced_name do |*args|
Rake::Task[task.name.to_sym].invoke(*args)
end
end
task
end
def namespace(name)
if klass = Bundler::Thor::RakeCompat.rake_classes.last # rubocop:disable Lint/AssignmentInCondition
const_name = Bundler::Thor::Util.camel_case(name.to_s).to_sym
klass.const_set(const_name, Class.new(Bundler::Thor))
new_klass = klass.const_get(const_name)
Bundler::Thor::RakeCompat.rake_classes << new_klass
end
super
Bundler::Thor::RakeCompat.rake_classes.pop
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/runner.rb 0000644 00000024000 15173517745 0021760 0 ustar 00 require_relative "../thor"
require_relative "group"
require "yaml"
require "digest/sha2"
require "pathname"
class Bundler::Thor::Runner < Bundler::Thor #:nodoc:
map "-T" => :list, "-i" => :install, "-u" => :update, "-v" => :version
def self.banner(command, all = false, subcommand = false)
"thor " + command.formatted_usage(self, all, subcommand)
end
def self.exit_on_failure?
true
end
# Override Bundler::Thor#help so it can give information about any class and any method.
#
def help(meth = nil)
if meth && !respond_to?(meth)
initialize_thorfiles(meth)
klass, command = Bundler::Thor::Util.find_class_and_command_by_namespace(meth)
self.class.handle_no_command_error(command, false) if klass.nil?
klass.start(["-h", command].compact, shell: shell)
else
super
end
end
# If a command is not found on Bundler::Thor::Runner, method missing is invoked and
# Bundler::Thor::Runner is then responsible for finding the command in all classes.
#
def method_missing(meth, *args)
meth = meth.to_s
initialize_thorfiles(meth)
klass, command = Bundler::Thor::Util.find_class_and_command_by_namespace(meth)
self.class.handle_no_command_error(command, false) if klass.nil?
args.unshift(command) if command
klass.start(args, shell: shell)
end
desc "install NAME", "Install an optionally named Bundler::Thor file into your system commands"
method_options as: :string, relative: :boolean, force: :boolean
def install(name) # rubocop:disable Metrics/MethodLength
initialize_thorfiles
is_uri = name =~ %r{^https?\://}
if is_uri
base = name
package = :file
require "open-uri"
begin
contents = URI.open(name, &:read)
rescue OpenURI::HTTPError
raise Error, "Error opening URI '#{name}'"
end
else
# If a directory name is provided as the argument, look for a 'main.thor'
# command in said directory.
begin
if File.directory?(File.expand_path(name))
base = File.join(name, "main.thor")
package = :directory
contents = File.open(base, &:read)
else
base = name
package = :file
require "open-uri"
contents = URI.open(name, &:read)
end
rescue Errno::ENOENT
raise Error, "Error opening file '#{name}'"
end
end
say "Your Thorfile contains:"
say contents
unless options["force"]
return false if no?("Do you wish to continue [y/N]?")
end
as = options["as"] || begin
first_line = contents.split("\n")[0]
(match = first_line.match(/\s*#\s*module:\s*([^\n]*)/)) ? match[1].strip : nil
end
unless as
basename = File.basename(name)
as = ask("Please specify a name for #{name} in the system repository [#{basename}]:")
as = basename if as.empty?
end
location = if options[:relative] || is_uri
name
else
File.expand_path(name)
end
thor_yaml[as] = {
filename: Digest::SHA256.hexdigest(name + as),
location: location,
namespaces: Bundler::Thor::Util.namespaces_in_content(contents, base)
}
save_yaml(thor_yaml)
say "Storing thor file in your system repository"
destination = File.join(thor_root, thor_yaml[as][:filename])
if package == :file
File.open(destination, "w") { |f| f.puts contents }
else
require "fileutils"
FileUtils.cp_r(name, destination)
end
thor_yaml[as][:filename] # Indicate success
end
desc "version", "Show Bundler::Thor version"
def version
require_relative "version"
say "Bundler::Thor #{Bundler::Thor::VERSION}"
end
desc "uninstall NAME", "Uninstall a named Bundler::Thor module"
def uninstall(name)
raise Error, "Can't find module '#{name}'" unless thor_yaml[name]
say "Uninstalling #{name}."
require "fileutils"
FileUtils.rm_rf(File.join(thor_root, (thor_yaml[name][:filename]).to_s))
thor_yaml.delete(name)
save_yaml(thor_yaml)
puts "Done."
end
desc "update NAME", "Update a Bundler::Thor file from its original location"
def update(name)
raise Error, "Can't find module '#{name}'" if !thor_yaml[name] || !thor_yaml[name][:location]
say "Updating '#{name}' from #{thor_yaml[name][:location]}"
old_filename = thor_yaml[name][:filename]
self.options = options.merge("as" => name)
if File.directory? File.expand_path(name)
require "fileutils"
FileUtils.rm_rf(File.join(thor_root, old_filename))
thor_yaml.delete(old_filename)
save_yaml(thor_yaml)
filename = install(name)
else
filename = install(thor_yaml[name][:location])
end
File.delete(File.join(thor_root, old_filename)) unless filename == old_filename
end
desc "installed", "List the installed Bundler::Thor modules and commands"
method_options internal: :boolean
def installed
initialize_thorfiles(nil, true)
display_klasses(true, options["internal"])
end
desc "list [SEARCH]", "List the available thor commands (--substring means .*SEARCH)"
method_options substring: :boolean, group: :string, all: :boolean, debug: :boolean
def list(search = "")
initialize_thorfiles
search = ".*#{search}" if options["substring"]
search = /^#{search}.*/i
group = options[:group] || "standard"
klasses = Bundler::Thor::Base.subclasses.select do |k|
(options[:all] || k.group == group) && k.namespace =~ search
end
display_klasses(false, false, klasses)
end
private
def thor_root
Bundler::Thor::Util.thor_root
end
def thor_yaml
@thor_yaml ||= begin
yaml_file = File.join(thor_root, "thor.yml")
yaml = YAML.load_file(yaml_file) if File.exist?(yaml_file)
yaml || {}
end
end
# Save the yaml file. If none exists in thor root, creates one.
#
def save_yaml(yaml)
yaml_file = File.join(thor_root, "thor.yml")
unless File.exist?(yaml_file)
require "fileutils"
FileUtils.mkdir_p(thor_root)
yaml_file = File.join(thor_root, "thor.yml")
FileUtils.touch(yaml_file)
end
File.open(yaml_file, "w") { |f| f.puts yaml.to_yaml }
end
# Load the Thorfiles. If relevant_to is supplied, looks for specific files
# in the thor_root instead of loading them all.
#
# By default, it also traverses the current path until find Bundler::Thor files, as
# described in thorfiles. This look up can be skipped by supplying
# skip_lookup true.
#
def initialize_thorfiles(relevant_to = nil, skip_lookup = false)
thorfiles(relevant_to, skip_lookup).each do |f|
Bundler::Thor::Util.load_thorfile(f, nil, options[:debug]) unless Bundler::Thor::Base.subclass_files.keys.include?(File.expand_path(f))
end
end
# Finds Thorfiles by traversing from your current directory down to the root
# directory of your system. If at any time we find a Bundler::Thor file, we stop.
#
# We also ensure that system-wide Thorfiles are loaded first, so local
# Thorfiles can override them.
#
# ==== Example
#
# If we start at /Users/wycats/dev/thor ...
#
# 1. /Users/wycats/dev/thor
# 2. /Users/wycats/dev
# 3. /Users/wycats <-- we find a Thorfile here, so we stop
#
# Suppose we start at c:\Documents and Settings\james\dev\thor ...
#
# 1. c:\Documents and Settings\james\dev\thor
# 2. c:\Documents and Settings\james\dev
# 3. c:\Documents and Settings\james
# 4. c:\Documents and Settings
# 5. c:\ <-- no Thorfiles found!
#
def thorfiles(relevant_to = nil, skip_lookup = false)
thorfiles = []
unless skip_lookup
Pathname.pwd.ascend do |path|
thorfiles = Bundler::Thor::Util.globs_for(path).map { |g| Dir[g] }.flatten
break unless thorfiles.empty?
end
end
files = (relevant_to ? thorfiles_relevant_to(relevant_to) : Bundler::Thor::Util.thor_root_glob)
files += thorfiles
files -= ["#{thor_root}/thor.yml"]
files.map! do |file|
File.directory?(file) ? File.join(file, "main.thor") : file
end
end
# Load Thorfiles relevant to the given method. If you provide "foo:bar" it
# will load all thor files in the thor.yaml that has "foo" e "foo:bar"
# namespaces registered.
#
def thorfiles_relevant_to(meth)
lookup = [meth, meth.split(":")[0...-1].join(":")]
files = thor_yaml.select do |_, v|
v[:namespaces] && !(v[:namespaces] & lookup).empty?
end
files.map { |_, v| File.join(thor_root, (v[:filename]).to_s) }
end
# Display information about the given klasses. If with_module is given,
# it shows a table with information extracted from the yaml file.
#
def display_klasses(with_modules = false, show_internal = false, klasses = Bundler::Thor::Base.subclasses)
klasses -= [Bundler::Thor, Bundler::Thor::Runner, Bundler::Thor::Group] unless show_internal
raise Error, "No Bundler::Thor commands available" if klasses.empty?
show_modules if with_modules && !thor_yaml.empty?
list = Hash.new { |h, k| h[k] = [] }
groups = klasses.select { |k| k.ancestors.include?(Bundler::Thor::Group) }
# Get classes which inherit from Bundler::Thor
(klasses - groups).each { |k| list[k.namespace.split(":").first] += k.printable_commands(false) }
# Get classes which inherit from Bundler::Thor::Base
groups.map! { |k| k.printable_commands(false).first }
list["root"] = groups
# Order namespaces with default coming first
list = list.sort { |a, b| a[0].sub(/^default/, "") <=> b[0].sub(/^default/, "") }
list.each { |n, commands| display_commands(n, commands) unless commands.empty? }
end
def display_commands(namespace, list) #:nodoc:
list.sort! { |a, b| a[0] <=> b[0] }
say shell.set_color(namespace, :blue, true)
say "-" * namespace.size
print_table(list, truncate: true)
say
end
alias_method :display_tasks, :display_commands
def show_modules #:nodoc:
info = []
labels = %w(Modules Namespaces)
info << labels
info << ["-" * labels[0].size, "-" * labels[1].size]
thor_yaml.each do |name, hash|
info << [name, hash[:namespaces].join(", ")]
end
print_table info
say ""
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor/base.rb 0000644 00000070641 15173517745 0021375 0 ustar 00 require_relative "command"
require_relative "core_ext/hash_with_indifferent_access"
require_relative "error"
require_relative "invocation"
require_relative "nested_context"
require_relative "parser"
require_relative "shell"
require_relative "line_editor"
require_relative "util"
class Bundler::Thor
autoload :Actions, File.expand_path("actions", __dir__)
autoload :RakeCompat, File.expand_path("rake_compat", __dir__)
autoload :Group, File.expand_path("group", __dir__)
# Shortcuts for help.
HELP_MAPPINGS = %w(-h -? --help -D)
# Bundler::Thor methods that should not be overwritten by the user.
THOR_RESERVED_WORDS = %w(invoke shell options behavior root destination_root relative_root
action add_file create_file in_root inside run run_ruby_script)
TEMPLATE_EXTNAME = ".tt"
class << self
def deprecation_warning(message) #:nodoc:
unless ENV["THOR_SILENCE_DEPRECATION"]
warn "Deprecation warning: #{message}\n" +
"You can silence deprecations warning by setting the environment variable THOR_SILENCE_DEPRECATION."
end
end
end
module Base
attr_accessor :options, :parent_options, :args
# It receives arguments in an Array and two hashes, one for options and
# other for configuration.
#
# Notice that it does not check if all required arguments were supplied.
# It should be done by the parser.
#
# ==== Parameters
# args<Array[Object]>:: An array of objects. The objects are applied to their
# respective accessors declared with <tt>argument</tt>.
#
# options<Hash>:: An options hash that will be available as self.options.
# The hash given is converted to a hash with indifferent
# access, magic predicates (options.skip?) and then frozen.
#
# config<Hash>:: Configuration for this Bundler::Thor class.
#
def initialize(args = [], local_options = {}, config = {})
parse_options = self.class.class_options
# The start method splits inbound arguments at the first argument
# that looks like an option (starts with - or --). It then calls
# new, passing in the two halves of the arguments Array as the
# first two parameters.
command_options = config.delete(:command_options) # hook for start
parse_options = parse_options.merge(command_options) if command_options
if local_options.is_a?(Array)
array_options = local_options
hash_options = {}
else
# Handle the case where the class was explicitly instantiated
# with pre-parsed options.
array_options = []
hash_options = local_options
end
# Let Bundler::Thor::Options parse the options first, so it can remove
# declared options from the array. This will leave us with
# a list of arguments that weren't declared.
current_command = config[:current_command]
stop_on_unknown = self.class.stop_on_unknown_option? current_command
# Give a relation of options.
# After parsing, Bundler::Thor::Options check whether right relations are kept
relations = if current_command.nil?
{exclusive_option_names: [], at_least_one_option_names: []}
else
current_command.options_relation
end
self.class.class_exclusive_option_names.map { |n| relations[:exclusive_option_names] << n }
self.class.class_at_least_one_option_names.map { |n| relations[:at_least_one_option_names] << n }
disable_required_check = self.class.disable_required_check? current_command
opts = Bundler::Thor::Options.new(parse_options, hash_options, stop_on_unknown, disable_required_check, relations)
self.options = opts.parse(array_options)
self.options = config[:class_options].merge(options) if config[:class_options]
# If unknown options are disallowed, make sure that none of the
# remaining arguments looks like an option.
opts.check_unknown! if self.class.check_unknown_options?(config)
# Add the remaining arguments from the options parser to the
# arguments passed in to initialize. Then remove any positional
# arguments declared using #argument (this is primarily used
# by Bundler::Thor::Group). Tis will leave us with the remaining
# positional arguments.
to_parse = args
to_parse += opts.remaining unless self.class.strict_args_position?(config)
thor_args = Bundler::Thor::Arguments.new(self.class.arguments)
thor_args.parse(to_parse).each { |k, v| __send__("#{k}=", v) }
@args = thor_args.remaining
end
class << self
def included(base) #:nodoc:
super(base)
base.extend ClassMethods
base.send :include, Invocation
base.send :include, Shell
end
# Returns the classes that inherits from Bundler::Thor or Bundler::Thor::Group.
#
# ==== Returns
# Array[Class]
#
def subclasses
@subclasses ||= []
end
# Returns the files where the subclasses are kept.
#
# ==== Returns
# Hash[path<String> => Class]
#
def subclass_files
@subclass_files ||= Hash.new { |h, k| h[k] = [] }
end
# Whenever a class inherits from Bundler::Thor or Bundler::Thor::Group, we should track the
# class and the file on Bundler::Thor::Base. This is the method responsible for it.
#
def register_klass_file(klass) #:nodoc:
file = caller[1].match(/(.*):\d+/)[1]
Bundler::Thor::Base.subclasses << klass unless Bundler::Thor::Base.subclasses.include?(klass)
file_subclasses = Bundler::Thor::Base.subclass_files[File.expand_path(file)]
file_subclasses << klass unless file_subclasses.include?(klass)
end
end
module ClassMethods
def attr_reader(*) #:nodoc:
no_commands { super }
end
def attr_writer(*) #:nodoc:
no_commands { super }
end
def attr_accessor(*) #:nodoc:
no_commands { super }
end
# If you want to raise an error for unknown options, call check_unknown_options!
# This is disabled by default to allow dynamic invocations.
def check_unknown_options!
@check_unknown_options = true
end
def check_unknown_options #:nodoc:
@check_unknown_options ||= from_superclass(:check_unknown_options, false)
end
def check_unknown_options?(config) #:nodoc:
!!check_unknown_options
end
# If you want to raise an error when the default value of an option does not match
# the type call check_default_type!
# This will be the default; for compatibility a deprecation warning is issued if necessary.
def check_default_type!
@check_default_type = true
end
# If you want to use defaults that don't match the type of an option,
# either specify `check_default_type: false` or call `allow_incompatible_default_type!`
def allow_incompatible_default_type!
@check_default_type = false
end
def check_default_type #:nodoc:
@check_default_type = from_superclass(:check_default_type, nil) unless defined?(@check_default_type)
@check_default_type
end
# If true, option parsing is suspended as soon as an unknown option or a
# regular argument is encountered. All remaining arguments are passed to
# the command as regular arguments.
def stop_on_unknown_option?(command_name) #:nodoc:
false
end
# If true, option set will not suspend the execution of the command when
# a required option is not provided.
def disable_required_check?(command_name) #:nodoc:
false
end
# If you want only strict string args (useful when cascading thor classes),
# call strict_args_position! This is disabled by default to allow dynamic
# invocations.
def strict_args_position!
@strict_args_position = true
end
def strict_args_position #:nodoc:
@strict_args_position ||= from_superclass(:strict_args_position, false)
end
def strict_args_position?(config) #:nodoc:
!!strict_args_position
end
# Adds an argument to the class and creates an attr_accessor for it.
#
# Arguments are different from options in several aspects. The first one
# is how they are parsed from the command line, arguments are retrieved
# from position:
#
# thor command NAME
#
# Instead of:
#
# thor command --name=NAME
#
# Besides, arguments are used inside your code as an accessor (self.argument),
# while options are all kept in a hash (self.options).
#
# Finally, arguments cannot have type :default or :boolean but can be
# optional (supplying :optional => :true or :required => false), although
# you cannot have a required argument after a non-required argument. If you
# try it, an error is raised.
#
# ==== Parameters
# name<Symbol>:: The name of the argument.
# options<Hash>:: Described below.
#
# ==== Options
# :desc - Description for the argument.
# :required - If the argument is required or not.
# :optional - If the argument is optional or not.
# :type - The type of the argument, can be :string, :hash, :array, :numeric.
# :default - Default value for this argument. It cannot be required and have default values.
# :banner - String to show on usage notes.
#
# ==== Errors
# ArgumentError:: Raised if you supply a required argument after a non required one.
#
def argument(name, options = {})
is_thor_reserved_word?(name, :argument)
no_commands { attr_accessor name }
required = if options.key?(:optional)
!options[:optional]
elsif options.key?(:required)
options[:required]
else
options[:default].nil?
end
remove_argument name
if required
arguments.each do |argument|
next if argument.required?
raise ArgumentError, "You cannot have #{name.to_s.inspect} as required argument after " \
"the non-required argument #{argument.human_name.inspect}."
end
end
options[:required] = required
arguments << Bundler::Thor::Argument.new(name, options)
end
# Returns this class arguments, looking up in the ancestors chain.
#
# ==== Returns
# Array[Bundler::Thor::Argument]
#
def arguments
@arguments ||= from_superclass(:arguments, [])
end
# Adds a bunch of options to the set of class options.
#
# class_options :foo => false, :bar => :required, :baz => :string
#
# If you prefer more detailed declaration, check class_option.
#
# ==== Parameters
# Hash[Symbol => Object]
#
def class_options(options = nil)
@class_options ||= from_superclass(:class_options, {})
build_options(options, @class_options) if options
@class_options
end
# Adds an option to the set of class options
#
# ==== Parameters
# name<Symbol>:: The name of the argument.
# options<Hash>:: Described below.
#
# ==== Options
# :desc:: -- Description for the argument.
# :required:: -- If the argument is required or not.
# :default:: -- Default value for this argument.
# :group:: -- The group for this options. Use by class options to output options in different levels.
# :aliases:: -- Aliases for this option. <b>Note:</b> Bundler::Thor follows a convention of one-dash-one-letter options. Thus aliases like "-something" wouldn't be parsed; use either "\--something" or "-s" instead.
# :type:: -- The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
# :banner:: -- String to show on usage notes.
# :hide:: -- If you want to hide this option from the help.
#
def class_option(name, options = {})
unless [ Symbol, String ].any? { |klass| name.is_a?(klass) }
raise ArgumentError, "Expected a Symbol or String, got #{name.inspect}"
end
build_option(name, options, class_options)
end
# Adds and declares option group for exclusive options in the
# block and arguments. You can declare options as the outside of the block.
#
# ==== Parameters
# Array[Bundler::Thor::Option.name]
#
# ==== Examples
#
# class_exclusive do
# class_option :one
# class_option :two
# end
#
# Or
#
# class_option :one
# class_option :two
# class_exclusive :one, :two
#
# If you give "--one" and "--two" at the same time ExclusiveArgumentsError
# will be raised.
#
def class_exclusive(*args, &block)
register_options_relation_for(:class_options,
:class_exclusive_option_names, *args, &block)
end
# Adds and declares option group for required at least one of options in the
# block and arguments. You can declare options as the outside of the block.
#
# ==== Examples
#
# class_at_least_one do
# class_option :one
# class_option :two
# end
#
# Or
#
# class_option :one
# class_option :two
# class_at_least_one :one, :two
#
# If you do not give "--one" and "--two" AtLeastOneRequiredArgumentError
# will be raised.
#
# You can use class_at_least_one and class_exclusive at the same time.
#
# class_exclusive do
# class_at_least_one do
# class_option :one
# class_option :two
# end
# end
#
# Then it is required either only one of "--one" or "--two".
#
def class_at_least_one(*args, &block)
register_options_relation_for(:class_options,
:class_at_least_one_option_names, *args, &block)
end
# Returns this class exclusive options array set, looking up in the ancestors chain.
#
# ==== Returns
# Array[Array[Bundler::Thor::Option.name]]
#
def class_exclusive_option_names
@class_exclusive_option_names ||= from_superclass(:class_exclusive_option_names, [])
end
# Returns this class at least one of required options array set, looking up in the ancestors chain.
#
# ==== Returns
# Array[Array[Bundler::Thor::Option.name]]
#
def class_at_least_one_option_names
@class_at_least_one_option_names ||= from_superclass(:class_at_least_one_option_names, [])
end
# Removes a previous defined argument. If :undefine is given, undefine
# accessors as well.
#
# ==== Parameters
# names<Array>:: Arguments to be removed
#
# ==== Examples
#
# remove_argument :foo
# remove_argument :foo, :bar, :baz, :undefine => true
#
def remove_argument(*names)
options = names.last.is_a?(Hash) ? names.pop : {}
names.each do |name|
arguments.delete_if { |a| a.name == name.to_s }
undef_method name, "#{name}=" if options[:undefine]
end
end
# Removes a previous defined class option.
#
# ==== Parameters
# names<Array>:: Class options to be removed
#
# ==== Examples
#
# remove_class_option :foo
# remove_class_option :foo, :bar, :baz
#
def remove_class_option(*names)
names.each do |name|
class_options.delete(name)
end
end
# Defines the group. This is used when thor list is invoked so you can specify
# that only commands from a pre-defined group will be shown. Defaults to standard.
#
# ==== Parameters
# name<String|Symbol>
#
def group(name = nil)
if name
@group = name.to_s
else
@group ||= from_superclass(:group, "standard")
end
end
# Returns the commands for this Bundler::Thor class.
#
# ==== Returns
# Hash:: An ordered hash with commands names as keys and Bundler::Thor::Command
# objects as values.
#
def commands
@commands ||= Hash.new
end
alias_method :tasks, :commands
# Returns the commands for this Bundler::Thor class and all subclasses.
#
# ==== Returns
# Hash:: An ordered hash with commands names as keys and Bundler::Thor::Command
# objects as values.
#
def all_commands
@all_commands ||= from_superclass(:all_commands, Hash.new)
@all_commands.merge!(commands)
end
alias_method :all_tasks, :all_commands
# Removes a given command from this Bundler::Thor class. This is usually done if you
# are inheriting from another class and don't want it to be available
# anymore.
#
# By default it only remove the mapping to the command. But you can supply
# :undefine => true to undefine the method from the class as well.
#
# ==== Parameters
# name<Symbol|String>:: The name of the command to be removed
# options<Hash>:: You can give :undefine => true if you want commands the method
# to be undefined from the class as well.
#
def remove_command(*names)
options = names.last.is_a?(Hash) ? names.pop : {}
names.each do |name|
commands.delete(name.to_s)
all_commands.delete(name.to_s)
undef_method name if options[:undefine]
end
end
alias_method :remove_task, :remove_command
# All methods defined inside the given block are not added as commands.
#
# So you can do:
#
# class MyScript < Bundler::Thor
# no_commands do
# def this_is_not_a_command
# end
# end
# end
#
# You can also add the method and remove it from the command list:
#
# class MyScript < Bundler::Thor
# def this_is_not_a_command
# end
# remove_command :this_is_not_a_command
# end
#
def no_commands(&block)
no_commands_context.enter(&block)
end
alias_method :no_tasks, :no_commands
def no_commands_context
@no_commands_context ||= NestedContext.new
end
def no_commands?
no_commands_context.entered?
end
# Sets the namespace for the Bundler::Thor or Bundler::Thor::Group class. By default the
# namespace is retrieved from the class name. If your Bundler::Thor class is named
# Scripts::MyScript, the help method, for example, will be called as:
#
# thor scripts:my_script -h
#
# If you change the namespace:
#
# namespace :my_scripts
#
# You change how your commands are invoked:
#
# thor my_scripts -h
#
# Finally, if you change your namespace to default:
#
# namespace :default
#
# Your commands can be invoked with a shortcut. Instead of:
#
# thor :my_command
#
def namespace(name = nil)
if name
@namespace = name.to_s
else
@namespace ||= Bundler::Thor::Util.namespace_from_thor_class(self)
end
end
# Parses the command and options from the given args, instantiate the class
# and invoke the command. This method is used when the arguments must be parsed
# from an array. If you are inside Ruby and want to use a Bundler::Thor class, you
# can simply initialize it:
#
# script = MyScript.new(args, options, config)
# script.invoke(:command, first_arg, second_arg, third_arg)
#
def start(given_args = ARGV, config = {})
config[:shell] ||= Bundler::Thor::Base.shell.new
dispatch(nil, given_args.dup, nil, config)
rescue Bundler::Thor::Error => e
config[:debug] || ENV["THOR_DEBUG"] == "1" ? (raise e) : config[:shell].error(e.message)
exit(false) if exit_on_failure?
rescue Errno::EPIPE
# This happens if a thor command is piped to something like `head`,
# which closes the pipe when it's done reading. This will also
# mean that if the pipe is closed, further unnecessary
# computation will not occur.
exit(true)
end
# Allows to use private methods from parent in child classes as commands.
#
# ==== Parameters
# names<Array>:: Method names to be used as commands
#
# ==== Examples
#
# public_command :foo
# public_command :foo, :bar, :baz
#
def public_command(*names)
names.each do |name|
class_eval "def #{name}(*); super end", __FILE__, __LINE__
end
end
alias_method :public_task, :public_command
def handle_no_command_error(command, has_namespace = $thor_runner) #:nodoc:
raise UndefinedCommandError.new(command, all_commands.keys, (namespace if has_namespace))
end
alias_method :handle_no_task_error, :handle_no_command_error
def handle_argument_error(command, error, args, arity) #:nodoc:
name = [command.ancestor_name, command.name].compact.join(" ")
msg = "ERROR: \"#{basename} #{name}\" was called with ".dup
msg << "no arguments" if args.empty?
msg << "arguments " << args.inspect unless args.empty?
msg << "\nUsage: \"#{banner(command).split("\n").join("\"\n \"")}\""
raise InvocationError, msg
end
# A flag that makes the process exit with status 1 if any error happens.
def exit_on_failure?
Bundler::Thor.deprecation_warning "Bundler::Thor exit with status 0 on errors. To keep this behavior, you must define `exit_on_failure?` in `#{self.name}`"
false
end
protected
# Prints the class options per group. If an option does not belong to
# any group, it's printed as Class option.
#
def class_options_help(shell, groups = {}) #:nodoc:
# Group options by group
class_options.each do |_, value|
groups[value.group] ||= []
groups[value.group] << value
end
# Deal with default group
global_options = groups.delete(nil) || []
print_options(shell, global_options)
# Print all others
groups.each do |group_name, options|
print_options(shell, options, group_name)
end
end
# Receives a set of options and print them.
def print_options(shell, options, group_name = nil)
return if options.empty?
list = []
padding = options.map { |o| o.aliases_for_usage.size }.max.to_i
options.each do |option|
next if option.hide
item = [option.usage(padding)]
item.push(option.description ? "# #{option.description}" : "")
list << item
list << ["", "# Default: #{option.print_default}"] if option.show_default?
list << ["", "# Possible values: #{option.enum_to_s}"] if option.enum
end
shell.say(group_name ? "#{group_name} options:" : "Options:")
shell.print_table(list, indent: 2)
shell.say ""
end
# Raises an error if the word given is a Bundler::Thor reserved word.
def is_thor_reserved_word?(word, type) #:nodoc:
return false unless THOR_RESERVED_WORDS.include?(word.to_s)
raise "#{word.inspect} is a Bundler::Thor reserved word and cannot be defined as #{type}"
end
# Build an option and adds it to the given scope.
#
# ==== Parameters
# name<Symbol>:: The name of the argument.
# options<Hash>:: Described in both class_option and method_option.
# scope<Hash>:: Options hash that is being built up
def build_option(name, options, scope) #:nodoc:
scope[name] = Bundler::Thor::Option.new(name, {check_default_type: check_default_type}.merge!(options))
end
# Receives a hash of options, parse them and add to the scope. This is a
# fast way to set a bunch of options:
#
# build_options :foo => true, :bar => :required, :baz => :string
#
# ==== Parameters
# Hash[Symbol => Object]
def build_options(options, scope) #:nodoc:
options.each do |key, value|
scope[key] = Bundler::Thor::Option.parse(key, value)
end
end
# Finds a command with the given name. If the command belongs to the current
# class, just return it, otherwise dup it and add the fresh copy to the
# current command hash.
def find_and_refresh_command(name) #:nodoc:
if commands[name.to_s]
commands[name.to_s]
elsif command = all_commands[name.to_s] # rubocop:disable Lint/AssignmentInCondition
commands[name.to_s] = command.clone
else
raise ArgumentError, "You supplied :for => #{name.inspect}, but the command #{name.inspect} could not be found."
end
end
alias_method :find_and_refresh_task, :find_and_refresh_command
# Every time someone inherits from a Bundler::Thor class, register the klass
# and file into baseclass.
def inherited(klass)
super(klass)
Bundler::Thor::Base.register_klass_file(klass)
klass.instance_variable_set(:@no_commands, 0)
end
# Fire this callback whenever a method is added. Added methods are
# tracked as commands by invoking the create_command method.
def method_added(meth)
super(meth)
meth = meth.to_s
if meth == "initialize"
initialize_added
return
end
# Return if it's not a public instance method
return unless public_method_defined?(meth.to_sym)
return if no_commands? || !create_command(meth)
is_thor_reserved_word?(meth, :command)
Bundler::Thor::Base.register_klass_file(self)
end
# Retrieves a value from superclass. If it reaches the baseclass,
# returns default.
def from_superclass(method, default = nil)
if self == baseclass || !superclass.respond_to?(method, true)
default
else
value = superclass.send(method)
# Ruby implements `dup` on Object, but raises a `TypeError`
# if the method is called on immediates. As a result, we
# don't have a good way to check whether dup will succeed
# without calling it and rescuing the TypeError.
begin
value.dup
rescue TypeError
value
end
end
end
#
# The basename of the program invoking the thor class.
#
def basename
File.basename($PROGRAM_NAME).split(" ").first
end
# SIGNATURE: Sets the baseclass. This is where the superclass lookup
# finishes.
def baseclass #:nodoc:
end
# SIGNATURE: Creates a new command if valid_command? is true. This method is
# called when a new method is added to the class.
def create_command(meth) #:nodoc:
end
alias_method :create_task, :create_command
# SIGNATURE: Defines behavior when the initialize method is added to the
# class.
def initialize_added #:nodoc:
end
# SIGNATURE: The hook invoked by start.
def dispatch(command, given_args, given_opts, config) #:nodoc:
raise NotImplementedError
end
# Register a relation of options for target(method_option/class_option)
# by args and block.
def register_options_relation_for(target, relation, *args, &block) # :nodoc:
opt = args.pop if args.last.is_a? Hash
opt ||= {}
names = args.map{ |arg| arg.to_s }
names += built_option_names(target, opt, &block) if block_given?
command_scope_member(relation, opt) << names
end
# Get target(method_options or class_options) options
# of before and after by block evaluation.
def built_option_names(target, opt = {}, &block) # :nodoc:
before = command_scope_member(target, opt).map{ |k,v| v.name }
instance_eval(&block)
after = command_scope_member(target, opt).map{ |k,v| v.name }
after - before
end
# Get command scope member by name.
def command_scope_member(name, options = {}) # :nodoc:
if options[:for]
find_and_refresh_command(options[:for]).send(name)
else
send(name)
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/thor/lib/thor.rb 0000644 00000051360 15173517745 0020460 0 ustar 00 require_relative "thor/base"
class Bundler::Thor
$thor_runner ||= false
class << self
# Allows for custom "Command" package naming.
#
# === Parameters
# name<String>
# options<Hash>
#
def package_name(name, _ = {})
@package_name = name.nil? || name == "" ? nil : name
end
# Sets the default command when thor is executed without an explicit command to be called.
#
# ==== Parameters
# meth<Symbol>:: name of the default command
#
def default_command(meth = nil)
if meth
@default_command = meth == :none ? "help" : meth.to_s
else
@default_command ||= from_superclass(:default_command, "help")
end
end
alias_method :default_task, :default_command
# Registers another Bundler::Thor subclass as a command.
#
# ==== Parameters
# klass<Class>:: Bundler::Thor subclass to register
# command<String>:: Subcommand name to use
# usage<String>:: Short usage for the subcommand
# description<String>:: Description for the subcommand
def register(klass, subcommand_name, usage, description, options = {})
if klass <= Bundler::Thor::Group
desc usage, description, options
define_method(subcommand_name) { |*args| invoke(klass, args) }
else
desc usage, description, options
subcommand subcommand_name, klass
end
end
# Defines the usage and the description of the next command.
#
# ==== Parameters
# usage<String>
# description<String>
# options<String>
#
def desc(usage, description, options = {})
if options[:for]
command = find_and_refresh_command(options[:for])
command.usage = usage if usage
command.description = description if description
else
@usage = usage
@desc = description
@hide = options[:hide] || false
end
end
# Defines the long description of the next command.
#
# Long description is by default indented, line-wrapped and repeated whitespace merged.
# In order to print long description verbatim, with indentation and spacing exactly
# as found in the code, use the +wrap+ option
#
# long_desc 'your very long description', wrap: false
#
# ==== Parameters
# long description<String>
# options<Hash>
#
def long_desc(long_description, options = {})
if options[:for]
command = find_and_refresh_command(options[:for])
command.long_description = long_description if long_description
else
@long_desc = long_description
@long_desc_wrap = options[:wrap] != false
end
end
# Maps an input to a command. If you define:
#
# map "-T" => "list"
#
# Running:
#
# thor -T
#
# Will invoke the list command.
#
# ==== Parameters
# Hash[String|Array => Symbol]:: Maps the string or the strings in the array to the given command.
#
def map(mappings = nil, **kw)
@map ||= from_superclass(:map, {})
if mappings && !kw.empty?
mappings = kw.merge!(mappings)
else
mappings ||= kw
end
if mappings
mappings.each do |key, value|
if key.respond_to?(:each)
key.each { |subkey| @map[subkey] = value }
else
@map[key] = value
end
end
end
@map
end
# Declares the options for the next command to be declared.
#
# ==== Parameters
# Hash[Symbol => Object]:: The hash key is the name of the option and the value
# is the type of the option. Can be :string, :array, :hash, :boolean, :numeric
# or :required (string). If you give a value, the type of the value is used.
#
def method_options(options = nil)
@method_options ||= {}
build_options(options, @method_options) if options
@method_options
end
alias_method :options, :method_options
# Adds an option to the set of method options. If :for is given as option,
# it allows you to change the options from a previous defined command.
#
# def previous_command
# # magic
# end
#
# method_option :foo, :for => :previous_command
#
# def next_command
# # magic
# end
#
# ==== Parameters
# name<Symbol>:: The name of the argument.
# options<Hash>:: Described below.
#
# ==== Options
# :desc - Description for the argument.
# :required - If the argument is required or not.
# :default - Default value for this argument. It cannot be required and have default values.
# :aliases - Aliases for this option.
# :type - The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
# :banner - String to show on usage notes.
# :hide - If you want to hide this option from the help.
#
def method_option(name, options = {})
unless [ Symbol, String ].any? { |klass| name.is_a?(klass) }
raise ArgumentError, "Expected a Symbol or String, got #{name.inspect}"
end
scope = if options[:for]
find_and_refresh_command(options[:for]).options
else
method_options
end
build_option(name, options, scope)
end
alias_method :option, :method_option
# Adds and declares option group for exclusive options in the
# block and arguments. You can declare options as the outside of the block.
#
# If :for is given as option, it allows you to change the options from
# a previous defined command.
#
# ==== Parameters
# Array[Bundler::Thor::Option.name]
# options<Hash>:: :for is applied for previous defined command.
#
# ==== Examples
#
# exclusive do
# option :one
# option :two
# end
#
# Or
#
# option :one
# option :two
# exclusive :one, :two
#
# If you give "--one" and "--two" at the same time ExclusiveArgumentsError
# will be raised.
#
def method_exclusive(*args, &block)
register_options_relation_for(:method_options,
:method_exclusive_option_names, *args, &block)
end
alias_method :exclusive, :method_exclusive
# Adds and declares option group for required at least one of options in the
# block of arguments. You can declare options as the outside of the block.
#
# If :for is given as option, it allows you to change the options from
# a previous defined command.
#
# ==== Parameters
# Array[Bundler::Thor::Option.name]
# options<Hash>:: :for is applied for previous defined command.
#
# ==== Examples
#
# at_least_one do
# option :one
# option :two
# end
#
# Or
#
# option :one
# option :two
# at_least_one :one, :two
#
# If you do not give "--one" and "--two" AtLeastOneRequiredArgumentError
# will be raised.
#
# You can use at_least_one and exclusive at the same time.
#
# exclusive do
# at_least_one do
# option :one
# option :two
# end
# end
#
# Then it is required either only one of "--one" or "--two".
#
def method_at_least_one(*args, &block)
register_options_relation_for(:method_options,
:method_at_least_one_option_names, *args, &block)
end
alias_method :at_least_one, :method_at_least_one
# Prints help information for the given command.
#
# ==== Parameters
# shell<Bundler::Thor::Shell>
# command_name<String>
#
def command_help(shell, command_name)
meth = normalize_command_name(command_name)
command = all_commands[meth]
handle_no_command_error(meth) unless command
shell.say "Usage:"
shell.say " #{banner(command).split("\n").join("\n ")}"
shell.say
class_options_help(shell, nil => command.options.values)
print_exclusive_options(shell, command)
print_at_least_one_required_options(shell, command)
if command.long_description
shell.say "Description:"
if command.wrap_long_description
shell.print_wrapped(command.long_description, indent: 2)
else
shell.say command.long_description
end
else
shell.say command.description
end
end
alias_method :task_help, :command_help
# Prints help information for this class.
#
# ==== Parameters
# shell<Bundler::Thor::Shell>
#
def help(shell, subcommand = false)
list = printable_commands(true, subcommand)
Bundler::Thor::Util.thor_classes_in(self).each do |klass|
list += klass.printable_commands(false)
end
sort_commands!(list)
if defined?(@package_name) && @package_name
shell.say "#{@package_name} commands:"
else
shell.say "Commands:"
end
shell.print_table(list, indent: 2, truncate: true)
shell.say
class_options_help(shell)
print_exclusive_options(shell)
print_at_least_one_required_options(shell)
end
# Returns commands ready to be printed.
def printable_commands(all = true, subcommand = false)
(all ? all_commands : commands).map do |_, command|
next if command.hidden?
item = []
item << banner(command, false, subcommand)
item << (command.description ? "# #{command.description.gsub(/\s+/m, ' ')}" : "")
item
end.compact
end
alias_method :printable_tasks, :printable_commands
def subcommands
@subcommands ||= from_superclass(:subcommands, [])
end
alias_method :subtasks, :subcommands
def subcommand_classes
@subcommand_classes ||= {}
end
def subcommand(subcommand, subcommand_class)
subcommands << subcommand.to_s
subcommand_class.subcommand_help subcommand
subcommand_classes[subcommand.to_s] = subcommand_class
define_method(subcommand) do |*args|
args, opts = Bundler::Thor::Arguments.split(args)
invoke_args = [args, opts, {invoked_via_subcommand: true, class_options: options}]
invoke_args.unshift "help" if opts.delete("--help") || opts.delete("-h")
invoke subcommand_class, *invoke_args
end
subcommand_class.commands.each do |_meth, command|
command.ancestor_name = subcommand
end
end
alias_method :subtask, :subcommand
# Extend check unknown options to accept a hash of conditions.
#
# === Parameters
# options<Hash>: A hash containing :only and/or :except keys
def check_unknown_options!(options = {})
@check_unknown_options ||= {}
options.each do |key, value|
if value
@check_unknown_options[key] = Array(value)
else
@check_unknown_options.delete(key)
end
end
@check_unknown_options
end
# Overwrite check_unknown_options? to take subcommands and options into account.
def check_unknown_options?(config) #:nodoc:
options = check_unknown_options
return false unless options
command = config[:current_command]
return true unless command
name = command.name
if subcommands.include?(name)
false
elsif options[:except]
!options[:except].include?(name.to_sym)
elsif options[:only]
options[:only].include?(name.to_sym)
else
true
end
end
# Stop parsing of options as soon as an unknown option or a regular
# argument is encountered. All remaining arguments are passed to the command.
# This is useful if you have a command that can receive arbitrary additional
# options, and where those additional options should not be handled by
# Bundler::Thor.
#
# ==== Example
#
# To better understand how this is useful, let's consider a command that calls
# an external command. A user may want to pass arbitrary options and
# arguments to that command. The command itself also accepts some options,
# which should be handled by Bundler::Thor.
#
# class_option "verbose", :type => :boolean
# stop_on_unknown_option! :exec
# check_unknown_options! :except => :exec
#
# desc "exec", "Run a shell command"
# def exec(*args)
# puts "diagnostic output" if options[:verbose]
# Kernel.exec(*args)
# end
#
# Here +exec+ can be called with +--verbose+ to get diagnostic output,
# e.g.:
#
# $ thor exec --verbose echo foo
# diagnostic output
# foo
#
# But if +--verbose+ is given after +echo+, it is passed to +echo+ instead:
#
# $ thor exec echo --verbose foo
# --verbose foo
#
# ==== Parameters
# Symbol ...:: A list of commands that should be affected.
def stop_on_unknown_option!(*command_names)
@stop_on_unknown_option = stop_on_unknown_option | command_names
end
def stop_on_unknown_option?(command) #:nodoc:
command && stop_on_unknown_option.include?(command.name.to_sym)
end
# Disable the check for required options for the given commands.
# This is useful if you have a command that does not need the required options
# to work, like help.
#
# ==== Parameters
# Symbol ...:: A list of commands that should be affected.
def disable_required_check!(*command_names)
@disable_required_check = disable_required_check | command_names
end
def disable_required_check?(command) #:nodoc:
command && disable_required_check.include?(command.name.to_sym)
end
protected
# Returns this class exclusive options array set.
#
# ==== Returns
# Array[Array[Bundler::Thor::Option.name]]
#
def method_exclusive_option_names #:nodoc:
@method_exclusive_option_names ||= []
end
# Returns this class at least one of required options array set.
#
# ==== Returns
# Array[Array[Bundler::Thor::Option.name]]
#
def method_at_least_one_option_names #:nodoc:
@method_at_least_one_option_names ||= []
end
def stop_on_unknown_option #:nodoc:
@stop_on_unknown_option ||= []
end
# help command has the required check disabled by default.
def disable_required_check #:nodoc:
@disable_required_check ||= [:help]
end
def print_exclusive_options(shell, command = nil) # :nodoc:
opts = []
opts = command.method_exclusive_option_names unless command.nil?
opts += class_exclusive_option_names
unless opts.empty?
shell.say "Exclusive Options:"
shell.print_table(opts.map{ |ex| ex.map{ |e| "--#{e}"}}, indent: 2 )
shell.say
end
end
def print_at_least_one_required_options(shell, command = nil) # :nodoc:
opts = []
opts = command.method_at_least_one_option_names unless command.nil?
opts += class_at_least_one_option_names
unless opts.empty?
shell.say "Required At Least One:"
shell.print_table(opts.map{ |ex| ex.map{ |e| "--#{e}"}}, indent: 2 )
shell.say
end
end
# The method responsible for dispatching given the args.
def dispatch(meth, given_args, given_opts, config) #:nodoc:
meth ||= retrieve_command_name(given_args)
command = all_commands[normalize_command_name(meth)]
if !command && config[:invoked_via_subcommand]
# We're a subcommand and our first argument didn't match any of our
# commands. So we put it back and call our default command.
given_args.unshift(meth)
command = all_commands[normalize_command_name(default_command)]
end
if command
args, opts = Bundler::Thor::Options.split(given_args)
if stop_on_unknown_option?(command) && !args.empty?
# given_args starts with a non-option, so we treat everything as
# ordinary arguments
args.concat opts
opts.clear
end
else
args = given_args
opts = nil
command = dynamic_command_class.new(meth)
end
opts = given_opts || opts || []
config[:current_command] = command
config[:command_options] = command.options
instance = new(args, opts, config)
yield instance if block_given?
args = instance.args
trailing = args[Range.new(arguments.size, -1)]
instance.invoke_command(command, trailing || [])
end
# The banner for this class. You can customize it if you are invoking the
# thor class by another ways which is not the Bundler::Thor::Runner. It receives
# the command that is going to be invoked and a boolean which indicates if
# the namespace should be displayed as arguments.
#
def banner(command, namespace = nil, subcommand = false)
command.formatted_usage(self, $thor_runner, subcommand).split("\n").map do |formatted_usage|
"#{basename} #{formatted_usage}"
end.join("\n")
end
def baseclass #:nodoc:
Bundler::Thor
end
def dynamic_command_class #:nodoc:
Bundler::Thor::DynamicCommand
end
def create_command(meth) #:nodoc:
@usage ||= nil
@desc ||= nil
@long_desc ||= nil
@long_desc_wrap ||= nil
@hide ||= nil
if @usage && @desc
base_class = @hide ? Bundler::Thor::HiddenCommand : Bundler::Thor::Command
relations = {exclusive_option_names: method_exclusive_option_names,
at_least_one_option_names: method_at_least_one_option_names}
commands[meth] = base_class.new(meth, @desc, @long_desc, @long_desc_wrap, @usage, method_options, relations)
@usage, @desc, @long_desc, @long_desc_wrap, @method_options, @hide = nil
@method_exclusive_option_names, @method_at_least_one_option_names = nil
true
elsif all_commands[meth] || meth == "method_missing"
true
else
puts "[WARNING] Attempted to create command #{meth.inspect} without usage or description. " \
"Call desc if you want this method to be available as command or declare it inside a " \
"no_commands{} block. Invoked from #{caller[1].inspect}."
false
end
end
alias_method :create_task, :create_command
def initialize_added #:nodoc:
class_options.merge!(method_options)
@method_options = nil
end
# Retrieve the command name from given args.
def retrieve_command_name(args) #:nodoc:
meth = args.first.to_s unless args.empty?
args.shift if meth && (map[meth] || meth !~ /^\-/)
end
alias_method :retrieve_task_name, :retrieve_command_name
# receives a (possibly nil) command name and returns a name that is in
# the commands hash. In addition to normalizing aliases, this logic
# will determine if a shortened command is an unambiguous substring of
# a command or alias.
#
# +normalize_command_name+ also converts names like +animal-prison+
# into +animal_prison+.
def normalize_command_name(meth) #:nodoc:
return default_command.to_s.tr("-", "_") unless meth
possibilities = find_command_possibilities(meth)
raise AmbiguousTaskError, "Ambiguous command #{meth} matches [#{possibilities.join(', ')}]" if possibilities.size > 1
if possibilities.empty?
meth ||= default_command
elsif map[meth]
meth = map[meth]
else
meth = possibilities.first
end
meth.to_s.tr("-", "_") # treat foo-bar as foo_bar
end
alias_method :normalize_task_name, :normalize_command_name
# this is the logic that takes the command name passed in by the user
# and determines whether it is an unambiguous substrings of a command or
# alias name.
def find_command_possibilities(meth)
len = meth.to_s.length
possibilities = all_commands.merge(map).keys.select { |n| meth == n[0, len] }.sort
unique_possibilities = possibilities.map { |k| map[k] || k }.uniq
if possibilities.include?(meth)
[meth]
elsif unique_possibilities.size == 1
unique_possibilities
else
possibilities
end
end
alias_method :find_task_possibilities, :find_command_possibilities
def subcommand_help(cmd)
desc "help [COMMAND]", "Describe subcommands or one specific subcommand"
class_eval "
def help(command = nil, subcommand = true); super; end
"
end
alias_method :subtask_help, :subcommand_help
# Sort the commands, lexicographically by default.
#
# Can be overridden in the subclass to change the display order of the
# commands.
def sort_commands!(list)
list.sort! { |a, b| a[0] <=> b[0] }
end
end
include Bundler::Thor::Base
map HELP_MAPPINGS => :help
desc "help [COMMAND]", "Describe available commands or one specific command"
def help(command = nil, subcommand = false)
if command
if self.class.subcommands.include? command
self.class.subcommand_classes[command].help(shell, true)
else
self.class.command_help(shell, command)
end
else
self.class.help(shell, subcommand)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri.rb 0000644 00000006615 15173517745 0020131 0 ustar 00 # frozen_string_literal: false
# Bundler::URI is a module providing classes to handle Uniform Resource Identifiers
# (RFC2396[http://tools.ietf.org/html/rfc2396]).
#
# == Features
#
# * Uniform way of handling URIs.
# * Flexibility to introduce custom Bundler::URI schemes.
# * Flexibility to have an alternate Bundler::URI::Parser (or just different patterns
# and regexp's).
#
# == Basic example
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI("http://foo.com/posts?id=30&limit=5#time=1305298413")
# #=> #<Bundler::URI::HTTP http://foo.com/posts?id=30&limit=5#time=1305298413>
#
# uri.scheme #=> "http"
# uri.host #=> "foo.com"
# uri.path #=> "/posts"
# uri.query #=> "id=30&limit=5"
# uri.fragment #=> "time=1305298413"
#
# uri.to_s #=> "http://foo.com/posts?id=30&limit=5#time=1305298413"
#
# == Adding custom URIs
#
# module Bundler::URI
# class RSYNC < Generic
# DEFAULT_PORT = 873
# end
# register_scheme 'RSYNC', RSYNC
# end
# #=> Bundler::URI::RSYNC
#
# Bundler::URI.scheme_list
# #=> {"FILE"=>Bundler::URI::File, "FTP"=>Bundler::URI::FTP, "HTTP"=>Bundler::URI::HTTP,
# # "HTTPS"=>Bundler::URI::HTTPS, "LDAP"=>Bundler::URI::LDAP, "LDAPS"=>Bundler::URI::LDAPS,
# # "MAILTO"=>Bundler::URI::MailTo, "RSYNC"=>Bundler::URI::RSYNC}
#
# uri = Bundler::URI("rsync://rsync.foo.com")
# #=> #<Bundler::URI::RSYNC rsync://rsync.foo.com>
#
# == RFC References
#
# A good place to view an RFC spec is http://www.ietf.org/rfc.html.
#
# Here is a list of all related RFC's:
# - RFC822[http://tools.ietf.org/html/rfc822]
# - RFC1738[http://tools.ietf.org/html/rfc1738]
# - RFC2255[http://tools.ietf.org/html/rfc2255]
# - RFC2368[http://tools.ietf.org/html/rfc2368]
# - RFC2373[http://tools.ietf.org/html/rfc2373]
# - RFC2396[http://tools.ietf.org/html/rfc2396]
# - RFC2732[http://tools.ietf.org/html/rfc2732]
# - RFC3986[http://tools.ietf.org/html/rfc3986]
#
# == Class tree
#
# - Bundler::URI::Generic (in uri/generic.rb)
# - Bundler::URI::File - (in uri/file.rb)
# - Bundler::URI::FTP - (in uri/ftp.rb)
# - Bundler::URI::HTTP - (in uri/http.rb)
# - Bundler::URI::HTTPS - (in uri/https.rb)
# - Bundler::URI::LDAP - (in uri/ldap.rb)
# - Bundler::URI::LDAPS - (in uri/ldaps.rb)
# - Bundler::URI::MailTo - (in uri/mailto.rb)
# - Bundler::URI::Parser - (in uri/common.rb)
# - Bundler::URI::REGEXP - (in uri/common.rb)
# - Bundler::URI::REGEXP::PATTERN - (in uri/common.rb)
# - Bundler::URI::Util - (in uri/common.rb)
# - Bundler::URI::Error - (in uri/common.rb)
# - Bundler::URI::InvalidURIError - (in uri/common.rb)
# - Bundler::URI::InvalidComponentError - (in uri/common.rb)
# - Bundler::URI::BadURIError - (in uri/common.rb)
#
# == Copyright Info
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# Documentation::
# Akira Yamada <akira@ruby-lang.org>
# Dmitry V. Sabanin <sdmitry@lrn.ru>
# Vincent Batts <vbatts@hashbangbash.com>
# License::
# Copyright (c) 2001 akira yamada <akira@ruby-lang.org>
# You can redistribute it and/or modify it under the same term as Ruby.
#
module Bundler::URI
end
require_relative 'uri/version'
require_relative 'uri/common'
require_relative 'uri/generic'
require_relative 'uri/file'
require_relative 'uri/ftp'
require_relative 'uri/http'
require_relative 'uri/https'
require_relative 'uri/ldap'
require_relative 'uri/ldaps'
require_relative 'uri/mailto'
require_relative 'uri/ws'
require_relative 'uri/wss'
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/generic.rb 0000644 00000115065 15173517745 0021545 0 ustar 00 # frozen_string_literal: true
# = uri/generic.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'common'
autoload :IPSocket, 'socket'
autoload :IPAddr, 'ipaddr'
module Bundler::URI
#
# Base class for all Bundler::URI classes.
# Implements generic Bundler::URI syntax as per RFC 2396.
#
class Generic
include Bundler::URI
#
# A Default port of nil for Bundler::URI::Generic.
#
DEFAULT_PORT = nil
#
# Returns default port.
#
def self.default_port
self::DEFAULT_PORT
end
#
# Returns default port.
#
def default_port
self.class.default_port
end
#
# An Array of the available components for Bundler::URI::Generic.
#
COMPONENT = [
:scheme,
:userinfo, :host, :port, :registry,
:path, :opaque,
:query,
:fragment
].freeze
#
# Components of the Bundler::URI in the order.
#
def self.component
self::COMPONENT
end
USE_REGISTRY = false # :nodoc:
def self.use_registry # :nodoc:
self::USE_REGISTRY
end
#
# == Synopsis
#
# See ::new.
#
# == Description
#
# At first, tries to create a new Bundler::URI::Generic instance using
# Bundler::URI::Generic::build. But, if exception Bundler::URI::InvalidComponentError is raised,
# then it does Bundler::URI::Escape.escape all Bundler::URI components and tries again.
#
def self.build2(args)
begin
return self.build(args)
rescue InvalidComponentError
if args.kind_of?(Array)
return self.build(args.collect{|x|
if x.is_a?(String)
DEFAULT_PARSER.escape(x)
else
x
end
})
elsif args.kind_of?(Hash)
tmp = {}
args.each do |key, value|
tmp[key] = if value
DEFAULT_PARSER.escape(value)
else
value
end
end
return self.build(tmp)
end
end
end
#
# == Synopsis
#
# See ::new.
#
# == Description
#
# Creates a new Bundler::URI::Generic instance from components of Bundler::URI::Generic
# with check. Components are: scheme, userinfo, host, port, registry, path,
# opaque, query, and fragment. You can provide arguments either by an Array or a Hash.
# See ::new for hash keys to use or for order of array items.
#
def self.build(args)
if args.kind_of?(Array) &&
args.size == ::Bundler::URI::Generic::COMPONENT.size
tmp = args.dup
elsif args.kind_of?(Hash)
tmp = ::Bundler::URI::Generic::COMPONENT.collect do |c|
if args.include?(c)
args[c]
else
nil
end
end
else
component = self.class.component rescue ::Bundler::URI::Generic::COMPONENT
raise ArgumentError,
"expected Array of or Hash of components of #{self.class} (#{component.join(', ')})"
end
tmp << nil
tmp << true
return self.new(*tmp)
end
#
# == Args
#
# +scheme+::
# Protocol scheme, i.e. 'http','ftp','mailto' and so on.
# +userinfo+::
# User name and password, i.e. 'sdmitry:bla'.
# +host+::
# Server host name.
# +port+::
# Server port.
# +registry+::
# Registry of naming authorities.
# +path+::
# Path on server.
# +opaque+::
# Opaque part.
# +query+::
# Query data.
# +fragment+::
# Part of the Bundler::URI after '#' character.
# +parser+::
# Parser for internal use [Bundler::URI::DEFAULT_PARSER by default].
# +arg_check+::
# Check arguments [false by default].
#
# == Description
#
# Creates a new Bundler::URI::Generic instance from ``generic'' components without check.
#
def initialize(scheme,
userinfo, host, port, registry,
path, opaque,
query,
fragment,
parser = DEFAULT_PARSER,
arg_check = false)
@scheme = nil
@user = nil
@password = nil
@host = nil
@port = nil
@path = nil
@query = nil
@opaque = nil
@fragment = nil
@parser = parser == DEFAULT_PARSER ? nil : parser
if arg_check
self.scheme = scheme
self.userinfo = userinfo
self.hostname = host
self.port = port
self.path = path
self.query = query
self.opaque = opaque
self.fragment = fragment
else
self.set_scheme(scheme)
self.set_userinfo(userinfo)
self.set_host(host)
self.set_port(port)
self.set_path(path)
self.query = query
self.set_opaque(opaque)
self.fragment=(fragment)
end
if registry
raise InvalidURIError,
"the scheme #{@scheme} does not accept registry part: #{registry} (or bad hostname?)"
end
@scheme&.freeze
self.set_path('') if !@path && !@opaque # (see RFC2396 Section 5.2)
self.set_port(self.default_port) if self.default_port && !@port
end
#
# Returns the scheme component of the Bundler::URI.
#
# Bundler::URI("http://foo/bar/baz").scheme #=> "http"
#
attr_reader :scheme
# Returns the host component of the Bundler::URI.
#
# Bundler::URI("http://foo/bar/baz").host #=> "foo"
#
# It returns nil if no host component exists.
#
# Bundler::URI("mailto:foo@example.org").host #=> nil
#
# The component does not contain the port number.
#
# Bundler::URI("http://foo:8080/bar/baz").host #=> "foo"
#
# Since IPv6 addresses are wrapped with brackets in URIs,
# this method returns IPv6 addresses wrapped with brackets.
# This form is not appropriate to pass to socket methods such as TCPSocket.open.
# If unwrapped host names are required, use the #hostname method.
#
# Bundler::URI("http://[::1]/bar/baz").host #=> "[::1]"
# Bundler::URI("http://[::1]/bar/baz").hostname #=> "::1"
#
attr_reader :host
# Returns the port component of the Bundler::URI.
#
# Bundler::URI("http://foo/bar/baz").port #=> 80
# Bundler::URI("http://foo:8080/bar/baz").port #=> 8080
#
attr_reader :port
def registry # :nodoc:
nil
end
# Returns the path component of the Bundler::URI.
#
# Bundler::URI("http://foo/bar/baz").path #=> "/bar/baz"
#
attr_reader :path
# Returns the query component of the Bundler::URI.
#
# Bundler::URI("http://foo/bar/baz?search=FooBar").query #=> "search=FooBar"
#
attr_reader :query
# Returns the opaque part of the Bundler::URI.
#
# Bundler::URI("mailto:foo@example.org").opaque #=> "foo@example.org"
# Bundler::URI("http://foo/bar/baz").opaque #=> nil
#
# The portion of the path that does not make use of the slash '/'.
# The path typically refers to an absolute path or an opaque part.
# (See RFC2396 Section 3 and 5.2.)
#
attr_reader :opaque
# Returns the fragment component of the Bundler::URI.
#
# Bundler::URI("http://foo/bar/baz?search=FooBar#ponies").fragment #=> "ponies"
#
attr_reader :fragment
# Returns the parser to be used.
#
# Unless a Bundler::URI::Parser is defined, DEFAULT_PARSER is used.
#
def parser
if !defined?(@parser) || !@parser
DEFAULT_PARSER
else
@parser || DEFAULT_PARSER
end
end
# Replaces self by other Bundler::URI object.
#
def replace!(oth)
if self.class != oth.class
raise ArgumentError, "expected #{self.class} object"
end
component.each do |c|
self.__send__("#{c}=", oth.__send__(c))
end
end
private :replace!
#
# Components of the Bundler::URI in the order.
#
def component
self.class.component
end
#
# Checks the scheme +v+ component against the Bundler::URI::Parser Regexp for :SCHEME.
#
def check_scheme(v)
if v && parser.regexp[:SCHEME] !~ v
raise InvalidComponentError,
"bad component(expected scheme component): #{v}"
end
return true
end
private :check_scheme
# Protected setter for the scheme component +v+.
#
# See also Bundler::URI::Generic.scheme=.
#
def set_scheme(v)
@scheme = v&.downcase
end
protected :set_scheme
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the scheme component +v+
# (with validation).
#
# See also Bundler::URI::Generic.check_scheme.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com")
# uri.scheme = "https"
# uri.to_s #=> "https://my.example.com"
#
def scheme=(v)
check_scheme(v)
set_scheme(v)
v
end
#
# Checks the +user+ and +password+.
#
# If +password+ is not provided, then +user+ is
# split, using Bundler::URI::Generic.split_userinfo, to
# pull +user+ and +password.
#
# See also Bundler::URI::Generic.check_user, Bundler::URI::Generic.check_password.
#
def check_userinfo(user, password = nil)
if !password
user, password = split_userinfo(user)
end
check_user(user)
check_password(password, user)
return true
end
private :check_userinfo
#
# Checks the user +v+ component for RFC2396 compliance
# and against the Bundler::URI::Parser Regexp for :USERINFO.
#
# Can not have a registry or opaque component defined,
# with a user component defined.
#
def check_user(v)
if @opaque
raise InvalidURIError,
"can not set user with opaque"
end
return v unless v
if parser.regexp[:USERINFO] !~ v
raise InvalidComponentError,
"bad component(expected userinfo component or user component): #{v}"
end
return true
end
private :check_user
#
# Checks the password +v+ component for RFC2396 compliance
# and against the Bundler::URI::Parser Regexp for :USERINFO.
#
# Can not have a registry or opaque component defined,
# with a user component defined.
#
def check_password(v, user = @user)
if @opaque
raise InvalidURIError,
"can not set password with opaque"
end
return v unless v
if !user
raise InvalidURIError,
"password component depends user component"
end
if parser.regexp[:USERINFO] !~ v
raise InvalidComponentError,
"bad password component"
end
return true
end
private :check_password
#
# Sets userinfo, argument is string like 'name:pass'.
#
def userinfo=(userinfo)
if userinfo.nil?
return nil
end
check_userinfo(*userinfo)
set_userinfo(*userinfo)
# returns userinfo
end
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the +user+ component
# (with validation).
#
# See also Bundler::URI::Generic.check_user.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://john:S3nsit1ve@my.example.com")
# uri.user = "sam"
# uri.to_s #=> "http://sam:V3ry_S3nsit1ve@my.example.com"
#
def user=(user)
check_user(user)
set_user(user)
# returns user
end
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the +password+ component
# (with validation).
#
# See also Bundler::URI::Generic.check_password.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://john:S3nsit1ve@my.example.com")
# uri.password = "V3ry_S3nsit1ve"
# uri.to_s #=> "http://john:V3ry_S3nsit1ve@my.example.com"
#
def password=(password)
check_password(password)
set_password(password)
# returns password
end
# Protected setter for the +user+ component, and +password+ if available
# (with validation).
#
# See also Bundler::URI::Generic.userinfo=.
#
def set_userinfo(user, password = nil)
unless password
user, password = split_userinfo(user)
end
@user = user
@password = password if password
[@user, @password]
end
protected :set_userinfo
# Protected setter for the user component +v+.
#
# See also Bundler::URI::Generic.user=.
#
def set_user(v)
set_userinfo(v, @password)
v
end
protected :set_user
# Protected setter for the password component +v+.
#
# See also Bundler::URI::Generic.password=.
#
def set_password(v)
@password = v
# returns v
end
protected :set_password
# Returns the userinfo +ui+ as <code>[user, password]</code>
# if properly formatted as 'user:password'.
def split_userinfo(ui)
return nil, nil unless ui
user, password = ui.split(':', 2)
return user, password
end
private :split_userinfo
# Escapes 'user:password' +v+ based on RFC 1738 section 3.1.
def escape_userpass(v)
parser.escape(v, /[@:\/]/o) # RFC 1738 section 3.1 #/
end
private :escape_userpass
# Returns the userinfo, either as 'user' or 'user:password'.
def userinfo
if @user.nil?
nil
elsif @password.nil?
@user
else
@user + ':' + @password
end
end
# Returns the user component (without Bundler::URI decoding).
def user
@user
end
# Returns the password component (without Bundler::URI decoding).
def password
@password
end
# Returns the user component after Bundler::URI decoding.
def decoded_user
Bundler::URI.decode_uri_component(@user) if @user
end
# Returns the password component after Bundler::URI decoding.
def decoded_password
Bundler::URI.decode_uri_component(@password) if @password
end
#
# Checks the host +v+ component for RFC2396 compliance
# and against the Bundler::URI::Parser Regexp for :HOST.
#
# Can not have a registry or opaque component defined,
# with a host component defined.
#
def check_host(v)
return v unless v
if @opaque
raise InvalidURIError,
"can not set host with registry or opaque"
elsif parser.regexp[:HOST] !~ v
raise InvalidComponentError,
"bad component(expected host component): #{v}"
end
return true
end
private :check_host
# Protected setter for the host component +v+.
#
# See also Bundler::URI::Generic.host=.
#
def set_host(v)
@host = v
end
protected :set_host
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the host component +v+
# (with validation).
#
# See also Bundler::URI::Generic.check_host.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com")
# uri.host = "foo.com"
# uri.to_s #=> "http://foo.com"
#
def host=(v)
check_host(v)
set_host(v)
v
end
# Extract the host part of the Bundler::URI and unwrap brackets for IPv6 addresses.
#
# This method is the same as Bundler::URI::Generic#host except
# brackets for IPv6 (and future IP) addresses are removed.
#
# uri = Bundler::URI("http://[::1]/bar")
# uri.hostname #=> "::1"
# uri.host #=> "[::1]"
#
def hostname
v = self.host
v&.start_with?('[') && v.end_with?(']') ? v[1..-2] : v
end
# Sets the host part of the Bundler::URI as the argument with brackets for IPv6 addresses.
#
# This method is the same as Bundler::URI::Generic#host= except
# the argument can be a bare IPv6 address.
#
# uri = Bundler::URI("http://foo/bar")
# uri.hostname = "::1"
# uri.to_s #=> "http://[::1]/bar"
#
# If the argument seems to be an IPv6 address,
# it is wrapped with brackets.
#
def hostname=(v)
v = "[#{v}]" if !(v&.start_with?('[') && v&.end_with?(']')) && v&.index(':')
self.host = v
end
#
# Checks the port +v+ component for RFC2396 compliance
# and against the Bundler::URI::Parser Regexp for :PORT.
#
# Can not have a registry or opaque component defined,
# with a port component defined.
#
def check_port(v)
return v unless v
if @opaque
raise InvalidURIError,
"can not set port with registry or opaque"
elsif !v.kind_of?(Integer) && parser.regexp[:PORT] !~ v
raise InvalidComponentError,
"bad component(expected port component): #{v.inspect}"
end
return true
end
private :check_port
# Protected setter for the port component +v+.
#
# See also Bundler::URI::Generic.port=.
#
def set_port(v)
v = v.empty? ? nil : v.to_i unless !v || v.kind_of?(Integer)
@port = v
end
protected :set_port
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the port component +v+
# (with validation).
#
# See also Bundler::URI::Generic.check_port.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com")
# uri.port = 8080
# uri.to_s #=> "http://my.example.com:8080"
#
def port=(v)
check_port(v)
set_port(v)
port
end
def check_registry(v) # :nodoc:
raise InvalidURIError, "can not set registry"
end
private :check_registry
def set_registry(v) #:nodoc:
raise InvalidURIError, "can not set registry"
end
protected :set_registry
def registry=(v)
raise InvalidURIError, "can not set registry"
end
#
# Checks the path +v+ component for RFC2396 compliance
# and against the Bundler::URI::Parser Regexp
# for :ABS_PATH and :REL_PATH.
#
# Can not have a opaque component defined,
# with a path component defined.
#
def check_path(v)
# raise if both hier and opaque are not nil, because:
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if v && @opaque
raise InvalidURIError,
"path conflicts with opaque"
end
# If scheme is ftp, path may be relative.
# See RFC 1738 section 3.2.2, and RFC 2396.
if @scheme && @scheme != "ftp"
if v && v != '' && parser.regexp[:ABS_PATH] !~ v
raise InvalidComponentError,
"bad component(expected absolute path component): #{v}"
end
else
if v && v != '' && parser.regexp[:ABS_PATH] !~ v &&
parser.regexp[:REL_PATH] !~ v
raise InvalidComponentError,
"bad component(expected relative path component): #{v}"
end
end
return true
end
private :check_path
# Protected setter for the path component +v+.
#
# See also Bundler::URI::Generic.path=.
#
def set_path(v)
@path = v
end
protected :set_path
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the path component +v+
# (with validation).
#
# See also Bundler::URI::Generic.check_path.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com/pub/files")
# uri.path = "/faq/"
# uri.to_s #=> "http://my.example.com/faq/"
#
def path=(v)
check_path(v)
set_path(v)
v
end
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the query component +v+.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com/?id=25")
# uri.query = "id=1"
# uri.to_s #=> "http://my.example.com/?id=1"
#
def query=(v)
return @query = nil unless v
raise InvalidURIError, "query conflicts with opaque" if @opaque
x = v.to_str
v = x.dup if x.equal? v
v.encode!(Encoding::UTF_8) rescue nil
v.delete!("\t\r\n")
v.force_encoding(Encoding::ASCII_8BIT)
raise InvalidURIError, "invalid percent escape: #{$1}" if /(%\H\H)/n.match(v)
v.gsub!(/(?!%\h\h|[!$-&(-;=?-_a-~])./n.freeze){'%%%02X' % $&.ord}
v.force_encoding(Encoding::US_ASCII)
@query = v
end
#
# Checks the opaque +v+ component for RFC2396 compliance and
# against the Bundler::URI::Parser Regexp for :OPAQUE.
#
# Can not have a host, port, user, or path component defined,
# with an opaque component defined.
#
def check_opaque(v)
return v unless v
# raise if both hier and opaque are not nil, because:
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
if @host || @port || @user || @path # userinfo = @user + ':' + @password
raise InvalidURIError,
"can not set opaque with host, port, userinfo or path"
elsif v && parser.regexp[:OPAQUE] !~ v
raise InvalidComponentError,
"bad component(expected opaque component): #{v}"
end
return true
end
private :check_opaque
# Protected setter for the opaque component +v+.
#
# See also Bundler::URI::Generic.opaque=.
#
def set_opaque(v)
@opaque = v
end
protected :set_opaque
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the opaque component +v+
# (with validation).
#
# See also Bundler::URI::Generic.check_opaque.
#
def opaque=(v)
check_opaque(v)
set_opaque(v)
v
end
#
# Checks the fragment +v+ component against the Bundler::URI::Parser Regexp for :FRAGMENT.
#
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the fragment component +v+
# (with validation).
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com/?id=25#time=1305212049")
# uri.fragment = "time=1305212086"
# uri.to_s #=> "http://my.example.com/?id=25#time=1305212086"
#
def fragment=(v)
return @fragment = nil unless v
x = v.to_str
v = x.dup if x.equal? v
v.encode!(Encoding::UTF_8) rescue nil
v.delete!("\t\r\n")
v.force_encoding(Encoding::ASCII_8BIT)
v.gsub!(/(?!%\h\h|[!-~])./n){'%%%02X' % $&.ord}
v.force_encoding(Encoding::US_ASCII)
@fragment = v
end
#
# Returns true if Bundler::URI is hierarchical.
#
# == Description
#
# Bundler::URI has components listed in order of decreasing significance from left to right,
# see RFC3986 https://tools.ietf.org/html/rfc3986 1.2.3.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com/")
# uri.hierarchical?
# #=> true
# uri = Bundler::URI.parse("mailto:joe@example.com")
# uri.hierarchical?
# #=> false
#
def hierarchical?
if @path
true
else
false
end
end
#
# Returns true if Bundler::URI has a scheme (e.g. http:// or https://) specified.
#
def absolute?
if @scheme
true
else
false
end
end
alias absolute absolute?
#
# Returns true if Bundler::URI does not have a scheme (e.g. http:// or https://) specified.
#
def relative?
!absolute?
end
#
# Returns an Array of the path split on '/'.
#
def split_path(path)
path.split("/", -1)
end
private :split_path
#
# Merges a base path +base+, with relative path +rel+,
# returns a modified base path.
#
def merge_path(base, rel)
# RFC2396, Section 5.2, 5)
# RFC2396, Section 5.2, 6)
base_path = split_path(base)
rel_path = split_path(rel)
# RFC2396, Section 5.2, 6), a)
base_path << '' if base_path.last == '..'
while i = base_path.index('..')
base_path.slice!(i - 1, 2)
end
if (first = rel_path.first) and first.empty?
base_path.clear
rel_path.shift
end
# RFC2396, Section 5.2, 6), c)
# RFC2396, Section 5.2, 6), d)
rel_path.push('') if rel_path.last == '.' || rel_path.last == '..'
rel_path.delete('.')
# RFC2396, Section 5.2, 6), e)
tmp = []
rel_path.each do |x|
if x == '..' &&
!(tmp.empty? || tmp.last == '..')
tmp.pop
else
tmp << x
end
end
add_trailer_slash = !tmp.empty?
if base_path.empty?
base_path = [''] # keep '/' for root directory
elsif add_trailer_slash
base_path.pop
end
while x = tmp.shift
if x == '..'
# RFC2396, Section 4
# a .. or . in an absolute path has no special meaning
base_path.pop if base_path.size > 1
else
# if x == '..'
# valid absolute (but abnormal) path "/../..."
# else
# valid absolute path
# end
base_path << x
tmp.each {|t| base_path << t}
add_trailer_slash = false
break
end
end
base_path.push('') if add_trailer_slash
return base_path.join('/')
end
private :merge_path
#
# == Args
#
# +oth+::
# Bundler::URI or String
#
# == Description
#
# Destructive form of #merge.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com")
# uri.merge!("/main.rbx?page=1")
# uri.to_s # => "http://my.example.com/main.rbx?page=1"
#
def merge!(oth)
t = merge(oth)
if self == t
nil
else
replace!(t)
self
end
end
#
# == Args
#
# +oth+::
# Bundler::URI or String
#
# == Description
#
# Merges two URIs.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com")
# uri.merge("/main.rbx?page=1")
# # => "http://my.example.com/main.rbx?page=1"
#
def merge(oth)
rel = parser.__send__(:convert_to_uri, oth)
if rel.absolute?
#raise BadURIError, "both Bundler::URI are absolute" if absolute?
# hmm... should return oth for usability?
return rel
end
unless self.absolute?
raise BadURIError, "both Bundler::URI are relative"
end
base = self.dup
authority = rel.userinfo || rel.host || rel.port
# RFC2396, Section 5.2, 2)
if (rel.path.nil? || rel.path.empty?) && !authority && !rel.query
base.fragment=(rel.fragment) if rel.fragment
return base
end
base.query = nil
base.fragment=(nil)
# RFC2396, Section 5.2, 4)
if !authority
base.set_path(merge_path(base.path, rel.path)) if base.path && rel.path
else
# RFC2396, Section 5.2, 4)
base.set_path(rel.path) if rel.path
end
# RFC2396, Section 5.2, 7)
base.set_userinfo(rel.userinfo) if rel.userinfo
base.set_host(rel.host) if rel.host
base.set_port(rel.port) if rel.port
base.query = rel.query if rel.query
base.fragment=(rel.fragment) if rel.fragment
return base
end # merge
alias + merge
# :stopdoc:
def route_from_path(src, dst)
case dst
when src
# RFC2396, Section 4.2
return ''
when %r{(?:\A|/)\.\.?(?:/|\z)}
# dst has abnormal absolute path,
# like "/./", "/../", "/x/../", ...
return dst.dup
end
src_path = src.scan(%r{[^/]*/})
dst_path = dst.scan(%r{[^/]*/?})
# discard same parts
while !dst_path.empty? && dst_path.first == src_path.first
src_path.shift
dst_path.shift
end
tmp = dst_path.join
# calculate
if src_path.empty?
if tmp.empty?
return './'
elsif dst_path.first.include?(':') # (see RFC2396 Section 5)
return './' + tmp
else
return tmp
end
end
return '../' * src_path.size + tmp
end
private :route_from_path
# :startdoc:
# :stopdoc:
def route_from0(oth)
oth = parser.__send__(:convert_to_uri, oth)
if self.relative?
raise BadURIError,
"relative Bundler::URI: #{self}"
end
if oth.relative?
raise BadURIError,
"relative Bundler::URI: #{oth}"
end
if self.scheme != oth.scheme
return self, self.dup
end
rel = Bundler::URI::Generic.new(nil, # it is relative Bundler::URI
self.userinfo, self.host, self.port,
nil, self.path, self.opaque,
self.query, self.fragment, parser)
if rel.userinfo != oth.userinfo ||
rel.host.to_s.downcase != oth.host.to_s.downcase ||
rel.port != oth.port
if self.userinfo.nil? && self.host.nil?
return self, self.dup
end
rel.set_port(nil) if rel.port == oth.default_port
return rel, rel
end
rel.set_userinfo(nil)
rel.set_host(nil)
rel.set_port(nil)
if rel.path && rel.path == oth.path
rel.set_path('')
rel.query = nil if rel.query == oth.query
return rel, rel
elsif rel.opaque && rel.opaque == oth.opaque
rel.set_opaque('')
rel.query = nil if rel.query == oth.query
return rel, rel
end
# you can modify `rel', but can not `oth'.
return oth, rel
end
private :route_from0
# :startdoc:
#
# == Args
#
# +oth+::
# Bundler::URI or String
#
# == Description
#
# Calculates relative path from oth to self.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse('http://my.example.com/main.rbx?page=1')
# uri.route_from('http://my.example.com')
# #=> #<Bundler::URI::Generic /main.rbx?page=1>
#
def route_from(oth)
# you can modify `rel', but can not `oth'.
begin
oth, rel = route_from0(oth)
rescue
raise $!.class, $!.message
end
if oth == rel
return rel
end
rel.set_path(route_from_path(oth.path, self.path))
if rel.path == './' && self.query
# "./?foo" -> "?foo"
rel.set_path('')
end
return rel
end
alias - route_from
#
# == Args
#
# +oth+::
# Bundler::URI or String
#
# == Description
#
# Calculates relative path to oth from self.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse('http://my.example.com')
# uri.route_to('http://my.example.com/main.rbx?page=1')
# #=> #<Bundler::URI::Generic /main.rbx?page=1>
#
def route_to(oth)
parser.__send__(:convert_to_uri, oth).route_from(self)
end
#
# Returns normalized Bundler::URI.
#
# require 'bundler/vendor/uri/lib/uri'
#
# Bundler::URI("HTTP://my.EXAMPLE.com").normalize
# #=> #<Bundler::URI::HTTP http://my.example.com/>
#
# Normalization here means:
#
# * scheme and host are converted to lowercase,
# * an empty path component is set to "/".
#
def normalize
uri = dup
uri.normalize!
uri
end
#
# Destructive version of #normalize.
#
def normalize!
if path&.empty?
set_path('/')
end
if scheme && scheme != scheme.downcase
set_scheme(self.scheme.downcase)
end
if host && host != host.downcase
set_host(self.host.downcase)
end
end
#
# Constructs String from Bundler::URI.
#
def to_s
str = ''.dup
if @scheme
str << @scheme
str << ':'
end
if @opaque
str << @opaque
else
if @host || %w[file postgres].include?(@scheme)
str << '//'
end
if self.userinfo
str << self.userinfo
str << '@'
end
if @host
str << @host
end
if @port && @port != self.default_port
str << ':'
str << @port.to_s
end
str << @path
if @query
str << '?'
str << @query
end
end
if @fragment
str << '#'
str << @fragment
end
str
end
alias to_str to_s
#
# Compares two URIs.
#
def ==(oth)
if self.class == oth.class
self.normalize.component_ary == oth.normalize.component_ary
else
false
end
end
def hash
self.component_ary.hash
end
def eql?(oth)
self.class == oth.class &&
parser == oth.parser &&
self.component_ary.eql?(oth.component_ary)
end
=begin
--- Bundler::URI::Generic#===(oth)
=end
# def ===(oth)
# raise NotImplementedError
# end
=begin
=end
# Returns an Array of the components defined from the COMPONENT Array.
def component_ary
component.collect do |x|
self.__send__(x)
end
end
protected :component_ary
# == Args
#
# +components+::
# Multiple Symbol arguments defined in Bundler::URI::HTTP.
#
# == Description
#
# Selects specified components from Bundler::URI.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse('http://myuser:mypass@my.example.com/test.rbx')
# uri.select(:userinfo, :host, :path)
# # => ["myuser:mypass", "my.example.com", "/test.rbx"]
#
def select(*components)
components.collect do |c|
if component.include?(c)
self.__send__(c)
else
raise ArgumentError,
"expected of components of #{self.class} (#{self.class.component.join(', ')})"
end
end
end
def inspect
"#<#{self.class} #{self}>"
end
#
# == Args
#
# +v+::
# Bundler::URI or String
#
# == Description
#
# Attempts to parse other Bundler::URI +oth+,
# returns [parsed_oth, self].
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("http://my.example.com")
# uri.coerce("http://foo.com")
# #=> [#<Bundler::URI::HTTP http://foo.com>, #<Bundler::URI::HTTP http://my.example.com>]
#
def coerce(oth)
case oth
when String
oth = parser.parse(oth)
else
super
end
return oth, self
end
# Returns a proxy Bundler::URI.
# The proxy Bundler::URI is obtained from environment variables such as http_proxy,
# ftp_proxy, no_proxy, etc.
# If there is no proper proxy, nil is returned.
#
# If the optional parameter +env+ is specified, it is used instead of ENV.
#
# Note that capitalized variables (HTTP_PROXY, FTP_PROXY, NO_PROXY, etc.)
# are examined, too.
#
# But http_proxy and HTTP_PROXY is treated specially under CGI environment.
# It's because HTTP_PROXY may be set by Proxy: header.
# So HTTP_PROXY is not used.
# http_proxy is not used too if the variable is case insensitive.
# CGI_HTTP_PROXY can be used instead.
def find_proxy(env=ENV)
raise BadURIError, "relative Bundler::URI: #{self}" if self.relative?
name = self.scheme.downcase + '_proxy'
proxy_uri = nil
if name == 'http_proxy' && env.include?('REQUEST_METHOD') # CGI?
# HTTP_PROXY conflicts with *_proxy for proxy settings and
# HTTP_* for header information in CGI.
# So it should be careful to use it.
pairs = env.reject {|k, v| /\Ahttp_proxy\z/i !~ k }
case pairs.length
when 0 # no proxy setting anyway.
proxy_uri = nil
when 1
k, _ = pairs.shift
if k == 'http_proxy' && env[k.upcase] == nil
# http_proxy is safe to use because ENV is case sensitive.
proxy_uri = env[name]
else
proxy_uri = nil
end
else # http_proxy is safe to use because ENV is case sensitive.
proxy_uri = env.to_hash[name]
end
if !proxy_uri
# Use CGI_HTTP_PROXY. cf. libwww-perl.
proxy_uri = env["CGI_#{name.upcase}"]
end
elsif name == 'http_proxy'
if RUBY_ENGINE == 'jruby' && p_addr = ENV_JAVA['http.proxyHost']
p_port = ENV_JAVA['http.proxyPort']
if p_user = ENV_JAVA['http.proxyUser']
p_pass = ENV_JAVA['http.proxyPass']
proxy_uri = "http://#{p_user}:#{p_pass}@#{p_addr}:#{p_port}"
else
proxy_uri = "http://#{p_addr}:#{p_port}"
end
else
unless proxy_uri = env[name]
if proxy_uri = env[name.upcase]
warn 'The environment variable HTTP_PROXY is discouraged. Use http_proxy.', uplevel: 1
end
end
end
else
proxy_uri = env[name] || env[name.upcase]
end
if proxy_uri.nil? || proxy_uri.empty?
return nil
end
if self.hostname
begin
addr = IPSocket.getaddress(self.hostname)
return nil if /\A127\.|\A::1\z/ =~ addr
rescue SocketError
end
end
name = 'no_proxy'
if no_proxy = env[name] || env[name.upcase]
return nil unless Bundler::URI::Generic.use_proxy?(self.hostname, addr, self.port, no_proxy)
end
Bundler::URI.parse(proxy_uri)
end
def self.use_proxy?(hostname, addr, port, no_proxy) # :nodoc:
hostname = hostname.downcase
dothostname = ".#{hostname}"
no_proxy.scan(/([^:,\s]+)(?::(\d+))?/) {|p_host, p_port|
if !p_port || port == p_port.to_i
if p_host.start_with?('.')
return false if hostname.end_with?(p_host.downcase)
else
return false if dothostname.end_with?(".#{p_host.downcase}")
end
if addr
begin
return false if IPAddr.new(p_host).include?(addr)
rescue IPAddr::InvalidAddressError
next
end
end
end
}
true
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/wss.rb 0000644 00000001067 15173517745 0020741 0 ustar 00 # frozen_string_literal: false
# = uri/wss.rb
#
# Author:: Matt Muller <mamuller@amazon.com>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'ws'
module Bundler::URI
# The default port for WSS URIs is 443, and the scheme is 'wss:' rather
# than 'ws:'. Other than that, WSS URIs are identical to WS URIs;
# see Bundler::URI::WS.
class WSS < WS
# A Default port of 443 for Bundler::URI::WSS
DEFAULT_PORT = 443
end
register_scheme 'WSS', WSS
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/https.rb 0000644 00000001122 15173517745 0021257 0 ustar 00 # frozen_string_literal: false
# = uri/https.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'http'
module Bundler::URI
# The default port for HTTPS URIs is 443, and the scheme is 'https:' rather
# than 'http:'. Other than that, HTTPS URIs are identical to HTTP URIs;
# see Bundler::URI::HTTP.
class HTTPS < HTTP
# A Default port of 443 for Bundler::URI::HTTPS
DEFAULT_PORT = 443
end
register_scheme 'HTTPS', HTTPS
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/ftp.rb 0000644 00000016430 15173517745 0020716 0 ustar 00 # frozen_string_literal: false
# = uri/ftp.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'generic'
module Bundler::URI
#
# FTP Bundler::URI syntax is defined by RFC1738 section 3.2.
#
# This class will be redesigned because of difference of implementations;
# the structure of its path. draft-hoffman-ftp-uri-04 is a draft but it
# is a good summary about the de facto spec.
# http://tools.ietf.org/html/draft-hoffman-ftp-uri-04
#
class FTP < Generic
# A Default port of 21 for Bundler::URI::FTP.
DEFAULT_PORT = 21
#
# An Array of the available components for Bundler::URI::FTP.
#
COMPONENT = [
:scheme,
:userinfo, :host, :port,
:path, :typecode
].freeze
#
# Typecode is "a", "i", or "d".
#
# * "a" indicates a text file (the FTP command was ASCII)
# * "i" indicates a binary file (FTP command IMAGE)
# * "d" indicates the contents of a directory should be displayed
#
TYPECODE = ['a', 'i', 'd'].freeze
# Typecode prefix ";type=".
TYPECODE_PREFIX = ';type='.freeze
def self.new2(user, password, host, port, path,
typecode = nil, arg_check = true) # :nodoc:
# Do not use this method! Not tested. [Bug #7301]
# This methods remains just for compatibility,
# Keep it undocumented until the active maintainer is assigned.
typecode = nil if typecode.size == 0
if typecode && !TYPECODE.include?(typecode)
raise ArgumentError,
"bad typecode is specified: #{typecode}"
end
# do escape
self.new('ftp',
[user, password],
host, port, nil,
typecode ? path + TYPECODE_PREFIX + typecode : path,
nil, nil, nil, arg_check)
end
#
# == Description
#
# Creates a new Bundler::URI::FTP object from components, with syntax checking.
#
# The components accepted are +userinfo+, +host+, +port+, +path+, and
# +typecode+.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[userinfo, host, port, path, typecode]</code>.
#
# If the path supplied is absolute, it will be escaped in order to
# make it absolute in the Bundler::URI.
#
# Examples:
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri1 = Bundler::URI::FTP.build(['user:password', 'ftp.example.com', nil,
# '/path/file.zip', 'i'])
# uri1.to_s # => "ftp://user:password@ftp.example.com/%2Fpath/file.zip;type=i"
#
# uri2 = Bundler::URI::FTP.build({:host => 'ftp.example.com',
# :path => 'ruby/src'})
# uri2.to_s # => "ftp://ftp.example.com/ruby/src"
#
def self.build(args)
# Fix the incoming path to be generic URL syntax
# FTP path -> URL path
# foo/bar /foo/bar
# /foo/bar /%2Ffoo/bar
#
if args.kind_of?(Array)
args[3] = '/' + args[3].sub(/^\//, '%2F')
else
args[:path] = '/' + args[:path].sub(/^\//, '%2F')
end
tmp = Util::make_components_hash(self, args)
if tmp[:typecode]
if tmp[:typecode].size == 1
tmp[:typecode] = TYPECODE_PREFIX + tmp[:typecode]
end
tmp[:path] << tmp[:typecode]
end
return super(tmp)
end
#
# == Description
#
# Creates a new Bundler::URI::FTP object from generic URL components with no
# syntax checking.
#
# Unlike build(), this method does not escape the path component as
# required by RFC1738; instead it is treated as per RFC2396.
#
# Arguments are +scheme+, +userinfo+, +host+, +port+, +registry+, +path+,
# +opaque+, +query+, and +fragment+, in that order.
#
def initialize(scheme,
userinfo, host, port, registry,
path, opaque,
query,
fragment,
parser = nil,
arg_check = false)
raise InvalidURIError unless path
path = path.sub(/^\//,'')
path.sub!(/^%2F/,'/')
super(scheme, userinfo, host, port, registry, path, opaque,
query, fragment, parser, arg_check)
@typecode = nil
if tmp = @path.index(TYPECODE_PREFIX)
typecode = @path[tmp + TYPECODE_PREFIX.size..-1]
@path = @path[0..tmp - 1]
if arg_check
self.typecode = typecode
else
self.set_typecode(typecode)
end
end
end
# typecode accessor.
#
# See Bundler::URI::FTP::COMPONENT.
attr_reader :typecode
# Validates typecode +v+,
# returns +true+ or +false+.
#
def check_typecode(v)
if TYPECODE.include?(v)
return true
else
raise InvalidComponentError,
"bad typecode(expected #{TYPECODE.join(', ')}): #{v}"
end
end
private :check_typecode
# Private setter for the typecode +v+.
#
# See also Bundler::URI::FTP.typecode=.
#
def set_typecode(v)
@typecode = v
end
protected :set_typecode
#
# == Args
#
# +v+::
# String
#
# == Description
#
# Public setter for the typecode +v+
# (with validation).
#
# See also Bundler::URI::FTP.check_typecode.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("ftp://john@ftp.example.com/my_file.img")
# #=> #<Bundler::URI::FTP ftp://john@ftp.example.com/my_file.img>
# uri.typecode = "i"
# uri
# #=> #<Bundler::URI::FTP ftp://john@ftp.example.com/my_file.img;type=i>
#
def typecode=(typecode)
check_typecode(typecode)
set_typecode(typecode)
typecode
end
def merge(oth) # :nodoc:
tmp = super(oth)
if self != tmp
tmp.set_typecode(oth.typecode)
end
return tmp
end
# Returns the path from an FTP Bundler::URI.
#
# RFC 1738 specifically states that the path for an FTP Bundler::URI does not
# include the / which separates the Bundler::URI path from the Bundler::URI host. Example:
#
# <code>ftp://ftp.example.com/pub/ruby</code>
#
# The above Bundler::URI indicates that the client should connect to
# ftp.example.com then cd to pub/ruby from the initial login directory.
#
# If you want to cd to an absolute directory, you must include an
# escaped / (%2F) in the path. Example:
#
# <code>ftp://ftp.example.com/%2Fpub/ruby</code>
#
# This method will then return "/pub/ruby".
#
def path
return @path.sub(/^\//,'').sub(/^%2F/,'/')
end
# Private setter for the path of the Bundler::URI::FTP.
def set_path(v)
super("/" + v.sub(/^\//, "%2F"))
end
protected :set_path
# Returns a String representation of the Bundler::URI::FTP.
def to_s
save_path = nil
if @typecode
save_path = @path
@path = @path + TYPECODE_PREFIX + @typecode
end
str = super
if @typecode
@path = save_path
end
return str
end
end
register_scheme 'FTP', FTP
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/rfc3986_parser.rb 0000644 00000012015 15173517745 0022600 0 ustar 00 # frozen_string_literal: true
module Bundler::URI
class RFC3986_Parser # :nodoc:
# Bundler::URI defined in RFC3986
HOST = %r[
(?<IP-literal>\[(?:
(?<IPv6address>
(?:\h{1,4}:){6}
(?<ls32>\h{1,4}:\h{1,4}
| (?<IPv4address>(?<dec-octet>[1-9]\d|1\d{2}|2[0-4]\d|25[0-5]|\d)
\.\g<dec-octet>\.\g<dec-octet>\.\g<dec-octet>)
)
| ::(?:\h{1,4}:){5}\g<ls32>
| \h{1,4}?::(?:\h{1,4}:){4}\g<ls32>
| (?:(?:\h{1,4}:)?\h{1,4})?::(?:\h{1,4}:){3}\g<ls32>
| (?:(?:\h{1,4}:){,2}\h{1,4})?::(?:\h{1,4}:){2}\g<ls32>
| (?:(?:\h{1,4}:){,3}\h{1,4})?::\h{1,4}:\g<ls32>
| (?:(?:\h{1,4}:){,4}\h{1,4})?::\g<ls32>
| (?:(?:\h{1,4}:){,5}\h{1,4})?::\h{1,4}
| (?:(?:\h{1,4}:){,6}\h{1,4})?::
)
| (?<IPvFuture>v\h++\.[!$&-.0-9:;=A-Z_a-z~]++)
)\])
| \g<IPv4address>
| (?<reg-name>(?:%\h\h|[!$&-.0-9;=A-Z_a-z~])*+)
]x
USERINFO = /(?:%\h\h|[!$&-.0-9:;=A-Z_a-z~])*+/
SCHEME = %r[[A-Za-z][+\-.0-9A-Za-z]*+].source
SEG = %r[(?:%\h\h|[!$&-.0-9:;=@A-Z_a-z~/])].source
SEG_NC = %r[(?:%\h\h|[!$&-.0-9;=@A-Z_a-z~])].source
FRAGMENT = %r[(?:%\h\h|[!$&-.0-9:;=@A-Z_a-z~/?])*+].source
RFC3986_URI = %r[\A
(?<seg>#{SEG}){0}
(?<Bundler::URI>
(?<scheme>#{SCHEME}):
(?<hier-part>//
(?<authority>
(?:(?<userinfo>#{USERINFO.source})@)?
(?<host>#{HOST.source.delete(" \n")})
(?::(?<port>\d*+))?
)
(?<path-abempty>(?:/\g<seg>*+)?)
| (?<path-absolute>/((?!/)\g<seg>++)?)
| (?<path-rootless>(?!/)\g<seg>++)
| (?<path-empty>)
)
(?:\?(?<query>[^\#]*+))?
(?:\#(?<fragment>#{FRAGMENT}))?
)\z]x
RFC3986_relative_ref = %r[\A
(?<seg>#{SEG}){0}
(?<relative-ref>
(?<relative-part>//
(?<authority>
(?:(?<userinfo>#{USERINFO.source})@)?
(?<host>#{HOST.source.delete(" \n")}(?<!/))?
(?::(?<port>\d*+))?
)
(?<path-abempty>(?:/\g<seg>*+)?)
| (?<path-absolute>/\g<seg>*+)
| (?<path-noscheme>#{SEG_NC}++(?:/\g<seg>*+)?)
| (?<path-empty>)
)
(?:\?(?<query>[^#]*+))?
(?:\#(?<fragment>#{FRAGMENT}))?
)\z]x
attr_reader :regexp
def initialize
@regexp = default_regexp.each_value(&:freeze).freeze
end
def split(uri) #:nodoc:
begin
uri = uri.to_str
rescue NoMethodError
raise InvalidURIError, "bad Bundler::URI(is not Bundler::URI?): #{uri.inspect}"
end
uri.ascii_only? or
raise InvalidURIError, "Bundler::URI must be ascii only #{uri.dump}"
if m = RFC3986_URI.match(uri)
query = m["query"]
scheme = m["scheme"]
opaque = m["path-rootless"]
if opaque
opaque << "?#{query}" if query
[ scheme,
nil, # userinfo
nil, # host
nil, # port
nil, # registry
nil, # path
opaque,
nil, # query
m["fragment"]
]
else # normal
[ scheme,
m["userinfo"],
m["host"],
m["port"],
nil, # registry
(m["path-abempty"] ||
m["path-absolute"] ||
m["path-empty"]),
nil, # opaque
query,
m["fragment"]
]
end
elsif m = RFC3986_relative_ref.match(uri)
[ nil, # scheme
m["userinfo"],
m["host"],
m["port"],
nil, # registry,
(m["path-abempty"] ||
m["path-absolute"] ||
m["path-noscheme"] ||
m["path-empty"]),
nil, # opaque
m["query"],
m["fragment"]
]
else
raise InvalidURIError, "bad Bundler::URI(is not Bundler::URI?): #{uri.inspect}"
end
end
def parse(uri) # :nodoc:
Bundler::URI.for(*self.split(uri), self)
end
def join(*uris) # :nodoc:
uris[0] = convert_to_uri(uris[0])
uris.inject :merge
end
@@to_s = Kernel.instance_method(:to_s)
if @@to_s.respond_to?(:bind_call)
def inspect
@@to_s.bind_call(self)
end
else
def inspect
@@to_s.bind(self).call
end
end
private
def default_regexp # :nodoc:
{
SCHEME: %r[\A#{SCHEME}\z]o,
USERINFO: %r[\A#{USERINFO}\z]o,
HOST: %r[\A#{HOST}\z]o,
ABS_PATH: %r[\A/#{SEG}*+\z]o,
REL_PATH: %r[\A(?!/)#{SEG}++\z]o,
QUERY: %r[\A(?:%\h\h|[!$&-.0-9:;=@A-Z_a-z~/?])*+\z],
FRAGMENT: %r[\A#{FRAGMENT}\z]o,
OPAQUE: %r[\A(?:[^/].*)?\z],
PORT: /\A[\x09\x0a\x0c\x0d ]*+\d*[\x09\x0a\x0c\x0d ]*\z/,
}
end
def convert_to_uri(uri)
if uri.is_a?(Bundler::URI::Generic)
uri
elsif uri = String.try_convert(uri)
parse(uri)
else
raise ArgumentError,
"bad argument (expected Bundler::URI object or Bundler::URI string)"
end
end
end # class Parser
end # module Bundler::URI
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/rfc2396_parser.rb 0000644 00000042662 15173517745 0022605 0 ustar 00 # frozen_string_literal: false
#--
# = uri/common.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License::
# You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
module Bundler::URI
#
# Includes Bundler::URI::REGEXP::PATTERN
#
module RFC2396_REGEXP
#
# Patterns used to parse Bundler::URI's
#
module PATTERN
# :stopdoc:
# RFC 2396 (Bundler::URI Generic Syntax)
# RFC 2732 (IPv6 Literal Addresses in URL's)
# RFC 2373 (IPv6 Addressing Architecture)
# alpha = lowalpha | upalpha
ALPHA = "a-zA-Z"
# alphanum = alpha | digit
ALNUM = "#{ALPHA}\\d"
# hex = digit | "A" | "B" | "C" | "D" | "E" | "F" |
# "a" | "b" | "c" | "d" | "e" | "f"
HEX = "a-fA-F\\d"
# escaped = "%" hex hex
ESCAPED = "%[#{HEX}]{2}"
# mark = "-" | "_" | "." | "!" | "~" | "*" | "'" |
# "(" | ")"
# unreserved = alphanum | mark
UNRESERVED = "\\-_.!~*'()#{ALNUM}"
# reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
# "$" | ","
# reserved = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
# "$" | "," | "[" | "]" (RFC 2732)
RESERVED = ";/?:@&=+$,\\[\\]"
# domainlabel = alphanum | alphanum *( alphanum | "-" ) alphanum
DOMLABEL = "(?:[#{ALNUM}](?:[-#{ALNUM}]*[#{ALNUM}])?)"
# toplabel = alpha | alpha *( alphanum | "-" ) alphanum
TOPLABEL = "(?:[#{ALPHA}](?:[-#{ALNUM}]*[#{ALNUM}])?)"
# hostname = *( domainlabel "." ) toplabel [ "." ]
HOSTNAME = "(?:#{DOMLABEL}\\.)*#{TOPLABEL}\\.?"
# :startdoc:
end # PATTERN
# :startdoc:
end # REGEXP
# Class that parses String's into Bundler::URI's.
#
# It contains a Hash set of patterns and Regexp's that match and validate.
#
class RFC2396_Parser
include RFC2396_REGEXP
#
# == Synopsis
#
# Bundler::URI::Parser.new([opts])
#
# == Args
#
# The constructor accepts a hash as options for parser.
# Keys of options are pattern names of Bundler::URI components
# and values of options are pattern strings.
# The constructor generates set of regexps for parsing URIs.
#
# You can use the following keys:
#
# * :ESCAPED (Bundler::URI::PATTERN::ESCAPED in default)
# * :UNRESERVED (Bundler::URI::PATTERN::UNRESERVED in default)
# * :DOMLABEL (Bundler::URI::PATTERN::DOMLABEL in default)
# * :TOPLABEL (Bundler::URI::PATTERN::TOPLABEL in default)
# * :HOSTNAME (Bundler::URI::PATTERN::HOSTNAME in default)
#
# == Examples
#
# p = Bundler::URI::Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
# u = p.parse("http://example.jp/%uABCD") #=> #<Bundler::URI::HTTP http://example.jp/%uABCD>
# Bundler::URI.parse(u.to_s) #=> raises Bundler::URI::InvalidURIError
#
# s = "http://example.com/ABCD"
# u1 = p.parse(s) #=> #<Bundler::URI::HTTP http://example.com/ABCD>
# u2 = Bundler::URI.parse(s) #=> #<Bundler::URI::HTTP http://example.com/ABCD>
# u1 == u2 #=> true
# u1.eql?(u2) #=> false
#
def initialize(opts = {})
@pattern = initialize_pattern(opts)
@pattern.each_value(&:freeze)
@pattern.freeze
@regexp = initialize_regexp(@pattern)
@regexp.each_value(&:freeze)
@regexp.freeze
end
# The Hash of patterns.
#
# See also Bundler::URI::Parser.initialize_pattern.
attr_reader :pattern
# The Hash of Regexp.
#
# See also Bundler::URI::Parser.initialize_regexp.
attr_reader :regexp
# Returns a split Bundler::URI against +regexp[:ABS_URI]+.
def split(uri)
case uri
when ''
# null uri
when @regexp[:ABS_URI]
scheme, opaque, userinfo, host, port,
registry, path, query, fragment = $~[1..-1]
# Bundler::URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
# absoluteURI = scheme ":" ( hier_part | opaque_part )
# hier_part = ( net_path | abs_path ) [ "?" query ]
# opaque_part = uric_no_slash *uric
# abs_path = "/" path_segments
# net_path = "//" authority [ abs_path ]
# authority = server | reg_name
# server = [ [ userinfo "@" ] hostport ]
if !scheme
raise InvalidURIError,
"bad Bundler::URI(absolute but no scheme): #{uri}"
end
if !opaque && (!path && (!host && !registry))
raise InvalidURIError,
"bad Bundler::URI(absolute but no path): #{uri}"
end
when @regexp[:REL_URI]
scheme = nil
opaque = nil
userinfo, host, port, registry,
rel_segment, abs_path, query, fragment = $~[1..-1]
if rel_segment && abs_path
path = rel_segment + abs_path
elsif rel_segment
path = rel_segment
elsif abs_path
path = abs_path
end
# Bundler::URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
# relativeURI = ( net_path | abs_path | rel_path ) [ "?" query ]
# net_path = "//" authority [ abs_path ]
# abs_path = "/" path_segments
# rel_path = rel_segment [ abs_path ]
# authority = server | reg_name
# server = [ [ userinfo "@" ] hostport ]
else
raise InvalidURIError, "bad Bundler::URI(is not Bundler::URI?): #{uri}"
end
path = '' if !path && !opaque # (see RFC2396 Section 5.2)
ret = [
scheme,
userinfo, host, port, # X
registry, # X
path, # Y
opaque, # Y
query,
fragment
]
return ret
end
#
# == Args
#
# +uri+::
# String
#
# == Description
#
# Parses +uri+ and constructs either matching Bundler::URI scheme object
# (File, FTP, HTTP, HTTPS, LDAP, LDAPS, or MailTo) or Bundler::URI::Generic.
#
# == Usage
#
# p = Bundler::URI::Parser.new
# p.parse("ldap://ldap.example.com/dc=example?user=john")
# #=> #<Bundler::URI::LDAP ldap://ldap.example.com/dc=example?user=john>
#
def parse(uri)
Bundler::URI.for(*self.split(uri), self)
end
#
# == Args
#
# +uris+::
# an Array of Strings
#
# == Description
#
# Attempts to parse and merge a set of URIs.
#
def join(*uris)
uris[0] = convert_to_uri(uris[0])
uris.inject :merge
end
#
# :call-seq:
# extract( str )
# extract( str, schemes )
# extract( str, schemes ) {|item| block }
#
# == Args
#
# +str+::
# String to search
# +schemes+::
# Patterns to apply to +str+
#
# == Description
#
# Attempts to parse and merge a set of URIs.
# If no +block+ given, then returns the result,
# else it calls +block+ for each element in result.
#
# See also Bundler::URI::Parser.make_regexp.
#
def extract(str, schemes = nil)
if block_given?
str.scan(make_regexp(schemes)) { yield $& }
nil
else
result = []
str.scan(make_regexp(schemes)) { result.push $& }
result
end
end
# Returns Regexp that is default +self.regexp[:ABS_URI_REF]+,
# unless +schemes+ is provided. Then it is a Regexp.union with +self.pattern[:X_ABS_URI]+.
def make_regexp(schemes = nil)
unless schemes
@regexp[:ABS_URI_REF]
else
/(?=#{Regexp.union(*schemes)}:)#{@pattern[:X_ABS_URI]}/x
end
end
#
# :call-seq:
# escape( str )
# escape( str, unsafe )
#
# == Args
#
# +str+::
# String to make safe
# +unsafe+::
# Regexp to apply. Defaults to +self.regexp[:UNSAFE]+
#
# == Description
#
# Constructs a safe String from +str+, removing unsafe characters,
# replacing them with codes.
#
def escape(str, unsafe = @regexp[:UNSAFE])
unless unsafe.kind_of?(Regexp)
# perhaps unsafe is String object
unsafe = Regexp.new("[#{Regexp.quote(unsafe)}]", false)
end
str.gsub(unsafe) do
us = $&
tmp = ''
us.each_byte do |uc|
tmp << sprintf('%%%02X', uc)
end
tmp
end.force_encoding(Encoding::US_ASCII)
end
#
# :call-seq:
# unescape( str )
# unescape( str, escaped )
#
# == Args
#
# +str+::
# String to remove escapes from
# +escaped+::
# Regexp to apply. Defaults to +self.regexp[:ESCAPED]+
#
# == Description
#
# Removes escapes from +str+.
#
def unescape(str, escaped = @regexp[:ESCAPED])
enc = str.encoding
enc = Encoding::UTF_8 if enc == Encoding::US_ASCII
str.gsub(escaped) { [$&[1, 2]].pack('H2').force_encoding(enc) }
end
@@to_s = Kernel.instance_method(:to_s)
if @@to_s.respond_to?(:bind_call)
def inspect
@@to_s.bind_call(self)
end
else
def inspect
@@to_s.bind(self).call
end
end
private
# Constructs the default Hash of patterns.
def initialize_pattern(opts = {})
ret = {}
ret[:ESCAPED] = escaped = (opts.delete(:ESCAPED) || PATTERN::ESCAPED)
ret[:UNRESERVED] = unreserved = opts.delete(:UNRESERVED) || PATTERN::UNRESERVED
ret[:RESERVED] = reserved = opts.delete(:RESERVED) || PATTERN::RESERVED
ret[:DOMLABEL] = opts.delete(:DOMLABEL) || PATTERN::DOMLABEL
ret[:TOPLABEL] = opts.delete(:TOPLABEL) || PATTERN::TOPLABEL
ret[:HOSTNAME] = hostname = opts.delete(:HOSTNAME)
# RFC 2396 (Bundler::URI Generic Syntax)
# RFC 2732 (IPv6 Literal Addresses in URL's)
# RFC 2373 (IPv6 Addressing Architecture)
# uric = reserved | unreserved | escaped
ret[:URIC] = uric = "(?:[#{unreserved}#{reserved}]|#{escaped})"
# uric_no_slash = unreserved | escaped | ";" | "?" | ":" | "@" |
# "&" | "=" | "+" | "$" | ","
ret[:URIC_NO_SLASH] = uric_no_slash = "(?:[#{unreserved};?:@&=+$,]|#{escaped})"
# query = *uric
ret[:QUERY] = query = "#{uric}*"
# fragment = *uric
ret[:FRAGMENT] = fragment = "#{uric}*"
# hostname = *( domainlabel "." ) toplabel [ "." ]
# reg-name = *( unreserved / pct-encoded / sub-delims ) # RFC3986
unless hostname
ret[:HOSTNAME] = hostname = "(?:[a-zA-Z0-9\\-.]|%\\h\\h)+"
end
# RFC 2373, APPENDIX B:
# IPv6address = hexpart [ ":" IPv4address ]
# IPv4address = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT
# hexpart = hexseq | hexseq "::" [ hexseq ] | "::" [ hexseq ]
# hexseq = hex4 *( ":" hex4)
# hex4 = 1*4HEXDIG
#
# XXX: This definition has a flaw. "::" + IPv4address must be
# allowed too. Here is a replacement.
#
# IPv4address = 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT "." 1*3DIGIT
ret[:IPV4ADDR] = ipv4addr = "\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"
# hex4 = 1*4HEXDIG
hex4 = "[#{PATTERN::HEX}]{1,4}"
# lastpart = hex4 | IPv4address
lastpart = "(?:#{hex4}|#{ipv4addr})"
# hexseq1 = *( hex4 ":" ) hex4
hexseq1 = "(?:#{hex4}:)*#{hex4}"
# hexseq2 = *( hex4 ":" ) lastpart
hexseq2 = "(?:#{hex4}:)*#{lastpart}"
# IPv6address = hexseq2 | [ hexseq1 ] "::" [ hexseq2 ]
ret[:IPV6ADDR] = ipv6addr = "(?:#{hexseq2}|(?:#{hexseq1})?::(?:#{hexseq2})?)"
# IPv6prefix = ( hexseq1 | [ hexseq1 ] "::" [ hexseq1 ] ) "/" 1*2DIGIT
# unused
# ipv6reference = "[" IPv6address "]" (RFC 2732)
ret[:IPV6REF] = ipv6ref = "\\[#{ipv6addr}\\]"
# host = hostname | IPv4address
# host = hostname | IPv4address | IPv6reference (RFC 2732)
ret[:HOST] = host = "(?:#{hostname}|#{ipv4addr}|#{ipv6ref})"
# port = *digit
ret[:PORT] = port = '\d*'
# hostport = host [ ":" port ]
ret[:HOSTPORT] = hostport = "#{host}(?::#{port})?"
# userinfo = *( unreserved | escaped |
# ";" | ":" | "&" | "=" | "+" | "$" | "," )
ret[:USERINFO] = userinfo = "(?:[#{unreserved};:&=+$,]|#{escaped})*"
# pchar = unreserved | escaped |
# ":" | "@" | "&" | "=" | "+" | "$" | ","
pchar = "(?:[#{unreserved}:@&=+$,]|#{escaped})"
# param = *pchar
param = "#{pchar}*"
# segment = *pchar *( ";" param )
segment = "#{pchar}*(?:;#{param})*"
# path_segments = segment *( "/" segment )
ret[:PATH_SEGMENTS] = path_segments = "#{segment}(?:/#{segment})*"
# server = [ [ userinfo "@" ] hostport ]
server = "(?:#{userinfo}@)?#{hostport}"
# reg_name = 1*( unreserved | escaped | "$" | "," |
# ";" | ":" | "@" | "&" | "=" | "+" )
ret[:REG_NAME] = reg_name = "(?:[#{unreserved}$,;:@&=+]|#{escaped})+"
# authority = server | reg_name
authority = "(?:#{server}|#{reg_name})"
# rel_segment = 1*( unreserved | escaped |
# ";" | "@" | "&" | "=" | "+" | "$" | "," )
ret[:REL_SEGMENT] = rel_segment = "(?:[#{unreserved};@&=+$,]|#{escaped})+"
# scheme = alpha *( alpha | digit | "+" | "-" | "." )
ret[:SCHEME] = scheme = "[#{PATTERN::ALPHA}][\\-+.#{PATTERN::ALPHA}\\d]*"
# abs_path = "/" path_segments
ret[:ABS_PATH] = abs_path = "/#{path_segments}"
# rel_path = rel_segment [ abs_path ]
ret[:REL_PATH] = rel_path = "#{rel_segment}(?:#{abs_path})?"
# net_path = "//" authority [ abs_path ]
ret[:NET_PATH] = net_path = "//#{authority}(?:#{abs_path})?"
# hier_part = ( net_path | abs_path ) [ "?" query ]
ret[:HIER_PART] = hier_part = "(?:#{net_path}|#{abs_path})(?:\\?(?:#{query}))?"
# opaque_part = uric_no_slash *uric
ret[:OPAQUE_PART] = opaque_part = "#{uric_no_slash}#{uric}*"
# absoluteURI = scheme ":" ( hier_part | opaque_part )
ret[:ABS_URI] = abs_uri = "#{scheme}:(?:#{hier_part}|#{opaque_part})"
# relativeURI = ( net_path | abs_path | rel_path ) [ "?" query ]
ret[:REL_URI] = rel_uri = "(?:#{net_path}|#{abs_path}|#{rel_path})(?:\\?#{query})?"
# Bundler::URI-reference = [ absoluteURI | relativeURI ] [ "#" fragment ]
ret[:URI_REF] = "(?:#{abs_uri}|#{rel_uri})?(?:##{fragment})?"
ret[:X_ABS_URI] = "
(#{scheme}): (?# 1: scheme)
(?:
(#{opaque_part}) (?# 2: opaque)
|
(?:(?:
//(?:
(?:(?:(#{userinfo})@)? (?# 3: userinfo)
(?:(#{host})(?::(\\d*))?))? (?# 4: host, 5: port)
|
(#{reg_name}) (?# 6: registry)
)
|
(?!//)) (?# XXX: '//' is the mark for hostport)
(#{abs_path})? (?# 7: path)
)(?:\\?(#{query}))? (?# 8: query)
)
(?:\\#(#{fragment}))? (?# 9: fragment)
"
ret[:X_REL_URI] = "
(?:
(?:
//
(?:
(?:(#{userinfo})@)? (?# 1: userinfo)
(#{host})?(?::(\\d*))? (?# 2: host, 3: port)
|
(#{reg_name}) (?# 4: registry)
)
)
|
(#{rel_segment}) (?# 5: rel_segment)
)?
(#{abs_path})? (?# 6: abs_path)
(?:\\?(#{query}))? (?# 7: query)
(?:\\#(#{fragment}))? (?# 8: fragment)
"
ret
end
# Constructs the default Hash of Regexp's.
def initialize_regexp(pattern)
ret = {}
# for Bundler::URI::split
ret[:ABS_URI] = Regexp.new('\A\s*+' + pattern[:X_ABS_URI] + '\s*\z', Regexp::EXTENDED)
ret[:REL_URI] = Regexp.new('\A\s*+' + pattern[:X_REL_URI] + '\s*\z', Regexp::EXTENDED)
# for Bundler::URI::extract
ret[:URI_REF] = Regexp.new(pattern[:URI_REF])
ret[:ABS_URI_REF] = Regexp.new(pattern[:X_ABS_URI], Regexp::EXTENDED)
ret[:REL_URI_REF] = Regexp.new(pattern[:X_REL_URI], Regexp::EXTENDED)
# for Bundler::URI::escape/unescape
ret[:ESCAPED] = Regexp.new(pattern[:ESCAPED])
ret[:UNSAFE] = Regexp.new("[^#{pattern[:UNRESERVED]}#{pattern[:RESERVED]}]")
# for Generic#initialize
ret[:SCHEME] = Regexp.new("\\A#{pattern[:SCHEME]}\\z")
ret[:USERINFO] = Regexp.new("\\A#{pattern[:USERINFO]}\\z")
ret[:HOST] = Regexp.new("\\A#{pattern[:HOST]}\\z")
ret[:PORT] = Regexp.new("\\A#{pattern[:PORT]}\\z")
ret[:OPAQUE] = Regexp.new("\\A#{pattern[:OPAQUE_PART]}\\z")
ret[:REGISTRY] = Regexp.new("\\A#{pattern[:REG_NAME]}\\z")
ret[:ABS_PATH] = Regexp.new("\\A#{pattern[:ABS_PATH]}\\z")
ret[:REL_PATH] = Regexp.new("\\A#{pattern[:REL_PATH]}\\z")
ret[:QUERY] = Regexp.new("\\A#{pattern[:QUERY]}\\z")
ret[:FRAGMENT] = Regexp.new("\\A#{pattern[:FRAGMENT]}\\z")
ret
end
def convert_to_uri(uri)
if uri.is_a?(Bundler::URI::Generic)
uri
elsif uri = String.try_convert(uri)
parse(uri)
else
raise ArgumentError,
"bad argument (expected Bundler::URI object or Bundler::URI string)"
end
end
end # class Parser
end # module Bundler::URI
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/common.rb 0000644 00000064534 15173517745 0021425 0 ustar 00 # frozen_string_literal: true
#--
# = uri/common.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License::
# You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative "rfc2396_parser"
require_relative "rfc3986_parser"
module Bundler::URI
include RFC2396_REGEXP
REGEXP = RFC2396_REGEXP
Parser = RFC2396_Parser
RFC3986_PARSER = RFC3986_Parser.new
Ractor.make_shareable(RFC3986_PARSER) if defined?(Ractor)
RFC2396_PARSER = RFC2396_Parser.new
Ractor.make_shareable(RFC2396_PARSER) if defined?(Ractor)
# Bundler::URI::Parser.new
DEFAULT_PARSER = Parser.new
DEFAULT_PARSER.pattern.each_pair do |sym, str|
unless REGEXP::PATTERN.const_defined?(sym)
REGEXP::PATTERN.const_set(sym, str)
end
end
DEFAULT_PARSER.regexp.each_pair do |sym, str|
const_set(sym, str)
end
Ractor.make_shareable(DEFAULT_PARSER) if defined?(Ractor)
module Util # :nodoc:
def make_components_hash(klass, array_hash)
tmp = {}
if array_hash.kind_of?(Array) &&
array_hash.size == klass.component.size - 1
klass.component[1..-1].each_index do |i|
begin
tmp[klass.component[i + 1]] = array_hash[i].clone
rescue TypeError
tmp[klass.component[i + 1]] = array_hash[i]
end
end
elsif array_hash.kind_of?(Hash)
array_hash.each do |key, value|
begin
tmp[key] = value.clone
rescue TypeError
tmp[key] = value
end
end
else
raise ArgumentError,
"expected Array of or Hash of components of #{klass} (#{klass.component[1..-1].join(', ')})"
end
tmp[:scheme] = klass.to_s.sub(/\A.*::/, '').downcase
return tmp
end
module_function :make_components_hash
end
module Schemes
end
private_constant :Schemes
# Registers the given +klass+ as the class to be instantiated
# when parsing a \Bundler::URI with the given +scheme+:
#
# Bundler::URI.register_scheme('MS_SEARCH', Bundler::URI::Generic) # => Bundler::URI::Generic
# Bundler::URI.scheme_list['MS_SEARCH'] # => Bundler::URI::Generic
#
# Note that after calling String#upcase on +scheme+, it must be a valid
# constant name.
def self.register_scheme(scheme, klass)
Schemes.const_set(scheme.to_s.upcase, klass)
end
# Returns a hash of the defined schemes:
#
# Bundler::URI.scheme_list
# # =>
# {"MAILTO"=>Bundler::URI::MailTo,
# "LDAPS"=>Bundler::URI::LDAPS,
# "WS"=>Bundler::URI::WS,
# "HTTP"=>Bundler::URI::HTTP,
# "HTTPS"=>Bundler::URI::HTTPS,
# "LDAP"=>Bundler::URI::LDAP,
# "FILE"=>Bundler::URI::File,
# "FTP"=>Bundler::URI::FTP}
#
# Related: Bundler::URI.register_scheme.
def self.scheme_list
Schemes.constants.map { |name|
[name.to_s.upcase, Schemes.const_get(name)]
}.to_h
end
INITIAL_SCHEMES = scheme_list
private_constant :INITIAL_SCHEMES
Ractor.make_shareable(INITIAL_SCHEMES) if defined?(Ractor)
# Returns a new object constructed from the given +scheme+, +arguments+,
# and +default+:
#
# - The new object is an instance of <tt>Bundler::URI.scheme_list[scheme.upcase]</tt>.
# - The object is initialized by calling the class initializer
# using +scheme+ and +arguments+.
# See Bundler::URI::Generic.new.
#
# Examples:
#
# values = ['john.doe', 'www.example.com', '123', nil, '/forum/questions/', nil, 'tag=networking&order=newest', 'top']
# Bundler::URI.for('https', *values)
# # => #<Bundler::URI::HTTPS https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
# Bundler::URI.for('foo', *values, default: Bundler::URI::HTTP)
# # => #<Bundler::URI::HTTP foo://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
#
def self.for(scheme, *arguments, default: Generic)
const_name = scheme.to_s.upcase
uri_class = INITIAL_SCHEMES[const_name]
uri_class ||= if /\A[A-Z]\w*\z/.match?(const_name) && Schemes.const_defined?(const_name, false)
Schemes.const_get(const_name, false)
end
uri_class ||= default
return uri_class.new(scheme, *arguments)
end
#
# Base class for all Bundler::URI exceptions.
#
class Error < StandardError; end
#
# Not a Bundler::URI.
#
class InvalidURIError < Error; end
#
# Not a Bundler::URI component.
#
class InvalidComponentError < Error; end
#
# Bundler::URI is valid, bad usage is not.
#
class BadURIError < Error; end
# Returns a 9-element array representing the parts of the \Bundler::URI
# formed from the string +uri+;
# each array element is a string or +nil+:
#
# names = %w[scheme userinfo host port registry path opaque query fragment]
# values = Bundler::URI.split('https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# names.zip(values)
# # =>
# [["scheme", "https"],
# ["userinfo", "john.doe"],
# ["host", "www.example.com"],
# ["port", "123"],
# ["registry", nil],
# ["path", "/forum/questions/"],
# ["opaque", nil],
# ["query", "tag=networking&order=newest"],
# ["fragment", "top"]]
#
def self.split(uri)
RFC3986_PARSER.split(uri)
end
# Returns a new \Bundler::URI object constructed from the given string +uri+:
#
# Bundler::URI.parse('https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# # => #<Bundler::URI::HTTPS https://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
# Bundler::URI.parse('http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
# # => #<Bundler::URI::HTTP http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
#
# It's recommended to first ::escape string +uri+
# if it may contain invalid Bundler::URI characters.
#
def self.parse(uri)
RFC3986_PARSER.parse(uri)
end
# Merges the given Bundler::URI strings +str+
# per {RFC 2396}[https://www.rfc-editor.org/rfc/rfc2396.html].
#
# Each string in +str+ is converted to an
# {RFC3986 Bundler::URI}[https://www.rfc-editor.org/rfc/rfc3986.html] before being merged.
#
# Examples:
#
# Bundler::URI.join("http://example.com/","main.rbx")
# # => #<Bundler::URI::HTTP http://example.com/main.rbx>
#
# Bundler::URI.join('http://example.com', 'foo')
# # => #<Bundler::URI::HTTP http://example.com/foo>
#
# Bundler::URI.join('http://example.com', '/foo', '/bar')
# # => #<Bundler::URI::HTTP http://example.com/bar>
#
# Bundler::URI.join('http://example.com', '/foo', 'bar')
# # => #<Bundler::URI::HTTP http://example.com/bar>
#
# Bundler::URI.join('http://example.com', '/foo/', 'bar')
# # => #<Bundler::URI::HTTP http://example.com/foo/bar>
#
def self.join(*str)
RFC3986_PARSER.join(*str)
end
#
# == Synopsis
#
# Bundler::URI::extract(str[, schemes][,&blk])
#
# == Args
#
# +str+::
# String to extract URIs from.
# +schemes+::
# Limit Bundler::URI matching to specific schemes.
#
# == Description
#
# Extracts URIs from a string. If block given, iterates through all matched URIs.
# Returns nil if block given or array with matches.
#
# == Usage
#
# require "bundler/vendor/uri/lib/uri"
#
# Bundler::URI.extract("text here http://foo.example.org/bla and here mailto:test@example.com and here also.")
# # => ["http://foo.example.com/bla", "mailto:test@example.com"]
#
def self.extract(str, schemes = nil, &block) # :nodoc:
warn "Bundler::URI.extract is obsolete", uplevel: 1 if $VERBOSE
DEFAULT_PARSER.extract(str, schemes, &block)
end
#
# == Synopsis
#
# Bundler::URI::regexp([match_schemes])
#
# == Args
#
# +match_schemes+::
# Array of schemes. If given, resulting regexp matches to URIs
# whose scheme is one of the match_schemes.
#
# == Description
#
# Returns a Regexp object which matches to Bundler::URI-like strings.
# The Regexp object returned by this method includes arbitrary
# number of capture group (parentheses). Never rely on its number.
#
# == Usage
#
# require 'bundler/vendor/uri/lib/uri'
#
# # extract first Bundler::URI from html_string
# html_string.slice(Bundler::URI.regexp)
#
# # remove ftp URIs
# html_string.sub(Bundler::URI.regexp(['ftp']), '')
#
# # You should not rely on the number of parentheses
# html_string.scan(Bundler::URI.regexp) do |*matches|
# p $&
# end
#
def self.regexp(schemes = nil)# :nodoc:
warn "Bundler::URI.regexp is obsolete", uplevel: 1 if $VERBOSE
DEFAULT_PARSER.make_regexp(schemes)
end
TBLENCWWWCOMP_ = {} # :nodoc:
256.times do |i|
TBLENCWWWCOMP_[-i.chr] = -('%%%02X' % i)
end
TBLENCURICOMP_ = TBLENCWWWCOMP_.dup.freeze
TBLENCWWWCOMP_[' '] = '+'
TBLENCWWWCOMP_.freeze
TBLDECWWWCOMP_ = {} # :nodoc:
256.times do |i|
h, l = i>>4, i&15
TBLDECWWWCOMP_[-('%%%X%X' % [h, l])] = -i.chr
TBLDECWWWCOMP_[-('%%%x%X' % [h, l])] = -i.chr
TBLDECWWWCOMP_[-('%%%X%x' % [h, l])] = -i.chr
TBLDECWWWCOMP_[-('%%%x%x' % [h, l])] = -i.chr
end
TBLDECWWWCOMP_['+'] = ' '
TBLDECWWWCOMP_.freeze
# Returns a URL-encoded string derived from the given string +str+.
#
# The returned string:
#
# - Preserves:
#
# - Characters <tt>'*'</tt>, <tt>'.'</tt>, <tt>'-'</tt>, and <tt>'_'</tt>.
# - Character in ranges <tt>'a'..'z'</tt>, <tt>'A'..'Z'</tt>,
# and <tt>'0'..'9'</tt>.
#
# Example:
#
# Bundler::URI.encode_www_form_component('*.-_azAZ09')
# # => "*.-_azAZ09"
#
# - Converts:
#
# - Character <tt>' '</tt> to character <tt>'+'</tt>.
# - Any other character to "percent notation";
# the percent notation for character <i>c</i> is <tt>'%%%X' % c.ord</tt>.
#
# Example:
#
# Bundler::URI.encode_www_form_component('Here are some punctuation characters: ,;?:')
# # => "Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A"
#
# Encoding:
#
# - If +str+ has encoding Encoding::ASCII_8BIT, argument +enc+ is ignored.
# - Otherwise +str+ is converted first to Encoding::UTF_8
# (with suitable character replacements),
# and then to encoding +enc+.
#
# In either case, the returned string has forced encoding Encoding::US_ASCII.
#
# Related: Bundler::URI.encode_uri_component (encodes <tt>' '</tt> as <tt>'%20'</tt>).
def self.encode_www_form_component(str, enc=nil)
_encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCWWWCOMP_, str, enc)
end
# Returns a string decoded from the given \URL-encoded string +str+.
#
# The given string is first encoded as Encoding::ASCII-8BIT (using String#b),
# then decoded (as below), and finally force-encoded to the given encoding +enc+.
#
# The returned string:
#
# - Preserves:
#
# - Characters <tt>'*'</tt>, <tt>'.'</tt>, <tt>'-'</tt>, and <tt>'_'</tt>.
# - Character in ranges <tt>'a'..'z'</tt>, <tt>'A'..'Z'</tt>,
# and <tt>'0'..'9'</tt>.
#
# Example:
#
# Bundler::URI.decode_www_form_component('*.-_azAZ09')
# # => "*.-_azAZ09"
#
# - Converts:
#
# - Character <tt>'+'</tt> to character <tt>' '</tt>.
# - Each "percent notation" to an ASCII character.
#
# Example:
#
# Bundler::URI.decode_www_form_component('Here+are+some+punctuation+characters%3A+%2C%3B%3F%3A')
# # => "Here are some punctuation characters: ,;?:"
#
# Related: Bundler::URI.decode_uri_component (preserves <tt>'+'</tt>).
def self.decode_www_form_component(str, enc=Encoding::UTF_8)
_decode_uri_component(/\+|%\h\h/, str, enc)
end
# Like Bundler::URI.encode_www_form_component, except that <tt>' '</tt> (space)
# is encoded as <tt>'%20'</tt> (instead of <tt>'+'</tt>).
def self.encode_uri_component(str, enc=nil)
_encode_uri_component(/[^*\-.0-9A-Z_a-z]/, TBLENCURICOMP_, str, enc)
end
# Like Bundler::URI.decode_www_form_component, except that <tt>'+'</tt> is preserved.
def self.decode_uri_component(str, enc=Encoding::UTF_8)
_decode_uri_component(/%\h\h/, str, enc)
end
def self._encode_uri_component(regexp, table, str, enc)
str = str.to_s.dup
if str.encoding != Encoding::ASCII_8BIT
if enc && enc != Encoding::ASCII_8BIT
str.encode!(Encoding::UTF_8, invalid: :replace, undef: :replace)
str.encode!(enc, fallback: ->(x){"&##{x.ord};"})
end
str.force_encoding(Encoding::ASCII_8BIT)
end
str.gsub!(regexp, table)
str.force_encoding(Encoding::US_ASCII)
end
private_class_method :_encode_uri_component
def self._decode_uri_component(regexp, str, enc)
raise ArgumentError, "invalid %-encoding (#{str})" if /%(?!\h\h)/.match?(str)
str.b.gsub(regexp, TBLDECWWWCOMP_).force_encoding(enc)
end
private_class_method :_decode_uri_component
# Returns a URL-encoded string derived from the given
# {Enumerable}[rdoc-ref:Enumerable@Enumerable+in+Ruby+Classes]
# +enum+.
#
# The result is suitable for use as form data
# for an \HTTP request whose <tt>Content-Type</tt> is
# <tt>'application/x-www-form-urlencoded'</tt>.
#
# The returned string consists of the elements of +enum+,
# each converted to one or more URL-encoded strings,
# and all joined with character <tt>'&'</tt>.
#
# Simple examples:
#
# Bundler::URI.encode_www_form([['foo', 0], ['bar', 1], ['baz', 2]])
# # => "foo=0&bar=1&baz=2"
# Bundler::URI.encode_www_form({foo: 0, bar: 1, baz: 2})
# # => "foo=0&bar=1&baz=2"
#
# The returned string is formed using method Bundler::URI.encode_www_form_component,
# which converts certain characters:
#
# Bundler::URI.encode_www_form('f#o': '/', 'b-r': '$', 'b z': '@')
# # => "f%23o=%2F&b-r=%24&b+z=%40"
#
# When +enum+ is Array-like, each element +ele+ is converted to a field:
#
# - If +ele+ is an array of two or more elements,
# the field is formed from its first two elements
# (and any additional elements are ignored):
#
# name = Bundler::URI.encode_www_form_component(ele[0], enc)
# value = Bundler::URI.encode_www_form_component(ele[1], enc)
# "#{name}=#{value}"
#
# Examples:
#
# Bundler::URI.encode_www_form([%w[foo bar], %w[baz bat bah]])
# # => "foo=bar&baz=bat"
# Bundler::URI.encode_www_form([['foo', 0], ['bar', :baz, 'bat']])
# # => "foo=0&bar=baz"
#
# - If +ele+ is an array of one element,
# the field is formed from <tt>ele[0]</tt>:
#
# Bundler::URI.encode_www_form_component(ele[0])
#
# Example:
#
# Bundler::URI.encode_www_form([['foo'], [:bar], [0]])
# # => "foo&bar&0"
#
# - Otherwise the field is formed from +ele+:
#
# Bundler::URI.encode_www_form_component(ele)
#
# Example:
#
# Bundler::URI.encode_www_form(['foo', :bar, 0])
# # => "foo&bar&0"
#
# The elements of an Array-like +enum+ may be mixture:
#
# Bundler::URI.encode_www_form([['foo', 0], ['bar', 1, 2], ['baz'], :bat])
# # => "foo=0&bar=1&baz&bat"
#
# When +enum+ is Hash-like,
# each +key+/+value+ pair is converted to one or more fields:
#
# - If +value+ is
# {Array-convertible}[rdoc-ref:implicit_conversion.rdoc@Array-Convertible+Objects],
# each element +ele+ in +value+ is paired with +key+ to form a field:
#
# name = Bundler::URI.encode_www_form_component(key, enc)
# value = Bundler::URI.encode_www_form_component(ele, enc)
# "#{name}=#{value}"
#
# Example:
#
# Bundler::URI.encode_www_form({foo: [:bar, 1], baz: [:bat, :bam, 2]})
# # => "foo=bar&foo=1&baz=bat&baz=bam&baz=2"
#
# - Otherwise, +key+ and +value+ are paired to form a field:
#
# name = Bundler::URI.encode_www_form_component(key, enc)
# value = Bundler::URI.encode_www_form_component(value, enc)
# "#{name}=#{value}"
#
# Example:
#
# Bundler::URI.encode_www_form({foo: 0, bar: 1, baz: 2})
# # => "foo=0&bar=1&baz=2"
#
# The elements of a Hash-like +enum+ may be mixture:
#
# Bundler::URI.encode_www_form({foo: [0, 1], bar: 2})
# # => "foo=0&foo=1&bar=2"
#
def self.encode_www_form(enum, enc=nil)
enum.map do |k,v|
if v.nil?
encode_www_form_component(k, enc)
elsif v.respond_to?(:to_ary)
v.to_ary.map do |w|
str = encode_www_form_component(k, enc)
unless w.nil?
str << '='
str << encode_www_form_component(w, enc)
end
end.join('&')
else
str = encode_www_form_component(k, enc)
str << '='
str << encode_www_form_component(v, enc)
end
end.join('&')
end
# Returns name/value pairs derived from the given string +str+,
# which must be an ASCII string.
#
# The method may be used to decode the body of Net::HTTPResponse object +res+
# for which <tt>res['Content-Type']</tt> is <tt>'application/x-www-form-urlencoded'</tt>.
#
# The returned data is an array of 2-element subarrays;
# each subarray is a name/value pair (both are strings).
# Each returned string has encoding +enc+,
# and has had invalid characters removed via
# {String#scrub}[rdoc-ref:String#scrub].
#
# A simple example:
#
# Bundler::URI.decode_www_form('foo=0&bar=1&baz')
# # => [["foo", "0"], ["bar", "1"], ["baz", ""]]
#
# The returned strings have certain conversions,
# similar to those performed in Bundler::URI.decode_www_form_component:
#
# Bundler::URI.decode_www_form('f%23o=%2F&b-r=%24&b+z=%40')
# # => [["f#o", "/"], ["b-r", "$"], ["b z", "@"]]
#
# The given string may contain consecutive separators:
#
# Bundler::URI.decode_www_form('foo=0&&bar=1&&baz=2')
# # => [["foo", "0"], ["", ""], ["bar", "1"], ["", ""], ["baz", "2"]]
#
# A different separator may be specified:
#
# Bundler::URI.decode_www_form('foo=0--bar=1--baz', separator: '--')
# # => [["foo", "0"], ["bar", "1"], ["baz", ""]]
#
def self.decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false)
raise ArgumentError, "the input of #{self.name}.#{__method__} must be ASCII only string" unless str.ascii_only?
ary = []
return ary if str.empty?
enc = Encoding.find(enc)
str.b.each_line(separator) do |string|
string.chomp!(separator)
key, sep, val = string.partition('=')
if isindex
if sep.empty?
val = key
key = +''
end
isindex = false
end
if use__charset_ and key == '_charset_' and e = get_encoding(val)
enc = e
use__charset_ = false
end
key.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_)
if val
val.gsub!(/\+|%\h\h/, TBLDECWWWCOMP_)
else
val = +''
end
ary << [key, val]
end
ary.each do |k, v|
k.force_encoding(enc)
k.scrub!
v.force_encoding(enc)
v.scrub!
end
ary
end
private
=begin command for WEB_ENCODINGS_
curl https://encoding.spec.whatwg.org/encodings.json|
ruby -rjson -e 'H={}
h={
"shift_jis"=>"Windows-31J",
"euc-jp"=>"cp51932",
"iso-2022-jp"=>"cp50221",
"x-mac-cyrillic"=>"macCyrillic",
}
JSON($<.read).map{|x|x["encodings"]}.flatten.each{|x|
Encoding.find(n=h.fetch(n=x["name"].downcase,n))rescue next
x["labels"].each{|y|H[y]=n}
}
puts "{"
H.each{|k,v|puts %[ #{k.dump}=>#{v.dump},]}
puts "}"
'
=end
WEB_ENCODINGS_ = {
"unicode-1-1-utf-8"=>"utf-8",
"utf-8"=>"utf-8",
"utf8"=>"utf-8",
"866"=>"ibm866",
"cp866"=>"ibm866",
"csibm866"=>"ibm866",
"ibm866"=>"ibm866",
"csisolatin2"=>"iso-8859-2",
"iso-8859-2"=>"iso-8859-2",
"iso-ir-101"=>"iso-8859-2",
"iso8859-2"=>"iso-8859-2",
"iso88592"=>"iso-8859-2",
"iso_8859-2"=>"iso-8859-2",
"iso_8859-2:1987"=>"iso-8859-2",
"l2"=>"iso-8859-2",
"latin2"=>"iso-8859-2",
"csisolatin3"=>"iso-8859-3",
"iso-8859-3"=>"iso-8859-3",
"iso-ir-109"=>"iso-8859-3",
"iso8859-3"=>"iso-8859-3",
"iso88593"=>"iso-8859-3",
"iso_8859-3"=>"iso-8859-3",
"iso_8859-3:1988"=>"iso-8859-3",
"l3"=>"iso-8859-3",
"latin3"=>"iso-8859-3",
"csisolatin4"=>"iso-8859-4",
"iso-8859-4"=>"iso-8859-4",
"iso-ir-110"=>"iso-8859-4",
"iso8859-4"=>"iso-8859-4",
"iso88594"=>"iso-8859-4",
"iso_8859-4"=>"iso-8859-4",
"iso_8859-4:1988"=>"iso-8859-4",
"l4"=>"iso-8859-4",
"latin4"=>"iso-8859-4",
"csisolatincyrillic"=>"iso-8859-5",
"cyrillic"=>"iso-8859-5",
"iso-8859-5"=>"iso-8859-5",
"iso-ir-144"=>"iso-8859-5",
"iso8859-5"=>"iso-8859-5",
"iso88595"=>"iso-8859-5",
"iso_8859-5"=>"iso-8859-5",
"iso_8859-5:1988"=>"iso-8859-5",
"arabic"=>"iso-8859-6",
"asmo-708"=>"iso-8859-6",
"csiso88596e"=>"iso-8859-6",
"csiso88596i"=>"iso-8859-6",
"csisolatinarabic"=>"iso-8859-6",
"ecma-114"=>"iso-8859-6",
"iso-8859-6"=>"iso-8859-6",
"iso-8859-6-e"=>"iso-8859-6",
"iso-8859-6-i"=>"iso-8859-6",
"iso-ir-127"=>"iso-8859-6",
"iso8859-6"=>"iso-8859-6",
"iso88596"=>"iso-8859-6",
"iso_8859-6"=>"iso-8859-6",
"iso_8859-6:1987"=>"iso-8859-6",
"csisolatingreek"=>"iso-8859-7",
"ecma-118"=>"iso-8859-7",
"elot_928"=>"iso-8859-7",
"greek"=>"iso-8859-7",
"greek8"=>"iso-8859-7",
"iso-8859-7"=>"iso-8859-7",
"iso-ir-126"=>"iso-8859-7",
"iso8859-7"=>"iso-8859-7",
"iso88597"=>"iso-8859-7",
"iso_8859-7"=>"iso-8859-7",
"iso_8859-7:1987"=>"iso-8859-7",
"sun_eu_greek"=>"iso-8859-7",
"csiso88598e"=>"iso-8859-8",
"csisolatinhebrew"=>"iso-8859-8",
"hebrew"=>"iso-8859-8",
"iso-8859-8"=>"iso-8859-8",
"iso-8859-8-e"=>"iso-8859-8",
"iso-ir-138"=>"iso-8859-8",
"iso8859-8"=>"iso-8859-8",
"iso88598"=>"iso-8859-8",
"iso_8859-8"=>"iso-8859-8",
"iso_8859-8:1988"=>"iso-8859-8",
"visual"=>"iso-8859-8",
"csisolatin6"=>"iso-8859-10",
"iso-8859-10"=>"iso-8859-10",
"iso-ir-157"=>"iso-8859-10",
"iso8859-10"=>"iso-8859-10",
"iso885910"=>"iso-8859-10",
"l6"=>"iso-8859-10",
"latin6"=>"iso-8859-10",
"iso-8859-13"=>"iso-8859-13",
"iso8859-13"=>"iso-8859-13",
"iso885913"=>"iso-8859-13",
"iso-8859-14"=>"iso-8859-14",
"iso8859-14"=>"iso-8859-14",
"iso885914"=>"iso-8859-14",
"csisolatin9"=>"iso-8859-15",
"iso-8859-15"=>"iso-8859-15",
"iso8859-15"=>"iso-8859-15",
"iso885915"=>"iso-8859-15",
"iso_8859-15"=>"iso-8859-15",
"l9"=>"iso-8859-15",
"iso-8859-16"=>"iso-8859-16",
"cskoi8r"=>"koi8-r",
"koi"=>"koi8-r",
"koi8"=>"koi8-r",
"koi8-r"=>"koi8-r",
"koi8_r"=>"koi8-r",
"koi8-ru"=>"koi8-u",
"koi8-u"=>"koi8-u",
"dos-874"=>"windows-874",
"iso-8859-11"=>"windows-874",
"iso8859-11"=>"windows-874",
"iso885911"=>"windows-874",
"tis-620"=>"windows-874",
"windows-874"=>"windows-874",
"cp1250"=>"windows-1250",
"windows-1250"=>"windows-1250",
"x-cp1250"=>"windows-1250",
"cp1251"=>"windows-1251",
"windows-1251"=>"windows-1251",
"x-cp1251"=>"windows-1251",
"ansi_x3.4-1968"=>"windows-1252",
"ascii"=>"windows-1252",
"cp1252"=>"windows-1252",
"cp819"=>"windows-1252",
"csisolatin1"=>"windows-1252",
"ibm819"=>"windows-1252",
"iso-8859-1"=>"windows-1252",
"iso-ir-100"=>"windows-1252",
"iso8859-1"=>"windows-1252",
"iso88591"=>"windows-1252",
"iso_8859-1"=>"windows-1252",
"iso_8859-1:1987"=>"windows-1252",
"l1"=>"windows-1252",
"latin1"=>"windows-1252",
"us-ascii"=>"windows-1252",
"windows-1252"=>"windows-1252",
"x-cp1252"=>"windows-1252",
"cp1253"=>"windows-1253",
"windows-1253"=>"windows-1253",
"x-cp1253"=>"windows-1253",
"cp1254"=>"windows-1254",
"csisolatin5"=>"windows-1254",
"iso-8859-9"=>"windows-1254",
"iso-ir-148"=>"windows-1254",
"iso8859-9"=>"windows-1254",
"iso88599"=>"windows-1254",
"iso_8859-9"=>"windows-1254",
"iso_8859-9:1989"=>"windows-1254",
"l5"=>"windows-1254",
"latin5"=>"windows-1254",
"windows-1254"=>"windows-1254",
"x-cp1254"=>"windows-1254",
"cp1255"=>"windows-1255",
"windows-1255"=>"windows-1255",
"x-cp1255"=>"windows-1255",
"cp1256"=>"windows-1256",
"windows-1256"=>"windows-1256",
"x-cp1256"=>"windows-1256",
"cp1257"=>"windows-1257",
"windows-1257"=>"windows-1257",
"x-cp1257"=>"windows-1257",
"cp1258"=>"windows-1258",
"windows-1258"=>"windows-1258",
"x-cp1258"=>"windows-1258",
"x-mac-cyrillic"=>"macCyrillic",
"x-mac-ukrainian"=>"macCyrillic",
"chinese"=>"gbk",
"csgb2312"=>"gbk",
"csiso58gb231280"=>"gbk",
"gb2312"=>"gbk",
"gb_2312"=>"gbk",
"gb_2312-80"=>"gbk",
"gbk"=>"gbk",
"iso-ir-58"=>"gbk",
"x-gbk"=>"gbk",
"gb18030"=>"gb18030",
"big5"=>"big5",
"big5-hkscs"=>"big5",
"cn-big5"=>"big5",
"csbig5"=>"big5",
"x-x-big5"=>"big5",
"cseucpkdfmtjapanese"=>"cp51932",
"euc-jp"=>"cp51932",
"x-euc-jp"=>"cp51932",
"csiso2022jp"=>"cp50221",
"iso-2022-jp"=>"cp50221",
"csshiftjis"=>"Windows-31J",
"ms932"=>"Windows-31J",
"ms_kanji"=>"Windows-31J",
"shift-jis"=>"Windows-31J",
"shift_jis"=>"Windows-31J",
"sjis"=>"Windows-31J",
"windows-31j"=>"Windows-31J",
"x-sjis"=>"Windows-31J",
"cseuckr"=>"euc-kr",
"csksc56011987"=>"euc-kr",
"euc-kr"=>"euc-kr",
"iso-ir-149"=>"euc-kr",
"korean"=>"euc-kr",
"ks_c_5601-1987"=>"euc-kr",
"ks_c_5601-1989"=>"euc-kr",
"ksc5601"=>"euc-kr",
"ksc_5601"=>"euc-kr",
"windows-949"=>"euc-kr",
"utf-16be"=>"utf-16be",
"utf-16"=>"utf-16le",
"utf-16le"=>"utf-16le",
} # :nodoc:
Ractor.make_shareable(WEB_ENCODINGS_) if defined?(Ractor)
# :nodoc:
# return encoding or nil
# http://encoding.spec.whatwg.org/#concept-encoding-get
def self.get_encoding(label)
Encoding.find(WEB_ENCODINGS_[label.to_str.strip.downcase]) rescue nil
end
end # module Bundler::URI
module Bundler
#
# Returns a \Bundler::URI object derived from the given +uri+,
# which may be a \Bundler::URI string or an existing \Bundler::URI object:
#
# # Returns a new Bundler::URI.
# uri = Bundler::URI('http://github.com/ruby/ruby')
# # => #<Bundler::URI::HTTP http://github.com/ruby/ruby>
# # Returns the given Bundler::URI.
# Bundler::URI(uri)
# # => #<Bundler::URI::HTTP http://github.com/ruby/ruby>
#
def URI(uri)
if uri.is_a?(Bundler::URI::Generic)
uri
elsif uri = String.try_convert(uri)
Bundler::URI.parse(uri)
else
raise ArgumentError,
"bad argument (expected Bundler::URI object or Bundler::URI string)"
end
end
module_function :URI
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/version.rb 0000644 00000000237 15173517745 0021610 0 ustar 00 module Bundler::URI
# :stopdoc:
VERSION_CODE = '001301'.freeze
VERSION = VERSION_CODE.scan(/../).collect{|n| n.to_i}.join('.').freeze
# :startdoc:
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/ldap.rb 0000644 00000013646 15173517745 0021053 0 ustar 00 # frozen_string_literal: false
# = uri/ldap.rb
#
# Author::
# Takaaki Tateishi <ttate@jaist.ac.jp>
# Akira Yamada <akira@ruby-lang.org>
# License::
# Bundler::URI::LDAP is copyrighted free software by Takaaki Tateishi and Akira Yamada.
# You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'generic'
module Bundler::URI
#
# LDAP Bundler::URI SCHEMA (described in RFC2255).
#--
# ldap://<host>/<dn>[?<attrs>[?<scope>[?<filter>[?<extensions>]]]]
#++
class LDAP < Generic
# A Default port of 389 for Bundler::URI::LDAP.
DEFAULT_PORT = 389
# An Array of the available components for Bundler::URI::LDAP.
COMPONENT = [
:scheme,
:host, :port,
:dn,
:attributes,
:scope,
:filter,
:extensions,
].freeze
# Scopes available for the starting point.
#
# * SCOPE_BASE - the Base DN
# * SCOPE_ONE - one level under the Base DN, not including the base DN and
# not including any entries under this
# * SCOPE_SUB - subtrees, all entries at all levels
#
SCOPE = [
SCOPE_ONE = 'one',
SCOPE_SUB = 'sub',
SCOPE_BASE = 'base',
].freeze
#
# == Description
#
# Creates a new Bundler::URI::LDAP object from components, with syntax checking.
#
# The components accepted are host, port, dn, attributes,
# scope, filter, and extensions.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[host, port, dn, attributes, scope, filter, extensions]</code>.
#
# Example:
#
# uri = Bundler::URI::LDAP.build({:host => 'ldap.example.com',
# :dn => '/dc=example'})
#
# uri = Bundler::URI::LDAP.build(["ldap.example.com", nil,
# "/dc=example;dc=com", "query", nil, nil, nil])
#
def self.build(args)
tmp = Util::make_components_hash(self, args)
if tmp[:dn]
tmp[:path] = tmp[:dn]
end
query = []
[:extensions, :filter, :scope, :attributes].collect do |x|
next if !tmp[x] && query.size == 0
query.unshift(tmp[x])
end
tmp[:query] = query.join('?')
return super(tmp)
end
#
# == Description
#
# Creates a new Bundler::URI::LDAP object from generic Bundler::URI components as per
# RFC 2396. No LDAP-specific syntax checking is performed.
#
# Arguments are +scheme+, +userinfo+, +host+, +port+, +registry+, +path+,
# +opaque+, +query+, and +fragment+, in that order.
#
# Example:
#
# uri = Bundler::URI::LDAP.new("ldap", nil, "ldap.example.com", nil, nil,
# "/dc=example;dc=com", nil, "query", nil)
#
# See also Bundler::URI::Generic.new.
#
def initialize(*arg)
super(*arg)
if @fragment
raise InvalidURIError, 'bad LDAP URL'
end
parse_dn
parse_query
end
# Private method to cleanup +dn+ from using the +path+ component attribute.
def parse_dn
raise InvalidURIError, 'bad LDAP URL' unless @path
@dn = @path[1..-1]
end
private :parse_dn
# Private method to cleanup +attributes+, +scope+, +filter+, and +extensions+
# from using the +query+ component attribute.
def parse_query
@attributes = nil
@scope = nil
@filter = nil
@extensions = nil
if @query
attrs, scope, filter, extensions = @query.split('?')
@attributes = attrs if attrs && attrs.size > 0
@scope = scope if scope && scope.size > 0
@filter = filter if filter && filter.size > 0
@extensions = extensions if extensions && extensions.size > 0
end
end
private :parse_query
# Private method to assemble +query+ from +attributes+, +scope+, +filter+, and +extensions+.
def build_path_query
@path = '/' + @dn
query = []
[@extensions, @filter, @scope, @attributes].each do |x|
next if !x && query.size == 0
query.unshift(x)
end
@query = query.join('?')
end
private :build_path_query
# Returns dn.
def dn
@dn
end
# Private setter for dn +val+.
def set_dn(val)
@dn = val
build_path_query
@dn
end
protected :set_dn
# Setter for dn +val+.
def dn=(val)
set_dn(val)
val
end
# Returns attributes.
def attributes
@attributes
end
# Private setter for attributes +val+.
def set_attributes(val)
@attributes = val
build_path_query
@attributes
end
protected :set_attributes
# Setter for attributes +val+.
def attributes=(val)
set_attributes(val)
val
end
# Returns scope.
def scope
@scope
end
# Private setter for scope +val+.
def set_scope(val)
@scope = val
build_path_query
@scope
end
protected :set_scope
# Setter for scope +val+.
def scope=(val)
set_scope(val)
val
end
# Returns filter.
def filter
@filter
end
# Private setter for filter +val+.
def set_filter(val)
@filter = val
build_path_query
@filter
end
protected :set_filter
# Setter for filter +val+.
def filter=(val)
set_filter(val)
val
end
# Returns extensions.
def extensions
@extensions
end
# Private setter for extensions +val+.
def set_extensions(val)
@extensions = val
build_path_query
@extensions
end
protected :set_extensions
# Setter for extensions +val+.
def extensions=(val)
set_extensions(val)
val
end
# Checks if Bundler::URI has a path.
# For Bundler::URI::LDAP this will return +false+.
def hierarchical?
false
end
end
register_scheme 'LDAP', LDAP
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/ws.rb 0000644 00000004563 15173517745 0020562 0 ustar 00 # frozen_string_literal: false
# = uri/ws.rb
#
# Author:: Matt Muller <mamuller@amazon.com>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'generic'
module Bundler::URI
#
# The syntax of WS URIs is defined in RFC6455 section 3.
#
# Note that the Ruby Bundler::URI library allows WS URLs containing usernames and
# passwords. This is not legal as per the RFC, but used to be
# supported in Internet Explorer 5 and 6, before the MS04-004 security
# update. See <URL:http://support.microsoft.com/kb/834489>.
#
class WS < Generic
# A Default port of 80 for Bundler::URI::WS.
DEFAULT_PORT = 80
# An Array of the available components for Bundler::URI::WS.
COMPONENT = %i[
scheme
userinfo host port
path
query
].freeze
#
# == Description
#
# Creates a new Bundler::URI::WS object from components, with syntax checking.
#
# The components accepted are userinfo, host, port, path, and query.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[userinfo, host, port, path, query]</code>.
#
# Example:
#
# uri = Bundler::URI::WS.build(host: 'www.example.com', path: '/foo/bar')
#
# uri = Bundler::URI::WS.build([nil, "www.example.com", nil, "/path", "query"])
#
# Currently, if passed userinfo components this method generates
# invalid WS URIs as per RFC 1738.
#
def self.build(args)
tmp = Util.make_components_hash(self, args)
super(tmp)
end
#
# == Description
#
# Returns the full path for a WS Bundler::URI, as required by Net::HTTP::Get.
#
# If the Bundler::URI contains a query, the full path is Bundler::URI#path + '?' + Bundler::URI#query.
# Otherwise, the path is simply Bundler::URI#path.
#
# Example:
#
# uri = Bundler::URI::WS.build(path: '/foo/bar', query: 'test=true')
# uri.request_uri # => "/foo/bar?test=true"
#
def request_uri
return unless @path
url = @query ? "#@path?#@query" : @path.dup
url.start_with?(?/.freeze) ? url : ?/ + url
end
end
register_scheme 'WS', WS
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/ldaps.rb 0000644 00000001043 15173517745 0021222 0 ustar 00 # frozen_string_literal: false
# = uri/ldap.rb
#
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'ldap'
module Bundler::URI
# The default port for LDAPS URIs is 636, and the scheme is 'ldaps:' rather
# than 'ldap:'. Other than that, LDAPS URIs are identical to LDAP URIs;
# see Bundler::URI::LDAP.
class LDAPS < LDAP
# A Default port of 636 for Bundler::URI::LDAPS
DEFAULT_PORT = 636
end
register_scheme 'LDAPS', LDAPS
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/mailto.rb 0000644 00000020052 15173517745 0021405 0 ustar 00 # frozen_string_literal: false
# = uri/mailto.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'generic'
module Bundler::URI
#
# RFC6068, the mailto URL scheme.
#
class MailTo < Generic
include RFC2396_REGEXP
# A Default port of nil for Bundler::URI::MailTo.
DEFAULT_PORT = nil
# An Array of the available components for Bundler::URI::MailTo.
COMPONENT = [ :scheme, :to, :headers ].freeze
# :stopdoc:
# "hname" and "hvalue" are encodings of an RFC 822 header name and
# value, respectively. As with "to", all URL reserved characters must
# be encoded.
#
# "#mailbox" is as specified in RFC 822 [RFC822]. This means that it
# consists of zero or more comma-separated mail addresses, possibly
# including "phrase" and "comment" components. Note that all URL
# reserved characters in "to" must be encoded: in particular,
# parentheses, commas, and the percent sign ("%"), which commonly occur
# in the "mailbox" syntax.
#
# Within mailto URLs, the characters "?", "=", "&" are reserved.
# ; RFC 6068
# hfields = "?" hfield *( "&" hfield )
# hfield = hfname "=" hfvalue
# hfname = *qchar
# hfvalue = *qchar
# qchar = unreserved / pct-encoded / some-delims
# some-delims = "!" / "$" / "'" / "(" / ")" / "*"
# / "+" / "," / ";" / ":" / "@"
#
# ; RFC3986
# unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
# pct-encoded = "%" HEXDIG HEXDIG
HEADER_REGEXP = /\A(?<hfield>(?:%\h\h|[!$'-.0-;@-Z_a-z~])*=(?:%\h\h|[!$'-.0-;@-Z_a-z~])*)(?:&\g<hfield>)*\z/
# practical regexp for email address
# https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address
EMAIL_REGEXP = /\A[a-zA-Z0-9.!\#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/
# :startdoc:
#
# == Description
#
# Creates a new Bundler::URI::MailTo object from components, with syntax checking.
#
# Components can be provided as an Array or Hash. If an Array is used,
# the components must be supplied as <code>[to, headers]</code>.
#
# If a Hash is used, the keys are the component names preceded by colons.
#
# The headers can be supplied as a pre-encoded string, such as
# <code>"subject=subscribe&cc=address"</code>, or as an Array of Arrays
# like <code>[['subject', 'subscribe'], ['cc', 'address']]</code>.
#
# Examples:
#
# require 'bundler/vendor/uri/lib/uri'
#
# m1 = Bundler::URI::MailTo.build(['joe@example.com', 'subject=Ruby'])
# m1.to_s # => "mailto:joe@example.com?subject=Ruby"
#
# m2 = Bundler::URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]])
# m2.to_s # => "mailto:john@example.com?Subject=Ruby&Cc=jack@example.com"
#
# m3 = Bundler::URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]})
# m3.to_s # => "mailto:listman@example.com?subject=subscribe"
#
def self.build(args)
tmp = Util.make_components_hash(self, args)
case tmp[:to]
when Array
tmp[:opaque] = tmp[:to].join(',')
when String
tmp[:opaque] = tmp[:to].dup
else
tmp[:opaque] = ''
end
if tmp[:headers]
query =
case tmp[:headers]
when Array
tmp[:headers].collect { |x|
if x.kind_of?(Array)
x[0] + '=' + x[1..-1].join
else
x.to_s
end
}.join('&')
when Hash
tmp[:headers].collect { |h,v|
h + '=' + v
}.join('&')
else
tmp[:headers].to_s
end
unless query.empty?
tmp[:opaque] << '?' << query
end
end
super(tmp)
end
#
# == Description
#
# Creates a new Bundler::URI::MailTo object from generic URL components with
# no syntax checking.
#
# This method is usually called from Bundler::URI::parse, which checks
# the validity of each component.
#
def initialize(*arg)
super(*arg)
@to = nil
@headers = []
# The RFC3986 parser does not normally populate opaque
@opaque = "?#{@query}" if @query && !@opaque
unless @opaque
raise InvalidComponentError,
"missing opaque part for mailto URL"
end
to, header = @opaque.split('?', 2)
# allow semicolon as a addr-spec separator
# http://support.microsoft.com/kb/820868
unless /\A(?:[^@,;]+@[^@,;]+(?:\z|[,;]))*\z/ =~ to
raise InvalidComponentError,
"unrecognised opaque part for mailtoURL: #{@opaque}"
end
if arg[10] # arg_check
self.to = to
self.headers = header
else
set_to(to)
set_headers(header)
end
end
# The primary e-mail address of the URL, as a String.
attr_reader :to
# E-mail headers set by the URL, as an Array of Arrays.
attr_reader :headers
# Checks the to +v+ component.
def check_to(v)
return true unless v
return true if v.size == 0
v.split(/[,;]/).each do |addr|
# check url safety as path-rootless
if /\A(?:%\h\h|[!$&-.0-;=@-Z_a-z~])*\z/ !~ addr
raise InvalidComponentError,
"an address in 'to' is invalid as Bundler::URI #{addr.dump}"
end
# check addr-spec
# don't s/\+/ /g
addr.gsub!(/%\h\h/, Bundler::URI::TBLDECWWWCOMP_)
if EMAIL_REGEXP !~ addr
raise InvalidComponentError,
"an address in 'to' is invalid as uri-escaped addr-spec #{addr.dump}"
end
end
true
end
private :check_to
# Private setter for to +v+.
def set_to(v)
@to = v
end
protected :set_to
# Setter for to +v+.
def to=(v)
check_to(v)
set_to(v)
v
end
# Checks the headers +v+ component against either
# * HEADER_REGEXP
def check_headers(v)
return true unless v
return true if v.size == 0
if HEADER_REGEXP !~ v
raise InvalidComponentError,
"bad component(expected opaque component): #{v}"
end
true
end
private :check_headers
# Private setter for headers +v+.
def set_headers(v)
@headers = []
if v
v.split('&').each do |x|
@headers << x.split(/=/, 2)
end
end
end
protected :set_headers
# Setter for headers +v+.
def headers=(v)
check_headers(v)
set_headers(v)
v
end
# Constructs String from Bundler::URI.
def to_s
@scheme + ':' +
if @to
@to
else
''
end +
if @headers.size > 0
'?' + @headers.collect{|x| x.join('=')}.join('&')
else
''
end +
if @fragment
'#' + @fragment
else
''
end
end
# Returns the RFC822 e-mail text equivalent of the URL, as a String.
#
# Example:
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri = Bundler::URI.parse("mailto:ruby-list@ruby-lang.org?Subject=subscribe&cc=myaddr")
# uri.to_mailtext
# # => "To: ruby-list@ruby-lang.org\nSubject: subscribe\nCc: myaddr\n\n\n"
#
def to_mailtext
to = Bundler::URI.decode_www_form_component(@to)
head = ''
body = ''
@headers.each do |x|
case x[0]
when 'body'
body = Bundler::URI.decode_www_form_component(x[1])
when 'to'
to << ', ' + Bundler::URI.decode_www_form_component(x[1])
else
head << Bundler::URI.decode_www_form_component(x[0]).capitalize + ': ' +
Bundler::URI.decode_www_form_component(x[1]) + "\n"
end
end
"To: #{to}
#{head}
#{body}
"
end
alias to_rfc822text to_mailtext
end
register_scheme 'MAILTO', MailTo
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/file.rb 0000644 00000004637 15173517745 0021052 0 ustar 00 # frozen_string_literal: true
require_relative 'generic'
module Bundler::URI
#
# The "file" Bundler::URI is defined by RFC8089.
#
class File < Generic
# A Default port of nil for Bundler::URI::File.
DEFAULT_PORT = nil
#
# An Array of the available components for Bundler::URI::File.
#
COMPONENT = [
:scheme,
:host,
:path
].freeze
#
# == Description
#
# Creates a new Bundler::URI::File object from components, with syntax checking.
#
# The components accepted are +host+ and +path+.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[host, path]</code>.
#
# A path from e.g. the File class should be escaped before
# being passed.
#
# Examples:
#
# require 'bundler/vendor/uri/lib/uri'
#
# uri1 = Bundler::URI::File.build(['host.example.com', '/path/file.zip'])
# uri1.to_s # => "file://host.example.com/path/file.zip"
#
# uri2 = Bundler::URI::File.build({:host => 'host.example.com',
# :path => '/ruby/src'})
# uri2.to_s # => "file://host.example.com/ruby/src"
#
# uri3 = Bundler::URI::File.build({:path => Bundler::URI::escape('/path/my file.txt')})
# uri3.to_s # => "file:///path/my%20file.txt"
#
def self.build(args)
tmp = Util::make_components_hash(self, args)
super(tmp)
end
# Protected setter for the host component +v+.
#
# See also Bundler::URI::Generic.host=.
#
def set_host(v)
v = "" if v.nil? || v == "localhost"
@host = v
end
# do nothing
def set_port(v)
end
# raise InvalidURIError
def check_userinfo(user)
raise Bundler::URI::InvalidURIError, "can not set userinfo for file Bundler::URI"
end
# raise InvalidURIError
def check_user(user)
raise Bundler::URI::InvalidURIError, "can not set user for file Bundler::URI"
end
# raise InvalidURIError
def check_password(user)
raise Bundler::URI::InvalidURIError, "can not set password for file Bundler::URI"
end
# do nothing
def set_userinfo(v)
end
# do nothing
def set_user(v)
end
# do nothing
def set_password(v)
end
end
register_scheme 'FILE', File
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/uri/lib/uri/http.rb 0000644 00000007501 15173517745 0021103 0 ustar 00 # frozen_string_literal: false
# = uri/http.rb
#
# Author:: Akira Yamada <akira@ruby-lang.org>
# License:: You can redistribute it and/or modify it under the same term as Ruby.
#
# See Bundler::URI for general documentation
#
require_relative 'generic'
module Bundler::URI
#
# The syntax of HTTP URIs is defined in RFC1738 section 3.3.
#
# Note that the Ruby Bundler::URI library allows HTTP URLs containing usernames and
# passwords. This is not legal as per the RFC, but used to be
# supported in Internet Explorer 5 and 6, before the MS04-004 security
# update. See <URL:http://support.microsoft.com/kb/834489>.
#
class HTTP < Generic
# A Default port of 80 for Bundler::URI::HTTP.
DEFAULT_PORT = 80
# An Array of the available components for Bundler::URI::HTTP.
COMPONENT = %i[
scheme
userinfo host port
path
query
fragment
].freeze
#
# == Description
#
# Creates a new Bundler::URI::HTTP object from components, with syntax checking.
#
# The components accepted are userinfo, host, port, path, query, and
# fragment.
#
# The components should be provided either as an Array, or as a Hash
# with keys formed by preceding the component names with a colon.
#
# If an Array is used, the components must be passed in the
# order <code>[userinfo, host, port, path, query, fragment]</code>.
#
# Example:
#
# uri = Bundler::URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')
#
# uri = Bundler::URI::HTTP.build([nil, "www.example.com", nil, "/path",
# "query", 'fragment'])
#
# Currently, if passed userinfo components this method generates
# invalid HTTP URIs as per RFC 1738.
#
def self.build(args)
tmp = Util.make_components_hash(self, args)
super(tmp)
end
#
# == Description
#
# Returns the full path for an HTTP request, as required by Net::HTTP::Get.
#
# If the Bundler::URI contains a query, the full path is Bundler::URI#path + '?' + Bundler::URI#query.
# Otherwise, the path is simply Bundler::URI#path.
#
# Example:
#
# uri = Bundler::URI::HTTP.build(path: '/foo/bar', query: 'test=true')
# uri.request_uri # => "/foo/bar?test=true"
#
def request_uri
return unless @path
url = @query ? "#@path?#@query" : @path.dup
url.start_with?(?/.freeze) ? url : ?/ + url
end
#
# == Description
#
# Returns the authority for an HTTP uri, as defined in
# https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.
#
#
# Example:
#
# Bundler::URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').authority #=> "www.example.com"
# Bundler::URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').authority #=> "www.example.com:8000"
# Bundler::URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').authority #=> "www.example.com"
#
def authority
if port == default_port
host
else
"#{host}:#{port}"
end
end
#
# == Description
#
# Returns the origin for an HTTP uri, as defined in
# https://datatracker.ietf.org/doc/html/rfc6454.
#
#
# Example:
#
# Bundler::URI::HTTP.build(host: 'www.example.com', path: '/foo/bar').origin #=> "http://www.example.com"
# Bundler::URI::HTTP.build(host: 'www.example.com', port: 8000, path: '/foo/bar').origin #=> "http://www.example.com:8000"
# Bundler::URI::HTTP.build(host: 'www.example.com', port: 80, path: '/foo/bar').origin #=> "http://www.example.com"
# Bundler::URI::HTTPS.build(host: 'www.example.com', path: '/foo/bar').origin #=> "https://www.example.com"
#
def origin
"#{scheme}://#{authority}"
end
end
register_scheme 'HTTP', HTTP
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/tsort/lib/tsort.rb 0000644 00000035233 15173517745 0021057 0 ustar 00 # frozen_string_literal: true
#--
# tsort.rb - provides a module for topological sorting and strongly connected components.
#++
#
#
# Bundler::TSort implements topological sorting using Tarjan's algorithm for
# strongly connected components.
#
# Bundler::TSort is designed to be able to be used with any object which can be
# interpreted as a directed graph.
#
# Bundler::TSort requires two methods to interpret an object as a graph,
# tsort_each_node and tsort_each_child.
#
# * tsort_each_node is used to iterate for all nodes over a graph.
# * tsort_each_child is used to iterate for child nodes of a given node.
#
# The equality of nodes are defined by eql? and hash since
# Bundler::TSort uses Hash internally.
#
# == A Simple Example
#
# The following example demonstrates how to mix the Bundler::TSort module into an
# existing class (in this case, Hash). Here, we're treating each key in
# the hash as a node in the graph, and so we simply alias the required
# #tsort_each_node method to Hash's #each_key method. For each key in the
# hash, the associated value is an array of the node's child nodes. This
# choice in turn leads to our implementation of the required #tsort_each_child
# method, which fetches the array of child nodes and then iterates over that
# array using the user-supplied block.
#
# require 'bundler/vendor/tsort/lib/tsort'
#
# class Hash
# include Bundler::TSort
# alias tsort_each_node each_key
# def tsort_each_child(node, &block)
# fetch(node).each(&block)
# end
# end
#
# {1=>[2, 3], 2=>[3], 3=>[], 4=>[]}.tsort
# #=> [3, 2, 1, 4]
#
# {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}.strongly_connected_components
# #=> [[4], [2, 3], [1]]
#
# == A More Realistic Example
#
# A very simple `make' like tool can be implemented as follows:
#
# require 'bundler/vendor/tsort/lib/tsort'
#
# class Make
# def initialize
# @dep = {}
# @dep.default = []
# end
#
# def rule(outputs, inputs=[], &block)
# triple = [outputs, inputs, block]
# outputs.each {|f| @dep[f] = [triple]}
# @dep[triple] = inputs
# end
#
# def build(target)
# each_strongly_connected_component_from(target) {|ns|
# if ns.length != 1
# fs = ns.delete_if {|n| Array === n}
# raise Bundler::TSort::Cyclic.new("cyclic dependencies: #{fs.join ', '}")
# end
# n = ns.first
# if Array === n
# outputs, inputs, block = n
# inputs_time = inputs.map {|f| File.mtime f}.max
# begin
# outputs_time = outputs.map {|f| File.mtime f}.min
# rescue Errno::ENOENT
# outputs_time = nil
# end
# if outputs_time == nil ||
# inputs_time != nil && outputs_time <= inputs_time
# sleep 1 if inputs_time != nil && inputs_time.to_i == Time.now.to_i
# block.call
# end
# end
# }
# end
#
# def tsort_each_child(node, &block)
# @dep[node].each(&block)
# end
# include Bundler::TSort
# end
#
# def command(arg)
# print arg, "\n"
# system arg
# end
#
# m = Make.new
# m.rule(%w[t1]) { command 'date > t1' }
# m.rule(%w[t2]) { command 'date > t2' }
# m.rule(%w[t3]) { command 'date > t3' }
# m.rule(%w[t4], %w[t1 t3]) { command 'cat t1 t3 > t4' }
# m.rule(%w[t5], %w[t4 t2]) { command 'cat t4 t2 > t5' }
# m.build('t5')
#
# == Bugs
#
# * 'tsort.rb' is wrong name because this library uses
# Tarjan's algorithm for strongly connected components.
# Although 'strongly_connected_components.rb' is correct but too long.
#
# == References
#
# R. E. Tarjan, "Depth First Search and Linear Graph Algorithms",
# <em>SIAM Journal on Computing</em>, Vol. 1, No. 2, pp. 146-160, June 1972.
#
module Bundler::TSort
VERSION = "0.2.0"
class Cyclic < StandardError
end
# Returns a topologically sorted array of nodes.
# The array is sorted from children to parents, i.e.
# the first element has no child and the last node has no parent.
#
# If there is a cycle, Bundler::TSort::Cyclic is raised.
#
# class G
# include Bundler::TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# p graph.tsort #=> [4, 2, 3, 1]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# p graph.tsort # raises Bundler::TSort::Cyclic
#
def tsort
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
Bundler::TSort.tsort(each_node, each_child)
end
# Returns a topologically sorted array of nodes.
# The array is sorted from children to parents, i.e.
# the first element has no child and the last node has no parent.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# If there is a cycle, Bundler::TSort::Cyclic is raised.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p Bundler::TSort.tsort(each_node, each_child) #=> [4, 2, 3, 1]
#
# g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p Bundler::TSort.tsort(each_node, each_child) # raises Bundler::TSort::Cyclic
#
def self.tsort(each_node, each_child)
tsort_each(each_node, each_child).to_a
end
# The iterator version of the #tsort method.
# <tt><em>obj</em>.tsort_each</tt> is similar to <tt><em>obj</em>.tsort.each</tt>, but
# modification of _obj_ during the iteration may lead to unexpected results.
#
# #tsort_each returns +nil+.
# If there is a cycle, Bundler::TSort::Cyclic is raised.
#
# class G
# include Bundler::TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# graph.tsort_each {|n| p n }
# #=> 4
# # 2
# # 3
# # 1
#
def tsort_each(&block) # :yields: node
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
Bundler::TSort.tsort_each(each_node, each_child, &block)
end
# The iterator version of the Bundler::TSort.tsort method.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# Bundler::TSort.tsort_each(each_node, each_child) {|n| p n }
# #=> 4
# # 2
# # 3
# # 1
#
def self.tsort_each(each_node, each_child) # :yields: node
return to_enum(__method__, each_node, each_child) unless block_given?
each_strongly_connected_component(each_node, each_child) {|component|
if component.size == 1
yield component.first
else
raise Cyclic.new("topological sort failed: #{component.inspect}")
end
}
end
# Returns strongly connected components as an array of arrays of nodes.
# The array is sorted from children to parents.
# Each elements of the array represents a strongly connected component.
#
# class G
# include Bundler::TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# p graph.strongly_connected_components #=> [[4], [2], [3], [1]]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# p graph.strongly_connected_components #=> [[4], [2, 3], [1]]
#
def strongly_connected_components
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
Bundler::TSort.strongly_connected_components(each_node, each_child)
end
# Returns strongly connected components as an array of arrays of nodes.
# The array is sorted from children to parents.
# Each elements of the array represents a strongly connected component.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p Bundler::TSort.strongly_connected_components(each_node, each_child)
# #=> [[4], [2], [3], [1]]
#
# g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# p Bundler::TSort.strongly_connected_components(each_node, each_child)
# #=> [[4], [2, 3], [1]]
#
def self.strongly_connected_components(each_node, each_child)
each_strongly_connected_component(each_node, each_child).to_a
end
# The iterator version of the #strongly_connected_components method.
# <tt><em>obj</em>.each_strongly_connected_component</tt> is similar to
# <tt><em>obj</em>.strongly_connected_components.each</tt>, but
# modification of _obj_ during the iteration may lead to unexpected results.
#
# #each_strongly_connected_component returns +nil+.
#
# class G
# include Bundler::TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# graph.each_strongly_connected_component {|scc| p scc }
# #=> [4]
# # [2]
# # [3]
# # [1]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# graph.each_strongly_connected_component {|scc| p scc }
# #=> [4]
# # [2, 3]
# # [1]
#
def each_strongly_connected_component(&block) # :yields: nodes
each_node = method(:tsort_each_node)
each_child = method(:tsort_each_child)
Bundler::TSort.each_strongly_connected_component(each_node, each_child, &block)
end
# The iterator version of the Bundler::TSort.strongly_connected_components method.
#
# The graph is represented by _each_node_ and _each_child_.
# _each_node_ should have +call+ method which yields for each node in the graph.
# _each_child_ should have +call+ method which takes a node argument and yields for each child node.
#
# g = {1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# Bundler::TSort.each_strongly_connected_component(each_node, each_child) {|scc| p scc }
# #=> [4]
# # [2]
# # [3]
# # [1]
#
# g = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_node = lambda {|&b| g.each_key(&b) }
# each_child = lambda {|n, &b| g[n].each(&b) }
# Bundler::TSort.each_strongly_connected_component(each_node, each_child) {|scc| p scc }
# #=> [4]
# # [2, 3]
# # [1]
#
def self.each_strongly_connected_component(each_node, each_child) # :yields: nodes
return to_enum(__method__, each_node, each_child) unless block_given?
id_map = {}
stack = []
each_node.call {|node|
unless id_map.include? node
each_strongly_connected_component_from(node, each_child, id_map, stack) {|c|
yield c
}
end
}
nil
end
# Iterates over strongly connected component in the subgraph reachable from
# _node_.
#
# Return value is unspecified.
#
# #each_strongly_connected_component_from doesn't call #tsort_each_node.
#
# class G
# include Bundler::TSort
# def initialize(g)
# @g = g
# end
# def tsort_each_child(n, &b) @g[n].each(&b) end
# def tsort_each_node(&b) @g.each_key(&b) end
# end
#
# graph = G.new({1=>[2, 3], 2=>[4], 3=>[2, 4], 4=>[]})
# graph.each_strongly_connected_component_from(2) {|scc| p scc }
# #=> [4]
# # [2]
#
# graph = G.new({1=>[2], 2=>[3, 4], 3=>[2], 4=>[]})
# graph.each_strongly_connected_component_from(2) {|scc| p scc }
# #=> [4]
# # [2, 3]
#
def each_strongly_connected_component_from(node, id_map={}, stack=[], &block) # :yields: nodes
Bundler::TSort.each_strongly_connected_component_from(node, method(:tsort_each_child), id_map, stack, &block)
end
# Iterates over strongly connected components in a graph.
# The graph is represented by _node_ and _each_child_.
#
# _node_ is the first node.
# _each_child_ should have +call+ method which takes a node argument
# and yields for each child node.
#
# Return value is unspecified.
#
# #Bundler::TSort.each_strongly_connected_component_from is a class method and
# it doesn't need a class to represent a graph which includes Bundler::TSort.
#
# graph = {1=>[2], 2=>[3, 4], 3=>[2], 4=>[]}
# each_child = lambda {|n, &b| graph[n].each(&b) }
# Bundler::TSort.each_strongly_connected_component_from(1, each_child) {|scc|
# p scc
# }
# #=> [4]
# # [2, 3]
# # [1]
#
def self.each_strongly_connected_component_from(node, each_child, id_map={}, stack=[]) # :yields: nodes
return to_enum(__method__, node, each_child, id_map, stack) unless block_given?
minimum_id = node_id = id_map[node] = id_map.size
stack_length = stack.length
stack << node
each_child.call(node) {|child|
if id_map.include? child
child_id = id_map[child]
minimum_id = child_id if child_id && child_id < minimum_id
else
sub_minimum_id =
each_strongly_connected_component_from(child, each_child, id_map, stack) {|c|
yield c
}
minimum_id = sub_minimum_id if sub_minimum_id < minimum_id
end
}
if node_id == minimum_id
component = stack.slice!(stack_length .. -1)
component.each {|n| id_map[n] = nil}
yield component
end
minimum_id
end
# Should be implemented by a extended class.
#
# #tsort_each_node is used to iterate for all nodes over a graph.
#
def tsort_each_node # :yields: node
raise NotImplementedError.new
end
# Should be implemented by a extended class.
#
# #tsort_each_child is used to iterate for child nodes of _node_.
#
def tsort_each_child(node) # :yields: child
raise NotImplementedError.new
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendor/fileutils/lib/fileutils.rb 0000644 00000240707 15173517745 0022535 0 ustar 00 # frozen_string_literal: true
begin
require 'rbconfig'
rescue LoadError
# for make rjit-headers
end
# Namespace for file utility methods for copying, moving, removing, etc.
#
# == What's Here
#
# First, what’s elsewhere. \Module \Bundler::FileUtils:
#
# - Inherits from {class Object}[rdoc-ref:Object].
# - Supplements {class File}[rdoc-ref:File]
# (but is not included or extended there).
#
# Here, module \Bundler::FileUtils provides methods that are useful for:
#
# - {Creating}[rdoc-ref:FileUtils@Creating].
# - {Deleting}[rdoc-ref:FileUtils@Deleting].
# - {Querying}[rdoc-ref:FileUtils@Querying].
# - {Setting}[rdoc-ref:FileUtils@Setting].
# - {Comparing}[rdoc-ref:FileUtils@Comparing].
# - {Copying}[rdoc-ref:FileUtils@Copying].
# - {Moving}[rdoc-ref:FileUtils@Moving].
# - {Options}[rdoc-ref:FileUtils@Options].
#
# === Creating
#
# - ::mkdir: Creates directories.
# - ::mkdir_p, ::makedirs, ::mkpath: Creates directories,
# also creating ancestor directories as needed.
# - ::link_entry: Creates a hard link.
# - ::ln, ::link: Creates hard links.
# - ::ln_s, ::symlink: Creates symbolic links.
# - ::ln_sf: Creates symbolic links, overwriting if necessary.
# - ::ln_sr: Creates symbolic links relative to targets
#
# === Deleting
#
# - ::remove_dir: Removes a directory and its descendants.
# - ::remove_entry: Removes an entry, including its descendants if it is a directory.
# - ::remove_entry_secure: Like ::remove_entry, but removes securely.
# - ::remove_file: Removes a file entry.
# - ::rm, ::remove: Removes entries.
# - ::rm_f, ::safe_unlink: Like ::rm, but removes forcibly.
# - ::rm_r: Removes entries and their descendants.
# - ::rm_rf, ::rmtree: Like ::rm_r, but removes forcibly.
# - ::rmdir: Removes directories.
#
# === Querying
#
# - ::pwd, ::getwd: Returns the path to the working directory.
# - ::uptodate?: Returns whether a given entry is newer than given other entries.
#
# === Setting
#
# - ::cd, ::chdir: Sets the working directory.
# - ::chmod: Sets permissions for an entry.
# - ::chmod_R: Sets permissions for an entry and its descendants.
# - ::chown: Sets the owner and group for entries.
# - ::chown_R: Sets the owner and group for entries and their descendants.
# - ::touch: Sets modification and access times for entries,
# creating if necessary.
#
# === Comparing
#
# - ::compare_file, ::cmp, ::identical?: Returns whether two entries are identical.
# - ::compare_stream: Returns whether two streams are identical.
#
# === Copying
#
# - ::copy_entry: Recursively copies an entry.
# - ::copy_file: Copies an entry.
# - ::copy_stream: Copies a stream.
# - ::cp, ::copy: Copies files.
# - ::cp_lr: Recursively creates hard links.
# - ::cp_r: Recursively copies files, retaining mode, owner, and group.
# - ::install: Recursively copies files, optionally setting mode,
# owner, and group.
#
# === Moving
#
# - ::mv, ::move: Moves entries.
#
# === Options
#
# - ::collect_method: Returns the names of methods that accept a given option.
# - ::commands: Returns the names of methods that accept options.
# - ::have_option?: Returns whether a given method accepts a given option.
# - ::options: Returns all option names.
# - ::options_of: Returns the names of the options for a given method.
#
# == Path Arguments
#
# Some methods in \Bundler::FileUtils accept _path_ arguments,
# which are interpreted as paths to filesystem entries:
#
# - If the argument is a string, that value is the path.
# - If the argument has method +:to_path+, it is converted via that method.
# - If the argument has method +:to_str+, it is converted via that method.
#
# == About the Examples
#
# Some examples here involve trees of file entries.
# For these, we sometimes display trees using the
# {tree command-line utility}[https://en.wikipedia.org/wiki/Tree_(command)],
# which is a recursive directory-listing utility that produces
# a depth-indented listing of files and directories.
#
# We use a helper method to launch the command and control the format:
#
# def tree(dirpath = '.')
# command = "tree --noreport --charset=ascii #{dirpath}"
# system(command)
# end
#
# To illustrate:
#
# tree('src0')
# # => src0
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# == Avoiding the TOCTTOU Vulnerability
#
# For certain methods that recursively remove entries,
# there is a potential vulnerability called the
# {Time-of-check to time-of-use}[https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use],
# or TOCTTOU, vulnerability that can exist when:
#
# - An ancestor directory of the entry at the target path is world writable;
# such directories include <tt>/tmp</tt>.
# - The directory tree at the target path includes:
#
# - A world-writable descendant directory.
# - A symbolic link.
#
# To avoid that vulnerability, you can use this method to remove entries:
#
# - Bundler::FileUtils.remove_entry_secure: removes recursively
# if the target path points to a directory.
#
# Also available are these methods,
# each of which calls \Bundler::FileUtils.remove_entry_secure:
#
# - Bundler::FileUtils.rm_r with keyword argument <tt>secure: true</tt>.
# - Bundler::FileUtils.rm_rf with keyword argument <tt>secure: true</tt>.
#
# Finally, this method for moving entries calls \Bundler::FileUtils.remove_entry_secure
# if the source and destination are on different file systems
# (which means that the "move" is really a copy and remove):
#
# - Bundler::FileUtils.mv with keyword argument <tt>secure: true</tt>.
#
# \Method \Bundler::FileUtils.remove_entry_secure removes securely
# by applying a special pre-process:
#
# - If the target path points to a directory, this method uses methods
# {File#chown}[rdoc-ref:File#chown]
# and {File#chmod}[rdoc-ref:File#chmod]
# in removing directories.
# - The owner of the target directory should be either the current process
# or the super user (root).
#
# WARNING: You must ensure that *ALL* parent directories cannot be
# moved by other untrusted users. For example, parent directories
# should not be owned by untrusted users, and should not be world
# writable except when the sticky bit is set.
#
# For details of this security vulnerability, see Perl cases:
#
# - {CVE-2005-0448}[https://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2005-0448].
# - {CVE-2004-0452}[https://cve.mitre.org/cgi-bin/cvename.cgi?name=CAN-2004-0452].
#
module Bundler::FileUtils
VERSION = "1.7.2"
def self.private_module_function(name) #:nodoc:
module_function name
private_class_method name
end
#
# Returns a string containing the path to the current directory:
#
# Bundler::FileUtils.pwd # => "/rdoc/fileutils"
#
# Related: Bundler::FileUtils.cd.
#
def pwd
Dir.pwd
end
module_function :pwd
alias getwd pwd
module_function :getwd
# Changes the working directory to the given +dir+, which
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments]:
#
# With no block given,
# changes the current directory to the directory at +dir+; returns zero:
#
# Bundler::FileUtils.pwd # => "/rdoc/fileutils"
# Bundler::FileUtils.cd('..')
# Bundler::FileUtils.pwd # => "/rdoc"
# Bundler::FileUtils.cd('fileutils')
#
# With a block given, changes the current directory to the directory
# at +dir+, calls the block with argument +dir+,
# and restores the original current directory; returns the block's value:
#
# Bundler::FileUtils.pwd # => "/rdoc/fileutils"
# Bundler::FileUtils.cd('..') { |arg| [arg, Bundler::FileUtils.pwd] } # => ["..", "/rdoc"]
# Bundler::FileUtils.pwd # => "/rdoc/fileutils"
#
# Keyword arguments:
#
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.cd('..')
# Bundler::FileUtils.cd('fileutils')
#
# Output:
#
# cd ..
# cd fileutils
#
# Related: Bundler::FileUtils.pwd.
#
def cd(dir, verbose: nil, &block) # :yield: dir
fu_output_message "cd #{dir}" if verbose
result = Dir.chdir(dir, &block)
fu_output_message 'cd -' if verbose and block
result
end
module_function :cd
alias chdir cd
module_function :chdir
#
# Returns +true+ if the file at path +new+
# is newer than all the files at paths in array +old_list+;
# +false+ otherwise.
#
# Argument +new+ and the elements of +old_list+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments]:
#
# Bundler::FileUtils.uptodate?('Rakefile', ['Gemfile', 'README.md']) # => true
# Bundler::FileUtils.uptodate?('Gemfile', ['Rakefile', 'README.md']) # => false
#
# A non-existent file is considered to be infinitely old.
#
# Related: Bundler::FileUtils.touch.
#
def uptodate?(new, old_list)
return false unless File.exist?(new)
new_time = File.mtime(new)
old_list.each do |old|
if File.exist?(old)
return false unless new_time > File.mtime(old)
end
end
true
end
module_function :uptodate?
def remove_trailing_slash(dir) #:nodoc:
dir == '/' ? dir : dir.chomp(?/)
end
private_module_function :remove_trailing_slash
#
# Creates directories at the paths in the given +list+
# (a single path or an array of paths);
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, creates a directory at each +path+ in +list+
# by calling: <tt>Dir.mkdir(path, mode)</tt>;
# see {Dir.mkdir}[rdoc-ref:Dir.mkdir]:
#
# Bundler::FileUtils.mkdir(%w[tmp0 tmp1]) # => ["tmp0", "tmp1"]
# Bundler::FileUtils.mkdir('tmp4') # => ["tmp4"]
#
# Keyword arguments:
#
# - <tt>mode: <i>mode</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
# see {File.chmod}[rdoc-ref:File.chmod].
# - <tt>noop: true</tt> - does not create directories.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.mkdir(%w[tmp0 tmp1], verbose: true)
# Bundler::FileUtils.mkdir(%w[tmp2 tmp3], mode: 0700, verbose: true)
#
# Output:
#
# mkdir tmp0 tmp1
# mkdir -m 700 tmp2 tmp3
#
# Raises an exception if any path points to an existing
# file or directory, or if for any reason a directory cannot be created.
#
# Related: Bundler::FileUtils.mkdir_p.
#
def mkdir(list, mode: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "mkdir #{mode ? ('-m %03o ' % mode) : ''}#{list.join ' '}" if verbose
return if noop
list.each do |dir|
fu_mkdir dir, mode
end
end
module_function :mkdir
#
# Creates directories at the paths in the given +list+
# (a single path or an array of paths),
# also creating ancestor directories as needed;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, creates a directory at each +path+ in +list+,
# along with any needed ancestor directories,
# by calling: <tt>Dir.mkdir(path, mode)</tt>;
# see {Dir.mkdir}[rdoc-ref:Dir.mkdir]:
#
# Bundler::FileUtils.mkdir_p(%w[tmp0/tmp1 tmp2/tmp3]) # => ["tmp0/tmp1", "tmp2/tmp3"]
# Bundler::FileUtils.mkdir_p('tmp4/tmp5') # => ["tmp4/tmp5"]
#
# Keyword arguments:
#
# - <tt>mode: <i>mode</i></tt> - also calls <tt>File.chmod(mode, path)</tt>;
# see {File.chmod}[rdoc-ref:File.chmod].
# - <tt>noop: true</tt> - does not create directories.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.mkdir_p(%w[tmp0 tmp1], verbose: true)
# Bundler::FileUtils.mkdir_p(%w[tmp2 tmp3], mode: 0700, verbose: true)
#
# Output:
#
# mkdir -p tmp0 tmp1
# mkdir -p -m 700 tmp2 tmp3
#
# Raises an exception if for any reason a directory cannot be created.
#
# Bundler::FileUtils.mkpath and Bundler::FileUtils.makedirs are aliases for Bundler::FileUtils.mkdir_p.
#
# Related: Bundler::FileUtils.mkdir.
#
def mkdir_p(list, mode: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "mkdir -p #{mode ? ('-m %03o ' % mode) : ''}#{list.join ' '}" if verbose
return *list if noop
list.each do |item|
path = remove_trailing_slash(item)
stack = []
until File.directory?(path) || File.dirname(path) == path
stack.push path
path = File.dirname(path)
end
stack.reverse_each do |dir|
begin
fu_mkdir dir, mode
rescue SystemCallError
raise unless File.directory?(dir)
end
end
end
return *list
end
module_function :mkdir_p
alias mkpath mkdir_p
alias makedirs mkdir_p
module_function :mkpath
module_function :makedirs
def fu_mkdir(path, mode) #:nodoc:
path = remove_trailing_slash(path)
if mode
Dir.mkdir path, mode
File.chmod mode, path
else
Dir.mkdir path
end
end
private_module_function :fu_mkdir
#
# Removes directories at the paths in the given +list+
# (a single path or an array of paths);
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, removes the directory at each +path+ in +list+,
# by calling: <tt>Dir.rmdir(path)</tt>;
# see {Dir.rmdir}[rdoc-ref:Dir.rmdir]:
#
# Bundler::FileUtils.rmdir(%w[tmp0/tmp1 tmp2/tmp3]) # => ["tmp0/tmp1", "tmp2/tmp3"]
# Bundler::FileUtils.rmdir('tmp4/tmp5') # => ["tmp4/tmp5"]
#
# Keyword arguments:
#
# - <tt>parents: true</tt> - removes successive ancestor directories
# if empty.
# - <tt>noop: true</tt> - does not remove directories.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.rmdir(%w[tmp0/tmp1 tmp2/tmp3], parents: true, verbose: true)
# Bundler::FileUtils.rmdir('tmp4/tmp5', parents: true, verbose: true)
#
# Output:
#
# rmdir -p tmp0/tmp1 tmp2/tmp3
# rmdir -p tmp4/tmp5
#
# Raises an exception if a directory does not exist
# or if for any reason a directory cannot be removed.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rmdir(list, parents: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "rmdir #{parents ? '-p ' : ''}#{list.join ' '}" if verbose
return if noop
list.each do |dir|
Dir.rmdir(dir = remove_trailing_slash(dir))
if parents
begin
until (parent = File.dirname(dir)) == '.' or parent == dir
dir = parent
Dir.rmdir(dir)
end
rescue Errno::ENOTEMPTY, Errno::EEXIST, Errno::ENOENT
end
end
end
end
module_function :rmdir
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# When +src+ is the path to an existing file
# and +dest+ is the path to a non-existent file,
# creates a hard link at +dest+ pointing to +src+; returns zero:
#
# Dir.children('tmp0/') # => ["t.txt"]
# Dir.children('tmp1/') # => []
# Bundler::FileUtils.ln('tmp0/t.txt', 'tmp1/t.lnk') # => 0
# Dir.children('tmp1/') # => ["t.lnk"]
#
# When +src+ is the path to an existing file
# and +dest+ is the path to an existing directory,
# creates a hard link at <tt>dest/src</tt> pointing to +src+; returns zero:
#
# Dir.children('tmp2') # => ["t.dat"]
# Dir.children('tmp3') # => []
# Bundler::FileUtils.ln('tmp2/t.dat', 'tmp3') # => 0
# Dir.children('tmp3') # => ["t.dat"]
#
# When +src+ is an array of paths to existing files
# and +dest+ is the path to an existing directory,
# then for each path +target+ in +src+,
# creates a hard link at <tt>dest/target</tt> pointing to +target+;
# returns +src+:
#
# Dir.children('tmp4/') # => []
# Bundler::FileUtils.ln(['tmp0/t.txt', 'tmp2/t.dat'], 'tmp4/') # => ["tmp0/t.txt", "tmp2/t.dat"]
# Dir.children('tmp4/') # => ["t.dat", "t.txt"]
#
# Keyword arguments:
#
# - <tt>force: true</tt> - overwrites +dest+ if it exists.
# - <tt>noop: true</tt> - does not create links.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.ln('tmp0/t.txt', 'tmp1/t.lnk', verbose: true)
# Bundler::FileUtils.ln('tmp2/t.dat', 'tmp3', verbose: true)
# Bundler::FileUtils.ln(['tmp0/t.txt', 'tmp2/t.dat'], 'tmp4/', verbose: true)
#
# Output:
#
# ln tmp0/t.txt tmp1/t.lnk
# ln tmp2/t.dat tmp3
# ln tmp0/t.txt tmp2/t.dat tmp4/
#
# Raises an exception if +dest+ is the path to an existing file
# and keyword argument +force+ is not +true+.
#
# Related: Bundler::FileUtils.link_entry (has different options).
#
def ln(src, dest, force: nil, noop: nil, verbose: nil)
fu_output_message "ln#{force ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest0(src, dest) do |s,d|
remove_file d, true if force
File.link s, d
end
end
module_function :ln
alias link ln
module_function :link
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a directory and +dest+ does not exist,
# creates links +dest+ and descendents pointing to +src+ and its descendents:
#
# tree('src0')
# # => src0
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
# File.exist?('dest0') # => false
# Bundler::FileUtils.cp_lr('src0', 'dest0')
# tree('dest0')
# # => dest0
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ and +dest+ are both paths to directories,
# creates links <tt>dest/src</tt> and descendents
# pointing to +src+ and its descendents:
#
# tree('src1')
# # => src1
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
# Bundler::FileUtils.mkdir('dest1')
# Bundler::FileUtils.cp_lr('src1', 'dest1')
# tree('dest1')
# # => dest1
# # `-- src1
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ is an array of paths to entries and +dest+ is the path to a directory,
# for each path +filepath+ in +src+, creates a link at <tt>dest/filepath</tt>
# pointing to that path:
#
# tree('src2')
# # => src2
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
# Bundler::FileUtils.mkdir('dest2')
# Bundler::FileUtils.cp_lr(['src2/sub0', 'src2/sub1'], 'dest2')
# tree('dest2')
# # => dest2
# # |-- sub0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- sub1
# # |-- src2.txt
# # `-- src3.txt
#
# Keyword arguments:
#
# - <tt>dereference_root: false</tt> - if +src+ is a symbolic link,
# does not dereference it.
# - <tt>noop: true</tt> - does not create links.
# - <tt>remove_destination: true</tt> - removes +dest+ before creating links.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.cp_lr('src0', 'dest0', noop: true, verbose: true)
# Bundler::FileUtils.cp_lr('src1', 'dest1', noop: true, verbose: true)
# Bundler::FileUtils.cp_lr(['src2/sub0', 'src2/sub1'], 'dest2', noop: true, verbose: true)
#
# Output:
#
# cp -lr src0 dest0
# cp -lr src1 dest1
# cp -lr src2/sub0 src2/sub1 dest2
#
# Raises an exception if +dest+ is the path to an existing file or directory
# and keyword argument <tt>remove_destination: true</tt> is not given.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def cp_lr(src, dest, noop: nil, verbose: nil,
dereference_root: true, remove_destination: false)
fu_output_message "cp -lr#{remove_destination ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
link_entry s, d, dereference_root, remove_destination
end
end
module_function :cp_lr
# Creates {symbolic links}[https://en.wikipedia.org/wiki/Symbolic_link].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to an existing file:
#
# - When +dest+ is the path to a non-existent file,
# creates a symbolic link at +dest+ pointing to +src+:
#
# Bundler::FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# Bundler::FileUtils.ln_s('src0.txt', 'dest0.txt')
# File.symlink?('dest0.txt') # => true
#
# - When +dest+ is the path to an existing file,
# creates a symbolic link at +dest+ pointing to +src+
# if and only if keyword argument <tt>force: true</tt> is given
# (raises an exception otherwise):
#
# Bundler::FileUtils.touch('src1.txt')
# Bundler::FileUtils.touch('dest1.txt')
# Bundler::FileUtils.ln_s('src1.txt', 'dest1.txt', force: true)
# FileTest.symlink?('dest1.txt') # => true
#
# Bundler::FileUtils.ln_s('src1.txt', 'dest1.txt') # Raises Errno::EEXIST.
#
# If +dest+ is the path to a directory,
# creates a symbolic link at <tt>dest/src</tt> pointing to +src+:
#
# Bundler::FileUtils.touch('src2.txt')
# Bundler::FileUtils.mkdir('destdir2')
# Bundler::FileUtils.ln_s('src2.txt', 'destdir2')
# File.symlink?('destdir2/src2.txt') # => true
#
# If +src+ is an array of paths to existing files and +dest+ is a directory,
# for each child +child+ in +src+ creates a symbolic link <tt>dest/child</tt>
# pointing to +child+:
#
# Bundler::FileUtils.mkdir('srcdir3')
# Bundler::FileUtils.touch('srcdir3/src0.txt')
# Bundler::FileUtils.touch('srcdir3/src1.txt')
# Bundler::FileUtils.mkdir('destdir3')
# Bundler::FileUtils.ln_s(['srcdir3/src0.txt', 'srcdir3/src1.txt'], 'destdir3')
# File.symlink?('destdir3/src0.txt') # => true
# File.symlink?('destdir3/src1.txt') # => true
#
# Keyword arguments:
#
# - <tt>force: true</tt> - overwrites +dest+ if it exists.
# - <tt>relative: false</tt> - create links relative to +dest+.
# - <tt>noop: true</tt> - does not create links.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.ln_s('src0.txt', 'dest0.txt', noop: true, verbose: true)
# Bundler::FileUtils.ln_s('src1.txt', 'destdir1', noop: true, verbose: true)
# Bundler::FileUtils.ln_s('src2.txt', 'dest2.txt', force: true, noop: true, verbose: true)
# Bundler::FileUtils.ln_s(['srcdir3/src0.txt', 'srcdir3/src1.txt'], 'destdir3', noop: true, verbose: true)
#
# Output:
#
# ln -s src0.txt dest0.txt
# ln -s src1.txt destdir1
# ln -sf src2.txt dest2.txt
# ln -s srcdir3/src0.txt srcdir3/src1.txt destdir3
#
# Related: Bundler::FileUtils.ln_sf.
#
def ln_s(src, dest, force: nil, relative: false, target_directory: true, noop: nil, verbose: nil)
if relative
return ln_sr(src, dest, force: force, noop: noop, verbose: verbose)
end
fu_output_message "ln -s#{force ? 'f' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest0(src, dest) do |s,d|
remove_file d, true if force
File.symlink s, d
end
end
module_function :ln_s
alias symlink ln_s
module_function :symlink
# Like Bundler::FileUtils.ln_s, but always with keyword argument <tt>force: true</tt> given.
#
def ln_sf(src, dest, noop: nil, verbose: nil)
ln_s src, dest, force: true, noop: noop, verbose: verbose
end
module_function :ln_sf
# Like Bundler::FileUtils.ln_s, but create links relative to +dest+.
#
def ln_sr(src, dest, target_directory: true, force: nil, noop: nil, verbose: nil)
options = "#{force ? 'f' : ''}#{target_directory ? '' : 'T'}"
dest = File.path(dest)
srcs = Array(src)
link = proc do |s, target_dir_p = true|
s = File.path(s)
if target_dir_p
d = File.join(destdirs = dest, File.basename(s))
else
destdirs = File.dirname(d = dest)
end
destdirs = fu_split_path(File.realpath(destdirs))
if fu_starting_path?(s)
srcdirs = fu_split_path((File.realdirpath(s) rescue File.expand_path(s)))
base = fu_relative_components_from(srcdirs, destdirs)
s = File.join(*base)
else
srcdirs = fu_clean_components(*fu_split_path(s))
base = fu_relative_components_from(fu_split_path(Dir.pwd), destdirs)
while srcdirs.first&. == ".." and base.last&.!=("..") and !fu_starting_path?(base.last)
srcdirs.shift
base.pop
end
s = File.join(*base, *srcdirs)
end
fu_output_message "ln -s#{options} #{s} #{d}" if verbose
next if noop
remove_file d, true if force
File.symlink s, d
end
case srcs.size
when 0
when 1
link[srcs[0], target_directory && File.directory?(dest)]
else
srcs.each(&link)
end
end
module_function :ln_sr
# Creates {hard links}[https://en.wikipedia.org/wiki/Hard_link]; returns +nil+.
#
# Arguments +src+ and +dest+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a file and +dest+ does not exist,
# creates a hard link at +dest+ pointing to +src+:
#
# Bundler::FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# Bundler::FileUtils.link_entry('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is the path to a directory and +dest+ does not exist,
# recursively creates hard links at +dest+ pointing to paths in +src+:
#
# Bundler::FileUtils.mkdir_p(['src1/dir0', 'src1/dir1'])
# src_file_paths = [
# 'src1/dir0/t0.txt',
# 'src1/dir0/t1.txt',
# 'src1/dir1/t2.txt',
# 'src1/dir1/t3.txt',
# ]
# Bundler::FileUtils.touch(src_file_paths)
# File.directory?('dest1') # => true
# Bundler::FileUtils.link_entry('src1', 'dest1')
# File.file?('dest1/dir0/t0.txt') # => true
# File.file?('dest1/dir0/t1.txt') # => true
# File.file?('dest1/dir1/t2.txt') # => true
# File.file?('dest1/dir1/t3.txt') # => true
#
# Keyword arguments:
#
# - <tt>dereference_root: true</tt> - dereferences +src+ if it is a symbolic link.
# - <tt>remove_destination: true</tt> - removes +dest+ before creating links.
#
# Raises an exception if +dest+ is the path to an existing file or directory
# and keyword argument <tt>remove_destination: true</tt> is not given.
#
# Related: Bundler::FileUtils.ln (has different options).
#
def link_entry(src, dest, dereference_root = false, remove_destination = false)
Entry_.new(src, nil, dereference_root).traverse do |ent|
destent = Entry_.new(dest, ent.rel, false)
File.unlink destent.path if remove_destination && File.file?(destent.path)
ent.link destent.path
end
end
module_function :link_entry
# Copies files.
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a file and +dest+ is not the path to a directory,
# copies +src+ to +dest+:
#
# Bundler::FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# Bundler::FileUtils.cp('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is the path to a file and +dest+ is the path to a directory,
# copies +src+ to <tt>dest/src</tt>:
#
# Bundler::FileUtils.touch('src1.txt')
# Bundler::FileUtils.mkdir('dest1')
# Bundler::FileUtils.cp('src1.txt', 'dest1')
# File.file?('dest1/src1.txt') # => true
#
# If +src+ is an array of paths to files and +dest+ is the path to a directory,
# copies from each +src+ to +dest+:
#
# src_file_paths = ['src2.txt', 'src2.dat']
# Bundler::FileUtils.touch(src_file_paths)
# Bundler::FileUtils.mkdir('dest2')
# Bundler::FileUtils.cp(src_file_paths, 'dest2')
# File.file?('dest2/src2.txt') # => true
# File.file?('dest2/src2.dat') # => true
#
# Keyword arguments:
#
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>noop: true</tt> - does not copy files.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.cp('src0.txt', 'dest0.txt', noop: true, verbose: true)
# Bundler::FileUtils.cp('src1.txt', 'dest1', noop: true, verbose: true)
# Bundler::FileUtils.cp(src_file_paths, 'dest2', noop: true, verbose: true)
#
# Output:
#
# cp src0.txt dest0.txt
# cp src1.txt dest1
# cp src2.txt src2.dat dest2
#
# Raises an exception if +src+ is a directory.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def cp(src, dest, preserve: nil, noop: nil, verbose: nil)
fu_output_message "cp#{preserve ? ' -p' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
copy_file s, d, preserve
end
end
module_function :cp
alias copy cp
module_function :copy
# Recursively copies files.
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# The mode, owner, and group are retained in the copy;
# to change those, use Bundler::FileUtils.install instead.
#
# If +src+ is the path to a file and +dest+ is not the path to a directory,
# copies +src+ to +dest+:
#
# Bundler::FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# Bundler::FileUtils.cp_r('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is the path to a file and +dest+ is the path to a directory,
# copies +src+ to <tt>dest/src</tt>:
#
# Bundler::FileUtils.touch('src1.txt')
# Bundler::FileUtils.mkdir('dest1')
# Bundler::FileUtils.cp_r('src1.txt', 'dest1')
# File.file?('dest1/src1.txt') # => true
#
# If +src+ is the path to a directory and +dest+ does not exist,
# recursively copies +src+ to +dest+:
#
# tree('src2')
# # => src2
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# Bundler::FileUtils.exist?('dest2') # => false
# Bundler::FileUtils.cp_r('src2', 'dest2')
# tree('dest2')
# # => dest2
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ and +dest+ are paths to directories,
# recursively copies +src+ to <tt>dest/src</tt>:
#
# tree('src3')
# # => src3
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# Bundler::FileUtils.mkdir('dest3')
# Bundler::FileUtils.cp_r('src3', 'dest3')
# tree('dest3')
# # => dest3
# # `-- src3
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
#
# If +src+ is an array of paths and +dest+ is a directory,
# recursively copies from each path in +src+ to +dest+;
# the paths in +src+ may point to files and/or directories.
#
# Keyword arguments:
#
# - <tt>dereference_root: false</tt> - if +src+ is a symbolic link,
# does not dereference it.
# - <tt>noop: true</tt> - does not copy files.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.cp_r('src0.txt', 'dest0.txt', noop: true, verbose: true)
# Bundler::FileUtils.cp_r('src1.txt', 'dest1', noop: true, verbose: true)
# Bundler::FileUtils.cp_r('src2', 'dest2', noop: true, verbose: true)
# Bundler::FileUtils.cp_r('src3', 'dest3', noop: true, verbose: true)
#
# Output:
#
# cp -r src0.txt dest0.txt
# cp -r src1.txt dest1
# cp -r src2 dest2
# cp -r src3 dest3
#
# Raises an exception of +src+ is the path to a directory
# and +dest+ is the path to a file.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def cp_r(src, dest, preserve: nil, noop: nil, verbose: nil,
dereference_root: true, remove_destination: nil)
fu_output_message "cp -r#{preserve ? 'p' : ''}#{remove_destination ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
copy_entry s, d, preserve, dereference_root, remove_destination
end
end
module_function :cp_r
# Recursively copies files from +src+ to +dest+.
#
# Arguments +src+ and +dest+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ is the path to a file, copies +src+ to +dest+:
#
# Bundler::FileUtils.touch('src0.txt')
# File.exist?('dest0.txt') # => false
# Bundler::FileUtils.copy_entry('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# If +src+ is a directory, recursively copies +src+ to +dest+:
#
# tree('src1')
# # => src1
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# Bundler::FileUtils.copy_entry('src1', 'dest1')
# tree('dest1')
# # => dest1
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
#
# The recursive copying preserves file types for regular files,
# directories, and symbolic links;
# other file types (FIFO streams, device files, etc.) are not supported.
#
# Keyword arguments:
#
# - <tt>dereference_root: true</tt> - if +src+ is a symbolic link,
# follows the link.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def copy_entry(src, dest, preserve = false, dereference_root = false, remove_destination = false)
if dereference_root
src = File.realpath(src)
end
Entry_.new(src, nil, false).wrap_traverse(proc do |ent|
destent = Entry_.new(dest, ent.rel, false)
File.unlink destent.path if remove_destination && (File.file?(destent.path) || File.symlink?(destent.path))
ent.copy destent.path
end, proc do |ent|
destent = Entry_.new(dest, ent.rel, false)
ent.copy_metadata destent.path if preserve
end)
end
module_function :copy_entry
# Copies file from +src+ to +dest+, which should not be directories.
#
# Arguments +src+ and +dest+
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# Examples:
#
# Bundler::FileUtils.touch('src0.txt')
# Bundler::FileUtils.copy_file('src0.txt', 'dest0.txt')
# File.file?('dest0.txt') # => true
#
# Keyword arguments:
#
# - <tt>dereference: false</tt> - if +src+ is a symbolic link,
# does not follow the link.
# - <tt>preserve: true</tt> - preserves file times.
# - <tt>remove_destination: true</tt> - removes +dest+ before copying files.
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def copy_file(src, dest, preserve = false, dereference = true)
ent = Entry_.new(src, nil, dereference)
ent.copy_file dest
ent.copy_metadata dest if preserve
end
module_function :copy_file
# Copies \IO stream +src+ to \IO stream +dest+ via
# {IO.copy_stream}[rdoc-ref:IO.copy_stream].
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def copy_stream(src, dest)
IO.copy_stream(src, dest)
end
module_function :copy_stream
# Moves entries.
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# If +src+ and +dest+ are on different file systems,
# first copies, then removes +src+.
#
# May cause a local vulnerability if not called with keyword argument
# <tt>secure: true</tt>;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# If +src+ is the path to a single file or directory and +dest+ does not exist,
# moves +src+ to +dest+:
#
# tree('src0')
# # => src0
# # |-- src0.txt
# # `-- src1.txt
# File.exist?('dest0') # => false
# Bundler::FileUtils.mv('src0', 'dest0')
# File.exist?('src0') # => false
# tree('dest0')
# # => dest0
# # |-- src0.txt
# # `-- src1.txt
#
# If +src+ is an array of paths to files and directories
# and +dest+ is the path to a directory,
# copies from each path in the array to +dest+:
#
# File.file?('src1.txt') # => true
# tree('src1')
# # => src1
# # |-- src.dat
# # `-- src.txt
# Dir.empty?('dest1') # => true
# Bundler::FileUtils.mv(['src1.txt', 'src1'], 'dest1')
# tree('dest1')
# # => dest1
# # |-- src1
# # | |-- src.dat
# # | `-- src.txt
# # `-- src1.txt
#
# Keyword arguments:
#
# - <tt>force: true</tt> - if the move includes removing +src+
# (that is, if +src+ and +dest+ are on different file systems),
# ignores raised exceptions of StandardError and its descendants.
# - <tt>noop: true</tt> - does not move files.
# - <tt>secure: true</tt> - removes +src+ securely;
# see details at Bundler::FileUtils.remove_entry_secure.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.mv('src0', 'dest0', noop: true, verbose: true)
# Bundler::FileUtils.mv(['src1.txt', 'src1'], 'dest1', noop: true, verbose: true)
#
# Output:
#
# mv src0 dest0
# mv src1.txt src1 dest1
#
def mv(src, dest, force: nil, noop: nil, verbose: nil, secure: nil)
fu_output_message "mv#{force ? ' -f' : ''} #{[src,dest].flatten.join ' '}" if verbose
return if noop
fu_each_src_dest(src, dest) do |s, d|
destent = Entry_.new(d, nil, true)
begin
if destent.exist?
if destent.directory?
raise Errno::EEXIST, d
end
end
begin
File.rename s, d
rescue Errno::EXDEV,
Errno::EPERM # move from unencrypted to encrypted dir (ext4)
copy_entry s, d, true
if secure
remove_entry_secure s, force
else
remove_entry s, force
end
end
rescue SystemCallError
raise unless force
end
end
end
module_function :mv
alias move mv
module_function :move
# Removes entries at the paths in the given +list+
# (a single path or an array of paths)
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# With no keyword arguments, removes files at the paths given in +list+:
#
# Bundler::FileUtils.touch(['src0.txt', 'src0.dat'])
# Bundler::FileUtils.rm(['src0.dat', 'src0.txt']) # => ["src0.dat", "src0.txt"]
#
# Keyword arguments:
#
# - <tt>force: true</tt> - ignores raised exceptions of StandardError
# and its descendants.
# - <tt>noop: true</tt> - does not remove files; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.rm(['src0.dat', 'src0.txt'], noop: true, verbose: true)
#
# Output:
#
# rm src0.dat src0.txt
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm(list, force: nil, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message "rm#{force ? ' -f' : ''} #{list.join ' '}" if verbose
return if noop
list.each do |path|
remove_file path, force
end
end
module_function :rm
alias remove rm
module_function :remove
# Equivalent to:
#
# Bundler::FileUtils.rm(list, force: true, **kwargs)
#
# Argument +list+ (a single path or an array of paths)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# See Bundler::FileUtils.rm for keyword arguments.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm_f(list, noop: nil, verbose: nil)
rm list, force: true, noop: noop, verbose: verbose
end
module_function :rm_f
alias safe_unlink rm_f
module_function :safe_unlink
# Removes entries at the paths in the given +list+
# (a single path or an array of paths);
# returns +list+, if it is an array, <tt>[list]</tt> otherwise.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# May cause a local vulnerability if not called with keyword argument
# <tt>secure: true</tt>;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# For each file path, removes the file at that path:
#
# Bundler::FileUtils.touch(['src0.txt', 'src0.dat'])
# Bundler::FileUtils.rm_r(['src0.dat', 'src0.txt'])
# File.exist?('src0.txt') # => false
# File.exist?('src0.dat') # => false
#
# For each directory path, recursively removes files and directories:
#
# tree('src1')
# # => src1
# # |-- dir0
# # | |-- src0.txt
# # | `-- src1.txt
# # `-- dir1
# # |-- src2.txt
# # `-- src3.txt
# Bundler::FileUtils.rm_r('src1')
# File.exist?('src1') # => false
#
# Keyword arguments:
#
# - <tt>force: true</tt> - ignores raised exceptions of StandardError
# and its descendants.
# - <tt>noop: true</tt> - does not remove entries; returns +nil+.
# - <tt>secure: true</tt> - removes +src+ securely;
# see details at Bundler::FileUtils.remove_entry_secure.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.rm_r(['src0.dat', 'src0.txt'], noop: true, verbose: true)
# Bundler::FileUtils.rm_r('src1', noop: true, verbose: true)
#
# Output:
#
# rm -r src0.dat src0.txt
# rm -r src1
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm_r(list, force: nil, noop: nil, verbose: nil, secure: nil)
list = fu_list(list)
fu_output_message "rm -r#{force ? 'f' : ''} #{list.join ' '}" if verbose
return if noop
list.each do |path|
if secure
remove_entry_secure path, force
else
remove_entry path, force
end
end
end
module_function :rm_r
# Equivalent to:
#
# Bundler::FileUtils.rm_r(list, force: true, **kwargs)
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# May cause a local vulnerability if not called with keyword argument
# <tt>secure: true</tt>;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# See Bundler::FileUtils.rm_r for keyword arguments.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def rm_rf(list, noop: nil, verbose: nil, secure: nil)
rm_r list, force: true, noop: noop, verbose: verbose, secure: secure
end
module_function :rm_rf
alias rmtree rm_rf
module_function :rmtree
# Securely removes the entry given by +path+,
# which should be the entry for a regular file, a symbolic link,
# or a directory.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Avoids a local vulnerability that can exist in certain circumstances;
# see {Avoiding the TOCTTOU Vulnerability}[rdoc-ref:FileUtils@Avoiding+the+TOCTTOU+Vulnerability].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def remove_entry_secure(path, force = false)
unless fu_have_symlink?
remove_entry path, force
return
end
fullpath = File.expand_path(path)
st = File.lstat(fullpath)
unless st.directory?
File.unlink fullpath
return
end
# is a directory.
parent_st = File.stat(File.dirname(fullpath))
unless parent_st.world_writable?
remove_entry path, force
return
end
unless parent_st.sticky?
raise ArgumentError, "parent directory is world writable, Bundler::FileUtils#remove_entry_secure does not work; abort: #{path.inspect} (parent directory mode #{'%o' % parent_st.mode})"
end
# freeze tree root
euid = Process.euid
dot_file = fullpath + "/."
begin
File.open(dot_file) {|f|
unless fu_stat_identical_entry?(st, f.stat)
# symlink (TOC-to-TOU attack?)
File.unlink fullpath
return
end
f.chown euid, -1
f.chmod 0700
}
rescue Errno::EISDIR # JRuby in non-native mode can't open files as dirs
File.lstat(dot_file).tap {|fstat|
unless fu_stat_identical_entry?(st, fstat)
# symlink (TOC-to-TOU attack?)
File.unlink fullpath
return
end
File.chown euid, -1, dot_file
File.chmod 0700, dot_file
}
end
unless fu_stat_identical_entry?(st, File.lstat(fullpath))
# TOC-to-TOU attack?
File.unlink fullpath
return
end
# ---- tree root is frozen ----
root = Entry_.new(path)
root.preorder_traverse do |ent|
if ent.directory?
ent.chown euid, -1
ent.chmod 0700
end
end
root.postorder_traverse do |ent|
begin
ent.remove
rescue
raise unless force
end
end
rescue
raise unless force
end
module_function :remove_entry_secure
def fu_have_symlink? #:nodoc:
File.symlink nil, nil
rescue NotImplementedError
return false
rescue TypeError
return true
end
private_module_function :fu_have_symlink?
def fu_stat_identical_entry?(a, b) #:nodoc:
a.dev == b.dev and a.ino == b.ino
end
private_module_function :fu_stat_identical_entry?
# Removes the entry given by +path+,
# which should be the entry for a regular file, a symbolic link,
# or a directory.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: Bundler::FileUtils.remove_entry_secure.
#
def remove_entry(path, force = false)
Entry_.new(path).postorder_traverse do |ent|
begin
ent.remove
rescue
raise unless force
end
end
rescue
raise unless force
end
module_function :remove_entry
# Removes the file entry given by +path+,
# which should be the entry for a regular file or a symbolic link.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def remove_file(path, force = false)
Entry_.new(path).remove_file
rescue
raise unless force
end
module_function :remove_file
# Recursively removes the directory entry given by +path+,
# which should be the entry for a regular file, a symbolic link,
# or a directory.
#
# Argument +path+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Optional argument +force+ specifies whether to ignore
# raised exceptions of StandardError and its descendants.
#
# Related: {methods for deleting}[rdoc-ref:FileUtils@Deleting].
#
def remove_dir(path, force = false)
remove_entry path, force # FIXME?? check if it is a directory
end
module_function :remove_dir
# Returns +true+ if the contents of files +a+ and +b+ are identical,
# +false+ otherwise.
#
# Arguments +a+ and +b+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Bundler::FileUtils.identical? and Bundler::FileUtils.cmp are aliases for Bundler::FileUtils.compare_file.
#
# Related: Bundler::FileUtils.compare_stream.
#
def compare_file(a, b)
return false unless File.size(a) == File.size(b)
File.open(a, 'rb') {|fa|
File.open(b, 'rb') {|fb|
return compare_stream(fa, fb)
}
}
end
module_function :compare_file
alias identical? compare_file
alias cmp compare_file
module_function :identical?
module_function :cmp
# Returns +true+ if the contents of streams +a+ and +b+ are identical,
# +false+ otherwise.
#
# Arguments +a+ and +b+
# should be {interpretable as a path}[rdoc-ref:FileUtils@Path+Arguments].
#
# Related: Bundler::FileUtils.compare_file.
#
def compare_stream(a, b)
bsize = fu_stream_blksize(a, b)
sa = String.new(capacity: bsize)
sb = String.new(capacity: bsize)
begin
a.read(bsize, sa)
b.read(bsize, sb)
return true if sa.empty? && sb.empty?
end while sa == sb
false
end
module_function :compare_stream
# Copies a file entry.
# See {install(1)}[https://man7.org/linux/man-pages/man1/install.1.html].
#
# Arguments +src+ (a single path or an array of paths)
# and +dest+ (a single path)
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments];
#
# If the entry at +dest+ does not exist, copies from +src+ to +dest+:
#
# File.read('src0.txt') # => "aaa\n"
# File.exist?('dest0.txt') # => false
# Bundler::FileUtils.install('src0.txt', 'dest0.txt')
# File.read('dest0.txt') # => "aaa\n"
#
# If +dest+ is a file entry, copies from +src+ to +dest+, overwriting:
#
# File.read('src1.txt') # => "aaa\n"
# File.read('dest1.txt') # => "bbb\n"
# Bundler::FileUtils.install('src1.txt', 'dest1.txt')
# File.read('dest1.txt') # => "aaa\n"
#
# If +dest+ is a directory entry, copies from +src+ to <tt>dest/src</tt>,
# overwriting if necessary:
#
# File.read('src2.txt') # => "aaa\n"
# File.read('dest2/src2.txt') # => "bbb\n"
# Bundler::FileUtils.install('src2.txt', 'dest2')
# File.read('dest2/src2.txt') # => "aaa\n"
#
# If +src+ is an array of paths and +dest+ points to a directory,
# copies each path +path+ in +src+ to <tt>dest/path</tt>:
#
# File.file?('src3.txt') # => true
# File.file?('src3.dat') # => true
# Bundler::FileUtils.mkdir('dest3')
# Bundler::FileUtils.install(['src3.txt', 'src3.dat'], 'dest3')
# File.file?('dest3/src3.txt') # => true
# File.file?('dest3/src3.dat') # => true
#
# Keyword arguments:
#
# - <tt>group: <i>group</i></tt> - changes the group if not +nil+,
# using {File.chown}[rdoc-ref:File.chown].
# - <tt>mode: <i>permissions</i></tt> - changes the permissions.
# using {File.chmod}[rdoc-ref:File.chmod].
# - <tt>noop: true</tt> - does not copy entries; returns +nil+.
# - <tt>owner: <i>owner</i></tt> - changes the owner if not +nil+,
# using {File.chown}[rdoc-ref:File.chown].
# - <tt>preserve: true</tt> - preserve timestamps
# using {File.utime}[rdoc-ref:File.utime].
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.install('src0.txt', 'dest0.txt', noop: true, verbose: true)
# Bundler::FileUtils.install('src1.txt', 'dest1.txt', noop: true, verbose: true)
# Bundler::FileUtils.install('src2.txt', 'dest2', noop: true, verbose: true)
#
# Output:
#
# install -c src0.txt dest0.txt
# install -c src1.txt dest1.txt
# install -c src2.txt dest2
#
# Related: {methods for copying}[rdoc-ref:FileUtils@Copying].
#
def install(src, dest, mode: nil, owner: nil, group: nil, preserve: nil,
noop: nil, verbose: nil)
if verbose
msg = +"install -c"
msg << ' -p' if preserve
msg << ' -m ' << mode_to_s(mode) if mode
msg << " -o #{owner}" if owner
msg << " -g #{group}" if group
msg << ' ' << [src,dest].flatten.join(' ')
fu_output_message msg
end
return if noop
uid = fu_get_uid(owner)
gid = fu_get_gid(group)
fu_each_src_dest(src, dest) do |s, d|
st = File.stat(s)
unless File.exist?(d) and compare_file(s, d)
remove_file d, true
if d.end_with?('/')
mkdir_p d
copy_file s, d + File.basename(s)
else
mkdir_p File.expand_path('..', d)
copy_file s, d
end
File.utime st.atime, st.mtime, d if preserve
File.chmod fu_mode(mode, st), d if mode
File.chown uid, gid, d if uid or gid
end
end
end
module_function :install
def user_mask(target) #:nodoc:
target.each_char.inject(0) do |mask, chr|
case chr
when "u"
mask | 04700
when "g"
mask | 02070
when "o"
mask | 01007
when "a"
mask | 07777
else
raise ArgumentError, "invalid `who' symbol in file mode: #{chr}"
end
end
end
private_module_function :user_mask
def apply_mask(mode, user_mask, op, mode_mask) #:nodoc:
case op
when '='
(mode & ~user_mask) | (user_mask & mode_mask)
when '+'
mode | (user_mask & mode_mask)
when '-'
mode & ~(user_mask & mode_mask)
end
end
private_module_function :apply_mask
def symbolic_modes_to_i(mode_sym, path) #:nodoc:
path = File.stat(path) unless File::Stat === path
mode = path.mode
mode_sym.split(/,/).inject(mode & 07777) do |current_mode, clause|
target, *actions = clause.split(/([=+-])/)
raise ArgumentError, "invalid file mode: #{mode_sym}" if actions.empty?
target = 'a' if target.empty?
user_mask = user_mask(target)
actions.each_slice(2) do |op, perm|
need_apply = op == '='
mode_mask = (perm || '').each_char.inject(0) do |mask, chr|
case chr
when "r"
mask | 0444
when "w"
mask | 0222
when "x"
mask | 0111
when "X"
if path.directory?
mask | 0111
else
mask
end
when "s"
mask | 06000
when "t"
mask | 01000
when "u", "g", "o"
if mask.nonzero?
current_mode = apply_mask(current_mode, user_mask, op, mask)
end
need_apply = false
copy_mask = user_mask(chr)
(current_mode & copy_mask) / (copy_mask & 0111) * (user_mask & 0111)
else
raise ArgumentError, "invalid `perm' symbol in file mode: #{chr}"
end
end
if mode_mask.nonzero? || need_apply
current_mode = apply_mask(current_mode, user_mask, op, mode_mask)
end
end
current_mode
end
end
private_module_function :symbolic_modes_to_i
def fu_mode(mode, path) #:nodoc:
mode.is_a?(String) ? symbolic_modes_to_i(mode, path) : mode
end
private_module_function :fu_mode
def mode_to_s(mode) #:nodoc:
mode.is_a?(String) ? mode : "%o" % mode
end
private_module_function :mode_to_s
# Changes permissions on the entries at the paths given in +list+
# (a single path or an array of paths)
# to the permissions given by +mode+;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
#
# - Modifies each entry that is a regular file using
# {File.chmod}[rdoc-ref:File.chmod].
# - Modifies each entry that is a symbolic link using
# {File.lchmod}[rdoc-ref:File.lchmod].
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# Argument +mode+ may be either an integer or a string:
#
# - \Integer +mode+: represents the permission bits to be set:
#
# Bundler::FileUtils.chmod(0755, 'src0.txt')
# Bundler::FileUtils.chmod(0644, ['src0.txt', 'src0.dat'])
#
# - \String +mode+: represents the permissions to be set:
#
# The string is of the form <tt>[targets][[operator][perms[,perms]]</tt>, where:
#
# - +targets+ may be any combination of these letters:
#
# - <tt>'u'</tt>: permissions apply to the file's owner.
# - <tt>'g'</tt>: permissions apply to users in the file's group.
# - <tt>'o'</tt>: permissions apply to other users not in the file's group.
# - <tt>'a'</tt> (the default): permissions apply to all users.
#
# - +operator+ may be one of these letters:
#
# - <tt>'+'</tt>: adds permissions.
# - <tt>'-'</tt>: removes permissions.
# - <tt>'='</tt>: sets (replaces) permissions.
#
# - +perms+ (may be repeated, with separating commas)
# may be any combination of these letters:
#
# - <tt>'r'</tt>: Read.
# - <tt>'w'</tt>: Write.
# - <tt>'x'</tt>: Execute (search, for a directory).
# - <tt>'X'</tt>: Search (for a directories only;
# must be used with <tt>'+'</tt>)
# - <tt>'s'</tt>: Uid or gid.
# - <tt>'t'</tt>: Sticky bit.
#
# Examples:
#
# Bundler::FileUtils.chmod('u=wrx,go=rx', 'src1.txt')
# Bundler::FileUtils.chmod('u=wrx,go=rx', '/usr/bin/ruby')
#
# Keyword arguments:
#
# - <tt>noop: true</tt> - does not change permissions; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.chmod(0755, 'src0.txt', noop: true, verbose: true)
# Bundler::FileUtils.chmod(0644, ['src0.txt', 'src0.dat'], noop: true, verbose: true)
# Bundler::FileUtils.chmod('u=wrx,go=rx', 'src1.txt', noop: true, verbose: true)
# Bundler::FileUtils.chmod('u=wrx,go=rx', '/usr/bin/ruby', noop: true, verbose: true)
#
# Output:
#
# chmod 755 src0.txt
# chmod 644 src0.txt src0.dat
# chmod u=wrx,go=rx src1.txt
# chmod u=wrx,go=rx /usr/bin/ruby
#
# Related: Bundler::FileUtils.chmod_R.
#
def chmod(mode, list, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message sprintf('chmod %s %s', mode_to_s(mode), list.join(' ')) if verbose
return if noop
list.each do |path|
Entry_.new(path).chmod(fu_mode(mode, path))
end
end
module_function :chmod
# Like Bundler::FileUtils.chmod, but changes permissions recursively.
#
def chmod_R(mode, list, noop: nil, verbose: nil, force: nil)
list = fu_list(list)
fu_output_message sprintf('chmod -R%s %s %s',
(force ? 'f' : ''),
mode_to_s(mode), list.join(' ')) if verbose
return if noop
list.each do |root|
Entry_.new(root).traverse do |ent|
begin
ent.chmod(fu_mode(mode, ent.path))
rescue
raise unless force
end
end
end
end
module_function :chmod_R
# Changes the owner and group on the entries at the paths given in +list+
# (a single path or an array of paths)
# to the given +user+ and +group+;
# returns +list+ if it is an array, <tt>[list]</tt> otherwise:
#
# - Modifies each entry that is a regular file using
# {File.chown}[rdoc-ref:File.chown].
# - Modifies each entry that is a symbolic link using
# {File.lchown}[rdoc-ref:File.lchown].
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# User and group:
#
# - Argument +user+ may be a user name or a user id;
# if +nil+ or +-1+, the user is not changed.
# - Argument +group+ may be a group name or a group id;
# if +nil+ or +-1+, the group is not changed.
# - The user must be a member of the group.
#
# Examples:
#
# # One path.
# # User and group as string names.
# File.stat('src0.txt').uid # => 1004
# File.stat('src0.txt').gid # => 1004
# Bundler::FileUtils.chown('user2', 'group1', 'src0.txt')
# File.stat('src0.txt').uid # => 1006
# File.stat('src0.txt').gid # => 1005
#
# # User and group as uid and gid.
# Bundler::FileUtils.chown(1004, 1004, 'src0.txt')
# File.stat('src0.txt').uid # => 1004
# File.stat('src0.txt').gid # => 1004
#
# # Array of paths.
# Bundler::FileUtils.chown(1006, 1005, ['src0.txt', 'src0.dat'])
#
# # Directory (not recursive).
# Bundler::FileUtils.chown('user2', 'group1', '.')
#
# Keyword arguments:
#
# - <tt>noop: true</tt> - does not change permissions; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.chown('user2', 'group1', 'src0.txt', noop: true, verbose: true)
# Bundler::FileUtils.chown(1004, 1004, 'src0.txt', noop: true, verbose: true)
# Bundler::FileUtils.chown(1006, 1005, ['src0.txt', 'src0.dat'], noop: true, verbose: true)
# Bundler::FileUtils.chown('user2', 'group1', path, noop: true, verbose: true)
# Bundler::FileUtils.chown('user2', 'group1', '.', noop: true, verbose: true)
#
# Output:
#
# chown user2:group1 src0.txt
# chown 1004:1004 src0.txt
# chown 1006:1005 src0.txt src0.dat
# chown user2:group1 src0.txt
# chown user2:group1 .
#
# Related: Bundler::FileUtils.chown_R.
#
def chown(user, group, list, noop: nil, verbose: nil)
list = fu_list(list)
fu_output_message sprintf('chown %s %s',
(group ? "#{user}:#{group}" : user || ':'),
list.join(' ')) if verbose
return if noop
uid = fu_get_uid(user)
gid = fu_get_gid(group)
list.each do |path|
Entry_.new(path).chown uid, gid
end
end
module_function :chown
# Like Bundler::FileUtils.chown, but changes owner and group recursively.
#
def chown_R(user, group, list, noop: nil, verbose: nil, force: nil)
list = fu_list(list)
fu_output_message sprintf('chown -R%s %s %s',
(force ? 'f' : ''),
(group ? "#{user}:#{group}" : user || ':'),
list.join(' ')) if verbose
return if noop
uid = fu_get_uid(user)
gid = fu_get_gid(group)
list.each do |root|
Entry_.new(root).traverse do |ent|
begin
ent.chown uid, gid
rescue
raise unless force
end
end
end
end
module_function :chown_R
def fu_get_uid(user) #:nodoc:
return nil unless user
case user
when Integer
user
when /\A\d+\z/
user.to_i
else
require 'etc'
Etc.getpwnam(user) ? Etc.getpwnam(user).uid : nil
end
end
private_module_function :fu_get_uid
def fu_get_gid(group) #:nodoc:
return nil unless group
case group
when Integer
group
when /\A\d+\z/
group.to_i
else
require 'etc'
Etc.getgrnam(group) ? Etc.getgrnam(group).gid : nil
end
end
private_module_function :fu_get_gid
# Updates modification times (mtime) and access times (atime)
# of the entries given by the paths in +list+
# (a single path or an array of paths);
# returns +list+ if it is an array, <tt>[list]</tt> otherwise.
#
# By default, creates an empty file for any path to a non-existent entry;
# use keyword argument +nocreate+ to raise an exception instead.
#
# Argument +list+ or its elements
# should be {interpretable as paths}[rdoc-ref:FileUtils@Path+Arguments].
#
# Examples:
#
# # Single path.
# f = File.new('src0.txt') # Existing file.
# f.atime # => 2022-06-10 11:11:21.200277 -0700
# f.mtime # => 2022-06-10 11:11:21.200277 -0700
# Bundler::FileUtils.touch('src0.txt')
# f = File.new('src0.txt')
# f.atime # => 2022-06-11 08:28:09.8185343 -0700
# f.mtime # => 2022-06-11 08:28:09.8185343 -0700
#
# # Array of paths.
# Bundler::FileUtils.touch(['src0.txt', 'src0.dat'])
#
# Keyword arguments:
#
# - <tt>mtime: <i>time</i></tt> - sets the entry's mtime to the given time,
# instead of the current time.
# - <tt>nocreate: true</tt> - raises an exception if the entry does not exist.
# - <tt>noop: true</tt> - does not touch entries; returns +nil+.
# - <tt>verbose: true</tt> - prints an equivalent command:
#
# Bundler::FileUtils.touch('src0.txt', noop: true, verbose: true)
# Bundler::FileUtils.touch(['src0.txt', 'src0.dat'], noop: true, verbose: true)
# Bundler::FileUtils.touch(path, noop: true, verbose: true)
#
# Output:
#
# touch src0.txt
# touch src0.txt src0.dat
# touch src0.txt
#
# Related: Bundler::FileUtils.uptodate?.
#
def touch(list, noop: nil, verbose: nil, mtime: nil, nocreate: nil)
list = fu_list(list)
t = mtime
if verbose
fu_output_message "touch #{nocreate ? '-c ' : ''}#{t ? t.strftime('-t %Y%m%d%H%M.%S ') : ''}#{list.join ' '}"
end
return if noop
list.each do |path|
created = nocreate
begin
File.utime(t, t, path)
rescue Errno::ENOENT
raise if created
File.open(path, 'a') {
;
}
created = true
retry if t
end
end
end
module_function :touch
private
module StreamUtils_
private
case (defined?(::RbConfig) ? ::RbConfig::CONFIG['host_os'] : ::RUBY_PLATFORM)
when /mswin|mingw/
def fu_windows?; true end
else
def fu_windows?; false end
end
def fu_copy_stream0(src, dest, blksize = nil) #:nodoc:
IO.copy_stream(src, dest)
end
def fu_stream_blksize(*streams)
streams.each do |s|
next unless s.respond_to?(:stat)
size = fu_blksize(s.stat)
return size if size
end
fu_default_blksize()
end
def fu_blksize(st)
s = st.blksize
return nil unless s
return nil if s == 0
s
end
def fu_default_blksize
1024
end
end
include StreamUtils_
extend StreamUtils_
class Entry_ #:nodoc: internal use only
include StreamUtils_
def initialize(a, b = nil, deref = false)
@prefix = @rel = @path = nil
if b
@prefix = a
@rel = b
else
@path = a
end
@deref = deref
@stat = nil
@lstat = nil
end
def inspect
"\#<#{self.class} #{path()}>"
end
def path
if @path
File.path(@path)
else
join(@prefix, @rel)
end
end
def prefix
@prefix || @path
end
def rel
@rel
end
def dereference?
@deref
end
def exist?
begin
lstat
true
rescue Errno::ENOENT
false
end
end
def file?
s = lstat!
s and s.file?
end
def directory?
s = lstat!
s and s.directory?
end
def symlink?
s = lstat!
s and s.symlink?
end
def chardev?
s = lstat!
s and s.chardev?
end
def blockdev?
s = lstat!
s and s.blockdev?
end
def socket?
s = lstat!
s and s.socket?
end
def pipe?
s = lstat!
s and s.pipe?
end
S_IF_DOOR = 0xD000
def door?
s = lstat!
s and (s.mode & 0xF000 == S_IF_DOOR)
end
def entries
opts = {}
opts[:encoding] = fu_windows? ? ::Encoding::UTF_8 : path.encoding
files = Dir.children(path, **opts)
untaint = RUBY_VERSION < '2.7'
files.map {|n| Entry_.new(prefix(), join(rel(), untaint ? n.untaint : n)) }
end
def stat
return @stat if @stat
if lstat() and lstat().symlink?
@stat = File.stat(path())
else
@stat = lstat()
end
@stat
end
def stat!
return @stat if @stat
if lstat! and lstat!.symlink?
@stat = File.stat(path())
else
@stat = lstat!
end
@stat
rescue SystemCallError
nil
end
def lstat
if dereference?
@lstat ||= File.stat(path())
else
@lstat ||= File.lstat(path())
end
end
def lstat!
lstat()
rescue SystemCallError
nil
end
def chmod(mode)
if symlink?
File.lchmod mode, path() if have_lchmod?
else
File.chmod mode, path()
end
rescue Errno::EOPNOTSUPP
end
def chown(uid, gid)
if symlink?
File.lchown uid, gid, path() if have_lchown?
else
File.chown uid, gid, path()
end
end
def link(dest)
case
when directory?
if !File.exist?(dest) and descendant_directory?(dest, path)
raise ArgumentError, "cannot link directory %s to itself %s" % [path, dest]
end
begin
Dir.mkdir dest
rescue
raise unless File.directory?(dest)
end
else
File.link path(), dest
end
end
def copy(dest)
lstat
case
when file?
copy_file dest
when directory?
if !File.exist?(dest) and descendant_directory?(dest, path)
raise ArgumentError, "cannot copy directory %s to itself %s" % [path, dest]
end
begin
Dir.mkdir dest
rescue
raise unless File.directory?(dest)
end
when symlink?
File.symlink File.readlink(path()), dest
when chardev?, blockdev?
raise "cannot handle device file"
when socket?
begin
require 'socket'
rescue LoadError
raise "cannot handle socket"
else
raise "cannot handle socket" unless defined?(UNIXServer)
end
UNIXServer.new(dest).close
File.chmod lstat().mode, dest
when pipe?
raise "cannot handle FIFO" unless File.respond_to?(:mkfifo)
File.mkfifo dest, lstat().mode
when door?
raise "cannot handle door: #{path()}"
else
raise "unknown file type: #{path()}"
end
end
def copy_file(dest)
File.open(path()) do |s|
File.open(dest, 'wb', s.stat.mode) do |f|
IO.copy_stream(s, f)
end
end
end
def copy_metadata(path)
st = lstat()
if !st.symlink?
File.utime st.atime, st.mtime, path
end
mode = st.mode
begin
if st.symlink?
begin
File.lchown st.uid, st.gid, path
rescue NotImplementedError
end
else
File.chown st.uid, st.gid, path
end
rescue Errno::EPERM, Errno::EACCES
# clear setuid/setgid
mode &= 01777
end
if st.symlink?
begin
File.lchmod mode, path
rescue NotImplementedError, Errno::EOPNOTSUPP
end
else
File.chmod mode, path
end
end
def remove
if directory?
remove_dir1
else
remove_file
end
end
def remove_dir1
platform_support {
Dir.rmdir path().chomp(?/)
}
end
def remove_file
platform_support {
File.unlink path
}
end
def platform_support
return yield unless fu_windows?
first_time_p = true
begin
yield
rescue Errno::ENOENT
raise
rescue => err
if first_time_p
first_time_p = false
begin
File.chmod 0700, path() # Windows does not have symlink
retry
rescue SystemCallError
end
end
raise err
end
end
def preorder_traverse
stack = [self]
while ent = stack.pop
yield ent
stack.concat ent.entries.reverse if ent.directory?
end
end
alias traverse preorder_traverse
def postorder_traverse
if directory?
begin
children = entries()
rescue Errno::EACCES
# Failed to get the list of children.
# Assuming there is no children, try to process the parent directory.
yield self
return
end
children.each do |ent|
ent.postorder_traverse do |e|
yield e
end
end
end
yield self
end
def wrap_traverse(pre, post)
pre.call self
if directory?
entries.each do |ent|
ent.wrap_traverse pre, post
end
end
post.call self
end
private
@@fileutils_rb_have_lchmod = nil
def have_lchmod?
# This is not MT-safe, but it does not matter.
if @@fileutils_rb_have_lchmod == nil
@@fileutils_rb_have_lchmod = check_have_lchmod?
end
@@fileutils_rb_have_lchmod
end
def check_have_lchmod?
return false unless File.respond_to?(:lchmod)
File.lchmod 0
return true
rescue NotImplementedError
return false
end
@@fileutils_rb_have_lchown = nil
def have_lchown?
# This is not MT-safe, but it does not matter.
if @@fileutils_rb_have_lchown == nil
@@fileutils_rb_have_lchown = check_have_lchown?
end
@@fileutils_rb_have_lchown
end
def check_have_lchown?
return false unless File.respond_to?(:lchown)
File.lchown nil, nil
return true
rescue NotImplementedError
return false
end
def join(dir, base)
return File.path(dir) if not base or base == '.'
return File.path(base) if not dir or dir == '.'
begin
File.join(dir, base)
rescue EncodingError
if fu_windows?
File.join(dir.encode(::Encoding::UTF_8), base.encode(::Encoding::UTF_8))
else
raise
end
end
end
if File::ALT_SEPARATOR
DIRECTORY_TERM = "(?=[/#{Regexp.quote(File::ALT_SEPARATOR)}]|\\z)"
else
DIRECTORY_TERM = "(?=/|\\z)"
end
def descendant_directory?(descendant, ascendant)
if File::FNM_SYSCASE.nonzero?
File.expand_path(File.dirname(descendant)).casecmp(File.expand_path(ascendant)) == 0
else
File.expand_path(File.dirname(descendant)) == File.expand_path(ascendant)
end
end
end # class Entry_
def fu_list(arg) #:nodoc:
[arg].flatten.map {|path| File.path(path) }
end
private_module_function :fu_list
def fu_each_src_dest(src, dest) #:nodoc:
fu_each_src_dest0(src, dest) do |s, d|
raise ArgumentError, "same file: #{s} and #{d}" if fu_same?(s, d)
yield s, d
end
end
private_module_function :fu_each_src_dest
def fu_each_src_dest0(src, dest, target_directory = true) #:nodoc:
if tmp = Array.try_convert(src)
tmp.each do |s|
s = File.path(s)
yield s, (target_directory ? File.join(dest, File.basename(s)) : dest)
end
else
src = File.path(src)
if target_directory and File.directory?(dest)
yield src, File.join(dest, File.basename(src))
else
yield src, File.path(dest)
end
end
end
private_module_function :fu_each_src_dest0
def fu_same?(a, b) #:nodoc:
File.identical?(a, b)
end
private_module_function :fu_same?
def fu_output_message(msg) #:nodoc:
output = @fileutils_output if defined?(@fileutils_output)
output ||= $stdout
if defined?(@fileutils_label)
msg = @fileutils_label + msg
end
output.puts msg
end
private_module_function :fu_output_message
def fu_split_path(path)
path = File.path(path)
list = []
until (parent, base = File.split(path); parent == path or parent == ".")
list << base
path = parent
end
list << path
list.reverse!
end
private_module_function :fu_split_path
def fu_relative_components_from(target, base) #:nodoc:
i = 0
while target[i]&.== base[i]
i += 1
end
Array.new(base.size-i, '..').concat(target[i..-1])
end
private_module_function :fu_relative_components_from
def fu_clean_components(*comp)
comp.shift while comp.first == "."
return comp if comp.empty?
clean = [comp.shift]
path = File.join(*clean, "") # ending with File::SEPARATOR
while c = comp.shift
if c == ".." and clean.last != ".." and !(fu_have_symlink? && File.symlink?(path))
clean.pop
path.chomp!(%r((?<=\A|/)[^/]+/\z), "")
else
clean << c
path << c << "/"
end
end
clean
end
private_module_function :fu_clean_components
if fu_windows?
def fu_starting_path?(path)
path&.start_with?(%r(\w:|/))
end
else
def fu_starting_path?(path)
path&.start_with?("/")
end
end
private_module_function :fu_starting_path?
# This hash table holds command options.
OPT_TABLE = {} #:nodoc: internal use only
(private_instance_methods & methods(false)).inject(OPT_TABLE) {|tbl, name|
(tbl[name.to_s] = instance_method(name).parameters).map! {|t, n| n if t == :key}.compact!
tbl
}
public
# Returns an array of the string names of \Bundler::FileUtils methods
# that accept one or more keyword arguments:
#
# Bundler::FileUtils.commands.sort.take(3) # => ["cd", "chdir", "chmod"]
#
def self.commands
OPT_TABLE.keys
end
# Returns an array of the string keyword names:
#
# Bundler::FileUtils.options.take(3) # => ["noop", "verbose", "force"]
#
def self.options
OPT_TABLE.values.flatten.uniq.map {|sym| sym.to_s }
end
# Returns +true+ if method +mid+ accepts the given option +opt+, +false+ otherwise;
# the arguments may be strings or symbols:
#
# Bundler::FileUtils.have_option?(:chmod, :noop) # => true
# Bundler::FileUtils.have_option?('chmod', 'secure') # => false
#
def self.have_option?(mid, opt)
li = OPT_TABLE[mid.to_s] or raise ArgumentError, "no such method: #{mid}"
li.include?(opt)
end
# Returns an array of the string keyword name for method +mid+;
# the argument may be a string or a symbol:
#
# Bundler::FileUtils.options_of(:rm) # => ["force", "noop", "verbose"]
# Bundler::FileUtils.options_of('mv') # => ["force", "noop", "verbose", "secure"]
#
def self.options_of(mid)
OPT_TABLE[mid.to_s].map {|sym| sym.to_s }
end
# Returns an array of the string method names of the methods
# that accept the given keyword option +opt+;
# the argument must be a symbol:
#
# Bundler::FileUtils.collect_method(:preserve) # => ["cp", "copy", "cp_r", "install"]
#
def self.collect_method(opt)
OPT_TABLE.keys.select {|m| OPT_TABLE[m].include?(opt) }
end
private
LOW_METHODS = singleton_methods(false) - collect_method(:noop).map(&:intern) # :nodoc:
module LowMethods # :nodoc: internal use only
private
def _do_nothing(*)end
::Bundler::FileUtils::LOW_METHODS.map {|name| alias_method name, :_do_nothing}
end
METHODS = singleton_methods() - [:private_module_function, # :nodoc:
:commands, :options, :have_option?, :options_of, :collect_method]
#
# This module has all methods of Bundler::FileUtils module, but it outputs messages
# before acting. This equates to passing the <tt>:verbose</tt> flag to
# methods in Bundler::FileUtils.
#
module Verbose
include Bundler::FileUtils
names = ::Bundler::FileUtils.collect_method(:verbose)
names.each do |name|
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}(*args, **options)
super(*args, **options, verbose: true)
end
EOS
end
private(*names)
extend self
class << self
public(*::Bundler::FileUtils::METHODS)
end
end
#
# This module has all methods of Bundler::FileUtils module, but never changes
# files/directories. This equates to passing the <tt>:noop</tt> flag
# to methods in Bundler::FileUtils.
#
module NoWrite
include Bundler::FileUtils
include LowMethods
names = ::Bundler::FileUtils.collect_method(:noop)
names.each do |name|
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}(*args, **options)
super(*args, **options, noop: true)
end
EOS
end
private(*names)
extend self
class << self
public(*::Bundler::FileUtils::METHODS)
end
end
#
# This module has all methods of Bundler::FileUtils module, but never changes
# files/directories, with printing message before acting.
# This equates to passing the <tt>:noop</tt> and <tt>:verbose</tt> flag
# to methods in Bundler::FileUtils.
#
module DryRun
include Bundler::FileUtils
include LowMethods
names = ::Bundler::FileUtils.collect_method(:noop)
names.each do |name|
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}(*args, **options)
super(*args, **options, noop: true, verbose: true)
end
EOS
end
private(*names)
extend self
class << self
public(*::Bundler::FileUtils::METHODS)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/settings/validator.rb 0000644 00000006054 15173517745 0020312 0 ustar 00 # frozen_string_literal: true
module Bundler
class Settings
class Validator
class Rule
attr_reader :description
def initialize(keys, description, &validate)
@keys = keys
@description = description
@validate = validate
end
def validate!(key, value, settings)
instance_exec(key, value, settings, &@validate)
end
def fail!(key, value, *reasons)
reasons.unshift @description
raise InvalidOption, "Setting `#{key}` to #{value.inspect} failed:\n#{reasons.map {|r| " - #{r}" }.join("\n")}"
end
def set(settings, key, value, *reasons)
hash_key = k(key)
return if settings[hash_key] == value
reasons.unshift @description
Bundler.ui.info "Setting `#{key}` to #{value.inspect}, since #{reasons.join(", ")}"
if value.nil?
settings.delete(hash_key)
else
settings[hash_key] = value
end
end
def k(key)
Bundler.settings.key_for(key)
end
end
def self.rules
@rules ||= Hash.new {|h, k| h[k] = [] }
end
private_class_method :rules
def self.rule(keys, description, &blk)
rule = Rule.new(keys, description, &blk)
keys.each {|k| rules[k] << rule }
end
private_class_method :rule
def self.validate!(key, value, settings)
rules_to_validate = rules[key]
rules_to_validate.each {|rule| rule.validate!(key, value, settings) }
end
rule %w[path path.system], "path and path.system are mutually exclusive" do |key, value, settings|
if key == "path" && value
set(settings, "path.system", nil)
elsif key == "path.system" && value
set(settings, :path, nil)
end
end
rule %w[with without], "a group cannot be in both `with` & `without` simultaneously" do |key, value, settings|
with = settings.fetch(k(:with), "").split(":").map(&:to_sym)
without = settings.fetch(k(:without), "").split(":").map(&:to_sym)
other_key = key == "with" ? :without : :with
other_setting = key == "with" ? without : with
conflicting = with & without
if conflicting.any?
fail!(key, value, "`#{other_key}` is current set to #{other_setting.inspect}", "the `#{conflicting.join("`, `")}` groups conflict")
end
end
rule %w[path], "relative paths are expanded relative to the current working directory" do |key, value, settings|
next if value.nil?
path = Pathname.new(value)
next if !path.relative? || !Bundler.feature_flag.path_relative_to_cwd?
path = path.expand_path
root = begin
Bundler.root
rescue GemfileNotFound
Pathname.pwd.expand_path
end
path = begin
path.relative_path_from(root)
rescue ArgumentError
path
end
set(settings, key, path.to_s)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/force_platform.rb 0000644 00000001040 15173517745 0017455 0 ustar 00 # frozen_string_literal: true
module Bundler
module ForcePlatform
# The `:force_ruby_platform` value used by dependencies for resolution, and
# by locked specifications for materialization is `false` by default, except
# for TruffleRuby. TruffleRuby generally needs to force the RUBY platform
# variant unless the name is explicitly allowlisted.
def default_force_ruby_platform
return false unless RUBY_ENGINE == "truffleruby"
!Gem::Platform::REUSE_AS_BINARY_ON_TRUFFLERUBY.include?(name)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/process_lock.rb 0000644 00000001256 15173517745 0017152 0 ustar 00 # frozen_string_literal: true
module Bundler
class ProcessLock
def self.lock(bundle_path = Bundler.bundle_path)
lock_file_path = File.join(bundle_path, "bundler.lock")
has_lock = false
File.open(lock_file_path, "w") do |f|
f.flock(File::LOCK_EX)
has_lock = true
yield
f.flock(File::LOCK_UN)
end
rescue Errno::EACCES, Errno::ENOLCK, Errno::ENOTSUP, Errno::EPERM, Errno::EROFS
# In the case the user does not have access to
# create the lock file or is using NFS where
# locks are not available we skip locking.
yield
ensure
FileUtils.rm_f(lock_file_path) if has_lock
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/match_metadata.rb 0000644 00000000606 15173517745 0017416 0 ustar 00 # frozen_string_literal: true
module Bundler
module MatchMetadata
def matches_current_metadata?
matches_current_ruby? && matches_current_rubygems?
end
def matches_current_ruby?
@required_ruby_version.satisfied_by?(Gem.ruby_version)
end
def matches_current_rubygems?
@required_rubygems_version.satisfied_by?(Gem.rubygems_version)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/compact_index_client/cache.rb 0000644 00000005377 15173517745 0021712 0 ustar 00 # frozen_string_literal: true
require_relative "gem_parser"
module Bundler
class CompactIndexClient
class Cache
attr_reader :directory
def initialize(directory, fetcher = nil)
@directory = Pathname.new(directory).expand_path
@updater = Updater.new(fetcher) if fetcher
@mutex = Thread::Mutex.new
@endpoints = Set.new
@info_root = mkdir("info")
@special_characters_info_root = mkdir("info-special-characters")
@info_etag_root = mkdir("info-etags")
end
def names
fetch("names", names_path, names_etag_path)
end
def versions
fetch("versions", versions_path, versions_etag_path)
end
def info(name, remote_checksum = nil)
path = info_path(name)
if remote_checksum && remote_checksum != SharedHelpers.checksum_for_file(path, :MD5)
fetch("info/#{name}", path, info_etag_path(name))
else
Bundler::CompactIndexClient.debug { "update skipped info/#{name} (#{remote_checksum ? "versions index checksum is nil" : "versions index checksum matches local"})" }
read(path)
end
end
def reset!
@mutex.synchronize { @endpoints.clear }
end
private
def names_path = directory.join("names")
def names_etag_path = directory.join("names.etag")
def versions_path = directory.join("versions")
def versions_etag_path = directory.join("versions.etag")
def info_path(name)
name = name.to_s
# TODO: converge this into the info_root by hashing all filenames like info_etag_path
if /[^a-z0-9_-]/.match?(name)
name += "-#{SharedHelpers.digest(:MD5).hexdigest(name).downcase}"
@special_characters_info_root.join(name)
else
@info_root.join(name)
end
end
def info_etag_path(name)
name = name.to_s
@info_etag_root.join("#{name}-#{SharedHelpers.digest(:MD5).hexdigest(name).downcase}")
end
def mkdir(name)
directory.join(name).tap do |dir|
SharedHelpers.filesystem_access(dir) do
FileUtils.mkdir_p(dir)
end
end
end
def fetch(remote_path, path, etag_path)
if already_fetched?(remote_path)
Bundler::CompactIndexClient.debug { "already fetched #{remote_path}" }
else
Bundler::CompactIndexClient.debug { "fetching #{remote_path}" }
@updater&.update(remote_path, path, etag_path)
end
read(path)
end
def already_fetched?(remote_path)
@mutex.synchronize { !@endpoints.add?(remote_path) }
end
def read(path)
return unless path.file?
SharedHelpers.filesystem_access(path, :read, &:read)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/compact_index_client/cache_file.rb 0000644 00000011073 15173517745 0022677 0 ustar 00 # frozen_string_literal: true
require_relative "../vendored_fileutils"
require "rubygems/package"
module Bundler
class CompactIndexClient
# write cache files in a way that is robust to concurrent modifications
# if digests are given, the checksums will be verified
class CacheFile
DEFAULT_FILE_MODE = 0o644
private_constant :DEFAULT_FILE_MODE
class Error < RuntimeError; end
class ClosedError < Error; end
class DigestMismatchError < Error
def initialize(digests, expected_digests)
super "Calculated checksums #{digests.inspect} did not match expected #{expected_digests.inspect}."
end
end
# Initialize with a copy of the original file, then yield the instance.
def self.copy(path, &block)
new(path) do |file|
file.initialize_digests
SharedHelpers.filesystem_access(path, :read) do
path.open("rb") do |s|
file.open {|f| IO.copy_stream(s, f) }
end
end
yield file
end
end
# Write data to a temp file, then replace the original file with it verifying the digests if given.
def self.write(path, data, digests = nil)
return unless data
new(path) do |file|
file.digests = digests
file.write(data)
end
end
attr_reader :original_path, :path
def initialize(original_path, &block)
@original_path = original_path
@perm = original_path.file? ? original_path.stat.mode : DEFAULT_FILE_MODE
@path = original_path.sub(/$/, ".#{$$}.tmp")
return unless block_given?
begin
yield self
ensure
close
end
end
def size
path.size
end
# initialize the digests using CompactIndexClient::SUPPORTED_DIGESTS, or a subset based on keys.
def initialize_digests(keys = nil)
@digests = keys ? SUPPORTED_DIGESTS.slice(*keys) : SUPPORTED_DIGESTS.dup
@digests.transform_values! {|algo_class| SharedHelpers.digest(algo_class).new }
end
# reset the digests so they don't contain any previously read data
def reset_digests
@digests&.each_value(&:reset)
end
# set the digests that will be verified at the end
def digests=(expected_digests)
@expected_digests = expected_digests
if @expected_digests.nil?
@digests = nil
elsif @digests
@digests = @digests.slice(*@expected_digests.keys)
else
initialize_digests(@expected_digests.keys)
end
end
# remove this method when we stop generating md5 digests for legacy etags
def md5
@digests && @digests["md5"]
end
def digests?
@digests&.any?
end
# Open the temp file for writing, reusing original permissions, yielding the IO object.
def open(write_mode = "wb", perm = @perm, &block)
raise ClosedError, "Cannot reopen closed file" if @closed
SharedHelpers.filesystem_access(path, :write) do
path.open(write_mode, perm) do |f|
yield digests? ? Gem::Package::DigestIO.new(f, @digests) : f
end
end
end
# Returns false without appending when no digests since appending is too error prone to do without digests.
def append(data)
return false unless digests?
open("a") {|f| f.write data }
verify && commit
end
def write(data)
reset_digests
open {|f| f.write data }
commit!
end
def commit!
verify || raise(DigestMismatchError.new(@base64digests, @expected_digests))
commit
end
# Verify the digests, returning true on match, false on mismatch.
def verify
return true unless @expected_digests && digests?
@base64digests = @digests.transform_values!(&:base64digest)
@digests = nil
@base64digests.all? {|algo, digest| @expected_digests[algo] == digest }
end
# Replace the original file with the temp file without verifying digests.
# The file is permanently closed.
def commit
raise ClosedError, "Cannot commit closed file" if @closed
SharedHelpers.filesystem_access(original_path, :write) do
FileUtils.mv(path, original_path)
end
@closed = true
end
# Remove the temp file without replacing the original file.
# The file is permanently closed.
def close
return if @closed
FileUtils.remove_file(path) if @path&.file?
@closed = true
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/compact_index_client/updater.rb 0000644 00000010545 15173517745 0022304 0 ustar 00 # frozen_string_literal: true
module Bundler
class CompactIndexClient
class Updater
class MismatchedChecksumError < Error
def initialize(path, message)
super "The checksum of /#{path} does not match the checksum provided by the server! Something is wrong. #{message}"
end
end
def initialize(fetcher)
@fetcher = fetcher
end
def update(remote_path, local_path, etag_path)
append(remote_path, local_path, etag_path) || replace(remote_path, local_path, etag_path)
rescue CacheFile::DigestMismatchError => e
raise MismatchedChecksumError.new(remote_path, e.message)
rescue Zlib::GzipFile::Error
raise Bundler::HTTPError
end
private
def append(remote_path, local_path, etag_path)
return false unless local_path.file? && local_path.size.nonzero?
CacheFile.copy(local_path) do |file|
etag = etag_path.read.tap(&:chomp!) if etag_path.file?
etag ||= generate_etag(etag_path, file) # Remove this after 2.5.0 has been out for a while.
# Subtract a byte to ensure the range won't be empty.
# Avoids 416 (Range Not Satisfiable) responses.
response = @fetcher.call(remote_path, request_headers(etag, file.size - 1))
break true if response.is_a?(Gem::Net::HTTPNotModified)
file.digests = parse_digests(response)
# server may ignore Range and return the full response
if response.is_a?(Gem::Net::HTTPPartialContent)
break false unless file.append(response.body.byteslice(1..-1))
else
file.write(response.body)
end
CacheFile.write(etag_path, etag_from_response(response))
true
end
end
# request without range header to get the full file or a 304 Not Modified
def replace(remote_path, local_path, etag_path)
etag = etag_path.read.tap(&:chomp!) if etag_path.file?
response = @fetcher.call(remote_path, request_headers(etag))
return true if response.is_a?(Gem::Net::HTTPNotModified)
CacheFile.write(local_path, response.body, parse_digests(response))
CacheFile.write(etag_path, etag_from_response(response))
end
def request_headers(etag, range_start = nil)
headers = {}
headers["Range"] = "bytes=#{range_start}-" if range_start
headers["If-None-Match"] = %("#{etag}") if etag
headers
end
def etag_for_request(etag_path)
etag_path.read.tap(&:chomp!) if etag_path.file?
end
# When first releasing this opaque etag feature, we want to generate the old MD5 etag
# based on the content of the file. After that it will always use the saved opaque etag.
# This transparently saves existing users with good caches from updating a bunch of files.
# Remove this behavior after 2.5.0 has been out for a while.
def generate_etag(etag_path, file)
etag = file.md5.hexdigest
CacheFile.write(etag_path, etag)
etag
end
def etag_from_response(response)
return unless response["ETag"]
etag = response["ETag"].delete_prefix("W/")
return if etag.delete_prefix!('"') && !etag.delete_suffix!('"')
etag
end
# Unwraps and returns a Hash of digest algorithms and base64 values
# according to RFC 8941 Structured Field Values for HTTP.
# https://www.rfc-editor.org/rfc/rfc8941#name-parsing-a-byte-sequence
# Ignores unsupported algorithms.
def parse_digests(response)
return unless header = response["Repr-Digest"] || response["Digest"]
digests = {}
header.split(",") do |param|
algorithm, value = param.split("=", 2)
algorithm.strip!
algorithm.downcase!
next unless SUPPORTED_DIGESTS.key?(algorithm)
next unless value = byte_sequence(value)
digests[algorithm] = value
end
digests.empty? ? nil : digests
end
# Unwrap surrounding colons (byte sequence)
# The wrapping characters must be matched or we return nil.
# Also handles quotes because right now rubygems.org sends them.
def byte_sequence(value)
return if value.delete_prefix!(":") && !value.delete_suffix!(":")
return if value.delete_prefix!('"') && !value.delete_suffix!('"')
value
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/compact_index_client/gem_parser.rb 0000644 00000002040 15173517745 0022753 0 ustar 00 # frozen_string_literal: true
module Bundler
class CompactIndexClient
if defined?(Gem::Resolver::APISet::GemParser)
GemParser = Gem::Resolver::APISet::GemParser
else
class GemParser
EMPTY_ARRAY = [].freeze
private_constant :EMPTY_ARRAY
def parse(line)
version_and_platform, rest = line.split(" ", 2)
version, platform = version_and_platform.split("-", 2)
dependencies, requirements = rest.split("|", 2).map! {|s| s.split(",") } if rest
dependencies = dependencies ? dependencies.map! {|d| parse_dependency(d) } : EMPTY_ARRAY
requirements = requirements ? requirements.map! {|d| parse_dependency(d) } : EMPTY_ARRAY
[version, platform, dependencies, requirements]
end
private
def parse_dependency(string)
dependency = string.split(":")
dependency[-1] = dependency[-1].split("&") if dependency.size > 1
dependency[0] = -dependency[0]
dependency
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/compact_index_client/parser.rb 0000644 00000005211 15173517745 0022126 0 ustar 00 # frozen_string_literal: true
module Bundler
class CompactIndexClient
class Parser
# `compact_index` - an object responding to #names, #versions, #info(name, checksum),
# returning the file contents as a string
def initialize(compact_index)
@compact_index = compact_index
@info_checksums = nil
@versions_by_name = nil
@available = nil
@gem_parser = nil
end
def names
lines(@compact_index.names)
end
def versions
@versions_by_name ||= Hash.new {|hash, key| hash[key] = [] }
@info_checksums = {}
lines(@compact_index.versions).each do |line|
name, versions_string, checksum = line.split(" ", 3)
@info_checksums[name] = checksum || ""
versions_string.split(",") do |version|
delete = version.delete_prefix!("-")
version = version.split("-", 2).unshift(name)
if delete
@versions_by_name[name].delete(version)
else
@versions_by_name[name] << version
end
end
end
@versions_by_name
end
def info(name)
data = @compact_index.info(name, info_checksums[name])
lines(data).map {|line| gem_parser.parse(line).unshift(name) }
end
def available?
return @available unless @available.nil?
@available = !info_checksums.empty?
end
private
def info_checksums
@info_checksums ||= lines(@compact_index.versions).each_with_object({}) do |line, checksums|
parse_version_checksum(line, checksums)
end
end
def lines(data)
return [] if data.nil? || data.empty?
lines = data.split("\n")
header = lines.index("---")
header ? lines[header + 1..-1] : lines
end
def gem_parser
@gem_parser ||= GemParser.new
end
# This is mostly the same as `split(" ", 3)` but it avoids allocating extra objects.
# This method gets called at least once for every gem when parsing versions.
def parse_version_checksum(line, checksums)
return unless (name_end = line.index(" ")) # Artifactory bug causes blank lines in artifactor index files
return unless (checksum_start = line.index(" ", name_end + 1) + 1)
checksum_end = line.size - checksum_start
line.freeze # allows slicing into the string to not allocate a copy of the line
name = line[0, name_end]
checksum = line[checksum_start, checksum_end]
checksums[name.freeze] = checksum # freeze name since it is used as a hash key
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/gem_helpers.rb 0000644 00000011346 15173517745 0016757 0 ustar 00 # frozen_string_literal: true
module Bundler
module GemHelpers
GENERIC_CACHE = { Gem::Platform::RUBY => Gem::Platform::RUBY } # rubocop:disable Style/MutableConstant
GENERICS = [
[Gem::Platform.new("java"), Gem::Platform.new("java")],
[Gem::Platform.new("mswin32"), Gem::Platform.new("mswin32")],
[Gem::Platform.new("mswin64"), Gem::Platform.new("mswin64")],
[Gem::Platform.new("universal-mingw32"), Gem::Platform.new("universal-mingw32")],
[Gem::Platform.new("x64-mingw32"), Gem::Platform.new("x64-mingw32")],
[Gem::Platform.new("x86_64-mingw32"), Gem::Platform.new("x64-mingw32")],
[Gem::Platform.new("x64-mingw-ucrt"), Gem::Platform.new("x64-mingw-ucrt")],
[Gem::Platform.new("mingw32"), Gem::Platform.new("x86-mingw32")],
].freeze
def generic(p)
GENERIC_CACHE[p] ||= begin
_, found = GENERICS.find do |match, _generic|
p.os == match.os && (!match.cpu || p.cpu == match.cpu)
end
found || Gem::Platform::RUBY
end
end
module_function :generic
def generic_local_platform
generic(local_platform)
end
module_function :generic_local_platform
def local_platform
Bundler.local_platform
end
module_function :local_platform
def generic_local_platform_is_ruby?
generic_local_platform == Gem::Platform::RUBY
end
module_function :generic_local_platform_is_ruby?
def platform_specificity_match(spec_platform, user_platform)
spec_platform = Gem::Platform.new(spec_platform)
PlatformMatch.specificity_score(spec_platform, user_platform)
end
module_function :platform_specificity_match
def select_best_platform_match(specs, platform, force_ruby: false, prefer_locked: false)
matching = if force_ruby
specs.select {|spec| spec.match_platform(Gem::Platform::RUBY) && spec.force_ruby_platform! }
else
specs.select {|spec| spec.match_platform(platform) }
end
if prefer_locked
locked_originally = matching.select {|spec| spec.is_a?(LazySpecification) }
return locked_originally if locked_originally.any?
end
sort_best_platform_match(matching, platform)
end
module_function :select_best_platform_match
def select_best_local_platform_match(specs, force_ruby: false)
select_best_platform_match(specs, local_platform, force_ruby: force_ruby).map(&:materialize_for_installation).compact
end
module_function :select_best_local_platform_match
def sort_best_platform_match(matching, platform)
exact = matching.select {|spec| spec.platform == platform }
return exact if exact.any?
sorted_matching = matching.sort_by {|spec| platform_specificity_match(spec.platform, platform) }
exemplary_spec = sorted_matching.first
sorted_matching.take_while {|spec| same_specificity(platform, spec, exemplary_spec) && same_deps(spec, exemplary_spec) }
end
module_function :sort_best_platform_match
class PlatformMatch
def self.specificity_score(spec_platform, user_platform)
return -1 if spec_platform == user_platform
return 1_000_000 if spec_platform.nil? || spec_platform == Gem::Platform::RUBY || user_platform == Gem::Platform::RUBY
os_match(spec_platform, user_platform) +
cpu_match(spec_platform, user_platform) * 10 +
platform_version_match(spec_platform, user_platform) * 100
end
def self.os_match(spec_platform, user_platform)
if spec_platform.os == user_platform.os
0
else
1
end
end
def self.cpu_match(spec_platform, user_platform)
if spec_platform.cpu == user_platform.cpu
0
elsif spec_platform.cpu == "arm" && user_platform.cpu.to_s.start_with?("arm")
0
elsif spec_platform.cpu.nil? || spec_platform.cpu == "universal"
1
else
2
end
end
def self.platform_version_match(spec_platform, user_platform)
if spec_platform.version == user_platform.version
0
elsif spec_platform.version.nil?
1
else
2
end
end
end
def same_specificity(platform, spec, exemplary_spec)
platform_specificity_match(spec.platform, platform) == platform_specificity_match(exemplary_spec.platform, platform)
end
module_function :same_specificity
def same_deps(spec, exemplary_spec)
same_runtime_deps = spec.dependencies.sort == exemplary_spec.dependencies.sort
same_metadata_deps = spec.required_ruby_version == exemplary_spec.required_ruby_version && spec.required_rubygems_version == exemplary_spec.required_rubygems_version
same_runtime_deps && same_metadata_deps
end
module_function :same_deps
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/installer.rb 0000644 00000023735 15173517745 0016467 0 ustar 00 # frozen_string_literal: true
require_relative "worker"
require_relative "installer/parallel_installer"
require_relative "installer/standalone"
require_relative "installer/gem_installer"
module Bundler
class Installer
class << self
attr_accessor :ambiguous_gems
Installer.ambiguous_gems = []
end
attr_reader :post_install_messages, :definition
# Begins the installation process for Bundler.
# For more information see the #run method on this class.
def self.install(root, definition, options = {})
installer = new(root, definition)
Plugin.hook(Plugin::Events::GEM_BEFORE_INSTALL_ALL, definition.dependencies)
installer.run(options)
Plugin.hook(Plugin::Events::GEM_AFTER_INSTALL_ALL, definition.dependencies)
installer
end
def initialize(root, definition)
@root = root
@definition = definition
@post_install_messages = {}
end
# Runs the install procedures for a specific Gemfile.
#
# Firstly, this method will check to see if `Bundler.bundle_path` exists
# and if not then Bundler will create the directory. This is usually the same
# location as RubyGems which typically is the `~/.gem` directory
# unless other specified.
#
# Secondly, it checks if Bundler has been configured to be "frozen".
# Frozen ensures that the Gemfile and the Gemfile.lock file are matching.
# This stops a situation where a developer may update the Gemfile but may not run
# `bundle install`, which leads to the Gemfile.lock file not being correctly updated.
# If this file is not correctly updated then any other developer running
# `bundle install` will potentially not install the correct gems.
#
# Thirdly, Bundler checks if there are any dependencies specified in the Gemfile.
# If there are no dependencies specified then Bundler returns a warning message stating
# so and this method returns.
#
# Fourthly, Bundler checks if the Gemfile.lock exists, and if so
# then proceeds to set up a definition based on the Gemfile and the Gemfile.lock.
# During this step Bundler will also download information about any new gems
# that are not in the Gemfile.lock and resolve any dependencies if needed.
#
# Fifthly, Bundler resolves the dependencies either through a cache of gems or by remote.
# This then leads into the gems being installed, along with stubs for their executables,
# but only if the --binstubs option has been passed or Bundler.options[:bin] has been set
# earlier.
#
# Sixthly, a new Gemfile.lock is created from the installed gems to ensure that the next time
# that a user runs `bundle install` they will receive any updates from this process.
#
# Finally, if the user has specified the standalone flag, Bundler will generate the needed
# require paths and save them in a `setup.rb` file. See `bundle standalone --help` for more
# information.
def run(options)
Bundler.create_bundle_path
ProcessLock.lock do
@definition.ensure_equivalent_gemfile_and_lockfile(options[:deployment])
if @definition.dependencies.empty?
Bundler.ui.warn "The Gemfile specifies no dependencies"
lock
return
end
if resolve_if_needed(options)
ensure_specs_are_compatible!
load_plugins
options.delete(:jobs)
else
options[:jobs] = 1 # to avoid the overhead of Bundler::Worker
end
install(options)
Gem::Specification.reset # invalidate gem specification cache so that installed gems are immediately available
lock
Standalone.new(options[:standalone], @definition).generate if options[:standalone]
end
end
def generate_bundler_executable_stubs(spec, options = {})
if options[:binstubs_cmd] && spec.executables.empty?
options = {}
spec.runtime_dependencies.each do |dep|
bins = @definition.specs[dep].first.executables
options[dep.name] = bins unless bins.empty?
end
if options.any?
Bundler.ui.warn "#{spec.name} has no executables, but you may want " \
"one from a gem it depends on."
options.each {|name, bins| Bundler.ui.warn " #{name} has: #{bins.join(", ")}" }
else
Bundler.ui.warn "There are no executables for the gem #{spec.name}."
end
return
end
# double-assignment to avoid warnings about variables that will be used by ERB
bin_path = Bundler.bin_path
bin_path = bin_path
relative_gemfile_path = Bundler.default_gemfile.relative_path_from(bin_path)
relative_gemfile_path = relative_gemfile_path
ruby_command = Thor::Util.ruby_command
ruby_command = ruby_command
template_path = File.expand_path("templates/Executable", __dir__)
if spec.name == "bundler"
template_path += ".bundler"
spec.executables = %(bundle)
end
template = File.read(template_path)
exists = []
spec.executables.each do |executable|
binstub_path = "#{bin_path}/#{executable}"
if File.exist?(binstub_path) && !options[:force]
exists << executable
next
end
mode = Gem.win_platform? ? "wb:UTF-8" : "w"
require "erb"
content = ERB.new(template, trim_mode: "-").result(binding)
File.write(binstub_path, content, mode: mode, perm: 0o777 & ~File.umask)
if Gem.win_platform? || options[:all_platforms]
prefix = "@ruby -x \"%~f0\" %*\n@exit /b %ERRORLEVEL%\n\n"
File.write("#{binstub_path}.cmd", prefix + content, mode: mode)
end
end
if options[:binstubs_cmd] && exists.any?
case exists.size
when 1
Bundler.ui.warn "Skipped #{exists[0]} since it already exists."
when 2
Bundler.ui.warn "Skipped #{exists.join(" and ")} since they already exist."
else
items = exists[0...-1].empty? ? nil : exists[0...-1].join(", ")
skipped = [items, exists[-1]].compact.join(" and ")
Bundler.ui.warn "Skipped #{skipped} since they already exist."
end
Bundler.ui.warn "If you want to overwrite skipped stubs, use --force."
end
end
def generate_standalone_bundler_executable_stubs(spec, options = {})
# double-assignment to avoid warnings about variables that will be used by ERB
bin_path = Bundler.bin_path
unless path = Bundler.settings[:path]
raise "Can't standalone without an explicit path set"
end
standalone_path = Bundler.root.join(path).relative_path_from(bin_path)
standalone_path = standalone_path
template = File.read(File.expand_path("templates/Executable.standalone", __dir__))
ruby_command = Thor::Util.ruby_command
ruby_command = ruby_command
spec.executables.each do |executable|
next if executable == "bundle"
executable_path = Pathname(spec.full_gem_path).join(spec.bindir, executable).relative_path_from(bin_path)
executable_path = executable_path
mode = Gem.win_platform? ? "wb:UTF-8" : "w"
require "erb"
content = ERB.new(template, trim_mode: "-").result(binding)
File.write("#{bin_path}/#{executable}", content, mode: mode, perm: 0o755)
if Gem.win_platform? || options[:all_platforms]
prefix = "@ruby -x \"%~f0\" %*\n@exit /b %ERRORLEVEL%\n\n"
File.write("#{bin_path}/#{executable}.cmd", prefix + content, mode: mode)
end
end
end
private
# the order that the resolver provides is significant, since
# dependencies might affect the installation of a gem.
# that said, it's a rare situation (other than rake), and parallel
# installation is SO MUCH FASTER. so we let people opt in.
def install(options)
standalone = options[:standalone]
force = options[:force]
local = options[:local]
jobs = installation_parallelization(options)
spec_installations = ParallelInstaller.call(self, @definition.specs, jobs, standalone, force, local: local)
spec_installations.each do |installation|
post_install_messages[installation.name] = installation.post_install_message if installation.has_post_install_message?
end
end
def installation_parallelization(options)
if jobs = options.delete(:jobs)
return jobs
end
if jobs = Bundler.settings[:jobs]
return jobs
end
Bundler.settings.processor_count
end
def load_plugins
Gem.load_plugins
requested_path_gems = @definition.requested_specs.select {|s| s.source.is_a?(Source::Path) }
path_plugin_files = requested_path_gems.map do |spec|
spec.matches_for_glob("rubygems_plugin#{Bundler.rubygems.suffix_pattern}")
rescue TypeError
error_message = "#{spec.name} #{spec.version} has an invalid gemspec"
raise Gem::InvalidSpecificationException, error_message
end.flatten
Gem.load_plugin_files(path_plugin_files)
Gem.load_env_plugins
end
def ensure_specs_are_compatible!
@definition.specs.each do |spec|
unless spec.matches_current_ruby?
raise InstallError, "#{spec.full_name} requires ruby version #{spec.required_ruby_version}, " \
"which is incompatible with the current version, #{Gem.ruby_version}"
end
unless spec.matches_current_rubygems?
raise InstallError, "#{spec.full_name} requires rubygems version #{spec.required_rubygems_version}, " \
"which is incompatible with the current version, #{Gem.rubygems_version}"
end
end
end
# returns whether or not a re-resolve was needed
def resolve_if_needed(options)
@definition.prefer_local! if options[:"prefer-local"]
if options[:local] || (@definition.no_resolve_needed? && !@definition.missing_specs?)
@definition.resolve_with_cache!
false
else
@definition.resolve_remotely!
true
end
end
def lock
@definition.lock
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin.rb 0000644 00000026650 15173517745 0015767 0 ustar 00 # frozen_string_literal: true
require_relative "plugin/api"
module Bundler
module Plugin
autoload :DSL, File.expand_path("plugin/dsl", __dir__)
autoload :Events, File.expand_path("plugin/events", __dir__)
autoload :Index, File.expand_path("plugin/index", __dir__)
autoload :Installer, File.expand_path("plugin/installer", __dir__)
autoload :SourceList, File.expand_path("plugin/source_list", __dir__)
class MalformattedPlugin < PluginError; end
class UndefinedCommandError < PluginError; end
class UnknownSourceError < PluginError; end
class PluginInstallError < PluginError; end
PLUGIN_FILE_NAME = "plugins.rb"
module_function
def reset!
instance_variables.each {|i| remove_instance_variable(i) }
@sources = {}
@commands = {}
@hooks_by_event = Hash.new {|h, k| h[k] = [] }
@loaded_plugin_names = []
end
reset!
# Installs a new plugin by the given name
#
# @param [Array<String>] names the name of plugin to be installed
# @param [Hash] options various parameters as described in description.
# Refer to cli/plugin for available options
def install(names, options)
raise InvalidOption, "You cannot specify `--branch` and `--ref` at the same time." if options["branch"] && options["ref"]
specs = Installer.new.install(names, options)
save_plugins names, specs
rescue PluginError
specs_to_delete = specs.select {|k, _v| names.include?(k) && !index.commands.values.include?(k) }
specs_to_delete.each_value {|spec| Bundler.rm_rf(spec.full_gem_path) }
raise
end
# Uninstalls plugins by the given names
#
# @param [Array<String>] names the names of plugins to be uninstalled
def uninstall(names, options)
if names.empty? && !options[:all]
Bundler.ui.error "No plugins to uninstall. Specify at least 1 plugin to uninstall.\n"\
"Use --all option to uninstall all the installed plugins."
return
end
names = index.installed_plugins if options[:all]
if names.any?
names.each do |name|
if index.installed?(name)
path = index.plugin_path(name).to_s
Bundler.rm_rf(path) if index.installed_in_plugin_root?(name)
index.unregister_plugin(name)
Bundler.ui.info "Uninstalled plugin #{name}"
else
Bundler.ui.error "Plugin #{name} is not installed \n"
end
end
else
Bundler.ui.info "No plugins installed"
end
end
# List installed plugins and commands
#
def list
installed_plugins = index.installed_plugins
if installed_plugins.any?
output = String.new
installed_plugins.each do |plugin|
output << "#{plugin}\n"
output << "-----\n"
index.plugin_commands(plugin).each do |command|
output << " #{command}\n"
end
output << "\n"
end
else
output = "No plugins installed"
end
Bundler.ui.info output
end
# Evaluates the Gemfile with a limited DSL and installs the plugins
# specified by plugin method
#
# @param [Pathname] gemfile path
# @param [Proc] block that can be evaluated for (inline) Gemfile
def gemfile_install(gemfile = nil, &inline)
Bundler.settings.temporary(frozen: false, deployment: false) do
builder = DSL.new
if block_given?
builder.instance_eval(&inline)
else
builder.eval_gemfile(gemfile)
end
builder.check_primary_source_safety
definition = builder.to_definition(nil, true)
return if definition.dependencies.empty?
plugins = definition.dependencies.map(&:name).reject {|p| index.installed? p }
installed_specs = Installer.new.install_definition(definition)
save_plugins plugins, installed_specs, builder.inferred_plugins
end
rescue RuntimeError => e
unless e.is_a?(GemfileError)
Bundler.ui.error "Failed to install plugin: #{e.message}\n #{e.backtrace[0]}"
end
raise
end
# The index object used to store the details about the plugin
def index
@index ||= Index.new
end
# The directory root for all plugin related data
#
# If run in an app, points to local root, in app_config_path
# Otherwise, points to global root, in Bundler.user_bundle_path("plugin")
def root
@root ||= if SharedHelpers.in_bundle?
local_root
else
global_root
end
end
def local_root
Bundler.app_config_path.join("plugin")
end
# The global directory root for all plugin related data
def global_root
Bundler.user_bundle_path("plugin")
end
# The cache directory for plugin stuffs
def cache
@cache ||= root.join("cache")
end
# To be called via the API to register to handle a command
def add_command(command, cls)
@commands[command] = cls
end
# Checks if any plugin handles the command
def command?(command)
!index.command_plugin(command).nil?
end
# To be called from Cli class to pass the command and argument to
# appropriate plugin class
def exec_command(command, args)
raise UndefinedCommandError, "Command `#{command}` not found" unless command? command
load_plugin index.command_plugin(command) unless @commands.key? command
@commands[command].new.exec(command, args)
end
# To be called via the API to register to handle a source plugin
def add_source(source, cls)
@sources[source] = cls
end
# Checks if any plugin declares the source
def source?(name)
!index.source_plugin(name.to_s).nil?
end
# @return [Class] that handles the source. The class includes API::Source
def source(name)
raise UnknownSourceError, "Source #{name} not found" unless source? name
load_plugin(index.source_plugin(name)) unless @sources.key? name
@sources[name]
end
# @param [Hash] The options that are present in the lock file
# @return [API::Source] the instance of the class that handles the source
# type passed in locked_opts
def from_lock(locked_opts)
src = source(locked_opts["type"])
src.new(locked_opts.merge("uri" => locked_opts["remote"]))
end
# To be called via the API to register a hooks and corresponding block that
# will be called to handle the hook
def add_hook(event, &block)
unless Events.defined_event?(event)
raise ArgumentError, "Event '#{event}' not defined in Bundler::Plugin::Events"
end
@hooks_by_event[event.to_s] << block
end
# Runs all the hooks that are registered for the passed event
#
# It passes the passed arguments and block to the block registered with
# the api.
#
# @param [String] event
def hook(event, *args, &arg_blk)
return unless Bundler.feature_flag.plugins?
unless Events.defined_event?(event)
raise ArgumentError, "Event '#{event}' not defined in Bundler::Plugin::Events"
end
plugins = index.hook_plugins(event)
return unless plugins.any?
plugins.each {|name| load_plugin(name) }
@hooks_by_event[event].each {|blk| blk.call(*args, &arg_blk) }
end
# currently only intended for specs
#
# @return [String, nil] installed path
def installed?(plugin)
Index.new.installed?(plugin)
end
# @return [true, false] whether the plugin is loaded
def loaded?(plugin)
@loaded_plugin_names.include?(plugin)
end
# Post installation processing and registering with index
#
# @param [Array<String>] plugins list to be installed
# @param [Hash] specs of plugins mapped to installation path (currently they
# contain all the installed specs, including plugins)
# @param [Array<String>] names of inferred source plugins that can be ignored
def save_plugins(plugins, specs, optional_plugins = [])
plugins.each do |name|
next if index.installed?(name)
spec = specs[name]
save_plugin(name, spec, optional_plugins.include?(name))
end
end
# Checks if the gem is good to be a plugin
#
# At present it only checks whether it contains plugins.rb file
#
# @param [Pathname] plugin_path the path plugin is installed at
# @raise [MalformattedPlugin] if plugins.rb file is not found
def validate_plugin!(plugin_path)
plugin_file = plugin_path.join(PLUGIN_FILE_NAME)
raise MalformattedPlugin, "#{PLUGIN_FILE_NAME} was not found in the plugin." unless plugin_file.file?
end
# Validates and registers a plugin.
#
# @param [String] name the name of the plugin
# @param [Specification] spec of installed plugin
# @param [Boolean] optional_plugin, removed if there is conflict with any
# other plugin (used for default source plugins)
#
# @raise [PluginInstallError] if validation or registration raises any error
def save_plugin(name, spec, optional_plugin = false)
validate_plugin! Pathname.new(spec.full_gem_path)
installed = register_plugin(name, spec, optional_plugin)
Bundler.ui.info "Installed plugin #{name}" if installed
rescue PluginError => e
raise PluginInstallError, "Failed to install plugin `#{spec.name}`, due to #{e.class} (#{e.message})"
end
# Runs the plugins.rb file in an isolated namespace, records the plugin
# actions it registers for and then passes the data to index to be stored.
#
# @param [String] name the name of the plugin
# @param [Specification] spec of installed plugin
# @param [Boolean] optional_plugin, removed if there is conflict with any
# other plugin (used for default source plugins)
#
# @raise [MalformattedPlugin] if plugins.rb raises any error
def register_plugin(name, spec, optional_plugin = false)
commands = @commands
sources = @sources
hooks = @hooks_by_event
@commands = {}
@sources = {}
@hooks_by_event = Hash.new {|h, k| h[k] = [] }
load_paths = spec.load_paths
Gem.add_to_load_path(*load_paths)
path = Pathname.new spec.full_gem_path
begin
load path.join(PLUGIN_FILE_NAME), true
rescue StandardError => e
raise MalformattedPlugin, "#{e.class}: #{e.message}"
end
if optional_plugin && @sources.keys.any? {|s| source? s }
Bundler.rm_rf(path)
false
else
index.register_plugin(name, path.to_s, load_paths, @commands.keys,
@sources.keys, @hooks_by_event.keys)
true
end
ensure
@commands = commands
@sources = sources
@hooks_by_event = hooks
end
# Executes the plugins.rb file
#
# @param [String] name of the plugin
def load_plugin(name)
return unless name && !name.empty?
return if loaded?(name)
# Need to ensure before this that plugin root where the rest of gems
# are installed to be on load path to support plugin deps. Currently not
# done to avoid conflicts
path = index.plugin_path(name)
Gem.add_to_load_path(*index.load_paths(name))
load path.join(PLUGIN_FILE_NAME)
@loaded_plugin_names << name
rescue RuntimeError => e
Bundler.ui.error "Failed loading plugin #{name}: #{e.message}"
raise
end
class << self
private :load_plugin, :register_plugin, :save_plugins, :validate_plugin!
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/ruby_version.rb 0000644 00000011271 15173517745 0017210 0 ustar 00 # frozen_string_literal: true
module Bundler
class RubyVersion
attr_reader :versions,
:patchlevel,
:engine,
:engine_versions,
:gem_version,
:engine_gem_version
def initialize(versions, patchlevel, engine, engine_version)
# The parameters to this method must satisfy the
# following constraints, which are verified in
# the DSL:
#
# * If an engine is specified, an engine version
# must also be specified
# * If an engine version is specified, an engine
# must also be specified
# * If the engine is "ruby", the engine version
# must not be specified, or the engine version
# specified must match the version.
@versions = Array(versions).map do |v|
normalized_v = normalize_version(v)
unless Gem::Requirement::PATTERN.match?(normalized_v)
raise InvalidArgumentError, "#{v} is not a valid requirement on the Ruby version"
end
op, v = Gem::Requirement.parse(normalized_v)
op == "=" ? v.to_s : "#{op} #{v}"
end
@gem_version = Gem::Requirement.create(@versions.first).requirements.first.last
@input_engine = engine&.to_s
@engine = engine&.to_s || "ruby"
@engine_versions = (engine_version && Array(engine_version)) || @versions
@engine_gem_version = Gem::Requirement.create(@engine_versions.first).requirements.first.last
@patchlevel = patchlevel || (@gem_version.prerelease? ? "-1" : nil)
end
def to_s(versions = self.versions)
output = String.new("ruby #{versions_string(versions)}")
output << "p#{patchlevel}" if patchlevel && patchlevel != "-1"
output << " (#{engine} #{versions_string(engine_versions)})" unless engine == "ruby"
output
end
# @private
PATTERN = /
ruby\s
(\d+\.\d+\.\d+(?:\.\S+)?) # ruby version
(?:p(-?\d+))? # optional patchlevel
(?:\s\((\S+)\s(.+)\))? # optional engine info
/xo
# Returns a RubyVersion from the given string.
# @param [String] the version string to match.
# @return [RubyVersion,Nil] The version if the string is a valid RubyVersion
# description, and nil otherwise.
def self.from_string(string)
new($1, $2, $3, $4) if string =~ PATTERN
end
def single_version_string
to_s(gem_version)
end
def ==(other)
versions == other.versions &&
engine == other.engine &&
engine_versions == other.engine_versions &&
patchlevel == other.patchlevel
end
def host
@host ||= [
RbConfig::CONFIG["host_cpu"],
RbConfig::CONFIG["host_vendor"],
RbConfig::CONFIG["host_os"],
].join("-")
end
# Returns a tuple of these things:
# [diff, this, other]
# The priority of attributes are
# 1. engine
# 2. ruby_version
# 3. engine_version
def diff(other)
raise ArgumentError, "Can only diff with a RubyVersion, not a #{other.class}" unless other.is_a?(RubyVersion)
if engine != other.engine && @input_engine
[:engine, engine, other.engine]
elsif versions.empty? || !matches?(versions, other.gem_version)
[:version, versions_string(versions), versions_string(other.versions)]
elsif @input_engine && !matches?(engine_versions, other.engine_gem_version)
[:engine_version, versions_string(engine_versions), versions_string(other.engine_versions)]
elsif patchlevel && (!patchlevel.is_a?(String) || !other.patchlevel.is_a?(String) || !matches?(patchlevel, other.patchlevel))
[:patchlevel, patchlevel, other.patchlevel]
end
end
def versions_string(versions)
Array(versions).join(", ")
end
def self.system
ruby_engine = RUBY_ENGINE.dup
ruby_version = Gem.ruby_version.to_s
ruby_engine_version = RUBY_ENGINE == "ruby" ? ruby_version : RUBY_ENGINE_VERSION.dup
patchlevel = RUBY_PATCHLEVEL.to_s
@system ||= RubyVersion.new(ruby_version, patchlevel, ruby_engine, ruby_engine_version)
end
private
# Ruby's official preview version format uses a `-`: Example: 3.3.0-preview2
# However, RubyGems recognizes preview version format with a `.`: Example: 3.3.0.preview2
# Returns version string after replacing `-` with `.`
def normalize_version(version)
version.tr("-", ".")
end
def matches?(requirements, version)
# Handles RUBY_PATCHLEVEL of -1 for instances like ruby-head
return requirements == version if requirements.to_s == "-1" || version.to_s == "-1"
Array(requirements).all? do |requirement|
Gem::Requirement.create(requirement).satisfied_by?(Gem::Version.create(version))
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/lockfile_parser.rb 0000644 00000021203 15173517745 0017622 0 ustar 00 # frozen_string_literal: true
module Bundler
class LockfileParser
class Position
attr_reader :line, :column
def initialize(line, column)
@line = line
@column = column
end
def advance!(string)
lines = string.count("\n")
if lines > 0
@line += lines
@column = string.length - string.rindex("\n")
else
@column += string.length
end
end
def to_s
"#{line}:#{column}"
end
end
attr_reader(
:sources,
:dependencies,
:specs,
:platforms,
:bundler_version,
:ruby_version,
:checksums,
)
BUNDLED = "BUNDLED WITH"
DEPENDENCIES = "DEPENDENCIES"
CHECKSUMS = "CHECKSUMS"
PLATFORMS = "PLATFORMS"
RUBY = "RUBY VERSION"
GIT = "GIT"
GEM = "GEM"
PATH = "PATH"
PLUGIN = "PLUGIN SOURCE"
SPECS = " specs:"
OPTIONS = /^ ([a-z]+): (.*)$/i
SOURCE = [GIT, GEM, PATH, PLUGIN].freeze
SECTIONS_BY_VERSION_INTRODUCED = {
Gem::Version.create("1.0") => [DEPENDENCIES, PLATFORMS, GIT, GEM, PATH].freeze,
Gem::Version.create("1.10") => [BUNDLED].freeze,
Gem::Version.create("1.12") => [RUBY].freeze,
Gem::Version.create("1.13") => [PLUGIN].freeze,
Gem::Version.create("2.5.0") => [CHECKSUMS].freeze,
}.freeze
KNOWN_SECTIONS = SECTIONS_BY_VERSION_INTRODUCED.values.flatten!.freeze
ENVIRONMENT_VERSION_SECTIONS = [BUNDLED, RUBY].freeze
deprecate_constant(:ENVIRONMENT_VERSION_SECTIONS)
def self.sections_in_lockfile(lockfile_contents)
sections = lockfile_contents.scan(/^\w[\w ]*$/)
sections.uniq!
sections
end
def self.unknown_sections_in_lockfile(lockfile_contents)
sections_in_lockfile(lockfile_contents) - KNOWN_SECTIONS
end
def self.sections_to_ignore(base_version = nil)
base_version &&= base_version.release
base_version ||= Gem::Version.create("1.0")
attributes = []
SECTIONS_BY_VERSION_INTRODUCED.each do |version, introduced|
next if version <= base_version
attributes += introduced
end
attributes
end
def self.bundled_with
lockfile = Bundler.default_lockfile
return unless lockfile.file?
lockfile_contents = Bundler.read_file(lockfile)
return unless lockfile_contents.include?(BUNDLED)
lockfile_contents.split(BUNDLED).last.strip
end
def initialize(lockfile)
@platforms = []
@sources = []
@dependencies = {}
@parse_method = nil
@specs = {}
@lockfile_path = begin
SharedHelpers.relative_lockfile_path
rescue GemfileNotFound
"Gemfile.lock"
end
@pos = Position.new(1, 1)
if lockfile.match?(/<<<<<<<|=======|>>>>>>>|\|\|\|\|\|\|\|/)
raise LockfileError, "Your #{@lockfile_path} contains merge conflicts.\n" \
"Run `git checkout HEAD -- #{@lockfile_path}` first to get a clean lock."
end
lockfile.split(/((?:\r?\n)+)/) do |line|
# split alternates between the line and the following whitespace
next @pos.advance!(line) if line.match?(/^\s*$/)
if SOURCE.include?(line)
@parse_method = :parse_source
parse_source(line)
elsif line == DEPENDENCIES
@parse_method = :parse_dependency
elsif line == CHECKSUMS
# This is a temporary solution to make this feature disabled by default
# for all gemfiles that don't already explicitly include the feature.
@checksums = true
@parse_method = :parse_checksum
elsif line == PLATFORMS
@parse_method = :parse_platform
elsif line == RUBY
@parse_method = :parse_ruby
elsif line == BUNDLED
@parse_method = :parse_bundled_with
elsif /^[^\s]/.match?(line)
@parse_method = nil
elsif @parse_method
send(@parse_method, line)
end
@pos.advance!(line)
end
@specs = @specs.values.sort_by!(&:full_name)
rescue ArgumentError => e
Bundler.ui.debug(e)
raise LockfileError, "Your lockfile is unreadable. Run `rm #{@lockfile_path}` " \
"and then `bundle install` to generate a new lockfile. The error occurred while " \
"evaluating #{@lockfile_path}:#{@pos}"
end
def may_include_redundant_platform_specific_gems?
bundler_version.nil? || bundler_version < Gem::Version.new("1.16.2")
end
private
TYPES = {
GIT => Bundler::Source::Git,
GEM => Bundler::Source::Rubygems,
PATH => Bundler::Source::Path,
PLUGIN => Bundler::Plugin,
}.freeze
def parse_source(line)
case line
when SPECS
return unless TYPES.key?(@type)
@current_source = TYPES[@type].from_lock(@opts)
@sources << @current_source
when OPTIONS
value = $2
value = true if value == "true"
value = false if value == "false"
key = $1
if @opts[key]
@opts[key] = Array(@opts[key])
@opts[key] << value
else
@opts[key] = value
end
when *SOURCE
@current_source = nil
@opts = {}
@type = line
else
parse_spec(line)
end
end
space = / /
NAME_VERSION = /
^(#{space}{2}|#{space}{4}|#{space}{6})(?!#{space}) # Exactly 2, 4, or 6 spaces at the start of the line
(.*?) # Name
(?:#{space}\(([^-]*) # Space, followed by version
(?:-(.*))?\))? # Optional platform
(!)? # Optional pinned marker
(?:#{space}([^ ]+))? # Optional checksum
$ # Line end
/xo
def parse_dependency(line)
return unless line =~ NAME_VERSION
spaces = $1
return unless spaces.size == 2
name = -$2
version = $3
pinned = $5
version = version.split(",").each(&:strip!) if version
dep = Bundler::Dependency.new(name, version)
if pinned && dep.name != "bundler"
spec = @specs.find {|_, v| v.name == dep.name }
dep.source = spec.last.source if spec
# Path sources need to know what the default name / version
# to use in the case that there are no gemspecs present. A fake
# gemspec is created based on the version set on the dependency
# TODO: Use the version from the spec instead of from the dependency
if version && version.size == 1 && version.first =~ /^\s*= (.+)\s*$/ && dep.source.is_a?(Bundler::Source::Path)
dep.source.name = name
dep.source.version = $1
end
end
@dependencies[dep.name] = dep
end
def parse_checksum(line)
return unless line =~ NAME_VERSION
spaces = $1
return unless spaces.size == 2
checksums = $6
return unless checksums
name = $2
version = $3
platform = $4
version = Gem::Version.new(version)
platform = platform ? Gem::Platform.new(platform) : Gem::Platform::RUBY
full_name = Gem::NameTuple.new(name, version, platform).full_name
return unless spec = @specs[full_name]
checksums.split(",") do |lock_checksum|
column = line.index(lock_checksum) + 1
checksum = Checksum.from_lock(lock_checksum, "#{@lockfile_path}:#{@pos.line}:#{column}")
spec.source.checksum_store.register(spec, checksum)
end
end
def parse_spec(line)
return unless line =~ NAME_VERSION
spaces = $1
name = -$2
version = $3
if spaces.size == 4
# only load platform for non-dependency (spec) line
platform = $4
version = Gem::Version.new(version)
platform = platform ? Gem::Platform.new(platform) : Gem::Platform::RUBY
@current_spec = LazySpecification.new(name, version, platform, @current_source)
@current_source.add_dependency_names(name)
@specs[@current_spec.full_name] = @current_spec
elsif spaces.size == 6
version = version.split(",").each(&:strip!) if version
dep = Gem::Dependency.new(name, version)
@current_spec.dependencies << dep
end
end
def parse_platform(line)
@platforms << Gem::Platform.new($1.strip) if line =~ /^ (.*)$/
end
def parse_bundled_with(line)
line.strip!
return unless Gem::Version.correct?(line)
@bundler_version = Gem::Version.create(line)
end
def parse_ruby(line)
line.strip!
@ruby_version = line
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/rubygems_gem_installer.rb 0000644 00000011264 15173517745 0021226 0 ustar 00 # frozen_string_literal: true
require "rubygems/installer"
module Bundler
class RubyGemsGemInstaller < Gem::Installer
def check_executable_overwrite(filename)
# Bundler needs to install gems regardless of binstub overwriting
end
def install
pre_install_checks
run_pre_install_hooks
spec.loaded_from = spec_file
# Completely remove any previous gem files
strict_rm_rf gem_dir
strict_rm_rf spec.extension_dir
SharedHelpers.filesystem_access(gem_dir, :create) do
FileUtils.mkdir_p gem_dir, mode: 0o755
end
extract_files
build_extensions if spec.extensions.any?
write_build_info_file
run_post_build_hooks
SharedHelpers.filesystem_access(bin_dir, :write) do
generate_bin
end
generate_plugins
write_spec
SharedHelpers.filesystem_access("#{gem_home}/cache", :write) do
write_cache_file
end
say spec.post_install_message unless spec.post_install_message.nil?
run_post_install_hooks
spec
end
if Bundler.rubygems.provides?("< 3.5")
def pre_install_checks
super
rescue Gem::FilePermissionError
# Ignore permission checks in RubyGems. Instead, go on, and try to write
# for real. We properly handle permission errors when they happen.
nil
end
end
def ensure_writable_dir(dir)
super
rescue Gem::FilePermissionError
# Ignore permission checks in RubyGems. Instead, go on, and try to write
# for real. We properly handle permission errors when they happen.
nil
end
def generate_plugins
return unless Gem::Installer.instance_methods(false).include?(:generate_plugins)
latest = Gem::Specification.stubs_for(spec.name).first
return if latest && latest.version > spec.version
ensure_writable_dir @plugins_dir
if spec.plugins.empty?
remove_plugins_for(spec, @plugins_dir)
else
regenerate_plugins_for(spec, @plugins_dir)
end
end
if Bundler.rubygems.provides?("< 3.5.19")
def generate_bin_script(filename, bindir)
bin_script_path = File.join bindir, formatted_program_filename(filename)
Gem.open_file_with_lock(bin_script_path) do
require "fileutils"
FileUtils.rm_f bin_script_path # prior install may have been --no-wrappers
File.open(bin_script_path, "wb", 0o755) do |file|
file.write app_script_text(filename)
file.chmod(options[:prog_mode] || 0o755)
end
end
verbose bin_script_path
generate_windows_script filename, bindir
end
end
def build_extensions
extension_cache_path = options[:bundler_extension_cache_path]
extension_dir = spec.extension_dir
unless extension_cache_path && extension_dir
prepare_extension_build(extension_dir)
return super
end
build_complete = SharedHelpers.filesystem_access(extension_cache_path.join("gem.build_complete"), :read, &:file?)
if build_complete && !options[:force]
SharedHelpers.filesystem_access(File.dirname(extension_dir)) do |p|
FileUtils.mkpath p
end
SharedHelpers.filesystem_access(extension_cache_path) do
FileUtils.cp_r extension_cache_path, extension_dir
end
else
prepare_extension_build(extension_dir)
super
SharedHelpers.filesystem_access(extension_cache_path.parent, &:mkpath)
SharedHelpers.filesystem_access(extension_cache_path) do
FileUtils.cp_r extension_dir, extension_cache_path
end
end
end
def spec
if Bundler.rubygems.provides?("< 3.3.12") # RubyGems implementation rescues and re-raises errors before 3.3.12 and we don't want that
@package.spec
else
super
end
end
def gem_checksum
Checksum.from_gem_package(@package)
end
private
def prepare_extension_build(extension_dir)
SharedHelpers.filesystem_access(extension_dir, :create) do
FileUtils.mkdir_p extension_dir
end
require "shellwords" unless Bundler.rubygems.provides?(">= 3.2.25")
end
def strict_rm_rf(dir)
return unless File.exist?(dir)
return if Dir.empty?(dir)
parent = File.dirname(dir)
parent_st = File.stat(parent)
if parent_st.world_writable? && !parent_st.sticky?
raise InsecureInstallPathError.new(spec.full_name, dir)
end
begin
FileUtils.remove_entry_secure(dir)
rescue StandardError => e
raise unless File.exist?(dir)
raise DirectoryRemovalError.new(e, "Could not delete previous installation of `#{dir}`")
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_persistent.rb 0000644 00000000305 15173517745 0020544 0 ustar 00 # frozen_string_literal: true
module Bundler
module Persistent
module Net
module HTTP
end
end
end
end
require_relative "vendor/net-http-persistent/lib/net/http/persistent"
share/gems/gems/bundler-2.5.22/lib/bundler/yaml_serializer.rb 0000644 00000004656 15173517745 0017666 0 ustar 00 # frozen_string_literal: true
module Bundler
# A stub yaml serializer that can handle only hashes and strings (as of now).
module YAMLSerializer
module_function
def dump(hash)
yaml = String.new("---")
yaml << dump_hash(hash)
end
def dump_hash(hash)
yaml = String.new("\n")
hash.each do |k, v|
yaml << k << ":"
if v.is_a?(Hash)
yaml << dump_hash(v).gsub(/^(?!$)/, " ") # indent all non-empty lines
elsif v.is_a?(Array) # Expected to be array of strings
if v.empty?
yaml << " []\n"
else
yaml << "\n- " << v.map {|s| s.to_s.gsub(/\s+/, " ").inspect }.join("\n- ") << "\n"
end
else
yaml << " " << v.to_s.gsub(/\s+/, " ").inspect << "\n"
end
end
yaml
end
ARRAY_REGEX = /
^
(?:[ ]*-[ ]) # '- ' before array items
(['"]?) # optional opening quote
(.*) # value
\1 # matching closing quote
$
/xo
HASH_REGEX = /
^
([ ]*) # indentations
([^#]+) # key excludes comment char '#'
(?::(?=(?:\s|$))) # : (without the lookahead the #key includes this when : is present in value)
[ ]?
(['"]?) # optional opening quote
(.*) # value
\3 # matching closing quote
$
/xo
def load(str)
res = {}
stack = [res]
last_hash = nil
last_empty_key = nil
str.split(/\r?\n/) do |line|
if match = HASH_REGEX.match(line)
indent, key, quote, val = match.captures
val = strip_comment(val)
depth = indent.size / 2
if quote.empty? && val.empty?
new_hash = {}
stack[depth][key] = new_hash
stack[depth + 1] = new_hash
last_empty_key = key
last_hash = stack[depth]
else
val = [] if val == "[]" # empty array
stack[depth][key] = val
end
elsif match = ARRAY_REGEX.match(line)
_, val = match.captures
val = strip_comment(val)
last_hash[last_empty_key] = [] unless last_hash[last_empty_key].is_a?(Array)
last_hash[last_empty_key].push(val)
end
end
res
end
def strip_comment(val)
if val.include?("#") && !val.start_with?("#")
val.split("#", 2).first.strip
else
val
end
end
class << self
private :dump_hash
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/gem_version_promoter.rb 0000644 00000012232 15173517745 0020724 0 ustar 00 # frozen_string_literal: true
module Bundler
# This class contains all of the logic for determining the next version of a
# Gem to update to based on the requested level (patch, minor, major).
# Primarily designed to work with Resolver which will provide it the list of
# available dependency versions as found in its index, before returning it to
# to the resolution engine to select the best version.
class GemVersionPromoter
attr_reader :level
attr_accessor :pre
# By default, strict is false, meaning every available version of a gem
# is returned from sort_versions. The order gives preference to the
# requested level (:patch, :minor, :major) but in complicated requirement
# cases some gems will by necessity be promoted past the requested level,
# or even reverted to older versions.
#
# If strict is set to true, the results from sort_versions will be
# truncated, eliminating any version outside the current level scope.
# This can lead to unexpected outcomes or even VersionConflict exceptions
# that report a version of a gem not existing for versions that indeed do
# existing in the referenced source.
attr_accessor :strict
# Creates a GemVersionPromoter instance.
#
# @return [GemVersionPromoter]
def initialize
@level = :major
@strict = false
@pre = false
end
# @param value [Symbol] One of three Symbols: :major, :minor or :patch.
def level=(value)
v = case value
when String, Symbol
value.to_sym
end
raise ArgumentError, "Unexpected level #{v}. Must be :major, :minor or :patch" unless [:major, :minor, :patch].include?(v)
@level = v
end
# Given a Resolver::Package and an Array of Specifications of available
# versions for a gem, this method will return the Array of Specifications
# sorted in an order to give preference to the current level (:major, :minor
# or :patch) when resolution is deciding what versions best resolve all
# dependencies in the bundle.
# @param package [Resolver::Package] The package being resolved.
# @param specs [Specification] An array of Specifications for the package.
# @return [Specification] A new instance of the Specification Array sorted.
def sort_versions(package, specs)
locked_version = package.locked_version
result = specs.sort do |a, b|
unless package.prerelease_specified? || pre?
a_pre = a.prerelease?
b_pre = b.prerelease?
next 1 if a_pre && !b_pre
next -1 if b_pre && !a_pre
end
if major? || locked_version.nil?
b <=> a
elsif either_version_older_than_locked?(a, b, locked_version)
b <=> a
elsif segments_do_not_match?(a, b, :major)
a <=> b
elsif !minor? && segments_do_not_match?(a, b, :minor)
a <=> b
else
b <=> a
end
end
post_sort(result, package.unlock?, locked_version)
end
# @return [bool] Convenience method for testing value of level variable.
def major?
level == :major
end
# @return [bool] Convenience method for testing value of level variable.
def minor?
level == :minor
end
# @return [bool] Convenience method for testing value of pre variable.
def pre?
pre == true
end
# Given a Resolver::Package and an Array of Specifications of available
# versions for a gem, this method will truncate the Array if strict
# is true. That means filtering out downgrades from the version currently
# locked, and filtering out upgrades that go past the selected level (major,
# minor, or patch).
# @param package [Resolver::Package] The package being resolved.
# @param specs [Specification] An array of Specifications for the package.
# @return [Specification] A new instance of the Specification Array
# truncated.
def filter_versions(package, specs)
return specs unless strict
locked_version = package.locked_version
return specs if locked_version.nil? || major?
specs.select do |spec|
gsv = spec.version
must_match = minor? ? [0] : [0, 1]
all_match = must_match.all? {|idx| gsv.segments[idx] == locked_version.segments[idx] }
all_match && gsv >= locked_version
end
end
private
def either_version_older_than_locked?(a, b, locked_version)
a.version < locked_version || b.version < locked_version
end
def segments_do_not_match?(a, b, level)
index = [:major, :minor].index(level)
a.segments[index] != b.segments[index]
end
# Specific version moves can't always reliably be done during sorting
# as not all elements are compared against each other.
def post_sort(result, unlock, locked_version)
# default :major behavior in Bundler does not do this
return result if major?
if unlock || locked_version.nil?
result
else
move_version_to_beginning(result, locked_version)
end
end
def move_version_to_beginning(result, version)
move, keep = result.partition {|s| s.version.to_s == version.to_s }
move.concat(keep)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/shared_helpers.rb 0000644 00000027532 15173517745 0017461 0 ustar 00 # frozen_string_literal: true
require_relative "version"
require_relative "rubygems_integration"
require_relative "current_ruby"
autoload :Pathname, "pathname"
module Bundler
autoload :WINDOWS, File.expand_path("constants", __dir__)
autoload :FREEBSD, File.expand_path("constants", __dir__)
autoload :NULL, File.expand_path("constants", __dir__)
module SharedHelpers
def root
gemfile = find_gemfile
raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
Pathname.new(gemfile).expand_path.parent
end
def default_gemfile
gemfile = find_gemfile
raise GemfileNotFound, "Could not locate Gemfile" unless gemfile
Pathname.new(gemfile).expand_path
end
def default_lockfile
gemfile = default_gemfile
case gemfile.basename.to_s
when "gems.rb" then Pathname.new(gemfile.sub(/.rb$/, ".locked"))
else Pathname.new("#{gemfile}.lock")
end
end
def default_bundle_dir
bundle_dir = find_directory(".bundle")
return nil unless bundle_dir
bundle_dir = Pathname.new(bundle_dir)
global_bundle_dir = Bundler.user_home.join(".bundle")
return nil if bundle_dir == global_bundle_dir
bundle_dir
end
def in_bundle?
find_gemfile
end
def chdir(dir, &blk)
Bundler.rubygems.ext_lock.synchronize do
Dir.chdir dir, &blk
end
end
def pwd
Bundler.rubygems.ext_lock.synchronize do
Pathname.pwd
end
end
def with_clean_git_env(&block)
keys = %w[GIT_DIR GIT_WORK_TREE]
old_env = keys.inject({}) do |h, k|
h.update(k => ENV[k])
end
keys.each {|key| ENV.delete(key) }
block.call
ensure
keys.each {|key| ENV[key] = old_env[key] }
end
def set_bundle_environment
set_bundle_variables
set_path
set_rubyopt
set_rubylib
end
# Rescues permissions errors raised by file system operations
# (ie. Errno:EACCESS, Errno::EAGAIN) and raises more friendly errors instead.
#
# @param path [String] the path that the action will be attempted to
# @param action [Symbol, #to_s] the type of operation that will be
# performed. For example: :write, :read, :exec
#
# @yield path
#
# @raise [Bundler::PermissionError] if Errno:EACCES is raised in the
# given block
# @raise [Bundler::TemporaryResourceError] if Errno:EAGAIN is raised in the
# given block
#
# @example
# filesystem_access("vendor/cache", :write) do
# FileUtils.mkdir_p("vendor/cache")
# end
#
# @see {Bundler::PermissionError}
def filesystem_access(path, action = :write, &block)
yield(path.dup)
rescue Errno::EACCES
raise PermissionError.new(path, action)
rescue Errno::EAGAIN
raise TemporaryResourceError.new(path, action)
rescue Errno::EPROTO
raise VirtualProtocolError.new
rescue Errno::ENOSPC
raise NoSpaceOnDeviceError.new(path, action)
rescue Errno::ENOTSUP
raise OperationNotSupportedError.new(path, action)
rescue Errno::EEXIST, Errno::ENOENT
raise
rescue SystemCallError => e
raise GenericSystemCallError.new(e, "There was an error accessing `#{path}`.")
end
def major_deprecation(major_version, message, removed_message: nil, print_caller_location: false)
if print_caller_location
caller_location = caller_locations(2, 2).first
suffix = " (called at #{caller_location.path}:#{caller_location.lineno})"
message += suffix
removed_message += suffix if removed_message
end
bundler_major_version = Bundler.bundler_major_version
if bundler_major_version > major_version
require_relative "errors"
raise DeprecatedError, "[REMOVED] #{removed_message || message}"
end
return unless bundler_major_version >= major_version && prints_major_deprecations?
Bundler.ui.warn("[DEPRECATED] #{message}")
end
def print_major_deprecations!
multiple_gemfiles = search_up(".") do |dir|
gemfiles = gemfile_names.select {|gf| File.file? File.expand_path(gf, dir) }
next if gemfiles.empty?
break gemfiles.size != 1
end
return unless multiple_gemfiles
message = "Multiple gemfiles (gems.rb and Gemfile) detected. " \
"Make sure you remove Gemfile and Gemfile.lock since bundler is ignoring them in favor of gems.rb and gems.locked."
Bundler.ui.warn message
end
def ensure_same_dependencies(spec, old_deps, new_deps)
new_deps = new_deps.reject {|d| d.type == :development }
old_deps = old_deps.reject {|d| d.type == :development }
without_type = proc {|d| Gem::Dependency.new(d.name, d.requirements_list.sort) }
new_deps.map!(&without_type)
old_deps.map!(&without_type)
extra_deps = new_deps - old_deps
return if extra_deps.empty?
Bundler.ui.debug "#{spec.full_name} from #{spec.remote} has either corrupted API or lockfile dependencies" \
" (was expecting #{old_deps.map(&:to_s)}, but the real spec has #{new_deps.map(&:to_s)})"
raise APIResponseMismatchError,
"Downloading #{spec.full_name} revealed dependencies not in the API or the lockfile (#{extra_deps.join(", ")})." \
"\nRunning `bundle update #{spec.name}` should fix the problem."
end
def pretty_dependency(dep)
msg = String.new(dep.name)
msg << " (#{dep.requirement})" unless dep.requirement == Gem::Requirement.default
if dep.is_a?(Bundler::Dependency)
platform_string = dep.platforms.join(", ")
msg << " " << platform_string if !platform_string.empty? && platform_string != Gem::Platform::RUBY
end
msg
end
def md5_available?
return @md5_available if defined?(@md5_available)
@md5_available = begin
require "openssl"
::OpenSSL::Digest.digest("MD5", "")
true
rescue LoadError
true
rescue ::OpenSSL::Digest::DigestError
false
end
end
def digest(name)
require "digest"
Digest(name)
end
def checksum_for_file(path, digest)
return unless path.file?
# This must use File.read instead of Digest.file().hexdigest
# because we need to preserve \n line endings on windows when calculating
# the checksum
SharedHelpers.filesystem_access(path, :read) do
File.open(path, "rb") do |f|
digest = SharedHelpers.digest(digest).new
buf = String.new(capacity: 16_384, encoding: Encoding::BINARY)
digest << buf while f.read(16_384, buf)
digest.hexdigest
end
end
end
def write_to_gemfile(gemfile_path, contents)
filesystem_access(gemfile_path) {|g| File.open(g, "w") {|file| file.puts contents } }
end
def relative_gemfile_path
relative_path_to(Bundler.default_gemfile)
end
def relative_lockfile_path
relative_path_to(Bundler.default_lockfile)
end
def relative_path_to(destination, from: pwd)
Pathname.new(destination).relative_path_from(from).to_s
rescue ArgumentError
# on Windows, if source and destination are on different drivers, there's no relative path from one to the other
destination
end
private
def validate_bundle_path
path_separator = Bundler.rubygems.path_separator
return unless Bundler.bundle_path.to_s.split(path_separator).size > 1
message = "Your bundle path contains text matching #{path_separator.inspect}, " \
"which is the path separator for your system. Bundler cannot " \
"function correctly when the Bundle path contains the " \
"system's PATH separator. Please change your " \
"bundle path to not match #{path_separator.inspect}." \
"\nYour current bundle path is '#{Bundler.bundle_path}'."
raise Bundler::PathError, message
end
def find_gemfile
given = ENV["BUNDLE_GEMFILE"]
return given if given && !given.empty?
find_file(*gemfile_names)
end
def gemfile_names
["gems.rb", "Gemfile"]
end
def find_file(*names)
search_up(*names) do |filename|
return filename if File.file?(filename)
end
end
def find_directory(*names)
search_up(*names) do |dirname|
return dirname if File.directory?(dirname)
end
end
def search_up(*names)
previous = nil
current = File.expand_path(SharedHelpers.pwd)
until !File.directory?(current) || current == previous
if ENV["BUNDLER_SPEC_RUN"]
# avoid stepping above the tmp directory when testing
gemspec = if ENV["GEM_COMMAND"]
# for Ruby Core
"lib/bundler/bundler.gemspec"
else
"bundler.gemspec"
end
# avoid stepping above the tmp directory when testing
return nil if File.file?(File.join(current, gemspec))
end
names.each do |name|
filename = File.join(current, name)
yield filename
end
previous = current
current = File.expand_path("..", current)
end
end
def set_env(key, value)
raise ArgumentError, "new key #{key}" unless EnvironmentPreserver::BUNDLER_KEYS.include?(key)
orig_key = "#{EnvironmentPreserver::BUNDLER_PREFIX}#{key}"
orig = ENV[key]
orig ||= EnvironmentPreserver::INTENTIONALLY_NIL
ENV[orig_key] ||= orig
ENV[key] = value
end
public :set_env
def set_bundle_variables
Bundler::SharedHelpers.set_env "BUNDLE_BIN_PATH", bundle_bin_path
Bundler::SharedHelpers.set_env "BUNDLE_GEMFILE", find_gemfile.to_s
Bundler::SharedHelpers.set_env "BUNDLER_VERSION", Bundler::VERSION
Bundler::SharedHelpers.set_env "BUNDLER_SETUP", File.expand_path("setup", __dir__)
end
def bundle_bin_path
# bundler exe & lib folders have same root folder, typical gem installation
exe_file = File.expand_path("../../exe/bundle", __dir__)
# for Ruby core repository testing
exe_file = File.expand_path("../../libexec/bundle", __dir__) unless File.exist?(exe_file)
# bundler is a default gem, exe path is separate
exe_file = Bundler.rubygems.bin_path("bundler", "bundle", VERSION) unless File.exist?(exe_file)
exe_file
end
public :bundle_bin_path
def set_path
validate_bundle_path
paths = (ENV["PATH"] || "").split(File::PATH_SEPARATOR)
paths.unshift "#{Bundler.bundle_path}/bin"
Bundler::SharedHelpers.set_env "PATH", paths.uniq.join(File::PATH_SEPARATOR)
end
def set_rubyopt
rubyopt = [ENV["RUBYOPT"]].compact
setup_require = "-r#{File.expand_path("setup", __dir__)}"
return if !rubyopt.empty? && rubyopt.first.include?(setup_require)
rubyopt.unshift setup_require
Bundler::SharedHelpers.set_env "RUBYOPT", rubyopt.join(" ")
end
def set_rubylib
rubylib = (ENV["RUBYLIB"] || "").split(File::PATH_SEPARATOR)
rubylib.unshift bundler_ruby_lib unless RbConfig::CONFIG["rubylibdir"] == bundler_ruby_lib
Bundler::SharedHelpers.set_env "RUBYLIB", rubylib.uniq.join(File::PATH_SEPARATOR)
end
def bundler_ruby_lib
File.expand_path("..", __dir__)
end
def clean_load_path
loaded_gem_paths = Bundler.rubygems.loaded_gem_paths
$LOAD_PATH.reject! do |p|
resolved_path = resolve_path(p)
next if $LOADED_FEATURES.any? {|lf| lf.start_with?(resolved_path) }
loaded_gem_paths.delete(p)
end
$LOAD_PATH.uniq!
end
def resolve_path(path)
expanded = File.expand_path(path)
return expanded unless File.exist?(expanded)
File.realpath(expanded)
end
def prints_major_deprecations?
require_relative "../bundler"
return false if Bundler.settings[:silence_deprecations]
require_relative "deprecate"
return false if Bundler::Deprecate.skip
true
end
extend self
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/index.rb 0000644 00000011553 15173517745 0015574 0 ustar 00 # frozen_string_literal: true
module Bundler
class Index
include Enumerable
def self.build
i = new
yield i
i
end
attr_reader :specs, :duplicates, :sources
protected :specs, :duplicates
RUBY = "ruby"
NULL = "\0"
def initialize
@sources = []
@cache = {}
@specs = {}
@duplicates = {}
end
def initialize_copy(o)
@sources = o.sources.dup
@cache = {}
@specs = {}
@duplicates = {}
o.specs.each do |name, hash|
@specs[name] = hash.dup
end
o.duplicates.each do |name, array|
@duplicates[name] = array.dup
end
end
def inspect
"#<#{self.class}:0x#{object_id} sources=#{sources.map(&:inspect)} specs.size=#{specs.size}>"
end
def empty?
each { return false }
true
end
def search_all(name, &blk)
return enum_for(:search_all, name) unless blk
specs_by_name(name).each(&blk)
@duplicates[name]&.each(&blk)
@sources.each {|source| source.search_all(name, &blk) }
end
# Search this index's specs, and any source indexes that this index knows
# about, returning all of the results.
def search(query)
results = local_search(query)
return results unless @sources.any?
@sources.each do |source|
results = safe_concat(results, source.search(query))
end
results.uniq!(&:full_name) unless results.empty? # avoid modifying frozen EMPTY_SEARCH
results
end
alias_method :[], :search
def local_search(query)
case query
when Gem::Specification, RemoteSpecification, LazySpecification, EndpointSpecification then search_by_spec(query)
when String then specs_by_name(query)
when Array then specs_by_name_and_version(*query)
else
raise "You can't search for a #{query.inspect}."
end
end
def add(spec)
(@specs[spec.name] ||= {}).store(spec.full_name, spec)
end
alias_method :<<, :add
def each(&blk)
return enum_for(:each) unless blk
specs.values.each do |spec_sets|
spec_sets.values.each(&blk)
end
sources.each {|s| s.each(&blk) }
self
end
def spec_names
names = specs.keys + sources.map(&:spec_names)
names.uniq!
names
end
def unmet_dependency_names
dependency_names.select do |name|
search(name).empty?
end
end
def dependency_names
names = []
each do |spec|
spec.dependencies.each do |dep|
next if dep.type == :development
names << dep.name
end
end
names.uniq
end
# Combines indexes proritizing existing specs, like `Hash#reverse_merge!`
# Duplicate specs found in `other` are stored in `@duplicates`.
def use(other)
return unless other
other.each do |spec|
exist?(spec) ? add_duplicate(spec) : add(spec)
end
self
end
# Combines indexes proritizing specs from `other`, like `Hash#merge!`
# Duplicate specs found in `self` are saved in `@duplicates`.
def merge!(other)
return unless other
other.each do |spec|
if existing = find_by_spec(spec)
add_duplicate(existing)
end
add spec
end
self
end
def size
@sources.inject(@specs.size) do |size, source|
size += source.size
end
end
# Whether all the specs in self are in other
def subset?(other)
all? do |spec|
other_spec = other[spec].first
other_spec && dependencies_eql?(spec, other_spec) && spec.source == other_spec.source
end
end
def dependencies_eql?(spec, other_spec)
deps = spec.dependencies.select {|d| d.type != :development }
other_deps = other_spec.dependencies.select {|d| d.type != :development }
deps.sort == other_deps.sort
end
def add_source(index)
raise ArgumentError, "Source must be an index, not #{index.class}" unless index.is_a?(Index)
@sources << index
@sources.uniq! # need to use uniq! here instead of checking for the item before adding
end
private
def safe_concat(a, b)
return a if b.empty?
return b if a.empty?
a.concat(b)
end
def add_duplicate(spec)
(@duplicates[spec.name] ||= []) << spec
end
def specs_by_name_and_version(name, version)
results = @specs[name]&.values
return EMPTY_SEARCH unless results
results.select! {|spec| spec.version == version }
results
end
def specs_by_name(name)
@specs[name]&.values || EMPTY_SEARCH
end
EMPTY_SEARCH = [].freeze
def search_by_spec(spec)
spec = find_by_spec(spec)
spec ? [spec] : EMPTY_SEARCH
end
def find_by_spec(spec)
@specs[spec.name]&.fetch(spec.full_name, nil)
end
def exist?(spec)
@specs[spec.name]&.key?(spec.full_name)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/deployment.rb 0000644 00000006305 15173517745 0016644 0 ustar 00 # frozen_string_literal: true
require_relative "shared_helpers"
Bundler::SharedHelpers.major_deprecation 2, "Bundler no longer integrates with " \
"Capistrano, but Capistrano provides its own integration with " \
"Bundler via the capistrano-bundler gem. Use it instead."
module Bundler
class Deployment
def self.define_task(context, task_method = :task, opts = {})
if defined?(Capistrano) && context.is_a?(Capistrano::Configuration)
context_name = "capistrano"
role_default = "{:except => {:no_release => true}}"
error_type = ::Capistrano::CommandError
else
context_name = "vlad"
role_default = "[:app]"
error_type = ::Rake::CommandFailedError
end
roles = context.fetch(:bundle_roles, false)
opts[:roles] = roles if roles
context.send :namespace, :bundle do
send :desc, <<-DESC
Install the current Bundler environment. By default, gems will be \
installed to the shared/bundle path. Gems in the development and \
test group will not be installed. The install command is executed \
with the --deployment and --quiet flags. If the bundle cmd cannot \
be found then you can override the bundle_cmd variable to specify \
which one it should use. The base path to the app is fetched from \
the :latest_release variable. Set it for custom deploy layouts.
You can override any of these defaults by setting the variables shown below.
N.B. bundle_roles must be defined before you require 'bundler/#{context_name}' \
in your deploy.rb file.
set :bundle_gemfile, "Gemfile"
set :bundle_dir, File.join(fetch(:shared_path), 'bundle')
set :bundle_flags, "--deployment --quiet"
set :bundle_without, [:development, :test]
set :bundle_with, [:mysql]
set :bundle_cmd, "bundle" # e.g. "/opt/ruby/bin/bundle"
set :bundle_roles, #{role_default} # e.g. [:app, :batch]
DESC
send task_method, :install, opts do
bundle_cmd = context.fetch(:bundle_cmd, "bundle")
bundle_flags = context.fetch(:bundle_flags, "--deployment --quiet")
bundle_dir = context.fetch(:bundle_dir, File.join(context.fetch(:shared_path), "bundle"))
bundle_gemfile = context.fetch(:bundle_gemfile, "Gemfile")
bundle_without = [*context.fetch(:bundle_without, [:development, :test])].compact
bundle_with = [*context.fetch(:bundle_with, [])].compact
app_path = context.fetch(:latest_release)
if app_path.to_s.empty?
raise error_type.new("Cannot detect current release path - make sure you have deployed at least once.")
end
args = ["--gemfile #{File.join(app_path, bundle_gemfile)}"]
args << "--path #{bundle_dir}" unless bundle_dir.to_s.empty?
args << bundle_flags.to_s
args << "--without #{bundle_without.join(" ")}" unless bundle_without.empty?
args << "--with #{bundle_with.join(" ")}" unless bundle_with.empty?
run "cd #{app_path} && #{bundle_cmd} install #{args.join(" ")}"
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/deprecate.rb 0000644 00000001554 15173517745 0016421 0 ustar 00 # frozen_string_literal: true
begin
require "rubygems/deprecate"
rescue LoadError
# it's fine if it doesn't exist on the current RubyGems...
nil
end
module Bundler
# If Bundler::Deprecate is an autoload constant, we need to define it
if defined?(Bundler::Deprecate) && !autoload?(:Deprecate)
# nothing to do!
elsif defined? ::Deprecate
Deprecate = ::Deprecate
elsif defined? Gem::Deprecate
Deprecate = Gem::Deprecate
else
class Deprecate
end
end
unless Deprecate.respond_to?(:skip_during)
def Deprecate.skip_during
original = skip
self.skip = true
yield
ensure
self.skip = original
end
end
unless Deprecate.respond_to?(:skip)
def Deprecate.skip
@skip ||= false
end
end
unless Deprecate.respond_to?(:skip=)
def Deprecate.skip=(skip)
@skip = skip
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/match_remote_metadata.rb 0000644 00000001537 15173517745 0020775 0 ustar 00 # frozen_string_literal: true
module Bundler
module FetchMetadata
# A fallback is included because the original version of the specification
# API didn't include that field, so some marshalled specs in the index have it
# set to +nil+.
def matches_current_ruby?
@required_ruby_version ||= _remote_specification.required_ruby_version || Gem::Requirement.default
super
end
def matches_current_rubygems?
# A fallback is included because the original version of the specification
# API didn't include that field, so some marshalled specs in the index have it
# set to +nil+.
@required_rubygems_version ||= _remote_specification.required_rubygems_version || Gem::Requirement.default
super
end
end
module MatchRemoteMetadata
include MatchMetadata
prepend FetchMetadata
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/errors.rb 0000644 00000017725 15173517745 0016010 0 ustar 00 # frozen_string_literal: true
module Bundler
class BundlerError < StandardError
def self.status_code(code)
define_method(:status_code) { code }
if match = BundlerError.all_errors.find {|_k, v| v == code }
error, _ = match
raise ArgumentError,
"Trying to register #{self} for status code #{code} but #{error} is already registered"
end
BundlerError.all_errors[self] = code
end
def self.all_errors
@all_errors ||= {}
end
end
class GemfileError < BundlerError; status_code(4); end
class InstallError < BundlerError; status_code(5); end
# Internal error, should be rescued
class SolveFailure < BundlerError; status_code(6); end
class GemNotFound < BundlerError; status_code(7); end
class InstallHookError < BundlerError; status_code(8); end
class GemfileNotFound < BundlerError; status_code(10); end
class GitError < BundlerError; status_code(11); end
class DeprecatedError < BundlerError; status_code(12); end
class PathError < BundlerError; status_code(13); end
class GemspecError < BundlerError; status_code(14); end
class InvalidOption < BundlerError; status_code(15); end
class ProductionError < BundlerError; status_code(16); end
class HTTPError < BundlerError
status_code(17)
def filter_uri(uri)
URICredentialsFilter.credential_filtered_uri(uri)
end
end
class RubyVersionMismatch < BundlerError; status_code(18); end
class SecurityError < BundlerError; status_code(19); end
class LockfileError < BundlerError; status_code(20); end
class CyclicDependencyError < BundlerError; status_code(21); end
class GemfileLockNotFound < BundlerError; status_code(22); end
class PluginError < BundlerError; status_code(29); end
class ThreadCreationError < BundlerError; status_code(33); end
class APIResponseMismatchError < BundlerError; status_code(34); end
class APIResponseInvalidDependenciesError < BundlerError; status_code(35); end
class GemfileEvalError < GemfileError; end
class MarshalError < StandardError; end
class ChecksumMismatchError < SecurityError
def initialize(lock_name, existing, checksum)
@lock_name = lock_name
@existing = existing
@checksum = checksum
end
def message
<<~MESSAGE
Bundler found mismatched checksums. This is a potential security risk.
#{@lock_name} #{@existing.to_lock}
from #{@existing.sources.join("\n and ")}
#{@lock_name} #{@checksum.to_lock}
from #{@checksum.sources.join("\n and ")}
#{mismatch_resolution_instructions}
To ignore checksum security warnings, disable checksum validation with
`bundle config set --local disable_checksum_validation true`
MESSAGE
end
def mismatch_resolution_instructions
removable, remote = [@existing, @checksum].partition(&:removable?)
case removable.size
when 0
msg = +"Mismatched checksums each have an authoritative source:\n"
msg << " 1. #{@existing.sources.reject(&:removable?).map(&:to_s).join(" and ")}\n"
msg << " 2. #{@checksum.sources.reject(&:removable?).map(&:to_s).join(" and ")}\n"
msg << "You may need to alter your Gemfile sources to resolve this issue.\n"
when 1
msg = +"If you trust #{remote.first.sources.first}, to resolve this issue you can:\n"
msg << removable.first.removal_instructions
when 2
msg = +"To resolve this issue you can either:\n"
msg << @checksum.removal_instructions
msg << "or if you are sure that the new checksum from #{@checksum.sources.first} is correct:\n"
msg << @existing.removal_instructions
end
end
status_code(37)
end
class PermissionError < BundlerError
def initialize(path, permission_type = :write)
@path = path
@permission_type = permission_type
end
def action
case @permission_type
when :read then "read from"
when :write then "write to"
when :executable, :exec then "execute"
else @permission_type.to_s
end
end
def permission_type
case @permission_type
when :create
"executable permissions for all parent directories and write permissions for `#{parent_folder}`"
else
"#{@permission_type} permissions for that path"
end
end
def parent_folder
File.dirname(@path)
end
def message
"There was an error while trying to #{action} `#{@path}`. " \
"It is likely that you need to grant #{permission_type}."
end
status_code(23)
end
class GemRequireError < BundlerError
attr_reader :orig_exception
def initialize(orig_exception, msg)
full_message = msg + "\nGem Load Error is: #{orig_exception.message}\n"\
"Backtrace for gem load error is:\n"\
"#{orig_exception.backtrace.join("\n")}\n"\
"Bundler Error Backtrace:\n"
super(full_message)
@orig_exception = orig_exception
end
status_code(24)
end
class YamlSyntaxError < BundlerError
attr_reader :orig_exception
def initialize(orig_exception, msg)
super(msg)
@orig_exception = orig_exception
end
status_code(25)
end
class TemporaryResourceError < PermissionError
def message
"There was an error while trying to #{action} `#{@path}`. " \
"Some resource was temporarily unavailable. It's suggested that you try" \
"the operation again."
end
status_code(26)
end
class VirtualProtocolError < BundlerError
def message
"There was an error relating to virtualization and file access. " \
"It is likely that you need to grant access to or mount some file system correctly."
end
status_code(27)
end
class OperationNotSupportedError < PermissionError
def message
"Attempting to #{action} `#{@path}` is unsupported by your OS."
end
status_code(28)
end
class NoSpaceOnDeviceError < PermissionError
def message
"There was an error while trying to #{action} `#{@path}`. " \
"There was insufficient space remaining on the device."
end
status_code(31)
end
class GenericSystemCallError < BundlerError
attr_reader :underlying_error
def initialize(underlying_error, message)
@underlying_error = underlying_error
super("#{message}\nThe underlying system error is #{@underlying_error.class}: #{@underlying_error}")
end
status_code(32)
end
class DirectoryRemovalError < BundlerError
def initialize(orig_exception, msg)
full_message = "#{msg}.\n" \
"The underlying error was #{orig_exception.class}: #{orig_exception.message}, with backtrace:\n" \
" #{orig_exception.backtrace.join("\n ")}\n\n" \
"Bundler Error Backtrace:"
super(full_message)
end
status_code(36)
end
class InsecureInstallPathError < BundlerError
def initialize(name, path)
@name = name
@path = path
end
def message
"Bundler cannot reinstall #{@name} because there's a previous installation of it at #{@path} that is unsafe to remove.\n" \
"The parent of #{@path} is world-writable and does not have the sticky bit set, making it insecure to remove due to potential vulnerabilities.\n" \
"Please change the permissions of #{File.dirname(@path)} or choose a different install path."
end
status_code(38)
end
class CorruptBundlerInstallError < BundlerError
def initialize(loaded_spec)
@loaded_spec = loaded_spec
end
def message
"The running version of Bundler (#{Bundler::VERSION}) does not match the version of the specification installed for it (#{@loaded_spec.version}). " \
"This can be caused by reinstalling Ruby without removing previous installation, leaving around an upgraded default version of Bundler. " \
"Reinstalling Ruby from scratch should fix the problem."
end
status_code(39)
end
class InvalidArgumentError < BundlerError; status_code(40); end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source.rb 0000644 00000006017 15173517745 0015764 0 ustar 00 # frozen_string_literal: true
module Bundler
class Source
autoload :Gemspec, File.expand_path("source/gemspec", __dir__)
autoload :Git, File.expand_path("source/git", __dir__)
autoload :Metadata, File.expand_path("source/metadata", __dir__)
autoload :Path, File.expand_path("source/path", __dir__)
autoload :Rubygems, File.expand_path("source/rubygems", __dir__)
autoload :RubygemsAggregate, File.expand_path("source/rubygems_aggregate", __dir__)
attr_accessor :dependency_names
attr_reader :checksum_store
def unmet_deps
specs.unmet_dependency_names
end
def version_message(spec, locked_spec = nil)
message = "#{spec.name} #{spec.version}"
message += " (#{spec.platform})" if spec.platform != Gem::Platform::RUBY && !spec.platform.nil?
if locked_spec
locked_spec_version = locked_spec.version
if locked_spec_version && spec.version != locked_spec_version
message += Bundler.ui.add_color(" (was #{locked_spec_version})", version_color(spec.version, locked_spec_version))
end
end
message
end
def can_lock?(spec)
spec.source == self
end
def local!; end
def local_only!; end
def cached!; end
def remote!; end
def add_dependency_names(names)
@dependency_names = Array(dependency_names) | Array(names)
end
# it's possible that gems from one source depend on gems from some
# other source, so now we download gemspecs and iterate over those
# dependencies, looking for gems we don't have info on yet.
def double_check_for(*); end
def dependency_names_to_double_check
specs.dependency_names
end
def spec_names
specs.spec_names
end
def include?(other)
other == self
end
def inspect
"#<#{self.class}:0x#{object_id} #{self}>"
end
def identifier
to_s
end
def path?
instance_of?(Bundler::Source::Path)
end
def extension_cache_path(spec)
return unless Bundler.feature_flag.global_gem_cache?
return unless source_slug = extension_cache_slug(spec)
Bundler.user_cache.join(
"extensions", Gem::Platform.local.to_s, Bundler.ruby_scope,
source_slug, spec.full_name
)
end
private
def version_color(spec_version, locked_spec_version)
if Gem::Version.correct?(spec_version) && Gem::Version.correct?(locked_spec_version)
# display yellow if there appears to be a regression
earlier_version?(spec_version, locked_spec_version) ? :yellow : :green
else
# default to green if the versions cannot be directly compared
:green
end
end
def earlier_version?(spec_version, locked_spec_version)
Gem::Version.new(spec_version) < Gem::Version.new(locked_spec_version)
end
def print_using_message(message)
if !message.include?("(was ")
Bundler.ui.debug message
else
Bundler.ui.info message
end
end
def extension_cache_slug(_)
nil
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/inline.rb 0000644 00000006151 15173517745 0015741 0 ustar 00 # frozen_string_literal: true
# Allows for declaring a Gemfile inline in a ruby script, optionally installing
# any gems that aren't already installed on the user's system.
#
# @note Every gem that is specified in this 'Gemfile' will be `require`d, as if
# the user had manually called `Bundler.require`. To avoid a requested gem
# being automatically required, add the `:require => false` option to the
# `gem` dependency declaration.
#
# @param install [Boolean] whether gems that aren't already installed on the
# user's system should be installed.
# Defaults to `false`.
#
# @param gemfile [Proc] a block that is evaluated as a `Gemfile`.
#
# @example Using an inline Gemfile
#
# #!/opt/alt/ruby33/bin/ruby
#
# require 'bundler/inline'
#
# gemfile do
# source 'https://rubygems.org'
# gem 'json', require: false
# gem 'nap', require: 'rest'
# gem 'cocoapods', '~> 0.34.1'
# end
#
# puts Pod::VERSION # => "0.34.4"
#
def gemfile(install = false, options = {}, &gemfile)
require_relative "../bundler"
Bundler.reset!
opts = options.dup
ui = opts.delete(:ui) { Bundler::UI::Shell.new }
ui.level = "silent" if opts.delete(:quiet) || !install
Bundler.ui = ui
raise ArgumentError, "Unknown options: #{opts.keys.join(", ")}" unless opts.empty?
old_gemfile = ENV["BUNDLE_GEMFILE"]
Bundler.unbundle_env!
begin
Bundler.instance_variable_set(:@bundle_path, Pathname.new(Gem.dir))
Bundler::SharedHelpers.set_env "BUNDLE_GEMFILE", "Gemfile"
Bundler::Plugin.gemfile_install(&gemfile) if Bundler.feature_flag.plugins?
builder = Bundler::Dsl.new
builder.instance_eval(&gemfile)
Bundler.settings.temporary(deployment: false, frozen: false) do
definition = builder.to_definition(nil, true)
definition.validate_runtime!
if install || definition.missing_specs?
Bundler.settings.temporary(inline: true, no_install: false) do
installer = Bundler::Installer.install(Bundler.root, definition, system: true)
installer.post_install_messages.each do |name, message|
Bundler.ui.info "Post-install message from #{name}:\n#{message}"
end
end
end
begin
runtime = Bundler::Runtime.new(nil, definition).setup
rescue Gem::LoadError => e
name = e.name
version = e.requirement.requirements.first[1]
activated_version = Gem.loaded_specs[name].version
Bundler.ui.info \
"The #{name} gem was resolved to #{version}, but #{activated_version} was activated by Bundler while installing it, causing a conflict. " \
"Bundler will now retry resolving with #{activated_version} instead."
builder.dependencies.delete_if {|d| d.name == name }
builder.instance_eval { gem name, activated_version }
definition = builder.to_definition(nil, true)
retry
end
runtime.require
end
ensure
if old_gemfile
ENV["BUNDLE_GEMFILE"] = old_gemfile
else
ENV["BUNDLE_GEMFILE"] = ""
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/templates/Executable.bundler 0000644 00000005550 15173517745 0021574 0 ustar 00 #!/usr/bin/env <%= Bundler.settings[:shebang] || RbConfig::CONFIG["ruby_install_name"] %>
# frozen_string_literal: true
#
# This file was generated by Bundler.
#
# The application '<%= executable %>' is installed as part of a gem, and
# this file is here to facilitate running it.
#
require "rubygems"
m = Module.new do
module_function
def invoked_as_script?
File.expand_path($0) == File.expand_path(__FILE__)
end
def env_var_version
ENV["BUNDLER_VERSION"]
end
def cli_arg_version
return unless invoked_as_script? # don't want to hijack other binstubs
return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
bundler_version = nil
update_index = nil
ARGV.each_with_index do |a, i|
if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN)
bundler_version = a
end
next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
bundler_version = $1
update_index = i
end
bundler_version
end
def gemfile
gemfile = ENV["BUNDLE_GEMFILE"]
return gemfile if gemfile && !gemfile.empty?
File.expand_path("<%= relative_gemfile_path %>", __dir__)
end
def lockfile
lockfile =
case File.basename(gemfile)
when "gems.rb" then gemfile.sub(/\.rb$/, ".locked")
else "#{gemfile}.lock"
end
File.expand_path(lockfile)
end
def lockfile_version
return unless File.file?(lockfile)
lockfile_contents = File.read(lockfile)
return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
Regexp.last_match(1)
end
def bundler_requirement
@bundler_requirement ||=
env_var_version ||
cli_arg_version ||
bundler_requirement_for(lockfile_version)
end
def bundler_requirement_for(version)
return "#{Gem::Requirement.default}.a" unless version
bundler_gem_version = Gem::Version.new(version)
bundler_gem_version.approximate_recommendation
end
def load_bundler!
ENV["BUNDLE_GEMFILE"] ||= gemfile
activate_bundler
end
def activate_bundler
gem_error = activation_error_handling do
gem "bundler", bundler_requirement
end
return if gem_error.nil?
require_error = activation_error_handling do
require "bundler/version"
end
return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
exit 42
end
def activation_error_handling
yield
nil
rescue StandardError, LoadError => e
e
end
end
m.load_bundler!
if m.invoked_as_script?
load Gem.bin_path("<%= spec.name %>", "<%= executable %>")
end
share/gems/gems/bundler-2.5.22/lib/bundler/templates/Executable 0000644 00000001544 15173517745 0020141 0 ustar 00 #!/usr/bin/env <%= Bundler.settings[:shebang] || RbConfig::CONFIG["ruby_install_name"] %>
# frozen_string_literal: true
#
# This file was generated by Bundler.
#
# The application '<%= executable %>' is installed as part of a gem, and
# this file is here to facilitate running it.
#
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("<%= relative_gemfile_path %>", __dir__)
bundle_binstub = File.expand_path("bundle", __dir__)
if File.file?(bundle_binstub)
if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
load(bundle_binstub)
else
abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
end
end
require "rubygems"
require "bundler/setup"
load Gem.bin_path("<%= spec.name %>", "<%= executable %>")
share/gems/gems/bundler-2.5.22/lib/bundler/templates/Gemfile 0000644 00000000114 15173517745 0017420 0 ustar 00 # frozen_string_literal: true
source "https://rubygems.org"
# gem "rails"
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/exe/newgem.tt 0000644 00000000106 15173517745 0022024 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
require "<%= config[:namespaced_path] %>"
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/rubocop.yml.tt 0000644 00000000354 15173517745 0022237 0 ustar 00 AllCops:
TargetRubyVersion: <%= ::Gem::Version.new(config[:required_ruby_version]).segments[0..1].join(".") %>
Style/StringLiterals:
EnforcedStyle: double_quotes
Style/StringLiteralsInInterpolation:
EnforcedStyle: double_quotes
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/bin/console.tt 0000644 00000000470 15173517745 0022177 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
# frozen_string_literal: true
require "bundler/setup"
require "<%= config[:namespaced_path] %>"
# You can add fixtures and/or initialization code here to make experimenting
# with your gem easier. You can also use a different console, if you like.
require "irb"
IRB.start(__FILE__)
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/bin/setup.tt 0000644 00000000203 15173517745 0021667 0 ustar 00 #!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'
set -vx
bundle install
# Do any other automated setup that you need to do here
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/sig/newgem.rbs.tt 0000644 00000000545 15173517746 0022622 0 ustar 00 <%- config[:constant_array].each_with_index do |c, i| -%>
<%= " " * i %>module <%= c %>
<%- end -%>
<%= " " * config[:constant_array].size %>VERSION: String
<%= " " * config[:constant_array].size %># See the writing guide of rbs: https://github.com/ruby/rbs#guides
<%- (config[:constant_array].size-1).downto(0) do |i| -%>
<%= " " * i %>end
<%- end -%>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/github/workflows/main.yml.tt 0000644 00000001431 15173517746 0025027 0 ustar 00 name: Ruby
on:
push:
branches:
- <%= config[:git_default_branch] %>
pull_request:
jobs:
build:
runs-on: ubuntu-latest
name: Ruby ${{ matrix.ruby }}
strategy:
matrix:
ruby:
- '<%= RUBY_VERSION %>'
steps:
- uses: actions/checkout@v4
<%- if config[:ext] == 'rust' -%>
- name: Set up Ruby & Rust
uses: oxidize-rb/actions/setup-ruby-and-rust@v1
with:
ruby-version: ${{ matrix.ruby }}
bundler-cache: true
cargo-cache: true
rubygems: '<%= ::Gem.rubygems_version %>'
<%- else -%>
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ matrix.ruby }}
bundler-cache: true
<%- end -%>
- name: Run the default task
run: bundle exec rake
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/ext/newgem/newgem.h.tt 0000644 00000000261 15173517746 0023556 0 ustar 00 #ifndef <%= config[:underscored_name].upcase %>_H
#define <%= config[:underscored_name].upcase %>_H 1
#include "ruby.h"
#endif /* <%= config[:underscored_name].upcase %>_H */
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/ext/newgem/src/lib.rs.tt 0000644 00000000570 15173517746 0024031 0 ustar 00 use magnus::{function, prelude::*, Error, Ruby};
fn hello(subject: String) -> String {
format!("Hello from Rust, {subject}!")
}
#[magnus::init]
fn init(ruby: &Ruby) -> Result<(), Error> {
let module = ruby.<%= config[:constant_array].map {|c| "define_module(#{c.dump})?"}.join(".") %>;
module.define_singleton_method("hello", function!(hello, 1))?;
Ok(())
}
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/ext/newgem/extconf-c.rb.tt 0000644 00000000514 15173517746 0024337 0 ustar 00 # frozen_string_literal: true
require "mkmf"
# Makes all symbols private by default to avoid unintended conflict
# with other gems. To explicitly export symbols you can use RUBY_FUNC_EXPORTED
# selectively, or entirely remove this flag.
append_cflags("-fvisibility=hidden")
create_makefile(<%= config[:makefile_path].inspect %>)
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/ext/newgem/Cargo.toml.tt 0000644 00000000440 15173517746 0024052 0 ustar 00 [package]
name = <%= config[:name].inspect %>
version = "0.1.0"
edition = "2021"
authors = ["<%= config[:author] %> <<%= config[:email] %>>"]
<%- if config[:mit] -%>
license = "MIT"
<%- end -%>
publish = false
[lib]
crate-type = ["cdylib"]
[dependencies]
magnus = { version = "0.6.2" }
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/ext/newgem/extconf-rust.rb.tt 0000644 00000000201 15173517746 0025103 0 ustar 00 # frozen_string_literal: true
require "mkmf"
require "rb_sys/mkmf"
create_rust_makefile(<%= config[:makefile_path].inspect %>)
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/ext/newgem/newgem.c.tt 0000644 00000000414 15173517746 0023551 0 ustar 00 #include "<%= config[:underscored_name] %>.h"
VALUE rb_m<%= config[:constant_array].join %>;
RUBY_FUNC_EXPORTED void
Init_<%= config[:underscored_name] %>(void)
{
rb_m<%= config[:constant_array].join %> = rb_define_module(<%= config[:constant_name].inspect %>);
}
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/circleci/config.yml.tt 0000644 00000001340 15173517746 0023605 0 ustar 00 version: 2.1
jobs:
build:
docker:
- image: ruby:<%= RUBY_VERSION %>
<%- if config[:ext] == 'rust' -%>
environment:
RB_SYS_FORCE_INSTALL_RUST_TOOLCHAIN: 'true'
<%- end -%>
steps:
- checkout
<%- if config[:ext] == 'rust' -%>
- run:
name: Install Rust/Cargo dependencies
command: apt-get update && apt-get install -y clang
- run:
name: Install a RubyGems version that can compile rust extensions
command: gem update --system '<%= ::Gem.rubygems_version %>'
<%- end -%>
- run:
name: Run the default task
command: |
gem install bundler -v <%= Bundler::VERSION %>
bundle install
bundle exec rake
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/standard.yml.tt 0000644 00000000270 15173517746 0022364 0 ustar 00 # For available configuration options, see:
# https://github.com/standardrb/standard
ruby_version: <%= ::Gem::Version.new(config[:required_ruby_version]).segments[0..1].join(".") %>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/Cargo.toml.tt 0000644 00000000377 15173517746 0022001 0 ustar 00 # This Cargo.toml is here to let externals tools (IDEs, etc.) know that this is
# a Rust project. Your extensions dependencies should be added to the Cargo.toml
# in the ext/ directory.
[workspace]
members = ["./ext/<%= config[:name] %>"]
resolver = "2"
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/CHANGELOG.md.tt 0000644 00000000120 15173517746 0021644 0 ustar 00 ## [Unreleased]
## [0.1.0] - <%= Time.now.strftime('%F') %>
- Initial release
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/spec/spec_helper.rb.tt 0000644 00000000612 15173517746 0023611 0 ustar 00 # frozen_string_literal: true
require "<%= config[:namespaced_path] %>"
RSpec.configure do |config|
# Enable flags like --only-failures and --next-failure
config.example_status_persistence_file_path = ".rspec_status"
# Disable RSpec exposing methods globally on `Module` and `main`
config.disable_monkey_patching!
config.expect_with :rspec do |c|
c.syntax = :expect
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/spec/newgem_spec.rb.tt 0000644 00000000376 15173517746 0023623 0 ustar 00 # frozen_string_literal: true
RSpec.describe <%= config[:constant_name] %> do
it "has a version number" do
expect(<%= config[:constant_name] %>::VERSION).not_to be nil
end
it "does something useful" do
expect(false).to eq(true)
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/newgem.gemspec.tt 0000644 00000004244 15173517746 0022675 0 ustar 00 # frozen_string_literal: true
require_relative "lib/<%=config[:namespaced_path]%>/version"
Gem::Specification.new do |spec|
spec.name = <%= config[:name].inspect %>
spec.version = <%= config[:constant_name] %>::VERSION
spec.authors = [<%= config[:author].inspect %>]
spec.email = [<%= config[:email].inspect %>]
spec.summary = "TODO: Write a short summary, because RubyGems requires one."
spec.description = "TODO: Write a longer description or delete this line."
spec.homepage = "TODO: Put your gem's website or public repo URL here."
<%- if config[:mit] -%>
spec.license = "MIT"
<%- end -%>
spec.required_ruby_version = ">= <%= config[:required_ruby_version] %>"
<%- if config[:ext] == 'rust' -%>
spec.required_rubygems_version = ">= <%= config[:rust_builder_required_rubygems_version] %>"
<%- end -%>
spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
# 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.
gemspec = File.basename(__FILE__)
spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
ls.readlines("\x0", chomp: true).reject do |f|
(f == gemspec) ||
f.start_with?(*%w[bin/ test/ spec/ features/ .git <%= config[:ci_config_path] %>appveyor Gemfile])
end
end
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]
<%- if config[:ext] == 'c' -%>
spec.extensions = ["ext/<%= config[:underscored_name] %>/extconf.rb"]
<%- end -%>
<%- if config[:ext] == 'rust' -%>
spec.extensions = ["ext/<%= config[:underscored_name] %>/Cargo.toml"]
<%- end -%>
# Uncomment to register a new dependency of your gem
# spec.add_dependency "example-gem", "~> 1.0"
# For more information and examples about making a new gem, check out our
# guide at: https://bundler.io/guides/creating_gem.html
end
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/rspec.tt 0000644 00000000065 15173517746 0021102 0 ustar 00 --format documentation
--color
--require spec_helper
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/LICENSE.txt.tt 0000644 00000002121 15173517746 0021661 0 ustar 00 The MIT License (MIT)
Copyright (c) <%= Time.now.year %> <%= config[:author] %>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/Rakefile.tt 0000644 00000003157 15173517746 0021515 0 ustar 00 # frozen_string_literal: true
require "bundler/gem_tasks"
<% default_task_names = [config[:test_task]].compact -%>
<% case config[:test] -%>
<% when "minitest" -%>
require "minitest/test_task"
Minitest::TestTask.create
<% when "test-unit" -%>
require "rake/testtask"
Rake::TestTask.new(:test) do |t|
t.libs << "test"
t.libs << "lib"
t.test_files = FileList["test/**/*_test.rb"]
end
<% when "rspec" -%>
require "rspec/core/rake_task"
RSpec::Core::RakeTask.new(:spec)
<% end -%>
<% if config[:linter] == "rubocop" -%>
<% default_task_names << :rubocop -%>
require "rubocop/rake_task"
RuboCop::RakeTask.new
<% elsif config[:linter] == "standard" -%>
<% default_task_names << :standard -%>
require "standard/rake"
<% end -%>
<% if config[:ext] -%>
<% default_task_names.unshift(:compile) -%>
<% default_task_names.unshift(:clobber) unless config[:ext] == 'rust' -%>
<% if config[:ext] == 'rust' -%>
require "rb_sys/extensiontask"
task build: :compile
GEMSPEC = Gem::Specification.load("<%= config[:underscored_name] %>.gemspec")
RbSys::ExtensionTask.new(<%= config[:name].inspect %>, GEMSPEC) do |ext|
ext.lib_dir = "lib/<%= config[:namespaced_path] %>"
end
<% else -%>
require "rake/extensiontask"
task build: :compile
GEMSPEC = Gem::Specification.load("<%= config[:underscored_name] %>.gemspec")
Rake::ExtensionTask.new("<%= config[:underscored_name] %>", GEMSPEC) do |ext|
ext.lib_dir = "lib/<%= config[:namespaced_path] %>"
end
<% end -%>
<% end -%>
<% if default_task_names.size == 1 -%>
task default: <%= default_task_names.first.inspect %>
<% else -%>
task default: %i[<%= default_task_names.join(" ") %>]
<% end -%>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/Gemfile.tt 0000644 00000001127 15173517746 0021336 0 ustar 00 # frozen_string_literal: true
source "https://rubygems.org"
# Specify your gem's dependencies in <%= config[:name] %>.gemspec
gemspec
gem "rake", "~> 13.0"
<%- if config[:ext] -%>
gem "rake-compiler"
<%- if config[:ext] == 'rust' -%>
gem "rb_sys", "~> 0.9.63"
<%- end -%>
<%- end -%>
<%- if config[:test] -%>
gem "<%= config[:test] %>", "~> <%= config[:test_framework_version] %>"
<%- end -%>
<%- if config[:linter] == "rubocop" -%>
gem "rubocop", "~> <%= config[:linter_version] %>"
<%- elsif config[:linter] == "standard" -%>
gem "standard", "~> <%= config[:linter_version] %>"
<%- end -%>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/gitlab-ci.yml.tt 0000644 00000000672 15173517746 0022425 0 ustar 00 default:
image: ruby:<%= RUBY_VERSION %>
before_script:
<%- if config[:ext] == 'rust' -%>
- apt-get update && apt-get install -y clang
- gem update --system '<%= ::Gem.rubygems_version %>'
<%- end -%>
- gem install bundler -v <%= Bundler::VERSION %>
- bundle install
example_job:
<%- if config[:ext] == 'rust' -%>
variables:
RB_SYS_FORCE_INSTALL_RUST_TOOLCHAIN: 'true'
<%- end -%>
script:
- bundle exec rake
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/gitignore.tt 0000644 00000000432 15173517746 0021753 0 ustar 00 /.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
<%- if config[:ext] -%>
*.bundle
*.so
*.o
*.a
mkmf.log
<%- if config[:ext] == 'rust' -%>
target/
<%- end -%>
<%- end -%>
<%- if config[:test] == "rspec" -%>
# rspec failure tracking
.rspec_status
<%- end -%>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/lib/newgem/version.rb.tt 0000644 00000000431 15173517746 0024102 0 ustar 00 # frozen_string_literal: true
<%- config[:constant_array].each_with_index do |c, i| -%>
<%= " " * i %>module <%= c %>
<%- end -%>
<%= " " * config[:constant_array].size %>VERSION = "0.1.0"
<%- (config[:constant_array].size-1).downto(0) do |i| -%>
<%= " " * i %>end
<%- end -%>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/lib/newgem.rb.tt 0000644 00000001075 15173517746 0022422 0 ustar 00 # frozen_string_literal: true
require_relative "<%= File.basename(config[:namespaced_path]) %>/version"
<%- if config[:ext] -%>
require_relative "<%= File.basename(config[:namespaced_path]) %>/<%= config[:underscored_name] %>"
<%- end -%>
<%- config[:constant_array].each_with_index do |c, i| -%>
<%= " " * i %>module <%= c %>
<%- end -%>
<%= " " * config[:constant_array].size %>class Error < StandardError; end
<%= " " * config[:constant_array].size %># Your code goes here...
<%- (config[:constant_array].size-1).downto(0) do |i| -%>
<%= " " * i %>end
<%- end -%>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/CODE_OF_CONDUCT.md.tt 0000644 00000012557 15173517746 0022653 0 ustar 00 # Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series of
actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within the
community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].
[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/README.md.tt 0000644 00000005522 15173517746 0021325 0 ustar 00 # <%= config[:constant_name] %>
TODO: Delete this and the text below, and describe your gem
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/<%= config[:namespaced_path] %>`. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
Install the gem and add to the application's Gemfile by executing:
```bash
bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
```
If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
```
## Usage
TODO: Write usage instructions here
## Development
After checking out the repo, run `bin/setup` to install dependencies.<% if config[:test] %> Then, run `rake <%= config[:test].sub('mini', '').sub('rspec', 'spec') %>` to run the tests.<% end %> You can also run `bin/console` for an interactive prompt that will allow you to experiment.<% if config[:bin] %> Run `bundle exec <%= config[:name] %>` to use the gem in this directory, ignoring other installed copies of this gem.<% end %>
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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
<% if config[:git] -%>
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/<%= config[:github_username] %>/<%= config[:name] %>.<% if config[:coc] %> This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/<%= config[:github_username] %>/<%= config[:name] %>/blob/<%= config[:git_default_branch] %>/CODE_OF_CONDUCT.md).<% end %>
<% end -%>
<% if config[:mit] -%>
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
<% end -%>
<% if config[:git] && config[:coc] -%>
## Code of Conduct
Everyone interacting in the <%= config[:constant_name] %> project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/<%= config[:github_username] %>/<%= config[:name] %>/blob/<%= config[:git_default_branch] %>/CODE_OF_CONDUCT.md).
<% end -%>
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/test/minitest/test_newgem.rb.tt 0000644 00000000432 15173517746 0025522 0 ustar 00 # frozen_string_literal: true
require "test_helper"
class <%= config[:minitest_constant_name] %> < Minitest::Test
def test_that_it_has_a_version_number
refute_nil ::<%= config[:constant_name] %>::VERSION
end
def test_it_does_something_useful
assert false
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/test/minitest/test_helper.rb.tt 0000644 00000000234 15173517746 0025517 0 ustar 00 # frozen_string_literal: true
$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
require "<%= config[:namespaced_path] %>"
require "minitest/autorun"
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/test/test-unit/newgem_test.rb.tt 0000644 00000000463 15173517746 0025626 0 ustar 00 # frozen_string_literal: true
require "test_helper"
class <%= config[:constant_name] %>Test < Test::Unit::TestCase
test "VERSION" do
assert do
::<%= config[:constant_name] %>.const_defined?(:VERSION)
end
end
test "something useful" do
assert_equal("expected", "actual")
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/templates/newgem/test/test-unit/test_helper.rb.tt 0000644 00000000225 15173517746 0025617 0 ustar 00 # frozen_string_literal: true
$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
require "<%= config[:namespaced_path] %>"
require "test-unit"
share/gems/gems/bundler-2.5.22/lib/bundler/templates/Executable.standalone 0000644 00000000654 15173517746 0022272 0 ustar 00 #!/usr/bin/env <%= Bundler.settings[:shebang] || RbConfig::CONFIG["ruby_install_name"] %>
# frozen_string_literal: true
#
# This file was generated by Bundler.
#
# The application '<%= executable %>' is installed as part of a gem, and
# this file is here to facilitate running it.
#
$:.unshift File.expand_path "<%= standalone_path %>", __dir__
require "bundler/setup"
load File.expand_path "<%= executable_path %>", __dir__
share/gems/gems/bundler-2.5.22/lib/bundler/compact_index_client.rb 0000644 00000006435 15173517746 0020644 0 ustar 00 # frozen_string_literal: true
require "pathname"
require "set"
module Bundler
# The CompactIndexClient is responsible for fetching and parsing the compact index.
#
# The compact index is a set of caching optimized files that are used to fetch gem information.
# The files are:
# - names: a list of all gem names
# - versions: a list of all gem versions
# - info/[gem]: a list of all versions of a gem
#
# The client is instantiated with:
# - `directory`: the root directory where the cache files are stored.
# - `fetcher`: (optional) an object that responds to #call(uri_path, headers) and returns an http response.
# If the `fetcher` is not provided, the client will only read cached files from disk.
#
# The client is organized into:
# - `Updater`: updates the cached files on disk using the fetcher.
# - `Cache`: calls the updater, caches files, read and return them from disk
# - `Parser`: parses the compact index file data
# - `CacheFile`: a concurrency safe file reader/writer that verifies checksums
#
# The client is intended to optimize memory usage and performance.
# It is called 100s or 1000s of times, parsing files with hundreds of thousands of lines.
# It may be called concurrently without global interpreter lock in some Rubies.
# As a result, some methods may look more complex than necessary to save memory or time.
class CompactIndexClient
# NOTE: MD5 is here not because we expect a server to respond with it, but
# because we use it to generate the etag on first request during the upgrade
# to the compact index client that uses opaque etags saved to files.
# Remove once 2.5.0 has been out for a while.
SUPPORTED_DIGESTS = { "sha-256" => :SHA256, "md5" => :MD5 }.freeze
DEBUG_MUTEX = Thread::Mutex.new
# info returns an Array of INFO Arrays. Each INFO Array has the following indices:
INFO_NAME = 0
INFO_VERSION = 1
INFO_PLATFORM = 2
INFO_DEPS = 3
INFO_REQS = 4
def self.debug
return unless ENV["DEBUG_COMPACT_INDEX"]
DEBUG_MUTEX.synchronize { warn("[#{self}] #{yield}") }
end
class Error < StandardError; end
require_relative "compact_index_client/cache"
require_relative "compact_index_client/cache_file"
require_relative "compact_index_client/parser"
require_relative "compact_index_client/updater"
def initialize(directory, fetcher = nil)
@cache = Cache.new(directory, fetcher)
@parser = Parser.new(@cache)
end
def names
Bundler::CompactIndexClient.debug { "names" }
@parser.names
end
def versions
Bundler::CompactIndexClient.debug { "versions" }
@parser.versions
end
def dependencies(names)
Bundler::CompactIndexClient.debug { "dependencies(#{names})" }
names.map {|name| info(name) }
end
def info(name)
Bundler::CompactIndexClient.debug { "info(#{name})" }
@parser.info(name)
end
def latest_version(name)
Bundler::CompactIndexClient.debug { "latest_version(#{name})" }
@parser.info(name).map {|d| Gem::Version.new(d[INFO_VERSION]) }.max
end
def available?
Bundler::CompactIndexClient.debug { "available?" }
@parser.available?
end
def reset!
Bundler::CompactIndexClient.debug { "reset!" }
@cache.reset!
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/fetcher/compact_index.rb 0000644 00000007465 15173517746 0020732 0 ustar 00 # frozen_string_literal: true
require_relative "base"
require_relative "../worker"
module Bundler
class Fetcher
class CompactIndex < Base
def self.compact_index_request(method_name)
method = instance_method(method_name)
undef_method(method_name)
define_method(method_name) do |*args, &blk|
method.bind(self).call(*args, &blk)
rescue NetworkDownError, CompactIndexClient::Updater::MismatchedChecksumError => e
raise HTTPError, e.message
rescue AuthenticationRequiredError, BadAuthenticationError
# Fail since we got a 401 from the server.
raise
rescue HTTPError => e
Bundler.ui.trace(e)
nil
end
end
def specs(gem_names)
specs_for_names(gem_names)
end
compact_index_request :specs
def specs_for_names(gem_names)
gem_info = []
complete_gems = []
remaining_gems = gem_names.dup
until remaining_gems.empty?
log_specs { "Looking up gems #{remaining_gems.inspect}" }
deps = fetch_gem_infos(remaining_gems).flatten(1)
next_gems = deps.flat_map {|d| d[CompactIndexClient::INFO_DEPS].flat_map(&:first) }.uniq
deps.each {|dep| gem_info << dep }
complete_gems.concat(deps.map(&:first)).uniq!
remaining_gems = next_gems - complete_gems
end
@bundle_worker&.stop
@bundle_worker = nil # reset it. Not sure if necessary
gem_info
end
def available?
unless SharedHelpers.md5_available?
Bundler.ui.debug("FIPS mode is enabled, bundler can't use the CompactIndex API")
return nil
end
# Read info file checksums out of /versions, so we can know if gems are up to date
compact_index_client.available?
rescue CompactIndexClient::Updater::MismatchedChecksumError => e
Bundler.ui.debug(e.message)
nil
end
compact_index_request :available?
def api_fetcher?
true
end
private
def compact_index_client
@compact_index_client ||=
SharedHelpers.filesystem_access(cache_path) do
CompactIndexClient.new(cache_path, client_fetcher)
end
end
def fetch_gem_infos(names)
in_parallel(names) {|name| compact_index_client.info(name) }
rescue TooManyRequestsError # rubygems.org is rate limiting us, slow down.
@bundle_worker&.stop
@bundle_worker = nil # reset it. Not sure if necessary
compact_index_client.reset!
names.map {|name| compact_index_client.info(name) }
end
def in_parallel(inputs, &blk)
func = lambda {|object, _index| blk.call(object) }
worker = bundle_worker(func)
inputs.each {|input| worker.enq(input) }
inputs.map { worker.deq }
end
def bundle_worker(func = nil)
@bundle_worker ||= begin
worker_name = "Compact Index (#{display_uri.host})"
Bundler::Worker.new(Bundler.settings.processor_count, worker_name, func)
end
@bundle_worker.tap do |worker|
worker.instance_variable_set(:@func, func) if func
end
end
def cache_path
Bundler.user_cache.join("compact_index", remote.cache_slug)
end
def client_fetcher
ClientFetcher.new(self, Bundler.ui)
end
ClientFetcher = Struct.new(:fetcher, :ui) do
def call(path, headers)
fetcher.downloader.fetch(fetcher.fetch_uri + path, headers)
rescue NetworkDownError => e
raise unless Bundler.feature_flag.allow_offline_install? && headers["If-None-Match"]
ui.warn "Using the cached data for the new index because of a network error: #{e}"
Gem::Net::HTTPNotModified.new(nil, nil, nil)
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/fetcher/gem_remote_fetcher.rb 0000644 00000000511 15173517746 0021721 0 ustar 00 # frozen_string_literal: true
require "rubygems/remote_fetcher"
module Bundler
class Fetcher
class GemRemoteFetcher < Gem::RemoteFetcher
def request(*args)
super do |req|
req.delete("User-Agent") if headers["User-Agent"]
yield req if block_given?
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/fetcher/dependency.rb 0000644 00000004632 15173517746 0020224 0 ustar 00 # frozen_string_literal: true
require_relative "base"
require "cgi"
module Bundler
class Fetcher
class Dependency < Base
def available?
@available ||= fetch_uri.scheme != "file" && downloader.fetch(dependency_api_uri)
rescue NetworkDownError => e
raise HTTPError, e.message
rescue AuthenticationRequiredError
# Fail since we got a 401 from the server.
raise
rescue HTTPError
false
end
def api_fetcher?
true
end
def specs(gem_names, full_dependency_list = [], last_spec_list = [])
query_list = gem_names.uniq - full_dependency_list
log_specs { "Query List: #{query_list.inspect}" }
return last_spec_list if query_list.empty?
spec_list, deps_list = Bundler::Retry.new("dependency api", FAIL_ERRORS).attempts do
dependency_specs(query_list)
end
returned_gems = spec_list.map(&:first).uniq
specs(deps_list, full_dependency_list + returned_gems, spec_list + last_spec_list)
rescue MarshalError, HTTPError, GemspecError
Bundler.ui.info "" unless Bundler.ui.debug? # new line now that the dots are over
Bundler.ui.debug "could not fetch from the dependency API, trying the full index"
nil
end
def dependency_specs(gem_names)
Bundler.ui.debug "Query Gemcutter Dependency Endpoint API: #{gem_names.join(",")}"
gem_list = unmarshalled_dep_gems(gem_names)
get_formatted_specs_and_deps(gem_list)
end
def unmarshalled_dep_gems(gem_names)
gem_list = []
gem_names.each_slice(Source::Rubygems::API_REQUEST_SIZE) do |names|
marshalled_deps = downloader.fetch(dependency_api_uri(names)).body
gem_list.concat(Bundler.safe_load_marshal(marshalled_deps))
end
gem_list
end
def get_formatted_specs_and_deps(gem_list)
deps_list = []
spec_list = []
gem_list.each do |s|
deps_list.concat(s[:dependencies].map(&:first))
deps = s[:dependencies].map {|n, d| [n, d.split(", ")] }
spec_list.push([s[:name], s[:number], s[:platform], deps])
end
[spec_list, deps_list]
end
def dependency_api_uri(gem_names = [])
uri = fetch_uri + "api/v1/dependencies"
uri.query = "gems=#{CGI.escape(gem_names.sort.join(","))}" if gem_names.any?
uri
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/fetcher/downloader.rb 0000644 00000006176 15173517746 0020251 0 ustar 00 # frozen_string_literal: true
module Bundler
class Fetcher
class Downloader
attr_reader :connection
attr_reader :redirect_limit
def initialize(connection, redirect_limit)
@connection = connection
@redirect_limit = redirect_limit
end
def fetch(uri, headers = {}, counter = 0)
raise HTTPError, "Too many redirects" if counter >= redirect_limit
filtered_uri = URICredentialsFilter.credential_filtered_uri(uri)
response = request(uri, headers)
Bundler.ui.debug("HTTP #{response.code} #{response.message} #{filtered_uri}")
case response
when Gem::Net::HTTPSuccess, Gem::Net::HTTPNotModified
response
when Gem::Net::HTTPRedirection
new_uri = Gem::URI.parse(response["location"])
if new_uri.host == uri.host
new_uri.user = uri.user
new_uri.password = uri.password
end
fetch(new_uri, headers, counter + 1)
when Gem::Net::HTTPRequestedRangeNotSatisfiable
new_headers = headers.dup
new_headers.delete("Range")
new_headers["Accept-Encoding"] = "gzip"
fetch(uri, new_headers)
when Gem::Net::HTTPRequestEntityTooLarge
raise FallbackError, response.body
when Gem::Net::HTTPTooManyRequests
raise TooManyRequestsError, response.body
when Gem::Net::HTTPUnauthorized
raise BadAuthenticationError, uri.host if uri.userinfo
raise AuthenticationRequiredError, uri.host
when Gem::Net::HTTPForbidden
raise AuthenticationForbiddenError, uri.host
when Gem::Net::HTTPNotFound
raise FallbackError, "Gem::Net::HTTPNotFound: #{filtered_uri}"
else
message = "Gem::#{response.class.name.gsub(/\AGem::/, "")}"
message += ": #{response.body}" unless response.body.empty?
raise HTTPError, message
end
end
def request(uri, headers)
validate_uri_scheme!(uri)
filtered_uri = URICredentialsFilter.credential_filtered_uri(uri)
Bundler.ui.debug "HTTP GET #{filtered_uri}"
req = Gem::Net::HTTP::Get.new uri.request_uri, headers
if uri.user
user = CGI.unescape(uri.user)
password = uri.password ? CGI.unescape(uri.password) : nil
req.basic_auth(user, password)
end
connection.request(uri, req)
rescue OpenSSL::SSL::SSLError
raise CertificateFailureError.new(uri)
rescue *HTTP_ERRORS => e
Bundler.ui.trace e
if e.is_a?(SocketError) || e.message.to_s.include?("host down:")
raise NetworkDownError, "Could not reach host #{uri.host}. Check your network " \
"connection and try again."
else
raise HTTPError, "Network error while fetching #{filtered_uri}" \
" (#{e})"
end
end
private
def validate_uri_scheme!(uri)
return if /\Ahttps?\z/.match?(uri.scheme)
raise InvalidOption,
"The request uri `#{uri}` has an invalid scheme (`#{uri.scheme}`). " \
"Did you mean `http` or `https`?"
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/fetcher/index.rb 0000644 00000001404 15173517746 0017207 0 ustar 00 # frozen_string_literal: true
require_relative "base"
module Bundler
class Fetcher
class Index < Base
def specs(_gem_names)
Bundler.rubygems.fetch_all_remote_specs(remote, gem_remote_fetcher)
rescue Gem::RemoteFetcher::FetchError => e
case e.message
when /certificate verify failed/
raise CertificateFailureError.new(display_uri)
when /401/
raise BadAuthenticationError, remote_uri if remote_uri.userinfo
raise AuthenticationRequiredError, remote_uri
when /403/
raise AuthenticationForbiddenError, remote_uri
else
raise HTTPError, "Could not fetch specs from #{display_uri} due to underlying error <#{e.message}>"
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/fetcher/base.rb 0000644 00000002027 15173517746 0017014 0 ustar 00 # frozen_string_literal: true
module Bundler
class Fetcher
class Base
attr_reader :downloader
attr_reader :display_uri
attr_reader :remote
attr_reader :gem_remote_fetcher
def initialize(downloader, remote, display_uri, gem_remote_fetcher)
raise "Abstract class" if self.class == Base
@downloader = downloader
@remote = remote
@display_uri = display_uri
@gem_remote_fetcher = gem_remote_fetcher
end
def remote_uri
@remote.uri
end
def fetch_uri
@fetch_uri ||= if remote_uri.host == "rubygems.org"
uri = remote_uri.dup
uri.host = "index.rubygems.org"
uri
else
remote_uri
end
end
def available?
true
end
def api_fetcher?
false
end
private
def log_specs(&block)
if Bundler.ui.debug?
Bundler.ui.debug yield
else
Bundler.ui.info ".", false
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/lockfile_generator.rb 0000644 00000004666 15173517746 0020333 0 ustar 00 # frozen_string_literal: true
module Bundler
class LockfileGenerator
attr_reader :definition
attr_reader :out
# @private
def initialize(definition)
@definition = definition
@out = String.new
end
def self.generate(definition)
new(definition).generate!
end
def generate!
add_sources
add_platforms
add_dependencies
add_checksums
add_locked_ruby_version
add_bundled_with
out
end
private
def add_sources
definition.send(:sources).lock_sources.each_with_index do |source, idx|
out << "\n" unless idx.zero?
# Add the source header
out << source.to_lock
# Find all specs for this source
specs = definition.resolve.select {|s| source.can_lock?(s) }
add_specs(specs)
end
end
def add_specs(specs)
# This needs to be sorted by full name so that
# gems with the same name, but different platform
# are ordered consistently
specs.sort_by(&:full_name).each do |spec|
next if spec.name == "bundler"
out << spec.to_lock
end
end
def add_platforms
add_section("PLATFORMS", definition.platforms)
end
def add_dependencies
out << "\nDEPENDENCIES\n"
handled = []
definition.dependencies.sort_by(&:to_s).each do |dep|
next if handled.include?(dep.name)
out << dep.to_lock << "\n"
handled << dep.name
end
end
def add_checksums
return unless definition.locked_checksums
checksums = definition.resolve.map do |spec|
spec.source.checksum_store.to_lock(spec)
end
add_section("CHECKSUMS", checksums)
end
def add_locked_ruby_version
return unless locked_ruby_version = definition.locked_ruby_version
add_section("RUBY VERSION", locked_ruby_version.to_s)
end
def add_bundled_with
add_section("BUNDLED WITH", definition.bundler_version_to_lock.to_s)
end
def add_section(name, value)
out << "\n#{name}\n"
case value
when Array
value.map(&:to_s).sort.each do |val|
out << " #{val}\n"
end
when Hash
value.to_a.sort_by {|k, _| k.to_s }.each do |key, val|
out << " #{key}: #{val}\n"
end
when String
out << " #{value}\n"
else
raise ArgumentError, "#{value.inspect} can't be serialized in a lockfile"
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vlad.rb 0000644 00000000721 15173517746 0015407 0 ustar 00 # frozen_string_literal: true
require_relative "shared_helpers"
Bundler::SharedHelpers.major_deprecation 2,
"The Bundler task for Vlad"
# Vlad task for Bundler.
#
# Add "require 'bundler/vlad'" in your Vlad deploy.rb, and
# include the vlad:bundle:install task in your vlad:deploy task.
require_relative "deployment"
include Rake::DSL if defined? Rake::DSL
namespace :vlad do
Bundler::Deployment.define_task(Rake::RemoteTask, :remote_task, roles: :app)
end
share/gems/gems/bundler-2.5.22/lib/bundler/source_map.rb 0000644 00000004254 15173517746 0016623 0 ustar 00 # frozen_string_literal: true
module Bundler
class SourceMap
attr_reader :sources, :dependencies, :locked_specs
def initialize(sources, dependencies, locked_specs)
@sources = sources
@dependencies = dependencies
@locked_specs = locked_specs
end
def pinned_spec_names(skip = nil)
direct_requirements.reject {|_, source| source == skip }.keys
end
def all_requirements
requirements = direct_requirements.dup
unmet_deps = sources.non_default_explicit_sources.map do |source|
(source.spec_names - pinned_spec_names).each do |indirect_dependency_name|
previous_source = requirements[indirect_dependency_name]
if previous_source.nil?
requirements[indirect_dependency_name] = source
else
no_ambiguous_sources = Bundler.feature_flag.bundler_3_mode?
msg = ["The gem '#{indirect_dependency_name}' was found in multiple relevant sources."]
msg.concat [previous_source, source].map {|s| " * #{s}" }.sort
msg << "You #{no_ambiguous_sources ? :must : :should} add this gem to the source block for the source you wish it to be installed from."
msg = msg.join("\n")
raise SecurityError, msg if no_ambiguous_sources
Bundler.ui.warn "Warning: #{msg}"
end
end
source.unmet_deps
end
sources.default_source.add_dependency_names(unmet_deps.flatten - requirements.keys)
requirements
end
def direct_requirements
@direct_requirements ||= begin
requirements = {}
default = sources.default_source
dependencies.each do |dep|
dep_source = dep.source || default
dep_source.add_dependency_names(dep.name)
requirements[dep.name] = dep_source
end
requirements
end
end
def locked_requirements
@locked_requirements ||= begin
requirements = {}
locked_specs.each do |locked_spec|
source = locked_spec.source
source.add_dependency_names(locked_spec.name)
requirements[locked_spec.name] = source
end
requirements
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_tsort.rb 0000644 00000000135 15173517746 0017521 0 ustar 00 # frozen_string_literal: true
module Bundler; end
require_relative "vendor/tsort/lib/tsort"
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/api.rb 0000644 00000005520 15173517746 0016532 0 ustar 00 # frozen_string_literal: true
module Bundler
# This is the interfacing class represents the API that we intend to provide
# the plugins to use.
#
# For plugins to be independent of the Bundler internals they shall limit their
# interactions to methods of this class only. This will save them from breaking
# when some internal change.
#
# Currently we are delegating the methods defined in Bundler class to
# itself. So, this class acts as a buffer.
#
# If there is some change in the Bundler class that is incompatible to its
# previous behavior or if otherwise desired, we can reimplement(or implement)
# the method to preserve compatibility.
#
# To use this, either the class can inherit this class or use it directly.
# For example of both types of use, refer the file `spec/plugins/command.rb`
#
# To use it without inheriting, you will have to create an object of this
# to use the functions (except for declaration functions like command, source,
# and hooks).
module Plugin
class API
autoload :Source, File.expand_path("api/source", __dir__)
# The plugins should declare that they handle a command through this helper.
#
# @param [String] command being handled by them
# @param [Class] (optional) class that handles the command. If not
# provided, the `self` class will be used.
def self.command(command, cls = self)
Plugin.add_command command, cls
end
# The plugins should declare that they provide a installation source
# through this helper.
#
# @param [String] the source type they provide
# @param [Class] (optional) class that handles the source. If not
# provided, the `self` class will be used.
def self.source(source, cls = self)
cls.send :include, Bundler::Plugin::API::Source
Plugin.add_source source, cls
end
def self.hook(event, &block)
Plugin.add_hook(event, &block)
end
# The cache dir to be used by the plugins for storage
#
# @return [Pathname] path of the cache dir
def cache_dir
Plugin.cache.join("plugins")
end
# A tmp dir to be used by plugins
# Accepts names that get concatenated as suffix
#
# @return [Pathname] object for the new directory created
def tmp(*names)
Bundler.tmp(["plugin", *names].join("-"))
end
def method_missing(name, *args, &blk)
return Bundler.send(name, *args, &blk) if Bundler.respond_to?(name)
return SharedHelpers.send(name, *args, &blk) if SharedHelpers.respond_to?(name)
super
end
def respond_to_missing?(name, include_private = false)
SharedHelpers.respond_to?(name, include_private) ||
Bundler.respond_to?(name, include_private) || super
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/dsl.rb 0000644 00000003311 15173517746 0016537 0 ustar 00 # frozen_string_literal: true
module Bundler
module Plugin
# Dsl to parse the Gemfile looking for plugins to install
class DSL < Bundler::Dsl
class PluginGemfileError < PluginError; end
alias_method :_gem, :gem # To use for plugin installation as gem
# So that we don't have to override all there methods to dummy ones
# explicitly.
# They will be handled by method_missing
[:gemspec, :gem, :install_if, :platforms, :env].each {|m| undef_method m }
# This lists the plugins that was added automatically and not specified by
# the user.
#
# When we encounter :type attribute with a source block, we add a plugin
# by name bundler-source-<type> to list of plugins to be installed.
#
# These plugins are optional and are not installed when there is conflict
# with any other plugin.
attr_reader :inferred_plugins
def initialize
super
@sources = Plugin::SourceList.new
@inferred_plugins = [] # The source plugins inferred from :type
end
def plugin(name, *args)
_gem(name, *args)
end
def method_missing(name, *args)
raise PluginGemfileError, "Undefined local variable or method `#{name}' for Gemfile" unless Bundler::Dsl.method_defined? name
end
def source(source, *args, &blk)
options = args.last.is_a?(Hash) ? args.pop.dup : {}
options = normalize_hash(options)
return super unless options.key?("type")
plugin_name = "bundler-source-#{options["type"]}"
return if @dependencies.any? {|d| d.name == plugin_name }
plugin(plugin_name)
@inferred_plugins << plugin_name
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/installer/git.rb 0000644 00000001411 15173517746 0020534 0 ustar 00 # frozen_string_literal: true
module Bundler
module Plugin
class Installer
class Git < Bundler::Source::Git
def cache_path
@cache_path ||= begin
git_scope = "#{base_name}-#{uri_hash}"
Plugin.cache.join("bundler", "git", git_scope)
end
end
def install_path
@install_path ||= begin
git_scope = "#{base_name}-#{shortref_for_path(revision)}"
Plugin.root.join("bundler", "gems", git_scope)
end
end
def root
Plugin.root
end
def generate_bin(spec, disable_extensions = false)
# Need to find a way without code duplication
# For now, we can ignore this
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/installer/rubygems.rb 0000644 00000000446 15173517746 0021615 0 ustar 00 # frozen_string_literal: true
module Bundler
module Plugin
class Installer
class Rubygems < Bundler::Source::Rubygems
private
def rubygems_dir
Plugin.root
end
def cache_path
Plugin.cache
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/installer/path.rb 0000644 00000000634 15173517746 0020713 0 ustar 00 # frozen_string_literal: true
module Bundler
module Plugin
class Installer
class Path < Bundler::Source::Path
def root
SharedHelpers.in_bundle? ? Bundler.root : Plugin.root
end
def generate_bin(spec, disable_extensions = false)
# Need to find a way without code duplication
# For now, we can ignore this
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/events.rb 0000644 00000004104 15173517746 0017262 0 ustar 00 # frozen_string_literal: true
module Bundler
module Plugin
module Events
def self.define(const, event)
const = const.to_sym.freeze
if const_defined?(const) && const_get(const) != event
raise ArgumentError, "Attempting to reassign #{const} to a different value"
end
const_set(const, event) unless const_defined?(const)
@events ||= {}
@events[event] = const
end
private_class_method :define
def self.reset
@events.each_value do |const|
remove_const(const)
end
@events = nil
end
private_class_method :reset
# Check if an event has been defined
# @param event [String] An event to check
# @return [Boolean] A boolean indicating if the event has been defined
def self.defined_event?(event)
@events ||= {}
@events.key?(event)
end
# @!parse
# A hook called before each individual gem is installed
# Includes a Bundler::ParallelInstaller::SpecInstallation.
# No state, error, post_install_message will be present as nothing has installed yet
# GEM_BEFORE_INSTALL = "before-install"
define :GEM_BEFORE_INSTALL, "before-install"
# @!parse
# A hook called after each individual gem is installed
# Includes a Bundler::ParallelInstaller::SpecInstallation.
# - If state is failed, an error will be present.
# - If state is success, a post_install_message may be present.
# GEM_AFTER_INSTALL = "after-install"
define :GEM_AFTER_INSTALL, "after-install"
# @!parse
# A hook called before any gems install
# Includes an Array of Bundler::Dependency objects
# GEM_BEFORE_INSTALL_ALL = "before-install-all"
define :GEM_BEFORE_INSTALL_ALL, "before-install-all"
# @!parse
# A hook called after any gems install
# Includes an Array of Bundler::Dependency objects
# GEM_AFTER_INSTALL_ALL = "after-install-all"
define :GEM_AFTER_INSTALL_ALL, "after-install-all"
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/installer.rb 0000644 00000010737 15173517746 0017764 0 ustar 00 # frozen_string_literal: true
module Bundler
# Handles the installation of plugin in appropriate directories.
#
# This class is supposed to be wrapper over the existing gem installation infra
# but currently it itself handles everything as the Source's subclasses (e.g. Source::RubyGems)
# are heavily dependent on the Gemfile.
module Plugin
class Installer
autoload :Rubygems, File.expand_path("installer/rubygems", __dir__)
autoload :Git, File.expand_path("installer/git", __dir__)
autoload :Path, File.expand_path("installer/path", __dir__)
def install(names, options)
check_sources_consistency!(options)
version = options[:version] || [">= 0"]
if options[:git]
install_git(names, version, options)
elsif options[:path]
install_path(names, version, options[:path])
else
sources = options[:source] || Gem.sources
install_rubygems(names, version, sources)
end
end
# Installs the plugin from Definition object created by limited parsing of
# Gemfile searching for plugins to be installed
#
# @param [Definition] definition object
# @return [Hash] map of names to their specs they are installed with
def install_definition(definition)
def definition.lock(*); end
definition.resolve_remotely!
specs = definition.specs
install_from_specs specs
end
private
def check_sources_consistency!(options)
if options.key?(:git) && options.key?(:local_git)
raise InvalidOption, "Remote and local plugin git sources can't be both specified"
end
# back-compat; local_git is an alias for git
if options.key?(:local_git)
Bundler::SharedHelpers.major_deprecation(2, "--local_git is deprecated, use --git")
options[:git] = options.delete(:local_git)
end
if (options.keys & [:source, :git, :path]).length > 1
raise InvalidOption, "Only one of --source, --git, or --path may be specified"
end
if (options.key?(:branch) || options.key?(:ref)) && !options.key?(:git)
raise InvalidOption, "--#{options.key?(:branch) ? "branch" : "ref"} can only be used with git sources"
end
if options.key?(:branch) && options.key?(:ref)
raise InvalidOption, "--branch and --ref can't be both specified"
end
end
def install_git(names, version, options)
source_list = SourceList.new
source = source_list.add_git_source({ "uri" => options[:git],
"branch" => options[:branch],
"ref" => options[:ref] })
install_all_sources(names, version, source_list, source)
end
def install_path(names, version, path)
source_list = SourceList.new
source = source_list.add_path_source({ "path" => path, "root_path" => SharedHelpers.pwd })
install_all_sources(names, version, source_list, source)
end
# Installs the plugin from rubygems source and returns the path where the
# plugin was installed
#
# @param [String] name of the plugin gem to search in the source
# @param [Array] version of the gem to install
# @param [String, Array<String>] source(s) to resolve the gem
#
# @return [Hash] map of names to the specs of plugins installed
def install_rubygems(names, version, sources)
source_list = SourceList.new
Array(sources).each {|remote| source_list.add_global_rubygems_remote(remote) }
install_all_sources(names, version, source_list)
end
def install_all_sources(names, version, source_list, source = nil)
deps = names.map {|name| Dependency.new(name, version, { "source" => source }) }
Bundler.configure_gem_home_and_path(Plugin.root)
Bundler.settings.temporary(deployment: false, frozen: false) do
definition = Definition.new(nil, deps, source_list, true)
install_definition(definition)
end
end
# Installs the plugins and deps from the provided specs and returns map of
# gems to their paths
#
# @param specs to install
#
# @return [Hash] map of names to the specs
def install_from_specs(specs)
paths = {}
specs.each do |spec|
spec.source.install spec
paths[spec.name] = spec
end
paths
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/api/source.rb 0000644 00000027425 15173517746 0020042 0 ustar 00 # frozen_string_literal: true
module Bundler
module Plugin
class API
# This class provides the base to build source plugins
# All the method here are required to build a source plugin (except
# `uri_hash`, `gem_install_dir`; they are helpers).
#
# Defaults for methods, where ever possible are provided which is
# expected to work. But, all source plugins have to override
# `fetch_gemspec_files` and `install`. Defaults are also not provided for
# `remote!`, `cache!` and `unlock!`.
#
# The defaults shall work for most situations but nevertheless they can
# be (preferably should be) overridden as per the plugins' needs safely
# (as long as they behave as expected).
# On overriding `initialize` you should call super first.
#
# If required plugin should override `hash`, `==` and `eql?` methods to be
# able to match objects representing same sources, but may be created in
# different situation (like form gemfile and lockfile). The default ones
# checks only for class and uri, but elaborate source plugins may need
# more comparisons (e.g. git checking on branch or tag).
#
# @!attribute [r] uri
# @return [String] the remote specified with `source` block in Gemfile
#
# @!attribute [r] options
# @return [String] options passed during initialization (either from
# lockfile or Gemfile)
#
# @!attribute [r] name
# @return [String] name that can be used to uniquely identify a source
#
# @!attribute [rw] dependency_names
# @return [Array<String>] Names of dependencies that the source should
# try to resolve. It is not necessary to use this list internally. This
# is present to be compatible with `Definition` and is used by
# rubygems source.
module Source
attr_reader :uri, :options, :name, :checksum_store
attr_accessor :dependency_names
def initialize(opts)
@options = opts
@dependency_names = []
@uri = opts["uri"]
@type = opts["type"]
@name = opts["name"] || "#{@type} at #{@uri}"
@checksum_store = Checksum::Store.new
end
# This is used by the default `spec` method to constructs the
# Specification objects for the gems and versions that can be installed
# by this source plugin.
#
# Note: If the spec method is overridden, this function is not necessary
#
# @return [Array<String>] paths of the gemspec files for gems that can
# be installed
def fetch_gemspec_files
[]
end
# Options to be saved in the lockfile so that the source plugin is able
# to check out same version of gem later.
#
# There options are passed when the source plugin is created from the
# lock file.
#
# @return [Hash]
def options_to_lock
{}
end
# Install the gem specified by the spec at appropriate path.
# `install_path` provides a sufficient default, if the source can only
# satisfy one gem, but is not binding.
#
# @return [String] post installation message (if any)
def install(spec, opts)
raise MalformattedPlugin, "Source plugins need to override the install method."
end
# It builds extensions, generates bins and installs them for the spec
# provided.
#
# It depends on `spec.loaded_from` to get full_gem_path. The source
# plugins should set that.
#
# It should be called in `install` after the plugin is done placing the
# gem at correct install location.
#
# It also runs Gem hooks `pre_install`, `post_build` and `post_install`
#
# Note: Do not override if you don't know what you are doing.
def post_install(spec, disable_exts = false)
opts = { env_shebang: false, disable_extensions: disable_exts }
installer = Bundler::Source::Path::Installer.new(spec, opts)
installer.post_install
end
# A default installation path to install a single gem. If the source
# servers multiple gems, it's not of much use and the source should one
# of its own.
def install_path
@install_path ||=
begin
base_name = File.basename(Gem::URI.parse(uri).normalize.path)
gem_install_dir.join("#{base_name}-#{uri_hash[0..11]}")
end
end
# Parses the gemspec files to find the specs for the gems that can be
# satisfied by the source.
#
# Few important points to keep in mind:
# - If the gems are not installed then it shall return specs for all
# the gems it can satisfy
# - If gem is installed (that is to be detected by the plugin itself)
# then it shall return at least the specs that are installed.
# - The `loaded_from` for each of the specs shall be correct (it is
# used to find the load path)
#
# @return [Bundler::Index] index containing the specs
def specs
files = fetch_gemspec_files
Bundler::Index.build do |index|
files.each do |file|
next unless spec = Bundler.load_gemspec(file)
spec.installed_by_version = Gem::VERSION
spec.source = self
Bundler.rubygems.validate(spec)
index << spec
end
end
end
# Set internal representation to fetch the gems/specs locally.
#
# When this is called, the source should try to fetch the specs and
# install from the local system.
def local!
end
# Set internal representation to fetch the gems/specs from remote.
#
# When this is called, the source should try to fetch the specs and
# install from remote path.
def remote!
end
# Set internal representation to fetch the gems/specs from app cache.
#
# When this is called, the source should try to fetch the specs and
# install from the path provided by `app_cache_path`.
def cached!
end
# This is called to update the spec and installation.
#
# If the source plugin is loaded from lockfile or otherwise, it shall
# refresh the cache/specs (e.g. git sources can make a fresh clone).
def unlock!
end
# Name of directory where plugin the is expected to cache the gems when
# #cache is called.
#
# Also this name is matched against the directories in cache for pruning
#
# This is used by `app_cache_path`
def app_cache_dirname
base_name = File.basename(Gem::URI.parse(uri).normalize.path)
"#{base_name}-#{uri_hash}"
end
# This method is called while caching to save copy of the gems that the
# source can resolve to path provided by `app_cache_app`so that they can
# be reinstalled from the cache without querying the remote (i.e. an
# alternative to remote)
#
# This is stored with the app and source plugins should try to provide
# specs and install only from this cache when `cached!` is called.
#
# This cache is different from the internal caching that can be done
# at sub paths of `cache_path` (from API). This can be though as caching
# by bundler.
def cache(spec, custom_path = nil)
new_cache_path = app_cache_path(custom_path)
FileUtils.rm_rf(new_cache_path)
FileUtils.cp_r(install_path, new_cache_path)
FileUtils.rm_rf(app_cache_path.join(".git"))
FileUtils.touch(app_cache_path.join(".bundlecache"))
end
# This shall check if two source object represent the same source.
#
# The comparison shall take place only on the attribute that can be
# inferred from the options passed from Gemfile and not on attributes
# that are used to pin down the gem to specific version (e.g. Git
# sources should compare on branch and tag but not on commit hash)
#
# The sources objects are constructed from Gemfile as well as from
# lockfile. To converge the sources, it is necessary that they match.
#
# The same applies for `eql?` and `hash`
def ==(other)
other.is_a?(self.class) && uri == other.uri
end
# When overriding `eql?` please preserve the behaviour as mentioned in
# docstring for `==` method.
alias_method :eql?, :==
# When overriding `hash` please preserve the behaviour as mentioned in
# docstring for `==` method, i.e. two methods equal by above comparison
# should have same hash.
def hash
[self.class, uri].hash
end
# A helper method, not necessary if not used internally.
def installed?
File.directory?(install_path)
end
# The full path where the plugin should cache the gem so that it can be
# installed latter.
#
# Note: Do not override if you don't know what you are doing.
def app_cache_path(custom_path = nil)
@app_cache_path ||= Bundler.app_cache(custom_path).join(app_cache_dirname)
end
# Used by definition.
#
# Note: Do not override if you don't know what you are doing.
def unmet_deps
specs.unmet_dependency_names
end
# Used by definition.
#
# Note: Do not override if you don't know what you are doing.
def spec_names
specs.spec_names
end
# Used by definition.
#
# Note: Do not override if you don't know what you are doing.
def add_dependency_names(names)
@dependencies |= Array(names)
end
# NOTE: Do not override if you don't know what you are doing.
def can_lock?(spec)
spec.source == self
end
# Generates the content to be entered into the lockfile.
# Saves type and remote and also calls to `options_to_lock`.
#
# Plugin should use `options_to_lock` to save information in lockfile
# and not override this.
#
# Note: Do not override if you don't know what you are doing.
def to_lock
out = String.new("#{LockfileParser::PLUGIN}\n")
out << " remote: #{@uri}\n"
out << " type: #{@type}\n"
options_to_lock.each do |opt, value|
out << " #{opt}: #{value}\n"
end
out << " specs:\n"
end
def to_s
"plugin source for #{@type} with uri #{@uri}"
end
alias_method :identifier, :to_s
# NOTE: Do not override if you don't know what you are doing.
def include?(other)
other == self
end
def uri_hash
SharedHelpers.digest(:SHA1).hexdigest(uri)
end
# NOTE: Do not override if you don't know what you are doing.
def gem_install_dir
Bundler.install_path
end
# It is used to obtain the full_gem_path.
#
# spec's loaded_from path is expanded against this to get full_gem_path
#
# Note: Do not override if you don't know what you are doing.
def root
Bundler.root
end
# @private
# This API on source might not be stable, and for now we expect plugins
# to download all specs in `#specs`, so we implement the method for
# compatibility purposes and leave it undocumented (and don't support)
# overriding it)
def double_check_for(*); end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/index.rb 0000644 00000013177 15173517746 0017077 0 ustar 00 # frozen_string_literal: true
module Bundler
# Manages which plugins are installed and their sources. This also is supposed to map
# which plugin does what (currently the features are not implemented so this class is
# now a stub class).
module Plugin
class Index
class CommandConflict < PluginError
def initialize(plugin, commands)
msg = "Command(s) `#{commands.join("`, `")}` declared by #{plugin} are already registered."
super msg
end
end
class SourceConflict < PluginError
def initialize(plugin, sources)
msg = "Source(s) `#{sources.join("`, `")}` declared by #{plugin} are already registered."
super msg
end
end
attr_reader :commands
def initialize
@plugin_paths = {}
@commands = {}
@sources = {}
@hooks = {}
@load_paths = {}
begin
load_index(global_index_file, true)
rescue GenericSystemCallError
# no need to fail when on a read-only FS, for example
nil
end
load_index(local_index_file) if SharedHelpers.in_bundle?
end
# This function is to be called when a new plugin is installed. This
# function shall add the functions of the plugin to existing maps and also
# the name to source location.
#
# @param [String] name of the plugin to be registered
# @param [String] path where the plugin is installed
# @param [Array<String>] load_paths for the plugin
# @param [Array<String>] commands that are handled by the plugin
# @param [Array<String>] sources that are handled by the plugin
def register_plugin(name, path, load_paths, commands, sources, hooks)
old_commands = @commands.dup
common = commands & @commands.keys
raise CommandConflict.new(name, common) unless common.empty?
commands.each {|c| @commands[c] = name }
common = sources & @sources.keys
raise SourceConflict.new(name, common) unless common.empty?
sources.each {|k| @sources[k] = name }
hooks.each do |event|
event_hooks = (@hooks[event] ||= []) << name
event_hooks.uniq!
end
@plugin_paths[name] = path
@load_paths[name] = load_paths
save_index
rescue StandardError
@commands = old_commands
raise
end
def unregister_plugin(name)
@commands.delete_if {|_, v| v == name }
@sources.delete_if {|_, v| v == name }
@hooks.each do |hook, names|
names.delete(name)
@hooks.delete(hook) if names.empty?
end
@plugin_paths.delete(name)
@load_paths.delete(name)
save_index
end
# Path of default index file
def index_file
Plugin.root.join("index")
end
# Path where the global index file is stored
def global_index_file
Plugin.global_root.join("index")
end
# Path where the local index file is stored
def local_index_file
Plugin.local_root.join("index")
end
def plugin_path(name)
Pathname.new @plugin_paths[name]
end
def load_paths(name)
@load_paths[name]
end
# Fetch the name of plugin handling the command
def command_plugin(command)
@commands[command]
end
def installed?(name)
@plugin_paths[name]
end
def installed_plugins
@plugin_paths.keys
end
def plugin_commands(plugin)
@commands.find_all {|_, n| n == plugin }.map(&:first)
end
def source?(source)
@sources.key? source
end
def source_plugin(name)
@sources[name]
end
# Returns the list of plugin names handling the passed event
def hook_plugins(event)
@hooks[event] || []
end
# This plugin is installed inside the .bundle/plugin directory,
# and thus is managed solely by Bundler
def installed_in_plugin_root?(name)
return false unless (path = installed?(name))
path.start_with?("#{Plugin.root}/")
end
private
# Reads the index file from the directory and initializes the instance
# variables.
#
# It skips the sources if the second param is true
# @param [Pathname] index file path
# @param [Boolean] is the index file global index
def load_index(index_file, global = false)
SharedHelpers.filesystem_access(index_file, :read) do |index_f|
valid_file = index_f&.exist? && !index_f.size.zero?
break unless valid_file
data = index_f.read
require_relative "../yaml_serializer"
index = YAMLSerializer.load(data)
@commands.merge!(index["commands"])
@hooks.merge!(index["hooks"])
@load_paths.merge!(index["load_paths"])
@plugin_paths.merge!(index["plugin_paths"])
@sources.merge!(index["sources"]) unless global
end
end
# Should be called when any of the instance variables change. Stores the
# instance variables in YAML format. (The instance variables are supposed
# to be only String key value pairs)
def save_index
index = {
"commands" => @commands,
"hooks" => @hooks,
"load_paths" => @load_paths,
"plugin_paths" => @plugin_paths,
"sources" => @sources,
}
require_relative "../yaml_serializer"
SharedHelpers.filesystem_access(index_file) do |index_f|
FileUtils.mkdir_p(index_f.dirname)
File.open(index_f, "w") {|f| f.puts YAMLSerializer.dump(index) }
end
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/plugin/source_list.rb 0000644 00000001552 15173517746 0020315 0 ustar 00 # frozen_string_literal: true
module Bundler
# SourceList object to be used while parsing the Gemfile, setting the
# approptiate options to be used with Source classes for plugin installation
module Plugin
class SourceList < Bundler::SourceList
def add_git_source(options = {})
add_source_to_list Plugin::Installer::Git.new(options), git_sources
end
def add_path_source(options = {})
add_source_to_list Plugin::Installer::Path.new(options), path_sources
end
def add_rubygems_source(options = {})
add_source_to_list Plugin::Installer::Rubygems.new(options), @rubygems_sources
end
def all_sources
path_sources + git_sources + rubygems_sources + [metadata_source]
end
private
def rubygems_aggregate_class
Plugin::Installer::Rubygems
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/endpoint_specification.rb 0000644 00000010137 15173517746 0021203 0 ustar 00 # frozen_string_literal: true
module Bundler
# used for Creating Specifications from the Gemcutter Endpoint
class EndpointSpecification < Gem::Specification
include MatchRemoteMetadata
attr_reader :name, :version, :platform, :checksum
attr_accessor :source, :remote, :dependencies
def initialize(name, version, platform, spec_fetcher, dependencies, metadata = nil)
super()
@name = name
@version = Gem::Version.create version
@platform = Gem::Platform.new(platform)
@spec_fetcher = spec_fetcher
@dependencies = dependencies.map {|dep, reqs| build_dependency(dep, reqs) }
@loaded_from = nil
@remote_specification = nil
parse_metadata(metadata)
end
def fetch_platform
@platform
end
# needed for standalone, load required_paths from local gemspec
# after the gem is installed
def require_paths
if @remote_specification
@remote_specification.require_paths
elsif _local_specification
_local_specification.require_paths
else
super
end
end
# needed for inline
def load_paths
# remote specs aren't installed, and can't have load_paths
if _local_specification
_local_specification.load_paths
else
super
end
end
# needed for binstubs
def executables
if @remote_specification
@remote_specification.executables
elsif _local_specification
_local_specification.executables
else
super
end
end
# needed for bundle clean
def bindir
if @remote_specification
@remote_specification.bindir
elsif _local_specification
_local_specification.bindir
else
super
end
end
# needed for post_install_messages during install
def post_install_message
if @remote_specification
@remote_specification.post_install_message
elsif _local_specification
_local_specification.post_install_message
else
super
end
end
# needed for "with native extensions" during install
def extensions
if @remote_specification
@remote_specification.extensions
elsif _local_specification
_local_specification.extensions
else
super
end
end
# needed for `bundle fund`
def metadata
if @remote_specification
@remote_specification.metadata
elsif _local_specification
_local_specification.metadata
else
super
end
end
def _local_specification
return unless @loaded_from && File.exist?(local_specification_path)
eval(File.read(local_specification_path), nil, local_specification_path).tap do |spec|
spec.loaded_from = @loaded_from
end
end
def __swap__(spec)
SharedHelpers.ensure_same_dependencies(self, dependencies, spec.dependencies)
@remote_specification = spec
end
private
def _remote_specification
@_remote_specification ||= @spec_fetcher.fetch_spec([@name, @version, @platform])
end
def local_specification_path
"#{base_dir}/specifications/#{full_name}.gemspec"
end
def parse_metadata(data)
unless data
@required_ruby_version = nil
@required_rubygems_version = nil
return
end
data.each do |k, v|
next unless v
case k.to_s
when "checksum"
begin
@checksum = Checksum.from_api(v.last, @spec_fetcher.uri)
rescue ArgumentError => e
raise ArgumentError, "Invalid checksum for #{full_name}: #{e.message}"
end
when "rubygems"
@required_rubygems_version = Gem::Requirement.new(v)
when "ruby"
@required_ruby_version = Gem::Requirement.new(v)
end
end
rescue StandardError => e
raise GemspecError, "There was an error parsing the metadata for the gem #{name} (#{version}): #{e.class}\n#{e}\nThe metadata was #{data.inspect}"
end
def build_dependency(name, requirements)
Gem::Dependency.new(name, requirements)
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/lazy_specification.rb 0000644 00000013447 15173517746 0020351 0 ustar 00 # frozen_string_literal: true
require_relative "force_platform"
module Bundler
class LazySpecification
include MatchMetadata
include MatchPlatform
include ForcePlatform
attr_reader :name, :version, :platform
attr_accessor :source, :remote, :force_ruby_platform, :dependencies, :required_ruby_version, :required_rubygems_version
alias_method :runtime_dependencies, :dependencies
def self.from_spec(s)
lazy_spec = new(s.name, s.version, s.platform, s.source)
lazy_spec.dependencies = s.dependencies
lazy_spec.required_ruby_version = s.required_ruby_version
lazy_spec.required_rubygems_version = s.required_rubygems_version
lazy_spec
end
def initialize(name, version, platform, source = nil)
@name = name
@version = version
@dependencies = []
@required_ruby_version = Gem::Requirement.default
@required_rubygems_version = Gem::Requirement.default
@platform = platform || Gem::Platform::RUBY
@source = source
@force_ruby_platform = default_force_ruby_platform
end
def full_name
@full_name ||= if platform == Gem::Platform::RUBY
"#{@name}-#{@version}"
else
"#{@name}-#{@version}-#{platform}"
end
end
def lock_name
@lock_name ||= name_tuple.lock_name
end
def name_tuple
Gem::NameTuple.new(@name, @version, @platform)
end
def ==(other)
full_name == other.full_name
end
def eql?(other)
full_name.eql?(other.full_name)
end
def hash
full_name.hash
end
##
# Does this locked specification satisfy +dependency+?
#
# NOTE: Rubygems default requirement is ">= 0", which doesn't match
# prereleases of 0 versions, like "0.0.0.dev" or "0.0.0.SNAPSHOT". However,
# bundler users expect those to work. We need to make sure that Gemfile
# dependencies without explicit requirements (which use ">= 0" under the
# hood by default) are still valid for locked specs using this kind of
# versions. The method implements an ad-hoc fix for that. A better solution
# might be to change default rubygems requirement of dependencies to be ">=
# 0.A" but that's a major refactoring likely to break things. Hopefully we
# can attempt it in the future.
#
def satisfies?(dependency)
effective_requirement = dependency.requirement == Gem::Requirement.default ? Gem::Requirement.new(">= 0.A") : dependency.requirement
@name == dependency.name && effective_requirement.satisfied_by?(Gem::Version.new(@version))
end
def to_lock
out = String.new
out << " #{lock_name}\n"
dependencies.sort_by(&:to_s).uniq.each do |dep|
next if dep.type == :development
out << " #{dep.to_lock}\n"
end
out
end
def materialize_for_installation
source.local!
matching_specs = source.specs.search(use_exact_resolved_specifications? ? self : [name, version])
return self if matching_specs.empty?
candidates = if use_exact_resolved_specifications?
matching_specs
else
target_platform = ruby_platform_materializes_to_ruby_platform? ? platform : local_platform
installable_candidates = GemHelpers.select_best_platform_match(matching_specs, target_platform)
specification = __materialize__(installable_candidates, fallback_to_non_installable: false)
return specification unless specification.nil?
if target_platform != platform
installable_candidates = GemHelpers.select_best_platform_match(matching_specs, platform)
end
installable_candidates
end
__materialize__(candidates)
end
# If in frozen mode, we fallback to a non-installable candidate because by
# doing this we avoid re-resolving and potentially end up changing the
# lock file, which is not allowed. In that case, we will give a proper error
# about the mismatch higher up the stack, right before trying to install the
# bad gem.
def __materialize__(candidates, fallback_to_non_installable: Bundler.frozen_bundle?)
search = candidates.reverse.find do |spec|
spec.is_a?(StubSpecification) || spec.matches_current_metadata?
end
if search.nil? && fallback_to_non_installable
search = candidates.last
else
search.dependencies = dependencies if search && search.full_name == full_name && (search.is_a?(RemoteSpecification) || search.is_a?(EndpointSpecification))
end
search
end
def to_s
lock_name
end
def git_version
return unless source.is_a?(Bundler::Source::Git)
" #{source.revision[0..6]}"
end
def force_ruby_platform!
@force_ruby_platform = true
end
private
def use_exact_resolved_specifications?
@use_exact_resolved_specifications ||= !source.is_a?(Source::Path) && ruby_platform_materializes_to_ruby_platform?
end
#
# For backwards compatibility with existing lockfiles, if the most specific
# locked platform is not a specific platform like x86_64-linux or
# universal-java-11, then we keep the previous behaviour of resolving the
# best platform variant at materiliazation time. For previous bundler
# versions (before 2.2.0) this was always the case (except when the lockfile
# only included non-ruby platforms), but we're also keeping this behaviour
# on newer bundlers unless users generate the lockfile from scratch or
# explicitly add a more specific platform.
#
def ruby_platform_materializes_to_ruby_platform?
generic_platform = generic_local_platform == Gem::Platform::JAVA ? Gem::Platform::JAVA : Gem::Platform::RUBY
!Bundler.most_specific_locked_platform?(generic_platform) || force_ruby_platform || Bundler.settings[:force_ruby_platform]
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/checksum.rb 0000644 00000015676 15173517746 0016302 0 ustar 00 # frozen_string_literal: true
module Bundler
class Checksum
ALGO_SEPARATOR = "="
DEFAULT_ALGORITHM = "sha256"
private_constant :DEFAULT_ALGORITHM
DEFAULT_BLOCK_SIZE = 16_384
private_constant :DEFAULT_BLOCK_SIZE
class << self
def from_gem_package(gem_package, algo = DEFAULT_ALGORITHM)
return if Bundler.settings[:disable_checksum_validation]
return unless source = gem_package.instance_variable_get(:@gem)
return unless source.respond_to?(:with_read_io)
source.with_read_io do |io|
from_gem(io, source.path)
ensure
io.rewind
end
end
def from_gem(io, pathname, algo = DEFAULT_ALGORITHM)
digest = Bundler::SharedHelpers.digest(algo.upcase).new
buf = String.new(capacity: DEFAULT_BLOCK_SIZE)
digest << io.readpartial(DEFAULT_BLOCK_SIZE, buf) until io.eof?
Checksum.new(algo, digest.hexdigest!, Source.new(:gem, pathname))
end
def from_api(digest, source_uri, algo = DEFAULT_ALGORITHM)
return if Bundler.settings[:disable_checksum_validation]
Checksum.new(algo, to_hexdigest(digest, algo), Source.new(:api, source_uri))
end
def from_lock(lock_checksum, lockfile_location)
algo, digest = lock_checksum.strip.split(ALGO_SEPARATOR, 2)
Checksum.new(algo, to_hexdigest(digest, algo), Source.new(:lock, lockfile_location))
end
def to_hexdigest(digest, algo = DEFAULT_ALGORITHM)
return digest unless algo == DEFAULT_ALGORITHM
return digest if digest.match?(/\A[0-9a-f]{64}\z/i)
if digest.match?(%r{\A[-0-9a-z_+/]{43}={0,2}\z}i)
digest = digest.tr("-_", "+/") # fix urlsafe base64
digest.unpack1("m0").unpack1("H*")
else
raise ArgumentError, "#{digest.inspect} is not a valid SHA256 hex or base64 digest"
end
end
end
attr_reader :algo, :digest, :sources
def initialize(algo, digest, source)
@algo = algo
@digest = digest
@sources = [source]
end
def ==(other)
match?(other) && other.sources == sources
end
alias_method :eql?, :==
def same_source?(other)
sources.include?(other.sources.first)
end
def match?(other)
other.is_a?(self.class) && other.digest == digest && other.algo == algo
end
def hash
digest.hash
end
def to_s
"#{to_lock} (from #{sources.first}#{", ..." if sources.size > 1})"
end
def to_lock
"#{algo}#{ALGO_SEPARATOR}#{digest}"
end
def merge!(other)
return nil unless match?(other)
@sources.concat(other.sources).uniq!
self
end
def formatted_sources
sources.join("\n and ").concat("\n")
end
def removable?
sources.all?(&:removable?)
end
def removal_instructions
msg = +""
i = 1
sources.each do |source|
msg << " #{i}. #{source.removal}\n"
i += 1
end
msg << " #{i}. run `bundle install`\n"
end
def inspect
abbr = "#{algo}#{ALGO_SEPARATOR}#{digest[0, 8]}"
from = "from #{sources.join(" and ")}"
"#<#{self.class}:#{object_id} #{abbr} #{from}>"
end
class Source
attr_reader :type, :location
def initialize(type, location)
@type = type
@location = location
end
def removable?
type == :lock || type == :gem
end
def ==(other)
other.is_a?(self.class) && other.type == type && other.location == location
end
# phrased so that the usual string format is grammatically correct
# rake (10.3.2) sha256=abc123 from #{to_s}
def to_s
case type
when :lock
"the lockfile CHECKSUMS at #{location}"
when :gem
"the gem at #{location}"
when :api
"the API at #{location}"
else
"#{location} (#{type})"
end
end
# A full sentence describing how to remove the checksum
def removal
case type
when :lock
"remove the matching checksum in #{location}"
when :gem
"remove the gem at #{location}"
when :api
"checksums from #{location} cannot be locally modified, you may need to update your sources"
else
"remove #{location} (#{type})"
end
end
end
class Store
attr_reader :store
protected :store
def initialize
@store = {}
@store_mutex = Mutex.new
end
def inspect
"#<#{self.class}:#{object_id} size=#{store.size}>"
end
# Replace when the new checksum is from the same source.
# The primary purpose is registering checksums from gems where there are
# duplicates of the same gem (according to full_name) in the index.
#
# In particular, this is when 2 gems have two similar platforms, e.g.
# "darwin20" and "darwin-20", both of which resolve to darwin-20.
# In the Index, the later gem replaces the former, so we do that here.
#
# However, if the new checksum is from a different source, we register like normal.
# This ensures a mismatch error where there are multiple top level sources
# that contain the same gem with different checksums.
def replace(spec, checksum)
return unless checksum
lock_name = spec.name_tuple.lock_name
@store_mutex.synchronize do
existing = fetch_checksum(lock_name, checksum.algo)
if !existing || existing.same_source?(checksum)
store_checksum(lock_name, checksum)
else
merge_checksum(lock_name, checksum, existing)
end
end
end
def register(spec, checksum)
return unless checksum
register_checksum(spec.name_tuple.lock_name, checksum)
end
def merge!(other)
other.store.each do |lock_name, checksums|
checksums.each do |_algo, checksum|
register_checksum(lock_name, checksum)
end
end
end
def to_lock(spec)
lock_name = spec.name_tuple.lock_name
checksums = @store[lock_name]
if checksums
"#{lock_name} #{checksums.values.map(&:to_lock).sort.join(",")}"
else
lock_name
end
end
private
def register_checksum(lock_name, checksum)
@store_mutex.synchronize do
existing = fetch_checksum(lock_name, checksum.algo)
if existing
merge_checksum(lock_name, checksum, existing)
else
store_checksum(lock_name, checksum)
end
end
end
def merge_checksum(lock_name, checksum, existing)
existing.merge!(checksum) || raise(ChecksumMismatchError.new(lock_name, existing, checksum))
end
def store_checksum(lock_name, checksum)
(@store[lock_name] ||= {})[checksum.algo] = checksum
end
def fetch_checksum(lock_name, algo)
@store[lock_name]&.fetch(algo, nil)
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/source_list.rb 0000644 00000015471 15173517746 0017024 0 ustar 00 # frozen_string_literal: true
module Bundler
class SourceList
attr_reader :path_sources,
:git_sources,
:plugin_sources,
:global_path_source,
:metadata_source
def global_rubygems_source
@global_rubygems_source ||= rubygems_aggregate_class.new("allow_local" => true)
end
def initialize
@path_sources = []
@git_sources = []
@plugin_sources = []
@global_rubygems_source = nil
@global_path_source = nil
@rubygems_sources = []
@metadata_source = Source::Metadata.new
@merged_gem_lockfile_sections = false
@local_mode = true
end
def merged_gem_lockfile_sections?
@merged_gem_lockfile_sections
end
def merged_gem_lockfile_sections!(replacement_source)
@merged_gem_lockfile_sections = true
@global_rubygems_source = replacement_source
end
def aggregate_global_source?
global_rubygems_source.multiple_remotes?
end
def implicit_global_source?
global_rubygems_source.no_remotes?
end
def add_path_source(options = {})
if options["gemspec"]
add_source_to_list Source::Gemspec.new(options), path_sources
else
path_source = add_source_to_list Source::Path.new(options), path_sources
@global_path_source ||= path_source if options["global"]
path_source
end
end
def add_git_source(options = {})
add_source_to_list(Source::Git.new(options), git_sources).tap do |source|
warn_on_git_protocol(source)
end
end
def add_rubygems_source(options = {})
new_source = Source::Rubygems.new(options)
return @global_rubygems_source if @global_rubygems_source == new_source
add_source_to_list new_source, @rubygems_sources
end
def add_plugin_source(source, options = {})
add_source_to_list Plugin.source(source).new(options), @plugin_sources
end
def add_global_rubygems_remote(uri)
global_rubygems_source.add_remote(uri)
global_rubygems_source
end
def local_mode?
@local_mode
end
def default_source
global_path_source || global_rubygems_source
end
def rubygems_sources
non_global_rubygems_sources + [global_rubygems_source]
end
def non_global_rubygems_sources
@rubygems_sources
end
def rubygems_remotes
rubygems_sources.map(&:remotes).flatten.uniq
end
def all_sources
path_sources + git_sources + plugin_sources + rubygems_sources + [metadata_source]
end
def non_default_explicit_sources
all_sources - [default_source, metadata_source]
end
def get(source)
source_list_for(source).find {|s| equivalent_source?(source, s) }
end
def lock_sources
lock_other_sources + lock_rubygems_sources
end
def lock_other_sources
(path_sources + git_sources + plugin_sources).sort_by(&:identifier)
end
def lock_rubygems_sources
if merged_gem_lockfile_sections?
[combine_rubygems_sources]
else
rubygems_sources.sort_by(&:identifier)
end
end
# Returns true if there are changes
def replace_sources!(replacement_sources)
return false if replacement_sources.empty?
@rubygems_sources, @path_sources, @git_sources, @plugin_sources = map_sources(replacement_sources)
@global_rubygems_source = global_replacement_source(replacement_sources)
different_sources?(lock_sources, replacement_sources)
end
# Returns true if there are changes
def expired_sources?(replacement_sources)
return false if replacement_sources.empty?
lock_sources = dup_with_replaced_sources(replacement_sources).lock_sources
different_sources?(lock_sources, replacement_sources)
end
def local_only!
all_sources.each(&:local_only!)
end
def local!
all_sources.each(&:local!)
end
def cached!
all_sources.each(&:cached!)
end
def remote!
@local_mode = false
all_sources.each(&:remote!)
end
private
def dup_with_replaced_sources(replacement_sources)
new_source_list = dup
new_source_list.replace_sources!(replacement_sources)
new_source_list
end
def map_sources(replacement_sources)
rubygems = @rubygems_sources.map do |source|
replace_rubygems_source(replacement_sources, source) || source
end
git, plugin = [@git_sources, @plugin_sources].map do |sources|
sources.map do |source|
replacement_sources.find {|s| s == source } || source
end
end
path = @path_sources.map do |source|
replacement_sources.find {|s| s == (source.is_a?(Source::Gemspec) ? source.as_path_source : source) } || source
end
[rubygems, path, git, plugin]
end
def global_replacement_source(replacement_sources)
replacement_source = replace_rubygems_source(replacement_sources, global_rubygems_source)
return global_rubygems_source unless replacement_source
replacement_source.local!
replacement_source
end
def replace_rubygems_source(replacement_sources, gemfile_source)
replacement_source = replacement_sources.find {|s| s == gemfile_source }
return unless replacement_source
# locked sources never include credentials so always prefer remotes from the gemfile
replacement_source.remotes = gemfile_source.remotes
replacement_source
end
def different_sources?(lock_sources, replacement_sources)
!equivalent_sources?(lock_sources, replacement_sources)
end
def rubygems_aggregate_class
Source::Rubygems
end
def add_source_to_list(source, list)
list.unshift(source).uniq!
source
end
def source_list_for(source)
case source
when Source::Git then git_sources
when Source::Path then path_sources
when Source::Rubygems then rubygems_sources
when Plugin::API::Source then plugin_sources
else raise ArgumentError, "Invalid source: #{source.inspect}"
end
end
def combine_rubygems_sources
Source::Rubygems.new("remotes" => rubygems_remotes)
end
def warn_on_git_protocol(source)
return if Bundler.settings["git.allow_insecure"]
if /^git\:/.match?(source.uri)
Bundler.ui.warn "The git source `#{source.uri}` uses the `git` protocol, " \
"which transmits data without encryption. Disable this warning with " \
"`bundle config set --local git.allow_insecure true`, or switch to the `https` " \
"protocol to keep your data secure."
end
end
def equivalent_sources?(lock_sources, replacement_sources)
lock_sources.sort_by(&:identifier) == replacement_sources.sort_by(&:identifier)
end
def equivalent_source?(source, other_source)
source == other_source
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/uri_normalizer.rb 0000644 00000001313 15173517746 0017520 0 ustar 00 # frozen_string_literal: true
module Bundler
module URINormalizer
module_function
# Normalizes uri to a consistent version, either with or without trailing
# slash.
#
# TODO: Currently gem sources are locked with a trailing slash, while git
# sources are locked without a trailing slash. This should be normalized but
# the inconsistency is there for now to avoid changing all lockfiles
# including GIT sources. We could normalize this on the next major.
#
def normalize_suffix(uri, trailing_slash: true)
if trailing_slash
uri.end_with?("/") ? uri : "#{uri}/"
else
uri.end_with?("/") ? uri.delete_suffix("/") : uri
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/vendored_uri.rb 0000644 00000000760 15173517746 0017151 0 ustar 00 # frozen_string_literal: true
module Bundler; end
# Use RubyGems vendored copy when available. Otherwise fallback to Bundler
# vendored copy. The vendored copy in Bundler can be removed once support for
# RubyGems 3.5 is dropped.
begin
require "rubygems/vendor/uri/lib/uri"
rescue LoadError
require_relative "vendor/uri/lib/uri"
Gem::URI = Bundler::URI
module Gem
def URI(uri) # rubocop:disable Naming/MethodName
Bundler::URI(uri)
end
module_function :URI
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/resolver.rb 0000644 00000044542 15173517746 0016333 0 ustar 00 # frozen_string_literal: true
module Bundler
#
# This class implements the interface needed by PubGrub for resolution. It is
# equivalent to the `PubGrub::BasicPackageSource` class provided by PubGrub by
# default and used by the most simple PubGrub consumers.
#
class Resolver
require_relative "vendored_pub_grub"
require_relative "resolver/base"
require_relative "resolver/candidate"
require_relative "resolver/incompatibility"
require_relative "resolver/root"
include GemHelpers
def initialize(base, gem_version_promoter)
@source_requirements = base.source_requirements
@base = base
@gem_version_promoter = gem_version_promoter
end
def start
@requirements = @base.requirements
@packages = @base.packages
root, logger = setup_solver
Bundler.ui.info "Resolving dependencies...", true
solve_versions(root: root, logger: logger)
end
def setup_solver
root = Resolver::Root.new(name_for_explicit_dependency_source)
root_version = Resolver::Candidate.new(0)
@all_specs = Hash.new do |specs, name|
source = source_for(name)
matches = source.specs.search(name)
# Don't bother to check for circular deps when no dependency API are
# available, since it's too slow to be usable. That edge case won't work
# but resolution other than that should work fine and reasonably fast.
if source.respond_to?(:dependency_api_available?) && source.dependency_api_available?
matches = filter_invalid_self_dependencies(matches, name)
end
specs[name] = matches.sort_by {|s| [s.version, s.platform.to_s] }
end
@all_versions = Hash.new do |candidates, package|
candidates[package] = all_versions_for(package)
end
@sorted_versions = Hash.new do |candidates, package|
candidates[package] = filtered_versions_for(package).sort
end
@sorted_versions[root] = [root_version]
root_dependencies = prepare_dependencies(@requirements, @packages)
@cached_dependencies = Hash.new do |dependencies, package|
dependencies[package] = Hash.new do |versions, version|
versions[version] = to_dependency_hash(version.dependencies.reject {|d| d.name == package.name }, @packages)
end
end
@cached_dependencies[root] = { root_version => root_dependencies }
logger = Bundler::UI::Shell.new
logger.level = debug? ? "debug" : "warn"
[root, logger]
end
def solve_versions(root:, logger:)
solver = PubGrub::VersionSolver.new(source: self, root: root, logger: logger)
result = solver.solve
resolved_specs = result.map {|package, version| version.to_specs(package) }.flatten
resolved_specs |= @base.specs_compatible_with(SpecSet.new(resolved_specs))
rescue PubGrub::SolveFailure => e
incompatibility = e.incompatibility
names_to_unlock, names_to_allow_prereleases_for, names_to_allow_remote_specs_for, extended_explanation = find_names_to_relax(incompatibility)
names_to_relax = names_to_unlock + names_to_allow_prereleases_for + names_to_allow_remote_specs_for
if names_to_relax.any?
if names_to_unlock.any?
Bundler.ui.debug "Found conflicts with locked dependencies. Will retry with #{names_to_unlock.join(", ")} unlocked...", true
@base.unlock_names(names_to_unlock)
end
if names_to_allow_prereleases_for.any?
Bundler.ui.debug "Found conflicts with dependencies with prereleases. Will retry considering prereleases for #{names_to_allow_prereleases_for.join(", ")}...", true
@base.include_prereleases(names_to_allow_prereleases_for)
end
if names_to_allow_remote_specs_for.any?
Bundler.ui.debug "Found conflicts with local versions of #{names_to_allow_remote_specs_for.join(", ")}. Will retry considering remote versions...", true
@base.include_remote_specs(names_to_allow_remote_specs_for)
end
root, logger = setup_solver
Bundler.ui.debug "Retrying resolution...", true
retry
end
explanation = e.message
if extended_explanation
explanation << "\n\n"
explanation << extended_explanation
end
raise SolveFailure.new(explanation)
end
def find_names_to_relax(incompatibility)
names_to_unlock = []
names_to_allow_prereleases_for = []
names_to_allow_remote_specs_for = []
extended_explanation = nil
while incompatibility.conflict?
cause = incompatibility.cause
incompatibility = cause.incompatibility
incompatibility.terms.each do |term|
package = term.package
name = package.name
if base_requirements[name]
names_to_unlock << name
elsif package.ignores_prereleases? && @all_specs[name].any? {|s| s.version.prerelease? }
names_to_allow_prereleases_for << name
elsif package.prefer_local? && @all_specs[name].any? {|s| !s.is_a?(StubSpecification) }
names_to_allow_remote_specs_for << name
end
no_versions_incompat = [cause.incompatibility, cause.satisfier].find {|incompat| incompat.cause.is_a?(PubGrub::Incompatibility::NoVersions) }
next unless no_versions_incompat
extended_explanation = no_versions_incompat.extended_explanation
end
end
[names_to_unlock.uniq, names_to_allow_prereleases_for.uniq, names_to_allow_remote_specs_for.uniq, extended_explanation]
end
def parse_dependency(package, dependency)
range = if repository_for(package).is_a?(Source::Gemspec)
PubGrub::VersionRange.any
else
requirement_to_range(dependency)
end
PubGrub::VersionConstraint.new(package, range: range)
end
def versions_for(package, range=VersionRange.any)
versions = select_sorted_versions(package, range)
# Conditional avoids (among other things) calling
# sort_versions_by_preferred with the root package
if versions.size > 1
sort_versions_by_preferred(package, versions)
else
versions
end
end
def no_versions_incompatibility_for(package, unsatisfied_term)
cause = PubGrub::Incompatibility::NoVersions.new(unsatisfied_term)
name = package.name
constraint = unsatisfied_term.constraint
constraint_string = constraint.constraint_string
requirements = constraint_string.split(" OR ").map {|req| Gem::Requirement.new(req.split(",")) }
if name == "bundler" && bundler_pinned_to_current_version?
custom_explanation = "the current Bundler version (#{Bundler::VERSION}) does not satisfy #{constraint}"
extended_explanation = bundler_not_found_message(requirements)
else
specs_matching_other_platforms = filter_matching_specs(@all_specs[name], requirements)
platforms_explanation = specs_matching_other_platforms.any? ? " for any resolution platforms (#{package.platforms.join(", ")})" : ""
custom_explanation = "#{constraint} could not be found in #{repository_for(package)}#{platforms_explanation}"
label = "#{name} (#{constraint_string})"
extended_explanation = other_specs_matching_message(specs_matching_other_platforms, label) if specs_matching_other_platforms.any?
end
Incompatibility.new([unsatisfied_term], cause: cause, custom_explanation: custom_explanation, extended_explanation: extended_explanation)
end
def debug?
ENV["BUNDLER_DEBUG_RESOLVER"] ||
ENV["BUNDLER_DEBUG_RESOLVER_TREE"] ||
ENV["DEBUG_RESOLVER"] ||
ENV["DEBUG_RESOLVER_TREE"] ||
false
end
def incompatibilities_for(package, version)
package_deps = @cached_dependencies[package]
sorted_versions = @sorted_versions[package]
package_deps[version].map do |dep_package, dep_constraint|
low = high = sorted_versions.index(version)
# find version low such that all >= low share the same dep
while low > 0 && package_deps[sorted_versions[low - 1]][dep_package] == dep_constraint
low -= 1
end
low =
if low == 0
nil
else
sorted_versions[low]
end
# find version high such that all < high share the same dep
while high < sorted_versions.length && package_deps[sorted_versions[high]][dep_package] == dep_constraint
high += 1
end
high =
if high == sorted_versions.length
nil
else
sorted_versions[high]
end
range = PubGrub::VersionRange.new(min: low, max: high, include_min: true)
self_constraint = PubGrub::VersionConstraint.new(package, range: range)
dep_term = PubGrub::Term.new(dep_constraint, false)
self_term = PubGrub::Term.new(self_constraint, true)
custom_explanation = if dep_package.meta? && package.root?
"current #{dep_package} version is #{dep_constraint.constraint_string}"
end
PubGrub::Incompatibility.new([self_term, dep_term], cause: :dependency, custom_explanation: custom_explanation)
end
end
def all_versions_for(package)
name = package.name
results = (@base[name] + filter_specs(@all_specs[name], package)).uniq {|spec| [spec.version.hash, spec.platform] }
if name == "bundler" && !bundler_pinned_to_current_version?
bundler_spec = Gem.loaded_specs["bundler"]
results << bundler_spec if bundler_spec
end
locked_requirement = base_requirements[name]
results = filter_matching_specs(results, locked_requirement) if locked_requirement
results.group_by(&:version).reduce([]) do |groups, (version, specs)|
platform_specs = package.platform_specs(specs)
# If package is a top-level dependency,
# candidate is only valid if there are matching versions for all resolution platforms.
#
# If package is not a top-level deependency,
# then it's not necessary that it has matching versions for all platforms, since it may have been introduced only as
# a dependency for a platform specific variant, so it will only need to have a valid version for that platform.
#
if package.top_level?
next groups if platform_specs.any?(&:empty?)
else
next groups if platform_specs.all?(&:empty?)
end
ruby_specs = select_best_platform_match(specs, Gem::Platform::RUBY)
ruby_group = Resolver::SpecGroup.new(ruby_specs)
unless ruby_group.empty?
platform_specs.each do |specs|
ruby_group.merge(Resolver::SpecGroup.new(specs))
end
groups << Resolver::Candidate.new(version, group: ruby_group, priority: -1)
next groups if package.force_ruby_platform?
end
platform_group = Resolver::SpecGroup.new(platform_specs.flatten.uniq)
next groups if platform_group == ruby_group
groups << Resolver::Candidate.new(version, group: platform_group, priority: 1)
groups
end
end
def source_for(name)
@source_requirements[name] || @source_requirements[:default]
end
def default_bundler_source
@source_requirements[:default_bundler]
end
def bundler_pinned_to_current_version?
!default_bundler_source.nil?
end
def name_for_explicit_dependency_source
Bundler.default_gemfile.basename.to_s
rescue StandardError
"Gemfile"
end
def raise_not_found!(package)
name = package.name
source = source_for(name)
specs = @all_specs[name]
matching_part = name
requirement_label = SharedHelpers.pretty_dependency(package.dependency)
cache_message = begin
" or in gems cached in #{Bundler.settings.app_cache_path}" if Bundler.app_cache.exist?
rescue GemfileNotFound
nil
end
specs_matching_requirement = filter_matching_specs(specs, package.dependency.requirement)
not_found_message = if specs_matching_requirement.any?
specs = specs_matching_requirement
matching_part = requirement_label
platforms = package.platforms
if platforms.size == 1
"Could not find gem '#{requirement_label}' with platform '#{platforms.first}'"
else
"Could not find gems matching '#{requirement_label}' valid for all resolution platforms (#{platforms.join(", ")})"
end
else
"Could not find gem '#{requirement_label}'"
end
message = String.new("#{not_found_message} in #{source}#{cache_message}.\n")
if specs.any?
message << "\n#{other_specs_matching_message(specs, matching_part)}"
end
raise GemNotFound, message
end
private
def filtered_versions_for(package)
@gem_version_promoter.filter_versions(package, @all_versions[package])
end
def raise_all_versions_filtered_out!(package)
level = @gem_version_promoter.level
name = package.name
locked_version = package.locked_version
requirement = package.dependency
raise GemNotFound,
"#{name} is locked to #{locked_version}, while Gemfile is requesting #{requirement}. " \
"--strict --#{level} was specified, but there are no #{level} level upgrades from #{locked_version} satisfying #{requirement}, so version solving has failed"
end
def filter_matching_specs(specs, requirements)
Array(requirements).flat_map do |requirement|
specs.select {| spec| requirement_satisfied_by?(requirement, spec) }
end
end
def filter_specs(specs, package)
filter_remote_specs(filter_prereleases(specs, package), package)
end
def filter_prereleases(specs, package)
return specs unless package.ignores_prereleases? && specs.size > 1
specs.reject {|s| s.version.prerelease? }
end
def filter_remote_specs(specs, package)
return specs unless package.prefer_local?
specs.select {|s| s.is_a?(StubSpecification) }
end
# Ignore versions that depend on themselves incorrectly
def filter_invalid_self_dependencies(specs, name)
specs.reject do |s|
s.dependencies.any? {|d| d.name == name && !d.requirement.satisfied_by?(s.version) }
end
end
def requirement_satisfied_by?(requirement, spec)
requirement.satisfied_by?(spec.version) || spec.source.is_a?(Source::Gemspec)
end
def sort_versions_by_preferred(package, versions)
@gem_version_promoter.sort_versions(package, versions)
end
def repository_for(package)
source_for(package.name)
end
def base_requirements
@base.base_requirements
end
def prepare_dependencies(requirements, packages)
to_dependency_hash(requirements, packages).map do |dep_package, dep_constraint|
name = dep_package.name
next [dep_package, dep_constraint] if name == "bundler"
dep_range = dep_constraint.range
versions = select_sorted_versions(dep_package, dep_range)
if versions.empty?
if dep_package.ignores_prereleases? || dep_package.prefer_local?
@all_versions.delete(dep_package)
@sorted_versions.delete(dep_package)
end
dep_package.consider_prereleases! if dep_package.ignores_prereleases?
dep_package.consider_remote_versions! if dep_package.prefer_local?
versions = select_sorted_versions(dep_package, dep_range)
end
if versions.empty? && select_all_versions(dep_package, dep_range).any?
raise_all_versions_filtered_out!(dep_package)
end
next [dep_package, dep_constraint] unless versions.empty?
next unless dep_package.current_platform?
raise_not_found!(dep_package)
end.compact.to_h
end
def select_sorted_versions(package, range)
range.select_versions(@sorted_versions[package])
end
def select_all_versions(package, range)
range.select_versions(@all_versions[package])
end
def other_specs_matching_message(specs, requirement)
message = String.new("The source contains the following gems matching '#{requirement}':\n")
message << specs.map {|s| " * #{s.full_name}" }.join("\n")
message
end
def requirement_to_range(requirement)
ranges = requirement.requirements.map do |(op, version)|
ver = Resolver::Candidate.new(version, priority: -1)
platform_ver = Resolver::Candidate.new(version, priority: 1)
case op
when "~>"
name = "~> #{ver}"
bump = Resolver::Candidate.new(version.bump.to_s + ".A")
PubGrub::VersionRange.new(name: name, min: ver, max: bump, include_min: true)
when ">"
PubGrub::VersionRange.new(min: platform_ver)
when ">="
PubGrub::VersionRange.new(min: ver, include_min: true)
when "<"
PubGrub::VersionRange.new(max: ver)
when "<="
PubGrub::VersionRange.new(max: platform_ver, include_max: true)
when "="
PubGrub::VersionRange.new(min: ver, max: platform_ver, include_min: true, include_max: true)
when "!="
PubGrub::VersionRange.new(min: ver, max: platform_ver, include_min: true, include_max: true).invert
else
raise "bad version specifier: #{op}"
end
end
ranges.inject(&:intersect)
end
def to_dependency_hash(dependencies, packages)
dependencies.inject({}) do |deps, dep|
package = packages[dep.name]
current_req = deps[package]
new_req = parse_dependency(package, dep.requirement)
deps[package] = if current_req
current_req.intersect(new_req)
else
new_req
end
deps
end
end
def bundler_not_found_message(conflict_dependencies)
candidate_specs = filter_matching_specs(default_bundler_source.specs.search("bundler"), conflict_dependencies)
if candidate_specs.any?
target_version = candidate_specs.last.version
new_command = [File.basename($PROGRAM_NAME), "_#{target_version}_", *ARGV].join(" ")
"Your bundle requires a different version of Bundler than the one you're running.\n" \
"Install the necessary version with `gem install bundler:#{target_version}` and rerun bundler using `#{new_command}`\n"
else
"Your bundle requires a different version of Bundler than the one you're running, and that version could not be found.\n"
end
end
end
end
share/gems/gems/bundler-2.5.22/lib/bundler/match_platform.rb 0000644 00000001107 15173517746 0017460 0 ustar 00 # frozen_string_literal: true
require_relative "gem_helpers"
module Bundler
module MatchPlatform
include GemHelpers
def match_platform(p)
MatchPlatform.platforms_match?(platform, p)
end
def self.platforms_match?(gemspec_platform, local_platform)
return true if gemspec_platform.nil?
return true if gemspec_platform == Gem::Platform::RUBY
return true if local_platform == gemspec_platform
gemspec_platform = Gem::Platform.new(gemspec_platform)
return true if gemspec_platform === local_platform
false
end
end
end
share/gems/gems/rdoc-6.6.3.1/exe/ri 0000755 00000000303 15173517746 0012427 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
begin
gem 'rdoc'
rescue NameError => e # --disable-gems
raise unless e.name == :gem
rescue Gem::LoadError
end
require 'rdoc/ri/driver'
RDoc::RI::Driver.run ARGV
share/gems/gems/rdoc-6.6.3.1/exe/rdoc 0000755 00000001660 15173517746 0012753 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
#
# RDoc: Documentation tool for source code
# (see lib/rdoc/rdoc.rb for more information)
#
# Copyright (c) 2003 Dave Thomas
# Released under the same terms as Ruby
begin
gem 'rdoc'
rescue NameError => e # --disable-gems
raise unless e.name == :gem
rescue Gem::LoadError
end
require 'rdoc/rdoc'
begin
r = RDoc::RDoc.new
r.document ARGV
rescue Errno::ENOSPC
$stderr.puts 'Ran out of space creating documentation'
$stderr.puts
$stderr.puts 'Please free up some space and try again'
rescue SystemExit
raise
rescue Exception => e
if $DEBUG_RDOC then
$stderr.puts e.message
$stderr.puts "#{e.backtrace.join "\n\t"}"
$stderr.puts
elsif Interrupt === e then
$stderr.puts
$stderr.puts 'Interrupted'
else
$stderr.puts "uh-oh! RDoc had a problem:"
$stderr.puts e.message
$stderr.puts
$stderr.puts "run with --debug for full backtrace"
end
exit 1
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc.rb 0000644 00000014346 15173517746 0013344 0 ustar 00 # frozen_string_literal: true
$DEBUG_RDOC = nil
# :main: README.rdoc
##
# RDoc produces documentation for Ruby source files by parsing the source and
# extracting the definition for classes, modules, methods, includes and
# requires. It associates these with optional documentation contained in an
# immediately preceding comment block then renders the result using an output
# formatter.
#
# For a simple introduction to writing or generating documentation using RDoc
# see the README.
#
# == Roadmap
#
# If you think you found a bug in RDoc see CONTRIBUTING@Bugs
#
# If you want to use RDoc to create documentation for your Ruby source files,
# see RDoc::Markup and refer to <tt>rdoc --help</tt> for command line usage.
#
# If you want to set the default markup format see
# RDoc::Markup@Supported+Formats
#
# If you want to store rdoc configuration in your gem (such as the default
# markup format) see RDoc::Options@Saved+Options
#
# If you want to write documentation for Ruby files see RDoc::Parser::Ruby
#
# If you want to write documentation for extensions written in C see
# RDoc::Parser::C
#
# If you want to generate documentation using <tt>rake</tt> see RDoc::Task.
#
# If you want to drive RDoc programmatically, see RDoc::RDoc.
#
# If you want to use the library to format text blocks into HTML or other
# formats, look at RDoc::Markup.
#
# If you want to make an RDoc plugin such as a generator or directive handler
# see RDoc::RDoc.
#
# If you want to write your own output generator see RDoc::Generator.
#
# If you want an overview of how RDoc works see CONTRIBUTING
#
# == Credits
#
# RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>.
#
# Dave Thomas <dave@pragmaticprogrammer.com> is the original author of RDoc.
#
# * The Ruby parser in rdoc/parse.rb is based heavily on the outstanding
# work of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby
# parser for irb and the rtags package.
module RDoc
##
# Exception thrown by any rdoc error.
class Error < RuntimeError; end
require_relative 'rdoc/version'
##
# Method visibilities
VISIBILITIES = [:public, :protected, :private]
##
# Name of the dotfile that contains the description of files to be processed
# in the current directory
DOT_DOC_FILENAME = ".document"
##
# General RDoc modifiers
GENERAL_MODIFIERS = %w[nodoc].freeze
##
# RDoc modifiers for classes
CLASS_MODIFIERS = GENERAL_MODIFIERS
##
# RDoc modifiers for attributes
ATTR_MODIFIERS = GENERAL_MODIFIERS
##
# RDoc modifiers for constants
CONSTANT_MODIFIERS = GENERAL_MODIFIERS
##
# RDoc modifiers for methods
METHOD_MODIFIERS = GENERAL_MODIFIERS +
%w[arg args yield yields notnew not-new not_new doc]
##
# Loads the best available YAML library.
def self.load_yaml
begin
gem 'psych'
rescue NameError => e # --disable-gems
raise unless e.name == :gem
rescue Gem::LoadError
end
begin
require 'psych'
rescue ::LoadError
ensure
require 'yaml'
end
end
##
# Seaches and returns the directory for settings.
#
# 1. <tt>$HOME/.rdoc</tt> directory, if it exists.
# 2. The +rdoc+ directory under the path specified by the
# +XDG_DATA_HOME+ environment variable, if it is set.
# 3. <tt>$HOME/.local/share/rdoc</tt> directory.
#
# Other than the home directory, the containing directory will be
# created automatically.
def self.home
rdoc_dir = begin
File.expand_path('~/.rdoc')
rescue ArgumentError
end
if File.directory?(rdoc_dir)
rdoc_dir
else
require 'fileutils'
begin
# XDG
xdg_data_home = ENV["XDG_DATA_HOME"] || File.join(File.expand_path("~"), '.local', 'share')
unless File.exist?(xdg_data_home)
FileUtils.mkdir_p xdg_data_home
end
File.join xdg_data_home, "rdoc"
rescue Errno::EACCES
end
end
end
autoload :RDoc, "#{__dir__}/rdoc/rdoc"
autoload :CrossReference, "#{__dir__}/rdoc/cross_reference"
autoload :ERBIO, "#{__dir__}/rdoc/erbio"
autoload :ERBPartial, "#{__dir__}/rdoc/erb_partial"
autoload :Encoding, "#{__dir__}/rdoc/encoding"
autoload :Generator, "#{__dir__}/rdoc/generator"
autoload :Options, "#{__dir__}/rdoc/options"
autoload :Parser, "#{__dir__}/rdoc/parser"
autoload :Servlet, "#{__dir__}/rdoc/servlet"
autoload :RI, "#{__dir__}/rdoc/ri"
autoload :Stats, "#{__dir__}/rdoc/stats"
autoload :Store, "#{__dir__}/rdoc/store"
autoload :Task, "#{__dir__}/rdoc/task"
autoload :Text, "#{__dir__}/rdoc/text"
autoload :Markdown, "#{__dir__}/rdoc/markdown"
autoload :Markup, "#{__dir__}/rdoc/markup"
autoload :RD, "#{__dir__}/rdoc/rd"
autoload :TomDoc, "#{__dir__}/rdoc/tom_doc"
autoload :KNOWN_CLASSES, "#{__dir__}/rdoc/known_classes"
autoload :TokenStream, "#{__dir__}/rdoc/token_stream"
autoload :Comment, "#{__dir__}/rdoc/comment"
require_relative 'rdoc/i18n'
# code objects
#
# We represent the various high-level code constructs that appear in Ruby
# programs: classes, modules, methods, and so on.
autoload :CodeObject, "#{__dir__}/rdoc/code_object"
autoload :Context, "#{__dir__}/rdoc/context"
autoload :TopLevel, "#{__dir__}/rdoc/top_level"
autoload :AnonClass, "#{__dir__}/rdoc/anon_class"
autoload :ClassModule, "#{__dir__}/rdoc/class_module"
autoload :NormalClass, "#{__dir__}/rdoc/normal_class"
autoload :NormalModule, "#{__dir__}/rdoc/normal_module"
autoload :SingleClass, "#{__dir__}/rdoc/single_class"
autoload :Alias, "#{__dir__}/rdoc/alias"
autoload :AnyMethod, "#{__dir__}/rdoc/any_method"
autoload :MethodAttr, "#{__dir__}/rdoc/method_attr"
autoload :GhostMethod, "#{__dir__}/rdoc/ghost_method"
autoload :MetaMethod, "#{__dir__}/rdoc/meta_method"
autoload :Attr, "#{__dir__}/rdoc/attr"
autoload :Constant, "#{__dir__}/rdoc/constant"
autoload :Mixin, "#{__dir__}/rdoc/mixin"
autoload :Include, "#{__dir__}/rdoc/include"
autoload :Extend, "#{__dir__}/rdoc/extend"
autoload :Require, "#{__dir__}/rdoc/require"
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/class_module.rb 0000644 00000047503 15173517746 0016017 0 ustar 00 # frozen_string_literal: true
##
# ClassModule is the base class for objects representing either a class or a
# module.
class RDoc::ClassModule < RDoc::Context
##
# 1::
# RDoc 3.7
# * Added visibility, singleton and file to attributes
# * Added file to constants
# * Added file to includes
# * Added file to methods
# 2::
# RDoc 3.13
# * Added extends
# 3::
# RDoc 4.0
# * Added sections
# * Added in_files
# * Added parent name
# * Complete Constant dump
MARSHAL_VERSION = 3 # :nodoc:
##
# Constants that are aliases for this class or module
attr_accessor :constant_aliases
##
# Comment and the location it came from. Use #add_comment to add comments
attr_accessor :comment_location
attr_accessor :diagram # :nodoc:
##
# Class or module this constant is an alias for
attr_accessor :is_alias_for
##
# Return a RDoc::ClassModule of class +class_type+ that is a copy
# of module +module+. Used to promote modules to classes.
#--
# TODO move to RDoc::NormalClass (I think)
def self.from_module class_type, mod
klass = class_type.new mod.name
mod.comment_location.each do |comment, location|
klass.add_comment comment, location
end
klass.parent = mod.parent
klass.section = mod.section
klass.viewer = mod.viewer
klass.attributes.concat mod.attributes
klass.method_list.concat mod.method_list
klass.aliases.concat mod.aliases
klass.external_aliases.concat mod.external_aliases
klass.constants.concat mod.constants
klass.includes.concat mod.includes
klass.extends.concat mod.extends
klass.methods_hash.update mod.methods_hash
klass.constants_hash.update mod.constants_hash
klass.current_section = mod.current_section
klass.in_files.concat mod.in_files
klass.sections.concat mod.sections
klass.unmatched_alias_lists = mod.unmatched_alias_lists
klass.current_section = mod.current_section
klass.visibility = mod.visibility
klass.classes_hash.update mod.classes_hash
klass.modules_hash.update mod.modules_hash
klass.metadata.update mod.metadata
klass.document_self = mod.received_nodoc ? nil : mod.document_self
klass.document_children = mod.document_children
klass.force_documentation = mod.force_documentation
klass.done_documenting = mod.done_documenting
# update the parent of all children
(klass.attributes +
klass.method_list +
klass.aliases +
klass.external_aliases +
klass.constants +
klass.includes +
klass.extends +
klass.classes +
klass.modules).each do |obj|
obj.parent = klass
obj.full_name = nil
end
klass
end
##
# Creates a new ClassModule with +name+ with optional +superclass+
#
# This is a constructor for subclasses, and must never be called directly.
def initialize(name, superclass = nil)
@constant_aliases = []
@diagram = nil
@is_alias_for = nil
@name = name
@superclass = superclass
@comment_location = [] # [[comment, location]]
super()
end
##
# Adds +comment+ to this ClassModule's list of comments at +location+. This
# method is preferred over #comment= since it allows ri data to be updated
# across multiple runs.
def add_comment comment, location
return unless document_self
original = comment
comment = case comment
when RDoc::Comment then
comment.normalize
else
normalize_comment comment
end
if location.parser == RDoc::Parser::C
@comment_location.delete_if { |(_, l)| l == location }
end
@comment_location << [comment, location]
self.comment = original
end
def add_things my_things, other_things # :nodoc:
other_things.each do |group, things|
my_things[group].each { |thing| yield false, thing } if
my_things.include? group
things.each do |thing|
yield true, thing
end
end
end
##
# Ancestors list for this ClassModule: the list of included modules
# (classes will add their superclass if any).
#
# Returns the included classes or modules, not the includes
# themselves. The returned values are either String or
# RDoc::NormalModule instances (see RDoc::Include#module).
#
# The values are returned in reverse order of their inclusion,
# which is the order suitable for searching methods/attributes
# in the ancestors. The superclass, if any, comes last.
def ancestors
includes.map { |i| i.module }.reverse
end
def aref_prefix # :nodoc:
raise NotImplementedError, "missing aref_prefix for #{self.class}"
end
##
# HTML fragment reference for this module or class. See
# RDoc::NormalClass#aref and RDoc::NormalModule#aref
def aref
"#{aref_prefix}-#{full_name}"
end
##
# Ancestors of this class or module only
alias direct_ancestors ancestors
##
# Clears the comment. Used by the Ruby parser.
def clear_comment
@comment = ''
end
##
# This method is deprecated, use #add_comment instead.
#
# Appends +comment+ to the current comment, but separated by a rule. Works
# more like <tt>+=</tt>.
def comment= comment # :nodoc:
comment = case comment
when RDoc::Comment then
comment.normalize
else
normalize_comment comment
end
comment = "#{@comment.to_s}\n---\n#{comment.to_s}" unless @comment.empty?
super comment
end
##
# Prepares this ClassModule for use by a generator.
#
# See RDoc::Store#complete
def complete min_visibility
update_aliases
remove_nodoc_children
update_includes
remove_invisible min_visibility
end
##
# Does this ClassModule or any of its methods have document_self set?
def document_self_or_methods
document_self || method_list.any?{ |m| m.document_self }
end
##
# Does this class or module have a comment with content or is
# #received_nodoc true?
def documented?
return true if @received_nodoc
return false if @comment_location.empty?
@comment_location.any? { |comment, _| not comment.empty? }
end
##
# Iterates the ancestors of this class or module for which an
# RDoc::ClassModule exists.
def each_ancestor # :yields: module
return enum_for __method__ unless block_given?
ancestors.each do |mod|
next if String === mod
next if self == mod
yield mod
end
end
##
# Looks for a symbol in the #ancestors. See Context#find_local_symbol.
def find_ancestor_local_symbol symbol
each_ancestor do |m|
res = m.find_local_symbol(symbol)
return res if res
end
nil
end
##
# Finds a class or module with +name+ in this namespace or its descendants
def find_class_named name
return self if full_name == name
return self if @name == name
@classes.values.find do |klass|
next if klass == self
klass.find_class_named name
end
end
##
# Return the fully qualified name of this class or module
def full_name
@full_name ||= if RDoc::ClassModule === parent then
"#{parent.full_name}::#{@name}"
else
@name
end
end
##
# TODO: filter included items by #display?
def marshal_dump # :nodoc:
attrs = attributes.sort.map do |attr|
next unless attr.display?
[ attr.name, attr.rw,
attr.visibility, attr.singleton, attr.file_name,
]
end.compact
method_types = methods_by_type.map do |type, visibilities|
visibilities = visibilities.map do |visibility, methods|
method_names = methods.map do |method|
next unless method.display?
[method.name, method.file_name]
end.compact
[visibility, method_names.uniq]
end
[type, visibilities]
end
[ MARSHAL_VERSION,
@name,
full_name,
@superclass,
parse(@comment_location),
attrs,
constants.select { |constant| constant.display? },
includes.map do |incl|
next unless incl.display?
[incl.name, parse(incl.comment), incl.file_name]
end.compact,
method_types,
extends.map do |ext|
next unless ext.display?
[ext.name, parse(ext.comment), ext.file_name]
end.compact,
@sections.values,
@in_files.map do |tl|
tl.relative_name
end,
parent.full_name,
parent.class,
]
end
def marshal_load array # :nodoc:
initialize_visibility
initialize_methods_etc
@current_section = nil
@document_self = true
@done_documenting = false
@parent = nil
@temporary_section = nil
@visibility = nil
@classes = {}
@modules = {}
@name = array[1]
@full_name = array[2]
@superclass = array[3]
@comment = array[4]
@comment_location = if RDoc::Markup::Document === @comment.parts.first then
@comment
else
RDoc::Markup::Document.new @comment
end
array[5].each do |name, rw, visibility, singleton, file|
singleton ||= false
visibility ||= :public
attr = RDoc::Attr.new nil, name, rw, nil, singleton
add_attribute attr
attr.visibility = visibility
attr.record_location RDoc::TopLevel.new file
end
array[6].each do |constant, comment, file|
case constant
when RDoc::Constant then
add_constant constant
else
constant = add_constant RDoc::Constant.new(constant, nil, comment)
constant.record_location RDoc::TopLevel.new file
end
end
array[7].each do |name, comment, file|
incl = add_include RDoc::Include.new(name, comment)
incl.record_location RDoc::TopLevel.new file
end
array[8].each do |type, visibilities|
visibilities.each do |visibility, methods|
@visibility = visibility
methods.each do |name, file|
method = RDoc::AnyMethod.new nil, name
method.singleton = true if type == 'class'
method.record_location RDoc::TopLevel.new file
add_method method
end
end
end
array[9].each do |name, comment, file|
ext = add_extend RDoc::Extend.new(name, comment)
ext.record_location RDoc::TopLevel.new file
end if array[9] # Support Marshal version 1
sections = (array[10] || []).map do |section|
[section.title, section]
end
@sections = Hash[*sections.flatten]
@current_section = add_section nil
@in_files = []
(array[11] || []).each do |filename|
record_location RDoc::TopLevel.new filename
end
@parent_name = array[12]
@parent_class = array[13]
end
##
# Merges +class_module+ into this ClassModule.
#
# The data in +class_module+ is preferred over the receiver.
def merge class_module
@parent = class_module.parent
@parent_name = class_module.parent_name
other_document = parse class_module.comment_location
if other_document then
document = parse @comment_location
document = document.merge other_document
@comment = @comment_location = document
end
cm = class_module
other_files = cm.in_files
merge_collections attributes, cm.attributes, other_files do |add, attr|
if add then
add_attribute attr
else
@attributes.delete attr
@methods_hash.delete attr.pretty_name
end
end
merge_collections constants, cm.constants, other_files do |add, const|
if add then
add_constant const
else
@constants.delete const
@constants_hash.delete const.name
end
end
merge_collections includes, cm.includes, other_files do |add, incl|
if add then
add_include incl
else
@includes.delete incl
end
end
@includes.uniq! # clean up
merge_collections extends, cm.extends, other_files do |add, ext|
if add then
add_extend ext
else
@extends.delete ext
end
end
@extends.uniq! # clean up
merge_collections method_list, cm.method_list, other_files do |add, meth|
if add then
add_method meth
else
@method_list.delete meth
@methods_hash.delete meth.pretty_name
end
end
merge_sections cm
self
end
##
# Merges collection +mine+ with +other+ preferring other. +other_files+ is
# used to help determine which items should be deleted.
#
# Yields whether the item should be added or removed (true or false) and the
# item to be added or removed.
#
# merge_collections things, other.things, other.in_files do |add, thing|
# if add then
# # add the thing
# else
# # remove the thing
# end
# end
def merge_collections mine, other, other_files, &block # :nodoc:
my_things = mine. group_by { |thing| thing.file }
other_things = other.group_by { |thing| thing.file }
remove_things my_things, other_files, &block
add_things my_things, other_things, &block
end
##
# Merges the comments in this ClassModule with the comments in the other
# ClassModule +cm+.
def merge_sections cm # :nodoc:
my_sections = sections.group_by { |section| section.title }
other_sections = cm.sections.group_by { |section| section.title }
other_files = cm.in_files
remove_things my_sections, other_files do |_, section|
@sections.delete section.title
end
other_sections.each do |group, sections|
if my_sections.include? group
my_sections[group].each do |my_section|
other_section = cm.sections_hash[group]
my_comments = my_section.comments
other_comments = other_section.comments
other_files = other_section.in_files
merge_collections my_comments, other_comments, other_files do |add, comment|
if add then
my_section.add_comment comment
else
my_section.remove_comment comment
end
end
end
else
sections.each do |section|
add_section group, section.comments
end
end
end
end
##
# Does this object represent a module?
def module?
false
end
##
# Allows overriding the initial name.
#
# Used for modules and classes that are constant aliases.
def name= new_name
@name = new_name
end
##
# Parses +comment_location+ into an RDoc::Markup::Document composed of
# multiple RDoc::Markup::Documents with their file set.
def parse comment_location
case comment_location
when String then
super
when Array then
docs = comment_location.map do |comment, location|
doc = super comment
doc.file = location
doc
end
RDoc::Markup::Document.new(*docs)
when RDoc::Comment then
doc = super comment_location.text, comment_location.format
doc.file = comment_location.location
doc
when RDoc::Markup::Document then
return comment_location
else
raise ArgumentError, "unknown comment class #{comment_location.class}"
end
end
##
# Path to this class or module for use with HTML generator output.
def path
http_url @store.rdoc.generator.class_dir
end
##
# Name to use to generate the url:
# modules and classes that are aliases for another
# module or class return the name of the latter.
def name_for_path
is_alias_for ? is_alias_for.full_name : full_name
end
##
# Returns the classes and modules that are not constants
# aliasing another class or module. For use by formatters
# only (caches its result).
def non_aliases
@non_aliases ||= classes_and_modules.reject { |cm| cm.is_alias_for }
end
##
# Updates the child modules or classes of class/module +parent+ by
# deleting the ones that have been removed from the documentation.
#
# +parent_hash+ is either <tt>parent.modules_hash</tt> or
# <tt>parent.classes_hash</tt> and +all_hash+ is ::all_modules_hash or
# ::all_classes_hash.
def remove_nodoc_children
prefix = self.full_name + '::'
modules_hash.each_key do |name|
full_name = prefix + name
modules_hash.delete name unless @store.modules_hash[full_name]
end
classes_hash.each_key do |name|
full_name = prefix + name
classes_hash.delete name unless @store.classes_hash[full_name]
end
end
def remove_things my_things, other_files # :nodoc:
my_things.delete_if do |file, things|
next false unless other_files.include? file
things.each do |thing|
yield false, thing
end
true
end
end
##
# Search record used by RDoc::Generator::JsonIndex
def search_record
[
name,
full_name,
full_name,
'',
path,
'',
snippet(@comment_location),
]
end
##
# Sets the store for this class or module and its contained code objects.
def store= store
super
@attributes .each do |attr| attr.store = store end
@constants .each do |const| const.store = store end
@includes .each do |incl| incl.store = store end
@extends .each do |ext| ext.store = store end
@method_list.each do |meth| meth.store = store end
end
##
# Get the superclass of this class. Attempts to retrieve the superclass
# object, returns the name if it is not known.
def superclass
@store.find_class_named(@superclass) || @superclass
end
##
# Set the superclass of this class to +superclass+
def superclass=(superclass)
raise NoMethodError, "#{full_name} is a module" if module?
@superclass = superclass
end
def to_s # :nodoc:
if is_alias_for then
"#{self.class.name} #{self.full_name} -> #{is_alias_for}"
else
super
end
end
##
# 'module' or 'class'
def type
module? ? 'module' : 'class'
end
##
# Updates the child modules & classes by replacing the ones that are
# aliases through a constant.
#
# The aliased module/class is replaced in the children and in
# RDoc::Store#modules_hash or RDoc::Store#classes_hash
# by a copy that has <tt>RDoc::ClassModule#is_alias_for</tt> set to
# the aliased module/class, and this copy is added to <tt>#aliases</tt>
# of the aliased module/class.
#
# Formatters can use the #non_aliases method to retrieve children that
# are not aliases, for instance to list the namespace content, since
# the aliased modules are included in the constants of the class/module,
# that are listed separately.
def update_aliases
constants.each do |const|
next unless cm = const.is_alias_for
cm_alias = cm.dup
cm_alias.name = const.name
# Don't move top-level aliases under Object, they look ugly there
unless RDoc::TopLevel === cm_alias.parent then
cm_alias.parent = self
cm_alias.full_name = nil # force update for new parent
end
cm_alias.aliases.clear
cm_alias.is_alias_for = cm
if cm.module? then
@store.modules_hash[cm_alias.full_name] = cm_alias
modules_hash[const.name] = cm_alias
else
@store.classes_hash[cm_alias.full_name] = cm_alias
classes_hash[const.name] = cm_alias
end
cm.aliases << cm_alias
end
end
##
# Deletes from #includes those whose module has been removed from the
# documentation.
#--
# FIXME: includes are not reliably removed, see _possible_bug test case
def update_includes
includes.reject! do |include|
mod = include.module
!(String === mod) && @store.modules_hash[mod.full_name].nil?
end
includes.uniq!
end
##
# Deletes from #extends those whose module has been removed from the
# documentation.
#--
# FIXME: like update_includes, extends are not reliably removed
def update_extends
extends.reject! do |ext|
mod = ext.module
!(String === mod) && @store.modules_hash[mod.full_name].nil?
end
extends.uniq!
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/stats/normal.rb 0000644 00000003060 15173517746 0015761 0 ustar 00 # frozen_string_literal: true
begin
require 'io/console/size'
rescue LoadError
# for JRuby
require 'io/console'
end
##
# Stats printer that prints just the files being documented with a progress
# bar
class RDoc::Stats::Normal < RDoc::Stats::Quiet
def begin_adding # :nodoc:
puts "Parsing sources..."
@last_width = 0
end
##
# Prints a file with a progress bar
def print_file files_so_far, filename
progress_bar = sprintf("%3d%% [%2d/%2d] ",
100 * files_so_far / @num_files,
files_so_far,
@num_files)
if $stdout.tty?
# Print a progress bar, but make sure it fits on a single line. Filename
# will be truncated if necessary.
size = IO.respond_to?(:console_size) ? IO.console_size : IO.console.winsize
terminal_width = size[1].to_i.nonzero? || 80
max_filename_size = (terminal_width - progress_bar.size) - 1
if filename.size > max_filename_size then
# Turn "some_long_filename.rb" to "...ong_filename.rb"
filename = filename[(filename.size - max_filename_size) .. -1]
filename[0..2] = "..."
end
# Clean the line with whitespaces so that leftover output from the
# previous line doesn't show up.
$stdout.print("\r\e[K") if @last_width && @last_width > 0
@last_width = progress_bar.size + filename.size
term = "\r"
else
term = "\n"
end
$stdout.print(progress_bar, filename, term)
$stdout.flush
end
def done_adding # :nodoc:
puts
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/stats/quiet.rb 0000644 00000001477 15173517746 0015632 0 ustar 00 # frozen_string_literal: true
##
# Stats printer that prints nothing
class RDoc::Stats::Quiet
##
# Creates a new Quiet that will print nothing
def initialize num_files
@num_files = num_files
end
##
# Prints a message at the beginning of parsing
def begin_adding(*) end
##
# Prints when an alias is added
def print_alias(*) end
##
# Prints when an attribute is added
def print_attribute(*) end
##
# Prints when a class is added
def print_class(*) end
##
# Prints when a constant is added
def print_constant(*) end
##
# Prints when a file is added
def print_file(*) end
##
# Prints when a method is added
def print_method(*) end
##
# Prints when a module is added
def print_module(*) end
##
# Prints when RDoc is done
def done_adding(*) end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/stats/verbose.rb 0000644 00000001762 15173517746 0016145 0 ustar 00 # frozen_string_literal: true
##
# Stats printer that prints everything documented, including the documented
# status
class RDoc::Stats::Verbose < RDoc::Stats::Normal
##
# Returns a marker for RDoc::CodeObject +co+ being undocumented
def nodoc co
" (undocumented)" unless co.documented?
end
def print_alias as # :nodoc:
puts " alias #{as.new_name} #{as.old_name}#{nodoc as}"
end
def print_attribute attribute # :nodoc:
puts " #{attribute.definition} #{attribute.name}#{nodoc attribute}"
end
def print_class(klass) # :nodoc:
puts " class #{klass.full_name}#{nodoc klass}"
end
def print_constant(constant) # :nodoc:
puts " #{constant.name}#{nodoc constant}"
end
def print_file(files_so_far, file) # :nodoc:
super
puts
end
def print_method(method) # :nodoc:
puts " #{method.singleton ? '::' : '#'}#{method.name}#{nodoc method}"
end
def print_module(mod) # :nodoc:
puts " module #{mod.full_name}#{nodoc mod}"
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator.rb 0000644 00000003513 15173517746 0015324 0 ustar 00 # frozen_string_literal: true
##
# RDoc uses generators to turn parsed source code in the form of an
# RDoc::CodeObject tree into some form of output. RDoc comes with the HTML
# generator RDoc::Generator::Darkfish and an ri data generator
# RDoc::Generator::RI.
#
# == Registering a Generator
#
# Generators are registered by calling RDoc::RDoc.add_generator with the class
# of the generator:
#
# class My::Awesome::Generator
# RDoc::RDoc.add_generator self
# end
#
# == Adding Options to +rdoc+
#
# Before option processing in +rdoc+, RDoc::Options will call ::setup_options
# on the generator class with an RDoc::Options instance. The generator can
# use RDoc::Options#option_parser to add command-line options to the +rdoc+
# tool. See RDoc::Options@Custom+Options for an example and see OptionParser
# for details on how to add options.
#
# You can extend the RDoc::Options instance with additional accessors for your
# generator.
#
# == Generator Instantiation
#
# After parsing, RDoc::RDoc will instantiate a generator by calling
# #initialize with an RDoc::Store instance and an RDoc::Options instance.
#
# The RDoc::Store instance holds documentation for parsed source code. In
# RDoc 3 and earlier the RDoc::TopLevel class held this data. When upgrading
# a generator from RDoc 3 and earlier you should only need to replace
# RDoc::TopLevel with the store instance.
#
# RDoc will then call #generate on the generator instance. You can use the
# various methods on RDoc::Store and in the RDoc::CodeObject tree to create
# your desired output format.
module RDoc::Generator
autoload :Markup, "#{__dir__}/generator/markup"
autoload :Darkfish, "#{__dir__}/generator/darkfish"
autoload :JsonIndex, "#{__dir__}/generator/json_index"
autoload :RI, "#{__dir__}/generator/ri"
autoload :POT, "#{__dir__}/generator/pot"
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/attr_changer.rb 0000644 00000000647 15173517746 0017303 0 ustar 00 # frozen_string_literal: true
class RDoc::Markup
AttrChanger = Struct.new :turn_on, :turn_off # :nodoc:
end
##
# An AttrChanger records a change in attributes. It contains a bitmap of the
# attributes to turn on, and a bitmap of those to turn off.
class RDoc::Markup::AttrChanger
def to_s # :nodoc:
"Attr: +#{turn_on}/-#{turn_off}"
end
def inspect # :nodoc:
'+%d/-%d' % [turn_on, turn_off]
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/table.rb 0000644 00000002170 15173517747 0015723 0 ustar 00 # frozen_string_literal: true
##
# A section of table
class RDoc::Markup::Table
# headers of each column
attr_accessor :header
# alignments of each column
attr_accessor :align
# body texts of each column
attr_accessor :body
# Creates new instance
def initialize header, align, body
@header, @align, @body = header, align, body
end
# :stopdoc:
def == other
self.class == other.class and
@header == other.header and
@align == other.align and
@body == other.body
end
def accept visitor
visitor.accept_table @header, @body, @align
end
def pretty_print q
q.group 2, '[Table: ', ']' do
q.group 2, '[Head: ', ']' do
q.seplist @header.zip(@align) do |text, align|
q.pp text
if align
q.text ":"
q.breakable
q.text align.to_s
end
end
end
q.breakable
q.group 2, '[Body: ', ']' do
q.seplist @body do |body|
q.group 2, '[', ']' do
q.seplist body do |text|
q.pp text
end
end
end
end
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/attributes.rb 0000644 00000002374 15173517747 0017030 0 ustar 00 # frozen_string_literal: true
##
# We manage a set of attributes. Each attribute has a symbol name and a bit
# value.
class RDoc::Markup::Attributes
##
# The regexp handling attribute type. See RDoc::Markup#add_regexp_handling
attr_reader :regexp_handling
##
# Creates a new attributes set.
def initialize
@regexp_handling = 1
@name_to_bitmap = [
[:_REGEXP_HANDLING_, @regexp_handling],
]
@next_bitmap = @regexp_handling << 1
end
##
# Returns a unique bit for +name+
def bitmap_for name
bitmap = @name_to_bitmap.assoc name
unless bitmap then
bitmap = @next_bitmap
@next_bitmap <<= 1
@name_to_bitmap << [name, bitmap]
else
bitmap = bitmap.last
end
bitmap
end
##
# Returns a string representation of +bitmap+
def as_string bitmap
return 'none' if bitmap.zero?
res = []
@name_to_bitmap.each do |name, bit|
res << name if (bitmap & bit) != 0
end
res.join ','
end
##
# yields each attribute name in +bitmap+
def each_name_of bitmap
return enum_for __method__, bitmap unless block_given?
@name_to_bitmap.each do |name, bit|
next if bit == @regexp_handling
yield name.to_s if (bitmap & bit) != 0
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/hard_break.rb 0000644 00000000675 15173517747 0016726 0 ustar 00 # frozen_string_literal: true
##
# A hard-break in the middle of a paragraph.
class RDoc::Markup::HardBreak
@instance = new
##
# RDoc::Markup::HardBreak is a singleton
def self.new
@instance
end
##
# Calls #accept_hard_break on +visitor+
def accept visitor
visitor.accept_hard_break self
end
def == other # :nodoc:
self.class === other
end
def pretty_print q # :nodoc:
q.text "[break]"
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/block_quote.rb 0000644 00000000373 15173517747 0017146 0 ustar 00 # frozen_string_literal: true
##
# A quoted section which contains markup items.
class RDoc::Markup::BlockQuote < RDoc::Markup::Raw
##
# Calls #accept_block_quote on +visitor+
def accept visitor
visitor.accept_block_quote self
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_joined_paragraph.rb 0000644 00000002207 15173517747 0020634 0 ustar 00 # frozen_string_literal: true
##
# Joins the parts of an RDoc::Markup::Paragraph into a single String.
#
# This allows for easier maintenance and testing of Markdown support.
#
# This formatter only works on Paragraph instances. Attempting to process
# other markup syntax items will not work.
class RDoc::Markup::ToJoinedParagraph < RDoc::Markup::Formatter
def initialize # :nodoc:
super nil
end
def start_accepting # :nodoc:
end
def end_accepting # :nodoc:
end
##
# Converts the parts of +paragraph+ to a single entry.
def accept_paragraph paragraph
parts = paragraph.parts.chunk do |part|
String === part
end.flat_map do |string, chunk|
string ? chunk.join.rstrip : chunk
end
paragraph.parts.replace parts
end
alias accept_block_quote ignore
alias accept_heading ignore
alias accept_list_end ignore
alias accept_list_item_end ignore
alias accept_list_item_start ignore
alias accept_list_start ignore
alias accept_raw ignore
alias accept_rule ignore
alias accept_verbatim ignore
alias accept_table ignore
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_tt_only.rb 0000644 00000004435 15173517747 0017034 0 ustar 00 # frozen_string_literal: true
##
# Extracts sections of text enclosed in plus, tt or code. Used to discover
# undocumented parameters.
class RDoc::Markup::ToTtOnly < RDoc::Markup::Formatter
##
# Stack of list types
attr_reader :list_type
##
# Output accumulator
attr_reader :res
##
# Creates a new tt-only formatter.
def initialize markup = nil
super nil, markup
add_tag :TT, nil, nil
end
##
# Adds tts from +block_quote+ to the output
def accept_block_quote block_quote
tt_sections block_quote.text
end
##
# Pops the list type for +list+ from #list_type
def accept_list_end list
@list_type.pop
end
##
# Pushes the list type for +list+ onto #list_type
def accept_list_start list
@list_type << list.type
end
##
# Prepares the visitor for consuming +list_item+
def accept_list_item_start list_item
case @list_type.last
when :NOTE, :LABEL then
Array(list_item.label).map do |label|
tt_sections label
end.flatten
end
end
##
# Adds +paragraph+ to the output
def accept_paragraph paragraph
tt_sections(paragraph.text)
end
##
# Does nothing to +markup_item+ because it doesn't have any user-built
# content
def do_nothing markup_item
end
alias accept_blank_line do_nothing # :nodoc:
alias accept_heading do_nothing # :nodoc:
alias accept_list_item_end do_nothing # :nodoc:
alias accept_raw do_nothing # :nodoc:
alias accept_rule do_nothing # :nodoc:
alias accept_verbatim do_nothing # :nodoc:
##
# Extracts tt sections from +text+
def tt_sections text
flow = @am.flow text.dup
flow.each do |item|
case item
when String then
@res << item if in_tt?
when RDoc::Markup::AttrChanger then
off_tags res, item
on_tags res, item
when RDoc::Markup::RegexpHandling then
@res << convert_regexp_handling(item) if in_tt? # TODO can this happen?
else
raise "Unknown flow element: #{item.inspect}"
end
end
res
end
##
# Returns an Array of items that were wrapped in plus, tt or code.
def end_accepting
@res.compact
end
##
# Prepares the visitor for gathering tt sections
def start_accepting
@res = []
@list_type = []
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_table_of_contents.rb 0000644 00000003334 15173517747 0021031 0 ustar 00 # frozen_string_literal: true
##
# Extracts just the RDoc::Markup::Heading elements from a
# RDoc::Markup::Document to help build a table of contents
class RDoc::Markup::ToTableOfContents < RDoc::Markup::Formatter
@to_toc = nil
##
# Singleton for table-of-contents generation
def self.to_toc
@to_toc ||= new
end
##
# Output accumulator
attr_reader :res
##
# Omits headings with a level less than the given level.
attr_accessor :omit_headings_below
def initialize # :nodoc:
super nil
@omit_headings_below = nil
end
##
# Adds +document+ to the output, using its heading cutoff if present
def accept_document document
@omit_headings_below = document.omit_headings_below
super
end
##
# Adds +heading+ to the table of contents
def accept_heading heading
@res << heading unless suppressed? heading
end
##
# Returns the table of contents
def end_accepting
@res
end
##
# Prepares the visitor for text generation
def start_accepting
@omit_headings_below = nil
@res = []
end
##
# Returns true if +heading+ is below the display threshold
def suppressed? heading
return false unless @omit_headings_below
heading.level > @omit_headings_below
end
# :stopdoc:
alias accept_block_quote ignore
alias accept_raw ignore
alias accept_rule ignore
alias accept_blank_line ignore
alias accept_paragraph ignore
alias accept_verbatim ignore
alias accept_list_end ignore
alias accept_list_item_start ignore
alias accept_list_item_end ignore
alias accept_list_end_bullet ignore
alias accept_list_start ignore
alias accept_table ignore
# :startdoc:
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_bs.rb 0000644 00000003223 15173517747 0015742 0 ustar 00 # frozen_string_literal: true
##
# Outputs RDoc markup with hot backspace action! You will probably need a
# pager to use this output format.
#
# This formatter won't work on 1.8.6 because it lacks String#chars.
class RDoc::Markup::ToBs < RDoc::Markup::ToRdoc
##
# Returns a new ToBs that is ready for hot backspace action!
def initialize markup = nil
super
@in_b = false
@in_em = false
end
##
# Sets a flag that is picked up by #annotate to do the right thing in
# #convert_string
def init_tags
add_tag :BOLD, '+b', '-b'
add_tag :EM, '+_', '-_'
add_tag :TT, '' , '' # we need in_tt information maintained
end
##
# Makes heading text bold.
def accept_heading heading
use_prefix or @res << ' ' * @indent
@res << @headings[heading.level][0]
@in_b = true
@res << attributes(heading.text)
@in_b = false
@res << @headings[heading.level][1]
@res << "\n"
end
##
# Turns on or off regexp handling for +convert_string+
def annotate tag
case tag
when '+b' then @in_b = true
when '-b' then @in_b = false
when '+_' then @in_em = true
when '-_' then @in_em = false
end
''
end
##
# Calls convert_string on the result of convert_regexp_handling
def convert_regexp_handling target
convert_string super
end
##
# Adds bold or underline mixed with backspaces
def convert_string string
return string unless @in_b or @in_em
chars = if @in_b then
string.chars.map do |char| "#{char}\b#{char}" end
elsif @in_em then
string.chars.map do |char| "_\b#{char}" end
end
chars.join
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/raw.rb 0000644 00000001747 15173517747 0015436 0 ustar 00 # frozen_string_literal: true
##
# A section of text that is added to the output document as-is
class RDoc::Markup::Raw
##
# The component parts of the list
attr_reader :parts
##
# Creates a new Raw containing +parts+
def initialize *parts
@parts = []
@parts.concat parts
end
##
# Appends +text+
def << text
@parts << text
end
def == other # :nodoc:
self.class == other.class and @parts == other.parts
end
##
# Calls #accept_raw+ on +visitor+
def accept visitor
visitor.accept_raw self
end
##
# Appends +other+'s parts
def merge other
@parts.concat other.parts
end
def pretty_print q # :nodoc:
self.class.name =~ /.*::(\w{1,4})/i
q.group 2, "[#{$1.downcase}: ", ']' do
q.seplist @parts do |part|
q.pp part
end
end
end
##
# Appends +texts+ onto this Paragraph
def push *texts
self.parts.concat texts
end
##
# The raw text
def text
@parts.join ' '
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_html_snippet.rb 0000644 00000013001 15173517747 0020037 0 ustar 00 # frozen_string_literal: true
##
# Outputs RDoc markup as paragraphs with inline markup only.
class RDoc::Markup::ToHtmlSnippet < RDoc::Markup::ToHtml
##
# After this many characters the input will be cut off.
attr_reader :character_limit
##
# The number of characters seen so far.
attr_reader :characters # :nodoc:
##
# The attribute bitmask
attr_reader :mask
##
# After this many paragraphs the input will be cut off.
attr_reader :paragraph_limit
##
# Count of paragraphs found
attr_reader :paragraphs
##
# Creates a new ToHtmlSnippet formatter that will cut off the input on the
# next word boundary after the given number of +characters+ or +paragraphs+
# of text have been encountered.
def initialize options, characters = 100, paragraphs = 3, markup = nil
super options, markup
@character_limit = characters
@paragraph_limit = paragraphs
@characters = 0
@mask = 0
@paragraphs = 0
@markup.add_regexp_handling RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
end
##
# Adds +heading+ to the output as a paragraph
def accept_heading heading
@res << "<p>#{to_html heading.text}\n"
add_paragraph
end
##
# Raw sections are untrusted and ignored
alias accept_raw ignore
##
# Rules are ignored
alias accept_rule ignore
##
# Adds +paragraph+ to the output
def accept_paragraph paragraph
para = @in_list_entry.last || "<p>"
text = paragraph.text @hard_break
@res << "#{para}#{to_html text}\n"
add_paragraph
end
##
# Finishes consumption of +list_item+
def accept_list_item_end list_item
end
##
# Prepares the visitor for consuming +list_item+
def accept_list_item_start list_item
@res << list_item_start(list_item, @list.last)
end
##
# Prepares the visitor for consuming +list+
def accept_list_start list
@list << list.type
@res << html_list_name(list.type, true)
@in_list_entry.push ''
end
##
# Adds +verbatim+ to the output
def accept_verbatim verbatim
throw :done if @characters >= @character_limit
input = verbatim.text.rstrip
text = truncate input
text << ' ...' unless text == input
super RDoc::Markup::Verbatim.new text
add_paragraph
end
##
# Prepares the visitor for HTML snippet generation
def start_accepting
super
@characters = 0
end
##
# Removes escaping from the cross-references in +target+
def handle_regexp_CROSSREF target
target.text.sub(/\A\\/, '')
end
##
# +target+ is a <code><br></code>
def handle_regexp_HARD_BREAK target
@characters -= 4
'<br>'
end
##
# Lists are paragraphs, but notes and labels have a separator
def list_item_start list_item, list_type
throw :done if @characters >= @character_limit
case list_type
when :BULLET, :LALPHA, :NUMBER, :UALPHA then
"<p>"
when :LABEL, :NOTE then
labels = Array(list_item.label).map do |label|
to_html label
end.join ', '
labels << " — " unless labels.empty?
start = "<p>#{labels}"
@characters += 1 # try to include the label
start
else
raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
end
end
##
# Returns just the text of +link+, +url+ is only used to determine the link
# type.
def gen_url url, text
if url =~ /^rdoc-label:([^:]*)(?::(.*))?/ then
type = "link"
elsif url =~ /([A-Za-z]+):(.*)/ then
type = $1
else
type = "http"
end
if (type == "http" or type == "https" or type == "link") and
url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
''
else
text.sub(%r%^#{type}:/*%, '')
end
end
##
# In snippets, there are no lists
def html_list_name list_type, open_tag
''
end
##
# Throws +:done+ when paragraph_limit paragraphs have been encountered
def add_paragraph
@paragraphs += 1
throw :done if @paragraphs >= @paragraph_limit
end
##
# Marks up +content+
def convert content
catch :done do
return super
end
end_accepting
end
##
# Converts flow items +flow+
def convert_flow flow
throw :done if @characters >= @character_limit
res = []
@mask = 0
flow.each do |item|
case item
when RDoc::Markup::AttrChanger then
off_tags res, item
on_tags res, item
when String then
text = convert_string item
res << truncate(text)
when RDoc::Markup::RegexpHandling then
text = convert_regexp_handling item
res << truncate(text)
else
raise "Unknown flow element: #{item.inspect}"
end
if @characters >= @character_limit then
off_tags res, RDoc::Markup::AttrChanger.new(0, @mask)
break
end
end
res << ' ...' if @characters >= @character_limit
res.join
end
##
# Maintains a bitmask to allow HTML elements to be closed properly. See
# RDoc::Markup::Formatter.
def on_tags res, item
@mask ^= item.turn_on
super
end
##
# Maintains a bitmask to allow HTML elements to be closed properly. See
# RDoc::Markup::Formatter.
def off_tags res, item
@mask ^= item.turn_off
super
end
##
# Truncates +text+ at the end of the first word after the character_limit.
def truncate text
length = text.length
characters = @characters
@characters += length
return text if @characters < @character_limit
remaining = @character_limit - characters
text =~ /\A(.{#{remaining},}?)(\s|$)/m # TODO word-break instead of \s?
$1
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_ansi.rb 0000644 00000004065 15173517747 0016275 0 ustar 00 # frozen_string_literal: true
##
# Outputs RDoc markup with vibrant ANSI color!
class RDoc::Markup::ToAnsi < RDoc::Markup::ToRdoc
##
# Creates a new ToAnsi visitor that is ready to output vibrant ANSI color!
def initialize markup = nil
super
@headings.clear
@headings[1] = ["\e[1;32m", "\e[m"] # bold
@headings[2] = ["\e[4;32m", "\e[m"] # underline
@headings[3] = ["\e[32m", "\e[m"] # just green
end
##
# Maps attributes to ANSI sequences
def init_tags
add_tag :BOLD, "\e[1m", "\e[m"
add_tag :TT, "\e[7m", "\e[m"
add_tag :EM, "\e[4m", "\e[m"
end
##
# Overrides indent width to ensure output lines up correctly.
def accept_list_item_end list_item
width = case @list_type.last
when :BULLET then
2
when :NOTE, :LABEL then
if @prefix then
@res << @prefix.strip
@prefix = nil
end
@res << "\n" unless res.length == 1
2
else
bullet = @list_index.last.to_s
@list_index[-1] = @list_index.last.succ
bullet.length + 2
end
@indent -= width
end
##
# Adds coloring to note and label list items
def accept_list_item_start list_item
bullet = case @list_type.last
when :BULLET then
'*'
when :NOTE, :LABEL then
labels = Array(list_item.label).map do |label|
attributes(label).strip
end.join "\n"
labels << ":\n" unless labels.empty?
labels
else
@list_index.last.to_s + '.'
end
case @list_type.last
when :NOTE, :LABEL then
@indent += 2
@prefix = bullet + (' ' * @indent)
else
@prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
width = bullet.gsub(/\e\[[\d;]*m/, '').length + 1
@indent += width
end
end
##
# Starts accepting with a reset screen
def start_accepting
super
@res = ["\e[0m"]
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/pre_process.rb 0000644 00000020652 15173517747 0017165 0 ustar 00 # frozen_string_literal: true
##
# Handle common directives that can occur in a block of text:
#
# \:include: filename
#
# Directives can be escaped by preceding them with a backslash.
#
# RDoc plugin authors can register additional directives to be handled by
# using RDoc::Markup::PreProcess::register.
#
# Any directive that is not built-in to RDoc (including those registered via
# plugins) will be stored in the metadata hash on the CodeObject the comment
# is attached to. See RDoc::Markup@Directives for the list of built-in
# directives.
class RDoc::Markup::PreProcess
##
# An RDoc::Options instance that will be filled in with overrides from
# directives
attr_accessor :options
##
# Adds a post-process handler for directives. The handler will be called
# with the result RDoc::Comment (or text String) and the code object for the
# comment (if any).
def self.post_process &block
@post_processors << block
end
##
# Registered post-processors
def self.post_processors
@post_processors
end
##
# Registers +directive+ as one handled by RDoc. If a block is given the
# directive will be replaced by the result of the block, otherwise the
# directive will be removed from the processed text.
#
# The block will be called with the directive name and the directive
# parameter:
#
# RDoc::Markup::PreProcess.register 'my-directive' do |directive, param|
# # replace text, etc.
# end
def self.register directive, &block
@registered[directive] = block
end
##
# Registered directives
def self.registered
@registered
end
##
# Clears all registered directives and post-processors
def self.reset
@post_processors = []
@registered = {}
end
reset
##
# Creates a new pre-processor for +input_file_name+ that will look for
# included files in +include_path+
def initialize(input_file_name, include_path)
@input_file_name = input_file_name
@include_path = include_path
@options = nil
end
##
# Look for directives in the given +text+.
#
# Options that we don't handle are yielded. If the block returns false the
# directive is restored to the text. If the block returns nil or no block
# was given the directive is handled according to the registered directives.
# If a String was returned the directive is replaced with the string.
#
# If no matching directive was registered the directive is restored to the
# text.
#
# If +code_object+ is given and the directive is unknown then the
# directive's parameter is set as metadata on the +code_object+. See
# RDoc::CodeObject#metadata for details.
def handle text, code_object = nil, &block
if RDoc::Comment === text then
comment = text
text = text.text
end
# regexp helper (square brackets for optional)
# $1 $2 $3 $4 $5
# [prefix][\]:directive:[spaces][param]newline
text = text.gsub(/^([ \t]*(?:#|\/?\*)?[ \t]*)(\\?):(\w+):([ \t]*)(.+)?(\r?\n|$)/) do
# skip something like ':toto::'
next $& if $4.empty? and $5 and $5[0, 1] == ':'
# skip if escaped
next "#$1:#$3:#$4#$5\n" unless $2.empty?
# This is not in handle_directive because I didn't want to pass another
# argument into it
if comment and $3 == 'markup' then
next "#{$1.strip}\n" unless $5
comment.format = $5.downcase
next "#{$1.strip}\n"
end
handle_directive $1, $3, $5, code_object, text.encoding, &block
end
if comment then
comment.text = text
else
comment = text
end
self.class.post_processors.each do |handler|
handler.call comment, code_object
end
text
end
##
# Performs the actions described by +directive+ and its parameter +param+.
#
# +code_object+ is used for directives that operate on a class or module.
# +prefix+ is used to ensure the replacement for handled directives is
# correct. +encoding+ is used for the <tt>include</tt> directive.
#
# For a list of directives in RDoc see RDoc::Markup.
#--
# When 1.8.7 support is ditched prefix can be defaulted to ''
def handle_directive prefix, directive, param, code_object = nil,
encoding = nil
blankline = "#{prefix.strip}\n"
directive = directive.downcase
case directive
when 'arg', 'args' then
return "#{prefix}:#{directive}: #{param}\n" unless code_object && code_object.kind_of?(RDoc::AnyMethod)
code_object.params = param
blankline
when 'category' then
if RDoc::Context === code_object then
section = code_object.add_section param
code_object.temporary_section = section
elsif RDoc::AnyMethod === code_object then
code_object.section_title = param
end
blankline # ignore category if we're not on an RDoc::Context
when 'doc' then
return blankline unless code_object
code_object.document_self = true
code_object.force_documentation = true
blankline
when 'enddoc' then
return blankline unless code_object
code_object.done_documenting = true
blankline
when 'include' then
filename = param.split(' ', 2).first
include_file filename, prefix, encoding
when 'main' then
@options.main_page = param if @options.respond_to? :main_page
blankline
when 'nodoc' then
return blankline unless code_object
code_object.document_self = nil # notify nodoc
code_object.document_children = param !~ /all/i
blankline
when 'notnew', 'not_new', 'not-new' then
return blankline unless RDoc::AnyMethod === code_object
code_object.dont_rename_initialize = true
blankline
when 'startdoc' then
return blankline unless code_object
code_object.start_doc
code_object.force_documentation = true
blankline
when 'stopdoc' then
return blankline unless code_object
code_object.stop_doc
blankline
when 'title' then
@options.default_title = param if @options.respond_to? :default_title=
blankline
when 'yield', 'yields' then
return blankline unless code_object
# remove parameter &block
code_object.params = code_object.params.sub(/,?\s*&\w+/, '') if code_object.params
code_object.block_params = param
blankline
else
result = yield directive, param if block_given?
case result
when nil then
code_object.metadata[directive] = param if code_object
if RDoc::Markup::PreProcess.registered.include? directive then
handler = RDoc::Markup::PreProcess.registered[directive]
result = handler.call directive, param if handler
else
result = "#{prefix}:#{directive}: #{param}\n"
end
when false then
result = "#{prefix}:#{directive}: #{param}\n"
end
result
end
end
##
# Handles the <tt>:include: _filename_</tt> directive.
#
# If the first line of the included file starts with '#', and contains
# an encoding information in the form 'coding:' or 'coding=', it is
# removed.
#
# If all lines in the included file start with a '#', this leading '#'
# is removed before inclusion. The included content is indented like
# the <tt>:include:</tt> directive.
#--
# so all content will be verbatim because of the likely space after '#'?
# TODO shift left the whole file content in that case
# TODO comment stop/start #-- and #++ in included file must be processed here
def include_file name, indent, encoding
full_name = find_include_file name
unless full_name then
warn "Couldn't find file to include '#{name}' from #{@input_file_name}"
return ''
end
content = RDoc::Encoding.read_file full_name, encoding, true
content = RDoc::Encoding.remove_magic_comment content
# strip magic comment
content = content.sub(/\A# .*coding[=:].*$/, '').lstrip
# strip leading '#'s, but only if all lines start with them
if content =~ /^[^#]/ then
content.gsub(/^/, indent)
else
content.gsub(/^#?/, indent)
end
end
##
# Look for the given file in the directory containing the current file,
# and then in each of the directories specified in the RDOC_INCLUDE path
def find_include_file(name)
to_search = [File.dirname(@input_file_name)].concat @include_path
to_search.each do |dir|
full_name = File.join(dir, name)
stat = File.stat(full_name) rescue next
return full_name if stat.readable?
end
nil
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/parser.rb 0000644 00000034766 15173517747 0016150 0 ustar 00 # frozen_string_literal: true
require 'strscan'
##
# A recursive-descent parser for RDoc markup.
#
# The parser tokenizes an input string then parses the tokens into a Document.
# Documents can be converted into output formats by writing a visitor like
# RDoc::Markup::ToHTML.
#
# The parser only handles the block-level constructs Paragraph, List,
# ListItem, Heading, Verbatim, BlankLine, Rule and BlockQuote.
# Inline markup such as <tt>\+blah\+</tt> is handled separately by
# RDoc::Markup::AttributeManager.
#
# To see what markup the Parser implements read RDoc. To see how to use
# RDoc markup to format text in your program read RDoc::Markup.
class RDoc::Markup::Parser
include RDoc::Text
##
# List token types
LIST_TOKENS = [
:BULLET,
:LABEL,
:LALPHA,
:NOTE,
:NUMBER,
:UALPHA,
]
##
# Parser error subclass
class Error < RuntimeError; end
##
# Raised when the parser is unable to handle the given markup
class ParseError < Error; end
##
# Enables display of debugging information
attr_accessor :debug
##
# Token accessor
attr_reader :tokens
##
# Parses +str+ into a Document.
#
# Use RDoc::Markup#parse instead of this method.
def self.parse str
parser = new
parser.tokenize str
doc = RDoc::Markup::Document.new
parser.parse doc
end
##
# Returns a token stream for +str+, for testing
def self.tokenize str
parser = new
parser.tokenize str
parser.tokens
end
##
# Creates a new Parser. See also ::parse
def initialize
@binary_input = nil
@current_token = nil
@debug = false
@s = nil
@tokens = []
end
##
# Builds a Heading of +level+
def build_heading level
type, text, = get
text = case type
when :TEXT then
skip :NEWLINE
text
else
unget
''
end
RDoc::Markup::Heading.new level, text
end
##
# Builds a List flush to +margin+
def build_list margin
p :list_start => margin if @debug
list = RDoc::Markup::List.new
label = nil
until @tokens.empty? do
type, data, column, = get
case type
when *LIST_TOKENS then
if column < margin || (list.type && list.type != type) then
unget
break
end
list.type = type
peek_type, _, column, = peek_token
case type
when :NOTE, :LABEL then
label = [] unless label
if peek_type == :NEWLINE then
# description not on the same line as LABEL/NOTE
# skip the trailing newline & any blank lines below
while peek_type == :NEWLINE
get
peek_type, _, column, = peek_token
end
# we may be:
# - at end of stream
# - at a column < margin:
# [text]
# blah blah blah
# - at the same column, but with a different type of list item
# [text]
# * blah blah
# - at the same column, with the same type of list item
# [one]
# [two]
# In all cases, we have an empty description.
# In the last case only, we continue.
if peek_type.nil? || column < margin then
empty = true
elsif column == margin then
case peek_type
when type
empty = :continue
when *LIST_TOKENS
empty = true
else
empty = false
end
else
empty = false
end
if empty then
label << data
next if empty == :continue
break
end
end
else
data = nil
end
if label then
data = label << data
label = nil
end
list_item = RDoc::Markup::ListItem.new data
parse list_item, column
list << list_item
else
unget
break
end
end
p :list_end => margin if @debug
if list.empty? then
return nil unless label
return nil unless [:LABEL, :NOTE].include? list.type
list_item = RDoc::Markup::ListItem.new label, RDoc::Markup::BlankLine.new
list << list_item
end
list
end
##
# Builds a Paragraph that is flush to +margin+
def build_paragraph margin
p :paragraph_start => margin if @debug
paragraph = RDoc::Markup::Paragraph.new
until @tokens.empty? do
type, data, column, = get
if type == :TEXT and column == margin then
paragraph << data
break if peek_token.first == :BREAK
data << ' ' if skip :NEWLINE and /#{SPACE_SEPARATED_LETTER_CLASS}\z/o.match?(data)
else
unget
break
end
end
paragraph.parts.last.sub!(/ \z/, '') # cleanup
p :paragraph_end => margin if @debug
paragraph
end
##
# Builds a Verbatim that is indented from +margin+.
#
# The verbatim block is shifted left (the least indented lines start in
# column 0). Each part of the verbatim is one line of text, always
# terminated by a newline. Blank lines always consist of a single newline
# character, and there is never a single newline at the end of the verbatim.
def build_verbatim margin
p :verbatim_begin => margin if @debug
verbatim = RDoc::Markup::Verbatim.new
min_indent = nil
generate_leading_spaces = true
line = ''.dup
until @tokens.empty? do
type, data, column, = get
if type == :NEWLINE then
line << data
verbatim << line
line = ''.dup
generate_leading_spaces = true
next
end
if column <= margin
unget
break
end
if generate_leading_spaces then
indent = column - margin
line << ' ' * indent
min_indent = indent if min_indent.nil? || indent < min_indent
generate_leading_spaces = false
end
case type
when :HEADER then
line << '=' * data
_, _, peek_column, = peek_token
peek_column ||= column + data
indent = peek_column - column - data
line << ' ' * indent
when :RULE then
width = 2 + data
line << '-' * width
_, _, peek_column, = peek_token
peek_column ||= column + width
indent = peek_column - column - width
line << ' ' * indent
when :BREAK, :TEXT then
line << data
when :BLOCKQUOTE then
line << '>>>'
peek_type, _, peek_column = peek_token
if peek_type != :NEWLINE and peek_column
line << ' ' * (peek_column - column - 3)
end
else # *LIST_TOKENS
list_marker = case type
when :BULLET then data
when :LABEL then "[#{data}]"
when :NOTE then "#{data}::"
else # :LALPHA, :NUMBER, :UALPHA
"#{data}."
end
line << list_marker
peek_type, _, peek_column = peek_token
unless peek_type == :NEWLINE then
peek_column ||= column + list_marker.length
indent = peek_column - column - list_marker.length
line << ' ' * indent
end
end
end
verbatim << line << "\n" unless line.empty?
verbatim.parts.each { |p| p.slice!(0, min_indent) unless p == "\n" } if min_indent > 0
verbatim.normalize
p :verbatim_end => margin if @debug
verbatim
end
##
# Pulls the next token from the stream.
def get
@current_token = @tokens.shift
p :get => @current_token if @debug
@current_token
end
##
# Parses the tokens into an array of RDoc::Markup::XXX objects,
# and appends them to the passed +parent+ RDoc::Markup::YYY object.
#
# Exits at the end of the token stream, or when it encounters a token
# in a column less than +indent+ (unless it is a NEWLINE).
#
# Returns +parent+.
def parse parent, indent = 0
p :parse_start => indent if @debug
until @tokens.empty? do
type, data, column, = get
case type
when :BREAK then
parent << RDoc::Markup::BlankLine.new
skip :NEWLINE, false
next
when :NEWLINE then
# trailing newlines are skipped below, so this is a blank line
parent << RDoc::Markup::BlankLine.new
skip :NEWLINE, false
next
end
# indentation change: break or verbatim
if column < indent then
unget
break
elsif column > indent then
unget
parent << build_verbatim(indent)
next
end
# indentation is the same
case type
when :HEADER then
parent << build_heading(data)
when :RULE then
parent << RDoc::Markup::Rule.new(data)
skip :NEWLINE
when :TEXT then
unget
parse_text parent, indent
when :BLOCKQUOTE then
nil while (type, = get; type) and type != :NEWLINE
_, _, column, = peek_token
bq = RDoc::Markup::BlockQuote.new
p :blockquote_start => [data, column] if @debug
parse bq, column
p :blockquote_end => indent if @debug
parent << bq
when *LIST_TOKENS then
unget
parent << build_list(indent)
else
type, data, column, line = @current_token
raise ParseError, "Unhandled token #{type} (#{data.inspect}) at #{line}:#{column}"
end
end
p :parse_end => indent if @debug
parent
end
##
# Small hook that is overridden by RDoc::TomDoc
def parse_text parent, indent # :nodoc:
parent << build_paragraph(indent)
end
##
# Returns the next token on the stream without modifying the stream
def peek_token
token = @tokens.first || []
p :peek => token if @debug
token
end
##
# A simple wrapper of StringScanner that is aware of the current column and lineno
class MyStringScanner
# :stopdoc:
def initialize(input)
@line = @column = 0
@s = StringScanner.new input
end
def scan(re)
ret = @s.scan(re)
@column += ret.length if ret
ret
end
def unscan(s)
@s.pos -= s.bytesize
@column -= s.length
end
def pos
[@column, @line]
end
def newline!
@column = 0
@line += 1
end
def eos?
@s.eos?
end
def matched
@s.matched
end
def [](i)
@s[i]
end
#:startdoc:
end
##
# Creates the StringScanner
def setup_scanner input
@s = MyStringScanner.new input
end
##
# Skips the next token if its type is +token_type+.
#
# Optionally raises an error if the next token is not of the expected type.
def skip token_type, error = true
type, = get
return unless type # end of stream
return @current_token if token_type == type
unget
raise ParseError, "expected #{token_type} got #{@current_token.inspect}" if error
end
##
# Turns text +input+ into a stream of tokens
def tokenize input
setup_scanner input
until @s.eos? do
pos = @s.pos
# leading spaces will be reflected by the column of the next token
# the only thing we loose are trailing spaces at the end of the file
next if @s.scan(/ +/)
# note: after BULLET, LABEL, etc.,
# indent will be the column of the next non-newline token
@tokens << case
# [CR]LF => :NEWLINE
when @s.scan(/\r?\n/) then
token = [:NEWLINE, @s.matched, *pos]
@s.newline!
token
# === text => :HEADER then :TEXT
when @s.scan(/(=+)(\s*)/) then
level = @s[1].length
header = [:HEADER, level, *pos]
if @s[2] =~ /^\r?\n/ then
@s.unscan(@s[2])
header
else
pos = @s.pos
@s.scan(/.*/)
@tokens << header
[:TEXT, @s.matched.sub(/\r$/, ''), *pos]
end
# --- (at least 3) and nothing else on the line => :RULE
when @s.scan(/(-{3,}) *\r?$/) then
[:RULE, @s[1].length - 2, *pos]
# * or - followed by white space and text => :BULLET
when @s.scan(/([*-]) +(\S)/) then
@s.unscan(@s[2])
[:BULLET, @s[1], *pos]
# A. text, a. text, 12. text => :UALPHA, :LALPHA, :NUMBER
when @s.scan(/([a-z]|\d+)\. +(\S)/i) then
# FIXME if tab(s), the column will be wrong
# either support tabs everywhere by first expanding them to
# spaces, or assume that they will have been replaced
# before (and provide a check for that at least in debug
# mode)
list_label = @s[1]
@s.unscan(@s[2])
list_type =
case list_label
when /[a-z]/ then :LALPHA
when /[A-Z]/ then :UALPHA
when /\d/ then :NUMBER
else
raise ParseError, "BUG token #{list_label}"
end
[list_type, list_label, *pos]
# [text] followed by spaces or end of line => :LABEL
when @s.scan(/\[(.*?)\]( +|\r?$)/) then
[:LABEL, @s[1], *pos]
# text:: followed by spaces or end of line => :NOTE
when @s.scan(/(.*?)::( +|\r?$)/) then
[:NOTE, @s[1], *pos]
# >>> followed by end of line => :BLOCKQUOTE
when @s.scan(/>>> *(\w+)?$/) then
if word = @s[1]
@s.unscan(word)
end
[:BLOCKQUOTE, word, *pos]
# anything else: :TEXT
else
@s.scan(/(.*?)( )?\r?$/)
token = [:TEXT, @s[1], *pos]
if @s[2] then
@tokens << token
[:BREAK, @s[2], pos[0] + @s[1].length, pos[1]]
else
token
end
end
end
self
end
##
# Returns the current token to the token stream
def unget
token = @current_token
p :unget => token if @debug
raise Error, 'too many #ungets' if token == @tokens.first
@tokens.unshift token if token
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_label.rb 0000644 00000003532 15173517747 0016420 0 ustar 00 # frozen_string_literal: true
require 'cgi/util'
##
# Creates HTML-safe labels suitable for use in id attributes. Tidylinks are
# converted to their link part and cross-reference links have the suppression
# marks removed (\\SomeClass is converted to SomeClass).
class RDoc::Markup::ToLabel < RDoc::Markup::Formatter
attr_reader :res # :nodoc:
##
# Creates a new formatter that will output HTML-safe labels
def initialize markup = nil
super nil, markup
@markup.add_regexp_handling RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
@markup.add_regexp_handling(/(((\{.*?\})|\b\S+?)\[\S+?\])/, :TIDYLINK)
add_tag :BOLD, '', ''
add_tag :TT, '', ''
add_tag :EM, '', ''
@res = []
end
##
# Converts +text+ to an HTML-safe label
def convert text
label = convert_flow @am.flow text
CGI.escape(label).gsub('%', '-').sub(/^-/, '')
end
##
# Converts the CROSSREF +target+ to plain text, removing the suppression
# marker, if any
def handle_regexp_CROSSREF target
text = target.text
text.sub(/^\\/, '')
end
##
# Converts the TIDYLINK +target+ to just the text part
def handle_regexp_TIDYLINK target
text = target.text
return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
$1
end
alias accept_blank_line ignore
alias accept_block_quote ignore
alias accept_heading ignore
alias accept_list_end ignore
alias accept_list_item_end ignore
alias accept_list_item_start ignore
alias accept_list_start ignore
alias accept_paragraph ignore
alias accept_raw ignore
alias accept_rule ignore
alias accept_verbatim ignore
alias end_accepting ignore
alias handle_regexp_HARD_BREAK ignore
alias start_accepting ignore
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_html_crossref.rb 0000644 00000011606 15173517747 0020214 0 ustar 00 # frozen_string_literal: true
##
# Subclass of the RDoc::Markup::ToHtml class that supports looking up method
# names, classes, etc to create links. RDoc::CrossReference is used to
# generate those links based on the current context.
class RDoc::Markup::ToHtmlCrossref < RDoc::Markup::ToHtml
# :stopdoc:
ALL_CROSSREF_REGEXP = RDoc::CrossReference::ALL_CROSSREF_REGEXP
CLASS_REGEXP_STR = RDoc::CrossReference::CLASS_REGEXP_STR
CROSSREF_REGEXP = RDoc::CrossReference::CROSSREF_REGEXP
METHOD_REGEXP_STR = RDoc::CrossReference::METHOD_REGEXP_STR
# :startdoc:
##
# RDoc::CodeObject for generating references
attr_accessor :context
##
# Should we show '#' characters on method references?
attr_accessor :show_hash
##
# Creates a new crossref resolver that generates links relative to +context+
# which lives at +from_path+ in the generated files. '#' characters on
# references are removed unless +show_hash+ is true. Only method names
# preceded by '#' or '::' are linked, unless +hyperlink_all+ is true.
def initialize(options, from_path, context, markup = nil)
raise ArgumentError, 'from_path cannot be nil' if from_path.nil?
super options, markup
@context = context
@from_path = from_path
@hyperlink_all = @options.hyperlink_all
@show_hash = @options.show_hash
@cross_reference = RDoc::CrossReference.new @context
end
# :nodoc:
def init_link_notation_regexp_handlings
add_regexp_handling_RDOCLINK
# The crossref must be linked before tidylink because Klass.method[:sym]
# will be processed as a tidylink first and will be broken.
crossref_re = @options.hyperlink_all ? ALL_CROSSREF_REGEXP : CROSSREF_REGEXP
@markup.add_regexp_handling crossref_re, :CROSSREF
add_regexp_handling_TIDYLINK
end
##
# Creates a link to the reference +name+ if the name exists. If +text+ is
# given it is used as the link text, otherwise +name+ is used.
def cross_reference name, text = nil, code = true
lookup = name
name = name[1..-1] unless @show_hash if name[0, 1] == '#'
if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
text ||= "#{CGI.unescape $'} at <code>#{$1}</code>"
code = false
else
text ||= name
end
link lookup, text, code
end
##
# We're invoked when any text matches the CROSSREF pattern. If we find the
# corresponding reference, generate a link. If the name we're looking for
# contains no punctuation, we look for it up the module/class chain. For
# example, ToHtml is found, even without the <tt>RDoc::Markup::</tt> prefix,
# because we look for it in module Markup first.
def handle_regexp_CROSSREF(target)
name = target.text
return name if name =~ /@[\w-]+\.[\w-]/ # labels that look like emails
unless @hyperlink_all then
# This ensures that words entirely consisting of lowercase letters will
# not have cross-references generated (to suppress lots of erroneous
# cross-references to "new" in text, for instance)
return name if name =~ /\A[a-z]*\z/
end
cross_reference name
end
##
# Handles <tt>rdoc-ref:</tt> scheme links and allows RDoc::Markup::ToHtml to
# handle other schemes.
def handle_regexp_HYPERLINK target
return cross_reference $' if target.text =~ /\Ardoc-ref:/
super
end
##
# +target+ is an rdoc-schemed link that will be converted into a hyperlink.
# For the rdoc-ref scheme the cross-reference will be looked up and the
# given name will be used.
#
# All other contents are handled by
# {the superclass}[rdoc-ref:RDoc::Markup::ToHtml#handle_regexp_RDOCLINK]
def handle_regexp_RDOCLINK target
url = target.text
case url
when /\Ardoc-ref:/ then
cross_reference $'
else
super
end
end
##
# Generates links for <tt>rdoc-ref:</tt> scheme URLs and allows
# RDoc::Markup::ToHtml to handle other schemes.
def gen_url url, text
return super unless url =~ /\Ardoc-ref:/
name = $'
cross_reference name, text, name == text
end
##
# Creates an HTML link to +name+ with the given +text+.
def link name, text, code = true
if !(name.end_with?('+@', '-@')) and name =~ /(.*[^#:])@/
name = $1
label = $'
end
ref = @cross_reference.resolve name, text
case ref
when String then
ref
else
path = ref.as_href @from_path
if code and RDoc::CodeObject === ref and !(RDoc::TopLevel === ref)
text = "<code>#{CGI.escapeHTML text}</code>"
end
if path =~ /#/ then
path << "-label-#{label}"
elsif ref.sections and
ref.sections.any? { |section| label == section.title } then
path << "##{label}"
else
if ref.respond_to?(:aref)
path << "##{ref.aref}-label-#{label}"
else
path << "#label-#{label}"
end
end if label
"<a href=\"#{path}\">#{text}</a>"
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/formatter.rb 0000644 00000012717 15173517747 0016647 0 ustar 00 # frozen_string_literal: true
##
# Base class for RDoc markup formatters
#
# Formatters are a visitor that converts an RDoc::Markup tree (from a comment)
# into some kind of output. RDoc ships with formatters for converting back to
# rdoc, ANSI text, HTML, a Table of Contents and other formats.
#
# If you'd like to write your own Formatter use
# RDoc::Markup::FormatterTestCase. If you're writing a text-output formatter
# use RDoc::Markup::TextFormatterTestCase which provides extra test cases.
class RDoc::Markup::Formatter
##
# Tag for inline markup containing a +bit+ for the bitmask and the +on+ and
# +off+ triggers.
InlineTag = Struct.new(:bit, :on, :off)
##
# Converts a target url to one that is relative to a given path
def self.gen_relative_url path, target
from = File.dirname path
to, to_file = File.split target
from = from.split "/"
to = to.split "/"
from.delete '.'
to.delete '.'
while from.size > 0 and to.size > 0 and from[0] == to[0] do
from.shift
to.shift
end
from.fill ".."
from.concat to
from << to_file
File.join(*from)
end
##
# Creates a new Formatter
def initialize options, markup = nil
@options = options
@markup = markup || RDoc::Markup.new
@am = @markup.attribute_manager
@am.add_regexp_handling(/<br>/, :HARD_BREAK)
@attributes = @am.attributes
@attr_tags = []
@in_tt = 0
@tt_bit = @attributes.bitmap_for :TT
@hard_break = ''
@from_path = '.'
end
##
# Adds +document+ to the output
def accept_document document
document.parts.each do |item|
case item
when RDoc::Markup::Document then # HACK
accept_document item
else
item.accept self
end
end
end
##
# Adds a regexp handling for links of the form rdoc-...:
def add_regexp_handling_RDOCLINK
@markup.add_regexp_handling(/rdoc-[a-z]+:[^\s\]]+/, :RDOCLINK)
end
##
# Adds a regexp handling for links of the form {<text>}[<url>] and
# <word>[<url>]
def add_regexp_handling_TIDYLINK
@markup.add_regexp_handling(/(?:
\{[^{}]*\} | # multi-word label
\b[^\s{}]+? # single-word label
)
\[\S+?\] # link target
/x, :TIDYLINK)
end
##
# Add a new set of tags for an attribute. We allow separate start and end
# tags for flexibility
def add_tag(name, start, stop)
attr = @attributes.bitmap_for name
@attr_tags << InlineTag.new(attr, start, stop)
end
##
# Allows +tag+ to be decorated with additional information.
def annotate(tag)
tag
end
##
# Marks up +content+
def convert content
@markup.convert content, self
end
##
# Converts flow items +flow+
def convert_flow(flow)
res = []
flow.each do |item|
case item
when String then
res << convert_string(item)
when RDoc::Markup::AttrChanger then
off_tags res, item
on_tags res, item
when RDoc::Markup::RegexpHandling then
res << convert_regexp_handling(item)
else
raise "Unknown flow element: #{item.inspect}"
end
end
res.join
end
##
# Converts added regexp handlings. See RDoc::Markup#add_regexp_handling
def convert_regexp_handling target
return target.text if in_tt?
handled = false
@attributes.each_name_of target.type do |name|
method_name = "handle_regexp_#{name}"
if respond_to? method_name then
target.text = public_send method_name, target
handled = true
end
end
unless handled then
target_name = @attributes.as_string target.type
raise RDoc::Error, "Unhandled regexp handling #{target_name}: #{target}"
end
target.text
end
##
# Converts a string to be fancier if desired
def convert_string string
string
end
##
# Use ignore in your subclass to ignore the content of a node.
#
# ##
# # We don't support raw nodes in ToNoRaw
#
# alias accept_raw ignore
def ignore *node
end
##
# Are we currently inside tt tags?
def in_tt?
@in_tt > 0
end
##
# Turns on tags for +item+ on +res+
def on_tags res, item
attr_mask = item.turn_on
return if attr_mask.zero?
@attr_tags.each do |tag|
if attr_mask & tag.bit != 0 then
res << annotate(tag.on)
@in_tt += 1 if tt? tag
end
end
end
##
# Turns off tags for +item+ on +res+
def off_tags res, item
attr_mask = item.turn_off
return if attr_mask.zero?
@attr_tags.reverse_each do |tag|
if attr_mask & tag.bit != 0 then
@in_tt -= 1 if tt? tag
res << annotate(tag.off)
end
end
end
##
# Extracts and a scheme, url and an anchor id from +url+ and returns them.
def parse_url url
case url
when /^rdoc-label:([^:]*)(?::(.*))?/ then
scheme = 'link'
path = "##{$1}"
id = " id=\"#{$2}\"" if $2
when /([A-Za-z]+):(.*)/ then
scheme = $1.downcase
path = $2
when /^#/ then
else
scheme = 'http'
path = url
url = url
end
if scheme == 'link' then
url = if path[0, 1] == '#' then # is this meaningful?
path
else
self.class.gen_relative_url @from_path, path
end
end
[scheme, url, id]
end
##
# Is +tag+ a tt tag?
def tt? tag
tag.bit == @tt_bit
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/include.rb 0000644 00000001474 15173517747 0016265 0 ustar 00 # frozen_string_literal: true
##
# A file included at generation time. Objects of this class are created by
# RDoc::RD for an extension-less include.
#
# This implementation in incomplete.
class RDoc::Markup::Include
##
# The filename to be included, without extension
attr_reader :file
##
# Directories to search for #file
attr_reader :include_path
##
# Creates a new include that will import +file+ from +include_path+
def initialize file, include_path
@file = file
@include_path = include_path
end
def == other # :nodoc:
self.class === other and
@file == other.file and @include_path == other.include_path
end
def pretty_print q # :nodoc:
q.group 2, '[incl ', ']' do
q.text file
q.breakable
q.text 'from '
q.pp include_path
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_markdown.rb 0000644 00000007153 15173517747 0017166 0 ustar 00 # frozen_string_literal: true
# :markup: markdown
##
# Outputs parsed markup as Markdown
class RDoc::Markup::ToMarkdown < RDoc::Markup::ToRdoc
##
# Creates a new formatter that will output Markdown format text
def initialize markup = nil
super
@headings[1] = ['# ', '']
@headings[2] = ['## ', '']
@headings[3] = ['### ', '']
@headings[4] = ['#### ', '']
@headings[5] = ['##### ', '']
@headings[6] = ['###### ', '']
add_regexp_handling_RDOCLINK
add_regexp_handling_TIDYLINK
@hard_break = " \n"
end
##
# Maps attributes to HTML sequences
def init_tags
add_tag :BOLD, '**', '**'
add_tag :EM, '*', '*'
add_tag :TT, '`', '`'
end
##
# Adds a newline to the output
def handle_regexp_HARD_BREAK target
" \n"
end
##
# Finishes consumption of `list`
def accept_list_end list
@res << "\n"
super
end
##
# Finishes consumption of `list_item`
def accept_list_item_end list_item
width = case @list_type.last
when :BULLET then
4
when :NOTE, :LABEL then
use_prefix
4
else
@list_index[-1] = @list_index.last.succ
4
end
@indent -= width
end
##
# Prepares the visitor for consuming `list_item`
def accept_list_item_start list_item
type = @list_type.last
case type
when :NOTE, :LABEL then
bullets = Array(list_item.label).map do |label|
attributes(label).strip
end.join "\n"
bullets << "\n:"
@prefix = ' ' * @indent
@indent += 4
@prefix << bullets + (' ' * (@indent - 1))
else
bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.'
@prefix = (' ' * @indent) + bullet.ljust(4)
@indent += 4
end
end
##
# Prepares the visitor for consuming `list`
def accept_list_start list
case list.type
when :BULLET, :LABEL, :NOTE then
@list_index << nil
when :LALPHA, :NUMBER, :UALPHA then
@list_index << 1
else
raise RDoc::Error, "invalid list type #{list.type}"
end
@list_width << 4
@list_type << list.type
end
##
# Adds `rule` to the output
def accept_rule rule
use_prefix or @res << ' ' * @indent
@res << '-' * 3
@res << "\n"
end
##
# Outputs `verbatim` indented 4 columns
def accept_verbatim verbatim
indent = ' ' * (@indent + 4)
verbatim.parts.each do |part|
@res << indent unless part == "\n"
@res << part
end
@res << "\n"
end
##
# Creates a Markdown-style URL from +url+ with +text+.
def gen_url url, text
scheme, url, = parse_url url
"[#{text.sub(%r{^#{scheme}:/*}i, '')}](#{url})"
end
##
# Handles <tt>rdoc-</tt> type links for footnotes.
def handle_rdoc_link url
case url
when /^rdoc-ref:/ then
$'
when /^rdoc-label:footmark-(\d+)/ then
"[^#{$1}]:"
when /^rdoc-label:foottext-(\d+)/ then
"[^#{$1}]"
when /^rdoc-label:label-/ then
gen_url url, $'
when /^rdoc-image:/ then
""
when /^rdoc-[a-z]+:/ then
$'
end
end
##
# Converts the RDoc markup tidylink into a Markdown.style link.
def handle_regexp_TIDYLINK target
text = target.text
return text unless text =~ /\{(.*?)\}\[(.*?)\]/ or text =~ /(\S+)\[(.*?)\]/
label = $1
url = $2
if url =~ /^rdoc-label:foot/ then
handle_rdoc_link url
else
gen_url url, label
end
end
##
# Converts the rdoc-...: links into a Markdown.style links.
def handle_regexp_RDOCLINK target
handle_rdoc_link target.text
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/rule.rb 0000644 00000000472 15173517747 0015606 0 ustar 00 # frozen_string_literal: true
##
# A horizontal rule with a weight
class RDoc::Markup::Rule < Struct.new :weight
##
# Calls #accept_rule on +visitor+
def accept visitor
visitor.accept_rule self
end
def pretty_print q # :nodoc:
q.group 2, '[rule:', ']' do
q.pp weight
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/list_item.rb 0000644 00000003331 15173517747 0016625 0 ustar 00 # frozen_string_literal: true
##
# An item within a List that contains paragraphs, headings, etc.
#
# For BULLET, NUMBER, LALPHA and UALPHA lists, the label will always be nil.
# For NOTE and LABEL lists, the list label may contain:
#
# * a single String for a single label
# * an Array of Strings for a list item with multiple terms
# * nil for an extra description attached to a previously labeled list item
class RDoc::Markup::ListItem
##
# The label for the ListItem
attr_accessor :label
##
# Parts of the ListItem
attr_reader :parts
##
# Creates a new ListItem with an optional +label+ containing +parts+
def initialize label = nil, *parts
@label = label
@parts = []
@parts.concat parts
end
##
# Appends +part+ to the ListItem
def << part
@parts << part
end
def == other # :nodoc:
self.class == other.class and
@label == other.label and
@parts == other.parts
end
##
# Runs this list item and all its #parts through +visitor+
def accept visitor
visitor.accept_list_item_start self
@parts.each do |part|
part.accept visitor
end
visitor.accept_list_item_end self
end
##
# Is the ListItem empty?
def empty?
@parts.empty?
end
##
# Length of parts in the ListItem
def length
@parts.length
end
def pretty_print q # :nodoc:
q.group 2, '[item: ', ']' do
case @label
when Array then
q.pp @label
q.text ';'
q.breakable
when String then
q.pp @label
q.text ';'
q.breakable
end
q.seplist @parts do |part|
q.pp part
end
end
end
##
# Adds +parts+ to the ListItem
def push *parts
@parts.concat parts
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/attribute_manager.rb 0000644 00000024053 15173517747 0020335 0 ustar 00 # frozen_string_literal: true
##
# Manages changes of attributes in a block of text
class RDoc::Markup::AttributeManager
unless ::MatchData.method_defined?(:match_length)
using ::Module.new {
refine(::MatchData) {
def match_length(nth) # :nodoc:
b, e = offset(nth)
e - b if b
end
}
}
end
##
# The NUL character
NULL = "\000".freeze
#--
# We work by substituting non-printing characters in to the text. For now
# I'm assuming that I can substitute a character in the range 0..8 for a 7
# bit character without damaging the encoded string, but this might be
# optimistic
#++
A_PROTECT = 004 # :nodoc:
##
# Special mask character to prevent inline markup handling
PROTECT_ATTR = A_PROTECT.chr # :nodoc:
##
# The attributes enabled for this markup object.
attr_reader :attributes
##
# This maps delimiters that occur around words (such as *bold* or +tt+)
# where the start and end delimiters and the same. This lets us optimize
# the regexp
attr_reader :matching_word_pairs
##
# And this is used when the delimiters aren't the same. In this case the
# hash maps a pattern to the attribute character
attr_reader :word_pair_map
##
# This maps HTML tags to the corresponding attribute char
attr_reader :html_tags
##
# A \ in front of a character that would normally be processed turns off
# processing. We do this by turning \< into <#{PROTECT}
attr_reader :protectable
##
# And this maps _regexp handling_ sequences to a name. A regexp handling
# sequence is something like a WikiWord
attr_reader :regexp_handlings
##
# A bits of exclusive maps
attr_reader :exclusive_bitmap
##
# Creates a new attribute manager that understands bold, emphasized and
# teletype text.
def initialize
@html_tags = {}
@matching_word_pairs = {}
@protectable = %w[<]
@regexp_handlings = []
@word_pair_map = {}
@exclusive_bitmap = 0
@attributes = RDoc::Markup::Attributes.new
add_word_pair "*", "*", :BOLD, true
add_word_pair "_", "_", :EM, true
add_word_pair "+", "+", :TT, true
add_html "em", :EM, true
add_html "i", :EM, true
add_html "b", :BOLD, true
add_html "tt", :TT, true
add_html "code", :TT, true
end
##
# Return an attribute object with the given turn_on and turn_off bits set
def attribute(turn_on, turn_off)
RDoc::Markup::AttrChanger.new turn_on, turn_off
end
##
# Changes the current attribute from +current+ to +new+
def change_attribute current, new
diff = current ^ new
attribute(new & diff, current & diff)
end
##
# Used by the tests to change attributes by name from +current_set+ to
# +new_set+
def changed_attribute_by_name current_set, new_set
current = new = 0
current_set.each do |name|
current |= @attributes.bitmap_for(name)
end
new_set.each do |name|
new |= @attributes.bitmap_for(name)
end
change_attribute(current, new)
end
##
# Copies +start_pos+ to +end_pos+ from the current string
def copy_string(start_pos, end_pos)
res = @str[start_pos...end_pos]
res.gsub!(/\000/, '')
res
end
# :nodoc:
def exclusive?(attr)
(attr & @exclusive_bitmap) != 0
end
NON_PRINTING_START = "\1" # :nodoc:
NON_PRINTING_END = "\2" # :nodoc:
##
# Map attributes like <b>text</b>to the sequence
# \001\002<char>\001\003<char>, where <char> is a per-attribute specific
# character
def convert_attrs(str, attrs, exclusive = false)
convert_attrs_matching_word_pairs(str, attrs, exclusive)
convert_attrs_word_pair_map(str, attrs, exclusive)
end
# :nodoc:
def convert_attrs_matching_word_pairs(str, attrs, exclusive)
# first do matching ones
tags = @matching_word_pairs.select { |start, bitmap|
exclusive == exclusive?(bitmap)
}.keys
return if tags.empty?
tags = "[#{tags.join("")}](?!#{PROTECT_ATTR})"
all_tags = "[#{@matching_word_pairs.keys.join("")}](?!#{PROTECT_ATTR})"
re = /(?:^|\W|#{all_tags})\K(#{tags})(\1*[#\\]?[\w:#{PROTECT_ATTR}.\/\[\]-]+?\S?)\1(?!\1)(?=#{all_tags}|\W|$)/
1 while str.gsub!(re) { |orig|
a, w = (m = $~).values_at(1, 2)
attr = @matching_word_pairs[a]
if attrs.set_attrs(m.begin(2), w.length, attr)
a = NULL * a.length
else
a = NON_PRINTING_START + a + NON_PRINTING_END
end
a + w + a
}
str.delete!(NON_PRINTING_START + NON_PRINTING_END)
end
# :nodoc:
def convert_attrs_word_pair_map(str, attrs, exclusive)
# then non-matching
unless @word_pair_map.empty? then
@word_pair_map.each do |regexp, attr|
next unless exclusive == exclusive?(attr)
1 while str.gsub!(regexp) { |orig|
w = (m = ($~))[2]
updated = attrs.set_attrs(m.begin(2), w.length, attr)
if updated
NULL * m.match_length(1) + w + NULL * m.match_length(3)
else
orig
end
}
end
end
end
##
# Converts HTML tags to RDoc attributes
def convert_html(str, attrs, exclusive = false)
tags = @html_tags.select { |start, bitmap|
exclusive == exclusive?(bitmap)
}.keys.join '|'
1 while str.gsub!(/<(#{tags})>(.*?)<\/\1>/i) { |orig|
attr = @html_tags[$1.downcase]
html_length = $~.match_length(1) + 2 # "<>".length
seq = NULL * html_length
attrs.set_attrs($~.begin(2), $~.match_length(2), attr)
seq + $2 + seq + NULL
}
end
##
# Converts regexp handling sequences to RDoc attributes
def convert_regexp_handlings str, attrs, exclusive = false
@regexp_handlings.each do |regexp, attribute|
next unless exclusive == exclusive?(attribute)
str.scan(regexp) do
capture = $~.size == 1 ? 0 : 1
s, e = $~.offset capture
attrs.set_attrs s, e - s, attribute | @attributes.regexp_handling
end
end
end
##
# Escapes regexp handling sequences of text to prevent conversion to RDoc
def mask_protected_sequences
# protect __send__, __FILE__, etc.
@str.gsub!(/__([a-z]+)__/i,
"_#{PROTECT_ATTR}_#{PROTECT_ATTR}\\1_#{PROTECT_ATTR}_#{PROTECT_ATTR}")
@str.gsub!(/(\A|[^\\])\\([#{Regexp.escape @protectable.join}])/m,
"\\1\\2#{PROTECT_ATTR}")
@str.gsub!(/\\(\\[#{Regexp.escape @protectable.join}])/m, "\\1")
end
##
# Unescapes regexp handling sequences of text
def unmask_protected_sequences
@str.gsub!(/(.)#{PROTECT_ATTR}/, "\\1\000")
end
##
# Adds a markup class with +name+ for words wrapped in the +start+ and
# +stop+ character. To make words wrapped with "*" bold:
#
# am.add_word_pair '*', '*', :BOLD
def add_word_pair(start, stop, name, exclusive = false)
raise ArgumentError, "Word flags may not start with '<'" if
start[0,1] == '<'
bitmap = @attributes.bitmap_for name
if start == stop then
@matching_word_pairs[start] = bitmap
else
pattern = /(#{Regexp.escape start})(\S+)(#{Regexp.escape stop})/
@word_pair_map[pattern] = bitmap
end
@protectable << start[0,1]
@protectable.uniq!
@exclusive_bitmap |= bitmap if exclusive
end
##
# Adds a markup class with +name+ for words surrounded by HTML tag +tag+.
# To process emphasis tags:
#
# am.add_html 'em', :EM
def add_html(tag, name, exclusive = false)
bitmap = @attributes.bitmap_for name
@html_tags[tag.downcase] = bitmap
@exclusive_bitmap |= bitmap if exclusive
end
##
# Adds a regexp handling for +pattern+ with +name+. A simple URL handler
# would be:
#
# @am.add_regexp_handling(/((https?:)\S+\w)/, :HYPERLINK)
def add_regexp_handling pattern, name, exclusive = false
bitmap = @attributes.bitmap_for(name)
@regexp_handlings << [pattern, bitmap]
@exclusive_bitmap |= bitmap if exclusive
end
##
# Processes +str+ converting attributes, HTML and regexp handlings
def flow str
@str = str.dup
mask_protected_sequences
@attrs = RDoc::Markup::AttrSpan.new @str.length, @exclusive_bitmap
convert_attrs @str, @attrs, true
convert_html @str, @attrs, true
convert_regexp_handlings @str, @attrs, true
convert_attrs @str, @attrs
convert_html @str, @attrs
convert_regexp_handlings @str, @attrs
unmask_protected_sequences
split_into_flow
end
##
# Debug method that prints a string along with its attributes
def display_attributes
puts
puts @str.tr(NULL, "!")
bit = 1
16.times do |bno|
line = ""
@str.length.times do |i|
if (@attrs[i] & bit) == 0
line << " "
else
if bno.zero?
line << "S"
else
line << ("%d" % (bno+1))
end
end
end
puts(line) unless line =~ /^ *$/
bit <<= 1
end
end
##
# Splits the string into chunks by attribute change
def split_into_flow
res = []
current_attr = 0
str_len = @str.length
# skip leading invisible text
i = 0
i += 1 while i < str_len and @str[i].chr == "\0"
start_pos = i
# then scan the string, chunking it on attribute changes
while i < str_len
new_attr = @attrs[i]
if new_attr != current_attr
if i > start_pos
res << copy_string(start_pos, i)
start_pos = i
end
res << change_attribute(current_attr, new_attr)
current_attr = new_attr
if (current_attr & @attributes.regexp_handling) != 0 then
i += 1 while
i < str_len and (@attrs[i] & @attributes.regexp_handling) != 0
res << RDoc::Markup::RegexpHandling.new(current_attr,
copy_string(start_pos, i))
start_pos = i
next
end
end
# move on, skipping any invisible characters
begin
i += 1
end while i < str_len and @str[i].chr == "\0"
end
# tidy up trailing text
if start_pos < str_len
res << copy_string(start_pos, str_len)
end
# and reset to all attributes off
res << change_attribute(current_attr, 0) if current_attr != 0
res
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/paragraph.rb 0000644 00000000754 15173517747 0016607 0 ustar 00 # frozen_string_literal: true
##
# A Paragraph of text
class RDoc::Markup::Paragraph < RDoc::Markup::Raw
##
# Calls #accept_paragraph on +visitor+
def accept visitor
visitor.accept_paragraph self
end
##
# Joins the raw paragraph text and converts inline HardBreaks to the
# +hard_break+ text.
def text hard_break = ''
@parts.map do |part|
if RDoc::Markup::HardBreak === part then
hard_break
else
part
end
end.join
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/list.rb 0000644 00000003504 15173517747 0015611 0 ustar 00 # frozen_string_literal: true
##
# A List is a homogeneous set of ListItems.
#
# The supported list types include:
#
# :BULLET::
# An unordered list
# :LABEL::
# An unordered definition list, but using an alternate RDoc::Markup syntax
# :LALPHA::
# An ordered list using increasing lowercase English letters
# :NOTE::
# An unordered definition list
# :NUMBER::
# An ordered list using increasing Arabic numerals
# :UALPHA::
# An ordered list using increasing uppercase English letters
#
# Definition lists behave like HTML definition lists. Each list item can
# describe multiple terms. See RDoc::Markup::ListItem for how labels and
# definition are stored as list items.
class RDoc::Markup::List
##
# The list's type
attr_accessor :type
##
# Items in the list
attr_reader :items
##
# Creates a new list of +type+ with +items+. Valid list types are:
# +:BULLET+, +:LABEL+, +:LALPHA+, +:NOTE+, +:NUMBER+, +:UALPHA+
def initialize type = nil, *items
@type = type
@items = []
@items.concat items
end
##
# Appends +item+ to the list
def << item
@items << item
end
def == other # :nodoc:
self.class == other.class and
@type == other.type and
@items == other.items
end
##
# Runs this list and all its #items through +visitor+
def accept visitor
visitor.accept_list_start self
@items.each do |item|
item.accept visitor
end
visitor.accept_list_end self
end
##
# Is the list empty?
def empty?
@items.empty?
end
##
# Returns the last item in the list
def last
@items.last
end
def pretty_print q # :nodoc:
q.group 2, "[list: #{@type} ", ']' do
q.seplist @items do |item|
q.pp item
end
end
end
##
# Appends +items+ to the list
def push *items
@items.concat items
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_html.rb 0000644 00000024131 15173517747 0016303 0 ustar 00 # frozen_string_literal: true
require 'cgi/util'
##
# Outputs RDoc markup as HTML.
class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
include RDoc::Text
# :section: Utilities
##
# Maps RDoc::Markup::Parser::LIST_TOKENS types to HTML tags
LIST_TYPE_TO_HTML = {
:BULLET => ['<ul>', '</ul>'],
:LABEL => ['<dl class="rdoc-list label-list">', '</dl>'],
:LALPHA => ['<ol style="list-style-type: lower-alpha">', '</ol>'],
:NOTE => ['<dl class="rdoc-list note-list">', '</dl>'],
:NUMBER => ['<ol>', '</ol>'],
:UALPHA => ['<ol style="list-style-type: upper-alpha">', '</ol>'],
}
attr_reader :res # :nodoc:
attr_reader :in_list_entry # :nodoc:
attr_reader :list # :nodoc:
##
# The RDoc::CodeObject HTML is being generated for. This is used to
# generate namespaced URI fragments
attr_accessor :code_object
##
# Path to this document for relative links
attr_accessor :from_path
# :section:
##
# Creates a new formatter that will output HTML
def initialize options, markup = nil
super
@code_object = nil
@from_path = ''
@in_list_entry = nil
@list = nil
@th = nil
@hard_break = "<br>\n"
init_regexp_handlings
init_tags
end
# :section: Regexp Handling
#
# These methods are used by regexp handling markup added by RDoc::Markup#add_regexp_handling.
# :nodoc:
URL_CHARACTERS_REGEXP_STR = /[A-Za-z0-9\-._~:\/\?#\[\]@!$&'\(\)*+,;%=]/.source
##
# Adds regexp handlings.
def init_regexp_handlings
# external links
@markup.add_regexp_handling(/(?:link:|https?:|mailto:|ftp:|irc:|www\.)#{URL_CHARACTERS_REGEXP_STR}+\w/,
:HYPERLINK)
init_link_notation_regexp_handlings
end
##
# Adds regexp handlings about link notations.
def init_link_notation_regexp_handlings
add_regexp_handling_RDOCLINK
add_regexp_handling_TIDYLINK
end
def handle_RDOCLINK url # :nodoc:
case url
when /^rdoc-ref:/
CGI.escapeHTML($')
when /^rdoc-label:/
text = $'
text = case text
when /\Alabel-/ then $'
when /\Afootmark-/ then $'
when /\Afoottext-/ then $'
else text
end
gen_url CGI.escapeHTML(url), CGI.escapeHTML(text)
when /^rdoc-image:/
%[<img src=\"#{CGI.escapeHTML($')}\">]
when /\Ardoc-[a-z]+:/
CGI.escapeHTML($')
end
end
##
# +target+ is a <code><br></code>
def handle_regexp_HARD_BREAK target
'<br>'
end
##
# +target+ is a potential link. The following schemes are handled:
#
# <tt>mailto:</tt>::
# Inserted as-is.
# <tt>http:</tt>::
# Links are checked to see if they reference an image. If so, that image
# gets inserted using an <tt><img></tt> tag. Otherwise a conventional
# <tt><a href></tt> is used.
# <tt>link:</tt>::
# Reference to a local file relative to the output directory.
def handle_regexp_HYPERLINK(target)
url = CGI.escapeHTML(target.text)
gen_url url, url
end
##
# +target+ is an rdoc-schemed link that will be converted into a hyperlink.
#
# For the +rdoc-ref+ scheme the named reference will be returned without
# creating a link.
#
# For the +rdoc-label+ scheme the footnote and label prefixes are stripped
# when creating a link. All other contents will be linked verbatim.
def handle_regexp_RDOCLINK target
handle_RDOCLINK target.text
end
##
# This +target+ is a link where the label is different from the URL
# <tt>label[url]</tt> or <tt>{long label}[url]</tt>
def handle_regexp_TIDYLINK(target)
text = target.text
return text unless
text =~ /^\{(.*)\}\[(.*?)\]$/ or text =~ /^(\S+)\[(.*?)\]$/
label = $1
url = CGI.escapeHTML($2)
if /^rdoc-image:/ =~ label
label = handle_RDOCLINK(label)
else
label = CGI.escapeHTML(label)
end
gen_url url, label
end
# :section: Visitor
#
# These methods implement the HTML visitor.
##
# Prepares the visitor for HTML generation
def start_accepting
@res = []
@in_list_entry = []
@list = []
end
##
# Returns the generated output
def end_accepting
@res.join
end
##
# Adds +block_quote+ to the output
def accept_block_quote block_quote
@res << "\n<blockquote>"
block_quote.parts.each do |part|
part.accept self
end
@res << "</blockquote>\n"
end
##
# Adds +paragraph+ to the output
def accept_paragraph paragraph
@res << "\n<p>"
text = paragraph.text @hard_break
text = text.gsub(/(#{SPACE_SEPARATED_LETTER_CLASS})?\K\r?\n(?=(?(1)(#{SPACE_SEPARATED_LETTER_CLASS})?))/o) {
defined?($2) && ' '
}
@res << to_html(text)
@res << "</p>\n"
end
##
# Adds +verbatim+ to the output
def accept_verbatim verbatim
text = verbatim.text.rstrip
klass = nil
content = if verbatim.ruby? or parseable? text then
begin
tokens = RDoc::Parser::RipperStateLex.parse text
klass = ' class="ruby"'
result = RDoc::TokenStream.to_html tokens
result = result + "\n" unless "\n" == result[-1]
result
rescue
CGI.escapeHTML text
end
else
CGI.escapeHTML text
end
if @options.pipe then
@res << "\n<pre><code>#{CGI.escapeHTML text}\n</code></pre>\n"
else
@res << "\n<pre#{klass}>#{content}</pre>\n"
end
end
##
# Adds +rule+ to the output
def accept_rule rule
@res << "<hr>\n"
end
##
# Prepares the visitor for consuming +list+
def accept_list_start(list)
@list << list.type
@res << html_list_name(list.type, true)
@in_list_entry.push false
end
##
# Finishes consumption of +list+
def accept_list_end(list)
@list.pop
if tag = @in_list_entry.pop
@res << tag
end
@res << html_list_name(list.type, false) << "\n"
end
##
# Prepares the visitor for consuming +list_item+
def accept_list_item_start(list_item)
if tag = @in_list_entry.last
@res << tag
end
@res << list_item_start(list_item, @list.last)
end
##
# Finishes consumption of +list_item+
def accept_list_item_end(list_item)
@in_list_entry[-1] = list_end_for(@list.last)
end
##
# Adds +blank_line+ to the output
def accept_blank_line(blank_line)
# @res << annotate("<p />") << "\n"
end
##
# Adds +heading+ to the output. The headings greater than 6 are trimmed to
# level 6.
def accept_heading heading
level = [6, heading.level].min
label = heading.label @code_object
@res << if @options.output_decoration
"\n<h#{level} id=\"#{label}\">"
else
"\n<h#{level}>"
end
@res << to_html(heading.text)
unless @options.pipe then
@res << "<span><a href=\"##{label}\">¶</a>"
@res << " <a href=\"#top\">↑</a></span>"
end
@res << "</h#{level}>\n"
end
##
# Adds +raw+ to the output
def accept_raw raw
@res << raw.parts.join("\n")
end
##
# Adds +table+ to the output
def accept_table header, body, aligns
@res << "\n<table role=\"table\">\n<thead>\n<tr>\n"
header.zip(aligns) do |text, align|
@res << '<th'
@res << ' align="' << align << '"' if align
@res << '>' << to_html(text) << "</th>\n"
end
@res << "</tr>\n</thead>\n<tbody>\n"
body.each do |row|
@res << "<tr>\n"
row.zip(aligns) do |text, align|
@res << '<td'
@res << ' align="' << align << '"' if align
@res << '>' << to_html(text) << "</td>\n"
end
@res << "</tr>\n"
end
@res << "</tbody>\n</table>\n"
end
# :section: Utilities
##
# CGI-escapes +text+
def convert_string(text)
CGI.escapeHTML text
end
##
# Generate a link to +url+ with content +text+. Handles the special cases
# for img: and link: described under handle_regexp_HYPERLINK
def gen_url url, text
scheme, url, id = parse_url url
if %w[http https link].include?(scheme) and
url =~ /\.(gif|png|jpg|jpeg|bmp)$/ then
"<img src=\"#{url}\" />"
else
if scheme != 'link' and %r%\A((?!https?:)(?:[^/#]*/)*+)([^/#]+)\.(rb|rdoc|md)(?=\z|#)%i =~ url
url = "#$1#{$2.tr('.', '_')}_#$3.html#$'"
end
text = text.sub %r%^#{scheme}:/*%i, ''
text = text.sub %r%^[*\^](\d+)$%, '\1'
link = "<a#{id} href=\"#{url}\">#{text}</a>"
link = "<sup>#{link}</sup>" if /"foot/ =~ id
link
end
end
##
# Determines the HTML list element for +list_type+ and +open_tag+
def html_list_name(list_type, open_tag)
tags = LIST_TYPE_TO_HTML[list_type]
raise RDoc::Error, "Invalid list type: #{list_type.inspect}" unless tags
tags[open_tag ? 0 : 1]
end
##
# Maps attributes to HTML tags
def init_tags
add_tag :BOLD, "<strong>", "</strong>"
add_tag :TT, "<code>", "</code>"
add_tag :EM, "<em>", "</em>"
end
##
# Returns the HTML tag for +list_type+, possible using a label from
# +list_item+
def list_item_start(list_item, list_type)
case list_type
when :BULLET, :LALPHA, :NUMBER, :UALPHA then
"<li>"
when :LABEL, :NOTE then
Array(list_item.label).map do |label|
"<dt>#{to_html label}\n"
end.join << "<dd>"
else
raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
end
end
##
# Returns the HTML end-tag for +list_type+
def list_end_for(list_type)
case list_type
when :BULLET, :LALPHA, :NUMBER, :UALPHA then
"</li>"
when :LABEL, :NOTE then
"</dd>"
else
raise RDoc::Error, "Invalid list type: #{list_type.inspect}"
end
end
##
# Returns true if text is valid ruby syntax
def parseable? text
verbose, $VERBOSE = $VERBOSE, nil
catch(:valid) do
eval("BEGIN { throw :valid, true }\n#{text}")
end
rescue SyntaxError
false
ensure
$VERBOSE = verbose
end
##
# Converts +item+ to HTML using RDoc::Text#to_html
def to_html item
super convert_flow @am.flow item
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/attr_span.rb 0000644 00000001237 15173517747 0016632 0 ustar 00 # frozen_string_literal: true
##
# An array of attributes which parallels the characters in a string.
class RDoc::Markup::AttrSpan
##
# Creates a new AttrSpan for +length+ characters
def initialize(length, exclusive)
@attrs = Array.new(length, 0)
@exclusive = exclusive
end
##
# Toggles +bits+ from +start+ to +length+
def set_attrs(start, length, bits)
updated = false
for i in start ... (start+length)
if (@exclusive & @attrs[i]) == 0 || (@exclusive & bits) != 0
@attrs[i] |= bits
updated = true
end
end
updated
end
##
# Accesses flags for character +n+
def [](n)
@attrs[n]
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/document.rb 0000644 00000006227 15173517747 0016461 0 ustar 00 # frozen_string_literal: true
##
# A Document containing lists, headings, paragraphs, etc.
class RDoc::Markup::Document
include Enumerable
##
# The file this document was created from. See also
# RDoc::ClassModule#add_comment
attr_reader :file
##
# If a heading is below the given level it will be omitted from the
# table_of_contents
attr_accessor :omit_headings_below
##
# The parts of the Document
attr_reader :parts
##
# Creates a new Document with +parts+
def initialize *parts
@parts = []
@parts.concat parts
@file = nil
@omit_headings_from_table_of_contents_below = nil
end
##
# Appends +part+ to the document
def << part
case part
when RDoc::Markup::Document then
unless part.empty? then
parts.concat part.parts
parts << RDoc::Markup::BlankLine.new
end
when String then
raise ArgumentError,
"expected RDoc::Markup::Document and friends, got String" unless
part.empty?
else
parts << part
end
end
def == other # :nodoc:
self.class == other.class and
@file == other.file and
@parts == other.parts
end
##
# Runs this document and all its #items through +visitor+
def accept visitor
visitor.start_accepting
visitor.accept_document self
visitor.end_accepting
end
##
# Concatenates the given +parts+ onto the document
def concat parts
self.parts.concat parts
end
##
# Enumerator for the parts of this document
def each &block
@parts.each(&block)
end
##
# Does this document have no parts?
def empty?
@parts.empty? or (@parts.length == 1 and merged? and @parts.first.empty?)
end
##
# The file this Document was created from.
def file= location
@file = case location
when RDoc::TopLevel then
location.relative_name
else
location
end
end
##
# When this is a collection of documents (#file is not set and this document
# contains only other documents as its direct children) #merge replaces
# documents in this class with documents from +other+ when the file matches
# and adds documents from +other+ when the files do not.
#
# The information in +other+ is preferred over the receiver
def merge other
if empty? then
@parts = other.parts
return self
end
other.parts.each do |other_part|
self.parts.delete_if do |self_part|
self_part.file and self_part.file == other_part.file
end
self.parts << other_part
end
self
end
##
# Does this Document contain other Documents?
def merged?
RDoc::Markup::Document === @parts.first
end
def pretty_print q # :nodoc:
start = @file ? "[doc (#{@file}): " : '[doc: '
q.group 2, start, ']' do
q.seplist @parts do |part|
q.pp part
end
end
end
##
# Appends +parts+ to the document
def push *parts
self.parts.concat parts
end
##
# Returns an Array of headings in the document.
#
# Require 'rdoc/markup/formatter' before calling this method.
def table_of_contents
accept RDoc::Markup::ToTableOfContents.to_toc
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/heading.rb 0000644 00000002757 15173517747 0016246 0 ustar 00 # frozen_string_literal: true
##
# A heading with a level (1-6) and text
RDoc::Markup::Heading =
Struct.new :level, :text do
@to_html = nil
@to_label = nil
##
# A singleton RDoc::Markup::ToLabel formatter for headings.
def self.to_label
@to_label ||= RDoc::Markup::ToLabel.new
end
##
# A singleton plain HTML formatter for headings. Used for creating labels
# for the Table of Contents
def self.to_html
return @to_html if @to_html
markup = RDoc::Markup.new
markup.add_regexp_handling RDoc::CrossReference::CROSSREF_REGEXP, :CROSSREF
@to_html = RDoc::Markup::ToHtml.new nil
def @to_html.handle_regexp_CROSSREF target
target.text.sub(/^\\/, '')
end
@to_html
end
##
# Calls #accept_heading on +visitor+
def accept visitor
visitor.accept_heading self
end
##
# An HTML-safe anchor reference for this header.
def aref
"label-#{self.class.to_label.convert text.dup}"
end
##
# Creates a fully-qualified label which will include the label from
# +context+. This helps keep ids unique in HTML.
def label context = nil
label = aref
label = [context.aref, label].compact.join '-' if
context and context.respond_to? :aref
label
end
##
# HTML markup of the text of this label without the surrounding header
# element.
def plain_html
self.class.to_html.to_html(text.dup)
end
def pretty_print q # :nodoc:
q.group 2, "[head: #{level} ", ']' do
q.pp text
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/verbatim.rb 0000644 00000002442 15173517747 0016447 0 ustar 00 # frozen_string_literal: true
##
# A section of verbatim text
class RDoc::Markup::Verbatim < RDoc::Markup::Raw
##
# Format of this verbatim section
attr_accessor :format
def initialize *parts # :nodoc:
super
@format = nil
end
def == other # :nodoc:
super and @format == other.format
end
##
# Calls #accept_verbatim on +visitor+
def accept visitor
visitor.accept_verbatim self
end
##
# Collapses 3+ newlines into two newlines
def normalize
parts = []
newlines = 0
@parts.each do |part|
case part
when /^\s*\n/ then
newlines += 1
parts << part if newlines == 1
else
newlines = 0
parts << part
end
end
parts.pop if parts.last =~ /\A\r?\n\z/
@parts = parts
end
def pretty_print q # :nodoc:
self.class.name =~ /.*::(\w{1,4})/i
q.group 2, "[#{$1.downcase}: ", ']' do
if @format then
q.text "format: #{@format}"
q.breakable
end
q.seplist @parts do |part|
q.pp part
end
end
end
##
# Is this verbatim section Ruby code?
def ruby?
@format ||= nil # TODO for older ri data, switch the tree to marshal_dump
@format == :ruby
end
##
# The text of the section
def text
@parts.join
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/blank_line.rb 0000644 00000000606 15173517747 0016734 0 ustar 00 # frozen_string_literal: true
##
# An empty line. This class is a singleton.
class RDoc::Markup::BlankLine
@instance = new
##
# RDoc::Markup::BlankLine is a singleton
def self.new
@instance
end
##
# Calls #accept_blank_line on +visitor+
def accept visitor
visitor.accept_blank_line self
end
def pretty_print q # :nodoc:
q.text 'blankline'
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_test.rb 0000644 00000002215 15173517747 0016315 0 ustar 00 # frozen_string_literal: true
##
# This Markup outputter is used for testing purposes.
class RDoc::Markup::ToTest < RDoc::Markup::Formatter
# :stopdoc:
##
# :section: Visitor
def start_accepting
@res = []
@list = []
end
def end_accepting
@res
end
def accept_paragraph(paragraph)
@res << convert_flow(@am.flow(paragraph.text))
end
def accept_raw raw
@res << raw.parts.join
end
def accept_verbatim(verbatim)
@res << verbatim.text.gsub(/^(\S)/, ' \1')
end
def accept_list_start(list)
@list << case list.type
when :BULLET then
'*'
when :NUMBER then
'1'
else
list.type
end
end
def accept_list_end(list)
@list.pop
end
def accept_list_item_start(list_item)
@res << "#{' ' * (@list.size - 1)}#{@list.last}: "
end
def accept_list_item_end(list_item)
end
def accept_blank_line(blank_line)
@res << "\n"
end
def accept_heading(heading)
@res << "#{'=' * heading.level} #{heading.text}"
end
def accept_rule(rule)
@res << '-' * rule.weight
end
# :startdoc:
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/indented_paragraph.rb 0000644 00000001611 15173517747 0020452 0 ustar 00 # frozen_string_literal: true
##
# An Indented Paragraph of text
class RDoc::Markup::IndentedParagraph < RDoc::Markup::Raw
##
# The indent in number of spaces
attr_reader :indent
##
# Creates a new IndentedParagraph containing +parts+ indented with +indent+
# spaces
def initialize indent, *parts
@indent = indent
super(*parts)
end
def == other # :nodoc:
super and indent == other.indent
end
##
# Calls #accept_indented_paragraph on +visitor+
def accept visitor
visitor.accept_indented_paragraph self
end
##
# Joins the raw paragraph text and converts inline HardBreaks to the
# +hard_break+ text followed by the indent.
def text hard_break = nil
@parts.map do |part|
if RDoc::Markup::HardBreak === part then
'%1$s%3$*2$s' % [hard_break, @indent, ' '] if hard_break
else
part
end
end.join
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/regexp_handling.rb 0000644 00000001315 15173517747 0017772 0 ustar 00 # frozen_string_literal: true
##
# Hold details of a regexp handling sequence
class RDoc::Markup::RegexpHandling
##
# Regexp handling type
attr_reader :type
##
# Regexp handling text
attr_accessor :text
##
# Creates a new regexp handling sequence of +type+ with +text+
def initialize(type, text)
@type, @text = type, text
end
##
# Regexp handlings are equal when the have the same text and type
def ==(o)
self.text == o.text && self.type == o.type
end
def inspect # :nodoc:
"#<RDoc::Markup::RegexpHandling:0x%x @type=%p, @text=%p>" % [
object_id, @type, text.dump]
end
def to_s # :nodoc:
"RegexpHandling: type=#{type} text=#{text.dump}"
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup/to_rdoc.rb 0000644 00000015032 15173517747 0016266 0 ustar 00 # frozen_string_literal: true
##
# Outputs RDoc markup as RDoc markup! (mostly)
class RDoc::Markup::ToRdoc < RDoc::Markup::Formatter
##
# Current indent amount for output in characters
attr_accessor :indent
##
# Output width in characters
attr_accessor :width
##
# Stack of current list indexes for alphabetic and numeric lists
attr_reader :list_index
##
# Stack of list types
attr_reader :list_type
##
# Stack of list widths for indentation
attr_reader :list_width
##
# Prefix for the next list item. See #use_prefix
attr_reader :prefix
##
# Output accumulator
attr_reader :res
##
# Creates a new formatter that will output (mostly) \RDoc markup
def initialize markup = nil
super nil, markup
@markup.add_regexp_handling(/\\\S/, :SUPPRESSED_CROSSREF)
@width = 78
init_tags
@headings = {}
@headings.default = []
@headings[1] = ['= ', '']
@headings[2] = ['== ', '']
@headings[3] = ['=== ', '']
@headings[4] = ['==== ', '']
@headings[5] = ['===== ', '']
@headings[6] = ['====== ', '']
@hard_break = "\n"
end
##
# Maps attributes to HTML sequences
def init_tags
add_tag :BOLD, "<b>", "</b>"
add_tag :TT, "<tt>", "</tt>"
add_tag :EM, "<em>", "</em>"
end
##
# Adds +blank_line+ to the output
def accept_blank_line blank_line
@res << "\n"
end
##
# Adds +paragraph+ to the output
def accept_block_quote block_quote
@indent += 2
block_quote.parts.each do |part|
@prefix = '> '
part.accept self
end
@indent -= 2
end
##
# Adds +heading+ to the output
def accept_heading heading
use_prefix or @res << ' ' * @indent
@res << @headings[heading.level][0]
@res << attributes(heading.text)
@res << @headings[heading.level][1]
@res << "\n"
end
##
# Finishes consumption of +list+
def accept_list_end list
@list_index.pop
@list_type.pop
@list_width.pop
end
##
# Finishes consumption of +list_item+
def accept_list_item_end list_item
width = case @list_type.last
when :BULLET then
2
when :NOTE, :LABEL then
if @prefix then
@res << @prefix.strip
@prefix = nil
end
@res << "\n"
2
else
bullet = @list_index.last.to_s
@list_index[-1] = @list_index.last.succ
bullet.length + 2
end
@indent -= width
end
##
# Prepares the visitor for consuming +list_item+
def accept_list_item_start list_item
type = @list_type.last
case type
when :NOTE, :LABEL then
bullets = Array(list_item.label).map do |label|
attributes(label).strip
end.join "\n"
bullets << ":\n" unless bullets.empty?
@prefix = ' ' * @indent
@indent += 2
@prefix << bullets + (' ' * @indent)
else
bullet = type == :BULLET ? '*' : @list_index.last.to_s + '.'
@prefix = (' ' * @indent) + bullet.ljust(bullet.length + 1)
width = bullet.length + 1
@indent += width
end
end
##
# Prepares the visitor for consuming +list+
def accept_list_start list
case list.type
when :BULLET then
@list_index << nil
@list_width << 1
when :LABEL, :NOTE then
@list_index << nil
@list_width << 2
when :LALPHA then
@list_index << 'a'
@list_width << list.items.length.to_s.length
when :NUMBER then
@list_index << 1
@list_width << list.items.length.to_s.length
when :UALPHA then
@list_index << 'A'
@list_width << list.items.length.to_s.length
else
raise RDoc::Error, "invalid list type #{list.type}"
end
@list_type << list.type
end
##
# Adds +paragraph+ to the output
def accept_paragraph paragraph
text = paragraph.text @hard_break
wrap attributes text
end
##
# Adds +paragraph+ to the output
def accept_indented_paragraph paragraph
@indent += paragraph.indent
text = paragraph.text @hard_break
wrap attributes text
@indent -= paragraph.indent
end
##
# Adds +raw+ to the output
def accept_raw raw
@res << raw.parts.join("\n")
end
##
# Adds +rule+ to the output
def accept_rule rule
use_prefix or @res << ' ' * @indent
@res << '-' * (@width - @indent)
@res << "\n"
end
##
# Outputs +verbatim+ indented 2 columns
def accept_verbatim verbatim
indent = ' ' * (@indent + 2)
verbatim.parts.each do |part|
@res << indent unless part == "\n"
@res << part
end
@res << "\n"
end
##
# Adds +table+ to the output
def accept_table header, body, aligns
widths = header.zip(body) do |h, b|
[h.size, b.size].max
end
aligns = aligns.map do |a|
case a
when nil
:center
when :left
:ljust
when :right
:rjust
end
end
@res << header.zip(widths, aligns) do |h, w, a|
h.__send__(a, w)
end.join("|").rstrip << "\n"
@res << widths.map {|w| "-" * w }.join("|") << "\n"
body.each do |row|
@res << row.zip(widths, aligns) do |t, w, a|
t.__send__(a, w)
end.join("|").rstrip << "\n"
end
end
##
# Applies attribute-specific markup to +text+ using RDoc::AttributeManager
def attributes text
flow = @am.flow text.dup
convert_flow flow
end
##
# Returns the generated output
def end_accepting
@res.join
end
##
# Removes preceding \\ from the suppressed crossref +target+
def handle_regexp_SUPPRESSED_CROSSREF target
text = target.text
text = text.sub('\\', '') unless in_tt?
text
end
##
# Adds a newline to the output
def handle_regexp_HARD_BREAK target
"\n"
end
##
# Prepares the visitor for text generation
def start_accepting
@res = [""]
@indent = 0
@prefix = nil
@list_index = []
@list_type = []
@list_width = []
end
##
# Adds the stored #prefix to the output and clears it. Lists generate a
# prefix for later consumption.
def use_prefix
prefix, @prefix = @prefix, nil
@res << prefix if prefix
prefix
end
##
# Wraps +text+ to #width
def wrap text
return unless text && !text.empty?
text_len = @width - @indent
text_len = 20 if text_len < 20
next_prefix = ' ' * @indent
prefix = @prefix || next_prefix
@prefix = nil
text.scan(/\G(?:([^ \n]{#{text_len}})(?=[^ \n])|(.{1,#{text_len}})(?:[ \n]|\z))/) do
@res << prefix << ($1 || $2) << "\n"
prefix = next_prefix
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/servlet.rb 0000644 00000030365 15173517747 0015030 0 ustar 00 # frozen_string_literal: true
require_relative '../rdoc'
require 'erb'
require 'time'
require 'json'
begin
require 'webrick'
rescue LoadError
abort "webrick is not found. You may need to `gem install webrick` to install webrick."
end
##
# This is a WEBrick servlet that allows you to browse ri documentation.
#
# You can show documentation through either `ri --server` or, with RubyGems
# 2.0 or newer, `gem server`. For ri, the server runs on port 8214 by
# default. For RubyGems the server runs on port 8808 by default.
#
# You can use this servlet in your own project by mounting it on a WEBrick
# server:
#
# require 'webrick'
#
# server = WEBrick::HTTPServer.new Port: 8000
#
# server.mount '/', RDoc::Servlet
#
# If you want to mount the servlet some other place than the root, provide the
# base path when mounting:
#
# server.mount '/rdoc', RDoc::Servlet, '/rdoc'
class RDoc::Servlet < WEBrick::HTTPServlet::AbstractServlet
@server_stores = Hash.new { |hash, server| hash[server] = {} }
@cache = Hash.new { |hash, store| hash[store] = {} }
##
# Maps an asset type to its path on the filesystem
attr_reader :asset_dirs
##
# An RDoc::Options instance used for rendering options
attr_reader :options
##
# Creates an instance of this servlet that shares cached data between
# requests.
def self.get_instance server, *options # :nodoc:
stores = @server_stores[server]
new server, stores, @cache, *options
end
##
# Creates a new WEBrick servlet.
#
# Use +mount_path+ when mounting the servlet somewhere other than /.
#
# Use +extra_doc_dirs+ for additional documentation directories.
#
# +server+ is provided automatically by WEBrick when mounting. +stores+ and
# +cache+ are provided automatically by the servlet.
def initialize server, stores, cache, mount_path = nil, extra_doc_dirs = []
super server
@cache = cache
@mount_path = mount_path
@extra_doc_dirs = extra_doc_dirs
@stores = stores
@options = RDoc::Options.new
@options.op_dir = '.'
darkfish_dir = nil
# HACK dup
$LOAD_PATH.each do |path|
darkfish_dir = File.join path, 'rdoc/generator/template/darkfish/'
next unless File.directory? darkfish_dir
@options.template_dir = darkfish_dir
break
end
@asset_dirs = {
:darkfish => darkfish_dir,
:json_index =>
File.expand_path('../generator/template/json_index/', __FILE__),
}
end
##
# Serves the asset at the path in +req+ for +generator_name+ via +res+.
def asset generator_name, req, res
asset_dir = @asset_dirs[generator_name]
asset_path = File.join asset_dir, req.path
if_modified_since req, res, asset_path
res.body = File.read asset_path
res.content_type = case req.path
when /\.css\z/ then 'text/css'
when /\.js\z/ then 'application/javascript'
else 'application/octet-stream'
end
end
##
# GET request entry point. Fills in +res+ for the path, etc. in +req+.
def do_GET req, res
req.path.sub!(/\A#{Regexp.escape @mount_path}/, '') if @mount_path
case req.path
when '/' then
root req, res
when '/js/darkfish.js', '/js/jquery.js', '/js/search.js',
%r%^/css/%, %r%^/images/%, %r%^/fonts/% then
asset :darkfish, req, res
when '/js/navigation.js', '/js/searcher.js' then
asset :json_index, req, res
when '/js/search_index.js' then
root_search req, res
else
show_documentation req, res
end
rescue WEBrick::HTTPStatus::NotFound => e
generator = generator_for RDoc::Store.new
not_found generator, req, res, e.message
rescue WEBrick::HTTPStatus::Status
raise
rescue => e
error e, req, res
end
##
# Fills in +res+ with the class, module or page for +req+ from +store+.
#
# +path+ is relative to the mount_path and is used to determine the class,
# module or page name (/RDoc/Servlet.html becomes RDoc::Servlet).
# +generator+ is used to create the page.
def documentation_page store, generator, path, req, res
text_name = path.chomp '.html'
name = text_name.gsub '/', '::'
if klass = store.find_class_or_module(name) then
res.body = generator.generate_class klass
elsif page = store.find_text_page(name.sub(/_([^_]*)\z/, '.\1')) then
res.body = generator.generate_page page
elsif page = store.find_text_page(text_name.sub(/_([^_]*)\z/, '.\1')) then
res.body = generator.generate_page page
else
not_found generator, req, res
end
end
##
# Creates the JSON search index on +res+ for the given +store+. +generator+
# must respond to \#json_index to build. +req+ is ignored.
def documentation_search store, generator, req, res
json_index = @cache[store].fetch :json_index do
@cache[store][:json_index] =
JSON.dump generator.json_index.build_index
end
res.content_type = 'application/javascript'
res.body = "var search_data = #{json_index}"
end
##
# Returns the RDoc::Store and path relative to +mount_path+ for
# documentation at +path+.
def documentation_source path
_, source_name, path = path.split '/', 3
store = @stores[source_name]
return store, path if store
store = store_for source_name
store.load_all
@stores[source_name] = store
return store, path
end
##
# Generates an error page for the +exception+ while handling +req+ on +res+.
def error exception, req, res
backtrace = exception.backtrace.join "\n"
res.content_type = 'text/html'
res.status = 500
res.body = <<-BODY
<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
<title>Error - #{ERB::Util.html_escape exception.class}</title>
<link type="text/css" media="screen" href="#{@mount_path}/css/rdoc.css" rel="stylesheet">
</head>
<body>
<h1>Error</h1>
<p>While processing <code>#{ERB::Util.html_escape req.request_uri}</code> the
RDoc (#{ERB::Util.html_escape RDoc::VERSION}) server has encountered a
<code>#{ERB::Util.html_escape exception.class}</code>
exception:
<pre>#{ERB::Util.html_escape exception.message}</pre>
<p>Please report this to the
<a href="https://github.com/ruby/rdoc/issues">RDoc issues tracker</a>. Please
include the RDoc version, the URI above and exception class, message and
backtrace. If you're viewing a gem's documentation, include the gem name and
version. If you're viewing Ruby's documentation, include the version of ruby.
<p>Backtrace:
<pre>#{ERB::Util.html_escape backtrace}</pre>
</body>
</html>
BODY
end
##
# Instantiates a Darkfish generator for +store+
def generator_for store
generator = RDoc::Generator::Darkfish.new store, @options
generator.file_output = false
generator.asset_rel_path = '..'
rdoc = RDoc::RDoc.new
rdoc.store = store
rdoc.generator = generator
rdoc.options = @options
@options.main_page = store.main
@options.title = store.title
generator
end
##
# Handles the If-Modified-Since HTTP header on +req+ for +path+. If the
# file has not been modified a Not Modified response is returned. If the
# file has been modified a Last-Modified header is added to +res+.
def if_modified_since req, res, path = nil
last_modified = File.stat(path).mtime if path
res['last-modified'] = last_modified.httpdate
return unless ims = req['if-modified-since']
ims = Time.parse ims
unless ims < last_modified then
res.body = ''
raise WEBrick::HTTPStatus::NotModified
end
end
##
# Returns an Array of installed documentation.
#
# Each entry contains the documentation name (gem name, 'Ruby
# Documentation', etc.), the path relative to the mount point, whether the
# documentation exists, the type of documentation (See RDoc::RI::Paths#each)
# and the filesystem to the RDoc::Store for the documentation.
def installed_docs
extra_counter = 0
ri_paths.map do |path, type|
store = RDoc::Store.new path, type
exists = File.exist? store.cache_path
case type
when :gem then
gem_path = path[%r%/([^/]*)/ri$%, 1]
[gem_path, "#{gem_path}/", exists, type, path]
when :system then
['Ruby Documentation', 'ruby/', exists, type, path]
when :site then
['Site Documentation', 'site/', exists, type, path]
when :home then
['Home Documentation', 'home/', exists, type, path]
when :extra then
extra_counter += 1
store.load_cache if exists
title = store.title || "Extra Documentation"
[title, "extra-#{extra_counter}/", exists, type, path]
end
end
end
##
# Returns a 404 page built by +generator+ for +req+ on +res+.
def not_found generator, req, res, message = nil
message ||= "The page <kbd>#{ERB::Util.h req.path}</kbd> was not found"
res.body = generator.generate_servlet_not_found message
res.status = 404
end
##
# Enumerates the ri paths. See RDoc::RI::Paths#each
def ri_paths &block
RDoc::RI::Paths.each true, true, true, :all, *@extra_doc_dirs, &block #TODO: pass extra_dirs
end
##
# Generates the root page on +res+. +req+ is ignored.
def root req, res
generator = RDoc::Generator::Darkfish.new nil, @options
res.body = generator.generate_servlet_root installed_docs
res.content_type = 'text/html'
end
##
# Generates a search index for the root page on +res+. +req+ is ignored.
def root_search req, res
search_index = []
info = []
installed_docs.map do |name, href, exists, type, path|
next unless exists
search_index << name
case type
when :gem
gemspec = path.gsub(%r%/doc/([^/]*?)/ri$%,
'/specifications/\1.gemspec')
spec = Gem::Specification.load gemspec
path = spec.full_name
comment = spec.summary
when :system then
path = 'ruby'
comment = 'Documentation for the Ruby standard library'
when :site then
path = 'site'
comment = 'Documentation for non-gem libraries'
when :home then
path = 'home'
comment = 'Documentation from your home directory'
when :extra
comment = name
end
info << [name, '', path, '', comment]
end
index = {
:index => {
:searchIndex => search_index,
:longSearchIndex => search_index,
:info => info,
}
}
res.body = "var search_data = #{JSON.dump index};"
res.content_type = 'application/javascript'
end
##
# Displays documentation for +req+ on +res+, whether that be HTML or some
# asset.
def show_documentation req, res
store, path = documentation_source req.path
if_modified_since req, res, store.cache_path
generator = generator_for store
case path
when nil, '', 'index.html' then
res.body = generator.generate_index
when 'table_of_contents.html' then
res.body = generator.generate_table_of_contents
when 'js/search_index.js' then
documentation_search store, generator, req, res
else
documentation_page store, generator, path, req, res
end
ensure
res.content_type ||= 'text/html'
end
##
# Returns an RDoc::Store for the given +source_name+ ('ruby' or a gem name).
def store_for source_name
case source_name
when 'home' then
RDoc::Store.new RDoc::RI::Paths.home_dir, :home
when 'ruby' then
RDoc::Store.new RDoc::RI::Paths.system_dir, :system
when 'site' then
RDoc::Store.new RDoc::RI::Paths.site_dir, :site
when /\Aextra-(\d+)\z/ then
index = $1.to_i - 1
ri_dir = installed_docs[index][4]
RDoc::Store.new ri_dir, :extra
else
ri_dir, type = ri_paths.find do |dir, dir_type|
next unless dir_type == :gem
source_name == dir[%r%/([^/]*)/ri$%, 1]
end
raise WEBrick::HTTPStatus::NotFound,
"Could not find gem \"#{ERB::Util.html_escape(source_name)}\". Are you sure you installed it?" unless ri_dir
store = RDoc::Store.new ri_dir, type
return store if File.exist? store.cache_path
raise WEBrick::HTTPStatus::NotFound,
"Could not find documentation for \"#{ERB::Util.html_escape(source_name)}\". Please run `gem rdoc --ri gem_name`"
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/alias.rb 0000644 00000004174 15173517747 0014434 0 ustar 00 # frozen_string_literal: true
##
# Represent an alias, which is an old_name/new_name pair associated with a
# particular context
#--
# TODO implement Alias as a proxy to a method/attribute, inheriting from
# MethodAttr
class RDoc::Alias < RDoc::CodeObject
##
# Aliased method's name
attr_reader :new_name
alias name new_name
##
# Aliasee method's name
attr_reader :old_name
##
# Is this an alias declared in a singleton context?
attr_accessor :singleton
##
# Source file token stream
attr_reader :text
##
# Creates a new Alias with a token stream of +text+ that aliases +old_name+
# to +new_name+, has +comment+ and is a +singleton+ context.
def initialize(text, old_name, new_name, comment, singleton = false)
super()
@text = text
@singleton = singleton
@old_name = old_name
@new_name = new_name
self.comment = comment
end
##
# Order by #singleton then #new_name
def <=>(other)
[@singleton ? 0 : 1, new_name] <=> [other.singleton ? 0 : 1, other.new_name]
end
##
# HTML fragment reference for this alias
def aref
type = singleton ? 'c' : 'i'
"#alias-#{type}-#{html_name}"
end
##
# Full old name including namespace
def full_old_name
@full_name || "#{parent.name}#{pretty_old_name}"
end
##
# HTML id-friendly version of +#new_name+.
def html_name
CGI.escape(@new_name.gsub('-', '-2D')).gsub('%','-').sub(/^-/, '')
end
def inspect # :nodoc:
parent_name = parent ? parent.name : '(unknown)'
"#<%s:0x%x %s.alias_method %s, %s>" % [
self.class, object_id,
parent_name, @old_name, @new_name,
]
end
##
# '::' for the alias of a singleton method/attribute, '#' for instance-level.
def name_prefix
singleton ? '::' : '#'
end
##
# Old name with prefix '::' or '#'.
def pretty_old_name
"#{singleton ? '::' : '#'}#{@old_name}"
end
##
# New name with prefix '::' or '#'.
def pretty_new_name
"#{singleton ? '::' : '#'}#{@new_name}"
end
alias pretty_name pretty_new_name
def to_s # :nodoc:
"alias: #{self.new_name} -> #{self.pretty_old_name} in: #{parent}"
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/context.rb 0000644 00000074420 15173517747 0015030 0 ustar 00 # frozen_string_literal: true
##
# A Context is something that can hold modules, classes, methods, attributes,
# aliases, requires, and includes. Classes, modules, and files are all
# Contexts.
class RDoc::Context < RDoc::CodeObject
include Comparable
##
# Types of methods
TYPES = %w[class instance]
##
# If a context has these titles it will be sorted in this order.
TOMDOC_TITLES = [nil, 'Public', 'Internal', 'Deprecated'] # :nodoc:
TOMDOC_TITLES_SORT = TOMDOC_TITLES.sort_by { |title| title.to_s } # :nodoc:
##
# Class/module aliases
attr_reader :aliases
##
# All attr* methods
attr_reader :attributes
##
# Block params to be used in the next MethodAttr parsed under this context
attr_accessor :block_params
##
# Constants defined
attr_reader :constants
##
# Sets the current documentation section of documentation
attr_writer :current_section
##
# Files this context is found in
attr_reader :in_files
##
# Modules this context includes
attr_reader :includes
##
# Modules this context is extended with
attr_reader :extends
##
# Methods defined in this context
attr_reader :method_list
##
# Name of this class excluding namespace. See also full_name
attr_reader :name
##
# Files this context requires
attr_reader :requires
##
# Use this section for the next method, attribute or constant added.
attr_accessor :temporary_section
##
# Hash <tt>old_name => [aliases]</tt>, for aliases
# that haven't (yet) been resolved to a method/attribute.
# (Not to be confused with the aliases of the context.)
attr_accessor :unmatched_alias_lists
##
# Aliases that could not be resolved.
attr_reader :external_aliases
##
# Current visibility of this context
attr_accessor :visibility
##
# Current visibility of this line
attr_writer :current_line_visibility
##
# Hash of registered methods. Attributes are also registered here,
# twice if they are RW.
attr_reader :methods_hash
##
# Params to be used in the next MethodAttr parsed under this context
attr_accessor :params
##
# Hash of registered constants.
attr_reader :constants_hash
##
# Creates an unnamed empty context with public current visibility
def initialize
super
@in_files = []
@name ||= "unknown"
@parent = nil
@visibility = :public
@current_section = Section.new self, nil, nil
@sections = { nil => @current_section }
@temporary_section = nil
@classes = {}
@modules = {}
initialize_methods_etc
end
##
# Sets the defaults for methods and so-forth
def initialize_methods_etc
@method_list = []
@attributes = []
@aliases = []
@requires = []
@includes = []
@extends = []
@constants = []
@external_aliases = []
@current_line_visibility = nil
# This Hash maps a method name to a list of unmatched aliases (aliases of
# a method not yet encountered).
@unmatched_alias_lists = {}
@methods_hash = {}
@constants_hash = {}
@params = nil
@store ||= nil
end
##
# Contexts are sorted by full_name
def <=>(other)
return nil unless RDoc::CodeObject === other
full_name <=> other.full_name
end
##
# Adds an item of type +klass+ with the given +name+ and +comment+ to the
# context.
#
# Currently only RDoc::Extend and RDoc::Include are supported.
def add klass, name, comment
if RDoc::Extend == klass then
ext = RDoc::Extend.new name, comment
add_extend ext
elsif RDoc::Include == klass then
incl = RDoc::Include.new name, comment
add_include incl
else
raise NotImplementedError, "adding a #{klass} is not implemented"
end
end
##
# Adds +an_alias+ that is automatically resolved
def add_alias an_alias
return an_alias unless @document_self
method_attr = find_method(an_alias.old_name, an_alias.singleton) ||
find_attribute(an_alias.old_name, an_alias.singleton)
if method_attr then
method_attr.add_alias an_alias, self
else
add_to @external_aliases, an_alias
unmatched_alias_list =
@unmatched_alias_lists[an_alias.pretty_old_name] ||= []
unmatched_alias_list.push an_alias
end
an_alias
end
##
# Adds +attribute+ if not already there. If it is (as method(s) or attribute),
# updates the comment if it was empty.
#
# The attribute is registered only if it defines a new method.
# For instance, <tt>attr_reader :foo</tt> will not be registered
# if method +foo+ exists, but <tt>attr_accessor :foo</tt> will be registered
# if method +foo+ exists, but <tt>foo=</tt> does not.
def add_attribute attribute
return attribute unless @document_self
# mainly to check for redefinition of an attribute as a method
# TODO find a policy for 'attr_reader :foo' + 'def foo=()'
register = false
key = nil
if attribute.rw.index 'R' then
key = attribute.pretty_name
known = @methods_hash[key]
if known then
known.comment = attribute.comment if known.comment.empty?
elsif registered = @methods_hash[attribute.pretty_name + '='] and
RDoc::Attr === registered then
registered.rw = 'RW'
else
@methods_hash[key] = attribute
register = true
end
end
if attribute.rw.index 'W' then
key = attribute.pretty_name + '='
known = @methods_hash[key]
if known then
known.comment = attribute.comment if known.comment.empty?
elsif registered = @methods_hash[attribute.pretty_name] and
RDoc::Attr === registered then
registered.rw = 'RW'
else
@methods_hash[key] = attribute
register = true
end
end
if register then
attribute.visibility = @visibility
add_to @attributes, attribute
resolve_aliases attribute
end
attribute
end
##
# Adds a class named +given_name+ with +superclass+.
#
# Both +given_name+ and +superclass+ may contain '::', and are
# interpreted relative to the +self+ context. This allows handling correctly
# examples like these:
# class RDoc::Gauntlet < Gauntlet
# module Mod
# class Object # implies < ::Object
# class SubObject < Object # this is _not_ ::Object
#
# Given <tt>class Container::Item</tt> RDoc assumes +Container+ is a module
# unless it later sees <tt>class Container</tt>. +add_class+ automatically
# upgrades +given_name+ to a class in this case.
def add_class class_type, given_name, superclass = '::Object'
# superclass +nil+ is passed by the C parser in the following cases:
# - registering Object in 1.8 (correct)
# - registering BasicObject in 1.9 (correct)
# - registering RubyVM in 1.9 in iseq.c (incorrect: < Object in vm.c)
#
# If we later find a superclass for a registered class with a nil
# superclass, we must honor it.
# find the name & enclosing context
if given_name =~ /^:+(\w+)$/ then
full_name = $1
enclosing = top_level
name = full_name.split(/:+/).last
else
full_name = child_name given_name
if full_name =~ /^(.+)::(\w+)$/ then
name = $2
ename = $1
enclosing = @store.classes_hash[ename] || @store.modules_hash[ename]
# HACK: crashes in actionpack/lib/action_view/helpers/form_helper.rb (metaprogramming)
unless enclosing then
# try the given name at top level (will work for the above example)
enclosing = @store.classes_hash[given_name] ||
@store.modules_hash[given_name]
return enclosing if enclosing
# not found: create the parent(s)
names = ename.split('::')
enclosing = self
names.each do |n|
enclosing = enclosing.classes_hash[n] ||
enclosing.modules_hash[n] ||
enclosing.add_module(RDoc::NormalModule, n)
end
end
else
name = full_name
enclosing = self
end
end
# fix up superclass
if full_name == 'BasicObject' then
superclass = nil
elsif full_name == 'Object' then
superclass = '::BasicObject'
end
# find the superclass full name
if superclass then
if superclass =~ /^:+/ then
superclass = $' #'
else
if superclass =~ /^(\w+):+(.+)$/ then
suffix = $2
mod = find_module_named($1)
superclass = mod.full_name + '::' + suffix if mod
else
mod = find_module_named(superclass)
superclass = mod.full_name if mod
end
end
# did we believe it was a module?
mod = @store.modules_hash.delete superclass
upgrade_to_class mod, RDoc::NormalClass, mod.parent if mod
# e.g., Object < Object
superclass = nil if superclass == full_name
end
klass = @store.classes_hash[full_name]
if klass then
# if TopLevel, it may not be registered in the classes:
enclosing.classes_hash[name] = klass
# update the superclass if needed
if superclass then
existing = klass.superclass
existing = existing.full_name unless existing.is_a?(String) if existing
if existing.nil? ||
(existing == 'Object' && superclass != 'Object') then
klass.superclass = superclass
end
end
else
# this is a new class
mod = @store.modules_hash.delete full_name
if mod then
klass = upgrade_to_class mod, RDoc::NormalClass, enclosing
klass.superclass = superclass unless superclass.nil?
else
klass = class_type.new name, superclass
enclosing.add_class_or_module(klass, enclosing.classes_hash,
@store.classes_hash)
end
end
klass.parent = self
klass
end
##
# Adds the class or module +mod+ to the modules or
# classes Hash +self_hash+, and to +all_hash+ (either
# <tt>TopLevel::modules_hash</tt> or <tt>TopLevel::classes_hash</tt>),
# unless #done_documenting is +true+. Sets the #parent of +mod+
# to +self+, and its #section to #current_section. Returns +mod+.
def add_class_or_module mod, self_hash, all_hash
mod.section = current_section # TODO declaring context? something is
# wrong here...
mod.parent = self
mod.full_name = nil
mod.store = @store
unless @done_documenting then
self_hash[mod.name] = mod
# this must be done AFTER adding mod to its parent, so that the full
# name is correct:
all_hash[mod.full_name] = mod
if @store.unmatched_constant_alias[mod.full_name] then
to, file = @store.unmatched_constant_alias[mod.full_name]
add_module_alias mod, mod.name, to, file
end
end
mod
end
##
# Adds +constant+ if not already there. If it is, updates the comment,
# value and/or is_alias_for of the known constant if they were empty/nil.
def add_constant constant
return constant unless @document_self
# HACK: avoid duplicate 'PI' & 'E' in math.c (1.8.7 source code)
# (this is a #ifdef: should be handled by the C parser)
known = @constants_hash[constant.name]
if known then
known.comment = constant.comment if known.comment.empty?
known.value = constant.value if
known.value.nil? or known.value.strip.empty?
known.is_alias_for ||= constant.is_alias_for
else
@constants_hash[constant.name] = constant
add_to @constants, constant
end
constant
end
##
# Adds included module +include+ which should be an RDoc::Include
def add_include include
add_to @includes, include
include
end
##
# Adds extension module +ext+ which should be an RDoc::Extend
def add_extend ext
add_to @extends, ext
ext
end
##
# Adds +method+ if not already there. If it is (as method or attribute),
# updates the comment if it was empty.
def add_method method
return method unless @document_self
# HACK: avoid duplicate 'new' in io.c & struct.c (1.8.7 source code)
key = method.pretty_name
known = @methods_hash[key]
if known then
if @store then # otherwise we are loading
known.comment = method.comment if known.comment.empty?
previously = ", previously in #{known.file}" unless
method.file == known.file
@store.rdoc.options.warn \
"Duplicate method #{known.full_name} in #{method.file}#{previously}"
end
else
@methods_hash[key] = method
if @current_line_visibility
method.visibility, @current_line_visibility = @current_line_visibility, nil
else
method.visibility = @visibility
end
add_to @method_list, method
resolve_aliases method
end
method
end
##
# Adds a module named +name+. If RDoc already knows +name+ is a class then
# that class is returned instead. See also #add_class.
def add_module(class_type, name)
mod = @classes[name] || @modules[name]
return mod if mod
full_name = child_name name
mod = @store.modules_hash[full_name] || class_type.new(name)
add_class_or_module mod, @modules, @store.modules_hash
end
##
# Adds a module by +RDoc::NormalModule+ instance. See also #add_module.
def add_module_by_normal_module(mod)
add_class_or_module mod, @modules, @store.modules_hash
end
##
# Adds an alias from +from+ (a class or module) to +name+ which was defined
# in +file+.
def add_module_alias from, from_name, to, file
return from if @done_documenting
to_full_name = child_name to.name
# if we already know this name, don't register an alias:
# see the metaprogramming in lib/active_support/basic_object.rb,
# where we already know BasicObject is a class when we find
# BasicObject = BlankSlate
return from if @store.find_class_or_module to_full_name
unless from
@store.unmatched_constant_alias[child_name(from_name)] = [to, file]
return to
end
new_to = from.dup
new_to.name = to.name
new_to.full_name = nil
if new_to.module? then
@store.modules_hash[to_full_name] = new_to
@modules[to.name] = new_to
else
@store.classes_hash[to_full_name] = new_to
@classes[to.name] = new_to
end
# Registers a constant for this alias. The constant value and comment
# will be updated later, when the Ruby parser adds the constant
const = RDoc::Constant.new to.name, nil, new_to.comment
const.record_location file
const.is_alias_for = from
add_constant const
new_to
end
##
# Adds +require+ to this context's top level
def add_require(require)
return require unless @document_self
if RDoc::TopLevel === self then
add_to @requires, require
else
parent.add_require require
end
end
##
# Returns a section with +title+, creating it if it doesn't already exist.
# +comment+ will be appended to the section's comment.
#
# A section with a +title+ of +nil+ will return the default section.
#
# See also RDoc::Context::Section
def add_section title, comment = nil
if section = @sections[title] then
section.add_comment comment if comment
else
section = Section.new self, title, comment
@sections[title] = section
end
section
end
##
# Adds +thing+ to the collection +array+
def add_to array, thing
array << thing if @document_self
thing.parent = self
thing.store = @store if @store
thing.section = current_section
end
##
# Is there any content?
#
# This means any of: comment, aliases, methods, attributes, external
# aliases, require, constant.
#
# Includes and extends are also checked unless <tt>includes == false</tt>.
def any_content(includes = true)
@any_content ||= !(
@comment.empty? &&
@method_list.empty? &&
@attributes.empty? &&
@aliases.empty? &&
@external_aliases.empty? &&
@requires.empty? &&
@constants.empty?
)
@any_content || (includes && !(@includes + @extends).empty? )
end
##
# Creates the full name for a child with +name+
def child_name name
if name =~ /^:+/
$' #'
elsif RDoc::TopLevel === self then
name
else
"#{self.full_name}::#{name}"
end
end
##
# Class attributes
def class_attributes
@class_attributes ||= attributes.select { |a| a.singleton }
end
##
# Class methods
def class_method_list
@class_method_list ||= method_list.select { |a| a.singleton }
end
##
# Array of classes in this context
def classes
@classes.values
end
##
# All classes and modules in this namespace
def classes_and_modules
classes + modules
end
##
# Hash of classes keyed by class name
def classes_hash
@classes
end
##
# The current documentation section that new items will be added to. If
# temporary_section is available it will be used.
def current_section
if section = @temporary_section then
@temporary_section = nil
else
section = @current_section
end
section
end
##
# Is part of this thing was defined in +file+?
def defined_in?(file)
@in_files.include?(file)
end
def display(method_attr) # :nodoc:
if method_attr.is_a? RDoc::Attr
"#{method_attr.definition} #{method_attr.pretty_name}"
else
"method #{method_attr.pretty_name}"
end
end
##
# Iterator for ancestors for duck-typing. Does nothing. See
# RDoc::ClassModule#each_ancestor.
#
# This method exists to make it easy to work with Context subclasses that
# aren't part of RDoc.
def each_ancestor # :nodoc:
end
##
# Iterator for attributes
def each_attribute # :yields: attribute
@attributes.each { |a| yield a }
end
##
# Iterator for classes and modules
def each_classmodule(&block) # :yields: module
classes_and_modules.sort.each(&block)
end
##
# Iterator for constants
def each_constant # :yields: constant
@constants.each {|c| yield c}
end
##
# Iterator for included modules
def each_include # :yields: include
@includes.each do |i| yield i end
end
##
# Iterator for extension modules
def each_extend # :yields: extend
@extends.each do |e| yield e end
end
##
# Iterator for methods
def each_method # :yields: method
return enum_for __method__ unless block_given?
@method_list.sort.each { |m| yield m }
end
##
# Iterator for each section's contents sorted by title. The +section+, the
# section's +constants+ and the sections +attributes+ are yielded. The
# +constants+ and +attributes+ collections are sorted.
#
# To retrieve methods in a section use #methods_by_type with the optional
# +section+ parameter.
#
# NOTE: Do not edit collections yielded by this method
def each_section # :yields: section, constants, attributes
return enum_for __method__ unless block_given?
constants = @constants.group_by do |constant| constant.section end
attributes = @attributes.group_by do |attribute| attribute.section end
constants.default = []
attributes.default = []
sort_sections.each do |section|
yield section, constants[section].select(&:display?).sort, attributes[section].select(&:display?).sort
end
end
##
# Finds an attribute +name+ with singleton value +singleton+.
def find_attribute(name, singleton)
name = $1 if name =~ /^(.*)=$/
@attributes.find { |a| a.name == name && a.singleton == singleton }
end
##
# Finds an attribute with +name+ in this context
def find_attribute_named(name)
case name
when /\A#/ then
find_attribute name[1..-1], false
when /\A::/ then
find_attribute name[2..-1], true
else
@attributes.find { |a| a.name == name }
end
end
##
# Finds a class method with +name+ in this context
def find_class_method_named(name)
@method_list.find { |meth| meth.singleton && meth.name == name }
end
##
# Finds a constant with +name+ in this context
def find_constant_named(name)
@constants.find do |m|
m.name == name || m.full_name == name
end
end
##
# Find a module at a higher scope
def find_enclosing_module_named(name)
parent && parent.find_module_named(name)
end
##
# Finds an external alias +name+ with singleton value +singleton+.
def find_external_alias(name, singleton)
@external_aliases.find { |m| m.name == name && m.singleton == singleton }
end
##
# Finds an external alias with +name+ in this context
def find_external_alias_named(name)
case name
when /\A#/ then
find_external_alias name[1..-1], false
when /\A::/ then
find_external_alias name[2..-1], true
else
@external_aliases.find { |a| a.name == name }
end
end
##
# Finds a file with +name+ in this context
def find_file_named name
@store.find_file_named name
end
##
# Finds an instance method with +name+ in this context
def find_instance_method_named(name)
@method_list.find { |meth| !meth.singleton && meth.name == name }
end
##
# Finds a method, constant, attribute, external alias, module or file
# named +symbol+ in this context.
def find_local_symbol(symbol)
find_method_named(symbol) or
find_constant_named(symbol) or
find_attribute_named(symbol) or
find_external_alias_named(symbol) or
find_module_named(symbol) or
find_file_named(symbol)
end
##
# Finds a method named +name+ with singleton value +singleton+.
def find_method(name, singleton)
@method_list.find { |m|
if m.singleton
m.name == name && m.singleton == singleton
else
m.name == name && !m.singleton && !singleton
end
}
end
##
# Finds a instance or module method with +name+ in this context
def find_method_named(name)
case name
when /\A#/ then
find_method name[1..-1], false
when /\A::/ then
find_method name[2..-1], true
else
@method_list.find { |meth| meth.name == name }
end
end
##
# Find a module with +name+ using ruby's scoping rules
def find_module_named(name)
res = @modules[name] || @classes[name]
return res if res
return self if self.name == name
find_enclosing_module_named name
end
##
# Look up +symbol+, first as a module, then as a local symbol.
def find_symbol(symbol)
find_symbol_module(symbol) || find_local_symbol(symbol)
end
##
# Look up a module named +symbol+.
def find_symbol_module(symbol)
result = nil
# look for a class or module 'symbol'
case symbol
when /^::/ then
result = @store.find_class_or_module symbol
when /^(\w+):+(.+)$/
suffix = $2
top = $1
searched = self
while searched do
mod = searched.find_module_named(top)
break unless mod
result = @store.find_class_or_module "#{mod.full_name}::#{suffix}"
break if result || searched.is_a?(RDoc::TopLevel)
searched = searched.parent
end
else
searched = self
while searched do
result = searched.find_module_named(symbol)
break if result || searched.is_a?(RDoc::TopLevel)
searched = searched.parent
end
end
result
end
##
# The full name for this context. This method is overridden by subclasses.
def full_name
'(unknown)'
end
##
# Does this context and its methods and constants all have documentation?
#
# (Yes, fully documented doesn't mean everything.)
def fully_documented?
documented? and
attributes.all? { |a| a.documented? } and
method_list.all? { |m| m.documented? } and
constants.all? { |c| c.documented? }
end
##
# URL for this with a +prefix+
def http_url(prefix)
path = name_for_path
path = path.gsub(/<<\s*(\w*)/, 'from-\1') if path =~ /<</
path = [prefix] + path.split('::')
File.join(*path.compact) + '.html'
end
##
# Instance attributes
def instance_attributes
@instance_attributes ||= attributes.reject { |a| a.singleton }
end
##
# Instance methods
def instance_methods
@instance_methods ||= method_list.reject { |a| a.singleton }
end
##
# Instance methods
#--
# TODO remove this later
def instance_method_list
warn '#instance_method_list is obsoleted, please use #instance_methods'
@instance_methods ||= method_list.reject { |a| a.singleton }
end
##
# Breaks method_list into a nested hash by type (<tt>'class'</tt> or
# <tt>'instance'</tt>) and visibility (+:public+, +:protected+, +:private+).
#
# If +section+ is provided only methods in that RDoc::Context::Section will
# be returned.
def methods_by_type section = nil
methods = {}
TYPES.each do |type|
visibilities = {}
RDoc::VISIBILITIES.each do |vis|
visibilities[vis] = []
end
methods[type] = visibilities
end
each_method do |method|
next if section and not method.section == section
methods[method.type][method.visibility] << method
end
methods
end
##
# Yields AnyMethod and Attr entries matching the list of names in +methods+.
def methods_matching(methods, singleton = false, &block)
(@method_list + @attributes).each do |m|
yield m if methods.include?(m.name) and m.singleton == singleton
end
each_ancestor do |parent|
parent.methods_matching(methods, singleton, &block)
end
end
##
# Array of modules in this context
def modules
@modules.values
end
##
# Hash of modules keyed by module name
def modules_hash
@modules
end
##
# Name to use to generate the url.
# <tt>#full_name</tt> by default.
def name_for_path
full_name
end
##
# Changes the visibility for new methods to +visibility+
def ongoing_visibility=(visibility)
@visibility = visibility
end
##
# Record +top_level+ as a file +self+ is in.
def record_location(top_level)
@in_files << top_level unless @in_files.include?(top_level)
end
##
# Should we remove this context from the documentation?
#
# The answer is yes if:
# * #received_nodoc is +true+
# * #any_content is +false+ (not counting includes)
# * All #includes are modules (not a string), and their module has
# <tt>#remove_from_documentation? == true</tt>
# * All classes and modules have <tt>#remove_from_documentation? == true</tt>
def remove_from_documentation?
@remove_from_documentation ||=
@received_nodoc &&
!any_content(false) &&
@includes.all? { |i| !i.module.is_a?(String) && i.module.remove_from_documentation? } &&
classes_and_modules.all? { |cm| cm.remove_from_documentation? }
end
##
# Removes methods and attributes with a visibility less than +min_visibility+.
#--
# TODO mark the visibility of attributes in the template (if not public?)
def remove_invisible min_visibility
return if [:private, :nodoc].include? min_visibility
remove_invisible_in @method_list, min_visibility
remove_invisible_in @attributes, min_visibility
remove_invisible_in @constants, min_visibility
end
##
# Only called when min_visibility == :public or :private
def remove_invisible_in array, min_visibility # :nodoc:
if min_visibility == :public then
array.reject! { |e|
e.visibility != :public and not e.force_documentation
}
else
array.reject! { |e|
e.visibility == :private and not e.force_documentation
}
end
end
##
# Tries to resolve unmatched aliases when a method or attribute has just
# been added.
def resolve_aliases added
# resolve any pending unmatched aliases
key = added.pretty_name
unmatched_alias_list = @unmatched_alias_lists[key]
return unless unmatched_alias_list
unmatched_alias_list.each do |unmatched_alias|
added.add_alias unmatched_alias, self
@external_aliases.delete unmatched_alias
end
@unmatched_alias_lists.delete key
end
##
# Returns RDoc::Context::Section objects referenced in this context for use
# in a table of contents.
def section_contents
used_sections = {}
each_method do |method|
next unless method.display?
used_sections[method.section] = true
end
# order found sections
sections = sort_sections.select do |section|
used_sections[section]
end
# only the default section is used
return [] if
sections.length == 1 and not sections.first.title
sections
end
##
# Sections in this context
def sections
@sections.values
end
def sections_hash # :nodoc:
@sections
end
##
# Sets the current section to a section with +title+. See also #add_section
def set_current_section title, comment
@current_section = add_section title, comment
end
##
# Given an array +methods+ of method names, set the visibility of each to
# +visibility+
def set_visibility_for(methods, visibility, singleton = false)
methods_matching methods, singleton do |m|
m.visibility = visibility
end
end
##
# Given an array +names+ of constants, set the visibility of each constant to
# +visibility+
def set_constant_visibility_for(names, visibility)
names.each do |name|
constant = @constants_hash[name] or next
constant.visibility = visibility
end
end
##
# Sorts sections alphabetically (default) or in TomDoc fashion (none,
# Public, Internal, Deprecated)
def sort_sections
titles = @sections.map { |title, _| title }
if titles.length > 1 and
TOMDOC_TITLES_SORT ==
(titles | TOMDOC_TITLES).sort_by { |title| title.to_s } then
@sections.values_at(*TOMDOC_TITLES).compact
else
@sections.sort_by { |title, _|
title.to_s
}.map { |_, section|
section
}
end
end
def to_s # :nodoc:
"#{self.class.name} #{self.full_name}"
end
##
# Return the TopLevel that owns us
#--
# FIXME we can be 'owned' by several TopLevel (see #record_location &
# #in_files)
def top_level
return @top_level if defined? @top_level
@top_level = self
@top_level = @top_level.parent until RDoc::TopLevel === @top_level
@top_level
end
##
# Upgrades NormalModule +mod+ in +enclosing+ to a +class_type+
def upgrade_to_class mod, class_type, enclosing
enclosing.modules_hash.delete mod.name
klass = RDoc::ClassModule.from_module class_type, mod
klass.store = @store
# if it was there, then we keep it even if done_documenting
@store.classes_hash[mod.full_name] = klass
enclosing.classes_hash[mod.name] = klass
klass
end
autoload :Section, "#{__dir__}/context/section"
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/ri/paths.rb 0000644 00000010536 15173517747 0015073 0 ustar 00 # frozen_string_literal: true
require_relative '../rdoc'
##
# The directories where ri data lives. Paths can be enumerated via ::each, or
# queried individually via ::system_dir, ::site_dir, ::home_dir and ::gem_dir.
module RDoc::RI::Paths
#:stopdoc:
require 'rbconfig'
version = RbConfig::CONFIG['ruby_version_dir_name'] || RbConfig::CONFIG['ruby_version']
BASE = File.join RbConfig::CONFIG['ridir'], version
HOMEDIR = RDoc.home
#:startdoc:
##
# Iterates over each selected path yielding the directory and type.
#
# Yielded types:
# :system:: Where Ruby's ri data is stored. Yielded when +system+ is
# true
# :site:: Where ri for installed libraries are stored. Yielded when
# +site+ is true. Normally no ri data is stored here.
# :home:: ~/.rdoc. Yielded when +home+ is true.
# :gem:: ri data for an installed gem. Yielded when +gems+ is true.
# :extra:: ri data directory from the command line. Yielded for each
# entry in +extra_dirs+
def self.each system = true, site = true, home = true, gems = :latest, *extra_dirs # :yields: directory, type
return enum_for __method__, system, site, home, gems, *extra_dirs unless
block_given?
extra_dirs.each do |dir|
yield dir, :extra
end
yield system_dir, :system if system
yield site_dir, :site if site
yield home_dir, :home if home and HOMEDIR
gemdirs(gems).each do |dir|
yield dir, :gem
end if gems
nil
end
##
# The ri directory for the gem with +gem_name+.
def self.gem_dir name, version
req = Gem::Requirement.new "= #{version}"
spec = Gem::Specification.find_by_name name, req
File.join spec.doc_dir, 'ri'
end
##
# The latest installed gems' ri directories. +filter+ can be :all or
# :latest.
#
# A +filter+ :all includes all versions of gems and includes gems without
# ri documentation.
def self.gemdirs filter = :latest
ri_paths = {}
all = Gem::Specification.map do |spec|
[File.join(spec.doc_dir, 'ri'), spec.name, spec.version]
end
if filter == :all then
gemdirs = []
all.group_by do |_, name, _|
name
end.sort_by do |group, _|
group
end.map do |group, items|
items.sort_by do |_, _, version|
version
end.reverse_each do |dir,|
gemdirs << dir
end
end
return gemdirs
end
all.each do |dir, name, ver|
next unless File.exist? dir
if ri_paths[name].nil? or ver > ri_paths[name].first then
ri_paths[name] = [ver, name, dir]
end
end
ri_paths.sort_by { |_, (_, name, _)| name }.map { |k, v| v.last }
rescue LoadError
[]
end
##
# The location of the rdoc data in the user's home directory.
#
# Like ::system, ri data in the user's home directory is rare and predates
# libraries distributed via RubyGems. ri data is rarely generated into this
# directory.
def self.home_dir
HOMEDIR
end
##
# Returns existing directories from the selected documentation directories
# as an Array.
#
# See also ::each
def self.path(system = true, site = true, home = true, gems = :latest, *extra_dirs)
path = raw_path system, site, home, gems, *extra_dirs
path.select { |directory| File.directory? directory }
end
##
# Returns selected documentation directories including nonexistent
# directories.
#
# See also ::each
def self.raw_path(system, site, home, gems, *extra_dirs)
path = []
each(system, site, home, gems, *extra_dirs) do |dir, type|
path << dir
end
path.compact
end
##
# The location of ri data installed into the site dir.
#
# Historically this was available for documentation installed by Ruby
# libraries predating RubyGems. It is unlikely to contain any content for
# modern Ruby installations.
def self.site_dir
File.join BASE, 'site'
end
##
# The location of the built-in ri data.
#
# This data is built automatically when `make` is run when Ruby is
# installed. If you did not install Ruby by hand you may need to install
# the documentation yourself. Please consult the documentation for your
# package manager or Ruby installer for details. You can also use the
# rdoc-data gem to install system ri data for common versions of Ruby.
def self.system_dir
File.join BASE, 'system'
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/ri/driver.rb 0000644 00000107522 15173517747 0015251 0 ustar 00 # frozen_string_literal: true
require 'optparse'
require_relative '../../rdoc'
require_relative 'formatter' # For RubyGems backwards compatibility
# TODO: Fix weird documentation with `require_relative`
##
# The RI driver implements the command-line ri tool.
#
# The driver supports:
# * loading RI data from:
# * Ruby's standard library
# * RubyGems
# * ~/.rdoc
# * A user-supplied directory
# * Paging output (uses RI_PAGER environment variable, PAGER environment
# variable or the less, more and pager programs)
# * Interactive mode with tab-completion
# * Abbreviated names (ri Zl shows Zlib documentation)
# * Colorized output
# * Merging output from multiple RI data sources
class RDoc::RI::Driver
##
# Base Driver error class
class Error < RDoc::RI::Error; end
##
# Raised when a name isn't found in the ri data stores
class NotFoundError < Error
def initialize(klass, suggestion_proc = nil) # :nodoc:
@klass = klass
@suggestion_proc = suggestion_proc
end
##
# Name that wasn't found
def name
@klass
end
def message # :nodoc:
str = "Nothing known about #{@klass}"
suggestions = @suggestion_proc&.call
if suggestions and !suggestions.empty?
str += "\nDid you mean? #{suggestions.join("\n ")}"
end
str
end
end
##
# Show all method documentation following a class or module
attr_accessor :show_all
##
# An RDoc::RI::Store for each entry in the RI path
attr_accessor :stores
##
# Controls the user of the pager vs $stdout
attr_accessor :use_stdout
##
# Default options for ri
def self.default_options
options = {}
options[:interactive] = false
options[:profile] = false
options[:show_all] = false
options[:use_stdout] = !$stdout.tty?
options[:width] = 72
# By default all standard paths are used.
options[:use_system] = true
options[:use_site] = true
options[:use_home] = true
options[:use_gems] = true
options[:extra_doc_dirs] = []
return options
end
##
# Dump +data_path+ using pp
def self.dump data_path
require 'pp'
File.open data_path, 'rb' do |io|
pp Marshal.load(io.read)
end
end
##
# Parses +argv+ and returns a Hash of options
def self.process_args argv
options = default_options
opts = OptionParser.new do |opt|
opt.accept File do |file,|
File.readable?(file) and not File.directory?(file) and file
end
opt.program_name = File.basename $0
opt.version = RDoc::VERSION
opt.release = nil
opt.summary_indent = ' ' * 4
opt.banner = <<-EOT
Usage: #{opt.program_name} [options] [name ...]
Where name can be:
Class | Module | Module::Class
Class::method | Class#method | Class.method | method
gem_name: | gem_name:README | gem_name:History
ruby: | ruby:NEWS | ruby:globals
All class names may be abbreviated to their minimum unambiguous form.
If a name is ambiguous, all valid options will be listed.
A '.' matches either class or instance methods, while #method
matches only instance and ::method matches only class methods.
README and other files may be displayed by prefixing them with the gem name
they're contained in. If the gem name is followed by a ':' all files in the
gem will be shown. The file name extension may be omitted where it is
unambiguous.
'ruby' can be used as a pseudo gem name to display files from the Ruby
core documentation. Use 'ruby:' by itself to get a list of all available
core documentation files.
For example:
#{opt.program_name} Fil
#{opt.program_name} File
#{opt.program_name} File.new
#{opt.program_name} zip
#{opt.program_name} rdoc:README
#{opt.program_name} ruby:comments
Note that shell quoting or escaping may be required for method names
containing punctuation:
#{opt.program_name} 'Array.[]'
#{opt.program_name} compact\\!
To see the default directories #{opt.program_name} will search, run:
#{opt.program_name} --list-doc-dirs
Specifying the --system, --site, --home, --gems, or --doc-dir options
will limit ri to searching only the specified directories.
ri options may be set in the RI environment variable.
The ri pager can be set with the RI_PAGER environment variable
or the PAGER environment variable.
EOT
opt.separator nil
opt.separator "Options:"
opt.separator nil
opt.on("--[no-]interactive", "-i",
"In interactive mode you can repeatedly",
"look up methods with autocomplete.") do |interactive|
options[:interactive] = interactive
end
opt.separator nil
opt.on("--[no-]all", "-a",
"Show all documentation for a class or",
"module.") do |show_all|
options[:show_all] = show_all
end
opt.separator nil
opt.on("--[no-]list", "-l",
"List classes ri knows about.") do |list|
options[:list] = list
end
opt.separator nil
opt.on("--[no-]pager",
"Send output to a pager,",
"rather than directly to stdout.") do |use_pager|
options[:use_stdout] = !use_pager
end
opt.separator nil
opt.on("-T",
"Synonym for --no-pager.") do
options[:use_stdout] = true
end
opt.separator nil
opt.on("--width=WIDTH", "-w", OptionParser::DecimalInteger,
"Set the width of the output.") do |width|
options[:width] = width
end
opt.separator nil
opt.on("--server[=PORT]", Integer,
"Run RDoc server on the given port.",
"The default port is 8214.") do |port|
options[:server] = port || 8214
end
opt.separator nil
formatters = RDoc::Markup.constants.grep(/^To[A-Z][a-z]+$/).sort
formatters = formatters.sort.map do |formatter|
formatter.to_s.sub('To', '').downcase
end
formatters -= %w[html label test] # remove useless output formats
opt.on("--format=NAME", "-f",
"Use the selected formatter. The default",
"formatter is bs for paged output and ansi",
"otherwise. Valid formatters are:",
"#{formatters.join(', ')}.", formatters) do |value|
options[:formatter] = RDoc::Markup.const_get "To#{value.capitalize}"
end
opt.separator nil
opt.on("--help", "-h",
"Show help and exit.") do
puts opts
exit
end
opt.separator nil
opt.on("--version", "-v",
"Output version information and exit.") do
puts "#{opts.program_name} #{opts.version}"
exit
end
opt.separator nil
opt.separator "Data source options:"
opt.separator nil
opt.on("--[no-]list-doc-dirs",
"List the directories from which ri will",
"source documentation on stdout and exit.") do |list_doc_dirs|
options[:list_doc_dirs] = list_doc_dirs
end
opt.separator nil
opt.on("--doc-dir=DIRNAME", "-d", Array,
"List of directories from which to source",
"documentation in addition to the standard",
"directories. May be repeated.") do |value|
value.each do |dir|
unless File.directory? dir then
raise OptionParser::InvalidArgument, "#{dir} is not a directory"
end
options[:extra_doc_dirs] << File.expand_path(dir)
end
end
opt.separator nil
opt.on("--no-standard-docs",
"Do not include documentation from",
"the Ruby standard library, site_lib,",
"installed gems, or ~/.rdoc.",
"Use with --doc-dir.") do
options[:use_system] = false
options[:use_site] = false
options[:use_gems] = false
options[:use_home] = false
end
opt.separator nil
opt.on("--[no-]system",
"Include documentation from Ruby's",
"standard library. Defaults to true.") do |value|
options[:use_system] = value
end
opt.separator nil
opt.on("--[no-]site",
"Include documentation from libraries",
"installed in site_lib.",
"Defaults to true.") do |value|
options[:use_site] = value
end
opt.separator nil
opt.on("--[no-]gems",
"Include documentation from RubyGems.",
"Defaults to true.") do |value|
options[:use_gems] = value
end
opt.separator nil
opt.on("--[no-]home",
"Include documentation stored in ~/.rdoc.",
"Defaults to true.") do |value|
options[:use_home] = value
end
opt.separator nil
opt.separator "Debug options:"
opt.separator nil
opt.on("--[no-]profile",
"Run with the ruby profiler.") do |value|
options[:profile] = value
end
opt.separator nil
opt.on("--dump=CACHE", File,
"Dump data from an ri cache or data file.") do |value|
options[:dump_path] = value
end
end
argv = ENV['RI'].to_s.split(' ').concat argv
opts.parse! argv
options[:names] = argv
options[:use_stdout] ||= !$stdout.tty?
options[:use_stdout] ||= options[:interactive]
options[:width] ||= 72
options
rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
puts opts
puts
puts e
exit 1
end
##
# Runs the ri command line executable using +argv+
def self.run argv = ARGV
options = process_args argv
if options[:dump_path] then
dump options[:dump_path]
return
end
ri = new options
ri.run
end
##
# Creates a new driver using +initial_options+ from ::process_args
def initialize initial_options = {}
@paging = false
@classes = nil
options = self.class.default_options.update(initial_options)
@formatter_klass = options[:formatter]
require 'profile' if options[:profile]
@names = options[:names]
@list = options[:list]
@doc_dirs = []
@stores = []
RDoc::RI::Paths.each(options[:use_system], options[:use_site],
options[:use_home], options[:use_gems],
*options[:extra_doc_dirs]) do |path, type|
@doc_dirs << path
store = RDoc::RI::Store.new path, type
store.load_cache
@stores << store
end
@list_doc_dirs = options[:list_doc_dirs]
@interactive = options[:interactive]
@server = options[:server]
@use_stdout = options[:use_stdout]
@show_all = options[:show_all]
@width = options[:width]
end
##
# Adds paths for undocumented classes +also_in+ to +out+
def add_also_in out, also_in
return if also_in.empty?
out << RDoc::Markup::Rule.new(1)
out << RDoc::Markup::Paragraph.new("Also found in:")
paths = RDoc::Markup::Verbatim.new
also_in.each do |store|
paths.parts.push store.friendly_path, "\n"
end
out << paths
end
##
# Adds a class header to +out+ for class +name+ which is described in
# +classes+.
def add_class out, name, classes
heading = if classes.all? { |klass| klass.module? } then
name
else
superclass = classes.map do |klass|
klass.superclass unless klass.module?
end.compact.shift || 'Object'
superclass = superclass.full_name unless String === superclass
"#{name} < #{superclass}"
end
out << RDoc::Markup::Heading.new(1, heading)
out << RDoc::Markup::BlankLine.new
end
##
# Adds "(from ...)" to +out+ for +store+
def add_from out, store
out << RDoc::Markup::Paragraph.new("(from #{store.friendly_path})")
end
##
# Adds +extends+ to +out+
def add_extends out, extends
add_extension_modules out, 'Extended by', extends
end
##
# Adds a list of +extensions+ to this module of the given +type+ to +out+.
# add_includes and add_extends call this, so you should use those directly.
def add_extension_modules out, type, extensions
return if extensions.empty?
out << RDoc::Markup::Rule.new(1)
out << RDoc::Markup::Heading.new(1, "#{type}:")
extensions.each do |modules, store|
if modules.length == 1 then
add_extension_modules_single out, store, modules.first
else
add_extension_modules_multiple out, store, modules
end
end
end
##
# Renders multiple included +modules+ from +store+ to +out+.
def add_extension_modules_multiple out, store, modules # :nodoc:
out << RDoc::Markup::Paragraph.new("(from #{store.friendly_path})")
wout, with = modules.partition { |incl| incl.comment.empty? }
out << RDoc::Markup::BlankLine.new unless with.empty?
with.each do |incl|
out << RDoc::Markup::Paragraph.new(incl.name)
out << RDoc::Markup::BlankLine.new
out << incl.comment
end
unless wout.empty? then
verb = RDoc::Markup::Verbatim.new
wout.each do |incl|
verb.push incl.name, "\n"
end
out << verb
end
end
##
# Adds a single extension module +include+ from +store+ to +out+
def add_extension_modules_single out, store, include # :nodoc:
name = include.name
path = store.friendly_path
out << RDoc::Markup::Paragraph.new("#{name} (from #{path})")
if include.comment then
out << RDoc::Markup::BlankLine.new
out << include.comment
end
end
##
# Adds +includes+ to +out+
def add_includes out, includes
add_extension_modules out, 'Includes', includes
end
##
# Looks up the method +name+ and adds it to +out+
def add_method out, name
filtered = lookup_method name
method_out = method_document name, filtered
out.concat method_out.parts
end
##
# Adds documentation for all methods in +klass+ to +out+
def add_method_documentation out, klass
klass.method_list.each do |method|
begin
add_method out, method.full_name
rescue NotFoundError
next
end
end
end
##
# Adds a list of +methods+ to +out+ with a heading of +name+
def add_method_list out, methods, name
return if methods.empty?
out << RDoc::Markup::Heading.new(1, "#{name}:")
out << RDoc::Markup::BlankLine.new
if @use_stdout and !@interactive then
out.concat methods.map { |method|
RDoc::Markup::Verbatim.new method
}
else
out << RDoc::Markup::IndentedParagraph.new(2, methods.join(', '))
end
out << RDoc::Markup::BlankLine.new
end
##
# Returns ancestor classes of +klass+
def ancestors_of klass
ancestors = []
unexamined = [klass]
seen = []
loop do
break if unexamined.empty?
current = unexamined.shift
seen << current
stores = classes[current]
next unless stores and not stores.empty?
klasses = stores.flat_map do |store|
store.ancestors[current] || []
end.uniq
klasses = klasses - seen
ancestors.concat klasses
unexamined.concat klasses
end
ancestors.reverse
end
##
# For RubyGems backwards compatibility
def class_cache # :nodoc:
end
##
# Builds a RDoc::Markup::Document from +found+, +klasess+ and +includes+
def class_document name, found, klasses, includes, extends
also_in = []
out = RDoc::Markup::Document.new
add_class out, name, klasses
add_includes out, includes
add_extends out, extends
found.each do |store, klass|
render_class out, store, klass, also_in
end
add_also_in out, also_in
out
end
##
# Adds the class +comment+ to +out+.
def class_document_comment out, comment # :nodoc:
unless comment.empty? then
out << RDoc::Markup::Rule.new(1)
if comment.merged? then
parts = comment.parts
parts = parts.zip [RDoc::Markup::BlankLine.new] * parts.length
parts.flatten!
parts.pop
out.concat parts
else
out << comment
end
end
end
##
# Adds the constants from +klass+ to the Document +out+.
def class_document_constants out, klass # :nodoc:
return if klass.constants.empty?
out << RDoc::Markup::Heading.new(1, "Constants:")
out << RDoc::Markup::BlankLine.new
list = RDoc::Markup::List.new :NOTE
constants = klass.constants.sort_by { |constant| constant.name }
list.items.concat constants.map { |constant|
parts = constant.comment.parts if constant.comment
parts << RDoc::Markup::Paragraph.new('[not documented]') if
parts.empty?
RDoc::Markup::ListItem.new(constant.name, *parts)
}
out << list
out << RDoc::Markup::BlankLine.new
end
##
# Hash mapping a known class or module to the stores it can be loaded from
def classes
return @classes if @classes
@classes = {}
@stores.each do |store|
store.cache[:modules].each do |mod|
# using default block causes searched-for modules to be added
@classes[mod] ||= []
@classes[mod] << store
end
end
@classes
end
##
# Returns the stores wherein +name+ is found along with the classes,
# extends and includes that match it
def classes_and_includes_and_extends_for name
klasses = []
extends = []
includes = []
found = @stores.map do |store|
begin
klass = store.load_class name
klasses << klass
extends << [klass.extends, store] if klass.extends
includes << [klass.includes, store] if klass.includes
[store, klass]
rescue RDoc::Store::MissingFileError
end
end.compact
extends.reject! do |modules,| modules.empty? end
includes.reject! do |modules,| modules.empty? end
[found, klasses, includes, extends]
end
##
# Completes +name+ based on the caches. For Readline
def complete name
completions = []
klass, selector, method = parse_name name
complete_klass name, klass, selector, method, completions
complete_method name, klass, selector, completions
completions.sort.uniq
end
def complete_klass name, klass, selector, method, completions # :nodoc:
klasses = classes.keys
# may need to include Foo when given Foo::
klass_name = method ? name : klass
if name !~ /#|\./ then
completions.replace klasses.grep(/^#{Regexp.escape klass_name}[^:]*$/)
completions.concat klasses.grep(/^#{Regexp.escape name}[^:]*$/) if
name =~ /::$/
completions << klass if classes.key? klass # to complete a method name
elsif selector then
completions << klass if classes.key? klass
elsif classes.key? klass_name then
completions << klass_name
end
end
def complete_method name, klass, selector, completions # :nodoc:
if completions.include? klass and name =~ /#|\.|::/ then
methods = list_methods_matching name
if not methods.empty? then
# remove Foo if given Foo:: and a method was found
completions.delete klass
elsif selector then
# replace Foo with Foo:: as given
completions.delete klass
completions << "#{klass}#{selector}"
end
completions.concat methods
end
end
##
# Converts +document+ to text and writes it to the pager
def display document
page do |io|
f = formatter(io)
f.width = @width if @width and f.respond_to?(:width)
text = document.accept f
io.write text
end
end
##
# Outputs formatted RI data for class +name+. Groups undocumented classes
def display_class name
return if name =~ /#|\./
found, klasses, includes, extends =
classes_and_includes_and_extends_for name
return if found.empty?
out = class_document name, found, klasses, includes, extends
display out
end
##
# Outputs formatted RI data for method +name+
def display_method name
out = RDoc::Markup::Document.new
add_method out, name
display out
end
##
# Outputs formatted RI data for the class or method +name+.
#
# Returns true if +name+ was found, false if it was not an alternative could
# be guessed, raises an error if +name+ couldn't be guessed.
def display_name name
if name =~ /\w:(\w|$)/ then
display_page name
return true
end
return true if display_class name
display_method name if name =~ /::|#|\./
true
rescue NotFoundError
matches = list_methods_matching name if name =~ /::|#|\./
matches = classes.keys.grep(/^#{Regexp.escape name}/) if matches.empty?
raise if matches.empty?
page do |io|
io.puts "#{name} not found, maybe you meant:"
io.puts
io.puts matches.sort.join("\n")
end
false
end
##
# Displays each name in +name+
def display_names names
names.each do |name|
name = expand_name name
display_name name
end
end
##
# Outputs formatted RI data for page +name+.
def display_page name
store_name, page_name = name.split ':', 2
store = @stores.find { |s| s.source == store_name }
return display_page_list store if page_name.empty?
pages = store.cache[:pages]
unless pages.include? page_name then
found_names = pages.select do |n|
n =~ /#{Regexp.escape page_name}\.[^.]+$/
end
if found_names.length.zero? then
return display_page_list store, pages
elsif found_names.length > 1 then
return display_page_list store, found_names, page_name
end
page_name = found_names.first
end
page = store.load_page page_name
display page.comment
end
##
# Outputs a formatted RI page list for the pages in +store+.
def display_page_list store, pages = store.cache[:pages], search = nil
out = RDoc::Markup::Document.new
title = if search then
"#{search} pages"
else
'Pages'
end
out << RDoc::Markup::Heading.new(1, "#{title} in #{store.friendly_path}")
out << RDoc::Markup::BlankLine.new
list = RDoc::Markup::List.new(:BULLET)
pages.each do |page|
list << RDoc::Markup::Paragraph.new(page)
end
out << list
display out
end
def check_did_you_mean # :nodoc:
if defined? DidYouMean::SpellChecker
true
else
begin
require 'did_you_mean'
if defined? DidYouMean::SpellChecker
true
else
false
end
rescue LoadError
false
end
end
end
##
# Expands abbreviated klass +klass+ into a fully-qualified class. "Zl::Da"
# will be expanded to Zlib::DataError.
def expand_class klass
class_names = classes.keys
ary = class_names.grep(Regexp.new("\\A#{klass.gsub(/(?=::|\z)/, '[^:]*')}\\z"))
if ary.length != 1 && ary.first != klass
if check_did_you_mean
suggestion_proc = -> { DidYouMean::SpellChecker.new(dictionary: class_names).correct(klass) }
raise NotFoundError.new(klass, suggestion_proc)
else
raise NotFoundError, klass
end
end
ary.first
end
##
# Expands the class portion of +name+ into a fully-qualified class. See
# #expand_class.
def expand_name name
klass, selector, method = parse_name name
return [selector, method].join if klass.empty?
case selector
when ':' then
[find_store(klass), selector, method]
else
[expand_class(klass), selector, method]
end.join
end
##
# Filters the methods in +found+ trying to find a match for +name+.
def filter_methods found, name
regexp = name_regexp name
filtered = found.find_all do |store, methods|
methods.any? { |method| method.full_name =~ regexp }
end
return filtered unless filtered.empty?
found
end
##
# Yields items matching +name+ including the store they were found in, the
# class being searched for, the class they were found in (an ancestor) the
# types of methods to look up (from #method_type), and the method name being
# searched for
def find_methods name
klass, selector, method = parse_name name
types = method_type selector
klasses = nil
ambiguous = klass.empty?
if ambiguous then
klasses = classes.keys
else
klasses = ancestors_of klass
klasses.unshift klass
end
methods = []
klasses.each do |ancestor|
ancestors = classes[ancestor]
next unless ancestors
klass = ancestor if ambiguous
ancestors.each do |store|
methods << [store, klass, ancestor, types, method]
end
end
methods = methods.sort_by do |_, k, a, _, m|
[k, a, m].compact
end
methods.each do |item|
yield(*item) # :yields: store, klass, ancestor, types, method
end
self
end
##
# Finds a store that matches +name+ which can be the name of a gem, "ruby",
# "home" or "site".
#
# See also RDoc::Store#source
def find_store name
@stores.each do |store|
source = store.source
return source if source == name
return source if
store.type == :gem and source =~ /^#{Regexp.escape name}-\d/
end
raise RDoc::RI::Driver::NotFoundError, name
end
##
# Creates a new RDoc::Markup::Formatter. If a formatter is given with -f,
# use it. If we're outputting to a pager, use bs, otherwise ansi.
def formatter(io)
if @formatter_klass then
@formatter_klass.new
elsif paging? or !io.tty? then
RDoc::Markup::ToBs.new
else
RDoc::Markup::ToAnsi.new
end
end
##
# Runs ri interactively using Readline if it is available.
def interactive
puts "\nEnter the method name you want to look up."
begin
require 'readline'
rescue LoadError
end
if defined? Readline then
Readline.completion_proc = method :complete
puts "You can use tab to autocomplete."
end
puts "Enter a blank line to exit.\n\n"
loop do
name = if defined? Readline then
Readline.readline ">> "
else
print ">> "
$stdin.gets
end
return if name.nil? or name.empty?
begin
display_name expand_name(name.strip)
rescue NotFoundError => e
puts e.message
end
end
rescue Interrupt
exit
end
##
# Lists classes known to ri starting with +names+. If +names+ is empty all
# known classes are shown.
def list_known_classes names = []
classes = []
stores.each do |store|
classes << store.module_names
end
classes = classes.flatten.uniq.sort
unless names.empty? then
filter = Regexp.union names.map { |name| /^#{name}/ }
classes = classes.grep filter
end
page do |io|
if paging? or io.tty? then
if names.empty? then
io.puts "Classes and Modules known to ri:"
else
io.puts "Classes and Modules starting with #{names.join ', '}:"
end
io.puts
end
io.puts classes.join("\n")
end
end
##
# Returns an Array of methods matching +name+
def list_methods_matching name
found = []
find_methods name do |store, klass, ancestor, types, method|
if types == :instance or types == :both then
methods = store.instance_methods[ancestor]
if methods then
matches = methods.grep(/^#{Regexp.escape method.to_s}/)
matches = matches.map do |match|
"#{klass}##{match}"
end
found.concat matches
end
end
if types == :class or types == :both then
methods = store.class_methods[ancestor]
next unless methods
matches = methods.grep(/^#{Regexp.escape method.to_s}/)
matches = matches.map do |match|
"#{klass}::#{match}"
end
found.concat matches
end
end
found.uniq
end
##
# Loads RI data for method +name+ on +klass+ from +store+. +type+ and
# +cache+ indicate if it is a class or instance method.
def load_method store, cache, klass, type, name
methods = store.public_send(cache)[klass]
return unless methods
method = methods.find do |method_name|
method_name == name
end
return unless method
store.load_method klass, "#{type}#{method}"
rescue RDoc::Store::MissingFileError => e
comment = RDoc::Comment.new("missing documentation at #{e.file}").parse
method = RDoc::AnyMethod.new nil, name
method.comment = comment
method
end
##
# Returns an Array of RI data for methods matching +name+
def load_methods_matching name
found = []
find_methods name do |store, klass, ancestor, types, method|
methods = []
methods << load_method(store, :class_methods, ancestor, '::', method) if
[:class, :both].include? types
methods << load_method(store, :instance_methods, ancestor, '#', method) if
[:instance, :both].include? types
found << [store, methods.compact]
end
found.reject do |path, methods| methods.empty? end
end
##
# Returns a filtered list of methods matching +name+
def lookup_method name
found = load_methods_matching name
if found.empty?
if check_did_you_mean
methods = []
_, _, method_name = parse_name name
find_methods name do |store, klass, ancestor, types, method|
methods.push(*store.class_methods[klass]) if [:class, :both].include? types
methods.push(*store.instance_methods[klass]) if [:instance, :both].include? types
end
methods = methods.uniq
suggestion_proc = -> { DidYouMean::SpellChecker.new(dictionary: methods).correct(method_name) }
raise NotFoundError.new(name, suggestion_proc)
else
raise NotFoundError, name
end
end
filter_methods found, name
end
##
# Builds a RDoc::Markup::Document from +found+, +klasses+ and +includes+
def method_document name, filtered
out = RDoc::Markup::Document.new
out << RDoc::Markup::Heading.new(1, name)
out << RDoc::Markup::BlankLine.new
filtered.each do |store, methods|
methods.each do |method|
render_method out, store, method, name
end
end
out
end
##
# Returns the type of method (:both, :instance, :class) for +selector+
def method_type selector
case selector
when '.', nil then :both
when '#' then :instance
else :class
end
end
##
# Returns a regular expression for +name+ that will match an
# RDoc::AnyMethod's name.
def name_regexp name
klass, type, name = parse_name name
case type
when '#', '::' then
/^#{klass}#{type}#{Regexp.escape name}$/
else
/^#{klass}(#|::)#{Regexp.escape name}$/
end
end
##
# Paginates output through a pager program.
def page
if pager = setup_pager then
begin
yield pager
ensure
pager.close
end
else
yield $stdout
end
rescue Errno::EPIPE
ensure
@paging = false
end
##
# Are we using a pager?
def paging?
@paging
end
##
# Extracts the class, selector and method name parts from +name+ like
# Foo::Bar#baz.
#
# NOTE: Given Foo::Bar, Bar is considered a class even though it may be a
# method
def parse_name name
parts = name.split(/(::?|#|\.)/)
if parts.length == 1 then
if parts.first =~ /^[a-z]|^([%&*+\/<>^`|~-]|\+@|-@|<<|<=>?|===?|=>|=~|>>|\[\]=?|~@)$/ then
type = '.'
meth = parts.pop
else
type = nil
meth = nil
end
elsif parts.length == 2 or parts.last =~ /::|#|\./ then
type = parts.pop
meth = nil
elsif parts[1] == ':' then
klass = parts.shift
type = parts.shift
meth = parts.join
elsif parts[-2] != '::' or parts.last !~ /^[A-Z]/ then
meth = parts.pop
type = parts.pop
end
klass ||= parts.join
[klass, type, meth]
end
##
# Renders the +klass+ from +store+ to +out+. If the klass has no
# documentable items the class is added to +also_in+ instead.
def render_class out, store, klass, also_in # :nodoc:
comment = klass.comment
# TODO the store's cache should always return an empty Array
class_methods = store.class_methods[klass.full_name] || []
instance_methods = store.instance_methods[klass.full_name] || []
attributes = store.attributes[klass.full_name] || []
if comment.empty? and
instance_methods.empty? and class_methods.empty? then
also_in << store
return
end
add_from out, store
class_document_comment out, comment
if class_methods or instance_methods or not klass.constants.empty? then
out << RDoc::Markup::Rule.new(1)
end
class_document_constants out, klass
add_method_list out, class_methods, 'Class methods'
add_method_list out, instance_methods, 'Instance methods'
add_method_list out, attributes, 'Attributes'
add_method_documentation out, klass if @show_all
end
def render_method out, store, method, name # :nodoc:
out << RDoc::Markup::Paragraph.new("(from #{store.friendly_path})")
unless name =~ /^#{Regexp.escape method.parent_name}/ then
out << RDoc::Markup::Heading.new(3, "Implementation from #{method.parent_name}")
end
out << RDoc::Markup::Rule.new(1)
render_method_arguments out, method.arglists
render_method_superclass out, method
if method.is_alias_for
al = method.is_alias_for
alias_for = store.load_method al.parent_name, "#{al.name_prefix}#{al.name}"
render_method_comment out, method, alias_for
else
render_method_comment out, method
end
end
def render_method_arguments out, arglists # :nodoc:
return unless arglists
arglists = arglists.chomp.split "\n"
arglists = arglists.map { |line| line + "\n" }
out << RDoc::Markup::Verbatim.new(*arglists)
out << RDoc::Markup::Rule.new(1)
end
def render_method_comment out, method, alias_for = nil# :nodoc:
if alias_for
unless method.comment.nil? or method.comment.empty?
out << RDoc::Markup::BlankLine.new
out << method.comment
end
out << RDoc::Markup::BlankLine.new
out << RDoc::Markup::Paragraph.new("(This method is an alias for #{alias_for.full_name}.)")
out << RDoc::Markup::BlankLine.new
out << alias_for.comment
out << RDoc::Markup::BlankLine.new
else
out << RDoc::Markup::BlankLine.new
out << method.comment
out << RDoc::Markup::BlankLine.new
end
end
def render_method_superclass out, method # :nodoc:
return unless
method.respond_to?(:superclass_method) and method.superclass_method
out << RDoc::Markup::BlankLine.new
out << RDoc::Markup::Heading.new(4, "(Uses superclass method #{method.superclass_method})")
out << RDoc::Markup::Rule.new(1)
end
##
# Looks up and displays ri data according to the options given.
def run
if @list_doc_dirs then
puts @doc_dirs
elsif @list then
list_known_classes @names
elsif @server then
start_server
elsif @interactive or @names.empty? then
interactive
else
display_names @names
end
rescue NotFoundError => e
abort e.message
end
##
# Sets up a pager program to pass output through. Tries the RI_PAGER and
# PAGER environment variables followed by pager, less then more.
def setup_pager
return if @use_stdout
pagers = [ENV['RI_PAGER'], ENV['PAGER'], 'pager', 'less', 'more']
require 'shellwords'
pagers.compact.uniq.each do |pager|
pager = Shellwords.split(pager)
next if pager.empty?
io = IO.popen(pager, 'w') rescue next
next if $? and $?.pid == io.pid and $?.exited? # pager didn't work
@paging = true
return io
end
@use_stdout = true
nil
end
##
# Starts a WEBrick server for ri.
def start_server
begin
require 'webrick'
rescue LoadError
abort "webrick is not found. You may need to `gem install webrick` to install webrick."
end
server = WEBrick::HTTPServer.new :Port => @server
extra_doc_dirs = @stores.map {|s| s.type == :extra ? s.path : nil}.compact
server.mount '/', RDoc::Servlet, nil, extra_doc_dirs
trap 'INT' do server.shutdown end
trap 'TERM' do server.shutdown end
server.start
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/ri/store.rb 0000644 00000000124 15173517747 0015100 0 ustar 00 # frozen_string_literal: true
module RDoc::RI
Store = RDoc::Store # :nodoc:
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/ri/formatter.rb 0000644 00000000162 15173517747 0015751 0 ustar 00 # frozen_string_literal: true
##
# For RubyGems backwards compatibility
module RDoc::RI::Formatter # :nodoc:
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/ri/task.rb 0000644 00000002475 15173517747 0014721 0 ustar 00 # frozen_string_literal: true
begin
gem 'rdoc'
rescue Gem::LoadError
end unless defined?(RDoc)
require_relative '../task'
##
# RDoc::RI::Task creates ri data in <code>./.rdoc</code> for your project.
#
# It contains the following tasks:
#
# [ri]
# Build ri data
#
# [clobber_ri]
# Delete ri data files. This target is automatically added to the main
# clobber target.
#
# [reri]
# Rebuild the ri data from scratch even if they are not out of date.
#
# Simple example:
#
# require 'rdoc/ri/task'
#
# RDoc::RI::Task.new do |ri|
# ri.main = 'README.rdoc'
# ri.rdoc_files.include 'README.rdoc', 'lib/**/*.rb'
# end
#
# For further configuration details see RDoc::Task.
class RDoc::RI::Task < RDoc::Task
DEFAULT_NAMES = { # :nodoc:
:clobber_rdoc => :clobber_ri,
:rdoc => :ri,
:rerdoc => :reri,
}
##
# Create an ri task with the given name. See RDoc::Task for documentation on
# setting names.
def initialize name = DEFAULT_NAMES # :yield: self
super
end
def clobber_task_description # :nodoc:
"Remove RI data files"
end
##
# Sets default task values
def defaults
super
@rdoc_dir = '.rdoc'
end
def rdoc_task_description # :nodoc:
'Build RI data files'
end
def rerdoc_task_description # :nodoc:
'Rebuild RI data files'
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/text.rb 0000644 00000017560 15173517747 0014332 0 ustar 00 # frozen_string_literal: true
##
# For RDoc::Text#to_html
require 'strscan'
##
# Methods for manipulating comment text
module RDoc::Text
##
# The language for this text. This affects stripping comments
# markers.
attr_accessor :language
##
# Maps markup formats to classes that can parse them. If the format is
# unknown, "rdoc" format is used.
MARKUP_FORMAT = {
'markdown' => RDoc::Markdown,
'rdoc' => RDoc::Markup,
'rd' => RDoc::RD,
'tomdoc' => RDoc::TomDoc,
}
MARKUP_FORMAT.default = RDoc::Markup
##
# Maps an encoding to a Hash of characters properly transcoded for that
# encoding.
#
# See also encode_fallback.
TO_HTML_CHARACTERS = Hash.new do |h, encoding|
h[encoding] = {
:close_dquote => encode_fallback('”', encoding, '"'),
:close_squote => encode_fallback('’', encoding, '\''),
:copyright => encode_fallback('©', encoding, '(c)'),
:ellipsis => encode_fallback('…', encoding, '...'),
:em_dash => encode_fallback('—', encoding, '---'),
:en_dash => encode_fallback('–', encoding, '--'),
:open_dquote => encode_fallback('“', encoding, '"'),
:open_squote => encode_fallback('‘', encoding, '\''),
:trademark => encode_fallback('®', encoding, '(r)'),
}
end
##
# Transcodes +character+ to +encoding+ with a +fallback+ character.
def self.encode_fallback character, encoding, fallback
character.encode(encoding, :fallback => { character => fallback },
:undef => :replace, :replace => fallback)
end
##
# Expands tab characters in +text+ to eight spaces
def expand_tabs text
expanded = []
text.each_line do |line|
nil while line.gsub!(/(?:\G|\r)((?:.{8})*?)([^\t\r\n]{0,7})\t/) do
r = "#{$1}#{$2}#{' ' * (8 - $2.size)}"
r = RDoc::Encoding.change_encoding r, text.encoding
r
end
expanded << line
end
expanded.join
end
##
# Flush +text+ left based on the shortest line
def flush_left text
indent = 9999
text.each_line do |line|
line_indent = line =~ /\S/ || 9999
indent = line_indent if indent > line_indent
end
empty = ''
empty = RDoc::Encoding.change_encoding empty, text.encoding
text.gsub(/^ {0,#{indent}}/, empty)
end
##
# Convert a string in markup format into HTML.
#
# Requires the including class to implement #formatter
def markup text
if @store.rdoc.options
locale = @store.rdoc.options.locale
else
locale = nil
end
if locale
i18n_text = RDoc::I18n::Text.new(text)
text = i18n_text.translate(locale)
end
parse(text).accept formatter
end
##
# Strips hashes, expands tabs then flushes +text+ to the left
def normalize_comment text
return text if text.empty?
case language
when :ruby
text = strip_hashes text
when :c
text = strip_stars text
end
text = expand_tabs text
text = flush_left text
text = strip_newlines text
text
end
##
# Normalizes +text+ then builds a RDoc::Markup::Document from it
def parse text, format = 'rdoc'
return text if RDoc::Markup::Document === text
return text.parse if RDoc::Comment === text
text = normalize_comment text # TODO remove, should not be necessary
return RDoc::Markup::Document.new if text =~ /\A\n*\z/
MARKUP_FORMAT[format].parse text
end
##
# The first +limit+ characters of +text+ as HTML
def snippet text, limit = 100
document = parse text
RDoc::Markup::ToHtmlSnippet.new(options, limit).convert document
end
##
# Strips leading # characters from +text+
def strip_hashes text
return text if text =~ /^(?>\s*)[^\#]/
empty = ''
empty = RDoc::Encoding.change_encoding empty, text.encoding
text.gsub(/^\s*(#+)/) { $1.tr '#', ' ' }.gsub(/^\s+$/, empty)
end
##
# Strips leading and trailing \n characters from +text+
def strip_newlines text
text.gsub(/\A\n*(.*?)\n*\z/m) do $1 end # block preserves String encoding
end
##
# Strips /* */ style comments
def strip_stars text
return text unless text =~ %r%/\*.*\*/%m
encoding = text.encoding
text = text.gsub %r%Document-method:\s+[\w:.#=!?|^&<>~+\-/*\%@`\[\]]+%, ''
space = ' '
space = RDoc::Encoding.change_encoding space, encoding if encoding
text.sub! %r%/\*+% do space * $&.length end
text.sub! %r%\*+/% do space * $&.length end
text.gsub! %r%^[ \t]*\*%m do space * $&.length end
empty = ''
empty = RDoc::Encoding.change_encoding empty, encoding if encoding
text.gsub(/^\s+$/, empty)
end
##
# Converts ampersand, dashes, ellipsis, quotes, copyright and registered
# trademark symbols in +text+ to properly encoded characters.
def to_html text
html = (''.encode text.encoding).dup
encoded = RDoc::Text::TO_HTML_CHARACTERS[text.encoding]
s = StringScanner.new text
insquotes = false
indquotes = false
after_word = nil
until s.eos? do
case
when s.scan(/<(tt|code)>.*?<\/\1>/) then # skip contents of tt
html << s.matched.gsub('\\\\', '\\')
when s.scan(/<(tt|code)>.*?/) then
warn "mismatched <#{s[1]}> tag" # TODO signal file/line
html << s.matched
when s.scan(/<[^>]+\/?s*>/) then # skip HTML tags
html << s.matched
when s.scan(/\\(\S)/) then # unhandled suppressed crossref
html << s[1]
after_word = nil
when s.scan(/\.\.\.(\.?)/) then
html << s[1] << encoded[:ellipsis]
after_word = nil
when s.scan(/\(c\)/i) then
html << encoded[:copyright]
after_word = nil
when s.scan(/\(r\)/i) then
html << encoded[:trademark]
after_word = nil
when s.scan(/---/) then
html << encoded[:em_dash]
after_word = nil
when s.scan(/--/) then
html << encoded[:en_dash]
after_word = nil
when s.scan(/"|"/) then
html << encoded[indquotes ? :close_dquote : :open_dquote]
indquotes = !indquotes
after_word = nil
when s.scan(/``/) then # backtick double quote
html << encoded[:open_dquote]
after_word = nil
when s.scan(/(?:'|'){2}/) then # tick double quote
html << encoded[:close_dquote]
after_word = nil
when s.scan(/`/) then # backtick
if insquotes or after_word
html << '`'
after_word = false
else
html << encoded[:open_squote]
insquotes = true
end
when s.scan(/'|'/) then # single quote
if insquotes
html << encoded[:close_squote]
insquotes = false
elsif after_word
# Mary's dog, my parents' house: do not start paired quotes
html << encoded[:close_squote]
else
html << encoded[:open_squote]
insquotes = true
end
after_word = nil
else # advance to the next potentially significant character
match = s.scan(/.+?(?=[<\\.("'`&-])/) #"
if match then
html << match
after_word = match =~ /\w$/
else
html << s.rest
break
end
end
end
html
end
##
# Wraps +txt+ to +line_len+
def wrap(txt, line_len = 76)
res = []
sp = 0
ep = txt.length
while sp < ep
# scan back for a space
p = sp + line_len - 1
if p >= ep
p = ep
else
while p > sp and txt[p] != ?\s
p -= 1
end
if p <= sp
p = sp + line_len
while p < ep and txt[p] != ?\s
p += 1
end
end
end
res << txt[sp...p] << "\n"
sp = p
sp += 1 while sp < ep and txt[sp] == ?\s
end
res.join.strip
end
##
# Character class to be separated by a space when concatenating
# lines.
SPACE_SEPARATED_LETTER_CLASS = /[\p{Nd}\p{Lc}\p{Pc}]|[!-~&&\W]/
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/constant.rb 0000644 00000007134 15173517747 0015173 0 ustar 00 # frozen_string_literal: true
##
# A constant
class RDoc::Constant < RDoc::CodeObject
MARSHAL_VERSION = 0 # :nodoc:
##
# Sets the module or class this is constant is an alias for.
attr_writer :is_alias_for
##
# The constant's name
attr_accessor :name
##
# The constant's value
attr_accessor :value
##
# The constant's visibility
attr_accessor :visibility
##
# Creates a new constant with +name+, +value+ and +comment+
def initialize(name, value, comment)
super()
@name = name
@value = value
@is_alias_for = nil
@visibility = :public
self.comment = comment
end
##
# Constants are ordered by name
def <=> other
return unless self.class === other
[parent_name, name] <=> [other.parent_name, other.name]
end
##
# Constants are equal when their #parent and #name is the same
def == other
self.class == other.class and
@parent == other.parent and
@name == other.name
end
##
# A constant is documented if it has a comment, or is an alias
# for a documented class or module.
def documented?
return true if super
return false unless @is_alias_for
case @is_alias_for
when String then
found = @store.find_class_or_module @is_alias_for
return false unless found
@is_alias_for = found
end
@is_alias_for.documented?
end
##
# Full constant name including namespace
def full_name
@full_name ||= "#{parent_name}::#{@name}"
end
##
# The module or class this constant is an alias for
def is_alias_for
case @is_alias_for
when String then
found = @store.find_class_or_module @is_alias_for
@is_alias_for = found if found
@is_alias_for
else
@is_alias_for
end
end
def inspect # :nodoc:
"#<%s:0x%x %s::%s>" % [
self.class, object_id,
parent_name, @name,
]
end
##
# Dumps this Constant for use by ri. See also #marshal_load
def marshal_dump
alias_name = case found = is_alias_for
when RDoc::CodeObject then found.full_name
else found
end
[ MARSHAL_VERSION,
@name,
full_name,
@visibility,
alias_name,
parse(@comment),
@file.relative_name,
parent.name,
parent.class,
section.title,
]
end
##
# Loads this Constant from +array+. For a loaded Constant the following
# methods will return cached values:
#
# * #full_name
# * #parent_name
def marshal_load array
initialize array[1], nil, array[5]
@full_name = array[2]
@visibility = array[3] || :public
@is_alias_for = array[4]
# 5 handled above
# 6 handled below
@parent_name = array[7]
@parent_class = array[8]
@section_title = array[9]
@file = RDoc::TopLevel.new array[6]
end
##
# Path to this constant for use with HTML generator output.
def path
"#{@parent.path}##{@name}"
end
def pretty_print q # :nodoc:
q.group 2, "[#{self.class.name} #{full_name}", "]" do
unless comment.empty? then
q.breakable
q.text "comment:"
q.breakable
q.pp @comment
end
end
end
##
# Sets the store for this class or module and its contained code objects.
def store= store
super
@file = @store.add_file @file.full_name if @file
end
def to_s # :nodoc:
parent_name = parent ? parent.full_name : '(unknown)'
if is_alias_for
"constant #{parent_name}::#@name -> #{is_alias_for}"
else
"constant #{parent_name}::#@name"
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/top_level.rb 0000644 00000013161 15173517747 0015330 0 ustar 00 # frozen_string_literal: true
##
# A TopLevel context is a representation of the contents of a single file
class RDoc::TopLevel < RDoc::Context
MARSHAL_VERSION = 0 # :nodoc:
##
# This TopLevel's File::Stat struct
attr_accessor :file_stat
##
# Relative name of this file
attr_accessor :relative_name
##
# Absolute name of this file
attr_accessor :absolute_name
##
# All the classes or modules that were declared in
# this file. These are assigned to either +#classes_hash+
# or +#modules_hash+ once we know what they really are.
attr_reader :classes_or_modules
attr_accessor :diagram # :nodoc:
##
# The parser class that processed this file
attr_reader :parser
##
# Creates a new TopLevel for the file at +absolute_name+. If documentation
# is being generated outside the source dir +relative_name+ is relative to
# the source directory.
def initialize absolute_name, relative_name = absolute_name
super()
@name = nil
@absolute_name = absolute_name
@relative_name = relative_name
@file_stat = File.stat(absolute_name) rescue nil # HACK for testing
@diagram = nil
@parser = nil
@classes_or_modules = []
end
##
# Sets the parser for this toplevel context, also the store.
def parser=(val)
@parser = val
@store.update_parser_of_file(absolute_name, val) if @store
@parser
end
##
# An RDoc::TopLevel is equal to another with the same relative_name
def == other
self.class === other and @relative_name == other.relative_name
end
alias eql? ==
##
# Adds +an_alias+ to +Object+ instead of +self+.
def add_alias(an_alias)
object_class.record_location self
return an_alias unless @document_self
object_class.add_alias an_alias
end
##
# Adds +constant+ to +Object+ instead of +self+.
def add_constant constant
object_class.record_location self
return constant unless @document_self
object_class.add_constant constant
end
##
# Adds +include+ to +Object+ instead of +self+.
def add_include(include)
object_class.record_location self
return include unless @document_self
object_class.add_include include
end
##
# Adds +method+ to +Object+ instead of +self+.
def add_method(method)
object_class.record_location self
return method unless @document_self
object_class.add_method method
end
##
# Adds class or module +mod+. Used in the building phase
# by the Ruby parser.
def add_to_classes_or_modules mod
@classes_or_modules << mod
end
##
# Base name of this file
def base_name
File.basename @relative_name
end
alias name base_name
##
# Only a TopLevel that contains text file) will be displayed. See also
# RDoc::CodeObject#display?
def display?
text? and super
end
##
# See RDoc::TopLevel::find_class_or_module
#--
# TODO Why do we search through all classes/modules found, not just the
# ones of this instance?
def find_class_or_module name
@store.find_class_or_module name
end
##
# Finds a class or module named +symbol+
def find_local_symbol(symbol)
find_class_or_module(symbol) || super
end
##
# Finds a module or class with +name+
def find_module_named(name)
find_class_or_module(name)
end
##
# Returns the relative name of this file
def full_name
@relative_name
end
##
# An RDoc::TopLevel has the same hash as another with the same
# relative_name
def hash
@relative_name.hash
end
##
# URL for this with a +prefix+
def http_url(prefix)
path = [prefix, @relative_name.tr('.', '_')]
File.join(*path.compact) + '.html'
end
def inspect # :nodoc:
"#<%s:0x%x %p modules: %p classes: %p>" % [
self.class, object_id,
base_name,
@modules.map { |n,m| m },
@classes.map { |n,c| c }
]
end
##
# Time this file was last modified, if known
def last_modified
@file_stat ? file_stat.mtime : nil
end
##
# Dumps this TopLevel for use by ri. See also #marshal_load
def marshal_dump
[
MARSHAL_VERSION,
@relative_name,
@parser,
parse(@comment),
]
end
##
# Loads this TopLevel from +array+.
def marshal_load array # :nodoc:
initialize array[1]
@parser = array[2]
@comment = array[3]
@file_stat = nil
end
##
# Returns the NormalClass "Object", creating it if not found.
#
# Records +self+ as a location in "Object".
def object_class
@object_class ||= begin
oc = @store.find_class_named('Object') || add_class(RDoc::NormalClass, 'Object')
oc.record_location self
oc
end
end
##
# Base name of this file without the extension
def page_name
basename = File.basename @relative_name
basename =~ /\.(rb|rdoc|txt|md)$/i
$` || basename
end
##
# Path to this file for use with HTML generator output.
def path
http_url @store.rdoc.generator.file_dir
end
def pretty_print q # :nodoc:
q.group 2, "[#{self.class}: ", "]" do
q.text "base name: #{base_name.inspect}"
q.breakable
items = @modules.map { |n,m| m }
items.concat @modules.map { |n,c| c }
q.seplist items do |mod| q.pp mod end
end
end
##
# Search record used by RDoc::Generator::JsonIndex
def search_record
return unless @parser < RDoc::Parser::Text
[
page_name,
'',
page_name,
'',
path,
'',
snippet(@comment),
]
end
##
# Is this TopLevel from a text file instead of a source code file?
def text?
@parser and @parser.include? RDoc::Parser::Text
end
def to_s # :nodoc:
"file #{full_name}"
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/i18n.rb 0000644 00000000264 15173517747 0014116 0 ustar 00 # frozen_string_literal: true
##
# This module provides i18n related features.
module RDoc::I18n
autoload :Locale, "#{__dir__}/i18n/locale"
require_relative 'i18n/text'
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/stats.rb 0000644 00000024772 15173517747 0014507 0 ustar 00 # frozen_string_literal: true
##
# RDoc statistics collector which prints a summary and report of a project's
# documentation totals.
class RDoc::Stats
include RDoc::Text
##
# Output level for the coverage report
attr_reader :coverage_level
##
# Count of files parsed during parsing
attr_reader :files_so_far
##
# Total number of files found
attr_reader :num_files
##
# Creates a new Stats that will have +num_files+. +verbosity+ defaults to 1
# which will create an RDoc::Stats::Normal outputter.
def initialize store, num_files, verbosity = 1
@num_files = num_files
@store = store
@coverage_level = 0
@doc_items = nil
@files_so_far = 0
@fully_documented = false
@num_params = 0
@percent_doc = nil
@start = Time.now
@undoc_params = 0
@display = case verbosity
when 0 then Quiet.new num_files
when 1 then Normal.new num_files
else Verbose.new num_files
end
end
##
# Records the parsing of an alias +as+.
def add_alias as
@display.print_alias as
end
##
# Records the parsing of an attribute +attribute+
def add_attribute attribute
@display.print_attribute attribute
end
##
# Records the parsing of a class +klass+
def add_class klass
@display.print_class klass
end
##
# Records the parsing of +constant+
def add_constant constant
@display.print_constant constant
end
##
# Records the parsing of +file+
def add_file(file)
@files_so_far += 1
@display.print_file @files_so_far, file
end
##
# Records the parsing of +method+
def add_method(method)
@display.print_method method
end
##
# Records the parsing of a module +mod+
def add_module(mod)
@display.print_module mod
end
##
# Call this to mark the beginning of parsing for display purposes
def begin_adding
@display.begin_adding
end
##
# Calculates documentation totals and percentages for classes, modules,
# constants, attributes and methods.
def calculate
return if @doc_items
ucm = @store.unique_classes_and_modules
classes = @store.unique_classes.reject { |cm| cm.full_name == 'Object' }
constants = []
ucm.each { |cm| constants.concat cm.constants }
methods = []
ucm.each { |cm| methods.concat cm.method_list }
attributes = []
ucm.each { |cm| attributes.concat cm.attributes }
@num_attributes, @undoc_attributes = doc_stats attributes
@num_classes, @undoc_classes = doc_stats classes
@num_constants, @undoc_constants = doc_stats constants
@num_methods, @undoc_methods = doc_stats methods
@num_modules, @undoc_modules = doc_stats @store.unique_modules
@num_items =
@num_attributes +
@num_classes +
@num_constants +
@num_methods +
@num_modules +
@num_params
@undoc_items =
@undoc_attributes +
@undoc_classes +
@undoc_constants +
@undoc_methods +
@undoc_modules +
@undoc_params
@doc_items = @num_items - @undoc_items
end
##
# Sets coverage report level. Accepted values are:
#
# false or nil:: No report
# 0:: Classes, modules, constants, attributes, methods
# 1:: Level 0 + method parameters
def coverage_level= level
level = -1 unless level
@coverage_level = level
end
##
# Returns the length and number of undocumented items in +collection+.
def doc_stats collection
visible = collection.select { |item| item.display? }
[visible.length, visible.count { |item| not item.documented? }]
end
##
# Call this to mark the end of parsing for display purposes
def done_adding
@display.done_adding
end
##
# The documentation status of this project. +true+ when 100%, +false+ when
# less than 100% and +nil+ when unknown.
#
# Set by calling #calculate
def fully_documented?
@fully_documented
end
##
# A report that says you did a great job!
def great_job
report = RDoc::Markup::Document.new
report << RDoc::Markup::Paragraph.new('100% documentation!')
report << RDoc::Markup::Paragraph.new('Great Job!')
report
end
##
# Calculates the percentage of items documented.
def percent_doc
return @percent_doc if @percent_doc
@fully_documented = (@num_items - @doc_items) == 0
@percent_doc = @doc_items.to_f / @num_items * 100 if @num_items.nonzero?
@percent_doc ||= 0
@percent_doc
end
##
# Returns a report on which items are not documented
def report
if @coverage_level > 0 then
extend RDoc::Text
end
if @coverage_level.zero? then
calculate
return great_job if @num_items == @doc_items
end
ucm = @store.unique_classes_and_modules
report = RDoc::Markup::Document.new
report << RDoc::Markup::Paragraph.new('The following items are not documented:')
report << RDoc::Markup::BlankLine.new
ucm.sort.each do |cm|
body = report_class_module(cm) {
[
report_constants(cm),
report_attributes(cm),
report_methods(cm),
].compact
}
report << body if body
end
if @coverage_level > 0 then
calculate
return great_job if @num_items == @doc_items
end
report
end
##
# Returns a report on undocumented attributes in ClassModule +cm+
def report_attributes cm
return if cm.attributes.empty?
report = []
cm.each_attribute do |attr|
next if attr.documented?
line = attr.line ? ":#{attr.line}" : nil
report << " #{attr.definition} :#{attr.name} # in file #{attr.file.full_name}#{line}\n"
report << "\n"
end
report
end
##
# Returns a report on undocumented items in ClassModule +cm+
def report_class_module cm
return if cm.fully_documented? and @coverage_level.zero?
return unless cm.display?
report = RDoc::Markup::Document.new
if cm.in_files.empty? then
report << RDoc::Markup::Paragraph.new("#{cm.definition} is referenced but empty.")
report << RDoc::Markup::Paragraph.new("It probably came from another project. I'm sorry I'm holding it against you.")
return report
elsif cm.documented? then
documented = true
klass = RDoc::Markup::Verbatim.new("#{cm.definition} # is documented\n")
else
report << RDoc::Markup::Paragraph.new('In files:')
list = RDoc::Markup::List.new :BULLET
cm.in_files.each do |file|
para = RDoc::Markup::Paragraph.new file.full_name
list << RDoc::Markup::ListItem.new(nil, para)
end
report << list
report << RDoc::Markup::BlankLine.new
klass = RDoc::Markup::Verbatim.new("#{cm.definition}\n")
end
klass << "\n"
body = yield.flatten # HACK remove #flatten
if body.empty? then
return if documented
klass.parts.pop
else
klass.parts.concat body
end
klass << "end\n"
report << klass
report
end
##
# Returns a report on undocumented constants in ClassModule +cm+
def report_constants cm
return if cm.constants.empty?
report = []
cm.each_constant do |constant|
# TODO constant aliases are listed in the summary but not reported
# figure out what to do here
next if constant.documented? || constant.is_alias_for
line = constant.line ? ":#{constant.line}" : line
report << " # in file #{constant.file.full_name}#{line}\n"
report << " #{constant.name} = nil\n"
report << "\n"
end
report
end
##
# Returns a report on undocumented methods in ClassModule +cm+
def report_methods cm
return if cm.method_list.empty?
report = []
cm.each_method do |method|
next if method.documented? and @coverage_level.zero?
if @coverage_level > 0 then
params, undoc = undoc_params method
@num_params += params
unless undoc.empty? then
@undoc_params += undoc.length
undoc = undoc.map do |param| "+#{param}+" end
param_report = " # #{undoc.join ', '} is not documented\n"
end
end
next if method.documented? and not param_report
line = method.line ? ":#{method.line}" : nil
scope = method.singleton ? 'self.' : nil
report << " # in file #{method.file.full_name}#{line}\n"
report << param_report if param_report
report << " def #{scope}#{method.name}#{method.params}; end\n"
report << "\n"
end
report
end
##
# Returns a summary of the collected statistics.
def summary
calculate
num_width = [@num_files, @num_items].max.to_s.length
undoc_width = [
@undoc_attributes,
@undoc_classes,
@undoc_constants,
@undoc_items,
@undoc_methods,
@undoc_modules,
@undoc_params,
].max.to_s.length
report = RDoc::Markup::Verbatim.new
report << "Files: %*d\n" % [num_width, @num_files]
report << "\n"
report << "Classes: %*d (%*d undocumented)\n" % [
num_width, @num_classes, undoc_width, @undoc_classes]
report << "Modules: %*d (%*d undocumented)\n" % [
num_width, @num_modules, undoc_width, @undoc_modules]
report << "Constants: %*d (%*d undocumented)\n" % [
num_width, @num_constants, undoc_width, @undoc_constants]
report << "Attributes: %*d (%*d undocumented)\n" % [
num_width, @num_attributes, undoc_width, @undoc_attributes]
report << "Methods: %*d (%*d undocumented)\n" % [
num_width, @num_methods, undoc_width, @undoc_methods]
report << "Parameters: %*d (%*d undocumented)\n" % [
num_width, @num_params, undoc_width, @undoc_params] if
@coverage_level > 0
report << "\n"
report << "Total: %*d (%*d undocumented)\n" % [
num_width, @num_items, undoc_width, @undoc_items]
report << "%6.2f%% documented\n" % percent_doc
report << "\n"
report << "Elapsed: %0.1fs\n" % (Time.now - @start)
RDoc::Markup::Document.new report
end
##
# Determines which parameters in +method+ were not documented. Returns a
# total parameter count and an Array of undocumented methods.
def undoc_params method
@formatter ||= RDoc::Markup::ToTtOnly.new
params = method.param_list
params = params.map { |param| param.gsub(/^\*\*?/, '') }
return 0, [] if params.empty?
document = parse method.comment
tts = document.accept @formatter
undoc = params - tts
[params.length, undoc]
end
autoload :Quiet, "#{__dir__}/stats/quiet"
autoload :Normal, "#{__dir__}/stats/normal"
autoload :Verbose, "#{__dir__}/stats/verbose"
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/attr.rb 0000644 00000007410 15173517747 0014311 0 ustar 00 # frozen_string_literal: true
##
# An attribute created by \#attr, \#attr_reader, \#attr_writer or
# \#attr_accessor
class RDoc::Attr < RDoc::MethodAttr
##
# 3::
# RDoc 4
# Added parent name and class
# Added section title
MARSHAL_VERSION = 3 # :nodoc:
##
# Is the attribute readable ('R'), writable ('W') or both ('RW')?
attr_accessor :rw
##
# Creates a new Attr with body +text+, +name+, read/write status +rw+ and
# +comment+. +singleton+ marks this as a class attribute.
def initialize(text, name, rw, comment, singleton = false)
super text, name
@rw = rw
@singleton = singleton
self.comment = comment
end
##
# Attributes are equal when their names, singleton and rw are identical
def == other
self.class == other.class and
self.name == other.name and
self.rw == other.rw and
self.singleton == other.singleton
end
##
# Add +an_alias+ as an attribute in +context+.
def add_alias(an_alias, context)
new_attr = self.class.new(self.text, an_alias.new_name, self.rw,
self.comment, self.singleton)
new_attr.record_location an_alias.file
new_attr.visibility = self.visibility
new_attr.is_alias_for = self
@aliases << new_attr
context.add_attribute new_attr
new_attr
end
##
# The #aref prefix for attributes
def aref_prefix
'attribute'
end
##
# Attributes never call super. See RDoc::AnyMethod#calls_super
#
# An RDoc::Attr can show up in the method list in some situations (see
# Gem::ConfigFile)
def calls_super # :nodoc:
false
end
##
# Returns attr_reader, attr_writer or attr_accessor as appropriate.
def definition
case @rw
when 'RW' then 'attr_accessor'
when 'R' then 'attr_reader'
when 'W' then 'attr_writer'
end
end
def inspect # :nodoc:
alias_for = @is_alias_for ? " (alias for #{@is_alias_for.name})" : nil
visibility = self.visibility
visibility = "forced #{visibility}" if force_documentation
"#<%s:0x%x %s %s (%s)%s>" % [
self.class, object_id,
full_name,
rw,
visibility,
alias_for,
]
end
##
# Dumps this Attr for use by ri. See also #marshal_load
def marshal_dump
[ MARSHAL_VERSION,
@name,
full_name,
@rw,
@visibility,
parse(@comment),
singleton,
@file.relative_name,
@parent.full_name,
@parent.class,
@section.title
]
end
##
# Loads this Attr from +array+. For a loaded Attr the following
# methods will return cached values:
#
# * #full_name
# * #parent_name
def marshal_load array
initialize_visibility
@aliases = []
@parent = nil
@parent_name = nil
@parent_class = nil
@section = nil
@file = nil
version = array[0]
@name = array[1]
@full_name = array[2]
@rw = array[3]
@visibility = array[4]
@comment = array[5]
@singleton = array[6] || false # MARSHAL_VERSION == 0
# 7 handled below
@parent_name = array[8]
@parent_class = array[9]
@section_title = array[10]
@file = RDoc::TopLevel.new array[7] if version > 1
@parent_name ||= @full_name.split('#', 2).first
end
def pretty_print q # :nodoc:
q.group 2, "[#{self.class.name} #{full_name} #{rw} #{visibility}", "]" do
unless comment.empty? then
q.breakable
q.text "comment:"
q.breakable
q.pp @comment
end
end
end
def to_s # :nodoc:
"#{definition} #{name} in: #{parent}"
end
##
# Attributes do not have token streams.
#
# An RDoc::Attr can show up in the method list in some situations (see
# Gem::ConfigFile)
def token_stream # :nodoc:
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markdown.rb 0000644 00001412356 15173517747 0015173 0 ustar 00 # coding: UTF-8
# frozen_string_literal: true
# :markup: markdown
##
# RDoc::Markdown as described by the [markdown syntax][syntax].
#
# To choose Markdown as your only default format see
# RDoc::Options@Saved+Options for instructions on setting up a `.doc_options`
# file to store your project default.
#
# ## Usage
#
# Here is a brief example of using this parse to read a markdown file by hand.
#
# data = File.read("README.md")
# formatter = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)
# html = RDoc::Markdown.parse(data).accept(formatter)
#
# # do something with html
#
# ## Extensions
#
# The following markdown extensions are supported by the parser, but not all
# are used in RDoc output by default.
#
# ### RDoc
#
# The RDoc Markdown parser has the following built-in behaviors that cannot be
# disabled.
#
# Underscores embedded in words are never interpreted as emphasis. (While the
# [markdown dingus][dingus] emphasizes in-word underscores, neither the
# Markdown syntax nor MarkdownTest mention this behavior.)
#
# For HTML output, RDoc always auto-links bare URLs.
#
# ### Break on Newline
#
# The break_on_newline extension converts all newlines into hard line breaks
# as in [Github Flavored Markdown][GFM]. This extension is disabled by
# default.
#
# ### CSS
#
# The #css extension enables CSS blocks to be included in the output, but they
# are not used for any built-in RDoc output format. This extension is disabled
# by default.
#
# Example:
#
# <style type="text/css">
# h1 { font-size: 3em }
# </style>
#
# ### Definition Lists
#
# The definition_lists extension allows definition lists using the [PHP
# Markdown Extra syntax][PHPE], but only one label and definition are supported
# at this time. This extension is enabled by default.
#
# Example:
#
# ```
# cat
# : A small furry mammal
# that seems to sleep a lot
#
# ant
# : A little insect that is known
# to enjoy picnics
#
# ```
#
# Produces:
#
# cat
# : A small furry mammal
# that seems to sleep a lot
#
# ant
# : A little insect that is known
# to enjoy picnics
#
# ### Strike
#
# Example:
#
# ```
# This is ~~striked~~.
# ```
#
# Produces:
#
# This is ~~striked~~.
#
# ### Github
#
# The #github extension enables a partial set of [Github Flavored Markdown]
# [GFM]. This extension is enabled by default.
#
# Supported github extensions include:
#
# #### Fenced code blocks
#
# Use ` ``` ` around a block of code instead of indenting it four spaces.
#
# #### Syntax highlighting
#
# Use ` ``` ruby ` as the start of a code fence to add syntax highlighting.
# (Currently only `ruby` syntax is supported).
#
# ### HTML
#
# Enables raw HTML to be included in the output. This extension is enabled by
# default.
#
# Example:
#
# <table>
# ...
# </table>
#
# ### Notes
#
# The #notes extension enables footnote support. This extension is enabled by
# default.
#
# Example:
#
# Here is some text[^1] including an inline footnote ^[for short footnotes]
#
# ...
#
# [^1]: With the footnote text down at the bottom
#
# Produces:
#
# Here is some text[^1] including an inline footnote ^[for short footnotes]
#
# [^1]: With the footnote text down at the bottom
#
# ## Limitations
#
# * Link titles are not used
# * Footnotes are collapsed into a single paragraph
#
# ## Author
#
# This markdown parser is a port to kpeg from [peg-markdown][pegmarkdown] by
# John MacFarlane.
#
# It is used under the MIT license:
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# The port to kpeg was performed by Eric Hodel and Evan Phoenix
#
# [dingus]: http://daringfireball.net/projects/markdown/dingus
# [GFM]: https://github.github.com/gfm/
# [pegmarkdown]: https://github.com/jgm/peg-markdown
# [PHPE]: https://michelf.ca/projects/php-markdown/extra/#def-list
# [syntax]: http://daringfireball.net/projects/markdown/syntax
#--
# Last updated to jgm/peg-markdown commit 8f8fc22ef0
class RDoc::Markdown
# :stopdoc:
# This is distinct from setup_parser so that a standalone parser
# can redefine #initialize and still have access to the proper
# parser setup code.
def initialize(str, debug=false)
setup_parser(str, debug)
end
# Prepares for parsing +str+. If you define a custom initialize you must
# call this method before #parse
def setup_parser(str, debug=false)
set_string str, 0
@memoizations = Hash.new { |h,k| h[k] = {} }
@result = nil
@failed_rule = nil
@failing_rule_offset = -1
@line_offsets = nil
setup_foreign_grammar
end
attr_reader :string
attr_reader :failing_rule_offset
attr_accessor :result, :pos
def current_column(target=pos)
if string[target] == "\n" && (c = string.rindex("\n", target-1) || -1)
return target - c
elsif c = string.rindex("\n", target)
return target - c
end
target + 1
end
def position_line_offsets
unless @position_line_offsets
@position_line_offsets = []
total = 0
string.each_line do |line|
total += line.size
@position_line_offsets << total
end
end
@position_line_offsets
end
if [].respond_to? :bsearch_index
def current_line(target=pos)
if line = position_line_offsets.bsearch_index {|x| x > target }
return line + 1
end
raise "Target position #{target} is outside of string"
end
else
def current_line(target=pos)
if line = position_line_offsets.index {|x| x > target }
return line + 1
end
raise "Target position #{target} is outside of string"
end
end
def current_character(target=pos)
if target < 0 || target >= string.size
raise "Target position #{target} is outside of string"
end
string[target, 1]
end
KpegPosInfo = Struct.new(:pos, :lno, :col, :line, :char)
def current_pos_info(target=pos)
l = current_line target
c = current_column target
ln = get_line(l-1)
chr = string[target,1]
KpegPosInfo.new(target, l, c, ln, chr)
end
def lines
string.lines
end
def get_line(no)
loff = position_line_offsets
if no < 0
raise "Line No is out of range: #{no} < 0"
elsif no >= loff.size
raise "Line No is out of range: #{no} >= #{loff.size}"
end
lend = loff[no]-1
lstart = no > 0 ? loff[no-1] : 0
string[lstart..lend]
end
def get_text(start)
@string[start..@pos-1]
end
# Sets the string and current parsing position for the parser.
def set_string string, pos
@string = string
@string_size = string ? string.size : 0
@pos = pos
@position_line_offsets = nil
end
def show_pos
width = 10
if @pos < width
"#{@pos} (\"#{@string[0,@pos]}\" @ \"#{@string[@pos,width]}\")"
else
"#{@pos} (\"... #{@string[@pos - width, width]}\" @ \"#{@string[@pos,width]}\")"
end
end
def failure_info
l = current_line @failing_rule_offset
c = current_column @failing_rule_offset
if @failed_rule.kind_of? Symbol
info = self.class::Rules[@failed_rule]
"line #{l}, column #{c}: failed rule '#{info.name}' = '#{info.rendered}'"
else
"line #{l}, column #{c}: failed rule '#{@failed_rule}'"
end
end
def failure_caret
p = current_pos_info @failing_rule_offset
"#{p.line.chomp}\n#{' ' * (p.col - 1)}^"
end
def failure_character
current_character @failing_rule_offset
end
def failure_oneline
p = current_pos_info @failing_rule_offset
if @failed_rule.kind_of? Symbol
info = self.class::Rules[@failed_rule]
"@#{p.lno}:#{p.col} failed rule '#{info.name}', got '#{p.char}'"
else
"@#{p.lno}:#{p.col} failed rule '#{@failed_rule}', got '#{p.char}'"
end
end
class ParseError < RuntimeError
end
def raise_error
raise ParseError, failure_oneline
end
def show_error(io=STDOUT)
error_pos = @failing_rule_offset
p = current_pos_info(error_pos)
io.puts "On line #{p.lno}, column #{p.col}:"
if @failed_rule.kind_of? Symbol
info = self.class::Rules[@failed_rule]
io.puts "Failed to match '#{info.rendered}' (rule '#{info.name}')"
else
io.puts "Failed to match rule '#{@failed_rule}'"
end
io.puts "Got: #{p.char.inspect}"
io.puts "=> #{p.line}"
io.print(" " * (p.col + 2))
io.puts "^"
end
def set_failed_rule(name)
if @pos > @failing_rule_offset
@failed_rule = name
@failing_rule_offset = @pos
end
end
attr_reader :failed_rule
def match_string(str)
len = str.size
if @string[pos,len] == str
@pos += len
return str
end
return nil
end
def scan(reg)
if m = reg.match(@string, @pos)
@pos = m.end(0)
return true
end
return nil
end
if "".respond_to? :ord
def get_byte
if @pos >= @string_size
return nil
end
s = @string[@pos].ord
@pos += 1
s
end
else
def get_byte
if @pos >= @string_size
return nil
end
s = @string[@pos]
@pos += 1
s
end
end
def parse(rule=nil)
# We invoke the rules indirectly via apply
# instead of by just calling them as methods because
# if the rules use left recursion, apply needs to
# manage that.
if !rule
apply(:_root)
else
method = rule.gsub("-","_hyphen_")
apply :"_#{method}"
end
end
class MemoEntry
def initialize(ans, pos)
@ans = ans
@pos = pos
@result = nil
@set = false
@left_rec = false
end
attr_reader :ans, :pos, :result, :set
attr_accessor :left_rec
def move!(ans, pos, result)
@ans = ans
@pos = pos
@result = result
@set = true
@left_rec = false
end
end
def external_invoke(other, rule, *args)
old_pos = @pos
old_string = @string
set_string other.string, other.pos
begin
if val = __send__(rule, *args)
other.pos = @pos
other.result = @result
else
other.set_failed_rule "#{self.class}##{rule}"
end
val
ensure
set_string old_string, old_pos
end
end
def apply_with_args(rule, *args)
@result = nil
memo_key = [rule, args]
if m = @memoizations[memo_key][@pos]
@pos = m.pos
if !m.set
m.left_rec = true
return nil
end
@result = m.result
return m.ans
else
m = MemoEntry.new(nil, @pos)
@memoizations[memo_key][@pos] = m
start_pos = @pos
ans = __send__ rule, *args
lr = m.left_rec
m.move! ans, @pos, @result
# Don't bother trying to grow the left recursion
# if it's failing straight away (thus there is no seed)
if ans and lr
return grow_lr(rule, args, start_pos, m)
else
return ans
end
end
end
def apply(rule)
@result = nil
if m = @memoizations[rule][@pos]
@pos = m.pos
if !m.set
m.left_rec = true
return nil
end
@result = m.result
return m.ans
else
m = MemoEntry.new(nil, @pos)
@memoizations[rule][@pos] = m
start_pos = @pos
ans = __send__ rule
lr = m.left_rec
m.move! ans, @pos, @result
# Don't bother trying to grow the left recursion
# if it's failing straight away (thus there is no seed)
if ans and lr
return grow_lr(rule, nil, start_pos, m)
else
return ans
end
end
end
def grow_lr(rule, args, start_pos, m)
while true
@pos = start_pos
@result = m.result
if args
ans = __send__ rule, *args
else
ans = __send__ rule
end
return nil unless ans
break if @pos <= m.pos
m.move! ans, @pos, @result
end
@result = m.result
@pos = m.pos
return m.ans
end
class RuleInfo
def initialize(name, rendered)
@name = name
@rendered = rendered
end
attr_reader :name, :rendered
end
def self.rule_info(name, rendered)
RuleInfo.new(name, rendered)
end
# :startdoc:
require_relative '../rdoc'
require_relative 'markup/to_joined_paragraph'
require_relative 'markdown/entities'
require_relative 'markdown/literals'
##
# Supported extensions
EXTENSIONS = []
##
# Extensions enabled by default
DEFAULT_EXTENSIONS = [
:definition_lists,
:github,
:html,
:notes,
:strike,
]
# :section: Extensions
##
# Creates extension methods for the `name` extension to enable and disable
# the extension and to query if they are active.
def self.extension name
EXTENSIONS << name
define_method "#{name}?" do
extension? name
end
define_method "#{name}=" do |enable|
extension name, enable
end
end
##
# Converts all newlines into hard breaks
extension :break_on_newline
##
# Allow style blocks
extension :css
##
# Allow PHP Markdown Extras style definition lists
extension :definition_lists
##
# Allow Github Flavored Markdown
extension :github
##
# Allow HTML
extension :html
##
# Enables the notes extension
extension :notes
##
# Enables the strike extension
extension :strike
# :section:
##
# Parses the `markdown` document into an RDoc::Document using the default
# extensions.
def self.parse markdown
parser = new
parser.parse markdown
end
# TODO remove when kpeg 0.10 is released
alias orig_initialize initialize # :nodoc:
##
# Creates a new markdown parser that enables the given +extensions+.
def initialize extensions = DEFAULT_EXTENSIONS, debug = false
@debug = debug
@formatter = RDoc::Markup::ToJoinedParagraph.new
@extensions = extensions
@references = nil
@unlinked_references = nil
@footnotes = nil
@note_order = nil
end
##
# Wraps `text` in emphasis for rdoc inline formatting
def emphasis text
if text =~ /\A[a-z\d.\/]+\z/i then
"_#{text}_"
else
"<em>#{text}</em>"
end
end
##
# :category: Extensions
#
# Is the extension `name` enabled?
def extension? name
@extensions.include? name
end
##
# :category: Extensions
#
# Enables or disables the extension with `name`
def extension name, enable
if enable then
@extensions |= [name]
else
@extensions -= [name]
end
end
##
# Parses `text` in a clone of this parser. This is used for handling nested
# lists the same way as markdown_parser.
def inner_parse text # :nodoc:
parser = clone
parser.setup_parser text, @debug
parser.peg_parse
doc = parser.result
doc.accept @formatter
doc.parts
end
##
# Finds a link reference for `label` and creates a new link to it with
# `content` as the link text. If `label` was not encountered in the
# reference-gathering parser pass the label and content are reconstructed
# with the linking `text` (usually whitespace).
def link_to content, label = content, text = nil
raise ParseError, 'enable notes extension' if
content.start_with? '^' and label.equal? content
if ref = @references[label] then
"{#{content}}[#{ref}]"
elsif label.equal? content then
"[#{content}]#{text}"
else
"[#{content}]#{text}[#{label}]"
end
end
##
# Creates an RDoc::Markup::ListItem by parsing the `unparsed` content from
# the first parsing pass.
def list_item_from unparsed
parsed = inner_parse unparsed.join
RDoc::Markup::ListItem.new nil, *parsed
end
##
# Stores `label` as a note and fills in previously unknown note references.
def note label
#foottext = "rdoc-label:foottext-#{label}:footmark-#{label}"
#ref.replace foottext if ref = @unlinked_notes.delete(label)
@notes[label] = foottext
#"{^1}[rdoc-label:footmark-#{label}:foottext-#{label}] "
end
##
# Creates a new link for the footnote `reference` and adds the reference to
# the note order list for proper display at the end of the document.
def note_for ref
@note_order << ref
label = @note_order.length
"{*#{label}}[rdoc-label:foottext-#{label}:footmark-#{label}]"
end
##
# The internal kpeg parse method
alias peg_parse parse # :nodoc:
##
# Creates an RDoc::Markup::Paragraph from `parts` and including
# extension-specific behavior
def paragraph parts
parts = parts.map do |part|
if "\n" == part then
RDoc::Markup::HardBreak.new
else
part
end
end if break_on_newline?
RDoc::Markup::Paragraph.new(*parts)
end
##
# Parses `markdown` into an RDoc::Document
def parse markdown
@references = {}
@unlinked_references = {}
markdown += "\n\n"
setup_parser markdown, @debug
peg_parse 'References'
if notes? then
@footnotes = {}
setup_parser markdown, @debug
peg_parse 'Notes'
# using note_order on the first pass would be a bug
@note_order = []
end
setup_parser markdown, @debug
peg_parse
doc = result
if notes? and not @footnotes.empty? then
doc << RDoc::Markup::Rule.new(1)
@note_order.each_with_index do |ref, index|
label = index + 1
note = @footnotes[ref] or raise ParseError, "footnote [^#{ref}] not found"
link = "{^#{label}}[rdoc-label:footmark-#{label}:foottext-#{label}] "
note.parts.unshift link
doc << note
end
end
doc.accept @formatter
doc
end
##
# Stores `label` as a reference to `link` and fills in previously unknown
# link references.
def reference label, link
if ref = @unlinked_references.delete(label) then
ref.replace link
end
@references[label] = link
end
##
# Wraps `text` in strong markup for rdoc inline formatting
def strong text
if text =~ /\A[a-z\d.\/-]+\z/i then
"*#{text}*"
else
"<b>#{text}</b>"
end
end
##
# Wraps `text` in strike markup for rdoc inline formatting
def strike text
if text =~ /\A[a-z\d.\/-]+\z/i then
"~#{text}~"
else
"<s>#{text}</s>"
end
end
# :stopdoc:
def setup_foreign_grammar
@_grammar_literals = RDoc::Markdown::Literals.new(nil)
end
# root = Doc
def _root
_tmp = apply(:_Doc)
set_failed_rule :_root unless _tmp
return _tmp
end
# Doc = BOM? Block*:a { RDoc::Markup::Document.new(*a.compact) }
def _Doc
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = apply(:_BOM)
unless _tmp
_tmp = true
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
_ary = []
while true
_tmp = apply(:_Block)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::Document.new(*a.compact) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Doc unless _tmp
return _tmp
end
# Block = @BlankLine* (BlockQuote | Verbatim | CodeFence | Table | Note | Reference | HorizontalRule | Heading | OrderedList | BulletList | DefinitionList | HtmlBlock | StyleBlock | Para | Plain)
def _Block
_save = self.pos
while true # sequence
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
while true # choice
_tmp = apply(:_BlockQuote)
break if _tmp
self.pos = _save2
_tmp = apply(:_Verbatim)
break if _tmp
self.pos = _save2
_tmp = apply(:_CodeFence)
break if _tmp
self.pos = _save2
_tmp = apply(:_Table)
break if _tmp
self.pos = _save2
_tmp = apply(:_Note)
break if _tmp
self.pos = _save2
_tmp = apply(:_Reference)
break if _tmp
self.pos = _save2
_tmp = apply(:_HorizontalRule)
break if _tmp
self.pos = _save2
_tmp = apply(:_Heading)
break if _tmp
self.pos = _save2
_tmp = apply(:_OrderedList)
break if _tmp
self.pos = _save2
_tmp = apply(:_BulletList)
break if _tmp
self.pos = _save2
_tmp = apply(:_DefinitionList)
break if _tmp
self.pos = _save2
_tmp = apply(:_HtmlBlock)
break if _tmp
self.pos = _save2
_tmp = apply(:_StyleBlock)
break if _tmp
self.pos = _save2
_tmp = apply(:_Para)
break if _tmp
self.pos = _save2
_tmp = apply(:_Plain)
break if _tmp
self.pos = _save2
break
end # end choice
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Block unless _tmp
return _tmp
end
# Para = @NonindentSpace Inlines:a @BlankLine+ { paragraph a }
def _Para
_save = self.pos
while true # sequence
_tmp = _NonindentSpace()
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Inlines)
a = @result
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _BlankLine()
if _tmp
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
@result = begin; paragraph a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Para unless _tmp
return _tmp
end
# Plain = Inlines:a { paragraph a }
def _Plain
_save = self.pos
while true # sequence
_tmp = apply(:_Inlines)
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; paragraph a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Plain unless _tmp
return _tmp
end
# AtxInline = !@Newline !(@Sp /#*/ @Sp @Newline) Inline
def _AtxInline
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save3
break
end
_tmp = scan(/\G(?-mix:#*)/)
unless _tmp
self.pos = _save3
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save3
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save3
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save2
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Inline)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_AtxInline unless _tmp
return _tmp
end
# AtxStart = < /\#{1,6}/ > { text.length }
def _AtxStart
_save = self.pos
while true # sequence
_text_start = self.pos
_tmp = scan(/\G(?-mix:\#{1,6})/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; text.length ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_AtxStart unless _tmp
return _tmp
end
# AtxHeading = AtxStart:s @Sp AtxInline+:a (@Sp /#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }
def _AtxHeading
_save = self.pos
while true # sequence
_tmp = apply(:_AtxStart)
s = @result
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_ary = []
_tmp = apply(:_AtxInline)
if _tmp
_ary << @result
while true
_tmp = apply(:_AtxInline)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save1
end
a = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save3
break
end
_tmp = scan(/\G(?-mix:#*)/)
unless _tmp
self.pos = _save3
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save3
end
break
end # end sequence
unless _tmp
_tmp = true
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::Heading.new(s, a.join) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_AtxHeading unless _tmp
return _tmp
end
# SetextHeading = (SetextHeading1 | SetextHeading2)
def _SetextHeading
_save = self.pos
while true # choice
_tmp = apply(:_SetextHeading1)
break if _tmp
self.pos = _save
_tmp = apply(:_SetextHeading2)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_SetextHeading unless _tmp
return _tmp
end
# SetextBottom1 = /={1,}/ @Newline
def _SetextBottom1
_save = self.pos
while true # sequence
_tmp = scan(/\G(?-mix:={1,})/)
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_SetextBottom1 unless _tmp
return _tmp
end
# SetextBottom2 = /-{1,}/ @Newline
def _SetextBottom2
_save = self.pos
while true # sequence
_tmp = scan(/\G(?-mix:-{1,})/)
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_SetextBottom2 unless _tmp
return _tmp
end
# SetextHeading1 = &(@RawLine SetextBottom1) @StartList:a (!@Endline Inline:b { a << b })+ @Sp @Newline SetextBottom1 { RDoc::Markup::Heading.new(1, a.join) }
def _SetextHeading1
_save = self.pos
while true # sequence
_save1 = self.pos
_save2 = self.pos
while true # sequence
_tmp = _RawLine()
unless _tmp
self.pos = _save2
break
end
_tmp = apply(:_SetextBottom1)
unless _tmp
self.pos = _save2
end
break
end # end sequence
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save3 = self.pos
_save4 = self.pos
while true # sequence
_save5 = self.pos
_tmp = _Endline()
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save4
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save4
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save4
end
break
end # end sequence
if _tmp
while true
_save6 = self.pos
while true # sequence
_save7 = self.pos
_tmp = _Endline()
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save6
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save6
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save6
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save3
end
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_SetextBottom1)
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::Heading.new(1, a.join) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_SetextHeading1 unless _tmp
return _tmp
end
# SetextHeading2 = &(@RawLine SetextBottom2) @StartList:a (!@Endline Inline:b { a << b })+ @Sp @Newline SetextBottom2 { RDoc::Markup::Heading.new(2, a.join) }
def _SetextHeading2
_save = self.pos
while true # sequence
_save1 = self.pos
_save2 = self.pos
while true # sequence
_tmp = _RawLine()
unless _tmp
self.pos = _save2
break
end
_tmp = apply(:_SetextBottom2)
unless _tmp
self.pos = _save2
end
break
end # end sequence
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save3 = self.pos
_save4 = self.pos
while true # sequence
_save5 = self.pos
_tmp = _Endline()
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save4
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save4
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save4
end
break
end # end sequence
if _tmp
while true
_save6 = self.pos
while true # sequence
_save7 = self.pos
_tmp = _Endline()
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save6
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save6
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save6
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save3
end
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_SetextBottom2)
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::Heading.new(2, a.join) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_SetextHeading2 unless _tmp
return _tmp
end
# Heading = (SetextHeading | AtxHeading)
def _Heading
_save = self.pos
while true # choice
_tmp = apply(:_SetextHeading)
break if _tmp
self.pos = _save
_tmp = apply(:_AtxHeading)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Heading unless _tmp
return _tmp
end
# BlockQuote = BlockQuoteRaw:a { RDoc::Markup::BlockQuote.new(*a) }
def _BlockQuote
_save = self.pos
while true # sequence
_tmp = apply(:_BlockQuoteRaw)
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::BlockQuote.new(*a) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_BlockQuote unless _tmp
return _tmp
end
# BlockQuoteRaw = @StartList:a (">" " "? Line:l { a << l } (!">" !@BlankLine Line:c { a << c })* (@BlankLine:n { a << n })*)+ { inner_parse a.join }
def _BlockQuoteRaw
_save = self.pos
while true # sequence
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_save2 = self.pos
while true # sequence
_tmp = match_string(">")
unless _tmp
self.pos = _save2
break
end
_save3 = self.pos
_tmp = match_string(" ")
unless _tmp
_tmp = true
self.pos = _save3
end
unless _tmp
self.pos = _save2
break
end
_tmp = apply(:_Line)
l = @result
unless _tmp
self.pos = _save2
break
end
@result = begin; a << l ; end
_tmp = true
unless _tmp
self.pos = _save2
break
end
while true
_save5 = self.pos
while true # sequence
_save6 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_save7 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save5
break
end
_tmp = apply(:_Line)
c = @result
unless _tmp
self.pos = _save5
break
end
@result = begin; a << c ; end
_tmp = true
unless _tmp
self.pos = _save5
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save2
break
end
while true
_save9 = self.pos
while true # sequence
_tmp = _BlankLine()
n = @result
unless _tmp
self.pos = _save9
break
end
@result = begin; a << n ; end
_tmp = true
unless _tmp
self.pos = _save9
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
if _tmp
while true
_save10 = self.pos
while true # sequence
_tmp = match_string(">")
unless _tmp
self.pos = _save10
break
end
_save11 = self.pos
_tmp = match_string(" ")
unless _tmp
_tmp = true
self.pos = _save11
end
unless _tmp
self.pos = _save10
break
end
_tmp = apply(:_Line)
l = @result
unless _tmp
self.pos = _save10
break
end
@result = begin; a << l ; end
_tmp = true
unless _tmp
self.pos = _save10
break
end
while true
_save13 = self.pos
while true # sequence
_save14 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save14
unless _tmp
self.pos = _save13
break
end
_save15 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save15
unless _tmp
self.pos = _save13
break
end
_tmp = apply(:_Line)
c = @result
unless _tmp
self.pos = _save13
break
end
@result = begin; a << c ; end
_tmp = true
unless _tmp
self.pos = _save13
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save10
break
end
while true
_save17 = self.pos
while true # sequence
_tmp = _BlankLine()
n = @result
unless _tmp
self.pos = _save17
break
end
@result = begin; a << n ; end
_tmp = true
unless _tmp
self.pos = _save17
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save10
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
@result = begin; inner_parse a.join ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_BlockQuoteRaw unless _tmp
return _tmp
end
# NonblankIndentedLine = !@BlankLine IndentedLine
def _NonblankIndentedLine
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_IndentedLine)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_NonblankIndentedLine unless _tmp
return _tmp
end
# VerbatimChunk = @BlankLine*:a NonblankIndentedLine+:b { a.concat b }
def _VerbatimChunk
_save = self.pos
while true # sequence
_ary = []
while true
_tmp = _BlankLine()
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
a = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_ary = []
_tmp = apply(:_NonblankIndentedLine)
if _tmp
_ary << @result
while true
_tmp = apply(:_NonblankIndentedLine)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save2
end
b = @result
unless _tmp
self.pos = _save
break
end
@result = begin; a.concat b ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_VerbatimChunk unless _tmp
return _tmp
end
# Verbatim = VerbatimChunk+:a { RDoc::Markup::Verbatim.new(*a.flatten) }
def _Verbatim
_save = self.pos
while true # sequence
_save1 = self.pos
_ary = []
_tmp = apply(:_VerbatimChunk)
if _tmp
_ary << @result
while true
_tmp = apply(:_VerbatimChunk)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save1
end
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::Verbatim.new(*a.flatten) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Verbatim unless _tmp
return _tmp
end
# HorizontalRule = @NonindentSpace ("*" @Sp "*" @Sp "*" (@Sp "*")* | "-" @Sp "-" @Sp "-" (@Sp "-")* | "_" @Sp "_" @Sp "_" (@Sp "_")*) @Sp @Newline @BlankLine+ { RDoc::Markup::Rule.new 1 }
def _HorizontalRule
_save = self.pos
while true # sequence
_tmp = _NonindentSpace()
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_save2 = self.pos
while true # sequence
_tmp = match_string("*")
unless _tmp
self.pos = _save2
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save2
break
end
_tmp = match_string("*")
unless _tmp
self.pos = _save2
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save2
break
end
_tmp = match_string("*")
unless _tmp
self.pos = _save2
break
end
while true
_save4 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save4
break
end
_tmp = match_string("*")
unless _tmp
self.pos = _save4
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
break if _tmp
self.pos = _save1
_save5 = self.pos
while true # sequence
_tmp = match_string("-")
unless _tmp
self.pos = _save5
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save5
break
end
_tmp = match_string("-")
unless _tmp
self.pos = _save5
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save5
break
end
_tmp = match_string("-")
unless _tmp
self.pos = _save5
break
end
while true
_save7 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save7
break
end
_tmp = match_string("-")
unless _tmp
self.pos = _save7
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save5
end
break
end # end sequence
break if _tmp
self.pos = _save1
_save8 = self.pos
while true # sequence
_tmp = match_string("_")
unless _tmp
self.pos = _save8
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save8
break
end
_tmp = match_string("_")
unless _tmp
self.pos = _save8
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save8
break
end
_tmp = match_string("_")
unless _tmp
self.pos = _save8
break
end
while true
_save10 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save10
break
end
_tmp = match_string("_")
unless _tmp
self.pos = _save10
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save8
end
break
end # end sequence
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
_save11 = self.pos
_tmp = _BlankLine()
if _tmp
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
else
self.pos = _save11
end
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::Rule.new 1 ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HorizontalRule unless _tmp
return _tmp
end
# Bullet = !HorizontalRule @NonindentSpace /[+*-]/ @Spacechar+
def _Bullet
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = apply(:_HorizontalRule)
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _NonindentSpace()
unless _tmp
self.pos = _save
break
end
_tmp = scan(/\G(?-mix:[+*-])/)
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = _Spacechar()
if _tmp
while true
_tmp = _Spacechar()
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Bullet unless _tmp
return _tmp
end
# BulletList = &Bullet (ListTight | ListLoose):a { RDoc::Markup::List.new(:BULLET, *a) }
def _BulletList
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = apply(:_Bullet)
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
while true # choice
_tmp = apply(:_ListTight)
break if _tmp
self.pos = _save2
_tmp = apply(:_ListLoose)
break if _tmp
self.pos = _save2
break
end # end choice
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::List.new(:BULLET, *a) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_BulletList unless _tmp
return _tmp
end
# ListTight = ListItemTight+:a @BlankLine* !(Bullet | Enumerator) { a }
def _ListTight
_save = self.pos
while true # sequence
_save1 = self.pos
_ary = []
_tmp = apply(:_ListItemTight)
if _tmp
_ary << @result
while true
_tmp = apply(:_ListItemTight)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save1
end
a = @result
unless _tmp
self.pos = _save
break
end
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_save3 = self.pos
_save4 = self.pos
while true # choice
_tmp = apply(:_Bullet)
break if _tmp
self.pos = _save4
_tmp = apply(:_Enumerator)
break if _tmp
self.pos = _save4
break
end # end choice
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ListTight unless _tmp
return _tmp
end
# ListLoose = @StartList:a (ListItem:b @BlankLine* { a << b })+ { a }
def _ListLoose
_save = self.pos
while true # sequence
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_save2 = self.pos
while true # sequence
_tmp = apply(:_ListItem)
b = @result
unless _tmp
self.pos = _save2
break
end
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save2
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
if _tmp
while true
_save4 = self.pos
while true # sequence
_tmp = apply(:_ListItem)
b = @result
unless _tmp
self.pos = _save4
break
end
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save4
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save4
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ListLoose unless _tmp
return _tmp
end
# ListItem = (Bullet | Enumerator) @StartList:a ListBlock:b { a << b } (ListContinuationBlock:c { a.push(*c) })* { list_item_from a }
def _ListItem
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_tmp = apply(:_Bullet)
break if _tmp
self.pos = _save1
_tmp = apply(:_Enumerator)
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_ListBlock)
b = @result
unless _tmp
self.pos = _save
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save
break
end
while true
_save3 = self.pos
while true # sequence
_tmp = apply(:_ListContinuationBlock)
c = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a.push(*c) ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
@result = begin; list_item_from a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ListItem unless _tmp
return _tmp
end
# ListItemTight = (Bullet | Enumerator) ListBlock:a (!@BlankLine ListContinuationBlock:b { a.push(*b) })* !ListContinuationBlock { list_item_from a }
def _ListItemTight
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_tmp = apply(:_Bullet)
break if _tmp
self.pos = _save1
_tmp = apply(:_Enumerator)
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_ListBlock)
a = @result
unless _tmp
self.pos = _save
break
end
while true
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_ListContinuationBlock)
b = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a.push(*b) ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_save5 = self.pos
_tmp = apply(:_ListContinuationBlock)
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save
break
end
@result = begin; list_item_from a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ListItemTight unless _tmp
return _tmp
end
# ListBlock = !@BlankLine Line:a ListBlockLine*:c { [a, *c] }
def _ListBlock
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Line)
a = @result
unless _tmp
self.pos = _save
break
end
_ary = []
while true
_tmp = apply(:_ListBlockLine)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
c = @result
unless _tmp
self.pos = _save
break
end
@result = begin; [a, *c] ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ListBlock unless _tmp
return _tmp
end
# ListContinuationBlock = @StartList:a @BlankLine* { a << "\n" } (Indent ListBlock:b { a.concat b })+ { a }
def _ListContinuationBlock
_save = self.pos
while true # sequence
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
@result = begin; a << "\n" ; end
_tmp = true
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_tmp = apply(:_Indent)
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_ListBlock)
b = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a.concat b ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
while true
_save4 = self.pos
while true # sequence
_tmp = apply(:_Indent)
unless _tmp
self.pos = _save4
break
end
_tmp = apply(:_ListBlock)
b = @result
unless _tmp
self.pos = _save4
break
end
@result = begin; a.concat b ; end
_tmp = true
unless _tmp
self.pos = _save4
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ListContinuationBlock unless _tmp
return _tmp
end
# Enumerator = @NonindentSpace [0-9]+ "." @Spacechar+
def _Enumerator
_save = self.pos
while true # sequence
_tmp = _NonindentSpace()
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_save2 = self.pos
_tmp = get_byte
if _tmp
unless _tmp >= 48 and _tmp <= 57
self.pos = _save2
_tmp = nil
end
end
if _tmp
while true
_save3 = self.pos
_tmp = get_byte
if _tmp
unless _tmp >= 48 and _tmp <= 57
self.pos = _save3
_tmp = nil
end
end
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string(".")
unless _tmp
self.pos = _save
break
end
_save4 = self.pos
_tmp = _Spacechar()
if _tmp
while true
_tmp = _Spacechar()
break unless _tmp
end
_tmp = true
else
self.pos = _save4
end
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Enumerator unless _tmp
return _tmp
end
# OrderedList = &Enumerator (ListTight | ListLoose):a { RDoc::Markup::List.new(:NUMBER, *a) }
def _OrderedList
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = apply(:_Enumerator)
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
while true # choice
_tmp = apply(:_ListTight)
break if _tmp
self.pos = _save2
_tmp = apply(:_ListLoose)
break if _tmp
self.pos = _save2
break
end # end choice
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::List.new(:NUMBER, *a) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_OrderedList unless _tmp
return _tmp
end
# ListBlockLine = !@BlankLine !(Indent? (Bullet | Enumerator)) !HorizontalRule OptionallyIndentedLine
def _ListBlockLine
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_Indent)
unless _tmp
_tmp = true
self.pos = _save4
end
unless _tmp
self.pos = _save3
break
end
_save5 = self.pos
while true # choice
_tmp = apply(:_Bullet)
break if _tmp
self.pos = _save5
_tmp = apply(:_Enumerator)
break if _tmp
self.pos = _save5
break
end # end choice
unless _tmp
self.pos = _save3
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save2
unless _tmp
self.pos = _save
break
end
_save6 = self.pos
_tmp = apply(:_HorizontalRule)
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_OptionallyIndentedLine)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ListBlockLine unless _tmp
return _tmp
end
# HtmlOpenAnchor = "<" Spnl ("a" | "A") Spnl HtmlAttribute* ">"
def _HtmlOpenAnchor
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("a")
break if _tmp
self.pos = _save1
_tmp = match_string("A")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlOpenAnchor unless _tmp
return _tmp
end
# HtmlCloseAnchor = "<" Spnl "/" ("a" | "A") Spnl ">"
def _HtmlCloseAnchor
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("a")
break if _tmp
self.pos = _save1
_tmp = match_string("A")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlCloseAnchor unless _tmp
return _tmp
end
# HtmlAnchor = HtmlOpenAnchor (HtmlAnchor | !HtmlCloseAnchor .)* HtmlCloseAnchor
def _HtmlAnchor
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlOpenAnchor)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlAnchor)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlCloseAnchor)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlCloseAnchor)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlAnchor unless _tmp
return _tmp
end
# HtmlBlockOpenAddress = "<" Spnl ("address" | "ADDRESS") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenAddress
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("address")
break if _tmp
self.pos = _save1
_tmp = match_string("ADDRESS")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenAddress unless _tmp
return _tmp
end
# HtmlBlockCloseAddress = "<" Spnl "/" ("address" | "ADDRESS") Spnl ">"
def _HtmlBlockCloseAddress
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("address")
break if _tmp
self.pos = _save1
_tmp = match_string("ADDRESS")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseAddress unless _tmp
return _tmp
end
# HtmlBlockAddress = HtmlBlockOpenAddress (HtmlBlockAddress | !HtmlBlockCloseAddress .)* HtmlBlockCloseAddress
def _HtmlBlockAddress
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenAddress)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockAddress)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseAddress)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseAddress)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockAddress unless _tmp
return _tmp
end
# HtmlBlockOpenBlockquote = "<" Spnl ("blockquote" | "BLOCKQUOTE") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenBlockquote
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("blockquote")
break if _tmp
self.pos = _save1
_tmp = match_string("BLOCKQUOTE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenBlockquote unless _tmp
return _tmp
end
# HtmlBlockCloseBlockquote = "<" Spnl "/" ("blockquote" | "BLOCKQUOTE") Spnl ">"
def _HtmlBlockCloseBlockquote
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("blockquote")
break if _tmp
self.pos = _save1
_tmp = match_string("BLOCKQUOTE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseBlockquote unless _tmp
return _tmp
end
# HtmlBlockBlockquote = HtmlBlockOpenBlockquote (HtmlBlockBlockquote | !HtmlBlockCloseBlockquote .)* HtmlBlockCloseBlockquote
def _HtmlBlockBlockquote
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenBlockquote)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockBlockquote)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseBlockquote)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseBlockquote)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockBlockquote unless _tmp
return _tmp
end
# HtmlBlockOpenCenter = "<" Spnl ("center" | "CENTER") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenCenter
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("center")
break if _tmp
self.pos = _save1
_tmp = match_string("CENTER")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenCenter unless _tmp
return _tmp
end
# HtmlBlockCloseCenter = "<" Spnl "/" ("center" | "CENTER") Spnl ">"
def _HtmlBlockCloseCenter
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("center")
break if _tmp
self.pos = _save1
_tmp = match_string("CENTER")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseCenter unless _tmp
return _tmp
end
# HtmlBlockCenter = HtmlBlockOpenCenter (HtmlBlockCenter | !HtmlBlockCloseCenter .)* HtmlBlockCloseCenter
def _HtmlBlockCenter
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenCenter)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockCenter)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseCenter)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseCenter)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCenter unless _tmp
return _tmp
end
# HtmlBlockOpenDir = "<" Spnl ("dir" | "DIR") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenDir
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dir")
break if _tmp
self.pos = _save1
_tmp = match_string("DIR")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenDir unless _tmp
return _tmp
end
# HtmlBlockCloseDir = "<" Spnl "/" ("dir" | "DIR") Spnl ">"
def _HtmlBlockCloseDir
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dir")
break if _tmp
self.pos = _save1
_tmp = match_string("DIR")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseDir unless _tmp
return _tmp
end
# HtmlBlockDir = HtmlBlockOpenDir (HtmlBlockDir | !HtmlBlockCloseDir .)* HtmlBlockCloseDir
def _HtmlBlockDir
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenDir)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockDir)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseDir)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseDir)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockDir unless _tmp
return _tmp
end
# HtmlBlockOpenDiv = "<" Spnl ("div" | "DIV") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenDiv
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("div")
break if _tmp
self.pos = _save1
_tmp = match_string("DIV")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenDiv unless _tmp
return _tmp
end
# HtmlBlockCloseDiv = "<" Spnl "/" ("div" | "DIV") Spnl ">"
def _HtmlBlockCloseDiv
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("div")
break if _tmp
self.pos = _save1
_tmp = match_string("DIV")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseDiv unless _tmp
return _tmp
end
# HtmlBlockDiv = HtmlBlockOpenDiv (HtmlBlockDiv | !HtmlBlockCloseDiv .)* HtmlBlockCloseDiv
def _HtmlBlockDiv
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenDiv)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockDiv)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseDiv)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseDiv)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockDiv unless _tmp
return _tmp
end
# HtmlBlockOpenDl = "<" Spnl ("dl" | "DL") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenDl
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dl")
break if _tmp
self.pos = _save1
_tmp = match_string("DL")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenDl unless _tmp
return _tmp
end
# HtmlBlockCloseDl = "<" Spnl "/" ("dl" | "DL") Spnl ">"
def _HtmlBlockCloseDl
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dl")
break if _tmp
self.pos = _save1
_tmp = match_string("DL")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseDl unless _tmp
return _tmp
end
# HtmlBlockDl = HtmlBlockOpenDl (HtmlBlockDl | !HtmlBlockCloseDl .)* HtmlBlockCloseDl
def _HtmlBlockDl
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenDl)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockDl)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseDl)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseDl)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockDl unless _tmp
return _tmp
end
# HtmlBlockOpenFieldset = "<" Spnl ("fieldset" | "FIELDSET") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenFieldset
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("fieldset")
break if _tmp
self.pos = _save1
_tmp = match_string("FIELDSET")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenFieldset unless _tmp
return _tmp
end
# HtmlBlockCloseFieldset = "<" Spnl "/" ("fieldset" | "FIELDSET") Spnl ">"
def _HtmlBlockCloseFieldset
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("fieldset")
break if _tmp
self.pos = _save1
_tmp = match_string("FIELDSET")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseFieldset unless _tmp
return _tmp
end
# HtmlBlockFieldset = HtmlBlockOpenFieldset (HtmlBlockFieldset | !HtmlBlockCloseFieldset .)* HtmlBlockCloseFieldset
def _HtmlBlockFieldset
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenFieldset)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockFieldset)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseFieldset)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseFieldset)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockFieldset unless _tmp
return _tmp
end
# HtmlBlockOpenForm = "<" Spnl ("form" | "FORM") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenForm
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("form")
break if _tmp
self.pos = _save1
_tmp = match_string("FORM")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenForm unless _tmp
return _tmp
end
# HtmlBlockCloseForm = "<" Spnl "/" ("form" | "FORM") Spnl ">"
def _HtmlBlockCloseForm
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("form")
break if _tmp
self.pos = _save1
_tmp = match_string("FORM")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseForm unless _tmp
return _tmp
end
# HtmlBlockForm = HtmlBlockOpenForm (HtmlBlockForm | !HtmlBlockCloseForm .)* HtmlBlockCloseForm
def _HtmlBlockForm
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenForm)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockForm)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseForm)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseForm)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockForm unless _tmp
return _tmp
end
# HtmlBlockOpenH1 = "<" Spnl ("h1" | "H1") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenH1
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h1")
break if _tmp
self.pos = _save1
_tmp = match_string("H1")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenH1 unless _tmp
return _tmp
end
# HtmlBlockCloseH1 = "<" Spnl "/" ("h1" | "H1") Spnl ">"
def _HtmlBlockCloseH1
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h1")
break if _tmp
self.pos = _save1
_tmp = match_string("H1")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseH1 unless _tmp
return _tmp
end
# HtmlBlockH1 = HtmlBlockOpenH1 (HtmlBlockH1 | !HtmlBlockCloseH1 .)* HtmlBlockCloseH1
def _HtmlBlockH1
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenH1)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockH1)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseH1)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseH1)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockH1 unless _tmp
return _tmp
end
# HtmlBlockOpenH2 = "<" Spnl ("h2" | "H2") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenH2
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h2")
break if _tmp
self.pos = _save1
_tmp = match_string("H2")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenH2 unless _tmp
return _tmp
end
# HtmlBlockCloseH2 = "<" Spnl "/" ("h2" | "H2") Spnl ">"
def _HtmlBlockCloseH2
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h2")
break if _tmp
self.pos = _save1
_tmp = match_string("H2")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseH2 unless _tmp
return _tmp
end
# HtmlBlockH2 = HtmlBlockOpenH2 (HtmlBlockH2 | !HtmlBlockCloseH2 .)* HtmlBlockCloseH2
def _HtmlBlockH2
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenH2)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockH2)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseH2)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseH2)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockH2 unless _tmp
return _tmp
end
# HtmlBlockOpenH3 = "<" Spnl ("h3" | "H3") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenH3
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h3")
break if _tmp
self.pos = _save1
_tmp = match_string("H3")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenH3 unless _tmp
return _tmp
end
# HtmlBlockCloseH3 = "<" Spnl "/" ("h3" | "H3") Spnl ">"
def _HtmlBlockCloseH3
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h3")
break if _tmp
self.pos = _save1
_tmp = match_string("H3")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseH3 unless _tmp
return _tmp
end
# HtmlBlockH3 = HtmlBlockOpenH3 (HtmlBlockH3 | !HtmlBlockCloseH3 .)* HtmlBlockCloseH3
def _HtmlBlockH3
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenH3)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockH3)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseH3)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseH3)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockH3 unless _tmp
return _tmp
end
# HtmlBlockOpenH4 = "<" Spnl ("h4" | "H4") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenH4
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h4")
break if _tmp
self.pos = _save1
_tmp = match_string("H4")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenH4 unless _tmp
return _tmp
end
# HtmlBlockCloseH4 = "<" Spnl "/" ("h4" | "H4") Spnl ">"
def _HtmlBlockCloseH4
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h4")
break if _tmp
self.pos = _save1
_tmp = match_string("H4")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseH4 unless _tmp
return _tmp
end
# HtmlBlockH4 = HtmlBlockOpenH4 (HtmlBlockH4 | !HtmlBlockCloseH4 .)* HtmlBlockCloseH4
def _HtmlBlockH4
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenH4)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockH4)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseH4)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseH4)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockH4 unless _tmp
return _tmp
end
# HtmlBlockOpenH5 = "<" Spnl ("h5" | "H5") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenH5
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h5")
break if _tmp
self.pos = _save1
_tmp = match_string("H5")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenH5 unless _tmp
return _tmp
end
# HtmlBlockCloseH5 = "<" Spnl "/" ("h5" | "H5") Spnl ">"
def _HtmlBlockCloseH5
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h5")
break if _tmp
self.pos = _save1
_tmp = match_string("H5")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseH5 unless _tmp
return _tmp
end
# HtmlBlockH5 = HtmlBlockOpenH5 (HtmlBlockH5 | !HtmlBlockCloseH5 .)* HtmlBlockCloseH5
def _HtmlBlockH5
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenH5)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockH5)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseH5)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseH5)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockH5 unless _tmp
return _tmp
end
# HtmlBlockOpenH6 = "<" Spnl ("h6" | "H6") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenH6
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h6")
break if _tmp
self.pos = _save1
_tmp = match_string("H6")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenH6 unless _tmp
return _tmp
end
# HtmlBlockCloseH6 = "<" Spnl "/" ("h6" | "H6") Spnl ">"
def _HtmlBlockCloseH6
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("h6")
break if _tmp
self.pos = _save1
_tmp = match_string("H6")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseH6 unless _tmp
return _tmp
end
# HtmlBlockH6 = HtmlBlockOpenH6 (HtmlBlockH6 | !HtmlBlockCloseH6 .)* HtmlBlockCloseH6
def _HtmlBlockH6
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenH6)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockH6)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseH6)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseH6)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockH6 unless _tmp
return _tmp
end
# HtmlBlockOpenMenu = "<" Spnl ("menu" | "MENU") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenMenu
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("menu")
break if _tmp
self.pos = _save1
_tmp = match_string("MENU")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenMenu unless _tmp
return _tmp
end
# HtmlBlockCloseMenu = "<" Spnl "/" ("menu" | "MENU") Spnl ">"
def _HtmlBlockCloseMenu
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("menu")
break if _tmp
self.pos = _save1
_tmp = match_string("MENU")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseMenu unless _tmp
return _tmp
end
# HtmlBlockMenu = HtmlBlockOpenMenu (HtmlBlockMenu | !HtmlBlockCloseMenu .)* HtmlBlockCloseMenu
def _HtmlBlockMenu
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenMenu)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockMenu)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseMenu)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseMenu)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockMenu unless _tmp
return _tmp
end
# HtmlBlockOpenNoframes = "<" Spnl ("noframes" | "NOFRAMES") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenNoframes
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("noframes")
break if _tmp
self.pos = _save1
_tmp = match_string("NOFRAMES")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenNoframes unless _tmp
return _tmp
end
# HtmlBlockCloseNoframes = "<" Spnl "/" ("noframes" | "NOFRAMES") Spnl ">"
def _HtmlBlockCloseNoframes
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("noframes")
break if _tmp
self.pos = _save1
_tmp = match_string("NOFRAMES")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseNoframes unless _tmp
return _tmp
end
# HtmlBlockNoframes = HtmlBlockOpenNoframes (HtmlBlockNoframes | !HtmlBlockCloseNoframes .)* HtmlBlockCloseNoframes
def _HtmlBlockNoframes
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenNoframes)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockNoframes)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseNoframes)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseNoframes)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockNoframes unless _tmp
return _tmp
end
# HtmlBlockOpenNoscript = "<" Spnl ("noscript" | "NOSCRIPT") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenNoscript
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("noscript")
break if _tmp
self.pos = _save1
_tmp = match_string("NOSCRIPT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenNoscript unless _tmp
return _tmp
end
# HtmlBlockCloseNoscript = "<" Spnl "/" ("noscript" | "NOSCRIPT") Spnl ">"
def _HtmlBlockCloseNoscript
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("noscript")
break if _tmp
self.pos = _save1
_tmp = match_string("NOSCRIPT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseNoscript unless _tmp
return _tmp
end
# HtmlBlockNoscript = HtmlBlockOpenNoscript (HtmlBlockNoscript | !HtmlBlockCloseNoscript .)* HtmlBlockCloseNoscript
def _HtmlBlockNoscript
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenNoscript)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockNoscript)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseNoscript)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseNoscript)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockNoscript unless _tmp
return _tmp
end
# HtmlBlockOpenOl = "<" Spnl ("ol" | "OL") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenOl
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("ol")
break if _tmp
self.pos = _save1
_tmp = match_string("OL")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenOl unless _tmp
return _tmp
end
# HtmlBlockCloseOl = "<" Spnl "/" ("ol" | "OL") Spnl ">"
def _HtmlBlockCloseOl
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("ol")
break if _tmp
self.pos = _save1
_tmp = match_string("OL")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseOl unless _tmp
return _tmp
end
# HtmlBlockOl = HtmlBlockOpenOl (HtmlBlockOl | !HtmlBlockCloseOl .)* HtmlBlockCloseOl
def _HtmlBlockOl
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenOl)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockOl)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseOl)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseOl)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOl unless _tmp
return _tmp
end
# HtmlBlockOpenP = "<" Spnl ("p" | "P") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenP
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("p")
break if _tmp
self.pos = _save1
_tmp = match_string("P")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenP unless _tmp
return _tmp
end
# HtmlBlockCloseP = "<" Spnl "/" ("p" | "P") Spnl ">"
def _HtmlBlockCloseP
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("p")
break if _tmp
self.pos = _save1
_tmp = match_string("P")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseP unless _tmp
return _tmp
end
# HtmlBlockP = HtmlBlockOpenP (HtmlBlockP | !HtmlBlockCloseP .)* HtmlBlockCloseP
def _HtmlBlockP
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenP)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockP)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseP)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseP)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockP unless _tmp
return _tmp
end
# HtmlBlockOpenPre = "<" Spnl ("pre" | "PRE") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenPre
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("pre")
break if _tmp
self.pos = _save1
_tmp = match_string("PRE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenPre unless _tmp
return _tmp
end
# HtmlBlockClosePre = "<" Spnl "/" ("pre" | "PRE") Spnl ">"
def _HtmlBlockClosePre
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("pre")
break if _tmp
self.pos = _save1
_tmp = match_string("PRE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockClosePre unless _tmp
return _tmp
end
# HtmlBlockPre = HtmlBlockOpenPre (HtmlBlockPre | !HtmlBlockClosePre .)* HtmlBlockClosePre
def _HtmlBlockPre
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenPre)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockPre)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockClosePre)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockClosePre)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockPre unless _tmp
return _tmp
end
# HtmlBlockOpenTable = "<" Spnl ("table" | "TABLE") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenTable
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("table")
break if _tmp
self.pos = _save1
_tmp = match_string("TABLE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenTable unless _tmp
return _tmp
end
# HtmlBlockCloseTable = "<" Spnl "/" ("table" | "TABLE") Spnl ">"
def _HtmlBlockCloseTable
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("table")
break if _tmp
self.pos = _save1
_tmp = match_string("TABLE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseTable unless _tmp
return _tmp
end
# HtmlBlockTable = HtmlBlockOpenTable (HtmlBlockTable | !HtmlBlockCloseTable .)* HtmlBlockCloseTable
def _HtmlBlockTable
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenTable)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockTable)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseTable)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseTable)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockTable unless _tmp
return _tmp
end
# HtmlBlockOpenUl = "<" Spnl ("ul" | "UL") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenUl
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("ul")
break if _tmp
self.pos = _save1
_tmp = match_string("UL")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenUl unless _tmp
return _tmp
end
# HtmlBlockCloseUl = "<" Spnl "/" ("ul" | "UL") Spnl ">"
def _HtmlBlockCloseUl
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("ul")
break if _tmp
self.pos = _save1
_tmp = match_string("UL")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseUl unless _tmp
return _tmp
end
# HtmlBlockUl = HtmlBlockOpenUl (HtmlBlockUl | !HtmlBlockCloseUl .)* HtmlBlockCloseUl
def _HtmlBlockUl
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenUl)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockUl)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseUl)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseUl)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockUl unless _tmp
return _tmp
end
# HtmlBlockOpenDd = "<" Spnl ("dd" | "DD") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenDd
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dd")
break if _tmp
self.pos = _save1
_tmp = match_string("DD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenDd unless _tmp
return _tmp
end
# HtmlBlockCloseDd = "<" Spnl "/" ("dd" | "DD") Spnl ">"
def _HtmlBlockCloseDd
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dd")
break if _tmp
self.pos = _save1
_tmp = match_string("DD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseDd unless _tmp
return _tmp
end
# HtmlBlockDd = HtmlBlockOpenDd (HtmlBlockDd | !HtmlBlockCloseDd .)* HtmlBlockCloseDd
def _HtmlBlockDd
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenDd)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockDd)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseDd)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseDd)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockDd unless _tmp
return _tmp
end
# HtmlBlockOpenDt = "<" Spnl ("dt" | "DT") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenDt
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dt")
break if _tmp
self.pos = _save1
_tmp = match_string("DT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenDt unless _tmp
return _tmp
end
# HtmlBlockCloseDt = "<" Spnl "/" ("dt" | "DT") Spnl ">"
def _HtmlBlockCloseDt
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("dt")
break if _tmp
self.pos = _save1
_tmp = match_string("DT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseDt unless _tmp
return _tmp
end
# HtmlBlockDt = HtmlBlockOpenDt (HtmlBlockDt | !HtmlBlockCloseDt .)* HtmlBlockCloseDt
def _HtmlBlockDt
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenDt)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockDt)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseDt)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseDt)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockDt unless _tmp
return _tmp
end
# HtmlBlockOpenFrameset = "<" Spnl ("frameset" | "FRAMESET") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenFrameset
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("frameset")
break if _tmp
self.pos = _save1
_tmp = match_string("FRAMESET")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenFrameset unless _tmp
return _tmp
end
# HtmlBlockCloseFrameset = "<" Spnl "/" ("frameset" | "FRAMESET") Spnl ">"
def _HtmlBlockCloseFrameset
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("frameset")
break if _tmp
self.pos = _save1
_tmp = match_string("FRAMESET")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseFrameset unless _tmp
return _tmp
end
# HtmlBlockFrameset = HtmlBlockOpenFrameset (HtmlBlockFrameset | !HtmlBlockCloseFrameset .)* HtmlBlockCloseFrameset
def _HtmlBlockFrameset
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenFrameset)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockFrameset)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseFrameset)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseFrameset)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockFrameset unless _tmp
return _tmp
end
# HtmlBlockOpenLi = "<" Spnl ("li" | "LI") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenLi
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("li")
break if _tmp
self.pos = _save1
_tmp = match_string("LI")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenLi unless _tmp
return _tmp
end
# HtmlBlockCloseLi = "<" Spnl "/" ("li" | "LI") Spnl ">"
def _HtmlBlockCloseLi
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("li")
break if _tmp
self.pos = _save1
_tmp = match_string("LI")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseLi unless _tmp
return _tmp
end
# HtmlBlockLi = HtmlBlockOpenLi (HtmlBlockLi | !HtmlBlockCloseLi .)* HtmlBlockCloseLi
def _HtmlBlockLi
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenLi)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockLi)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseLi)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseLi)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockLi unless _tmp
return _tmp
end
# HtmlBlockOpenTbody = "<" Spnl ("tbody" | "TBODY") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenTbody
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("tbody")
break if _tmp
self.pos = _save1
_tmp = match_string("TBODY")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenTbody unless _tmp
return _tmp
end
# HtmlBlockCloseTbody = "<" Spnl "/" ("tbody" | "TBODY") Spnl ">"
def _HtmlBlockCloseTbody
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("tbody")
break if _tmp
self.pos = _save1
_tmp = match_string("TBODY")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseTbody unless _tmp
return _tmp
end
# HtmlBlockTbody = HtmlBlockOpenTbody (HtmlBlockTbody | !HtmlBlockCloseTbody .)* HtmlBlockCloseTbody
def _HtmlBlockTbody
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenTbody)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockTbody)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseTbody)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseTbody)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockTbody unless _tmp
return _tmp
end
# HtmlBlockOpenTd = "<" Spnl ("td" | "TD") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenTd
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("td")
break if _tmp
self.pos = _save1
_tmp = match_string("TD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenTd unless _tmp
return _tmp
end
# HtmlBlockCloseTd = "<" Spnl "/" ("td" | "TD") Spnl ">"
def _HtmlBlockCloseTd
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("td")
break if _tmp
self.pos = _save1
_tmp = match_string("TD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseTd unless _tmp
return _tmp
end
# HtmlBlockTd = HtmlBlockOpenTd (HtmlBlockTd | !HtmlBlockCloseTd .)* HtmlBlockCloseTd
def _HtmlBlockTd
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenTd)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockTd)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseTd)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseTd)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockTd unless _tmp
return _tmp
end
# HtmlBlockOpenTfoot = "<" Spnl ("tfoot" | "TFOOT") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenTfoot
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("tfoot")
break if _tmp
self.pos = _save1
_tmp = match_string("TFOOT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenTfoot unless _tmp
return _tmp
end
# HtmlBlockCloseTfoot = "<" Spnl "/" ("tfoot" | "TFOOT") Spnl ">"
def _HtmlBlockCloseTfoot
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("tfoot")
break if _tmp
self.pos = _save1
_tmp = match_string("TFOOT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseTfoot unless _tmp
return _tmp
end
# HtmlBlockTfoot = HtmlBlockOpenTfoot (HtmlBlockTfoot | !HtmlBlockCloseTfoot .)* HtmlBlockCloseTfoot
def _HtmlBlockTfoot
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenTfoot)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockTfoot)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseTfoot)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseTfoot)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockTfoot unless _tmp
return _tmp
end
# HtmlBlockOpenTh = "<" Spnl ("th" | "TH") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenTh
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("th")
break if _tmp
self.pos = _save1
_tmp = match_string("TH")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenTh unless _tmp
return _tmp
end
# HtmlBlockCloseTh = "<" Spnl "/" ("th" | "TH") Spnl ">"
def _HtmlBlockCloseTh
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("th")
break if _tmp
self.pos = _save1
_tmp = match_string("TH")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseTh unless _tmp
return _tmp
end
# HtmlBlockTh = HtmlBlockOpenTh (HtmlBlockTh | !HtmlBlockCloseTh .)* HtmlBlockCloseTh
def _HtmlBlockTh
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenTh)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockTh)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseTh)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseTh)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockTh unless _tmp
return _tmp
end
# HtmlBlockOpenThead = "<" Spnl ("thead" | "THEAD") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenThead
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("thead")
break if _tmp
self.pos = _save1
_tmp = match_string("THEAD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenThead unless _tmp
return _tmp
end
# HtmlBlockCloseThead = "<" Spnl "/" ("thead" | "THEAD") Spnl ">"
def _HtmlBlockCloseThead
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("thead")
break if _tmp
self.pos = _save1
_tmp = match_string("THEAD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseThead unless _tmp
return _tmp
end
# HtmlBlockThead = HtmlBlockOpenThead (HtmlBlockThead | !HtmlBlockCloseThead .)* HtmlBlockCloseThead
def _HtmlBlockThead
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenThead)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockThead)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseThead)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseThead)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockThead unless _tmp
return _tmp
end
# HtmlBlockOpenTr = "<" Spnl ("tr" | "TR") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenTr
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("tr")
break if _tmp
self.pos = _save1
_tmp = match_string("TR")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenTr unless _tmp
return _tmp
end
# HtmlBlockCloseTr = "<" Spnl "/" ("tr" | "TR") Spnl ">"
def _HtmlBlockCloseTr
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("tr")
break if _tmp
self.pos = _save1
_tmp = match_string("TR")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseTr unless _tmp
return _tmp
end
# HtmlBlockTr = HtmlBlockOpenTr (HtmlBlockTr | !HtmlBlockCloseTr .)* HtmlBlockCloseTr
def _HtmlBlockTr
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenTr)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockTr)
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_HtmlBlockCloseTr)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseTr)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockTr unless _tmp
return _tmp
end
# HtmlBlockOpenScript = "<" Spnl ("script" | "SCRIPT") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenScript
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("script")
break if _tmp
self.pos = _save1
_tmp = match_string("SCRIPT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenScript unless _tmp
return _tmp
end
# HtmlBlockCloseScript = "<" Spnl "/" ("script" | "SCRIPT") Spnl ">"
def _HtmlBlockCloseScript
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("script")
break if _tmp
self.pos = _save1
_tmp = match_string("SCRIPT")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseScript unless _tmp
return _tmp
end
# HtmlBlockScript = HtmlBlockOpenScript (!HtmlBlockCloseScript .)* HtmlBlockCloseScript
def _HtmlBlockScript
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenScript)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_tmp = apply(:_HtmlBlockCloseScript)
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseScript)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockScript unless _tmp
return _tmp
end
# HtmlBlockOpenHead = "<" Spnl ("head" | "HEAD") Spnl HtmlAttribute* ">"
def _HtmlBlockOpenHead
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("head")
break if _tmp
self.pos = _save1
_tmp = match_string("HEAD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockOpenHead unless _tmp
return _tmp
end
# HtmlBlockCloseHead = "<" Spnl "/" ("head" | "HEAD") Spnl ">"
def _HtmlBlockCloseHead
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("head")
break if _tmp
self.pos = _save1
_tmp = match_string("HEAD")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockCloseHead unless _tmp
return _tmp
end
# HtmlBlockHead = HtmlBlockOpenHead (!HtmlBlockCloseHead .)* HtmlBlockCloseHead
def _HtmlBlockHead
_save = self.pos
while true # sequence
_tmp = apply(:_HtmlBlockOpenHead)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_tmp = apply(:_HtmlBlockCloseHead)
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockCloseHead)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockHead unless _tmp
return _tmp
end
# HtmlBlockInTags = (HtmlAnchor | HtmlBlockAddress | HtmlBlockBlockquote | HtmlBlockCenter | HtmlBlockDir | HtmlBlockDiv | HtmlBlockDl | HtmlBlockFieldset | HtmlBlockForm | HtmlBlockH1 | HtmlBlockH2 | HtmlBlockH3 | HtmlBlockH4 | HtmlBlockH5 | HtmlBlockH6 | HtmlBlockMenu | HtmlBlockNoframes | HtmlBlockNoscript | HtmlBlockOl | HtmlBlockP | HtmlBlockPre | HtmlBlockTable | HtmlBlockUl | HtmlBlockDd | HtmlBlockDt | HtmlBlockFrameset | HtmlBlockLi | HtmlBlockTbody | HtmlBlockTd | HtmlBlockTfoot | HtmlBlockTh | HtmlBlockThead | HtmlBlockTr | HtmlBlockScript | HtmlBlockHead)
def _HtmlBlockInTags
_save = self.pos
while true # choice
_tmp = apply(:_HtmlAnchor)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockAddress)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockBlockquote)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockCenter)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockDir)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockDiv)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockDl)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockFieldset)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockForm)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockH1)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockH2)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockH3)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockH4)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockH5)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockH6)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockMenu)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockNoframes)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockNoscript)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockOl)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockP)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockPre)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockTable)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockUl)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockDd)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockDt)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockFrameset)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockLi)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockTbody)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockTd)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockTfoot)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockTh)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockThead)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockTr)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockScript)
break if _tmp
self.pos = _save
_tmp = apply(:_HtmlBlockHead)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_HtmlBlockInTags unless _tmp
return _tmp
end
# HtmlBlock = < (HtmlBlockInTags | HtmlComment | HtmlBlockSelfClosing | HtmlUnclosed) > @BlankLine+ { if html? then RDoc::Markup::Raw.new text end }
def _HtmlBlock
_save = self.pos
while true # sequence
_text_start = self.pos
_save1 = self.pos
while true # choice
_tmp = apply(:_HtmlBlockInTags)
break if _tmp
self.pos = _save1
_tmp = apply(:_HtmlComment)
break if _tmp
self.pos = _save1
_tmp = apply(:_HtmlBlockSelfClosing)
break if _tmp
self.pos = _save1
_tmp = apply(:_HtmlUnclosed)
break if _tmp
self.pos = _save1
break
end # end choice
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = _BlankLine()
if _tmp
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
@result = begin; if html? then
RDoc::Markup::Raw.new text
end ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlock unless _tmp
return _tmp
end
# HtmlUnclosed = "<" Spnl HtmlUnclosedType Spnl HtmlAttribute* Spnl ">"
def _HtmlUnclosed
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlUnclosedType)
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlUnclosed unless _tmp
return _tmp
end
# HtmlUnclosedType = ("HR" | "hr")
def _HtmlUnclosedType
_save = self.pos
while true # choice
_tmp = match_string("HR")
break if _tmp
self.pos = _save
_tmp = match_string("hr")
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_HtmlUnclosedType unless _tmp
return _tmp
end
# HtmlBlockSelfClosing = "<" Spnl HtmlBlockType Spnl HtmlAttribute* "/" Spnl ">"
def _HtmlBlockSelfClosing
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_HtmlBlockType)
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlBlockSelfClosing unless _tmp
return _tmp
end
# HtmlBlockType = ("ADDRESS" | "BLOCKQUOTE" | "CENTER" | "DD" | "DIR" | "DIV" | "DL" | "DT" | "FIELDSET" | "FORM" | "FRAMESET" | "H1" | "H2" | "H3" | "H4" | "H5" | "H6" | "HR" | "ISINDEX" | "LI" | "MENU" | "NOFRAMES" | "NOSCRIPT" | "OL" | "P" | "PRE" | "SCRIPT" | "TABLE" | "TBODY" | "TD" | "TFOOT" | "TH" | "THEAD" | "TR" | "UL" | "address" | "blockquote" | "center" | "dd" | "dir" | "div" | "dl" | "dt" | "fieldset" | "form" | "frameset" | "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "hr" | "isindex" | "li" | "menu" | "noframes" | "noscript" | "ol" | "p" | "pre" | "script" | "table" | "tbody" | "td" | "tfoot" | "th" | "thead" | "tr" | "ul")
def _HtmlBlockType
_save = self.pos
while true # choice
_tmp = match_string("ADDRESS")
break if _tmp
self.pos = _save
_tmp = match_string("BLOCKQUOTE")
break if _tmp
self.pos = _save
_tmp = match_string("CENTER")
break if _tmp
self.pos = _save
_tmp = match_string("DD")
break if _tmp
self.pos = _save
_tmp = match_string("DIR")
break if _tmp
self.pos = _save
_tmp = match_string("DIV")
break if _tmp
self.pos = _save
_tmp = match_string("DL")
break if _tmp
self.pos = _save
_tmp = match_string("DT")
break if _tmp
self.pos = _save
_tmp = match_string("FIELDSET")
break if _tmp
self.pos = _save
_tmp = match_string("FORM")
break if _tmp
self.pos = _save
_tmp = match_string("FRAMESET")
break if _tmp
self.pos = _save
_tmp = match_string("H1")
break if _tmp
self.pos = _save
_tmp = match_string("H2")
break if _tmp
self.pos = _save
_tmp = match_string("H3")
break if _tmp
self.pos = _save
_tmp = match_string("H4")
break if _tmp
self.pos = _save
_tmp = match_string("H5")
break if _tmp
self.pos = _save
_tmp = match_string("H6")
break if _tmp
self.pos = _save
_tmp = match_string("HR")
break if _tmp
self.pos = _save
_tmp = match_string("ISINDEX")
break if _tmp
self.pos = _save
_tmp = match_string("LI")
break if _tmp
self.pos = _save
_tmp = match_string("MENU")
break if _tmp
self.pos = _save
_tmp = match_string("NOFRAMES")
break if _tmp
self.pos = _save
_tmp = match_string("NOSCRIPT")
break if _tmp
self.pos = _save
_tmp = match_string("OL")
break if _tmp
self.pos = _save
_tmp = match_string("P")
break if _tmp
self.pos = _save
_tmp = match_string("PRE")
break if _tmp
self.pos = _save
_tmp = match_string("SCRIPT")
break if _tmp
self.pos = _save
_tmp = match_string("TABLE")
break if _tmp
self.pos = _save
_tmp = match_string("TBODY")
break if _tmp
self.pos = _save
_tmp = match_string("TD")
break if _tmp
self.pos = _save
_tmp = match_string("TFOOT")
break if _tmp
self.pos = _save
_tmp = match_string("TH")
break if _tmp
self.pos = _save
_tmp = match_string("THEAD")
break if _tmp
self.pos = _save
_tmp = match_string("TR")
break if _tmp
self.pos = _save
_tmp = match_string("UL")
break if _tmp
self.pos = _save
_tmp = match_string("address")
break if _tmp
self.pos = _save
_tmp = match_string("blockquote")
break if _tmp
self.pos = _save
_tmp = match_string("center")
break if _tmp
self.pos = _save
_tmp = match_string("dd")
break if _tmp
self.pos = _save
_tmp = match_string("dir")
break if _tmp
self.pos = _save
_tmp = match_string("div")
break if _tmp
self.pos = _save
_tmp = match_string("dl")
break if _tmp
self.pos = _save
_tmp = match_string("dt")
break if _tmp
self.pos = _save
_tmp = match_string("fieldset")
break if _tmp
self.pos = _save
_tmp = match_string("form")
break if _tmp
self.pos = _save
_tmp = match_string("frameset")
break if _tmp
self.pos = _save
_tmp = match_string("h1")
break if _tmp
self.pos = _save
_tmp = match_string("h2")
break if _tmp
self.pos = _save
_tmp = match_string("h3")
break if _tmp
self.pos = _save
_tmp = match_string("h4")
break if _tmp
self.pos = _save
_tmp = match_string("h5")
break if _tmp
self.pos = _save
_tmp = match_string("h6")
break if _tmp
self.pos = _save
_tmp = match_string("hr")
break if _tmp
self.pos = _save
_tmp = match_string("isindex")
break if _tmp
self.pos = _save
_tmp = match_string("li")
break if _tmp
self.pos = _save
_tmp = match_string("menu")
break if _tmp
self.pos = _save
_tmp = match_string("noframes")
break if _tmp
self.pos = _save
_tmp = match_string("noscript")
break if _tmp
self.pos = _save
_tmp = match_string("ol")
break if _tmp
self.pos = _save
_tmp = match_string("p")
break if _tmp
self.pos = _save
_tmp = match_string("pre")
break if _tmp
self.pos = _save
_tmp = match_string("script")
break if _tmp
self.pos = _save
_tmp = match_string("table")
break if _tmp
self.pos = _save
_tmp = match_string("tbody")
break if _tmp
self.pos = _save
_tmp = match_string("td")
break if _tmp
self.pos = _save
_tmp = match_string("tfoot")
break if _tmp
self.pos = _save
_tmp = match_string("th")
break if _tmp
self.pos = _save
_tmp = match_string("thead")
break if _tmp
self.pos = _save
_tmp = match_string("tr")
break if _tmp
self.pos = _save
_tmp = match_string("ul")
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_HtmlBlockType unless _tmp
return _tmp
end
# StyleOpen = "<" Spnl ("style" | "STYLE") Spnl HtmlAttribute* ">"
def _StyleOpen
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("style")
break if _tmp
self.pos = _save1
_tmp = match_string("STYLE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_StyleOpen unless _tmp
return _tmp
end
# StyleClose = "<" Spnl "/" ("style" | "STYLE") Spnl ">"
def _StyleClose
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("/")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = match_string("style")
break if _tmp
self.pos = _save1
_tmp = match_string("STYLE")
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_StyleClose unless _tmp
return _tmp
end
# InStyleTags = StyleOpen (!StyleClose .)* StyleClose
def _InStyleTags
_save = self.pos
while true # sequence
_tmp = apply(:_StyleOpen)
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_tmp = apply(:_StyleClose)
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_StyleClose)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_InStyleTags unless _tmp
return _tmp
end
# StyleBlock = < InStyleTags > @BlankLine* { if css? then RDoc::Markup::Raw.new text end }
def _StyleBlock
_save = self.pos
while true # sequence
_text_start = self.pos
_tmp = apply(:_InStyleTags)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
@result = begin; if css? then
RDoc::Markup::Raw.new text
end ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_StyleBlock unless _tmp
return _tmp
end
# Inlines = (!@Endline Inline:i { i } | @Endline:c !(&{ github? } Ticks3 /[^`\n]*$/) &Inline { c })+:chunks @Endline? { chunks }
def _Inlines
_save = self.pos
while true # sequence
_save1 = self.pos
_ary = []
_save2 = self.pos
while true # choice
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = _Endline()
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_Inline)
i = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; i ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
_save5 = self.pos
while true # sequence
_tmp = _Endline()
c = @result
unless _tmp
self.pos = _save5
break
end
_save6 = self.pos
_save7 = self.pos
while true # sequence
_save8 = self.pos
_tmp = begin; github? ; end
self.pos = _save8
unless _tmp
self.pos = _save7
break
end
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save7
break
end
_tmp = scan(/\G(?-mix:[^`\n]*$)/)
unless _tmp
self.pos = _save7
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_save9 = self.pos
_tmp = apply(:_Inline)
self.pos = _save9
unless _tmp
self.pos = _save5
break
end
@result = begin; c ; end
_tmp = true
unless _tmp
self.pos = _save5
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
if _tmp
_ary << @result
while true
_save10 = self.pos
while true # choice
_save11 = self.pos
while true # sequence
_save12 = self.pos
_tmp = _Endline()
_tmp = _tmp ? nil : true
self.pos = _save12
unless _tmp
self.pos = _save11
break
end
_tmp = apply(:_Inline)
i = @result
unless _tmp
self.pos = _save11
break
end
@result = begin; i ; end
_tmp = true
unless _tmp
self.pos = _save11
end
break
end # end sequence
break if _tmp
self.pos = _save10
_save13 = self.pos
while true # sequence
_tmp = _Endline()
c = @result
unless _tmp
self.pos = _save13
break
end
_save14 = self.pos
_save15 = self.pos
while true # sequence
_save16 = self.pos
_tmp = begin; github? ; end
self.pos = _save16
unless _tmp
self.pos = _save15
break
end
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save15
break
end
_tmp = scan(/\G(?-mix:[^`\n]*$)/)
unless _tmp
self.pos = _save15
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save14
unless _tmp
self.pos = _save13
break
end
_save17 = self.pos
_tmp = apply(:_Inline)
self.pos = _save17
unless _tmp
self.pos = _save13
break
end
@result = begin; c ; end
_tmp = true
unless _tmp
self.pos = _save13
end
break
end # end sequence
break if _tmp
self.pos = _save10
break
end # end choice
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save1
end
chunks = @result
unless _tmp
self.pos = _save
break
end
_save18 = self.pos
_tmp = _Endline()
unless _tmp
_tmp = true
self.pos = _save18
end
unless _tmp
self.pos = _save
break
end
@result = begin; chunks ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Inlines unless _tmp
return _tmp
end
# Inline = (Str | @Endline | UlOrStarLine | @Space | Strong | Emph | Strike | Image | Link | NoteReference | InlineNote | Code | RawHtml | Entity | EscapedChar | Symbol)
def _Inline
_save = self.pos
while true # choice
_tmp = apply(:_Str)
break if _tmp
self.pos = _save
_tmp = _Endline()
break if _tmp
self.pos = _save
_tmp = apply(:_UlOrStarLine)
break if _tmp
self.pos = _save
_tmp = _Space()
break if _tmp
self.pos = _save
_tmp = apply(:_Strong)
break if _tmp
self.pos = _save
_tmp = apply(:_Emph)
break if _tmp
self.pos = _save
_tmp = apply(:_Strike)
break if _tmp
self.pos = _save
_tmp = apply(:_Image)
break if _tmp
self.pos = _save
_tmp = apply(:_Link)
break if _tmp
self.pos = _save
_tmp = apply(:_NoteReference)
break if _tmp
self.pos = _save
_tmp = apply(:_InlineNote)
break if _tmp
self.pos = _save
_tmp = apply(:_Code)
break if _tmp
self.pos = _save
_tmp = apply(:_RawHtml)
break if _tmp
self.pos = _save
_tmp = apply(:_Entity)
break if _tmp
self.pos = _save
_tmp = apply(:_EscapedChar)
break if _tmp
self.pos = _save
_tmp = apply(:_Symbol)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Inline unless _tmp
return _tmp
end
# Space = @Spacechar+ { " " }
def _Space
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = _Spacechar()
if _tmp
while true
_tmp = _Spacechar()
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
@result = begin; " " ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Space unless _tmp
return _tmp
end
# Str = @StartList:a < @NormalChar+ > { a = text } (StrChunk:c { a << c })* { a }
def _Str
_save = self.pos
while true # sequence
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_save1 = self.pos
_tmp = _NormalChar()
if _tmp
while true
_tmp = _NormalChar()
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; a = text ; end
_tmp = true
unless _tmp
self.pos = _save
break
end
while true
_save3 = self.pos
while true # sequence
_tmp = apply(:_StrChunk)
c = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a << c ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Str unless _tmp
return _tmp
end
# StrChunk = < (@NormalChar | /_+/ &Alphanumeric)+ > { text }
def _StrChunk
_save = self.pos
while true # sequence
_text_start = self.pos
_save1 = self.pos
_save2 = self.pos
while true # choice
_tmp = _NormalChar()
break if _tmp
self.pos = _save2
_save3 = self.pos
while true # sequence
_tmp = scan(/\G(?-mix:_+)/)
unless _tmp
self.pos = _save3
break
end
_save4 = self.pos
_tmp = apply(:_Alphanumeric)
self.pos = _save4
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save2
break
end # end choice
if _tmp
while true
_save5 = self.pos
while true # choice
_tmp = _NormalChar()
break if _tmp
self.pos = _save5
_save6 = self.pos
while true # sequence
_tmp = scan(/\G(?-mix:_+)/)
unless _tmp
self.pos = _save6
break
end
_save7 = self.pos
_tmp = apply(:_Alphanumeric)
self.pos = _save7
unless _tmp
self.pos = _save6
end
break
end # end sequence
break if _tmp
self.pos = _save5
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_StrChunk unless _tmp
return _tmp
end
# EscapedChar = "\\" !@Newline < /[:\\`|*_{}\[\]()#+.!><-]/ > { text }
def _EscapedChar
_save = self.pos
while true # sequence
_tmp = match_string("\\")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_tmp = scan(/\G(?-mix:[:\\`|*_{}\[\]()#+.!><-])/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_EscapedChar unless _tmp
return _tmp
end
# Entity = (HexEntity | DecEntity | CharEntity):a { a }
def _Entity
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_tmp = apply(:_HexEntity)
break if _tmp
self.pos = _save1
_tmp = apply(:_DecEntity)
break if _tmp
self.pos = _save1
_tmp = apply(:_CharEntity)
break if _tmp
self.pos = _save1
break
end # end choice
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Entity unless _tmp
return _tmp
end
# Endline = (@LineBreak | @TerminalEndline | @NormalEndline)
def _Endline
_save = self.pos
while true # choice
_tmp = _LineBreak()
break if _tmp
self.pos = _save
_tmp = _TerminalEndline()
break if _tmp
self.pos = _save
_tmp = _NormalEndline()
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Endline unless _tmp
return _tmp
end
# NormalEndline = @Sp @Newline !@BlankLine !">" !AtxStart !(Line /={1,}|-{1,}/ @Newline) { "\n" }
def _NormalEndline
_save = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save2
unless _tmp
self.pos = _save
break
end
_save3 = self.pos
_tmp = apply(:_AtxStart)
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save
break
end
_save4 = self.pos
_save5 = self.pos
while true # sequence
_tmp = apply(:_Line)
unless _tmp
self.pos = _save5
break
end
_tmp = scan(/\G(?-mix:={1,}|-{1,})/)
unless _tmp
self.pos = _save5
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save5
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save
break
end
@result = begin; "\n" ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_NormalEndline unless _tmp
return _tmp
end
# TerminalEndline = @Sp @Newline @Eof
def _TerminalEndline
_save = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
_tmp = _Eof()
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TerminalEndline unless _tmp
return _tmp
end
# LineBreak = " " @NormalEndline { RDoc::Markup::HardBreak.new }
def _LineBreak
_save = self.pos
while true # sequence
_tmp = match_string(" ")
unless _tmp
self.pos = _save
break
end
_tmp = _NormalEndline()
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::HardBreak.new ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_LineBreak unless _tmp
return _tmp
end
# Symbol = < @SpecialChar > { text }
def _Symbol
_save = self.pos
while true # sequence
_text_start = self.pos
_tmp = _SpecialChar()
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Symbol unless _tmp
return _tmp
end
# UlOrStarLine = (UlLine | StarLine):a { a }
def _UlOrStarLine
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_tmp = apply(:_UlLine)
break if _tmp
self.pos = _save1
_tmp = apply(:_StarLine)
break if _tmp
self.pos = _save1
break
end # end choice
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_UlOrStarLine unless _tmp
return _tmp
end
# StarLine = (< /\*{4,}/ > { text } | < @Spacechar /\*+/ &@Spacechar > { text })
def _StarLine
_save = self.pos
while true # choice
_save1 = self.pos
while true # sequence
_text_start = self.pos
_tmp = scan(/\G(?-mix:\*{4,})/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save1
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save1
end
break
end # end sequence
break if _tmp
self.pos = _save
_save2 = self.pos
while true # sequence
_text_start = self.pos
_save3 = self.pos
while true # sequence
_tmp = _Spacechar()
unless _tmp
self.pos = _save3
break
end
_tmp = scan(/\G(?-mix:\*+)/)
unless _tmp
self.pos = _save3
break
end
_save4 = self.pos
_tmp = _Spacechar()
self.pos = _save4
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save2
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_StarLine unless _tmp
return _tmp
end
# UlLine = (< /_{4,}/ > { text } | < @Spacechar /_+/ &@Spacechar > { text })
def _UlLine
_save = self.pos
while true # choice
_save1 = self.pos
while true # sequence
_text_start = self.pos
_tmp = scan(/\G(?-mix:_{4,})/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save1
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save1
end
break
end # end sequence
break if _tmp
self.pos = _save
_save2 = self.pos
while true # sequence
_text_start = self.pos
_save3 = self.pos
while true # sequence
_tmp = _Spacechar()
unless _tmp
self.pos = _save3
break
end
_tmp = scan(/\G(?-mix:_+)/)
unless _tmp
self.pos = _save3
break
end
_save4 = self.pos
_tmp = _Spacechar()
self.pos = _save4
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save2
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_UlLine unless _tmp
return _tmp
end
# Emph = (EmphStar | EmphUl)
def _Emph
_save = self.pos
while true # choice
_tmp = apply(:_EmphStar)
break if _tmp
self.pos = _save
_tmp = apply(:_EmphUl)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Emph unless _tmp
return _tmp
end
# Whitespace = (@Spacechar | @Newline)
def _Whitespace
_save = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save
_tmp = _Newline()
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Whitespace unless _tmp
return _tmp
end
# EmphStar = "*" !@Whitespace @StartList:a (!"*" Inline:b { a << b } | StrongStar:b { a << b })+ "*" { emphasis a.join }
def _EmphStar
_save = self.pos
while true # sequence
_tmp = match_string("*")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _Whitespace()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # choice
_save4 = self.pos
while true # sequence
_save5 = self.pos
_tmp = match_string("*")
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save4
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save4
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save4
end
break
end # end sequence
break if _tmp
self.pos = _save3
_save6 = self.pos
while true # sequence
_tmp = apply(:_StrongStar)
b = @result
unless _tmp
self.pos = _save6
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save6
end
break
end # end sequence
break if _tmp
self.pos = _save3
break
end # end choice
if _tmp
while true
_save7 = self.pos
while true # choice
_save8 = self.pos
while true # sequence
_save9 = self.pos
_tmp = match_string("*")
_tmp = _tmp ? nil : true
self.pos = _save9
unless _tmp
self.pos = _save8
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save8
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save8
end
break
end # end sequence
break if _tmp
self.pos = _save7
_save10 = self.pos
while true # sequence
_tmp = apply(:_StrongStar)
b = @result
unless _tmp
self.pos = _save10
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save10
end
break
end # end sequence
break if _tmp
self.pos = _save7
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("*")
unless _tmp
self.pos = _save
break
end
@result = begin; emphasis a.join ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_EmphStar unless _tmp
return _tmp
end
# EmphUl = "_" !@Whitespace @StartList:a (!"_" Inline:b { a << b } | StrongUl:b { a << b })+ "_" { emphasis a.join }
def _EmphUl
_save = self.pos
while true # sequence
_tmp = match_string("_")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _Whitespace()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # choice
_save4 = self.pos
while true # sequence
_save5 = self.pos
_tmp = match_string("_")
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save4
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save4
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save4
end
break
end # end sequence
break if _tmp
self.pos = _save3
_save6 = self.pos
while true # sequence
_tmp = apply(:_StrongUl)
b = @result
unless _tmp
self.pos = _save6
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save6
end
break
end # end sequence
break if _tmp
self.pos = _save3
break
end # end choice
if _tmp
while true
_save7 = self.pos
while true # choice
_save8 = self.pos
while true # sequence
_save9 = self.pos
_tmp = match_string("_")
_tmp = _tmp ? nil : true
self.pos = _save9
unless _tmp
self.pos = _save8
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save8
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save8
end
break
end # end sequence
break if _tmp
self.pos = _save7
_save10 = self.pos
while true # sequence
_tmp = apply(:_StrongUl)
b = @result
unless _tmp
self.pos = _save10
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save10
end
break
end # end sequence
break if _tmp
self.pos = _save7
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("_")
unless _tmp
self.pos = _save
break
end
@result = begin; emphasis a.join ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_EmphUl unless _tmp
return _tmp
end
# Strong = (StrongStar | StrongUl)
def _Strong
_save = self.pos
while true # choice
_tmp = apply(:_StrongStar)
break if _tmp
self.pos = _save
_tmp = apply(:_StrongUl)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Strong unless _tmp
return _tmp
end
# StrongStar = "**" !@Whitespace @StartList:a (!"**" Inline:b { a << b })+ "**" { strong a.join }
def _StrongStar
_save = self.pos
while true # sequence
_tmp = match_string("**")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _Whitespace()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = match_string("**")
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
while true
_save5 = self.pos
while true # sequence
_save6 = self.pos
_tmp = match_string("**")
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save5
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save5
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("**")
unless _tmp
self.pos = _save
break
end
@result = begin; strong a.join ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_StrongStar unless _tmp
return _tmp
end
# StrongUl = "__" !@Whitespace @StartList:a (!"__" Inline:b { a << b })+ "__" { strong a.join }
def _StrongUl
_save = self.pos
while true # sequence
_tmp = match_string("__")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _Whitespace()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = match_string("__")
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
while true
_save5 = self.pos
while true # sequence
_save6 = self.pos
_tmp = match_string("__")
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save5
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save5
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("__")
unless _tmp
self.pos = _save
break
end
@result = begin; strong a.join ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_StrongUl unless _tmp
return _tmp
end
# Strike = &{ strike? } "~~" !@Whitespace @StartList:a (!"~~" Inline:b { a << b })+ "~~" { strike a.join }
def _Strike
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; strike? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = match_string("~~")
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = _Whitespace()
_tmp = _tmp ? nil : true
self.pos = _save2
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save3 = self.pos
_save4 = self.pos
while true # sequence
_save5 = self.pos
_tmp = match_string("~~")
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save4
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save4
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save4
end
break
end # end sequence
if _tmp
while true
_save6 = self.pos
while true # sequence
_save7 = self.pos
_tmp = match_string("~~")
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save6
break
end
_tmp = apply(:_Inline)
b = @result
unless _tmp
self.pos = _save6
break
end
@result = begin; a << b ; end
_tmp = true
unless _tmp
self.pos = _save6
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save3
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("~~")
unless _tmp
self.pos = _save
break
end
@result = begin; strike a.join ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Strike unless _tmp
return _tmp
end
# Image = "!" (ExplicitLink | ReferenceLink):a { "rdoc-image:#{a[/\[(.*)\]/, 1]}" }
def _Image
_save = self.pos
while true # sequence
_tmp = match_string("!")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_tmp = apply(:_ExplicitLink)
break if _tmp
self.pos = _save1
_tmp = apply(:_ReferenceLink)
break if _tmp
self.pos = _save1
break
end # end choice
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; "rdoc-image:#{a[/\[(.*)\]/, 1]}" ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Image unless _tmp
return _tmp
end
# Link = (ExplicitLink | ReferenceLink | AutoLink)
def _Link
_save = self.pos
while true # choice
_tmp = apply(:_ExplicitLink)
break if _tmp
self.pos = _save
_tmp = apply(:_ReferenceLink)
break if _tmp
self.pos = _save
_tmp = apply(:_AutoLink)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Link unless _tmp
return _tmp
end
# ReferenceLink = (ReferenceLinkDouble | ReferenceLinkSingle)
def _ReferenceLink
_save = self.pos
while true # choice
_tmp = apply(:_ReferenceLinkDouble)
break if _tmp
self.pos = _save
_tmp = apply(:_ReferenceLinkSingle)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_ReferenceLink unless _tmp
return _tmp
end
# ReferenceLinkDouble = Label:content < Spnl > !"[]" Label:label { link_to content, label, text }
def _ReferenceLinkDouble
_save = self.pos
while true # sequence
_tmp = apply(:_Label)
content = @result
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_tmp = apply(:_Spnl)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("[]")
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Label)
label = @result
unless _tmp
self.pos = _save
break
end
@result = begin; link_to content, label, text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ReferenceLinkDouble unless _tmp
return _tmp
end
# ReferenceLinkSingle = Label:content < (Spnl "[]")? > { link_to content, content, text }
def _ReferenceLinkSingle
_save = self.pos
while true # sequence
_tmp = apply(:_Label)
content = @result
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_save1 = self.pos
_save2 = self.pos
while true # sequence
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save2
break
end
_tmp = match_string("[]")
unless _tmp
self.pos = _save2
end
break
end # end sequence
unless _tmp
_tmp = true
self.pos = _save1
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; link_to content, content, text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ReferenceLinkSingle unless _tmp
return _tmp
end
# ExplicitLink = Label:l "(" @Sp Source:s Spnl Title @Sp ")" { "{#{l}}[#{s}]" }
def _ExplicitLink
_save = self.pos
while true # sequence
_tmp = apply(:_Label)
l = @result
unless _tmp
self.pos = _save
break
end
_tmp = match_string("(")
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Source)
s = @result
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Title)
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = match_string(")")
unless _tmp
self.pos = _save
break
end
@result = begin; "{#{l}}[#{s}]" ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ExplicitLink unless _tmp
return _tmp
end
# Source = ("<" < SourceContents > ">" | < SourceContents >) { text }
def _Source
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_save2 = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save2
break
end
_text_start = self.pos
_tmp = apply(:_SourceContents)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save2
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save2
end
break
end # end sequence
break if _tmp
self.pos = _save1
_text_start = self.pos
_tmp = apply(:_SourceContents)
if _tmp
text = get_text(_text_start)
end
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Source unless _tmp
return _tmp
end
# SourceContents = ((!"(" !")" !">" Nonspacechar)+ | "(" SourceContents ")")*
def _SourceContents
while true
_save1 = self.pos
while true # choice
_save2 = self.pos
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = match_string("(")
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_save5 = self.pos
_tmp = match_string(")")
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save3
break
end
_save6 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
while true
_save7 = self.pos
while true # sequence
_save8 = self.pos
_tmp = match_string("(")
_tmp = _tmp ? nil : true
self.pos = _save8
unless _tmp
self.pos = _save7
break
end
_save9 = self.pos
_tmp = match_string(")")
_tmp = _tmp ? nil : true
self.pos = _save9
unless _tmp
self.pos = _save7
break
end
_save10 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save10
unless _tmp
self.pos = _save7
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save7
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
break if _tmp
self.pos = _save1
_save11 = self.pos
while true # sequence
_tmp = match_string("(")
unless _tmp
self.pos = _save11
break
end
_tmp = apply(:_SourceContents)
unless _tmp
self.pos = _save11
break
end
_tmp = match_string(")")
unless _tmp
self.pos = _save11
end
break
end # end sequence
break if _tmp
self.pos = _save1
break
end # end choice
break unless _tmp
end
_tmp = true
set_failed_rule :_SourceContents unless _tmp
return _tmp
end
# Title = (TitleSingle | TitleDouble | ""):a { a }
def _Title
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_tmp = apply(:_TitleSingle)
break if _tmp
self.pos = _save1
_tmp = apply(:_TitleDouble)
break if _tmp
self.pos = _save1
_tmp = match_string("")
break if _tmp
self.pos = _save1
break
end # end choice
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Title unless _tmp
return _tmp
end
# TitleSingle = "'" (!("'" @Sp (")" | @Newline)) .)* "'"
def _TitleSingle
_save = self.pos
while true # sequence
_tmp = match_string("'")
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_save4 = self.pos
while true # sequence
_tmp = match_string("'")
unless _tmp
self.pos = _save4
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save4
break
end
_save5 = self.pos
while true # choice
_tmp = match_string(")")
break if _tmp
self.pos = _save5
_tmp = _Newline()
break if _tmp
self.pos = _save5
break
end # end choice
unless _tmp
self.pos = _save4
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string("'")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TitleSingle unless _tmp
return _tmp
end
# TitleDouble = "\"" (!("\"" @Sp (")" | @Newline)) .)* "\""
def _TitleDouble
_save = self.pos
while true # sequence
_tmp = match_string("\"")
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_save4 = self.pos
while true # sequence
_tmp = match_string("\"")
unless _tmp
self.pos = _save4
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save4
break
end
_save5 = self.pos
while true # choice
_tmp = match_string(")")
break if _tmp
self.pos = _save5
_tmp = _Newline()
break if _tmp
self.pos = _save5
break
end # end choice
unless _tmp
self.pos = _save4
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string("\"")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TitleDouble unless _tmp
return _tmp
end
# AutoLink = (AutoLinkUrl | AutoLinkEmail)
def _AutoLink
_save = self.pos
while true # choice
_tmp = apply(:_AutoLinkUrl)
break if _tmp
self.pos = _save
_tmp = apply(:_AutoLinkEmail)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_AutoLink unless _tmp
return _tmp
end
# AutoLinkUrl = "<" < /[A-Za-z]+/ "://" (!@Newline !">" .)+ > ">" { text }
def _AutoLinkUrl
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_save1 = self.pos
while true # sequence
_tmp = scan(/\G(?-mix:[A-Za-z]+)/)
unless _tmp
self.pos = _save1
break
end
_tmp = match_string("://")
unless _tmp
self.pos = _save1
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_save5 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
while true
_save6 = self.pos
while true # sequence
_save7 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save6
break
end
_save8 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save8
unless _tmp
self.pos = _save6
break
end
_tmp = get_byte
unless _tmp
self.pos = _save6
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save1
end
break
end # end sequence
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_AutoLinkUrl unless _tmp
return _tmp
end
# AutoLinkEmail = "<" "mailto:"? < /[\w+.\/!%~$-]+/i "@" (!@Newline !">" .)+ > ">" { "mailto:#{text}" }
def _AutoLinkEmail
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("mailto:")
unless _tmp
_tmp = true
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_save2 = self.pos
while true # sequence
_tmp = scan(/\G(?i-mx:[\w+.\/!%~$-]+)/)
unless _tmp
self.pos = _save2
break
end
_tmp = match_string("@")
unless _tmp
self.pos = _save2
break
end
_save3 = self.pos
_save4 = self.pos
while true # sequence
_save5 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save4
break
end
_save6 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save4
break
end
_tmp = get_byte
unless _tmp
self.pos = _save4
end
break
end # end sequence
if _tmp
while true
_save7 = self.pos
while true # sequence
_save8 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save8
unless _tmp
self.pos = _save7
break
end
_save9 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save9
unless _tmp
self.pos = _save7
break
end
_tmp = get_byte
unless _tmp
self.pos = _save7
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save3
end
unless _tmp
self.pos = _save2
end
break
end # end sequence
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
break
end
@result = begin; "mailto:#{text}" ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_AutoLinkEmail unless _tmp
return _tmp
end
# Reference = @NonindentSpace !"[]" Label:label ":" Spnl RefSrc:link RefTitle @BlankLine+ { # TODO use title reference label, link nil }
def _Reference
_save = self.pos
while true # sequence
_tmp = _NonindentSpace()
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("[]")
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Label)
label = @result
unless _tmp
self.pos = _save
break
end
_tmp = match_string(":")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_RefSrc)
link = @result
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_RefTitle)
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = _BlankLine()
if _tmp
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
@result = begin; # TODO use title
reference label, link
nil
; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Reference unless _tmp
return _tmp
end
# Label = "[" (!"^" &{ notes? } | &. &{ !notes? }) @StartList:a (!"]" Inline:l { a << l })* "]" { a.join.gsub(/\s+/, ' ') }
def _Label
_save = self.pos
while true # sequence
_tmp = match_string("[")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
while true # choice
_save2 = self.pos
while true # sequence
_save3 = self.pos
_tmp = match_string("^")
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_save4 = self.pos
_tmp = begin; notes? ; end
self.pos = _save4
unless _tmp
self.pos = _save2
end
break
end # end sequence
break if _tmp
self.pos = _save1
_save5 = self.pos
while true # sequence
_save6 = self.pos
_tmp = get_byte
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_save7 = self.pos
_tmp = begin; !notes? ; end
self.pos = _save7
unless _tmp
self.pos = _save5
end
break
end # end sequence
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
while true
_save9 = self.pos
while true # sequence
_save10 = self.pos
_tmp = match_string("]")
_tmp = _tmp ? nil : true
self.pos = _save10
unless _tmp
self.pos = _save9
break
end
_tmp = apply(:_Inline)
l = @result
unless _tmp
self.pos = _save9
break
end
@result = begin; a << l ; end
_tmp = true
unless _tmp
self.pos = _save9
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string("]")
unless _tmp
self.pos = _save
break
end
@result = begin; a.join.gsub(/\s+/, ' ') ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Label unless _tmp
return _tmp
end
# RefSrc = < Nonspacechar+ > { text }
def _RefSrc
_save = self.pos
while true # sequence
_text_start = self.pos
_save1 = self.pos
_tmp = apply(:_Nonspacechar)
if _tmp
while true
_tmp = apply(:_Nonspacechar)
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RefSrc unless _tmp
return _tmp
end
# RefTitle = (RefTitleSingle | RefTitleDouble | RefTitleParens | EmptyTitle)
def _RefTitle
_save = self.pos
while true # choice
_tmp = apply(:_RefTitleSingle)
break if _tmp
self.pos = _save
_tmp = apply(:_RefTitleDouble)
break if _tmp
self.pos = _save
_tmp = apply(:_RefTitleParens)
break if _tmp
self.pos = _save
_tmp = apply(:_EmptyTitle)
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_RefTitle unless _tmp
return _tmp
end
# EmptyTitle = ""
def _EmptyTitle
_tmp = match_string("")
set_failed_rule :_EmptyTitle unless _tmp
return _tmp
end
# RefTitleSingle = Spnl "'" < (!("'" @Sp @Newline | @Newline) .)* > "'" { text }
def _RefTitleSingle
_save = self.pos
while true # sequence
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("'")
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_save4 = self.pos
while true # choice
_save5 = self.pos
while true # sequence
_tmp = match_string("'")
unless _tmp
self.pos = _save5
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save5
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save5
end
break
end # end sequence
break if _tmp
self.pos = _save4
_tmp = _Newline()
break if _tmp
self.pos = _save4
break
end # end choice
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("'")
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RefTitleSingle unless _tmp
return _tmp
end
# RefTitleDouble = Spnl "\"" < (!("\"" @Sp @Newline | @Newline) .)* > "\"" { text }
def _RefTitleDouble
_save = self.pos
while true # sequence
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("\"")
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_save4 = self.pos
while true # choice
_save5 = self.pos
while true # sequence
_tmp = match_string("\"")
unless _tmp
self.pos = _save5
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save5
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save5
end
break
end # end sequence
break if _tmp
self.pos = _save4
_tmp = _Newline()
break if _tmp
self.pos = _save4
break
end # end choice
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("\"")
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RefTitleDouble unless _tmp
return _tmp
end
# RefTitleParens = Spnl "(" < (!(")" @Sp @Newline | @Newline) .)* > ")" { text }
def _RefTitleParens
_save = self.pos
while true # sequence
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string("(")
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_save4 = self.pos
while true # choice
_save5 = self.pos
while true # sequence
_tmp = match_string(")")
unless _tmp
self.pos = _save5
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save5
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save5
end
break
end # end sequence
break if _tmp
self.pos = _save4
_tmp = _Newline()
break if _tmp
self.pos = _save4
break
end # end choice
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string(")")
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RefTitleParens unless _tmp
return _tmp
end
# References = (Reference | SkipBlock)*
def _References
while true
_save1 = self.pos
while true # choice
_tmp = apply(:_Reference)
break if _tmp
self.pos = _save1
_tmp = apply(:_SkipBlock)
break if _tmp
self.pos = _save1
break
end # end choice
break unless _tmp
end
_tmp = true
set_failed_rule :_References unless _tmp
return _tmp
end
# Ticks1 = "`" !"`"
def _Ticks1
_save = self.pos
while true # sequence
_tmp = match_string("`")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Ticks1 unless _tmp
return _tmp
end
# Ticks2 = "``" !"`"
def _Ticks2
_save = self.pos
while true # sequence
_tmp = match_string("``")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Ticks2 unless _tmp
return _tmp
end
# Ticks3 = "```" !"`"
def _Ticks3
_save = self.pos
while true # sequence
_tmp = match_string("```")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Ticks3 unless _tmp
return _tmp
end
# Ticks4 = "````" !"`"
def _Ticks4
_save = self.pos
while true # sequence
_tmp = match_string("````")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Ticks4 unless _tmp
return _tmp
end
# Ticks5 = "`````" !"`"
def _Ticks5
_save = self.pos
while true # sequence
_tmp = match_string("`````")
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Ticks5 unless _tmp
return _tmp
end
# Code = (Ticks1 @Sp < ((!"`" Nonspacechar)+ | !Ticks1 /`+/ | !(@Sp Ticks1) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks1 | Ticks2 @Sp < ((!"`" Nonspacechar)+ | !Ticks2 /`+/ | !(@Sp Ticks2) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks2 | Ticks3 @Sp < ((!"`" Nonspacechar)+ | !Ticks3 /`+/ | !(@Sp Ticks3) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks3 | Ticks4 @Sp < ((!"`" Nonspacechar)+ | !Ticks4 /`+/ | !(@Sp Ticks4) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks4 | Ticks5 @Sp < ((!"`" Nonspacechar)+ | !Ticks5 /`+/ | !(@Sp Ticks5) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks5) { "<code>#{text}</code>" }
def _Code
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_save2 = self.pos
while true # sequence
_tmp = apply(:_Ticks1)
unless _tmp
self.pos = _save2
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save2
break
end
_text_start = self.pos
_save3 = self.pos
_save4 = self.pos
while true # choice
_save5 = self.pos
_save6 = self.pos
while true # sequence
_save7 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save6
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save6
end
break
end # end sequence
if _tmp
while true
_save8 = self.pos
while true # sequence
_save9 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save9
unless _tmp
self.pos = _save8
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save8
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save5
end
break if _tmp
self.pos = _save4
_save10 = self.pos
while true # sequence
_save11 = self.pos
_tmp = apply(:_Ticks1)
_tmp = _tmp ? nil : true
self.pos = _save11
unless _tmp
self.pos = _save10
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save10
end
break
end # end sequence
break if _tmp
self.pos = _save4
_save12 = self.pos
while true # sequence
_save13 = self.pos
_save14 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save14
break
end
_tmp = apply(:_Ticks1)
unless _tmp
self.pos = _save14
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save13
unless _tmp
self.pos = _save12
break
end
_save15 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save15
_save16 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save16
break
end
_save17 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save17
unless _tmp
self.pos = _save16
end
break
end # end sequence
break if _tmp
self.pos = _save15
break
end # end choice
unless _tmp
self.pos = _save12
end
break
end # end sequence
break if _tmp
self.pos = _save4
break
end # end choice
if _tmp
while true
_save18 = self.pos
while true # choice
_save19 = self.pos
_save20 = self.pos
while true # sequence
_save21 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save21
unless _tmp
self.pos = _save20
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save20
end
break
end # end sequence
if _tmp
while true
_save22 = self.pos
while true # sequence
_save23 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save23
unless _tmp
self.pos = _save22
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save22
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save19
end
break if _tmp
self.pos = _save18
_save24 = self.pos
while true # sequence
_save25 = self.pos
_tmp = apply(:_Ticks1)
_tmp = _tmp ? nil : true
self.pos = _save25
unless _tmp
self.pos = _save24
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save24
end
break
end # end sequence
break if _tmp
self.pos = _save18
_save26 = self.pos
while true # sequence
_save27 = self.pos
_save28 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save28
break
end
_tmp = apply(:_Ticks1)
unless _tmp
self.pos = _save28
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save27
unless _tmp
self.pos = _save26
break
end
_save29 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save29
_save30 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save30
break
end
_save31 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save31
unless _tmp
self.pos = _save30
end
break
end # end sequence
break if _tmp
self.pos = _save29
break
end # end choice
unless _tmp
self.pos = _save26
end
break
end # end sequence
break if _tmp
self.pos = _save18
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save3
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save2
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save2
break
end
_tmp = apply(:_Ticks1)
unless _tmp
self.pos = _save2
end
break
end # end sequence
break if _tmp
self.pos = _save1
_save32 = self.pos
while true # sequence
_tmp = apply(:_Ticks2)
unless _tmp
self.pos = _save32
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save32
break
end
_text_start = self.pos
_save33 = self.pos
_save34 = self.pos
while true # choice
_save35 = self.pos
_save36 = self.pos
while true # sequence
_save37 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save37
unless _tmp
self.pos = _save36
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save36
end
break
end # end sequence
if _tmp
while true
_save38 = self.pos
while true # sequence
_save39 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save39
unless _tmp
self.pos = _save38
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save38
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save35
end
break if _tmp
self.pos = _save34
_save40 = self.pos
while true # sequence
_save41 = self.pos
_tmp = apply(:_Ticks2)
_tmp = _tmp ? nil : true
self.pos = _save41
unless _tmp
self.pos = _save40
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save40
end
break
end # end sequence
break if _tmp
self.pos = _save34
_save42 = self.pos
while true # sequence
_save43 = self.pos
_save44 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save44
break
end
_tmp = apply(:_Ticks2)
unless _tmp
self.pos = _save44
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save43
unless _tmp
self.pos = _save42
break
end
_save45 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save45
_save46 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save46
break
end
_save47 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save47
unless _tmp
self.pos = _save46
end
break
end # end sequence
break if _tmp
self.pos = _save45
break
end # end choice
unless _tmp
self.pos = _save42
end
break
end # end sequence
break if _tmp
self.pos = _save34
break
end # end choice
if _tmp
while true
_save48 = self.pos
while true # choice
_save49 = self.pos
_save50 = self.pos
while true # sequence
_save51 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save51
unless _tmp
self.pos = _save50
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save50
end
break
end # end sequence
if _tmp
while true
_save52 = self.pos
while true # sequence
_save53 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save53
unless _tmp
self.pos = _save52
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save52
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save49
end
break if _tmp
self.pos = _save48
_save54 = self.pos
while true # sequence
_save55 = self.pos
_tmp = apply(:_Ticks2)
_tmp = _tmp ? nil : true
self.pos = _save55
unless _tmp
self.pos = _save54
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save54
end
break
end # end sequence
break if _tmp
self.pos = _save48
_save56 = self.pos
while true # sequence
_save57 = self.pos
_save58 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save58
break
end
_tmp = apply(:_Ticks2)
unless _tmp
self.pos = _save58
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save57
unless _tmp
self.pos = _save56
break
end
_save59 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save59
_save60 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save60
break
end
_save61 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save61
unless _tmp
self.pos = _save60
end
break
end # end sequence
break if _tmp
self.pos = _save59
break
end # end choice
unless _tmp
self.pos = _save56
end
break
end # end sequence
break if _tmp
self.pos = _save48
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save33
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save32
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save32
break
end
_tmp = apply(:_Ticks2)
unless _tmp
self.pos = _save32
end
break
end # end sequence
break if _tmp
self.pos = _save1
_save62 = self.pos
while true # sequence
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save62
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save62
break
end
_text_start = self.pos
_save63 = self.pos
_save64 = self.pos
while true # choice
_save65 = self.pos
_save66 = self.pos
while true # sequence
_save67 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save67
unless _tmp
self.pos = _save66
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save66
end
break
end # end sequence
if _tmp
while true
_save68 = self.pos
while true # sequence
_save69 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save69
unless _tmp
self.pos = _save68
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save68
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save65
end
break if _tmp
self.pos = _save64
_save70 = self.pos
while true # sequence
_save71 = self.pos
_tmp = apply(:_Ticks3)
_tmp = _tmp ? nil : true
self.pos = _save71
unless _tmp
self.pos = _save70
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save70
end
break
end # end sequence
break if _tmp
self.pos = _save64
_save72 = self.pos
while true # sequence
_save73 = self.pos
_save74 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save74
break
end
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save74
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save73
unless _tmp
self.pos = _save72
break
end
_save75 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save75
_save76 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save76
break
end
_save77 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save77
unless _tmp
self.pos = _save76
end
break
end # end sequence
break if _tmp
self.pos = _save75
break
end # end choice
unless _tmp
self.pos = _save72
end
break
end # end sequence
break if _tmp
self.pos = _save64
break
end # end choice
if _tmp
while true
_save78 = self.pos
while true # choice
_save79 = self.pos
_save80 = self.pos
while true # sequence
_save81 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save81
unless _tmp
self.pos = _save80
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save80
end
break
end # end sequence
if _tmp
while true
_save82 = self.pos
while true # sequence
_save83 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save83
unless _tmp
self.pos = _save82
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save82
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save79
end
break if _tmp
self.pos = _save78
_save84 = self.pos
while true # sequence
_save85 = self.pos
_tmp = apply(:_Ticks3)
_tmp = _tmp ? nil : true
self.pos = _save85
unless _tmp
self.pos = _save84
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save84
end
break
end # end sequence
break if _tmp
self.pos = _save78
_save86 = self.pos
while true # sequence
_save87 = self.pos
_save88 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save88
break
end
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save88
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save87
unless _tmp
self.pos = _save86
break
end
_save89 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save89
_save90 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save90
break
end
_save91 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save91
unless _tmp
self.pos = _save90
end
break
end # end sequence
break if _tmp
self.pos = _save89
break
end # end choice
unless _tmp
self.pos = _save86
end
break
end # end sequence
break if _tmp
self.pos = _save78
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save63
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save62
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save62
break
end
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save62
end
break
end # end sequence
break if _tmp
self.pos = _save1
_save92 = self.pos
while true # sequence
_tmp = apply(:_Ticks4)
unless _tmp
self.pos = _save92
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save92
break
end
_text_start = self.pos
_save93 = self.pos
_save94 = self.pos
while true # choice
_save95 = self.pos
_save96 = self.pos
while true # sequence
_save97 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save97
unless _tmp
self.pos = _save96
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save96
end
break
end # end sequence
if _tmp
while true
_save98 = self.pos
while true # sequence
_save99 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save99
unless _tmp
self.pos = _save98
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save98
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save95
end
break if _tmp
self.pos = _save94
_save100 = self.pos
while true # sequence
_save101 = self.pos
_tmp = apply(:_Ticks4)
_tmp = _tmp ? nil : true
self.pos = _save101
unless _tmp
self.pos = _save100
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save100
end
break
end # end sequence
break if _tmp
self.pos = _save94
_save102 = self.pos
while true # sequence
_save103 = self.pos
_save104 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save104
break
end
_tmp = apply(:_Ticks4)
unless _tmp
self.pos = _save104
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save103
unless _tmp
self.pos = _save102
break
end
_save105 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save105
_save106 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save106
break
end
_save107 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save107
unless _tmp
self.pos = _save106
end
break
end # end sequence
break if _tmp
self.pos = _save105
break
end # end choice
unless _tmp
self.pos = _save102
end
break
end # end sequence
break if _tmp
self.pos = _save94
break
end # end choice
if _tmp
while true
_save108 = self.pos
while true # choice
_save109 = self.pos
_save110 = self.pos
while true # sequence
_save111 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save111
unless _tmp
self.pos = _save110
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save110
end
break
end # end sequence
if _tmp
while true
_save112 = self.pos
while true # sequence
_save113 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save113
unless _tmp
self.pos = _save112
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save112
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save109
end
break if _tmp
self.pos = _save108
_save114 = self.pos
while true # sequence
_save115 = self.pos
_tmp = apply(:_Ticks4)
_tmp = _tmp ? nil : true
self.pos = _save115
unless _tmp
self.pos = _save114
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save114
end
break
end # end sequence
break if _tmp
self.pos = _save108
_save116 = self.pos
while true # sequence
_save117 = self.pos
_save118 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save118
break
end
_tmp = apply(:_Ticks4)
unless _tmp
self.pos = _save118
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save117
unless _tmp
self.pos = _save116
break
end
_save119 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save119
_save120 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save120
break
end
_save121 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save121
unless _tmp
self.pos = _save120
end
break
end # end sequence
break if _tmp
self.pos = _save119
break
end # end choice
unless _tmp
self.pos = _save116
end
break
end # end sequence
break if _tmp
self.pos = _save108
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save93
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save92
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save92
break
end
_tmp = apply(:_Ticks4)
unless _tmp
self.pos = _save92
end
break
end # end sequence
break if _tmp
self.pos = _save1
_save122 = self.pos
while true # sequence
_tmp = apply(:_Ticks5)
unless _tmp
self.pos = _save122
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save122
break
end
_text_start = self.pos
_save123 = self.pos
_save124 = self.pos
while true # choice
_save125 = self.pos
_save126 = self.pos
while true # sequence
_save127 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save127
unless _tmp
self.pos = _save126
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save126
end
break
end # end sequence
if _tmp
while true
_save128 = self.pos
while true # sequence
_save129 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save129
unless _tmp
self.pos = _save128
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save128
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save125
end
break if _tmp
self.pos = _save124
_save130 = self.pos
while true # sequence
_save131 = self.pos
_tmp = apply(:_Ticks5)
_tmp = _tmp ? nil : true
self.pos = _save131
unless _tmp
self.pos = _save130
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save130
end
break
end # end sequence
break if _tmp
self.pos = _save124
_save132 = self.pos
while true # sequence
_save133 = self.pos
_save134 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save134
break
end
_tmp = apply(:_Ticks5)
unless _tmp
self.pos = _save134
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save133
unless _tmp
self.pos = _save132
break
end
_save135 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save135
_save136 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save136
break
end
_save137 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save137
unless _tmp
self.pos = _save136
end
break
end # end sequence
break if _tmp
self.pos = _save135
break
end # end choice
unless _tmp
self.pos = _save132
end
break
end # end sequence
break if _tmp
self.pos = _save124
break
end # end choice
if _tmp
while true
_save138 = self.pos
while true # choice
_save139 = self.pos
_save140 = self.pos
while true # sequence
_save141 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save141
unless _tmp
self.pos = _save140
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save140
end
break
end # end sequence
if _tmp
while true
_save142 = self.pos
while true # sequence
_save143 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save143
unless _tmp
self.pos = _save142
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save142
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save139
end
break if _tmp
self.pos = _save138
_save144 = self.pos
while true # sequence
_save145 = self.pos
_tmp = apply(:_Ticks5)
_tmp = _tmp ? nil : true
self.pos = _save145
unless _tmp
self.pos = _save144
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save144
end
break
end # end sequence
break if _tmp
self.pos = _save138
_save146 = self.pos
while true # sequence
_save147 = self.pos
_save148 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save148
break
end
_tmp = apply(:_Ticks5)
unless _tmp
self.pos = _save148
end
break
end # end sequence
_tmp = _tmp ? nil : true
self.pos = _save147
unless _tmp
self.pos = _save146
break
end
_save149 = self.pos
while true # choice
_tmp = _Spacechar()
break if _tmp
self.pos = _save149
_save150 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save150
break
end
_save151 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save151
unless _tmp
self.pos = _save150
end
break
end # end sequence
break if _tmp
self.pos = _save149
break
end # end choice
unless _tmp
self.pos = _save146
end
break
end # end sequence
break if _tmp
self.pos = _save138
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save123
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save122
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save122
break
end
_tmp = apply(:_Ticks5)
unless _tmp
self.pos = _save122
end
break
end # end sequence
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
@result = begin; "<code>#{text}</code>" ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Code unless _tmp
return _tmp
end
# RawHtml = < (HtmlComment | HtmlBlockScript | HtmlTag) > { if html? then text else '' end }
def _RawHtml
_save = self.pos
while true # sequence
_text_start = self.pos
_save1 = self.pos
while true # choice
_tmp = apply(:_HtmlComment)
break if _tmp
self.pos = _save1
_tmp = apply(:_HtmlBlockScript)
break if _tmp
self.pos = _save1
_tmp = apply(:_HtmlTag)
break if _tmp
self.pos = _save1
break
end # end choice
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; if html? then text else '' end ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RawHtml unless _tmp
return _tmp
end
# BlankLine = @Sp @Newline { "\n" }
def _BlankLine
_save = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
@result = begin; "\n" ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_BlankLine unless _tmp
return _tmp
end
# Quoted = ("\"" (!"\"" .)* "\"" | "'" (!"'" .)* "'")
def _Quoted
_save = self.pos
while true # choice
_save1 = self.pos
while true # sequence
_tmp = match_string("\"")
unless _tmp
self.pos = _save1
break
end
while true
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = match_string("\"")
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = get_byte
unless _tmp
self.pos = _save3
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save1
break
end
_tmp = match_string("\"")
unless _tmp
self.pos = _save1
end
break
end # end sequence
break if _tmp
self.pos = _save
_save5 = self.pos
while true # sequence
_tmp = match_string("'")
unless _tmp
self.pos = _save5
break
end
while true
_save7 = self.pos
while true # sequence
_save8 = self.pos
_tmp = match_string("'")
_tmp = _tmp ? nil : true
self.pos = _save8
unless _tmp
self.pos = _save7
break
end
_tmp = get_byte
unless _tmp
self.pos = _save7
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save5
break
end
_tmp = match_string("'")
unless _tmp
self.pos = _save5
end
break
end # end sequence
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_Quoted unless _tmp
return _tmp
end
# HtmlAttribute = (AlphanumericAscii | "-")+ Spnl ("=" Spnl (Quoted | (!">" Nonspacechar)+))? Spnl
def _HtmlAttribute
_save = self.pos
while true # sequence
_save1 = self.pos
_save2 = self.pos
while true # choice
_tmp = apply(:_AlphanumericAscii)
break if _tmp
self.pos = _save2
_tmp = match_string("-")
break if _tmp
self.pos = _save2
break
end # end choice
if _tmp
while true
_save3 = self.pos
while true # choice
_tmp = apply(:_AlphanumericAscii)
break if _tmp
self.pos = _save3
_tmp = match_string("-")
break if _tmp
self.pos = _save3
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save4 = self.pos
_save5 = self.pos
while true # sequence
_tmp = match_string("=")
unless _tmp
self.pos = _save5
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save5
break
end
_save6 = self.pos
while true # choice
_tmp = apply(:_Quoted)
break if _tmp
self.pos = _save6
_save7 = self.pos
_save8 = self.pos
while true # sequence
_save9 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save9
unless _tmp
self.pos = _save8
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save8
end
break
end # end sequence
if _tmp
while true
_save10 = self.pos
while true # sequence
_save11 = self.pos
_tmp = match_string(">")
_tmp = _tmp ? nil : true
self.pos = _save11
unless _tmp
self.pos = _save10
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save10
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save7
end
break if _tmp
self.pos = _save6
break
end # end choice
unless _tmp
self.pos = _save5
end
break
end # end sequence
unless _tmp
_tmp = true
self.pos = _save4
end
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlAttribute unless _tmp
return _tmp
end
# HtmlComment = "<!--" (!"-->" .)* "-->"
def _HtmlComment
_save = self.pos
while true # sequence
_tmp = match_string("<!--")
unless _tmp
self.pos = _save
break
end
while true
_save2 = self.pos
while true # sequence
_save3 = self.pos
_tmp = match_string("-->")
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_tmp = match_string("-->")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlComment unless _tmp
return _tmp
end
# HtmlTag = "<" Spnl "/"? AlphanumericAscii+ Spnl HtmlAttribute* "/"? Spnl ">"
def _HtmlTag
_save = self.pos
while true # sequence
_tmp = match_string("<")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = match_string("/")
unless _tmp
_tmp = true
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = apply(:_AlphanumericAscii)
if _tmp
while true
_tmp = apply(:_AlphanumericAscii)
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
while true
_tmp = apply(:_HtmlAttribute)
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
_save4 = self.pos
_tmp = match_string("/")
unless _tmp
_tmp = true
self.pos = _save4
end
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_tmp = match_string(">")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HtmlTag unless _tmp
return _tmp
end
# Eof = !.
def _Eof
_save = self.pos
_tmp = get_byte
_tmp = _tmp ? nil : true
self.pos = _save
set_failed_rule :_Eof unless _tmp
return _tmp
end
# Nonspacechar = !@Spacechar !@Newline .
def _Nonspacechar
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = _Spacechar()
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save2
unless _tmp
self.pos = _save
break
end
_tmp = get_byte
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Nonspacechar unless _tmp
return _tmp
end
# Sp = @Spacechar*
def _Sp
while true
_tmp = _Spacechar()
break unless _tmp
end
_tmp = true
set_failed_rule :_Sp unless _tmp
return _tmp
end
# Spnl = @Sp (@Newline @Sp)?
def _Spnl
_save = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_save2 = self.pos
while true # sequence
_tmp = _Newline()
unless _tmp
self.pos = _save2
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save2
end
break
end # end sequence
unless _tmp
_tmp = true
self.pos = _save1
end
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Spnl unless _tmp
return _tmp
end
# SpecialChar = (/[~*_`&\[\]()<!#\\'"]/ | @ExtendedSpecialChar)
def _SpecialChar
_save = self.pos
while true # choice
_tmp = scan(/\G(?-mix:[~*_`&\[\]()<!#\\'"])/)
break if _tmp
self.pos = _save
_tmp = _ExtendedSpecialChar()
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_SpecialChar unless _tmp
return _tmp
end
# NormalChar = !(@SpecialChar | @Spacechar | @Newline) .
def _NormalChar
_save = self.pos
while true # sequence
_save1 = self.pos
_save2 = self.pos
while true # choice
_tmp = _SpecialChar()
break if _tmp
self.pos = _save2
_tmp = _Spacechar()
break if _tmp
self.pos = _save2
_tmp = _Newline()
break if _tmp
self.pos = _save2
break
end # end choice
_tmp = _tmp ? nil : true
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = get_byte
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_NormalChar unless _tmp
return _tmp
end
# Digit = [0-9]
def _Digit
_save = self.pos
_tmp = get_byte
if _tmp
unless _tmp >= 48 and _tmp <= 57
self.pos = _save
_tmp = nil
end
end
set_failed_rule :_Digit unless _tmp
return _tmp
end
# Alphanumeric = %literals.Alphanumeric
def _Alphanumeric
_tmp = @_grammar_literals.external_invoke(self, :_Alphanumeric)
set_failed_rule :_Alphanumeric unless _tmp
return _tmp
end
# AlphanumericAscii = %literals.AlphanumericAscii
def _AlphanumericAscii
_tmp = @_grammar_literals.external_invoke(self, :_AlphanumericAscii)
set_failed_rule :_AlphanumericAscii unless _tmp
return _tmp
end
# BOM = %literals.BOM
def _BOM
_tmp = @_grammar_literals.external_invoke(self, :_BOM)
set_failed_rule :_BOM unless _tmp
return _tmp
end
# Newline = %literals.Newline
def _Newline
_tmp = @_grammar_literals.external_invoke(self, :_Newline)
set_failed_rule :_Newline unless _tmp
return _tmp
end
# Spacechar = %literals.Spacechar
def _Spacechar
_tmp = @_grammar_literals.external_invoke(self, :_Spacechar)
set_failed_rule :_Spacechar unless _tmp
return _tmp
end
# HexEntity = /&#x/i < /[0-9a-fA-F]+/ > ";" { [text.to_i(16)].pack 'U' }
def _HexEntity
_save = self.pos
while true # sequence
_tmp = scan(/\G(?i-mx:&#x)/)
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_tmp = scan(/\G(?-mix:[0-9a-fA-F]+)/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string(";")
unless _tmp
self.pos = _save
break
end
@result = begin; [text.to_i(16)].pack 'U' ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_HexEntity unless _tmp
return _tmp
end
# DecEntity = "&#" < /[0-9]+/ > ";" { [text.to_i].pack 'U' }
def _DecEntity
_save = self.pos
while true # sequence
_tmp = match_string("&#")
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_tmp = scan(/\G(?-mix:[0-9]+)/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string(";")
unless _tmp
self.pos = _save
break
end
@result = begin; [text.to_i].pack 'U' ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_DecEntity unless _tmp
return _tmp
end
# CharEntity = "&" < /[A-Za-z0-9]+/ > ";" { if entity = HTML_ENTITIES[text] then entity.pack 'U*' else "&#{text};" end }
def _CharEntity
_save = self.pos
while true # sequence
_tmp = match_string("&")
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_tmp = scan(/\G(?-mix:[A-Za-z0-9]+)/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string(";")
unless _tmp
self.pos = _save
break
end
@result = begin; if entity = HTML_ENTITIES[text] then
entity.pack 'U*'
else
"&#{text};"
end
; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_CharEntity unless _tmp
return _tmp
end
# NonindentSpace = / {0,3}/
def _NonindentSpace
_tmp = scan(/\G(?-mix: {0,3})/)
set_failed_rule :_NonindentSpace unless _tmp
return _tmp
end
# Indent = /\t| /
def _Indent
_tmp = scan(/\G(?-mix:\t| )/)
set_failed_rule :_Indent unless _tmp
return _tmp
end
# IndentedLine = Indent Line
def _IndentedLine
_save = self.pos
while true # sequence
_tmp = apply(:_Indent)
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Line)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_IndentedLine unless _tmp
return _tmp
end
# OptionallyIndentedLine = Indent? Line
def _OptionallyIndentedLine
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = apply(:_Indent)
unless _tmp
_tmp = true
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Line)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_OptionallyIndentedLine unless _tmp
return _tmp
end
# StartList = &. { [] }
def _StartList
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = get_byte
self.pos = _save1
unless _tmp
self.pos = _save
break
end
@result = begin; [] ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_StartList unless _tmp
return _tmp
end
# Line = @RawLine:a { a }
def _Line
_save = self.pos
while true # sequence
_tmp = _RawLine()
a = @result
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Line unless _tmp
return _tmp
end
# RawLine = (< /[^\r\n]*/ @Newline > | < .+ > @Eof) { text }
def _RawLine
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_text_start = self.pos
_save2 = self.pos
while true # sequence
_tmp = scan(/\G(?-mix:[^\r\n]*)/)
unless _tmp
self.pos = _save2
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save2
end
break
end # end sequence
if _tmp
text = get_text(_text_start)
end
break if _tmp
self.pos = _save1
_save3 = self.pos
while true # sequence
_text_start = self.pos
_save4 = self.pos
_tmp = get_byte
if _tmp
while true
_tmp = get_byte
break unless _tmp
end
_tmp = true
else
self.pos = _save4
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save3
break
end
_tmp = _Eof()
unless _tmp
self.pos = _save3
end
break
end # end sequence
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RawLine unless _tmp
return _tmp
end
# SkipBlock = (HtmlBlock | (!"#" !SetextBottom1 !SetextBottom2 !@BlankLine @RawLine)+ @BlankLine* | @BlankLine+ | @RawLine)
def _SkipBlock
_save = self.pos
while true # choice
_tmp = apply(:_HtmlBlock)
break if _tmp
self.pos = _save
_save1 = self.pos
while true # sequence
_save2 = self.pos
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = match_string("#")
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_save5 = self.pos
_tmp = apply(:_SetextBottom1)
_tmp = _tmp ? nil : true
self.pos = _save5
unless _tmp
self.pos = _save3
break
end
_save6 = self.pos
_tmp = apply(:_SetextBottom2)
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save3
break
end
_save7 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save3
break
end
_tmp = _RawLine()
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
while true
_save8 = self.pos
while true # sequence
_save9 = self.pos
_tmp = match_string("#")
_tmp = _tmp ? nil : true
self.pos = _save9
unless _tmp
self.pos = _save8
break
end
_save10 = self.pos
_tmp = apply(:_SetextBottom1)
_tmp = _tmp ? nil : true
self.pos = _save10
unless _tmp
self.pos = _save8
break
end
_save11 = self.pos
_tmp = apply(:_SetextBottom2)
_tmp = _tmp ? nil : true
self.pos = _save11
unless _tmp
self.pos = _save8
break
end
_save12 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save12
unless _tmp
self.pos = _save8
break
end
_tmp = _RawLine()
unless _tmp
self.pos = _save8
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save1
break
end
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save1
end
break
end # end sequence
break if _tmp
self.pos = _save
_save14 = self.pos
_tmp = _BlankLine()
if _tmp
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
else
self.pos = _save14
end
break if _tmp
self.pos = _save
_tmp = _RawLine()
break if _tmp
self.pos = _save
break
end # end choice
set_failed_rule :_SkipBlock unless _tmp
return _tmp
end
# ExtendedSpecialChar = &{ notes? } "^"
def _ExtendedSpecialChar
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; notes? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = match_string("^")
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_ExtendedSpecialChar unless _tmp
return _tmp
end
# NoteReference = &{ notes? } RawNoteReference:ref { note_for ref }
def _NoteReference
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; notes? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_RawNoteReference)
ref = @result
unless _tmp
self.pos = _save
break
end
@result = begin; note_for ref ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_NoteReference unless _tmp
return _tmp
end
# RawNoteReference = "[^" < (!@Newline !"]" .)+ > "]" { text }
def _RawNoteReference
_save = self.pos
while true # sequence
_tmp = match_string("[^")
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_save1 = self.pos
_save2 = self.pos
while true # sequence
_save3 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_save4 = self.pos
_tmp = match_string("]")
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save2
break
end
_tmp = get_byte
unless _tmp
self.pos = _save2
end
break
end # end sequence
if _tmp
while true
_save5 = self.pos
while true # sequence
_save6 = self.pos
_tmp = _Newline()
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_save7 = self.pos
_tmp = match_string("]")
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save5
break
end
_tmp = get_byte
unless _tmp
self.pos = _save5
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("]")
unless _tmp
self.pos = _save
break
end
@result = begin; text ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RawNoteReference unless _tmp
return _tmp
end
# Note = &{ notes? } @NonindentSpace RawNoteReference:ref ":" @Sp @StartList:a RawNoteBlock:i { a.concat i } (&Indent RawNoteBlock:i { a.concat i })* { @footnotes[ref] = paragraph a nil }
def _Note
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; notes? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = _NonindentSpace()
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_RawNoteReference)
ref = @result
unless _tmp
self.pos = _save
break
end
_tmp = match_string(":")
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_RawNoteBlock)
i = @result
unless _tmp
self.pos = _save
break
end
@result = begin; a.concat i ; end
_tmp = true
unless _tmp
self.pos = _save
break
end
while true
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = apply(:_Indent)
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_RawNoteBlock)
i = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a.concat i ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
@result = begin; @footnotes[ref] = paragraph a
nil
; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Note unless _tmp
return _tmp
end
# InlineNote = &{ notes? } "^[" @StartList:a (!"]" Inline:l { a << l })+ "]" { ref = [:inline, @note_order.length] @footnotes[ref] = paragraph a note_for ref }
def _InlineNote
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; notes? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = match_string("^[")
unless _tmp
self.pos = _save
break
end
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_save4 = self.pos
_tmp = match_string("]")
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_Inline)
l = @result
unless _tmp
self.pos = _save3
break
end
@result = begin; a << l ; end
_tmp = true
unless _tmp
self.pos = _save3
end
break
end # end sequence
if _tmp
while true
_save5 = self.pos
while true # sequence
_save6 = self.pos
_tmp = match_string("]")
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_tmp = apply(:_Inline)
l = @result
unless _tmp
self.pos = _save5
break
end
@result = begin; a << l ; end
_tmp = true
unless _tmp
self.pos = _save5
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = match_string("]")
unless _tmp
self.pos = _save
break
end
@result = begin; ref = [:inline, @note_order.length]
@footnotes[ref] = paragraph a
note_for ref
; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_InlineNote unless _tmp
return _tmp
end
# Notes = (Note | SkipBlock)*
def _Notes
while true
_save1 = self.pos
while true # choice
_tmp = apply(:_Note)
break if _tmp
self.pos = _save1
_tmp = apply(:_SkipBlock)
break if _tmp
self.pos = _save1
break
end # end choice
break unless _tmp
end
_tmp = true
set_failed_rule :_Notes unless _tmp
return _tmp
end
# RawNoteBlock = @StartList:a (!@BlankLine !RawNoteReference OptionallyIndentedLine:l { a << l })+ < @BlankLine* > { a << text } { a }
def _RawNoteBlock
_save = self.pos
while true # sequence
_tmp = _StartList()
a = @result
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_save2 = self.pos
while true # sequence
_save3 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save3
unless _tmp
self.pos = _save2
break
end
_save4 = self.pos
_tmp = apply(:_RawNoteReference)
_tmp = _tmp ? nil : true
self.pos = _save4
unless _tmp
self.pos = _save2
break
end
_tmp = apply(:_OptionallyIndentedLine)
l = @result
unless _tmp
self.pos = _save2
break
end
@result = begin; a << l ; end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
if _tmp
while true
_save5 = self.pos
while true # sequence
_save6 = self.pos
_tmp = _BlankLine()
_tmp = _tmp ? nil : true
self.pos = _save6
unless _tmp
self.pos = _save5
break
end
_save7 = self.pos
_tmp = apply(:_RawNoteReference)
_tmp = _tmp ? nil : true
self.pos = _save7
unless _tmp
self.pos = _save5
break
end
_tmp = apply(:_OptionallyIndentedLine)
l = @result
unless _tmp
self.pos = _save5
break
end
@result = begin; a << l ; end
_tmp = true
unless _tmp
self.pos = _save5
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; a << text ; end
_tmp = true
unless _tmp
self.pos = _save
break
end
@result = begin; a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_RawNoteBlock unless _tmp
return _tmp
end
# CodeFence = &{ github? } Ticks3 (@Sp StrChunk:format)? Spnl < ((!"`" Nonspacechar)+ | !Ticks3 /`+/ | Spacechar | @Newline)+ > Ticks3 @Sp @Newline* { verbatim = RDoc::Markup::Verbatim.new text verbatim.format = format.intern if format.instance_of?(String) verbatim }
def _CodeFence
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; github? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_save3 = self.pos
while true # sequence
_tmp = _Sp()
unless _tmp
self.pos = _save3
break
end
_tmp = apply(:_StrChunk)
format = @result
unless _tmp
self.pos = _save3
end
break
end # end sequence
unless _tmp
_tmp = true
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Spnl)
unless _tmp
self.pos = _save
break
end
_text_start = self.pos
_save4 = self.pos
_save5 = self.pos
while true # choice
_save6 = self.pos
_save7 = self.pos
while true # sequence
_save8 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save8
unless _tmp
self.pos = _save7
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save7
end
break
end # end sequence
if _tmp
while true
_save9 = self.pos
while true # sequence
_save10 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save10
unless _tmp
self.pos = _save9
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save9
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save6
end
break if _tmp
self.pos = _save5
_save11 = self.pos
while true # sequence
_save12 = self.pos
_tmp = apply(:_Ticks3)
_tmp = _tmp ? nil : true
self.pos = _save12
unless _tmp
self.pos = _save11
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save11
end
break
end # end sequence
break if _tmp
self.pos = _save5
_tmp = apply(:_Spacechar)
break if _tmp
self.pos = _save5
_tmp = _Newline()
break if _tmp
self.pos = _save5
break
end # end choice
if _tmp
while true
_save13 = self.pos
while true # choice
_save14 = self.pos
_save15 = self.pos
while true # sequence
_save16 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save16
unless _tmp
self.pos = _save15
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save15
end
break
end # end sequence
if _tmp
while true
_save17 = self.pos
while true # sequence
_save18 = self.pos
_tmp = match_string("`")
_tmp = _tmp ? nil : true
self.pos = _save18
unless _tmp
self.pos = _save17
break
end
_tmp = apply(:_Nonspacechar)
unless _tmp
self.pos = _save17
end
break
end # end sequence
break unless _tmp
end
_tmp = true
else
self.pos = _save14
end
break if _tmp
self.pos = _save13
_save19 = self.pos
while true # sequence
_save20 = self.pos
_tmp = apply(:_Ticks3)
_tmp = _tmp ? nil : true
self.pos = _save20
unless _tmp
self.pos = _save19
break
end
_tmp = scan(/\G(?-mix:`+)/)
unless _tmp
self.pos = _save19
end
break
end # end sequence
break if _tmp
self.pos = _save13
_tmp = apply(:_Spacechar)
break if _tmp
self.pos = _save13
_tmp = _Newline()
break if _tmp
self.pos = _save13
break
end # end choice
break unless _tmp
end
_tmp = true
else
self.pos = _save4
end
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Ticks3)
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
while true
_tmp = _Newline()
break unless _tmp
end
_tmp = true
unless _tmp
self.pos = _save
break
end
@result = begin; verbatim = RDoc::Markup::Verbatim.new text
verbatim.format = format.intern if format.instance_of?(String)
verbatim
; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_CodeFence unless _tmp
return _tmp
end
# Table = &{ github? } TableHead:header TableLine:line TableRow+:body { table = RDoc::Markup::Table.new(header, line, body) }
def _Table
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; github? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_TableHead)
header = @result
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_TableLine)
line = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_ary = []
_tmp = apply(:_TableRow)
if _tmp
_ary << @result
while true
_tmp = apply(:_TableRow)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save2
end
body = @result
unless _tmp
self.pos = _save
break
end
@result = begin; table = RDoc::Markup::Table.new(header, line, body) ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_Table unless _tmp
return _tmp
end
# TableHead = TableItem2+:items "|"? @Newline { items }
def _TableHead
_save = self.pos
while true # sequence
_save1 = self.pos
_ary = []
_tmp = apply(:_TableItem2)
if _tmp
_ary << @result
while true
_tmp = apply(:_TableItem2)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save1
end
items = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_tmp = match_string("|")
unless _tmp
_tmp = true
self.pos = _save2
end
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
@result = begin; items ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TableHead unless _tmp
return _tmp
end
# TableRow = ((TableItem:item1 TableItem2*:items { [item1, *items] }):row | TableItem2+:row) "|"? @Newline { row }
def _TableRow
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_save2 = self.pos
while true # sequence
_tmp = apply(:_TableItem)
item1 = @result
unless _tmp
self.pos = _save2
break
end
_ary = []
while true
_tmp = apply(:_TableItem2)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
items = @result
unless _tmp
self.pos = _save2
break
end
@result = begin; [item1, *items] ; end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
row = @result
break if _tmp
self.pos = _save1
_save4 = self.pos
_ary = []
_tmp = apply(:_TableItem2)
if _tmp
_ary << @result
while true
_tmp = apply(:_TableItem2)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save4
end
row = @result
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_save5 = self.pos
_tmp = match_string("|")
unless _tmp
_tmp = true
self.pos = _save5
end
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
@result = begin; row ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TableRow unless _tmp
return _tmp
end
# TableItem2 = "|" TableItem
def _TableItem2
_save = self.pos
while true # sequence
_tmp = match_string("|")
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_TableItem)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TableItem2 unless _tmp
return _tmp
end
# TableItem = < /(?:\\.|[^|\n])+/ > { text.strip.gsub(/\\(.)/, '\1') }
def _TableItem
_save = self.pos
while true # sequence
_text_start = self.pos
_tmp = scan(/\G(?-mix:(?:\\.|[^|\n])+)/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
@result = begin; text.strip.gsub(/\\(.)/, '\1') ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TableItem unless _tmp
return _tmp
end
# TableLine = ((TableAlign:align1 TableAlign2*:aligns {[align1, *aligns] }):line | TableAlign2+:line) "|"? @Newline { line }
def _TableLine
_save = self.pos
while true # sequence
_save1 = self.pos
while true # choice
_save2 = self.pos
while true # sequence
_tmp = apply(:_TableAlign)
align1 = @result
unless _tmp
self.pos = _save2
break
end
_ary = []
while true
_tmp = apply(:_TableAlign2)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
aligns = @result
unless _tmp
self.pos = _save2
break
end
@result = begin; [align1, *aligns] ; end
_tmp = true
unless _tmp
self.pos = _save2
end
break
end # end sequence
line = @result
break if _tmp
self.pos = _save1
_save4 = self.pos
_ary = []
_tmp = apply(:_TableAlign2)
if _tmp
_ary << @result
while true
_tmp = apply(:_TableAlign2)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save4
end
line = @result
break if _tmp
self.pos = _save1
break
end # end choice
unless _tmp
self.pos = _save
break
end
_save5 = self.pos
_tmp = match_string("|")
unless _tmp
_tmp = true
self.pos = _save5
end
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
@result = begin; line ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TableLine unless _tmp
return _tmp
end
# TableAlign2 = "|" @Sp TableAlign
def _TableAlign2
_save = self.pos
while true # sequence
_tmp = match_string("|")
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_TableAlign)
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TableAlign2 unless _tmp
return _tmp
end
# TableAlign = < /:?-+:?/ > @Sp { text.start_with?(":") ? (text.end_with?(":") ? :center : :left) : (text.end_with?(":") ? :right : nil) }
def _TableAlign
_save = self.pos
while true # sequence
_text_start = self.pos
_tmp = scan(/\G(?-mix::?-+:?)/)
if _tmp
text = get_text(_text_start)
end
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
@result = begin;
text.start_with?(":") ?
(text.end_with?(":") ? :center : :left) :
(text.end_with?(":") ? :right : nil)
; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_TableAlign unless _tmp
return _tmp
end
# DefinitionList = &{ definition_lists? } DefinitionListItem+:list { RDoc::Markup::List.new :NOTE, *list.flatten }
def _DefinitionList
_save = self.pos
while true # sequence
_save1 = self.pos
_tmp = begin; definition_lists? ; end
self.pos = _save1
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_ary = []
_tmp = apply(:_DefinitionListItem)
if _tmp
_ary << @result
while true
_tmp = apply(:_DefinitionListItem)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save2
end
list = @result
unless _tmp
self.pos = _save
break
end
@result = begin; RDoc::Markup::List.new :NOTE, *list.flatten ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_DefinitionList unless _tmp
return _tmp
end
# DefinitionListItem = DefinitionListLabel+:label DefinitionListDefinition+:defns { list_items = [] list_items << RDoc::Markup::ListItem.new(label, defns.shift) list_items.concat defns.map { |defn| RDoc::Markup::ListItem.new nil, defn } unless list_items.empty? list_items }
def _DefinitionListItem
_save = self.pos
while true # sequence
_save1 = self.pos
_ary = []
_tmp = apply(:_DefinitionListLabel)
if _tmp
_ary << @result
while true
_tmp = apply(:_DefinitionListLabel)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save1
end
label = @result
unless _tmp
self.pos = _save
break
end
_save2 = self.pos
_ary = []
_tmp = apply(:_DefinitionListDefinition)
if _tmp
_ary << @result
while true
_tmp = apply(:_DefinitionListDefinition)
_ary << @result if _tmp
break unless _tmp
end
_tmp = true
@result = _ary
else
self.pos = _save2
end
defns = @result
unless _tmp
self.pos = _save
break
end
@result = begin; list_items = []
list_items <<
RDoc::Markup::ListItem.new(label, defns.shift)
list_items.concat defns.map { |defn|
RDoc::Markup::ListItem.new nil, defn
} unless list_items.empty?
list_items
; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_DefinitionListItem unless _tmp
return _tmp
end
# DefinitionListLabel = StrChunk:label @Sp @Newline { label }
def _DefinitionListLabel
_save = self.pos
while true # sequence
_tmp = apply(:_StrChunk)
label = @result
unless _tmp
self.pos = _save
break
end
_tmp = _Sp()
unless _tmp
self.pos = _save
break
end
_tmp = _Newline()
unless _tmp
self.pos = _save
break
end
@result = begin; label ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_DefinitionListLabel unless _tmp
return _tmp
end
# DefinitionListDefinition = @NonindentSpace ":" @Space Inlines:a @BlankLine+ { paragraph a }
def _DefinitionListDefinition
_save = self.pos
while true # sequence
_tmp = _NonindentSpace()
unless _tmp
self.pos = _save
break
end
_tmp = match_string(":")
unless _tmp
self.pos = _save
break
end
_tmp = _Space()
unless _tmp
self.pos = _save
break
end
_tmp = apply(:_Inlines)
a = @result
unless _tmp
self.pos = _save
break
end
_save1 = self.pos
_tmp = _BlankLine()
if _tmp
while true
_tmp = _BlankLine()
break unless _tmp
end
_tmp = true
else
self.pos = _save1
end
unless _tmp
self.pos = _save
break
end
@result = begin; paragraph a ; end
_tmp = true
unless _tmp
self.pos = _save
end
break
end # end sequence
set_failed_rule :_DefinitionListDefinition unless _tmp
return _tmp
end
Rules = {}
Rules[:_root] = rule_info("root", "Doc")
Rules[:_Doc] = rule_info("Doc", "BOM? Block*:a { RDoc::Markup::Document.new(*a.compact) }")
Rules[:_Block] = rule_info("Block", "@BlankLine* (BlockQuote | Verbatim | CodeFence | Table | Note | Reference | HorizontalRule | Heading | OrderedList | BulletList | DefinitionList | HtmlBlock | StyleBlock | Para | Plain)")
Rules[:_Para] = rule_info("Para", "@NonindentSpace Inlines:a @BlankLine+ { paragraph a }")
Rules[:_Plain] = rule_info("Plain", "Inlines:a { paragraph a }")
Rules[:_AtxInline] = rule_info("AtxInline", "!@Newline !(@Sp /\#*/ @Sp @Newline) Inline")
Rules[:_AtxStart] = rule_info("AtxStart", "< /\\\#{1,6}/ > { text.length }")
Rules[:_AtxHeading] = rule_info("AtxHeading", "AtxStart:s @Sp AtxInline+:a (@Sp /\#*/ @Sp)? @Newline { RDoc::Markup::Heading.new(s, a.join) }")
Rules[:_SetextHeading] = rule_info("SetextHeading", "(SetextHeading1 | SetextHeading2)")
Rules[:_SetextBottom1] = rule_info("SetextBottom1", "/={1,}/ @Newline")
Rules[:_SetextBottom2] = rule_info("SetextBottom2", "/-{1,}/ @Newline")
Rules[:_SetextHeading1] = rule_info("SetextHeading1", "&(@RawLine SetextBottom1) @StartList:a (!@Endline Inline:b { a << b })+ @Sp @Newline SetextBottom1 { RDoc::Markup::Heading.new(1, a.join) }")
Rules[:_SetextHeading2] = rule_info("SetextHeading2", "&(@RawLine SetextBottom2) @StartList:a (!@Endline Inline:b { a << b })+ @Sp @Newline SetextBottom2 { RDoc::Markup::Heading.new(2, a.join) }")
Rules[:_Heading] = rule_info("Heading", "(SetextHeading | AtxHeading)")
Rules[:_BlockQuote] = rule_info("BlockQuote", "BlockQuoteRaw:a { RDoc::Markup::BlockQuote.new(*a) }")
Rules[:_BlockQuoteRaw] = rule_info("BlockQuoteRaw", "@StartList:a (\">\" \" \"? Line:l { a << l } (!\">\" !@BlankLine Line:c { a << c })* (@BlankLine:n { a << n })*)+ { inner_parse a.join }")
Rules[:_NonblankIndentedLine] = rule_info("NonblankIndentedLine", "!@BlankLine IndentedLine")
Rules[:_VerbatimChunk] = rule_info("VerbatimChunk", "@BlankLine*:a NonblankIndentedLine+:b { a.concat b }")
Rules[:_Verbatim] = rule_info("Verbatim", "VerbatimChunk+:a { RDoc::Markup::Verbatim.new(*a.flatten) }")
Rules[:_HorizontalRule] = rule_info("HorizontalRule", "@NonindentSpace (\"*\" @Sp \"*\" @Sp \"*\" (@Sp \"*\")* | \"-\" @Sp \"-\" @Sp \"-\" (@Sp \"-\")* | \"_\" @Sp \"_\" @Sp \"_\" (@Sp \"_\")*) @Sp @Newline @BlankLine+ { RDoc::Markup::Rule.new 1 }")
Rules[:_Bullet] = rule_info("Bullet", "!HorizontalRule @NonindentSpace /[+*-]/ @Spacechar+")
Rules[:_BulletList] = rule_info("BulletList", "&Bullet (ListTight | ListLoose):a { RDoc::Markup::List.new(:BULLET, *a) }")
Rules[:_ListTight] = rule_info("ListTight", "ListItemTight+:a @BlankLine* !(Bullet | Enumerator) { a }")
Rules[:_ListLoose] = rule_info("ListLoose", "@StartList:a (ListItem:b @BlankLine* { a << b })+ { a }")
Rules[:_ListItem] = rule_info("ListItem", "(Bullet | Enumerator) @StartList:a ListBlock:b { a << b } (ListContinuationBlock:c { a.push(*c) })* { list_item_from a }")
Rules[:_ListItemTight] = rule_info("ListItemTight", "(Bullet | Enumerator) ListBlock:a (!@BlankLine ListContinuationBlock:b { a.push(*b) })* !ListContinuationBlock { list_item_from a }")
Rules[:_ListBlock] = rule_info("ListBlock", "!@BlankLine Line:a ListBlockLine*:c { [a, *c] }")
Rules[:_ListContinuationBlock] = rule_info("ListContinuationBlock", "@StartList:a @BlankLine* { a << \"\\n\" } (Indent ListBlock:b { a.concat b })+ { a }")
Rules[:_Enumerator] = rule_info("Enumerator", "@NonindentSpace [0-9]+ \".\" @Spacechar+")
Rules[:_OrderedList] = rule_info("OrderedList", "&Enumerator (ListTight | ListLoose):a { RDoc::Markup::List.new(:NUMBER, *a) }")
Rules[:_ListBlockLine] = rule_info("ListBlockLine", "!@BlankLine !(Indent? (Bullet | Enumerator)) !HorizontalRule OptionallyIndentedLine")
Rules[:_HtmlOpenAnchor] = rule_info("HtmlOpenAnchor", "\"<\" Spnl (\"a\" | \"A\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlCloseAnchor] = rule_info("HtmlCloseAnchor", "\"<\" Spnl \"/\" (\"a\" | \"A\") Spnl \">\"")
Rules[:_HtmlAnchor] = rule_info("HtmlAnchor", "HtmlOpenAnchor (HtmlAnchor | !HtmlCloseAnchor .)* HtmlCloseAnchor")
Rules[:_HtmlBlockOpenAddress] = rule_info("HtmlBlockOpenAddress", "\"<\" Spnl (\"address\" | \"ADDRESS\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseAddress] = rule_info("HtmlBlockCloseAddress", "\"<\" Spnl \"/\" (\"address\" | \"ADDRESS\") Spnl \">\"")
Rules[:_HtmlBlockAddress] = rule_info("HtmlBlockAddress", "HtmlBlockOpenAddress (HtmlBlockAddress | !HtmlBlockCloseAddress .)* HtmlBlockCloseAddress")
Rules[:_HtmlBlockOpenBlockquote] = rule_info("HtmlBlockOpenBlockquote", "\"<\" Spnl (\"blockquote\" | \"BLOCKQUOTE\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseBlockquote] = rule_info("HtmlBlockCloseBlockquote", "\"<\" Spnl \"/\" (\"blockquote\" | \"BLOCKQUOTE\") Spnl \">\"")
Rules[:_HtmlBlockBlockquote] = rule_info("HtmlBlockBlockquote", "HtmlBlockOpenBlockquote (HtmlBlockBlockquote | !HtmlBlockCloseBlockquote .)* HtmlBlockCloseBlockquote")
Rules[:_HtmlBlockOpenCenter] = rule_info("HtmlBlockOpenCenter", "\"<\" Spnl (\"center\" | \"CENTER\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseCenter] = rule_info("HtmlBlockCloseCenter", "\"<\" Spnl \"/\" (\"center\" | \"CENTER\") Spnl \">\"")
Rules[:_HtmlBlockCenter] = rule_info("HtmlBlockCenter", "HtmlBlockOpenCenter (HtmlBlockCenter | !HtmlBlockCloseCenter .)* HtmlBlockCloseCenter")
Rules[:_HtmlBlockOpenDir] = rule_info("HtmlBlockOpenDir", "\"<\" Spnl (\"dir\" | \"DIR\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseDir] = rule_info("HtmlBlockCloseDir", "\"<\" Spnl \"/\" (\"dir\" | \"DIR\") Spnl \">\"")
Rules[:_HtmlBlockDir] = rule_info("HtmlBlockDir", "HtmlBlockOpenDir (HtmlBlockDir | !HtmlBlockCloseDir .)* HtmlBlockCloseDir")
Rules[:_HtmlBlockOpenDiv] = rule_info("HtmlBlockOpenDiv", "\"<\" Spnl (\"div\" | \"DIV\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseDiv] = rule_info("HtmlBlockCloseDiv", "\"<\" Spnl \"/\" (\"div\" | \"DIV\") Spnl \">\"")
Rules[:_HtmlBlockDiv] = rule_info("HtmlBlockDiv", "HtmlBlockOpenDiv (HtmlBlockDiv | !HtmlBlockCloseDiv .)* HtmlBlockCloseDiv")
Rules[:_HtmlBlockOpenDl] = rule_info("HtmlBlockOpenDl", "\"<\" Spnl (\"dl\" | \"DL\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseDl] = rule_info("HtmlBlockCloseDl", "\"<\" Spnl \"/\" (\"dl\" | \"DL\") Spnl \">\"")
Rules[:_HtmlBlockDl] = rule_info("HtmlBlockDl", "HtmlBlockOpenDl (HtmlBlockDl | !HtmlBlockCloseDl .)* HtmlBlockCloseDl")
Rules[:_HtmlBlockOpenFieldset] = rule_info("HtmlBlockOpenFieldset", "\"<\" Spnl (\"fieldset\" | \"FIELDSET\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseFieldset] = rule_info("HtmlBlockCloseFieldset", "\"<\" Spnl \"/\" (\"fieldset\" | \"FIELDSET\") Spnl \">\"")
Rules[:_HtmlBlockFieldset] = rule_info("HtmlBlockFieldset", "HtmlBlockOpenFieldset (HtmlBlockFieldset | !HtmlBlockCloseFieldset .)* HtmlBlockCloseFieldset")
Rules[:_HtmlBlockOpenForm] = rule_info("HtmlBlockOpenForm", "\"<\" Spnl (\"form\" | \"FORM\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseForm] = rule_info("HtmlBlockCloseForm", "\"<\" Spnl \"/\" (\"form\" | \"FORM\") Spnl \">\"")
Rules[:_HtmlBlockForm] = rule_info("HtmlBlockForm", "HtmlBlockOpenForm (HtmlBlockForm | !HtmlBlockCloseForm .)* HtmlBlockCloseForm")
Rules[:_HtmlBlockOpenH1] = rule_info("HtmlBlockOpenH1", "\"<\" Spnl (\"h1\" | \"H1\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseH1] = rule_info("HtmlBlockCloseH1", "\"<\" Spnl \"/\" (\"h1\" | \"H1\") Spnl \">\"")
Rules[:_HtmlBlockH1] = rule_info("HtmlBlockH1", "HtmlBlockOpenH1 (HtmlBlockH1 | !HtmlBlockCloseH1 .)* HtmlBlockCloseH1")
Rules[:_HtmlBlockOpenH2] = rule_info("HtmlBlockOpenH2", "\"<\" Spnl (\"h2\" | \"H2\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseH2] = rule_info("HtmlBlockCloseH2", "\"<\" Spnl \"/\" (\"h2\" | \"H2\") Spnl \">\"")
Rules[:_HtmlBlockH2] = rule_info("HtmlBlockH2", "HtmlBlockOpenH2 (HtmlBlockH2 | !HtmlBlockCloseH2 .)* HtmlBlockCloseH2")
Rules[:_HtmlBlockOpenH3] = rule_info("HtmlBlockOpenH3", "\"<\" Spnl (\"h3\" | \"H3\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseH3] = rule_info("HtmlBlockCloseH3", "\"<\" Spnl \"/\" (\"h3\" | \"H3\") Spnl \">\"")
Rules[:_HtmlBlockH3] = rule_info("HtmlBlockH3", "HtmlBlockOpenH3 (HtmlBlockH3 | !HtmlBlockCloseH3 .)* HtmlBlockCloseH3")
Rules[:_HtmlBlockOpenH4] = rule_info("HtmlBlockOpenH4", "\"<\" Spnl (\"h4\" | \"H4\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseH4] = rule_info("HtmlBlockCloseH4", "\"<\" Spnl \"/\" (\"h4\" | \"H4\") Spnl \">\"")
Rules[:_HtmlBlockH4] = rule_info("HtmlBlockH4", "HtmlBlockOpenH4 (HtmlBlockH4 | !HtmlBlockCloseH4 .)* HtmlBlockCloseH4")
Rules[:_HtmlBlockOpenH5] = rule_info("HtmlBlockOpenH5", "\"<\" Spnl (\"h5\" | \"H5\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseH5] = rule_info("HtmlBlockCloseH5", "\"<\" Spnl \"/\" (\"h5\" | \"H5\") Spnl \">\"")
Rules[:_HtmlBlockH5] = rule_info("HtmlBlockH5", "HtmlBlockOpenH5 (HtmlBlockH5 | !HtmlBlockCloseH5 .)* HtmlBlockCloseH5")
Rules[:_HtmlBlockOpenH6] = rule_info("HtmlBlockOpenH6", "\"<\" Spnl (\"h6\" | \"H6\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseH6] = rule_info("HtmlBlockCloseH6", "\"<\" Spnl \"/\" (\"h6\" | \"H6\") Spnl \">\"")
Rules[:_HtmlBlockH6] = rule_info("HtmlBlockH6", "HtmlBlockOpenH6 (HtmlBlockH6 | !HtmlBlockCloseH6 .)* HtmlBlockCloseH6")
Rules[:_HtmlBlockOpenMenu] = rule_info("HtmlBlockOpenMenu", "\"<\" Spnl (\"menu\" | \"MENU\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseMenu] = rule_info("HtmlBlockCloseMenu", "\"<\" Spnl \"/\" (\"menu\" | \"MENU\") Spnl \">\"")
Rules[:_HtmlBlockMenu] = rule_info("HtmlBlockMenu", "HtmlBlockOpenMenu (HtmlBlockMenu | !HtmlBlockCloseMenu .)* HtmlBlockCloseMenu")
Rules[:_HtmlBlockOpenNoframes] = rule_info("HtmlBlockOpenNoframes", "\"<\" Spnl (\"noframes\" | \"NOFRAMES\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseNoframes] = rule_info("HtmlBlockCloseNoframes", "\"<\" Spnl \"/\" (\"noframes\" | \"NOFRAMES\") Spnl \">\"")
Rules[:_HtmlBlockNoframes] = rule_info("HtmlBlockNoframes", "HtmlBlockOpenNoframes (HtmlBlockNoframes | !HtmlBlockCloseNoframes .)* HtmlBlockCloseNoframes")
Rules[:_HtmlBlockOpenNoscript] = rule_info("HtmlBlockOpenNoscript", "\"<\" Spnl (\"noscript\" | \"NOSCRIPT\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseNoscript] = rule_info("HtmlBlockCloseNoscript", "\"<\" Spnl \"/\" (\"noscript\" | \"NOSCRIPT\") Spnl \">\"")
Rules[:_HtmlBlockNoscript] = rule_info("HtmlBlockNoscript", "HtmlBlockOpenNoscript (HtmlBlockNoscript | !HtmlBlockCloseNoscript .)* HtmlBlockCloseNoscript")
Rules[:_HtmlBlockOpenOl] = rule_info("HtmlBlockOpenOl", "\"<\" Spnl (\"ol\" | \"OL\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseOl] = rule_info("HtmlBlockCloseOl", "\"<\" Spnl \"/\" (\"ol\" | \"OL\") Spnl \">\"")
Rules[:_HtmlBlockOl] = rule_info("HtmlBlockOl", "HtmlBlockOpenOl (HtmlBlockOl | !HtmlBlockCloseOl .)* HtmlBlockCloseOl")
Rules[:_HtmlBlockOpenP] = rule_info("HtmlBlockOpenP", "\"<\" Spnl (\"p\" | \"P\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseP] = rule_info("HtmlBlockCloseP", "\"<\" Spnl \"/\" (\"p\" | \"P\") Spnl \">\"")
Rules[:_HtmlBlockP] = rule_info("HtmlBlockP", "HtmlBlockOpenP (HtmlBlockP | !HtmlBlockCloseP .)* HtmlBlockCloseP")
Rules[:_HtmlBlockOpenPre] = rule_info("HtmlBlockOpenPre", "\"<\" Spnl (\"pre\" | \"PRE\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockClosePre] = rule_info("HtmlBlockClosePre", "\"<\" Spnl \"/\" (\"pre\" | \"PRE\") Spnl \">\"")
Rules[:_HtmlBlockPre] = rule_info("HtmlBlockPre", "HtmlBlockOpenPre (HtmlBlockPre | !HtmlBlockClosePre .)* HtmlBlockClosePre")
Rules[:_HtmlBlockOpenTable] = rule_info("HtmlBlockOpenTable", "\"<\" Spnl (\"table\" | \"TABLE\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseTable] = rule_info("HtmlBlockCloseTable", "\"<\" Spnl \"/\" (\"table\" | \"TABLE\") Spnl \">\"")
Rules[:_HtmlBlockTable] = rule_info("HtmlBlockTable", "HtmlBlockOpenTable (HtmlBlockTable | !HtmlBlockCloseTable .)* HtmlBlockCloseTable")
Rules[:_HtmlBlockOpenUl] = rule_info("HtmlBlockOpenUl", "\"<\" Spnl (\"ul\" | \"UL\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseUl] = rule_info("HtmlBlockCloseUl", "\"<\" Spnl \"/\" (\"ul\" | \"UL\") Spnl \">\"")
Rules[:_HtmlBlockUl] = rule_info("HtmlBlockUl", "HtmlBlockOpenUl (HtmlBlockUl | !HtmlBlockCloseUl .)* HtmlBlockCloseUl")
Rules[:_HtmlBlockOpenDd] = rule_info("HtmlBlockOpenDd", "\"<\" Spnl (\"dd\" | \"DD\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseDd] = rule_info("HtmlBlockCloseDd", "\"<\" Spnl \"/\" (\"dd\" | \"DD\") Spnl \">\"")
Rules[:_HtmlBlockDd] = rule_info("HtmlBlockDd", "HtmlBlockOpenDd (HtmlBlockDd | !HtmlBlockCloseDd .)* HtmlBlockCloseDd")
Rules[:_HtmlBlockOpenDt] = rule_info("HtmlBlockOpenDt", "\"<\" Spnl (\"dt\" | \"DT\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseDt] = rule_info("HtmlBlockCloseDt", "\"<\" Spnl \"/\" (\"dt\" | \"DT\") Spnl \">\"")
Rules[:_HtmlBlockDt] = rule_info("HtmlBlockDt", "HtmlBlockOpenDt (HtmlBlockDt | !HtmlBlockCloseDt .)* HtmlBlockCloseDt")
Rules[:_HtmlBlockOpenFrameset] = rule_info("HtmlBlockOpenFrameset", "\"<\" Spnl (\"frameset\" | \"FRAMESET\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseFrameset] = rule_info("HtmlBlockCloseFrameset", "\"<\" Spnl \"/\" (\"frameset\" | \"FRAMESET\") Spnl \">\"")
Rules[:_HtmlBlockFrameset] = rule_info("HtmlBlockFrameset", "HtmlBlockOpenFrameset (HtmlBlockFrameset | !HtmlBlockCloseFrameset .)* HtmlBlockCloseFrameset")
Rules[:_HtmlBlockOpenLi] = rule_info("HtmlBlockOpenLi", "\"<\" Spnl (\"li\" | \"LI\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseLi] = rule_info("HtmlBlockCloseLi", "\"<\" Spnl \"/\" (\"li\" | \"LI\") Spnl \">\"")
Rules[:_HtmlBlockLi] = rule_info("HtmlBlockLi", "HtmlBlockOpenLi (HtmlBlockLi | !HtmlBlockCloseLi .)* HtmlBlockCloseLi")
Rules[:_HtmlBlockOpenTbody] = rule_info("HtmlBlockOpenTbody", "\"<\" Spnl (\"tbody\" | \"TBODY\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseTbody] = rule_info("HtmlBlockCloseTbody", "\"<\" Spnl \"/\" (\"tbody\" | \"TBODY\") Spnl \">\"")
Rules[:_HtmlBlockTbody] = rule_info("HtmlBlockTbody", "HtmlBlockOpenTbody (HtmlBlockTbody | !HtmlBlockCloseTbody .)* HtmlBlockCloseTbody")
Rules[:_HtmlBlockOpenTd] = rule_info("HtmlBlockOpenTd", "\"<\" Spnl (\"td\" | \"TD\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseTd] = rule_info("HtmlBlockCloseTd", "\"<\" Spnl \"/\" (\"td\" | \"TD\") Spnl \">\"")
Rules[:_HtmlBlockTd] = rule_info("HtmlBlockTd", "HtmlBlockOpenTd (HtmlBlockTd | !HtmlBlockCloseTd .)* HtmlBlockCloseTd")
Rules[:_HtmlBlockOpenTfoot] = rule_info("HtmlBlockOpenTfoot", "\"<\" Spnl (\"tfoot\" | \"TFOOT\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseTfoot] = rule_info("HtmlBlockCloseTfoot", "\"<\" Spnl \"/\" (\"tfoot\" | \"TFOOT\") Spnl \">\"")
Rules[:_HtmlBlockTfoot] = rule_info("HtmlBlockTfoot", "HtmlBlockOpenTfoot (HtmlBlockTfoot | !HtmlBlockCloseTfoot .)* HtmlBlockCloseTfoot")
Rules[:_HtmlBlockOpenTh] = rule_info("HtmlBlockOpenTh", "\"<\" Spnl (\"th\" | \"TH\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseTh] = rule_info("HtmlBlockCloseTh", "\"<\" Spnl \"/\" (\"th\" | \"TH\") Spnl \">\"")
Rules[:_HtmlBlockTh] = rule_info("HtmlBlockTh", "HtmlBlockOpenTh (HtmlBlockTh | !HtmlBlockCloseTh .)* HtmlBlockCloseTh")
Rules[:_HtmlBlockOpenThead] = rule_info("HtmlBlockOpenThead", "\"<\" Spnl (\"thead\" | \"THEAD\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseThead] = rule_info("HtmlBlockCloseThead", "\"<\" Spnl \"/\" (\"thead\" | \"THEAD\") Spnl \">\"")
Rules[:_HtmlBlockThead] = rule_info("HtmlBlockThead", "HtmlBlockOpenThead (HtmlBlockThead | !HtmlBlockCloseThead .)* HtmlBlockCloseThead")
Rules[:_HtmlBlockOpenTr] = rule_info("HtmlBlockOpenTr", "\"<\" Spnl (\"tr\" | \"TR\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseTr] = rule_info("HtmlBlockCloseTr", "\"<\" Spnl \"/\" (\"tr\" | \"TR\") Spnl \">\"")
Rules[:_HtmlBlockTr] = rule_info("HtmlBlockTr", "HtmlBlockOpenTr (HtmlBlockTr | !HtmlBlockCloseTr .)* HtmlBlockCloseTr")
Rules[:_HtmlBlockOpenScript] = rule_info("HtmlBlockOpenScript", "\"<\" Spnl (\"script\" | \"SCRIPT\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseScript] = rule_info("HtmlBlockCloseScript", "\"<\" Spnl \"/\" (\"script\" | \"SCRIPT\") Spnl \">\"")
Rules[:_HtmlBlockScript] = rule_info("HtmlBlockScript", "HtmlBlockOpenScript (!HtmlBlockCloseScript .)* HtmlBlockCloseScript")
Rules[:_HtmlBlockOpenHead] = rule_info("HtmlBlockOpenHead", "\"<\" Spnl (\"head\" | \"HEAD\") Spnl HtmlAttribute* \">\"")
Rules[:_HtmlBlockCloseHead] = rule_info("HtmlBlockCloseHead", "\"<\" Spnl \"/\" (\"head\" | \"HEAD\") Spnl \">\"")
Rules[:_HtmlBlockHead] = rule_info("HtmlBlockHead", "HtmlBlockOpenHead (!HtmlBlockCloseHead .)* HtmlBlockCloseHead")
Rules[:_HtmlBlockInTags] = rule_info("HtmlBlockInTags", "(HtmlAnchor | HtmlBlockAddress | HtmlBlockBlockquote | HtmlBlockCenter | HtmlBlockDir | HtmlBlockDiv | HtmlBlockDl | HtmlBlockFieldset | HtmlBlockForm | HtmlBlockH1 | HtmlBlockH2 | HtmlBlockH3 | HtmlBlockH4 | HtmlBlockH5 | HtmlBlockH6 | HtmlBlockMenu | HtmlBlockNoframes | HtmlBlockNoscript | HtmlBlockOl | HtmlBlockP | HtmlBlockPre | HtmlBlockTable | HtmlBlockUl | HtmlBlockDd | HtmlBlockDt | HtmlBlockFrameset | HtmlBlockLi | HtmlBlockTbody | HtmlBlockTd | HtmlBlockTfoot | HtmlBlockTh | HtmlBlockThead | HtmlBlockTr | HtmlBlockScript | HtmlBlockHead)")
Rules[:_HtmlBlock] = rule_info("HtmlBlock", "< (HtmlBlockInTags | HtmlComment | HtmlBlockSelfClosing | HtmlUnclosed) > @BlankLine+ { if html? then RDoc::Markup::Raw.new text end }")
Rules[:_HtmlUnclosed] = rule_info("HtmlUnclosed", "\"<\" Spnl HtmlUnclosedType Spnl HtmlAttribute* Spnl \">\"")
Rules[:_HtmlUnclosedType] = rule_info("HtmlUnclosedType", "(\"HR\" | \"hr\")")
Rules[:_HtmlBlockSelfClosing] = rule_info("HtmlBlockSelfClosing", "\"<\" Spnl HtmlBlockType Spnl HtmlAttribute* \"/\" Spnl \">\"")
Rules[:_HtmlBlockType] = rule_info("HtmlBlockType", "(\"ADDRESS\" | \"BLOCKQUOTE\" | \"CENTER\" | \"DD\" | \"DIR\" | \"DIV\" | \"DL\" | \"DT\" | \"FIELDSET\" | \"FORM\" | \"FRAMESET\" | \"H1\" | \"H2\" | \"H3\" | \"H4\" | \"H5\" | \"H6\" | \"HR\" | \"ISINDEX\" | \"LI\" | \"MENU\" | \"NOFRAMES\" | \"NOSCRIPT\" | \"OL\" | \"P\" | \"PRE\" | \"SCRIPT\" | \"TABLE\" | \"TBODY\" | \"TD\" | \"TFOOT\" | \"TH\" | \"THEAD\" | \"TR\" | \"UL\" | \"address\" | \"blockquote\" | \"center\" | \"dd\" | \"dir\" | \"div\" | \"dl\" | \"dt\" | \"fieldset\" | \"form\" | \"frameset\" | \"h1\" | \"h2\" | \"h3\" | \"h4\" | \"h5\" | \"h6\" | \"hr\" | \"isindex\" | \"li\" | \"menu\" | \"noframes\" | \"noscript\" | \"ol\" | \"p\" | \"pre\" | \"script\" | \"table\" | \"tbody\" | \"td\" | \"tfoot\" | \"th\" | \"thead\" | \"tr\" | \"ul\")")
Rules[:_StyleOpen] = rule_info("StyleOpen", "\"<\" Spnl (\"style\" | \"STYLE\") Spnl HtmlAttribute* \">\"")
Rules[:_StyleClose] = rule_info("StyleClose", "\"<\" Spnl \"/\" (\"style\" | \"STYLE\") Spnl \">\"")
Rules[:_InStyleTags] = rule_info("InStyleTags", "StyleOpen (!StyleClose .)* StyleClose")
Rules[:_StyleBlock] = rule_info("StyleBlock", "< InStyleTags > @BlankLine* { if css? then RDoc::Markup::Raw.new text end }")
Rules[:_Inlines] = rule_info("Inlines", "(!@Endline Inline:i { i } | @Endline:c !(&{ github? } Ticks3 /[^`\\n]*$/) &Inline { c })+:chunks @Endline? { chunks }")
Rules[:_Inline] = rule_info("Inline", "(Str | @Endline | UlOrStarLine | @Space | Strong | Emph | Strike | Image | Link | NoteReference | InlineNote | Code | RawHtml | Entity | EscapedChar | Symbol)")
Rules[:_Space] = rule_info("Space", "@Spacechar+ { \" \" }")
Rules[:_Str] = rule_info("Str", "@StartList:a < @NormalChar+ > { a = text } (StrChunk:c { a << c })* { a }")
Rules[:_StrChunk] = rule_info("StrChunk", "< (@NormalChar | /_+/ &Alphanumeric)+ > { text }")
Rules[:_EscapedChar] = rule_info("EscapedChar", "\"\\\\\" !@Newline < /[:\\\\`|*_{}\\[\\]()\#+.!><-]/ > { text }")
Rules[:_Entity] = rule_info("Entity", "(HexEntity | DecEntity | CharEntity):a { a }")
Rules[:_Endline] = rule_info("Endline", "(@LineBreak | @TerminalEndline | @NormalEndline)")
Rules[:_NormalEndline] = rule_info("NormalEndline", "@Sp @Newline !@BlankLine !\">\" !AtxStart !(Line /={1,}|-{1,}/ @Newline) { \"\\n\" }")
Rules[:_TerminalEndline] = rule_info("TerminalEndline", "@Sp @Newline @Eof")
Rules[:_LineBreak] = rule_info("LineBreak", "\" \" @NormalEndline { RDoc::Markup::HardBreak.new }")
Rules[:_Symbol] = rule_info("Symbol", "< @SpecialChar > { text }")
Rules[:_UlOrStarLine] = rule_info("UlOrStarLine", "(UlLine | StarLine):a { a }")
Rules[:_StarLine] = rule_info("StarLine", "(< /\\*{4,}/ > { text } | < @Spacechar /\\*+/ &@Spacechar > { text })")
Rules[:_UlLine] = rule_info("UlLine", "(< /_{4,}/ > { text } | < @Spacechar /_+/ &@Spacechar > { text })")
Rules[:_Emph] = rule_info("Emph", "(EmphStar | EmphUl)")
Rules[:_Whitespace] = rule_info("Whitespace", "(@Spacechar | @Newline)")
Rules[:_EmphStar] = rule_info("EmphStar", "\"*\" !@Whitespace @StartList:a (!\"*\" Inline:b { a << b } | StrongStar:b { a << b })+ \"*\" { emphasis a.join }")
Rules[:_EmphUl] = rule_info("EmphUl", "\"_\" !@Whitespace @StartList:a (!\"_\" Inline:b { a << b } | StrongUl:b { a << b })+ \"_\" { emphasis a.join }")
Rules[:_Strong] = rule_info("Strong", "(StrongStar | StrongUl)")
Rules[:_StrongStar] = rule_info("StrongStar", "\"**\" !@Whitespace @StartList:a (!\"**\" Inline:b { a << b })+ \"**\" { strong a.join }")
Rules[:_StrongUl] = rule_info("StrongUl", "\"__\" !@Whitespace @StartList:a (!\"__\" Inline:b { a << b })+ \"__\" { strong a.join }")
Rules[:_Strike] = rule_info("Strike", "&{ strike? } \"~~\" !@Whitespace @StartList:a (!\"~~\" Inline:b { a << b })+ \"~~\" { strike a.join }")
Rules[:_Image] = rule_info("Image", "\"!\" (ExplicitLink | ReferenceLink):a { \"rdoc-image:\#{a[/\\[(.*)\\]/, 1]}\" }")
Rules[:_Link] = rule_info("Link", "(ExplicitLink | ReferenceLink | AutoLink)")
Rules[:_ReferenceLink] = rule_info("ReferenceLink", "(ReferenceLinkDouble | ReferenceLinkSingle)")
Rules[:_ReferenceLinkDouble] = rule_info("ReferenceLinkDouble", "Label:content < Spnl > !\"[]\" Label:label { link_to content, label, text }")
Rules[:_ReferenceLinkSingle] = rule_info("ReferenceLinkSingle", "Label:content < (Spnl \"[]\")? > { link_to content, content, text }")
Rules[:_ExplicitLink] = rule_info("ExplicitLink", "Label:l \"(\" @Sp Source:s Spnl Title @Sp \")\" { \"{\#{l}}[\#{s}]\" }")
Rules[:_Source] = rule_info("Source", "(\"<\" < SourceContents > \">\" | < SourceContents >) { text }")
Rules[:_SourceContents] = rule_info("SourceContents", "((!\"(\" !\")\" !\">\" Nonspacechar)+ | \"(\" SourceContents \")\")*")
Rules[:_Title] = rule_info("Title", "(TitleSingle | TitleDouble | \"\"):a { a }")
Rules[:_TitleSingle] = rule_info("TitleSingle", "\"'\" (!(\"'\" @Sp (\")\" | @Newline)) .)* \"'\"")
Rules[:_TitleDouble] = rule_info("TitleDouble", "\"\\\"\" (!(\"\\\"\" @Sp (\")\" | @Newline)) .)* \"\\\"\"")
Rules[:_AutoLink] = rule_info("AutoLink", "(AutoLinkUrl | AutoLinkEmail)")
Rules[:_AutoLinkUrl] = rule_info("AutoLinkUrl", "\"<\" < /[A-Za-z]+/ \"://\" (!@Newline !\">\" .)+ > \">\" { text }")
Rules[:_AutoLinkEmail] = rule_info("AutoLinkEmail", "\"<\" \"mailto:\"? < /[\\w+.\\/!%~$-]+/i \"@\" (!@Newline !\">\" .)+ > \">\" { \"mailto:\#{text}\" }")
Rules[:_Reference] = rule_info("Reference", "@NonindentSpace !\"[]\" Label:label \":\" Spnl RefSrc:link RefTitle @BlankLine+ { \# TODO use title reference label, link nil }")
Rules[:_Label] = rule_info("Label", "\"[\" (!\"^\" &{ notes? } | &. &{ !notes? }) @StartList:a (!\"]\" Inline:l { a << l })* \"]\" { a.join.gsub(/\\s+/, ' ') }")
Rules[:_RefSrc] = rule_info("RefSrc", "< Nonspacechar+ > { text }")
Rules[:_RefTitle] = rule_info("RefTitle", "(RefTitleSingle | RefTitleDouble | RefTitleParens | EmptyTitle)")
Rules[:_EmptyTitle] = rule_info("EmptyTitle", "\"\"")
Rules[:_RefTitleSingle] = rule_info("RefTitleSingle", "Spnl \"'\" < (!(\"'\" @Sp @Newline | @Newline) .)* > \"'\" { text }")
Rules[:_RefTitleDouble] = rule_info("RefTitleDouble", "Spnl \"\\\"\" < (!(\"\\\"\" @Sp @Newline | @Newline) .)* > \"\\\"\" { text }")
Rules[:_RefTitleParens] = rule_info("RefTitleParens", "Spnl \"(\" < (!(\")\" @Sp @Newline | @Newline) .)* > \")\" { text }")
Rules[:_References] = rule_info("References", "(Reference | SkipBlock)*")
Rules[:_Ticks1] = rule_info("Ticks1", "\"`\" !\"`\"")
Rules[:_Ticks2] = rule_info("Ticks2", "\"``\" !\"`\"")
Rules[:_Ticks3] = rule_info("Ticks3", "\"```\" !\"`\"")
Rules[:_Ticks4] = rule_info("Ticks4", "\"````\" !\"`\"")
Rules[:_Ticks5] = rule_info("Ticks5", "\"`````\" !\"`\"")
Rules[:_Code] = rule_info("Code", "(Ticks1 @Sp < ((!\"`\" Nonspacechar)+ | !Ticks1 /`+/ | !(@Sp Ticks1) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks1 | Ticks2 @Sp < ((!\"`\" Nonspacechar)+ | !Ticks2 /`+/ | !(@Sp Ticks2) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks2 | Ticks3 @Sp < ((!\"`\" Nonspacechar)+ | !Ticks3 /`+/ | !(@Sp Ticks3) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks3 | Ticks4 @Sp < ((!\"`\" Nonspacechar)+ | !Ticks4 /`+/ | !(@Sp Ticks4) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks4 | Ticks5 @Sp < ((!\"`\" Nonspacechar)+ | !Ticks5 /`+/ | !(@Sp Ticks5) (@Spacechar | @Newline !@BlankLine))+ > @Sp Ticks5) { \"<code>\#{text}</code>\" }")
Rules[:_RawHtml] = rule_info("RawHtml", "< (HtmlComment | HtmlBlockScript | HtmlTag) > { if html? then text else '' end }")
Rules[:_BlankLine] = rule_info("BlankLine", "@Sp @Newline { \"\\n\" }")
Rules[:_Quoted] = rule_info("Quoted", "(\"\\\"\" (!\"\\\"\" .)* \"\\\"\" | \"'\" (!\"'\" .)* \"'\")")
Rules[:_HtmlAttribute] = rule_info("HtmlAttribute", "(AlphanumericAscii | \"-\")+ Spnl (\"=\" Spnl (Quoted | (!\">\" Nonspacechar)+))? Spnl")
Rules[:_HtmlComment] = rule_info("HtmlComment", "\"<!--\" (!\"-->\" .)* \"-->\"")
Rules[:_HtmlTag] = rule_info("HtmlTag", "\"<\" Spnl \"/\"? AlphanumericAscii+ Spnl HtmlAttribute* \"/\"? Spnl \">\"")
Rules[:_Eof] = rule_info("Eof", "!.")
Rules[:_Nonspacechar] = rule_info("Nonspacechar", "!@Spacechar !@Newline .")
Rules[:_Sp] = rule_info("Sp", "@Spacechar*")
Rules[:_Spnl] = rule_info("Spnl", "@Sp (@Newline @Sp)?")
Rules[:_SpecialChar] = rule_info("SpecialChar", "(/[~*_`&\\[\\]()<!\#\\\\'\"]/ | @ExtendedSpecialChar)")
Rules[:_NormalChar] = rule_info("NormalChar", "!(@SpecialChar | @Spacechar | @Newline) .")
Rules[:_Digit] = rule_info("Digit", "[0-9]")
Rules[:_Alphanumeric] = rule_info("Alphanumeric", "%literals.Alphanumeric")
Rules[:_AlphanumericAscii] = rule_info("AlphanumericAscii", "%literals.AlphanumericAscii")
Rules[:_BOM] = rule_info("BOM", "%literals.BOM")
Rules[:_Newline] = rule_info("Newline", "%literals.Newline")
Rules[:_Spacechar] = rule_info("Spacechar", "%literals.Spacechar")
Rules[:_HexEntity] = rule_info("HexEntity", "/&\#x/i < /[0-9a-fA-F]+/ > \";\" { [text.to_i(16)].pack 'U' }")
Rules[:_DecEntity] = rule_info("DecEntity", "\"&\#\" < /[0-9]+/ > \";\" { [text.to_i].pack 'U' }")
Rules[:_CharEntity] = rule_info("CharEntity", "\"&\" < /[A-Za-z0-9]+/ > \";\" { if entity = HTML_ENTITIES[text] then entity.pack 'U*' else \"&\#{text};\" end }")
Rules[:_NonindentSpace] = rule_info("NonindentSpace", "/ {0,3}/")
Rules[:_Indent] = rule_info("Indent", "/\\t| /")
Rules[:_IndentedLine] = rule_info("IndentedLine", "Indent Line")
Rules[:_OptionallyIndentedLine] = rule_info("OptionallyIndentedLine", "Indent? Line")
Rules[:_StartList] = rule_info("StartList", "&. { [] }")
Rules[:_Line] = rule_info("Line", "@RawLine:a { a }")
Rules[:_RawLine] = rule_info("RawLine", "(< /[^\\r\\n]*/ @Newline > | < .+ > @Eof) { text }")
Rules[:_SkipBlock] = rule_info("SkipBlock", "(HtmlBlock | (!\"\#\" !SetextBottom1 !SetextBottom2 !@BlankLine @RawLine)+ @BlankLine* | @BlankLine+ | @RawLine)")
Rules[:_ExtendedSpecialChar] = rule_info("ExtendedSpecialChar", "&{ notes? } \"^\"")
Rules[:_NoteReference] = rule_info("NoteReference", "&{ notes? } RawNoteReference:ref { note_for ref }")
Rules[:_RawNoteReference] = rule_info("RawNoteReference", "\"[^\" < (!@Newline !\"]\" .)+ > \"]\" { text }")
Rules[:_Note] = rule_info("Note", "&{ notes? } @NonindentSpace RawNoteReference:ref \":\" @Sp @StartList:a RawNoteBlock:i { a.concat i } (&Indent RawNoteBlock:i { a.concat i })* { @footnotes[ref] = paragraph a nil }")
Rules[:_InlineNote] = rule_info("InlineNote", "&{ notes? } \"^[\" @StartList:a (!\"]\" Inline:l { a << l })+ \"]\" { ref = [:inline, @note_order.length] @footnotes[ref] = paragraph a note_for ref }")
Rules[:_Notes] = rule_info("Notes", "(Note | SkipBlock)*")
Rules[:_RawNoteBlock] = rule_info("RawNoteBlock", "@StartList:a (!@BlankLine !RawNoteReference OptionallyIndentedLine:l { a << l })+ < @BlankLine* > { a << text } { a }")
Rules[:_CodeFence] = rule_info("CodeFence", "&{ github? } Ticks3 (@Sp StrChunk:format)? Spnl < ((!\"`\" Nonspacechar)+ | !Ticks3 /`+/ | Spacechar | @Newline)+ > Ticks3 @Sp @Newline* { verbatim = RDoc::Markup::Verbatim.new text verbatim.format = format.intern if format.instance_of?(String) verbatim }")
Rules[:_Table] = rule_info("Table", "&{ github? } TableHead:header TableLine:line TableRow+:body { table = RDoc::Markup::Table.new(header, line, body) }")
Rules[:_TableHead] = rule_info("TableHead", "TableItem2+:items \"|\"? @Newline { items }")
Rules[:_TableRow] = rule_info("TableRow", "((TableItem:item1 TableItem2*:items { [item1, *items] }):row | TableItem2+:row) \"|\"? @Newline { row }")
Rules[:_TableItem2] = rule_info("TableItem2", "\"|\" TableItem")
Rules[:_TableItem] = rule_info("TableItem", "< /(?:\\\\.|[^|\\n])+/ > { text.strip.gsub(/\\\\(.)/, '\\1') }")
Rules[:_TableLine] = rule_info("TableLine", "((TableAlign:align1 TableAlign2*:aligns {[align1, *aligns] }):line | TableAlign2+:line) \"|\"? @Newline { line }")
Rules[:_TableAlign2] = rule_info("TableAlign2", "\"|\" @Sp TableAlign")
Rules[:_TableAlign] = rule_info("TableAlign", "< /:?-+:?/ > @Sp { text.start_with?(\":\") ? (text.end_with?(\":\") ? :center : :left) : (text.end_with?(\":\") ? :right : nil) }")
Rules[:_DefinitionList] = rule_info("DefinitionList", "&{ definition_lists? } DefinitionListItem+:list { RDoc::Markup::List.new :NOTE, *list.flatten }")
Rules[:_DefinitionListItem] = rule_info("DefinitionListItem", "DefinitionListLabel+:label DefinitionListDefinition+:defns { list_items = [] list_items << RDoc::Markup::ListItem.new(label, defns.shift) list_items.concat defns.map { |defn| RDoc::Markup::ListItem.new nil, defn } unless list_items.empty? list_items }")
Rules[:_DefinitionListLabel] = rule_info("DefinitionListLabel", "StrChunk:label @Sp @Newline { label }")
Rules[:_DefinitionListDefinition] = rule_info("DefinitionListDefinition", "@NonindentSpace \":\" @Space Inlines:a @BlankLine+ { paragraph a }")
# :startdoc:
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/comment.rb 0000644 00000012305 15173517747 0015000 0 ustar 00 # frozen_string_literal: true
##
# A comment holds the text comment for a RDoc::CodeObject and provides a
# unified way of cleaning it up and parsing it into an RDoc::Markup::Document.
#
# Each comment may have a different markup format set by #format=. By default
# 'rdoc' is used. The :markup: directive tells RDoc which format to use.
#
# See RDoc::MarkupReference@Directive+for+Specifying+RDoc+Source+Format.
class RDoc::Comment
include RDoc::Text
##
# The format of this comment. Defaults to RDoc::Markup
attr_reader :format
##
# The RDoc::TopLevel this comment was found in
attr_accessor :location
##
# Line where this Comment was written
attr_accessor :line
##
# For duck-typing when merging classes at load time
alias file location # :nodoc:
##
# The text for this comment
attr_reader :text
##
# Alias for text
alias to_s text
##
# Overrides the content returned by #parse. Use when there is no #text
# source for this comment
attr_writer :document
##
# Creates a new comment with +text+ that is found in the RDoc::TopLevel
# +location+.
def initialize text = nil, location = nil, language = nil
@location = location
@text = text.nil? ? nil : text.dup
@language = language
@document = nil
@format = 'rdoc'
@normalized = false
end
##
#--
# TODO deep copy @document
def initialize_copy copy # :nodoc:
@text = copy.text.dup
end
def == other # :nodoc:
self.class === other and
other.text == @text and other.location == @location
end
##
# Look for a 'call-seq' in the comment to override the normal parameter
# handling. The :call-seq: is indented from the baseline. All lines of the
# same indentation level and prefix are consumed.
#
# For example, all of the following will be used as the :call-seq:
#
# # :call-seq:
# # ARGF.readlines(sep=$/) -> array
# # ARGF.readlines(limit) -> array
# # ARGF.readlines(sep, limit) -> array
# #
# # ARGF.to_a(sep=$/) -> array
# # ARGF.to_a(limit) -> array
# # ARGF.to_a(sep, limit) -> array
def extract_call_seq method
# we must handle situations like the above followed by an unindented first
# comment. The difficulty is to make sure not to match lines starting
# with ARGF at the same indent, but that are after the first description
# paragraph.
if /^(?<S> ((?!\n)\s)*+ (?# whitespaces except newline))
:?call-seq:
(?<B> \g<S>(?<N>\n|\z) (?# trailing spaces))?
(?<seq>
(\g<S>(?!\w)\S.*\g<N>)*
(?>
(?<H> \g<S>\w+ (?# ' # ARGF' in the example above))
.*\g<N>)?
(\g<S>\S.*\g<N> (?# other non-blank line))*+
(\g<B>+(\k<H>.*\g<N> (?# ARGF.to_a lines))++)*+
)
(?m:^\s*$|\z)
/x =~ @text
seq = $~[:seq]
all_start, all_stop = $~.offset(0)
@text.slice! all_start...all_stop
seq.gsub!(/^\s*/, '')
method.call_seq = seq
end
method
end
##
# A comment is empty if its text String is empty.
def empty?
@text.empty?
end
##
# HACK dubious
def encode! encoding
@text = String.new @text, encoding: encoding
self
end
##
# Sets the format of this comment and resets any parsed document
def format= format
@format = format
@document = nil
end
def inspect # :nodoc:
location = @location ? @location.relative_name : '(unknown)'
"#<%s:%x %s %p>" % [self.class, object_id, location, @text]
end
##
# Normalizes the text. See RDoc::Text#normalize_comment for details
def normalize
return self unless @text
return self if @normalized # TODO eliminate duplicate normalization
@text = normalize_comment @text
@normalized = true
self
end
##
# Was this text normalized?
def normalized? # :nodoc:
@normalized
end
##
# Parses the comment into an RDoc::Markup::Document. The parsed document is
# cached until the text is changed.
def parse
return @document if @document
@document = super @text, @format
@document.file = @location
@document
end
##
# Removes private sections from this comment. Private sections are flush to
# the comment marker and start with <tt>--</tt> and end with <tt>++</tt>.
# For C-style comments, a private marker may not start at the opening of the
# comment.
#
# /*
# *--
# * private
# *++
# * public
# */
def remove_private
# Workaround for gsub encoding for Ruby 1.9.2 and earlier
empty = ''
empty = RDoc::Encoding.change_encoding empty, @text.encoding
@text = @text.gsub(%r%^\s*([#*]?)--.*?^\s*(\1)\+\+\n?%m, empty)
@text = @text.sub(%r%^\s*[#*]?--.*%m, '')
end
##
# Replaces this comment's text with +text+ and resets the parsed document.
#
# An error is raised if the comment contains a document but no text.
def text= text
raise RDoc::Error, 'replacing document-only comment is not allowed' if
@text.nil? and @document
@document = nil
@text = text.nil? ? nil : text.dup
end
##
# Returns true if this comment is in TomDoc format.
def tomdoc?
@format == 'tomdoc'
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/rd/inline_parser.rb 0000644 00000143577 15173517747 0016615 0 ustar 00 # frozen_string_literal: true
#
# DO NOT MODIFY!!!!
# This file is automatically generated by Racc 1.7.3
# from Racc grammar file "inline_parser.ry".
#
###### racc/parser.rb begin
unless $".find {|p| p.end_with?('/racc/parser.rb')}
$".push "#{__dir__}/racc/parser.rb"
#--
# Copyright (c) 1999-2006 Minero Aoki
#
# This program is free software.
# You can distribute/modify this program under the same terms of ruby.
#
# As a special exception, when this code is copied by Racc
# into a Racc output file, you may use that output file
# without restriction.
#++
unless $".find {|p| p.end_with?('/racc/info.rb')}
$".push "#{__dir__}/racc/info.rb"
module Racc
VERSION = '1.7.3'
Version = VERSION
Copyright = 'Copyright (c) 1999-2006 Minero Aoki'
end
end
unless defined?(NotImplementedError)
NotImplementedError = NotImplementError # :nodoc:
end
module Racc
class ParseError < StandardError; end
end
unless defined?(::ParseError)
ParseError = Racc::ParseError # :nodoc:
end
# Racc is a LALR(1) parser generator.
# It is written in Ruby itself, and generates Ruby programs.
#
# == Command-line Reference
#
# racc [-o<var>filename</var>] [--output-file=<var>filename</var>]
# [-e<var>rubypath</var>] [--executable=<var>rubypath</var>]
# [-v] [--verbose]
# [-O<var>filename</var>] [--log-file=<var>filename</var>]
# [-g] [--debug]
# [-E] [--embedded]
# [-l] [--no-line-convert]
# [-c] [--line-convert-all]
# [-a] [--no-omit-actions]
# [-C] [--check-only]
# [-S] [--output-status]
# [--version] [--copyright] [--help] <var>grammarfile</var>
#
# [+grammarfile+]
# Racc grammar file. Any extension is permitted.
# [-o+outfile+, --output-file=+outfile+]
# A filename for output. default is <+filename+>.tab.rb
# [-O+filename+, --log-file=+filename+]
# Place logging output in file +filename+.
# Default log file name is <+filename+>.output.
# [-e+rubypath+, --executable=+rubypath+]
# output executable file(mode 755). where +path+ is the Ruby interpreter.
# [-v, --verbose]
# verbose mode. create +filename+.output file, like yacc's y.output file.
# [-g, --debug]
# add debug code to parser class. To display debugging information,
# use this '-g' option and set @yydebug true in parser class.
# [-E, --embedded]
# Output parser which doesn't need runtime files (racc/parser.rb).
# [-F, --frozen]
# Output parser which declares frozen_string_literals: true
# [-C, --check-only]
# Check syntax of racc grammar file and quit.
# [-S, --output-status]
# Print messages time to time while compiling.
# [-l, --no-line-convert]
# turns off line number converting.
# [-c, --line-convert-all]
# Convert line number of actions, inner, header and footer.
# [-a, --no-omit-actions]
# Call all actions, even if an action is empty.
# [--version]
# print Racc version and quit.
# [--copyright]
# Print copyright and quit.
# [--help]
# Print usage and quit.
#
# == Generating Parser Using Racc
#
# To compile Racc grammar file, simply type:
#
# $ racc parse.y
#
# This creates Ruby script file "parse.tab.y". The -o option can change the output filename.
#
# == Writing A Racc Grammar File
#
# If you want your own parser, you have to write a grammar file.
# A grammar file contains the name of your parser class, grammar for the parser,
# user code, and anything else.
# When writing a grammar file, yacc's knowledge is helpful.
# If you have not used yacc before, Racc is not too difficult.
#
# Here's an example Racc grammar file.
#
# class Calcparser
# rule
# target: exp { print val[0] }
#
# exp: exp '+' exp
# | exp '*' exp
# | '(' exp ')'
# | NUMBER
# end
#
# Racc grammar files resemble yacc files.
# But (of course), this is Ruby code.
# yacc's $$ is the 'result', $0, $1... is
# an array called 'val', and $-1, $-2... is an array called '_values'.
#
# See the {Grammar File Reference}[rdoc-ref:lib/racc/rdoc/grammar.en.rdoc] for
# more information on grammar files.
#
# == Parser
#
# Then you must prepare the parse entry method. There are two types of
# parse methods in Racc, Racc::Parser#do_parse and Racc::Parser#yyparse
#
# Racc::Parser#do_parse is simple.
#
# It's yyparse() of yacc, and Racc::Parser#next_token is yylex().
# This method must returns an array like [TOKENSYMBOL, ITS_VALUE].
# EOF is [false, false].
# (TOKENSYMBOL is a Ruby symbol (taken from String#intern) by default.
# If you want to change this, see the grammar reference.
#
# Racc::Parser#yyparse is little complicated, but useful.
# It does not use Racc::Parser#next_token, instead it gets tokens from any iterator.
#
# For example, <code>yyparse(obj, :scan)</code> causes
# calling +obj#scan+, and you can return tokens by yielding them from +obj#scan+.
#
# == Debugging
#
# When debugging, "-v" or/and the "-g" option is helpful.
#
# "-v" creates verbose log file (.output).
# "-g" creates a "Verbose Parser".
# Verbose Parser prints the internal status when parsing.
# But it's _not_ automatic.
# You must use -g option and set +@yydebug+ to +true+ in order to get output.
# -g option only creates the verbose parser.
#
# === Racc reported syntax error.
#
# Isn't there too many "end"?
# grammar of racc file is changed in v0.10.
#
# Racc does not use '%' mark, while yacc uses huge number of '%' marks..
#
# === Racc reported "XXXX conflicts".
#
# Try "racc -v xxxx.y".
# It causes producing racc's internal log file, xxxx.output.
#
# === Generated parsers does not work correctly
#
# Try "racc -g xxxx.y".
# This command let racc generate "debugging parser".
# Then set @yydebug=true in your parser.
# It produces a working log of your parser.
#
# == Re-distributing Racc runtime
#
# A parser, which is created by Racc, requires the Racc runtime module;
# racc/parser.rb.
#
# Ruby 1.8.x comes with Racc runtime module,
# you need NOT distribute Racc runtime files.
#
# If you want to include the Racc runtime module with your parser.
# This can be done by using '-E' option:
#
# $ racc -E -omyparser.rb myparser.y
#
# This command creates myparser.rb which `includes' Racc runtime.
# Only you must do is to distribute your parser file (myparser.rb).
#
# Note: parser.rb is ruby license, but your parser is not.
# Your own parser is completely yours.
module Racc
unless defined?(Racc_No_Extensions)
Racc_No_Extensions = false # :nodoc:
end
class Parser
Racc_Runtime_Version = ::Racc::VERSION
Racc_Runtime_Core_Version_R = ::Racc::VERSION
begin
if Object.const_defined?(:RUBY_ENGINE) and RUBY_ENGINE == 'jruby'
require 'jruby'
require 'racc/cparse-jruby.jar'
com.headius.racc.Cparse.new.load(JRuby.runtime, false)
else
require 'racc/cparse'
end
unless new.respond_to?(:_racc_do_parse_c, true)
raise LoadError, 'old cparse.so'
end
if Racc_No_Extensions
raise LoadError, 'selecting ruby version of racc runtime core'
end
Racc_Main_Parsing_Routine = :_racc_do_parse_c # :nodoc:
Racc_YY_Parse_Method = :_racc_yyparse_c # :nodoc:
Racc_Runtime_Core_Version = Racc_Runtime_Core_Version_C # :nodoc:
Racc_Runtime_Type = 'c' # :nodoc:
rescue LoadError
Racc_Main_Parsing_Routine = :_racc_do_parse_rb
Racc_YY_Parse_Method = :_racc_yyparse_rb
Racc_Runtime_Core_Version = Racc_Runtime_Core_Version_R
Racc_Runtime_Type = 'ruby'
end
def Parser.racc_runtime_type # :nodoc:
Racc_Runtime_Type
end
def _racc_setup
@yydebug = false unless self.class::Racc_debug_parser
@yydebug = false unless defined?(@yydebug)
if @yydebug
@racc_debug_out = $stderr unless defined?(@racc_debug_out)
@racc_debug_out ||= $stderr
end
arg = self.class::Racc_arg
arg[13] = true if arg.size < 14
arg
end
def _racc_init_sysvars
@racc_state = [0]
@racc_tstack = []
@racc_vstack = []
@racc_t = nil
@racc_val = nil
@racc_read_next = true
@racc_user_yyerror = false
@racc_error_status = 0
end
# The entry point of the parser. This method is used with #next_token.
# If Racc wants to get token (and its value), calls next_token.
#
# Example:
# def parse
# @q = [[1,1],
# [2,2],
# [3,3],
# [false, '$']]
# do_parse
# end
#
# def next_token
# @q.shift
# end
class_eval <<~RUBY, __FILE__, __LINE__ + 1
def do_parse
#{Racc_Main_Parsing_Routine}(_racc_setup(), false)
end
RUBY
# The method to fetch next token.
# If you use #do_parse method, you must implement #next_token.
#
# The format of return value is [TOKEN_SYMBOL, VALUE].
# +token-symbol+ is represented by Ruby's symbol by default, e.g. :IDENT
# for 'IDENT'. ";" (String) for ';'.
#
# The final symbol (End of file) must be false.
def next_token
raise NotImplementedError, "#{self.class}\#next_token is not defined"
end
def _racc_do_parse_rb(arg, in_debug)
action_table, action_check, action_default, action_pointer,
_, _, _, _,
_, _, token_table, * = arg
_racc_init_sysvars
tok = act = i = nil
catch(:racc_end_parse) {
while true
if i = action_pointer[@racc_state[-1]]
if @racc_read_next
if @racc_t != 0 # not EOF
tok, @racc_val = next_token()
unless tok # EOF
@racc_t = 0
else
@racc_t = (token_table[tok] or 1) # error token
end
racc_read_token(@racc_t, tok, @racc_val) if @yydebug
@racc_read_next = false
end
end
i += @racc_t
unless i >= 0 and
act = action_table[i] and
action_check[i] == @racc_state[-1]
act = action_default[@racc_state[-1]]
end
else
act = action_default[@racc_state[-1]]
end
while act = _racc_evalact(act, arg)
;
end
end
}
end
# Another entry point for the parser.
# If you use this method, you must implement RECEIVER#METHOD_ID method.
#
# RECEIVER#METHOD_ID is a method to get next token.
# It must 'yield' the token, which format is [TOKEN-SYMBOL, VALUE].
class_eval <<~RUBY, __FILE__, __LINE__ + 1
def yyparse(recv, mid)
#{Racc_YY_Parse_Method}(recv, mid, _racc_setup(), false)
end
RUBY
def _racc_yyparse_rb(recv, mid, arg, c_debug)
action_table, action_check, action_default, action_pointer,
_, _, _, _,
_, _, token_table, * = arg
_racc_init_sysvars
catch(:racc_end_parse) {
until i = action_pointer[@racc_state[-1]]
while act = _racc_evalact(action_default[@racc_state[-1]], arg)
;
end
end
recv.__send__(mid) do |tok, val|
unless tok
@racc_t = 0
else
@racc_t = (token_table[tok] or 1) # error token
end
@racc_val = val
@racc_read_next = false
i += @racc_t
unless i >= 0 and
act = action_table[i] and
action_check[i] == @racc_state[-1]
act = action_default[@racc_state[-1]]
end
while act = _racc_evalact(act, arg)
;
end
while !(i = action_pointer[@racc_state[-1]]) ||
! @racc_read_next ||
@racc_t == 0 # $
unless i and i += @racc_t and
i >= 0 and
act = action_table[i] and
action_check[i] == @racc_state[-1]
act = action_default[@racc_state[-1]]
end
while act = _racc_evalact(act, arg)
;
end
end
end
}
end
###
### common
###
def _racc_evalact(act, arg)
action_table, action_check, _, action_pointer,
_, _, _, _,
_, _, _, shift_n,
reduce_n, * = arg
nerr = 0 # tmp
if act > 0 and act < shift_n
#
# shift
#
if @racc_error_status > 0
@racc_error_status -= 1 unless @racc_t <= 1 # error token or EOF
end
@racc_vstack.push @racc_val
@racc_state.push act
@racc_read_next = true
if @yydebug
@racc_tstack.push @racc_t
racc_shift @racc_t, @racc_tstack, @racc_vstack
end
elsif act < 0 and act > -reduce_n
#
# reduce
#
code = catch(:racc_jump) {
@racc_state.push _racc_do_reduce(arg, act)
false
}
if code
case code
when 1 # yyerror
@racc_user_yyerror = true # user_yyerror
return -reduce_n
when 2 # yyaccept
return shift_n
else
raise '[Racc Bug] unknown jump code'
end
end
elsif act == shift_n
#
# accept
#
racc_accept if @yydebug
throw :racc_end_parse, @racc_vstack[0]
elsif act == -reduce_n
#
# error
#
case @racc_error_status
when 0
unless arg[21] # user_yyerror
nerr += 1
on_error @racc_t, @racc_val, @racc_vstack
end
when 3
if @racc_t == 0 # is $
# We're at EOF, and another error occurred immediately after
# attempting auto-recovery
throw :racc_end_parse, nil
end
@racc_read_next = true
end
@racc_user_yyerror = false
@racc_error_status = 3
while true
if i = action_pointer[@racc_state[-1]]
i += 1 # error token
if i >= 0 and
(act = action_table[i]) and
action_check[i] == @racc_state[-1]
break
end
end
throw :racc_end_parse, nil if @racc_state.size <= 1
@racc_state.pop
@racc_vstack.pop
if @yydebug
@racc_tstack.pop
racc_e_pop @racc_state, @racc_tstack, @racc_vstack
end
end
return act
else
raise "[Racc Bug] unknown action #{act.inspect}"
end
racc_next_state(@racc_state[-1], @racc_state) if @yydebug
nil
end
def _racc_do_reduce(arg, act)
_, _, _, _,
goto_table, goto_check, goto_default, goto_pointer,
nt_base, reduce_table, _, _,
_, use_result, * = arg
state = @racc_state
vstack = @racc_vstack
tstack = @racc_tstack
i = act * -3
len = reduce_table[i]
reduce_to = reduce_table[i+1]
method_id = reduce_table[i+2]
void_array = []
tmp_t = tstack[-len, len] if @yydebug
tmp_v = vstack[-len, len]
tstack[-len, len] = void_array if @yydebug
vstack[-len, len] = void_array
state[-len, len] = void_array
# tstack must be updated AFTER method call
if use_result
vstack.push __send__(method_id, tmp_v, vstack, tmp_v[0])
else
vstack.push __send__(method_id, tmp_v, vstack)
end
tstack.push reduce_to
racc_reduce(tmp_t, reduce_to, tstack, vstack) if @yydebug
k1 = reduce_to - nt_base
if i = goto_pointer[k1]
i += state[-1]
if i >= 0 and (curstate = goto_table[i]) and goto_check[i] == k1
return curstate
end
end
goto_default[k1]
end
# This method is called when a parse error is found.
#
# ERROR_TOKEN_ID is an internal ID of token which caused error.
# You can get string representation of this ID by calling
# #token_to_str.
#
# ERROR_VALUE is a value of error token.
#
# value_stack is a stack of symbol values.
# DO NOT MODIFY this object.
#
# This method raises ParseError by default.
#
# If this method returns, parsers enter "error recovering mode".
def on_error(t, val, vstack)
raise ParseError, sprintf("parse error on value %s (%s)",
val.inspect, token_to_str(t) || '?')
end
# Enter error recovering mode.
# This method does not call #on_error.
def yyerror
throw :racc_jump, 1
end
# Exit parser.
# Return value is +Symbol_Value_Stack[0]+.
def yyaccept
throw :racc_jump, 2
end
# Leave error recovering mode.
def yyerrok
@racc_error_status = 0
end
# For debugging output
def racc_read_token(t, tok, val)
@racc_debug_out.print 'read '
@racc_debug_out.print tok.inspect, '(', racc_token2str(t), ') '
@racc_debug_out.puts val.inspect
@racc_debug_out.puts
end
def racc_shift(tok, tstack, vstack)
@racc_debug_out.puts "shift #{racc_token2str tok}"
racc_print_stacks tstack, vstack
@racc_debug_out.puts
end
def racc_reduce(toks, sim, tstack, vstack)
out = @racc_debug_out
out.print 'reduce '
if toks.empty?
out.print ' <none>'
else
toks.each {|t| out.print ' ', racc_token2str(t) }
end
out.puts " --> #{racc_token2str(sim)}"
racc_print_stacks tstack, vstack
@racc_debug_out.puts
end
def racc_accept
@racc_debug_out.puts 'accept'
@racc_debug_out.puts
end
def racc_e_pop(state, tstack, vstack)
@racc_debug_out.puts 'error recovering mode: pop token'
racc_print_states state
racc_print_stacks tstack, vstack
@racc_debug_out.puts
end
def racc_next_state(curstate, state)
@racc_debug_out.puts "goto #{curstate}"
racc_print_states state
@racc_debug_out.puts
end
def racc_print_stacks(t, v)
out = @racc_debug_out
out.print ' ['
t.each_index do |i|
out.print ' (', racc_token2str(t[i]), ' ', v[i].inspect, ')'
end
out.puts ' ]'
end
def racc_print_states(s)
out = @racc_debug_out
out.print ' ['
s.each {|st| out.print ' ', st }
out.puts ' ]'
end
def racc_token2str(tok)
self.class::Racc_token_to_s_table[tok] or
raise "[Racc Bug] can't convert token #{tok} to string"
end
# Convert internal ID of token symbol to the string.
def token_to_str(t)
self.class::Racc_token_to_s_table[t]
end
end
end
end
###### racc/parser.rb end
require 'strscan'
class RDoc::RD
##
# RD format parser for inline markup such as emphasis, links, footnotes, etc.
class InlineParser < Racc::Parser
# :stopdoc:
EM_OPEN = '((*'
EM_OPEN_RE = /\A#{Regexp.quote(EM_OPEN)}/
EM_CLOSE = '*))'
EM_CLOSE_RE = /\A#{Regexp.quote(EM_CLOSE)}/
CODE_OPEN = '(({'
CODE_OPEN_RE = /\A#{Regexp.quote(CODE_OPEN)}/
CODE_CLOSE = '}))'
CODE_CLOSE_RE = /\A#{Regexp.quote(CODE_CLOSE)}/
VAR_OPEN = '((|'
VAR_OPEN_RE = /\A#{Regexp.quote(VAR_OPEN)}/
VAR_CLOSE = '|))'
VAR_CLOSE_RE = /\A#{Regexp.quote(VAR_CLOSE)}/
KBD_OPEN = '((%'
KBD_OPEN_RE = /\A#{Regexp.quote(KBD_OPEN)}/
KBD_CLOSE = '%))'
KBD_CLOSE_RE = /\A#{Regexp.quote(KBD_CLOSE)}/
INDEX_OPEN = '((:'
INDEX_OPEN_RE = /\A#{Regexp.quote(INDEX_OPEN)}/
INDEX_CLOSE = ':))'
INDEX_CLOSE_RE = /\A#{Regexp.quote(INDEX_CLOSE)}/
REF_OPEN = '((<'
REF_OPEN_RE = /\A#{Regexp.quote(REF_OPEN)}/
REF_CLOSE = '>))'
REF_CLOSE_RE = /\A#{Regexp.quote(REF_CLOSE)}/
FOOTNOTE_OPEN = '((-'
FOOTNOTE_OPEN_RE = /\A#{Regexp.quote(FOOTNOTE_OPEN)}/
FOOTNOTE_CLOSE = '-))'
FOOTNOTE_CLOSE_RE = /\A#{Regexp.quote(FOOTNOTE_CLOSE)}/
VERB_OPEN = "(('"
VERB_OPEN_RE = /\A#{Regexp.quote(VERB_OPEN)}/
VERB_CLOSE = "'))"
VERB_CLOSE_RE = /\A#{Regexp.quote(VERB_CLOSE)}/
BAR = "|"
BAR_RE = /\A#{Regexp.quote(BAR)}/
QUOTE = '"'
QUOTE_RE = /\A#{Regexp.quote(QUOTE)}/
SLASH = "/"
SLASH_RE = /\A#{Regexp.quote(SLASH)}/
BACK_SLASH = "\\"
BACK_SLASH_RE = /\A#{Regexp.quote(BACK_SLASH)}/
URL = "URL:"
URL_RE = /\A#{Regexp.quote(URL)}/
other_re_mode = Regexp::EXTENDED
other_re_mode |= Regexp::MULTILINE
OTHER_RE = Regexp.new(
"\\A.+?(?=#{Regexp.quote(EM_OPEN)}|#{Regexp.quote(EM_CLOSE)}|
#{Regexp.quote(CODE_OPEN)}|#{Regexp.quote(CODE_CLOSE)}|
#{Regexp.quote(VAR_OPEN)}|#{Regexp.quote(VAR_CLOSE)}|
#{Regexp.quote(KBD_OPEN)}|#{Regexp.quote(KBD_CLOSE)}|
#{Regexp.quote(INDEX_OPEN)}|#{Regexp.quote(INDEX_CLOSE)}|
#{Regexp.quote(REF_OPEN)}|#{Regexp.quote(REF_CLOSE)}|
#{Regexp.quote(FOOTNOTE_OPEN)}|#{Regexp.quote(FOOTNOTE_CLOSE)}|
#{Regexp.quote(VERB_OPEN)}|#{Regexp.quote(VERB_CLOSE)}|
#{Regexp.quote(BAR)}|
#{Regexp.quote(QUOTE)}|
#{Regexp.quote(SLASH)}|
#{Regexp.quote(BACK_SLASH)}|
#{Regexp.quote(URL)})", other_re_mode)
# :startdoc:
##
# Creates a new parser for inline markup in the rd format. The +block_parser+
# is used to for footnotes and labels in the inline text.
def initialize block_parser
@block_parser = block_parser
end
##
# Parses the +inline+ text from RD format into RDoc format.
def parse inline
@inline = inline
@src = StringScanner.new inline
@pre = "".dup
@yydebug = true
do_parse.to_s
end
##
# Returns the next token from the inline text
def next_token
return [false, false] if @src.eos?
# p @src.rest if @yydebug
if ret = @src.scan(EM_OPEN_RE)
@pre << ret
[:EM_OPEN, ret]
elsif ret = @src.scan(EM_CLOSE_RE)
@pre << ret
[:EM_CLOSE, ret]
elsif ret = @src.scan(CODE_OPEN_RE)
@pre << ret
[:CODE_OPEN, ret]
elsif ret = @src.scan(CODE_CLOSE_RE)
@pre << ret
[:CODE_CLOSE, ret]
elsif ret = @src.scan(VAR_OPEN_RE)
@pre << ret
[:VAR_OPEN, ret]
elsif ret = @src.scan(VAR_CLOSE_RE)
@pre << ret
[:VAR_CLOSE, ret]
elsif ret = @src.scan(KBD_OPEN_RE)
@pre << ret
[:KBD_OPEN, ret]
elsif ret = @src.scan(KBD_CLOSE_RE)
@pre << ret
[:KBD_CLOSE, ret]
elsif ret = @src.scan(INDEX_OPEN_RE)
@pre << ret
[:INDEX_OPEN, ret]
elsif ret = @src.scan(INDEX_CLOSE_RE)
@pre << ret
[:INDEX_CLOSE, ret]
elsif ret = @src.scan(REF_OPEN_RE)
@pre << ret
[:REF_OPEN, ret]
elsif ret = @src.scan(REF_CLOSE_RE)
@pre << ret
[:REF_CLOSE, ret]
elsif ret = @src.scan(FOOTNOTE_OPEN_RE)
@pre << ret
[:FOOTNOTE_OPEN, ret]
elsif ret = @src.scan(FOOTNOTE_CLOSE_RE)
@pre << ret
[:FOOTNOTE_CLOSE, ret]
elsif ret = @src.scan(VERB_OPEN_RE)
@pre << ret
[:VERB_OPEN, ret]
elsif ret = @src.scan(VERB_CLOSE_RE)
@pre << ret
[:VERB_CLOSE, ret]
elsif ret = @src.scan(BAR_RE)
@pre << ret
[:BAR, ret]
elsif ret = @src.scan(QUOTE_RE)
@pre << ret
[:QUOTE, ret]
elsif ret = @src.scan(SLASH_RE)
@pre << ret
[:SLASH, ret]
elsif ret = @src.scan(BACK_SLASH_RE)
@pre << ret
[:BACK_SLASH, ret]
elsif ret = @src.scan(URL_RE)
@pre << ret
[:URL, ret]
elsif ret = @src.scan(OTHER_RE)
@pre << ret
[:OTHER, ret]
else
ret = @src.rest
@pre << ret
@src.terminate
[:OTHER, ret]
end
end
##
# Raises a ParseError when invalid formatting is found
def on_error(et, ev, values)
lines_of_rest = @src.rest.lines.to_a.length
prev_words = prev_words_on_error(ev)
at = 4 + prev_words.length
message = <<-MSG
RD syntax error: line #{@block_parser.line_index - lines_of_rest}:
...#{prev_words} #{(ev||'')} #{next_words_on_error()} ...
MSG
message << " " * at + "^" * (ev ? ev.length : 0) + "\n"
raise ParseError, message
end
##
# Returns words before the error
def prev_words_on_error(ev)
pre = @pre
if ev and /#{Regexp.quote(ev)}$/ =~ pre
pre = $`
end
last_line(pre)
end
##
# Returns the last line of +src+
def last_line(src)
if n = src.rindex("\n")
src[(n+1) .. -1]
else
src
end
end
private :last_line
##
# Returns words following an error
def next_words_on_error
if n = @src.rest.index("\n")
@src.rest[0 .. (n-1)]
else
@src.rest
end
end
##
# Creates a new RDoc::RD::Inline for the +rdoc+ markup and the raw +reference+
def inline rdoc, reference = rdoc
RDoc::RD::Inline.new rdoc, reference
end
# :stopdoc:
##### State transition tables begin ###
racc_action_table = [
104, 103, 102, 100, 101, 99, 115, 116, 117, 29,
105, 106, 107, 108, 109, 110, 111, 112, 113, 114,
84, 118, 119, 63, 64, 65, 61, 81, 62, 76,
78, 79, 85, 66, 67, 68, 69, 70, 71, 72,
73, 74, 75, 77, 80, 149, 63, 64, 65, 153,
81, 62, 76, 78, 79, 86, 66, 67, 68, 69,
70, 71, 72, 73, 74, 75, 77, 80, 152, 104,
103, 102, 100, 101, 99, 115, 116, 117, 87, 105,
106, 107, 108, 109, 110, 111, 112, 113, 114, 88,
118, 119, 104, 103, 102, 100, 101, 99, 115, 116,
117, 89, 105, 106, 107, 108, 109, 110, 111, 112,
113, 114, 96, 118, 119, 104, 103, 102, 100, 101,
99, 115, 116, 117, 124, 105, 106, 107, 108, 109,
110, 111, 112, 113, 114, 137, 118, 119, 22, 23,
24, 25, 26, 21, 18, 19, 176, 177, 13, 148,
14, 154, 15, 137, 16, 161, 17, 164, 173, 20,
22, 23, 24, 25, 26, 21, 18, 19, 175, 177,
13, nil, 14, nil, 15, nil, 16, nil, 17, nil,
nil, 20, 22, 23, 24, 25, 26, 21, 18, 19,
nil, nil, 13, nil, 14, nil, 15, nil, 16, nil,
17, nil, nil, 20, 22, 23, 24, 25, 26, 21,
18, 19, nil, nil, 13, nil, 14, nil, 15, nil,
16, nil, 17, nil, nil, 20, 22, 23, 24, 25,
26, 21, 18, 19, nil, nil, 13, nil, 14, nil,
15, nil, 16, nil, 17, nil, nil, 20, 22, 23,
24, 25, 26, 21, 18, 19, nil, nil, 13, nil,
14, nil, 15, nil, 16, nil, 17, nil, nil, 20,
22, 23, 24, 25, 26, 21, 18, 19, nil, nil,
13, nil, 14, nil, 15, nil, 16, nil, 17, 42,
nil, 20, 54, 38, 53, 55, 56, 57, nil, 13,
nil, 14, nil, 15, nil, 16, nil, 17, nil, nil,
20, 22, 23, 24, 25, 26, 21, 18, 19, nil,
nil, 13, nil, 14, nil, 15, nil, 16, nil, 17,
nil, nil, 20, 63, 64, 65, 61, 81, 62, 76,
78, 79, nil, 66, 67, 68, 69, 70, 71, 72,
73, 74, 75, 77, 80, 122, nil, nil, 54, nil,
53, 55, 56, 57, nil, 13, nil, 14, nil, 15,
nil, 16, nil, 17, 145, nil, 20, 54, 133, 53,
55, 56, 57, nil, 13, nil, 14, nil, 15, nil,
16, nil, 17, 145, nil, 20, 54, 133, 53, 55,
56, 57, nil, 13, nil, 14, nil, 15, nil, 16,
nil, 17, 145, nil, 20, 54, 133, 53, 55, 56,
57, nil, 13, nil, 14, nil, 15, nil, 16, nil,
17, 145, nil, 20, 54, 133, 53, 55, 56, 57,
nil, 13, nil, 14, nil, 15, nil, 16, nil, 17,
nil, nil, 20, 135, 136, 54, 133, 53, 55, 56,
57, nil, 13, nil, 14, nil, 15, nil, 16, nil,
17, nil, nil, 20, 135, 136, 54, 133, 53, 55,
56, 57, nil, 13, nil, 14, nil, 15, nil, 16,
nil, 17, nil, nil, 20, 135, 136, 54, 133, 53,
55, 56, 57, nil, 13, nil, 14, nil, 15, nil,
16, nil, 17, 95, nil, 20, 54, 91, 53, 55,
56, 57, 145, nil, nil, 54, 133, 53, 55, 56,
57, 158, nil, nil, 54, nil, 53, 55, 56, 57,
165, 135, 136, 54, 133, 53, 55, 56, 57, 145,
nil, nil, 54, 133, 53, 55, 56, 57, 172, 135,
136, 54, 133, 53, 55, 56, 57, 174, 135, 136,
54, 133, 53, 55, 56, 57, 178, 135, 136, 54,
133, 53, 55, 56, 57, 135, 136, 54, 133, 53,
55, 56, 57, 135, 136, 54, 133, 53, 55, 56,
57, 135, 136, 54, 133, 53, 55, 56, 57, 22,
23, 24, 25, 26, 21 ]
racc_action_check = [
38, 38, 38, 38, 38, 38, 38, 38, 38, 1,
38, 38, 38, 38, 38, 38, 38, 38, 38, 38,
29, 38, 38, 59, 59, 59, 59, 59, 59, 59,
59, 59, 31, 59, 59, 59, 59, 59, 59, 59,
59, 59, 59, 59, 59, 59, 61, 61, 61, 61,
61, 61, 61, 61, 61, 32, 61, 61, 61, 61,
61, 61, 61, 61, 61, 61, 61, 61, 61, 91,
91, 91, 91, 91, 91, 91, 91, 91, 33, 91,
91, 91, 91, 91, 91, 91, 91, 91, 91, 34,
91, 91, 97, 97, 97, 97, 97, 97, 97, 97,
97, 35, 97, 97, 97, 97, 97, 97, 97, 97,
97, 97, 37, 97, 97, 155, 155, 155, 155, 155,
155, 155, 155, 155, 41, 155, 155, 155, 155, 155,
155, 155, 155, 155, 155, 43, 155, 155, 0, 0,
0, 0, 0, 0, 0, 0, 165, 165, 0, 58,
0, 90, 0, 94, 0, 100, 0, 125, 162, 0,
2, 2, 2, 2, 2, 2, 2, 2, 164, 172,
2, nil, 2, nil, 2, nil, 2, nil, 2, nil,
nil, 2, 13, 13, 13, 13, 13, 13, 13, 13,
nil, nil, 13, nil, 13, nil, 13, nil, 13, nil,
13, nil, nil, 13, 14, 14, 14, 14, 14, 14,
14, 14, nil, nil, 14, nil, 14, nil, 14, nil,
14, nil, 14, nil, nil, 14, 15, 15, 15, 15,
15, 15, 15, 15, nil, nil, 15, nil, 15, nil,
15, nil, 15, nil, 15, nil, nil, 15, 16, 16,
16, 16, 16, 16, 16, 16, nil, nil, 16, nil,
16, nil, 16, nil, 16, nil, 16, nil, nil, 16,
17, 17, 17, 17, 17, 17, 17, 17, nil, nil,
17, nil, 17, nil, 17, nil, 17, nil, 17, 18,
nil, 17, 18, 18, 18, 18, 18, 18, nil, 18,
nil, 18, nil, 18, nil, 18, nil, 18, nil, nil,
18, 19, 19, 19, 19, 19, 19, 19, 19, nil,
nil, 19, nil, 19, nil, 19, nil, 19, nil, 19,
nil, nil, 19, 20, 20, 20, 20, 20, 20, 20,
20, 20, nil, 20, 20, 20, 20, 20, 20, 20,
20, 20, 20, 20, 20, 39, nil, nil, 39, nil,
39, 39, 39, 39, nil, 39, nil, 39, nil, 39,
nil, 39, nil, 39, 44, nil, 39, 44, 44, 44,
44, 44, 44, nil, 44, nil, 44, nil, 44, nil,
44, nil, 44, 45, nil, 44, 45, 45, 45, 45,
45, 45, nil, 45, nil, 45, nil, 45, nil, 45,
nil, 45, 138, nil, 45, 138, 138, 138, 138, 138,
138, nil, 138, nil, 138, nil, 138, nil, 138, nil,
138, 146, nil, 138, 146, 146, 146, 146, 146, 146,
nil, 146, nil, 146, nil, 146, nil, 146, nil, 146,
nil, nil, 146, 42, 42, 42, 42, 42, 42, 42,
42, nil, 42, nil, 42, nil, 42, nil, 42, nil,
42, nil, nil, 42, 122, 122, 122, 122, 122, 122,
122, 122, nil, 122, nil, 122, nil, 122, nil, 122,
nil, 122, nil, nil, 122, 127, 127, 127, 127, 127,
127, 127, 127, nil, 127, nil, 127, nil, 127, nil,
127, nil, 127, 36, nil, 127, 36, 36, 36, 36,
36, 36, 52, nil, nil, 52, 52, 52, 52, 52,
52, 92, nil, nil, 92, nil, 92, 92, 92, 92,
126, 126, 126, 126, 126, 126, 126, 126, 126, 142,
nil, nil, 142, 142, 142, 142, 142, 142, 159, 159,
159, 159, 159, 159, 159, 159, 159, 163, 163, 163,
163, 163, 163, 163, 163, 163, 171, 171, 171, 171,
171, 171, 171, 171, 171, 95, 95, 95, 95, 95,
95, 95, 95, 158, 158, 158, 158, 158, 158, 158,
158, 168, 168, 168, 168, 168, 168, 168, 168, 27,
27, 27, 27, 27, 27 ]
racc_action_pointer = [
135, 9, 157, nil, nil, nil, nil, nil, nil, nil,
nil, nil, nil, 179, 201, 223, 245, 267, 286, 308,
330, nil, nil, nil, nil, nil, nil, 606, nil, 20,
nil, 18, 39, 60, 69, 79, 510, 89, -3, 352,
nil, 120, 449, 130, 371, 390, nil, nil, nil, nil,
nil, nil, 519, nil, nil, nil, nil, nil, 138, 20,
nil, 43, nil, nil, nil, nil, nil, nil, nil, nil,
nil, nil, nil, nil, nil, nil, nil, nil, nil, nil,
nil, nil, nil, nil, nil, nil, nil, nil, nil, nil,
128, 66, 528, nil, 148, 581, nil, 89, nil, nil,
149, nil, nil, nil, nil, nil, nil, nil, nil, nil,
nil, nil, nil, nil, nil, nil, nil, nil, nil, nil,
nil, nil, 470, nil, nil, 154, 537, 491, nil, nil,
nil, nil, nil, nil, nil, nil, nil, nil, 409, nil,
nil, nil, 546, nil, nil, nil, 428, nil, nil, nil,
nil, nil, nil, nil, nil, 112, nil, nil, 589, 555,
nil, nil, 155, 564, 164, 142, nil, nil, 597, nil,
nil, 573, 164, nil, nil, nil, nil, nil, nil ]
racc_action_default = [
-138, -138, -1, -3, -4, -5, -6, -7, -8, -9,
-10, -11, -12, -138, -138, -138, -138, -138, -138, -138,
-138, -103, -104, -105, -106, -107, -108, -111, -110, -138,
-2, -138, -138, -138, -138, -138, -138, -138, -138, -27,
-26, -35, -138, -58, -41, -40, -47, -48, -49, -50,
-51, -52, -63, -66, -67, -68, -69, -70, -138, -138,
-112, -138, -116, -117, -118, -119, -120, -121, -122, -123,
-124, -125, -126, -127, -128, -129, -130, -131, -132, -133,
-134, -135, -137, -109, 179, -13, -14, -15, -16, -17,
-138, -138, -23, -22, -33, -138, -19, -24, -79, -80,
-138, -82, -83, -84, -85, -86, -87, -88, -89, -90,
-91, -92, -93, -94, -95, -96, -97, -98, -99, -100,
-25, -35, -138, -58, -28, -138, -59, -42, -46, -55,
-56, -65, -71, -72, -75, -76, -77, -31, -38, -44,
-53, -54, -57, -61, -73, -74, -39, -62, -101, -102,
-136, -113, -114, -115, -18, -20, -21, -33, -138, -138,
-78, -81, -138, -59, -36, -37, -64, -45, -59, -43,
-60, -138, -34, -36, -37, -29, -30, -32, -34 ]
racc_goto_table = [
126, 44, 125, 43, 144, 144, 160, 93, 97, 52,
166, 82, 144, 40, 41, 39, 138, 146, 169, 30,
36, 94, 44, 1, 123, 129, 169, 52, 90, 37,
52, 167, 147, 92, 120, 121, 31, 32, 33, 34,
35, 170, 58, 166, 59, 83, 170, 166, 151, nil,
150, nil, 166, 159, 4, 166, 4, nil, nil, nil,
nil, 155, nil, 156, 160, nil, nil, 4, 4, 4,
4, 4, nil, 4, 5, nil, 5, 157, nil, nil,
163, nil, 162, 52, nil, 168, nil, 5, 5, 5,
5, 5, nil, 5, nil, nil, nil, nil, 144, nil,
nil, nil, 144, nil, nil, 129, 144, 144, nil, 6,
129, 6, nil, nil, nil, nil, 171, 7, nil, 7,
nil, nil, 6, 6, 6, 6, 6, 8, 6, 8,
7, 7, 7, 7, 7, 11, 7, 11, nil, nil,
8, 8, 8, 8, 8, nil, 8, nil, 11, 11,
11, 11, 11, nil, 11 ]
racc_goto_check = [
22, 24, 21, 23, 36, 36, 37, 18, 16, 34,
35, 41, 36, 19, 20, 17, 25, 25, 28, 3,
13, 23, 24, 1, 23, 24, 28, 34, 14, 15,
34, 29, 32, 17, 19, 20, 1, 1, 1, 1,
1, 33, 1, 35, 38, 39, 33, 35, 42, nil,
41, nil, 35, 22, 4, 35, 4, nil, nil, nil,
nil, 16, nil, 18, 37, nil, nil, 4, 4, 4,
4, 4, nil, 4, 5, nil, 5, 23, nil, nil,
22, nil, 21, 34, nil, 22, nil, 5, 5, 5,
5, 5, nil, 5, nil, nil, nil, nil, 36, nil,
nil, nil, 36, nil, nil, 24, 36, 36, nil, 6,
24, 6, nil, nil, nil, nil, 22, 7, nil, 7,
nil, nil, 6, 6, 6, 6, 6, 8, 6, 8,
7, 7, 7, 7, 7, 11, 7, 11, nil, nil,
8, 8, 8, 8, 8, nil, 8, nil, 11, 11,
11, 11, 11, nil, 11 ]
racc_goto_pointer = [
nil, 23, nil, 17, 54, 74, 109, 117, 127, nil,
nil, 135, nil, 2, -8, 11, -30, -3, -29, -5,
-4, -40, -42, -15, -17, -28, nil, nil, -120, -96,
nil, nil, -20, -101, -9, -116, -40, -91, 24, 18,
nil, -9, -13 ]
racc_goto_default = [
nil, nil, 2, 3, 46, 47, 48, 49, 50, 9,
10, 51, 12, nil, nil, nil, nil, nil, nil, nil,
nil, nil, nil, nil, 140, nil, 45, 127, 139, 128,
141, 130, 142, 143, 132, 131, 134, 98, nil, 28,
27, nil, 60 ]
racc_reduce_table = [
0, 0, :racc_error,
1, 27, :_reduce_none,
2, 28, :_reduce_2,
1, 28, :_reduce_3,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
1, 29, :_reduce_none,
3, 30, :_reduce_13,
3, 31, :_reduce_14,
3, 32, :_reduce_15,
3, 33, :_reduce_16,
3, 34, :_reduce_17,
4, 35, :_reduce_18,
3, 35, :_reduce_19,
2, 40, :_reduce_20,
2, 40, :_reduce_21,
1, 40, :_reduce_22,
1, 40, :_reduce_23,
2, 41, :_reduce_24,
2, 41, :_reduce_25,
1, 41, :_reduce_26,
1, 41, :_reduce_27,
2, 39, :_reduce_none,
4, 39, :_reduce_29,
4, 39, :_reduce_30,
2, 43, :_reduce_31,
4, 43, :_reduce_32,
1, 44, :_reduce_33,
3, 44, :_reduce_34,
1, 45, :_reduce_none,
3, 45, :_reduce_36,
3, 45, :_reduce_37,
2, 46, :_reduce_38,
2, 46, :_reduce_39,
1, 46, :_reduce_40,
1, 46, :_reduce_41,
1, 47, :_reduce_none,
2, 51, :_reduce_43,
1, 51, :_reduce_44,
2, 53, :_reduce_45,
1, 53, :_reduce_46,
1, 50, :_reduce_none,
1, 50, :_reduce_none,
1, 50, :_reduce_none,
1, 50, :_reduce_none,
1, 50, :_reduce_none,
1, 50, :_reduce_none,
1, 54, :_reduce_none,
1, 54, :_reduce_none,
1, 55, :_reduce_none,
1, 55, :_reduce_none,
1, 56, :_reduce_57,
1, 52, :_reduce_58,
1, 57, :_reduce_59,
2, 58, :_reduce_60,
1, 58, :_reduce_none,
2, 49, :_reduce_62,
1, 49, :_reduce_none,
2, 48, :_reduce_64,
1, 48, :_reduce_none,
1, 60, :_reduce_none,
1, 60, :_reduce_none,
1, 60, :_reduce_none,
1, 60, :_reduce_none,
1, 60, :_reduce_none,
1, 62, :_reduce_none,
1, 62, :_reduce_none,
1, 59, :_reduce_none,
1, 59, :_reduce_none,
1, 61, :_reduce_none,
1, 61, :_reduce_none,
1, 61, :_reduce_none,
2, 42, :_reduce_78,
1, 42, :_reduce_none,
1, 63, :_reduce_none,
2, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
1, 63, :_reduce_none,
3, 36, :_reduce_101,
3, 37, :_reduce_102,
1, 65, :_reduce_none,
1, 65, :_reduce_none,
1, 65, :_reduce_none,
1, 65, :_reduce_none,
1, 65, :_reduce_none,
1, 65, :_reduce_none,
2, 66, :_reduce_109,
1, 66, :_reduce_none,
1, 38, :_reduce_111,
1, 67, :_reduce_none,
2, 67, :_reduce_113,
2, 67, :_reduce_114,
2, 67, :_reduce_115,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
1, 68, :_reduce_none,
2, 64, :_reduce_136,
1, 64, :_reduce_none ]
racc_reduce_n = 138
racc_shift_n = 179
racc_token_table = {
false => 0,
:error => 1,
:EX_LOW => 2,
:QUOTE => 3,
:BAR => 4,
:SLASH => 5,
:BACK_SLASH => 6,
:URL => 7,
:OTHER => 8,
:REF_OPEN => 9,
:FOOTNOTE_OPEN => 10,
:FOOTNOTE_CLOSE => 11,
:EX_HIGH => 12,
:EM_OPEN => 13,
:EM_CLOSE => 14,
:CODE_OPEN => 15,
:CODE_CLOSE => 16,
:VAR_OPEN => 17,
:VAR_CLOSE => 18,
:KBD_OPEN => 19,
:KBD_CLOSE => 20,
:INDEX_OPEN => 21,
:INDEX_CLOSE => 22,
:REF_CLOSE => 23,
:VERB_OPEN => 24,
:VERB_CLOSE => 25 }
racc_nt_base = 26
racc_use_result_var = true
Racc_arg = [
racc_action_table,
racc_action_check,
racc_action_default,
racc_action_pointer,
racc_goto_table,
racc_goto_check,
racc_goto_default,
racc_goto_pointer,
racc_nt_base,
racc_reduce_table,
racc_token_table,
racc_shift_n,
racc_reduce_n,
racc_use_result_var ]
Ractor.make_shareable(Racc_arg) if defined?(Ractor)
Racc_token_to_s_table = [
"$end",
"error",
"EX_LOW",
"QUOTE",
"BAR",
"SLASH",
"BACK_SLASH",
"URL",
"OTHER",
"REF_OPEN",
"FOOTNOTE_OPEN",
"FOOTNOTE_CLOSE",
"EX_HIGH",
"EM_OPEN",
"EM_CLOSE",
"CODE_OPEN",
"CODE_CLOSE",
"VAR_OPEN",
"VAR_CLOSE",
"KBD_OPEN",
"KBD_CLOSE",
"INDEX_OPEN",
"INDEX_CLOSE",
"REF_CLOSE",
"VERB_OPEN",
"VERB_CLOSE",
"$start",
"content",
"elements",
"element",
"emphasis",
"code",
"var",
"keyboard",
"index",
"reference",
"footnote",
"verb",
"normal_str_ele",
"substitute",
"ref_label",
"ref_label2",
"ref_url_strings",
"filename",
"element_label",
"element_label2",
"ref_subst_content",
"ref_subst_content_q",
"ref_subst_strings_q",
"ref_subst_strings_first",
"ref_subst_ele2",
"ref_subst_eles",
"ref_subst_str_ele_first",
"ref_subst_eles_q",
"ref_subst_ele",
"ref_subst_ele_q",
"ref_subst_str_ele",
"ref_subst_str_ele_q",
"ref_subst_strings",
"ref_subst_string3",
"ref_subst_string",
"ref_subst_string_q",
"ref_subst_string2",
"ref_url_string",
"verb_strings",
"normal_string",
"normal_strings",
"verb_string",
"verb_normal_string" ]
Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
Racc_debug_parser = false
##### State transition tables end #####
# reduce 0 omitted
# reduce 1 omitted
def _reduce_2(val, _values, result)
result.append val[1]
result
end
def _reduce_3(val, _values, result)
result = val[0]
result
end
# reduce 4 omitted
# reduce 5 omitted
# reduce 6 omitted
# reduce 7 omitted
# reduce 8 omitted
# reduce 9 omitted
# reduce 10 omitted
# reduce 11 omitted
# reduce 12 omitted
def _reduce_13(val, _values, result)
content = val[1]
result = inline "<em>#{content}</em>", content
result
end
def _reduce_14(val, _values, result)
content = val[1]
result = inline "<code>#{content}</code>", content
result
end
def _reduce_15(val, _values, result)
content = val[1]
result = inline "+#{content}+", content
result
end
def _reduce_16(val, _values, result)
content = val[1]
result = inline "<tt>#{content}</tt>", content
result
end
def _reduce_17(val, _values, result)
label = val[1]
@block_parser.add_label label.reference
result = "<span id=\"label-#{label}\">#{label}</span>"
result
end
def _reduce_18(val, _values, result)
result = "{#{val[1]}}[#{val[2].join}]"
result
end
def _reduce_19(val, _values, result)
scheme, inline = val[1]
result = "{#{inline}}[#{scheme}#{inline.reference}]"
result
end
def _reduce_20(val, _values, result)
result = [nil, inline(val[1])]
result
end
def _reduce_21(val, _values, result)
result = [
'rdoc-label:',
inline("#{val[0].reference}/#{val[1].reference}")
]
result
end
def _reduce_22(val, _values, result)
result = ['rdoc-label:', val[0].reference]
result
end
def _reduce_23(val, _values, result)
result = ['rdoc-label:', "#{val[0].reference}/"]
result
end
def _reduce_24(val, _values, result)
result = [nil, inline(val[1])]
result
end
def _reduce_25(val, _values, result)
result = [
'rdoc-label:',
inline("#{val[0].reference}/#{val[1].reference}")
]
result
end
def _reduce_26(val, _values, result)
result = ['rdoc-label:', val[0]]
result
end
def _reduce_27(val, _values, result)
ref = val[0].reference
result = ['rdoc-label:', inline(ref, "#{ref}/")]
result
end
# reduce 28 omitted
def _reduce_29(val, _values, result)
result = val[1]
result
end
def _reduce_30(val, _values, result)
result = val[1]
result
end
def _reduce_31(val, _values, result)
result = inline val[0]
result
end
def _reduce_32(val, _values, result)
result = inline "\"#{val[1]}\""
result
end
def _reduce_33(val, _values, result)
result = inline val[0]
result
end
def _reduce_34(val, _values, result)
result = inline "\"#{val[1]}\""
result
end
# reduce 35 omitted
def _reduce_36(val, _values, result)
result = val[1]
result
end
def _reduce_37(val, _values, result)
result = inline val[1]
result
end
def _reduce_38(val, _values, result)
result = val[0].append val[1]
result
end
def _reduce_39(val, _values, result)
result = val[0].append val[1]
result
end
def _reduce_40(val, _values, result)
result = val[0]
result
end
def _reduce_41(val, _values, result)
result = inline val[0]
result
end
# reduce 42 omitted
def _reduce_43(val, _values, result)
result = val[0].append val[1]
result
end
def _reduce_44(val, _values, result)
result = inline val[0]
result
end
def _reduce_45(val, _values, result)
result = val[0].append val[1]
result
end
def _reduce_46(val, _values, result)
result = val[0]
result
end
# reduce 47 omitted
# reduce 48 omitted
# reduce 49 omitted
# reduce 50 omitted
# reduce 51 omitted
# reduce 52 omitted
# reduce 53 omitted
# reduce 54 omitted
# reduce 55 omitted
# reduce 56 omitted
def _reduce_57(val, _values, result)
result = val[0]
result
end
def _reduce_58(val, _values, result)
result = inline val[0]
result
end
def _reduce_59(val, _values, result)
result = inline val[0]
result
end
def _reduce_60(val, _values, result)
result << val[1]
result
end
# reduce 61 omitted
def _reduce_62(val, _values, result)
result << val[1]
result
end
# reduce 63 omitted
def _reduce_64(val, _values, result)
result << val[1]
result
end
# reduce 65 omitted
# reduce 66 omitted
# reduce 67 omitted
# reduce 68 omitted
# reduce 69 omitted
# reduce 70 omitted
# reduce 71 omitted
# reduce 72 omitted
# reduce 73 omitted
# reduce 74 omitted
# reduce 75 omitted
# reduce 76 omitted
# reduce 77 omitted
def _reduce_78(val, _values, result)
result << val[1]
result
end
# reduce 79 omitted
# reduce 80 omitted
# reduce 81 omitted
# reduce 82 omitted
# reduce 83 omitted
# reduce 84 omitted
# reduce 85 omitted
# reduce 86 omitted
# reduce 87 omitted
# reduce 88 omitted
# reduce 89 omitted
# reduce 90 omitted
# reduce 91 omitted
# reduce 92 omitted
# reduce 93 omitted
# reduce 94 omitted
# reduce 95 omitted
# reduce 96 omitted
# reduce 97 omitted
# reduce 98 omitted
# reduce 99 omitted
# reduce 100 omitted
def _reduce_101(val, _values, result)
index = @block_parser.add_footnote val[1].rdoc
result = "{*#{index}}[rdoc-label:foottext-#{index}:footmark-#{index}]"
result
end
def _reduce_102(val, _values, result)
result = inline "<tt>#{val[1]}</tt>", val[1]
result
end
# reduce 103 omitted
# reduce 104 omitted
# reduce 105 omitted
# reduce 106 omitted
# reduce 107 omitted
# reduce 108 omitted
def _reduce_109(val, _values, result)
result << val[1]
result
end
# reduce 110 omitted
def _reduce_111(val, _values, result)
result = inline val[0]
result
end
# reduce 112 omitted
def _reduce_113(val, _values, result)
result = val[1]
result
end
def _reduce_114(val, _values, result)
result = val[1]
result
end
def _reduce_115(val, _values, result)
result = val[1]
result
end
# reduce 116 omitted
# reduce 117 omitted
# reduce 118 omitted
# reduce 119 omitted
# reduce 120 omitted
# reduce 121 omitted
# reduce 122 omitted
# reduce 123 omitted
# reduce 124 omitted
# reduce 125 omitted
# reduce 126 omitted
# reduce 127 omitted
# reduce 128 omitted
# reduce 129 omitted
# reduce 130 omitted
# reduce 131 omitted
# reduce 132 omitted
# reduce 133 omitted
# reduce 134 omitted
# reduce 135 omitted
def _reduce_136(val, _values, result)
result << val[1]
result
end
# reduce 137 omitted
def _reduce_none(val, _values, result)
val[0]
end
end # class InlineParser
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/rd/block_parser.rb 0000644 00000121401 15173517747 0016407 0 ustar 00 # frozen_string_literal: true
#
# DO NOT MODIFY!!!!
# This file is automatically generated by Racc 1.7.3
# from Racc grammar file "block_parser.ry".
#
###### racc/parser.rb begin
unless $".find {|p| p.end_with?('/racc/parser.rb')}
$".push "#{__dir__}/racc/parser.rb"
#--
# Copyright (c) 1999-2006 Minero Aoki
#
# This program is free software.
# You can distribute/modify this program under the same terms of ruby.
#
# As a special exception, when this code is copied by Racc
# into a Racc output file, you may use that output file
# without restriction.
#++
unless $".find {|p| p.end_with?('/racc/info.rb')}
$".push "#{__dir__}/racc/info.rb"
module Racc
VERSION = '1.7.3'
Version = VERSION
Copyright = 'Copyright (c) 1999-2006 Minero Aoki'
end
end
unless defined?(NotImplementedError)
NotImplementedError = NotImplementError # :nodoc:
end
module Racc
class ParseError < StandardError; end
end
unless defined?(::ParseError)
ParseError = Racc::ParseError # :nodoc:
end
# Racc is a LALR(1) parser generator.
# It is written in Ruby itself, and generates Ruby programs.
#
# == Command-line Reference
#
# racc [-o<var>filename</var>] [--output-file=<var>filename</var>]
# [-e<var>rubypath</var>] [--executable=<var>rubypath</var>]
# [-v] [--verbose]
# [-O<var>filename</var>] [--log-file=<var>filename</var>]
# [-g] [--debug]
# [-E] [--embedded]
# [-l] [--no-line-convert]
# [-c] [--line-convert-all]
# [-a] [--no-omit-actions]
# [-C] [--check-only]
# [-S] [--output-status]
# [--version] [--copyright] [--help] <var>grammarfile</var>
#
# [+grammarfile+]
# Racc grammar file. Any extension is permitted.
# [-o+outfile+, --output-file=+outfile+]
# A filename for output. default is <+filename+>.tab.rb
# [-O+filename+, --log-file=+filename+]
# Place logging output in file +filename+.
# Default log file name is <+filename+>.output.
# [-e+rubypath+, --executable=+rubypath+]
# output executable file(mode 755). where +path+ is the Ruby interpreter.
# [-v, --verbose]
# verbose mode. create +filename+.output file, like yacc's y.output file.
# [-g, --debug]
# add debug code to parser class. To display debugging information,
# use this '-g' option and set @yydebug true in parser class.
# [-E, --embedded]
# Output parser which doesn't need runtime files (racc/parser.rb).
# [-F, --frozen]
# Output parser which declares frozen_string_literals: true
# [-C, --check-only]
# Check syntax of racc grammar file and quit.
# [-S, --output-status]
# Print messages time to time while compiling.
# [-l, --no-line-convert]
# turns off line number converting.
# [-c, --line-convert-all]
# Convert line number of actions, inner, header and footer.
# [-a, --no-omit-actions]
# Call all actions, even if an action is empty.
# [--version]
# print Racc version and quit.
# [--copyright]
# Print copyright and quit.
# [--help]
# Print usage and quit.
#
# == Generating Parser Using Racc
#
# To compile Racc grammar file, simply type:
#
# $ racc parse.y
#
# This creates Ruby script file "parse.tab.y". The -o option can change the output filename.
#
# == Writing A Racc Grammar File
#
# If you want your own parser, you have to write a grammar file.
# A grammar file contains the name of your parser class, grammar for the parser,
# user code, and anything else.
# When writing a grammar file, yacc's knowledge is helpful.
# If you have not used yacc before, Racc is not too difficult.
#
# Here's an example Racc grammar file.
#
# class Calcparser
# rule
# target: exp { print val[0] }
#
# exp: exp '+' exp
# | exp '*' exp
# | '(' exp ')'
# | NUMBER
# end
#
# Racc grammar files resemble yacc files.
# But (of course), this is Ruby code.
# yacc's $$ is the 'result', $0, $1... is
# an array called 'val', and $-1, $-2... is an array called '_values'.
#
# See the {Grammar File Reference}[rdoc-ref:lib/racc/rdoc/grammar.en.rdoc] for
# more information on grammar files.
#
# == Parser
#
# Then you must prepare the parse entry method. There are two types of
# parse methods in Racc, Racc::Parser#do_parse and Racc::Parser#yyparse
#
# Racc::Parser#do_parse is simple.
#
# It's yyparse() of yacc, and Racc::Parser#next_token is yylex().
# This method must returns an array like [TOKENSYMBOL, ITS_VALUE].
# EOF is [false, false].
# (TOKENSYMBOL is a Ruby symbol (taken from String#intern) by default.
# If you want to change this, see the grammar reference.
#
# Racc::Parser#yyparse is little complicated, but useful.
# It does not use Racc::Parser#next_token, instead it gets tokens from any iterator.
#
# For example, <code>yyparse(obj, :scan)</code> causes
# calling +obj#scan+, and you can return tokens by yielding them from +obj#scan+.
#
# == Debugging
#
# When debugging, "-v" or/and the "-g" option is helpful.
#
# "-v" creates verbose log file (.output).
# "-g" creates a "Verbose Parser".
# Verbose Parser prints the internal status when parsing.
# But it's _not_ automatic.
# You must use -g option and set +@yydebug+ to +true+ in order to get output.
# -g option only creates the verbose parser.
#
# === Racc reported syntax error.
#
# Isn't there too many "end"?
# grammar of racc file is changed in v0.10.
#
# Racc does not use '%' mark, while yacc uses huge number of '%' marks..
#
# === Racc reported "XXXX conflicts".
#
# Try "racc -v xxxx.y".
# It causes producing racc's internal log file, xxxx.output.
#
# === Generated parsers does not work correctly
#
# Try "racc -g xxxx.y".
# This command let racc generate "debugging parser".
# Then set @yydebug=true in your parser.
# It produces a working log of your parser.
#
# == Re-distributing Racc runtime
#
# A parser, which is created by Racc, requires the Racc runtime module;
# racc/parser.rb.
#
# Ruby 1.8.x comes with Racc runtime module,
# you need NOT distribute Racc runtime files.
#
# If you want to include the Racc runtime module with your parser.
# This can be done by using '-E' option:
#
# $ racc -E -omyparser.rb myparser.y
#
# This command creates myparser.rb which `includes' Racc runtime.
# Only you must do is to distribute your parser file (myparser.rb).
#
# Note: parser.rb is ruby license, but your parser is not.
# Your own parser is completely yours.
module Racc
unless defined?(Racc_No_Extensions)
Racc_No_Extensions = false # :nodoc:
end
class Parser
Racc_Runtime_Version = ::Racc::VERSION
Racc_Runtime_Core_Version_R = ::Racc::VERSION
begin
if Object.const_defined?(:RUBY_ENGINE) and RUBY_ENGINE == 'jruby'
require 'jruby'
require 'racc/cparse-jruby.jar'
com.headius.racc.Cparse.new.load(JRuby.runtime, false)
else
require 'racc/cparse'
end
unless new.respond_to?(:_racc_do_parse_c, true)
raise LoadError, 'old cparse.so'
end
if Racc_No_Extensions
raise LoadError, 'selecting ruby version of racc runtime core'
end
Racc_Main_Parsing_Routine = :_racc_do_parse_c # :nodoc:
Racc_YY_Parse_Method = :_racc_yyparse_c # :nodoc:
Racc_Runtime_Core_Version = Racc_Runtime_Core_Version_C # :nodoc:
Racc_Runtime_Type = 'c' # :nodoc:
rescue LoadError
Racc_Main_Parsing_Routine = :_racc_do_parse_rb
Racc_YY_Parse_Method = :_racc_yyparse_rb
Racc_Runtime_Core_Version = Racc_Runtime_Core_Version_R
Racc_Runtime_Type = 'ruby'
end
def Parser.racc_runtime_type # :nodoc:
Racc_Runtime_Type
end
def _racc_setup
@yydebug = false unless self.class::Racc_debug_parser
@yydebug = false unless defined?(@yydebug)
if @yydebug
@racc_debug_out = $stderr unless defined?(@racc_debug_out)
@racc_debug_out ||= $stderr
end
arg = self.class::Racc_arg
arg[13] = true if arg.size < 14
arg
end
def _racc_init_sysvars
@racc_state = [0]
@racc_tstack = []
@racc_vstack = []
@racc_t = nil
@racc_val = nil
@racc_read_next = true
@racc_user_yyerror = false
@racc_error_status = 0
end
# The entry point of the parser. This method is used with #next_token.
# If Racc wants to get token (and its value), calls next_token.
#
# Example:
# def parse
# @q = [[1,1],
# [2,2],
# [3,3],
# [false, '$']]
# do_parse
# end
#
# def next_token
# @q.shift
# end
class_eval <<~RUBY, __FILE__, __LINE__ + 1
def do_parse
#{Racc_Main_Parsing_Routine}(_racc_setup(), false)
end
RUBY
# The method to fetch next token.
# If you use #do_parse method, you must implement #next_token.
#
# The format of return value is [TOKEN_SYMBOL, VALUE].
# +token-symbol+ is represented by Ruby's symbol by default, e.g. :IDENT
# for 'IDENT'. ";" (String) for ';'.
#
# The final symbol (End of file) must be false.
def next_token
raise NotImplementedError, "#{self.class}\#next_token is not defined"
end
def _racc_do_parse_rb(arg, in_debug)
action_table, action_check, action_default, action_pointer,
_, _, _, _,
_, _, token_table, * = arg
_racc_init_sysvars
tok = act = i = nil
catch(:racc_end_parse) {
while true
if i = action_pointer[@racc_state[-1]]
if @racc_read_next
if @racc_t != 0 # not EOF
tok, @racc_val = next_token()
unless tok # EOF
@racc_t = 0
else
@racc_t = (token_table[tok] or 1) # error token
end
racc_read_token(@racc_t, tok, @racc_val) if @yydebug
@racc_read_next = false
end
end
i += @racc_t
unless i >= 0 and
act = action_table[i] and
action_check[i] == @racc_state[-1]
act = action_default[@racc_state[-1]]
end
else
act = action_default[@racc_state[-1]]
end
while act = _racc_evalact(act, arg)
;
end
end
}
end
# Another entry point for the parser.
# If you use this method, you must implement RECEIVER#METHOD_ID method.
#
# RECEIVER#METHOD_ID is a method to get next token.
# It must 'yield' the token, which format is [TOKEN-SYMBOL, VALUE].
class_eval <<~RUBY, __FILE__, __LINE__ + 1
def yyparse(recv, mid)
#{Racc_YY_Parse_Method}(recv, mid, _racc_setup(), false)
end
RUBY
def _racc_yyparse_rb(recv, mid, arg, c_debug)
action_table, action_check, action_default, action_pointer,
_, _, _, _,
_, _, token_table, * = arg
_racc_init_sysvars
catch(:racc_end_parse) {
until i = action_pointer[@racc_state[-1]]
while act = _racc_evalact(action_default[@racc_state[-1]], arg)
;
end
end
recv.__send__(mid) do |tok, val|
unless tok
@racc_t = 0
else
@racc_t = (token_table[tok] or 1) # error token
end
@racc_val = val
@racc_read_next = false
i += @racc_t
unless i >= 0 and
act = action_table[i] and
action_check[i] == @racc_state[-1]
act = action_default[@racc_state[-1]]
end
while act = _racc_evalact(act, arg)
;
end
while !(i = action_pointer[@racc_state[-1]]) ||
! @racc_read_next ||
@racc_t == 0 # $
unless i and i += @racc_t and
i >= 0 and
act = action_table[i] and
action_check[i] == @racc_state[-1]
act = action_default[@racc_state[-1]]
end
while act = _racc_evalact(act, arg)
;
end
end
end
}
end
###
### common
###
def _racc_evalact(act, arg)
action_table, action_check, _, action_pointer,
_, _, _, _,
_, _, _, shift_n,
reduce_n, * = arg
nerr = 0 # tmp
if act > 0 and act < shift_n
#
# shift
#
if @racc_error_status > 0
@racc_error_status -= 1 unless @racc_t <= 1 # error token or EOF
end
@racc_vstack.push @racc_val
@racc_state.push act
@racc_read_next = true
if @yydebug
@racc_tstack.push @racc_t
racc_shift @racc_t, @racc_tstack, @racc_vstack
end
elsif act < 0 and act > -reduce_n
#
# reduce
#
code = catch(:racc_jump) {
@racc_state.push _racc_do_reduce(arg, act)
false
}
if code
case code
when 1 # yyerror
@racc_user_yyerror = true # user_yyerror
return -reduce_n
when 2 # yyaccept
return shift_n
else
raise '[Racc Bug] unknown jump code'
end
end
elsif act == shift_n
#
# accept
#
racc_accept if @yydebug
throw :racc_end_parse, @racc_vstack[0]
elsif act == -reduce_n
#
# error
#
case @racc_error_status
when 0
unless arg[21] # user_yyerror
nerr += 1
on_error @racc_t, @racc_val, @racc_vstack
end
when 3
if @racc_t == 0 # is $
# We're at EOF, and another error occurred immediately after
# attempting auto-recovery
throw :racc_end_parse, nil
end
@racc_read_next = true
end
@racc_user_yyerror = false
@racc_error_status = 3
while true
if i = action_pointer[@racc_state[-1]]
i += 1 # error token
if i >= 0 and
(act = action_table[i]) and
action_check[i] == @racc_state[-1]
break
end
end
throw :racc_end_parse, nil if @racc_state.size <= 1
@racc_state.pop
@racc_vstack.pop
if @yydebug
@racc_tstack.pop
racc_e_pop @racc_state, @racc_tstack, @racc_vstack
end
end
return act
else
raise "[Racc Bug] unknown action #{act.inspect}"
end
racc_next_state(@racc_state[-1], @racc_state) if @yydebug
nil
end
def _racc_do_reduce(arg, act)
_, _, _, _,
goto_table, goto_check, goto_default, goto_pointer,
nt_base, reduce_table, _, _,
_, use_result, * = arg
state = @racc_state
vstack = @racc_vstack
tstack = @racc_tstack
i = act * -3
len = reduce_table[i]
reduce_to = reduce_table[i+1]
method_id = reduce_table[i+2]
void_array = []
tmp_t = tstack[-len, len] if @yydebug
tmp_v = vstack[-len, len]
tstack[-len, len] = void_array if @yydebug
vstack[-len, len] = void_array
state[-len, len] = void_array
# tstack must be updated AFTER method call
if use_result
vstack.push __send__(method_id, tmp_v, vstack, tmp_v[0])
else
vstack.push __send__(method_id, tmp_v, vstack)
end
tstack.push reduce_to
racc_reduce(tmp_t, reduce_to, tstack, vstack) if @yydebug
k1 = reduce_to - nt_base
if i = goto_pointer[k1]
i += state[-1]
if i >= 0 and (curstate = goto_table[i]) and goto_check[i] == k1
return curstate
end
end
goto_default[k1]
end
# This method is called when a parse error is found.
#
# ERROR_TOKEN_ID is an internal ID of token which caused error.
# You can get string representation of this ID by calling
# #token_to_str.
#
# ERROR_VALUE is a value of error token.
#
# value_stack is a stack of symbol values.
# DO NOT MODIFY this object.
#
# This method raises ParseError by default.
#
# If this method returns, parsers enter "error recovering mode".
def on_error(t, val, vstack)
raise ParseError, sprintf("parse error on value %s (%s)",
val.inspect, token_to_str(t) || '?')
end
# Enter error recovering mode.
# This method does not call #on_error.
def yyerror
throw :racc_jump, 1
end
# Exit parser.
# Return value is +Symbol_Value_Stack[0]+.
def yyaccept
throw :racc_jump, 2
end
# Leave error recovering mode.
def yyerrok
@racc_error_status = 0
end
# For debugging output
def racc_read_token(t, tok, val)
@racc_debug_out.print 'read '
@racc_debug_out.print tok.inspect, '(', racc_token2str(t), ') '
@racc_debug_out.puts val.inspect
@racc_debug_out.puts
end
def racc_shift(tok, tstack, vstack)
@racc_debug_out.puts "shift #{racc_token2str tok}"
racc_print_stacks tstack, vstack
@racc_debug_out.puts
end
def racc_reduce(toks, sim, tstack, vstack)
out = @racc_debug_out
out.print 'reduce '
if toks.empty?
out.print ' <none>'
else
toks.each {|t| out.print ' ', racc_token2str(t) }
end
out.puts " --> #{racc_token2str(sim)}"
racc_print_stacks tstack, vstack
@racc_debug_out.puts
end
def racc_accept
@racc_debug_out.puts 'accept'
@racc_debug_out.puts
end
def racc_e_pop(state, tstack, vstack)
@racc_debug_out.puts 'error recovering mode: pop token'
racc_print_states state
racc_print_stacks tstack, vstack
@racc_debug_out.puts
end
def racc_next_state(curstate, state)
@racc_debug_out.puts "goto #{curstate}"
racc_print_states state
@racc_debug_out.puts
end
def racc_print_stacks(t, v)
out = @racc_debug_out
out.print ' ['
t.each_index do |i|
out.print ' (', racc_token2str(t[i]), ' ', v[i].inspect, ')'
end
out.puts ' ]'
end
def racc_print_states(s)
out = @racc_debug_out
out.print ' ['
s.each {|st| out.print ' ', st }
out.puts ' ]'
end
def racc_token2str(tok)
self.class::Racc_token_to_s_table[tok] or
raise "[Racc Bug] can't convert token #{tok} to string"
end
# Convert internal ID of token symbol to the string.
def token_to_str(t)
self.class::Racc_token_to_s_table[t]
end
end
end
end
###### racc/parser.rb end
class RDoc::RD
##
# RD format parser for headings, paragraphs, lists, verbatim sections that
# exist as blocks.
class BlockParser < Racc::Parser
# :stopdoc:
MARK_TO_LEVEL = {
'=' => 1,
'==' => 2,
'===' => 3,
'====' => 4,
'+' => 5,
'++' => 6,
}
# :startdoc:
##
# Footnotes for this document
attr_reader :footnotes
##
# Labels for items in this document
attr_reader :labels
##
# Path to find included files in
attr_accessor :include_path
##
# Creates a new RDoc::RD::BlockParser. Use #parse to parse an rd-format
# document.
def initialize
@inline_parser = RDoc::RD::InlineParser.new self
@include_path = []
# for testing
@footnotes = []
@labels = {}
end
##
# Parses +src+ and returns an RDoc::Markup::Document.
def parse src
@src = src
@src.push false
@footnotes = []
@labels = {}
# @i: index(line no.) of src
@i = 0
# stack for current indentation
@indent_stack = []
# how indented.
@current_indent = @indent_stack.join("")
# RDoc::RD::BlockParser for tmp src
@subparser = nil
# which part is in now
@in_part = nil
@part_content = []
@in_verbatim = false
@yydebug = true
document = do_parse
unless @footnotes.empty? then
blankline = document.parts.pop
document.parts << RDoc::Markup::Rule.new(1)
document.parts.concat @footnotes
document.parts.push blankline
end
document
end
##
# Returns the next token from the document
def next_token # :nodoc:
# preprocessing
# if it is not in RD part
# => method
while @in_part != "rd"
line = @src[@i]
@i += 1 # next line
case line
# src end
when false
return [false, false]
# RD part begin
when /^=begin\s*(?:\bRD\b.*)?\s*$/
if @in_part # if in non-RD part
@part_content.push(line)
else
@in_part = "rd"
return [:WHITELINE, "=begin\n"] # <= for textblockand
end
# non-RD part begin
when /^=begin\s+(\w+)/
part = $1
=begin # not imported to RDoc
if @in_part # if in non-RD part
@part_content.push(line)
else
@in_part = part if @tree.filter[part] # if filter exists
# p "BEGIN_PART: #{@in_part}" # DEBUG
end
=end
@in_part = part
# non-RD part end
when /^=end(?:$|[\s\0\C-d\C-z])/
if @in_part # if in non-RD part
=begin # not imported to RDoc
# p "END_PART: #{@in_part}" # DEBUG
# make Part-in object
part = RDoc::RD::Part.new(@part_content.join(""), @tree, "r")
@part_content.clear
# call filter, part_out is output(Part object)
part_out = @tree.filter[@in_part].call(part)
if @tree.filter[@in_part].mode == :rd # if output is RD formatted
subtree = parse_subtree(part_out.to_a)
else # if output is target formatted
basename = Tempfile.create(["rdtmp", ".#{@in_part}"], @tree.tmp_dir) do |tmpfile|
tmpfile.print(part_out)
File.basename(tmpfile.path)
end
subtree = parse_subtree(["=begin\n", "<<< #{basename}\n", "=end\n"])
end
@in_part = nil
return [:SUBTREE, subtree]
=end
end
else
=begin # not imported to RDoc
if @in_part # if in non-RD part
@part_content.push(line)
end
=end
end
end
@current_indent = @indent_stack.join("")
line = @src[@i]
case line
when false
if_current_indent_equal("") do
[false, false]
end
when /^=end/
if_current_indent_equal("") do
@in_part = nil
[:WHITELINE, "=end"] # MUST CHANGE??
end
when /^\s*$/
@i += 1 # next line
return [:WHITELINE, ':WHITELINE']
when /^\#/ # comment line
@i += 1 # next line
self.next_token()
when /^(={1,4})(?!=)\s*(?=\S)/, /^(\+{1,2})(?!\+)\s*(?=\S)/
rest = $' # '
rest.strip!
mark = $1
if_current_indent_equal("") do
return [:HEADLINE, [MARK_TO_LEVEL[mark], rest]]
end
when /^<<<\s*(\S+)/
file = $1
if_current_indent_equal("") do
suffix = file[-3 .. -1]
if suffix == ".rd" or suffix == ".rb"
subtree = parse_subtree(get_included(file))
[:SUBTREE, subtree]
else
[:INCLUDE, file]
end
end
when /^(\s*)\*(\s*)/
rest = $' # '
newIndent = $2
if_current_indent_equal($1) do
if @in_verbatim
[:STRINGLINE, line]
else
@indent_stack.push("\s" + newIndent)
[:ITEMLISTLINE, rest]
end
end
when /^(\s*)(\(\d+\))(\s*)/
rest = $' # '
mark = $2
newIndent = $3
if_current_indent_equal($1) do
if @in_verbatim
[:STRINGLINE, line]
else
@indent_stack.push("\s" * mark.size + newIndent)
[:ENUMLISTLINE, rest]
end
end
when /^(\s*):(\s*)/
rest = $' # '
newIndent = $2
if_current_indent_equal($1) do
if @in_verbatim
[:STRINGLINE, line]
else
@indent_stack.push("\s#{$2}")
[:DESCLISTLINE, rest]
end
end
when /^(\s*)---(?!-|\s*$)/
indent = $1
rest = $'
/\s*/ === rest
term = $'
new_indent = $&
if_current_indent_equal(indent) do
if @in_verbatim
[:STRINGLINE, line]
else
@indent_stack.push("\s\s\s" + new_indent)
[:METHODLISTLINE, term]
end
end
when /^(\s*)/
if_current_indent_equal($1) do
[:STRINGLINE, line]
end
else
raise "[BUG] parsing error may occurred."
end
end
##
# Yields to the given block if +indent+ matches the current indent, otherwise
# an indentation token is processed.
def if_current_indent_equal(indent)
indent = indent.sub(/\t/, "\s" * 8)
if @current_indent == indent
@i += 1 # next line
yield
elsif indent.index(@current_indent) == 0
@indent_stack.push(indent[@current_indent.size .. -1])
[:INDENT, ":INDENT"]
else
@indent_stack.pop
[:DEDENT, ":DEDENT"]
end
end
private :if_current_indent_equal
##
# Cuts off excess whitespace in +src+
def cut_off(src)
ret = []
whiteline_buf = []
line = src.shift
/^\s*/ =~ line
indent = Regexp.quote($&)
ret.push($')
while line = src.shift
if /^(\s*)$/ =~ line
whiteline_buf.push(line)
elsif /^#{indent}/ =~ line
unless whiteline_buf.empty?
ret.concat(whiteline_buf)
whiteline_buf.clear
end
ret.push($')
else
raise "[BUG]: probably Parser Error while cutting off.\n"
end
end
ret
end
private :cut_off
def set_term_to_element(parent, term)
# parent.set_term_under_document_struct(term, @tree.document_struct)
parent.set_term_without_document_struct(term)
end
private :set_term_to_element
##
# Raises a ParseError when invalid formatting is found
def on_error(et, ev, _values)
prv, cur, nxt = format_line_num(@i, @i+1, @i+2)
raise ParseError, <<Msg
RD syntax error: line #{@i+1}:
#{prv} |#{@src[@i-1].chomp}
#{cur}=>|#{@src[@i].chomp}
#{nxt} |#{@src[@i+1].chomp}
Msg
end
##
# Current line number
def line_index
@i
end
##
# Parses subtree +src+
def parse_subtree src
@subparser ||= RDoc::RD::BlockParser.new
@subparser.parse src
end
private :parse_subtree
##
# Retrieves the content for +file+ from the include_path
def get_included(file)
included = []
@include_path.each do |dir|
file_name = File.join dir, file
if File.exist? file_name then
included = File.readlines file_name
break
end
end
included
end
private :get_included
##
# Formats line numbers +line_numbers+ prettily
def format_line_num(*line_numbers)
width = line_numbers.collect{|i| i.to_s.length }.max
line_numbers.collect{|i| sprintf("%#{width}d", i) }
end
private :format_line_num
##
# Retrieves the content of +values+ as a single String
def content values
values.map { |value| value.content }.join
end
##
# Creates a paragraph for +value+
def paragraph value
content = cut_off(value).join(' ').rstrip
contents = @inline_parser.parse content
RDoc::Markup::Paragraph.new(*contents)
end
##
# Adds footnote +content+ to the document
def add_footnote content
index = @footnotes.length / 2 + 1
footmark_link = "{^#{index}}[rdoc-label:footmark-#{index}:foottext-#{index}]"
@footnotes << RDoc::Markup::Paragraph.new(footmark_link, ' ', *content)
@footnotes << RDoc::Markup::BlankLine.new
index
end
##
# Adds label +label+ to the document
def add_label label
@labels[label] = true
label
end
# :stopdoc:
##### State transition tables begin ###
racc_action_table = [
34, 35, 30, 33, 40, 34, 35, 30, 33, 40,
65, 34, 35, 30, 33, 14, 73, 36, 38, 34,
15, 88, 34, 35, 30, 33, 14, 9, 10, 11,
12, 15, 34, 35, 30, 33, 14, 9, 10, 11,
12, 15, 34, 35, 30, 33, 35, 47, 30, 54,
33, 15, 34, 35, 30, 33, 54, 47, 14, 14,
59, 15, 34, 35, 30, 33, 14, 73, 67, 76,
77, 15, 34, 35, 30, 33, 14, 73, 54, 81,
38, 15, 34, 35, 30, 33, 14, 73, 38, 40,
83, 15, 34, 35, 30, 33, 14, 73, nil, nil,
nil, 15, 34, 35, 30, 33, 14, 73, nil, nil,
nil, 15, 34, 35, 30, 33, 14, 73, nil, nil,
nil, 15, 34, 35, 30, 33, 14, 73, nil, nil,
nil, 15, 34, 35, 30, 33, 14, 73, nil, nil,
nil, 15, 34, 35, 30, 33, 14, 73, 61, 63,
nil, 15, 14, 62, 60, 61, 63, 79, 61, 63,
62, 87, nil, 62, 34, 35, 30, 33 ]
racc_action_check = [
41, 41, 41, 41, 41, 15, 15, 15, 15, 15,
41, 86, 86, 86, 86, 86, 86, 1, 13, 22,
86, 86, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 2, 2, 2, 2, 2, 2, 2, 2,
2, 2, 24, 24, 24, 24, 25, 24, 28, 30,
31, 24, 27, 27, 27, 27, 33, 27, 34, 35,
36, 27, 45, 45, 45, 45, 45, 45, 44, 49,
51, 45, 46, 46, 46, 46, 46, 46, 54, 56,
57, 46, 47, 47, 47, 47, 47, 47, 58, 62,
66, 47, 68, 68, 68, 68, 68, 68, nil, nil,
nil, 68, 74, 74, 74, 74, 74, 74, nil, nil,
nil, 74, 75, 75, 75, 75, 75, 75, nil, nil,
nil, 75, 78, 78, 78, 78, 78, 78, nil, nil,
nil, 78, 79, 79, 79, 79, 79, 79, nil, nil,
nil, 79, 85, 85, 85, 85, 85, 85, 39, 39,
nil, 85, 52, 39, 39, 82, 82, 52, 64, 64,
82, 82, nil, 64, 20, 20, 20, 20 ]
racc_action_pointer = [
19, 17, 29, nil, nil, nil, nil, nil, nil, nil,
nil, nil, nil, 11, nil, 2, nil, nil, nil, nil,
161, nil, 16, nil, 39, 42, nil, 49, 43, nil,
41, 44, nil, 48, 51, 52, 60, nil, nil, 141,
nil, -3, nil, nil, 55, 59, 69, 79, nil, 56,
nil, 57, 145, nil, 70, nil, 66, 73, 81, nil,
nil, nil, 82, nil, 151, nil, 77, nil, 89, nil,
nil, nil, nil, nil, 99, 109, nil, nil, 119, 129,
nil, nil, 148, nil, nil, 139, 8, nil, nil ]
racc_action_default = [
-2, -73, -1, -4, -5, -6, -7, -8, -9, -10,
-11, -12, -13, -14, -16, -73, -23, -24, -25, -26,
-27, -31, -32, -34, -72, -36, -38, -72, -40, -42,
-59, -44, -46, -59, -63, -65, -73, -3, -15, -73,
-22, -73, -30, -33, -73, -69, -70, -71, -37, -73,
-41, -73, -51, -58, -61, -45, -73, -62, -64, 89,
-17, -19, -73, -21, -18, -28, -73, -35, -66, -53,
-54, -55, -56, -57, -67, -68, -39, -43, -49, -73,
-60, -47, -73, -29, -52, -48, -73, -20, -50 ]
racc_goto_table = [
4, 39, 4, 68, 74, 75, 5, 6, 5, 6,
44, 42, 51, 49, 3, 56, 37, 57, 58, 1,
2, 66, 84, 41, 43, 48, 50, 64, 84, 84,
45, 46, 42, 45, 46, 55, 85, 86, 80, 84,
84, nil, nil, nil, nil, nil, nil, nil, 82, nil,
nil, nil, 78 ]
racc_goto_check = [
4, 10, 4, 31, 31, 31, 5, 6, 5, 6,
21, 12, 27, 21, 3, 27, 3, 9, 9, 1,
2, 11, 32, 17, 19, 23, 26, 10, 32, 32,
5, 6, 12, 5, 6, 29, 31, 31, 33, 32,
32, nil, nil, nil, nil, nil, nil, nil, 10, nil,
nil, nil, 4 ]
racc_goto_pointer = [
nil, 19, 20, 14, 0, 6, 7, nil, nil, -17,
-14, -20, -9, nil, nil, nil, nil, 8, nil, 2,
nil, -14, nil, 0, nil, nil, -2, -18, nil, 4,
nil, -42, -46, -16 ]
racc_goto_default = [
nil, nil, nil, nil, 70, 71, 72, 7, 8, 13,
nil, nil, 21, 16, 17, 18, 19, 20, 22, 23,
24, nil, 25, 26, 27, 28, 29, nil, 31, 32,
52, nil, 69, 53 ]
racc_reduce_table = [
0, 0, :racc_error,
1, 15, :_reduce_1,
0, 15, :_reduce_2,
2, 16, :_reduce_3,
1, 16, :_reduce_4,
1, 17, :_reduce_5,
1, 17, :_reduce_6,
1, 17, :_reduce_none,
1, 17, :_reduce_8,
1, 17, :_reduce_9,
1, 17, :_reduce_10,
1, 17, :_reduce_11,
1, 21, :_reduce_12,
1, 22, :_reduce_13,
1, 18, :_reduce_14,
2, 23, :_reduce_15,
1, 23, :_reduce_16,
3, 19, :_reduce_17,
1, 25, :_reduce_18,
2, 24, :_reduce_19,
4, 24, :_reduce_20,
2, 24, :_reduce_21,
1, 24, :_reduce_22,
1, 26, :_reduce_none,
1, 26, :_reduce_none,
1, 26, :_reduce_none,
1, 26, :_reduce_none,
1, 20, :_reduce_27,
3, 20, :_reduce_28,
4, 20, :_reduce_29,
2, 31, :_reduce_30,
1, 31, :_reduce_31,
1, 27, :_reduce_32,
2, 32, :_reduce_33,
1, 32, :_reduce_34,
3, 33, :_reduce_35,
1, 28, :_reduce_36,
2, 36, :_reduce_37,
1, 36, :_reduce_38,
3, 37, :_reduce_39,
1, 29, :_reduce_40,
2, 39, :_reduce_41,
1, 39, :_reduce_42,
3, 40, :_reduce_43,
1, 30, :_reduce_44,
2, 42, :_reduce_45,
1, 42, :_reduce_46,
3, 43, :_reduce_47,
3, 41, :_reduce_48,
2, 41, :_reduce_49,
4, 41, :_reduce_50,
1, 41, :_reduce_51,
2, 45, :_reduce_52,
1, 45, :_reduce_none,
1, 46, :_reduce_54,
1, 46, :_reduce_55,
1, 46, :_reduce_none,
1, 46, :_reduce_57,
1, 44, :_reduce_none,
0, 44, :_reduce_none,
2, 47, :_reduce_none,
1, 47, :_reduce_none,
2, 34, :_reduce_62,
1, 34, :_reduce_63,
2, 38, :_reduce_64,
1, 38, :_reduce_65,
2, 35, :_reduce_66,
2, 35, :_reduce_67,
2, 35, :_reduce_68,
1, 35, :_reduce_69,
1, 35, :_reduce_none,
1, 35, :_reduce_71,
0, 35, :_reduce_72 ]
racc_reduce_n = 73
racc_shift_n = 89
racc_token_table = {
false => 0,
:error => 1,
:DUMMY => 2,
:ITEMLISTLINE => 3,
:ENUMLISTLINE => 4,
:DESCLISTLINE => 5,
:METHODLISTLINE => 6,
:STRINGLINE => 7,
:WHITELINE => 8,
:SUBTREE => 9,
:HEADLINE => 10,
:INCLUDE => 11,
:INDENT => 12,
:DEDENT => 13 }
racc_nt_base = 14
racc_use_result_var = true
Racc_arg = [
racc_action_table,
racc_action_check,
racc_action_default,
racc_action_pointer,
racc_goto_table,
racc_goto_check,
racc_goto_default,
racc_goto_pointer,
racc_nt_base,
racc_reduce_table,
racc_token_table,
racc_shift_n,
racc_reduce_n,
racc_use_result_var ]
Ractor.make_shareable(Racc_arg) if defined?(Ractor)
Racc_token_to_s_table = [
"$end",
"error",
"DUMMY",
"ITEMLISTLINE",
"ENUMLISTLINE",
"DESCLISTLINE",
"METHODLISTLINE",
"STRINGLINE",
"WHITELINE",
"SUBTREE",
"HEADLINE",
"INCLUDE",
"INDENT",
"DEDENT",
"$start",
"document",
"blocks",
"block",
"textblock",
"verbatim",
"lists",
"headline",
"include",
"textblockcontent",
"verbatimcontent",
"verbatim_after_lists",
"list",
"itemlist",
"enumlist",
"desclist",
"methodlist",
"lists2",
"itemlistitems",
"itemlistitem",
"first_textblock_in_itemlist",
"other_blocks_in_list",
"enumlistitems",
"enumlistitem",
"first_textblock_in_enumlist",
"desclistitems",
"desclistitem",
"description_part",
"methodlistitems",
"methodlistitem",
"whitelines",
"blocks_in_list",
"block_in_list",
"whitelines2" ]
Ractor.make_shareable(Racc_token_to_s_table) if defined?(Ractor)
Racc_debug_parser = false
##### State transition tables end #####
# reduce 0 omitted
def _reduce_1(val, _values, result)
result = RDoc::Markup::Document.new(*val[0])
result
end
def _reduce_2(val, _values, result)
raise ParseError, "file empty"
result
end
def _reduce_3(val, _values, result)
result = val[0].concat val[1]
result
end
def _reduce_4(val, _values, result)
result = val[0]
result
end
def _reduce_5(val, _values, result)
result = val
result
end
def _reduce_6(val, _values, result)
result = val
result
end
# reduce 7 omitted
def _reduce_8(val, _values, result)
result = val
result
end
def _reduce_9(val, _values, result)
result = val
result
end
def _reduce_10(val, _values, result)
result = [RDoc::Markup::BlankLine.new]
result
end
def _reduce_11(val, _values, result)
result = val[0].parts
result
end
def _reduce_12(val, _values, result)
# val[0] is like [level, title]
title = @inline_parser.parse(val[0][1])
result = RDoc::Markup::Heading.new(val[0][0], title)
result
end
def _reduce_13(val, _values, result)
result = RDoc::Markup::Include.new val[0], @include_path
result
end
def _reduce_14(val, _values, result)
# val[0] is Array of String
result = paragraph val[0]
result
end
def _reduce_15(val, _values, result)
result << val[1].rstrip
result
end
def _reduce_16(val, _values, result)
result = [val[0].rstrip]
result
end
def _reduce_17(val, _values, result)
# val[1] is Array of String
content = cut_off val[1]
result = RDoc::Markup::Verbatim.new(*content)
# imform to lexer.
@in_verbatim = false
result
end
def _reduce_18(val, _values, result)
# val[0] is Array of String
content = cut_off val[0]
result = RDoc::Markup::Verbatim.new(*content)
# imform to lexer.
@in_verbatim = false
result
end
def _reduce_19(val, _values, result)
result << val[1]
result
end
def _reduce_20(val, _values, result)
result.concat val[2]
result
end
def _reduce_21(val, _values, result)
result << "\n"
result
end
def _reduce_22(val, _values, result)
result = val
# inform to lexer.
@in_verbatim = true
result
end
# reduce 23 omitted
# reduce 24 omitted
# reduce 25 omitted
# reduce 26 omitted
def _reduce_27(val, _values, result)
result = val[0]
result
end
def _reduce_28(val, _values, result)
result = val[1]
result
end
def _reduce_29(val, _values, result)
result = val[1].push(val[2])
result
end
def _reduce_30(val, _values, result)
result = val[0] << val[1]
result
end
def _reduce_31(val, _values, result)
result = [val[0]]
result
end
def _reduce_32(val, _values, result)
result = RDoc::Markup::List.new :BULLET, *val[0]
result
end
def _reduce_33(val, _values, result)
result.push(val[1])
result
end
def _reduce_34(val, _values, result)
result = val
result
end
def _reduce_35(val, _values, result)
result = RDoc::Markup::ListItem.new nil, val[0], *val[1]
result
end
def _reduce_36(val, _values, result)
result = RDoc::Markup::List.new :NUMBER, *val[0]
result
end
def _reduce_37(val, _values, result)
result.push(val[1])
result
end
def _reduce_38(val, _values, result)
result = val
result
end
def _reduce_39(val, _values, result)
result = RDoc::Markup::ListItem.new nil, val[0], *val[1]
result
end
def _reduce_40(val, _values, result)
result = RDoc::Markup::List.new :NOTE, *val[0]
result
end
def _reduce_41(val, _values, result)
result.push(val[1])
result
end
def _reduce_42(val, _values, result)
result = val
result
end
def _reduce_43(val, _values, result)
term = @inline_parser.parse val[0].strip
result = RDoc::Markup::ListItem.new term, *val[1]
result
end
def _reduce_44(val, _values, result)
result = RDoc::Markup::List.new :LABEL, *val[0]
result
end
def _reduce_45(val, _values, result)
result.push(val[1])
result
end
def _reduce_46(val, _values, result)
result = val
result
end
def _reduce_47(val, _values, result)
result = RDoc::Markup::ListItem.new "<tt>#{val[0].strip}</tt>", *val[1]
result
end
def _reduce_48(val, _values, result)
result = [val[1]].concat(val[2])
result
end
def _reduce_49(val, _values, result)
result = [val[1]]
result
end
def _reduce_50(val, _values, result)
result = val[2]
result
end
def _reduce_51(val, _values, result)
result = []
result
end
def _reduce_52(val, _values, result)
result.concat val[1]
result
end
# reduce 53 omitted
def _reduce_54(val, _values, result)
result = val
result
end
def _reduce_55(val, _values, result)
result = val
result
end
# reduce 56 omitted
def _reduce_57(val, _values, result)
result = []
result
end
# reduce 58 omitted
# reduce 59 omitted
# reduce 60 omitted
# reduce 61 omitted
def _reduce_62(val, _values, result)
result = paragraph [val[0]].concat(val[1])
result
end
def _reduce_63(val, _values, result)
result = paragraph [val[0]]
result
end
def _reduce_64(val, _values, result)
result = paragraph [val[0]].concat(val[1])
result
end
def _reduce_65(val, _values, result)
result = paragraph [val[0]]
result
end
def _reduce_66(val, _values, result)
result = [val[0]].concat(val[1])
result
end
def _reduce_67(val, _values, result)
result.concat val[1]
result
end
def _reduce_68(val, _values, result)
result = val[1]
result
end
def _reduce_69(val, _values, result)
result = val
result
end
# reduce 70 omitted
def _reduce_71(val, _values, result)
result = []
result
end
def _reduce_72(val, _values, result)
result = []
result
end
def _reduce_none(val, _values, result)
val[0]
end
end # class BlockParser
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/rd/inline.rb 0000644 00000002612 15173517747 0015221 0 ustar 00 # frozen_string_literal: true
##
# Inline keeps track of markup and labels to create proper links.
class RDoc::RD::Inline
##
# The text of the reference
attr_reader :reference
##
# The markup of this reference in RDoc format
attr_reader :rdoc
##
# Creates a new Inline for +rdoc+ and +reference+.
#
# +rdoc+ may be another Inline or a String. If +reference+ is not given it
# will use the text from +rdoc+.
def self.new rdoc, reference = rdoc
if self === rdoc and reference.equal? rdoc then
rdoc
else
super
end
end
##
# Initializes the Inline with +rdoc+ and +inline+
def initialize rdoc, reference # :not-new:
@reference = reference.equal?(rdoc) ? reference.dup : reference
# unpack
@reference = @reference.reference if self.class === @reference
@rdoc = rdoc
end
def == other # :nodoc:
self.class === other and
@reference == other.reference and @rdoc == other.rdoc
end
##
# Appends +more+ to this inline. +more+ may be a String or another Inline.
def append more
case more
when String then
@reference += more
@rdoc += more
when RDoc::RD::Inline then
@reference += more.reference
@rdoc += more.rdoc
else
raise "unknown thingy #{more}"
end
self
end
def inspect # :nodoc:
"(inline: #{self})"
end
alias to_s rdoc # :nodoc:
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/rd.rb 0000644 00000007126 15173517747 0013750 0 ustar 00 # frozen_string_literal: true
##
# RDoc::RD implements the RD format from the rdtool gem.
#
# To choose RD as your only default format see
# RDoc::Options@Saved+Options for instructions on setting up a
# <code>.doc_options</code> file to store your project default.
#
# == LICENSE
#
# The grammar that produces RDoc::RD::BlockParser and RDoc::RD::InlineParser
# is included in RDoc under the Ruby License.
#
# You can find the original source for rdtool at
# https://github.com/uwabami/rdtool/
#
# You can use, re-distribute or change these files under Ruby's License or GPL.
#
# 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.
class RDoc::RD
##
# Parses +rd+ source and returns an RDoc::Markup::Document. If the
# <tt>=begin</tt> or <tt>=end</tt> lines are missing they will be added.
def self.parse rd
rd = rd.lines.to_a
if rd.find { |i| /\S/ === i } and !rd.find{|i| /^=begin\b/ === i } then
rd.unshift("=begin\n").push("=end\n")
end
parser = RDoc::RD::BlockParser.new
document = parser.parse rd
# isn't this always true?
document.parts.shift if RDoc::Markup::BlankLine === document.parts.first
document.parts.pop if RDoc::Markup::BlankLine === document.parts.last
document
end
autoload :BlockParser, "#{__dir__}/rd/block_parser"
autoload :InlineParser, "#{__dir__}/rd/inline_parser"
autoload :Inline, "#{__dir__}/rd/inline"
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/code_object.rb 0000644 00000022413 15173517747 0015577 0 ustar 00 # frozen_string_literal: true
##
# Base class for the RDoc code tree.
#
# We contain the common stuff for contexts (which are containers) and other
# elements (methods, attributes and so on)
#
# Here's the tree of the CodeObject subclasses:
#
# * RDoc::Context
# * RDoc::TopLevel
# * RDoc::ClassModule
# * RDoc::AnonClass (never used so far)
# * RDoc::NormalClass
# * RDoc::NormalModule
# * RDoc::SingleClass
# * RDoc::MethodAttr
# * RDoc::Attr
# * RDoc::AnyMethod
# * RDoc::GhostMethod
# * RDoc::MetaMethod
# * RDoc::Alias
# * RDoc::Constant
# * RDoc::Mixin
# * RDoc::Require
# * RDoc::Include
class RDoc::CodeObject
include RDoc::Text
##
# Our comment
attr_reader :comment
##
# Do we document our children?
attr_reader :document_children
##
# Do we document ourselves?
attr_reader :document_self
##
# Are we done documenting (ie, did we come across a :enddoc:)?
attr_reader :done_documenting
##
# Which file this code object was defined in
attr_reader :file
##
# Force documentation of this CodeObject
attr_reader :force_documentation
##
# Line in #file where this CodeObject was defined
attr_accessor :line
##
# Hash of arbitrary metadata for this CodeObject
attr_reader :metadata
##
# Sets the parent CodeObject
attr_writer :parent
##
# Did we ever receive a +:nodoc:+ directive?
attr_reader :received_nodoc
##
# Set the section this CodeObject is in
attr_writer :section
##
# The RDoc::Store for this object.
attr_reader :store
##
# We are the model of the code, but we know that at some point we will be
# worked on by viewers. By implementing the Viewable protocol, viewers can
# associated themselves with these objects.
attr_accessor :viewer
##
# Creates a new CodeObject that will document itself and its children
def initialize
@metadata = {}
@comment = ''
@parent = nil
@parent_name = nil # for loading
@parent_class = nil # for loading
@section = nil
@section_title = nil # for loading
@file = nil
@full_name = nil
@store = nil
@track_visibility = true
initialize_visibility
end
##
# Initializes state for visibility of this CodeObject and its children.
def initialize_visibility # :nodoc:
@document_children = true
@document_self = true
@done_documenting = false
@force_documentation = false
@received_nodoc = false
@ignored = false
@suppressed = false
@track_visibility = true
end
##
# Replaces our comment with +comment+, unless it is empty.
def comment=(comment)
@comment = case comment
when NilClass then ''
when RDoc::Markup::Document then comment
when RDoc::Comment then comment.normalize
else
if comment and not comment.empty? then
normalize_comment comment
else
# HACK correct fix is to have #initialize create @comment
# with the correct encoding
if String === @comment and @comment.empty? then
@comment = RDoc::Encoding.change_encoding @comment, comment.encoding
end
@comment
end
end
end
##
# Should this CodeObject be displayed in output?
#
# A code object should be displayed if:
#
# * The item didn't have a nodoc or wasn't in a container that had nodoc
# * The item wasn't ignored
# * The item has documentation and was not suppressed
def display?
@document_self and not @ignored and
(documented? or not @suppressed)
end
##
# Enables or disables documentation of this CodeObject's children unless it
# has been turned off by :enddoc:
def document_children=(document_children)
return unless @track_visibility
@document_children = document_children unless @done_documenting
end
##
# Enables or disables documentation of this CodeObject unless it has been
# turned off by :enddoc:. If the argument is +nil+ it means the
# documentation is turned off by +:nodoc:+.
def document_self=(document_self)
return unless @track_visibility
return if @done_documenting
@document_self = document_self
@received_nodoc = true if document_self.nil?
end
##
# Does this object have a comment with content or is #received_nodoc true?
def documented?
@received_nodoc or !@comment.empty?
end
##
# Turns documentation on/off, and turns on/off #document_self
# and #document_children.
#
# Once documentation has been turned off (by +:enddoc:+),
# the object will refuse to turn #document_self or
# #document_children on, so +:doc:+ and +:start_doc:+ directives
# will have no effect in the current file.
def done_documenting=(value)
return unless @track_visibility
@done_documenting = value
@document_self = !value
@document_children = @document_self
end
##
# Yields each parent of this CodeObject. See also
# RDoc::ClassModule#each_ancestor
def each_parent
code_object = self
while code_object = code_object.parent do
yield code_object
end
self
end
##
# File name where this CodeObject was found.
#
# See also RDoc::Context#in_files
def file_name
return unless @file
@file.absolute_name
end
##
# Force the documentation of this object unless documentation
# has been turned off by :enddoc:
#--
# HACK untested, was assigning to an ivar
def force_documentation=(value)
@force_documentation = value unless @done_documenting
end
##
# Sets the full_name overriding any computed full name.
#
# Set to +nil+ to clear RDoc's cached value
def full_name= full_name
@full_name = full_name
end
##
# Use this to ignore a CodeObject and all its children until found again
# (#record_location is called). An ignored item will not be displayed in
# documentation.
#
# See github issue #55
#
# The ignored status is temporary in order to allow implementation details
# to be hidden. At the end of processing a file RDoc allows all classes
# and modules to add new documentation to previously created classes.
#
# If a class was ignored (via stopdoc) then reopened later with additional
# documentation it should be displayed. If a class was ignored and never
# reopened it should not be displayed. The ignore flag allows this to
# occur.
def ignore
return unless @track_visibility
@ignored = true
stop_doc
end
##
# Has this class been ignored?
#
# See also #ignore
def ignored?
@ignored
end
##
# The options instance from the store this CodeObject is attached to, or a
# default options instance if the CodeObject is not attached.
#
# This is used by Text#snippet
def options
if @store and @store.rdoc then
@store.rdoc.options
else
RDoc::Options.new
end
end
##
# Our parent CodeObject. The parent may be missing for classes loaded from
# legacy RI data stores.
def parent
return @parent if @parent
return nil unless @parent_name
if @parent_class == RDoc::TopLevel then
@parent = @store.add_file @parent_name
else
@parent = @store.find_class_or_module @parent_name
return @parent if @parent
begin
@parent = @store.load_class @parent_name
rescue RDoc::Store::MissingFileError
nil
end
end
end
##
# File name of our parent
def parent_file_name
@parent ? @parent.base_name : '(unknown)'
end
##
# Name of our parent
def parent_name
@parent ? @parent.full_name : '(unknown)'
end
##
# Records the RDoc::TopLevel (file) where this code object was defined
def record_location top_level
@ignored = false
@suppressed = false
@file = top_level
end
##
# The section this CodeObject is in. Sections allow grouping of constants,
# attributes and methods inside a class or module.
def section
return @section if @section
@section = parent.add_section @section_title if parent
end
##
# Enable capture of documentation unless documentation has been
# turned off by :enddoc:
def start_doc
return if @done_documenting
@document_self = true
@document_children = true
@ignored = false
@suppressed = false
end
##
# Disable capture of documentation
def stop_doc
return unless @track_visibility
@document_self = false
@document_children = false
end
##
# Sets the +store+ that contains this CodeObject
def store= store
@store = store
return unless @track_visibility
if :nodoc == options.visibility then
initialize_visibility
@track_visibility = false
end
end
##
# Use this to suppress a CodeObject and all its children until the next file
# it is seen in or documentation is discovered. A suppressed item with
# documentation will be displayed while an ignored item with documentation
# may not be displayed.
def suppress
return unless @track_visibility
@suppressed = true
stop_doc
end
##
# Has this class been suppressed?
#
# See also #suppress
def suppressed?
@suppressed
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/version.rb 0000644 00000000154 15173517747 0015022 0 ustar 00 # frozen_string_literal: true
module RDoc
##
# RDoc version you are using
VERSION = '6.6.3.1'
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/erb_partial.rb 0000644 00000000620 15173517747 0015617 0 ustar 00 # frozen_string_literal: true
##
# Allows an ERB template to be rendered in the context (binding) of an
# existing ERB template evaluation.
class RDoc::ERBPartial < ERB
##
# Overrides +compiler+ startup to set the +eoutvar+ to an empty string only
# if it isn't already set.
def set_eoutvar compiler, eoutvar = '_erbout'
super
compiler.pre_cmd = ["#{eoutvar} ||= +''"]
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser.rb 0000644 00000016673 15173517747 0014646 0 ustar 00 # -*- coding: us-ascii -*-
# frozen_string_literal: true
##
# A parser is simple a class that subclasses RDoc::Parser and implements #scan
# to fill in an RDoc::TopLevel with parsed data.
#
# The initialize method takes an RDoc::TopLevel to fill with parsed content,
# the name of the file to be parsed, the content of the file, an RDoc::Options
# object and an RDoc::Stats object to inform the user of parsed items. The
# scan method is then called to parse the file and must return the
# RDoc::TopLevel object. By calling super these items will be set for you.
#
# In order to be used by RDoc the parser needs to register the file extensions
# it can parse. Use ::parse_files_matching to register extensions.
#
# require 'rdoc'
#
# class RDoc::Parser::Xyz < RDoc::Parser
# parse_files_matching /\.xyz$/
#
# def initialize top_level, file_name, content, options, stats
# super
#
# # extra initialization if needed
# end
#
# def scan
# # parse file and fill in @top_level
# end
# end
class RDoc::Parser
@parsers = []
class << self
##
# An Array of arrays that maps file extension (or name) regular
# expressions to parser classes that will parse matching filenames.
#
# Use parse_files_matching to register a parser's file extensions.
attr_reader :parsers
end
##
# The name of the file being parsed
attr_reader :file_name
##
# Alias an extension to another extension. After this call, files ending
# "new_ext" will be parsed using the same parser as "old_ext"
def self.alias_extension(old_ext, new_ext)
old_ext = old_ext.sub(/^\.(.*)/, '\1')
new_ext = new_ext.sub(/^\.(.*)/, '\1')
parser = can_parse_by_name "xxx.#{old_ext}"
return false unless parser
RDoc::Parser.parsers.unshift [/\.#{new_ext}$/, parser]
true
end
##
# Determines if the file is a "binary" file which basically means it has
# content that an RDoc parser shouldn't try to consume.
def self.binary?(file)
return false if file =~ /\.(rdoc|txt)$/
s = File.read(file, 1024) or return false
return true if s[0, 2] == Marshal.dump('')[0, 2] or s.index("\x00")
mode = 'r:utf-8' # default source encoding has been changed to utf-8
s.sub!(/\A#!.*\n/, '') # assume shebang line isn't longer than 1024.
encoding = s[/^\s*\#\s*(?:-\*-\s*)?(?:en)?coding:\s*([^\s;]+?)(?:-\*-|[\s;])/, 1]
mode = "rb:#{encoding}" if encoding
s = File.open(file, mode) {|f| f.gets(nil, 1024)}
not s.valid_encoding?
end
##
# Checks if +file+ is a zip file in disguise. Signatures from
# http://www.garykessler.net/library/file_sigs.html
def self.zip? file
zip_signature = File.read file, 4
zip_signature == "PK\x03\x04" or
zip_signature == "PK\x05\x06" or
zip_signature == "PK\x07\x08"
rescue
false
end
##
# Return a parser that can handle a particular extension
def self.can_parse file_name
parser = can_parse_by_name file_name
# HACK Selenium hides a jar file using a .txt extension
return if parser == RDoc::Parser::Simple and zip? file_name
parser
end
##
# Returns a parser that can handle the extension for +file_name+. This does
# not depend upon the file being readable.
def self.can_parse_by_name file_name
_, parser = RDoc::Parser.parsers.find { |regexp,| regexp =~ file_name }
# The default parser must not parse binary files
ext_name = File.extname file_name
return parser if ext_name.empty?
if parser == RDoc::Parser::Simple and ext_name !~ /txt|rdoc/ then
case check_modeline file_name
when nil, 'rdoc' then # continue
else return nil
end
end
parser
rescue Errno::EACCES
end
##
# Returns the file type from the modeline in +file_name+
def self.check_modeline file_name
line = File.open file_name do |io|
io.gets
end
/-\*-\s*(.*?\S)\s*-\*-/ =~ line
return nil unless type = $1
if /;/ =~ type then
return nil unless /(?:\s|\A)mode:\s*([^\s;]+)/i =~ type
type = $1
end
return nil if /coding:/i =~ type
type.downcase
rescue ArgumentError
rescue Encoding::InvalidByteSequenceError # invalid byte sequence
end
##
# Finds and instantiates the correct parser for the given +file_name+ and
# +content+.
def self.for top_level, file_name, content, options, stats
return if binary? file_name
parser = use_markup content
unless parser then
parse_name = file_name
# If no extension, look for shebang
if file_name !~ /\.\w+$/ && content =~ %r{\A#!(.+)} then
shebang = $1
case shebang
when %r{env\s+ruby}, %r{/ruby}
parse_name = 'dummy.rb'
end
end
parser = can_parse parse_name
end
return unless parser
content = remove_modeline content
parser.new top_level, file_name, content, options, stats
rescue SystemCallError
nil
end
##
# Record which file types this parser can understand.
#
# It is ok to call this multiple times.
def self.parse_files_matching(regexp)
RDoc::Parser.parsers.unshift [regexp, self]
end
##
# Removes an emacs-style modeline from the first line of the document
def self.remove_modeline content
content.sub(/\A.*-\*-\s*(.*?\S)\s*-\*-.*\r?\n/, '')
end
##
# If there is a <tt>markup: parser_name</tt> comment at the front of the
# file, use it to determine the parser. For example:
#
# # markup: rdoc
# # Class comment can go here
#
# class C
# end
#
# The comment should appear as the first line of the +content+.
#
# If the content contains a shebang or editor modeline the comment may
# appear on the second or third line.
#
# Any comment style may be used to hide the markup comment.
def self.use_markup content
markup = content.lines.first(3).grep(/markup:\s+(\w+)/) { $1 }.first
return unless markup
# TODO Ruby should be returned only when the filename is correct
return RDoc::Parser::Ruby if %w[tomdoc markdown].include? markup
markup = Regexp.escape markup
_, selected = RDoc::Parser.parsers.find do |_, parser|
/^#{markup}$/i =~ parser.name.sub(/.*:/, '')
end
selected
end
##
# Creates a new Parser storing +top_level+, +file_name+, +content+,
# +options+ and +stats+ in instance variables. In +@preprocess+ an
# RDoc::Markup::PreProcess object is created which allows processing of
# directives.
def initialize top_level, file_name, content, options, stats
@top_level = top_level
@top_level.parser = self.class
@store = @top_level.store
@file_name = file_name
@content = content
@options = options
@stats = stats
@preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
@preprocess.options = @options
end
autoload :RubyTools, "#{__dir__}/parser/ruby_tools"
autoload :Text, "#{__dir__}/parser/text"
##
# Normalizes tabs in +body+
def handle_tab_width(body)
if /\t/ =~ body
tab_width = @options.tab_width
body.split(/\n/).map do |line|
1 while line.gsub!(/\t+/) do
b, e = $~.offset(0)
' ' * (tab_width * (e-b) - b % tab_width)
end
line
end.join "\n"
else
body
end
end
end
# simple must come first in order to show up last in the parsers list
require_relative 'parser/simple'
require_relative 'parser/c'
require_relative 'parser/changelog'
require_relative 'parser/markdown'
require_relative 'parser/rd'
require_relative 'parser/ruby'
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/token_stream.rb 0000644 00000006256 15173517747 0016041 0 ustar 00 # frozen_string_literal: true
##
# A TokenStream is a list of tokens, gathered during the parse of some entity
# (say a method). Entities populate these streams by being registered with the
# lexer. Any class can collect tokens by including TokenStream. From the
# outside, you use such an object by calling the start_collecting_tokens
# method, followed by calls to add_token and pop_token.
module RDoc::TokenStream
##
# Converts +token_stream+ to HTML wrapping various tokens with
# <tt><span></tt> elements. Some tokens types are wrapped in spans
# with the given class names. Other token types are not wrapped in spans.
def self.to_html token_stream
starting_title = false
token_stream.map do |t|
next unless t
style = case t[:kind]
when :on_const then 'ruby-constant'
when :on_kw then 'ruby-keyword'
when :on_ivar then 'ruby-ivar'
when :on_cvar then 'ruby-identifier'
when :on_gvar then 'ruby-identifier'
when '=' != t[:text] && :on_op
then 'ruby-operator'
when :on_tlambda then 'ruby-operator'
when :on_ident then 'ruby-identifier'
when :on_label then 'ruby-value'
when :on_backref, :on_dstring
then 'ruby-node'
when :on_comment then 'ruby-comment'
when :on_embdoc then 'ruby-comment'
when :on_regexp then 'ruby-regexp'
when :on_tstring then 'ruby-string'
when :on_int, :on_float,
:on_rational, :on_imaginary,
:on_heredoc,
:on_symbol, :on_CHAR then 'ruby-value'
when :on_heredoc_beg, :on_heredoc_end
then 'ruby-identifier'
end
comment_with_nl = false
if :on_comment == t[:kind] or :on_embdoc == t[:kind] or :on_heredoc_end == t[:kind]
comment_with_nl = true if "\n" == t[:text][-1]
text = t[:text].rstrip
else
text = t[:text]
end
if :on_ident == t[:kind] && starting_title
starting_title = false
style = 'ruby-identifier ruby-title'
end
if :on_kw == t[:kind] and 'def' == t[:text]
starting_title = true
end
text = CGI.escapeHTML text
if style then
"<span class=\"#{style}\">#{text}</span>#{"\n" if comment_with_nl}"
else
text
end
end.join
end
##
# Adds +tokens+ to the collected tokens
def add_tokens(tokens)
@token_stream.concat(tokens)
end
##
# Adds one +token+ to the collected tokens
def add_token(token)
@token_stream.push(token)
end
##
# Starts collecting tokens
def collect_tokens
@token_stream = []
end
alias start_collecting_tokens collect_tokens
##
# Remove the last token from the collected tokens
def pop_token
@token_stream.pop
end
##
# Current token stream
def token_stream
@token_stream
end
##
# Returns a string representation of the token stream
def tokens_to_s
(token_stream or return '').compact.map { |token| token[:text] }.join ''
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/erbio.rb 0000644 00000001525 15173517747 0014440 0 ustar 00 # frozen_string_literal: true
require 'erb'
##
# A subclass of ERB that writes directly to an IO. Credit to Aaron Patterson
# and Masatoshi SEKI.
#
# To use:
#
# erbio = RDoc::ERBIO.new '<%= "hello world" %>', nil, nil
#
# File.open 'hello.txt', 'w' do |io|
# erbio.result binding
# end
#
# Note that binding must enclose the io you wish to output on.
class RDoc::ERBIO < ERB
##
# Defaults +eoutvar+ to 'io', otherwise is identical to ERB's initialize
def initialize str, trim_mode: nil, eoutvar: 'io'
super(str, trim_mode: trim_mode, eoutvar: eoutvar)
end
##
# Instructs +compiler+ how to write to +io_variable+
def set_eoutvar compiler, io_variable
compiler.put_cmd = "#{io_variable}.write"
compiler.insert_cmd = "#{io_variable}.write"
compiler.pre_cmd = []
compiler.post_cmd = []
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/i18n/text.rb 0000644 00000005602 15173517750 0015075 0 ustar 00 # frozen_string_literal: true
##
# An i18n supported text.
#
# This object provides the following two features:
#
# * Extracts translation messages from wrapped raw text.
# * Translates wrapped raw text in specified locale.
#
# Wrapped raw text is one of String, RDoc::Comment or Array of them.
class RDoc::I18n::Text
##
# Creates a new i18n supported text for +raw+ text.
def initialize(raw)
@raw = raw
end
##
# Extracts translation target messages and yields each message.
#
# Each yielded message is a Hash. It consists of the followings:
#
# :type :: :paragraph
# :paragraph :: String (The translation target message itself.)
# :line_no :: Integer (The line number of the :paragraph is started.)
#
# The above content may be added in the future.
def extract_messages
parse do |part|
case part[:type]
when :empty_line
# ignore
when :paragraph
yield(part)
end
end
end
# Translates raw text into +locale+.
def translate(locale)
translated_text = ''
parse do |part|
case part[:type]
when :paragraph
translated_text += locale.translate(part[:paragraph])
when :empty_line
translated_text += part[:line]
else
raise "should not reach here: unexpected type: #{type}"
end
end
translated_text
end
private
def parse(&block)
paragraph = ''
paragraph_start_line = 0
line_no = 0
each_line(@raw) do |line|
line_no += 1
case line
when /\A\s*\z/
if paragraph.empty?
emit_empty_line_event(line, line_no, &block)
else
paragraph += line
emit_paragraph_event(paragraph, paragraph_start_line, line_no,
&block)
paragraph = ''
end
else
paragraph_start_line = line_no if paragraph.empty?
paragraph += line
end
end
unless paragraph.empty?
emit_paragraph_event(paragraph, paragraph_start_line, line_no, &block)
end
end
def each_line(raw, &block)
case raw
when RDoc::Comment
raw.text.each_line(&block)
when Array
raw.each do |comment, location|
each_line(comment, &block)
end
else
raw.each_line(&block)
end
end
def emit_empty_line_event(line, line_no)
part = {
:type => :empty_line,
:line => line,
:line_no => line_no,
}
yield(part)
end
def emit_paragraph_event(paragraph, paragraph_start_line, line_no, &block)
paragraph_part = {
:type => :paragraph,
:line_no => paragraph_start_line,
}
match_data = /(\s*)\z/.match(paragraph)
if match_data
paragraph_part[:paragraph] = match_data.pre_match
yield(paragraph_part)
emit_empty_line_event(match_data[1], line_no, &block)
else
paragraph_part[:paragraph] = paragraph
yield(paragraph_part)
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/i18n/locale.rb 0000644 00000004546 15173517750 0015356 0 ustar 00 # frozen_string_literal: true
##
# A message container for a locale.
#
# This object provides the following two features:
#
# * Loads translated messages from .po file.
# * Translates a message into the locale.
class RDoc::I18n::Locale
@@locales = {} # :nodoc:
class << self
##
# Returns the locale object for +locale_name+.
def [](locale_name)
@@locales[locale_name] ||= new(locale_name)
end
##
# Sets the locale object for +locale_name+.
#
# Normally, this method is not used. This method is useful for
# testing.
def []=(locale_name, locale)
@@locales[locale_name] = locale
end
end
##
# The name of the locale. It uses IETF language tag format
# +[language[_territory][.codeset][@modifier]]+.
#
# See also {BCP 47 - Tags for Identifying
# Languages}[http://tools.ietf.org/rfc/bcp/bcp47.txt].
attr_reader :name
##
# Creates a new locale object for +name+ locale. +name+ must
# follow IETF language tag format.
def initialize(name)
@name = name
@messages = {}
end
##
# Loads translation messages from +locale_directory+/+@name+/rdoc.po
# or +locale_directory+/+@name+.po. The former has high priority.
#
# This method requires gettext gem for parsing .po file. If you
# don't have gettext gem, this method doesn't load .po file. This
# method warns and returns +false+.
#
# Returns +true+ if succeeded, +false+ otherwise.
def load(locale_directory)
return false if @name.nil?
po_file_candidates = [
File.join(locale_directory, @name, 'rdoc.po'),
File.join(locale_directory, "#{@name}.po"),
]
po_file = po_file_candidates.find do |po_file_candidate|
File.exist?(po_file_candidate)
end
return false unless po_file
begin
require 'gettext/po_parser'
require 'gettext/mo'
rescue LoadError
warn('Need gettext gem for i18n feature:')
warn(' gem install gettext')
return false
end
po_parser = GetText::POParser.new
messages = GetText::MO.new
po_parser.report_warning = false
po_parser.parse_file(po_file, messages)
@messages.merge!(messages)
true
end
##
# Translates the +message+ into locale. If there is no translation
# messages for +message+ in locale, +message+ itself is returned.
def translate(message)
@messages[message] || message
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/store.rb 0000644 00000055400 15173517750 0014467 0 ustar 00 # frozen_string_literal: true
require 'fileutils'
##
# A set of rdoc data for a single project (gem, path, etc.).
#
# The store manages reading and writing ri data for a project and maintains a
# cache of methods, classes and ancestors in the store.
#
# The store maintains a #cache of its contents for faster lookup. After
# adding items to the store it must be flushed using #save_cache. The cache
# contains the following structures:
#
# @cache = {
# :ancestors => {}, # class name => ancestor names
# :attributes => {}, # class name => attributes
# :class_methods => {}, # class name => class methods
# :instance_methods => {}, # class name => instance methods
# :modules => [], # classes and modules in this store
# :pages => [], # page names
# }
#--
# TODO need to prune classes
class RDoc::Store
##
# Errors raised from loading or saving the store
class Error < RDoc::Error
end
##
# Raised when a stored file for a class, module, page or method is missing.
class MissingFileError < Error
##
# The store the file should exist in
attr_reader :store
##
# The file the #name should be saved as
attr_reader :file
##
# The name of the object the #file would be loaded from
attr_reader :name
##
# Creates a new MissingFileError for the missing +file+ for the given
# +name+ that should have been in the +store+.
def initialize store, file, name
@store = store
@file = file
@name = name
end
def message # :nodoc:
"store at #{@store.path} missing file #{@file} for #{@name}"
end
end
##
# Stores the name of the C variable a class belongs to. This helps wire up
# classes defined from C across files.
attr_reader :c_enclosure_classes # :nodoc:
attr_reader :c_enclosure_names # :nodoc:
##
# Maps C variables to class or module names for each parsed C file.
attr_reader :c_class_variables
##
# Maps C variables to singleton class names for each parsed C file.
attr_reader :c_singleton_class_variables
##
# If true this Store will not write any files
attr_accessor :dry_run
##
# Path this store reads or writes
attr_accessor :path
##
# The RDoc::RDoc driver for this parse tree. This allows classes consulting
# the documentation tree to access user-set options, for example.
attr_accessor :rdoc
##
# Type of ri datastore this was loaded from. See RDoc::RI::Driver,
# RDoc::RI::Paths.
attr_accessor :type
##
# The contents of the Store
attr_reader :cache
##
# The encoding of the contents in the Store
attr_accessor :encoding
##
# The lazy constants alias will be discovered in passing
attr_reader :unmatched_constant_alias
##
# Creates a new Store of +type+ that will load or save to +path+
def initialize path = nil, type = nil
@dry_run = false
@encoding = nil
@path = path
@rdoc = nil
@type = type
@cache = {
:ancestors => {},
:attributes => {},
:class_methods => {},
:c_class_variables => {},
:c_singleton_class_variables => {},
:encoding => @encoding,
:instance_methods => {},
:main => nil,
:modules => [],
:pages => [],
:title => nil,
}
@classes_hash = {}
@modules_hash = {}
@files_hash = {}
@text_files_hash = {}
@c_enclosure_classes = {}
@c_enclosure_names = {}
@c_class_variables = {}
@c_singleton_class_variables = {}
@unique_classes = nil
@unique_modules = nil
@unmatched_constant_alias = {}
end
##
# Adds +module+ as an enclosure (namespace) for the given +variable+ for C
# files.
def add_c_enclosure variable, namespace
@c_enclosure_classes[variable] = namespace
end
##
# Adds C variables from an RDoc::Parser::C
def add_c_variables c_parser
filename = c_parser.top_level.relative_name
@c_class_variables[filename] = make_variable_map c_parser.classes
@c_singleton_class_variables[filename] = c_parser.singleton_classes
end
##
# Adds the file with +name+ as an RDoc::TopLevel to the store. Returns the
# created RDoc::TopLevel.
def add_file absolute_name, relative_name: absolute_name, parser: nil
unless top_level = @files_hash[relative_name] then
top_level = RDoc::TopLevel.new absolute_name, relative_name
top_level.parser = parser if parser
top_level.store = self
@files_hash[relative_name] = top_level
@text_files_hash[relative_name] = top_level if top_level.text?
end
top_level
end
##
# Sets the parser of +absolute_name+, unless it from a source code file.
def update_parser_of_file(absolute_name, parser)
if top_level = @files_hash[absolute_name] then
@text_files_hash[absolute_name] = top_level if top_level.text?
end
end
##
# Returns all classes discovered by RDoc
def all_classes
@classes_hash.values
end
##
# Returns all classes and modules discovered by RDoc
def all_classes_and_modules
@classes_hash.values + @modules_hash.values
end
##
# All TopLevels known to RDoc
def all_files
@files_hash.values
end
##
# Returns all modules discovered by RDoc
def all_modules
modules_hash.values
end
##
# Ancestors cache accessor. Maps a klass name to an Array of its ancestors
# in this store. If Foo in this store inherits from Object, Kernel won't be
# listed (it will be included from ruby's ri store).
def ancestors
@cache[:ancestors]
end
##
# Attributes cache accessor. Maps a class to an Array of its attributes.
def attributes
@cache[:attributes]
end
##
# Path to the cache file
def cache_path
File.join @path, 'cache.ri'
end
##
# Path to the ri data for +klass_name+
def class_file klass_name
name = klass_name.split('::').last
File.join class_path(klass_name), "cdesc-#{name}.ri"
end
##
# Class methods cache accessor. Maps a class to an Array of its class
# methods (not full name).
def class_methods
@cache[:class_methods]
end
##
# Path where data for +klass_name+ will be stored (methods or class data)
def class_path klass_name
File.join @path, *klass_name.split('::')
end
##
# Hash of all classes known to RDoc
def classes_hash
@classes_hash
end
##
# Removes empty items and ensures item in each collection are unique and
# sorted
def clean_cache_collection collection # :nodoc:
collection.each do |name, item|
if item.empty? then
collection.delete name
else
# HACK mongrel-1.1.5 documents its files twice
item.uniq!
item.sort!
end
end
end
##
# Prepares the RDoc code object tree for use by a generator.
#
# It finds unique classes/modules defined, and replaces classes/modules that
# are aliases for another one by a copy with RDoc::ClassModule#is_alias_for
# set.
#
# It updates the RDoc::ClassModule#constant_aliases attribute of "real"
# classes or modules.
#
# It also completely removes the classes and modules that should be removed
# from the documentation and the methods that have a visibility below
# +min_visibility+, which is the <tt>--visibility</tt> option.
#
# See also RDoc::Context#remove_from_documentation?
def complete min_visibility
fix_basic_object_inheritance
# cache included modules before they are removed from the documentation
all_classes_and_modules.each { |cm| cm.ancestors }
unless min_visibility == :nodoc then
remove_nodoc @classes_hash
remove_nodoc @modules_hash
end
@unique_classes = find_unique @classes_hash
@unique_modules = find_unique @modules_hash
unique_classes_and_modules.each do |cm|
cm.complete min_visibility
end
@files_hash.each_key do |file_name|
tl = @files_hash[file_name]
unless tl.text? then
tl.modules_hash.clear
tl.classes_hash.clear
tl.classes_or_modules.each do |cm|
name = cm.full_name
if cm.type == 'class' then
tl.classes_hash[name] = cm if @classes_hash[name]
else
tl.modules_hash[name] = cm if @modules_hash[name]
end
end
end
end
end
##
# Hash of all files known to RDoc
def files_hash
@files_hash
end
##
# Finds the enclosure (namespace) for the given C +variable+.
def find_c_enclosure variable
@c_enclosure_classes.fetch variable do
break unless name = @c_enclosure_names[variable]
mod = find_class_or_module name
unless mod then
loaded_mod = load_class_data name
file = loaded_mod.in_files.first
return unless file # legacy data source
file.store = self
mod = file.add_module RDoc::NormalModule, name
end
@c_enclosure_classes[variable] = mod
end
end
##
# Finds the class with +name+ in all discovered classes
def find_class_named name
@classes_hash[name]
end
##
# Finds the class with +name+ starting in namespace +from+
def find_class_named_from name, from
from = find_class_named from unless RDoc::Context === from
until RDoc::TopLevel === from do
return nil unless from
klass = from.find_class_named name
return klass if klass
from = from.parent
end
find_class_named name
end
##
# Finds the class or module with +name+
def find_class_or_module name
name = $' if name =~ /^::/
@classes_hash[name] || @modules_hash[name]
end
##
# Finds the file with +name+ in all discovered files
def find_file_named name
@files_hash[name]
end
##
# Finds the module with +name+ in all discovered modules
def find_module_named name
@modules_hash[name]
end
##
# Returns the RDoc::TopLevel that is a text file and has the given
# +file_name+
def find_text_page file_name
@text_files_hash.each_value.find do |file|
file.full_name == file_name
end
end
##
# Finds unique classes/modules defined in +all_hash+,
# and returns them as an array. Performs the alias
# updates in +all_hash+: see ::complete.
#--
# TODO aliases should be registered by Context#add_module_alias
def find_unique all_hash
unique = []
all_hash.each_pair do |full_name, cm|
unique << cm if full_name == cm.full_name
end
unique
end
##
# Fixes the erroneous <tt>BasicObject < Object</tt> in 1.9.
#
# Because we assumed all classes without a stated superclass
# inherit from Object, we have the above wrong inheritance.
#
# We fix BasicObject right away if we are running in a Ruby
# version >= 1.9.
def fix_basic_object_inheritance
basic = classes_hash['BasicObject']
return unless basic
basic.superclass = nil
end
##
# Friendly rendition of #path
def friendly_path
case type
when :gem then
parent = File.expand_path '..', @path
"gem #{File.basename parent}"
when :home then RDoc.home
when :site then 'ruby site'
when :system then 'ruby core'
else @path
end
end
def inspect # :nodoc:
"#<%s:0x%x %s %p>" % [self.class, object_id, @path, module_names.sort]
end
##
# Instance methods cache accessor. Maps a class to an Array of its
# instance methods (not full name).
def instance_methods
@cache[:instance_methods]
end
##
# Loads all items from this store into memory. This recreates a
# documentation tree for use by a generator
def load_all
load_cache
module_names.each do |module_name|
mod = find_class_or_module(module_name) || load_class(module_name)
# load method documentation since the loaded class/module does not have
# it
loaded_methods = mod.method_list.map do |method|
load_method module_name, method.full_name
end
mod.method_list.replace loaded_methods
loaded_attributes = mod.attributes.map do |attribute|
load_method module_name, attribute.full_name
end
mod.attributes.replace loaded_attributes
end
all_classes_and_modules.each do |mod|
descendent_re = /^#{mod.full_name}::[^:]+$/
module_names.each do |name|
next unless name =~ descendent_re
descendent = find_class_or_module name
case descendent
when RDoc::NormalClass then
mod.classes_hash[name] = descendent
when RDoc::NormalModule then
mod.modules_hash[name] = descendent
end
end
end
@cache[:pages].each do |page_name|
page = load_page page_name
@files_hash[page_name] = page
@text_files_hash[page_name] = page if page.text?
end
end
##
# Loads cache file for this store
def load_cache
#orig_enc = @encoding
@cache = marshal_load(cache_path)
load_enc = @cache[:encoding]
# TODO this feature will be time-consuming to add:
# a) Encodings may be incompatible but transcodeable
# b) Need to warn in the appropriate spots, wherever they may be
# c) Need to handle cross-cache differences in encodings
# d) Need to warn when generating into a cache with different encodings
#
#if orig_enc and load_enc != orig_enc then
# warn "Cached encoding #{load_enc} is incompatible with #{orig_enc}\n" \
# "from #{path}/cache.ri" unless
# Encoding.compatible? orig_enc, load_enc
#end
@encoding = load_enc unless @encoding
@cache[:pages] ||= []
@cache[:main] ||= nil
@cache[:c_class_variables] ||= {}
@cache[:c_singleton_class_variables] ||= {}
@cache[:c_class_variables].each do |_, map|
map.each do |variable, name|
@c_enclosure_names[variable] = name
end
end
@cache
rescue Errno::ENOENT
end
##
# Loads ri data for +klass_name+ and hooks it up to this store.
def load_class klass_name
obj = load_class_data klass_name
obj.store = self
case obj
when RDoc::NormalClass then
@classes_hash[klass_name] = obj
when RDoc::SingleClass then
@classes_hash[klass_name] = obj
when RDoc::NormalModule then
@modules_hash[klass_name] = obj
end
end
##
# Loads ri data for +klass_name+
def load_class_data klass_name
file = class_file klass_name
marshal_load(file)
rescue Errno::ENOENT => e
error = MissingFileError.new(self, file, klass_name)
error.set_backtrace e.backtrace
raise error
end
##
# Loads ri data for +method_name+ in +klass_name+
def load_method klass_name, method_name
file = method_file klass_name, method_name
obj = marshal_load(file)
obj.store = self
obj.parent ||= find_class_or_module(klass_name) || load_class(klass_name)
obj
rescue Errno::ENOENT => e
error = MissingFileError.new(self, file, klass_name + method_name)
error.set_backtrace e.backtrace
raise error
end
##
# Loads ri data for +page_name+
def load_page page_name
file = page_file page_name
obj = marshal_load(file)
obj.store = self
obj
rescue Errno::ENOENT => e
error = MissingFileError.new(self, file, page_name)
error.set_backtrace e.backtrace
raise error
end
##
# Gets the main page for this RDoc store. This page is used as the root of
# the RDoc server.
def main
@cache[:main]
end
##
# Sets the main page for this RDoc store.
def main= page
@cache[:main] = page
end
##
# Converts the variable => ClassModule map +variables+ from a C parser into
# a variable => class name map.
def make_variable_map variables
map = {}
variables.each { |variable, class_module|
map[variable] = class_module.full_name
}
map
end
##
# Path to the ri data for +method_name+ in +klass_name+
def method_file klass_name, method_name
method_name = method_name.split('::').last
method_name =~ /#(.*)/
method_type = $1 ? 'i' : 'c'
method_name = $1 if $1
method_name = method_name.gsub(/\W/) { "%%%02x" % $&[0].ord }
File.join class_path(klass_name), "#{method_name}-#{method_type}.ri"
end
##
# Modules cache accessor. An Array of all the module (and class) names in
# the store.
def module_names
@cache[:modules]
end
##
# Hash of all modules known to RDoc
def modules_hash
@modules_hash
end
##
# Returns the RDoc::TopLevel that is a text file and has the given +name+
def page name
@text_files_hash.each_value.find do |file|
file.page_name == name or file.base_name == name
end
end
##
# Path to the ri data for +page_name+
def page_file page_name
file_name = File.basename(page_name).gsub('.', '_')
File.join @path, File.dirname(page_name), "page-#{file_name}.ri"
end
##
# Removes from +all_hash+ the contexts that are nodoc or have no content.
#
# See RDoc::Context#remove_from_documentation?
def remove_nodoc all_hash
all_hash.keys.each do |name|
context = all_hash[name]
all_hash.delete(name) if context.remove_from_documentation?
end
end
##
# Saves all entries in the store
def save
load_cache
all_classes_and_modules.each do |klass|
save_class klass
klass.each_method do |method|
save_method klass, method
end
klass.each_attribute do |attribute|
save_method klass, attribute
end
end
all_files.each do |file|
save_page file
end
save_cache
end
##
# Writes the cache file for this store
def save_cache
clean_cache_collection @cache[:ancestors]
clean_cache_collection @cache[:attributes]
clean_cache_collection @cache[:class_methods]
clean_cache_collection @cache[:instance_methods]
@cache[:modules].uniq!
@cache[:modules].sort!
@cache[:pages].uniq!
@cache[:pages].sort!
@cache[:encoding] = @encoding # this gets set twice due to assert_cache
@cache[:c_class_variables].merge! @c_class_variables
@cache[:c_singleton_class_variables].merge! @c_singleton_class_variables
return if @dry_run
File.open cache_path, 'wb' do |io|
Marshal.dump @cache, io
end
end
##
# Writes the ri data for +klass+ (or module)
def save_class klass
full_name = klass.full_name
FileUtils.mkdir_p class_path(full_name) unless @dry_run
@cache[:modules] << full_name
path = class_file full_name
begin
disk_klass = load_class full_name
klass = disk_klass.merge klass
rescue MissingFileError
end
# BasicObject has no ancestors
ancestors = klass.direct_ancestors.compact.map do |ancestor|
# HACK for classes we don't know about (class X < RuntimeError)
String === ancestor ? ancestor : ancestor.full_name
end
@cache[:ancestors][full_name] ||= []
@cache[:ancestors][full_name].concat ancestors
attribute_definitions = klass.attributes.map do |attribute|
"#{attribute.definition} #{attribute.name}"
end
unless attribute_definitions.empty? then
@cache[:attributes][full_name] ||= []
@cache[:attributes][full_name].concat attribute_definitions
end
to_delete = []
unless klass.method_list.empty? then
@cache[:class_methods][full_name] ||= []
@cache[:instance_methods][full_name] ||= []
class_methods, instance_methods =
klass.method_list.partition { |meth| meth.singleton }
class_methods = class_methods. map { |method| method.name }
instance_methods = instance_methods.map { |method| method.name }
attribute_names = klass.attributes.map { |attr| attr.name }
old = @cache[:class_methods][full_name] - class_methods
to_delete.concat old.map { |method|
method_file full_name, "#{full_name}::#{method}"
}
old = @cache[:instance_methods][full_name] -
instance_methods - attribute_names
to_delete.concat old.map { |method|
method_file full_name, "#{full_name}##{method}"
}
@cache[:class_methods][full_name] = class_methods
@cache[:instance_methods][full_name] = instance_methods
end
return if @dry_run
FileUtils.rm_f to_delete
File.open path, 'wb' do |io|
Marshal.dump klass, io
end
end
##
# Writes the ri data for +method+ on +klass+
def save_method klass, method
full_name = klass.full_name
FileUtils.mkdir_p class_path(full_name) unless @dry_run
cache = if method.singleton then
@cache[:class_methods]
else
@cache[:instance_methods]
end
cache[full_name] ||= []
cache[full_name] << method.name
return if @dry_run
File.open method_file(full_name, method.full_name), 'wb' do |io|
Marshal.dump method, io
end
end
##
# Writes the ri data for +page+
def save_page page
return unless page.text?
path = page_file page.full_name
FileUtils.mkdir_p File.dirname(path) unless @dry_run
cache[:pages] ||= []
cache[:pages] << page.full_name
return if @dry_run
File.open path, 'wb' do |io|
Marshal.dump page, io
end
end
##
# Source of the contents of this store.
#
# For a store from a gem the source is the gem name. For a store from the
# home directory the source is "home". For system ri store (the standard
# library documentation) the source is"ruby". For a store from the site
# ri directory the store is "site". For other stores the source is the
# #path.
def source
case type
when :gem then File.basename File.expand_path '..', @path
when :home then 'home'
when :site then 'site'
when :system then 'ruby'
else @path
end
end
##
# Gets the title for this RDoc store. This is used as the title in each
# page on the RDoc server
def title
@cache[:title]
end
##
# Sets the title page for this RDoc store.
def title= title
@cache[:title] = title
end
##
# Returns the unique classes discovered by RDoc.
#
# ::complete must have been called prior to using this method.
def unique_classes
@unique_classes
end
##
# Returns the unique classes and modules discovered by RDoc.
# ::complete must have been called prior to using this method.
def unique_classes_and_modules
@unique_classes + @unique_modules
end
##
# Returns the unique modules discovered by RDoc.
# ::complete must have been called prior to using this method.
def unique_modules
@unique_modules
end
private
def marshal_load(file)
File.open(file, 'rb') {|io| Marshal.load(io, MarshalFilter)}
end
MarshalFilter = proc do |obj|
case obj
when true, false, nil, Array, Class, Encoding, Hash, Integer, String, Symbol, RDoc::Text
else
unless obj.class.name.start_with?("RDoc::")
raise TypeError, "not permitted class: #{obj.class.name}"
end
end
obj
end
private_constant :MarshalFilter
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/method_attr.rb 0000644 00000022047 15173517750 0015646 0 ustar 00 # frozen_string_literal: true
##
# Abstract class representing either a method or an attribute.
class RDoc::MethodAttr < RDoc::CodeObject
include Comparable
##
# Name of this method/attribute.
attr_accessor :name
##
# public, protected, private
attr_accessor :visibility
##
# Is this a singleton method/attribute?
attr_accessor :singleton
##
# Source file token stream
attr_reader :text
##
# Array of other names for this method/attribute
attr_reader :aliases
##
# The method/attribute we're aliasing
attr_accessor :is_alias_for
#--
# The attributes below are for AnyMethod only.
# They are left here for the time being to
# allow ri to operate.
# TODO modify ri to avoid calling these on attributes.
#++
##
# Parameters yielded by the called block
attr_reader :block_params
##
# Parameters for this method
attr_accessor :params
##
# Different ways to call this method
attr_accessor :call_seq
##
# The call_seq or the param_seq with method name, if there is no call_seq.
attr_reader :arglists
##
# Pretty parameter list for this method
attr_reader :param_seq
##
# Creates a new MethodAttr from token stream +text+ and method or attribute
# name +name+.
#
# Usually this is called by super from a subclass.
def initialize text, name
super()
@text = text
@name = name
@aliases = []
@is_alias_for = nil
@parent_name = nil
@singleton = nil
@visibility = :public
@see = false
@arglists = nil
@block_params = nil
@call_seq = nil
@param_seq = nil
@params = nil
end
##
# Resets cached data for the object so it can be rebuilt by accessor methods
def initialize_copy other # :nodoc:
@full_name = nil
end
def initialize_visibility # :nodoc:
super
@see = nil
end
##
# Order by #singleton then #name
def <=>(other)
return unless other.respond_to?(:singleton) &&
other.respond_to?(:name)
[ @singleton ? 0 : 1, name] <=>
[other.singleton ? 0 : 1, other.name]
end
def == other # :nodoc:
equal?(other) or self.class == other.class and full_name == other.full_name
end
##
# A method/attribute is documented if any of the following is true:
# - it was marked with :nodoc:;
# - it has a comment;
# - it is an alias for a documented method;
# - it has a +#see+ method that is documented.
def documented?
super or
(is_alias_for and is_alias_for.documented?) or
(see and see.documented?)
end
##
# A method/attribute to look at,
# in particular if this method/attribute has no documentation.
#
# It can be a method/attribute of the superclass or of an included module,
# including the Kernel module, which is always appended to the included
# modules.
#
# Returns +nil+ if there is no such method/attribute.
# The +#is_alias_for+ method/attribute, if any, is not included.
#
# Templates may generate a "see also ..." if this method/attribute
# has documentation, and "see ..." if it does not.
def see
@see = find_see if @see == false
@see
end
##
# Sets the store for this class or module and its contained code objects.
def store= store
super
@file = @store.add_file @file.full_name if @file
end
def find_see # :nodoc:
return nil if singleton || is_alias_for
# look for the method
other = find_method_or_attribute name
return other if other
# if it is a setter, look for a getter
return nil unless name =~ /[a-z_]=$/i # avoid == or ===
return find_method_or_attribute name[0..-2]
end
def find_method_or_attribute name # :nodoc:
return nil unless parent.respond_to? :ancestors
searched = parent.ancestors
kernel = @store.modules_hash['Kernel']
searched << kernel if kernel &&
parent != kernel && !searched.include?(kernel)
searched.each do |ancestor|
next if String === ancestor
next if parent == ancestor
other = ancestor.find_method_named('#' + name) ||
ancestor.find_attribute_named(name)
return other if other
end
nil
end
##
# Abstract method. Contexts in their building phase call this
# to register a new alias for this known method/attribute.
#
# - creates a new AnyMethod/Attribute named <tt>an_alias.new_name</tt>;
# - adds +self+ as an alias for the new method or attribute
# - adds the method or attribute to #aliases
# - adds the method or attribute to +context+.
def add_alias(an_alias, context)
raise NotImplementedError
end
##
# HTML fragment reference for this method
def aref
type = singleton ? 'c' : 'i'
# % characters are not allowed in html names => dash instead
"#{aref_prefix}-#{type}-#{html_name}"
end
##
# Prefix for +aref+, defined by subclasses.
def aref_prefix
raise NotImplementedError
end
##
# Attempts to sanitize the content passed by the Ruby parser:
# remove outer parentheses, etc.
def block_params=(value)
# 'yield.to_s' or 'assert yield, msg'
return @block_params = '' if value =~ /^[\.,]/
# remove trailing 'if/unless ...'
return @block_params = '' if value =~ /^(if|unless)\s/
value = $1.strip if value =~ /^(.+)\s(if|unless)\s/
# outer parentheses
value = $1 if value =~ /^\s*\((.*)\)\s*$/
value = value.strip
# proc/lambda
return @block_params = $1 if value =~ /^(proc|lambda)(\s*\{|\sdo)/
# surrounding +...+ or [...]
value = $1.strip if value =~ /^\+(.*)\+$/
value = $1.strip if value =~ /^\[(.*)\]$/
return @block_params = '' if value.empty?
# global variable
return @block_params = 'str' if value =~ /^\$[&0-9]$/
# wipe out array/hash indices
value.gsub!(/(\w)\[[^\[]+\]/, '\1')
# remove @ from class/instance variables
value.gsub!(/@@?([a-z0-9_]+)/, '\1')
# method calls => method name
value.gsub!(/([A-Z:a-z0-9_]+)\.([a-z0-9_]+)(\s*\(\s*[a-z0-9_.,\s]*\s*\)\s*)?/) do
case $2
when 'to_s' then $1
when 'const_get' then 'const'
when 'new' then
$1.split('::').last. # ClassName => class_name
gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
gsub(/([a-z\d])([A-Z])/,'\1_\2').
downcase
else
$2
end
end
# class prefixes
value.gsub!(/[A-Za-z0-9_:]+::/, '')
# simple expressions
value = $1 if value =~ /^([a-z0-9_]+)\s*[-*+\/]/
@block_params = value.strip
end
##
# HTML id-friendly method/attribute name
def html_name
require 'cgi/util'
CGI.escape(@name.gsub('-', '-2D')).gsub('%','-').sub(/^-/, '')
end
##
# Full method/attribute name including namespace
def full_name
@full_name ||= "#{parent_name}#{pretty_name}"
end
def inspect # :nodoc:
alias_for = @is_alias_for ? " (alias for #{@is_alias_for.name})" : nil
visibility = self.visibility
visibility = "forced #{visibility}" if force_documentation
"#<%s:0x%x %s (%s)%s>" % [
self.class, object_id,
full_name,
visibility,
alias_for,
]
end
##
# '::' for a class method/attribute, '#' for an instance method.
def name_prefix
@singleton ? '::' : '#'
end
##
# Name for output to HTML. For class methods the full name with a "." is
# used like +SomeClass.method_name+. For instance methods the class name is
# used if +context+ does not match the parent.
#
# This is to help prevent people from using :: to call class methods.
def output_name context
return "#{name_prefix}#{@name}" if context == parent
"#{parent_name}#{@singleton ? '.' : '#'}#{@name}"
end
##
# Method/attribute name with class/instance indicator
def pretty_name
"#{name_prefix}#{@name}"
end
##
# Type of method/attribute (class or instance)
def type
singleton ? 'class' : 'instance'
end
##
# Path to this method for use with HTML generator output.
def path
"#{@parent.path}##{aref}"
end
##
# Name of our parent with special handling for un-marshaled methods
def parent_name
@parent_name || super
end
def pretty_print q # :nodoc:
alias_for =
if @is_alias_for.respond_to? :name then
"alias for #{@is_alias_for.name}"
elsif Array === @is_alias_for then
"alias for #{@is_alias_for.last}"
end
q.group 2, "[#{self.class.name} #{full_name} #{visibility}", "]" do
if alias_for then
q.breakable
q.text alias_for
end
if text then
q.breakable
q.text "text:"
q.breakable
q.pp @text
end
unless comment.empty? then
q.breakable
q.text "comment:"
q.breakable
q.pp @comment
end
end
end
##
# Used by RDoc::Generator::JsonIndex to create a record for the search
# engine.
def search_record
[
@name,
full_name,
@name,
@parent.full_name,
path,
params,
snippet(@comment),
]
end
def to_s # :nodoc:
if @is_alias_for
"#{self.class.name}: #{full_name} -> #{is_alias_for}"
else
"#{self.class.name}: #{full_name}"
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/encoding.rb 0000644 00000006577 15173517750 0015134 0 ustar 00 # coding: US-ASCII
# frozen_string_literal: true
##
# This class is a wrapper around File IO and Encoding that helps RDoc load
# files and convert them to the correct encoding.
module RDoc::Encoding
HEADER_REGEXP = /^
(?:
\A\#!.*\n
|
^\#\s+frozen[-_]string[-_]literal[=:].+\n
|
^\#[^\n]+\b(?:en)?coding[=:]\s*(?<name>[^\s;]+).*\n
|
<\?xml[^?]*encoding=(?<quote>["'])(?<name>.*?)\k<quote>.*\n
)+
/xi # :nodoc:
##
# Reads the contents of +filename+ and handles any encoding directives in
# the file.
#
# The content will be converted to the +encoding+. If the file cannot be
# converted a warning will be printed and nil will be returned.
#
# If +force_transcode+ is true the document will be transcoded and any
# unknown character in the target encoding will be replaced with '?'
def self.read_file filename, encoding, force_transcode = false
content = File.open filename, "rb" do |f| f.read end
content.gsub!("\r\n", "\n") if RUBY_PLATFORM =~ /mswin|mingw/
utf8 = content.sub!(/\A\xef\xbb\xbf/, '')
enc = RDoc::Encoding.detect_encoding content
content = RDoc::Encoding.change_encoding content, enc if enc
begin
encoding ||= Encoding.default_external
orig_encoding = content.encoding
if not orig_encoding.ascii_compatible? then
content = content.encode encoding
elsif utf8 then
content = RDoc::Encoding.change_encoding content, Encoding::UTF_8
content = content.encode encoding
else
# assume the content is in our output encoding
content = RDoc::Encoding.change_encoding content, encoding
end
unless content.valid_encoding? then
# revert and try to transcode
content = RDoc::Encoding.change_encoding content, orig_encoding
content = content.encode encoding
end
unless content.valid_encoding? then
warn "unable to convert #{filename} to #{encoding}, skipping"
content = nil
end
rescue Encoding::InvalidByteSequenceError,
Encoding::UndefinedConversionError => e
if force_transcode then
content = RDoc::Encoding.change_encoding content, orig_encoding
content = content.encode(encoding,
:invalid => :replace,
:undef => :replace,
:replace => '?')
return content
else
warn "unable to convert #{e.message} for #{filename}, skipping"
return nil
end
end
content
rescue ArgumentError => e
raise unless e.message =~ /unknown encoding name - (.*)/
warn "unknown encoding name \"#{$1}\" for #{filename}, skipping"
nil
rescue Errno::EISDIR, Errno::ENOENT
nil
end
##
# Detects the encoding of +string+ based on the magic comment
def self.detect_encoding string
result = HEADER_REGEXP.match string
name = result && result[:name]
name ? Encoding.find(name) : nil
end
##
# Removes magic comments and shebang
def self.remove_magic_comment string
string.sub HEADER_REGEXP do |s|
s.gsub(/[^\n]/, '')
end
end
##
# Changes encoding based on +encoding+ without converting and returns new
# string
def self.change_encoding text, encoding
if text.kind_of? RDoc::Comment
text.encode! encoding
else
String.new text, encoding: encoding
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/ruby_tools.rb 0000644 00000005204 15173517750 0017025 0 ustar 00 # frozen_string_literal: true
##
# Collection of methods for writing parsers
module RDoc::Parser::RubyTools
##
# Adds a token listener +obj+, but you should probably use token_listener
def add_token_listener(obj)
@token_listeners ||= []
@token_listeners << obj
end
##
# Fetches the next token from the scanner
def get_tk
tk = nil
if @tokens.empty? then
if @scanner_point >= @scanner.size
return nil
else
tk = @scanner[@scanner_point]
@scanner_point += 1
@read.push tk[:text]
end
else
@read.push @unget_read.shift
tk = @tokens.shift
end
if tk == nil || :on___end__ == tk[:kind]
tk = nil
end
return nil unless tk
# inform any listeners of our shiny new token
@token_listeners.each do |obj|
obj.add_token(tk)
end if @token_listeners
tk
end
##
# Reads and returns all tokens up to one of +tokens+. Leaves the matched
# token in the token list.
def get_tk_until(*tokens)
read = []
loop do
tk = get_tk
case tk
when *tokens then
unget_tk tk
break
end
read << tk
end
read
end
##
# Retrieves a String representation of the read tokens
def get_tkread
read = @read.join("")
@read = []
read
end
##
# Peek equivalent for get_tkread
def peek_read
@read.join('')
end
##
# Peek at the next token, but don't remove it from the stream
def peek_tk
unget_tk(tk = get_tk)
tk
end
##
# Removes the token listener +obj+
def remove_token_listener(obj)
@token_listeners.delete(obj)
end
##
# Resets the tools
def reset
@read = []
@tokens = []
@unget_read = []
@nest = 0
@scanner_point = 0
end
##
# Skips whitespace tokens including newlines
def skip_tkspace
tokens = []
while (tk = get_tk) and (:on_sp == tk[:kind] or :on_nl == tk[:kind] or :on_ignored_nl == tk[:kind]) do
tokens.push(tk)
end
unget_tk(tk)
tokens
end
##
# Skips whitespace tokens excluding newlines
def skip_tkspace_without_nl
tokens = []
while (tk = get_tk) and :on_sp == tk[:kind] do
tokens.push(tk)
end
unget_tk(tk)
tokens
end
##
# Has +obj+ listen to tokens
def token_listener(obj)
add_token_listener obj
yield
ensure
remove_token_listener obj
end
##
# Returns +tk+ to the scanner
def unget_tk(tk)
@tokens.unshift tk
@unget_read.unshift @read.pop
# Remove this token from any listeners
@token_listeners.each do |obj|
obj.pop_token
end if @token_listeners
nil
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/text.rb 0000644 00000000462 15173517750 0015611 0 ustar 00 # frozen_string_literal: true
##
# Indicates this parser is text and doesn't contain code constructs.
#
# Include this module in a RDoc::Parser subclass to make it show up as a file,
# not as part of a class or module.
#--
# This is not named File to avoid overriding ::File
module RDoc::Parser::Text
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/ripper_state_lex.rb 0000644 00000037661 15173517750 0020211 0 ustar 00 # frozen_string_literal: true
require 'ripper'
##
# Wrapper for Ripper lex states
class RDoc::Parser::RipperStateLex
# :stopdoc:
# TODO: Remove this constants after Ruby 2.4 EOL
RIPPER_HAS_LEX_STATE = Ripper::Filter.method_defined?(:state)
Token = Struct.new(:line_no, :char_no, :kind, :text, :state)
EXPR_NONE = 0
EXPR_BEG = 1
EXPR_END = 2
EXPR_ENDARG = 4
EXPR_ENDFN = 8
EXPR_ARG = 16
EXPR_CMDARG = 32
EXPR_MID = 64
EXPR_FNAME = 128
EXPR_DOT = 256
EXPR_CLASS = 512
EXPR_LABEL = 1024
EXPR_LABELED = 2048
EXPR_FITEM = 4096
EXPR_VALUE = EXPR_BEG
EXPR_BEG_ANY = (EXPR_BEG | EXPR_MID | EXPR_CLASS)
EXPR_ARG_ANY = (EXPR_ARG | EXPR_CMDARG)
EXPR_END_ANY = (EXPR_END | EXPR_ENDARG | EXPR_ENDFN)
class InnerStateLex < Ripper::Filter
attr_accessor :lex_state
def initialize(code)
@lex_state = EXPR_BEG
@in_fname = false
@continue = false
reset
super(code)
end
def reset
@command_start = false
@cmd_state = @command_start
end
def on_nl(tok, data)
case @lex_state
when EXPR_FNAME, EXPR_DOT
@continue = true
else
@continue = false
@lex_state = EXPR_BEG unless (EXPR_LABEL & @lex_state) != 0
end
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_ignored_nl(tok, data)
case @lex_state
when EXPR_FNAME, EXPR_DOT
@continue = true
else
@continue = false
@lex_state = EXPR_BEG unless (EXPR_LABEL & @lex_state) != 0
end
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_op(tok, data)
case tok
when '&', '|', '!', '!=', '!~'
case @lex_state
when EXPR_FNAME, EXPR_DOT
@lex_state = EXPR_ARG
else
@lex_state = EXPR_BEG
end
when '<<'
# TODO next token?
case @lex_state
when EXPR_FNAME, EXPR_DOT
@lex_state = EXPR_ARG
else
@lex_state = EXPR_BEG
end
when '?'
@lex_state = EXPR_BEG
when '&&', '||', '+=', '-=', '*=', '**=',
'&=', '|=', '^=', '<<=', '>>=', '||=', '&&='
@lex_state = EXPR_BEG
when '::'
case @lex_state
when EXPR_ARG, EXPR_CMDARG
@lex_state = EXPR_DOT
when EXPR_FNAME, EXPR_DOT
@lex_state = EXPR_ARG
else
@lex_state = EXPR_BEG
end
else
case @lex_state
when EXPR_FNAME, EXPR_DOT
@lex_state = EXPR_ARG
else
@lex_state = EXPR_BEG
end
end
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_kw(tok, data)
case tok
when 'class'
@lex_state = EXPR_CLASS
@in_fname = true
when 'def'
@lex_state = EXPR_FNAME
@continue = true
@in_fname = true
when 'if', 'unless', 'while', 'until'
if ((EXPR_MID | EXPR_END | EXPR_ENDARG | EXPR_ENDFN | EXPR_ARG | EXPR_CMDARG) & @lex_state) != 0 # postfix if
@lex_state = EXPR_BEG | EXPR_LABEL
else
@lex_state = EXPR_BEG
end
when 'begin', 'case', 'when'
@lex_state = EXPR_BEG
when 'return', 'break'
@lex_state = EXPR_MID
else
if @lex_state == EXPR_FNAME
@lex_state = EXPR_END
else
@lex_state = EXPR_END
end
end
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_tstring_beg(tok, data)
@lex_state = EXPR_BEG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_tstring_end(tok, data)
@lex_state = EXPR_END | EXPR_ENDARG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_CHAR(tok, data)
@lex_state = EXPR_END
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_period(tok, data)
@lex_state = EXPR_DOT
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_int(tok, data)
@lex_state = EXPR_END | EXPR_ENDARG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_float(tok, data)
@lex_state = EXPR_END | EXPR_ENDARG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_rational(tok, data)
@lex_state = EXPR_END | EXPR_ENDARG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_imaginary(tok, data)
@lex_state = EXPR_END | EXPR_ENDARG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_symbeg(tok, data)
@lex_state = EXPR_FNAME
@continue = true
@in_fname = true
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
private def on_variables(event, tok, data)
if @in_fname
@lex_state = EXPR_ENDFN
@in_fname = false
@continue = false
elsif @continue
case @lex_state
when EXPR_DOT
@lex_state = EXPR_ARG
else
@lex_state = EXPR_ENDFN
@continue = false
end
else
@lex_state = EXPR_CMDARG
end
data << Token.new(lineno, column, event, tok, @lex_state)
end
def on_ident(tok, data)
on_variables(__method__, tok, data)
end
def on_ivar(tok, data)
@lex_state = EXPR_END
on_variables(__method__, tok, data)
end
def on_cvar(tok, data)
@lex_state = EXPR_END
on_variables(__method__, tok, data)
end
def on_gvar(tok, data)
@lex_state = EXPR_END
on_variables(__method__, tok, data)
end
def on_backref(tok, data)
@lex_state = EXPR_END
on_variables(__method__, tok, data)
end
def on_lparen(tok, data)
@lex_state = EXPR_LABEL | EXPR_BEG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_rparen(tok, data)
@lex_state = EXPR_ENDFN
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_lbrace(tok, data)
@lex_state = EXPR_LABEL | EXPR_BEG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_rbrace(tok, data)
@lex_state = EXPR_ENDARG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_lbracket(tok, data)
@lex_state = EXPR_LABEL | EXPR_BEG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_rbracket(tok, data)
@lex_state = EXPR_ENDARG
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_const(tok, data)
case @lex_state
when EXPR_FNAME
@lex_state = EXPR_ENDFN
when EXPR_CLASS, EXPR_CMDARG, EXPR_MID
@lex_state = EXPR_ARG
else
@lex_state = EXPR_CMDARG
end
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_sp(tok, data)
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_comma(tok, data)
@lex_state = EXPR_BEG | EXPR_LABEL if (EXPR_ARG_ANY & @lex_state) != 0
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_comment(tok, data)
@lex_state = EXPR_BEG unless (EXPR_LABEL & @lex_state) != 0
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_ignored_sp(tok, data)
@lex_state = EXPR_BEG unless (EXPR_LABEL & @lex_state) != 0
data << Token.new(lineno, column, __method__, tok, @lex_state)
end
def on_heredoc_beg(tok, data)
data << Token.new(lineno, column, __method__, tok, @lex_state)
@lex_state = EXPR_END
data
end
def on_heredoc_end(tok, data)
data << Token.new(lineno, column, __method__, tok, @lex_state)
@lex_state = EXPR_BEG
data
end
def on_default(event, tok, data)
reset
data << Token.new(lineno, column, event, tok, @lex_state)
end
end unless RIPPER_HAS_LEX_STATE
class InnerStateLex < Ripper::Filter
def initialize(code)
super(code)
end
def on_default(event, tok, data)
data << Token.new(lineno, column, event, tok, state)
end
end if RIPPER_HAS_LEX_STATE
def get_squashed_tk
if @buf.empty?
tk = @tokens.shift
else
tk = @buf.shift
end
return nil if tk.nil?
case tk[:kind]
when :on_symbeg then
tk = get_symbol_tk(tk)
when :on_tstring_beg then
tk = get_string_tk(tk)
when :on_backtick then
if (tk[:state] & (EXPR_FNAME | EXPR_ENDFN)) != 0
@inner_lex.lex_state = EXPR_ARG unless RIPPER_HAS_LEX_STATE
tk[:kind] = :on_ident
tk[:state] = Ripper::Lexer.const_defined?(:State) ? Ripper::Lexer::State.new(EXPR_ARG) : EXPR_ARG
else
tk = get_string_tk(tk)
end
when :on_regexp_beg then
tk = get_regexp_tk(tk)
when :on_embdoc_beg then
tk = get_embdoc_tk(tk)
when :on_heredoc_beg then
@heredoc_queue << retrieve_heredoc_info(tk)
@inner_lex.lex_state = EXPR_END unless RIPPER_HAS_LEX_STATE
when :on_nl, :on_ignored_nl, :on_comment, :on_heredoc_end then
if !@heredoc_queue.empty?
get_heredoc_tk(*@heredoc_queue.shift)
elsif tk[:text].nil? # :on_ignored_nl sometimes gives nil
tk[:text] = ''
end
when :on_words_beg then
tk = get_words_tk(tk)
when :on_qwords_beg then
tk = get_words_tk(tk)
when :on_symbols_beg then
tk = get_words_tk(tk)
when :on_qsymbols_beg then
tk = get_words_tk(tk)
when :on_op then
if '&.' == tk[:text]
tk[:kind] = :on_period
else
tk = get_op_tk(tk)
end
end
tk
end
private def get_symbol_tk(tk)
is_symbol = true
symbol_tk = Token.new(tk.line_no, tk.char_no, :on_symbol)
if ":'" == tk[:text] or ':"' == tk[:text] or tk[:text].start_with?('%s')
tk1 = get_string_tk(tk)
symbol_tk[:text] = tk1[:text]
symbol_tk[:state] = tk1[:state]
else
case (tk1 = get_squashed_tk)[:kind]
when :on_ident
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
when :on_tstring_content
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = get_squashed_tk[:state] # skip :on_tstring_end
when :on_tstring_end
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
when :on_op
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
when :on_ivar
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
when :on_cvar
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
when :on_gvar
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
when :on_const
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
when :on_kw
symbol_tk[:text] = ":#{tk1[:text]}"
symbol_tk[:state] = tk1[:state]
else
is_symbol = false
tk = tk1
end
end
if is_symbol
tk = symbol_tk
end
tk
end
private def get_string_tk(tk)
string = tk[:text]
state = nil
kind = :on_tstring
loop do
inner_str_tk = get_squashed_tk
if inner_str_tk.nil?
break
elsif :on_tstring_end == inner_str_tk[:kind]
string = string + inner_str_tk[:text]
state = inner_str_tk[:state]
break
elsif :on_label_end == inner_str_tk[:kind]
string = string + inner_str_tk[:text]
state = inner_str_tk[:state]
kind = :on_symbol
break
else
string = string + inner_str_tk[:text]
if :on_embexpr_beg == inner_str_tk[:kind] then
kind = :on_dstring if :on_tstring == kind
end
end
end
Token.new(tk.line_no, tk.char_no, kind, string, state)
end
private def get_regexp_tk(tk)
string = tk[:text]
state = nil
loop do
inner_str_tk = get_squashed_tk
if inner_str_tk.nil?
break
elsif :on_regexp_end == inner_str_tk[:kind]
string = string + inner_str_tk[:text]
state = inner_str_tk[:state]
break
else
string = string + inner_str_tk[:text]
end
end
Token.new(tk.line_no, tk.char_no, :on_regexp, string, state)
end
private def get_embdoc_tk(tk)
string = tk[:text]
until :on_embdoc_end == (embdoc_tk = get_squashed_tk)[:kind] do
string = string + embdoc_tk[:text]
end
string = string + embdoc_tk[:text]
Token.new(tk.line_no, tk.char_no, :on_embdoc, string, embdoc_tk.state)
end
private def get_heredoc_tk(heredoc_name, indent)
string = ''
start_tk = nil
prev_tk = nil
until heredoc_end?(heredoc_name, indent, tk = @tokens.shift) do
start_tk = tk unless start_tk
if (prev_tk.nil? or "\n" == prev_tk[:text][-1]) and 0 != tk[:char_no]
string = string + (' ' * tk[:char_no])
end
string = string + tk[:text]
prev_tk = tk
end
start_tk = tk unless start_tk
prev_tk = tk unless prev_tk
@buf.unshift tk # closing heredoc
heredoc_tk = Token.new(start_tk.line_no, start_tk.char_no, :on_heredoc, string, prev_tk.state)
@buf.unshift heredoc_tk
end
private def retrieve_heredoc_info(tk)
name = tk[:text].gsub(/\A<<[-~]?(['"`]?)(.+)\1\z/, '\2')
indent = tk[:text] =~ /\A<<[-~]/
[name, indent]
end
private def heredoc_end?(name, indent, tk)
result = false
if :on_heredoc_end == tk[:kind] then
tk_name = tk[:text].chomp
tk_name.lstrip! if indent
if name == tk_name
result = true
end
end
result
end
private def get_words_tk(tk)
string = ''
start_token = tk[:text]
start_quote = tk[:text].rstrip[-1]
line_no = tk[:line_no]
char_no = tk[:char_no]
state = tk[:state]
end_quote =
case start_quote
when ?( then ?)
when ?[ then ?]
when ?{ then ?}
when ?< then ?>
else start_quote
end
end_token = nil
loop do
tk = get_squashed_tk
if tk.nil?
end_token = end_quote
break
elsif :on_tstring_content == tk[:kind] then
string += tk[:text]
elsif :on_words_sep == tk[:kind] or :on_tstring_end == tk[:kind] then
if end_quote == tk[:text].strip then
end_token = tk[:text]
break
else
string += tk[:text]
end
else
string += tk[:text]
end
end
text = "#{start_token}#{string}#{end_token}"
Token.new(line_no, char_no, :on_dstring, text, state)
end
private def get_op_tk(tk)
redefinable_operators = %w[! != !~ % & * ** + +@ - -@ / < << <= <=> == === =~ > >= >> [] []= ^ ` | ~]
if redefinable_operators.include?(tk[:text]) and tk[:state] == EXPR_ARG then
@inner_lex.lex_state = EXPR_ARG unless RIPPER_HAS_LEX_STATE
tk[:state] = Ripper::Lexer.const_defined?(:State) ? Ripper::Lexer::State.new(EXPR_ARG) : EXPR_ARG
tk[:kind] = :on_ident
elsif tk[:text] =~ /^[-+]$/ then
tk_ahead = get_squashed_tk
case tk_ahead[:kind]
when :on_int, :on_float, :on_rational, :on_imaginary then
tk[:text] += tk_ahead[:text]
tk[:kind] = tk_ahead[:kind]
tk[:state] = tk_ahead[:state]
when :on_heredoc_beg, :on_tstring, :on_dstring # frozen/non-frozen string literal
tk[:text] += tk_ahead[:text]
tk[:kind] = tk_ahead[:kind]
tk[:state] = tk_ahead[:state]
else
@buf.unshift tk_ahead
end
end
tk
end
# :startdoc:
# New lexer for +code+.
def initialize(code)
@buf = []
@heredoc_queue = []
@inner_lex = InnerStateLex.new(code)
@tokens = @inner_lex.parse([])
end
# Returns tokens parsed from +code+.
def self.parse(code)
lex = self.new(code)
tokens = []
begin
while tk = lex.get_squashed_tk
tokens.push tk
end
rescue StopIteration
end
tokens
end
# Returns +true+ if lex state will be +END+ after +token+.
def self.end?(token)
(token[:state] & EXPR_END)
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/markdown.rb 0000644 00000000730 15173517750 0016445 0 ustar 00 # frozen_string_literal: true
##
# Parse a Markdown format file. The parsed RDoc::Markup::Document is attached
# as a file comment.
class RDoc::Parser::Markdown < RDoc::Parser
include RDoc::Parser::Text
parse_files_matching(/\.(md|markdown)(?:\.[^.]+)?$/)
##
# Creates an Markdown-format TopLevel for the given file.
def scan
comment = RDoc::Comment.new @content, @top_level
comment.format = 'markdown'
@top_level.comment = comment
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/rd.rb 0000644 00000000665 15173517750 0015237 0 ustar 00 # frozen_string_literal: true
##
# Parse a RD format file. The parsed RDoc::Markup::Document is attached as a
# file comment.
class RDoc::Parser::RD < RDoc::Parser
include RDoc::Parser::Text
parse_files_matching(/\.rd(?:\.[^.]+)?$/)
##
# Creates an rd-format TopLevel for the given file.
def scan
comment = RDoc::Comment.new @content, @top_level
comment.format = 'rd'
@top_level.comment = comment
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/changelog.rb 0000644 00000021207 15173517750 0016554 0 ustar 00 # frozen_string_literal: true
##
# A ChangeLog file parser.
#
# This parser converts a ChangeLog into an RDoc::Markup::Document. When
# viewed as HTML a ChangeLog page will have an entry for each day's entries in
# the sidebar table of contents.
#
# This parser is meant to parse the MRI ChangeLog, but can be used to parse any
# {GNU style Change
# Log}[http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html].
class RDoc::Parser::ChangeLog < RDoc::Parser
include RDoc::Parser::Text
parse_files_matching(/(\/|\\|\A)ChangeLog[^\/\\]*\z/)
##
# Attaches the +continuation+ of the previous line to the +entry_body+.
#
# Continued function listings are joined together as a single entry.
# Continued descriptions are joined to make a single paragraph.
def continue_entry_body entry_body, continuation
return unless last = entry_body.last
if last =~ /\)\s*\z/ and continuation =~ /\A\(/ then
last.sub!(/\)\s*\z/, ',')
continuation = continuation.sub(/\A\(/, '')
end
if last =~ /\s\z/ then
last << continuation
else
last << ' ' + continuation
end
end
##
# Creates an RDoc::Markup::Document given the +groups+ of ChangeLog entries.
def create_document groups
doc = RDoc::Markup::Document.new
doc.omit_headings_below = 2
doc.file = @top_level
doc << RDoc::Markup::Heading.new(1, File.basename(@file_name))
doc << RDoc::Markup::BlankLine.new
groups.sort_by do |day,| day end.reverse_each do |day, entries|
doc << RDoc::Markup::Heading.new(2, day.dup)
doc << RDoc::Markup::BlankLine.new
doc.concat create_entries entries
end
doc
end
##
# Returns a list of ChangeLog entries an RDoc::Markup nodes for the given
# +entries+.
def create_entries entries
out = []
entries.each do |entry, items|
out << RDoc::Markup::Heading.new(3, entry)
out << RDoc::Markup::BlankLine.new
out << create_items(items)
end
out
end
##
# Returns an RDoc::Markup::List containing the given +items+ in the
# ChangeLog
def create_items items
list = RDoc::Markup::List.new :NOTE
items.each do |item|
item =~ /\A(.*?(?:\([^)]+\))?):\s*/
title = $1
body = $'
paragraph = RDoc::Markup::Paragraph.new body
list_item = RDoc::Markup::ListItem.new title, paragraph
list << list_item
end
list
end
##
# Groups +entries+ by date.
def group_entries entries
@time_cache ||= {}
entries.group_by do |title, _|
begin
time = @time_cache[title]
(time || parse_date(title)).strftime '%Y-%m-%d'
rescue NoMethodError, ArgumentError
time, = title.split ' ', 2
parse_date(time).strftime '%Y-%m-%d'
end
end
end
##
# Parse date in ISO-8601, RFC-2822, or default of Git
def parse_date(date)
case date
when /\A\s*(\d+)-(\d+)-(\d+)(?:[ T](\d+):(\d+):(\d+) *([-+]\d\d):?(\d\d))?\b/
Time.new($1, $2, $3, $4, $5, $6, ("#{$7}:#{$8}" if $7))
when /\A\s*\w{3}, +(\d+) (\w{3}) (\d+) (\d+):(\d+):(\d+) *(?:([-+]\d\d):?(\d\d))\b/
Time.new($3, $2, $1, $4, $5, $6, ("#{$7}:#{$8}" if $7))
when /\A\s*\w{3} (\w{3}) +(\d+) (\d+) (\d+):(\d+):(\d+) *(?:([-+]\d\d):?(\d\d))\b/
Time.new($3, $1, $2, $4, $5, $6, ("#{$7}:#{$8}" if $7))
when /\A\s*\w{3} (\w{3}) +(\d+) (\d+):(\d+):(\d+) (\d+)\b/
Time.new($6, $1, $2, $3, $4, $5)
else
raise ArgumentError, "bad date: #{date}"
end
end
##
# Parses the entries in the ChangeLog.
#
# Returns an Array of each ChangeLog entry in order of parsing.
#
# A ChangeLog entry is an Array containing the ChangeLog title (date and
# committer) and an Array of ChangeLog items (file and function changed with
# description).
#
# An example result would be:
#
# [ 'Tue Dec 4 08:33:46 2012 Eric Hodel <drbrain@segment7.net>',
# [ 'README.EXT: Converted to RDoc format',
# 'README.EXT.ja: ditto']]
def parse_entries
@time_cache ||= {}
if /\A((?:.*\n){,3})commit\s/ =~ @content
class << self; prepend Git; end
parse_info($1)
return parse_entries
end
entries = []
entry_name = nil
entry_body = []
@content.each_line do |line|
case line
when /^\s*$/ then
next
when /^\w.*/ then
entries << [entry_name, entry_body] if entry_name
entry_name = $&
begin
time = parse_date entry_name
@time_cache[entry_name] = time
rescue ArgumentError
entry_name = nil
end
entry_body = []
when /^(\t| {8})?\*\s*(.*)/ then # "\t* file.c (func): ..."
entry_body << $2.dup
when /^(\t| {8})?\s*(\(.*)/ then # "\t(func): ..."
entry = $2
if entry_body.last =~ /:/ then
entry_body << entry.dup
else
continue_entry_body entry_body, entry
end
when /^(\t| {8})?\s*(.*)/ then
continue_entry_body entry_body, $2
end
end
entries << [entry_name, entry_body] if entry_name
entries.reject! do |(entry,_)|
entry == nil
end
entries
end
##
# Converts the ChangeLog into an RDoc::Markup::Document
def scan
@time_cache = {}
entries = parse_entries
grouped_entries = group_entries entries
doc = create_document grouped_entries
@top_level.comment = doc
@top_level
end
##
# The extension for Git commit log
module Git
##
# Parses auxiliary info. Currentry `base-url` to expand
# references is effective.
def parse_info(info)
/^\s*base-url\s*=\s*(.*\S)/ =~ info
@base_url = $1
end
##
# Parses the entries in the Git commit logs
def parse_entries
entries = []
@content.scan(/^commit\s+(\h{20})\h*\n((?:.+\n)*)\n((?: {4}.*\n+)*)/) do
entry_name, header, entry_body = $1, $2, $3.gsub(/^ {4}/, '')
# header = header.scan(/^ *(\S+?): +(.*)/).to_h
# date = header["CommitDate"] || header["Date"]
date = header[/^ *(?:Author)?Date: +(.*)/, 1]
author = header[/^ *Author: +(.*)/, 1]
begin
time = parse_date(header[/^ *CommitDate: +(.*)/, 1] || date)
@time_cache[entry_name] = time
author.sub!(/\s*<(.*)>/, '')
email = $1
entries << [entry_name, [author, email, date, entry_body]]
rescue ArgumentError
end
end
entries
end
##
# Returns a list of ChangeLog entries as
# RDoc::Parser::ChangeLog::Git::LogEntry list for the given
# +entries+.
def create_entries entries
# git log entries have no strictly itemized style like the old
# style, just assume Markdown.
entries.map do |commit, entry|
LogEntry.new(@base_url, commit, *entry)
end
end
LogEntry = Struct.new(:base, :commit, :author, :email, :date, :contents) do
HEADING_LEVEL = 3
def initialize(base, commit, author, email, date, contents)
case contents
when String
contents = RDoc::Markdown.parse(contents).parts.each do |body|
case body
when RDoc::Markup::Heading
body.level += HEADING_LEVEL + 1
end
end
case first = contents[0]
when RDoc::Markup::Paragraph
contents[0] = RDoc::Markup::Heading.new(HEADING_LEVEL + 1, first.text)
end
end
super
end
def level
HEADING_LEVEL
end
def aref
"label-#{commit}"
end
def label context = nil
aref
end
def text
case base
when nil
"#{date}"
when /%s/
"{#{date}}[#{base % commit}]"
else
"{#{date}}[#{base}#{commit}]"
end + " {#{author}}[mailto:#{email}]"
end
def accept visitor
visitor.accept_heading self
begin
if visitor.respond_to?(:code_object=)
code_object = visitor.code_object
visitor.code_object = self
end
contents.each do |body|
body.accept visitor
end
ensure
if visitor.respond_to?(:code_object)
visitor.code_object = code_object
end
end
end
def pretty_print q # :nodoc:
q.group(2, '[log_entry: ', ']') do
q.text commit
q.text ','
q.breakable
q.group(2, '[date: ', ']') { q.text date }
q.text ','
q.breakable
q.group(2, '[author: ', ']') { q.text author }
q.text ','
q.breakable
q.group(2, '[email: ', ']') { q.text email }
q.text ','
q.breakable
q.pp contents
end
end
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/c.rb 0000644 00000105642 15173517750 0015055 0 ustar 00 # frozen_string_literal: true
require 'tsort'
##
# RDoc::Parser::C attempts to parse C extension files. It looks for
# the standard patterns that you find in extensions: +rb_define_class+,
# +rb_define_method+ and so on. It tries to find the corresponding
# C source for the methods and extract comments, but if we fail
# we don't worry too much.
#
# The comments associated with a Ruby method are extracted from the C
# comment block associated with the routine that _implements_ that
# method, that is to say the method whose name is given in the
# +rb_define_method+ call. For example, you might write:
#
# /*
# * Returns a new array that is a one-dimensional flattening of this
# * array (recursively). That is, for every element that is an array,
# * extract its elements into the new array.
# *
# * s = [ 1, 2, 3 ] #=> [1, 2, 3]
# * t = [ 4, 5, 6, [7, 8] ] #=> [4, 5, 6, [7, 8]]
# * a = [ s, t, 9, 10 ] #=> [[1, 2, 3], [4, 5, 6, [7, 8]], 9, 10]
# * a.flatten #=> [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
# */
# static VALUE
# rb_ary_flatten(VALUE ary)
# {
# ary = rb_obj_dup(ary);
# rb_ary_flatten_bang(ary);
# return ary;
# }
#
# ...
#
# void
# Init_Array(void)
# {
# ...
# rb_define_method(rb_cArray, "flatten", rb_ary_flatten, 0);
#
# Here RDoc will determine from the +rb_define_method+ line that there's a
# method called "flatten" in class Array, and will look for the implementation
# in the method +rb_ary_flatten+. It will then use the comment from that
# method in the HTML output. This method must be in the same source file
# as the +rb_define_method+.
#
# The comment blocks may include special directives:
#
# [Document-class: +name+]
# Documentation for the named class.
#
# [Document-module: +name+]
# Documentation for the named module.
#
# [Document-const: +name+]
# Documentation for the named +rb_define_const+.
#
# Constant values can be supplied on the first line of the comment like so:
#
# /* 300: The highest possible score in bowling */
# rb_define_const(cFoo, "PERFECT", INT2FIX(300));
#
# The value can contain internal colons so long as they are escaped with a \
#
# [Document-global: +name+]
# Documentation for the named +rb_define_global_const+
#
# [Document-variable: +name+]
# Documentation for the named +rb_define_variable+
#
# [Document-method\: +method_name+]
# Documentation for the named method. Use this when the method name is
# unambiguous.
#
# [Document-method\: <tt>ClassName::method_name</tt>]
# Documentation for a singleton method in the given class. Use this when
# the method name alone is ambiguous.
#
# [Document-method\: <tt>ClassName#method_name</tt>]
# Documentation for a instance method in the given class. Use this when the
# method name alone is ambiguous.
#
# [Document-attr: +name+]
# Documentation for the named attribute.
#
# [call-seq: <i>text up to an empty line</i>]
# Because C source doesn't give descriptive names to Ruby-level parameters,
# you need to document the calling sequence explicitly
#
# In addition, RDoc assumes by default that the C method implementing a
# Ruby function is in the same source file as the rb_define_method call.
# If this isn't the case, add the comment:
#
# rb_define_method(....); // in filename
#
# As an example, we might have an extension that defines multiple classes
# in its Init_xxx method. We could document them using
#
# /*
# * Document-class: MyClass
# *
# * Encapsulate the writing and reading of the configuration
# * file. ...
# */
#
# /*
# * Document-method: read_value
# *
# * call-seq:
# * cfg.read_value(key) -> value
# * cfg.read_value(key} { |key| } -> value
# *
# * Return the value corresponding to +key+ from the configuration.
# * In the second form, if the key isn't found, invoke the
# * block and return its value.
# */
class RDoc::Parser::C < RDoc::Parser
parse_files_matching(/\.(?:([CcHh])\1?|c([+xp])\2|y)\z/)
include RDoc::Text
# :stopdoc:
BOOL_ARG_PATTERN = /\s*+\b([01]|Q?(?:true|false)|TRUE|FALSE)\b\s*/
TRUE_VALUES = ['1', 'TRUE', 'true', 'Qtrue'].freeze
# :startdoc:
##
# Maps C variable names to names of Ruby classes or modules
attr_reader :classes
##
# C file the parser is parsing
attr_accessor :content
##
# Dependencies from a missing enclosing class to the classes in
# missing_dependencies that depend upon it.
attr_reader :enclosure_dependencies
##
# Maps C variable names to names of Ruby classes (and singleton classes)
attr_reader :known_classes
##
# Classes found while parsing the C file that were not yet registered due to
# a missing enclosing class. These are processed by do_missing
attr_reader :missing_dependencies
##
# Maps C variable names to names of Ruby singleton classes
attr_reader :singleton_classes
##
# The TopLevel items in the parsed file belong to
attr_reader :top_level
##
# Prepares for parsing a C file. See RDoc::Parser#initialize for details on
# the arguments.
def initialize top_level, file_name, content, options, stats
super
@known_classes = RDoc::KNOWN_CLASSES.dup
@content = handle_tab_width handle_ifdefs_in @content
@file_dir = File.dirname @file_name
@classes = load_variable_map :c_class_variables
@singleton_classes = load_variable_map :c_singleton_class_variables
@markup = @options.markup
# class_variable => { function => [method, ...] }
@methods = Hash.new { |h, f| h[f] = Hash.new { |i, m| i[m] = [] } }
# missing variable => [handle_class_module arguments]
@missing_dependencies = {}
# missing enclosure variable => [dependent handle_class_module arguments]
@enclosure_dependencies = Hash.new { |h, k| h[k] = [] }
@enclosure_dependencies.instance_variable_set :@missing_dependencies,
@missing_dependencies
@enclosure_dependencies.extend TSort
def @enclosure_dependencies.tsort_each_node &block
each_key(&block)
rescue TSort::Cyclic => e
cycle_vars = e.message.scan(/"(.*?)"/).flatten
cycle = cycle_vars.sort.map do |var_name|
delete var_name
var_name, type, mod_name, = @missing_dependencies[var_name]
"#{type} #{mod_name} (#{var_name})"
end.join ', '
warn "Unable to create #{cycle} due to a cyclic class or module creation"
retry
end
def @enclosure_dependencies.tsort_each_child node, &block
fetch(node, []).each(&block)
end
end
##
# Scans #content for rb_define_alias
def do_aliases
@content.scan(/rb_define_alias\s*\(
\s*(\w+),
\s*"(.+?)",
\s*"(.+?)"
\s*\)/xm) do |var_name, new_name, old_name|
class_name = @known_classes[var_name]
unless class_name then
@options.warn "Enclosing class or module %p for alias %s %s is not known" % [
var_name, new_name, old_name]
next
end
class_obj = find_class var_name, class_name
comment = find_alias_comment var_name, new_name, old_name
comment.normalize
if comment.to_s.empty? and existing_method = class_obj.method_list.find { |m| m.name == old_name}
comment = existing_method.comment
end
add_alias(var_name, class_obj, old_name, new_name, comment)
end
end
##
# Add alias, either from a direct alias definition, or from two
# method that reference the same function.
def add_alias(var_name, class_obj, old_name, new_name, comment)
al = RDoc::Alias.new '', old_name, new_name, ''
al.singleton = @singleton_classes.key? var_name
al.comment = comment
al.record_location @top_level
class_obj.add_alias al
@stats.add_alias al
al
end
##
# Scans #content for rb_attr and rb_define_attr
def do_attrs
@content.scan(/rb_attr\s*\(
\s*(\w+),
\s*([\w"()]+),
#{BOOL_ARG_PATTERN},
#{BOOL_ARG_PATTERN},
\s*\w+\);/xmo) do |var_name, attr_name, read, write|
handle_attr var_name, attr_name, read, write
end
@content.scan(%r%rb_define_attr\(
\s*([\w\.]+),
\s*"([^"]+)",
#{BOOL_ARG_PATTERN},
#{BOOL_ARG_PATTERN}\);
%xmo) do |var_name, attr_name, read, write|
handle_attr var_name, attr_name, read, write
end
end
##
# Scans #content for boot_defclass
def do_boot_defclass
@content.scan(/(\w+)\s*=\s*boot_defclass\s*\(\s*"(\w+?)",\s*(\w+?)\s*\)/) do
|var_name, class_name, parent|
parent = nil if parent == "0"
handle_class_module(var_name, :class, class_name, parent, nil)
end
end
##
# Scans #content for rb_define_class, boot_defclass, rb_define_class_under
# and rb_singleton_class
def do_classes_and_modules
do_boot_defclass if @file_name == "class.c"
@content.scan(
%r(
(?<open>\s*\(\s*) {0}
(?<close>\s*\)\s*) {0}
(?<name>\s*"(?<class_name>\w+)") {0}
(?<parent>\s*(?:
(?<parent_name>[\w\*\s\(\)\.\->]+) |
rb_path2class\s*\(\s*"(?<path>[\w:]+)"\s*\)
)) {0}
(?<under>\w+) {0}
(?<var_name>[\w\.]+)\s* =
\s*rb_(?:
define_(?:
class(?: # rb_define_class(name, parent_name)
\(\s*
\g<name>,
\g<parent>
\s*\)
|
_under\g<open> # rb_define_class_under(under, name, parent_name...)
\g<under>,
\g<name>,
\g<parent>
\g<close>
)
|
(?<module>)
module(?: # rb_define_module(name)
\g<open>
\g<name>
\g<close>
|
_under\g<open> # rb_define_module_under(under, name)
\g<under>,
\g<name>
\g<close>
)
)
|
(?<attributes>(?:\s*"\w+",)*\s*NULL\s*) {0}
struct_define(?:
\g<open> # rb_struct_define(name, ...)
\g<name>,
|
_under\g<open> # rb_struct_define_under(under, name, ...)
\g<under>,
\g<name>,
|
_without_accessor(?:
\g<open> # rb_struct_define_without_accessor(name, parent_name, ...)
|
_under\g<open> # rb_struct_define_without_accessor_under(under, name, parent_name, ...)
\g<under>,
)
\g<name>,
\g<parent>,
\s*\w+, # Allocation function
)
\g<attributes>
\g<close>
|
singleton_class\g<open> # rb_singleton_class(target_class_name)
(?<target_class_name>\w+)
\g<close>
)
)mx
) do
if target_class_name = $~[:target_class_name]
# rb_singleton_class(target_class_name)
handle_singleton $~[:var_name], target_class_name
next
end
var_name = $~[:var_name]
type = $~[:module] ? :module : :class
class_name = $~[:class_name]
parent_name = $~[:parent_name] || $~[:path]
under = $~[:under]
attributes = $~[:attributes]
handle_class_module(var_name, type, class_name, parent_name, under)
if attributes and !parent_name # rb_struct_define *not* without_accessor
true_flag = 'Qtrue'
attributes.scan(/"\K\w+(?=")/) do |attr_name|
handle_attr var_name, attr_name, true_flag, true_flag
end
end
end
end
##
# Scans #content for rb_define_variable, rb_define_readonly_variable,
# rb_define_const and rb_define_global_const
def do_constants
@content.scan(%r%\Wrb_define_
( variable |
readonly_variable |
const |
global_const )
\s*\(
(?:\s*(\w+),)?
\s*"(\w+)",
\s*(.*?)\s*\)\s*;
%xm) do |type, var_name, const_name, definition|
var_name = "rb_cObject" if !var_name or var_name == "rb_mKernel"
handle_constants type, var_name, const_name, definition
end
@content.scan(%r%
\Wrb_curses_define_const
\s*\(
\s*
(\w+)
\s*
\)
\s*;%xm) do |consts|
const = consts.first
handle_constants 'const', 'mCurses', const, "UINT2NUM(#{const})"
end
@content.scan(%r%
\Wrb_file_const
\s*\(
\s*
"([^"]+)",
\s*
(.*?)
\s*
\)
\s*;%xm) do |name, value|
handle_constants 'const', 'rb_mFConst', name, value
end
end
##
# Scans #content for rb_include_module
def do_includes
@content.scan(/rb_include_module\s*\(\s*(\w+?),\s*(\w+?)\s*\)/) do |c,m|
next unless cls = @classes[c]
m = @known_classes[m] || m
comment = new_comment '', @top_level, :c
incl = cls.add_include RDoc::Include.new(m, comment)
incl.record_location @top_level
end
end
##
# Scans #content for rb_define_method, rb_define_singleton_method,
# rb_define_module_function, rb_define_private_method,
# rb_define_global_function and define_filetest_function
def do_methods
@content.scan(%r%rb_define_
(
singleton_method |
method |
module_function |
private_method
)
\s*\(\s*([\w\.]+),
\s*"([^"]+)",
\s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\(|\(METHOD\))?(\w+)\)?,
\s*(-?\w+)\s*\)
(?:;\s*/[*/]\s+in\s+(\w+?\.(?:cpp|c|y)))?
%xm) do |type, var_name, meth_name, function, param_count, source_file|
# Ignore top-object and weird struct.c dynamic stuff
next if var_name == "ruby_top_self"
next if var_name == "nstr"
var_name = "rb_cObject" if var_name == "rb_mKernel"
handle_method(type, var_name, meth_name, function, param_count,
source_file)
end
@content.scan(%r%rb_define_global_function\s*\(
\s*"([^"]+)",
\s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
\s*(-?\w+)\s*\)
(?:;\s*/[*/]\s+in\s+(\w+?\.[cy]))?
%xm) do |meth_name, function, param_count, source_file|
handle_method("method", "rb_mKernel", meth_name, function, param_count,
source_file)
end
@content.scan(/define_filetest_function\s*\(
\s*"([^"]+)",
\s*(?:RUBY_METHOD_FUNC\(|VALUEFUNC\()?(\w+)\)?,
\s*(-?\w+)\s*\)/xm) do |meth_name, function, param_count|
handle_method("method", "rb_mFileTest", meth_name, function, param_count)
handle_method("singleton_method", "rb_cFile", meth_name, function,
param_count)
end
end
##
# Creates classes and module that were missing were defined due to the file
# order being different than the declaration order.
def do_missing
return if @missing_dependencies.empty?
@enclosure_dependencies.tsort.each do |in_module|
arguments = @missing_dependencies.delete in_module
next unless arguments # dependency on existing class
handle_class_module(*arguments)
end
end
##
# Finds the comment for an alias on +class_name+ from +new_name+ to
# +old_name+
def find_alias_comment class_name, new_name, old_name
content =~ %r%((?>/\*.*?\*/\s+))
rb_define_alias\(\s*#{Regexp.escape class_name}\s*,
\s*"#{Regexp.escape new_name}"\s*,
\s*"#{Regexp.escape old_name}"\s*\);%xm
new_comment($1 || '', @top_level, :c)
end
##
# Finds a comment for rb_define_attr, rb_attr or Document-attr.
#
# +var_name+ is the C class variable the attribute is defined on.
# +attr_name+ is the attribute's name.
#
# +read+ and +write+ are the read/write flags ('1' or '0'). Either both or
# neither must be provided.
def find_attr_comment var_name, attr_name, read = nil, write = nil
attr_name = Regexp.escape attr_name
rw = if read and write then
/\s*#{read}\s*,\s*#{write}\s*/xm
else
/.*?/m
end
comment = if @content =~ %r%((?>/\*.*?\*/\s+))
rb_define_attr\((?:\s*#{var_name},)?\s*
"#{attr_name}"\s*,
#{rw}\)\s*;%xm then
$1
elsif @content =~ %r%((?>/\*.*?\*/\s+))
rb_attr\(\s*#{var_name}\s*,
\s*#{attr_name}\s*,
#{rw},.*?\)\s*;%xm then
$1
elsif @content =~ %r%(/\*.*?(?:\s*\*\s*)?)
Document-attr:\s#{attr_name}\s*?\n
((?>(.|\n)*?\*/))%x then
"#{$1}\n#{$2}"
else
''
end
new_comment comment, @top_level, :c
end
##
# Generate a Ruby-method table
def gen_body_table file_content
table = {}
file_content.scan(%r{
((?>/\*.*?\*/\s*)?)
((?:\w+\s+){0,2} VALUE\s+(\w+)
\s*(?:\([^\)]*\))(?:[^\);]|$))
| ((?>/\*.*?\*/\s*))^\s*(\#\s*define\s+(\w+)\s+(\w+))
| ^\s*\#\s*define\s+(\w+)\s+(\w+)
}xm) do
case
when name = $3
table[name] = [:func_def, $1, $2, $~.offset(2)] if !(t = table[name]) || t[0] != :func_def
when name = $6
table[name] = [:macro_def, $4, $5, $~.offset(5), $7] if !(t = table[name]) || t[0] == :macro_alias
when name = $8
table[name] ||= [:macro_alias, $9]
end
end
table
end
##
# Find the C code corresponding to a Ruby method
def find_body class_name, meth_name, meth_obj, file_content, quiet = false
if file_content
@body_table ||= {}
@body_table[file_content] ||= gen_body_table file_content
type, *args = @body_table[file_content][meth_name]
end
case type
when :func_def
comment = new_comment args[0], @top_level, :c
body = args[1]
offset, = args[2]
comment.remove_private if comment
# try to find the whole body
body = $& if /#{Regexp.escape body}[^(]*?\{.*?^\}/m =~ file_content
# The comment block may have been overridden with a 'Document-method'
# block. This happens in the interpreter when multiple methods are
# vectored through to the same C method but those methods are logically
# distinct (for example Kernel.hash and Kernel.object_id share the same
# implementation
override_comment = find_override_comment class_name, meth_obj
comment = override_comment if override_comment
comment.normalize
find_modifiers comment, meth_obj if comment
#meth_obj.params = params
meth_obj.start_collecting_tokens
tk = { :line_no => 1, :char_no => 1, :text => body }
meth_obj.add_token tk
meth_obj.comment = comment
meth_obj.line = file_content[0, offset].count("\n") + 1
body
when :macro_def
comment = new_comment args[0], @top_level, :c
body = args[1]
offset, = args[2]
find_body class_name, args[3], meth_obj, file_content, true
comment.normalize
find_modifiers comment, meth_obj
meth_obj.start_collecting_tokens
tk = { :line_no => 1, :char_no => 1, :text => body }
meth_obj.add_token tk
meth_obj.comment = comment
meth_obj.line = file_content[0, offset].count("\n") + 1
body
when :macro_alias
# with no comment we hope the aliased definition has it and use it's
# definition
body = find_body(class_name, args[0], meth_obj, file_content, true)
return body if body
@options.warn "No definition for #{meth_name}"
false
else # No body, but might still have an override comment
comment = find_override_comment class_name, meth_obj
if comment then
comment.normalize
find_modifiers comment, meth_obj
meth_obj.comment = comment
''
else
@options.warn "No definition for #{meth_name}"
false
end
end
end
##
# Finds a RDoc::NormalClass or RDoc::NormalModule for +raw_name+
def find_class(raw_name, name, base_name = nil)
unless @classes[raw_name]
if raw_name =~ /^rb_m/
container = @top_level.add_module RDoc::NormalModule, name
else
container = @top_level.add_class RDoc::NormalClass, name
end
container.name = base_name if base_name
container.record_location @top_level
@classes[raw_name] = container
end
@classes[raw_name]
end
##
# Look for class or module documentation above Init_+class_name+(void),
# in a Document-class +class_name+ (or module) comment or above an
# rb_define_class (or module). If a comment is supplied above a matching
# Init_ and a rb_define_class the Init_ comment is used.
#
# /*
# * This is a comment for Foo
# */
# Init_Foo(void) {
# VALUE cFoo = rb_define_class("Foo", rb_cObject);
# }
#
# /*
# * Document-class: Foo
# * This is a comment for Foo
# */
# Init_foo(void) {
# VALUE cFoo = rb_define_class("Foo", rb_cObject);
# }
#
# /*
# * This is a comment for Foo
# */
# VALUE cFoo = rb_define_class("Foo", rb_cObject);
def find_class_comment class_name, class_mod
comment = nil
if @content =~ %r%
((?>/\*.*?\*/\s+))
(static\s+)?
void\s+
Init(?:VM)?_(?i:#{class_name})\s*(?:_\(\s*)?\(\s*(?:void\s*)?\)%xm then
comment = $1.sub(%r%Document-(?:class|module):\s+#{class_name}%, '')
elsif @content =~ %r%Document-(?:class|module):\s+#{class_name}\s*?
(?:<\s+[:,\w]+)?\n((?>.*?\*/))%xm then
comment = "/*\n#{$1}"
elsif @content =~ %r%((?>/\*.*?\*/\s+))
([\w\.\s]+\s* = \s+)?rb_define_(class|module)[\t (]*?"(#{class_name})"%xm then
comment = $1
elsif @content =~ %r%((?>/\*.*?\*/\s+))
([\w\. \t]+ = \s+)?rb_define_(class|module)_under[\t\w, (]*?"(#{class_name.split('::').last})"%xm then
comment = $1
else
comment = ''
end
comment = new_comment comment, @top_level, :c
comment.normalize
look_for_directives_in class_mod, comment
class_mod.add_comment comment, @top_level
end
##
# Generate a const table
def gen_const_table file_content
table = {}
@content.scan(%r{
((?>^\s*/\*.*?\*/\s+))
rb_define_(\w+)\((?:\s*(?:\w+),)?\s*
"(\w+)"\s*,
.*?\)\s*;
| Document-(?:const|global|variable):\s
((?:\w+::)*\w+)
\s*?\n((?>.*?\*/))
}mxi) do
case
when $1 then table[[$2, $3]] = $1
when $4 then table[$4] = "/*\n" + $5
end
end
table
end
##
# Finds a comment matching +type+ and +const_name+ either above the
# comment or in the matching Document- section.
def find_const_comment(type, const_name, class_name = nil)
@const_table ||= {}
@const_table[@content] ||= gen_const_table @content
table = @const_table[@content]
comment =
table[[type, const_name]] ||
(class_name && table[class_name + "::" + const_name]) ||
table[const_name] ||
''
new_comment comment, @top_level, :c
end
##
# Handles modifiers in +comment+ and updates +meth_obj+ as appropriate.
def find_modifiers comment, meth_obj
comment.normalize
comment.extract_call_seq meth_obj
look_for_directives_in meth_obj, comment
end
##
# Finds a <tt>Document-method</tt> override for +meth_obj+ on +class_name+
def find_override_comment class_name, meth_obj
name = Regexp.escape meth_obj.name
prefix = Regexp.escape meth_obj.name_prefix
comment = if @content =~ %r%Document-method:
\s+#{class_name}#{prefix}#{name}
\s*?\n((?>.*?\*/))%xm then
"/*#{$1}"
elsif @content =~ %r%Document-method:
\s#{name}\s*?\n((?>.*?\*/))%xm then
"/*#{$1}"
end
return unless comment
new_comment comment, @top_level, :c
end
##
# Creates a new RDoc::Attr +attr_name+ on class +var_name+ that is either
# +read+, +write+ or both
def handle_attr(var_name, attr_name, read, write)
rw = ''
rw += 'R' if TRUE_VALUES.include?(read)
rw += 'W' if TRUE_VALUES.include?(write)
class_name = @known_classes[var_name]
return unless class_name
class_obj = find_class var_name, class_name
return unless class_obj
comment = find_attr_comment var_name, attr_name
comment.normalize
name = attr_name.gsub(/rb_intern(?:_const)?\("([^"]+)"\)/, '\1')
attr = RDoc::Attr.new '', name, rw, comment
attr.record_location @top_level
class_obj.add_attribute attr
@stats.add_attribute attr
end
##
# Creates a new RDoc::NormalClass or RDoc::NormalModule based on +type+
# named +class_name+ in +parent+ which was assigned to the C +var_name+.
def handle_class_module(var_name, type, class_name, parent, in_module)
parent_name = @known_classes[parent] || parent
if in_module then
enclosure = @classes[in_module] || @store.find_c_enclosure(in_module)
if enclosure.nil? and enclosure = @known_classes[in_module] then
enc_type = /^rb_m/ =~ in_module ? :module : :class
handle_class_module in_module, enc_type, enclosure, nil, nil
enclosure = @classes[in_module]
end
unless enclosure then
@enclosure_dependencies[in_module] << var_name
@missing_dependencies[var_name] =
[var_name, type, class_name, parent, in_module]
return
end
else
enclosure = @top_level
end
if type == :class then
full_name = if RDoc::ClassModule === enclosure then
enclosure.full_name + "::#{class_name}"
else
class_name
end
if @content =~ %r%Document-class:\s+#{full_name}\s*<\s+([:,\w]+)% then
parent_name = $1
end
cm = enclosure.add_class RDoc::NormalClass, class_name, parent_name
else
cm = enclosure.add_module RDoc::NormalModule, class_name
end
cm.record_location enclosure.top_level
find_class_comment cm.full_name, cm
case cm
when RDoc::NormalClass
@stats.add_class cm
when RDoc::NormalModule
@stats.add_module cm
end
@classes[var_name] = cm
@known_classes[var_name] = cm.full_name
@store.add_c_enclosure var_name, cm
end
##
# Adds constants. By providing some_value: at the start of the comment you
# can override the C value of the comment to give a friendly definition.
#
# /* 300: The perfect score in bowling */
# rb_define_const(cFoo, "PERFECT", INT2FIX(300));
#
# Will override <tt>INT2FIX(300)</tt> with the value +300+ in the output
# RDoc. Values may include quotes and escaped colons (\:).
def handle_constants(type, var_name, const_name, definition)
class_name = @known_classes[var_name]
return unless class_name
class_obj = find_class var_name, class_name, class_name[/::\K[^:]+\z/]
unless class_obj then
@options.warn 'Enclosing class or module %p is not known' % [const_name]
return
end
comment = find_const_comment type, const_name, class_name
comment.normalize
# In the case of rb_define_const, the definition and comment are in
# "/* definition: comment */" form. The literal ':' and '\' characters
# can be escaped with a backslash.
if type.downcase == 'const' then
if /\A(.+?)?:(?!\S)/ =~ comment.text
new_definition, new_comment = $1, $'
if !new_definition # Default to literal C definition
new_definition = definition
else
new_definition = new_definition.gsub(/\\([\\:])/, '\1')
end
new_definition.sub!(/\A(\s+)/, '')
new_comment = "#{$1}#{new_comment.lstrip}"
new_comment = self.new_comment(new_comment, @top_level, :c)
con = RDoc::Constant.new const_name, new_definition, new_comment
else
con = RDoc::Constant.new const_name, definition, comment
end
else
con = RDoc::Constant.new const_name, definition, comment
end
con.record_location @top_level
@stats.add_constant con
class_obj.add_constant con
end
##
# Removes #ifdefs that would otherwise confuse us
def handle_ifdefs_in(body)
body.gsub(/^#ifdef HAVE_PROTOTYPES.*?#else.*?\n(.*?)#endif.*?\n/m, '\1')
end
##
# Adds an RDoc::AnyMethod +meth_name+ defined on a class or module assigned
# to +var_name+. +type+ is the type of method definition function used.
# +singleton_method+ and +module_function+ create a singleton method.
def handle_method(type, var_name, meth_name, function, param_count,
source_file = nil)
class_name = @known_classes[var_name]
singleton = @singleton_classes.key? var_name
@methods[var_name][function] << meth_name
return unless class_name
class_obj = find_class var_name, class_name
if existing_method = class_obj.method_list.find { |m| m.c_function == function }
add_alias(var_name, class_obj, existing_method.name, meth_name, existing_method.comment)
end
if class_obj then
if meth_name == 'initialize' then
meth_name = 'new'
singleton = true
type = 'method' # force public
end
meth_obj = RDoc::AnyMethod.new '', meth_name
meth_obj.c_function = function
meth_obj.singleton =
singleton || %w[singleton_method module_function].include?(type)
p_count = Integer(param_count) rescue -1
if source_file then
file_name = File.join @file_dir, source_file
if File.exist? file_name then
file_content = File.read file_name
else
@options.warn "unknown source #{source_file} for #{meth_name} in #{@file_name}"
end
else
file_content = @content
end
body = find_body class_name, function, meth_obj, file_content
if body and meth_obj.document_self then
meth_obj.params = if p_count < -1 then # -2 is Array
'(*args)'
elsif p_count == -1 then # argc, argv
rb_scan_args body
else
args = (1..p_count).map { |i| "p#{i}" }
"(#{args.join ', '})"
end
meth_obj.record_location @top_level
if meth_obj.section_title
class_obj.temporary_section = class_obj.add_section(meth_obj.section_title)
end
class_obj.add_method meth_obj
@stats.add_method meth_obj
meth_obj.visibility = :private if 'private_method' == type
end
end
end
##
# Registers a singleton class +sclass_var+ as a singleton of +class_var+
def handle_singleton sclass_var, class_var
class_name = @known_classes[class_var]
@known_classes[sclass_var] = class_name
@singleton_classes[sclass_var] = class_name
end
##
# Loads the variable map with the given +name+ from the RDoc::Store, if
# present.
def load_variable_map map_name
return {} unless files = @store.cache[map_name]
return {} unless name_map = files[@file_name]
class_map = {}
name_map.each do |variable, name|
next unless mod = @store.find_class_or_module(name)
class_map[variable] = if map_name == :c_class_variables then
mod
else
name
end
@known_classes[variable] = name
end
class_map
end
##
# Look for directives in a normal comment block:
#
# /*
# * :title: My Awesome Project
# */
#
# This method modifies the +comment+
def look_for_directives_in context, comment
@preprocess.handle comment, context do |directive, param|
case directive
when 'main' then
@options.main_page = param
''
when 'title' then
@options.default_title = param if @options.respond_to? :default_title=
''
end
end
comment
end
##
# Extracts parameters from the +method_body+ and returns a method
# parameter string. Follows 1.9.3dev's scan-arg-spec, see README.EXT
def rb_scan_args method_body
method_body =~ /rb_scan_args\((.*?)\)/m
return '(*args)' unless $1
$1.split(/,/)[2] =~ /"(.*?)"/ # format argument
format = $1.split(//)
lead = opt = trail = 0
if format.first =~ /\d/ then
lead = $&.to_i
format.shift
if format.first =~ /\d/ then
opt = $&.to_i
format.shift
if format.first =~ /\d/ then
trail = $&.to_i
format.shift
block_arg = true
end
end
end
if format.first == '*' and not block_arg then
var = true
format.shift
if format.first =~ /\d/ then
trail = $&.to_i
format.shift
end
end
if format.first == ':' then
hash = true
format.shift
end
if format.first == '&' then
block = true
format.shift
end
# if the format string is not empty there's a bug in the C code, ignore it
args = []
position = 1
(1...(position + lead)).each do |index|
args << "p#{index}"
end
position += lead
(position...(position + opt)).each do |index|
args << "p#{index} = v#{index}"
end
position += opt
if var then
args << '*args'
position += 1
end
(position...(position + trail)).each do |index|
args << "p#{index}"
end
position += trail
if hash then
args << "p#{position} = {}"
end
args << '&block' if block
"(#{args.join ', '})"
end
##
# Removes lines that are commented out that might otherwise get picked up
# when scanning for classes and methods
def remove_commented_out_lines
@content = @content.gsub(%r%//.*rb_define_%, '//')
end
##
# Extracts the classes, modules, methods, attributes, constants and aliases
# from a C file and returns an RDoc::TopLevel for this file
def scan
remove_commented_out_lines
do_classes_and_modules
do_missing
do_constants
do_methods
do_includes
do_aliases
do_attrs
@store.add_c_variables self
@top_level
end
##
# Creates a RDoc::Comment instance.
def new_comment text = nil, location = nil, language = nil
RDoc::Comment.new(text, location, language).tap do |comment|
comment.format = @markup
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/ruby.rb 0000644 00000166233 15173517750 0015617 0 ustar 00 # frozen_string_literal: true
##
# This file contains stuff stolen outright from:
#
# rtags.rb -
# ruby-lex.rb - ruby lexcal analyzer
# ruby-token.rb - ruby tokens
# by Keiju ISHITSUKA (Nippon Rational Inc.)
#
require 'ripper'
require_relative 'ripper_state_lex'
##
# Extracts code elements from a source file returning a TopLevel object
# containing the constituent file elements.
#
# This file is based on rtags
#
# RubyParser understands how to document:
# * classes
# * modules
# * methods
# * constants
# * aliases
# * private, public, protected
# * private_class_function, public_class_function
# * private_constant, public_constant
# * module_function
# * attr, attr_reader, attr_writer, attr_accessor
# * extra accessors given on the command line
# * metaprogrammed methods
# * require
# * include
#
# == Method Arguments
#
#--
# NOTE: I don't think this works, needs tests, remove the paragraph following
# this block when known to work
#
# The parser extracts the arguments from the method definition. You can
# override this with a custom argument definition using the :args: directive:
#
# ##
# # This method tries over and over until it is tired
#
# def go_go_go(thing_to_try, tries = 10) # :args: thing_to_try
# puts thing_to_try
# go_go_go thing_to_try, tries - 1
# end
#
# If you have a more-complex set of overrides you can use the :call-seq:
# directive:
#++
#
# The parser extracts the arguments from the method definition. You can
# override this with a custom argument definition using the :call-seq:
# directive:
#
# ##
# # This method can be called with a range or an offset and length
# #
# # :call-seq:
# # my_method(Range)
# # my_method(offset, length)
#
# def my_method(*args)
# end
#
# The parser extracts +yield+ expressions from method bodies to gather the
# yielded argument names. If your method manually calls a block instead of
# yielding or you want to override the discovered argument names use
# the :yields: directive:
#
# ##
# # My method is awesome
#
# def my_method(&block) # :yields: happy, times
# block.call 1, 2
# end
#
# == Metaprogrammed Methods
#
# To pick up a metaprogrammed method, the parser looks for a comment starting
# with '##' before an identifier:
#
# ##
# # This is a meta-programmed method!
#
# add_my_method :meta_method, :arg1, :arg2
#
# The parser looks at the token after the identifier to determine the name, in
# this example, :meta_method. If a name cannot be found, a warning is printed
# and 'unknown is used.
#
# You can force the name of a method using the :method: directive:
#
# ##
# # :method: some_method!
#
# By default, meta-methods are instance methods. To indicate that a method is
# a singleton method instead use the :singleton-method: directive:
#
# ##
# # :singleton-method:
#
# You can also use the :singleton-method: directive with a name:
#
# ##
# # :singleton-method: some_method!
#
# You can define arguments for metaprogrammed methods via either the
# :call-seq:, :arg: or :args: directives.
#
# Additionally you can mark a method as an attribute by
# using :attr:, :attr_reader:, :attr_writer: or :attr_accessor:. Just like
# for :method:, the name is optional.
#
# ##
# # :attr_reader: my_attr_name
#
# == Hidden methods and attributes
#
# You can provide documentation for methods that don't appear using
# the :method:, :singleton-method: and :attr: directives:
#
# ##
# # :attr_writer: ghost_writer
# # There is an attribute here, but you can't see it!
#
# ##
# # :method: ghost_method
# # There is a method here, but you can't see it!
#
# ##
# # this is a comment for a regular method
#
# def regular_method() end
#
# Note that by default, the :method: directive will be ignored if there is a
# standard rdocable item following it.
class RDoc::Parser::Ruby < RDoc::Parser
parse_files_matching(/\.rbw?$/)
include RDoc::TokenStream
include RDoc::Parser::RubyTools
##
# RDoc::NormalClass type
NORMAL = "::"
##
# RDoc::SingleClass type
SINGLE = "<<"
##
# Creates a new Ruby parser.
def initialize(top_level, file_name, content, options, stats)
super
content = handle_tab_width(content)
@size = 0
@token_listeners = nil
content = RDoc::Encoding.remove_magic_comment content
@scanner = RDoc::Parser::RipperStateLex.parse(content)
@content = content
@scanner_point = 0
@prev_seek = nil
@markup = @options.markup
@track_visibility = :nodoc != @options.visibility
@encoding = @options.encoding
reset
end
##
# Return +true+ if +tk+ is a newline.
def tk_nl?(tk)
:on_nl == tk[:kind] or :on_ignored_nl == tk[:kind]
end
##
# Retrieves the read token stream and replaces +pattern+ with +replacement+
# using gsub. If the result is only a ";" returns an empty string.
def get_tkread_clean pattern, replacement # :nodoc:
read = get_tkread.gsub(pattern, replacement).strip
return '' if read == ';'
read
end
##
# Extracts the visibility information for the visibility token +tk+
# and +single+ class type identifier.
#
# Returns the visibility type (a string), the visibility (a symbol) and
# +singleton+ if the methods following should be converted to singleton
# methods.
def get_visibility_information tk, single # :nodoc:
vis_type = tk[:text]
singleton = single == SINGLE
vis =
case vis_type
when 'private' then :private
when 'protected' then :protected
when 'public' then :public
when 'private_class_method' then
singleton = true
:private
when 'public_class_method' then
singleton = true
:public
when 'module_function' then
singleton = true
:public
else
raise RDoc::Error, "Invalid visibility: #{tk.name}"
end
return vis_type, vis, singleton
end
##
# Look for the first comment in a file that isn't a shebang line.
def collect_first_comment
skip_tkspace
comment = ''.dup
comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
first_line = true
first_comment_tk_kind = nil
line_no = nil
tk = get_tk
while tk && (:on_comment == tk[:kind] or :on_embdoc == tk[:kind])
comment_body = retrieve_comment_body(tk)
if first_line and comment_body =~ /\A#!/ then
skip_tkspace
tk = get_tk
elsif first_line and comment_body =~ /\A#\s*-\*-/ then
first_line = false
skip_tkspace
tk = get_tk
else
break if first_comment_tk_kind and not first_comment_tk_kind === tk[:kind]
first_comment_tk_kind = tk[:kind]
line_no = tk[:line_no] if first_line
first_line = false
comment << comment_body
tk = get_tk
if :on_nl === tk then
skip_tkspace_without_nl
tk = get_tk
end
end
end
unget_tk tk
new_comment comment, line_no
end
##
# Consumes trailing whitespace from the token stream
def consume_trailing_spaces # :nodoc:
skip_tkspace_without_nl
end
##
# Creates a new attribute in +container+ with +name+.
def create_attr container, single, name, rw, comment # :nodoc:
att = RDoc::Attr.new get_tkread, name, rw, comment, single == SINGLE
record_location att
container.add_attribute att
@stats.add_attribute att
att
end
##
# Creates a module alias in +container+ at +rhs_name+ (or at the top-level
# for "::") with the name from +constant+.
def create_module_alias container, constant, rhs_name # :nodoc:
mod = if rhs_name =~ /^::/ then
@store.find_class_or_module rhs_name
else
container.find_module_named rhs_name
end
container.add_module_alias mod, rhs_name, constant, @top_level
end
##
# Aborts with +msg+
def error(msg)
msg = make_message msg
abort msg
end
##
# Looks for a true or false token.
def get_bool
skip_tkspace
tk = get_tk
if :on_kw == tk[:kind] && 'true' == tk[:text]
true
elsif :on_kw == tk[:kind] && ('false' == tk[:text] || 'nil' == tk[:text])
false
else
unget_tk tk
true
end
end
##
# Look for the name of a class of module (optionally with a leading :: or
# with :: separated named) and return the ultimate name, the associated
# container, and the given name (with the ::).
def get_class_or_module container, ignore_constants = false
skip_tkspace
name_t = get_tk
given_name = ''.dup
# class ::A -> A is in the top level
if :on_op == name_t[:kind] and '::' == name_t[:text] then # bug
name_t = get_tk
container = @top_level
given_name << '::'
end
skip_tkspace_without_nl
given_name << name_t[:text]
is_self = name_t[:kind] == :on_op && name_t[:text] == '<<'
new_modules = []
while !is_self && (tk = peek_tk) and :on_op == tk[:kind] and '::' == tk[:text] do
prev_container = container
container = container.find_module_named name_t[:text]
container ||=
if ignore_constants then
c = RDoc::NormalModule.new name_t[:text]
c.store = @store
new_modules << [prev_container, c]
c
else
c = prev_container.add_module RDoc::NormalModule, name_t[:text]
c.ignore unless prev_container.document_children
@top_level.add_to_classes_or_modules c
c
end
record_location container
get_tk
skip_tkspace
if :on_lparen == peek_tk[:kind] # ProcObjectInConstant::()
parse_method_or_yield_parameters
break
end
name_t = get_tk
unless :on_const == name_t[:kind] || :on_ident == name_t[:kind]
raise RDoc::Error, "Invalid class or module definition: #{given_name}"
end
if prev_container == container and !ignore_constants
given_name = name_t[:text]
else
given_name << '::' + name_t[:text]
end
end
skip_tkspace_without_nl
return [container, name_t, given_name, new_modules]
end
##
# Skip opening parentheses and yield the block.
# Skip closing parentheses too when exists.
def skip_parentheses(&block)
left_tk = peek_tk
if :on_lparen == left_tk[:kind]
get_tk
ret = skip_parentheses(&block)
right_tk = peek_tk
if :on_rparen == right_tk[:kind]
get_tk
end
ret
else
yield
end
end
##
# Return a superclass, which can be either a constant of an expression
def get_class_specification
tk = peek_tk
if tk.nil?
return ''
elsif :on_kw == tk[:kind] && 'self' == tk[:text]
return 'self'
elsif :on_gvar == tk[:kind]
return ''
end
res = get_constant
skip_tkspace_without_nl
get_tkread # empty out read buffer
tk = get_tk
return res unless tk
case tk[:kind]
when :on_nl, :on_comment, :on_embdoc, :on_semicolon then
unget_tk(tk)
return res
end
res += parse_call_parameters(tk)
res
end
##
# Parse a constant, which might be qualified by one or more class or module
# names
def get_constant
res = ""
skip_tkspace_without_nl
tk = get_tk
while tk && ((:on_op == tk[:kind] && '::' == tk[:text]) || :on_const == tk[:kind]) do
res += tk[:text]
tk = get_tk
end
unget_tk(tk)
res
end
##
# Get an included module that may be surrounded by parens
def get_included_module_with_optional_parens
skip_tkspace_without_nl
get_tkread
tk = get_tk
end_token = get_end_token tk
return '' unless end_token
nest = 0
continue = false
only_constant = true
while tk != nil do
is_element_of_constant = false
case tk[:kind]
when :on_semicolon then
break if nest == 0
when :on_lbracket then
nest += 1
when :on_rbracket then
nest -= 1
when :on_lbrace then
nest += 1
when :on_rbrace then
nest -= 1
if nest <= 0
# we might have a.each { |i| yield i }
unget_tk(tk) if nest < 0
break
end
when :on_lparen then
nest += 1
when end_token[:kind] then
if end_token[:kind] == :on_rparen
nest -= 1
break if nest <= 0
else
break if nest <= 0
end
when :on_rparen then
nest -= 1
when :on_comment, :on_embdoc then
@read.pop
if :on_nl == end_token[:kind] and "\n" == tk[:text][-1] and
(!continue or (tk[:state] & RDoc::Parser::RipperStateLex::EXPR_LABEL) != 0) then
break if !continue and nest <= 0
end
when :on_comma then
continue = true
when :on_ident then
continue = false if continue
when :on_kw then
case tk[:text]
when 'def', 'do', 'case', 'for', 'begin', 'class', 'module'
nest += 1
when 'if', 'unless', 'while', 'until', 'rescue'
# postfix if/unless/while/until/rescue must be EXPR_LABEL
nest += 1 unless (tk[:state] & RDoc::Parser::RipperStateLex::EXPR_LABEL) != 0
when 'end'
nest -= 1
break if nest == 0
end
when :on_const then
is_element_of_constant = true
when :on_op then
is_element_of_constant = true if '::' == tk[:text]
end
only_constant = false unless is_element_of_constant
tk = get_tk
end
if only_constant
get_tkread_clean(/\s+/, ' ')
else
''
end
end
##
# Little hack going on here. In the statement:
#
# f = 2*(1+yield)
#
# We see the RPAREN as the next token, so we need to exit early. This still
# won't catch all cases (such as "a = yield + 1"
def get_end_token tk # :nodoc:
case tk[:kind]
when :on_lparen
token = RDoc::Parser::RipperStateLex::Token.new
token[:kind] = :on_rparen
token[:text] = ')'
token
when :on_rparen
nil
else
token = RDoc::Parser::RipperStateLex::Token.new
token[:kind] = :on_nl
token[:text] = "\n"
token
end
end
##
# Retrieves the method container for a singleton method.
def get_method_container container, name_t # :nodoc:
prev_container = container
container = container.find_module_named(name_t[:text])
unless container then
constant = prev_container.constants.find do |const|
const.name == name_t[:text]
end
if constant then
parse_method_dummy prev_container
return
end
end
unless container then
# TODO seems broken, should starting at Object in @store
obj = name_t[:text].split("::").inject(Object) do |state, item|
state.const_get(item)
end rescue nil
type = obj.class == Class ? RDoc::NormalClass : RDoc::NormalModule
unless [Class, Module].include?(obj.class) then
warn("Couldn't find #{name_t[:text]}. Assuming it's a module")
end
if type == RDoc::NormalClass then
sclass = obj.superclass ? obj.superclass.name : nil
container = prev_container.add_class type, name_t[:text], sclass
else
container = prev_container.add_module type, name_t[:text]
end
record_location container
end
container
end
##
# Extracts a name or symbol from the token stream.
def get_symbol_or_name
tk = get_tk
case tk[:kind]
when :on_symbol then
text = tk[:text].sub(/^:/, '')
next_tk = peek_tk
if next_tk && :on_op == next_tk[:kind] && '=' == next_tk[:text] then
get_tk
text << '='
end
text
when :on_ident, :on_const, :on_gvar, :on_cvar, :on_ivar, :on_op, :on_kw then
tk[:text]
when :on_tstring, :on_dstring then
tk[:text][1..-2]
else
raise RDoc::Error, "Name or symbol expected (got #{tk})"
end
end
##
# Marks containers between +container+ and +ancestor+ as ignored
def suppress_parents container, ancestor # :nodoc:
while container and container != ancestor do
container.suppress unless container.documented?
container = container.parent
end
end
##
# Look for directives in a normal comment block:
#
# # :stopdoc:
# # Don't display comment from this point forward
#
# This routine modifies its +comment+ parameter.
def look_for_directives_in container, comment
@preprocess.handle comment, container do |directive, param|
case directive
when 'method', 'singleton-method',
'attr', 'attr_accessor', 'attr_reader', 'attr_writer' then
false # handled elsewhere
when 'section' then
break unless container.kind_of?(RDoc::Context)
container.set_current_section param, comment.dup
comment.text = ''
break
end
end
comment.remove_private
end
##
# Adds useful info about the parser to +message+
def make_message message
prefix = "#{@file_name}:".dup
tk = peek_tk
prefix << "#{tk[:line_no]}:#{tk[:char_no]}:" if tk
"#{prefix} #{message}"
end
##
# Creates a comment with the correct format
def new_comment comment, line_no = nil
c = RDoc::Comment.new comment, @top_level, :ruby
c.line = line_no
c.format = @markup
c
end
##
# Creates an RDoc::Attr for the name following +tk+, setting the comment to
# +comment+.
def parse_attr(context, single, tk, comment)
line_no = tk[:line_no]
args = parse_symbol_arg 1
if args.size > 0 then
name = args[0]
rw = "R"
skip_tkspace_without_nl
tk = get_tk
if :on_comma == tk[:kind] then
rw = "RW" if get_bool
else
unget_tk tk
end
att = create_attr context, single, name, rw, comment
att.line = line_no
read_documentation_modifiers att, RDoc::ATTR_MODIFIERS
else
warn "'attr' ignored - looks like a variable"
end
end
##
# Creates an RDoc::Attr for each attribute listed after +tk+, setting the
# comment for each to +comment+.
def parse_attr_accessor(context, single, tk, comment)
line_no = tk[:line_no]
args = parse_symbol_arg
rw = "?"
tmp = RDoc::CodeObject.new
read_documentation_modifiers tmp, RDoc::ATTR_MODIFIERS
# TODO In most other places we let the context keep track of document_self
# and add found items appropriately but here we do not. I'm not sure why.
return if @track_visibility and not tmp.document_self
case tk[:text]
when "attr_reader" then rw = "R"
when "attr_writer" then rw = "W"
when "attr_accessor" then rw = "RW"
else
rw = '?'
end
for name in args
att = create_attr context, single, name, rw, comment
att.line = line_no
end
end
##
# Parses an +alias+ in +context+ with +comment+
def parse_alias(context, single, tk, comment)
line_no = tk[:line_no]
skip_tkspace
if :on_lparen === peek_tk[:kind] then
get_tk
skip_tkspace
end
new_name = get_symbol_or_name
skip_tkspace
if :on_comma === peek_tk[:kind] then
get_tk
skip_tkspace
end
begin
old_name = get_symbol_or_name
rescue RDoc::Error
return
end
al = RDoc::Alias.new(get_tkread, old_name, new_name, comment,
single == SINGLE)
record_location al
al.line = line_no
read_documentation_modifiers al, RDoc::ATTR_MODIFIERS
context.add_alias al
@stats.add_alias al
al
end
##
# Extracts call parameters from the token stream.
def parse_call_parameters(tk)
end_token = case tk[:kind]
when :on_lparen
:on_rparen
when :on_rparen
return ""
else
:on_nl
end
nest = 0
loop do
break if tk.nil?
case tk[:kind]
when :on_semicolon
break
when :on_lparen
nest += 1
when end_token
if end_token == :on_rparen
nest -= 1
break if RDoc::Parser::RipperStateLex.end?(tk) and nest <= 0
else
break if RDoc::Parser::RipperStateLex.end?(tk)
end
when :on_comment, :on_embdoc
unget_tk(tk)
break
when :on_op
if tk[:text] =~ /^(.{1,2})?=$/
unget_tk(tk)
break
end
end
tk = get_tk
end
get_tkread_clean "\n", " "
end
##
# Parses a class in +context+ with +comment+
def parse_class container, single, tk, comment
line_no = tk[:line_no]
declaration_context = container
container, name_t, given_name, = get_class_or_module container
if name_t[:kind] == :on_const
cls = parse_class_regular container, declaration_context, single,
name_t, given_name, comment
elsif name_t[:kind] == :on_op && name_t[:text] == '<<'
case name = skip_parentheses { get_class_specification }
when 'self', container.name
read_documentation_modifiers cls, RDoc::CLASS_MODIFIERS
parse_statements container, SINGLE
return # don't update line
else
cls = parse_class_singleton container, name, comment
end
else
warn "Expected class name or '<<'. Got #{name_t[:kind]}: #{name_t[:text].inspect}"
return
end
cls.line = line_no
# after end modifiers
read_documentation_modifiers cls, RDoc::CLASS_MODIFIERS
cls
end
##
# Parses and creates a regular class
def parse_class_regular container, declaration_context, single, # :nodoc:
name_t, given_name, comment
superclass = '::Object'
if given_name =~ /^::/ then
declaration_context = @top_level
given_name = $'
end
tk = peek_tk
if tk[:kind] == :on_op && tk[:text] == '<' then
get_tk
skip_tkspace
superclass = get_class_specification
superclass = '(unknown)' if superclass.empty?
end
cls_type = single == SINGLE ? RDoc::SingleClass : RDoc::NormalClass
cls = declaration_context.add_class cls_type, given_name, superclass
cls.ignore unless container.document_children
read_documentation_modifiers cls, RDoc::CLASS_MODIFIERS
record_location cls
cls.add_comment comment, @top_level
@top_level.add_to_classes_or_modules cls
@stats.add_class cls
suppress_parents container, declaration_context unless cls.document_self
parse_statements cls
cls
end
##
# Parses a singleton class in +container+ with the given +name+ and
# +comment+.
def parse_class_singleton container, name, comment # :nodoc:
other = @store.find_class_named name
unless other then
if name =~ /^::/ then
name = $'
container = @top_level
end
other = container.add_module RDoc::NormalModule, name
record_location other
# class << $gvar
other.ignore if name.empty?
other.add_comment comment, @top_level
end
# notify :nodoc: all if not a constant-named class/module
# (and remove any comment)
unless name =~ /\A(::)?[A-Z]/ then
other.document_self = nil
other.document_children = false
other.clear_comment
end
@top_level.add_to_classes_or_modules other
@stats.add_class other
read_documentation_modifiers other, RDoc::CLASS_MODIFIERS
parse_statements(other, SINGLE)
other
end
##
# Parses a constant in +context+ with +comment+. If +ignore_constants+ is
# true, no found constants will be added to RDoc.
def parse_constant container, tk, comment, ignore_constants = false
line_no = tk[:line_no]
name = tk[:text]
skip_tkspace_without_nl
return unless name =~ /^\w+$/
new_modules = []
if :on_op == peek_tk[:kind] && '::' == peek_tk[:text] then
unget_tk tk
container, name_t, _, new_modules = get_class_or_module container, true
name = name_t[:text]
end
is_array_or_hash = false
if peek_tk && :on_lbracket == peek_tk[:kind]
get_tk
nest = 1
while bracket_tk = get_tk
case bracket_tk[:kind]
when :on_lbracket
nest += 1
when :on_rbracket
nest -= 1
break if nest == 0
end
end
skip_tkspace_without_nl
is_array_or_hash = true
end
unless peek_tk && :on_op == peek_tk[:kind] && '=' == peek_tk[:text] then
return false
end
get_tk
unless ignore_constants
new_modules.each do |prev_c, new_module|
prev_c.add_module_by_normal_module new_module
new_module.ignore unless prev_c.document_children
@top_level.add_to_classes_or_modules new_module
end
end
value = ''
con = RDoc::Constant.new name, value, comment
body = parse_constant_body container, con, is_array_or_hash
return unless body
con.value = body
record_location con
con.line = line_no
read_documentation_modifiers con, RDoc::CONSTANT_MODIFIERS
return if is_array_or_hash
@stats.add_constant con
container.add_constant con
true
end
def parse_constant_body container, constant, is_array_or_hash # :nodoc:
nest = 0
rhs_name = ''.dup
get_tkread
tk = get_tk
body = nil
loop do
break if tk.nil?
if :on_semicolon == tk[:kind] then
break if nest <= 0
elsif [:on_tlambeg, :on_lparen, :on_lbrace, :on_lbracket].include?(tk[:kind]) then
nest += 1
elsif (:on_kw == tk[:kind] && 'def' == tk[:text]) then
nest += 1
elsif (:on_kw == tk[:kind] && %w{do if unless case begin}.include?(tk[:text])) then
if (tk[:state] & RDoc::Parser::RipperStateLex::EXPR_LABEL) == 0
nest += 1
end
elsif [:on_rparen, :on_rbrace, :on_rbracket].include?(tk[:kind]) ||
(:on_kw == tk[:kind] && 'end' == tk[:text]) then
nest -= 1
elsif (:on_comment == tk[:kind] or :on_embdoc == tk[:kind]) then
unget_tk tk
if nest <= 0 and RDoc::Parser::RipperStateLex.end?(tk) then
body = get_tkread_clean(/^[ \t]+/, '')
read_documentation_modifiers constant, RDoc::CONSTANT_MODIFIERS
break
else
read_documentation_modifiers constant, RDoc::CONSTANT_MODIFIERS
end
elsif :on_const == tk[:kind] then
rhs_name << tk[:text]
next_tk = peek_tk
if nest <= 0 and (next_tk.nil? || :on_nl == next_tk[:kind]) then
create_module_alias container, constant, rhs_name unless is_array_or_hash
break
end
elsif :on_nl == tk[:kind] then
if nest <= 0 and RDoc::Parser::RipperStateLex.end?(tk) then
unget_tk tk
break
end
elsif :on_op == tk[:kind] && '::' == tk[:text]
rhs_name << '::'
end
tk = get_tk
end
body ? body : get_tkread_clean(/^[ \t]+/, '')
end
##
# Generates an RDoc::Method or RDoc::Attr from +comment+ by looking for
# :method: or :attr: directives in +comment+.
def parse_comment container, tk, comment
return parse_comment_tomdoc container, tk, comment if @markup == 'tomdoc'
column = tk[:char_no]
line_no = comment.line.nil? ? tk[:line_no] : comment.line
comment.text = comment.text.sub(/(^# +:?)(singleton-)(method:)/, '\1\3')
singleton = !!$~
co =
if (comment.text = comment.text.sub(/^# +:?method: *(\S*).*?\n/i, '')) && !!$~ then
line_no += $`.count("\n")
parse_comment_ghost container, comment.text, $1, column, line_no, comment
elsif (comment.text = comment.text.sub(/# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i, '')) && !!$~ then
parse_comment_attr container, $1, $3, comment
end
if co then
co.singleton = singleton
co.line = line_no
end
true
end
##
# Parse a comment that is describing an attribute in +container+ with the
# given +name+ and +comment+.
def parse_comment_attr container, type, name, comment # :nodoc:
return if name.empty?
rw = case type
when 'attr_reader' then 'R'
when 'attr_writer' then 'W'
else 'RW'
end
create_attr container, NORMAL, name, rw, comment
end
def parse_comment_ghost container, text, name, column, line_no, # :nodoc:
comment
name = nil if name.empty?
meth = RDoc::GhostMethod.new get_tkread, name
record_location meth
meth.start_collecting_tokens
indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
position_comment = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
position_comment[:text] = "# File #{@top_level.relative_name}, line #{line_no}"
newline = RDoc::Parser::RipperStateLex::Token.new(0, 0, :on_nl, "\n")
meth.add_tokens [position_comment, newline, indent]
meth.params =
if text.sub!(/^#\s+:?args?:\s*(.*?)\s*$/i, '') then
$1
else
''
end
comment.normalize
comment.extract_call_seq meth
return unless meth.name
container.add_method meth
meth.comment = comment
@stats.add_method meth
meth
end
##
# Creates an RDoc::Method on +container+ from +comment+ if there is a
# Signature section in the comment
def parse_comment_tomdoc container, tk, comment
return unless signature = RDoc::TomDoc.signature(comment)
column = tk[:char_no]
line_no = tk[:line_no]
name, = signature.split %r%[ \(]%, 2
meth = RDoc::GhostMethod.new get_tkread, name
record_location meth
meth.line = line_no
meth.start_collecting_tokens
indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
position_comment = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
position_comment[:text] = "# File #{@top_level.relative_name}, line #{line_no}"
newline = RDoc::Parser::RipperStateLex::Token.new(0, 0, :on_nl, "\n")
meth.add_tokens [position_comment, newline, indent]
meth.call_seq = signature
comment.normalize
return unless meth.name
container.add_method meth
meth.comment = comment
@stats.add_method meth
end
##
# Parses an +include+ or +extend+, indicated by the +klass+ and adds it to
# +container+ # with +comment+
def parse_extend_or_include klass, container, comment # :nodoc:
loop do
skip_tkspace_comment
name = get_included_module_with_optional_parens
unless name.empty? then
obj = container.add klass, name, comment
record_location obj
end
return if peek_tk.nil? || :on_comma != peek_tk[:kind]
get_tk
end
end
##
# Parses an +included+ with a block feature of ActiveSupport::Concern.
def parse_included_with_activesupport_concern container, comment # :nodoc:
skip_tkspace_without_nl
tk = get_tk
unless tk[:kind] == :on_lbracket || (tk[:kind] == :on_kw && tk[:text] == 'do')
unget_tk tk
return nil # should be a block
end
parse_statements container
container
end
##
# Parses identifiers that can create new methods or change visibility.
#
# Returns true if the comment was not consumed.
def parse_identifier container, single, tk, comment # :nodoc:
case tk[:text]
when 'private', 'protected', 'public', 'private_class_method',
'public_class_method', 'module_function' then
parse_visibility container, single, tk
return true
when 'private_constant', 'public_constant'
parse_constant_visibility container, single, tk
return true
when 'attr' then
parse_attr container, single, tk, comment
when /^attr_(reader|writer|accessor)$/ then
parse_attr_accessor container, single, tk, comment
when 'alias_method' then
parse_alias container, single, tk, comment
when 'require', 'include' then
# ignore
else
if comment.text =~ /\A#\#$/ then
case comment.text
when /^# +:?attr(_reader|_writer|_accessor)?:/ then
parse_meta_attr container, single, tk, comment
else
method = parse_meta_method container, single, tk, comment
method.params = container.params if
container.params
method.block_params = container.block_params if
container.block_params
end
end
end
false
end
##
# Parses a meta-programmed attribute and creates an RDoc::Attr.
#
# To create foo and bar attributes on class C with comment "My attributes":
#
# class C
#
# ##
# # :attr:
# #
# # My attributes
#
# my_attr :foo, :bar
#
# end
#
# To create a foo attribute on class C with comment "My attribute":
#
# class C
#
# ##
# # :attr: foo
# #
# # My attribute
#
# my_attr :foo, :bar
#
# end
def parse_meta_attr(context, single, tk, comment)
args = parse_symbol_arg
rw = "?"
# If nodoc is given, don't document any of them
tmp = RDoc::CodeObject.new
read_documentation_modifiers tmp, RDoc::ATTR_MODIFIERS
regexp = /^# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i
if regexp =~ comment.text then
comment.text = comment.text.sub(regexp, '')
rw = case $1
when 'attr_reader' then 'R'
when 'attr_writer' then 'W'
else 'RW'
end
name = $3 unless $3.empty?
end
if name then
att = create_attr context, single, name, rw, comment
else
args.each do |attr_name|
att = create_attr context, single, attr_name, rw, comment
end
end
att
end
##
# Parses a meta-programmed method
def parse_meta_method(container, single, tk, comment)
column = tk[:char_no]
line_no = tk[:line_no]
start_collecting_tokens
add_token tk
add_token_listener self
skip_tkspace_without_nl
comment.text = comment.text.sub(/(^# +:?)(singleton-)(method:)/, '\1\3')
singleton = !!$~
name = parse_meta_method_name comment, tk
return unless name
meth = RDoc::MetaMethod.new get_tkread, name
record_location meth
meth.line = line_no
meth.singleton = singleton
remove_token_listener self
meth.start_collecting_tokens
indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
position_comment = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
position_comment[:text] = "# File #{@top_level.relative_name}, line #{line_no}"
newline = RDoc::Parser::RipperStateLex::Token.new(0, 0, :on_nl, "\n")
meth.add_tokens [position_comment, newline, indent]
meth.add_tokens @token_stream
parse_meta_method_params container, single, meth, tk, comment
meth.comment = comment
@stats.add_method meth
meth
end
##
# Parses the name of a metaprogrammed method. +comment+ is used to
# determine the name while +tk+ is used in an error message if the name
# cannot be determined.
def parse_meta_method_name comment, tk # :nodoc:
if comment.text.sub!(/^# +:?method: *(\S*).*?\n/i, '') then
return $1 unless $1.empty?
end
name_t = get_tk
if :on_symbol == name_t[:kind] then
name_t[:text][1..-1]
elsif :on_tstring == name_t[:kind] then
name_t[:text][1..-2]
elsif :on_op == name_t[:kind] && '=' == name_t[:text] then # ignore
remove_token_listener self
nil
else
warn "unknown name token #{name_t.inspect} for meta-method '#{tk[:text]}'"
'unknown'
end
end
##
# Parses the parameters and block for a meta-programmed method.
def parse_meta_method_params container, single, meth, tk, comment # :nodoc:
token_listener meth do
meth.params = ''
look_for_directives_in meth, comment
comment.normalize
comment.extract_call_seq meth
container.add_method meth
last_tk = tk
while tk = get_tk do
if :on_semicolon == tk[:kind] then
break
elsif :on_nl == tk[:kind] then
break unless last_tk and :on_comma == last_tk[:kind]
elsif :on_sp == tk[:kind] then
# expression continues
elsif :on_kw == tk[:kind] && 'do' == tk[:text] then
parse_statements container, single, meth
break
else
last_tk = tk
end
end
end
end
##
# Parses a normal method defined by +def+
def parse_method(container, single, tk, comment)
singleton = nil
added_container = false
name = nil
column = tk[:char_no]
line_no = tk[:line_no]
start_collecting_tokens
add_token tk
token_listener self do
prev_container = container
name, container, singleton = parse_method_name container
added_container = container != prev_container
end
return unless name
meth = RDoc::AnyMethod.new get_tkread, name
look_for_directives_in meth, comment
meth.singleton = single == SINGLE ? true : singleton
record_location meth
meth.line = line_no
meth.start_collecting_tokens
indent = RDoc::Parser::RipperStateLex::Token.new(1, 1, :on_sp, ' ' * column)
token = RDoc::Parser::RipperStateLex::Token.new(line_no, 1, :on_comment)
token[:text] = "# File #{@top_level.relative_name}, line #{line_no}"
newline = RDoc::Parser::RipperStateLex::Token.new(0, 0, :on_nl, "\n")
meth.add_tokens [token, newline, indent]
meth.add_tokens @token_stream
parse_method_params_and_body container, single, meth, added_container
comment.normalize
comment.extract_call_seq meth
meth.comment = comment
# after end modifiers
read_documentation_modifiers meth, RDoc::METHOD_MODIFIERS
@stats.add_method meth
end
##
# Parses the parameters and body of +meth+
def parse_method_params_and_body container, single, meth, added_container
token_listener meth do
parse_method_parameters meth
if meth.document_self or not @track_visibility then
container.add_method meth
elsif added_container then
container.document_self = false
end
# Having now read the method parameters and documentation modifiers, we
# now know whether we have to rename #initialize to ::new
if meth.name == "initialize" && !meth.singleton then
if meth.dont_rename_initialize then
meth.visibility = :protected
else
meth.singleton = true
meth.name = "new"
meth.visibility = :public
end
end
parse_statements container, single, meth
end
end
##
# Parses a method that needs to be ignored.
def parse_method_dummy container
dummy = RDoc::Context.new
dummy.parent = container
dummy.store = container.store
skip_method dummy
end
##
# Parses the name of a method in +container+.
#
# Returns the method name, the container it is in (for def Foo.name) and if
# it is a singleton or regular method.
def parse_method_name container # :nodoc:
skip_tkspace
name_t = get_tk
back_tk = skip_tkspace_without_nl
singleton = false
dot = get_tk
if dot[:kind] == :on_period || (dot[:kind] == :on_op && dot[:text] == '::') then
singleton = true
name, container = parse_method_name_singleton container, name_t
else
unget_tk dot
back_tk.reverse_each do |token|
unget_tk token
end
name = parse_method_name_regular container, name_t
end
return name, container, singleton
end
##
# For the given +container+ and initial name token +name_t+ the method name
# is parsed from the token stream for a regular method.
def parse_method_name_regular container, name_t # :nodoc:
if :on_op == name_t[:kind] && (%w{* & [] []= <<}.include?(name_t[:text])) then
name_t[:text]
else
unless [:on_kw, :on_const, :on_ident].include?(name_t[:kind]) then
warn "expected method name token, . or ::, got #{name_t.inspect}"
skip_method container
return
end
name_t[:text]
end
end
##
# For the given +container+ and initial name token +name_t+ the method name
# and the new +container+ (if necessary) are parsed from the token stream
# for a singleton method.
def parse_method_name_singleton container, name_t # :nodoc:
skip_tkspace
name_t2 = get_tk
if (:on_kw == name_t[:kind] && 'self' == name_t[:text]) || (:on_op == name_t[:kind] && '%' == name_t[:text]) then
# NOTE: work around '[' being consumed early
if :on_lbracket == name_t2[:kind]
get_tk
name = '[]'
else
name = name_t2[:text]
end
elsif :on_const == name_t[:kind] then
name = name_t2[:text]
container = get_method_container container, name_t
return unless container
name
elsif :on_ident == name_t[:kind] || :on_ivar == name_t[:kind] || :on_gvar == name_t[:kind] then
parse_method_dummy container
name = nil
elsif (:on_kw == name_t[:kind]) && ('true' == name_t[:text] || 'false' == name_t[:text] || 'nil' == name_t[:text]) then
klass_name = "#{name_t[:text].capitalize}Class"
container = @store.find_class_named klass_name
container ||= @top_level.add_class RDoc::NormalClass, klass_name
name = name_t2[:text]
else
warn "unexpected method name token #{name_t.inspect}"
# break
skip_method container
name = nil
end
return name, container
end
##
# Extracts +yield+ parameters from +method+
def parse_method_or_yield_parameters(method = nil,
modifiers = RDoc::METHOD_MODIFIERS)
skip_tkspace_without_nl
tk = get_tk
end_token = get_end_token tk
return '' unless end_token
nest = 0
continue = false
while tk != nil do
case tk[:kind]
when :on_semicolon then
break if nest == 0
when :on_lbracket then
nest += 1
when :on_rbracket then
nest -= 1
when :on_lbrace then
nest += 1
when :on_rbrace then
nest -= 1
if nest <= 0
# we might have a.each { |i| yield i }
unget_tk(tk) if nest < 0
break
end
when :on_lparen then
nest += 1
when end_token[:kind] then
if end_token[:kind] == :on_rparen
nest -= 1
break if nest <= 0
else
break
end
when :on_rparen then
nest -= 1
when :on_comment, :on_embdoc then
@read.pop
if :on_nl == end_token[:kind] and "\n" == tk[:text][-1] and
(!continue or (tk[:state] & RDoc::Parser::RipperStateLex::EXPR_LABEL) != 0) then
if method && method.block_params.nil? then
unget_tk tk
read_documentation_modifiers method, modifiers
end
break if !continue and nest <= 0
end
when :on_comma then
continue = true
when :on_ident then
continue = false if continue
end
tk = get_tk
end
get_tkread_clean(/\s+/, ' ')
end
##
# Capture the method's parameters. Along the way, look for a comment
# containing:
#
# # yields: ....
#
# and add this as the block_params for the method
def parse_method_parameters method
res = parse_method_or_yield_parameters method
res = "(#{res})" unless res =~ /\A\(/
method.params = res unless method.params
return if method.block_params
skip_tkspace_without_nl
read_documentation_modifiers method, RDoc::METHOD_MODIFIERS
end
##
# Parses an RDoc::NormalModule in +container+ with +comment+
def parse_module container, single, tk, comment
container, name_t, = get_class_or_module container
name = name_t[:text]
mod = container.add_module RDoc::NormalModule, name
mod.ignore unless container.document_children
record_location mod
read_documentation_modifiers mod, RDoc::CLASS_MODIFIERS
mod.add_comment comment, @top_level
parse_statements mod
# after end modifiers
read_documentation_modifiers mod, RDoc::CLASS_MODIFIERS
@stats.add_module mod
end
##
# Parses an RDoc::Require in +context+ containing +comment+
def parse_require(context, comment)
skip_tkspace_comment
tk = get_tk
if :on_lparen == tk[:kind] then
skip_tkspace_comment
tk = get_tk
end
name = tk[:text][1..-2] if :on_tstring == tk[:kind]
if name then
@top_level.add_require RDoc::Require.new(name, comment)
else
unget_tk tk
end
end
##
# Parses a rescue
def parse_rescue
skip_tkspace_without_nl
while tk = get_tk
case tk[:kind]
when :on_nl, :on_semicolon, :on_comment then
break
when :on_comma then
skip_tkspace_without_nl
get_tk if :on_nl == peek_tk[:kind]
end
skip_tkspace_without_nl
end
end
##
# Retrieve comment body without =begin/=end
def retrieve_comment_body(tk)
if :on_embdoc == tk[:kind]
tk[:text].gsub(/\A=begin.*\n/, '').gsub(/=end\n?\z/, '')
else
tk[:text]
end
end
##
# The core of the Ruby parser.
def parse_statements(container, single = NORMAL, current_method = nil,
comment = new_comment(''))
raise 'no' unless RDoc::Comment === comment
comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
nest = 1
save_visibility = container.visibility
non_comment_seen = true
while tk = get_tk do
keep_comment = false
try_parse_comment = false
non_comment_seen = true unless (:on_comment == tk[:kind] or :on_embdoc == tk[:kind])
case tk[:kind]
when :on_nl, :on_ignored_nl, :on_comment, :on_embdoc then
if :on_nl == tk[:kind] or :on_ignored_nl == tk[:kind]
skip_tkspace
tk = get_tk
else
past_tokens = @read.size > 1 ? @read[0..-2] : []
nl_position = 0
past_tokens.reverse.each_with_index do |read_tk, i|
if read_tk =~ /^\n$/ then
nl_position = (past_tokens.size - 1) - i
break
elsif read_tk =~ /^#.*\n$/ then
nl_position = ((past_tokens.size - 1) - i) + 1
break
end
end
comment_only_line = past_tokens[nl_position..-1].all?{ |c| c =~ /^\s+$/ }
unless comment_only_line then
tk = get_tk
end
end
if tk and (:on_comment == tk[:kind] or :on_embdoc == tk[:kind]) then
if non_comment_seen then
# Look for RDoc in a comment about to be thrown away
non_comment_seen = parse_comment container, tk, comment unless
comment.empty?
comment = ''
comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
end
line_no = nil
while tk and (:on_comment == tk[:kind] or :on_embdoc == tk[:kind]) do
comment_body = retrieve_comment_body(tk)
line_no = tk[:line_no] if comment.empty?
comment += comment_body
comment << "\n" unless comment_body =~ /\n\z/
if comment_body.size > 1 && comment_body =~ /\n\z/ then
skip_tkspace_without_nl # leading spaces
end
tk = get_tk
end
comment = new_comment comment, line_no
unless comment.empty? then
look_for_directives_in container, comment
if container.done_documenting then
throw :eof if RDoc::TopLevel === container
container.ongoing_visibility = save_visibility
end
end
keep_comment = true
else
non_comment_seen = true
end
unget_tk tk
keep_comment = true
container.current_line_visibility = nil
when :on_kw then
case tk[:text]
when 'class' then
parse_class container, single, tk, comment
when 'module' then
parse_module container, single, tk, comment
when 'def' then
parse_method container, single, tk, comment
when 'alias' then
parse_alias container, single, tk, comment unless current_method
when 'yield' then
if current_method.nil? then
warn "Warning: yield outside of method" if container.document_self
else
parse_yield container, single, tk, current_method
end
when 'until', 'while' then
if (tk[:state] & RDoc::Parser::RipperStateLex::EXPR_LABEL) == 0
nest += 1
skip_optional_do_after_expression
end
# Until and While can have a 'do', which shouldn't increase the nesting.
# We can't solve the general case, but we can handle most occurrences by
# ignoring a do at the end of a line.
# 'for' is trickier
when 'for' then
nest += 1
skip_for_variable
skip_optional_do_after_expression
when 'case', 'do', 'if', 'unless', 'begin' then
if (tk[:state] & RDoc::Parser::RipperStateLex::EXPR_LABEL) == 0
nest += 1
end
when 'super' then
current_method.calls_super = true if current_method
when 'rescue' then
parse_rescue
when 'end' then
nest -= 1
if nest == 0 then
container.ongoing_visibility = save_visibility
parse_comment container, tk, comment unless comment.empty?
return
end
end
when :on_const then
unless parse_constant container, tk, comment, current_method then
try_parse_comment = true
end
when :on_ident then
if nest == 1 and current_method.nil? then
keep_comment = parse_identifier container, single, tk, comment
end
case tk[:text]
when "require" then
parse_require container, comment
when "include" then
parse_extend_or_include RDoc::Include, container, comment
when "extend" then
parse_extend_or_include RDoc::Extend, container, comment
when "included" then
parse_included_with_activesupport_concern container, comment
end
else
try_parse_comment = nest == 1
end
if try_parse_comment then
non_comment_seen = parse_comment container, tk, comment unless
comment.empty?
keep_comment = false
end
unless keep_comment then
comment = new_comment ''
comment = RDoc::Encoding.change_encoding comment, @encoding if @encoding
container.params = nil
container.block_params = nil
end
consume_trailing_spaces
end
container.params = nil
container.block_params = nil
end
##
# Parse up to +no+ symbol arguments
def parse_symbol_arg(no = nil)
skip_tkspace_comment
tk = get_tk
if tk[:kind] == :on_lparen
parse_symbol_arg_paren no
else
parse_symbol_arg_space no, tk
end
end
##
# Parses up to +no+ symbol arguments surrounded by () and places them in
# +args+.
def parse_symbol_arg_paren no # :nodoc:
args = []
loop do
skip_tkspace_comment
if tk1 = parse_symbol_in_arg
args.push tk1
break if no and args.size >= no
end
skip_tkspace_comment
case (tk2 = get_tk)[:kind]
when :on_rparen
break
when :on_comma
else
warn("unexpected token: '#{tk2.inspect}'") if $DEBUG_RDOC
break
end
end
args
end
##
# Parses up to +no+ symbol arguments separated by spaces and places them in
# +args+.
def parse_symbol_arg_space no, tk # :nodoc:
args = []
unget_tk tk
if tk = parse_symbol_in_arg
args.push tk
return args if no and args.size >= no
end
loop do
skip_tkspace_without_nl
tk1 = get_tk
if tk1.nil? || :on_comma != tk1[:kind] then
unget_tk tk1
break
end
skip_tkspace_comment
if tk = parse_symbol_in_arg
args.push tk
break if no and args.size >= no
end
end
args
end
##
# Returns symbol text from the next token
def parse_symbol_in_arg
tk = get_tk
if :on_symbol == tk[:kind] then
tk[:text].sub(/^:/, '')
elsif :on_tstring == tk[:kind] then
tk[:text][1..-2]
elsif :on_dstring == tk[:kind] or :on_ident == tk[:kind] then
nil # ignore
else
warn("Expected symbol or string, got #{tk.inspect}") if $DEBUG_RDOC
nil
end
end
##
# Parses statements in the top-level +container+
def parse_top_level_statements container
comment = collect_first_comment
look_for_directives_in container, comment
throw :eof if container.done_documenting
@markup = comment.format
# HACK move if to RDoc::Context#comment=
container.comment = comment if container.document_self unless comment.empty?
parse_statements container, NORMAL, nil, comment
end
##
# Determines the visibility in +container+ from +tk+
def parse_visibility(container, single, tk)
vis_type, vis, singleton = get_visibility_information tk, single
skip_tkspace_comment false
ptk = peek_tk
# Ryan Davis suggested the extension to ignore modifiers, because he
# often writes
#
# protected unless $TESTING
#
if [:on_nl, :on_semicolon].include?(ptk[:kind]) || (:on_kw == ptk[:kind] && (['if', 'unless'].include?(ptk[:text]))) then
container.ongoing_visibility = vis
elsif :on_kw == ptk[:kind] && 'def' == ptk[:text]
container.current_line_visibility = vis
else
update_visibility container, vis_type, vis, singleton
end
end
##
# Parses a Module#private_constant or Module#public_constant call from +tk+.
def parse_constant_visibility(container, single, tk)
args = parse_symbol_arg
case tk[:text]
when 'private_constant'
vis = :private
when 'public_constant'
vis = :public
else
raise RDoc::Error, 'Unreachable'
end
container.set_constant_visibility_for args, vis
end
##
# Determines the block parameter for +context+
def parse_yield(context, single, tk, method)
return if method.block_params
get_tkread
method.block_params = parse_method_or_yield_parameters
end
##
# Directives are modifier comments that can appear after class, module, or
# method names. For example:
#
# def fred # :yields: a, b
#
# or:
#
# class MyClass # :nodoc:
#
# We return the directive name and any parameters as a two element array if
# the name is in +allowed+. A directive can be found anywhere up to the end
# of the current line.
def read_directive allowed
tokens = []
while tk = get_tk do
tokens << tk
if :on_nl == tk[:kind] or (:on_kw == tk[:kind] && 'def' == tk[:text]) then
return
elsif :on_comment == tk[:kind] or :on_embdoc == tk[:kind] then
return unless tk[:text] =~ /:?\b([\w-]+):\s*(.*)/
directive = $1.downcase
return [directive, $2] if allowed.include? directive
return
end
end
ensure
unless tokens.length == 1 and (:on_comment == tokens.first[:kind] or :on_embdoc == tokens.first[:kind]) then
tokens.reverse_each do |token|
unget_tk token
end
end
end
##
# Handles directives following the definition for +context+ (any
# RDoc::CodeObject) if the directives are +allowed+ at this point.
#
# See also RDoc::Markup::PreProcess#handle_directive
def read_documentation_modifiers context, allowed
skip_tkspace_without_nl
directive, value = read_directive allowed
return unless directive
@preprocess.handle_directive '', directive, value, context do |dir, param|
if %w[notnew not_new not-new].include? dir then
context.dont_rename_initialize = true
true
end
end
end
##
# Records the location of this +container+ in the file for this parser and
# adds it to the list of classes and modules in the file.
def record_location container # :nodoc:
case container
when RDoc::ClassModule then
@top_level.add_to_classes_or_modules container
end
container.record_location @top_level
end
##
# Scans this Ruby file for Ruby constructs
def scan
reset
catch :eof do
begin
parse_top_level_statements @top_level
rescue StandardError => e
if @content.include?('<%') and @content.include?('%>') then
# Maybe, this is ERB.
$stderr.puts "\033[2KRDoc detects ERB file. Skips it for compatibility:"
$stderr.puts @file_name
return
end
if @scanner_point >= @scanner.size
now_line_no = @scanner[@scanner.size - 1][:line_no]
else
now_line_no = peek_tk[:line_no]
end
first_tk_index = @scanner.find_index { |tk| tk[:line_no] == now_line_no }
last_tk_index = @scanner.find_index { |tk| tk[:line_no] == now_line_no + 1 }
last_tk_index = last_tk_index ? last_tk_index - 1 : @scanner.size - 1
code = @scanner[first_tk_index..last_tk_index].map{ |t| t[:text] }.join
$stderr.puts <<-EOF
#{self.class} failure around line #{now_line_no} of
#{@file_name}
EOF
unless code.empty? then
$stderr.puts code
$stderr.puts
end
raise e
end
end
@top_level
end
##
# while, until, and for have an optional do
def skip_optional_do_after_expression
skip_tkspace_without_nl
tk = get_tk
b_nest = 0
nest = 0
loop do
break unless tk
case tk[:kind]
when :on_semicolon, :on_nl, :on_ignored_nl then
break if b_nest.zero?
when :on_lparen then
nest += 1
when :on_rparen then
nest -= 1
when :on_kw then
case tk[:text]
when 'begin'
b_nest += 1
when 'end'
b_nest -= 1
when 'do'
break if nest.zero?
end
when :on_comment, :on_embdoc then
if b_nest.zero? and "\n" == tk[:text][-1] then
break
end
end
tk = get_tk
end
skip_tkspace_without_nl
get_tk if peek_tk && :on_kw == peek_tk[:kind] && 'do' == peek_tk[:text]
end
##
# skip the var [in] part of a 'for' statement
def skip_for_variable
skip_tkspace_without_nl
get_tk
skip_tkspace_without_nl
tk = get_tk
unget_tk(tk) unless :on_kw == tk[:kind] and 'in' == tk[:text]
end
##
# Skips the next method in +container+
def skip_method container
meth = RDoc::AnyMethod.new "", "anon"
parse_method_parameters meth
parse_statements container, false, meth
end
##
# Skip spaces until a comment is found
def skip_tkspace_comment(skip_nl = true)
loop do
skip_nl ? skip_tkspace : skip_tkspace_without_nl
next_tk = peek_tk
return if next_tk.nil? || (:on_comment != next_tk[:kind] and :on_embdoc != next_tk[:kind])
get_tk
end
end
##
# Updates visibility in +container+ from +vis_type+ and +vis+.
def update_visibility container, vis_type, vis, singleton # :nodoc:
new_methods = []
case vis_type
when 'module_function' then
args = parse_symbol_arg
container.set_visibility_for args, :private, false
container.methods_matching args do |m|
s_m = m.dup
record_location s_m
s_m.singleton = true
new_methods << s_m
end
when 'public_class_method', 'private_class_method' then
args = parse_symbol_arg
container.methods_matching args, true do |m|
if m.parent != container then
m = m.dup
record_location m
new_methods << m
end
m.visibility = vis
end
else
args = parse_symbol_arg
container.set_visibility_for args, vis, singleton
end
new_methods.each do |method|
case method
when RDoc::AnyMethod then
container.add_method method
when RDoc::Attr then
container.add_attribute method
end
method.visibility = vis
end
end
##
# Prints +message+ to +$stderr+ unless we're being quiet
def warn message
@options.warn make_message message
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/parser/simple.rb 0000644 00000002653 15173517750 0016122 0 ustar 00 # frozen_string_literal: true
##
# Parse a non-source file. We basically take the whole thing as one big
# comment.
class RDoc::Parser::Simple < RDoc::Parser
include RDoc::Parser::Text
parse_files_matching(//)
attr_reader :content # :nodoc:
##
# Prepare to parse a plain file
def initialize(top_level, file_name, content, options, stats)
super
preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
@content = preprocess.handle @content, @top_level
end
##
# Extract the file contents and attach them to the TopLevel as a comment
def scan
comment = remove_coding_comment @content
comment = remove_private_comment comment
comment = RDoc::Comment.new comment, @top_level
@top_level.comment = comment
@top_level
end
##
# Removes the encoding magic comment from +text+
def remove_coding_comment text
text.sub(/\A# .*coding[=:].*$/, '')
end
##
# Removes private comments.
#
# Unlike RDoc::Comment#remove_private this implementation only looks for two
# dashes at the beginning of the line. Three or more dashes are considered
# to be a rule and ignored.
def remove_private_comment comment
# Workaround for gsub encoding for Ruby 1.9.2 and earlier
empty = ''
empty = RDoc::Encoding.change_encoding empty, comment.encoding
comment = comment.gsub(%r%^--\n.*?^\+\+\n?%m, empty)
comment.sub(%r%^--\n.*%m, empty)
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/context/section.rb 0000644 00000011300 15173517750 0016452 0 ustar 00 # frozen_string_literal: true
require 'cgi/util'
##
# A section of documentation like:
#
# # :section: The title
# # The body
#
# Sections can be referenced multiple times and will be collapsed into a
# single section.
class RDoc::Context::Section
include RDoc::Text
MARSHAL_VERSION = 0 # :nodoc:
##
# Section comment
attr_reader :comment
##
# Section comments
attr_reader :comments
##
# Context this Section lives in
attr_reader :parent
##
# Section title
attr_reader :title
##
# Creates a new section with +title+ and +comment+
def initialize parent, title, comment
@parent = parent
@title = title ? title.strip : title
@comments = []
add_comment comment
end
##
# Sections are equal when they have the same #title
def == other
self.class === other and @title == other.title
end
alias eql? ==
##
# Adds +comment+ to this section
def add_comment comment
comment = extract_comment comment
return if comment.empty?
case comment
when RDoc::Comment then
@comments << comment
when RDoc::Markup::Document then
@comments.concat comment.parts
when Array then
@comments.concat comment
else
raise TypeError, "unknown comment type: #{comment.inspect}"
end
end
##
# Anchor reference for linking to this section
def aref
title = @title || '[untitled]'
CGI.escape(title).gsub('%', '-').sub(/^-/, '')
end
##
# Extracts the comment for this section from the original comment block.
# If the first line contains :section:, strip it and use the rest.
# Otherwise remove lines up to the line containing :section:, and look
# for those lines again at the end and remove them. This lets us write
#
# # :section: The title
# # The body
def extract_comment comment
case comment
when Array then
comment.map do |c|
extract_comment c
end
when nil
RDoc::Comment.new ''
when RDoc::Comment then
if comment.text =~ /^#[ \t]*:section:.*\n/ then
start = $`
rest = $'
comment.text = if start.empty? then
rest
else
rest.sub(/#{start.chomp}\Z/, '')
end
end
comment
when RDoc::Markup::Document then
comment
else
raise TypeError, "unknown comment #{comment.inspect}"
end
end
def inspect # :nodoc:
"#<%s:0x%x %p>" % [self.class, object_id, title]
end
def hash # :nodoc:
@title.hash
end
##
# The files comments in this section come from
def in_files
return [] if @comments.empty?
case @comments
when Array then
@comments.map do |comment|
comment.file
end
when RDoc::Markup::Document then
@comment.parts.map do |document|
document.file
end
else
raise RDoc::Error, "BUG: unknown comment class #{@comments.class}"
end
end
##
# Serializes this Section. The title and parsed comment are saved, but not
# the section parent which must be restored manually.
def marshal_dump
[
MARSHAL_VERSION,
@title,
parse,
]
end
##
# De-serializes this Section. The section parent must be restored manually.
def marshal_load array
@parent = nil
@title = array[1]
@comments = array[2]
end
##
# Parses +comment_location+ into an RDoc::Markup::Document composed of
# multiple RDoc::Markup::Documents with their file set.
def parse
case @comments
when String then
super
when Array then
docs = @comments.map do |comment, location|
doc = super comment
doc.file = location if location
doc
end
RDoc::Markup::Document.new(*docs)
when RDoc::Comment then
doc = super @comments.text, comments.format
doc.file = @comments.location
doc
when RDoc::Markup::Document then
return @comments
else
raise ArgumentError, "unknown comment class #{comments.class}"
end
end
##
# The section's title, or 'Top Section' if the title is nil.
#
# This is used by the table of contents template so the name is silly.
def plain_html
@title || 'Top Section'
end
##
# Removes a comment from this section if it is from the same file as
# +comment+
def remove_comment comment
return if @comments.empty?
case @comments
when Array then
@comments.delete_if do |my_comment|
my_comment.file == comment.file
end
when RDoc::Markup::Document then
@comments.parts.delete_if do |document|
document.file == comment.file.name
end
else
raise RDoc::Error, "BUG: unknown comment class #{@comments.class}"
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/include.rb 0000644 00000000253 15173517750 0014752 0 ustar 00 # frozen_string_literal: true
##
# A Module included in a class with \#include
#
# RDoc::Include.new 'Enumerable', 'comment ...'
class RDoc::Include < RDoc::Mixin
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/normal_class.rb 0000644 00000004205 15173517750 0016005 0 ustar 00 # frozen_string_literal: true
##
# A normal class, neither singleton nor anonymous
class RDoc::NormalClass < RDoc::ClassModule
##
# The ancestors of this class including modules. Unlike Module#ancestors,
# this class is not included in the result. The result will contain both
# RDoc::ClassModules and Strings.
def ancestors
if String === superclass then
super << superclass
elsif superclass then
ancestors = super
ancestors << superclass
ancestors.concat superclass.ancestors
else
super
end
end
def aref_prefix # :nodoc:
'class'
end
##
# The definition of this class, <tt>class MyClassName</tt>
def definition
"class #{full_name}"
end
def direct_ancestors
superclass ? super + [superclass] : super
end
def inspect # :nodoc:
superclass = @superclass ? " < #{@superclass}" : nil
"<%s:0x%x class %s%s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [
self.class, object_id,
full_name, superclass, @includes, @extends, @attributes, @method_list, @aliases
]
end
def to_s # :nodoc:
display = "#{self.class.name} #{self.full_name}"
if superclass
display += ' < ' + (superclass.is_a?(String) ? superclass : superclass.full_name)
end
display += ' -> ' + is_alias_for.to_s if is_alias_for
display
end
def pretty_print q # :nodoc:
superclass = @superclass ? " < #{@superclass}" : nil
q.group 2, "[class #{full_name}#{superclass}", "]" do
q.breakable
q.text "includes:"
q.breakable
q.seplist @includes do |inc| q.pp inc end
q.breakable
q.text "constants:"
q.breakable
q.seplist @constants do |const| q.pp const end
q.breakable
q.text "attributes:"
q.breakable
q.seplist @attributes do |attr| q.pp attr end
q.breakable
q.text "methods:"
q.breakable
q.seplist @method_list do |meth| q.pp meth end
q.breakable
q.text "aliases:"
q.breakable
q.seplist @aliases do |aliaz| q.pp aliaz end
q.breakable
q.text "comment:"
q.breakable
q.pp comment
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/rubygems_hook.rb 0000644 00000012325 15173517750 0016207 0 ustar 00 # frozen_string_literal: true
require 'rubygems/user_interaction'
require 'fileutils'
require_relative '../rdoc'
##
# Gem::RDoc provides methods to generate RDoc and ri data for installed gems
# upon gem installation.
#
# This file is automatically required by RubyGems 1.9 and newer.
class RDoc::RubygemsHook
include Gem::UserInteraction
extend Gem::UserInteraction
@rdoc_version = nil
@specs = []
##
# Force installation of documentation?
attr_accessor :force
##
# Generate rdoc?
attr_accessor :generate_rdoc
##
# Generate ri data?
attr_accessor :generate_ri
class << self
##
# Loaded version of RDoc. Set by ::load_rdoc
attr_reader :rdoc_version
end
##
# Post installs hook that generates documentation for each specification in
# +specs+
def self.generation_hook installer, specs
start = Time.now
types = installer.document
generate_rdoc = types.include? 'rdoc'
generate_ri = types.include? 'ri'
specs.each do |spec|
new(spec, generate_rdoc, generate_ri).generate
end
return unless generate_rdoc or generate_ri
duration = (Time.now - start).to_i
names = specs.map(&:name).join ', '
say "Done installing documentation for #{names} after #{duration} seconds"
end
##
# Loads the RDoc generator
def self.load_rdoc
return if @rdoc_version
require_relative 'rdoc'
@rdoc_version = Gem::Version.new ::RDoc::VERSION
end
##
# Creates a new documentation generator for +spec+. RDoc and ri data
# generation can be enabled or disabled through +generate_rdoc+ and
# +generate_ri+ respectively.
#
# Only +generate_ri+ is enabled by default.
def initialize spec, generate_rdoc = false, generate_ri = true
@doc_dir = spec.doc_dir
@force = false
@rdoc = nil
@spec = spec
@generate_rdoc = generate_rdoc
@generate_ri = generate_ri
@rdoc_dir = spec.doc_dir 'rdoc'
@ri_dir = spec.doc_dir 'ri'
end
##
# Removes legacy rdoc arguments from +args+
#--
# TODO move to RDoc::Options
def delete_legacy_args args
args.delete '--inline-source'
args.delete '--promiscuous'
args.delete '-p'
args.delete '--one-file'
end
##
# Generates documentation using the named +generator+ ("darkfish" or "ri")
# and following the given +options+.
#
# Documentation will be generated into +destination+
def document generator, options, destination
generator_name = generator
options = options.dup
options.exclude ||= [] # TODO maybe move to RDoc::Options#finish
options.setup_generator generator
options.op_dir = destination
Dir.chdir @spec.full_gem_path do
options.finish
end
generator = options.generator.new @rdoc.store, options
@rdoc.options = options
@rdoc.generator = generator
say "Installing #{generator_name} documentation for #{@spec.full_name}"
FileUtils.mkdir_p options.op_dir
Dir.chdir options.op_dir do
begin
@rdoc.class.current = @rdoc
@rdoc.generator.generate
ensure
@rdoc.class.current = nil
end
end
end
##
# Generates RDoc and ri data
def generate
return if @spec.default_gem?
return unless @generate_ri or @generate_rdoc
setup
options = nil
args = @spec.rdoc_options
args.concat @spec.source_paths
args.concat @spec.extra_rdoc_files
case config_args = Gem.configuration[:rdoc]
when String then
args = args.concat config_args.split(' ')
when Array then
args = args.concat config_args
end
delete_legacy_args args
Dir.chdir @spec.full_gem_path do
options = ::RDoc::Options.new
options.default_title = "#{@spec.full_name} Documentation"
options.parse args
end
options.quiet = !Gem.configuration.really_verbose
@rdoc = new_rdoc
@rdoc.options = options
store = RDoc::Store.new
store.encoding = options.encoding
store.dry_run = options.dry_run
store.main = options.main_page
store.title = options.title
@rdoc.store = store
say "Parsing documentation for #{@spec.full_name}"
Dir.chdir @spec.full_gem_path do
@rdoc.parse_files options.files
end
document 'ri', options, @ri_dir if
@generate_ri and (@force or not File.exist? @ri_dir)
document 'darkfish', options, @rdoc_dir if
@generate_rdoc and (@force or not File.exist? @rdoc_dir)
end
##
# #new_rdoc creates a new RDoc instance. This method is provided only to
# make testing easier.
def new_rdoc # :nodoc:
::RDoc::RDoc.new
end
##
# Is rdoc documentation installed?
def rdoc_installed?
File.exist? @rdoc_dir
end
##
# Removes generated RDoc and ri data
def remove
base_dir = @spec.base_dir
raise Gem::FilePermissionError, base_dir unless File.writable? base_dir
FileUtils.rm_rf @rdoc_dir
FileUtils.rm_rf @ri_dir
end
##
# Is ri data installed?
def ri_installed?
File.exist? @ri_dir
end
##
# Prepares the spec for documentation generation
def setup
self.class.load_rdoc
raise Gem::FilePermissionError, @doc_dir if
File.exist?(@doc_dir) and not File.writable?(@doc_dir)
FileUtils.mkdir_p @doc_dir unless File.exist? @doc_dir
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/cross_reference.rb 0000644 00000016172 15173517750 0016505 0 ustar 00 # frozen_string_literal: true
require_relative 'markup/attribute_manager' # for PROTECT_ATTR
##
# RDoc::CrossReference is a reusable way to create cross references for names.
class RDoc::CrossReference
##
# Regular expression to match class references
#
# 1. There can be a '\\' in front of text to suppress the cross-reference
# 2. There can be a '::' in front of class names to reference from the
# top-level namespace.
# 3. The method can be followed by parenthesis (not recommended)
CLASS_REGEXP_STR = '\\\\?((?:\:{2})?[A-Z]\w*(?:\:\:\w+)*)'
##
# Regular expression to match a single method argument.
METHOD_ARG_REGEXP_STR = '[\w.+*/=<>-]+'
##
# Regular expression to match method arguments.
METHOD_ARGS_REGEXP_STR = /(?:\((?:#{METHOD_ARG_REGEXP_STR}(?:,\s*#{METHOD_ARG_REGEXP_STR})*)?\))?/.source
##
# Regular expression to match method references.
#
# See CLASS_REGEXP_STR
METHOD_REGEXP_STR = /(
(?!\d)[\w#{RDoc::Markup::AttributeManager::PROTECT_ATTR}]+[!?=]?|
%|=(?:==?|~)|![=~]|\[\]=?|<(?:<|=>?)?|>[>=]?|[-+!]@?|\*\*?|[\/%\`|&^~]
)#{METHOD_ARGS_REGEXP_STR}/.source.delete("\n ").freeze
##
# Regular expressions matching text that should potentially have
# cross-reference links generated are passed to add_regexp_handling. Note
# that these expressions are meant to pick up text for which cross-references
# have been suppressed, since the suppression characters are removed by the
# code that is triggered.
CROSSREF_REGEXP = /(?:^|[\s()])
(
(?:
# A::B::C.meth
#{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR}
# A::B::C
# The stuff after CLASS_REGEXP_STR is a
# nasty hack. CLASS_REGEXP_STR unfortunately matches
# words like dog and cat (these are legal "class"
# names in Fortran 95). When a word is flagged as a
# potential cross-reference, limitations in the markup
# engine suppress other processing, such as typesetting.
# This is particularly noticeable for contractions.
# In order that words like "can't" not
# be flagged as potential cross-references, only
# flag potential class cross-references if the character
# after the cross-reference is a space, sentence
# punctuation, tag start character, or attribute
# marker.
| #{CLASS_REGEXP_STR}(?=[@\s).?!,;<\000]|\z)
# Stand-alone method (preceded by a #)
| \\?\##{METHOD_REGEXP_STR}
# Stand-alone method (preceded by ::)
| ::#{METHOD_REGEXP_STR}
# Things that look like filenames
# The key thing is that there must be at least
# one special character (period, slash, or
# underscore).
| (?:\.\.\/)*[-\/\w]+[_\/.][-\w\/.]+
# Things that have markup suppressed
# Don't process things like '\<' in \<tt>, though.
# TODO: including < is a hack, not very satisfying.
| \\[^\s<]
)
# labels for headings
(?:@[\w+%-]+(?:\.[\w|%-]+)?)?
)/x
##
# Version of CROSSREF_REGEXP used when <tt>--hyperlink-all</tt> is specified.
ALL_CROSSREF_REGEXP = /
(?:^|[\s()])
(
(?:
# A::B::C.meth
#{CLASS_REGEXP_STR}(?:[.#]|::)#{METHOD_REGEXP_STR}
# A::B::C
| #{CLASS_REGEXP_STR}(?=[@\s).?!,;<\000]|\z)
# Stand-alone method
| \\?#{METHOD_REGEXP_STR}
# Things that look like filenames
| (?:\.\.\/)*[-\/\w]+[_\/.][-\w\/.]+
# Things that have markup suppressed
| \\[^\s<]
)
# labels for headings
(?:@[\w+%-]+)?
)/x
##
# Hash of references that have been looked-up to their replacements
attr_accessor :seen
##
# Allows cross-references to be created based on the given +context+
# (RDoc::Context).
def initialize context
@context = context
@store = context.store
@seen = {}
end
##
# Returns a method reference to +name+.
def resolve_method name
ref = nil
if /#{CLASS_REGEXP_STR}([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
type = $2
if '.' == type # will find either #method or ::method
method = $3
else
method = "#{type}#{$3}"
end
container = @context.find_symbol_module($1)
elsif /^([.#]|::)#{METHOD_REGEXP_STR}/o =~ name then
type = $1
if '.' == type
method = $2
else
method = "#{type}#{$2}"
end
container = @context
else
type = nil
container = nil
end
if container then
unless RDoc::TopLevel === container then
if '.' == type then
if 'new' == method then # AnyClassName.new will be class method
ref = container.find_local_symbol method
ref = container.find_ancestor_local_symbol method unless ref
else
ref = container.find_local_symbol "::#{method}"
ref = container.find_ancestor_local_symbol "::#{method}" unless ref
ref = container.find_local_symbol "##{method}" unless ref
ref = container.find_ancestor_local_symbol "##{method}" unless ref
end
else
ref = container.find_local_symbol method
ref = container.find_ancestor_local_symbol method unless ref
end
end
end
ref
end
##
# Returns a reference to +name+.
#
# If the reference is found and +name+ is not documented +text+ will be
# returned. If +name+ is escaped +name+ is returned. If +name+ is not
# found +text+ is returned.
def resolve name, text
return @seen[name] if @seen.include? name
ref = case name
when /^\\(#{CLASS_REGEXP_STR})$/o then
@context.find_symbol $1
else
@context.find_symbol name
end
ref = resolve_method name unless ref
# Try a page name
ref = @store.page name if not ref and name =~ /^[\w.]+$/
ref = nil if RDoc::Alias === ref # external alias, can't link to it
out = if name == '\\' then
name
elsif name =~ /^\\/ then
# we remove the \ only in front of what we know:
# other backslashes are treated later, only outside of <tt>
ref ? $' : name
elsif ref then
if ref.display? then
ref
else
text
end
else
text
end
@seen[name] = out
out
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/pot/message_extractor.rb 0000644 00000003037 15173517750 0021641 0 ustar 00 # frozen_string_literal: true
##
# Extracts message from RDoc::Store
class RDoc::Generator::POT::MessageExtractor
##
# Creates a message extractor for +store+.
def initialize store
@store = store
@po = RDoc::Generator::POT::PO.new
end
##
# Extracts messages from +store+, stores them into
# RDoc::Generator::POT::PO and returns it.
def extract
@store.all_classes_and_modules.each do |klass|
extract_from_klass(klass)
end
@po
end
private
def extract_from_klass klass
extract_text(klass.comment_location, klass.full_name)
klass.each_section do |section, constants, attributes|
extract_text(section.title ,"#{klass.full_name}: section title")
section.comments.each do |comment|
extract_text(comment, "#{klass.full_name}: #{section.title}")
end
end
klass.each_constant do |constant|
extract_text(constant.comment, constant.full_name)
end
klass.each_attribute do |attribute|
extract_text(attribute.comment, attribute.full_name)
end
klass.each_method do |method|
extract_text(method.comment, method.full_name)
end
end
def extract_text text, comment, location = nil
return if text.nil?
options = {
:extracted_comment => comment,
:references => [location].compact,
}
i18n_text = RDoc::I18n::Text.new(text)
i18n_text.extract_messages do |part|
@po.add(entry(part[:paragraph], options))
end
end
def entry msgid, options
RDoc::Generator::POT::POEntry.new(msgid, options)
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/pot/po_entry.rb 0000644 00000006371 15173517750 0017765 0 ustar 00 # frozen_string_literal: true
##
# A PO entry in PO
class RDoc::Generator::POT::POEntry
# The msgid content
attr_reader :msgid
# The msgstr content
attr_reader :msgstr
# The comment content created by translator (PO editor)
attr_reader :translator_comment
# The comment content extracted from source file
attr_reader :extracted_comment
# The locations where the PO entry is extracted
attr_reader :references
# The flags of the PO entry
attr_reader :flags
##
# Creates a PO entry for +msgid+. Other valus can be specified by
# +options+.
def initialize msgid, options = {}
@msgid = msgid
@msgstr = options[:msgstr] || ""
@translator_comment = options[:translator_comment]
@extracted_comment = options[:extracted_comment]
@references = options[:references] || []
@flags = options[:flags] || []
end
##
# Returns the PO entry in PO format.
def to_s
entry = ''
entry += format_translator_comment
entry += format_extracted_comment
entry += format_references
entry += format_flags
entry += <<-ENTRY
msgid #{format_message(@msgid)}
msgstr #{format_message(@msgstr)}
ENTRY
end
##
# Merges the PO entry with +other_entry+.
def merge other_entry
options = {
:extracted_comment => merge_string(@extracted_comment,
other_entry.extracted_comment),
:translator_comment => merge_string(@translator_comment,
other_entry.translator_comment),
:references => merge_array(@references,
other_entry.references),
:flags => merge_array(@flags,
other_entry.flags),
}
self.class.new(@msgid, options)
end
private
def format_comment mark, comment
return '' unless comment
return '' if comment.empty?
formatted_comment = ''
comment.each_line do |line|
formatted_comment += "#{mark} #{line}"
end
formatted_comment += "\n" unless formatted_comment.end_with?("\n")
formatted_comment
end
def format_translator_comment
format_comment('#', @translator_comment)
end
def format_extracted_comment
format_comment('#.', @extracted_comment)
end
def format_references
return '' if @references.empty?
formatted_references = ''
@references.sort.each do |file, line|
formatted_references += "\#: #{file}:#{line}\n"
end
formatted_references
end
def format_flags
return '' if @flags.empty?
formatted_flags = flags.join(",")
"\#, #{formatted_flags}\n"
end
def format_message message
return "\"#{escape(message)}\"" unless message.include?("\n")
formatted_message = '""'
message.each_line do |line|
formatted_message += "\n"
formatted_message += "\"#{escape(line)}\""
end
formatted_message
end
def escape string
string.gsub(/["\\\t\n]/) do |special_character|
case special_character
when "\t"
"\\t"
when "\n"
"\\n"
else
"\\#{special_character}"
end
end
end
def merge_string string1, string2
[string1, string2].compact.join("\n")
end
def merge_array array1, array2
(array1 + array2).uniq
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/pot/po.rb 0000644 00000003233 15173517750 0016536 0 ustar 00 # frozen_string_literal: true
##
# Generates a PO format text
class RDoc::Generator::POT::PO
##
# Creates an object that represents PO format.
def initialize
@entries = {}
add_header
end
##
# Adds a PO entry to the PO.
def add entry
existing_entry = @entries[entry.msgid]
if existing_entry
entry = existing_entry.merge(entry)
end
@entries[entry.msgid] = entry
end
##
# Returns PO format text for the PO.
def to_s
po = ''
sort_entries.each do |entry|
po += "\n" unless po.empty?
po += entry.to_s
end
po
end
private
def add_header
add(header_entry)
end
def header_entry
comment = <<-COMMENT
SOME DESCRIPTIVE TITLE.
Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
This file is distributed under the same license as the PACKAGE package.
FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
COMMENT
content = <<-CONTENT
Project-Id-Version: PACKAGE VERSEION
Report-Msgid-Bugs-To:
PO-Revision-Date: YEAR-MO_DA HO:MI+ZONE
Last-Translator: FULL NAME <EMAIL@ADDRESS>
Language-Team: LANGUAGE <LL@li.org>
Language:
MIME-Version: 1.0
Content-Type: text/plain; charset=CHARSET
Content-Transfer-Encoding: 8bit
Plural-Forms: nplurals=INTEGER; plural=EXPRESSION;
CONTENT
options = {
:msgstr => content,
:translator_comment => comment,
:flags => ['fuzzy'],
}
RDoc::Generator::POT::POEntry.new('', options)
end
def sort_entries
headers, messages = @entries.values.partition do |entry|
entry.msgid.empty?
end
# TODO: sort by location
sorted_messages = messages.sort_by do |entry|
entry.msgid
end
headers + sorted_messages
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/json_index.rb 0000644 00000017202 15173517750 0017457 0 ustar 00 # frozen_string_literal: true
require 'json'
begin
require 'zlib'
rescue LoadError
end
##
# The JsonIndex generator is designed to complement an HTML generator and
# produces a JSON search index. This generator is derived from sdoc by
# Vladimir Kolesnikov and contains verbatim code written by him.
#
# This generator is designed to be used with a regular HTML generator:
#
# class RDoc::Generator::Darkfish
# def initialize options
# # ...
# @base_dir = Pathname.pwd.expand_path
#
# @json_index = RDoc::Generator::JsonIndex.new self, options
# end
#
# def generate
# # ...
# @json_index.generate
# end
# end
#
# == Index Format
#
# The index is output as a JSON file assigned to the global variable
# +search_data+. The structure is:
#
# var search_data = {
# "index": {
# "searchIndex":
# ["a", "b", ...],
# "longSearchIndex":
# ["a", "a::b", ...],
# "info": [
# ["A", "A", "A.html", "", ""],
# ["B", "A::B", "A::B.html", "", ""],
# ...
# ]
# }
# }
#
# The same item is described across the +searchIndex+, +longSearchIndex+ and
# +info+ fields. The +searchIndex+ field contains the item's short name, the
# +longSearchIndex+ field contains the full_name (when appropriate) and the
# +info+ field contains the item's name, full_name, path, parameters and a
# snippet of the item's comment.
#
# == LICENSE
#
# Copyright (c) 2009 Vladimir Kolesnikov
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
class RDoc::Generator::JsonIndex
include RDoc::Text
##
# Where the search index lives in the generated output
SEARCH_INDEX_FILE = File.join 'js', 'search_index.js'
attr_reader :index # :nodoc:
##
# Creates a new generator. +parent_generator+ is used to determine the
# class_dir and file_dir of links in the output index.
#
# +options+ are the same options passed to the parent generator.
def initialize parent_generator, options
@parent_generator = parent_generator
@store = parent_generator.store
@options = options
@template_dir = File.expand_path '../template/json_index', __FILE__
@base_dir = @parent_generator.base_dir
@classes = nil
@files = nil
@index = nil
end
##
# Builds the JSON index as a Hash.
def build_index
reset @store.all_files.sort, @store.all_classes_and_modules.sort
index_classes
index_methods
index_pages
{ :index => @index }
end
##
# Output progress information if debugging is enabled
def debug_msg *msg
return unless $DEBUG_RDOC
$stderr.puts(*msg)
end
##
# Writes the JSON index to disk
def generate
debug_msg "Generating JSON index"
debug_msg " writing search index to %s" % SEARCH_INDEX_FILE
data = build_index
return if @options.dry_run
out_dir = @base_dir + @options.op_dir
index_file = out_dir + SEARCH_INDEX_FILE
FileUtils.mkdir_p index_file.dirname, :verbose => $DEBUG_RDOC
index_file.open 'w', 0644 do |io|
io.set_encoding Encoding::UTF_8
io.write 'var search_data = '
JSON.dump data, io, 0
end
unless ENV['SOURCE_DATE_EPOCH'].nil?
index_file.utime index_file.atime, Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime
end
Dir.chdir @template_dir do
Dir['**/*.js'].each do |source|
dest = File.join out_dir, source
FileUtils.install source, dest, :mode => 0644, :preserve => true, :verbose => $DEBUG_RDOC
end
end
end
##
# Compress the search_index.js file using gzip
def generate_gzipped
return if @options.dry_run or not defined?(Zlib)
debug_msg "Compressing generated JSON index"
out_dir = @base_dir + @options.op_dir
search_index_file = out_dir + SEARCH_INDEX_FILE
outfile = out_dir + "#{search_index_file}.gz"
debug_msg "Reading the JSON index file from %s" % search_index_file
search_index = search_index_file.read(mode: 'r:utf-8')
debug_msg "Writing gzipped search index to %s" % outfile
Zlib::GzipWriter.open(outfile) do |gz|
gz.mtime = File.mtime(search_index_file)
gz.orig_name = search_index_file.basename.to_s
gz.write search_index
gz.close
end
# GZip the rest of the js files
Dir.chdir @template_dir do
Dir['**/*.js'].each do |source|
dest = out_dir + source
outfile = out_dir + "#{dest}.gz"
debug_msg "Reading the original js file from %s" % dest
data = dest.read
debug_msg "Writing gzipped file to %s" % outfile
Zlib::GzipWriter.open(outfile) do |gz|
gz.mtime = File.mtime(dest)
gz.orig_name = dest.basename.to_s
gz.write data
gz.close
end
end
end
end
##
# Adds classes and modules to the index
def index_classes
debug_msg " generating class search index"
documented = @classes.uniq.select do |klass|
klass.document_self_or_methods
end
documented.each do |klass|
debug_msg " #{klass.full_name}"
record = klass.search_record
@index[:searchIndex] << search_string(record.shift)
@index[:longSearchIndex] << search_string(record.shift)
@index[:info] << record
end
end
##
# Adds methods to the index
def index_methods
debug_msg " generating method search index"
list = @classes.uniq.flat_map do |klass|
klass.method_list
end.sort_by do |method|
[method.name, method.parent.full_name]
end
list.each do |method|
debug_msg " #{method.full_name}"
record = method.search_record
@index[:searchIndex] << "#{search_string record.shift}()"
@index[:longSearchIndex] << "#{search_string record.shift}()"
@index[:info] << record
end
end
##
# Adds pages to the index
def index_pages
debug_msg " generating pages search index"
pages = @files.select do |file|
file.text?
end
pages.each do |page|
debug_msg " #{page.page_name}"
record = page.search_record
@index[:searchIndex] << search_string(record.shift)
@index[:longSearchIndex] << ''
record.shift
@index[:info] << record
end
end
##
# The directory classes are written to
def class_dir
@parent_generator.class_dir
end
##
# The directory files are written to
def file_dir
@parent_generator.file_dir
end
def reset files, classes # :nodoc:
@files = files
@classes = classes
@index = {
:searchIndex => [],
:longSearchIndex => [],
:info => []
}
end
##
# Removes whitespace and downcases +string+
def search_string string
string.downcase.gsub(/\s/, '')
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/pot.rb 0000644 00000004413 15173517750 0016121 0 ustar 00 # frozen_string_literal: true
##
# Generates a POT file.
#
# Here is a translator work flow with the generator.
#
# == Create .pot
#
# You create .pot file by pot formatter:
#
# % rdoc --format pot
#
# It generates doc/rdoc.pot.
#
# == Create .po
#
# You create .po file from doc/rdoc.pot. This operation is needed only
# the first time. This work flow assumes that you are a translator
# for Japanese.
#
# You create locale/ja/rdoc.po from doc/rdoc.pot. You can use msginit
# provided by GNU gettext or rmsginit provided by gettext gem. This
# work flow uses gettext gem because it is more portable than GNU
# gettext for Rubyists. Gettext gem is implemented by pure Ruby.
#
# % gem install gettext
# % mkdir -p locale/ja
# % rmsginit --input doc/rdoc.pot --output locale/ja/rdoc.po --locale ja
#
# Translate messages in .po
#
# You translate messages in .po by a PO file editor. po-mode.el exists
# for Emacs users. There are some GUI tools such as GTranslator.
# There are some Web services such as POEditor and Tansifex. You can
# edit by your favorite text editor because .po is a text file.
# Generate localized documentation
#
# You can generate localized documentation with locale/ja/rdoc.po:
#
# % rdoc --locale ja
#
# You can find documentation in Japanese in doc/. Yay!
#
# == Update translation
#
# You need to update translation when your application is added or
# modified messages.
#
# You can update .po by the following command lines:
#
# % rdoc --format pot
# % rmsgmerge --update locale/ja/rdoc.po doc/rdoc.pot
#
# You edit locale/ja/rdoc.po to translate new messages.
class RDoc::Generator::POT
RDoc::RDoc.add_generator self
##
# Description of this generator
DESCRIPTION = 'creates .pot file'
##
# Set up a new .pot generator
def initialize store, options #:not-new:
@options = options
@store = store
end
##
# Writes .pot to disk.
def generate
po = extract_messages
pot_path = 'rdoc.pot'
File.open(pot_path, "w") do |pot|
pot.print(po.to_s)
end
end
# :nodoc:
def class_dir
nil
end
private
def extract_messages
extractor = MessageExtractor.new(@store)
extractor.extract
end
require_relative 'pot/message_extractor'
require_relative 'pot/po'
require_relative 'pot/po_entry'
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/json_index/js/searcher.js 0000644 00000014704 15173517750 0023517 0 ustar 00 Searcher = function(data) {
this.data = data;
this.handlers = [];
}
Searcher.prototype = new function() {
// search is performed in chunks of 1000 for non-blocking user input
var CHUNK_SIZE = 1000;
// do not try to find more than 100 results
var MAX_RESULTS = 100;
var huid = 1;
var suid = 1;
var runs = 0;
this.find = function(query) {
var queries = splitQuery(query);
var regexps = buildRegexps(queries);
var highlighters = buildHilighters(queries);
var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++};
var _this = this;
this.currentSuid = state.n;
if (!query) return;
var run = function() {
// stop current search thread if new search started
if (state.n != _this.currentSuid) return;
var results =
performSearch(_this.data, regexps, queries, highlighters, state);
var hasMore = (state.limit > 0 && state.pass < 4);
triggerResults.call(_this, results, !hasMore);
if (hasMore) {
setTimeout(run, 2);
}
runs++;
};
runs = 0;
// start search thread
run();
}
/* ----- Events ------ */
this.ready = function(fn) {
fn.huid = huid;
this.handlers.push(fn);
}
/* ----- Utilities ------ */
function splitQuery(query) {
return query.split(/(\s+|::?|\(\)?)/).filter(function(string) {
return string.match(/\S/);
});
}
function buildRegexps(queries) {
return queries.map(function(query) {
return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i');
});
}
function buildHilighters(queries) {
return queries.map(function(query) {
return query.split('').map(function(l, i) {
return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2);
}).join('');
});
}
// function longMatchRegexp(index, longIndex, regexps) {
// for (var i = regexps.length - 1; i >= 0; i--){
// if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false;
// };
// return true;
// }
/* ----- Mathchers ------ */
/*
* This record matches if the index starts with queries[0] and the record
* matches all of the regexps
*/
function matchPassBeginning(index, longIndex, queries, regexps) {
if (index.indexOf(queries[0]) != 0) return false;
for (var i=1, l = regexps.length; i < l; i++) {
if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
return false;
};
return true;
}
/*
* This record matches if the longIndex starts with queries[0] and the
* longIndex matches all of the regexps
*/
function matchPassLongIndex(index, longIndex, queries, regexps) {
if (longIndex.indexOf(queries[0]) != 0) return false;
for (var i=1, l = regexps.length; i < l; i++) {
if (!longIndex.match(regexps[i]))
return false;
};
return true;
}
/*
* This record matches if the index contains queries[0] and the record
* matches all of the regexps
*/
function matchPassContains(index, longIndex, queries, regexps) {
if (index.indexOf(queries[0]) == -1) return false;
for (var i=1, l = regexps.length; i < l; i++) {
if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
return false;
};
return true;
}
/*
* This record matches if regexps[0] matches the index and the record
* matches all of the regexps
*/
function matchPassRegexp(index, longIndex, queries, regexps) {
if (!index.match(regexps[0])) return false;
for (var i=1, l = regexps.length; i < l; i++) {
if (!index.match(regexps[i]) && !longIndex.match(regexps[i]))
return false;
};
return true;
}
/* ----- Highlighters ------ */
function highlightRegexp(info, queries, regexps, highlighters) {
var result = createResult(info);
for (var i=0, l = regexps.length; i < l; i++) {
result.title = result.title.replace(regexps[i], highlighters[i]);
result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
};
return result;
}
function hltSubstring(string, pos, length) {
return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length);
}
function highlightQuery(info, queries, regexps, highlighters) {
var result = createResult(info);
var pos = 0;
var lcTitle = result.title.toLowerCase();
pos = lcTitle.indexOf(queries[0]);
if (pos != -1) {
result.title = hltSubstring(result.title, pos, queries[0].length);
}
result.namespace = result.namespace.replace(regexps[0], highlighters[0]);
for (var i=1, l = regexps.length; i < l; i++) {
result.title = result.title.replace(regexps[i], highlighters[i]);
result.namespace = result.namespace.replace(regexps[i], highlighters[i]);
};
return result;
}
function createResult(info) {
var result = {};
result.title = info[0];
result.namespace = info[1];
result.path = info[2];
result.params = info[3];
result.snippet = info[4];
result.badge = info[6];
return result;
}
/* ----- Searching ------ */
function performSearch(data, regexps, queries, highlighters, state) {
var searchIndex = data.searchIndex;
var longSearchIndex = data.longSearchIndex;
var info = data.info;
var result = [];
var i = state.from;
var l = searchIndex.length;
var togo = CHUNK_SIZE;
var matchFunc, hltFunc;
while (state.pass < 4 && state.limit > 0 && togo > 0) {
if (state.pass == 0) {
matchFunc = matchPassBeginning;
hltFunc = highlightQuery;
} else if (state.pass == 1) {
matchFunc = matchPassLongIndex;
hltFunc = highlightQuery;
} else if (state.pass == 2) {
matchFunc = matchPassContains;
hltFunc = highlightQuery;
} else if (state.pass == 3) {
matchFunc = matchPassRegexp;
hltFunc = highlightRegexp;
}
for (; togo > 0 && i < l && state.limit > 0; i++, togo--) {
if (info[i].n == state.n) continue;
if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) {
info[i].n = state.n;
result.push(hltFunc(info[i], queries, regexps, highlighters));
state.limit--;
}
};
if (searchIndex.length <= i) {
state.pass++;
i = state.from = 0;
} else {
state.from = i;
}
}
return result;
}
function triggerResults(results, isLast) {
this.handlers.forEach(function(fn) {
fn.call(this, results, isLast)
});
}
}
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/json_index/js/navigation.js 0000644 00000005165 15173517750 0024063 0 ustar 00 /*
* Navigation allows movement using the arrow keys through the search results.
*
* When using this library you will need to set scrollIntoView to the
* appropriate function for your layout. Use scrollInWindow if the container
* is not scrollable and scrollInElement if the container is a separate
* scrolling region.
*/
Navigation = new function() {
this.initNavigation = function() {
var _this = this;
document.addEventListener('keydown', function(e) {
_this.onkeydown(e);
});
this.navigationActive = true;
}
this.setNavigationActive = function(state) {
this.navigationActive = state;
}
this.onkeydown = function(e) {
if (!this.navigationActive) return;
switch(e.key) {
case 'ArrowLeft':
if (this.moveLeft()) e.preventDefault();
break;
case 'ArrowUp':
if (e.key == 'ArrowUp' || e.ctrlKey) {
if (this.moveUp()) e.preventDefault();
}
break;
case 'ArrowRight':
if (this.moveRight()) e.preventDefault();
break;
case 'ArrowDown':
if (e.key == 'ArrowDown' || e.ctrlKey) {
if (this.moveDown()) e.preventDefault();
}
break;
case 'Enter':
if (this.current) e.preventDefault();
this.select(this.current);
break;
}
if (e.ctrlKey && e.shiftKey) this.select(this.current);
}
this.moveRight = function() {
}
this.moveLeft = function() {
}
this.move = function(isDown) {
}
this.moveUp = function() {
return this.move(false);
}
this.moveDown = function() {
return this.move(true);
}
/*
* Scrolls to the given element in the scrollable element view.
*/
this.scrollInElement = function(element, view) {
var offset, viewHeight, viewScroll, height;
offset = element.offsetTop;
height = element.offsetHeight;
viewHeight = view.offsetHeight;
viewScroll = view.scrollTop;
if (offset - viewScroll + height > viewHeight) {
view.scrollTop = offset - viewHeight + height;
}
if (offset < viewScroll) {
view.scrollTop = offset;
}
}
/*
* Scrolls to the given element in the window. The second argument is
* ignored
*/
this.scrollInWindow = function(element, ignored) {
var offset, viewHeight, viewScroll, height;
offset = element.offsetTop;
height = element.offsetHeight;
viewHeight = window.innerHeight;
viewScroll = window.scrollY;
if (offset - viewScroll + height > viewHeight) {
window.scrollTo(window.scrollX, offset - viewHeight + height);
}
if (offset < viewScroll) {
window.scrollTo(window.scrollX, offset);
}
}
}
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml 0000644 00000000572 15173517750 0024573 0 ustar 00 <%- if klass.type == 'class' then %>
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<%- if klass.superclass and not String === klass.superclass then -%>
<p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a>
<%- else -%>
<p class="link"><%= klass.superclass %>
<%- end -%>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/class.rhtml 0000644 00000013336 15173517750 0022561 0 ustar 00 <body id="top" role="document" class="<%= klass.type %>">
<nav role="navigation">
<div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %>
</div>
<%= render '_sidebar_table_of_contents.rhtml' %>
<div id="class-metadata">
<%= render '_sidebar_sections.rhtml' %>
<%= render '_sidebar_parent.rhtml' %>
<%= render '_sidebar_includes.rhtml' %>
<%= render '_sidebar_extends.rhtml' %>
<%= render '_sidebar_methods.rhtml' %>
</div>
</nav>
<main role="main" aria-labelledby="<%=h klass.aref %>">
<h1 id="<%=h klass.aref %>" class="<%= klass.type %>">
<%= klass.type %> <%= klass.full_name %>
</h1>
<section class="description">
<%= klass.description %>
</section>
<%- klass.each_section do |section, constants, attributes| -%>
<section id="<%= section.aref %>" class="documentation-section">
<%- if section.title then -%>
<header class="documentation-section-title">
<h2>
<%= section.title %>
</h2>
<span class="section-click-top">
<a href="#top">↑ top</a>
</span>
</header>
<%- end -%>
<%- if section.comment then -%>
<div>
<%= section.description %>
</div>
<%- end -%>
<%- unless constants.empty? then -%>
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<%- constants.each do |const| -%>
<dt id="<%= const.name %>"><%= const.name %>
<%- if const.comment then -%>
<dd><%= const.description.strip %>
<%- else -%>
<dd class="missing-docs">(Not documented)
<%- end -%>
<%- end -%>
</dl>
</section>
<%- end -%>
<%- unless attributes.empty? then -%>
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<%- attributes.each do |attrib| -%>
<div id="<%= attrib.aref %>" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name"><%= h attrib.name %></span><span
class="attribute-access-type">[<%= attrib.rw %>]</span>
</div>
<div class="method-description">
<%- if attrib.comment then -%>
<%= attrib.description.strip %>
<%- else -%>
<p class="missing-docs">(Not documented)
<%- end -%>
</div>
</div>
<%- end -%>
</section>
<%- end -%>
<%- klass.methods_by_type(section).each do |type, visibilities|
next if visibilities.empty?
visibilities.each do |visibility, methods|
next if methods.empty? %>
<section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section">
<header>
<h3><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
</header>
<%- methods.each do |method| -%>
<div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
<div class="method-header">
<%- if (call_seq = method.call_seq) then -%>
<%- call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
<div class="method-heading">
<span class="method-callseq">
<%= h(call_seq.strip.
gsub( /^\w+\./m, '')).
gsub(/(.*)[-=]>/, '\1→') %>
</span>
<%- if i == 0 and method.token_stream then -%>
<span class="method-click-advice">click to toggle source</span>
<%- end -%>
</div>
<%- end -%>
<%- elsif method.has_call_seq? then -%>
<div class="method-heading">
<span class="method-name"><%= h method.name %></span>
</div>
<%- else -%>
<div class="method-heading">
<span class="method-name"><%= h method.name %></span><span
class="method-args"><%= h method.param_seq %></span>
<%- if method.token_stream then -%>
<span class="method-click-advice">click to toggle source</span>
<%- end -%>
</div>
<%- end -%>
</div>
<%- unless method.skip_description? then -%>
<div class="method-description">
<%- if method.comment then -%>
<%= method.description.strip %>
<%- else -%>
<p class="missing-docs">(Not documented)
<%- end -%>
<%- if method.calls_super then -%>
<div class="method-calls-super">
Calls superclass method
<%=
method.superclass_method ?
method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
%>
</div>
<%- end -%>
<%- if method.token_stream then -%>
<div class="method-source-code" id="<%= method.html_name %>-source">
<pre><%= method.markup_code %></pre>
</div>
<%- end -%>
</div>
<%- end -%>
<%- unless method.aliases.empty? then -%>
<div class="aliases">
Also aliased as: <%= method.aliases.map do |aka|
if aka.parent then # HACK lib/rexml/encodings
%{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
else
h aka.name
end
end.join ", " %>
</div>
<%- end -%>
<%- if method.is_alias_for then -%>
<div class="aliases">
Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
</div>
<%- end -%>
</div>
<%- end -%>
</section>
<%- end
end %>
</section>
<%- end -%>
</main>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml 0000644 00000000516 15173517750 0025207 0 ustar 00 <body role="document">
<nav role="navigation">
<%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %>
<div id="project-metadata">
<%= render '_sidebar_pages.rhtml' %>
<%= render '_sidebar_classes.rhtml' %>
</div>
</nav>
<main role="main">
<h1>Not Found</h1>
<p><%= message %>
</main>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml 0000644 00000000671 15173517750 0024750 0 ustar 00 <%- if !svninfo.empty? then %>
<div id="file-svninfo-section" class="nav-section">
<h3>VCS Info</h3>
<div class="section-body">
<dl class="svninfo">
<dt>Rev
<dd><%= svninfo[:rev] %>
<dt>Last Checked In
<dd><%= svninfo[:commitdate].strftime('%Y-%m-%d %H:%M:%S') %>
(<%= svninfo[:commitdelta] %> ago)
<dt>Checked in by
<dd><%= svninfo[:committer] %>
</dl>
</div>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml 0000644 00000000703 15173517750 0025104 0 ustar 00 <%- unless klass.includes.empty? then %>
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<%- klass.each_include do |inc| -%>
<%- unless String === inc.module then -%>
<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a>
<%- else -%>
<li><span class="include"><%= inc.name %></span>
<%- end -%>
<%- end -%>
</ul>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/wrench_orange.png 0000644 00000001110 15173517750 0025163 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8˕��kSQ ��8H)N ]uA,����w��j�a zcbb 6���&� Qcn^b4b2e �l� x� W�
}$ �����9�X��t:�$��n"�0����T8�J)N��!��h4ʉ�F��|�p8|2�X,f��[����͵`0������S���~�O�Z%
}
��i�z=�n���H�X��t:4
��"�B�r�L�R��tv�_�T'�-�l��u��&f_���u�R�����l6� �u]e�
�5~lޢ�n����z�{�e�j���jU��i�w��|}��� ����?��$����&�� ����x
�r��|TN��%��*4�Ç l��;'T�^�ٗG <����"pF�ୌw��!y��h�ݔ��e��E���6�� �
ܙצ� ��P���J��:� C\DW�^���,<<�4�� � A���� �ѹ�]��s��6� ޑ����� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/zoom.png 0000644 00000001264 15173517750 0023340 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< FIDAT8ˍ�KH�A ���̪-��K�C=�
�Cm�fu�P��)D��B�"�K�$A�
e��t�����J�� Z�yu�m���0�}f~3#�s L�� |!!|g-V�9��Q�鎺��c�`��T���C8*�����5�b�F'��R!D�Ћ�
�kb�^sP��!�������� Loc��g�ע≣�.=^u��֘����[�
� ��65�FG ��� �!�� P
�%wN5�\��q=(�t@ȀѶ (t2)է�"�L?B�2�uXcY��V$�����&����a]c��t����<� �*��� �Q��1��}E )h ��Y����ҁ�갎����6` �D�Xr< :=UR���̞��O���9��8�*}�V&b==h��ցq�ف�+;�˜�JT<��������� ���A� !C�:����̼�}�nAH��~0b�M���36� �+�/ 痗����s�IĢ̾�����Ek� � ��J {�v��!���=_�M�yK�b] �ö�a��{6W�03 �<U��=�c� @_��@,�/fg�kM�q�?)�+� �H� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/wrench.png 0000644 00000001142 15173517750 0023635 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8˕��oQ�_�[�c�+W.]�х�i��5 g � m���J[F�q����#_�)�qո��;,��@��{�;���u pL�TʙH$�(Z� X��M��ɤ���n�i" ��\nt: �}��yD��� �<o��u]�q�}���,���5Q�X��j�P*��DޅB!5�ɠ�l�����X�2�|X��P�VQ( IEA�X���k�
ί���:�lU*h�{-��PU�,�� ��n� �Y���>�� ���0 �\ � ږIU���4(�r�����
� H M�k ̈��_���4��_z����iy�'�"[�
��n1��rM�� �_�A�`b�� �=$Ik�_p-�q�S~�� ��=li~3�Bv"q�Z �A���ԧ̸�r�[��G���]<&�e�!�'ڸ67 �y��q�$O�X!�=_��~1�Gs�~�E��ZQ�x&qW��K3��!ޤ�u��n�kz� Grj�Q�n� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/date.png 0000644 00000001162 15173517750 0023266 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< IDAT8˕RmkA~�ԋ�K$��5X�%� �ǂ!��#�?P��@P�Z(*E�A�#�ܹۙ�w��:�0�;3ϼ�@J ���f?W��o�L����`
�O�Z�+���M������<�ww�
^�I���ś�K�����Z��Rj�F�NV0+�v�E8 �q ���+��bF"�v ���s��;�4 t��� ��>9� ck��t���yx� ��D��7��гm\P���S�t �]�Io�@��#�/ �د���)�[�f����^ѻ�#dHk��b�G"������uݿ�q �\.X��c8�Y��h��H������|�r��}�/�! �F���s� R�B�(�������]���j�T5���V��?ZxY�l6���s�d2Qg��wp�d����C2���p8�A���厊����*��X,¢�� < �}" �W����
�� ��
8s"��j�R-�-tiM�1�e�K�
���l�T*=L��/�F�#�C�7~��
-:MW1�� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/add.png 0000644 00000001335 15173517750 0023103 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< oIDAT8˥��K�a��[�/���Y(�)%X(o�l��Nۖsk��n.���-����h�;8�f���E��P��"jï��MGˈ �}yພ羹�$ I���.t�u���lu��� AX��:�Z�H�h1�D�nZJ�OJB��{�Z����?�`2`��S���=�N$��ő�=;��a�� &j�w ��q�JG�#�<"N���2h8�`��6���x�ցn_+ ~ ��Zto��}`���x%XЛ͈ hXѿ�ƻ/��}���B�J�_G�&�|Q�r-��6� �Aރ EL�⬡\�U3:WUh[�C6+� 6.f� �*� �KܝF��q���� �ou4܄? �d�|X���ҥ �Mv��D` �
*_���[
�� �#A���2��0li��R�|x�q`4w=\������u�Q ��m+G��|%$�� 5 �� Թ���5�RO*�YGM��UO ��G�qj4ְ(X�&
s1�c� ˭( LV�f�
R���d�j��Q '-1��A�TA>U �j 4,�p�V�"4L$ e�@.ArB���Y a~m�y� ��Y])Q8t N�L���ܞt2��"��I ���
�o=C�S��d�)�_��_� AF� (� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/macFFBgHack.png 0000644 00000000317 15173517750 0024366 0 ustar 00 �PNG
IHDR ��c sBIT|d� pHYs ��~� tEXtSoftware Adobe Fireworks CS3��F tEXtCreation Time 7/16/07Z�� (IDATH���A 0 !��U[
Gϱ�JJJJJJJJJ�Y� � ��� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/arrow_up.png 0000644 00000000564 15173517750 0024214 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< IDAT8˥�?/Q�ϲ��hg5��j%�'��F,[
���LH�� 3�(���v��w�=�fcoN{O~9���VM4Q7ܿ�)v/�WQ����=��&���b����p�S�O����� ��^��'&^:\˨6���eND!&� ���9꒣�_|�?\�� � �s���r�x�, �����g�*,(F�#d[�O� ��aAA�*�P
p1����O+C�$`�)����*�w`A��#�0�$��� �*�?�����b&N�R IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/tag_blue.png 0000644 00000003530 15173517750 0024134 0 ustar 00 �PNG
IHDR �a gAMA ��7�� iCCPICC Profile x�T�k�P��e���:g >h�ndStC��kW��Z�6�!H��m\��$�~�ًo:�w�>� كo{�
�a���"L�"���4M'S�����9'��^��qZ�/USO������^ C+�hM��J&G@Ӳy�� �lt�o߫�c՚� � ��5�"�Y�i\�t�։�15��LsX� g8oc�ግ#�f45@� ��B:K�@8�i��
��'&��.�<�ER/�dE� �� s��_���雭��m�N�|�� 9}p�� �?_�A��pX6�5~B�$�&���ti��e��Y)% $�bT�3li� ������P���4�43Y���P��1��KF��ۑ��5>�)�@����r��y��� ���[�:V���ͦ#��wQ?HB�� d(�B a�cĪ�L"J��itTy�8�;(��� Gx�_�^�[�����%��ŷ��Q�麲�ua��n�7��m� Q���H^e�O�Q�u6�S��u �2��%vX ���^�*l
O�����ޭˀq,>��S���%�L��d����B���1CZ��$M��9��P 'w����\/����]��.r#���E|!�3�>_�o�a�۾�d�1Z�ӑ���z���'�=������~V+��cjJ�tO %mN����� |��-���bW�O+
o� ^� I�H�.�;���S�]�i_s9�*p����.7U^��s.�3u� �|^,�� <����;�c�=ma��>V��t.[ ��՟Ϫ���� x���#
�¡_2 pHYs �� diTXtXML:com.adobe.xmp <x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="XMP Core 4.4.0">
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<rdf:Description rdf:about=""
xmlns:xmp="http://ns.adobe.com/xap/1.0/">
<xmp:CreatorTool>Adobe ImageReady</xmp:CreatorTool>
</rdf:Description>
</rdf:RDF>
</x:xmpmeta>
�z `IDAT8}RMka~vW#�j-į��V�&ZjR
�� B��"�Q�����!z�R!� �JA��"�� T ~ zi*U��̶��G_�ݝ}g��yEQp�:::�+��z2��t�~&�o*��L�o�$��d2�e�e�
' �V @4�3H6��DX�0O���@(R���m���F�ٍ�� od��F���ɾ͇xU�p:< "�� N�����T�d�}����\��3��,@��A�Z �������r��r��7�! ��� ��tZ����W�w��F��_�Z�>���lhR���lޢ l�k1��<\ �ؼ
��*� �q:����Z� UB:������{ے�ܡP�@M���elۀ^��z�>�:�D"1�iX��Z
{�e<��)iJl�
E�n)�ev� �`PO�y����db=;;C��X��.� c��� k�1k&8�j���ר_ ���d��{~?j�c�fi�R�ԡs�b��O��� �A����9��&�yd�V;�8�����$�p.r�=�XL���v�}�@!Oa�X,*�C�;���z�����J ��n���Y�T��a�B��!�^�L{n�7��k��� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/page_white_width.png 0000644 00000000465 15173517750 0025671 0 ustar 00 �PNG
IHDR ��7� gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT(υ�A�0E��֕n\x���qob♼� �R�w(���g�I�u2�U��5�S����6�VX���ʲJ6Yhl�Oe< �Ƥj�56�S&����5� ��n�2 ��,��be� %,r�[;�z�ֳ��
X`���<�Ɛ�dz�B����7|�!A��/�n2=V��� �Y��� �r�o� v��Zd IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/bug.png 0000644 00000001406 15173517750 0023127 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8˝��OSQ�\ ^[�تtz��% l$�*�**�2:�
iRp�����
�c0���ąKw&&`44�� �(�e��K�ɽ�w�wrO ��X�\���Hi�s�cUQz@��������;քId�Taˀ���)j���C'يKT��8=����ʯ�9ނ^z� ����Θ ���1OF�Z�[��W�-G�z�?���&�%*��M���Gn�N!�a O>Nc��[ɨX·��0N� �qg*�1Su��b|�{g|�fz)̾����&\
��5\ �0 �3�i� D��;`|�0>A?Tx4^���`�o�qs� �`>ʦ�`��fC��v�@m�X����[r\���At.��)�G�[ Ì �� ���`��N1� ��)�B������W�s+�:�Nd��s�V�a�*D�X.pB�&B�]���H@T�3@�Pڏڠ wV�P6��3yp-�����4� Ǽ
�$�H�'��9��{m @�U�$�ZjC���X�:T��g����L�:�:�?�� [#��{1��P=.2���F\�i���A-D
7�7q��XI��פ b4�ka��Aj�%
ͼj&Q˫H��&�s.��
`�j������KLE3�*ΫX w�6��_�l���=�@�����h�ߊv� �,qq�� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/find.png 0000644 00000001223 15173517750 0023267 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< %IDAT8�c���?%���4��y�dÞ����'/Xf�Ʀ�"ʀ��G�v i �QT�o���@���5 )����%�k;��o�4���� � 7��Y%u� �Z�bV����Ty�E��,X�����ݣ�o6ة��m�=���x��)k� ���?"����e�KZ��帹y�����L���e����?�� ��'��?e���}K��j���m�ѹ�Ó �.dfay���� 6 �\V���o��]Z� ������9�մ�6�\�K/ �b�Ĭ`�
*Y�Bc~Z�:��
��ola�_[�����S1qI��bR����/*.�����?##�;�L�@� �:
�]��_����@�$������e��;��@1��/x%�|���W4�
��|F�=c� 9��WA1 2 5��za�N�?(8���� S����SQE�QBZ� (�`����?�֎n�x% �P`�����_IU�
� P,��a�j (��X���@��K�*��п�9���� }� c�e&R1 �2h�Z<u IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/tag_green.png 0000644 00000001145 15173517750 0024305 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8˅�I�a��O�Uÿ �{�bFc�N4FMt�n����-=�6c li4�BH!�(�dX����.U�>����B�ZE�RA�\F�TB�XD�P������ �}!���r��^�C2��^�@�I`�&���tl� $�ɝ�,S3M�D.��'� ��9�0�NCӴ�������Y6��)F?��2���m$ �b�
�@�W��H<�� �N��t͐x��j� D"�5��v���1o��f�����^���g��V�f�I.l���f�� ��hě��9<��V��O�C|8��i4�>��C8%�J�lGk8 �z����#�S�mȉr�X���Z�\@��{�x<.� ��`����^o�r �Ō��B�x<��^��'��j��}���U�����1���}Q�W��hT ��]"�k�L|�s���n���ێ# �~�ߢK\}b���x'�BQ'{i��^�o�PȲ��z��].�c�)��weS�L|iW� �(��S IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png 0000644 00000000317 15173517750 0026415 0 ustar 00 �PNG
IHDR ��7� gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< aIDAT(�c�π 2�Q��������+�/ދE����p�,
� %ւ��)X���C�۱)X�dB=6���P�M��u]�[�z+����_70!I� ȓ zS5�� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/bullet_black.png 0000644 00000000323 15173517750 0024772 0 ustar 00 �PNG
IHDR ��7� gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< eIDAT(�c�π 2 .�R�
�We��7JaWА�����\
X�]��?���XH^��?���
��7��3`��[����*60H
ڐ��s���V IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/brick.png 0000644 00000000704 15173517750 0023444 0 ustar 00 �PNG
IHDR ��7� gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< VIDAT�?HT ��ݝ��^ٟ�
ju
��ɥ����pOhi/���8ԩ�!�p*��0��Ў��;��}E �,tn�M2��|13 "by��K�$i�^NFD��Й�;��4eZ|�U�j|��jf^��$ig)kY�b�I��u�K��W��P�cJ'U>�4�MK����B݆�eS��J���tO9�iԄ
�ʆ���n#2� ���u` � *�����_�
�R4���+�*����B� ���u���Ϙ�MY�Uo���AaL��G��۽�kE�|"�2w��9�m� [�y�Gw�S��B�3{��e�r �~�㫹��<�{
@ �� �%
�@� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/page_green.png 0000644 00000001155 15173517750 0024447 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT�?��s ��~~���TI�!!�b�F� ,H8���b�1a5�l�
�N�QB� b`�^8M�A��~����y*�������\�)(��0���k��������J������� i�ΆI H ���q�����~����{�СM�кOg��Ԫ(2X2�s��,�}�O>�};���x��3o}~�W �tܠ��$��S�j�bjLEMa8�����y���ww>�����J�Ҫ�*m*��u�=g6 =W�|�v�jz
:@B�(%U�Z��4�\��1���m��f��j"�j��A�ƚ6��hT ��*J � V��ZJZ $@�1�0PHZ�(}
)B�e� ���� @)zc�Ԋe� ��� 0�2FH����d � #���� �W?�9 ��</����; ���C�9�A��x�y��� 轍y3t� -�;��w^�t'I����WM����e С* >��W����i !� Gc��{s��ގl6� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/plugin.png 0000644 00000001117 15173517750 0023647 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8˥�=H�q��f~\?��,��yoX�{KC��7�PcM�5�4EkS$�8V*w����J�B%��{�s^1㪋g9�����9IDp�8��ラ�%w%I�
=���@]m�v�bS?��|b��~��?��Gժi�lT70��������p��,�@ۙ�ܘ^�Y3�$ՙO�<o�a ��x8 A�܉�BW!�����!JB�x8K?�Y�\����z܃S�<f����R�DKC��� ����Pf'� ��h����af��WãI��n�]�BW��)䎇�p��!Gos �A�MN���X�� � �0eY[�ra�B�A���m ����h=ڊ�I#͘�0���6�1;����Ū���3Q� @s�e
���p�k_�; +��� ?R15�S_?q�� �9�*�H�3��ɞ����`�!w� �����2/��L .�\��c�Ie��صf|��Ĕ�b��`���M �o��w=��_��m�6E�X IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/ruby.png 0000644 00000001120 15173517750 0023324 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8�͓�K�Q � ��&*z��( z�2��4��r�!��\e7�7�V"�x!bT7�R*�c�
�<��|���|:[WAD�>���9���{L�i'�v����%IID=z�/�;��"�\k��)�k�u�9��x�]2��$��W0=
��������$��Q��H�>}F|`���n6ϜϤkN7
>��9LL��(,.�� �����}>ּ^��
��OMM|��%꿏�:/T]�F$ �6VW)��)t��5����F�K�����ò� Qq"� �r�f ��y_�O�a| ���p�HJ�*MT��X8��[^D��r���-|��|[��v(33���!�.���44���NJ�e�bʡr� טu�͚�d�+��@� S[K���o ~TK��r�j�k������or a��P�DP��y5�@Y�?i�܅��Sg��@'�˼Zj��_M�5���̻��w��.� ;�'5�ڿ_��� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png 0000644 00000000321 15173517750 0026240 0 ustar 00 �PNG
IHDR ��7� gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< cIDAT(�c�π 2�Q��������+�/ދE����p�,
� %��ć�O��`
P�oǦ`1� ���BrC6�u�o�_�?��$�
}J Ʀg IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/transparent.png 0000644 00000000141 15173517750 0024706 0 ustar 00 �PNG
IHDR %=m" PLTE������ tRNS @��f IDAT c`
0 ���z IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif 0000644 00000013376 15173517750 0025621 0 ustar 00 GIF89a�
� �������������������������������������������������������������� !� NETSCAPE2.0 !�
, �
� �@Ri�h��l�p,�tm�#6N���+�r��rD4 �h��@F�Cjz]L�����j�]�R���3-���H$w�Py��� |KI��������\K����� ��Q\���]P��I���� ��������~$�
~�
��������������������������J������������������ �%:`���@ X�P@AO 2|�(�D��**�H�E� }l�F�=��$� �Ƌ@\9��L� J(��)?�
``��C�=�4�RO@�>}5�TDU�^=�U�Q�H�~���X�e���֫��:<��!�� �b`�^O �v��y ':<�/%Ƅ��E��n`ʎ3A�����Ɗ�~�`�۸Rf*�4�L���� E3��DZ�[�����FU��պ�g*>|Ao��G ��4Q�]���V;��ޙ
<��G)�� }����SvO�<}��&p ���y� �]�Xg
X�
�`�"1���A� fJh!�B 2�8'�m
�� uљtbj)��H s6.7�L;jԣJ?���p6�� �l�@k[� ��-)��P��V�X���fQ9�{f�ĥZ^v &��0�
l���p�)g 9P !�
, � � EMb��T��5+��k��sl�y���[�J;��w3iH�ʒ:�Q��X�R$�Á��511��@��eg;=��(g�ڙ��n%pf�"�|��w}��zv[xE%` +�% �����1"
��� �����1������������������Ʒ�1��+ +�'i 1֘~ ���~������%�t����"�����������ݫ'�$|dЉ'N�7o%p�Dz�:�)�D����H�$��D��E��tl���̑5żlP�4 #��y��5��S�RzC>� j��U���z�ҧ]�$�j�QM
ʆķ� �772�1@ܒ�DH�; ܋%Ѕ���q��ۛX���M�g����Nά�g�MW z!`���d���ѥ]���uj��a��}�a ݸ�6;�5լD�zT�h,5�~�z~�@y[�:�3M�7�g�G�]�����q�=@c5
4�u����흃�5_�� �_9���_A�Mt�B\���K ⵘ}" @l��D�i��Qu� +b�aq&��{#'�L�H�jz��"$&�� �$B !�
, � � EI���@*�P�R*;ò[������L���l7DҎ�%�G�I�0)���m��IԲ�����`��I��}>ă�}-R�wFu�}y�|O�(p�*�"�rt�{R��A>(
�^( �"��4���
��� �3������������3��3���.�.����Чɞ
v.*o 3��u ��� z���z����(� ����D���.��z� Ha ���р�P����*6���=� %������8��A%ϤH�]J��Q&��� �2�L��z�녆Aɔ>5 0j�(� ]�T�.�s
�*�I�@m:n�Tx^7�}�v(�H�y�!8�/�
��4^ֹ��Gi`z��A�" �� ?l�8�]�'STҧX�*3� �@X��MS<@�蜮-�.���/A��y5��|��U�v�۬�ϰ�V�r�4<A:\�4��bm��dv�i� � {˿�ӛ �W��'7��n�����a��q{�"8V�_��u_^���2���_��[k��o�Tpbp
:��M
�s�k�x_"Vؓ�� !�
, � � %R�4� y�ԬԢ���\�K���٩��l'#���Q�<�P:��A*�4� G����Z����L���nq�,���I�\��EoI�Uzqx#)��_"�"
��� �0��0���+�0�#��#�I�"����'�����2� 0� � q�+��t�'��� �k���`���n�����܀�#�����|�2�aq�Vk������oE �f
NC��})Tǐ`��� R8��ć=��5��& �D9�ۦ Z�{�@滗1M�۴��͇)�Ty��N39]Ʊ�A�o���V
j�>Z0ՠV�T�y����ïe�]U���4�f!P�c0z ��kW+_� �^��ў`v�"�Ŋa@x:@O,��Ȭt�K5�z�sR�tH5�y3�ʥ�>yz= �3[/�Z|��&�����x @��7n��Gd�n� �B� ^��|{Z�C�N�3�Z�&$�p�{f�;^C}C���o� ���% !�
, � � %�$5��,%�:��k��.]�#>����� �B"�ZRp�]2�S���hk�9�E�-�e<ͩ��k�Gj6�-��t��� ���wsz|m���OQti����x��41
)
�U" ��� �B������Q
��������B������)��������#�� �� B+u��� �)�ێ��� �#��������"���� �p��g�߿=�Q�Ǎ��P�a Q��*֑X�b<88����l$�����Q,?� y2��=0յT#r�Η5� �
�9`jL mgT�J�2��M�Wy6�jukիK�y�0 �i��P0J� Cg&(`���oq]�혗']u}C* ���^\sx�a��GtKp eÈa� @��j�v�l�g�V�D�z$�ͣQ�>m�b��1�����6�}�4 @�l�`Ѫ�zvs�Gt� 2y��/V+��S��NJ=^ ����"�+Y � 09ڛ>0}���Lj��`���ab�q�O
��'8^� X�d����|5 [��ahW�Y��7 ֑W6!��i���!��qHX�&�(@�3�&B !�
, � � Q$�@RS��"�� �k;�� S�]�3X'���+�ζS
���tUi���k ���`��m��0���c�]���w��l��dt$v}��k~zq,l��ryu�x��?)B�� ����
�����; �0��0�����;�����+ �������G� 0-g��+� ���.z�����%�������$��z ��������+�l�(jx�9hN� ���t �<�; 8O��7�y�xH#�| �����bH�$ѼLip�ȅ ѐ�
� �2"��-��A��(���P� $��tj� @{ ��s(W��$( ��=�!u�5��(�jm�n wmĸo����A���@w/��������d�1+: '���l� �1�f��#�|,z2�0Hg�������@1}�թٯ�[��3�S�+|�7U�ǃ�.�{�� P卵0ʶc=+PL�0�3�:~���p��'����v{��O��n<����~)�@��u�P6
��k (� ���àK'v�K
V�`I�9(Z�L�G! !�
, � � �PeRN*�'�,Ԣ���v*�o<�����bK�s M��3�k>o�����R� �sAE1f�m):��k��v���v�M{w�l
��r�tqPm�|��uF~�?W a3�&
���A�6��������6 �-�� ���3���- ����.�,����6o 3/h��-��o��� ������'�d�����z���z��&�����(�CGo߉O��� a� �9 ќD=
�kOOEu j(�Ǒ�L����ʏ�T��IR&K�.��H���=�� ���
�t��tI��£B�0E:qjԪP� �����h�Y �� ʾ�B�F�dÎT0@ �ܝK!Aݽ_�aw�9��h P�(�!Ѣ,�f�ʓmZ�,r��Ɲ[|.��1鑣wZ���h%�.�:�^m�Ri綽7V}c\����u�;o�>o���ü��u+],E�b��d]/\��.������*h�3�;��߯�� ~�����
��|H�oXg���6�]���� ! !�
, � � E9�$�#%5(�,Ԓr��(i�0.����݊�`lXt��D%�ydJ�6���H�^�.�p���l��[k�=.˿�(>�S�x~�gypv}�lNtj�x�{e> �( �~~
�����-������-��� �,-�(��������������� ' �e -/p��(��u �'����"� �����u����� ��������GN�
����šL��1��:�I<���9 u���G '��9��cɕ-Q�$��L�'lD���7U�T��T�� ׄ �t�Ѧ�BU�@%J��JŪ�)W? L�S��Y �b��Zvm��މ ���Б]x�F�0�I�{�V�Xg�|��-Bf�E��#��|.@�4O���P4 �u8S
g ֥_�n �;Ө ՞�(�բQ�)����wǮ<.�(��ʳ2?�����eG��|L�Յ"x�/��-���/�y��+,�p=E��1�� �d�Q��ٷ�~ �� 2Kꔛ$���r
` m*Ys�C
zFn � ak}��nn��I#�����Q !�
, � � %R�4��Ԝ"CA,���(~ں8د��DA���2hs���+�p]���ˤ�Ob�� K��w8^>��u�z�`�H~htkv"x�m��|1Z,
���-���#�5��1"�1�����'���'�[�#����,�
��,}, �'� p�#��h�1 �w�� �a�������"��������w ��#�p�"b�1� �V-��ak�c���B�) ��P@�;�] Xq�Č#N�-A�"߲Syr����L�4eM�ʚph�\@�e�q/o�� ���D2(q ��s:g��u@��Fu+��Q�AU���ӯZ��#xbR�� ��4�v�G1 ��
M�����ɻ�� �;8F�P`B۩3he�11O~� �˟��>z�(�C�3���A=��\���Z-�ڇ�A��� �a��-qiS�R�����Ym�G�(�1���;��Ž��=dt�q�B�[��� !�
, �
� %�di�h��l�p,�4�0T:�Ԕ��n琘�9␄\� ���<
�P)�J�Z���+^�f�(��-N �Ǥ4��an��t#o~$z|u�#��Svx��@��������"�'�������% �#m# ���S���%�
��� ��$��%�§ ������#���ְ��ͽ�$�& A��"����% �� �$��#��H݃'/�9�����BH
E d�O�C�)L��q#F�o� ��g�B��b�DIʤC������'C��Rg̙G�� 4^M=<iEj0�ћM�-0��R=��jB+î��{u,H�YÖ$+vhP�z�z�$W-] ���&������=���-� >F\�dd��3 X�堙Kl��٣�̊@��@���T��?}��IV�UT+��������o�l�|gr�
T�e��lu�ӭ��ޒ�v��G�]l<ݑ�sg��_D
�)4E�Q����_i� ��)�Pi#���!h Da
%���.@��q�M��OQ `�pn��yHW� �C�"�$�s*
��]hp$��V
8��<��c ! ; share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/page_white_text.png 0000644 00000000526 15173517750 0025534 0 ustar 00 �PNG
IHDR ��7� gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT�1nSA��Ǟ�4A����(�I�Sp.KPp"��Q�A�7%����1Ӣ�;� ��+���Z######����DWk=�C��?����|��X��j�9昇���S �ekMs9���NNV��G@���kD)��4� hn�������.Q�@�nJ)1]:�; 1@�� �T��:� t���i��:�� �I�$f M ��-�+g �]����^Lv IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/package.png 0000644 00000001525 15173517750 0023747 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8�}�Kh\u ��{g�̝4�L���)�B�1>�n\��F��)��PAD�� Q�TWf!�"؍�����` �HC0ijC�1ͳ��L�f w���(v!�g}�6�9���)wyc�/T4�" ����Գ� X�8ѫ� �����̛v���כ*������� �WG U}[E>�� ��7�&����t�Ji�G�+*rQE� >�{� `�����=�����9 o/ror��g�aw=MЪ�U��Q��VcƏ�;}ź;q�D�>��r ��7j�T�1a��U&m�8�6��l7K���Vio{�Ǥ9s���VԨ�,O"a��Wū���mpt�k��.h-��V}�����֯K��*�R�\�M�- Юޡ�'O�'C�U0)�7����9Ms�&�3�P#���� V
'w '�ů� �
N,�o��p���#�L Ri4�Q�j�� h �]��G�S\���;Q���Ƥ��B�H��`�1����@<Ѐd�^�{�9�]� �!�� �"���dlǁD� @|0mp��
� ��Q���
a+��k��K7����
�"$���� h$?$�B�r�N#&Cif
�N�7�S���V[�6��l�a�L/Hb�F�6�t����X�=�ֽɕد}��GO�|뻗zU�C5r���h�8�D>��)4V�w���ͦ�|�"������L\>2�FΫ�[�^y�jW��?�'q{�g �Bi��o�.��ȧ��T��c��t�ܲ^&�� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/brick_link.png 0000644 00000001374 15173517750 0024465 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< �IDAT8�mR�K�Q���� -f=��?�I�ZT�v��rpm�ED R-*"+RJ,+"ZLR�.JŢ��>DÔ��?��R;��c����}��s�}W��b{{����Jlff�`��[��%��n�Js.��Û/�ZA ���8>>F�P@>������5�}q$ {�_���Kx< �B!���y�+q����� IE���auuN�S�1st���ppp �LMM���;99���G ��T/=/����������
LNN�aO�d2H$8;;��9�pzzZt�xgg�p^�W" bbbBU���$A:����-"������W�U9D6nnnJ����JUUqss�d2�X,&U����]�H�tF'$���fS����4
�x\>C���� v� ���XZZ������d�j�r��*���^�G�Q�R)������ג�c���t� ]��l6G�M��r�����������8��������d���0���e\SS���$immMW��p�544�zzz�Ipuu�^���u90�_�9�������>�������^WTT|� ������P]]���: �$����A����W���Ã��w�{5n���ZZZ���&c��]�5�}EP^^�����`�0��,˃�ccc�W�/"֘� kX� ���Y�j� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/images/delete.png 0000644 00000001313 15173517750 0023611 0 ustar 00 �PNG
IHDR �a gAMA ��7�� tEXtSoftware Adobe ImageReadyq�e< ]IDAT8˥��KSa�[� ��n��QP��2w��ܦγL�[,bi��a�A��\�C��v��_2Ml�ZFjס���NMjm��kʷ�`&.#z�����<ϓ ���bV��P�T3�%�I��{G��qRiv�ȅ�
�tz�#E�� 6����Edd���J�`���DR�2<]N� �;�4�Ѿ;���m>� 7��8��ɀQe6�L�I���t��殷c�q!z� |v ��j�/Xi���@��
� %1|h���l� !���|������!
�Y#�u�U�N�w]�˼ H3��u� t]E��>k%�I�f��o���R��D:�0��`�~� |�
���(r�
�on�3oG0!�$����V��
�*[W0_������-+���� d�� W� &�2�ZfMF��VJp�iF&B��
>� �R���g�-� �~ C�m��ڴ���ER�
ឫ� p�5ްy����+��21���K�aw�h�`� ��#���a�Z�T�Zo���L��ѓ���`"�(?��'� �ˎJv�K�ކ��|�:�G9[�a�w8�2
Jw ��f'��y����m�zsӘ��Tsw��_��_� �ιIr� IEND�B`� share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml 0000644 00000000640 15173517750 0024741 0 ustar 00 <%- unless klass.method_list.empty? then %>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<%- klass.each_method do |meth| -%>
<li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name -%></a>
<%- end -%>
</ul>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml 0000644 00000000535 15173517750 0025260 0 ustar 00 <div id="home-section" class="nav-section">
<h3>Documentation</h3>
<ul>
<%- installed.each do |name, href, exists, type, _| -%>
<%- next if type == :extra -%>
<li class="folder">
<%- if exists then -%>
<a href="<%= href %>"><%= h name %></a>
<%- else -%>
<%= h name %>
<%- end -%>
<%- end -%>
</ul>
</div>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/page.rhtml 0000644 00000000657 15173517750 0022372 0 ustar 00 <body id="top" role="document" class="file">
<nav role="navigation">
<div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %>
</div>
<%= render '_sidebar_table_of_contents.rhtml' %>
<div id="project-metadata">
<%= render '_sidebar_pages.rhtml' %>
</div>
</nav>
<main role="main" aria-label="Page <%=h file.full_name%>">
<%= file.description %>
</main>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml 0000644 00000002237 15173517750 0026772 0 ustar 00 <%- comment = if current.respond_to? :comment_location then
current.comment_location
else
current.comment
end
table = current.parse(comment).table_of_contents.dup
if table.length > 1 then %>
<div class="nav-section">
<h3>Table of Contents</h3>
<%- display_link = proc do |heading| -%>
<a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
<%- end -%>
<%- list_siblings = proc do -%>
<%- level = table.first&.level -%>
<%- while table.first && table.first.level >= level -%>
<%- heading = table.shift -%>
<%- if table.first.nil? || table.first.level <= heading.level -%>
<li><% display_link.call heading -%>
<%- else -%>
<li>
<details open>
<summary><%- display_link.call heading -%></summary>
<ul class="link-list" role="directory">
<% list_siblings.call %>
</ul>
</details>
</li>
<%- end -%>
<%- end -%>
<%- end -%>
<ul class="link-list" role="directory">
<% list_siblings.call %>
</ul>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml 0000644 00000000671 15173517750 0025441 0 ustar 00 <div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="<%= rel_prefix %>/index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="<%= rel_prefix %>/table_of_contents.html#pages">Pages</a>
<a href="<%= rel_prefix %>/table_of_contents.html#classes">Classes</a>
<a href="<%= rel_prefix %>/table_of_contents.html#methods">Methods</a>
</div>
</div>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml 0000644 00000000705 15173517750 0024752 0 ustar 00 <%- unless klass.extends.empty? then %>
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<%- klass.each_extend do |ext| -%>
<%- unless String === ext.module then -%>
<li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
<%- else -%>
<li><span class="extend"><%= ext.name %></span>
<%- end -%>
<%- end -%>
</ul>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml 0000644 00000000260 15173517750 0025064 0 ustar 00 <div id="file-list-section" class="nav-section">
<h3>Defined In</h3>
<ul>
<%- klass.in_files.each do |tl| -%>
<li><%= h tl.relative_name %>
<%- end -%>
</ul>
</div>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/index.rhtml 0000644 00000001100 15173517750 0022545 0 ustar 00 <body id="top" role="document" class="file">
<nav role="navigation">
<div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %>
</div>
<div id="project-metadata">
<%= render '_sidebar_pages.rhtml' %>
<%= render '_sidebar_classes.rhtml' %>
</div>
</nav>
<main role="main">
<%- if @options.main_page and
main_page = @files.find { |f| f.full_name == @options.main_page } then %>
<%= main_page.description %>
<%- else -%>
<p>This is the API documentation for <%= h @title %>.
<%- end -%>
</main>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml 0000644 00000002005 15173517750 0024372 0 ustar 00 <%- simple_files = @files.select { |f| f.text? } %>
<%- if defined?(current) -%>
<%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name -%>
<%- end -%>
<%- unless simple_files.empty? then -%>
<div id="fileindex-section" class="nav-section">
<h3>Pages</h3>
<ul class="link-list">
<%- simple_files.group_by do |f| -%>
<%- f.full_name[%r{\A[^/]+(?=/)}] || f.page_name -%>
<%- end.each do |n, files| -%>
<%- f = files.shift -%>
<%- if files.empty? -%>
<li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
<%- next -%>
<%- end -%>
<li><details<% if dir == n %> open<% end %>><summary><%
if n == f.page_name
%><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h n %></a><%
else
%><%= h n %><% files.unshift(f)
end %></summary>
<ul class="link-list">
<%- files.each do |f| -%>
<li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
<%- end -%>
</ul></details>
<%- end -%>
</ul>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/servlet_root.rhtml 0000644 00000003405 15173517750 0024177 0 ustar 00 <body role="document">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" class="nav-section">
<h2>
<a href="<%= rel_prefix %>/" rel="home">Home</a>
</h2>
</div>
<%= render '_sidebar_search.rhtml' %>
</div>
<%= render '_sidebar_installed.rhtml' %>
</nav>
<main role="main">
<h1>Local RDoc Documentation</h1>
<p>Here you can browse local documentation from the ruby standard library and
your installed gems.
<%- extra_dirs = installed.select { |_, _, _, type,| type == :extra } -%>
<%- unless extra_dirs.empty? -%>
<h2>Extra Documentation Directories</h2>
<p>The following additional documentation directories are available:</p>
<ol>
<%- extra_dirs.each do |name, href, exists, _, path| -%>
<li>
<%- if exists -%>
<a href="<%= href %>"><%= h name %></a> (<%= h path %>)
<%- else -%>
<%= h name %> (<%= h path %>; <i>not available</i>)
<%- end -%>
</li>
<%- end -%>
</ol>
<%- end -%>
<%- gems = installed.select { |_, _, _, type,| type == :gem } -%>
<%- missing = gems.reject { |_, _, exists,| exists } -%>
<%- unless missing.empty? then -%>
<h2>Missing Gem Documentation</h2>
<p>You are missing documentation for some of your installed gems.
You can install missing documentation for gems by running
<kbd>gem rdoc --all</kbd>. After installing the missing documentation you
only need to reload this page. The newly created documentation will
automatically appear.
<p>You can also install documentation for a specific gem by running one of
the following commands.
<ul>
<%- names = missing.map { |name,| name.sub(/-([^-]*)$/, '') }.uniq -%>
<%- names.each do |name| -%>
<li><kbd>gem rdoc <%=h name %></kbd>
<%- end -%>
</ul>
<%- end -%>
</main>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_head.rhtml 0000644 00000001561 15173517750 0022511 0 ustar 00 <meta charset="<%= @options.charset %>">
<title><%= h @title %></title>
<script type="text/javascript">
var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
var index_rel_prefix = "<%= h rel_prefix %>/";
</script>
<script src="<%= h asset_rel_prefix %>/js/navigation.js" defer></script>
<script src="<%= h asset_rel_prefix %>/js/search.js" defer></script>
<script src="<%= h asset_rel_prefix %>/js/search_index.js" defer></script>
<script src="<%= h asset_rel_prefix %>/js/searcher.js" defer></script>
<script src="<%= h asset_rel_prefix %>/js/darkfish.js" defer></script>
<link href="<%= h asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
<link href="<%= h asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
<%- @options.template_stylesheets.each do |stylesheet| -%>
<link href="<%= h asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_footer.rhtml 0000644 00000000536 15173517750 0023107 0 ustar 00 <footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> <%= RDoc::VERSION %>.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/css/fonts.css 0000644 00000014364 15173517750 0023041 0 ustar 00 /*
* Copyright 2010, 2012 Adobe Systems Incorporated (http://www.adobe.com/),
* with Reserved Font Name "Source". All Rights Reserved. Source is a
* trademark of Adobe Systems Incorporated in the United States and/or other
* countries.
*
* This Font Software is licensed under the SIL Open Font License, Version
* 1.1.
*
* This license is copied below, and is also available with a FAQ at:
* http://scripts.sil.org/OFL
*/
@font-face {
font-family: "Source Code Pro";
font-style: normal;
font-weight: 400;
src: local("Source Code Pro"),
local("SourceCodePro-Regular"),
url("../fonts/SourceCodePro-Regular.ttf") format("truetype");
}
@font-face {
font-family: "Source Code Pro";
font-style: normal;
font-weight: 700;
src: local("Source Code Pro Bold"),
local("SourceCodePro-Bold"),
url("../fonts/SourceCodePro-Bold.ttf") format("truetype");
}
/*
* Copyright (c) 2010, Łukasz Dziedzic (dziedzic@typoland.com),
* with Reserved Font Name Lato.
*
* This Font Software is licensed under the SIL Open Font License, Version
* 1.1.
*
* This license is copied below, and is also available with a FAQ at:
* http://scripts.sil.org/OFL
*/
@font-face {
font-family: "Lato";
font-style: normal;
font-weight: 300;
src: local("Lato Light"),
local("Lato-Light"),
url("../fonts/Lato-Light.ttf") format("truetype");
}
@font-face {
font-family: "Lato";
font-style: italic;
font-weight: 300;
src: local("Lato Light Italic"),
local("Lato-LightItalic"),
url("../fonts/Lato-LightItalic.ttf") format("truetype");
}
@font-face {
font-family: "Lato";
font-style: normal;
font-weight: 700;
src: local("Lato Regular"),
local("Lato-Regular"),
url("../fonts/Lato-Regular.ttf") format("truetype");
}
@font-face {
font-family: "Lato";
font-style: italic;
font-weight: 700;
src: local("Lato Italic"),
local("Lato-Italic"),
url("../fonts/Lato-RegularItalic.ttf") format("truetype");
}
/*
* -----------------------------------------------------------
* SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
* -----------------------------------------------------------
*
* PREAMBLE
* The goals of the Open Font License (OFL) are to stimulate worldwide
* development of collaborative font projects, to support the font creation
* efforts of academic and linguistic communities, and to provide a free and
* open framework in which fonts may be shared and improved in partnership
* with others.
*
* The OFL allows the licensed fonts to be used, studied, modified and
* redistributed freely as long as they are not sold by themselves. The
* fonts, including any derivative works, can be bundled, embedded,
* redistributed and/or sold with any software provided that any reserved
* names are not used by derivative works. The fonts and derivatives,
* however, cannot be released under any other type of license. The
* requirement for fonts to remain under this license does not apply
* to any document created using the fonts or their derivatives.
*
* DEFINITIONS
* "Font Software" refers to the set of files released by the Copyright
* Holder(s) under this license and clearly marked as such. This may
* include source files, build scripts and documentation.
*
* "Reserved Font Name" refers to any names specified as such after the
* copyright statement(s).
*
* "Original Version" refers to the collection of Font Software components as
* distributed by the Copyright Holder(s).
*
* "Modified Version" refers to any derivative made by adding to, deleting,
* or substituting -- in part or in whole -- any of the components of the
* Original Version, by changing formats or by porting the Font Software to a
* new environment.
*
* "Author" refers to any designer, engineer, programmer, technical
* writer or other person who contributed to the Font Software.
*
* PERMISSION & CONDITIONS
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of the Font Software, to use, study, copy, merge, embed, modify,
* redistribute, and sell modified and unmodified copies of the Font
* Software, subject to the following conditions:
*
* 1) Neither the Font Software nor any of its individual components,
* in Original or Modified Versions, may be sold by itself.
*
* 2) Original or Modified Versions of the Font Software may be bundled,
* redistributed and/or sold with any software, provided that each copy
* contains the above copyright notice and this license. These can be
* included either as stand-alone text files, human-readable headers or
* in the appropriate machine-readable metadata fields within text or
* binary files as long as those fields can be easily viewed by the user.
*
* 3) No Modified Version of the Font Software may use the Reserved Font
* Name(s) unless explicit written permission is granted by the corresponding
* Copyright Holder. This restriction only applies to the primary font name as
* presented to the users.
*
* 4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
* Software shall not be used to promote, endorse or advertise any
* Modified Version, except to acknowledge the contribution(s) of the
* Copyright Holder(s) and the Author(s) or with their explicit written
* permission.
*
* 5) The Font Software, modified or unmodified, in part or in whole,
* must be distributed entirely under this license, and must not be
* distributed under any other license. The requirement for fonts to
* remain under this license does not apply to any document created
* using the Font Software.
*
* TERMINATION
* This license becomes null and void if any of the above conditions are
* not met.
*
* DISCLAIMER
* THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
* OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
* DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
* OTHER DEALINGS IN THE FONT SOFTWARE.
*/
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/css/rdoc.css 0000644 00000025456 15173517750 0022643 0 ustar 00 /*
* "Darkfish" Rdoc CSS
* $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $
*
* Author: Michael Granger <ged@FaerieMUD.org>
*
*/
/* vim: ft=css et sw=2 ts=2 sts=2 */
/* Base Green is: #6C8C22 */
.hide { display: none !important; }
* { padding: 0; margin: 0; }
body {
background: #fafafa;
font-family: Lato, sans-serif;
font-weight: 300;
/* Layout */
display: grid;
grid-template-columns: auto 1fr;
}
body > :last-child {
grid-column: 1 / 3;
}
h1 span,
h2 span,
h3 span,
h4 span,
h5 span,
h6 span {
position: relative;
display: none;
padding-left: 1em;
line-height: 0;
vertical-align: baseline;
font-size: 10px;
}
h1 span { top: -1.3em; }
h2 span { top: -1.2em; }
h3 span { top: -1.0em; }
h4 span { top: -0.8em; }
h5 span { top: -0.5em; }
h6 span { top: -0.5em; }
h1:hover span,
h2:hover span,
h3:hover span,
h4:hover span,
h5:hover span,
h6:hover span {
display: inline;
}
h1:target,
h2:target,
h3:target,
h4:target,
h5:target,
h6:target {
margin-left: -10px;
border-left: 10px solid #f1edba;
}
:link,
:visited {
color: #6C8C22;
text-decoration: none;
}
:link:hover,
:visited:hover {
border-bottom: 1px dotted #6C8C22;
}
code,
pre {
font-family: "Source Code Pro", Monaco, monospace;
background-color: rgba(27,31,35,0.05);
padding: 0em 0.2em;
border-radius: 0.2em;
}
em {
text-decoration-color: rgba(52, 48, 64, 0.25);
text-decoration-line: underline;
text-decoration-style: dotted;
}
strong,
em {
background-color: rgba(158, 178, 255, 0.1);
}
table {
margin: 0;
border-spacing: 0;
border-collapse: collapse;
}
table tr th, table tr td {
padding: 0.2em 0.4em;
border: 1px solid #ccc;
}
table tr th {
background-color: #eceaed;
}
table tr:nth-child(even) td {
background-color: #f5f4f6;
}
/* @group Generic Classes */
.initially-hidden {
display: none;
}
#search-field {
width: 98%;
background: white;
border: none;
height: 1.5em;
-webkit-border-radius: 4px;
-moz-border-radius: 4px;
border-radius: 4px;
text-align: left;
}
#search-field:focus {
background: #f1edba;
}
#search-field:-moz-placeholder,
#search-field::-webkit-input-placeholder {
font-weight: bold;
color: #666;
}
.missing-docs {
font-size: 120%;
background: white url(../images/wrench_orange.png) no-repeat 4px center;
color: #ccc;
line-height: 2em;
border: 1px solid #d00;
opacity: 1;
padding-left: 20px;
text-indent: 24px;
letter-spacing: 3px;
font-weight: bold;
-webkit-border-radius: 5px;
-moz-border-radius: 5px;
}
.target-section {
border: 2px solid #dcce90;
border-left-width: 8px;
padding: 0 1em;
background: #fff3c2;
}
/* @end */
/* @group Index Page, Standalone file pages */
.table-of-contents ul {
margin: 1em;
list-style: none;
}
.table-of-contents ul ul {
margin-top: 0.25em;
}
.table-of-contents ul :link,
.table-of-contents ul :visited {
font-size: 16px;
}
.table-of-contents li {
margin-bottom: 0.25em;
}
.table-of-contents li .toc-toggle {
width: 16px;
height: 16px;
background: url(../images/add.png) no-repeat;
}
.table-of-contents li .toc-toggle.open {
background: url(../images/delete.png) no-repeat;
}
/* @end */
/* @group Top-Level Structure */
nav {
font-family: Helvetica, sans-serif;
font-size: 14px;
border-right: 1px solid #ccc;
position: sticky;
top: 0;
overflow: auto;
/* Layout */
width: 260px; /* fallback */
width: max(50px, 20vw);
min-width: 50px;
max-width: 80vw;
height: calc(100vh - 100px); /* reduce the footer height */
resize: horizontal;
}
main {
display: block;
margin: 1em;
min-width: 340px;
font-size: 16px;
}
main h1,
main h2,
main h3,
main h4,
main h5,
main h6 {
font-family: Helvetica, sans-serif;
}
.table-of-contents main {
margin-left: 2em;
}
#validator-badges {
margin: 1em 1em 2em;
font-size: smaller;
}
/* @end */
/* @group navigation */
nav {
margin-bottom: 1em;
}
nav .nav-section {
margin-top: 2em;
border-top: 2px solid #aaa;
font-size: 90%;
overflow: hidden;
}
nav h2 {
margin: 0;
padding: 2px 8px 2px 8px;
background-color: #e8e8e8;
color: #555;
font-size: 125%;
text-align: center;
}
nav h3,
#table-of-contents-navigation {
margin: 0;
padding: 2px 8px 2px 8px;
text-align: right;
background-color: #e8e8e8;
color: #555;
}
nav ul,
nav dl,
nav p {
padding: 4px 8px 0;
list-style: none;
}
#project-navigation .nav-section {
margin: 0;
border-top: 0;
}
#home-section h2 {
text-align: center;
}
#table-of-contents-navigation {
font-size: 1.2em;
font-weight: bold;
text-align: center;
}
#search-section {
margin-top: 0;
border-top: 0;
}
#search-field-wrapper {
border-top: 1px solid #aaa;
border-bottom: 1px solid #aaa;
padding: 3px 8px;
background-color: #e8e8e8;
color: #555;
}
ul.link-list li {
white-space: nowrap;
line-height: 1.4em;
}
ul.link-list .type {
font-size: 8px;
text-transform: uppercase;
color: white;
background: #969696;
padding: 2px 4px;
-webkit-border-radius: 5px;
}
dl.note-list dt {
float: left;
margin-right: 1em;
}
.calls-super {
background: url(../images/arrow_up.png) no-repeat right center;
}
.nav-section details > summary {
display: block;
}
.nav-section details > summary::-webkit-details-marker {
display: none;
}
.nav-section details > summary::before {
content: "";
}
.nav-section details > summary::after {
content: "\25B6"; /* BLACK RIGHT-POINTING TRIANGLE */
font-size: 0.8em;
margin-left: 0.4em;
}
.nav-section details[open] > summary::after {
content: "\25BD"; /* WHITE DOWN-POINTING TRIANGLE */
}
/* @end */
/* @group Documentation Section */
main {
color: #333;
}
main > h1:first-child,
main > h2:first-child,
main > h3:first-child,
main > h4:first-child,
main > h5:first-child,
main > h6:first-child {
margin-top: 0px;
}
main sup {
vertical-align: super;
font-size: 0.8em;
}
/* The heading with the class name */
main h1[class] {
margin-top: 0;
margin-bottom: 1em;
font-size: 2em;
color: #6C8C22;
}
main h1 {
margin: 2em 0 0.5em;
font-size: 1.7em;
}
main h2 {
margin: 2em 0 0.5em;
font-size: 1.5em;
}
main h3 {
margin: 2em 0 0.5em;
font-size: 1.2em;
}
main h4 {
margin: 2em 0 0.5em;
font-size: 1.1em;
}
main h5 {
margin: 2em 0 0.5em;
font-size: 1em;
}
main h6 {
margin: 2em 0 0.5em;
font-size: 1em;
}
main p {
margin: 0 0 0.5em;
line-height: 1.4em;
}
main pre {
margin: 1.2em 0.5em;
padding: 1em;
font-size: 0.8em;
}
main hr {
margin: 1.5em 1em;
border: 2px solid #ddd;
}
main blockquote {
margin: 0 2em 1.2em 1.2em;
padding-left: 0.5em;
border-left: 2px solid #ddd;
}
main ol,
main ul {
margin: 1em 2em;
}
main li > p {
margin-bottom: 0.5em;
}
main dl {
margin: 1em 0.5em;
}
main dt {
margin-bottom: 0.5em;
font-weight: bold;
}
main dd {
margin: 0 1em 1em 0.5em;
}
main header h2 {
margin-top: 2em;
border-width: 0;
border-top: 4px solid #bbb;
font-size: 130%;
}
main header h3 {
margin: 2em 0 1.5em;
border-width: 0;
border-top: 3px solid #bbb;
font-size: 120%;
}
.documentation-section-title {
position: relative;
}
.documentation-section-title .section-click-top {
position: absolute;
top: 6px;
left: 12px;
font-size: 10px;
color: #9b9877;
visibility: hidden;
padding-left: 0.5px;
}
.documentation-section-title:hover .section-click-top {
visibility: visible;
}
.constants-list > dl {
margin: 1em 0 2em;
border: 0;
}
.constants-list > dl dt {
margin-bottom: 0.75em;
padding-left: 0;
font-family: "Source Code Pro", Monaco, monospace;
font-size: 110%;
}
.constants-list > dl dt a {
color: inherit;
}
.constants-list > dl dd {
margin: 0 0 2em 0;
padding: 0;
color: #666;
}
.documentation-section h2 {
position: relative;
}
.documentation-section h2 a {
position: absolute;
top: 8px;
right: 10px;
font-size: 12px;
color: #9b9877;
visibility: hidden;
}
.documentation-section h2:hover a {
visibility: visible;
}
/* @group Method Details */
main .method-source-code {
max-height: 0;
overflow: auto;
transition-duration: 200ms;
transition-delay: 0ms;
transition-property: all;
transition-timing-function: ease-in-out;
}
main .method-source-code.active-menu {
max-height: 100vh;
}
main .method-description .method-calls-super {
color: #333;
font-weight: bold;
}
main .method-detail {
margin-bottom: 2.5em;
cursor: pointer;
}
main .method-detail:target {
margin-left: -10px;
border-left: 10px solid #f1edba;
}
main .method-heading {
position: relative;
font-family: "Source Code Pro", Monaco, monospace;
font-size: 110%;
font-weight: bold;
color: #333;
}
main .method-heading :link,
main .method-heading :visited {
color: inherit;
}
main .method-click-advice {
position: absolute;
top: 2px;
right: 5px;
font-size: 12px;
color: #9b9877;
visibility: hidden;
padding-right: 20px;
line-height: 20px;
background: url(../images/zoom.png) no-repeat right top;
}
main .method-header:hover .method-click-advice {
visibility: visible;
}
main .method-alias .method-heading {
color: #666;
}
main .method-description,
main .aliases {
margin-top: 0.75em;
color: #333;
}
main .aliases {
padding-top: 4px;
font-style: italic;
cursor: default;
}
main .method-description ul {
margin-left: 1.5em;
}
main #attribute-method-details .method-detail:hover {
background-color: transparent;
cursor: default;
}
main .attribute-access-type {
text-transform: uppercase;
padding: 0 1em;
}
/* @end */
/* @end */
/* @group Source Code */
pre {
margin: 0.5em 0;
border: 1px dashed #999;
padding: 0.5em;
background: #262626;
color: white;
overflow: auto;
}
.ruby-constant { color: #7fffd4; background: transparent; }
.ruby-keyword { color: #00ffff; background: transparent; }
.ruby-ivar { color: #eedd82; background: transparent; }
.ruby-operator { color: #00ffee; background: transparent; }
.ruby-identifier { color: #ffdead; background: transparent; }
.ruby-node { color: #ffa07a; background: transparent; }
.ruby-comment { color: #dc0000; background: transparent; }
.ruby-regexp { color: #ffa07a; background: transparent; }
.ruby-value { color: #7fffd4; background: transparent; }
/* @end */
/* @group search results */
#search-results {
font-family: Lato, sans-serif;
font-weight: 300;
}
#search-results .search-match {
font-family: Helvetica, sans-serif;
font-weight: normal;
}
#search-results .search-selected {
background: #e8e8e8;
border-bottom: 1px solid transparent;
}
#search-results li {
list-style: none;
border-bottom: 1px solid #aaa;
margin-bottom: 0.5em;
}
#search-results li:last-child {
border-bottom: none;
margin-bottom: 0;
}
#search-results li p {
padding: 0;
margin: 0.5em;
}
#search-results .search-namespace {
font-weight: bold;
}
#search-results li em {
background: yellow;
font-style: normal;
}
#search-results pre {
margin: 0.5em;
font-family: "Source Code Pro", Monaco, monospace;
}
/* @end */
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml 0000644 00000001256 15173517750 0024547 0 ustar 00 <div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml 0000644 00000002143 15173517750 0024733 0 ustar 00 <div id="classindex-section" class="nav-section">
<h3>Class and Module Index</h3>
<%-
all_classes = @classes.group_by do |klass|
klass.full_name[/\A[^:]++(?:::[^:]++(?=::))*+(?=::[^:]*+\z)/]
end.delete_if do |_, klasses|
!klasses.any?(&:display?)
end
link = proc do |index_klass, display = index_klass.display?|
if display
-%><code><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.name %></a></code><%-
else
-%><code><%= index_klass.name %></code><%-
end
end
if top = all_classes[nil]
solo = top.one? {|klass| klass.display?}
traverse = proc do |klasses| -%>
<ul class="link-list">
<%- klasses.each do |index_klass| -%>
<%- if children = all_classes[index_klass.full_name] -%>
<li><details<% if solo; solo = false %> open<% end %>><summary><% link.call(index_klass) %></summary>
<%- traverse.call(children) -%>
</ul></details>
<%- elsif index_klass.display? -%>
<li><% link.call(index_klass, true) %>
<%- end -%>
<%- end -%>
<%- end -%>
<%- traverse.call(top) -%>
<%- end -%>
</div>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml 0000644 00000000503 15173517750 0025123 0 ustar 00 <%- unless klass.sections.length == 1 then %>
<div id="sections-section" class="nav-section">
<h3>Sections</h3>
<ul class="link-list" role="directory">
<%- klass.sort_sections.each do |section| -%>
<li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
<%- end -%>
</ul>
</div>
<%- end -%>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/js/darkfish.js 0000644 00000005151 15173517750 0023145 0 ustar 00 /**
*
* Darkfish Page Functions
* $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $
*
* Author: Michael Granger <mgranger@laika.com>
*
*/
/* Provide console simulation for firebug-less environments */
/*
if (!("console" in window) || !("firebug" in console)) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml",
"group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
};
*/
function showSource( e ) {
var target = e.target;
while (!target.classList.contains('method-detail')) {
target = target.parentNode;
}
if (typeof target !== "undefined" && target !== null) {
target = target.querySelector('.method-source-code');
}
if (typeof target !== "undefined" && target !== null) {
target.classList.toggle('active-menu')
}
};
function hookSourceViews() {
document.querySelectorAll('.method-heading').forEach(function (codeObject) {
codeObject.addEventListener('click', showSource);
});
};
function hookSearch() {
var input = document.querySelector('#search-field');
var result = document.querySelector('#search-results');
result.classList.remove("initially-hidden");
var search_section = document.querySelector('#search-section');
search_section.classList.remove("initially-hidden");
var search = new Search(search_data, input, result);
search.renderItem = function(result) {
var li = document.createElement('li');
var html = '';
// TODO add relative path to <script> per-page
html += '<p class="search-match"><a href="' + index_rel_prefix + this.escapeHTML(result.path) + '">' + this.hlt(result.title);
if (result.params)
html += '<span class="params">' + result.params + '</span>';
html += '</a>';
if (result.namespace)
html += '<p class="search-namespace">' + this.hlt(result.namespace);
if (result.snippet)
html += '<div class="search-snippet">' + result.snippet + '</div>';
li.innerHTML = html;
return li;
}
search.select = function(result) {
window.location.href = result.firstChild.firstChild.href;
}
search.scrollIntoView = search.scrollInWindow;
};
function hookFocus() {
document.addEventListener("keydown", (event) => {
if (document.activeElement.tagName === 'INPUT') {
return;
}
if (event.key === "/") {
event.preventDefault();
document.querySelector('#search-field').focus();
}
});
}
document.addEventListener('DOMContentLoaded', function() {
hookSourceViews();
hookSearch();
hookFocus();
});
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/js/search.js 0000644 00000006003 15173517750 0022614 0 ustar 00 Search = function(data, input, result) {
this.data = data;
this.input = input;
this.result = result;
this.current = null;
this.view = this.result.parentNode;
this.searcher = new Searcher(data.index);
this.init();
}
Search.prototype = Object.assign({}, Navigation, new function() {
var suid = 1;
this.init = function() {
var _this = this;
var observer = function(e) {
switch(e.key) {
case 'ArrowUp':
case 'ArrowDown':
return;
}
_this.search(_this.input.value);
};
this.input.addEventListener('keyup', observer);
this.input.addEventListener('click', observer); // mac's clear field
this.searcher.ready(function(results, isLast) {
_this.addResults(results, isLast);
})
this.initNavigation();
this.setNavigationActive(false);
}
this.search = function(value, selectFirstMatch) {
value = value.trim().toLowerCase();
if (value) {
this.setNavigationActive(true);
} else {
this.setNavigationActive(false);
}
if (value == '') {
this.lastQuery = value;
this.result.innerHTML = '';
this.result.setAttribute('aria-expanded', 'false');
this.setNavigationActive(false);
} else if (value != this.lastQuery) {
this.lastQuery = value;
this.result.setAttribute('aria-busy', 'true');
this.result.setAttribute('aria-expanded', 'true');
this.firstRun = true;
this.searcher.find(value);
}
}
this.addResults = function(results, isLast) {
var target = this.result;
if (this.firstRun && (results.length > 0 || isLast)) {
this.current = null;
this.result.innerHTML = '';
}
for (var i=0, l = results.length; i < l; i++) {
var item = this.renderItem.call(this, results[i]);
item.setAttribute('id', 'search-result-' + target.childElementCount);
target.appendChild(item);
};
if (this.firstRun && results.length > 0) {
this.firstRun = false;
this.current = target.firstChild;
this.current.classList.add('search-selected');
}
//TODO: ECMAScript
//if (jQuery.browser.msie) this.$element[0].className += '';
if (isLast) this.result.setAttribute('aria-busy', 'false');
}
this.move = function(isDown) {
if (!this.current) return;
var next = isDown ? this.current.nextElementSibling : this.current.previousElementSibling;
if (next) {
this.current.classList.remove('search-selected');
next.classList.add('search-selected');
this.input.setAttribute('aria-activedescendant', next.getAttribute('id'));
this.scrollIntoView(next, this.view);
this.current = next;
this.input.value = next.firstChild.firstChild.text;
this.input.select();
}
return true;
}
this.hlt = function(html) {
return this.escapeHTML(html).
replace(/\u0001/g, '<em>').
replace(/\u0002/g, '</em>');
}
this.escapeHTML = function(html) {
return html.replace(/[&<>"`']/g, function(c) {
return '&#' + c.charCodeAt(0) + ';';
});
}
});
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf 0000644 00000267764 15173517750 0025366 0 ustar 00 GPOS'�� HPGSUBV.T Il OS/2�8�� J| `cmapRԟ� J� �cvt &�6 e� 8fpgm� zA e� �gasp e� glyf�^�� O� ��head��d� � 6hhea�1 �� $hmtx?k� �� TkernO�Q� �@ g�loca�) N4 ,maxp>
� P` name�Bbd P� }post:�\� b �prep�x9� op �
0 J DFLT latn �� �� kern kern G r �����T��v �
� � � �
V
��8�,^$^ �0��
D��J��J� � � J � L F �!z" ##P#�$4$~%x&&�'�(�)�*�+�+�,J,�-n. .�/$/V/�/�/�1�242n2�2�3 3V3�3�44J4�4�4�5�5�6�7�7�7�8~8�8�:�;";�;�<�=2>,?&?�@�A�B�C8C�D�E.F( > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ - #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ 0 �=
�=
�= �I #�� &�� *�� 2�� 4�� 7�A 9�= :�m <�d ?�= Y�~ Z�� \�� k�� l�= m�I o�I p�� r�= y�I |�= }�I ��� ��� ��� ��� ��� ��� ��� ��d ��~ ��~ �� �� �d �I �I �= �= �= �= �I �I �I & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� 0 �=
�=
�= �I #�� &�� *�� 2�� 4�� 7�A 9�= :�m <�d ?�= Y�~ Z�� \�� k�� l�= m�I o�I p�� r�= y�I |�= }�I ��� ��� ��� ��� ��� ��� ��� ��d ��~ ��~ �� �� �d �I �I �= �= �= �= �I �I �I q > ��
>
> �G �� �G �� �� �� " F #�� $�� &�� *�� -�o 2�� 4�� D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� V�� X�� Y�� Z�� \�� ]�� k�� l > m�� o�� p�� r > t P u P w�� y�� { P | > }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� �� �� � � � > � > �G � > � > �G � �G � � ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� ��
�o m�o o�o y�o }�o �o �o �o �o �o $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� > �� �L �L �� �� �� " $�� -�. D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� X�� w�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �L �L �L ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� +
�� #�� &�� *�� 2�� 4�� I�� W�� Y�� Z�� \�� k�� l m�� o�� p�� r y�� | }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � � � � � 3 ��
��
�� �$ #�� &�� *�� 2�� 4�� 7�8 9�V :�y <�= ?�V Y�z Z�� \�z k�� l�� m�$ o�$ p�� r�� t�= u�= y�$ {�= |�� }�$ ��� ��� ��� ��� ��� ��� ��� ��= ��z ��z �� �� �= �$ �$ �� �� �� �� �$ �$ �$ $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� / �� �= �= �� $�� -�V D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �= �= �= ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� #�� &�� *�� 2�� 4�� 7�� 8�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� f �� �L �L �L �� �] �] " - #�� $�� &�� *�� -�8 2�� 4�� D�) F�) G�) H�) J�A P�] Q�] R�) S�] T�) U�] V�F X�] Y�Q Z�y [�b \�L ]�e k�� m�L o�L p�� w�] y�L }�L ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��) ��) ��) ��) ��) ��) ��) ��) ��) ��) ��) ��) ��) ��] ��) ��) ��) ��) ��) ��) ��] ��] ��] ��] ��Q ��Q �� �) �� �) �) �] �� �) �F �F �e �e �e �L �L �L �L �L �L �L �L ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� q > ��
>
> �G �� �G �� �� �� " F #�� $�� &�� *�� -�o 2�� 4�� D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� V�� X�� Y�� Z�� \�� ]�� k�� l > m�� o�� p�� r > t P u P w�� y�� { P | > }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� �� �� � � � > � > �G � > � > �G � �G � � ��� N F ��
F
F �� �� �� �� �� $�� -�� D�� F�� G�� H�� J�� P�� Q�� R�� S�� T�� U�� V�� X�� l F r F t < u < w�� { < | F ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� � F � F � � F � F � � ��� +
�� #�� &�� *�� 2�� 4�� I�� W�� Y�� Z�� \�� k�� l m�� o�� p�� r y�� | }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � � � � � m 4 �~
4
4 �[ �V �[ �~ �� �� " 2 #�� $�~ &�� *�� -�8 2�� 4�� D�G F�G G�G H�G J�_ P�� Q�� R�G S�� T�G U�� V�G X�� ]�� k�� l 4 m�V o�V p�� r 4 t 2 u 2 w�� y�V { 2 | 4 }�V ��~ ��~ ��~ ��~ ��~ ��~ ��~ ��� ��� ��� ��� ��� ��� ��� ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��� ��G ��G ��G ��G ��G ��G ��� ��� ��� ��� �~ �G �� �G �G �� �� �G �G �G �� �� �� �V �V � 4 � 4 �[ � 4 � 4 �[ �V �[ �V �V ��~ �� " #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � - #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � K
K
K �y �y l K r K t d u d { d | K � K � K �y � K � K �y �y ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � " �y �y D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �y �y �y . �� �~ �~ �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �~ �~ �~ ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� ��� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� . �� �y �y �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �y �y �y ��� - #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ �e �e $�e 9 F : F < ( ? F ��e ��e ��e ��e ��e ��e ��e � ( �e � ( ��e �e �e $�e 9 F : F < ( ? F ��e ��e ��e ��e ��e ��e ��e � ( �e � ( ��e & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� �e �e $�e 9 F : F < ( ? F ��e ��e ��e ��e ��e ��e ��e � ( �e � ( ��e > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� �� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� �� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� �� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� �� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� �� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� ��
�o m�o o�o y�o }�o �o �o �o �o �o $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� m 4 �~
4
4 �[ �V �[ �~ �� �� " 2 #�� $�~ &�� *�� -�8 2�� 4�� D�G F�G G�G H�G J�_ P�� Q�� R�G S�� T�G U�� V�G X�� ]�� k�� l 4 m�V o�V p�� r 4 t 2 u 2 w�� y�V { 2 | 4 }�V ��~ ��~ ��~ ��~ ��~ ��~ ��~ ��� ��� ��� ��� ��� ��� ��� ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��� ��G ��G ��G ��G ��G ��G ��� ��� ��� ��� �~ �G �� �G �G �� �� �G �G �G �� �� �� �V �V � 4 � 4 �[ � 4 � 4 �[ �V �[ �V �V ��~ $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � . �� �~ �~ �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �~ �~ �~ ��� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � . �� �~ �~ �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �~ �~ �~ ��� : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� ��
�o m�o o�o y�o }�o �o �o �o �o �o ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � " �o
�o
�o �t 9�j :�� <�y ?�j Y�� Z�� \�� l�o m�t o�t r�o t�� u�� y�t {�� |�o }�t ��y ��� ��� �y �t �t �o �o �o �o �t �t �t ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � m 4 �~
4
4 �[ �V �[ �~ �� �� " 2 #�� $�~ &�� *�� -�8 2�� 4�� D�G F�G G�G H�G J�_ P�� Q�� R�G S�� T�G U�� V�G X�� ]�� k�� l 4 m�V o�V p�� r 4 t 2 u 2 w�� y�V { 2 | 4 }�V ��~ ��~ ��~ ��~ ��~ ��~ ��~ ��� ��� ��� ��� ��� ��� ��� ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��G ��� ��G ��G ��G ��G ��G ��G ��� ��� ��� ��� �~ �G �� �G �G �� �� �G �G �G �� �� �� �V �V � 4 � 4 �[ � 4 � 4 �[ �V �[ �V �V ��~ �� " #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � �� " #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � �� " #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ 0 �=
�=
�= �I #�� &�� *�� 2�� 4�� 7�A 9�= :�m <�d ?�= Y�~ Z�� \�� k�� l�= m�I o�I p�� r�= y�I |�= }�I ��� ��� ��� ��� ��� ��� ��� ��d ��~ ��~ �� �� �d �I �I �= �= �= �= �I �I �I > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ 0 �=
�=
�= �I #�� &�� *�� 2�� 4�� 7�A 9�= :�m <�d ?�= Y�~ Z�� \�� k�� l�= m�I o�I p�� r�= y�I |�= }�I ��� ��� ��� ��� ��� ��� ��� ��d ��~ ��~ �� �� �d �I �I �= �= �= �= �I �I �I & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� 0 �=
�=
�= �I #�� &�� *�� 2�� 4�� 7�A 9�= :�m <�d ?�= Y�~ Z�� \�� k�� l�= m�I o�I p�� r�= y�I |�= }�I ��� ��� ��� ��� ��� ��� ��� ��d ��~ ��~ �� �� �d �I �I �= �= �= �= �I �I �I & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� & �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� > �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[ : �V
�V
�V �� #�� &�� *�� - 2 2�� 4�� 7�� 8�� 9�� :�� <�y ?�� W�� Y�� Z�� \�� k�� l�V m�� o�� p�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��y ��� ��� �� �� �y �� �� �V �V �V �V �� �� �� r
# $ & ' ) - . / 2 3 4 5 7 8 9 : ; < = > ? E H I K N P Q R S U Y Z [ \ ^ k l m o p r t u y { | } � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �
8 � DFLT latn �� �� case &case ,liga 2liga 8sups >sups D , > B
@ L O , { t u C j q v � � � � � � � I �, x x � A�� �P `K tyPL �J�z��� � �� � &
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � r d e i � x � p k � v j � � � s g w � � � � � l | � � � � c n � � � m } � b � � � � � � � � � � � � � � � � � � � y � � � � � � � � � � � � � � � � � � � � � q � � � z � � � ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ / �� , 8 < @ �� BK� PX@3 ` f [ [ Q C Q
D@4 h f [ [ Q C Q
DY@@?>=<;:9751/+)&$ $
+>32 #'.<54>54.#"#"'4632#"&!!7!!3<G*6]E'!1;3$
A!1:1! /?#.B.{,! ,, !,����]#[��n$ ;S47O;-('rT .)*4C.$8' �� .. ..��y$? �����
)@& h C S D
+#>74>32 #"&�F
>F�!""'5���-PS\88\SP-<��""!5 ��t�
,@) B k D
$+#"&'7!#"&'7e$
&]$
&��ܚ�$�ܚ�$ P r� : > yK�)PX@(
Y C Q
C
D@&
Z
Y C
DY@ >=<; : :5320-,'%#"!#!+#"&547!+#"546?3#76;>;!323+32 %!!�' ��Ԇ)��ۂ�
)։(�+�) �� ��� ��,�����E
��l� �% ��D�
�m$�y E� r��B[ 9 D O �@!
*BK� PX@2 j
h
f _
SC S D@1 j
h
f k
SC S DY@LKA@# $#$ +.'7632 .54>?>; #".' +4.'> ေ> "/AU8o<rY6=r�g
#"d�7 #;XAc@|c=D~�p$
#�-Lb6kY�b4��'DX2`TV,bP&!(#�/HhLN�pE��J@!!)%��0GhN\�N� �:P9)��>c��6M9*,6Tl }��8� ' 0 D X uK�PX@+ [ [ SC
C S D@/ [ [ C S C
C S DY@
US((%"&((($
+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>�7Zt>3W?#4XvA3V?$J.>$0XC'-?$0WC(XA��B�7Zt>3W>#4XuA3V?$J.=$0XC(.?$0WB(qg�h4&ImGg�i5&JmI<W9 )W�]<V8(V�b
���g�h5&JlGg�i5&KmH<W9)W�];V8(V� M���� ? O T@QK8J)#Bh S C S
C S D FD/-&$
?? +2 "#"'.#">7>;#"&/#".54>7.54> 32>7�>hJ)40K6=eI(>;a2A
<TD�M�/lz�GG|\6:c�M106b��0.J_2>si^(��GrP,�)Kh? E:%,Mi>E�I�NH�G ^�[�� �3V>#-U|NR�y\ F�FP�d8��BeD"!:P/� Viz ��e�
@ B k D
$+#"&'7e$
&��ܚ�$ ���H� � (+ .54>7�!2! ++<'
4UxR& S~T+�O���H X���PV�����r w�� ���� � (+4.'&546? '&547>\!1! ++<'
4UxR& S~T++O���H Y���PV�����r w�� ���� ; *@'40/+'&"
B ja ; ; +7>7'7>7./7 .5<?3>? '.' x
��
� � 2
��� �
��n+n n,n �� n,n
n+n
� � �3� .@+ j k M R F +!!#!7!�7��O7L8�Q �8��=G�;�G� ?� � � @ B ? S
D"+74632'.54>7#"&?0'+/(8" '$ %/U#2;0)URL %9J,2 c*x @ M Q E+!!n� �RxN :�� � � @ S D&$+74>32 #"&:!#7''5M""'55 ����� @ k D""++6; !&�''/�$ Z��`� ' ,@) S CS D '' +2 #".54>2>54.#" �\�r@b��y\�r@b��.c��Q5\}Gc��Q5]}�H�ّ���jH�ّ�G�j��_�)ʂ�z;_��Ƀ�{; � �� )@&B h C R
D$+%!7#"/3!!F��� �I�5�(H�E�� 'i��H F 5� 1 <@9- B h S C Q
D +)#!
11+2 >3!2!7>7>54.#"#"/>�K�c9;e�K� G#h �q
!K}Z2-Mf9Du_F.\~��*S}R[���D�8!5! �C{|�NCcA 'Ig?Z�b4 q��<� H U@RD
B h h [ S C S D B@:80/.-%# HH +2 #".'7632 32>54.#7>54.#"#"/>�K�`73XwCEgF#Q��ha�f< )
2OpNa�g6$V�m a�k8,Kd9Dv`F.[~��)OvLP~^?
7Oe:`�xD.\�Y
GhF"Ci�@7aG)B2X|L@_? 'Hg@Z�b4 > ^� +@(
B \ C
D!#+!+#!"&/367!Z�1T2�g;Tk �5b�2
�i�
-�� '�� g��8� - @@=+*B h [ Q C S D(#&(""+#!632 #".'7632 32>54.#"'!2 ����kg�g3[��m:hXI
-HgF[�yF(T�Xn�8�{_�$ 6a�P}NJJ#-' % =r�iBmN,%r ��� 3 2@/ B [ C S D 0.&$ +2 #".54>7>;> 32>54.#"�T�b6Q��oY�f7:Z>� Q�&>B���*PsJ^�p=,QtG_�o=M5`�Rl��J7h�\:qwH
��*K#?G�-DtU0=l�WFrP+Do� � �� $@!B Q C
D $'++>7!"&57� ��H.
��
�# ��
> f��&� % ; O D@A
B [ S C S D=<'& GE<O=O1/&;'; %% +".54>7.54>32 '2>54.#" 2>54.#" ^�m<6`�MmpBx�fW�_1)MpH<cG'N��eY�l==`u7,]ZQ=$.Ty�[�Y+%HjES�\2!Fk1ZNY�fA!�hT�l?3WuCDw`F5NiBf�q<J3_�SOkA"8PkE?fJ(�9]v>6]E'2XwE2^H+ � Z� 2 2@/ B [ S C
D /-%# +".54>32 +>74.#" 32>MP�^3O��iU�c5 :V7�H T� > B�V+NnBV�l=)MnD]�i8Z3\�Of�I8f�VDrosE��I&L)BH�CqQ-9g�VClK(Ai� :��Z� ;K�#PX@ S C S D@ [ S DY�&&&$+74>32 #"&4>32 #"&:!#7''5f!#7''5M""'55D""'55 <�e� ) K@
B ?K�#PX@ S C S
D@ [ S
DY@ (& "+74632'.54>7#"&4>32 #"&<0'+/(8" '$ %/o!#7''5U#2;0)URL %9J,2<""'55 � �5 �(+ � ��%( �B��A��
��
� �� c !@ Y M Q E+!!!!�; ��/:��+GG � �5 �(+ 767>7&'&5<>7��� L%( �����A
�~ ���� ' 9 5@2 B h f S C S D(&#, $+>32 #7>54.#"#"'4>32 #"& EQ\4=gK*1LYQ< @9NZL2 9M,>\@(
"!""'5
3'&Fa;SvXA<>(��,E>?PhH/K5 #*# �g""!5 a��2 W l f@c
^
?B h [
[ [ O S GYX b`XlYlOMCA=;86,*"
WW
+%"&5<7#".54>32 32>54.#" 3267632 #".54>32 %2>7.#" IG?�L-B*!>Zq�N1T! ';sZ7L��g\���a7V��z��_ o�����^<j���hpɘXDq��%!HHF p. ;l\K5 /�NH\S 9L,;|tfL,��=Z !* I��v|�|?7f���z��PD> JP[�����ǡq=I�҉�ՙTD?lT7%AXck4!9* �� X�
$@!B Z C
D# +!#"&'!+3!.'XLe���L�b�>E�
��b ��z�* � 5� * =@: B [ S C S
D *(" !+3!2 # !2654.#%!2>54&#!��yf�b/,QtI��C�s�JD��)OsJ��a�\,�����*OrHD|eI�yb�p<�����:]B$H:_zAw~ ����� / D@A
B h f S C S D '%" //+%2>32 #".546$32 #".#" �ItZA. #.ix�PzŋKp� �ItaQ& )N}`��aBv�E%+%*/K5 X�⊹3�y,B*( ,5,h���|NjJ � -� @ S C S
D!(!&+#!!2 4.#!!2>-1[���g�$��}ʍLg?u�h���x�ޢZ/}ڵ�b3�U�ދyH�c� � ?� (@% Y Q C Q
D+!!!!!!4�WG7 ��I� ��5��P��R� � ?� "@ Y Q C
D+!!!#!4�WJO ��Pd�5��S�u� ��� � 9 G@D$ B h [ S C S D 1/(& 99+%2>7#"504>7!#".546$32 #"'.#" �CobZ-0�k?5o}�R͐Mn��M~hV& '7Kb?��]Bz�A *� �
%:'Y�㊻3�w,@)' !h���|njK � !� @ Z C
D+!#!#3!3sdS��Sd�dR(Rd��Y��k� � �� @ C
D+!#3 d�d� ���� '@$ B h C S D#%$+#"&'7>32 32>73}Hn�W6Y+
#1#;lW=
xd�u�q76%W�i� � �� &@#
B \ C
D'(% +3267>; #"&'.+#3^M"(P Q�~ �P �* TTc�d�L ���X f �U� � X� @ C R
D+7!!3�h �6�cUU� � <� ! '@$ B h C
D!6(+ 67>;#>7+"'#32-
~E�W��� �n�W�D�� �
�y� �#� �F�� � !� @ B C
D!+2>73#"'#3b
��W�. �Q�W�1� �0 ��y�-�G� ���q� ' @ S C S D((($+#".546$32 4.#" 32>qm���|ȍLn��}ɍLg?v�g�ޣ\@v�g�ޢ[0����xY�≺3�xY��{ŋKh��{ŊKg� � ?� /@, [S C
D
!+#!2# 32>54&#GFc�T��J��v�T�^�k:��;�����l��H��S<j�V�� ���q� / T@
BK�PX@ S C S C D@ k S C S DY�((($&+#"&'#".546$32 4.#" 32>q5a�U#N
�|�|ȍLn��}ɍLg?v�g�ޣ\@v�g�ޢ[0�⼓1�{
C2Y�≺3�xY��{ŋKh��{ŊKg� � 3� ! 7@4 B [S C
D ! *!+#!2#"'.# 32>54&#POc�P��<n�^qU ��!%SM�_�j8�������\�sH ��@���4`�S�~ '���� = =@:= B h f S C S D;9(&! #!+#".#" #"&'7632 32>54.54>32� ";]FLwS,2QgmgQ2B{�m��<! !-@U8T�`32QglhQ1:m�ef�8�&-&1Uq@=S;+)1FdI`��LcV+#)#9d�N>S:((0GgKQ�sDKH � �� @ Q C
D +!#!7�
�8�c��6
�T��3T ���� #@ C S D +%2>73#".5473 o]�uL kdl]��sg�o:kdl-W�FH~�cl��u˖VG|�e,-l��(T�h;
� @ B C
D, +32 >7>;#O&
GN�:Y� �c00� �y � ~� ( @ # B C
D+; +32 >7>;2 >7>;#.'#�N ���
�M��Y� ��Y��h))� �h))� �y� �/ �� �� @
B C
D)"'!+ 32676; #"&'+��Y
-�c� �Y
��� b��
�� 4�r�� �p
� �� @ B C
D,"+#32 >7>;gIcI��X+ �SG��H? �d! � , �� $@! Q C Q
D +!!7>7!7��28 �A �� �! � R!
�R D��D� '@$ [ O QE !#+!+32D�&
�̼ ���# ��
q��H� @ k D" +32#"&'q'' �% �$�+ ��� '@$ B [ O Q E!#+!!7>;#"5�(���˻�
# v �� @ B k D+!+3#"&'&'+\;UC �
�F���
� �L ������1 @ M Q E +!7� �+�AA �~� @ k D +2 #"/�s5 ���� <��s� + ^@ BK�%PX@ S C S
D@ S C
CS DY@
#!++*' +!#"&5#".54>322>7&#"�.!&[gr=?^? ,Qp��R<h3��9odY#2;EC~o]D%[
9P�^41Z�PW��~\4��@u�d�-Pn��L�� f���� 0 h�"BK�%PX@ CS C SD@! CS C
C S DY@ (& 0 0 *%+33>32 #"&'#" 32>54&f�]a'`ju<AbB" ;Ul�HU�* 9sk]$#7?C#?mYE/f���O�\32[�PM���b9MLl�@t�d��'7"3Xu��A�� H��F� 2 5@2B h f S C S D%(#&*$+%#".54>32 #".#" 32>32 5_[^5VT*!>Xn�I1OB6
1N;T�k= AbC5TA1&
�;L,;j�VO��vV1#2 ! % Z��lEvV0")"
@���� . p@ " BK�%PX@ C S C S
D@! C S C
CS DY@ &$ . .
+!"&5#".54>323%2>7.#"�!'alv=AbB" ;Ul�IQ�,I\��I9rk]$#+�E?mYE/f
=Q�_42\�QL���b9GGK�Q@?t�c N@3Xt��@�� F��F� , = 7@42 B hS C S D.--=.=*&%,+32>32 #".54>32 %">54.F8`�Ќ��5UC3( 1]_f:S�X. ;Wp�OIe? ��P�cC��O,,G%)JB;1')��$($
4K07e�ZK��zZ4)=GgDq�Q%)036 1( B��� % ^�BK�!PX@ kS CQD@ k YS DY@ % %!$%$ ++'&546737>32#"&#"!2j*#�~�
:Wn? 8
(-Q?-
~���w ~U�V+
0 AhK{F ����� > T d �@<& CBBK� PX@+ [ [ C S C S D@. h [ [ S C S DY@VU^\UdVdQOGD7642*(
+ #".54>32.5467#".54>32! 4&'.#" 32>2>54&#"�(/(#*#@t�dO�_4K��b"D#")[69bG(1]�W3Z#
�l 1X)c�a1'Hf>N�[2�@eF$n]@dE$l�7ZKA>@$ 3016@'?uZ6 =X8HoL(4 #H3 $GgDE�h?
L��1F %?T.+C-*FZ
6Wo8hi3Tm9jn f �� ,@)B C S C
D %%+33>32#654&#"f�^\(akp9po
^KMS6pi^$A��KuQ*��2]��|.)fj7g�Z�� x �� &@# S CC
D
+##".54>32 Ny]y� � �W ! �m���� ( 4@1 B S CC S D %# !%%+#"&'7>323267#".54>32 J�(?W5 )JR
�� �4XA%
XQbW ! c �� 0@- B \C C
D %(%!+3267>; #"&'.+#rm%� R�9 lP ��$=]���� { �_
�
�
�
� u �� @ C
D +33u�]���Q ^ �� 5 Z@
BK�)PX@ S C
D@ CSC
DY@ 5 5%&($! +332>32>32#>54&#"#654&#"^x+# N�qdU']gl5k^
]K>M1eaW#C]K :Jr�I?�$�ꛫ~v"'PwO'�}
6_��| 7Z]-Z�\��|E6TW� ^ �� ! P@
BK�)PX@ S C
D@ C S C
DY@ ! !%&!+332>32#654&#"^x+" )cnt;op
^KMS8rk^$=�$��O}W-�� 2[��|.)ej9i�]�� G���� % ,@) S C SD %% +%2>54&#"".54>32 �W�f7�~:fVE/�wP�]3H��lP�]3I��>[��g��)Jex�F��K8j�`yߪe9i�^yޫf 2���� - m@ !BK�)PX@ S C S CD@! CS C S CDY@ %#- - *&!+32>32 #"&'" 32>54&2�+# 'amv=AbB" ;Ul�HQ�+;�9sj^$#,�E?mYE/f��F$��Q�_42[�PM���b9HF� ?t�d��O@3Xu��A�� <��s� . 6@3#B S CS C D &$ . .*) +#"&547#".54>322>?&#"�6O&Yeo<?^? ,Qp��R<h3��9mdX#4;EC~o]D%[��sM}Z11Z�PW��~\4��?t�c�-Pn��L�� ^ �� ,@)
B S C
D #$!+332>32&#"^x+# D�c)+.(k�=<�$�أ�Y�� !���� < =@:< B h f S C S D:8'%" #!+#".#" #"&'7>32 32>54.54>32�
2J73[C'&?OTO?&3^�Ra�/
5R>;aE&&>PSP>&2Z|JT|0i "9K*)8) %4K5@x]8C6" ' 'DY2,<+ #2H4:kS144 l���@ + g@
&BK�!PX@# j h Q C S D@! j h \ S DY@ %#(&&+74>7#"5?>;!!32>32 #"&�D��B
./ ��E=0!3&(r9R]�$9,5) d ��G��)4!A:**3Z r���� " P@
BK�%PX@C T
D@C
C T DY@ " "'!%+32>73#"&5#"&54>7!KMS7pj^$@^x, )cmt:oo
�/(fk8i�\� O|U-�� 3Z�� S �� @ B C
D+ +32 67>;#SI�
� G�N� ��,*0
� V x� ) @ # B C
D(!+: +32 >76;2 >7>;#"'&5+VC� V$�
F B�VD� ��B���))��**
� (�� �� V� @ B C
D("(!+3267>; #"&'+s�P
� T��P
� �� P��r q �0�� � �Q V���� @
BC D,"!++32 >7>;�C��J
�
� I�� ��
��
<� @ Q C Q
D+!!7>7!7!6�a/ �^
���
����K& MK G��F� D 7@4" 5B [ [ O S G<:303)+4𑯎&54>;+" ;20#".54>�D9J\+NoE3 :P1 '?.* ")"'8# 38U: #*#�9I;tw<�<U�_3( 3Vn:B�>-TF3
)5 =vw{A)B0
%BY4D{ut ��� @ Q D+3#�KK� ��� D 7@45" B [ [ O S G<:303)+3"+7>;2>54&54>7.54>54.+"&504>732 �D9J\+NoE3 :P1 '>/* ")"'9" 37V: #*#9I;tw<�<U�_3( 3Vm;B�>-TF3
(6 =vw{A(C0
%BY4D{ut P��� 9@6 j k [ O S G
+2>53#".#"#4>32 �%=*N <X83kib+&;*M <W84khb70B'7^F('0'0B'7^F('0' �����
)@& h S CD
+>734632 #"&�D
) C 5'#7''5��&-PS\88\SP-���'7#'55 ��� / : K@H%B j h f k S C S D##'# +.54>?>; #".'>32 + V�b4L�ˀ#
#)V�.
4N8�KlI* J]l:$
#�)LmE�i�r= @o�`�לX� �;- ��"' 1%�
�Q�]7lJ�� i� = C@@+
B h [ S C S
D%&%##(" +#!>3!#!7>7#7>;>32 #"'.#"!a�%'#/ )�5$=/ *��$ Lz�fPuQ4( &;XAN�`= $�� ��,F9/'@
#4I5W% )]�uC%?V0 <.4_�O��$ � �D # 7 9@6! B
@ ? W S D42*( (+467'7>327 '#"&''7.7 32>54.#"(#�2�-n?>n-�1�%))#�1�-n?>m,�1�$)H+Ib89cJ++Jc98bI+�>m-�2�%*)$�2�-n?>m-�2�$)($�2�-m?8bI++Ib88cJ++Jc � �� ! 8@5 B
Z Y C
D! +! +!32 >7>;!!!!#!7!7!�[��M
�N��[��o��/]/��n��h �d##� ��9v8��8v ��� @ Y Q D+3#3#�KKKK���� X�}b� E Y A@>E WM: #B h f W S DCA,*'%! #!+#".#" #"&'7632 32>54.5467.54>32 >54.'K 1I76[B%(BUXUB(^](22]�Ta�0
4P>>bD$Im�mIdq*42Z}LS{0��!8IPR$NC 2CJL#`M
#:N*)>3,-3AR7^�&"U;Dy\5B6" % 'CY2=S@:GaGU�)!V>;lR145��&<2+(+&kE(?3*&&+g v�qm % 3K�'PX@
S D@ O S GY�&(($+#".54>32 #".54632
V
0"
"1
k��� / K a �@
BK�PX@4 h f [ [ S C S DK�PX@4 h f [ [ S C S D@4 h f [ [ S C S DYY@
^\*,*(#&(%"
+>32 #".54>32 #".#" 32>4>32 #".7 32>54.#"Y";�t`�s@Cw�c4WJA !;[DS�a55_�L<V?-�%4^���dc���^44^���cc���^4<g��\��yW/h���g�#;FAv�fd�wB )! 5b�WZ�a3 ,c���^44^���cd���^44^���d��h/Wy��]��ii�� �>d� 0 : L@I!B h [ W S D21 651:2:%# 00
+"&=#".54>7>454#"#"&/>32 '26? 4cB 2&)[�go'8)
1i?*>) �=[+��9G D.1 1!*H7! w/- 1A$ 4Y�a*5)�KB.) � ��� % �%(+77�
� � =
� � z
���� { z
���� �T�� =K� PX@ _ M Q E@ k M Q EY�+!#!�<.O$���' c*x @ M Q E+!!n� �RxN q��� 1 G P ��<BK�PX@/h [
[ S C S DK�PX@/h [
[ S C S D@/h [
[ S C S DYY@22PNJH2G2F)!**,& +4>32 #".7 32>54.#"#32 #"'.#'32654&+q4^���dd���^44^���cc���^4<g��\��yW/h���g�U����v
O �� n�ywkw��c���^44^���cd���^44^���d��h/Wy��]��ii��yusvd�
��_
@a[\T r�q$ @ M Q E+!!y�� $@ �D�� ' @ W S D((($+4>32 #".7 32>54.#"�0Qm>?nQ//Qn?>mQ0E$>U00T=$$=T00U>$n>mQ..Qm>>lQ//Ql>0T>$$>T00T?$$?T < P8 <@9 j h Z M Q E
+!!#!7!!!�2� �O1L1�S�2����V�jG�l�G��G ���V / g@
- BK�!PX@ h [ S D@! h [ O Q EY@ +)%#
//+2 >3!2!767%>54.#"#"/>�(E3 3C%�(�'
"=,#/9Z $�V,?*-LD?!�� ;>@$ - B= `e �|�V > �@:BK�PX@, h h [ [ S D@1 h h [ [ O S GY@ 8631+*)( >> +2 #".'7632 32>54.#7>54.#"#"/>�(D2 UE@A+H^3<N1
9.,E/+D0ae".?T $ 1BPV)<&K_K95U>! 3C$
(' 0; -!2RH + B;0I2 �T� @ kD "++7>3T�7�
��� ���� $ 7@4 #BC S
C D $ $&(!&+32673#"50>7#"&'#"&5RcjX�H][z3K�]Xn(.��cmybX� ;3X[JD*R#�� y�B4� *@' hi S D +##!#".54>34 �U����Vm\�h8E��n�R�
�
y-SwKV�i; ���� @ O S G($+4>32 #".�$& &$P& &%% ��T V@
BK� PX@ ^ j T D@ j j T DY@ +2 32654.'73 #"&'764#3:(8"8:'JN 2E(&D
��
2* �a73!5% ��lQ N� BK�PX@ j j Q D@ j j M R FY�$+37#"/733!��C�
�9R����% ��h5 �;�� # )@& W S D ## +2 #".54>2>54&#"�7U; +OpE8V; +Oq7T8 RR:U8R�$C]9O�[2$B]9O�\2��*MlBYk+NlAYj ��� % �# (+7'&54767&'&54?'&54767&'&54?� � � � � � ��
' '
�� ��
' '
�� � `� ( . Q@N" B h h
Z \ C
D.-('&%$#%"#!"
+%3+#7!"5'3+6;37#"/733!>7!�n=���A�� &�$(���C� �9R������ �'��"�U d#�k%w
��h5t �| � H� 9 J b@_D=7 B h h
Z [ C T
D
JIHGFEB@;:52/- 9
9""
+%+6;2 >3!2 !7>7%>54.#"#*/>%37#"/733!w &�$(y(E3 3C%�(�'
"=,#/>X ����C� �9R��� d#�K,?*-LD?!� � ;>@$ - F9`e %w
��h5 � r� Y _ y@vU
! .
B
h
h
h [
[ \
S C
D_^SPMKEDCB:820*(YY"#!#+%3+#7!"5'3+6;%2 #".'7632 32>54.#7>54.#"#*/>>7!� n=���A�� &�$(��(D2 UE@A+H^3<N1 "6*,E/+D0ae".?V 1BP+�� �'��"�U d#)<&K_K95U>! 3C$
-% 0; -!2RH + E80I2�� �| ��;� ( : 5@2 B h f S C S D('#, $+#".54>?3 32>324>32 #"&; DP\4;gL+1KZP; >6MXK1!8K)=]B'�!""'5�3'%Db>RtS=68%��+?99KeG0L5$*$P""!5 ���� X�& $ @ ���� X�& $ H ���� X�& $
@ ���� X�& $ @ ���� X�& $
@ ���� X�& $ @ �� �� :@7 B Y Y Q C S
D# +!!!!!!+!!��6 ��W �X���Mwz���
5��P��R��b ��z5+ ����� L h@e 9?
J B h f
h S C SC S D HF>=750.&$! LL +2 32654.'7.546$32 #".#" 32>32 #"&'76#3:(8"/r��Fp� �ItaQ& )N}`��aBv�bItZA. #-ds�L JN 2E(&D
��
2* r^�܅�3�y,B*( ,5,h���|NjJ%+%*-I5 L73!5% �� � ?�& ( G �� � ?�& ( G �� � ?�& (
G �� � ?�& (
G �� � ��& , �� � ��& , �� � ��& ,
�� � ��& ,
E `� ! ,@) Y S C S
D!%(!+3!2 #!#%4.#!!!!2>M�R�}ɍLl�����$T��?u�g��Hs��Jx�ݡZ��U�މ����r�yH��>��c��� � !�& 1 � �� ���q�& 2 � �� ���q�& 2 � �� ���q�& 2
� �� ���q�& 2 � �� ���q�& 2
� � �)C � (+ ' 7 )�cF6���Z,���9C�
����3u��3wp4��p O���� ! - 9 b@
21&% BK�PX@ k C S C S D@ j k S C S DY�**%(%$+#"&'+7.546$327>; .#"%4&' 32>qm���h�C�")�JNn��m�Ez
4�DH�w:6%:�`�ޣ\"40��9�Z�ޢ[0����x>9��Q卺3�xE?� �Q��v�E�<@h��(o�E�67g��� ����& 8 � �� ����& 8 � �� ����& 8
� �� ����& 8
� �� � ��& < & � Y� ,@) \ [ C
D"& +32+#3 32>54&#����J��u�#c�d-T�^�k:��i��l��H������T<j�V�� ;��� P �@
JBK� PX@- h k S C Q C S D@+ h k [ S C S DY@ LKIGFD<:$" PP +2 #"&'7632 32>54.54>54.#"+'&573>�InJ%4MZM4.EQE.6_�M]~0 3L::^B$/HRH/5O]O54T=A{cE p*#���W|��-I\.FdL<:A+)3'&7TBL\3C6! % (E]58F0#-B58RC=GZ? D9&Bv�^�z�v (_��K�� <��s�& D CT �� <����& D v- �� <��s�& D � �� <���h& D � �� <���m& D j �� <��s�& D �2 2��j� G W d �@?E!BK�)PX@5 h h
[ S C SD@? h h
[ S C SC SDY@&YX ^]XdYdSQIHCA=;860/'%
GG+2 32>32 #"&'#".54>?>54&#"#"/>32> 32>7">54&Z7]D&>���y5UD3( 0\`g:t� [jo08]C%F�� \[BaF. Q�crt 9�����=0B'=oY<
�GtY;
��{4b� ;Q0:hN0))��$($
3K1��MjA 8W<K}[6U#in(/( NPxkjx�'Eb?.B+-U|P+6c�V'<N-HQ H��F� N h@e ;A
L B h f
h S C SC S D JH@?9720(&#! NN +2 32654.'7.54>32 #".#" 32>32 #"&'76#3:(8"1OtM&!>Xn�I1OB6
1N;T�k= AbC5TA1&
2XVV/ JN 2E(&D
��
2* u?i�SO��vV1#2 ! % Z��lEvV0")"
7I,P73!5% �� F��F�& H C � �� F��F�& H v � �� F��F�& H � � �� F��Qm& H j � �� a `�& � C� �� x '�& � v� �� B %�& � �� �� I Dm& � j� I���y 7 I 5@20B76
@ [ S D98A?8I9I,*" +&54?.'&54? 7 #".54>32 4654&'267.#" ��3vD
Q�C�
�+H4 @��~L�^5Ay�i1`TE\U�I��! +GeDZ�`2*Hc. y#0 =3�
o(f~�Y����n9h�[m��U9X=��K��,��3dO1H|�^M{V.�� ^ �j& Q � ���++ �� G����& R C � ���++ �� G����& R v � ���++ �� G����& R � � ���++ �� G���j& R � � ���++ �� G���o& R j � ���++ � �3^ # +@( [ Y O S G&&&%+!!4>32#"&4>32#"&���U� %$. &$,X %$. %#-�G{& 1#%/�Y& 1#%/ ��� * 5 u@
43$#BK�PX@! k C S C S D@! j k S C S DY@,+ +5,5'% +"'+7.54>327>; &#"2>54&'��YF
!&+-H��lDq-= 2u),I����7GnW�h9W�g9��G
K`�5�[yߪe(&S�5�Xyޫf��W�GY��AZ��kBn*�GB �� r����& X C � ���++ �� r����& X v � ���++ �� r����& X � � ���++ �� r���o& X j � ���++ �� V����& \ v � ���++ ;���� 0 ?@<"B CS C S CD (& 0 0 *%+3>32 #"&'#" 32>54&;�]b'`kt<AbB" ;Ul�HQ�+6$9sk]$#7>C#?mYF/g����N�\32[�PM���b9HG�E@u�d��'6"3Xu��A���� V���o& \ j � ���++ ����� ' 0 L@I-BA h Z C
C S D )($" ''+2 #"&54>7.'!+332>!.'�
Q+BK*6 e���L�bg7. 3*$��E� �! B:">6. ��b ��y $0<")0
��+, <��s� 4 F �K�%PX@&;B@&;BYK�%PX@* h S C SC S D@. h S C
C S C S DY@65 ><5F6F1/('$" 44
+2 #"&54>7.5#".54>32#32>2>7&#",
Q+BK-8 !&[gr=?^? ,Qp��R<h3u3+ 3*$�09odY#2;EC~o]D%[�! B:#@7/
4P�^41Z�PW��~\4�? $0<")0
6@u�d�-Pn��L�� �� ����� & & � �� H��F�& F v � ���++ ���?� ' T@Q B
h Y Q C Q
C S D $" '' +2 #"&54>7!!!!!!#32>X
Q+BK*6 ��� �WG7 ��I� p3+ 3*$�! B:">6.�R��P��R $0<")0
F��F� L ] e@bR9@?B h h
S C SC S DNM M]N]IG>=750. LL +2 #"&54>7"#".54>32 32>32 732>">54.C
Q+BK$/ S�X. ;Wp�OIe? 8`�Ќ��5UC3( /XZ_6)-3+ 3*$P�cC��O,,G�! B: 93-7e�ZK��zZ4)=G )JB;1')��$($
1H0
$0<")0
�Dq�Q%)036 1( x N� @C
D +#Ny]y� � 0 �� !@ B C R
D+%!!7>?3g� �~Dh �6H�
�[c��=
��UMf@
^� S 8� @ B C
D+46?37#S �L]H� �_\Z��
Tv��W2 V���V �� � !�& 1 � �� ^ ��& Q v ���++ ��� � 46@
BK�PX@* Y S C Q
C S
DK�PX@4 Y S C Q
C S
C S
DK�#PX@* Y S C Q
C S
DK�%PX@4 Y S C Q
C S
C S
D@2 Y S C Q
C Q
C S DYYYY@ 1/'% (% +!!!!!#".54>32 4.#" 32> �ZG2 ��H� �'+q��Vo�}Ce��W�rQ,]7g�]w̕U8h�\x̔T�R��P��R>N{U-W�އ�6�z5a�Vg��xKk��xIj� 6���� 8 N ] S@PT6$ B h S C
SDPO:9 O]P]FD9N:N42*(" 88 +2 32>32 #"&'#".54>32>2>54.#" ">54.�=aD#8^�ƃ�y5UD3( 0\`g:y� Ui~GOtK$M��ix�:�8GrW>( :W;Z�h88Z~H{_? ��{-0J� 9O0%F@80' ��$($
3K1��EnL):aE���Z�uv��I2Vs��?CoO+T�ۈ6fP0q:k�_:EN' 6) �� '����& 6 �� !����& V v � ���++ �� '����& 6
�� !����& V � � ���++ �� � ��& <
& �� , ��& = F �� <�& ] v � ���++ �� , ��& = F �� <�& ] � � ���++ �� , ��& = F �� <�& ] � � ���++ ��U� %SK�PX@ Y S C S DK�PX@ Y S C S DK�PX@ Y S C S DK�PX@ Y S C S DK�PX@ Y S C S DK�PX@ Y S C S DK�PX@ Y S C S D@ Y S C S DYYYYYYY@ % %"" +#763>7'&546737>3#"!��Vw�W%3eWE���//�"5dWE1f ��b�\+/ FqS
���1 FqR�E o�R�
@ B k D' +#"/+73R= { �A�S� � �� ��r�
@ B k D' +32 ?6;#�A { � ?�S�� � � �� r�q$ q ��a� @ W D +".5473 32>73e5K.C 3&,?+C#=Y� 5H* 4% 3B&2ZD' 2��� @ S D($+#".54>32 � F !! �s � =K�'PX@ W S D@ [ O S GY�$&($+4>32 #".732654&#"�/?##?/ /?##?/:@32@@23@$<++<$$;,,;$2@@22@@ 7��\
+@(B @ j S D +2 #"&54>732>F
Q+BK 1> -3+ 3*$�! B:%C:/
$0<")0
|�nh QK� PX@ W S D@ [ O S GY@
+2673#".#"#>32 �(.9(6 1-+&0:)5 2,*�7/$>.!(!:-$?-!'! ���� #@ S D
#++7>3!+7>3�� )� =�-�
�� ��� ��Y� \�BK�1PX@ SCS
D@ SC
CS DY@ !$## ++#!#"&'7632327#7>3Y�q]q�VVsb 0 �V��$�d��;ns &
��!
� ld @ M Q E+!!���+dE � Bd @ M Q E+!!�� �VdE �#�� � (+&5467�\H):#7;X�B
1v?/* �\� � (+'&5467>54&'&547E\H*8
�7;X�A 1v?,
� � � � (+7'&5467>54&'&547�\H*8
�7;X�A 1v?, �#�� ) � (+&5467&5467�\H):�\H):#7;X�B
1v?/*7;X�B
1v?/* �e� + � (+'&5467>54&'&547%'&5467>54&'&547T\H*8
8\H*8
�7;X�A 1v?,7;X�A 1v?, ��� � + � (+7'&5467>54&'&547%'&5467>54&'&547|\H*8
8\H*8
�7;X�A 1v?,7;X�A 1v?, ���� " YK�PX@# C S CSC D@ O C S C DY@
$!#"+>3 >32>72! #"'!�F�K/ GL�F��=O
h=�����&
�� �� f���� 6 ��*
BK�PX@6 `
[ C SC SC
D@1 ` O
[ C SC
DY@ 6 61.,+)'$##!##+%!7>3 >32>72!!#.'#"'"&5467�X��F�K/ GL�F��Z_F�K,
G&OOM$�� ��&
�+ �' �
91�| @ O S G($+4>32 #".9.Pi<=lP..Pl=<iP.T=lQ..Ql=<iP..Pi :��� � ! 1 @ SD&&(&&$+74>32 #"&%4>32 #"&%4>32 #"&:!#7''5�!""'5�!#7''5M""'55'""!5'""'55 }���� ' 0 D X l � �K�PX@/ [ [ SC
C
S
D@3 [ [ C S C
C
S
DY@}{sqig_]US((%"&((($+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>%#".54>32 4.#" 32>�7Zt>3W?#4XvA3V?$J.>$0XC'-?$0WC(XA��B�7Zt>3W>#4XuA3V?$J.=$0XC(.?$0WB(�6Zt?3W>#4XuA3V?$J.=$0WC'->$0WC'qg�h4&ImGg�i5&JmI<W9 )W�]<V8(V�b
���g�h5&JlGg�i5&KmH<W9)W�];V8(V�]g�h5&JlGg�i5&KmH<W9)W�];V8(V� � ��� �(+7�
� � z
���� ��� � (+7'&54767&'&54?� � � ��
' '
�� � �� @ C
D""+'+6;� &�$( d# )���� J [@X 9 B h h
[ [ S C
S
DJIFEDC?=75$##%'$+3>32 #".#"!#!!#! 32>32 #".5#73>7#L� q��r@jWI % ,@W:_��`e�� � 4a�Y>cM:) )^l|Fn�u<���^�ғN,A*$ $ @}�u *X0 z��C%+% !.K5 Q�ه9/Y* �H� & 9@6B hi S D & &!4)
+ >7>;#7+"'#32'###7��
6E<6 �
�7<F7
��?E?�
n���'��|)�B?
:��: ( ;� : 3@0 B S CS
D : :***+!>54.#" !"504>7!7.54>32 !�,d�yDCv�]p˛[0Y|L+�3 �N�]4l��rÍPK��g �hY��yj�n7I�V�hF��
�Rw�\��YF��v}͛h�3 W���� / A C@@ 5"B h [ S CS D10;90A1A#)**$+>32 #".54>32 >54&#"#"'2>7.#"�%BBD&EjH& k�ԂClM)&Eaw�K1WG4ol-G6%
NK�v_!7V?f�r=t=# 5d�^AI����,SvKR��tT/7T:N�V���&F��x4dN0`��`y� �� i� @ B C R
D+)3!.'i�j�Y�j�������%& ���w� $@! Q CD +##!##7w ��_���_�� �P�i��i�P ��� *@' B Q C Q D +!!!767 &5467 �I��R�
�����R����R$2-
�{�� @ M Q E+!!�< ���G E S� "@ B j [
D+%!+!##"&5467!2 67>;RM��9�
� 7� ��)#(� L�� ' ; O L@IK-B[
O
S G=<)( GE<O=O31(;); '' +".'#".54>32 >32 %2>7.#" !2>54.#" �3O?3"HPX30T>$3Un<3O?3"GPX31U?$2Up��(IDA -4@(-P=$-<m0Q;"-<$(ICA!,5?'BV..VB'$C`<N�_5'BV..VB'$C`<L�`7N&?T--T@&'Ge=.F0*Id:-F0&@S--T@& �e���� ' *@' B S CS D!%'U$+>32#"&#"#"&'7>3232>7�EZl;$4
`�"�Kas@ ;
6[J7>W�U+
,
����d�Z) ' GrQ ���� 7 d@a !0"/B [ [ [ O S G 42+)&$ 7 7
+2>7#".#"'>32 2>7#".#"'>32 43-% #i83a]\.3,% #h<4a][2-& #h84a]\/3,$ $h<5a]Z( 8+.$,$ 6-/$,$�� 8*/$,$ 6-0%+% � � p kK� PX@) ^ _ ZMQE@' j k ZMQEY@
+!3!!!!#!7!7!��F��͇� �F�E���Z��>c
��G�G��G� g P�O @ @ M Q E+ !!���&)$�@A�
��v> �� ��
x��I u P�Q @ @ M Q E+%!7!7>767.'&5<>7c� �A��G&)$���PI��>
�� ��f� "@
B M Q E+3 # >7 .'��B��nB��L M�� �@����@�S �� ��� ~� @ ja +3v�� �0 @�T� % k@ BK�!PX@" kS C Q C
D@ k [S C
DY@ !&%$ +!#!+'&5737>32 #"&#"8 w^n�Fl*"�~� Dl�X%$
,"���<}���v *U\�e6. �� @��� $ �@
BK�!PX@$ kSC
QC
DK�%PX@" k
[SC
DK�)PX@& k
[ CS C
D@- h k
[ C S C
DYYY@ $ $!!%$ ++'&5737>32;#.#"!3l*"�~� Bj�YE�94�]�/h0EqU7 ~���v *BX�m>
�nL /X~NBF S�� ��� -K�1PX@ j D@
j aY@ +#�n;N[�� {�� @ j a +2 #"&/� �I ��
�� �6�� @ O S G$$$"+#"&54632#"&546324/ .. /O. -- .� ,, -- ,, -- �6�p @ M Q E+!!� ��p: ,�� @ j a #++7>3��� I����
��� @ B j a+ +#"&/.'+73�G��G�W��� ��� @ B j a+ +32 6?>;#�G��G�W���� ���� (@%j O S G
+"&547332673�gc>DNXU?
{�XT9AQHcr @8�� @ O S G($+#".54>32 � � ��1� !@ [ O S G$&($+4>32 #".732654&#"�-<"">-->""<-5?32@@23?^";**;"#:**:#2@@22@@ ��� 1@. [ O S G
+2673#".#"#>32 &/4&4 3/-&/7'4 4.-O7+"<, & 9*"<, % � � +@( O S G
#++7>3!+7>3� -�Z�3������ ��� @ k D +2+� $ U�
!;XB
- ��M�_<� � ʓ^p �ӡ� � � ��V � �� � � / � T �� �� P� r� }� M� �( �( � �� �� ?d c� :���� Z� �� F� q� >� g� � �� f� �� :� <+ �� �+ �� � a���� �� �v �? � �` �p �& �B � �� �� �n �� �F �� �� �� '5 �E �� �T��S �� ,( D� q( ��� � <� f] H� @ F8 Bq�� f� x��mx c� u ^ ^� G� 2� <� ^ !� l� r� SS VV��� VF ( GX �( � P� T �� �� � �� �X �� X vM kk �2 �� �d cM q r� �� <� �� � � � y � � �� �2 � �� �� �������������������������� �? �? �? �? �& �& �& �& �� En �� �� �� �� �� �� �� OE �E �E �E �S �F � ;� <� <� <� <� <� <� 2] H F F F F� a� x� B� I� I ^� G� G� G� G� G� �� � r� r� r� r� V� ;� V���� < �] H? � F� x� 02 Sn � ^ �� 6� ' !� ' !S �� ,F � ,F � ,F � o � r � 2 � 7 | �<��� �� �n �n ��
g �g �g��, �, f�9` : }E �E � � )! �l (+ W���T ���� �b E� L�e� �� �+ g+ u� � ��� @ @ S { � � , � � � @ � � � g� P` � �[ �j �y �j �[ $�[ 9 > : A < / ? > D�� F�� G�� H�� R�� T�� m�y o�y y�y }�y ��[ ��[ ��[ ��[ ��[ ��[ ��[ � / ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �[ �� �� �� �� � / �y �y �j �j �y �j �y �y ��[
�[
�j
�y
�j
�[
$�[
9 >
: A
< /
? >
D��
F��
G��
H��
R��
T��
m�y
o�y
y�y
}�y
��[
��[
��[
��[
��[
��[
��[
� /
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�[
��
��
��
��
� /
�y
�y
�j
�j
�y
�j
�y
�y
��[ #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� ��
�[
�j
�y
�j
�[
$�[
9 >
: A
< /
? >
D��
F��
G��
H��
R��
T��
m�y
o�y
y�y
}�y
��[
��[
��[
��[
��[
��[
��[
� /
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�[
��
��
��
��
� /
�y
�y
�j
�j
�y
�j
�y
�y
��[ �=
�=
�= �I #�� &�� *�� 2�� 4�� 7�A 9�= :�m <�d ?�= Y�~ Z�� \�� k�� l�= m�I o�I p�� r�= y�I |�= }�I ��� ��� ��� ��� ��� ��� ��� ��d ��~ ��~ �� �� �d �I �I �= �= �= �= �I �I �I �y ��
�y
�y �j �j �� $�� 7�G 9�� ;�� <�Q =�� ?�� l�y r�y |�y ��� ��� ��� ��� ��� ��� ��� ��Q �� �Q �� �� �� �y �y �j �y �y �j �j ��� �=
�=
�= �I #�� &�� *�� 2�� 4�� 7�A 9�= :�m <�d ?�= Y�~ Z�� \�� k�� l�= m�I o�I p�� r�= y�I |�= }�I ��� ��� ��� ��� ��� ��� ��� ��d ��~ ��~ �� �� �d �I �I �= �= �= �= �I �I �I > ��
>
> �G �� �G �� �� �� " F #�� $�� &�� *�� -�o 2�� 4�� D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� V�� X�� Y�� Z�� \�� ]�� k�� l > m�� o�� p�� r > t P u P w�� y�� { P | > }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� �� �� � � � > � > �G � > � > �G � �G � � ��� # �� # �� #
�� # �� #
�� # �� # $�� # 7�� # 9�� # ;�� # <�� # =�� # ?�� # @�� # `�� # l�� # r�� # |�� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # �� # �� # �� # �� # �� # �� # �� # �� # �� # ��� $ �V $
�V $
�V $ �� $ #�� $ &�� $ *�� $ - 2 $ 2�� $ 4�� $ 7�� $ 8�� $ 9�� $ :�� $ <�y $ ?�� $ W�� $ Y�� $ Z�� $ \�� $ k�� $ l�V $ m�� $ o�� $ p�� $ r�V $ t�` $ u�` $ y�� $ {�` $ |�V $ }�� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��y $ ��� $ ��� $ �� $ �� $ �y $ �� $ �� $ �V $ �V $ �V $ �V $ �� $ �� $ �� & �o & m�o & o�o & y�o & }�o & �o & �o & �o & �o & �o ' �� ' �� '
�� ' �� '
�� ' �� ' $�� ' 7�� ' 9�� ' ;�� ' <�� ' =�� ' ?�� ' @�� ' `�� ' l�� ' r�� ' |�� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' ��� ) �� ) �L ) �L ) �� ) �� ) �� ) " ) $�� ) -�. ) D�� ) F�� ) G�� ) H�� ) P�� ) Q�� ) R�� ) S�� ) T�� ) U�� ) X�� ) w�� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) �� ) �� ) �� ) �� ) �� ) �� ) �L ) �L ) �L ) ��� - �� - �� - $�� - ��� - ��� - ��� - ��� - ��� - ��� - ��� - �� - ��� . .
.
. �� . #�� . &�� . *�� . 2�� . 4�� . I�� . W�� . Y�� . Z�� . \�� . k�� . l . m�� . o�� . p�� . r . y�� . | . }�� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . �� . �� . � . � . � . � . � . � . � . � . � / �� /
�� /
�� / �$ / #�� / &�� / *�� / 2�� / 4�� / 7�8 / 9�V / :�y / <�= / ?�V / Y�z / Z�� / \�z / k�� / l�� / m�$ / o�$ / p�� / r�� / t�= / u�= / y�$ / {�= / |�� / }�$ / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��= / ��z / ��z / �� / �� / �= / �$ / �$ / �� / �� / �� / �� / �$ / �$ / �$ 2 �� 2 �� 2
�� 2 �� 2
�� 2 �� 2 $�� 2 7�� 2 9�� 2 ;�� 2 <�� 2 =�� 2 ?�� 2 @�� 2 `�� 2 l�� 2 r�� 2 |�� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 ��� 3 �� 3 �= 3 �= 3 �� 3 $�� 3 -�V 3 D�� 3 F�� 3 G�� 3 H�� 3 R�� 3 T�� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 �� 3 �� 3 �� 3 �� 3 �� 3 �= 3 �= 3 �= 3 ��� 4 �� 4 �� 4
�� 4 �� 4
�� 4 �� 4 $�� 4 7�� 4 9�� 4 ;�� 4 <�� 4 =�� 4 ?�� 4 @�� 4 `�� 4 l�� 4 r�� 4 |�� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 ��� 5 #�� 5 &�� 5 *�� 5 2�� 5 4�� 5 7�� 5 8�� 5 k�� 5 p�� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 �� 5 �� 7 �� 7 �L 7 �L 7 �L 7 �� 7 �] 7 �] 7 " - 7 #�� 7 $�� 7 &�� 7 *�� 7 -�8 7 2�� 7 4�� 7 D�) 7 F�) 7 G�) 7 H�) 7 J�A 7 P�] 7 Q�] 7 R�) 7 S�] 7 T�) 7 U�] 7 V�F 7 X�] 7 Y�Q 7 Z�y 7 [�b 7 \�L 7 ]�e 7 k�� 7 m�L 7 o�L 7 p�� 7 w�] 7 y�L 7 }�L 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��] 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��] 7 ��] 7 ��] 7 ��] 7 ��Q 7 ��Q 7 �� 7 �) 7 �� 7 �) 7 �) 7 �] 7 �� 7 �) 7 �F 7 �F 7 �e 7 �e 7 �e 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 ��� 8 �� 8 �� 8 $�� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 �� 8 ��� 9 > 9 �� 9
> 9
> 9 �G 9 �� 9 �G 9 �� 9 �� 9 �� 9 " F 9 #�� 9 $�� 9 &�� 9 *�� 9 -�o 9 2�� 9 4�� 9 D�� 9 F�� 9 G�� 9 H�� 9 P�� 9 Q�� 9 R�� 9 S�� 9 T�� 9 U�� 9 V�� 9 X�� 9 Y�� 9 Z�� 9 \�� 9 ]�� 9 k�� 9 l > 9 m�� 9 o�� 9 p�� 9 r > 9 t P 9 u P 9 w�� 9 y�� 9 { P 9 | > 9 }�� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 � 9 � 9 � > 9 � > 9 �G 9 � > 9 � > 9 �G 9 � 9 �G 9 � 9 � 9 ��� : F : �� :
F :
F : �� : �� : �� : �� : �� : $�� : -�� : D�� : F�� : G�� : H�� : J�� : P�� : Q�� : R�� : S�� : T�� : U�� : V�� : X�� : l F : r F : t < : u < : w�� : { < : | F : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : �� : �� : �� : �� : �� : �� : �� : �� : � F : � F : � : � F : � F : � : � : ��� ; ;
;
; �� ; #�� ; &�� ; *�� ; 2�� ; 4�� ; I�� ; W�� ; Y�� ; Z�� ; \�� ; k�� ; l ; m�� ; o�� ; p�� ; r ; y�� ; | ; }�� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; �� ; �� ; � ; � ; � ; � ; � ; � ; � ; � ; � < 4 < �~ <
4 <
4 < �[ < �V < �[ < �~ < �� < �� < " 2 < #�� < $�~ < &�� < *�� < -�8 < 2�� < 4�� < D�G < F�G < G�G < H�G < J�_ < P�� < Q�� < R�G < S�� < T�G < U�� < V�G < X�� < ]�� < k�� < l 4 < m�V < o�V < p�� < r 4 < t 2 < u 2 < w�� < y�V < { 2 < | 4 < }�V < ��~ < ��~ < ��~ < ��~ < ��~ < ��~ < ��~ < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��G < ��G < ��G < ��G < ��G < ��G < ��G < ��G < ��G < ��G < ��G < ��G < ��G < ��� < ��G < ��G < ��G < ��G < ��G < ��G < ��� < ��� < ��� < ��� < �~ < �G < �� < �G < �G < �� < �� < �G < �G < �G < �� < �� < �� < �V < �V < � 4 < � 4 < �[ < � 4 < � 4 < �[ < �V < �[ < �V < �V < ��~ = �� = " = #�� = &�� = *�� = 2�� = 4�� = k�� = m�� = o�� = p�� = y�� = }�� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = �� = �� = � = � = � = � = � > #�� > &�� > *�� > 2�� > 4�� > D�� > F�� > G�� > H�� > R�� > T�� > k�� > p�� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > �� > �� > �� > �� > �� > �� ? �V ?
�V ?
�V ? �� ? #�� ? &�� ? *�� ? - 2 ? 2�� ? 4�� ? 7�� ? 8�� ? 9�� ? :�� ? <�y ? ?�� ? W�� ? Y�� ? Z�� ? \�� ? k�� ? l�V ? m�� ? o�� ? p�� ? r�V ? t�` ? u�` ? y�� ? {�` ? |�V ? }�� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��y ? ��� ? ��� ? �� ? �� ? �y ? �� ? �� ? �V ? �V ? �V ? �V ? �� ? �� ? �� E �� E
�� E �� E
�� E @�� E [�� E `�� E l�� E r�� E |�� E � E � E � E � H �� H
�� H �� H
�� H @�� H [�� H `�� H l�� H r�� H |�� H � H � H � H � I K I
K I
K I �y I �y I l K I r K I t d I u d I { d I | K I � K I � K I �y I � K I � K I �y I �y K �� K
�� K
�� K Y�� K \�� K l�� K r�� K t�� K u�� K {�� K |�� K ��� K ��� K �� K �� K �� K �� N D�� N F�� N G�� N H�� N R�� N T�� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N �� N �� N �� N �� P �� P
�� P
�� P Y�� P \�� P l�� P r�� P t�� P u�� P {�� P |�� P ��� P ��� P �� P �� P �� P �� Q �� Q
�� Q
�� Q Y�� Q \�� Q l�� Q r�� Q t�� Q u�� Q {�� Q |�� Q ��� Q ��� Q �� Q �� Q �� Q �� R �� R
�� R �� R
�� R @�� R [�� R `�� R l�� R r�� R |�� R � R � R � R � S �� S
�� S �� S
�� S @�� S [�� S `�� S l�� S r�� S |�� S � S � S � S � U �y U �y U D�� U F�� U G�� U H�� U R�� U T�� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U �� U �� U �� U �� U �y U �y U �y Y �� Y �~ Y �~ Y �� Y $�� Y D�� Y F�� Y G�� Y H�� Y R�� Y T�� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y �� Y �� Y �� Y �� Y �� Y �~ Y �~ Y �~ Y ��� Z �� Z �� Z �� Z �� Z $�� Z ��� Z ��� Z ��� Z ��� Z ��� Z ��� Z ��� Z �� Z �� Z �� Z �� Z ��� [ D�� [ F�� [ G�� [ H�� [ R�� [ T�� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ �� [ �� [ �� [ �� \ �� \ �y \ �y \ �� \ $�� \ D�� \ F�� \ G�� \ H�� \ R�� \ T�� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ �� \ �� \ �� \ �� \ �� \ �y \ �y \ �y \ ��� ^ #�� ^ &�� ^ *�� ^ 2�� ^ 4�� ^ D�� ^ F�� ^ G�� ^ H�� ^ R�� ^ T�� ^ k�� ^ p�� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ �� ^ �� ^ �� ^ �� ^ �� ^ �� k �� k �� k
�� k �� k
�� k �� k $�� k 7�� k 9�� k ;�� k <�� k =�� k ?�� k @�� k `�� k l�� k r�� k |�� k ��� k ��� k ��� k ��� k ��� k ��� k ��� k ��� k �� k �� k �� k �� k �� k �� k �� k �� k �� k ��� l �[ l �j l �y l �j l �[ l $�[ l 9 > l : A l < / l ? > l D�� l F�� l G�� l H�� l R�� l T�� l m�y l o�y l y�y l }�y l ��[ l ��[ l ��[ l ��[ l ��[ l ��[ l ��[ l � / l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l �[ l �� l �� l �� l �� l � / l �y l �y l �j l �j l �y l �j l �y l �y l ��[ m �y m �� m
�y m
�y m �j m �j m �� m $�� m 7�G m 9�� m ;�� m <�Q m =�� m ?�� m l�y m r�y m |�y m ��� m ��� m ��� m ��� m ��� m ��� m ��� m ��Q m �� m �Q m �� m �� m �� m �y m �y m �j m �y m �y m �j m �j m ��� o �y o �� o
�y o
�y o �j o �j o �� o $�� o 7�G o 9�� o ;�� o <�Q o =�� o ?�� o l�y o r�y o |�y o ��� o ��� o ��� o ��� o ��� o ��� o ��� o ��Q o �� o �Q o �� o �� o �� o �y o �y o �j o �y o �y o �j o �j o ��� p �� p �� p
�� p �� p
�� p �� p $�� p 7�� p 9�� p ;�� p <�� p =�� p ?�� p @�� p `�� p l�� p r�� p |�� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p �� p �� p �� p �� p �� p �� p �� p �� p �� p ��� r �[ r �j r �y r �j r �[ r $�[ r 9 > r : A r < / r ? > r D�� r F�� r G�� r H�� r R�� r T�� r m�y r o�y r y�y r }�y r ��[ r ��[ r ��[ r ��[ r ��[ r ��[ r ��[ r � / r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r �[ r �� r �� r �� r �� r � / r �y r �y r �j r �j r �y r �j r �y r �y r ��[ t �e t �e t $�e t 9 F t : F t < ( t ? F t ��e t ��e t ��e t ��e t ��e t ��e t ��e t � ( t �e t � ( t ��e u �e u �e u $�e u 9 F u : F u < ( u ? F u ��e u ��e u ��e u ��e u ��e u ��e u ��e u � ( u �e u � ( u ��e y �y y �� y
�y y
�y y �j y �j y �� y $�� y 7�G y 9�� y ;�� y <�Q y =�� y ?�� y l�y y r�y y |�y y ��� y ��� y ��� y ��� y ��� y ��� y ��� y ��Q y �� y �Q y �� y �� y �� y �y y �y y �j y �y y �y y �j y �j y ��� { �e { �e { $�e { 9 F { : F { < ( { ? F { ��e { ��e { ��e { ��e { ��e { ��e { ��e { � ( { �e { � ( { ��e | �[ | �j | �y | �j | �[ | $�[ | 9 > | : A | < / | ? > | D�� | F�� | G�� | H�� | R�� | T�� | m�y | o�y | y�y | }�y | ��[ | ��[ | ��[ | ��[ | ��[ | ��[ | ��[ | � / | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | �[ | �� | �� | �� | �� | � / | �y | �y | �j | �j | �y | �j | �y | �y | ��[ } �y } �� }
�y }
�y } �j } �j } �� } $�� } 7�G } 9�� } ;�� } <�Q } =�� } ?�� } l�y } r�y } |�y } ��� } ��� } ��� } ��� } ��� } ��� } ��� } ��Q } �� } �Q } �� } �� } �� } �y } �y } �j } �y } �y } �j } �j } ��� � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � �o � m�o � o�o � y�o � }�o � �o � �o � �o � �o � �o � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � 4 � �~ �
4 �
4 � �[ � �V � �[ � �~ � �� � �� � " 2 � #�� � $�~ � &�� � *�� � -�8 � 2�� � 4�� � D�G � F�G � G�G � H�G � J�_ � P�� � Q�� � R�G � S�� � T�G � U�� � V�G � X�� � ]�� � k�� � l 4 � m�V � o�V � p�� � r 4 � t 2 � u 2 � w�� � y�V � { 2 � | 4 � }�V � ��~ � ��~ � ��~ � ��~ � ��~ � ��~ � ��~ � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��� � ��G � ��G � ��G � ��G � ��G � ��G � ��� � ��� � ��� � ��� � �~ � �G � �� � �G � �G � �� � �� � �G � �G � �G � �� � �� � �� � �V � �V � � 4 � � 4 � �[ � � 4 � � 4 � �[ � �V � �[ � �V � �V � ��~ � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� �
�� � Y�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � ��� � ��� � �� � �� � �� � �� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� � �~ � �~ � �� � $�� � D�� � F�� � G�� � H�� � R�� � T�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �~ � �~ � �~ � ��� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� � �~ � �~ � �� � $�� � D�� � F�� � G�� � H�� � R�� � T�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �~ � �~ � �~ � ��� � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � �o � m�o � o�o � y�o � }�o � �o � �o � �o � �o � �o � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �o �
�o �
�o � �t � 9�j � :�� � <�y � ?�j � Y�� � Z�� � \�� � l�o � m�t � o�t � r�o � t�� � u�� � y�t � {�� � |�o � }�t � ��y � ��� � ��� � �y � �t � �t � �o � �o � �o � �o � �t � �t � �t � �� �
�� �
�� � Y�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � ��� � ��� � �� � �� � �� � �� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � 4 � �~ �
4 �
4 � �[ � �V � �[ � �~ � �� � �� � " 2 � #�� � $�~ � &�� � *�� � -�8 � 2�� � 4�� � D�G � F�G � G�G � H�G � J�_ � P�� � Q�� � R�G � S�� � T�G � U�� � V�G � X�� � ]�� � k�� � l 4 � m�V � o�V � p�� � r 4 � t 2 � u 2 � w�� � y�V � { 2 � | 4 � }�V � ��~ � ��~ � ��~ � ��~ � ��~ � ��~ � ��~ � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��G � ��� � ��G � ��G � ��G � ��G � ��G � ��G � ��� � ��� � ��� � ��� � �~ � �G � �� � �G � �G � �� � �� � �G � �G � �G � �� � �� � �� � �V � �V � � 4 � � 4 � �[ � � 4 � � 4 � �[ � �V � �[ � �V � �V � ��~ � �� � " � #�� � &�� � *�� � 2�� � 4�� � k�� � m�� � o�� � p�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � � � � � � � � � � � �� � " � #�� � &�� � *�� � 2�� � 4�� � k�� � m�� � o�� � p�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � � � � � � � � � � � �� � " � #�� � &�� � *�� � 2�� � 4�� � k�� � m�� � o�� � p�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � � � � � � � � � � � �y � �� �
�y �
�y � �j � �j � �� � $�� � 7�G � 9�� � ;�� � <�Q � =�� � ?�� � l�y � r�y � |�y � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��Q � �� � �Q � �� � �� � �� � �y � �y � �j � �y � �y � �j � �j � ��� � �y � �� �
�y �
�y � �j � �j � �� � $�� � 7�G � 9�� � ;�� � <�Q � =�� � ?�� � l�y � r�y � |�y � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��Q � �� � �Q � �� � �� � �� � �y � �y � �j � �y � �y � �j � �j � ��� � �[ � �j � �y � �j � �[ � $�[ � 9 > � : A � < / � ? > � D�� � F�� � G�� � H�� � R�� � T�� � m�y � o�y � y�y � }�y � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � � / � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �[ � �� � �� � �� � �� � � / � �y � �y � �j � �j � �y � �j � �y � �y � ��[ � �[ � �j � �y � �j � �[ � $�[ � 9 > � : A � < / � ? > � D�� � F�� � G�� � H�� � R�� � T�� � m�y � o�y � y�y � }�y � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � � / � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �[ � �� � �� � �� � �� � � / � �y � �y � �j � �j � �y � �j � �y � �y � ��[ � �= �
�= �
�= � �I � #�� � &�� � *�� � 2�� � 4�� � 7�A � 9�= � :�m � <�d � ?�= � Y�~ � Z�� � \�� � k�� � l�= � m�I � o�I � p�� � r�= � y�I � |�= � }�I � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��d � ��~ � ��~ � �� � �� � �d � �I � �I � �= � �= � �= � �= � �I � �I � �I � �[ � �j � �y � �j � �[ � $�[ � 9 > � : A � < / � ? > � D�� � F�� � G�� � H�� � R�� � T�� � m�y � o�y � y�y � }�y � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � � / � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �[ � �� � �� � �� � �� � � / � �y � �y � �j � �j � �y � �j � �y � �y � ��[ � �[ � �j � �y � �j � �[ � $�[ � 9 > � : A � < / � ? > � D�� � F�� � G�� � H�� � R�� � T�� � m�y � o�y � y�y � }�y � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � � / � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �[ � �� � �� � �� � �� � � / � �y � �y � �j � �j � �y � �j � �y � �y � ��[ � �= �
�= �
�= � �I � #�� � &�� � *�� � 2�� � 4�� � 7�A � 9�= � :�m � <�d � ?�= � Y�~ � Z�� � \�� � k�� � l�= � m�I � o�I � p�� � r�= � y�I � |�= � }�I � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��d � ��~ � ��~ � �� � �� � �d � �I � �I � �= � �= � �= � �= � �I � �I � �I � �y � �� �
�y �
�y � �j � �j � �� � $�� � 7�G � 9�� � ;�� � <�Q � =�� � ?�� � l�y � r�y � |�y � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��Q � �� � �Q � �� � �� � �� � �y � �y � �j � �y � �y � �j � �j � ��� � �= �
�= �
�= � �I � #�� � &�� � *�� � 2�� � 4�� � 7�A � 9�= � :�m � <�d � ?�= � Y�~ � Z�� � \�� � k�� � l�= � m�I � o�I � p�� � r�= � y�I � |�= � }�I � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��d � ��~ � ��~ � �� � �� � �d � �I � �I � �= � �= � �= � �= � �I � �I � �I � �y � �� �
�y �
�y � �j � �j � �� � $�� � 7�G � 9�� � ;�� � <�Q � =�� � ?�� � l�y � r�y � |�y � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��Q � �� � �Q � �� � �� � �� � �y � �y � �j � �y � �y � �j � �j � ��� � �y � �� �
�y �
�y � �j � �j � �� � $�� � 7�G � 9�� � ;�� � <�Q � =�� � ?�� � l�y � r�y � |�y � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��Q � �� � �Q � �� � �� � �� � �y � �y � �j � �y � �y � �j � �j � ��� � �[ � �j � �y � �j � �[ � $�[ � 9 > � : A � < / � ? > � D�� � F�� � G�� � H�� � R�� � T�� � m�y � o�y � y�y � }�y � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � ��[ � � / � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �[ � �� � �� � �� � �� � � / � �y � �y � �j � �j � �y � �j � �y � �y � ��[ � �V �
�V �
�V � �� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�y � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�V � m�� � o�� � p�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � ��� � ��� � �� � �� � �y � �� � �� � �V � �V � �V � �V � �� � �� � �� � � � � �.��B�>t� Tn��<�4t�@x n �
L
r
� � l �
B
l
� "^��N��R�@�� P��� :j����r�N"j� Pj�@�
j��� j � � � � d d � $ � n �!*!|"f"�#&#V#p$@$Z$�$�%`& & &v&�&�'6'|'�( (�)$)�*X*d*p*|*�*�*�*�+�+�+�+�+�+�+�+�+�,>,J,V,b,n,z,�,�-<-H-T-`-l-x-�.j.v.�.�.�.�.�/�0<0H0T0`0l0x0�0�0�1 121D1V1h1z1�1�2j2|2�2�2�2�3,3>3�4r4~4�4�5�5�5�6.6:6L7:7�7�888 8,888J8V8h8t8�9l9�9�9�9�:&:t:�;
;>;�;�;�;�<"<J<�<�= =�>(>T>�?�?�?�@@�@�AjA�BBBB�B�B�CjC�DBD�D�E E`EzE�F�F�F�GG(GJGxG�G�HHDH�H�H� � d " / n � � � �
� � / � � ( � 0 B B
�Q - 2E
�w 9 S g { ^� � P � `U � �
�� 0
� d
�
� 4� � �Copyright (c) 2010-2013 by tyPoland Lukasz Dziedzic with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1.Lato LightItalictyPolandLukaszDziedzic: Lato Light Italic: 2013Lato Light ItalicVersion 1.105; Western+Polish opensourceLato-LightItalicLato is a trademark of tyPoland Lukasz Dziedzic.Lukasz DziedzicLato is a sanserif typeface family designed in the Summer 2010 by Warsaw-based designer Lukasz Dziedzic ("Lato" means "Summer" in Polish). It tries to carefully balance some potentially conflicting priorities: it should seem quite "transparent" when used in body text but would display some original traits when used in larger sizes. The classical proportions, particularly visible in the uppercase, give the letterforms familiar harmony and elegance. At the same time, its sleek sanserif look makes evident the fact that Lato was designed in 2010, even though it does not follow any current trend. The semi-rounded details of the letters give Lato a feeling of warmth, while the strong structure provides stability and seriousness.http://www.typoland.com/http://www.typoland.com/designers/Lukasz_Dziedzic/Copyright (c) 2013-2013 by tyPoland Lukasz Dziedzic (http://www.typoland.com/) with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1 (http://scripts.sil.org/OFL).http://scripts.sil.org/OFL C o p y r i g h t ( c ) 2 0 1 0 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 . L a t o L i g h t I t a l i c t y P o l a n d L u k a s z D z i e d z i c : L a t o L i g h t I t a l i c : 2 0 1 3 L a t o - L i g h t I t a l i c V e r s i o n 1 . 1 0 5 ; W e s t e r n + P o l i s h o p e n s o u r c e L a t o i s a t r a d e m a r k o f t y P o l a n d L u k a s z D z i e d z i c . L u k a s z D z i e d z i c L a t o i s a s a n s e r i f t y p e f a c e f a m i l y d e s i g n e d i n t h e S u m m e r 2 0 1 0 b y W a r s a w - b a s e d d e s i g n e r L u k a s z D z i e d z i c ( " L a t o " m e a n s " S u m m e r " i n P o l i s h ) . I t t r i e s t o c a r e f u l l y b a l a n c e s o m e p o t e n t i a l l y c o n f l i c t i n g p r i o r i t i e s : i t s h o u l d s e e m q u i t e " t r a n s p a r e n t " w h e n u s e d i n b o d y t e x t b u t w o u l d d i s p l a y s o m e o r i g i n a l t r a i t s w h e n u s e d i n l a r g e r s i z e s . T h e c l a s s i c a l p r o p o r t i o n s , p a r t i c u l a r l y v i s i b l e i n t h e u p p e r c a s e , g i v e t h e l e t t e r f o r m s f a m i l i a r h a r m o n y a n d e l e g a n c e . A t t h e s a m e t i m e , i t s s l e e k s a n s e r i f l o o k m a k e s e v i d e n t t h e f a c t t h a t L a t o w a s d e s i g n e d i n 2 0 1 0 , e v e n t h o u g h i t d o e s n o t f o l l o w a n y c u r r e n t t r e n d . T h e s e m i - r o u n d e d d e t a i l s o f t h e l e t t e r s g i v e L a t o a f e e l i n g o f w a r m t h , w h i l e t h e s t r o n g s t r u c t u r e p r o v i d e s s t a b i l i t y a n d s e r i o u s n e s s . h t t p : / / w w w . t y p o l a n d . c o m / h t t p : / / w w w . t y p o l a n d . c o m / d e s i g n e r s / L u k a s z _ D z i e d z i c / C o p y r i g h t ( c ) 2 0 1 3 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c ( h t t p : / / w w w . t y p o l a n d . c o m / ) w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 ( h t t p : / / s c r i p t s . s i l . o r g / O F L ) . h t t p : / / s c r i p t s . s i l . o r g / O F L L a t o L i g h t I t a l i c �� �X A
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � b c � d � e � � � � � � � f � � � � g � � � � � h � � � j i k m l n � o q p r s u t v w � x z y { } | � � ~ � � � � � � �
� � � � �
� � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � !"#NULLuni00A0uni00ADmacronperiodcenteredAogonekaogonekEogonekeogonekNacutenacuteSacutesacuteZacutezacute
Zdotaccent
zdotaccentuni02C9EuroDeltauni2669undercommaaccent
grave.case
dieresis.case macron.case
acute.casecircumflex.case
caron.case
breve.casedotaccent.case ring.case
tilde.casehungarumlaut.case
caron.salt �� _ K _ K� �� ����V��������V� ,� `f-�, d ��P�&Z�E[X!#!�X �PPX!�@Y �8PX!�8YY � Ead�(PX!� E �0PX!�0Y ��PX f ��a �
PX` � PX!�
` �6PX!�6``YYY� +YY#� PXeYY-�, E �%ad �CPX�#B�#B!!Y�`-�,#!#! d�bB �#B� *! �C � �� +�0%�QX`PaRYX#Y! �@SX� +!�@Y#� PXeY-�,�C+� C`B-�,�#B# � #Ba��b�`�*-�, E �Ec�Eb`D�`-�, E � +#�%` E�#a d � PX!� �0PX� �@YY#� PXeY�%#aDD�`-�,�E�aD-� ,�` � CJ� PX � #BY�
CJ� RX �
#BY-�
, � b � c�#a� C` �` � #B#-� ,KTX�DY$�
e#x-� ,KQXKSX�DY!Y$�e#x-�
,� CUX� C�aB�
+Y� C�%B� %B�
%B�# �%PX� C`�%B�� �#a� *!#�a �#a� *!� C`�%B�%a� *!Y� CG�
CG`��b �Ec�Eb`� #D�C� >�C`B-�,� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,� +-�,�+� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-� ,�+-� ,�+-� ,�+-� ,�+-� ,�+-�!,�+-�",�+-�#,� +-�$, <�`-�%, `�
` C#�`C�%a�`�$*!-�&,�%+�%*-�', G �Ec�Eb`#a8# �UX G �Ec�Eb`#a8!Y-�(,� ETX ��'*�0"Y-�),�+� ETX ��'*�0"Y-�*, 5�`-�+, �Ec�Eb� +�Ec�Eb� +� � D>#8�**-�,, < G �Ec�Eb`� Ca8-�-,.<-�., < G �Ec�Eb`� Ca�Cc8-�/,� % . G� #B�%I��G#G#a Xb!Y�#B�.*-�0,� �%�%G#G#a�E+e�.# <�8-�1,� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# �C �#G#G#a#F`�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba# �&#Fa8#�CF�%�CG#G#a` �C��b`# � +#�C`� +�%a�%��b�&a �%`d#�%`dPX!#!Y# �&#Fa8Y-�2,� �& .G#G#a#<8-�3,� �#B F#G� +#a8-�4,� �%�%G#G#a� TX. <#!�%�%G#G#a �%�%G#G#a�%�%I�%a�Ec# Xb!Yc�Eb`#.# <�8#!Y-�5,� �C .G#G#a `� `f��b# <�8-�6,# .F�%FRX <Y.�&+-�7,# .F�%FPX <Y.�&+-�8,# .F�%FRX <Y# .F�%FPX <Y.�&+-�9,�0+# .F�%FRX <Y.�&+-�:,�1+� <�#B�8# .F�%FRX <Y.�&+�C.�&+-�;,� �%�& .G#G#a�E+# < .#8�&+-�<,�%B� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# G�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba�%Fa8# <#8! F#G� +#a8!Y�&+-�=,�0+.�&+-�>,�1+!# <�#B#8�&+�C.�&+-�?,� G� #B� .�,*-�@,� G� #B� .�,*-�A,� �-*-�B,�/*-�C,� E# . F�#a8�&+-�D,�#B�C+-�E,� <+-�F,� <+-�G,� <+-�H,�<+-�I,� =+-�J,� =+-�K,� =+-�L,�=+-�M,� 9+-�N,� 9+-�O,� 9+-�P,�9+-�Q,� ;+-�R,� ;+-�S,� ;+-�T,�;+-�U,� >+-�V,� >+-�W,� >+-�X,�>+-�Y,� :+-�Z,� :+-�[,� :+-�\,�:+-�],�2+.�&+-�^,�2+�6+-�_,�2+�7+-�`,� �2+�8+-�a,�3+.�&+-�b,�3+�6+-�c,�3+�7+-�d,�3+�8+-�e,�4+.�&+-�f,�4+�6+-�g,�4+�7+-�h,�4+�8+-�i,�5+.�&+-�j,�5+�6+-�k,�5+�7+-�l,�5+�8+-�m,+�e�$Px�0- K� KRX��Y� c �#D�#p�E �(`f �UX�%a�Ec#b�#D� *� *�*Y�( ERD� *�D�$�QX�@�X�D�&�QX� �X�DYYYY������ D share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf 0000644 00000416034 15173517750 0025650 0 ustar 00 � pBASEe ]� �0 FDSIG GDEF��� �x �GPOS#f�8 �d bGSUB�] �� JOS/2��� x `cmapspB 3fglyfc��[ M� Ovhead�ʹ � 6hhea3 y 4 $hmtx�s�p � Bloca�ny� A� BmaxpT^ X name��s �@ �post+�� �$ 9 �7
��_<� � �
� � s�0�:($ �� X�0�0( � * b X� �X K�X ^ 2) � 8 ADBO ��� �` � �� X # J 6 F \ i , @ J ; D k : B & K & F 2 @ 8 = H C / 7 R 4 H O * L 2 # H / H / t 5 1 > % F ������ J 6 6 6 6 6 F F F F \ \ \ \ \ \ \ \ ^ \ \ \ \ F \ \ \ \ , , , , , , , , , @ @ @ @ J J J J J J J J J J J J ; D D D [ k k k * k�� k : : : B B B B B B B B & & & & & & & & & & & & & & & & & & & & & & & & F F F F F F F 2 2 2 2 2 2 2 2 @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ @ 8 8 8 8 8 8 I 2 A J & . = = = = = = = = = = = = = = ' = = = = = = = = H C C C C C " / / / / 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 7 4 4 4 4 4 4 4 4��� H H H O O O O O O O O O O O O * L L L L 2 2 2 2 2 2 2 # # # H H H H H H H H�� / / / / / / / / / / / / / / / / / / / / / / / / / t R t t a a / 5 5 5 5 5 5 5 5 = R 1 1 1 1 1 1 1 > > > > > > > > > > > > > > > > > > > > > > > F F F F F F / H H * A�� B H H H 4 C / / 6 / n 7 F 0 / * 1 / @ < H H H O O 2 ) 2 ) y #�� H J / 4 4 4 t t J J 5 + + 2 1�� ' > ! F F 4�� 2 E 2 9 C / B / / / / / / / / / / / / / / / / / / / / / / / / / / / / / / / / Q Q Q Q Q Q Q Q Q Q Q Q Q Q O Q O Q Q Q Q Q Q Q Q Q �� Q Q J l \ 8 @ & J D : B B & @ K ? ������ J�� �� * H 5 F V A 7 = I " @ ; 3
H / 2 > ) I H 9 * F A = = 3 > > = > I 0 J t ) � � � � � � � h � � � � � � � j i j s � � n o h � � � � � � } � � � � J J l \ . @ @ E�� : @ & @ K 6 @ - " J \ \ l 7 2 J J ;�� E @ ? & l 2 . E @ 6 , > J �� \ 2 @ & & = < T t 7 0 I I M % H / H H C 2 % H @ # # & Q 5 " 7 7 t C 5 O O *�� $ M I K / % x / 0 M H C % @ H 2 = 7 7 I / / / / C Q Q Q�� 8 O 3 * # . < > = 5 8 O 8 O 3 * # . < > = 5 8 O 8 O 3 * # . < > = 5 8 O � � � ��� � � b g � R � � 3 E � E � � � * ; F F F P P � � v � � z Z � � z Z | Y � < < >�c � ~ � h j i J � J � @ Y Y G 0 w > < @ \ � h � h � h � h � h e�� F T | | | @ � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � 0 � � � � � � � � t & | � � � � � � � � � � � � � � � > $ @ C - ` . O C [ C 5 O Y # # 4
5 F F T F � F F t b F F F V F 4 4 F F I F�� � � p � @ < � � } ! B , ; J
] > G f
�� J < 9 ' H 5 5 A A D D A A 0 0
�� , 7���� 5�� �� �� ����� .��� J # � � � � � � � � Z } � u u � � � } � n m � � � � � � � . } � � � � � u � n f � � � � � � � z � � m t � � w x � � � � u � � B 9 � � � � � � � � �" � � � � � � m � � � � � � � � � u � � n � J � � � k � n f �0�c � � h � � o � � � � � � � / � � � � � � � � � � � � � � � � u z s i � j j � ���� � � ! ! � � � � � � � ��������� � � � ��������� � � � � � � � ��������������������������������������������������������������������������������� K K � ��� ^ � ^ ^������ � ^ ^������ � ^ ^������������������������ ��� � �� � � � � � ��� ��� � ,����
, , 5�� > A �� �� $ � , $
� � � ���Rkl���������mnopqrstuv�������
������ ! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5���� : = R ^ � � �
*)+-KJLNipoqsr������VS���������� M �����T������&(u�����W�����o 6 9 � ����������� �hU������l 8 _ 7 a ] � � ~ � � � � � �U���������� � � � / 9 @ Z ` z ~�������������7C\ghnv{~������������������ *,14=E_auz~���������������/_cu�������������� C I M P R X [ � � � ! + ; I S c g o � � � � � � � � � " & 0 3 5 : ? D I q y � � � � � � � � � � � � �!!!! !"!&!.!^!�!�!�!�" """"""" ")"+"7"H"a"e###!%�%�%�%�%�%�%�%�%�%�&&&<&@&B&`&c&f&k''R'd'�..%������ 0 : A [ a { �������������7CP^hjox}������������������ #,.49@_atz~��������������� 0br�������������� C G M O R V [ � � � $ 2 > R X f l ~ � � � � � � � � & / 2 5 9 < D G p t } � � � � � � � � � � � � �!!!! !"!&!.!P!�!�!�!�" """"""" ")"+"7"H"`"d### % %�%�%�%�%�%�%�%�%�&&&:&@&B&`&c&e&j''R'd'�.."������ = �� �� ��o Y ���
���� ������������ �x�p�o� %$#$ ��;�:�. �� ��� �� ����������� �� �� �� ����� �- �i� �o �d�c�j �$ �~ �|�y�� �� ��� ��� �����z�z � ���� �� �T �i�p�l�G �%��� �s� � �� ��� ޚޙ�r�m �cݹ�j�q�վջ%y%l � � � �� ��� ������� � � �� �� ��� " " , 028>HNPZ\^bfprxz z | | xz����������� ������ �� � � �� � � � � � � � � � �� � � �� ���Rkl��������������������������o�VSQT����&���������������(�mno� 6 7 8 9 : = M R ] ^ _ a ~ � � � � � � � � �� � � � � � � ��
)*+-JKLN�iopqrs��������� ; < @
S T! V# U" W$ [( b. c/ d1 e0 `, p< q= r> s? xC }I �M �O �T �Q �U � �V �WZ �[ �] �\ �b �a �f �j �hn �� �t � �u �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� � �� �� ��� W w �� �� ? �P �v �� �� �� �� �� O t@ �w o; �g > N �� �� �������������������� �����2:?A��������H4;@I��
"-./02467� C#JE��v�wxy|~�z}�������������������J KLMNOPQRS T
U V W
XYZ[\]^_`abcd*,-358<= Q X% Y& Z' n: uA zE yD {G |H �X �Y �^ �_ �` �c �d �e �k �l �m �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� ��F� A B C D E F G H I J K L f2 g3 h4 i5 j6 k7 l8 m9 �R �S �x �y �z �{ �| �} �~ �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� ����������������������������������l��������1��6gY]Uebck�x}~pqrstuvwyz{|���������������������������������������������������������� $� ! ! � " " � # # � $ $ R % % k & & l ' ' � ( ) � * * � + + � , , � - - � . . � / / � 0 9 m : ; � < < � = = � > > � ? ? � @ @ � A Z [ [ � \ \ � ] ] � ^ ^ � _ _ � ` ` � a z { { � | | � } } � ~ ~ � � � o � � � � � V � � S � � Q � � T � � � � � � � � � � � � � � & � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � ( � � � � � m � � � � � 6 � � = � � M � � R � � ] � � a � � ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �
� � � � � � ) � � - � � J � � N � � � � � i � � o � � � � � � � � � � � � � � � � � � � � � ; < @
S T !
V # U
" W $ [ ( b . c / d 1 e 0 ` , p < q = r ! ! > " " s # # ? $ $ x % % C & & } ' ' I ( ( � ) ) M * * � + + O , , � - - T . . � / / Q 0 0 � 1 1 U 2 2 3 3 � 4 4 � 5 5 V 6 6 � 7 7 W 8 8 Z 9 9 � : : [ ; ; � < < ] = = � > > \ ? ? � @ @ b A A � B B a C C � D D f E E � F F j G G � H H h I I n J J � K K � L L � M M t N N � O O P P � Q Q u R R � S S � T T � U U � V V � W W � X X � Y Y � Z Z � [ [ � \ \ � ] ] � ^ ^ � _ _ � ` ` � a a � b b � c c � d d � e e � f f � g g � h h � i i � j j � k k � l l � m m � n n � o o � p p � q q � r r � s s � t t � u u � v v � w w � x x � y y � z z � { { � | | � } } � ~ ~ � � � � � � \ � � � � � W � � w � � � � � � � � � � � � � � � � ? � � � � � � � P � � � � � v � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � O � � � � t � � @ � � � � � w � � o � � ; � � � � � g � � > � � � � N � � � � � � � � � � � � 7 7 � C C P P P � Q Q � R X � Y \ � ^ g � h h � j j � k n � o v � x { � } ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � 0 � � 2 � � : � � ? � � A � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � H � � 4 � � ; � � @ � � I � �
" $ # & - ' ' 2 ( ( 4 ) * 6 , , 8 . 1 9 4 4 = 9 = > @ @ � A A B B C C C # D D J E E E _ _ F a a G t u � z z � ~ ~ � � � � � � � � � v � � � � � w � � { � � | � � ~ � � � � � ^ � � o � � z � � } � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � / � 0 _ b b � c c J r r s s K t t u u L � � � � M � � � � N � � � � O � � � � P � � � � Q � � � � R � � � � S � � � � T � �
� � U � � � � V � � � � W � �
� � X � � � � Y � � � � Z � � [ � � � � \ � � � � ] � � � � ^ � � � � _ � � � � ` � � � � a � � � � b � � � � c � � � � d C C ) G G * H I , M M / O O 3 P P 5 R R 7 V V 8 W X < [ [ > � � + � � . � � B Q X
% Y & Z ' n : u ! ! A $ $ z % % E & & y ' ' D ( ( { ) ) G * * | + + H 2 2 � 3 3 X 4 4 � 5 5 Y 6 6 � 7 7 ^ 8 8 � 9 9 _ : : � ; ; ` > > � ? ? c @ @ � A A d B B � C C e D D � E E k F F � G G l H H � I I m R R � S S � X X � Y Y � Z Z � [ [ � \ \ � ] ] � ^ ^ � _ _ � ` ` � a a � b b � c c � f f � g g � l l � m m � n n � o o � ~ ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � F � � � � � � � � A � � � � B � � � � C � � � � D � � � � E � � � � F � � � � G � � � � H � � � � I � � � � J � � � � K � � � � L � � � � f � � 2 � � g � � 3 � � h � � 4 � � i � � 5 � � j � � 6 � � k � � 7 � � l � � 8 � � m � � 9 � � � � � R � � � � � S � � � � � x � � � � � y � � � � � z � � � � � { � � � � � | � � � � � } � � � � � ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � p � � � � � � � � � � � ! � " " � & & � / / 0 0 l 2 3 � 5 5 � 9 : � < < � = = � > ? � D D h G G � H H � I I � p p � q q 1 t y � } ~ � 6 � � � � � � � F � � X � � g � � Y � � Z � � \ � � ] � � U � � d � � ^ � � ` � � e � � b � � f ! ! � ! ! � ! ! k ! ! � ! ! � !" !" � !& !& � !. !. � !P !P x !Q !R } !S !Z p ![ !^ y !� !� !� !� � !� !� � !� !� � !� !� � !� !� � " " � " " � " " � " " � " " � " " � " " � " " i " " � " " � " " � " " � ") ") � "+ "+ � "7 "7 � "H "H � "` "` � "a "a � "d "e � # # � # # � # # � # #! � % %� s %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � & & � & & � &: &; � &< &< � &@ &@ � &B &B � &` &` � &c &c � &e &e � &f &f � &j &k � ' ' � 'R 'R � 'd 'd � '� '� � . . � ." .% � � � � � � � �� �� � � � � � � � � � � � * * M � � � � �'<Qp����4p��� W���� J}��<_ju����)X���0K�����&1<G������
& 1 < G R ` � � � � � � �
$
/
:
E
M
~
�
�
�
�
�
�
�
� * 5 @ K V d o z � � � � � � � $ / ; F i t � � � � � � � �
)
4
?
J
V
a
l
z
�
�
�
�
�
�
�
�
�
�$/:EP[fq|������
Xcny����� *5@KYdoz��������
+EP[fq|������� "-]hs~�����������
#.9DOZe���;br}�������*5�����������r}�������@KVa��������4?JU`kv������������ +7Bmx����������� !9DP[ft�������� "-hs~������ % 0 ; F T _ j � � � � � � + � � � � � � � � � � � � ( q � � � � � � � % 0 ; F Q \ g r � � � � � � � ! , 7 B M X c n y � � � � � � � � � � � �! !! !*!s!�!�!�">"�"�"�#$#g#�#�$ $_$�$�$�%%O%�%�%�%�&P&�&�' 'H'k'�'�'�'�( ((/(:(u(�(�(�))7)w)�)�**-*d*�*�*�++E+d+�+�+�,(,^,�,�,�-
-6-S-�-�-�-�.6.f.�.�/G/o/�/�/�00O0�0�0�0�0�0�0�0�0�0�1=1H1S1^1i1t11�1�1�1�1�1�1�2 2(232>2I2T2_2j2u2�2�2�2�2�2�2�2�2�2�2�33 33"3J3w3�3�3�3�3�4
44 4.494V4b4�4�4�4�4�4�5
55 5%5V5^5f5�5�5�5�5�5�5�5�5�5�6)616R6�6�6�6�7 77E7k7s7�7�8=8i8�8�9(9R9�9�9�::;:]:�:�;
;=;p;�;�< < <U<�<�= =a=i=�=�=�=�=�=�=�=�>>>>$>c>�>�>�??? ?)?8?F?N?]?e?m?�?�?�?�?�?�?�?�?�?�?�?�?�?�?�@@!@=@K@S@v@�@�@�AASA[A�A�A�A�A�BBLBmBxB�B�B�B�B�B�B�B�CC*C\CdC{C�C�C�C�DD;DiD�D�D�D�E EECEKESE[EcE�E�E�E�FFF)FSF�F�F�F�G&GfG�G�G�H
HH7HhH�H�H�H�H�H�H�H�H�H�III I%IjI�I�I�I�J#J_J�J�J�J�KK)K1KCKKKSKdKlK�K�K�K�LL/LQLwL�L�L�MM M'MdMoM�M�M�M�M�M�N"N*N5N@NKNaN�N�N�N�N�O,OkO�O�O�PP#PHPyP�P�P�P�P�P�P�P�P�P�P�Q QQ Q'QqQyQ�Q�Q�RKR�R�R�SS,S^S�S�TTIT�T�T�T�UURUvU�U�U�U�VVJV_V�V�V�W W@WtW�W�X X_X�X�X�X�X�X�Y,YMYnY�Y�Y�Y�Z Z>ZKZXZaZnZ�Z�Z�Z�Z�Z�Z�Z�Z�Z�[[[[3[_[l[[�[�[�[�[�[�\\\;\G\S\f\s\�\�\�\�\�]*]k]z]�]�]�]�]�^^_^|^�^�^�_P_�_�` `+`:`I`X`p`�`�`�`�`�a aha�a�b0b�b�cc&c2c:cBc�c�c�c�c�c�c�c�c�c�c�c�c�ddd7dNdpd�d�d�e,eDe�e�e�fff3fYflf�f�f�g
gBgZg�g�g�h h h<hEhNhWh`hihrh{h�h�h�h�h�h�h�h�h�h�ii7idi�i�i�jMjnj�j�j�j�k%kFkrk�k�k�l/lSltl�l�l�mm$m]m�m�nnEn�n�n�oo=oJoVocopo�o�p)pTp�p�q
qgq�q�rr^r�r�ssgs�s�s�t"t;tjt�t�t�t�t�u%u4uDuSucusu�u�u�u�u�u�u�u�vvv#v3vyv�v�v�v�v�v�www(w;wVwqw�w�w�w�w�xxx1x@x�x�x�x�x�x�y.ybyy�y�y�y�y�zzz-z@z�z�{!{9{Q{h{�{�{�{�{�{�| |<|\|{|�|�|�} }}.}F}V}f}{}�}�}�}�}�}�}�~~I~�~�~�~�.b�����������������7�����ȃЃ��
�3�G�U�t�|���������������ȄЄ��� ���υ݅����$�7�J�p�����������܆���0�G�^�����Ň�
�8�^���������Ԉ��
�(�C�a�}�������É҉� ��*�?�K�T�]�f�������Պ���(�8�A�J�S�\�e�������ċ� ���8�D�a�������>�k���َ�7�i�������ю�� �K�y�������5�e���Ӑ��!�5�I�l�����Ւ �.�Q�������������������Ӓ��&�C�d�������ēԓ����&�6�F�U�e�u���������ʔߔ�� �1�D�W�j��������ӕ���$�7�I�^�r�������Ö֖���#�;�T�l�������̗���2�J�b�z�������Ϙ��
�!�6�K�e�z�������љ� ��-�E�^�}�����͚�� �6�M�l�����ۛ���*�D�T�e�����������ŜҜߜ���%�7�D�P�]�j�w�����������ŝҝߝ������F�ߥ����!�1�E�V�g�u��������������"�M�p�x�������� # 5� 3!%3''#7'377# #���(()|__�+ � u^��l[Mbb
��p_;;��s O� 3'&&'#3#'#��
�˰˜'�(J<<1m44m����t�� J 2� " 332#32654&##3254&##J�Dl?6:FHBqG[A6014BOv9=O� F?+S
KACT)�+%$ �ZX+& 6��:� "&&546632&&#"3267dQ�TS�W>d!Q7$E[]I#;QQ L�ml�Q3 [pbdp Y` F 4�
332#'326654&&##F�_�NM�[)3M++M3�D�pp�Gw(\NNY% \ � 3!!3#!\�����&�|�{�| i � 3!!3#i������|�|� ,��#� "&&546632&&#"32675#53WS�PP�TB^ Q2'@UNM#
_�!m L�mm�P3 [pbdp
px�� 0 @ � 33353##@���������t�� J � 353#5!#3J��Ę�|�||�l| ;��� "&'73265#5!6u+U9C23��.k 0<[H4C'{�R@j@ D R� 3333#D����֣�K��� ���wc� k � 33!k�"���| : � 333773#54>7##''# :�@@�|22H3/��ZZ�t�QXP����PXQ� B � 333&&553#'#B��8���8����4:�tE�6|:� &��2� "&&546632'2654&#",MwBBwMNvBBvN3<<33<< N�om�MM�mo�Nljekkejl K 1� 332##3254&##K�GsEFtETKx=;K�'\OLb/�Rh3* &�NG� & %2654&#""&'&&5466323267,3<<33<<�_� XjBwMNvB`QC#
0llqekkeql��bL��m�MM�m�� "n F H� 332#'#3254&##F�ErE@4��}MHw<;H�%XNH]����`a0& 2��'� * "&'732654&''.546632&&#"*B�5U%Y//-6/T$@'=lF;r,K"D0%-</OAK;q 0.e & # $/F/6X4,*] "TE6\8 9� 3#5!#���||�� @��� "&5332653.ww�-./-�s ���`:??:��o� I�
3336673�ŜNM�����5f66f50�t T� ! 3336677336673#'&&'#[W�,^)�P�&
&���*N,,O)��(O--O([�t� @ @ � F� 33366773#'&'#���?
:����G DO={4 4{�����0; 3� H� 353366773�ҞB B�����%I''I%��P� 8 #� 35!5!!81����5Y�{Y�I| =��� % "&&5467&&#"'6632#'#'2675�2I(��42$I*43u@hxx %[!:IQ & (D*SX
"&` &nr��8 (rR" H��)� "'##336632'2654#"RH? s� H$]k=bY)8[/-. B6��N �rUy?xFL�.� C��#� "&&546632&#"3267WN}IP�L;` D77@PN='A;-l =uRSt=& ['LA@M ]%$ /��� ! "&5466323'53#'#52675&&#" ^s=a6);�x H+)(<2 �yQu>M��C3$x�CGIE 7��#� "3&"&&546632!3267>+< � KN|IJvBMh5�� L="=!1+h�./]�h=uRRt>?kD% 62Y R I� 3#57546632&&#"3#Ճ�.cM+L 4 ]��}m
9]6 l
Ws�� 4�-<� 0 < J "&&5475&&54675&&5466323##"&'3322654&#"2654&##"'@f;M !&;a8.$�d7\:" T\bgH�R ,, ++,;K,+>3#D�9,=&
) 2B+<P( l #9I$
%:C4Q.�*('**'(*��# H � 3336632#4&#"H� Q8SN� ) -��_ -l^�� 2.�� �� O ��&U
- �� *�<��&�
- L I� 33373#'L����̟�I��k����N} 2�� � "&5#5!3267�]`�/2 &!'? p^�t��.# l
# >� 33366326632#4#"#4#"#o
2+D5+5:�s
�= +Q"/VJ��R-0��R-�� H � 3336632#4&#"Hx T7TN� ) -�B .l^�� 2.�� /��)� "&&546632'2654&#",BsHHsBBsHHsB3333333 =uRSt==tSRu=wM@ALLA@M H�H)� 336632#"'#2654#"Hx N(]j=b8D6U)9[/--��2#�sUx?6Q�$FL�.� /�H� ! 57##"&5466323732675&&#"}D#^s=a6*A s�+)(<2��P �yQu> !3�X$�CGIE t $� 3336632&&#"tx %i;!) % .Y �l=;
{6C�� 5�� � ' "&'732654&&'&&54632&&#" (C�/?.e5)&41eXzjCm'B%T)"#4?MT"} - \
K:EV+X+:)C] 1��&� "&&55#57733#3267�O^)}�y��27 0!O 7bA�m��s�80 j
>��
� "&5332673#'#�UL� ) ,�x !Q l^2��1/!F�G%. 9�
33366773ڻ�N N����%M''M%� T� 33366773366773#'&&'#UQ� k �L� ��%H&&J#��%H&&H%�� H+:Y� % 2� 3'3366773#'&&'#%���3
,����9
1�P+,P��R,+R �>;� "&'7326773366773�&+1
גS
I��<U�p$ ��#K'%K%� >U* F � 35#5!!F���� O.sN��s�� O~& � �� O~& � �� OC& �� OT& �� ON& �� O/& �� OP& �� O~& O�
+ "&54773'&&'#3#'#2654&#",3?+�;S "@j�
�˰˜'�(��6-5�R(
/ -6��<<1m44m����t����� OT& � g� % 3'&&'#"&54667#'##33267��
�1D (('�(�˰�*3
#;J<<1m44m��2. 4%
����t9
J �� �
O�& - �� Ov& �� O& T �� O& V �� O�& X �� O�& Z �� �
OC& & - �� O�& \ �� O�& ^ �� O�& ` �� O�& b �� �
OP& & - �� S� 3#!#3#3!5#� T
���s�vv���v-d]1]�q�|�|�|������ S~& M �[ ���� S/& M [ 4� ! * 35#5732#'3254&##3#532654&##TKK�Dk>59FHBrGRFu8=Fjj95233:�E� E;*K
OEDY*lf3-<K�)'$ �� J�D2�& < �� 6�:�& 3+ �� 6��:~& �5 �� 6��:C& 5 �� 6��:T& 5 �� 6��:d& 5 �� F 4T& �� F�
4�& -� �� F�D4�& <� �� F�4�& 3� �� 4� � E� 3&&546632#7326654&'�&"74:9za��DxO
!2?< 5""+^UCDi<��s�Hw)^Qm_�� \ ~& � �� \ ~& � �� \ C& �� \ T& �� \ N& �� \ /& �� \ P& �� \ d& ^� -� ! "&54667!!!3#!#3267�1D&�������%) #;�2. 3& �|�{�| ) J �� \�
�& - �� \ v& �� \ T& �� \ D& T �� F & V �� \ @�& X �� \ �& Z �� \�
C& & - �� \ �& f �� ,��#~& � �� ,��#C& �� ,��#P& �� ,��#d& �� ,�#�& 0 �� ,��#T& �� ,��#/& �� ,��#T& ,��`2 1 &&#"32675#53#"&&546632&&54632&&#"Q2'@UNM#
_�!m>S�PP�TKB '
E[pbdp
px�� 0L�mm�P 7Nm!�� @ C& �� @ N& �� @�
�& - �� ��& 3�_ �� @��& 9 U� 3#57533533###35#@==���==�����E^]]]K� ���S�� J ~&
� �� J ~&
� �� J C&
�� J T&
�� J N&
�� J /&
�� J d&
�� J T&
J� � "&54667#53#5!#3#326731C#�����*# ";�2. 3% |�||�l|1 J �� J v&
�� J�
�&
- �� J P&
�� ;��C& �� D�R�& 0 �� D�
R�& - �� D�DR�& < �� [ ~&
�� �� k &
���� k� �&
0# �� k�
�&
-# �� *�
/&
&� -# �� k�D �&
<# �� �
35'737!k@2r��1�"�&X@J��dX~�| �� k =�&
���� : ~& � �� : d& �� :�
�& - �� B ~& �
�� B ~& �
�� B T&
�� B T&
�� B��& 0 �� B d&
�� B�
�& - �� B�D�& < �� &��2~& � �� &��2~& � �� &��2C& �� &��2T& �� &��2N& �� &��2/& �� &��2y& �� &��2P& �� &��2T& &� 2� ! - "&5467.54663232672654&#"B1C+Oh3BwMNvB`P(! #;33<<33<<�2.)=
^�Xk�OO�j��#5 JSipekkepi �� &�
2�& - �� &��2v& �� &��2& T �� &��2& V �� &��2�& X �� &��2�& Z �� &�
2C& & - &��S? ( "&&5466326654&'7'2654&#",MwBBwM?4
m s'+BvN3<<33<< N�om�M '$# ,5 r +�Wo�Nljekkejl�� &��S~& � � �� &��S~& � � �� &��Sv& � �� &��ST& � � �� &�
S?& � - �� &��2�& f ��D� ) 77&&5466327#"'7&#"2654&'EBwMV=5PDBvNT?6Z�(3<o3<�
b)oEm�M-K4a(mCo�N.Ls$� k��lj"�!�� ��D~& � � S� !"&&54663!#3#3%3#" MzEH}O"�yy���!00G�pp�D{�{�|w�%XOO\' �� F H~& � �� F HT& �� F Hd& �� F�H�& 0 �� F�
H�& - �� F�
H/& & - �� F�DH�& < �� 2��'~& � �� 2��'C& �� 2��'T& �� 2��'�& h �� 2�'�& 3 �� 2�'�& 0 �� 2��'d& �� 2�
'�& - @��D� $ "&'732654&''7&&#"#46632�1P<!) 6@ V
+ \�3iQ\vRG=(S $ Y"$ 8V} ��b�Cg<eRx%ZA3R0�� 9T& �� �9�& 3 �� �9�& 0 �� �
9�& - �� �D9�& < 9� 3#5735#5!#3#�^'��E�||�K�� @��~& � �� @��~& � �� @��C& �� @��T& �� @��N& �� @��/& �� @��P& �� @��~& �� @�� y& �� @��T& @� � $ "&54667&&53326533267B1C fi�,./.��<# #;�2. 1!�w��`:??:��o�; 1 J �� @���& P �� @���& I �� @���& R �� @���& L �� @�
�& - �� @��v& @���B #"&53326536654&'7swww�-./-F ,
m AV������`:??:�." ,4 =B �� @���~& � � �� @���~& � � �� @���v& � �� @���T& � �� @�
�B& � - �� �
I�& - �� T~& � �� T~& � �� TC& �� TN& �� H~& � �� H~& � �� HC& �� HN& �� Hd& �� �
H�& - �� Hv& �� HT& �� 8 #~& � �� 8 #T& �� 8 #d& �� 8 #C& �� 8�
#�& -
�� 8�D#�& <
4� 3#5732#'326654&&##3#FFF�^�NM�Z)3M++M3ll*ED�pp�Gw(\NNY%�K I 6� 3332##53254&##I�[GsEFtE[Rw<;R�c'[OMb.{�h3) 2��0� "&&547!&&#"'6632'267#/JrAg?7"7D"]>NuABsL);�9 P�iVOe )P�kj�Q@UU@ A��,� "&'7326654&#"#36632i0
0+7�� G+:\6X �!YTq]&$�1�>#'A�z�� J�J� 33"&'732653J�y"+ �!P��t�
m')~��6[7 & A� 333"&5463233&�i )) ((6�i���|)* ** *�����|�� .�JW~& '��h � � �� =��/& � �� =��/& � �� =���& �� =���& �� =���& �� =���& �� =���& �� =��& =��n ) 4 @ "&54677"&&5467&&#"'6632#'#'26752654&#"@AC�;M)*C�2I(��42$I*43u@hxx %[!:IQ &P8=++{J#
6!+=��(D*SX
"&` &nr��8 (rR" �� =���& =� .� , 7 "&54667'##"&&5467&&#"'66323272675�1D ( %[02I(��42$I*43u@hx83! ?�!:IQ &�21 1#
: ((D*SX
"&` &nr��4AIR"�� =�
�& - �� =��& �� =��U)& S �� '��)& U �� =��>2& W �� =��F& Y �� =�
�& & - �� =��t& [ �� =��t& ] �� =��y& _ �� =��E& a �� =�
�& & - ��Q� 3 @ "3&&"&'#"&5467&&#"'66326632#327%3267&&55�({1M%F%;Jos"/4)Q(&;@$4F#�4$%'3 I��
7)�-65.�h("("P>NZ. ` )) AmA" 32_�
- ,�� ��Q/& �
�� ��Q�&
��)� & "'###57533#36632'2654#"RH? sBB���I#]k=bY)8[/-- B6)FHGL1I �nRt=x@H|.� �� H�D)�& <
�� C�#�& 2* �� C��#/& �* �� C��#�& * �� C��#�& * �� C��#�&
* "��z6 ! & "&5466323'53#'#72675&&#"3�Te6V/#2�o ? "2+"� �yQu> M��C3&x�CGIE�b� �� /�
�& - �� /�D�& < �� /��& 2� /��R� ( "&5466323'5#53533#'#52675&#"_s=b5*;���BBx H+'**<2 �uNp< M*LGGF��3$x�!?BC@�� 7��#/& � �� 7��#/& � �� 7��#�& �� 7��#�& �� 7��#�& �� 7��#�& �� 7��#�& 7� #� 2 "3&"&5467#"&&546632!3267327>+< �
3B# N|IJvBMh5�� L="=!138 ?�./]��21#8 =uRRt>?kD% 62Y".&B�� 7��#�&
�� 7�
#�& - �� 7��#& �� 7��#�& �� 7��M)& S �� ��#)& U �� 7��62& W �� 7��#F& Y �� 7�
#�& & - �� 7��#n& e �� 4�-</& " � �� 4�-<�& " �� 4�-<�& " �� 4�-<�& "
�� 4�-<�& " 1 �� 4�-<�& " �� 4�-<�& " �� 4�-<�& " ���� & # �e <���� �& # �e <�� H�
�& # - �� H�D �& # < �� � �& # 2�e �� H� �& # 9 � 3#57533#36632#4&#"HBB��� Q8SN� ) -)FHGL+` -l^�� 2.��� O �/&U �- �� O /&U �- �� O �&U - �� O �&U - �� O �&U - �� O ��&U - �� O �&U - �� O� ��&M
- �� O �&U - �� O�
��& $ -- �� O �&U - O �� !#5!�Z}s��� *�<�&� - �� L�I�& & 0 �� L�
I�& & - �� L�DI�& & < L I� 33773#'L����˟�J������H{�� 2�� �& ' ��<�� 2�� 6& ' � �� 2� �& ' 0C �� 2�
�& ' -C �� 2�
k& ' &�< -C �� 2�D �& ' <C 2�� � "&55'75#5!73267�]`U2��/z2�2 &!'? p^U1[K�t�D\^�.# l
�� ����& '�
���� # >2& ( ��� # >�& (
�� #�
>�& ( - �� H /& ) � �� H /& ) � �� H �& ) �� H �& ) �� H� �& ) 0 �� H �& )
�� H�
�& ) - �� H�D �& ) < �� �� & 3336632#4&#"'667#"&54632�x H1JE� !��'48
(47)8=W�@ -k]��!1-��"NE/3).7UKR} �� /��)/& * � �� /��)/& * � �� /��)�& * �� /��)�& * �� /��)�& * �� /��)�& * �� /��)
& * �� /��)�& * /� )� ! - "&5467.54663232672654&#"@0B+<e=GtBBsH`M&$ @43333333�21)<AoKSt==tScr"5 AJNCALLACN �� /�
)�& * - �� /��)& * �� /��A)& * S �� ��))& * U �� /��*2& * W �� /��)F& * Y �� /�
)�& * & - �� /��)�& * �� /��)n& * e /��Q� ) "&&5466326654&'7'2654&#",BsHHsB71 %l
B4#+HsB3333333 =uRSt=
.+#
07 =M!a>Ru=wM@ALLA@M �� /��Q/&� � �� /��Q/&� � �� /��Q&� �� /��Q�&� � �� /�
Q�&� - /��)
( 77&#"'7&&5466327#"&'72654'��!33P9. HsBK=.9/ HsB%F �33�� �Q��.7!W6St=&7/8 X6Ru=KR@!��� /��)/&� � ��Q� 8 72654&#""3&&"&&5466326632#3267#"&'� �%w� 2S12T3'=D"3E#�5!#3 H $K>kM@AMMA@M!.55.�h=uRSt=*11*AmA" 41
_'//' �� t $/& - �1 �� R�$�& - 0� �� t $�& - 1 �� t $�& -
1 �� a�
$�& - -� �� a�
$�& - &1 -� �� /�D$�& - <� �� 5�� /& . � �� 5�� �& . �� 5�� �& . �� 5�� R& . g �� 5� �& . 2 �� 5� �& . 0 �� 5�� �& .
�� 5�
�& . - =��;� 4 "&'732654.54>54&#"#46632 �)@"1* ./ ('�2eLAS) ./ 'N d
$3( ,(+ #<3��>c91M+$2%" &9,-K, R I� 3#57546632&&#"Ճ�.cM+L 4 ]}m
9]6 l
W��� 1��&6& / � �� 1�&�& / 2K �� 1�&�& / 0D �� 1�
&�& / -D �� 1�D&�& / <D �� 1��&j& / �� � 1��&� "&&55#575#57733#3#3267�O^)||}�y�Ҿ�27 0!O 7bA FXm��sXL
80 j
�� >��
/& 0 �� �� >��
/& 0 �� �� >��
�& 0 � �� >��
�& 0 � �� >��
�& 0 � �� >��
�& 0 � �� >��
�& 0 � �� >��
& 0 � �� >��
& 0 � �� >��
�& 0 � >� $� & "&54667'##"&5332673327�1D ( !Q5UL� ) ,�:1! ?�21 0# J%.l^2��1/!F�4A�� >��
9& 0 O� �� >��
r& 0 H� �� >��
i& 0 Q� �� >��
r& 0 K� �� >�
�& 0 - �� >��
& 0 � >��n� ! "&5332673>54'7#'#�UL� ) ,!)m
7*x !Q l^2��1/!F'&+/7 7D�7G%.�� >��n/&� �� �� >��n/&� �� �� >��n&� � �� >��n�&� � �� >�
n�&� - �� �
9�& 1 - �� T/& 2 � �� T/& 2 � �� T�& 2 �� T�& 2 �� �>;/& 4 � �� �>;/& 4 � �� �>;�& 4 �� �>;�& 4 �� �>;�& 4
�� �H�& 4 - � �� �>;& 4 �� �>;�& 4 �� F /& 5 � �� F �& 5 �� F �& 5
�� F �& 5 �� F�
�& 5 - �� F�D �& 5 < /��&� / 7326544'&&#""&&546632&&''7&'77�F13>9 6?rCqD>e:$C
0#�(w*2@&H"�(o@M<r�;>LK :��;lIHe6 -I KD<Y)ED8<�qP~H H�H)� " 336632#"&'#2654&#"H� G%\k>b6%>U(:,0..�u�M �sUx? Q�$FLCC� H�E � "&'73254&#"#336632q )
/ ) -�x T7TN!J� mQ2.���B .l^��7\7 *�<�� "&'73265#5!�.K + 15'�Z(d�i
36es�.<g? A�<#� , 33"&54632"&'732653"&54632M�I%11%&00� )
� M$%11%&00�9,"#++#",�l')�6Z7�,"#++#", ���z� . "&5#53327"&54632"&5#533267�RU\�$ !& (( ))�RU\�$
% p^�s� .# l
5* ** *��p^�s� .#l
B�<u/ 33"&'732653'7'7M�� )
� M��H�d�H�d��l')�6Z7�H�b�H�b H��"� % "&53366323267>54&#"(hxx &Z02I(��42$I*43u�IQ % !: nr 8 '(C*TW "&a &# H��)� "&'##336632'2654#"Q"F sx N+>Y0=cZ):^,, " 6�3$>pLVy?xDH�� H��'� , "&'##46632&&#"36632'2654#"S"G s+_N$:"+* G$\j=`Y(8Z-. !!6�:`;l(.L �oSt=xAI}� 4��� "&'732654&#"'6632�4j+<=%AQM8 : D i>I}LK $%] M@AL[ &=tSRu= C��-� + %"32654'67&&546632&#"6632#"'�*8!"')�r!!$P�L=] @2@AW/b*DO.V>F;�@ !��1A5!Y7St=% X+PD% -.E=*F*/ /�Vm� " / "&&57##"&&5466323'5332672675&&#" 7H#B#>]4=`5)9�$��),%83�*E(? >uQQu> M��S%"l�CGIE /��l� - "&5466323'546632&#"#'#72675&&#"�]p<`4';"K?
x
H)-$72 �yQu>M,H,l#%��3$x�CGIE 6��!� "3&&"&'73267!&&546632 X �
::1i*0!="=M
��:mLBqEI}�]/.�h X26 &Dk?>uQRt> /��� ! "&&546632373#'#72675&&#" >_4=b8&C sx K+)(<2 >uQQu> !3�3$x�CGIE�� n =� 7��"� "&&5467!&&#"'6632'267##Mj5S
G9"=!0+h1LwEHtH-:
� @mC% 51X >tRQu>p/1` ��o� ( 2 "&&'7&&#"'663273267#"&'744'326�BW,�
+ -1&S%DbKC
#">$4] � ( ) >h?y"]:6$8(F $: Jq@� H( 6 F��"� * "&&54675&&546632&&#"33#"3267=FpA>5.0>nF7j+5 H&91eCR75>E+I:.k #E326
; 2= ],c ]% �� 0�� �! /��"� + "&&546632'2654&##532654&#"<LzGLyE:`:(/39<h=$-,# ## 9FD 9tVXs: ?2":
:22E"p cHMRA *�<.� "&'732655#575#5!3#�.K + 15'���Z��(d�i
36�Fvs�L�<g? 1�>n� , 9 "&'732677##"&&5466323'46632&#"2675&&#" )g,1#I 82A">\3>a4&8"L@
�b(,%83� a."? >oGLq> #(K0m%#�3afE�C>=C /�<� , "&'732677##"&&5466323732675&&#")k,1#M 79H#>_4<b9N9 s�g+*%?7� d0"? >oGLq>?3� dpG�C>=C @��� "&&54>32&&#"3275#53QI|L.Oc5DX"B/(#@'H9$ \� j 8rW?bC#% X B5ELSb� & �-9� % "&54673366773'2654&'#/IW# ��R
R�� $WJ�PB&A0�� 4##4 �h1B&BP\ ) + ��9� # / "&5467&&#"'66326632&#"'2654&',Zn7.* *> )R%%S( >*(/6nZ "" #" ^X,\*k
%**%
k*\,X^w$ 99 $ <�H� 57#"&5332673} S8SN�!( -���_ .l^2��1/K�X H � ! 346632&&#"36632#4&#"H+_N$:"++ Q8SN� ) -�:`;l(.] -l^��2-�� H�E � . "&'732654&#"#46632&&#"36632i +
) -�+_N$:"++ Q8SN!N� m'*2-���:`;l(.] -l^��7\7�� H �' �� O .�&O
- O � 353#5!#3O�����s
ss��s �� � �&Q
- �H � ##73753y��Ͽ�F����� �G}�X�� 2�� �& ' =�w )�� � ) 354&#""&55#"&546325#5!3#3267� �]` RJ;.$�/��2 &!'?]& ��p^O?.,8zt��LU.# l
2�E � "&5#5!327�^_�/1 !-!'?�p^6t�P.#l )�<W� ! 33!#"&'732654&#"'7#)���WU?i>Hd#B=&,85+1����N�
lIIf5/"[ 82,1G�� y � 33!y� �s ��5� #'##"'#"&53327332675o
3+D
6+5:�s
�= +Q"/VJ\��-0O��-O �H5� 57##"'#"&53327332673�
-)D
6*4;�s
���a ,Q"/VJ\��-0O��-O�X #�E>� + "&'732654#"#4#"#3366326632�%
s
�o
2+D6*4; A�m Z-0��R-���> +Q"/VJ��0O0 ��E � "&'73265336632#4&#"> $x O4TL� # * H�l!%�B .l^�� 7)��4W4 H�Et� "&&54&#"#336632327&@I # *�x P4SL
%�4W47)���B .l^��%!l J � 333&&553#'&&'#J��
���
��<.\%���<.[&� /��)� "&&546632"3&27#,BtGGtBCsGGsCY�Y_� ;tUVs;;sVUt;�``��jj ��Q� % "&&5466323#3#3#'27&&#"�8f@@f8,"힀��� / !3& 8sXXs:tMcXtsBM7? �G?� # 5.5466753 4&'66�8b;;b8|9a;;a9�.&&.$.&&.��=oOOo=��=oOOo=��CJ"IDDI��J 4���� #'##"&'73267�x %i;!) % .Z �l=;
{6C 4���� "&'732673#'#�!) % .Z �x %i
|6C�Cl<< 4�E2� "&&55##"&'73266733267�=F Y0+ !$40�
.�/O/m56
|0(�("k
t�E$� "&&5336632&&#"3267IN^)x %i;!) % .Y 17 0!P�7bA�l=;
{6C�9/
k
t $� 346632.#"t8v]5T !! A-GqC { D;� J 6� 332#'#32654##J�9]79)��mGV('OV� G>:H���$ < J 6� 73254##33�VO'(^��)97]9��G�< $�H:=H � 5�E � 5 "'3267#"&55732654&&'&&54632&&#" (99
) XI?.e5)&41eXzjCm'B%T)"#4?MT"} ij^3\
K:EV+X+:)C] +�<1� "&'7326546632&&#"�1A *&& %XL.=%"+""R�
f +,�9^8 i
+,� 9^8 +�<1� % "&'732655#57546632&&#"3#�1A *&& ��%XL.=%"+"��"R�
f +,�E�9^8 i
+,�K�9^8 2�h'� 23#5#5354&#"'66�O^)}�y��27 /!P�7bA�m��s�80
j
1�E&� "&&5#57733#3267�O^)}�y��26 0!Q�7bA^m��s��9/
k
����X� "&55#57533533##'#'32675#�PIRR���VVx
K9 '� k]NE����K��E%,�5) b '��1� # "&&54675#5332654&'53#,Op:/ W� !2451! �W .:o >b5<Y s_%K94II49K%_s Y<5b> >��)� "&5332654&#"'632*l��2-/3
-Kd9q yv
��@:\P;8mcl^�N 9�
#'&&'##~��N N����&L''L&�� T� #'&&'##'&&'##33677Q� k
�L� ��%I%%K#��%I%%I%�� H+:Y� 9� 3>32&#"#'&&'# �;S=%(/ גS
I >V,p( -� �#K'%K%� ! 9� 353366773�Û6 4�Zk#?&&?#k��� F�Ez� "&&55!5#5!!327-@I ������
%�3P+
O.sN��t%!l F��M�
% %"2232654'67#5#5!6632##� �J �����* G+1:U\ � $��5.O.sO��EL76<V9 4�<� "&'732654&#"'7#5!2Oo(C H,5EA7 0���=[3Es�7%\&:4.4
G�sN�3U4Jh6 ���<j� 0 ; "&&5466323'53!#"&'732654&#"'7##'#7275&#"�,F')F+2 s k=D+P9.C9 # '$.nzY ,! " @uOOtA.[��O� kO?e; ^ 29/. Q���, x3�!EFFG ��N� 0 "&55#57733632&&#" '2654.5445#K�wDJz�!)(I 1$'"12"1qSB2#44#A@ l[�m�� O # +>.1G'm #!(6(�4) �<�� 4 "&'73265#327#"&55#57733546632&&#"r )
� 4$YMDKz�"PD#
!K�l')~�*%
k jV�m��3X6l')��6Z7 2 � 3>54&#"'6632�BM A8*FI$pMDsE+O59(:5 /3) ]'9/]G6QF'�� E #� 3.546632&&#"�5O,FsDMo%IG)7B MB'FQ6G]/9'] )3/ 5:(�� 2 � 35#5736654&#"'66323#͗L]PM=4,JI&tOBoCG0���E0\*/3) \(8.]G7`%K� 9 #� 35#573&&546632&&#"3#��L80GCoBPt%IJ,4=MP���E%`7G].8(\ )3/*\0K� C�H� #575#5733#3#㠠��������<FyF)��KyK�� /��*� + "&&546632'26654&&#"7"&54632,IrBBrIIsBBsI 6!!6 5!!5 ** ** P�zz�OO�zz�Pw,k^\i--i\^k,�( ++ ( B�J� ! "&'73265#'##33&&553z )
�8���8� D�m'E�6|:�����4:�6[7�� /���� �� /��/& � �� /��/& � �� /���& �� /���& �� /���& �� /���& �� /���& �� /��& /��n # 0 < "&54677"&&546632373#'#72675&&#"2654&#"4AC�;M)*Cu>_4=b8&C sx K+)(<2<8=++{J#
6!+=��>uQQu> !3�3$x�CGIE�� /���& �� /�
�& - �� /��& �� /��I)& S �� ��)& U �� /��22& W �� /��F& Y �� /�
�& & - �� /��t& [ �� /��t& ] �� /��y& _ �� /��E& a �� /�
�& & - /� (� ' 4 "&54667'##"&&54663237332672675&&#"�-?!
K$>_4=b8&C s3' ;�+)(<2�21 1$ 6$>uQQu> !3�4 AO�CGIE �� /�<�� �� /�</&6 �
�� /�<�&6
�� /�<�&6
�� /�<�&6
�� /�<�&6 1
�� /�<�&6
�� /�<�&6
�� /�<�&6
�� Q 4�&@
Q 4� 353#5!3Q��/�s
s��s �� Q 4/&@ � �� Q 4/&@ � �� Q 4�&@ �� Q 4�&@ �� Q 4�&@ �� Q 4�&@ �� Q 4�&@ �� Q� 4�&N
�� Q 4&@ �� Q�
4�&? - �� Q 4�&@ �� Q 4�&P
O� �� "&5467##5!3267_1D6 *�Z2*
?�21.?}s�3A Q� 4� "&5467#53#5!3#3267N0D4 ۱�/��2(
@�21.?s
s��s3A O .�
!5#575#5!3#���Z���Evs�K� Q 4� 3535#575#5!3#3Q����/���seEZs�Kes � �
# 3267&#"&&'#"&54632#5!� " $), Q5T_WO,*�Z 6-�/ !V><I
5s�% P3 Q 4� 353#5!3Q��/�s�t��s �� Q 4�&R �<�� Q P6&R � �� Q�4�&R 0 �� Q�
4�&R - �� Q�
4k&R &< - �� Q�D4�&R < Q A� 3535'75#5!73Q�T2��/z2��s�1[K�t�E\^�s �� ��&R�
��� �� i� #53#533353#533"&54632`\�NP\�^�� && &&s�t��ss�t��s.' '' ' �� Q 4�&R = w Q 4�
# 354&#"535#"&546325#5!3#3� x� OH;- �/���[&
��s�=+*8 |t��G�s �� O� �� J 2� l � 3!!l����|�� 9� 353%3'&&'# ������9
Y3��Y|�1n44n1 �� \ � �� 8 #� �� @ � &��2� "&&546632'2654&#"'53,NvBBvNNvBBvN3<<33<<� R�jk�OO�jj�Rtbbnnbbt����� J �
�� D R� I�
33#&&'#ıŜNM��t05f66f5��� : � �� B � B � 35!5!%5!B�pL�z�||{{�||�� &��2� @ � 3!##@ؓ���t�� �� K 1� ? � 357'5!!!?�������%Y��Y|��| �� 9� �� H� ��H� 5&&5467534&'66�g{{gtg{{g�5++544,,4U
�ww�
TT
�ww�
U_?Q
0 O>>O ��
Q �� F� C� 35&&55336553�et�Q|Q�te�tm�n=��n��mt� 9� ' 3535.5466323#5>54&#" d+ AvOPuA *d� 9669 wEZ6[�NN�[6ZEwj&FN3UmmU3NF&j O� 3'&&'#3#'#'
p
鳰�� �!p^-~J<<1X99X����t��[F �� � 3!#3#3'�:�����G^-~�|�{�|[F �� (� 33353##'Ń^��^�^-~����t��[F �� � 353#5!#3'�YYFYY�O^-~|�||�l|[F�� J N � ����2� "&&54632'2654&&#"''b=^5t\\tt\ % &�^-~ Q�l������`vOZ''ZOv`�F p� !53366773'\��(
)����^-~���(G&&G(��P�[F�� HN � �� :� % ) 3535&&5466323#5>54&#"'�R )3]??\3) R�$ %�^-~w2wTU�II�UTw2wj+GL1a__a1LG+j[F *��N� , "&546632373327#"&'#'2677&&#"�Xl;`5,I�
, 4>30 3/!7+ �yRu?+8W9�v&l
%-Rx?,V,+CJHC H�O.� 2 46632#"&'2654&#"'6654&#"H/aK7b>+*:O:Z0%O#b'8+*5), %' 9��Dl?'P?2J `FI^- &;t9 23'8k>*)'HDI�I$ �O1� >54.'7 36673� 9I*�42)0� -D2�$-"/���9 "j�GP�Z?nn|L.f* 5��#� ! - "&&54667&&54632&&#" '32654&')BoC-I+-D]a:{8!9j)2W@3E#<p�A,.:4'8B 6gG5O9 P91Im9) AO6Fj;�698=,>
E F��"� , "&&54675&&546632&&#"327&#"3267JNuA>4./>nF5j+6 H$82d"$++63<F L%:9g "D326: 2> _+i ^( V�E� & '6654&'.54675!#�s0D&H;"��=GE�?hM)=4VI �& ' 5T=_�Rtt Va`((2
7:Z A�O� >54&#"#4&'336632 & 0�� "M7VE�N��96(!%��X S(T*6k]� 7��!� "&54632"3.2667# ,n��nn��n, � ++ � , ��������^ SOOS �!VNNV! =�� � "&&55#5!3267�HR!�%+,+ H 2]?�s3th%.# l I��J� ! 34&'33>7 &&'U�&Yi= (I)DK"� E# X T'?#]:a@�$#1kb& &jD H8 "��@� ''&&#"'6632##���
3 2-Wh!��c �'%w
bn�N @�<I� & 3326733267#"&'##"&'@�"! /� %19
>$%
����5+")4:�v*m./+- <b8 /� 3.'7 36673�?O)�+' '0�1M9^��= "Zb_)V�UW��] ;�E� 7 '6654&'.546675&&54675!#"3267&&#" �s0D8^7(C'05 1)ԍ1<81( .:P B3=A�& & *L>+H5
E-2ss/)"8t8-"%
0'Y 3��%� "&&546632'2654&#",BqFFqBBqFFqB2002111 =uRSt==tSRu=wM@ALLA@M
��N� " "&54665#'665#57!#3267�SAz�
bK�R
& ]MJ\)X�c e�Rnt+bK l H�O)� 46632#"&'2654#"H@nEp~=a6"FV'8\+81��^x9�wUx? 9l7 FL�J?g /��@� "&&54663!&&''2654&#" Al@Fp> (?'&);gA).-*(0/ ;qRVq7yV8Gh8wB=;T?H@G 2��&� "&55#57!#3267�YF�J�� > cR�ms=r+ n
>��� "&&54654&'332654&'7&Nd/�1%/1�} 9dB!C! S(># c/-/LR-g@ 9x;�� �O?t # 5.5466753 4&'66�8b;;b8|9a;;a9�.&&.$.&&.��=oOOo=}}=oOOo=��CJ"IDDI��J )�CD�
'7373'#�����w[��ɑ~� V7 ����� � �OEt % 5.554&'3336654&'7�N[(�",{)*
�ol��@h>{ R)>#><*@
��FQ2hB :|>��� ��B� - "&54673254&'332654&&'7#"&'#�O_,"�%&-| �!)XQ":4 ��>�74>l>4A]"6++6"4)HC)BC'15yM��#**# I�F� $ '6654&'.54>32&&#" �s &5*QC(/Pg79\ C 0?RJC>E �& +
#8W><]@"# [H<=8#6)\ H��.� ) 6 ".5546632 '2654&#">54&#"G/[I,0cL5a=/)'?&?iD&6++:/#4R@B,*# <_D�Dk>&O?2O2M/G].0-(8
4=V%$2")'K 9��!�
, 7&&"&&54&'332667.546632�.RAC/*/lMa,�U *UwO-9b=Xy?z,"
hT/��4V4"1
4\#\U
-<>7X3X�n�� �� �O?t� �OA * 6654&#"5.5467546632i'/{:b;:.b%%*-,N1PX<`8,Y-GJH>3���?tSA�4U/Y3:L�Zn2�tSvA+U* �� *��N>& �� F��">&� �� A�O>&� �� =�� >&� � �� =�� �&� � �� 3��%>&� �� >��>&� � �� >���&� � �� ��B>&� �� =�� >&� J� �� >��>&� J� I�DJ� ( 34&'33>7 '667&&'U�&Yi= (I)DK"0,�%G D" X T'?#]:a@�$#1kb&#H= (W)&iC H8 0�O(� %2654&#"5.546632,42244223T1GsBBsG0Q3dPDALLADP��BgDSt==tSCfC-U- J�F� ! '6654&&'.546633&"#" �r &)9iCKM�(Z$>NBI>E �& *
8_HUp7y>G.8#6)\ t�O� !!3#t�������s�aL�S )�K*� '6654''7&&''7&'7� 4h9<�
x�<�Er_��
�2Z-" 5 {p/6H{oeLlv���1d �� ��'�"� �� �$�� 0�� ����� � ���� 3��/�*� � p* 3773�/`���� �.�> �[~� '1^-~[F �� h:�>J �� �(���E ���� "&533267gR?�' [L.bZ!m �� �8�# �� �8�# �� �8�! �� �+b� �� �.�> �� j-�m �� i-�j �� j-�l �� s-�i �� �3�Pn �� �3�Pk �� n=�� �� o7�!M �� h:�>J �� �;�GN ���� '6654&'7� $+\L&?�:J9,)4 ���� .5467Z%@&L\+$�4),9J ��t� '7<} ���� �[~�� ���� '6654&'7'7� %LH$6�<} �:J90#1 �� }��� .5467'7� 7$IL$
~<} � 1#09J7�� ���� '6654&'7'7� %LH$6�^ }�:J90#1 � ���� .54677� 7$IL%
C }<� 1#09J&�� ���� # "&&#"'66323267'6654&'7_! ?)%! ?){ &
SAE8 3$ 4#�/ ;! %& ����
# &&54677"&&#"'66323267O0EBR
%
! ?)%! ?)�&% !; v 3$ 4# �� O� J 2� 3!!32#'32654&##J���[EqDBoE_P;:;;O�|�#SHJ\)s+..%�� J 2� �� l �` �DL� 3#'53667>7!3#5!� �U� %
YO ���JBg%�(9:���\ev:Y^>��\ܼ� �� \ � W� - 3'&&#"'6632353376632&&#"####q -C&x&B- q�B%x%B[� �.C����C.� ������� .��,� * "&'732654&##532654&#"'6632%B�5N&S.6C=@WC>47,(B"K-r=tz*)1AEw ,1f#!.*)&m'#&" b(+^Q/K
P;C[. @ � 33373#5467#@�8���8���:4�D�t�:|6����� @ C&� E R� 33376632&&#"##E�:L"S7
!;˞�<���D2�#w���� ����� "&'732667667!##G"
[�W
2C �BGb�b�tE{Fmy0�� : � �� @ � �� &��2� �� @ �m �� K 1� �� 6��:� �� 9� ��F� "&'7327733773� ( . ݜL64E�� _ � ⾜���JV ��H� 5&&5467534&'6�lvvltlvvl�`1/4/1` Z ~rq{ XX {qr~ ZU{ C>>C �� �� F� @�D^� 33333#5@���K
z�����\ܼ - � !#"&&55332673�-!Mo;�:= '�.iX��D6�t :� 333333 �OxO�������t �D^� 3333333#5 ~KtK~; s�������\ܼ 9� 3#5!32#'32654##�� >h?<e? .0c|�*XGN^)u,2V " 6� 3332#'32654##3"�;[47\:
&+R ���)XHN^)u,2V����t J 2� 3332#'32654##J�VJsBEtISJ:A{J��)XHN^)u,2V ��!� "'73267#53&&#"'6632��ZNE+>M
�� M>%; N$n@S�NP� `\$KT{IC ^"3K�ts�G ��D� " %26654&&#""&'##336632� I\1��2
[G]ees%]TTZ""ZTT]%�������~���� � !5##&&54663335#"�I���8FDrE��LL:==��^LNX%�t`�&001 �� \ ~ ] �� \ N a ��:� " "'732654&#"##5!#6632�*
+$ ����%3Y6)F
p 631��||�+_NNY% �� l ~&� � 7��9� "&&546632&&#"3#3267gU�QT�T?d!N8#;V��
SC(?NR G�st�K3"^ CI{UJ$\` �� 2��'� �� J �
�� J N � �� ;��� ���E� # + "&'732667667!32###%32654##+
7U15[8|2!9%$'L �6;i�Z�(XHO^).VfFYh+�,3U E� 3335332###732654&## �V�7U13V6�V� #!# ����(XHO^)��u(7/& 8� 5!#6632#54#"#��#Wh�H �||�Ye��H���� E R~&� � �� @ ~&� � �� ��FC&� ?�D� 3333##5?���� z����t�� <� 3#53533#32#'32654&##�ww���%GsEBqG*!8;:> �u``u_"OBN\'r(2+% &��2� "&&546632"3&&267#,MwBBwMNvBBvN-; � ;-/<�; N�no�KL�nn�N+KJJK�NVRSU o� 33366776632&&#"�ŜO
%NH y���6e66e6�\S�# �2 l 8 3!73!l ������� 2 �
3#57!!3#~LL�����F(|�K�� �De� 2 3'&&#"'6632353376632&&#"3#5####q -C&x&B- I6
b'B%x%B[� �.C����C.� ��\ܼ���� .�D,� , 5&&'732654&##532654&#"'6632�3`)N&S.6C=@WC>47,(B"K-r=tz*)1AdP ��+&f#!.*)&m'#&" b(+^Q/K
P;Qb� E�D]� 33376632&&#"3#5##E�:L"S7
!;�S s*�<���D2�#w�\ܼ�� X� 3#5!37>32&"#"##��13'3
,��p1|��03�$|���� @�D^� 333533#5##@���K
pa������\ܼ�� 6�D:� 5.546632&&#"3267!Bj?S�W>d!Q7$E[]I#;Q7T ��S�^l�Q3 [pbdp YB� �� H� H� 35#57333667733#�_��B B��r��Fq�%I''I%���K� �DU� 333667733#5#'&'#���?
:��vW p7G DO={4 4{���\ܼ�0; 3� ,�D\� !#"&&553326733#5~+ Lm:�8:&�K
{.iX��D6��\ܼ > *� 336632#54&#">�+!Mn;�8> '��.hX��D5�� �� J �
�� WC&� �� OC&� ���� S� M �� \ C&� �� 2��0� � �� @ /&� �� &��2N&� �� &��2� �� ��F/&� �� ��Fy&� �� =��� <�� � - 32654&#""&54>76676632�91+*.(8kv�.TsF.2 @#4I-L*5W5<jTTI>B7#
�ګ�o�T*
� 80 3fLLs? T #� # 332#32654&##32654&##T�;_8(,/8;b;gQ*$$)R^-%',]�92 ; 623? /�� t � 3!!t����s�� �TF� 3#'53>77!3#5!��n�
uO~��
1J
�` KF��`��� �� 7��#� V� - 3'&&#"'6632353376632&&#"#'##5#q
-C$ p $C- q�A*p*A <�);i��i;)�<������ 0�� � ) "&'732654##53254&#"'6632=o;9)T"F>[xoS2>+H)62m=Hn=%375Dv *] 0c/_! >2 :
722E" I � 33366773#5467#I� # ��� " ��%].;��&\.=�� I �&"
M F� 33376632&#"#'#M�N. I5
��vO�[?) � ;���� ��
� "&'73267667!##I
v�o
R �"(J�J�}7o7SY % 3� # 33366773#54667##'&&'# %�; 7��
6Q9 � 66 ��OP !J �� L PO H � 33353#5#H���������� /��)� * H � 3!##Hȓ��}�� �� H�H)� + �� C��#� 2 &� 3#5!#��}ss�� �� �>;� 4 �HB� # / : 57#"&546632'536632#"&'275&&#"32654&#"�&CO*C%#|->J*D'$� ! � �K �yQu> H��L �sUx? H$� DGIDFLCC��� % 2� 3 H�TI� 33333#5H���O~�}��`�� @ � !5#"&&55332753u(#>`6�-4$ ��'YJ��.)� # 5� 333333#�IxI��}��}� #�T_� 3333333#5#�FuF�;q�}��}��`�� 3� 3#5!32#'3254##��&<`88`<& NN }s� H>@L p<9 & 2� 3332#'3254##3&�$3Q00Q3$ ?? �� H>@L p<9�� Q *� 3332#'3254##Q�i?d::d?icVVc� H>@L p<9 5��� "&'73267#53&&#"'6632�4m'7F#>R ��
L:F2? g:NLI $V17c2+#U#9sXVt: ��D� %2654&#""&'##336632� !C^ 4��5]ATddk=PP>>PP=wec��_a���� " � !5##7&&54663335#"{Gm��)97]9��VVO'���H:>G �< $ �� 7��#/) �� 7��#�- �<&� * "&'7326654&&#"##57533#36632=%
,* (�BB��� H1\a9h�l)j`MX$��*EHGK,^-����E�� t /& �# C��!� "&&546632&&#"3#3267[PIP�O9[!?;"8N�� R>%D4*j :tVWs: Y,1c71Y% �� 5�� � . �� O �� $ �� O �N �� *�<�� % ���@� ' "&'73267667!32###%3254##. 4S11S4�3
DJJ � -G�P� H>@L }>}>EK|<9 $ ?� 3335332##5#73254##$�O�6S//S6�O�CC H>@L ��p<9�� �I �� M F/&$ � �� I /&" � �� �>;�&-
K�T
� 3333##'K����~�}��� 2t 3#53533#32#'3254##������&<a88a<& OO �tWWtW I>@K p<9�� /��)�� % K� 33366776632&&#"ֱ�K
EA ]��%M''M%HXV|# �� x � 3!73#x w ��� / �
35#575!#3#�SS�����E�srK� �Tc� 2 3'&&#"'6632353376632&&#"3#5#'##5#q
-C$ p $C- @>a%A*p*A <�);i��i;)�<�`������ 0�T � + '&&'732654##53254&#"'6632�+S,9)T"F>[xoS2>+H)62m=Hn=%375bO�� ] 0c/_! >2 :
72=J � M�TR� 33376632&#"3#5#'#M�N. I5
_Xl3vO�[?) � ;�`���� S� 3#5!376632&&#"#'#��3 E0
��h3}s�[A'� E��� H�TI� 333533#5#5#H���O~V���`���� C�T#� '&&546632&#"3267YsP�L;` D77@PN='A; B#���hSt=& ['LA@M ] � �H9� 53366773�ǔP
P������'F$$F'�� �H8� 5#57333667733#�M'��P
P��n���E��'F$$F'�[K� %�TA� 3'33667733#5#'&&'#%���3
,��Za|#9
1�P+,P�~`��R,+R @�TJ� !5#"&&5533267533#5h% <]5�*1�O}�'UF��('��`���� H � # �� V�&
�� 2�� � ' �� =���&
�� ��Q� �� 7��#�&
�� 7��"�� �� I �&" �� /��)�&( �� /��)�� �� �>;�&- �� �>;
&- �� /��� �� /���&e
C��� $ 0 "&&5467&&54667>7'32654&'%?f=]G+D5bB:@$C"CA!;%DL<l�:'(;-#4@ 6dDTd H-49 �
,jQEj<�49;>+;
F�� Q 4�? �� Q 4�E �� Q 4�R ���u� ) 5 A E "&''26533&&554632"#&&'#"&54632'2654&#"53
�e
-1
�a -�1JJ11II1J� q �{3[z1_@Cq ��/[z1_@COXWQQWXOZ"+,"",+"�NN ��J� 2 = 6654&#""&&5467&&5466326673&''327&&'�
%D]0?*'I1JS%8 = �, 3(#CG%Y}1( "@
�%. '��3U2AS &G /M/PD)A4 ; K+;n3 w. "�%. C$% 8�� � ' "&54632'26654&&#"7"&54632,n��nn��n 3 3 4 4 ,, ++ ��������r(`RS\&&\SR`(�*"#))#"* O { 353#566733O��AN%l�wo[
��w 3 � 35>54&#"'66326633:[�L62&?O2hICd9Aj>?�TM}i-/1'O232[=5oo6| *��� * "&'732654&춮&#"'6632Rv%D P+4C"SK^M2,%A!J/l=Ej;@9<RFs 2(] $'$ )h/&!% Z&+)M81FM>;S+ # .{ 35467#5!533#��$D�� �PPk O 6�n�e~��p� .��{ "&'732654&#"'!!632Rt'B I-6EB2 , A��� (,;c<Fq 4%]%2102*A|w*WDFd4 <��!� + "32654&".54>32&&#"6632= < B%&;4*1\I+.Mc4Df M< 'C*"S$8X4?h% "L9161+��$LwTY�T)- X&WK!$*WCB_4 > { 3>7!5!�+D2���<K(P�wt?|ZCv{�] =�� � & 3 "&54675&&546632654&#"2654&&'+n�G1(58a?_q5&2E8k"0.,#1G,8'D.#B aM;I H26O*_O,GLA2P.~,1%-$%',��'( % 3 */ 5��� * 3267&&#""&'732667#"&&546632�4+ = A&%<NCg!N= 'B+"T#7Z4?h=BuJ-Na�1+ "K91� . X&XK!%*WCB`3A�pY�T) 8�� � ! "&54632"6654&&267,n��nn��n(� 3 '� 4 ��������*��*Va'�@ )Uc* O {
353'733O�`H�t�wBCQ���w 8�� N ' "&54632'26654&&#"7"&54632,n��nn��n 3 3 4 4 ,, ++ ��������r$TGGP!!PGGT$u*""**""* O B 353#566733O��AN%l�w6[
�5w 3 N 356654&#"'66326633:��62&?O2hICd96^;?}TY�8/2'P222\>0\W+| *��N * "&'732654&춮&#"'6632Rv%D P+4C"SK^M2,%A!J/l=Ej;@9<RFsZ2(] %,( *h2*!( Z&+*O84IMA=W- #��.B 735467#5!533#��#C�� �PP�w N 7�Z�e���p� .��B "&'732654&#"'!!6632Rt'B I-6EB2 , A��� &;c<FqZ4%]&7552*I{� *YGIg6 �� <��!�s >��B
>7!5!�%NC���<K)Nm��V{ZD{��` �� =�� �u 5��N + 3267.#""&'732667#"&&546632�4+ > $0%<NCg!N= %A,#S#7Z4?h=BuJ-Nas55 $9@2��- X %YM"$.^FEb4A�p_�Y+ 8�� N "&54632"654&&267',n��nn��n%� 3 %� 4 ���������
�#.JS#�y�!-JX% O B
353'733O�^H�t�w AQ��5w 8�� � ' "&54632'26654&&#"7"&54632,n��nn��n 3 3 4 4 ,, ++ ��������r*dUV`''`VUd*�*"#**#"* O � 353#566733O��AN%l�w�[
��w 3 � 35>54&#"'66326633:\�L62&?O2hICd9Aj>?�TMk.47'O235`A6qp7| *��� * "&'732654&춮&#"'6632Rv%D P+4C"SK^M2,%A!J/l=Ej;@9<RFs 2(] $)' *h2'$& Y&,*O93IP?=T, # .� 35467#5!533#��%D�� �PPq O 7�_�f���p� .��� "&'732654&#"'!!6632Rt'B I-6EB2 , A��� &;c<Fq 4%d *4424+I|+YEHe5 <��!� + "32654&".54>32&&#"6632= < B%&;4*1\I+.Mc4Df M< 'C*#S$8X4?h. "O>383.��%NzV\�V*. X([N!%+YECb4 > � 3>7!5!�+D3���=K(R�|x@|[Cz�` =�� � & 3 "&54675&&546632654&#"2654&&'+n�G1(58a?_q5&2E8k"0.,#1G,8'D. "B dO<K K38P,bP.JPB3Q0�,6'/''(.��)* & 6 +2 5��� * 3267&&#""&'732667#"&&546632�4+ = B&%<NCg!N= 'B+"T#7Z4?h=BuJ-Na�3. "P;2��. X'\N!%+YEDa4B�s[�W* 8�� � ! "&54632"6654&&267,n��nn��n'� 3 '� 4 ��������:��-Yc)�0,Yg+ O �
353'733O�^H�t�wUBQ���w ���� � "&54632,4@@44@@ D12DD21D ��'� � '66'#"&54632�%CA*BB.>>j�VI.51/8[Q_��� ����"'� C � �� ��'�"'� C � ����Y � # "&546323"&546323"&54632[)33)*22�)33))33�*22*)33 8()77)(88()77)(88()77)(8 ���� 7'3"&54632��0+99++99�����9-,88,-9 �R�� 73"&54632�`I+99++99�����8,-99-,8 b���� & 7&>54&#"'6632"&54632�+. * 0R$c;:\7!/. <+99++99�(<.'& K(2$H7(7+)2#��9-,88,-9 g�F�� & "&&54>'33267"&5463249]7!/. �+. + 1R$c5+99++99�$H7(7+)2#(<.'& J(3�8,-99-,8 �/�� ''3�#�#/푑� R/�'��{ � � �"�� "&5467632-7>WX&48
(36"TLR}(ND02).7 �"�� '667#"&54632�'48
(47)8=W"NE/3).7UKR} �� 3"�'��{ � � �� E"$�'��{ � � �� �� �� ���� E�$ �'��{�� � ��� �"�� &&54632#"'gWW=8)73)
84"(}RKU7.)3/E � �� %'57Z��>���7�� � �� 7'7'7�>>�7��7���� * �'��{ � � �� ; .�'��{ � � �� F~� �� F~� �� F~� P �6 75!P��oo �X6 55!X�oo P �6 75!P��oo�� �X6� �� � ���� � � e�� %"&&546632,.K++K./J++Je*I..I**I..I* v S�� %"&&546632'2654&#",4S//S45R//R5,77,+88S/R23Q//Q32R/K:..::..: � r�� 7!�.r(�� � `�� 7!%35#�R����`L��F� z r�� 753z��rD�� Z `�� 753%3'Z��ղY`x��F� � T�� 73�D��Td�� � 4�� 7377'�y��C��4���yYZ z R�� %5!*�d�RD�� Z 0�� %5!'7#*���Y�0x���� | T�� %%5%3���DT���� Y 4�� %%5%3'5��yF�4��\y�Z � k�� 7!'26654&&#"�<�*B&&B**B&&Bk6�� %A))A%%A))A% �XJ 55!X��� <�\ �� 5!<�nn <�� �� 5!5!<� �^^�^^ >I� 5!>�ISS �c���� "&'7 32667,x�g&A��??��A&g��=?C$++$C?= ��M��
&&5467�arraRYQQY�V捍�VAW�wv�W ~�M��
'6654&'7�RYQQYRbqq�AW�vw�WAV捍� �h�� !#3�(���\N�@N h�h�� 53#5!h��(�N�N�� j�h�� / "&546654&&'5>54&&54633#"33�`Z<66<Z`M)>(/55/(>)�=Q$53 !V" 36#Q=N *(O,93 39.L)* N i�h�� / 532654&54675&&54654&##532#i)>'.66.'>)M`Z<66<Z`�N *)L.93 39,O(* N=Q#63 "V! 35$Q= J�`� 3JI{���f�� �m� 3�� J�`� 3���{I�f�� �m� 33낂����H0��H @ [6 7'7'7737'�@a�� N ��a@t[,�DG+��+GD�,� Y���� 5'37'� �� v �� Pv �� v�� Y���� 75'75'37'7'� �� �� v �� �� P� v ~~ v �� v ~~ v � G��� 1 > "&'732654.5467&&54632&&#" 654&&'7j"T3< &=C=&-%
^T:] D86'?E?'+) b� 4= $6O(%T)+K3 +A/&D)DU)\ ' -@-,A&C[�!% ( 0���
%"&&5466333 AnAAlA*4��4hLTb)�9���$ �� w���&Ȍ �t �� >���'��v � � ��D� $ = I 7&>54&#"'6632"&54632&>54&#"'6632"&54632N % A J'?V! 4+99++99� % A J'?V! 4+99++99�/G;7
T I>+@314!��9-,88,-9 /G;7
T I>+@314!��9-,88,-9 <��D� $ * 6 %&>54&#"'6632"&54632'3"&54632f % A J'?V! 4+99++99���0+99++99�/G;7
T I>+@314!��9-,88,-9 ����9-,88,-9 �� � $ * 6 7&>54&#"'6632"&54632'3"&54632N % A J'?V! 4+99++99��0+99++99�/G;7
T I>+@314!��9-,88,-9 ����9-,88,-9 @���� ( 7''36654&#"'6632"&54632�
v%<,&< Q(v<Af;$54"8(44('44��\\(1((+ K.1(J41D1%$��7))77))7 \�F� ( %#753267#"&&54>'2#"&546q
v%<,&< Q(v<Af;$54#8(44('44�\\(1)(+ K.1(K31D1%$ 7)(88()7 � �� 3!#�(��N�� h �� !#5! �(qN�A �z�{ 33�p���MN h�z�{ 533h�p�N��� ��h�� !#3%3#�\����11�\N�@NN� h�h�� 53#5!'3#h��\�11�N�N��N� ��� !#�'��N�� h�� #5! �(\N�V �h� 33�p�����N h�h� 533h�p�N`�R ��E� ; "&&546632'26654&&#"7"&&546632&&#"3267,L�MM�LL�MM�LAb66bAAb66bM2N-1O-'57 %'&!/7 Q�gh�OO�hg�Q=D{RRyCCyRR{DK0Y<;V/ =
>,3<
D ��E� , 4 "&&546632'26654&&#"'32##53254&##,L�MM�LL�MM�LAb66bAAb66b:�+F)*F*< Q�gh�OO�hg�Q=D{RRyCCyRR{DWm901@ [�@ e7�� ) 2 "&&546632'2654&#"'532#'#532654&##+6Z66Z67Z55Z7?QQ??QQY#.*< 74[;;[44[;;[41SFFSSFFS8� " M<<d ��jR� 5#53#333773#57##'#BO�Nqg""gT 5:6 j�WW�:^GG^��`s��s` ��^R� & : "&'73254&''&&54632&&#"733773#57##'#k!7 2# *%>7 8,") Bng""gT 5:6 ^< *&);=
(%(? :^GG^��`s��s` �m&� / 9 ".546632#'##"&&5466754&&#"32672675S<oV3R�QLa.N <)$:!=pL :-/Z;=a6-; **U$F9 �1b�f��SAoE��3 #&?'6E( %@'>�nh�CI K\ $! ��&� 0 : ".54>32#'##"&&5466754&#"32672675S<oV31Vo=I^-N <)$:!=pL?>#G<$=a6-; **U$F9 *T�W\�T(;c<��2#&?'6E'
)? =eHTo6I [
$" F � 37#7#537#53733733#3##7#�i
h�KW
P\TiTOZT_Uhn�y�^n^����^n^��� T� '7'7737'�@R�� N ��R@e,�8H �� H8�,~ | ��6 75!|`�oo�� | ��6� �� | ��6� @��� ' - 3 '7&&'77.54632237&&' #74&'27" W 'L @3)N2wdX"7I *O47iM` J� Es
�
#dr)@1L[�
� $T h*A11P.�
a, Z �� l�
� 2�� �x��� 2�� �x�
� 2�� �l�
� 2�� �x�
2�� �l�� 2�� �l�
2�� �x�� 2�� �l�
2�� �l�
2�� � �X 2�� � }X 2�� �ol� 2�� � �v� 2 �:� � "&54632'2654&#",KbbKKbbK )) **�nbbllbbnR8FE66EF8 ��F� � 535#566733�ym08 Ui�Z�C��Z ��F� � '6654&#"'6323�Yf# -$=>aEUD8��9A]$ !08QF>0S1Z ��:� � ' "&'732654춮&#"'6632*7XA. &25*/!&= I1'B(B&+-I�''3>7# 0"< 1#$6 ��F� � 53533##5��Ok\_::_d6'�ddGVV ��:� � "&'732654&#"'7!#6632*7WA. &. - �
%>&[�''3" �[7 9(:M ��:� �
$ "32654"&54632&&#"66321$)"4T]f[/:*$.01=G'C
)$6�p\^tD
71B9'>$ ��F� � >7#5!� 2#�:.3�=_[4[::fkA ��:� � $ 0 "&54675&&54632'6654&#"2654&',HX,%#!V=@SE()X7 " "/!"�@."3* 29929 3%.A� �
��:� � % 73267&&#""&'73267#"&546632�! #(#%.=*%/.1=G'D*T\dQ
)$��D 71B9'?$q\]t ���& .54667J'11'O/))/��/U]<<]V.(?uA@v? ���}& '6654&'7 P/))/P'00��(?v@Au?(.V]<<]U �=l�� "&54632,%%%%�$ %% $ ��v�� '66'#"&54632�&(''HA��7
# "a9Q ����D "&54632'2654&#",@TT@@TT@ \MNYYNM\O'33%%33' � �8 !5#56673Q&*S�@�� � �D 356654&#"'66323�>T > A(;G2 \7)L#8 $:3"A W ����D % "&'732654춮#"'6632- F#)-#& '#*E(2E # N B 7 >1(!
& ,8 � �D 7573533##5�`LMA^33^=3� �XXB== ����8 "&'732654&#"'73#6632."D#)++Յ
2;L B �X#3..@ ����D " %"3254"&546632&&#"66321
$ GO%I6 7*
&"'.6G� �^I-M/= ."0..B � �8 3>7#5!�& �&(-HE'W8+MS5 ����D $ / "&54675&&54632'654&#"2654&',;K' J35I #K.
6% ! )22)
$$%6�
�
����D # %3267&&#""&'73267#"&54632%
#!6)
&!'-6G6GO%I� ��<
-!
0./A^J,M/ ���� &&5467B3993OS+(Y8xOOx70am7i/ ���� '6654'7O)*SO399Y0/i7ma07xOOx �l z "&54632,%%%% % && % �}v z '66'#"&54632�&(''#%A�8 $ #3/9P �� �+�{
7�� �7�o 7�� �7�{ 7�� �+�{
7�� �7�{ 7�� �+�o 7�� �+�{ 7�� �7�o 7�� �+�{ 7�� �+�{ 7�� � ��� 7�� � ��� 7�� �.l� 7�� � �v� 7�� �o��) �� �o��J �� �o��7 �o�� " "&5467&#"'6632#'#'2675�2<ep93%#Q*DNS:#?2o<(3?+DIM�$N 8 �o�K "'##36632'2654#"O0) Qh/>H)A>#8
o+#�u2\L8P*T+1U�
�o�� "&&546632&&#"3267[2P/4U1"50
'//$ )@o)M67M*@ 1)(1@ �o�K "&546632'53#'#72675&&#" @L)A$ &gT0
$ o\P6N*1t�, T � )./+ �p�� "3&&"&&546632#3278*�#3T10N-ON�5%**" Gz ��(M74M+\B" > �w�R 5#5754632&&#"3#JJGO 3#<oow�M
8L K3
Q� � ��� + 7 F %"&5475&&54675&&5466323##"'3322654&#"2654&##"&' @W4(B% �AP;
6<BGlV &1 ( ,�(+'
, (5K :4
(,4C0�
�w�K 36632#54&#"�h5$83hw�u= I>˾ � �w�k 5#53"&54632&}�7 && ''w�Q��v" $$ " � ��k 7"&'732655#53"&54632� 0 "~� D) && ''�
I #�Q��(E*�" $$ " �w�K 3373#'�hqr|�pQ-w��~��~-Q �o�K "&5#533267zC=E�
&oL>Q�� P 0w"� ! 3366326632#54&#"#54&#"0T.""-
2"73h h wJ+ "J=˾ ܾ � �w�� 336632#54&#"�U5%83hwJ+ I>˾ � �o�� "&&546632'2654&#",,L//L,,L//L, o)M67M**M76M)S1()11)(1 � ��� 7336632#"&'72654#"�U3>G)A%(4#8
��!\L8P*3_�+1U�
� ��� %57#"&546632373'2675&&#"]-@L)A$ *Q�
$ �c0\P6N*"�>� � )./+ �w�� 336632&&#"�V@#
6wJI)(W#,� �o�� & "&'732654&'.54632&&#" ,)T /5 0 4"PF+E/,0- 5#Ro? &/: =
% .> �o�" "&55#57733#327mPBEJ
W��!" 4oQAoMaaQn% J �o�� "&553326753#'#�83hhU5oH=� ��. tw��
3366773�yh0
0cuwJ�33��� &w� 337733773#''#xRf &S( _Ox wI�dd��dd���ZZ |w�� 7'3366773#'&&'#|oho lioo" w��4
4��4 4 � ��� 7"&'7326773366773� �h/ (ctC�M@�//���@> �w�� 57#5!3���#��w7�Q7�Q �p��
" '7"3&&"&&546632#327:}Fl7*�#3T10N-ON�5%**" G�nD�� ��(M74M+\B" > �p��
" '7"3&&"&&546632#32704kGv*�#3T10N-ON�5%**" G�2�D� ��(M74M+\B" > � ��� 2 "3&&"&5467#"&&546632#326732678*�#'". 3T10N-ON�5%("1
*z �d""&(M74M+\B"
= (/
�p�� "&54673&&#"'6632'267#'OP�/#)" G 1N//M0 &�%p]C" >)M74M+N !! �w�N 4632&&#"6632#54&#"�CI. 5$83hwR:K L? H>�� � � ��� % %"&54673366773'2654&'#/1:hh*
)ce91
�6,- �""��� -,6@ �w�M 5&&546632&&#"1@/M-3H3+ +3?w�$I7.< "A !7$� �o�� "&546632373#'#72675&&#" >M)B%2& PT2
$!o\P6N))!�� T � )./+ � ��� + %"&'732677#"&546632373'2675&&#"H #3$#->M+B#,S\A
%"�C
&\F2K) ��@D�
p )(') �w�k 535#533"&54632�tf�j� && ''wQ�Q�Qv" $$ "�� �ol�' 2 ���@ 53ب�HH ���= 5!�
�AA >�= 5!>��AA $ ?4S ) 7'7&547'76327'#"'72654&#"mIQ"!PIY0642YIQ"RIZ46/e$22$$22?JR.A?.RJZZJR-@!7RJ[ N5-,66,-5 @�� � + 773254.546753&&#" #5&&@@/W/J*CJC*XLb4M I#?)E*BKB*WSb1hsd !- *>.AV ��+ T. )>.?]��) C &� ) 356654'#57&&546632&&#"3#!C4BpT ;gB>Y#O, 07�� #[P5
V)?\2*'P.0$[
$4| 9{ 35#535#5333667733#3#⩩����= =�������F7F%�!B !B ���F7F� -��G� 1 "&'#57445447#576632&&#"3!3#3267}f�?67A�j3_%Q4 2B�����D1#6Q(e vqD Eny(&O<8J
J8= L,0 `�� � ! 5&&5466753&'66757av8a>Q'?C $; E"�%#$$)_
�mGhB
a] Z�� ] _\-A�@ .��&� & "&'7>77#5737>32&&#"3#�!2
WK /VE; &'s'Q` l=9�e+I[+ n+#7k�<a9 O��3� / 5 "&7&&5467722327&&'667'7&&'o 13�JY�m 2 3
7(Q
0)Q%X5 3 4")%&�c ���s!�u��h\fl*O �kL(.c\j�a8]e C &� 0 35667#573&&'#57&546632&&#"3#3#!C.?pOZC;gB>Y#O, 07����#[B,D
E ?\2*'P.0J
J*| <{ # ' + 3'5#575#57533533#3##'#73'#'3'#3'#� "*SFFFF�TPjEEEE�TP� #�>1�0=
zz���626����<2<���m|<222 K{ 3#575323###3&ೃ#eQQ�;dC
CB
De:,�
6,"",7
�|U� G=[9I#� H&"�'" P{ ! ' 3'#573373333###'377#377#*� KD �#w&w ?E �A
� ꉉ�"9������?��"��h�((��(( [ 2� ) - %"&5466323'5#53533#'#'2675&&#"5!N]4P+$0��yHHd ;#" 2*��tc[8P+CJ11D�n%ao +&/-�JJ K{ ' , 1 3#575#575323#3###4&'#364'3Ň#eQQQQ�O|K??K}N,����| >""> }Y5.5�9F;
;C?��
- }##�& C��� # 5.5466753&&#"3275#53&Bf;9gCbU=Q4 AGK@#L� I)nf P�_\�U
he@Pqegm
zx��$f 5�� � 6 "&5467#57367#5736654&#"'66323#3!327Gko<J �J�# 3F#W>\l Dt ���
%(AH=)p gU E D
O'0_R J K
%<^(( O��3� ! 5.5466753&&'67CGn?=nIQW@Q"+#Q!O/�3.01nd N�b_�T
][ AO
�Z
(L$-e�Tk�l Y { 75327#573&&##5!#3##'YIt�Q�
F7I��:MK H6����uGD uJ#?J@Q�� ��'{ 5'75'75377>54&'7yD#gD#g��#��#�*H,yg� � @17!@2�~E@V7E@V�"8# [|= # 5{ 35'75'75#5!#77�q#�q#���q#�q#��7@H77@H�kks7?I77?I� # 5{ 3#57!#5!�g�����EK�L1JJ 9{ ! 35#575#5732##3#32654&##�mmmm�ClACm@=��74::47�E3D'&QAAR%2K�U7.50 4 { 35#57!!3#3#�LL����ݏ�aU�|y{PZa Gp 7'77'7\K�3�3�K I�/�0�I�� Gph �� Gph �� ��H�'
��D &h
��F� ' 3 ? K "&54632'2654&#"'%"&54632'2654&#""&54632'2654&#"�6II67II7 �&�X6II67II7-6JJ67II7�H<<CC<<H? '''' �,�^�QH<<CC<<H> ''&' >H<<CC<<H> ''&' �� Q|' �qD &h �� G|' �qD &h � �� Q�'
�qD &h �� ��G|' �qD &h
� ��
��G�' �qD &h
� �� ��G|' �qD &h � ��
��G�' �qD &h � �� ��G�'
�qD &h � �� ��G�'�qD &h � �� ��G|' �qD &h � �� ��G|'�qD &h � �� H|' �qD &h � �� ��G|' �qD &h � �� ��G�'
�qD &h � �� ��G|'�qD &h � �� ��G|'�qD &h � �� ��G|' �qD &h � 5��F{ ! - 5#56673'%5#56673"&54632'2654&#"�Q&+S��&�@Q&+S�6JJ67II7��@�,�^�]�A� H<<CC<<H> ''&' �� ��G�'
��D &h
� F ^6 75#53533#���l��^�h��h� F~ 5!F�hh T p# 7'7'77'�I��I��I��I�pJ��J��J��J� F IK "&54632"&54632%5!,"//"#..#"//"#..����+""++""+��+""++""+�hh�� � ������ ��� F ��&� t � ��� F -g'� � &� � � t �y %%5%��~��� �f���� b �y 75%5%5b ��� �����f F 0
35!5%5%F�4̬���hh��z�y."". F 0
35!%5775''5F�4�����hh�y."".y�z F 6 75#53533#5!���l����̞�h��h��hh V� 3#''#V�v�y.--.��t���� F (l 77#537#5!733#3!XGY�I�H]GY�I��H(zg�gzzg�gz 4 �$� %".#"'6632 3267� /%$'X U. /%$&X U� )))NC (*)NC�� 4 v$ &� t � � F ^~ %5!5!����^�h�� F ^~ 7!!F��^ h� I ^D 7546632#54&#"I;fBBf;l@77@^�Gh::hG��CHHC� F ^6 73!Fl`^��h �� ye ( 4 %"&'##"&&5463236632%267&&#"%2654&#"�5P)B.(A&ZI/A#L3-J,-N��$( 4"&+$10y.@%/0M-^h,(5/2V7Fb3� % !)0 ).$&./ ���� "&&546632'2654&#"-(B''B()A&&A) %% %%�%A**A%%A**A%F)! )) !) �c�� 3��/cK���� pc�&�� �v �cr� ''3/�c���� �� @�<I�� <�� � + 73267&&#""&&5466324454&#"'6632�. &A3*7=5Z57a>#D3; 2@)Y4Ng4I��+,>L!7��0X=Eh; T`Z#'L�[r�_ ��b� " "&'732654&&546632&#"�
' QN ' P�j>GM��RGoAk>GL��SFpA �p� #46632&#"r� QN
&�p�GoAk>G }�br� "&'732653�
'� P�j>G��qFpA !��Y4 '736673�J�c �b�P� EG��**��| �� 9�a �� 9�u O� #33736677#O˰˜'�(�
�
��t�����4m1<<1m B �� 35!5#535!5!B&����|�{�|�t�� , 5,c'��t A � � A ;��.{
55!!!;���⧮=xW"#W|��| ��?{ !#!&�� x�
s�� ��H� " . : "&546632&&#"3267'77'7"&54632'2654&#"�?T,G( 2/ !! )9kK�3�3�K�@TT@@TT@ 8WO6K(<
1)(/
=��I�/�0�I��\MNYYNM\O'33%%33' J��� ) 6654&#""&''667546323267;,+ 6Cl
71jQJW*[H. /5!T�*X6 4��IKZ �~uZP>kd64, Y 0 ��>� 1 ".54>32 !"32673!2554'&&#",9cK++Kc99cK+�b6T5_"&(r�
G&(H 4\zFFz\44\zF� <=3<HZ�
�
��8 5!!#��F�e��� O�t� ��9 '3'�O O�f�E��E��� ��J '7!5!'74E���f�EO�t�O�� ��9 737*��O�t�O��F�e���F�� ] � %'7'��
j�����j
� > �� 7'7'%'7�S���j
S�
i�� G 6�� %%7'7'7���S�
i6j
�S��� f 6� 7'77ij
�S��6��T�
j
��8 5!!!!#��FN ��((��N ODU##UD ��9 7'3'#'##nO ODU##U�E��EN���((�� ��J '7!5!75'!5!'74EN���((�� NEODU##UDO�� ��9 733737*��ODU##UDO��FN ��((��NF�� �� d� %'7!'57!'7d�M[��[M��M[$[M��<ll<��<ll< J��0 #'7'73'7.�<ll<��<ll<8�N[ [M��M[��[N <�S 0 5!'#'7'73'7<���<ll<��<ll<�mmu�N[ [M��M[��[N 9 Z : %"&&546632,Fn??nFFn??nZ?mDEl??lEDm? ' H1L %"&&546632'26654&&#",KvDDvKLuDDuL2N--N22N--NHDuIJtDDtJIuDL/S45R//R54S/ H f. 7!H�f�8 5 S#A 7!%!!5�hB��S�OP 5 S#A 77!%!!5I�C��`��S�?�WE:f 9@b % ,��9�� A eJ 753A��e� A eJ 753%3'A���pe� H� D k(A 73D� k��� D k(A 7377'D� J��k���kk A Q6 %5!*���Q�� A Q6 %5!'7#*���p�Q�� �� 0 kA %%5%3� �k��* 0 kA %%5%3'5� �N�k��*��k
kuA 73
d��k��� �� kKA %%5%3G��dk��* , M,G # 7!%26654&&#"7"&&546632, � JqAAqJIrAArI0J**J00J**JM��AqGHpAApHGqAL,O23N,,N32O, 7 W!D + %"&&546632'26654&&#"7"&54632,EoAAoEFnAAnF0M--M00M--M01DD11DDW>pIIn??nIIp>H,O44N,,N44O,6E43EE34E ��u� 7!%!! KGA����
lA��K: ���- 7!667%!&&'73667! K�9 Z&A���4["� B.]#1 R1�_
lA'E O(��K:�R�zMD=7p8c�R ���p� &&'73>7� I5](=$f{CZd�=U�J==>xݼEN_��� 5��-� ! "&&5466323 '6654&'�4!-N/ OG6 195m & $<$ 0^<*P*,Q��af ����j� ! "&&546632%#"&&546632b1 (E*"�eT2 (E*"�e & $<$�<��bf& $<$G$��af ��X� #.5463236632.\u@W@2LL2@W@u ^�vi6_g4DD4g_6iv� X� 4 7"&5466327.546326632#"&'#!5667#�:I'@%$ #"
W@@W
!$ $%@'H;%IUF�hFUH�OC1> 716CC617 >1CO&3cR
99
Rc3& ����\� #53.��.. hi�� X� ! %#"&54>73 #"&'#!5667C'9M CsXXsC M9'BUF�hFU�3'BF-OZxUUxZO-FB'3cR
99
Rc �� ]x + 7 E M U %"&&546632'26654&&#"'"&546323"&54632"&'73267'254#"3254#",Z�NN�ZZ�MM�ZDg::gDDg::g � iAQ/ 9''9 /Q��
M�XY�MM�YX�MC;jFFj;;jFFj;�' && '' && '�B9 !! 9B� 0Id ' 3 ; C %"&&5466322654&#"32654&#"267'#"''"54323"5432,T�HH�TU�HH���:FO/ VV /O �0H�RSHHSR�H(& && && && &�@;@@;@� �� �� %#.5463236632.EPOA'kS?TT?Sk'AOPE->02@\D_`7DD7`_D\@20> �� �x " 6 B N V &&#"3262672654&#""&&54632#32654&#""&'6632672'&00
6XRN88ohgq6b@U~E��o�;H7X3%j
KUXhOPfWh)�
��03P6/?DNSIu�E;V��bjMG
MJ7T/73� e+%.45-%+L53 �� g� % , : H %"&&5467&5467&&54>7'267!'66327&&#"66327&&#",n�B-1%?1
,30� 1?%1-B�n9Q��Pb # "� " #@;0: ?6; 'O ;6? :0;@`5==5�" "A77A" "A77 �� x % ; I W %"&54632'"&5463226654&#""&'&5467663266327&&#"66327&&#",[_gSSg_[Bh;xmmx<gB^�#B�uu�B"�� # #� # #� l*6SMMS6*�7qWpggpWq7CVT�&(bddb(&�TV0! !A77A! !A77 ��=X ( '73546323%37'654&#"354&#"C((.bYYb.((��))5/""/5.�$&%%F �\dd\� �� ��6"//"6!/55/ .��*� ' 2654&#"5#535.5466323#,?PP??R%B ��<Z2AsJKrA2Z<��<UAATTA+D'��lgI Cd<Em@@mE<dC Igl ��v�
' 72654&&#""&&54663275%#7�@Q%A+)A%Q>JsAAsJA6q�$aaAsVUA+D''D+AU\@mEDn@ja�݁h I)Em@ �� d� 7 %2654&#"'7&&'#5367'7675373#'#5&',5EE55EE�IR
bb PIQ l
RIQ bbPIR l �F66FF66F�IP h QIR mm
QIO
h RIS mm J��� 3'377''#�x��>9--99--
QP����{y]\yy\] # 5�
33%!5''##�v�g JDDJh/���c�wppw �� �c��� �� �"��� �� �"��� ��C 5254#56�]]k\\ODDORDCS �zC &546"3zk\\k]]SCDRODD ���A 5&&546632&&#"1@/M-3H3+ +3?�P%H7.= #@ !6%t � � 373'!��������<�� �<� '!%��<�� Z ��� %"&'57 3267O#?��
&�)87iQ9?E
�� }1z/� �� �1�/� �� u1�� �� uA�� �yx� 3� � yk���� �P�� �� �1�/� �� }1z/� �x b 3� Z ��k���� n=�� �� m;�� �� �P�� �� �<�� �� �8� �� �5
�� �>��
�� ��� 2 �� � � 4 .��)� " . : F R ^ j v � � "&54632'"&546323"&54632%"&54632!"&54632%"&54632!"&54632%"&54632!"&54632%"&54632"&54632'"&54632+|���]�a��c]����
-RmmR+ }1z/ '72�d�1�b� ���~ '7Q�N��w_� �+b '7 N�!+�� �1�/ '7&H�d1H�b ���~ '7A�N�J�_ �.�> 'Xc#�. u1�� '73'#�8l�l8}14��4\ ���C '73'#�@Z�Z@h�'oo'T n=�� ".#"'6632 327n% \@:% \@= MK7MK f��T "&&#"'66323267s#1$_G4$0%_F� LD KE �P�� 5!�(P]] ���/ 5!�.�^^ �� �P�� �� ���/ �<��
"&'73267,URT((()TQ<[B // B[ �<��
"&'73267,VTr rT<TJ*,,*JT ���P
"&'73267,JRP*""*PR�FC ## CF z��C
"&'73267,`O||O�I; "" ;I �>�� "&54632,+77++77>1()33)(1 ���d "&54632,(22((22�/%%..%%/ m;�� "&546323"&54632�#--##--�#--##--;."#..#".."#..#". t��N "&546323"&54632� ** **� ** ))�* )) ** )) * �8� '6654&'7 $, bP'?8:ZB5", ���v '6654&'7 $,]L&?�:
I1(", w<�R
"&'73267'"&54632,XYL6.-7LXY ,, ,,<[B$44$B[�(!!**!!( x���
"&'73267'"&54632,QY
H
9))9
H[Q ++ ++�FC%%%%CFx(! )) !( �8� "&54632'2654&#",ACCAACCA8=+*==*+=7 ���~ "&54632'2654&#",3??32@@2�6--55--67 �5
'7'7�NXbGNXb5#�,�#�, �� y '7'7�Ie^AHd^�"�4�"�4 uA�� '737�l8}}8lA�4\\4� ���T '737�Z@hh@Z�n(TT(n �$n6 3��$b� B5�
'7'7�lbXelbX5�,�#�,� 9��y '7'7�z^dsz^e��4�"�4� �5��
'6632&&#"�TQVVQT)(((5B[[B 00 ���M
'6632&&#"�PRJJRP*""*�CFFC "" �2x "&54676326%.;<B
&&22-.F0$ " �8� .5467W%@'Pb +%8,"5BZ �2u '67#"&54632�B
&& &-;21$ "1-.F�� �8� ����� 5#5353JuuT��BGB� ������ 533#�Tuu���BGB �>�� 5#53Al�>OG� "��� '6654&'7- %
m 2R�;(, /1 5D" ��p��
&546"3pZLLZ$ $��9//96 ����� 53533�UTU�GhhG ������ 5#53#U�U��iFFi ������ 5#53533#UUTUU��BGBBGB ��f��� 53���GG �� �
���
��� m�� ��� �� ��� �� �����
'6654&'7� ;, " P=g�;6(%31 �8��
&&5467ZP=g^ :- "8(%31; ��� '6654&'73� ;, .2V &&g�;iH " 31 ��� '6654&'73� ;, .2V &&g�;iH " 31 � � "&546673326750A%S !! @�21 4% / A � � "&5466733267:1D&Z ! #;�2. 5&
1 J ��g�� 73�j���� ��$��� 5!#5#�Ln�GG�� u� �� ��� ���� ��� �� �� ��� n� �� �� ��D��� �� J �L %".#"'6632 327�%=3, \92&=2- \9�4DC4DD ����
526548�$ $ZLL��769//9 ��*��� 53353�LnL֎GG� �� ��� 5!'35#��nn���6J k� � '&32366324&#"#54&#"�St' (<8SF�
�OP
/ �6�� '7'77'�1??1AA1??1A6,89,77,98,7 �� n=�� �� f��T �(��� "&5533267b=2j
�E:" O �0�C(�� 5!���^^ �cJ� '6632.#"w&g�xx�g&A��??��JC?==?C%** �;�r "&546323"&54632''7�####�####�8NN;$$$$$$$$�$�4 ���� "&546323"&54632''7�""##�##""�?_\�$##$$##$}'�9 h:�> "&5463277"&54632�####;&hM{####H! !��! ! �;�r "&546323"&54632''7�####�####�dNN;$$$$$$$$�u4� ���� "&546323"&54632''7�""##�##""�|\_�$##$$##$}9� o7�! "&54632'77"&54632�!!!!_Ig#R!!!!H �� �;�G , "&546323"&54632'"&&#"'6632327�####�####E +!
@2&!*! @3;$$$$$$$$�88'79 �;�9 "&546323"&54632%5!�####�####��(;$$$$$$$$�EE ���� "&546323"&54632%5!�""##�##""��.�$##$$##$�EE �;�i "&546323"&54632''737�####�####�\0dd0\;$$$$$$$$�\,AA,\ ���� "&546323"&54632''737�""##�##""�\;^^;\�$##$$##$�f'II'f �6A) '73'#7'7�/]t]/f�8ON64\\4A,3 ��- '73'#7'7�;Z~Z;\�,d1�'dd'H2V< 6�) '73'#''7�/]t]/f�iNS64\\4Aw4 /�� '73'#''7�;Z~Z;\�e0a�'dd'HM;W �6*2 '73'#7'6654&'7�/]t]/f�
&RA 464\\4A
2
>*# & ��)� '73'#'6654&'7�;Z~Z;\� &
S@C�'dd'H/
<-!,' �6�F '73'#7"&&#"'632327�/]t]/f<& C N % C 64TT48^&o&o ���� '73'#7"&&#"'6632327�;Z~Z;\>( F0* ' F0�'\\'?Z&96' 96 �<�t
"&'73267''7,URK-+,,KQM@]W<[B$44$B[,�A ����
"&'73267''7,JRH.%%/HR9H_\�FC#''#CFl/�9 �<�t
"&'73267''7,URK-+,,KQ_tW]<[B$44$B[xA� ����
"&'73267''7,JRH.%%/HR[s\_�FC#''#CFl9� �<�y
"&'73267''6654&'7,URK-+,,KQy 'SCF<[B$44$B[}3
P4+1' ����
"&'73267''6654&'7,JRH.%%/HRj &R@C�FC#''#CFm/
=-!,' �<�E
! "&'73267'"&&#"'6632327,NGH%((%HH& K3) % K3<D- !! -D�&:6%96 ����
! "&'73267'"&&#"'6632327,JMG'))'GM( F0* ' F0�>2 2>�'96' 86 �4�B '73'#7"&'73267�4RtR4VA;6!%& 6;4!YY!=^:((: ���� '73'#7"&'73267�8W~W8\ILG&()%GK�'\\'H]<1 1< �P�n 5!''7�(�1�<P]]y<iJ ���� 5!''7�.�1�<�^^qBkQ uA�R "&54632'737, ,, ,,kl0��0l�(!!**!!(}�,aa,� z��� "&54632'737, ++ ++pb/��/b1(! )) !(sf0TT0f s-� .54677� 8$NR%!<"wG?,#,7R<�� i-� .5467'7� 8$NR%!�Fw!?,#,7RL�� �3�P
! &&5467'6632327#"&&#"O0EBR
%
�3) % K3)& 3&% "; 96&96& j-� '6654&'7'7� &RN$7�R"v?:R7,#,� j-� '6654&'7'7� &RN$7�Fw ?:R7,#,�� �3�P ! "&&#"'6632327'6654&'7f& K3) % K3� &
SAE�&96&96�/ ;" %& �� ��q '5!E�犊 �� ��� '!E��� �pq� 3�px�� ��p�� !��px�� ! �7q %53!53!53��������犊���� ! �7� %3!3!3��������������� �qA 333犊���7
���p
���p
�� ���A !!!�����7
���p
���p
�� �Eq %53!53!53!53�p��p��p��p犊������ �E� %3!3!3!3�p��p��p��p��������� �q_ 53535353犊�����~����������� ����_ 5!5!5!5!�������~����������� �p�q %!#!��Ԋ�� �p�� %!#!��Ԋ����E ��p�q %#!!����� ��p�� %#!!�������E ���pqq #!5!q�����pw� ���pq� #!!q�����p3 ���p�q !#5!������pw� ���p�� !#!������p3 � ��� %!3!��J�,��� � ��� %!3!��J�,�E�� � ��� 7!3������ � ��� 7!3��E��� �� �q� %!5!3q�J,��w �� �q� %!!3q�J,��3 �� ��� '53!E��w�� �� ��� '3!E��3�� �p�� %!#3!��Ԋ�,�x�� �p�� %!#3!��Ԋ�,���x�� ��p�� %!##!3��ԊD��w�� ��p�� %#!33!���D�,�w�� ��p�� %#!!3�����x�� ��p�� %!##!3��ԊD��3E�� ��p�� %#!33!���D�,���E3�� ��p�� %#!!3�����x�� ���pq� #!5!3q���,��pw�w ���pq� #!!3q���,��p33 ���p�� #!53!#q����D�pw�w�� ���p�� !#5!33����,�D�pw�w�� ���p�� !#53!������pw�w ���p�� #!3!#q����D�p33�� ���p�� !#!33����,�D�p33�� ���p�� !#3!������p33 ���p�q %!#!5!��Ԋ����w� ���p�� #!!!!q����,��p3D� ���p�� %!#!5!5!��Ԋ��,����w�D ���p�� %!#!!��Ԋ����3 ���p�q %#!#5!������w� ���p�� %#!#!3�������3D ���p�� %#!#535!���������w�D ���p�� %#!#!������3 �� ��� %!5!3!�� ,�,�w�� �� ��� %!!!3!���J,�,�D3�� �� ��� %!5!5!3!��J��,�,�D�w�� �� ��� %!!3!�� ,�,�3�� �� ��� %!53!3�� ���w�� �� ��� '3!3#E���3���D �� ��� 75#53!3����D�w��� �� ��� %!3!3�� ��3�� ���p�� %!#!5!3!��Ԋ��,�,�w�w�� ���p�� %!#!!3!��Ԋ��,�,�33�� ���p�� %!#!5!3!��Ԋ��,�,���w�w�� ���p�� %!#!!3!��Ԋ��,�,���33�� ���p�� %!#!53!3��Ԋ�����w�w�� ���p�� %#!#5!3!����,�,�w�w�� ���p�� %#!#53!3�������w�w�� ���p��
%##!3!3#�D�������33��� ���p��
%!##5#53!3��ԊD����3D�w�� ���p��
!#!333#����,�D��p33��D� ���p��
%#!#53533!�����D�,���w�D3�� ���p�� %!#!3!3��Ԋ�����33�� ���p�� %#!#!3!����,�,���33�� ���p�� %#!#3!3�������33�� ���p�� %#!#53!3�������w�w�� ���p�� %#!#3!3�������33�� K �
q %53!53w��>�犊�� K �
� %3!3w��>������ �jq� 33犊��,���,�� ��j�� !!����,���,�� �� ^�� 5!5!E� �q���퉉 ^�p�� 3!3q��d��px��x�� �p�� %!#!!!��Ԋ���,^���� ^�p�q ##!#q��?��pw����� ^�p�� !#!##!��J�?��,q����d�w ���pq� #!5!5!5!q���,����p� ���p�q ###5!q���?�pw��w��� ���p�� #!5!##5!���J?�퉣,�p��v� � ^�� 73!!!�,��,^����� ^ ��� 73333^�������w��� ^ ^�� 333!q������qw�������� �� ^q� %!5!5!5!3q�J,��,�^���� �� ��� %!53333��������w��w �� ^�� !533!5!3�ԣ�����q��v� �p�� %!#3!!!��Ԋ�,��,^�x��� ^�p�� 3##33^�������px��w��x�� ^�p�� 333##!^������,�px��w����w ���pq� #!5!5!5!3q���,��,��p�� ���p�� 3!##533q��퉣���px��w�w ���p�� 3!533##5!q���ԣ���,�px����� ���p�� 5!!#!5!E�Ԋ���q����� ���p�q ###5!#q����pw��w���� ���p�� 5!##!##5!E⣉,�J��,q����w��� �� ^�� !5!3!5!�� ,�,� �q���d�� �� ��� %!533333�� ������w��w�� �� ^�� 33!!5335!q���J�ԣ����qw����v�� ���p�� %!#!5!5!5!3!!!��Ԋ��,��,�,��,^����� ���p�� ###533333#q����������pw��w�w��w����� ���p�� 33!!533##!##5!q���J�ԣ����,�J��,qw����v�w��� �p�q 4>33#"�9f�LEE@i>�p�M�f9�>i@�p ���pqq !#4&&##532 q�>i@EEM�f9�p�@i>�9f� �� �q� ##532665q9f�MEE@i>�pL�f9�>i@� � ��� 333#".�>i@EEL�f9X��p@i>�9f� ��X� 3# L��L���� ��X� #5L L������ ��X� #5533 ��L��L��L�����A�����A���A�A� �� �qq '5!E�犊 � �q� 73���� � ��q 75!��犊 �pqq 3�p�� �� �q� '!E���� � ��� 7!���� � ��� 7!����� ��p�q !��p�� �� ��� %!5!5!5!��J��,��D�D ��p�� !333���D�D�pw�� �� ��� %!!!!���J�,�DD ��p�� %###!�D�D�w ,X� !X,��D �pX� 5!X�p�� �pX�� !X�p^�� �pX } !X�p
�� �pX, !X�p��D �pX� !X�pk�� �pX� !X�p�� �pX9 !X�p�7 �pX� !X�px�� �p
� !
�px�� �p�� !�px�� �pw� !w�px�� �p,� !,�px�� �p �� 3�px�� �p �� 3��px�� �p K� 3K�px�� ,�pX� !,,�px�� *��X� # / ; G S _ k w � � � � � � � � � � � +7CO[gs���������� 4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&���8
�
�
���8
�
�
���8
�
�
���8
�
�
���8
�
�
���8
�
�
���8
�
�
�U
ZU
ZU
ZU
ZU
ZU
ZU
*��L*� # / ; G S _ k w � � � � � � � � � � � +7CO[gs���������� 4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&� � � >��� � � >��� � � >��� � � >��� � � >��� � � >��� � � >��� NU NU NU NU NU NU N *��:E� # / ; G S _ k w � � � � � � � � � � � +7CO[gs���������� 4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&�/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B 9X� 5!X9��
�pX� 3
K�px�� �p,, !,�p��D ,�pX, !,,�p��D ,,� !,,��D �pX� !!,,�px�D�D �pX� !!,,,��D�D��D �pX� !!!X���X,�Dx �pX� !!!X���X�p�� ,,X� !,,,��D �pX� !!,,��,,��D�D��D �pX� !!!X��,,�p���� 5��-�� ������j�� B� ' 3#57546632&#"3#33"&54632IBB$PC 4 ZZ��J+77++77}m5V4 l
!& s���>1()33)(1 ��Z� ' "&533267%#57546632&#"3#L;� $�#BB$PC 4 ZZ [K#��m }m5V4 l
!& s�� >��z$ #4>55#7#3ϑ"8CC8"o��p"8CD8"����H_?,)4M<����I`?-(3L;�T� A�Z� 3333'53##A���%���%��h����܂�"]�� ��=X� ��X X��(�l ��(q� '7AQ�Q0�PP�� ��\ \��\���� ��(h� ��0Q���TTP���� Hf $ < H T ` l & ~ & �
* � 6 � D* :n � 2� $ � D* � � � F� (D dl $� �� 4� 4� 2
N 4n � � � � � � $ 0 T
, t 0 � . �
2 � 8
0 &
h <
� � "
� . � 2 �
�
� " 2 F ` z � 0 � ( �
, 4 , 8 ` < � 0 � H
" 2
L 8 `���� a���� g i & l �� ������������� J���� ����� ����� �������� 1��������� ����� [� ]����� �� ������ [ 0 ]����������� ����� [ - ]������������ ���������� [ * ]������� ��� �������� �� ������ [ $ ]����������� ����������� [ - , * ]���� � , ���� a���� � , ���� g , ������� 1���� � , ���� J � 2 0 1 0 - 2 0 2 0 A d o b e S y s t e m s I n c o r p o r a t e d ( h t t p : / / w w w . a d o b e . c o m / ) , w i t h R e s e r v e d F o n t N a m e S o u r c e . S o u r c e C o d e P r o B o l d 2 . 0 3 8 ; A D B O ; S o u r c e C o d e P r o - B o l d ; A D O B E S o u r c e C o d e P r o B o l d V e r s i o n 2 . 0 3 8 ; h o t c o n v 1 . 0 . 1 1 6 ; m a k e o t f e x e 2 . 5 . 6 5 6 0 1 S o u r c e C o d e P r o - B o l d S o u r c e i s a t r a d e m a r k o f A d o b e S y s t e m s I n c o r p o r a t e d i n t h e U n i t e d S t a t e s a n d / o r o t h e r c o u n t r i e s . A d o b e S y s t e m s I n c o r p o r a t e d P a u l D . H u n t , T e o T u o m i n e n h t t p : / / w w w . a d o b e . c o m / t y p e T h i s F o n t S o f t w a r e i s l i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 . T h i s l i c e n s e i s a v a i l a b l e w i t h a F A Q a t : h t t p : / / s c r i p t s . s i l . o r g / O F L . T h i s F o n t S o f t w a r e i s d i s t r i b u t e d o n a n A S I S B A S I S , W I T H O U T W A R R A N T I E S O R C O N D I T I O N S O F A N Y K I N D , e i t h e r e x p r e s s o r i m p l i e d . S e e t h e S I L O p e n F o n t L i c e n s e f o r t h e s p e c i f i c l a n g u a g e , p e r m i s s i o n s a n d l i m i t a t i o n s g o v e r n i n g y o u r u s e o f t h i s F o n t S o f t w a r e . h t t p : / / s c r i p t s . s i l . o r g / O F L s i m p l e a s i m p l e g s e r i f e d i & l S a m i J c u r s i v e � c u r s i v e � c u r s i v e � S e r b i a n � C y r i l l i c b r e v e [� ] s l a s h e d z e r o [ 0 ] t y p o g r a p h i c h y p h e n [ - ] t y p o g r a p h i c a s t e r i s k [ * ] s l a s h e d d o l l a r s i g n [ $ ] a l t e r n a t e n u m e r a l o n e [ 1 ] t y p o g r a p h i c a l t e r n a t e s [ - , * ] s i m p l e a , c u r s i v e � s i m p l e g , c u r s i v e � , S e r b i a n 1 S a m i J , c u r s i v e �?@>AB>9 0?@>AB>9 gV 8 � A 70A5G:0<8A00<A:89 JA:>@>?8A=K9 �A:>@>?8A=K9 �A:>@>?8A=K9 �A5@1A:89 1:8@8;;8G5A:0O :@0B:0 [� ]70G5@:=CBK9 =>;L [ 0 ]B8?>3@0DA:89 45D8A [ - ]B8?>3@0DA:0O 72574>G:0 [ * ]70G5@:=CBK9 7=0: 4>;;0@0 [ $ ]B8?>3@0DA:85 70<5AB8B5;8 [ - , * ]?@>AB>9 0 , A:>@>?8A=K9 �A5@1A:89 1 , ?@>AB>9 g , A:>@>?8A=K9 �A00<A:89 J , A:>@>?8A=K9 � �� 2 $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] � � � � b c
� d � � � e � � !"#$%&'()*+,-. �/0123456789: � � �; �< �=>?@ABCDEFGHIJK �LMNOPQR fSTUV � � � � gWXYZ[\]^_`abcdefghi �j �klmnopqrs �tuvwxyz{|}~ � � �� h������������������������ �� ������ ����� � ������ j i k m l�� n��������������� ����� o �� ����� q p r� s��������������� ������������� u t v� w������ ������������ �������� x����� z y { } |���
� � � � !"#$%& ~ �' �()*+,-./0123456789:;<=>? �@ �ABCDE �FGHI � �JKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~�������������������������������������������������������������������������������������������������������������������������������� �
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~������������������������������������������������������������������������������������������������������� ������������������������� � � " �
� � � � � � � � � � � � � �
B > @ ^ ` _ ? �
� � � � !"#$%& �' � �( #) *+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdef �g �hijklmnopqrstuvwxyz{|}~���������������� � � �� ����������������� � ��� � � � ����������������� � � �� � ! � � � A � a � ���� � ����� � ��� ������ � �������������������������������������������������������� ������� C � � � � � � � � � � � �
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~��������������������������������������������������������������������������������������������������������������������������������
!"#$%&'()*+,-.AmacronAbreve
Aringacuteuni01CDAogonekuni1EA0uni1EA2uni1EA4uni1EA6uni1EA8uni1EAAuni1EACuni1EAEuni1EB0uni1EB2uni1EB4uni1EB6AEacuteuni01E2uni0243uni1E06 Ccircumflex
CdotaccentDcaronuni1E0Cuni1E0Euni1E10Dcroatuni018AEcaronEmacronEbreve
EdotaccentEogonekuni1EB8uni1EBAuni1EBCuni1EBEuni1EC0uni1EC2uni1EC4uni1EC6uni1E16uni01F4 Gcircumflex
Gdotaccentuni0122Gcaronuni1E20 uni00470303uni0193 Hcircumflexuni1E26uni1E24uni1E28uni1E2AHbarItildeImacronuni01CFIogonekuni1EC8uni1ECAIbreve Jcircumflexuni0136uni1E32uni1E34LacuteLcaronuni013Buni1E36uni1E38uni1E3ALdotuni1E3Euni1E40uni1E42Nacuteuni01F8Ncaronuni0145uni1E44uni1E46uni1E48Omacron
OhungarumlautObreveuni01D1uni01EAuni1ECCuni1ECEuni1ED0uni1ED2uni1ED4uni1ED6uni1ED8Ohornuni1EDAuni1EDCuni1EDEuni1EE0uni1EE2uni1E52 OslashacuteRacuteRcaronuni1E58uni0156uni1E5Auni1E5Cuni1E5ESacute Scircumflexuni1E66uni015Euni0218uni1E60uni1E62uni1E9ETcaronuni0162uni021Auni1E6Cuni1E6ETbarUtildeUmacronUbreveUring
Uhungarumlautuni01D3Uogonekuni01D5uni01D7uni01D9uni01DBuni1EE4uni1EE6Uhornuni1EE8uni1EEAuni1EECuni1EEEuni1EF0uni1E7EWgraveWacute Wcircumflex WdieresisYgrave Ycircumflexuni1E8Euni1EF4uni1EF6uni1EF8Zacute
Zdotaccentuni1E90uni1E92uni1E94uni018FEngIJuni004C00B7004C uni01320301amacronabreve
aringacuteuni01CEaogonekuni1EA1uni1EA3uni1EA5uni1EA7uni1EA9uni1EABuni1EADuni1EAFuni1EB1uni1EB3uni1EB5uni1EB7aeacuteuni01E3uni0180uni1E07 ccircumflex
cdotaccentdcaronuni1E0Duni1E0Funi1E11ecaronemacronebreveeogonek
edotaccentuni1EB9uni1EBBuni1EBDuni1EBFuni1EC1uni1EC3uni1EC5uni1EC7uni1E17uni01F5 gcircumflex
gdotaccentuni0123gcaronuni1E21 uni00670303 hcircumflexuni1E27uni1E25uni1E96uni1E29uni1E2Bhbaritildeimacronuni01D0iogonekuni1EC9uni1ECBibreve jcircumflexuni0137uni1E33uni1E35 kgreenlandiclacutelcaronuni013Cuni1E37uni1E39uni1E3Bldotuni1E3Funi1E41uni1E43nacuteuni01F9ncaronuni0146uni1E45uni1E47uni1E49 napostropheomacron
ohungarumlautuni01D2uni01EBuni1ECDuni1ECFuni1ED1uni1ED3uni1ED5uni1ED7uni1ED9obreveuni1E53ohornuni1EDBuni1EDDuni1EDFuni1EE1uni1EE3 oslashacuteracuteuni0157rcaronuni1E59uni1E5Buni1E5Duni1E5Fsacute scircumflexuni1E67uni015Funi0219uni1E61uni1E63longstcaronuni0163uni021Buni1E6Duni1E6Funi1E97tbarutildeumacronubreveuring
uhungarumlautuni01D4uogonekuni01D6uni01D8uni01DAuni01DCuni1EE5uni1EE7uhornuni1EE9uni1EEBuni1EEDuni1EEFuni1EF1uni1E7Fwgravewacute wcircumflex wdieresisygrave ycircumflexuni1E8Funi1EF5uni1EF7uni1EF9zacute
zdotaccentuni1E91uni1E93uni1E95enguni0237ijuni006C00B7006C uni01330301uni0250uni0252uni0253uni0254uni0255uni0256uni0257uni0258uni0251uni0299uni0259uni025Auni025Buni025Cuni025Euni025Funi0260uni0261uni0262uni0263uni0264uni0265uni0266uni0267uni029Cuni0268uni026Auni029Duni029Euni026Buni026Cuni026Duni026Euni029Funi026Funi0270uni0271uni0272uni0273uni0274uni0275uni0276uni0278uni0279uni027Auni027Buni027Duni027Euni0280uni0281uni0282uni0283uni0284uni0287uni0288uni0289uni028Auni028Buni028Cuni028Duni028Euni028Funi0290uni0291uni0292uni02A4uni02A6uni02A7uni0294uni0295uni02A1uni02A2uni01C2uni0298 uni014A.aa.aagrave.aaacute.a
acircumflex.aatilde.a adieresis.a amacron.aabreve.aaring.a aringacute.a uni01CE.a uni1EA1.a uni1EA3.a uni1EA5.a uni1EA7.a uni1EA9.a uni1EAB.a uni1EAD.a uni1EAF.a uni1EB1.a uni1EB3.a uni1EB5.a uni1EB7.a aogonek.ag.a uni01F5.a
gcircumflex.agbreve.a gdotaccent.a uni0123.agcaron.a uni1E21.a
uni00670303.ai.a
dotlessi.aigrave.aiacute.a
icircumflex.aitilde.a idieresis.a imacron.a uni01D0.a iogonek.a uni1EC9.a uni1ECB.a uni012D.a uni0268.a iogonek.d
iogonek.da uni0268.d
uni0268.da uni029D.dl.alacute.alcaron.a uni013C.a uni1E37.a uni1E39.a uni1E3B.alslash.aldot.auni006C00B7006C.a uni026B.a uni026C.aAlphaBetaGammauni0394EpsilonZetaEtaThetaIotaKappaLambdaMuNuXiOmicronPiRhoSigmaTauUpsilonPhiChiPsiuni03A9
Alphatonos EpsilontonosEtatonos Iotatonos Iotadieresis Omicrontonos UpsilontonosUpsilondieresis
Omegatonosalphabetagammadeltaepsilonzetaetathetaiotakappalambdauni03BCnuxiomicronrhosigmatauupsilonphichipsiomegauni03C2uni03D0uni03D1uni03D5phi.a
alphatonos epsilontonosetatonos iotatonos iotadieresis omicrontonos upsilontonosupsilondieresis
omegatonosiotadieresistonosupsilondieresistonosuni03D7uni03D9uni03DBuni03DDuni03E1uni037E anoteleia
anoteleia.capuni0374uni0375tonos tonos.cap
dieresistonosuni037Auni1FBEuni1FBDuni1FBFuni1FFEuni1FEFuni1FFDuni1FCDuni1FDDuni1FCEuni1FDEuni1FCFuni1FDFuni1FC0uni1FEDuni1FEEuni1FC1 uni1FBD.cap uni1FFE.cap uni1FEF.cap uni1FFD.cap uni1FCD.cap uni1FDD.cap uni1FCE.cap uni1FDE.cap uni1FCF.cap uni1FDF.capuni0410uni0411uni0412uni0413uni0414uni0415uni0416uni0417uni0418uni0419uni041Auni041Buni041Cuni041Duni041Euni041Funi0420uni0421uni0422uni0423uni0424uni0425uni0426uni0427uni0428uni0429uni042Auni042Buni042Cuni042Duni042Euni042Funi0400uni0401uni0402uni0403uni0404uni0405uni0406uni0407uni0408uni0409uni040Auni040Buni040Cuni040Duni040Euni040Funi0462uni0472uni0474uni0490uni0492uni0496uni0498uni049Auni04A0uni04A2uni04AAuni04AEuni04B0uni04B2uni04B6uni04BAuni04C0uni04C1uni04D0uni04D4uni04D6uni04D8uni04E2uni04E6uni04E8uni04EEuni04F2uni0430uni0431uni0432uni0433uni0434uni0435uni0436uni0437uni0438uni0439uni043Auni043Buni043Cuni043Duni043Euni043Funi0440uni0441uni0442uni0443uni0444uni0445uni0446uni0447uni0448uni0449uni044Auni044Buni044Cuni044Duni044Euni044Funi0450uni0451uni0452uni0453uni0454uni0455uni0456uni0457uni0458uni0459uni045Auni045Buni045Cuni045Duni045Euni045Funi0463uni0473uni0475uni0491uni0493uni0497uni0499uni049Buni04A1uni04A3uni04ABuni04AFuni04B1uni04B3uni04B7uni04BBuni04C2uni04CFuni04D1uni04D5uni04D7uni04D9uni04E3uni04E7uni04E9uni04EFuni04F3 uni0430.a uni04D1.a uni0431.srb uni0456.a uni0457.a uni04CF.auni2116zero.aone.a zero.onumone.onumtwo.onum
three.onum four.onum five.onumsix.onum
seven.onum
eight.onum nine.onumzero.bone.bzero.capone.captwo.cap three.capfour.capfive.capsix.cap seven.cap eight.capnine.capzero.cone.c
quotereverseduni00ADuni2010
figuredashuni2015uni25E6uni25AAuni25ABuni25B4uni25B5uni25B8uni25B9uni25BEuni25BFuni25C2uni25C3 invbullet
filledrect
underscoredbluni203Euni203Funi2016 exclamdbluni2047uni2049uni2048uni203Duni2E18uni231Cuni231Duni231Euni231Funi27E6uni27E7uni2E22uni2E23uni2E24uni2E25uni2117uni2120at.case
asterisk.ahyphen.a uni00AD.a uni2010.adollar.a zero.supsone.supstwo.sups
three.sups four.sups five.supssix.sups
seven.sups
eight.sups nine.supsparenleft.supsparenright.sups period.sups
comma.sups zero.subsone.substwo.subs
three.subs four.subs five.subssix.subs
seven.subs
eight.subs nine.subsparenleft.subsparenright.subs period.subs
comma.subs zero.dnomone.dnomtwo.dnom
three.dnom four.dnom five.dnomsix.dnom
seven.dnom
eight.dnom nine.dnomparenleft.dnomparenright.dnom period.dnom
comma.dnom zero.numrone.numrtwo.numr
three.numr four.numr five.numrsix.numr
seven.numr
eight.numr nine.numrparenleft.numrparenright.numr period.numr
comma.numr
ordfeminine.aa.supsb.supsc.supsd.supse.supsf.supsg.supsh.supsi.supsj.supsk.supsl.supsm.supsn.supso.supsp.supsq.supsr.supss.supst.supsu.supsv.supsw.supsx.supsy.supsz.sups egrave.sups eacute.sups eogonek.sups uni0259.sups uni0266.supsuni02E0uni02E4a.supag.supai.supa
colon.sups hyphen.sups endash.sups emdash.supsEurouni0192
colonmonetarylirauni20A6pesetauni20A9donguni20B1uni20B2uni20B4uni20B5uni20B9uni20BAuni20AEuni20B8uni20BDuni2215
slash.fraconethird twothirdsuni2155uni2156uni2157uni2158uni2159uni215Auni2150 oneeighth threeeighths fiveeighths seveneighthsuni2151uni2152uni2189uni2219 equivalence
revlogicalnot intersection
orthogonaluni2032uni2033uni2035uni00B5
integraltp
integralbtuni2206uni2126uni2200uni2203uni2237uni2105uni2113 estimateduni2190arrowupuni2192 arrowdownuni2196uni2197uni2198uni2199uni21D0uni21D1uni21D2uni21D3 arrowboth arrowupdn arrowupdnbseuni25CFuni25CBuni25A0uni25A1uni2752uni25C6triagupuni25B3uni25B6uni25B7triagdnuni25BDuni25C0uni25C1triagrttriaglf invcircleuni25C9uni2610uni2611uni2713 musicalnotemusicalnotedblheartclubdiamondspade smileface invsmilefaceuni2764uni2615u1F4A9u1F916u1F512femalemalesunhouseuni02B9uni02BBuni02BCuni02BEuni02BFuni02C1uni02D0uni02D1uni02DEuni02C8uni02C9uni02CAuni02CBuni02CCuni25CCuni0300 uni0300.capuni0340uni0301 uni0301.cap uni0301.guni0302 uni0302.capuni0303 uni0303.capuni0304 uni0304.capuni0305 uni0305.capuni0306 uni0306.c uni0306.cap uni0306.ccapuni0307 uni0307.capuni0308 uni0308.capuni0309 uni0309.capuni0310 uni0310.capuni030A uni030A.capuni030B uni030B.capuni030C uni030C.cap uni030C.auni030F uni030F.capuni0311 uni0311.capuni0312 uni0312.guni0313uni0343uni0318uni0319uni031Auni031Buni031Cuni031Duni031Euni031Funi0320uni0323uni0324uni0325uni0326 uni0326.auni0327 uni0327.capuni0328 uni0328.capuni0329uni032Auni032Cuni032Euni032Funi0330uni0331uni0334uni0339uni033Auni033Buni033Cuni033Duni0342 uni0342.capuni0345uni035Funi0361 uni03080301uni03080301.cap
uni03080301.g uni03080300uni03080300.cap
uni03080300.g uni03080303 uni03080304uni03080304.cap uni0308030Cuni0308030C.cap uni03020301uni03020301.cap uni03020300uni03020300.cap uni03020309uni03020309.cap uni03020303uni03020303.cap uni03060301uni03060301.cap uni03060300uni03060300.cap uni03060309uni03060309.cap uni03060303uni03060303.cap uni03020306uni03020306.cap uni03040301uni03040301.cap uni030C0307uni030C0307.cap uni03120301 uni03120300 uni03120303 uni03130301 uni03130300 uni03130303uni00A0uni2007
space.frac nbspace.fracuni2500uni2501uni2502uni2503uni2504uni2505uni2506uni2507uni2508uni2509uni250Auni250Buni250Cuni250Duni250Euni250Funi2510uni2511uni2512uni2513uni2514uni2515uni2516uni2517uni2518uni2519uni251Auni251Buni251Cuni251Duni251Euni251Funi2520uni2521uni2522uni2523uni2524uni2525uni2526uni2527uni2528uni2529uni252Auni252Buni252Cuni252Duni252Euni252Funi2530uni2531uni2532uni2533uni2534uni2535uni2536uni2537uni2538uni2539uni253Auni253Buni253Cuni253Duni253Euni253Funi2540uni2541uni2542uni2543uni2544uni2545uni2546uni2547uni2548uni2549uni254Auni254Buni254Cuni254Duni254Euni254Funi2550uni2551uni2552uni2553uni2554uni2555uni2556uni2557uni2558uni2559uni255Auni255Buni255Cuni255Duni255Euni255Funi2560uni2561uni2562uni2563uni2564uni2565uni2566uni2567uni2568uni2569uni256Auni256Buni256Cuni256Duni256Euni256Funi2570uni2571uni2572uni2573uni2574uni2575uni2576uni2577uni2578uni2579uni257Auni257Buni257Cuni257Duni257Euni257Funi2580uni2581uni2582uni2583uni2584uni2585uni2586uni2587uni2588uni2589uni258Auni258Buni258Cuni258Duni258Euni258Funi2590uni2591uni2592uni2593uni2594uni2595uni2596uni2597uni2598uni2599uni259Auni259Buni259Cuni259Duni259Euni259Funi202FuniFEFFu1F3B5u1F3B6f_if_luniE0A0uniE0A1uniE0A2uniE0B0uniE0B1uniE0B2uniE0B3 ideoromn DFLT cyrl grek latn �V � t
! ! " " # ' ) 1 3 5 7 7 : : = = @ @ M M [ [ ^ ^ e e v v � � � � � � � � � � � � � � � � � �
$$ ** 00 ?? BB QQ UU \\ aa ss ww �� �� �� �� �� �� �� �� �� �� �� �� �� �� � ## && 56 ;; ?@ HH LN QR YY \^ bb dd ff ll nn qq uu �� �� �� �� �� �� �� �� �� �� �� �� �� ��
$% '- 01 46 KL ee �� �� � E Hn � # 11 BD Hn
�( DFLT cyrl .grek Xlatn l ��
SRB �� ! ��
" �� # ATH &NSM 6SKS F �� $ ��
% �� & �� ' (ccmp �ccmp �ccmpccmp
ccmpccmpccmp"ccmp*frac2frac8frac>fracDfracJfracPfracVfrac\markbmarkvmark�mark�mark�mark�mark�mark�mkmkmkmkmkmkmkmkmkmkmkmk mkmk&mkmk,size2size6size:size>sizeBsizeFsizeJsizeN
d & . 8 B J T \ d l t | � � v x z � � � � � � � h � � z � �
`
P��
�t � � � � 8 � � & ^ ��� ^ ��� \ �� | � Z S � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �x~x���xx���x����xxxxx������������r�rr x&,�x�xx2xx����8�rr��8 >DJPV\�b�hnrrtzzr�r������� �������r�rr�r�������h����8�8x�xxx�xx
r x�"(x.x4"x.x&x�:@�Frrr��rLRrXrhr , ,� a� C� M� J� H� B� �� @� 1� -� ?� @ �� V �� �� �� Y� �� � ; C 4 ` 8 � ( H �� )� v� Y > � " T �� �� � 6 R % � ' r� � * P � �� f �� � � 3 d� ) J�
� ,� .� 9 E� E E G� B L $ >� F� 4� � O D \ & � � Z `
, � D L h h . d j p v | � ^ � ^ � � ^ ^ � � � � � � � � � � ^ � � � � � � � � � � ^ , W B � � O � 1 � @ � V ' � b > � � 7 w � � � � 6 � N M x� j Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z } � � � � & �,28 � �> � �D �JPV\Vbhnt �z����� � �����& � �V�bn ��z�h�DD��� �V2������ ��J� �b ���n
""(.��4:@F �� � �� �LRX^2V� � � � �>d � ,�� U�� *�� D�� ��� C�� E�� O�� ��� @�� 0�� -�� 8�� 6�� T�� 4�� %�� Y�� ��3 o�� 2�� ��3 ��3 ��� 3�� q�� 9�� �3 7�� L�� "�� .�� D�3 �� h�� <�3 �� (�� *�3 B�� ,�$ ��I �3 �3 o�3 n�3 N�� �3 W�3 �� 4�3 -�3 6�3 �3 V�y q�3 �$ R�� K�3 �� ��� ��
, � �Z o Jo �� " ,� �� � �� �� z� H H D J > > > > P V > \ b D D D J > h P P P n V > J J J J t t > , � � � ` � !�� 6 � L �2 Z S h n h h n h h n h n h n h n h h n n h n h n h n h n h n h n h n h n h n h h h h h h h n h n h h n h h h n h n h n h n h n h n h n h n h n h n h n h n h n h h h h h h & & , 2 8 8 2 2 > D J P , ,� ,� ,� ,� ,� ,� ,# ,� ,� G F , ! # $ % & ' / (a������������������� # " % + , 4������������������� hj FG � E JJ JMM Kin L R � # 11 (BD )Hn , �
! # $ % & ' ) * + , - . / 0 1 3 4 5 @ M [ e � � � � � � � � �
QUaw��������������������������������������
56?@HLMNQRY\]^bdflnqu��������������
$%'()*+,-01456KLe� & � 23 .
! # $ ' ) * - . / 0 3 5 M � �U��� ?@LRY\]� $% (0 6< >A EE }
! # $ % & ' ) * + , - . / 0 1 3 4 5 M [ � � � � �Ua��������������������������������������
6?@LQRY\]^du�� =
'R� ' *� 45
$ * 0 4 7 : = ^ � �
*Us #&?@� ��
�� DFLT cyrl fgreklatnR �� ! ( 0 8 @ H P X ` h p x � � � � � � � � � � � � � � � �
SRB T �� " ! ) 1 9 A I Q Y a i q y � � � � � � � � � � � � � � � � � �� "
" * 2 : B J R Z b j r z � � � � � � � � � � � � � � � � � �� " # + 3 ; C K S [ c k s { � � � � � � � � � � � � � � � � ATH ^NSM �SKS � �� ! $ , 4 < D L T \ d l t | � � � � � � � � � � � � � � � �� !
% - 5 = E M U ] e m u } � � � � � � � � � � � � � � �
�� " & . 6 > F N V ^ f n v ~ � � � � � � � � � � � � � � � � �� " ' / 7 ? G O W _ g o w � � � � � � � � � � � � � � � �
casePcaseVcase\casebcasehcasencasetcasezccmp�ccmp�ccmp�ccmp�ccmp�ccmp�ccmp�ccmp�cv01�cv01�cv01�cv01cv01cv01cv01cv01cv02 cv02&cv02,cv022cv028cv02>cv02Dcv02Jcv04Pcv04Vcv04\cv04bcv04hcv04ncv04tcv04zcv06�cv06�cv06�cv06�cv06�cv06�cv06�cv06�cv07�cv07�cv07�cv07�cv07�cv07�cv07�cv07�cv08�cv08�cv08�cv08�cv08�cv08�cv08cv08
cv09cv09cv09 cv09"cv09(cv09.cv094cv09:cv10@cv10Fcv10Lcv10Rcv10Xcv10^cv10dcv10jcv11pcv11vcv11|cv11�cv11�cv11�cv11�cv11�cv12�cv12�cv12�cv12�cv12�cv12�cv12�cv12�cv14�cv14�cv14�cv14�cv14�cv14�cv14�cv14�cv15 cv15 cv15 cv15 cv15 cv15 cv15 $cv15 *cv16 0cv16 6cv16 <cv16 Bcv16 Hcv16 Ncv16 Tcv16 Zcv17 `cv17 fcv17 lcv17 rcv17 xcv17 ~cv17 �cv17 �dnom �dnom �dnom �dnom �dnom �dnom �dnom �dnom �frac �frac �frac �frac �frac �frac �frac
frac
locl
locl
&locl
.locl
4locl
:numr
@numr
Fnumr
Lnumr
Rnumr
Xnumr
^numr
dnumr
jonum
ponum
vonum
|onum
�onum
�onum
�onum
�onum
�ordn
�ordn
�ordn
�ordn
�ordn
�ordn
�ordn
�ordn
�salt
�salt
�salt salt $salt @salt \salt xsalt �sinf �sinf �sinf �sinf �sinf �sinf �sinf �sinf �ss01 �ss01 �ss01 �ss01 �ss01 ss01 ss01 ss01 ss02 ss02 (ss02 0ss02 8ss02 @ss02 Hss02 Pss02 Xss03 `ss03 jss03 tss03 ~ss03 �ss03 �ss03 �ss03 �ss04 �ss04 �ss04 �ss04 �ss04 �ss04 �ss04 �ss04 �ss05 �ss05 �ss05 �ss05 �ss05
ss05
ss05
ss05
ss06
ss06
&ss06
,ss06
2ss06
8ss06
>ss06
Dss06
Jss07
Pss07
Vss07
\ss07
bss07
hss07
nss07
tss07
zsubs
�subs
�subs
�subs
�subs
�subs
�subs
�subs
�sups
�sups
�sups
�sups
�sups
�sups
�sups
�sups
�zero zerozero zerozerozero zero$zero* @ : 4 . ( " � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � ~ x r l t n h b \ V P J R L F @ : 4 . ( 0 * $ � � � � � � � � � � � � � � � � � � � � � � � � � � � � ~ � � z t n h b \
� � � � � � � � � � � � � � � � ~ t j ` V P J D > 8 2 , & $ � � � � � � � � � � � � � � � � � � �
$ J R Z b j r ~ � � � � � � � � � � � � � � � &.6>FNV^fn , * 0 . , z�� ��� � � �� � � 2 < x � � � � V h � � � � � � � � � � � � � !# L
& , 2 8 > D J P * *
U � � � � � � �� � ! � � ! � � " � : d � � $U �S �Y c W $] �[ �a _ a C $ * 0 6 <K �M �H �J N O Q N C & ,j �j �i �i k k C & ,m �m �l �l n n C � , 6 @ J T ` j t ~ � � � � � � � � � � @ 4 e 4 v � 4 �
� 4 � 4
4 $ 0 4 B ? 2 Q 4 � � '\ w 4 � � 4 � � � ; 2 * v " � d " � !$%"# �
� � � � # � � # �� � # � )*+,-./0123456789:;<=>?@ABCDEFG �������������� r MNOP � ���� N R 9������������������������� 35CILPRTVXZ\^`bdf P !"#$%&'(5)*+,-./01234ef'J :
6789:;<=>K 6 ?RABCDEFGHIJK@STUVWXYZ[L\]NPhijL 4 4 4 4
8 C < <�� <
<
@
M 4 N 4 * (U�MOQNP�� 35CILPRTVXZ\^`bdf ( q
r � �� "
_ b � �+.qt�A _ �+q b �.t � �A $ 4 ��
CHKOQSUWY[]_ace ? $ %Q��HL !#
" $ ' * / 0 �6 6 Y [ [ > ] x ? z z [ | � \ � � � � � � � � � � �^~ �� � !��
24CHKOQSUWY[]_ace !�� 35CILPRTVXZ\^`bdf mv ��
�� � ! o
hj %
qr 5 )* 00 �� �� ���� mv 9��mnopqrstuvxyz{|}~������
24CHKOQSUWY[]_ace \\ && )) " " ;B // $ 'JKLMNOPQRSTU[\]^_`ab����MO@A[1 � � � my� �� � R n nz� $? ( $ %Q��HL��
24CHKOQSUWY[]_ace % oo share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf 0000644 00000416670 15173517750 0026377 0 ustar 00 � pBASEe ]� �� FDSIG � GDEF��� � �GPOS�� � \GSUB�] d JOS/2��� x `cmapspB 3fglyf�� M� Q.head��: � 6hhea3 � 4 $hmtx �� � Bloca'`ӄ A� BmaxpTa X nameܝ �� �post+�� �� 9 �K�4_<� � �
� � sK�?�:$ �� X�?�? � * e X� �X K�X ^ 2# � 8 ADBO @ ��� �` � �� X > c A W r � 5 O _ Q b � H R 0 f 0 d C * O +
6 & A Q ] P < D g H ] Z 7 j J : ] < ] < � G E M 3 @ 1 G ������ c A A A A A W W W W r r r r r r r r s r r r r r r r r r 5 5 5 5 5 5 5 5 5 O O O O
_ _ _ _ _ _ _ _ _ _ _ _ Q b b b | � � � 7 �
� H H H R R R R R R R R 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 $ $ ! d d d d d d d C C C C C C C C N * * * * * * O O O O O O O O O O O O O O O O O O O O O O O +
& & & & & & & & A A A A A A e ; U p D Y Q Q Q Q Q Q Q Q Q Q Q Q Q Q I Q Q Q Q Q Q Q Q ] P P P P P 6 < < < < D D D D D D D D D D D D D D D D D D H H H H H H H H�� ] ] ' ] Z Z Z Z Z Z Z Z Z Z Z Z 7 j j j j J J J J J J J # : : : ] ] ] ] ] ] ] ]�� < < < < < < < < < < < < 5 < < < < < < < < < < < < < � f � � � � @ G G G G G G G G X g E E E E E E E M M M M M M M M M M M M M M M M M M M M M M M 3 1 1 1 1 1 1 1 1 G G G G G G < ] ] 7 ]�� P ^ ] ] = P < < ? < s E [ > = 7 < < N 3 < M ] ] ] Z V 8 J J J O � * * :�� ] ` < ! , ? ? ? � � c c G 8 8 6 E 2 M 3 1 9 G G ; 0 G Y G R T < R < < < < < < < < < < < < < < 9 < < < < < < < < < < < < < < < < < < c c c c c c c c c c c c c c Z c Z c 8 c c c c c c c c -�� c c c � + r A O 0 _ b + H R F 0 O f K * & 6 , & $ _ ( & 9 ] 0 A [ t ] H Q d 8 T / \ @ ] < B O , 8 5 " Z ] O , % 9 [ ] Q Q @ O O " Q O d > [ � D � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � c c � r > N N f H O 0 O f A * / 6 O A ( & 7 b . , r r � B C _ _ Q�� ' f N / K 0 & � < > f O A & & 6 A [ _ �� r ; N 0 0 / / Q K h � * D > d d n @ ] < ] ] P B 1 @ ^ X : : # F } = , 7 D D � P G Z Z 7�� : n d 1 g ) < F � H > n ! ] P 3 3 @ X ] J Q D E d < < 1 1 < < U c c c * G a E 9 ' 8 M F D C G a G a E 9 ' 8 N F D C G a G a E 9 ' 8 M F D C G a � � � � � � m y � � � � ^ f � f � � � R ` U U U P P � � � � � � u � � � u � u � < < >�f � z � b x c c c T [ H � ] W ^ t � b � b � b � b � b p�� 1 1 W h � � � U � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � F � � � � � � � � � 4 � � � � � � � � � � � � � � � � = : U M 5 : q 1 ` N . * m * T = ` l - 7 7 * E 0 S U U f U � U U x k U U U o U L L U U ` U�� � � � T L � � > + & F O F 4 t ! ! ` Q V g ! !�� U < J > W I I ! > > > > > > * * �� D 3��� M ������ - <�� ` 1 � � � � � � � � � � � � � � � � � � � � � � � � � 5 � � � � � � � { � � � � � � � � � � � � � � � � � � � � � � � k j � � � � � � � � �# � � � � � � � � � � � � � � � � � � � o � � � � � { �?�f � � � � � � � � � � � � � 5 Y � � � � � � � � � � � � � � � � � � � � � � � � ��� � ! ! � � � ����� � ����� � � � � � ����������������������������������������� K K �� � � ����� � ����� � ����������������� ���� � �� �� � ,����
, , M 4 9 c S - �� �� $ � , $
� � � ���Rkl���������mnopqrstuv�������
������ ! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5���� : = R ^ � � �
*)+-KJLNipoqsr������VS���������� M �����T������&(u�����W�����o 6 9 � ����������� �hU������l 8 _ 7 a ] � � ~ � � � � � �U���������� � � � / 9 @ Z ` z ~�������������7C\ghnv{~������������������ *,14=E_auz~���������������/_cu�������������� C I M P R X [ � � � ! + ; I S c g o � � � � � � � � � " & 0 3 5 : ? D I q y � � � � � � � � � � � � �!!!! !"!&!.!^!�!�!�!�" """"""" ")"+"7"H"a"e###!%�%�%�%�%�%�%�%�%�%�&&&<&@&B&`&c&f&k''R'd'�..%������ 0 : A [ a { �������������7CP^hjox}������������������ #,.49@_atz~��������������� 0br�������������� C G M O R V [ � � � $ 2 > R X f l ~ � � � � � � � � & / 2 5 9 < D G p t } � � � � � � � � � � � � �!!!! !"!&!.!P!�!�!�!�" """"""" ")"+"7"H"`"d### % %�%�%�%�%�%�%�%�%�&&&:&@&B&`&c&e&j''R'd'�.."������ = �� �� ��o Y ���
���� ������������ �x�p�o� %$#$ ��;�:�. �� ��� �� ����������� �� �� �� ����� �- �i� �o �d�c�j �$ �~ �|�y�� �� ��� ��� �����z�z � ���� �� �T �i�p�l�G �%��� �s� � �� ��� ޚޙ�r�m �cݹ�j�q�վջ%y%l � � � �� ��� ������� � � �� �� ��� " " , 028>HNPZ\^bfprxz z | | xz����������� ������ �� � � �� � � � � � � � � � �� � � �� ���Rkl��������������������������o�VSQT����&���������������(�mno� 6 7 8 9 : = M R ] ^ _ a ~ � � � � � � � � �� � � � � � � ��
)*+-JKLN�iopqrs��������� ; < @
S T! V# U" W$ [( b. c/ d1 e0 `, p< q= r> s? xC }I �M �O �T �Q �U � �V �WZ �[ �] �\ �b �a �f �j �hn �� �t � �u �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� � �� �� ��� W w �� �� ? �P �v �� �� �� �� �� O t@ �w o; �g > N �� �� �������������������� �����2:?A��������H4;@I��
"-./02467� C#JE��v�wxy|~�z}�������������������J KLMNOPQRS T
U V W
XYZ[\]^_`abcd*,-358<= Q X% Y& Z' n: uA zE yD {G |H �X �Y �^ �_ �` �c �d �e �k �l �m �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� ��F� A B C D E F G H I J K L f2 g3 h4 i5 j6 k7 l8 m9 �R �S �x �y �z �{ �| �} �~ �� �� �� �� �� �� �� �� �� �� �� �� �� �� �� ����������������������������������l��������1��6gY]Uebck�x}~pqrstuvwyz{|���������������������������������������������������������� $� ! ! � " " � # # � $ $ R % % k & & l ' ' � ( ) � * * � + + � , , � - - � . . � / / � 0 9 m : ; � < < � = = � > > � ? ? � @ @ � A Z [ [ � \ \ � ] ] � ^ ^ � _ _ � ` ` � a z { { � | | � } } � ~ ~ � � � o � � � � � V � � S � � Q � � T � � � � � � � � � � � � � � & � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � ( � � � � � m � � � � � 6 � � = � � M � � R � � ] � � a � � ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �
� � � � � � ) � � - � � J � � N � � � � � i � � o � � � � � � � � � � � � � � � � � � � � � ; < @
S T !
V # U
" W $ [ ( b . c / d 1 e 0 ` , p < q = r ! ! > " " s # # ? $ $ x % % C & & } ' ' I ( ( � ) ) M * * � + + O , , � - - T . . � / / Q 0 0 � 1 1 U 2 2 3 3 � 4 4 � 5 5 V 6 6 � 7 7 W 8 8 Z 9 9 � : : [ ; ; � < < ] = = � > > \ ? ? � @ @ b A A � B B a C C � D D f E E � F F j G G � H H h I I n J J � K K � L L � M M t N N � O O P P � Q Q u R R � S S � T T � U U � V V � W W � X X � Y Y � Z Z � [ [ � \ \ � ] ] � ^ ^ � _ _ � ` ` � a a � b b � c c � d d � e e � f f � g g � h h � i i � j j � k k � l l � m m � n n � o o � p p � q q � r r � s s � t t � u u � v v � w w � x x � y y � z z � { { � | | � } } � ~ ~ � � � � � � \ � � � � � W � � w � � � � � � � � � � � � � � � � ? � � � � � � � P � � � � � v � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � O � � � � t � � @ � � � � � w � � o � � ; � � � � � g � � > � � � � N � � � � � � � � � � � � 7 7 � C C P P P � Q Q � R X � Y \ � ^ g � h h � j j � k n � o v � x { � } ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � 0 � � 2 � � : � � ? � � A � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � H � � 4 � � ; � � @ � � I � �
" $ # & - ' ' 2 ( ( 4 ) * 6 , , 8 . 1 9 4 4 = 9 = > @ @ � A A B B C C C # D D J E E E _ _ F a a G t u � z z � ~ ~ � � � � � � � � � v � � � � � w � � { � � | � � ~ � � � � � ^ � � o � � z � � } � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � / � 0 _ b b � c c J r r s s K t t u u L � � � � M � � � � N � � � � O � � � � P � � � � Q � � � � R � � � � S � � � � T � �
� � U � � � � V � � � � W � �
� � X � � � � Y � � � � Z � � [ � � � � \ � � � � ] � � � � ^ � � � � _ � � � � ` � � � � a � � � � b � � � � c � � � � d C C ) G G * H I , M M / O O 3 P P 5 R R 7 V V 8 W X < [ [ > � � + � � . � � B Q X
% Y & Z ' n : u ! ! A $ $ z % % E & & y ' ' D ( ( { ) ) G * * | + + H 2 2 � 3 3 X 4 4 � 5 5 Y 6 6 � 7 7 ^ 8 8 � 9 9 _ : : � ; ; ` > > � ? ? c @ @ � A A d B B � C C e D D � E E k F F � G G l H H � I I m R R � S S � X X � Y Y � Z Z � [ [ � \ \ � ] ] � ^ ^ � _ _ � ` ` � a a � b b � c c � f f � g g � l l � m m � n n � o o � ~ ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � F � � � � � � � � A � � � � B � � � � C � � � � D � � � � E � � � � F � � � � G � � � � H � � � � I � � � � J � � � � K � � � � L � � � � f � � 2 � � g � � 3 � � h � � 4 � � i � � 5 � � j � � 6 � � k � � 7 � � l � � 8 � � m � � 9 � � � � � R � � � � � S � � � � � x � � � � � y � � � � � z � � � � � { � � � � � | � � � � � } � � � � � ~ � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � p � � � � � � � � � � � ! � " " � & & � / / 0 0 l 2 3 � 5 5 � 9 : � < < � = = � > ? � D D h G G � H H � I I � p p � q q 1 t y � } ~ � 6 � � � � � � � F � � X � � g � � Y � � Z � � \ � � ] � � U � � d � � ^ � � ` � � e � � b � � f ! ! � ! ! � ! ! k ! ! � ! ! � !" !" � !& !& � !. !. � !P !P x !Q !R } !S !Z p ![ !^ y !� !� !� !� � !� !� � !� !� � !� !� � !� !� � " " � " " � " " � " " � " " � " " � " " � " " i " " � " " � " " � " " � ") ") � "+ "+ � "7 "7 � "H "H � "` "` � "a "a � "d "e � # # � # # � # # � # #! � % %� s %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � %� %� � & & � & & � &: &; � &< &< � &@ &@ � &B &B � &` &` � &c &c � &e &e � &f &f � &j &k � ' ' � 'R 'R � 'd 'd � '� '� � . . � ." .% � � � � � � � �� �� � � � � � � � � � � � * * M � � � � �'>St����<x���4q���Bq���g�����*V���Ac���$/:EP[fq|�� ! , 7 B M [ f q | � � � � �
"
-
8
C
N
Y
d
o
z
�
�
�
�
�
�
�
�
� : E P [ f q | � � � � � � � � � � � ? J U ` l w � � � � � � � � �
#
.
9
D
O
Z
e
p
{
�
�
�
�
�
�
�
�
�
� (3>IT_ju������� '2=K������� ;FQ\gr���������� )4?JUp{���������"-8CNY����������� '2=HS^it����Hj����������Ze�������
+6D����
#.9u�������� mx������������
+6BNYdp{��������� .9DOZs~��������$/:EP[f��������� > I T _ j u � � � � � � � [ f � � � � � � �
+ 6 A L W b � � � � � �
< G R ] h s ~ � � � � � � � & Z e p { � � � � � � � � � � � �! !!!!,!7!B!M!X!c!�!�""6"y"�"�#+#^#�#�$$]$�$�% %%F%�%�%�&&?&�&�''E'�'�'�(!()(4(I(T(n(z(�(�) ))N)�)�)�*)*P*�*�*�++7+g+�+�+�+�,N,z,�,�,�-(-a-�-�-�..2.[.�.�/+/o/�/�0 060c0�0�0�0�11 11"1-181C1N1�1�1�1�1�1�1�1�2 2 22!2,2:2�2�2�2�2�2�2�2�2�2�2�33
33#3.393D3O3Z3e3p3{3�3�3�3�4 4H4Z4e4q4|4�4�4�4�4�4�5585@5H5W5w55�5�5�5�5�5�5�5�66!636;6S6[6c6�6�6�6�7%7B7`7}7�7�7�7�8 8c8�8�9$9d9�9�9�: :O:v:�:�;%;Q;�;�;�<<D<~<�<�==P=�=�=�>(>3>>>I>T>_>j>u>�>�>�>�>�??D?\?�?�?�?�?�?�?�?�?�?�@ @@@#@+@3@;@C@K@S@[@c@k@s@{@�@�@�@�@�@�AA3ATA�A�A�A�A�BB6B>B�B�B�B�C CGCOCWC_CgCoCwCC�C�C�C�D D4DPDtD�D�D�E EDELETE�E�E�E�E�E�E�F$FNFqF|F�F�F�F�GG/GAGYG�G�HHDHaH�H�H�H�II<IDIOIZIbImIuI�I�I�I�I�I�I�J(J7J`JhJ�J�KKK8K_K�K�K�K�K�K�K�K�LBLJLaL�L�L�L�L�MMEMsM�M�M�M�M�N!N)N1N9NAN}N�N�N�N�N�N�O OO<ONOeO�O�PP8PRP�P�P�P�Q Q(Q3Q;QFQNQYQaQlQwQQ�Q�Q�Q�Q�Q�RRRkR�SSSBS�S�S�TT3T�T�T�UUCUZU�U�U�VV!V<VDV�V�V�V�WW@W~W�W�XX1X�X�X�Y Y Y?YKYWY�Y�Y�ZZ>ZOZZZzZ�Z�Z�Z�Z�Z�Z�[[[ [%[-[5[A[M[Y[a[j[�[�[�[�[�[�\\ \.\D\U\k\�\�\�\�\�\�\�]]!]2]s]�]�]�]�]�^^)^O^�^�^�^�_L_�_�`/`m`|`�`�`�`�`�`�`�aaama�bb2b�b�c#cScqc}c�c�c�c�c�dddd#d,d5d>dGdPdYdbdkd�d�d�ee!eMe�e�e�f#f?f\frf�f�f�f�g$g<gjg�g�g�h7hRhmh�h�h�h�h�h�h�h�h�h�h�h�iiii i(i0i8ipi�i�i�j0jSj�j�j�k#k<kZk�k�k�l l;lZl�l�l�l�m mLmzm�m�n nLn~n�n�oo@o�o�o�o�o�o�ppVp�p�qq>qyq�r r\r�r�ssWs�s�ttDtzt�t�t�uuu!u)u9u�u�u�u�u�u�vvv&v6vFvVvfvvv�v�v�v�v�w w w-wFwsw|w�w�w�w�w�w�xx$xDxlxwx�x�x�x�yy<yLyWygyoy�y�zz z>zFzNzqz�z�z�z�{{Y{�{�{�{�{�||3|N|h|�|�|�|�}}$}H}d}�}�}�}�}�}�~~~-~>~U~f~}~�~�~� 5m�����e�z���'�����@���(�h����;�\�y���������Ą�� �*�2�:�B�J�Y�a�i�q������������������dž����������Ɇ׆��%�K�X�e�m�u�����Ї�� �A�f�����ʈ���A�V�k��������̉��(�B�b�j�z�������͊݊��
�� �(�B�]�z��������
�� �(�O�h�x�����Ќ،�� �$�P�|���Վ�.�r���Ɏ��-�G�a�{�������C�k�����ّ�>�{���ܒ��+�N�q�������0�j�j�j�j�j�w���������͓��!�>�]�{���������͔ݔ��� �.�=�M�]�m�|�������Ε�� � �1�D�Y�n���������і���!�7�L�_�r�������×ח���0�H�`�y�����Řߘ���+�C�\�t�������řٙ� ��*�C�X�m�������Țݚ� �#�<�[�s�����ٛ���)�H�j�����Ҝ��"�2�C�g�t�����������ÝН����&�2�?�L�Y�f�s�������������Ξ۞����(���ͦۦ����'�8�I�W�m�~�~�~�����ŧ��)�L�T�a�t���� > � 3!%!''#7'377# >��I46u���1B�Ba��l:�ggP��^ww��� 8� 3'&&'#3#'#� � ! ��^�X>�?odd7m99m�Z��p�� c #� " 332#32654&##32654&##c�Ce98;HP�nvYTIML]jT][Vj� F:1O NDa_|675,��;C=5 A��*� "&&546632&&#"3267_Q�LL�U;\ /B)?]44]?-H /'c Q�kj�R0 5!AvRRyB-2 W )� 332#'32654&##W�����SIqooqI�����D�||� r � 3!!!!!r�����L�F�G�G � � 3!!!!�������F�F�� 5��� "&&546632&&#"3275#53QR�IK�UAX /?/=\3iaI)�� e Q�kj�R3 5"AvR|�'�E�� - O � 33!3#!OTTT������p5�� _ �� 353#5!#3_�����GFF��G Q���� "&'73265!5!7j"4 K&GA��f)^ 583,+KQrF�A=e< b D� 3333#bT_��^�q���I��iX�� � � 33!�RE���G H � 33373#4667##'# Hf\ ]fP%^<\&���jj�pH WU ���� UW �� R � 333&&53#'#R\�? P\�? ��d�1k4T�p��2h3�� 0��(� "&&546632'2654&#",Jr@@rJJr@@rJK[[KK[[ R�lj�PP�jl�RI�~|��|~� f � 332##32654&##f�Im==nHsiVSTUi�$UHEZ,��HAFG7 0�]+� & %2654&#""&'&&5466323267,K[[KK[[ Wn_u@rJJr@p\J3 %9��|��|���XB��j�PP�j��+*C d )� 332##32654&##d�Cg;PC�_�umMQQMm�#QDL]����Y?@A4 C��� - "&'732654&&''.546632&&#" 1Hz,2%c8DK 5"^!A,7a?>h$, N39F#6 \)A'8h 5,:%-:.#* )
*B02O--$6 !4, ( (-A14U2 * .� !#5!#��JFF�� O�� � "&&53326653-@e9T$?'(>%Q9c 4r^��fDQ$$QD��h^r4 + -�
3336673��Xj iU����:e::e:b�p
N� % 33 3>773 3>73#&&'#nd^0
@P>
.Z`h@
@��d-/!!/,��,/!!/,��o : : �� 6 "� 33366773#'&&'#6ķ\\
ZX��\c
bS=�, ,������3 3� & 2� !53366773�Xc$&_V����%L((L&�Z� A � 35!5!!An�����t2F2��G Q��� ' "&&54667.#"'6632#'#'2675�-K-G�}8//Y" %s@daC(d )S)hw1A !>+7I,
!7"%8.m[��B /B&"�!1 )% ]�� � ! "&'##336632'2654&#"@#Q#BR!W+bh>dG@T@I I&#G # 6��^"(�qSv>EgZPc#&� P��� "&&546632&&#"3267ZLxFJ|I;X ) A&8U0/T8-K %(c <rPRr<* 5 /U87T/$5$( <���� ! "&5466323'53#'#'275&&#"_t?e9,F RD S HA!? *E)L �yOs>! Z��8@ -EI� /S8Wc D��� "!&&"&&546632!3267><^ 6N2IwFFqAiu��iL,G! $]�MHKJ�C<sQOr=}g
RT6" g B� 3#5754632&&#"3#�`dHD 3 A:���>)Yl > D;,C�] H� 6� 0 < L "&5475&&54675&&5466323##"&'3322654&#"2654&##"&'(jvP #5W3) �~2U5+50m^[ByX/AA/.BB9Ub78_%" Q�G@>. & 1@+5N+ C4 4K( 4>-N/�?43??34?��<%#)&- ] � 3336632#4&#"]R&W9VRR4<+D+��s)6d`��#EC,,�� �� Z ��&U
0 �� 7�'��&�
0 j >� 3333#'jR^��\�s� ���q� J��� "&5#53327�MS��5++0"8 YV�C��50= : .� ! 33366326632#4#"#4&#":B2*G3*39R4!L%�@"*T'-MI��VU%&��V*+%&�� ] � 3336632#4&#"]D&X9VRR4<+D+�S)6d`��#EC,,�� <�� � "&&546632'2654&#",@mCCm@@mCCm@FUUFFUU <rPRr<<rRPr<DgSThhTSg ]�3 � ! 336632#"&'#2654&#"]D"Y-bg>d;"O �AU@I I&#F��> *�qRv>! \�gZPc#&� <�3�� ! 57##"&546632373275&&#"� Q-^t?e9,H"B�HA!? *E)LͱZ +�yOs>" 6�MI� /S8Wc � � 3336632&&#"�D&pC/$ 7e,�s;D G ?L�� G��� ( "&'732654&&'&&54632&&#" 6G|,&*fC>=AB^`fd8h$("R/>2CJQW!2` - 6 $-
C7;O%5 * "*6%'B( E��"� "&&55#57733#3267�GR#�� D��5F#8!I 3Z<�>��C�AD
< M���� "&5332673#'#�WRS3=*E(RC%X d`.��EC+/Q�U+6 3 %�
!336673 �Sp
pO���%G##G%� P� 3336677336673#'&'#rjR: <R: :Lhj8 6��"A##A"��"A##A"��3]]3� @ � 37'3366773#'&&'#@��[M
IW��ZU! P��k+,i�p.+p 1�/'� "'732677336673�$
3@�Sw
jN�6O�
A;-$�� J##I!
��0L- G � 35!5!!GM�����W,wC,��C �� 8c& � �� 8c& � �� 8F& �� 8I& �� 80& �� 8& �� 8J& �� 8p& 8�
+ "&54773'&&'#3#'#2654&#",*7%�%O %8m � ! ��^�X>�?� �2(0i2*.!(2��dd7m99m�Z��p��� �� 8M& � _� % 3'&&'#"&54667#'##33267� � !
+<(>�?U�^�&5 .odd7m99m�y-. 3'
����p>%
+�� �)8�& - �� 8h& �� 8x& T �� 8x& V �� 8�& X �� 8�& Z �� �)8F& & - �� 8�& \ �� 8�& ^ �� 8�& ` �� 8�& b �� �)8J& & - �� O� 3#!#3#3!5#�.�+�?�����IywL6j�R�F�G�G������ Oc& M �x ���� O& M x )� ! * 35#5732#'32654&##3#532654&##iOO�Ce98;HP�nvjT][Vj��YTIML]�8� F:1O NDa_F;C=5V>�675,�� c�V#�& < �� A� *�& 32 �� A��*c& �. �� A��*F& . �� A��*M& . �� A��*;& . �� W )M& �� W�))�& -� �� W�V)�& <� �� W� )�& 3� �� )� � 7� 3&&546632#'32654&'�9:'%(3;8oR���zRVZcS P70::XEAd:����D��z��� r c& � �� r c& � �� r F& �� r M& �� r 0& �� r & �� r J& �� r ;& s� )� "&5467!!!!!!#3267�,;5!�������K0 "
-�-.-F�F�G�G#2
+�� r�)�& -! �� r h& �� r I& �� r *x& T �� r x& V �� r �& X �� r �& Z �� r�)F& & -! �� r �& f �� 5��c& � �� 5��F& �� 5��J& �� 5��;& �� 5� �& 0 �� 5��M& �� 5��& �� 5��I& 5��M$ 1 &&#"3275#53#"&&546632&54632&&#"
/?/=\3iaI)�� e@R�IK�U'>1 L5"AvR|�'�E�� -Q�kj�R/:? '�� O F& �� O 0& �� O�) �& - �� � �& 3�N �� O� �& 9
N� 3#5753!533##!!5!OEETTEET�����8nnnn>� 5��}g�� _ �c&
� �� _ �c&
� �� _ �F&
�� _ �I&
�� _ �0&
�� _ �&
�� _ �;&
�� _ �M&
_� �� "&5467#53#5!#3#32677+<.�������&$" -�-.*DGFF��G <
+�� _ �h&
�� _�)��&
- �� _ �J&
�� Q���F& �� b� D�& 0& �� b�)D�& -& �� b�VD�& <& �� | c&
�� �� � &
|�� �� �&
01 �� ��) �&
-1 �� 7�) &
&� -1 �� ��V �&
<1
�
35'737!�_ |R� �E�45Bd��q5��G �� � �&
���� H c& � �� H ;& �� H�)�& - �� R c& �
�� R c& �
�� R M&
�� R I&
�� R� �& 0 �� R ;&
�� R�)�& - �� R�V�& < �� 0��(c& � �� 0��(c& � �� 0��(F& �� 0��(I& �� 0��(0& �� 0��(& �� 0��(l& �� 0��(J& �� 0��(M& 0� (� ! - "&5467.54663232672654&#">,;+ Mk6@rJJr@^W.."
-/K[[KK[[�-.(<\�^i�QQ�i��%@
+ ��|��|�� �� 0�)(�& - �� 0��(h& �� 0��(x& T �� 0��(x& V �� 0��(�& X �� 0��(�& Z �� 0�)(F& & - 0��2- ' "&&546632654'7'2654&#",Jr@@rJ>1NA 80,2@rJK[[KK[[ R�lj�P F *3? +�]l�RI�~|��|~� �� 0��2c& � � �� 0��2c& � � �� 0��2h& � �� 0��2I& � � �� 0�)2-& � - �� 0��(�& f $��0� ' 77&&5466327#"'&#"2654'$C @rJWA48@ @rJYA6*�,>K[�K[�+b+tFj�P9M$^*rGl�R<PkW?l2��v�~Y<��6�� $��0c& � � ! O� !"&5463!#3#3%3#"(|��|���UUU����F�G�GD�}}� �� d )c& � �� d )M& �� d );& �� d� )�& 0 �� d�))�& - �� d�))& & - �� d�V)�& < �� C��c& � �� C��F& �� C��M& �� C���& h �� C� �& 3 �� C� �& 0
�� C��;& �� C�)�& -
N��9� & "&'732654&&''7&&#"#4632�1T (6#.5 JE|?+@OTziSgycL+P '"5 >/ 7+
6�)([_�c�n�TF� bD3Q/�� * .M& �� *� .�& 3 �� *� .�& 0 �� *�).�& - �� *�V.�& < * .� !#5735#5!#3#�Z4�؎�2:�FF�>�� �� O�� c& � �� O�� c& � �� O�� F& �� O�� I& �� O�� 0& �� O�� & �� O�� J& �� O�� p& �� O�� l& �� O�� M& O� � % "&5467&&533266533267>,;/]nTN;(?%QFD;-"
-�-.+>~���ffS$QD��hjs>
+�� O�� �& P �� O�� �& I �� O�� �& R �� O�� �& L �� O�) �& - �� O�� h& O��v9 ! "&&533266536654'7-@e9T$?'(>%!)+A ?.9c 4r^��fDQ$$QD�$* ):8 ��^r4�� O��vc& � � �� O��vc& � � �� O��vh& � �� O��vI& � �� O�)v9& � - �� +�)-�& - ��
Nc& � ��
Nc& � ��
NF& ��
N0& �� & 2c& � �� & 2c& � �� & 2F& �� & 20& �� & 2;& �� &�)2�& - �� & 2h& �� & 2I& �� A c& � �� A M& �� A ;& �� A F& �� A�)�& -
�� A�V�& <
)� 3#5732#'32654&##3#WKK�����SIpoopI��:8����D�||��> e !� 3332##532654&##eTvIl==mHvkVTUUk�n%THEZ,��AFG6 ;��&� "&&5447!&&#"'6632'267!,Im;�VP(C( W:No<?qJEY��S T�f v� 9 )R�ii�THsoqq U��%� ! "&'7326654&&#"#36632z* +%B-%R SQ W0>b8)L K/uhcq06(� �M%4@�{~�E p�[�� 33"&'732653pS�%
&S?��p�B4,��mJX D *� 333"&5463233DL� !--!!//EL����G-''++''-�����G�� Y�[9c& '��n � � �� Q�� & � �� Q�� & � �� Q���& �� Q���& �� Q���& �� Q���& �� Q���& �� Q���& Q��K
* 5 A "&5477"&&54667.#"'6632#'#'26752654&#"@4:/�#I%):~-K-G�}8//Y" %s@daC(d )S)hw1A^!!!!98(6a2#3"(8��!>+7I,
!7"%8.m[��B /B&"�!1 )%("!!"�� Q���& Q� %� . 9 "&5467'##"&&54667.#"'663232672675�+<8'(d4-K-G�}8//Y" %s@da6/% /�)S)hw1A�./-D= /!>+7I,
!7"%8.m[��= '&"�!1 )% �� Q�)�& - �� Q���& �� Q��+& S �� I��& U �� Q��& W �� Q��#& Y �� Q�)�& & - �� Q��@& [ �� Q��@& ] �� Q��P& _ �� Q��"& a �� Q�)�& & - ��U� 3 @ "3&"&'#"&5467&&#"'66326632!3267%3267&55�%A�H3K#P,7Iu�0& = O+,>K(3B ��@9 0 A�q)! >CL �DQ��C.)).G=J\G98 /55/=e<
LY
8�#'#"6A
"/�� ��U & � �� ��U�& �� � ) "&'###57533#36632'2654&#"@#Q#BIIR��!W+bh>dG@T@I I&#G # 62;VV@C["(�lPq<EbUL]#&� �� ]�V �& <
�� P� �& 2. �� P�� & �. �� P���& . �� P���& . �� P���&
. 6��k0 ! & "&5466323'53#'#'275&&#"3�Zn;`7)B O@ NA@ : (B'HUJ �yOs>" Z��8@ .EI� /S8Wc� Q��� <�)��& - �� <�V��& < �� <� ��& 2� <��D� ) "&5466323'5#53533#'#'275&&#"_t?e9,F ��RIID S HA!? *F)L uLn<" Z9@VV:��@ -EI� -O4R^�� D�� & � �� D�� & � �� D���& �� D���& �� D���& �� D���& �� D���& D� � 3 "!&&"&5467#"&&546632!32673267><^ 6N*-:+! IwFFqAiu��iL,G! 3=$
/�MHKJ�n./(? <rPPs=}g
RT6$5/ '�� D���&
�� D�)�& - �� D���& �� D���& �� D��'& S �� D��& U �� D��& W �� D��#& Y �� D�)�& & - �� D��K& e �� H� 6 & " � �� H� 6�& " �� H� 6�& " �� H� 6�& "
�� H� 6�& " 1 �� H� 6�& " �� H� 6�& " �� H� 6�& " ���� �& # �W <���� l& # �W <�� ]�) �& # - �� ]�V �& # < �� '� �& # 2�Z �� ]� �& # 9 � 3#57533#36632#4&#"]IIR��&W9VRR4<+D+2:VV@@s)6d`��EC,,���� Z � &U �0 �� Z � &U �0 �� Z ��&U 0 �� Z �&U 0 �� Z ��&U 0 �� Z ��&U 0 �� Z ��&U 0 �� Z� ��&M
0 �� Z ��&U 0 �� Z�)��& $ -0 �� Z ��&U 0 Z �� !#5!<�4�C��� 7�'��&� 0 �� j� >�& & 0# �� j�)>�& & -# �� j�V>�& & <# j >� 337%3#'jR^��\�s� �����n��� J���& ' ��<�� J��0& ' � �� J� �& ' 0U �� J�)�& ' -U �� J�)T& ' &�< -U �� J�V�& ' <U J��� "&55'75#537327�MSl ���� �5++0"8 YV�@6P�C��T6d�50= �� #��{�& '�
��� : . & ( � �� : .�& (
�� :�).�& ( - �� ] & ) � �� ] & ) � �� ] �& ) �� ] �& ) �� ]� �& ) 0
�� ] �& )
�� ]�) �& ) -
�� ]�V �& ) <
�� V� & 3336632#4&#"'667#"&54632�D#P5OLS.4'='�� /6 (* (2L�L%3a]��)B@)(��^0P4( #+@9Kv �� <�� & * � �� <�� & * � �� <�� �& * �� <�� �& * �� <�� �& * �� <�� �& * �� <�� �& * �� <�� �& * <� � " . "&5467.54663232672654&#"D+:*Bi<Cm@@mC+L4(-$ /7FUUFFUU�./'=?pKRr<<rRC]>@
'gTThhTTg�� <�) �& * - �� <�� �& * �� <�� & * S �� 5�� & * U �� <�� & * W �� <�� #& * Y �� <�) �& * & - �� <�� �& * �� <�� K& * e <��/� ) "&&5466326654&'7'2654&#",@mCCm@7.)-@ ?,(0Cm@FUUFFUU <rPRr< /+ *:A gDPr<DgSThhTSg �� <��/ &� � �� <��/ &� � �� <��/�&� �� <��/�&� � �� <�)/�&� - <�� ( 7&#"'7&&5466327#"'72654'��&6FU%.5 Cm@O=4.5 Cm@O=�FU�/�<.!j��*> T4Rr<+=*> V5Pr<+iS?,���� <�� &� � ��U� 7 72654&#""3&"&&5466326632#3267#"&'�,44,1333'6���1N-.N1.BH.0@ �A1) =#1NB8hSShgUSgyKJ��C<rPRr<:>>:=e<
SR
88==8 �� � & - �. �� f� �& - 0� �� � �& - . �� � �& -
. �� ��)�& - -� �� ��)�& - &. -� �� @�V�& - <� �� G�� & . � �� G���& . �� G���& . �� G��-& . g �� G� �& . 2 �� G� �& . 0 �� G���& .
�� G�)�& . - X��4� 3 "&'732654.54>54&#"#4632 �*F ! 4 *-)<<)$-)7?Rk^5I&$)<;)(I :/ #* "2*"2+0 %1LJ�\q)C(%6+* $ %:/*C( g B� 3#5754632&&#"�`dHD 3 A:�>)Yl > D;�� �� E��"0& / � �� E� "�& / 2Y �� E� "�& / 0O �� E�)"�& / -O �� E�V"�& / <O �� E��"C& / �� � E��"� "&&55#575#57733#3#3267�GR#���� D����5F#8!I 3Z< :�>��C�@ AD
< �� M��� & 0 �� �� M��� & 0 �� �� M����& 0 � �� M����& 0 � �� M����& 0 � �� M����& 0 � �� M����& 0 � �� M����& 0 � �� M����& 0 � �� M����& 0 � M� � & "&5467'##"&53326733267�+<8'%X8WRS3=*E(R6/% /�./+AU+6d`.��EC+/Q�: '�� M��� & 0 O� �� M���L& 0 H� �� M���H& 0 Q� �� M���L& 0 K� �� M�)��& 0 - �� M����& 0 � M��V� ! "&53326736654&'7#'#�WRS3=*E($2@ :#C%X d`.��EC+/Q*1 +:;�7U+6 �� M��V &� �� �� M��V &� �� �� M��V�&� � �� M��V�&� � �� M�)V�&� - �� 3�)%�& 1 - �� P & 2 � �� P & 2 � �� P�& 2 �� P�& 2 �� 1�/' & 4 � �� 1�/' & 4 � �� 1�/'�& 4 �� 1�/'�& 4 �� 1�/'�& 4
�� 1�-'�& 4 - � �� 1�/'�& 4 �� 1�/'�& 4 �� G & 5 � �� G �& 5 �� G �& 5
�� G �& 5 �� G�)�& 5 - �� G�V�& 5 < <��� 1 7326544'&&#""&&546632&&''7&&'77�,J-PM#R'PS�?mB;gB/T
:,� �: &&I!� v?M:k�2K)oW
/&\��9iHDe8*&Bd'N4B 4)F2==�wPyD ]�3 � " 336632#"&'#2654&#"]R"U+bi?d:$L �@VAI H&#F���W"(�qRv># \�gZPc#&� ]�I � "&'732654&#"#336632�( &4<+D+RD&X9VR?� ?7/1EC,,���S)6d`��N[ 7�'�� "&'73265#5!�&H 9 I2�4%X�=
F>�C�<\5 ]�' � + 33"&54632"&'732653"&54632pR(##""�$
%R<##""�J ��>3, ��JX# ����l� / "&5#533267"&54632"&5#533267�@Ck�$ #(!--!!//�?Cl�$ # YV�C��50> -''++''-��YV�C��50> P�'N 33"&'732653'7'7pR�$
%R<��+�:�+�:��>3, ��JX)�8�)�8 ^��� % "&53366323267'>54&#"$dbD(d3.K-��8F0Y" %s�hw1A**R) m[*B . >,RU2I%8.� 1 )%%# ]�� � "&'##336632'2654&#"@$P#BD Z1bg>dH@UAI$J #E # 6�@ -�qSv>EfXSc%$� ]�� � + "&'##4632&#"36632'2654&#"A$Q#BY[0!!62!W+bh>dG?UAH J%#G # 6Sh ?>8z"(�oRt=EeXOa#&� =��� "&'7326654&&#"'66328e'% M-8S/.O4+G * _BFtGFw ($5$/T78U/ 5 *<rRPr< P���
1 %"32654&'667&&546632&&#"6632#"'� H"&.78 ��C ,4JyF>Z ( E*5U1 /g/:>YYC:�,' � < eBRr<( 3 0V9,G486-4H9 <�P_� - "&57##"&5466323'533267%275&&#"">; R-^s?d9,E S
��F@!@ )D(L�I@d +�yOs>" Z��#)/?�I� /S8Wc <��b� - "&5466323'54632&&#"#'#'275&&#"
^s>d9+F @B !D SFA!@ (D(K �yOs>! Z8DM?2*��@ -EI� /S8Wc ?��� "!&&"&'73267!&&546632">U6
WP:]$ "H+Kj��:iE@kAGv�JKHM�C"6TR
Ef9>rPOr= <���� "&546632373#'#'275&&#"^t>f:+H"BD T HA!? *E)L �yOs>" 6�@ -EI� /S8Wc �� s &� E��� "&&5467!&&#"'6632'267!)If5}^J+I! %]:Jp?@mEAW��P <kE
OP6"=qPQs<BOMMO ��m� ( 2 "&&'%&&#"'663273267#"&'74&'326�=T-1D+&8 K1DdI+
6
52[?�@,9D 8_:�818GD 9"
+ (6!Gq@� h<5] [��� ) "&54675&&546632&&#"33#"3267>e~B0)06_==a'!#K2@D�5CLRRL1S$$.i MF48
8$,: " 6%&J@%)+- 6( �� >���! =��� + "&&546632'2654&##532654&#"GLxFIwD6W2+),Ar_=BG6#4:;13Q0c 9qSUr: :-$:
;4FLB-*('@("&%.U=\_ 7�'4� "&'732655#575#5!3#�&H 9 I2���4��%X�=
F>�<�C�B�<\5 <�(cu * 7 "&'732677##"&5466323'4632&#"275&&#"/`) %O%FH Q-^s?e9+F @C
!xaEA!@ )D(L� :F:a )�sLo=" 0AQ?2*�Zf!I� .P4R` <�'�� - "&'732677##"&&546632373275&&#"/b( &P%FL S->_5>e;+J BwdFC!@ )E*M�;G:a );nLLo=# 6�[k"I� .P4R` N��� ! "&&546632&&#"32675#53SHwFIzGAU )?/2U3/R4!9�� a ;rRPr=* 4"-T=;U-p;� ( 3� %� % "&5467336673'2654&'#.7=#�TqpP�#<8�B4#G4���"7""7"
�N4G#4B9";""=" <�� � # / "&5467&&#"'66326632&#"'2654&',UeH9 2 -)K('M(- 2 8IdV29</.=: ZO8f0"!< -**- <!"0f8OZD:-,Q((Q,-: M�3�� 57#"&5332673�'X9VRR4<,C+Rͮr(7d`.��EC-+S�M ] � 34632&#"36632#4&#"]Y[0!!62&W9VRR4<+D+Sh ?>8�(7da�� EB+,�� ]�I � + "&'732654&#"#4632&#"36632�( (4<+D+RY[0" 62&W9VR?� ?7/*EB+,��Sh ?>8�(7da��N[ �� ] ��' �� Z 4�&O
0 V � 353#5!#3V�����C`CC��C �� 8���&Q
0 �3�� ##73753���c�U�rR�� � �i��M�� J���& ' =�� � J��� ) 354&#""&55#"&546325#533#327�!#&
MSTH3' (
����5++0"8n)&��YV�<.&0�C��@�50= J�I� "&5#533267�MR��4+,!:�YV�C�*5/
> O�';� # 33!6#"&'7326654&#"'!OR��E_1=a7K` )J7&=%F> "����,�2Y7Fb30 4%%C->F,�] � � 33!�R.�]C *�� � ! #'##"'#"&53326733267 B2*G3*39R4!L$�@"*T'-MI\��U&%`��*+&%` *�3 � " 57##"'#"&533267332673�1*G3*39R4!L$Rͬd%*T'-MI\��U&%`��*+&%`�M :�I.� - "&'732654#"#4&#"#3366326632�# 4!L%RB2*G3*39:�?0(rU%&��V*+%&���@"*T'-MI��FQ ���I � "&'73265336632#4&#"8
D&W7VQR49+C*8�?/)S)6d`��#GA,,��HS ]�Im� "&54&#"#33663232670C84:+B+RD&V7VR
�SH?GA,,���S)6d`��)/? ` �� 333&&553#&&'#`O�$NO�%��;/['�:/['� <�� � "&&546632"!&&267!,@nBBn@AmBBmA?U >
V?DW��X 9rSUq::qUSr9�OGGO��XOOX !��K� % "&&5466323#3#3#'267&&#"�8]88]8- � .##5JJ :rSTq:D�@�DC_\_a[ ,�3,� # 5.5466753 4&'66:b<<b:P:b<<b:�K99KXK99K��<oNNn<��<nNNo<��UataTTa��a ?���� #'##"&'73267�D&oD.$ 7f+�s:E G ?L ?���� "&'732673#'#�.$ 7f+RD&o G ?L��8s:E ?�I� "&55##"&'7326733267�I=K1+ %IR & .�SKu08 G 5B1� 50 > ��I� "&&5336632&&#"3267MFR#D&pC/$ 7e,5F#8!H�3Z<�s;D G ?L��AD
< � � 354632&&#"��uQ7 0 0S3�y�G (UD� c !� 332#'#532654&##c�5S0H3�]���7==7��?6?G ľ��++,$ c !� 732654I##33��7==7]�3H0S5�S��%+++�� G?5@� G�I� 7 "&'3267#"&55732654&&'&&54632&&#" 6-T$$
$C;&*fC>=AB^`fd8h$("R/>2CJQW!2` 5'0=SOU6 $-
C7;O%5 * "*6%'B( 8�' � "&'732654632&&#"�(> /3 LZ$4&7&F�=
B77Xd= B7��Xc 8�' � # "&'732655#5754632&&#"3#�(> /3 ��LZ$4&7&��F�=
B7�:�Xd= B7�@�Xc 6�d� 23#5#5354&#"'66�GR#�� D��4G"9!I�2[<�>��C�AD
< E�I"� "&&5#57733#3267�FR#�� D��5F#9!P�3Z<�>��C�nAD
< ��J� "&55#57533533##'#'32675#�LH``R�RffD"Nt,0&:"� a]L:����@�L(0�C='+p 2��&� ' "&&546675#53326654&'53# ,Kk8 +j�+8#D33E"8+�j+ 8j ?f82N;C5$bI-N//N-Ib$5C;N28f? M�� � "&&53326654&#"'6632)?c:SR:2E$+-
GU7l /dM��XK;f@JM@diX�O 3 %�
#&&'##X�Sp
pO��%H""H%��� P� #&&'##'&&'##33677�jR:
<R: :Lhj8 6�#A""B"��#A""A#����3]]3� 1 '� 3>32&&#"#&&'#1�4L4"
0=�Sw
j*0M-A<.?�
J#"J!�� 9 !� !53366773�YU#!TXˤB� :!!9 ���� G�Il� "&55!5!5!!3267/D8��F�����I
�QB$,wC,��_)/? G��F� & %"2232654&'667#5!5!3632##�+ %&�> �D�����,N%9`'3NN- �*2$��
5,wC,���1)6H9 ;�'� ! "&&'7326654&#"'!5!632 8U?(!U@-J,WP $ !�����esDm�,5 0&E.AI
. C,�kWGd4 �'j� 6 C "&5466323'53!6232#"&'732654&#"'7##'#'2675&&#"�CX.K+ -L
�0C#-L/1C'- )3-,!��;5'"+5. �xNs? ]��,�5Y6Ea3"4JK?E4��]:+E*!� gSVd ��:� 0 "&&55#57733632&&#" '2654.547#HVe+IL
E� &%A * #'99'l�\G':;'}C ,S=�>�� 0 # (?2CN@-%%/"$4)�A: 0�'[� 3 "&'73265#3267#"&5#5773354632&&#"a#
"� '
-L=HK E�AL
(<�>3,��-1> ZH
>��PIW?4,��JX G �� 3>54&#"'6632�BR'NG9O,!gL?g=1U77%@D+=H1 5%;-YB:UF$�� Y � !.546632&&#"7V0=f?Mg +O9FO'TA$FU:BY-;%5 1H=+D@%�� G � 35#5736654&#"'66323#�LfS[KF:P ,!iN>e<(B&��:/f<=H2 5$<-YB/L=?� R � !5#573.546632&&#"3#�LL&B(;e?Nh", P:FL\R���:=L/BY-<$5 2H=<f/?� T�3� #575#5733#3#����P�����g:l:F��>l>�� <�� � % "&54632'26654&#"7"&54632,m��mn��n.I+]EE]+I.%%%% ��������D;�o����o�;�$ ## $ R�[� "&'73265#'##33&&53�# �? P\�? P9�B5+��2h3����d�1k4T�mKW �� <����� �� <��� & � �� <��� & � �� <����& �� <����& �� <����& �� <����& �� <����& �� <����& <���K
! . : "&5477"&546632373#'#'275&&#"2654&#"04:(�$J&):V^t>f:+H"BD T HA!? *E)LS!!!!98(3e2#3"(8���yOs>" 6�@ -EI� /S8Wc%"!!"�� <����& �� <�)��& - �� <����& �� <��& S �� 9���& U �� <��& W �� <���#& Y �� <�)��& & - �� <���@& [ �� <���@& ] �� <���P& _ �� <���"& a �� <�)��& & - <� � % 2 "&5467'##"&5466323733267275&&#"�*94$ T.^t>f:+H"B4*! -�HA!? *E)L�./+B@ -�yOs>" 6�;
'I� /S8Wc �� <�'��� �� <�'� &6 �
�� <�'��&6
�� <�'��&6
�� <�'��&6
�� <�'��&6 1
�� <�'��&6
�� <�'��&6
�� <�'��&6
�� c 4�&@
c 4� 353#533cŭ��C`C�]C�� c 4 &@ � �� c 4 &@ � �� c 4�&@ �� c 4�&@ �� c 4�&@ �� c 4�&@ �� c 4�&@ �� c� 4�&N
�� c 4�&@ �� c�)4�&? - �� c 4�&@ �� c 4�&P
Z� �� "&5467##5!3267a,<3#�4,,$
/�./*B�C�; ' c� 4� "&5467#53#533#3267Y+</ �ŭ���)'$
/�./)BC`C�]C < ' Z 4�
!5#575#5!3#<���4���8�C�>� c 4� 3535#575#533#3cŴ������C�:�C�@�C 8��� & 3267&&#"&&'#"&546325#5!z)%(0 : ( M5FKB? B!�4
/i � / !B-,8�C�) ?) c 4� 353#533cŭ��CBC�{C�� c 4�&R �"<�� c 40&R � �� c� 4�&R 0 �� c�)4�&R - �� c�)4T&R &"< - �� c�V4�&R < c 4� 353'75#5373c�l ���� ��C @6P�C��T6d��C �� - {�&R�
�� �� \� #53#533353#533"&54632qk�f il�m��####CBC�{CCBC�{C$" !! " �� c 4�&R = % � c 4�
# 354&#"535#"&546325#533#3!"#!x�JA1'$ �����f
*��C�4%!-
�C��/�C �� 8� �� c #� � � 3!!�����F�� + -� 353%!&&'#+�`�YKa!!2^��2G%5o99o5 �� r � �� A � �� O � 0��(� ! "&&546632'26654&#"'53,Jr@@rJJr@@rJ2K)[KK[)K1� T�ii�QQ�ii�TICyRz��zRyC�HH�� _ ��
�� b D� + -�
33#&&'#+�a�Xj i��pc:e::e:���� H � �� R � F � 35!5!5!F�6���GG5GGFF �� 0��(� O � 3!#!O�T����pJ���� f � K � 355!!!K�������_21F���G�� * .� �� & 2� ��>� 5&&5467534&'66k��kLk��k�SIIS�THHTX�wu�WW�uw�XbVm�hTTh�um�� 6 "� , ,� !5&&55336553drP�T�Prd�us���
Z��
���su� & 2� ' 3535.5466323#56654&&#"&y3!=rMNq=!2 y�1A&J66J&A1DPjB\�RR�\BjPD=/�gGqAAqGg�/= $ 8� 3'&&'#3#'#'� � ��^�X;�;.9$Oodd7c;;c�Z��p���
#
� 3!#3#3'�@����?9$O�F�G�G�
#
� 3333##'�L�LL��9$O����p5���
#
�� 353#5!#3'�vv@ww�X9$OGFF��G�
#
�� _ �0 � ��(� "&&54632'2654&#"'\;\4rYZrrZ8CC87CC�9$O Q�l������I��������H
#
( Z� !53366773'e�MI
KJ���9$O���)J&&L'�Z��
#
�� & 20 � 0� # ' 3535&&5466323#56654&#"'�c)/2[=>[1/)c�')?::?)'�9$OD<�^X�OO�X^�<D=;�_n��n_�;=�
#
9��?� 0 "&5466323733267#"&5#'26677.#"�Wm=d92[R
+4@O">*
,3%C*D wTv>8Gs@��-? 03cE)E)[68,V@U] ]�M � 3 46632#"&'72654&#"'>54&#"],ZD1W664J[8Z3.]&�8OFG
5@ @,8B#S��Bg<&L;6R dMA\0!)=v>�JC:N? 1> 88XYX�W. 0�M� 6654.'7 36673�#<K)R#D96N
R 0E0�!0(:���2+��M_�e>no{K+c* A��� $ 1 "&&54667.54632&&#" '32654&',<lC5Y6(A'QU5vFIl),()J11N.8i�,H)KML5U_ 5cE;[?4<%,AA ./ CU;Eh:�/F&YI>U"a [��� , "&54675&&546632&#"3267&"#"3267@j{A.+,6_=6b)!IU=EDI %�MO-R+#5c ND57
:"-: 74&&!(DP(/"7( t�H � ( '6654&&'.54>7""5!#�B945]86Yo9HPK y;q[6(K3PM� $
/]O<yqa%CC#brv69C"
+2G ]�M� >54&#"#4&'336632�,2-G-RK)Y;NE�P��FD>*=��a B&_83a]� H��� "&54632"!&&2667! ,jzzjjzzj=Q&R=)@(��'A ���������|��|��4yffy4 Q��
� "&5#533267�QH��0.,< YV CR�H41
= d��A� 34&'33>7 .'nR(o}> /c1MV(] FC#!%a H > �FrNN
8*3nh,"V_0&-6] 8��)� ''&&#"'6632##�Y�9-
+ 3G5�Y��G?
D
,ZG��� T�E'� & 33266733267#"&'##"&'TR1611S &' P,!7����CE.,Bb�W>.:42 2JB( / � !&&'7 3>73tCR&H9
"=,S
7Q5��]4��H?��AT��W \�H� : '6654&&'.546675&&5467"5!#"3267&&#"�B858`9,I*0?)%+- ��7Q)@!!%-R4.P2SG� $
)L@0O7 H4)?CC>:#6 H"B/05 *2F @��� "&&546632'2654&#",@kAAk@@kAAk@FQQFFQQ <rPRr<<rRPr<DgSThhTSg ��=� " "&54>5#'665#57!#327�:0�R eE�\- ?;FX[(f�kk�b?D)_ZF0? ]�M � ! 46632#"&'726654&#"]=g>kr=a6*Q#�'@&AJ&B(#I��Un7�tRv> (AjA�.W<Pc(Q=|+ <��<� ! "&&54663!&&''2654&&#"">i?Bk=+I*/5<e??P!>.?TS :pPUn5FcDKk9D`R1S4Y[Tb B��� "&5#57!#3267xA4�F�� 0 GD$>CN�E" @ O��� ! "&54654&'332654&'7&bqP&=$@TP;i hi'N' B&8 &e*1<bg3l?;w=Wy? ,�M,n # 5.5466753 4&'66:b<<b:P:b<<b:�K99KXK99K��<oNNn<<nNNo<��UataTTa��a 8�A0�
'7373#�S��R��W��P�� V:������� 5�M)n $ 5&&554&'3336654&'7hbP=@P?ELod��}d� B&8 ?6GU7��ba8eB>qA|�� "��6� . "&546732654&'332654&&'7#"&'#�BZ5&H)*.# (U( $,"I&1UE#;8 xyM�9!=qMLR7C =''= F4TW2MH) :{Uzz'**' Z�L � % '6654&&'.546632&&#" �B./9hAHvC=U * <)2P./Q2:? �!, 4aONm9' 5,O59D% +"M ]�� � ) 5 ".546632'2654&#" 6654&#"I(TE+-[E/V6<5P\:a?;MEHH? 15��g@*;@ 7ZBBh;%M;6T iO>Z1HL:;Q #6E'�!6W@88Y O���
+ 7&&""&54&'332667.546632�@pVZH5E�\hMH3)@'k�S#6Z6|:g >. �x>��c_'/3"J>0|q BR&7R-����H�� ,�M,n� %�M3� ) 6654&#"5.546754632S>N'& #O:f?=.@+/P>S@JR>e;+=y>fWS`;�۪9nQK�604dDQ\�k_�qPs?+V*�� 9��? & �� [�� &� $ �� ]�M &� �� Q��
&� � �� Q��
�&� � �� @�� &� �� O�� &� � �� O���&� � �� "��6 &� �� Q��
&� J� �� O�� &� J� d�EA� & 34&'33>7 '667.'nR(o}> /c1MV(!I _'F FB#!%a H > �FrNN
8*3nh,4d#)X+"U_0&-6] >�M� %2654&#"5.546632,HQQHHQQ#8\5AlAAlA4Y86gUUggUUg�?kIRr<<rRHj@ .G5 [�L� " '6654&&'.546633&"#" �A.1:g@FyK� N*Ue-P4:? �!,
4\JSj4FVW3A% +"M ��M � !!!!�y��
����C�;Q�X D�M
� '6654&''%&''%&&'7 �P
?zD"E�K"*uJ3t�T�
0\. ? :#Ez?8 >&E}Gx+=F��2`�� �+�� �� �T}�� `�� � }�� �h� 73Q#��\� � W � 3773�#6\�� �� /� ��c� ')9$O�
#
�� �4� J �� �7���E ����� "&53327Z3,S
;61P�H> �� �<|�# �� �<|�# �� �>p�! �� �.M� �� /� �� �/�m �� �/�j �� �/�l �� �/�i �� �2�'n �� �2�'k �� A�� �� �3�M �� �4� J �� �L�&N ��x� '6654&'7
!*)BI 3�& /.,#- ��w� .5467S 3 IA )*!�-#,./ ��_� '7(2L �� �� ��c�� ���� '6654'7'7� B6@9�2K �& 5/0.,5 � � ���� &&5467'7"9A5 Cl2K � 5,.0/5 &� � ���� '6654'7'7� B6@9�7 L�& 5/0.,5 � ���� &&54677"9A5 C9 L2� 5,.0/5 � � ���� # "&&#"'66323267'6654&'7] * ! * m %;?:P ## ##�!
' ! ����
# &&54677"&&#"'66323267G$:@:% * ! * �! '
x ## ## �� 8� c #�
3!!32#'32654&##c���~Fk>l�tTSUTr�F�$OBg`F9C?5 �� c #� �� � �` �DB� !#'53>7>7!3#5!�"� �
9I I�x%Tk 8ZZ���2-cWAimF��2Ѽ��� r � W� / 3'&&#"'66323337>32&&#"####�+
,%/5L5/#*
+�Zn<L<n_�5P34���43P5���5��5�� >�� � + "&'7326654&##532654&#"'6632-Hu2/,Y:,G+^VJ6XNK8.P -$k=^u3/9K@l .39+& :)?<@:745" 8#-YO4O SD?X/ N
� 33373#467#NP ?�\P ?����4k1���pW3h2��d�� N
E&� f D� 3337>32&&#"##fSkX-/ Q�\�k���25N $$���5�� �� � "&'732667667!##:
":T�+6 MKNj�n�pJZ�Zdk( �� H � �� O � �� 0��(� �� O �m �� f � �� A��*� �� * .� /��,� "&'7326773373� '
�Yz2/pU�L K #��܁�$��=F ��>� 5&&5467534&'66p||pLq{{q�MOOM�MOOM _�qo}]]}oq�_XR`l]PP]��`�� 6 "� O�DM� 33!33#5OSSG D���I��2Ѽ A � !#"&&55332673�<(Km:RWP':T&)_P��S@%�p ( 0� 333333(L�L�L���I��I�p &�DP� 3333333#5&J�J�J@ B���I��I��2Ѽ =�
3#5!32#'32654&##ɶ
7Ci=zh>3MPTP,JF��'QAiaD>F<< 7 !�
3332#'32654&##37L$byvd% KMMM RL���WbiaD>F>:����p b !� 3332#'32654&##bTyHm=�nzoSWVVm���&QBiaD>F>: .��� "&'73267!5!&&#"'6632Ch)."O3Vh�� dV+K . h=S|EG} 2-4"(||Gho! 6 1N�oo�M ,��4� %2654&#""&'##336632|/33/-55-O_JTTK^LTdd=~��ww��~I������핊���� �� !##&&54663335#"�y�`�AT;hC��nnLRR�� [ODQ#�pY�4A@? �� r c ] �� r 0 a ��@� # "&'7326654&#"##5!#6632�$
, ND2*T���7>a80K C;4JC
��JFF�+\JNY%�� � c&� � B��*� "&&546632&&#"!!3267`S�IK�T<^ .D)Xl ��l]/J .'c M�oo�N1 6 "ohG||("4-2�� C��� �� _ ��
�� _ �0 � �� Q���� ����>� ) "&'732667667332###%32654&###
�Wml[_\
!0 A?@C
MFIl�j��WbiaJY�h\b%P>F>: ' =� 333332###732654&##'L�L#WliYp�� ?@AA�����Wbia5��D=G@8 7� 5!#6632#54&#"#��7bmRED2*SJFF�Zf��C8
��J�� f Dc&� � �� N
c&� � �� /��,E&� K�D
� 33!3##5KTT�E���I�p�� '� 3#53533#32#'32654&##���S��BHm=~nH>SQSX7�D}}D�"L?i]B;E>5 0��(� "&&546632"!&&267!,Jr@@rJKq@@qKFYNYFJ[��[ P�mm�NN�mm�Pbqjjq��zz� & W� 33366776632&&#"��Yj@:4
����:e::e:�IB M%%�� � < 3!73!�9F ����� < �
3#57!!3#�PP��Ҩ�,:&F�>�� �Dg� 4 3'&&#"'66323337>32&&#"3#5####�+
,%/5L5/#*
+o- ;'n<L<n_�5P34���43P5���2Ѽ5��5�� >�D � - 5&'7326654&##532654&#"'6632uU/,Y:,G+^VJ6XNK8.P -$k=^u3/9K3X8�� V9+& :)?<@:745" 8#-YO4O SD8R2� f�DL� 3337>32&&#"3#5##fSkX-/ Q�5 B�k���25N $$���2Ѽ5�� X� 3#5!37>32&#"##ͺBK'*
I�Q�@JF��44M #%���5�� O�DM� 33!33#5#!OTSG @Q�������2Ѽ5�� A�D*� 5.546632&&#"32679Hp@L�U;\ /B)?]44]?-H / N2��
U�cj�R0 5!AvRRyB%/��� & 2� & 2� !5#57333667733#�Y&�Xc$&_V���:v�%L((L&��>� 6�D4� 333667733#5#'&&'#6ķ\\
ZX��<A%c
bS=�, ,�����2Ѽ�3 3� A�DF� !#"&&553326733#5�;(Jl9RVO&8TG F&)_P��S@%��2Ѽ [ � 336632#54&#"[S9&Kk9RTP%7���)^O��S>���� _ ��
�� WE&� �� 8E&� ���� O� M �� r E&� �� ;��&� � �� N
&� �� 0��(0&� �� 0��(� �� /��,&� �� /��,l&� �� Q��� K��� . 32654&#""&54>7>76632�NMAGGB%P%�p|,RrG #6!;W;!!Z/<[39dd{gRKY&2 �ӥ�y�T) K
.WI()6fGMr> h � 332#32654&##32654##h�Ti.'+?qY��B97>��B?���9B(4
65HC %"" ��&(L � � 3!!�y���C�] *�T-� 73#'53>77!3#5!���� FG G���HZ`���4#SN�]4����� D��� R� , 3'&&#""'6632353376632&"#"#'##5#�" '<*7P7*;' "�Vi?P?i])M*<p��p<*M)]������ >��� & "&'732654&##53254#"'6632;k4$*X-LRMITH��4L&"*c@\vW2=� *6"-*)&@KJ 7 "@CK!
75FL d �� 3336673#5467#dP%
�LP
%���']/;��'^/<�� d ��&"
n 0� 3337>32&#"#'#nR�;&*
5�[����l*-M)a��� ���� "&'73267667!##J
GS� L16O�O��C�C� @ � # 33366773#54667##'&&'# @d\
ZdN
X>\ �� : : ��;> =��= >;� ] �� 33353#5#]R�RR������� <�� � * ] �� 3!##]�R����] �� ]�3 � + �� P��� B � !#5!#���CC�]�� 1�/'� 4 �38� # . : 57#"&546632'536632#"&'27&#"32654&#"'CS*E''P.DJ*E()� #%.+�),#/!!!͛J
�yOs>J��L�qRv>J�#0!gTVcgZPc"�� �� @ � 3 ^�T8� 33333#5^R�RGG�]��]4�� X �� !5#"&553326753� *&dmREK+R�Sazz=4� : � 333333:RzLzR�]��]�� :�TR� 3333333#5:RvLvR<A�]��]��]4�� # '� 3#5332#'3254&##ɦ�JWkkWJBy;>B�C�HPQJBY.* F �
3332#'3254&##3FKDQbbQD<r8:<6K�HPQJBY.*�� } �
3332#'3254&##}SqYllYqh}=@h�HPQJBY.* =��� "&'73267#53&&#"'6632 9d&# N.Sg�� cH0F ' \BGuGEw &"3 SS@KJ 2 (7rWUq8 ,��4� %2654&#""&'##336632~,66,.880HcQRRR aFOee8\^_]]_^\Dqp���ki~��~ 7 �� !5##7&&546633'35#"���]�3H0T4�⏏7==��� G?6?���$,++ �� D�� ) �� D���- �'� * "&'7326654&#"##57533#36632N #8!CD%@*RIIR��$S4^d 5L�>5�|�q,,��49VV>Br(6��q�X% �� � & �1 P��� "&&546632&&#"!!3267ZLyEJ|I<W ' E*Jg ��gT.M "Q 8qUVr8& 4 KJ@RT!4H �� G��� . �� Z �� $ �� Z ��N �� 7�'�� % ����,� ' "&'73267667332###%32654&##%
�QddQ_`
B=77= L07M�R�HPQJ�C�GLJN+..* : (� 3335332##5#732654&##:P�PS``Sk��;77;��ųHPQJ��B+./)�� �I �� n 0 &$ � �� d � &" � �� 1�/'�&-
g�T�� 3333##'gR�R� F�]���� ) !n 3#53533#32#'3254&##�R��LVkkVLCz<>C�CttC�HPQJBY.* �� <�� �� F 0� 33366776632&#"��Ta
051 p��#I##H$�HDJ$%�� � �� 3!73#�B���] H �
35#575!!3#�JJy�٬��8�C�>� �T_� 1 3'&&#""'6632353376632&"#"3#5#'##5#�" '<*7P7*;' "b/:!i?P?i])M*<p��p<*M)]�4������ >�T� ) '&&'732654&##53254#"'6632�1[,$*X-LRMITH��4L&"*c@\vW2=eT �� $6"-*)&@KJ 7 "@CK!
75=K� n�T=� 3337>32&#"3#5#'#nR�;&*
5�<?!����l*-M)a�4���� ! F� 3#53376632&#"#'#ʩ�_*:%
'�O�_�C�lA'M+e��� ]�T8� 333533#5#5#]R�RGGJ����]4���� P�T� '.546632&&#"3267/@c9J|I;X ) A&8U0/T8-K %FX �� @jHRr<* 5 /U87T/$5> � 3�3%� 5336673�Tn
nP�����%J""J%
�� 3�3%� 5#5733366733#�N9�Tn
nP�����8���%J""J%
�X>� @�T0� 37'33667733#5#'&&'#@��[M
IW��LG$U! P��k+,i�4��p.+p X�T+� !5#"&5533267533#5� (&blRDI)RGG�R^~~:3�]4�� �� ] � # �� R�&
�� J��� ' �� Q���&
�� ��U� �� D���&
�� E���� �� d ��&" �� <�� �&( �� <�� �� �� 1�/'�&- �� 1�/'�&- �� <���� �� <����&e
U��� & 3 "&&5467.54667>7 '32654&''7`;iW"?(9iH(- 6 FT%(@$-E(6c�&>#BJ=.NZ 4aB\n-1 2/ K
# BT;Dj;�-C&]I<N"b �� c 4�? �� c 4�E �� c 4�R ��^� ) 5 = A "&''26533.55432"#&&'# "&54632'254#"53#Wu DXu �.DD..BB.224"� A �n Q ?dZ/�cA��� P ?dY0�b OSSMMSSO7kjjk�66 *��A� 3 ? 6654&#""&&54667&&5466326673&''3267&&'�*=!"'.:X2#8 $A+=B*@# S- )L4$<5AH$W�J4 ;/V" +: A+ +6��/R5+C7)O#,F)H:*C82_'(`8@w4.D7")�7B *e5 = G��� # "&54632'2654&#"7"&54632,j{{jkzzkCUUCCUUC%%%% ��������B���}}����$ ## $ a ~ 353#566733a��8M =�D�5��D E
� 35>54&#"'66326633Il�MDG-M /+dC`pJ�W = �1`�t57F- /,5gU<{�OG 9��� * "&'732654춮&#"'6632 Rq#* Z=AXj~q`G;-P ,(g=<_8M;+G,?h 7#6 .@59F?E2/6$ 4#-&H4:J +B,8R, ' !~ 735667#5!533#��"A��?Xcc��=/�4�7��tB� 8��
~ ! "&'7326654&#"'!!6632 Ul%) T@-J+VG(8",i�� 5%=c;Cl 6!6 -$B,BJ 3G� +XEEa2 M��� ) "32654&"&&54>32&&#"6632@&W& UF9NFAEo@,K`4;X .B$3W7'^0Yn;aH(.\aM?AF��D�f`�U'' 34wg&-cb=\4 F ~ 3>7!5!�1M7���?S0[��CG3H���^ D��� * 7 "&&546675&&546632 654&#"2654&&'.Hi9(?"(93Y9^h9(#9!6fPB?5C-MGM5[8.?X -P2,@.J21J)`J-O +<./N-h:F/B8/&2#��?1-3"B05E C�� � ) 3267&&#""&'732667#"&546632�EC&V'
SG9Np:X .B%3V7']1Xn;a8FnA,K`�AF(-]aM��' 4 4xf&,cb=\4D�g`�U' G��� "&54632"6654&267,j{{jkzzkC(�UC 8� U ��������W;�� E)�~�� [ F)�� a ~
353'733a�t*�@�D�V0���D G��J # "&54632'2654&#"7"&54632,j{{jkzzkCUUCCUUC%%%% ��������Bsywnnwys�$ ## $ a > 353#566733a��8M =�D�5�D E
J 356654&#"'66326633I��DG-M /+dC`p�� > �1n�@:H- /,5iXL�\G 9��J * "&'732654춮&#"'6632 Rq#* Z=AXj~q`G;-P ,(g=<_8M;+G,?hV7#6 -A7;E@E4/8$ 4#-'I4:L +C-:S- '��!> 735667#5!533#��!@��?Xcc��=1�.�7��cC� 8��
> ! "&'7326654&#"'!!6632 Ul%) T@-J+VG(8",i�� 5%=c;ClV6"5 ,$C.DJ 7G�
*YGFb4�� N���s F��> >7!5!�1M7���?S0J\���DG3I���` �� D���u C�� J ) 3267&&#""&'732667#"&546632�EC&V'UH9Np:X .B%2V7']1Xn;a8FnA,K`zCJ(.aeN��' 33xg%-gd>^4D�gc�W( G��J "&54632"654&27,j{{jkzzk 2�UC;'�U ����������7Syp�(+K4S|s a >
353'733a�n*�@�D�R/��D G��� # "&54632'2654&#"7"&54632,j{{jkzzkCUUCCUUC%%%% ��������B���������# "" # a � 353#566733a��8M =�D�4��D E
� 35>54&#"'66326633Im�MDG-M /+dC`pJ�W > �1`�v5>N, .,5p\<{�PG 9��� * "&'732654춮&#"'6632 Rq#* Z=AXj~q`G;-P ,(g=<_8M;+G,?h 7#6 .B9;G?H418$ 4#,'J5<M -D-:T- ' !� 735667#5!533#��#A��?Xcc�� >0�%�7��fB� 8��
� ! "&'7326654&#"'!!6632 Ul%) T@-J+VG(8",i�� 5%=c;Cl 6!9 0%D.DL <F� +ZFGc4 M��� ) "32654&"&&54>32&&#"6632@&W'
UF9NFAEo@,K`4;X .B$3W7&_0Yn;aQ(.aePADG��F�ic�V(& 36|j',ed>_5 F � 3>7!5!�1M8���@S0^���EF2J���a D��� * 7 "&&546675&&546632 654&#"2654&&'.Hi9(?"(93Y9^h8)#9!6fPB?5C-MGM5[8/>X /R4-B/M42K*aL/S +>/1P/q<I2C:0'5%��A4.5#D27H C�� � ) 3267&&#""&'732667#"&546632�EC&V' TG9Np:X .B%3V7']1Xn;a8FnA,K`�CH(-bfQ��' 4 6|i%-ed?_4F�jb�W( G��� "&54632"654&267,j{{jkzzkD(�UC!8�U ��������j?��<X���� "i<W�� a �
353'733a�n*�@�D�R/���D ��} � "&54632,"//""// /%&//&%/ �+� � '667#"&54632�>>
.0 ,.]�4 P;&%%'E;Xy �� ��}'� f � �� �+�'� f � ��8 � # "&546323"&546323"&54632f )) ((� )) ))� )) )) *!"))"!**!"))"!**!"))"!* ��u� %'3"&54632
P
++ ++�X^^���*$#))#$* �Hu� 73"&54632
8
( ++ ++�^X��^)$#**#$) m���� % 7&>54&#"'6632"&54632�13$77&A1"\:Sg$52 ++ ++�+@3/1 )8 -#.UG);10:'�*$#))#$* y�<�� % "&54>'33267"&546323Sg$52 I13$77&A1"\3 ++ ++�UG);10:'+@3/1 )7 -#. )$#**#$) �`c� ''3n`�nn� �� �`��&�� �s �^|� "&5467632+'3MC.6 '*^@8Kx"0O4( "+ �^�� '667#"&54632� /6 (* (2L^0P4( #+@9Kv �� ^^��&�� �s �� f^��&�� �s �� � � {� ���� f� � {'����� � s�� �^� &&54632#"'cCL2( *' 7.^#vK9@+# (4P � 4�� %'57^��'4�P�#�� � 4�� 7'7'7�''�4"��#�P�� R 4��&�� �s �� ` 4�&�� �s �� U+i� �� U+i� �� U+i� P � 75!P��HH �X 55!X�HH P � 75!P��HH�� �X � �� �}�� � s�� %"&&546632,'D**D'(C**Cs%B,,B%%B,,B% � g�� %"&&546632'2654&#",/I))I//I))I//;;/.<<g*H--H**H--H*0>11>>11> � ��� 7!� �
�� � u�� 7!'35#�$���u"��-� � ��� 753����%�� u u�� 753%3'u�����muF��+� � e�� 73�%��eD�� � O�� 7377'�G��)��Oo��Kml � c�� %5!+�B�c%�� u N�� %5!'7#+�n�m�NF��T� � e�� %%5%3���%e���� u O�� %%5%3'5���G+�O����K�l � s�� 7!'2654&#"�(�;MM;:NNs&�� M:;LL;:M �X4 55!X�pp <�t �� 5!<�GG <� �� 5!5!<� �>>z== >Aw 5!>�A66 �f��
"&'73267,�e_�mm�_d��B>):55:)>B �P��
&&5467�hyyh-d``d�Q䑑�Q*U�~~�U z�P��
'6654&'7�-e__e-hyy�*U�~~�U*Q䑑� �h�� !#3��Ә\/�/ b�hw� 53#5!b���/�/�� x�h�� / "&54654&>54&54633#"33�^[ ?;;? [^=436'44'634�8M7X2#4$/^4M8/(!+[/13 313T. )/ c�h�� / 5326654&54675&&54654&&##532"#c336&44&633=^Z ?;;? Z^�/) .T313 31/[+!(/8M4^/$4#2X7M8 c�`�� 3cHJ���f�� �Q� 3J�� c�`�� 3���JH�f�� �Q� 33JJJ���H0��H T o, 7'7'7737'�*l�� 0 ��l*xo �F.7��7.F� � ���� 5'37' ��F��P;G��G�� ���� 75'75'37'7' ����F����P�G��G��G��G� [���� 3 C "&'732654.5467&&54632&&#" 6654.' 7\ 2=*)-)@H@)3(LK2Q (9#*&)@I@)2)Z�)@H #(@H %@&!- ) % )>.,A(4N"5%% *>.0<';N�!+ &"", ) H����
%"&&5466333>Fp@>jC+6Q�.`KO])�R��� �� ����&ȕ �k �� ]����'��z �y ��;� % ? K 7&>54&#"'6632"&546327&>54&#"'6632"&54632f"&$%') D*>L '& ++ ++�"&$%') D*>L '& ++ ++�*C746!!.1!"K9*B76>'�*$#))#$*�*C746!!.1!"K9*B76>'�*$#))#$* W��;� % + 7 %&>54&#"'6632"&54632%'3"&54632~"&$%') D*>L '& ++ ++��
P
++ ++�*C746!!.1!"K9*B76>'�*$#))#$*�X^^���*$#))#$* ��� % + 7 7&>54&#"'6632"&546327'3"&54632f"&$%') D*>L '& ++ ++�
P
++ ++�*C746!!.1!"K9*B76>'�*$#))#$*�X^^���*$#))#$* ^���� ) 7''3>54&#"'6632"&54632� F0"?=)F 0#f:;W1%55 )) ))��LLk,6'-< ,&.)F./B0,4$�)""))"") t�<�� ) %#773267#"&&54>'72#"&546Z F0"?=)F 0#e;:X1%55 )) **��LLk-6'-< ,&.)G-/B0,4$�)""))"") � �� 3!#���/�x b w� !#5!5��/�I ��~ 33�B�V�[/ b��w~ 533b�BV/��, ��h�� !#3%3#�<����++�\/�//� b�h�� 53#5!'3#b��<_++�/�/��/� ��� !#���/�� bw� #5!5�r/�_ �h� 33�BӘ���/ b�hw 533b�B�/�R ��:� ; "&&546632'26654&&#"7"&&546632&&#"3267,L{GG{LMzGGzMCe88eCCe88eK-I,.L+#2" .86,& 5 R�ff�PP�ff�R*I�WX�HH�XW�I^/Y>:U.'K;BM* ��:� * 3 "&&546632'26654&&#"'32##532654&##,L{GG{LMzGGzMCe88eCCe88e(r9OP81''*+&' R�ff�PP�ff�R*I�WX�HH�XW�Ijk8=BAs�&)$ p?�� - 6 "&&546632'26654&&#"'532#'#532654&##,4U33U44U33U4*C''C**C((C L /..#) ?2Y:;X22X;:Y2%(I//I))I//I(=� $ SFFf ��nD� #53#333773#57##'#[`�`�G-,G7G*Hn 66� 6rPPr�ʉi��i� bD� & : "&'73254&''&&54632&&#"733773#57##'#}!6!%1.%9/ 2 #. :tG-,G7G*Hb%' '#'1'
'##8 6rPPr�ʉi��i� 1�p"{ , 5 "&&546632#'##"&546754&&#"3267275UO�PN�REZ,2G'5L� A5<g@=iA-C 'R88gY+�Z����V?kD��: *F=MN0P0J�ok�O- "@~7.#( 1��"� , 5 "&&546632#'##"&546754&&#"3267'275UO�PO�SDY+2G'5L� @3<iA=iA-C 'R88gY+N�os�M7]9��: *F=LO
&?'A�bZ~C- �@~6/#' W � 37#7#537#53733733#3##7#��hPWU\5�5PWU\6���g�9�:����:�9��� h<�� '7'7737'�*\�� 0 ��\*g< �9.,��*.9� � � �� 75!�L�HH�� � �� � �� � �� � U��� 5 ? 7&"#"'7&&'77.54663227&&' #""'74&'2326�9)
2<?8 )I'9 $)K03X9 8!5,%!+O45_? �?-" ;>� &�-��� $9 �(:+/E%��
"0�)?00H)�$,�1�� �� � <�� ���� <�� ��� � <�� �� � <�� ��� <�� �� <�� �� <�� ��� <�� �� <�� �� <�� �<�^ <�� �<l^ <�� ��]� <�� �g� < ��C� � "&54632'2654&#",HWWHHWWH+66++66�ldbllbdl3NONMMNON ��O� � 535#566733�{i)54r�6�)��6 ��O� � '>54&#"'66323�C[/.' 1&K+>N+J0��%9P> &, ##)A>%CH-6 ��C� � & "&'732654#52654&#"'6632)3Q*9!$4�;9+%0&D+7P'(+3(C�*"! $!F() "" "81#.2&$4 ��O� � 53533##5��/��::::I! �tt.hh ��C� � "&'732654&#"'73#632+7N*(G'36*% �
(9QU�*"!:1%(.�8`C@<J ��C� � % %"32654&"&546632&&#"6324/6)#.,$JX0R2&1%0D,@@D%>9:,$#,�i[Ja/,
HK)E8%<# ��O� � >7#5!� 6)�%18�Dmf87$>nrD ��C� � % 2 "&54675&&54632'6654&#"2654&&'+GM-'!#H<>H( *(O- )#"&6). 3 " ,�?,&7' .98/"-0%.?�# �' )) ��C� � % 73267&&#""&'73267#"&546632�+*.6)#.>%3&0C,@?E%?(JX0Q^#-:;-��
-
GK(E7&<#i\Ia/ � �" .5467X&02:-5&'4� ,RZ9T|A>wBAw? � l" '6654&'7.5&&5.92/� ?wABw>A|T9ZR ��D]�� "&54632, � ��g�� '66'#"&54632 # 5��' &&%-E ����= "&54632'2654&#",=NN==NN= .. .. XNNUUNNX2::<66<:: � a1 !5#56673"R!)2�* �� � �= 356654&#"'66323�NS &';$6>G2�$;N! !#52(L-5 ����= $ "&'732654#52654&#"'6632+"D 1#`)( ( >"/;8 'F '3& &,(7' ,1 � �= 7573533##5�q.ad9229J ��aa*JJ ����1 "&'732654&#"'73#632-)= - %$ ��
2>G ' �6F 4//; ����=
# %"32654&"&54632&&#"66327(#, :OVD ,
+3-34A�#&" �RFV[)
;95*+= � �1 3>7#53�* ��*-4RM)5$.SW5 ����= % 0 "&54675&&54632'6654&#"2654&',8E( D.2A!%H! , )5"/' 5# % %//% ! %!%3� �
% ����= $ 73267&&#""&'73267#"&54632� #, ( - )3-33A2;NV� '# �(
995*,<QGU\ ���
&&5467U1881.-((-L1oKKp1!-c;:d- ��l�
'6654&'7.-((-.277L -d:;c-!1pKKo ���] Z "&54632, �g Z '66'#"&54632 # 5u' &&&-E �� ��]
�� � aQ �� � �] �� ��]
�� � �] �� ��Q �� ��] �� � �Q �� ��] �� ��] �� � ��� �� � �l� �� �]z �� � �gz �� ����) �� ����J �� ����7 ���� # "&5467&&#"'6632#'#'2675
-=kp!) 7L(A?5</UH$�1+59 ,+G?�&1S% ���b "&'##36632'2654&#"G22@5 AE)B3(4'.'.)� ׁ8YK7M)5>:3<(� ���� "&546632&&#"3267ZF_0M-#2 !/=;/)2�YO6L') @54@ )) ���b "&546632'53#'#'275&&#"?L)B' +@56,'&'5.�XP5K)7|�)$5(�>57= ���� "3&&"&&546632#32678$=�2 0P//K*HM�F./6�+-/)��(K54L)SD
24
(" ���i #5754632&#"3#OOAE/-!&)%���0;G/
*# 2�� � ��� * 6 F %"&5475&&5475&&546323##"'3322654&#"2654&##"&'*FO5
'M5
�R I5 ?G@>cV (( (($5@%#; 4�,+( "
* 6>0
5: "$)/B!%! (( !%�%
���b 36632#54&#"�@8$85@ $(�ׁE!A>��)(� ���g #53"&54632<��% �2��� � �|g 7"&'73265#53"&54632�.!!/ ��=1 �
/+(2��'?$
���b 3373#'�@�H}�GkF��ʠ���CT ���b "&5#53327}53Q� #�<883��
1 F�� 3366326632#54&#"#54&#"F21 E5!5/>#!,>#",�A- <$F8��&,/��&,/� ���� 336632#54&#"�57%85@ $(�A0!A>��)(� ���� "&&546632'2654&#",*H,,H*+G,,G++11++11�(K56L''L65K(4@45@@54@ ��� 336632#"&'72654&#"�46 AD)B&.N(4'.*)�$YK7M)7j�>:3<� ��� 57#"&546632373'275&&#"v4 ?L)B' -4�,'&'5.o8XP5K) �:�(�>57= ���� 336632&&#"�6B'#
=�AK',
6(2� ���� ' "&'732654&'.54632&&#" 4+L 7%(&8 7%G@$? -%"4 9%I�) #(5(
$ (9 ���0 "&55#57733#3267qH8MP5��#,
1�J=�0dd2�)+/ ���� "&553326753#'#
74@ #)@49�A=��('�2! ����
3366773zB>>>w�A�00��� 4��� 337733773#''#�Y@,082+;WK*,�A�[[��[[����[[� ���� 7'3366773#'&&'#�ofD+&DhoE/
+���B
B��E
E ��� "&'7326773366773�
&
�@E <>�<2$@�//���2A ���� 57#5!3�ս���!�2!�2 ����
" '7"3&&"&&546632#3267Ip-f4$=�2 0P//K*HM�F./6�n)x{+-/)��(K54L)SD
24
(" ����
" '7"3&&"&&546632#3267'"f-`$=�2 0P//K*HM�F./6� x)�+-/)��(K54L)SD
24
(" � ��� 2 "3&&"&5467#"&&546632#326732678$=�2% *
0P//K*HM�F./.%
�+-/)�R !*(K54L)SD
24
( /
���� "&54673&&#"'6632'267#*IS�?-/>$G_,G,$7�7�XD 11
(YP4L*2./1, ���g 4632&&#"6632#54&#"�;?#
" 8$85@ $(�Z;G0*#Q!A>ļ)(� � ��� $ %"&54673366773'2654'#-'*rA;;?q)'
�+$0" �&&���"1$+*
"/*
���g 5&&546632&&#"2H+G)/D"/ +5<=�� M:*: $(*%)B � ���� "&546632373#'#'275&&#"?L)B' .456.%(%6/�XP5K) ��$5(�>57= � ��� * %"&'732677#"&546632373'275&&#" A4--3 ?L*C% -5QB,'(&60�,+$8WJ3I( ��=C�*�<23; ���g 535#533"&54632��r�|��2�2��2� �� ��]�' < �zG 53ޜ// ��E 5!�** =E 5!=�** : S A ) 7'7&5467'76327'#"'72654&#"f,T$S,W0?>1W,T$T,X/?>1o1EE11EES-U1C#;V-Z%%Z-V1D";U-Y&&J<<JJ<<J U�� � - 7732654.546753&&#" #5&&U'&\8;>.HQH.YI<7J ,"?22<.HRH.aO<7eq9)1& ) ';+?Q��+ 0 -&% )=.@W��, M � ( 356654&'#57&&54632&&#"3#!N>>uc s_>U 0;*AF ��$$H2 `8
4 > Uc+ / A4 < 8 4G G 5 #~ !5#535#5333667733#3#�����U\!"\R������0A/@�!C##C!���/A0� :��6� 1 "&'#57&45447#576632&&#"!!!#3267vb�@;;@�j3X 1<&I[&���XE+A 1%] �u,,v�-!/!bV1 1Ua%",+2 q���� " 5&&5466753&&'667:Yp5\83,@(. 4$ H'�@87A!h
{jEe<jg"4��4"gWCX
O
X 1��� & "&'732677#57376632&&#"3#�* 4-
hF)
PT1
!*��&Ga >PL�;8dh >%;"??�=\4 `��"� / 5 ""&7&&5467722327&'667'7&'m
< >�=Ip_
0 0
+!1: 21 N2 0
S<67;H� �R{%�l��k\iq$/�
",%0d[
n��H�� N � 6 35665445#573&&'#57&&54632&&#"3#3#!N>>|W ^Ms_>U 0;*AF� ��$$H2 `8,!.!Uc+ / A4 1!14G G . (~ # ' + 3'5#575#57533533#3##'#73'#'3'#3'#� ;@5KKKKT^sAIIIIT]t� :�bL�Ja3�����+D+����0D0���J�0DDD * G~ 3#575323###3&Ň#�]]�<a=LL
}YF�PD;;���3� I<8XT�El;1��s :~ ! ' 3'#573373333###'377#377#* �$LE"L ;b< G ?F p", 4 /
�
1 ����(4 ���� ��:��(��D�bb��bb m "� ) - %"&5466323'5#53533#'#'2675&&#"5!L[2P,'5��GNN:> 4- .C9vznb[7P,S"1CC,�S. ; �D2=F�11 * H~ ' - 2 3#575#575323#3###4&'#366'3&Ň#�]]]]�MrXNMWtMF�����G3;;k#�t(:(t5?.
.@?�� :
�; ��F T��� # 5.546753&&#"32675#537Cf:|g<.O1<&W_]S :t�CXndR�`��ec, .!�y{��E��> d =��� : "&5467#573667#5736654&#"'66323#3!3267CZo
PE.-�F�!8/)6 ,!N=5Q.a�3��>;-I!&$d XO(+ ,. &4 !/%.(G/ -1 0)+6) 7%/ `��"� " 5.546753&&'667JEj;�j5/O 13 "71!P2�NGHMncR�a��a`+ / ��# ,&0d�p�
� l
~ 753267!573&&##5!#3##'lOS`��L� ]LO��EJH]J�]�C:<,.&D1 H1LX��� -��~ " '75'75377>54&'7�]s]sT�«�%NB(Ed� ++5H+*6ǞQ+[HQ+[�)='
To5 7 !~ !5'75'75#5!#77������ˊ����A+KHA+K�@@�@(MH@(L� 7 !~ !#57!#5!�R�����,0�&M11 * 1~ ! 35#575#5732##!!32654&##�tttt�Bh<=hA^��TMTTMT�,C,6$N>@P&C1�HABC7 E ~ 35#57!!3#3#�OO������|4�G�Fx8| <p 7'77'7M1�!�!�1 -� � �-�� <ph �� <ph �� ��=�'
�zM &h
� 0��?� ' 3 ? K "&54632'2654&#"'%"&54632'2654&#""&54632'2654&#"�4AA44AA4##$$��f4AA44AA4##$$*4AA44AA4##$$�F>=DD=>F*,.-**-.,� �:�0F>=DD=>F*,.-)*,.,*F>=DD=>F*,.-)*,., �� ?~' �sM &h � �� <~' �sM &h � �� U�'
�sM &h � �� ��<~' �sM &h
� �� ��<�' �sM &h
� �� ��<~' �sM &h � �� ��<�' �sM &h � �� ��<�'
�sM &h � �� ��<�'�sM &h � �� ��<~' �sM &h � �� ��<~'�sM &h � �� <~' �sM &h � �� ��<~' �sM &h � �� ��<�'
�sM &h � �� ��<~'�sM &h � �� ��<~'�sM &h � �� ��<~' �sM &h � S��?~ ! - 5#56673'%5#56673"&54632'2654&#"�R!)2m��fR!)2�4AA44AA4##$$��*
�{ �:�<�*
� F>=DD=>F*,.-)*,.,�� ��<�'
�zM &h
� U h, %5#53533# ��B��h�>��>� U+i 5!U�+>> f ~� 7'7'77'�,��,��,��,�~-��-��-��-� U `3 "&54632"&54632'5!, ��� �� �>> �� �y������ U ��&� k � ��� U T@'� � &� � �) x 0�h %%5%�u��-0�>�O�� k 0�h 75%5%5k-��u0O��O�> U
35!5%5%U��R�҇��>>��J�GI,,I U
35!%5775''5U��R҇���>>�GI,,IG�J U , %5#53533#5! ��B�����>��>�>> o �� 3#''#o�H�HB11B ��~���� U AS 77#537#5!733#3!pLg�[�
L=Lg�[�LA>�>>�> L � � ".#"'6632 3267� /)')5H& /)')5H""4G6""4F6 �� L � &� k � � U hi %5!5!����h�>�� U hi 7!!U���h>� ` h�: 7546632#54&#"`5\;;\5AL??Lh�Aa55aA��MTTM� U h, 73!UBlh�z> �� �\� ' 3 %"&'##"&&5463236632%27&&#"2654&#"�7O&)5#$=%U=2D O6-E(W��@(4 $+/R,15/#= !>�:=- )F+NY<)5@,M2TfSX1+-)(6=+0?17=2 ���� "&&54632'2654&#",!9#K2"9##9""**"!**� :&;F 9(&: ..#%..%#. �h� 3Q"� d� �� ����&�� �X ��W� ''3!"Q��d� �� T�E'�� L�� � * 73267&&#""&&5466326454&#"'6632�C-AY!F!IIh0S34bC)O KA 9& P.asCw�;Fmc*"Y��.W;Bf:&"}p4 #��p�_ ��b� # "'732654.546632&&#" � * <9
)
;�>RN7~�7Ag<>UM6~�~8Ah< �p� #46632&&#"TK<9 )�p�Ag<>UM ��bT� "'732653�
*K<�>RN��_Ah< >��G4 '736673/�G�t�<�_� -;�� ��m �� + -�a �� & 2�u 8� #33736677#8�^�X>�?� � !��p����9m7dd7m F �� 35!5!5!5!5!FL�����G�G�F�p�� O C R'��t O � � O F��%~
55!!!F�������wx5FF5G���G 4��$~ !#!4�U��x��
��S ��=� " . : "&546632&&#"3267'77'7"&54632'2654&#"�;P)B% .
$1.%%
6v1�!�!�1�=NN==NN= .. ..AVN4J'' @33? '��-� � �-��XNNUUNNX2::<66<:: t���� ' 6654&#""&''66746323267;C!)O<Z !+T>9Ih\5% +!C�;�F2*C��P[4 tePK^�NM<3( ��>� 1 ".54>32 !"32673!2554'&&#",9cK++Kc99cK+�b6T5_"&(r�
G&(H 4\zFFz\44\zF� <=3<HZ�
� ��9 5!!!��+���J� .�D� !��7 '3'
�. .���*��*�I ��F '7!5!'75*�I��*.�D�.�� !��7 737*��.�D�.��*���J�*�� ` ! � %7%��
?|��6!6��|?
�� Q �� 7''%'�06��|?
06 >�� V 7�� %%777���06 >7?
60���� g 7� 7'%j?
60��7|��6/��
? ��9 5!!!!!��+p]�hCC���p .g6>>6g !��7 7'3'#'##O. .g6>>6�*��*o���CC�h] ��F '7!5!75'!5!'75*o���CC�h]o*.g6>>6g.�� !��7 733737*��.g6>>6g.��*o\�iCC���o*�� �� %d� %'7!'57!'7d�-~�T~-��-~�~-��&��&��&��& U��0 #'7'73'7.�&��&��&��&9�.~�~-��-~�[~. <�v 0 5!'#'7'73'7<���&��&��&��&�@@Q�.~�~-��-~�[~. J i+ %"&&546632,Af;;fAAf;;fi;f@Ae;;eA@f; > ^6 %"&&546632'26654&&#",Ek>>kEEk>>kE4R//R44R//R^>kCCk>>kCCk>20T66T00T66T0 W u 7!W�u��V I g- 7!%!!I�o\��g�:1d I g- 77!%!!I;�3��X��g�1�q7(] ! K7b % ,�� K �� > iX 753>��i� > iX 753%!>��oF�i�,[ > m.H 73>�m��� > m.H 737%%>�,Y��m���M�� > UD %5!+���U�� > UD %5!'!+������U��h[ * mH %%5%3��m��% * mH %%5%3'��/��m��%MA� mqH 73Y��m��� �� mCH %%5%3@��Ym��% D d0 # 7!'26654&&#"7"&&546632D��Cf;;fCBg;;gB1N,,N12M,,Md�4;g@Af;;fA@g;1.P34O..O43P. 3 [%R / %"&&546632'26654&&#"7"&&546632,DqDDqDDqDDqD4Y88Y43Z88Z3%@''@%%@''@[=qNMq==qMNq=20Z@@Z00Z@@Z0:#A,+@$$@+,A# ��q� 7!%!!=M4����
v3��=+4 ��� 7!667%!&&'73667!=�6 6)4��Cp#V E+8%= jA�'
v3#= 2*��=+^�
M�@&:~?n�a ����b� &'73>7�;\8)D$r�N6O�u&��&>�Cw��M2I�� M��� ! "&5466323 '6654&'�(=(G."2
D. #A<0N'% 5!
0[9'E
)/T�i7J& ��Q� ! "&546632%#"&546632h(<&D,"z.L-(;%D,"��.L'% 5!<��7J%'% 5!k*�|7J& ��O� #.5463236632.Zr>T=1JK0>S>r a�yj6bd5CC5db6jy� O� 4 7"&546327&&5466326632#"&'# !5>7#�;JS:"2'C))C'2";RI<%G /F,�z,F0 F�UCFG -O%8 8%O- GFCU&1KV((((VK1& ��S� #53.��%% om�� O� # %#"&54>73 #"&'# !5>7F)7J@qUVp@I8)E /F,�z,F0 �4&BF-Q]{XX{]Q-FB&4KV((((VK 'Om + 7 E M U %"&&546632'26654&&#""&546323"&54632"&'73267'254#"3254#",U�KK�UU�KK�UGl==lGGl==l�fBQ"?,,@
"R�
�
'K�TU�KK�UT�K->oIIo>>oIIo> $ ## $$ ## $�E=
'$$'
=E� ;;Y ' 5 A M %"&&5466322654&#"32654&#"267'#"&''"&546323"&54632,P{DD{PQzDDz��:DQ
"@..@" Q
�
;F{NOzFFzON{F $$$$$$$$�C>
'&&'
>C�
�� �� %#.5463236632.HSRC)oVBWWBVo)CRSH /@23CaGbg;JJ;gbGaC32@ �� '�m $ 8 D P Y &&#"3262672654&#""&&54632#32654&#""&'663266726+<
<=cTQ:;zqpz;jEU~E��y�:E3U3#p" "Y]crWXrbt
.�
��28P6.@GQWKw�F)S��^cPJ
ED2M*:6|
k,(/78.(,L 8 ! �� \� # * 8 F %"&&547&5467&&54>7'267!'66327&&#"66327&&#",j�@[$>/ *0/�
/>$[@�j>K��KZ ! !� "@;_?6; 'O ;6?_;@_9::9�# #A77A# #A77 �� 'rm % ; I W %"&54632'"&5463226654&#""&'&5467663266327&&#"66327&&#",a`hYYh_bDm?�oo�?mDY�"?�mn�?"�� # #� # #�
m*6SMMS6*�9v[zhhz[v9-VS �&%b__b%&� SV%! !A77A! !A77 -��+X ! * '73546323%37'6654&#"354&#"U((.YPPY.((��,, 1##1 I�2332F$$�W``W�$��$�� )#00#) $�;CC; <�� � * 26654&&#"5#535.5466323#,1N--N11O--O��<^5>mEEm>5]=��+-P34N--N43P-���>e?c<Bi==iB<c?e>� �� e� ) 726654&&#""&&54663275%#7�1N..N11O--O1El??lE%A��;�:>lB-O43O--O34O-9=jBBi=�:��?[Bj= �� [} 8 %2654&#"'7&&'#53667'76675373#'#5&&',;MM;;MM�+X
ll
V+W+@*Y+X ll W+X%/@*�M==MM==Mm,W+>)X,X
tt
W,V$0>.%Y,Z tt `���� 3'377''#��L��(@AA@@AA
SR����E������� 1 '�
33%!''#1�H�PjaRRah3���<�}}����h�� �� �^|�� �� �^��� ��=
526548�:<<:[]]22,-21ODDO �v=
&546"3v[]][:<<:ODDO12-,2 ���; 5&&546632&&#"2H+G)/D"/ +5<=�[!L:+: $(*%)B v � �� 373'3�]
]g]�]��W�� �W�� '3']�]W�� � ��� %"&'57 3267I 3i�
�+5+?<36 + �� �8l � �� �8� � �� �8�� �� �>�� ��_� 3f�?�� �� �Y�� �� �8� � �� �8l � ��_ B 3�8�@�� �� A�� �� �L�� �� �Y�� �� �;�� �� �9�� �� �8�� �� �Ln�
�� � z 2 �� � � 4 5��#� " . 9 E Q \ g s � "&54632'"&546323"&54632%"&54632!"&54632%"&54632!"&54632%"&54632!"&54632%"&54632"&54632'"&54632+z�
��
`�P
��d
M���
{ &R$mn&%R �8l '7A�:�8�8� ��mc '7I�/��s7� �.M '7CU'.�� �8� '7+�:8)�8 ���c '7$�/�*�7 /� '7B9/U/
� �8�� '73'#�#rRr#v8 �� q ���F '73'#�$iVi$n�qq] A�� ".#"'6632 3267t& 7/4& 7/A",#;M"-":M {��I ".#"'6632 327w ) 86- ) (86� " 9B B:A �Y�� 5!�
Y99 ��� 5!� �99 �� �Y�� �� ��� �;�� "&&'7 32667,6B!3, !+3"B;-E%0 0%E- �<�� "&&'73267,8D D&12&D C<*E&+>>+&E* ���J
"&'73267,FF2/++/2F�M4#11#4M ���E "&&'73267,7A H#**$H @�$;!#33#!;$ �Ln� "&54632, && &&L# ## # ��g; "&54632,""""� �L�� "&546323"&54632� � L !! !! ���0 "&546323"&54632� � � �<|� '6654'7 SDKD<(+61,++ ��{h '6654'7 S AIC�&'0)&+* �;�- "&&'7 32667'"&54632,6E#00""0 0#D7 ;-E%2 2%E-� ����
"&'73267'"&54632,HJ.5..6.KH �M4%33%4Mt �9�� "&54632'2654&#",4::44::4!!!!98()77)(8%"!!" ���p "&54632'2654&#",*77*)88) �2()22)(2$ �8�� '7'7�.W:4.W:8� �� ���l '7'7�+\96+]8�� �� �>�� '737r#vv#r>� qq � ���M '737i$nn$i�q\\q �$I0 3J$ Q� k8�� '7'7�c:Wic:W8� �� � j��l '7'7�j8]uj9\�� �� � �8�� '>32.#"�3!B66B"3+! ,8%E--E%/ / ���I
'6632&&#"�2FFFF2/++/�5LL5#11 �)a� "&54676632/ +/ )'$%?"$ �>p� &&5467L+EKDS >)+-06+ �)c� '665#"&54632 +)"%'$%?�� �<|� ���� 5#5353Sss5�H/H� �x�� 533#�5ss��H/H �=�� 5#53Oo�=^/� #��� '654&'7+T@
W�)L
&?B �j��
&546"3jEEEE&''&��3-.4$ ��-��� 53533�Y6Y�/jj/ ����� 5#53#Y�Y�j//j ����� 5#53533#YY6YY�H/HH/H ��j��� 53��// �� �)n��
��� ��0�� �� �� ��� �� � z��
'6654&'7�?.$#A4U�(&$"+, �?��
&&5467SA4VO?.%"?#",,) � z '6654&'73�?."+(6#&U�(`H +, � z '6654&'73�?."+(6#&U�(`H +, � � "&54667332678+;':%-$ 0�./ 2(;!
' � � "&5466733267:,;'=%," -�-. 3(<!
+ ��O�� 73 :���� �� ��� 53#5#��0�␐aa �� �� �� �� ���� ��� ���� ��� �!�� �� ��V��� �� o ��= %".#"'6632 3267�!1(&7+1!1(&7+�"+#
6J"+" 6J �x��
526548�&''&EEE��$ $4.-3 �� ��� 53353�0�0�``� ����� 53'35#��Ɩ��(T ���� '&632366324&#"#54&#"�43/''0240�NF FN<(*&&*( �5�� '7'77'� == >> == >5 99 :: 99 : �� A�� �� {��I �7��� "5533267XM@
�\/
1 �?�U�� 5!�ګ:: �fX�
'6632&&#"�e��d_�mm�X*>AA>*:55 �L�L "&546323"&54632''7��{#R1Lus" ���� "&546323"&54632''7��|%_5�lw$ �4� "&5463277"&54632�51DKsS�
� �L�L "&546323"&54632''7��m`1RLui"s ���� "&546323"&54632''7��zo5_�lm$w �3� "&54632'77"&54632�]@B)IS �� �L�& - "&546323"&54632'"&&#"'66323267��-#+$**&#+$**Lw'5'5 �L� "&546323"&54632'5!��� L�// ���� "&546323"&54632%5!���� ��.. �L�H "&546323"&54632''737���^ `` ^L�\ II \ ���� "&546323"&54632''737���c!dd!c�|`KK` �: '73'#'7� dDd g�#W1:"\\"H x" �� x '73'#'7�"]H]"]{ a#�ZZE ]' 5:� '73'#'7� dDd g�q0d:"\\"Hp$u Y��x '73'#'7�"]H]"]wZ#U�ZZEX%_ �:� '73'#'6654&'7� dDd gv %;?::"\\"H#)%#(# ���� '73'#'6654&'7�"]H]"]u !& x8�ZZE#*D&# �:�# '73'#7"&&#"'66323267� dDd gC *$+!# *#+!:"XX"EG'2&3 ���� '73'#7"&&#"'66323267�"]H]"]D *!-%( *"-$�WWBJ&5'5 �;�@ "&&'7 32667''7,6B!0.!"-0"B;'X4;-E%2 2%E-l |( ����
"&'73267''7,FF/1,,1/FC)_5�M4%33%4Mb t$ �;�@ "&&'7 32667''7,6B!0.!"-0"B1e4X;-E%2 2%E-lq(| ����
"&'73267''7,FF/1,,1/FIk5_�M4%33%4Mbm$t �;�P "&&'7 32667''6654&'7,6B!0.!"-0"BQ#)=D>;-E%2 2%E-o$2)((& ����
"&'73267''6654&'7,FF/1,,1/F]
!%;>9�M4%33%4M_#*$#&# �;�" % "&&'732677"&&#"'66323267,1= //././ = *$/#% *#/#; 2++2 �&2&2 ����
# "&'73267'"&&#"'66323267,FD......D *!-%( *"-$�@****@�'5&5 �:�$ '73'#7"&'73267� _D_ `>;&(**(&;:SS>I8!
!8 ���� '73'#7"&'73267�!\H\!]BB.++,*.C�WWEI9%""%9 �Y�K 5!''7�
� �&Y99h'c1 ���� 5!''7� � y'�99\&g0 �>�- "&54632'737, Ar zz r� � ss � ���� "&54632'737, Al yy l5 sm \\ m �/�
.54677�- G:I3+JCA& )*3'.�� �/�
.5467'7�- G:Is@K&A& )*3'8�� �2�'
# &&5467'66323267#"&&#"G$:@:% �#% *#/#% *$2" '
|&2&2 �/�
'6654'7'7�
I;F -�2*JA&'3*) &
� �/�
'6654'7'7�
I;F -�?J'A&'3*) &�� �2�' # "&&#"'66323267'6654&'7m *$/#% *#/#� %;?:�&2&2�!
' " ��S 5!'�NN �� �z '5!'�ޜ� �pS� 3N�px�� �pz� 3ޜ�px�� !7S 53!53!53��������NNNNNN ! �7z %53!53!53��������ޜ����� �SA 333NNNNN7
���p
���p
�� �zA 333ޜ����7
���p
���p
�� ES 53!53!53!53�p��p��p��pNNNNNNNN �Ez %53!53!53!53�p��p��p��pޜ������� ��S_ 53535353NNNNNNN~����������� ��z_ 53535353ޜ������~����������� �pS !#!��Nz�k� �pz %!#!��Nz��
�pS !#!�����k� �pz %!#!������
��pSS #!5!SN��z�p�N ��pSz #!5!SN��z�pn� ��pzS #!5!z�����p�N ��pzz #!5!z�����pn� � !3!��N,�k �� %!3!��N,�
�� �� 3!ޜ�kN � �� 73!ޜ�
��� ��S� !5!3S��,NN� �� �S� %!5!3S��,Nޜn ��z� 5!3'�N�� �� �z� '5!3'�ޜn�� �p� !#3!��NN,�kx�k �p� %!#3!��NN,��x�� �p� !##3!��N'��k��k �p� !#33!���'N,�k���k �p� !#3!�����kx�k �p� %!##3!��N'���n
�� �p� %!#33!���'N,��
n�� �p� %!#3!������x�� ��pS� #!5!3SN��,N�p�N� ��pS� #!5!3SN��,N�pn�n ��pz� #!5!3#SN���'�p�N�� ��pz� #!5!33z���,N'�p�N��k ��pz� #!5!3z�����p�N� ��pz� #!5!3#SN���'�pn�n�� ��pz� #!5!33z���,N'�pn�n�� ��pz� #!5!3z�����pn�n ��pS !#!5!��N����k�N ��pz #!5!!!SN��z,��pn�'N ��pz %!#!5!5!��N��,z���N' ��pz %!#!5!��N�����n� ��pS !#!5!�������k�N ��pz !#!5!!�������kn�' ��pz %!#!5!5!���������N' ��pz %!#!5!��������n� ��� !5!3!�Z,N,N��k �� �� !!5!3!���,N,'�n�k �� �� %!5!5!3!����,N,�'N��� �� �� %!5!3!�Z,N,ޜn�� ��� !5!3!�Z�N��k �� �� '5!3!!'���ޜn�kN' �� �� 75!5!3!����'N���� �� �� %!5!3!�Z�ޜn�� ��p� !#!5!3!��N��,N,�k�N��k ��p� !#!5!3!��N��,N,�kn�n�k ��p� %!#!5!3!��N��,N,���N��� ��p� %!#!5!3!��N��,N,��n�n�� ��p� !#!5!3!��N����k�N��k ��p� !#!5!3!�����,N,�k�N��k ��p� !#!5!3!�������k�N��k ��p�
%##!5!3!!z'N�������n�n�kN ��p�
%!##5!5!3!��N'�����n'N��� ��p�
#!5!33!!z���,N'���pn�n��'N ��p�
%!#!5!533!�����'N,���N'n�� ��p� %!#!5!3!��N�����n�n�� ��p� %!#!5!3!�����,N,��n�n�� ��p� !#!5!3!�������kn�n�k ��p� %!#!5!3!���������N��� ��p� %!#!5!3!��������n�n�� K
S 53!53w��>�NNNN K �
z %53!53w��>�ޜ��� �jS� 33NNN�,���,�� �jz� 33ޜ���,���,�� �� �� 5!5!'��Z�SNN�NN ��p�� 3#3SN�N�px��x�� �p� %!#!!!��Nz��,���1NN ��pS ##!#SNN��p��k�N�k ��p� !#!##!��N��N,S� 1�� ��pS� #!5!5!5!SN��,��z�pGNNN ��p�S ###5!SNN��p��k�N� ��p�� #!5!##5!�N��ȜN�,�p�N��GN �� %3!!!N,��,�1��NNN �� 3333�NNN��k��kN � �� 333!SN�8NzS���N�1� N �� �S� %!5!5!5!3S��,��,N�NNNG ���� !53333��8�NNNN��k� �� ��� !533!5!3���N��8zNSNG��N� �p� %!#3!!!��NN,��,���x��NN ��p� 3##33�Nz�NN�px����kx�k ��p� 333##!�NNN��N,�px������N���� ��pS� #!5!5!5!3SN��,��,N�pGNNNG ��p�� 3###533SN�N��N�px���N� ��p�� 3!533##5!SN����NN�,�px���NG��GN ��p� 5!!#!5!'���N���SNN���GN ��pS ###5!#SNN���p��k�NN�k ��p� 5!##!##5!'��N,��N�,SNN�����kGN �� �� !5!3!5!�Z,N,�Z�SNG���NN ��� !533333�Z�NNN�N��k��k �� �� 33!!5335!SN�����N���S���NNG��NN ��p� %!#!5!5!5!3!!!��N��,��,N,��,���GNNNG��NN ��p� ###533333#SNN��NNN��p��k�N��k��kN�k ��p� 33!!533##!##5!SN�����Nz�N,��N�,S���NNG�����kGN �pS 4>33#"5]{F''HwF�p�F{]5NGvH�p ��pSS !#4&&##532 SNGvH''F{]5�p�HvGN5]{ ��S� ##532665S5]{F''HvG�pF{]5NFwH� � 333#".NFwH''F{]5X��pHwFN5]{ ��X� 3#-+��+�YW�� ��X� #5+-+�����WYW ��X� #5533-����+��++������WW��W����W ��SS 5!'zNN S� 3N� S 5!zNN �pSS 3N�p� �� �Sz '5!'zޜ� �z� 3ޜ� �z %5!zޜ� �pzS 3ޜ�p� �� �z %!5!5!5!����,z�'N' �pz� #333z�'N'�p���k �� �z !!5!!���z,'�' �pz� ###3z'N'��k�� ,X� !X,��D �pX� 5!X�p�� �pX�� !X�p^�� �pX } !X�p
�� �pX, !X�p��D �pX� !X�pk�� �pX� !X�p�� �pX9 !X�p�7 �pX� !X�px�� �p
� !
�px�� �p�� !�px�� �pw� !w�px�� �p,� !,�px�� �p �� 3�px�� �p �� 3��px�� �p K� 3K�px�� ,�pX� !,,�px�� *��X� # / ; G S _ k w � � � � � � � � � � � +7CO[gs���������� 4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&���8
�
�
���8
�
�
���8
�
�
���8
�
�
���8
�
�
���8
�
�
���8
�
�
�U
ZU
ZU
ZU
ZU
ZU
ZU
*��L*� # / ; G S _ k w � � � � � � � � � � � +7CO[gs���������� 4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&� � � >��� � � >��� � � >��� � � >��� � � >��� � � >��� � � >��� NU NU NU NU NU NU N *��:E� # / ; G S _ k w � � � � � � � � � � � +7CO[gs���������� 4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&4632#"&'4632#"&'4632#"&�/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �/""//""/�/""//""/�/""//""/G � � �"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B N"//""//""//""//""//""//B 9X� 5!X9��
�pX� 3
K�px�� �p,, !,�p��D ,�pX, !,,�p��D ,,� !,,��D �pX� !!,,�px�D�D �pX� !!,,,��D�D��D �pX� !!!X���X,�Dx �pX� !!!X���X�p�� ,,X� !,,,��D �pX� !!,,��,,��D�D��D �pX� !!!X��,,�p���� M���� �� ��Q�� 4
� % 3#5754632&#"3#33"&54632vBBEI* Egg�R( && &&�>MJW ? ^MC�]�L# ## # 9��� % "&533267%#5754632&#"3#�.)R ��BBEI* Dgg 95f��> �>MJW ? ^MC�] c��d$ #4>55#7#3�Q"8DC8"t��u"8CD8"QQ��DY;+)5O<����EZ<+(4N<�3� S�Z� 3333'53##SJ�R�JT���^>���yװ�"�Ǽ�� -��+X� ��X X��(�l ��� c� '7*1��19�0--0�� ��e e��e���� ��� _� .��91���]]0��� Hf $ < H T ` l & ~ & �
* � 6 � D* :n � 2� $ � D* � � � L � dP *� �� 4� 4� 2
8 4X � � � � � � � $ >
, ^ 0 � . �
2 � 8
&
R <
x � "
� . � 2 �
�
� "
� 0 J d ~ 0 � ( �
, � 4 8 J < � 0 � H � "
� 2
6 8 J���� a���� g i & l �� ������������� J���� ����� ����� �������� 1��������� ����� [� ]����� �� ������ [ 0 ]����������� ����� [ - ]������������ ���������� [ * ]������� ��� �������� �� ������ [ $ ]����������� ����������� [ - , * ]���� � , ���� a���� � , ���� g , ������� 1���� � , ���� J � 2 0 1 0 - 2 0 2 0 A d o b e S y s t e m s I n c o r p o r a t e d ( h t t p : / / w w w . a d o b e . c o m / ) , w i t h R e s e r v e d F o n t N a m e S o u r c e . S o u r c e C o d e P r o R e g u l a r 2 . 0 3 8 ; A D B O ; S o u r c e C o d e P r o - R e g u l a r ; A D O B E V e r s i o n 2 . 0 3 8 ; h o t c o n v 1 . 0 . 1 1 6 ; m a k e o t f e x e 2 . 5 . 6 5 6 0 1 S o u r c e C o d e P r o - R e g u l a r S o u r c e i s a t r a d e m a r k o f A d o b e S y s t e m s I n c o r p o r a t e d i n t h e U n i t e d S t a t e s a n d / o r o t h e r c o u n t r i e s . A d o b e S y s t e m s I n c o r p o r a t e d P a u l D . H u n t , T e o T u o m i n e n h t t p : / / w w w . a d o b e . c o m / t y p e T h i s F o n t S o f t w a r e i s l i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 . T h i s l i c e n s e i s a v a i l a b l e w i t h a F A Q a t : h t t p : / / s c r i p t s . s i l . o r g / O F L . T h i s F o n t S o f t w a r e i s d i s t r i b u t e d o n a n A S I S B A S I S , W I T H O U T W A R R A N T I E S O R C O N D I T I O N S O F A N Y K I N D , e i t h e r e x p r e s s o r i m p l i e d . S e e t h e S I L O p e n F o n t L i c e n s e f o r t h e s p e c i f i c l a n g u a g e , p e r m i s s i o n s a n d l i m i t a t i o n s g o v e r n i n g y o u r u s e o f t h i s F o n t S o f t w a r e . h t t p : / / s c r i p t s . s i l . o r g / O F L s i m p l e a s i m p l e g s e r i f e d i & l S a m i J c u r s i v e � c u r s i v e � c u r s i v e � S e r b i a n � C y r i l l i c b r e v e [� ] s l a s h e d z e r o [ 0 ] t y p o g r a p h i c h y p h e n [ - ] t y p o g r a p h i c a s t e r i s k [ * ] s l a s h e d d o l l a r s i g n [ $ ] a l t e r n a t e n u m e r a l o n e [ 1 ] t y p o g r a p h i c a l t e r n a t e s [ - , * ] s i m p l e a , c u r s i v e � s i m p l e g , c u r s i v e � , S e r b i a n 1 S a m i J , c u r s i v e �?@>AB>9 0?@>AB>9 gV 8 � A 70A5G:0<8A00<A:89 JA:>@>?8A=K9 �A:>@>?8A=K9 �A:>@>?8A=K9 �A5@1A:89 1:8@8;;8G5A:0O :@0B:0 [� ]70G5@:=CBK9 =>;L [ 0 ]B8?>3@0DA:89 45D8A [ - ]B8?>3@0DA:0O 72574>G:0 [ * ]70G5@:=CBK9 7=0: 4>;;0@0 [ $ ]B8?>3@0DA:85 70<5AB8B5;8 [ - , * ]?@>AB>9 0 , A:>@>?8A=K9 �A5@1A:89 1 , ?@>AB>9 g , A:>@>?8A=K9 �A00<A:89 J , A:>@>?8A=K9 � �� 2 $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] � � � � b c
� d � � � e � � !"#$%&'()*+,-. �/0123456789: � � �; �< �=>?@ABCDEFGHIJK �LMNOPQR fSTUV � � � � gWXYZ[\]^_`abcdefghi �j �klmnopqrs �tuvwxyz{|}~ � � �� h������������������������ �� ������ ����� � ������ j i k m l�� n��������������� ����� o �� ����� q p r� s��������������� ������������� u t v� w������ ������������ �������� x����� z y { } |���
� � � � !"#$%& ~ �' �()*+,-./0123456789:;<=>? �@ �ABCDE �FGHI � �JKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~�������������������������������������������������������������������������������������������������������������������������������� �
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~������������������������������������������������������������������������������������������������������� ������������������������� � � " �
� � � � � � � � � � � � � �
B > @ ^ ` _ ? �
� � � � !"#$%& �' � �( #) *+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdef �g �hijklmnopqrstuvwxyz{|}~���������������� � � �� ����������������� � ��� � � � ����������������� � � �� � ! � � � A � a � ���� � ����� � ��� ������ � �������������������������������������������������������� ������� C � � � � � � � � � � � �
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~��������������������������������������������������������������������������������������������������������������������������������
!"#$%&'()*+,-.AmacronAbreve
Aringacuteuni01CDAogonekuni1EA0uni1EA2uni1EA4uni1EA6uni1EA8uni1EAAuni1EACuni1EAEuni1EB0uni1EB2uni1EB4uni1EB6AEacuteuni01E2uni0243uni1E06 Ccircumflex
CdotaccentDcaronuni1E0Cuni1E0Euni1E10Dcroatuni018AEcaronEmacronEbreve
EdotaccentEogonekuni1EB8uni1EBAuni1EBCuni1EBEuni1EC0uni1EC2uni1EC4uni1EC6uni1E16uni01F4 Gcircumflex
Gdotaccentuni0122Gcaronuni1E20 uni00470303uni0193 Hcircumflexuni1E26uni1E24uni1E28uni1E2AHbarItildeImacronuni01CFIogonekuni1EC8uni1ECAIbreve Jcircumflexuni0136uni1E32uni1E34LacuteLcaronuni013Buni1E36uni1E38uni1E3ALdotuni1E3Euni1E40uni1E42Nacuteuni01F8Ncaronuni0145uni1E44uni1E46uni1E48Omacron
OhungarumlautObreveuni01D1uni01EAuni1ECCuni1ECEuni1ED0uni1ED2uni1ED4uni1ED6uni1ED8Ohornuni1EDAuni1EDCuni1EDEuni1EE0uni1EE2uni1E52 OslashacuteRacuteRcaronuni1E58uni0156uni1E5Auni1E5Cuni1E5ESacute Scircumflexuni1E66uni015Euni0218uni1E60uni1E62uni1E9ETcaronuni0162uni021Auni1E6Cuni1E6ETbarUtildeUmacronUbreveUring
Uhungarumlautuni01D3Uogonekuni01D5uni01D7uni01D9uni01DBuni1EE4uni1EE6Uhornuni1EE8uni1EEAuni1EECuni1EEEuni1EF0uni1E7EWgraveWacute Wcircumflex WdieresisYgrave Ycircumflexuni1E8Euni1EF4uni1EF6uni1EF8Zacute
Zdotaccentuni1E90uni1E92uni1E94uni018FEngIJuni004C00B7004C uni01320301amacronabreve
aringacuteuni01CEaogonekuni1EA1uni1EA3uni1EA5uni1EA7uni1EA9uni1EABuni1EADuni1EAFuni1EB1uni1EB3uni1EB5uni1EB7aeacuteuni01E3uni0180uni1E07 ccircumflex
cdotaccentdcaronuni1E0Duni1E0Funi1E11ecaronemacronebreveeogonek
edotaccentuni1EB9uni1EBBuni1EBDuni1EBFuni1EC1uni1EC3uni1EC5uni1EC7uni1E17uni01F5 gcircumflex
gdotaccentuni0123gcaronuni1E21 uni00670303 hcircumflexuni1E27uni1E25uni1E96uni1E29uni1E2Bhbaritildeimacronuni01D0iogonekuni1EC9uni1ECBibreve jcircumflexuni0137uni1E33uni1E35 kgreenlandiclacutelcaronuni013Cuni1E37uni1E39uni1E3Bldotuni1E3Funi1E41uni1E43nacuteuni01F9ncaronuni0146uni1E45uni1E47uni1E49 napostropheomacron
ohungarumlautuni01D2uni01EBuni1ECDuni1ECFuni1ED1uni1ED3uni1ED5uni1ED7uni1ED9obreveuni1E53ohornuni1EDBuni1EDDuni1EDFuni1EE1uni1EE3 oslashacuteracuteuni0157rcaronuni1E59uni1E5Buni1E5Duni1E5Fsacute scircumflexuni1E67uni015Funi0219uni1E61uni1E63longstcaronuni0163uni021Buni1E6Duni1E6Funi1E97tbarutildeumacronubreveuring
uhungarumlautuni01D4uogonekuni01D6uni01D8uni01DAuni01DCuni1EE5uni1EE7uhornuni1EE9uni1EEBuni1EEDuni1EEFuni1EF1uni1E7Fwgravewacute wcircumflex wdieresisygrave ycircumflexuni1E8Funi1EF5uni1EF7uni1EF9zacute
zdotaccentuni1E91uni1E93uni1E95enguni0237ijuni006C00B7006C uni01330301uni0250uni0252uni0253uni0254uni0255uni0256uni0257uni0258uni0251uni0299uni0259uni025Auni025Buni025Cuni025Euni025Funi0260uni0261uni0262uni0263uni0264uni0265uni0266uni0267uni029Cuni0268uni026Auni029Duni029Euni026Buni026Cuni026Duni026Euni029Funi026Funi0270uni0271uni0272uni0273uni0274uni0275uni0276uni0278uni0279uni027Auni027Buni027Duni027Euni0280uni0281uni0282uni0283uni0284uni0287uni0288uni0289uni028Auni028Buni028Cuni028Duni028Euni028Funi0290uni0291uni0292uni02A4uni02A6uni02A7uni0294uni0295uni02A1uni02A2uni01C2uni0298 uni014A.aa.aagrave.aaacute.a
acircumflex.aatilde.a adieresis.a amacron.aabreve.aaring.a aringacute.a uni01CE.a uni1EA1.a uni1EA3.a uni1EA5.a uni1EA7.a uni1EA9.a uni1EAB.a uni1EAD.a uni1EAF.a uni1EB1.a uni1EB3.a uni1EB5.a uni1EB7.a aogonek.ag.a uni01F5.a
gcircumflex.agbreve.a gdotaccent.a uni0123.agcaron.a uni1E21.a
uni00670303.ai.a
dotlessi.aigrave.aiacute.a
icircumflex.aitilde.a idieresis.a imacron.a uni01D0.a iogonek.a uni1EC9.a uni1ECB.a uni012D.a uni0268.a iogonek.d
iogonek.da uni0268.d
uni0268.da uni029D.dl.alacute.alcaron.a uni013C.a uni1E37.a uni1E39.a uni1E3B.alslash.aldot.auni006C00B7006C.a uni026B.a uni026C.aAlphaBetaGammauni0394EpsilonZetaEtaThetaIotaKappaLambdaMuNuXiOmicronPiRhoSigmaTauUpsilonPhiChiPsiuni03A9
Alphatonos EpsilontonosEtatonos Iotatonos Iotadieresis Omicrontonos UpsilontonosUpsilondieresis
Omegatonosalphabetagammadeltaepsilonzetaetathetaiotakappalambdauni03BCnuxiomicronrhosigmatauupsilonphichipsiomegauni03C2uni03D0uni03D1uni03D5phi.a
alphatonos epsilontonosetatonos iotatonos iotadieresis omicrontonos upsilontonosupsilondieresis
omegatonosiotadieresistonosupsilondieresistonosuni03D7uni03D9uni03DBuni03DDuni03E1uni037E anoteleia
anoteleia.capuni0374uni0375tonos tonos.cap
dieresistonosuni037Auni1FBEuni1FBDuni1FBFuni1FFEuni1FEFuni1FFDuni1FCDuni1FDDuni1FCEuni1FDEuni1FCFuni1FDFuni1FC0uni1FEDuni1FEEuni1FC1 uni1FBD.cap uni1FFE.cap uni1FEF.cap uni1FFD.cap uni1FCD.cap uni1FDD.cap uni1FCE.cap uni1FDE.cap uni1FCF.cap uni1FDF.capuni0410uni0411uni0412uni0413uni0414uni0415uni0416uni0417uni0418uni0419uni041Auni041Buni041Cuni041Duni041Euni041Funi0420uni0421uni0422uni0423uni0424uni0425uni0426uni0427uni0428uni0429uni042Auni042Buni042Cuni042Duni042Euni042Funi0400uni0401uni0402uni0403uni0404uni0405uni0406uni0407uni0408uni0409uni040Auni040Buni040Cuni040Duni040Euni040Funi0462uni0472uni0474uni0490uni0492uni0496uni0498uni049Auni04A0uni04A2uni04AAuni04AEuni04B0uni04B2uni04B6uni04BAuni04C0uni04C1uni04D0uni04D4uni04D6uni04D8uni04E2uni04E6uni04E8uni04EEuni04F2uni0430uni0431uni0432uni0433uni0434uni0435uni0436uni0437uni0438uni0439uni043Auni043Buni043Cuni043Duni043Euni043Funi0440uni0441uni0442uni0443uni0444uni0445uni0446uni0447uni0448uni0449uni044Auni044Buni044Cuni044Duni044Euni044Funi0450uni0451uni0452uni0453uni0454uni0455uni0456uni0457uni0458uni0459uni045Auni045Buni045Cuni045Duni045Euni045Funi0463uni0473uni0475uni0491uni0493uni0497uni0499uni049Buni04A1uni04A3uni04ABuni04AFuni04B1uni04B3uni04B7uni04BBuni04C2uni04CFuni04D1uni04D5uni04D7uni04D9uni04E3uni04E7uni04E9uni04EFuni04F3 uni0430.a uni04D1.a uni0431.srb uni0456.a uni0457.a uni04CF.auni2116zero.aone.a zero.onumone.onumtwo.onum
three.onum four.onum five.onumsix.onum
seven.onum
eight.onum nine.onumzero.bone.bzero.capone.captwo.cap three.capfour.capfive.capsix.cap seven.cap eight.capnine.capzero.cone.c
quotereverseduni00ADuni2010
figuredashuni2015uni25E6uni25AAuni25ABuni25B4uni25B5uni25B8uni25B9uni25BEuni25BFuni25C2uni25C3 invbullet
filledrect
underscoredbluni203Euni203Funi2016 exclamdbluni2047uni2049uni2048uni203Duni2E18uni231Cuni231Duni231Euni231Funi27E6uni27E7uni2E22uni2E23uni2E24uni2E25uni2117uni2120at.case
asterisk.ahyphen.a uni00AD.a uni2010.adollar.a zero.supsone.supstwo.sups
three.sups four.sups five.supssix.sups
seven.sups
eight.sups nine.supsparenleft.supsparenright.sups period.sups
comma.sups zero.subsone.substwo.subs
three.subs four.subs five.subssix.subs
seven.subs
eight.subs nine.subsparenleft.subsparenright.subs period.subs
comma.subs zero.dnomone.dnomtwo.dnom
three.dnom four.dnom five.dnomsix.dnom
seven.dnom
eight.dnom nine.dnomparenleft.dnomparenright.dnom period.dnom
comma.dnom zero.numrone.numrtwo.numr
three.numr four.numr five.numrsix.numr
seven.numr
eight.numr nine.numrparenleft.numrparenright.numr period.numr
comma.numr
ordfeminine.aa.supsb.supsc.supsd.supse.supsf.supsg.supsh.supsi.supsj.supsk.supsl.supsm.supsn.supso.supsp.supsq.supsr.supss.supst.supsu.supsv.supsw.supsx.supsy.supsz.sups egrave.sups eacute.sups eogonek.sups uni0259.sups uni0266.supsuni02E0uni02E4a.supag.supai.supa
colon.sups hyphen.sups endash.sups emdash.supsEurouni0192
colonmonetarylirauni20A6pesetauni20A9donguni20B1uni20B2uni20B4uni20B5uni20B9uni20BAuni20AEuni20B8uni20BDuni2215
slash.fraconethird twothirdsuni2155uni2156uni2157uni2158uni2159uni215Auni2150 oneeighth threeeighths fiveeighths seveneighthsuni2151uni2152uni2189uni2219 equivalence
revlogicalnot intersection
orthogonaluni2032uni2033uni2035uni00B5
integraltp
integralbtuni2206uni2126uni2200uni2203uni2237uni2105uni2113 estimateduni2190arrowupuni2192 arrowdownuni2196uni2197uni2198uni2199uni21D0uni21D1uni21D2uni21D3 arrowboth arrowupdn arrowupdnbseuni25CFuni25CBuni25A0uni25A1uni2752uni25C6triagupuni25B3uni25B6uni25B7triagdnuni25BDuni25C0uni25C1triagrttriaglf invcircleuni25C9uni2610uni2611uni2713 musicalnotemusicalnotedblheartclubdiamondspade smileface invsmilefaceuni2764uni2615u1F4A9u1F916u1F512femalemalesunhouseuni02B9uni02BBuni02BCuni02BEuni02BFuni02C1uni02D0uni02D1uni02DEuni02C8uni02C9uni02CAuni02CBuni02CCuni25CCuni0300 uni0300.capuni0340uni0301 uni0301.cap uni0301.guni0302 uni0302.capuni0303 uni0303.capuni0304 uni0304.capuni0305 uni0305.capuni0306 uni0306.c uni0306.cap uni0306.ccapuni0307 uni0307.capuni0308 uni0308.capuni0309 uni0309.capuni0310 uni0310.capuni030A uni030A.capuni030B uni030B.capuni030C uni030C.cap uni030C.auni030F uni030F.capuni0311 uni0311.capuni0312 uni0312.guni0313uni0343uni0318uni0319uni031Auni031Buni031Cuni031Duni031Euni031Funi0320uni0323uni0324uni0325uni0326 uni0326.auni0327 uni0327.capuni0328 uni0328.capuni0329uni032Auni032Cuni032Euni032Funi0330uni0331uni0334uni0339uni033Auni033Buni033Cuni033Duni0342 uni0342.capuni0345uni035Funi0361 uni03080301uni03080301.cap
uni03080301.g uni03080300uni03080300.cap
uni03080300.g uni03080303 uni03080304uni03080304.cap uni0308030Cuni0308030C.cap uni03020301uni03020301.cap uni03020300uni03020300.cap uni03020309uni03020309.cap uni03020303uni03020303.cap uni03060301uni03060301.cap uni03060300uni03060300.cap uni03060309uni03060309.cap uni03060303uni03060303.cap uni03020306uni03020306.cap uni03040301uni03040301.cap uni030C0307uni030C0307.cap uni03120301 uni03120300 uni03120303 uni03130301 uni03130300 uni03130303uni00A0uni2007
space.frac nbspace.fracuni2500uni2501uni2502uni2503uni2504uni2505uni2506uni2507uni2508uni2509uni250Auni250Buni250Cuni250Duni250Euni250Funi2510uni2511uni2512uni2513uni2514uni2515uni2516uni2517uni2518uni2519uni251Auni251Buni251Cuni251Duni251Euni251Funi2520uni2521uni2522uni2523uni2524uni2525uni2526uni2527uni2528uni2529uni252Auni252Buni252Cuni252Duni252Euni252Funi2530uni2531uni2532uni2533uni2534uni2535uni2536uni2537uni2538uni2539uni253Auni253Buni253Cuni253Duni253Euni253Funi2540uni2541uni2542uni2543uni2544uni2545uni2546uni2547uni2548uni2549uni254Auni254Buni254Cuni254Duni254Euni254Funi2550uni2551uni2552uni2553uni2554uni2555uni2556uni2557uni2558uni2559uni255Auni255Buni255Cuni255Duni255Euni255Funi2560uni2561uni2562uni2563uni2564uni2565uni2566uni2567uni2568uni2569uni256Auni256Buni256Cuni256Duni256Euni256Funi2570uni2571uni2572uni2573uni2574uni2575uni2576uni2577uni2578uni2579uni257Auni257Buni257Cuni257Duni257Euni257Funi2580uni2581uni2582uni2583uni2584uni2585uni2586uni2587uni2588uni2589uni258Auni258Buni258Cuni258Duni258Euni258Funi2590uni2591uni2592uni2593uni2594uni2595uni2596uni2597uni2598uni2599uni259Auni259Buni259Cuni259Duni259Euni259Funi202FuniFEFFu1F3B5u1F3B6f_if_luniE0A0uniE0A1uniE0A2uniE0B0uniE0B1uniE0B2uniE0B3 ideoromn DFLT cyrl grek latn �V � t
! ! " " # ' ) 1 3 5 7 7 : : = = @ @ M M [ [ ^ ^ e e v v � � � � � � � � � � � � � � � � � �
$$ ** 00 ?? BB QQ UU \\ aa ss ww �� �� �� �� �� �� �� �� �� �� �� �� �� �� � ## && 56 ;; ?@ HH LN QR YY \^ bb dd ff ll nn qq uu �� �� �� �� �� �� �� �� �� �� �� �� �� ��
$% '- 01 46 KL ee �� �� � E Hn � # 11 BD Hn
�( DFLT cyrl .grek Xlatn l ��
SRB �� ! ��
" �� # ATH &NSM 6SKS F �� $ ��
% �� & �� ' (ccmp �ccmp �ccmpccmp
ccmpccmpccmp"ccmp*frac2frac8frac>fracDfracJfracPfracVfrac\markbmarkvmark�mark�mark�mark�mark�mark�mkmkmkmkmkmkmkmkmkmkmkmk mkmk&mkmk,size2size6size:size>sizeBsizeFsizeJsizeN
d & . 8 B J T \ d l t | � � v x z � � � � � � � b | � n � �
Z
P�� �
�t � � � � � 2 � � X ��� X ��� V �� v � Z S � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �x~x���xx���x����xxxxx������������r rr&x,2�x�xx8xx�>��D�rr ��DJPV\bhn�tz��rr���r�r�������J�������rrr�r����������D
Dx�xxx�xxJ�r "x�(�x�x.(x�x,x�4:@�Frrr�rLrRr�r ,� ,� Z� K� V� J� D� F� �� @� .� 0� <� =� @� �� Z� �� �� �� \� �� � >� A� 0� d� /� � '� B� �� +� � B� \� D� ?� %� "� T� `� n� �� -� 6� N� #� � � {� �� &� G� �� �� F� j� �� �� �� J� %� ,� 2� 2� H� H� H N� � P� (� :� � ]� M� <� X� �� �� Z `
,� �� D L h h . d j p v | � ^ � ^ � � ^ ^ � � � � � � � � � � ^ � � � � � � � � � � � � ^ , ^ F � z ] � ? � @ � Z ' * � b k � � : � � � 6 � N �� j Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z Z } � � � � & �,28 � �> � �D �JPV\bhntz8 ������ � � ��b��& � �V�hz � ���n�DD��� �V2������ ��D� �h ���z�
"(��.4:@ �F � �� �LRX^2V�ddd�dddd � � �jp � ,�� X�� &�� M�� ��� J�� R�� ]�� ��� @�� 9�� .�� <�� 6�� T�� 0�� #�� :�� \�� �% O�� ��� ��% �% ��� 5�� |�� �% P�� "�� 2�� i�% �� h�� 3�% �� �� &�% F�� ,� a�� �% �% ��% e�% W�� ��% ��% �� 0�% H�% 6�% �% `�� |�% /�� � N�� K�% �� H�� �� ��� ��
, � �Q � Q� �� " ,� �� �� �� �� �� H H D J > > > > P V > \ b D D D h > n P P P t V > J J J J z z > , � � � d � �� � 6 � P �2 Z S h n h h n h h n h n h n h n h h n n h n h n h n h n h n h n h n h n h n h h h h h h h n h n h h n h h h n h n h n h n h n h n h n h n h n h n h n h n h n h h h h h h & & , 2 8 8 2 2 > D J P ,� ,� ,j ,� ,L ,> ,� ,i ,[ ,T G F , ! # $ % & ' / (a������������������� # " % + , 4������������������� hj FG � E JJ JMM Kin L R � # 11 (BD )Hn , �
! # $ % & ' ) * + , - . / 0 1 3 4 5 @ M [ e � � � � � � � � �
QUaw��������������������������������������
56?@HLMNQRY\]^bdflnqu��������������
$%'()*+,-01456KLe� & � 23 .
! # $ ' ) * - . / 0 3 5 M � �U��� ?@LRY\]� $% (0 6< >A EE }
! # $ % & ' ) * + , - . / 0 1 3 4 5 M [ � � � � �Ua��������������������������������������
6?@LQRY\]^du�� =
'R� ' *� 45
$ * 0 4 7 : = ^ � �
*Us #&?@� ��
�� DFLT cyrl fgreklatnR �� ! ( 0 8 @ H P X ` h p x � � � � � � � � � � � � � � � �
SRB T �� " ! ) 1 9 A I Q Y a i q y � � � � � � � � � � � � � � � � � �� "
" * 2 : B J R Z b j r z � � � � � � � � � � � � � � � � � �� " # + 3 ; C K S [ c k s { � � � � � � � � � � � � � � � � ATH ^NSM �SKS � �� ! $ , 4 < D L T \ d l t | � � � � � � � � � � � � � � � �� !
% - 5 = E M U ] e m u } � � � � � � � � � � � � � � �
�� " & . 6 > F N V ^ f n v ~ � � � � � � � � � � � � � � � � �� " ' / 7 ? G O W _ g o w � � � � � � � � � � � � � � � �
casePcaseVcase\casebcasehcasencasetcasezccmp�ccmp�ccmp�ccmp�ccmp�ccmp�ccmp�ccmp�cv01�cv01�cv01�cv01cv01cv01cv01cv01cv02 cv02&cv02,cv022cv028cv02>cv02Dcv02Jcv04Pcv04Vcv04\cv04bcv04hcv04ncv04tcv04zcv06�cv06�cv06�cv06�cv06�cv06�cv06�cv06�cv07�cv07�cv07�cv07�cv07�cv07�cv07�cv07�cv08�cv08�cv08�cv08�cv08�cv08�cv08cv08
cv09cv09cv09 cv09"cv09(cv09.cv094cv09:cv10@cv10Fcv10Lcv10Rcv10Xcv10^cv10dcv10jcv11pcv11vcv11|cv11�cv11�cv11�cv11�cv11�cv12�cv12�cv12�cv12�cv12�cv12�cv12�cv12�cv14�cv14�cv14�cv14�cv14�cv14�cv14�cv14�cv15 cv15 cv15 cv15 cv15 cv15 cv15 $cv15 *cv16 0cv16 6cv16 <cv16 Bcv16 Hcv16 Ncv16 Tcv16 Zcv17 `cv17 fcv17 lcv17 rcv17 xcv17 ~cv17 �cv17 �dnom �dnom �dnom �dnom �dnom �dnom �dnom �dnom �frac �frac �frac �frac �frac �frac �frac
frac
locl
locl
&locl
.locl
4locl
:numr
@numr
Fnumr
Lnumr
Rnumr
Xnumr
^numr
dnumr
jonum
ponum
vonum
|onum
�onum
�onum
�onum
�onum
�ordn
�ordn
�ordn
�ordn
�ordn
�ordn
�ordn
�ordn
�salt
�salt
�salt salt $salt @salt \salt xsalt �sinf �sinf �sinf �sinf �sinf �sinf �sinf �sinf �ss01 �ss01 �ss01 �ss01 �ss01 ss01 ss01 ss01 ss02 ss02 (ss02 0ss02 8ss02 @ss02 Hss02 Pss02 Xss03 `ss03 jss03 tss03 ~ss03 �ss03 �ss03 �ss03 �ss04 �ss04 �ss04 �ss04 �ss04 �ss04 �ss04 �ss04 �ss05 �ss05 �ss05 �ss05 �ss05
ss05
ss05
ss05
ss06
ss06
&ss06
,ss06
2ss06
8ss06
>ss06
Dss06
Jss07
Pss07
Vss07
\ss07
bss07
hss07
nss07
tss07
zsubs
�subs
�subs
�subs
�subs
�subs
�subs
�subs
�sups
�sups
�sups
�sups
�sups
�sups
�sups
�sups
�zero zerozero zerozerozero zero$zero* @ : 4 . ( " � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � ~ x r l t n h b \ V P J R L F @ : 4 . ( 0 * $ � � � � � � � � � � � � � � � � � � � � � � � � � � � � ~ � � z t n h b \
� � � � � � � � � � � � � � � � ~ t j ` V P J D > 8 2 , & $ � � � � � � � � � � � � � � � � � � �
$ J R Z b j r ~ � � � � � � � � � � � � � � � &.6>FNV^fn , * 0 . , z�� ��� � � �� � � 2 < x � � � � V h � � � � � � � � � � � � � !# L
& , 2 8 > D J P * *
U � � � � � � �� � ! � � ! � � " � : d � � $U �S �Y c W $] �[ �a _ a C $ * 0 6 <K �M �H �J N O Q N C & ,j �j �i �i k k C & ,m �m �l �l n n C � , 6 @ J T ` j t ~ � � � � � � � � � � @ 4 e 4 v � 4 �
� 4 � 4
4 $ 0 4 B ? 2 Q 4 � � '\ w 4 � � 4 � � � ; 2 * v " � d " � !$%"# �
� � � � # � � # �� � # � )*+,-./0123456789:;<=>?@ABCDEFG �������������� r MNOP � ���� N R 9������������������������� 35CILPRTVXZ\^`bdf P !"#$%&'(5)*+,-./01234ef'J :
6789:;<=>K 6 ?RABCDEFGHIJK@STUVWXYZ[L\]NPhijL 4 4 4 4
8 C < <�� <
<
@
M 4 N 4 * (U�MOQNP�� 35CILPRTVXZ\^`bdf ( q
r � �� "
_ b � �+.qt�A _ �+q b �.t � �A $ 4 ��
CHKOQSUWY[]_ace ? $ %Q��HL !#
" $ ' * / 0 �6 6 Y [ [ > ] x ? z z [ | � \ � � � � � � � � � � �^~ �� � !��
24CHKOQSUWY[]_ace !�� 35CILPRTVXZ\^`bdf mv ��
�� � ! o
hj %
qr 5 )* 00 �� �� ���� mv 9��mnopqrstuvxyz{|}~������
24CHKOQSUWY[]_ace \\ && )) " " ;B // $ 'JKLMNOPQRSTU[\]^_`ab����MO@A[1 � � � my� �� � R n nz� $? ( $ %Q��HL��
24CHKOQSUWY[]_ace % oo share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf 0000644 00000273670 15173517750 0024563 0 ustar 00 DSIG w� GPOS�� , K�GSUBV.T L� OS/2ٮ�i M� `cmapRԟ� NP �cvt '�� m` 8fpgm� zA m� �gasp mX glyf*~ʙ S8 �Bhead��e� �| 6hhea�� � $hmtx[�`� �� TkernlBjT �, l�loca�.� V ,maxp<
� X< name� $� X\ ^post:�] i� �prep�x9� w, �
0 J DFLT latn �� �� kern kern Jn v �$R�
�^� h
B
l � & ��rj����Z ���j��L�� * | � D V � : � � �!.!�##L#�$4$~%�&J'$'�(�)�*�+f+�,6,�-�.(.�/t/�/�0:0|2"2�33T3�3�4&4l4�55b5�66L6�6�7B7�7�888�9d9�9�:&:�:�;@<�=�>j?,?�@hA�B�CzD�E�F�G*G�HfI� K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J - �
�
� �x #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�h ?�L Y�| Z�� \�| l� m�x o�x r� y�x |� }�x ��� ��� ��� ��� ��� ��� ��� ��h �� �� �h �x �x � � � � �x �x �x �� ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� - �
�
� �x #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�h ?�L Y�| Z�� \�| l� m�x o�x r� y�x |� }�x ��� ��� ��� ��� ��� ��� ��� ��h �� �� �h �x �x � � � � �x �x �x �� k 0 �x
0
0 �@ �� �@ �x �� �� " 0 #�� $�x &�� *�� -�h 2�� 4�� D�� F�� G�� H�� I�� J�x P�� Q�� R�� S�� T�� U�� V�� W�� X�� Y�� [�� \�� ]�� l 0 m�� o�� r 0 t : u : w�� y�� { : | 0 }�� ��x ��x ��x ��x ��x ��x ��x ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �x �� �� �� �� �� �� �� � � � 0 � 0 �@ � 0 � 0 �@ � � � � 0 ��x ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J
�j m�j o�j y�j }�j �j �j �j �j �j ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� 4 �| �L �L �| �� �� " $�| -�: F�� G�� H�� P�� Q�� R�� S�� T�� U�� X�� w�� ��| ��| ��| ��| ��| ��| ��| ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �| �� �� �� �� �L �L ��| �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� 1 �� #�� &�� *�� 2�� 4�� F�� G�� H�� I�� R�� T�� W�� Y�� Z�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� I ��
��
�� 6 �: 6 "�� #�� &�� *�� 2�� 4�� 7�T 9�J :�h <�, ?�J F�� G�� H�� R�� T�� Y�� Z�� \�� l�� m�: o�: r�� t�6 u�6 y�: {�6 |�� }�: ��� ��� ��� ��� ��� ��� ��� ��, ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �, �: �: �� �� � 6 �� �� � 6 �: �: �: ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� . �v � � �v $�v -�J D�� F�� G�� H�� R�� T�� ��v ��v ��v ��v ��v ��v ��v ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �v �� �� �� �� � � ��v ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� #�� &�� *�� 2�� 4�� 7�� 8�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� [ �| �L �L �L �| �` �` #�� $�| &�� *�� -�8 2�� 4�� D� F�. G�. H�. J�D P�` Q�` R�. S�` T�. U�` V�^ X�` Y�L Z�t [�p \�L ]�� m�L o�L w�` y�L }�L ��| ��| ��| ��| ��| ��| ��| ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� ��. ��. ��. ��. ��. ��. ��` ��. ��. ��. ��. ��. ��. ��` ��` ��` ��` �| � �� �. �. �` �� �. �L �L �L �L �L �L �L ��| �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� k 0 �x
0
0 �@ �� �@ �x �� �� " 0 #�� $�x &�� *�� -�h 2�� 4�� D�� F�� G�� H�� I�� J�x P�� Q�� R�� S�� T�� U�� V�� W�� X�� Y�� [�� \�� ]�� l 0 m�� o�� r 0 t : u : w�� y�� { : | 0 }�� ��x ��x ��x ��x ��x ��x ��x ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �x �� �� �� �� �� �� �� � � � 0 � 0 �@ � 0 � 0 �@ � � � � 0 ��x I 0 ��
0
0 �� �� �� �� " " $�� -�� D�� F�� G�� H�� J�� R�� T�� V�� l 0 m�� o�� r 0 t 0 u 0 y�� { 0 | 0 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� � 0 � 0 � � 0 � 0 � �� �� �� � 0 ��� 1 �� #�� &�� *�� 2�� 4�� F�� G�� H�� I�� R�� T�� W�� Y�� Z�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� i �\
�h �` �h �\ �� �� " " #�� $�\ &�� *�� -�8 2�� 4�� D�� F�` G�` H�` J�T P�� Q�� R�` S�� T�` U�� V�� X�� Y�� Z�� [�| \�� l m�` o�` r t 2 u 2 w�� y�` { 2 | }�` ��\ ��\ ��\ ��\ ��\ ��\ ��\ ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��` ��` ��` ��` ��` ��` ��� ��` ��` ��` ��` ��` ��` ��� ��� ��� ��� �\ �� �� �` �` �� �� �` �` �` � � �h � � �h �` �` �` � ��\ 0 �� " " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� D
D
D �~ �~ l D r D t d u d { d | D � D � D �~ � D � D �~ � D ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ���
�| �| D�� ��� ��� ��� ��� ��� ��� ��� �� �| �| $ �� �| �| �� $�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �| �| ��� �� �� �� �� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� $ �� �| �| �� $�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �| �| ��� " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J �H �H $�H 9 : : : < ( ? : ��H ��H ��H ��H ��H ��H ��H � ( �H � ( ��H �H �H $�H 9 : : : < ( ? : ��H ��H ��H ��H ��H ��H ��H � ( �H � ( ��H ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� �H �H $�H 9 : : : < ( ? : ��H ��H ��H ��H ��H ��H ��H � ( �H � ( ��H K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J
�j m�j o�j y�j }�j �j �j �j �j �j ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� i �\
�h �` �h �\ �� �� " " #�� $�\ &�� *�� -�8 2�� 4�� D�� F�` G�` H�` J�T P�� Q�� R�` S�� T�` U�� V�� X�� Y�� Z�� [�| \�� l m�` o�` r t 2 u 2 w�� y�` { 2 | }�` ��\ ��\ ��\ ��\ ��\ ��\ ��\ ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��` ��` ��` ��` ��` ��` ��� ��` ��` ��` ��` ��` ��` ��� ��� ��� ��� �\ �� �� �` �` �� �� �` �` �` � � �h � � �h �` �` �` � ��\ ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ���
�j m�j o�j y�j }�j �j �j �j �j �j ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� �t
�t
�t �� 9�^ :�� <�h ?�^ Y�� \�� l�t m�� o�� r�t t�| u�| y�� {�| |�t }�� ��h �h � � �t �t �t �t � � � ��t ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� i �\
�h �` �h �\ �� �� " " #�� $�\ &�� *�� -�8 2�� 4�� D�� F�` G�` H�` J�T P�� Q�� R�` S�� T�` U�� V�� X�� Y�� Z�� [�| \�� l m�` o�` r t 2 u 2 w�� y�` { 2 | }�` ��\ ��\ ��\ ��\ ��\ ��\ ��\ ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��` ��` ��` ��` ��` ��` ��� ��` ��` ��` ��` ��` ��` ��� ��� ��� ��� �\ �� �� �` �` �� �� �` �` �` � � �h � � �h �` �` �` � ��\ 0 �� " " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � 0 �� " " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � 0 �� " " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J - �
�
� �x #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�h ?�L Y�| Z�� \�| l� m�x o�x r� y�x |� }�x ��� ��� ��� ��� ��� ��� ��� ��h �� �� �h �x �x � � � � �x �x �x �� K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J - �
�
� �x #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�h ?�L Y�| Z�� \�| l� m�x o�x r� y�x |� }�x ��� ��� ��� ��� ��� ��� ��� ��h �� �� �h �x �x � � � � �x �x �x �� ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� ' �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� K �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J 6 �J
�J
�J �� "�� #�� &�� *�� - 2 2�� 4�� 7�| 8�� 9�x :�� <�\ ?�x Y�� \�� l�J m�� o�� r�J t�H u�H y�� {�H |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��\ �� �� �\ �� �� �J �J �J �J �� �� �� ��J v
# $ & ' ) - . / 2 3 4 5 7 8 9 : ; < = > ? D E H I K N P Q R S U Y Z [ \ ^ l m o p r t u y { | } � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �
8 � DFLT latn �� �� case &case ,liga 2liga 8sups >sups D , > B
@ L O , { t u C j q v � � � � � � � I � x x � x�� �P `K tyPL @ �J�z��� � �� � &
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � r d e i � x � p k � v j � � � s g w � � � � � l | � � � � c n � � � m } � b � � � � � � � � � � � � � � � � � � � y � � � � � � � � � � � � � � � � � � � � � q � � � z � � � ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ - �� % 5 9 = J@G B h f [ [ Q C Q
D=<($#* $
+>32 #'&>54&#"#"'4632 #"&!!7!!�9DO.?gI) -60#z -70 I9)8( c>0( (0>���22c��u& #@[87P;+&%iu"3+(.:(3<��/@ )( ?��g6, ����
! &@# Q C S D
+#.54>32 #".� y +!..""..!���-VW[44[WV-<��."".-""- ����
,@) B Q D
$+#"&/!#"&/3 � ��ޛ ## �"�ޛ ## �" 6 Q� > B H@E
Y C Q
C
D BA@? > >86530/*(##!#!+#"&5467#+#"&546?3#7>;>;3323+32%3#TQ G�G- OU��A�
$'�H+ PT�TO!I�
%&�A� ���A���Y"Z��% � 9FJ f "�Z� ��K �� 9�F j�$g 8 C N ~@ J( I>)
? 4 BK� PX@$ h f S C S D@$ h f S C S DY�# &# &+.'7>32 .54>?>; #".' +4.'> �y�H50FaD%F�kA9m�h
Bi�<+):L1!H�pE<s�k B�%@V1"AeE#��"<P/ A_= aKR &1.5U�aI�lE� �
R:B !!� 4R{\Z�xK� �2H4&�-F]�0G6(�(<K H���� ' 1 E Y �K� PX@' [ [ SC S
DK�"PX@+ [ [ SC
C S D@/ [ [ C S C
C S DYY@
VT((%#&((($
+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>�4Wt?DsV00VsDCuU1� 1A%%A00A%%A1 �
���
�54Ws?DsV00VsDCtV0� 1A%%A00A%%A1 ?T�[00[�TV�\00\�VB\;;\BA[99[w��
RT�[00[�TV�\00\�VB]::]BAZ99Z R��x� ? K �@8IH+%BK� PX@* h S C S
C S
D@( h S C S
C S DY@ FD/-(&" ??+2 #"&'.#" >7>;#"&/#".54>7.54> 3267�O�_7o
1E.2P9 "6&�&-nFB,� $�^��P�yJ/SrD=:5d���0Nd4p�D�Yjk�3To<8. 9M-#@AE&�]C�Js�a���[j6g�]F}jT M�NI�_7��AcD#RD�9� ��3�
@ B Q D
$+#"&/3 ��ޛ ## �" ��� �
(+ .54>7 !nh OKiA AiKO
imu�m� 0s���zy���t1��l J��� � (+4'&546? '.54676*mi
OKiA AiKO hnu���1t���yz���s0 �� `_�� 0 J@-)($ BK�PX@ Q D@ M Q EY@
0 0+5467'767./7.=3>? '.' b!�,�$%#�,�# X �,�!!�,� _�"cKd eKd %��) cKd eKd !'� d �"� ,@) M YQ E +!!#!5!���i��k���U��R��� ^��P � @? S
D$+74>32 '&547>7#".^ , / 0G-
* {) '3 -a_Z&
%0:!!- d R� @ M Q E+!!d��� X��Q � @ S D($+74>32 #".X!..""..!n."".-""- ���� @ k D#"++>;�7 KY
0!K#"� " <��L� ' @ S C S D((($+#".54>32 4.#" 32>LQ��mn��PP��nm��Q�7]zBBz\77\zBBz]7̼��XX����XX��켤߈;;�ߤ�ވ;;�� � � *@' B h C R
D&+%!47#"&/3!! 4�
8��� ��,-�
Mq�� h $� 3 ;@8/ B h S C Q
D ,*$"
33+2 >3!2 !5467>54.#"#"&/>Y[�sB0Rk<��(R&� "�D�9^C$(F^66\G1
]P{��6g�^P�}u=�~
"l=(�:klo??_> 9N/ b�f5 l��.� J U@RF
B h h [ S C S D CA;910/.&$ JJ +2 #".'7632 32>54.#5>54.#"#"&/>l[�o>#A\9��K��cr�pHL (DeKKqK& Q�p[�R%'D]66\G0 ]P{��4`�SDkQ8%��c�o;9d�P I@,1N`/:`F(�&B\8>\< 9O. b�f5 ( `� &@# B [ C
D!#+3+#!"&/3467!������ �����f��y[���< �; l���� . @@=,+B h [ Q C S D(#&(""+#!632 #".'7632 32>54.#"'!�09�>Bp_p�t;P��m?tdV!6 3HaCKxU.'OvO6t>pt�K&1��Bt�]r��F*6 L & 0Y|MClL*!� l��2� . 2@/ B [ C S D +)! +2 #".5467>;> 32>54.#"�V�tDH��ml�|CT[k2 ��3|��(MoGHtS-,PpCHtQ+n9m�fc�~HE�p^�z���#'�LErR-.RpBFqO*1Sm n <� @ Q C
D $'++>7!"&=<��
.'Z
��P",�S%�*y `��&� 3 G D@AB [ S C S D54! ?=4G5G+) 3!3 +".5467.54>32 '2>54.#" 2>54.#" Ck��F��qs>r�ba�r>tp��G�kFoM)1Sl;;lS1)MoFFc> !Aa@@aA! >c9j�^��&*�tO�f::f�Ot�*&��^�j9�'Gc<JiB BiJ<cG'�+G\12XB&&BX21\G+ � 6� 3 2@/ B [ S C
D 0.&$ +".54>32 +>74.#" 32>%Q�nAF~�hg�xA,='��
0 ��&7�+Li?BmM*'IiAHoL(L6i�c^�zFDz�g>oji8�; 4,.�CmL)+Lj?DkJ&/Nf ���y� ' ;K�$PX@ S C S D@ [ S DY�((($+74>32 #".4>32 #".�!..""..!!..""..!n."".-""- ."".-""- ���y� 2 D�?K�$PX@ S C S
D@ [ S
DY@ /-%#$+74>32 '&547>7#".4>32 #".� , / 0G-
* !..""..!{) '3 -a_Z&
%0:!!-�."".-""- � ��W �(+ ��?--�����
�
�
�� ���� !@ Y M Q E+!!!!�[��[��>�և � ��W � (+75467%>7.'%.=��++�?�
�
�
�oJ "���� ( < 9@6 B h f S C S D(&#- $+>32 #'54>54.#"#"'4>32 #"." KYg<O�b8-ERG3z -EOE-":O-=W<% �!..""..! 4(.TxKLnS=66!�� *A99EX<+F1 $ ��."".-""- V� O Q a f@c
X
7B h [
[ [ O S GSR [YRaSaGE;9530.&$ QQ
+%"&'#".54>32 32>54.#" 3267632 #"$&54>32 %2>7&#"�Nb
:�N<X; A��}Ce-] )1XC'Y��z��dk�����U
k�ﭭ���}7d���l\���_5=k�� ?;1L'.K}Z3B�KNQF)Id:U��X��K1$/
8f�W�ЋEf�������XB3 BHRn�,�mʯ�g9(Ns��kl��Lx2VA' ?f�EHW
I�
$@!B Z C
D# +!#"&'!+3!&'I� ��}�"�=���
Z�� ��{G6Q)E � �� * =@: B [ S C S
D *(" !+3!2 #!2>54&#%!2>54&#!�Ʉ�{;!CeD��C��x��6SwM$���� RxO&�����4`�W5bTB ��[�l;��
&E_9o��$@[6~v Z�� � . D@A B h f S C S D )' ..+2 #".546$32#".#" 32>76�
LX�����bi� ���Y?
(6Jb@s��MM��i@fWK&(
Sfrk����kbTY
O�҂�ґL 1" � �� @ S C S
D!(!$+#!!24.#!!2>�f��������f�H��s��Us��H̡���g�g�����АL��L�� � !� .@+ Y Q C Q
D +!!!!!!�P-��������$���� � !� (@% Y Q C
D +!!!#!�PL������ ���� Z��@� 4 K@H!
B h [ S C S D ,*%# 44+%2>7#"&=!#"$&546$32 #"'.#" -:aVL&��6u��Y����ig��U�}j.7>YySyĊJM��� <n��':'k����j/C*X (%O�т�ՔN � 8� @ Y C
D+!#!#3!38�������t��� � �� @ C
D+!#3���� <���� QK�PX� B� BYK�PX@ C S D@ h C S DY�!&$+#"'>7>3232>53�;s�mai<2BgG%��x��F 9 (T�Z� � :� " &@#
B [ C
D)(% +3267>; #".'.+#3�I&-�) ���% *:�� !X��% ��
$�Y
9 �p� � �� @ C R
D+%!!3pl��£�� � �� # %@" B h C
D!6)+ >7>;#467+"' #32o
�
���- -�
��
�5 3q
�g 0��--�2���
�� � 8� @ C
D!+2.53#"&' #3>�b ���d�
��1��g70�� \���� ' @ S C S D((($+#"$&546$324.#" 32>�f��������ff����f�H��ts��HH��st��H̡���kk�
��
�ll��ґNN�҄�ёMM�� � � *@' [ S C
D
!+#!2 #'32>54&+����ɄAF�ȁ��SV,������?t�ed�xC�,OnB�� \��$� 0 s� BK� PX@ k S C S DK�PX@ S C S C D@ k S C S DYY�(((%&+#"&'#"$&546$324.#" 32>�)NpFp�$8�9{C����ff����f�H��ts��HH��st��H�e���/�sk�
��
�ll��ґNN�҄�ёMM�� � �� # 2@/B [ S C
D #! ,!+#!2 #"'.#'32>54&+����Ɓ>0[�S$ ��5��((��U�W,���V���7h�[L�iJ(��) �)Kh?�� :���� = =@:= B h f S C S D;9(&#! #"+#".#" #"&'7>32 32>54.54>32� -EaEAdC";a{�{a;@{�r��Q86QsSElK(;`{�{`;;p�kx�J�")"#<Q/<O8),7TzY^�zFeV\ -6-&E`;AS8')6V�_L�nBLH ~� @ Q C
D +!#!5~�1�/���
�� ���� #@ C S D +%2>53#".53 �Y�a3�O�Ԅ�ԔO�3a��<l�Zg��|ԛXX��|g��Z�l= G� @ B C
D, +32 >7>;#� � �"������
"P++P"� �g �� ( @ # B C
D+< +32 >7>;2>7>;#&'#�"(
Q#8!O
)#��A��� ����� >""?� � 4C!<� �gE )%�� �� @ B C
D("(!+ 3267>; #"&'+��'�va ��%��� �� ���
�� �P�Y�� �� @ B C
D,"+#32 >7>;��� H G �:��:_��#> >"- V ��
$@! Q C Q
D
+!!547!5���2��,���H" ���L v� �����
'@$ [ O QE
!#+!+32 �p���� F��F ���� @ k D# +32#"&'L!0
YK 8
�" �'"# Z����
!@ [ O Q E!"+46;#"&=!!Z��p��� 3F�� ��� @
B k D+!+3#"&'.'+sf��
����z`+,+�� ���[ @ M Q E +!5��xx &��� @ k D +2 #"&'�! �f���
\��z ) 9 }@ !/BK� PX@' h [ S C S
D@+ h [ S C
CS DY@+*10*9+9%##' +!#"&/#".54>754&#"#"&/>32 2>75 zO (LT_:;gL-B��ecAYA/ T�vU�Z.�2/NE? {�l1,<^$9'!BeE<oV7Ovy!)!9QP8d�U��#2 � 2D*(:% ���� % �@ BK� PX@ CS C SDK�"PX@ CS C SD@! CS C
C S DYY@ %% (#+33>32 #"&'#" 32654.��?�iX�d6<q�fb�3 &QW�70uH��#B`���IYB��~p��QLD\&wPI�B6ʻc�[* J�� * i@
*BK� PX@$ h f S C S D@$ h f S C S DY�($#(#"+#".#" 32>32 #".54>32E#6M8JrM'*LmDAT8$ 2B�n_�xE?y�sj�?A 5d�X\�a3 & AQKF��|q��NE? H���� % p@ BK�"PX@ C S C S
D@! C S C
CS DY@ %% +!"/#".54>323%267.#" [&
A�lW�d6<q�g]�4��=W�71uG��"B`%{O_C��~p��Q?92�?�PI�B5ʻc�[* J��� $ - {�BK� PX@' h [ S C S D@' h [ S C S DY@&% )(%-&-
$$ +2 #! 32>32 #".54>"!4.#[�p?�^0TtHCaF/ 2!\ip7i��HAz�r��'"B_=s�l* `�_/ $ A(;&G�ʃj��M���>gK) �� ]@
BK�2PX@ S C Q C
D@ Y S C
DY@
4%+3'.=354>32+" !!�p�1[�PD: .K6 %��]
IbW�]0Y6XA]��� 2��� 9 M ] �@2A*BK�PX@,
[ [ C S C S D@/ h
[ [ S C S DY@ ON WUN]O]JH@>#! 99 +2!#"' #".5467.54>7.54>4.' 32>2>54&#" �Bs/*s"9e�SG? !:`zz`:Az�oo�n7_S+3!0 KU9f��*H^hl19G#HmJHrO*��6S8 qlkq 8R B! APJyV..$% 2XFAz_9,Ja5Ki C8/.**�]JyU.��&. N6";+0BN 6K-]nn]-K6 � �� -@*B C S C
D ##+33>32 #4&#"��A�gSU,�ilO�:���ES7e�V�{�sLA� � �� GK� PX@ S CC
D@ S CC
DY@
+##".54>32 X��#.-##-.#�� �>-##-/##/ ����� ( Y� BK� PX@ S CC S D@ S CC S DY@ %# U%+#"&'7>323265#".54>32 X EmL!6
NB�#.-##-.#���=iN-
`
IQ@>-##-/##/ � �� 0@- B [C C
D %(%!+3267>; #"&'.+#K.@ ���
�� �� 2���� W�s
� �
� � � X� @C
D +#X���?� � � * V�) BK� PX@ S C
D@ CSC
DY@ * *##&$! +332 >32>32 #4&#"#4&#"�j&
8�\g EVa2P}W.�hc,O<#�b^Bq/�%hEXra7P43b�\�{�w{ <[<�{�zxG=�
� � L�BK� PX@ S C
D@ C S C
DY@ #$!+332 >32 #4&#"�j&
B�kSU,�ilO�:�%nIZ7e�V�{�sLA� H�� # NK� PX@ S CS D@ S CS DY@ ## +2 #".54>2654&#" ,o�}CC}�oo�~DD~�o����LpK%%KpJ��wx��II��xw��J�xɴ��4b�ZZ�a4 ��� % �@ BK� PX@ S C S CDK�PX@ S C S CD@! CS C S CDYY@ %% ($!+32 >32 #"&'" 32654.�j&
A�mW�d6<p�f^�3W�71uH��#B`��L%xO`C��~p��Q>9�@�PI�B6ʻc�[* H��� % �K�PX@ B@ BYK� PX@ SCS C DK�PX@ SCS C D@!C S CS C DYY@ %% (#+##".54>32763267.#" Ų@�iW�d6<q�gb�6
&��W�70vG��"B`����JZC��~p��QF@O%��PI�@7ʻc�[* � � lK�PX@ B@ BYK�PX@ S C
D@ h C S C
DY@ !$%!+332 >32#"&#"�f 4�g*D :4]}*��jw�lg�{ >�� < =@:< B h f S C S D:8'%" #!+#".#" #"&'7>32 32>54.54>32� &7L4-H3-J^c^J-2b�]j�<*(9Q=4N4-J_c_J-0\�Vd�:N(5 '4& !(<W=FwW2E6D
" .<"*7' )>[A:kQ0?7 ,���> ! t@
BK�2PX@$ j hQ C T D@" j h [ T DY@
!!+"&5#"&=7>;!!32>32 �x�z�)Z"��>1 ) 4.��~lG9�����@>U+1 z���� L� BK� PX@C S
D@C
C S DY@ $!#+32673#"/#".5,jkN�:�j&
B�jSV+��zs~JB� %mIY7d�V� �� @ B C
D, +32 >7>;#� ��c���t$H##H$�� �� . @ ' B C
D*!,< +32 >7>;2 >7>;#"'.'+� � �M� � ����
�
� ���t$C""C$��p#D!!H �� "�/0�R" �� @ B C
D("(!+ 3267>; #"&'+���� �
���c���
��
�� @� ��� �� ���� @ BC D,""++32 >7>;� ���^�
�������,,} F U� @ Q C Q
D+!!5467!5!U ��)�
'����#�&�J
#ߌ ,�� � @ 3@0$ B [ [ O S G86303++4춮.54>;+" ;2 #".54>�FCCF)S{R5 MY)7!!7)YM 5R{S)�?QkP@2bbd4EtT.OeV8hcb2&A3% %4@%2bch8WdP/TtE4ccb �p� @ Q D+3#把��� X��,� @ 5@2 B [ [ O S G?>=<1/,)3)+ +546;2654.54>7.54>54&+"&=32 3"�*R{R5 MY)7!!7)YM 5R{R*FCCF�2bcc4EtT/PdW8hcb2%@4% %3A&2bch8VeO.TtE4dbb2@PkQ t� 9@6 j k O [ S G
+2673#".#"#4>32 �AI�%Ef@4f_V$AI�%EeA4f_VeUFCpP, '!TGCpP-!'! ���
! &@# S C QD
+4>73 4>32 #". y �"--""--"�� -UW\44\WU-���-""-."". ��� . 7 �@ 3 2&* BK� PX@) j h f T C S DK� PX@) j h f T C S D@) j h f T C S DYY@ ##'#+.54>?>; #".'>32 +1\�q?B~�w BR�6. !-?*4?U;& 0<�k B�y4LsN'
O��ro��Q� � ?1> � " ?HJ� ��9c� 4 [� > @@=7+B h [ S C S
D%&#&'%" +46;4>32 #"&'.#"!#!>3!#!5>5#4 �6n�nNy^EH
)3B-?`@ � �{92 9 � �<">0 ��$^�{G'DZ4. /#*NnD��H �Km-Ls
"3E.! � �` # 7 ?@< ! B
@ ? W S D42*( (+467'7>327 '#"&''7.7 32>54.#"�! �[�,h:9f+�Y� "! �[�,h99e,�Y� "�#>Q//S=$$=S//Q>#�9e,�Z� "! �[�,g:9f+�\� "! �[�,g:.Q=$$=Q./R>##>R , S� " 8@5
B
Z Y C
D"! ,! +!32 >7>;!!!!#!5!5!�2�h�
!��g3��T�����T��q(��#: ;"6 ��fig��;gi �p� @ Y Q D+3#3#把������� r���� H Z A@>HXN= #B h f W S DFD-+(&! #!+#".#" #"&'7>32 32>54.5467.54>32 >54.'1 &7L40M5 1OfifO1NT1>2a�\j�<)(:U?2O6 2RhnhR2V]2?0\�Vd�:��Fm�>60 4FOT(B6�*8 &9/+.7G\=Q&%bEFwW2E6D
# ->&-B3*,3F]@N}#&iK:kP0>7��3G95 K/$8.&## I �V{ ' 3K� PX@
S D@ O S GY�((($+#".54>32 #".54>32 � )( () g )) )) ( (* *( (* * D���� . J b �@
BK� PX@4 h f [ [ S C S D@4 h f [ [ S C S DY@
_],,*(#%(%"
+>32 #".54>32#".#" 32>4>32 #".7 32>54.#" =9�tb�s?Ez�bl�9. 2L;FqO++Lj>0B0%�R4_���ee���_44_���ee���_4d,Rr��X��c-Rs��X��b�@BIDz�de�yCD7A -TxKMyR+ e���`44`���ed���`44`���eY��tS-d��Y��vS.e�� \?T� ) 5 E@B!- B h [ W S D+*/.*5+5%##' +#"&/#".54>754&#"#"&/>32 2675T< .28"&A0&X�k:9&2% 4yI6T: ��3J$Fa<4H 1 )<)"C5#%?<
*1."<T3��&#i#*" � �� ) �)(+5 5 ��:
�
� :/�:
�
� :�
��
��
��
��
��
�;�� =K� PX@ _ M Q E@ k M Q EY�+!#!�\��;�X! d R� @ M Q E+!!d��� D���� 3 I V ��>BK� PX@/h [
[ S C S D@/h [
[ S C S DY@44VTLJ4I4H)!*,,& +4>32 #".7 32>54.#"#!2 #"'.#'32>54.+D4_���ee���_44_���ee���_4d,Rr��X��c-Rs��X��b� ��kj �!� Pt7M/+F4��e���`44`���ed���`44`���eY��tS-d��Y��vS.e���|}z^�
��.
r(:&%8$ �RD @ M Q E+!!>��Du F'�� ' @ W S D((($+4>32 #".7 32>54.#"F2XwEEwX22XwEEwX2 6I**H6 6H**I6 hCvW22WvCBuW33WuA*I6 6I**J7 7J d P"� 7@4 Y Y M Q E
+!!#!5!!!���i��k��k��B������p�x�%� R�Qe - 9@6+ B h [ S D (&"
--+2 >;2 !546?>54&#"#"&/>Z4U<!*6 �/��
�, <-.9 G�e 6M/(E>: �M+
�455370* jj T|Re = S@P9B h h [ [ S D 640.*)(' == +2 #".'7632 32>54.#5>54&#"#"&/>b3R; wBE*E[09T=+7 + / 'A/WG:009 C,ATe 3D(�-N>7T9 1H/
( + W<424/( 5O5 ��U� @ kD #++7>3U�j�! ���
� z���� 3@0 BC S
C D &$!#+32673#"/#"&' #"&5,liN�:�j&
C�WJp'Y&)��nmxJB� %mHD3.*W&��($ *�7� *@' hi S D +##!#".54>3��h�u??u�h���7�7]=i�QV�e8 |��� @ O S G($+4>32 #".|)6 8((8 6)Q 8((8 6))6 ����
�K�PX@
B@
BYK� PX@ ^ T DK�PX@ j T D@ j j T DYY@ +2 32654.'73 #"&'76� *+)<&+pZQ 9P0)J � ! �PE6 3$7 x�D_ O� BK�$PX@ j j Q D@ j j M R FY�$+37#"/733!��k '�l��i��+X 8��zU H<�� )@& W S D +2 #".54>2654&#"~FqP,,PqFGrQ,,QrGTSSTWSS�+PsGHtQ++QtHGsP+��iddhhddi � �
� % �% (+7'&54767&'&54?%'&54767&'&54?�:
�
�
:�(�:
�
�
:�
�{�{
f |� & 0 O@L$ B h Z
[ C S
D0.+)&% $!#
+3+#5!"&/3%37#"/733!4673+>;m
Rm��
V|���k '�l��i��, L2. M A �� 9�;�+X 8��zU�,��� \ f ]� - = G e@b710+ B h h Z [ C S
D GEB@=<;:9853/.(&"
--
+2 >;2 !546?>54&#"#"&/>%37#"/733!+>;f4U<!*6 �/��
�, <-.9 G����k '�l��i�, L2. M� 6M/(E>: �M+
�455370* jj3�+X 8��zU�v \ D }� N T ^ x@uJ
%R B
h h
[ [
\ S C S
D^\YWTSGEA?;:980.)'! NN!#+3+#5!"&/32 #".'7632 32>54.#5>54&#"#"&/>4673+>;m
Rm��
V|�B3R; wBE*E[09T=+7 + / 'A/WG:009 C,AT���, L2. M A �� 9�� 3D(�-N>7T9 1H/
( + W<424/( 5O5�\,��� \ ,�� ) = 9@6 B h f S C T D('#- $+#".54>?3 32>324>32 #". KXh<O�b8-ERG3z -EOE-":O-=W<& �q!..""..!� 4(,RvKLjL601!�� ,>2/<P;,E1 $ ."".-""- ��
I�& $ k ��
I�& $ k ��
I�& $
v ��
I�& $ v ��
I�& $
v ��
I-& $ s �� �� :@7 B Y Y Q C S
D# +!!!!!!!+!���</��=a��1�Գ %���^ ���$�������)E Z�� � K2K�PX@:>
I B@:>
IBYK� PX@0 h f S C S C S DK�
PX@0 h f S C S C S DK�PX@0 h f S C S C S D@7 h f h S C S C S DYYY@ GE=<861/'% KK
+2 32654.'7.546$32#".#" 32>7632 #"&'76� *+)<&$��Vi� ���Y?
(6Jb@s��MM��i@fWK&
LS�ZQ 9P0)J � ! v u� ���kbTY
O�҂�ґL 1"
Sap7E6 3$7 �� � !�& ( 7 �� � !�& ( 7 �� � !�& (
B �� � !�& (
B ���� ��& , � �� � ��& , � ���� {�& ,
���� x�& ,
2 �� ! ,@) Y S C S
D!%(!+3!2#!#%4.#!!!!2>2���ff��������H��t��}��Ut��H �g��������g�2�АL�r�L��� � 8�& 1 � �� \����& 2 � �� \����& 2 � �� \����& 2
� �� \����& 2 � �� \����& 2
� ~ �X � (+ ' 7 ���b_����_d��_YX�����`b��`dY`��X \���� ! - 8 h@21&% BK� PX@ k C S C S D@ j k S C S DY�)*%(%$+#"&'+&546$327>;.#"4&'32>�f����l�Od: N�p{f��s�SR d�gp�AKE�<�Ws��H�A<�qt�t��H̡���k10� b ��
�l:6o�b��I�*+N�҄~�H��FM�� �� ����& 8 � �� ����& 8 � �� ����& 8
� �� ����& 8
� �� ��& < 9 � � .@+ [ [ C
D !+#332 #'32>54&+����ɄAF�ȁ��SV,��������?t�ed�xC�,OnB�� ���v� H wK� PX�B�BYK� PX@ h S C SD@# h S C
C S DY@ CB=;%# HH+2 #"&'7>32 32>54.54>54.#"#4>�g�b/+@K@+5P]P59d�Oa�<)(7K5,F18TbT8-CNC-8Y?DoO+�E���<]n3<VB203 '4-/FfNNzU-E6D
" .@%8F3*:SB5O?6<G0 A4!*T~T�&�h�zB �� \��z�& D C � �� \��z�& D v � �� \��z�& D � � �� \��z�& D � � �� \��z{& D j � �� \��z�& D � � \�� C Q \ �@ A; BK� PX@5 h h
[ S C SDK� PX@5 h h
[ S C SD@? h h
[ S C SC SDYY@&SR XWR\S\MKED?=8631.-%#
CC+2 #! 32>32 #"&'#".54>754&#"#"&/>32>32>5"!4.�R�g;��.MiAE\=&/!Wcj4u�7Wjw;ErS-B��ecAYA/ T�qx�!6���{�l1dQ9cI*�=`E)� <W@z�p) [�Z, $ =(;&qt>X8#FjH<t\;2v~#*#9QPf[Xg��#8H*WP$JnJ�)NpFAoP- J�� H �K�PX@7;
F B@7;
FBYK�PX@- h f f S C T D@3 h f f f S C T DY@ DB42/-%# HH +2 32654.'7.54>32#".#" 32>32 #"&'76� *+)<&%S�f:?y�sj�?/#6M8JrM'*LmDAT8$ 2;�aZQ 9P0)J � ! y O��qq��NE?@ 5d�X\�a3 & AHJ:E6 3$7�� J����& H C � �� J����& H v � �� J����& H � � �� J���{& H j � ���� ��& � C� �� � (�& � v� ���� 6�& � �� ���� ){& � j� L��� 4 H 6@3:0B43@ [ S D65@>5H6H.,$"+.54?.'.54? 7 #".54>32.'2>7.#" �g-e9`�Q�#a<cF'>{�xb�}H>t�hd�Au^�_GsQ.4Kc>KqL'.Pi)
H"><0z9
C1|��n��VB{�p^�~JVW��@���6m�o+Q?%2WwDQV- �� � ��& Q � �� H���& R C � �� H���& R v � �� H���& R � � �� H���& R � � �� H��{& R j � d �"� + +@( [ Y O S G(((%+!!4>32 #".4>32 #".d��Bb!--""--!!--""--!��."".-""-�S."".-""- @��-I ! + 5 t@ 43%$ BAK� PX@ j k S C S D@ j k S C S DY@
-,,5-5%%(%'+ #"&'+7.54>327>;&#"2>54'�=BC}�oL�67; C�BFD~�oO�8D Z��;�IoLtO(7KsO(4�OFtD�vx��I" J �E�|w��J&#[���aN86d��$5d�Z�`��0�� z����& X C � �� z����& X v � �� z����& X � � �� z���{& X j � �� ����& \ v � ���� # q@ BK� PX@! CS C S CD@! CS C S CDY@ ## (#+3>32 #"&'" 32654.��?�iW�d6<p�f_�3W�71uH��#B`����JYB��~p��QE?�3�PI�B6ʻc�[* �� ���{& \ j �
���� ' / �K�PX@
, B@
,BYK�PX@! Z C
C S D@( h Z C
C S DY@ )($"
''
+2 #"&5467"&'!+3#32>!&'d ]3XeO< ��}�"�=�=%*"1*
�?�
�B OB:e&Z�� ��g '/&+ �G6Q)E \��� C S �@;I BK�PX@1 h [ S C
S C S D@8 h h [ S C
S C S DY@EDKJDSES%##.%#' +!32>32 #"&54>7&/#".54>754&#"#"&/>32 2>75 z*"1*
]3Xe'5
(LT_:;gL-B��ecAYA/ T�vU�Z.�2/NE? {�l1,< '/&+ B OB 83- ^$9'!BeE<oV7Ovy!)!9QP8d�U��#2 � 2D*(:%�� Z�� �& & � �� J���& F v � ���4� & �K�PX� B� BYK�PX@* Y Q C Q
C
S D@1
h Y Q C Q
C S DY@ #!
&& +2 #"&5467!!!!!!#32> ]3XeO<�Zs�P-���[*"1*
�B OB:e&���$��� '/&+ J��� < E �K�PX@
- B@
-BYK�PX@2 h [ S C S C
S D@9 h
h [ S C S C S DY@ >= A@=E>E97+)&$
<< +2 #"&5467.54>32 #! 32>32 32>"!4.� ]3XeB4g�~FAz�n[�p?�^0TtHCaF/ 22�R'!1*
���'"B_�B OB5]%H�ȁj��M=s�l* `�_/ $ A<G &.&+ U��>gK) � X� @C
D +#X��� � , � #@
B C R
D+%!!54?3����l�һ��%ā ��"�*_�
V� 6 K� #@
BC
D +7#54?�� �������MfC��Li D �� � 8�& 1 � �� � ��& Q v \��'� 02@
BK� PX@" Y S
C S
DK�"PX@, Y S C Q
C S
DK�,PX@6 Y S C Q
C Q
C S DK�0PX@4 Y S C Q
C Q
C S D@2 Y S C Q
C Q
C S DYYYY@ -+#! (# +!!!!!5#".54>3254.#" 32>'�P-�����T����\\�ꎡ�T@w�hh�xAAx�hh�w@���$����x�k�
��
�l�y�3�ӔOO�ӄ�ӓNN�� H��u 0 @ K �@ .
BK� PX@, h
[
S C SD@, h
[
S C SDY@$BA21 GFAKBK:81@2@,*"
00+2 #! 32>32 #"&'#".54>32>2654.#""!4.�R�g;��.MiA=Y@- 3!Wcj4w�76��d�u@@w�f��52�����"DhEGhE"�e=`E*� <W@z�p) [�Z, $ A(;&swpzI��xw��Jyni~�xɴZ�b44b�Z��)NpFAoP- �� :���� & 6 �� >���& V v � �� :����& 6 �� >���& V � � �� ��& <
D �� V ��& = N �� F U�& ] v � �� V �& = X �� F U�& ] � � �� V ��& = X �� F U�& ] � � j���� # 6@3
BY S C T D # ##"+#5432>7'.=37>3#"!�Y��<-Q?,Y���� .Q@- B �&^9:\D�I�ƿb :]D�� �d�
@ B k D' +#"/+3dw�� {ߦ�~~ �d� @ B k D+ +32 >?>;#{ � � wߦ�
}
} �� �� �RD q �D� @ W D
+".53 32>532MhA ~"9++9"~ Ai�+Ib7!9((9!7bI+ ���� @ S D($+#".54>32 �#.-""-.#:-""-/##/ jk�� =K� PX@ W S D@ [ O S GY�$&($+4>32 #".732654&#"j 7H()I8 8I)(H7 d6/-77-/6#*D22D*)D00D),88,-88 ����
YK�PX@ B @@ B @YK�PX@
S D@ j S DY@ +2 #"&54>732>� ]3Xe+;"\*"1*
�B OB ;6/
'/&+ �Y� QK�.PX@ W S D@ O [ S GY@
+2673#".#"#4>32 �$'l/A(#=60Ho0B'#=6/-*,/O8 " X0O9 " ^��� #@ S D
#++7>3!+7>3�� J�
!!��V� !��� ���
� 0���� ! Y�BK�(PX@ SC S
D@ SC
C S DY@ ! 6##++#!#"&'7>3265#54>3� ���sy�"B B9� �H$��r��w� K >B|@
�
�� @ M Q E+!!� ���� �
�� @ M Q E+!!�2���� :�'� � (+.5467 r YP7
�0a0Z�E"
,16 D&
Z�F� � (+ '.547>54&'&547 YO7
�0`0[�E"
-16 D& Z��F � � (+% '.547>54&'&547 YO7
�0`0[�E"
-16 D& :�W� 1 � (+.5467 .5467 r YP7
� YP7
�0a0Z�E"
,16 D&
,0a0Z�E"
,16 D&
Z�v� 1 � (+ '.547>54&'&547% '.547>54&'&547 YO7
� YO7
�0`0[�E"
-16 D& ,0`0[�E"
-16 D& Z��v � 1 � (+% '.547>54&'&547% '.547>54&'&547 YO7
� YO7
�0`0[�E"
-16 D& ,0`0[�E"
-16 D& v��� 3@0
B C S C D#$&"+4632 632>72 !#"'!v)+"LPP'(57&N�E,(�x&75(�w� 0
��0 <�`�� � v��� / G@D
% $ B[ C S C D/.$$#$&"
+4632 632>72 !!#.'#"'"&=!!v)+"LPP'(57&N�E,(�x�(,E�N&75(N�E+)��w� 0
��0 <��< 0��0 <X � ��� ,K�PX@ S D@ O S GY�($+4>32 #".�;d�LM�e;;e�ML�d;SM�e;;e�MM�d;;d� X��V � ' ; @ SD((((($+74>32 #".%4>32 #".%4>32 #".X!..""..!!..""..!��!..""..!n."".-""-."".-""-."".-""- H���� ' 1 E Y m � �K� PX@+ [ [ SC
S
DK�"PX@/ [ [ SC
C
S
D@3 [ [ C S C
C
S
DYY@~|trjh`^VT((%#&((($+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>%#".54>32 4.#" 32>�4Wt?DsV00VsDCuU1� 1A%%A00A%%A1 � ���
�54Ws?DsV00VsDCtV0� 1A%%A00A%%A1 h4Wt?DsV00VsDCuU1� 1A%%A00A%%A1 ?T�[00[�TV�\00\�VB\;;\BA[99[}
��
RT�[00[�TV�\00\�VB]::]BAZ99ZAT�[00[�TV�\00\�VB]::]BAZ99Z � ��� �(+5 ��:
�
� :�
��
��
� ��� �(+'&54767&'&54?�:
�
�
: �{
�D #� @ C
D#"+'+>;, L2. M5 \ "��r� G [@X 5 B h h
[ [ S C
S
DGF@?>=9720"###%$+3>32#".#"!#! !#! 32>32 #".'#53&45467#"�_��l��F=%>aK�� #�� �j ��6R<+ KFЏt��W����~ˏLdXD
&.&�7 ( 8 �� % FfqO�Ӄf ) @I)� & C@@B h S C S D & &!4)
+ >7>;#7+"'#32'###5� � jn �
�nj �~�U/
��mK�� MH��P
i��i V ~� 7 1@.1 B S CS
D 7 6***+!>54.#" !"&=!5.54>32 !#DQ�c7E{�dd�{E7b�Q� $�`�l;c���c;m�`�$ �Ag�]k�m88m�k]�gA�J# d�`��e�֚VV�րe��`�d # \��2� * > C@@ 0 B h [ S CS D,+64+>,>#'(($+>32 #".54>32>54&#"#"&'2>7.#" \'INV3Z�h9I�ݔV�h:L��ph�0�|*G8*
xBw`G
&>W:T�X- <U9* J�ʀ���9k�_sʔVYV%C�� ��7p�s,S@&>m�WAfF% b� @ B C R
D+3!%!.'`�S��M�� ��g��:""; >��� $@! Q CD +##!##5��� ������W��W� T��� &@#B Q C Q D+!!!!5467 .5T��e=����Q
u�� ���;4�;�A �
�\�� @ M Q E+!!�\��� . �� "@
B j [
D,# +#"&=!2 >7>;# � )O � � s�֕�!)9�e D"8 G�P : � � ' ; O L@IK-B[
O
S G=<)( GE<O=O31(;); '' +%".'#".54>32 >32 %2>7.#" !2>54.#" �8[MA AL\7>qU22Uq>7\LA AM[8>pV22Vp�O$>7227>$$?0 0?�$?/ /?$$>8228>�";L**L;"0Y|LL|X1";L**L;"1X|LL|Y0� 5E''E4 /H00H//H00H/ 4E''E5 ����\� # (@% B S C S D6''"+>32#"#"&'7>32>7v��&E do�
Ac�K#J
:W=%C��V
mv��f�_-
L
;]B �~�� 7 �@ 0!/"BK� PX@+ [ [ O [ S GK�PX@$ [ [ W S D@+ [ [ O [ S GYY@ 42+)&$ 7 7
+2>7#".#"'>32 2>7#".#"'>32 6." #p=4ge_- 8." #qB5hd_- 6." #p=4ge_- 8." #qB5hd_Z r/.!(!
m31!)!��
q0.!)! m31!(! � ��~ kK� PX@) ^ _ ZMQE@' j k ZMQEY@
+!733!!!#7!5!7!��r�r��_��2w�w��K_�V���ȇ���� � P�� !@ @ M Q E+ !!��G.32�����yz �
� z{�
� � P�� !@ @ M Q E+5467%67.'%.=!5!��)81�G��J��z �
� z��� ���� "@
B M Q E+3 # >7 &'��|��z|� ��
�5���4��&&EF+#& ���� � @ C D+3#��� �� ! a@ BK�2PX@ S C Q C
D@ Y S C
DY@ ! !U%+3'.=354>32#"&#" !#!�p�:t�s&O ��d��T]
I8]�p>
]
��3� `�� �� ��BK�&PX@ SC Q C
DK�2PX@" C S C Q C
D@ Y C S C
DYY@ A!% +3'.=354>32;#.#" !!�p�4h�hS�Hd�6m(����]
I6T�pB
�Y*��6��� �����
@ S D
+2+h
>1P
2H4 ��
�� @ j a +2 #"&'%� Ӌ���
� � ��v� ' @ O S G((($+#".54>32 #".54>32 � )' ') � (( (( �' ') )' ') ) D'"� @ M Q E+!!D�"�j �
�� @ j a
#++7>3�����
�� �
��
x� @ B j a* +#"&/&'+73x� �� ��
__� ��
x� @
B j a,!+#'32 >?>;��� �� �
�^^ �J�
(@%j O S G
+"&53326533��sNVVNs��sr;==;i| � � @ O S G($+#".54>32 �"-,!!,-"�,!!,,"", v��- !@ [ O S G$&($+4>32 #".732654&#"v 3D&'E5 5E'&D3 Y6/-77-/6{'B//B'&@..@&+99+-88 V� 1@. O [ S G
+2673#".#"#4>32 �#%b*>(#@;4"%d+?'#@:4)%+H5 +$+I4 N
�� +@( O S G
#++7>3!+7>3��V�&!�� `�( ��
��
� �|��
@ S D
+2+�
>9�
!;ZBG ���C�_<� � ʓ^p �ӡ�D���- ��V �D�C� ' - � � � �� 6� j$ H~ R� �X �X J `� d� ^� d� X��� <� �� h� l� (� l� l� n� `� �� �� �� �� �� � "l VP
�Z Z� �� �l �� Z� �f �x <R � �0 �� �< \� �< \ �$ :� � �P � � � VX ���X Z� � f &� \^ �� J^ H J� � 2X � ���� � �j �X �X HP �^ H& �d >� ,X z � � � FX ,X �X X� t� � �� �� 4� �� ,X �� rf < D� \� �� �� d< Df F� d� R� Tf �X z: *" |f �� x� H� �� f� f� D ,P
P
P
P
P
P
B��Z Z� �� �� �� �f��f �f��f��* 2� �< \< \< \< \< \� ~< \� �� �� �� �� � �� �� \� \� \� \� \� \` \� J J J J J �� � �� ��R LX �X HX HX HX HX H� dX @X zX zX zX z P � P
� \Z Z� J� � J �> ,� 6� �X �� \� HH :d >$ :d >� � V� F� V� F� V� F� jf f f f f �f jf �f f ^� 0X �j �� :� Z� Z� :� Z� Z� v� v� �� X Hx �x �f�D� "� @� V� \p X >X T� �z .X : ��� �� �� �� �� � ��t � f �f��f��f Df �f��f��f f �f vf f Nf � l� #` � �J � �N � �J #�� $�J &�� *�� 2�� 4�� 9 0 : 0 < ? 0 D�� F�� G�� H�� R�� T�� m�N o�N y�N }�N ��J ��J ��J ��J ��J ��J ��J ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �J �� �� �� �� �� �� � �N �N � � �N �N �N ��J
�J
�
�N
�
�J
#��
$�J
&��
*��
2��
4��
9 0
: 0
<
? 0
D��
F��
G��
H��
R��
T��
m�N
o�N
y�N
}�N
��J
��J
��J
��J
��J
��J
��J
���
���
���
���
���
���
���
�
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�J
��
��
��
��
��
��
�
�N
�N
�
�
�N
�N
�N
��J #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� ��
�J
�
�N
�
�J
#��
$�J
&��
*��
2��
4��
9 0
: 0
<
? 0
D��
F��
G��
H��
R��
T��
m�N
o�N
y�N
}�N
��J
��J
��J
��J
��J
��J
��J
���
���
���
���
���
���
���
�
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�J
��
��
��
��
��
��
�
�N
�N
�
�
�N
�N
�N
��J �
�
� �x #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�h ?�L Y�| Z�� \�| l� m�x o�x r� y�x |� }�x ��� ��� ��� ��� ��� ��� ��� ��h �� �� �h �x �x � � � � �x �x �x �� �N ��
�N
�N �x �x �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�N r�N |�N ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �N �N �x �N �N �x ��N ��� �
�
� �x #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�h ?�L Y�| Z�� \�| l� m�x o�x r� y�x |� }�x ��� ��� ��� ��� ��� ��� ��� ��h �� �� �h �x �x � � � � �x �x �x �� 0 �x
0
0 �@ �� �@ �x �� �� " 0 #�� $�x &�� *�� -�h 2�� 4�� D�� F�� G�� H�� I�� J�x P�� Q�� R�� S�� T�� U�� V�� W�� X�� Y�� [�� \�� ]�� l 0 m�� o�� r 0 t : u : w�� y�� { : | 0 }�� ��x ��x ��x ��x ��x ��x ��x ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �x �� �� �� �� �� �� �� � � � 0 � 0 �@ � 0 � 0 �@ � � � � 0 ��x # �� # �� #
�� # �� #
�� # �� # �� # �� # $�� # 7�� # 9�� # ;�� # <�� # =�� # ?�� # @�� # `�� # l�� # r�� # |�� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # �� # �� # �� # �� # �� # �� # �� # �� # �� # �� # �� # ��� # ��� $ �J $
�J $
�J $ �� $ "�� $ #�� $ &�� $ *�� $ - 2 $ 2�� $ 4�� $ 7�| $ 8�� $ 9�x $ :�� $ <�\ $ ?�x $ Y�� $ \�� $ l�J $ m�� $ o�� $ r�J $ t�H $ u�H $ y�� $ {�H $ |�J $ }�� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��\ $ �� $ �� $ �\ $ �� $ �� $ �J $ �J $ �J $ �J $ �� $ �� $ �� $ ��J & �j & m�j & o�j & y�j & }�j & �j & �j & �j & �j & �j ' �� ' �� '
�� ' �� '
�� ' �� ' �� ' �� ' $�� ' 7�� ' 9�� ' ;�� ' <�� ' =�� ' ?�� ' @�� ' `�� ' l�� ' r�� ' |�� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' ��� ' ��� ) �| ) �L ) �L ) �| ) �� ) �� ) " ) $�| ) -�: ) F�� ) G�� ) H�� ) P�� ) Q�� ) R�� ) S�� ) T�� ) U�� ) X�� ) w�� ) ��| ) ��| ) ��| ) ��| ) ��| ) ��| ) ��| ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) �| ) �� ) �� ) �� ) �� ) �L ) �L ) ��| - �� - �� - �� - �� - $�� - ��� - ��� - ��� - ��� - ��� - ��� - ��� - �� - �� - �� - ��� . �� . #�� . &�� . *�� . 2�� . 4�� . F�� . G�� . H�� . I�� . R�� . T�� . W�� . Y�� . Z�� . \�� . m�� . o�� . y�� . }�� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . �� . �� . �� . �� . �� . �� . �� . �� . �� . �� / �� /
�� /
�� / 6 / �: / 6 / "�� / #�� / &�� / *�� / 2�� / 4�� / 7�T / 9�J / :�h / <�, / ?�J / F�� / G�� / H�� / R�� / T�� / Y�� / Z�� / \�� / l�� / m�: / o�: / r�� / t�6 / u�6 / y�: / {�6 / |�� / }�: / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��, / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / �� / �� / �� / �� / �� / �, / �: / �: / �� / �� / � 6 / �� / �� / � 6 / �: / �: / �: / ��� 2 �� 2 �� 2
�� 2 �� 2
�� 2 �� 2 �� 2 �� 2 $�� 2 7�� 2 9�� 2 ;�� 2 <�� 2 =�� 2 ?�� 2 @�� 2 `�� 2 l�� 2 r�� 2 |�� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 ��� 2 ��� 3 �v 3 � 3 � 3 �v 3 $�v 3 -�J 3 D�� 3 F�� 3 G�� 3 H�� 3 R�� 3 T�� 3 ��v 3 ��v 3 ��v 3 ��v 3 ��v 3 ��v 3 ��v 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 �v 3 �� 3 �� 3 �� 3 �� 3 � 3 � 3 ��v 4 �� 4 �� 4
�� 4 �� 4
�� 4 �� 4 �� 4 �� 4 $�� 4 7�� 4 9�� 4 ;�� 4 <�� 4 =�� 4 ?�� 4 @�� 4 `�� 4 l�� 4 r�� 4 |�� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 ��� 4 ��� 5 #�� 5 &�� 5 *�� 5 2�� 5 4�� 5 7�� 5 8�� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 �� 5 �� 7 �| 7 �L 7 �L 7 �L 7 �| 7 �` 7 �` 7 #�� 7 $�| 7 &�� 7 *�� 7 -�8 7 2�� 7 4�� 7 D� 7 F�. 7 G�. 7 H�. 7 J�D 7 P�` 7 Q�` 7 R�. 7 S�` 7 T�. 7 U�` 7 V�^ 7 X�` 7 Y�L 7 Z�t 7 [�p 7 \�L 7 ]�� 7 m�L 7 o�L 7 w�` 7 y�L 7 }�L 7 ��| 7 ��| 7 ��| 7 ��| 7 ��| 7 ��| 7 ��| 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 �� 7 �� 7 �� 7 �� 7 �� 7 �� 7 �� 7 ��. 7 ��. 7 ��. 7 ��. 7 ��. 7 ��. 7 ��` 7 ��. 7 ��. 7 ��. 7 ��. 7 ��. 7 ��. 7 ��` 7 ��` 7 ��` 7 ��` 7 �| 7 � 7 �� 7 �. 7 �. 7 �` 7 �� 7 �. 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 ��| 8 �� 8 �� 8 �� 8 �� 8 $�� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 �� 8 �� 8 �� 8 ��� 9 0 9 �x 9
0 9
0 9 �@ 9 �� 9 �@ 9 �x 9 �� 9 �� 9 " 0 9 #�� 9 $�x 9 &�� 9 *�� 9 -�h 9 2�� 9 4�� 9 D�� 9 F�� 9 G�� 9 H�� 9 I�� 9 J�x 9 P�� 9 Q�� 9 R�� 9 S�� 9 T�� 9 U�� 9 V�� 9 W�� 9 X�� 9 Y�� 9 [�� 9 \�� 9 ]�� 9 l 0 9 m�� 9 o�� 9 r 0 9 t : 9 u : 9 w�� 9 y�� 9 { : 9 | 0 9 }�� 9 ��x 9 ��x 9 ��x 9 ��x 9 ��x 9 ��x 9 ��x 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 �x 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 � 9 � 9 � 0 9 � 0 9 �@ 9 � 0 9 � 0 9 �@ 9 � 9 � 9 � 9 � 0 9 ��x : 0 : �� :
0 :
0 : �� : �� : �� : �� : " " : $�� : -�� : D�� : F�� : G�� : H�� : J�� : R�� : T�� : V�� : l 0 : m�� : o�� : r 0 : t 0 : u 0 : y�� : { 0 : | 0 : }�� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : �� : �� : �� : �� : �� : �� : �� : � 0 : � 0 : � : � 0 : � 0 : � : �� : �� : �� : � 0 : ��� ; �� ; #�� ; &�� ; *�� ; 2�� ; 4�� ; F�� ; G�� ; H�� ; I�� ; R�� ; T�� ; W�� ; Y�� ; Z�� ; \�� ; m�� ; o�� ; y�� ; }�� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; �� ; �� ; �� ; �� ; �� ; �� ; �� ; �� ; �� ; �� < < �\ <
<
< �h < �` < �h < �\ < �� < �� < " " < #�� < $�\ < &�� < *�� < -�8 < 2�� < 4�� < D�� < F�` < G�` < H�` < J�T < P�� < Q�� < R�` < S�� < T�` < U�� < V�� < X�� < Y�� < Z�� < [�| < \�� < l < m�` < o�` < r < t 2 < u 2 < w�� < y�` < { 2 < | < }�` < ��\ < ��\ < ��\ < ��\ < ��\ < ��\ < ��\ < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��` < ��` < ��` < ��` < ��` < ��` < ��� < ��` < ��` < ��` < ��` < ��` < ��` < ��� < ��� < ��� < ��� < �\ < �� < �� < �` < �` < �� < �� < �` < �` < �` < � < � < �h < � < � < �h < �` < �` < �` < � < ��\ = �� = " " = #�� = &�� = *�� = 2�� = 4�� = F�� = G�� = H�� = R�� = T�� = V�� = Y�� = \�� = m�� = o�� = y�� = }�� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = �� = �� = �� = �� = �� = � = � = � = � = � > #�� > &�� > *�� > 2�� > 4�� > F�� > G�� > H�� > R�� > T�� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > �� > �� > �� > �� > �� ? �J ?
�J ?
�J ? �� ? "�� ? #�� ? &�� ? *�� ? - 2 ? 2�� ? 4�� ? 7�| ? 8�� ? 9�x ? :�� ? <�\ ? ?�x ? Y�� ? \�� ? l�J ? m�� ? o�� ? r�J ? t�H ? u�H ? y�� ? {�H ? |�J ? }�� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��\ ? �� ? �� ? �\ ? �� ? �� ? �J ? �J ? �J ? �J ? �� ? �� ? �� ? ��J D �� D
�� D
�� D Y�� D Z�� D \�� D l�� D r�� D t�� D u�� D {�� D |�� D � D � D � D � D ��� E �� E
�� E �� E
�� E 9�� E :�� E ?�� E @�� E Y�� E [�� E \�� E `�� E l�� E r�� E |�� E � E � E � E � E ��� H �� H
�� H �� H
�� H 9�� H :�� H ?�� H @�� H Y�� H [�� H \�� H `�� H l�� H r�� H |�� H � H � H � H � H ��� I D I
D I
D I �~ I �~ I l D I r D I t d I u d I { d I | D I � D I � D I �~ I � D I � D I �~ I � D K �� K
�� K
�� K Y�� K Z�� K \�� K l�� K r�� K t�� K u�� K {�� K |�� K � K � K � K � K ��� N F�� N G�� N H�� N R�� N T�� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N �� N �� N �� P �� P
�� P
�� P Y�� P Z�� P \�� P l�� P r�� P t�� P u�� P {�� P |�� P � P � P � P � P ��� Q �� Q
�� Q
�� Q Y�� Q Z�� Q \�� Q l�� Q r�� Q t�� Q u�� Q {�� Q |�� Q � Q � Q � Q � Q ��� R �� R
�� R �� R
�� R 9�� R :�� R ?�� R @�� R Y�� R [�� R \�� R `�� R l�� R r�� R |�� R � R � R � R � R ��� S �� S
�� S �� S
�� S 9�� S :�� S ?�� S @�� S Y�� S [�� S \�� S `�� S l�� S r�� S |�� S � S � S � S � S ��� U �| U �| U D�� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U �� U �| U �| Y �� Y �| Y �| Y �� Y $�� Y F�� Y G�� Y H�� Y R�� Y T�� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y �� Y �� Y �� Y �� Y �| Y �| Y ��� Z �� Z �� Z �� Z �� [ F�� [ G�� [ H�� [ R�� [ T�� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ �� [ �� [ �� \ �� \ �| \ �| \ �� \ $�� \ F�� \ G�� \ H�� \ R�� \ T�� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ �� \ �� \ �� \ �� \ �| \ �| \ ��� ^ #�� ^ &�� ^ *�� ^ 2�� ^ 4�� ^ F�� ^ G�� ^ H�� ^ R�� ^ T�� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ �� ^ �� ^ �� ^ �� ^ �� l �J l � l �N l � l �J l #�� l $�J l &�� l *�� l 2�� l 4�� l 9 0 l : 0 l < l ? 0 l D�� l F�� l G�� l H�� l R�� l T�� l m�N l o�N l y�N l }�N l ��J l ��J l ��J l ��J l ��J l ��J l ��J l ��� l ��� l ��� l ��� l ��� l ��� l ��� l � l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l �J l �� l �� l �� l �� l �� l �� l � l �N l �N l � l � l �N l �N l �N l ��J m �N m �� m
�N m
�N m �x m �x m �� m $�� m 7�L m 9�� m :�� m ;�� m <�` m =�� m ?�� m l�N m r�N m |�N m ��� m ��� m ��� m ��� m ��� m ��� m ��� m ��` m �� m �` m �� m �� m �� m �N m �N m �x m �N m �N m �x m ��N m ��� o �N o �� o
�N o
�N o �x o �x o �� o $�� o 7�L o 9�� o :�� o ;�� o <�` o =�� o ?�� o l�N o r�N o |�N o ��� o ��� o ��� o ��� o ��� o ��� o ��� o ��` o �� o �` o �� o �� o �� o �N o �N o �x o �N o �N o �x o ��N o ��� p �� p �� p
�� p �� p
�� p �� p �� p �� p $�� p 7�� p 9�� p ;�� p <�� p =�� p ?�� p @�� p `�� p l�� p r�� p |�� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p �� p �� p �� p �� p �� p �� p �� p �� p �� p �� p �� p ��� p ��� r �J r � r �N r � r �J r #�� r $�J r &�� r *�� r 2�� r 4�� r 9 0 r : 0 r < r ? 0 r D�� r F�� r G�� r H�� r R�� r T�� r m�N r o�N r y�N r }�N r ��J r ��J r ��J r ��J r ��J r ��J r ��J r ��� r ��� r ��� r ��� r ��� r ��� r ��� r � r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r �J r �� r �� r �� r �� r �� r �� r � r �N r �N r � r � r �N r �N r �N r ��J t �H t �H t $�H t 9 : t : : t < ( t ? : t ��H t ��H t ��H t ��H t ��H t ��H t ��H t � ( t �H t � ( t ��H u �H u �H u $�H u 9 : u : : u < ( u ? : u ��H u ��H u ��H u ��H u ��H u ��H u ��H u � ( u �H u � ( u ��H y �N y �� y
�N y
�N y �x y �x y �� y $�� y 7�L y 9�� y :�� y ;�� y <�` y =�� y ?�� y l�N y r�N y |�N y ��� y ��� y ��� y ��� y ��� y ��� y ��� y ��` y �� y �` y �� y �� y �� y �N y �N y �x y �N y �N y �x y ��N y ��� { �H { �H { $�H { 9 : { : : { < ( { ? : { ��H { ��H { ��H { ��H { ��H { ��H { ��H { � ( { �H { � ( { ��H | �J | � | �N | � | �J | #�� | $�J | &�� | *�� | 2�� | 4�� | 9 0 | : 0 | < | ? 0 | D�� | F�� | G�� | H�� | R�� | T�� | m�N | o�N | y�N | }�N | ��J | ��J | ��J | ��J | ��J | ��J | ��J | ��� | ��� | ��� | ��� | ��� | ��� | ��� | � | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | �J | �� | �� | �� | �� | �� | �� | � | �N | �N | � | � | �N | �N | �N | ��J } �N } �� }
�N }
�N } �x } �x } �� } $�� } 7�L } 9�� } :�� } ;�� } <�` } =�� } ?�� } l�N } r�N } |�N } ��� } ��� } ��� } ��� } ��� } ��� } ��� } ��` } �� } �` } �� } �� } �� } �N } �N } �x } �N } �N } �x } ��N } ��� � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � �j � m�j � o�j � y�j � }�j � �j � �j � �j � �j � �j � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � � �\ �
�
� �h � �` � �h � �\ � �� � �� � " " � #�� � $�\ � &�� � *�� � -�8 � 2�� � 4�� � D�� � F�` � G�` � H�` � J�T � P�� � Q�� � R�` � S�� � T�` � U�� � V�� � X�� � Y�� � Z�� � [�| � \�� � l � m�` � o�` � r � t 2 � u 2 � w�� � y�` � { 2 � | � }�` � ��\ � ��\ � ��\ � ��\ � ��\ � ��\ � ��\ � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��� � ��� � ��� � �\ � �� � �� � �` � �` � �� � �� � �` � �` � �` � � � � � �h � � � � � �h � �` � �` � �` � � � ��\ � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �j � m�j � o�j � y�j � }�j � �j � �j � �j � �j � �j � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �t �
�t �
�t � �� � 9�^ � :�� � <�h � ?�^ � Y�� � \�� � l�t � m�� � o�� � r�t � t�| � u�| � y�� � {�| � |�t � }�� � ��h � �h � � � � � �t � �t � �t � �t � � � � � � � ��t � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � � �\ �
�
� �h � �` � �h � �\ � �� � �� � " " � #�� � $�\ � &�� � *�� � -�8 � 2�� � 4�� � D�� � F�` � G�` � H�` � J�T � P�� � Q�� � R�` � S�� � T�` � U�� � V�� � X�� � Y�� � Z�� � [�| � \�� � l � m�` � o�` � r � t 2 � u 2 � w�� � y�` � { 2 � | � }�` � ��\ � ��\ � ��\ � ��\ � ��\ � ��\ � ��\ � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��� � ��� � ��� � �\ � �� � �� � �` � �` � �� � �� � �` � �` � �` � � � � � �h � � � � � �h � �` � �` � �` � � � ��\ � �� � " " � #�� � &�� � *�� � 2�� � 4�� � F�� � G�� � H�� � R�� � T�� � V�� � Y�� � \�� � m�� � o�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � � � � � � � � � � � �� � " " � #�� � &�� � *�� � 2�� � 4�� � F�� � G�� � H�� � R�� � T�� � V�� � Y�� � \�� � m�� � o�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � � � � � � � � � � � �� � " " � #�� � &�� � *�� � 2�� � 4�� � F�� � G�� � H�� � R�� � T�� � V�� � Y�� � \�� � m�� � o�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � � � � � � � � � � � �N � �� �
�N �
�N � �x � �x � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�N � r�N � |�N � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �N � �N � �x � �N � �N � �x � ��N � ��� � �N � �� �
�N �
�N � �x � �x � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�N � r�N � |�N � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �N � �N � �x � �N � �N � �x � ��N � ��� � �J � � � �N � � � �J � #�� � $�J � &�� � *�� � 2�� � 4�� � 9 0 � : 0 � < � ? 0 � D�� � F�� � G�� � H�� � R�� � T�� � m�N � o�N � y�N � }�N � ��J � ��J � ��J � ��J � ��J � ��J � ��J � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �J � �� � �� � �� � �� � �� � �� � � � �N � �N � � � � � �N � �N � �N � ��J � �J � � � �N � � � �J � #�� � $�J � &�� � *�� � 2�� � 4�� � 9 0 � : 0 � < � ? 0 � D�� � F�� � G�� � H�� � R�� � T�� � m�N � o�N � y�N � }�N � ��J � ��J � ��J � ��J � ��J � ��J � ��J � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �J � �� � �� � �� � �� � �� � �� � � � �N � �N � � � � � �N � �N � �N � ��J � � �
� �
� � �x � #�� � &�� � *�� � 2�� � 4�� � 7�L � 9�L � :�� � <�h � ?�L � Y�| � Z�� � \�| � l� � m�x � o�x � r� � y�x � |� � }�x � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � �� � �� � �h � �x � �x � � � � � � � � � �x � �x � �x � �� � �J � � � �N � � � �J � #�� � $�J � &�� � *�� � 2�� � 4�� � 9 0 � : 0 � < � ? 0 � D�� � F�� � G�� � H�� � R�� � T�� � m�N � o�N � y�N � }�N � ��J � ��J � ��J � ��J � ��J � ��J � ��J � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �J � �� � �� � �� � �� � �� � �� � � � �N � �N � � � � � �N � �N � �N � ��J � �J � � � �N � � � �J � #�� � $�J � &�� � *�� � 2�� � 4�� � 9 0 � : 0 � < � ? 0 � D�� � F�� � G�� � H�� � R�� � T�� � m�N � o�N � y�N � }�N � ��J � ��J � ��J � ��J � ��J � ��J � ��J � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �J � �� � �� � �� � �� � �� � �� � � � �N � �N � � � � � �N � �N � �N � ��J � � �
� �
� � �x � #�� � &�� � *�� � 2�� � 4�� � 7�L � 9�L � :�� � <�h � ?�L � Y�| � Z�� � \�| � l� � m�x � o�x � r� � y�x � |� � }�x � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � �� � �� � �h � �x � �x � � � � � � � � � �x � �x � �x � �� � �N � �� �
�N �
�N � �x � �x � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�N � r�N � |�N � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �N � �N � �x � �N � �N � �x � ��N � ��� � �N � �� �
�N �
�N � �x � �x � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�N � r�N � |�N � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �N � �N � �x � �N � �N � �x � ��N � ��� � �N � �� �
�N �
�N � �x � �x � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�N � r�N � |�N � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �N � �N � �x � �N � �N � �x � ��N � ��� � �J � � � �N � � � �J � #�� � $�J � &�� � *�� � 2�� � 4�� � 9 0 � : 0 � < � ? 0 � D�� � F�� � G�� � H�� � R�� � T�� � m�N � o�N � y�N � }�N � ��J � ��J � ��J � ��J � ��J � ��J � ��J � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �J � �� � �� � �� � �� � �� � �� � � � �N � �N � � � � � �N � �N � �N � ��J � �J �
�J �
�J � �� � "�� � #�� � &�� � *�� � - 2 � 2�� � 4�� � 7�| � 8�� � 9�x � :�� � <�\ � ?�x � Y�� � \�� � l�J � m�� � o�� � r�J � t�H � u�H � y�� � {�H � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��\ � �� � �� � �\ � �� � �� � �J � �J � �J � �J � �� � �� � �� � ��J � � � � ��D��(\��8R|�� � Z� R� @ �
*
N
t
� � � : � �
:
�
�
�:���*z�>�&`��.d���8Tv��l�HP�Tn�"���`� N � � * Z � � N � � � � z � �!�!�"�# #j#�#�$n$�$�% %l%�&&X&�&�'('l'�'�(l))�*>*J*V*b*n*z*�*�+�+�+�+�,,, ,,,8,�,�,�,�,�,�,�,�-�-�-�-�-�-�..�.�.�.�.�.�.�/�0�0�0�0�0�0�0�0�11�1�1�1�1�1�1�2(2�2�2�2�2�2�3d3p44�4�4�5d6"6<6p6�6�6�7�8T8`8l8x8�8�8�8�8�8�8�8�9*9R9�9�9�9�:4:�:�;;x;�;�;�<<0<~<�= =j=�>>p?~?�?�?�@~@�ADA�A�BBNBhB�C8C�D8D�D�EEHE^E�F8F`F�F�F�GG4GbG�G�G�H@HzH� � b " / n � � n � � � * � � ( � � 0 � / G
�V 2 2J
�| > X l t T� � P� � `> 0� �
�� 0
� d
�
�8 4�Copyright (c) 2010-2013 by tyPoland Lukasz Dziedzic with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1.LatoRegulartyPolandLukaszDziedzic: Lato Regular: 2013Lato RegularVersion 1.105; Western+Polish opensourceLato-RegularLato is a trademark of tyPoland Lukasz Dziedzic.tyPoland Lukasz DziedzicLukasz DziedzicLato is a sanserif typeface family designed in the Summer 2010 by Warsaw-based designer Lukasz Dziedzic ("Lato" means "Summer" in Polish). It tries to carefully balance some potentially conflicting priorities: it should seem quite "transparent" when used in body text but would display some original traits when used in larger sizes. The classical proportions, particularly visible in the uppercase, give the letterforms familiar harmony and elegance. At the same time, its sleek sanserif look makes evident the fact that Lato was designed in 2010, even though it does not follow any current trend. The semi-rounded details of the letters give Lato a feeling of warmth, while the strong structure provides stability and seriousness.http://www.typoland.com/http://www.typoland.com/designers/Lukasz_Dziedzic/Copyright (c) 2010-2013 by tyPoland Lukasz Dziedzic (http://www.typoland.com/) with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1 (http://scripts.sil.org/OFL).http://scripts.sil.org/OFL C o p y r i g h t ( c ) 2 0 1 0 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 . L a t o R e g u l a r t y P o l a n d L u k a s z D z i e d z i c : L a t o R e g u l a r : 2 0 1 3 L a t o - R e g u l a r V e r s i o n 1 . 1 0 5 ; W e s t e r n + P o l i s h o p e n s o u r c e L a t o i s a t r a d e m a r k o f t y P o l a n d L u k a s z D z i e d z i c . t y P o l a n d L u k a s z D z i e d z i c L u k a s z D z i e d z i c L a t o i s a s a n s e r i f t y p e f a c e f a m i l y d e s i g n e d i n t h e S u m m e r 2 0 1 0 b y W a r s a w - b a s e d d e s i g n e r L u k a s z D z i e d z i c ( " L a t o " m e a n s " S u m m e r " i n P o l i s h ) . I t t r i e s t o c a r e f u l l y b a l a n c e s o m e p o t e n t i a l l y c o n f l i c t i n g p r i o r i t i e s : i t s h o u l d s e e m q u i t e " t r a n s p a r e n t " w h e n u s e d i n b o d y t e x t b u t w o u l d d i s p l a y s o m e o r i g i n a l t r a i t s w h e n u s e d i n l a r g e r s i z e s . T h e c l a s s i c a l p r o p o r t i o n s , p a r t i c u l a r l y v i s i b l e i n t h e u p p e r c a s e , g i v e t h e l e t t e r f o r m s f a m i l i a r h a r m o n y a n d e l e g a n c e . A t t h e s a m e t i m e , i t s s l e e k s a n s e r i f l o o k m a k e s e v i d e n t t h e f a c t t h a t L a t o w a s d e s i g n e d i n 2 0 1 0 , e v e n t h o u g h i t d o e s n o t f o l l o w a n y c u r r e n t t r e n d . T h e s e m i - r o u n d e d d e t a i l s o f t h e l e t t e r s g i v e L a t o a f e e l i n g o f w a r m t h , w h i l e t h e s t r o n g s t r u c t u r e p r o v i d e s s t a b i l i t y a n d s e r i o u s n e s s . h t t p : / / w w w . t y p o l a n d . c o m / h t t p : / / w w w . t y p o l a n d . c o m / d e s i g n e r s / L u k a s z _ D z i e d z i c / C o p y r i g h t ( c ) 2 0 1 0 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c ( h t t p : / / w w w . t y p o l a n d . c o m / ) w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 ( h t t p : / / s c r i p t s . s i l . o r g / O F L ) . h t t p : / / s c r i p t s . s i l . o r g / O F L �t x
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � b c � d � e � � � � � � � f � � � � g � � � � � h � � � j i k m l n � o q p r s u t v w � x z y { } | � � ~ � � � � � � �
� � � � �
� � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � !"#NULLuni00A0uni00ADmacronperiodcenteredAogonekaogonekEogonekeogonekNacutenacuteSacutesacuteZacutezacute
Zdotaccent
zdotaccentuni02C9EuroDeltauni2669undercommaaccent
grave.case
dieresis.case macron.case
acute.casecircumflex.case
caron.case
breve.casedotaccent.case ring.case
tilde.casehungarumlaut.case
caron.salt �� � � � �� �� ����V��������V� ,� `f-�, d ��P�&Z�E[X!#!�X �PPX!�@Y �8PX!�8YY � Ead�(PX!� E �0PX!�0Y ��PX f ��a �
PX` � PX!�
` �6PX!�6``YYY� +YY#� PXeYY-�, E �%ad �CPX�#B�#B!!Y�`-�,#!#! d�bB �#B� *! �C � �� +�0%�QX`PaRYX#Y! �@SX� +!�@Y#� PXeY-�,�C+� C`B-�,�#B# � #Ba��b�`�*-�, E �Ec�Eb`D�`-�, E � +#�%` E�#a d � PX!� �0PX� �@YY#� PXeY�%#aDD�`-�,�E�aD-� ,�` � CJ� PX � #BY�
CJ� RX �
#BY-�
, � b � c�#a� C` �` � #B#-� ,KTX�DY$�
e#x-� ,KQXKSX�DY!Y$�e#x-�
,� CUX� C�aB�
+Y� C�%B� %B�
%B�# �%PX� C`�%B�� �#a� *!#�a �#a� *!� C`�%B�%a� *!Y� CG�
CG`��b �Ec�Eb`� #D�C� >�C`B-�,� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,� +-�,�+� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-� ,�+-� ,�+-� ,�+-� ,�+-� ,�+-�!,�+-�",�+-�#,� +-�$, <�`-�%, `�
` C#�`C�%a�`�$*!-�&,�%+�%*-�', G �Ec�Eb`#a8# �UX G �Ec�Eb`#a8!Y-�(,� ETX ��'*�0"Y-�),�+� ETX ��'*�0"Y-�*, 5�`-�+, �Ec�Eb� +�Ec�Eb� +� � D>#8�**-�,, < G �Ec�Eb`� Ca8-�-,.<-�., < G �Ec�Eb`� Ca�Cc8-�/,� % . G� #B�%I��G#G#a Xb!Y�#B�.*-�0,� �%�%G#G#a�E+e�.# <�8-�1,� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# �C �#G#G#a#F`�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba# �&#Fa8#�CF�%�CG#G#a` �C��b`# � +#�C`� +�%a�%��b�&a �%`d#�%`dPX!#!Y# �&#Fa8Y-�2,� �& .G#G#a#<8-�3,� �#B F#G� +#a8-�4,� �%�%G#G#a� TX. <#!�%�%G#G#a �%�%G#G#a�%�%I�%a�Ec# Xb!Yc�Eb`#.# <�8#!Y-�5,� �C .G#G#a `� `f��b# <�8-�6,# .F�%FRX <Y.�&+-�7,# .F�%FPX <Y.�&+-�8,# .F�%FRX <Y# .F�%FPX <Y.�&+-�9,�0+# .F�%FRX <Y.�&+-�:,�1+� <�#B�8# .F�%FRX <Y.�&+�C.�&+-�;,� �%�& .G#G#a�E+# < .#8�&+-�<,�%B� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# G�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba�%Fa8# <#8! F#G� +#a8!Y�&+-�=,�0+.�&+-�>,�1+!# <�#B#8�&+�C.�&+-�?,� G� #B� .�,*-�@,� G� #B� .�,*-�A,� �-*-�B,�/*-�C,� E# . F�#a8�&+-�D,�#B�C+-�E,� <+-�F,� <+-�G,� <+-�H,�<+-�I,� =+-�J,� =+-�K,� =+-�L,�=+-�M,� 9+-�N,� 9+-�O,� 9+-�P,�9+-�Q,� ;+-�R,� ;+-�S,� ;+-�T,�;+-�U,� >+-�V,� >+-�W,� >+-�X,�>+-�Y,� :+-�Z,� :+-�[,� :+-�\,�:+-�],�2+.�&+-�^,�2+�6+-�_,�2+�7+-�`,� �2+�8+-�a,�3+.�&+-�b,�3+�6+-�c,�3+�7+-�d,�3+�8+-�e,�4+.�&+-�f,�4+�6+-�g,�4+�7+-�h,�4+�8+-�i,�5+.�&+-�j,�5+�6+-�k,�5+�7+-�l,�5+�8+-�m,+�e�$Px�0- K� KRX��Y� c �#D�#p�E �(`f �UX�%a�Ec#b�#D� *� *�*Y�( ERD� *�D�$�QX�@�X�D�&�QX� �X�DYYYY������ D share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf 0000644 00000272124 15173517750 0025702 0 ustar 00 DSIG tL GPOS � , HPGSUBV.T I| OS/2ٮ�� J� `cmapRԟ� J� �cvt '� i� 8fpgm� zA j4 �gasp i� glyfmr�� O� �>head��d� � 6hhea�` �L $hmtx4W� �p Tkern@�B� �� g�loca�E�/ R� ,maxpC
� T� name�� U Tpost:�] fX �prep�x9� s� �
0 J DFLT latn �� �� kern kern G r �����T��v �
� � � �
V
��8�,^$^ �0��
D��J��J� � � J � L F �!z" ##P#�$4$~%x&&�'�(�)�*�+�+�,J,�-n. .�/$/V/�/�/�1�242n2�2�3 3V3�3�44J4�4�4�5�5�6�7�7�7�8~8�8�:�;";�;�<�=2>,?&?�@�A�B�C8C�D�E.F( > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U - #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U 0 ��
��
�� �; #�� &�� *�� 2�� 4�� 7�5 9�, :�| <�; ?�, Y�r Z�� \�| k�� l�� m�; o�; p�� r�� y�; |�� }�; ��� ��� ��� ��� ��� ��� ��� ��; ��r ��r �� �� �; �; �; � � � � �; �; �; & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� 0 ��
��
�� �; #�� &�� *�� 2�� 4�� 7�5 9�, :�| <�; ?�, Y�r Z�� \�| k�� l�� m�; o�; p�� r�� y�; |�� }�; ��� ��� ��� ��� ��� ��� ��� ��; ��r ��r �� �� �; �; �; � � � � �; �; �; q 6 ��
6
6 �A �� �A �� �� �� " : #�� $�� &�� *�� -�i 2�� 4�� D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� V�� X�� Y�� Z�� \�� ]�� k�� l 6 m�� o�� p�� r 6 t P u P w�� y�� { P | 6 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� �� �� � � � 6 � 6 �A � 6 � 6 �A � �A � � ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� ��
�� m�� o�� y�� }�� � � � � � $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� > �| �L �L �| �� �� " $�| -�: D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� X�� w�� ��| ��| ��| ��| ��| ��| ��| ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �| �� �� �� �� �� �L �L �L ��| �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� +
�� #�� &�� *�� 2�� 4�� I�� W�� Y�� Z�� \�� k�� l m�� o�� p�� r y�� | }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � � � � � 3 ��
��
�� �; #�� &�� *�� 2�� 4�� 7�8 9�J :�h <�, ?�J Y�| Z�� \�| k�� l�� m�; o�; p�� r�� t�, u�, y�; {�, |�� }�; ��� ��� ��� ��� ��� ��� ��� ��, ��| ��| �� �� �, �; �; � � � � �; �; �; $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� / �v �C �C �v $�v -�J D�� F�� G�� H�� R�� T�� ��v ��v ��v ��v ��v ��v ��v ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �v �� �� �� �� �C �C �C ��v $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� #�� &�� *�� 2�� 4�� 7�� 8�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� f �| �L �L �L �| �f �f " ' #�� $�| &�� *�� -�8 2�� 4�� D�/ F�/ G�/ H�/ J�E P�f Q�f R�/ S�f T�/ U�f V�J X�f Y�W Z� [�Z \�L ]�_ k�� m�L o�L p�� w�f y�L }�L ��| ��| ��| ��| ��| ��| ��| ��� ��� ��� ��� ��� ��� ��� ��/ ��/ ��/ ��/ ��/ ��/ ��/ ��/ ��/ ��/ ��/ ��/ ��/ ��f ��/ ��/ ��/ ��/ ��/ ��/ ��f ��f ��f ��f ��W ��W �| �/ �� �/ �/ �f �� �/ �J �J �_ �_ �_ �L �L �L �L �L �L �L �L ��| �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� q 6 ��
6
6 �A �� �A �� �� �� " : #�� $�� &�� *�� -�i 2�� 4�� D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� V�� X�� Y�� Z�� \�� ]�� k�� l 6 m�� o�� p�� r 6 t P u P w�� y�� { P | 6 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� �� �� � � � 6 � 6 �A � 6 � 6 �A � �A � � ��� N : ��
:
: �� �� �� �� �� $�� -�� D�� F�� G�� H�� J�� P�� Q�� R�� S�� T�� U�� V�� X�� l : r : t < u < w�� { < | : ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� � : � : � � : � : � � ��� +
�� #�� &�� *�� 2�� 4�� I�� W�� Y�� Z�� \�� k�� l m�� o�� p�� r y�� | }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � � � � � m 7 �r
7
7 �' �J �' �r �� �� " 2 #�� $�r &�� *�� -�8 2�� 4�� D�A F�A G�A H�A J�W P�� Q�� R�A S�� T�A U�� V�A X�� ]�� k�� l 7 m�J o�J p�� r 7 t > u > w�� y�J { > | 7 }�J ��r ��r ��r ��r ��r ��r ��r ��� ��� ��� ��� ��� ��� ��� ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��� ��A ��A ��A ��A ��A ��A ��� ��� ��� ��� �r �A �� �A �A �� �� �A �A �A �� �� �� �J �J � 7 � 7 �' � 7 � 7 �' �J �' �J �J ��r �� " # #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � - #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � E
E
E � � l E r E t d u d { d | E � E � E � � E � E � � ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � " �h �h D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �h �h �h . �� �r �r �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �r �r �r ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� � � � ��� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� . �� �h �h �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �h �h �h ��� - #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U �T �T $�T 9 : : : < ( ? : ��T ��T ��T ��T ��T ��T ��T � ( �T � ( ��T �T �T $�T 9 : : : < ( ? : ��T ��T ��T ��T ��T ��T ��T � ( �T � ( ��T & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� �T �T $�T 9 : : : < ( ? : ��T ��T ��T ��T ��T ��T ��T � ( �T � ( ��T > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� �� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� �� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� �� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� �� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� �� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� ��
�� m�� o�� y�� }�� � � � � � $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� ��� m 7 �r
7
7 �' �J �' �r �� �� " 2 #�� $�r &�� *�� -�8 2�� 4�� D�A F�A G�A H�A J�W P�� Q�� R�A S�� T�A U�� V�A X�� ]�� k�� l 7 m�J o�J p�� r 7 t > u > w�� y�J { > | 7 }�J ��r ��r ��r ��r ��r ��r ��r ��� ��� ��� ��� ��� ��� ��� ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��� ��A ��A ��A ��A ��A ��A ��� ��� ��� ��� �r �A �� �A �A �� �� �A �A �A �� �� �� �J �J � 7 � 7 �' � 7 � 7 �' �J �' �J �J ��r $ �� ��
�� ��
�� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� ��� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � . �� �r �r �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �r �r �r ��� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � . �� �r �r �� $�� D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �r �r �r ��� : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� ��
�� m�� o�� y�� }�� � � � � � ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � " �i
�i
�i �� 9�^ :�� <�h ?�^ Y�� Z�� \�� l�i m�� o�� r�i t�} u�} y�� {�} |�i }�� ��h ��� ��� �h � � �i �i �i �i � � � ��
��
�� Y�� \�� l�� r�� t�� u�� {�� |�� ��� ��� �� �� �� �� ��
�� ��
�� @�� [�� `�� l�� r�� |�� � � � � m 7 �r
7
7 �' �J �' �r �� �� " 2 #�� $�r &�� *�� -�8 2�� 4�� D�A F�A G�A H�A J�W P�� Q�� R�A S�� T�A U�� V�A X�� ]�� k�� l 7 m�J o�J p�� r 7 t > u > w�� y�J { > | 7 }�J ��r ��r ��r ��r ��r ��r ��r ��� ��� ��� ��� ��� ��� ��� ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��A ��� ��A ��A ��A ��A ��A ��A ��� ��� ��� ��� �r �A �� �A �A �� �� �A �A �A �� �� �� �J �J � 7 � 7 �' � 7 � 7 �' �J �' �J �J ��r �� " # #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � �� " # #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � �� " # #�� &�� *�� 2�� 4�� k�� m�� o�� p�� y�� }�� ��� ��� ��� ��� ��� ��� ��� �� �� � � � � � & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U 0 ��
��
�� �; #�� &�� *�� 2�� 4�� 7�5 9�, :�| <�; ?�, Y�r Z�� \�| k�� l�� m�; o�; p�� r�� y�; |�� }�; ��� ��� ��� ��� ��� ��� ��� ��; ��r ��r �� �� �; �; �; � � � � �; �; �; > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U 0 ��
��
�� �; #�� &�� *�� 2�� 4�� 7�5 9�, :�| <�; ?�, Y�r Z�� \�| k�� l�� m�; o�; p�� r�� y�; |�� }�; ��� ��� ��� ��� ��� ��� ��� ��; ��r ��r �� �� �; �; �; � � � � �; �; �; & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� 0 ��
��
�� �; #�� &�� *�� 2�� 4�� 7�5 9�, :�| <�; ?�, Y�r Z�� \�| k�� l�� m�; o�; p�� r�� y�; |�� }�; ��� ��� ��� ��� ��� ��� ��� ��; ��r ��r �� �� �; �; �; � � � � �; �; �; & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� & �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� > �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U : �J
�J
�J �� #�� &�� *�� - > 2�� 4�� 7�| 8�� 9�� :�� <�h ?�� W�� Y�� Z�� \�� k�� l�J m�� o�� p�� r�J t�I u�I y�� {�I |�J }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��h ��� ��� �� �� �h �� �� �J �J �J �J �� �� �� r
# $ & ' ) - . / 2 3 4 5 7 8 9 : ; < = > ? E H I K N P Q R S U Y Z [ \ ^ k l m o p r t u y { | } � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �
8 � DFLT latn �� �� case &case ,liga 2liga 8sups >sups D , > B
@ L O , { t u C j q v � � � � � � � I �� x x � t�� �P `K tyPL �J�z��� � �� � &
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � r d e i � x � p k � v j � � � s g w � � � � � l | � � � � c n � � � m } � b � � � � � � � � � � � � � � � � � � � y � � � � � � � � � � � � � � � � � � � � � q � � � z � � � ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ - �� ( 8 < @ J@G B h f [ [ Q C Q
D@?($#- $
+>32 #'.54>54&#"#"'4632 #"&!!7!!�9DO.?gI) -60#z
-5- I9)8( c>0( (0>���22c��u& #@[87P;+&%ia /(&.8'3<��/@ )( ?��g6, ����
! &@# Q C S D
+#>74>32 #".F uF�!-."".-!���-UV\44\VU->��."".-""- ����
*@' B Q D
$+#"&=!#"&=�$" %�$" %��ߛ "" �!�ߛ "" �! 6 �� < @ H@E
Y C Q
C
D @?>= < <6431.-(&##!#!+#"&547#+#"546?3#7>;>;3323+32%3# �Nq�t 0 M��+�j�'&�v
- N���M v�&%�j����j���X ]��# �(
7KG k �X� ��G ��
7K G�bf 8 C N �@J ) ? B AK� PX@$ j h f k C DK�
PX@$ j h f k C D@$ j h f k C DYY�# '# %+.'7632 .54>?>; #".' +4.'> �w�?= +A\Dg>w]9B|�o @&g�30 %6I2]@~c>F��u" @�":N,`JsP)� 5H)WHkG" aKN&1/ 1KoRS�xL� � Q;@"!�2IlO_��S� �,A0#�2Oh�*?1%�-DU Z���� ' 1 E Y �K� PX@' [ [ SC S
DK� PX@+ [ [ SC
C S D@/ [ [ C S C
C S DYY@
VT((%#&((($
+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>�;`{A8^C%6]}F8^C&�$1 (G4 $1 'G5 w |��
~:`|A8]C%6]}F8]D%�$1 (G5 $1 'G6 xc�j7)MoFc�k8)NpH2H."JsQ1E-!GqU ��
�c�i7)MnFc�l8)NpH2G."JrQ1F-!Hr 9���� B N �@;LK.& BK� PX@* h S C S
C S
D@( h S C S
C S DY@ IG20)'#!
BB+2 #"'.#">7>;#"./#".54>7.54> 3267�FrR-e )<)3R; /2B)6w[G� `^�R�b65]}H'%9i��q#=T1_�F��sr�,Nj>! 8- &C[49x?�gB�Gs�`�� zWf1[�QO�u\ B�?R�j>��8W< VF�>� ����
@ B Q D
$+#"&=�$" %��ߛ "" �! z��S
� (+ .547 * Q*;& U�uG JrN)�J���C .V���S� �/ r�� �����
� (+4.'&546?
'.547>9 ) R);& T�uF IsN)1I���C /W���T������. r� �a�� 6 C@0,+'$# BK�PX@ k D@
jaY@
6 6+7>7'767&/7 &546?3>? '.'i �!�$$$ �3�T
� �# �2�a�!
dIefIe ��!
dIe fHd
� s �A� .@+ j k M R F +!!#!7!�5��f5�5�i�6��S��Q��� 2��$ � @
? S
D"+74632 '&54>7#"&2A6 . 1F-
*' 4A{/B'3 -a_Z& &5E*E a<� @ M Q E+!!s��8�� -��' � @ S D($+74>32 #".-"--""--"n."".-""- ����.� @ k D#"++>;]:I�4 I "� ! O��j� ' ,@) S CS D '' +2 #".54>2>54.#" �_�sAb��~`�sAb�� T�qB-Le8T�qB-Le�I�ے���kI�ۓ�J�k��Y��x�j0Y���x�i0 � �� *@'
B h C R
D$+7!7#"&/3!!�6{��,� ���M�
Kq�� / J� 4 ;@80 B h S C Q
D -+'%
44+2 >3!2!7>7>54.#"#"&/>�S�f99b�J�Q)R&� �HIrO)#>U2p�% # Wc���/Z�R[��~C�x
"5;)�AusxE6R6 uf b�f4 ]��X� C U@R?
B h h [ S C S D <:64.-,+#! CC +2 #".'7632 32>54.#7>54.#"#"&/>�T�b6*MmCz{V��jd�jBP,B\AR�W. N�f��">T2r�& # Xc���.UxIOyZ;#�pl�{B.\�_ :W: 8Zr;0Q;"{��5P5ve b�f4 - f� '@$
B \ C
D!#+3+#!"&/3>7!���.�/��"+�� ��b��{W���7 �9 D��F� . @@=,+B h [ Q C S D(#&(""+#!632 #".'7632 32>54.#"'!<37�9so\i�i4]��u?p_N = /C_CS�d7$HnK2sDg��M$/�9d�Q~͐O)6 J % 8e�V9]C$ � h��0� 2 2@/ B [ C S D /-%# +2 #".54>7>;> 32>54.#"�O�e:T��vb�l9 9W<�3 ��.%7���$Dd@O�a6'Ge>O�^5l2`�Wo��P<n�_>wy}E���3,$)�!;cH(5^�L=cE%8_~ � �� $@!B Q C
D $'++>7!"&=7�
� '�� ��D-�+�)u R��>� 3 G D@AB [ S C S D54! ?=4G5G+) 3!3 +".5467.54>32 '2>54.#" 2>54.#" c�r>��aaH�iZ�e6��t|Q��cN~Z0-Lc5Bz_9$Fd�QqG :X;HoL'9Y3^�Q��)&�bX�q@4[{F��-#�ui�w?�.RtF@Z9$LwS5W?#�4Sf3-N;"-Lh:+P=% � w� 1 2@/ B [ S C
D .,&$ +".54>32 +>74.#"32>5K�`7R��p^�h8 ;T6�c0 ��.=�P%D_:I{Z3�xO~Y0M0\�Ti��N;j�XH}vvB�< 6-/�:_D%2Y{Ju�5Zv -���� ' ;K�$PX@ S C S D@ [ S DY�((($+74>32 #".4>32 #".-"--""--"d"--""--"n."".-""- ."".-""- .���� , D�
?K�$PX@ S C S
D@ [ S
DY@ )' "+74632 '&54>7#"&4>32 #"..A6 . 1F-
*' 4Ai"--""--"{/B'3 -a_Z& &5E*E."".-""- � ��W �(+ �6�#/+��-��
�
� '0� �� � !@ Y M Q E+!!!!�Z��:X��=�Ѓ } ��X �(+ 7>7%>7.'%.54>7����/+�Z�|�o
�
� '0�n ���� % 9 5@2 B h f S C S D(&#* $+>32 #7>54&#"#"'4>32 #".�!KWc8FqP*/HWO=
%w 5LWI1_Q8R;'
!-."".-! 4(*Je;TvW?;@+��0JA>H[=NZ $ ��."".-""- M��M T d f@c
[
<B h [
[ [ O S GVU ^\UdVdLJ@>9731)' TT
+%"&'#".54>32 32>54.#" 3267>32 #".54>32 %2>7&#"FR?�H0G. ?[w�T?[)�!3aK.Dz�e��lP��v��L k�����_<k���muϛZEv��1<:8k#)I�a92�JMPE#<R0<~uhN-��4L #F�it�v<u�્ړL>0 3HR_����ɥu@O�؊םYu3WC( Gr�I9H �� ��
$@!B Z C
D# +!#"&'!+3!.'�� N��� %����>�
^����zQB&&C a e� * =@: B [ S C S
D *(" !+3!2 # !2>54&#%32>54&+a��p�h2%JoJ��G��y�?OxP(�����QyQ(|���-SwI@tbL �pc�xB��*NnE_q�+MlAgg d���� / D@A B h f S C S D '%"
//+%2>32 #".546$32 #".#" �BfN7) A^���̍Kt��L|fS$@(EmWtʔU:g�� ' Qfq\�䉻6�{2F+N
(/(]���o�{B a =� @ S C S
D!(!$+#!!2 4.#!!2>=q����ՔP�7g�]�Ό2xƎO1����v�Z��l�yA��[�� a A� (@% Y Q C Q
D+!!!!!!.��<��=u�ϱ/ � ���� a A� "@ Y Q C
D+!!!#!.��?��L��/ ����� d��%� : G@D&
B h [ S C S D 20+)" ::+%2>7#"&50>17!#".546$32 #"'.#" �4ZOI$'� �C6s��R�ӖQs��S�nY%<
5KjK{͓R;l�� D
O��':']�芹3�z 2D(N
)%^���q�~C a E� @ Z C
D+!#!#3!3��Q�EP���O�O���r��}� � �� @ C
D+!#3=���� ����� QK� PX� B� BYK� PX@ C S D@ h C S DY�#%"+#"&'7>32 32>73� ��6^0
!+ 4\J3 u���m"N~\� r %� &@#
B \ C
D'(% +3267>; #".'.+#3�B#-�, ���%#�� ��'+QQ���" ��
#�Y
<�n� a f� @ C R
D+%!!3/7������ a v� " &@# B h C
D!6(+ 67>;#>7+"'#324 3 ���� ��/.������ [�'*'� �g#.�~++�.��� �{ a E� @ B C
D!+2>73#"&'#3r j���^ �����`� ��)�gH��� d���� ) @ S C S D(((&+#".546$32 4.#" 32>�4_���k�ӕOr���ӕO�8g�]vƎP8g�]xƎO2zڹ�h8^�扷3�|_��m�|D_���m�|C^�� r i� /@, [S C
D
!+#!2 # 32>54.#nB���r�m6J�υtJ�U�X."DhE���6d�Vq��M�4]�L:\A# d���� 0 P� BK�PX@ S C S C D@ k S C S DY�(((%&+#"&'#".546$32 4.#" 32>�3^�R!�"5�6q<�ӕOr���ӕO�8g�]vƎP8g�]xƎO2yظ�4�w^�扷3�|_��m�|D_���m�|C^�� r U� # 7@4B [S C
D #" ,!+#!2 #"'.# 32>54&#vJ��yr�m54b�W 5�1��
"%/D�U�Y-��Y���0YNW�wS&��(���0WwGms ���� = =@:= B h f S C S D;9(&#! #"+#".#" #"&'7>32 32>54.54>32� &;T?@dE$0NeheN0F��t��AB,DdKEoM*0NcicN0@x�ln�9�#)#(E\54G3')2JhJf��PeVY -7-,NmB7I2%&0JlOX�|JTI { �� @ Q C
D +!#!7��Y����W����� ���$� #@ C S D +%2>73#".5473 vP�eA k�jc��{o�w>j�k'Ko�>m�Zi��{ӛXH��j-/i��&K|Z1 | W� @ B C
D, +32 >7>;#|� � �%��7��� M**L! �g � �� , !@ '
B C
D,> +32 >7>;2 >7>;#.'#�� �
�$+ �
�'�����
�/���
( <� �
: :� �gO&&�� �� �� @ B C
D'"(!+ 3267>; #"&'+�
l �� z���
�Q$�������l��
q
��$ y �� @ B C
D,"+#32 >7>;�G�G����
} !�=��;^�� 44 > �� $@! Q C Q
D +!!7>7!7� ����" l�7�< �l�; �� !��W� '@$ [ O QE !#+!+32!�W �ř��C�� l��q� @ k D# +32#"&'lI +iH 2�" �9" ���)� '@$
B [ O Q E!#+!!7>;#"&57�X� ����C80 �� @
B k D+!+3#"&'.'+>rg��
����z`+,+�� ������X @ M Q E +!7��+�tt M��� @ k D +2 #"&'�
kc ��� 0��� + ^@ BK�"PX@ S C S
D@ S C
CS DY@
$!++*' +!#"&57#".54>322>7.#"0\#$S]f7<bE&-St��ZA{<��1^TI ++<pbP9 $�@hI(/[�VZ��]3��=l�Y\'Fat�E� O���� , �K�"PX@ B@ BYK� PX@ CS C TDK�"PX@ CS C TD@! CS C
C T DYY@ $",, (%+33>32#"&'#" 32>54&O��X&X`h6��"?Ym�FQ�*
�0b[P &j74\L<)V��4=eF'��R���_6D?Au<j�W��6-,Kes{<w| <��b / d�BK� PX@$ h f S C S D@$ h f S C S DY�%(#%($+%#".54>32#".#" 32>32 34]^e:X�[/M��rd�38 +A3E{\5 8Q6-F6)!,�9L-<m�\{�hGDC
K��f>eG' ! 6 5��� * s@ BK�"PX@ C S C S
D@! C S C
CS DY@ $"**
+!"&57#"&54>323%2>7.#"�#&Zck7��"?Ym�FJ{+E���90a[O !&j6OY0V$�AjK)��R���^6:6-�?�;i�V 5,^��Yw} ;��q * 9 b@
0 BK� PX@ hS C S D@ hS C S DY@ ,++9,9*&%*+32>32 #".54>32 %">54.q6���uv0K;-& ,3afo@W�`4!?[u�QMpH#��?jR:��d #8 BoYB �� # 75K2:k�^N��xW2,DRB4[{G19B$' ?��� # g@
BK�2PX@" S CQC Q D@ M W S DY@
# #T%#++'.5737>32#"&#"3ve.KF�d� AcI>3 +I8& �a���KW
NbW�]0\8ZA]� ����� ; K ^ �@9$ BK�PX@+ [ [ C S C S D@. h [ [ S C S DY@=<[YSQEC<K=K4320(&
+ #".54>32.5467#".54>32! 2>54&#"4&'.#"32>0"(")1)Bz�mW�e7R��Y$G# &^<:eL,5f�bnQ~
�~6R9 YN6R8 W
6_*RxN&yoBmM+�2PD<<?%*DHU:Gb9$B]8OrJ") B) &JoJH�mB4; 9��/M`1XZ,J^3Z^� - 0?"HL#:N O �� ,@)B C S C
D &#+33>32#>54&#"O��SO�es|L�L=B-_ZN A��Tvy��+�{�%RP1ZN�� _ �� GK� PX@ S CC
D@ S CC
DY@
+##".54>32 �z�z�#,,!",,#�� �>-##-.##/ �g���� ( Y� BK� PX@ S CC S D@ S CC S DY@ %# U%+#"&'7>323267#".54>32 ��-LiC#2 GE
��#-+!"+,#���=iN-
`
IQ@>-##-.##/ N �� 0@- B \C C
D %(%!+3267>; #"&'.+#�j O ��y 0� ��
";����� W�s
� �� � X �� @ C
D +33X�����? G � 0 Z@ BK�"PX@ S C
D@ CSC
DY@ 0 0&%$$! +332>32>32#654&#"#>54&#"GzY<K�cgbL�hpoL�L2;+VPEA�M/;0YOD ?�<�~�������2�{�1(KG+S{P���0GD0[�R�� G � P@
BK�"PX@ S C
D@ C S C
DY@ &$!+332>32#>54&#"GyY<Q�mq}L�L=A0c\O :�<���*�{�%RO4_�S�� 7��� # NK� PX@ S C SD@ S C SDY@ ## +%2>54&#"".54>32 �IxT.nhJwT.mYS�d8P��nS�d8P��}P��_��O��_���9l�d��b9l�c�c ��� + �@ BK� PX@ S C S CDK�"PX@ S C S CD@! CS C S CDYY@ #!++ (&!+32>32#"&'" 32>54& �Y<&Zcl8��"?Ym�FK|*6�0c\O &k74\L<)V��M<�BkL)��R���_6;7�E�<l�W��7-,Kes{<w| 0��� 0 b@ %
BK� PX@ S CS C D@ S CS C DY@
)& 0 0*, +#"&54>5#".54>322>7.#"p ;#PZb4<bE&-St��ZA{<��0]TH -+<pbP9 ��%�;^C$/[�VZ��]3��<j�Wc'Fat�E� G �� ,@)
B S C
D #*!+332>32&#"GzY A�Y** /,a�38� �������*
�� 9 9@69 B h f S C S D/#%/#"+#".#" #"&'7>32 32>54.54>32� !/D0-J6 >^m^>7g�Za�/, 0I81O7 >^l^>3`�V[�2S ,;!/8)&:ZHF�a:E6D
# 2C&3<(#7XI@w\7=4 _���> 0 b�+BK�2PX@# j h Q C S D@! j h \ S DY@ %#(+&+74>7#"&54>?>;!!32>32 #"&�?q
�K^,
��=/)( %0}?ap�$:/� 9����)2 31 U+1j `���� # L� BK�"PX@C T
D@C
C T DY@ # #*!&+32>73#"&54>57#"&5467bL=B.a[N ?�zX "Q�jq}L��|$RP2\�P� "("Q����*� K �� @ B C
D, +32 >7>;#K�� : �����t%J$$I&�� Q �� . @ ' B C
D*!,< +32 >7>;2 >7>;#"'.'+Q�] Jq
��W�{
�����t#A A#��p#B! C#�� "�! �R" �� �� @ B C
D(")!+32>7>; #"&'+h�� �
�����
��
�!� �� /�+����� Q���� @
BC D,"!++32 >7>;<)����� @ ���)����*+ Y� @ Q C Q
D+!!7>7!7!P ����6 K���#�&�J
#ߌ 1��Y� E 7@4& :B [ [ O S G=;303++4𑯎.54>;+" ;2#".54>�85
JI-Y�V1
'B/"3;5@ # C=
2EfC" & �4Bhw|575a�i7M EoQ;?<MgA![?<rsu?FU %(Gb:Bxsq ���5� @ Q D+3#������ ���� G 7@4<( B [ [ O S G?=525++3" +7>;2>5<&454>7.54>54&+"&54>5732 �85
JI-Y�V1
'B/"3;5@ # C=
2EfC" & 4Bhw|575a�i7M
EoQ<?;LhA![?<rsu?FU %(Gb:Bxsq 9�� 9@6 j k O [ S G
+2673#".#"#4>32 �AI�%Ef@4f_V$AI�%EeA4f_VeUFCpP, '!TGCpP-!'! ����
! &@# S C QD
+>73 4>32 #".�C
hB."--""--"�� -UW\45\VU-���."".-""- ��&� / 8 �@ % BK� PX@. j h f k S C S D@. j h f k S C S DY@
##'#+.54>?>; #".'>32 +�R�`4M�ф" @-R}04 +=*�@[?* '!S`i6! @�tj�Z�]0
Dq�`~מ\� � ?1< �� "<#6&� ��� Dv� �� > ?@<+B h [ S C S
D&&%#%&" +#!>3!#!7>7#7>;>32 #"&'.#"!z �Y 60 < �
�;#9+$� q! P��mT{X9K#2H4AkQ3 �� � Kj*I
p
/C..F ^�zF&B[5,
0$+OpE��F � �+` # 7 ?@< ! B
@ ? W S D42*( (+467'7>327 '#"&''7.7 32>54.#"! �[�,h:9f+�Y� "! �[�,h99e,�Z� !�#>Q//S=$$=S//Q>#�9e,�Z� "! �[�,g:9f+�\� !! �[�,g:.Q=$$=Q./R>##>R ~ �� " 8@5
B
Z Y C
D"! ,! +!32 >7>;!!!!#!7!7!�6�ʐ �
_ "��6 ��
V ��'�'��
V
��p'��!: ; =��cic��Aci ���5� @ Y Q D+3#3#���������� ;��� F V A@>FTL; !B h f W S DDB+)&$ #!+#".#" #"&'7>32 32>54.5467.54>32 >54.'R!/B0/K6 DfvfDY_%-6f�^a�00 !0I:2O7 )BUYUB)ag%.3a�W[�/��:Zn3:26Ug1E9� .>".A88JdH[�)!U9J�`7D6B
" 3E))<0(*0?R8Y�'"X>AvZ5>6��/B82 V51D70 #P ^��� ' @ S D((($+#".54>32 #".54>32 ? )( () g )) )) ( (* *( (* * ]��� + G a �@
BK� PX@5 h
f [ [ S C S D@5 h
f [ [ S C S DY@ \ZPNB@42(& ++ +2 #".54>32#".#" 32>%4>32 #".7 32>54.#"; <9�tb�s?Dz�bm�9. 2M:GpP**Kg>?V9!�.4`���ee���_44_���ed���`4e,Qs��XX��sR-c��X��sQ,�@BIDz�de�yCC8A -TxKMyR+ �e���`44`���ed���`44`���eY��tS--St��Y��e.Sv�� �?�� - 9 L@I! B h [ W S D/. 32.9/9%#
--
+"&/#"&54>?6454&#"#"&/>32 '26?.04 AR%V�j(0"0$ 6xD,D//�.G$
B\9*H 1 ED(K;&& .6
(2. 4G(��P&#m *" � ��� % �%(+77�4�
o ;]4�
o ;� ��
��
�� ��
��
�>� =K� PX@ _ M Q E@ k M Q EY�+!#!�[4�$�9�^ a<� @ M Q E+!!s��8�� ^��� 3 I V ��>BK� PX@/h [
[ S C S D@/h [
[ S C S DY@44VTLJ4I4H)!*,,& +4>32 #".7 32>54.#"#!2 #"'.#'32>54.+^4`���ee���`44`���ee���`4e,Rr��XX��sR-c�焄�b� ��kj
�!� Ps8M/+F4��e���`44`���ed���`44`���eY��tS--St��Y��ee���|}z^�
��.
r(:&%8$ p��A @ M Q E+!!~��Aq �'� ' @ W S D((($+4>32 #".7 32>54.#"�3XvDEwX22XwEDvX3} 6I**I6 6I**I6 hCvW22WvCBuW33WuA*I6 6I**J7 7J 3 PK� <@9 j h Z M Q E
+!!#!7!!!�/��e-�-�j�/����D������r�{�$� ���d - 9@6+ B h [ S D (&#!
--+26;2!7>?>54&#"#"&/>�`m 0?"�2*��
� 6(6**A!C �ddS,HA< � * �89: -0+2 ji �|�d : S@P6B h h [ [ S D 31.,('&% :: +2 #".'7632 32>54>54&#"#"&/>�.K5 �980Nd48Q7" :
+!"5%FV [S5,2= @5HWd->$�-E7<]?!1G/! %011Y=>,-.+ 4P4 ��� @ kD #++7>3�� f�" ��� � ���� % 2@/ BC T
C D % %'%!&+32673#"&=#"&'#"&5<7\SVQF�=]�|gF�PA^ #U %��Y
RYJB�
lHC/+$H �� k�7�� *@' hi S D +##!#".54>3�ܵ���붝j]�i9H��q���7�7]2Z~MZ�tC ���� @ O S G($+4>32 #".�)6 7((7 6)Q 8((8 6))6 ��w
�K�PX@ B@ BYK� PX@ ^ T DK�PX@ j T D@ j j T DYY@
+2 32654&'73 #"&'76E(+GB:k JC!;Q0&B� ( # �R?.$9'5 ��z^ N�
BK�2PX@ j j Q D@ j j M R FY�$+37#"&/733!�6
y �hNy �u��,\ 6���] �<�� ! )@& W S D !! +2 #".54>2654&#"�:]A"0UxH;^A#0Wy
ZYA?2E+@�%Ea<R�]2%Eb<Q�]2���uKU&C^8KT w ��� % �%(+'&54767&'&54?'&54767&'&54?���5
�
p!;���5
�
p!; �{
�|�{
� k� + 1 V@S% /
B h h
Z \ C
D10+*)('&$##!#
+3+#7!"&/3+>;37#"&/733!>73�n
Uj���w��/ F�1!G�u�6
y �hNy �u����I �� >�] [ ���,\ 6���]�,�� � \� 7 H b@_B;5 B h h
Z [ C T
D
HGFEDC?=9820,*
7 7#"
+%+>;26;2 !7>?>54&#"#"&/>%37#"&/733!�/ F�1!G�`m 3C$�2*��
� 6(6*/=
+ ����6
y �hNy �u5 [ �IdS-LC>!�8* �89: -04)
ji<�,\ 6���] � z� T Z ~@{P
" /
X
B
h
h
h [
[ \
S C
D ZYMKGEA@?>8631+)T T##!#+3+#7!"&/3+>;%2 #".'7632 32>54>54&#"#"&/>>73 n
Uj���w��/ F�1!G�u.K5 �980Nd48Q7" :
46"5%FV [S5,2@ 15HW
���I �� >�] [ ->$�-E7<]?!1G/,2%011Y=>,-0% 4P4�c,�� ��u ' ; 5@2 B h f S C S D(&#, $+#".54>?3 32>324>32 #".u!LWb8DoQ,/IWN: $u 1HSF/-;!7S<' ��!-."".-!� 4''HgAQsS<56$��-B:8CV;)?+ $ ."".-""- ���� ��& $ O ���� ��& $ _ ���� ��& $
O ���� ��& $ O ���� ��& $
O ���� �-& $ P �� �� 9@6A Y Y Q C S
D# +!!!!!!!+!��L �*�:�� &��� ��� �������$@ d���� J �K�PX@9= H B@9= HBYK� PX@0 h f S C S C S DK�PX@0 h f S C S C S D@7 h f h S C S C S DYY@ FD<;64/-%# JJ
+2 32654&'7.546$32 #".#" 32>32 #"&'76�(+GB0r�~Bt��L|fS$@(EmWtʔU:g�UBfN7) AWߒJC!;Q0&B� ( # v d�ڀ�6�{2F+N
(/(]���o�{B ' Q^o:?.$9'5 �� a A�& ( $ �� a A�& ( $ �� a A�& (
$ �� a A�& (
$ �� V
�& , �� � �& , �� g ��& ,
�� � ��& ,
E �� ! ,@) Y S C S
D!%(!+3!2 #!#%4.#!!!!2>S�P�ԕOp��Q�{7f�]��>\
��?2xŎN �Z�㈷���v��l�yA�n��[�� �� a E�& 1 � �� d����& 2 � �� d����& 2 � �� d����& 2
� �� d����& 2 � �� d����& 2
� l �9W � (+ ' 7 9�|8f��nP���g0������]d��]e[]��Z 0���� % 1 = g@5*)#
BK� PX@ k C S C S D@ j k S C S DY�**'(%&+#"&'+.546$327>; .#"%4&' 32>�4_���ka�Cm=J�MRr��h�EY `�EJ��+)�2�OvƎP�$"�<0wHxƎO2zڹ�h82/� T錷3�|;6p �T��a�<.1_��*X�;��&'^�� �� ���$�& 8 � �� ���$�& 8 � �� ���$�& 8
� �� ���$�& 8
� �� y ��& < <�� �����++ � �� ,@) \ [ C
D"( +32 +#3 32>54&#��r�n6J�΅�!���3J�U�X.���6c�Uq��L����a��4]�Lt� 3�&� P }@ JGBAK�,PX@( h S C S C Q D@% h W S C S DY@ LKFD=;%# PP+2 #"&'7>32 32>54.54>54.#"+'&573>�Y~Q&/FQF/+@K@+>i�OY�10 "-@0*G3 .DQD.1JWJ1-I4>mU:
l.KF�n(�^���6Se/D`H638&#/)+=XAV�_3E6B " 6I*0?.(4H8>XE:@P8 ;0 Ct�U���KW!M\��K �� 0����& D Ci �� 0����& D v+ �� 0����& D �" �� 0����& D �" �� 0����& D j" �� 0����& D �6 ��� G U bG@ E?"BK� PX@5 h h
[ S C SDK�PX@5 h h
[ S C SDK�,PX@? h h
[ S C SC SD@J h h
[ S C S C SC SDYYY@&WV \[VbWbQOIHCA<:75/.(&
GG+2 32>32 #"&'#"&54>7>54#"#"&/>32>32>7">54&]<fK*7��zl1K;-& ,3afo@i�' Ydj1��@���<U?0W�hlz<���x�g-NA4]K4 �<bI2 ��c(K%BY39lU7
�� # 74L1rr>W8wxG�c> (�!)!7QP`UT^��%<Q2HE%JoJ�-TvH$3@$9D <��b I �K�PX@6 < G B@6 < GBYK� PX@0 h f S C S C S DK�PX@0 h f S C S C S D@7 h f h S C S C S DYY@ EC;:42-+#! II
+2 32654&'7.54>32#".#" 32>32 #"&'76(+GB2JqL'M��rd�38 +A3E{\5 8Q6-F6)!,/TTW1JC!;Q0&B� ( # y
Ck�T{�hGDC
K��f>eG' ! 63H-<?.$9'5�� ;��q�& H C � �� ;����& H v � �� ;��q�& H � � �� ;����& H j � �� = ��& � C� �� _ u�& � v� �� " ^�& � �� �� / w�& � j� <���� 1 E 6@37-B10@ [ S D32=;2E3E+)! +.54?.'&54? 7 #".54>32.'2>7.#" ��)`7%X�F� qQ^F�ȂR�e8E}�ia�0LL�!AoX> &<U9KwR+"=S) ^%
7@3|9 ST���k9k�_l��U[\��E���3l�v,Q?&<i�QCjI' �� G ��& Q � ���++ �� 7����& R C � ���++ �� 7����& R v � ���++ �� 7����& R � � ���++ �� 7����& R � � ���++ �� 7����& R j � ���++ s �A~ ' +@( [ Y O S G(&(%+!!4>32 #"&4>32 #"&���B�&2 ' &21;X&2 ' &20<�� 2& ( 1$>�f 2& ( 1$> ���% ) 4 �@32#" BK� PX@! C S C S C DK�PX@! C S C S C DK� PX@! k C S C S D@! j k S C S DYYY@+* *4+4&$ +"'+7.54>327>; &#"2>54&'�|Z$: C�(+P��n}[" Z�'+P�����8NJzY1�I{Y1
�F7=1 �5�X��b@. �5�W�c�YBZ-L���sM��g,K ��, �� `����& X C � ���++ �� `����& X v � ���++ �� `����& X � � ���++ �� `����& X j � ���++ �� Q����& \ v � ���++ %���� , p@ BK� PX@! CS C S CD@! CS C S CDY@ $",, (%+3>32#"&'#" 32>54&%ݰY&X`h6��"?Ym�FK{+.' 0b\O !&k74\L<)V���4=eF'��R���_6;6��&�<j�W��6,,Kes{<w|�� Q����& \ j � ���++ ������ ' 0 �K�PX@
- B@
-BYK�PX@! Z C
C S D@( h Z C
C S DY@ )($" ''
+2 #"&5467#"&'!+3#32>!.'�
Y0LRVB
N��� %���_-&( ���
� @ F:?n)^����g !*3 ' �QB&&C 0��� 4 F(K�PX@&; BK�"PX@&;B@&;BYYK� PX@# S C SC S DK�PX@# S C SC S DK�"PX@* h S C SC S D@. h S C
C S C S DYYY@65 ?<5F6F1/('$" 44
+2 #"&54>7.57#".54>32#32>2>7.#">
Y0LR*:"$S]f7<bE&-St��ZA{<y-&( �C1^TI ++<pbP9 � @ F: =81 �@hI(/[�VZ��]3�, !*3 ' \=l�Y\'Fat�E� �� d���� & & � �� <��o�& F v � ���++ a��A� % �K�PX� B� BYK�PX@* Y Q C Q
C
S D@1
h Y Q C Q
C S DY@ "
%% +2 #"&5467!!!!!!#32>G
Y0LRVB���/��<��=ui-&( � @ F:?n)��� ��� !*3 ' ;��q A P �K�PX@G2 B@G2BYK� PX@* h S C S C S DK�PX@* h S C S C S D@1 h h S C S C S DYY@CB BPCP><0.)'
AA
+2 #"&5467.54>32 32>32 32>">54.I
Y0LRI9U�_2!?[u�QMpH#6���uv0K;-& ,M�T+$( ?jR:��d #8� @ F::f(<j�]N��xW2,DR%BoYB �� # 7P] !)2 ' Y4[{G19B$' _ �� @C
D +#�z�z�� � �� !@
B C R
D+%!!76?3�m��=7�E��Y�&�} ���-`�
W� L b� @ B C
D+4?37#L�N�F��\�T�� D��Jf! I� �E �� a E�& 1 � �� G ��& Q v ���++ d���� 2'@
BK� PX@" Y S
C S
DK� PX@- Y S
C S
C S
DK� PX@* Y S C Q
C S
DK�"PX@4 Y S C Q
C S
C S
D@2 Y S C Q
C Q
C S DYYYY@ /-%# (# +!!!!!7#".54>32 4.#" 32>���;��=q�� Z��u��Fh���K�kS h/Z�Sm��I0[�Sm��H��� ����r~\�ㇹ6�~&Ge?��j�|Dc���k�|Cb�� .��� 4 F U �@
L2 "BK� PX@$ h S C
SD@$ h S C
SDY@ HG65 GUHU><5F6F0.&$ 44 +2 32>32 #"&'#".54>32>2>54&#" ">54.�AhJ'8\��~ym0K;-& ,2afp@i�'EQzQ)U��kk�#?��IQ}U+]aN|X/.JH;fP8 ��h&'="?X5)LC;0&
�� # 74L1tsny;e�H���Xe[Zf�vN��qs�L��y/VB( .YQ3:A!*! �� ���& 6 � ��
��#�& V v ���++�� ����& 6 � ��
��,�& V �~ ���++�� y ��& <
<�� �����++ �� ��& = 8 �� Y�& ] v � ���++ �� �& = 8 �� Y�& ] � � ���++ �� ��& = 8 �� Y�& ] � � ���++ ��i� ' 6@3
BY S C S D ' '# "+#763>7'.546767376$3#"!��2��� :.UH8���*0 � /UI9+G�!˹[7:^E�
�ſ_ ;^E�} Q��� @ B k D, +#"&/.'+3�r d� w���� q��� @ B k D( +32 ?>;#qx d
� s������ �� p��A q ���� @ W D
+".5467332>73r>V6y4B'6#z&Eg�!:M-
3?)9!6aI+ �� @ S D($+#".54>32 #.-""-.#:-""-/##/ �kJ� =K� PX@ W S D@ [ O S GY�$&($+4>32 #".732654&#"� 7H()I8 8I)(H7 d6/-77-/6#*D22D*)D00D),88,-88 /��t
YK�PX@ B @@ B @YK�PX@
S D@ j S DY@ +2 #"&54>732>R
Y0LR.@%W-&( � @ F:"@:2
!*3 ' h��� QK�*PX@ W S D@ O [ S GY@ +273#".#"#>32 �Ai!2B% 5-) (j"3A%!4-()X/M7 # -,.N8 # ��)� #@ S D
#++7>3!+7>3� H�" �� S� ��� ��� � ����� ! Y�BK�(PX@ SC S
D@ SC
C S DY@ ! 6##++#!#"&'7>3267#7>3�"|l�k��O�z =<;N� �D#��u�}w� H ?C�?
��� @ M Q E+!!��� �} �o� @ M Q E+!!���7�} ���� � (+.5467�j^/ !
�%J%d�L
09@"6
���� � (+ '&5467>54&'&547pj^0 !
�%J%d�L
08@#6
�� � � (+7 '&5467>54&'&547�j^0 !
�%J%d�L
08@#6
���� 1 � (+.5467.5467�j^/ !
�j^/ !
�%J%d�L
09@"6
*%J%d�L
09@"6
���� 1 � (+ '&5467>54&'&547% '&5467>54&'&547yj^0 !
�j^0 !
�%J%d�L
08@#6
*%J%d�L
08@#6
���� � 1 � (+7 '&5467>54&'&547% '&5467>54&'&547�j^0 !
�j^0 !
�%J%d�L
08@#6
*%J%d�L
08@#6
����� % ,@) B C S C D$&$"+>3 632>32 ! #"&'!�,*?�G#)33#P$KIF &!��6H0+u6��� /��,
)
�D�� � B���� 9 E@B )!("B[ C S C D98'%#&$"
+>3 632>32!!#.'#"&'#"&5<>7!!�,*?�G#)33#P$KIF &"��Pj.*?�G!0+O$KIG &!kP��� /��,
'(�v: /�/ �
(� � ��� ,K�PX@ S D@ O S GY�($+4>32 #".�:e�LM�e;;e�ML�e:SM�e;;e�MM�d;;d� -��, � ' ; @ SD((((($+74>32 #".%4>32 #".%4>32 #".-"--""--""--""--"!..""..!n."".-""-."".-""-."".-""- Z���� ' 1 E Y m � �K� PX@+ [ [ SC
S
DK� PX@/ [ [ SC
C
S
D@3 [ [ C S C
C
S
DYY@~|trjh`^VT((%#&((($+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>%#".54>32 4.#" 32>�;`{A8^C%6]}F8^C&�$1 (G4 $1 'G5 w |��
~:`|A8]C%6]}F8]D%�$1 (G5 $1 'G6 ):`{A8^C%6]}F8]D%�$1 (F5 #1 'F6 xc�j7)MoFc�k8)NpH2H."JsQ1E-!GqU ��
�c�i7)MnFc�l8)NpH2G."JrQ1F-!HrRc�i7)MnFc�l8)NpH2G."JrQ1F-!Hr � ��� �(+7�4�
o ;� ��
��
w ��� �(+'&54767&'&54?���5
�
p!; �{
� c� @ C
D#"+'+>;?/ F�1!G5 [ *���� B [@X 4 B h h
[ [ S C
S
DBA?>=<861/"##%%$+3>32#".#"!#!!#! 32>32 #".'#7367#T�!w��p��;C &6J3M�oT0 ��� �d��RoI. ASގq�v>� � ��̎LcWB 4f�`7#H&6 ��-6-DeqR�ҀcJG �I6� % B@?B h S C S D % %!4(
+>7>;#7+"'#32'###7�
� fGk.�
}.iGg�
�<x;�P
3��rG��RH��Ne��e A� = /@,! B S CS
D = <,**+!>54.#" !"&546767!7.54>32 !�5T�i<5a�Re��H*Lj@4�/ LxR,0X|��`zȎNAw�f~
( �Jx�pZ�_0B��zMyY:�O %�Tv�Ta��tQ+L��prěl�a A�� � 3 H B@? "B h [ S CS D54?=4H5H#*++$+>32 #".5467>32>7>54&#"#"&'2>7.#"�'JMT0ItQ,n�݉HwT._��g^�" e\'C7)
:qdU .I5K{\: ]9* 8l�c ?!���/X~P#sʔVRQ"= 9�� ��7o�r-S@'>m�W gp �� �� @ B C R
D+)3!.'��ԩ���
����9 !9 ����� $@! Q CD +##!##7��Ȳ�ɱȼ����]��]� �� � $@!B Q C Q D+!!!!7>7 &5<7�R�����A��
��!
���;4�;�A � �^� @ M Q E+!!�[��� L l� "@ B j [
D,'!+!##"&5<>7!2 >7>;p���"Ne [ n�
�[ A 7 Q = ��� ' ; O L@IK-B[
O
S G=<)( GE<O=O31(;); '' +%".'#".54>32 >32 %2>7.#" !2>54.#" {3P?1 DNX35[C'7\xB3O@2 DMX35\D'7]y��!<86$,4!&A1 $1S%B1 $1 !;86%+4�!8K))K8!(KhAR�i=!9K))K9!(KiAR�i<� 5E''E4 !<T4&:&!<T4'9& 4E''E5 �{���� ! (@% B S C S D6'%"+>32#"#"&'7>32>7�)��#A *\n �Og}F D
6Q=,C��Wnu��f�_-
L
:^B ���� 7 ^@[ 0!/"B [ [ O [ S G 42+)&$ 7 7
+2>7#".#"'>32 2>7#".#"'>32 @ 80% (u=4c_\- 90%
)wB4d^\ 81%
'v=4c_\- 81%
)wB5c_[W
l0."(" i31!)!��
m/-!(!
h31!)! � � } kK� PX@) ^ _ ZMQE@' j k ZMQEY@
+!733!!!#7!7!7!��}����w��5�}���Pw�S���ʃ���� Z P�� @ @ M Q E+ !!�3�-2/��*>��yz �
� z{�
� i P�� @
@ M Q E+%!7!7>7%>7.'%.54657n��>���2/�a�P����z �
� z�� ���� "@
B M Q E+3 # >7 &'��|��y|� ��
�5���4��&&EF,#& ��� ~� -K� PX@ k D@
jaY@ +3v�� �0 >��� ' s@
BK�2PX@( S C QC
C QD@ M W S C
DY@ ' 'W%#+#!+'&5737>32 #"&#"�y�k�}f.KF�c(� Iz�k''#
SzU1 � `���KX #O8]�n=Z $HnK5 >�� ! �@ BK� PX@( SCQC
C Q DK�&PX@( SCQC
C Q DK�2PX@, C S CQC
C Q D@$M W C S C
DYYY@ ! !#!%# ++'&5737>32;#.#"3wg.KF�b(�
Bn�aG�5w���-_+u��a���KX !Q7T�pA
�Z$
��7� G��2�� 5K�0PX@ Q D@ M Q EY@ +#2~mQR�� U
� @ j a +2 #"&/ ����
�
� � �� ' @ O S G((($+#".54>32 #".54>32 P %# #% X $$ $$ �$$% %$$% % �(�� @ M Q E+!!�4���f
� @ j a
#++7>3����
��
�
f
�� @ B j a& +#"&/+73ǃ r� ���
kk� �
�� @ B j a !+#'32 7>3� r� ���kk ���� (@%j O S G
+"&547332673�syo�NOp,Ie�^^ c><4T< * @ O S G($+#".54>32 "-,!!,-"�,!!,,"", ��V- !@ [ O S G$&($+4>32 #".732654&#"� 4D&'E4 4E'&D4 Y6/-77-/6{'B//B'&@..@&+99+-88 ��� 1@. O [ S G
+2673#".#"#>32 )^ .>% 82. 'a .>%!82-|*%*G5 -%*H5 �
b� +@( O S G
#++7>3!+7>3(�S�' �� ]�) �� ��
� }��
@ k D
+2+� +$ <]�
9^I
D ��{��_<� � ʓ^p �ӡ�� �- ��V O����� � ' - � { �� �� 6� G� Z 9� �( z(��� �� s� 2� a� -���� O� �� /� ]� -� D� h� �� R� �� -� .+ �� �+ }� �� M��� a� di a+ a aE dp a6 �1��� r� a� ao a� dh r� d� r� ? {? �� |Z ����� y| ( !� l(��� ���8 M� 0 Ob < 5� ;] ?���$ O� _�g� N� X G G� 7 � 0� G
� _ `� K� Q���� QZ ( 1X �(��� 9� { �� �� � �� ~X �� ;8 ^= ]x �k �� �� a= ^8 p �� 3� �� �8 ; k# �8 � �� �k w� �� �� ������������������� d+ a+ a+ a+ a6 V6 �6 g6 �� Eo a� d� d� d� d� d� l� 0? �? �? �? �� yh �I 3� 0� 0� 0� 0� 0� 0� b <� ;� ;� ;� ;� =� _� "� /� < G� 7� 7� 7� 7� 7� s� ` ` ` `� Q %� Q��� 0� db <+ a� ;� _� Y Lo a G� d .�
�
� y| Z | Z | Z � 8 Q8 q8 p8 �88 �8 /8 h8 �x�� �� �� �� �� � �� ����, �, B� �� -O ZV �V wA�� */ �] + A ��Y ���� �x L� =�{� �� �+ Z+ i� � �� >G >8 G8 U8 �8 �88 f8 �8 �8*8 �8 �8 �8 g� P` � �U �� �� �� �U $�U 9 6 : 0 < - ? 6 D�� F�� G�� H�� R�� T�� m�� o�� y�� }�� ��U ��U ��U ��U ��U ��U ��U � - ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �U �� �� �� �� � - � � � � � � � � ��U
�U
��
��
��
�U
$�U
9 6
: 0
< -
? 6
D��
F��
G��
H��
R��
T��
m��
o��
y��
}��
��U
��U
��U
��U
��U
��U
��U
� -
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�U
��
��
��
��
� -
�
�
�
�
�
�
�
�
��U #�� &�� *�� 2�� 4�� D�� F�� G�� H�� R�� T�� k�� p�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� ��
�U
��
��
��
�U
$�U
9 6
: 0
< -
? 6
D��
F��
G��
H��
R��
T��
m��
o��
y��
}��
��U
��U
��U
��U
��U
��U
��U
� -
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�U
��
��
��
��
� -
�
�
�
�
�
�
�
�
��U ��
��
�� �; #�� &�� *�� 2�� 4�� 7�5 9�, :�| <�; ?�, Y�r Z�� \�| k�� l�� m�; o�; p�� r�� y�; |�� }�; ��� ��� ��� ��� ��� ��� ��� ��; ��r ��r �� �� �; �; �; � � � � �; �; �; �� ��
��
�� �^ �^ �� $�� 7�A 9�� ;�� <�@ =�� ?�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��@ �� �@ �� �� �� � � �^ � � �^ �^ ��� ��
��
�� �; #�� &�� *�� 2�� 4�� 7�5 9�, :�| <�; ?�, Y�r Z�� \�| k�� l�� m�; o�; p�� r�� y�; |�� }�; ��� ��� ��� ��� ��� ��� ��� ��; ��r ��r �� �� �; �; �; � � � � �; �; �; 6 ��
6
6 �A �� �A �� �� �� " : #�� $�� &�� *�� -�i 2�� 4�� D�� F�� G�� H�� P�� Q�� R�� S�� T�� U�� V�� X�� Y�� Z�� \�� ]�� k�� l 6 m�� o�� p�� r 6 t P u P w�� y�� { P | 6 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� �� �� � � � 6 � 6 �A � 6 � 6 �A � �A � � ��� # �� # �� #
�� # �� #
�� # �� # $�� # 7�� # 9�� # ;�� # <�� # =�� # ?�� # @�� # `�� # l�� # r�� # |�� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # �� # �� # �� # �� # �� # �� # �� # �� # �� # ��� $ �J $
�J $
�J $ �� $ #�� $ &�� $ *�� $ - > $ 2�� $ 4�� $ 7�| $ 8�� $ 9�� $ :�� $ <�h $ ?�� $ W�� $ Y�� $ Z�� $ \�� $ k�� $ l�J $ m�� $ o�� $ p�� $ r�J $ t�I $ u�I $ y�� $ {�I $ |�J $ }�� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��h $ ��� $ ��� $ �� $ �� $ �h $ �� $ �� $ �J $ �J $ �J $ �J $ �� $ �� $ �� & �� & m�� & o�� & y�� & }�� & � & � & � & � & � ' �� ' �� '
�� ' �� '
�� ' �� ' $�� ' 7�� ' 9�� ' ;�� ' <�� ' =�� ' ?�� ' @�� ' `�� ' l�� ' r�� ' |�� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' ��� ) �| ) �L ) �L ) �| ) �� ) �� ) " ) $�| ) -�: ) D�� ) F�� ) G�� ) H�� ) P�� ) Q�� ) R�� ) S�� ) T�� ) U�� ) X�� ) w�� ) ��| ) ��| ) ��| ) ��| ) ��| ) ��| ) ��| ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) �| ) �� ) �� ) �� ) �� ) �� ) �L ) �L ) �L ) ��| - �� - �� - $�� - ��� - ��� - ��� - ��� - ��� - ��� - ��� - �� - ��� . .
.
. �� . #�� . &�� . *�� . 2�� . 4�� . I�� . W�� . Y�� . Z�� . \�� . k�� . l . m�� . o�� . p�� . r . y�� . | . }�� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . �� . �� . � . � . � . � . � . � . � . � . � / �� /
�� /
�� / �; / #�� / &�� / *�� / 2�� / 4�� / 7�8 / 9�J / :�h / <�, / ?�J / Y�| / Z�� / \�| / k�� / l�� / m�; / o�; / p�� / r�� / t�, / u�, / y�; / {�, / |�� / }�; / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��, / ��| / ��| / �� / �� / �, / �; / �; / � / � / � / � / �; / �; / �; 2 �� 2 �� 2
�� 2 �� 2
�� 2 �� 2 $�� 2 7�� 2 9�� 2 ;�� 2 <�� 2 =�� 2 ?�� 2 @�� 2 `�� 2 l�� 2 r�� 2 |�� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 ��� 3 �v 3 �C 3 �C 3 �v 3 $�v 3 -�J 3 D�� 3 F�� 3 G�� 3 H�� 3 R�� 3 T�� 3 ��v 3 ��v 3 ��v 3 ��v 3 ��v 3 ��v 3 ��v 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 �v 3 �� 3 �� 3 �� 3 �� 3 �C 3 �C 3 �C 3 ��v 4 �� 4 �� 4
�� 4 �� 4
�� 4 �� 4 $�� 4 7�� 4 9�� 4 ;�� 4 <�� 4 =�� 4 ?�� 4 @�� 4 `�� 4 l�� 4 r�� 4 |�� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 ��� 5 #�� 5 &�� 5 *�� 5 2�� 5 4�� 5 7�� 5 8�� 5 k�� 5 p�� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 �� 5 �� 7 �| 7 �L 7 �L 7 �L 7 �| 7 �f 7 �f 7 " ' 7 #�� 7 $�| 7 &�� 7 *�� 7 -�8 7 2�� 7 4�� 7 D�/ 7 F�/ 7 G�/ 7 H�/ 7 J�E 7 P�f 7 Q�f 7 R�/ 7 S�f 7 T�/ 7 U�f 7 V�J 7 X�f 7 Y�W 7 Z� 7 [�Z 7 \�L 7 ]�_ 7 k�� 7 m�L 7 o�L 7 p�� 7 w�f 7 y�L 7 }�L 7 ��| 7 ��| 7 ��| 7 ��| 7 ��| 7 ��| 7 ��| 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��f 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��/ 7 ��f 7 ��f 7 ��f 7 ��f 7 ��W 7 ��W 7 �| 7 �/ 7 �� 7 �/ 7 �/ 7 �f 7 �� 7 �/ 7 �J 7 �J 7 �_ 7 �_ 7 �_ 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 ��| 8 �� 8 �� 8 $�� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 �� 8 ��� 9 6 9 �� 9
6 9
6 9 �A 9 �� 9 �A 9 �� 9 �� 9 �� 9 " : 9 #�� 9 $�� 9 &�� 9 *�� 9 -�i 9 2�� 9 4�� 9 D�� 9 F�� 9 G�� 9 H�� 9 P�� 9 Q�� 9 R�� 9 S�� 9 T�� 9 U�� 9 V�� 9 X�� 9 Y�� 9 Z�� 9 \�� 9 ]�� 9 k�� 9 l 6 9 m�� 9 o�� 9 p�� 9 r 6 9 t P 9 u P 9 w�� 9 y�� 9 { P 9 | 6 9 }�� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 � 9 � 9 � 6 9 � 6 9 �A 9 � 6 9 � 6 9 �A 9 � 9 �A 9 � 9 � 9 ��� : : : �� :
: :
: : �� : �� : �� : �� : �� : $�� : -�� : D�� : F�� : G�� : H�� : J�� : P�� : Q�� : R�� : S�� : T�� : U�� : V�� : X�� : l : : r : : t < : u < : w�� : { < : | : : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : �� : �� : �� : �� : �� : �� : �� : �� : � : : � : : � : � : : � : : � : � : ��� ; ;
;
; �� ; #�� ; &�� ; *�� ; 2�� ; 4�� ; I�� ; W�� ; Y�� ; Z�� ; \�� ; k�� ; l ; m�� ; o�� ; p�� ; r ; y�� ; | ; }�� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; �� ; �� ; � ; � ; � ; � ; � ; � ; � ; � ; � < 7 < �r <
7 <
7 < �' < �J < �' < �r < �� < �� < " 2 < #�� < $�r < &�� < *�� < -�8 < 2�� < 4�� < D�A < F�A < G�A < H�A < J�W < P�� < Q�� < R�A < S�� < T�A < U�� < V�A < X�� < ]�� < k�� < l 7 < m�J < o�J < p�� < r 7 < t > < u > < w�� < y�J < { > < | 7 < }�J < ��r < ��r < ��r < ��r < ��r < ��r < ��r < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��A < ��A < ��A < ��A < ��A < ��A < ��A < ��A < ��A < ��A < ��A < ��A < ��A < ��� < ��A < ��A < ��A < ��A < ��A < ��A < ��� < ��� < ��� < ��� < �r < �A < �� < �A < �A < �� < �� < �A < �A < �A < �� < �� < �� < �J < �J < � 7 < � 7 < �' < � 7 < � 7 < �' < �J < �' < �J < �J < ��r = �� = " # = #�� = &�� = *�� = 2�� = 4�� = k�� = m�� = o�� = p�� = y�� = }�� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = �� = �� = � = � = � = � = � > #�� > &�� > *�� > 2�� > 4�� > D�� > F�� > G�� > H�� > R�� > T�� > k�� > p�� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > �� > �� > �� > �� > �� > �� ? �J ?
�J ?
�J ? �� ? #�� ? &�� ? *�� ? - > ? 2�� ? 4�� ? 7�| ? 8�� ? 9�� ? :�� ? <�h ? ?�� ? W�� ? Y�� ? Z�� ? \�� ? k�� ? l�J ? m�� ? o�� ? p�� ? r�J ? t�I ? u�I ? y�� ? {�I ? |�J ? }�� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��h ? ��� ? ��� ? �� ? �� ? �h ? �� ? �� ? �J ? �J ? �J ? �J ? �� ? �� ? �� E �� E
�� E �� E
�� E @�� E [�� E `�� E l�� E r�� E |�� E � E � E � E � H �� H
�� H �� H
�� H @�� H [�� H `�� H l�� H r�� H |�� H � H � H � H � I E I
E I
E I � I � I l E I r E I t d I u d I { d I | E I � E I � E I � I � E I � E I � I � K �� K
�� K
�� K Y�� K \�� K l�� K r�� K t�� K u�� K {�� K |�� K ��� K ��� K �� K �� K �� K �� N D�� N F�� N G�� N H�� N R�� N T�� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N �� N �� N �� N �� P �� P
�� P
�� P Y�� P \�� P l�� P r�� P t�� P u�� P {�� P |�� P ��� P ��� P �� P �� P �� P �� Q �� Q
�� Q
�� Q Y�� Q \�� Q l�� Q r�� Q t�� Q u�� Q {�� Q |�� Q ��� Q ��� Q �� Q �� Q �� Q �� R �� R
�� R �� R
�� R @�� R [�� R `�� R l�� R r�� R |�� R � R � R � R � S �� S
�� S �� S
�� S @�� S [�� S `�� S l�� S r�� S |�� S � S � S � S � U �h U �h U D�� U F�� U G�� U H�� U R�� U T�� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U �� U �� U �� U �� U �h U �h U �h Y �� Y �r Y �r Y �� Y $�� Y D�� Y F�� Y G�� Y H�� Y R�� Y T�� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y �� Y �� Y �� Y �� Y �� Y �r Y �r Y �r Y ��� Z �� Z �� Z �� Z �� Z $�� Z ��� Z ��� Z ��� Z ��� Z ��� Z ��� Z ��� Z �� Z � Z � Z � Z ��� [ D�� [ F�� [ G�� [ H�� [ R�� [ T�� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ �� [ �� [ �� [ �� \ �� \ �h \ �h \ �� \ $�� \ D�� \ F�� \ G�� \ H�� \ R�� \ T�� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ �� \ �� \ �� \ �� \ �� \ �h \ �h \ �h \ ��� ^ #�� ^ &�� ^ *�� ^ 2�� ^ 4�� ^ D�� ^ F�� ^ G�� ^ H�� ^ R�� ^ T�� ^ k�� ^ p�� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ �� ^ �� ^ �� ^ �� ^ �� ^ �� k �� k �� k
�� k �� k
�� k �� k $�� k 7�� k 9�� k ;�� k <�� k =�� k ?�� k @�� k `�� k l�� k r�� k |�� k ��� k ��� k ��� k ��� k ��� k ��� k ��� k ��� k �� k �� k �� k �� k �� k �� k �� k �� k �� k ��� l �U l �� l �� l �� l �U l $�U l 9 6 l : 0 l < - l ? 6 l D�� l F�� l G�� l H�� l R�� l T�� l m�� l o�� l y�� l }�� l ��U l ��U l ��U l ��U l ��U l ��U l ��U l � - l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l �U l �� l �� l �� l �� l � - l � l � l � l � l � l � l � l � l ��U m �� m �� m
�� m
�� m �^ m �^ m �� m $�� m 7�A m 9�� m ;�� m <�@ m =�� m ?�� m l�� m r�� m |�� m ��� m ��� m ��� m ��� m ��� m ��� m ��� m ��@ m �� m �@ m �� m �� m �� m � m � m �^ m � m � m �^ m �^ m ��� o �� o �� o
�� o
�� o �^ o �^ o �� o $�� o 7�A o 9�� o ;�� o <�@ o =�� o ?�� o l�� o r�� o |�� o ��� o ��� o ��� o ��� o ��� o ��� o ��� o ��@ o �� o �@ o �� o �� o �� o � o � o �^ o � o � o �^ o �^ o ��� p �� p �� p
�� p �� p
�� p �� p $�� p 7�� p 9�� p ;�� p <�� p =�� p ?�� p @�� p `�� p l�� p r�� p |�� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p �� p �� p �� p �� p �� p �� p �� p �� p �� p ��� r �U r �� r �� r �� r �U r $�U r 9 6 r : 0 r < - r ? 6 r D�� r F�� r G�� r H�� r R�� r T�� r m�� r o�� r y�� r }�� r ��U r ��U r ��U r ��U r ��U r ��U r ��U r � - r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r �U r �� r �� r �� r �� r � - r � r � r � r � r � r � r � r � r ��U t �T t �T t $�T t 9 : t : : t < ( t ? : t ��T t ��T t ��T t ��T t ��T t ��T t ��T t � ( t �T t � ( t ��T u �T u �T u $�T u 9 : u : : u < ( u ? : u ��T u ��T u ��T u ��T u ��T u ��T u ��T u � ( u �T u � ( u ��T y �� y �� y
�� y
�� y �^ y �^ y �� y $�� y 7�A y 9�� y ;�� y <�@ y =�� y ?�� y l�� y r�� y |�� y ��� y ��� y ��� y ��� y ��� y ��� y ��� y ��@ y �� y �@ y �� y �� y �� y � y � y �^ y � y � y �^ y �^ y ��� { �T { �T { $�T { 9 : { : : { < ( { ? : { ��T { ��T { ��T { ��T { ��T { ��T { ��T { � ( { �T { � ( { ��T | �U | �� | �� | �� | �U | $�U | 9 6 | : 0 | < - | ? 6 | D�� | F�� | G�� | H�� | R�� | T�� | m�� | o�� | y�� | }�� | ��U | ��U | ��U | ��U | ��U | ��U | ��U | � - | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | �U | �� | �� | �� | �� | � - | � | � | � | � | � | � | � | � | ��U } �� } �� }
�� }
�� } �^ } �^ } �� } $�� } 7�A } 9�� } ;�� } <�@ } =�� } ?�� } l�� } r�� } |�� } ��� } ��� } ��� } ��� } ��� } ��� } ��� } ��@ } �� } �@ } �� } �� } �� } � } � } �^ } � } � } �^ } �^ } ��� � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � �� � m�� � o�� � y�� � }�� � � � � � � � � � � � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � ��� � 7 � �r �
7 �
7 � �' � �J � �' � �r � �� � �� � " 2 � #�� � $�r � &�� � *�� � -�8 � 2�� � 4�� � D�A � F�A � G�A � H�A � J�W � P�� � Q�� � R�A � S�� � T�A � U�� � V�A � X�� � ]�� � k�� � l 7 � m�J � o�J � p�� � r 7 � t > � u > � w�� � y�J � { > � | 7 � }�J � ��r � ��r � ��r � ��r � ��r � ��r � ��r � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��� � ��A � ��A � ��A � ��A � ��A � ��A � ��� � ��� � ��� � ��� � �r � �A � �� � �A � �A � �� � �� � �A � �A � �A � �� � �� � �� � �J � �J � � 7 � � 7 � �' � � 7 � � 7 � �' � �J � �' � �J � �J � ��r � �� � �� �
�� � �� �
�� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� �
�� � Y�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � ��� � ��� � �� � �� � �� � �� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� � �r � �r � �� � $�� � D�� � F�� � G�� � H�� � R�� � T�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �r � �r � �r � ��� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �� � �r � �r � �� � $�� � D�� � F�� � G�� � H�� � R�� � T�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �r � �r � �r � ��� � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � �� � m�� � o�� � y�� � }�� � � � � � � � � � � � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � �i �
�i �
�i � �� � 9�^ � :�� � <�h � ?�^ � Y�� � Z�� � \�� � l�i � m�� � o�� � r�i � t�} � u�} � y�� � {�} � |�i � }�� � ��h � ��� � ��� � �h � � � � � �i � �i � �i � �i � � � � � � � �� �
�� �
�� � Y�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � ��� � ��� � �� � �� � �� � �� � �� �
�� � �� �
�� � @�� � [�� � `�� � l�� � r�� � |�� � � � � � � � � � 7 � �r �
7 �
7 � �' � �J � �' � �r � �� � �� � " 2 � #�� � $�r � &�� � *�� � -�8 � 2�� � 4�� � D�A � F�A � G�A � H�A � J�W � P�� � Q�� � R�A � S�� � T�A � U�� � V�A � X�� � ]�� � k�� � l 7 � m�J � o�J � p�� � r 7 � t > � u > � w�� � y�J � { > � | 7 � }�J � ��r � ��r � ��r � ��r � ��r � ��r � ��r � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��A � ��� � ��A � ��A � ��A � ��A � ��A � ��A � ��� � ��� � ��� � ��� � �r � �A � �� � �A � �A � �� � �� � �A � �A � �A � �� � �� � �� � �J � �J � � 7 � � 7 � �' � � 7 � � 7 � �' � �J � �' � �J � �J � ��r � �� � " # � #�� � &�� � *�� � 2�� � 4�� � k�� � m�� � o�� � p�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � � � � � � � � � � � �� � " # � #�� � &�� � *�� � 2�� � 4�� � k�� � m�� � o�� � p�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � � � � � � � � � � � �� � " # � #�� � &�� � *�� � 2�� � 4�� � k�� � m�� � o�� � p�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � � � � � � � � � � � �� � �� �
�� �
�� � �^ � �^ � �� � $�� � 7�A � 9�� � ;�� � <�@ � =�� � ?�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��@ � �� � �@ � �� � �� � �� � � � � � �^ � � � � � �^ � �^ � ��� � �� � �� �
�� �
�� � �^ � �^ � �� � $�� � 7�A � 9�� � ;�� � <�@ � =�� � ?�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��@ � �� � �@ � �� � �� � �� � � � � � �^ � � � � � �^ � �^ � ��� � �U � �� � �� � �� � �U � $�U � 9 6 � : 0 � < - � ? 6 � D�� � F�� � G�� � H�� � R�� � T�� � m�� � o�� � y�� � }�� � ��U � ��U � ��U � ��U � ��U � ��U � ��U � � - � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �U � �� � �� � �� � �� � � - � � � � � � � � � � � � � � � � � ��U � �U � �� � �� � �� � �U � $�U � 9 6 � : 0 � < - � ? 6 � D�� � F�� � G�� � H�� � R�� � T�� � m�� � o�� � y�� � }�� � ��U � ��U � ��U � ��U � ��U � ��U � ��U � � - � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �U � �� � �� � �� � �� � � - � � � � � � � � � � � � � � � � � ��U � �� �
�� �
�� � �; � #�� � &�� � *�� � 2�� � 4�� � 7�5 � 9�, � :�| � <�; � ?�, � Y�r � Z�� � \�| � k�� � l�� � m�; � o�; � p�� � r�� � y�; � |�� � }�; � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��; � ��r � ��r � �� � �� � �; � �; � �; � � � � � � � � � �; � �; � �; � �U � �� � �� � �� � �U � $�U � 9 6 � : 0 � < - � ? 6 � D�� � F�� � G�� � H�� � R�� � T�� � m�� � o�� � y�� � }�� � ��U � ��U � ��U � ��U � ��U � ��U � ��U � � - � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �U � �� � �� � �� � �� � � - � � � � � � � � � � � � � � � � � ��U � �U � �� � �� � �� � �U � $�U � 9 6 � : 0 � < - � ? 6 � D�� � F�� � G�� � H�� � R�� � T�� � m�� � o�� � y�� � }�� � ��U � ��U � ��U � ��U � ��U � ��U � ��U � � - � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �U � �� � �� � �� � �� � � - � � � � � � � � � � � � � � � � � ��U � �� �
�� �
�� � �; � #�� � &�� � *�� � 2�� � 4�� � 7�5 � 9�, � :�| � <�; � ?�, � Y�r � Z�� � \�| � k�� � l�� � m�; � o�; � p�� � r�� � y�; � |�� � }�; � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��; � ��r � ��r � �� � �� � �; � �; � �; � � � � � � � � � �; � �; � �; � �� � �� �
�� �
�� � �^ � �^ � �� � $�� � 7�A � 9�� � ;�� � <�@ � =�� � ?�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��@ � �� � �@ � �� � �� � �� � � � � � �^ � � � � � �^ � �^ � ��� � �� �
�� �
�� � �; � #�� � &�� � *�� � 2�� � 4�� � 7�5 � 9�, � :�| � <�; � ?�, � Y�r � Z�� � \�| � k�� � l�� � m�; � o�; � p�� � r�� � y�; � |�� � }�; � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��; � ��r � ��r � �� � �� � �; � �; � �; � � � � � � � � � �; � �; � �; � �� � �� �
�� �
�� � �^ � �^ � �� � $�� � 7�A � 9�� � ;�� � <�@ � =�� � ?�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��@ � �� � �@ � �� � �� � �� � � � � � �^ � � � � � �^ � �^ � ��� � �� � �� �
�� �
�� � �^ � �^ � �� � $�� � 7�A � 9�� � ;�� � <�@ � =�� � ?�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��@ � �� � �@ � �� � �� � �� � � � � � �^ � � � � � �^ � �^ � ��� � �U � �� � �� � �� � �U � $�U � 9 6 � : 0 � < - � ? 6 � D�� � F�� � G�� � H�� � R�� � T�� � m�� � o�� � y�� � }�� � ��U � ��U � ��U � ��U � ��U � ��U � ��U � � - � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �U � �� � �� � �� � �� � � - � � � � � � � � � � � � � � � � � ��U � �J �
�J �
�J � �� � #�� � &�� � *�� � - > � 2�� � 4�� � 7�| � 8�� � 9�� � :�� � <�h � ?�� � W�� � Y�� � Z�� � \�� � k�� � l�J � m�� � o�� � p�� � r�J � t�I � u�I � y�� � {�I � |�J � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��h � ��� � ��� � �� � �� � �h � �� � �� � �J � �J � �J � �J � �� � �� � �� � � � � � �Z,�
Bz�(Zt��J�B��N� r �
.
^
�
� � z �
P
z
� 2���>|���Lr��F���(Hx���X�d�`���(���t�(�.l� R � � @ � � � f | � @ @ � �!!l!�"&"l#<#�#�$,$F% %%b%�&&�&�&�'2'^'�((Z(�)")�*�*�+ + ++$+0+<+�,n,z,�,�,�,�,�,�,�- -*-6-B-N-Z-f-�. .,.8.D.P.b.�/R/^/j/v/�/�/�0�1�1�1�1�1�1�1�1�2
2�2�2�2�2�2�2�3L444*4<4N4`4�4�5�6|6�6�7"7�88P8~8�8�9~:8:D:T:`:p:�:�:�:�:�:�:�;8;h;�;�;�;�<J<�<�=,=�=�=�=�> >H>�>�?4?�@@:@�A�A�A�BB�CCxDD0D\D�D�D�E�E�FRF�F�G0GpG�HH�H�I IJIdI�I�I�JJ:JzJ�J�K � b " / n � � n � � � ) � � ( � � 0 � + C
�R . 2F
�x : T h p R| � P� � `4 0� �
�� 0
� d
�
�. 4�Copyright (c) 2010-2013 by tyPoland Lukasz Dziedzic with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1.LatoItalictyPolandLukaszDziedzic: Lato Italic: 2013Lato ItalicVersion 1.105; Western+Polish opensourceLato-ItalicLato is a trademark of tyPoland Lukasz Dziedzic.tyPoland Lukasz DziedzicLukasz DziedzicLato is a sanserif typeface family designed in the Summer 2010 by Warsaw-based designer Lukasz Dziedzic ("Lato" means "Summer" in Polish). It tries to carefully balance some potentially conflicting priorities: it should seem quite "transparent" when used in body text but would display some original traits when used in larger sizes. The classical proportions, particularly visible in the uppercase, give the letterforms familiar harmony and elegance. At the same time, its sleek sanserif look makes evident the fact that Lato was designed in 2010, even though it does not follow any current trend. The semi-rounded details of the letters give Lato a feeling of warmth, while the strong structure provides stability and seriousness.http://www.typoland.com/http://www.typoland.com/designers/Lukasz_Dziedzic/Copyright (c) 2010-2013 by tyPoland Lukasz Dziedzic (http://www.typoland.com/) with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1 (http://scripts.sil.org/OFL).http://scripts.sil.org/OFL C o p y r i g h t ( c ) 2 0 1 0 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 . L a t o I t a l i c t y P o l a n d L u k a s z D z i e d z i c : L a t o I t a l i c : 2 0 1 3 L a t o - I t a l i c V e r s i o n 1 . 1 0 5 ; W e s t e r n + P o l i s h o p e n s o u r c e L a t o i s a t r a d e m a r k o f t y P o l a n d L u k a s z D z i e d z i c . t y P o l a n d L u k a s z D z i e d z i c L u k a s z D z i e d z i c L a t o i s a s a n s e r i f t y p e f a c e f a m i l y d e s i g n e d i n t h e S u m m e r 2 0 1 0 b y W a r s a w - b a s e d d e s i g n e r L u k a s z D z i e d z i c ( " L a t o " m e a n s " S u m m e r " i n P o l i s h ) . I t t r i e s t o c a r e f u l l y b a l a n c e s o m e p o t e n t i a l l y c o n f l i c t i n g p r i o r i t i e s : i t s h o u l d s e e m q u i t e " t r a n s p a r e n t " w h e n u s e d i n b o d y t e x t b u t w o u l d d i s p l a y s o m e o r i g i n a l t r a i t s w h e n u s e d i n l a r g e r s i z e s . T h e c l a s s i c a l p r o p o r t i o n s , p a r t i c u l a r l y v i s i b l e i n t h e u p p e r c a s e , g i v e t h e l e t t e r f o r m s f a m i l i a r h a r m o n y a n d e l e g a n c e . A t t h e s a m e t i m e , i t s s l e e k s a n s e r i f l o o k m a k e s e v i d e n t t h e f a c t t h a t L a t o w a s d e s i g n e d i n 2 0 1 0 , e v e n t h o u g h i t d o e s n o t f o l l o w a n y c u r r e n t t r e n d . T h e s e m i - r o u n d e d d e t a i l s o f t h e l e t t e r s g i v e L a t o a f e e l i n g o f w a r m t h , w h i l e t h e s t r o n g s t r u c t u r e p r o v i d e s s t a b i l i t y a n d s e r i o u s n e s s . h t t p : / / w w w . t y p o l a n d . c o m / h t t p : / / w w w . t y p o l a n d . c o m / d e s i g n e r s / L u k a s z _ D z i e d z i c / C o p y r i g h t ( c ) 2 0 1 0 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c ( h t t p : / / w w w . t y p o l a n d . c o m / ) w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 ( h t t p : / / s c r i p t s . s i l . o r g / O F L ) . h t t p : / / s c r i p t s . s i l . o r g / O F L �� �r t
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � b c � d � e � � � � � � � f � � � � g � � � � � h � � � j i k m l n � o q p r s u t v w � x z y { } | � � ~ � � � � � � �
� � � � �
� � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � !"#NULLuni00A0uni00ADmacronperiodcenteredAogonekaogonekEogonekeogonekNacutenacuteSacutesacuteZacutezacute
Zdotaccent
zdotaccentuni02C9EuroDeltauni2669undercommaaccent
grave.case
dieresis.case macron.case
acute.casecircumflex.case
caron.case
breve.casedotaccent.case ring.case
tilde.casehungarumlaut.case
caron.salt �� � � � �� �� ����V��������V� ,� `f-�, d ��P�&Z�E[X!#!�X �PPX!�@Y �8PX!�8YY � Ead�(PX!� E �0PX!�0Y ��PX f ��a �
PX` � PX!�
` �6PX!�6``YYY� +YY#� PXeYY-�, E �%ad �CPX�#B�#B!!Y�`-�,#!#! d�bB �#B� *! �C � �� +�0%�QX`PaRYX#Y! �@SX� +!�@Y#� PXeY-�,�C+� C`B-�,�#B# � #Ba��b�`�*-�, E �Ec�Eb`D�`-�, E � +#�%` E�#a d � PX!� �0PX� �@YY#� PXeY�%#aDD�`-�,�E�aD-� ,�` � CJ� PX � #BY�
CJ� RX �
#BY-�
, � b � c�#a� C` �` � #B#-� ,KTX�DY$�
e#x-� ,KQXKSX�DY!Y$�e#x-�
,� CUX� C�aB�
+Y� C�%B� %B�
%B�# �%PX� C`�%B�� �#a� *!#�a �#a� *!� C`�%B�%a� *!Y� CG�
CG`��b �Ec�Eb`� #D�C� >�C`B-�,� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,� +-�,�+� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-� ,�+-� ,�+-� ,�+-� ,�+-� ,�+-�!,�+-�",�+-�#,� +-�$, <�`-�%, `�
` C#�`C�%a�`�$*!-�&,�%+�%*-�', G �Ec�Eb`#a8# �UX G �Ec�Eb`#a8!Y-�(,� ETX ��'*�0"Y-�),�+� ETX ��'*�0"Y-�*, 5�`-�+, �Ec�Eb� +�Ec�Eb� +� � D>#8�**-�,, < G �Ec�Eb`� Ca8-�-,.<-�., < G �Ec�Eb`� Ca�Cc8-�/,� % . G� #B�%I��G#G#a Xb!Y�#B�.*-�0,� �%�%G#G#a�E+e�.# <�8-�1,� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# �C �#G#G#a#F`�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba# �&#Fa8#�CF�%�CG#G#a` �C��b`# � +#�C`� +�%a�%��b�&a �%`d#�%`dPX!#!Y# �&#Fa8Y-�2,� �& .G#G#a#<8-�3,� �#B F#G� +#a8-�4,� �%�%G#G#a� TX. <#!�%�%G#G#a �%�%G#G#a�%�%I�%a�Ec# Xb!Yc�Eb`#.# <�8#!Y-�5,� �C .G#G#a `� `f��b# <�8-�6,# .F�%FRX <Y.�&+-�7,# .F�%FPX <Y.�&+-�8,# .F�%FRX <Y# .F�%FPX <Y.�&+-�9,�0+# .F�%FRX <Y.�&+-�:,�1+� <�#B�8# .F�%FRX <Y.�&+�C.�&+-�;,� �%�& .G#G#a�E+# < .#8�&+-�<,�%B� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# G�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba�%Fa8# <#8! F#G� +#a8!Y�&+-�=,�0+.�&+-�>,�1+!# <�#B#8�&+�C.�&+-�?,� G� #B� .�,*-�@,� G� #B� .�,*-�A,� �-*-�B,�/*-�C,� E# . F�#a8�&+-�D,�#B�C+-�E,� <+-�F,� <+-�G,� <+-�H,�<+-�I,� =+-�J,� =+-�K,� =+-�L,�=+-�M,� 9+-�N,� 9+-�O,� 9+-�P,�9+-�Q,� ;+-�R,� ;+-�S,� ;+-�T,�;+-�U,� >+-�V,� >+-�W,� >+-�X,�>+-�Y,� :+-�Z,� :+-�[,� :+-�\,�:+-�],�2+.�&+-�^,�2+�6+-�_,�2+�7+-�`,� �2+�8+-�a,�3+.�&+-�b,�3+�6+-�c,�3+�7+-�d,�3+�8+-�e,�4+.�&+-�f,�4+�6+-�g,�4+�7+-�h,�4+�8+-�i,�5+.�&+-�j,�5+�6+-�k,�5+�7+-�l,�5+�8+-�m,+�e�$Px�0- K� KRX��Y� c �#D�#p�E �(`f �UX�%a�Ec#b�#D� *� *�*Y�( ERD� *�D�$�QX�@�X�D�&�QX� �X�DYYYY������ D share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf 0000644 00000270714 15173517750 0024225 0 ustar 00 GPOS�jN� K�GSUBV.T L� OS/2�8� M� `cmapRԟ� N@ �cvt &�7 g| 8fpgm� zA g� �gasp gt glyf�i� S( ��head�DeJ 6hheaix �� $hmtxESvJ � Tkern�2�� �l l�locaK�p� PP ,maxp>
� R| name�
U� R� :post:�\� c� �prep�x9� qH �
0 J DFLT latn �� �� kern kern Jn v �$R�
�^� h
B
l � & ��rj����Z ���j��L�� * | � D V � : � � �!.!�##L#�$4$~%�&J'$'�(�)�*�+f+�,6,�-�.(.�/t/�/�0:0|2"2�33T3�3�4&4l4�55b5�66L6�6�7B7�7�888�9d9�9�:&:�:�;@<�=�>j?,?�@hA�B�CzD�E�F�G*G�HfI� K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V - �
�
� �v #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�y ?�L Y�� Z�� \�� l� m�v o�v r� y�v |� }�v ��� ��� ��� ��� ��� ��� ��� ��y �� �� �y �v �v � � � � �v �v �v �� ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� - �
�
� �v #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�y ?�L Y�� Z�� \�� l� m�v o�v r� y�v |� }�v ��� ��� ��� ��� ��� ��� ��� ��y �� �� �y �v �v � � � � �v �v �v �� k 7 ��
7
7 �G �� �G �� �� �� " < #�� $�� &�� *�� -�o 2�� 4�� D�� F�� G�� H�� I�� J�{ P�� Q�� R�� S�� T�� U�� V�� W�� X�� Y�� [�� \�� ]�� l 7 m�� o�� r 7 t F u F w�� y�� { F | 7 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� � � � 7 � 7 �G � 7 � 7 �G � � � � 7 ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V
�e m�e o�e y�e }�e �e �e �e �e �e ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� 4 �� �L �L �� �� �� " $�� -�. F�� G�� H�� P�� Q�� R�� S�� T�� U�� X�� w�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �L �L ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� 1 �� #�� &�� *�� 2�� 4�� F�� G�� H�� I�� R�� T�� W�� Y�� Z�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� I ��
��
�� 4 �$ 4 "�� #�� &�� *�� 2�� 4�� 7�[ 9�V :�y <�= ?�V F�� G�� H�� R�� T�� Y�� Z�� \�� l�� m�$ o�$ r�� t�B u�B y�$ {�B |�� }�$ ��� ��� ��� ��� ��� ��� ��� ��= ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �= �$ �$ �� �� � 4 �� �� � 4 �$ �$ �$ ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� . �� � � �� $�� -�V D�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� #�� &�� *�� 2�� 4�� 7�� 8�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� [ �� �L �L �L �� �` �` #�� $�� &�� *�� -�8 2�� 4�� D� F�) G�) H�) J�> P�` Q�` R�) S�` T�) U�` V�D X�` Y�L Z�t [�g \�L ]�� m�L o�L w�` y�L }�L ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� ��) ��) ��) ��) ��) ��) ��` ��) ��) ��) ��) ��) ��) ��` ��` ��` ��` �� � �� �) �) �` �� �) �L �L �L �L �L �L �L ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� k 7 ��
7
7 �G �� �G �� �� �� " < #�� $�� &�� *�� -�o 2�� 4�� D�� F�� G�� H�� I�� J�{ P�� Q�� R�� S�� T�� U�� V�� W�� X�� Y�� [�� \�� ]�� l 7 m�� o�� r 7 t F u F w�� y�� { F | 7 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� � � � 7 � 7 �G � 7 � 7 �G � � � � 7 ��� I 7 ��
7
7 �� �� �� �� " % $�� -�� D�� F�� G�� H�� J�� R�� T�� V�� l 7 m�� o�� r 7 t 7 u 7 y�� { 7 | 7 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� � 7 � 7 � � 7 � 7 � �� �� �� � 7 ��� 1 �� #�� &�� *�� 2�� 4�� F�� G�� H�� I�� R�� T�� W�� Y�� Z�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� i �t
�y �` �y �t �� �� " % #�� $�t &�� *�� -�8 2�� 4�� D�� F�` G�` H�` J�[ P�� Q�� R�` S�� T�` U�� V�� X�� Y�� Z�� [�� \�� l m�` o�` r t - u - w�� y�` { - | }�` ��t ��t ��t ��t ��t ��t ��t ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��` ��` ��` ��` ��` ��` ��� ��` ��` ��` ��` ��` ��` ��� ��� ��� ��� �t �� �� �` �` �� �� �` �` �` � � �y � � �y �` �` �` � ��t 0 �� " % #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� K
K
K �y �y l K r K t d u d { d | K � K � K �y � K � K �y � K ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ���
�� �� D�� ��� ��� ��� ��� ��� ��� ��� �� � � $ �� �� �� �� $�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� � � ��� �� �� �� �� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� $ �� �� �� �� $�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� � � ��� " #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V �` �` $�` 9 F : F < ( ? F ��` ��` ��` ��` ��` ��` ��` � ( �` � ( ��` �` �` $�` 9 F : F < ( ? F ��` ��` ��` ��` ��` ��` ��` � ( �` � ( ��` ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� �` �` $�` 9 F : F < ( ? F ��` ��` ��` ��` ��` ��` ��` � ( �` � ( ��` K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V
�e m�e o�e y�e }�e �e �e �e �e �e ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� �� �� �� �� $�� ��� ��� ��� ��� ��� ��� ��� �� �� �� ��� i �t
�y �` �y �t �� �� " % #�� $�t &�� *�� -�8 2�� 4�� D�� F�` G�` H�` J�[ P�� Q�� R�` S�� T�` U�� V�� X�� Y�� Z�� [�� \�� l m�` o�` r t - u - w�� y�` { - | }�` ��t ��t ��t ��t ��t ��t ��t ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��` ��` ��` ��` ��` ��` ��� ��` ��` ��` ��` ��` ��` ��� ��� ��� ��� �t �� �� �` �` �� �� �` �` �` � � �y � � �y �` �` �` � ��t ) �� ��
�� ��
�� �� �� �� $�� 7�� 9�� ;�� <�� =�� ?�� @�� `�� l�� r�� |�� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� �� �� �� ��� ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ���
�e m�e o�e y�e }�e �e �e �e �e �e ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� �t
�t
�t �o 9�j :�� <�y ?�j Y�� \�� l�t m�o o�o r�t t�� u�� y�o {�� |�t }�o ��y �y �o �o �t �t �t �t �o �o �o ��t ��
��
�� Y�� Z�� \�� l�� r�� t�� u�� {�� |�� � � � � ��� ��
�� ��
�� 9�� :�� ?�� @�� Y�� [�� \�� `�� l�� r�� |�� � � � � ��� i �t
�y �` �y �t �� �� " % #�� $�t &�� *�� -�8 2�� 4�� D�� F�` G�` H�` J�[ P�� Q�� R�` S�� T�` U�� V�� X�� Y�� Z�� [�� \�� l m�` o�` r t - u - w�� y�` { - | }�` ��t ��t ��t ��t ��t ��t ��t ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��` ��` ��` ��` ��` ��` ��� ��` ��` ��` ��` ��` ��` ��� ��� ��� ��� �t �� �� �` �` �� �� �` �` �` � � �y � � �y �` �` �` � ��t 0 �� " % #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � 0 �� " % #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � 0 �� " % #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� V�� Y�� \�� m�� o�� y�� }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� � � � � � ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V - �
�
� �v #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�y ?�L Y�� Z�� \�� l� m�v o�v r� y�v |� }�v ��� ��� ��� ��� ��� ��� ��� ��y �� �� �y �v �v � � � � �v �v �v �� K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V - �
�
� �v #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�y ?�L Y�� Z�� \�� l� m�v o�v r� y�v |� }�v ��� ��� ��� ��� ��� ��� ��� ��y �� �� �y �v �v � � � � �v �v �v �� ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� ' �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� K �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V 6 �V
�V
�V �� "�� #�� &�� *�� - - 2�� 4�� 7�� 8�� 9�� :�� <�t ?�� Y�� \�� l�V m�� o�� r�V t�` u�` y�� {�` |�V }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��t �� �� �t �� �� �V �V �V �V �� �� �� ��V v
# $ & ' ) - . / 2 3 4 5 7 8 9 : ; < = > ? D E H I K N P Q R S U Y Z [ \ ^ l m o p r t u y { | } � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � �
8 � DFLT latn �� �� case &case ,liga 2liga 8sups >sups D , > B
@ L O , { t u C j q v � � � � � � � I �, x x � D�� �P `K tyPL @ �J�z��� � �� � &
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � r d e i � x � p k � v j � � � s g w � � � � � l | � � � � c n � � � m } � b � � � � � � � � � � � � � � � � � � � y � � � � � � � � � � � � � � � � � � � � � q � � � z � � � ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ ` T @
~ �1DS[a~����� " & 0 : D �!"!&"""""" "+"H"`"e%�&i���
�1ARZ`x����� & 0 9 D �!"!&"""""" "+"H"`"d%�&i��� �������������{�u�q�[�H����$��������������I�����������������ޡޞ�:ڜ / �� ' 3 7 ; �� BK� PX@3 ` f [ [ Q C Q
D@4 h f [ [ Q C Q
DY@
;:$$#, $
+>32 #'&>54.#"#"'4632#"&!!7!!3<G*6]E'!1:3%
A 1;2" /?#.B.{,! ,, !,����]#[��n$ ;S47O;-('rz /**5C/$8' �� .. ..��y$? ����
&@# Q C S D
+#.54>32 #"&tA1!""'5���-PS\88\SP-<��""!5 ��)�
,@)
B Q D
$+#"&/!#"&/ u ��ܙ�$�ܙ�$ V <� 6 : ��5BK�-PX@(
Y C Q
C
D@&
Z
Y C
DY@ :987 6 6421/-,(&#"!#!+#"&547!+#"&5<?3#76;>;!323+32%!!�^)V��V*^��R�(�W*_*_* W�(�R� ��*R����E��m�
�&!��F� �p&!�{,F� ���
\ ; F Q �@ )
!
LA*7 BK� PX@2 j
h
f _
SC T D@1 j
h
f k
SC T DY@NMCB;965$#$ +.'7632 .54>?>; #".' +4.'> ��H &4EX8 D�e>4e�_ $ e�?
'?]A /_WJ7 :m�f
$�2Tm< P}U,��,Lc8 LqL&bP'!'#|4QwZE�e>��K?"!(%�� (4G[<V�sF�
�B\@+��7Yu�>X?-(0K` W���� ' 0 D X ?@< [ [ C S C
C S DUS((%"&((($
+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>�0Rl<>mP..Pm>>lQ/L#=Q--P<##<P--Q=#eC�
D�0Ql<>mP..Pm>>lQ.L#<Q--Q<##<Q--Q<#3W�X--X�WX�Y--Y�XMnG!!GnMMmF!!Fm�
��PW�X--X�WX�Y--Y�XMoG!!GoMMmF Fm j��T� @ R S@PN9K*$B h f S C
C S D GE0.'%!
@@+2 #"&'.#">7>;#"&/#".54>7.54> 32>7&'�CxY5
":W;<bF'TX�-5 7C>*Y�-l~�OK�sG4Z|HGG3^���;^s8F}m[&�5BkJ(�.Ng8 D<*%C\7R�V�HH�I
^�[���4X?$2a�ZH�mVP�VFwX2��MrM& 9N/� N_n ���
@ B Q D
$+#"&/ ��ܙ�$ ����� �(+.54>7�yx*Mi@ @iM*
wyv�e�
v���uu���v
��e b���� �(+4'&54? '&5476Zyw
*Lj@ @jL*xyv���
v���uu���v
�� {��� 5 1@.1-,($#
B M Q E 5 5+5467'7>7./7 .=3>? '.' t ����4 ����
�� m,n
n-n
�� m-m
n-n � m �� ,@) M YQ E +!!#!5!i��QN�R���=I�;�I� n� � @ B ? S
D"+74632'&5467>7#"&n0'+/(8"
%/U#2;0)URL
'5@$2 d)5z @ M Q E+!!d�/zQ i��" � @ S D($+74>32 #"&i!""'5M""!5 ������ @ k D""++6;[ 'n')-�% I��?� ' @ S C S D((($+#".54>32 4.#" 32>?P��ii��OO��ii��PdBo�RR�pBBp�RR�oB�WW����WW����HH���GG�� � � *@'
B h C R
D%+%!47#"/3!!5E��
�J5�'J|"&�� (i��J � � 2 >@;. Bh S C Q
D -,+)$"
22+2 >3!2 !5467>54.#"#"&#'>ZQ�pB1To=�E E#c�o �<fK+4Wq>CqW9
0 Kr��/_�`P�~w>�<8" �=rtzENsJ$)Ie<#[�b3 ���� H U@RD
B h h [ S C S D B@;910/.&$ HH +2 #".'7632 32>54.#5>54.#"#"/>eQ�m?+Kf<��Fz�ay�h:& #4KeBZ�[-)`�s\�^02Tp=CpV: 1
Jr��-Z�XEoT9 ��W�l=Ah�@
599- <]s6ApQ/E-NlAKnH"(He>#[�b3 ? ^� @ [ C
D!#+!+#!"&/3467![
�V�e �UV��^�4
�j�
/��&�� ����� / @@=-,B h [ Q C S D(#&(#"+#!>32 #".'7632 32>54.#"'!� � UCx7n�q:N��d;j^N
1MiFR�i;-[�^9�H>o|^�(?q�\p�|B#.' $ 5d�]L�[3s ���� 0 2@/B [ C S D -+#! +2 #".54676;> 32>54.#"t[�o?E{�gc�u@T`�"T�Z 4;���1Z�QV�a43]�NX�`2N<m�``�vB@x�mSт��)H#=E�]O�a66_�MQ�[1=a| � /� @ Q C
D #'++67!"&=/�wA�
�� �+ �� = x��� ' ; O D@A
B [ S C S D=<)( GE<O=O31(;); '' +".54>7.54>32 '2>54.#" 2>54.#" Df�yD-RqD>`A"9j�_^�k9"B`>DqR.Dy�fQ�`4Dj�<<�jD4_�QQwN%*QuKKvQ*%Nw6f�ZNzZ<>Vi<K�b88b�K<iV><ZzNZ�f6L-StG]|J J|]GtS-�1Sj9=iN,,Ni=9jS1 � � 2 2@/ B [ S C
D /-%# +".54>32 +>74.#" 32>=W�k<Cx�b^�q?-@)��"V� 3:�"2Z{IN�]40W{KU�\/Z9j�\[�rA@u�d7ddi<��H*K#@F�M�[32Z}KN}W.:^u ���J� # ;K�#PX@ S C S D@ [ S DY�(&($+74>32 #"&4>32 #"&�!""'5!""'5M""!5D""!5 ��J� - H@
(B ?K�#PX@ S C S
D@ [ S
DY�,*$($+4>32 #"&4632'&5467>7#"&�!""'50'+/(8"
%/j""!5�#2;0)URL
'5@$2 � �5 �(+ �� ��!'* ) ���A �� �� A� ���e !@ Y M Q E+!!!!�;��;��,J�J � �5 � (+546767.'&=� * ("��� A
A�) !���� ( : 9@6 B h f S C S D(&#- $+>32 #'54>54.#"#"'4>32 #"&!DQ`8F|]7/HTI3 A0GSG0*H^3BaB&�!""'5 2'*NqFLnS?78"��)>:<KbC6U; #+# �i""!5 l�3 N a f@c
U
8B h [
[ [ O S GPO YWOaPaFD<:641/'% NN
+%"&'#".54>32 32>54.#"3267632 #"$&546$32 %2>7.#" �XY8�R8R6A}�t5]%[ %09hP/a��}���mq����d
p����zv�����q:e���$MG>P3"Z�g9(;�]W]S'D\5U��V��.I ,7 <o�b�ݒHj�������]DA%JPi�%�� �wS��m��HF?kS6Iv�K(E2 ��
$@!B Z C
D# +!#"&'!+3!.'�O��I�NCf��z�� ��e ��{�++ � z� * =@: B [ S C S
D *(" !+3!2 #!2654.#%!2>54&#!��y�t9'JkE��@z�q��c��3`�Y��3b�Y*�����0]�U8hXA��Z�d5�����CkK(K2Rh7�� |��� 2 D@A B h f S C S D ,*" 22+%2 #".54>32 #".#" 32>7>�
(,h{�X���be���M�ob/ +=TnF�WV��yLwdV* �+/K5 g� ��
�i+@*- % Y�뒖�W(:' � y� @ S C S
D!(!$+#!!2 4.#!!2>yb��������bjR�Ҁ�c��ҕRĤ���b�b������T� T�� � "� .@+ Y Q C Q
D +!!!!!"�l����U��S��U� � "� (@% Y Q C
D +!!!#"���{g�U��U�v� |��C� 4 H@E!
B h [ S C S D ,*%# 44+%2>7!"&=!#".546$32 #"'.#" 2Ixg]/�� �5r��Y���dd��Q�vf/ 9a�h�ޝUV��C +} 8� %:'g� �� �g+?),,0&X�쓖�X � � @ Y C
D+!#!#3!3g��ggvg��Z��l� � ^� @ C
D+!#3^gg� Y���� '@$ B h C S D#'$+#"&'>7>32 32>53�;m�b-\1 #- LzV-g�w�|? 0c�f� � � " &@# B [ C
D'(' +32>7>; #"&'.+#3VT ;S�� !�S �� [ff� K
���X d �V� � �� @ C R
D+%!!38���fWW� � H� %@" B h C
D!5(+>7>;#47+"'#32z
,GZ����YF;� �
�y� �#� �J�
�( � � @ C
D!+2&53#"'#3 �Z1�hY2� �6 ��y� �Y� {���� ' @ S C S D((($+#".54>32 4.#" 32>�b������cc������bjR�Ҁ~їSS��~�ҕRĤ���gg� �� �hg������WW�씕�VV�� � S� *@' [ S C
D
!+#!2#%!2>54&#!Vfm��E��u��^�g7���:�����]�q?R4\}J�� {���� 0 T@
BK�PX@ S C S C D@ k S C S DY�(((%&+#"&'#".54>32 4.#" 32>�+PsHpV ��?�N���cc������bjR�Ҁ~їSS��~�ҕR�k��~-�v F g� �� �hg������WW�씕�VV�� � �� " 2@/ B [ S C
D " *!+#!2#"&'.#'32>54&#!Vfi��8i�]�Y �;')��^�g6ƽ��������Q�eA
�� >L-TvJ�� W���� = =@:= B h f S C S D;9(&! #!+#".#" #"&'7632 32>54.54>32~
)FiMMuO)=d�d==t�l��L (8J`=T�[0=d�d=6h�bn�H�%-&,Ld7H^B-,5PuWY�tCcV,#)#3XyEKaA,*4Qy[G�e=FH # n� @ Q C
D +!#!5n�f� �W��0W ���� #@ C S D +%2>53#".53 �f�p;fJ��||NjJg;o�IG~�ck��u˗VV��uk��c�~H �� @ B C
D* +3267>;#Q� �P��[� �j.46,� �y �� ' @ # B C
D,; +32 >7>;2 >7>;#&'#U e
� � eN�C\�^�][��u..� �u,-� �y��4 �� @ B C
D(")!+ 32>7>; #"&'+�e
��
b��e�B
�J ]�� ��L
�T�%��� �� @ B C
D,"+#32 >7>;�g��Y��ZH��H?
�v++� s ��
$@! Q C Q
D
+!!547!5��~��� ����#�U%�U �����
'@$ [ O QE
!#+!+32 �>�����$
��
$ ������ @ k D" +32#"&')'n' �%�" k����
!@ [ O Q E!"+46;#"&=!!k��=���
s
$� � �� @
B k D,!+3#"&'.'+ <UD �
�
G���
� �L ���3 @ M Q E +!5���DD V��� @ k D +2 #"&/� �6 ���
� k��C� ' 7 T@Q -B h [ S C
C S D)( /.(7)7" ''
+!"/#".54>754&#"#"/>32 %2>7 )QXf=3`J-H��wuHeF,
N�mPxO(�J:aSH#�ͅ?!6H (@, >aD?lP0h��(0( NP3_�S�x5->$#<S52I/ ����� # �K�%PX@
B@
BYK�%PX@ CS C SD@! CS C
C S DY@ ## &#+33>32#"&'#" 32>54&�`B�m��9o�ih�6hc�?9�ZX�Y-����Xf��m��PQOz�f[��VE@u�b�� X��X� , 9@6, B h f S C S D(&#(#"+#".#" 32>32 #".54>321
#:W>V�[01Z�NHa?%
FXg8_�q?<s�la�8^ =r�ei�o:"("
4&E��yr��K>5 W���� # q@
BK�%PX@ C S C S
D@! C S C
CS DY@ ##
+!"/#"&54>323%267.#"c
B�n��9o�ie�6`�^c�?:�XX�Y-��Zj��m��PKHN�Q@f[
UF@u�b�� X���� % 0 H@EB h [ S C S D'& ,+&0'0 %% +2 #! 32>32 #".54>"!4.T�i;
�14`�TKnK,
Oao8f�xA=s�kMzY7 �,Pp�:o�ip�s:!)!
4%G��k��JG0Z~NPX/ n� _�BK�!PX@ S C QC
D@ [S C
DY@ !$%! +3'&=354>32#"&#" !!nj �,PqD ? ) 1S<!C��{ '~U�V+
. @gK{G�� K���� : P d �@3B+BK�PX@,
[ [ C S C S D@/ h
[ [ S C S DY@ RQ \ZQdRdMKA?$" :: +23 #"' #".5467.54>7.54>4.' 32>2>54.#" �Ao,� � 4]�OVF*0<c�c<>u�gi�k6h[2; - GO3]��1Rkuv3&A.-W~RL�a7��@dD#$Ec??dE$$Ed� ! &_6HuS.B +.-QC>rX5+I`6Or @9.-()�[HuT.��/9
'1;#,K7 ">V.%B\88]B$$B]88\B% � �� -@*B C S C
D ##+33>32 #4&#"�_E�nR}R*_��b�B���Ue4b�W��|��eX� � G� &@# S CC
D
+##".54>32 _� � �W !! ���G� ' 4@1 B S CC S D $" !$%+#"&'76323265#".54>32 ;Y< .
QN� �4XA%
0 XQbW !! � �� 0@- B [C C
D %(%!+3267>; #"&'.+# .� T�I
�S �^ -`���{ �_
�
�
�
� � � @C
D +# _��Q� � �� , 8@5 +
B CSC
D , ,##&&! +332 >32>32 #4&#"#4&#"�4 BKU/m�ATc4JvS,`~u4_I+_toQ�6��)D1q>Z; 1`�Z��|��&KpJ��|��aV� � �� 1@. B C S C
D #$!+332 >32 #4&#"�4 D�oR}R*_��b�B��Vi4b�W��|��eX� W���� ' ,@) S CS D '' +2 #".54>2>54.#" k�t==t�kk�u==u�kY�Y,,Y�YY�Y--Y��I��uu��HH��uu��I�K=r�dc�s>>s�cd�r= ����� $ D@A B CS C S CD $$ &%!+32 >32#"&'" 32>54&�4
B�n��9n�if�6Bc�>9�YX�Y-���C �Zj��m��PJI�g\��VF@u�b�� W���� # D@ABC S CS C D ## &#+##"&54>32763267.#"�`B�l��9o�ig�6 ��c�?6�YX�Y-��Xf��m��PNLp�]f[RH@u�b�� � �� 8@5 B h C S C
D #$%!+332 >32#".#"�20�u-L"
!0 q�-��y�B
���y Y���� < =@:< B h f S C S D:8'%" #!+#".#" #"&'7>32 32>54.54>32� #9S<6Y?#0NchcN0/Y�Si�<
&=[C?`@!0NcicN0.UzL[�;h 4E&/>, ':T<ApR0C6" % #<Q-2B. &:S>5bJ,46 4���@ # x@
!BK�PX@% j hQC S D@# j h[ S DY@
## +"&5#"&=7>;!! 32>32 �eq� �
-9��%2 $4&&upu� % d ��G�]);&
**3 ����� -@* BC
C S D $!#+32673#"/#".5逃a�C`5 E�oS|R*���cX� �Vh4b�W| �� @
BC
D,!+!#32 >7>;T�\KH
J H� ��*+
�� * @ # B C
D*!); +32 >76;2>76;#"'.'+I� ' �F��F����C� ��**��-*+� ( �� # v� @ B C
D("(!+ 3267>; #"&'+���[
$
X��j[��
�� U�� �Z� � ����h ���� @ BC D,""++32 >7>;{D��[OO K I���� ��
J :�
@ Q C Q
D+!!547!5!:��d�)q������K&MK ?���� H 3@0* B [ [ O S G@>;83-+4.#52>54.54>;+" ;2 #".54>�):##:)&HiB7!+G3 )5 5) 3G+!7BiH&�!7)=)7!7hhi8=hM+* 8P19lii5%>. /=%5ijl81P8 *+Mh=8ihh ��Q� @ Q D+3#KK� i��� H 5@2 B [ [ O S GEDCB530-3)+ +546;2>54.54>7.54>54.+"&=32 3"}&HiB7 !+G3 )5 5) 3G+! 7BiH&)9##9)�7hhi8=hM+* 8P18lji5%=/ .>%5iil91P8 *+Mh=8ihh7!7)=)7 ���� 9@6 j k [ O S G
+2>53#".#"#4>32 %=*N <X83kib+&;*M <W84khb70B'7^F('0'0B'7^F('0' ���
&@# S C QD
+4>73 4632 #"&A�5'""'5��&-PS\88\SP-���'5""7 ���� 0 ; U@R 6&, B j h f k S C T D##'# +.54>?>; #".'>32 + M`�r>@{�s
$ W�5 !7P8+KfC' EXh:
$��/Y}N,\�a3 J��tp��M�
�:.! ��"' 1%�
�b�o@i?q� C Q� : @@=3)B h [ S C S
D#&#%&%" +46;4>32 #"'.#"!#!>3!#!5>5#C�4g�fLtW>&
->V<NuP(�
�?H?+�6"@2 ��&]�uC%@V0 ;.4]�O��' ��Yy+( A
(:N4F � ��D # 7 9@6! B
@ ? W S D42*( (+467'7>327 '#"&''7.7 32>54.#"�($�1�-n?>m-�1�$*)$�2�-n>>m-�1�$)H+Ic88cJ++Jc88cI+�>m-�2�$*)$�2�-n?>m-�2�$)($�2�-n?8bI++Ib88cJ++Jc U (� 8@5 B
Z Y C
D *! +!32 67>;!!!!#!5!5!�Z�ZO
Z
YP�Y[��n��_��n��h �g#!'� ��:v:��~:v ��Q� @ Y Q D+3#3#KKKK���� ��}k� H \ A@>H ZP= #B h f W S DFD-+(&! #!+#".#" #"&'7>32 32>54.5467.54>32 >54.'( #9S<8[@#2RhmhR2TR6C/Y�Si�<
&>\D>`B"4VmqmV4[g7E.UzL[�;��'CX`c-G>$=QZ]+YJ
5F'.D7.07F]>S{#&bEApR0C6" % "<Q/3L;004EY=M{%%cJ6aK,55��)A5-*+ `=-F7,)'&^ '�"W ' 3K�PX@
S D@ O S GY�((($+#".54>32 #".54>32 �
W
U���� , H \ �@
BK�PX@4 h f [ [ S C S DK�PX@4 h f [ [ S C S D@4 h f [ [ S C S DYY@
YW*,((#&(%!
+632 #".54>32 #".#" 3264>32 #".7 32>54.#"8 ;�t`�s@Cx�c4WJ@
!:[DS�a55^�MU{�S4]���dd���]44]���dc���]4;g���hh���g�
;FAv�fd�wB )! 5b�WZ�a3)Pc���^44^���cd���^44^���d��hh���ii�� j>5� & 4 B@? ,B h [ W S D('.-'4(4$##' +#"&/#".54>754&#"#"/>322>75 5
15=$!<. *]�iDI+;( 0jCeh��!81+��!*G D$
%9'$A1 3LO
0-ub��"�D8' � ��� % �%(+55�� �
� � �
�
z
�� ��
{
z
�� ��
�S�� =K� PX@ _ M Q E@ k M Q EY�+!#!�=R���' d)5z @ M Q E+!!d�/zQ U���� / F O ��:BK�PX@/h [
[ S C S DK�PX@/h [
[ S C S D@/h [
[ S C S DYY@00OMIG0F0E)!(*,& +4>32 #".7 32>54.#"#32 #"&'.#'32654&+U4]���dd���]44]���dc���]4;g���hh���g�U����u P
��n�ywlv��c���^44^���cd���^44^���d��hh���ii��yusvd���
_
@a[\T �5% @ M Q E+!!!��%A [D�� ' @ W S D((($+4>32 #".7 32>54.#"[/Qn??nQ//Qn??nQ/G$>T00T=$$=T00T>$n>mQ..Qm>>lQ//Ql>0T>$$>T00T?$$?T m P� 7@4 Y Y M Q E
+!!#!5!!!i��QN�R��R��U��jI�n�I��I a�;W - g@
+ BK�#PX@ h [ S D@! h [ O Q EY@ (&#!
--+2 >3!2 !546?>54.#"#"&/>V,N9!*8 �'�&� 1%'4 >H |W1I0(E?; �*� 89< #4"G7`f b|=W ? �@=BK�PX@, h h [ [ S D@1 h h [ [ O S GY@ ;964.-,+#! ?? +2 #".'7>32 32>54.#5>54.#"#"/>\,L7 H<IM%@V0<Q7! $;-)>).J5[Y'3 ?I{W/C+BWTB0M7 3C$
(% *4!4%1K?"2!A;`f ��� @ kD #++7>3� 9� ��
� ����� 0@- BC S
C D &$!#+32673#"/#"&' #"&5逃a�C`5 F�fb�%0���cX� �X\MH+X$�� 6�B�� *@' hi S D +##!#".54>3��U��Vg�r==r�g�R�
�
y8b�MP�\2 ��o� @ O S G($+4>32 #".�$& &$P& &%% ���� V@
BK� PX@ ^ j T D@ j j T DY@ +2 32654.'73 #"&'76�( 390A'*= Y]1D()N
��
,&! �`<; 0! ��5R O� BK�PX@ j j Q D@ j j M R FY�$+37#"/733!��� �:���� %~ ��c1 W;�� )@& W S D +2 #".54>2654&#"wBjJ''JjBDjK''KjDhiihkii�*OoEEoO**OoEEoO*��rq��qr� � ��� ) �' (+7'&547>7.'&54?'&547>7.'&54?� � � � � � � &
% ��
�� &
% ��
� q� # - O@L! B h Z
[ C S
D-+(&#" $!"
+%3+#5!"/3%37#"/733!47!+>;�~m?��`C���� �:����� �� (
*�$�� �# %~ ��c1w �}�
d � K� - = G e@b710+ B h h Z [ C S
D GEB@=<;:9853/.(&#!
--
+2 >3!2 !546?>54.#"#"&/>%37#"/733!+>;f,N9!*8 �'�&� 1%'4 >I|���� �:���� (
*�1I0(E?; �*� 89< #4"@>`f %~ ��c1�b
d S q� P U _]@N
$S BK� PX@B
h h
[ [
\ S C S
DK� PX@B
h h
[ [
\ SC S
DK�
PX@B
h h
[ [
\ S C S
D@B
h h
[ [
\ SC S
DYYY@!_]ZXUTKHEC=<;:20)' PP!"+%3+#5!"/32 #".'7>32 32>54.#5>54.#"#*.'>47!+>;�~m?��`C�Z,L7 H<IM%@V0<Q7! $;-)>).J5[Y'3 >J {��� �� (
*�$�� ��/C+BWTB0M7 3C$
(% *4!4%1K?"2!G5`f�� �}�
d *���� ) ; 5@2 B h f S C T D('#- $+#".54>?3 32>324>32 #"&�DQ`8E}]70GTJ3 A0GTG0*H^3E_@$
��!""'5�2')MoGLkM924#��*<45E]B6U; #+#O""!5 �� ��& $ [ �� ��& $ [ �� ��& $
` �� ��& $ ` �� ��& $
` �� ��& $ ` �� �� 4@1 Y Y Q C S
D" +!!!!!!!+!����Hj��K��8���
O� i �U��S��U��c7. |��� O h@e <B
M B h f
h S C SC S D KIA@:820(&! OO +2 32654.'7.54>32 #".#" 32>7>32 #"&'76�( 390A'$��Ze���M�ob/ +=TnF�WV��yLwdV*
(,ey�UY]1D()N
��
,&! sn���
�i+@*- % Y�뒖�W(:'+.J5 K<; 0! �� � "�& ( Z �� � "�& ( Z �� � "�& (
_ �� � "�& (
_ �� ��& , �� � N�& , �� E�& ,
�� N�& ,
1 �� ! ,@) Y S C S
D!%(!+3!2 #!#%4.#!!!!2>1����bb������R�Ҁ�c��l��ҕR��b��������b���T��@��T�� �� � �& 1 � �� {����& 2 � �� {����& 2 � �� {����& 2
� �� {����& 2 � �� {����& 2
� � ��D � (+ ' 7 �t3����4u��5pn ����4t��4vp6��o {���� ! - 9 b@
21&% BK�PX@ k C S C S D@ j k S C S DY�**%(%$+#"&'+7&54>327>;.#"4&' 32>�b���s�Q�
,�lwc���y�So 7�eo�$^U�G�j~їSrVN�E�d�ҕRĤ���g=9��` �� �hC?��`�갠�R�9<W�씘�R�35V�� �� ����& 8 � �� ����& 8 � �� ����& 8
� �� ����& 8
� �� ��& < / � S� .@+ [ [ C
D
!+#3!2#%!2>54&#!Vff��E��u��^�g7��� �������]�q?R4\}J�� ��'� J >@; B h S C
C S D ED?='%" JJ+2 #"&'7>32 32>54.54>54.#"#4>�U�Z./GRG/!7EIE7!2Z~Me�<
%<Y?;\?!;XfX;0ITI0 ?fIG}^6_Bu��3Qd2>\G87:%$1$ !)<S;DrR-C6" % #=R/CQ4&1K?1H>:DS8 I?*+X�^��e�o; �� k��C�& D C � �� k��C�& D v � �� k��C�& D � � �� k��Ci& D � � �� k��CW& D j � �� k��C�& D � � k���� B R ] �@:@ BK�1PX@5 h h
[ S C SD@? h h
[ S C SC SDY@&TS YXS]T]NLDC><7520-,$"
BB+2 #! 32>32 #"&'#".54>754&#"#"&/>32> 32>5"!4.�K�`7
�l0X|LGdD&
JZe4��/Uly7?lP.H��wuHeF, M�k~�/���ͅ?!<R1BtW2�HsR1V(He�<s�op�r:!'!
4%��MjB BhI@qV6E��)0)
NP�po��(BY58O2,U|O+4^�RU�]1 X��X� G h@e6:
E B h f
h S C SC S D CA9842/-%# GG +2 32654.'7.54>32#".#" 32>32 #"&'76�( 390A'%W�g8<s�la�8
#:W>V�[01Z�NHa?%
-�jY]1D()N
��
,&! vK��sr��K>5" =r�ei�o:"("
:NO<; 0! �� X����& H C � �� X����& H v � �� X����& H � � �� X���W& H j � �� " V�& � C� �� � ��& � v� ���� ��& � �� ���� �W& � j� Y���} 6 J 6@3<2B65@ [ S D87B@7J8J.,$"+&54?.'.546? 7 #".54>32 .'2>7.#" � ~<�J
Z�N�
r?iM*9r�s[�wD:o�g5kcV �n�9X�\2;XvLX�Y-7_}.
m!/<0� d/z��u��WAy�l`�I9X<��K��-E��t3fP2<j�R]�d5�� � �i& Q � �� W����& R C � �� W����& R v � �� W����& R � � �� W���i& R � � �� W���W& R j � m �_ # +@( [ Y O S G($(#+!!4632 #"&4632 #"&m��Uy5'""'55'""'5�I�'7#!5�_'7#!5 W���& , 6 =@:54%$
B j k S C S D.--6.6'%($'+ #"'+7.54>327>;.#"2>54'h<>=t�k�lQ
!&�DF=u�kX�7W 2��/0�-vKY�[.iY�Z.P�
WiC�vu��HOm�C�u��I1-t��h�9�*,?s���>r�d�s�]E�� �����& X C � �� �����& X v � �� �����& X � � �� ����W& X j � �� ����& \ v � ����� ! @@=B CS C S CD !! &#+3>32#"&'" 32>54&�_B�m��9n�if�6Bc�>9�YX�Y-�����Xg��m��PNL�g\��VF@u�b�� �� ���W& \ j � ��c� & / O@L,BA h Z C
C S D ('#! && +2 #"&54>7&'!+3"32>!.'F
T/L^'1��I�NCfC 23&@2 &�z���" KB 92*��e ��y/A'05 ��++ k���� B R n@k-H 6B h
h [ S C S C S DDC JICRDR?=1/*(%# BB +2 #"&54>7&/#".54>754&#"#"&/>32 32>2>7 �
T/L^)4
)QXf=3`J-H��wuHeF, N�mPxO(.(@2 &��:aSH#�ͅ?!6H�" KB ;3+ (@, >aD?lP0h��(0(
NP3_�S�x "-7 05 (->$#<S52I/ �� |���& & �� X��X�& F v � ��A� ' T@Q B
h Y Q C Q
C S D $" '' +2 #"&54>7!!!!!!#32>$
T/L^&1�RP�l���[.(@2 &�" KB 82+�U��S��U "-7 05 X���� C N g@d2B h h
[ S C SC S DED JIDNEN@>0.+)$" CC
+2 #"&54>7"#".54>32 #! 32>32 32>"!4.�
T/L^!+
f�xA=s�jT�i;
�14`�TKnK,
7EP*,&@2 &�MzY7 �,Pp�" KB 4/)G��k��J:o�ip�s:!)!
*" ",5 05 �0Z~NPX/ � � @C
D +# _� � : � #@ B C R
D+%!!54?3c� �r�����f��? ��WKeB
]� 9 � #@
BC
D +7#54?[� �_�����Y2 T���Z4Tv �� � �& 1 � �� � ��& Q v {��7� 4 �@
BK�PX@+ Y S C Q C S
DK�%PX@) Y S C Q C S
DK�)PX@3 Y S C Q C Q
C S D@1 Y S C Q C Q
C S DYYY@
1/%(%
+!!!!!#".54>32 !4.#" 32>7�l���%k��]�ߠYY�߇]��k%E��J��sr��KK��rs��J2��S��UNR�Y/f�
�� �h0Z�RM�=��XX�씕�WW�� W��W� 2 F Q a@^.
B h
[
S C SDHG43 MLGQHQ><3F4F,*"
22+2 #! 32>32 #"&'#".54>32>2>54.#" "!4.�K�`7 �l0Y|LCcE) JZe4��,*Ĕb�m::m�c��*E^x�ZR{R))R{RS|S))S|?HsR1W(Ie�<s�op�r:!)!
4%����H��uu��I��BjL)�K=r�dc�s>>s�cd�r=n4^�RU�]1 �� W���� & 6 �� Y����& V v � �� W����& 6 �� Y����& V � � �� ��& <
4 �� s ��& = h �� J :�& ] v � �� s ��& = k �� J :�& ] � � �� s ��& = k �� J :�& ] � � v���� # 2@/Y S C S D # #"" +#543>7'&=37>3#"!{` Dl�X$3`N7
_��ض$5`N7
e ��b�\+0 FpR
'���3 FpR�G �(� @ B k D* +#"/&'+73(A ��C�U� ��� �(�
@ B k D' +32 ?>;# C � �A�U� �
�� �� �5% q 5�� @ W D
+".53 32>53$B[9E(A00A)E9[�'DZ2%B2 2B%2ZD' ��}� @ S D($+#".54>32 } F !! xs�� =K�'PX@ W S D@ [ O S GY�$&($+4>32 #".732654&#"x/?##?/ /?##?/:@32@@23@$<++<$$;,,;$2@@22@@ ����
+@(B @ j S D +2 #"&54>732>�
T/L^ -8 1.(@2 &�" KB"=6,
"-7 05 &�*i QK� PX@ W S D@ [ O S GY@
+2673#".#"#4>32 �+,;%6"!;63*,=&6"";53 7/$?.!'!9-$?.!'! |��� #@ S D
#++7>3!+7>3�� *� R� /�
��
��
� .��s� \�BK�1PX@ SCS
D@ SC
CS DY@ !$## ++#!#"&'7632325#5463s�_�,mi 4
���$�e��=nt '��"
� �f @ M Q E+!!���fG � �f @ M Q E+!!���fG �!.� � (+.5467�L=&2#!&K&N�;3d6;= n� � (+ '&547>54'&547�L= &2#�&K&N�;2e6:= n� � � (+7 '&547>54'&547�L= &2#�&K&N�;2e6:= �!;� ) � (+.5467.5467�L=&2#�L=&2#!&K&N�;3d6;=&K&N�;3d6;= n'� ) � (+ '&547>54'&547% '&547>54'&547�L= &2#JL= &2#�&K&N�;2e6:=&K&N�;2e6:= n� ' � ) � (+7 '&547>54'&547% '&547>54'&547�L= &2#JL= &2#�&K&N�;2e6:=&K&N�;2e6:= ����� �@ BK�PX@ C CSC DK�%PX@Z C C D@ `Z C DYY@
#!""+463 632>72 !#"'!�M�S
R�N��
��� �
� ��
�� ����� - �@ &" BK�PX@/
`
[ CCSC DK�%PX@-
` Z
[ CC D@/`
` Z
[ C DYY@+)('%#! !"#+7!!5463 632>72 !!#.'#"'"&5�|��M�S
R�N��}N�R
S�M�� �
� �B �
� 1i| @ O S G($+4>32 #". .Pj<=lP..Pl=<jP.T=lQ..Ql=<iP..Pi i��� � # 5 @ SD(&(&($+74>32 #"&%4>32 #"&%4>32 #"&i!""'5�!""'5�!""'5M""!5'""!5'""!5 W��z� ' 0 D X l � K@H [ [ C S C
C
S
D}{sqig_]US((%"&((($+#".54>32 4.#" 32>>;+#".54>32 4.#" 32>%#".54>32 4.#" 32>�0Rl<>mP..Pm>>lQ/L#=Q--P<##<P--Q=#eC�
D�0Ql<>mP..Pm>>lQ.L#<Q--Q<##<Q--Q<# 0Ql<>mP..Pm>>lQ.L#<Q--Q<##<Q--Q<#3W�X--X�WX�Y--Y�XMnG!!GnMMmF!!Fm�
��PW�X--X�WX�Y--Y�XMoG!!GoMMmF FmMW�X--X�WX�Y--Y�XMoG!!GoMMmF Fm � ��� �(+5�� �
�
z
�� ��
� ��� � (+7'&547>7.'&54?� � � � &
% ��
�6 �� @ C
D#"+'+>;k (
*
d ��o� N [@X ; B h h
[ [ S C
S
DNMHGFEA?97$##%'$+3>32 #".#"!#!!#! 32>32 #".'#53.547# �Z��n@m]Q%
"1CY:Z�qJZ���
Hp�Z>_H4$
%$TfxFq��T���_�ҒN,A+# % ?z�v /2' |�~@%+% #.K5 N�ً;'10 HH� # C@@
B h S C S D # #!4%
+67>;#7+"'#32###5��
9>� �?9
�W�G��
l���,��z*�E?��x;��; h }� 7 1@.1 B S CS
D 7 6***+!>54.#" !"&=!5.54>32 !#c`�r>V��ooŔV>q�`� �b�yDe�뇇�eDx�b�kOw�g~�~??~�~g�wO��4�\��m�ؖOO�؉m��\�4 {��� . B C@@ 4 B h [ S CS D0/:8/B0B#+(($+>32 #".54>32 >54&#"#"&'2>7.#" �$CCG(W�_2G�ԌQ�`5I��q5cVD��1K8%
MR�oO
+GeEb�k9(If=# H��~����6f�[rɖV9W; ;5-��
�&G��y3cN/I�dKvR+ � @ B C R
D+3!7!&'^\M�
��*
��ySz!+& M��� $@! Q CD +##!##5�b��b��R�k��k�R W���� &@#
B Q C Q D+!!!!547 &5W�����{�[ ��` �R����R$1.
�z�� @ M Q E+!!�=���I ( �� "@ B j [
D*# +#"&=!267>;#5�:�
� :��O�
��.)%'�
�I J
� ' ; O L@IK-B[
O
S G=<)( GE<O=O31(;); '' +".'#".54>32 >32 %2>7.#" !2>54.#" �7\NC CN[79hO//Oh97[NC CN\79hO//Oh�F,KB; ;BK,,M:!!:M�+M9!!9M+-KB; ;BK(BW//VC(+PsGGrP+(CW..WC(+PrGGsP+N&@S--T@& :V78V: :V87V: &@T--S@& ����K� ) *@' B S CS D!%)U$+>32#"&#"#"&'7>3232>7�
:Vo@'9
4XC- � ?]xE!A
" <`G/
>W�U+
+
DgH��c�Z* ' GqQ ���� / d@a ( 'B [ [ [ O S G ,*%# //
+267#".#"'>32 267#".#"'>32
4X d84ec`.7W c<4fc_.4X d84ec`.7W c<4fc_*- :+/$,$- 8-0$,$��- :+.$,$- 8-/$,$ � ��p kK� PX@) ^ _ ZMQE@' j k ZMQEY@
+!3!!!!#!5!7!��uGt��h��@vHv��Th�De ��J�J��J� � P�O !@ @ M Q E+ !!��
��''%���v> �� �� ?x��I � P�O !@
@ M Q E+5467>7.'.=!5!�
&&&��
���(��? >�I ��f�� "@
B M Q E+3 # >7 .'��B��nB��L N��
�@����@�S �� ���� � @ C D+3#��� k� a�BK�!PX@ S C QC
D@ [S C
DY@ !$%!
+3'&=354>32#"&#" !#!nj �6g�_!G
+!��G`�{ 'U\�g7
0
��R�<}�� �� " �K�!PX@ SC QC
DK�1PX@ [ SC
D@! [ C S C
DYY@ " "A15!
+3'&=354>32 ;#.#" !!nj �4d�`"IE<H_6w0KvQ+ ��{ 'AX�n>�nO/Y~NAG�� ��R��
@ j D
+2+: 0[ "6M6
�� @ j a +2 #"&'%t�G
���
�� 2E� % @ O S G&(($+#".54>32 #".54632 �
�
0!
�
!1
U5�q @ M Q E+!!U��aq< �J� @ j a #++7>3J��
F����
<� @ B j a, +#"&/.'+73<I��J�Z{{� <� @ B j a, +32 >?>;# J� �I�Z�{{� 2��
(@%j O S G
+"&5332653$|v@R``R@v�pfGQQGbt �8{� @ O S G($+#".54>32 { � }��� !@ [ O S G$&($+4>32 #".732654&#"}-="">-->""=-5@32@@23@^";**;"#:**:#2@@22@@ *)� 1@. [ O S G
+2673#".#"#4>32 �*,6"5"!<85*+8$4""<84P7+#;- % 8*"<- % j�� +@( O S G
#++7>3!+7>3�� /�
q� 4��� �� � ��m�
@ k D
+2+U 3� #;U< . ���U_<� � ʓ^p �ӡ�6��z� ��V �6�:z / � � �� �� V� �� Wg j� �X �X b {� m� n� d� i��� I� �� �� �� ?� �� �� �� x� �� �� �� �� �� �� !k l � |� �� �x �� |� �V �� Y( �� � �� �; {� �; {� � W� #� � � � � � sX ���X k� � I V� kD �� XD W� X� � K: �� ���� �� �7 �: �: W. �D W �\ Y� 4: �� � � #� � JX ?XX i� �� � �� �� C� �� UX� �I 'M U� jj �� �� dM UI [� m� a� bI �: �� 6 �I �� �� Wj �� �� �� S� * 7�� |� �� �� �� �V V �V V ' 1� �; {; {; {; {; {� �; {� �� �� �� �� � �� �� k� k� k� k� k� kI k� X� X� X� X� X� "� �����0 Y: �: W: W: W: W: W� m: W: �: �: �: �� . �� � k |� X� �� X� �* :X 9� �: �� {� W: W\ Y W\ Y� � s� J� s� J� s� J� vI I I I 5I �I xI �I &I |� .: �7 �� �� n� n� �� n� n� �� �� ` i� Wk �k ��6� � H� h� { T MT W� �c (T J��� �� �� �� �� � ��* l I �I I I UI �I I I 2I �I }I *I jI � l� #` � �V � �B � �V #�� $�V &�� *�� 2�� 4�� 9 7 : 7 < ? 7 D�� F�� G�� H�� R�� T�� m�B o�B y�B }�B ��V ��V ��V ��V ��V ��V ��V ��� ��� ��� ��� ��� ��� ��� � ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �V �� �� �� �� �� �� � �B �B � � �B �B �B ��V
�V
�
�B
�
�V
#��
$�V
&��
*��
2��
4��
9 7
: 7
<
? 7
D��
F��
G��
H��
R��
T��
m�B
o�B
y�B
}�B
��V
��V
��V
��V
��V
��V
��V
���
���
���
���
���
���
���
�
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�V
��
��
��
��
��
��
�
�B
�B
�
�
�B
�B
�B
��V #�� &�� *�� 2�� 4�� F�� G�� H�� R�� T�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� ��
�V
�
�B
�
�V
#��
$�V
&��
*��
2��
4��
9 7
: 7
<
? 7
D��
F��
G��
H��
R��
T��
m�B
o�B
y�B
}�B
��V
��V
��V
��V
��V
��V
��V
���
���
���
���
���
���
���
�
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
���
�V
��
��
��
��
��
��
�
�B
�B
�
�
�B
�B
�B
��V �
�
� �v #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�y ?�L Y�� Z�� \�� l� m�v o�v r� y�v |� }�v ��� ��� ��� ��� ��� ��� ��� ��y �� �� �y �v �v � � � � �v �v �v �� �B ��
�B
�B �v �v �� $�� 7�L 9�� :�� ;�� <�` =�� ?�� l�B r�B |�B ��� ��� ��� ��� ��� ��� ��� ��` �� �` �� �� �� �B �B �v �B �B �v ��B ��� �
�
� �v #�� &�� *�� 2�� 4�� 7�L 9�L :�� <�y ?�L Y�� Z�� \�� l� m�v o�v r� y�v |� }�v ��� ��� ��� ��� ��� ��� ��� ��y �� �� �y �v �v � � � � �v �v �v �� 7 ��
7
7 �G �� �G �� �� �� " < #�� $�� &�� *�� -�o 2�� 4�� D�� F�� G�� H�� I�� J�{ P�� Q�� R�� S�� T�� U�� V�� W�� X�� Y�� [�� \�� ]�� l 7 m�� o�� r 7 t F u F w�� y�� { F | 7 }�� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� ��� �� �� �� �� �� �� �� �� � � � 7 � 7 �G � 7 � 7 �G � � � � 7 ��� # �� # �� #
�� # �� #
�� # �� # �� # �� # $�� # 7�� # 9�� # ;�� # <�� # =�� # ?�� # @�� # `�� # l�� # r�� # |�� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # ��� # �� # �� # �� # �� # �� # �� # �� # �� # �� # �� # �� # ��� # ��� $ �V $
�V $
�V $ �� $ "�� $ #�� $ &�� $ *�� $ - - $ 2�� $ 4�� $ 7�� $ 8�� $ 9�� $ :�� $ <�t $ ?�� $ Y�� $ \�� $ l�V $ m�� $ o�� $ r�V $ t�` $ u�` $ y�� $ {�` $ |�V $ }�� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��� $ ��t $ �� $ �� $ �t $ �� $ �� $ �V $ �V $ �V $ �V $ �� $ �� $ �� $ ��V & �e & m�e & o�e & y�e & }�e & �e & �e & �e & �e & �e ' �� ' �� '
�� ' �� '
�� ' �� ' �� ' �� ' $�� ' 7�� ' 9�� ' ;�� ' <�� ' =�� ' ?�� ' @�� ' `�� ' l�� ' r�� ' |�� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' ��� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' �� ' ��� ' ��� ) �� ) �L ) �L ) �� ) �� ) �� ) " ) $�� ) -�. ) F�� ) G�� ) H�� ) P�� ) Q�� ) R�� ) S�� ) T�� ) U�� ) X�� ) w�� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) ��� ) �� ) �� ) �� ) �� ) �� ) �L ) �L ) ��� - �� - �� - �� - �� - $�� - ��� - ��� - ��� - ��� - ��� - ��� - ��� - �� - �� - �� - ��� . �� . #�� . &�� . *�� . 2�� . 4�� . F�� . G�� . H�� . I�� . R�� . T�� . W�� . Y�� . Z�� . \�� . m�� . o�� . y�� . }�� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . ��� . �� . �� . �� . �� . �� . �� . �� . �� . �� . �� / �� /
�� /
�� / 4 / �$ / 4 / "�� / #�� / &�� / *�� / 2�� / 4�� / 7�[ / 9�V / :�y / <�= / ?�V / F�� / G�� / H�� / R�� / T�� / Y�� / Z�� / \�� / l�� / m�$ / o�$ / r�� / t�B / u�B / y�$ / {�B / |�� / }�$ / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��= / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / ��� / �� / �� / �� / �� / �� / �= / �$ / �$ / �� / �� / � 4 / �� / �� / � 4 / �$ / �$ / �$ / ��� 2 �� 2 �� 2
�� 2 �� 2
�� 2 �� 2 �� 2 �� 2 $�� 2 7�� 2 9�� 2 ;�� 2 <�� 2 =�� 2 ?�� 2 @�� 2 `�� 2 l�� 2 r�� 2 |�� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 ��� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 �� 2 ��� 2 ��� 3 �� 3 � 3 � 3 �� 3 $�� 3 -�V 3 D�� 3 F�� 3 G�� 3 H�� 3 R�� 3 T�� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 ��� 3 �� 3 �� 3 �� 3 �� 3 �� 3 � 3 � 3 ��� 4 �� 4 �� 4
�� 4 �� 4
�� 4 �� 4 �� 4 �� 4 $�� 4 7�� 4 9�� 4 ;�� 4 <�� 4 =�� 4 ?�� 4 @�� 4 `�� 4 l�� 4 r�� 4 |�� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 ��� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 �� 4 ��� 4 ��� 5 #�� 5 &�� 5 *�� 5 2�� 5 4�� 5 7�� 5 8�� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 ��� 5 �� 5 �� 7 �� 7 �L 7 �L 7 �L 7 �� 7 �` 7 �` 7 #�� 7 $�� 7 &�� 7 *�� 7 -�8 7 2�� 7 4�� 7 D� 7 F�) 7 G�) 7 H�) 7 J�> 7 P�` 7 Q�` 7 R�) 7 S�` 7 T�) 7 U�` 7 V�D 7 X�` 7 Y�L 7 Z�t 7 [�g 7 \�L 7 ]�� 7 m�L 7 o�L 7 w�` 7 y�L 7 }�L 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 ��� 7 �� 7 �� 7 �� 7 �� 7 �� 7 �� 7 �� 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��` 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��) 7 ��` 7 ��` 7 ��` 7 ��` 7 �� 7 � 7 �� 7 �) 7 �) 7 �` 7 �� 7 �) 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 �L 7 ��� 8 �� 8 �� 8 �� 8 �� 8 $�� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 ��� 8 �� 8 �� 8 �� 8 ��� 9 7 9 �� 9
7 9
7 9 �G 9 �� 9 �G 9 �� 9 �� 9 �� 9 " < 9 #�� 9 $�� 9 &�� 9 *�� 9 -�o 9 2�� 9 4�� 9 D�� 9 F�� 9 G�� 9 H�� 9 I�� 9 J�{ 9 P�� 9 Q�� 9 R�� 9 S�� 9 T�� 9 U�� 9 V�� 9 W�� 9 X�� 9 Y�� 9 [�� 9 \�� 9 ]�� 9 l 7 9 m�� 9 o�� 9 r 7 9 t F 9 u F 9 w�� 9 y�� 9 { F 9 | 7 9 }�� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 ��� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 �� 9 � 9 � 9 � 7 9 � 7 9 �G 9 � 7 9 � 7 9 �G 9 � 9 � 9 � 9 � 7 9 ��� : 7 : �� :
7 :
7 : �� : �� : �� : �� : " % : $�� : -�� : D�� : F�� : G�� : H�� : J�� : R�� : T�� : V�� : l 7 : m�� : o�� : r 7 : t 7 : u 7 : y�� : { 7 : | 7 : }�� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : ��� : �� : �� : �� : �� : �� : �� : �� : � 7 : � 7 : � : � 7 : � 7 : � : �� : �� : �� : � 7 : ��� ; �� ; #�� ; &�� ; *�� ; 2�� ; 4�� ; F�� ; G�� ; H�� ; I�� ; R�� ; T�� ; W�� ; Y�� ; Z�� ; \�� ; m�� ; o�� ; y�� ; }�� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; ��� ; �� ; �� ; �� ; �� ; �� ; �� ; �� ; �� ; �� ; �� < < �t <
<
< �y < �` < �y < �t < �� < �� < " % < #�� < $�t < &�� < *�� < -�8 < 2�� < 4�� < D�� < F�` < G�` < H�` < J�[ < P�� < Q�� < R�` < S�� < T�` < U�� < V�� < X�� < Y�� < Z�� < [�� < \�� < l < m�` < o�` < r < t - < u - < w�� < y�` < { - < | < }�` < ��t < ��t < ��t < ��t < ��t < ��t < ��t < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��� < ��` < ��` < ��` < ��` < ��` < ��` < ��� < ��` < ��` < ��` < ��` < ��` < ��` < ��� < ��� < ��� < ��� < �t < �� < �� < �` < �` < �� < �� < �` < �` < �` < � < � < �y < � < � < �y < �` < �` < �` < � < ��t = �� = " % = #�� = &�� = *�� = 2�� = 4�� = F�� = G�� = H�� = R�� = T�� = V�� = Y�� = \�� = m�� = o�� = y�� = }�� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = ��� = �� = �� = �� = �� = �� = � = � = � = � = � > #�� > &�� > *�� > 2�� > 4�� > F�� > G�� > H�� > R�� > T�� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > ��� > �� > �� > �� > �� > �� ? �V ?
�V ?
�V ? �� ? "�� ? #�� ? &�� ? *�� ? - - ? 2�� ? 4�� ? 7�� ? 8�� ? 9�� ? :�� ? <�t ? ?�� ? Y�� ? \�� ? l�V ? m�� ? o�� ? r�V ? t�` ? u�` ? y�� ? {�` ? |�V ? }�� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��� ? ��t ? �� ? �� ? �t ? �� ? �� ? �V ? �V ? �V ? �V ? �� ? �� ? �� ? ��V D �� D
�� D
�� D Y�� D Z�� D \�� D l�� D r�� D t�� D u�� D {�� D |�� D � D � D � D � D ��� E �� E
�� E �� E
�� E 9�� E :�� E ?�� E @�� E Y�� E [�� E \�� E `�� E l�� E r�� E |�� E � E � E � E � E ��� H �� H
�� H �� H
�� H 9�� H :�� H ?�� H @�� H Y�� H [�� H \�� H `�� H l�� H r�� H |�� H � H � H � H � H ��� I K I
K I
K I �y I �y I l K I r K I t d I u d I { d I | K I � K I � K I �y I � K I � K I �y I � K K �� K
�� K
�� K Y�� K Z�� K \�� K l�� K r�� K t�� K u�� K {�� K |�� K � K � K � K � K ��� N F�� N G�� N H�� N R�� N T�� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N ��� N �� N �� N �� P �� P
�� P
�� P Y�� P Z�� P \�� P l�� P r�� P t�� P u�� P {�� P |�� P � P � P � P � P ��� Q �� Q
�� Q
�� Q Y�� Q Z�� Q \�� Q l�� Q r�� Q t�� Q u�� Q {�� Q |�� Q � Q � Q � Q � Q ��� R �� R
�� R �� R
�� R 9�� R :�� R ?�� R @�� R Y�� R [�� R \�� R `�� R l�� R r�� R |�� R � R � R � R � R ��� S �� S
�� S �� S
�� S 9�� S :�� S ?�� S @�� S Y�� S [�� S \�� S `�� S l�� S r�� S |�� S � S � S � S � S ��� U �� U �� U D�� U ��� U ��� U ��� U ��� U ��� U ��� U ��� U �� U � U � Y �� Y �� Y �� Y �� Y $�� Y F�� Y G�� Y H�� Y R�� Y T�� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y ��� Y �� Y �� Y �� Y �� Y � Y � Y ��� Z �� Z �� Z �� Z �� [ F�� [ G�� [ H�� [ R�� [ T�� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ ��� [ �� [ �� [ �� \ �� \ �� \ �� \ �� \ $�� \ F�� \ G�� \ H�� \ R�� \ T�� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ ��� \ �� \ �� \ �� \ �� \ � \ � \ ��� ^ #�� ^ &�� ^ *�� ^ 2�� ^ 4�� ^ F�� ^ G�� ^ H�� ^ R�� ^ T�� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ ��� ^ �� ^ �� ^ �� ^ �� ^ �� l �V l � l �B l � l �V l #�� l $�V l &�� l *�� l 2�� l 4�� l 9 7 l : 7 l < l ? 7 l D�� l F�� l G�� l H�� l R�� l T�� l m�B l o�B l y�B l }�B l ��V l ��V l ��V l ��V l ��V l ��V l ��V l ��� l ��� l ��� l ��� l ��� l ��� l ��� l � l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l ��� l �V l �� l �� l �� l �� l �� l �� l � l �B l �B l � l � l �B l �B l �B l ��V m �B m �� m
�B m
�B m �v m �v m �� m $�� m 7�L m 9�� m :�� m ;�� m <�` m =�� m ?�� m l�B m r�B m |�B m ��� m ��� m ��� m ��� m ��� m ��� m ��� m ��` m �� m �` m �� m �� m �� m �B m �B m �v m �B m �B m �v m ��B m ��� o �B o �� o
�B o
�B o �v o �v o �� o $�� o 7�L o 9�� o :�� o ;�� o <�` o =�� o ?�� o l�B o r�B o |�B o ��� o ��� o ��� o ��� o ��� o ��� o ��� o ��` o �� o �` o �� o �� o �� o �B o �B o �v o �B o �B o �v o ��B o ��� p �� p �� p
�� p �� p
�� p �� p �� p �� p $�� p 7�� p 9�� p ;�� p <�� p =�� p ?�� p @�� p `�� p l�� p r�� p |�� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p ��� p �� p �� p �� p �� p �� p �� p �� p �� p �� p �� p �� p ��� p ��� r �V r � r �B r � r �V r #�� r $�V r &�� r *�� r 2�� r 4�� r 9 7 r : 7 r < r ? 7 r D�� r F�� r G�� r H�� r R�� r T�� r m�B r o�B r y�B r }�B r ��V r ��V r ��V r ��V r ��V r ��V r ��V r ��� r ��� r ��� r ��� r ��� r ��� r ��� r � r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r ��� r �V r �� r �� r �� r �� r �� r �� r � r �B r �B r � r � r �B r �B r �B r ��V t �` t �` t $�` t 9 F t : F t < ( t ? F t ��` t ��` t ��` t ��` t ��` t ��` t ��` t � ( t �` t � ( t ��` u �` u �` u $�` u 9 F u : F u < ( u ? F u ��` u ��` u ��` u ��` u ��` u ��` u ��` u � ( u �` u � ( u ��` y �B y �� y
�B y
�B y �v y �v y �� y $�� y 7�L y 9�� y :�� y ;�� y <�` y =�� y ?�� y l�B y r�B y |�B y ��� y ��� y ��� y ��� y ��� y ��� y ��� y ��` y �� y �` y �� y �� y �� y �B y �B y �v y �B y �B y �v y ��B y ��� { �` { �` { $�` { 9 F { : F { < ( { ? F { ��` { ��` { ��` { ��` { ��` { ��` { ��` { � ( { �` { � ( { ��` | �V | � | �B | � | �V | #�� | $�V | &�� | *�� | 2�� | 4�� | 9 7 | : 7 | < | ? 7 | D�� | F�� | G�� | H�� | R�� | T�� | m�B | o�B | y�B | }�B | ��V | ��V | ��V | ��V | ��V | ��V | ��V | ��� | ��� | ��� | ��� | ��� | ��� | ��� | � | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | ��� | �V | �� | �� | �� | �� | �� | �� | � | �B | �B | � | � | �B | �B | �B | ��V } �B } �� }
�B }
�B } �v } �v } �� } $�� } 7�L } 9�� } :�� } ;�� } <�` } =�� } ?�� } l�B } r�B } |�B } ��� } ��� } ��� } ��� } ��� } ��� } ��� } ��` } �� } �` } �� } �� } �� } �B } �B } �v } �B } �B } �v } ��B } ��� � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � �e � m�e � o�e � y�e � }�e � �e � �e � �e � �e � �e � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � �� � �� � �� � �� � $�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � ��� � � �t �
�
� �y � �` � �y � �t � �� � �� � " % � #�� � $�t � &�� � *�� � -�8 � 2�� � 4�� � D�� � F�` � G�` � H�` � J�[ � P�� � Q�� � R�` � S�� � T�` � U�� � V�� � X�� � Y�� � Z�� � [�� � \�� � l � m�` � o�` � r � t - � u - � w�� � y�` � { - � | � }�` � ��t � ��t � ��t � ��t � ��t � ��t � ��t � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��� � ��� � ��� � �t � �� � �� � �` � �` � �� � �� � �` � �` � �` � � � � � �y � � � � � �y � �` � �` � �` � � � ��t � �� � �� �
�� � �� �
�� � �� � �� � �� � $�� � 7�� � 9�� � ;�� � <�� � =�� � ?�� � @�� � `�� � l�� � r�� � |�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � �� � ��� � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �e � m�e � o�e � y�e � }�e � �e � �e � �e � �e � �e � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � �t �
�t �
�t � �o � 9�j � :�� � <�y � ?�j � Y�� � \�� � l�t � m�o � o�o � r�t � t�� � u�� � y�o � {�� � |�t � }�o � ��y � �y � �o � �o � �t � �t � �t � �t � �o � �o � �o � ��t � �� �
�� �
�� � Y�� � Z�� � \�� � l�� � r�� � t�� � u�� � {�� � |�� � � � � � � � � � ��� � �� �
�� � �� �
�� � 9�� � :�� � ?�� � @�� � Y�� � [�� � \�� � `�� � l�� � r�� � |�� � � � � � � � � � ��� � � �t �
�
� �y � �` � �y � �t � �� � �� � " % � #�� � $�t � &�� � *�� � -�8 � 2�� � 4�� � D�� � F�` � G�` � H�` � J�[ � P�� � Q�� � R�` � S�� � T�` � U�� � V�� � X�� � Y�� � Z�� � [�� � \�� � l � m�` � o�` � r � t - � u - � w�� � y�` � { - � | � }�` � ��t � ��t � ��t � ��t � ��t � ��t � ��t � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��` � ��` � ��` � ��` � ��` � ��` � ��� � ��� � ��� � ��� � �t � �� � �� � �` � �` � �� � �� � �` � �` � �` � � � � � �y � � � � � �y � �` � �` � �` � � � ��t � �� � " % � #�� � &�� � *�� � 2�� � 4�� � F�� � G�� � H�� � R�� � T�� � V�� � Y�� � \�� � m�� � o�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � � � � � � � � � � � �� � " % � #�� � &�� � *�� � 2�� � 4�� � F�� � G�� � H�� � R�� � T�� � V�� � Y�� � \�� � m�� � o�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � � � � � � � � � � � �� � " % � #�� � &�� � *�� � 2�� � 4�� � F�� � G�� � H�� � R�� � T�� � V�� � Y�� � \�� � m�� � o�� � y�� � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �� � �� � �� � �� � �� � � � � � � � � � � � �B � �� �
�B �
�B � �v � �v � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�B � r�B � |�B � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �B � �B � �v � �B � �B � �v � ��B � ��� � �B � �� �
�B �
�B � �v � �v � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�B � r�B � |�B � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �B � �B � �v � �B � �B � �v � ��B � ��� � �V � � � �B � � � �V � #�� � $�V � &�� � *�� � 2�� � 4�� � 9 7 � : 7 � < � ? 7 � D�� � F�� � G�� � H�� � R�� � T�� � m�B � o�B � y�B � }�B � ��V � ��V � ��V � ��V � ��V � ��V � ��V � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �V � �� � �� � �� � �� � �� � �� � � � �B � �B � � � � � �B � �B � �B � ��V � �V � � � �B � � � �V � #�� � $�V � &�� � *�� � 2�� � 4�� � 9 7 � : 7 � < � ? 7 � D�� � F�� � G�� � H�� � R�� � T�� � m�B � o�B � y�B � }�B � ��V � ��V � ��V � ��V � ��V � ��V � ��V � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �V � �� � �� � �� � �� � �� � �� � � � �B � �B � � � � � �B � �B � �B � ��V � � �
� �
� � �v � #�� � &�� � *�� � 2�� � 4�� � 7�L � 9�L � :�� � <�y � ?�L � Y�� � Z�� � \�� � l� � m�v � o�v � r� � y�v � |� � }�v � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � �� � �� � �y � �v � �v � � � � � � � � � �v � �v � �v � �� � �V � � � �B � � � �V � #�� � $�V � &�� � *�� � 2�� � 4�� � 9 7 � : 7 � < � ? 7 � D�� � F�� � G�� � H�� � R�� � T�� � m�B � o�B � y�B � }�B � ��V � ��V � ��V � ��V � ��V � ��V � ��V � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �V � �� � �� � �� � �� � �� � �� � � � �B � �B � � � � � �B � �B � �B � ��V � �V � � � �B � � � �V � #�� � $�V � &�� � *�� � 2�� � 4�� � 9 7 � : 7 � < � ? 7 � D�� � F�� � G�� � H�� � R�� � T�� � m�B � o�B � y�B � }�B � ��V � ��V � ��V � ��V � ��V � ��V � ��V � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �V � �� � �� � �� � �� � �� � �� � � � �B � �B � � � � � �B � �B � �B � ��V � � �
� �
� � �v � #�� � &�� � *�� � 2�� � 4�� � 7�L � 9�L � :�� � <�y � ?�L � Y�� � Z�� � \�� � l� � m�v � o�v � r� � y�v � |� � }�v � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��y � �� � �� � �y � �v � �v � � � � � � � � � �v � �v � �v � �� � �B � �� �
�B �
�B � �v � �v � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�B � r�B � |�B � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �B � �B � �v � �B � �B � �v � ��B � ��� � �B � �� �
�B �
�B � �v � �v � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�B � r�B � |�B � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �B � �B � �v � �B � �B � �v � ��B � ��� � �B � �� �
�B �
�B � �v � �v � �� � $�� � 7�L � 9�� � :�� � ;�� � <�` � =�� � ?�� � l�B � r�B � |�B � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��` � �� � �` � �� � �� � �� � �B � �B � �v � �B � �B � �v � ��B � ��� � �V � � � �B � � � �V � #�� � $�V � &�� � *�� � 2�� � 4�� � 9 7 � : 7 � < � ? 7 � D�� � F�� � G�� � H�� � R�� � T�� � m�B � o�B � y�B � }�B � ��V � ��V � ��V � ��V � ��V � ��V � ��V � ��� � ��� � ��� � ��� � ��� � ��� � ��� � � � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � �V � �� � �� � �� � �� � �� � �� � � � �B � �B � � � � � �B � �B � �B � ��V � �V �
�V �
�V � �� � "�� � #�� � &�� � *�� � - - � 2�� � 4�� � 7�� � 8�� � 9�� � :�� � <�t � ?�� � Y�� � \�� � l�V � m�� � o�� � r�V � t�` � u�` � y�� � {�` � |�V � }�� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��� � ��t � �� � �� � �t � �� � �� � �V � �V � �V � �V � �� � �� � �� � ��V � � � � �"��"�� J��"<b��n�6� 2� ( z �
,
R
� ~ � � � �
�
�
� Zv��@~�F��F��Fr���*� z�T����T��V�`����P��� r � N N � � � J l
^!B!�!�"$"># #&#n#�$"$�$�%.%d%�%�&.&t&�'0'�))r)~)�)�)�)�)�**�*�*�*�*�*�*�*�++T+`+l+x+�+�+�+�,P,\,h,t,�,�,�-P-\-h-t-�-�-�.x// /(/4/@/L/X/d/p/�0000&020>0�1 1 11$101<1�1�22�2�2�3<3�3�4*4\4h4t5<5�5�5�666 6(646@6L6X6d6�6�777D7n7�7�8R8�8�8�99>9d9�9�::V:�;t;�;�<�<�= =>=�>4>�??F?p?�?�?�@�@�A^A�A�B6BxB�B�CbC�C�C�D D.D\D�D�D�E$EhE�E� � ` " / n � � � �
� � ( �
� ( �
� 0 � % %
�4 2(
�Z 6 J ^ Pl � P� � ` � �
�� 0
V d
�
�
� 4n �
�Copyright (c) 2010-2013 by tyPoland Lukasz Dziedzic with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1.Lato LightRegulartyPolandLukaszDziedzic: Lato Light: 2013Version 1.105; Western+Polish opensourceLato-LightLato is a trademark of tyPoland Lukasz Dziedzic.Lukasz DziedzicLato is a sanserif typeface family designed in the Summer 2010 by Warsaw-based designer Lukasz Dziedzic ("Lato" means "Summer" in Polish). It tries to carefully balance some potentially conflicting priorities: it should seem quite "transparent" when used in body text but would display some original traits when used in larger sizes. The classical proportions, particularly visible in the uppercase, give the letterforms familiar harmony and elegance. At the same time, its sleek sanserif look makes evident the fact that Lato was designed in 2010, even though it does not follow any current trend. The semi-rounded details of the letters give Lato a feeling of warmth, while the strong structure provides stability and seriousness.http://www.typoland.com/http://www.typoland.com/designers/Lukasz_Dziedzic/Copyright (c) 2013-2013 by tyPoland Lukasz Dziedzic (http://www.typoland.com/) with Reserved Font Name "Lato". Licensed under the SIL Open Font License, Version 1.1 (http://scripts.sil.org/OFL).http://scripts.sil.org/OFL C o p y r i g h t ( c ) 2 0 1 0 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 . L a t o L i g h t R e g u l a r t y P o l a n d L u k a s z D z i e d z i c : L a t o L i g h t : 2 0 1 3 L a t o - L i g h t V e r s i o n 1 . 1 0 5 ; W e s t e r n + P o l i s h o p e n s o u r c e L a t o i s a t r a d e m a r k o f t y P o l a n d L u k a s z D z i e d z i c . L u k a s z D z i e d z i c L a t o i s a s a n s e r i f t y p e f a c e f a m i l y d e s i g n e d i n t h e S u m m e r 2 0 1 0 b y W a r s a w - b a s e d d e s i g n e r L u k a s z D z i e d z i c ( " L a t o " m e a n s " S u m m e r " i n P o l i s h ) . I t t r i e s t o c a r e f u l l y b a l a n c e s o m e p o t e n t i a l l y c o n f l i c t i n g p r i o r i t i e s : i t s h o u l d s e e m q u i t e " t r a n s p a r e n t " w h e n u s e d i n b o d y t e x t b u t w o u l d d i s p l a y s o m e o r i g i n a l t r a i t s w h e n u s e d i n l a r g e r s i z e s . T h e c l a s s i c a l p r o p o r t i o n s , p a r t i c u l a r l y v i s i b l e i n t h e u p p e r c a s e , g i v e t h e l e t t e r f o r m s f a m i l i a r h a r m o n y a n d e l e g a n c e . A t t h e s a m e t i m e , i t s s l e e k s a n s e r i f l o o k m a k e s e v i d e n t t h e f a c t t h a t L a t o w a s d e s i g n e d i n 2 0 1 0 , e v e n t h o u g h i t d o e s n o t f o l l o w a n y c u r r e n t t r e n d . T h e s e m i - r o u n d e d d e t a i l s o f t h e l e t t e r s g i v e L a t o a f e e l i n g o f w a r m t h , w h i l e t h e s t r o n g s t r u c t u r e p r o v i d e s s t a b i l i t y a n d s e r i o u s n e s s . h t t p : / / w w w . t y p o l a n d . c o m / h t t p : / / w w w . t y p o l a n d . c o m / d e s i g n e r s / L u k a s z _ D z i e d z i c / C o p y r i g h t ( c ) 2 0 1 3 - 2 0 1 3 b y t y P o l a n d L u k a s z D z i e d z i c ( h t t p : / / w w w . t y p o l a n d . c o m / ) w i t h R e s e r v e d F o n t N a m e " L a t o " . L i c e n s e d u n d e r t h e S I L O p e n F o n t L i c e n s e , V e r s i o n 1 . 1 ( h t t p : / / s c r i p t s . s i l . o r g / O F L ) . h t t p : / / s c r i p t s . s i l . o r g / O F L L a t o L i g h t �Z D
! " # $ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? @ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z [ \ ] ^ _ ` a � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � b c � d � e � � � � � � � f � � � � g � � � � � h � � � j i k m l n � o q p r s u t v w � x z y { } | � � ~ � � � � � � �
� � � � �
� � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � � !"#NULLuni00A0uni00ADmacronperiodcenteredAogonekaogonekEogonekeogonekNacutenacuteSacutesacuteZacutezacute
Zdotaccent
zdotaccentuni02C9EuroDeltauni2669undercommaaccent
grave.case
dieresis.case macron.case
acute.casecircumflex.case
caron.case
breve.casedotaccent.case ring.case
tilde.casehungarumlaut.case
caron.salt �� b K b K� �� ����V��������V� ,� `f-�, d ��P�&Z�E[X!#!�X �PPX!�@Y �8PX!�8YY � Ead�(PX!� E �0PX!�0Y ��PX f ��a �
PX` � PX!�
` �6PX!�6``YYY� +YY#� PXeYY-�, E �%ad �CPX�#B�#B!!Y�`-�,#!#! d�bB �#B� *! �C � �� +�0%�QX`PaRYX#Y! �@SX� +!�@Y#� PXeY-�,�C+� C`B-�,�#B# � #Ba��b�`�*-�, E �Ec�Eb`D�`-�, E � +#�%` E�#a d � PX!� �0PX� �@YY#� PXeY�%#aDD�`-�,�E�aD-� ,�` � CJ� PX � #BY�
CJ� RX �
#BY-�
, � b � c�#a� C` �` � #B#-� ,KTX�DY$�
e#x-� ,KQXKSX�DY!Y$�e#x-�
,� CUX� C�aB�
+Y� C�%B� %B�
%B�# �%PX� C`�%B�� �#a� *!#�a �#a� *!� C`�%B�%a� *!Y� CG�
CG`��b �Ec�Eb`� #D�C� >�C`B-�,� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,�+-�,� +-�,�+� ETX � #B `�a�
BB�`�
+�m+"Y-�,� +-�,�+-� ,�+-� ,�+-� ,�+-� ,�+-� ,�+-�!,�+-�",�+-�#,� +-�$, <�`-�%, `�
` C#�`C�%a�`�$*!-�&,�%+�%*-�', G �Ec�Eb`#a8# �UX G �Ec�Eb`#a8!Y-�(,� ETX ��'*�0"Y-�),�+� ETX ��'*�0"Y-�*, 5�`-�+, �Ec�Eb� +�Ec�Eb� +� � D>#8�**-�,, < G �Ec�Eb`� Ca8-�-,.<-�., < G �Ec�Eb`� Ca�Cc8-�/,� % . G� #B�%I��G#G#a Xb!Y�#B�.*-�0,� �%�%G#G#a�E+e�.# <�8-�1,� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# �C �#G#G#a#F`�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba# �&#Fa8#�CF�%�CG#G#a` �C��b`# � +#�C`� +�%a�%��b�&a �%`d#�%`dPX!#!Y# �&#Fa8Y-�2,� �& .G#G#a#<8-�3,� �#B F#G� +#a8-�4,� �%�%G#G#a� TX. <#!�%�%G#G#a �%�%G#G#a�%�%I�%a�Ec# Xb!Yc�Eb`#.# <�8#!Y-�5,� �C .G#G#a `� `f��b# <�8-�6,# .F�%FRX <Y.�&+-�7,# .F�%FPX <Y.�&+-�8,# .F�%FRX <Y# .F�%FPX <Y.�&+-�9,�0+# .F�%FRX <Y.�&+-�:,�1+� <�#B�8# .F�%FRX <Y.�&+�C.�&+-�;,� �%�& .G#G#a�E+# < .#8�&+-�<,�%B� �%�% .G#G#a �#B�E+ �`PX �@QX� �&YBB# G�C��b` � + ��a �C`d#�CadPX�Ca�C`Y�%��ba�%Fa8# <#8! F#G� +#a8!Y�&+-�=,�0+.�&+-�>,�1+!# <�#B#8�&+�C.�&+-�?,� G� #B� .�,*-�@,� G� #B� .�,*-�A,� �-*-�B,�/*-�C,� E# . F�#a8�&+-�D,�#B�C+-�E,� <+-�F,� <+-�G,� <+-�H,�<+-�I,� =+-�J,� =+-�K,� =+-�L,�=+-�M,� 9+-�N,� 9+-�O,� 9+-�P,�9+-�Q,� ;+-�R,� ;+-�S,� ;+-�T,�;+-�U,� >+-�V,� >+-�W,� >+-�X,�>+-�Y,� :+-�Z,� :+-�[,� :+-�\,�:+-�],�2+.�&+-�^,�2+�6+-�_,�2+�7+-�`,� �2+�8+-�a,�3+.�&+-�b,�3+�6+-�c,�3+�7+-�d,�3+�8+-�e,�4+.�&+-�f,�4+�6+-�g,�4+�7+-�h,�4+�8+-�i,�5+.�&+-�j,�5+�6+-�k,�5+�7+-�l,�5+�8+-�m,+�e�$Px�0- K� KRX��Y� c �#D�#p�E �(`f �UX�%a�Ec#b�#D� *� *�*Y�( ERD� *�D�$�QX�@�X�D�&�QX� �X�DYYYY������ D share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml 0000644 00000003113 15173517750 0025134 0 ustar 00 <body id="top" class="table-of-contents">
<main role="main">
<h1 class="class"><%= h @title %></h1>
<%- simple_files = @files.select { |f| f.text? } -%>
<%- unless simple_files.empty? then -%>
<h2 id="pages">Pages</h2>
<ul>
<%- simple_files.sort.each do |file| -%>
<li class="file">
<a href="<%= h file.path %>"><%= h file.page_name %></a>
<%
# HACK table_of_contents should not exist on Document
table = file.parse(file.comment).table_of_contents
unless table.empty? then %>
<ul>
<%- table.each do |heading| -%>
<li><a href="<%= h file.path %>#<%= heading.aref %>"><%= heading.plain_html %></a>
<%- end -%>
</ul>
<%- end -%>
</li>
<%- end -%>
</ul>
<%- end -%>
<h2 id="classes">Classes and Modules</h2>
<ul>
<%- @modsort.each do |klass| -%>
<li class="<%= klass.type %>">
<a href="<%= klass.path %>"><%= klass.full_name %></a>
<%- table = []
table.concat klass.parse(klass.comment_location).table_of_contents
table.concat klass.section_contents
unless table.empty? then %>
<ul>
<%- table.each do |item| -%>
<%- label = item.respond_to?(:label) ? item.label(klass) : item.aref -%>
<li><a href="<%= klass.path %>#<%= label %>"><%= item.plain_html %></a>
<%- end -%>
</ul>
<%- end -%>
</li>
<%- end -%>
</ul>
<h2 id="methods">Methods</h2>
<ul>
<%- @store.all_classes_and_modules.flat_map do |mod|
mod.method_list
end.sort.each do |method| %>
<li class="method">
<a href="<%= method.path %>"><%= h method.pretty_name %></a>
—
<span class="container"><%= method.parent.full_name %></span>
<%- end -%>
</ul>
</main>
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/darkfish.rb 0000644 00000050241 15173517750 0017112 0 ustar 00 # frozen_string_literal: true
# -*- mode: ruby; ruby-indent-level: 2; tab-width: 2 -*-
require 'erb'
require 'fileutils'
require 'pathname'
require_relative 'markup'
##
# Darkfish RDoc HTML Generator
#
# $Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $
#
# == Author/s
# * Michael Granger (ged@FaerieMUD.org)
#
# == Contributors
# * Mahlon E. Smith (mahlon@martini.nu)
# * Eric Hodel (drbrain@segment7.net)
#
# == License
#
# Copyright (c) 2007, 2008, Michael Granger. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# * 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.
#
# * Neither the name of the author/s, nor the names of the project's
# contributors may be used to endorse or promote products derived from this
# software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
#
# == Attributions
#
# Darkfish uses the {Silk Icons}[http://www.famfamfam.com/lab/icons/silk/] set
# by Mark James.
class RDoc::Generator::Darkfish
RDoc::RDoc.add_generator self
include ERB::Util
##
# Stylesheets, fonts, etc. that are included in RDoc.
BUILTIN_STYLE_ITEMS = # :nodoc:
%w[
css/fonts.css
fonts/Lato-Light.ttf
fonts/Lato-LightItalic.ttf
fonts/Lato-Regular.ttf
fonts/Lato-RegularItalic.ttf
fonts/SourceCodePro-Bold.ttf
fonts/SourceCodePro-Regular.ttf
css/rdoc.css
]
##
# Path to this file's parent directory. Used to find templates and other
# resources.
GENERATOR_DIR = File.join 'rdoc', 'generator'
##
# Release Version
VERSION = '3'
##
# Description of this generator
DESCRIPTION = 'HTML generator, written by Michael Granger'
##
# The relative path to style sheets and javascript. By default this is set
# the same as the rel_prefix.
attr_accessor :asset_rel_path
##
# The path to generate files into, combined with <tt>--op</tt> from the
# options for a full path.
attr_reader :base_dir
##
# Classes and modules to be used by this generator, not necessarily
# displayed. See also #modsort
attr_reader :classes
##
# No files will be written when dry_run is true.
attr_accessor :dry_run
##
# When false the generate methods return a String instead of writing to a
# file. The default is true.
attr_accessor :file_output
##
# Files to be displayed by this generator
attr_reader :files
##
# The JSON index generator for this Darkfish generator
attr_reader :json_index
##
# Methods to be displayed by this generator
attr_reader :methods
##
# Sorted list of classes and modules to be displayed by this generator
attr_reader :modsort
##
# The RDoc::Store that is the source of the generated content
attr_reader :store
##
# The directory where the template files live
attr_reader :template_dir # :nodoc:
##
# The output directory
attr_reader :outputdir
##
# Initialize a few instance variables before we start
def initialize store, options
@store = store
@options = options
@asset_rel_path = ''
@base_dir = Pathname.pwd.expand_path
@dry_run = @options.dry_run
@file_output = true
@template_dir = Pathname.new options.template_dir
@template_cache = {}
@classes = nil
@context = nil
@files = nil
@methods = nil
@modsort = nil
@json_index = RDoc::Generator::JsonIndex.new self, options
end
##
# Output progress information if debugging is enabled
def debug_msg *msg
return unless $DEBUG_RDOC
$stderr.puts(*msg)
end
##
# Directory where generated class HTML files live relative to the output
# dir.
def class_dir
nil
end
##
# Directory where generated class HTML files live relative to the output
# dir.
def file_dir
nil
end
##
# Create the directories the generated docs will live in if they don't
# already exist.
def gen_sub_directories
@outputdir.mkpath
end
##
# Copy over the stylesheet into the appropriate place in the output
# directory.
def write_style_sheet
debug_msg "Copying static files"
options = { :verbose => $DEBUG_RDOC, :noop => @dry_run }
BUILTIN_STYLE_ITEMS.each do |item|
install_rdoc_static_file @template_dir + item, "./#{item}", options
end
unless @options.template_stylesheets.empty?
FileUtils.cp @options.template_stylesheets, '.', **options
end
Dir[(@template_dir + "{js,images}/**/*").to_s].each do |path|
next if File.directory? path
next if File.basename(path) =~ /^\./
dst = Pathname.new(path).relative_path_from @template_dir
install_rdoc_static_file @template_dir + path, dst, options
end
end
##
# Build the initial indices and output objects based on an array of TopLevel
# objects containing the extracted information.
def generate
setup
write_style_sheet
generate_index
generate_class_files
generate_file_files
generate_table_of_contents
@json_index.generate
@json_index.generate_gzipped
copy_static
rescue => e
debug_msg "%s: %s\n %s" % [
e.class.name, e.message, e.backtrace.join("\n ")
]
raise
end
##
# Copies static files from the static_path into the output directory
def copy_static
return if @options.static_path.empty?
fu_options = { :verbose => $DEBUG_RDOC, :noop => @dry_run }
@options.static_path.each do |path|
unless File.directory? path then
FileUtils.install path, @outputdir, **fu_options.merge(:mode => 0644)
next
end
Dir.chdir path do
Dir[File.join('**', '*')].each do |entry|
dest_file = @outputdir + entry
if File.directory? entry then
FileUtils.mkdir_p entry, **fu_options
else
FileUtils.install entry, dest_file, **fu_options.merge(:mode => 0644)
end
end
end
end
end
##
# Return a list of the documented modules sorted by salience first, then
# by name.
def get_sorted_module_list classes
classes.select do |klass|
klass.display?
end.sort
end
##
# Generate an index page which lists all the classes which are documented.
def generate_index
setup
template_file = @template_dir + 'index.rhtml'
return unless template_file.exist?
debug_msg "Rendering the index page..."
out_file = @base_dir + @options.op_dir + 'index.html'
rel_prefix = @outputdir.relative_path_from out_file.dirname
search_index_rel_prefix = rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
asset_rel_prefix = rel_prefix + @asset_rel_path
@title = @options.title
render_template template_file, out_file do |io|
here = binding
# suppress 1.9.3 warning
here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
here
end
rescue => e
error = RDoc::Error.new \
"error generating index.html: #{e.message} (#{e.class})"
error.set_backtrace e.backtrace
raise error
end
##
# Generates a class file for +klass+
def generate_class klass, template_file = nil
setup
current = klass
template_file ||= @template_dir + 'class.rhtml'
debug_msg " working on %s (%s)" % [klass.full_name, klass.path]
out_file = @outputdir + klass.path
rel_prefix = @outputdir.relative_path_from out_file.dirname
search_index_rel_prefix = rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
asset_rel_prefix = rel_prefix + @asset_rel_path
svninfo = get_svninfo(current)
@title = "#{klass.type} #{klass.full_name} - #{@options.title}"
debug_msg " rendering #{out_file}"
render_template template_file, out_file do |io|
here = binding
# suppress 1.9.3 warning
here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
here.local_variable_set(:svninfo, svninfo)
here
end
end
##
# Generate a documentation file for each class and module
def generate_class_files
setup
template_file = @template_dir + 'class.rhtml'
template_file = @template_dir + 'classpage.rhtml' unless
template_file.exist?
return unless template_file.exist?
debug_msg "Generating class documentation in #{@outputdir}"
current = nil
@classes.each do |klass|
current = klass
generate_class klass, template_file
end
rescue => e
error = RDoc::Error.new \
"error generating #{current.path}: #{e.message} (#{e.class})"
error.set_backtrace e.backtrace
raise error
end
##
# Generate a documentation file for each file
def generate_file_files
setup
page_file = @template_dir + 'page.rhtml'
fileinfo_file = @template_dir + 'fileinfo.rhtml'
# for legacy templates
filepage_file = @template_dir + 'filepage.rhtml' unless
page_file.exist? or fileinfo_file.exist?
return unless
page_file.exist? or fileinfo_file.exist? or filepage_file.exist?
debug_msg "Generating file documentation in #{@outputdir}"
out_file = nil
current = nil
@files.each do |file|
current = file
if file.text? and page_file.exist? then
generate_page file
next
end
template_file = nil
out_file = @outputdir + file.path
debug_msg " working on %s (%s)" % [file.full_name, out_file]
rel_prefix = @outputdir.relative_path_from out_file.dirname
search_index_rel_prefix = rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
asset_rel_prefix = rel_prefix + @asset_rel_path
unless filepage_file then
if file.text? then
next unless page_file.exist?
template_file = page_file
@title = file.page_name
else
next unless fileinfo_file.exist?
template_file = fileinfo_file
@title = "File: #{file.base_name}"
end
end
@title += " - #{@options.title}"
template_file ||= filepage_file
render_template template_file, out_file do |io|
here = binding
# suppress 1.9.3 warning
here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
here.local_variable_set(:current, current)
here
end
end
rescue => e
error =
RDoc::Error.new "error generating #{out_file}: #{e.message} (#{e.class})"
error.set_backtrace e.backtrace
raise error
end
##
# Generate a page file for +file+
def generate_page file
setup
template_file = @template_dir + 'page.rhtml'
out_file = @outputdir + file.path
debug_msg " working on %s (%s)" % [file.full_name, out_file]
rel_prefix = @outputdir.relative_path_from out_file.dirname
search_index_rel_prefix = rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
current = file
asset_rel_prefix = rel_prefix + @asset_rel_path
@title = "#{file.page_name} - #{@options.title}"
debug_msg " rendering #{out_file}"
render_template template_file, out_file do |io|
here = binding
# suppress 1.9.3 warning
here.local_variable_set(:current, current)
here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
here
end
end
##
# Generates the 404 page for the RDoc servlet
def generate_servlet_not_found message
setup
template_file = @template_dir + 'servlet_not_found.rhtml'
return unless template_file.exist?
debug_msg "Rendering the servlet 404 Not Found page..."
rel_prefix = rel_prefix = ''
search_index_rel_prefix = rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
asset_rel_prefix = ''
@title = 'Not Found'
render_template template_file do |io|
here = binding
# suppress 1.9.3 warning
here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
here
end
rescue => e
error = RDoc::Error.new \
"error generating servlet_not_found: #{e.message} (#{e.class})"
error.set_backtrace e.backtrace
raise error
end
##
# Generates the servlet root page for the RDoc servlet
def generate_servlet_root installed
setup
template_file = @template_dir + 'servlet_root.rhtml'
return unless template_file.exist?
debug_msg 'Rendering the servlet root page...'
rel_prefix = '.'
asset_rel_prefix = rel_prefix
search_index_rel_prefix = asset_rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
@title = 'Local RDoc Documentation'
render_template template_file do |io| binding end
rescue => e
error = RDoc::Error.new \
"error generating servlet_root: #{e.message} (#{e.class})"
error.set_backtrace e.backtrace
raise error
end
##
# Generate an index page which lists all the classes which are documented.
def generate_table_of_contents
setup
template_file = @template_dir + 'table_of_contents.rhtml'
return unless template_file.exist?
debug_msg "Rendering the Table of Contents..."
out_file = @outputdir + 'table_of_contents.html'
rel_prefix = @outputdir.relative_path_from out_file.dirname
search_index_rel_prefix = rel_prefix
search_index_rel_prefix += @asset_rel_path if @file_output
asset_rel_prefix = rel_prefix + @asset_rel_path
@title = "Table of Contents - #{@options.title}"
render_template template_file, out_file do |io|
here = binding
# suppress 1.9.3 warning
here.local_variable_set(:asset_rel_prefix, asset_rel_prefix)
here
end
rescue => e
error = RDoc::Error.new \
"error generating table_of_contents.html: #{e.message} (#{e.class})"
error.set_backtrace e.backtrace
raise error
end
def install_rdoc_static_file source, destination, options # :nodoc:
return unless source.exist?
begin
FileUtils.mkdir_p File.dirname(destination), **options
begin
FileUtils.ln source, destination, **options
rescue Errno::EEXIST
FileUtils.rm destination
retry
end
rescue
FileUtils.cp source, destination, **options
end
end
##
# Prepares for generation of output from the current directory
def setup
return if instance_variable_defined? :@outputdir
@outputdir = Pathname.new(@options.op_dir).expand_path @base_dir
return unless @store
@classes = @store.all_classes_and_modules.sort
@files = @store.all_files.sort
@methods = @classes.flat_map { |m| m.method_list }.sort
@modsort = get_sorted_module_list @classes
end
##
# Return a string describing the amount of time in the given number of
# seconds in terms a human can understand easily.
def time_delta_string seconds
return 'less than a minute' if seconds < 60
return "#{seconds / 60} minute#{seconds / 60 == 1 ? '' : 's'}" if
seconds < 3000 # 50 minutes
return 'about one hour' if seconds < 5400 # 90 minutes
return "#{seconds / 3600} hours" if seconds < 64800 # 18 hours
return 'one day' if seconds < 86400 # 1 day
return 'about one day' if seconds < 172800 # 2 days
return "#{seconds / 86400} days" if seconds < 604800 # 1 week
return 'about one week' if seconds < 1209600 # 2 week
return "#{seconds / 604800} weeks" if seconds < 7257600 # 3 months
return "#{seconds / 2419200} months" if seconds < 31536000 # 1 year
return "#{seconds / 31536000} years"
end
# %q$Id: darkfish.rb 52 2009-01-07 02:08:11Z deveiant $"
SVNID_PATTERN = /
\$Id:\s
(\S+)\s # filename
(\d+)\s # rev
(\d{4}-\d{2}-\d{2})\s # Date (YYYY-MM-DD)
(\d{2}:\d{2}:\d{2}Z)\s # Time (HH:MM:SSZ)
(\w+)\s # committer
\$$
/x
##
# Try to extract Subversion information out of the first constant whose
# value looks like a subversion Id tag. If no matching constant is found,
# and empty hash is returned.
def get_svninfo klass
constants = klass.constants or return {}
constants.find { |c| c.value =~ SVNID_PATTERN } or return {}
filename, rev, date, time, committer = $~.captures
commitdate = Time.parse "#{date} #{time}"
return {
:filename => filename,
:rev => Integer(rev),
:commitdate => commitdate,
:commitdelta => time_delta_string(Time.now - commitdate),
:committer => committer,
}
end
##
# Creates a template from its components and the +body_file+.
#
# For backwards compatibility, if +body_file+ contains "<html" the body is
# used directly.
def assemble_template body_file
body = body_file.read
return body if body =~ /<html/
head_file = @template_dir + '_head.rhtml'
footer_file = @template_dir + '_footer.rhtml'
<<-TEMPLATE
<!DOCTYPE html>
<html>
<head>
#{head_file.read}
#{body}
#{footer_file.read}
TEMPLATE
end
##
# Renders the ERb contained in +file_name+ relative to the template
# directory and returns the result based on the current context.
def render file_name
template_file = @template_dir + file_name
template = template_for template_file, false, RDoc::ERBPartial
template.filename = template_file.to_s
template.result @context
end
##
# Load and render the erb template in the given +template_file+ and write
# it out to +out_file+.
#
# Both +template_file+ and +out_file+ should be Pathname-like objects.
#
# An io will be yielded which must be captured by binding in the caller.
def render_template template_file, out_file = nil # :yield: io
io_output = out_file && !@dry_run && @file_output
erb_klass = io_output ? RDoc::ERBIO : ERB
template = template_for template_file, true, erb_klass
if io_output then
debug_msg "Outputting to %s" % [out_file.expand_path]
out_file.dirname.mkpath
out_file.open 'w', 0644 do |io|
io.set_encoding @options.encoding
@context = yield io
template_result template, @context, template_file
end
else
@context = yield nil
output = template_result template, @context, template_file
debug_msg " would have written %d characters to %s" % [
output.length, out_file.expand_path
] if @dry_run
output
end
end
##
# Creates the result for +template+ with +context+. If an error is raised a
# Pathname +template_file+ will indicate the file where the error occurred.
def template_result template, context, template_file
template.filename = template_file.to_s
template.result context
rescue NoMethodError => e
raise RDoc::Error, "Error while evaluating %s: %s" % [
template_file.expand_path,
e.message,
], e.backtrace
end
##
# Retrieves a cache template for +file+, if present, or fills the cache.
def template_for file, page = true, klass = ERB
template = @template_cache[file]
return template if template
if page then
template = assemble_template file
erbout = 'io'
else
template = file.read
template = template.encode @options.encoding
file_var = File.basename(file).sub(/\..*/, '')
erbout = "_erbout_#{file_var}"
end
template = klass.new template, trim_mode: '-', eoutvar: erbout
@template_cache[file] = template
template
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/markup.rb 0000644 00000006411 15173517750 0016616 0 ustar 00 # frozen_string_literal: true
##
# Handle common RDoc::Markup tasks for various CodeObjects
#
# This module is loaded by generators. It allows RDoc's CodeObject tree to
# avoid loading generator code to improve startup time for +ri+.
module RDoc::Generator::Markup
##
# Generates a relative URL from this object's path to +target_path+
def aref_to(target_path)
RDoc::Markup::ToHtml.gen_relative_url path, target_path
end
##
# Generates a relative URL from +from_path+ to this object's path
def as_href(from_path)
RDoc::Markup::ToHtml.gen_relative_url from_path, path
end
##
# Handy wrapper for marking up this object's comment
def description
markup @comment
end
##
# Creates an RDoc::Markup::ToHtmlCrossref formatter
def formatter
return @formatter if defined? @formatter
options = @store.rdoc.options
this = RDoc::Context === self ? self : @parent
@formatter = RDoc::Markup::ToHtmlCrossref.new options, this.path, this
@formatter.code_object = self
@formatter
end
##
# Build a webcvs URL starting for the given +url+ with +full_path+ appended
# as the destination path. If +url+ contains '%s' +full_path+ will be
# will replace the %s using sprintf on the +url+.
def cvs_url(url, full_path)
if /%s/ =~ url then
sprintf url, full_path
else
url + full_path
end
end
end
class RDoc::CodeObject
include RDoc::Generator::Markup
end
class RDoc::MethodAttr
##
# Prepend +src+ with line numbers. Relies on the first line of a source
# code listing having:
#
# # File xxxxx, line dddd
#
# If it has this comment then line numbers are added to +src+ and the <tt>,
# line dddd</tt> portion of the comment is removed.
def add_line_numbers(src)
return unless src.sub!(/\A(.*)(, line (\d+))/, '\1')
first = $3.to_i - 1
last = first + src.count("\n")
size = last.to_s.length
line = first
src.gsub!(/^/) do
res = if line == first then
" " * (size + 1)
else
"<span class=\"line-num\">%2$*1$d</span> " % [size, line]
end
line += 1
res
end
end
##
# Turns the method's token stream into HTML.
#
# Prepends line numbers if +options.line_numbers+ is true.
def markup_code
return '' unless @token_stream
src = RDoc::TokenStream.to_html @token_stream
# dedent the source
indent = src.length
lines = src.lines.to_a
lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
lines.each do |line|
if line =~ /^ *(?=\S)/
n = $~.end(0)
indent = n if n < indent
break if n == 0
end
end
src.gsub!(/^#{' ' * indent}/, '') if indent > 0
add_line_numbers(src) if options.line_numbers
src
end
end
class RDoc::ClassModule
##
# Handy wrapper for marking up this class or module's comment
def description
markup @comment_location
end
end
class RDoc::Context::Section
include RDoc::Generator::Markup
end
class RDoc::TopLevel
##
# Returns a URL for this source file on some web repository. Use the -W
# command line option to set.
def cvs_url
url = @store.rdoc.options.webcvs
if /%s/ =~ url then
url % @relative_name
else
url + @relative_name
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/generator/ri.rb 0000644 00000000717 15173517750 0015734 0 ustar 00 # frozen_string_literal: true
##
# Generates ri data files
class RDoc::Generator::RI
RDoc::RDoc.add_generator self
##
# Description of this generator
DESCRIPTION = 'creates ri data files'
##
# Set up a new ri generator
def initialize store, options #:not-new:
@options = options
@store = store
@store.path = '.'
end
##
# Writes the parsed data store to disk for use by ri.
def generate
@store.save
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/ghost_method.rb 0000644 00000000217 15173517750 0016013 0 ustar 00 # frozen_string_literal: true
##
# GhostMethod represents a method referenced only by a comment
class RDoc::GhostMethod < RDoc::AnyMethod
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/single_class.rb 0000644 00000000777 15173517751 0016011 0 ustar 00 # frozen_string_literal: true
##
# A singleton class
class RDoc::SingleClass < RDoc::ClassModule
##
# Adds the superclass to the included modules.
def ancestors
superclass ? super + [superclass] : super
end
def aref_prefix # :nodoc:
'sclass'
end
##
# The definition of this singleton class, <tt>class << MyClassName</tt>
def definition
"class << #{full_name}"
end
def pretty_print q # :nodoc:
q.group 2, "[class << #{full_name}", "]" do
next
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/task.rb 0000644 00000020530 15173517751 0014272 0 ustar 00 # frozen_string_literal: true
#--
# Copyright (c) 2003, 2004 Jim Weirich, 2009 Eric Hodel
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#++
begin
gem 'rdoc'
rescue Gem::LoadError
end unless defined?(RDoc)
begin
gem 'rake'
rescue Gem::LoadError
end unless defined?(Rake)
require_relative '../rdoc'
require 'rake'
require 'rake/tasklib'
##
# RDoc::Task creates the following rake tasks to generate and clean up RDoc
# output:
#
# [rdoc]
# Main task for this RDoc task.
#
# [clobber_rdoc]
# Delete all the rdoc files. This target is automatically added to the main
# clobber target.
#
# [rerdoc]
# Rebuild the rdoc files from scratch, even if they are not out of date.
#
# [rdoc:coverage]
# Print RDoc coverage report for all rdoc files.
#
# Simple Example:
#
# require 'rdoc/task'
#
# RDoc::Task.new do |rdoc|
# rdoc.main = "README.rdoc"
# rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
# end
#
# The +rdoc+ object passed to the block is an RDoc::Task object. See the
# attributes list for the RDoc::Task class for available customization options.
#
# == Specifying different task names
#
# You may wish to give the task a different name, such as if you are
# generating two sets of documentation. For instance, if you want to have a
# development set of documentation including private methods:
#
# require 'rdoc/task'
#
# RDoc::Task.new :rdoc_dev do |rdoc|
# rdoc.main = "README.rdoc"
# rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
# rdoc.options << "--all"
# end
#
# The tasks would then be named :<em>rdoc_dev</em>,
# :clobber_<em>rdoc_dev</em>, and :re<em>rdoc_dev</em>.
#
# If you wish to have completely different task names, then pass a Hash as
# first argument. With the <tt>:rdoc</tt>, <tt>:clobber_rdoc</tt> and
# <tt>:rerdoc</tt> options, you can customize the task names to your liking.
#
# For example:
#
# require 'rdoc/task'
#
# RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
# :rerdoc => "rdoc:force")
#
# This will create the tasks <tt>:rdoc</tt>, <tt>:rdoc:clean</tt>,
# <tt>:rdoc:force</tt>, and <tt>:rdoc:coverage</tt>.
class RDoc::Task < Rake::TaskLib
##
# Name of the main, top level task. (default is :rdoc)
attr_accessor :name
##
# Comment markup format. rdoc, rd and tomdoc are supported. (default is
# 'rdoc')
attr_accessor :markup
##
# Name of directory to receive the html output files. (default is "html")
attr_accessor :rdoc_dir
##
# Title of RDoc documentation. (defaults to rdoc's default)
attr_accessor :title
##
# Name of file to be used as the main, top level file of the RDoc. (default
# is none)
attr_accessor :main
##
# Name of template to be used by rdoc. (defaults to rdoc's default)
attr_accessor :template
##
# Name of format generator (<tt>--format</tt>) used by rdoc. (defaults to
# rdoc's default)
attr_accessor :generator
##
# List of files to be included in the rdoc generation. (default is [])
attr_accessor :rdoc_files
##
# Additional list of options to be passed rdoc. (default is [])
attr_accessor :options
##
# Whether to run the rdoc process as an external shell (default is false)
attr_accessor :external
##
# Create an RDoc task with the given name. See the RDoc::Task class overview
# for documentation.
def initialize name = :rdoc # :yield: self
defaults
check_names name
@name = name
yield self if block_given?
define
end
##
# Ensures that +names+ only includes names for the :rdoc, :clobber_rdoc and
# :rerdoc. If other names are given an ArgumentError is raised.
def check_names names
return unless Hash === names
invalid_options =
names.keys.map { |k| k.to_sym } - [:rdoc, :clobber_rdoc, :rerdoc]
unless invalid_options.empty? then
raise ArgumentError, "invalid options: #{invalid_options.join ', '}"
end
end
##
# Task description for the clobber rdoc task or its renamed equivalent
def clobber_task_description
"Remove RDoc HTML files"
end
##
# Sets default task values
def defaults
@name = :rdoc
@rdoc_files = Rake::FileList.new
@rdoc_dir = 'html'
@main = nil
@title = nil
@template = nil
@generator = nil
@options = []
end
##
# All source is inline now. This method is deprecated
def inline_source # :nodoc:
warn "RDoc::Task#inline_source is deprecated"
true
end
##
# All source is inline now. This method is deprecated
def inline_source=(value) # :nodoc:
warn "RDoc::Task#inline_source is deprecated"
end
##
# Create the tasks defined by this task lib.
def define
desc rdoc_task_description
task rdoc_task_name
desc rerdoc_task_description
task rerdoc_task_name => [clobber_task_name, rdoc_task_name]
desc clobber_task_description
task clobber_task_name do
rm_r @rdoc_dir rescue nil
end
task :clobber => [clobber_task_name]
directory @rdoc_dir
rdoc_target_deps = [
@rdoc_files,
Rake.application.rakefile
].flatten.compact
task rdoc_task_name => [rdoc_target]
file rdoc_target => rdoc_target_deps do
@before_running_rdoc.call if @before_running_rdoc
args = option_list + @rdoc_files
$stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
RDoc::RDoc.new.document args
end
namespace rdoc_task_name do
desc coverage_task_description
task coverage_task_name do
@before_running_rdoc.call if @before_running_rdoc
opts = option_list << "-C"
args = opts + @rdoc_files
$stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
RDoc::RDoc.new.document args
end
end
self
end
##
# List of options that will be supplied to RDoc
def option_list
result = @options.dup
result << "-o" << @rdoc_dir
result << "--main" << main if main
result << "--markup" << markup if markup
result << "--title" << title if title
result << "-T" << template if template
result << '-f' << generator if generator
result
end
##
# The block passed to this method will be called just before running the
# RDoc generator. It is allowed to modify RDoc::Task attributes inside the
# block.
def before_running_rdoc(&block)
@before_running_rdoc = block
end
##
# Task description for the rdoc task or its renamed equivalent
def rdoc_task_description
'Build RDoc HTML files'
end
##
# Task description for the rerdoc task or its renamed description
def rerdoc_task_description
"Rebuild RDoc HTML files"
end
##
# Task description for the coverage task or its renamed description
def coverage_task_description
"Print RDoc coverage report"
end
private
def rdoc_target
"#{rdoc_dir}/created.rid"
end
def rdoc_task_name
case name
when Hash then (name[:rdoc] || "rdoc").to_s
else name.to_s
end
end
def clobber_task_name
case name
when Hash then (name[:clobber_rdoc] || "clobber_rdoc").to_s
else "clobber_#{name}"
end
end
def rerdoc_task_name
case name
when Hash then (name[:rerdoc] || "rerdoc").to_s
else "re#{name}"
end
end
def coverage_task_name
"coverage"
end
end
# :stopdoc:
module Rake
##
# For backwards compatibility
RDocTask = RDoc::Task # :nodoc:
end
# :startdoc:
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/code_objects.rb 0000644 00000000242 15173517751 0015751 0 ustar 00 # frozen_string_literal: true
# This file was used to load all the RDoc::CodeObject subclasses at once. Now
# autoload handles this.
require_relative '../rdoc'
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/options.rb 0000644 00000103353 15173517751 0015030 0 ustar 00 # frozen_string_literal: true
require 'optparse'
require 'pathname'
##
# RDoc::Options handles the parsing and storage of options
#
# == Saved Options
#
# You can save some options like the markup format in the
# <tt>.rdoc_options</tt> file in your gem. The easiest way to do this is:
#
# rdoc --markup tomdoc --write-options
#
# Which will automatically create the file and fill it with the options you
# specified.
#
# The following options will not be saved since they interfere with the user's
# preferences or with the normal operation of RDoc:
#
# * +--coverage-report+
# * +--dry-run+
# * +--encoding+
# * +--force-update+
# * +--format+
# * +--pipe+
# * +--quiet+
# * +--template+
# * +--verbose+
#
# == Custom Options
#
# Generators can hook into RDoc::Options to add generator-specific command
# line options.
#
# When <tt>--format</tt> is encountered in ARGV, RDoc calls ::setup_options on
# the generator class to add extra options to the option parser. Options for
# custom generators must occur after <tt>--format</tt>. <tt>rdoc --help</tt>
# will list options for all installed generators.
#
# Example:
#
# class RDoc::Generator::Spellcheck
# RDoc::RDoc.add_generator self
#
# def self.setup_options rdoc_options
# op = rdoc_options.option_parser
#
# op.on('--spell-dictionary DICTIONARY',
# RDoc::Options::Path) do |dictionary|
# rdoc_options.spell_dictionary = dictionary
# end
# end
# end
#
# Of course, RDoc::Options does not respond to +spell_dictionary+ by default
# so you will need to add it:
#
# class RDoc::Options
#
# ##
# # The spell dictionary used by the spell-checking plugin.
#
# attr_accessor :spell_dictionary
#
# end
#
# == Option Validators
#
# OptionParser validators will validate and cast user input values. In
# addition to the validators that ship with OptionParser (String, Integer,
# Float, TrueClass, FalseClass, Array, Regexp, Date, Time, URI, etc.),
# RDoc::Options adds Path, PathArray and Template.
class RDoc::Options
##
# The deprecated options.
DEPRECATED = {
'--accessor' => 'support discontinued',
'--diagram' => 'support discontinued',
'--help-output' => 'support discontinued',
'--image-format' => 'was an option for --diagram',
'--inline-source' => 'source code is now always inlined',
'--merge' => 'ri now always merges class information',
'--one-file' => 'support discontinued',
'--op-name' => 'support discontinued',
'--opname' => 'support discontinued',
'--promiscuous' => 'files always only document their content',
'--ri-system' => 'Ruby installers use other techniques',
}
##
# RDoc options ignored (or handled specially) by --write-options
SPECIAL = %w[
coverage_report
dry_run
encoding
files
force_output
force_update
generator
generator_name
generator_options
generators
op_dir
page_dir
option_parser
pipe
rdoc_include
root
static_path
stylesheet_url
template
template_dir
update_output_dir
verbosity
write_options
]
##
# Option validator for OptionParser that matches a directory that exists on
# the filesystem.
Directory = Object.new
##
# Option validator for OptionParser that matches a file or directory that
# exists on the filesystem.
Path = Object.new
##
# Option validator for OptionParser that matches a comma-separated list of
# files or directories that exist on the filesystem.
PathArray = Object.new
##
# Option validator for OptionParser that matches a template directory for an
# installed generator that lives in
# <tt>"rdoc/generator/template/#{template_name}"</tt>
Template = Object.new
##
# Character-set for HTML output. #encoding is preferred over #charset
attr_accessor :charset
##
# If true, RDoc will not write any files.
attr_accessor :dry_run
##
# The output encoding. All input files will be transcoded to this encoding.
#
# The default encoding is UTF-8. This is set via --encoding.
attr_accessor :encoding
##
# Files matching this pattern will be excluded
attr_writer :exclude
##
# The list of files to be processed
attr_accessor :files
##
# Create the output even if the output directory does not look
# like an rdoc output directory
attr_accessor :force_output
##
# Scan newer sources than the flag file if true.
attr_accessor :force_update
##
# Formatter to mark up text with
attr_accessor :formatter
##
# Description of the output generator (set with the <tt>--format</tt> option)
attr_accessor :generator
##
# For #==
attr_reader :generator_name # :nodoc:
##
# Loaded generator options. Used to prevent --help from loading the same
# options multiple times.
attr_accessor :generator_options
##
# Old rdoc behavior: hyperlink all words that match a method name,
# even if not preceded by '#' or '::'
attr_accessor :hyperlink_all
##
# Include line numbers in the source code
attr_accessor :line_numbers
##
# The output locale.
attr_accessor :locale
##
# The directory where locale data live.
attr_accessor :locale_dir
##
# Name of the file, class or module to display in the initial index page (if
# not specified the first file we encounter is used)
attr_accessor :main_page
##
# The default markup format. The default is 'rdoc'. 'markdown', 'tomdoc'
# and 'rd' are also built-in.
attr_accessor :markup
##
# If true, only report on undocumented files
attr_accessor :coverage_report
##
# The name of the output directory
attr_accessor :op_dir
##
# The OptionParser for this instance
attr_accessor :option_parser
##
# Output heading decorations?
attr_accessor :output_decoration
##
# Directory where guides, FAQ, and other pages not associated with a class
# live. You may leave this unset if these are at the root of your project.
attr_accessor :page_dir
##
# Is RDoc in pipe mode?
attr_accessor :pipe
##
# Array of directories to search for files to satisfy an :include:
attr_accessor :rdoc_include
##
# Root of the source documentation will be generated for. Set this when
# building documentation outside the source directory. Defaults to the
# current directory.
attr_accessor :root
##
# Include the '#' at the front of hyperlinked instance method names
attr_accessor :show_hash
##
# Directory to copy static files from
attr_accessor :static_path
##
# The number of columns in a tab
attr_accessor :tab_width
##
# Template to be used when generating output
attr_accessor :template
##
# Directory the template lives in
attr_accessor :template_dir
##
# Additional template stylesheets
attr_accessor :template_stylesheets
##
# Documentation title
attr_accessor :title
##
# Should RDoc update the timestamps in the output dir?
attr_accessor :update_output_dir
##
# Verbosity, zero means quiet
attr_accessor :verbosity
##
# URL of web cvs frontend
attr_accessor :webcvs
##
# Minimum visibility of a documented method. One of +:public+, +:protected+,
# +:private+ or +:nodoc+.
#
# The +:nodoc+ visibility ignores all directives related to visibility. The
# other visibilities may be overridden on a per-method basis with the :doc:
# directive.
attr_reader :visibility
##
# Indicates if files of test suites should be skipped
attr_accessor :skip_tests
def initialize loaded_options = nil # :nodoc:
init_ivars
override loaded_options if loaded_options
end
def init_ivars # :nodoc:
@dry_run = false
@exclude = %w[
~\z \.orig\z \.rej\z \.bak\z
\.gemspec\z
]
@files = nil
@force_output = false
@force_update = true
@generator = nil
@generator_name = nil
@generator_options = []
@generators = RDoc::RDoc::GENERATORS
@hyperlink_all = false
@line_numbers = false
@locale = nil
@locale_name = nil
@locale_dir = 'locale'
@main_page = nil
@markup = 'rdoc'
@coverage_report = false
@op_dir = nil
@page_dir = nil
@pipe = false
@output_decoration = true
@rdoc_include = []
@root = Pathname(Dir.pwd)
@show_hash = false
@static_path = []
@stylesheet_url = nil # TODO remove in RDoc 4
@tab_width = 8
@template = nil
@template_dir = nil
@template_stylesheets = []
@title = nil
@update_output_dir = true
@verbosity = 1
@visibility = :protected
@webcvs = nil
@write_options = false
@encoding = Encoding::UTF_8
@charset = @encoding.name
@skip_tests = true
end
def init_with map # :nodoc:
init_ivars
encoding = map['encoding']
@encoding = encoding ? Encoding.find(encoding) : encoding
@charset = map['charset']
@exclude = map['exclude']
@generator_name = map['generator_name']
@hyperlink_all = map['hyperlink_all']
@line_numbers = map['line_numbers']
@locale_name = map['locale_name']
@locale_dir = map['locale_dir']
@main_page = map['main_page']
@markup = map['markup']
@op_dir = map['op_dir']
@show_hash = map['show_hash']
@tab_width = map['tab_width']
@template_dir = map['template_dir']
@title = map['title']
@visibility = map['visibility']
@webcvs = map['webcvs']
@rdoc_include = sanitize_path map['rdoc_include']
@static_path = sanitize_path map['static_path']
end
def yaml_initialize tag, map # :nodoc:
init_with map
end
def override map # :nodoc:
if map.has_key?('encoding')
encoding = map['encoding']
@encoding = encoding ? Encoding.find(encoding) : encoding
end
@charset = map['charset'] if map.has_key?('charset')
@exclude = map['exclude'] if map.has_key?('exclude')
@generator_name = map['generator_name'] if map.has_key?('generator_name')
@hyperlink_all = map['hyperlink_all'] if map.has_key?('hyperlink_all')
@line_numbers = map['line_numbers'] if map.has_key?('line_numbers')
@locale_name = map['locale_name'] if map.has_key?('locale_name')
@locale_dir = map['locale_dir'] if map.has_key?('locale_dir')
@main_page = map['main_page'] if map.has_key?('main_page')
@markup = map['markup'] if map.has_key?('markup')
@op_dir = map['op_dir'] if map.has_key?('op_dir')
@page_dir = map['page_dir'] if map.has_key?('page_dir')
@show_hash = map['show_hash'] if map.has_key?('show_hash')
@tab_width = map['tab_width'] if map.has_key?('tab_width')
@template_dir = map['template_dir'] if map.has_key?('template_dir')
@title = map['title'] if map.has_key?('title')
@visibility = map['visibility'] if map.has_key?('visibility')
@webcvs = map['webcvs'] if map.has_key?('webcvs')
if map.has_key?('rdoc_include')
@rdoc_include = sanitize_path map['rdoc_include']
end
if map.has_key?('static_path')
@static_path = sanitize_path map['static_path']
end
end
def == other # :nodoc:
self.class === other and
@encoding == other.encoding and
@generator_name == other.generator_name and
@hyperlink_all == other.hyperlink_all and
@line_numbers == other.line_numbers and
@locale == other.locale and
@locale_dir == other.locale_dir and
@main_page == other.main_page and
@markup == other.markup and
@op_dir == other.op_dir and
@rdoc_include == other.rdoc_include and
@show_hash == other.show_hash and
@static_path == other.static_path and
@tab_width == other.tab_width and
@template == other.template and
@title == other.title and
@visibility == other.visibility and
@webcvs == other.webcvs
end
##
# Check that the files on the command line exist
def check_files
@files.delete_if do |file|
if File.exist? file then
if File.readable? file then
false
else
warn "file '#{file}' not readable"
true
end
else
warn "file '#{file}' not found"
true
end
end
end
##
# Ensure only one generator is loaded
def check_generator
if @generator then
raise OptionParser::InvalidOption,
"generator already set to #{@generator_name}"
end
end
##
# Set the title, but only if not already set. Used to set the title
# from a source file, so that a title set from the command line
# will have the priority.
def default_title=(string)
@title ||= string
end
##
# For dumping YAML
def to_yaml(*options) # :nodoc:
encoding = @encoding ? @encoding.name : nil
yaml = {}
yaml['encoding'] = encoding
yaml['static_path'] = sanitize_path(@static_path)
yaml['rdoc_include'] = sanitize_path(@rdoc_include)
yaml['page_dir'] = (sanitize_path([@page_dir]).first if @page_dir)
ivars = instance_variables.map { |ivar| ivar.to_s[1..-1] }
ivars -= SPECIAL
ivars.sort.each do |ivar|
yaml[ivar] = instance_variable_get("@#{ivar}")
end
yaml.to_yaml
end
##
# Create a regexp for #exclude
def exclude
if @exclude.nil? or Regexp === @exclude then
# done, #finish is being re-run
@exclude
elsif @exclude.empty? then
nil
else
Regexp.new(@exclude.join("|"))
end
end
##
# Completes any unfinished option setup business such as filtering for
# existent files, creating a regexp for #exclude and setting a default
# #template.
def finish
if @write_options then
write_options
exit
end
@op_dir ||= 'doc'
root = @root.to_s
if @rdoc_include.empty? || !@rdoc_include.include?(root)
@rdoc_include << root
end
@exclude = self.exclude
finish_page_dir
check_files
# If no template was specified, use the default template for the output
# formatter
unless @template then
@template = @generator_name
@template_dir = template_dir_for @template
end
if @locale_name
@locale = RDoc::I18n::Locale[@locale_name]
@locale.load(@locale_dir)
else
@locale = nil
end
self
end
##
# Fixes the page_dir to be relative to the root_dir and adds the page_dir to
# the files list.
def finish_page_dir
return unless @page_dir
@files << @page_dir
page_dir = Pathname(@page_dir)
begin
page_dir = page_dir.expand_path.relative_path_from @root
rescue ArgumentError
# On Windows, sometimes crosses different drive letters.
page_dir = page_dir.expand_path
end
@page_dir = page_dir
end
##
# Returns a properly-space list of generators and their descriptions.
def generator_descriptions
lengths = []
generators = RDoc::RDoc::GENERATORS.map do |name, generator|
lengths << name.length
description = generator::DESCRIPTION if
generator.const_defined? :DESCRIPTION
[name, description]
end
longest = lengths.max
generators.sort.map do |name, description|
if description then
" %-*s - %s" % [longest, name, description]
else
" #{name}"
end
end.join "\n"
end
##
# Parses command line options.
def parse argv
ignore_invalid = true
argv.insert(0, *ENV['RDOCOPT'].split) if ENV['RDOCOPT']
opts = OptionParser.new do |opt|
@option_parser = opt
opt.program_name = File.basename $0
opt.version = RDoc::VERSION
opt.release = nil
opt.summary_indent = ' ' * 4
opt.banner = <<-EOF
Usage: #{opt.program_name} [options] [names...]
Files are parsed, and the information they contain collected, before any
output is produced. This allows cross references between all files to be
resolved. If a name is a directory, it is traversed. If no names are
specified, all Ruby files in the current directory (and subdirectories) are
processed.
How RDoc generates output depends on the output formatter being used, and on
the options you give.
Options can be specified via the RDOCOPT environment variable, which
functions similar to the RUBYOPT environment variable for ruby.
$ export RDOCOPT="--show-hash"
will make rdoc show hashes in method links by default. Command-line options
always will override those in RDOCOPT.
Available formatters:
#{generator_descriptions}
RDoc understands the following file formats:
EOF
parsers = Hash.new { |h,parser| h[parser] = [] }
RDoc::Parser.parsers.each do |regexp, parser|
parsers[parser.name.sub('RDoc::Parser::', '')] << regexp.source
end
parsers.sort.each do |parser, regexp|
opt.banner += " - #{parser}: #{regexp.join ', '}\n"
end
opt.banner += " - TomDoc: Only in ruby files\n"
opt.banner += "\n The following options are deprecated:\n\n"
name_length = DEPRECATED.keys.sort_by { |k| k.length }.last.length
DEPRECATED.sort_by { |k,| k }.each do |name, reason|
opt.banner += " %*1$2$s %3$s\n" % [-name_length, name, reason]
end
opt.accept Template do |template|
template_dir = template_dir_for template
unless template_dir then
$stderr.puts "could not find template #{template}"
nil
else
[template, template_dir]
end
end
opt.accept Directory do |directory|
directory = File.expand_path directory
raise OptionParser::InvalidArgument unless File.directory? directory
directory
end
opt.accept Path do |path|
path = File.expand_path path
raise OptionParser::InvalidArgument unless File.exist? path
path
end
opt.accept PathArray do |paths,|
paths = if paths then
paths.split(',').map { |d| d unless d.empty? }
end
paths.map do |path|
path = File.expand_path path
raise OptionParser::InvalidArgument unless File.exist? path
path
end
end
opt.separator nil
opt.separator "Parsing options:"
opt.separator nil
opt.on("--encoding=ENCODING", "-e", Encoding.list.map { |e| e.name },
"Specifies the output encoding. All files",
"read will be converted to this encoding.",
"The default encoding is UTF-8.",
"--encoding is preferred over --charset") do |value|
@encoding = Encoding.find value
@charset = @encoding.name # may not be valid value
end
opt.separator nil
opt.on("--locale=NAME",
"Specifies the output locale.") do |value|
@locale_name = value
end
opt.on("--locale-data-dir=DIR",
"Specifies the directory where locale data live.") do |value|
@locale_dir = value
end
opt.separator nil
opt.on("--all", "-a",
"Synonym for --visibility=private.") do |value|
@visibility = :private
end
opt.separator nil
opt.on("--exclude=PATTERN", "-x", Regexp,
"Do not process files or directories",
"matching PATTERN.") do |value|
@exclude << value
end
opt.separator nil
opt.on("--no-skipping-tests", nil,
"Don't skip generating documentation for test and spec files") do |value|
@skip_tests = false
end
opt.separator nil
opt.on("--extension=NEW=OLD", "-E",
"Treat files ending with .new as if they",
"ended with .old. Using '-E cgi=rb' will",
"cause xxx.cgi to be parsed as a Ruby file.") do |value|
new, old = value.split(/=/, 2)
unless new and old then
raise OptionParser::InvalidArgument, "Invalid parameter to '-E'"
end
unless RDoc::Parser.alias_extension old, new then
raise OptionParser::InvalidArgument, "Unknown extension .#{old} to -E"
end
end
opt.separator nil
opt.on("--[no-]force-update", "-U",
"Forces rdoc to scan all sources even if",
"no files are newer than the flag file.") do |value|
@force_update = value
end
opt.separator nil
opt.on("--pipe", "-p",
"Convert RDoc on stdin to HTML") do
@pipe = true
end
opt.separator nil
opt.on("--tab-width=WIDTH", "-w", Integer,
"Set the width of tab characters.") do |value|
raise OptionParser::InvalidArgument,
"#{value} is an invalid tab width" if value <= 0
@tab_width = value
end
opt.separator nil
opt.on("--visibility=VISIBILITY", "-V", RDoc::VISIBILITIES + [:nodoc],
"Minimum visibility to document a method.",
"One of 'public', 'protected' (the default),",
"'private' or 'nodoc' (show everything)") do |value|
@visibility = value
end
opt.separator nil
markup_formats = RDoc::Text::MARKUP_FORMAT.keys.sort
opt.on("--markup=MARKUP", markup_formats,
"The markup format for the named files.",
"The default is rdoc. Valid values are:",
markup_formats.join(', ')) do |value|
@markup = value
end
opt.separator nil
opt.on("--root=ROOT", Directory,
"Root of the source tree documentation",
"will be generated for. Set this when",
"building documentation outside the",
"source directory. Default is the",
"current directory.") do |root|
@root = Pathname(root)
end
opt.separator nil
opt.on("--page-dir=DIR", Directory,
"Directory where guides, your FAQ or",
"other pages not associated with a class",
"live. Set this when you don't store",
"such files at your project root.",
"NOTE: Do not use the same file name in",
"the page dir and the root of your project") do |page_dir|
@page_dir = page_dir
end
opt.separator nil
opt.separator "Common generator options:"
opt.separator nil
opt.on("--force-output", "-O",
"Forces rdoc to write the output files,",
"even if the output directory exists",
"and does not seem to have been created",
"by rdoc.") do |value|
@force_output = value
end
opt.separator nil
generator_text = @generators.keys.map { |name| " #{name}" }.sort
opt.on("-f", "--fmt=FORMAT", "--format=FORMAT", @generators.keys,
"Set the output formatter. One of:", *generator_text) do |value|
check_generator
@generator_name = value.downcase
setup_generator
end
opt.separator nil
opt.on("--include=DIRECTORIES", "-i", PathArray,
"Set (or add to) the list of directories to",
"be searched when satisfying :include:",
"requests. Can be used more than once.") do |value|
@rdoc_include.concat value.map { |dir| dir.strip }
end
opt.separator nil
opt.on("--[no-]coverage-report=[LEVEL]", "--[no-]dcov", "-C", Integer,
"Prints a report on undocumented items.",
"Does not generate files.") do |value|
value = 0 if value.nil? # Integer converts -C to nil
@coverage_report = value
@force_update = true if value
end
opt.separator nil
opt.on("--output=DIR", "--op", "-o",
"Set the output directory.") do |value|
@op_dir = value
end
opt.separator nil
opt.on("-d",
"Deprecated --diagram option.",
"Prevents firing debug mode",
"with legacy invocation.") do |value|
end
opt.separator nil
opt.separator 'HTML generator options:'
opt.separator nil
opt.on("--charset=CHARSET", "-c",
"Specifies the output HTML character-set.",
"Use --encoding instead of --charset if",
"available.") do |value|
@charset = value
end
opt.separator nil
opt.on("--hyperlink-all", "-A",
"Generate hyperlinks for all words that",
"correspond to known methods, even if they",
"do not start with '#' or '::' (legacy",
"behavior).") do |value|
@hyperlink_all = value
end
opt.separator nil
opt.on("--main=NAME", "-m",
"NAME will be the initial page displayed.") do |value|
@main_page = value
end
opt.separator nil
opt.on("--[no-]line-numbers", "-N",
"Include line numbers in the source code.",
"By default, only the number of the first",
"line is displayed, in a leading comment.") do |value|
@line_numbers = value
end
opt.separator nil
opt.on("--show-hash", "-H",
"A name of the form #name in a comment is a",
"possible hyperlink to an instance method",
"name. When displayed, the '#' is removed",
"unless this option is specified.") do |value|
@show_hash = value
end
opt.separator nil
opt.on("--template=NAME", "-T", Template,
"Set the template used when generating",
"output. The default depends on the",
"formatter used.") do |(template, template_dir)|
@template = template
@template_dir = template_dir
end
opt.separator nil
opt.on("--template-stylesheets=FILES", PathArray,
"Set (or add to) the list of files to",
"include with the html template.") do |value|
@template_stylesheets.concat value
end
opt.separator nil
opt.on("--title=TITLE", "-t",
"Set TITLE as the title for HTML output.") do |value|
@title = value
end
opt.separator nil
opt.on("--copy-files=PATH", Path,
"Specify a file or directory to copy static",
"files from.",
"If a file is given it will be copied into",
"the output dir. If a directory is given the",
"entire directory will be copied.",
"You can use this multiple times") do |value|
@static_path << value
end
opt.separator nil
opt.on("--webcvs=URL", "-W",
"Specify a URL for linking to a web frontend",
"to CVS. If the URL contains a '\%s', the",
"name of the current file will be",
"substituted; if the URL doesn't contain a",
"'\%s', the filename will be appended to it.") do |value|
@webcvs = value
end
opt.separator nil
opt.separator "ri generator options:"
opt.separator nil
opt.on("--ri", "-r",
"Generate output for use by `ri`. The files",
"are stored in the '.rdoc' directory under",
"your home directory unless overridden by a",
"subsequent --op parameter, so no special",
"privileges are needed.") do |value|
check_generator
@generator_name = "ri"
@op_dir ||= RDoc::RI::Paths::HOMEDIR
setup_generator
end
opt.separator nil
opt.on("--ri-site", "-R",
"Generate output for use by `ri`. The files",
"are stored in a site-wide directory,",
"making them accessible to others, so",
"special privileges are needed.") do |value|
check_generator
@generator_name = "ri"
@op_dir = RDoc::RI::Paths.site_dir
setup_generator
end
opt.separator nil
opt.separator "Generic options:"
opt.separator nil
opt.on("--write-options",
"Write .rdoc_options to the current",
"directory with the given options. Not all",
"options will be used. See RDoc::Options",
"for details.") do |value|
@write_options = true
end
opt.separator nil
opt.on("--[no-]dry-run",
"Don't write any files") do |value|
@dry_run = value
end
opt.separator nil
opt.on("-D", "--[no-]debug",
"Displays lots on internal stuff.") do |value|
$DEBUG_RDOC = value
end
opt.separator nil
opt.on("--[no-]ignore-invalid",
"Ignore invalid options and continue",
"(default true).") do |value|
ignore_invalid = value
end
opt.separator nil
opt.on("--quiet", "-q",
"Don't show progress as we parse.") do |value|
@verbosity = 0
end
opt.separator nil
opt.on("--verbose", "-V",
"Display extra progress as RDoc parses") do |value|
@verbosity = 2
end
opt.separator nil
opt.on("--version", "-v", "print the version") do
puts opt.version
exit
end
opt.separator nil
opt.on("--help", "-h", "Display this help") do
RDoc::RDoc::GENERATORS.each_key do |generator|
setup_generator generator
end
puts opt.help
exit
end
opt.separator nil
end
setup_generator 'darkfish' if
argv.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?
deprecated = []
invalid = []
begin
opts.parse! argv
rescue OptionParser::ParseError => e
if DEPRECATED[e.args.first] then
deprecated << e.args.first
elsif %w[--format --ri -r --ri-site -R].include? e.args.first then
raise
else
invalid << e.args.join(' ')
end
retry
end
unless @generator then
@generator = RDoc::Generator::Darkfish
@generator_name = 'darkfish'
end
if @pipe and not argv.empty? then
@pipe = false
invalid << '-p (with files)'
end
unless quiet then
deprecated.each do |opt|
$stderr.puts 'option ' + opt + ' is deprecated: ' + DEPRECATED[opt]
end
end
unless invalid.empty? then
invalid = "invalid options: #{invalid.join ', '}"
if ignore_invalid then
unless quiet then
$stderr.puts invalid
$stderr.puts '(invalid options are ignored)'
end
else
unless quiet then
$stderr.puts opts
end
$stderr.puts invalid
exit 1
end
end
@files = argv.dup
self
end
##
# Don't display progress as we process the files
def quiet
@verbosity.zero?
end
##
# Set quietness to +bool+
def quiet= bool
@verbosity = bool ? 0 : 1
end
##
# Removes directories from +path+ that are outside the current directory
def sanitize_path path
require 'pathname'
dot = Pathname.new('.').expand_path
path.reject do |item|
path = Pathname.new(item).expand_path
is_reject = nil
relative = nil
begin
relative = path.relative_path_from(dot).to_s
rescue ArgumentError
# On Windows, sometimes crosses different drive letters.
is_reject = true
else
is_reject = relative.start_with? '..'
end
is_reject
end
end
##
# Set up an output generator for the named +generator_name+.
#
# If the found generator responds to :setup_options it will be called with
# the options instance. This allows generators to add custom options or set
# default options.
def setup_generator generator_name = @generator_name
@generator = @generators[generator_name]
unless @generator then
raise OptionParser::InvalidArgument,
"Invalid output formatter #{generator_name}"
end
return if @generator_options.include? @generator
@generator_name = generator_name
@generator_options << @generator
if @generator.respond_to? :setup_options then
@option_parser ||= OptionParser.new
@generator.setup_options self
end
end
##
# Finds the template dir for +template+
def template_dir_for template
template_path = File.join 'rdoc', 'generator', 'template', template
$LOAD_PATH.map do |path|
File.join File.expand_path(path), template_path
end.find do |dir|
File.directory? dir
end
end
# Sets the minimum visibility of a documented method.
#
# Accepts +:public+, +:protected+, +:private+, +:nodoc+, or +:all+.
#
# When +:all+ is passed, visibility is set to +:private+, similarly to
# RDOCOPT="--all", see #visibility for more information.
def visibility= visibility
case visibility
when :all
@visibility = :private
else
@visibility = visibility
end
end
##
# Displays a warning using Kernel#warn if we're being verbose
def warn message
super message if @verbosity > 1
end
##
# Writes the YAML file .rdoc_options to the current directory containing the
# parsed options.
def write_options
RDoc.load_yaml
File.open '.rdoc_options', 'w' do |io|
io.set_encoding Encoding::UTF_8
io.print to_yaml
end
end
##
# Loads options from .rdoc_options if the file exists, otherwise creates a
# new RDoc::Options instance.
def self.load_options
options_file = File.expand_path '.rdoc_options'
return RDoc::Options.new unless File.exist? options_file
RDoc.load_yaml
begin
options = YAML.safe_load File.read('.rdoc_options'), permitted_classes: [RDoc::Options, Symbol]
rescue Psych::SyntaxError
raise RDoc::Error, "#{options_file} is not a valid rdoc options file"
end
return RDoc::Options.new unless options # Allow empty file.
raise RDoc::Error, "#{options_file} is not a valid rdoc options file" unless
RDoc::Options === options or Hash === options
if Hash === options
# Override the default values with the contents of YAML file.
options = RDoc::Options.new options
end
options
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/known_classes.rb 0000644 00000005276 15173517751 0016213 0 ustar 00 # frozen_string_literal: true
module RDoc
##
# Ruby's built-in classes, modules and exceptions
KNOWN_CLASSES = {
"rb_cArray" => "Array",
"rb_cBasicObject" => "BasicObject",
"rb_cBignum" => "Bignum",
"rb_cClass" => "Class",
"rb_cData" => "Data",
"rb_cDir" => "Dir",
"rb_cEncoding" => "Encoding",
"rb_cFalseClass" => "FalseClass",
"rb_cFile" => "File",
"rb_cFixnum" => "Fixnum",
"rb_cFloat" => "Float",
"rb_cHash" => "Hash",
"rb_cIO" => "IO",
"rb_cInteger" => "Integer",
"rb_cModule" => "Module",
"rb_cNilClass" => "NilClass",
"rb_cNumeric" => "Numeric",
"rb_cObject" => "Object",
"rb_cProc" => "Proc",
"rb_cRange" => "Range",
"rb_cRefinement" => "Refinement",
"rb_cRegexp" => "Regexp",
"rb_cRubyVM" => "RubyVM",
"rb_cSocket" => "Socket",
"rb_cString" => "String",
"rb_cStruct" => "Struct",
"rb_cSymbol" => "Symbol",
"rb_cThread" => "Thread",
"rb_cTime" => "Time",
"rb_cTrueClass" => "TrueClass",
"rb_eArgError" => "ArgumentError",
"rb_eEOFError" => "EOFError",
"rb_eException" => "Exception",
"rb_eFatal" => "fatal",
"rb_eFloatDomainError" => "FloatDomainError",
"rb_eIOError" => "IOError",
"rb_eIndexError" => "IndexError",
"rb_eInterrupt" => "Interrupt",
"rb_eLoadError" => "LoadError",
"rb_eNameError" => "NameError",
"rb_eNoMemError" => "NoMemoryError",
"rb_eNotImpError" => "NotImplementedError",
"rb_eRangeError" => "RangeError",
"rb_eRuntimeError" => "RuntimeError",
"rb_eScriptError" => "ScriptError",
"rb_eSecurityError" => "SecurityError",
"rb_eSignal" => "SignalException",
"rb_eStandardError" => "StandardError",
"rb_eSyntaxError" => "SyntaxError",
"rb_eSystemCallError" => "SystemCallError",
"rb_eSystemExit" => "SystemExit",
"rb_eTypeError" => "TypeError",
"rb_eZeroDivError" => "ZeroDivisionError",
"rb_mComparable" => "Comparable",
"rb_mEnumerable" => "Enumerable",
"rb_mErrno" => "Errno",
"rb_mFConst" => "File::Constants",
"rb_mFileTest" => "FileTest",
"rb_mGC" => "GC",
"rb_mKernel" => "Kernel",
"rb_mMath" => "Math",
"rb_mProcess" => "Process"
}
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/tom_doc.rb 0000644 00000014726 15173517751 0014766 0 ustar 00 # frozen_string_literal: true
# :markup: tomdoc
# A parser for TomDoc based on TomDoc 1.0.0-rc1 (02adef9b5a)
#
# The TomDoc specification can be found at:
#
# http://tomdoc.org
#
# The latest version of the TomDoc specification can be found at:
#
# https://github.com/mojombo/tomdoc/blob/master/tomdoc.md
#
# To choose TomDoc as your only default format see RDoc::Options@Saved+Options
# for instructions on setting up a <code>.rdoc_options</code> file to store
# your project default.
#
# There are a few differences between this parser and the specification. A
# best-effort was made to follow the specification as closely as possible but
# some choices to deviate were made.
#
# A future version of RDoc will warn when a MUST or MUST NOT is violated and
# may warn when a SHOULD or SHOULD NOT is violated. RDoc will always try
# to emit documentation even if given invalid TomDoc.
#
# Here are some implementation choices this parser currently makes:
#
# This parser allows rdoc-style inline markup but you should not depended on
# it.
#
# This parser allows a space between the comment and the method body.
#
# This parser does not require the default value to be described for an
# optional argument.
#
# This parser does not examine the order of sections. An Examples section may
# precede the Arguments section.
#
# This class is documented in TomDoc format. Since this is a subclass of the
# RDoc markup parser there isn't much to see here, unfortunately.
class RDoc::TomDoc < RDoc::Markup::Parser
# Internal: Token accessor
attr_reader :tokens
# Internal: Adds a post-processor which sets the RDoc section based on the
# comment's status.
#
# Returns nothing.
def self.add_post_processor # :nodoc:
RDoc::Markup::PreProcess.post_process do |comment, code_object|
next unless code_object and
RDoc::Comment === comment and comment.format == 'tomdoc'
comment.text.gsub!(/(\A\s*# )(Public|Internal|Deprecated):\s+/) do
section = code_object.add_section $2
code_object.temporary_section = section
$1
end
end
end
add_post_processor
# Public: Parses TomDoc from text
#
# text - A String containing TomDoc-format text.
#
# Examples
#
# RDoc::TomDoc.parse <<-TOMDOC
# This method does some things
#
# Returns nothing.
# TOMDOC
# # => #<RDoc::Markup::Document:0xXXX @parts=[...], @file=nil>
#
# Returns an RDoc::Markup::Document representing the TomDoc format.
def self.parse text
parser = new
parser.tokenize text
doc = RDoc::Markup::Document.new
parser.parse doc
doc
end
# Internal: Extracts the Signature section's method signature
#
# comment - An RDoc::Comment that will be parsed and have the signature
# extracted
#
# Returns a String containing the signature and nil if not
def self.signature comment
return unless comment.tomdoc?
document = comment.parse
signature = nil
found_heading = false
found_signature = false
document.parts.delete_if do |part|
next false if found_signature
found_heading ||=
RDoc::Markup::Heading === part && part.text == 'Signature'
next false unless found_heading
next true if RDoc::Markup::BlankLine === part
if RDoc::Markup::Verbatim === part then
signature = part
found_signature = true
end
end
signature and signature.text
end
# Public: Creates a new TomDoc parser. See also RDoc::Markup::parse
def initialize
super
@section = nil
@seen_returns = false
end
# Internal: Builds a heading from the token stream
#
# level - The level of heading to create
#
# Returns an RDoc::Markup::Heading
def build_heading level
heading = super
@section = heading.text
heading
end
# Internal: Builds a verbatim from the token stream. A verbatim in the
# Examples section will be marked as in Ruby format.
#
# margin - The indentation from the margin for lines that belong to this
# verbatim section.
#
# Returns an RDoc::Markup::Verbatim
def build_verbatim margin
verbatim = super
verbatim.format = :ruby if @section == 'Examples'
verbatim
end
# Internal: Builds a paragraph from the token stream
#
# margin - Unused
#
# Returns an RDoc::Markup::Paragraph.
def build_paragraph margin
p :paragraph_start => margin if @debug
paragraph = RDoc::Markup::Paragraph.new
until @tokens.empty? do
type, data, = get
case type
when :TEXT then
@section = 'Returns' if data =~ /\A(Returns|Raises)/
paragraph << data
when :NEWLINE then
if :TEXT == peek_token[0] then
# Lines beginning with 'Raises' in the Returns section should not be
# treated as multiline text
if 'Returns' == @section and
peek_token[1].start_with?('Raises') then
break
else
paragraph << ' '
end
else
break
end
else
unget
break
end
end
p :paragraph_end => margin if @debug
paragraph
end
##
# Detects a section change to "Returns" and adds a heading
def parse_text parent, indent # :nodoc:
paragraph = build_paragraph indent
if false == @seen_returns and 'Returns' == @section then
@seen_returns = true
parent << RDoc::Markup::Heading.new(3, 'Returns')
parent << RDoc::Markup::BlankLine.new
end
parent << paragraph
end
# Internal: Turns text into an Array of tokens
#
# text - A String containing TomDoc-format text.
#
# Returns self.
def tokenize text
text = text.sub(/\A(Public|Internal|Deprecated):\s+/, '')
setup_scanner text
until @s.eos? do
pos = @s.pos
# leading spaces will be reflected by the column of the next token
# the only thing we loose are trailing spaces at the end of the file
next if @s.scan(/ +/)
@tokens << case
when @s.scan(/\r?\n/) then
token = [:NEWLINE, @s.matched, *pos]
@s.newline!
token
when @s.scan(/(Examples|Signature)$/) then
@tokens << [:HEADER, 3, *pos]
[:TEXT, @s[1], *pos]
when @s.scan(/([:\w][\w\[\]]*)[ ]+- /) then
[:NOTE, @s[1], *pos]
else
@s.scan(/.*/)
[:TEXT, @s.matched.sub(/\r$/, ''), *pos]
end
end
self
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/extend.rb 0000644 00000000251 15173517751 0014615 0 ustar 00 # frozen_string_literal: true
##
# A Module extension to a class with \#extend
#
# RDoc::Extend.new 'Enumerable', 'comment ...'
class RDoc::Extend < RDoc::Mixin
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/normal_module.rb 0000644 00000002671 15173517751 0016173 0 ustar 00 # frozen_string_literal: true
##
# A normal module, like NormalClass
class RDoc::NormalModule < RDoc::ClassModule
def aref_prefix # :nodoc:
'module'
end
def inspect # :nodoc:
"#<%s:0x%x module %s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [
self.class, object_id,
full_name, @includes, @extends, @attributes, @method_list, @aliases
]
end
##
# The definition of this module, <tt>module MyModuleName</tt>
def definition
"module #{full_name}"
end
##
# This is a module, returns true
def module?
true
end
def pretty_print q # :nodoc:
q.group 2, "[module #{full_name}:", "]" do
q.breakable
q.text "includes:"
q.breakable
q.seplist @includes do |inc| q.pp inc end
q.breakable
q.breakable
q.text "constants:"
q.breakable
q.seplist @constants do |const| q.pp const end
q.text "attributes:"
q.breakable
q.seplist @attributes do |attr| q.pp attr end
q.breakable
q.text "methods:"
q.breakable
q.seplist @method_list do |meth| q.pp meth end
q.breakable
q.text "aliases:"
q.breakable
q.seplist @aliases do |aliaz| q.pp aliaz end
q.breakable
q.text "comment:"
q.breakable
q.pp comment
end
end
##
# Modules don't have one, raises NoMethodError
def superclass
raise NoMethodError, "#{full_name} is a module"
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/mixin.rb 0000644 00000005401 15173517751 0014454 0 ustar 00 # frozen_string_literal: true
##
# A Mixin adds features from a module into another context. RDoc::Include and
# RDoc::Extend are both mixins.
class RDoc::Mixin < RDoc::CodeObject
##
# Name of included module
attr_accessor :name
##
# Creates a new Mixin for +name+ with +comment+
def initialize(name, comment)
super()
@name = name
self.comment = comment
@module = nil # cache for module if found
end
##
# Mixins are sorted by name
def <=> other
return unless self.class === other
name <=> other.name
end
def == other # :nodoc:
self.class === other and @name == other.name
end
alias eql? == # :nodoc:
##
# Full name based on #module
def full_name
m = self.module
RDoc::ClassModule === m ? m.full_name : @name
end
def hash # :nodoc:
[@name, self.module].hash
end
def inspect # :nodoc:
"#<%s:0x%x %s.%s %s>" % [
self.class,
object_id,
parent_name, self.class.name.downcase, @name,
]
end
##
# Attempts to locate the included module object. Returns the name if not
# known.
#
# The scoping rules of Ruby to resolve the name of an included module are:
# - first look into the children of the current context;
# - if not found, look into the children of included modules,
# in reverse inclusion order;
# - if still not found, go up the hierarchy of names.
#
# This method has <code>O(n!)</code> behavior when the module calling
# include is referencing nonexistent modules. Avoid calling #module until
# after all the files are parsed. This behavior is due to ruby's constant
# lookup behavior.
#
# As of the beginning of October, 2011, no gem includes nonexistent modules.
def module
return @module if @module
# search the current context
return @name unless parent
full_name = parent.child_name(@name)
@module = @store.modules_hash[full_name]
return @module if @module
return @name if @name =~ /^::/
# search the includes before this one, in reverse order
searched = parent.includes.take_while { |i| i != self }.reverse
searched.each do |i|
inc = i.module
next if String === inc
full_name = inc.child_name(@name)
@module = @store.modules_hash[full_name]
return @module if @module
end
# go up the hierarchy of names
up = parent.parent
while up
full_name = up.child_name(@name)
@module = @store.modules_hash[full_name]
return @module if @module
up = up.parent
end
@name
end
##
# Sets the store for this class or module and its contained code objects.
def store= store
super
@file = @store.add_file @file.full_name if @file
end
def to_s # :nodoc:
"#{self.class.name.downcase} #@name in: #{parent}"
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/anon_class.rb 0000644 00000000253 15173517751 0015450 0 ustar 00 # frozen_string_literal: true
##
# An anonymous class like:
#
# c = Class.new do end
#
# AnonClass is currently not used.
class RDoc::AnonClass < RDoc::ClassModule
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markup.rb 0000644 00000017616 15173517751 0014642 0 ustar 00 # frozen_string_literal: true
##
# RDoc::Markup parses plain text documents and attempts to decompose them into
# their constituent parts. Some of these parts are high-level: paragraphs,
# chunks of verbatim text, list entries and the like. Other parts happen at
# the character level: a piece of bold text, a word in code font. This markup
# is similar in spirit to that used on WikiWiki webs, where folks create web
# pages using a simple set of formatting rules.
#
# RDoc::Markup and other markup formats do no output formatting, this is
# handled by the RDoc::Markup::Formatter subclasses.
#
# = Supported Formats
#
# Besides the RDoc::Markup format, the following formats are built in to RDoc:
#
# markdown::
# The markdown format as described by
# http://daringfireball.net/projects/markdown/. See RDoc::Markdown for
# details on the parser and supported extensions.
# rd::
# The rdtool format. See RDoc::RD for details on the parser and format.
# tomdoc::
# The TomDoc format as described by http://tomdoc.org/. See RDoc::TomDoc
# for details on the parser and supported extensions.
#
# You can choose a markup format using the following methods:
#
# per project::
# If you build your documentation with rake use RDoc::Task#markup.
#
# If you build your documentation by hand run:
#
# rdoc --markup your_favorite_format --write-options
#
# and commit <tt>.rdoc_options</tt> and ship it with your packaged gem.
# per file::
# At the top of the file use the <tt>:markup:</tt> directive to set the
# default format for the rest of the file.
# per comment::
# Use the <tt>:markup:</tt> directive at the top of a comment you want
# to write in a different format.
#
# = RDoc::Markup
#
# RDoc::Markup is extensible at runtime: you can add \new markup elements to
# be recognized in the documents that RDoc::Markup parses.
#
# RDoc::Markup is intended to be the basis for a family of tools which share
# the common requirement that simple, plain-text should be rendered in a
# variety of different output formats and media. It is envisaged that
# RDoc::Markup could be the basis for formatting RDoc style comment blocks,
# Wiki entries, and online FAQs.
#
# == Synopsis
#
# This code converts +input_string+ to HTML. The conversion takes place in
# the +convert+ method, so you can use the same RDoc::Markup converter to
# convert multiple input strings.
#
# require 'rdoc'
#
# h = RDoc::Markup::ToHtml.new(RDoc::Options.new)
#
# puts h.convert(input_string)
#
# You can extend the RDoc::Markup parser to recognize new markup
# sequences, and to add regexp handling. Here we make WikiWords significant to
# the parser, and also make the sequences {word} and \<no>text...</no> signify
# strike-through text. We then subclass the HTML output class to deal
# with these:
#
# require 'rdoc'
#
# class WikiHtml < RDoc::Markup::ToHtml
# def handle_regexp_WIKIWORD(target)
# "<font color=red>" + target.text + "</font>"
# end
# end
#
# markup = RDoc::Markup.new
# markup.add_word_pair("{", "}", :STRIKE)
# markup.add_html("no", :STRIKE)
#
# markup.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
#
# wh = WikiHtml.new RDoc::Options.new, markup
# wh.add_tag(:STRIKE, "<strike>", "</strike>")
#
# puts "<body>#{wh.convert ARGF.read}</body>"
#
# == Encoding
#
# Where Encoding support is available, RDoc will automatically convert all
# documents to the same output encoding. The output encoding can be set via
# RDoc::Options#encoding and defaults to Encoding.default_external.
#
# = \RDoc Markup Reference
#
# See RDoc::MarkupReference.
#
#--
# Original Author:: Dave Thomas, dave@pragmaticprogrammer.com
# License:: Ruby license
class RDoc::Markup
##
# An AttributeManager which handles inline markup.
attr_reader :attribute_manager
##
# Parses +str+ into an RDoc::Markup::Document.
def self.parse str
RDoc::Markup::Parser.parse str
rescue RDoc::Markup::Parser::Error => e
$stderr.puts <<-EOF
While parsing markup, RDoc encountered a #{e.class}:
#{e}
\tfrom #{e.backtrace.join "\n\tfrom "}
---8<---
#{text}
---8<---
RDoc #{RDoc::VERSION}
Ruby #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL} #{RUBY_RELEASE_DATE}
Please file a bug report with the above information at:
https://github.com/ruby/rdoc/issues
EOF
raise
end
##
# Take a block of text and use various heuristics to determine its
# structure (paragraphs, lists, and so on). Invoke an event handler as we
# identify significant chunks.
def initialize attribute_manager = nil
@attribute_manager = attribute_manager || RDoc::Markup::AttributeManager.new
@output = nil
end
##
# Add to the sequences used to add formatting to an individual word (such
# as *bold*). Matching entries will generate attributes that the output
# formatters can recognize by their +name+.
def add_word_pair(start, stop, name)
@attribute_manager.add_word_pair(start, stop, name)
end
##
# Add to the sequences recognized as general markup.
def add_html(tag, name)
@attribute_manager.add_html(tag, name)
end
##
# Add to other inline sequences. For example, we could add WikiWords using
# something like:
#
# parser.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
#
# Each wiki word will be presented to the output formatter.
def add_regexp_handling(pattern, name)
@attribute_manager.add_regexp_handling(pattern, name)
end
##
# We take +input+, parse it if necessary, then invoke the output +formatter+
# using a Visitor to render the result.
def convert input, formatter
document = case input
when RDoc::Markup::Document then
input
else
RDoc::Markup::Parser.parse input
end
document.accept formatter
end
autoload :Parser, "#{__dir__}/markup/parser"
autoload :PreProcess, "#{__dir__}/markup/pre_process"
# Inline markup classes
autoload :AttrChanger, "#{__dir__}/markup/attr_changer"
autoload :AttrSpan, "#{__dir__}/markup/attr_span"
autoload :Attributes, "#{__dir__}/markup/attributes"
autoload :AttributeManager, "#{__dir__}/markup/attribute_manager"
autoload :RegexpHandling, "#{__dir__}/markup/regexp_handling"
# RDoc::Markup AST
autoload :BlankLine, "#{__dir__}/markup/blank_line"
autoload :BlockQuote, "#{__dir__}/markup/block_quote"
autoload :Document, "#{__dir__}/markup/document"
autoload :HardBreak, "#{__dir__}/markup/hard_break"
autoload :Heading, "#{__dir__}/markup/heading"
autoload :Include, "#{__dir__}/markup/include"
autoload :IndentedParagraph, "#{__dir__}/markup/indented_paragraph"
autoload :List, "#{__dir__}/markup/list"
autoload :ListItem, "#{__dir__}/markup/list_item"
autoload :Paragraph, "#{__dir__}/markup/paragraph"
autoload :Table, "#{__dir__}/markup/table"
autoload :Raw, "#{__dir__}/markup/raw"
autoload :Rule, "#{__dir__}/markup/rule"
autoload :Verbatim, "#{__dir__}/markup/verbatim"
# Formatters
autoload :Formatter, "#{__dir__}/markup/formatter"
autoload :ToAnsi, "#{__dir__}/markup/to_ansi"
autoload :ToBs, "#{__dir__}/markup/to_bs"
autoload :ToHtml, "#{__dir__}/markup/to_html"
autoload :ToHtmlCrossref, "#{__dir__}/markup/to_html_crossref"
autoload :ToHtmlSnippet, "#{__dir__}/markup/to_html_snippet"
autoload :ToLabel, "#{__dir__}/markup/to_label"
autoload :ToMarkdown, "#{__dir__}/markup/to_markdown"
autoload :ToRdoc, "#{__dir__}/markup/to_rdoc"
autoload :ToTableOfContents, "#{__dir__}/markup/to_table_of_contents"
autoload :ToTest, "#{__dir__}/markup/to_test"
autoload :ToTtOnly, "#{__dir__}/markup/to_tt_only"
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/rdoc.rb 0000644 00000033246 15173517751 0014267 0 ustar 00 # frozen_string_literal: true
require_relative '../rdoc'
require 'find'
require 'fileutils'
require 'pathname'
require 'time'
##
# This is the driver for generating RDoc output. It handles file parsing and
# generation of output.
#
# To use this class to generate RDoc output via the API, the recommended way
# is:
#
# rdoc = RDoc::RDoc.new
# options = RDoc::Options.load_options # returns an RDoc::Options instance
# # set extra options
# rdoc.document options
#
# You can also generate output like the +rdoc+ executable:
#
# rdoc = RDoc::RDoc.new
# rdoc.document argv
#
# Where +argv+ is an array of strings, each corresponding to an argument you'd
# give rdoc on the command line. See <tt>rdoc --help</tt> for details.
class RDoc::RDoc
@current = nil
##
# This is the list of supported output generators
GENERATORS = {}
##
# List of directory names always skipped
UNCONDITIONALLY_SKIPPED_DIRECTORIES = %w[CVS .svn .git].freeze
##
# List of directory names skipped if test suites should be skipped
TEST_SUITE_DIRECTORY_NAMES = %w[spec test].freeze
##
# Generator instance used for creating output
attr_accessor :generator
##
# Hash of files and their last modified times.
attr_reader :last_modified
##
# RDoc options
attr_accessor :options
##
# Accessor for statistics. Available after each call to parse_files
attr_reader :stats
##
# The current documentation store
attr_reader :store
##
# Add +klass+ that can generate output after parsing
def self.add_generator(klass)
name = klass.name.sub(/^RDoc::Generator::/, '').downcase
GENERATORS[name] = klass
end
##
# Active RDoc::RDoc instance
def self.current
@current
end
##
# Sets the active RDoc::RDoc instance
def self.current= rdoc
@current = rdoc
end
##
# Creates a new RDoc::RDoc instance. Call #document to parse files and
# generate documentation.
def initialize
@current = nil
@generator = nil
@last_modified = {}
@old_siginfo = nil
@options = nil
@stats = nil
@store = nil
end
##
# Report an error message and exit
def error(msg)
raise RDoc::Error, msg
end
##
# Gathers a set of parseable files from the files and directories listed in
# +files+.
def gather_files files
files = [@options.root.to_s] if files.empty?
file_list = normalized_file_list files, true, @options.exclude
file_list = remove_unparseable(file_list)
if file_list.count {|name, mtime|
file_list[name] = @last_modified[name] unless mtime
mtime
} > 0
@last_modified.replace file_list
file_list.keys.sort
else
[]
end
end
##
# Turns RDoc from stdin into HTML
def handle_pipe
@html = RDoc::Markup::ToHtml.new @options
parser = RDoc::Text::MARKUP_FORMAT[@options.markup]
document = parser.parse $stdin.read
out = @html.convert document
$stdout.write out
end
##
# Installs a siginfo handler that prints the current filename.
def install_siginfo_handler
return unless Signal.list.include? 'INFO'
@old_siginfo = trap 'INFO' do
puts @current if @current
end
end
##
# Create an output dir if it doesn't exist. If it does exist, but doesn't
# contain the flag file <tt>created.rid</tt> then we refuse to use it, as
# we may clobber some manually generated documentation
def setup_output_dir(dir, force)
flag_file = output_flag_file dir
last = {}
if @options.dry_run then
# do nothing
elsif File.exist? dir then
error "#{dir} exists and is not a directory" unless File.directory? dir
begin
File.open flag_file do |io|
unless force then
Time.parse io.gets
io.each do |line|
file, time = line.split "\t", 2
time = Time.parse(time) rescue next
last[file] = time
end
end
end
rescue SystemCallError, TypeError
error <<-ERROR
Directory #{dir} already exists, but it looks like it isn't an RDoc directory.
Because RDoc doesn't want to risk destroying any of your existing files,
you'll need to specify a different output directory name (using the --op <dir>
option)
ERROR
end unless @options.force_output
else
FileUtils.mkdir_p dir
FileUtils.touch flag_file
end
last
end
##
# Sets the current documentation tree to +store+ and sets the store's rdoc
# driver to this instance.
def store= store
@store = store
@store.rdoc = self
end
##
# Update the flag file in an output directory.
def update_output_dir(op_dir, time, last = {})
return if @options.dry_run or not @options.update_output_dir
unless ENV['SOURCE_DATE_EPOCH'].nil?
time = Time.at(ENV['SOURCE_DATE_EPOCH'].to_i).gmtime
end
File.open output_flag_file(op_dir), "w" do |f|
f.puts time.rfc2822
last.each do |n, t|
f.puts "#{n}\t#{t.rfc2822}"
end
end
end
##
# Return the path name of the flag file in an output directory.
def output_flag_file(op_dir)
File.join op_dir, "created.rid"
end
##
# The .document file contains a list of file and directory name patterns,
# representing candidates for documentation. It may also contain comments
# (starting with '#')
def parse_dot_doc_file in_dir, filename
# read and strip comments
patterns = File.read(filename).gsub(/#.*/, '')
result = {}
patterns.split(' ').each do |patt|
candidates = Dir.glob(File.join(in_dir, patt))
result.update normalized_file_list(candidates, false, @options.exclude)
end
result
end
##
# Given a list of files and directories, create a list of all the Ruby
# files they contain.
#
# If +force_doc+ is true we always add the given files, if false, only
# add files that we guarantee we can parse. It is true when looking at
# files given on the command line, false when recursing through
# subdirectories.
#
# The effect of this is that if you want a file with a non-standard
# extension parsed, you must name it explicitly.
def normalized_file_list(relative_files, force_doc = false,
exclude_pattern = nil)
file_list = {}
relative_files.each do |rel_file_name|
rel_file_name = rel_file_name.sub(/^\.\//, '')
next if rel_file_name.end_with? 'created.rid'
next if exclude_pattern && exclude_pattern =~ rel_file_name
stat = File.stat rel_file_name rescue next
case type = stat.ftype
when "file" then
mtime = (stat.mtime unless (last_modified = @last_modified[rel_file_name] and
stat.mtime.to_i <= last_modified.to_i))
if force_doc or RDoc::Parser.can_parse(rel_file_name) then
file_list[rel_file_name] = mtime
end
when "directory" then
next if UNCONDITIONALLY_SKIPPED_DIRECTORIES.include?(rel_file_name)
basename = File.basename(rel_file_name)
next if options.skip_tests && TEST_SUITE_DIRECTORY_NAMES.include?(basename)
created_rid = File.join rel_file_name, "created.rid"
next if File.file? created_rid
dot_doc = File.join rel_file_name, RDoc::DOT_DOC_FILENAME
if File.file? dot_doc then
file_list.update(parse_dot_doc_file(rel_file_name, dot_doc))
else
file_list.update(list_files_in_directory(rel_file_name))
end
else
warn "rdoc can't parse the #{type} #{rel_file_name}"
end
end
file_list
end
##
# Return a list of the files to be processed in a directory. We know that
# this directory doesn't have a .document file, so we're looking for real
# files. However we may well contain subdirectories which must be tested
# for .document files.
def list_files_in_directory dir
files = Dir.glob File.join(dir, "*")
normalized_file_list files, false, @options.exclude
end
##
# Parses +filename+ and returns an RDoc::TopLevel
def parse_file filename
encoding = @options.encoding
filename = filename.encode encoding
@stats.add_file filename
return if RDoc::Parser.binary? filename
content = RDoc::Encoding.read_file filename, encoding
return unless content
filename_path = Pathname(filename).expand_path
begin
relative_path = filename_path.relative_path_from @options.root
rescue ArgumentError
relative_path = filename_path
end
if @options.page_dir and
relative_path.to_s.start_with? @options.page_dir.to_s then
relative_path =
relative_path.relative_path_from @options.page_dir
end
top_level = @store.add_file filename, relative_name: relative_path.to_s
parser = RDoc::Parser.for top_level, filename, content, @options, @stats
return unless parser
parser.scan
# restart documentation for the classes & modules found
top_level.classes_or_modules.each do |cm|
cm.done_documenting = false
end
top_level
rescue Errno::EACCES => e
$stderr.puts <<-EOF
Unable to read #{filename}, #{e.message}
Please check the permissions for this file. Perhaps you do not have access to
it or perhaps the original author's permissions are to restrictive. If the
this is not your library please report a bug to the author.
EOF
rescue => e
$stderr.puts <<-EOF
Before reporting this, could you check that the file you're documenting
has proper syntax:
#{Gem.ruby} -c #{filename}
RDoc is not a full Ruby parser and will fail when fed invalid ruby programs.
The internal error was:
\t(#{e.class}) #{e.message}
EOF
$stderr.puts e.backtrace.join("\n\t") if $DEBUG_RDOC
raise e
nil
end
##
# Parse each file on the command line, recursively entering directories.
def parse_files files
file_list = gather_files files
@stats = RDoc::Stats.new @store, file_list.length, @options.verbosity
return [] if file_list.empty?
original_options = @options.dup
@stats.begin_adding
file_info = file_list.map do |filename|
@current = filename
parse_file filename
end.compact
@stats.done_adding
@options = original_options
file_info
end
##
# Removes file extensions known to be unparseable from +files+ and TAGS
# files for emacs and vim.
def remove_unparseable files
files.reject do |file, *|
file =~ /\.(?:class|eps|erb|scpt\.txt|svg|ttf|yml)$/i or
(file =~ /tags$/i and
/\A(\f\n[^,]+,\d+$|!_TAG_)/.match?(File.binread(file, 100)))
end
end
##
# Generates documentation or a coverage report depending upon the settings
# in +options+.
#
# +options+ can be either an RDoc::Options instance or an array of strings
# equivalent to the strings that would be passed on the command line like
# <tt>%w[-q -o doc -t My\ Doc\ Title]</tt>. #document will automatically
# call RDoc::Options#finish if an options instance was given.
#
# For a list of options, see either RDoc::Options or <tt>rdoc --help</tt>.
#
# By default, output will be stored in a directory called "doc" below the
# current directory, so make sure you're somewhere writable before invoking.
def document options
self.store = RDoc::Store.new
if RDoc::Options === options then
@options = options
else
@options = RDoc::Options.load_options
@options.parse options
end
@options.finish
if @options.pipe then
handle_pipe
exit
end
unless @options.coverage_report then
@last_modified = setup_output_dir @options.op_dir, @options.force_update
end
@store.encoding = @options.encoding
@store.dry_run = @options.dry_run
@store.main = @options.main_page
@store.title = @options.title
@store.path = @options.op_dir
@start_time = Time.now
@store.load_cache
file_info = parse_files @options.files
@options.default_title = "RDoc Documentation"
@store.complete @options.visibility
@stats.coverage_level = @options.coverage_report
if @options.coverage_report then
puts
puts @stats.report.accept RDoc::Markup::ToRdoc.new
elsif file_info.empty? then
$stderr.puts "\nNo newer files." unless @options.quiet
else
gen_klass = @options.generator
@generator = gen_klass.new @store, @options
generate
end
if @stats and (@options.coverage_report or not @options.quiet) then
puts
puts @stats.summary.accept RDoc::Markup::ToRdoc.new
end
exit @stats.fully_documented? if @options.coverage_report
end
##
# Generates documentation for +file_info+ (from #parse_files) into the
# output dir using the generator selected
# by the RDoc options
def generate
if @options.dry_run then
# do nothing
@generator.generate
else
Dir.chdir @options.op_dir do
unless @options.quiet then
$stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
end
@generator.generate
update_output_dir '.', @start_time, @last_modified
end
end
end
##
# Removes a siginfo handler and replaces the previous
def remove_siginfo_handler
return unless Signal.list.key? 'INFO'
handler = @old_siginfo || 'DEFAULT'
trap 'INFO', handler
end
end
begin
require 'rubygems'
rdoc_extensions = Gem.find_files 'rdoc/discover'
rdoc_extensions.each do |extension|
begin
load extension
rescue => e
warn "error loading #{extension.inspect}: #{e.message} (#{e.class})"
warn "\t#{e.backtrace.join "\n\t"}" if $DEBUG
end
end
rescue LoadError
end
# require built-in generators after discovery in case they've been replaced
require_relative 'generator/darkfish'
require_relative 'generator/ri'
require_relative 'generator/pot'
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/meta_method.rb 0000644 00000000200 15173517751 0015606 0 ustar 00 # frozen_string_literal: true
##
# MetaMethod represents a meta-programmed method
class RDoc::MetaMethod < RDoc::AnyMethod
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/any_method.rb 0000644 00000021062 15173517751 0015460 0 ustar 00 # frozen_string_literal: true
##
# AnyMethod is the base class for objects representing methods
class RDoc::AnyMethod < RDoc::MethodAttr
##
# 2::
# RDoc 4
# Added calls_super
# Added parent name and class
# Added section title
# 3::
# RDoc 4.1
# Added is_alias_for
MARSHAL_VERSION = 3 # :nodoc:
##
# Don't rename \#initialize to \::new
attr_accessor :dont_rename_initialize
##
# The C function that implements this method (if it was defined in a C file)
attr_accessor :c_function
# The section title of the method (if defined in a C file via +:category:+)
attr_accessor :section_title
# Parameters for this method
attr_accessor :params
##
# If true this method uses +super+ to call a superclass version
attr_accessor :calls_super
include RDoc::TokenStream
##
# Creates a new AnyMethod with a token stream +text+ and +name+
def initialize text, name
super
@c_function = nil
@dont_rename_initialize = false
@token_stream = nil
@calls_super = false
@superclass_method = nil
end
##
# Adds +an_alias+ as an alias for this method in +context+.
def add_alias an_alias, context = nil
method = self.class.new an_alias.text, an_alias.new_name
method.record_location an_alias.file
method.singleton = self.singleton
method.params = self.params
method.visibility = self.visibility
method.comment = an_alias.comment
method.is_alias_for = self
@aliases << method
context.add_method method if context
method
end
##
# Prefix for +aref+ is 'method'.
def aref_prefix
'method'
end
##
# The call_seq or the param_seq with method name, if there is no call_seq.
#
# Use this for displaying a method's argument lists.
def arglists
if @call_seq then
@call_seq
elsif @params then
"#{name}#{param_seq}"
end
end
##
# Different ways to call this method
def call_seq
unless call_seq = _call_seq
call_seq = is_alias_for._call_seq if is_alias_for
end
return unless call_seq
deduplicate_call_seq(call_seq)
end
##
# Sets the different ways you can call this method. If an empty +call_seq+
# is given nil is assumed.
#
# See also #param_seq
def call_seq= call_seq
return if call_seq.empty?
@call_seq = call_seq
end
##
# Whether the method has a call-seq.
def has_call_seq?
!!(@call_seq || is_alias_for&._call_seq)
end
##
# Loads is_alias_for from the internal name. Returns nil if the alias
# cannot be found.
def is_alias_for # :nodoc:
case @is_alias_for
when RDoc::MethodAttr then
@is_alias_for
when Array then
return nil unless @store
klass_name, singleton, method_name = @is_alias_for
return nil unless klass = @store.find_class_or_module(klass_name)
@is_alias_for = klass.find_method method_name, singleton
end
end
##
# Dumps this AnyMethod for use by ri. See also #marshal_load
def marshal_dump
aliases = @aliases.map do |a|
[a.name, parse(a.comment)]
end
is_alias_for = [
@is_alias_for.parent.full_name,
@is_alias_for.singleton,
@is_alias_for.name
] if @is_alias_for
[ MARSHAL_VERSION,
@name,
full_name,
@singleton,
@visibility,
parse(@comment),
@call_seq,
@block_params,
aliases,
@params,
@file.relative_name,
@calls_super,
@parent.name,
@parent.class,
@section.title,
is_alias_for,
]
end
##
# Loads this AnyMethod from +array+. For a loaded AnyMethod the following
# methods will return cached values:
#
# * #full_name
# * #parent_name
def marshal_load array
initialize_visibility
@dont_rename_initialize = nil
@token_stream = nil
@aliases = []
@parent = nil
@parent_name = nil
@parent_class = nil
@section = nil
@file = nil
version = array[0]
@name = array[1]
@full_name = array[2]
@singleton = array[3]
@visibility = array[4]
@comment = array[5]
@call_seq = array[6]
@block_params = array[7]
# 8 handled below
@params = array[9]
# 10 handled below
@calls_super = array[11]
@parent_name = array[12]
@parent_title = array[13]
@section_title = array[14]
@is_alias_for = array[15]
array[8].each do |new_name, comment|
add_alias RDoc::Alias.new(nil, @name, new_name, comment, @singleton)
end
@parent_name ||= if @full_name =~ /#/ then
$`
else
name = @full_name.split('::')
name.pop
name.join '::'
end
@file = RDoc::TopLevel.new array[10] if version > 0
end
##
# Method name
#
# If the method has no assigned name, it extracts it from #call_seq.
def name
return @name if @name
@name =
@call_seq[/^.*?\.(\w+)/, 1] ||
@call_seq[/^.*?(\w+)/, 1] ||
@call_seq if @call_seq
end
##
# A list of this method's method and yield parameters. +call-seq+ params
# are preferred over parsed method and block params.
def param_list
if @call_seq then
params = @call_seq.split("\n").last
params = params.sub(/.*?\((.*)\)/, '\1')
params = params.sub(/(\{|do)\s*\|([^|]*)\|.*/, ',\2')
elsif @params then
params = @params.sub(/\((.*)\)/, '\1')
params << ",#{@block_params}" if @block_params
elsif @block_params then
params = @block_params
else
return []
end
if @block_params then
# If this method has explicit block parameters, remove any explicit
# &block
params = params.sub(/,?\s*&\w+/, '')
else
params = params.sub(/\&(\w+)/, '\1')
end
params = params.gsub(/\s+/, '').split(',').reject(&:empty?)
params.map { |param| param.sub(/=.*/, '') }
end
##
# Pretty parameter list for this method. If the method's parameters were
# given by +call-seq+ it is preferred over the parsed values.
def param_seq
if @call_seq then
params = @call_seq.split("\n").last
params = params.sub(/[^( ]+/, '')
params = params.sub(/(\|[^|]+\|)\s*\.\.\.\s*(end|\})/, '\1 \2')
elsif @params then
params = @params.gsub(/\s*\#.*/, '')
params = params.tr_s("\n ", " ")
params = "(#{params})" unless params[0] == ?(
else
params = ''
end
if @block_params then
# If this method has explicit block parameters, remove any explicit
# &block
params = params.sub(/,?\s*&\w+/, '')
block = @block_params.tr_s("\n ", " ")
if block[0] == ?(
block = block.sub(/^\(/, '').sub(/\)/, '')
end
params << " { |#{block}| ... }"
end
params
end
##
# Whether to skip the method description, true for methods that have
# aliases with a call-seq that doesn't include the method name.
def skip_description?
has_call_seq? && call_seq.nil? && !!(is_alias_for || !aliases.empty?)
end
##
# Sets the store for this method and its referenced code objects.
def store= store
super
@file = @store.add_file @file.full_name if @file
end
##
# For methods that +super+, find the superclass method that would be called.
def superclass_method
return unless @calls_super
return @superclass_method if @superclass_method
parent.each_ancestor do |ancestor|
if method = ancestor.method_list.find { |m| m.name == @name } then
@superclass_method = method
break
end
end
@superclass_method
end
protected
##
# call_seq without deduplication and alias lookup.
def _call_seq
@call_seq if defined?(@call_seq) && @call_seq
end
private
##
# call_seq with alias examples information removed, if this
# method is an alias method.
def deduplicate_call_seq(call_seq)
return call_seq unless is_alias_for || !aliases.empty?
method_name = self.name
method_name = method_name[0, 1] if method_name =~ /\A\[/
entries = call_seq.split "\n"
ignore = aliases.map(&:name)
if is_alias_for
ignore << is_alias_for.name
ignore.concat is_alias_for.aliases.map(&:name)
end
ignore.map! { |n| n =~ /\A\[/ ? /\[.*\]/ : n}
ignore.delete(method_name)
ignore = Regexp.union(ignore)
matching = entries.reject do |entry|
entry =~ /^\w*\.?#{ignore}[$\(\s]/ or
entry =~ /\s#{ignore}\s/
end
matching.empty? ? nil : matching.join("\n")
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/require.rb 0000644 00000001704 15173517751 0015006 0 ustar 00 # frozen_string_literal: true
##
# A file loaded by \#require
class RDoc::Require < RDoc::CodeObject
##
# Name of the required file
attr_accessor :name
##
# Creates a new Require that loads +name+ with +comment+
def initialize(name, comment)
super()
@name = name.gsub(/'|"/, "") #'
@top_level = nil
self.comment = comment
end
def inspect # :nodoc:
"#<%s:0x%x require '%s' in %s>" % [
self.class,
object_id,
@name,
parent_file_name,
]
end
def to_s # :nodoc:
"require #{name} in: #{parent}"
end
##
# The RDoc::TopLevel corresponding to this require, or +nil+ if not found.
def top_level
@top_level ||= begin
tl = RDoc::TopLevel.all_files_hash[name + '.rb']
if tl.nil? and RDoc::TopLevel.all_files.first.full_name =~ %r(^lib/) then
# second chance
tl = RDoc::TopLevel.all_files_hash['lib/' + name + '.rb']
end
tl
end
end
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/ri.rb 0000644 00000000566 15173517751 0013751 0 ustar 00 # frozen_string_literal: true
require_relative '../rdoc'
##
# Namespace for the ri command line tool's implementation.
#
# See <tt>ri --help</tt> for details.
module RDoc::RI
##
# Base RI error class
class Error < RDoc::Error; end
autoload :Driver, "#{__dir__}/ri/driver"
autoload :Paths, "#{__dir__}/ri/paths"
autoload :Store, "#{__dir__}/ri/store"
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markdown/literals.rb 0000644 00000024363 15173517751 0017001 0 ustar 00 # coding: UTF-8
# frozen_string_literal: true
# :markup: markdown
##
# This set of literals is for Ruby 1.9 regular expressions and gives full
# unicode support.
#
# Unlike peg-markdown, this set of literals recognizes Unicode alphanumeric
# characters, newlines and spaces.
class RDoc::Markdown::Literals
# :stopdoc:
# This is distinct from setup_parser so that a standalone parser
# can redefine #initialize and still have access to the proper
# parser setup code.
def initialize(str, debug=false)
setup_parser(str, debug)
end
# Prepares for parsing +str+. If you define a custom initialize you must
# call this method before #parse
def setup_parser(str, debug=false)
set_string str, 0
@memoizations = Hash.new { |h,k| h[k] = {} }
@result = nil
@failed_rule = nil
@failing_rule_offset = -1
@line_offsets = nil
setup_foreign_grammar
end
attr_reader :string
attr_reader :failing_rule_offset
attr_accessor :result, :pos
def current_column(target=pos)
if string[target] == "\n" && (c = string.rindex("\n", target-1) || -1)
return target - c
elsif c = string.rindex("\n", target)
return target - c
end
target + 1
end
def position_line_offsets
unless @position_line_offsets
@position_line_offsets = []
total = 0
string.each_line do |line|
total += line.size
@position_line_offsets << total
end
end
@position_line_offsets
end
if [].respond_to? :bsearch_index
def current_line(target=pos)
if line = position_line_offsets.bsearch_index {|x| x > target }
return line + 1
end
raise "Target position #{target} is outside of string"
end
else
def current_line(target=pos)
if line = position_line_offsets.index {|x| x > target }
return line + 1
end
raise "Target position #{target} is outside of string"
end
end
def current_character(target=pos)
if target < 0 || target >= string.size
raise "Target position #{target} is outside of string"
end
string[target, 1]
end
KpegPosInfo = Struct.new(:pos, :lno, :col, :line, :char)
def current_pos_info(target=pos)
l = current_line target
c = current_column target
ln = get_line(l-1)
chr = string[target,1]
KpegPosInfo.new(target, l, c, ln, chr)
end
def lines
string.lines
end
def get_line(no)
loff = position_line_offsets
if no < 0
raise "Line No is out of range: #{no} < 0"
elsif no >= loff.size
raise "Line No is out of range: #{no} >= #{loff.size}"
end
lend = loff[no]-1
lstart = no > 0 ? loff[no-1] : 0
string[lstart..lend]
end
def get_text(start)
@string[start..@pos-1]
end
# Sets the string and current parsing position for the parser.
def set_string string, pos
@string = string
@string_size = string ? string.size : 0
@pos = pos
@position_line_offsets = nil
end
def show_pos
width = 10
if @pos < width
"#{@pos} (\"#{@string[0,@pos]}\" @ \"#{@string[@pos,width]}\")"
else
"#{@pos} (\"... #{@string[@pos - width, width]}\" @ \"#{@string[@pos,width]}\")"
end
end
def failure_info
l = current_line @failing_rule_offset
c = current_column @failing_rule_offset
if @failed_rule.kind_of? Symbol
info = self.class::Rules[@failed_rule]
"line #{l}, column #{c}: failed rule '#{info.name}' = '#{info.rendered}'"
else
"line #{l}, column #{c}: failed rule '#{@failed_rule}'"
end
end
def failure_caret
p = current_pos_info @failing_rule_offset
"#{p.line.chomp}\n#{' ' * (p.col - 1)}^"
end
def failure_character
current_character @failing_rule_offset
end
def failure_oneline
p = current_pos_info @failing_rule_offset
if @failed_rule.kind_of? Symbol
info = self.class::Rules[@failed_rule]
"@#{p.lno}:#{p.col} failed rule '#{info.name}', got '#{p.char}'"
else
"@#{p.lno}:#{p.col} failed rule '#{@failed_rule}', got '#{p.char}'"
end
end
class ParseError < RuntimeError
end
def raise_error
raise ParseError, failure_oneline
end
def show_error(io=STDOUT)
error_pos = @failing_rule_offset
p = current_pos_info(error_pos)
io.puts "On line #{p.lno}, column #{p.col}:"
if @failed_rule.kind_of? Symbol
info = self.class::Rules[@failed_rule]
io.puts "Failed to match '#{info.rendered}' (rule '#{info.name}')"
else
io.puts "Failed to match rule '#{@failed_rule}'"
end
io.puts "Got: #{p.char.inspect}"
io.puts "=> #{p.line}"
io.print(" " * (p.col + 2))
io.puts "^"
end
def set_failed_rule(name)
if @pos > @failing_rule_offset
@failed_rule = name
@failing_rule_offset = @pos
end
end
attr_reader :failed_rule
def match_string(str)
len = str.size
if @string[pos,len] == str
@pos += len
return str
end
return nil
end
def scan(reg)
if m = reg.match(@string, @pos)
@pos = m.end(0)
return true
end
return nil
end
if "".respond_to? :ord
def get_byte
if @pos >= @string_size
return nil
end
s = @string[@pos].ord
@pos += 1
s
end
else
def get_byte
if @pos >= @string_size
return nil
end
s = @string[@pos]
@pos += 1
s
end
end
def parse(rule=nil)
# We invoke the rules indirectly via apply
# instead of by just calling them as methods because
# if the rules use left recursion, apply needs to
# manage that.
if !rule
apply(:_root)
else
method = rule.gsub("-","_hyphen_")
apply :"_#{method}"
end
end
class MemoEntry
def initialize(ans, pos)
@ans = ans
@pos = pos
@result = nil
@set = false
@left_rec = false
end
attr_reader :ans, :pos, :result, :set
attr_accessor :left_rec
def move!(ans, pos, result)
@ans = ans
@pos = pos
@result = result
@set = true
@left_rec = false
end
end
def external_invoke(other, rule, *args)
old_pos = @pos
old_string = @string
set_string other.string, other.pos
begin
if val = __send__(rule, *args)
other.pos = @pos
other.result = @result
else
other.set_failed_rule "#{self.class}##{rule}"
end
val
ensure
set_string old_string, old_pos
end
end
def apply_with_args(rule, *args)
@result = nil
memo_key = [rule, args]
if m = @memoizations[memo_key][@pos]
@pos = m.pos
if !m.set
m.left_rec = true
return nil
end
@result = m.result
return m.ans
else
m = MemoEntry.new(nil, @pos)
@memoizations[memo_key][@pos] = m
start_pos = @pos
ans = __send__ rule, *args
lr = m.left_rec
m.move! ans, @pos, @result
# Don't bother trying to grow the left recursion
# if it's failing straight away (thus there is no seed)
if ans and lr
return grow_lr(rule, args, start_pos, m)
else
return ans
end
end
end
def apply(rule)
@result = nil
if m = @memoizations[rule][@pos]
@pos = m.pos
if !m.set
m.left_rec = true
return nil
end
@result = m.result
return m.ans
else
m = MemoEntry.new(nil, @pos)
@memoizations[rule][@pos] = m
start_pos = @pos
ans = __send__ rule
lr = m.left_rec
m.move! ans, @pos, @result
# Don't bother trying to grow the left recursion
# if it's failing straight away (thus there is no seed)
if ans and lr
return grow_lr(rule, nil, start_pos, m)
else
return ans
end
end
end
def grow_lr(rule, args, start_pos, m)
while true
@pos = start_pos
@result = m.result
if args
ans = __send__ rule, *args
else
ans = __send__ rule
end
return nil unless ans
break if @pos <= m.pos
m.move! ans, @pos, @result
end
@result = m.result
@pos = m.pos
return m.ans
end
class RuleInfo
def initialize(name, rendered)
@name = name
@rendered = rendered
end
attr_reader :name, :rendered
end
def self.rule_info(name, rendered)
RuleInfo.new(name, rendered)
end
# :startdoc:
# :stopdoc:
def setup_foreign_grammar; end
# Alphanumeric = /\p{Word}/
def _Alphanumeric
_tmp = scan(/\G(?-mix:\p{Word})/)
set_failed_rule :_Alphanumeric unless _tmp
return _tmp
end
# AlphanumericAscii = /[A-Za-z0-9]/
def _AlphanumericAscii
_tmp = scan(/\G(?-mix:[A-Za-z0-9])/)
set_failed_rule :_AlphanumericAscii unless _tmp
return _tmp
end
# BOM = "uFEFF"
def _BOM
_tmp = match_string("uFEFF")
set_failed_rule :_BOM unless _tmp
return _tmp
end
# Newline = /\n|\r\n?|\p{Zl}|\p{Zp}/
def _Newline
_tmp = scan(/\G(?-mix:\n|\r\n?|\p{Zl}|\p{Zp})/)
set_failed_rule :_Newline unless _tmp
return _tmp
end
# NonAlphanumeric = /\p{^Word}/
def _NonAlphanumeric
_tmp = scan(/\G(?-mix:\p{^Word})/)
set_failed_rule :_NonAlphanumeric unless _tmp
return _tmp
end
# Spacechar = /\t|\p{Zs}/
def _Spacechar
_tmp = scan(/\G(?-mix:\t|\p{Zs})/)
set_failed_rule :_Spacechar unless _tmp
return _tmp
end
Rules = {}
Rules[:_Alphanumeric] = rule_info("Alphanumeric", "/\\p{Word}/")
Rules[:_AlphanumericAscii] = rule_info("AlphanumericAscii", "/[A-Za-z0-9]/")
Rules[:_BOM] = rule_info("BOM", "\"uFEFF\"")
Rules[:_Newline] = rule_info("Newline", "/\\n|\\r\\n?|\\p{Zl}|\\p{Zp}/")
Rules[:_NonAlphanumeric] = rule_info("NonAlphanumeric", "/\\p{^Word}/")
Rules[:_Spacechar] = rule_info("Spacechar", "/\\t|\\p{Zs}/")
# :startdoc:
end
share/gems/gems/rdoc-6.6.3.1/lib/rdoc/markdown/entities.rb 0000644 00000154040 15173517751 0017002 0 ustar 00 # frozen_string_literal: true
##
# HTML entity name map for RDoc::Markdown
RDoc::Markdown::HTML_ENTITIES = {
"AElig" => [0x000C6],
"AMP" => [0x00026],
"Aacute" => [0x000C1],
"Abreve" => [0x00102],
"Acirc" => [0x000C2],
"Acy" => [0x00410],
"Afr" => [0x1D504],
"Agrave" => [0x000C0],
"Alpha" => [0x00391],
"Amacr" => [0x00100],
"And" => [0x02A53],
"Aogon" => [0x00104],
"Aopf" => [0x1D538],
"ApplyFunction" => [0x02061],
"Aring" => [0x000C5],
"Ascr" => [0x1D49C],
"Assign" => [0x02254],
"Atilde" => [0x000C3],
"Auml" => [0x000C4],
"Backslash" => [0x02216],
"Barv" => [0x02AE7],
"Barwed" => [0x02306],
"Bcy" => [0x00411],
"Because" => [0x02235],
"Bernoullis" => [0x0212C],
"Beta" => [0x00392],
"Bfr" => [0x1D505],
"Bopf" => [0x1D539],
"Breve" => [0x002D8],
"Bscr" => [0x0212C],
"Bumpeq" => [0x0224E],
"CHcy" => [0x00427],
"COPY" => [0x000A9],
"Cacute" => [0x00106],
"Cap" => [0x022D2],
"CapitalDifferentialD" => [0x02145],
"Cayleys" => [0x0212D],
"Ccaron" => [0x0010C],
"Ccedil" => [0x000C7],
"Ccirc" => [0x00108],
"Cconint" => [0x02230],
"Cdot" => [0x0010A],
"Cedilla" => [0x000B8],
"CenterDot" => [0x000B7],
"Cfr" => [0x0212D],
"Chi" => [0x003A7],
"CircleDot" => [0x02299],
"CircleMinus" => [0x02296],
"CirclePlus" => [0x02295],
"CircleTimes" => [0x02297],
"ClockwiseContourIntegral" => [0x02232],
"CloseCurlyDoubleQuote" => [0x0201D],
"CloseCurlyQuote" => [0x02019],
"Colon" => [0x02237],
"Colone" => [0x02A74],
"Congruent" => [0x02261],
"Conint" => [0x0222F],
"ContourIntegral" => [0x0222E],
"Copf" => [0x02102],
"Coproduct" => [0x02210],
"CounterClockwiseContourIntegral" => [0x02233],
"Cross" => [0x02A2F],
"Cscr" => [0x1D49E],
"Cup" => [0x022D3],
"CupCap" => [0x0224D],
"DD" => [0x02145],
"DDotrahd" => [0x02911],
"DJcy" => [0x00402],
"DScy" => [0x00405],
"DZcy" => [0x0040F],
"Dagger" => [0x02021],
"Darr" => [0x021A1],
"Dashv" => [0x02AE4],
"Dcaron" => [0x0010E],
"Dcy" => [0x00414],
"Del" => [0x02207],
"Delta" => [0x00394],
"Dfr" => [0x1D507],
"DiacriticalAcute" => [0x000B4],
"DiacriticalDot" => [0x002D9],
"DiacriticalDoubleAcute" => [0x002DD],
"DiacriticalGrave" => [0x00060],
"DiacriticalTilde" => [0x002DC],
"Diamond" => [0x022C4],
"DifferentialD" => [0x02146],
"Dopf" => [0x1D53B],
"Dot" => [0x000A8],
"DotDot" => [0x020DC],
"DotEqual" => [0x02250],
"DoubleContourIntegral" => [0x0222F],
"DoubleDot" => [0x000A8],
"DoubleDownArrow" => [0x021D3],
"DoubleLeftArrow" => [0x021D0],
"DoubleLeftRightArrow" => [0x021D4],
"DoubleLeftTee" => [0x02AE4],
"DoubleLongLeftArrow" => [0x027F8],
"DoubleLongLeftRightArrow" => [0x027FA],
"DoubleLongRightArrow" => [0x027F9],
"DoubleRightArrow" => [0x021D2],
"DoubleRightTee" => [0x022A8],
"DoubleUpArrow" => [0x021D1],
"DoubleUpDownArrow" => [0x021D5],
"DoubleVerticalBar" => [0x02225],
"DownArrow" => [0x02193],
"DownArrowBar" => [0x02913],
"DownArrowUpArrow" => [0x021F5],
"DownBreve" => [0x00311],
"DownLeftRightVector" => [0x02950],
"DownLeftTeeVector" => [0x0295E],
"DownLeftVector" => [0x021BD],
"DownLeftVectorBar" => [0x02956],
"DownRightTeeVector" => [0x0295F],
"DownRightVector" => [0x021C1],
"DownRightVectorBar" => [0x02957],
"DownTee" => [0x022A4],
"DownTeeArrow" => [0x021A7],
"Downarrow" => [0x021D3],
"Dscr" => [0x1D49F],
"Dstrok" => [0x00110],
"ENG" => [0x0014A],
"ETH" => [0x000D0],
"Eacute" => [0x000C9],
"Ecaron" => [0x0011A],
"Ecirc" => [0x000CA],
"Ecy" => [0x0042D],
"Edot" => [0x00116],
"Efr" => [0x1D508],
"Egrave" => [0x000C8],
"Element" => [0x02208],
"Emacr" => [0x00112],
"EmptySmallSquare" => [0x025FB],
"EmptyVerySmallSquare" => [0x025AB],
"Eogon" => [0x00118],
"Eopf" => [0x1D53C],
"Epsilon" => [0x00395],
"Equal" => [0x02A75],
"EqualTilde" => [0x02242],
"Equilibrium" => [0x021CC],
"Escr" => [0x02130],
"Esim" => [0x02A73],
"Eta" => [0x00397],
"Euml" => [0x000CB],
"Exists" => [0x02203],
"ExponentialE" => [0x02147],
"Fcy" => [0x00424],
"Ffr" => [0x1D509],
"FilledSmallSquare" => [0x025FC],
"FilledVerySmallSquare" => [0x025AA],
"Fopf" => [0x1D53D],
"ForAll" => [0x02200],
"Fouriertrf" => [0x02131],
"Fscr" => [0x02131],
"GJcy" => [0x00403],
"GT" => [0x0003E],
"Gamma" => [0x00393],
"Gammad" => [0x003DC],
"Gbreve" => [0x0011E],
"Gcedil" => [0x00122],
"Gcirc" => [0x0011C],
"Gcy" => [0x00413],
"Gdot" => [0x00120],
"Gfr" => [0x1D50A],
"Gg" => [0x022D9],
"Gopf" => [0x1D53E],
"GreaterEqual" => [0x02265],
"GreaterEqualLess" => [0x022DB],
"GreaterFullEqual" => [0x02267],
"GreaterGreater" => [0x02AA2],
"GreaterLess" => [0x02277],
"GreaterSlantEqual" => [0x02A7E],
"GreaterTilde" => [0x02273],
"Gscr" => [0x1D4A2],
"Gt" => [0x0226B],
"HARDcy" => [0x0042A],
"Hacek" => [0x002C7],
"Hat" => [0x0005E],
"Hcirc" => [0x00124],
"Hfr" => [0x0210C],
"HilbertSpace" => [0x0210B],
"Hopf" => [0x0210D],
"HorizontalLine" => [0x02500],
"Hscr" => [0x0210B],
"Hstrok" => [0x00126],
"HumpDownHump" => [0x0224E],
"HumpEqual" => [0x0224F],
"IEcy" => [0x00415],
"IJlig" => [0x00132],
"IOcy" => [0x00401],
"Iacute" => [0x000CD],
"Icirc" => [0x000CE],
"Icy" => [0x00418],
"Idot" => [0x00130],
"Ifr" => [0x02111],
"Igrave" => [0x000CC],
"Im" => [0x02111],
"Imacr" => [0x0012A],
"ImaginaryI" => [0x02148],
"Implies" => [0x021D2],
"Int" => [0x0222C],
"Integral" => [0x0222B],
"Intersection" => [0x022C2],
"InvisibleComma" => [0x02063],
"InvisibleTimes" => [0x02062],
"Iogon" => [0x0012E],
"Iopf" => [0x1D540],
"Iota" => [0x00399],
"Iscr" => [0x02110],
"Itilde" => [0x00128],
"Iukcy" => [0x00406],
"Iuml" => [0x000CF],
"Jcirc" => [0x00134],
"Jcy" => [0x00419],
"Jfr" => [0x1D50D],
"Jopf" => [0x1D541],
"Jscr" => [0x1D4A5],
"Jsercy" => [0x00408],
"Jukcy" => [0x00404],
"KHcy" => [0x00425],
"KJcy" => [0x0040C],
"Kappa" => [0x0039A],
"Kcedil" => [0x00136],
"Kcy" => [0x0041A],
"Kfr" => [0x1D50E],
"Kopf" => [0x1D542],
"Kscr" => [0x1D4A6],
"LJcy" => [0x00409],
"LT" => [0x0003C],
"Lacute" => [0x00139],
"Lambda" => [0x0039B],
"Lang" => [0x027EA],
"Laplacetrf" => [0x02112],
"Larr" => [0x0219E],
"Lcaron" => [0x0013D],
"Lcedil" => [0x0013B],
"Lcy" => [0x0041B],
"LeftAngleBracket" => [0x027E8],
"LeftArrow" => [0x02190],
"LeftArrowBar" => [0x021E4],
"LeftArrowRightArrow" => [0x021C6],
"LeftCeiling" => [0x02308],
"LeftDoubleBracket" => [0x027E6],
"LeftDownTeeVector" => [0x02961],
"LeftDownVector" => [0x021C3],
"LeftDownVectorBar" => [0x02959],
"LeftFloor" => [0x0230A],
"LeftRightArrow" => [0x02194],
"LeftRightVector" => [0x0294E],
"LeftTee" => [0x022A3],
"LeftTeeArrow" => [0x021A4],
"LeftTeeVector" => [0x0295A],
"LeftTriangle" => [0x022B2],
"LeftTriangleBar" => [0x029CF],
"LeftTriangleEqual" => [0x022B4],
"LeftUpDownVector" => [0x02951],
"LeftUpTeeVector" => [0x02960],
"LeftUpVector" => [0x021BF],
"LeftUpVectorBar" => [0x02958],
"LeftVector" => [0x021BC],
"LeftVectorBar" => [0x02952],
"Leftarrow" => [0x021D0],
"Leftrightarrow" => [0x021D4],
"LessEqualGreater" => [0x022DA],
"LessFullEqual" => [0x02266],
"LessGreater" => [0x02276],
"LessLess" => [0x02AA1],
"LessSlantEqual" => [0x02A7D],
"LessTilde" => [0x02272],
"Lfr" => [0x1D50F],
"Ll" => [0x022D8],
"Lleftarrow" => [0x021DA],
"Lmidot" => [0x0013F],
"LongLeftArrow" => [0x027F5],
"LongLeftRightArrow" => [0x027F7],
"LongRightArrow" => [0x027F6],
"Longleftarrow" => [0x027F8],
"Longleftrightarrow" => [0x027FA],
"Longrightarrow" => [0x027F9],
"Lopf" => [0x1D543],
"LowerLeftArrow" => [0x02199],
"LowerRightArrow" => [0x02198],
"Lscr" => [0x02112],
"Lsh" => [0x021B0],
"Lstrok" => [0x00141],
"Lt" => [0x0226A],
"Map" => [0x02905],
"Mcy" => [0x0041C],
"MediumSpace" => [0x0205F],
"Mellintrf" => [0x02133],
"Mfr" => [0x1D510],
"MinusPlus" => [0x02213],
"Mopf" => [0x1D544],
"Mscr" => [0x02133],
"Mu" => [0x0039C],
"NJcy" => [0x0040A],
"Nacute" => [0x00143],
"Ncaron" => [0x00147],
"Ncedil" => [0x00145],
"Ncy" => [0x0041D],
"NegativeMediumSpace" => [0x0200B],
"NegativeThickSpace" => [0x0200B],
"NegativeThinSpace" => [0x0200B],
"NegativeVeryThinSpace" => [0x0200B],
"NestedGreaterGreater" => [0x0226B],
"NestedLessLess" => [0x0226A],
"NewLine" => [0x0000A],
"Nfr" => [0x1D511],
"NoBreak" => [0x02060],
"NonBreakingSpace" => [0x000A0],
"Nopf" => [0x02115],
"Not" => [0x02AEC],
"NotCongruent" => [0x02262],
"NotCupCap" => [0x0226D],
"NotDoubleVerticalBar" => [0x02226],
"NotElement" => [0x02209],
"NotEqual" => [0x02260],
"NotEqualTilde" => [0x02242, 0x00338],
"NotExists" => [0x02204],
"NotGreater" => [0x0226F],
"NotGreaterEqual" => [0x02271],
"NotGreaterFullEqual" => [0x02267, 0x00338],
"NotGreaterGreater" => [0x0226B, 0x00338],
"NotGreaterLess" => [0x02279],
"NotGreaterSlantEqual" => [0x02A7E, 0x00338],
"NotGreaterTilde" => [0x02275],
"NotHumpDownHump" => [0x0224E, 0x00338],
"NotHumpEqual" => [0x0224F, 0x00338],
"NotLeftTriangle" => [0x022EA],
"NotLeftTriangleBar" => [0x029CF, 0x00338],
"NotLeftTriangleEqual" => [0x022EC],
"NotLess" => [0x0226E],
"NotLessEqual" => [0x02270],
"NotLessGreater" => [0x02278],
"NotLessLess" => [0x0226A, 0x00338],
"NotLessSlantEqual" => [0x02A7D, 0x00338],
"NotLessTilde" => [0x02274],
"NotNestedGreaterGreater" => [0x02AA2, 0x00338],
"NotNestedLessLess" => [0x02AA1, 0x00338],
"NotPrecedes" => [0x02280],
"NotPrecedesEqual" => [0x02AAF, 0x00338],
"NotPrecedesSlantEqual" => [0x022E0],
"NotReverseElement" => [0x0220C],
"NotRightTriangle" => [0x022EB],
"NotRightTriangleBar" => [0x029D0, 0x00338],
"NotRightTriangleEqual" => [0x022ED],
"NotSquareSubset" => [0x0228F, 0x00338],
"NotSquareSubsetEqual" => [0x022E2],
"NotSquareSuperset" => [0x02290, 0x00338],
"NotSquareSupersetEqual" => [0x022E3],
"NotSubset" => [0x02282, 0x020D2],
"NotSubsetEqual" => [0x02288],
"NotSucceeds" => [0x02281],
"NotSucceedsEqual" => [0x02AB0, 0x00338],
"NotSucceedsSlantEqual" => [0x022E1],
"NotSucceedsTilde" => [0x0227F, 0x00338],
"NotSuperset" => [0x02283, 0x020D2],
"NotSupersetEqual" => [0x02289],
"NotTilde" => [0x02241],
"NotTildeEqual" => [0x02244],
"NotTildeFullEqual" => [0x02247],
"NotTildeTilde" => [0x02249],
"NotVerticalBar" => [0x02224],
"Nscr" => [0x1D4A9],
"Ntilde" => [0x000D1],
"Nu" => [0x0039D],
"OElig" => [0x00152],
"Oacute" => [0x000D3],
"Ocirc" => [0x000D4],
"Ocy" => [0x0041E],
"Odblac" => [0x00150],
"Ofr" => [0x1D512],
"Ograve" => [0x000D2],
"Omacr" => [0x0014C],
"Omega" => [0x003A9],
"Omicron" => [0x0039F],
"Oopf" => [0x1D546],
"OpenCurlyDoubleQuote" => [0x0201C],
"OpenCurlyQuote" => [0x02018],
"Or" => [0x02A54],
"Oscr" => [0x1D4AA],
"Oslash" => [0x000D8],
"Otilde" => [0x000D5],
"Otimes" => [0x02A37],
"Ouml" => [0x000D6],
"OverBar" => [0x0203E],
"OverBrace" => [0x023DE],
"OverBracket" => [0x023B4],
"OverParenthesis" => [0x023DC],
"PartialD" => [0x02202],
"Pcy" => [0x0041F],
"Pfr" => [0x1D513],
"Phi" => [0x003A6],
"Pi" => [0x003A0],
"PlusMinus" => [0x000B1],
"Poincareplane" => [0x0210C],
"Popf" => [0x02119],
"Pr" => [0x02ABB],
"Precedes" => [0x0227A],
"PrecedesEqual" => [0x02AAF],
"PrecedesSlantEqual" => [0x0227C],
"PrecedesTilde" => [0x0227E],
"Prime" => [0x02033],
"Product" => [0x0220F],
"Proportion" => [0x02237],
"Proportional" => [0x0221D],
"Pscr" => [0x1D4AB],
"Psi" => [0x003A8],
"QUOT" => [0x00022],
"Qfr" => [0x1D514],
"Qopf" => [0x0211A],
"Qscr" => [0x1D4AC],
"RBarr" => [0x02910],
"REG" => [0x000AE],
"Racute" => [0x00154],
"Rang" => [0x027EB],
"Rarr" => [0x021A0],
"Rarrtl" => [0x02916],
"Rcaron" => [0x00158],
"Rcedil" => [0x00156],
"Rcy" => [0x00420],
"Re" => [0x0211C],
"ReverseElement" => [0x0220B],
"ReverseEquilibrium" => [0x021CB],
"ReverseUpEquilibrium" => [0x0296F],
"Rfr" => [0x0211C],
"Rho" => [0x003A1],
"RightAngleBracket" => [0x027E9],
"RightArrow" => [0x02192],
"RightArrowBar" => [0x021E5],
"RightArrowLeftArrow" => [0x021C4],
"RightCeiling" => [0x02309],
"RightDoubleBracket" => [0x027E7],
"RightDownTeeVector" => [0x0295D],
"RightDownVector" => [0x021C2],
"RightDownVectorBar" => [0x02955],
"RightFloor" => [0x0230B],
"RightTee" => [0x022A2],
"RightTeeArrow" => [0x021A6],
"RightTeeVector" => [0x0295B],
"RightTriangle" => [0x022B3],
"RightTriangleBar" => [0x029D0],
"RightTriangleEqual" => [0x022B5],
"RightUpDownVector" => [0x0294F],
"RightUpTeeVector" => [0x0295C],
"RightUpVector" => [0x021BE],
"RightUpVectorBar" => [0x02954],
"RightVector" => [0x021C0],
"RightVectorBar" => [0x02953],
"Rightarrow" => [0x021D2],
"Ropf" => [0x0211D],
"RoundImplies" => [0x02970],
"Rrightarrow" => [0x021DB],
"Rscr" => [0x0211B],
"Rsh" => [0x021B1],
"RuleDelayed" => [0x029F4],
"SHCHcy" => [0x00429],
"SHcy" => [0x00428],
"SOFTcy" => [0x0042C],
"Sacute" => [0x0015A],
"Sc" => [0x02ABC],
"Scaron" => [0x00160],
"Scedil" => [0x0015E],
"Scirc" => [0x0015C],
"Scy" => [0x00421],
"Sfr" => [0x1D516],
"ShortDownArrow" => [0x02193],
"ShortLeftArrow" => [0x02190],
"ShortRightArrow" => [0x02192],
"ShortUpArrow" => [0x02191],
"Sigma" => [0x003A3],
"SmallCircle" => [0x02218],
"Sopf" => [0x1D54A],
"Sqrt" => [0x0221A],
"Square" => [0x025A1],
"SquareIntersection" => [0x02293],
"SquareSubset" => [0x0228F],
"SquareSubsetEqual" => [0x02291],
"SquareSuperset" => [0x02290],
"SquareSupersetEqual" => [0x02292],
"SquareUnion" => [0x02294],
"Sscr" => [0x1D4AE],
"Star" => [0x022C6],
"Sub" => [0x022D0],
"Subset" => [0x022D0],
"SubsetEqual" => [0x02286],
"Succeeds" => [0x0227B],
"SucceedsEqual" => [0x02AB0],
"SucceedsSlantEqual" => [0x0227D],
"SucceedsTilde" => [0x0227F],
"SuchThat" => [0x0220B],
"Sum" => [0x02211],
"Sup" => [0x022D1],
"Superset" => [0x02283],
"SupersetEqual" => [0x02287],
"Supset" => [0x022D1],
"THORN" => [0x000DE],
"TRADE" => [0x02122],
"TSHcy" => [0x0040B],
"TScy" => [0x00426],
"Tab" => [0x00009],
"Tau" => [0x003A4],
"Tcaron" => [0x00164],
"Tcedil" => [0x00162],
"Tcy" => [0x00422],
"Tfr" => [0x1D517],
"Therefore" => [0x02234],
"Theta" => [0x00398],
"ThickSpace" => [0x0205F, 0x0200A],
"ThinSpace" => [0x02009],
"Tilde" => [0x0223C],
"TildeEqual" => [0x02243],
"TildeFullEqual" => [0x02245],
"TildeTilde" => [0x02248],
"Topf" => [0x1D54B],
"TripleDot" => [0x020DB],
"Tscr" => [0x1D4AF],
"Tstrok" => [0x00166],
"Uacute" => [0x000DA],
"Uarr" => [0x0219F],
"Uarrocir" => [0x02949],
"Ubrcy" => [0x0040E],
"Ubreve" => [0x0016C],
"Ucirc" => [0x000DB],
"Ucy" => [0x00423],
"Udblac" => [0x00170],
"Ufr" => [0x1D518],
"Ugrave" => [0x000D9],
"Umacr" => [0x0016A],
"UnderBar" => [0x0005F],
"UnderBrace" => [0x023DF],
"UnderBracket" => [0x023B5],
"UnderParenthesis" => [0x023DD],
"Union" => [0x022C3],
"UnionPlus" => [0x0228E],
"Uogon" => [0x00172],
"Uopf" => [0x1D54C],
"UpArrow" => [0x02191],
"UpArrowBar" => [0x02912],
"UpArrowDownArrow" => [0x021C5],
"UpDownArrow" => [0x02195],
"UpEquilibrium" => [0x0296E],
"UpTee" => [0x022A5],
"UpTeeArrow" => [0x021A5],
"Uparrow" => [0x021D1],
"Updownarrow" => [0x021D5],
"UpperLeftArrow" => [0x02196],
"UpperRightArrow" => [0x02197],
"Upsi" => [0x003D2],
"Upsilon" => [0x003A5],
"Uring" => [0x0016E],
"Uscr" => [0x1D4B0],
"Utilde" => [0x00168],
"Uuml" => [0x000DC],
"VDash" => [0x022AB],
"Vbar" => [0x02AEB],
"Vcy" => [0x00412],
"Vdash" => [0x022A9],
"Vdashl" => [0x02AE6],
"Vee" => [0x022C1],
"Verbar" => [0x02016],
"Vert" => [0x02016],
"VerticalBar" => [0x02223],
"VerticalLine" => [0x0007C],
"VerticalSeparator" => [0x02758],
"VerticalTilde" => [0x02240],
"VeryThinSpace" => [0x0200A],
"Vfr" => [0x1D519],
"Vopf" => [0x1D54D],
"Vscr" => [0x1D4B1],
"Vvdash" => [0x022AA],
"Wcirc" => [0x00174],
"Wedge" => [0x022C0],
"Wfr" => [0x1D51A],
"Wopf" => [0x1D54E],
"Wscr" => [0x1D4B2],
"Xfr" => [0x1D51B],
"Xi" => [0x0039E],
"Xopf" => [0x1D54F],
"Xscr" => [0x1D4B3],
"YAcy" => [0x0042F],
"YIcy" => [0x00407],
"YUcy" => [0x0042E],
"Yacute" => [0x000DD],
"Ycirc" => [0x00176],
"Ycy" => [0x0042B],
"Yfr" => [0x1D51C],
"Yopf" => [0x1D550],
"Yscr" => [0x1D4B4],
"Yuml" => [0x00178],
"ZHcy" => [0x00416],
"Zacute" => [0x00179],
"Zcaron" => [0x0017D],
"Zcy" => [0x00417],
"Zdot" => [0x0017B],
"ZeroWidthSpace" => [0x0200B],
"Zeta" => [0x00396],
"Zfr" => [0x02128],
"Zopf" => [0x02124],
"Zscr" => [0x1D4B5],
"aacute" => [0x000E1],
"abreve" => [0x00103],
"ac" => [0x0223E],
"acE" => [0x0223E, 0x00333],
"acd" => [0x0223F],
"acirc" => [0x000E2],
"acute" => [0x000B4],
"acy" => [0x00430],
"aelig" => [0x000E6],
"af" => [0x02061],
"afr" => [0x1D51E],
"agrave" => [0x000E0],
"alefsym" => [0x02135],
"aleph" => [0x02135],
"alpha" => [0x003B1],
"amacr" => [0x00101],
"amalg" => [0x02A3F],
"amp" => [0x00026],
"and" => [0x02227],
"andand" => [0x02A55],
"andd" => [0x02A5C],
"andslope" => [0x02A58],
"andv" => [0x02A5A],
"ang" => [0x02220],
"ange" => [0x029A4],
"angle" => [0x02220],
"angmsd" => [0x02221],
"angmsdaa" => [0x029A8],
"angmsdab" => [0x029A9],
"angmsdac" => [0x029AA],
"angmsdad" => [0x029AB],
"angmsdae" => [0x029AC],
"angmsdaf" => [0x029AD],
"angmsdag" => [0x029AE],
"angmsdah" => [0x029AF],
"angrt" => [0x0221F],
"angrtvb" => [0x022BE],
"angrtvbd" => [0x0299D],
"angsph" => [0x02222],
"angst" => [0x000C5],
"angzarr" => [0x0237C],
"aogon" => [0x00105],
"aopf" => [0x1D552],
"ap" => [0x02248],
"apE" => [0x02A70],
"apacir" => [0x02A6F],
"ape" => [0x0224A],
"apid" => [0x0224B],
"apos" => [0x00027],
"approx" => [0x02248],
"approxeq" => [0x0224A],
"aring" => [0x000E5],
"ascr" => [0x1D4B6],
"ast" => [0x0002A],
"asymp" => [0x02248],
"asympeq" => [0x0224D],
"atilde" => [0x000E3],
"auml" => [0x000E4],
"awconint" => [0x02233],
"awint" => [0x02A11],
"bNot" => [0x02AED],
"backcong" => [0x0224C],
"backepsilon" => [0x003F6],
"backprime" => [0x02035],
"backsim" => [0x0223D],
"backsimeq" => [0x022CD],
"barvee" => [0x022BD],
"barwed" => [0x02305],
"barwedge" => [0x02305],
"bbrk" => [0x023B5],
"bbrktbrk" => [0x023B6],
"bcong" => [0x0224C],
"bcy" => [0x00431],
"bdquo" => [0x0201E],
"becaus" => [0x02235],
"because" => [0x02235],
"bemptyv" => [0x029B0],
"bepsi" => [0x003F6],
"bernou" => [0x0212C],
"beta" => [0x003B2],
"beth" => [0x02136],
"between" => [0x0226C],
"bfr" => [0x1D51F],
"bigcap" => [0x022C2],
"bigcirc" => [0x025EF],
"bigcup" => [0x022C3],
"bigodot" => [0x02A00],
"bigoplus" => [0x02A01],
"bigotimes" => [0x02A02],
"bigsqcup" => [0x02A06],
"bigstar" => [0x02605],
"bigtriangledown" => [0x025BD],
"bigtriangleup" => [0x025B3],
"biguplus" => [0x02A04],
"bigvee" => [0x022C1],
"bigwedge" => [0x022C0],
"bkarow" => [0x0290D],
"blacklozenge" => [0x029EB],
"blacksquare" => [0x025AA],
"blacktriangle" => [0x025B4],
"blacktriangledown" => [0x025BE],
"blacktriangleleft" => [0x025C2],
"blacktriangleright" => [0x025B8],
"blank" => [0x02423],
"blk12" => [0x02592],
"blk14" => [0x02591],
"blk34" => [0x02593],
"block" => [0x02588],
"bne" => [0x0003D, 0x020E5],
"bnequiv" => [0x02261, 0x020E5],
"bnot" => [0x02310],
"bopf" => [0x1D553],
"bot" => [0x022A5],
"bottom" => [0x022A5],
"bowtie" => [0x022C8],
"boxDL" => [0x02557],
"boxDR" => [0x02554],
"boxDl" => [0x02556],
"boxDr" => [0x02553],
"boxH" => [0x02550],
"boxHD" => [0x02566],
"boxHU" => [0x02569],
"boxHd" => [0x02564],
"boxHu" => [0x02567],
"boxUL" => [0x0255D],
"boxUR" => [0x0255A],
"boxUl" => [0x0255C],
"boxUr" => [0x02559],
"boxV" => [0x02551],
"boxVH" => [0x0256C],
"boxVL" => [0x02563],
"boxVR" => [0x02560],
"boxVh" => [0x0256B],
"boxVl" => [0x02562],
"boxVr" => [0x0255F],
"boxbox" => [0x029C9],
"boxdL" => [0x02555],
"boxdR" => [0x02552],
"boxdl" => [0x02510],
"boxdr" => [0x0250C],
"boxh" => [0x02500],
"boxhD" => [0x02565],
"boxhU" => [0x02568],
"boxhd" => [0x0252C],
"boxhu" => [0x02534],
"boxminus" => [0x0229F],
"boxplus" => [0x0229E],
"boxtimes" => [0x022A0],
"boxuL" => [0x0255B],
"boxuR" => [0x02558],
"boxul" => [0x02518],
"boxur" => [0x02514],
"boxv" => [0x02502],
"boxvH" => [0x0256A],
"boxvL" => [0x02561],
"boxvR" => [0x0255E],
"boxvh" => [0x0253C],
"boxvl" => [0x02524],
"boxvr" => [0x0251C],
"bprime" => [0x02035],
"breve" => [0x002D8],
"brvbar" => [0x000A6],
"bscr" => [0x1D4B7],
"bsemi" => [0x0204F],
"bsim" => [0x0223D],
"bsime" => [0x022CD],
"bsol" => [0x0005C],
"bsolb" => [0x029C5],
"bsolhsub" => [0x027C8],
"bull" => [0x02022],
"bullet" => [0x02022],
"bump" => [0x0224E],
"bumpE" => [0x02AAE],
"bumpe" => [0x0224F],
"bumpeq" => [0x0224F],
"cacute" => [0x00107],
"cap" => [0x02229],
"capand" => [0x02A44],
"capbrcup" => [0x02A49],
"capcap" => [0x02A4B],
"capcup" => [0x02A47],
"capdot" => [0x02A40],
"caps" => [0x02229, 0x0FE00],
"caret" => [0x02041],
"caron" => [0x002C7],
"ccaps" => [0x02A4D],
"ccaron" => [0x0010D],
"ccedil" => [0x000E7],
"ccirc" => [0x00109],
"ccups" => [0x02A4C],
"ccupssm" => [0x02A50],
"cdot" => [0x0010B],
"cedil" => [0x000B8],
"cemptyv" => [0x029B2],
"cent" => [0x000A2],
"centerdot" => [0x000B7],
"cfr" => [0x1D520],
"chcy" => [0x00447],
"check" => [0x02713],
"checkmark" => [0x02713],
"chi" => [0x003C7],
"cir" => [0x025CB],
"cirE" => [0x029C3],
"circ" => [0x002C6],
"circeq" => [0x02257],
"circlearrowleft" => [0x021BA],
"circlearrowright" => [0x021BB],
"circledR" => [0x000AE],
"circledS" => [0x024C8],
"circledast" => [0x0229B],
"circledcirc" => [0x0229A],
"circleddash" => [0x0229D],
"cire" => [0x02257],
"cirfnint" => [0x02A10],
"cirmid" => [0x02AEF],
"cirscir" => [0x029C2],
"clubs" => [0x02663],
"clubsuit" => [0x02663],
"colon" => [0x0003A],
"colone" => [0x02254],
"coloneq" => [0x02254],
"comma" => [0x0002C],
"commat" => [0x00040],
"comp" => [0x02201],
"compfn" => [0x02218],
"complement" => [0x02201],
"complexes" => [0x02102],
"cong" => [0x02245],
"congdot" => [0x02A6D],
"conint" => [0x0222E],
"copf" => [0x1D554],
"coprod" => [0x02210],
"copy" => [0x000A9],
"copysr" => [0x02117],
"crarr" => [0x021B5],
"cross" => [0x02717],
"cscr" => [0x1D4B8],
"csub" => [0x02ACF],
"csube" => [0x02AD1],
"csup" => [0x02AD0],
"csupe" => [0x02AD2],
"ctdot" => [0x022EF],
"cudarrl" => [0x02938],
"cudarrr" => [0x02935],
"cuepr" => [0x022DE],
"cuesc" => [0x022DF],
"cularr" => [0x021B6],
"cularrp" => [0x0293D],
"cup" => [0x0222A],
"cupbrcap" => [0x02A48],
"cupcap" => [0x02A46],
"cupcup" => [0x02A4A],
"cupdot" => [0x0228D],
"cupor" => [0x02A45],
"cups" => [0x0222A, 0x0FE00],
"curarr" => [0x021B7],
"curarrm" => [0x0293C],
"curlyeqprec" => [0x022DE],
"curlyeqsucc" => [0x022DF],
"curlyvee" => [0x022CE],
"curlywedge" => [0x022CF],
"curren" => [0x000A4],
"curvearrowleft" => [0x021B6],
"curvearrowright" => [0x021B7],
"cuvee" => [0x022CE],
"cuwed" => [0x022CF],
"cwconint" => [0x02232],
"cwint" => [0x02231],
"cylcty" => [0x0232D],
"dArr" => [0x021D3],
"dHar" => [0x02965],
"dagger" => [0x02020],
"daleth" => [0x02138],
"darr" => [0x02193],
"dash" => [0x02010],
"dashv" => [0x022A3],
"dbkarow" => [0x0290F],
"dblac" => [0x002DD],
"dcaron" => [0x0010F],
"dcy" => [0x00434],
"dd" => [0x02146],
"ddagger" => [0x02021],
"ddarr" => [0x021CA],
"ddotseq" => [0x02A77],
"deg" => [0x000B0],
"delta" => [0x003B4],
"demptyv" => [0x029B1],
"dfisht" => [0x0297F],
"dfr" => [0x1D521],
"dharl" => [0x021C3],
"dharr" => [0x021C2],
"diam" => [0x022C4],
"diamond" => [0x022C4],
"diamondsuit" => [0x02666],
"diams" => [0x02666],
"die" => [0x000A8],
"digamma" => [0x003DD],
"disin" => [0x022F2],
"div" => [0x000F7],
"divide" => [0x000F7],
"divideontimes" => [0x022C7],
"divonx" => [0x022C7],
"djcy" => [0x00452],
"dlcorn" => [0x0231E],
"dlcrop" => [0x0230D],
"dollar" => [0x00024],
"dopf" => [0x1D555],
"dot" => [0x002D9],
"doteq" => [0x02250],
"doteqdot" => [0x02251],
"dotminus" => [0x02238],
"dotplus" => [0x02214],
"dotsquare" => [0x022A1],
"doublebarwedge" => [0x02306],
"downarrow" => [0x02193],
"downdownarrows" => [0x021CA],
"downharpoonleft" => [0x021C3],
"downharpoonright" => [0x021C2],
"drbkarow" => [0x02910],
"drcorn" => [0x0231F],
"drcrop" => [0x0230C],
"dscr" => [0x1D4B9],
"dscy" => [0x00455],
"dsol" => [0x029F6],
"dstrok" => [0x00111],
"dtdot" => [0x022F1],
"dtri" => [0x025BF],
"dtrif" => [0x025BE],
"duarr" => [0x021F5],
"duhar" => [0x0296F],
"dwangle" => [0x029A6],
"dzcy" => [0x0045F],
"dzigrarr" => [0x027FF],
"eDDot" => [0x02A77],
"eDot" => [0x02251],
"eacute" => [0x000E9],
"easter" => [0x02A6E],
"ecaron" => [0x0011B],
"ecir" => [0x02256],
"ecirc" => [0x000EA],
"ecolon" => [0x02255],
"ecy" => [0x0044D],
"edot" => [0x00117],
"ee" => [0x02147],
"efDot" => [0x02252],
"efr" => [0x1D522],
"eg" => [0x02A9A],
"egrave" => [0x000E8],
"egs" => [0x02A96],
"egsdot" => [0x02A98],
"el" => [0x02A99],
"elinters" => [0x023E7],
"ell" => [0x02113],
"els" => [0x02A95],
"elsdot" => [0x02A97],
"emacr" => [0x00113],
"empty" => [0x02205],
"emptyset" => [0x02205],
"emptyv" => [0x02205],
"emsp" => [0x02003],
"emsp13" => [0x02004],
"emsp14" => [0x02005],
"eng" => [0x0014B],
"ensp" => [0x02002],
"eogon" => [0x00119],
"eopf" => [0x1D556],
"epar" => [0x022D5],
"eparsl" => [0x029E3],
"eplus" => [0x02A71],
"epsi" => [0x003B5],
"epsilon" => [0x003B5],
"epsiv" => [0x003F5],
"eqcirc" => [0x02256],
"eqcolon" => [0x02255],
"eqsim" => [0x02242],
"eqslantgtr" => [0x02A96],
"eqslantless" => [0x02A95],
"equals" => [0x0003D],
"equest" => [0x0225F],
"equiv" => [0x02261],
"equivDD" => [0x02A78],
"eqvparsl" => [0x029E5],
"erDot" => [0x02253],
"erarr" => [0x02971],
"escr" => [0x0212F],
"esdot" => [0x02250],
"esim" => [0x02242],
"eta" => [0x003B7],
"eth" => [0x000F0],
"euml" => [0x000EB],
"euro" => [0x020AC],
"excl" => [0x00021],
"exist" => [0x02203],
"expectation" => [0x02130],
"exponentiale" => [0x02147],
"fallingdotseq" => [0x02252],
"fcy" => [0x00444],
"female" => [0x02640],
"ffilig" => [0x0FB03],
"fflig" => [0x0FB00],
"ffllig" => [0x0FB04],
"ffr" => [0x1D523],
"filig" => [0x0FB01],
"fjlig" => [0x00066, 0x0006A],
"flat" => [0x0266D],
"fllig" => [0x0FB02],
"fltns" => [0x025B1],
"fnof" => [0x00192],
"fopf" => [0x1D557],
"forall" => [0x02200],
"fork" => [0x022D4],
"forkv" => [0x02AD9],
"fpartint" => [0x02A0D],
"frac12" => [0x000BD],
"frac13" => [0x02153],
"frac14" => [0x000BC],
"frac15" => [0x02155],
"frac16" => [0x02159],
"frac18" => [0x0215B],
"frac23" => [0x02154],
"frac25" => [0x02156],
"frac34" => [0x000BE],
"frac35" => [0x02157],
"frac38" => [0x0215C],
"frac45" => [0x02158],
"frac56" => [0x0215A],
"frac58" => [0x0215D],
"frac78" => [0x0215E],
"frasl" => [0x02044],
"frown" => [0x02322],
"fscr" => [0x1D4BB],
"gE" => [0x02267],
"gEl" => [0x02A8C],
"gacute" => [0x001F5],
"gamma" => [0x003B3],
"gammad" => [0x003DD],
"gap" => [0x02A86],
"gbreve" => [0x0011F],
"gcirc" => [0x0011D],
"gcy" => [0x00433],
"gdot" => [0x00121],
"ge" => [0x02265],
"gel" => [0x022DB],
"geq" => [0x02265],
"geqq" => [0x02267],
"geqslant" => [0x02A7E],
"ges" => [0x02A7E],
"gescc" => [0x02AA9],
"gesdot" => [0x02A80],
"gesdoto" => [0x02A82],
"gesdotol" => [0x02A84],
"gesl" => [0x022DB, 0x0FE00],
"gesles" => [0x02A94],
"gfr" => [0x1D524],
"gg" => [0x0226B],
"ggg" => [0x022D9],
"gimel" => [0x02137],
"gjcy" => [0x00453],
"gl" => [0x02277],
"glE" => [0x02A92],
"gla" => [0x02AA5],
"glj" => [0x02AA4],
"gnE" => [0x02269],
"gnap" => [0x02A8A],
"gnapprox" => [0x02A8A],
"gne" => [0x02A88],
"gneq" => [0x02A88],
"gneqq" => [0x02269],
"gnsim" => [0x022E7],
"gopf" => [0x1D558],
"grave" => [0x00060],
"gscr" => [0x0210A],
"gsim" => [0x02273],
"gsime" => [0x02A8E],
"gsiml" => [0x02A90],
"gt" => [0x0003E],
"gtcc" => [0x02AA7],
"gtcir" => [0x02A7A],
"gtdot" => [0x022D7],
"gtlPar" => [0x02995],
"gtquest" => [0x02A7C],
"gtrapprox" => [0x02A86],
"gtrarr" => [0x02978],
"gtrdot" => [0x022D7],
"gtreqless" => [0x022DB],
"gtreqqless" => [0x02A8C],
"gtrless" => [0x02277],
"gtrsim" => [0x02273],
"gvertneqq" => [0x02269, 0x0FE00],
"gvnE" => [0x02269, 0x0FE00],
"hArr" => [0x021D4],
"hairsp" => [0x0200A],
"half" => [0x000BD],
"hamilt" => [0x0210B],
"hardcy" => [0x0044A],
"harr" => [0x02194],
"harrcir" => [0x02948],
"harrw" => [0x021AD],
"hbar" => [0x0210F],
"hcirc" => [0x00125],
"hearts" => [0x02665],
"heartsuit" => [0x02665],
"hellip" => [0x02026],
"hercon" => [0x022B9],
"hfr" => [0x1D525],
"hksearow" => [0x02925],
"hkswarow" => [0x02926],
"hoarr" => [0x021FF],
"homtht" => [0x0223B],
"hookleftarrow" => [0x021A9],
"hookrightarrow" => [0x021AA],
"hopf" => [0x1D559],
"horbar" => [0x02015],
"hscr" => [0x1D4BD],
"hslash" => [0x0210F],
"hstrok" => [0x00127],
"hybull" => [0x02043],
"hyphen" => [0x02010],
"iacute" => [0x000ED],
"ic" => [0x02063],
"icirc" => [0x000EE],
"icy" => [0x00438],
"iecy" => [0x00435],
"iexcl" => [0x000A1],
"iff" => [0x021D4],
"ifr" => [0x1D526],
"igrave" => [0x000EC],
"ii" => [0x02148],
"iiiint" => [0x02A0C],
"iiint" => [0x0222D],
"iinfin" => [0x029DC],
"iiota" => [0x02129],
"ijlig" => [0x00133],
"imacr" => [0x0012B],
"image" => [0x02111],
"imagline" => [0x02110],
"imagpart" => [0x02111],
"imath" => [0x00131],
"imof" => [0x022B7],
"imped" => [0x001B5],
"in" => [0x02208],
"incare" => [0x02105],
"infin" => [0x0221E],
"infintie" => [0x029DD],
"inodot" => [0x00131],
"int" => [0x0222B],
"intcal" => [0x022BA],
"integers" => [0x02124],
"intercal" => [0x022BA],
"intlarhk" => [0x02A17],
"intprod" => [0x02A3C],
"iocy" => [0x00451],
"iogon" => [0x0012F],
"iopf" => [0x1D55A],
"iota" => [0x003B9],
"iprod" => [0x02A3C],
"iquest" => [0x000BF],
"iscr" => [0x1D4BE],
"isin" => [0x02208],
"isinE" => [0x022F9],
"isindot" => [0x022F5],
"isins" => [0x022F4],
"isinsv" => [0x022F3],
"isinv" => [0x02208],
"it" => [0x02062],
"itilde" => [0x00129],
"iukcy" => [0x00456],
"iuml" => [0x000EF],
"jcirc" => [0x00135],
"jcy" => [0x00439],
"jfr" => [0x1D527],
"jmath" => [0x00237],
"jopf" => [0x1D55B],
"jscr" => [0x1D4BF],
"jsercy" => [0x00458],
"jukcy" => [0x00454],
"kappa" => [0x003BA],
"kappav" => [0x003F0],
"kcedil" => [0x00137],
"kcy" => [0x0043A],
"kfr" => [0x1D528],
"kgreen" => [0x00138],
"khcy" => [0x00445],
"kjcy" => [0x0045C],
"kopf" => [0x1D55C],
"kscr" => [0x1D4C0],
"lAarr" => [0x021DA],
"lArr" => [0x021D0],
"lAtail" => [0x0291B],
"lBarr" => [0x0290E],
"lE" => [0x02266],
"lEg" => [0x02A8B],
"lHar" => [0x02962],
"lacute" => [0x0013A],
"laemptyv" => [0x029B4],
"lagran" => [0x02112],
"lambda" => [0x003BB],
"lang" => [0x027E8],
"langd" => [0x02991],
"langle" => [0x027E8],
"lap" => [0x02A85],
"laquo" => [0x000AB],
"larr" => [0x02190],
"larrb" => [0x021E4],
"larrbfs" => [0x0291F],
"larrfs" => [0x0291D],
"larrhk" => [0x021A9],
"larrlp" => [0x021AB],
"larrpl" => [0x02939],
"larrsim" => [0x02973],
"larrtl" => [0x021A2],
"lat" => [0x02AAB],
"latail" => [0x02919],
"late" => [0x02AAD],
"lates" => [0x02AAD, 0x0FE00],
"lbarr" => [0x0290C],
"lbbrk" => [0x02772],
"lbrace" => [0x0007B],
"lbrack" => [0x0005B],
"lbrke" => [0x0298B],
"lbrksld" => [0x0298F],
"lbrkslu" => [0x0298D],
"lcaron" => [0x0013E],
"lcedil" => [0x0013C],
"lceil" => [0x02308],
"lcub" => [0x0007B],
"lcy" => [0x0043B],
"ldca" => [0x02936],
"ldquo" => [0x0201C],
"ldquor" => [0x0201E],
"ldrdhar" => [0x02967],
"ldrushar" => [0x0294B],
"ldsh" => [0x021B2],
"le" => [0x02264],
"leftarrow" => [0x02190],
"leftarrowtail" => [0x021A2],
"leftharpoondown" => [0x021BD],
"leftharpoonup" => [0x021BC],
"leftleftarrows" => [0x021C7],
"leftrightarrow" => [0x02194],
"leftrightarrows" => [0x021C6],
"leftrightharpoons" => [0x021CB],
"leftrightsquigarrow" => [0x021AD],
"leftthreetimes" => [0x022CB],
"leg" => [0x022DA],
"leq" => [0x02264],
"leqq" => [0x02266],
"leqslant" => [0x02A7D],
"les" => [0x02A7D],
"lescc" => [0x02AA8],
"lesdot" => [0x02A7F],
"lesdoto" => [0x02A81],
"lesdotor" => [0x02A83],
"lesg" => [0x022DA, 0x0FE00],
"lesges" => [0x02A93],
"lessapprox" => [0x02A85],
"lessdot" => [0x022D6],
"lesseqgtr" => [0x022DA],
"lesseqqgtr" => [0x02A8B],
"lessgtr" => [0x02276],
"lesssim" => [0x02272],
"lfisht" => [0x0297C],
"lfloor" => [0x0230A],
"lfr" => [0x1D529],
"lg" => [0x02276],
"lgE" => [0x02A91],
"lhard" => [0x021BD],
"lharu" => [0x021BC],
"lharul" => [0x0296A],
"lhblk" => [0x02584],
"ljcy" => [0x00459],
"ll" => [0x0226A],
"llarr" => [0x021C7],
"llcorner" => [0x0231E],
"llhard" => [0x0296B],
"lltri" => [0x025FA],
"lmidot" => [0x00140],
"lmoust" => [0x023B0],
"lmoustache" => [0x023B0],
"lnE" => [0x02268],
"lnap" => [0x02A89],
"lnapprox" => [0x02A89],
"lne" => [0x02A87],
"lneq" => [0x02A87],
"lneqq" => [0x02268],
"lnsim" => [0x022E6],
"loang" => [0x027EC],
"loarr" => [0x021FD],
"lobrk" => [0x027E6],
"longleftarrow" => [0x027F5],
"longleftrightarrow" => [0x027F7],
"longmapsto" => [0x027FC],
"longrightarrow" => [0x027F6],
"looparrowleft" => [0x021AB],
"looparrowright" => [0x021AC],
"lopar" => [0x02985],
"lopf" => [0x1D55D],
"loplus" => [0x02A2D],
"lotimes" => [0x02A34],
"lowast" => [0x02217],
"lowbar" => [0x0005F],
"loz" => [0x025CA],
"lozenge" => [0x025CA],
"lozf" => [0x029EB],
"lpar" => [0x00028],
"lparlt" => [0x02993],
"lrarr" => [0x021C6],
"lrcorner" => [0x0231F],
"lrhar" => [0x021CB],
"lrhard" => [0x0296D],
"lrm" => [0x0200E],
"lrtri" => [0x022BF],
"lsaquo" => [0x02039],
"lscr" => [0x1D4C1],
"lsh" => [0x021B0],
"lsim" => [0x02272],
"lsime" => [0x02A8D],
"lsimg" => [0x02A8F],
"lsqb" => [0x0005B],
"lsquo" => [0x02018],
"lsquor" => [0x0201A],
"lstrok" => [0x00142],
"lt" => [0x0003C],
"ltcc" => [0x02AA6],
"ltcir" => [0x02A79],
"ltdot" => [0x022D6],
"lthree" => [0x022CB],
"ltimes" => [0x022C9],
"ltlarr" => [0x02976],
"ltquest" => [0x02A7B],
"ltrPar" => [0x02996],
"ltri" => [0x025C3],
"ltrie" => [0x022B4],
"ltrif" => [0x025C2],
"lurdshar" => [0x0294A],
"luruhar" => [0x02966],
"lvertneqq" => [0x02268, 0x0FE00],
"lvnE" => [0x02268, 0x0FE00],
"mDDot" => [0x0223A],
"macr" => [0x000AF],
"male" => [0x02642],
"malt" => [0x02720],
"maltese" => [0x02720],
"map" => [0x021A6],
"mapsto" => [0x021A6],
"mapstodown" => [0x021A7],
"mapstoleft" => [0x021A4],
"mapstoup" => [0x021A5],
"marker" => [0x025AE],
"mcomma" => [0x02A29],
"mcy" => [0x0043C],
"mdash" => [0x02014],
"measuredangle" => [0x02221],
"mfr" => [0x1D52A],
"mho" => [0x02127],
"micro" => [0x000B5],
"mid" => [0x02223],
"midast" => [0x0002A],
"midcir" => [0x02AF0],
"middot" => [0x000B7],
"minus" => [0x02212],
"minusb" => [0x0229F],
"minusd" => [0x02238],
"minusdu" => [0x02A2A],
"mlcp" => [0x02ADB],
"mldr" => [0x02026],
"mnplus" => [0x02213],
"models" => [0x022A7],
"mopf" => [0x1D55E],
"mp" => [0x02213],
"mscr" => [0x1D4C2],
"mstpos" => [0x0223E],
"mu" => [0x003BC],
"multimap" => [0x022B8],
"mumap" => [0x022B8],
"nGg" => [0x022D9, 0x00338],
"nGt" => [0x0226B, 0x020D2],
"nGtv" => [0x0226B, 0x00338],
"nLeftarrow" => [0x021CD],
"nLeftrightarrow" => [0x021CE],
"nLl" => [0x022D8, 0x00338],
"nLt" => [0x0226A, 0x020D2],
"nLtv" => [0x0226A, 0x00338],
"nRightarrow" => [0x021CF],
"nVDash" => [0x022AF],
"nVdash" => [0x022AE],
"nabla" => [0x02207],
"nacute" => [0x00144],
"nang" => [0x02220, 0x020D2],
"nap" => [0x02249],
"napE" => [0x02A70, 0x00338],
"napid" => [0x0224B, 0x00338],
"napos" => [0x00149],
"napprox" => [0x02249],
"natur" => [0x0266E],
"natural" => [0x0266E],
"naturals" => [0x02115],
"nbsp" => [0x000A0],
"nbump" => [0x0224E, 0x00338],
"nbumpe" => [0x0224F, 0x00338],
"ncap" => [0x02A43],
"ncaron" => [0x00148],
"ncedil" => [0x00146],
"ncong" => [0x02247],
"ncongdot" => [0x02A6D, 0x00338],
"ncup" => [0x02A42],
"ncy" => [0x0043D],
"ndash" => [0x02013],
"ne" => [0x02260],
"neArr" => [0x021D7],
"nearhk" => [0x02924],
"nearr" => [0x02197],
"nearrow" => [0x02197],
"nedot" => [0x02250, 0x00338],
"nequiv" => [0x02262],
"nesear" => [0x02928],
"nesim" => [0x02242, 0x00338],
"nexist" => [0x02204],
"nexists" => [0x02204],
"nfr" => [0x1D52B],
"ngE" => [0x02267, 0x00338],
"nge" => [0x02271],
"ngeq" => [0x02271],
"ngeqq" => [0x02267, 0x00338],
"ngeqslant" => [0x02A7E, 0x00338],
"nges" => [0x02A7E, 0x00338],
"ngsim" => [0x02275],
"ngt" => [0x0226F],
"ngtr" => [0x0226F],
"nhArr" => [0x021CE],
"nharr" => [0x021AE],
"nhpar" => [0x02AF2],
"ni" => [0x0220B],
"nis" => [0x022FC],
"nisd" => [0x022FA],
"niv" => [0x0220B],
"njcy" => [0x0045A],
"nlArr" => [0x021CD],
"nlE" => [0x02266, 0x00338],
"nlarr" => [0x0219A],
"nldr" => [0x02025],
"nle" => [0x02270],
"nleftarrow" => [0x0219A],
"nleftrightarrow" => [0x021AE],
"nleq" => [0x02270],
"nleqq" => [0x02266, 0x00338],
"nleqslant" => [0x02A7D, 0x00338],
"nles" => [0x02A7D, 0x00338],
"nless" => [0x0226E],
"nlsim" => [0x02274],
"nlt" => [0x0226E],
"nltri" => [0x022EA],
"nltrie" => [0x022EC],
"nmid" => [0x02224],
"nopf" => [0x1D55F],
"not" => [0x000AC],
"notin" => [0x02209],
"notinE" => [0x022F9, 0x00338],
"notindot" => [0x022F5, 0x00338],
"notinva" => [0x02209],
"notinvb" => [0x022F7],
"notinvc" => [0x022F6],
"notni" => [0x0220C],
"notniva" => [0x0220C],
"notnivb" => [0x022FE],
"notnivc" => [0x022FD],
"npar" => [0x02226],
"nparallel" => [0x02226],
"nparsl" => [0x02AFD, 0x020E5],
"npart" => [0x02202, 0x00338],
"npolint" => [0x02A14],
"npr" => [0x02280],
"nprcue" => [0x022E0],
"npre" => [0x02AAF, 0x00338],
"nprec" => [0x02280],
"npreceq" => [0x02AAF, 0x00338],
"nrArr" => [0x021CF],
"nrarr" => [0x0219B],
"nrarrc" => [0x02933, 0x00338],
"nrarrw" => [0x0219D, 0x00338],
"nrightarrow" => [0x0219B],
"nrtri" => [0x022EB],
"nrtrie" => [0x022ED],
"nsc" => [0x02281],
"nsccue" => [0x022E1],
"nsce" => [0x02AB0, 0x00338],
"nscr" => [0x1D4C3],
"nshortmid" => [0x02224],
"nshortparallel" => [0x02226],
"nsim" => [0x02241],
"nsime" => [0x02244],
"nsimeq" => [0x02244],
"nsmid" => [0x02224],
"nspar" => [0x02226],
"nsqsube" => [0x022E2],
"nsqsupe" => [0x022E3],
"nsub" => [0x02284],
"nsubE" => [0x02AC5, 0x00338],
"nsube" => [0x02288],
"nsubset" => [0x02282, 0x020D2],
"nsubseteq" => [0x02288],
"nsubseteqq" => [0x02AC5, 0x00338],
"nsucc" => [0x02281],
"nsucceq" => [0x02AB0, 0x00338],
"nsup" => [0x02285],
"nsupE" => [0x02AC6, 0x00338],
"nsupe" => [0x02289],
"nsupset" => [0x02283, 0x020D2],
"nsupseteq" => [0x02289],
"nsupseteqq" => [0x02AC6, 0x00338],
"ntgl" => [0x02279],
"ntilde" => [0x000F1],
"ntlg" => [0x02278],
"ntriangleleft" => [0x022EA],
"ntrianglelefteq" => [0x022EC],
"ntriangleright" => [0x022EB],
"ntrianglerighteq" => [0x022ED],
"nu" => [0x003BD],
"num" => [0x00023],
"numero" => [0x02116],
"numsp" => [0x02007],
"nvDash" => [0x022AD],
"nvHarr" => [0x02904],
"nvap" => [0x0224D, 0x020D2],
"nvdash" => [0x022AC],
"nvge" => [0x02265, 0x020D2],
"nvgt" => [0x0003E, 0x020D2],
"nvinfin" => [0x029DE],
"nvlArr" => [0x02902],
"nvle" => [0x02264, 0x020D2],
"nvlt" => [0x0003C, 0x020D2],
"nvltrie" => [0x022B4, 0x020D2],
"nvrArr" => [0x02903],
"nvrtrie" => [0x022B5, 0x020D2],
"nvsim" => [0x0223C, 0x020D2],
"nwArr" => [0x021D6],
"nwarhk" => [0x02923],
"nwarr" => [0x02196],
"nwarrow" => [0x02196],
"nwnear" => [0x02927],
"oS" => [0x024C8],
"oacute" => [0x000F3],
"oast" => [0x0229B],
"ocir" => [0x0229A],
"ocirc" => [0x000F4],
"ocy" => [0x0043E],
"odash" => [0x0229D],
"odblac" => [0x00151],
"odiv" => [0x02A38],
"odot" => [0x02299],
"odsold" => [0x029BC],
"oelig" => [0x00153],
"ofcir" => [0x029BF],
"ofr" => [0x1D52C],
"ogon" => [0x002DB],
"ograve" => [0x000F2],
"ogt" => [0x029C1],
"ohbar" => [0x029B5],
"ohm" => [0x003A9],
"oint" => [0x0222E],
"olarr" => [0x021BA],
"olcir" => [0x029BE],
"olcross" => [0x029BB],
"oline" => [0x0203E],
"olt" => [0x029C0],
"omacr" => [0x0014D],
"omega" => [0x003C9],
"omicron" => [0x003BF],
"omid" => [0x029B6],
"ominus" => [0x02296],
"oopf" => [0x1D560],
"opar" => [0x029B7],
"operp" => [0x029B9],
"oplus" => [0x02295],
"or" => [0x02228],
"orarr" => [0x021BB],
"ord" => [0x02A5D],
"order" => [0x02134],
"orderof" => [0x02134],
"ordf" => [0x000AA],
"ordm" => [0x000BA],
"origof" => [0x022B6],
"oror" => [0x02A56],
"orslope" => [0x02A57],
"orv" => [0x02A5B],
"oscr" => [0x02134],
"oslash" => [0x000F8],
"osol" => [0x02298],
"otilde" => [0x000F5],
"otimes" => [0x02297],
"otimesas" => [0x02A36],
"ouml" => [0x000F6],
"ovbar" => [0x0233D],
"par" => [0x02225],
"para" => [0x000B6],
"parallel" => [0x02225],
"parsim" => [0x02AF3],
"parsl" => [0x02AFD],
"part" => [0x02202],
"pcy" => [0x0043F],
"percnt" => [0x00025],
"period" => [0x0002E],
"permil" => [0x02030],
"perp" => [0x022A5],
"pertenk" => [0x02031],
"pfr" => [0x1D52D],
"phi" => [0x003C6],
"phiv" => [0x003D5],
"phmmat" => [0x02133],
"phone" => [0x0260E],
"pi" => [0x003C0],
"pitchfork" => [0x022D4],
"piv" => [0x003D6],
"planck" => [0x0210F],
"planckh" => [0x0210E],
"plankv" => [0x0210F],
"plus" => [0x0002B],
"plusacir" => [0x02A23],
"plusb" => [0x0229E],
"pluscir" => [0x02A22],
"plusdo" => [0x02214],
"plusdu" => [0x02A25],
"pluse" => [0x02A72],
"plusmn" => [0x000B1],
"plussim" => [0x02A26],
"plustwo" => [0x02A27],
"pm" => [0x000B1],
"pointint" => [0x02A15],
"popf" => [0x1D561],
"pound" => [0x000A3],
"pr" => [0x0227A],
"prE" => [0x02AB3],
"prap" => [0x02AB7],
"prcue" => [0x0227C],
"pre" => [0x02AAF],
"prec" => [0x0227A],
"precapprox" => [0x02AB7],
"preccurlyeq" => [0x0227C],
"preceq" => [0x02AAF],
"precnapprox" => [0x02AB9],
"precneqq" => [0x02AB5],
"precnsim" => [0x022E8],
"precsim" => [0x0227E],
"prime" => [0x02032],
"primes" => [0x02119],
"prnE" => [0x02AB5],
"prnap" => [0x02AB9],
"prnsim" => [0x022E8],
"prod" => [0x0220F],
"profalar" => [0x0232E],
"profline" => [0x02312],
"profsurf" => [0x02313],
"prop" => [0x0221D],
"propto" => [0x0221D],
"prsim" => [0x0227E],
"prurel" => [0x022B0],
"pscr" => [0x1D4C5],
"psi" => [0x003C8],
"puncsp" => [0x02008],
"qfr" => [0x1D52E],
"qint" => [0x02A0C],
"qopf" => [0x1D562],
"qprime" => [0x02057],
"qscr" => [0x1D4C6],
"quaternions" => [0x0210D],
"quatint" => [0x02A16],
"quest" => [0x0003F],
"questeq" => [0x0225F],
"quot" => [0x00022],
"rAarr" => [0x021DB],
"rArr" => [0x021D2],
"rAtail" => [0x0291C],
"rBarr" => [0x0290F],
"rHar" => [0x02964],
"race" => [0x0223D, 0x00331],
"racute" => [0x00155],
"radic" => [0x0221A],
"raemptyv" => [0x029B3],
"rang" => [0x027E9],
"rangd" => [0x02992],
"range" => [0x029A5],
"rangle" => [0x027E9],
"raquo" => [0x000BB],
"rarr" => [0x02192],
"rarrap" => [0x02975],
"rarrb" => [0x021E5],
"rarrbfs" => [0x02920],
"rarrc" => [0x02933],
"rarrfs" => [0x0291E],
"rarrhk" => [0x021AA],
"rarrlp" => [0x021AC],
"rarrpl" => [0x02945],
"rarrsim" => [0x02974],
"rarrtl" => [0x021A3],
"rarrw" => [0x0219D],
"ratail" => [0x0291A],
"ratio" => [0x02236],
"rationals" => [0x0211A],
"rbarr" => [0x0290D],
"rbbrk" => [0x02773],
"rbrace" => [0x0007D],
"rbrack" => [0x0005D],
"rbrke" => [0x0298C],
"rbrksld" => [0x0298E],
"rbrkslu" => [0x02990],
"rcaron" => [0x00159],
"rcedil" => [0x00157],
"rceil" => [0x02309],
"rcub" => [0x0007D],
"rcy" => [0x00440],
"rdca" => [0x02937],
"rdldhar" => [0x02969],
"rdquo" => [0x0201D],
"rdquor" => [0x0201D],
"rdsh" => [0x021B3],
"real" => [0x0211C],
"realine" => [0x0211B],
"realpart" => [0x0211C],
"reals" => [0x0211D],
"rect" => [0x025AD],
"reg" => [0x000AE],
"rfisht" => [0x0297D],
"rfloor" => [0x0230B],
"rfr" => [0x1D52F],
"rhard" => [0x021C1],
"rharu" => [0x021C0],
"rharul" => [0x0296C],
"rho" => [0x003C1],
"rhov" => [0x003F1],
"rightarrow" => [0x02192],
"rightarrowtail" => [0x021A3],
"rightharpoondown" => [0x021C1],
"rightharpoonup" => [0x021C0],
"rightleftarrows" => [0x021C4],
"rightleftharpoons" => [0x021CC],
"rightrightarrows" => [0x021C9],
"rightsquigarrow" => [0x0219D],
"rightthreetimes" => [0x022CC],
"ring" => [0x002DA],
"risingdotseq" => [0x02253],
"rlarr" => [0x021C4],
"rlhar" => [0x021CC],
"rlm" => [0x0200F],
"rmoust" => [0x023B1],
"rmoustache" => [0x023B1],
"rnmid" => [0x02AEE],
"roang" => [0x027ED],
"roarr" => [0x021FE],
"robrk" => [0x027E7],
"ropar" => [0x02986],
"ropf" => [0x1D563],
"roplus" => [0x02A2E],
"rotimes" => [0x02A35],
"rpar" => [0x00029],
"rpargt" => [0x02994],
"rppolint" => [0x02A12],
"rrarr" => [0x021C9],
"rsaquo" => [0x0203A],
"rscr" => [0x1D4C7],
"rsh" => [0x021B1],
"rsqb" => [0x0005D],
"rsquo" => [0x02019],
"rsquor" => [0x02019],
"rthree" => [0x022CC],
"rtimes" => [0x022CA],
"rtri" => [0x025B9],
"rtrie" => [0x022B5],
"rtrif" => [0x025B8],
"rtriltri" => [0x029CE],
"ruluhar" => [0x02968],
"rx" => [0x0211E],
"sacute" => [0x0015B],
"sbquo" => [0x0201A],
"sc" => [0x0227B],
"scE" => [0x02AB4],
"scap" => [0x02AB8],
"scaron" => [0x00161],
"sccue" => [0x0227D],
"sce" => [0x02AB0],
"scedil" => [0x0015F],
"scirc" => [0x0015D],
"scnE" => [0x02AB6],
"scnap" => [0x02ABA],
"scnsim" => [0x022E9],
"scpolint" => [0x02A13],
"scsim" => [0x0227F],
"scy" => [0x00441],
"sdot" => [0x022C5],
"sdotb" => [0x022A1],
"sdote" => [0x02A66],
"seArr" => [0x021D8],
"searhk" => [0x02925],
"searr" => [0x02198],
"searrow" => [0x02198],
"sect" => [0x000A7],
"semi" => [0x0003B],
"seswar" => [0x02929],
"setminus" => [0x02216],
"setmn" => [0x02216],
"sext" => [0x02736],
"sfr" => [0x1D530],
"sfrown" => [0x02322],
"sharp" => [0x0266F],
"shchcy" => [0x00449],
"shcy" => [0x00448],
"shortmid" => [0x02223],
"shortparallel" => [0x02225],
"shy" => [0x000AD],
"sigma" => [0x003C3],
"sigmaf" => [0x003C2],
"sigmav" => [0x003C2],
"sim" => [0x0223C],
"simdot" => [0x02A6A],
"sime" => [0x02243],
"simeq" => [0x02243],
"simg" => [0x02A9E],
"simgE" => [0x02AA0],
"siml" => [0x02A9D],
"simlE" => [0x02A9F],
"simne" => [0x02246],
"simplus" => [0x02A24],
"simrarr" => [0x02972],
"slarr" => [0x02190],
"smallsetminus" => [0x02216],
"smashp" => [0x02A33],
"smeparsl" => [0x029E4],
"smid" => [0x02223],
"smile" => [0x02323],
"smt" => [0x02AAA],
"smte" => [0x02AAC],
"smtes" => [0x02AAC, 0x0FE00],
"softcy" => [0x0044C],
"sol" => [0x0002F],
"solb" => [0x029C4],
"solbar" => [0x0233F],
"sopf" => [0x1D564],
"spades" => [0x02660],
"spadesuit" => [0x02660],
"spar" => [0x02225],
"sqcap" => [0x02293],
"sqcaps" => [0x02293, 0x0FE00],
"sqcup" => [0x02294],
"sqcups" => [0x02294, 0x0FE00],
"sqsub" => [0x0228F],
"sqsube" => [0x02291],
"sqsubset" => [0x0228F],
"sqsubseteq" => [0x02291],
"sqsup" => [0x02290],
"sqsupe" => [0x02292],
"sqsupset" => [0x02290],
"sqsupseteq" => [0x02292],
"squ" => [0x025A1],
"square" => [0x025A1],
"squarf" => [0x025AA],
"squf" => [0x025AA],
"srarr" => [0x02192],
"sscr" => [0x1D4C8],
"ssetmn" => [0x02216],
"ssmile" => [0x02323],
"sstarf" => [0x022C6],
"star" => [0x02606],
"starf" => [0x02605],
"straightepsilon" => [0x003F5],
"straightphi" => [0x003D5],
"strns" => [0x000AF],
"sub" => [0x02282],
"subE" => [0x02AC5],
"subdot" => [0x02ABD],
"sube" => [0x02286],
"subedot" => [0x02AC3],
"submult" => [0x02AC1],
"subnE" => [0x02ACB],
"subne" => [0x0228A],
"subplus" => [0x02ABF],
"subrarr" => [0x02979],
"subset" => [0x02282],
"subseteq" => [0x02286],
"subseteqq" => [0x02AC5],
"subsetneq" => [0x0228A],
"subsetneqq" => [0x02ACB],
"subsim" => [0x02AC7],
"subsub" => [0x02AD5],
"subsup" => [0x02AD3],
"succ" => [0x0227B],
"succapprox" => [0x02AB8],
"succcurlyeq" => [0x0227D],
"succeq" => [0x02AB0],
"succnapprox" => [0x02ABA],
"succneqq" => [0x02AB6],
"succnsim" => [0x022E9],
"succsim" => [0x0227F],
"sum" => [0x02211],
"sung" => [0x0266A],
"sup" => [0x02283],
"sup1" => [0x000B9],
"sup2" => [0x000B2],
"sup3" => [0x000B3],
"supE" => [0x02AC6],
"supdot" => [0x02ABE],
"supdsub" => [0x02AD8],
"supe" => [0x02287],
"supedot" => [0x02AC4],
"suphsol" => [0x027C9],
"suphsub" => [0x02AD7],
"suplarr" => [0x0297B],
"supmult" => [0x02AC2],
"supnE" => [0x02ACC],
"supne" => [0x0228B],
"supplus" => [0x02AC0],
"supset" => [0x02283],
"supseteq" => [0x02287],
"supseteqq" => [0x02AC6],
"supsetneq" => [0x0228B],
"supsetneqq" => [0x02ACC],
"supsim" => [0x02AC8],
"supsub" => [0x02AD4],
"supsup" => [0x02AD6],
"swArr" => [0x021D9],
"swarhk" => [0x02926],
"swarr" => [0x02199],
"swarrow" => [0x02199],
"swnwar" => [0x0292A],
"szlig" => [0x000DF],
"target" => [0x02316],
"tau" => [0x003C4],
"tbrk" => [0x023B4],
"tcaron" => [0x00165],
"tcedil" => [0x00163],
"tcy" => [0x00442],
"tdot" => [0x020DB],
"telrec" => [0x02315],
"tfr" => [0x1D531],
"there4" => [0x02234],
"therefore" => [0x02234],
"theta" => [0x003B8],
"thetasym" => [0x003D1],
"thetav" => [0x003D1],
"thickapprox" => [0x02248],
"thicksim" => [0x0223C],
"thinsp" => [0x02009],
"thkap" => [0x02248],
"thksim" => [0x0223C],
"thorn" => [0x000FE],
"tilde" => [0x002DC],
"times" => [0x000D7],
"timesb" => [0x022A0],
"timesbar" => [0x02A31],
"timesd" => [0x02A30],
"tint" => [0x0222D],
"toea" => [0x02928],
"top" => [0x022A4],
"topbot" => [0x02336],
"topcir" => [0x02AF1],
"topf" => [0x1D565],
"topfork" => [0x02ADA],
"tosa" => [0x02929],
"tprime" => [0x02034],
"trade" => [0x02122],
"triangle" => [0x025B5],
"triangledown" => [0x025BF],
"triangleleft" => [0x025C3],
"trianglelefteq" => [0x022B4],
"triangleq" => [0x0225C],
"triangleright" => [0x025B9],
"trianglerighteq" => [0x022B5],
"tridot" => [0x025EC],
"trie" => [0x0225C],
"triminus" => [0x02A3A],
"triplus" => [0x02A39],
"trisb" => [0x029CD],
"tritime" => [0x02A3B],
"trpezium" => [0x023E2],
"tscr" => [0x1D4C9],
"tscy" => [0x00446],
"tshcy" => [0x0045B],
"tstrok" => [0x00167],
"twixt" => [0x0226C],
"twoheadleftarrow" => [0x0219E],
"twoheadrightarrow" => [0x021A0],
"uArr" => [0x021D1],
"uHar" => [0x02963],
"uacute" => [0x000FA],
"uarr" => [0x02191],
"ubrcy" => [0x0045E],
"ubreve" => [0x0016D],
"ucirc" => [0x000FB],
"ucy" => [0x00443],
"udarr" => [0x021C5],
"udblac" => [0x00171],
"udhar" => [0x0296E],
"ufisht" => [0x0297E],
"ufr" => [0x1D532],
"ugrave" => [0x000F9],
"uharl" => [0x021BF],
"uharr" => [0x021BE],
"uhblk" => [0x02580],
"ulcorn" => [0x0231C],
"ulcorner" => [0x0231C],
"ulcrop" => [0x0230F],
"ultri" => [0x025F8],
"umacr" => [0x0016B],
"uml" => [0x000A8],
"uogon" => [0x00173],
"uopf" => [0x1D566],
"uparrow" => [0x02191],
"updownarrow" => [0x02195],
"upharpoonleft" => [0x021BF],
"upharpoonright" => [0x021BE],
"uplus" => [0x0228E],
"upsi" => [0x003C5],
"upsih" => [0x003D2],
"upsilon" => [0x003C5],
"upuparrows" => [0x021C8],
"urcorn" => [0x0231D],
"urcorner" => [0x0231D],
"urcrop" => [0x0230E],
"uring" => [0x0016F],
"urtri" => [0x025F9],
"uscr" => [0x1D4CA],
"utdot" => [0x022F0],
"utilde" => [0x00169],
"utri" => [0x025B5],
"utrif" => [0x025B4],
"uuarr" => [0x021C8],
"uuml" => [0x000FC],
"uwangle" => [0x029A7],
"vArr" => [0x021D5],
"vBar" => [0x02AE8],
"vBarv" => [0x02AE9],
"vDash" => [0x022A8],
"vangrt" => [0x0299C],
"varepsilon" => [0x003F5],
"varkappa" => [0x003F0],
"varnothing" => [0x02205],
"varphi" => [0x003D5],
"varpi" => [0x003D6],
"varpropto" => [0x0221D],
"varr" => [0x02195],
"varrho" => [0x003F1],
"varsigma" => [0x003C2],
"varsubsetneq" => [0x0228A, 0x0FE00],
"varsubsetneqq" => [0x02ACB, 0x0FE00],
"varsupsetneq" => [0x0228B, 0x0FE00],
"varsupsetneqq" => [0x02ACC, 0x0FE00],
"vartheta" => [0x003D1],
"vartriangleleft" => [0x022B2],
"vartriangleright" => [0x022B3],
"vcy" => [0x00432],
"vdash" => [0x022A2],
"vee" => [0x02228],
"veebar" => [0x022BB],
"veeeq" => [0x0225A],
"vellip" => [0x022EE],
"verbar" => [0x0007C],
"vert" => [0x0007C],
"vfr" => [0x1D533],
"vltri" => [0x022B2],
"vnsub" => [0x02282, 0x020D2],
"vnsup" => [0x02283, 0x020D2],
"vopf" => [0x1D567],
"vprop" => [0x0221D],
"vrtri" => [0x022B3],
"vscr" => [0x1D4CB],
"vsubnE" => [0x02ACB, 0x0FE00],
"vsubne" => [0x0228A, 0x0FE00],
"vsupnE" => [0x02ACC, 0x0FE00],
"vsupne" => [0x0228B, 0x0FE00],
"vzigzag" => [0x0299A],
"wcirc" => [0x00175],
"wedbar" => [0x02A5F],
"wedge" => [0x02227],
"wedgeq" => [0x02259],
"weierp" => [0x02118],
"wfr" => [0x1D534],
"wopf" => [0x1D568],
"wp" => [0x02118],
"wr" => [0x02240],
"wreath" => [0x02240],
"wscr" => [0x1D4CC],
"xcap" => [0x022C2],
"xcirc" => [0x025EF],
"xcup" => [0x022C3],
"xdtri" => [0x025BD],
"xfr" => [0x1D535],
"xhArr" => [0x027FA],
"xharr" => [0x027F7],
"xi" => [0x003BE],
"xlArr" => [0x027F8],
"xlarr" => [0x027F5],
"xmap" => [0x027FC],
"xnis" => [0x022FB],
"xodot" => [0x02A00],
"xopf" => [0x1D569],
"xoplus" => [0x02A01],
"xotime" => [0x02A02],
"xrArr" => [0x027F9],
"xrarr" => [0x027F6],
"xscr" => [0x1D4CD],
"xsqcup" => [0x02A06],
"xuplus" => [0x02A04],
"xutri" => [0x025B3],
"xvee" => [0x022C1],
"xwedge" => [0x022C0],
"yacute" => [0x000FD],
"yacy" => [0x0044F],
"ycirc" => [0x00177],
"ycy" => [0x0044B],
"yen" => [0x000A5],
"yfr" => [0x1D536],
"yicy" => [0x00457],
"yopf" => [0x1D56A],
"yscr" => [0x1D4CE],
"yucy" => [0x0044E],
"yuml" => [0x000FF],
"zacute" => [0x0017A],
"zcaron" => [0x0017E],
"zcy" => [0x00437],
"zdot" => [0x0017C],
"zeetrf" => [0x02128],
"zeta" => [0x003B6],
"zfr" => [0x1D537],
"zhcy" => [0x00436],
"zigrarr" => [0x021DD],
"zopf" => [0x1D56B],
"zscr" => [0x1D4CF],
"zwj" => [0x0200D],
"zwnj" => [0x0200C],
}
share/gems/gems/erb-4.0.3/libexec/erb 0000755 00000010754 15173517751 0013100 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
# Tiny eRuby --- ERB2
# Copyright (c) 1999-2000,2002 Masatoshi SEKI
# You can redistribute it and/or modify it under the same terms as Ruby.
require 'erb'
class ERB
module Main
def ARGV.switch
return nil if self.empty?
arg = self.shift
return nil if arg == '--'
case arg
when /\A-(.)(.*)/
if $1 == '-'
arg, @maybe_arg = arg.split(/=/, 2)
return arg
end
raise 'unknown switch "-"' if $2[0] == ?- and $1 != 'T'
if $2.size > 0
self.unshift "-#{$2}"
@maybe_arg = $2
else
@maybe_arg = nil
end
"-#{$1}"
when /\A(\w+)=/
arg
else
self.unshift arg
nil
end
end
def ARGV.req_arg
(@maybe_arg || self.shift || raise('missing argument')).tap {
@maybe_arg = nil
}
end
def trim_mode_opt(trim_mode, disable_percent)
return trim_mode if disable_percent
case trim_mode
when 0
return '%'
when 1
return '%>'
when 2
return '%<>'
when '-'
return '%-'
end
end
module_function :trim_mode_opt
def run(factory=ERB)
trim_mode = 0
disable_percent = false
variables = {}
begin
while switch = ARGV.switch
case switch
when '-x' # ruby source
output = true
when '-n' # line number
number = true
when '-v' # verbose
$VERBOSE = true
when '--version' # version
STDERR.puts factory.version
exit
when '-d', '--debug' # debug
$DEBUG = true
when '-r' # require
require ARGV.req_arg
when '-T' # trim mode
arg = ARGV.req_arg
if arg == '-'
trim_mode = arg
next
end
raise "invalid trim mode #{arg.dump}" unless arg =~ /\A[0-2]\z/
trim_mode = arg.to_i
when '-E', '--encoding'
arg = ARGV.req_arg
set_encoding(*arg.split(/:/, 2))
when '-U'
set_encoding(Encoding::UTF_8, Encoding::UTF_8)
when '-P'
disable_percent = true
when '--help'
raise "print this help"
when /\A-/
raise "unknown switch #{switch.dump}"
else
var, val = *switch.split('=', 2)
(variables ||= {})[var] = val
end
end
rescue # usage
STDERR.puts $!.to_s
STDERR.puts File.basename($0) +
" [switches] [var=value...] [inputfile]"
STDERR.puts <<EOU
-x print ruby script
-n print ruby script with line number
-v enable verbose mode
-d set $DEBUG to true
-r library load a library
-E ex[:in] set default external/internal encodings
-U set default encoding to UTF-8
-T trim_mode specify trim_mode (0..2, -)
-P disable ruby code evaluation for lines beginning with %
var=value set variable
EOU
exit 1
end
$<.set_encoding(Encoding::UTF_8, nil)
src = $<.read
filename = $FILENAME
exit 2 unless src
trim = trim_mode_opt(trim_mode, disable_percent)
erb = factory.new(src, trim_mode: trim)
erb.filename = filename
if output
if number
erb.src.each_line.with_index do |line, l|
puts "%3d %s"%[l+1, line]
end
else
puts erb.src
end
else
bind = TOPLEVEL_BINDING
if variables
enc = erb.encoding
for var, val in variables do
val = val.encode(enc) if val
bind.local_variable_set(var, val)
end
end
erb.run(bind)
end
end
module_function :run
def set_encoding(extern, intern = nil)
verbose, $VERBOSE = $VERBOSE, nil
Encoding.default_external = extern unless extern.nil? || extern == ""
Encoding.default_internal = intern unless intern.nil? || intern == ""
[$stdin, $stdout, $stderr].each do |io|
io.set_encoding(extern, intern)
end
ensure
$VERBOSE = verbose
end
module_function :set_encoding
class << self; private :set_encoding; end
end
end
ERB::Main.run
share/gems/gems/io-console-0.7.1/lib/io/console/size.rb 0000644 00000000657 15173517751 0016406 0 ustar 00 # frozen_string_literal: false
# fallback to console window size
def IO.default_console_size
[
ENV["LINES"].to_i.nonzero? || 25,
ENV["COLUMNS"].to_i.nonzero? || 80,
]
end
begin
require 'io/console'
rescue LoadError
class << IO
alias console_size default_console_size
end
else
# returns console window size
def IO.console_size
console.winsize
rescue NoMethodError
default_console_size
end
end
share/gems/gems/psych-5.1.2/lib/psych/syntax_error.rb 0000644 00000001114 15173517751 0016314 0 ustar 00 # frozen_string_literal: true
require_relative 'exception'
module Psych
class SyntaxError < Psych::Exception
attr_reader :file, :line, :column, :offset, :problem, :context
def initialize file, line, col, offset, problem, context
err = [problem, context].compact.join ' '
filename = file || '<unknown>'
message = "(%s): %s at line %d column %d" % [filename, err, line, col]
@file = file
@line = line
@column = col
@offset = offset
@problem = problem
@context = context
super(message)
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/class_loader.rb 0000644 00000004012 15173517751 0016210 0 ustar 00 # frozen_string_literal: true
require_relative 'omap'
require_relative 'set'
module Psych
class ClassLoader # :nodoc:
BIG_DECIMAL = 'BigDecimal'
COMPLEX = 'Complex'
DATE = 'Date'
DATE_TIME = 'DateTime'
EXCEPTION = 'Exception'
OBJECT = 'Object'
PSYCH_OMAP = 'Psych::Omap'
PSYCH_SET = 'Psych::Set'
RANGE = 'Range'
RATIONAL = 'Rational'
REGEXP = 'Regexp'
STRUCT = 'Struct'
SYMBOL = 'Symbol'
def initialize
@cache = CACHE.dup
end
def load klassname
return nil if !klassname || klassname.empty?
find klassname
end
def symbolize sym
symbol
sym.to_sym
end
constants.each do |const|
konst = const_get const
class_eval <<~RUBY, __FILE__, __LINE__ + 1
def #{const.to_s.downcase}
load #{konst.inspect}
end
RUBY
end
private
def find klassname
@cache[klassname] ||= resolve(klassname)
end
def resolve klassname
name = klassname
retried = false
begin
path2class(name)
rescue ArgumentError, NameError => ex
unless retried
name = "Struct::#{name}"
retried = ex
retry
end
raise retried
end
end
CACHE = Hash[constants.map { |const|
val = const_get const
begin
[val, ::Object.const_get(val)]
rescue
nil
end
}.compact].freeze
class Restricted < ClassLoader
def initialize classes, symbols
@classes = classes
@symbols = symbols
super()
end
def symbolize sym
return super if @symbols.empty?
if @symbols.include? sym
super
else
raise DisallowedClass.new('load', 'Symbol')
end
end
private
def find klassname
if @classes.include? klassname
super
else
raise DisallowedClass.new('load', klassname)
end
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/exception.rb 0000644 00000001326 15173517751 0015560 0 ustar 00 # frozen_string_literal: true
module Psych
class Exception < RuntimeError
end
class BadAlias < Exception
end
# Subclasses `BadAlias` for backwards compatibility
class AliasesNotEnabled < BadAlias
def initialize
super "Alias parsing was not enabled. To enable it, pass `aliases: true` to `Psych::load` or `Psych::safe_load`."
end
end
# Subclasses `BadAlias` for backwards compatibility
class AnchorNotDefined < BadAlias
def initialize anchor_name
super "An alias referenced an unknown anchor: #{anchor_name}"
end
end
class DisallowedClass < Exception
def initialize action, klass_name
super "Tried to #{action} unspecified class: #{klass_name}"
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes/alias.rb 0000644 00000001013 15173517751 0015754 0 ustar 00 # frozen_string_literal: true
module Psych
module Nodes
###
# This class represents a {YAML Alias}[http://yaml.org/spec/1.1/#alias].
# It points to an +anchor+.
#
# A Psych::Nodes::Alias is a terminal node and may have no children.
class Alias < Psych::Nodes::Node
# The anchor this alias links to
attr_accessor :anchor
# Create a new Alias that points to an +anchor+
def initialize anchor
@anchor = anchor
end
def alias?; true; end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes/mapping.rb 0000644 00000003051 15173517751 0016322 0 ustar 00 # frozen_string_literal: true
module Psych
module Nodes
###
# This class represents a {YAML Mapping}[http://yaml.org/spec/1.1/#mapping].
#
# A Psych::Nodes::Mapping node may have 0 or more children, but must have
# an even number of children. Here are the valid children a
# Psych::Nodes::Mapping node may have:
#
# * Psych::Nodes::Sequence
# * Psych::Nodes::Mapping
# * Psych::Nodes::Scalar
# * Psych::Nodes::Alias
class Mapping < Psych::Nodes::Node
# Any Map Style
ANY = 0
# Block Map Style
BLOCK = 1
# Flow Map Style
FLOW = 2
# The optional anchor for this mapping
attr_accessor :anchor
# The optional tag for this mapping
attr_accessor :tag
# Is this an implicit mapping?
attr_accessor :implicit
# The style of this mapping
attr_accessor :style
###
# Create a new Psych::Nodes::Mapping object.
#
# +anchor+ is the anchor associated with the map or +nil+.
# +tag+ is the tag associated with the map or +nil+.
# +implicit+ is a boolean indicating whether or not the map was implicitly
# started.
# +style+ is an integer indicating the mapping style.
#
# == See Also
# See also Psych::Handler#start_mapping
def initialize anchor = nil, tag = nil, implicit = true, style = BLOCK
super()
@anchor = anchor
@tag = tag
@implicit = implicit
@style = style
end
def mapping?; true; end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes/scalar.rb 0000644 00000003204 15173517751 0016134 0 ustar 00 # frozen_string_literal: true
module Psych
module Nodes
###
# This class represents a {YAML Scalar}[http://yaml.org/spec/1.1/#id858081].
#
# This node type is a terminal node and should not have any children.
class Scalar < Psych::Nodes::Node
# Any style scalar, the emitter chooses
ANY = 0
# Plain scalar style
PLAIN = 1
# Single quoted style
SINGLE_QUOTED = 2
# Double quoted style
DOUBLE_QUOTED = 3
# Literal style
LITERAL = 4
# Folded style
FOLDED = 5
# The scalar value
attr_accessor :value
# The anchor value (if there is one)
attr_accessor :anchor
# The tag value (if there is one)
attr_accessor :tag
# Is this a plain scalar?
attr_accessor :plain
# Is this scalar quoted?
attr_accessor :quoted
# The style of this scalar
attr_accessor :style
###
# Create a new Psych::Nodes::Scalar object.
#
# +value+ is the string value of the scalar
# +anchor+ is an associated anchor or nil
# +tag+ is an associated tag or nil
# +plain+ is a boolean value
# +quoted+ is a boolean value
# +style+ is an integer indicating the string style
#
# == See Also
#
# See also Psych::Handler#scalar
def initialize value, anchor = nil, tag = nil, plain = true, quoted = false, style = ANY
@value = value
@anchor = anchor
@tag = tag
@plain = plain
@quoted = quoted
@style = style
end
def scalar?; true; end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes/node.rb 0000644 00000003651 15173517751 0015622 0 ustar 00 # frozen_string_literal: true
require 'stringio'
require_relative '../class_loader'
require_relative '../scalar_scanner'
module Psych
module Nodes
###
# The base class for any Node in a YAML parse tree. This class should
# never be instantiated.
class Node
include Enumerable
# The children of this node
attr_reader :children
# An associated tag
attr_reader :tag
# The line number where this node start
attr_accessor :start_line
# The column number where this node start
attr_accessor :start_column
# The line number where this node ends
attr_accessor :end_line
# The column number where this node ends
attr_accessor :end_column
# Create a new Psych::Nodes::Node
def initialize
@children = []
end
###
# Iterate over each node in the tree. Yields each node to +block+ depth
# first.
def each &block
return enum_for :each unless block_given?
Visitors::DepthFirst.new(block).accept self
end
###
# Convert this node to Ruby.
#
# See also Psych::Visitors::ToRuby
def to_ruby(symbolize_names: false, freeze: false, strict_integer: false)
Visitors::ToRuby.create(symbolize_names: symbolize_names, freeze: freeze, strict_integer: strict_integer).accept(self)
end
alias :transform :to_ruby
###
# Convert this node to YAML.
#
# See also Psych::Visitors::Emitter
def yaml io = nil, options = {}
real_io = io || StringIO.new(''.encode('utf-8'))
Visitors::Emitter.new(real_io, options).accept self
return real_io.string unless io
io
end
alias :to_yaml :yaml
def alias?; false; end
def document?; false; end
def mapping?; false; end
def scalar?; false; end
def sequence?; false; end
def stream?; false; end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes/sequence.rb 0000644 00000004041 15173517751 0016477 0 ustar 00 # frozen_string_literal: true
module Psych
module Nodes
###
# This class represents a
# {YAML sequence}[http://yaml.org/spec/1.1/#sequence/syntax].
#
# A YAML sequence is basically a list, and looks like this:
#
# %YAML 1.1
# ---
# - I am
# - a Sequence
#
# A YAML sequence may have an anchor like this:
#
# %YAML 1.1
# ---
# &A [
# "This sequence",
# "has an anchor"
# ]
#
# A YAML sequence may also have a tag like this:
#
# %YAML 1.1
# ---
# !!seq [
# "This sequence",
# "has a tag"
# ]
#
# This class represents a sequence in a YAML document. A
# Psych::Nodes::Sequence node may have 0 or more children. Valid children
# for this node are:
#
# * Psych::Nodes::Sequence
# * Psych::Nodes::Mapping
# * Psych::Nodes::Scalar
# * Psych::Nodes::Alias
class Sequence < Psych::Nodes::Node
# Any Styles, emitter chooses
ANY = 0
# Block style sequence
BLOCK = 1
# Flow style sequence
FLOW = 2
# The anchor for this sequence (if any)
attr_accessor :anchor
# The tag name for this sequence (if any)
attr_accessor :tag
# Is this sequence started implicitly?
attr_accessor :implicit
# The sequence style used
attr_accessor :style
###
# Create a new object representing a YAML sequence.
#
# +anchor+ is the anchor associated with the sequence or nil.
# +tag+ is the tag associated with the sequence or nil.
# +implicit+ a boolean indicating whether or not the sequence was
# implicitly started.
# +style+ is an integer indicating the list style.
#
# See Psych::Handler#start_sequence
def initialize anchor = nil, tag = nil, implicit = true, style = BLOCK
super()
@anchor = anchor
@tag = tag
@implicit = implicit
@style = style
end
def sequence?; true; end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes/document.rb 0000644 00000003501 15173517751 0016505 0 ustar 00 # frozen_string_literal: true
module Psych
module Nodes
###
# This represents a YAML Document. This node must be a child of
# Psych::Nodes::Stream. A Psych::Nodes::Document must have one child,
# and that child may be one of the following:
#
# * Psych::Nodes::Sequence
# * Psych::Nodes::Mapping
# * Psych::Nodes::Scalar
class Document < Psych::Nodes::Node
# The version of the YAML document
attr_accessor :version
# A list of tag directives for this document
attr_accessor :tag_directives
# Was this document implicitly created?
attr_accessor :implicit
# Is the end of the document implicit?
attr_accessor :implicit_end
###
# Create a new Psych::Nodes::Document object.
#
# +version+ is a list indicating the YAML version.
# +tags_directives+ is a list of tag directive declarations
# +implicit+ is a flag indicating whether the document will be implicitly
# started.
#
# == Example:
# This creates a YAML document object that represents a YAML 1.1 document
# with one tag directive, and has an implicit start:
#
# Psych::Nodes::Document.new(
# [1,1],
# [["!", "tag:tenderlovemaking.com,2009:"]],
# true
# )
#
# == See Also
# See also Psych::Handler#start_document
def initialize version = [], tag_directives = [], implicit = false
super()
@version = version
@tag_directives = tag_directives
@implicit = implicit
@implicit_end = true
end
###
# Returns the root node. A Document may only have one root node:
# http://yaml.org/spec/1.1/#id898031
def root
children.first
end
def document?; true; end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes/stream.rb 0000644 00000002001 15173517751 0016154 0 ustar 00 # frozen_string_literal: true
module Psych
module Nodes
###
# Represents a YAML stream. This is the root node for any YAML parse
# tree. This node must have one or more child nodes. The only valid
# child node for a Psych::Nodes::Stream node is Psych::Nodes::Document.
class Stream < Psych::Nodes::Node
# Encodings supported by Psych (and libyaml)
# Any encoding
ANY = Psych::Parser::ANY
# UTF-8 encoding
UTF8 = Psych::Parser::UTF8
# UTF-16LE encoding
UTF16LE = Psych::Parser::UTF16LE
# UTF-16BE encoding
UTF16BE = Psych::Parser::UTF16BE
# The encoding used for this stream
attr_accessor :encoding
###
# Create a new Psych::Nodes::Stream node with an +encoding+ that
# defaults to Psych::Nodes::Stream::UTF8.
#
# See also Psych::Handler#start_stream
def initialize encoding = UTF8
super()
@encoding = encoding
end
def stream?; true; end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/tree_builder.rb 0000644 00000006024 15173517751 0016227 0 ustar 00 # frozen_string_literal: true
require_relative 'handler'
module Psych
###
# This class works in conjunction with Psych::Parser to build an in-memory
# parse tree that represents a YAML document.
#
# == Example
#
# parser = Psych::Parser.new Psych::TreeBuilder.new
# parser.parse('--- foo')
# tree = parser.handler.root
#
# See Psych::Handler for documentation on the event methods used in this
# class.
class TreeBuilder < Psych::Handler
# Returns the root node for the built tree
attr_reader :root
# Create a new TreeBuilder instance
def initialize
@stack = []
@last = nil
@root = nil
@start_line = nil
@start_column = nil
@end_line = nil
@end_column = nil
end
def event_location(start_line, start_column, end_line, end_column)
@start_line = start_line
@start_column = start_column
@end_line = end_line
@end_column = end_column
end
%w{
Sequence
Mapping
}.each do |node|
class_eval <<~RUBY, __FILE__, __LINE__ + 1
def start_#{node.downcase}(anchor, tag, implicit, style)
n = Nodes::#{node}.new(anchor, tag, implicit, style)
set_start_location(n)
@last.children << n
push n
end
def end_#{node.downcase}
n = pop
set_end_location(n)
n
end
RUBY
end
###
# Handles start_document events with +version+, +tag_directives+,
# and +implicit+ styling.
#
# See Psych::Handler#start_document
def start_document version, tag_directives, implicit
n = Nodes::Document.new version, tag_directives, implicit
set_start_location(n)
@last.children << n
push n
end
###
# Handles end_document events with +version+, +tag_directives+,
# and +implicit+ styling.
#
# See Psych::Handler#start_document
def end_document implicit_end = !streaming?
@last.implicit_end = implicit_end
n = pop
set_end_location(n)
n
end
def start_stream encoding
@root = Nodes::Stream.new(encoding)
set_start_location(@root)
push @root
end
def end_stream
n = pop
set_end_location(n)
n
end
def scalar value, anchor, tag, plain, quoted, style
s = Nodes::Scalar.new(value,anchor,tag,plain,quoted,style)
set_location(s)
@last.children << s
s
end
def alias anchor
a = Nodes::Alias.new(anchor)
set_location(a)
@last.children << a
a
end
private
def push value
@stack.push value
@last = value
end
def pop
x = @stack.pop
@last = @stack.last
x
end
def set_location(node)
set_start_location(node)
set_end_location(node)
end
def set_start_location(node)
node.start_line = @start_line
node.start_column = @start_column
end
def set_end_location(node)
node.end_line = @end_line
node.end_column = @end_column
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/versions.rb 0000644 00000000273 15173517751 0015432 0 ustar 00 # frozen_string_literal: true
module Psych
# The version of Psych you are using
VERSION = '5.1.2'
if RUBY_ENGINE == 'jruby'
DEFAULT_SNAKEYAML_VERSION = '2.7'.freeze
end
end
share/gems/gems/psych-5.1.2/lib/psych/set.rb 0000644 00000000112 15173517751 0014345 0 ustar 00 # frozen_string_literal: true
module Psych
class Set < ::Hash
end
end
share/gems/gems/psych-5.1.2/lib/psych/scalar_scanner.rb 0000644 00000011277 15173517751 0016546 0 ustar 00 # frozen_string_literal: true
module Psych
###
# Scan scalars for built in types
class ScalarScanner
# Taken from http://yaml.org/type/timestamp.html
TIME = /^-?\d{4}-\d{1,2}-\d{1,2}(?:[Tt]|\s+)\d{1,2}:\d\d:\d\d(?:\.\d*)?(?:\s*(?:Z|[-+]\d{1,2}:?(?:\d\d)?))?$/
# Taken from http://yaml.org/type/float.html
# Base 60, [-+]inf and NaN are handled separately
FLOAT = /^(?:[-+]?([0-9][0-9_,]*)?\.[0-9]*([eE][-+][0-9]+)?(?# base 10))$/x
# Taken from http://yaml.org/type/int.html
INTEGER_STRICT = /^(?:[-+]?0b[0-1_]+ (?# base 2)
|[-+]?0[0-7_]+ (?# base 8)
|[-+]?(0|[1-9][0-9_]*) (?# base 10)
|[-+]?0x[0-9a-fA-F_]+ (?# base 16))$/x
# Same as above, but allows commas.
# Not to YML spec, but kept for backwards compatibility
INTEGER_LEGACY = /^(?:[-+]?0b[0-1_,]+ (?# base 2)
|[-+]?0[0-7_,]+ (?# base 8)
|[-+]?(?:0|[1-9](?:[0-9]|,[0-9]|_[0-9])*) (?# base 10)
|[-+]?0x[0-9a-fA-F_,]+ (?# base 16))$/x
attr_reader :class_loader
# Create a new scanner
def initialize class_loader, strict_integer: false
@symbol_cache = {}
@class_loader = class_loader
@strict_integer = strict_integer
end
# Tokenize +string+ returning the Ruby object
def tokenize string
return nil if string.empty?
return @symbol_cache[string] if @symbol_cache.key?(string)
integer_regex = @strict_integer ? INTEGER_STRICT : INTEGER_LEGACY
# Check for a String type, being careful not to get caught by hash keys, hex values, and
# special floats (e.g., -.inf).
if string.match?(%r{^[^\d.:-]?[[:alpha:]_\s!@#$%\^&*(){}<>|/\\~;=]+}) || string.match?(/\n/)
return string if string.length > 5
if string.match?(/^[^ytonf~]/i)
string
elsif string == '~' || string.match?(/^null$/i)
nil
elsif string.match?(/^(yes|true|on)$/i)
true
elsif string.match?(/^(no|false|off)$/i)
false
else
string
end
elsif string.match?(TIME)
begin
parse_time string
rescue ArgumentError
string
end
elsif string.match?(/^\d{4}-(?:1[012]|0\d|\d)-(?:[12]\d|3[01]|0\d|\d)$/)
require 'date'
begin
class_loader.date.strptime(string, '%F', Date::GREGORIAN)
rescue ArgumentError
string
end
elsif string.match?(/^\+?\.inf$/i)
Float::INFINITY
elsif string.match?(/^-\.inf$/i)
-Float::INFINITY
elsif string.match?(/^\.nan$/i)
Float::NAN
elsif string.match?(/^:./)
if string =~ /^:(["'])(.*)\1/
@symbol_cache[string] = class_loader.symbolize($2.sub(/^:/, ''))
else
@symbol_cache[string] = class_loader.symbolize(string.sub(/^:/, ''))
end
elsif string.match?(/^[-+]?[0-9][0-9_]*(:[0-5]?[0-9]){1,2}$/)
i = 0
string.split(':').each_with_index do |n,e|
i += (n.to_i * 60 ** (e - 2).abs)
end
i
elsif string.match?(/^[-+]?[0-9][0-9_]*(:[0-5]?[0-9]){1,2}\.[0-9_]*$/)
i = 0
string.split(':').each_with_index do |n,e|
i += (n.to_f * 60 ** (e - 2).abs)
end
i
elsif string.match?(FLOAT)
if string.match?(/\A[-+]?\.\Z/)
string
else
Float(string.delete(',_').gsub(/\.([Ee]|$)/, '\1'))
end
elsif string.match?(integer_regex)
parse_int string
else
string
end
end
###
# Parse and return an int from +string+
def parse_int string
Integer(string.delete(',_'))
end
###
# Parse and return a Time from +string+
def parse_time string
klass = class_loader.load 'Time'
date, time = *(string.split(/[ tT]/, 2))
(yy, m, dd) = date.match(/^(-?\d{4})-(\d{1,2})-(\d{1,2})/).captures.map { |x| x.to_i }
md = time.match(/(\d+:\d+:\d+)(?:\.(\d*))?\s*(Z|[-+]\d+(:\d\d)?)?/)
(hh, mm, ss) = md[1].split(':').map { |x| x.to_i }
us = (md[2] ? Rational("0.#{md[2]}") : 0) * 1000000
time = klass.utc(yy, m, dd, hh, mm, ss, us)
return time if 'Z' == md[3]
return klass.at(time.to_i, us) unless md[3]
tz = md[3].match(/^([+\-]?\d{1,2})\:?(\d{1,2})?$/)[1..-1].compact.map { |digit| Integer(digit, 10) }
offset = tz.first * 3600
if offset < 0
offset -= ((tz[1] || 0) * 60)
else
offset += ((tz[1] || 0) * 60)
end
klass.new(yy, m, dd, hh, mm, ss+us/(1_000_000r), offset)
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/json/yaml_events.rb 0000644 00000001413 15173517751 0017056 0 ustar 00 # frozen_string_literal: true
module Psych
module JSON
module YAMLEvents # :nodoc:
def start_document version, tag_directives, implicit
super(version, tag_directives, !streaming?)
end
def end_document implicit_end = !streaming?
super(implicit_end)
end
def start_mapping anchor, tag, implicit, style
super(anchor, nil, true, Nodes::Mapping::FLOW)
end
def start_sequence anchor, tag, implicit, style
super(anchor, nil, true, Nodes::Sequence::FLOW)
end
def scalar value, anchor, tag, plain, quoted, style
if "tag:yaml.org,2002:null" == tag
super('null', nil, nil, true, false, Nodes::Scalar::PLAIN)
else
super
end
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/json/tree_builder.rb 0000644 00000000543 15173517751 0017200 0 ustar 00 # frozen_string_literal: true
require_relative 'yaml_events'
module Psych
module JSON
###
# Psych::JSON::TreeBuilder is an event based AST builder. Events are sent
# to an instance of Psych::JSON::TreeBuilder and a JSON AST is constructed.
class TreeBuilder < Psych::TreeBuilder
include Psych::JSON::YAMLEvents
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/json/ruby_events.rb 0000644 00000000750 15173517751 0017100 0 ustar 00 # frozen_string_literal: true
module Psych
module JSON
module RubyEvents # :nodoc:
def visit_Time o
formatted = format_time o
@emitter.scalar formatted, nil, nil, false, true, Nodes::Scalar::DOUBLE_QUOTED
end
def visit_DateTime o
visit_Time o.to_time
end
def visit_String o
@emitter.scalar o.to_s, nil, nil, false, true, Nodes::Scalar::DOUBLE_QUOTED
end
alias :visit_Symbol :visit_String
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/json/stream.rb 0000644 00000000622 15173517751 0016024 0 ustar 00 # frozen_string_literal: true
require_relative 'ruby_events'
require_relative 'yaml_events'
module Psych
module JSON
class Stream < Psych::Visitors::JSONTree
include Psych::JSON::RubyEvents
include Psych::Streaming
extend Psych::Streaming::ClassMethods
class Emitter < Psych::Stream::Emitter # :nodoc:
include Psych::JSON::YAMLEvents
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/coder.rb 0000644 00000004062 15173517751 0014656 0 ustar 00 # frozen_string_literal: true
module Psych
###
# If an object defines +encode_with+, then an instance of Psych::Coder will
# be passed to the method when the object is being serialized. The Coder
# automatically assumes a Psych::Nodes::Mapping is being emitted. Other
# objects like Sequence and Scalar may be emitted if +seq=+ or +scalar=+ are
# called, respectively.
class Coder
attr_accessor :tag, :style, :implicit, :object
attr_reader :type, :seq
def initialize tag
@map = {}
@seq = []
@implicit = false
@type = :map
@tag = tag
@style = Psych::Nodes::Mapping::BLOCK
@scalar = nil
@object = nil
end
def scalar *args
if args.length > 0
warn "#{caller[0]}: Coder#scalar(a,b,c) is deprecated" if $VERBOSE
@tag, @scalar, _ = args
@type = :scalar
end
@scalar
end
# Emit a map. The coder will be yielded to the block.
def map tag = @tag, style = @style
@tag = tag
@style = style
yield self if block_given?
@map
end
# Emit a scalar with +value+ and +tag+
def represent_scalar tag, value
self.tag = tag
self.scalar = value
end
# Emit a sequence with +list+ and +tag+
def represent_seq tag, list
@tag = tag
self.seq = list
end
# Emit a sequence with +map+ and +tag+
def represent_map tag, map
@tag = tag
self.map = map
end
# Emit an arbitrary object +obj+ and +tag+
def represent_object tag, obj
@tag = tag
@type = :object
@object = obj
end
# Emit a scalar with +value+
def scalar= value
@type = :scalar
@scalar = value
end
# Emit a map with +value+
def map= map
@type = :map
@map = map
end
def []= k, v
@type = :map
@map[k] = v
end
alias :add :[]=
def [] k
@type = :map
@map[k]
end
# Emit a sequence of +list+
def seq= list
@type = :seq
@seq = list
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/core_ext.rb 0000644 00000000552 15173517751 0015372 0 ustar 00 # frozen_string_literal: true
class Object
def self.yaml_tag url
Psych.add_tag(url, self)
end
###
# call-seq: to_yaml(options = {})
#
# Convert an object to YAML. See Psych.dump for more information on the
# available +options+.
def to_yaml options = {}
Psych.dump self, options
end
end
if defined?(::IRB)
require_relative 'y'
end
share/gems/gems/psych-5.1.2/lib/psych/y.rb 0000644 00000000276 15173517751 0014035 0 ustar 00 # frozen_string_literal: true
module Kernel
###
# An alias for Psych.dump_stream meant to be used with IRB.
def y *objects
puts Psych.dump_stream(*objects)
end
private :y
end
share/gems/gems/psych-5.1.2/lib/psych/parser.rb 0000644 00000004034 15173517751 0015055 0 ustar 00 # frozen_string_literal: true
module Psych
###
# YAML event parser class. This class parses a YAML document and calls
# events on the handler that is passed to the constructor. The events can
# be used for things such as constructing a YAML AST or deserializing YAML
# documents. It can even be fed back to Psych::Emitter to emit the same
# document that was parsed.
#
# See Psych::Handler for documentation on the events that Psych::Parser emits.
#
# Here is an example that prints out ever scalar found in a YAML document:
#
# # Handler for detecting scalar values
# class ScalarHandler < Psych::Handler
# def scalar value, anchor, tag, plain, quoted, style
# puts value
# end
# end
#
# parser = Psych::Parser.new(ScalarHandler.new)
# parser.parse(yaml_document)
#
# Here is an example that feeds the parser back in to Psych::Emitter. The
# YAML document is read from STDIN and written back out to STDERR:
#
# parser = Psych::Parser.new(Psych::Emitter.new($stderr))
# parser.parse($stdin)
#
# Psych uses Psych::Parser in combination with Psych::TreeBuilder to
# construct an AST of the parsed YAML document.
class Parser
class Mark < Struct.new(:index, :line, :column)
end
# The handler on which events will be called
attr_accessor :handler
# Set the encoding for this parser to +encoding+
attr_writer :external_encoding
###
# Creates a new Psych::Parser instance with +handler+. YAML events will
# be called on +handler+. See Psych::Parser for more details.
def initialize handler = Handler.new
@handler = handler
@external_encoding = ANY
end
###
# call-seq:
# parser.parse(yaml)
#
# Parse the YAML document contained in +yaml+. Events will be called on
# the handler set on the parser instance.
#
# See Psych::Parser and Psych::Parser#handler
def parse yaml, path = yaml.respond_to?(:path) ? yaml.path : "<unknown>"
_native_parse @handler, yaml, path
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/visitors.rb 0000644 00000000376 15173517751 0015450 0 ustar 00 # frozen_string_literal: true
require_relative 'visitors/visitor'
require_relative 'visitors/to_ruby'
require_relative 'visitors/emitter'
require_relative 'visitors/yaml_tree'
require_relative 'visitors/json_tree'
require_relative 'visitors/depth_first'
share/gems/gems/psych-5.1.2/lib/psych/visitors/json_tree.rb 0000644 00000001121 15173517751 0017425 0 ustar 00 # frozen_string_literal: true
require_relative '../json/ruby_events'
module Psych
module Visitors
class JSONTree < YAMLTree
include Psych::JSON::RubyEvents
def self.create options = {}
emitter = Psych::JSON::TreeBuilder.new
class_loader = ClassLoader.new
ss = ScalarScanner.new class_loader
new(emitter, ss, options)
end
def accept target
if target.respond_to?(:encode_with)
dump_coder target
else
send(@dispatch_cache[target.class], target)
end
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/visitors/yaml_tree.rb 0000644 00000040374 15173517751 0017433 0 ustar 00 # frozen_string_literal: true
require_relative '../tree_builder'
require_relative '../scalar_scanner'
require_relative '../class_loader'
module Psych
module Visitors
###
# YAMLTree builds a YAML ast given a Ruby object. For example:
#
# builder = Psych::Visitors::YAMLTree.new
# builder << { :foo => 'bar' }
# builder.tree # => #<Psych::Nodes::Stream .. }
#
class YAMLTree < Psych::Visitors::Visitor
class Registrar # :nodoc:
def initialize
@obj_to_id = {}.compare_by_identity
@obj_to_node = {}.compare_by_identity
@targets = []
@counter = 0
end
def register target, node
@targets << target
@obj_to_node[target] = node
end
def key? target
@obj_to_node.key? target
rescue NoMethodError
false
end
def id_for target
@obj_to_id[target] ||= (@counter += 1)
end
def node_for target
@obj_to_node[target]
end
end
attr_reader :started, :finished
alias :finished? :finished
alias :started? :started
def self.create options = {}, emitter = nil
emitter ||= TreeBuilder.new
class_loader = ClassLoader.new
ss = ScalarScanner.new class_loader
new(emitter, ss, options)
end
def initialize emitter, ss, options
super()
@started = false
@finished = false
@emitter = emitter
@st = Registrar.new
@ss = ss
@options = options
@line_width = options[:line_width]
if @line_width && @line_width < 0
if @line_width == -1
# Treat -1 as unlimited line-width, same as libyaml does.
@line_width = nil
else
fail(ArgumentError, "Invalid line_width #{@line_width}, must be non-negative or -1 for unlimited.")
end
end
@coders = []
@dispatch_cache = Hash.new do |h,klass|
method = "visit_#{(klass.name || '').split('::').join('_')}"
method = respond_to?(method) ? method : h[klass.superclass]
raise(TypeError, "Can't dump #{target.class}") unless method
h[klass] = method
end.compare_by_identity
end
def start encoding = Nodes::Stream::UTF8
@emitter.start_stream(encoding).tap do
@started = true
end
end
def finish
@emitter.end_stream.tap do
@finished = true
end
end
def tree
finish unless finished?
@emitter.root
end
def push object
start unless started?
version = []
version = [1,1] if @options[:header]
case @options[:version]
when Array
version = @options[:version]
when String
version = @options[:version].split('.').map { |x| x.to_i }
else
version = [1,1]
end if @options.key? :version
@emitter.start_document version, [], false
accept object
@emitter.end_document !@emitter.streaming?
end
alias :<< :push
def accept target
# return any aliases we find
if @st.key? target
oid = @st.id_for target
node = @st.node_for target
anchor = oid.to_s
node.anchor = anchor
return @emitter.alias anchor
end
if target.respond_to?(:encode_with)
dump_coder target
else
send(@dispatch_cache[target.class], target)
end
end
def visit_Psych_Omap o
seq = @emitter.start_sequence(nil, 'tag:yaml.org,2002:omap', false, Nodes::Sequence::BLOCK)
register(o, seq)
o.each { |k,v| visit_Hash k => v }
@emitter.end_sequence
end
def visit_Encoding o
tag = "!ruby/encoding"
@emitter.scalar o.name, nil, tag, false, false, Nodes::Scalar::ANY
end
def visit_Object o
tag = Psych.dump_tags[o.class]
unless tag
klass = o.class == Object ? nil : o.class.name
tag = ['!ruby/object', klass].compact.join(':')
end
map = @emitter.start_mapping(nil, tag, false, Nodes::Mapping::BLOCK)
register(o, map)
dump_ivars o
@emitter.end_mapping
end
alias :visit_Delegator :visit_Object
def visit_Struct o
tag = ['!ruby/struct', o.class.name].compact.join(':')
register o, @emitter.start_mapping(nil, tag, false, Nodes::Mapping::BLOCK)
o.members.each do |member|
@emitter.scalar member.to_s, nil, nil, true, false, Nodes::Scalar::ANY
accept o[member]
end
dump_ivars o
@emitter.end_mapping
end
def visit_Exception o
dump_exception o, o.message.to_s
end
def visit_NameError o
dump_exception o, o.message.to_s
end
def visit_Regexp o
register o, @emitter.scalar(o.inspect, nil, '!ruby/regexp', false, false, Nodes::Scalar::ANY)
end
def visit_Date o
register o, visit_Integer(o.gregorian)
end
def visit_DateTime o
t = o.italy
formatted = format_time t, t.offset.zero?
tag = '!ruby/object:DateTime'
register o, @emitter.scalar(formatted, nil, tag, false, false, Nodes::Scalar::ANY)
end
def visit_Time o
formatted = format_time o
register o, @emitter.scalar(formatted, nil, nil, true, false, Nodes::Scalar::ANY)
end
def visit_Rational o
register o, @emitter.start_mapping(nil, '!ruby/object:Rational', false, Nodes::Mapping::BLOCK)
[
'denominator', o.denominator.to_s,
'numerator', o.numerator.to_s
].each do |m|
@emitter.scalar m, nil, nil, true, false, Nodes::Scalar::ANY
end
@emitter.end_mapping
end
def visit_Complex o
register o, @emitter.start_mapping(nil, '!ruby/object:Complex', false, Nodes::Mapping::BLOCK)
['real', o.real.to_s, 'image', o.imag.to_s].each do |m|
@emitter.scalar m, nil, nil, true, false, Nodes::Scalar::ANY
end
@emitter.end_mapping
end
def visit_Integer o
@emitter.scalar o.to_s, nil, nil, true, false, Nodes::Scalar::ANY
end
alias :visit_TrueClass :visit_Integer
alias :visit_FalseClass :visit_Integer
def visit_Float o
if o.nan?
@emitter.scalar '.nan', nil, nil, true, false, Nodes::Scalar::ANY
elsif o.infinite?
@emitter.scalar((o.infinite? > 0 ? '.inf' : '-.inf'),
nil, nil, true, false, Nodes::Scalar::ANY)
else
@emitter.scalar o.to_s, nil, nil, true, false, Nodes::Scalar::ANY
end
end
def visit_BigDecimal o
@emitter.scalar o._dump, nil, '!ruby/object:BigDecimal', false, false, Nodes::Scalar::ANY
end
def visit_String o
plain = true
quote = true
style = Nodes::Scalar::PLAIN
tag = nil
if binary?(o)
o = [o].pack('m0')
tag = '!binary' # FIXME: change to below when syck is removed
#tag = 'tag:yaml.org,2002:binary'
style = Nodes::Scalar::LITERAL
plain = false
quote = false
elsif o =~ /\n(?!\Z)/ # match \n except blank line at the end of string
style = Nodes::Scalar::LITERAL
elsif o == '<<'
style = Nodes::Scalar::SINGLE_QUOTED
tag = 'tag:yaml.org,2002:str'
plain = false
quote = false
elsif o == 'y' || o == 'n'
style = Nodes::Scalar::DOUBLE_QUOTED
elsif @line_width && o.length > @line_width
style = Nodes::Scalar::FOLDED
elsif o =~ /^[^[:word:]][^"]*$/
style = Nodes::Scalar::DOUBLE_QUOTED
elsif not String === @ss.tokenize(o) or /\A0[0-7]*[89]/ =~ o
style = Nodes::Scalar::SINGLE_QUOTED
end
is_primitive = o.class == ::String
ivars = is_primitive ? [] : o.instance_variables
if ivars.empty?
unless is_primitive
tag = "!ruby/string:#{o.class}"
plain = false
quote = false
end
@emitter.scalar o, nil, tag, plain, quote, style
else
maptag = '!ruby/string'.dup
maptag << ":#{o.class}" unless o.class == ::String
register o, @emitter.start_mapping(nil, maptag, false, Nodes::Mapping::BLOCK)
@emitter.scalar 'str', nil, nil, true, false, Nodes::Scalar::ANY
@emitter.scalar o, nil, tag, plain, quote, style
dump_ivars o
@emitter.end_mapping
end
end
def visit_Module o
raise TypeError, "can't dump anonymous module: #{o}" unless o.name
register o, @emitter.scalar(o.name, nil, '!ruby/module', false, false, Nodes::Scalar::SINGLE_QUOTED)
end
def visit_Class o
raise TypeError, "can't dump anonymous class: #{o}" unless o.name
register o, @emitter.scalar(o.name, nil, '!ruby/class', false, false, Nodes::Scalar::SINGLE_QUOTED)
end
def visit_Range o
register o, @emitter.start_mapping(nil, '!ruby/range', false, Nodes::Mapping::BLOCK)
['begin', o.begin, 'end', o.end, 'excl', o.exclude_end?].each do |m|
accept m
end
@emitter.end_mapping
end
def visit_Hash o
if o.class == ::Hash
register(o, @emitter.start_mapping(nil, nil, true, Psych::Nodes::Mapping::BLOCK))
o.each do |k,v|
accept k
accept v
end
@emitter.end_mapping
else
visit_hash_subclass o
end
end
def visit_Psych_Set o
register(o, @emitter.start_mapping(nil, '!set', false, Psych::Nodes::Mapping::BLOCK))
o.each do |k,v|
accept k
accept v
end
@emitter.end_mapping
end
def visit_Array o
if o.class == ::Array
visit_Enumerator o
else
visit_array_subclass o
end
end
def visit_Enumerator o
register o, @emitter.start_sequence(nil, nil, true, Nodes::Sequence::BLOCK)
o.each { |c| accept c }
@emitter.end_sequence
end
def visit_NilClass o
@emitter.scalar('', nil, 'tag:yaml.org,2002:null', true, false, Nodes::Scalar::ANY)
end
def visit_Symbol o
if o.empty?
@emitter.scalar "", nil, '!ruby/symbol', false, false, Nodes::Scalar::ANY
else
@emitter.scalar ":#{o}", nil, nil, true, false, Nodes::Scalar::ANY
end
end
def visit_BasicObject o
tag = Psych.dump_tags[o.class]
tag ||= "!ruby/marshalable:#{o.class.name}"
map = @emitter.start_mapping(nil, tag, false, Nodes::Mapping::BLOCK)
register(o, map)
o.marshal_dump.each(&method(:accept))
@emitter.end_mapping
end
private
def binary? string
string.encoding == Encoding::ASCII_8BIT && !string.ascii_only?
end
def visit_array_subclass o
tag = "!ruby/array:#{o.class}"
ivars = o.instance_variables
if ivars.empty?
node = @emitter.start_sequence(nil, tag, false, Nodes::Sequence::BLOCK)
register o, node
o.each { |c| accept c }
@emitter.end_sequence
else
node = @emitter.start_mapping(nil, tag, false, Nodes::Sequence::BLOCK)
register o, node
# Dump the internal list
accept 'internal'
@emitter.start_sequence(nil, nil, true, Nodes::Sequence::BLOCK)
o.each { |c| accept c }
@emitter.end_sequence
# Dump the ivars
accept 'ivars'
@emitter.start_mapping(nil, nil, true, Nodes::Sequence::BLOCK)
ivars.each do |ivar|
accept ivar
accept o.instance_variable_get ivar
end
@emitter.end_mapping
@emitter.end_mapping
end
end
def visit_hash_subclass o
ivars = o.instance_variables
if ivars.any?
tag = "!ruby/hash-with-ivars:#{o.class}"
node = @emitter.start_mapping(nil, tag, false, Psych::Nodes::Mapping::BLOCK)
register(o, node)
# Dump the ivars
accept 'ivars'
@emitter.start_mapping nil, nil, true, Nodes::Mapping::BLOCK
o.instance_variables.each do |ivar|
accept ivar
accept o.instance_variable_get ivar
end
@emitter.end_mapping
# Dump the elements
accept 'elements'
@emitter.start_mapping nil, nil, true, Nodes::Mapping::BLOCK
o.each do |k,v|
accept k
accept v
end
@emitter.end_mapping
@emitter.end_mapping
else
tag = "!ruby/hash:#{o.class}"
node = @emitter.start_mapping(nil, tag, false, Psych::Nodes::Mapping::BLOCK)
register(o, node)
o.each do |k,v|
accept k
accept v
end
@emitter.end_mapping
end
end
def dump_list o
end
def dump_exception o, msg
tag = ['!ruby/exception', o.class.name].join ':'
@emitter.start_mapping nil, tag, false, Nodes::Mapping::BLOCK
if msg
@emitter.scalar 'message', nil, nil, true, false, Nodes::Scalar::ANY
accept msg
end
@emitter.scalar 'backtrace', nil, nil, true, false, Nodes::Scalar::ANY
accept o.backtrace
dump_ivars o
@emitter.end_mapping
end
def format_time time, utc = time.utc?
if utc
time.strftime("%Y-%m-%d %H:%M:%S.%9N Z")
else
time.strftime("%Y-%m-%d %H:%M:%S.%9N %:z")
end
end
def register target, yaml_obj
@st.register target, yaml_obj
yaml_obj
end
def dump_coder o
@coders << o
tag = Psych.dump_tags[o.class]
unless tag
klass = o.class == Object ? nil : o.class.name
tag = ['!ruby/object', klass].compact.join(':')
end
c = Psych::Coder.new(tag)
o.encode_with(c)
emit_coder c, o
end
def emit_coder c, o
case c.type
when :scalar
@emitter.scalar c.scalar, nil, c.tag, c.tag.nil?, false, c.style
when :seq
@emitter.start_sequence nil, c.tag, c.tag.nil?, c.style
c.seq.each do |thing|
accept thing
end
@emitter.end_sequence
when :map
register o, @emitter.start_mapping(nil, c.tag, c.implicit, c.style)
c.map.each do |k,v|
accept k
accept v
end
@emitter.end_mapping
when :object
accept c.object
end
end
def dump_ivars target
target.instance_variables.each do |iv|
@emitter.scalar("#{iv.to_s.sub(/^@/, '')}", nil, nil, true, false, Nodes::Scalar::ANY)
accept target.instance_variable_get(iv)
end
end
end
class RestrictedYAMLTree < YAMLTree
DEFAULT_PERMITTED_CLASSES = {
TrueClass => true,
FalseClass => true,
NilClass => true,
Integer => true,
Float => true,
String => true,
Array => true,
Hash => true,
}.compare_by_identity.freeze
def initialize emitter, ss, options
super
@permitted_classes = DEFAULT_PERMITTED_CLASSES.dup
Array(options[:permitted_classes]).each do |klass|
@permitted_classes[klass] = true
end
@permitted_symbols = {}.compare_by_identity
Array(options[:permitted_symbols]).each do |symbol|
@permitted_symbols[symbol] = true
end
@aliases = options.fetch(:aliases, false)
end
def accept target
if !@aliases && @st.key?(target)
raise BadAlias, "Tried to dump an aliased object"
end
unless Symbol === target || @permitted_classes[target.class]
raise DisallowedClass.new('dump', target.class.name || target.class.inspect)
end
super
end
def visit_Symbol sym
unless @permitted_classes[Symbol] || @permitted_symbols[sym]
raise DisallowedClass.new('dump', "Symbol(#{sym.inspect})")
end
super
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/visitors/depth_first.rb 0000644 00000001162 15173517751 0017755 0 ustar 00 # frozen_string_literal: true
module Psych
module Visitors
class DepthFirst < Psych::Visitors::Visitor
def initialize block
@block = block
end
private
def nary o
o.children.each { |x| visit x }
@block.call o
end
alias :visit_Psych_Nodes_Stream :nary
alias :visit_Psych_Nodes_Document :nary
alias :visit_Psych_Nodes_Sequence :nary
alias :visit_Psych_Nodes_Mapping :nary
def terminal o
@block.call o
end
alias :visit_Psych_Nodes_Scalar :terminal
alias :visit_Psych_Nodes_Alias :terminal
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/visitors/visitor.rb 0000644 00000001276 15173517751 0017147 0 ustar 00 # frozen_string_literal: true
module Psych
module Visitors
class Visitor
def accept target
visit target
end
private
# @api private
def self.dispatch_cache
Hash.new do |hash, klass|
hash[klass] = :"visit_#{klass.name.gsub('::', '_')}"
end.compare_by_identity
end
if defined?(Ractor)
def dispatch
@dispatch_cache ||= (Ractor.current[:Psych_Visitors_Visitor] ||= Visitor.dispatch_cache)
end
else
DISPATCH = dispatch_cache
def dispatch
DISPATCH
end
end
def visit target
send dispatch[target.class], target
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/visitors/to_ruby.rb 0000644 00000030601 15173517751 0017125 0 ustar 00 # frozen_string_literal: true
require_relative '../scalar_scanner'
require_relative '../class_loader'
require_relative '../exception'
unless defined?(Regexp::NOENCODING)
Regexp::NOENCODING = 32
end
module Psych
module Visitors
###
# This class walks a YAML AST, converting each node to Ruby
class ToRuby < Psych::Visitors::Visitor
def self.create(symbolize_names: false, freeze: false, strict_integer: false)
class_loader = ClassLoader.new
scanner = ScalarScanner.new class_loader, strict_integer: strict_integer
new(scanner, class_loader, symbolize_names: symbolize_names, freeze: freeze)
end
attr_reader :class_loader
def initialize ss, class_loader, symbolize_names: false, freeze: false
super()
@st = {}
@ss = ss
@load_tags = Psych.load_tags
@domain_types = Psych.domain_types
@class_loader = class_loader
@symbolize_names = symbolize_names
@freeze = freeze
end
def accept target
result = super
unless @domain_types.empty? || !target.tag
key = target.tag.sub(/^[!\/]*/, '').sub(/(,\d+)\//, '\1:')
key = "tag:#{key}" unless key =~ /^(?:tag:|x-private)/
if @domain_types.key? key
value, block = @domain_types[key]
result = block.call value, result
end
end
result = deduplicate(result).freeze if @freeze
result
end
def deserialize o
if klass = resolve_class(@load_tags[o.tag])
instance = klass.allocate
if instance.respond_to?(:init_with)
coder = Psych::Coder.new(o.tag)
coder.scalar = o.value
instance.init_with coder
end
return instance
end
return o.value if o.quoted
return @ss.tokenize(o.value) unless o.tag
case o.tag
when '!binary', 'tag:yaml.org,2002:binary'
o.value.unpack('m').first
when /^!(?:str|ruby\/string)(?::(.*))?$/, 'tag:yaml.org,2002:str'
klass = resolve_class($1)
if klass
klass.allocate.replace o.value
else
o.value
end
when '!ruby/object:BigDecimal'
require 'bigdecimal' unless defined? BigDecimal
class_loader.big_decimal._load o.value
when "!ruby/object:DateTime"
class_loader.date_time
require 'date' unless defined? DateTime
t = @ss.parse_time(o.value)
DateTime.civil(*t.to_a[0, 6].reverse, Rational(t.utc_offset, 86400)) +
(t.subsec/86400)
when '!ruby/encoding'
::Encoding.find o.value
when "!ruby/object:Complex"
class_loader.complex
Complex(o.value)
when "!ruby/object:Rational"
class_loader.rational
Rational(o.value)
when "!ruby/class", "!ruby/module"
resolve_class o.value
when "tag:yaml.org,2002:float", "!float"
Float(@ss.tokenize(o.value))
when "!ruby/regexp"
klass = class_loader.regexp
o.value =~ /^\/(.*)\/([mixn]*)$/m
source = $1
options = 0
lang = nil
$2&.each_char do |option|
case option
when 'x' then options |= Regexp::EXTENDED
when 'i' then options |= Regexp::IGNORECASE
when 'm' then options |= Regexp::MULTILINE
when 'n' then options |= Regexp::NOENCODING
else lang = option
end
end
klass.new(*[source, options, lang].compact)
when "!ruby/range"
klass = class_loader.range
args = o.value.split(/([.]{2,3})/, 2).map { |s|
accept Nodes::Scalar.new(s)
}
args.push(args.delete_at(1) == '...')
klass.new(*args)
when /^!ruby\/sym(bol)?:?(.*)?$/
class_loader.symbolize o.value
else
@ss.tokenize o.value
end
end
private :deserialize
def visit_Psych_Nodes_Scalar o
register o, deserialize(o)
end
def visit_Psych_Nodes_Sequence o
if klass = resolve_class(@load_tags[o.tag])
instance = klass.allocate
if instance.respond_to?(:init_with)
coder = Psych::Coder.new(o.tag)
coder.seq = o.children.map { |c| accept c }
instance.init_with coder
end
return instance
end
case o.tag
when nil
register_empty(o)
when '!omap', 'tag:yaml.org,2002:omap'
map = register(o, Psych::Omap.new)
o.children.each { |a|
map[accept(a.children.first)] = accept a.children.last
}
map
when /^!(?:seq|ruby\/array):(.*)$/
klass = resolve_class($1)
list = register(o, klass.allocate)
o.children.each { |c| list.push accept c }
list
else
register_empty(o)
end
end
def visit_Psych_Nodes_Mapping o
if @load_tags[o.tag]
return revive(resolve_class(@load_tags[o.tag]), o)
end
return revive_hash(register(o, {}), o) unless o.tag
case o.tag
when /^!ruby\/struct:?(.*)?$/
klass = resolve_class($1) if $1
if klass
s = register(o, klass.allocate)
members = {}
struct_members = s.members.map { |x| class_loader.symbolize x }
o.children.each_slice(2) do |k,v|
member = accept(k)
value = accept(v)
if struct_members.include?(class_loader.symbolize(member))
s.send("#{member}=", value)
else
members[member.to_s.sub(/^@/, '')] = value
end
end
init_with(s, members, o)
else
klass = class_loader.struct
members = o.children.map { |c| accept c }
h = Hash[*members]
s = klass.new(*h.map { |k,v|
class_loader.symbolize k
}).new(*h.map { |k,v| v })
register(o, s)
s
end
when /^!ruby\/object:?(.*)?$/
name = $1 || 'Object'
if name == 'Complex'
class_loader.complex
h = Hash[*o.children.map { |c| accept c }]
register o, Complex(h['real'], h['image'])
elsif name == 'Rational'
class_loader.rational
h = Hash[*o.children.map { |c| accept c }]
register o, Rational(h['numerator'], h['denominator'])
elsif name == 'Hash'
revive_hash(register(o, {}), o)
else
obj = revive((resolve_class(name) || class_loader.object), o)
obj
end
when /^!(?:str|ruby\/string)(?::(.*))?$/, 'tag:yaml.org,2002:str'
klass = resolve_class($1)
members = {}
string = nil
o.children.each_slice(2) do |k,v|
key = accept k
value = accept v
if key == 'str'
if klass
string = klass.allocate.replace value
else
string = value
end
register(o, string)
else
members[key] = value
end
end
init_with(string, members.map { |k,v| [k.to_s.sub(/^@/, ''),v] }, o)
when /^!ruby\/array:(.*)$/
klass = resolve_class($1)
list = register(o, klass.allocate)
members = Hash[o.children.map { |c| accept c }.each_slice(2).to_a]
list.replace members['internal']
members['ivars'].each do |ivar, v|
list.instance_variable_set ivar, v
end
list
when '!ruby/range'
klass = class_loader.range
h = Hash[*o.children.map { |c| accept c }]
register o, klass.new(h['begin'], h['end'], h['excl'])
when /^!ruby\/exception:?(.*)?$/
h = Hash[*o.children.map { |c| accept c }]
e = build_exception((resolve_class($1) || class_loader.exception),
h.delete('message'))
e.set_backtrace h.delete('backtrace') if h.key? 'backtrace'
init_with(e, h, o)
when '!set', 'tag:yaml.org,2002:set'
set = class_loader.psych_set.new
@st[o.anchor] = set if o.anchor
o.children.each_slice(2) do |k,v|
set[accept(k)] = accept(v)
end
set
when /^!ruby\/hash-with-ivars(?::(.*))?$/
hash = $1 ? resolve_class($1).allocate : {}
register o, hash
o.children.each_slice(2) do |key, value|
case key.value
when 'elements'
revive_hash hash, value
when 'ivars'
value.children.each_slice(2) do |k,v|
hash.instance_variable_set accept(k), accept(v)
end
end
end
hash
when /^!map:(.*)$/, /^!ruby\/hash:(.*)$/
revive_hash register(o, resolve_class($1).allocate), o
when '!omap', 'tag:yaml.org,2002:omap'
map = register(o, class_loader.psych_omap.new)
o.children.each_slice(2) do |l,r|
map[accept(l)] = accept r
end
map
when /^!ruby\/marshalable:(.*)$/
name = $1
klass = resolve_class(name)
obj = register(o, klass.allocate)
if obj.respond_to?(:init_with)
init_with(obj, revive_hash({}, o), o)
elsif obj.respond_to?(:marshal_load)
marshal_data = o.children.map(&method(:accept))
obj.marshal_load(marshal_data)
obj
else
raise ArgumentError, "Cannot deserialize #{name}"
end
else
revive_hash(register(o, {}), o)
end
end
def visit_Psych_Nodes_Document o
accept o.root
end
def visit_Psych_Nodes_Stream o
o.children.map { |c| accept c }
end
def visit_Psych_Nodes_Alias o
@st.fetch(o.anchor) { raise AnchorNotDefined, o.anchor }
end
private
def register node, object
@st[node.anchor] = object if node.anchor
object
end
def register_empty object
list = register(object, [])
object.children.each { |c| list.push accept c }
list
end
def revive_hash hash, o, tagged= false
o.children.each_slice(2) { |k,v|
key = accept(k)
val = accept(v)
if key == '<<' && k.tag != "tag:yaml.org,2002:str"
case v
when Nodes::Alias, Nodes::Mapping
begin
hash.merge! val
rescue TypeError
hash[key] = val
end
when Nodes::Sequence
begin
h = {}
val.reverse_each do |value|
h.merge! value
end
hash.merge! h
rescue TypeError
hash[key] = val
end
else
hash[key] = val
end
else
if !tagged && @symbolize_names && key.is_a?(String)
key = key.to_sym
elsif !@freeze
key = deduplicate(key)
end
hash[key] = val
end
}
hash
end
if RUBY_VERSION < '2.7'
def deduplicate key
if key.is_a?(String)
# It is important to untaint the string, otherwise it won't
# be deduplicated into an fstring, but simply frozen.
-(key.untaint)
else
key
end
end
else
def deduplicate key
if key.is_a?(String)
-key
else
key
end
end
end
def merge_key hash, key, val
end
def revive klass, node
s = register(node, klass.allocate)
init_with(s, revive_hash({}, node, true), node)
end
def init_with o, h, node
c = Psych::Coder.new(node.tag)
c.map = h
if o.respond_to?(:init_with)
o.init_with c
else
h.each { |k,v| o.instance_variable_set(:"@#{k}", v) }
end
o
end
# Convert +klassname+ to a Class
def resolve_class klassname
class_loader.load klassname
end
end
class NoAliasRuby < ToRuby
def visit_Psych_Nodes_Alias o
raise AliasesNotEnabled
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/visitors/emitter.rb 0000644 00000002712 15173517751 0017115 0 ustar 00 # frozen_string_literal: true
module Psych
module Visitors
class Emitter < Psych::Visitors::Visitor
def initialize io, options = {}
opts = [:indentation, :canonical, :line_width].find_all { |opt|
options.key?(opt)
}
if opts.empty?
@handler = Psych::Emitter.new io
else
du = Handler::DumperOptions.new
opts.each { |option| du.send :"#{option}=", options[option] }
@handler = Psych::Emitter.new io, du
end
end
def visit_Psych_Nodes_Stream o
@handler.start_stream o.encoding
o.children.each { |c| accept c }
@handler.end_stream
end
def visit_Psych_Nodes_Document o
@handler.start_document o.version, o.tag_directives, o.implicit
o.children.each { |c| accept c }
@handler.end_document o.implicit_end
end
def visit_Psych_Nodes_Scalar o
@handler.scalar o.value, o.anchor, o.tag, o.plain, o.quoted, o.style
end
def visit_Psych_Nodes_Sequence o
@handler.start_sequence o.anchor, o.tag, o.implicit, o.style
o.children.each { |c| accept c }
@handler.end_sequence
end
def visit_Psych_Nodes_Mapping o
@handler.start_mapping o.anchor, o.tag, o.implicit, o.style
o.children.each { |c| accept c }
@handler.end_mapping
end
def visit_Psych_Nodes_Alias o
@handler.alias o.anchor
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/handlers/recorder.rb 0000644 00000001573 15173517751 0017173 0 ustar 00 # frozen_string_literal: true
require_relative '../handler'
module Psych
module Handlers
###
# This handler will capture an event and record the event. Recorder events
# are available vial Psych::Handlers::Recorder#events.
#
# For example:
#
# recorder = Psych::Handlers::Recorder.new
# parser = Psych::Parser.new recorder
# parser.parse '--- foo'
#
# recorder.events # => [list of events]
#
# # Replay the events
#
# emitter = Psych::Emitter.new $stdout
# recorder.events.each do |m, args|
# emitter.send m, *args
# end
class Recorder < Psych::Handler
attr_reader :events
def initialize
@events = []
super
end
EVENTS.each do |event|
define_method event do |*args|
@events << [event, args]
end
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/handlers/document_stream.rb 0000644 00000001014 15173517751 0020545 0 ustar 00 # frozen_string_literal: true
require_relative '../tree_builder'
module Psych
module Handlers
class DocumentStream < Psych::TreeBuilder # :nodoc:
def initialize &block
super
@block = block
end
def start_document version, tag_directives, implicit
n = Nodes::Document.new version, tag_directives, implicit
push n
end
def end_document implicit_end = !streaming?
@last.implicit_end = implicit_end
@block.call pop
end
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/nodes.rb 0000644 00000004600 15173517751 0014670 0 ustar 00 # frozen_string_literal: true
require_relative 'nodes/node'
require_relative 'nodes/stream'
require_relative 'nodes/document'
require_relative 'nodes/sequence'
require_relative 'nodes/scalar'
require_relative 'nodes/mapping'
require_relative 'nodes/alias'
module Psych
###
# = Overview
#
# When using Psych.load to deserialize a YAML document, the document is
# translated to an intermediary AST. That intermediary AST is then
# translated in to a Ruby object graph.
#
# In the opposite direction, when using Psych.dump, the Ruby object graph is
# translated to an intermediary AST which is then converted to a YAML
# document.
#
# Psych::Nodes contains all of the classes that make up the nodes of a YAML
# AST. You can manually build an AST and use one of the visitors (see
# Psych::Visitors) to convert that AST to either a YAML document or to a
# Ruby object graph.
#
# Here is an example of building an AST that represents a list with one
# scalar:
#
# # Create our nodes
# stream = Psych::Nodes::Stream.new
# doc = Psych::Nodes::Document.new
# seq = Psych::Nodes::Sequence.new
# scalar = Psych::Nodes::Scalar.new('foo')
#
# # Build up our tree
# stream.children << doc
# doc.children << seq
# seq.children << scalar
#
# The stream is the root of the tree. We can then convert the tree to YAML:
#
# stream.to_yaml => "---\n- foo\n"
#
# Or convert it to Ruby:
#
# stream.to_ruby => [["foo"]]
#
# == YAML AST Requirements
#
# A valid YAML AST *must* have one Psych::Nodes::Stream at the root. A
# Psych::Nodes::Stream node must have 1 or more Psych::Nodes::Document nodes
# as children.
#
# Psych::Nodes::Document nodes must have one and *only* one child. That child
# may be one of:
#
# * Psych::Nodes::Sequence
# * Psych::Nodes::Mapping
# * Psych::Nodes::Scalar
#
# Psych::Nodes::Sequence and Psych::Nodes::Mapping nodes may have many
# children, but Psych::Nodes::Mapping nodes should have an even number of
# children.
#
# All of these are valid children for Psych::Nodes::Sequence and
# Psych::Nodes::Mapping nodes:
#
# * Psych::Nodes::Sequence
# * Psych::Nodes::Mapping
# * Psych::Nodes::Scalar
# * Psych::Nodes::Alias
#
# Psych::Nodes::Scalar and Psych::Nodes::Alias are both terminal nodes and
# should not have any children.
module Nodes
end
end
share/gems/gems/psych-5.1.2/lib/psych/stream.rb 0000644 00000001633 15173517751 0015056 0 ustar 00 # frozen_string_literal: true
module Psych
###
# Psych::Stream is a streaming YAML emitter. It will not buffer your YAML,
# but send it straight to an IO.
#
# Here is an example use:
#
# stream = Psych::Stream.new($stdout)
# stream.start
# stream.push({:foo => 'bar'})
# stream.finish
#
# YAML will be immediately emitted to $stdout with no buffering.
#
# Psych::Stream#start will take a block and ensure that Psych::Stream#finish
# is called, so you can do this form:
#
# stream = Psych::Stream.new($stdout)
# stream.start do |em|
# em.push(:foo => 'bar')
# end
#
class Stream < Psych::Visitors::YAMLTree
class Emitter < Psych::Emitter # :nodoc:
def end_document implicit_end = !streaming?
super
end
def streaming?
true
end
end
include Psych::Streaming
extend Psych::Streaming::ClassMethods
end
end
share/gems/gems/psych-5.1.2/lib/psych/handler.rb 0000644 00000016311 15173517751 0015177 0 ustar 00 # frozen_string_literal: true
module Psych
###
# Psych::Handler is an abstract base class that defines the events used
# when dealing with Psych::Parser. Clients who want to use Psych::Parser
# should implement a class that inherits from Psych::Handler and define
# events that they can handle.
#
# Psych::Handler defines all events that Psych::Parser can possibly send to
# event handlers.
#
# See Psych::Parser for more details
class Handler
###
# Configuration options for dumping YAML.
class DumperOptions
attr_accessor :line_width, :indentation, :canonical
def initialize
@line_width = 0
@indentation = 2
@canonical = false
end
end
# Default dumping options
OPTIONS = DumperOptions.new
# Events that a Handler should respond to.
EVENTS = [ :alias,
:empty,
:end_document,
:end_mapping,
:end_sequence,
:end_stream,
:scalar,
:start_document,
:start_mapping,
:start_sequence,
:start_stream ]
###
# Called with +encoding+ when the YAML stream starts. This method is
# called once per stream. A stream may contain multiple documents.
#
# See the constants in Psych::Parser for the possible values of +encoding+.
def start_stream encoding
end
###
# Called when the document starts with the declared +version+,
# +tag_directives+, if the document is +implicit+.
#
# +version+ will be an array of integers indicating the YAML version being
# dealt with, +tag_directives+ is a list of tuples indicating the prefix
# and suffix of each tag, and +implicit+ is a boolean indicating whether
# the document is started implicitly.
#
# === Example
#
# Given the following YAML:
#
# %YAML 1.1
# %TAG ! tag:tenderlovemaking.com,2009:
# --- !squee
#
# The parameters for start_document must be this:
#
# version # => [1, 1]
# tag_directives # => [["!", "tag:tenderlovemaking.com,2009:"]]
# implicit # => false
def start_document version, tag_directives, implicit
end
###
# Called with the document ends. +implicit+ is a boolean value indicating
# whether or not the document has an implicit ending.
#
# === Example
#
# Given the following YAML:
#
# ---
# hello world
#
# +implicit+ will be true. Given this YAML:
#
# ---
# hello world
# ...
#
# +implicit+ will be false.
def end_document implicit
end
###
# Called when an alias is found to +anchor+. +anchor+ will be the name
# of the anchor found.
#
# === Example
#
# Here we have an example of an array that references itself in YAML:
#
# --- &ponies
# - first element
# - *ponies
#
# &ponies is the anchor, *ponies is the alias. In this case, alias is
# called with "ponies".
def alias anchor
end
###
# Called when a scalar +value+ is found. The scalar may have an
# +anchor+, a +tag+, be implicitly +plain+ or implicitly +quoted+
#
# +value+ is the string value of the scalar
# +anchor+ is an associated anchor or nil
# +tag+ is an associated tag or nil
# +plain+ is a boolean value
# +quoted+ is a boolean value
# +style+ is an integer indicating the string style
#
# See the constants in Psych::Nodes::Scalar for the possible values of
# +style+
#
# === Example
#
# Here is a YAML document that exercises most of the possible ways this
# method can be called:
#
# ---
# - !str "foo"
# - &anchor fun
# - many
# lines
# - |
# many
# newlines
#
# The above YAML document contains a list with four strings. Here are
# the parameters sent to this method in the same order:
#
# # value anchor tag plain quoted style
# ["foo", nil, "!str", false, false, 3 ]
# ["fun", "anchor", nil, true, false, 1 ]
# ["many lines", nil, nil, true, false, 1 ]
# ["many\nnewlines\n", nil, nil, false, true, 4 ]
#
def scalar value, anchor, tag, plain, quoted, style
end
###
# Called when a sequence is started.
#
# +anchor+ is the anchor associated with the sequence or nil.
# +tag+ is the tag associated with the sequence or nil.
# +implicit+ a boolean indicating whether or not the sequence was implicitly
# started.
# +style+ is an integer indicating the list style.
#
# See the constants in Psych::Nodes::Sequence for the possible values of
# +style+.
#
# === Example
#
# Here is a YAML document that exercises most of the possible ways this
# method can be called:
#
# ---
# - !!seq [
# a
# ]
# - &pewpew
# - b
#
# The above YAML document consists of three lists, an outer list that
# contains two inner lists. Here is a matrix of the parameters sent
# to represent these lists:
#
# # anchor tag implicit style
# [nil, nil, true, 1 ]
# [nil, "tag:yaml.org,2002:seq", false, 2 ]
# ["pewpew", nil, true, 1 ]
def start_sequence anchor, tag, implicit, style
end
###
# Called when a sequence ends.
def end_sequence
end
###
# Called when a map starts.
#
# +anchor+ is the anchor associated with the map or +nil+.
# +tag+ is the tag associated with the map or +nil+.
# +implicit+ is a boolean indicating whether or not the map was implicitly
# started.
# +style+ is an integer indicating the mapping style.
#
# See the constants in Psych::Nodes::Mapping for the possible values of
# +style+.
#
# === Example
#
# Here is a YAML document that exercises most of the possible ways this
# method can be called:
#
# ---
# k: !!map { hello: world }
# v: &pewpew
# hello: world
#
# The above YAML document consists of three maps, an outer map that contains
# two inner maps. Below is a matrix of the parameters sent in order to
# represent these three maps:
#
# # anchor tag implicit style
# [nil, nil, true, 1 ]
# [nil, "tag:yaml.org,2002:map", false, 2 ]
# ["pewpew", nil, true, 1 ]
def start_mapping anchor, tag, implicit, style
end
###
# Called when a map ends
def end_mapping
end
###
# Called when an empty event happens. (Which, as far as I can tell, is
# never).
def empty
end
###
# Called when the YAML stream ends
def end_stream
end
###
# Called before each event with line/column information.
def event_location(start_line, start_column, end_line, end_column)
end
###
# Is this handler a streaming handler?
def streaming?
false
end
end
end
share/gems/gems/psych-5.1.2/lib/psych/omap.rb 0000644 00000000113 15173517751 0014507 0 ustar 00 # frozen_string_literal: true
module Psych
class Omap < ::Hash
end
end
share/gems/gems/psych-5.1.2/lib/psych/streaming.rb 0000644 00000001233 15173517751 0015550 0 ustar 00 # frozen_string_literal: true
module Psych
module Streaming
module ClassMethods
###
# Create a new streaming emitter. Emitter will print to +io+. See
# Psych::Stream for an example.
def new io
emitter = const_get(:Emitter).new(io)
class_loader = ClassLoader.new
ss = ScalarScanner.new class_loader
super(emitter, ss, {})
end
end
###
# Start streaming using +encoding+
def start encoding = Nodes::Stream::UTF8
super.tap { yield self if block_given? }
ensure
finish if block_given?
end
private
def register target, obj
end
end
end
share/gems/gems/ruby-lsapi-5.6/README 0000644 00000012661 15173517751 0013033 0 ustar 00
lsapi - LSAPI extension for Ruby
================================
INSTALL
-------
$ ruby setup.rb config
$ ruby setup.rb setup
# ruby setup.rb install
USAGE
-----
General CGI scripts
^^^^^^^^^^^^^^^^^^^
The most efficient way to use LSAPI interface is to modify your CGI scripts.
You need to add the following code to your CGI scripts:
require 'lsapi'
while LSAPI.accept != nil
<your CGI script>
...
end
There is no need to change the way that how CGI environment variables
are being accessed in your scripts.
You can find some examples under examples/ folder.
Ruby Script Runner
^^^^^^^^^^^^^^^^^^
If you don't want to change your existing Ruby CGI code, you can use our
Ruby script runner under scripts/ folder. You need to configure
lsruby_runner.rb as a LSAPI application, then add a script handler
for "rb" suffix.
Rails dispatcher
^^^^^^^^^^^^^^^^
With Ruby LSAPI, we proudly provide a optimum platform for Rails application
deployment. Ruby LSAPI has the following advantages over other solutions.
* Easy configuration, deploy a Rails application only take a few clicks
with our Rails easy configuration
* Fast startup, the expensive Rails framework initialization only takes
place once when multiple processes need to be started
* Resource efficience, ruby processes can be started on demand, idle
process will be stop.
To use LSAPI with Ruby on Rails, please check out our toturial
http://www.litespeedtech.com/support/wiki/doku.php
There are a few environment variables that can be tweaked to tune ruby
LSAPI process.
* LSAPI_CHILDREN (default: 0)
LSAPI_CHILDREN controls the maximum number of children processes can be
started by the first ruby process started by web server. When set to <=1,
the first ruby process will handle request by itself, without starting any
child process. When LSAPI_CHILDREN is >1, the LSAPI application is stared in
"Self Managed Mode", which will start children processes based on demand.
With Rails easy configuration, LSAPI_CHILDREN is set to the value of
"Max Connections" by web server, no need to set it explicitly.
Usually, there is no need to set value of LSAPI_CHILDREN over 100 in most
server environment.
* LSAPI_AVOID_FORK (default: 0)
LSAPI_AVOID_FORK specifies the policy of the internal process manager in
"Self Managed Mode". When set to 0, the internal process manager will stop
and start children process on demand to save system resource. This is
preferred in a shared hosting environment. When set to 1, the internal
process manager will try to avoid freqently stopping and starting children
process. This might be preferred in a dedicate hosting environment.
* LSAPI_EXTRA_CHILDREN (default: 1/3 of LSAPI_CHILDREN or 0)
LSAPI_EXTRA_CHILDREN controls the maximum number of extra children processes
can be started when some or all existing children processes are in
malfunctioning state. Total number of children processes will be reduced to
LSAPI_CHILDREN level as soon as service is back to normal.
When LSAPI_AVOID_FORK is set to 0, the default value is 1/3 of
LSAPI_CHIDLREN, When LSAPI_AVOID_FORK is set to 1, the default value is 0.
* LSAPI_MAX_REQS (default value: 10000)
LSAPI_MAX_REQS specifies the maximum number of requests each child
process will handle before it exits automatically. This parameter can
help reducing memory usage when there are memory leaks in the application.
* LSAPI_MAX_IDLE (default value: 300 seconds)
In Self Managed Mode, LSAPI_MAX_IDLE controls how long a idle child
process will wait for a new request before exit. This option help
releasing system resources taken by idle processes.
* LSAPI_MAX_IDLE_CHILDREN
(default value: 1/3 of LSAPI_CHILDREN or LSAPI_CHILDREN)
In Self Managed Mode, LSAI_MAX_IDLE_CHILDREN controls how many idle
children processes are allowed. Excessive idle children processes
will be killed by the parent process.
When LSAPI_AVOID_FORK is set to 0, the default value is 1/3 of
LSAPI_CHIDLREN, When LSAPI_AVOID_FORK is set to 1, the default value
is LSAPI_CHILDREN.
* LSAPI_MAX_PROCESS_TIME (default value: 300 seconds)
In Self Managed Mode, LSAPI_MAX_PROCESS_TIME controls the maximum
processing time allowed when processing a request. If a child process
can not finish processing of a request in the given time period, it
will be killed by the parent process. This option can help getting rid
of dead or runaway child process.
* LSAPI_PGRP_MAX_IDLE (default value: FOREVER )
In Self Managed Mode, LSAPI_PGRP_MAX_IDLE controls how long the parent
process will wait before exiting when there is no child process.
This option help releasing system resources taken by an idle parent
process.
* LSAPI_PPID_NO_CHECK
By default a LSAPI application check the existence of its parent process
and exits automatically if the parent process died. This is to reduce
orphan process when web server is restarted. However, it is desireable
to disable this feature, such as when a LSAPI process was started
manually from command line. LSAPI_PPID_NO_CHECK should be set when
you want to disable the checking of existence of parent process.
License
-------
LSAPI library code is under BSD license
LSAPI ruby extension code is under Ruby license
* ((<URL:http://www.ruby-lang.org/ja/LICENSE.txt>)) (Japanese)
* ((<URL:http://www.ruby-lang.org/en/LICENSE.txt>)) (English)
Copyright
---------
Copyright (C) 2006 Lite Speed Technologies Inc.
share/gems/gems/ruby-lsapi-5.6/ext/lsapi/extconf.rb 0000644 00000000374 15173517751 0016054 0 ustar 00 require 'mkmf'
dir_config( 'lsapi' )
if ( have_library( "socket" ))
have_library( "nsl" )
end
if RUBY_VERSION =~ /1.9/ then
$CPPFLAGS += " -DRUBY_19"
end
if RUBY_VERSION =~ /2/ then
$CPPFLAGS += " -DRUBY_2"
end
create_makefile( "lsapi" )
share/gems/gems/ruby-lsapi-5.6/ext/lsapi/lsapilib.h 0000644 00000027775 15173517751 0016047 0 ustar 00 /*
Copyright (c) 2002-2018, Lite Speed Technologies Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of the Lite Speed Technologies Inc nor the
names of its contributors may be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
OWNER 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.
*/
#ifndef _LSAPILIB_H_
#define _LSAPILIB_H_
#if defined (c_plusplus) || defined (__cplusplus)
extern "C" {
#endif
#include "lsapidef.h"
#include <stddef.h>
#include <sys/time.h>
#include <sys/types.h>
struct LSAPI_key_value_pair
{
char * pKey;
char * pValue;
int keyLen;
int valLen;
};
struct lsapi_child_status;
#define LSAPI_MAX_RESP_HEADERS 1000
typedef struct lsapi_request
{
int m_fdListen;
int m_fd;
long m_lLastActive;
long m_lReqBegin;
char * m_pReqBuf;
int m_reqBufSize;
char * m_pRespBuf;
char * m_pRespBufEnd;
char * m_pRespBufPos;
char * m_pRespHeaderBuf;
char * m_pRespHeaderBufEnd;
char * m_pRespHeaderBufPos;
struct lsapi_child_status * child_status;
struct iovec * m_pIovec;
struct iovec * m_pIovecEnd;
struct iovec * m_pIovecCur;
struct iovec * m_pIovecToWrite;
struct lsapi_packet_header * m_respPktHeaderEnd;
struct lsapi_req_header * m_pHeader;
struct LSAPI_key_value_pair * m_pEnvList;
struct LSAPI_key_value_pair * m_pSpecialEnvList;
int m_envListSize;
int m_specialEnvListSize;
struct lsapi_http_header_index * m_pHeaderIndex;
struct lsapi_header_offset * m_pUnknownHeader;
char * m_pScriptFile;
char * m_pScriptName;
char * m_pQueryString;
char * m_pHttpHeader;
char * m_pRequestMethod;
int m_totalLen;
int m_reqState;
off_t m_reqBodyLen;
off_t m_reqBodyRead;
int m_bufProcessed;
int m_bufRead;
struct lsapi_packet_header m_respPktHeader[5];
struct lsapi_resp_header m_respHeader;
short m_respHeaderLen[LSAPI_MAX_RESP_HEADERS];
void * m_pAppData;
}LSAPI_Request;
extern LSAPI_Request g_req;
/* return: >0 continue, ==0 stop, -1 failed */
typedef int (*LSAPI_CB_EnvHandler )( const char * pKey, int keyLen,
const char * pValue, int valLen, void * arg );
int LSAPI_Init(void);
void LSAPI_Stop(void);
int LSAPI_Is_Listen_r( LSAPI_Request * pReq);
int LSAPI_InitRequest( LSAPI_Request * pReq, int fd );
int LSAPI_Accept_r( LSAPI_Request * pReq );
void LSAPI_Reset_r( LSAPI_Request * pReq );
int LSAPI_Finish_r( LSAPI_Request * pReq );
int LSAPI_Release_r( LSAPI_Request * pReq );
char * LSAPI_GetHeader_r( LSAPI_Request * pReq, int headerIndex );
int LSAPI_ForeachHeader_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg );
int LSAPI_ForeachOrgHeader_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg );
int LSAPI_ForeachEnv_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg );
int LSAPI_ForeachSpecialEnv_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg );
char * LSAPI_GetEnv_r( LSAPI_Request * pReq, const char * name );
ssize_t LSAPI_ReadReqBody_r( LSAPI_Request * pReq, char * pBuf, size_t len );
int LSAPI_ReqBodyGetChar_r( LSAPI_Request * pReq );
int LSAPI_ReqBodyGetLine_r( LSAPI_Request * pReq, char * pBuf, size_t bufLen, int *getLF );
int LSAPI_FinalizeRespHeaders_r( LSAPI_Request * pReq );
ssize_t LSAPI_Write_r( LSAPI_Request * pReq, const char * pBuf, size_t len );
ssize_t LSAPI_sendfile_r( LSAPI_Request * pReq, int fdIn, off_t* off, size_t size );
ssize_t LSAPI_Write_Stderr_r( LSAPI_Request * pReq, const char * pBuf, size_t len );
int LSAPI_Flush_r( LSAPI_Request * pReq );
int LSAPI_AppendRespHeader_r( LSAPI_Request * pReq, const char * pBuf, int len );
int LSAPI_AppendRespHeader2_r( LSAPI_Request * pReq, const char * pHeaderName,
const char * pHeaderValue );
int LSAPI_ErrResponse_r( LSAPI_Request * pReq, int code, const char ** pRespHeaders,
const char * pBody, int bodyLen );
static inline int LSAPI_SetRespStatus_r( LSAPI_Request * pReq, int code )
{
if ( !pReq )
return -1;
pReq->m_respHeader.m_respInfo.m_status = code;
return 0;
}
static inline int LSAPI_SetAppData_r( LSAPI_Request * pReq, void * data )
{
if ( !pReq )
return -1;
pReq->m_pAppData = data;
return 0;
}
static inline void * LSAPI_GetAppData_r( LSAPI_Request * pReq )
{
if ( !pReq )
return NULL;
return pReq->m_pAppData;
}
static inline char * LSAPI_GetQueryString_r( LSAPI_Request * pReq )
{
if ( pReq )
return pReq->m_pQueryString;
return NULL;
}
static inline char * LSAPI_GetScriptFileName_r( LSAPI_Request * pReq )
{
if ( pReq )
return pReq->m_pScriptFile;
return NULL;
}
static inline char * LSAPI_GetScriptName_r( LSAPI_Request * pReq )
{
if ( pReq )
return pReq->m_pScriptName;
return NULL;
}
static inline char * LSAPI_GetRequestMethod_r( LSAPI_Request * pReq)
{
if ( pReq )
return pReq->m_pRequestMethod;
return NULL;
}
static inline off_t LSAPI_GetReqBodyLen_r( LSAPI_Request * pReq )
{
if ( pReq )
return pReq->m_reqBodyLen;
return -1;
}
static inline off_t LSAPI_GetReqBodyRemain_r( LSAPI_Request * pReq )
{
if ( pReq )
return pReq->m_reqBodyLen - pReq->m_reqBodyRead;
return -1;
}
int LSAPI_End_Response_r(LSAPI_Request * pReq);
int LSAPI_Is_Listen(void);
static inline int LSAPI_Accept( void )
{ return LSAPI_Accept_r( &g_req ); }
static inline int LSAPI_Finish(void)
{ return LSAPI_Finish_r( &g_req ); }
static inline char * LSAPI_GetHeader( int headerIndex )
{ return LSAPI_GetHeader_r( &g_req, headerIndex ); }
static inline int LSAPI_ForeachHeader( LSAPI_CB_EnvHandler fn, void * arg )
{ return LSAPI_ForeachHeader_r( &g_req, fn, arg ); }
static inline int LSAPI_ForeachOrgHeader(
LSAPI_CB_EnvHandler fn, void * arg )
{ return LSAPI_ForeachOrgHeader_r( &g_req, fn, arg ); }
static inline int LSAPI_ForeachEnv( LSAPI_CB_EnvHandler fn, void * arg )
{ return LSAPI_ForeachEnv_r( &g_req, fn, arg ); }
static inline int LSAPI_ForeachSpecialEnv( LSAPI_CB_EnvHandler fn, void * arg )
{ return LSAPI_ForeachSpecialEnv_r( &g_req, fn, arg ); }
static inline char * LSAPI_GetEnv( const char * name )
{ return LSAPI_GetEnv_r( &g_req, name ); }
static inline char * LSAPI_GetQueryString(void)
{ return LSAPI_GetQueryString_r( &g_req ); }
static inline char * LSAPI_GetScriptFileName(void)
{ return LSAPI_GetScriptFileName_r( &g_req ); }
static inline char * LSAPI_GetScriptName(void)
{ return LSAPI_GetScriptName_r( &g_req ); }
static inline char * LSAPI_GetRequestMethod(void)
{ return LSAPI_GetRequestMethod_r( &g_req ); }
static inline off_t LSAPI_GetReqBodyLen(void)
{ return LSAPI_GetReqBodyLen_r( &g_req ); }
static inline off_t LSAPI_GetReqBodyRemain(void)
{ return LSAPI_GetReqBodyRemain_r( &g_req ); }
static inline ssize_t LSAPI_ReadReqBody( char * pBuf, size_t len )
{ return LSAPI_ReadReqBody_r( &g_req, pBuf, len ); }
static inline int LSAPI_ReqBodyGetChar(void)
{ return LSAPI_ReqBodyGetChar_r( &g_req ); }
static inline int LSAPI_ReqBodyGetLine( char * pBuf, int len, int *getLF )
{ return LSAPI_ReqBodyGetLine_r( &g_req, pBuf, len, getLF ); }
static inline int LSAPI_FinalizeRespHeaders(void)
{ return LSAPI_FinalizeRespHeaders_r( &g_req ); }
static inline ssize_t LSAPI_Write( const char * pBuf, ssize_t len )
{ return LSAPI_Write_r( &g_req, pBuf, len ); }
static inline ssize_t LSAPI_sendfile( int fdIn, off_t* off, size_t size )
{
return LSAPI_sendfile_r(&g_req, fdIn, off, size );
}
static inline ssize_t LSAPI_Write_Stderr( const char * pBuf, ssize_t len )
{ return LSAPI_Write_Stderr_r( &g_req, pBuf, len ); }
static inline int LSAPI_Flush(void)
{ return LSAPI_Flush_r( &g_req ); }
static inline int LSAPI_AppendRespHeader( char * pBuf, int len )
{ return LSAPI_AppendRespHeader_r( &g_req, pBuf, len ); }
static inline int LSAPI_SetRespStatus( int code )
{ return LSAPI_SetRespStatus_r( &g_req, code ); }
static inline int LSAPI_ErrResponse( int code, const char ** pRespHeaders, const char * pBody, int bodyLen )
{ return LSAPI_ErrResponse_r( &g_req, code, pRespHeaders, pBody, bodyLen ); }
static inline int LSAPI_End_Response(void)
{ return LSAPI_End_Response_r( &g_req ); }
int LSAPI_IsRunning(void);
int LSAPI_CreateListenSock( const char * pBind, int backlog );
typedef int (*fn_select_t)( int, fd_set *, fd_set *, fd_set *, struct timeval * );
int LSAPI_Init_Prefork_Server( int max_children, fn_select_t fp, int avoidFork );
void LSAPI_Set_Server_fd( int fd );
int LSAPI_Prefork_Accept_r( LSAPI_Request * pReq );
void LSAPI_No_Check_ppid(void);
void LSAPI_Set_Max_Reqs( int reqs );
void LSAPI_Set_Max_Idle( int secs );
void LSAPI_Set_Max_Children( int maxChildren );
void LSAPI_Set_Max_Idle_Children( int maxIdleChld );
void LSAPI_Set_Server_Max_Idle_Secs( int serverMaxIdle );
void LSAPI_Set_Max_Process_Time( int secs );
int LSAPI_Init_Env_Parameters( fn_select_t fp );
void LSAPI_Set_Slow_Req_Msecs( int msecs );
int LSAPI_Get_Slow_Req_Msecs(void);
int LSAPI_is_suEXEC_Daemon(void);
int LSAPI_Set_Restored_Parent_Pid(int pid);
typedef void (*LSAPI_On_Timer_pf)(int *forked_child_pid);
void LSAPI_Register_Pgrp_Timer_Callback(LSAPI_On_Timer_pf);
int LSAPI_Inc_Req_Processed(int cnt);
int LSAPI_Accept_Before_Fork(LSAPI_Request * pReq);
int LSAPI_Postfork_Child(LSAPI_Request * pReq);
int LSAPI_Postfork_Parent(LSAPI_Request * pReq);
#define LSAPI_LOG_LEVEL_BITS 0xff
#define LSAPI_LOG_FLAG_NONE 0
#define LSAPI_LOG_FLAG_DEBUG 1
#define LSAPI_LOG_FLAG_INFO 2
#define LSAPI_LOG_FLAG_NOTICE 3
#define LSAPI_LOG_FLAG_WARN 4
#define LSAPI_LOG_FLAG_ERROR 5
#define LSAPI_LOG_FLAG_CRIT 6
#define LSAPI_LOG_FLAG_FATAL 7
#define LSAPI_LOG_TIMESTAMP_BITS (0xff00)
#define LSAPI_LOG_TIMESTAMP_FULL (0x100)
#define LSAPI_LOG_TIMESTAMP_HMS (0x200)
#define LSAPI_LOG_TIMESTAMP_STDERR (0x400)
#define LSAPI_LOG_PID (0x10000)
void LSAPI_Log(int flag, const char * fmt, ...)
#if __GNUC__
__attribute__((format(printf, 2, 3)))
#endif
;
#if defined (c_plusplus) || defined (__cplusplus)
}
#endif
#endif
share/gems/gems/ruby-lsapi-5.6/ext/lsapi/lsapilib.c 0000644 00000350541 15173517751 0016030 0 ustar 00 //#define LSAPI_DEBUG
/*
Copyright (c) 2002-2018, Lite Speed Technologies Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of the Lite Speed Technologies Inc nor the
names of its contributors may be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
OWNER 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.
*/
#include <ctype.h>
#include <dlfcn.h>
#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <sys/stat.h>
#include <sched.h>
#include <signal.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <string.h>
#include <sys/mman.h>
#include <sys/resource.h>
#include <sys/socket.h>
#include <sys/time.h>
#include <sys/uio.h>
#include <sys/wait.h>
#include <grp.h>
#include <pwd.h>
#include <time.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <netdb.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <sys/un.h>
#include "lsapilib.h"
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
#include <sys/prctl.h>
#endif
#if defined(__FreeBSD__ ) || defined(__NetBSD__) || defined(__OpenBSD__) \
|| defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
#include <sys/sysctl.h>
#endif
#include <inttypes.h>
#ifndef uint32
#define uint32 uint32_t
#endif
struct lsapi_MD5Context {
uint32 buf[4];
uint32 bits[2];
unsigned char in[64];
};
void lsapi_MD5Init(struct lsapi_MD5Context *context);
void lsapi_MD5Update(struct lsapi_MD5Context *context, unsigned char const *buf,
unsigned len);
void lsapi_MD5Final(unsigned char digest[16], struct lsapi_MD5Context *context);
/*
* This is needed to make RSAREF happy on some MS-DOS compilers.
*/
typedef struct lsapi_MD5Context lsapi_MD5_CTX;
#define LSAPI_ST_REQ_HEADER 1
#define LSAPI_ST_REQ_BODY 2
#define LSAPI_ST_RESP_HEADER 4
#define LSAPI_ST_RESP_BODY 8
#define LSAPI_ST_BACKGROUND 16
#define LSAPI_RESP_BUF_SIZE 8192
#define LSAPI_INIT_RESP_HEADER_LEN 4096
enum
{
LSAPI_STATE_IDLE,
LSAPI_STATE_CONNECTED,
LSAPI_STATE_ACCEPTING,
};
typedef struct lsapi_child_status
{
int m_pid;
long m_tmStart;
volatile short m_iKillSent;
volatile char m_inProcess;
volatile char m_state;
volatile int m_iReqCounter;
volatile long m_tmWaitBegin;
volatile long m_tmReqBegin;
volatile long m_tmLastCheckPoint;
}
lsapi_child_status;
static lsapi_child_status * s_worker_status = NULL;
static int g_inited = 0;
static int g_running = 1;
static int s_ppid;
static int s_restored_ppid = 0;
static int s_pid = 0;
static int s_slow_req_msecs = 0;
static int s_keep_listener = 1;
static int s_dump_debug_info = 0;
static int s_pid_dump_debug_info = 0;
static int s_req_processed = 0;
static int s_skip_write = 0;
static int (*pthread_atfork_func)(void (*prepare)(void), void (*parent)(void),
void (*child)(void)) = NULL;
static int *s_busy_workers = NULL;
static int *s_accepting_workers = NULL;
static int *s_global_counter = &s_req_processed;
static int s_max_busy_workers = -1;
static char *s_stderr_log_path = NULL;
static int s_stderr_is_pipe = 0;
static int s_ignore_pid = -1;
static size_t s_total_pages = 1;
static size_t s_min_avail_pages = 256 * 1024;
static size_t *s_avail_pages = &s_total_pages;
LSAPI_Request g_req =
{ .m_fdListen = -1, .m_fd = -1 };
static char s_secret[24];
static LSAPI_On_Timer_pf s_proc_group_timer_cb = NULL;
void Flush_RespBuf_r( LSAPI_Request * pReq );
static int lsapi_reopen_stderr(const char *p);
static const char *CGI_HEADERS[H_TRANSFER_ENCODING+1] =
{
"HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET",
"HTTP_ACCEPT_ENCODING",
"HTTP_ACCEPT_LANGUAGE", "HTTP_AUTHORIZATION",
"HTTP_CONNECTION", "CONTENT_TYPE",
"CONTENT_LENGTH", "HTTP_COOKIE", "HTTP_COOKIE2",
"HTTP_HOST", "HTTP_PRAGMA",
"HTTP_REFERER", "HTTP_USER_AGENT",
"HTTP_CACHE_CONTROL",
"HTTP_IF_MODIFIED_SINCE", "HTTP_IF_MATCH",
"HTTP_IF_NONE_MATCH",
"HTTP_IF_RANGE",
"HTTP_IF_UNMODIFIED_SINCE",
"HTTP_KEEP_ALIVE",
"HTTP_RANGE",
"HTTP_X_FORWARDED_FOR",
"HTTP_VIA",
"HTTP_TRANSFER_ENCODING"
};
static int CGI_HEADER_LEN[H_TRANSFER_ENCODING+1] =
{ 11, 19, 20, 20, 18, 15, 12, 14, 11, 12, 9, 11, 12, 15, 18,
22, 13, 18, 13, 24, 15, 10, 20, 8, 22 };
static const char *HTTP_HEADERS[H_TRANSFER_ENCODING+1] =
{
"Accept", "Accept-Charset",
"Accept-Encoding",
"Accept-Language", "Authorization",
"Connection", "Content-Type",
"Content-Length", "Cookie", "Cookie2",
"Host", "Pragma",
"Referer", "User-Agent",
"Cache-Control",
"If-Modified-Since", "If-Match",
"If-None-Match",
"If-Range",
"If-Unmodified-Since",
"Keep-Alive",
"Range",
"X-Forwarded-For",
"Via",
"Transfer-Encoding"
};
static int HTTP_HEADER_LEN[H_TRANSFER_ENCODING+1] =
{ 6, 14, 15, 15, 13, 10, 12, 14, 6, 7, 4, 6, 7, 10, //user-agent
13,17, 8, 13, 8, 19, 10, 5, 15, 3, 17
};
static const char *s_log_level_names[8] =
{
"", "DEBUG","INFO", "NOTICE", "WARN", "ERROR", "CRIT", "FATAL"
};
void LSAPI_Log(int flag, const char * fmt, ...)
{
char buf[1024];
char *p = buf;
if ((flag & LSAPI_LOG_TIMESTAMP_BITS)
&& !(s_stderr_is_pipe))
{
struct timeval tv;
struct tm tm;
gettimeofday(&tv, NULL);
localtime_r(&tv.tv_sec, &tm);
if (flag & LSAPI_LOG_TIMESTAMP_FULL)
{
p += snprintf(p, 1024, "%04d-%02d-%02d %02d:%02d:%02d.%06d ",
tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday,
tm.tm_hour, tm.tm_min, tm.tm_sec, (int)tv.tv_usec);
}
else if (flag & LSAPI_LOG_TIMESTAMP_HMS)
{
p += snprintf(p, 1024, "%02d:%02d:%02d ",
tm.tm_hour, tm.tm_min, tm.tm_sec);
}
}
int level = flag & LSAPI_LOG_LEVEL_BITS;
if (level && level <= LSAPI_LOG_FLAG_FATAL)
{
p += snprintf(p, 100, "[%s] ", s_log_level_names[level]);
}
if (flag & LSAPI_LOG_PID)
{
p += snprintf(p, 100, "[UID:%d][%d] ", getuid(), s_pid);
}
if (p > buf)
fprintf(stderr, "%.*s", (int)(p - buf), buf);
va_list ap;
va_start(ap, fmt);
vfprintf(stderr, fmt, ap);
va_end(ap);
}
#ifdef LSAPI_DEBUG
#define DBGLOG_FLAG (LSAPI_LOG_TIMESTAMP_FULL|LSAPI_LOG_FLAG_DEBUG|LSAPI_LOG_PID)
#define lsapi_dbg(...) LSAPI_Log(DBGLOG_FLAG, __VA_ARGS__)
#else
#define lsapi_dbg(...)
#endif
#define lsapi_log(...) LSAPI_Log(LSAPI_LOG_TIMESTAMP_FULL|LSAPI_LOG_PID, __VA_ARGS__)
void lsapi_perror(const char * pMessage, int err_no)
{
lsapi_log("%s, errno: %d (%s)\n", pMessage, err_no, strerror(err_no));
}
static int lsapi_parent_dead()
{
// Return non-zero if the parent is dead. 0 if still alive.
if (!s_ppid) {
// not checking, so not dead
return(0);
}
if (s_restored_ppid) {
if (kill(s_restored_ppid,0) == -1) {
if (errno == EPERM) {
return(0); // no permission, but it's still there.
}
return(1); // Dead
}
return(0); // it worked, so it's not dead
}
return(s_ppid != getppid());
}
static void lsapi_sigpipe( int sig )
{
}
static void lsapi_siguser1( int sig )
{
g_running = 0;
}
#ifndef sighandler_t
typedef void (*sighandler_t)(int);
#endif
static void lsapi_signal(int signo, sighandler_t handler)
{
struct sigaction sa;
sigaction(signo, NULL, &sa);
if (sa.sa_handler == SIG_DFL)
{
sigemptyset(&sa.sa_mask);
sa.sa_flags = 0;
sa.sa_handler = handler;
sigaction(signo, &sa, NULL);
}
}
static int s_enable_core_dump = 0;
static void lsapi_enable_core_dump(void)
{
#if defined(__FreeBSD__ ) || defined(__NetBSD__) || defined(__OpenBSD__) \
|| defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
int mib[2];
size_t len;
#if !defined(__OpenBSD__)
len = 2;
if ( sysctlnametomib("kern.sugid_coredump", mib, &len) == 0 )
{
len = sizeof(s_enable_core_dump);
if (sysctl(mib, 2, NULL, 0, &s_enable_core_dump, len) == -1)
perror( "sysctl: Failed to set 'kern.sugid_coredump', "
"core dump may not be available!");
}
#else
int set = 3;
len = sizeof(set);
mib[0] = CTL_KERN;
mib[1] = KERN_NOSUIDCOREDUMP;
if (sysctl(mib, 2, NULL, 0, &set, len) == 0) {
s_enable_core_dump = 1;
}
#endif
#endif
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
if (prctl(PR_SET_DUMPABLE, s_enable_core_dump,0,0,0) == -1)
perror( "prctl: Failed to set dumpable, "
"core dump may not be available!");
#endif
}
static inline void lsapi_buildPacketHeader( struct lsapi_packet_header * pHeader,
char type, int len )
{
pHeader->m_versionB0 = LSAPI_VERSION_B0; /* LSAPI protocol version */
pHeader->m_versionB1 = LSAPI_VERSION_B1;
pHeader->m_type = type;
pHeader->m_flag = LSAPI_ENDIAN;
pHeader->m_packetLen.m_iLen = len;
}
static int lsapi_set_nblock( int fd, int nonblock )
{
int val = fcntl( fd, F_GETFL, 0 );
if ( nonblock )
{
if (!( val & O_NONBLOCK ))
{
return fcntl( fd, F_SETFL, val | O_NONBLOCK );
}
}
else
{
if ( val & O_NONBLOCK )
{
return fcntl( fd, F_SETFL, val &(~O_NONBLOCK) );
}
}
return 0;
}
static int lsapi_close( int fd )
{
int ret;
while( 1 )
{
ret = close( fd );
if (( ret == -1 )&&( errno == EINTR )&&(g_running))
continue;
return ret;
}
}
static void lsapi_close_connection(LSAPI_Request *pReq)
{
if (pReq->m_fd == -1)
return;
lsapi_close(pReq->m_fd);
pReq->m_fd = -1;
if (s_busy_workers)
__atomic_fetch_sub(s_busy_workers, 1, __ATOMIC_SEQ_CST);
if (s_worker_status)
__atomic_store_n(&s_worker_status->m_state, LSAPI_STATE_IDLE,
__ATOMIC_SEQ_CST);
}
static inline ssize_t lsapi_read( int fd, void * pBuf, size_t len )
{
ssize_t ret;
while( 1 )
{
ret = read( fd, (char *)pBuf, len );
if (( ret == -1 )&&( errno == EINTR )&&(g_running))
continue;
return ret;
}
}
/*
static int lsapi_write( int fd, const void * pBuf, int len )
{
int ret;
const char * pCur;
const char * pEnd;
if ( len == 0 )
return 0;
pCur = (const char *)pBuf;
pEnd = pCur + len;
while( g_running && (pCur < pEnd) )
{
ret = write( fd, pCur, pEnd - pCur );
if ( ret >= 0)
pCur += ret;
else if (( ret == -1 )&&( errno != EINTR ))
return ret;
}
return pCur - (const char *)pBuf;
}
*/
static int lsapi_writev( int fd, struct iovec ** pVec, int count, int totalLen )
{
int ret;
int left = totalLen;
int n = count;
if (s_skip_write)
return totalLen;
while(( left > 0 )&&g_running )
{
ret = writev( fd, *pVec, n );
if ( ret > 0 )
{
left -= ret;
if (( left <= 0)||( !g_running ))
return totalLen - left;
while( ret > 0 )
{
if ( (*pVec)->iov_len <= (unsigned int )ret )
{
ret -= (*pVec)->iov_len;
++(*pVec);
}
else
{
(*pVec)->iov_base = (char *)(*pVec)->iov_base + ret;
(*pVec)->iov_len -= ret;
break;
}
}
}
else if ( ret == -1 )
{
if ( errno == EAGAIN )
{
if ( totalLen - left > 0 )
return totalLen - left;
else
return -1;
}
else if ( errno != EINTR )
return ret;
}
}
return totalLen - left;
}
/*
static int getTotalLen( struct iovec * pVec, int count )
{
struct iovec * pEnd = pVec + count;
int total = 0;
while( pVec < pEnd )
{
total += pVec->iov_len;
++pVec;
}
return total;
}
*/
static inline int allocateBuf( LSAPI_Request * pReq, int size )
{
char * pBuf = (char *)realloc( pReq->m_pReqBuf, size );
if ( pBuf )
{
pReq->m_pReqBuf = pBuf;
pReq->m_reqBufSize = size;
pReq->m_pHeader = (struct lsapi_req_header *)pReq->m_pReqBuf;
return 0;
}
return -1;
}
static int allocateIovec( LSAPI_Request * pReq, int n )
{
struct iovec * p = (struct iovec *)realloc(
pReq->m_pIovec, sizeof(struct iovec) * n );
if ( !p )
return -1;
pReq->m_pIovecToWrite = p + ( pReq->m_pIovecToWrite - pReq->m_pIovec );
pReq->m_pIovecCur = p + ( pReq->m_pIovecCur - pReq->m_pIovec );
pReq->m_pIovec = p;
pReq->m_pIovecEnd = p + n;
return 0;
}
static int allocateRespHeaderBuf( LSAPI_Request * pReq, int size )
{
char * p = (char *)realloc( pReq->m_pRespHeaderBuf, size );
if ( !p )
return -1;
pReq->m_pRespHeaderBufPos = p + ( pReq->m_pRespHeaderBufPos - pReq->m_pRespHeaderBuf );
pReq->m_pRespHeaderBuf = p;
pReq->m_pRespHeaderBufEnd = p + size;
return 0;
}
static inline int verifyHeader( struct lsapi_packet_header * pHeader, char pktType )
{
if (( LSAPI_VERSION_B0 != pHeader->m_versionB0 )||
( LSAPI_VERSION_B1 != pHeader->m_versionB1 )||
( pktType != pHeader->m_type ))
return -1;
if ( LSAPI_ENDIAN != (pHeader->m_flag & LSAPI_ENDIAN_BIT ))
{
register char b;
b = pHeader->m_packetLen.m_bytes[0];
pHeader->m_packetLen.m_bytes[0] = pHeader->m_packetLen.m_bytes[3];
pHeader->m_packetLen.m_bytes[3] = b;
b = pHeader->m_packetLen.m_bytes[1];
pHeader->m_packetLen.m_bytes[1] = pHeader->m_packetLen.m_bytes[2];
pHeader->m_packetLen.m_bytes[2] = b;
}
return pHeader->m_packetLen.m_iLen;
}
static int allocateEnvList( struct LSAPI_key_value_pair ** pEnvList,
int *curSize, int newSize )
{
struct LSAPI_key_value_pair * pBuf;
if ( *curSize >= newSize )
return 0;
if ( newSize > 8192 )
return -1;
pBuf = (struct LSAPI_key_value_pair *)realloc( *pEnvList, newSize *
sizeof(struct LSAPI_key_value_pair) );
if ( pBuf )
{
*pEnvList = pBuf;
*curSize = newSize;
return 0;
}
else
return -1;
}
static inline int isPipe( int fd )
{
char achPeer[128];
socklen_t len = 128;
if (( getpeername( fd, (struct sockaddr *)achPeer, &len ) != 0 )&&
( errno == ENOTCONN ))
return 0;
else
return 1;
}
static int parseEnv( struct LSAPI_key_value_pair * pEnvList, int count,
char **pBegin, char * pEnd )
{
struct LSAPI_key_value_pair * pEnvEnd;
int keyLen = 0, valLen = 0;
if ( count > 8192 )
return -1;
pEnvEnd = pEnvList + count;
while( pEnvList != pEnvEnd )
{
if ( pEnd - *pBegin < 4 )
return -1;
keyLen = *((unsigned char *)((*pBegin)++));
keyLen = (keyLen << 8) + *((unsigned char *)((*pBegin)++));
valLen = *((unsigned char *)((*pBegin)++));
valLen = (valLen << 8) + *((unsigned char *)((*pBegin)++));
if ( *pBegin + keyLen + valLen > pEnd )
return -1;
if (( !keyLen )||( !valLen ))
return -1;
pEnvList->pKey = *pBegin;
*pBegin += keyLen;
pEnvList->pValue = *pBegin;
*pBegin += valLen;
pEnvList->keyLen = keyLen - 1;
pEnvList->valLen = valLen - 1;
++pEnvList;
}
if ( memcmp( *pBegin, "\0\0\0\0", 4 ) != 0 )
return -1;
*pBegin += 4;
return 0;
}
static inline void swapIntEndian( int * pInteger )
{
char * p = (char *)pInteger;
register char b;
b = p[0];
p[0] = p[3];
p[3] = b;
b = p[1];
p[1] = p[2];
p[2] = b;
}
static inline void fixEndian( LSAPI_Request * pReq )
{
struct lsapi_req_header *p= pReq->m_pHeader;
swapIntEndian( &p->m_httpHeaderLen );
swapIntEndian( &p->m_reqBodyLen );
swapIntEndian( &p->m_scriptFileOff );
swapIntEndian( &p->m_scriptNameOff );
swapIntEndian( &p->m_queryStringOff );
swapIntEndian( &p->m_requestMethodOff );
swapIntEndian( &p->m_cntUnknownHeaders );
swapIntEndian( &p->m_cntEnv );
swapIntEndian( &p->m_cntSpecialEnv );
}
static void fixHeaderIndexEndian( LSAPI_Request * pReq )
{
int i;
for( i = 0; i < H_TRANSFER_ENCODING; ++i )
{
if ( pReq->m_pHeaderIndex->m_headerOff[i] )
{
register char b;
char * p = (char *)(&pReq->m_pHeaderIndex->m_headerLen[i]);
b = p[0];
p[0] = p[1];
p[1] = b;
swapIntEndian( &pReq->m_pHeaderIndex->m_headerOff[i] );
}
}
if ( pReq->m_pHeader->m_cntUnknownHeaders > 0 )
{
struct lsapi_header_offset * pCur, *pEnd;
pCur = pReq->m_pUnknownHeader;
pEnd = pCur + pReq->m_pHeader->m_cntUnknownHeaders;
while( pCur < pEnd )
{
swapIntEndian( &pCur->nameOff );
swapIntEndian( &pCur->nameLen );
swapIntEndian( &pCur->valueOff );
swapIntEndian( &pCur->valueLen );
++pCur;
}
}
}
static int validateHeaders( LSAPI_Request * pReq )
{
int totalLen = pReq->m_pHeader->m_httpHeaderLen;
int i;
for(i = 0; i < H_TRANSFER_ENCODING; ++i)
{
if ( pReq->m_pHeaderIndex->m_headerOff[i] )
{
if (pReq->m_pHeaderIndex->m_headerOff[i] > totalLen
|| pReq->m_pHeaderIndex->m_headerLen[i]
+ pReq->m_pHeaderIndex->m_headerOff[i] > totalLen)
return -1;
}
}
if (pReq->m_pHeader->m_cntUnknownHeaders > 0)
{
struct lsapi_header_offset * pCur, *pEnd;
pCur = pReq->m_pUnknownHeader;
pEnd = pCur + pReq->m_pHeader->m_cntUnknownHeaders;
while( pCur < pEnd )
{
if (pCur->nameOff > totalLen
|| pCur->nameOff + pCur->nameLen > totalLen
|| pCur->valueOff > totalLen
|| pCur->valueOff + pCur->valueLen > totalLen)
return -1;
++pCur;
}
}
return 0;
}
static uid_t s_uid = 0;
static uid_t s_defaultUid; //web server need set this
static gid_t s_defaultGid;
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
#define LSAPI_LVE_DISABLED 0
#define LSAPI_LVE_ENABLED 1
#define LSAPI_CAGEFS_ENABLED 2
#define LSAPI_CAGEFS_NO_SUEXEC 3
struct liblve;
static int s_enable_lve = LSAPI_LVE_DISABLED;
static struct liblve * s_lve = NULL;
static void *s_liblve;
static int (*fp_lve_is_available)(void) = NULL;
static int (*fp_lve_instance_init)(struct liblve *) = NULL;
static int (*fp_lve_destroy)(struct liblve *) = NULL;
static int (*fp_lve_enter)(struct liblve *, uint32_t, int32_t, int32_t, uint32_t *) = NULL;
static int (*fp_lve_leave)(struct liblve *, uint32_t *) = NULL;
static int (*fp_lve_jail)( struct passwd *, char *) = NULL;
static int lsapi_load_lve_lib(void)
{
s_liblve = dlopen("liblve.so.0", RTLD_NOW | RTLD_GLOBAL);
if (s_liblve)
{
fp_lve_is_available = dlsym(s_liblve, "lve_is_available");
if (dlerror() == NULL)
{
if ( !(*fp_lve_is_available)() )
{
int uid = getuid();
if ( uid )
{
if (setreuid( s_uid, uid )) {};
if ( !(*fp_lve_is_available)() )
s_enable_lve = 0;
if (setreuid( uid, s_uid )) {};
}
}
}
}
else
{
s_enable_lve = LSAPI_LVE_DISABLED;
}
return (s_liblve)? 0 : -1;
}
static int init_lve_ex(void)
{
int rc;
if ( !s_liblve )
return -1;
fp_lve_instance_init = dlsym(s_liblve, "lve_instance_init");
fp_lve_destroy = dlsym(s_liblve, "lve_destroy");
fp_lve_enter = dlsym(s_liblve, "lve_enter");
fp_lve_leave = dlsym(s_liblve, "lve_leave");
if ( s_enable_lve >= LSAPI_CAGEFS_ENABLED )
fp_lve_jail = dlsym(s_liblve, "jail" );
if ( s_lve == NULL )
{
rc = (*fp_lve_instance_init)(NULL);
s_lve = malloc(rc);
}
rc = (*fp_lve_instance_init)(s_lve);
if (rc != 0)
{
perror( "LSAPI: Unable to initialize LVE" );
free( s_lve );
s_lve = NULL;
return -1;
}
return 0;
}
#endif
static int readSecret( const char * pSecretFile )
{
struct stat st;
int fd = open( pSecretFile, O_RDONLY , 0600 );
if ( fd == -1 )
{
lsapi_log("LSAPI: failed to open secret file: %s!\n", pSecretFile );
return -1;
}
if ( fstat( fd, &st ) == -1 )
{
lsapi_log("LSAPI: failed to check state of file: %s!\n", pSecretFile );
close( fd );
return -1;
}
/*
if ( st.st_uid != s_uid )
{
lsapi_log("LSAPI: file owner check failure: %s!\n", pSecretFile );
close( fd );
return -1;
}
*/
if ( st.st_mode & 0077 )
{
lsapi_log("LSAPI: file permission check failure: %s\n", pSecretFile );
close( fd );
return -1;
}
if ( read( fd, s_secret, 16 ) < 16 )
{
lsapi_log("LSAPI: failed to read secret from secret file: %s\n", pSecretFile );
close( fd );
return -1;
}
close( fd );
return 0;
}
int LSAPI_is_suEXEC_Daemon(void)
{
if (( !s_uid )&&( s_secret[0] ))
return 1;
else
return 0;
}
static int LSAPI_perror_r( LSAPI_Request * pReq, const char * pErr1, const char *pErr2 )
{
char achError[4096];
int n = snprintf(achError, sizeof(achError), "[UID:%d][%d] %s:%s: %s\n",
getuid(), getpid(),
pErr1, (pErr2)?pErr2:"", strerror(errno));
if (n > (int)sizeof(achError))
n = sizeof(achError);
if ( pReq )
LSAPI_Write_Stderr_r( pReq, achError, n );
else
if (write( STDERR_FILENO, achError, n )) {};
return 0;
}
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
static int lsapi_lve_error( LSAPI_Request * pReq )
{
static const char * headers[] =
{
"Cache-Control: private, no-cache, no-store, must-revalidate, max-age=0",
"Pragma: no-cache",
"Retry-After: 60",
"Content-Type: text/html",
NULL
};
static const char achBody[] =
"<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\n"
"<HTML><HEAD>\n<TITLE>508 Resource Limit Is Reached</TITLE>\n"
"</HEAD><BODY>\n" "<H1>Resource Limit Is Reached</H1>\n"
"The website is temporarily unable to service your request as it exceeded resource limit.\n"
"Please try again later.\n"
"<HR>\n"
"</BODY></HTML>\n";
LSAPI_ErrResponse_r( pReq, 508, headers, achBody, sizeof( achBody ) - 1 );
return 0;
}
static int lsapi_enterLVE( LSAPI_Request * pReq, uid_t uid )
{
if ( s_lve && uid ) //root user should not do that
{
uint32_t cookie;
int ret = -1;
ret = (*fp_lve_enter)(s_lve, uid, -1, -1, &cookie);
if ( ret < 0 )
{
//lsapi_log("enter LVE (%d) : result: %d !\n", uid, ret );
LSAPI_perror_r(pReq, "LSAPI: lve_enter() failure, reached resource limit.", NULL );
lsapi_lve_error( pReq );
return -1;
}
}
return 0;
}
static int lsapi_jailLVE( LSAPI_Request * pReq, uid_t uid, struct passwd * pw )
{
int ret = 0;
char error_msg[1024] = "";
ret = (*fp_lve_jail)( pw, error_msg );
if ( ret < 0 )
{
lsapi_log("LSAPI: LVE jail(%d) result: %d, error: %s !\n",
uid, ret, error_msg );
LSAPI_perror_r( pReq, "LSAPI: jail() failure.", NULL );
return -1;
}
return ret;
}
static int lsapi_initLVE(void)
{
const char * pEnv;
if ( (pEnv = getenv( "LSAPI_LVE_ENABLE" ))!= NULL )
{
s_enable_lve = atol( pEnv );
pEnv = NULL;
}
else if ( (pEnv = getenv( "LVE_ENABLE" ))!= NULL )
{
s_enable_lve = atol( pEnv );
pEnv = NULL;
}
if ( s_enable_lve && !s_uid )
{
lsapi_load_lve_lib();
if ( s_enable_lve )
{
return init_lve_ex();
}
}
return 0;
}
#endif
static int setUID_LVE(LSAPI_Request * pReq, uid_t uid, gid_t gid, const char * pChroot)
{
int rv;
struct passwd * pw;
pw = getpwuid( uid );
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
if ( s_lve )
{
if( lsapi_enterLVE( pReq, uid ) == -1 )
return -1;
if ( pw && fp_lve_jail)
{
rv = lsapi_jailLVE( pReq, uid, pw );
if ( rv == -1 )
return -1;
if (( rv == 1 )&&(s_enable_lve == LSAPI_CAGEFS_NO_SUEXEC )) //this mode only use cageFS, does not use suEXEC
{
uid = s_defaultUid;
gid = s_defaultGid;
pw = getpwuid( uid );
}
}
}
#endif
//if ( !uid || !gid ) //do not allow root
//{
// return -1;
//}
#if defined(__FreeBSD__ ) || defined(__NetBSD__) || defined(__OpenBSD__) \
|| defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
if ( s_enable_core_dump )
lsapi_enable_core_dump();
#endif
rv = setgid(gid);
if (rv == -1)
{
LSAPI_perror_r(pReq, "LSAPI: setgid()", NULL);
return -1;
}
if ( pw && (pw->pw_gid == gid ))
{
rv = initgroups( pw->pw_name, gid );
if (rv == -1)
{
LSAPI_perror_r(pReq, "LSAPI: initgroups()", NULL);
return -1;
}
}
else
{
rv = setgroups(1, &gid);
if (rv == -1)
{
LSAPI_perror_r(pReq, "LSAPI: setgroups()", NULL);
}
}
if ( pChroot )
{
rv = chroot( pChroot );
if ( rv == -1 )
{
LSAPI_perror_r(pReq, "LSAPI: chroot()", NULL);
return -1;
}
}
rv = setuid(uid);
if (rv == -1)
{
LSAPI_perror_r(pReq, "LSAPI: setuid()", NULL);
return -1;
}
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
if ( s_enable_core_dump )
lsapi_enable_core_dump();
#endif
return 0;
}
static int lsapi_suexec_auth( LSAPI_Request *pReq,
char * pAuth, int len, char * pUgid, int ugidLen )
{
lsapi_MD5_CTX md5ctx;
unsigned char achMD5[16];
if ( len < 32 )
return -1;
memmove( achMD5, pAuth + 16, 16 );
memmove( pAuth + 16, s_secret, 16 );
lsapi_MD5Init( &md5ctx );
lsapi_MD5Update( &md5ctx, (unsigned char *)pAuth, 32 );
lsapi_MD5Update( &md5ctx, (unsigned char *)pUgid, 8 );
lsapi_MD5Final( (unsigned char *)pAuth + 16, &md5ctx);
if ( memcmp( achMD5, pAuth + 16, 16 ) == 0 )
return 0;
return 1;
}
static int lsapi_changeUGid( LSAPI_Request * pReq )
{
int uid = s_defaultUid;
int gid = s_defaultGid;
const char *pStderrLog;
const char *pChroot = NULL;
struct LSAPI_key_value_pair * pEnv;
struct LSAPI_key_value_pair * pAuth;
int i;
if ( s_uid )
return 0;
//with special ID 0x00
//authenticate the suEXEC request;
//first one should be MD5( nonce + lscgid secret )
//remember to clear the secret after verification
//it should be set at the end of special env
i = pReq->m_pHeader->m_cntSpecialEnv - 1;
if ( i >= 0 )
{
pEnv = pReq->m_pSpecialEnvList + i;
if (( *pEnv->pKey == '\000' )&&
( strcmp( pEnv->pKey+1, "SUEXEC_AUTH" ) == 0 ))
{
--pReq->m_pHeader->m_cntSpecialEnv;
pAuth = pEnv--;
if (( *pEnv->pKey == '\000' )&&
( strcmp( pEnv->pKey+1, "SUEXEC_UGID" ) == 0 ))
{
--pReq->m_pHeader->m_cntSpecialEnv;
uid = *(uint32_t *)pEnv->pValue;
gid = *(((uint32_t *)pEnv->pValue) + 1 );
//lsapi_log("LSAPI: SUEXEC_UGID set UID: %d, GID: %d\n", uid, gid );
}
else
{
lsapi_log("LSAPI: missing SUEXEC_UGID env, use default user!\n" );
pEnv = NULL;
}
if ( pEnv&& lsapi_suexec_auth( pReq, pAuth->pValue, pAuth->valLen, pEnv->pValue, pEnv->valLen ) == 0 )
{
//read UID, GID from specialEnv
}
else
{
//authentication error
lsapi_log("LSAPI: SUEXEC_AUTH authentication failed, use default user!\n" );
uid = 0;
}
}
else
{
//lsapi_log("LSAPI: no SUEXEC_AUTH env, use default user!\n" );
}
}
if ( !uid )
{
uid = s_defaultUid;
gid = s_defaultGid;
}
//change uid
if ( setUID_LVE( pReq, uid, gid, pChroot ) == -1 )
{
return -1;
}
s_uid = uid;
if ( pReq->m_fdListen != -1 )
{
close( pReq->m_fdListen );
pReq->m_fdListen = -1;
}
pStderrLog = LSAPI_GetEnv_r( pReq, "LSAPI_STDERR_LOG");
if (pStderrLog)
lsapi_reopen_stderr(pStderrLog);
return 0;
}
static int parseContentLenFromHeader(LSAPI_Request * pReq)
{
const char * pContentLen = LSAPI_GetHeader_r( pReq, H_CONTENT_LENGTH );
if ( pContentLen )
pReq->m_reqBodyLen = strtoll( pContentLen, NULL, 10 );
return 0;
}
static int parseRequest( LSAPI_Request * pReq, int totalLen )
{
int shouldFixEndian;
char * pBegin = pReq->m_pReqBuf + sizeof( struct lsapi_req_header );
char * pEnd = pReq->m_pReqBuf + totalLen;
shouldFixEndian = ( LSAPI_ENDIAN != (
pReq->m_pHeader->m_pktHeader.m_flag & LSAPI_ENDIAN_BIT ) );
if ( shouldFixEndian )
{
fixEndian( pReq );
}
if ( (pReq->m_specialEnvListSize < pReq->m_pHeader->m_cntSpecialEnv )&&
allocateEnvList( &pReq->m_pSpecialEnvList,
&pReq->m_specialEnvListSize,
pReq->m_pHeader->m_cntSpecialEnv ) == -1 )
return -1;
if ( (pReq->m_envListSize < pReq->m_pHeader->m_cntEnv )&&
allocateEnvList( &pReq->m_pEnvList, &pReq->m_envListSize,
pReq->m_pHeader->m_cntEnv ) == -1 )
return -1;
if ( parseEnv( pReq->m_pSpecialEnvList,
pReq->m_pHeader->m_cntSpecialEnv,
&pBegin, pEnd ) == -1 )
return -1;
if ( parseEnv( pReq->m_pEnvList, pReq->m_pHeader->m_cntEnv,
&pBegin, pEnd ) == -1 )
return -1;
if (pReq->m_pHeader->m_scriptFileOff < 0
|| pReq->m_pHeader->m_scriptFileOff >= totalLen
|| pReq->m_pHeader->m_scriptNameOff < 0
|| pReq->m_pHeader->m_scriptNameOff >= totalLen
|| pReq->m_pHeader->m_queryStringOff < 0
|| pReq->m_pHeader->m_queryStringOff >= totalLen
|| pReq->m_pHeader->m_requestMethodOff < 0
|| pReq->m_pHeader->m_requestMethodOff >= totalLen)
{
lsapi_log("Bad request header - ERROR#1\n");
return -1;
}
pReq->m_pScriptFile = pReq->m_pReqBuf + pReq->m_pHeader->m_scriptFileOff;
pReq->m_pScriptName = pReq->m_pReqBuf + pReq->m_pHeader->m_scriptNameOff;
pReq->m_pQueryString = pReq->m_pReqBuf + pReq->m_pHeader->m_queryStringOff;
pReq->m_pRequestMethod = pReq->m_pReqBuf + pReq->m_pHeader->m_requestMethodOff;
pBegin = pReq->m_pReqBuf + (( pBegin - pReq->m_pReqBuf + 7 ) & (~0x7));
pReq->m_pHeaderIndex = ( struct lsapi_http_header_index * )pBegin;
pBegin += sizeof( struct lsapi_http_header_index );
pReq->m_pUnknownHeader = (struct lsapi_header_offset *)pBegin;
pBegin += sizeof( struct lsapi_header_offset) *
pReq->m_pHeader->m_cntUnknownHeaders;
pReq->m_pHttpHeader = pBegin;
pBegin += pReq->m_pHeader->m_httpHeaderLen;
if ( pBegin != pEnd )
{
lsapi_log("Request header does match total size, total: %d, "
"real: %ld\n", totalLen, pBegin - pReq->m_pReqBuf );
return -1;
}
if ( shouldFixEndian )
{
fixHeaderIndexEndian( pReq );
}
if (validateHeaders(pReq) == -1)
{
lsapi_log("Bad request header - ERROR#2\n");
return -1;
}
pReq->m_reqBodyLen = pReq->m_pHeader->m_reqBodyLen;
if ( pReq->m_reqBodyLen == -2 )
{
parseContentLenFromHeader(pReq);
}
return 0;
}
//OPTIMIZATION
static char s_accept_notify = 0;
static char s_schedule_notify = 0;
static char s_notify_scheduled = 0;
static char s_notified_pid = 0;
static struct lsapi_packet_header s_ack = {'L', 'S',
LSAPI_REQ_RECEIVED, LSAPI_ENDIAN, {LSAPI_PACKET_HEADER_LEN} };
static struct lsapi_packet_header s_conn_close_pkt = {'L', 'S',
LSAPI_CONN_CLOSE, LSAPI_ENDIAN, {LSAPI_PACKET_HEADER_LEN} };
static inline int send_notification_pkt( int fd, struct lsapi_packet_header *pkt )
{
if ( write( fd, pkt, LSAPI_PACKET_HEADER_LEN ) < LSAPI_PACKET_HEADER_LEN )
return -1;
return 0;
}
static inline int send_req_received_notification( int fd )
{
return send_notification_pkt(fd, &s_ack);
}
static inline int send_conn_close_notification( int fd )
{
return send_notification_pkt(fd, &s_conn_close_pkt);
}
//static void lsapi_sigalarm( int sig )
//{
// if ( s_notify_scheduled )
// {
// s_notify_scheduled = 0;
// if ( g_req.m_fd != -1 )
// write_req_received_notification( g_req.m_fd );
// }
//}
static inline int lsapi_schedule_notify(void)
{
if ( !s_notify_scheduled )
{
alarm( 2 );
s_notify_scheduled = 1;
}
return 0;
}
static inline int notify_req_received( int fd )
{
if ( s_schedule_notify )
return lsapi_schedule_notify();
return send_req_received_notification( fd );
}
static inline int lsapi_notify_pid( int fd )
{
char achBuf[16];
lsapi_buildPacketHeader( (struct lsapi_packet_header *)achBuf, LSAPI_STDERR_STREAM,
8 + LSAPI_PACKET_HEADER_LEN );
memmove( &achBuf[8], "\0PID", 4 );
*((int *)&achBuf[12]) = getpid();
if ( write( fd, achBuf, 16 ) < 16 )
return -1;
return 0;
}
static int readReq( LSAPI_Request * pReq )
{
int len;
int packetLen;
if ( !pReq )
return -1;
if ( pReq->m_reqBufSize < 8192 )
{
if ( allocateBuf( pReq, 8192 ) == -1 )
return -1;
}
while ( pReq->m_bufRead < LSAPI_PACKET_HEADER_LEN )
{
len = lsapi_read( pReq->m_fd, pReq->m_pReqBuf, pReq->m_reqBufSize );
if ( len <= 0 )
return -1;
pReq->m_bufRead += len;
}
pReq->m_reqState = LSAPI_ST_REQ_HEADER;
packetLen = verifyHeader( &pReq->m_pHeader->m_pktHeader, LSAPI_BEGIN_REQUEST );
if ( packetLen < 0 )
{
lsapi_log("packetLen < 0\n");
return -1;
}
if ( packetLen > LSAPI_MAX_HEADER_LEN )
{
lsapi_log("packetLen > %d\n", LSAPI_MAX_HEADER_LEN );
return -1;
}
if ( packetLen + 1024 > pReq->m_reqBufSize )
{
if ( allocateBuf( pReq, packetLen + 1024 ) == -1 )
return -1;
}
while( packetLen > pReq->m_bufRead )
{
len = lsapi_read( pReq->m_fd, pReq->m_pReqBuf + pReq->m_bufRead, packetLen - pReq->m_bufRead );
if ( len <= 0 )
return -1;
pReq->m_bufRead += len;
}
if ( parseRequest( pReq, packetLen ) < 0 )
{
lsapi_log("ParseRequest error\n");
return -1;
}
pReq->m_reqState = LSAPI_ST_REQ_BODY | LSAPI_ST_RESP_HEADER;
if ( !s_uid )
{
if ( lsapi_changeUGid( pReq ) )
return -1;
memset(s_secret, 0, sizeof(s_secret));
}
pReq->m_bufProcessed = packetLen;
//OPTIMIZATION
if ( !s_accept_notify && !s_notified_pid )
return notify_req_received( pReq->m_fd );
else
{
s_notified_pid = 0;
return 0;
}
}
int LSAPI_Init(void)
{
if ( !g_inited )
{
s_uid = geteuid();
s_secret[0] = 0;
lsapi_signal(SIGPIPE, lsapi_sigpipe);
lsapi_signal(SIGUSR1, lsapi_siguser1);
#if defined(SIGXFSZ) && defined(SIG_IGN)
signal(SIGXFSZ, SIG_IGN);
#endif
/* let STDOUT function as STDERR,
just in case writing to STDOUT directly */
dup2( 2, 1 );
if ( LSAPI_InitRequest( &g_req, LSAPI_SOCK_FILENO ) == -1 )
return -1;
g_inited = 1;
s_ppid = getppid();
void *pthread_lib = dlopen("libpthread.so", RTLD_LAZY);
if (pthread_lib)
pthread_atfork_func = dlsym(pthread_lib, "pthread_atfork");
}
return 0;
}
void LSAPI_Stop(void)
{
g_running = 0;
}
int LSAPI_IsRunning(void)
{
return g_running;
}
void LSAPI_Register_Pgrp_Timer_Callback(LSAPI_On_Timer_pf cb)
{
s_proc_group_timer_cb = cb;
}
int LSAPI_InitRequest( LSAPI_Request * pReq, int fd )
{
int newfd;
if ( !pReq )
return -1;
memset( pReq, 0, sizeof( LSAPI_Request ) );
if ( allocateIovec( pReq, 16 ) == -1 )
return -1;
pReq->m_pRespBuf = pReq->m_pRespBufPos = (char *)malloc( LSAPI_RESP_BUF_SIZE );
if ( !pReq->m_pRespBuf )
return -1;
pReq->m_pRespBufEnd = pReq->m_pRespBuf + LSAPI_RESP_BUF_SIZE;
pReq->m_pIovecCur = pReq->m_pIovecToWrite = pReq->m_pIovec + 1;
pReq->m_respPktHeaderEnd = &pReq->m_respPktHeader[5];
if ( allocateRespHeaderBuf( pReq, LSAPI_INIT_RESP_HEADER_LEN ) == -1 )
return -1;
if ( fd == STDIN_FILENO )
{
fd = dup( fd );
newfd = open( "/dev/null", O_RDWR );
dup2( newfd, STDIN_FILENO );
}
if ( isPipe( fd ) )
{
pReq->m_fdListen = -1;
pReq->m_fd = fd;
}
else
{
pReq->m_fdListen = fd;
pReq->m_fd = -1;
lsapi_set_nblock( fd, 1 );
}
return 0;
}
int LSAPI_Is_Listen( void )
{
return LSAPI_Is_Listen_r( &g_req );
}
int LSAPI_Is_Listen_r( LSAPI_Request * pReq)
{
return pReq->m_fdListen != -1;
}
int LSAPI_Accept_r( LSAPI_Request * pReq )
{
char achPeer[128];
socklen_t len;
int nodelay = 1;
if ( !pReq )
return -1;
if ( LSAPI_Finish_r( pReq ) == -1 )
return -1;
lsapi_set_nblock( pReq->m_fdListen , 0 );
while( g_running )
{
if ( pReq->m_fd == -1 )
{
if ( pReq->m_fdListen != -1)
{
len = sizeof( achPeer );
pReq->m_fd = accept( pReq->m_fdListen,
(struct sockaddr *)&achPeer, &len );
if ( pReq->m_fd == -1 )
{
if (( errno == EINTR )||( errno == EAGAIN))
continue;
else
return -1;
}
else
{
if (s_worker_status)
__atomic_store_n(&s_worker_status->m_state,
LSAPI_STATE_CONNECTED, __ATOMIC_SEQ_CST);
if (s_busy_workers)
__atomic_fetch_add(s_busy_workers, 1, __ATOMIC_SEQ_CST);
lsapi_set_nblock( pReq->m_fd , 0 );
if (((struct sockaddr *)&achPeer)->sa_family == AF_INET )
{
setsockopt(pReq->m_fd, IPPROTO_TCP, TCP_NODELAY,
(char *)&nodelay, sizeof(nodelay));
}
//init_conn_key( pReq->m_fd );
//OPTIMIZATION
if ( s_accept_notify )
if ( notify_req_received( pReq->m_fd ) == -1 )
return -1;
}
}
else
return -1;
}
if ( !readReq( pReq ) )
break;
//abort();
lsapi_close_connection(pReq);
LSAPI_Reset_r( pReq );
}
return 0;
}
static struct lsapi_packet_header finish_close[2] =
{
{'L', 'S', LSAPI_RESP_END, LSAPI_ENDIAN, {LSAPI_PACKET_HEADER_LEN} },
{'L', 'S', LSAPI_CONN_CLOSE, LSAPI_ENDIAN, {LSAPI_PACKET_HEADER_LEN} }
};
int LSAPI_Finish_r( LSAPI_Request * pReq )
{
/* finish req body */
if ( !pReq )
return -1;
if (pReq->m_reqState)
{
if ( pReq->m_fd != -1 )
{
if ( pReq->m_reqState & LSAPI_ST_RESP_HEADER )
{
LSAPI_FinalizeRespHeaders_r( pReq );
}
if ( pReq->m_pRespBufPos != pReq->m_pRespBuf )
{
Flush_RespBuf_r( pReq );
}
pReq->m_pIovecCur->iov_base = (void *)finish_close;
pReq->m_pIovecCur->iov_len = LSAPI_PACKET_HEADER_LEN;
pReq->m_totalLen += LSAPI_PACKET_HEADER_LEN;
++pReq->m_pIovecCur;
LSAPI_Flush_r( pReq );
}
LSAPI_Reset_r( pReq );
}
return 0;
}
int LSAPI_End_Response_r(LSAPI_Request * pReq)
{
if (!pReq)
return -1;
if (pReq->m_reqState & LSAPI_ST_BACKGROUND)
return 0;
if (pReq->m_reqState)
{
if ( pReq->m_fd != -1 )
{
if ( pReq->m_reqState & LSAPI_ST_RESP_HEADER )
{
if ( pReq->m_pRespHeaderBufPos <= pReq->m_pRespHeaderBuf )
return 0;
LSAPI_FinalizeRespHeaders_r( pReq );
}
if ( pReq->m_pRespBufPos != pReq->m_pRespBuf )
{
Flush_RespBuf_r( pReq );
}
pReq->m_pIovecCur->iov_base = (void *)finish_close;
pReq->m_pIovecCur->iov_len = LSAPI_PACKET_HEADER_LEN << 1;
pReq->m_totalLen += LSAPI_PACKET_HEADER_LEN << 1;
++pReq->m_pIovecCur;
LSAPI_Flush_r( pReq );
lsapi_close_connection(pReq);
}
pReq->m_reqState |= LSAPI_ST_BACKGROUND;
}
return 0;
}
void LSAPI_Reset_r( LSAPI_Request * pReq )
{
pReq->m_pRespBufPos = pReq->m_pRespBuf;
pReq->m_pIovecCur = pReq->m_pIovecToWrite = pReq->m_pIovec + 1;
pReq->m_pRespHeaderBufPos = pReq->m_pRespHeaderBuf;
memset( &pReq->m_pHeaderIndex, 0,
(char *)(pReq->m_respHeaderLen) - (char *)&pReq->m_pHeaderIndex );
}
int LSAPI_Release_r( LSAPI_Request * pReq )
{
if ( pReq->m_pReqBuf )
free( pReq->m_pReqBuf );
if ( pReq->m_pSpecialEnvList )
free( pReq->m_pSpecialEnvList );
if ( pReq->m_pEnvList )
free( pReq->m_pEnvList );
if ( pReq->m_pRespHeaderBuf )
free( pReq->m_pRespHeaderBuf );
return 0;
}
char * LSAPI_GetHeader_r( LSAPI_Request * pReq, int headerIndex )
{
int off;
if ( !pReq || ((unsigned int)headerIndex > H_TRANSFER_ENCODING) )
return NULL;
off = pReq->m_pHeaderIndex->m_headerOff[ headerIndex ];
if ( !off )
return NULL;
if ( *(pReq->m_pHttpHeader + off
+ pReq->m_pHeaderIndex->m_headerLen[ headerIndex ]) )
{
*( pReq->m_pHttpHeader + off
+ pReq->m_pHeaderIndex->m_headerLen[ headerIndex ]) = 0;
}
return pReq->m_pHttpHeader + off;
}
static int readBodyToReqBuf( LSAPI_Request * pReq )
{
off_t bodyLeft;
ssize_t len = pReq->m_bufRead - pReq->m_bufProcessed;
if ( len > 0 )
return len;
pReq->m_bufRead = pReq->m_bufProcessed = pReq->m_pHeader->m_pktHeader.m_packetLen.m_iLen;
bodyLeft = pReq->m_reqBodyLen - pReq->m_reqBodyRead;
len = pReq->m_reqBufSize - pReq->m_bufRead;
if ( len < 0 )
return -1;
if ( len > bodyLeft )
len = bodyLeft;
len = lsapi_read( pReq->m_fd, pReq->m_pReqBuf + pReq->m_bufRead, len );
if ( len > 0 )
pReq->m_bufRead += len;
return len;
}
int LSAPI_ReqBodyGetChar_r( LSAPI_Request * pReq )
{
if (!pReq || (pReq->m_fd ==-1) )
return EOF;
if ( pReq->m_bufProcessed >= pReq->m_bufRead )
{
if ( readBodyToReqBuf( pReq ) <= 0 )
return EOF;
}
++pReq->m_reqBodyRead;
return (unsigned char)*(pReq->m_pReqBuf + pReq->m_bufProcessed++);
}
int LSAPI_ReqBodyGetLine_r( LSAPI_Request * pReq, char * pBuf, size_t bufLen, int *getLF )
{
ssize_t len;
ssize_t left;
char * pBufEnd = pBuf + bufLen - 1;
char * pBufCur = pBuf;
char * pCur;
char * p;
if (!pReq || pReq->m_fd == -1 || !pBuf || !getLF)
return -1;
*getLF = 0;
while( (left = pBufEnd - pBufCur ) > 0 )
{
len = pReq->m_bufRead - pReq->m_bufProcessed;
if ( len <= 0 )
{
if ( (len = readBodyToReqBuf( pReq )) <= 0 )
{
*getLF = 1;
break;
}
}
if ( len > left )
len = left;
pCur = pReq->m_pReqBuf + pReq->m_bufProcessed;
p = memchr( pCur, '\n', len );
if ( p )
len = p - pCur + 1;
memmove( pBufCur, pCur, len );
pBufCur += len;
pReq->m_bufProcessed += len;
pReq->m_reqBodyRead += len;
if ( p )
{
*getLF = 1;
break;
}
}
*pBufCur = 0;
return pBufCur - pBuf;
}
ssize_t LSAPI_ReadReqBody_r( LSAPI_Request * pReq, char * pBuf, size_t bufLen )
{
ssize_t len;
off_t total;
/* char *pOldBuf = pBuf; */
if (!pReq || pReq->m_fd == -1 || !pBuf || (ssize_t)bufLen < 0)
return -1;
total = pReq->m_reqBodyLen - pReq->m_reqBodyRead;
if ( total <= 0 )
return 0;
if ( total < (ssize_t)bufLen )
bufLen = total;
total = 0;
len = pReq->m_bufRead - pReq->m_bufProcessed;
if ( len > 0 )
{
if ( len > (ssize_t)bufLen )
len = bufLen;
memmove( pBuf, pReq->m_pReqBuf + pReq->m_bufProcessed, len );
pReq->m_bufProcessed += len;
total += len;
pBuf += len;
bufLen -= len;
}
while( bufLen > 0 )
{
len = lsapi_read( pReq->m_fd, pBuf, bufLen );
if ( len > 0 )
{
total += len;
pBuf += len;
bufLen -= len;
}
else if ( len <= 0 )
{
if ( !total)
return -1;
break;
}
}
pReq->m_reqBodyRead += total;
return total;
}
ssize_t LSAPI_Write_r( LSAPI_Request * pReq, const char * pBuf, size_t len )
{
struct lsapi_packet_header * pHeader;
const char * pEnd;
const char * p;
ssize_t bufLen;
ssize_t toWrite;
ssize_t packetLen;
int skip = 0;
if (!pReq || !pBuf)
return -1;
if (pReq->m_reqState & LSAPI_ST_BACKGROUND)
return len;
if (pReq->m_fd == -1)
return -1;
if ( pReq->m_reqState & LSAPI_ST_RESP_HEADER )
{
LSAPI_FinalizeRespHeaders_r( pReq );
/*
if ( *pBuf == '\r' )
{
++skip;
}
if ( *pBuf == '\n' )
{
++skip;
}
*/
}
pReq->m_reqState |= LSAPI_ST_RESP_BODY;
if ( ((ssize_t)len - skip) < pReq->m_pRespBufEnd - pReq->m_pRespBufPos )
{
memmove( pReq->m_pRespBufPos, pBuf + skip, len - skip );
pReq->m_pRespBufPos += len - skip;
return len;
}
pHeader = pReq->m_respPktHeader;
p = pBuf + skip;
pEnd = pBuf + len;
bufLen = pReq->m_pRespBufPos - pReq->m_pRespBuf;
while( ( toWrite = pEnd - p ) > 0 )
{
packetLen = toWrite + bufLen;
if ( LSAPI_MAX_DATA_PACKET_LEN < packetLen)
{
packetLen = LSAPI_MAX_DATA_PACKET_LEN;
toWrite = packetLen - bufLen;
}
lsapi_buildPacketHeader( pHeader, LSAPI_RESP_STREAM,
packetLen + LSAPI_PACKET_HEADER_LEN );
pReq->m_totalLen += packetLen + LSAPI_PACKET_HEADER_LEN;
pReq->m_pIovecCur->iov_base = (void *)pHeader;
pReq->m_pIovecCur->iov_len = LSAPI_PACKET_HEADER_LEN;
++pReq->m_pIovecCur;
++pHeader;
if ( bufLen > 0 )
{
pReq->m_pIovecCur->iov_base = (void *)pReq->m_pRespBuf;
pReq->m_pIovecCur->iov_len = bufLen;
pReq->m_pRespBufPos = pReq->m_pRespBuf;
++pReq->m_pIovecCur;
bufLen = 0;
}
pReq->m_pIovecCur->iov_base = (void *)p;
pReq->m_pIovecCur->iov_len = toWrite;
++pReq->m_pIovecCur;
p += toWrite;
if ( pHeader >= pReq->m_respPktHeaderEnd - 1)
{
if ( LSAPI_Flush_r( pReq ) == -1 )
return -1;
pHeader = pReq->m_respPktHeader;
}
}
if ( pHeader != pReq->m_respPktHeader )
if ( LSAPI_Flush_r( pReq ) == -1 )
return -1;
return p - pBuf;
}
#if defined(__FreeBSD__ )
ssize_t gsendfile( int fdOut, int fdIn, off_t* off, size_t size )
{
ssize_t ret;
off_t written;
ret = sendfile( fdIn, fdOut, *off, size, NULL, &written, 0 );
if ( written > 0 )
{
ret = written;
*off += ret;
}
return ret;
}
#endif
#if defined(__OpenBSD__) || defined(__NetBSD__)
ssize_t gsendfile( int fdOut, int fdIn, off_t* off, size_t size )
{
ssize_t ret;
off_t written = 0;
const size_t bufsiz = 16384;
unsigned char in[bufsiz] = {0};
if (lseek(fdIn, *off, SEEK_SET) == -1) {
return -1;
}
while (size > 0) {
size_t tor = size > sizeof(in) ? sizeof(in) : size;
ssize_t c = read(fdIn, in, tor);
if (c <= 0) {
goto end;
}
ssize_t w = write(fdOut, in, c);
if (w > 0)
written += w;
if (w != c) {
goto end;
}
size -= c;
}
end:
*off += written;
return 0;
}
#endif
#if defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
ssize_t gsendfile( int fdOut, int fdIn, off_t* off, size_t size )
{
ssize_t ret;
off_t len = size;
ret = sendfile( fdIn, fdOut, *off, &len, NULL, 0 );
if (( ret == 0 )&&( len > 0 ))
{
ret = len;
*off += len;
}
return ret;
}
#endif
#if defined(sun) || defined(__sun)
#include <sys/sendfile.h>
ssize_t gsendfile( int fdOut, int fdIn, off_t *off, size_t size )
{
int n = 0 ;
sendfilevec_t vec[1];
vec[n].sfv_fd = fdIn;
vec[n].sfv_flag = 0;
vec[n].sfv_off = *off;
vec[n].sfv_len = size;
++n;
size_t written;
ssize_t ret = sendfilev( fdOut, vec, n, &written );
if (( !ret )||( errno == EAGAIN ))
ret = written;
if ( ret > 0 )
*off += ret;
return ret;
}
#endif
#if defined(linux) || defined(__linux) || defined(__linux__) || \
defined(__gnu_linux__)
#include <sys/sendfile.h>
#define gsendfile sendfile
#endif
#if defined(HPUX)
ssize_t gsendfile( int fdOut, int fdIn, off_t * off, size_t size )
{
return sendfile( fdOut, fdIn, off, size, NULL, 0 );
}
#endif
ssize_t LSAPI_sendfile_r( LSAPI_Request * pReq, int fdIn, off_t* off, size_t size )
{
struct lsapi_packet_header * pHeader = pReq->m_respPktHeader;
if ( !pReq || (pReq->m_fd == -1) || fdIn == -1 )
return -1;
if ( pReq->m_reqState & LSAPI_ST_RESP_HEADER )
{
LSAPI_FinalizeRespHeaders_r( pReq );
}
pReq->m_reqState |= LSAPI_ST_RESP_BODY;
LSAPI_Flush_r(pReq);
lsapi_buildPacketHeader( pHeader, LSAPI_RESP_STREAM,
size + LSAPI_PACKET_HEADER_LEN );
if (write(pReq->m_fd, (const char *) pHeader, LSAPI_PACKET_HEADER_LEN ) != LSAPI_PACKET_HEADER_LEN)
return -1;
return gsendfile( pReq->m_fd, fdIn, off, size );
}
void Flush_RespBuf_r( LSAPI_Request * pReq )
{
struct lsapi_packet_header * pHeader = pReq->m_respPktHeader;
int bufLen = pReq->m_pRespBufPos - pReq->m_pRespBuf;
pReq->m_reqState |= LSAPI_ST_RESP_BODY;
lsapi_buildPacketHeader( pHeader, LSAPI_RESP_STREAM,
bufLen + LSAPI_PACKET_HEADER_LEN );
pReq->m_totalLen += bufLen + LSAPI_PACKET_HEADER_LEN;
pReq->m_pIovecCur->iov_base = (void *)pHeader;
pReq->m_pIovecCur->iov_len = LSAPI_PACKET_HEADER_LEN;
++pReq->m_pIovecCur;
++pHeader;
if ( bufLen > 0 )
{
pReq->m_pIovecCur->iov_base = (void *)pReq->m_pRespBuf;
pReq->m_pIovecCur->iov_len = bufLen;
pReq->m_pRespBufPos = pReq->m_pRespBuf;
++pReq->m_pIovecCur;
bufLen = 0;
}
}
int LSAPI_Flush_r( LSAPI_Request * pReq )
{
int ret = 0;
int n;
if ( !pReq )
return -1;
n = pReq->m_pIovecCur - pReq->m_pIovecToWrite;
if (( 0 == n )&&( pReq->m_pRespBufPos == pReq->m_pRespBuf ))
return 0;
if ( pReq->m_fd == -1 )
{
pReq->m_pRespBufPos = pReq->m_pRespBuf;
pReq->m_totalLen = 0;
pReq->m_pIovecCur = pReq->m_pIovecToWrite = pReq->m_pIovec;
return -1;
}
if ( pReq->m_reqState & LSAPI_ST_RESP_HEADER )
{
LSAPI_FinalizeRespHeaders_r( pReq );
}
if ( pReq->m_pRespBufPos != pReq->m_pRespBuf )
{
Flush_RespBuf_r( pReq );
}
n = pReq->m_pIovecCur - pReq->m_pIovecToWrite;
if ( n > 0 )
{
ret = lsapi_writev( pReq->m_fd, &pReq->m_pIovecToWrite,
n, pReq->m_totalLen );
if ( ret < pReq->m_totalLen )
{
lsapi_close_connection(pReq);
ret = -1;
}
pReq->m_totalLen = 0;
pReq->m_pIovecCur = pReq->m_pIovecToWrite = pReq->m_pIovec;
}
return ret;
}
ssize_t LSAPI_Write_Stderr_r( LSAPI_Request * pReq, const char * pBuf, size_t len )
{
struct lsapi_packet_header header;
const char * pEnd;
const char * p;
ssize_t packetLen;
ssize_t totalLen;
int ret;
struct iovec iov[2];
struct iovec *pIov;
if ( !pReq )
return -1;
if (s_stderr_log_path || pReq->m_fd == -1 || pReq->m_fd == pReq->m_fdListen)
return write( 2, pBuf, len );
if ( pReq->m_pRespBufPos != pReq->m_pRespBuf )
{
LSAPI_Flush_r( pReq );
}
p = pBuf;
pEnd = pBuf + len;
while( ( packetLen = pEnd - p ) > 0 )
{
if ( LSAPI_MAX_DATA_PACKET_LEN < packetLen)
{
packetLen = LSAPI_MAX_DATA_PACKET_LEN;
}
lsapi_buildPacketHeader( &header, LSAPI_STDERR_STREAM,
packetLen + LSAPI_PACKET_HEADER_LEN );
totalLen = packetLen + LSAPI_PACKET_HEADER_LEN;
iov[0].iov_base = (void *)&header;
iov[0].iov_len = LSAPI_PACKET_HEADER_LEN;
iov[1].iov_base = (void *)p;
iov[1].iov_len = packetLen;
p += packetLen;
pIov = iov;
ret = lsapi_writev( pReq->m_fd, &pIov,
2, totalLen );
if ( ret < totalLen )
{
lsapi_close_connection(pReq);
ret = -1;
}
}
return p - pBuf;
}
static char * GetHeaderVar( LSAPI_Request * pReq, const char * name )
{
int i;
char * pValue;
for( i = 0; i < H_TRANSFER_ENCODING; ++i )
{
if ( pReq->m_pHeaderIndex->m_headerOff[i] )
{
if ( strcmp( name, CGI_HEADERS[i] ) == 0 )
{
pValue = pReq->m_pHttpHeader
+ pReq->m_pHeaderIndex->m_headerOff[i];
if ( *(pValue + pReq->m_pHeaderIndex->m_headerLen[i]) != '\0')
{
*(pValue + pReq->m_pHeaderIndex->m_headerLen[i]) = '\0';
}
return pValue;
}
}
}
if ( pReq->m_pHeader->m_cntUnknownHeaders > 0 )
{
const char *p;
char *pKey;
char *pKeyEnd;
int keyLen;
struct lsapi_header_offset * pCur, *pEnd;
pCur = pReq->m_pUnknownHeader;
pEnd = pCur + pReq->m_pHeader->m_cntUnknownHeaders;
while( pCur < pEnd )
{
pKey = pReq->m_pHttpHeader + pCur->nameOff;
keyLen = pCur->nameLen;
pKeyEnd = pKey + keyLen;
p = &name[5];
while(( pKey < pKeyEnd )&&( *p ))
{
char ch = toupper( *pKey );
if ((ch != *p )||(( *p == '_' )&&( ch != '-')))
break;
++p; ++pKey;
}
if (( pKey == pKeyEnd )&& (!*p ))
{
pValue = pReq->m_pHttpHeader + pCur->valueOff;
if ( *(pValue + pCur->valueLen) != '\0')
{
*(pValue + pCur->valueLen) = '\0';
}
return pValue;
}
++pCur;
}
}
return NULL;
}
char * LSAPI_GetEnv_r( LSAPI_Request * pReq, const char * name )
{
struct LSAPI_key_value_pair * pBegin = pReq->m_pEnvList;
struct LSAPI_key_value_pair * pEnd = pBegin + pReq->m_pHeader->m_cntEnv;
if ( !pReq || !name )
return NULL;
if ( strncmp( name, "HTTP_", 5 ) == 0 )
{
return GetHeaderVar( pReq, name );
}
while( pBegin < pEnd )
{
if ( strcmp( name, pBegin->pKey ) == 0 )
return pBegin->pValue;
++pBegin;
}
return NULL;
}
struct _headerInfo
{
const char * _name;
int _nameLen;
const char * _value;
int _valueLen;
};
int compareValueLocation(const void * v1, const void *v2 )
{
return ((const struct _headerInfo *)v1)->_value -
((const struct _headerInfo *)v2)->_value;
}
int LSAPI_ForeachOrgHeader_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg )
{
int i;
int len = 0;
char * pValue;
int ret;
int count = 0;
struct _headerInfo headers[512];
if ( !pReq || !fn )
return -1;
if ( !pReq->m_pHeaderIndex )
return 0;
for( i = 0; i < H_TRANSFER_ENCODING; ++i )
{
if ( pReq->m_pHeaderIndex->m_headerOff[i] )
{
len = pReq->m_pHeaderIndex->m_headerLen[i];
pValue = pReq->m_pHttpHeader + pReq->m_pHeaderIndex->m_headerOff[i];
*(pValue + len ) = 0;
headers[count]._name = HTTP_HEADERS[i];
headers[count]._nameLen = HTTP_HEADER_LEN[i];
headers[count]._value = pValue;
headers[count]._valueLen = len;
++count;
//ret = (*fn)( HTTP_HEADERS[i], HTTP_HEADER_LEN[i],
// pValue, len, arg );
//if ( ret <= 0 )
// return ret;
}
}
if ( pReq->m_pHeader->m_cntUnknownHeaders > 0 )
{
char *pKey;
int keyLen;
struct lsapi_header_offset * pCur, *pEnd;
pCur = pReq->m_pUnknownHeader;
pEnd = pCur + pReq->m_pHeader->m_cntUnknownHeaders;
while( pCur < pEnd )
{
pKey = pReq->m_pHttpHeader + pCur->nameOff;
keyLen = pCur->nameLen;
*(pKey + keyLen ) = 0;
pValue = pReq->m_pHttpHeader + pCur->valueOff;
*(pValue + pCur->valueLen ) = 0;
headers[count]._name = pKey;
headers[count]._nameLen = keyLen;
headers[count]._value = pValue;
headers[count]._valueLen = pCur->valueLen;
++count;
if ( count == 512 )
break;
//ret = (*fn)( pKey, keyLen,
// pValue, pCur->valueLen, arg );
//if ( ret <= 0 )
// return ret;
++pCur;
}
}
qsort( headers, count, sizeof( struct _headerInfo ), compareValueLocation );
for( i = 0; i < count; ++i )
{
ret = (*fn)( headers[i]._name, headers[i]._nameLen,
headers[i]._value, headers[i]._valueLen, arg );
if ( ret <= 0 )
return ret;
}
return count;
}
int LSAPI_ForeachHeader_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg )
{
int i;
int len = 0;
char * pValue;
int ret;
int count = 0;
if ( !pReq || !fn )
return -1;
for( i = 0; i < H_TRANSFER_ENCODING; ++i )
{
if ( pReq->m_pHeaderIndex->m_headerOff[i] )
{
len = pReq->m_pHeaderIndex->m_headerLen[i];
pValue = pReq->m_pHttpHeader + pReq->m_pHeaderIndex->m_headerOff[i];
*(pValue + len ) = 0;
ret = (*fn)( CGI_HEADERS[i], CGI_HEADER_LEN[i],
pValue, len, arg );
++count;
if ( ret <= 0 )
return ret;
}
}
if ( pReq->m_pHeader->m_cntUnknownHeaders > 0 )
{
char achHeaderName[256];
char *p;
char *pKey;
char *pKeyEnd ;
int keyLen;
struct lsapi_header_offset * pCur, *pEnd;
pCur = pReq->m_pUnknownHeader;
pEnd = pCur + pReq->m_pHeader->m_cntUnknownHeaders;
while( pCur < pEnd )
{
pKey = pReq->m_pHttpHeader + pCur->nameOff;
keyLen = pCur->nameLen;
if ( keyLen > 250 )
keyLen = 250;
pKeyEnd = pKey + keyLen;
memcpy( achHeaderName, "HTTP_", 5 );
p = &achHeaderName[5];
while( pKey < pKeyEnd )
{
char ch = *pKey++;
if ( ch == '-' )
*p++ = '_';
else
*p++ = toupper( ch );
}
*p = 0;
keyLen += 5;
pValue = pReq->m_pHttpHeader + pCur->valueOff;
*(pValue + pCur->valueLen ) = 0;
ret = (*fn)( achHeaderName, keyLen,
pValue, pCur->valueLen, arg );
if ( ret <= 0 )
return ret;
++pCur;
}
}
return count + pReq->m_pHeader->m_cntUnknownHeaders;
}
static int EnvForeach( struct LSAPI_key_value_pair * pEnv,
int n, LSAPI_CB_EnvHandler fn, void * arg )
{
struct LSAPI_key_value_pair * pEnd = pEnv + n;
int ret;
if ( !pEnv || !fn )
return -1;
while( pEnv < pEnd )
{
ret = (*fn)( pEnv->pKey, pEnv->keyLen,
pEnv->pValue, pEnv->valLen, arg );
if ( ret <= 0 )
return ret;
++pEnv;
}
return n;
}
int LSAPI_ForeachEnv_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg )
{
if ( !pReq || !fn )
return -1;
if ( pReq->m_pHeader->m_cntEnv > 0 )
{
return EnvForeach( pReq->m_pEnvList, pReq->m_pHeader->m_cntEnv,
fn, arg );
}
return 0;
}
int LSAPI_ForeachSpecialEnv_r( LSAPI_Request * pReq,
LSAPI_CB_EnvHandler fn, void * arg )
{
if ( !pReq || !fn )
return -1;
if ( pReq->m_pHeader->m_cntSpecialEnv > 0 )
{
return EnvForeach( pReq->m_pSpecialEnvList,
pReq->m_pHeader->m_cntSpecialEnv,
fn, arg );
}
return 0;
}
int LSAPI_FinalizeRespHeaders_r( LSAPI_Request * pReq )
{
if ( !pReq || !pReq->m_pIovec )
return -1;
if ( !( pReq->m_reqState & LSAPI_ST_RESP_HEADER ) )
return 0;
pReq->m_reqState &= ~LSAPI_ST_RESP_HEADER;
if ( pReq->m_pRespHeaderBufPos > pReq->m_pRespHeaderBuf )
{
pReq->m_pIovecCur->iov_base = (void *)pReq->m_pRespHeaderBuf;
pReq->m_pIovecCur->iov_len = pReq->m_pRespHeaderBufPos - pReq->m_pRespHeaderBuf;
pReq->m_totalLen += pReq->m_pIovecCur->iov_len;
++pReq->m_pIovecCur;
}
pReq->m_pIovec->iov_len = sizeof( struct lsapi_resp_header)
+ pReq->m_respHeader.m_respInfo.m_cntHeaders * sizeof( short );
pReq->m_totalLen += pReq->m_pIovec->iov_len;
lsapi_buildPacketHeader( &pReq->m_respHeader.m_pktHeader,
LSAPI_RESP_HEADER, pReq->m_totalLen );
pReq->m_pIovec->iov_base = (void *)&pReq->m_respHeader;
pReq->m_pIovecToWrite = pReq->m_pIovec;
return 0;
}
int LSAPI_AppendRespHeader2_r( LSAPI_Request * pReq, const char * pHeaderName,
const char * pHeaderValue )
{
int nameLen, valLen, len;
if ( !pReq || !pHeaderName || !pHeaderValue )
return -1;
if ( pReq->m_reqState & LSAPI_ST_RESP_BODY )
return -1;
if ( pReq->m_respHeader.m_respInfo.m_cntHeaders >= LSAPI_MAX_RESP_HEADERS )
return -1;
nameLen = strlen( pHeaderName );
valLen = strlen( pHeaderValue );
if ( nameLen == 0 )
return -1;
while( nameLen > 0 )
{
char ch = *(pHeaderName + nameLen - 1 );
if (( ch == '\n' )||( ch == '\r' ))
--nameLen;
else
break;
}
if ( nameLen <= 0 )
return 0;
while( valLen > 0 )
{
char ch = *(pHeaderValue + valLen - 1 );
if (( ch == '\n' )||( ch == '\r' ))
--valLen;
else
break;
}
len = nameLen + valLen + 1;
if ( len > LSAPI_RESP_HTTP_HEADER_MAX )
return -1;
if ( pReq->m_pRespHeaderBufPos + len + 1 > pReq->m_pRespHeaderBufEnd )
{
int newlen = pReq->m_pRespHeaderBufPos + len + 4096 - pReq->m_pRespHeaderBuf;
newlen -= newlen % 4096;
if ( allocateRespHeaderBuf( pReq, newlen ) == -1 )
return -1;
}
memmove( pReq->m_pRespHeaderBufPos, pHeaderName, nameLen );
pReq->m_pRespHeaderBufPos += nameLen;
*pReq->m_pRespHeaderBufPos++ = ':';
memmove( pReq->m_pRespHeaderBufPos, pHeaderValue, valLen );
pReq->m_pRespHeaderBufPos += valLen;
*pReq->m_pRespHeaderBufPos++ = 0;
++len; /* add one byte padding for \0 */
pReq->m_respHeaderLen[pReq->m_respHeader.m_respInfo.m_cntHeaders] = len;
++pReq->m_respHeader.m_respInfo.m_cntHeaders;
return 0;
}
int LSAPI_AppendRespHeader_r( LSAPI_Request * pReq, const char * pBuf, int len )
{
if ( !pReq || !pBuf || len <= 0 || len > LSAPI_RESP_HTTP_HEADER_MAX )
return -1;
if ( pReq->m_reqState & LSAPI_ST_RESP_BODY )
return -1;
if ( pReq->m_respHeader.m_respInfo.m_cntHeaders >= LSAPI_MAX_RESP_HEADERS )
return -1;
while( len > 0 )
{
char ch = *(pBuf + len - 1 );
if (( ch == '\n' )||( ch == '\r' ))
--len;
else
break;
}
if ( len <= 0 )
return 0;
if ( pReq->m_pRespHeaderBufPos + len + 1 > pReq->m_pRespHeaderBufEnd )
{
int newlen = pReq->m_pRespHeaderBufPos + len + 4096 - pReq->m_pRespHeaderBuf;
newlen -= newlen % 4096;
if ( allocateRespHeaderBuf( pReq, newlen ) == -1 )
return -1;
}
memmove( pReq->m_pRespHeaderBufPos, pBuf, len );
pReq->m_pRespHeaderBufPos += len;
*pReq->m_pRespHeaderBufPos++ = 0;
++len; /* add one byte padding for \0 */
pReq->m_respHeaderLen[pReq->m_respHeader.m_respInfo.m_cntHeaders] = len;
++pReq->m_respHeader.m_respInfo.m_cntHeaders;
return 0;
}
int LSAPI_CreateListenSock2( const struct sockaddr * pServerAddr, int backlog )
{
int ret;
int fd;
int flag = 1;
int addr_len;
switch( pServerAddr->sa_family )
{
case AF_INET:
addr_len = 16;
break;
case AF_INET6:
addr_len = sizeof( struct sockaddr_in6 );
break;
case AF_UNIX:
addr_len = sizeof( struct sockaddr_un );
unlink( ((struct sockaddr_un *)pServerAddr)->sun_path );
break;
default:
return -1;
}
fd = socket( pServerAddr->sa_family, SOCK_STREAM, 0 );
if ( fd == -1 )
return -1;
fcntl( fd, F_SETFD, FD_CLOEXEC );
if(setsockopt( fd, SOL_SOCKET, SO_REUSEADDR,
(char *)( &flag ), sizeof(flag)) == 0)
{
ret = bind( fd, pServerAddr, addr_len );
if ( !ret )
{
ret = listen( fd, backlog );
if ( !ret )
return fd;
}
}
ret = errno;
close(fd);
errno = ret;
return -1;
}
int LSAPI_ParseSockAddr( const char * pBind, struct sockaddr * pAddr )
{
char achAddr[256];
char * p = achAddr;
char * pEnd;
struct addrinfo *res, hints;
int doAddrInfo = 0;
int port;
if ( !pBind )
return -1;
while( isspace( *pBind ) )
++pBind;
strncpy(achAddr, pBind, 255);
achAddr[255] = 0;
switch( *p )
{
case '/':
pAddr->sa_family = AF_UNIX;
strncpy( ((struct sockaddr_un *)pAddr)->sun_path, p,
sizeof(((struct sockaddr_un *)pAddr)->sun_path) );
return 0;
case '[':
pAddr->sa_family = AF_INET6;
++p;
pEnd = strchr( p, ']' );
if ( !pEnd )
return -1;
*pEnd++ = 0;
if ( *p == '*' )
{
strcpy( achAddr, "::" );
p = achAddr;
}
doAddrInfo = 1;
break;
default:
pAddr->sa_family = AF_INET;
pEnd = strchr( p, ':' );
if ( !pEnd )
return -1;
*pEnd++ = 0;
doAddrInfo = 0;
if ( *p == '*' )
{
((struct sockaddr_in *)pAddr)->sin_addr.s_addr = htonl(INADDR_ANY);
}
else if (!strcasecmp( p, "localhost" ) )
((struct sockaddr_in *)pAddr)->sin_addr.s_addr = htonl( INADDR_LOOPBACK );
else
{
#ifdef HAVE_INET_PTON
if (!inet_pton(AF_INET, p, &((struct sockaddr_in *)pAddr)->sin_addr))
#else
((struct sockaddr_in *)pAddr)->sin_addr.s_addr = inet_addr( p );
if ( ((struct sockaddr_in *)pAddr)->sin_addr.s_addr == INADDR_BROADCAST)
#endif
{
doAddrInfo = 1;
}
}
break;
}
if ( *pEnd == ':' )
++pEnd;
port = atoi( pEnd );
if (( port <= 0 )||( port > 65535 ))
return -1;
if ( doAddrInfo )
{
memset(&hints, 0, sizeof(hints));
hints.ai_family = pAddr->sa_family;
hints.ai_socktype = SOCK_STREAM;
hints.ai_protocol = IPPROTO_TCP;
if ( getaddrinfo(p, NULL, &hints, &res) )
{
return -1;
}
memcpy(pAddr, res->ai_addr, res->ai_addrlen);
freeaddrinfo(res);
}
if ( pAddr->sa_family == AF_INET )
((struct sockaddr_in *)pAddr)->sin_port = htons( port );
else
((struct sockaddr_in6 *)pAddr)->sin6_port = htons( port );
return 0;
}
int LSAPI_CreateListenSock( const char * pBind, int backlog )
{
char serverAddr[128];
int ret;
int fd = -1;
ret = LSAPI_ParseSockAddr( pBind, (struct sockaddr *)serverAddr );
if ( !ret )
{
fd = LSAPI_CreateListenSock2( (struct sockaddr *)serverAddr, backlog );
}
return fd;
}
static fn_select_t g_fnSelect = select;
typedef struct _lsapi_prefork_server
{
int m_fd;
int m_iMaxChildren;
int m_iExtraChildren;
int m_iCurChildren;
int m_iMaxIdleChildren;
int m_iServerMaxIdle;
int m_iChildrenMaxIdleTime;
int m_iMaxReqProcessTime;
int m_iAvoidFork;
lsapi_child_status * m_pChildrenStatus;
lsapi_child_status * m_pChildrenStatusCur;
lsapi_child_status * m_pChildrenStatusEnd;
}lsapi_prefork_server;
static lsapi_prefork_server * g_prefork_server = NULL;
int LSAPI_Init_Prefork_Server( int max_children, fn_select_t fp, int avoidFork )
{
if ( g_prefork_server )
return 0;
if ( max_children <= 1 )
return -1;
if ( max_children >= 10000)
max_children = 10000;
if (s_max_busy_workers == 0)
s_max_busy_workers = max_children / 2 + 1;
g_prefork_server = (lsapi_prefork_server *)malloc( sizeof( lsapi_prefork_server ) );
if ( !g_prefork_server )
return -1;
memset( g_prefork_server, 0, sizeof( lsapi_prefork_server ) );
if ( fp != NULL )
g_fnSelect = fp;
s_ppid = getppid();
s_pid = getpid();
setpgid( s_pid, s_pid );
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
s_total_pages = sysconf(_SC_PHYS_PAGES);
#endif
g_prefork_server->m_iAvoidFork = avoidFork;
g_prefork_server->m_iMaxChildren = max_children;
g_prefork_server->m_iExtraChildren = ( avoidFork ) ? 0 : (max_children / 3) ;
g_prefork_server->m_iMaxIdleChildren = ( avoidFork ) ? (max_children + 1) : (max_children / 3);
if ( g_prefork_server->m_iMaxIdleChildren == 0 )
g_prefork_server->m_iMaxIdleChildren = 1;
g_prefork_server->m_iChildrenMaxIdleTime = 300;
g_prefork_server->m_iMaxReqProcessTime = 3600;
setsid();
return 0;
}
void LSAPI_Set_Server_fd( int fd )
{
if( g_prefork_server )
g_prefork_server->m_fd = fd;
}
static int lsapi_accept( int fdListen )
{
int fd;
int nodelay = 1;
socklen_t len;
char achPeer[128];
len = sizeof( achPeer );
fd = accept( fdListen, (struct sockaddr *)&achPeer, &len );
if ( fd != -1 )
{
if (((struct sockaddr *)&achPeer)->sa_family == AF_INET )
{
setsockopt( fd, IPPROTO_TCP, TCP_NODELAY,
(char *)&nodelay, sizeof(nodelay));
}
//OPTIMIZATION
//if ( s_accept_notify )
// notify_req_received( fd );
}
return fd;
}
static unsigned int s_max_reqs = UINT_MAX;
static int s_max_idle_secs = 300;
static int s_stop;
static void lsapi_cleanup(int signal)
{
s_stop = signal;
}
static lsapi_child_status * find_child_status( int pid )
{
lsapi_child_status * pStatus = g_prefork_server->m_pChildrenStatus;
lsapi_child_status * pEnd = g_prefork_server->m_pChildrenStatusEnd;
while( pStatus < pEnd )
{
if ( pStatus->m_pid == pid )
{
if (pid == 0)
{
memset(pStatus, 0, sizeof( *pStatus ) );
pStatus->m_pid = -1;
}
if ( pStatus + 1 > g_prefork_server->m_pChildrenStatusCur )
g_prefork_server->m_pChildrenStatusCur = pStatus + 1;
return pStatus;
}
++pStatus;
}
return NULL;
}
void LSAPI_reset_server_state( void )
{
/*
Reset child status
*/
g_prefork_server->m_iCurChildren = 0;
lsapi_child_status * pStatus = g_prefork_server->m_pChildrenStatus;
lsapi_child_status * pEnd = g_prefork_server->m_pChildrenStatusEnd;
while( pStatus < pEnd )
{
pStatus->m_pid = 0;
++pStatus;
}
if (s_busy_workers)
__atomic_store_n(s_busy_workers, 0, __ATOMIC_SEQ_CST);
if (s_accepting_workers)
__atomic_store_n(s_accepting_workers, 0, __ATOMIC_SEQ_CST);
}
static void lsapi_sigchild( int signal )
{
int status, pid;
char expect_connected = LSAPI_STATE_CONNECTED;
char expect_accepting = LSAPI_STATE_ACCEPTING;
lsapi_child_status * child_status;
if (g_prefork_server == NULL)
return;
while( 1 )
{
pid = waitpid( -1, &status, WNOHANG|WUNTRACED );
if ( pid <= 0 )
{
break;
}
if ( WIFSIGNALED( status ))
{
int sig_num = WTERMSIG( status );
#ifdef WCOREDUMP
const char * dump = WCOREDUMP( status ) ? "yes" : "no";
#else
const char * dump = "unknown";
#endif
lsapi_log("Child process with pid: %d was killed by signal: "
"%d, core dumped: %s\n", pid, sig_num, dump );
}
if ( pid == s_pid_dump_debug_info )
{
pid = 0;
continue;
}
if ( pid == s_ignore_pid )
{
pid = 0;
s_ignore_pid = -1;
continue;
}
child_status = find_child_status( pid );
if ( child_status )
{
if (__atomic_compare_exchange_n(&child_status->m_state,
&expect_connected,
LSAPI_STATE_IDLE, 1,
__ATOMIC_SEQ_CST,
__ATOMIC_SEQ_CST))
{
if (s_busy_workers)
__atomic_fetch_sub(s_busy_workers, 1, __ATOMIC_SEQ_CST);
}
else if (__atomic_compare_exchange_n(&child_status->m_state,
&expect_accepting,
LSAPI_STATE_IDLE, 1,
__ATOMIC_SEQ_CST,
__ATOMIC_SEQ_CST))
{
if (s_accepting_workers)
__atomic_fetch_sub(s_accepting_workers, 1, __ATOMIC_SEQ_CST);
}
child_status->m_pid = 0;
--g_prefork_server->m_iCurChildren;
}
}
while(( g_prefork_server->m_pChildrenStatusCur > g_prefork_server->m_pChildrenStatus )
&&( g_prefork_server->m_pChildrenStatusCur[-1].m_pid == 0 ))
--g_prefork_server->m_pChildrenStatusCur;
}
static int lsapi_init_children_status(void)
{
char * pBuf;
int size = 4096;
int max_children;
if (g_prefork_server->m_pChildrenStatus)
return 0;
max_children = g_prefork_server->m_iMaxChildren
+ g_prefork_server->m_iExtraChildren;
size = max_children * sizeof( lsapi_child_status ) * 2 + 3 * sizeof(int);
size = (size + 4095) / 4096 * 4096;
pBuf =( char*) mmap( NULL, size, PROT_READ | PROT_WRITE,
MAP_ANON | MAP_SHARED, -1, 0 );
if ( pBuf == MAP_FAILED )
{
perror( "Anonymous mmap() failed" );
return -1;
}
memset( pBuf, 0, size );
g_prefork_server->m_pChildrenStatus = (lsapi_child_status *)pBuf;
g_prefork_server->m_pChildrenStatusCur = (lsapi_child_status *)pBuf;
g_prefork_server->m_pChildrenStatusEnd = (lsapi_child_status *)pBuf + max_children;
s_busy_workers = (int *)g_prefork_server->m_pChildrenStatusEnd;
s_accepting_workers = s_busy_workers + 1;
s_global_counter = s_accepting_workers + 1;
s_avail_pages = (size_t *)(s_global_counter + 1);
setsid();
return 0;
}
static void dump_debug_info( lsapi_child_status * pStatus, long tmCur )
{
char achCmd[1024];
if ( s_pid_dump_debug_info )
{
if ( kill( s_pid_dump_debug_info, 0 ) == 0 )
return;
}
lsapi_log("Possible runaway process, UID: %d, PPID: %d, PID: %d, "
"reqCount: %d, process time: %ld, checkpoint time: %ld, start "
"time: %ld\n", getuid(), getppid(), pStatus->m_pid,
pStatus->m_iReqCounter, tmCur - pStatus->m_tmReqBegin,
tmCur - pStatus->m_tmLastCheckPoint, tmCur - pStatus->m_tmStart );
s_pid_dump_debug_info = fork();
if (s_pid_dump_debug_info == 0)
{
snprintf( achCmd, 1024, "gdb --batch -ex \"attach %d\" -ex \"set height 0\" "
"-ex \"bt\" >&2;PATH=$PATH:/usr/sbin lsof -p %d >&2",
pStatus->m_pid, pStatus->m_pid );
if ( system( achCmd ) == -1 )
perror( "system()" );
exit( 0 );
}
}
static void lsapi_check_child_status( long tmCur )
{
int idle = 0;
int tobekilled;
int dying = 0;
int count = 0;
lsapi_child_status * pStatus = g_prefork_server->m_pChildrenStatus;
lsapi_child_status * pEnd = g_prefork_server->m_pChildrenStatusCur;
while( pStatus < pEnd )
{
tobekilled = 0;
if ( pStatus->m_pid != 0 && pStatus->m_pid != -1)
{
++count;
if ( !pStatus->m_inProcess )
{
if (g_prefork_server->m_iCurChildren - dying
> g_prefork_server->m_iMaxChildren
|| idle > g_prefork_server->m_iMaxIdleChildren)
{
++pStatus->m_iKillSent;
//tobekilled = SIGUSR1;
}
else
{
if (s_max_idle_secs> 0
&& tmCur - pStatus->m_tmWaitBegin > s_max_idle_secs + 5)
{
++pStatus->m_iKillSent;
//tobekilled = SIGUSR1;
}
}
if (!pStatus->m_iKillSent)
++idle;
}
else
{
if (tmCur - pStatus->m_tmReqBegin >
g_prefork_server->m_iMaxReqProcessTime)
{
if ((pStatus->m_iKillSent % 5) == 0 && s_dump_debug_info)
dump_debug_info( pStatus, tmCur );
if ( pStatus->m_iKillSent > 5 )
{
tobekilled = SIGKILL;
lsapi_log("Force killing runaway process PID: %d"
" with SIGKILL\n", pStatus->m_pid );
}
else
{
tobekilled = SIGTERM;
lsapi_log("Killing runaway process PID: %d with "
"SIGTERM\n", pStatus->m_pid );
}
}
}
if ( tobekilled )
{
if (( kill( pStatus->m_pid, tobekilled ) == -1 ) &&
( errno == ESRCH ))
{
pStatus->m_pid = 0;
--count;
}
else
{
++pStatus->m_iKillSent;
++dying;
}
}
}
++pStatus;
}
if ( abs( g_prefork_server->m_iCurChildren - count ) > 1 )
{
lsapi_log("Children tracking is wrong: Cur Children: %d,"
" count: %d, idle: %d, dying: %d\n",
g_prefork_server->m_iCurChildren, count, idle, dying );
}
}
//static int lsapi_all_children_must_die(void)
//{
// int maxWait;
// int sec =0;
// g_prefork_server->m_iMaxReqProcessTime = 10;
// g_prefork_server->m_iMaxIdleChildren = -1;
// maxWait = 15;
//
// while( g_prefork_server->m_iCurChildren && (sec < maxWait) )
// {
// lsapi_check_child_status(time(NULL));
// sleep( 1 );
// sec++;
// }
// if ( g_prefork_server->m_iCurChildren != 0 )
// kill( -getpgrp(), SIGKILL );
// return 0;
//}
void set_skip_write(void)
{ s_skip_write = 1; }
int is_enough_free_mem(void)
{
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
//minimum 1GB or 10% available free memory
return (*s_avail_pages > s_min_avail_pages
|| (*s_avail_pages * 10) / s_total_pages > 0);
#endif
return 1;
}
static int lsapi_prefork_server_accept( lsapi_prefork_server * pServer,
LSAPI_Request * pReq )
{
struct sigaction act, old_term, old_quit, old_int,
old_usr1, old_child;
lsapi_child_status * child_status;
int wait_secs = 0;
int ret = 0;
int pid;
time_t lastTime = 0;
time_t curTime = 0;
fd_set readfds;
struct timeval timeout;
sigset_t mask;
sigset_t orig_mask;
lsapi_init_children_status();
act.sa_flags = 0;
act.sa_handler = lsapi_sigchild;
sigemptyset(&(act.sa_mask));
if( sigaction( SIGCHLD, &act, &old_child ) )
{
perror( "Can't set signal handler for SIGCHILD" );
return -1;
}
/* Set up handler to kill children upon exit */
act.sa_flags = 0;
act.sa_handler = lsapi_cleanup;
sigemptyset(&(act.sa_mask));
if( sigaction( SIGTERM, &act, &old_term ) ||
sigaction( SIGINT, &act, &old_int ) ||
sigaction( SIGUSR1, &act, &old_usr1 ) ||
sigaction( SIGQUIT, &act, &old_quit ))
{
perror( "Can't set signals" );
return -1;
}
while( !s_stop )
{
if (s_proc_group_timer_cb != NULL) {
s_proc_group_timer_cb(&s_ignore_pid);
}
curTime = time( NULL );
if (curTime != lastTime )
{
lastTime = curTime;
if (lsapi_parent_dead())
break;
lsapi_check_child_status(curTime );
if (pServer->m_iServerMaxIdle)
{
if ( pServer->m_iCurChildren <= 0 )
{
++wait_secs;
if ( wait_secs > pServer->m_iServerMaxIdle )
return -1;
}
else
wait_secs = 0;
}
}
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
*s_avail_pages = sysconf(_SC_AVPHYS_PAGES);
// lsapi_log("Memory total: %zd, free: %zd, free %%%zd\n",
// s_total_pages, *s_avail_pages, *s_avail_pages * 100 / s_total_pages);
#endif
FD_ZERO( &readfds );
FD_SET( pServer->m_fd, &readfds );
timeout.tv_sec = 1;
timeout.tv_usec = 0;
ret = (*g_fnSelect)(pServer->m_fd+1, &readfds, NULL, NULL, &timeout);
if (ret == 1 )
{
int accepting = 0;
if (s_accepting_workers)
accepting = __atomic_load_n(s_accepting_workers, __ATOMIC_SEQ_CST);
if (pServer->m_iCurChildren > 0
&& accepting > 0)
{
usleep(400);
while(accepting-- > 0)
sched_yield();
continue;
}
}
else if ( ret == -1 )
{
if ( errno == EINTR )
continue;
/* perror( "select()" ); */
break;
}
else
{
continue;
}
if (pServer->m_iCurChildren >=
pServer->m_iMaxChildren + pServer->m_iExtraChildren)
{
lsapi_log("Reached max children process limit: %d, extra: %d,"
" current: %d, busy: %d, please increase LSAPI_CHILDREN.\n",
pServer->m_iMaxChildren, pServer->m_iExtraChildren,
pServer->m_iCurChildren,
s_busy_workers ? *s_busy_workers : -1 );
usleep( 100000 );
continue;
}
pReq->m_fd = lsapi_accept( pServer->m_fd );
if ( pReq->m_fd != -1 )
{
wait_secs = 0;
child_status = find_child_status( 0 );
sigemptyset( &mask );
sigaddset( &mask, SIGCHLD );
if ( sigprocmask(SIG_BLOCK, &mask, &orig_mask) < 0 )
{
perror( "sigprocmask(SIG_BLOCK) to block SIGCHLD" );
}
pid = fork();
if ( !pid )
{
setsid();
if (sigprocmask(SIG_SETMASK, &orig_mask, NULL) < 0)
perror( "sigprocmask( SIG_SETMASK ) to restore SIGMASK in child" );
g_prefork_server = NULL;
s_ppid = getppid();
s_pid = getpid();
s_req_processed = 0;
s_proc_group_timer_cb = NULL;
s_worker_status = child_status;
if (pthread_atfork_func)
(*pthread_atfork_func)(NULL, NULL, set_skip_write);
__atomic_store_n(&s_worker_status->m_state,
LSAPI_STATE_CONNECTED, __ATOMIC_SEQ_CST);
if (s_busy_workers)
__atomic_add_fetch(s_busy_workers, 1, __ATOMIC_SEQ_CST);
lsapi_set_nblock( pReq->m_fd, 0 );
//keep it open if busy_count is used.
if (!s_keep_listener && s_busy_workers
&& *s_busy_workers > (pServer->m_iMaxChildren >> 1))
s_keep_listener = 1;
if ((s_uid == 0 || !s_keep_listener || !is_enough_free_mem())
&& pReq->m_fdListen != -1 )
{
close( pReq->m_fdListen );
pReq->m_fdListen = -1;
}
/* don't catch our signals */
sigaction( SIGCHLD, &old_child, 0 );
sigaction( SIGTERM, &old_term, 0 );
sigaction( SIGQUIT, &old_quit, 0 );
sigaction( SIGINT, &old_int, 0 );
sigaction( SIGUSR1, &old_usr1, 0 );
//init_conn_key( pReq->m_fd );
lsapi_notify_pid( pReq->m_fd );
s_notified_pid = 1;
//if ( s_accept_notify )
// return notify_req_received( pReq->m_fd );
return 0;
}
else if ( pid == -1 )
{
lsapi_perror("fork() failed, please increase process limit", errno);
if (child_status)
child_status->m_pid = 0;
}
else
{
++pServer->m_iCurChildren;
if ( child_status )
{
child_status->m_pid = pid;
child_status->m_tmWaitBegin = curTime;
child_status->m_tmStart = curTime;
}
}
close( pReq->m_fd );
pReq->m_fd = -1;
if (sigprocmask(SIG_SETMASK, &orig_mask, NULL) < 0)
perror( "sigprocmask( SIG_SETMASK ) to restore SIGMASK" );
}
else
{
if (( errno == EINTR )||( errno == EAGAIN))
continue;
lsapi_perror("accept() failed", errno);
return -1;
}
}
sigaction( SIGUSR1, &old_usr1, 0 );
//kill( -getpgrp(), SIGUSR1 );
//lsapi_all_children_must_die(); /* Sorry, children ;-) */
return -1;
}
static struct sigaction old_term, old_quit, old_int,
old_usr1, old_child;
int LSAPI_Postfork_Child(LSAPI_Request * pReq)
{
int max_children = g_prefork_server->m_iMaxChildren;
s_pid = getpid();
__atomic_store_n(&pReq->child_status->m_pid, s_pid, __ATOMIC_SEQ_CST);
s_worker_status = pReq->child_status;
setsid();
g_prefork_server = NULL;
s_ppid = getppid();
s_req_processed = 0;
s_proc_group_timer_cb = NULL;
if (pthread_atfork_func)
(*pthread_atfork_func)(NULL, NULL, set_skip_write);
__atomic_store_n(&s_worker_status->m_state,
LSAPI_STATE_CONNECTED, __ATOMIC_SEQ_CST);
if (s_busy_workers)
__atomic_add_fetch(s_busy_workers, 1, __ATOMIC_SEQ_CST);
lsapi_set_nblock( pReq->m_fd, 0 );
//keep it open if busy_count is used.
if (!s_keep_listener && s_busy_workers
&& *s_busy_workers > (max_children >> 1))
s_keep_listener = 1;
if ((s_uid == 0 || !s_keep_listener || !is_enough_free_mem())
&& pReq->m_fdListen != -1 )
{
close(pReq->m_fdListen);
pReq->m_fdListen = -1;
}
//init_conn_key( pReq->m_fd );
lsapi_notify_pid(pReq->m_fd);
s_notified_pid = 1;
//if ( s_accept_notify )
// return notify_req_received( pReq->m_fd );
return 0;
}
int LSAPI_Postfork_Parent(LSAPI_Request * pReq)
{
++g_prefork_server->m_iCurChildren;
if (pReq->child_status)
{
time_t curTime = time( NULL );
pReq->child_status->m_tmWaitBegin = curTime;
pReq->child_status->m_tmStart = curTime;
}
close(pReq->m_fd);
pReq->m_fd = -1;
return 0;
}
int LSAPI_Accept_Before_Fork(LSAPI_Request * pReq)
{
time_t lastTime = 0;
time_t curTime = 0;
fd_set readfds;
struct timeval timeout;
int wait_secs = 0;
int ret = 0;
lsapi_prefork_server * pServer = g_prefork_server;
struct sigaction act;
lsapi_init_children_status();
act.sa_flags = 0;
act.sa_handler = lsapi_sigchild;
sigemptyset(&(act.sa_mask));
if (sigaction(SIGCHLD, &act, &old_child))
{
perror( "Can't set signal handler for SIGCHILD" );
return -1;
}
/* Set up handler to kill children upon exit */
act.sa_flags = 0;
act.sa_handler = lsapi_cleanup;
sigemptyset(&(act.sa_mask));
if (sigaction(SIGTERM, &act, &old_term) ||
sigaction(SIGINT, &act, &old_int ) ||
sigaction(SIGUSR1, &act, &old_usr1) ||
sigaction(SIGQUIT, &act, &old_quit))
{
perror( "Can't set signals" );
return -1;
}
s_stop = 0;
pReq->m_reqState = 0;
while(!s_stop)
{
if (s_proc_group_timer_cb != NULL) {
s_proc_group_timer_cb(&s_ignore_pid);
}
curTime = time(NULL);
if (curTime != lastTime)
{
lastTime = curTime;
if (lsapi_parent_dead())
break;
lsapi_check_child_status(curTime);
if (pServer->m_iServerMaxIdle)
{
if (pServer->m_iCurChildren <= 0)
{
++wait_secs;
if ( wait_secs > pServer->m_iServerMaxIdle )
return -1;
}
else
wait_secs = 0;
}
}
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
*s_avail_pages = sysconf(_SC_AVPHYS_PAGES);
// lsapi_log("Memory total: %zd, free: %zd, free %%%zd\n",
// s_total_pages, *s_avail_pages, *s_avail_pages * 100 / s_total_pages);
#endif
FD_ZERO(&readfds);
FD_SET(pServer->m_fd, &readfds);
timeout.tv_sec = 1;
timeout.tv_usec = 0;
ret = (*g_fnSelect)(pServer->m_fd+1, &readfds, NULL, NULL, &timeout);
if (ret == 1 )
{
int accepting = 0;
if (s_accepting_workers)
accepting = __atomic_load_n(s_accepting_workers, __ATOMIC_SEQ_CST);
if (pServer->m_iCurChildren > 0
&& accepting > 0)
{
usleep( 400);
while(accepting-- > 0)
sched_yield();
continue;
}
}
else if (ret == -1)
{
if (errno == EINTR)
continue;
/* perror( "select()" ); */
break;
}
else
{
continue;
}
if (pServer->m_iCurChildren >=
pServer->m_iMaxChildren + pServer->m_iExtraChildren)
{
lsapi_log("Reached max children process limit: %d, extra: %d,"
" current: %d, busy: %d, please increase LSAPI_CHILDREN.\n",
pServer->m_iMaxChildren, pServer->m_iExtraChildren,
pServer->m_iCurChildren,
s_busy_workers ? *s_busy_workers : -1);
usleep(100000);
continue;
}
pReq->m_fd = lsapi_accept(pServer->m_fd);
if (pReq->m_fd != -1)
{
wait_secs = 0;
pReq->child_status = find_child_status(0);
ret = 0;
break;
}
else
{
if ((errno == EINTR) || (errno == EAGAIN))
continue;
lsapi_perror("accept() failed", errno);
ret = -1;
break;
}
}
sigaction(SIGCHLD, &old_child, 0);
sigaction(SIGTERM, &old_term, 0);
sigaction(SIGQUIT, &old_quit, 0);
sigaction(SIGINT, &old_int, 0);
sigaction(SIGUSR1, &old_usr1, 0);
return ret;
}
int LSAPI_Prefork_Accept_r( LSAPI_Request * pReq )
{
int fd;
int ret;
int wait_secs;
fd_set readfds;
struct timeval timeout;
if (s_skip_write)
return -1;
LSAPI_Finish_r( pReq );
if ( g_prefork_server )
{
if ( g_prefork_server->m_fd != -1 )
if ( lsapi_prefork_server_accept( g_prefork_server, pReq ) == -1 )
return -1;
}
else if (s_req_processed > 0 && s_max_busy_workers > 0 && s_busy_workers)
{
ret = __atomic_load_n(s_busy_workers, __ATOMIC_SEQ_CST);
if (ret >= s_max_busy_workers)
{
send_conn_close_notification(pReq->m_fd);
lsapi_close_connection(pReq);
}
}
if ( (unsigned int)s_req_processed > s_max_reqs )
return -1;
if ( s_worker_status )
{
s_worker_status->m_tmWaitBegin = time( NULL );
}
while( g_running )
{
if ( pReq->m_fd != -1 )
{
fd = pReq->m_fd;
}
else if ( pReq->m_fdListen != -1 )
fd = pReq->m_fdListen;
else
{
break;
}
wait_secs = 0;
while( 1 )
{
if ( !g_running )
return -1;
if (s_req_processed && s_worker_status
&& s_worker_status->m_iKillSent)
return -1;
FD_ZERO( &readfds );
FD_SET( fd, &readfds );
timeout.tv_sec = 1;
timeout.tv_usec = 0;
if (fd == pReq->m_fdListen)
{
if (s_worker_status)
__atomic_store_n(&s_worker_status->m_state,
LSAPI_STATE_ACCEPTING, __ATOMIC_SEQ_CST);
if (s_accepting_workers)
__atomic_fetch_add(s_accepting_workers, 1, __ATOMIC_SEQ_CST);
}
ret = (*g_fnSelect)(fd+1, &readfds, NULL, NULL, &timeout);
if (fd == pReq->m_fdListen)
{
if (s_accepting_workers)
__atomic_fetch_sub(s_accepting_workers, 1, __ATOMIC_SEQ_CST);
if (s_worker_status)
__atomic_store_n(&s_worker_status->m_state,
LSAPI_STATE_IDLE, __ATOMIC_SEQ_CST);
}
if ( ret == 0 )
{
if ( s_worker_status )
{
s_worker_status->m_inProcess = 0;
if (fd == pReq->m_fdListen)
{
if (s_keep_listener == 0 || !is_enough_free_mem())
return -1;
if (s_keep_listener == 1)
{
int wait_time = 10;
if (s_busy_workers)
wait_time += *s_busy_workers * 10;
if (s_accepting_workers)
wait_time >>= (*s_accepting_workers);
if (wait_secs >= wait_time)
return -1;
}
}
}
++wait_secs;
if (( s_max_idle_secs > 0 )&&(wait_secs >= s_max_idle_secs ))
return -1;
if ( lsapi_parent_dead() )
return -1;
}
else if ( ret == -1 )
{
if ( errno == EINTR )
continue;
else
return -1;
}
else if ( ret >= 1 )
{
if (s_req_processed && s_worker_status
&& s_worker_status->m_iKillSent)
return -1;
if ( fd == pReq->m_fdListen )
{
pReq->m_fd = lsapi_accept( pReq->m_fdListen );
if ( pReq->m_fd != -1 )
{
if (s_worker_status)
__atomic_store_n(&s_worker_status->m_state,
LSAPI_STATE_CONNECTED,
__ATOMIC_SEQ_CST);
if (s_busy_workers)
__atomic_fetch_add(s_busy_workers, 1, __ATOMIC_SEQ_CST);
fd = pReq->m_fd;
lsapi_set_nblock( fd, 0 );
//init_conn_key( pReq->m_fd );
if (!s_keep_listener)
{
close( pReq->m_fdListen );
pReq->m_fdListen = -1;
}
if ( s_accept_notify )
if ( notify_req_received( pReq->m_fd ) == -1 )
return -1;
}
else
{
if (( errno == EINTR )||( errno == EAGAIN))
continue;
lsapi_perror( "lsapi_accept() error", errno );
return -1;
}
}
else
break;
}
}
if ( !readReq( pReq ) )
{
if ( s_worker_status )
{
s_worker_status->m_iKillSent = 0;
s_worker_status->m_inProcess = 1;
++s_worker_status->m_iReqCounter;
s_worker_status->m_tmReqBegin =
s_worker_status->m_tmLastCheckPoint = time(NULL);
}
++s_req_processed;
return 0;
}
lsapi_close_connection(pReq);
LSAPI_Reset_r( pReq );
}
return -1;
}
void LSAPI_Set_Max_Reqs( int reqs )
{ s_max_reqs = reqs - 1; }
void LSAPI_Set_Max_Idle( int secs )
{ s_max_idle_secs = secs; }
void LSAPI_Set_Max_Children( int maxChildren )
{
if ( g_prefork_server )
g_prefork_server->m_iMaxChildren = maxChildren;
}
void LSAPI_Set_Extra_Children( int extraChildren )
{
if (( g_prefork_server )&&( extraChildren >= 0 ))
g_prefork_server->m_iExtraChildren = extraChildren;
}
void LSAPI_Set_Max_Process_Time( int secs )
{
if (( g_prefork_server )&&( secs > 0 ))
g_prefork_server->m_iMaxReqProcessTime = secs;
}
void LSAPI_Set_Max_Idle_Children( int maxIdleChld )
{
if (( g_prefork_server )&&( maxIdleChld > 0 ))
g_prefork_server->m_iMaxIdleChildren = maxIdleChld;
}
void LSAPI_Set_Server_Max_Idle_Secs( int serverMaxIdle )
{
if ( g_prefork_server )
g_prefork_server->m_iServerMaxIdle = serverMaxIdle;
}
void LSAPI_Set_Slow_Req_Msecs( int msecs )
{
s_slow_req_msecs = msecs;
}
int LSAPI_Get_Slow_Req_Msecs(void)
{
return s_slow_req_msecs;
}
void LSAPI_No_Check_ppid(void)
{
s_ppid = 0;
}
int LSAPI_Get_ppid(void)
{
return(s_ppid);
}
#if defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
#include <crt_externs.h>
#else
extern char ** environ;
#endif
static void unset_lsapi_envs(void)
{
char **env;
#if defined(macintosh) || defined(__APPLE__) || defined(__APPLE_CC__)
env = *_NSGetEnviron();
#else
env = environ;
#endif
while( env != NULL && *env != NULL )
{
if (!strncmp(*env, "LSAPI_", 6) || !strncmp( *env, "PHP_LSAPI_", 10 )
|| (!strncmp( *env, "PHPRC=", 6 )&&(!s_uid)))
{
char ** del = env;
do
*del = del[1];
while( *del++ );
}
else
++env;
}
}
static int lsapi_initSuEXEC(void)
{
int i;
struct passwd * pw;
s_defaultUid = 0;
s_defaultGid = 0;
if ( s_uid == 0 )
{
const char * p = getenv( "LSAPI_DEFAULT_UID" );
if ( p )
{
i = atoi( p );
if ( i > 0 )
s_defaultUid = i;
}
p = getenv( "LSAPI_DEFAULT_GID" );
if ( p )
{
i = atoi( p );
if ( i > 0 )
s_defaultGid = i;
}
p = getenv( "LSAPI_SECRET" );
if (( !p )||( readSecret(p) == -1 ))
return -1;
if ( g_prefork_server )
{
if ( g_prefork_server->m_iMaxChildren < 100 )
g_prefork_server->m_iMaxChildren = 100;
if ( g_prefork_server->m_iExtraChildren < 1000 )
g_prefork_server->m_iExtraChildren = 1000;
}
}
if ( !s_defaultUid || !s_defaultGid )
{
pw = getpwnam( "nobody" );
if ( pw )
{
if ( !s_defaultUid )
s_defaultUid = pw->pw_uid;
if ( !s_defaultGid )
s_defaultGid = pw->pw_gid;
}
else
{
if ( !s_defaultUid )
s_defaultUid = 10000;
if ( !s_defaultGid )
s_defaultGid = 10000;
}
}
return 0;
}
static int lsapi_check_path(const char *p, char *final, int max_len)
{
char resolved_path[PATH_MAX+1];
int len = 0;
char *end;
if (*p != '/')
{
if (getcwd(final, max_len) == NULL)
return -1;
len = strlen(final);
*(final + len) = '/';
++len;
}
end = memccpy(&final[len], p, '\0', PATH_MAX - len);
if (!end)
{
errno = EINVAL;
return -1;
}
p = final;
if (realpath(p, resolved_path) == NULL
&& errno != ENOENT && errno != EACCES)
return -1;
if (strncmp(resolved_path, "/etc/", 5) == 0)
{
errno = EPERM;
return -1;
}
return 0;
}
static int lsapi_reopen_stderr2(const char *full_path)
{
int newfd = open(full_path, O_WRONLY | O_CREAT | O_APPEND, 0644);
if (newfd == -1)
{
LSAPI_perror_r(NULL, "Failed to open custom stderr log", full_path);
return -1;
}
if (newfd != 2)
{
dup2(newfd, 2);
close(newfd);
dup2(2, 1);
}
if (s_stderr_log_path && full_path != s_stderr_log_path)
{
free(s_stderr_log_path);
s_stderr_log_path = NULL;
}
s_stderr_log_path = strdup(full_path);
return 0;
}
static int lsapi_reopen_stderr(const char *p)
{
char full_path[PATH_MAX];
if (s_uid == 0)
return -1;
if (lsapi_check_path(p, full_path, PATH_MAX) == -1)
{
LSAPI_perror_r(NULL, "Invalid custom stderr log path", p);
return -1;
}
return lsapi_reopen_stderr2(full_path);
}
int LSAPI_Init_Env_Parameters( fn_select_t fp )
{
const char *p;
char ch;
int n;
int avoidFork = 0;
p = getenv("LSAPI_STDERR_LOG");
if (p)
{
lsapi_reopen_stderr(p);
}
if (!s_stderr_log_path)
s_stderr_is_pipe = isPipe(STDERR_FILENO);
p = getenv( "PHP_LSAPI_MAX_REQUESTS" );
if ( !p )
p = getenv( "LSAPI_MAX_REQS" );
if ( p )
{
n = atoi( p );
if ( n > 0 )
LSAPI_Set_Max_Reqs( n );
}
p = getenv( "LSAPI_KEEP_LISTEN" );
if ( p )
{
n = atoi( p );
s_keep_listener = n;
}
p = getenv( "LSAPI_AVOID_FORK" );
if ( p )
{
avoidFork = atoi( p );
if (avoidFork)
{
s_keep_listener = 2;
ch = *(p + strlen(p) - 1);
if ( ch == 'G' || ch == 'g' )
avoidFork *= 1024 * 1024 * 1024;
else if ( ch == 'M' || ch == 'm' )
avoidFork *= 1024 * 1024;
if (avoidFork >= 1024 * 10240)
s_min_avail_pages = avoidFork / 4096;
}
}
p = getenv( "LSAPI_ACCEPT_NOTIFY" );
if ( p )
{
s_accept_notify = atoi( p );
}
p = getenv( "LSAPI_SLOW_REQ_MSECS" );
if ( p )
{
n = atoi( p );
LSAPI_Set_Slow_Req_Msecs( n );
}
#if defined( RLIMIT_CORE )
p = getenv( "LSAPI_ALLOW_CORE_DUMP" );
if ( !p )
{
struct rlimit limit = { 0, 0 };
setrlimit( RLIMIT_CORE, &limit );
}
else
s_enable_core_dump = 1;
#endif
p = getenv( "LSAPI_MAX_IDLE" );
if ( p )
{
n = atoi( p );
LSAPI_Set_Max_Idle( n );
}
if ( LSAPI_Is_Listen() )
{
n = 0;
p = getenv( "PHP_LSAPI_CHILDREN" );
if ( !p )
p = getenv( "LSAPI_CHILDREN" );
if ( p )
n = atoi( p );
if ( n > 1 )
{
LSAPI_Init_Prefork_Server( n, fp, avoidFork != 0 );
LSAPI_Set_Server_fd( g_req.m_fdListen );
}
p = getenv( "LSAPI_EXTRA_CHILDREN" );
if ( p )
LSAPI_Set_Extra_Children( atoi( p ) );
p = getenv( "LSAPI_MAX_IDLE_CHILDREN" );
if ( p )
LSAPI_Set_Max_Idle_Children( atoi( p ) );
p = getenv( "LSAPI_PGRP_MAX_IDLE" );
if ( p )
{
LSAPI_Set_Server_Max_Idle_Secs( atoi( p ) );
}
p = getenv( "LSAPI_MAX_PROCESS_TIME" );
if ( p )
LSAPI_Set_Max_Process_Time( atoi( p ) );
if ( getenv( "LSAPI_PPID_NO_CHECK" ) )
{
LSAPI_No_Check_ppid();
}
p = getenv("LSAPI_MAX_BUSY_WORKER");
if (p)
{
n = atoi(p);
s_max_busy_workers = n;
if (n >= 0)
LSAPI_No_Check_ppid();
}
p = getenv( "LSAPI_DUMP_DEBUG_INFO" );
if ( p )
s_dump_debug_info = atoi( p );
if ( lsapi_initSuEXEC() == -1 )
return -1;
#if defined(linux) || defined(__linux) || defined(__linux__) || defined(__gnu_linux__)
lsapi_initLVE();
#endif
}
unset_lsapi_envs();
return 0;
}
int LSAPI_ErrResponse_r( LSAPI_Request * pReq, int code, const char ** pRespHeaders,
const char * pBody, int bodyLen )
{
LSAPI_SetRespStatus_r( pReq, code );
if ( pRespHeaders )
{
while( *pRespHeaders )
{
LSAPI_AppendRespHeader_r( pReq, *pRespHeaders, strlen( *pRespHeaders ) );
++pRespHeaders;
}
}
if ( pBody &&( bodyLen > 0 ))
{
LSAPI_Write_r( pReq, pBody, bodyLen );
}
LSAPI_Finish_r( pReq );
return 0;
}
static void lsapi_MD5Transform(uint32 buf[4], uint32 const in[16]);
/*
* Note: this code is harmless on little-endian machines.
*/
static void byteReverse(unsigned char *buf, unsigned longs)
{
uint32 t;
do {
t = (uint32) ((unsigned) buf[3] << 8 | buf[2]) << 16 |
((unsigned) buf[1] << 8 | buf[0]);
*(uint32 *) buf = t;
buf += 4;
} while (--longs);
}
/*
* Start MD5 accumulation. Set bit count to 0 and buffer to mysterious
* initialization constants.
*/
void lsapi_MD5Init(struct lsapi_MD5Context *ctx)
{
ctx->buf[0] = 0x67452301;
ctx->buf[1] = 0xefcdab89;
ctx->buf[2] = 0x98badcfe;
ctx->buf[3] = 0x10325476;
ctx->bits[0] = 0;
ctx->bits[1] = 0;
}
/*
* Update context to reflect the concatenation of another buffer full
* of bytes.
*/
void lsapi_MD5Update(struct lsapi_MD5Context *ctx, unsigned char const *buf, unsigned len)
{
register uint32 t;
/* Update bitcount */
t = ctx->bits[0];
if ((ctx->bits[0] = t + ((uint32) len << 3)) < t)
ctx->bits[1]++; /* Carry from low to high */
ctx->bits[1] += len >> 29;
t = (t >> 3) & 0x3f; /* Bytes already in shsInfo->data */
/* Handle any leading odd-sized chunks */
if (t) {
unsigned char *p = (unsigned char *) ctx->in + t;
t = 64 - t;
if (len < t) {
memmove(p, buf, len);
return;
}
memmove(p, buf, t);
byteReverse(ctx->in, 16);
lsapi_MD5Transform(ctx->buf, (uint32 *) ctx->in);
buf += t;
len -= t;
}
/* Process data in 64-byte chunks */
while (len >= 64) {
memmove(ctx->in, buf, 64);
byteReverse(ctx->in, 16);
lsapi_MD5Transform(ctx->buf, (uint32 *) ctx->in);
buf += 64;
len -= 64;
}
/* Handle any remaining bytes of data. */
memmove(ctx->in, buf, len);
}
/*
* Final wrap-up - pad to 64-byte boundary with the bit pattern
* 1 0* (64-bit count of bits processed, MSB-first)
*/
void lsapi_MD5Final(unsigned char digest[16], struct lsapi_MD5Context *ctx)
{
unsigned int count;
unsigned char *p;
/* Compute number of bytes mod 64 */
count = (ctx->bits[0] >> 3) & 0x3F;
/* Set the first char of padding to 0x80. This is safe since there is
always at least one byte free */
p = ctx->in + count;
*p++ = 0x80;
/* Bytes of padding needed to make 64 bytes */
count = 64 - 1 - count;
/* Pad out to 56 mod 64 */
if (count < 8) {
/* Two lots of padding: Pad the first block to 64 bytes */
memset(p, 0, count);
byteReverse(ctx->in, 16);
lsapi_MD5Transform(ctx->buf, (uint32 *) ctx->in);
/* Now fill the next block with 56 bytes */
memset(ctx->in, 0, 56);
} else {
/* Pad block to 56 bytes */
memset(p, 0, count - 8);
}
byteReverse(ctx->in, 14);
/* Append length in bits and transform */
((uint32 *) ctx->in)[14] = ctx->bits[0];
((uint32 *) ctx->in)[15] = ctx->bits[1];
lsapi_MD5Transform(ctx->buf, (uint32 *) ctx->in);
byteReverse((unsigned char *) ctx->buf, 4);
memmove(digest, ctx->buf, 16);
memset(ctx, 0, sizeof(*ctx)); /* In case it's sensitive */
}
/* The four core functions - F1 is optimized somewhat */
/* #define F1(x, y, z) (x & y | ~x & z) */
#define F1(x, y, z) (z ^ (x & (y ^ z)))
#define F2(x, y, z) F1(z, x, y)
#define F3(x, y, z) (x ^ y ^ z)
#define F4(x, y, z) (y ^ (x | ~z))
/* This is the central step in the MD5 algorithm. */
#define MD5STEP(f, w, x, y, z, data, s) \
( w += f(x, y, z) + data, w = w<<s | w>>(32-s), w += x )
/*
* The core of the MD5 algorithm, this alters an existing MD5 hash to
* reflect the addition of 16 longwords of new data. MD5Update blocks
* the data and converts bytes into longwords for this routine.
*/
static void lsapi_MD5Transform(uint32 buf[4], uint32 const in[16])
{
register uint32 a, b, c, d;
a = buf[0];
b = buf[1];
c = buf[2];
d = buf[3];
MD5STEP(F1, a, b, c, d, in[0] + 0xd76aa478, 7);
MD5STEP(F1, d, a, b, c, in[1] + 0xe8c7b756, 12);
MD5STEP(F1, c, d, a, b, in[2] + 0x242070db, 17);
MD5STEP(F1, b, c, d, a, in[3] + 0xc1bdceee, 22);
MD5STEP(F1, a, b, c, d, in[4] + 0xf57c0faf, 7);
MD5STEP(F1, d, a, b, c, in[5] + 0x4787c62a, 12);
MD5STEP(F1, c, d, a, b, in[6] + 0xa8304613, 17);
MD5STEP(F1, b, c, d, a, in[7] + 0xfd469501, 22);
MD5STEP(F1, a, b, c, d, in[8] + 0x698098d8, 7);
MD5STEP(F1, d, a, b, c, in[9] + 0x8b44f7af, 12);
MD5STEP(F1, c, d, a, b, in[10] + 0xffff5bb1, 17);
MD5STEP(F1, b, c, d, a, in[11] + 0x895cd7be, 22);
MD5STEP(F1, a, b, c, d, in[12] + 0x6b901122, 7);
MD5STEP(F1, d, a, b, c, in[13] + 0xfd987193, 12);
MD5STEP(F1, c, d, a, b, in[14] + 0xa679438e, 17);
MD5STEP(F1, b, c, d, a, in[15] + 0x49b40821, 22);
MD5STEP(F2, a, b, c, d, in[1] + 0xf61e2562, 5);
MD5STEP(F2, d, a, b, c, in[6] + 0xc040b340, 9);
MD5STEP(F2, c, d, a, b, in[11] + 0x265e5a51, 14);
MD5STEP(F2, b, c, d, a, in[0] + 0xe9b6c7aa, 20);
MD5STEP(F2, a, b, c, d, in[5] + 0xd62f105d, 5);
MD5STEP(F2, d, a, b, c, in[10] + 0x02441453, 9);
MD5STEP(F2, c, d, a, b, in[15] + 0xd8a1e681, 14);
MD5STEP(F2, b, c, d, a, in[4] + 0xe7d3fbc8, 20);
MD5STEP(F2, a, b, c, d, in[9] + 0x21e1cde6, 5);
MD5STEP(F2, d, a, b, c, in[14] + 0xc33707d6, 9);
MD5STEP(F2, c, d, a, b, in[3] + 0xf4d50d87, 14);
MD5STEP(F2, b, c, d, a, in[8] + 0x455a14ed, 20);
MD5STEP(F2, a, b, c, d, in[13] + 0xa9e3e905, 5);
MD5STEP(F2, d, a, b, c, in[2] + 0xfcefa3f8, 9);
MD5STEP(F2, c, d, a, b, in[7] + 0x676f02d9, 14);
MD5STEP(F2, b, c, d, a, in[12] + 0x8d2a4c8a, 20);
MD5STEP(F3, a, b, c, d, in[5] + 0xfffa3942, 4);
MD5STEP(F3, d, a, b, c, in[8] + 0x8771f681, 11);
MD5STEP(F3, c, d, a, b, in[11] + 0x6d9d6122, 16);
MD5STEP(F3, b, c, d, a, in[14] + 0xfde5380c, 23);
MD5STEP(F3, a, b, c, d, in[1] + 0xa4beea44, 4);
MD5STEP(F3, d, a, b, c, in[4] + 0x4bdecfa9, 11);
MD5STEP(F3, c, d, a, b, in[7] + 0xf6bb4b60, 16);
MD5STEP(F3, b, c, d, a, in[10] + 0xbebfbc70, 23);
MD5STEP(F3, a, b, c, d, in[13] + 0x289b7ec6, 4);
MD5STEP(F3, d, a, b, c, in[0] + 0xeaa127fa, 11);
MD5STEP(F3, c, d, a, b, in[3] + 0xd4ef3085, 16);
MD5STEP(F3, b, c, d, a, in[6] + 0x04881d05, 23);
MD5STEP(F3, a, b, c, d, in[9] + 0xd9d4d039, 4);
MD5STEP(F3, d, a, b, c, in[12] + 0xe6db99e5, 11);
MD5STEP(F3, c, d, a, b, in[15] + 0x1fa27cf8, 16);
MD5STEP(F3, b, c, d, a, in[2] + 0xc4ac5665, 23);
MD5STEP(F4, a, b, c, d, in[0] + 0xf4292244, 6);
MD5STEP(F4, d, a, b, c, in[7] + 0x432aff97, 10);
MD5STEP(F4, c, d, a, b, in[14] + 0xab9423a7, 15);
MD5STEP(F4, b, c, d, a, in[5] + 0xfc93a039, 21);
MD5STEP(F4, a, b, c, d, in[12] + 0x655b59c3, 6);
MD5STEP(F4, d, a, b, c, in[3] + 0x8f0ccc92, 10);
MD5STEP(F4, c, d, a, b, in[10] + 0xffeff47d, 15);
MD5STEP(F4, b, c, d, a, in[1] + 0x85845dd1, 21);
MD5STEP(F4, a, b, c, d, in[8] + 0x6fa87e4f, 6);
MD5STEP(F4, d, a, b, c, in[15] + 0xfe2ce6e0, 10);
MD5STEP(F4, c, d, a, b, in[6] + 0xa3014314, 15);
MD5STEP(F4, b, c, d, a, in[13] + 0x4e0811a1, 21);
MD5STEP(F4, a, b, c, d, in[4] + 0xf7537e82, 6);
MD5STEP(F4, d, a, b, c, in[11] + 0xbd3af235, 10);
MD5STEP(F4, c, d, a, b, in[2] + 0x2ad7d2bb, 15);
MD5STEP(F4, b, c, d, a, in[9] + 0xeb86d391, 21);
buf[0] += a;
buf[1] += b;
buf[2] += c;
buf[3] += d;
}
int LSAPI_Set_Restored_Parent_Pid(int pid)
{
int old_ppid = s_ppid;
s_restored_ppid = pid;
return old_ppid;
}
int LSAPI_Inc_Req_Processed(int cnt)
{
return __atomic_add_fetch(s_global_counter, cnt, __ATOMIC_SEQ_CST);
}
share/gems/gems/ruby-lsapi-5.6/ext/lsapi/lsapidef.h 0000644 00000011054 15173517751 0016016 0 ustar 00 /*
Copyright (c) 2002-2018, Lite Speed Technologies Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of the Lite Speed Technologies Inc nor the
names of its contributors may be used to endorse or promote
products derived from this software without specific prior
written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
OWNER 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.
*/
#ifndef _LSAPIDEF_H_
#define _LSAPIDEF_H_
#include <inttypes.h>
#if defined (c_plusplus) || defined (__cplusplus)
extern "C" {
#endif
enum
{
H_ACCEPT = 0,
H_ACC_CHARSET,
H_ACC_ENCODING,
H_ACC_LANG,
H_AUTHORIZATION,
H_CONNECTION,
H_CONTENT_TYPE,
H_CONTENT_LENGTH,
H_COOKIE,
H_COOKIE2,
H_HOST,
H_PRAGMA,
H_REFERER,
H_USERAGENT,
H_CACHE_CTRL,
H_IF_MODIFIED_SINCE,
H_IF_MATCH,
H_IF_NO_MATCH,
H_IF_RANGE,
H_IF_UNMOD_SINCE,
H_KEEP_ALIVE,
H_RANGE,
H_X_FORWARDED_FOR,
H_VIA,
H_TRANSFER_ENCODING
};
#define LSAPI_SOCK_FILENO 0
#define LSAPI_VERSION_B0 'L'
#define LSAPI_VERSION_B1 'S'
/* Values for m_flag in lsapi_packet_header */
#define LSAPI_ENDIAN_LITTLE 0
#define LSAPI_ENDIAN_BIG 1
#define LSAPI_ENDIAN_BIT 1
#if defined(__i386__)||defined( __x86_64 )||defined( __x86_64__ )
#define LSAPI_ENDIAN LSAPI_ENDIAN_LITTLE
#else
#define LSAPI_ENDIAN LSAPI_ENDIAN_BIG
#endif
/* Values for m_type in lsapi_packet_header */
#define LSAPI_BEGIN_REQUEST 1
#define LSAPI_ABORT_REQUEST 2
#define LSAPI_RESP_HEADER 3
#define LSAPI_RESP_STREAM 4
#define LSAPI_RESP_END 5
#define LSAPI_STDERR_STREAM 6
#define LSAPI_REQ_RECEIVED 7
#define LSAPI_CONN_CLOSE 8
#define LSAPI_INTERNAL_ERROR 9
#define LSAPI_MAX_HEADER_LEN 65535
#define LSAPI_MAX_DATA_PACKET_LEN 16384
#define LSAPI_RESP_HTTP_HEADER_MAX 32768
#define LSAPI_PACKET_HEADER_LEN 8
struct lsapi_packet_header
{
char m_versionB0; /* LSAPI protocol version */
char m_versionB1;
char m_type;
char m_flag;
union
{
int32_t m_iLen; /* include this header */
char m_bytes[4];
}m_packetLen;
};
/*
LSAPI request header packet
1. struct lsapi_req_header
2. struct lsapi_http_header_index
3. lsapi_header_offset * unknownHeaders
4. org http request header
5. request body if available
*/
struct lsapi_req_header
{
struct lsapi_packet_header m_pktHeader;
int32_t m_httpHeaderLen;
int32_t m_reqBodyLen;
int32_t m_scriptFileOff; /* path to the script file. */
int32_t m_scriptNameOff; /* decrypted URI, without pathinfo, */
int32_t m_queryStringOff; /* Query string inside env */
int32_t m_requestMethodOff;
int32_t m_cntUnknownHeaders;
int32_t m_cntEnv;
int32_t m_cntSpecialEnv;
} ;
struct lsapi_http_header_index
{
uint16_t m_headerLen[H_TRANSFER_ENCODING+1];
int32_t m_headerOff[H_TRANSFER_ENCODING+1];
} ;
struct lsapi_header_offset
{
int32_t nameOff;
int32_t nameLen;
int32_t valueOff;
int32_t valueLen;
} ;
struct lsapi_resp_info
{
int32_t m_cntHeaders;
int32_t m_status;
};
struct lsapi_resp_header
{
struct lsapi_packet_header m_pktHeader;
struct lsapi_resp_info m_respInfo;
};
#if defined (c_plusplus) || defined (__cplusplus)
}
#endif
#endif
share/gems/gems/ruby-lsapi-5.6/ext/lsapi/Makefile 0000644 00000021754 15173517751 0015526 0 ustar 00
SHELL = /bin/sh
# V=0 quiet, V=1 verbose. other values don't work.
V = 1
V0 = $(V:0=)
Q1 = $(V:1=)
Q = $(Q1:0=@)
ECHO1 = $(V:1=@ :)
ECHO = $(ECHO1:0=@ echo)
NULLCMD = :
#### Start of system configuration section. ####
srcdir = .
topdir = /opt/alt/ruby33/include
hdrdir = $(topdir)
arch_hdrdir = /opt/alt/ruby33/include
PATH_SEPARATOR = :
VPATH = $(srcdir):$(arch_hdrdir)/ruby:$(hdrdir)/ruby
prefix = $(DESTDIR)/opt/alt/ruby33
rubysitearchprefix = $(sitearchlibdir)/$(RUBY_BASE_NAME)
rubyarchprefix = $(DESTDIR)/opt/alt/ruby33/lib64/ruby
rubylibprefix = $(exec_prefix)/share/ruby
exec_prefix = $(DESTDIR)/opt/alt/ruby33
vendorarchhdrdir = $(vendorhdrdir)/$(arch)
sitearchhdrdir = $(sitehdrdir)/$(arch)
rubyarchhdrdir = $(DESTDIR)/opt/alt/ruby33/include
vendorhdrdir = $(rubyhdrdir)/vendor_ruby
sitehdrdir = $(rubyhdrdir)/site_ruby
rubyhdrdir = $(DESTDIR)/opt/alt/ruby33/include
rubygemsdir = $(DESTDIR)/opt/alt/ruby33/share/rubygems
vendorarchdir = $(DESTDIR)/opt/alt/ruby33/lib64/ruby/vendor_ruby
vendorlibdir = $(vendordir)
vendordir = $(DESTDIR)/opt/alt/ruby33/share/ruby/vendor_ruby
sitearchdir = $(DESTDIR)/opt/alt/ruby33/lib64/ruby/site_ruby
sitelibdir = $(sitedir)
sitedir = $(DESTDIR)/opt/alt/ruby33/share/ruby/site_ruby
rubyarchdir = $(rubyarchprefix)
rubylibdir = $(rubylibprefix)
sitearchincludedir = $(includedir)/$(sitearch)
archincludedir = $(includedir)/$(arch)
sitearchlibdir = $(libdir)/$(sitearch)
archlibdir = $(DESTDIR)/opt/alt/ruby33/lib64
ridir = $(datarootdir)/$(RI_BASE_NAME)
mandir = $(DESTDIR)/opt/alt/ruby33/share/man
localedir = $(datarootdir)/locale
libdir = $(exec_prefix)/lib64
psdir = $(docdir)
pdfdir = $(docdir)
dvidir = $(docdir)
htmldir = $(docdir)
infodir = $(DESTDIR)/opt/alt/ruby33/share/info
docdir = $(datarootdir)/doc/$(PACKAGE)
oldincludedir = $(DESTDIR)/usr/include
includedir = $(exec_prefix)/include
localstatedir = $(DESTDIR)/var
sharedstatedir = $(DESTDIR)/var/lib
sysconfdir = $(DESTDIR)/etc
datadir = $(DESTDIR)/opt/alt/ruby33/share
datarootdir = $(prefix)/share
libexecdir = $(DESTDIR)/opt/alt/ruby33/libexec
sbindir = $(DESTDIR)/opt/alt/ruby33/sbin
bindir = $(exec_prefix)/bin
archdir = $(rubyarchdir)
CC_WRAPPER =
CC = gcc
CXX = g++
LIBRUBY = $(LIBRUBY_SO)
LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
LIBRUBYARG_SHARED = -Wl,-rpath,$(archlibdir) -L$(archlibdir) -l$(RUBY_SO_NAME)
LIBRUBYARG_STATIC = -Wl,-rpath,$(archlibdir) -L$(archlibdir) -l$(RUBY_SO_NAME)-static $(MAINLIBS)
empty =
OUTFLAG = -o $(empty)
COUTFLAG = -o $(empty)
CSRCFLAG = $(empty)
RUBY_EXTCONF_H =
cflags = $(optflags) $(debugflags) $(warnflags)
cxxflags =
optflags = -O3 -fno-fast-math
debugflags = -ggdb3
warnflags = -Wall -Wextra -Wdeprecated-declarations -Wdiv-by-zero -Wduplicated-cond -Wimplicit-function-declaration -Wimplicit-int -Wpointer-arith -Wwrite-strings -Wold-style-definition -Wimplicit-fallthrough=0 -Wmissing-noreturn -Wno-cast-function-type -Wno-constant-logical-operand -Wno-long-long -Wno-missing-field-initializers -Wno-overlength-strings -Wno-packed-bitfield-compat -Wno-parentheses-equality -Wno-self-assign -Wno-tautological-compare -Wno-unused-parameter -Wno-unused-value -Wsuggest-attribute=format -Wsuggest-attribute=noreturn -Wunused-variable -Wmisleading-indentation -Wundef
cppflags =
CCDLFLAGS = -fPIC
CFLAGS = $(CCDLFLAGS) -O2 -g -pipe -Wall -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -Wp,-D_GLIBCXX_ASSERTIONS -fexceptions -fstack-protector-strong -grecord-gcc-switches -specs=/usr/lib/rpm/redhat/redhat-hardened-cc1 -specs=/usr/lib/rpm/redhat/redhat-annobin-cc1 -m64 -mtune=generic -fasynchronous-unwind-tables -fstack-clash-protection -fcf-protection $(ARCH_FLAG)
INCFLAGS = -I. -I$(arch_hdrdir) -I$(hdrdir)/ruby/backward -I$(hdrdir) -I$(srcdir)
DEFS =
CPPFLAGS = $(DEFS) $(cppflags)
CXXFLAGS = $(CCDLFLAGS) -O2 -g -pipe -Wall -Werror=format-security -Wp,-D_FORTIFY_SOURCE=2 -Wp,-D_GLIBCXX_ASSERTIONS -fexceptions -fstack-protector-strong -grecord-gcc-switches -specs=/usr/lib/rpm/redhat/redhat-hardened-cc1 -specs=/usr/lib/rpm/redhat/redhat-annobin-cc1 -mtune=generic -fasynchronous-unwind-tables -fstack-clash-protection -fcf-protection $(ARCH_FLAG)
ldflags = -L. -Wl,-z,relro -Wl,-z,now -specs=/usr/lib/rpm/redhat/redhat-hardened-ld -fstack-protector-strong -rdynamic -Wl,-export-dynamic -Wl,--no-as-needed
dldflags = -Wl,-z,relro -Wl,-z,now -specs=/usr/lib/rpm/redhat/redhat-hardened-ld
ARCH_FLAG = -m64
DLDFLAGS = $(ldflags) $(dldflags) $(ARCH_FLAG)
LDSHARED = $(CC) -shared
LDSHAREDXX = $(CXX) -shared
AR = gcc-ar
EXEEXT =
RUBY_INSTALL_NAME = $(RUBY_BASE_NAME)
RUBY_SO_NAME = ruby
RUBYW_INSTALL_NAME =
RUBY_VERSION_NAME = $(RUBY_BASE_NAME)-$(ruby_version_dir_name)
RUBYW_BASE_NAME = rubyw
RUBY_BASE_NAME = ruby
arch = x86_64-linux
sitearch = $(arch)
ruby_version = 3.3.0
ruby = $(bindir)/$(RUBY_BASE_NAME)
RUBY = $(ruby)
BUILTRUBY = $(bindir)/$(RUBY_BASE_NAME)
ruby_headers = $(hdrdir)/ruby.h $(hdrdir)/ruby/backward.h $(hdrdir)/ruby/ruby.h $(hdrdir)/ruby/defines.h $(hdrdir)/ruby/missing.h $(hdrdir)/ruby/intern.h $(hdrdir)/ruby/st.h $(hdrdir)/ruby/subst.h $(arch_hdrdir)/ruby/config.h
RM = rm -f
RM_RF = rm -fr
RMDIRS = rmdir --ignore-fail-on-non-empty -p
MAKEDIRS = /usr/bin/mkdir -p
INSTALL = /usr/bin/install -c
INSTALL_PROG = $(INSTALL) -m 0755
INSTALL_DATA = $(INSTALL) -m 644
COPY = cp
TOUCH = exit >
#### End of system configuration section. ####
preload =
libpath = . $(archlibdir)
LIBPATH = -L. -L$(archlibdir) -Wl,-rpath,$(archlibdir)
DEFFILE =
CLEANFILES = mkmf.log
DISTCLEANFILES =
DISTCLEANDIRS =
extout =
extout_prefix =
target_prefix =
LOCAL_LIBS =
LIBS = $(LIBRUBYARG_SHARED) -lm -lpthread -lc
ORIG_SRCS = lsapilib.c lsruby.c
SRCS = $(ORIG_SRCS)
OBJS = lsapilib.o lsruby.o
HDRS = $(srcdir)/lsapidef.h $(srcdir)/lsapilib.h
LOCAL_HDRS =
TARGET = lsapi
TARGET_NAME = lsapi
TARGET_ENTRY = Init_$(TARGET_NAME)
DLLIB = $(TARGET).so
EXTSTATIC =
STATIC_LIB =
TIMESTAMP_DIR = .
BINDIR = $(bindir)
RUBYCOMMONDIR = $(sitedir)$(target_prefix)
RUBYLIBDIR = $(sitelibdir)$(target_prefix)
RUBYARCHDIR = $(sitearchdir)$(target_prefix)
HDRDIR = $(sitehdrdir)$(target_prefix)
ARCHHDRDIR = $(sitearchhdrdir)$(target_prefix)
TARGET_SO_DIR =
TARGET_SO = $(TARGET_SO_DIR)$(DLLIB)
CLEANLIBS = $(TARGET_SO) false
CLEANOBJS = $(OBJS) *.bak
TARGET_SO_DIR_TIMESTAMP = $(TIMESTAMP_DIR)/.sitearchdir.time
all: $(DLLIB)
static: $(STATIC_LIB)
.PHONY: all install static install-so install-rb
.PHONY: clean clean-so clean-static clean-rb
clean-static::
clean-rb-default::
clean-rb::
clean-so::
clean: clean-so clean-static clean-rb-default clean-rb
-$(Q)$(RM_RF) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES) .*.time
distclean-rb-default::
distclean-rb::
distclean-so::
distclean-static::
distclean: clean distclean-so distclean-static distclean-rb-default distclean-rb
-$(Q)$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log
-$(Q)$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES)
-$(Q)$(RMDIRS) $(DISTCLEANDIRS) 2> /dev/null || true
realclean: distclean
install: install-so install-rb
install-so: $(DLLIB) $(TARGET_SO_DIR_TIMESTAMP)
$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
clean-static::
-$(Q)$(RM) $(STATIC_LIB)
install-rb: pre-install-rb do-install-rb install-rb-default
install-rb-default: pre-install-rb-default do-install-rb-default
pre-install-rb: Makefile
pre-install-rb-default: Makefile
do-install-rb:
do-install-rb-default:
pre-install-rb-default:
@$(NULLCMD)
$(TARGET_SO_DIR_TIMESTAMP):
$(Q) $(MAKEDIRS) $(@D) $(RUBYARCHDIR)
$(Q) $(TOUCH) $@
site-install: site-install-so site-install-rb
site-install-so: install-so
site-install-rb: install-rb
.SUFFIXES: .c .m .cc .mm .cxx .cpp .o .S
.cc.o:
$(ECHO) compiling $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
.cc.S:
$(ECHO) translating $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
.mm.o:
$(ECHO) compiling $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
.mm.S:
$(ECHO) translating $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
.cxx.o:
$(ECHO) compiling $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
.cxx.S:
$(ECHO) translating $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
.cpp.o:
$(ECHO) compiling $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
.cpp.S:
$(ECHO) translating $(<)
$(Q) $(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
.c.o:
$(ECHO) compiling $(<)
$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
.c.S:
$(ECHO) translating $(<)
$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
.m.o:
$(ECHO) compiling $(<)
$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -c $(CSRCFLAG)$<
.m.S:
$(ECHO) translating $(<)
$(Q) $(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) $(COUTFLAG)$@ -S $(CSRCFLAG)$<
$(TARGET_SO): $(OBJS) Makefile
$(ECHO) linking shared-object $(DLLIB)
-$(Q)$(RM) $(@)
$(Q) $(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)
$(OBJS): $(HDRS) $(ruby_headers)
share/gems/gems/ruby-lsapi-5.6/ext/lsapi/lsruby.c 0000644 00000055563 15173517751 0015557 0 ustar 00
#include "ruby.h"
#if defined( RUBY_VERSION_CODE ) && RUBY_VERSION_CODE < 180
#include "util.h"
#else
#include <ruby/util.h>
#include <ruby/version.h>
#endif
#include "lsapilib.h"
#include <errno.h>
#include <netinet/in.h>
#include <netinet/tcp.h>
#include <signal.h>
#include <sys/socket.h>
#include <sys/wait.h>
#include <unistd.h>
#include <sys/mman.h>
#include <fcntl.h>
#ifndef RUBY_API_VERSION_CODE
#define RUBY_API_VERSION_CODE (RUBY_API_VERSION_MAJOR*10000+RUBY_API_VERSION_MINOR*100+RUBY_API_VERSION_TEENY)
#endif
/* RUBY_EXTERN VALUE ruby_errinfo; */
RUBY_EXTERN VALUE rb_stdin;
RUBY_EXTERN VALUE rb_stdout;
#if defined( RUBY_VERSION_CODE ) && RUBY_VERSION_CODE < 180
RUBY_EXTERN VALUE rb_defout;
#endif
static VALUE orig_stdin;
static VALUE orig_stdout;
static VALUE orig_stderr;
#if defined( RUBY_VERSION_CODE ) && RUBY_VERSION_CODE < 180
static VALUE orig_defout;
#endif
static VALUE orig_env;
static VALUE env_copy;
static VALUE lsapi_env;
static int MAX_BODYBUF_LENGTH = (10 * 1024 * 1024);
#if RUBY_API_VERSION_CODE >= 20700
# if defined rb_tainted_str_new
# undef rb_tainted_str_new
# endif
# define rb_tainted_str_new(p,l) rb_str_new((p),(l))
#endif
/* static VALUE lsapi_objrefs; */
typedef struct lsapi_data
{
LSAPI_Request * req;
VALUE env;
ssize_t (* fn_write)( LSAPI_Request *, const char * , size_t );
}lsapi_data;
static VALUE cLSAPI;
static VALUE s_req = Qnil;
static lsapi_data * s_req_data;
static VALUE s_req_stderr = Qnil;
static lsapi_data * s_stderr_data;
static pid_t s_pid = 0;
typedef struct lsapi_body
{
char *bodyBuf; //we put small one into memory, otherwise, into a memory mapping file, and we still use the bodyBuf to access this mapping
int bodyLen; //expected length got form content-length
int bodyCurrentLen; //current length by read() readBodyToReqBuf
int curPos;
}lsapi_body;
static lsapi_body s_body;
static char sTempFile[1024] = {0};
/*
* static void lsapi_ruby_setenv(const char *name, const char *value)
* {
* if (!name) return;
*
* if (value && *value)
* ruby_setenv(name, value);
* else
* ruby_unsetenv(name);
} * *
*/
static void lsapi_mark( lsapi_data * data )
{
rb_gc_mark( data->env );
}
/*
* static void lsapi_free_data( lsapi_data * data )
* {
* free( data );
} * *
*/
static int add_env_rails( const char * pKey, int keyLen, const char * pValue, int valLen,
void * arg )
{
char * p;
int len;
/* Fixup some environment variables for rails */
switch( *pKey )
{
case 'Q':
if ( strcmp( pKey, "QUERY_STRING" ) == 0 )
{
if ( !*pValue )
return 1;
}
break;
case 'R':
if (( *(pKey+8) == 'U' )&&( strcmp( pKey, "REQUEST_URI" ) == 0 ))
{
p = strchr( pValue, '?' );
if ( p )
{
len = valLen - ( p - pValue ) - 1;
/*
* valLen = p - pValue;
*p++ = 0;
*/
}
else
{
p = (char *)pValue + valLen;
len = 0;
}
rb_hash_aset( lsapi_env,rb_tainted_str_new("PATH_INFO", 9),
rb_tainted_str_new(pValue, p - pValue));
rb_hash_aset( lsapi_env,rb_tainted_str_new("REQUEST_PATH", 12),
rb_tainted_str_new(pValue, p - pValue));
if ( *p == '?' )
++p;
rb_hash_aset( lsapi_env,rb_tainted_str_new("QUERY_STRING", 12),
rb_tainted_str_new(p, len));
}
break;
case 'S':
if ( strcmp( pKey, "SCRIPT_NAME" ) == 0 )
{
pValue = "/";
valLen = 1;
}
break;
case 'P':
if ( strcmp( pKey, "PATH_INFO" ) == 0 )
return 1;
default:
break;
}
/* lsapi_ruby_setenv(pKey, pValue ); */
rb_hash_aset( lsapi_env,rb_tainted_str_new(pKey, keyLen),
rb_tainted_str_new(pValue, valLen));
return 1;
}
static int add_env_no_fix( const char * pKey, int keyLen, const char * pValue, int valLen,
void * arg )
{
rb_hash_aset( lsapi_env,rb_tainted_str_new(pKey, keyLen),
rb_tainted_str_new(pValue, valLen));
return 1;
}
typedef int (*fn_add_env)( const char * pKey, int keyLen, const char * pValue, int valLen,
void * arg );
fn_add_env s_fn_add_env = add_env_no_fix;
static void clear_env()
{
/* rb_funcall( lsapi_env, rb_intern( "clear" ), 0 ); */
rb_funcall( lsapi_env, rb_intern( "replace" ), 1, env_copy );
}
static void setup_cgi_env( lsapi_data * data )
{
clear_env();
LSAPI_ForeachHeader_r( data->req, s_fn_add_env, data );
LSAPI_ForeachEnv_r( data->req, s_fn_add_env, data );
}
static VALUE lsapi_s_accept( VALUE self )
{
int pid;
if ( LSAPI_Prefork_Accept_r( &g_req ) == -1 )
return Qnil;
else
{
if (s_body.bodyBuf != NULL)
free (s_body.bodyBuf);
s_body.bodyBuf = NULL;
s_body.bodyLen = -1;
s_body.bodyCurrentLen = 0;
s_body.curPos = 0;
pid = getpid();
if ( pid != s_pid )
{
s_pid = pid;
rb_funcall( Qnil, rb_intern( "srand" ), 0 );
}
setup_cgi_env( s_req_data );
return s_req;
}
}
static VALUE lsapi_s_accept_new_conn(VALUE self)
{
if (LSAPI_Accept_Before_Fork(&g_req) == -1 )
return Qnil;
else
return s_req;
}
static VALUE lsapi_s_postfork_child(VALUE self)
{
LSAPI_Postfork_Child(&g_req);
return s_req;
}
static VALUE lsapi_s_postfork_parent(VALUE self)
{
LSAPI_Postfork_Parent(&g_req);
return s_req;
}
/*
* static int chdir_file( const char * pFile )
* {
* char * p = strrchr( pFile, '/' );
* int ret;
* if ( !p )
* return -1;
*p = 0;
ret = chdir( pFile );
*p = '/';
return ret;
}
*/
static VALUE lsapi_eval_string_wrap(VALUE self, VALUE str)
{
#if RUBY_API_VERSION_CODE < 20700
if (rb_safe_level() >= 4)
{
Check_Type(str, T_STRING);
}
else
#endif
{
SafeStringValue(str);
}
return rb_eval_string_wrap(StringValuePtr(str), NULL);
}
static VALUE lsapi_process( VALUE self )
{
/* lsapi_data *data;
const char * pScriptPath;
Data_Get_Struct(self,lsapi_data, data);
pScriptPath = LSAPI_GetScriptFileName_r( data->req );
*/
/*
* if ( chdir_file( pScriptPath ) == -1 )
* {
* lsapi_send_error( 404 );
* }
* rb_load_file( pScriptPath );
*/
return Qnil;
}
static VALUE lsapi_putc(VALUE self, VALUE c)
{
char ch = NUM2CHR(c);
lsapi_data *data;
Data_Get_Struct(self,lsapi_data, data);
if ( (*data->fn_write)( data->req, &ch, 1 ) == 1 )
return c;
else
return INT2NUM( EOF );
}
static VALUE lsapi_write( VALUE self, VALUE str )
{
lsapi_data *data;
int len;
Data_Get_Struct(self,lsapi_data, data);
/* len = LSAPI_Write_r( data->req, RSTRING_PTR(str), RSTRING_LEN(str) ); */
if (TYPE(str) != T_STRING)
str = rb_obj_as_string(str);
len = (*data->fn_write)( data->req, RSTRING_PTR(str), RSTRING_LEN(str) );
return INT2NUM( len );
}
static VALUE lsapi_print( int argc, VALUE *argv, VALUE out )
{
int i;
VALUE line;
/* if no argument given, print `$_' */
if (argc == 0)
{
argc = 1;
line = rb_lastline_get();
argv = &line;
}
for (i = 0; i<argc; i++)
{
if (!NIL_P(rb_output_fs) && i>0)
{
lsapi_write(out, rb_output_fs);
}
switch (TYPE(argv[i]))
{
case T_NIL:
lsapi_write(out, rb_str_new2("nil"));
break;
default:
lsapi_write(out, argv[i]);
break;
}
}
if (!NIL_P(rb_output_rs))
{
lsapi_write(out, rb_output_rs);
}
return Qnil;
}
static VALUE lsapi_printf(int argc, VALUE *argv, VALUE out)
{
lsapi_write(out, rb_f_sprintf(argc, argv));
return Qnil;
}
static VALUE lsapi_puts _((int, VALUE*, VALUE));
#if RUBY_API_VERSION_CODE >= 10900
static VALUE lsapi_puts_ary(VALUE ary, VALUE out, int recur )
{
VALUE tmp;
long i;
if (recur)
{
tmp = rb_str_new2("[...]");
rb_io_puts(1, &tmp, out);
return Qnil;
}
for (i=0; i<RARRAY_LEN(ary); i++)
{
tmp = RARRAY_PTR(ary)[i];
rb_io_puts(1, &tmp, out);
}
return Qnil;
}
#else
static VALUE lsapi_puts_ary(VALUE ary, VALUE out)
{
VALUE tmp;
int i;
for (i=0; i<RARRAY_LEN(ary); i++)
{
tmp = RARRAY_PTR(ary)[i];
if (rb_inspecting_p(tmp))
{
tmp = rb_str_new2("[...]");
}
lsapi_puts(1, &tmp, out);
}
return Qnil;
}
#endif
static VALUE lsapi_puts(int argc, VALUE *argv, VALUE out)
{
int i;
VALUE line;
/* if no argument given, print newline. */
if (argc == 0)
{
lsapi_write(out, rb_default_rs);
return Qnil;
}
for (i=0; i<argc; i++)
{
switch (TYPE(argv[i]))
{
case T_NIL:
line = rb_str_new2("nil");
break;
case T_ARRAY:
#if RUBY_API_VERSION_CODE >= 10900
rb_exec_recursive(lsapi_puts_ary, argv[i], out);
#else
rb_protect_inspect(lsapi_puts_ary, argv[i], out);
#endif
continue;
default:
line = argv[i];
break;
}
line = rb_obj_as_string(line);
lsapi_write(out, line);
if (*( RSTRING_PTR(line) + RSTRING_LEN(line) - 1 ) != '\n')
{
lsapi_write(out, rb_default_rs);
}
}
return Qnil;
}
static VALUE lsapi_addstr(VALUE out, VALUE str)
{
lsapi_write(out, str);
return out;
}
static VALUE lsapi_flush( VALUE self )
{
/*
* lsapi_data *data;
* Data_Get_Struct(self,lsapi_data, data);
*/
LSAPI_Flush_r( &g_req );
return Qnil;
}
static VALUE lsapi_getc( VALUE self )
{
int ch;
/*
* lsapi_data *data;
* Data_Get_Struct(self,lsapi_data, data);
*/
#if RUBY_API_VERSION_CODE < 20700
if (rb_safe_level() >= 4 && !OBJ_TAINTED(self))
{
rb_raise(rb_eSecurityError, "Insecure: operation on untainted IO");
}
#endif
ch = LSAPI_ReqBodyGetChar_r( &g_req );
if ( ch == EOF )
return Qnil;
return INT2NUM( ch );
}
static inline int isBodyWriteToFile()
{
return ((s_body.bodyLen >= MAX_BODYBUF_LENGTH)? (1): (0));
}
//create a temp file and open it, if failed, fd = -1
static inline int createTempFile()
{
int fd = -1;
char *sfn = strdup(sTempFile);
if ((fd = mkstemp(sfn)) == -1)
{
fprintf(stderr, "%s: %s\n", sfn, strerror(errno));
}
else
unlink(sfn);
free(sfn);
return fd;
}
//return 1 if error occured!
//if already created, always OK (0)
static int createBodyBuf()
{
int fd = -1;
if (s_body.bodyLen == -1)
{
s_body.bodyLen = LSAPI_GetReqBodyLen_r(&g_req);
//Error if get a zeor length, should not happen
if (s_body.bodyLen < 0)
{
//Wrong bode length will be treated as 0
s_body.bodyLen = 0;
}
if (s_body.bodyLen > 0)
{
if (isBodyWriteToFile())
{
//create file mapping
fd = createTempFile();
if (fd == -1)
{
return 1;
}
if (ftruncate(fd, s_body.bodyLen) == 0)
{
perror("ftruncate() failed. \n");
close(fd);
return 1;
}
s_body.bodyBuf = mmap(NULL, s_body.bodyLen, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
if (s_body.bodyBuf == MAP_FAILED)
{
perror("File mapping failed. \n");
close(fd);
return 1;
}
close(fd); //close since needn't it anymore
}
else
{
s_body.bodyBuf = (char *)calloc(s_body.bodyLen, sizeof(char));
if (s_body.bodyBuf == NULL)
{
perror("Memory calloc error");
return 1;
}
}
}
}
return 0;
}
static inline int isAllBodyRead()
{
return (s_body.bodyCurrentLen < s_body.bodyLen)? 0 : 1;
}
static inline int isEofBodyBuf()
{
return (s_body.curPos < s_body.bodyLen) ? 0 : 1;
}
//try to read length as times pagesize (such as 8KB * N)
static int readBodyBuf(const int needRead)
{
const int blockSize = 8192;
char *buff = s_body.bodyBuf + s_body.bodyCurrentLen;
int nRead;
int readMore = (needRead + blockSize -1) / blockSize * blockSize;
int remain = LSAPI_GetReqBodyRemain_r( &g_req );
//Only when not enough left, needReadChange will be changed!!!
if (remain < readMore)
readMore = remain;
if ( readMore <= 0 )
return 0;
nRead = LSAPI_ReadReqBody_r(&g_req, buff, readMore);
if ( nRead > 0 )
s_body.bodyCurrentLen += nRead;
return nRead;
}
static VALUE lsapi_gets( VALUE self )
{
VALUE str;
const int blkSize = 4096;
int n;
char *p = NULL;
#if RUBY_API_VERSION_CODE < 20700
if (rb_safe_level() >= 4 && !OBJ_TAINTED(self))
{
rb_raise(rb_eSecurityError, "Insecure: operation on untainted IO");
}
#endif
if (createBodyBuf() == 1)
{
return Qnil;
}
//comment:
while((p = memmem(s_body.bodyBuf + s_body.curPos, s_body.bodyCurrentLen - s_body.curPos, "\n", 1)) == NULL)
{
if (isAllBodyRead() == 1)
break;
//read one page and check, then reply
readBodyBuf(blkSize);
}
p = memmem(s_body.bodyBuf + s_body.curPos, s_body.bodyCurrentLen - s_body.curPos, "\n", 1);
if (p != NULL)
n = p - s_body.bodyBuf - s_body.curPos + 1;
else
n = s_body.bodyCurrentLen - s_body.curPos;
str = rb_str_buf_new( n );
#if RUBY_API_VERSION_CODE < 20700
OBJ_TAINT(str);
#endif
if (n > 0)
{
rb_str_buf_cat( str, s_body.bodyBuf + s_body.curPos, n );
s_body.curPos += n;
}
return str;
}
static VALUE lsapi_read(int argc, VALUE *argv, VALUE self)
{
VALUE str;
int n;
int needRead;
int nRead;
#if RUBY_API_VERSION_CODE < 20700
if (rb_safe_level() >= 4 && !OBJ_TAINTED(self))
{
rb_raise(rb_eSecurityError, "Insecure: operation on untainted IO");
}
#endif
if (createBodyBuf() == 1)
{
return Qnil;
}
//we need to consider these 4 cases:
//1, need all data since argc == 0, we may have all data 2, or not
//3, need a length of data (argv >= 1), we may have enough data already read, 4, or not
if (argc == 0)
n = s_body.bodyLen - s_body.curPos;
else
{
n = NUM2INT(argv[0]); //request that length from currentpos
if (n < 0)
return Qnil;
if (n > s_body.bodyLen - s_body.curPos)
n = s_body.bodyLen - s_body.curPos;
}
needRead = s_body.curPos + n - s_body.bodyCurrentLen;
if (needRead < 0)
needRead = 0;
str = rb_str_buf_new( n );
#if RUBY_API_VERSION_CODE < 20700
OBJ_TAINT(str);
#endif
if (n == 0)
return str;
//copy already have part first
if (n - needRead != 0)
{
rb_str_buf_cat( str, s_body.bodyBuf + s_body.curPos, n - needRead);
s_body.curPos += (n - needRead);
}
if (needRead > 0)
{
//try to read needRead, but may be less (changed) when read the end of the data
nRead = readBodyBuf(needRead);
if (nRead > 0)
{
n = ((nRead < needRead) ? nRead : needRead);
rb_str_buf_cat( str, s_body.bodyBuf + s_body.curPos, n );
s_body.curPos += n;
}
}
return str;
}
static VALUE lsapi_rewind(VALUE self)
{
s_body.curPos = 0;
return self;
}
static VALUE lsapi_each(VALUE self)
{
VALUE str;
lsapi_rewind(self);
while(isEofBodyBuf() != 1)
{
str = lsapi_gets(self);
rb_yield(str);
}
return self;
}
static VALUE lsapi_eof(VALUE self)
{
return (LSAPI_GetReqBodyRemain_r( &g_req ) <= 0) ? Qtrue : Qfalse;
}
static VALUE lsapi_binmode(VALUE self)
{
return self;
}
static VALUE lsapi_isatty(VALUE self)
{
return Qfalse;
}
static VALUE lsapi_sync(VALUE self)
{
return Qfalse;
}
static VALUE lsapi_setsync(VALUE self,VALUE sync)
{
return Qfalse;
}
static VALUE lsapi_close(VALUE self)
{
LSAPI_Flush_r( &g_req );
if (isBodyWriteToFile())
{
//msync(s_body.bodyBuf, s_body.bodyLen, MS_SYNC);
//sleep(5);
munmap(s_body.bodyBuf, s_body.bodyLen);
}
else
free(s_body.bodyBuf);
s_body.bodyBuf = NULL;
s_body.bodyLen = -1;
s_body.bodyCurrentLen = 0;
s_body.curPos = 0;
//Should the temp be deleted here?!
return Qnil;
}
static VALUE lsapi_reopen( int argc, VALUE *argv, VALUE self)
{
VALUE orig_verbose;
if ( self == s_req_stderr )
{
/* constant silence hack */
orig_verbose = (VALUE)ruby_verbose;
ruby_verbose = Qnil;
rb_define_global_const("STDERR", orig_stderr);
ruby_verbose = (VALUE)orig_verbose;
return rb_funcall2( orig_stderr, rb_intern( "reopen" ), argc, argv );
}
return self;
}
static void readMaxBodyBufLength()
{
int n;
const char *p = getenv( "LSAPI_MAX_BODYBUF_LENGTH" );
if ( p )
{
n = atoi( p );
if (n > 0)
{
if (strstr(p, "M") || strstr(p, "m"))
MAX_BODYBUF_LENGTH = n * 1024 * 1024;
else if (strstr(p, "K") || strstr(p, "k"))
MAX_BODYBUF_LENGTH = n * 1024;
else
MAX_BODYBUF_LENGTH = n;
}
}
}
static void readTempFileTemplate()
{
const char *p = getenv( "LSAPI_TEMPFILE" );
if (p == NULL || strlen(p) > 1024 - 7)
p = "/tmp/lsapi.XXXXXX";
strcpy(sTempFile, p);
if (strlen(p) <= 6 || strcmp(p + (strlen(p) - 6), "XXXXXX") != 0)
strcat(sTempFile, ".XXXXXX");
}
static void initBodyBuf()
{
s_body.bodyBuf = NULL;
s_body.bodyLen = -1;
s_body.bodyCurrentLen = 0;
s_body.curPos = 0;
}
void Init_lsapi()
{
VALUE orig_verbose;
char * p;
int prefork = 0;
LSAPI_Init();
initBodyBuf();
readMaxBodyBufLength();
readTempFileTemplate();
p = getenv("LSAPI_CHILDREN");
if (p && atoi(p) > 1)
prefork = 1;
#ifdef rb_thread_select
LSAPI_Init_Env_Parameters( rb_thread_select );
#else
LSAPI_Init_Env_Parameters( select );
#endif
s_pid = getpid();
p = getenv( "RACK_ROOT" );
if ( p )
{
if ( chdir( p ) == -1 )
perror( "chdir()" );
}
if ( p || getenv( "RACK_ENV" ) )
s_fn_add_env = add_env_rails;
orig_stdin = rb_stdin;
orig_stdout = rb_stdout;
orig_stderr = rb_stderr;
#if defined( RUBY_VERSION_CODE ) && RUBY_VERSION_CODE < 180
orig_defout = rb_defout;
#endif
orig_env = rb_const_get( rb_cObject, rb_intern("ENV") );
env_copy = rb_funcall( orig_env, rb_intern( "to_hash" ), 0 );
/* tell the garbage collector it is a global variable, do not recycle it. */
rb_global_variable(&env_copy);
rb_hash_aset( env_copy,rb_tainted_str_new("GATEWAY_Irewindable_input.rbNTERFACE", 17),
rb_tainted_str_new("CGI/1.2", 7));
rb_define_global_function("eval_string_wrap", lsapi_eval_string_wrap, 1);
cLSAPI = rb_define_class("LSAPI", rb_cObject);
rb_undef_alloc_func(cLSAPI);
rb_define_singleton_method(cLSAPI, "accept", lsapi_s_accept, 0);
if (prefork)
{
rb_define_singleton_method(cLSAPI, "accept_new_connection", lsapi_s_accept_new_conn, 0);
rb_define_singleton_method(cLSAPI, "postfork_child", lsapi_s_postfork_child, 0);
rb_define_singleton_method(cLSAPI, "postfork_parent", lsapi_s_postfork_parent, 0);
}
rb_define_method(cLSAPI, "process", lsapi_process, 0 );
/* rb_define_method(cLSAPI, "initialize", lsapi_initialize, 0); */
rb_define_method(cLSAPI, "putc", lsapi_putc, 1);
rb_define_method(cLSAPI, "write", lsapi_write, 1);
rb_define_method(cLSAPI, "print", lsapi_print, -1);
rb_define_method(cLSAPI, "printf", lsapi_printf, -1);
rb_define_method(cLSAPI, "puts", lsapi_puts, -1);
rb_define_method(cLSAPI, "<<", lsapi_addstr, 1);
rb_define_method(cLSAPI, "flush", lsapi_flush, 0);
rb_define_method(cLSAPI, "getc", lsapi_getc, 0);
/* rb_define_method(cLSAPI, "ungetc", lsapi_ungetc, 1); */
rb_define_method(cLSAPI, "gets", lsapi_gets, 0);
//TEST: adding readline function to make irb happy?
/*rb_define_method(cLSAPI, "readline", lsapi_gets, 0); */
rb_define_method(cLSAPI, "read", lsapi_read, -1);
rb_define_method(cLSAPI, "rewind", lsapi_rewind, 0);
rb_define_method(cLSAPI, "each", lsapi_each, 0);
rb_define_method(cLSAPI, "eof", lsapi_eof, 0);
rb_define_method(cLSAPI, "eof?", lsapi_eof, 0);
rb_define_method(cLSAPI, "close", lsapi_close, 0);
/* rb_define_method(cLSAPI, "closed?", lsapi_closed, 0); */
rb_define_method(cLSAPI, "binmode", lsapi_binmode, 0);
rb_define_method(cLSAPI, "isatty", lsapi_isatty, 0);
rb_define_method(cLSAPI, "tty?", lsapi_isatty, 0);
rb_define_method(cLSAPI, "sync", lsapi_sync, 0);
rb_define_method(cLSAPI, "sync=", lsapi_setsync, 1);
rb_define_method(cLSAPI, "reopen", lsapi_reopen, -1 );
s_req = Data_Make_Struct( cLSAPI, lsapi_data, lsapi_mark, free, s_req_data );
s_req_data->req = &g_req;
s_req_data->fn_write = LSAPI_Write_r;
rb_stdin = rb_stdout = s_req;
#if defined( RUBY_VERSION_CODE ) && RUBY_VERSION_CODE < 180
rb_defout = s_req;
#endif
rb_global_variable(&s_req );
s_req_stderr = Data_Make_Struct( cLSAPI, lsapi_data, lsapi_mark, free, s_stderr_data );
s_stderr_data->req = &g_req;
s_stderr_data->fn_write = LSAPI_Write_Stderr_r;
rb_stderr = s_req_stderr;
rb_global_variable(&s_req_stderr );
/* constant silence hack */
orig_verbose = (VALUE)ruby_verbose;
ruby_verbose = Qnil;
lsapi_env = rb_hash_new();
clear_env();
/* redefine ENV using a hash table, should be faster than char **environment */
rb_define_global_const("ENV", lsapi_env);
rb_define_global_const("STDERR", rb_stderr);
ruby_verbose = (VALUE)orig_verbose;
return;
}
share/gems/gems/ruby-lsapi-5.6/setup.rb 0000644 00000106502 15173517751 0013636 0 ustar 00 #
# setup.rb
#
# Copyright (c) 2000-2005 Minero Aoki
#
# This program is free software.
# You can distribute/modify this program under the terms of
# the GNU LGPL, Lesser General Public License version 2.1.
#
unless Enumerable.method_defined?(:map) # Ruby 1.4.6
module Enumerable
alias map collect
end
end
unless File.respond_to?(:read) # Ruby 1.6
def File.read(fname)
open(fname) {|f|
return f.read
}
end
end
unless Errno.const_defined?(:ENOTEMPTY) # Windows?
module Errno
class ENOTEMPTY
# We do not raise this exception, implementation is not needed.
end
end
end
def File.binread(fname)
open(fname, 'rb') {|f|
return f.read
}
end
# for corrupted Windows' stat(2)
def File.dir?(path)
File.directory?((path[-1,1] == '/') ? path : path + '/')
end
class ConfigTable
include Enumerable
def initialize(rbconfig)
@rbconfig = rbconfig
@items = []
@table = {}
# options
@install_prefix = nil
@config_opt = nil
@verbose = true
@no_harm = false
end
attr_accessor :install_prefix
attr_accessor :config_opt
attr_writer :verbose
def verbose?
@verbose
end
attr_writer :no_harm
def no_harm?
@no_harm
end
def [](key)
lookup(key).resolve(self)
end
def []=(key, val)
lookup(key).set val
end
def names
@items.map {|i| i.name }
end
def each(&block)
@items.each(&block)
end
def key?(name)
@table.key?(name)
end
def lookup(name)
@table[name] or setup_rb_error "no such config item: #{name}"
end
def add(item)
@items.push item
@table[item.name] = item
end
def remove(name)
item = lookup(name)
@items.delete_if {|i| i.name == name }
@table.delete_if {|name, i| i.name == name }
item
end
def load_script(path, inst = nil)
if File.file?(path)
MetaConfigEnvironment.new(self, inst).instance_eval File.read(path), path
end
end
def savefile
'.config'
end
def load_savefile
begin
File.foreach(savefile()) do |line|
k, v = *line.split(/=/, 2)
self[k] = v.strip
end
rescue Errno::ENOENT
setup_rb_error $!.message + "\n#{File.basename($0)} config first"
end
end
def save
@items.each {|i| i.value }
File.open(savefile(), 'w') {|f|
@items.each do |i|
f.printf "%s=%s\n", i.name, i.value if i.value? and i.value
end
}
end
def load_standard_entries
standard_entries(@rbconfig).each do |ent|
add ent
end
end
def standard_entries(rbconfig)
c = rbconfig
rubypath = File.join(c['bindir'], c['ruby_install_name'] + c['EXEEXT'])
major = c['MAJOR'].to_i
minor = c['MINOR'].to_i
teeny = c['TEENY'].to_i
version = "#{major}.#{minor}"
# ruby ver. >= 1.4.4?
newpath_p = ((major >= 2) or
((major == 1) and
((minor >= 5) or
((minor == 4) and (teeny >= 4)))))
if c['rubylibdir']
# V > 1.6.3
libruby = "#{c['prefix']}/lib/ruby"
librubyver = c['rubylibdir']
librubyverarch = c['archdir']
siteruby = c['sitedir']
siterubyver = c['sitelibdir']
siterubyverarch = c['sitearchdir']
elsif newpath_p
# 1.4.4 <= V <= 1.6.3
libruby = "#{c['prefix']}/lib/ruby"
librubyver = "#{c['prefix']}/lib/ruby/#{version}"
librubyverarch = "#{c['prefix']}/lib/ruby/#{version}/#{c['arch']}"
siteruby = c['sitedir']
siterubyver = "$siteruby/#{version}"
siterubyverarch = "$siterubyver/#{c['arch']}"
else
# V < 1.4.4
libruby = "#{c['prefix']}/lib/ruby"
librubyver = "#{c['prefix']}/lib/ruby/#{version}"
librubyverarch = "#{c['prefix']}/lib/ruby/#{version}/#{c['arch']}"
siteruby = "#{c['prefix']}/lib/ruby/#{version}/site_ruby"
siterubyver = siteruby
siterubyverarch = "$siterubyver/#{c['arch']}"
end
parameterize = lambda {|path|
path.sub(/\A#{Regexp.quote(c['prefix'])}/, '$prefix')
}
if arg = c['configure_args'].split.detect {|arg| /--with-make-prog=/ =~ arg }
makeprog = arg.sub(/'/, '').split(/=/, 2)[1]
else
makeprog = 'make'
end
[
ExecItem.new('installdirs', 'std/site/home',
'std: install under libruby; site: install under site_ruby; home: install under $HOME')\
{|val, table|
case val
when 'std'
table['rbdir'] = '$librubyver'
table['sodir'] = '$librubyverarch'
when 'site'
table['rbdir'] = '$siterubyver'
table['sodir'] = '$siterubyverarch'
when 'home'
setup_rb_error '$HOME was not set' unless ENV['HOME']
table['prefix'] = ENV['HOME']
table['rbdir'] = '$libdir/ruby'
table['sodir'] = '$libdir/ruby'
end
},
PathItem.new('prefix', 'path', c['prefix'],
'path prefix of target environment'),
PathItem.new('bindir', 'path', parameterize.call(c['bindir']),
'the directory for commands'),
PathItem.new('libdir', 'path', parameterize.call(c['libdir']),
'the directory for libraries'),
PathItem.new('datadir', 'path', parameterize.call(c['datadir']),
'the directory for shared data'),
PathItem.new('mandir', 'path', parameterize.call(c['mandir']),
'the directory for man pages'),
PathItem.new('sysconfdir', 'path', parameterize.call(c['sysconfdir']),
'the directory for system configuration files'),
PathItem.new('localstatedir', 'path', parameterize.call(c['localstatedir']),
'the directory for local state data'),
PathItem.new('libruby', 'path', libruby,
'the directory for ruby libraries'),
PathItem.new('librubyver', 'path', librubyver,
'the directory for standard ruby libraries'),
PathItem.new('librubyverarch', 'path', librubyverarch,
'the directory for standard ruby extensions'),
PathItem.new('siteruby', 'path', siteruby,
'the directory for version-independent aux ruby libraries'),
PathItem.new('siterubyver', 'path', siterubyver,
'the directory for aux ruby libraries'),
PathItem.new('siterubyverarch', 'path', siterubyverarch,
'the directory for aux ruby binaries'),
PathItem.new('rbdir', 'path', '$siterubyver',
'the directory for ruby scripts'),
PathItem.new('sodir', 'path', '$siterubyverarch',
'the directory for ruby extentions'),
PathItem.new('rubypath', 'path', rubypath,
'the path to set to #! line'),
ProgramItem.new('rubyprog', 'name', rubypath,
'the ruby program using for installation'),
ProgramItem.new('makeprog', 'name', makeprog,
'the make program to compile ruby extentions'),
SelectItem.new('shebang', 'all/ruby/never', 'ruby',
'shebang line (#!) editing mode'),
BoolItem.new('without-ext', 'yes/no', 'no',
'does not compile/install ruby extentions')
]
end
private :standard_entries
def load_multipackage_entries
multipackage_entries().each do |ent|
add ent
end
end
def multipackage_entries
[
PackageSelectionItem.new('with', 'name,name...', '', 'ALL',
'package names that you want to install'),
PackageSelectionItem.new('without', 'name,name...', '', 'NONE',
'package names that you do not want to install')
]
end
private :multipackage_entries
ALIASES = {
'std-ruby' => 'librubyver',
'stdruby' => 'librubyver',
'rubylibdir' => 'librubyver',
'archdir' => 'librubyverarch',
'site-ruby-common' => 'siteruby', # For backward compatibility
'site-ruby' => 'siterubyver', # For backward compatibility
'bin-dir' => 'bindir',
'bin-dir' => 'bindir',
'rb-dir' => 'rbdir',
'so-dir' => 'sodir',
'data-dir' => 'datadir',
'ruby-path' => 'rubypath',
'ruby-prog' => 'rubyprog',
'ruby' => 'rubyprog',
'make-prog' => 'makeprog',
'make' => 'makeprog'
}
def fixup
ALIASES.each do |ali, name|
@table[ali] = @table[name]
end
@items.freeze
@table.freeze
@options_re = /\A--(#{@table.keys.join('|')})(?:=(.*))?\z/
end
def parse_opt(opt)
m = @options_re.match(opt) or setup_rb_error "config: unknown option #{opt}"
m.to_a[1,2]
end
def dllext
@rbconfig['DLEXT']
end
def value_config?(name)
lookup(name).value?
end
class Item
def initialize(name, template, default, desc)
@name = name.freeze
@template = template
@value = default
@default = default
@description = desc
end
attr_reader :name
attr_reader :description
attr_accessor :default
alias help_default default
def help_opt
"--#{@name}=#{@template}"
end
def value?
true
end
def value
@value
end
def resolve(table)
@value.gsub(%r<\$([^/]+)>) { table[$1] }
end
def set(val)
@value = check(val)
end
private
def check(val)
setup_rb_error "config: --#{name} requires argument" unless val
val
end
end
class BoolItem < Item
def config_type
'bool'
end
def help_opt
"--#{@name}"
end
private
def check(val)
return 'yes' unless val
case val
when /\Ay(es)?\z/i, /\At(rue)?\z/i then 'yes'
when /\An(o)?\z/i, /\Af(alse)\z/i then 'no'
else
setup_rb_error "config: --#{@name} accepts only yes/no for argument"
end
end
end
class PathItem < Item
def config_type
'path'
end
private
def check(path)
setup_rb_error "config: --#{@name} requires argument" unless path
path[0,1] == '$' ? path : File.expand_path(path)
end
end
class ProgramItem < Item
def config_type
'program'
end
end
class SelectItem < Item
def initialize(name, selection, default, desc)
super
@ok = selection.split('/')
end
def config_type
'select'
end
private
def check(val)
unless @ok.include?(val.strip)
setup_rb_error "config: use --#{@name}=#{@template} (#{val})"
end
val.strip
end
end
class ExecItem < Item
def initialize(name, selection, desc, &block)
super name, selection, nil, desc
@ok = selection.split('/')
@action = block
end
def config_type
'exec'
end
def value?
false
end
def resolve(table)
setup_rb_error "$#{name()} wrongly used as option value"
end
undef set
def evaluate(val, table)
v = val.strip.downcase
unless @ok.include?(v)
setup_rb_error "invalid option --#{@name}=#{val} (use #{@template})"
end
@action.call v, table
end
end
class PackageSelectionItem < Item
def initialize(name, template, default, help_default, desc)
super name, template, default, desc
@help_default = help_default
end
attr_reader :help_default
def config_type
'package'
end
private
def check(val)
unless File.dir?("packages/#{val}")
setup_rb_error "config: no such package: #{val}"
end
val
end
end
class MetaConfigEnvironment
def initialize(config, installer)
@config = config
@installer = installer
end
def config_names
@config.names
end
def config?(name)
@config.key?(name)
end
def bool_config?(name)
@config.lookup(name).config_type == 'bool'
end
def path_config?(name)
@config.lookup(name).config_type == 'path'
end
def value_config?(name)
@config.lookup(name).config_type != 'exec'
end
def add_config(item)
@config.add item
end
def add_bool_config(name, default, desc)
@config.add BoolItem.new(name, 'yes/no', default ? 'yes' : 'no', desc)
end
def add_path_config(name, default, desc)
@config.add PathItem.new(name, 'path', default, desc)
end
def set_config_default(name, default)
@config.lookup(name).default = default
end
def remove_config(name)
@config.remove(name)
end
# For only multipackage
def packages
raise '[setup.rb fatal] multi-package metaconfig API packages() called for single-package; contact application package vendor' unless @installer
@installer.packages
end
# For only multipackage
def declare_packages(list)
raise '[setup.rb fatal] multi-package metaconfig API declare_packages() called for single-package; contact application package vendor' unless @installer
@installer.packages = list
end
end
end # class ConfigTable
# This module requires: #verbose?, #no_harm?
module FileOperations
def mkdir_p(dirname, prefix = nil)
dirname = prefix + File.expand_path(dirname) if prefix
$stderr.puts "mkdir -p #{dirname}" if verbose?
return if no_harm?
# Does not check '/', it's too abnormal.
dirs = File.expand_path(dirname).split(%r<(?=/)>)
if /\A[a-z]:\z/i =~ dirs[0]
disk = dirs.shift
dirs[0] = disk + dirs[0]
end
dirs.each_index do |idx|
path = dirs[0..idx].join('')
Dir.mkdir path unless File.dir?(path)
end
end
def rm_f(path)
$stderr.puts "rm -f #{path}" if verbose?
return if no_harm?
force_remove_file path
end
def rm_rf(path)
$stderr.puts "rm -rf #{path}" if verbose?
return if no_harm?
remove_tree path
end
def remove_tree(path)
if File.symlink?(path)
remove_file path
elsif File.dir?(path)
remove_tree0 path
else
force_remove_file path
end
end
def remove_tree0(path)
Dir.foreach(path) do |ent|
next if ent == '.'
next if ent == '..'
entpath = "#{path}/#{ent}"
if File.symlink?(entpath)
remove_file entpath
elsif File.dir?(entpath)
remove_tree0 entpath
else
force_remove_file entpath
end
end
begin
Dir.rmdir path
rescue Errno::ENOTEMPTY
# directory may not be empty
end
end
def move_file(src, dest)
force_remove_file dest
begin
File.rename src, dest
rescue
File.open(dest, 'wb') {|f|
f.write File.binread(src)
}
File.chmod File.stat(src).mode, dest
File.unlink src
end
end
def force_remove_file(path)
begin
remove_file path
rescue
end
end
def remove_file(path)
File.chmod 0777, path
File.unlink path
end
def install(from, dest, mode, prefix = nil)
$stderr.puts "install #{from} #{dest}" if verbose?
return if no_harm?
realdest = prefix ? prefix + File.expand_path(dest) : dest
realdest = File.join(realdest, File.basename(from)) if File.dir?(realdest)
str = File.binread(from)
if diff?(str, realdest)
verbose_off {
rm_f realdest if File.exist?(realdest)
}
File.open(realdest, 'wb') {|f|
f.write str
}
File.chmod mode, realdest
File.open("#{objdir_root()}/InstalledFiles", 'a') {|f|
if prefix
f.puts realdest.sub(prefix, '')
else
f.puts realdest
end
}
end
end
def diff?(new_content, path)
return true unless File.exist?(path)
new_content != File.binread(path)
end
def command(*args)
$stderr.puts args.join(' ') if verbose?
system(*args) or raise RuntimeError,
"system(#{args.map{|a| a.inspect }.join(' ')}) failed"
end
def ruby(*args)
command config('rubyprog'), *args
end
def make(task = nil)
command(*[config('makeprog'), task].compact)
end
def extdir?(dir)
File.exist?("#{dir}/MANIFEST") or File.exist?("#{dir}/extconf.rb")
end
def files_of(dir)
Dir.open(dir) {|d|
return d.select {|ent| File.file?("#{dir}/#{ent}") }
}
end
DIR_REJECT = %w( . .. CVS SCCS RCS CVS.adm .svn )
def directories_of(dir)
Dir.open(dir) {|d|
return d.select {|ent| File.dir?("#{dir}/#{ent}") } - DIR_REJECT
}
end
end
# This module requires: #srcdir_root, #objdir_root, #relpath
module HookScriptAPI
def get_config(key)
@config[key]
end
alias config get_config
# obsolete: use metaconfig to change configuration
def set_config(key, val)
@config[key] = val
end
#
# srcdir/objdir (works only in the package directory)
#
def curr_srcdir
"#{srcdir_root()}/#{relpath()}"
end
def curr_objdir
"#{objdir_root()}/#{relpath()}"
end
def srcfile(path)
"#{curr_srcdir()}/#{path}"
end
def srcexist?(path)
File.exist?(srcfile(path))
end
def srcdirectory?(path)
File.dir?(srcfile(path))
end
def srcfile?(path)
File.file?(srcfile(path))
end
def srcentries(path = '.')
Dir.open("#{curr_srcdir()}/#{path}") {|d|
return d.to_a - %w(. ..)
}
end
def srcfiles(path = '.')
srcentries(path).select {|fname|
File.file?(File.join(curr_srcdir(), path, fname))
}
end
def srcdirectories(path = '.')
srcentries(path).select {|fname|
File.dir?(File.join(curr_srcdir(), path, fname))
}
end
end
class ToplevelInstaller
Version = '3.4.1'
Copyright = 'Copyright (c) 2000-2005 Minero Aoki'
TASKS = [
[ 'all', 'do config, setup, then install' ],
[ 'config', 'saves your configurations' ],
[ 'show', 'shows current configuration' ],
[ 'setup', 'compiles ruby extentions and others' ],
[ 'install', 'installs files' ],
[ 'test', 'run all tests in test/' ],
[ 'clean', "does `make clean' for each extention" ],
[ 'distclean',"does `make distclean' for each extention" ]
]
def ToplevelInstaller.invoke
config = ConfigTable.new(load_rbconfig())
config.load_standard_entries
config.load_multipackage_entries if multipackage?
config.fixup
klass = (multipackage?() ? ToplevelInstallerMulti : ToplevelInstaller)
klass.new(File.dirname($0), config).invoke
end
def ToplevelInstaller.multipackage?
File.dir?(File.dirname($0) + '/packages')
end
def ToplevelInstaller.load_rbconfig
if arg = ARGV.detect {|arg| /\A--rbconfig=/ =~ arg }
ARGV.delete(arg)
load File.expand_path(arg.split(/=/, 2)[1])
$".push 'rbconfig.rb'
else
require 'rbconfig'
end
::Config::CONFIG
end
def initialize(ardir_root, config)
@ardir = File.expand_path(ardir_root)
@config = config
# cache
@valid_task_re = nil
end
def config(key)
@config[key]
end
def inspect
"#<#{self.class} #{__id__()}>"
end
def invoke
run_metaconfigs
case task = parsearg_global()
when nil, 'all'
parsearg_config
init_installers
exec_config
exec_setup
exec_install
else
case task
when 'config', 'test'
;
when 'clean', 'distclean'
@config.load_savefile if File.exist?(@config.savefile)
else
@config.load_savefile
end
__send__ "parsearg_#{task}"
init_installers
__send__ "exec_#{task}"
end
end
def run_metaconfigs
@config.load_script "#{@ardir}/metaconfig"
end
def init_installers
@installer = Installer.new(@config, @ardir, File.expand_path('.'))
end
#
# Hook Script API bases
#
def srcdir_root
@ardir
end
def objdir_root
'.'
end
def relpath
'.'
end
#
# Option Parsing
#
def parsearg_global
while arg = ARGV.shift
case arg
when /\A\w+\z/
setup_rb_error "invalid task: #{arg}" unless valid_task?(arg)
return arg
when '-q', '--quiet'
@config.verbose = false
when '--verbose'
@config.verbose = true
when '--help'
print_usage $stdout
exit 0
when '--version'
puts "#{File.basename($0)} version #{Version}"
exit 0
when '--copyright'
puts Copyright
exit 0
else
setup_rb_error "unknown global option '#{arg}'"
end
end
nil
end
def valid_task?(t)
valid_task_re() =~ t
end
def valid_task_re
@valid_task_re ||= /\A(?:#{TASKS.map {|task,desc| task }.join('|')})\z/
end
def parsearg_no_options
unless ARGV.empty?
task = caller(0).first.slice(%r<`parsearg_(\w+)'>, 1)
setup_rb_error "#{task}: unknown options: #{ARGV.join(' ')}"
end
end
alias parsearg_show parsearg_no_options
alias parsearg_setup parsearg_no_options
alias parsearg_test parsearg_no_options
alias parsearg_clean parsearg_no_options
alias parsearg_distclean parsearg_no_options
def parsearg_config
evalopt = []
set = []
@config.config_opt = []
while i = ARGV.shift
if /\A--?\z/ =~ i
@config.config_opt = ARGV.dup
break
end
name, value = *@config.parse_opt(i)
if @config.value_config?(name)
@config[name] = value
else
evalopt.push [name, value]
end
set.push name
end
evalopt.each do |name, value|
@config.lookup(name).evaluate value, @config
end
# Check if configuration is valid
set.each do |n|
@config[n] if @config.value_config?(n)
end
end
def parsearg_install
@config.no_harm = false
@config.install_prefix = ''
while a = ARGV.shift
case a
when '--no-harm'
@config.no_harm = true
when /\A--prefix=/
path = a.split(/=/, 2)[1]
path = File.expand_path(path) unless path[0,1] == '/'
@config.install_prefix = path
else
setup_rb_error "install: unknown option #{a}"
end
end
end
def print_usage(out)
out.puts 'Typical Installation Procedure:'
out.puts " $ ruby #{File.basename $0} config"
out.puts " $ ruby #{File.basename $0} setup"
out.puts " # ruby #{File.basename $0} install (may require root privilege)"
out.puts
out.puts 'Detailed Usage:'
out.puts " ruby #{File.basename $0} <global option>"
out.puts " ruby #{File.basename $0} [<global options>] <task> [<task options>]"
fmt = " %-24s %s\n"
out.puts
out.puts 'Global options:'
out.printf fmt, '-q,--quiet', 'suppress message outputs'
out.printf fmt, ' --verbose', 'output messages verbosely'
out.printf fmt, ' --help', 'print this message'
out.printf fmt, ' --version', 'print version and quit'
out.printf fmt, ' --copyright', 'print copyright and quit'
out.puts
out.puts 'Tasks:'
TASKS.each do |name, desc|
out.printf fmt, name, desc
end
fmt = " %-24s %s [%s]\n"
out.puts
out.puts 'Options for CONFIG or ALL:'
@config.each do |item|
out.printf fmt, item.help_opt, item.description, item.help_default
end
out.printf fmt, '--rbconfig=path', 'rbconfig.rb to load',"running ruby's"
out.puts
out.puts 'Options for INSTALL:'
out.printf fmt, '--no-harm', 'only display what to do if given', 'off'
out.printf fmt, '--prefix=path', 'install path prefix', ''
out.puts
end
#
# Task Handlers
#
def exec_config
@installer.exec_config
@config.save # must be final
end
def exec_setup
@installer.exec_setup
end
def exec_install
@installer.exec_install
end
def exec_test
@installer.exec_test
end
def exec_show
@config.each do |i|
printf "%-20s %s\n", i.name, i.value if i.value?
end
end
def exec_clean
@installer.exec_clean
end
def exec_distclean
@installer.exec_distclean
end
end # class ToplevelInstaller
class ToplevelInstallerMulti < ToplevelInstaller
include FileOperations
def initialize(ardir_root, config)
super
@packages = directories_of("#{@ardir}/packages")
raise 'no package exists' if @packages.empty?
@root_installer = Installer.new(@config, @ardir, File.expand_path('.'))
end
def run_metaconfigs
@config.load_script "#{@ardir}/metaconfig", self
@packages.each do |name|
@config.load_script "#{@ardir}/packages/#{name}/metaconfig"
end
end
attr_reader :packages
def packages=(list)
raise 'package list is empty' if list.empty?
list.each do |name|
raise "directory packages/#{name} does not exist"\
unless File.dir?("#{@ardir}/packages/#{name}")
end
@packages = list
end
def init_installers
@installers = {}
@packages.each do |pack|
@installers[pack] = Installer.new(@config,
"#{@ardir}/packages/#{pack}",
"packages/#{pack}")
end
with = extract_selection(config('with'))
without = extract_selection(config('without'))
@selected = @installers.keys.select {|name|
(with.empty? or with.include?(name)) \
and not without.include?(name)
}
end
def extract_selection(list)
a = list.split(/,/)
a.each do |name|
setup_rb_error "no such package: #{name}" unless @installers.key?(name)
end
a
end
def print_usage(f)
super
f.puts 'Inluded packages:'
f.puts ' ' + @packages.sort.join(' ')
f.puts
end
#
# Task Handlers
#
def exec_config
run_hook 'pre-config'
each_selected_installers {|inst| inst.exec_config }
run_hook 'post-config'
@config.save # must be final
end
def exec_setup
run_hook 'pre-setup'
each_selected_installers {|inst| inst.exec_setup }
run_hook 'post-setup'
end
def exec_install
run_hook 'pre-install'
each_selected_installers {|inst| inst.exec_install }
run_hook 'post-install'
end
def exec_test
run_hook 'pre-test'
each_selected_installers {|inst| inst.exec_test }
run_hook 'post-test'
end
def exec_clean
rm_f @config.savefile
run_hook 'pre-clean'
each_selected_installers {|inst| inst.exec_clean }
run_hook 'post-clean'
end
def exec_distclean
rm_f @config.savefile
run_hook 'pre-distclean'
each_selected_installers {|inst| inst.exec_distclean }
run_hook 'post-distclean'
end
#
# lib
#
def each_selected_installers
Dir.mkdir 'packages' unless File.dir?('packages')
@selected.each do |pack|
$stderr.puts "Processing the package `#{pack}' ..." if verbose?
Dir.mkdir "packages/#{pack}" unless File.dir?("packages/#{pack}")
Dir.chdir "packages/#{pack}"
yield @installers[pack]
Dir.chdir '../..'
end
end
def run_hook(id)
@root_installer.run_hook id
end
# module FileOperations requires this
def verbose?
@config.verbose?
end
# module FileOperations requires this
def no_harm?
@config.no_harm?
end
end # class ToplevelInstallerMulti
class Installer
FILETYPES = %w( bin lib ext data conf man )
include FileOperations
include HookScriptAPI
def initialize(config, srcroot, objroot)
@config = config
@srcdir = File.expand_path(srcroot)
@objdir = File.expand_path(objroot)
@currdir = '.'
end
def inspect
"#<#{self.class} #{File.basename(@srcdir)}>"
end
def noop(rel)
end
#
# Hook Script API base methods
#
def srcdir_root
@srcdir
end
def objdir_root
@objdir
end
def relpath
@currdir
end
#
# Config Access
#
# module FileOperations requires this
def verbose?
@config.verbose?
end
# module FileOperations requires this
def no_harm?
@config.no_harm?
end
def verbose_off
begin
save, @config.verbose = @config.verbose?, false
yield
ensure
@config.verbose = save
end
end
#
# TASK config
#
def exec_config
exec_task_traverse 'config'
end
alias config_dir_bin noop
alias config_dir_lib noop
def config_dir_ext(rel)
extconf if extdir?(curr_srcdir())
end
alias config_dir_data noop
alias config_dir_conf noop
alias config_dir_man noop
def extconf
ruby "#{curr_srcdir()}/extconf.rb", *@config.config_opt
end
#
# TASK setup
#
def exec_setup
exec_task_traverse 'setup'
end
def setup_dir_bin(rel)
files_of(curr_srcdir()).each do |fname|
update_shebang_line "#{curr_srcdir()}/#{fname}"
end
end
alias setup_dir_lib noop
def setup_dir_ext(rel)
make if extdir?(curr_srcdir())
end
alias setup_dir_data noop
alias setup_dir_conf noop
alias setup_dir_man noop
def update_shebang_line(path)
return if no_harm?
return if config('shebang') == 'never'
old = Shebang.load(path)
if old
$stderr.puts "warning: #{path}: Shebang line includes too many args. It is not portable and your program may not work." if old.args.size > 1
new = new_shebang(old)
return if new.to_s == old.to_s
else
return unless config('shebang') == 'all'
new = Shebang.new(config('rubypath'))
end
$stderr.puts "updating shebang: #{File.basename(path)}" if verbose?
open_atomic_writer(path) {|output|
File.open(path, 'rb') {|f|
f.gets if old # discard
output.puts new.to_s
output.print f.read
}
}
end
def new_shebang(old)
if /\Aruby/ =~ File.basename(old.cmd)
Shebang.new(config('rubypath'), old.args)
elsif File.basename(old.cmd) == 'env' and old.args.first == 'ruby'
Shebang.new(config('rubypath'), old.args[1..-1])
else
return old unless config('shebang') == 'all'
Shebang.new(config('rubypath'))
end
end
def open_atomic_writer(path, &block)
tmpfile = File.basename(path) + '.tmp'
begin
File.open(tmpfile, 'wb', &block)
File.rename tmpfile, File.basename(path)
ensure
File.unlink tmpfile if File.exist?(tmpfile)
end
end
class Shebang
def Shebang.load(path)
line = nil
File.open(path) {|f|
line = f.gets
}
return nil unless /\A#!/ =~ line
parse(line)
end
def Shebang.parse(line)
cmd, *args = *line.strip.sub(/\A\#!/, '').split(' ')
new(cmd, args)
end
def initialize(cmd, args = [])
@cmd = cmd
@args = args
end
attr_reader :cmd
attr_reader :args
def to_s
"#! #{@cmd}" + (@args.empty? ? '' : " #{@args.join(' ')}")
end
end
#
# TASK install
#
def exec_install
rm_f 'InstalledFiles'
exec_task_traverse 'install'
end
def install_dir_bin(rel)
install_files targetfiles(), "#{config('bindir')}/#{rel}", 0755
end
def install_dir_lib(rel)
install_files libfiles(), "#{config('rbdir')}/#{rel}", 0644
end
def install_dir_ext(rel)
return unless extdir?(curr_srcdir())
install_files rubyextentions('.'),
"#{config('sodir')}/#{File.dirname(rel)}",
0555
end
def install_dir_data(rel)
install_files targetfiles(), "#{config('datadir')}/#{rel}", 0644
end
def install_dir_conf(rel)
# FIXME: should not remove current config files
# (rename previous file to .old/.org)
install_files targetfiles(), "#{config('sysconfdir')}/#{rel}", 0644
end
def install_dir_man(rel)
install_files targetfiles(), "#{config('mandir')}/#{rel}", 0644
end
def install_files(list, dest, mode)
mkdir_p dest, @config.install_prefix
list.each do |fname|
install fname, dest, mode, @config.install_prefix
end
end
def libfiles
glob_reject(%w(*.y *.output), targetfiles())
end
def rubyextentions(dir)
ents = glob_select("*.#{@config.dllext}", targetfiles())
if ents.empty?
setup_rb_error "no ruby extention exists: 'ruby #{$0} setup' first"
end
ents
end
def targetfiles
mapdir(existfiles() - hookfiles())
end
def mapdir(ents)
ents.map {|ent|
if File.exist?(ent)
then ent # objdir
else "#{curr_srcdir()}/#{ent}" # srcdir
end
}
end
# picked up many entries from cvs-1.11.1/src/ignore.c
JUNK_FILES = %w(
core RCSLOG tags TAGS .make.state
.nse_depinfo #* .#* cvslog.* ,* .del-* *.olb
*~ *.old *.bak *.BAK *.orig *.rej _$* *$
*.org *.in .*
)
def existfiles
glob_reject(JUNK_FILES, (files_of(curr_srcdir()) | files_of('.')))
end
def hookfiles
%w( pre-%s post-%s pre-%s.rb post-%s.rb ).map {|fmt|
%w( config setup install clean ).map {|t| sprintf(fmt, t) }
}.flatten
end
def glob_select(pat, ents)
re = globs2re([pat])
ents.select {|ent| re =~ ent }
end
def glob_reject(pats, ents)
re = globs2re(pats)
ents.reject {|ent| re =~ ent }
end
GLOB2REGEX = {
'.' => '\.',
'$' => '\$',
'#' => '\#',
'*' => '.*'
}
def globs2re(pats)
/\A(?:#{
pats.map {|pat| pat.gsub(/[\.\$\#\*]/) {|ch| GLOB2REGEX[ch] } }.join('|')
})\z/
end
#
# TASK test
#
TESTDIR = 'test'
def exec_test
unless File.directory?('test')
$stderr.puts 'no test in this package' if verbose?
return
end
$stderr.puts 'Running tests...' if verbose?
begin
require 'test/unit'
rescue LoadError
setup_rb_error 'test/unit cannot loaded. You need Ruby 1.8 or later to invoke this task.'
end
runner = Test::Unit::AutoRunner.new(true)
runner.to_run << TESTDIR
runner.run
end
#
# TASK clean
#
def exec_clean
exec_task_traverse 'clean'
rm_f @config.savefile
rm_f 'InstalledFiles'
end
alias clean_dir_bin noop
alias clean_dir_lib noop
alias clean_dir_data noop
alias clean_dir_conf noop
alias clean_dir_man noop
def clean_dir_ext(rel)
return unless extdir?(curr_srcdir())
make 'clean' if File.file?('Makefile')
end
#
# TASK distclean
#
def exec_distclean
exec_task_traverse 'distclean'
rm_f @config.savefile
rm_f 'InstalledFiles'
end
alias distclean_dir_bin noop
alias distclean_dir_lib noop
def distclean_dir_ext(rel)
return unless extdir?(curr_srcdir())
make 'distclean' if File.file?('Makefile')
end
alias distclean_dir_data noop
alias distclean_dir_conf noop
alias distclean_dir_man noop
#
# Traversing
#
def exec_task_traverse(task)
run_hook "pre-#{task}"
FILETYPES.each do |type|
if type == 'ext' and config('without-ext') == 'yes'
$stderr.puts 'skipping ext/* by user option' if verbose?
next
end
traverse task, type, "#{task}_dir_#{type}"
end
run_hook "post-#{task}"
end
def traverse(task, rel, mid)
dive_into(rel) {
run_hook "pre-#{task}"
__send__ mid, rel.sub(%r[\A.*?(?:/|\z)], '')
directories_of(curr_srcdir()).each do |d|
traverse task, "#{rel}/#{d}", mid
end
run_hook "post-#{task}"
}
end
def dive_into(rel)
return unless File.dir?("#{@srcdir}/#{rel}")
dir = File.basename(rel)
Dir.mkdir dir unless File.dir?(dir)
prevdir = Dir.pwd
Dir.chdir dir
$stderr.puts '---> ' + rel if verbose?
@currdir = rel
yield
Dir.chdir prevdir
$stderr.puts '<--- ' + rel if verbose?
@currdir = File.dirname(rel)
end
def run_hook(id)
path = [ "#{curr_srcdir()}/#{id}",
"#{curr_srcdir()}/#{id}.rb" ].detect {|cand| File.file?(cand) }
return unless path
begin
instance_eval File.read(path), path, 1
rescue
raise if $DEBUG
setup_rb_error "hook #{path} failed:\n" + $!.message
end
end
end # class Installer
class SetupError < StandardError; end
def setup_rb_error(msg)
raise SetupError, msg
end
if $0 == __FILE__
begin
ToplevelInstaller.invoke
rescue SetupError
raise if $DEBUG
$stderr.puts $!.message
$stderr.puts "Try 'ruby #{$0} --help' for detailed usage."
exit 1
end
end
share/gems/gems/ruby-lsapi-5.6/examples/lsapi_with_cgi.rb 0000755 00000000357 15173517751 0017305 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
require 'lsapi'
require 'cgi'
while LSAPI.accept != nil
cgi = CGI.new
name = cgi['name']
puts cgi.header
puts "Hello #{name}! <br> " if name
puts "You are from #{cgi.remote_addr}<br>"
end
share/gems/gems/ruby-lsapi-5.6/examples/testlsapi.rb 0000755 00000000413 15173517751 0016321 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
require 'lsapi'
$count = 0;
while LSAPI.accept != nil
print "HTTP/1.0 200 OK\r\nContent-type: text/html\r\n\r\nHello World! \##{$count}<br>\r\n"
ENV.each_pair {|key, value| print "#{key} is #{value}<br>\r\n" }
$count = $count + 1
end
share/gems/gems/ruby-lsapi-5.6/rails/dispatch.lsapi 0000755 00000000770 15173517751 0016117 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
if GC.respond_to?(:copy_on_write_friendly=)
GC.copy_on_write_friendly = true
end
require File.dirname(__FILE__) + "/../config/environment" unless defined?(RAILS_ROOT)
# If you're using RubyGems and mod_ruby, this require should be changed to an absolute path one, like:
# "/usr/local/lib/ruby/gems/1.8/gems/rails-0.8.0/lib/dispatcher" -- otherwise performance is severely impaired
require "dispatcher"
require "lsapi"
while LSAPI.accept != nil
Dispatcher.dispatch
end
share/gems/gems/ruby-lsapi-5.6/scripts/lsruby_runner.rb 0000755 00000002115 15173517751 0017074 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
require 'lsapi'
class CodeCache
def [](filename)
mtime = File.mtime( filename )
entry = @cache[filename];
if entry != nil
return entry
end
code = compile(filename)
#entry = CodeEntry.new( filename, mtime, code )
@cache[filename] = code
return code
end
private
def initialize
@cache = {}
end
def compile(filename)
open(filename) do |f|
s = f.read
s.untaint
binding = eval_string_wrap("binding")
return eval(format("Proc.new {\n%s\n}", s), binding, filename, 0)
end
end
end
$count = 0;
$cache = CodeCache.new
while true
$req = LSAPI.accept
break if $req == nil
filename = ENV['SCRIPT_FILENAME']
filename.untaint
filename =~ %r{^(\/.*?)\/*([^\/]+)$}
path = $1
Dir.chdir( path )
#load( filename, true )
code = $cache[filename]
code.call
end
class CodeEntry
public :path, :name, :mtime, :opcode
def initizlize( filename, mtime, opcode )
filename =~ %r{^(\/.*?)\/*([^\/]+)$}
@path = $1
@name = $2
@mtime = mtime
@opcode = opcode
end
end
share/gems/gems/ruby-lsapi-5.6/lsapi.gemspec 0000644 00000001611 15173517751 0014621 0 ustar 00 Gem::Specification.new do |s|
s.name = %q{ruby-lsapi}
s.version = "5.6"
s.date = %q{2024-01-22}
s.description = "This is a ruby extension for fast communication with LiteSpeed Web Server."
s.summary = %q{A ruby extension for fast communication with LiteSpeed Web Server.}
s.has_rdoc = false
s.authors = ["LiteSpeed Technologies Inc."]
s.email = "info@litespeedtech.com"
s.homepage = "http://www.litespeedtech.com/"
s.rubyforge_project = "ruby-lsapi"
s.files = ["lsapi.gemspec", "README", "examples", "examples/testlsapi.rb", "examples/lsapi_with_cgi.rb", "ext", "ext/lsapi", "ext/lsapi/extconf.rb", "ext/lsapi/lsapidef.h", "ext/lsapi/lsapilib.c", "ext/lsapi/lsapilib.h", "ext/lsapi/lsruby.c", "rails", "rails/dispatch.lsapi", "scripts", "scripts/lsruby_runner.rb", "setup.rb"]
s.extra_rdoc_files = ["README"]
s.extensions << "ext/lsapi/extconf.rb"
s.require_paths << "lib"
end
share/gems/gems/rake-13.1.0/exe/rake 0000755 00000002245 15173517751 0012644 0 ustar 00 #!/opt/alt/ruby33/bin/ruby
#--
# Copyright (c) 2003, 2004, 2005, 2006, 2007 Jim Weirich
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
#++
require "rake"
Rake.application.run
share/gems/gems/rake-13.1.0/doc/proto_rake.rdoc 0000644 00000004716 15173517751 0015003 0 ustar 00 = Original Prototype Rake
This is the original 100 line prototype rake program.
---
#!/opt/alt/ruby33/bin/ruby
require 'ftools'
class Task
TASKS = Hash.new
attr_reader :prerequisites
def initialize(task_name)
@name = task_name
@prerequisites = []
@actions = []
end
def enhance(deps=nil, &block)
@prerequisites |= deps if deps
@actions << block if block_given?
self
end
def name
@name.to_s
end
def invoke
@prerequisites.each { |n| Task[n].invoke }
execute if needed?
end
def execute
return if @triggered
@triggered = true
@actions.collect { |act| result = act.call(self) }.last
end
def needed?
true
end
def timestamp
Time.now
end
class << self
def [](task_name)
TASKS[intern(task_name)] or fail "Don't know how to rake #{task_name}"
end
def define_task(args, &block)
case args
when Hash
fail "Too Many Target Names: #{args.keys.join(' ')}" if args.size > 1
fail "No Task Name Given" if args.size < 1
task_name = args.keys[0]
deps = args[task_name]
else
task_name = args
deps = []
end
deps = deps.collect {|d| intern(d) }
get(task_name).enhance(deps, &block)
end
def get(task_name)
name = intern(task_name)
TASKS[name] ||= self.new(name)
end
def intern(task_name)
(Symbol === task_name) ? task_name : task_name.intern
end
end
end
class FileTask < Task
def needed?
return true unless File.exist?(name)
latest_prereq = @prerequisites.collect{|n| Task[n].timestamp}.max
return false if latest_prereq.nil?
timestamp < latest_prereq
end
def timestamp
File.new(name.to_s).mtime
end
end
def task(args, &block)
Task.define_task(args, &block)
end
def file(args, &block)
FileTask.define_task(args, &block)
end
def sys(cmd)
puts cmd
system(cmd) or fail "Command Failed: [#{cmd}]"
end
def rake
begin
here = Dir.pwd
while ! File.exist?("Rakefile")
Dir.chdir("..")
fail "No Rakefile found" if Dir.pwd == here
here = Dir.pwd
end
puts "(in #{Dir.pwd})"
load "./Rakefile"
ARGV.push("default") if ARGV.size == 0
ARGV.each { |task_name| Task[task_name].invoke }
rescue Exception => ex
puts "rake aborted ... #{ex.message}"
puts ex.backtrace.find {|str| str =~ /Rakefile/ } || ""
end
end
if __FILE__ == $0 then
rake
end
share/gems/gems/rake-13.1.0/doc/example/b.c 0000644 00000000101 15173517751 0013765 0 ustar 00 #include <stdio.h>
void b()
{
printf ("In function b\n");
}
share/gems/gems/rake-13.1.0/doc/example/Rakefile2 0000644 00000001127 15173517752 0015141 0 ustar 00 # Example Rakefile -*- ruby -*-
# Using the power of Ruby
task :default => [:main]
def ext(fn, newext)
fn.sub(/\.[^.]+$/, newext)
end
SRCFILES = Dir['*.c']
OBJFILES = SRCFILES.collect { |fn| ext(fn,".o") }
OBJFILES.each do |objfile|
srcfile = ext(objfile, ".c")
file objfile => [srcfile] do |t|
sh "gcc #{srcfile} -c -o #{t.name}"
end
end
file "main" => OBJFILES do |t|
sh "gcc -o #{t.name} main.o a.o b.o"
end
task :clean do
rm_f FileList['*.o']
Dir['*~'].each { |fn| rm_f fn }
end
task :clobber => [:clean] do
rm_f "main"
end
task :run => ["main"] do
sh "./main"
end
share/gems/gems/rake-13.1.0/doc/example/Rakefile1 0000644 00000001236 15173517752 0015141 0 ustar 00 # Example Rakefile -*- ruby -*-
task :default => [:main]
file "a.o" => ["a.c"] do |t|
src = t.name.sub(/\.o$/, '.c')
sh "gcc #{src} -c -o #{t.name}"
end
file "b.o" => ["b.c"] do |t|
src = t.name.sub(/\.o$/, '.c')
sh "gcc #{src} -c -o #{t.name}"
end
file "main.o" => ["main.c"] do |t|
src = t.name.sub(/\.o$/, '.c')
sh "gcc #{src} -c -o #{t.name}"
end
OBJFILES = ["a.o", "b.o", "main.o"]
task :obj => OBJFILES
file "main" => OBJFILES do |t|
sh "gcc -o #{t.name} main.o a.o b.o"
end
task :clean do
rm_f FileList['*.o']
Dir['*~'].each { |fn| rm_f fn }
end
task :clobber => [:clean] do
rm_f "main"
end
task :run => ["main"] do
sh "./main"
end
share/gems/gems/rake-13.1.0/doc/example/a.c 0000644 00000000101 15173517752 0013765 0 ustar 00 #include <stdio.h>
void a()
{
printf ("In function a\n");
}
share/gems/gems/rake-13.1.0/doc/example/main.c 0000644 00000000147 15173517753 0014504 0 ustar 00 #include <stdio.h>
extern void a();
extern void b();
int main ()
{
a();
b();
return 0;
}
share/gems/gems/rake-13.1.0/doc/command_line_usage.rdoc 0000644 00000013506 15173517753 0016446 0 ustar 00 = Rake Command Line Usage
Rake is invoked from the command line using:
% rake [options ...] [VAR=VALUE ...] [targets ...]
Options are:
[<tt><em>name</em>=<em>value</em></tt>]
Set the environment variable <em>name</em> to <em>value</em>
during the execution of the <b>rake</b> command. You can access
the value by using ENV['<em>name</em>'].
[<tt>--all</tt> (-A)]
Used in combination with the -T and -D options, will force
those options to show all the tasks, even the ones without comments.
[<tt>--backtrace</tt>{=_output_} (-n)]
Enable a full backtrace (i.e. like --trace, but without the task
tracing details). The _output_ parameter is optional, but if
specified it controls where the backtrace output is sent. If
_output_ is <tt>stdout</tt>, then backtrace output is directed to
standard output. If _output_ is <tt>stderr</tt>, or if it is
missing, then the backtrace output is sent to standard error.
[<tt>--comments</tt>]
Used in combination with the -W options to force the output to
contain commented options only. This is the reverse of
<tt>--all</tt>.
[<tt>--describe</tt> _pattern_ (-D)]
Describe the tasks (matching optional PATTERN), then exit.
[<tt>--dry-run</tt> (-n)]
Do a dry run. Print the tasks invoked and executed, but do not
actually execute any of the actions.
[<tt>--execute</tt> _code_ (-e)]
Execute some Ruby code and exit.
[<tt>--execute-print</tt> _code_ (-p)]
Execute some Ruby code, print the result, and exit.
[<tt>--execute-continue</tt> _code_ (-E)]
Execute some Ruby code, then continue with normal task processing.
[<tt>--help</tt> (-H)]
Display some help text and exit.
[<tt>--jobs</tt> _number_ (-j)]
Specifies the maximum number of concurrent threads allowed. Rake
will allocate threads as needed up to this maximum number.
If omitted, Rake will attempt to estimate the number of CPUs on
the system and add 4 to that number.
The concurrent threads are used to execute the <tt>multitask</tt>
prerequisites. Also see the <tt>-m</tt> option which turns all
tasks into multitasks.
Sample values:
(no -j) : Allow up to (# of CPUs + 4) number of threads
--jobs : Allow unlimited number of threads
--jobs=1 : Allow only one thread (the main thread)
--jobs=16 : Allow up to 16 concurrent threads
[<tt>--job-stats</tt> _level_]
Display job statistics at the completion of the run. By default,
this will display the requested number of active threads (from the
-j options) and the maximum number of threads in play at any given
time.
If the optional _level_ is <tt>history</tt>, then a complete trace
of task history will be displayed on standard output.
[<tt>--libdir</tt> _directory_ (-I)]
Add _directory_ to the list of directories searched for require.
[<tt>--multitask</tt> (-m)]
Treat all tasks as multitasks. ('make/drake' semantics)
[<tt>--nosearch</tt> (-N)]
Do not search for a Rakefile in parent directories.
[<tt>--prereqs</tt> (-P)]
Display a list of all tasks and their immediate prerequisites.
[<tt>--quiet</tt> (-q)]
Do not echo commands from FileUtils.
[<tt>--rakefile</tt> _filename_ (-f)]
Use _filename_ as the name of the rakefile. The default rakefile
names are +rakefile+ and +Rakefile+ (with +rakefile+ taking
precedence). If the rakefile is not found in the current
directory, +rake+ will search parent directories for a match. The
directory where the Rakefile is found will become the current
directory for the actions executed in the Rakefile.
[<tt>--rakelibdir</tt> _rakelibdir_ (-R)]
Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib')
[<tt>--require</tt> _name_ (-r)]
Require _name_ before executing the Rakefile.
[<tt>--rules</tt>]
Trace the rules resolution.
[<tt>--silent (-s)</tt>]
Like --quiet, but also suppresses the 'in directory' announcement.
[<tt>--suppress-backtrace _pattern_ </tt>]
Line matching the regular expression _pattern_ will be removed
from the backtrace output. Note that the --backtrace option is the
full backtrace without these lines suppressed.
[<tt>--system</tt> (-g)]
Use the system wide (global) rakefiles. The project Rakefile is
ignored. By default, the system wide rakefiles are used only if no
project Rakefile is found. On Unix-like system, the system wide
rake files are located in $HOME/.rake. On a windows system they
are stored in $APPDATA/Rake.
[<tt>--no-system</tt> (-G)]
Use the project level Rakefile, ignoring the system-wide (global)
rakefiles.
[<tt>--tasks</tt> <em>pattern</em> (-T)]
Display a list of the major tasks and their comments. Comments
are defined using the "desc" command. If a pattern is given, then
only tasks matching the pattern are displayed.
[<tt>--trace</tt>{=_output_} (-t)]
Turn on invoke/execute tracing. Also enable full backtrace on
errors. The _output_ parameter is optional, but if specified it
controls where the trace output is sent. If _output_ is
<tt>stdout</tt>, then trace output is directed to standard output.
If _output_ is <tt>stderr</tt>, or if it is missing, then trace
output is sent to standard error.
[<tt>--verbose</tt> (-v)]
Echo the Sys commands to standard output.
[<tt>--version</tt> (-V)]
Display the program version and exit.
[<tt>--where</tt> <em>pattern</em> (-W)]
Display tasks that match <em>pattern</em> and the file and line
number where the task is defined. By default this option will
display all tasks, not just the tasks that have descriptions.
[<tt>--no-deprecation-warnings</tt> (-X)]
Do not display the deprecation warnings.
In addition, any command line option of the form
<em>VAR</em>=<em>VALUE</em> will be added to the environment hash
<tt>ENV</tt> and may be tested in the Rakefile.
share/gems/gems/rake-13.1.0/doc/rakefile.rdoc 0000644 00000050342 15173517753 0014416 0 ustar 00 = Rakefile Format
First of all, there is no special format for a Rakefile. A Rakefile
contains executable Ruby code. Anything legal in a ruby script is
allowed in a Rakefile.
Now that we understand there is no special syntax in a Rakefile, there
are some conventions that are used in a Rakefile that are a little
unusual in a typical Ruby program. Since a Rakefile is tailored to
specifying tasks and actions, the idioms used in a Rakefile are
designed to support that.
So, what goes into a Rakefile?
== Tasks
Tasks are the main unit of work in a Rakefile. Tasks have a name
(usually given as a symbol or a string), a list of prerequisites (more
symbols or strings) and a list of actions (given as a block).
=== Simple Tasks
A task is declared by using the +task+ method. +task+ takes a single
parameter that is the name of the task.
task :name
=== Tasks with Prerequisites
Any prerequisites are given as a list (enclosed in square brackets)
following the name and an arrow (=>).
task name: [:prereq1, :prereq2]
*NOTE:* Although this syntax looks a little funky, it is legal
Ruby. We are constructing a hash where the key is :name and the value
for that key is the list of prerequisites. It is equivalent to the
following ...
hash = Hash.new
hash[:name] = [:prereq1, :prereq2]
task(hash)
You can also use strings for task names and prerequisites, rake doesn't care.
This is the same task definition:
task 'name' => %w[prereq1 prereq2]
As is this:
task name: %w[prereq1 prereq2]
We'll prefer this style for regular tasks with prerequisites throughout the
rest of the document. Using an array of strings for the prerequisites means
you will need to make fewer changes if you need to move tasks into namespaces
or perform other refactorings.
=== Tasks with Actions
Actions are defined by passing a block to the +task+ method. Any Ruby
code can be placed in the block. The block may reference the task
object via the block parameter.
task name: [:prereq1, :prereq2] do |t|
# actions (may reference t)
end
=== Multiple Definitions
A task may be specified more than once. Each specification adds its
prerequisites and actions to the existing definition. This allows one
part of a rakefile to specify the actions and a different rakefile
(perhaps separately generated) to specify the dependencies.
For example, the following is equivalent to the single task
specification given above.
task :name
task name: :prereq1
task name: %w[prereq2]
task :name do |t|
# actions
end
== File Tasks
Some tasks are designed to create a file from one or more other files.
Tasks that generate these files may be skipped if the file already
exists. File tasks are used to specify file creation tasks.
File tasks are declared using the +file+ method (instead of the +task+
method). In addition, file tasks are usually named with a string
rather than a symbol.
The following file task creates a executable program (named +prog+)
given two object files named +a.o+ and +b.o+. The tasks
for creating +a.o+ and +b.o+ are not shown.
file "prog" => ["a.o", "b.o"] do |t|
sh "cc -o #{t.name} #{t.prerequisites.join(' ')}"
end
== Directory Tasks
It is common to need to create directories upon demand. The
+directory+ convenience method is a short-hand for creating a FileTask
that creates the directory. For example, the following declaration
...
directory "testdata/examples/doc"
is equivalent to ...
file "testdata" do |t| mkdir t.name end
file "testdata/examples" => ["testdata"] do |t| mkdir t.name end
file "testdata/examples/doc" => ["testdata/examples"] do |t| mkdir t.name end
The +directory+ method does not accept prerequisites or actions, but
both prerequisites and actions can be added later. For example ...
directory "testdata"
file "testdata" => ["otherdata"]
file "testdata" do
cp Dir["standard_data/*.data"], "testdata"
end
== Tasks with Parallel Prerequisites
Rake allows parallel execution of prerequisites using the following syntax:
multitask copy_files: %w[copy_src copy_doc copy_bin] do
puts "All Copies Complete"
end
In this example, +copy_files+ is a normal rake task. Its actions are
executed whenever all of its prerequisites are done. The big
difference is that the prerequisites (+copy_src+, +copy_bin+ and
+copy_doc+) are executed in parallel. Each of the prerequisites are
run in their own Ruby thread, possibly allowing faster overall runtime.
=== Secondary Prerequisites
If any of the primary prerequisites of a multitask have common secondary
prerequisites, all of the primary/parallel prerequisites will wait
until the common prerequisites have been run.
For example, if the <tt>copy_<em>xxx</em></tt> tasks have the
following prerequisites:
task copy_src: :prep_for_copy
task copy_bin: :prep_for_copy
task copy_doc: :prep_for_copy
Then the +prep_for_copy+ task is run before starting all the copies in
parallel. Once +prep_for_copy+ is complete, +copy_src+, +copy_bin+,
and +copy_doc+ are all run in parallel. Note that +prep_for_copy+ is
run only once, even though it is referenced in multiple threads.
=== Thread Safety
The Rake internal data structures are thread-safe with respect
to the multitask parallel execution, so there is no need for the user
to do extra synchronization for Rake's benefit. However, if there are
user data structures shared between the parallel prerequisites, the
user must do whatever is necessary to prevent race conditions.
== Tasks with Arguments
Prior to version 0.8.0, rake was only able to handle command line
arguments of the form NAME=VALUE that were passed into Rake via the
ENV hash. Many folks had asked for some kind of simple command line
arguments, perhaps using "--" to separate regular task names from
argument values on the command line. The problem is that there was no
easy way to associate positional arguments on the command line with
different tasks. Suppose both tasks :a and :b expect a command line
argument: does the first value go with :a? What if :b is run first?
Should it then get the first command line argument.
Rake 0.8.0 solves this problem by explicitly passing values directly
to the tasks that need them. For example, if I had a release task
that required a version number, I could say:
rake release[0.8.2]
And the string "0.8.2" will be passed to the :release task. Multiple
arguments can be passed by separating them with a comma, for example:
rake name[john,doe]
Just a few words of caution. The rake task name and its arguments
need to be a single command line argument to rake. This generally
means no spaces. If spaces are needed, then the entire name +
argument string should be quoted. Something like this:
rake "name[billy bob, smith]"
(Quoting rules vary between operating systems and shells, so make sure
you consult the proper docs for your OS/shell).
=== Tasks that Expect Parameters
Parameters are only given to tasks that are setup to expect them. In
order to handle named parameters, the task declaration syntax for
tasks has been extended slightly.
For example, a task that needs a first name and last name might be
declared as:
task :name, [:first_name, :last_name]
The first argument is still the name of the task (:name in this case).
The next two arguments are the names of the parameters expected by
:name in an array (:first_name and :last_name in the example).
To access the values of the parameters, the block defining the task
behaviour can now accept a second parameter:
task :name, [:first_name, :last_name] do |t, args|
puts "First name is #{args.first_name}"
puts "Last name is #{args.last_name}"
end
The first argument of the block "t" is always bound to the current
task object. The second argument "args" is an open-struct like object
that allows access to the task arguments. Extra command line
arguments to a task are ignored.
If you wish to specify default values for the arguments, you can use
the with_defaults method in the task body. Here is the above example
where we specify default values for the first and last names:
task :name, [:first_name, :last_name] do |t, args|
args.with_defaults(:first_name => "John", :last_name => "Dough")
puts "First name is #{args.first_name}"
puts "Last name is #{args.last_name}"
end
=== Tasks that Expect Parameters and Have Prerequisites
Tasks that use parameters have a slightly different format for
prerequisites. Use the arrow notation to indicate the prerequisites
for tasks with arguments. For example:
task :name, [:first_name, :last_name] => [:pre_name] do |t, args|
args.with_defaults(:first_name => "John", :last_name => "Dough")
puts "First name is #{args.first_name}"
puts "Last name is #{args.last_name}"
end
=== Tasks that take Variable-length Parameters
Tasks that need to handle a list of values as a parameter can use the
extras method of the args variable. This allows for tasks that can
loop over a variable number of values, and its compatible with named
parameters as well:
task :email, [:message] do |t, args|
mail = Mail.new(args.message)
recipients = args.extras
recipients.each do |target|
mail.send_to(target)
end
end
There is also the convenience method to_a that returns all parameters
in the sequential order they were given, including those associated
with named parameters.
=== Deprecated Task Parameters Format
There is an older format for declaring task parameters that omitted
the task argument array and used the :needs keyword to introduce the
dependencies. That format is still supported for compatibility, but
is not recommended for use. The older format may be dropped in future
versions of rake.
== Accessing Task Programmatically
Sometimes it is useful to manipulate tasks programmatically in a
Rakefile. To find a task object use Rake::Task.[].
=== Programmatic Task Example
For example, the following Rakefile defines two tasks. The :doit task
simply prints a simple "DONE" message. The :dont class will lookup
the doit class and remove (clear) all of its prerequisites and
actions.
task :doit do
puts "DONE"
end
task :dont do
Rake::Task[:doit].clear
end
Running this example:
$ rake doit
(in /Users/jim/working/git/rake/x)
DONE
$ rake dont doit
(in /Users/jim/working/git/rake/x)
$
The ability to programmatically manipulate tasks gives rake very
powerful meta-programming capabilities w.r.t. task execution, but
should be used with caution.
== Rules
When a file is named as a prerequisite, but does not have a file task
defined for it, Rake will attempt to synthesize a task by looking at a
list of rules supplied in the Rakefile.
Suppose we were trying to invoke task "mycode.o", but no task is
defined for it. But the rakefile has a rule that look like this ...
rule '.o' => ['.c'] do |t|
sh "cc #{t.source} -c -o #{t.name}"
end
This rule will synthesize any task that ends in ".o". It has a
prerequisite a source file with an extension of ".c" must exist. If
Rake is able to find a file named "mycode.c", it will automatically
create a task that builds "mycode.o" from "mycode.c".
If the file "mycode.c" does not exist, rake will attempt
to recursively synthesize a rule for it.
When a task is synthesized from a rule, the +source+ attribute of the
task is set to the matching source file. This allows us to write
rules with actions that reference the source file.
=== Advanced Rules
Any regular expression may be used as the rule pattern. Additionally,
a proc may be used to calculate the name of the source file. This
allows for complex patterns and sources.
The following rule is equivalent to the example above.
rule( /\.o$/ => [
proc {|task_name| task_name.sub(/\.[^.]+$/, '.c') }
]) do |t|
sh "cc #{t.source} -c -o #{t.name}"
end
*NOTE:* Because of a _quirk_ in Ruby syntax, parenthesis are
required on *rule* when the first argument is a regular expression.
The following rule might be used for Java files ...
rule '.class' => [
proc { |tn| tn.sub(/\.class$/, '.java').sub(/^classes\//, 'src/') }
] do |t|
java_compile(t.source, t.name)
end
*NOTE:* +java_compile+ is a hypothetical method that invokes the
java compiler.
== Importing Dependencies
Any ruby file (including other rakefiles) can be included with a
standard Ruby +require+ command. The rules and declarations in the
required file are just added to the definitions already accumulated.
Because the files are loaded _before_ the rake targets are evaluated,
the loaded files must be "ready to go" when the rake command is
invoked. This makes generated dependency files difficult to use. By
the time rake gets around to updating the dependencies file, it is too
late to load it.
The +import+ command addresses this by specifying a file to be loaded
_after_ the main rakefile is loaded, but _before_ any targets on the
command line are invoked. In addition, if the file name matches an
explicit task, that task is invoked before loading the file. This
allows dependency files to be generated and used in a single rake
command invocation.
Example:
require 'rake/loaders/makefile'
file ".depends.mf" => [SRC_LIST] do |t|
sh "makedepend -f- -- #{CFLAGS} -- #{t.prerequisites} > #{t.name}"
end
import ".depends.mf"
If ".depends" does not exist, or is out of date w.r.t. the source
files, a new ".depends" file is generated using +makedepend+ before
loading.
== Comments
Standard Ruby comments (beginning with "#") can be used anywhere it is
legal in Ruby source code, including comments for tasks and rules.
However, if you wish a task to be described using the "-T" switch,
then you need to use the +desc+ command to describe the task.
Example:
desc "Create a distribution package"
task package: %w[ ... ] do ... end
The "-T" switch (or "--tasks" if you like to spell things out) will
display a list of tasks that have a description. If you use +desc+ to
describe your major tasks, you have a semi-automatic way of generating
a summary of your Rake file.
$ rake -T
(in /home/.../rake)
rake clean # Remove any temporary products.
rake clobber # Remove any generated file.
rake clobber_rdoc # Remove rdoc products
rake contrib_test # Run tests for contrib_test
rake default # Default Task
rake install # Install the application
rake lines # Count lines in the main rake file
rake rdoc # Build the rdoc HTML Files
rake rerdoc # Force a rebuild of the RDOC files
rake test # Run tests
rake testall # Run all test targets
Only tasks with descriptions will be displayed with the "-T" switch.
Use "-P" (or "--prereqs") to get a list of all tasks and their
prerequisites.
== Namespaces
As projects grow (and along with it, the number of tasks), it is
common for task names to begin to clash. For example, if you might
have a main program and a set of sample programs built by a single
Rakefile. By placing the tasks related to the main program in one
namespace, and the tasks for building the sample programs in a
different namespace, the task names will not interfere with each other.
For example:
namespace "main" do
task :build do
# Build the main program
end
end
namespace "samples" do
task :build do
# Build the sample programs
end
end
task build: %w[main:build samples:build]
Referencing a task in a separate namespace can be achieved by
prefixing the task name with the namespace and a colon
(e.g. "main:build" refers to the :build task in the +main+ namespace).
Nested namespaces are supported.
Note that the name given in the +task+ command is always the unadorned
task name without any namespace prefixes. The +task+ command always
defines a task in the current namespace.
=== FileTasks
File task names are not scoped by the namespace command. Since the
name of a file task is the name of an actual file in the file system,
it makes little sense to include file task names in name space.
Directory tasks (created by the +directory+ command) are a type of
file task and are also not affected by namespaces.
=== Name Resolution
When looking up a task name, rake will start with the current
namespace and attempt to find the name there. If it fails to find a
name in the current namespace, it will search the parent namespaces
until a match is found (or an error occurs if there is no match).
The "rake" namespace is a special implicit namespace that refers to
the toplevel names.
If a task name begins with a "^" character, the name resolution will
start in the parent namespace. Multiple "^" characters are allowed.
Here is an example file with multiple :run tasks and how various names
resolve in different locations.
task :run
namespace "one" do
task :run
namespace "two" do
task :run
# :run => "one:two:run"
# "two:run" => "one:two:run"
# "one:two:run" => "one:two:run"
# "one:run" => "one:run"
# "^run" => "one:run"
# "^^run" => "rake:run" (the top level task)
# "rake:run" => "rake:run" (the top level task)
end
# :run => "one:run"
# "two:run" => "one:two:run"
# "^run" => "rake:run"
end
# :run => "rake:run"
# "one:run" => "one:run"
# "one:two:run" => "one:two:run"
== FileLists
FileLists are the way Rake manages lists of files. You can treat a
FileList as an array of strings for the most part, but FileLists
support some additional operations.
=== Creating a FileList
Creating a file list is easy. Just give it the list of file names:
fl = FileList['file1.rb', file2.rb']
Or give it a glob pattern:
fl = FileList['*.rb']
== Odds and Ends
=== do/end versus { }
Blocks may be specified with either a +do+/+end+ pair, or with curly
braces in Ruby. We _strongly_ recommend using +do+/+end+ to specify the
actions for tasks and rules. Because the rakefile idiom tends to
leave off parentheses on the task/file/rule methods, unusual
ambiguities can arise when using curly braces.
For example, suppose that the method +object_files+ returns a list of
object files in a project. Now we use +object_files+ as the
prerequisites in a rule specified with actions in curly braces.
# DON'T DO THIS!
file "prog" => object_files {
# Actions are expected here (but it doesn't work)!
}
Because curly braces have a higher precedence than +do+/+end+, the
block is associated with the +object_files+ method rather than the
+file+ method.
This is the proper way to specify the task ...
# THIS IS FINE
file "prog" => object_files do
# Actions go here
end
== Rakefile Path
When issuing the +rake+ command in a terminal, Rake will look
for a Rakefile in the current directory. If a Rakefile is not found,
it will search parent directories until one is found.
For example, if a Rakefile resides in the +project/+ directory,
moving deeper into the project's directory tree will not have an adverse
effect on rake tasks:
$ pwd
/home/user/project
$ cd lib/foo/bar
$ pwd
/home/user/project/lib/foo/bar
$ rake run_pwd
/home/user/project
As far as rake is concerned, all tasks are run from the directory in
which the Rakefile resides.
=== Multiple Rake Files
Not all tasks need to be included in a single Rakefile. Additional
rake files (with the file extension "+.rake+") may be placed in
+rakelib+ directory located at the top level of a project (i.e.
the same directory that contains the main +Rakefile+).
Also, rails projects may include additional rake files in the
+lib/tasks+ directory.
=== Clean and Clobber Tasks
Through <tt>require 'rake/clean'</tt> Rake provides +clean+ and +clobber+
tasks:
+clean+ ::
Clean up the project by deleting scratch files and backup files. Add files
to the +CLEAN+ FileList to have the +clean+ target handle them.
+clobber+ ::
Clobber all generated and non-source files in a project. The task depends
on +clean+, so all the +CLEAN+ files will be deleted as well as files in the
+CLOBBER+ FileList. The intent of this task is to return a project to its
pristine, just unpacked state.
You can add file names or glob patterns to both the +CLEAN+ and +CLOBBER+
lists.
=== Phony Task
The phony task can be used as a dependency to allow file-based tasks to use
non-file-based-tasks as prerequisites without forcing them to rebuild. You
can <tt>require 'rake/phony'</tt> to add the +phony+ task.
----
== See
* README.rdoc -- Main documentation for Rake.
share/gems/gems/rake-13.1.0/doc/rational.rdoc 0000644 00000014110 15173517753 0014436 0 ustar 00 = Why rake?
Ok, let me state from the beginning that I never intended to write this
code. I'm not convinced it is useful, and I'm not convinced anyone
would even be interested in it. All I can say is that Why's onion truck
must by been passing through the Ohio valley.
What am I talking about? ... A Ruby version of Make.
See, I can sense you cringing already, and I agree. The world certainly
doesn't need yet another reworking of the "make" program. I mean, we
already have "ant". Isn't that enough?
It started yesterday. I was helping a coworker fix a problem in one of
the Makefiles we use in our project. Not a particularly tough problem,
but during the course of the conversation I began lamenting some of the
shortcomings of make. In particular, in one of my makefiles I wanted to
determine the name of a file dynamically and had to resort to some
simple scripting (in Ruby) to make it work. "Wouldn't it be nice if you
could just use Ruby inside a Makefile" I said.
My coworker (a recent convert to Ruby) agreed, but wondered what it
would look like. So I sketched the following on the whiteboard...
"What if you could specify the make tasks in Ruby, like this ..."
task "build" do
java_compile(...args, etc ...)
end
"The task function would register "build" as a target to be made,
and the block would be the action executed whenever the build
system determined that it was time to do the build target."
We agreed that would be cool, but writing make from scratch would be WAY
too much work. And that was the end of that!
... Except I couldn't get the thought out of my head. What exactly
would be needed to make the about syntax work as a make file? Hmmm, you
would need to register the tasks, you need some way of specifying
dependencies between tasks, and some way of kicking off the process.
Hey! What if we did ... and fifteen minutes later I had a working
prototype of Ruby make, complete with dependencies and actions.
I showed the code to my coworker and we had a good laugh. It was just
about a page worth of code that reproduced an amazing amount of the
functionality of make. We were both truly stunned with the power of
Ruby.
But it didn't do everything make did. In particular, it didn't have
timestamp based file dependencies (where a file is rebuilt if any of its
prerequisite files have a later timestamp). Obviously THAT would be a
pain to add and so Ruby Make would remain an interesting experiment.
... Except as I walked back to my desk, I started thinking about what
file based dependencies would really need. Rats! I was hooked again,
and by adding a new class and two new methods, file/timestamp
dependencies were implemented.
Ok, now I was really hooked. Last night (during CSI!) I massaged the
code and cleaned it up a bit. The result is a bare-bones replacement
for make in exactly 100 lines of code.
For the curious, you can see it at ...
* doc/proto_rake.rdoc
Oh, about the name. When I wrote the example Ruby Make task on my
whiteboard, my coworker exclaimed "Oh! I have the perfect name: Rake ...
Get it? Ruby-Make. Rake!" He said he envisioned the tasks as leaves
and Rake would clean them up ... or something like that. Anyways, the
name stuck.
Some quick examples ...
A simple task to delete backup files ...
task :clean do
Dir['*~'].each {|fn| rm fn rescue nil}
end
Note that task names are symbols (they are slightly easier to type
than quoted strings ... but you may use quoted string if you would
rather). Rake makes the methods of the FileUtils module directly
available, so we take advantage of the <tt>rm</tt> command. Also note
the use of "rescue nil" to trap and ignore errors in the <tt>rm</tt>
command.
To run it, just type "rake clean". Rake will automatically find a
Rakefile in the current directory (or above!) and will invoke the
targets named on the command line. If there are no targets explicitly
named, rake will invoke the task "default".
Here's another task with dependencies ...
task :clobber => [:clean] do
rm_r "tempdir"
end
Task :clobber depends upon task :clean, so :clean will be run before
:clobber is executed.
Files are specified by using the "file" command. It is similar to the
task command, except that the task name represents a file, and the task
will be run only if the file doesn't exist, or if its modification time
is earlier than any of its prerequisites.
Here is a file based dependency that will compile "hello.cc" to
"hello.o".
file "hello.cc"
file "hello.o" => ["hello.cc"] do |t|
srcfile = t.name.sub(/\.o$/, ".cc")
sh %{g++ #{srcfile} -c -o #{t.name}}
end
I normally specify file tasks with string (rather than symbols). Some
file names can't be represented by symbols. Plus it makes the
distinction between them more clear to the casual reader.
Currently writing a task for each and every file in the project would be
tedious at best. I envision a set of libraries to make this job
easier. For instance, perhaps something like this ...
require 'rake/ctools'
Dir['*.c'].each do |fn|
c_source_file(fn)
end
where "c_source_file" will create all the tasks need to compile all the
C source files in a directory. Any number of useful libraries could be
created for rake.
That's it. There's no documentation (other than whats in this
message). Does this sound interesting to anyone? If so, I'll continue
to clean it up and write it up and publish it on RAA. Otherwise, I'll
leave it as an interesting exercise and a tribute to the power of Ruby.
Why /might/ rake be interesting to Ruby programmers. I don't know,
perhaps ...
* No weird make syntax (only weird Ruby syntax :-)
* No need to edit or read XML (a la ant)
* Platform independent build scripts.
* Will run anywhere Ruby exists, so no need to have "make" installed.
If you stay away from the "sys" command and use things like
'ftools', you can have a perfectly platform independent
build script. Also rake is only 100 lines of code, so it can
easily be packaged along with the rest of your code.
So ... Sorry for the long rambling message. Like I said, I never
intended to write this code at all.
share/gems/gems/rake-13.1.0/doc/jamis.rb 0000644 00000026165 15173517753 0013421 0 ustar 00 # frozen_string_literal: true
module RDoc
module Page
FONTS = "\"Bitstream Vera Sans\", Verdana, Arial, Helvetica, sans-serif"
STYLE = <<CSS
a {
color: #00F;
text-decoration: none;
}
a:hover {
color: #77F;
text-decoration: underline;
}
body, td, p {
font-family: %fonts%;
background: #FFF;
color: #000;
margin: 0px;
font-size: small;
}
#content {
margin: 2em;
}
#description p {
margin-bottom: 0.5em;
}
.sectiontitle {
margin-top: 1em;
margin-bottom: 1em;
padding: 0.5em;
padding-left: 2em;
background: #005;
color: #FFF;
font-weight: bold;
border: 1px dotted black;
}
.attr-rw {
padding-left: 1em;
padding-right: 1em;
text-align: center;
color: #055;
}
.attr-name {
font-weight: bold;
}
.attr-desc {
}
.attr-value {
font-family: monospace;
}
.file-title-prefix {
font-size: large;
}
.file-title {
font-size: large;
font-weight: bold;
background: #005;
color: #FFF;
}
.banner {
background: #005;
color: #FFF;
border: 1px solid black;
padding: 1em;
}
.banner td {
background: transparent;
color: #FFF;
}
h1 a, h2 a, .sectiontitle a, .banner a {
color: #FF0;
}
h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover {
color: #FF7;
}
.dyn-source {
display: none;
background: #FFE;
color: #000;
border: 1px dotted black;
margin: 0.5em 2em 0.5em 2em;
padding: 0.5em;
}
.dyn-source .cmt {
color: #00F;
font-style: italic;
}
.dyn-source .kw {
color: #070;
font-weight: bold;
}
.method {
margin-left: 1em;
margin-right: 1em;
margin-bottom: 1em;
}
.description pre {
padding: 0.5em;
border: 1px dotted black;
background: #FFE;
}
.method .title {
font-family: monospace;
font-size: large;
border-bottom: 1px dashed black;
margin-bottom: 0.3em;
padding-bottom: 0.1em;
}
.method .description, .method .sourcecode {
margin-left: 1em;
}
.description p, .sourcecode p {
margin-bottom: 0.5em;
}
.method .sourcecode p.source-link {
text-indent: 0em;
margin-top: 0.5em;
}
.method .aka {
margin-top: 0.3em;
margin-left: 1em;
font-style: italic;
text-indent: 2em;
}
h1 {
padding: 1em;
border: 1px solid black;
font-size: x-large;
font-weight: bold;
color: #FFF;
background: #007;
}
h2 {
padding: 0.5em 1em 0.5em 1em;
border: 1px solid black;
font-size: large;
font-weight: bold;
color: #FFF;
background: #009;
}
h3, h4, h5, h6 {
padding: 0.2em 1em 0.2em 1em;
border: 1px dashed black;
color: #000;
background: #AAF;
}
.sourcecode > pre {
padding: 0.5em;
border: 1px dotted black;
background: #FFE;
}
CSS
XHTML_PREAMBLE = %{<?xml version="1.0" encoding="%charset%"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
}
HEADER = XHTML_PREAMBLE + <<ENDHEADER
<html>
<head>
<title>%title%</title>
<meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
<link rel="stylesheet" href="%style_url%" type="text/css" media="screen" />
<script language="JavaScript" type="text/javascript">
// <![CDATA[
function toggleSource( id )
{
var elem
var link
if( document.getElementById )
{
elem = document.getElementById( id )
link = document.getElementById( "l_" + id )
}
else if ( document.all )
{
elem = eval( "document.all." + id )
link = eval( "document.all.l_" + id )
}
else
return false;
if( elem.style.display == "block" )
{
elem.style.display = "none"
link.innerHTML = "show source"
}
else
{
elem.style.display = "block"
link.innerHTML = "hide source"
}
}
function openCode( url )
{
window.open( url, "SOURCE_CODE", "width=400,height=400,scrollbars=yes" )
}
// ]]>
</script>
</head>
<body>
ENDHEADER
FILE_PAGE = <<HTML
<table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'>
<tr><td>
<table width="100%" border='0' cellpadding='0' cellspacing='0'><tr>
<td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br />%short_name%</td>
<td align="right">
<table border='0' cellspacing="0" cellpadding="2">
<tr>
<td>Path:</td>
<td>%full_path%
IF:cvsurl
(<a href="%cvsurl%">CVS</a>)
ENDIF:cvsurl
</td>
</tr>
<tr>
<td>Modified:</td>
<td>%dtm_modified%</td>
</tr>
</table>
</td></tr>
</table>
</td></tr>
</table><br>
HTML
###################################################################
CLASS_PAGE = <<HTML
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
<td class="file-title"><span class="file-title-prefix">%classmod%</span><br />%full_name%</td>
<td align="right">
<table cellspacing=0 cellpadding=2>
<tr valign="top">
<td>In:</td>
<td>
START:infiles
HREF:full_path_url:full_path:
IF:cvsurl
(<a href="%cvsurl%">CVS</a>)
ENDIF:cvsurl
END:infiles
</td>
</tr>
IF:parent
<tr>
<td>Parent:</td>
<td>
IF:par_url
<a href="%par_url%">
ENDIF:par_url
%parent%
IF:par_url
</a>
ENDIF:par_url
</td>
</tr>
ENDIF:parent
</table>
</td>
</tr>
</table>
HTML
###################################################################
METHOD_LIST = <<HTML
<div id="content">
IF:diagram
<table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center">
%diagram%
</td></tr></table>
ENDIF:diagram
IF:description
<div class="description">%description%</div>
ENDIF:description
IF:requires
<div class="sectiontitle">Required Files</div>
<ul>
START:requires
<li>HREF:aref:name:</li>
END:requires
</ul>
ENDIF:requires
IF:toc
<div class="sectiontitle">Contents</div>
<ul>
START:toc
<li><a href="#%href%">%secname%</a></li>
END:toc
</ul>
ENDIF:toc
IF:methods
<div class="sectiontitle">Methods</div>
<ul>
START:methods
<li>HREF:aref:name:</li>
END:methods
</ul>
ENDIF:methods
IF:includes
<div class="sectiontitle">Included Modules</div>
<ul>
START:includes
<li>HREF:aref:name:</li>
END:includes
</ul>
ENDIF:includes
START:sections
IF:sectitle
<div class="sectiontitle"><a nem="%secsequence%">%sectitle%</a></div>
IF:seccomment
<div class="description">
%seccomment%
</div>
ENDIF:seccomment
ENDIF:sectitle
IF:classlist
<div class="sectiontitle">Classes and Modules</div>
%classlist%
ENDIF:classlist
IF:constants
<div class="sectiontitle">Constants</div>
<table border='0' cellpadding='5'>
START:constants
<tr valign='top'>
<td class="attr-name">%name%</td>
<td>=</td>
<td class="attr-value">%value%</td>
</tr>
IF:desc
<tr valign='top'>
<td> </td>
<td colspan="2" class="attr-desc">%desc%</td>
</tr>
ENDIF:desc
END:constants
</table>
ENDIF:constants
IF:attributes
<div class="sectiontitle">Attributes</div>
<table border='0' cellpadding='5'>
START:attributes
<tr valign='top'>
<td class='attr-rw'>
IF:rw
[%rw%]
ENDIF:rw
</td>
<td class='attr-name'>%name%</td>
<td class='attr-desc'>%a_desc%</td>
</tr>
END:attributes
</table>
ENDIF:attributes
IF:method_list
START:method_list
IF:methods
<div class="sectiontitle">%type% %category% methods</div>
START:methods
<div class="method">
<div class="title">
IF:callseq
<a name="%aref%"></a><b>%callseq%</b>
ENDIF:callseq
IFNOT:callseq
<a name="%aref%"></a><b>%name%</b>%params%
ENDIF:callseq
IF:codeurl
[ <a href="javascript:openCode('%codeurl%')">source</a> ]
ENDIF:codeurl
</div>
IF:m_desc
<div class="description">
%m_desc%
</div>
ENDIF:m_desc
IF:aka
<div class="aka">
This method is also aliased as
START:aka
<a href="%aref%">%name%</a>
END:aka
</div>
ENDIF:aka
IF:sourcecode
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('%aref%_source')" id="l_%aref%_source">show source</a> ]</p>
<div id="%aref%_source" class="dyn-source">
<pre>
%sourcecode%
</pre>
</div>
</div>
ENDIF:sourcecode
</div>
END:methods
ENDIF:methods
END:method_list
ENDIF:method_list
END:sections
</div>
HTML
FOOTER = <<ENDFOOTER
</body>
</html>
ENDFOOTER
BODY = HEADER + <<ENDBODY
!INCLUDE! <!-- banner header -->
<div id="bodyContent">
#{METHOD_LIST}
</div>
#{FOOTER}
ENDBODY
########################## Source code ##########################
SRC_PAGE = XHTML_PREAMBLE + <<HTML
<html>
<head><title>%title%</title>
<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
<style>
.ruby-comment { color: green; font-style: italic }
.ruby-constant { color: #4433aa; font-weight: bold; }
.ruby-identifier { color: #222222; }
.ruby-ivar { color: #2233dd; }
.ruby-keyword { color: #3333FF; font-weight: bold }
.ruby-node { color: #777777; }
.ruby-operator { color: #111111; }
.ruby-regexp { color: #662222; }
.ruby-value { color: #662222; font-style: italic }
.kw { color: #3333FF; font-weight: bold }
.cmt { color: green; font-style: italic }
.str { color: #662222; font-style: italic }
.re { color: #662222; }
</style>
</head>
<body bgcolor="white">
<pre>%code%</pre>
</body>
</html>
HTML
########################## Index ################################
FR_INDEX_BODY = <<HTML
!INCLUDE!
HTML
FILE_INDEX = XHTML_PREAMBLE + <<HTML
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
<style>
<!--
body {
background-color: #EEE;
font-family: #{FONTS};
color: #000;
margin: 0px;
}
.banner {
background: #005;
color: #FFF;
padding: 0.2em;
font-size: small;
font-weight: bold;
text-align: center;
}
.entries {
margin: 0.25em 1em 0 1em;
font-size: x-small;
}
a {
color: #00F;
text-decoration: none;
white-space: nowrap;
}
a:hover {
color: #77F;
text-decoration: underline;
}
-->
</style>
<base target="docwin">
</head>
<body>
<div class="banner">%list_title%</div>
<div class="entries">
START:entries
<a href="%href%">%name%</a><br>
END:entries
</div>
</body></html>
HTML
CLASS_INDEX = FILE_INDEX
METHOD_INDEX = FILE_INDEX
INDEX = XHTML_PREAMBLE + <<HTML
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>%title%</title>
<meta http-equiv="Content-Type" content="text/html; charset=%charset%">
</head>
<frameset cols="20%,*">
<frameset rows="15%,35%,50%">
<frame src="fr_file_index.html" title="Files" name="Files" />
<frame src="fr_class_index.html" name="Classes" />
<frame src="fr_method_index.html" name="Methods" />
</frameset>
IF:inline_source
<frame src="%initial_page%" name="docwin">
ENDIF:inline_source
IFNOT:inline_source
<frameset rows="80%,20%">
<frame src="%initial_page%" name="docwin">
<frame src="blank.html" name="source">
</frameset>
ENDIF:inline_source
<noframes>
<body bgcolor="white">
Click <a href="html/index.html">here</a> for a non-frames
version of this page.
</body>
</noframes>
</frameset>
</html>
HTML
end
end
share/gems/gems/rake-13.1.0/doc/glossary.rdoc 0000644 00000003364 15173517753 0014501 0 ustar 00 = Glossary
action ::
Code to be executed in order to perform a task. Actions in a Rakefile are
specified in a code block. (Usually delimited by +do+/+end+ pairs.)
execute ::
When a task is executed, all of its actions are performed in the order they
were defined. Note that, unlike <tt>invoke</tt>, <tt>execute</tt> always
executes the actions (without invoking or executing the prerequisites).
file task (Rake::FileTask) ::
A file task is a task whose purpose is to create a file (which has the same
name as the task). When invoked, a file task will only execute if one or
more of the following conditions are true.
1. The associated file does not exist.
2. A prerequisite has a later time stamp than the existing file.
Because normal Tasks always have the current time as timestamp, a FileTask
that has a normal Task prerequisite will always execute.
invoke ::
When a task is invoked, first we check to see if it has been invoked before.
If it has been, then nothing else is done. If this is the first time it has
been invoked, then we invoke each of its prerequisites. Finally, we check
to see if we need to execute the actions of this task by calling
Rake::Task#needed?. If the task is needed, we execute its actions.
NOTE: Prerequisites are still invoked even if the task is not needed.
prerequisites ::
Every task has a (possibly empty) set of prerequisites. A prerequisite P to
Task T is itself a task that must be invoked before Task T.
rule ::
A rule is a recipe for synthesizing a task when no task is explicitly
defined. Rules generally synthesize file tasks.
task (Rake::Task) ::
The basic unit of work in a Rakefile. A task has a name, a set of
prerequisites, and a list of actions to be performed.
share/gems/gems/rake-13.1.0/History.rdoc 0000644 00000215222 15173517754 0013531 0 ustar 00 === 13.0.6
* Additional fix for #389
Pull request #390 by hsbt
=== 13.0.5
* Fixed the regression of #388
Pull request #389 by hsbt
=== 13.0.4
* Fix rake test loader swallowing useful error information.
Pull request #367 by deivid-rodriguez
* Add -C/--directory option the same as GNU make.
Pull request #376 by nobu
=== 13.0.3
* Fix breaking change of execution order on TestTask.
Pull request #368 by ysakasin
=== 13.0.2
==== Enhancements
* Fix tests to work with current FileUtils
Pull Request #358 by jeremyevans
* Simplify default rake test loader
Pull Request #357 by deivid-rodriguez
* Update rdoc
Pull Request #366 by bahasalien
* Update broken links to rake articles from Avdi in README
Pull Request #360 by svl7
=== 13.0.1
==== Bug fixes
* Fixed bug: Reenabled task raises previous exception on second invokation
Pull Request #271 by thorsteneckel
* Fix an incorrectly resolved arg pattern
Pull Request #327 by mjbellantoni
=== 13.0.0
==== Enhancements
* Follows recent changes on keyword arguments in ruby 2.7.
Pull Request #326 by nobu
* Make `PackageTask` be able to omit parent directory while packing files
Pull Request #310 by tonytonyjan
* Add order only dependency
Pull Request #269 by take-cheeze
==== Compatibility changes
* Drop old ruby versions(< 2.2)
=== 12.3.3
==== Bug fixes
* Use the application's name in error message if a task is not found.
Pull Request #303 by tmatilai
==== Enhancements:
* Use File.open explicitly.
=== 12.3.2
==== Bug fixes
* Fixed test fails caused by 2.6 warnings.
Pull Request #297 by hsbt
==== Enhancements:
* Rdoc improvements.
Pull Request #293 by colby-swandale
* Improve multitask performance.
Pull Request #273 by jsm
* Add alias `prereqs`.
Pull Request #268 by take-cheeze
=== 12.3.1
==== Bug fixes
* Support did_you_mean >= v1.2.0 which has a breaking change on formatters.
Pull request #262 by FUJI Goro.
==== Enhancements:
* Don't run task if it depends on already invoked but failed task.
Pull request #252 by Gonzalo Rodriguez.
* Make space trimming consistent for all task arguments.
Pull request #259 by Gonzalo Rodriguez.
* Removes duplicated inclusion of Rake::DSL in tests.
Pull request #254 by Gonzalo Rodriguez.
* Re-raise a LoadError that didn't come from require in the test loader.
Pull request #250 by Dylan Thacker-Smith.
=== 12.3.0
==== Compatibility Changes
* Bump `required_ruby_version` to Ruby 2.0.0. Rake has already
removed support for Ruby 1.9.x.
==== Enhancements:
* Support `test-bundled-gems` task on ruby core.
=== 12.2.1
==== Bug fixes
* Fixed to break Capistrano::Application on capistrano3.
=== 12.2.0
==== Enhancements:
* Make rake easier to use as a library
Pull request #211 by @drbrain
* Fix quadratic performance in FileTask#out_of_date?
Pull request #224 by @doudou
* Clarify output when printing nested exception traces
Pull request #232 by @urbanautomaton
==== Bug fixes
* Account for a file that match 2 or more patterns.
Pull request #231 by @styd
=== 12.1.0
==== Enhancements:
* Added did_you_mean feature for invalid rake task.
Pull request #221 by @xtina-starr
* Enabled to dependency chained by extensions. Pull request #39 by Petr Skocik.
* Make all of string literals to frozen objects on Ruby 2.4 or later.
==== Bug fixes
* Typo fixes in rakefile.rdoc. Pull request #180 by Yuta Kurotaki.
* Fix unexpected behavior of file task with dryrun option.
Pull request #183 by @aycabta.
* Make LoadError from running tests more obvious. Pull request #195
by Eric Hodel.
* Fix unexpected TypeError with hash style option. Pull request #202
by Kuniaki IGARASHI.
=== 12.0.0
==== Compatibility Changes
* Removed arguments on clear #157 by Jesse Bowes
* Removed `rake/contrib` packages. These are extracted to `rake-contrib` gem.
* Removed deprecated method named `last\_comment`.
==== Enhancements:
* Re-use trace option on `cleanup` task. #164 by Brian Henderson
* Actions adore keyword arguments #174 by Josh Cheek
* Rake::TaskArguments#key? alias of #has_key? #175 by Paul Annesley
=== 11.3.0 / 2016-09-20
==== Enhancements:
* Remove to reference `Fixnum` constant. Pull request #160 by nobu
=== 11.2.2 / 2016-06-12
==== Bug fixes
* Fix unexpected behavior with multiple dependencies on Rake::TestTask
=== 11.2.1 / 2016-06-12
==== Bug fixes
* Fix regression of dependencies handling on Rake::TestTask. Report #139
=== 11.2.0 / 2016-06-11
==== Bug fixes
* Fix unexpected cut-out behavior on task description using triple dots
and exclamation. Report #106 from Stephan Kämper and Pull request #134 by Lee
* Fix empty argument assignment with `with_defaults` option. Pull request #135
by bakunyo
* Ignore to use `hwprefs` on Darwin platform. Use sysctl now. Report #128
==== Enhancements
* Spawn options for sh Pull equest #138 by Eric Hodel.
* Allow to specify dependencies(prerequisites) for Rake::TestTask
Pull request #117 by Tim Maslyuchenko
* Use Bundler task instead of hoe for gem release.
* Remove explicitly load to rubygems for Ruby 1.8.
* Unify to declare `Rake::VERSION`.
* Support xz format for PackageTask.
=== 11.1.2 / 2016-03-28
==== Bug fixes
* Remove `-W` option when Rake::TestTask#verbose enabled. It's misunderstanding
specification change with Rake 11. Partly revert #67
=== 11.1.1 / 2016-03-14
==== Bug fixes
* Use `-W` instead of `--verbose` when Rake::TestTask#verbose enabled.
JRuby doesn't have `--verbose` option.
=== 11.1.0 / 2016-03-11
==== Compatibility Changes
* Revert to remove `last\_comment`. It will remove Rake 12.
=== 11.0.1 / 2016-03-09
==== Bug fixes
* Fixed packaging manifest.
=== 11.0.0 / 2016-03-09
==== Bug fixes
* Correctly handle bad encoding in exception messages. Pull request #113
by Tomer Brisker
* Fix verbose option at TestTask. Pull request #67 by Mike Blumtritt
==== Enhancements
* Make FileList#exclude more analogous to FileList#include.
* Use IO.open instead of Open3.popen3 for CPU counter.
* Make Rake::Task#already_invoked publicly accessible.
Pull request #93 by Joe Rafaniello
* Lookup prerequisites with same name outside of scope instead of
matching self. Pull request #96 by Sandy Vanderbleek
* Make FileList#pathmap behave like String#pathmap.
Pull request #61 by Daniel Tamai
* Add fetch method to task arguments.
Pull request #12 by Chris Keathley
* Use ruby warnings by default. Pull request #97 by Harold Giménez
==== Compatibility Changes
* Removed to support Ruby 1.8.x
* Removed constant named `RAKEVERSION`
* Removed Rake::AltSystem
* Removed Rake::RubyForgePublisher
* Removed Rake::TaskManager#last\_comment. Use last\_description.
* Removed Rake::TaskLib#paste
* Removed Top-level SshDirPublisher, SshFreshDirPublisher, SshFilePublisher
and CompositePublisher from lib/rake/contrib/publisher.rb
* Removed "rake/runtest.rb"
=== 10.5.0 / 2016-01-13
==== Enhancements
* Removed monkey patching for Ruby 1.8. Pull request #46 by Pablo Herrero.
* Inheritance class of Rake::FileList returns always self class.
Pull request #74 by Thomas Scholz
=== 10.4.2 / 2014-12-02
==== Bug fixes
* Rake no longer edits ARGV. This allows you to re-exec rake from a rake
task. Pull requset #9 by Matt Palmer.
* Documented how Rake::DSL#desc handles sentences in task descriptions.
Issue #7 by Raza Sayed.
* Fixed test error on 1.9.3 with legacy RubyGems. Issue #8 by Matt Palmer.
* Deleted duplicated History entry. Pull request #10 by Yuji Yamamoto.
=== 10.4.1 / 2014-12-01
==== Bug fixes
* Reverted fix for #277 as it caused numerous issues for rake users.
rails/spring issue #366 by Gustavo Dutra.
=== 10.4.0 / 2014-11-22
==== Enhancements
* Upgraded to minitest 5. Pull request #292 by Teo Ljungberg.
* Added support for Pathname in rake tasks. Pull request #271 by Randy
Coulman.
* Rake now ignores falsy dependencies which allows for easier programmatic
creation of tasks. Pull request #273 by Manav.
* Rake no longer edits ARGV. This allows you to re-exec rake from a rake
task. Issue #277 by Matt Palmer.
* Etc.nprocessors is used for counting the number of CPUs.
==== Bug fixes
* Updated rake manpage. Issue #283 by Nathan Long, pull request #291 by
skittleys.
* Add Rake::LATE to allow rebuilding of files that depend on deleted files.
Bug #286, pull request #287 by David Grayson.
* Fix relinking of files when repackaging. Bug #276 by Muenze.
* Fixed some typos. Pull request #280 by Jed Northridge.
* Try counting CPUs via cpuinfo if host_os was not matched. Pull request
#282 by Edouard B.
=== 10.3.2 / 2014-05-15
==== Bug fixes
* Rake no longer infinitely loops when showing exception causes that refer to
each other. Bug #272 by Chris Bandy.
* Fixed documentation typos. Bug #275 by Jake Worth.
=== 10.3.1 / 2014-04-17
==== Bug fixes
* Really stop reporting an error when cleaning already-deleted files. Pull
request #269 by Randy Coulman
* Fixed infinite loop when cleaning already-deleted files on windows.
=== 10.3 / 2014-04-15
==== Enhancements
* Added --build-all option to rake which treats all file prerequisites as
out-of-date. Pull request #254 by Andrew Gilbert.
* Added Rake::NameSpace#scope. Issue #263 by Jon San Miguel.
==== Bug fixes
* Suppress org.jruby package files in rake error messages for JRuby users.
Issue #213 by Charles Nutter.
* Fixed typo, removed extra "h". Pull request #267 by Hsing-Hui Hsu.
* Rake no longer reports an error when cleaning already-deleted files. Pull
request #266 by Randy Coulman.
* Consume stderr while determining CPU count to avoid hang. Issue #268 by
Albert Sun.
=== 10.2.2 / 2014-03-27
==== Bug fixes
* Restored Ruby 1.8.7 compatibility
=== 10.2.1 / 2014-03-25
==== Bug fixes
* File tasks including a ':' are now top-level tasks again. Issue #262 by
Josh Holtrop.
* Use sysctl for CPU count for all BSDs. Pull request #261 by Joshua Stein.
* Fixed CPU detection for unknown platforms.
=== 10.2.0 / 2014-03-24
==== Enhancements
* Rake now requires Ruby 1.9 or newer. For me, this is a breaking change, but
it seems that Jim planned to release it with Rake 10.2. See also pull
request #247 by Philip Arndt.
* Rake now allows you to declare tasks under a namespace like:
task 'a:b' do ... end
Pull request #232 by Judson Lester.
* Task#source defaults to the first prerequisite in non-rule tasks. Pull
request #215 by Avdi Grimm.
* Rake now automatically rebuilds and reloads imported files. Pull request
#209 by Randy Coulman.
* The rake task arguments can contain escaped commas. Pull request #214 by
Filip Hrbek.
* Rake now prints the exception class on errors. Patch #251 by David Cornu.
==== Bug fixes
* Fixed typos. Pull request #256 by Valera Rozuvan, #250 via Jake Worth, #260
by Zachary Scott.
* Fixed documentation for calling tasks with arguments. Pull request #235 by
John Varghese.
* Clarified `rake -f` usage message. Pull request #252 by Marco Pfatschbacher.
* Fixed a test failure on windows. Pull request #231 by Hiroshi Shirosaki.
* Fixed corrupted rake.1.gz. Pull request #225 by Michel Boaventura.
* Fixed bug in can\_detect\_signals? in test. Patch from #243 by Alexey
Borzenkov.
=== 10.1.1
* Use http://github.com/jimweirich/rake instead of http://rake.rubyforge.org for
canonical project url.
=== 10.1.0
==== Changes
===== New Features
* Add support for variable length task argument lists. If more actual
arguments are supplied than named arguments, then the extra
arguments values will be in args.extras.
* Application name is not displayed in the help banner. (Previously
"rake" was hardcoded, now rake-based applications can display their
own names).
===== Bug Fixes
Bug fixes include:
* Fix backtrace suppression issues.
* Rules now explicit get task arguments passed to them.
* Rename FileList#exclude? to FileList#exclude\_from\_list? to avoid
conflict with new Rails method.
* Clean / Clobber tasks now report failure to remove files.
* Plus heaps of internal code cleanup.
==== Thanks
As usual, it was input from users that drove a lot of these changes.
The following people contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Michael Nikitochkin (general code cleanup)
* Vipul A M (general code cleanup)
* Dennis Bell (variable length task argument lists)
* Jacob Swanner (rules arguments)
* Rafael Rosa Fu (documentation typo)
* Stuart Nelson (install.rb fixes)
* Lee Hambley (application name in help banner)
-- Jim Weirich
=== 10.0.3
"Jim, when will Rake reach version 1.0?"
Over the past several years I've been asked that question at
conferences, panels and over twitter. Due to historical reasons (or
maybe just plain laziness) Rake has (incorrectly) been treating the
second digit of the version as the major release number. So in my head
Rake was already at version 9.
Well, it's time to fix things. This next version of Rake drops old,
crufty, backwards compatibility hacks such as top level constants, DSL
methods defined in Object and numerous other features that are just no
longer desired. It's also time to drop the leading zero from the
version number as well and call this new version of rake what it
really is: Version 10.
So, welcome to Rake 10.0!
Rake 10 is actually feature identical to the latest version of Rake 9
(that would be the version spelled 0.9.3), *except* that Rake 10 drops
all the sundry deprecated features that have accumulated over the years.
If your Rakefile is up to date and current with all the new features
of Rake 10, you are ready to go. If your Rakefile still uses a few
deprecated feeatures, feel free to use Rake 9 (0.9.3) with the same
feature set. Just be aware that future features will be in Rake 10
family line.
==== Changes
As mentioned above, there are no new features in Rake 10. However,
there are a number of features missing:
* Classic namespaces are now gone. Rake is no longer able to reflect
the options settings in the global variables ($rakefile, $show\_tasks,
$show\_prereqs, $trace, $dryrun and $silent). The
<tt>--classic-namespace</tt> option is no longer supported.
* Global constants are no longer supported. This includes
<tt>Task</tt>, <tt>FileTask</tt>, <tt>FileCreationTask</tt> and
<tt>RakeApp</tt>). The constant missing hook to warn about using
global rake constants has been removed.
* The Rake DSL methods (task, file, directory, etc) are in their own
module (Rake::DSL). The stub versions of these methods (that printed
warnings) in Object have been removed. However, the DSL methods are
added to the top-level <tt>main</tt> object. Since <tt>main</tt> is
not in the inheritance tree, the presence of the DSL methods in main
should be low impact on other libraries.
If you want to use the Rake DSL commands from your own code, just
include <tt>Rake::DSL</tt> into your own classes and modules.
* The deprecated syntax for task arguments (the one using
<tt>:needs</tt>) has been removed.
* The <tt>--reduce-compat</tt> flag has been removed (it's not needed
anymore).
* The deprecated <tt>rake/sys.rb</tt> library has been removed.
* The deprecated <tt>rake/rdoctask.rb</tt> library has been removed.
RDoc supplies its own rake task now.
* The deprecated <tt>rake/gempackagetask.rb</tt> library has been
removed. Gem supplies its own package task now.
There is one small behavioral change:
* Non-file tasks now always report the current time as their time
stamp. This is different from the previous behavior where non-file
tasks reported current time only if there were no prerequisites, and
the max prerequisite timestamp otherwise. This lead to inconsistent
and surprising behavior when adding prerequisites to tasks that in
turn were prequisites to file tasks. The new behavior is more
consistent and predictable.
==== Changes (from 0.9.3, 0.9.4, 0.9.5)
Since Rake 10 includes the changes from the last version of Rake 9,
we'll repeat the changes for versions 0.9.3 through 0.9.5 here.
===== New Features (in 0.9.3)
* Multitask tasks now use a thread pool. Use -j to limit the number of
available threads.
* Use -m to turn regular tasks into multitasks (use at your own risk).
* You can now do "Rake.add_rakelib 'dir'" in your Rakefile to
programatically add rake task libraries.
* You can specific backtrace suppression patterns (see
--suppress-backtrace)
* Directory tasks can now take prerequisites and actions
* Use --backtrace to request a full backtrace without the task trace.
* You can say "--backtrace=stdout" and "--trace=stdout" to route trace
output to standard output rather than standard error.
* Optional 'phony' target (enable with 'require 'rake/phony'") for
special purpose builds.
* Task#clear now clears task comments as well as actions and
prerequisites. Task#clear_comment will specifically target comments.
* The --all option will force -T and -D to consider all the tasks,
with and without descriptions.
===== Bug Fixes (in 0.9.3)
* Semi-colons in windows rakefile paths now work.
* Improved Control-C support when invoking multiple test suites.
* egrep method now reads files in text mode (better support for
Windows)
* Better deprecation line number reporting.
* The -W option now works with all tasks, whether they have a
description or not.
* File globs in rake should not be sorted alphabetically, independent
of file system and platform.
* Numerous internal improvements.
* Documentation typos and fixes.
===== Bug Fixes (in 0.9.4)
* Exit status with failing tests is not correctly set to non-zero.
* Simplified syntax for phony task (for older versions of RDoc).
* Stand alone FileList usage gets glob function (without loading in
extra dependencies)
===== Bug Fixes (in 0.9.5)
* --trace and --backtrace no longer swallow following task names.
==== Thanks
As usual, it was input from users that drove a lot of these changes. The
following people contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== 10.0.2
==== Changes
===== Bug Fixes
* --trace and --backtrace no longer swallow following task names.
==== Thanks
As usual, it was input from users that drove a lot of these changes. The
following people contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== 10.0.1
==== Changes
===== Bug Fixes
* Exit status with failing tests is not correctly set to non-zero.
* Simplified syntax for phony task (for older versions of RDoc).
* Stand alone FileList usage gets glob function (without loading in
extra dependencies)
==== Thanks
As usual, it was input from users that drove a lot of these changes. The
following people contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== 10.0.0
"Jim, when will Rake reach version 1.0?"
Over the past several years I've been asked that question at
conferences, panels and over twitter. Due to historical reasons (or
maybe just plain laziness) Rake has (incorrectly) been treating the
second digit of the version as the major release number. So in my head
Rake was already at version 9.
Well, it's time to fix things. This next version of Rake drops old,
crufty, backwards compatibility hacks such as top level constants, DSL
methods defined in Object and numerous other features that are just no
longer desired. It's also time to drop the leading zero from the
version number as well and call this new version of rake what it
really is: Version 10.
So, welcome to Rake 10.0!
Rake 10 is actually feature identical to the latest version of Rake 9
(that would be the version spelled 0.9.3), *except* that Rake 10 drops
all the sundry deprecated features that have accumulated over the years.
If your Rakefile is up to date and current with all the new features
of Rake 10, you are ready to go. If your Rakefile still uses a few
deprecated feeatures, feel free to use Rake 9 (0.9.3) with the same
feature set. Just be aware that future features will be in Rake 10
family line.
==== Changes in 10.0
As mentioned above, there are no new features in Rake 10. However,
there are a number of features missing:
* Classic namespaces are now gone. Rake is no longer able to reflect
the options settings in the global variables ($rakefile, $show\_tasks,
$show\_prereqs, $trace, $dryrun and $silent). The
<tt>--classic-namespace</tt> option is no longer supported.
* Global constants are no longer supported. This includes
<tt>Task</tt>, <tt>FileTask</tt>, <tt>FileCreationTask</tt> and
<tt>RakeApp</tt>). The constant missing hook to warn about using
global rake constants has been removed.
* The Rake DSL methods (task, file, directory, etc) are in their own
module (Rake::DSL). The stub versions of these methods (that printed
warnings) in Object have been removed. However, the DSL methods are
added to the top-level <tt>main</tt> object. Since <tt>main</tt> is
not in the inheritance tree, the presence of the DSL methods in main
should be low impact on other libraries.
If you want to use the Rake DSL commands from your own code, just
include <tt>Rake::DSL</tt> into your own classes and modules.
* The deprecated syntax for task arguments (the one using
<tt>:needs</tt>) has been removed.
* The <tt>--reduce-compat</tt> flag has been removed (it's not needed
anymore).
* The deprecated <tt>rake/sys.rb</tt> library has been removed.
* The deprecated <tt>rake/rdoctask.rb</tt> library has been removed.
RDoc supplies its own rake task now.
* The deprecated <tt>rake/gempackagetask.rb</tt> library has been
removed. Gem supplies its own package task now.
There is one small behavioral change:
* Non-file tasks now always report the current time as their time
stamp. This is different from the previous behavior where non-file
tasks reported current time only if there were no prerequisites, and
the max prerequisite timestamp otherwise. This lead to inconsistent
and surprising behavior when adding prerequisites to tasks that in
turn were prequisites to file tasks. The new behavior is more
consistent and predictable.
==== Changes (from 0.9.3)
Since Rake 10 includes the changes from the last version of Rake 9,
we'll repeat the changes for version 0.9.3 here.
===== New Features
* Multitask tasks now use a thread pool. Use -j to limit the number of
available threads.
* Use -m to turn regular tasks into multitasks (use at your own risk).
* You can now do "Rake.add_rakelib 'dir'" in your Rakefile to
programatically add rake task libraries.
* You can specific backtrace suppression patterns (see
--suppress-backtrace)
* Directory tasks can now take prerequisites and actions
* Use --backtrace to request a full backtrace without the task trace.
* You can say "--backtrace=stdout" and "--trace=stdout" to route trace
output to standard output rather than standard error.
* Optional 'phony' target (enable with 'require 'rake/phony'") for
special purpose builds.
* Task#clear now clears task comments as well as actions and
prerequisites. Task#clear_comment will specifically target comments.
* The --all option will force -T and -D to consider all the tasks,
with and without descriptions.
===== Bug Fixes
* Semi-colons in windows rakefile paths now work.
* Improved Control-C support when invoking multiple test suites.
* egrep method now reads files in text mode (better support for
Windows)
* Better deprecation line number reporting.
* The -W option now works with all tasks, whether they have a
description or not.
* File globs in rake should not be sorted alphabetically, independent
of file system and platform.
* Numerous internal improvements.
* Documentation typos and fixes.
==== Thanks
As usual, it was input from users that drove a lot of these changes. The
following people contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== 0.9.6
Rake version 0.9.6 contains a number of fixes mainly for merging
Rake into the Ruby source tree and fixing tests.
==== Changes
===== Bug Fixes (0.9.6)
* Better trace output when using a multi-threaded Rakefile.
* Arg parsing is now consistent for tasks and multitasks.
* Skip exit code test in versions of Ruby that don't support it well.
Changes for better integration with the Ruby source tree:
* Fix version literal for Ruby source tree build.
* Better loading of libraries for testing in Ruby build.
* Use the ruby version provided by Ruby's tests.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== 0.9.5
Rake version 0.9.5 contains a number of bug fixes.
==== Changes
===== Bug Fixes (0.9.5)
* --trace and --backtrace no longer swallow following task names.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== 0.9.4
Rake version 0.9.4 contains a number of bug fixes.
==== Changes
===== Bug Fixes (0.9.4)
* Exit status with failing tests is not correctly set to non-zero.
* Simplified syntax for phony task (for older versions of RDoc).
* Stand alone FileList usage gets glob function (without loading in
extra dependencies)
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== 0.9.3
Rake version 0.9.3 contains some new, backwards compatible features and
a number of bug fixes.
==== Changes
===== New Features
* Multitask tasks now use a thread pool. Use -j to limit the number of
available threads.
* Use -m to turn regular tasks into multitasks (use at your own risk).
* You can now do "Rake.add_rakelib 'dir'" in your Rakefile to
programatically add rake task libraries.
* You can specific backtrace suppression patterns (see
--suppress-backtrace)
* Directory tasks can now take prerequisites and actions
* Use --backtrace to request a full backtrace without the task trace.
* You can say "--backtrace=stdout" and "--trace=stdout" to route trace
output to standard output rather than standard error.
* Optional 'phony' target (enable with 'require 'rake/phony'") for
special purpose builds.
* Task#clear now clears task comments as well as actions and
prerequisites. Task#clear_comment will specifically target comments.
* The --all option will force -T and -D to consider all the tasks,
with and without descriptions.
===== Bug Fixes
* Semi-colons in windows rakefile paths now work.
* Improved Control-C support when invoking multiple test suites.
* egrep method now reads files in text mode (better support for
Windows)
* Better deprecation line number reporting.
* The -W option now works with all tasks, whether they have a
description or not.
* File globs in rake should not be sorted alphabetically, independent
of file system and platform.
* Numerous internal improvements.
* Documentation typos and fixes.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Aaron Patterson
* Dylan Smith
* Jo Liss
* Jonas Pfenniger
* Kazuki Tsujimoto
* Michael Bishop
* Michael Elufimov
* NAKAMURA Usaku
* Ryan Davis
* Sam Grönblom
* Sam Phippen
* Sergio Wong
* Tay Ray Chuan
* grosser
* quix
Also, many thanks to Eric Hodel for assisting with getting this release
out the door.
-- Jim Weirich
=== Rake 0.9.2.2
Rake version 0.9.2.2 is mainly bug fixes.
==== Changes
* The rake test loader now removes arguments it has processed. Issue #51
* Rake::TaskArguments now responds to #values\_at
* RakeFileUtils.verbose_flag = nil silences output the same as 0.8.7
* Rake tests are now directory-independent
* Rake tests are no longer require flexmock
* Commands constant is no longer polluting top level namespace.
* Show only the interesting portion of the backtrace by default (James M. Lawrence).
* Added --reduce-compat option to remove backward compatible DSL hacks (James M. Lawrence).
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* James M. Lawrence (quix)
* Roger Pack
* Cezary Baginski
* Sean Scot August Moon
* R.T. Lechow
* Alex Chaffee
* James Tucker
* Matthias Lüdtke
* Santiago Pastorino
Also, bit thanks to Eric Hodel for assisting with getting this release
out the door (where "assisting" includes, but is not by any means
limited to, "pushing" me to get it done).
-- Jim Weirich
=== 0.9.2
Rake version 0.9.2 has a few small fixes. See below for details.
==== Changes
* Support for Ruby 1.8.6 was fixed.
* Global DSL warnings now honor --no-deprecate
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* James M. Lawrence (quix)
* Roger Pack
* Cezary Baginski
* Sean Scot August Moon
* R.T. Lechow
* Alex Chaffee
* James Tucker
* Matthias Lüdtke
* Santiago Pastorino
Also, bit thanks to Eric Hodel for assisting with getting this release
out the door (where "assisting" includes, but is not by any means
limited to, "pushing" me to get it done).
-- Jim Weirich
=== 0.9.1
Rake version 0.9.1 has a number of bug fixes and enhancments (see
below for more details). Additionally, the internals have be slightly
restructured and improved.
==== Changes
Rake 0.9.1 adds back the global DSL methods, but with deprecation
messages. This allows Rake 0.9.1 to be used with older rakefiles with
warning messages.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* James M. Lawrence (quix)
* Roger Pack
* Cezary Baginski
* Sean Scot August Moon
* R.T. Lechow
* Alex Chaffee
* James Tucker
* Matthias Lüdtke
* Santiago Pastorino
Also, bit thanks to Eric Hodel for assisting with getting this release
out the door (where "assisting" includes, but is not by any means
limited to, "pushing" me to get it done).
-- Jim Weirich
=== 0.9.0
Rake version 0.9.0 has a number of bug fixes and enhancments (see
below for more details). Additionally, the internals have be slightly
restructured and improved.
==== Changes
===== New Features / Enhancements / Bug Fixes in Version 0.9.0
* Rake now warns when the deprecated :needs syntax used (and suggests
the proper syntax in the warning).
* Moved Rake DSL commands to top level ruby object 'main'. Rake DSL
commands are no longer private methods in Object. (Suggested by
James M. Lawrence/quix)
* Rake now uses case-insensitive comparisons to find the Rakefile on Windows.
Based on patch by Roger Pack.
* Rake now requires (instead of loads) files in the test task. Patch by Cezary
Baginski.
* Fixed typos. Patches by Sean Scot August Moon and R.T. Lechow.
* Rake now prints the Rakefile directory only when it's different from the
current directory. Patch by Alex Chaffee.
* Improved rakefile_location discovery on Windows. Patch by James Tucker.
* Rake now recognizes "Windows Server" as a windows system. Patch by Matthias
Lüdtke
* Rake::RDocTask is deprecated. Use RDoc::Task from RDoc 2.4.2+ (require
'rdoc/task')
* Rake::GemPackageTask is deprecated. Use Gem::PackageTask (require
'rubygems/package\_task')
* Rake now outputs various messages to $stderr instead of $stdout.
* Rake no longer emits warnings for Config. Patch by Santiago Pastorino.
* Removed Rake's DSL methods from the top level scope. If you need to
call 'task :xzy' in your code, include Rake::DSL into your class, or
put the code in a Rake::DSL.environment do ... end block.
* Split rake.rb into individual files.
* Support for the --where (-W) flag for showing where a task is defined.
* Fixed quoting in test task.
(http://onestepback.org/redmine/issues/show/44,
http://www.pivotaltracker.com/story/show/1223138)
* Fixed the silent option parsing problem.
(http://onestepback.org/redmine/issues/show/47)
* Fixed :verbose=>false flag on sh and ruby commands.
* Rake command line options may be given by default in a RAKEOPT
environment variable.
* Errors in Rake will now display the task invocation chain in effect
at the time of the error.
* Accepted change by warnickr to not expand test patterns in shell
(allowing more files in the test suite).
* Fixed that file tasks did not perform prereq lookups in scope
(Redmine #57).
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* James M. Lawrence (quix)
* Roger Pack
* Cezary Baginski
* Sean Scot August Moon
* R.T. Lechow
* Alex Chaffee
* James Tucker
* Matthias Lüdtke
* Santiago Pastorino
Also, bit thanks to Eric Hodel for assisting with getting this release
out the door (where "assisting" includes, but is not by any means
limited to, "pushing" me to get it done).
-- Jim Weirich
=== 0.8.7
Rake version 0.8.5 introduced greatly improved support for executing
commands on Windows. The "sh" command now has the same semantics on
Windows that it has on Unix based platforms.
Rake version 0.8.6 includes minor fixes the the RDoc generation.
Rake version 0.8.7 includes a minor fix for JRuby running on windows.
==== Changes
===== New Features / Enhancements in Version 0.8.5
* Improved implementation of the Rake system command for Windows.
(patch from James M. Lawrence/quix)
* Support for Ruby 1.9's improved system command. (patch from James
M. Lawrence/quix)
* Rake now includes the configured extension when invoking an
executable (Config::CONFIG['EXEEXT])
===== Bug Fixes in Version 0.8.5
* Environment variable keys are now correctly cased (it matters in
some implementations).
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Charles Nutter
-- Jim Weirich
=== 0.8.6
Rake version 0.8.5 introduced greatly improved support for executing
commands on Windows. The "sh" command now has the same semantics on
Windows that it has on Unix based platforms.
Rake version 0.8.5 includes minor fixes the the RDoc generation.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* James M. Lawrence/quix
* Luis Lavena
-- Jim Weirich
=== 0.8.5
Rake version 0.8.5 is a new release of Rake with greatly improved
support for executing commands on Windows. The "sh" command now has
the same semantics on Windows that it has on Unix based platforms.
==== Changes
===== New Features / Enhancements in Version 0.8.5
* Improved implementation of the Rake system command for Windows.
(patch from James M. Lawrence/quix)
* Support for Ruby 1.9's improved system command. (patch from James
M. Lawrence/quix)
* Rake now includes the configured extension when invoking an
executable (Config::CONFIG['EXEEXT])
===== Bug Fixes in Version 0.8.5
* Environment variable keys are now correctly cased (it matters in
some implementations).
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* James M. Lawrence/quix
* Luis Lavena
-- Jim Weirich
=== 0.8.4
Rake version 0.8.4 is a bug-fix release of rake.
NOTE: The version of Rake that comes with Ruby 1.9 has diverged
slightly from the core Rake code base. Rake 0.8.4 will work
with Ruby 1.9, but is not a strict upgrade for the Rake that
comes with Ruby 1.9. A (near) future release of Rake will unify
those two codebases.
==== Letter Writing Campaign
Thanks to Aaron Patterson (@tenderlove) and Eric Hodel (@drbrain) for
their encouraging support in organizing a letter writing campaign to
lobby for the "Warning Free" release of rake 0.8.4. A special callout
goes to Jonathan D. Lord, Sr (Dr. Wingnut) whose postcard was the
first to actually reach me. (see
http://tenderlovemaking.com/2009/02/26/we-need-a-new-version-of-rake/
for details)
==== Changes
===== New Features / Enhancements in Version 0.8.4
* Case is preserved on rakefile names. (patch from James
M. Lawrence/quix)
* Improved Rakefile case insensitivity testing (patch from Luis
Lavena).
* Windows system dir search order is now: HOME, HOMEDRIVE + HOMEPATH,
APPDATA, USERPROFILE (patch from Luis Lavena)
* MingGW is now recognized as a windows platform. (patch from Luis
Lavena)
===== Bug Fixes in Version 0.8.4
* Removed reference to manage_gem to fix the warning produced by the
gem package task.
* Fixed stray ARGV option problem that was interfering with
Test::Unit::Runner. (patch from Pivotal Labs)
===== Infrastructure Improvements in Version 0.8.4
* Numerous fixes to the windows test suite (patch from Luis Lavena).
* Improved Rakefile case insensitivity testing (patch from Luis
Lavena).
* Better support for windows paths in the test task (patch from Simon
Chiang/bahuvrihi)
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* James M. Lawrence/quix
* Luis Lavena
* Pivotal Labs
* Simon Chiang/bahuvrihi
-- Jim Weirich
=== 0.8.3
Rake version 0.8.3 is a bug-fix release of rake.
==== Changes
===== Bug Fixes in Version 0.8.3
* Enhanced the system directory detection in windows. We now check
HOMEDRIVE/HOMEPATH and USERPROFILE if APPDATA isn't found. (Patch
supplied by James Tucker). Rake no long aborts if it can't find the
directory.
* Added fix to handle ruby installations in directories with spaces in
their name.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Edwin Pratomo
* Gavin Stark
* Adam Q. Salter
* Adam Majer
* Emanuel Indermühle
* Ittay Dror
* Bheeshmar Redheendran (for spending an afternoon with me debugging
windows issues)
-- Jim Weirich
=== 0.8.2
Rake version 0.8.2 is a new release of rake that includes a number of
new features and numerous bug fixes.
==== Changes
===== New Features in Version 0.8.2
* Switched from getoptlong to optparse (patches supplied by Edwin
Pratomo).
* The -T option will now attempt to dynamically sense the size of the
terminal. The -T output will only self-truncate if the output is a
tty. However, if RAKE_COLUMNS is explicitly set, it will be honored
in any case. (Patch provided by Gavin Stark).
* The following public methods have been added to rake task objects:
* task.clear -- Clear both the prerequisites and actions of the
target rake task.
* task.clear_prerequisites -- Clear all the existing prerequisites
from the target rake task.
* task.clear_actions -- Clear all the existing actions from the
target rake task.
* task.reenable -- Re-enable a task, allowing its actions to be
executed again if the task is invoked.
* Changed RDoc test task to have no default template. This makes it
easier for the tempate to pick up the template from the environment.
* Default values for task arguments can easily be specified with the
:with_defaults method. (Idea for default argument merging supplied
by (Adam Q. Salter)
===== Bug Fixes in Version 0.8.2
* Fixed bug in package task so that it will include the subdir
directory in the package for testing. (Bug found by Adam Majer)
* Fixed filename dependency order bug in test\_inspect\_pending and
test\_to\_s\_pending. (Bug found by Adam Majer)
* Fixed check for file utils options to make them immune to the
symbol/string differences. (Patch supplied by Edwin Pratomo)
* Fixed bug with rules involving multiple source, where only the first
dependency of a rule has any effect (Patch supplied by Emanuel
Indermühle)
* FileList#clone and FileList#dup have better sematics w.r.t. taint
and freeze.
* Changed from using Mutex to Monitor. Evidently Mutex causes thread
join errors when Ruby is compiled with -disable-pthreads. (Patch
supplied by Ittay Dror)
* Fixed bug in makefile parser that had problems with extra spaces in
file task names. (Patch supplied by Ittay Dror)
==== Other changes in Version 0.8.2
* Added ENV var to rake's own Rakefile to prevent OS X from including
extended attribute junk in the rake package tar file. (Bug found by
Adam Majer)
* Added a performance patch for reading large makefile dependency
files. (Patch supplied by Ittay Dror)
==== Task Argument Examples
Prior to version 0.8.0, rake was only able to handle command line
arguments of the form NAME=VALUE that were passed into Rake via the
ENV hash. Many folks had asked for some kind of simple command line
arguments, perhaps using "--" to separate regular task names from
argument values on the command line. The problem is that there was no
easy way to associate positional arguments on the command line with
different tasks. Suppose both tasks :a and :b expect a command line
argument: does the first value go with :a? What if :b is run first?
Should it then get the first command line argument.
Rake 0.8.0 solves this problem by explicitly passing values directly
to the tasks that need them. For example, if I had a release task
that required a version number, I could say:
rake release[0.8.2]
And the string "0.8.2" will be passed to the :release task. Multiple
arguments can be passed by separating them with a comma, for example:
rake name[john,doe]
Just a few words of caution. The rake task name and its arguments
need to be a single command line argument to rake. This generally
means no spaces. If spaces are needed, then the entire rake +
argument string should be quoted. Something like this:
rake "name[billy bob, smith]"
(Quoting rules vary between operating systems and shells, so make sure
you consult the proper docs for your OS/shell).
===== Tasks that Expect Parameters
Parameters are only given to tasks that are setup to expect them. In
order to handle named parameters, the task declaration syntax for
tasks has been extended slightly.
For example, a task that needs a first name and last name might be
declared as:
task :name, :first_name, :last_name
The first argument is still the name of the task (:name in this case).
The next to argumements are the names of the parameters expected by
:name (:first_name and :last_name in the example).
To access the values of the parameters, the block defining the task
behaviour can now accept a second parameter:
task :name, :first_name, :last_name do |t, args|
puts "First name is #{args.first_name}"
puts "Last name is #{args.last_name}"
end
The first argument of the block "t" is always bound to the current
task object. The second argument "args" is an open-struct like object
that allows access to the task arguments. Extra command line
arguments to a task are ignored. Missing command line arguments are
given the nil value.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Edwin Pratomo
* Gavin Stark
* Adam Q. Salter
* Adam Majer
* Emanuel Indermühle
* Ittay Dror
* Bheeshmar Redheendran (for spending an afternoon with me debugging
windows issues)
-- Jim Weirich
=== 0.8.0/0.8.1
Rake version 0.8.0 is a new release of rake that includes serveral new
features.
==== Changes
===== New Features in Version 0.8.0
* Tasks can now receive command line parameters. See the examples
below for more details.
* Comments are limited to 80 columns on output, but full comments can
be seen by using the -D parameter. (feature suggested by Jamis
Buck).
* Explicit exit(n) calls will now set the exit status to n. (patch
provided by Stephen Touset).
* Rake is now compatible with Ruby 1.9.
Version 0.8.1 is a minor update that includes additional Ruby 1.9
compatibility fixes.
==== Task Argument Examples
Prior to version 0.8.0, rake was only able to handle command line
arguments of the form NAME=VALUE that were passed into Rake via the
ENV hash. Many folks had asked for some kind of simple command line
arguments, perhaps using "--" to separate regular task names from
argument values on the command line. The problem is that there was no
easy way to associate positional arguments on the command line with
different tasks. Suppose both tasks :a and :b expect a command line
argument: does the first value go with :a? What if :b is run first?
Should it then get the first command line argument.
Rake 0.8.0 solves this problem by explicitly passing values directly
to the tasks that need them. For example, if I had a release task
that required a version number, I could say:
rake release[0.8.0]
And the string "0.8.0" will be passed to the :release task. Multiple
arguments can be passed by separating them with a comma, for example:
rake name[john,doe]
Just a few words of caution. The rake task name and its arguments
need to be a single command line argument to rake. This generally
means no spaces. If spaces are needed, then the entire rake +
argument string should be quoted. Something like this:
rake "name[billy bob, smith]"
(Quoting rules vary between operating systems and shells, so make sure
you consult the proper docs for your OS/shell).
===== Tasks that Expect Parameters
Parameters are only given to tasks that are setup to expect them. In
order to handle named parameters, the task declaration syntax for
tasks has been extended slightly.
For example, a task that needs a first name and last name might be
declared as:
task :name, :first_name, :last_name
The first argument is still the name of the task (:name in this case).
The next to argumements are the names of the parameters expected by
:name (:first_name and :last_name in the example).
To access the values of the parameters, the block defining the task
behaviour can now accept a second parameter:
task :name, :first_name, :last_name do |t, args|
puts "First name is #{args.first_name}"
puts "Last name is #{args.last_name}"
end
The first argument of the block "t" is always bound to the current
task object. The second argument "args" is an open-struct like object
that allows access to the task arguments. Extra command line
arguments to a task are ignored. Missing command line arguments are
given the nil value.
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
* Jamis Buck (for comment formatting suggestions)
* Stephen Touset (for exit status patch).
-- Jim Weirich
=== 0.7.3
Rake version 0.7.3 is a minor release that includes some refactoring to better
support custom Rake applications.
==== Changes
===== New Features in Version 0.7.3
* Added the +init+ and +top_level+ methods to make the creation of custom Rake applications a bit easier. E.g.
gem 'rake', ">= 0.7.3"
require 'rake'
Rake.application.init('myrake')
task :default do
something_interesting
end
Rake.application.top_level
==== Thanks
As usual, it was input from users that drove a alot of these changes. The
following people either contributed patches, made suggestions or made
otherwise helpful comments. Thanks to ...
-- Jim Weirich
=== 0.7.2
Version 0.7.2 supplies a bug fix and a few minor enhancements. In
particular, the new version fixes an incompatibility with the soon to
be released Ruby 1.8.6. We strongly recommend upgrading to Rake 0.7.2
in order to be compatible with the new version of Ruby.
==== Changes
===== Bug Fixes in 0.7.2
There are quite a number of bug fixes in the new 0.7.2 version of
Rake:
* Removed dependency on internal fu_xxx functions from FileUtils.
* Error messages are now send to stderr rather than stdout (from
Payton Quackenbush).
* Better error handling on invalid command line arguments (from Payton
Quackenbush).
* Fixed some bugs where the application object was going to the global
appliation instead of using its own data.
* Fixed the method name leak from FileUtils (bug found by Glenn
Vanderburg).
* Added test for noop, bad_option and verbose flags to sh command.
* Added a description to the gem task in GemPackageTask.
* Fixed a bug when rules have multiple prerequisites (patch by Joel
VanderWerf)
* Added the handful of RakeFileUtils to the private method as well.
===== New Features in 0.7.2
The following new features are available in Rake version 0.7.2:
* Added square and curly bracket patterns to FileList#include (Tilman
Sauerbeck).
* FileLists can now pass a block to FileList#exclude to exclude files
based on calculated values.
* Added plain filename support to rule dependents (suggested by Nobu
Nakada).
* Added pathmap support to rule dependents. In other words, if a
pathmap format (beginning with a '%') is given as a Rake rule
dependent, then the name of the depend will be the name of the
target with the pathmap format applied.
* Added a 'tasks' method to a namespace to get a list of tasks
associated with the namespace.
* Added tar_command and zip_command options to the Package task.
* The clean task will no longer delete 'core' if it is a directory.
===== Internal Rake Improvements
The following changes will are mainly internal improvements and
refactorings and have little effect on the end user. But they may be
of interest to the general public.
* Added rcov task and updated unit testing for better code coverage.
* Added a 'shame' task to the Rakefile.
* Added rake_extension to handle detection of extension collisions.
* Added a protected 'require "rubygems"' to test/test_application to
unbreak cruisecontrol.rb.
* Removed rake\_dup. Now we just simply rescue a bad dup.
* Refactored the FileList reject logic to remove duplication.
* Removed if \_\_FILE\_\_ at the end of the rake.rb file.
==== Thanks
As usual, it was input from users that drove a alot of these changes.
The following people either contributed patches, made suggestions or
made otherwise helpful comments. Thanks to ...
* Payton Quackenbush -- For several error handling improvements.
* Glenn Vanderburg -- For finding and fixing the method name leak from
FileUtils.
* Joel VanderWerf -- for finding and fixing a bug in the handling of
multiple prerequisites.
* Tilman Sauerbeck -- For some enhancing FileList to support more
advanced file globbing.
* Nobu Nakada -- For suggesting plain file name support to rule dependents.
-- Jim Weirich
=== 0.7.1
Version 0.7.1 supplies a bug fix and a few minor enhancements.
==== Changes
===== Bug Fixes in 0.7.1
* Changes in the exception reported for the FileUtils.ln caused
safe_ln to fail with a NotImplementedError. Rake 0.7.1 will now
catch that error or any StandardError and properly fall back to
using +cp+.
===== New Features in 0.7.1
* You can filter the results of the --task option by supplying an
optional regular expression. This allows the user to easily find a
particular task name in a long list of possible names.
* Transforming procs in a rule may now return a list of prerequisites.
This allows more flexible rule formation.
* FileList and String now support a +pathmap+ melthod that makes the
transforming paths a bit easier. See the API docs for +pathmap+ for
details.
* The -f option without a value will disable the search for a
Rakefile. This allows the Rakefile to be defined entirely in a
library (and loaded with the -r option). The current working
directory is not changed when this is done.
==== Thanks
As usual, it was input from users that drove a alot of these changes.
The following people either contributed patches, made suggestions or
made otherwise helpful comments. Thanks to ...
* James Britt and Assaph Mehr for reporting and helping to debug the
safe_ln issue.
-- Jim Weirich
=== 0.7.0
These changes for Rake have been brewing for a long time. Here they
are, I hope you enjoy them.
==== Changes
===== New Features
* Name space support for task names (see below).
* Prerequisites can be executed in parallel (see below).
* Added safe_ln support for openAFS (via Ludvig Omholt).
* RDoc defaults to internal (in-process) invocation. The old behavior
is still available by setting the +external+ flag to true.
* Rakefiles are now loaded with the expanded path to prevent
accidental pollution from the Ruby load path.
* Task objects my now be used in prerequisite lists directly.
* Task objects (in addition to task names) may now be included in the
prerequisite list of a task.
* Internals cleanup and refactoring.
===== Bug Fixes
* Compatibility fixes for Ruby 1.8.4 FileUtils changes.
===== Namespaces
Tasks can now be nested inside their own namespaces. Tasks within one
namespace will not accidentally interfer with tasks named in a different
namespace.
For example:
namespace "main" do
task :build do
# Build the main program
end
end
namespace "samples" do
task :build do
# Build the sample programs
end
end
task :build_all => ["main:build", "samples:build"]
Even though both tasks are named :build, they are separate tasks in
their own namespaces. The :build_all task (defined in the toplevel
namespace) references both build tasks in its prerequisites.
You may invoke each of the individual build tasks with the following
commands:
rake main:build
rake samples:build
Or invoke both via the :build_all command:
rake build_all
Namespaces may be nested arbitrarily. Since the name of file tasks
correspond to the name of a file in the external file system,
FileTasks are not affected by the namespaces.
See the Rakefile format documentation (in the Rake API documents) for
more information.
===== Parallel Tasks
Sometimes you have several tasks that can be executed in parallel. By
specifying these tasks as prerequisites to a +multitask+ task.
In the following example the tasks copy\_src, copy\_doc and copy\_bin
will all execute in parallel in their own thread.
multitask :copy_files => [:copy_src, :copy_doc, :copy_bin] do
puts "All Copies Complete"
end
==== Thanks
As usual, it was input from users that drove a alot of these changes.
The following people either contributed patches, made suggestions or
made otherwise helpful comments. Thanks to ...
* Doug Young (inspiration for the parallel task)
* David Heinemeier Hansson (for --trace message enhancement and for
pushing for namespace support).
* Ludvig Omholt (for the openAFS fix)
-- Jim Weirich
=== 0.6.1
* Rebuilt 0.6.0 gem without signing.
=== 0.6.0
Its time for some long requested enhancements and lots of bug fixes
... And a whole new web page.
==== New Web Page
The primary documentation for rake has moved from the RubyForge based
wiki to its own Hieraki based web site. Constant spam on the wiki
made it a difficult to keep clean. The new site will be easier to
update and organize.
Check out the new documentation at: http://docs.rubyrake.org
We will be adding new documentation to the site as time goes on.
In addition to the new docs page, make sure you check out Martin
Fowlers article on rake at http://martinfowler.com/articles/rake.html
==== Changes
===== New Features
* Multiple prerequisites on Rake rules now allowed. However, keep the
following in mind:
1. All the prerequisites of a rule must be available before a rule
is triggered, where "enabled" means (a) an existing file, (b) a
defined rule, or (c) another rule which also must be
trigger-able.
2. Rules are checked in order of definition, so it is important to
order your rules properly. If a file can be created by two
different rules, put the more specific rule first (otherwise the
more general rule will trigger first and the specific one will
never be triggered).
3. The <tt>source</tt> method now returns the name of the first
prerequisite listed in the rule. <tt>sources</tt> returns the
names of all the rule prerequisites, ordered as they are defined
in the rule. If the task has other prerequisites not defined in
the rule (but defined in an explicit task definition), then they
will _not_ be included in the sources list.
* FileLists may now use the egrep command. This popular enhancement
is now a core part of the FileList object. If you want to get a
list of all your to-dos, fixmes and TBD comments, add the following
to your Rakefile.
desc "Look for TODO and FIXME tags in the code"
task :todo do
FileList['**/*.rb'].egrep /#.*(FIXME|TODO|TBD)/
end
* The <tt>investigation</tt> method was added to task object to dump
out some important values. This makes it a bit easier to debug Rake
tasks.
For example, if you are having problems with a particular task, just
print it out:
task :huh do
puts Rake::Task['huh'].investigation
end
* The Rake::TestTask class now supports a "ruby\_opts" option to pass
arbitrary ruby options to a test subprocess.
===== Some Incompatibilities
* When using the <tt>ruby</tt> command to start a Ruby subprocess, the
Ruby interpreter that is currently running rake is used by default.
This makes it easier to use rake in an environment with multiple
ruby installation. (Previously, the first ruby command found in the
PATH was used).
If you wish to chose a different Ruby interpreter, you can
explicitly choose the interpreter via the <tt>sh</tt> command.
* The major rake classes (Task, FileTask, FileCreationTask, RakeApp)
have been moved out of the toplevel scope and are now accessible as
Rake::Task, Rake::FileTask, Rake::FileCreationTask and
Rake::Application. If your Rakefile
directly references any one of these tasks, you may:
1. Update your Rakefile to use the new classnames
2. Use the --classic-namespace option on the rake command to get the
old behavior,
3. Add <code>require 'rake/classic_namespace'</code> to the
Rakefile to get the old behavior.
<tt>rake</tt> will print a rather annoying warning whenever a
deprecated class name is referenced without enabling classic
namespace.
===== Bug Fixes
* Several unit tests and functional tests were fixed to run better
under windows.
* Directory tasks are now a specialized version of a File task. A
directory task will only be triggered if it doesn't exist. It will
not be triggered if it is out of date w.r.t. any of its
prerequisites.
* Fixed a bug in the Rake::GemPackageTask class so that the gem now
properly contains the platform name.
* Fixed a bug where a prerequisite on a <tt>file</tt> task would cause
an exception if the prerequisite did not exist.
==== Thanks
As usual, it was input from users that drove a alot of these changes.
The following people either contributed patches, made suggestions or
made otherwise helpful comments. Thanks to ...
* Greg Fast (better ruby_opt test options)
* Kelly Felkins (requested by better namespace support)
* Martin Fowler (suggested Task.investigation)
* Stuart Jansen (send initial patch for multiple prerequisites).
* Masao Mutch (better support for non-ruby Gem platforms)
* Philipp Neubeck (patch for file task exception fix)
-- Jim Weirich
=== 0.5.4
Time for some minor bug fixes and small enhancements
==== Changes
Here are the changes for version 0.5.4 ...
* Added double quotes to the test runner. This allows the location of
the tests (and runner) to be in a directory path that contains
spaces (e.g. "C:/Program Files/ruby/bin").
* Added .svn to default ignore list. Now subversion project metadata
is automatically ignored by Rake's FileList.
* Updated FileList#include to support nested arrays and filelists.
FileLists are flat lists of file names. Using a FileList in an
include will flatten out the nested file names.
== Thanks
As usual, it was input from users that drove a alot of these changes.
Thanks to ...
* Tilman Sauerbeck for the nested FileList suggestion.
* Josh Knowles for pointing out the spaces in directory name problem.
-- Jim Weirich
=== 0.5.3
Although it has only been two weeks since the last release, we have
enough updates to the Rake program to make it time for another
release.
==== Changes
Here are the changes for version 0.5.3 ...
* FileLists have been extensively changed so that they mimic the
behavior of real arrays even more closely. In particular,
operations on FileLists that return a new collection (e.g. collect,
reject) will now return a FileList rather than an array. In
addition, several places where FileLists were not properly expanded
before use have been fixed.
* A method (+ext+) to simplify the handling of file extensions was
added to String and to Array.
* The 'testrb' script in test/unit tends to silently swallow syntax
errors in test suites. Because of that, the default test loader is
now a rake-provided script. You can still use 'testrb' by setting
the loader flag in the test task to :testrb. (See the API documents
for TestTask for all the loader flag values).
* FileUtil methods (e.g. cp, mv, install) are now declared to be
private. This will cut down on the interference with user defined
methods of the same name.
* Fixed the verbose flag in the TestTask so that the test code is
controlled by the flag. Also shortened up some failure messages.
(Thanks to Tobias Luetke for the suggestion).
* Rules will now properly detect a task that can generate a source
file. Previously rules would only consider source files that were
already present.
* Added an +import+ command that allows Rake to dynamically import
dependendencies into a running Rake session. The +import+ command
can run tasks to update the dependency file before loading them.
Dependency files can be in rake or make format, allowing rake to
work with tools designed to generate dependencies for make.
==== Thanks
As usual, it was input from users that drove a alot of these changes.
Thanks to ...
* Brian Gernhardt for the rules fix (especially for the patience to
explain the problem to me until I got what he was talking about).
* Stefan Lang for pointing out problems in the dark corners of the
FileList implementation.
* Alexey Verkhovsky pointing out the silently swallows syntax errors
in tests.
* Tobias Luetke for beautifying the test task output.
* Sam Roberts for some of the ideas behind dependency loading.
-- Jim Weirich
=== 0.5.0
It has been a long time in coming, but we finally have a new version
of Rake available.
==== Changes
* Fixed documentation that was lacking the Rake module name (Tilman
Sauerbeck).
* Added tar.gz and tar.bz2 support to package task (Tilman Sauerbeck).
* Recursive rules are now supported (Tilman Sauerbeck).
* Added warning option for the Test Task (requested by Eric Hodel).
* The jamis rdoc template is only used if it exists.
* Added fix for Ruby 1.8.2 test/unit and rails problem.
* Added contributed rake man file (Jani Monoses).
* Added Brian Candler's fix for problems in --trace and --dry-run
mode.
==== Thanks
Lots of people provided input to this release. Thanks to Tilman
Sauerbeck for numerous patches, documentation fixes and suggestions.
And for also pushing me to get this release out. Also, thanks to
Brian Candler for the finding and fixing --trace/dry-run fix. That
was an obscure bug. Also to Eric Hodel for some good suggestions.
-- Jim Weirich
=== 0.4.15
==== Changes
Version 0.4.15 is a bug fix update for the Ruby 1.8.2 compatibility
changes. This release includes:
* Fixed a bug that prevented the TESTOPTS flag from working with the
revised for 1.8.2 test task.
* Updated the docs on --trace to indicate that it also enables a full
backtrace on errors.
* Several fixes for new warnings generated.
==== Mini-Roadmap
I will continue to issue Rake updates in the 0.4.xx series as new
Ruby-1.8.2 issues become manifest. Once the codebase stabilizes, I
will release a 0.5.0 version incorporating all the changes. If you
are not using Ruby-1.8.2 and wish to avoid version churn, I recommend
staying with a release prior to Rake-0.4.14.
=== 0.4.14
Version 0.4.14 is a compatibility fix to allow Rake's test task to
work under Ruby 1.8.2. A change in the Test::Unit autorun feature
prevented Rake from running any tests. This release fixes the
problem.
Rake 0.4.14 is the recommended release for anyone using Ruby 1.8.2.
=== 0.4.13
* Fixed the dry-run flag so it is operating again.
* Multiple arguments to sh and ruby commands will not be interpreted
by the shell (patch provided by Jonathan Paisley).
=== 0.4.12
* Added --silent (-s) to suppress the (in directory) rake message.
=== 0.4.11
* Changed the "don't know how to rake" message (finally)
* Changes references to a literal "Rakefile" to reference the global
variable $rakefile (which contains the actual name of the rakefile).
=== 0.4.10
* Added block support to the "sh" command, allowing users to take
special actions on the result of the system call. E.g.
sh "shell_command" do |ok, res|
puts "Program returned #{res.exitstatus}" if ! ok
end
=== 0.4.9
* Switched to Jamis Buck's RDoc template.
* Removed autorequire from Rake's gem spec. This prevents the Rake
libraries from loading while using rails.
=== 0.4.8
* Added support for .rb versions of Rakefile.
* Removed \\\n's from test task.
* Fixed Ruby 1.9 compatibility issue with FileList.
=== 0.4.7
* Fixed problem in FileList that caused Ruby 1.9 to go into infinite
recursion. Since to_a was removed from Object, it does not need to
added back into the list of methods to rewrite in FileList. (Thanks
to Kent Sibilev for pointing this out).
=== 0.4.6
* Removed test version of ln in FileUtils that prevented safe_ln from
using ln.
=== 0.4.5
* Upgraded comments in TestTask.
* FileList to_s and inspect now automatically resolve pending changes.
* FileList#exclude properly returns the FileList.
=== 0.4.4
* Fixed initialization problem with @comment.
* Now using multi -r technique in TestTask. Switch Rakefile back to
using the built-in test task macros because the rake runtime is no
longer needed.
* Added 'TEST=filename' and 'TESTOPTS=options' to the Test Task
macros.
* Allow a +test_files+ attribute in test tasks. This allows more
flexibility in specifying test files.
=== 0.4.3
* Fixed Comment leakage.
=== 0.4.2
* Added safe_ln that falls back to a copy if a file link is not supported.
* Package builder now uses safe\_ln.
=== 0.4.1
* Task comments are now additive, combined with "/".
* Works with (soon to be released) rubygems 0.6.2 (or 0.7.0)
=== 0.4.0
* FileList now uses deferred loading. The file system is not searched
until the first call that needs the file names.
* VAR=VALUE options are now accepted on the command line and are
treated like environment variables. The values may be tested in a
Rakefile by referencing ENV['VAR'].
* File.mtime is now used (instead of File.new().mtime).
=== 0.3.2.x
* Removed some hidden dependencies on rubygems. Tests now will test
gems only if they are installed.
* Removed Sys from some example files. I believe that is that last
reference to Sys outside of the contrib area.
* Updated all copyright notices to include 2004.
=== 0.3.2
* GEM Installation now works with the application stub.
=== 0.3.1
* FileLists now automatically ignore CVS, .bak, !
* GEM Installation now works.
=== 0.3.0
Promoted 0.2.10.
=== 0.2.10
General
* Added title to Rake's rdocs
* Contrib packages are no longer included in the documentation.
RDoc Issues
* Removed default for the '--main' option
* Fixed rendering of the rdoc options
* Fixed clean/clobber confusion with rerdoc
* 'title' attribute added
Package Task Library Issues
* Version (or explicit :noversion) is required.
* +package_file+ attribute is now writable
FileList Issues
* Dropped bang version of exclude. Now using ant-like include/exclude semantics.
* Enabled the "yield self" idiom in FileList#initialize.
=== 0.2.9
This version contains numerous changes as the RubyConf.new(2003)
presentation was being prepared. The changes include:
* The monolithic rubyapp task library is in the process of being
dropped in favor of lighter weight task libraries.
=== 0.2.7
* Added "desc" for task descriptions.
* -T will now display tasks with descriptions.
* -P will display tasks and prerequisites.
* Dropped the Sys module in favor of the 1.8.x FileUtils module. Sys
is still supported in the contrib area.
=== 0.2.6
* Moved to RubyForge
=== 0.2.5
* Switched to standard ruby app builder.
* Added no_match option to file matcher.
=== 0.2.4
* Fixed indir, which neglected to actually change directories.
=== 0.2.3
* Added rake module for a help target
* Added 'for\_files' to Sys
* Added a $rakefile constant
* Added test for selecting proper rule with multiple targets.
share/gems/gems/rake-13.1.0/README.rdoc 0000644 00000011527 15173517754 0013027 0 ustar 00 = RAKE -- Ruby Make
home :: https://github.com/ruby/rake
bugs :: https://github.com/ruby/rake/issues
docs :: https://ruby.github.io/rake
== Description
Rake is a Make-like program implemented in Ruby. Tasks and dependencies are
specified in standard Ruby syntax.
Rake has the following features:
* Rakefiles (rake's version of Makefiles) are completely defined in
standard Ruby syntax. No XML files to edit. No quirky Makefile
syntax to worry about (is that a tab or a space?)
* Users can specify tasks with prerequisites.
* Rake supports rule patterns to synthesize implicit tasks.
* Flexible FileLists that act like arrays but know about manipulating
file names and paths.
* A library of prepackaged tasks to make building rakefiles easier. For example,
tasks for building tarballs. (Formerly
tasks for building RDoc, Gems, and publishing to FTP were included in rake but they're now
available in RDoc, RubyGems, and rake-contrib respectively.)
* Supports parallel execution of tasks.
== Installation
=== Gem Installation
Download and install rake with the following.
gem install rake
== Usage
=== Simple Example
First, you must write a "Rakefile" file which contains the build rules. Here's
a simple example:
task default: %w[test]
task :test do
ruby "test/unittest.rb"
end
This Rakefile has two tasks:
* A task named "test", which -- upon invocation -- will run a unit test file
in Ruby.
* A task named "default". This task does nothing by itself, but it has exactly
one dependency, namely the "test" task. Invoking the "default" task will
cause Rake to invoke the "test" task as well.
Running the "rake" command without any options will cause it to run the
"default" task in the Rakefile:
% ls
Rakefile test/
% rake
(in /home/some_user/Projects/rake)
ruby test/unittest.rb
....unit test output here...
Type "rake --help" for all available options.
== Resources
=== Rake Information
* {Rake command-line}[link:doc/command_line_usage.rdoc]
* {Writing Rakefiles}[link:doc/rakefile.rdoc]
* The original {Rake announcement}[link:doc/rational.rdoc]
* Rake {glossary}[link:doc/glossary.rdoc]
=== Presentations and Articles about Rake
* Avdi Grimm's rake series:
1. {Rake Basics}[https://avdi.codes/rake-part-1-basics/]
2. {Rake File Lists}[https://avdi.codes/rake-part-2-file-lists-2/]
3. {Rake Rules}[https://avdi.codes/rake-part-3-rules/]
4. {Rake Pathmap}[https://avdi.codes/rake-part-4-pathmap/]
5. {File Operations}[https://avdi.codes/rake-part-5-file-operations/]
6. {Clean and Clobber}[https://avdi.codes/rake-part-6-clean-and-clobber/]
7. {MultiTask}[https://avdi.codes/rake-part-7-multitask/]
* {Jim Weirich's 2003 RubyConf presentation}[https://web.archive.org/web/20140221123354/http://onestepback.org/articles/buildingwithrake/]
* Martin Fowler's article on Rake: https://martinfowler.com/articles/rake.html
== Other Make Re-envisionings ...
Rake is a late entry in the make replacement field. Here are links to
other projects with similar (and not so similar) goals.
* https://directory.fsf.org/wiki/Bras -- Bras, one of earliest
implementations of "make in a scripting language".
* http://www.a-a-p.org -- Make in Python
* https://ant.apache.org -- The Ant project
* https://search.cpan.org/search?query=PerlBuildSystem -- The Perl Build System
* https://www.rubydoc.info/gems/rant/0.5.7/frames -- Rant, another Ruby make tool.
== Credits
[<b>Jim Weirich</b>] Who originally created Rake.
[<b>Ryan Dlugosz</b>] For the initial conversation that sparked Rake.
[<b>Nobuyoshi Nakada <nobu@ruby-lang.org></b>] For the initial patch for rule support.
[<b>Tilman Sauerbeck <tilman@code-monkey.de></b>] For the recursive rule patch.
[<b>Eric Hodel</b>] For aid in maintaining rake.
[<b>Hiroshi SHIBATA</b>] Maintainer of Rake 10 and later
== License
Rake is available under an MIT-style license.
:include: MIT-LICENSE
---
= Other stuff
Author:: Jim Weirich <jim.weirich@gmail.com>
Requires:: Ruby 2.0.0 or later
License:: Copyright Jim Weirich.
Released under an MIT-style license. See the MIT-LICENSE
file included in the distribution.
== Warranty
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.
== Historical
Rake was originally created by Jim Weirich, who unfortunately passed away in
February 2014. This repository was originally hosted at
{github.com/jimweirich/rake}[https://github.com/jimweirich/rake/], however
with his passing, has been moved to {ruby/rake}[https://github.com/ruby/rake].
You can view Jim's last commit here:
https://github.com/jimweirich/rake/tree/336559f28f55bce418e2ebcc0a57548dcbac4025
You can {read more about Jim}[https://en.wikipedia.org/wiki/Jim_Weirich] at Wikipedia.
Thank you for this great tool, Jim. We'll remember you.
share/gems/gems/rake-13.1.0/MIT-LICENSE 0000644 00000002033 15173517754 0012645 0 ustar 00 Copyright (c) Jim Weirich
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
share/gems/gems/rake-13.1.0/lib/rake/dsl_definition.rb 0000644 00000012760 15173517754 0016230 0 ustar 00 # frozen_string_literal: true
# Rake DSL functions.
require "rake/file_utils_ext"
module Rake
##
# DSL is a module that provides #task, #desc, #namespace, etc. Use this
# when you'd like to use rake outside the top level scope.
#
# For a Rakefile you run from the command line this module is automatically
# included.
module DSL
#--
# Include the FileUtils file manipulation functions in the top
# level module, but mark them private so that they don't
# unintentionally define methods on other objects.
#++
include FileUtilsExt
private(*FileUtils.instance_methods(false))
private(*FileUtilsExt.instance_methods(false))
private
# :call-seq:
# task(task_name)
# task(task_name: dependencies)
# task(task_name, arguments => dependencies)
#
# Declare a basic task. The +task_name+ is always the first argument. If
# the task name contains a ":" it is defined in that namespace.
#
# The +dependencies+ may be a single task name or an Array of task names.
# The +argument+ (a single name) or +arguments+ (an Array of names) define
# the arguments provided to the task.
#
# The task, argument and dependency names may be either symbols or
# strings.
#
# A task with a single dependency:
#
# task clobber: %w[clean] do
# rm_rf "html"
# end
#
# A task with an argument and a dependency:
#
# task :package, [:version] => :test do |t, args|
# # ...
# end
#
# To invoke this task from the command line:
#
# $ rake package[1.2.3]
#
def task(*args, &block) # :doc:
Rake::Task.define_task(*args, &block)
end
# Declare a file task.
#
# Example:
# file "config.cfg" => ["config.template"] do
# open("config.cfg", "w") do |outfile|
# open("config.template") do |infile|
# while line = infile.gets
# outfile.puts line
# end
# end
# end
# end
#
def file(*args, &block) # :doc:
Rake::FileTask.define_task(*args, &block)
end
# Declare a file creation task.
# (Mainly used for the directory command).
def file_create(*args, &block)
Rake::FileCreationTask.define_task(*args, &block)
end
# Declare a set of files tasks to create the given directories on
# demand.
#
# Example:
# directory "testdata/doc"
#
def directory(*args, &block) # :doc:
result = file_create(*args, &block)
dir, _ = *Rake.application.resolve_args(args)
dir = Rake.from_pathname(dir)
Rake.each_dir_parent(dir) do |d|
file_create d do |t|
mkdir_p t.name unless File.exist?(t.name)
end
end
result
end
# Declare a task that performs its prerequisites in
# parallel. Multitasks does *not* guarantee that its prerequisites
# will execute in any given order (which is obvious when you think
# about it)
#
# Example:
# multitask deploy: %w[deploy_gem deploy_rdoc]
#
def multitask(*args, &block) # :doc:
Rake::MultiTask.define_task(*args, &block)
end
# Create a new rake namespace and use it for evaluating the given
# block. Returns a NameSpace object that can be used to lookup
# tasks defined in the namespace.
#
# Example:
#
# ns = namespace "nested" do
# # the "nested:run" task
# task :run
# end
# task_run = ns[:run] # find :run in the given namespace.
#
# Tasks can also be defined in a namespace by using a ":" in the task
# name:
#
# task "nested:test" do
# # ...
# end
#
def namespace(name=nil, &block) # :doc:
name = name.to_s if name.kind_of?(Symbol)
name = name.to_str if name.respond_to?(:to_str)
unless name.kind_of?(String) || name.nil?
raise ArgumentError, "Expected a String or Symbol for a namespace name"
end
Rake.application.in_namespace(name, &block)
end
# Declare a rule for auto-tasks.
#
# Example:
# rule '.o' => '.c' do |t|
# sh 'cc', '-o', t.name, t.source
# end
#
def rule(*args, &block) # :doc:
Rake::Task.create_rule(*args, &block)
end
# Describes the next rake task. Duplicate descriptions are discarded.
# Descriptions are shown with <code>rake -T</code> (up to the first
# sentence) and <code>rake -D</code> (the entire description).
#
# Example:
# desc "Run the Unit Tests"
# task test: [:build] do
# # ... run tests
# end
#
def desc(description) # :doc:
Rake.application.last_description = description
end
# Import the partial Rakefiles +fn+. Imported files are loaded
# _after_ the current file is completely loaded. This allows the
# import statement to appear anywhere in the importing file, and yet
# allowing the imported files to depend on objects defined in the
# importing file.
#
# A common use of the import statement is to include files
# containing dependency declarations.
#
# See also the --rakelibdir command line option.
#
# Example:
# import ".depend", "my_rules"
#
def import(*fns) # :doc:
fns.each do |fn|
Rake.application.add_import(fn)
end
end
end
extend FileUtilsExt
end
# Extend the main object with the DSL commands. This allows top-level
# calls to task, etc. to work from a Rakefile without polluting the
# object inheritance tree.
self.extend Rake::DSL
share/gems/gems/rake-13.1.0/lib/rake/loaders/makefile.rb 0000644 00000002542 15173517754 0016441 0 ustar 00 # frozen_string_literal: true
module Rake
# Makefile loader to be used with the import file loader. Use this to
# import dependencies from make dependency tools:
#
# require 'rake/loaders/makefile'
#
# file ".depends.mf" => [SRC_LIST] do |t|
# sh "makedepend -f- -- #{CFLAGS} -- #{t.prerequisites} > #{t.name}"
# end
#
# import ".depends.mf"
#
# See {Importing Dependencies}[link:doc/rakefile_rdoc.html#label-Importing+Dependencies]
# for further details.
class MakefileLoader
include Rake::DSL
SPACE_MARK = "\0" # :nodoc:
# Load the makefile dependencies in +fn+.
def load(fn) # :nodoc:
lines = File.read fn
lines.gsub!(/\\ /, SPACE_MARK)
lines.gsub!(/#[^\n]*\n/m, "")
lines.gsub!(/\\\n/, " ")
lines.each_line do |line|
process_line(line)
end
end
private
# Process one logical line of makefile data.
def process_line(line) # :nodoc:
file_tasks, args = line.split(":", 2)
return if args.nil?
dependents = args.split.map { |d| respace(d) }
file_tasks.scan(/\S+/) do |file_task|
file_task = respace(file_task)
file file_task => dependents
end
end
def respace(str) # :nodoc:
str.tr SPACE_MARK, " "
end
end
# Install the handler
Rake.application.add_loader("mf", MakefileLoader.new)
end
share/gems/gems/rake-13.1.0/lib/rake/testtask.rb 0000644 00000012303 15173517754 0015071 0 ustar 00 # frozen_string_literal: true
require "rake"
require "rake/tasklib"
module Rake
# Create a task that runs a set of tests.
#
# Example:
# require "rake/testtask"
#
# Rake::TestTask.new do |t|
# t.libs << "test"
# t.test_files = FileList['test/test*.rb']
# t.verbose = true
# end
#
# If rake is invoked with a "TEST=filename" command line option,
# then the list of test files will be overridden to include only the
# filename specified on the command line. This provides an easy way
# to run just one test.
#
# If rake is invoked with a "TESTOPTS=options" command line option,
# then the given options are passed to the test process after a
# '--'. This allows Test::Unit options to be passed to the test
# suite.
#
# Examples:
#
# rake test # run tests normally
# rake test TEST=just_one_file.rb # run just one test file.
# rake test TESTOPTS="-v" # run in verbose mode
# rake test TESTOPTS="--runner=fox" # use the fox test runner
#
class TestTask < TaskLib
# Name of test task. (default is :test)
attr_accessor :name
# List of directories added to $LOAD_PATH before running the
# tests. (default is 'lib')
attr_accessor :libs
# True if verbose test output desired. (default is false)
attr_accessor :verbose
# Test options passed to the test suite. An explicit
# TESTOPTS=opts on the command line will override this. (default
# is NONE)
attr_accessor :options
# Request that the tests be run with the warning flag set.
# E.g. warning=true implies "ruby -w" used to run the tests.
# (default is true)
attr_accessor :warning
# Glob pattern to match test files. (default is 'test/test*.rb')
attr_accessor :pattern
# Style of test loader to use. Options are:
#
# * :rake -- Rake provided test loading script (default).
# * :testrb -- Ruby provided test loading script.
# * :direct -- Load tests using command line loader.
#
attr_accessor :loader
# Array of command line options to pass to ruby when running test loader.
attr_accessor :ruby_opts
# Description of the test task. (default is 'Run tests')
attr_accessor :description
# Task prerequisites.
attr_accessor :deps
# Explicitly define the list of test files to be included in a
# test. +list+ is expected to be an array of file names (a
# FileList is acceptable). If both +pattern+ and +test_files+ are
# used, then the list of test files is the union of the two.
def test_files=(list)
@test_files = list
end
# Create a testing task.
def initialize(name=:test)
@name = name
@libs = ["lib"]
@pattern = nil
@options = nil
@test_files = nil
@verbose = false
@warning = true
@loader = :rake
@ruby_opts = []
@description = "Run tests" + (@name == :test ? "" : " for #{@name}")
@deps = []
if @name.is_a?(Hash)
@deps = @name.values.first
@name = @name.keys.first
end
yield self if block_given?
@pattern = "test/test*.rb" if @pattern.nil? && @test_files.nil?
define
end
# Create the tasks defined by this task lib.
def define
desc @description
task @name => Array(deps) do
FileUtilsExt.verbose(@verbose) do
puts "Use TESTOPTS=\"--verbose\" to pass --verbose" \
", etc. to runners." if ARGV.include? "--verbose"
args =
"#{ruby_opts_string} #{run_code} " +
"#{file_list_string} #{option_list}"
ruby args do |ok, status|
if !ok && status.respond_to?(:signaled?) && status.signaled?
raise SignalException.new(status.termsig)
elsif !ok
status = "Command failed with status (#{status.exitstatus})"
details = ": [ruby #{args}]"
message =
if Rake.application.options.trace or @verbose
status + details
else
status
end
fail message
end
end
end
end
self
end
def option_list # :nodoc:
(ENV["TESTOPTS"] ||
ENV["TESTOPT"] ||
ENV["TEST_OPTS"] ||
ENV["TEST_OPT"] ||
@options ||
"")
end
def ruby_opts_string # :nodoc:
opts = @ruby_opts.dup
opts.unshift("-I\"#{lib_path}\"") unless @libs.empty?
opts.unshift("-w") if @warning
opts.join(" ")
end
def lib_path # :nodoc:
@libs.join(File::PATH_SEPARATOR)
end
def file_list_string # :nodoc:
file_list.map { |fn| "\"#{fn}\"" }.join(" ")
end
def file_list # :nodoc:
if ENV["TEST"]
FileList[ENV["TEST"]]
else
result = []
result += @test_files.to_a if @test_files
result += FileList[@pattern].to_a if @pattern
result
end
end
def ruby_version # :nodoc:
RUBY_VERSION
end
def run_code # :nodoc:
case @loader
when :direct
"-e \"ARGV.each{|f| require f}\""
when :testrb
"-S testrb"
when :rake
"#{__dir__}/rake_test_loader.rb"
end
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/task_arguments.rb 0000644 00000004644 15173517754 0016267 0 ustar 00 # frozen_string_literal: true
module Rake
##
# TaskArguments manage the arguments passed to a task.
#
class TaskArguments
include Enumerable
# Argument names
attr_reader :names
# Create a TaskArgument object with a list of argument +names+ and a set
# of associated +values+. +parent+ is the parent argument object.
def initialize(names, values, parent=nil)
@names = names
@parent = parent
@hash = {}
@values = values
names.each_with_index { |name, i|
next if values[i].nil? || values[i] == ""
@hash[name.to_sym] = values[i]
}
end
# Retrieve the complete array of sequential values
def to_a
@values.dup
end
# Retrieve the list of values not associated with named arguments
def extras
@values[@names.length..-1] || []
end
# Create a new argument scope using the prerequisite argument
# names.
def new_scope(names)
values = names.map { |n| self[n] }
self.class.new(names, values + extras, self)
end
# Find an argument value by name or index.
def [](index)
lookup(index.to_sym)
end
# Specify a hash of default values for task arguments. Use the
# defaults only if there is no specific value for the given
# argument.
def with_defaults(defaults)
@hash = defaults.merge(@hash)
end
# Enumerates the arguments and their values
def each(&block)
@hash.each(&block)
end
# Extracts the argument values at +keys+
def values_at(*keys)
keys.map { |k| lookup(k) }
end
# Returns the value of the given argument via method_missing
def method_missing(sym, *args)
lookup(sym.to_sym)
end
# Returns a Hash of arguments and their values
def to_hash
@hash.dup
end
def to_s # :nodoc:
inspect
end
def inspect # :nodoc:
inspection = @hash.map do |k,v|
"#{k.to_s}: #{v.to_s}"
end.join(", ")
"#<#{self.class} #{inspection}>"
end
# Returns true if +key+ is one of the arguments
def has_key?(key)
@hash.has_key?(key)
end
alias key? has_key?
def fetch(*args, &block)
@hash.fetch(*args, &block)
end
protected
def lookup(name) # :nodoc:
if @hash.has_key?(name)
@hash[name]
elsif @parent
@parent.lookup(name)
end
end
end
EMPTY_TASK_ARGS = TaskArguments.new([], []) # :nodoc:
end
share/gems/gems/rake-13.1.0/lib/rake/multi_task.rb 0000644 00000000531 15173517754 0015403 0 ustar 00 # frozen_string_literal: true
module Rake
# Same as a regular task, but the immediate prerequisites are done in
# parallel using Ruby threads.
#
class MultiTask < Task
private
def invoke_prerequisites(task_args, invocation_chain) # :nodoc:
invoke_prerequisites_concurrently(task_args, invocation_chain)
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/invocation_exception_mixin.rb 0000644 00000000715 15173517754 0020666 0 ustar 00 # frozen_string_literal: true
module Rake
module InvocationExceptionMixin
# Return the invocation chain (list of Rake tasks) that were in
# effect when this exception was detected by rake. May be null if
# no tasks were active.
def chain
@rake_invocation_chain ||= nil
end
# Set the invocation chain in effect when this exception was
# detected.
def chain=(value)
@rake_invocation_chain = value
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/file_task.rb 0000644 00000003054 15173517754 0015173 0 ustar 00 # frozen_string_literal: true
require "rake/task"
require "rake/early_time"
module Rake
# A FileTask is a task that includes time based dependencies. If any of a
# FileTask's prerequisites have a timestamp that is later than the file
# represented by this task, then the file must be rebuilt (using the
# supplied actions).
#
class FileTask < Task
# Is this file task needed? Yes if it doesn't exist, or if its time stamp
# is out of date.
def needed?
begin
out_of_date?(File.mtime(name)) || @application.options.build_all
rescue Errno::ENOENT
true
end
end
# Time stamp for file task.
def timestamp
begin
File.mtime(name)
rescue Errno::ENOENT
Rake::LATE
end
end
private
# Are there any prerequisites with a later time than the given time stamp?
def out_of_date?(stamp)
all_prerequisite_tasks.any? { |prereq|
prereq_task = application[prereq, @scope]
if prereq_task.instance_of?(Rake::FileTask)
prereq_task.timestamp > stamp || @application.options.build_all
else
prereq_task.timestamp > stamp
end
}
end
# ----------------------------------------------------------------
# Task class methods.
#
class << self
# Apply the scope to the task name according to the rules for this kind
# of task. File based tasks ignore the scope when creating the name.
def scope_name(scope, task_name)
Rake.from_pathname(task_name)
end
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/ext/string.rb 0000644 00000013562 15173517754 0015345 0 ustar 00 # frozen_string_literal: true
require "rake/ext/core"
class String
rake_extension("ext") do
# Replace the file extension with +newext+. If there is no extension on
# the string, append the new extension to the end. If the new extension
# is not given, or is the empty string, remove any existing extension.
#
# +ext+ is a user added method for the String class.
#
# This String extension comes from Rake
def ext(newext="")
return self.dup if [".", ".."].include? self
if newext != ""
newext = "." + newext unless newext =~ /^\./
end
self.chomp(File.extname(self)) << newext
end
end
rake_extension("pathmap") do
# Explode a path into individual components. Used by +pathmap+.
#
# This String extension comes from Rake
def pathmap_explode
head, tail = File.split(self)
return [self] if head == self
return [tail] if head == "." || tail == "/"
return [head, tail] if head == "/"
return head.pathmap_explode + [tail]
end
protected :pathmap_explode
# Extract a partial path from the path. Include +n+ directories from the
# front end (left hand side) if +n+ is positive. Include |+n+|
# directories from the back end (right hand side) if +n+ is negative.
#
# This String extension comes from Rake
def pathmap_partial(n)
dirs = File.dirname(self).pathmap_explode
partial_dirs =
if n > 0
dirs[0...n]
elsif n < 0
dirs.reverse[0...-n].reverse
else
"."
end
File.join(partial_dirs)
end
protected :pathmap_partial
# Perform the pathmap replacement operations on the given path. The
# patterns take the form 'pat1,rep1;pat2,rep2...'.
#
# This String extension comes from Rake
def pathmap_replace(patterns, &block)
result = self
patterns.split(";").each do |pair|
pattern, replacement = pair.split(",")
pattern = Regexp.new(pattern)
if replacement == "*" && block_given?
result = result.sub(pattern, &block)
elsif replacement
result = result.sub(pattern, replacement)
else
result = result.sub(pattern, "")
end
end
result
end
protected :pathmap_replace
# Map the path according to the given specification. The specification
# controls the details of the mapping. The following special patterns are
# recognized:
#
# <tt>%p</tt> :: The complete path.
# <tt>%f</tt> :: The base file name of the path, with its file extension,
# but without any directories.
# <tt>%n</tt> :: The file name of the path without its file extension.
# <tt>%d</tt> :: The directory list of the path.
# <tt>%x</tt> :: The file extension of the path. An empty string if there
# is no extension.
# <tt>%X</tt> :: Everything *but* the file extension.
# <tt>%s</tt> :: The alternate file separator if defined, otherwise use #
# the standard file separator.
# <tt>%%</tt> :: A percent sign.
#
# The <tt>%d</tt> specifier can also have a numeric prefix (e.g. '%2d').
# If the number is positive, only return (up to) +n+ directories in the
# path, starting from the left hand side. If +n+ is negative, return (up
# to) +n+ directories from the right hand side of the path.
#
# Examples:
#
# 'a/b/c/d/file.txt'.pathmap("%2d") => 'a/b'
# 'a/b/c/d/file.txt'.pathmap("%-2d") => 'c/d'
#
# Also the <tt>%d</tt>, <tt>%p</tt>, <tt>%f</tt>, <tt>%n</tt>,
# <tt>%x</tt>, and <tt>%X</tt> operators can take a pattern/replacement
# argument to perform simple string substitutions on a particular part of
# the path. The pattern and replacement are separated by a comma and are
# enclosed by curly braces. The replacement spec comes after the %
# character but before the operator letter. (e.g. "%{old,new}d").
# Multiple replacement specs should be separated by semi-colons (e.g.
# "%{old,new;src,bin}d").
#
# Regular expressions may be used for the pattern, and back refs may be
# used in the replacement text. Curly braces, commas and semi-colons are
# excluded from both the pattern and replacement text (let's keep parsing
# reasonable).
#
# For example:
#
# "src/org/onestepback/proj/A.java".pathmap("%{^src,class}X.class")
#
# returns:
#
# "class/org/onestepback/proj/A.class"
#
# If the replacement text is '*', then a block may be provided to perform
# some arbitrary calculation for the replacement.
#
# For example:
#
# "/path/to/file.TXT".pathmap("%X%{.*,*}x") { |ext|
# ext.downcase
# }
#
# Returns:
#
# "/path/to/file.txt"
#
# This String extension comes from Rake
def pathmap(spec=nil, &block)
return self if spec.nil?
result = "".dup
spec.scan(/%\{[^}]*\}-?\d*[sdpfnxX%]|%-?\d+d|%.|[^%]+/) do |frag|
case frag
when "%f"
result << File.basename(self)
when "%n"
result << File.basename(self).ext
when "%d"
result << File.dirname(self)
when "%x"
result << File.extname(self)
when "%X"
result << self.ext
when "%p"
result << self
when "%s"
result << (File::ALT_SEPARATOR || File::SEPARATOR)
when "%-"
# do nothing
when "%%"
result << "%"
when /%(-?\d+)d/
result << pathmap_partial($1.to_i)
when /^%\{([^}]*)\}(\d*[dpfnxX])/
patterns, operator = $1, $2
result << pathmap("%" + operator).pathmap_replace(patterns, &block)
when /^%/
fail ArgumentError, "Unknown pathmap specifier #{frag} in '#{spec}'"
else
result << frag
end
end
result
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/ext/core.rb 0000644 00000001234 15173517754 0014760 0 ustar 00 # frozen_string_literal: true
class Module
# Check for an existing method in the current class before extending. If
# the method already exists, then a warning is printed and the extension is
# not added. Otherwise the block is yielded and any definitions in the
# block will take effect.
#
# Usage:
#
# class String
# rake_extension("xyz") do
# def xyz
# ...
# end
# end
# end
#
def rake_extension(method) # :nodoc:
if method_defined?(method)
$stderr.puts "WARNING: Possible conflict with Rake extension: " +
"#{self}##{method} already exists"
else
yield
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/file_creation_task.rb 0000644 00000001273 15173517754 0017060 0 ustar 00 # frozen_string_literal: true
require "rake/file_task"
require "rake/early_time"
module Rake
# A FileCreationTask is a file task that when used as a dependency will be
# needed if and only if the file has not been created. Once created, it is
# not re-triggered if any of its dependencies are newer, nor does trigger
# any rebuilds of tasks that depend on it whenever it is updated.
#
class FileCreationTask < FileTask
# Is this file task needed? Yes if it doesn't exist.
def needed?
!File.exist?(name)
end
# Time stamp for file creation task. This time stamp is earlier
# than any other time stamp.
def timestamp
Rake::EARLY
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/file_list.rb 0000644 00000030720 15173517754 0015204 0 ustar 00 # frozen_string_literal: true
require "rake/cloneable"
require "rake/file_utils_ext"
require "rake/ext/string"
module Rake
##
# A FileList is essentially an array with a few helper methods defined to
# make file manipulation a bit easier.
#
# FileLists are lazy. When given a list of glob patterns for possible files
# to be included in the file list, instead of searching the file structures
# to find the files, a FileList holds the pattern for latter use.
#
# This allows us to define a number of FileList to match any number of
# files, but only search out the actual files when then FileList itself is
# actually used. The key is that the first time an element of the
# FileList/Array is requested, the pending patterns are resolved into a real
# list of file names.
#
class FileList
include Cloneable
# == Method Delegation
#
# The lazy evaluation magic of FileLists happens by implementing all the
# array specific methods to call +resolve+ before delegating the heavy
# lifting to an embedded array object (@items).
#
# In addition, there are two kinds of delegation calls. The regular kind
# delegates to the @items array and returns the result directly. Well,
# almost directly. It checks if the returned value is the @items object
# itself, and if so will return the FileList object instead.
#
# The second kind of delegation call is used in methods that normally
# return a new Array object. We want to capture the return value of these
# methods and wrap them in a new FileList object. We enumerate these
# methods in the +SPECIAL_RETURN+ list below.
# List of array methods (that are not in +Object+) that need to be
# delegated.
ARRAY_METHODS = (Array.instance_methods - Object.instance_methods).map(&:to_s)
# List of additional methods that must be delegated.
MUST_DEFINE = %w[inspect <=>]
# List of methods that should not be delegated here (we define special
# versions of them explicitly below).
MUST_NOT_DEFINE = %w[to_a to_ary partition * <<]
# List of delegated methods that return new array values which need
# wrapping.
SPECIAL_RETURN = %w[
map collect sort sort_by select find_all reject grep
compact flatten uniq values_at
+ - & |
]
DELEGATING_METHODS = (ARRAY_METHODS + MUST_DEFINE - MUST_NOT_DEFINE).map(&:to_s).sort.uniq
# Now do the delegation.
DELEGATING_METHODS.each do |sym|
if SPECIAL_RETURN.include?(sym)
ln = __LINE__ + 1
class_eval %{
def #{sym}(*args, &block)
resolve
result = @items.send(:#{sym}, *args, &block)
self.class.new.import(result)
end
}, __FILE__, ln
else
ln = __LINE__ + 1
class_eval %{
def #{sym}(*args, &block)
resolve
result = @items.send(:#{sym}, *args, &block)
result.object_id == @items.object_id ? self : result
end
}, __FILE__, ln
end
end
GLOB_PATTERN = %r{[*?\[\{]}
# Create a file list from the globbable patterns given. If you wish to
# perform multiple includes or excludes at object build time, use the
# "yield self" pattern.
#
# Example:
# file_list = FileList.new('lib/**/*.rb', 'test/test*.rb')
#
# pkg_files = FileList.new('lib/**/*') do |fl|
# fl.exclude(/\bCVS\b/)
# end
#
def initialize(*patterns)
@pending_add = []
@pending = false
@exclude_patterns = DEFAULT_IGNORE_PATTERNS.dup
@exclude_procs = DEFAULT_IGNORE_PROCS.dup
@items = []
patterns.each { |pattern| include(pattern) }
yield self if block_given?
end
# Add file names defined by glob patterns to the file list. If an array
# is given, add each element of the array.
#
# Example:
# file_list.include("*.java", "*.cfg")
# file_list.include %w( math.c lib.h *.o )
#
def include(*filenames)
# TODO: check for pending
filenames.each do |fn|
if fn.respond_to? :to_ary
include(*fn.to_ary)
else
@pending_add << Rake.from_pathname(fn)
end
end
@pending = true
self
end
alias :add :include
# Register a list of file name patterns that should be excluded from the
# list. Patterns may be regular expressions, glob patterns or regular
# strings. In addition, a block given to exclude will remove entries that
# return true when given to the block.
#
# Note that glob patterns are expanded against the file system. If a file
# is explicitly added to a file list, but does not exist in the file
# system, then an glob pattern in the exclude list will not exclude the
# file.
#
# Examples:
# FileList['a.c', 'b.c'].exclude("a.c") => ['b.c']
# FileList['a.c', 'b.c'].exclude(/^a/) => ['b.c']
#
# If "a.c" is a file, then ...
# FileList['a.c', 'b.c'].exclude("a.*") => ['b.c']
#
# If "a.c" is not a file, then ...
# FileList['a.c', 'b.c'].exclude("a.*") => ['a.c', 'b.c']
#
def exclude(*patterns, &block)
patterns.each do |pat|
if pat.respond_to? :to_ary
exclude(*pat.to_ary)
else
@exclude_patterns << Rake.from_pathname(pat)
end
end
@exclude_procs << block if block_given?
resolve_exclude unless @pending
self
end
# Clear all the exclude patterns so that we exclude nothing.
def clear_exclude
@exclude_patterns = []
@exclude_procs = []
self
end
# A FileList is equal through array equality.
def ==(array)
to_ary == array
end
# Return the internal array object.
def to_a
resolve
@items
end
# Return the internal array object.
def to_ary
to_a
end
# Lie about our class.
def is_a?(klass)
klass == Array || super(klass)
end
alias kind_of? is_a?
# Redefine * to return either a string or a new file list.
def *(other)
result = @items * other
case result
when Array
self.class.new.import(result)
else
result
end
end
def <<(obj)
resolve
@items << Rake.from_pathname(obj)
self
end
# Resolve all the pending adds now.
def resolve
if @pending
@pending = false
@pending_add.each do |fn| resolve_add(fn) end
@pending_add = []
resolve_exclude
end
self
end
def resolve_add(fn) # :nodoc:
case fn
when GLOB_PATTERN
add_matching(fn)
else
self << fn
end
end
private :resolve_add
def resolve_exclude # :nodoc:
reject! { |fn| excluded_from_list?(fn) }
self
end
private :resolve_exclude
# Return a new FileList with the results of running +sub+ against each
# element of the original list.
#
# Example:
# FileList['a.c', 'b.c'].sub(/\.c$/, '.o') => ['a.o', 'b.o']
#
def sub(pat, rep)
inject(self.class.new) { |res, fn| res << fn.sub(pat, rep) }
end
# Return a new FileList with the results of running +gsub+ against each
# element of the original list.
#
# Example:
# FileList['lib/test/file', 'x/y'].gsub(/\//, "\\")
# => ['lib\\test\\file', 'x\\y']
#
def gsub(pat, rep)
inject(self.class.new) { |res, fn| res << fn.gsub(pat, rep) }
end
# Same as +sub+ except that the original file list is modified.
def sub!(pat, rep)
each_with_index { |fn, i| self[i] = fn.sub(pat, rep) }
self
end
# Same as +gsub+ except that the original file list is modified.
def gsub!(pat, rep)
each_with_index { |fn, i| self[i] = fn.gsub(pat, rep) }
self
end
# Apply the pathmap spec to each of the included file names, returning a
# new file list with the modified paths. (See String#pathmap for
# details.)
def pathmap(spec=nil, &block)
collect { |fn| fn.pathmap(spec, &block) }
end
# Return a new FileList with <tt>String#ext</tt> method applied to
# each member of the array.
#
# This method is a shortcut for:
#
# array.collect { |item| item.ext(newext) }
#
# +ext+ is a user added method for the Array class.
def ext(newext="")
collect { |fn| fn.ext(newext) }
end
# Grep each of the files in the filelist using the given pattern. If a
# block is given, call the block on each matching line, passing the file
# name, line number, and the matching line of text. If no block is given,
# a standard emacs style file:linenumber:line message will be printed to
# standard out. Returns the number of matched items.
def egrep(pattern, *options)
matched = 0
each do |fn|
begin
File.open(fn, "r", *options) do |inf|
count = 0
inf.each do |line|
count += 1
if pattern.match(line)
matched += 1
if block_given?
yield fn, count, line
else
puts "#{fn}:#{count}:#{line}"
end
end
end
end
rescue StandardError => ex
$stderr.puts "Error while processing '#{fn}': #{ex}"
end
end
matched
end
# Return a new file list that only contains file names from the current
# file list that exist on the file system.
def existing
select { |fn| File.exist?(fn) }.uniq
end
# Modify the current file list so that it contains only file name that
# exist on the file system.
def existing!
resolve
@items = @items.select { |fn| File.exist?(fn) }.uniq
self
end
# FileList version of partition. Needed because the nested arrays should
# be FileLists in this version.
def partition(&block) # :nodoc:
resolve
result = @items.partition(&block)
[
self.class.new.import(result[0]),
self.class.new.import(result[1]),
]
end
# Convert a FileList to a string by joining all elements with a space.
def to_s
resolve
self.join(" ")
end
# Add matching glob patterns.
def add_matching(pattern)
self.class.glob(pattern).each do |fn|
self << fn unless excluded_from_list?(fn)
end
end
private :add_matching
# Should the given file name be excluded from the list?
#
# NOTE: This method was formerly named "exclude?", but Rails
# introduced an exclude? method as an array method and setup a
# conflict with file list. We renamed the method to avoid
# confusion. If you were using "FileList#exclude?" in your user
# code, you will need to update.
def excluded_from_list?(fn)
return true if @exclude_patterns.any? do |pat|
case pat
when Regexp
fn =~ pat
when GLOB_PATTERN
flags = File::FNM_PATHNAME
# Ruby <= 1.9.3 does not support File::FNM_EXTGLOB
flags |= File::FNM_EXTGLOB if defined? File::FNM_EXTGLOB
File.fnmatch?(pat, fn, flags)
else
fn == pat
end
end
@exclude_procs.any? { |p| p.call(fn) }
end
DEFAULT_IGNORE_PATTERNS = [
/(^|[\/\\])CVS([\/\\]|$)/,
/(^|[\/\\])\.svn([\/\\]|$)/,
/\.bak$/,
/~$/
]
DEFAULT_IGNORE_PROCS = [
proc { |fn| fn =~ /(^|[\/\\])core$/ && !File.directory?(fn) }
]
def import(array) # :nodoc:
@items = array
self
end
class << self
# Create a new file list including the files listed. Similar to:
#
# FileList.new(*args)
def [](*args)
new(*args)
end
# Get a sorted list of files matching the pattern. This method
# should be preferred to Dir[pattern] and Dir.glob(pattern) because
# the files returned are guaranteed to be sorted.
def glob(pattern, *args)
Dir.glob(pattern, *args).sort
end
end
end
end
module Rake
class << self
# Yield each file or directory component.
def each_dir_parent(dir) # :nodoc:
old_length = nil
while dir != "." && dir.length != old_length
yield(dir)
old_length = dir.length
dir = File.dirname(dir)
end
end
# Convert Pathname and Pathname-like objects to strings;
# leave everything else alone
def from_pathname(path) # :nodoc:
path = path.to_path if path.respond_to?(:to_path)
path = path.to_str if path.respond_to?(:to_str)
path
end
end
end # module Rake
share/gems/gems/rake-13.1.0/lib/rake/rule_recursion_overflow_error.rb 0000644 00000000576 15173517754 0021434 0 ustar 00 # frozen_string_literal: true
module Rake
# Error indicating a recursion overflow error in task selection.
class RuleRecursionOverflowError < StandardError
def initialize(*args)
super
@targets = []
end
def add_target(target)
@targets << target
end
def message
super + ": [" + @targets.reverse.join(" => ") + "]"
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/tasklib.rb 0000644 00000000245 15173517754 0014662 0 ustar 00 # frozen_string_literal: true
require "rake"
module Rake
# Base class for Task Libraries.
class TaskLib
include Cloneable
include Rake::DSL
end
end
share/gems/gems/rake-13.1.0/lib/rake/file_utils.rb 0000644 00000007413 15173517754 0015374 0 ustar 00 # frozen_string_literal: true
require "rbconfig"
require "fileutils"
#--
# This a FileUtils extension that defines several additional commands to be
# added to the FileUtils utility functions.
module FileUtils
# Path to the currently running Ruby program
RUBY = ENV["RUBY"] || File.join(
RbConfig::CONFIG["bindir"],
RbConfig::CONFIG["ruby_install_name"] + RbConfig::CONFIG["EXEEXT"]).
sub(/.*\s.*/m, '"\&"')
# Run the system command +cmd+. If multiple arguments are given the command
# is run directly (without the shell, same semantics as Kernel::exec and
# Kernel::system).
#
# It is recommended you use the multiple argument form over interpolating
# user input for both usability and security reasons. With the multiple
# argument form you can easily process files with spaces or other shell
# reserved characters in them. With the multiple argument form your rake
# tasks are not vulnerable to users providing an argument like
# <code>; rm # -rf /</code>.
#
# If a block is given, upon command completion the block is called with an
# OK flag (true on a zero exit status) and a Process::Status object.
# Without a block a RuntimeError is raised when the command exits non-zero.
#
# Examples:
#
# sh 'ls -ltr'
#
# sh 'ls', 'file with spaces'
#
# # check exit status after command runs
# sh %{grep pattern file} do |ok, res|
# if !ok
# puts "pattern not found (status = #{res.exitstatus})"
# end
# end
#
def sh(*cmd, &block)
options = (Hash === cmd.last) ? cmd.pop : {}
shell_runner = block_given? ? block : create_shell_runner(cmd)
set_verbose_option(options)
verbose = options.delete :verbose
noop = options.delete(:noop) || Rake::FileUtilsExt.nowrite_flag
Rake.rake_output_message sh_show_command cmd if verbose
unless noop
res = (Hash === cmd.last) ? system(*cmd) : system(*cmd, options)
status = $?
status = Rake::PseudoStatus.new(1) if !res && status.nil?
shell_runner.call(res, status)
end
end
def create_shell_runner(cmd) # :nodoc:
show_command = sh_show_command cmd
lambda do |ok, status|
ok or
fail "Command failed with status (#{status.exitstatus}): " +
"[#{show_command}]"
end
end
private :create_shell_runner
def sh_show_command(cmd) # :nodoc:
cmd = cmd.dup
if Hash === cmd.first
env = cmd.first
env = env.map { |name, value| "#{name}=#{value}" }.join " "
cmd[0] = env
end
cmd.join " "
end
private :sh_show_command
def set_verbose_option(options) # :nodoc:
unless options.key? :verbose
options[:verbose] =
(Rake::FileUtilsExt.verbose_flag == Rake::FileUtilsExt::DEFAULT) ||
Rake::FileUtilsExt.verbose_flag
end
end
private :set_verbose_option
# Run a Ruby interpreter with the given arguments.
#
# Example:
# ruby %{-pe '$_.upcase!' <README}
#
def ruby(*args, **options, &block)
if args.length > 1
sh(RUBY, *args, **options, &block)
else
sh("#{RUBY} #{args.first}", **options, &block)
end
end
LN_SUPPORTED = [true]
# Attempt to do a normal file link, but fall back to a copy if the link
# fails.
def safe_ln(*args, **options)
if LN_SUPPORTED[0]
begin
return options.empty? ? ln(*args) : ln(*args, **options)
rescue StandardError, NotImplementedError
LN_SUPPORTED[0] = false
end
end
options.empty? ? cp(*args) : cp(*args, **options)
end
# Split a file path into individual directory names.
#
# Example:
# split_all("a/b/c") => ['a', 'b', 'c']
#
def split_all(path)
head, tail = File.split(path)
return [tail] if head == "." || tail == "/"
return [head, tail] if head == "/"
return split_all(head) + [tail]
end
end
share/gems/gems/rake-13.1.0/lib/rake/thread_history_display.rb 0000644 00000002204 15173517754 0020003 0 ustar 00 # frozen_string_literal: true
require "rake/private_reader"
module Rake
class ThreadHistoryDisplay # :nodoc: all
include Rake::PrivateReader
private_reader :stats, :items, :threads
def initialize(stats)
@stats = stats
@items = { _seq_: 1 }
@threads = { _seq_: "A" }
end
def show
puts "Job History:"
stats.each do |stat|
stat[:data] ||= {}
rename(stat, :thread, threads)
rename(stat[:data], :item_id, items)
rename(stat[:data], :new_thread, threads)
rename(stat[:data], :deleted_thread, threads)
printf("%8d %2s %-20s %s\n",
(stat[:time] * 1_000_000).round,
stat[:thread],
stat[:event],
stat[:data].map do |k, v| "#{k}:#{v}" end.join(" "))
end
end
private
def rename(hash, key, renames)
if hash && hash[key]
original = hash[key]
value = renames[original]
unless value
value = renames[:_seq_]
renames[:_seq_] = renames[:_seq_].succ
renames[original] = value
end
hash[key] = value
end
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/task_argument_error.rb 0000644 00000000225 15173517754 0017304 0 ustar 00 # frozen_string_literal: true
module Rake
# Error indicating an ill-formed task declaration.
class TaskArgumentError < ArgumentError
end
end
share/gems/gems/rake-13.1.0/lib/rake/late_time.rb 0000644 00000000447 15173517754 0015200 0 ustar 00 # frozen_string_literal: true
module Rake
# LateTime is a fake timestamp that occurs _after_ any other time value.
class LateTime
include Comparable
include Singleton
def <=>(other)
1
end
def to_s
"<LATE TIME>"
end
end
LATE = LateTime.instance
end
share/gems/gems/rake-13.1.0/lib/rake/backtrace.rb 0000644 00000001600 15173517754 0015144 0 ustar 00 # frozen_string_literal: true
module Rake
module Backtrace # :nodoc: all
SYS_KEYS = RbConfig::CONFIG.keys.grep(/(?:[a-z]prefix|libdir)\z/)
SYS_PATHS = RbConfig::CONFIG.values_at(*SYS_KEYS).uniq +
[ File.join(File.dirname(__FILE__), "..") ]
SUPPRESSED_PATHS = SYS_PATHS.
map { |s| s.tr("\\", "/") }.
map { |f| File.expand_path(f) }.
reject { |s| s.nil? || s =~ /^ *$/ }
SUPPRESSED_PATHS_RE = SUPPRESSED_PATHS.map { |f| Regexp.quote(f) }.join("|")
SUPPRESSED_PATHS_RE << "|^org\\/jruby\\/\\w+\\.java" if
Object.const_defined?(:RUBY_ENGINE) and RUBY_ENGINE == "jruby"
SUPPRESS_PATTERN = %r!(\A(#{SUPPRESSED_PATHS_RE})|bin/rake:\d+)!i
def self.collapse(backtrace)
pattern = Rake.application.options.suppress_backtrace_pattern ||
SUPPRESS_PATTERN
backtrace.reject { |elem| elem =~ pattern }
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/cpu_counter.rb 0000644 00000004515 15173517754 0015563 0 ustar 00 # frozen_string_literal: true
module Rake
# Based on a script at:
# http://stackoverflow.com/questions/891537/ruby-detect-number-of-cpus-installed
class CpuCounter # :nodoc: all
def self.count
new.count_with_default
end
def count_with_default(default=4)
count || default
rescue StandardError
default
end
begin
require "etc"
rescue LoadError
else
if Etc.respond_to?(:nprocessors)
def count
return Etc.nprocessors
end
end
end
end
end
unless Rake::CpuCounter.method_defined?(:count)
Rake::CpuCounter.class_eval <<-'end;', __FILE__, __LINE__+1
require 'rbconfig'
def count
if RUBY_PLATFORM == 'java'
count_via_java_runtime
else
case RbConfig::CONFIG['host_os']
when /linux/
count_via_cpuinfo
when /darwin|bsd/
count_via_sysctl
when /mswin|mingw/
count_via_win32
else
# Try everything
count_via_win32 ||
count_via_sysctl ||
count_via_cpuinfo
end
end
end
def count_via_java_runtime
Java::Java.lang.Runtime.getRuntime.availableProcessors
rescue StandardError
nil
end
def count_via_win32
require 'win32ole'
wmi = WIN32OLE.connect("winmgmts://")
cpu = wmi.ExecQuery("select NumberOfCores from Win32_Processor") # TODO count hyper-threaded in this
cpu.to_enum.first.NumberOfCores
rescue StandardError, LoadError
nil
end
def count_via_cpuinfo
open('/proc/cpuinfo') { |f| f.readlines }.grep(/processor/).size
rescue StandardError
nil
end
def count_via_sysctl
run 'sysctl', '-n', 'hw.ncpu'
end
def run(command, *args)
cmd = resolve_command(command)
if cmd
IO.popen [cmd, *args] do |io|
io.read.to_i
end
else
nil
end
end
def resolve_command(command)
look_for_command("/usr/sbin", command) ||
look_for_command("/sbin", command) ||
in_path_command(command)
end
def look_for_command(dir, command)
path = File.join(dir, command)
File.exist?(path) ? path : nil
end
def in_path_command(command)
IO.popen ['which', command] do |io|
io.eof? ? nil : command
end
end
end;
end
share/gems/gems/rake-13.1.0/lib/rake/linked_list.rb 0000644 00000005424 15173517754 0015536 0 ustar 00 # frozen_string_literal: true
module Rake
# Polylithic linked list structure used to implement several data
# structures in Rake.
class LinkedList
include Enumerable
attr_reader :head, :tail
# Polymorphically add a new element to the head of a list. The
# type of head node will be the same list type as the tail.
def conj(item)
self.class.cons(item, self)
end
# Is the list empty?
# .make guards against a list being empty making any instantiated LinkedList
# object not empty by default
# You should consider overriding this method if you implement your own .make method
def empty?
false
end
# Lists are structurally equivalent.
def ==(other)
current = self
while !current.empty? && !other.empty?
return false if current.head != other.head
current = current.tail
other = other.tail
end
current.empty? && other.empty?
end
# Convert to string: LL(item, item...)
def to_s
items = map(&:to_s).join(", ")
"LL(#{items})"
end
# Same as +to_s+, but with inspected items.
def inspect
items = map(&:inspect).join(", ")
"LL(#{items})"
end
# For each item in the list.
def each
current = self
while !current.empty?
yield(current.head)
current = current.tail
end
self
end
# Make a list out of the given arguments. This method is
# polymorphic
def self.make(*args)
# return an EmptyLinkedList if there are no arguments
return empty if !args || args.empty?
# build a LinkedList by starting at the tail and iterating
# through each argument
# inject takes an EmptyLinkedList to start
args.reverse.inject(empty) do |list, item|
list = cons(item, list)
list # return the newly created list for each item in the block
end
end
# Cons a new head onto the tail list.
def self.cons(head, tail)
new(head, tail)
end
# The standard empty list class for the given LinkedList class.
def self.empty
self::EMPTY
end
protected
def initialize(head, tail=EMPTY)
@head = head
@tail = tail
end
# Represent an empty list, using the Null Object Pattern.
#
# When inheriting from the LinkedList class, you should implement
# a type specific Empty class as well. Make sure you set the class
# instance variable @parent to the associated list class (this
# allows conj, cons and make to work polymorphically).
class EmptyLinkedList < LinkedList
@parent = LinkedList
def initialize
end
def empty?
true
end
def self.cons(head, tail)
@parent.cons(head, tail)
end
end
EMPTY = EmptyLinkedList.new
end
end
share/gems/gems/rake-13.1.0/lib/rake/version.rb 0000644 00000000320 15173517754 0014710 0 ustar 00 # frozen_string_literal: true
module Rake
VERSION = "13.1.0"
module Version # :nodoc: all
MAJOR, MINOR, BUILD, *OTHER = Rake::VERSION.split "."
NUMBERS = [MAJOR, MINOR, BUILD, *OTHER]
end
end
share/gems/gems/rake-13.1.0/lib/rake/trace_output.rb 0000644 00000001077 15173517754 0015753 0 ustar 00 # frozen_string_literal: true
module Rake
module TraceOutput # :nodoc: all
# Write trace output to output stream +out+.
#
# The write is done as a single IO call (to print) to lessen the
# chance that the trace output is interrupted by other tasks also
# producing output.
def trace_on(out, *strings)
sep = $\ || "\n"
if strings.empty?
output = sep
else
output = strings.map { |s|
next if s.nil?
s.end_with?(sep) ? s : s + sep
}.join
end
out.print(output)
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/phony.rb 0000644 00000000575 15173517754 0014374 0 ustar 00 # frozen_string_literal: true
# Defines a :phony task that you can use as a dependency. This allows
# file-based tasks to use non-file-based tasks as prerequisites
# without forcing them to rebuild.
#
# See FileTask#out_of_date? and Task#timestamp for more info.
require "rake"
task :phony
Rake::Task[:phony].tap do |task|
def task.timestamp # :nodoc:
Time.at 0
end
end
share/gems/gems/rake-13.1.0/lib/rake/rake_test_loader.rb 0000644 00000000735 15173517754 0016544 0 ustar 00 # frozen_string_literal: true
require "rake/file_list"
# Load the test files from the command line.
argv = ARGV.select do |argument|
case argument
when /^-/ then
argument
when /\*/ then
Rake::FileList[argument].to_a.each do |file|
require File.expand_path file
end
false
else
path = File.expand_path argument
abort "\nFile does not exist: #{path}\n\n" unless File.exist?(path)
require path
false
end
end
ARGV.replace argv
share/gems/gems/rake-13.1.0/lib/rake/file_utils_ext.rb 0000644 00000007532 15173517754 0016256 0 ustar 00 # frozen_string_literal: true
require "rake/file_utils"
module Rake
#
# FileUtilsExt provides a custom version of the FileUtils methods
# that respond to the <tt>verbose</tt> and <tt>nowrite</tt>
# commands.
#
module FileUtilsExt
include FileUtils
class << self
attr_accessor :verbose_flag, :nowrite_flag
end
DEFAULT = Object.new
FileUtilsExt.verbose_flag = DEFAULT
FileUtilsExt.nowrite_flag = false
FileUtils.commands.each do |name|
opts = FileUtils.options_of name
default_options = []
if opts.include?("verbose")
default_options << "verbose: FileUtilsExt.verbose_flag"
end
if opts.include?("noop")
default_options << "noop: FileUtilsExt.nowrite_flag"
end
next if default_options.empty?
module_eval(<<-EOS, __FILE__, __LINE__ + 1)
def #{name}(*args, **options, &block)
super(*args,
#{default_options.join(', ')},
**options, &block)
end
EOS
end
# Get/set the verbose flag controlling output from the FileUtils
# utilities. If verbose is true, then the utility method is
# echoed to standard output.
#
# Examples:
# verbose # return the current value of the
# # verbose flag
# verbose(v) # set the verbose flag to _v_.
# verbose(v) { code } # Execute code with the verbose flag set
# # temporarily to _v_. Return to the
# # original value when code is done.
def verbose(value=nil)
oldvalue = FileUtilsExt.verbose_flag
FileUtilsExt.verbose_flag = value unless value.nil?
if block_given?
begin
yield
ensure
FileUtilsExt.verbose_flag = oldvalue
end
end
FileUtilsExt.verbose_flag
end
# Get/set the nowrite flag controlling output from the FileUtils
# utilities. If verbose is true, then the utility method is
# echoed to standard output.
#
# Examples:
# nowrite # return the current value of the
# # nowrite flag
# nowrite(v) # set the nowrite flag to _v_.
# nowrite(v) { code } # Execute code with the nowrite flag set
# # temporarily to _v_. Return to the
# # original value when code is done.
def nowrite(value=nil)
oldvalue = FileUtilsExt.nowrite_flag
FileUtilsExt.nowrite_flag = value unless value.nil?
if block_given?
begin
yield
ensure
FileUtilsExt.nowrite_flag = oldvalue
end
end
oldvalue
end
# Use this function to prevent potentially destructive ruby code
# from running when the :nowrite flag is set.
#
# Example:
#
# when_writing("Building Project") do
# project.build
# end
#
# The following code will build the project under normal
# conditions. If the nowrite(true) flag is set, then the example
# will print:
#
# DRYRUN: Building Project
#
# instead of actually building the project.
#
def when_writing(msg=nil)
if FileUtilsExt.nowrite_flag
$stderr.puts "DRYRUN: #{msg}" if msg
else
yield
end
end
# Send the message to the default rake output (which is $stderr).
def rake_output_message(message)
$stderr.puts(message)
end
# Check that the options do not contain options not listed in
# +optdecl+. An ArgumentError exception is thrown if non-declared
# options are found.
def rake_check_options(options, *optdecl)
h = options.dup
optdecl.each do |name|
h.delete name
end
raise ArgumentError, "no such option: #{h.keys.join(' ')}" unless
h.empty?
end
extend self
end
end
share/gems/gems/rake-13.1.0/lib/rake/private_reader.rb 0000644 00000000612 15173517754 0016223 0 ustar 00 # frozen_string_literal: true
module Rake
# Include PrivateReader to use +private_reader+.
module PrivateReader # :nodoc: all
def self.included(base)
base.extend(ClassMethods)
end
module ClassMethods
# Declare a list of private accessors
def private_reader(*names)
attr_reader(*names)
private(*names)
end
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/default_loader.rb 0000644 00000000411 15173517754 0016176 0 ustar 00 # frozen_string_literal: true
module Rake
# Default Rakefile loader used by +import+.
class DefaultLoader
##
# Loads a rakefile into the current application from +fn+
def load(fn)
Rake.load_rakefile(File.expand_path(fn))
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/application.rb 0000644 00000063047 15173517754 0015545 0 ustar 00 # frozen_string_literal: true
require "optparse"
require "rake/task_manager"
require "rake/file_list"
require "rake/thread_pool"
require "rake/thread_history_display"
require "rake/trace_output"
require "rake/win32"
module Rake
CommandLineOptionError = Class.new(StandardError)
##
# Rake main application object. When invoking +rake+ from the
# command line, a Rake::Application object is created and run.
class Application
include TaskManager
include TraceOutput
# The name of the application (typically 'rake')
attr_reader :name
# The original directory where rake was invoked.
attr_reader :original_dir
# Name of the actual rakefile used.
attr_reader :rakefile
# Number of columns on the terminal
attr_accessor :terminal_columns
# List of the top level task names (task names from the command line).
attr_reader :top_level_tasks
# Override the detected TTY output state (mostly for testing)
attr_writer :tty_output
DEFAULT_RAKEFILES = [
"rakefile",
"Rakefile",
"rakefile.rb",
"Rakefile.rb"
].freeze
# Initialize a Rake::Application object.
def initialize
super
@name = "rake"
@rakefiles = DEFAULT_RAKEFILES.dup
@rakefile = nil
@pending_imports = []
@imported = []
@loaders = {}
@default_loader = Rake::DefaultLoader.new
@original_dir = Dir.pwd
@top_level_tasks = []
add_loader("rb", DefaultLoader.new)
add_loader("rf", DefaultLoader.new)
add_loader("rake", DefaultLoader.new)
@tty_output = STDOUT.tty?
@terminal_columns = ENV["RAKE_COLUMNS"].to_i
set_default_options
end
# Run the Rake application. The run method performs the following
# three steps:
#
# * Initialize the command line options (+init+).
# * Define the tasks (+load_rakefile+).
# * Run the top level tasks (+top_level+).
#
# If you wish to build a custom rake command, you should call
# +init+ on your application. Then define any tasks. Finally,
# call +top_level+ to run your top level tasks.
def run(argv = ARGV)
standard_exception_handling do
init "rake", argv
load_rakefile
top_level
end
end
# Initialize the command line parameters and app name.
def init(app_name="rake", argv = ARGV)
standard_exception_handling do
@name = app_name
begin
args = handle_options argv
rescue ArgumentError
# Backward compatibility for capistrano
args = handle_options
end
load_debug_at_stop_feature
collect_command_line_tasks(args)
end
end
def load_debug_at_stop_feature
return unless ENV["RAKE_DEBUG"]
require "debug/session"
DEBUGGER__::start no_sigint_hook: true, nonstop: true
Rake::Task.prepend Module.new {
def execute(*)
exception = DEBUGGER__::SESSION.capture_exception_frames(/(exe|bin|lib)\/rake/) do
super
end
if exception
STDERR.puts exception.message
DEBUGGER__::SESSION.enter_postmortem_session exception
raise exception
end
end
}
rescue LoadError
end
private :load_debug_at_stop_feature
# Find the rakefile and then load it and any pending imports.
def load_rakefile
standard_exception_handling do
raw_load_rakefile
end
end
# Run the top level tasks of a Rake application.
def top_level
run_with_threads do
if options.show_tasks
display_tasks_and_comments
elsif options.show_prereqs
display_prerequisites
else
top_level_tasks.each { |task_name| invoke_task(task_name) }
end
end
end
# Run the given block with the thread startup and shutdown.
def run_with_threads
thread_pool.gather_history if options.job_stats == :history
yield
thread_pool.join if defined?(@thread_pool)
if options.job_stats
stats = thread_pool.statistics
puts "Maximum active threads: #{stats[:max_active_threads]} + main"
puts "Total threads in play: #{stats[:total_threads_in_play]} + main"
end
ThreadHistoryDisplay.new(thread_pool.history).show if
options.job_stats == :history
end
# Add a loader to handle imported files ending in the extension
# +ext+.
def add_loader(ext, loader)
ext = ".#{ext}" unless ext =~ /^\./
@loaders[ext] = loader
end
# Application options from the command line
def options
@options ||= OpenStruct.new
end
# Return the thread pool used for multithreaded processing.
def thread_pool # :nodoc:
@thread_pool ||= ThreadPool.new(options.thread_pool_size || Rake.suggested_thread_count-1)
end
# internal ----------------------------------------------------------------
# Invokes a task with arguments that are extracted from +task_string+
def invoke_task(task_string) # :nodoc:
name, args = parse_task_string(task_string)
t = self[name]
t.invoke(*args)
end
def parse_task_string(string) # :nodoc:
/^([^\[]+)(?:\[(.*)\])$/ =~ string.to_s
name = $1
remaining_args = $2
return string, [] unless name
return name, [] if remaining_args.empty?
args = []
begin
/\s*((?:[^\\,]|\\.)*?)\s*(?:,\s*(.*))?$/ =~ remaining_args
remaining_args = $2
args << $1.gsub(/\\(.)/, '\1')
end while remaining_args
return name, args
end
# Provide standard exception handling for the given block.
def standard_exception_handling # :nodoc:
yield
rescue SystemExit
# Exit silently with current status
raise
rescue OptionParser::InvalidOption => ex
$stderr.puts ex.message
exit(false)
rescue Exception => ex
# Exit with error message
display_error_message(ex)
exit_because_of_exception(ex)
end
# Exit the program because of an unhandled exception.
# (may be overridden by subclasses)
def exit_because_of_exception(ex) # :nodoc:
exit(false)
end
# Display the error message that caused the exception.
def display_error_message(ex) # :nodoc:
trace "#{name} aborted!"
display_exception_details(ex)
trace "Tasks: #{ex.chain}" if has_chain?(ex)
trace "(See full trace by running task with --trace)" unless
options.backtrace
end
def display_exception_details(ex) # :nodoc:
display_exception_details_seen << ex
display_exception_message_details(ex)
display_exception_backtrace(ex)
display_cause_details(ex.cause) if has_cause?(ex)
end
def display_cause_details(ex) # :nodoc:
return if display_exception_details_seen.include? ex
trace "\nCaused by:"
display_exception_details(ex)
end
def display_exception_details_seen # :nodoc:
Thread.current[:rake_display_exception_details_seen] ||= []
end
def has_cause?(ex) # :nodoc:
ex.respond_to?(:cause) && ex.cause
end
def display_exception_message_details(ex) # :nodoc:
if ex.instance_of?(RuntimeError)
trace ex.message
elsif ex.respond_to?(:detailed_message)
trace "#{ex.class.name}: #{ex.detailed_message(highlight: false)}"
else
trace "#{ex.class.name}: #{ex.message}"
end
end
def display_exception_backtrace(ex) # :nodoc:
if options.backtrace
trace ex.backtrace.join("\n")
else
trace Backtrace.collapse(ex.backtrace).join("\n")
end
end
# Warn about deprecated usage.
#
# Example:
# Rake.application.deprecate("import", "Rake.import", caller.first)
#
def deprecate(old_usage, new_usage, call_site) # :nodoc:
unless options.ignore_deprecate
$stderr.puts "WARNING: '#{old_usage}' is deprecated. " +
"Please use '#{new_usage}' instead.\n" +
" at #{call_site}"
end
end
# Does the exception have a task invocation chain?
def has_chain?(exception) # :nodoc:
exception.respond_to?(:chain) && exception.chain
end
private :has_chain?
# True if one of the files in RAKEFILES is in the current directory.
# If a match is found, it is copied into @rakefile.
def have_rakefile # :nodoc:
@rakefiles.each do |fn|
if File.exist?(fn)
others = FileList.glob(fn, File::FNM_CASEFOLD)
return others.size == 1 ? others.first : fn
elsif fn == ""
return fn
end
end
return nil
end
# True if we are outputting to TTY, false otherwise
def tty_output? # :nodoc:
@tty_output
end
# We will truncate output if we are outputting to a TTY or if we've been
# given an explicit column width to honor
def truncate_output? # :nodoc:
tty_output? || @terminal_columns.nonzero?
end
# Display the tasks and comments.
def display_tasks_and_comments # :nodoc:
displayable_tasks = tasks.select { |t|
(options.show_all_tasks || t.comment) &&
t.name =~ options.show_task_pattern
}
case options.show_tasks
when :tasks
width = displayable_tasks.map { |t| t.name_with_args.length }.max || 10
if truncate_output?
max_column = terminal_width - name.size - width - 7
else
max_column = nil
end
displayable_tasks.each do |t|
printf("#{name} %-#{width}s # %s\n",
t.name_with_args,
max_column ? truncate(t.comment, max_column) : t.comment)
end
when :describe
displayable_tasks.each do |t|
puts "#{name} #{t.name_with_args}"
comment = t.full_comment || ""
comment.split("\n").each do |line|
puts " #{line}"
end
puts
end
when :lines
displayable_tasks.each do |t|
t.locations.each do |loc|
printf "#{name} %-30s %s\n", t.name_with_args, loc
end
end
else
fail "Unknown show task mode: '#{options.show_tasks}'"
end
end
def terminal_width # :nodoc:
if @terminal_columns.nonzero?
result = @terminal_columns
else
result = unix? ? dynamic_width : 80
end
(result < 10) ? 80 : result
rescue
80
end
# Calculate the dynamic width of the
def dynamic_width # :nodoc:
@dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
end
def dynamic_width_stty # :nodoc:
%x{stty size 2>/dev/null}.split[1].to_i
end
def dynamic_width_tput # :nodoc:
%x{tput cols 2>/dev/null}.to_i
end
def unix? # :nodoc:
RbConfig::CONFIG["host_os"] =~
/(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
end
def windows? # :nodoc:
Win32.windows?
end
def truncate(string, width) # :nodoc:
if string.nil?
""
elsif string.length <= width
string
else
(string[0, width - 3] || "") + "..."
end
end
# Display the tasks and prerequisites
def display_prerequisites # :nodoc:
tasks.each do |t|
puts "#{name} #{t.name}"
t.prerequisites.each { |pre| puts " #{pre}" }
end
end
def trace(*strings) # :nodoc:
options.trace_output ||= $stderr
trace_on(options.trace_output, *strings)
end
def sort_options(options) # :nodoc:
options.sort_by { |opt|
opt.select { |o| o.is_a?(String) && o =~ /^-/ }.map(&:downcase).sort.reverse
}
end
private :sort_options
# A list of all the standard options used in rake, suitable for
# passing to OptionParser.
def standard_rake_options # :nodoc:
sort_options(
[
["--all", "-A",
"Show all tasks, even uncommented ones (in combination with -T or -D)",
lambda { |value|
options.show_all_tasks = value
}
],
["--backtrace=[OUT]",
"Enable full backtrace. OUT can be stderr (default) or stdout.",
lambda { |value|
options.backtrace = true
select_trace_output(options, "backtrace", value)
}
],
["--build-all", "-B",
"Build all prerequisites, including those which are up-to-date.",
lambda { |value|
options.build_all = true
}
],
["--comments",
"Show commented tasks only",
lambda { |value|
options.show_all_tasks = !value
}
],
["--describe", "-D [PATTERN]",
"Describe the tasks (matching optional PATTERN), then exit.",
lambda { |value|
select_tasks_to_show(options, :describe, value)
}
],
["--directory", "-C [DIRECTORY]",
"Change to DIRECTORY before doing anything.",
lambda { |value|
Dir.chdir value
@original_dir = Dir.pwd
}
],
["--dry-run", "-n",
"Do a dry run without executing actions.",
lambda { |value|
Rake.verbose(true)
Rake.nowrite(true)
options.dryrun = true
options.trace = true
}
],
["--execute", "-e CODE",
"Execute some Ruby code and exit.",
lambda { |value|
eval(value)
exit
}
],
["--execute-print", "-p CODE",
"Execute some Ruby code, print the result, then exit.",
lambda { |value|
puts eval(value)
exit
}
],
["--execute-continue", "-E CODE",
"Execute some Ruby code, " +
"then continue with normal task processing.",
lambda { |value| eval(value) }
],
["--jobs", "-j [NUMBER]",
"Specifies the maximum number of tasks to execute in parallel. " +
"(default is number of CPU cores + 4)",
lambda { |value|
if value.nil? || value == ""
value = Float::INFINITY
elsif value =~ /^\d+$/
value = value.to_i
else
value = Rake.suggested_thread_count
end
value = 1 if value < 1
options.thread_pool_size = value - 1
}
],
["--job-stats [LEVEL]",
"Display job statistics. " +
"LEVEL=history displays a complete job list",
lambda { |value|
if value =~ /^history/i
options.job_stats = :history
else
options.job_stats = true
end
}
],
["--libdir", "-I LIBDIR",
"Include LIBDIR in the search path for required modules.",
lambda { |value| $:.push(value) }
],
["--multitask", "-m",
"Treat all tasks as multitasks.",
lambda { |value| options.always_multitask = true }
],
["--no-search", "--nosearch",
"-N", "Do not search parent directories for the Rakefile.",
lambda { |value| options.nosearch = true }
],
["--prereqs", "-P",
"Display the tasks and dependencies, then exit.",
lambda { |value| options.show_prereqs = true }
],
["--quiet", "-q",
"Do not log messages to standard output.",
lambda { |value| Rake.verbose(false) }
],
["--rakefile", "-f [FILENAME]",
"Use FILENAME as the rakefile to search for.",
lambda { |value|
value ||= ""
@rakefiles.clear
@rakefiles << value
}
],
["--rakelibdir", "--rakelib", "-R RAKELIBDIR",
"Auto-import any .rake files in RAKELIBDIR. " +
"(default is 'rakelib')",
lambda { |value|
options.rakelib = value.split(File::PATH_SEPARATOR)
}
],
["--require", "-r MODULE",
"Require MODULE before executing rakefile.",
lambda { |value|
begin
require value
rescue LoadError => ex
begin
rake_require value
rescue LoadError
raise ex
end
end
}
],
["--rules",
"Trace the rules resolution.",
lambda { |value| options.trace_rules = true }
],
["--silent", "-s",
"Like --quiet, but also suppresses the " +
"'in directory' announcement.",
lambda { |value|
Rake.verbose(false)
options.silent = true
}
],
["--suppress-backtrace PATTERN",
"Suppress backtrace lines matching regexp PATTERN. " +
"Ignored if --trace is on.",
lambda { |value|
options.suppress_backtrace_pattern = Regexp.new(value)
}
],
["--system", "-g",
"Using system wide (global) rakefiles " +
"(usually '~/.rake/*.rake').",
lambda { |value| options.load_system = true }
],
["--no-system", "--nosystem", "-G",
"Use standard project Rakefile search paths, " +
"ignore system wide rakefiles.",
lambda { |value| options.ignore_system = true }
],
["--tasks", "-T [PATTERN]",
"Display the tasks (matching optional PATTERN) " +
"with descriptions, then exit. " +
"-AT combination displays all the tasks, including those without descriptions.",
lambda { |value|
select_tasks_to_show(options, :tasks, value)
}
],
["--trace=[OUT]", "-t",
"Turn on invoke/execute tracing, enable full backtrace. " +
"OUT can be stderr (default) or stdout.",
lambda { |value|
options.trace = true
options.backtrace = true
select_trace_output(options, "trace", value)
Rake.verbose(true)
}
],
["--verbose", "-v",
"Log message to standard output.",
lambda { |value| Rake.verbose(true) }
],
["--version", "-V",
"Display the program version.",
lambda { |value|
puts "rake, version #{Rake::VERSION}"
exit
}
],
["--where", "-W [PATTERN]",
"Describe the tasks (matching optional PATTERN), then exit.",
lambda { |value|
select_tasks_to_show(options, :lines, value)
options.show_all_tasks = true
}
],
["--no-deprecation-warnings", "-X",
"Disable the deprecation warnings.",
lambda { |value|
options.ignore_deprecate = true
}
],
])
end
def select_tasks_to_show(options, show_tasks, value) # :nodoc:
options.show_tasks = show_tasks
options.show_task_pattern = Regexp.new(value || "")
Rake::TaskManager.record_task_metadata = true
end
private :select_tasks_to_show
def select_trace_output(options, trace_option, value) # :nodoc:
value = value.strip unless value.nil?
case value
when "stdout"
options.trace_output = $stdout
when "stderr", nil
options.trace_output = $stderr
else
fail CommandLineOptionError,
"Unrecognized --#{trace_option} option '#{value}'"
end
end
private :select_trace_output
# Read and handle the command line options. Returns the command line
# arguments that we didn't understand, which should (in theory) be just
# task names and env vars.
def handle_options(argv) # :nodoc:
set_default_options
OptionParser.new do |opts|
opts.banner = "#{Rake.application.name} [-f rakefile] {options} targets..."
opts.separator ""
opts.separator "Options are ..."
opts.on_tail("-h", "--help", "-H", "Display this help message.") do
puts opts
exit
end
standard_rake_options.each { |args| opts.on(*args) }
opts.environment("RAKEOPT")
end.parse(argv)
end
# Similar to the regular Ruby +require+ command, but will check
# for *.rake files in addition to *.rb files.
def rake_require(file_name, paths=$LOAD_PATH, loaded=$") # :nodoc:
fn = file_name + ".rake"
return false if loaded.include?(fn)
paths.each do |path|
full_path = File.join(path, fn)
if File.exist?(full_path)
Rake.load_rakefile(full_path)
loaded << fn
return true
end
end
fail LoadError, "Can't find #{file_name}"
end
def find_rakefile_location # :nodoc:
here = Dir.pwd
until (fn = have_rakefile)
Dir.chdir("..")
return nil if Dir.pwd == here || options.nosearch
here = Dir.pwd
end
[fn, here]
ensure
Dir.chdir(Rake.original_dir)
end
def print_rakefile_directory(location) # :nodoc:
$stderr.puts "(in #{Dir.pwd})" unless
options.silent or original_dir == location
end
def raw_load_rakefile # :nodoc:
rakefile, location = find_rakefile_location
if (!options.ignore_system) &&
(options.load_system || rakefile.nil?) &&
system_dir && File.directory?(system_dir)
print_rakefile_directory(location)
glob("#{system_dir}/*.rake") do |name|
add_import name
end
else
fail "No Rakefile found (looking for: #{@rakefiles.join(', ')})" if
rakefile.nil?
@rakefile = rakefile
Dir.chdir(location)
print_rakefile_directory(location)
Rake.load_rakefile(File.expand_path(@rakefile)) if
@rakefile && @rakefile != ""
options.rakelib.each do |rlib|
glob("#{rlib}/*.rake") do |name|
add_import name
end
end
end
load_imports
end
def glob(path, &block) # :nodoc:
FileList.glob(path.tr("\\", "/")).each(&block)
end
private :glob
# The directory path containing the system wide rakefiles.
def system_dir # :nodoc:
@system_dir ||=
begin
if ENV["RAKE_SYSTEM"]
ENV["RAKE_SYSTEM"]
else
standard_system_dir
end
end
end
# The standard directory containing system wide rake files.
if Win32.windows?
def standard_system_dir #:nodoc:
Win32.win32_system_dir
end
else
def standard_system_dir #:nodoc:
File.join(File.expand_path("~"), ".rake")
end
end
private :standard_system_dir
# Collect the list of tasks on the command line. If no tasks are
# given, return a list containing only the default task.
# Environmental assignments are processed at this time as well.
#
# `args` is the list of arguments to peruse to get the list of tasks.
# It should be the command line that was given to rake, less any
# recognised command-line options, which OptionParser.parse will
# have taken care of already.
def collect_command_line_tasks(args) # :nodoc:
@top_level_tasks = []
args.each do |arg|
if arg =~ /^(\w+)=(.*)$/m
ENV[$1] = $2
else
@top_level_tasks << arg unless arg =~ /^-/
end
end
@top_level_tasks.push(default_task_name) if @top_level_tasks.empty?
end
# Default task name ("default").
# (May be overridden by subclasses)
def default_task_name # :nodoc:
"default"
end
# Add a file to the list of files to be imported.
def add_import(fn) # :nodoc:
@pending_imports << fn
end
# Load the pending list of imported files.
def load_imports # :nodoc:
while fn = @pending_imports.shift
next if @imported.member?(fn)
fn_task = lookup(fn) and fn_task.invoke
ext = File.extname(fn)
loader = @loaders[ext] || @default_loader
loader.load(fn)
if fn_task = lookup(fn) and fn_task.needed?
fn_task.reenable
fn_task.invoke
loader.load(fn)
end
@imported << fn
end
end
def rakefile_location(backtrace=caller) # :nodoc:
backtrace.map { |t| t[/([^:]+):/, 1] }
re = /^#{@rakefile}$/
re = /#{re.source}/i if windows?
backtrace.find { |str| str =~ re } || ""
end
def set_default_options # :nodoc:
options.always_multitask = false
options.backtrace = false
options.build_all = false
options.dryrun = false
options.ignore_deprecate = false
options.ignore_system = false
options.job_stats = false
options.load_system = false
options.nosearch = false
options.rakelib = %w[rakelib]
options.show_all_tasks = false
options.show_prereqs = false
options.show_task_pattern = nil
options.show_tasks = nil
options.silent = false
options.suppress_backtrace_pattern = nil
options.thread_pool_size = Rake.suggested_thread_count
options.trace = false
options.trace_output = $stderr
options.trace_rules = false
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/task.rb 0000644 00000031371 15173517754 0014177 0 ustar 00 # frozen_string_literal: true
require "rake/invocation_exception_mixin"
module Rake
##
# A Task is the basic unit of work in a Rakefile. Tasks have associated
# actions (possibly more than one) and a list of prerequisites. When
# invoked, a task will first ensure that all of its prerequisites have an
# opportunity to run and then it will execute its own actions.
#
# Tasks are not usually created directly using the new method, but rather
# use the +file+ and +task+ convenience methods.
#
class Task
# List of prerequisites for a task.
attr_reader :prerequisites
alias prereqs prerequisites
# List of order only prerequisites for a task.
attr_reader :order_only_prerequisites
# List of actions attached to a task.
attr_reader :actions
# Application owning this task.
attr_accessor :application
# Array of nested namespaces names used for task lookup by this task.
attr_reader :scope
# File/Line locations of each of the task definitions for this
# task (only valid if the task was defined with the detect
# location option set).
attr_reader :locations
# Has this task already been invoked? Already invoked tasks
# will be skipped unless you reenable them.
attr_reader :already_invoked
# Return task name
def to_s
name
end
def inspect # :nodoc:
"<#{self.class} #{name} => [#{prerequisites.join(', ')}]>"
end
# List of sources for task.
attr_writer :sources
def sources
if defined?(@sources)
@sources
else
prerequisites
end
end
# List of prerequisite tasks
def prerequisite_tasks
(prerequisites + order_only_prerequisites).map { |pre| lookup_prerequisite(pre) }
end
def lookup_prerequisite(prerequisite_name) # :nodoc:
scoped_prerequisite_task = application[prerequisite_name, @scope]
if scoped_prerequisite_task == self
unscoped_prerequisite_task = application[prerequisite_name]
end
unscoped_prerequisite_task || scoped_prerequisite_task
end
private :lookup_prerequisite
# List of all unique prerequisite tasks including prerequisite tasks'
# prerequisites.
# Includes self when cyclic dependencies are found.
def all_prerequisite_tasks
seen = {}
collect_prerequisites(seen)
seen.values
end
def collect_prerequisites(seen) # :nodoc:
prerequisite_tasks.each do |pre|
next if seen[pre.name]
seen[pre.name] = pre
pre.collect_prerequisites(seen)
end
end
protected :collect_prerequisites
# First source from a rule (nil if no sources)
def source
sources.first
end
# Create a task named +task_name+ with no actions or prerequisites. Use
# +enhance+ to add actions and prerequisites.
def initialize(task_name, app)
@name = task_name.to_s
@prerequisites = []
@actions = []
@already_invoked = false
@comments = []
@lock = Monitor.new
@application = app
@scope = app.current_scope
@arg_names = nil
@locations = []
@invocation_exception = nil
@order_only_prerequisites = []
end
# Enhance a task with prerequisites or actions. Returns self.
def enhance(deps=nil, &block)
@prerequisites |= deps if deps
@actions << block if block_given?
self
end
# Name of the task, including any namespace qualifiers.
def name
@name.to_s
end
# Name of task with argument list description.
def name_with_args # :nodoc:
if arg_description
"#{name}#{arg_description}"
else
name
end
end
# Argument description (nil if none).
def arg_description # :nodoc:
@arg_names ? "[#{arg_names.join(',')}]" : nil
end
# Name of arguments for this task.
def arg_names
@arg_names || []
end
# Reenable the task, allowing its tasks to be executed if the task
# is invoked again.
def reenable
@already_invoked = false
@invocation_exception = nil
end
# Clear the existing prerequisites, actions, comments, and arguments of a rake task.
def clear
clear_prerequisites
clear_actions
clear_comments
clear_args
self
end
# Clear the existing prerequisites of a rake task.
def clear_prerequisites
prerequisites.clear
self
end
# Clear the existing actions on a rake task.
def clear_actions
actions.clear
self
end
# Clear the existing comments on a rake task.
def clear_comments
@comments = []
self
end
# Clear the existing arguments on a rake task.
def clear_args
@arg_names = nil
self
end
# Invoke the task if it is needed. Prerequisites are invoked first.
def invoke(*args)
task_args = TaskArguments.new(arg_names, args)
invoke_with_call_chain(task_args, InvocationChain::EMPTY)
end
# Same as invoke, but explicitly pass a call chain to detect
# circular dependencies.
#
# If multiple tasks depend on this
# one in parallel, they will all fail if the first execution of
# this task fails.
def invoke_with_call_chain(task_args, invocation_chain)
new_chain = Rake::InvocationChain.append(self, invocation_chain)
@lock.synchronize do
begin
if application.options.trace
application.trace "** Invoke #{name} #{format_trace_flags}"
end
if @already_invoked
if @invocation_exception
if application.options.trace
application.trace "** Previous invocation of #{name} failed #{format_trace_flags}"
end
raise @invocation_exception
else
return
end
end
@already_invoked = true
invoke_prerequisites(task_args, new_chain)
execute(task_args) if needed?
rescue Exception => ex
add_chain_to(ex, new_chain)
@invocation_exception = ex
raise ex
end
end
end
protected :invoke_with_call_chain
def add_chain_to(exception, new_chain) # :nodoc:
exception.extend(InvocationExceptionMixin) unless
exception.respond_to?(:chain)
exception.chain = new_chain if exception.chain.nil?
end
private :add_chain_to
# Invoke all the prerequisites of a task.
def invoke_prerequisites(task_args, invocation_chain) # :nodoc:
if application.options.always_multitask
invoke_prerequisites_concurrently(task_args, invocation_chain)
else
prerequisite_tasks.each { |p|
prereq_args = task_args.new_scope(p.arg_names)
p.invoke_with_call_chain(prereq_args, invocation_chain)
}
end
end
# Invoke all the prerequisites of a task in parallel.
def invoke_prerequisites_concurrently(task_args, invocation_chain)# :nodoc:
futures = prerequisite_tasks.map do |p|
prereq_args = task_args.new_scope(p.arg_names)
application.thread_pool.future(p) do |r|
r.invoke_with_call_chain(prereq_args, invocation_chain)
end
end
# Iterate in reverse to improve performance related to thread waiting and switching
futures.reverse_each(&:value)
end
# Format the trace flags for display.
def format_trace_flags
flags = []
flags << "first_time" unless @already_invoked
flags << "not_needed" unless needed?
flags.empty? ? "" : "(" + flags.join(", ") + ")"
end
private :format_trace_flags
# Execute the actions associated with this task.
def execute(args=nil)
args ||= EMPTY_TASK_ARGS
if application.options.dryrun
application.trace "** Execute (dry run) #{name}"
return
end
application.trace "** Execute #{name}" if application.options.trace
application.enhance_with_matching_rule(name) if @actions.empty?
if opts = Hash.try_convert(args) and !opts.empty?
@actions.each { |act| act.call(self, args, **opts) }
else
@actions.each { |act| act.call(self, args) }
end
end
# Is this task needed?
def needed?
true
end
# Timestamp for this task. Basic tasks return the current time for their
# time stamp. Other tasks can be more sophisticated.
def timestamp
Time.now
end
# Add a description to the task. The description can consist of an option
# argument list (enclosed brackets) and an optional comment.
def add_description(description)
return unless description
comment = description.strip
add_comment(comment) if comment && !comment.empty?
end
def comment=(comment) # :nodoc:
add_comment(comment)
end
def add_comment(comment) # :nodoc:
return if comment.nil?
@comments << comment unless @comments.include?(comment)
end
private :add_comment
# Full collection of comments. Multiple comments are separated by
# newlines.
def full_comment
transform_comments("\n")
end
# First line (or sentence) of all comments. Multiple comments are
# separated by a "/".
def comment
transform_comments(" / ") { |c| first_sentence(c) }
end
# Transform the list of comments as specified by the block and
# join with the separator.
def transform_comments(separator, &block)
if @comments.empty?
nil
else
block ||= lambda { |c| c }
@comments.map(&block).join(separator)
end
end
private :transform_comments
# Get the first sentence in a string. The sentence is terminated
# by the first period, exclamation mark, or the end of the line.
# Decimal points do not count as periods.
def first_sentence(string)
string.split(/(?<=\w)(\.|!)[ \t]|(\.$|!)|\n/).first
end
private :first_sentence
# Set the names of the arguments for this task. +args+ should be
# an array of symbols, one for each argument name.
def set_arg_names(args)
@arg_names = args.map(&:to_sym)
end
# Return a string describing the internal state of a task. Useful for
# debugging.
def investigation
result = "------------------------------\n".dup
result << "Investigating #{name}\n"
result << "class: #{self.class}\n"
result << "task needed: #{needed?}\n"
result << "timestamp: #{timestamp}\n"
result << "pre-requisites: \n"
prereqs = prerequisite_tasks
prereqs.sort! { |a, b| a.timestamp <=> b.timestamp }
prereqs.each do |p|
result << "--#{p.name} (#{p.timestamp})\n"
end
latest_prereq = prerequisite_tasks.map(&:timestamp).max
result << "latest-prerequisite time: #{latest_prereq}\n"
result << "................................\n\n"
return result
end
# Format dependencies parameter to pass to task.
def self.format_deps(deps)
deps = [deps] unless deps.respond_to?(:to_ary)
deps.map { |d| Rake.from_pathname(d).to_s }
end
# Add order only dependencies.
def |(deps)
@order_only_prerequisites |= Task.format_deps(deps) - @prerequisites
self
end
# ----------------------------------------------------------------
# Rake Module Methods
#
class << self
# Clear the task list. This cause rake to immediately forget all the
# tasks that have been assigned. (Normally used in the unit tests.)
def clear
Rake.application.clear
end
# List of all defined tasks.
def tasks
Rake.application.tasks
end
# Return a task with the given name. If the task is not currently
# known, try to synthesize one from the defined rules. If no rules are
# found, but an existing file matches the task name, assume it is a file
# task with no dependencies or actions.
def [](task_name)
Rake.application[task_name]
end
# TRUE if the task name is already defined.
def task_defined?(task_name)
Rake.application.lookup(task_name) != nil
end
# Define a task given +args+ and an option block. If a rule with the
# given name already exists, the prerequisites and actions are added to
# the existing task. Returns the defined task.
def define_task(*args, &block)
Rake.application.define_task(self, *args, &block)
end
# Define a rule for synthesizing tasks.
def create_rule(*args, &block)
Rake.application.create_rule(*args, &block)
end
# Apply the scope to the task name according to the rules for
# this kind of task. Generic tasks will accept the scope as
# part of the name.
def scope_name(scope, task_name)
scope.path_with_task_name(task_name)
end
end # class << Rake::Task
end # class Rake::Task
end
share/gems/gems/rake-13.1.0/lib/rake/win32.rb 0000644 00000003020 15173517754 0014165 0 ustar 00 # frozen_string_literal: true
require "rbconfig"
module Rake
# Win 32 interface methods for Rake. Windows specific functionality
# will be placed here to collect that knowledge in one spot.
module Win32 # :nodoc: all
# Error indicating a problem in locating the home directory on a
# Win32 system.
class Win32HomeError < RuntimeError
end
class << self
# True if running on a windows system.
def windows?
RbConfig::CONFIG["host_os"] =~ %r!(msdos|mswin|djgpp|mingw|[Ww]indows)!
end
# The standard directory containing system wide rake files on
# Win 32 systems. Try the following environment variables (in
# order):
#
# * HOME
# * HOMEDRIVE + HOMEPATH
# * APPDATA
# * USERPROFILE
#
# If the above are not defined, the return nil.
def win32_system_dir #:nodoc:
win32_shared_path = ENV["HOME"]
if win32_shared_path.nil? && ENV["HOMEDRIVE"] && ENV["HOMEPATH"]
win32_shared_path = ENV["HOMEDRIVE"] + ENV["HOMEPATH"]
end
win32_shared_path ||= ENV["APPDATA"]
win32_shared_path ||= ENV["USERPROFILE"]
raise Win32HomeError,
"Unable to determine home path environment variable." if
win32_shared_path.nil? or win32_shared_path.empty?
normalize(File.join(win32_shared_path, "Rake"))
end
# Normalize a win32 path so that the slashes are all forward slashes.
def normalize(path)
path.gsub(/\\/, "/")
end
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/packagetask.rb 0000644 00000014022 15173517754 0015505 0 ustar 00 # frozen_string_literal: true
# Define a package task library to aid in the definition of
# redistributable package files.
require "rake"
require "rake/tasklib"
module Rake
# Create a packaging task that will package the project into
# distributable files (e.g zip archive or tar files).
#
# The PackageTask will create the following targets:
#
# +:package+ ::
# Create all the requested package files.
#
# +:clobber_package+ ::
# Delete all the package files. This target is automatically
# added to the main clobber target.
#
# +:repackage+ ::
# Rebuild the package files from scratch, even if they are not out
# of date.
#
# <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tgz"</tt> ::
# Create a gzipped tar package (if <em>need_tar</em> is true).
#
# <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.gz"</tt> ::
# Create a gzipped tar package (if <em>need_tar_gz</em> is true).
#
# <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.tar.bz2"</tt> ::
# Create a bzip2'd tar package (if <em>need_tar_bz2</em> is true).
#
# <tt>"<em>package_dir</em>/<em>name</em>-<em>version</em>.zip"</tt> ::
# Create a zip package archive (if <em>need_zip</em> is true).
#
# Example:
#
# Rake::PackageTask.new("rake", "1.2.3") do |p|
# p.need_tar = true
# p.package_files.include("lib/**/*.rb")
# end
#
class PackageTask < TaskLib
# Name of the package (from the GEM Spec).
attr_accessor :name
# Version of the package (e.g. '1.3.2').
attr_accessor :version
# Directory used to store the package files (default is 'pkg').
attr_accessor :package_dir
# True if a gzipped tar file (tgz) should be produced (default is
# false).
attr_accessor :need_tar
# True if a gzipped tar file (tar.gz) should be produced (default
# is false).
attr_accessor :need_tar_gz
# True if a bzip2'd tar file (tar.bz2) should be produced (default
# is false).
attr_accessor :need_tar_bz2
# True if a xz'd tar file (tar.xz) should be produced (default is false)
attr_accessor :need_tar_xz
# True if a zip file should be produced (default is false)
attr_accessor :need_zip
# List of files to be included in the package.
attr_accessor :package_files
# Tar command for gzipped or bzip2ed archives. The default is 'tar'.
attr_accessor :tar_command
# Zip command for zipped archives. The default is 'zip'.
attr_accessor :zip_command
# True if parent directory should be omitted (default is false)
attr_accessor :without_parent_dir
# Create a Package Task with the given name and version. Use +:noversion+
# as the version to build a package without a version or to provide a
# fully-versioned package name.
def initialize(name=nil, version=nil)
init(name, version)
yield self if block_given?
define unless name.nil?
end
# Initialization that bypasses the "yield self" and "define" step.
def init(name, version)
@name = name
@version = version
@package_files = Rake::FileList.new
@package_dir = "pkg"
@need_tar = false
@need_tar_gz = false
@need_tar_bz2 = false
@need_tar_xz = false
@need_zip = false
@tar_command = "tar"
@zip_command = "zip"
@without_parent_dir = false
end
# Create the tasks defined by this task library.
def define
fail "Version required (or :noversion)" if @version.nil?
@version = nil if :noversion == @version
desc "Build all the packages"
task :package
desc "Force a rebuild of the package files"
task repackage: [:clobber_package, :package]
desc "Remove package products"
task :clobber_package do
rm_r package_dir rescue nil
end
task clobber: [:clobber_package]
[
[need_tar, tgz_file, "z"],
[need_tar_gz, tar_gz_file, "z"],
[need_tar_bz2, tar_bz2_file, "j"],
[need_tar_xz, tar_xz_file, "J"]
].each do |need, file, flag|
if need
task package: ["#{package_dir}/#{file}"]
file "#{package_dir}/#{file}" =>
[package_dir_path] + package_files do
chdir(working_dir) { sh @tar_command, "#{flag}cvf", file, target_dir }
mv "#{package_dir_path}/#{target_dir}", package_dir if without_parent_dir
end
end
end
if need_zip
task package: ["#{package_dir}/#{zip_file}"]
file "#{package_dir}/#{zip_file}" =>
[package_dir_path] + package_files do
chdir(working_dir) { sh @zip_command, "-r", zip_file, target_dir }
mv "#{package_dir_path}/#{zip_file}", package_dir if without_parent_dir
end
end
directory package_dir_path => @package_files do
@package_files.each do |fn|
f = File.join(package_dir_path, fn)
fdir = File.dirname(f)
mkdir_p(fdir) unless File.exist?(fdir)
if File.directory?(fn)
mkdir_p(f)
else
rm_f f
safe_ln(fn, f)
end
end
end
self
end
# The name of this package
def package_name
@version ? "#{@name}-#{@version}" : @name
end
# The directory this package will be built in
def package_dir_path
"#{package_dir}/#{package_name}"
end
# The package name with .tgz added
def tgz_file
"#{package_name}.tgz"
end
# The package name with .tar.gz added
def tar_gz_file
"#{package_name}.tar.gz"
end
# The package name with .tar.bz2 added
def tar_bz2_file
"#{package_name}.tar.bz2"
end
# The package name with .tar.xz added
def tar_xz_file
"#{package_name}.tar.xz"
end
# The package name with .zip added
def zip_file
"#{package_name}.zip"
end
def working_dir
without_parent_dir ? package_dir_path : package_dir
end
# target directory relative to working_dir
def target_dir
without_parent_dir ? "." : package_name
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/rake_module.rb 0000644 00000002770 15173517754 0015525 0 ustar 00 # frozen_string_literal: true
require "rake/application"
module Rake
class << self
# Current Rake Application
def application
@application ||= Rake::Application.new
end
# Set the current Rake application object.
def application=(app)
@application = app
end
def suggested_thread_count # :nodoc:
@cpu_count ||= Rake::CpuCounter.count
@cpu_count + 4
end
# Return the original directory where the Rake application was started.
def original_dir
application.original_dir
end
# Load a rakefile.
def load_rakefile(path)
load(path)
end
# Add files to the rakelib list
def add_rakelib(*files)
application.options.rakelib ||= []
application.options.rakelib.concat(files)
end
# Make +block_application+ the default rake application inside a block so
# you can load rakefiles into a different application.
#
# This is useful when you want to run rake tasks inside a library without
# running rake in a sub-shell.
#
# Example:
#
# Dir.chdir 'other/directory'
#
# other_rake = Rake.with_application do |rake|
# rake.load_rakefile
# end
#
# puts other_rake.tasks
def with_application(block_application = Rake::Application.new)
orig_application = Rake.application
Rake.application = block_application
yield block_application
block_application
ensure
Rake.application = orig_application
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/promise.rb 0000644 00000004437 15173517754 0014716 0 ustar 00 # frozen_string_literal: true
module Rake
# A Promise object represents a promise to do work (a chore) in the
# future. The promise is created with a block and a list of
# arguments for the block. Calling value will return the value of
# the promised chore.
#
# Used by ThreadPool.
#
class Promise # :nodoc: all
NOT_SET = Object.new.freeze # :nodoc:
attr_accessor :recorder
# Create a promise to do the chore specified by the block.
def initialize(args, &block)
@mutex = Mutex.new
@result = NOT_SET
@error = NOT_SET
@args = args
@block = block
end
# Return the value of this promise.
#
# If the promised chore is not yet complete, then do the work
# synchronously. We will wait.
def value
unless complete?
stat :sleeping_on, item_id: object_id
@mutex.synchronize do
stat :has_lock_on, item_id: object_id
chore
stat :releasing_lock_on, item_id: object_id
end
end
error? ? raise(@error) : @result
end
# If no one else is working this promise, go ahead and do the chore.
def work
stat :attempting_lock_on, item_id: object_id
if @mutex.try_lock
stat :has_lock_on, item_id: object_id
chore
stat :releasing_lock_on, item_id: object_id
@mutex.unlock
else
stat :bailed_on, item_id: object_id
end
end
private
# Perform the chore promised
def chore
if complete?
stat :found_completed, item_id: object_id
return
end
stat :will_execute, item_id: object_id
begin
@result = @block.call(*@args)
rescue Exception => e
@error = e
end
stat :did_execute, item_id: object_id
discard
end
# Do we have a result for the promise
def result?
!@result.equal?(NOT_SET)
end
# Did the promise throw an error
def error?
!@error.equal?(NOT_SET)
end
# Are we done with the promise
def complete?
result? || error?
end
# free up these items for the GC
def discard
@args = nil
@block = nil
end
# Record execution statistics if there is a recorder
def stat(*args)
@recorder.call(*args) if @recorder
end
end
end
share/gems/gems/rake-13.1.0/lib/rake/clean.rb 0000644 00000004035 15173517754 0014314 0 ustar 00 # frozen_string_literal: true
# The 'rake/clean' file defines two file lists (CLEAN and CLOBBER) and
# two rake tasks (:clean and :clobber).
#
# [:clean] Clean up the project by deleting scratch files and backup
# files. Add files to the CLEAN file list to have the :clean
# target handle them.
#
# [:clobber] Clobber all generated and non-source files in a project.
# The task depends on :clean, so all the clean files will
# be deleted as well as files in the CLOBBER file list.
# The intent of this task is to return a project to its
# pristine, just unpacked state.
require "rake"
# :stopdoc:
module Rake
module Cleaner
extend FileUtils
module_function
def cleanup_files(file_names)
file_names.each do |file_name|
cleanup(file_name)
end
end
def cleanup(file_name, **opts)
begin
opts = { verbose: Rake.application.options.trace }.merge(opts)
rm_r file_name, **opts
rescue StandardError => ex
puts "Failed to remove #{file_name}: #{ex}" unless file_already_gone?(file_name)
end
end
def file_already_gone?(file_name)
return false if File.exist?(file_name)
path = file_name
prev = nil
while path = File.dirname(path)
return false if cant_be_deleted?(path)
break if [prev, "."].include?(path)
prev = path
end
true
end
private_class_method :file_already_gone?
def cant_be_deleted?(path_name)
File.exist?(path_name) &&
(!File.readable?(path_name) || !File.executable?(path_name))
end
private_class_method :cant_be_deleted?
end
end
CLEAN = ::Rake::FileList["**/*~", "**/*.bak", "**/core"]
CLEAN.clear_exclude.exclude { |fn|
fn.pathmap("%f").downcase == "core" && File.directory?(fn)
}
desc "Remove any temporary products."
task :clean do
Rake::Cleaner.cleanup_files(CLEAN)
end
CLOBBER = ::Rake::FileList.new
desc "Remove any generated files."
task clobber: [:clean] do
Rake::Cleaner.cleanup_files(CLOBBER)
end
share/gems/gems/rake-13.1.0/lib/rake/early_time.rb 0000644 00000000562 15173517754 0015365 0 ustar 00 # frozen_string_literal: true
module Rake
# EarlyTime is a fake timestamp that occurs _before_ any other time value.
class EarlyTime
include Comparable
include Singleton
##
# The EarlyTime always comes before +other+!
def <=>(other)
-1
end
def to_s # :nodoc:
"<EARLY TIME>"
end
end
EARLY = EarlyTime.instance
end
share/gems/gems/rake-13.1.0/lib/rake/invocation_chain.rb 0000644 00000002276 15173517754 0016552 0 ustar 00 # frozen_string_literal: true
module Rake
# InvocationChain tracks the chain of task invocations to detect
# circular dependencies.
class InvocationChain < LinkedList
# Is the invocation already in the chain?
def member?(invocation)
head == invocation || tail.member?(invocation)
end
# Append an invocation to the chain of invocations. It is an error
# if the invocation already listed.
def append(invocation)
if member?(invocation)
fail RuntimeError, "Circular dependency detected: #{to_s} => #{invocation}"
end
conj(invocation)
end
# Convert to string, ie: TOP => invocation => invocation
def to_s
"#{prefix}#{head}"
end
# Class level append.
def self.append(invocation, chain)
chain.append(invocation)
end
private
def prefix
"#{tail} => "
end
# Null object for an empty chain.
class EmptyInvocationChain < LinkedList::EmptyLinkedList
@parent = InvocationChain
def member?(obj)
false
end
def append(invocation)
conj(invocation)
end
def to_s
"TOP"
end
end
EMPTY = EmptyInvocationChain.new
end
end
share/gems/gems/rake-13.1.0/lib/rake/task_manager.rb 0000644 00000024031 15173517754 0015664 0 ustar 00 # frozen_string_literal: true
module Rake
# The TaskManager module is a mixin for managing tasks.
module TaskManager
# Track the last comment made in the Rakefile.
attr_accessor :last_description
def initialize # :nodoc:
super
@tasks = Hash.new
@rules = Array.new
@scope = Scope.make
@last_description = nil
end
def create_rule(*args, &block) # :nodoc:
pattern, args, deps, order_only = resolve_args(args)
pattern = Regexp.new(Regexp.quote(pattern) + "$") if String === pattern
@rules << [pattern, args, deps, order_only, block]
end
def define_task(task_class, *args, &block) # :nodoc:
task_name, arg_names, deps, order_only = resolve_args(args)
original_scope = @scope
if String === task_name and
not task_class.ancestors.include? Rake::FileTask
task_name, *definition_scope = *(task_name.split(":").reverse)
@scope = Scope.make(*(definition_scope + @scope.to_a))
end
task_name = task_class.scope_name(@scope, task_name)
task = intern(task_class, task_name)
task.set_arg_names(arg_names) unless arg_names.empty?
if Rake::TaskManager.record_task_metadata
add_location(task)
task.add_description(get_description(task))
end
task.enhance(Task.format_deps(deps), &block)
task | order_only unless order_only.nil?
task
ensure
@scope = original_scope
end
# Lookup a task. Return an existing task if found, otherwise
# create a task of the current type.
def intern(task_class, task_name)
@tasks[task_name.to_s] ||= task_class.new(task_name, self)
end
# Find a matching task for +task_name+.
def [](task_name, scopes=nil)
task_name = task_name.to_s
self.lookup(task_name, scopes) or
enhance_with_matching_rule(task_name) or
synthesize_file_task(task_name) or
fail generate_message_for_undefined_task(task_name)
end
def generate_message_for_undefined_task(task_name)
message = "Don't know how to build task '#{task_name}' "\
"(See the list of available tasks with `#{Rake.application.name} --tasks`)"
message + generate_did_you_mean_suggestions(task_name)
end
def generate_did_you_mean_suggestions(task_name)
return "" unless defined?(::DidYouMean::SpellChecker)
suggestions = ::DidYouMean::SpellChecker.new(dictionary: @tasks.keys).correct(task_name.to_s)
if ::DidYouMean.respond_to?(:formatter)# did_you_mean v1.2.0 or later
::DidYouMean.formatter.message_for(suggestions)
elsif defined?(::DidYouMean::Formatter) # before did_you_mean v1.2.0
::DidYouMean::Formatter.new(suggestions).to_s
else
""
end
end
def synthesize_file_task(task_name) # :nodoc:
return nil unless File.exist?(task_name)
define_task(Rake::FileTask, task_name)
end
# Resolve the arguments for a task/rule. Returns a tuple of
# [task_name, arg_name_list, prerequisites, order_only_prerequisites].
def resolve_args(args)
if args.last.is_a?(Hash)
deps = args.pop
resolve_args_with_dependencies(args, deps)
else
resolve_args_without_dependencies(args)
end
end
# Resolve task arguments for a task or rule when there are no
# dependencies declared.
#
# The patterns recognized by this argument resolving function are:
#
# task :t
# task :t, [:a]
#
def resolve_args_without_dependencies(args)
task_name = args.shift
if args.size == 1 && args.first.respond_to?(:to_ary)
arg_names = args.first.to_ary
else
arg_names = args
end
[task_name, arg_names, [], nil]
end
private :resolve_args_without_dependencies
# Resolve task arguments for a task or rule when there are
# dependencies declared.
#
# The patterns recognized by this argument resolving function are:
#
# task :t, order_only: [:e]
# task :t => [:d]
# task :t => [:d], order_only: [:e]
# task :t, [a] => [:d]
# task :t, [a] => [:d], order_only: [:e]
#
def resolve_args_with_dependencies(args, hash) # :nodoc:
fail "Task Argument Error" if
hash.size != 1 &&
(hash.size != 2 || !hash.key?(:order_only))
order_only = hash.delete(:order_only)
key, value = hash.map { |k, v| [k, v] }.first
if args.empty?
task_name = key
arg_names = []
deps = value || []
else
task_name = args.shift
arg_names = key || args.shift|| []
deps = value || []
end
deps = [deps] unless deps.respond_to?(:to_ary)
[task_name, arg_names, deps, order_only]
end
private :resolve_args_with_dependencies
# If a rule can be found that matches the task name, enhance the
# task with the prerequisites and actions from the rule. Set the
# source attribute of the task appropriately for the rule. Return
# the enhanced task or nil of no rule was found.
def enhance_with_matching_rule(task_name, level=0)
fail Rake::RuleRecursionOverflowError,
"Rule Recursion Too Deep" if level >= 16
@rules.each do |pattern, args, extensions, order_only, block|
if pattern && pattern.match(task_name)
task = attempt_rule(task_name, pattern, args, extensions, block, level)
task | order_only unless order_only.nil?
return task if task
end
end
nil
rescue Rake::RuleRecursionOverflowError => ex
ex.add_target(task_name)
fail ex
end
# List of all defined tasks in this application.
def tasks
@tasks.values.sort_by { |t| t.name }
end
# List of all the tasks defined in the given scope (and its
# sub-scopes).
def tasks_in_scope(scope)
prefix = scope.path
tasks.select { |t|
/^#{prefix}:/ =~ t.name
}
end
# Clear all tasks in this application.
def clear
@tasks.clear
@rules.clear
end
# Lookup a task, using scope and the scope hints in the task name.
# This method performs straight lookups without trying to
# synthesize file tasks or rules. Special scope names (e.g. '^')
# are recognized. If no scope argument is supplied, use the
# current scope. Return nil if the task cannot be found.
def lookup(task_name, initial_scope=nil)
initial_scope ||= @scope
task_name = task_name.to_s
if task_name =~ /^rake:/
scopes = Scope.make
task_name = task_name.sub(/^rake:/, "")
elsif task_name =~ /^(\^+)/
scopes = initial_scope.trim($1.size)
task_name = task_name.sub(/^(\^+)/, "")
else
scopes = initial_scope
end
lookup_in_scope(task_name, scopes)
end
# Lookup the task name
def lookup_in_scope(name, scope)
loop do
tn = scope.path_with_task_name(name)
task = @tasks[tn]
return task if task
break if scope.empty?
scope = scope.tail
end
nil
end
private :lookup_in_scope
# Return the list of scope names currently active in the task
# manager.
def current_scope
@scope
end
# Evaluate the block in a nested namespace named +name+. Create
# an anonymous namespace if +name+ is nil.
def in_namespace(name)
name ||= generate_name
@scope = Scope.new(name, @scope)
ns = NameSpace.new(self, @scope)
yield(ns)
ns
ensure
@scope = @scope.tail
end
private
# Add a location to the locations field of the given task.
def add_location(task)
loc = find_location
task.locations << loc if loc
task
end
# Find the location that called into the dsl layer.
def find_location
locations = caller
i = 0
while locations[i]
return locations[i + 1] if locations[i] =~ /rake\/dsl_definition.rb/
i += 1
end
nil
end
# Generate an anonymous namespace name.
def generate_name
@seed ||= 0
@seed += 1
"_anon_#{@seed}"
end
def trace_rule(level, message) # :nodoc:
options.trace_output.puts "#{" " * level}#{message}" if
Rake.application.options.trace_rules
end
# Attempt to create a rule given the list of prerequisites.
def attempt_rule(task_name, task_pattern, args, extensions, block, level)
sources = make_sources(task_name, task_pattern, extensions)
prereqs = sources.map { |source|
trace_rule level, "Attempting Rule #{task_name} => #{source}"