typelizer 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d728a2d15357f1cd3316c78dde5407a130c26e80cfc8e4e706cfa3836ef4d650
-  data.tar.gz: f3f4c3b3420da55c4c2a671a85b9a03d06cf02a09a1df63578c4df0f91a4ea75
+  metadata.gz: 45bdcfd99663e0a61f6d70b5825f4ee29db4bc70927676c162fab5e8557675d6
+  data.tar.gz: ff3df8f4e1433bf7e8eb2f88318c117d58f86d14b974d6c1100fafe04988edc6
 SHA512:
-  metadata.gz: e1adc62cf80343300db84b62a34e13fb0f6bf5b6749a3940f34c56463054b0f4b50727ce946fcecff3fd05584ba3d45c0cd94ac77b733a6cdb676381b7163716
-  data.tar.gz: a7e6101a95798e1a1f5522b096fec15e966cfd3f354004c32d83702ea7cea230b06185df2180226d5b93325de51414f03d59cb05caba880dd9cd72ad87473b9e
+  metadata.gz: ed256b928dd5621f2a573c74997bcb2dd072af8ed02e79919e3f0506056bfd579405d234257136d87a3840393cc6fa625f2b50c1e9362eabcb5b7682e0d0eb00
+  data.tar.gz: ba1dab8fa94374dc25b02ac67b7e995f4a5d10c9492ceddf7bb866f22abaf609d148393af8a6c1eb899ccb553f0b2be542618811b58e1ae6b08f0d9d95d916ae

data/CHANGELOG.md

@@ -7,6 +7,34 @@ and this project adheres to [Semantic Versioning].
 
 ## [Unreleased]
 
+## [0.1.4] - 2024-10-04
+
+## Added
+
+- PORO model plugin ([@okuramasafumi])
+- Auto model plugin ([@skryukov])
+
+## [0.1.3] - 2024-09-27
+
+## Added
+
+- Support inline associations ([@okuramasafumi], [@skryukov])
+
+  Example of Alba serializer with inline associations (note the `helper Typelizer::DSL`, see [Alba's docs](https://github.com/okuramasafumi/alba?tab=readme-ov-file#helper) for more details):  
+
+  ```ruby
+  class FooSerializer
+    include Alba::Resource
+    helper Typelizer::DSL
+
+    many :bars do
+      typelize_from Bar
+
+      attributes :id, :name
+    end
+  end
+  ```
+
 ## [0.1.2] - 2024-09-05
 
 ### Fixed
@@ -27,7 +55,9 @@ and this project adheres to [Semantic Versioning].
 [@okuramasafumi]: https://github.com/@okuramasafumi
 [@skryukov]: https://github.com/skryukov
 
-[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/skryukov/typelizer/compare/v0.1.4...HEAD
+[0.1.4]: https://github.com/skryukov/typelizer/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/skryukov/typelizer/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/skryukov/typelizer/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/skryukov/typelizer/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/skryukov/typelizer/commits/v0.1.0

data/README.md

@@ -202,8 +202,8 @@ Typelizer.configure do |config|
   # Custom transformation for generated properties
   config.properties_transformer = ->(properties) { ... }
 
-  # Plugin for model type inference (default: ModelPlugins::ActiveRecord)
-  config.model_plugin = Typelizer::ModelPlugins::ActiveRecord
+  # Plugin for model type inference (default: ModelPlugins::Auto)
+  config.model_plugin = Typelizer::ModelPlugins::Auto
 
   # Plugin for serializer parsing (default: SerializerPlugins::Auto)
   config.serializer_plugin = Typelizer::SerializerPlugins::Auto

data/lib/typelizer/config.rb

@@ -29,13 +29,17 @@ module Typelizer
     class << self
       def instance
         @instance ||= new(
-          serializer_name_mapper: ->(serializer) { serializer.name.ends_with?("Serializer") ? serializer.name.delete_suffix("Serializer") : serializer.name.delete_suffix("Resource") },
+          serializer_name_mapper: ->(serializer) do
+            return "" if serializer.name.nil?
+
+            serializer.name.ends_with?("Serializer") ? serializer.name&.delete_suffix("Serializer") : serializer.name&.delete_suffix("Resource")
+          end,
           serializer_model_mapper: ->(serializer) do
             base_class = serializer_name_mapper.call(serializer)
             Object.const_get(base_class) if Object.const_defined?(base_class)
           end,
 
-          model_plugin: ModelPlugins::ActiveRecord,
+          model_plugin: ModelPlugins::Auto,
           serializer_plugin: SerializerPlugins::Auto,
           plugin_configs: {},
 

data/lib/typelizer/dsl.rb

@@ -4,12 +4,12 @@ module Typelizer
     # typelize attribute_name: ["string", "Date", optional: true, nullable: true, multi: true]
 
     def self.included(base)
-      Typelizer.base_classes << base.to_s
+      Typelizer.base_classes << base.to_s if base.name
       base.extend(ClassMethods)
     end
 
     def self.extended(base)
-      Typelizer.base_classes << base.to_s
+      Typelizer.base_classes << base.to_s if base.name
       base.extend(ClassMethods)
     end
 

data/lib/typelizer/generator.rb

@@ -33,8 +33,9 @@ module Typelizer
         raise ArgumentError, "Please ensure all your serializers include Typelizer::DSL." if base_classes.none?
       end
 
-      (base_classes + base_classes.flat_map(&:descendants)).uniq.sort_by(&:name)
+      (base_classes + base_classes.flat_map(&:descendants)).uniq
         .reject { |serializer| Typelizer.reject_class.call(serializer: serializer) }
+        .sort_by(&:name)
     end
 
     def read_serializers(files = nil)

data/lib/typelizer/interface.rb

@@ -11,8 +11,16 @@ module Typelizer
       @serializer_plugin = config.serializer_plugin.new(serializer: serializer, config: config)
     end
 
+    def inline?
+      !serializer.is_a?(Class) || serializer.name.nil?
+    end
+
     def name
-      config.serializer_name_mapper.call(serializer).tr_s(":", "")
+      if inline?
+        Renderer.new("inline_type.ts.erb").call(properties: properties).strip
+      else
+        config.serializer_name_mapper.call(serializer).tr_s(":", "")
+      end
     end
 
     def filename
@@ -51,7 +59,7 @@ module Typelizer
         .partition { |type| type.is_a?(Interface) }
 
       serializer_types = association_serializers
-        .filter_map { |interface| interface.name if interface.name != name }
+        .filter_map { |interface| interface.name if interface.name != name && !interface.inline? }
 
       custom_type_imports = attribute_types
         .flat_map { |type| extract_typescript_types(type.to_s) }

data/lib/typelizer/model_plugins/auto.rb

@@ -0,0 +1,19 @@
+module Typelizer
+  module ModelPlugins
+    module Auto
+      class << self
+        def new(model_class:, config:)
+          plugin(model_class).new(model_class: model_class, config: config)
+        end
+
+        def plugin(model_class)
+          if model_class && model_class < ::ActiveRecord::Base
+            ActiveRecord
+          else
+            Poro
+          end
+        end
+      end
+    end
+  end
+end

data/lib/typelizer/model_plugins/poro.rb

@@ -0,0 +1,13 @@
+module Typelizer
+  module ModelPlugins
+    class Poro
+      # We don't care about intialization
+      def initialize(...)
+      end
+
+      def infer_types(prop)
+        prop
+      end
+    end
+  end
+end

data/lib/typelizer/renderer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Typelizer
+  class Renderer
+    def initialize(template)
+      @erb = ERB.new(File.read(File.join(File.dirname(__FILE__), "templates/#{template}")), trim_mode: "-")
+    end
+
+    def call(**context)
+      b = binding
+      context.each_pair do |key, value|
+        b.local_variable_set(key, value)
+      end
+      erb.result(b)
+    end
+
+    private
+
+    attr_reader :erb
+
+    def indent(content, multiplier = 2)
+      spaces = " " * multiplier
+      content.to_s.each_line.map { |line| line.blank? ? line : "#{spaces}#{line}" }.join
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+{
+<%- properties.each do |property| -%>
+<%= indent(property) %>;
+<%- end -%>
+}

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

@@ -5,20 +5,20 @@ import type {<%= interface.imports.join(", ") %>} from '<%= interface.config.typ
 <%- if interface.root_key -%>
 type <%= interface.name %>Data = {
 <%- interface.properties.each do |property| -%>
-  <%= property %>;
+<%= indent(property) %>;
 <%- end -%>
 }
 
 type <%= interface.name %> = {
   <%= interface.root_key %>: <%= interface.name %>Data;
 <%- interface.meta_fields&.each do |property| -%>
-  <%= property %>;
+<%= indent(property) %>;
 <%- end -%>
 }
 <%- else -%>
 type <%= interface.name %> = {
 <%- interface.properties.each do |property| -%>
-  <%= property %>;
+<%= indent(property) %>;
 <%- end -%>
 }
 <%- end -%>

data/lib/typelizer/version.rb

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

data/lib/typelizer/writer.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "fileutils"
-require "erb"
 
 module Typelizer
   class Writer
@@ -54,8 +53,8 @@ module Typelizer
     end
 
     def render_template(template, **context)
-      template_cache[template] ||= ERB.new(File.read(File.join(File.dirname(__FILE__), "templates/#{template}")), trim_mode: "-")
-      template_cache[template].result_with_hash(context)
+      template_cache[template] ||= Renderer.new(template)
+      template_cache[template].call(**context)
     end
 
     def cleanup_output_dir

data/lib/typelizer.rb

@@ -4,6 +4,7 @@ require_relative "typelizer/version"
 require_relative "typelizer/config"
 require_relative "typelizer/property"
 require_relative "typelizer/interface"
+require_relative "typelizer/renderer"
 require_relative "typelizer/writer"
 require_relative "typelizer/generator"
 
@@ -15,9 +16,13 @@ require_relative "typelizer/serializer_plugins/alba"
 require_relative "typelizer/serializer_plugins/ams"
 
 require_relative "typelizer/model_plugins/active_record"
+require_relative "typelizer/model_plugins/poro"
+require_relative "typelizer/model_plugins/auto"
 
 require_relative "typelizer/railtie" if defined?(Rails)
 
+require "logger"
+
 module Typelizer
   class << self
     def enabled?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typelizer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Svyatoslav Kryukov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -41,8 +41,11 @@ files:
 - lib/typelizer/interface.rb
 - lib/typelizer/listen.rb
 - lib/typelizer/model_plugins/active_record.rb
+- lib/typelizer/model_plugins/auto.rb
+- lib/typelizer/model_plugins/poro.rb
 - lib/typelizer/property.rb
 - lib/typelizer/railtie.rb
+- lib/typelizer/renderer.rb
 - lib/typelizer/serializer_plugins/alba.rb
 - lib/typelizer/serializer_plugins/ams.rb
 - lib/typelizer/serializer_plugins/auto.rb
@@ -50,6 +53,7 @@ files:
 - lib/typelizer/serializer_plugins/oj_serializers.rb
 - lib/typelizer/templates/fingerprint.ts.erb
 - lib/typelizer/templates/index.ts.erb
+- lib/typelizer/templates/inline_type.ts.erb
 - lib/typelizer/templates/interface.ts.erb
 - lib/typelizer/version.rb
 - lib/typelizer/writer.rb