rbi 0.1.8 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 502c584fe293212d2f14f1a6b8d76457645afe9a4bc6355cd32c2179bb9a4e68
-  data.tar.gz: 4ed5b4fd62249dec73277ab31fc07595f1cdcfacdec5d6f13de9951ccffecc0c
+  metadata.gz: 4161675b7c71e44d7f0f7ee6b2b6901509bc367ab9d34fdcdca5fb7dfb600cff
+  data.tar.gz: b34c191ab1806649d81e5620dcaf57a86b9a5881a164724f5f900176dde2e0d1
 SHA512:
-  metadata.gz: 84333e72029b10d6a9ee7fc2a2392e08d6e9fc2d0871deec2a35e6e1042fde559efba0de2df008b91fcecfff2ba1b1b414275fb6a29c0a2cc52db62b08ae9915
-  data.tar.gz: 1162d80c92024e93af674629594c726bd2b5b965bebc63150f6384f488d0a24dcf7c52f2c56552aecec2010d26352b43fc88e3191cbfc2a042ea8ea64eca7e00
+  metadata.gz: 2efc52240df29f1ddffed5daeff5d51c5b63a234d30219b70cf283e7b53086845f23f4438894991f864006198779bfaeea47857b60715086853c5eb321a6762b
+  data.tar.gz: fa1c376c7432db658ec2d8fa356e74dc9c22f55d2035743a7f28a603c4339df9102bfc95dbe6d1d05d18f0a453496836ae568209adbc3736de4bb64ca7e6385c

data/Gemfile

@@ -10,7 +10,7 @@ group(:development, :test) do
   gem("minitest")
   gem("minitest-reporters")
   gem("rake", "~> 13.1")
-  gem("rubocop", "~> 1.60", require: false)
+  gem("rubocop", "~> 1.62", require: false)
   gem("rubocop-shopify", require: false)
   gem("rubocop-sorbet", require: false)
   gem("sorbet", ">= 0.5.9204", require: false)

data/lib/rbi/index.rb

@@ -70,7 +70,7 @@ module RBI
     end
   end
 
-  # A Node that can be refered to by a unique ID inside an index
+  # A Node that can be referred to by a unique ID inside an index
   module Indexable
     extend T::Sig
     extend T::Helpers

data/lib/rbi/model.rb

@@ -534,6 +534,79 @@ module RBI
       @params << param
     end
 
+    sig { params(name: String).void }
+    def add_param(name)
+      @params << ReqParam.new(name)
+    end
+
+    sig { params(name: String, default_value: String).void }
+    def add_opt_param(name, default_value)
+      @params << OptParam.new(name, default_value)
+    end
+
+    sig { params(name: String).void }
+    def add_rest_param(name)
+      @params << RestParam.new(name)
+    end
+
+    sig { params(name: String).void }
+    def add_kw_param(name)
+      @params << KwParam.new(name)
+    end
+
+    sig { params(name: String, default_value: String).void }
+    def add_kw_opt_param(name, default_value)
+      @params << KwOptParam.new(name, default_value)
+    end
+
+    sig { params(name: String).void }
+    def add_kw_rest_param(name)
+      @params << KwRestParam.new(name)
+    end
+
+    sig { params(name: String).void }
+    def add_block_param(name)
+      @params << BlockParam.new(name)
+    end
+
+    sig do
+      params(
+        params: T::Array[SigParam],
+        return_type: T.nilable(String),
+        is_abstract: T::Boolean,
+        is_override: T::Boolean,
+        is_overridable: T::Boolean,
+        is_final: T::Boolean,
+        type_params: T::Array[String],
+        checked: T.nilable(Symbol),
+        block: T.proc.params(node: Sig).void,
+      ).void
+    end
+    def add_sig(
+      params: [],
+      return_type: nil,
+      is_abstract: false,
+      is_override: false,
+      is_overridable: false,
+      is_final: false,
+      type_params: [],
+      checked: nil,
+      &block
+    )
+      sig = Sig.new(
+        params: params,
+        return_type: return_type,
+        is_abstract: is_abstract,
+        is_override: is_override,
+        is_overridable: is_overridable,
+        is_final: is_final,
+        type_params: type_params,
+        checked: checked,
+        &block
+      )
+      @sigs << sig
+    end
+
     sig { returns(String) }
     def fully_qualified_name
       if is_singleton
@@ -1085,6 +1158,11 @@ module RBI
       @params << param
     end
 
+    sig { params(name: String, type: String).void }
+    def add_param(name, type)
+      @params << SigParam.new(name, type)
+    end
+
     sig { params(other: Object).returns(T::Boolean) }
     def ==(other)
       return false unless other.is_a?(Sig)

data/lib/rbi/rewriters/filter_versions.rb

