prism 2.0.0.rc1-x86_64-linux-gnu

data/lib/prism.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+# :markup: markdown
+#--
+# rbs_inline: enabled
+
+# 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 :DesugarCompiler, "prism/desugar_compiler"
+  autoload :Dispatcher, "prism/dispatcher"
+  autoload :DotVisitor, "prism/dot_visitor"
+  autoload :DSL, "prism/dsl"
+  autoload :InspectVisitor, "prism/inspect_visitor"
+  autoload :LexCompat, "prism/lex_compat"
+  autoload :MutationCompiler, "prism/mutation_compiler"
+  autoload :NodeFind, "prism/node_find"
+  autoload :Pattern, "prism/pattern"
+  autoload :Reflection, "prism/reflection"
+  autoload :Relocation, "prism/relocation"
+  autoload :Serialize, "prism/serialize"
+  autoload :StringQuery, "prism/string_query"
+  autoload :Translation, "prism/translation"
+  autoload :Visitor, "prism/visitor"
+
+  # Some of these constants are not meant to be exposed, so marking them as
+  # private here.
+
+  if RUBY_ENGINE != "jruby"
+    private_constant :LexCompat
+    private_constant :NodeFind
+  end
+
+  # Raised when requested to parse as the currently running Ruby version but Prism has no support for it.
+  class CurrentVersionError < ArgumentError
+    # Initialize a new exception for the given ruby version string.
+    #
+    #: (String version) -> void
+    def initialize(version)
+      message = +"invalid version: Requested to parse as `version: 'current'`; "
+      major, minor, =
+        if version.match?(/\A\d+\.\d+.\d+\z/)
+          version.split(".").map(&:to_i)
+        end
+
+      if major && minor && ((major < 3) || (major == 3 && minor < 3))
+        message << " #{version} is below the minimum supported syntax."
+      else
+        message << " #{version} is unknown. Please update the `prism` gem."
+      end
+
+      super(message)
+    end
+  end
+
+  # :call-seq:
+  #   lex_compat(source, **options) -> LexCompat::Result
+  #
+  # Returns a parse result whose value is an array of tokens that closely
+  # resembles the return value of Ripper.lex.
+  #
+  # For supported options, see Prism.parse.
+  #
+  #: (String source, **untyped options) -> LexCompat::Result
+  def self.lex_compat(source, **options)
+    LexCompat.new(source, **options).result # steep:ignore
+  end
+
+  # :call-seq:
+  #   load(source, serialized, freeze) -> ParseResult
+  #
+  # Load the serialized AST using the source as a reference into a tree.
+  #
+  #: (String source, String serialized, ?bool freeze) -> ParseResult
+  def self.load(source, serialized, freeze = false)
+    Serialize.load_parse(source, serialized, freeze)
+  end
+
+  # Given a Method, UnboundMethod, Proc, or Thread::Backtrace::Location,
+  # returns the Prism node representing it. On CRuby, this uses node_id for
+  # an exact match. On other implementations, it falls back to best-effort
+  # matching by source location line number.
+  #
+  #: (Method | UnboundMethod | Proc | Thread::Backtrace::Location callable) -> Node?
+  def self.find(callable)
+    NodeFind.find(callable)
+  end
+
+  # @rbs!
+  #    VERSION: String
+  #    BACKEND: :CEXT | :FFI
+  #
+  #    interface _Stream
+  #      def gets: (?Integer integer) -> (String | nil)
+  #    end
+  #
+  #    def self.parse:               (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> ParseResult
+  #    def self.profile:             (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> void
+  #    def self.lex:                 (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> LexResult
+  #    def self.parse_lex:           (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> ParseLexResult
+  #    def self.dump:                (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> String
+  #    def self.parse_comments:      (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> Array[Comment]
+  #    def self.parse_success?:      (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> bool
+  #    def self.parse_failure?:      (String source,  ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> bool
+  #    def self.parse_stream:        (_Stream stream, ?filepath: String, ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> ParseResult
+  #    def self.parse_file:          (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> ParseResult
+  #    def self.profile_file:        (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> void
+  #    def self.lex_file:            (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> LexResult
+  #    def self.parse_lex_file:      (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> ParseLexResult
+  #    def self.dump_file:           (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> String
+  #    def self.parse_file_comments: (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> Array[Comment]
+  #    def self.parse_file_success?: (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> bool
+  #    def self.parse_file_failure?: (path filepath,                     ?attach_comments: bool, ?command_line: String, ?encoding: Encoding | false, ?freeze: bool, ?frozen_string_literal: bool, ?line: Integer, ?main_script: bool, ?partial_script: bool, ?raise_error: Symbol | true, ?scopes: Array[Array[Symbol]], ?version: String) -> bool
+end
+
+require_relative "prism/polyfill/byteindex"
+require_relative "prism/polyfill/warn"
+require_relative "prism/node"
+require_relative "prism/node_ext"
+require_relative "prism/parse_result"
+
+# 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"]
+  # The C extension is the default backend on CRuby.
+  Prism::BACKEND = :CEXT
+
+  begin
+    # The precompiled native libraries are in <gem_dir>/lib/prism/<ruby_version>
+    require_relative "prism/#{RUBY_VERSION[/\d+\.\d+/]}/prism"
+  rescue LoadError => e
+    if e.message.include?("GLIBC")
+      warn(<<~EOM)
+
+        ERROR: It looks like you're trying to use Prism as a precompiled native gem on a system
+               with an unsupported version of glibc.
+
+          #{e.message}
+
+          If that's the case, then please install Prism via the `ruby` platform gem:
+              gem install prism --platform=ruby
+          or, in your Gemfile:
+              gem "prism", force_ruby_platform: true
+
+      EOM
+      raise e
+    end
+
+    # Precompiled library isn't available, fall back to the library compiled at installation time.
+    require "prism/prism"
+  end
+else
+  # The FFI backend is used on other Ruby implementations.
+  Prism::BACKEND = :FFI
+
+  require_relative "prism/ffi"
+end

