typespec_from_serializers 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a1d95c0934cefa4c37d29af028dbd3677a3d07b5a6f8af804c206400091472d
-  data.tar.gz: 8ea38365134c4d22d0e60fb19886d6803e6ee9ad82b97a52c8e21decb4ee916c
+  metadata.gz: 58c9803235729fabc83ae742e83822906d3ed88746e2c40f7d04d7368409a5cb
+  data.tar.gz: de245ba8d20d6b695af332f886c8b0b83a491cd563364a2c06f000c90726739e
 SHA512:
-  metadata.gz: 2cfdedc3b5e45b9b9fac2e6abbfd215495787f9eb150d639091f3e5df9eaa4b4d7f84b5ba5fab3ede09876df871a08b11a3165eb358cc2788bac3be8ebbe41ea
-  data.tar.gz: 745708a0339c1cb4f7f45773eff7a2751826d734a9f6a252a6f275c050ad194b4b9c9464cd6f81e885575befda88345681db27389a980b9ae36ab64eadd51b27
+  metadata.gz: efc632aa512a2fec97c35bde59de42c1516ec23d4231be04cbc3238ca5a1bc7756c495cb9b7efcbb5a0209aade99bd6096b04229b0b6bbc4b1afae58a5b4b62b
+  data.tar.gz: 2a2fb5ca8cf367d6a22649538af11e2ee690256522caca1b63de0639d8e5b64fb8d6d5af1453ac7604a2632c439b3132652a4b906d16b0cac76c0ac4c87150f3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # TypeSpec From Serializers Changelog
 
+## [0.5.0] - 2025-12-22
+
+### Fixed
+- Route parameter typing with `type:` now works correctly without interfering with Rails routing
+
 ## [0.4.0] - 2025-12-22
 
 ### Added

data/lib/typespec_from_serializers/generator.rb

@@ -30,6 +30,21 @@ module TypeSpecFromSerializers
   module Linting
     extend self
 
+    @warning_count = 0
+
+    def reset_count
+      @warning_count = 0
+    end
+
+    def warning_count
+      @warning_count
+    end
+
+    def print_summary
+      return if @warning_count == 0
+      puts "\nTypeSpec generation completed with #{@warning_count} lint warning#{'s' unless @warning_count == 1}"
+    end
+
     # Internal: Lints for missing parameter types
     def missing_param_types(controller, route, path_param_names, param_types, config)
       return unless enabled?(config.linting, :missing_param_types)
@@ -37,6 +52,7 @@ module TypeSpecFromSerializers
       missing_path_params = path_param_names.select { |name| !param_types.key?(name) }
 
       unless missing_path_params.empty?
+        @warning_count += 1
         location = "#{controller.camelize}#{config.controller_suffix}##{route[:action]}"
         warn "TypeSpec Lint: Missing type for path parameter(s) #{missing_path_params.join(', ')} in #{location} (#{route[:method]} #{route[:path]}). Defaulting to 'string'."
       end
@@ -47,6 +63,7 @@ module TypeSpecFromSerializers
       return unless enabled?(config.linting, :unknown_response_types)
 
       if response_type == "unknown"
+        @warning_count += 1
         location = "#{controller.camelize}#{config.controller_suffix}##{route[:action]}"
         warn "TypeSpec Lint: Unknown response type for #{location} (#{route[:method]} #{route[:path]}). Consider adding a serializer or explicit type annotation."
       end
@@ -57,6 +74,7 @@ module TypeSpecFromSerializers
       return unless enabled?(config.linting, :missing_documentation) && config.extract_docs
 
       if doc.nil?
+        @warning_count += 1
         location = "#{controller.camelize}#{config.controller_suffix}##{route[:action]}"
         warn "TypeSpec Lint: Missing documentation for #{location} (#{route[:method]} #{route[:path]}). Consider adding an RDoc comment."
       end
@@ -68,6 +86,7 @@ module TypeSpecFromSerializers
 
       duplicates = name_counts.select { |_, count| count > 1 }
       duplicates.each do |action, count|
+        @warning_count += 1
         ops = operations.select { |op| op.action == action }
         methods = ops.map { |op| op.method }.join(', ')
         warn "TypeSpec Lint: Action '#{action}' used for multiple routes (#{methods}). Using method suffix to differentiate."
@@ -79,6 +98,7 @@ module TypeSpecFromSerializers
       return unless enabled?(config.linting, :type_inference_failures)
 
       if property.type.nil? && explicit_type.nil?
+        @warning_count += 1
         warn "TypeSpec Lint: Could not infer type for '#{property.name}' in #{serializer_name}. Consider adding explicit type annotation."
       end
     end
@@ -598,6 +618,8 @@ module TypeSpecFromSerializers
 
     # Public: Generates code for all serializers in the app.
     def generate(force: ENV["SERIALIZER_TYPESPEC_FORCE"])
+      Linting.reset_count
+
       @force_generation = force
       clean_output_dir if force && config.output_dir.exist?
 
@@ -614,6 +636,8 @@ module TypeSpecFromSerializers
         generate_model_for(serializer)
       end
 
+      Linting.print_summary
+
       {serializers: serializers, controllers: controllers}
     end
 
@@ -763,7 +787,7 @@ module TypeSpecFromSerializers
           path: path,
           response_type: response_type,
           route_name: route_name,
-          param_types: route.defaults[:type] || {},
+          param_types: route.defaults[:__typespec_types] || {},
         }
       end
 

data/lib/typespec_from_serializers/routing_patch.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "action_dispatch/routing/mapper"
+require "action_dispatch/journey/route"
+
+# Internal: Minimal surgical patches to ActionDispatch routing for TypeSpec metadata support.
+#
+# This module patches Rails routing to support the `type:` parameter for specifying
+# path parameter types without interfering with Rails' route matching or URL generation.
+#
+# The type metadata is stored in route defaults under the :__typespec_types key and
+# explicitly excluded from route requirements to prevent it from affecting routing behavior.
+#
+# Examples
+#
+#   # In routes.rb
+#   resources :users, type: { id: Integer }
+#   get '/posts/:id', to: 'posts#show', type: { id: Integer }
+#
+# The patches work at three interception points:
+# 1. Mapper::Base#match - for GET/POST/PATCH/etc methods
+# 2. Mapper::Resources#resources - for resources/resource methods
+# 3. Journey::Route#requirements - filters metadata from route requirements
+module TypeSpecFromSerializers
+  # Internal: Shared logic for moving type metadata from options to defaults.
+  module RoutingPatchHelpers
+    module_function
+
+    # Internal: Moves type: parameter from route options to defaults[:__typespec_types].
+    #
+    # This ensures type metadata is stored but doesn't interfere with routing.
+    #
+    # options - Hash of route options (will be modified in place)
+    #
+    # Returns the modified options Hash
+    def move_type_to_defaults!(options)
+      return options unless options.key?(:type)
+
+      types = options.delete(:type)
+      options[:defaults] = (options[:defaults] || {}).merge(__typespec_types: types)
+      options
+    end
+  end
+
+  # Internal: Patches ActionDispatch::Routing::Mapper::Base to intercept match method.
+  #
+  # Intercepts the low-level match method used by get, post, patch, delete, etc.
+  module MapperPatch
+    def match(path, *rest, &block)
+      options = rest.last.is_a?(Hash) ? rest.pop.dup : {}
+      RoutingPatchHelpers.move_type_to_defaults!(options)
+
+      rest.push(options) unless options.empty?
+      super(path, *rest, &block)
+    end
+  end
+
+  # Internal: Patches ActionDispatch::Routing::Mapper::Resources to intercept resources method.
+  #
+  # Intercepts the resources/resource DSL methods to support type: parameter.
+  module ResourcesPatch
+    def resources(*resources, &block)
+      options = resources.extract_options!
+      RoutingPatchHelpers.move_type_to_defaults!(options)
+
+      resources.push(options) unless options.empty?
+      super(*resources, &block)
+    end
+  end
+
+  # Internal: Patches ActionDispatch::Journey::Route to filter type metadata from requirements.
+  #
+  # The requirements method is used for route matching and URL generation.
+  # We exclude :__typespec_types to ensure it doesn't affect routing behavior.
+  module RoutePatch
+    def requirements
+      super.except(:__typespec_types)
+    end
+  end
+end
+
+# Apply patches to ActionDispatch
+ActionDispatch::Routing::Mapper::Base.prepend(TypeSpecFromSerializers::MapperPatch)
+ActionDispatch::Routing::Mapper::Resources.prepend(TypeSpecFromSerializers::ResourcesPatch)
+ActionDispatch::Journey::Route.prepend(TypeSpecFromSerializers::RoutePatch)

data/lib/typespec_from_serializers/version.rb

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

data/lib/typespec_from_serializers.rb

@@ -5,3 +5,4 @@ require_relative "typespec_from_serializers/dsl"
 require_relative "typespec_from_serializers/sorbet"
 require_relative "typespec_from_serializers/rbi"
 require_relative "typespec_from_serializers/railtie"
+require_relative "typespec_from_serializers/routing_patch"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typespec_from_serializers
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Danila Poyarkov
@@ -320,6 +320,7 @@ files:
 - lib/typespec_from_serializers/railtie.rb
 - lib/typespec_from_serializers/rbi.rb
 - lib/typespec_from_serializers/rdoc.rb
+- lib/typespec_from_serializers/routing_patch.rb
 - lib/typespec_from_serializers/runner.rb
 - lib/typespec_from_serializers/sorbet.rb
 - lib/typespec_from_serializers/version.rb