orthoses 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8718c01d3ca0c5ea18285c9082218c526e280626d15da555b17773ec8d582ac3
-  data.tar.gz: 2541364526894cb9f2870a4a69169418ca57ad042911507bd96557e54df1abfd
+  metadata.gz: 758b4661d8c0df218aa722a78505efee6dec692b601aad81e660c86444389f5e
+  data.tar.gz: bcfbe10b12f0d3ef2444a7461d2a5004410b89b8d88ef3c100fb6e88f3325e6d
 SHA512:
-  metadata.gz: b8dbc5aaeda5a1943a61bfc8b0190994373284e5c4712d2ffe710fe31fe95949406b8d2a3929dfad09b573b14c19d81c7f558cbc7ac197055d128596e2625272
-  data.tar.gz: 465cff7f5fa29e7b599549a790b85ba1d597e820e6437811ead5e8de031fee797ef07746bba448451b2b73715511e8bd59a65cb8b32bf86ab1d09832a06ac3a7
+  metadata.gz: 3b8813677299e76fe253d87e0ab8460ba596c0c6805225767525c60c7f9845bc62cdd9e4f491cb8a2a6197ae473deacd15e78ce29f209305e7e3b1a86a391661
+  data.tar.gz: b3979ddfbc4f209ce221c2e93e0a80c7d7120d0ef541d6f0061777db7f30b290170fae324aa3d3c4e6d99fbbd37c96a166473aefcc10b404647a5b4bfa0250f3

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    orthoses (1.1.0)
+    orthoses (1.3.0)
       rbs (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.3.1)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -17,7 +17,7 @@ GEM
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    language_server-protocol (3.17.0.0)
+    language_server-protocol (3.17.0.1)
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -27,25 +27,27 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rb-fsevent (0.11.1)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.6.0)
+    rbs (2.7.0)
     rgot (1.1.0)
-    steep (1.1.1)
+    securerandom (0.2.0)
+    steep (1.2.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
       parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.3.2)
+      rbs (>= 2.7.0)
+      securerandom (>= 0.1)
       terminal-table (>= 2, < 4)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -32,7 +32,7 @@ namespace :rbs do
   desc "build RBS to sig/out"
   task :build do
     Orthoses::Builder.new do
-      use Orthoses::CreateFileByName
+      use Orthoses::CreateFileByName,
         base_dir: Rails.root.join("sig/out"),
         header: "# !!! GENERATED CODE !!!"
       use Orthoses::Filter do |name, _content|
@@ -165,11 +165,6 @@ Run `rbs prototype rb` command process to `paths` option files.
 
 Run `rbs prototype runtime` command process with `patterns` option string.
 
-### Orthoses::AvoidRecursiveAncestorError
-
-Mixin a module into an Object class raises `RBS::RecursiveAncestorError` when validation.
-Please add this middleware then.
-
 ### Orthoses::Autoload
 
 Force load const defined by `autoload`.

data/lib/orthoses/content/duplication_checker.rb

@@ -4,7 +4,7 @@ module Orthoses
     class DuplicationChecker
       def initialize(decl, env: nil)
         @decl = decl
-        @env = env || Utils.rbs_environment(collection: true)
+        @env = env || Utils.rbs_environment
       end
 
       def update_decl

data/lib/orthoses/content/environment.rb

@@ -17,7 +17,7 @@ module Orthoses
 
       def initialize(constant_filter: nil, mixin_filter: nil, attribute_filter: nil)
         @load_env = RBS::Environment.new
-        @known_env = Utils.rbs_environment(collection: true, cache: false)
+        @known_env = Utils.rbs_environment(cache: false)
         @constant_filter = constant_filter
         @mixin_filter = mixin_filter
         @attribute_filter = attribute_filter

data/lib/orthoses/content.rb

@@ -19,19 +19,24 @@ module Orthoses
     attr_reader :name
     attr_reader :body
     attr_accessor :header
+    attr_accessor :comment
 
     def initialize(name:)
       Orthoses.logger.debug("Create Orthoses::Content for #{name}")
       @name = name
       @body = []
       @header = nil
+      @comment = nil
+      @uniq = false
     end
 
     def <<(line)
+      @uniq = false
       @body << line
     end
 
     def concat(other)
+      @uniq = false
       @body.concat(other)
     end
 
@@ -39,7 +44,12 @@ module Orthoses
       @body.empty?
     end
 
+    def interface?
+      @name.split('::').last.start_with?('_')
+    end
+
     def delete(val)
+      @uniq = false
       @body.delete(val)
     end
 
@@ -63,7 +73,9 @@ module Orthoses
     end
 
     def original_rbs
-      a = [@header]
+      a = []
+      a << @comment if @comment
+      a << @header
       a << "  #{@body.join("\n  ")}" if @body.length > 0
       a << "end"
       a.join("\n")
@@ -103,7 +115,10 @@ module Orthoses
       end
       parsed_decl = parsed_decls.first or raise
       parsed_decl.tap do |decl|
-        DuplicationChecker.new(decl).update_decl
+        if !@uniq
+          DuplicationChecker.new(decl).update_decl
+          @uniq = true
+        end
       end
     rescue RBS::ParsingError
       Orthoses.logger.error "```rbs\n#{original_rbs}```"
@@ -111,7 +126,7 @@ module Orthoses
     end
 
     def auto_header
-      env = Utils.rbs_environment(collection: true)
+      env = Utils.rbs_environment
       if entry = env.class_decls[TypeName(name).absolute!]
         @header = Content::HeaderBuilder.new(env: env).build(entry: entry)
         return
@@ -119,7 +134,7 @@ module Orthoses
 
       return unless @header.nil?
 
-      if name.split('::').last.start_with?('_')
+      if interface?
         self.header = "interface #{name}"
         return
       end

data/lib/orthoses/create_file_by_name.rb

@@ -13,33 +13,12 @@ module Orthoses
       @if = binding.local_variable_get(:if)
     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
-    })
+    using Utils::Underscore
 
     def call
       store = @loader.call
 
       store.each do |name, content|
-        begin
-          content.uniq!
-        rescue NameError, LoadError => err
-          Orthoses.logger.error(err.inspect)
-          next
-        end
-
         next unless @if.nil? || @if.call(name, content)
 
         file_path = Pathname("#{@base_dir}/#{name.to_s.split('::').map(&:underscore).join('/')}.rbs")
@@ -49,7 +28,7 @@ module Orthoses
             out.puts @header
             out.puts
           end
-          out.puts content.original_rbs
+          out.puts content.to_rbs
         end
         Orthoses.logger.info("Generate file to #{file_path.to_s}")
       end

data/lib/orthoses/outputable/avoid_recursive_ancestor_error.rb

@@ -11,6 +11,9 @@ module Orthoses
 
       def call
         @loader.call.tap do |store|
+          next if !store.key?("Object")
+          next if store["Object"].body.empty?
+
           object_mixins = {}
           collect_mixin_recursive(store, "Object", object_mixins)
 

data/lib/orthoses/outputable/constantizable_filter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module Outputable
+    # Constantizable is an internal middleware
+    # It's using on orthoses/outputable.rb
+    class ConstantizableFilter
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        @loader.call.tap do |store|
+          failures = []
+          store.each do |name, content|
+            next if content.header
+            next if content.interface?
+
+            begin
+              Object.const_get(name)
+            rescue NameError, LoadError => err
+              Orthoses.logger.error(err.inspect)
+              failures << name
+              next
+            end
+          end
+          failures.each { |name| store.delete(name) }
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/outputable/uniq_content_body.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module Outputable
+    # UniqContentBody is an internal middleware
+    # It's using on orthoses/outputable.rb
+    class UniqContentBody
+      def initialize(loader)
+        @loader = loader
+      end
+
+      def call
+        @loader.call.tap do |store|
+          store.each do |name, content|
+            content.uniq!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/orthoses/outputable.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'orthoses/outputable/avoid_recursive_ancestor_error'
+require 'orthoses/outputable/constantizable_filter'
+require 'orthoses/outputable/uniq_content_body'
 
 module Orthoses
   # Module for output middleware.
@@ -15,6 +17,8 @@ module Orthoses
   module Outputable
     def call
       @loader = AvoidRecursiveAncestorError.new(@loader)
+      @loader = ConstantizableFilter.new(@loader)
+      @loader = UniqContentBody.new(@loader)
       super
     end
   end

data/lib/orthoses/utils/underscore.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Orthoses
+  module Utils
+    module Underscore
+      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
+    end
+  end
+end

data/lib/orthoses/utils.rb

@@ -2,6 +2,8 @@
 
 module Orthoses
   module Utils
+    autoload :Underscore, "orthoses/utils/underscore"
+
     def self.unautoload!
       warn "`Orthoses::Utils.unautoload!` is deprecated. please use `Orthoses::Autoload` middleware instead."
       ObjectSpace.each_object(Module) do |mod|
@@ -27,7 +29,7 @@ module Orthoses
       end
     end
 
-    def self.rbs_defined_const?(name, library: nil, collection: false)
+    def self.rbs_defined_const?(name, library: nil, collection: true)
       return false if name.start_with?("#<")
       env = rbs_environment(library: library, collection: collection)
       name = name.sub(/Object::/, '')
@@ -35,7 +37,7 @@ module Orthoses
       env.constant_decls.has_key?(target)
     end
 
