rbs-siggen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e403c0c57cc49ef98ae97fc5f63ee2f0c7bfdb3d4311fd45239fc8c7c3c18a7
+  data.tar.gz: 98fcb8dd20631d140fd925ce71f0f8864f47c0b1e3ad22cc8db536b9f3a42d25
+SHA512:
+  metadata.gz: fa1febf6e6fe41d8bf020f1854cf0f41e956eec2b017d5c468196cfd78cb5cd802e7f6367c027cb9d1bfaf408252181c4d018ca66ca4e63e32a47d727de995e7
+  data.tar.gz: 8bb8326380805b4a6732328e3715cf9e1315c9e3ad8d926b41857a4dff7a42185a6f9081d29dcb4a4e785c7761d2ea1f5cc67262c43e3f0141d85d0927786757

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Koji NAKAMURA
+
+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,35 @@
+# RBS::Siggen
+
+RBS::Siggen
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rbs-siggen
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rbs-siggen
+```
+
+## Usage
+
+TBD
+
+## 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 the created tag, 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/kozy4324/rbs-siggen.
+
+## 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,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "steep/rake_task"
+Steep::RakeTask.new do |t|
+  t.check.severity_level = :error
+  t.watch.verbose
+end
+
+task default: %i[test rubocop steep]

data/Steepfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  ignore_signature "sig/test"
+  check "lib"
+end
+
+target :test do
+  unreferenced!
+  signature "sig/test"
+  check "test"
+  configure_code_diagnostics(D::Ruby.lenient)
+end

data/exe/rbs-siggen

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.join(__dir__, "../lib")
+require "rbs/siggen"
+require "pathname"
+require "optparse"
+
+options = { sig_dir: "sig" }
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: rbs-siggen [options] <lib-path>"
+
+  opts.on("--sig-dir DIR", "Path to RBS signature directory (default: sig)") do |dir|
+    options[:sig_dir] = dir
+  end
+
+  opts.on("-v", "--version", "Show version") do
+    puts "rbs-siggen #{RBS::Siggen::VERSION}"
+    exit
+  end
+
+  opts.on("-h", "--help", "Show this help") do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+
+if ARGV.empty?
+  puts parser
+  exit 1
+end
+
+lib_path = ARGV[0]
+
+siggen = RBS::Siggen.new(path: options[:sig_dir])
+siggen.analyze(path: Pathname(lib_path)) do |siggen, _|
+  puts siggen.generate
+end

data/lib/rbs/siggen/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RBS
+  class Siggen
+    VERSION = "0.1.0"
+  end
+end

data/lib/rbs/siggen.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+require "rbs"
+require "steep"
+require "parser"
+require "erb"
+require "stringio"
+require_relative "siggen/version"
+
+module RBS
+  class Siggen # rubocop:disable Style/Documentation
+    # @rbs @env: RBS::Environment
+    # @rbs @typing: untyped
+    # @rbs @node: Parser::AST::Node
+
+    #: (path: String) -> void
+    def initialize(path: "sig")
+      core_root = RBS::EnvironmentLoader::DEFAULT_CORE_ROOT
+      env_loader = RBS::EnvironmentLoader.new(core_root: core_root)
+      env_loader.add path: Pathname(path)
+
+      env = RBS::Environment.new
+      env_loader.load(env: env)
+      @env = env.resolve_type_names
+    end
+
+    #: (String sig_string, ?name: String) -> void
+    def add_signature(sig_string, name: "a.rbs")
+      buffer = RBS::Buffer.new(name:, content: sig_string)
+      _, dirs, decls = RBS::Parser.parse_signature(buffer)
+      @env.add_signature(buffer: buffer, directives: dirs, decls: decls)
+    end
+
+    #: (path: String) { (Siggen, String) -> void } -> void
+    def analyze(path:)
+      ruby_files = Dir.glob("#{path}/**/*.rb")
+      ruby_files.each do |file|
+        analyze_ruby(File.read(file), name: file)
+        yield self, file
+      end
+    end
+
+    #: (String ruby_string, ?name: String) -> void
+    def analyze_ruby(ruby_string, name: "a.rb")
+      # steep:ignore:start
+      definition_builder = RBS::DefinitionBuilder.new(env: @env)
+
+      factory = Steep::AST::Types::Factory.new(builder: definition_builder)
+      builder = Steep::Interface::Builder.new(factory, implicitly_returns_nil: true)
+      checker = Steep::Subtyping::Check.new(builder: builder)
+
+      source = Steep::Source.parse(ruby_string, path: Pathname(name), factory: factory)
+
+      annotations = source.annotations(block: source.node, factory: checker.factory, context: nil)
+      resolver = RBS::Resolver::ConstantResolver.new(builder: checker.factory.definition_builder)
+      const_env = Steep::TypeInference::ConstantEnv.new(factory: checker.factory, context: nil, resolver: resolver)
+
+      case annotations.self_type
+      when Steep::AST::Types::Name::Instance
+        module_name = annotations.self_type.name
+        module_type = Steep::AST::Types::Name::Singleton.new(name: module_name)
+        instance_type = annotations.self_type
+      when Steep::AST::Types::Name::Singleton
+        module_name = annotations.self_type.name
+        module_type = annotations.self_type
+        instance_type = annotations.self_type
+      else
+        module_name = Steep::AST::Builtin::Object.module_name
+        module_type = Steep::AST::Builtin::Object.module_type
+        instance_type = Steep::AST::Builtin::Object.instance_type
+      end
+
+      type_env = Steep::TypeInference::TypeEnvBuilder.new(
+        Steep::TypeInference::TypeEnvBuilder::Command::ImportGlobalDeclarations.new(checker.factory),
+        Steep::TypeInference::TypeEnvBuilder::Command::ImportInstanceVariableAnnotations.new(annotations),
+        Steep::TypeInference::TypeEnvBuilder::Command::ImportConstantAnnotations.new(annotations),
+        Steep::TypeInference::TypeEnvBuilder::Command::ImportLocalVariableAnnotations.new(annotations)
+      ).build(Steep::TypeInference::TypeEnv.new(const_env))
+
+      context = Steep::TypeInference::Context.new(
+        block_context: nil,
+        method_context: nil,
+        module_context: Steep::TypeInference::Context::ModuleContext.new(
+          instance_type: instance_type,
+          module_type: module_type,
+          implement_name: nil,
+          nesting: nil,
+          class_name: module_name,
+          instance_definition: checker.factory.definition_builder.build_instance(module_name),
+          module_definition: checker.factory.definition_builder.build_singleton(module_name)
+        ),
+        break_context: nil,
+        self_type: instance_type,
+        type_env: type_env,
+        call_context: Steep::TypeInference::MethodCall::TopLevelContext.new,
+        variable_context: Steep::TypeInference::Context::TypeVariableContext.empty
+      )
+
+      typing = Steep::Typing.new(source: source, root_context: context, cursor: nil)
+      construction = Steep::TypeConstruction.new(checker: checker,
+                                                 source: source,
+                                                 annotations: annotations,
+                                                 context: context,
+                                                 typing: typing)
+      construction.synthesize(source.node)
+
+      @typing = typing
+      @node = source.node
+      # steep:ignore:end
+    end
+
+    #: () -> String
+    def generate
+      result = {} #: Hash[String, Array[String]]
+
+      traverse(@node) do |node, call_of|
+        next unless node.type == :send
+
+        _, _, *args = node.children
+        args = args.map { |a| a.children[0] }
+
+        call_of.method_decls.each do |method_decl|
+          receiver_type = method_decl.method_name.type_name
+          class_name = "#{receiver_type.namespace}#{receiver_type.name}"
+
+          rp = method_decl.method_def.type.type.required_positionals.map(&:name)
+          arg_hash = rp.zip(args).to_h
+          annos = method_decl.method_def
+                             .member_annotations
+                             .filter { |a| a.string.include?("siggen:") }
+                             .map { |a| a.string.split("siggen:")[1].strip }
+          next if annos.empty?
+
+          result[class_name] ||= []
+          annos.each do |anno|
+            result[class_name] << ERB.new(anno).result_with_hash(arg_hash)
+          end
+        end
+      end
+
+      io = ::StringIO.new
+      result.each do |key, values|
+        io.puts "class #{key}"
+        values.each do |v|
+          io.puts "  #{v}"
+        end
+        io.puts "end"
+      end
+      io.rewind
+      io.read || ""
+    end
+
+    #: (untyped node) ?{ (Parser::AST::Node node, untyped call_of) -> void } -> void
+    def traverse(node, &block)
+      return unless node.is_a?(::Parser::AST::Node)
+
+      call_of = begin
+        @typing.call_of(node:)
+      rescue StandardError
+        nil
+      end
+
+      unless call_of.nil? ||
+             call_of.is_a?(Steep::TypeInference::MethodCall::NoMethodError) || # steep:ignore
+             call_of.is_a?(Steep::TypeInference::MethodCall::Untyped) # steep:ignore
+        yield(node, call_of)
+      end
+
+      node.children.each do |child|
+        traverse(child, &block)
+      end
+    end
+  end
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,252 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: 0.3.0
+  source:
+    type: rubygems
+- name: bigdecimal
+  version: '4.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: csv
+  version: '3.3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: digest
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: ffi
+  version: 1.17.3
+  source:
+    type: rubygems
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: io-console
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: listen
+  version: '3.9'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '5.25'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: 0.3.0
+  source:
+    type: rubygems
+- name: openssl
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parser
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pp
+  version: '0'
+  source:
+    type: stdlib
+- name: prettyprint
+  version: '0'
+  source:
+    type: stdlib
+- name: prism
+  version: 1.9.0
+  source:
+    type: rubygems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rbs
+  version: 3.10.3
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: regexp_parser
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rubocop
+  version: '1.57'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rubocop-ast
+  version: '1.46'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: socket
+  version: '0'
+  source:
+    type: stdlib
+- name: stringio
+  version: '0'
+  source:
+    type: stdlib
+- name: strscan
+  version: '0'
+  source:
+    type: stdlib
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: tzinfo
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: 5aeae33367fa324abf3a4ef912f4e27aaf17f6b9
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true

data/sig/generated/rbs/siggen.rbs

@@ -0,0 +1,29 @@
+# Generated from lib/rbs/siggen.rb with RBS::Inline
+
+module RBS
+  class Siggen
+    @env: RBS::Environment
+
+    @typing: untyped
+
+    @node: Parser::AST::Node
+
+    # : (path: String) -> void
+    def initialize: (path: String) -> void
+
+    # : (String sig_string, ?name: String) -> void
+    def add_signature: (String sig_string, ?name: String) -> void
+
+    # : (path: String) { (Siggen, String) -> void } -> void
+    def analyze: (path: String) { (Siggen, String) -> void } -> void
+
+    # : (String ruby_string, ?name: String) -> void
+    def analyze_ruby: (String ruby_string, ?name: String) -> void
+
+    # : () -> String
+    def generate: () -> String
+
+    # : (untyped node) ?{ (Parser::AST::Node node, untyped call_of) -> void } -> void
+    def traverse: (untyped node) ?{ (Parser::AST::Node node, untyped call_of) -> void } -> void
+  end
+end

data/sig/rbs/siggen.rbs

@@ -0,0 +1,5 @@
+module RBS
+  class Siggen
+    VERSION: String
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rbs-siggen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Koji NAKAMURA
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: RBS::Siggen
+email:
+- kozy4324@gmail.com
+executables:
+- rbs-siggen
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- exe/rbs-siggen
+- lib/rbs/siggen.rb
+- lib/rbs/siggen/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/generated/rbs/siggen.rbs
+- sig/rbs/siggen.rbs
+homepage: https://github.com/kozy4324/rbs-siggen
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kozy4324/rbs-siggen
+  source_code_uri: https://github.com/kozy4324/rbs-siggen
+  changelog_uri: https://github.com/kozy4324/rbs-siggen/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: RBS::Siggen
+test_files: []