orthoses 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2fbbb509545bf6efd770838fff4ac02168f0352f0f2e2561ed927eb3479a4bb
-  data.tar.gz: 259b1cf53cc3b2ea17ec3d6088260131ccd9d8562ec002b0d515cb817b96d228
+  metadata.gz: 2d5b96650f0b18fdb84d67bc6821887ac974e529bf13e05c079ad703645a0583
+  data.tar.gz: 50a0101c732e7a66d166e0ff4a3f6fd439d7c50ab2985ffb49c618e698f5873f
 SHA512:
-  metadata.gz: 50aceef69e828e6fbd90cbb23813bd66676b399d4a5551728eebf9ae8c24544aeda11c7d57810826575c53b215da541d232eb5a8ecb26fb9cf2d5a99822c7a91
-  data.tar.gz: 36972f90ecdf75efa516c2fb576ea616f2b949a5930463f01ff9046335ae6571d7e98f9c33593bee21397cd29754da4abdfea038c956eaaa74d92deded56ba71
+  metadata.gz: 2a9443b508c4dbb2518c656d34441fcedf4d571254834b375a99d97fd3c1443dd8bc4ef165c48334a66e64267efa7e9da7db43f9fcfea7c96d90a023f83e25b9
+  data.tar.gz: aa13ee94cb12d5729204fa8ecd926142bf56c58f30e9a6e13ee1c73914748fda0d752d3aeb7d31292de677c8ad4c19c5dd8636d919b05664b154cd4d62e0188a

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    orthoses (0.3.0)
+      rbs (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    ffi (1.15.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.4.0)
+    rgot (1.1.0)
+    steep (0.52.2)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  orthoses!
+  rake (~> 13.0)
+  rgot (~> 1.1)
+  steep
+
+BUNDLED WITH
+   2.3.9

data/README.md

@@ -89,6 +89,18 @@ This is very useful for middleware development and debugging.
 If a class is defined using the `DelegateClass` method
 RBS is automatically generated as inherited.
 
+### Orthoses::Writer
+
+Write output RBS to `io` option object.
+`io` should be able to call `#write` method.
+This is useful when you want to combine outputs into a single output.
+
+### Orthoses::RBSPrototypeRB
+
+Run `rbs prototype rb` command process to `paths` option files.
+`content_filter` option could filter with content decl.
+`mixin_filter` option could filter with mixin(include, extend, prepend) decl.
+
 .rb
 
 ```rb

data/lib/orthoses/call_tracer.rb

@@ -20,7 +20,7 @@ module Orthoses
     end
 
     def trace(target, &block)
-      TracePoint.new(:call) do |tp|
+      t = 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]
@@ -47,7 +47,8 @@ module Orthoses
           end
         end
         @result << [called_method, argument]
-      end.enable(target: target, &block)
+      end
+      t.enable(target: target, &block)
     end
   end
 end

data/lib/orthoses/content/environment.rb

@@ -0,0 +1,109 @@
+module Orthoses
+  class Content
+    class Environment
+      def initialize(constant_filter: nil, mixin_filter: nil)
+        @env = RBS::Environment.new
+        @constant_filter = constant_filter
+        @mixin_filter = mixin_filter
+      end
+
+      def <<(decl)
+        @env << decl
+      end
+
+      def write_to(store:)
+        each do |add_content|
+          content = store[add_content.name]
+          # content.header = add_content.header
+          content.concat(add_content.body)
+        end
+      end
+
+      def each
+        each_class do |content|
+          yield content
+        end
+        each_interface do |content|
+          yield content
+        end
+      end
+
+      private
+
+      def each_class
+        @env.class_decls.each do |type_name, m_entry|
+          name = type_name.relative!.to_s
+          content = Content.new(name: name)
+          case decl = m_entry.decls.first.decl
+          when RBS::AST::Declarations::Module
+            self_types = decl.self_types.empty? ? nil : " : #{decl.self_types.join(', ')}"
+            content.header = "module #{name_and_params(name, decl.type_params)}#{self_types}"
+          when RBS::AST::Declarations::Class
+            super_class = decl.super_class.nil? ? nil : " < #{name_and_args(decl.super_class.name, decl.super_class.args)}"
+            content.header = "class #{name_and_params(name, decl.type_params)}#{super_class}"
+          else
+            raise
+          end
+          decls_to_lines(m_entry.decls.map(&:decl)).each do |line|
+            content << line
+          end
+          yield content
+        end
+      end
+
+      def each_interface
+        @env.interface_decls.each do |type_name, s_entry|
+          name = type_name.relative!.to_s
+          content = Content.new(name: name)
+          decl = s_entry.decl
+          content.header = "interface #{name_and_params(name, decl.type_params)}"
+          decls_to_lines([decl]).each do |line|
+            content << line
+          end
+          yield content
+        end
+      end
+
+      def name_and_params(name, params)
+        if params.empty?
+          "#{name}"
+        else
+          ps = params.each.map do |param|
+            param.to_s
+          end
+
+          "#{name}[#{ps.join(", ")}]"
+        end
+      end
+
+      def name_and_args(name, args)
+        if name && args
+          if args.empty?
+            "#{name}"
+          else
+            "#{name}[#{args.join(", ")}]"
+          end
+        end
+      end
+
+      def decls_to_lines(decls)
+        out = StringIO.new
+        writer = RBS::Writer.new(out: out)
+        decls.each do |decl|
+          next unless decl.respond_to?(:members)
+          decl.members.each do |member|
+            next if member.respond_to?(:members)
+            case member
+            when RBS::AST::Declarations::Constant
+              next unless @constant_filter.nil? || @constant_filter.call(member)
+            when RBS::AST::Members::Mixin
+              next unless @mixin_filter.nil? || @mixin_filter.call(member)
+            end
+            writer.write_member(member)
+          end
+        end
+        out.string.each_line(chomp: true).to_a
+      end
+    end
+  end
+end

data/lib/orthoses/content.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'orthoses/content/duplication_checker'
+require 'orthoses/content/environment'
 
 module Orthoses
   # Common interface for output.
@@ -44,6 +45,11 @@ module Orthoses
     private
 
     def auto_header
+      if name.split('::').last.start_with?('_')
+        self.header = "interface #{name}"
+        return
+      end
+
       val = Object.const_get(name)
 
       case val

data/lib/orthoses/create_file_by_name.rb

@@ -28,6 +28,12 @@ module Orthoses
       store = @loader.call
 
       store.each do |name, content|
+        rbs = begin
+          content.to_rbs
+        rescue NameError, LoadError => err
+          Orthoses.logger.error(err.inspect)
+          next
+        end
         file_path = Pathname("#{@base_dir}/#{name.to_s.split('::').map(&:underscore).join('/')}.rbs")
         file_path.dirname.mkpath
         file_path.open('w+') do |out|
@@ -35,7 +41,7 @@ module Orthoses
             out.puts @header
             out.puts
           end
-          out.puts content.to_rbs
+          out.puts rbs
         end
         Orthoses.logger.info("Generate file to #{file_path.to_s}")
       end

data/lib/orthoses/delegate_class.rb

@@ -29,7 +29,6 @@ module Orthoses
           next unless subclass_name
           delegate_to_class_name = Utils.module_name(delegate_to_class)
           next unless delegate_to_class_name
-          next unless store[subclass_name].header.nil?
 
           header = "class #{subclass_name} < ::#{delegate_to_class_name}#{temporary_type_params(delegate_to_class_name)}"
           store[subclass_name].header = header

data/lib/orthoses/load_rbs.rb

@@ -11,79 +11,16 @@ module Orthoses
 
     def call
       @loader.call.tap do |store|
-        tmp_env = RBS::Environment.new
-
+        env = Content::Environment.new
         @paths.each do |path|
           Orthoses.logger.debug("Load #{path}")
           buffer = RBS::Buffer.new(name: path.to_s, content: File.read(path.to_s, encoding: "UTF-8"))
-          decls = RBS::Parser.parse_signature(buffer)
-          decls.each { |decl| tmp_env << decl }
-        end
-
-        tmp_env.class_decls.each do |type_name, m_entry|
-          name = type_name.relative!.to_s
-          content = store[name]
-          case decl = m_entry.decls.first.decl
-          when RBS::AST::Declarations::Module
-            self_types = decl.self_types.empty? ? nil : " : #{decl.self_types.join(', ')}"
-            content.header = "module #{name_and_params(name, decl.type_params)}#{self_types}"
-          when RBS::AST::Declarations::Class
-            super_class = decl.super_class.nil? ? nil : " < #{name_and_args(decl.super_class.name, decl.super_class.args)}"
-            content.header = "class #{name_and_params(name, decl.type_params)}#{super_class}"
-          end
-          decls_to_lines(m_entry.decls.map(&:decl)).each do |line|
-            content << line
-          end
-        end
-
-        tmp_env.interface_decls.each do |type_name, s_entry|
-          name = type_name.relative!.to_s
-          content = store[name]
-          decl = s_entry.decl
-          content.header = "interface #{name_and_params(name, decl.type_params)}"
-          decls_to_lines([decl]).each do |line|
-            content << line
-          end
-        end
-      end
-    end
-
-    private
-
-    def name_and_params(name, params)
-      if params.empty?
-        "#{name}"
-      else
-        ps = params.each.map do |param|
-          param.to_s
-        end
-
-        "#{name}[#{ps.join(", ")}]"
-      end
-    end
-
-    def name_and_args(name, args)
-      if name && args
-        if args.empty?
-          "#{name}"
-        else
-          "#{name}[#{args.join(", ")}]"
-        end
-      end
-    end
-
-    def decls_to_lines(decls)
-      out = StringIO.new
-      writer = RBS::Writer.new(out: out)
-      decls.each do |decl|
-        if decl.respond_to?(:members)
-          decl.members.each do |member|
-            next if member.respond_to?(:members)
-            writer.write_member(member)
+          RBS::Parser.parse_signature(buffer).each do |decl|
+            env << decl
           end
         end
+        env.write_to(store: store)
       end
-      out.string.each_line(chomp: true).to_a
     end
   end
 end

data/lib/orthoses/rbs_prototype_rb.rb

@@ -0,0 +1,34 @@
+module Orthoses
+  # Call `rbs prototype rb` and add to store
+  #     use Orthoses::RBSPrototypeRB,
+  #       paths: Dir.glob("lib/**/*.rb")
+  class RBSPrototypeRB
+    def initialize(loader, paths:, constant_filter: nil, mixin_filter: nil)
+      @loader = loader
+      @paths = paths
+      @constant_filter = constant_filter
+      @mixin_filter = mixin_filter
+    end
+
+    def call
+      @loader.call.tap do |store|
+        parser = RBS::Prototype::RB.new
+        @paths.each do |path|
+          begin
+            parser.parse File.read(path.to_s)
+          rescue => err
+            Orthoses.logger.error("Parse error #{err.inspect} by RBS::Prototype::RB #{path}")
+          end
+        end
+        env = Orthoses::Content::Environment.new(
+          constant_filter: @constant_filter,
+          mixin_filter: @mixin_filter,
+        )
+        parser.decls.each do |decl|
+          env << decl
+        end
+        env.write_to(store: store)
+      end
+    end
+  end
+end

data/lib/orthoses/utils.rb

@@ -63,11 +63,11 @@ module Orthoses
       when "stdlib"
         RBS::Repository::DEFAULT_STDLIB_ROOT.each_entry do |path|
           lib = path.to_s
-          loader.add(library: lib.to_s) unless lib == "." || lib == ".."
+          loader.add(library: lib.to_s, version: nil) unless lib == "." || lib == ".."
         end
       else
         Array(library).each do |lib|
-          loader.add(library: lib.to_s)
+          loader.add(library: lib.to_s, version: nil)
         end
       end
 
@@ -117,10 +117,13 @@ module Orthoses
             "{ #{object.map { |k, v| "#{k}: #{object_to_rbs(v, strict: strict)}" }.join(', ')} }"
           else
             keys = object.keys.map { |k| object_to_rbs(k, strict: strict) }.uniq
-            values = object.values.map { |k| object_to_rbs(k, strict: strict) }.uniq
+            values = object.values.map { |v| object_to_rbs(v, strict: strict) }.uniq
             "Hash[#{keys.join(' | ')}, #{values.join(' | ')}]"
           end
         end
+      when ARGF
+        # see also https://github.com/ruby/rbs/pull/975
+        'untyped'
       else
         Utils.module_name(object.class) || 'untyped'
       end

data/lib/orthoses/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orthoses
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/orthoses/writer.rb

@@ -0,0 +1,16 @@
+module Orthoses
+  class Writer
+    def initialize(loader, io:)
+      @loader = loader
+      @io = io
+    end
+
+    def call
+      @loader.call.tap do |store|
+        store.each do |name, content|
+          @io.write content.to_rbs
+        end
+      end
+    end
+  end
+end

data/lib/orthoses.rb

@@ -14,11 +14,13 @@ require_relative 'orthoses/mixin'
 require_relative 'orthoses/load_rbs'
 require_relative 'orthoses/object_space_all'
 require_relative 'orthoses/pp'
+require_relative 'orthoses/rbs_prototype_rb'
 require_relative 'orthoses/store'
 require_relative 'orthoses/tap'
 require_relative 'orthoses/utils'
 require_relative 'orthoses/version'
 require_relative 'orthoses/walk'
+require_relative 'orthoses/writer'
 
 module Orthoses
   class ConstLoadError < StandardError

data/sig/orthoses/call_tracer.rbs

@@ -2,4 +2,5 @@
 
 class Orthoses::CallTracer
   attr_accessor result: Array[[ Method, Hash[Symbol, untyped] ]]
+  def trace: [T] (Method | UnboundMethod) ?{ () -> T } -> T
 end

data/sig/orthoses/const_load_error.rbs

@@ -1,6 +1,6 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
-class Orthoses::ConstLoadError < StandardError
+class Orthoses::ConstLoadError < ::StandardError
   attr_reader root: Module
   attr_reader const: Symbol
   attr_reader error: untyped

data/sig/orthoses/content/environment.rbs

@@ -0,0 +1,13 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+class Orthoses::Content::Environment
+  type constant_filter = ^(RBS::AST::Declarations::Constant) -> boolish
+  type mixin_filter = ^(RBS::AST::Members::Mixin) -> boolish
+  @env: RBS::Environment
+  @constant_filter: constant_filter?
+  @mixin_filter: mixin_filter?
+  def initialize: (?constant_filter: constant_filter?, ?mixin_filter: mixin_filter?) -> void
+  def <<: (RBS::AST::Declarations::t decl) -> RBS::Environment
+  def write_to: (store: Orthoses::store) -> void
+  def each: () { (Orthoses::Content) -> void } -> void
+end

data/sig/orthoses/delegate_class.rbs

@@ -1,4 +1,7 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
 class Orthoses::DelegateClass
+  @loader: Orthoses::_Call
+  include Orthoses::_MiddleWare
+  def initialize: (Orthoses::_Call loader) -> void
 end

data/sig/orthoses/load_rbs.rbs

@@ -1,4 +1,8 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
 class Orthoses::LoadRBS
+  @loader: Orthoses::_Call
+  @paths: Array[_ToS]
+  include Orthoses::_MiddleWare
+  def initialize: (Orthoses::_Call loader, paths: Array[_ToS]) -> void
 end

data/sig/orthoses/name_space_error.rbs

@@ -1,4 +1,4 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
-class Orthoses::NameSpaceError < StandardError
+class Orthoses::NameSpaceError < ::StandardError
 end

data/sig/orthoses/object_space_all.rbs

@@ -1,4 +1,7 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
 class Orthoses::ObjectSpaceAll
+  @loader: Orthoses::_Call
+  include Orthoses::_MiddleWare
+  def initialize: (Orthoses::_Call loader, ?if: ^(Module) -> boolish) -> void
 end

data/sig/orthoses/rbs_prototype_rb.rbs

@@ -0,0 +1,10 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+class Orthoses::RBSPrototypeRB
+  @loader: Orthoses::_Call
+  include Orthoses::_MiddleWare
+  def initialize: (Orthoses::_Call loader, paths: Array[_ToS], ?constant_filter: Orthoses::Content::Environment::constant_filter?, ?mixin_filter: Orthoses::Content::Environment::mixin_filter?) -> void
+  @paths: Array[_ToS]
+  @constant_filter: Orthoses::Content::Environment::constant_filter?
+  @mixin_filter: Orthoses::Content::Environment::mixin_filter?
+end

data/sig/orthoses/tap.rbs

@@ -1,4 +1,7 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
 class Orthoses::Tap
+  @loader: Orthoses::_Call
+  include Orthoses::_MiddleWare
+  def initialize: (Orthoses::_Call loader) -> void
 end

data/sig/orthoses/writer.rbs

@@ -0,0 +1,7 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+class Orthoses::Writer
+  @loader: Orthoses::_Call
+  include Orthoses::_MiddleWare
+  def initialize: (Orthoses::_Call loader, io: _Writer) -> void
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - lib/orthoses.rb
@@ -41,6 +42,7 @@ files:
 - lib/orthoses/constant.rb
 - lib/orthoses/content.rb
 - lib/orthoses/content/duplication_checker.rb
+- lib/orthoses/content/environment.rb
 - lib/orthoses/create_file_by_name.rb
 - lib/orthoses/delegate_class.rb
 - lib/orthoses/filter.rb
@@ -48,11 +50,13 @@ files:
 - lib/orthoses/mixin.rb
 - lib/orthoses/object_space_all.rb
 - lib/orthoses/pp.rb
+- lib/orthoses/rbs_prototype_rb.rb
 - lib/orthoses/store.rb
 - lib/orthoses/tap.rb
 - lib/orthoses/utils.rb
 - lib/orthoses/version.rb
 - lib/orthoses/walk.rb
+- lib/orthoses/writer.rb
 - orthoses.gemspec
 - sig/orthoses.rbs
 - sig/orthoses/_call.rbs
@@ -64,6 +68,7 @@ files:
 - sig/orthoses/constant.rbs
 - sig/orthoses/content.rbs
 - sig/orthoses/content/duplication_checker.rbs
+- sig/orthoses/content/environment.rbs
 - sig/orthoses/create_file_by_name.rbs
 - sig/orthoses/delegate_class.rbs
 - sig/orthoses/filter.rbs
@@ -72,10 +77,12 @@ files:
 - sig/orthoses/name_space_error.rbs
 - sig/orthoses/object_space_all.rbs
 - sig/orthoses/pp.rbs
+- sig/orthoses/rbs_prototype_rb.rbs
 - sig/orthoses/store.rbs
 - sig/orthoses/tap.rbs
 - sig/orthoses/utils.rbs
 - sig/orthoses/walk.rbs
+- sig/orthoses/writer.rbs
 homepage: https://github.com/ksss/orthoses
 licenses:
 - MIT
@@ -97,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.0.dev
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Framework for Generate RBS