orthoses 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64cbbb058a7d4dc7c5f6f0d8cc66a23a1b2026253ad20add3cc63777a1c42227
+  data.tar.gz: 15742e8389d7fc4e129bca6ab48203f13dad5b2338eff73a2b4c530ba239d327
+SHA512:
+  metadata.gz: 276874fcb60ce45b3b2ffe3388e963b596f65a466c4f36f5b3986b561f756f721d797e8217a27b6a292f988343fe8f4209886b876ba03e4512466b51903e4996
+  data.tar.gz: 73b2a614b599980d20d2d0334d87f4f508b163beff9a766979d67f39f49213a634c9e907725efd1f7a51e1552b5db90e80f3d766bba024ff050d50c5d5522b5c

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 co000ri@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in orthoses.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rgot", "~> 1.1"
+gem "steep"
+gem "activesupport"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 ksss
+
+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,123 @@
+# Orthoses
+
+Orthoses is a framework for RBS generation.
+The Rack architecture keeps your code organized and extensible.
+
+## PoC
+
+https://gist.github.com/ksss/00592da24f28774bf8fc5db08331666e
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add orthoses
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install orthoses
+
+## Usage
+
+```rb
+Orthoses::Builder.new do
+  use Orthoses::CreateFileByName
+    base_dir: Rails.root.join("sig/out"),
+    header: "# !!! GENERATED CODE !!!"
+  use Orthoses::Filter,
+    if: -> (name, _content) {
+      path, _lineno = Object.const_source_location(name)
+      return false unless path
+      %r{app/models}.match?(path)
+    }
+  use YourCustom::Middleware
+  use Orthoses::IncludeExtendPrepend
+  use Orthoses::Constant
+  use Orthoses::Walk,
+    root: "Foo"
+  run -> () {
+    # load library or application
+  }
+end.call
+```
+
+## Middlewares
+
+### Orthoses::Constant
+
+Add constant signature to class/module.
+Signatures are predicted from constant values.
+
+### Orthoses::IncludeExtendPrepend
+
+Add module include/extend/prepend definition.
+It use `Module#{includeed,extended,prepended}` for capture.
+
+### Orthoses::ObjectSpaceAll
+
+Add module/class by `ObjectSpace.each_object(Module)`
+
+### Orthoses::CreateFileByName
+
+Separate directories for each module name and output RBS files.
+
+### Orthoses::Filter
+
+Filter stored value by name and content.
+
+### Orthoses::PP
+
+Debug pring current stored values
+
+### Orthoses::LoadRBS
+
+Load RBS from `paths`.
+And loaded RBS will write to output.
+
+### Orthoses::Walk
+
+Load class/module recersive from `root` constant.
+If set String to `root`, It get constant after loading.
+
+### Orthoses::Tap
+
+Get the current store in the block as an argument.
+This is very useful for middleware development and debugging.
+
+### Orthoses::DelegateClass
+
+If a class is defined using the `DelegateClass` method
+RBS is automatically generated as inherited.
+
+.rb
+
+```rb
+class Tempfile < DelegateClass(File)
+end
+```
+
+.rbs
+
+```rbs
+class Tempfile < File
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/ksss/orthoses. 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/ksss/orthoses/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 Orthoses project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/orthoses/blob/main/CODE_OF_CONDUCT.md).

data/lib/orthoses/builder.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Orthoses
+  # Middleware builder like the Rack
+  #   Builder.new do
+  #     use Orthoses::CreateFileByName
+  #     use Orthoses::Constant
+  #     use Orthoses::IncludeExtendPrepend
+  #     use Orthoses::Walk,
+  #       root: "Foo"
+  #     run ->() { require 'foo' }
+  #   end
+  class Builder
+    def initialize(&block)
+      @use = []
+      @run = nil
+      instance_eval(&block) if block
+    end
+
+    module CallLogable
+      def call()
+        Orthoses.logger.info("[#{self.class}]#call start")
+        super.tap do
+          Orthoses.logger.info("[#{self.class}]#call end")
+        end
+      end
+    end
+
+    def use(middleware, *args, **key, &block)
+      @use << proc do |loader|
+        middleware.new(loader, *args, **key, &block).tap do |m|
+          m.extend CallLogable
+        end
+      end
+    end
+
+    def run(loader)
+      use Store
+      @run = proc do
+        Orthoses.logger.info("[loader].call start")
+        loader.call.tap do
+          Orthoses.logger.info("[loader].call end")
+        end
+      end
+    end
+
+    def to_loader
+      @use.reverse.inject(@run) { |current, next_proc| next_proc[current] }
+    end
+
+    def call
+      to_loader.call
+    end
+  end
+end

data/lib/orthoses/call_tracer.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Orthoses
+  # Trace :call event by TracePoint and capture arguments.
+  #   def call
+  #     scope = CallTracer.new
+  #     scope.trace(ActiveRecord::Base.method(:scope)) do
+  #       @loader.call
+  #     end
+  #     scope.result.each do |method, argument|
+  #       argument[:name]
+  #       argument[:body]
+  #       argument[:block]
+  #     end
+  class CallTracer
+    attr_accessor :result
+
+    def initialize
+      @result = []
+    end
+
+    def trace(target, &block)
+      TracePoint.new(:call) do |tp|
+        called_method = tp.self.method(tp.method_id)
+        argument = tp.parameters.each_with_object({}) do |op_name, hash|
+          name = op_name[1]
+          case name
+          when :*, :**, :&, nil
+            # skip
+          else
+            hash[name] = tp.binding.local_variable_get(name).then do |var|
+              case var
+              when Module
+                var # avoid missing name
+              else
+                var.dup
+              end
+            rescue => err
+              case var
+              when Thread::Backtrace::Location
+                # known
+              else
+                warn("#dup fail (#{err.class}) #{err.message}")
+              end
+              var
+            end
+          end
+        end
+        @result << [called_method, argument]
+      end.enable(target: target, &block)
+    end
+  end
+end

data/lib/orthoses/constant.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class Constant
+    def initialize(loader, strict:, if: nil, on_error: nil)
+      @loader = loader
+      @strict = strict
+      @if = binding.local_variable_get(:if)
+      @on_error = on_error
+    end
+
+    def call
+      cache = {}
+      @loader.call.tap do |store|
+        will_add_key_and_content = []
+        store.each do |name, _|
+          next if name == :Module
+          next if name.start_with?('#<')
+
+          begin
+            base = Object.const_get(name)
+          rescue NameError, ArgumentError, LoadError
+            # i18n/tests raise ArgumentError
+            next
+          end
+          next unless base.kind_of?(Module)
+          Orthoses::Utils.each_const_recursive(base, on_error: @on_error) do |current, const, val|
+            next if current.singleton_class?
+            next if Utils.module_name(current).nil?
+            next if val.kind_of?(Module)
+            next if cache[[current, const]]
+            cache[[current, const]] = true
+
+            rbs = Orthoses::Utils.object_to_rbs(val, strict: @strict)
+            next unless rbs
+            next unless @if.nil? || @if.call(current, const, val, rbs)
+
+            will_add_key_and_content << [Utils.module_name(current), "#{const}: #{rbs}"]
+          end
+        end
+        will_add_key_and_content.each do |name, line|
+          store[name] << line
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/content.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Orthoses
+  # Common interface for output.
+  # Orthoses::Content expect to use result of middleware.
+  #   store = @loader.call
+  #   store["Foo::Bar"] << "def baz: () -> void"
+  # By default, Orthoses::Content search constant of keys.
+  # and decide class or module declaration.
+  # Also declaraion can specify directly.
+  #   store["Foo::Bar"].header = "class Foo::Bar < Baz"
+  # Orthoses::Content can generate RBS.
+  #   store["Foo::Bar"].to_rbs
+  class Content
+    attr_reader :name
+    attr_reader :body
+    attr_accessor :header
+
+    def initialize(name:)
+      @name = name
+      @body = []
+      @header = nil
+    end
+
+    def <<(line)
+      Orthoses.logger.debug("[#{name}] << #{line} on #{__FILE__}:#{__LINE__}")
+      @body << line
+    end
+
+    def concat(other)
+      Orthoses.logger.debug("[#{name}] concat #{other} on #{__FILE__}:#{__LINE__}")
+      @body.concat(other)
+    end
+
+    def to_rbs
+      if @header.nil?
+        auto_header
+      end
+      body_uniq("#{@header}\n#{@body.map { |b| "  #{b}\n" }.join}end\n")
+    end
+
+    private
+
+    def auto_header
+      val = Object.const_get(name)
+
+      case val
+      when Class
+        superclass =
+          if val.superclass && val.superclass != Object
+            super_module_name = Utils.module_name(val.superclass)
+
+            if super_module_name && super_module_name != "Random::Base" # https://github.com/ruby/rbs/pull/977
+              " < ::#{super_module_name}#{temporary_type_params(super_module_name)}"
+            else
+              nil
+            end
+          else
+            nil
+          end
+        self.header = "class #{Utils.module_name(val)}#{type_params(name)}#{superclass}"
+      when Module
+        self.header = "module #{Utils.module_name(val)}#{type_params(name)}"
+      else
+        raise "#{val.inspect} is not class/module"
+      end
+    end
+
+    def temporary_type_params(name)
+      Utils.known_type_params(name)&.then do |params|
+        if params.empty?
+          nil
+        else
+          "[#{params.map { :untyped }.join(', ')}]"
+        end
+      end
+    end
+
+    def type_params(name)
+      Utils.known_type_params(name)&.then do |type_params|
+        if type_params.empty?
+          nil
+        else
+          "[#{type_params.join(', ')}]"
+        end
+      end
+    end
+
+    def body_uniq(rbs)
+      buffer = RBS::Buffer.new(
+        name: "orthoses/content.rb",
+        content: rbs
+      )
+      out = StringIO.new
+      writer = RBS::Writer.new(out: out)
+      decls = RBS::Parser.parse_signature(buffer).map do |parsed_decl|
+        before_members = parsed_decl.members.dup
+        parsed_decl.members.uniq! { |m| [m.class, m.respond_to?(:name) ? m.name : nil] }
+        (before_members - parsed_decl.members).each do |droped_member|
+          Orthoses.logger.warn("#{parsed_decl.name}::#{droped_member.name.to_s}: #{droped_member.to_s} was droped since duplication")
+        end
+        parsed_decl
+      end
+      writer.write(decls)
+      out.string
+    rescue RBS::ParsingError
+      puts "```rbs"
+      puts rbs
+      puts "```"
+      raise
+    end
+  end
+end

