prism 0.24.0 → 0.25.0

data/sig/prism/node_ext.rbs

@@ -0,0 +1,78 @@
+module Prism
+  class InterpolatedMatchLastLineNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    def options: () -> Integer
+  end
+
+  class InterpolatedRegularExpressionNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    def options: () -> Integer
+  end
+
+  class MatchLastLineNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    def options: () -> Integer
+  end
+
+  class RegularExpressionNode < Node
+    # Returns a numeric value that represents the flags that were used to create
+    # the regular expression.
+    def options: () -> Integer
+  end
+
+  class InterpolatedStringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    def heredoc?: () -> bool?
+  end
+
+  class InterpolatedXStringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    def heredoc?: () -> bool?
+  end
+
+  class StringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    def heredoc?: () -> bool?
+  end
+
+  class XStringNode < Node
+    # Returns true if this node was represented as a heredoc in the source code.
+    def heredoc?: () -> bool?
+  end
+
+  class ImaginaryNode < Node
+    def value: () -> Complex
+  end
+
+  class RationalNode < Node
+    def value: () -> Rational
+  end
+
+  class ConstantReadNode < Node
+    def full_name_parts: () -> [Symbol]
+    def full_name: () -> String
+  end
+
+  class ConstantPathNode < Node
+    class DynamicPartsInConstantPathError < StandardError
+    end
+
+    class MissingNodesInConstantPathError < StandardError
+    end
+
+    def full_name_parts: () -> Array[Symbol]
+    def full_name: () -> String
+  end
+
+  class ConstantPathTargetNode < Node
+    def full_name_parts: () -> Array[Symbol]
+    def full_name: () -> String
+  end
+
+  class ParametersNode < Node
+    def signature: () -> Array[[Symbol, Symbol] | [Symbol]]
+  end
+end

data/sig/prism/pack.rbs

@@ -0,0 +1,43 @@
+module Prism
+  module Pack
+    type variant = :pack | :unpack
+
+    def self.parse: (Symbol version, variant variant, String source) -> Format
+
+    class Directive
+      type directive_type = :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
+
+      type signness = :UNSIGNED | :SIGNED | :SIGNED_NA
+
+      type endianness = :AGNOSTIC_ENDIAN | :LITTLE_ENDIAN | :BIG_ENDIAN | :NATIVE_ENDIAN | :ENDIAN_NA
+
+      type size = :SIZE_SHORT | :SIZE_INT | :SIZE_LONG | :SIZE_LONG_LONG | :SIZE_8 | :SIZE_16 | :SIZE_32 |
+                  :SIZE_64 | :SIZE_P | :SIZE_NA
+
+      type length_type = :LENGTH_FIXED | :LENGTH_MAX | :LENGTH_RELATIVE | :LENGTH_NA
+
+
+      attr_reader version: Symbol
+      attr_reader variant: variant
+      attr_reader source: String
+      attr_reader type: directive_type
+      attr_reader signed: signness
+      attr_reader endian: endianness
+      attr_reader size: size
+      attr_reader length_type: length_type
+      attr_reader length: Integer
+
+      def describe: () -> String
+    end
+
+    class Format
+      attr_reader directives: Array[Directive]
+      attr_reader encoding: Encoding
+
+      def describe: () -> String
+    end
+  end
+end

data/sig/prism/parse_result.rbs

