rbs-inline 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1a71b1f31f0a31d47ce7d19bde6f0145203c52e830f781dad464be32f46402b
-  data.tar.gz: fbccd964aaaff4af93ee63a72a6b52e610bd3e66c5a12f3e042c180096e40d14
+  metadata.gz: '091f44026573a60f39acf39a0b8865a3cee4a4f72401cd0ab8ce37d9e397caad'
+  data.tar.gz: 95236c91fac2461db268a7fbd81503210d0d818bad958a6b9ff03d708a28558b
 SHA512:
-  metadata.gz: bbf05cddf2f37f7d1f9de08e0267c77b1af127560b6de0ed0710267579057b0c4c8000462da0faf375754d5da9a927da3b1c7df289b1614e4d60558ba1722619
-  data.tar.gz: b0af1f6f5640604ea3b812c3f6df6dbcd8cc87e41c04ef72fe325928511a5ba73520a0e898f3998151e657a2f4d346022a503f1e6bbb8de67e6dec92f810df1e
+  metadata.gz: e76c5c6311109ffbac3a157625370a42f7f8b0cd2e1be58f8de4352d5e1528027acff819ecf7db6d9a6bb16bbb478adadfcb09d474816f7cc942a5a42be63729
+  data.tar.gz: 8d7d4aba2f04cac960975add67c7d7ad30366806a540cd899a11f1250a7045145a9578732c055cf75ad50d1a68949d6aea55c7f7e3077d958aafb042f7c52149

data/README.md

@@ -3,11 +3,16 @@
 RBS::Inline allows embedding RBS type declarations into Ruby code as comments. You can declare types, write the implementation, and verifies they are consistent without leaving the editor opening the Ruby code.
 
 > [!IMPORTANT]
-> The gem is experimental. We are still seeking the best syntax with your feedbacks.
+> The syntax is experimental. We are still seeking the best syntax with your feedbacks.
+
+> [!IMPORTANT]
+> This gem is a prototype for testing. We plan to merge this feature to rbs-gem and deprecate rbs-inline gem after that.
 
 Here is a quick example of embedded declarations.
 
 ```rb
+# rbs_inline: enabled
+
 class Person
   attr_reader :name #:: String
 

data/lib/rbs/inline/annotation_parser.rb

@@ -501,7 +501,7 @@ module RBS
       #
       # ```
       # Integer -- Foo        # => Returns `Integer`, tokenizer has `--` as its current token
-      # Integer[ -- Foo       # => Returns a tree for `Integer[`, tokenizer has `--` as its curren token
+      # Integer[ -- Foo       # => Returns a tree for `Integer[`, tokenizer has `--` as its current token
       # Integer[ Foo          # => Returns a tree for `Integer[ Foo`, tokenizer is at the end of the input
       # ```
       #

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

@@ -69,7 +69,7 @@ module RBS
           # [FIXME] It only supports `self` receiver.
           #
           # ```rb
-          # def self.foo = ()    # :sigleton
+          # def self.foo = ()    # :singleton
           # def object.foo = ()  # Not supported (returns :instance)
           # ```
           #
@@ -578,7 +578,7 @@ module RBS
               end
             RBS
 
-            _, dirs, decls = RBS::Parser.parse_signature(source)
+            _, _, decls = RBS::Parser.parse_signature(source)
 
             mod = decls[0]
             mod.is_a?(RBS::AST::Declarations::Module) or raise

data/lib/rbs/inline/cli.rb

@@ -5,6 +5,56 @@ require "optparse"
 module RBS
   module Inline
     class CLI
