typelizer 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d00f7bda8328c5148fe2bb6053d27066dd128fd834432c92d39417c3bbdc9405
-  data.tar.gz: 8b7fc9baa4b646cd91965b1316d9c9dcb22867a5bc8b65407c3fa36bbff9d85c
+  metadata.gz: 391ff3345874135d72e3875c60aff109ebfd8ce98b0766e51dd1d2a8909e2af9
+  data.tar.gz: 1a3c12dad42402fc5485f3124660e2376db4f8dec7b36d016a8d48a33d568fa0
 SHA512:
-  metadata.gz: 9174cd537b757ea89f7a886c1443e12a78f16b269bc16ccb2e49866128c47471df83e55c32cc60ef7148ea4e8cd15d5cc1552f907dad903931c043af97ab6bc2
-  data.tar.gz: f4d59939214975e140d1a9db3cdc8c5bd9a3278baf6f59d686af7434499917ae30581fcb2a2681c1e106372fcda819250a47f5ba61a4844819dac660f8dea93a
+  metadata.gz: 6111652d2f134f20fa6450c1eccaf592a1bade20e0325b49b43a55628e9ac4f7eab1dfbfad09df0aa28893ae898571ccb486d92aa79f23cce682ab3d0c61b8d4
+  data.tar.gz: 1b73e070ce4dc50cc87d1a589a286afffcca8f42f596a6172e9b236e9911c72b45ea391d8e7b20ac8321eb83bb488f871c48d67e2a5ece6672530e0e897a6689

data/CHANGELOG.md

