rbs-trace 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84f76be342e771b3dc3ea9ae507fce861475310bc8c093e91999e802516114a7
+  data.tar.gz: a8a78314b1ba4ab837318e0b4f555e7898a1d16f938f2d8bd58c0e57cc5b5076
+SHA512:
+  metadata.gz: ef51d01034f05ac60091ed78956bd01923735aa6692b32e74e973a4eb598b27f46ebeaf60a33bd842a9d9ae4c1f8310e85de75d60cff3859c9c8a20329ba7ec9
+  data.tar.gz: b78f4dbb9aca347a74a5f2461a553870b11509405569a1bee5464147b417bd894f51cbbe70678cd3b5ed906af1cdcea4c0e9a756a18072e496492ce4c44a0077

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 15
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - "lib/rbs-trace.rb"

data/.ruby-version

@@ -0,0 +1 @@
+3.3.3

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Takumi Shotoku
+
+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,112 @@
+# RBS::Trace
+
+RBS::Trace collects argument types and return value types using TracePoint, and inserts inline RBS type declarations into files.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rbs-trace
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rbs-trace
+
+## Usage
+
+For example, suppose you have the following class:
+
+```ruby
+class User
+  def initialize(first_name, last_name)
+    @first_name = first_name
+    @last_name = last_name
+  end
+
+  def full_name
+    "#{@first_name} #{@last_name}"
+  end
+
+  def say_hello
+    puts "hi, #{full_name}."
+  end
+end
+```
+
+Call target methods within the `enable` method block, and call the `insert_rbs` method.
+
+```ruby
+tracing = RBS::Trace::MethodTracing.new
+
+# Collects the types of methods called in the block.
+tracing.enable do
+  user = User.new("Nanoha", "Takamachi")
+  user.say_hello
+end
+
+tracing.insert_rbs
+```
+
+Automatically inserts inline RBS definitions into the file.
+
+```ruby
+class User
+  # @rbs (String, String) -> void
+  def initialize(first_name, last_name)
+    @first_name = first_name
+    @last_name = last_name
+  end
+
+  # @rbs () -> String
+  def full_name
+    "#{@first_name} #{@last_name}"
+  end
+
+  # @rbs () -> void
+  def say_hello
+    puts "hi, #{full_name}."
+  end
+end
+```
+
+### RSpec
+
+Add the following code to `spec/support/rbs_trace.rb`.
+
+```ruby
+return unless ENV["RBS_TRACE"]
+
+RSpec.configure do |config|
+  tracing = RBS::Trace::MethodTracing.new
+
+  config.before(:suite) { tracing.enable }
+  config.after(:suite) do
+    tracing.disable
+    tracing.insert_rbs
+  end
+end
+```
+
+Then run RSpec with the environment variables.
+
+```console
+$ RBS_TRACE=1 bundle exec rspec
+```
+
+## Development
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sinsoku/rbs-trace. 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/sinsoku/rbs-trace/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rbs::Trace project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sinsoku/rbs-trace/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rbs/trace/declaration.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RBS
+  module Trace
+    class Declaration
+      METHOD_KINDS = %i[req opt rest keyreq key keyrest].freeze
+      private_constant :METHOD_KINDS
+
+      attr_accessor :return_type
+
+      def initialize(parameters, void: false)
+        @parameters = parameters
+        @void = void
+      end
+
+      def to_rbs
+        ret = if @void
+                "void"
+              elsif @return_type == NilClass
+                "nil"
+              elsif @return_type == TrueClass || @return_type == FalseClass
+                "bool"
+              else
+                @return_type
+              end
+
+        "(#{parameters_rbs}) -> #{ret}"
+      end
+
+      private
+
+      # TODO: support block argument
+      def parameters_rbs
+        converted = {}
+        @parameters.each do |kind, name, klass|
+          converted[kind] ||= []
+          converted[kind] << convert(kind, name, klass)
+        end
+
+        METHOD_KINDS.flat_map { |kind| converted[kind] }.compact.join(", ")
+      end
+
+      def select_parameters(selected)
+        @parameters.select { |kind, _name, _klass| kind == selected }
+      end
+
+      def convert(kind, name, klass) # rubocop:disable Metrics/MethodLength
+        case kind
+        when :req
+          klass
+        when :opt
+          "?#{klass}"
+        when :rest
+          "*#{klass.join("|")}"
+        when :keyreq
+          "#{name}: #{klass}"
+        when :key
+          "?#{name}: #{klass}"
+        when :keyrest
+          "**#{klass.join("|")}"
+        end
+      end
+    end
+  end
+end