+      # Calculate the path under `output_path` that has the same structure relative to one of the `base_paths`
+      #
+      # ```rb
+      # calculator = PathCalculator.new(Pathname("/rbs-inline"), [Pathname("app"), Pathname("lib")], Pathname("/tmp/sig"))
+      # calculator.calculate(Pathname("/rbs-inline/app/models/foo.rb"))   # => Pathname("/tmp/sig/models/foo.rb")
+      # calculator.calculate(Pathname("/rbs-inline/lib/bar.rb"))          # => Pathname("/tmp/sig/bar.rb")
+      # calculator.calculate(Pathname("/rbs-inline/hello/world.rb"))      # => Pathname("/tmp/sig/hello/world.rb")
+      # calculator.calculate(Pathname("/foo.rb"))                         # => nil
+      # ```
+      #
+      #
+      class PathCalculator
+        attr_reader :pwd #:: Pathname
+
+        attr_reader :base_paths #:: Array[Pathname]
+
+        attr_reader :output_path #:: Pathname
+
+        # @rbs pwd: Pathname
+        # @rbs base_paths: Array[Pathname]
+        # @rbs output_path: Pathname
+        def initialize(pwd, base_paths, output_path) #:: void
+          @pwd = pwd
+          @base_paths = base_paths
+          @output_path = output_path
+        end
+
+        #:: (Pathname) -> Pathname?
+        def calculate(path)
+          path = pwd + path if path.relative?
+          path = path.cleanpath
+          return nil unless has_prefix?(path, prefix: pwd)
+
+          if prefix = base_paths.find {|base| has_prefix?(path, prefix: pwd + base) }
+            relative_to_output = path.relative_path_from(pwd + prefix)
+          else
+            relative_to_output = path.relative_path_from(pwd)
+          end
+
+          output_path + relative_to_output
+        end
+
+        # @rbs path: Pathname
+        # @rbs prefix: Pathname
+        # @rbs returns bool
+        def has_prefix?(path, prefix:)
+          path.descend.include?(prefix)
+        end
+      end
+
       attr_reader :stdout, :stderr #:: IO
       attr_reader :logger #:: Logger
 
@@ -20,12 +70,13 @@ module RBS
       # @rbs args: Array[String]
       # @rbs returns Integer
       def run(args)
-        base_path = Pathname("lib")
+        base_paths = [Pathname("lib"), Pathname("app")]
         output_path = nil #: Pathname?
 
         OptionParser.new do |opts|
-          opts.on("--base=[BASE]", "The path to calculate relative path of files (defaults to #{base_path})") do
-            base_path = Pathname(_1)
+          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
@@ -37,17 +88,17 @@ module RBS
           end
         end.parse!(args)
 
-        base_path = Pathname.pwd + base_path
+        logger.debug { "base_paths = #{base_paths.join(File::PATH_SEPARATOR)}, output_path = #{output_path}" }
 
-        logger.debug { "base_path = #{base_path}, output_path = #{output_path}" }
-
-        targets = args.flat_map do
-          path = Pathname(_1)
+        if output_path
+          calculator = PathCalculator.new(Pathname.pwd, base_paths, output_path)
+        end
 
+        targets = args.flat_map { Pathname.glob(_1) }.flat_map do |path|
           if path.directory?
             pattern = path + "**/*.rb"
             Pathname.glob(pattern.to_s)
-          else 
+          else
             path
           end
         end
@@ -58,12 +109,14 @@ module RBS
         count = 0
 
         targets.each do |target|
-          relative_path = (Pathname.pwd + target).relative_path_from(base_path)
-          if output_path
-            output = output_path + relative_path.sub_ext(".rbs")
+          absolute_path = Pathname.pwd + target
 
-            unless output.to_s.start_with?(output_path.to_s)
-              raise "Cannot calculate the output file path for #{target} in #{output_path}"
+          if output_path && calculator
+            output_file_path = calculator.calculate(absolute_path)
+            if output_file_path
+              output = output_file_path.sub_ext(".rbs")
+            else
+              raise "Cannot calculate the output file path for #{target} in #{output_path}: calculated = #{output}"
             end
 
             logger.debug { "Generating #{output} from #{target} ..." }
@@ -84,14 +137,18 @@ module RBS
                 output.parent.mkpath
               end
 
-              logger.debug { "Writing RBS file to #{output}..." }
-              output.write(writer.output)
+              if output.file? && output.read == writer.output
+                logger.debug { "Skip writing identical RBS file" }
+              else
+                logger.debug { "Writing RBS file to #{output}..." }
+                output.write(writer.output)
+                count += 1
+              end
             else
               stdout.puts writer.output
               stdout.puts
+              count += 1
             end
-
-            count += 1
           else
             logger.debug { "Skipping #{target} because `# rbs_inline: enabled` comment not found" }
           end

data/lib/rbs/inline/parser.rb

@@ -1,5 +1,3 @@
-# rbs_inline: enabled
-
 # @rbs use Prism::*
 
 module RBS
