types_from_serializers 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ca195394efd6b1c37c31b81ff85f7ccbcba562e9cf7b76d7810dfc613e1aa6
-  data.tar.gz: 20ef589a30a448e668d1da4106ab565e768227e74f950c5d56bfbd2a83aa9a48
+  metadata.gz: e9253a2af8e018bad4fc2015153df9e0f2c5acd8fa6dc1980ee6c5942fd63b0b
+  data.tar.gz: 3ddc115f8667dcba81f51ae867323c9852939c019b18e49a29bf5a73d8c0c790
 SHA512:
-  metadata.gz: fec219f23757f68e03678195ac3f66f13d3d48897e30c3f4b141c12257eb394577c997ecc639110ac3fee8be57e90f915c94989e84116a9be76d9d1e5df47f52
-  data.tar.gz: 1956d02db12c7ea5eab5edff52dc48356f163f71a17ab08fc93e6dcae810d29df26ea7501ddc0e8ac609087981d2456e4b927bcdb01acfeff455adf4671b58b0
+  metadata.gz: 8dc521ddba354a4443a907597ba1b5c4d6093c156b6685e0ac683bcc922f2414e3380f00ba8e2ae5e96587dd519efd738304ec98d93643d6859d1dc6047be1ca
+  data.tar.gz: f69cf927cc528364a62c2a96ffbdcf54dff910700d80a89e8109bdb1d4c208bf9cfce6221c43c04bc914a5cd4c284a3854e2504122bef256365c6f4c654c5f0c

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# [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
+
+* generate types for inline serializers, exclude them from the index ([1c3657c](https://github.com/ElMassimo/types_from_serializers/commit/1c3657c61a1bc891f3219f6eaf8557cd3cd6344a)), closes [#19](https://github.com/ElMassimo/types_from_serializers/issues/19)
+
+
+
+# [2.2.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.1.0...types_from_serializers@2.2.0) (2024-08-23)
+
+
+### Bug Fixes
+
+* be more accurate regarding decimal serialization ([cd63653](https://github.com/ElMassimo/types_from_serializers/commit/cd636530a5710112a14746cc7d0e3f15016cd5e1))
+
+
+### Features
+
+* infer type from enums ([#20](https://github.com/ElMassimo/types_from_serializers/issues/20)) ([49dc61d](https://github.com/ElMassimo/types_from_serializers/commit/49dc61da2718256e9b5f5743b5a65c4746d64c2f))
+
+
+
 # [2.1.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.0.2...types_from_serializers@2.1.0) (2023-07-19)
 
 

data/lib/types_from_serializers/generator.rb

@@ -38,15 +38,17 @@ module TypesFromSerializers
         TypesFromSerializers.config.name_from_serializer.call(name).gsub("::", "/")
       end
 
-      # Internal: The columns corresponding to the serializer model, if it's a
-      # record.
-      def model_columns
-        @model_columns ||= _serializer_model_name&.to_model.try(:columns_hash) || {}
+      # Internal: If the serializer was defined inside a file.
+      def inline_serializer?
+        name.include?("Serializer::")
       end
 
       # Internal: The TypeScript properties of the serialzeir interface.
       def ts_properties
         @ts_properties ||= begin
+          model_class = _serializer_model_name&.to_model
+          model_columns = model_class.try(:columns_hash) || {}
+          model_enums = model_class.try(:defined_enums) || {}
           types_from = try(:_serializer_types_from)
 
           prepare_attributes(
@@ -64,7 +66,7 @@ module TypesFromSerializers
                   multi: options[:association] == :many,
                   column_name: options.fetch(:value_from),
                 ).tap do |property|
-                  property.infer_type_from(model_columns, types_from)
+                  property.infer_type_from(model_columns, model_enums, types_from)
                 end
               end
             }
@@ -190,9 +192,11 @@ module TypesFromSerializers
 
     # Internal: Infers the property's type by checking a corresponding SQL
     # column, or falling back to a TypeScript interface if provided.
-    def infer_type_from(columns_hash, ts_interface)
+    def infer_type_from(columns_hash, defined_enums, ts_interface)
       if type
         type
+      elsif (enum = defined_enums[column_name.to_s])
+        self.type = enum.keys.map(&:inspect).join(" | ")
       elsif (column = columns_hash[column_name.to_s])
         self.multi = true if column.try(:array)
         self.optional = true if column.null && !column.default
@@ -313,9 +317,7 @@ module TypesFromSerializers
     # Internal: Checks if it should avoid generating an interface.
     def skip_serializer?(serializer)
       serializer.name.in?(config.base_serializers) ||
-        config.skip_serializer_if.call(serializer) ||
-        # NOTE: Ignore inline serializers.
-        serializer.ts_name.include?("Serializer")
+        config.skip_serializer_if.call(serializer)
     end
 
     # Internal: Returns an object compatible with FileUpdateChecker.
@@ -363,7 +365,9 @@ module TypesFromSerializers
         output_dir: root.join(defined?(ViteRuby) ? ViteRuby.config.source_code_dir : "app/frontend").join("types/serializers"),
 
         # Remove the serializer suffix from the class name.
-        name_from_serializer: ->(name) { name.delete_suffix("Serializer") },
+        name_from_serializer: ->(name) {
+          name.split("::").map { |n| n.delete_suffix("Serializer") }.join("::")
+        },
 
         # Types that don't need to be imported in TypeScript.
         global_types: [
@@ -383,7 +387,7 @@ module TypesFromSerializers
           boolean: :boolean,
           date: "string | Date",
           datetime: "string | Date",
-          decimal: :number,
+          decimal: "string | number",
           integer: :number,
           string: :string,
           text: :string,
@@ -421,7 +425,7 @@ module TypesFromSerializers
       <<~TS
         //
         // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
-        #{serializers.map { |s|
+        #{serializers.reject(&:inline_serializer?).map { |s|
           "export type { default as #{s.ts_name} } from './#{s.ts_filename}'"
         }.join("\n")}
       TS

data/lib/types_from_serializers/version.rb

@@ -2,5 +2,5 @@
 
 module TypesFromSerializers
   # Public: This library adheres to semantic versioning.
-  VERSION = "2.1.0"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: types_from_serializers
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-19 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -277,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Generate TypeScript interfaces from your JSON serializers.