data/lib/orthoses/create_file_by_name.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class CreateFileByName
+    def initialize(loader, base_dir:, header: nil)
+      @loader = loader
+      @base_dir = base_dir
+      @header = header
+    end
+
+    using(Module.new {
+      refine String do
+        # avoid load active_support
+        def underscore
+          return self unless /[A-Z-]|::/.match?(self)
+          word = self.to_s.gsub("::", "/")
+          word.gsub!(/(?:(?<=([A-Za-z\d]))|\b)((?-mix:(?=a)b))(?=\b|[^a-z])/) { "#{$1 && '_' }#{$2.downcase}" }
+          word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+      end
+    })
+
+    def call
+      store = @loader.call
+
+      store.each do |name, content|
+        file_path = Pathname("#{@base_dir}/#{name.to_s.split('::').map(&:underscore).join('/')}.rbs")
+        file_path.dirname.mkpath
+        file_path.open('w+') do |out|
+          if @header
+            out.puts @header
+            out.puts
+          end
+          out.puts content.to_rbs
+        end
+        Orthoses.logger.info("Generate file to #{file_path.to_s}")
+      end
+    end
+  end
+end

data/lib/orthoses/delegate_class.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class DelegateClass
+    def initialize(loader)
+      @loader = loader
+    end
+
+    def call
+      require 'delegate'
+      classes = []
+      Class.class_eval do
+        define_method(:inherited) do |subclass|
+          classes << [subclass, self]
+        end
+      end
+      delegate_class_super_map = {}
+      delegate_class_tracer = TracePoint.new(:return) do |tp|
+        return_value = tp.return_value
+        superclass = tp.binding.local_variable_get(:superclass)
+        delegate_class_super_map[return_value] = superclass
+      end
+      store = delegate_class_tracer.enable(target: method(:DelegateClass)) do
+        @loader.call
+      end
+      classes.each do |subclass, superclass|
+        if delegate_to_class = delegate_class_super_map[superclass]
+          subclass_name = Utils.module_name(subclass)
+          next unless subclass_name
+          delegate_to_class_name = Utils.module_name(delegate_to_class)
+          next unless delegate_to_class_name
+          store[subclass_name].header = "class #{subclass_name} < #{delegate_to_class_name}"
+        end
+      end
+      store
+    end
+
+    def from_DelegateClass?(klass)
+      klass.name.nil? &&
+        klass.superclass == Delegator &&
+        klass.instance_methods.include?(:__setobj__) &&
+        klass.instance_method(:__setobj__).source_location.first.end_with?("delegate.rb")
+    end
+  end
+end