@@ -50,9 +48,10 @@ module RBS
           instance.comments[result.line_range.end] = result
         end
 
-        if result.comments.none? {|comment| comment.location.slice =~ /\A# rbs_inline: enabled\Z/}
-          return
-        end
+        with_magic_comment = result.comments.any? {|comment| comment.location.slice =~ /\A# rbs_inline: enabled\Z/}
+        with_annotation = annots.any? {|result| result.annotations.any? }
+
+        return unless with_magic_comment || with_annotation
 
         uses = [] #: Array[AST::Annotations::Use]
         annots.each do |annot|
@@ -71,7 +70,7 @@ module RBS
         ]
       end
 
-      # @rbs rturns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
+      # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
       def current_class_module_decl
         surrounding_decls.last
       end

data/lib/rbs/inline/version.rb

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

data/sig/generated/rbs/inline/annotation_parser.rbs

@@ -146,7 +146,7 @@ module RBS
       #
       # ```
       # Integer -- Foo        # => Returns `Integer`, tokenizer has `--` as its current token
-      # Integer[ -- Foo       # => Returns a tree for `Integer[`, tokenizer has `--` as its curren token
+      # Integer[ -- Foo       # => Returns a tree for `Integer[`, tokenizer has `--` as its current token
       # Integer[ Foo          # => Returns a tree for `Integer[ Foo`, tokenizer is at the end of the input
       # ```
       #

data/sig/generated/rbs/inline/ast/members.rbs

@@ -49,7 +49,7 @@ module RBS
           # [FIXME] It only supports `self` receiver.
           #
           # ```rb
-          # def self.foo = ()    # :sigleton
+          # def self.foo = ()    # :singleton
           # def object.foo = ()  # Not supported (returns :instance)
           # ```
           def method_kind: () -> RBS::AST::Members::MethodDefinition::kind

data/sig/generated/rbs/inline/cli.rbs

@@ -3,6 +3,37 @@
 module RBS
   module Inline
     class CLI
+      # Calculate the path under `output_path` that has the same structure relative to one of the `base_paths`
+      #
+      # ```rb
+      # calculator = PathCalculator.new(Pathname("/rbs-inline"), [Pathname("app"), Pathname("lib")], Pathname("/tmp/sig"))
+      # calculator.calculate(Pathname("/rbs-inline/app/models/foo.rb"))   # => Pathname("/tmp/sig/models/foo.rb")
+      # calculator.calculate(Pathname("/rbs-inline/lib/bar.rb"))          # => Pathname("/tmp/sig/bar.rb")
+      # calculator.calculate(Pathname("/rbs-inline/hello/world.rb"))      # => Pathname("/tmp/sig/hello/world.rb")
+      # calculator.calculate(Pathname("/foo.rb"))                         # => nil
+      # ```
+      #
+      class PathCalculator
+        attr_reader pwd: Pathname
+
+        attr_reader base_paths: Array[Pathname]
+
+        attr_reader output_path: Pathname
+
+        # @rbs pwd: Pathname
+        # @rbs base_paths: Array[Pathname]
+        # @rbs output_path: Pathname
+        def initialize: (Pathname pwd, Array[Pathname] base_paths, Pathname output_path) -> void
+
+        # :: (Pathname) -> Pathname?
+        def calculate: (Pathname) -> Pathname?
+
+        # @rbs path: Pathname
+        # @rbs prefix: Pathname
+        # @rbs returns bool
+        def has_prefix?: (Pathname path, prefix: Pathname) -> bool
+      end
+
       attr_reader stdout: IO
 
       attr_reader stderr: IO

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

@@ -34,8 +34,8 @@ module RBS
       # @rbs returns [Array[AST::Annotations::Use], Array[AST::Declarations::t]]?
       def self.parse: (ParseResult[ProgramNode] result) -> [ Array[AST::Annotations::Use], Array[AST::Declarations::t] ]?
 
-      # @rbs rturns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
-      def current_class_module_decl: () -> untyped
+      # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil
+      def current_class_module_decl: () -> (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl | nil)
 
       # @rbs returns AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl
       def current_class_module_decl!: () -> (AST::Declarations::ModuleDecl | AST::Declarations::ClassDecl)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs-inline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism