syntax_tree-rbs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0550ed09644f60c85734f0633143c5fa621356c9fada7f073446070037ca2e
-  data.tar.gz: fbad990727e58695a58c37cbf31eea3a0f5ed418b4666d38416a8b4fe2aecdaf
+  metadata.gz: 22d2b985f00c4722c74fad681a8ee586a6bebbf3fbc2aa0a6476fce331379bed
+  data.tar.gz: 9d077e966f23b4777f0d4a8d41ff4a6cde08493c8759f8b399d2f494cc3abc2f
 SHA512:
-  metadata.gz: 1c95de371dba5bbffb0b8d78251f77c6143de8db74c17576ae674125b46173db0b35d65ab97eb6ebd8cf44e91311e33a138c78ff84ab5b17c13d0cb914217af9
-  data.tar.gz: d4bf5bc46aa49848425f119937e45e9e15f131e0dc623b8f6bc4c3f93863cb21a5ce824fbca5aa6fbcf9f34129dd1093eb1ee16806cc27003b3b3b21382d3021
+  metadata.gz: fc9cc4ff0703d4ade8295ff7784082f1d4372340ba2bb5094c9f928d5c11726c08437669a8a3b9fb001715b859f2085ce2ca543176541fbebf9ad61ee3fd249b
+  data.tar.gz: ad7b5984c280199385c501a743587c06455db0a0d86ffc7072971597113bf3aad4b9a6de794d5d3f2577fba26a95d682a53ccb40d4facbafc767d9f45834e59c

data/.github/workflows/main.yml

@@ -26,7 +26,9 @@ jobs:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
     - name: Test
-      run: bundle exec rake test
+      run: |
+        bundle exec rake test
+        bundle exec rake stree:check
   automerge:
     name: AutoMerge
     needs: ci

data/CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [0.5.0] - 2022-07-07
+
+### Added
+
+- A new `SyntaxTree::RBS::Visitor` class that can be used to walk the tree. All `RBS` nodes now respond to `accept(visitor)` which will delegate to the appropriate methods.
+
+### Changed
+
+- Ensure optional proc types have parentheses around them.
+
 ## [0.4.0] - 2022-05-13
 
 ### Added
@@ -32,7 +42,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/v0.4.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/v0.1.0...v0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree-rbs (0.4.0)
+    syntax_tree-rbs (0.5.0)
       prettier_print
       rbs
       syntax_tree (>= 2.0.1)
@@ -10,17 +10,17 @@ GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    minitest (5.15.0)
+    minitest (5.16.2)
     prettier_print (0.1.0)
     rake (13.0.6)
