taro 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66112afc92f209f1cea91ae5483f54c37e8d5a79635ebf616afa0b868bc13637
-  data.tar.gz: fe46dcf993a314c1b2a5a08088010c523041a90bda55c121d81cf91ed665c11d
+  metadata.gz: 465c83896bfdecb2b6469916e9b1bc38ede0a250a8e065e51507318bc5819b21
+  data.tar.gz: 619861477867bfb5e5aee5e2321db250c5b7bd2b77e03a26f4794b44dcd3086d
 SHA512:
-  metadata.gz: 48d2ba7713e024656b49845ff1053b42076450e23367fb01063f1dce4ac3b74cd1a13351ddc43eac11e678052da76ac51508af1ba41b746e05a10cccc4c2ae4a
-  data.tar.gz: '08bd1115dcbb4240ed10edb7dbd52471c597cf5de98c85ef87be76dce9b4aef938cdc6b38ff8089c5ccfa3b684c887f75104e5ac5f9bc42eb8e3abe72e61a61c'
+  metadata.gz: 779d566f0deae14c83c6f6ed23dd0972ce1cb4c4835f789a5ac4e53f468c4074a5b39a0ba4751efe289a66c6a5f1eacce3cd8934d37c26d867c61c336ee7ac66
+  data.tar.gz: bad4460168d908f823e66e2c7419ccedfad511fdf77eb7a37652f5221ee8da0797ce3fde5ae4ce69dd6a9bbe7e138c038f8c91e98e561804a30c5ee6fc28e284

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+### Added
+
+- `Taro::Export::Base#write_to_file` for writing schema files without the rake task
+- `Taro.declarations.eager_load` for ensuring all declarations are loaded in Rails
+
 ## [3.0.0] - 2026-03-03
 
 ### Changed

data/lib/taro/declarations.rb

@@ -8,26 +8,31 @@ module Taro
       include Enumerable
 
       def [](key)
-        map[key]
+        data[key]
       end
 
       def []=(key, declaration)
-        map.key?(key) && raise(Taro::InvariantError, "#{key} already declared")
-        map[key] = declaration
+        data.key?(key) && raise(Taro::InvariantError, "#{key} already declared")
+        data[key] = declaration
       end
 
       def each(&)
-        map.each_value(&)
+        data.each_value(&)
       end
 
       def reset
-        map.clear
+        data.clear
+      end
+
+      def eager_load
+        ::Rails.application.eager_load! if defined?(::Rails.application.eager_load!)
+        self
       end
 
       private
 
-      def map
-        @map ||= {}
+      def data
+        @data ||= {}
       end
     end
   end

data/lib/taro/export/base.rb

@@ -1,10 +1,16 @@
 class Taro::Export::Base
   attr_reader :result
 
-  def self.call(declarations: Taro.declarations, title: Taro.config.api_name, version: Taro.config.api_version, **)
+  def self.call(declarations: Taro.declarations.eager_load, title: Taro.config.api_name, version: Taro.config.api_version, **)
     new.call(declarations:, title:, version:, **)
   end
 
+  def write_to_file(path: Taro.config.export_path, format: Taro.config.export_format)
+    data = __send__("to_#{format}") # e.g. to_json, to_yaml
+    FileUtils.mkdir_p(File.dirname(path))
+    File.write(path, data)
+  end
+
   def to_json(*)
     require 'json'
     JSON.pretty_generate(result)

data/lib/taro/rails/response_validator.rb

@@ -1,3 +1,6 @@
+# This runs on for every response,
+# so we are using Struct instead of Data here for performance reasons:
+# https://bugs.ruby-lang.org/issues/19693
 Taro::Rails::ResponseValidator = Struct.new(:controller, :declaration, :rendered) do
   def self.call(controller, declaration, rendered)
     new(controller, declaration, rendered).call

data/lib/taro/rails/tasks/export.rake

@@ -1,20 +1,7 @@
 desc 'Export all taro API declarations to a file'
 task 'taro:export' => :environment do
-  # make sure all declarations have been seen
-  Rails.application.eager_load!
+  Taro::Export::OpenAPIv3.call.write_to_file
 
-  title = Taro.config.api_name
-  version = Taro.config.api_version
-  format = Taro.config.export_format
-  path = Taro.config.export_path
-  # the generator / openapi version might become a config option later
-
-  export = Taro::Export::OpenAPIv3.call(title:, version:)
-
-  data = export.send("to_#{format}")
-
-  FileUtils.mkdir_p(File.dirname(path))
-  File.write(path, data)
-
-  puts "Exported the API #{title} v#{version} to #{path}"
+  puts "Exported the API #{Taro.config.api_name} " \
+       "v#{Taro.config.api_version} to #{Taro.config.export_path}"
 end

data/lib/taro/types/base_type.rb

@@ -7,7 +7,8 @@
 # The object is a parameter hash for inputs and a manually passed hash
 # or object when rendering a response.
 #
-# Using Struct instead of Data here for performance reasons:
+# The type initializer is a hot path for param parsing and response rendering,
+# so we are using Struct instead of Data here for performance reasons:
 # https://bugs.ruby-lang.org/issues/19693
 Taro::Types::BaseType = Struct.new(:object) do
   require_relative "shared"

data/lib/taro/version.rb

@@ -1,4 +1,4 @@
 # :nocov:
 module Taro
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taro
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Janosch Müller