typelizer 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed3e7b6339e4a79168c10afd541bba9ea8c509b00f689465df037501327ac6e2
-  data.tar.gz: a7f079a7ad377d1f2754cc1efcb98a7bc0e8af11c3910e8f56b648090ddb7f46
+  metadata.gz: a41914a150239acf4de1b43149a0bfaa81c9511a6a5434aa445cfc9dbf3ee343
+  data.tar.gz: 82d1616845d782c041466d8500453afb8052a3d4fd8ce4e6f63c045c41a19544
 SHA512:
-  metadata.gz: 7687ff8e061c46e11f56421684a5629a823debc4d76ac3018e3ab7ac960416a05088662372b38bb4029a650ba6d81c74fbccb49d9821d7864f86023fdddd819e
-  data.tar.gz: 860d8dc24a04302c2e70d30a4ef6811f595ee4e55788ab47d6966c10a405370dc756419b06e15b343b00fc38d495897e706d5be5a5fb1816b9a0da3315c009ce
+  metadata.gz: 1f51fef6373b00d177faceccebc84c87e22f428f684990aa3faa762a5cabca853cf609c7476f98cc34ce26d1737ace2f258c47099a23018755f3e595873009d1
+  data.tar.gz: fff6bc2ca1844cc45d7d7a2a6bf8ac269078243013acb4e83ead8a902936f62fcfd5e15a96fbcbb1289266c52f53446e4cb3fa74584eeef09ab86882eadcfc43

data/CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog],
 and this project adheres to [Semantic Versioning].
 
+## [Unreleased]
+
+## [0.4.2] - 2025-06-23
+
+### Added
+
+- Map `uuid` type to `string` by default. ([@ventsislaf])
+
+### Fixed
+
+- Alba: fix `has_many` with a custom `key` generates single value type instead of array. ([@skryukov])
+
+## [0.4.1] - 2025-06-10
+
+### Added
+
+- Add option to use double quotes in generated TypeScript interfaces through `prefer_double_quotes` config option ([@kristinemcbride])
+
+### Fixed
+
+- Fix types not being generated on the fly since [0.2.0]. ([@skryukov])
+- Improve memory consumption (~100x less memory) & speed of types generation (~5x faster). ([@skryukov])
+- Fix nullable detection for `belongs_to` associations with `:active_record` strategy. ([@NOX73])
+- Alba: fix unknown type for conditional attribute with `transform_keys`. ([@nkriege])
+
 ## [0.4.0] - 2025-05-03
 
 ### Added 
@@ -35,7 +60,7 @@ and this project adheres to [Semantic Versioning].
       admin_level: number;
     }
   ```
-  
+
 ### Fixed
 
 - Alba: always use strings for keys in properties. ([@skryukov])
@@ -146,11 +171,17 @@ and this project adheres to [Semantic Versioning].
 
 [@davidrunger]: https://github.com/davidrunger
 [@Envek]: https://github.com/Envek
+[@kristinemcbride]: https://github.com/kristinemcbride
+[@nkriege]: https://github.com/nkriege
+[@NOX73]: https://github.com/NOX73
 [@okuramasafumi]: https://github.com/okuramasafumi
 [@patvice]: https://github.com/patvice
 [@skryukov]: https://github.com/skryukov
+[@ventsislaf]: https://github.com/ventsislaf
 
-[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.4.2...HEAD
+[0.4.2]: https://github.com/skryukov/typelizer/compare/v0.4.1...v0.4.2
+[0.4.1]: https://github.com/skryukov/typelizer/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/skryukov/typelizer/compare/v0.3.0...v0.4.0
 [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

data/README.md

@@ -281,6 +281,9 @@ Typelizer.configure do |config|
   # Will change imports and exports of types from default to support this syntax option
   config.verbatim_module_syntax = false
 
+  # Use double quotes in generated TypeScript interfaces (default: false)
+  config.prefer_double_quotes = false
+
   # Support comments in generated TypeScript interfaces (default: false)
   # Will add comments to the generated interfaces
   config.comments = false

data/lib/typelizer/config.rb

@@ -7,7 +7,8 @@ module Typelizer
     integer: :number,
     string: :string,
     text: :string,
-    citext: :string
+    citext: :string,
+    uuid: :string
   }.tap do |types|
     types.default = :unknown
   end
@@ -28,6 +29,7 @@ module Typelizer
     :inheritance_strategy,
     :associations_strategy,
     :comments,
+    :prefer_double_quotes,
     keyword_init: true
   ) do
     class << self
@@ -52,6 +54,7 @@ module Typelizer
           inheritance_strategy: :none,
           associations_strategy: :database,
           comments: false,
+          prefer_double_quotes: false,
 
           output_dir: js_root.join("types/serializers"),
 

data/lib/typelizer/generator.rb

@@ -16,16 +16,14 @@ module Typelizer
     def call(force: false)
       return unless Typelizer.enabled?
 
-      writer.call(interfaces, force: force)
-
-      interfaces
+      found_interfaces = interfaces
+      writer.call(found_interfaces, force: force)
+      found_interfaces
     end
 
     def interfaces
-      @interfaces ||= begin
-        read_serializers
-        target_serializers.map(&:typelizer_interface).reject(&:empty?)
-      end
+      read_serializers
+      target_serializers.map(&:typelizer_interface).reject(&:empty?)
     end
 
     private
@@ -44,14 +42,10 @@ module Typelizer
 
     def read_serializers(files = nil)
       files ||= Typelizer.dirs.flat_map { |dir| Dir["#{dir}/**/*.rb"] }
-
       files.each do |file|
         trace = TracePoint.new(:call) do |tp|
-          begin
-            next unless tp.self.methods.include?(:typelizer_interface)
-          rescue WeakRef::RefError
-            next
-          end
+          next unless tp.self.is_a?(Class) && tp.self.respond_to?(:typelizer_interface) && tp.self.typelizer_interface.is_a?(Interface)
+
           serializer_plugin = tp.self.typelizer_interface.serializer_plugin
 
           if tp.callee_id.in?(serializer_plugin.methods_to_typelize)

data/lib/typelizer/interface.rb

@@ -103,6 +103,10 @@ module Typelizer
       "<#{self.class.name} #{name} properties=[#{properties_to_print.map(&:fingerprint).join(", ")}]>"
     end
 
+    def quote(str)
+      config.prefer_double_quotes ? "\"#{str}\"" : "'#{str}'"
+    end
+
     private
 
     def self_type_name

data/lib/typelizer/model_plugins/active_record.rb

@@ -17,7 +17,7 @@ module Typelizer
             if config.associations_strategy == :database
               prop.nullable = column.null if column
             elsif config.associations_strategy == :active_record
-              prop.nullable = !association.options[:required] || association.options[:optional]
+              prop.nullable = association.options[:optional] === true || association.options[:required] === false
             else
               raise "Unknown associations strategy: #{config.associations_strategy}"
             end

data/lib/typelizer/property.rb

@@ -24,8 +24,10 @@ module Typelizer
     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}>"
+      props = to_h
+      props[:type] = type_name
+      props = props.filter_map { |k, v| "#{k}=#{v.inspect}" unless v.nil? }
+      "<#{self.class.name} #{props.join(" ")}>"
     end
 
     private

data/lib/typelizer/serializer_plugins/alba.rb

@@ -98,7 +98,7 @@ module Typelizer
             optional: false,
             nullable: false,
             multi: false, # we override this in typelize_method_transform
-            column_name: column_name,
+            column_name: attr.name.is_a?(Symbol) ? attr.name.name : attr.name,
             **options
           )
         when ::Alba::TypedAttribute
@@ -124,7 +124,7 @@ module Typelizer
             **options
           )
         when ::Alba::ConditionalAttribute
-          build_property(name, attr.instance_variable_get(:@body), optional: true)
+          build_property(column_name, attr.instance_variable_get(:@body), optional: true)
         else
           raise ArgumentError, "Unsupported attribute type: #{attr.class}"
         end

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

@@ -1,7 +1,7 @@
 <%- interfaces.each do |interface| -%>
 <%- if interface.config.verbatim_module_syntax -%>
-export type { <%= interface.name %> } from './<%= interface.filename %>'
+export type { <%= interface.name %> } from <%= interface.quote('./' + interface.filename) %>
 <%- else -%>
-export type { default as <%= interface.name %> } from './<%= interface.filename %>'
-<%- end -%>
+export type { default as <%= interface.name %> } from <%= interface.quote('./' + interface.filename) %>
 <%- end -%>
+<%- end -%>

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

@@ -1 +1 @@
-<%= interface.overwritten_properties.any? ? "Omit<" : "" %><%= interface.parent_interface.name %><%= "['#{interface.parent_interface.root_key}']" if interface.parent_interface.root_key %><%= interface.overwritten_properties.any? ? ", " + interface.overwritten_properties.map { |pr| "'#{pr.name}'" }.join(' | ') + ">" : ""%>
+<%= interface.overwritten_properties.any? ? "Omit<" : "" %><%= interface.parent_interface.name %><%= "[" + interface.quote(interface.parent_interface.root_key) + "]" if interface.parent_interface.root_key %><%= interface.overwritten_properties.any? ? ", " + interface.overwritten_properties.map { |pr| interface.quote(pr.name) }.join(' | ') + ">" : ""%>

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

@@ -1,5 +1,5 @@
 <% if interface.imports.any? -%>
-import type {<%= interface.imports.join(", ") %>} from '<%= interface.config.types_import_path %>'
+import type {<%= interface.imports.join(", ") %>} from <%= interface.quote(interface.config.types_import_path) %>
 <% end -%>
 
 type <%= interface.name %><%= "Data" if interface.root_key %> = <%=

data/lib/typelizer/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: typelizer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 bindir: bin
 cert_chain: []
-date: 2025-05-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A TypeScript type generator for Ruby serializers.
 test_files: []