@@ -7,21 +7,57 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.3.0] - 2025-02-28
+
+### Added
+
+- Support transform keys. ([@patvice], [@skryukov])
+
+  Typelizer now respects `transform_keys`/`key_transform` configurations for all plugins.
+
+- Support typing method def in Alba. ([@patvice])
+
+  The `typelize` helper now can be used before a method definition:
+
+  ```ruby
+  class UserResource < ApplicationResource
+    attributes :id, :name, :email, :chars_in_name
+
+    typelize :number
+    def chars_in_name(obj)
+      obj.name.chars.count
+    end
+  end
+  ```
+
+- Support for deprecated attributes. ([@Envek])
+
+  They will be marked as deprecated using JSDoc [`@deprecated` tag](https://jsdoc.app/tags-deprecated) in TypeScript interface comments.
+
+  In ActiveModel::Serializer attributes `deprecated` option is recognized.
+
+  For other serializers, you can use `deprecated` option of `typelize` method.
+
+### Fixed
+
+- Ignore `nil` values on fingerprint calculation. ([@Envek])
+
 ## [0.2.0] - 2024-11-26
 
 ## Added
 
-- Add support for enum attributes declared using `ActiveRecord::Enum` or explicitly in serializers ([@envek])
-- Add support for comments in generated TypeScript interfaces ([@envek])
+- Add support for enum attributes declared using `ActiveRecord::Enum` or explicitly in serializers ([@Envek])
+- Add support for comments in generated TypeScript interfaces ([@Envek])
 - Add TypeScript verbatim module syntax support through `verbatim_module_syntax` config option ([@patvice])
 - Add `typelizer:generate:refresh` command to clean output directory and regenerate all interfaces ([@patvice])
 - Allow disabling Typelizer in Rails development with `DISABLE_TYPELIZER` environment variable to `true` ([@okuramasafumi])
+- Allow to get interfaces without generating TypeScript files ([@Envek])
 
-## Fixes
+## Fixed
 
 - Do not override `Typelizer.dirs` in the railtie initializer ([@patvice])
 - Do not raise on empty nested serializers ([@skryukov])
-- Attribute options merging in inherited serializers ([@envek])
+- Attribute options merging in inherited serializers ([@Envek])
 - Allow recursive type definition ([@okuramasafumi])
 
 ## [0.1.5] - 2024-10-07
@@ -75,12 +111,13 @@ and this project adheres to [Semantic Versioning].
 - Initial release ([@skryukov])
 
 [@davidrunger]: https://github.com/davidrunger
-[@envek]: https://github.com/envek
+[@Envek]: https://github.com/Envek
 [@okuramasafumi]: https://github.com/okuramasafumi
 [@patvice]: https://github.com/patvice
 [@skryukov]: https://github.com/skryukov
 
-[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/skryukov/typelizer/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/skryukov/typelizer/compare/v0.1.5...v0.2.0
 [0.1.5]: https://github.com/skryukov/typelizer/compare/v0.1.4...v0.1.5
 [0.1.4]: https://github.com/skryukov/typelizer/compare/v0.1.3...v0.1.4

data/README.md

@@ -105,7 +105,7 @@ end
 You can also specify more complex type definitions using a lower-level API:
 
 ```ruby
-typelize attribute_name: ["string", "Date", optional: true, nullable: true, multi: true, enum: %w[foo bar], comment: "Attribute description"]
+typelize attribute_name: ["string", "Date", optional: true, nullable: true, multi: true, enum: %w[foo bar], comment: "Attribute description", deprecated: "Use `another_attribute` instead"]
 ```
 
 ### TypeScript Integration

data/lib/typelizer/interface.rb

@@ -73,6 +73,10 @@ module Typelizer
       "<#{self.class.name} #{name} properties=#{properties.inspect}>"
     end
 
+    def fingerprint
+      "<#{self.class.name} #{name} properties=[#{properties.map(&:fingerprint).join(", ")}]>"
+    end
+
     private
 
     def self_type_name
@@ -90,7 +94,7 @@ module Typelizer
     def infer_types(props, hash_name = :_typelizer_attributes)
       props.map do |prop|
         if serializer.respond_to?(hash_name)
-          dsl_type = serializer.public_send(hash_name)[prop.name.to_sym]
+          dsl_type = serializer.public_send(hash_name)[prop.column_name.to_sym]
           if dsl_type&.any?
             next Property.new(prop.to_h.merge(dsl_type)).tap do |property|
               property.comment ||= model_plugin.comment_for(property) if config.comments && property.comment != false

data/lib/typelizer/property.rb

@@ -1,7 +1,7 @@
 module Typelizer
   Property = Struct.new(
     :name, :type, :optional, :nullable,
-    :multi, :column_name, :comment, :enum,
+    :multi, :column_name, :comment, :enum, :deprecated,
     keyword_init: true
   ) do
     def inspect
@@ -17,6 +17,11 @@ module Typelizer
       "#{name}#{"?" if optional}: #{type_str}"
     end
 
+    def fingerprint
+      props = to_h.merge(type: type_name).reject { |_, v| v.nil? }.map { |k, v| "#{k}=#{v.inspect}" }.join(" ")
+      "<#{self.class.name} #{props}>"
+    end
+
     private
 
     def type_name

data/lib/typelizer/serializer_plugins/alba.rb

@@ -22,19 +22,31 @@ module Typelizer
           :association, :one, :has_one,
           :many, :has_many,
           :attributes, :attribute,
+          :method_added,
           :nested_attribute, :nested,
           :meta
         ]
       end
 
       def typelize_method_transform(method:, name:, binding:, type:, attrs:)
-        return {name => [type, attrs.merge(multi: true)]} if [:many, :has_many].include?(method)
+        if method == :method_added && binding.local_variable_defined?(:method_name)
+          name = binding.local_variable_get(:method_name)
+        end
+
+        if [:many, :has_many].include?(method)
+          return {name => [type, attrs.merge(multi: true)]}
+        end
 
         super
       end
 
       def root_key
-        serializer.new({}).send(:_key)
+        root = serializer.new({}).send(:_key)
+        if !root.nil? && has_transform_key?(serializer) && should_transform_root_key?(serializer)
+          fetch_key(serializer, root)
+        else
+          root
+        end
       end
 
       def meta_fields
@@ -51,6 +63,12 @@ module Typelizer
       private
 
       def build_property(name, attr, **options)
+        column_name = name
+
+        if has_transform_key?(serializer)
+          name = fetch_key(serializer, name)
+        end
+
         case attr
         when Symbol
           Property.new(
@@ -59,7 +77,7 @@ module Typelizer
             optional: false,
             nullable: false,
             multi: false,
-            column_name: name,
+            column_name: column_name,
             **options
           )
         when Proc
@@ -69,7 +87,7 @@ module Typelizer
             optional: false,
             nullable: false,
             multi: false,
-            column_name: nil,
+            column_name: column_name,
             **options
           )
         when ::Alba::Association
@@ -80,7 +98,7 @@ module Typelizer
             optional: false,
             nullable: false,
             multi: false, # we override this in typelize_method_transform
-            column_name: name,
+            column_name: column_name,
             **options
           )
         when ::Alba::TypedAttribute
@@ -91,7 +109,7 @@ module Typelizer
             # not sure if that's a good default tbh
             nullable: !alba_type.instance_variable_get(:@auto_convert),
             multi: false,
-            column_name: name,
+            column_name: column_name,
             **ts_mapper[alba_type.name.to_s],
             **options
           )
@@ -102,7 +120,7 @@ module Typelizer
             optional: false,
             nullable: false,
             multi: false,
-            column_name: nil,
+            column_name: column_name,
             **options
           )
         when ::Alba::ConditionalAttribute
@@ -112,6 +130,18 @@ module Typelizer
         end
       end
 
+      def has_transform_key?(serializer)
+        serializer._transform_type != :none
+      end
+
+      def should_transform_root_key?(serializer)
+        serializer._transforming_root_key
+      end
+
+      def fetch_key(serializer, key)
+        ::Alba.transform_key(key, transform_type: serializer._transform_type)
+      end
+
       private
 
       def ts_mapper

data/lib/typelizer/serializer_plugins/ams.rb

@@ -19,11 +19,13 @@ module Typelizer
       def properties
         serializer._attributes_data.merge(serializer._reflections).flat_map do |key, association|
           type = association.options[:serializer] ? Interface.new(serializer: association.options[:serializer]) : nil
+          adapter = ActiveModelSerializers::Adapter.configured_adapter
           Property.new(
-            name: key.to_s,
+            name: adapter.transform_key_casing!(key.to_s, association.options),
             type: type,
             optional: association.options.key?(:if) || association.options.key?(:unless),
             multi: association.respond_to?(:collection?) && association.collection?,
+            deprecated: (association.options[:deprecated] if association.options.key?(:deprecated)),
             column_name: association.name.to_s
           )
         end

data/lib/typelizer/serializer_plugins/oj_serializers.rb

@@ -11,7 +11,11 @@ module Typelizer
       end
 
       def properties
-        serializer._attributes
+        transform_keys = serializer.try(:_transform_keys)
+        attributes = serializer._attributes
+        attributes = attributes.transform_keys(&transform_keys) if transform_keys
+
+        attributes
           .flat_map do |key, options|
             if options[:association] == :flat
               Interface.new(serializer: options.fetch(:serializer)).properties

data/lib/typelizer/templates/interface.ts.erb

@@ -18,7 +18,10 @@ type <%= interface.name %> = {
 <%- else -%>
 type <%= interface.name %> = {
 <%- interface.properties.each do |property| -%>
-<%= indent("/** #{property.comment.split("\n").map(&:strip).join("\n * ")} */\n") if interface.config.comments && property.comment -%>
+<%- comment = "" -%>
+<%- comment += property.comment.to_s if interface.config.comments -%>
+<%- comment += "\n@deprecated #{property.deprecated.is_a?(String) ? property.deprecated : ''}" if property.deprecated -%>
+<%= indent("/** #{comment.strip.split("\n").map(&:strip).join("\n * ")} */\n") unless comment.empty? -%>
 <%= indent(property) %>;
 <%- end -%>
 }

data/lib/typelizer/version.rb

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

data/lib/typelizer/writer.rb

@@ -32,7 +32,7 @@ module Typelizer
     end
 
     def write_interface(interface)
-      write_file("#{interface.filename}.ts", interface.inspect) do
+      write_file("#{interface.filename}.ts", interface.fingerprint) do
         render_template("interface.ts.erb", interface: interface)
       end
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: typelizer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -67,7 +66,6 @@ metadata:
   homepage_uri: https://github.com/skryukov/typelizer
   source_code_uri: https://github.com/skryukov/typelizer
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A TypeScript type generator for Ruby serializers.
 test_files: []