types_from_serializers 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab46cb83091bc01087646a3e9c1eee590d4148ea16f86fcca2c83ad91b24d2a5
-  data.tar.gz: 95e62afbb4b49ab897434fe33926322964439af03726c570bec6296eb4c51ca1
+  metadata.gz: ddc6e7ca4c4edfab72abe33e0a3688871bd8e746f00f0ea00c832e9b4bad700e
+  data.tar.gz: cf128002a889f0446b6ddc0c8a212dbbd5885af27c6aee1552a8de9b5f723a22
 SHA512:
-  metadata.gz: 8280b0616181a1b13b4192bc6cd9ceb6b43498d31bd83b871d3da0bba924c63b52d67598df83df8d8ccac535999f81a99e42b530cbc0ab6afeddbfa9366928e2
-  data.tar.gz: ee8d6f445603ef26932c631a2064f337186c6f27451771b2f31577df37c587f318b1abe22e9277e7db48f2d65d47ca7c62f1177a67cbc35df615e5277931bce1
+  metadata.gz: 4f05eada087b1d751525c2439ad60918e0179fce0766230d75502e3ad1d8970af74057e1262c89eaf04b372885574b01d645f852b284d56f73bb88eeab6e072e
+  data.tar.gz: 98c5830eb74ae87c10313ad07eb4f72f35f444f8f4c75db8e79640200017e67dff65e45464aa24afcfb68fad3261735ee7ae3b9e3a155a090e91160c8bb9fac3

data/CHANGELOG.md