data/lib/rbs/trace/definition.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RBS
+  module Trace
+    class Definition
+      attr_reader :klass, :name, :lineno
+
+      def initialize(klass:, name:, lineno:)
+        @klass = klass
+        @name = name
+        @lineno = lineno
+      end
+
+      def decls
+        @decls ||= []
+      end
+
+      def rbs_comment(indent = 0)
+        "#{" " * indent}# @rbs #{rbs}\n"
+      end
+
+      def rbs
+        # TODO: merge multiple decls
+        @decls.first.to_rbs
+      end
+    end
+  end
+end

data/lib/rbs/trace/file.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RBS
+  module Trace
+    class File
+      def initialize(path)
+        @path = path
+      end
+
+      def definitions
+        @definitions ||= {}
+      end
+
+      def with_rbs
+        lines = ::File.readlines(@path)
+        reverse_definitions.each do |d|
+          next if skip_insert?(lines, d)
+
+          current = d.lineno - 1
+          indent = lines[current]&.index("def")
+          next unless indent
+
+          lines.insert(current, d.rbs_comment(indent))
+        end
+        lines.join
+      end
+
+      def rewrite
+        ::File.write(@path, with_rbs)
+      end
+
+      private
+
+      def skip_insert?(lines, definition)
+        prev = definition.lineno - 2
+
+        definition.decls.empty? || lines[prev]&.include?("# @rbs")
+      end
+
+      def reverse_definitions
+        @definitions.values.sort_by { |d| -d.lineno }
+      end
+    end
+  end
+end

