rbs_heuristic_prototype 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a07c6fce554f459391e7d81cfee78e42cd54a78704d1ccefa27f6b289cdce67e
-  data.tar.gz: 78846ef4bcd829e0cb74de64feedc83314599fac49f9174919f6f72fd8e8c180
+  metadata.gz: 2ee5a4a5f00977d9e0dbc066729d092cec68269d386873fc3f5f54a916c307c9
+  data.tar.gz: 2418855e5847a4acaba0a3f03f9154126ab26026168a70764a3e30bec74d38fa
 SHA512:
-  metadata.gz: a4ad899d1c92ff8ebfa26dab2d041357440724637b1c28094d9748b4024b97214bd9a2328ddbc524e35cc0c468d0658113d31484ee34b93cae6d2d545e1e0aa2
-  data.tar.gz: ff09d89ee6476e0951e31fad137b172130cb82820072a8e6a86f85718c9afa9e6a36dcc384e66e12d774d71a38609bb1287b6326bb063c97e1cf94537e5dc046
+  metadata.gz: b50cbc5fdbef39926001a9a6ca9c4844a62985a4f1827d69bc03f4963059875ce48a1c235fc15d5f9d3479475903225dbf74f63bd4448d024ad69c007e1ff68e
+  data.tar.gz: 8d7c8d7b4a71c9574cd31b65359548fdad6e7782d00e675352a4ff77ec268bcf8ff864dd47f900783a4f575b8745148cc412916b793413f326822f1d57b92902

data/.rubocop.yml

@@ -15,5 +15,9 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
 Metrics/MethodLength:
   Max: 20

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbs_heuristic_prototype (0.1.0)
+    rbs_heuristic_prototype (0.2.0)
       rbs
 
 GEM
@@ -35,7 +35,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
     crass (1.0.6)
-    csv (3.2.6)
+    csv (3.2.7)
     diff-lcs (1.5.0)
     erubi (1.12.0)
     ffi (1.15.5)
@@ -106,7 +106,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.54.1)
+    rubocop (1.54.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -121,9 +121,9 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     securerandom (0.2.2)
-    steep (1.4.0)
+    steep (1.5.0)
       activesupport (>= 5.1)
-      concurrent-ruby (>= 1.2.2)
+      concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)
       fileutils (>= 1.1.0)
       json (>= 2.1.0)
@@ -132,7 +132,7 @@ GEM
       logger (>= 1.3.0)
       parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.8.0)
+      rbs (>= 3.1.0)
       securerandom (>= 0.1)
       strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)

data/README.md

@@ -29,7 +29,7 @@ gems:
 ## Usage
 
 1. Run `rbs prototype rb` or `rbs prototype runtime` first
-2. Run `rbs:prototype:heuristic`
+2. Run `rbs:prototype:heuristic:apply`
 
 Then rbs_heuristic_prototype will update the prototype signature files generated
 by `rbs prototype` according to the heuristic rules.
@@ -40,6 +40,9 @@ by `rbs prototype` according to the heuristic rules.
   * Convert a constant annotated with Array of Union of symbols (ex. `Array[:sym1 | :sym2 | ...]`) to a constant annotated with `Array[Symbol]`
   * This is useful to avoid `Ruby::IncompatibleAssignment` warning when right hand value uses `#freeze` method
     * ref: https://github.com/soutaro/steep/issues/363
+* Rule 3:
+  * Convert a scoped module/class definition (ex. `Foo::Bar::Baz`) to the nested definitions
+  * This is useful to define intermediate modules automatically like what Rails and zeitwerk does.
 
 ## Development
 