data/lib/orthoses/filter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Orthoses
+  # Filter current store.
+  #   use Orthoses::Filter,
+  #     # filter stored key and value if proc return true
+  #     if: -> (name, content) { Orthoses.rbs_defined_class?(name) }
+  class Filter
+    def initialize(loader, if:)
+      @loader = loader
+      @if = binding.local_variable_get(:if)
+    end
+
+    def call
+      @loader.call.tap do |store|
+        store.filter! do |name, content|
+          @if.call(name, content).tap do
+            Orthoses.logger.debug("Filter pass [#{name}]")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/include_extend_prepend.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Orthoses
+  class IncludeExtendPrepend
+    def initialize(loader, if: nil)
+      @loader = loader
+      @if = binding.local_variable_get(:if)
+    end
+
+    def call
+      modules = Hash.new { |h, k| h[k] = [] }
+      ::Module.module_eval do
+        define_method(:included) do |mod|
+          modules[mod] << [:include, self]
+        end
+
+        define_method(:extended) do |mod|
+          modules[mod] << [:extend, self]
+        end
+
+        define_method(:prepended) do |mod|
+          modules[mod] << [:prepend, self]
+        end
+      end
+
+      store = @loader.call
+
+      modules.each do |base_mod, how_mods|
+        next unless base_mod.kind_of?(Module)
+        base_mod_name = Utils.module_name(base_mod)
+        next unless base_mod_name
+
+        lines = how_mods.filter.map do |how, mod|
+          mod_name = Utils.module_name(mod)
+          next unless mod_name
+          known_type_params = Utils.known_type_params(mod)
+          next unless known_type_params.nil? || known_type_params.empty?
+          next unless @if.nil? || @if.call(base_mod, how, mod)
+
+          if base_mod_name == "Object"
+            # avoid RecursiveAncestorError
+            content = store[mod_name]
+            if content.header.nil?
+              content.header = "module #{Utils.module_to_type_name(mod)} : ::BasicObject"
+            end
+          else
+            store[mod_name]
+          end
+
+          "#{how} #{mod_name}"
+        end
+        store[base_mod_name].concat(lines)
+      end
+
+      store
+    end
+  end
+end