@@ -0,0 +1,123 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RBI
+  module Rewriters
+    # Take a gem version and filter out all RBI that is not relevant to that version based on @version annotations
+    # in comments. As an example:
+    #
+    # ~~~rb
+    # tree = Parser.parse_string(<<~RBI)
+    #   class Foo
+    #     # @version > 0.3.0
+    #     def bar
+    #     end
+    #
+    #     # @version <= 0.3.0
+    #     def bar(arg1)
+    #     end
+    #   end
+    # RBI
+    #
+    # Rewriters::FilterVersions.filter(tree, Gem::Version.new("0.3.1"))
+    #
+    # assert_equal(<<~RBI, tree.string)
+    #   class Foo
+    #     # @version > 0.3.0
+    #     def bar
+    #     end
+    #   end
+    # RBI
+    # ~~~
+    #
+    # Supported operators:
+    # - equals `=`
+    # - not equals `!=`
+    # - greater than `>`
+    # - greater than or equal to `>=`
+    # - less than `<`
+    # - less than or equal to `<=`
+    # - pessimistic or twiddle-wakka`~>`
+    #
+    # And/or logic:
+    # - "And" logic: put multiple versions on the same line
+    #   - e.g. `@version > 0.3.0, <1.0.0` means version must be greater than 0.3.0 AND less than 1.0.0
+    # - "Or" logic: put multiple versions on subsequent lines
+    #   - e.g. the following means version must be less than 0.3.0 OR greater than 1.0.0
+    #       ```
+    #       # @version < 0.3.0
+    #       # @version > 1.0.0
+    #       ```
+    # Prerelease versions:
+    # - Prerelease versions are considered less than their non-prerelease counterparts
+    #   - e.g. `0.4.0-prerelease` is less than `0.4.0`
+    #
+    # RBI with no versions:
+    # - RBI with no version annotations are automatically counted towards ALL versions
+    class FilterVersions < Visitor
+      extend T::Sig
+
+      VERSION_PREFIX = "version "
+
+      class << self
+        extend T::Sig
+
+        sig { params(tree: Tree, version: Gem::Version).void }
+        def filter(tree, version)
+          v = new(version)
+          v.visit(tree)
+        end
+      end
+
+      sig { params(version: Gem::Version).void }
+      def initialize(version)
+        super()
+        @version = version
+      end
+
+      sig { override.params(node: T.nilable(Node)).void }
+      def visit(node)
+        return unless node
+
+        unless node.satisfies_version?(@version)
+          node.detach
+          return
+        end
+
+        visit_all(node.nodes.dup) if node.is_a?(Tree)
+      end
+    end
+  end
+
+  class Node
+    sig { params(version: Gem::Version).returns(T::Boolean) }
+    def satisfies_version?(version)
+      return true unless is_a?(NodeWithComments)
+
+      requirements = version_requirements
+      requirements.empty? || requirements.any? { |req| req.satisfied_by?(version) }
+    end
+  end
+
+  class NodeWithComments
+    sig { returns(T::Array[Gem::Requirement]) }
+    def version_requirements
+      annotations.select do |annotation|
+        annotation.start_with?(Rewriters::FilterVersions::VERSION_PREFIX)
+      end.map do |annotation|
+        versions = annotation.delete_prefix(Rewriters::FilterVersions::VERSION_PREFIX).split(/, */)
+        Gem::Requirement.new(versions)
+      end
+    end
+  end
+
+  class Tree
+    extend T::Sig
+
+    sig { params(version: Gem::Version).void }
+    def filter_versions!(version)
+      visitor = Rewriters::FilterVersions.new(version)
+      visitor.visit(self)
+    end
+  end
+end

data/lib/rbi/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RBI
-  VERSION = "0.1.8"
+  VERSION = "0.1.10"
 end

data/lib/rbi.rb

@@ -10,6 +10,7 @@ require "rbi/index"
 require "rbi/rewriters/add_sig_templates"
 require "rbi/rewriters/annotate"
 require "rbi/rewriters/deannotate"
+require "rbi/rewriters/filter_versions"
 require "rbi/rewriters/merge_trees"
 require "rbi/rewriters/nest_singleton_methods"
 require "rbi/rewriters/nest_non_public_methods"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbi
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -19,7 +19,7 @@ dependencies:
         version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.22'
+        version: '0.25'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +64,7 @@ files:
 - lib/rbi/rewriters/add_sig_templates.rb
 - lib/rbi/rewriters/annotate.rb
 - lib/rbi/rewriters/deannotate.rb
+- lib/rbi/rewriters/filter_versions.rb
 - lib/rbi/rewriters/group_nodes.rb
 - lib/rbi/rewriters/merge_trees.rb
 - lib/rbi/rewriters/nest_non_public_methods.rb
@@ -92,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.7
 signing_key: 
 specification_version: 4
 summary: RBI generation framework