rbs-inline 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '091f44026573a60f39acf39a0b8865a3cee4a4f72401cd0ab8ce37d9e397caad'
-  data.tar.gz: 95236c91fac2461db268a7fbd81503210d0d818bad958a6b9ff03d708a28558b
+  metadata.gz: 44afba2006b4ffed3719716d5ac515d474dc7ba9ee18c4f9b3298c9925441284
+  data.tar.gz: 2c008cd99c1de1a2cb80945eed727b74fe9450af07fd3d20299775d5ee728978
 SHA512:
-  metadata.gz: e76c5c6311109ffbac3a157625370a42f7f8b0cd2e1be58f8de4352d5e1528027acff819ecf7db6d9a6bb16bbb478adadfcb09d474816f7cc942a5a42be63729
-  data.tar.gz: 8d7d4aba2f04cac960975add67c7d7ad30366806a540cd899a11f1250a7045145a9578732c055cf75ad50d1a68949d6aea55c7f7e3077d958aafb042f7c52149
+  metadata.gz: d7d02d3e07d295c00890ac95bad4c2f7f49700a0cdddb9885dcc3c194d272ef5b387c168f675a46f2b5dc3f49aaeb5230603dbe7ebcea20087952aebb7516b66
+  data.tar.gz: 6e476d54d6db64e42cdc7a6bfe9dfb5b1454f290e2746836cc17fe77ca41db5dac2b1a01d311877af189ee7ad2bd06207f1db2aaac86e1e494dd5855e921254d

data/lib/rbs/inline/ast/declarations.rb

@@ -9,18 +9,8 @@ module RBS
           # @rbs returns TypeName?
           def type_name(node)
             case node
-            when Prism::ConstantReadNode
-              TypeName(node.name.to_s)
-            when Prism::ConstantPathNode
-              if node.parent
-                if parent = type_name(node.parent)
-                  if child = type_name(node.child)
-                    return parent + child
-                  end
-                end
-              else
-                type_name(node.child)&.absolute!
-              end
+            when Prism::ConstantReadNode, Prism::ConstantPathNode
+              TypeName(node.full_name)
             end
           end
         end

data/lib/rbs/inline/cli.rb

@@ -72,15 +72,28 @@ module RBS
       def run(args)
         base_paths = [Pathname("lib"), Pathname("app")]
         output_path = nil #: Pathname?
+        opt_in = true
 
         OptionParser.new do |opts|
-          opts.on("--base=[BASE]", "The path to calculate relative path of files (defaults to #{base_paths.join(File::PATH_SEPARATOR)})") do |str|
+          opts.on("--base=BASE", "The path to calculate relative path of files (defaults to #{base_paths.join(File::PATH_SEPARATOR)})") do |str|
             # @type var str: String
             base_paths = str.split(File::PATH_SEPARATOR).map {|path| Pathname(path) }
           end
 
-          opts.on("--output=[BASE]", "The directory where the RBS files are saved at (defaults to STDOUT if not specified)") do
-            output_path = Pathname(_1)
+          opts.on("--output[=DEST]", "Save the generated RBS files under `sig/generated` or DEST if specified (defaults to output to STDOUT)") do
+            if _1
+              output_path = Pathname(_1)
+            else
+              output_path = Pathname("sig/generated")
+            end
+          end
+
+          opts.on("--opt-out", "Generates RBS files by default. Opt-out with `# rbs_inline: disabled` comment") do
+            opt_in = false
+          end
+
+          opts.on("--opt-in", "Generates RBS files only for files with `# rbs_inline: enabled` comment (default)") do
+            opt_in = true
           end
 
           opts.on("--verbose") do
@@ -126,7 +139,7 @@ module RBS
 
           logger.debug { "Parsing ruby file #{target}..." }
 
-          if (uses, decls = Parser.parse(Prism.parse_file(target.to_s)))
+          if (uses, decls = Parser.parse(Prism.parse_file(target.to_s), opt_in: opt_in))
             writer = Writer.new()
             writer.header("Generated from #{target.relative? ? target : target.relative_path_from(Pathname.pwd)} with RBS::Inline")
             writer.write(uses, decls)

data/lib/rbs/inline/parser.rb

@@ -1,3 +1,5 @@
+# rbs_inline: enabled
+
 # @rbs use Prism::*
 
 module RBS
@@ -36,22 +38,26 @@ module RBS
         @comments = {}
       end
 
-      # @rbs result: ParseResult[ProgramNode]
+      # @rbs result: ParseResult
+      # @rbs opt_in: bool -- `true` for *opt-out* mode, `false` for *opt-in* mode.
       # @rbs returns [Array[AST::Annotations::Use], Array[AST::Declarations::t]]?
-      def self.parse(result)
+      def self.parse(result, opt_in:)
         instance = Parser.new()
 
-        # pp result
-
         annots = AnnotationParser.parse(result.comments)
         annots.each do |result|
           instance.comments[result.line_range.end] = result
         end
 
-        with_magic_comment = result.comments.any? {|comment| comment.location.slice =~ /\A# rbs_inline: enabled\Z/}
-        with_annotation = annots.any? {|result| result.annotations.any? }
+        with_enable_magic_comment = result.comments.any? {|comment| comment.location.slice =~ /\A# rbs_inline: enabled\Z/}
+        with_disable_magic_comment = result.comments.any? {|comment| comment.location.slice =~ /\A# rbs_inline: disabled\Z/}
 
-        return unless with_magic_comment || with_annotation
+        return if with_disable_magic_comment # Skips if `rbs_inline: disabled`
+
+        if opt_in
+          # opt-in means the `rbs_inline: enable` is required.
+          return unless with_enable_magic_comment
+        end
 
         uses = [] #: Array[AST::Annotations::Use]
         annots.each do |annot|

data/lib/rbs/inline/version.rb

@@ -2,6 +2,6 @@
 
 module RBS
   module Inline
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/rbs_collection.lock.yaml

@@ -38,7 +38,7 @@ gems:
   source:
     type: stdlib
 - name: prism
-  version: 0.24.0
+  version: 0.29.0
   source:
     type: rubygems
 - name: rake
@@ -46,7 +46,7 @@ gems:
   source:
     type: git
     name: ruby/gem_rbs_collection
-    revision: d2e93d426c927fdab90ef12e30a9875aa05d60d6
+    revision: 7a105f52053ce1c708b605dfa9c1ab8473424036
     remote: https://github.com/ruby/gem_rbs_collection.git
     repo_dir: gems
 - name: rbs

data/sig/generated/rbs/inline/parser.rbs

@@ -30,9 +30,10 @@ module RBS
 
       def initialize: () -> void
 
-      # @rbs result: ParseResult[ProgramNode]
+      # @rbs result: ParseResult
+      # @rbs opt_in: bool -- `true` for *opt-out* mode, `false` for *opt-in* mode.
       # @rbs returns [Array[AST::Annotations::Use], Array[AST::Declarations::t]]?
-      def self.parse: (ParseResult[ProgramNode] result) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t] ]?
+      def self.parse: (ParseResult result, opt_in: bool) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t] ]?
 
       # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
       def current_class_module_decl: () -> (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil)

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: rbs-inline
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.29'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: '0.30'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.29'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: '0.30'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement