typelizer 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a7d9dfc60b5b5b8432575016f4f63697b6c6e356d74044abf6646b7d8e10a6
-  data.tar.gz: 374654bfb99f5bb3363b7a21174bb4c4a52718d2b852d4597e80aa155ce6fa34
+  metadata.gz: 8810d416e08a0541a844bf7e538fbd66999f1ab5e0b6209d5e7c071b06c58fdf
+  data.tar.gz: 725952a78be5d5f3e13d10e876badfc2be72e848af6bfd2a8063b0f34d0b28c8
 SHA512:
-  metadata.gz: 3886301d0db29ef0ed101f5edf76e6228501672f5750c0109a854e142f880c1cd24a71fea9ca352caa888697f801302283b679e36ac61ea19c87e8c9b73ecfb4
-  data.tar.gz: bf5b5cdc3748500355aa1bac6d2f0dc035a4776080e06bee523c369cf33177ed24f1e92702e42366e5a7b1e72994696ff32dc52f55295f66bbf48f7961c5e2a5
+  metadata.gz: a6e833349308d44de700a56865f948f8fa1a2d352acf23d34ab6d9fe22c548ceeef70d566fb78e700f985334f3eb40cabbe8542900b792b6966b98a7e3c07698
+  data.tar.gz: a6570c070f5b20876814b47045862e2aeeba6589bbd0c6220b43d958f9d46f93e08d54fa3aa1fdc81f74bc874d86acd3f5fe5bc9d4fb4ba7d828534a7ae31c0e

data/CHANGELOG.md

@@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.14.0] - 2026-10-03
+
+### Added
+
+- [Blueprinter](https://github.com/procore-oss/blueprinter) support, including views. ([@skryukov])
+
+### Fixed
+
+- Associations and nested attributes no longer take the type of a model column with the same name. ([@lukasedw])
+- Generated route files no longer have duplicate keys when a resource is routed more than once, e.g. nested under several parents. ([@visini])
+- OpenAPI: a string literal mixed with other types (`'auto' | number`) now becomes a string enum instead of a broken `$ref`. ([@skryukov])
+- Conditional attributes (`if:`/`unless:`) stay optional under `null_strategy :optional` and `:nullable_and_optional`, even when the column is NOT NULL. ([@skryukov])
+- Generation no longer crashes for a serializer whose class name contains neither `Serializer` nor `Resource`. ([@skryukov])
+- Keys that aren't valid identifiers (e.g. from Alba's `transform_keys :dash`) are now quoted, and quotes in enum values are escaped. Run `rails typelizer:generate:refresh` once to fix existing files. ([@skryukov])
+
+## [0.13.1] - 2026-05-18
+
+### Added
+
+- `routes.include` and `routes.exclude` now accept a `Proc` (or any callable responding to `#call`) in addition to `Regexp`. Predicates receive the route-info hash (`:path`, `:name`, `:controller`, `:action`, `:verb`, `:required_parts`, `:optional_parts`) and must return truthy to match. Heterogeneous arrays are supported. Useful when the URL path alone can't disambiguate routes — e.g. multiple feature areas mounted under different subdomain constraints that share paths, or filtering by HTTP verb / helper name. ([@pastpatryk])
+
+  ```ruby
+  config.routes.include = ->(r) { r[:controller].to_s.start_with?("admin/") }
+  ```
+
+### Fixed
+
+- Unnamed alias routes sharing `controller#action` with a named route (e.g. ActiveStorage representations) no longer inherit the named route's name. Name lookup now matches by `[controller, path]` instead of `[controller, action]`, so distinct paths produce distinct entries. ([@skryukov])
+
 ## [0.13.0] - 2026-05-01
 
 ### Added
@@ -492,9 +521,11 @@ and this project adheres to [Semantic Versioning].
 [@jonmarkgo]: https://github.com/jonmarkgo
 [@julik]: https://github.com/julik
 [@kristinemcbride]: https://github.com/kristinemcbride