@@ -1,15 +1,39 @@
-# 0.1.0 (2022-07-12)
+## [0.1.3](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@0.1.2...types_from_serializers@0.1.3) (2022-07-12)
+
+
+### Features
+
+* apply the sql mapping fallback as the default ([64898c4](https://github.com/ElMassimo/types_from_serializers/commit/64898c4e3a3f83ea67294f2200f253cd2a64aea9))
+
+
+
+## [0.1.2](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@0.1.1...types_from_serializers@0.1.2) (2022-07-12)
 
 
 ### Bug Fixes
 
-* handle non-ActiveRecord models and extract types from unions ([ea9b2a7](https://github.com/ElMassimo/types_from_serializers/commit/ea9b2a71cb85503ff691e5ef115ab73f89b005af))
+* avoid having the full file path in the cache key ([556f8f6](https://github.com/ElMassimo/types_from_serializers/commit/556f8f667608fa950a3ad0647540055b1b5f1dc8))
+
+
+
+## [0.1.1](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@0.1.0...types_from_serializers@0.1.1) (2022-07-12)
+
+
+
+# 0.1.0 (2022-07-12)
 
 
 ### Features
 
-* make the DSL is available without manually requiring ([04a4f3a](https://github.com/ElMassimo/types_from_serializers/commit/04a4f3ad3c96658639cbe75de07f19cc7f79f4c6))
-* support specifying base serializers and additional dirs to scan ([164cfe1](https://github.com/ElMassimo/types_from_serializers/commit/164cfe17bb0527c59cf95441381aef7bf797a568))
+- Start simple, no additional syntax required
+- Infers types from a related `ActiveRecord` model, using the SQL schema
+- Understands JS native types and how to map SQL columns: `string`, `boolean`, etc
+- Automatically types [associations](https://github.com/ElMassimo/oj_serializers#associations-dsl-), importing the generated types for the referenced serializers
+- Detects [conditional attributes](https://github.com/ElMassimo/oj_serializers#rendering-an-attribute-conditionally) and marks them as optional: `name?: string`
+- Fallback to a custom interface using `type_from`
+- Supports custom types and automatically adds the necessary imports
+- handle non-ActiveRecord models and extract types from unions ([ea9b2a7](https://github.com/ElMassimo/types_from_serializers/commit/ea9b2a71cb85503ff691e5ef115ab73f89b005af))
+- support specifying base serializers and additional dirs to scan ([164cfe1](https://github.com/ElMassimo/types_from_serializers/commit/164cfe17bb0527c59cf95441381aef7bf797a568))
 
 
 

data/lib/types_from_serializers/generator.rb

@@ -15,7 +15,11 @@ module TypesFromSerializers
     :native_types,
     :sql_to_typescript_type_mapping,
     keyword_init: true,
-  )
+  ) do
+    def unknown_type
+      sql_to_typescript_type_mapping.default
+    end
+  end
 
   # Internal: The type metadata for a serializer.
   SerializerMetadata = Struct.new(
@@ -47,9 +51,10 @@ module TypesFromSerializers
         to_s.classify.safe_constantize
       end
 
-      delegate :to_model, to: :to_s
+      def to_model
+        to_s.to_model
+      end
     end
-    # rubocop:enable Rails/Delegate
 
     refine Class do
       # Internal: Name of the TypeScript interface.
@@ -133,7 +138,7 @@ module TypesFromSerializers
 
       def typescript_fields(metadata)
         (metadata.attributes + metadata.associations).map { |meta|
-          type = meta.type.is_a?(Class) ? meta.type.typescript_interface_name : meta.type || :unknown
+          type = meta.type.is_a?(Class) ? meta.type.typescript_interface_name : meta.type || TypesFromSerializers.config.unknown_type
           type = meta.many ? "#{type}[]" : type
           "  #{meta.typescript_name}#{"?" if meta.optional}: #{type}"
         }
@@ -198,6 +203,7 @@ module TypesFromSerializers
     # Public: Generates code for all serializers in the app.
     def generate(force: ENV["SERIALIZER_TYPES_FORCE"])
       @force_generation = force
+      config.output_dir.rmtree if force && config.output_dir.exist?
       generate_index_file
 
       loaded_serializers.each do |serializer|
@@ -221,26 +227,16 @@ module TypesFromSerializers
 
       write_if_changed(filename: filename, cache_key: metadata.inspect) {
         serializer.typescript_infer_types(metadata)
-        <<~TS
-          //
-          // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
-          #{serializer.typescript_imports(metadata).join}
-          export default interface #{serializer.typescript_interface_name} {
-          #{serializer.typescript_fields(metadata).join("\n")}
-          }
-        TS
+        serializer_interface_content(serializer, metadata)
       }
     end
 
     # Internal: Allows to import all serializer types from a single file.
     def generate_index_file
-      write_if_changed(filename: "index", cache_key: all_serializer_files.join) {
+      cache_key = all_serializer_files.map { |file| file.delete_prefix(root.to_s) }.join
+      write_if_changed(filename: "index", cache_key: cache_key) {
         load_serializers(all_serializer_files)
-        <<~TS
-          //
-          // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
-          #{loaded_serializers.map { |s| "export type { default as #{s.typescript_interface_name} } from './#{s.typescript_interface_basename}'" }.join("\n")}
-        TS
+        serializers_index_content(loaded_serializers)
       }
     end
 
@@ -265,7 +261,7 @@ module TypesFromSerializers
     end
 
     def all_serializer_files
-      config.serializers_dirs.flat_map { |dir| Dir["#{dir}/**/*.rb"] }
+      config.serializers_dirs.flat_map { |dir| Dir["#{dir}/**/*.rb"] }.sort
     end
 
     def load_serializers(files)
@@ -335,6 +331,25 @@ module TypesFromSerializers
       }
     end
 
+    def serializers_index_content(serializers)
+      <<~TS
+        //
+        // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
+        #{serializers.map { |s| "export type { default as #{s.typescript_interface_name} } from './#{s.typescript_interface_basename}'" }.join("\n")}
+      TS
+    end
+
+    def serializer_interface_content(serializer, metadata)
+      <<~TS
+        //
+        // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
+        #{serializer.typescript_imports(metadata).join}
+        export default interface #{serializer.typescript_interface_name} {
+        #{serializer.typescript_fields(metadata).join("\n")}
+        }
+      TS
+    end
+
     # Internal: Returns true if the cache key has changed since the last codegen.
     def stale?(file, cache_key_comment)
       @force_generation || file.gets != cache_key_comment

data/lib/types_from_serializers/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: types_from_serializers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Máximo Mussini
@@ -114,6 +114,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-snapshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +156,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: js_from_routes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement