rbs-relaxed 3.9.0.1

data/lib/rbs/annotate/rdoc_source.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module RBS
+  module Annotate
+    class RDocSource
+      attr_accessor :with_system_dir, :with_gems_dir, :with_site_dir, :with_home_dir
+
+      attr_reader :extra_dirs
+
+      attr_reader :stores
+
+      def initialize
+        self.with_system_dir = true
+        self.with_gems_dir = false
+        self.with_site_dir = false
+        self.with_home_dir = false
+
+        @extra_dirs = []
+        @stores = []
+      end
+
+      def load
+        @stores.clear()
+
+        RDoc::RI::Paths.each(with_system_dir, with_site_dir, with_home_dir, with_gems_dir ? :latest : false, *extra_dirs.map(&:to_s)) do |path, type|
+          store = RDoc::Store.new(path, type)
+          store.load_all
+
+          @stores << store
+        end
+      end
+
+      def find_class(typename)
+        classes = [] #: Array[::RDoc::ClassModule]
+
+        @stores.each do |store|
+          if klass = store.find_class_or_module(typename.relative!.to_s)
+            classes << klass
+          end
+        end
+
+        unless classes.empty?
+          classes
+        end
+      end
+
+      def docs
+        if ds = yield
+          unless ds.empty?
+            ds.map do |code_object|
+              case comment = code_object.comment
+              when String
+                raise
+              when RDoc::Comment
+                comment.parse
+              when RDoc::Markup::Document
+                comment
+              end
+            end
+          end
+        end
+      end
+
+      def class_docs(typename)
+        if classes = find_class(typename)
+          classes.map {|klass| klass.comment }
+        end
+      end
+
+      def find_const(const_name)
+        namespace =
+          if const_name.namespace.empty?
+            TypeName.parse("::Object")
+          else
+            const_name.namespace.to_type_name
+          end
+
+        if classes = find_class(namespace)
+          # @type var consts: Array[RDoc::Constant]
+          consts = []
+
+          classes.each do |klass|
+            if const = klass.constants.find {|c| c.name == const_name.name.to_s }
+              consts << const
+            end
+          end
+
+          unless consts.empty?
+            consts
+          end
+        end
+      end
+
+      def find_method(typename, instance_method: nil, singleton_method: nil)
+        if classes = find_class(typename)
+          # @type var methods: Array[RDoc::AnyMethod]
+          methods = []
+
+          classes.each do |klass|
+            klass.method_list.each do |method|
+              if instance_method && !method.singleton && method.name == instance_method.to_s
+                methods << method
+              end
+
+              if singleton_method && method.singleton && method.name == singleton_method.to_s
+                methods << method
+              end
+            end
+          end
+
+          unless methods.empty?
+            methods
+          end
+        end
+      end
+
+      def find_attribute(typename, name, singleton:)
+        if klasss = find_class(typename)
+          # @type var attrs: Array[RDoc::Attr]
+          attrs = []
+
+          klasss.each do |kls|
+            attrs.concat(kls.attributes.select {|attr| attr.singleton == singleton && attr.name == name.to_s })
+          end
+
+          attrs unless attrs.empty?
+        end
+      end
+    end
+  end
+end

data/lib/rbs/annotate.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "rdoc"
+
+require "rbs/annotate/rdoc_annotator"
+require "rbs/annotate/rdoc_source"
+require "rbs/annotate/annotations"
+require "rbs/annotate/formatter"

data/lib/rbs/ast/annotation.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RBS
+  module AST
+    class Annotation
+      attr_reader :string
+      attr_reader :location
+
+      def initialize(string:, location:)
+        @string = string
+        @location = location
+      end
+
+      def ==(other)
+        other.is_a?(Annotation) && other.string == string
+      end
+
+      alias eql? ==
+
+      def hash
+        self.class.hash ^ string.hash
+      end
+
+      def to_json(state = _ = nil)
+        { string: string, location: location }.to_json(state)
+      end
+    end
+  end
+end

data/lib/rbs/ast/comment.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RBS
+  module AST
+    class Comment
+      attr_reader :string
+      attr_reader :location
+
+      def initialize(string:, location:)
+        @string = string
+        @location = location
+      end
+
+      def ==(other)
+        other.is_a?(Comment) && other.string == string
+      end
+
+      alias eql? ==
+
+      def hash
+        self.class.hash ^ string.hash
+      end
+
+      def to_json(state = _ = nil)
+        { string: string, location: location }.to_json(state)
+      end
+    end
+  end
+end

data/lib/rbs/ast/declarations.rb

