typespec_from_serializers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e14e0d2601ec8ee7b5efa388163e3997830d825b6f98f9df7e40ecd0248a8f6
-  data.tar.gz: d15e88b3aa25f587697c2614b867ccaa31b3438c08d11ca12bd17ddf752313b8
+  metadata.gz: 85c22cdd4d7f9bb9402cceab726de827f7ebcc9692e1c1a19f7575fb429ca48e
+  data.tar.gz: 8a7ebd811666bec1c591802c126794c7761c8ab7f6abbb54f56c5ddef5f54030
 SHA512:
-  metadata.gz: a2a246f2e90ce1fb583ce3bd1abc4c621c36f69fca705c853360e371beb22f668aa51ba043e4b7c3fdec9e2055577dd5df9b92c645984a4af81543aec546826b
-  data.tar.gz: 47249bf5f3c9f9af0c801790f65d0d8aa829071770f7590c15897c73fe286af61922bf92d9985bea9acb201c7d43b8c9fb5d84f2a5e71bb9720dd2a2c1d90fce
+  metadata.gz: 6240113cea4819efe395d5b7c259430cfc949822a2f8b11ebd0e6dfdef2e349596170da79bcdce8bc82dde3ba8290258d5d7061a7056cdacd7bd25e9f90fe5d3
+  data.tar.gz: e81ff91f9b8de9e81b61b796b1f201e37c2ae59dffc7300ce7c927a7c07c017001bd6d81ee8fc34be849bb937bc0ae1895895a00be180899272a9f7ad5ce23c6

data/CHANGELOG.md

@@ -1,4 +1,43 @@
-# [2.3.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.2.0...types_from_serializers@2.3.0) (2024-08-23)
+# TypeSpec From Serializers Changelog
+
+## [0.2.0] - 2025-12-19
+
+Initial release - fork of `types_from_serializers` adapted to generate TypeSpec instead of TypeScript.
+
+### Features
+
+**Routes Generation**
+- Generate TypeSpec HTTP interfaces from Rails routes automatically
+- Type path parameters in `routes.rb`: `type: { id: Integer }`
+- Type request body in controllers with `type` DSL
+- Nested routes organized in namespaces
+- Filter exported routes with `export_if` configuration
+
+**Sorbet Integration**
+- Automatic type inference from Sorbet signatures
+- Support for `T.nilable`, `T::Array`, unions, and complex shapes
+- Works with RBI files (Tapioca-generated)
+
+**Type System**
+- Simple `type:` syntax for explicit types
+- Union types: `type: "string | int32"`
+- Automatic inference from SQL schema and ActiveRecord enums
+- Custom TypeSpec model references
+
+**OpenAPI**
+- Compile TypeSpec to OpenAPI 3.0: `rake typespec_from_serializers:compile_openapi`
+- Setup dependencies: `rake typespec_from_serializers:setup`
+
+**Developer Experience**
+- Automatic regeneration in development mode
+- Vite live reload support
+- Incremental generation for modified files only
+
+---
+
+# Previous versions (types_from_serializers)
+
+## [2.3.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.2.0...types_from_serializers@2.3.0) (2024-08-23)
 
 
 ### Features

data/README.md

@@ -1,22 +1,15 @@
 <h1 align="center">
 TypeSpec From Serializers
 <p align="center">
-<a href="https://travis-ci.org/dannote/typespec_from_serializers"><img alt="Build Status" src="https://travis-ci.org/dannote/typespec_from_serializers.svg"/></a>
-<a href="http://inch-ci.org/github/dannote/typespec_from_serializers"><img alt="Inline docs" src="http://inch-ci.org/github/dannote/typespec_from_serializers.svg"/></a>
-<a href="https://codeclimate.com/github/dannote/typespec_from_serializers"><img alt="Maintainability" src="https://codeclimate.com/github/dannote/typespec_from_serializers/badges/gpa.svg"/></a>
-<a href="https://codeclimate.com/github/dannote/typespec_from_serializers"><img alt="Test Coverage" src="https://codeclimate.com/github/dannote/typespec_from_serializers/badges/coverage.svg"/></a>
+<a href="https://github.com/dannote/typespec_from_serializers/actions"><img alt="Build Status" src="https://github.com/dannote/typespec_from_serializers/workflows/build/badge.svg"/></a>
 <a href="https://rubygems.org/gems/typespec_from_serializers"><img alt="Gem Version" src="https://img.shields.io/gem/v/typespec_from_serializers.svg?colorB=e9573f"/></a>
 <a href="https://github.com/dannote/typespec_from_serializers/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/></a>
 </p>
 </h1>
 
-[aliases]: https://vite-ruby.netlify.app/guide/development.html#import-aliases-%F0%9F%91%89
-[config options]: https://github.com/dannote/typespec_from_serializers/blob/main/lib/typespec_from_serializers/generator.rb#L82-L85
-[readme]: https://github.com/dannote/typespec_from_serializers
+Automatically generate [TypeSpec](https://typespec.io) definitions from Ruby serializers and Rails routes.
 
-**TypeSpec From Serializers** is a Ruby gem that automatically generates [TypeSpec](https://typespec.io) definitions from Ruby serializers and Rails routes. It is a derivative work of [`types_from_serializers`][types_from_serializers] by ElMassimo, originally designed to generate TypeScript definitions. This fork adapts the core functionality to produce TypeSpec descriptions, enabling Rails developers to define APIs compatible with TypeSpec’s ecosystem, including OpenAPI generation and client/server code scaffolding.
-
-For more information, check the main [README].
+For full documentation, see the [main README](https://github.com/dannote/typespec_from_serializers).
 
 ### Installation 💿
 

data/lib/typespec_from_serializers/dsl/controller.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module TypeSpecFromSerializers
+  module DSL
+    # DSL for Rails controllers to declare parameter types
+    module Controller
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # DSL for declaring method return types (same as serializer DSL)
+        # Usage:
+        #   type id: Integer, title: String
+        #   def video_params
+        #     # ...
+        #   end
+        def type(type_definition)
+          @_pending_return_type = type_definition
+        end
+
+        # Internal: Captures pending type declaration when method is defined
+        def method_added(method_name)
+          super
+          if (pending_type = @_pending_return_type)
+            return_type_registry[method_name] = pending_type
+            @_pending_return_type = nil
+          end
+        end
+
+        # Internal: Registry storing method return type declarations
+        def return_type_registry
+          @return_type_registry ||= {}
+        end
+
+        # Public: Retrieve declared return type for a method
+        def type_for_method(method_name)
+          return_type_registry[method_name.to_sym]
+        end
+      end
+    end
+  end
+end

data/lib/typespec_from_serializers/dsl/serializer.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+# Internal: A DSL to specify types for serializer attributes.
+module TypeSpecFromSerializers
+  module DSL
+    module Serializer
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # Override: Capture the name of the model related to the serializer.
+        #
+        # name - An alias for the internal object in the serializer.
+        # model - The name of an ActiveRecord model to infer types from the schema.
+        # typespec_from - The name of a TypeScript model to infer types from.
+        def object_as(name, model: nil, typespec_from: nil)
+          # NOTE: Avoid taking memory for type information that won't be used.
+          if Rails.env.development?
+            model ||= name.is_a?(Symbol) ? name : try(:_serializer_model_name) || name
+            define_singleton_method(:_serializer_model_name) { model }
+            define_singleton_method(:_serializer_typespec_from) { typespec_from } if typespec_from
+          end
+
+          super(name)
+        end
+
+        # Public: Declare type for an attribute or method return value.
+        #
+        # type    - Symbol for attribute type, or Class/Sorbet type for method return
+        # options - Additional options passed to `attribute` when type is a Symbol
+        #
+        # Examples
+        #
+        #   type :string           # Attribute type
+        #   type String            # Method return type
+        #   type T.nilable(String) # Sorbet type
+        #
+        def type(type, **options)
+          type.is_a?(Symbol) ? attribute(type: type, **options) : @_pending_return_type = type
+        end
+
+        # Internal: Captures pending type declaration when method is defined.
+        def method_added(method_name)
+          super
+          if (pending_type = @_pending_return_type)
+            return_type_registry[method_name] = pending_type
+            @_pending_return_type = nil
+          end
+        end
+
+        # Internal: Registry storing method return type declarations.
+        def return_type_registry
+          @return_type_registry ||= {}
+        end
+
+        # Public: Retrieve declared return type for a method.
+        def type_for_method(method_name)
+          return_type_registry[method_name.to_sym]
+        end
+
+      private
+
+        # Override: Remove unnecessary options in production, types are only
+        # used when generating code in development.
+        unless Rails.env.development?
+          def add_attribute(name, type: nil, optional: nil, **options)
+            super(name, **options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/typespec_from_serializers/dsl.rb

@@ -1,46 +1,4 @@
 # frozen_string_literal: true
 
-require "active_support/concern"
-
-# Internal: A DSL to specify types for serializer attributes.
-module TypeSpecFromSerializers
-  module DSL
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      # Override: Capture the name of the model related to the serializer.
-      #
-      # name - An alias for the internal object in the serializer.
-      # model - The name of an ActiveRecord model to infer types from the schema.
-      # typespec_from - The name of a TypeScript model to infer types from.
-      def object_as(name, model: nil, typespec_from: nil)
-        # NOTE: Avoid taking memory for type information that won't be used.
-        if Rails.env.development?
-          model ||= name.is_a?(Symbol) ? name : try(:_serializer_model_name) || name
-          define_singleton_method(:_serializer_model_name) { model }
-          define_singleton_method(:_serializer_typespec_from) { typespec_from } if typespec_from
-        end
-
-        super(name)
-      end
-
-      # Public: Shortcut for typing a serializer attribute.
-      #
-      # It specifies the type for a serializer method that will be defined
-      # immediately after calling this method.
-      def type(type, **options)
-        attribute type: type, **options
-      end
-
-    private
-
-      # Override: Remove unnecessary options in production, types are only
-      # used when generating code in development.
-      unless Rails.env.development?
-        def add_attribute(name, type: nil, optional: nil, **options)
-          super(name, **options)
-        end
-      end
-    end
-  end
-end
+require_relative "dsl/serializer"
+require_relative "dsl/controller"