@@ -0,0 +1,127 @@
+module Prism
+  class Source
+    attr_reader source: String
+    attr_reader start_line: Integer
+    attr_reader offsets: Array[Integer]
+
+    def initialize: (String source, ?Integer start_line, ?Array[Integer] offsets) -> void
+    def encoding: () -> Encoding
+    def slice: (Integer byte_offset, Integer length) -> String
+    def line: (Integer byte_offset) -> Integer
+    def line_start: (Integer byte_offset) -> Integer
+    def line_offset: (Integer byte_offset) -> Integer
+    def column: (Integer byte_offset) -> Integer
+    def character_offset: (Integer byte_offset) -> Integer
+    def character_column: (Integer byte_offset) -> Integer
+    def code_units_offset: (Integer byte_offset, Encoding encoding) -> Integer
+    def code_units_column: (Integer byte_offset, Encoding encoding) -> Integer
+  end
+
+  class Location
+    attr_reader source: Source
+    attr_reader start_offset: Integer
+    attr_reader length: Integer
+
+    def initialize: (Source source, Integer start_offset, Integer length) -> void
+    def leading_comments: () -> Array[comment]
+    def leading_comment: (comment) -> void
+    def trailing_comments: () -> Array[comment]
+    def trailing_comment: (comment) -> void
+    def comments: () -> Array[comment]
+    def copy: (?source: Source, ?start_offset: Integer, ?length: Integer) -> Location
+    def slice: () -> String
+    def start_character_offset: () -> Integer
+    def end_offset: () -> Integer
+    def end_character_offset: () -> Integer
+    def start_line: () -> Integer
+    def start_line_slice: () -> String
+    def end_line: () -> Integer
+    def start_column: () -> Integer
+    def start_character_column: () -> Integer
+    def end_column: () -> Integer
+    def end_character_column: () -> Integer
+    def deconstruct_keys: (Array[Symbol] keys) -> { start_offset: Integer, end_offset: Integer }
+    def pretty_print: (untyped q) -> untyped
+    def join: (Location other) -> Location
+  end
+
+  class Comment
+    attr_reader location: Location
+
+    def initialize: (Location location) -> void
+    def deconstruct_keys: (Array[Symbol] keys) -> { location: Location }
+  end
+
+  interface _Comment
+    def trailing?: () -> bool
+  end
+
+  type comment = Comment & _Comment
+
+  class InlineComment < Comment
+    include _Comment
+  end
+
+  class EmbDocComment < Comment
+    include _Comment
+  end
+
+  class MagicComment
+    attr_reader key_loc: Location
+    attr_reader value_loc: Location
+
+    def initialize: (Location key_loc, Location value_loc) -> void
+
+    def key: () -> String
+    def value: () -> String
+
+    def deconstruct_keys: (Array[Symbol] keys) -> { key_loc: Location, value_loc: Location }
+  end
+
+  class ParseError
+    attr_reader type: Symbol
+    attr_reader message: String
+    attr_reader location: Location
+    attr_reader level: Symbol
+
+    def initialize: (Symbol type, String message, Location location, Symbol level) -> void
+    def deconstruct_keys: (Array[Symbol] keys) -> { message: String, location: Location, level: Symbol }
+  end
+
+  class ParseWarning
+    attr_reader type: Symbol
+    attr_reader message: String
+    attr_reader location: Location
+    attr_reader level: Symbol
+
+    def initialize: (Symbol type, String message, Location location, Symbol level) -> void
+    def deconstruct_keys: (Array[Symbol] keys) -> { message: String, location: Location, level: Symbol }
+  end
+
+  class ParseResult[out T]
+    attr_reader value: T
+    attr_reader comments: Array[comment]
+    attr_reader magic_comments: Array[MagicComment]
+    attr_reader data_loc: Location?
+    attr_reader errors: Array[ParseError]
+    attr_reader warnings: Array[ParseWarning]
+    attr_reader source: Source
+
+    def initialize: (T value, Array[comment] comments, Array[MagicComment] magic_comments, Location? data_loc, Array[ParseError] errors, Array[ParseWarning] warnings, Source source) -> void
+    def deconstruct_keys: (Array[Symbol] keys) -> { value: T, comments: Array[comment], magic_comments: Array[MagicComment], data_loc: Location?, errors: Array[ParseError], warnings: Array[ParseWarning] }
+    def success?: () -> bool
+    def failure?: () -> bool
+  end
+
+  class Token
+    attr_reader source: Source
+    attr_reader type: Symbol
+    attr_reader value: String
+    attr_reader location: Location
+
+    def initialize: (Source source, Symbol type, String value, Location location) -> void
+    def deconstruct_keys: (Array[Symbol] keys) -> { type: Symbol, value: String, location: Location }
+    def pretty_print: (untyped q) -> untyped
+    def ==: (untyped other) -> bool
+  end
+end

data/sig/prism/pattern.rbs

@@ -0,0 +1,13 @@
+module Prism
+  class Pattern
+    class CompilationError < StandardError
+    end
+
+    attr_reader query: String
+
+    def initialize: (String query) -> void
+    def compile: () -> Proc
+    def scan: (Prism::node root) { (Prism::node) -> void } -> void
+            | (Prism::node root) -> ::Enumerator[Prism::node, void]
+  end
+end

data/sig/prism/serialize.rbs

@@ -0,0 +1,7 @@
+module Prism
+  module Serialize
+    def self.load: (String, String) -> ParseResult[ProgramNode]
+
+    def self.load_tokens: (Source, String) -> ParseResult[Array[Token]]   # TODO: check if array[token] is right
+  end
+end

data/sig/prism/visitor.rbs

@@ -0,0 +1,168 @@
+# This file is generated by the templates/template.rb script and should not be
+# modified manually. See templates/sig/prism/visitor.rbs.erb
+# if you are looking to modify the template
+
+module Prism
+  class BasicVisitor
+    def visit: (Prism::node?) -> void
+    def visit_all: (Array[Prism::node?]) -> void
+    def visit_child_nodes: (Prism::node) -> void
+  end
+
+  interface _Visitor
+    def visit_alias_global_variable_node: (AliasGlobalVariableNode) -> void
+    def visit_alias_method_node: (AliasMethodNode) -> void
+    def visit_alternation_pattern_node: (AlternationPatternNode) -> void
+    def visit_and_node: (AndNode) -> void
+    def visit_arguments_node: (ArgumentsNode) -> void
+    def visit_array_node: (ArrayNode) -> void
+    def visit_array_pattern_node: (ArrayPatternNode) -> void
+    def visit_assoc_node: (AssocNode) -> void
+    def visit_assoc_splat_node: (AssocSplatNode) -> void
+    def visit_back_reference_read_node: (BackReferenceReadNode) -> void
+    def visit_begin_node: (BeginNode) -> void
+    def visit_block_argument_node: (BlockArgumentNode) -> void
+    def visit_block_local_variable_node: (BlockLocalVariableNode) -> void
+    def visit_block_node: (BlockNode) -> void
+    def visit_block_parameter_node: (BlockParameterNode) -> void
+    def visit_block_parameters_node: (BlockParametersNode) -> void
+    def visit_break_node: (BreakNode) -> void
+    def visit_call_and_write_node: (CallAndWriteNode) -> void
+    def visit_call_node: (CallNode) -> void
+    def visit_call_operator_write_node: (CallOperatorWriteNode) -> void
+    def visit_call_or_write_node: (CallOrWriteNode) -> void
+    def visit_call_target_node: (CallTargetNode) -> void
+    def visit_capture_pattern_node: (CapturePatternNode) -> void
+    def visit_case_match_node: (CaseMatchNode) -> void
+    def visit_case_node: (CaseNode) -> void
+    def visit_class_node: (ClassNode) -> void
+    def visit_class_variable_and_write_node: (ClassVariableAndWriteNode) -> void
+    def visit_class_variable_operator_write_node: (ClassVariableOperatorWriteNode) -> void
+    def visit_class_variable_or_write_node: (ClassVariableOrWriteNode) -> void
+    def visit_class_variable_read_node: (ClassVariableReadNode) -> void
+    def visit_class_variable_target_node: (ClassVariableTargetNode) -> void
+    def visit_class_variable_write_node: (ClassVariableWriteNode) -> void
+    def visit_constant_and_write_node: (ConstantAndWriteNode) -> void
+    def visit_constant_operator_write_node: (ConstantOperatorWriteNode) -> void
+    def visit_constant_or_write_node: (ConstantOrWriteNode) -> void
+    def visit_constant_path_and_write_node: (ConstantPathAndWriteNode) -> void
+    def visit_constant_path_node: (ConstantPathNode) -> void
+    def visit_constant_path_operator_write_node: (ConstantPathOperatorWriteNode) -> void
+    def visit_constant_path_or_write_node: (ConstantPathOrWriteNode) -> void
+    def visit_constant_path_target_node: (ConstantPathTargetNode) -> void
+    def visit_constant_path_write_node: (ConstantPathWriteNode) -> void
+    def visit_constant_read_node: (ConstantReadNode) -> void
+    def visit_constant_target_node: (ConstantTargetNode) -> void
+    def visit_constant_write_node: (ConstantWriteNode) -> void
+    def visit_def_node: (DefNode) -> void
+    def visit_defined_node: (DefinedNode) -> void
+    def visit_else_node: (ElseNode) -> void
+    def visit_embedded_statements_node: (EmbeddedStatementsNode) -> void
+    def visit_embedded_variable_node: (EmbeddedVariableNode) -> void
+    def visit_ensure_node: (EnsureNode) -> void
+    def visit_false_node: (FalseNode) -> void
+    def visit_find_pattern_node: (FindPatternNode) -> void
+    def visit_flip_flop_node: (FlipFlopNode) -> void
+    def visit_float_node: (FloatNode) -> void
+    def visit_for_node: (ForNode) -> void
+    def visit_forwarding_arguments_node: (ForwardingArgumentsNode) -> void
+    def visit_forwarding_parameter_node: (ForwardingParameterNode) -> void
+    def visit_forwarding_super_node: (ForwardingSuperNode) -> void
+    def visit_global_variable_and_write_node: (GlobalVariableAndWriteNode) -> void
+    def visit_global_variable_operator_write_node: (GlobalVariableOperatorWriteNode) -> void
+    def visit_global_variable_or_write_node: (GlobalVariableOrWriteNode) -> void
+    def visit_global_variable_read_node: (GlobalVariableReadNode) -> void
+    def visit_global_variable_target_node: (GlobalVariableTargetNode) -> void
+    def visit_global_variable_write_node: (GlobalVariableWriteNode) -> void
+    def visit_hash_node: (HashNode) -> void
+    def visit_hash_pattern_node: (HashPatternNode) -> void
+    def visit_if_node: (IfNode) -> void
+    def visit_imaginary_node: (ImaginaryNode) -> void
+    def visit_implicit_node: (ImplicitNode) -> void
+    def visit_implicit_rest_node: (ImplicitRestNode) -> void
+    def visit_in_node: (InNode) -> void
+    def visit_index_and_write_node: (IndexAndWriteNode) -> void
+    def visit_index_operator_write_node: (IndexOperatorWriteNode) -> void
+    def visit_index_or_write_node: (IndexOrWriteNode) -> void
+    def visit_index_target_node: (IndexTargetNode) -> void
+    def visit_instance_variable_and_write_node: (InstanceVariableAndWriteNode) -> void
+    def visit_instance_variable_operator_write_node: (InstanceVariableOperatorWriteNode) -> void
+    def visit_instance_variable_or_write_node: (InstanceVariableOrWriteNode) -> void
+    def visit_instance_variable_read_node: (InstanceVariableReadNode) -> void
+    def visit_instance_variable_target_node: (InstanceVariableTargetNode) -> void
+    def visit_instance_variable_write_node: (InstanceVariableWriteNode) -> void
+    def visit_integer_node: (IntegerNode) -> void
+    def visit_interpolated_match_last_line_node: (InterpolatedMatchLastLineNode) -> void
+    def visit_interpolated_regular_expression_node: (InterpolatedRegularExpressionNode) -> void
+    def visit_interpolated_string_node: (InterpolatedStringNode) -> void
+    def visit_interpolated_symbol_node: (InterpolatedSymbolNode) -> void
+    def visit_interpolated_x_string_node: (InterpolatedXStringNode) -> void
+    def visit_it_parameters_node: (ItParametersNode) -> void
+    def visit_keyword_hash_node: (KeywordHashNode) -> void
+    def visit_keyword_rest_parameter_node: (KeywordRestParameterNode) -> void
+    def visit_lambda_node: (LambdaNode) -> void
+    def visit_local_variable_and_write_node: (LocalVariableAndWriteNode) -> void
+    def visit_local_variable_operator_write_node: (LocalVariableOperatorWriteNode) -> void
+    def visit_local_variable_or_write_node: (LocalVariableOrWriteNode) -> void
+    def visit_local_variable_read_node: (LocalVariableReadNode) -> void
+    def visit_local_variable_target_node: (LocalVariableTargetNode) -> void
+    def visit_local_variable_write_node: (LocalVariableWriteNode) -> void
+    def visit_match_last_line_node: (MatchLastLineNode) -> void
+    def visit_match_predicate_node: (MatchPredicateNode) -> void
+    def visit_match_required_node: (MatchRequiredNode) -> void
+    def visit_match_write_node: (MatchWriteNode) -> void
+    def visit_missing_node: (MissingNode) -> void
+    def visit_module_node: (ModuleNode) -> void
+    def visit_multi_target_node: (MultiTargetNode) -> void
+    def visit_multi_write_node: (MultiWriteNode) -> void
+    def visit_next_node: (NextNode) -> void
+    def visit_nil_node: (NilNode) -> void
+    def visit_no_keywords_parameter_node: (NoKeywordsParameterNode) -> void
+    def visit_numbered_parameters_node: (NumberedParametersNode) -> void
+    def visit_numbered_reference_read_node: (NumberedReferenceReadNode) -> void
+    def visit_optional_keyword_parameter_node: (OptionalKeywordParameterNode) -> void
+    def visit_optional_parameter_node: (OptionalParameterNode) -> void
+    def visit_or_node: (OrNode) -> void
+    def visit_parameters_node: (ParametersNode) -> void
+    def visit_parentheses_node: (ParenthesesNode) -> void
+    def visit_pinned_expression_node: (PinnedExpressionNode) -> void
+    def visit_pinned_variable_node: (PinnedVariableNode) -> void
+    def visit_post_execution_node: (PostExecutionNode) -> void
+    def visit_pre_execution_node: (PreExecutionNode) -> void
+    def visit_program_node: (ProgramNode) -> void
+    def visit_range_node: (RangeNode) -> void
+    def visit_rational_node: (RationalNode) -> void
+    def visit_redo_node: (RedoNode) -> void
+    def visit_regular_expression_node: (RegularExpressionNode) -> void
+    def visit_required_keyword_parameter_node: (RequiredKeywordParameterNode) -> void
+    def visit_required_parameter_node: (RequiredParameterNode) -> void
+    def visit_rescue_modifier_node: (RescueModifierNode) -> void
+    def visit_rescue_node: (RescueNode) -> void
+    def visit_rest_parameter_node: (RestParameterNode) -> void
+    def visit_retry_node: (RetryNode) -> void
+    def visit_return_node: (ReturnNode) -> void
+    def visit_self_node: (SelfNode) -> void
+    def visit_shareable_constant_node: (ShareableConstantNode) -> void
+    def visit_singleton_class_node: (SingletonClassNode) -> void
+    def visit_source_encoding_node: (SourceEncodingNode) -> void
+    def visit_source_file_node: (SourceFileNode) -> void
+    def visit_source_line_node: (SourceLineNode) -> void
+    def visit_splat_node: (SplatNode) -> void
+    def visit_statements_node: (StatementsNode) -> void
+    def visit_string_node: (StringNode) -> void
+    def visit_super_node: (SuperNode) -> void
+    def visit_symbol_node: (SymbolNode) -> void
+    def visit_true_node: (TrueNode) -> void
+    def visit_undef_node: (UndefNode) -> void
+    def visit_unless_node: (UnlessNode) -> void
+    def visit_until_node: (UntilNode) -> void
+    def visit_when_node: (WhenNode) -> void
+    def visit_while_node: (WhileNode) -> void
+    def visit_x_string_node: (XStringNode) -> void
+    def visit_yield_node: (YieldNode) -> void
+  end
+
+  class Visitor < BasicVisitor
+    include _Visitor
+  end
+end