typespec_from_serializers 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bc90948b5d93848663bab0d1162a1f26d49d832a05ef4c57eb5cb1e90f74ff3
-  data.tar.gz: '008ddb8319166e72e2e75a30d840ad387a082df6e4d0846698e87f9b15ac1c05'
+  metadata.gz: 80df92c4cd5814bc352130e1d4eb56d648c7efbb46158a99bf98a100f55cc186
+  data.tar.gz: f1d3027b282117a49be85a929cf85183ce22a08e39a6a8390d7f3be1363c85cb
 SHA512:
-  metadata.gz: 950c7c34c0d3766854fd6eb4b3aa958b7ed8a20040ad8a43c5573d52741b156441b43e0fbded753536624d368ce353959f5f9e13d311eddea05ba75b8a4e85df
-  data.tar.gz: 6695700e9a0f73b03e97107d1844e2ef878dcf50217b45826418488827643923260f9b2465bd20fc4d03ef298ea2028f87132fa496abbb67f43ad635fda47562
+  metadata.gz: 99f22f4f43af8b642d4e69e81b089f472e252b9075df4975a34e392226fea6c5b9e01b39bd8cb555a3f03c1bac0cb8b113a04ea2daa68e0ea87a4b40c6f0a5d7
+  data.tar.gz: 38fc2e2f89bc1e8933de619f8573806bb562e907fc71a46c66c58d4411f25299c6f96d6507440542c8b1ebe841bfe3d2538c1eaa2a0ceaea9c556a1edeb771ef

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # TypeSpec From Serializers Changelog
 
+## [0.6.0] - 2026-03-03
+
+### Added
+- Automatic route namespace/interface disambiguation: names that collide with model names are suffixed (e.g., `namespace Task` → `namespace TaskRoutes` when `TaskSerializer` exists)
+- New `route_namespace_suffix` config option (default: `"Routes"`) to control the disambiguation suffix
+- Content-based cache keys: files are only rewritten when generated output actually changes, eliminating unnecessary diffs from internal representation changes
+
+## [0.5.4] - 2025-12-23
+
+### Fixed
+- Transitive params extraction now follows method calls through intermediate methods
+- Route-level `type:` declarations now only apply to actual path params (not inherited by collection routes)
+
 ## [0.5.3] - 2025-12-23
 
 ### Fixed

data/lib/typespec_from_serializers/generator.rb

@@ -213,6 +213,7 @@ module TypeSpecFromSerializers
     :custom_typespec_dir,
     :name_from_serializer,
     :controller_suffix,
+    :route_namespace_suffix,
     :param_method_suffix,
     :global_types,
     :sort_properties_by,
@@ -653,9 +654,10 @@ module TypeSpecFromSerializers
     # Internal: Defines a TypeSpec model for the serializer.
     def generate_model_for(serializer)
       model = serializer.tsp_model
+      content = serializer_model_content(model)
 
-      write_if_changed(filename: "models/#{model.filename}", cache_key: model.inspect, extension: "tsp") {
-        serializer_model_content(model)
+      write_if_changed(filename: "models/#{model.filename}", cache_key: content, extension: "tsp") {
+        content
       }
     rescue => e
       $stderr.puts "ERROR in generate_model_for(#{serializer.name}): #{e.class}: #{e.message}"
@@ -665,10 +667,10 @@ module TypeSpecFromSerializers
 
     # Internal: Allows to import all serializer types from a single file.
     def generate_index_file
-      cache_key = all_serializer_files.map { |file| file.delete_prefix(root.to_s) }.join
-      write_if_changed(filename: "index", cache_key: cache_key) {
-        load_serializers(all_serializer_files)
-        serializers_index_content(loaded_serializers)
+      load_serializers(all_serializer_files)
+      content = serializers_index_content(loaded_serializers)
+      write_if_changed(filename: "index", cache_key: content) {
+        content
       }
     end
 
@@ -677,9 +679,9 @@ module TypeSpecFromSerializers
       return [] unless defined?(Rails) && Rails.application
 
       routes, controllers = collect_rails_routes
-      cache_key = routes.map(&:inspect).join
-      write_if_changed(filename: "routes", cache_key: cache_key) {
-        routes_content(routes)
+      content = routes_content(routes)
+      write_if_changed(filename: "routes", cache_key: content) {
+        content
       }
 
       # Return list of controller class names
@@ -811,8 +813,10 @@ module TypeSpecFromSerializers
       operations = ns_routes.map { |route| build_operation(controller, route) }
       operations = make_operation_names_unique(operations)
 
+      interface_name = disambiguate_route_name(controller.tr("/", "_").camelize)
+
       Resource.new(
-        name: controller.tr("/", "_").camelize,
+        name: interface_name,
         path: base_path.start_with?("/") ? base_path : "/#{base_path}",
         operations: operations,
         parent_namespace: parent_namespace,
@@ -847,7 +851,10 @@ module TypeSpecFromSerializers
 
     # Internal: Extracts all parameter types from route metadata and controller DSL
     def extract_all_param_types(controller, route)
+      # Route-level types are for path params only - filter to actual path params
+      path_param_names = route[:path].scan(/:([a-zA-Z_][a-zA-Z0-9_]*)/).flatten
       route_param_types = route[:param_types]
+        .select { |k, _| path_param_names.include?(k.to_s) }
         .transform_keys(&:to_s)
         .transform_values { |v| map_type_class_to_typespec(v) }
 
@@ -912,11 +919,21 @@ module TypeSpecFromSerializers
     end
 
     # Internal: Extracts parent namespace from nested route paths
-    # E.g., "/lands/{land_id}/comments" → "Land"
-    #       "/tasks/{task_id}/comments" → "Task"
+    # E.g., "/lands/{land_id}/comments" → "LandRoutes" (suffixed to avoid model collision)
+    #       "/tasks/{task_id}/comments" → "TaskRoutes"
     def extract_parent_namespace(path)
       # Match pattern like /resource/:resource_id/nested (Rails uses : notation)
-      path[%r{^/([^/]+)/:[^/]+_id/}, 1]&.singularize&.camelize
+      name = path[%r{^/([^/]+)/:[^/]+_id/}, 1]&.singularize&.camelize
+      return unless name
+
+      disambiguate_route_name(name)
+    end
+
+    # Internal: Suffixes a route namespace/interface name if it collides with a model name.
+    # E.g., "Task" → "TaskRoutes" when TaskSerializer exists.
+    def disambiguate_route_name(name)
+      model_names = loaded_serializers.map { |s| s.tsp_name }
+      model_names.include?(name) ? "#{name}#{config.route_namespace_suffix}" : name
     end
 
     # Internal: Simplifies operation name using REST conventions
@@ -1133,19 +1150,40 @@ module TypeSpecFromSerializers
       {}
     end
 
-    # Internal: Finds *_params methods that are called by a specific action method
+    # Internal: Finds *_params methods that are called by a specific action method (transitively)
     def find_params_methods_called_by_action(controller_class, action)
       method_node = find_action_node(controller_class, action)
       return [] unless method_node
 
+      method = controller_class.instance_method(action)
+      file_path, = method.source_location
       suffix = config.param_method_suffix
-      find_method_calls(method_node)
-        .select { |name| name.end_with?(suffix) }
-        .map(&:to_sym)
+
+      find_params_methods_transitively(file_path, method_node, suffix)
     rescue
       []
     end
 
+    # Internal: Recursively finds *_params methods through intermediate method calls
+    def find_params_methods_transitively(file_path, node, suffix, visited = Set.new)
+      calls = find_method_calls(node)
+      params_methods = calls.select { |name| name.end_with?(suffix) }.map(&:to_sym)
+
+      # Follow non-params method calls defined in the same file
+      calls.each do |call_name|
+        next if call_name.end_with?(suffix)
+        next if visited.include?(call_name)
+
+        visited << call_name
+        called_node = find_def_node(file_path) { |n| n.name.to_s == call_name }
+        next unless called_node
+
+        params_methods.concat(find_params_methods_transitively(file_path, called_node, suffix, visited))
+      end
+
+      params_methods.uniq
+    end
+
     # Internal: Finds the AST node for a controller action method.
     def find_action_node(controller_class, action)
       return unless controller_class.method_defined?(action)
@@ -1154,7 +1192,7 @@ module TypeSpecFromSerializers
       file_path, line_number = method.source_location
       return unless file_path && File.exist?(file_path)
 
-      find_method_at_line(file_path, line_number)
+      find_def_node(file_path) { |node| node.location.start_line == line_number }
     end
 
     # Internal: Parses a Ruby file and caches the result.
@@ -1166,28 +1204,29 @@ module TypeSpecFromSerializers
       end
     end
 
-    # Internal: Finds a DefNode at the exact line number.
-    def find_method_at_line(file_path, line_number)
+    # Internal: Traverses all descendant nodes in BFS order.
+    def each_descendant(node)
+      return enum_for(:each_descendant, node) unless block_given?
+      queue = [node]
+      while (current = queue.shift)
+        yield current
+        queue.concat(current.compact_child_nodes)
+      end
+    end
+
+    # Internal: Finds a DefNode matching the given condition.
+    def find_def_node(file_path)
       ast = parse_file_cached(file_path)
       return unless ast
-
-      queue = [ast]
-      while (node = queue.shift)
-        return node if node.is_a?(Prism::DefNode) && node.location.start_line == line_number
-        queue.concat(node.compact_child_nodes)
-      end
-      nil
+      each_descendant(ast).find { |node| node.is_a?(Prism::DefNode) && yield(node) }
     end
 
     # Internal: Finds all unqualified method call names in an AST node.
     def find_method_calls(node)
-      calls = []
-      queue = [node]
-      while (current = queue.shift)
-        calls << current.name.to_s if current.is_a?(Prism::CallNode) && current.receiver.nil?
-        queue.concat(current.compact_child_nodes)
-      end
-      calls.uniq
+      each_descendant(node)
+        .select { |n| n.is_a?(Prism::CallNode) && n.receiver.nil? }
+        .map { |n| n.name.to_s }
+        .uniq
     end
 
     # Internal: Extracts key-value types from Sorbet hash type
@@ -1343,6 +1382,9 @@ module TypeSpecFromSerializers
         # Controller suffix for route generation reporting
         controller_suffix: "Controller",
 
+        # Suffix for route namespaces/interfaces that collide with model names
+        route_namespace_suffix: "Routes",
+
         # Types that don't need to be imported in TypeSpec.
         global_types: [
           "Array",

data/lib/typespec_from_serializers/version.rb

@@ -2,5 +2,5 @@
 
 module TypeSpecFromSerializers
   # Public: This library adheres to semantic versioning.
-  VERSION = "0.5.3"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typespec_from_serializers
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Danila Poyarkov
 - Máximo Mussini
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-23 00:00:00.000000000 Z
+date: 2026-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -328,7 +327,6 @@ homepage: https://github.com/dannote/typespec_from_serializers
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -343,8 +341,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Generate TypeSpec descriptions from your JSON serializers.
 test_files: []