data/lib/rbs/trace/method_tracing.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module RBS
+  module Trace
+    class MethodTracing # rubocop:disable Metrics/ClassLength
+      ASSIGNED_NODE_TYPES = %i[statements_node local_variable_write_node instance_variable_write_node
+                               class_variable_write_node constant_write_node call_node embedded_statements_node].freeze
+      private_constant :ASSIGNED_NODE_TYPES
+
+      def enable(&)
+        trace.enable(&)
+      end
+
+      def disable
+        trace.disable
+      end
+
+      def files
+        @files ||= {}
+      end
+
+      def insert_rbs
+        files.each_value(&:rewrite)
+      end
+
+      private
+
+      def trace
+        @trace ||= TracePoint.new(:call, :return, :raise) { |tp| record(tp) }
+      end
+
+      def logger
+        return @logger if defined?(@logger)
+
+        level = ENV["RBS_TRACE_DEBUG"] ? :debug : :info
+        @logger = Logger.new($stdout, level:)
+      end
+
+      def stack_traces
+        @stack_traces ||= []
+      end
+
+      def find_or_new_file(path)
+        files[path] ||= File.new(path)
+        files[path]
+      end
+
+      def find_or_new_definition(file, tp)
+        name = tp.method_id
+        is_singleton = tp.defined_class.singleton_class?
+        klass = is_singleton ? tp.self : tp.defined_class
+        mark = is_singleton ? "." : "#"
+        signature = "#{klass}#{mark}#{name}"
+
+        _filename, lineno = tp.self.method(name).source_location
+        file.definitions[signature] ||= Definition.new(klass:, name:, lineno:)
+      end
+
+      def record(tp) # rubocop:disable Metrics/MethodLength
+        return if ignore_path?(tp.path)
+
+        file = find_or_new_file(tp.path)
+        definition = find_or_new_definition(file, tp)
+
+        case tp.event
+        when :call
+          call_event(tp)
+        when :return, :raise
+          return_event(tp, definition)
+        end
+      rescue StandardError => e
+        logger.debug(e)
+      end
+
+      def call_event(tp) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        parameters = tp.parameters.map do |kind, name|
+          value = tp.binding.local_variable_get(name)
+          klass = case kind
+                  when :rest
+                    value.map(&:class).uniq
+                  when :keyrest
+                    value.map { |_, v| v.class }.uniq
+                  when :block
+                    # TODO: support block argument
+                  else
+                    value.class
+                  end
+          [kind, name, klass]
+        end
+        stack_traces << Declaration.new(parameters, void: !assign_return_value?(tp.path, tp.method_id))
+      end
+
+      def return_event(tp, definition)
+        decl = stack_traces.pop
+        # TODO: check usecase where decl is nil
+        return unless decl
+
+        decl.return_type = tp.event == :return ? tp.return_value.class : nil
+        definition.decls << decl
+      end
+
+      def ignore_path?(path)
+        bundle_path = Bundler.bundle_path.to_s
+        ruby_lib_path = RbConfig::CONFIG["rubylibdir"]
+
+        path.start_with?("<internal") ||
+          path.start_with?(bundle_path) ||
+          path.start_with?(ruby_lib_path) ||
+          path.start_with?(__FILE__)
+      end
+
+      def assign_return_value?(path, method_id) # rubocop:disable Metrics/AbcSize
+        is_initialize = method_id == :initialize
+        return false if is_initialize
+
+        i = caller_locations.index { |loc| loc.path == path && loc.label == method_id.to_s }
+        loc = caller_locations[i + 1]
+
+        node = parsed_nodes(loc.path)
+        method_name = is_initialize ? :new : method_id
+        parents = find_parents(node, method_name:, lineno: loc.lineno)
+        return false unless parents
+
+        parent = parents[1]
+        ASSIGNED_NODE_TYPES.include?(parent.type)
+      end
+
+      def find_parents(node, method_name:, lineno:, parents: [])
+        result = nil
+        node.compact_child_nodes.each do |child|
+          break if result
+
+          found = child.type == :call_node && child.name == method_name && child.location.start_line == lineno
+          result = found ? [child, *parents] : find_parents(child, method_name:, lineno:, parents: [node, *parents])
+        end
+        result
+      end
+
+      def parsed_nodes(path)
+        @parsed_nodes ||= {}
+        @parsed_nodes[path] ||= Prism.parse_file(path)
+        @parsed_nodes[path].value
+      end
+    end
+  end
+end

data/lib/rbs/trace/version.rb

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

data/lib/rbs/trace.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "logger"
+require "prism"
+
+require_relative "trace/declaration"
+require_relative "trace/definition"
+require_relative "trace/file"
+require_relative "trace/method_tracing"
+require_relative "trace/version"
+
+module RBS
+  module Trace
+    class Error < StandardError; end
+  end
+end

data/lib/rbs-trace.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "rbs/trace"

data/sig/rbs/trace.rbs

@@ -0,0 +1,6 @@
+module Rbs
+  module Trace
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rbs-trace
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takumi Shotoku
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+description: |
+  RBS::Trace collects argument types and return value types using TracePoint, and inserts
+  inline RBS type declarations into files."
+email:
+- sinsoku.listy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rbs-trace.rb
+- lib/rbs/trace.rb
+- lib/rbs/trace/declaration.rb
+- lib/rbs/trace/definition.rb
+- lib/rbs/trace/file.rb
+- lib/rbs/trace/method_tracing.rb
+- lib/rbs/trace/version.rb
+- sig/rbs/trace.rbs
+homepage: https://github.com/sinsoku/rbs-trace
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sinsoku/rbs-trace
+  source_code_uri: https://github.com/sinsoku/rbs-trace/blob/v0.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/sinsoku/rbs-trace/tree/v0.1.0
+  rubygems_mfa_required: 'true'
+post_install_message:
+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: 3.5.17
+signing_key:
+specification_version: 4
+summary: Automatically Insert inline RBS type declarations using runtime information.
+test_files: []