-    rbs (2.4.0)
+    rbs (2.6.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    syntax_tree (2.5.0)
+    syntax_tree (3.0.0)
       prettier_print
 
 PLATFORMS

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "syntax_tree/rake_tasks"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,10 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+SOURCE_FILES =
+  FileList[%w[Gemfile Rakefile syntax_tree-rbs.gemspec lib/**/*.rb test/*.rb]]
+
+SyntaxTree::Rake::CheckTask.new { |t| t.source_files = SOURCE_FILES }
+SyntaxTree::Rake::WriteTask.new { |t| t.source_files = SOURCE_FILES }
+
 task default: :test

data/lib/syntax_tree/rbs/entrypoints.rb

@@ -0,0 +1,392 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module RBS
+    # These are the methods that are going to be defined on each node of the
+    # AST. They each will create a visitor and enter into the visitor's walking
+    # algorithm.
+    module Entrypoints
+      def format(q)
+        accept(Format.new(q))
+      end
+
+      def pretty_print(q)
+        accept(PrettyPrint.new(q))
+      end
+    end
+
+    # This is the root node of the entire tree. It contains all of the top-level
+    # declarations within the file.
+    class Root
+      include Entrypoints
+
+      attr_reader :declarations
+
+      def initialize(declarations)
+        @declarations = declarations
+      end
+
+      def accept(visitor)
+        visitor.visit_root(self)
+      end
+    end
+  end
+end
+
+module RBS
+  class TypeName
+    include SyntaxTree::RBS::Entrypoints
+
+    def accept(visitor)
+      visitor.visit_type_name(self)
+    end
+  end
+
+  module AST
+    module Declarations
+      class Base
+        include SyntaxTree::RBS::Entrypoints
+      end
+
+      # type foo = String
+      class Alias
+        def accept(visitor)
+          visitor.visit_alias_declaration(self)
+        end
+      end
+
+      # class Foo end
+      class Class
+        def accept(visitor)
+          visitor.visit_class_declaration(self)
+        end
+      end
+
+      # Foo: String
+      class Constant
+        def accept(visitor)
+          visitor.visit_constant_declaration(self)
+        end
+      end
+
+      # $foo: String
+      class Global
+        def accept(visitor)
+          visitor.visit_global_declaration(self)
+        end
+      end
+
+      # interface _Foo end
+      class Interface
+        def accept(visitor)
+          visitor.visit_interface_declaration(self)
+        end
+      end
+
+      # module Foo end
+      class Module
+        def accept(visitor)
+          visitor.visit_module_declaration(self)
+        end
+      end
+    end
+
+    module Members
+      class Base
+        include SyntaxTree::RBS::Entrypoints
+      end
+
+      # alias foo bar
+      # alias self.foo self.bar
+      class Alias
+        def accept(visitor)
+          visitor.visit_alias_member(self)
+        end
+      end
+
+      # attr_accessor foo: Foo
+      class AttrAccessor
+        def accept(visitor)
+          visitor.visit_attr_accessor_member(self)
+        end
+      end
+
+      # attr_reader foo: Foo
+      class AttrReader
+        def accept(visitor)
+          visitor.visit_attr_reader_member(self)
+        end
+      end
+
+      # attr_writer foo: Foo
+      class AttrWriter
+        def accept(visitor)
+          visitor.visit_attr_writer_member(self)
+        end
+      end
+
+      # self.@foo: String
+      class ClassInstanceVariable
+        def accept(visitor)
+          visitor.visit_class_instance_variable_member(self)
+        end
+      end
+
+      # @@foo: String
+      class ClassVariable
+        def accept(visitor)
+          visitor.visit_class_variable_member(self)
+        end
+      end
+
+      # extend Foo
+      class Extend
+        def accept(visitor)
+          visitor.visit_extend_member(self)
+        end
+      end
+
+      # include Foo
+      class Include
+        def accept(visitor)
+          visitor.visit_include_member(self)
+        end
+      end
+
+      # @foo: String
+      class InstanceVariable
+        def accept(visitor)
+          visitor.visit_instance_variable_member(self)
+        end
+      end
+
+      # def t: (T t) -> void
+      class MethodDefinition
+        def accept(visitor)
+          visitor.visit_method_definition_member(self)
+        end
+      end
+
+      # prepend Foo
+      class Prepend
+        def accept(visitor)
+          visitor.visit_prepend_member(self)
+        end
+      end
+
+      # private
+      class Private
+        def accept(visitor)
+          visitor.visit_private_member(self)
+        end
+      end
+
+      # public
+      class Public
+        def accept(visitor)
+          visitor.visit_public_member(self)
+        end
+      end
+    end
+  end
+
+  module Types
+    # Foo
+    class Alias
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_alias_type(self)
+      end
+    end
+
+    # any
+    class Bases::Any
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_any_type(self)
+      end
+    end
+
+    # bool
+    class Bases::Bool
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_bool_type(self)
+      end
+    end
+
+    # bottom
+    class Bases::Bottom
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_bottom_type(self)
+      end
+    end
+
+    # class
+    class Bases::Class
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_class_type(self)
+      end
+    end
+
+    # instance
+    class Bases::Instance
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_instance_type(self)
+      end
+    end
+
+    # nil
+    class Bases::Nil
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_nil_type(self)
+      end
+    end
+
+    # self
+    class Bases::Self
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_self_type(self)
+      end
+    end
+
+    # top
+    class Bases::Top
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_top_type(self)
+      end
+    end
+
+    # void
+    class Bases::Void
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_void_type(self)
+      end
+    end
+
+    # Foo
+    class ClassInstance
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_class_instance_type(self)
+      end
+    end
+
+    # singleton(Foo)
+    class ClassSingleton
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_class_singleton_type(self)
+      end
+    end
+
+    # Foo foo
+    class Function::Param
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_function_param_type(self)
+      end
+    end
+
+    # _Foo
+    class Interface
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_interface_type(self)
+      end
+    end
+
+    # foo & bar
+    class Intersection
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_intersection_type(self)
+      end
+    end
+
+    # 1
+    class Literal
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_literal_type(self)
+      end
+    end
+
+    # foo?
+    class Optional
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_optional_type(self)
+      end
+    end
+
+    # ^-> void
+    class Proc
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_proc_type(self)
+      end
+    end
+
+    # { foo: bar }
+    class Record
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_record_type(self)
+      end
+    end
+
+    # [foo, bar]
+    class Tuple
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_tuple_type(self)
+      end
+    end
+
+    # foo | bar
+    class Union
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_union_type(self)
+      end
+    end
+
+    # foo
+    class Variable
+      include SyntaxTree::RBS::Entrypoints
+
+      def accept(visitor)
+        visitor.visit_variable_type(self)
+      end
+    end
+  end
+end