@@ -0,0 +1,467 @@
+# frozen_string_literal: true
+
+module RBS
+  module AST
+    module Declarations
+      class Base
+      end
+
+      module NestedDeclarationHelper
+        def each_member
+          if block_given?
+            members.each do |member|
+              if member.is_a?(Members::Base)
+                yield(_ = member)
+              end
+            end
+          else
+            enum_for :each_member
+          end
+        end
+
+        def each_decl
+          if block_given?
+            members.each do |member|
+              if member.is_a?(Base)
+                yield(_ = member)
+              end
+            end
+          else
+            enum_for :each_decl
+          end
+        end
+      end
+
+      module MixinHelper
+        def each_mixin(&block)
+          if block
+            @mixins ||= begin
+                          _ = members.select do |member|
+                            case member
+                            when Members::Include, Members::Extend, Members::Prepend
+                              true
+                            else
+                              false
+                            end
+                          end
+                        end
+            @mixins.each(&block)
+          else
+            enum_for :each_mixin
+          end
+        end
+      end
+
+      class Class < Base
+        class Super
+          attr_reader :name
+          attr_reader :args
+          attr_reader :location
+
+          def initialize(name:, args:, location:)
+            @name = name
+            @args = args
+            @location = location
+          end
+
+          def ==(other)
+            other.is_a?(Super) && other.name == name && other.args == args
+          end
+
+          alias eql? ==
+
+          def hash
+            self.class.hash ^ name.hash ^ args.hash
+          end
+
+          def to_json(state = _ = nil)
+            {
+              name: name,
+              args: args,
+              location: location
+            }.to_json(state)
+          end
+        end
+
+        include NestedDeclarationHelper
+        include MixinHelper
+
+        attr_reader :name
+        attr_reader :type_params
+        attr_reader :members
+        attr_reader :super_class
+        attr_reader :annotations
+        attr_reader :location
+        attr_reader :comment
+
+        def initialize(name:, type_params:, super_class:, members:, annotations:, location:, comment:)
+          @name = name
+          @type_params = type_params
+          @super_class = super_class
+          @members = members
+          @annotations = annotations
+          @location = location
+          @comment = comment
+        end
+
+        def update(name: self.name, type_params: self.type_params, super_class: self.super_class, members: self.members, annotations: self.annotations, location: self.location, comment: self.comment)
+          self.class.new(
+            name: name,
+            type_params: type_params,
+            super_class: super_class,
+            members: members,
+            annotations: annotations,
+            location: location,
+            comment: comment
+          )
+        end
+
+        def ==(other)
+          other.is_a?(Class) &&
+            other.name == name &&
+            other.type_params == type_params &&
+            other.super_class == super_class &&
+            other.members == members
+        end
+
+        alias eql? ==
+
+        def hash
+          self.class.hash ^ name.hash ^ type_params.hash ^ super_class.hash ^ members.hash
+        end
+
+        def to_json(state = _ = nil)
+          {
+            declaration: :class,
+            name: name,
+            type_params: type_params,
+            members: members,
+            super_class: super_class,
+            annotations: annotations,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+
+      class Module < Base
+        class Self
+          attr_reader :name
+          attr_reader :args
+          attr_reader :location
+
+          def initialize(name:, args:, location:)
+            @name = name
+            @args = args
+            @location = location
+          end
+
+          def ==(other)
+            other.is_a?(Self) && other.name == name && other.args == args
+          end
+
+          alias eql? ==
+
+          def hash
+            self.class.hash ^ name.hash ^ args.hash ^ location.hash
+          end
+
+          def to_json(state = _ = nil)
+            {
+              name: name,
+              args: args,
+              location: location
+            }.to_json(state)
+          end
+
+          def to_s
+            if args.empty?
+              name.to_s
+            else
+              "#{name}[#{args.join(", ")}]"
+            end
+          end
+        end
+
+        include NestedDeclarationHelper
+        include MixinHelper
+
+        attr_reader :name
+        attr_reader :type_params
+        attr_reader :members
+        attr_reader :location
+        attr_reader :annotations
+        attr_reader :self_types
+        attr_reader :comment
+
+        def initialize(name:, type_params:, members:, self_types:, annotations:, location:, comment:)
+          @name = name
+          @type_params = type_params
+          @self_types = self_types
+          @members = members
+          @annotations = annotations
+          @location = location
+          @comment = comment
+        end
+
+        def update(name: self.name, type_params: self.type_params, members: self.members, self_types: self.self_types, annotations: self.annotations, location: self.location, comment: self.comment)
+          self.class.new(
+            name: name,
+            type_params: type_params,
+            members: members,
+            self_types: self_types,
+            annotations: annotations,
+            location: location,
+            comment: comment
+          )
+        end
+
+
+        def ==(other)
+          other.is_a?(Module) &&
+            other.name == name &&
+            other.type_params == type_params &&
+            other.self_types == self_types &&
+            other.members == members
+        end
+
+        alias eql? ==
+
+        def hash
+          self.class.hash ^ name.hash ^ type_params.hash ^ self_types.hash ^ members.hash
+        end
+
+        def to_json(state = _ = nil)
+          {
+            declaration: :module,
+            name: name,
+            type_params: type_params,
+            members: members,
+            self_types: self_types,
+            annotations: annotations,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+
+      class Interface < Base
+        attr_reader :name
+        attr_reader :type_params
+        attr_reader :members
+        attr_reader :annotations
+        attr_reader :location
+        attr_reader :comment
+
+        include MixinHelper
+
+        def initialize(name:, type_params:, members:, annotations:, location:, comment:)
+          @name = name
+          @type_params = type_params
+          @members = members
+          @annotations = annotations
+          @location = location
+          @comment = comment
+        end
+
+        def update(name: self.name, type_params: self.type_params, members: self.members, annotations: self.annotations, location: self.location, comment: self.comment)
+          self.class.new(
+            name: name,
+            type_params: type_params,
+            members: members,
+            annotations: annotations,
+            location: location,
+            comment: comment
+          )
+        end
+
+        def ==(other)
+          other.is_a?(Interface) &&
+            other.name == name &&
+            other.type_params == type_params &&
+            other.members == members
+        end
+
+        alias eql? ==
+
+        def hash
+          self.class.hash ^ type_params.hash ^ members.hash
+        end
+
+        def to_json(state = _ = nil)
+          {
+            declaration: :interface,
+            name: name,
+            type_params: type_params,
+            members: members,
+            annotations: annotations,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+
+      class TypeAlias < Base
+        attr_reader :name
+        attr_reader :type_params
+        attr_reader :type
+        attr_reader :annotations
+        attr_reader :location
+        attr_reader :comment
+
+        def initialize(name:, type_params:, type:, annotations:, location:, comment:)
+          @name = name
+          @type_params = type_params
+          @type = type
+          @annotations = annotations
+          @location = location
+          @comment = comment
+        end
+
+        def ==(other)
+          other.is_a?(TypeAlias) &&
+            other.name == name &&
+            other.type_params == type_params &&
+            other.type == type
+        end
+
+        alias eql? ==
+
+        def hash
+          self.class.hash ^ name.hash ^ type_params.hash ^ type.hash
+        end
+
+        def to_json(state = _ = nil)
+          {
+            declaration: :alias,
+            name: name,
+            type_params: type_params,
+            type: type,
+            annotations: annotations,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+
+      class Constant < Base
+        attr_reader :name
+        attr_reader :type
+        attr_reader :location
+        attr_reader :comment
+
+        def initialize(name:, type:, location:, comment:)
+          @name = name
+          @type = type
+          @location = location
+          @comment = comment
+        end
+
+        def ==(other)
+          other.is_a?(Constant) &&
+            other.name == name &&
+            other.type == type
+        end
+
+        alias eql? ==
+
+        def hash
+          self.class.hash ^ name.hash ^ type.hash
+        end
+
+        def to_json(state = _ = nil)
+          {
+            declaration: :constant,
+            name: name,
+            type: type,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+
+      class Global < Base
+        attr_reader :name
+        attr_reader :type
+        attr_reader :location
+        attr_reader :comment
+
+        def initialize(name:, type:, location:, comment:)
+          @name = name
+          @type = type
+          @location = location
+          @comment = comment
+        end
+
+        def ==(other)
+          other.is_a?(Global) &&
+            other.name == name &&
+            other.type == type
+        end
+
+        alias eql? ==
+
+        def hash
+          self.class.hash ^ name.hash ^ type.hash
+        end
+
+        def to_json(state = _ = nil)
+          {
+            declaration: :global,
+            name: name,
+            type: type,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+
+      class AliasDecl < Base
+        attr_reader :new_name, :old_name, :location, :comment
+
+        def initialize(new_name:, old_name:, location:, comment:)
+          @new_name = new_name
+          @old_name = old_name
+          @location = location
+          @comment = comment
+        end
+
+        def ==(other)
+          other.is_a?(self.class) &&
+            other.new_name == new_name &&
+            other.old_name == old_name
+        end
+
+        alias eql? ==
+
+        def hash
+          self.class.hash ^ new_name.hash ^ old_name.hash
+        end
+      end
+
+      class ClassAlias < AliasDecl
+        def to_json(state = _ = nil)
+          {
+            declaration: :class_alias,
+            new_name: new_name,
+            old_name: old_name,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+
+      class ModuleAlias < AliasDecl
+        def to_json(state = _ = nil)
+          {
+            declaration: :module_alias,
+            new_name: new_name,
+            old_name: old_name,
+            location: location,
+            comment: comment
+          }.to_json(state)
+        end
+      end
+    end
+  end
+end

data/lib/rbs/ast/directives.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RBS
+  module AST
+    module Directives
+      class Base
+      end
+
+      class Use < Base
+        class SingleClause
+          attr_reader :type_name, :new_name, :location
+
+          def initialize(type_name:, new_name:, location:)
+            @type_name = type_name
+            @new_name = new_name
+            @location = location
+          end
+        end
+
+        class WildcardClause
+          attr_reader :namespace, :location
+
+          def initialize(namespace:, location:)
+            @location = location
+            @namespace = namespace
+          end
+        end
+
+        attr_reader :clauses, :location
+
+        def initialize(clauses:, location:)
+          @clauses = clauses
+          @location = location
+        end
+      end
+
+      class ResolveTypeNames < Base
+        attr_reader :location
+
+        attr_reader :value
+
+        def initialize(value:, location:)
+          @value = value
+          @location = location
+        end
+      end
+    end
+  end
+end