syntax_tree-rbs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eff99e85b92644bcfc8cf94291ec8e056c30cb72723bf98e571a0ffef264fcd8
+  data.tar.gz: 75ee446a19c76662c34bf17e323d0e26101cbb3cb173eb6546088e96e11fa867
+SHA512:
+  metadata.gz: 3121deff5c7b0b25889b95cecbe79ca611d140d00d6ebc52d6232696f944d882431c6d41f4b669bd4ec68f2452d1a48c18c4292d97c60d155491894886c73b11
+  data.tar.gz: 3a05df94b6b1be4115e39ce358b3dbba4846fd39cc592fbf5b73825e17fb7054bc0e8e9b0c8db585c85a46c75789deb16626c07cb9bcd51679b8e9b1b98cf5df

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: Main
+on:
+- push
+- pull_request_target
+jobs:
+  ci:
+    name: CI
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@master
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: '3.1'
+    - name: Test
+      run: bundle exec rake test
+  automerge:
+    name: AutoMerge
+    needs: ci
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
+    steps:
+    - uses: actions/github-script@v3
+      with:
+        script: |
+          github.pulls.merge({
+            owner: context.payload.repository.owner.login,
+            repo: context.payload.repository.name,
+            pull_number: context.payload.pull_request.number
+          })

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+test.rbs

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2022-04-05
+
+### Added
+
+- 🎉 Initial release! 🎉
+
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ruby-syntax-tree/syntax_tree-rbs/compare/93efc7...v0.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    syntax_tree-rbs (0.1.0)
+      rbs
+      syntax_tree (>= 2.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.4.0)
+    minitest (5.15.0)
+    rake (13.0.6)
+    rbs (2.3.2)
+    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.0.1)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  minitest
+  rake
+  simplecov
+  syntax_tree-rbs!
+
+BUNDLED WITH
+   2.3.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Kevin Newton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# SyntaxTree::RBS
+
+[![Build Status](https://github.com/ruby-syntax-tree/syntax_tree-rbs/actions/workflows/main.yml/badge.svg)](https://github.com/ruby-syntax-tree/syntax_tree-rbs/actions/workflows/main.yml)
+[![Gem Version](https://img.shields.io/gem/v/syntax_tree-rbs.svg)](https://rubygems.org/gems/syntax_tree-rbs)
+
+[Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) support for RBS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "syntax_tree-rbs"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install syntax_tree-rbs
+
+## Usage
+
+From code:
+
+```ruby
+require "syntax_tree/rbs"
+
+pp SyntaxTree::RBS.parse(source) # print out the AST
+puts SyntaxTree::RBS.format(source) # format the AST
+```
+
+From the CLI:
+
+```sh
+$ stree ast --plugins=rbs file.rbs
+(root declarations=[(constant name=(type-name "Hello") type=(class-instance (type-name "World")))])
+```
+
+or
+
+```sh
+$ stree format --plugins=rbs file.rbs
+Hello: World
+```
+
+or
+
+```sh
+$ stree write --plugins=rbs file.rbs
+file.rbs 1ms
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/syntax_tree-rbs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "syntax_tree/rbs"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/format

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+$:.unshift File.expand_path("../lib", __dir__)
+require "syntax_tree/rbs"
+
+puts SyntaxTree::RBS.format(ARGF.read)

data/bin/parse

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+$:.unshift File.expand_path("../lib", __dir__)
+require "syntax_tree/rbs"
+
+pp SyntaxTree::RBS.parse(ARGF.read)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/syntax_tree/rbs/declarations.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module RBS
+  module AST
+    module Declarations
+      class Alias
+        # Prints out a type alias, which is a declaration that looks like:
+        # type foo = String
+        def format(q)
+          SyntaxTree::RBS::Comment.maybe_format(q, comment)
+          SyntaxTree::RBS::Annotations.maybe_format(q, annotations)
+
+          q.group do
+            q.text("type ")
+            name.format(q)
+            q.text(" =")
+            q.group do
+              q.indent do
+                q.breakable
+                type.format(q)
+              end
+            end
+          end
+        end
+
+        def pretty_print(q)
+          q.group(2, "(constant", ")") do
+            SyntaxTree::RBS::Comment.maybe_pretty_print(q, comment)
+            SyntaxTree::RBS::Annotations.maybe_pretty_print(q, annotations)
+
+            q.breakable
+            q.text("name=")
+            q.pp(name)
+
+            q.breakable
+            q.text("type=")
+            q.pp(type)
+          end
+        end
+      end
+
+      class Class
+        # Prints out a class declarations, which looks like:
+        # class Foo end
+        def format(q)
+          SyntaxTree::RBS::Comment.maybe_format(q, comment)
+          SyntaxTree::RBS::Annotations.maybe_format(q, annotations)
+
+          q.group do
+            q.text("class ")
+            SyntaxTree::RBS::NameAndTypeParams.new(self).format(q)
+
+            if super_class
+              q.text(" < ")
+              SyntaxTree::RBS::NameAndArgs.new(super_class).format(q)
+            end
+
+            q.indent do
+              SyntaxTree::RBS::Members.new(self).format(q)
+            end
+
+            q.breakable(force: true)
+            q.text("end")
+          end
+        end
+
+        def pretty_print(q)
+          q.group(2, "(class", ")") do
+            SyntaxTree::RBS::Comment.maybe_pretty_print(q, comment)
+            SyntaxTree::RBS::Annotations.maybe_pretty_print(q, annotations)
+
+            q.pp(SyntaxTree::RBS::NameAndTypeParams.new(self))
+
+            if super_class
+              q.breakable
+              q.text("super_class=")
+              q.group(2, "(class", ")") do
+                q.pp(SyntaxTree::RBS::NameAndArgs.new(super_class))
+              end
+            end
+
+            q.breakable
+            q.text("members=")
+            q.pp(members)
+          end
+        end
+      end
+
+      class Constant
+        # Prints out a constant declaration, which looks like:
+        # Foo: String
+        def format(q)
+          SyntaxTree::RBS::Comment.maybe_format(q, comment)
+
+          q.group do
+            name.format(q)
+            q.text(": ")
+            type.format(q)
+          end
+        end
+
+        def pretty_print(q)
+          q.group(2, "(constant", ")") do
+            SyntaxTree::RBS::Comment.maybe_pretty_print(q, comment)
+
+            q.breakable
+            q.text("name=")
+            q.pp(name)
+
+            q.breakable
+            q.text("type=")
+            q.pp(type)
+          end
+        end
+      end
+
+      class Global
+        # Prints out a global declaration, which looks like:
+        # $foo: String
+        def format(q)
+          SyntaxTree::RBS::Comment.maybe_format(q, comment)
+
+          q.group do
+            q.text(name)
+            q.text(": ")
+            type.format(q)
+          end
+        end
+
+        def pretty_print(q)
+          q.group(2, "(global", ")") do
+            SyntaxTree::RBS::Comment.maybe_pretty_print(q, comment)
+
+            q.breakable
+            q.text("name=")
+            q.pp(name)
+
+            q.breakable
+            q.text("type=")
+            q.pp(type)
+          end
+        end
+      end
+
+      class Interface
+        # Prints out an interface declaration, which looks like:
+        # interface _Foo end
+        def format(q)
+          SyntaxTree::RBS::Comment.maybe_format(q, comment)
+          SyntaxTree::RBS::Annotations.maybe_format(q, annotations)
+
+          q.group do
+            q.text("interface ")
+            SyntaxTree::RBS::NameAndTypeParams.new(self).format(q)
+            q.indent { SyntaxTree::RBS::Members.new(self).format(q) }
+            q.breakable(force: true)
+            q.text("end")
+          end
+        end
+
+        def pretty_print(q)
+          q.group(2, "(interface", ")") do
+            SyntaxTree::RBS::Comment.maybe_pretty_print(q, comment)
+            SyntaxTree::RBS::Annotations.maybe_pretty_print(q, annotations)
+
+            q.pp(SyntaxTree::RBS::NameAndTypeParams.new(self))
+
+            q.breakable
+            q.text("members=")
+            q.pp(members)
+          end
+        end
+      end
+
+      class Module
+        # Prints out a module declaration, which looks like:
+        # module Foo end
+        def format(q)
+          SyntaxTree::RBS::Comment.maybe_format(q, comment)
+          SyntaxTree::RBS::Annotations.maybe_format(q, annotations)
+
+          q.group do
+            q.text("module ")
+            SyntaxTree::RBS::NameAndTypeParams.new(self).format(q)
+
+            if self_types.any?
+              q.text(" : ")
+              q.seplist(self_types, -> { q.text(", ") }) do |self_type|
+                SyntaxTree::RBS::NameAndArgs.new(self_type).format(q)
+              end
+            end
+
+            q.indent { SyntaxTree::RBS::Members.new(self).format(q) }
+            q.breakable(force: true)
+            q.text("end")
+          end
+        end
+
+        def pretty_print(q)
+          q.group(2, "(module", ")") do
+            SyntaxTree::RBS::Comment.maybe_pretty_print(q, comment)
+            SyntaxTree::RBS::Annotations.maybe_pretty_print(q, annotations)
+
+            q.pp(SyntaxTree::RBS::NameAndTypeParams.new(self))
+
+            if self_types.any?
+              q.breakable
+              q.text("self_types=")
+              q.group(2, "[", "]") do
+                q.seplist(self_types) do |self_type|
+                  q.group(2, "(self-type", ")") do
+                    q.pp(SyntaxTree::RBS::NameAndArgs.new(self_type))
+                  end
+                end
+              end
+            end
+
+            q.breakable
+            q.text("members=")
+            q.pp(members)
+          end
+        end
+      end
+    end
+  end
+end