-    def self.rbs_defined_class?(name, library: nil, collection: false)
+    def self.rbs_defined_class?(name, library: nil, collection: true)
       return false if name.start_with?("#<")
       env = rbs_environment(library: library, collection: collection)
       target = rbs_type_name(name)
@@ -69,7 +71,7 @@ module Orthoses
       end
     }.call
 
-    def self.rbs_environment(library: nil, collection: false, cache: true)
+    def self.rbs_environment(library: nil, collection: true, cache: true)
       @env_cache ||= {}
       if cache && hit = @env_cache[[library, collection]]
         return hit
@@ -188,7 +190,7 @@ module Orthoses
         else
           raise TypeError
         end
-      rbs_environment(collection: true).class_decls[type_name]&.then do |entry|
+      rbs_environment.class_decls[type_name]&.then do |entry|
         entry.decls.first.decl.type_params
       end
     end

data/lib/orthoses/version.rb

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

data/lib/orthoses.rb

@@ -3,33 +3,31 @@
 require 'rbs'
 require 'pathname'
 
-require_relative 'orthoses/attribute'
-require_relative 'orthoses/builder'
-require_relative 'orthoses/call_tracer'
-require_relative 'orthoses/constant'
-require_relative 'orthoses/content'
-require_relative 'orthoses/create_file_by_name'
-require_relative 'orthoses/delegate_class'
-require_relative 'orthoses/filter'
-require_relative 'orthoses/mixin'
-require_relative 'orthoses/load_rbs'
-require_relative 'orthoses/object_space_all'
-require_relative 'orthoses/outputable'
-require_relative 'orthoses/path_helper'
-require_relative 'orthoses/pp'
-require_relative 'orthoses/rbs_prototype_rb'
-require_relative 'orthoses/rbs_prototype_runtime'
-require_relative 'orthoses/store'
-require_relative 'orthoses/tap'
-require_relative 'orthoses/autoload'
-require_relative 'orthoses/utils'
-require_relative 'orthoses/version'
-require_relative 'orthoses/walk'
-require_relative 'orthoses/writer'
-
 module Orthoses
-  # Use autoload just in case there are side effects.
+  autoload :Attribute, 'orthoses/attribute'
+  autoload :Builder, 'orthoses/builder'
+  autoload :CallTracer, 'orthoses/call_tracer'
+  autoload :Constant, 'orthoses/constant'
+  autoload :Content, 'orthoses/content'
+  autoload :CreateFileByName, 'orthoses/create_file_by_name'
+  autoload :DelegateClass, 'orthoses/delegate_class'
+  autoload :Filter, 'orthoses/filter'
+  autoload :Mixin, 'orthoses/mixin'
   autoload :LazyTracePoint, 'orthoses/lazy_trace_point'
+  autoload :LoadRBS, 'orthoses/load_rbs'
+  autoload :ObjectSpaceAll, 'orthoses/object_space_all'
+  autoload :Outputable, 'orthoses/outputable'
+  autoload :PathHelper, 'orthoses/path_helper'
+  autoload :PP, 'orthoses/pp'
+  autoload :RBSPrototypeRB, 'orthoses/rbs_prototype_rb'
+  autoload :RBSPrototypeRuntime, 'orthoses/rbs_prototype_runtime'
+  autoload :Store, 'orthoses/store'
+  autoload :Tap, 'orthoses/tap'
+  autoload :Autoload, 'orthoses/autoload'
+  autoload :Utils, 'orthoses/utils'
+  autoload :VERSION, 'orthoses/version'
+  autoload :Walk, 'orthoses/walk'
+  autoload :Writer, 'orthoses/writer'
 
   METHOD_METHOD = ::Kernel.instance_method(:method)
   INSTANCE_METHOD_METHOD = ::Module.instance_method(:instance_method)

data/sig/orthoses/attribute/hook.rbs

@@ -2,7 +2,10 @@
 
 module Orthoses::Attribute::Hook
   def attr: (*untyped names) -> untyped
+
   def attr_accessor: (*untyped names) -> untyped
+
   def attr_reader: (*untyped names) -> untyped
+
   def attr_writer: (*untyped names) -> untyped
 end

data/sig/orthoses/call_tracer/capturable.rbs

@@ -2,6 +2,8 @@
 
 module Orthoses::CallTracer::Capturable
   def build_capture: (untyped tp) -> untyped
+
   private def build_method: (untyped tp) -> untyped
+
   private def build_argument: (untyped tp) -> untyped
 end

data/sig/orthoses/content.rbs

@@ -5,6 +5,7 @@ class Orthoses::Content
   def <<: (String) -> void
   def concat: (Array[String]) -> void
   def empty?: () -> untyped
+  def interface?: () -> untyped
   def delete: (untyped val) -> untyped
   def to_rbs: () -> String
   def to_decl: () -> untyped

