rbi 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ec679e5a50e9325d794c32a93ca12eb08aff102e12b21e6476a172b8001cba
-  data.tar.gz: 5abffaaba601923ebe58dd49e5c59aba2faf41a73ee4571b15e157c5f220297f
+  metadata.gz: fb13c49bd19a95d439f7249770add05929979892daa3ba9c55de8241a596a8d2
+  data.tar.gz: bc772396cd7997b9443782775854993cb9e4b0d1241415020c258aa8f49186b2
 SHA512:
-  metadata.gz: dfebab9782d4817841ec80c87d81ff9919df026de13614fe056bc4ca0cd9ab4546f861c230172023d8f3c185b60b1155e076c7ef22ef420421bd1203879f15b0
-  data.tar.gz: bae1339fd94ad30d5d6997611b1ac14fc36d9119607a32f954ab2361112c5ec5c31181636409df223c190348477917cf2e27da3d2bae0551295836273e59fcbb
+  metadata.gz: 9990c9fd5fa2bc0925f06ce07f02079165f431e9535874d0204b0e2afbc6ad1919578e3ecd13a33b69ef575ec84911fadb34d3a71df917437fd46182bb07aa6e
+  data.tar.gz: 2818b3db38a03e58eb8bd6dd160ca50fac237242192620a6910dd73c451a3ee90e5dd483502e721870329724f0b4237899225d3c4e5f429b37abd667e0183c87

data/Gemfile

@@ -5,9 +5,13 @@ source "https://rubygems.org"
 
 gemspec
 
-group(:development) do
-  gem('rubocop-shopify', require: false)
-  gem('rubocop-sorbet', require: false)
-  gem('byebug')
-  gem('pry-byebug')
+group(:development, :test) do
+  gem("byebug")
+  gem("minitest")
+  gem("rake", "~> 13.0")
+  gem("rubocop", "~> 1.7", require: false)
+  gem("rubocop-shopify", require: false)
+  gem("rubocop-sorbet", require: false)
+  gem("sorbet", require: false)
+  gem("tapioca", require: false, github: "Shopify/tapioca", branch: "master")
 end

data/README.md

@@ -1,8 +1,6 @@
-# Rbi
+# RBI generation framework
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rbi`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+`RBI` provides a Ruby API to compose Ruby interface files consumed by Sorbet.
 
 ## Installation
 
@@ -14,7 +12,7 @@ gem 'rbi'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -22,17 +20,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```rb
+require "rbi"
+
+rbi = RBI::File.new(strictness: "true") do |file|
+  file << RBI::Module.new("Foo") do |mod|
+    mod << RBI::Method.new("foo")
+  end
+end
+
+puts rbi.string
+```
+
+will produce:
+
+```rb
+# typed: true
+
+module Foo
+  def foo; end
+end
+```
+
+## Features
+
+* RBI generation API
+* RBI parsing with Whitequark
+* RBI formatting
+* RBI validation
+* RBI merging
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-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).
+This repo uses itself (`rbi`) to retrieve and generate gem RBIs. You can run `dev rbi` to update local gem RBIs with RBIs from the central repo.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rbi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/rbi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Shopify/rbi/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -40,4 +68,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rbi project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rbi/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rbi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rbi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,7 +1,9 @@
 # typed: true
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"

data/lib/rbi/index.rb

@@ -0,0 +1,186 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RBI
+  class Index < Visitor
+    extend T::Sig
+    include T::Enumerable
+
+    sig { params(node: Node).returns(Index) }
+    def self.index(*node)
+      index = Index.new
+      index.visit_all(node)
+      index
+    end
+
+    sig { void }
+    def initialize
+      super()
+      @index = T.let({}, T::Hash[String, T::Array[Node]])
+    end
+
+    sig { returns(T::Array[String]) }
+    def keys
+      @index.keys
+    end
+
+    sig { params(id: String).returns(T::Array[Node]) }
+    def [](id)
+      @index[id] ||= []
+    end
+
+    sig { params(node: T.all(Indexable, Node)).void }
+    def index(node)
+      node.index_ids.each { |id| self[id] << node }
+    end
+
+    sig { override.params(node: T.nilable(Node)).void }
+    def visit(node)
+      return unless node
+
+      case node
+      when Scope
+        index(node)
+        visit_all(node.nodes)
+      when Tree
+        visit_all(node.nodes)
+      when Indexable
+        index(node)
+      end
+    end
+  end
+
+  class Tree
+    extend T::Sig
+
+    sig { returns(Index) }
+    def index
+      Index.index(self)
+    end
+  end
+
+  # A Node that can be refered to by a unique ID inside an index
+  module Indexable
+    extend T::Sig
+    extend T::Helpers
+
+    interface!
+
+    # Unique IDs that refer to this node.
+    #
+    # Some nodes can have multiple ids, for example an attribute accessor matches the ID of the
+    # getter and the setter.
+    sig { abstract.returns(T::Array[String]) }
+    def index_ids; end
+  end
+
+  class Scope
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      [fully_qualified_name]
+    end
+  end
+
+  class Const
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      [fully_qualified_name]
+    end
+  end
+
+  class Attr
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      fully_qualified_names
+    end
+  end
+
+  class Method
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      [fully_qualified_name]
+    end
+  end
+
+  class Include
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      names.map { |name| "#{parent_scope&.fully_qualified_name}.include(#{name})" }
+    end
+  end
+
+  class Extend
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      names.map { |name| "#{parent_scope&.fully_qualified_name}.extend(#{name})" }
+    end
+  end
+
+  class MixesInClassMethods
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      names.map { |name| "#{parent_scope&.fully_qualified_name}.mixes_in_class_method(#{name})" }
+    end
+  end
+
+  class Helper
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      [to_s]
+    end
+  end
+
+  class TStructConst
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      fully_qualified_names
+    end
+  end
+
+  class TStructProp
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      fully_qualified_names
+    end
+  end
+
+  class TEnumBlock
+    extend T::Sig
+    include Indexable
+
+    sig { override.returns(T::Array[String]) }
+    def index_ids
+      [to_s]
+    end
+  end
+end

data/lib/rbi/loc.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RBI
+  class Loc
+    extend T::Sig
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :file
+
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :begin_line, :end_line, :begin_column, :end_column
+
+    sig do
+      params(
+        file: T.nilable(String),
+        begin_line: T.nilable(Integer),
+        end_line: T.nilable(Integer),
+        begin_column: T.nilable(Integer),
+        end_column: T.nilable(Integer)
+      ).void
+    end
+    def initialize(file: nil, begin_line: nil, end_line: nil, begin_column: nil, end_column: nil)
+      @file = file
+      @begin_line = begin_line
+      @end_line = end_line
+      @begin_column = begin_column
+      @end_column = end_column
+    end
+
+    sig { returns(String) }
+    def to_s
+      "#{file}:#{begin_line}:#{begin_column}-#{end_line}:#{end_column}"
+    end
+  end
+end