@@ -64,7 +67,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-
-
 Everyone interacting in the RbsHeuristicPrototype project's codebases, issue trackers is
 expected to follow the [code of conduct](https://github.com/tk0miya/rbs_heuristic_prototype/blob/main/CODE_OF_CONDUCT.md).

data/Steepfile

@@ -5,8 +5,7 @@ D = Steep::Diagnostic
 target :lib do
   signature "sig"
 
-  check "lib"                       # Directory name
-  check "Gemfile"                   # File name
+  check "lib"
 
-  configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  configure_code_diagnostics(D::Ruby.lenient)
 end

data/lib/rbs_heuristic_prototype/filters/active_model_validations_filter.rb

@@ -8,11 +8,16 @@ module RbsHeuristicPrototype
       attr_reader :klass
 
       def process_class(decl)
-        @klass = const_get(decl)
+        klass = const_get(decl)
 
-        return decl unless klass&.ancestors&.include?(ActiveModel::Validations)
-
-        super
+        if klass&.ancestors&.include?(ActiveModel::Validations)
+          @klass = klass
+          super
+        else
+          decl
+        end
+      ensure
+        @klass = nil
       end
 
       def process_member(member)

data/lib/rbs_heuristic_prototype/filters/base.rb

@@ -84,8 +84,9 @@ module RbsHeuristicPrototype
       end
 
       def const_get(decl)
-        decl.name.to_namespace.path.inject(Kernel) do |const, mod|
-          const.const_get(mod)
+        init = Kernel # : singleton(Class)?
+        decl.name.to_namespace.path.inject(init) do |const, mod|
+          const&.const_get(mod)
         end
       rescue StandardError
         nil

data/lib/rbs_heuristic_prototype/filters/deep_module_filter.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module RbsHeuristicPrototype
+  module Filters
+    class DeepModuleFilter < Base
+      attr_reader :stack
+
+      def initialize(env)
+        super
+        @stack = [::Kernel]
+      end
+
+      def process_module(decl) # rubocop:disable Metrics/AbcSize
+        if decl.name.namespace.empty?
+          namespaces = []
+          stack << const_get(decl)
+          super
+        else
+          namespaces = namespace_to_decl!(decl.name.namespace)
+          decl = decl.dup
+          decl.instance_eval { @name = RBS::TypeName.new(name: name.name, namespace: RBS::Namespace.empty) }
+          (_ = namespaces.last).members << super
+          namespaces.first or raise
+        end
+      ensure
+        namespaces.size.succ.times { stack.pop }
+      end
+
+      def process_class(decl) # rubocop:disable Metrics/AbcSize
+        if decl.name.namespace.empty?
+          namespaces = []
+          stack << const_get(decl)
+          super
+        else
+          namespaces = namespace_to_decl!(decl.name.namespace)
+          decl = decl.dup
+          decl.instance_eval { @name = RBS::TypeName.new(name: name.name, namespace: RBS::Namespace.empty) }
+          stack << stack.last&.const_get(decl.name.name)
+          (_ = namespaces.last).members << super
+          namespaces.first or raise
+        end
+      ensure
+        namespaces.size.succ.times { stack.pop }
+      end
+
+      def namespace_to_decl!(namespace)
+        namespaces = []
+        namespace.path.each do |path|
+          obj = stack.last&.const_get(path)
+          stack << obj
+          decl = obj_to_decl(obj)
+          namespaces.last.members << decl unless namespaces.empty?
+          namespaces << decl
+        end
+        namespaces
+      end
+
+      def obj_to_decl(obj) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        if obj.is_a?(Class)
+          if (superclass = obj.superclass)
+            super_class = RBS::AST::Declarations::Class::Super.new(name: TypeName(superclass.name.to_s),
+                                                                   args: [],
+                                                                   location: nil)
+          end
+          RBS::AST::Declarations::Class.new(
+            name: TypeName(obj.name.to_s.split("::").last.to_s),
+            type_params: [],
+            super_class:,
+            members: [],
+            annotations: [],
+            location: nil,
+            comment: nil
+          )
+        else
+          RBS::AST::Declarations::Module.new(
+            name: TypeName(obj.name.to_s.split("::").last.to_s),
+            type_params: [],
+            members: [],
+            self_types: [],
+            annotations: [],
+            location: nil,
+            comment: nil
+          )
+        end
+      end
+    end
+  end
+end

data/lib/rbs_heuristic_prototype/filters/symbol_array_constants_filter.rb

@@ -19,11 +19,9 @@ module RbsHeuristicPrototype
       end
 
       def process_constant_type(type)
-        # @type var location: untyped
         name = RBS::TypeName.new(namespace: RBS::Namespace.root, name: :Symbol)
-        location = type.location
-        symbol = RBS::Types::Alias.new(name:, args: [], location:)
-        RBS::Types::ClassInstance.new(name: type.name, args: [symbol], location:)
+        symbol = RBS::Types::Alias.new(name:, args: [], location: type.location)
+        RBS::Types::ClassInstance.new(name: type.name, args: [symbol], location: type.location)
       end
 
       def symbol_array?(type)

data/lib/rbs_heuristic_prototype/rake_task.rb

@@ -9,6 +9,7 @@ module RbsHeuristicPrototype
     FILTERS = {
       active_model_validations: Filters::ActiveModelValidationsFilter,
       boolean_methods: Filters::BooleanMethodsFilter,
+      deep_module: Filters::DeepModuleFilter,
       symbol_array_constants: Filters::SymbolArrayConstantsFilter
     }.freeze
 

data/lib/rbs_heuristic_prototype/version.rb

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

data/lib/rbs_heuristic_prototype.rb

@@ -2,6 +2,7 @@
 
 require_relative "rbs_heuristic_prototype/filters/active_model_validations_filter"
 require_relative "rbs_heuristic_prototype/filters/boolean_methods_filter"
+require_relative "rbs_heuristic_prototype/filters/deep_module_filter"
 require_relative "rbs_heuristic_prototype/filters/symbol_array_constants_filter"
 require_relative "rbs_heuristic_prototype/rake_task"
 require_relative "rbs_heuristic_prototype/version"

data/sig/rbs_heuristic_prototype/filters/active_model_validations_filter.rbs

@@ -1,7 +1,9 @@
 module RbsHeuristicPrototype
   module Filters
     class ActiveModelValidationsFilter < Base
-      @klass: Class?
+      attr_reader klass: singleton(ActiveModel::Validations)?
+
+      @klass: singleton(ActiveModel::Validations)?
 
       def process_class: (RBS::AST::Declarations::Class decl) -> RBS::AST::Declarations::Class
       def process_member: (RBS::AST::Members::t member) -> RBS::AST::Members::t

data/sig/rbs_heuristic_prototype/filters/base.rbs

@@ -10,7 +10,7 @@ module RbsHeuristicPrototype
       def process_class: (RBS::AST::Declarations::Class decl) -> RBS::AST::Declarations::Class
       def process_constant: (RBS::AST::Declarations::Constant member) -> RBS::AST::Declarations::Constant
       def process_member: (RBS::AST::Members::t member) -> RBS::AST::Members::t
-      def const_get: (RBS::AST::Declarations::t decl) -> Class?
+      def const_get: (RBS::AST::Declarations::Class | RBS::AST::Declarations::Module decl) -> singleton(Class)?
     end
   end
 end

data/sig/rbs_heuristic_prototype/filters/deep_module_filter.rbs

@@ -0,0 +1,15 @@
+module RbsHeuristicPrototype
+  module Filters
+    class DeepModuleFilter < Base
+      attr_reader stack: Array[Module | Class | nil]
+
+      @stack: Array[Module | Class | nil]
+
+      def initialize: (RBS::Environment env) -> void
+      def process_module: (RBS::AST::Declarations::Module decl) -> RBS::AST::Declarations::t
+      def process_class: (RBS::AST::Declarations::Class decl) -> RBS::AST::Declarations::t
+      def namespace_to_decl!: (RBS::Namespace namespace) -> Array[RBS::AST::Declarations::Module | RBS::AST::Declarations::Class]
+      def obj_to_decl: (Module | Class obj) -> (RBS::AST::Declarations::Module | RBS::AST::Declarations::Class)
+    end
+  end
+end

data/sig/rbs_heuristic_prototype/filters/symbol_array_constants_filter.rbs

@@ -2,11 +2,11 @@ module RbsHeuristicPrototype
   module Filters
     class SymbolArrayConstantsFilter < Base
       def process_constant: (RBS::AST::Declarations::Constant constant) -> RBS::AST::Declarations::Constant
-      def process_constant_type: (RBS::Types::t type) -> RBS::Types::ClassInstance
-      def symbol_array?: (RBS::Types::t type) -> bool
-      def array?: (RBS::Types::t type) -> bool
-      def symbol_union?: (RBS::Types::t type) -> bool
-      def symbol?: (RBS::Types::t type) -> bool
+      def process_constant_type: (untyped type) -> RBS::Types::ClassInstance
+      def symbol_array?: (untyped type) -> bool
+      def array?: (untyped type) -> bool
+      def symbol_union?: (untyped type) -> bool
+      def symbol?: (untyped type) -> bool
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbs_heuristic_prototype
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Takeshi KOMIYA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-15 00:00:00.000000000 Z
+date: 2023-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs
@@ -47,6 +47,7 @@ files:
 - lib/rbs_heuristic_prototype/filters/active_model_validations_filter.rb
 - lib/rbs_heuristic_prototype/filters/base.rb
 - lib/rbs_heuristic_prototype/filters/boolean_methods_filter.rb
+- lib/rbs_heuristic_prototype/filters/deep_module_filter.rb
 - lib/rbs_heuristic_prototype/filters/symbol_array_constants_filter.rb
 - lib/rbs_heuristic_prototype/rake_task.rb
 - lib/rbs_heuristic_prototype/version.rb
@@ -59,6 +60,7 @@ files:
 - sig/rbs_heuristic_prototype/filters/active_model_validations_filter.rbs
 - sig/rbs_heuristic_prototype/filters/base.rbs
 - sig/rbs_heuristic_prototype/filters/boolean_methods_filter.rbs
+- sig/rbs_heuristic_prototype/filters/deep_module_filter.rbs
 - sig/rbs_heuristic_prototype/filters/symbol_array_constants_filter.rbs
 - sig/rbs_heuristic_prototype/rake_task.rbs
 homepage: https://github.com/tk0miya/rbs_heuristic_prototype