data/sig/orthoses/mixin/hook.rbs

@@ -2,6 +2,8 @@
 
 module Orthoses::Mixin::Hook
   def include: (*untyped modules) -> untyped
+
   def extend: (*untyped modules) -> untyped
+
   def prepend: (*untyped modules) -> untyped
 end

data/sig/orthoses/outputable/constantizable_filter.rbs

@@ -0,0 +1,6 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+class Orthoses::Outputable::ConstantizableFilter
+  def initialize: (untyped loader) -> void
+  def call: () -> untyped
+end

data/sig/orthoses/outputable/uniq_content_body.rbs

@@ -0,0 +1,6 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+class Orthoses::Outputable::UniqContentBody
+  def initialize: (untyped loader) -> void
+  def call: () -> untyped
+end

data/sig/orthoses/utils/underscore.rbs

@@ -0,0 +1,4 @@
+# THIS IS GENERATED CODE from `$ rake generate_self_sig`
+
+module Orthoses::Utils::Underscore
+end

data/sig/orthoses/utils.rbs

@@ -2,16 +2,28 @@
 
 module Orthoses::Utils
   def self.unautoload!: () -> untyped
+
   def self.each_const_recursive: (Module root, ?cache: Hash[untyped, true], ?on_error: ^(Orthoses::ConstLoadError) -> void) ?{ (Module, Symbol, untyped) -> void } -> void
+
   def self.rbs_defined_const?: (String name, ?library: (String | Array[String])?, ?collection: boolish) -> bool
+
   def self.rbs_defined_class?: (String name, ?library: (String | Array[String])?, ?collection: boolish) -> bool
+
   def self.rbs_type_name: (String) -> RBS::TypeName
+
   def self.rbs_environment: (?library: String | Array[String] | nil, ?collection: boolish, ?cache: boolish) -> RBS::Environment
+
   def self.object_to_rbs: (untyped object, strict: bool) -> String
+
   def self.module_name: (Module mod) -> String?
+
   def self.module_to_type_name: (Module) -> RBS::TypeName?
+
   def self.known_type_params: (Module | String) -> Array[RBS::AST::TypeParam]?
+
   def self.new_store: () -> Orthoses::store
+
   UNBOUND_NAME_METHOD: UnboundMethod
+
   attr_accessor self.rbs_collection_pathname: Pathname
 end

data/sig/orthoses.rbs

@@ -1,9 +1,13 @@
 # THIS IS GENERATED CODE from `$ rake generate_self_sig`
 
 module Orthoses
-  VERSION: "1.1.0"
+  VERSION: "1.3.0"
+
   attr_accessor self.logger: ::Logger
+
   type store = Hash[String, Orthoses::Content]
+
   INSTANCE_METHOD_METHOD: UnboundMethod
+
   METHOD_METHOD: UnboundMethod
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-14 00:00:00.000000000 Z
+date: 2022-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -60,6 +60,8 @@ files:
 - lib/orthoses/object_space_all.rb
 - lib/orthoses/outputable.rb
 - lib/orthoses/outputable/avoid_recursive_ancestor_error.rb
+- lib/orthoses/outputable/constantizable_filter.rb
+- lib/orthoses/outputable/uniq_content_body.rb
 - lib/orthoses/path_helper.rb
 - lib/orthoses/pp.rb
 - lib/orthoses/rbs_prototype_rb.rb
@@ -67,6 +69,7 @@ files:
 - lib/orthoses/store.rb
 - lib/orthoses/tap.rb
 - lib/orthoses/utils.rb
+- lib/orthoses/utils/underscore.rb
 - lib/orthoses/version.rb
 - lib/orthoses/walk.rb
 - lib/orthoses/writer.rb
@@ -103,6 +106,8 @@ files:
 - sig/orthoses/object_space_all.rbs
 - sig/orthoses/outputable.rbs
 - sig/orthoses/outputable/avoid_recursive_ancestor_error.rbs
+- sig/orthoses/outputable/constantizable_filter.rbs
+- sig/orthoses/outputable/uniq_content_body.rbs
 - sig/orthoses/path_helper.rbs
 - sig/orthoses/pp.rbs
 - sig/orthoses/rbs_prototype_rb.rbs
@@ -110,6 +115,7 @@ files:
 - sig/orthoses/store.rbs
 - sig/orthoses/tap.rbs
 - sig/orthoses/utils.rbs
+- sig/orthoses/utils/underscore.rbs
 - sig/orthoses/walk.rbs
 - sig/orthoses/writer.rbs
 homepage: https://github.com/ksss/orthoses
@@ -133,7 +139,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.16
 signing_key:
 specification_version: 4
 summary: Framework for Generate RBS