data/prism.gemspec

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "prism"
+  spec.version = "2.0.0.rc1"
+  spec.authors = ["Shopify"]
+  spec.email = ["ruby@shopify.com"]
+
+  spec.summary = "Prism Ruby parser"
+  spec.homepage = "https://github.com/ruby/prism"
+  spec.license = "MIT"
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.require_paths = ["lib"]
+  spec.files = [
+    "BSDmakefile",
+    "CHANGELOG.md",
+    "CODE_OF_CONDUCT.md",
+    "CONTRIBUTING.md",
+    "LICENSE.md",
+    "Makefile",
+    "README.md",
+    "config.yml",
+    "docs/build_system.md",
+    "docs/configuration.md",
+    "docs/cruby_compilation.md",
+    "docs/design.md",
+    "docs/encoding.md",
+    "docs/fuzzing.md",
+    "docs/heredocs.md",
+    "docs/javascript.md",
+    "docs/local_variable_depth.md",
+    "docs/mapping.md",
+    "docs/parser_translation.md",
+    "docs/parsing_rules.md",
+    "docs/releasing.md",
+    "docs/relocation.md",
+    "docs/ripper_translation.md",
+    "docs/ruby_api.md",
+    "docs/ruby_parser_translation.md",
+    "docs/serialization.md",
+    "docs/testing.md",
+    "ext/prism/api_node.c",
+    "ext/prism/extconf.rb",
+    "ext/prism/extension.c",
+    "ext/prism/extension.h",
+    "include/prism.h",
+    "include/prism/compiler/accel.h",
+    "include/prism/compiler/align.h",
+    "include/prism/compiler/assume.h",
+    "include/prism/compiler/exported.h",
+    "include/prism/compiler/fallthrough.h",
+    "include/prism/compiler/filesystem.h",
+    "include/prism/compiler/flex_array.h",
+    "include/prism/compiler/force_inline.h",
+    "include/prism/compiler/format.h",
+    "include/prism/compiler/inline.h",
+    "include/prism/compiler/nodiscard.h",
+    "include/prism/compiler/nonnull.h",
+    "include/prism/compiler/unused.h",
+    "include/prism/internal/allocator.h",
+    "include/prism/internal/allocator_debug.h",
+    "include/prism/internal/arena.h",
+    "include/prism/internal/bit.h",
+    "include/prism/internal/buffer.h",
+    "include/prism/internal/char.h",
+    "include/prism/internal/comments.h",
+    "include/prism/internal/constant_pool.h",
+    "include/prism/internal/diagnostic.h",
+    "include/prism/internal/encoding.h",
+    "include/prism/internal/integer.h",
+    "include/prism/internal/isinf.h",
+    "include/prism/internal/line_offset_list.h",
+    "include/prism/internal/list.h",
+    "include/prism/internal/magic_comments.h",
+    "include/prism/internal/memchr.h",
+    "include/prism/internal/node.h",
+    "include/prism/internal/options.h",
+    "include/prism/internal/parser.h",
+    "include/prism/internal/regexp.h",
+    "include/prism/internal/serialize.h",
+    "include/prism/internal/source.h",
+    "include/prism/internal/static_literals.h",
+    "include/prism/internal/strncasecmp.h",
+    "include/prism/internal/stringy.h",
+    "include/prism/internal/strpbrk.h",
+    "include/prism/internal/tokens.h",
+    "include/prism/arena.h",
+    "include/prism/ast.h",
+    "include/prism/buffer.h",
+    "include/prism/comments.h",
+    "include/prism/constant_pool.h",
+    "include/prism/diagnostic.h",
+    "include/prism/errors_format.h",
+    "include/prism/excludes.h",
+    "include/prism/integer.h",
+    "include/prism/json.h",
+    "include/prism/line_offset_list.h",
+    "include/prism/magic_comments.h",
+    "include/prism/node.h",
+    "include/prism/options.h",
+    "include/prism/parser.h",
+    "include/prism/prettyprint.h",
+    "include/prism/serialize.h",
+    "include/prism/source.h",
+    "include/prism/stream.h",
+    "include/prism/string_query.h",
+    "include/prism/stringy.h",
+    "include/prism/version.h",
+    "lib/prism.rb",
+    "lib/prism/compiler.rb",
+    "lib/prism/desugar_compiler.rb",
+    "lib/prism/dispatcher.rb",
+    "lib/prism/dot_visitor.rb",
+    "lib/prism/dsl.rb",
+    "lib/prism/ffi.rb",
+    "lib/prism/inspect_visitor.rb",
+    "lib/prism/lex_compat.rb",
+    "lib/prism/mutation_compiler.rb",
+    "lib/prism/node_ext.rb",
+    "lib/prism/node_find.rb",
+    "lib/prism/node.rb",
+    "lib/prism/parse_result.rb",
+    "lib/prism/parse_result/errors.rb",
+    "lib/prism/parse_result/newlines.rb",
+    "lib/prism/pattern.rb",
+    "lib/prism/polyfill/append_as_bytes.rb",
+    "lib/prism/polyfill/byteindex.rb",
+    "lib/prism/polyfill/scan_byte.rb",
+    "lib/prism/polyfill/unpack1.rb",
+    "lib/prism/polyfill/warn.rb",
+    "lib/prism/reflection.rb",
+    "lib/prism/relocation.rb",
+    "lib/prism/serialize.rb",
+    "lib/prism/string_query.rb",
+    "lib/prism/translation.rb",
+    "lib/prism/translation/parser.rb",
+    "lib/prism/translation/parser_current.rb",
+    "lib/prism/translation/parser_versions.rb",
+    "lib/prism/translation/parser/builder.rb",
+    "lib/prism/translation/parser/compiler.rb",
+    "lib/prism/translation/parser/lexer.rb",
+    "lib/prism/translation/ripper.rb",
+    "lib/prism/translation/ripper/filter.rb",
+    "lib/prism/translation/ripper/lexer.rb",
+    "lib/prism/translation/ripper/sexp.rb",
+    "lib/prism/translation/ripper/shim.rb",
+    "lib/prism/translation/ruby_parser.rb",
+    "lib/prism/visitor.rb",
+    "prism.gemspec",
+    "rbi/generated/prism.rbi",
+    "rbi/generated/prism/compiler.rbi",
+    "rbi/generated/prism/desugar_compiler.rbi",
+    "rbi/generated/prism/dispatcher.rbi",
+    "rbi/generated/prism/dot_visitor.rbi",
+    "rbi/generated/prism/dsl.rbi",
+    "rbi/generated/prism/inspect_visitor.rbi",
+    "rbi/generated/prism/lex_compat.rbi",
+    "rbi/generated/prism/mutation_compiler.rbi",
+    "rbi/generated/prism/node.rbi",
+    "rbi/generated/prism/node_ext.rbi",
+    "rbi/generated/prism/node_find.rbi",
+    "rbi/generated/prism/parse_result.rbi",
+    "rbi/generated/prism/pattern.rbi",
+    "rbi/generated/prism/reflection.rbi",
+    "rbi/generated/prism/relocation.rbi",
+    "rbi/generated/prism/serialize.rbi",
+    "rbi/generated/prism/string_query.rbi",
+    "rbi/generated/prism/translation.rbi",
+    "rbi/generated/prism/visitor.rbi",
+    "rbi/generated/prism/parse_result/errors.rbi",
+    "rbi/generated/prism/parse_result/newlines.rbi",
+    "rbi/prism/translation/parser.rbi",
+    "rbi/prism/translation/parser_versions.rbi",
+    "rbi/prism/translation/ripper.rbi",
+    "rbi/rubyvm/node_find.rbi",
+    "sig/generated/prism.rbs",
+    "sig/generated/prism/compiler.rbs",
+    "sig/generated/prism/desugar_compiler.rbs",
+    "sig/generated/prism/dispatcher.rbs",
+    "sig/generated/prism/dot_visitor.rbs",
+    "sig/generated/prism/dsl.rbs",
+    "sig/generated/prism/inspect_visitor.rbs",
+    "sig/generated/prism/lex_compat.rbs",
+    "sig/generated/prism/mutation_compiler.rbs",
+    "sig/generated/prism/node.rbs",
+    "sig/generated/prism/node_ext.rbs",
+    "sig/generated/prism/node_find.rbs",
+    "sig/generated/prism/parse_result.rbs",
+    "sig/generated/prism/pattern.rbs",
+    "sig/generated/prism/reflection.rbs",
+    "sig/generated/prism/relocation.rbs",
+    "sig/generated/prism/serialize.rbs",
+    "sig/generated/prism/string_query.rbs",
+    "sig/generated/prism/translation.rbs",
+    "sig/generated/prism/visitor.rbs",
+    "sig/generated/prism/parse_result/errors.rbs",
+    "sig/generated/prism/parse_result/newlines.rbs",
+    "sig/manifest.yaml",
+    "src/arena.c",
+    "src/buffer.c",
+    "src/char.c",
+    "src/comments.c",
+    "src/constant_pool.c",
+    "src/diagnostic.c",
+    "src/encoding.c",
+    "src/errors_format.c",
+    "src/integer.c",
+    "src/json.c",
+    "src/line_offset_list.c",
+    "src/list.c",
+    "src/memchr.c",
+    "src/node.c",
+    "src/options.c",
+    "src/parser.c",
+    "src/prettyprint.c",
+    "src/prism.c",
+    "src/regexp.c",
+    "src/serialize.c",
+    "src/source.c",
+    "src/static_literals.c",
+    "src/string_query.c",
+    "src/stringy.c",
+    "src/strncasecmp.c",
+    "src/strpbrk.c",
+    "src/tokens.c"
+  ]
+
+  spec.extensions = ["ext/prism/extconf.rb"]
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["source_code_uri"] = "https://github.com/ruby/prism"
+  spec.metadata["changelog_uri"] = "https://github.com/ruby/prism/blob/main/CHANGELOG.md"
+end