types_from_serializers 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcf37c6e48a063c85bcbfef2e383c92ac841bc69e6fbacd817a3ebeb4f60b722
-  data.tar.gz: dc83b8c53f250040db99e380bef6abb2b973981f8007b2b1151f75f6789b8d1a
+  metadata.gz: 0c7231c333c07c7cc5c16f2934c5c6cdc59b6633ad93b1a97f254d489f43af95
+  data.tar.gz: 9165a3c8fd6d7fb50ef7f4c26a3d6fb8d33c60cc6a2397657777f97fde10940a
 SHA512:
-  metadata.gz: a289339bfa3f5cd7b980cd72fc663f5ca2d92b838feb82ee9612a5d7664de2fba1864a81490d2b2899ea59b7a7c5c8c53094b2ab017062cfa2dd16468bdaba64
-  data.tar.gz: 7f9ae782d1bd177a1148c7eb977f749c800ff00af86bfe49e0575ab87af36cb7e6dc44d05b2637393f444bd3060f5cfd190bebe55c5a7d6c904cac9955880d4b
+  metadata.gz: 71add1bc036f519427612789520ddea812be40d1d2daac7ad1e6553d7d2d4c4d9981f94eff342dfbe951315b9c3cb91a7d6ca960d1e8139e247ff11a6e48a9c6
+  data.tar.gz: 8ddfa2c04c39db9ec8940c799a3c38494a69ead2ac4e656494b8784db4d2c4f418fa0a05338301f04bd6d3cd6ae11830e6e02f0a98897b5a19a969e59c14676c

data/CHANGELOG.md

@@ -1,6 +1,25 @@
-## [2.6.1](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.6.0...types_from_serializers@2.6.1) (2026-07-03)
+# [2.7.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.6.1...types_from_serializers@2.7.0) (2026-10-19)
+
+
+### Features
+
+* replace generated cache-key headers with content comparison ([#37](https://github.com/ElMassimo/types_from_serializers/issues/37)) ([1902824](https://github.com/ElMassimo/types_from_serializers/commit/19028240524cfff7007f04030b2cb968b856abec))
+
+
 
+# [2.7.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.6.1...types_from_serializers@2.7.0) (2026-10-17)
+
+
+### Features
+
+* generated files no longer start with a `// TypesFromSerializers CacheKey` header. Files are compared by content and only written when they changed, which removes a frequent source of merge conflicts. Run `bin/rake types_from_serializers:generate` once after upgrading to drop the header from existing files.
+* in development, only the serializers whose files were modified are regenerated, together with their subclasses and the serializers that flat-embed them, found by scanning the serializer files; adding or removing a serializer file still triggers a full pass.
+* `SERIALIZER_TYPES_FORCE` now only controls whether the output dir is cleaned before generating.
+
+
+## [2.6.1](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.6.0...types_from_serializers@2.6.1) (2026-07-03)
 
+* Render nullable boolean columns with default value of false as not optional on rails 8.1 [#36](https://github.com/ElMassimo/types_from_serializers/pull/36)
 
 # [2.6.0](https://github.com/ElMassimo/types_from_serializers/compare/types_from_serializers@2.5.0...types_from_serializers@2.6.0) (2026-05-06)
 

data/lib/types_from_serializers/dsl.rb

@@ -32,7 +32,7 @@ module TypesFromSerializers
         attribute type: type, **options
       end
 
-    private
+      private
 
       # Override: Remove unnecessary options in production, types are only
       # used when generating code in development.

data/lib/types_from_serializers/generator.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "digest"
 require "fileutils"
 require "pathname"
 
@@ -152,7 +151,7 @@ module TypesFromSerializers
       TS
     end
 
-  protected
+    protected
 
     def pathname
       @pathname ||= Pathname.new(filename)
@@ -249,7 +248,7 @@ module TypesFromSerializers
       @modified.clear
     end
 
-  private
+    private
 
     def track_changes(dirs)
       Listen.to(*dirs, only: %r{.rb$}) do |modified, added, removed|
@@ -263,8 +262,6 @@ module TypesFromSerializers
   class << self
     using SerializerRefinements
 
-    attr_reader :force_generation
-
     # Public: Registry of named configurations for multi-app setups.
     def configs
       @configs ||= {}
@@ -283,19 +280,14 @@ module TypesFromSerializers
     end
 
     # Public: Generates code for all serializers in the app.
+    #
+    # force - Deletes the output dir first, so that files for serializers that
+    #         were renamed or removed don't linger.
     def generate(force: ENV["SERIALIZER_TYPES_FORCE"])
-      @force_generation = force
       config.output_dir.rmtree if force && config.output_dir.exist?
-
-      if config.namespace
-        load_serializers(all_serializer_files) if force
-      else
-        generate_index_file
-      end
-
-      loaded_serializers.each do |serializer|
-        generate_interface_for(serializer)
-      end
+      load_serializers(all_serializer_files)
+      generate_index_file unless config.namespace
+      generate_interfaces
     end
 
     # Public: Generates types for all registered configurations (default + named).
@@ -306,28 +298,29 @@ module TypesFromSerializers
       end
     end
 
+    # Public: Generates code only for serializers whose files changed since the
+    # last run, which avoids loading every serializer on each reload.
+    #
+    # When files were only modified, the index can't have changed (it's derived
+    # from file names), so only the modified serializers and the ones that
+    # depend on them are regenerated. Added or removed files require a full pass.
     def generate_changed
       chg = changes_for(config)
-      if chg.updated?
-        config.output_dir.rmtree if chg.any_removed?
-        load_serializers(chg.modified_files)
-        generate
-        chg.clear
+      return unless chg.updated?
+
+      if chg.only_modified?
+        load_serializers_and_dependents(chg.modified_files)
+        generate_interfaces
+      else
+        generate(force: chg.any_removed?)
       end
+      chg.clear
     end
 
     # Public: Like generate_changed but for all registered configurations.
     def generate_all_changed
       all_configs_list.each do |cfg|
-        chg = changes_for(cfg)
-        if chg.updated?
-          with_active_config(cfg) do
-            config.output_dir.rmtree if chg.any_removed?
-            load_serializers(chg.modified_files)
-            generate
-            chg.clear
-          end
-        end
+        with_active_config(cfg) { generate_changed }
       end
     end
 
@@ -335,16 +328,14 @@ module TypesFromSerializers
     def generate_interface_for(serializer)
       interface = serializer.ts_interface
 
-      write_if_changed(filename: interface.filename, cache_key: interface.inspect, extension: config.namespace ? "d.ts" : "ts") {
+      write_if_changed(filename: interface.filename, extension: config.namespace ? "d.ts" : "ts") {
         serializer_interface_content(interface)
       }
     end
 
     # Internal: Allows to import all serializer types from a single file.
     def generate_index_file
-      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)
+      write_if_changed(filename: "index") {
         serializers_index_content(loaded_serializers)
       }
     end
@@ -365,7 +356,7 @@ module TypesFromSerializers
       all_configs_list.map { |cfg| changes_for(cfg) }
     end
 
-  private
+    private
 
     def root
       defined?(Rails) ? Rails.root : Pathname.new(Dir.pwd)
@@ -390,6 +381,51 @@ module TypesFromSerializers
       @config = saved
     end
 
+    def generate_interfaces
+      loaded_serializers.each { |serializer| generate_interface_for(serializer) }
+    end
+
+    # Internal: Requires the given serializer files, plus every serializer file
+    # whose interface depends on a serializer they define, transitively. Rails
+    # unloads all classes before to_prepare, so subclasses and flat associations
+    # of a modified serializer would otherwise stay unloaded, and their files
+    # stale.
+    def load_serializers_and_dependents(files)
+      loaded = Set.new
+      pending = files.to_a
+      until pending.empty?
+        load_serializers(pending)
+        loaded.merge(pending)
+        names = serializer_names_defined_in(pending)
+        pending = names.empty? ? [] : serializer_files_depending_on(names).reject { |file| loaded.include?(file) }
+      end
+    end
+
+    def serializer_names_defined_in(files)
+      base_serializers = config.base_serializers.filter_map(&:safe_constantize)
+      (base_serializers + base_serializers.flat_map(&:descendants))
+        .select { |serializer| files.include?(Object.const_source_location(serializer.name)&.first) }
+        .map { |serializer| serializer.name.demodulize }
+        .uniq
+    end
+
+    # Internal: Files whose serializers inherit from, or flat-embed, one of the
+    # named serializers: the only references that change a generated interface,
+    # since plain associations only import the other interface by name.
+    #
+    # A file is scanned as text rather than loaded, so this is cheap. Flat
+    # associations are matched loosely (a flat call anywhere plus the name
+    # anywhere) so that multi-line calls aren't missed.
+    def serializer_files_depending_on(names)
+      alternatives = names.map { |name| Regexp.escape(name) }.join("|")
+      inherits = /<\s*(?:\w+::)*(?:#{alternatives})\b/
+      mentions = /\b(?:#{alternatives})\b/
+      all_serializer_files.select { |file|
+        source = File.read(file)
+        source.match?(inherits) || (source.include?("flat") && source.match?(mentions))
+      }
+    end
+
     def all_serializer_files
       config.serializers_dirs.flat_map { |dir| Dir["#{dir}/**/*.rb"] }.sort
     end
@@ -463,26 +499,21 @@ module TypesFromSerializers
       )
     end
 
-    # Internal: Writes if the file does not exist or the cache key has changed.
-    # The cache strategy consists of a comment on the first line of the file.
+    # Internal: Writes the file unless it already has the same content, which
+    # keeps mtimes stable so file watchers don't react to no-op generations.
     #
-    # Yields to receive the rendered file content when it needs to.
-    def write_if_changed(filename:, cache_key:, extension: "ts")
+    # Yields to receive the rendered file content.
+    def write_if_changed(filename:, extension: "ts")
       filename = config.output_dir.join("#{filename}.#{extension}")
+      content = yield
+      return if filename.exist? && filename.read == content
+
       FileUtils.mkdir_p(filename.dirname)
-      cache_key_comment = "// TypesFromSerializers CacheKey #{Digest::MD5.hexdigest(cache_key)}\n"
-      File.open(filename, "a+") { |file|
-        if stale?(file, cache_key_comment)
-          file.truncate(0)
-          file.write(cache_key_comment)
-          file.write(yield)
-        end
-      }
+      filename.write(content)
     end
 
     def serializers_index_content(serializers)
       <<~TS
-        //
         // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
         #{serializers.reject(&:inline_serializer?).map { |s|
           "export type { default as #{s.ts_name} } from './#{s.ts_filename}'"
@@ -496,7 +527,6 @@ module TypesFromSerializers
 
     def standard_interface_definition(interface)
       <<~TS
-        //
         // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
         #{interface.used_imports.join}
         export default #{interface.as_typescript}
@@ -505,7 +535,6 @@ module TypesFromSerializers
 
     def declaration_interface_definition(interface)
       <<~TS
-        //
         // DO NOT MODIFY: This file was automatically generated by TypesFromSerializers.
         #{interface.used_imports.empty? ? "export {}\n" : interface.used_imports.join}
         declare global {
@@ -515,10 +544,5 @@ module TypesFromSerializers
         }
       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
-    end
   end
 end

data/lib/types_from_serializers/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: types_from_serializers
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Máximo Mussini
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -84,16 +83,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -228,7 +227,6 @@ homepage: https://github.com/ElMassimo/types_from_serializers
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -243,8 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Generate TypeScript interfaces from your JSON serializers.
 test_files: []