rbs 1.6.0 → 1.7.0.beta.2

data/lib/rbs/location_aux.rb

@@ -0,0 +1,121 @@
+module RBS
+  class Location
+    def inspect
+      rks = each_required_key.to_a
+      ops = each_optional_key.to_a.map {|x| "?#{x}" }
+      "#<#{self.class}:#{self.__id__} buffer=#{buffer.name}, start=#{start_line}:#{start_column}, pos=#{start_pos}...#{end_pos}, children=#{(rks + ops).join(",")} source='#{source.lines.first&.chomp}'>"
+    end
+
+    def self.new(buffer_ = nil, start_pos_ = nil, end_pos_ = nil, buffer: nil, start_pos: nil, end_pos: nil)
+      __skip__ =
+        begin
+          if buffer && start_pos && end_pos
+            super(buffer, start_pos, end_pos)
+          else
+            super(buffer_, start_pos_, end_pos_)
+          end
+        end
+    end
+
+    WithChildren = self
+
+    def name
+      buffer.name
+    end
+
+    def start_line
+      start_loc[0]
+    end
+
+    def start_column
+      start_loc[1]
+    end
+
+    def end_line
+      end_loc[0]
+    end
+
+    def end_column
+      end_loc[1]
+    end
+
+    def start_loc
+      @start_loc ||= begin
+        _start_loc || buffer.pos_to_loc(start_pos)
+      end
+    end
+
+    def end_loc
+      @end_loc ||= begin
+        _end_loc || buffer.pos_to_loc(end_pos)
+      end
+    end
+
+    def range
+      @range ||= start_pos...end_pos
+    end
+
+    def source
+      @source ||= buffer.content[range] or raise
+    end
+
+    def to_s
+      "#{name || "-"}:#{start_line}:#{start_column}...#{end_line}:#{end_column}"
+    end
+
+    def ==(other)
+      other.is_a?(Location) &&
+        other.buffer == buffer &&
+        other.start_pos == start_pos &&
+        other.end_pos == end_pos
+    end
+
+    def to_json(state = _ = nil)
+      {
+        start: {
+          line: start_line,
+          column: start_column
+        },
+        end: {
+          line: end_line,
+          column: end_column
+        },
+        buffer: {
+          name: name&.to_s
+        }
+      }.to_json(state)
+    end
+
+    def self.to_string(location, default: "*:*:*...*:*")
+      location&.to_s || default
+    end
+
+    def add_required_child(name, range)
+      _add_required_child(name, range.begin, range.end)
+    end
+
+    def add_optional_child(name, range)
+      if range
+        _add_optional_child(name, range.begin, range.end)
+      else
+        _add_optional_no_child(name);
+      end
+    end
+
+    def each_optional_key(&block)
+      if block
+        _optional_keys.uniq.each(&block)
+      else
+        enum_for(:each_optional_key)
+      end
+    end
+
+    def each_required_key(&block)
+      if block
+        _required_keys.uniq.each(&block)
+      else
+        enum_for(:each_required_key)
+      end
+    end
+  end
+end

data/lib/rbs/locator.rb

@@ -172,16 +172,19 @@ module RBS
 
     def find_in_loc(pos, location:, array:)
       if test_loc(pos, location: location)
-        if location.is_a?(Location::WithChildren)
-          location.optional_children.each do |key, range|
-            if range === pos
-              array.unshift(key)
-              return true
+        if location.is_a?(Location)
+          location.each_optional_key do |key|
+            if loc = location[key]
+              if loc.range === pos
+                array.unshift(key)
+                return true
+              end
             end
           end
 
-          location.required_children.each do |key, range|
-            if range === pos
+          location.each_required_key do |key|
+            loc = location[key] or raise
+            if loc.range === pos
               array.unshift(key)
               return true
             end

data/lib/rbs/parser_aux.rb

@@ -0,0 +1,31 @@
+module RBS
+  class Parser
+    def self.parse_type(source, line: 1, column: 0, variables: [])
+      _parse_type(buffer(source), line, column, variables)
+    end
+
+    def self.parse_method_type(source, line: 1, column: 0, variables: [])
+      _parse_method_type(buffer(source), line, column, variables)
+    end
+
+    def self.parse_signature(source, line: 1, column: 0)
+      _parse_signature(buffer(source), line, column)
+    end
+
+    def self.buffer(source)
+      case source
+      when String
+        Buffer.new(content: source, name: "a.rbs")
+      when Buffer
+        source
+      end
+    end
+
+    SyntaxError = ParsingError
+    SemanticsError = ParsingError
+    LexerError = ParsingError
+
+    class LocatedValue
+    end
+  end
+end

data/lib/rbs/types.rb

@@ -1,4 +1,3 @@
-
 module RBS
   module Types
     module NoFreeVariables
@@ -434,7 +433,7 @@ module RBS
         return "{ }" if self.fields.empty?
 
         fields = self.fields.map do |key, type|
-          if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_]*\z/) && !key.match?(Parser::KEYWORDS_RE)
+          if key.is_a?(Symbol) && key.match?(/\A[A-Za-z_][A-Za-z_]*\z/) && !Parser::KEYWORDS.key?(key)
             "#{key}: #{type}"
           else
             "#{key.inspect} => #{type}"
@@ -691,7 +690,7 @@ module RBS
 
         def to_s
           if name
-            if /\A#{Parser::KEYWORDS_RE}\z/.match?(name)
+            if Parser::KEYWORDS.key?(name)
               "#{type} `#{name}`"
             else
               "#{type} #{name}"

data/lib/rbs/version.rb

@@ -1,3 +1,3 @@
 module RBS
-  VERSION = "1.6.0"
+  VERSION = "1.7.0.beta.2"
 end

data/lib/rbs/writer.rb

@@ -232,8 +232,10 @@ module RBS
     def method_name(name)
       s = name.to_s
 
-      if [:tOPERATOR, :kAMP, :kHAT, :kSTAR, :kLT, :kEXCLAMATION, :kSTAR2, :kBAR].include?(Parser::PUNCTS[s]) ||
-          (/\A[a-zA-Z_]\w*[?!=]?\z/.match?(s) && !/\Aself\??\z/.match?(s))
+      case s
+      when /\A(_?)[A-Za-z_]\w*(\?|!|=)?\Z/
+        s
+      when *%w(|  ^  &  <=>  ==  ===  =~  >   >=  <   <=   <<  >> +  -  *  /  %   **   ~   +@  -@  []  []=  ` ! != !~)
         s
       else
         "`#{s}`"

data/lib/rbs.rb

@@ -12,7 +12,6 @@ require "strscan"
 require "rbs/char_scanner"
 require "rbs/errors"
 require "rbs/buffer"
-require "rbs/location"
 require "rbs/namespace"
 require "rbs/type_name"
 require "rbs/types"
@@ -47,12 +46,9 @@ require "rbs/locator"
 require "rbs/type_alias_dependency"
 require "rbs/collection"
 
-begin
-  require "rbs/parser"
-rescue LoadError
-  STDERR.puts "Missing parser Ruby code? Running `rake parser` may solve the issue"
-  raise
-end
+require "rbs_extension"
+require "rbs/parser_aux"
+require "rbs/location_aux"
 
 module RBS
   class <<self

data/rbs.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
   end
-  spec.files << "lib/rbs/parser.rb"
+  spec.extensions = %w{ext/rbs_extension/extconf.rb}
+
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/sig/ancestor_builder.rbs

@@ -82,7 +82,7 @@ module RBS
       def mixin_ancestors: (Environment::ClassEntry | Environment::ModuleEntry,
                             TypeName,
                             included_modules: Array[Definition::Ancestor::Instance]?,
-                         included_interfaces:Array[Definition::Ancestor::Instance]?,
+                         included_interfaces: Array[Definition::Ancestor::Instance]?,
                            prepended_modules: Array[Definition::Ancestor::Instance]?,
                             extended_modules: Array[Definition::Ancestor::Instance]?,
                          extended_interfaces: Array[Definition::Ancestor::Instance]?) -> void
@@ -91,7 +91,7 @@ module RBS
                              TypeName,
                              align_params: Substitution?,
                          included_modules: Array[Definition::Ancestor::Instance]?,
-                      included_interfaces:Array[Definition::Ancestor::Instance]?,
+                      included_interfaces: Array[Definition::Ancestor::Instance]?,
                         prepended_modules: Array[Definition::Ancestor::Instance]?,
                          extended_modules: Array[Definition::Ancestor::Instance]?,
                       extended_interfaces: Array[Definition::Ancestor::Instance]?) -> void

data/sig/annotation.rbs

@@ -10,9 +10,9 @@ module RBS
     #
     class Annotation
       attr_reader string: String
-      attr_reader location: Location?
+      attr_reader location: Location[untyped, untyped]?
 
-      def initialize: (string: String, location: Location?) -> void
+      def initialize: (string: String, location: Location[untyped, untyped]?) -> void
 
       def ==: (untyped other) -> bool
 

data/sig/comment.rbs

@@ -2,15 +2,17 @@ module RBS
   module AST
     # RBS allows writing documentation of declarations and members.
     #
-    #    # This is a doc for class.
-    #    class Hello
-    #    end
+    # ```
+    # # This is a doc for class.
+    # class Hello
+    # end
+    # ```
     #
     class Comment
       attr_reader string: String
-      attr_reader location: Location?
+      attr_reader location: Location[bot, bot]?
 
-      def initialize: (string: String, location: Location?) -> void
+      def initialize: (string: String, location: Location[bot, bot]?) -> void
 
       def ==: (untyped other) -> bool
 
@@ -19,8 +21,6 @@ module RBS
       def hash: () -> Integer
 
       include _ToJson
-
-      def concat: (string: String, location: Location?) -> self
     end
   end
 end

data/sig/constant_table.rbs

@@ -9,7 +9,7 @@ module RBS
 
     def absolute_type: (Types::t, context: Array[Namespace]) -> Types::t
 
-    def absolute_type_name: (TypeName, context: Array[Namespace], location: Location?) -> TypeName
+    def absolute_type_name: (TypeName, context: Array[Namespace], location: Location[untyped, untyped]?) -> TypeName
 
     def name_to_constant: (TypeName) -> Constant?
 

data/sig/declarations.rbs

@@ -17,7 +17,7 @@ module RBS
           # ^^^^^^^^^          unchecked
           #           ^^^      variance
           #               ^^^^ name
-          type loc = Location::WithChildren[:name, :variance | :unchecked]
+          type loc = Location[:name, :variance | :unchecked]
 
           attr_reader name: Symbol
           attr_reader variance: variance
@@ -86,7 +86,7 @@ module RBS
           # ^^^^^         name
           #      ^^^^^^^^ args
           #
-          type loc = Location::WithChildren[:name, :args]
+          type loc = Location[:name, :args]
 
           attr_reader name: TypeName
           attr_reader args: Array[Types::t]
@@ -112,7 +112,7 @@ module RBS
         #              ^            lt
         #                       ^^^ end
         #
-        type loc = Location::WithChildren[:keyword | :name | :end, :type_params | :lt]
+        type loc = Location[:keyword | :name | :end, :type_params | :lt]
 
         include NestedDeclarationHelper
         include MixinHelper
@@ -137,7 +137,7 @@ module RBS
           # ^^^^^         name
           #      ^^^^^^^^ args
           #
-          type loc = Location::WithChildren[:name, :args]
+          type loc = Location[:name, :args]
 
           attr_reader name: TypeName
           attr_reader args: Array[Types::t]
@@ -166,7 +166,7 @@ module RBS
         #                 ^^^^^^^^^^^     self_types
         #                             ^^^ end
         #
-        type loc = Location::WithChildren[:keyword | :name | :end, :type_params | :colon | :self_types]
+        type loc = Location[:keyword | :name | :end, :type_params | :colon | :self_types]
 
         include NestedDeclarationHelper
         include MixinHelper
@@ -199,7 +199,7 @@ module RBS
         #               ^^^^^^     type_params
         #                      ^^^ end
         #
-        type loc = Location::WithChildren[:name | :keyword | :end, :type_params]
+        type loc = Location[:name | :keyword | :end, :type_params]
 
         attr_reader name: TypeName
         attr_reader type_params: ModuleTypeParams
@@ -221,7 +221,7 @@ module RBS
         # ^^^^                keyword
         #      ^^^            name
         #          ^          eq
-        type loc = Location::WithChildren[:keyword | :name | :eq, bot]
+        type loc = Location[:keyword | :name | :eq, bot]
 
         attr_reader name: TypeName
         attr_reader type: Types::t
@@ -240,7 +240,7 @@ module RBS
         # ^^^^^^^         name
         #        ^        colon
         #
-        type loc = Location::WithChildren[:name | :colon, bot]
+        type loc = Location[:name | :colon, bot]
 
         attr_reader name: TypeName
         attr_reader type: Types::t
@@ -258,7 +258,7 @@ module RBS
         # ^^^^^         name
         #      ^        colon
         #
-        type loc = Location::WithChildren[:name | :colon, bot]
+        type loc = Location[:name | :colon, bot]
 
         attr_reader name: Symbol
         attr_reader type: Types::t

data/sig/definition.rbs

@@ -90,7 +90,7 @@ module RBS
 
       def initialize: (type_name: TypeName, params: Array[Symbol], ancestors: Array[Ancestor::t]) -> void
 
-      def apply: (Array[Types::t], location: Location?) -> Array[Ancestor::t]
+      def apply: (Array[Types::t], location: Location[untyped, untyped]?) -> Array[Ancestor::t]
     end
 
     class SingletonAncestors

data/sig/definition_builder.rbs

@@ -14,7 +14,7 @@ module RBS
 
     def validate_super_class!: (TypeName, Environment::ClassEntry) -> void
 
-    def ensure_namespace!: (Namespace, location: Location?) -> void
+    def ensure_namespace!: (Namespace, location: Location[untyped, untyped]?) -> void
 
     def build_interface: (TypeName) -> Definition
 
@@ -37,7 +37,7 @@ module RBS
 
     def validate_type_params: (Definition, ancestors: AncestorBuilder::OneAncestors, methods: MethodBuilder::Methods) -> void
 
-    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location?
+    def source_location: (Definition::Ancestor::Instance::source, AST::Declarations::t) -> Location[untyped, untyped]?
 
     def insert_variable: (TypeName, Hash[Symbol, Definition::Variable], name: Symbol, type: Types::t) -> void
 

data/sig/errors.rbs

@@ -19,6 +19,21 @@ module RBS
   # Error class for errors raised during parsing.
   #
   class ParsingError < BaseError
+    attr_reader location: Location[untyped, untyped]
+    attr_reader error_message: String
+    attr_reader token_type: String
+
+    def initialize: (Location[untyped, untyped], String error_message, String token_type) -> void
+
+    def error_value: () -> String
+
+    def token_str: () -> String
+  end
+
+  class Parser
+    SemanticsError: singleton(ParsingError)
+    SyntaxError: singleton(ParsingError)
+    LexerError: singleton(ParsingError)
   end
 
   # Error class for errors raised during loading environments.
@@ -35,45 +50,45 @@ module RBS
     attr_reader type_name: TypeName
     attr_reader args: Array[Types::t]
     attr_reader params: Array[Symbol]
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location?) -> void
+    def initialize: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location?) -> void
+    def self.check!: (type_name: TypeName, args: Array[Types::t], params: Array[Symbol], location: Location[untyped, untyped]?) -> void
   end
 
   class RecursiveAncestorError < DefinitionError
     attr_reader ancestors: Array[Definition::Ancestor::t]
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (ancestors: Array[Definition::Ancestor::t], location: Location?) -> void
+    def initialize: (ancestors: Array[Definition::Ancestor::t], location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (Definition::Ancestor::t, ancestors: Array[Definition::Ancestor::t], location: Location?) -> void
+    def self.check!: (Definition::Ancestor::t, ancestors: Array[Definition::Ancestor::t], location: Location[untyped, untyped]?) -> void
   end
 
   class NoTypeFoundError < DefinitionError
     attr_reader type_name: TypeName
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, location: Location?) -> void
+    def initialize: (type_name: TypeName, location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (TypeName, env: Environment, location: Location?) -> TypeName
+    def self.check!: (TypeName, env: Environment, location: Location[untyped, untyped]?) -> TypeName
   end
 
   class NoSuperclassFoundError < DefinitionError
     attr_reader type_name: TypeName
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, location: Location?) -> void
+    def initialize: (type_name: TypeName, location: Location[untyped, untyped]?) -> void
 
-    def self.check!: (TypeName, env: Environment, location: Location?) -> void
+    def self.check!: (TypeName, env: Environment, location: Location[untyped, untyped]?) -> void
   end
 
   class NoSelfTypeFoundError < DefinitionError
     attr_reader type_name: TypeName
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, location: Location?) -> void
+    def initialize: (type_name: TypeName, location: Location[untyped, untyped]?) -> void
 
     def self.check!: (AST::Declarations::Module::Self, env: Environment) -> void
   end
@@ -84,7 +99,7 @@ module RBS
 
     def initialize: (type_name: TypeName, member: AST::Members::t) -> void
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
 
     def self.check!: (TypeName, env: Environment, member: AST::Members::t) -> void
   end
@@ -103,9 +118,9 @@ module RBS
 
     def qualified_method_name: () -> String
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
 
-    def other_locations: () -> Array[Location?]
+    def other_locations: () -> Array[Location[untyped, untyped]?]
   end
 
   class DuplicatedInterfaceMethodDefinitionError < DefinitionError
@@ -127,9 +142,9 @@ module RBS
     attr_reader type_name: TypeName
     attr_reader original_name: Symbol
     attr_reader aliased_name: Symbol
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, original_name: Symbol, aliased_name: Symbol, location: Location?) -> void
+    def initialize: (type_name: TypeName, original_name: Symbol, aliased_name: Symbol, location: Location[untyped, untyped]?) -> void
   end
 
   class SuperclassMismatchError < DefinitionError
@@ -165,9 +180,9 @@ module RBS
   class InvalidVarianceAnnotationError < DefinitionError
     attr_reader type_name: TypeName
     attr_reader param: AST::Declarations::ModuleTypeParams::TypeParam
-    attr_reader location: Location?
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (type_name: TypeName, param: AST::Declarations::ModuleTypeParams::TypeParam, location: Location?) -> void
+    def initialize: (type_name: TypeName, param: AST::Declarations::ModuleTypeParams::TypeParam, location: Location[untyped, untyped]?) -> void
   end
 
   class RecursiveAliasDefinitionError < DefinitionError
@@ -179,7 +194,7 @@ module RBS
 
     def initialize: (type: ty, defs: Array[defn]) -> void
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
   end
 
   class MixinClassError < DefinitionError
@@ -190,7 +205,7 @@ module RBS
 
     def initialize: (type_name: TypeName, member: member) -> void
 
-    def location: () -> Location?
+    def location: () -> Location[untyped, untyped]?
 
     def self.check!: (type_name: TypeName, env: Environment, member: member) -> void
 
@@ -199,9 +214,9 @@ module RBS
 
   class RecursiveTypeAliasError < LoadingError
     attr_reader alias_names: Array[TypeName]
-    attr_reader location: Location
+    attr_reader location: Location[untyped, untyped]?
 
-    def initialize: (alias_names: Array[TypeName], location: Location) -> void
+    def initialize: (alias_names: Array[TypeName], location: Location[untyped, untyped]?) -> void
 
     def name: () -> String
   end