+[@lukasedw]: https://github.com/lukasedw
 [@nkriege]: https://github.com/nkriege
 [@NOX73]: https://github.com/NOX73
 [@okuramasafumi]: https://github.com/okuramasafumi
+[@pastpatryk]: https://github.com/pastpatryk
 [@patvice]: https://github.com/patvice
 [@pgiblock]: https://github.com/pgiblock
 [@PedroAugustoRamalhoDuarte]: https://github.com/PedroAugustoRamalhoDuarte
@@ -502,8 +533,11 @@ and this project adheres to [Semantic Versioning].
 [@rdavid1099]: https://github.com/rdavid1099
 [@skryukov]: https://github.com/skryukov
 [@ventsislaf]: https://github.com/ventsislaf
+[@visini]: https://github.com/visini
 
-[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.13.0...HEAD
+[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.14.0...HEAD
+[0.14.0]: https://github.com/skryukov/typelizer/compare/v0.13.1...v0.14.0
+[0.13.1]: https://github.com/skryukov/typelizer/compare/v0.13.0...v0.13.1
 [0.13.0]: https://github.com/skryukov/typelizer/compare/v0.12.0...v0.13.0
 [0.12.0]: https://github.com/skryukov/typelizer/compare/v0.11.0...v0.12.0
 [0.11.0]: https://github.com/skryukov/typelizer/compare/v0.10.0...v0.11.0

data/README.md

@@ -8,7 +8,7 @@ Typelizer generates TypeScript types, route helpers, and OpenAPI schemas from yo
 
 - Automatic TypeScript interface generation from serializers
 - Type-safe route helpers from Rails routes
-- Supports Alba, ActiveModel::Serializer, Oj::Serializer, Panko::Serializer
+- Supports Alba, ActiveModel::Serializer, Oj::Serializer, Panko::Serializer, Blueprinter
 - OpenAPI 3.0/3.1 schema generation
 - Multiple output writers with layered configuration
 - File watching with automatic regeneration in development
@@ -60,7 +60,7 @@ cd spec/app && RAILS_ENV=test bundle exec rails db:create db:migrate && cd ../..
 bundle exec rspec
 ```
 
-The test suite uses a dummy Rails app in `spec/app/` with models, migrations, and serializers for all four supported frameworks (Alba, AMS, OjSerializers, Panko). Linting is done with StandardRB:
+The test suite uses a dummy Rails app in `spec/app/` with models, migrations, and serializers for all five supported frameworks (Alba, AMS, OjSerializers, Panko, Blueprinter). Linting is done with StandardRB:
 
 ```bash
 bundle exec standardrb
@@ -72,9 +72,9 @@ bundle exec standardrb
 
 Typelizer is inspired by [types_from_serializers](https://github.com/ElMassimo/types_from_serializers), [js-routes](https://github.com/railsware/js-routes), and [Wayfinder](https://github.com/nicholasvansanten/wayfinder).
 
-<a href="https://evilmartians.com/?utm_source=typelizer&utm_campaign=project_page">
-<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Built by Evil Martians" width="236" height="54">
-</a>
+<br/>
+
+<img src="https://cdn.evilmartians.com/badges/logo-no-label.svg" alt="Evil Martians logo" width="22" height="16" /> <b>Typelizer</b> is built by <b><a href="https://evilmartians.com/">Evil Martians</a></b>, an American design and engineering consultancy for <b>developer tools, AI, and cybersecurity startups</b>.
 
 ## License
 

data/lib/typelizer/config.rb

@@ -100,7 +100,7 @@ module Typelizer
           return name if name.empty?
 
           # remove only the end of the line
-          name.sub(/(Serializer|Resource)\z/, "")
+          name.sub(/(Serializer|Resource|Blueprint)\z/, "")
         end,
 
         filename_mapper: nil,

data/lib/typelizer/dsl/hooks/blueprinter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Typelizer
+  module DSL
+    module Hooks
+      module Blueprinter
+        include Methods
+        extend Builder
+
+        hook :field, :identifier, :association
+      end
+    end
+  end
+end

data/lib/typelizer/dsl/hooks.rb

@@ -18,6 +18,9 @@ module Typelizer
         elsif defined?(::Panko::Serializer) && base.ancestors.include?(::Panko::Serializer)
           require_relative "hooks/panko"
           base.singleton_class.prepend(Panko)
+        elsif defined?(::Blueprinter::Base) && base.ancestors.include?(::Blueprinter::Base)
+          require_relative "hooks/blueprinter"
+          base.singleton_class.prepend(Blueprinter)
         end
       end
 

data/lib/typelizer/interface.rb

@@ -148,7 +148,7 @@ module Typelizer
         # Collect enum type names from properties
         enum_imports = all_properties.filter_map(&:enum_type_name)
 
-        result = (custom_type_imports + serializer_types + trait_imports + enum_imports + Array(parent_interface&.name)).uniq - [self_type_name, name]
+        result = (custom_type_imports + serializer_types + trait_imports + enum_imports + Array(parent_interface&.name)).uniq - [self_type_name, name, *trait_interfaces.map(&:name)]
         ImportSorter.sort(result, config.imports_sort_order)
       end
     end
@@ -190,7 +190,7 @@ module Typelizer
     end
 
     def self_type_name
-      serializer.name.match(/(\w+::)?(\w+)(Serializer|Resource)/)[2]
+      serializer.name[/(\w+::)?(\w+)(Serializer|Resource|Blueprint)/, 2]
     end
 
     def extract_typescript_types(type)

data/lib/typelizer/model_plugins/active_record.rb

@@ -10,6 +10,7 @@ module Typelizer
 
       def infer_types(prop)
         infer_types_for_association(prop) ||
+          serializer_resolved_type?(prop) ||
           infer_types_for_column(prop) ||
           infer_types_for_association_ids(prop) ||
           infer_types_for_delegate(prop) ||
@@ -26,6 +27,7 @@ module Typelizer
       end
 
       def enum_for(prop)
+        return if serializer_resolved_type?(prop)
         return unless model_class&.defined_enums&.key?(prop.column_name.to_s)
 
         prop.enum = model_class.defined_enums[prop.column_name.to_s].keys
@@ -35,6 +37,12 @@ module Typelizer
 
       private
 
+      # An association or nested attribute is already typed by the serializer;
+      # a same-named column describes a different value.
+      def serializer_resolved_type?(prop)
+        prop.type.is_a?(Interface) || prop.type.is_a?(Shape)
+      end
+
       def columns_hash
         return nil unless model_class
         return nil if model_class.abstract_class?
@@ -55,6 +63,7 @@ module Typelizer
         association = model_class&.reflect_on_association(prop.column_name.to_sym)
         return nil unless association
 
+        prop.multi = association.collection? if prop.multi.nil?
         case association.macro
         when :belongs_to
           foreign_key = association.foreign_key
@@ -89,10 +98,10 @@ module Typelizer
         when :nullable
           prop.nullable = column.null
         when :optional
-          prop.optional = column.null
+          prop.optional ||= column.null
         when :nullable_and_optional
           prop.nullable = column.null
-          prop.optional = column.null
+          prop.optional ||= column.null
         else
           raise "Unknown null strategy: #{config.null_strategy}"
         end

data/lib/typelizer/openapi.rb

@@ -101,6 +101,8 @@ module Typelizer
       def union_member_schema(type)
         if type.respond_to?(:properties)
           {"$ref" => "#/components/schemas/#{type.name}"}
+        elsif string_literal?(type)
+          {type: :string, enum: [unquote_string_literal(type)]}
         else
           sym = type.to_sym
           if OPENAPI_TYPES.include?(sym)

data/lib/typelizer/property.rb

@@ -53,7 +53,7 @@ module Typelizer
       # Add nullable at the end (null should always be last in sorted output)
       type_str = "#{type_str} | null" if nullable
 
-      "#{name}#{"?" if optional}: #{type_str}"
+      "#{js_key(name.to_s, prefer_double_quotes)}#{"?" if optional}: #{type_str}"
     end
 
     def fingerprint
@@ -95,7 +95,9 @@ module Typelizer
     end
 
     def quote_string(str, prefer_double_quotes)
-      prefer_double_quotes ? "\"#{str}\"" : "'#{str}'"
+      quote = prefer_double_quotes ? '"' : "'"
+      escaped = str.to_s.gsub(/[\\#{quote}]/) { |char| "\\#{char}" }
+      "#{quote}#{escaped}#{quote}"
     end
 
     def js_key(str, prefer_double_quotes)

data/lib/typelizer/route_generator.rb

@@ -33,14 +33,14 @@ module Typelizer
         Rails.application.reload_routes_unless_loaded
       end
 
-      name_by_action, name_by_path = build_name_lookups(Rails.application.routes.named_routes)
+      named_paths = build_named_paths(Rails.application.routes.named_routes)
 
       routes = Rails.application.routes.routes.flat_map do |route|
         app = route.app.app
         if app.is_a?(Class) && app < Rails::Engine
           collect_engine_routes(route, app) || []
         else
-          build_route_info(route, name_by_action, name_by_path)
+          build_route_info(route, named_paths)
         end
       end.compact
 
@@ -49,52 +49,57 @@ module Typelizer
         .map { |r| [r[:controller], r[:action], r[:path]] }.to_set
       routes.reject! { |r| r[:verb] == "put" && patch_keys.include?([r[:controller], r[:action], r[:path]]) }
 
+      # Skip unnamed duplicates of a named route (Rails repeats member routes under each parent for `shallow: true`)
+      named_keys = routes.select { |r| r[:named] }
+        .map { |r| [r[:controller], r[:verb], r[:path]] }.to_set
+      routes.reject! { |r| !r[:named] && named_keys.include?([r[:controller], r[:verb], r[:path]]) }
+      routes.uniq!
+
       if config.include
         patterns = Array(config.include)
-        routes = routes.select { |r| patterns.any? { |p| r[:path].match?(p) } }
+        routes = routes.select { |r| patterns.any? { |p| match_route?(r, p) } }
       end
       if config.exclude
         patterns = Array(config.exclude)
-        routes = routes.reject { |r| patterns.any? { |p| r[:path].match?(p) } }
+        routes = routes.reject { |r| patterns.any? { |p| match_route?(r, p) } }
       end
 
       routes
     end
 
-    def build_name_lookups(named_routes, path_prefix: "", name_prefix: "")
-      name_by_action = {}
-      name_by_path = {}
+    def match_route?(route_info, pattern)
+      if pattern.respond_to?(:call)
+        pattern.call(route_info)
+      else
+        route_info[:path].match?(pattern)
+      end
+    end
 
-      named_routes.each do |name, route|
+    def build_named_paths(named_routes, path_prefix: "")
+      named_routes.each_with_object({}) do |(name, route), paths|
         controller = route.requirements[:controller]
         action = route.requirements[:action]
         next unless controller && action
 
-        path = path_prefix + strip_format(route.path.spec.to_s)
-        prefixed_name = "#{name_prefix}#{name}"
-        name_by_action[[controller, action]] = prefixed_name
-        name_by_path[[controller, path]] = prefixed_name
+        paths[[controller, path_prefix + strip_format(route.path.spec.to_s)]] ||= name.to_s
       end
-
-      [name_by_action, name_by_path]
     end
 
     def strip_format(path)
       path.sub(FORMAT_SUFFIX, "")
     end
 
-    def build_route_info(route, name_by_action, name_by_path)
+    def build_route_info(route, named_paths)
       controller = route.requirements[:controller]
       action = route.requirements[:action]
 
       path = strip_format(route.path.spec.to_s)
 
       if controller.present? && action.present?
-        has_own_name = !!route.name
-        name = route.name || name_by_action[[controller, action]]
-        name ||= name_by_path[[controller, path]] ? action : nil
+        # Match by [controller, path] so unnamed aliases at distinct paths (e.g. ActiveStorage representations) don't inherit a sibling's name
+        path_name = named_paths[[controller, path]]
+        name = route.name || (action if path_name)
       elsif route.name.present?
-        has_own_name = true
         name = route.name.to_s
         controller = "_routes"
         action = name
@@ -110,7 +115,8 @@ module Typelizer
 
       {
         name: name,
-        named: has_own_name || !!name_by_action[[controller, action]],
+        named: !!route.name,
+        path_name: path_name,
         controller: controller,
         action: action,
         verb: verb,
@@ -125,14 +131,10 @@ module Typelizer
       engine_name = mount_route.name
       return unless engine_name
 
-      name_by_action, name_by_path = build_name_lookups(
-        engine.routes.named_routes,
-        path_prefix: mount_prefix,
-        name_prefix: "#{engine_name}_"
-      )
+      named_paths = build_named_paths(engine.routes.named_routes, path_prefix: mount_prefix)
 
       engine.routes.routes.filter_map do |engine_route|
-        info = build_route_info(engine_route, name_by_action, name_by_path)
+        info = build_route_info(engine_route, named_paths)
         next unless info
         info[:path] = mount_prefix + info[:path]
         info

data/lib/typelizer/route_writer.rb

@@ -145,8 +145,12 @@ module Typelizer
     end
 
     def route_key(route, controller_routes)
-      collides = controller_routes.count { |r| r[:action] == route[:action] } > 1
-      camelize_key(collides ? route[:name] : route[:action])
+      same_action = controller_routes.select { |r| r[:action] == route[:action] }
+      return camelize_key(route[:action]) if same_action.one?
+      return camelize_key(route[:name]) if route[:named]
+      return camelize_key(route[:action]) if same_action.one? { |r| !r[:named] }
+
+      camelize_key("#{route[:action]}_#{route[:path_name]}")
     end
 
     def camelize_key(key)

data/lib/typelizer/serializer_plugins/alba.rb

@@ -1,4 +1,5 @@
 require_relative "base"
+require_relative "trait_interface"
 
 module Typelizer
   module SerializerPlugins
@@ -224,4 +225,3 @@ module Typelizer
 end
 
 require_relative "alba/block_attribute_collector"
-require_relative "alba/trait_interface"

data/lib/typelizer/serializer_plugins/auto.rb

@@ -15,6 +15,8 @@ module Typelizer
             AMS
           elsif defined?(::Panko::Serializer) && serializer.ancestors.include?(::Panko::Serializer)
             Panko
+          elsif defined?(::Blueprinter::Base) && serializer.ancestors.include?(::Blueprinter::Base)
+            Blueprinter
           else
             raise "Can't guess serializer plugin for #{serializer}. " \
                     "Please specify it with `config.serializer_plugin`."

data/lib/typelizer/serializer_plugins/blueprinter.rb

@@ -0,0 +1,71 @@
+require_relative "base"
+require_relative "trait_interface"
+
+module Typelizer
+  module SerializerPlugins
+    class Blueprinter < Base
+      CONDITIONAL_OPTIONS = %i[if unless exclude_if_nil].freeze
+
+      def properties
+        view_properties(:default)
+      end
+
+      # Each extra view becomes its own full type, since views can also exclude fields
+      def trait_interfaces
+        @trait_interfaces ||= (serializer.reflections.keys - %i[default identifier]).map do |view|
+          TraitInterface.new(serializer: serializer, trait_name: view, context: context, plugin: self, suffix: "View")
+        end
+      end
+
+      def trait_properties(view)
+        typelizes = serializer.respond_to?(:_typelizer_attributes) ? serializer._typelizer_attributes : {}
+        [view_properties(view), typelizes]
+      end
+
+      private
+
+      def view_properties(view)
+        reflection = serializer.reflections.fetch(view)
+        reflection.fields.values.map { |field| field_property(field) } +
+          reflection.associations.values.map { |association| association_property(association) }
+      end
+
+      def field_property(field)
+        Property.new(
+          name: field.display_name,
+          optional: optional?(field.options),
+          nullable: false,
+          multi: false,
+          column_name: field.name
+        )
+      end
+
+      # `multi` stays nil: Blueprinter renders a list or a single object depending
+      # on the value, so the model's association decides
+      def association_property(association)
+        Property.new(
+          name: association.display_name,
+          type: association_type(association),
+          optional: optional?(association.options),
+          nullable: false,
+          multi: nil,
+          column_name: association.name
+        )
+      end
+
+      def association_type(association)
+        blueprint = association.blueprint
+        return unless blueprint.is_a?(Class)
+
+        interface = context.interface_for(blueprint)
+        return interface if association.view == :default
+
+        interface.trait_interfaces.find { |view| view.trait_name == association.view }&.name
+      end
+
+      def optional?(options)
+        CONDITIONAL_OPTIONS.any? { |key| options.key?(key) }
+      end
+    end
+  end
+end

data/lib/typelizer/serializer_plugins/{alba/trait_interface.rb → trait_interface.rb}

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
-require_relative "../../type_inference"
+require_relative "../type_inference"
 
 module Typelizer
   module SerializerPlugins
-    class Alba::TraitInterface
+    class TraitInterface
       include TypeInference
 
       attr_reader :serializer, :trait_name, :context, :plugin
 
-      def initialize(serializer:, trait_name:, context:, plugin:)
+      def initialize(serializer:, trait_name:, context:, plugin:, suffix: "Trait")
         @serializer = serializer
         @trait_name = trait_name
         @context = context
         @plugin = plugin
+        @suffix = suffix
       end
 
       def config
@@ -22,7 +23,7 @@ module Typelizer
 
       def name
         base_name = config.serializer_name_mapper.call(serializer).tr_s(":", "")
-        "#{base_name}#{trait_name.to_s.camelize}Trait"
+        "#{base_name}#{trait_name.to_s.camelize}#{@suffix}"
       end
 
       def properties

data/lib/typelizer/version.rb

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

data/lib/typelizer.rb

@@ -29,6 +29,7 @@ require_relative "typelizer/serializer_plugins/oj_serializers"
 require_relative "typelizer/serializer_plugins/alba"
 require_relative "typelizer/serializer_plugins/ams"
 require_relative "typelizer/serializer_plugins/panko"
+require_relative "typelizer/serializer_plugins/blueprinter"
 
 require_relative "typelizer/model_plugins/active_record"
 require_relative "typelizer/model_plugins/poro"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typelizer
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
@@ -56,6 +56,7 @@ files:
 - lib/typelizer/dsl/hooks.rb
 - lib/typelizer/dsl/hooks/alba.rb
 - lib/typelizer/dsl/hooks/ams.rb
+- lib/typelizer/dsl/hooks/blueprinter.rb
 - lib/typelizer/dsl/hooks/oj_serializers.rb
 - lib/typelizer/dsl/hooks/panko.rb
 - lib/typelizer/generator.rb
@@ -77,12 +78,13 @@ files:
 - lib/typelizer/serializer_config_layer.rb
 - lib/typelizer/serializer_plugins/alba.rb
 - lib/typelizer/serializer_plugins/alba/block_attribute_collector.rb
-- lib/typelizer/serializer_plugins/alba/trait_interface.rb
 - lib/typelizer/serializer_plugins/ams.rb
 - lib/typelizer/serializer_plugins/auto.rb
 - lib/typelizer/serializer_plugins/base.rb
+- lib/typelizer/serializer_plugins/blueprinter.rb
 - lib/typelizer/serializer_plugins/oj_serializers.rb
 - lib/typelizer/serializer_plugins/panko.rb
+- lib/typelizer/serializer_plugins/trait_interface.rb
 - lib/typelizer/shape.rb
 - lib/typelizer/templates/comment.ts.erb
 - lib/typelizer/templates/enums.ts.erb