tarantool-rails 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 824fd7e958e18a4576a55a510ae6713557bb7d0e6a36ce202f18d72785eb18ef
-  data.tar.gz: e33adb1ed56190a0d11f32c1994a71f2e247c2548e30bb594344b581794f03ba
+  metadata.gz: 30e777d2be6062e333e01fa5ab1e50fc2ccab417e19ae4513dddf8a5b8f2bd8f
+  data.tar.gz: 72c8fdfd334c5d3da9b62313e90e92650e7b045596d57409aff7a02e2dff8c85
 SHA512:
-  metadata.gz: cd86cbe614985b58a745dfa2807df813e8b1eb95f7ea0a044f26f0a539577c15dac3cbeffa33bcec5774c31583a9a324a7706fbbb72ba16392a4c7e46088bd2f
-  data.tar.gz: 5afa1af094609b0ed6f6637b7a1aa08dbe6afcf8b9ae3cda57031ad0f4a3565bb23ff204e37c5e9f779366cc916fdcb83025f8dec3de43501eda8b9ae5f90451
+  metadata.gz: 10cd6a546bb3298f10b39a44a3fec2f79189c300e9152e0a1eaad79f9350e868b0d84caae77e77e222f2f03cc989070674cbde5b61c45a023b70cf1679636f72
+  data.tar.gz: 38f7446ec5667c71a8717e84bf4b77b2763288d8f011be423867796a982e85844651ad10296961644e8a0df7716c443b09aba827da452aa652110a1b77bed59e

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.3.0 (2026-10-18)
+
+- `config.tarantool.instrumenter` replaces `ActiveSupport::Notifications` as the pool instrumenter, for chaining
+  tarantool-opentelemetry.
+- Depends on `tarantool-client ~> 0.3` and `tarantool-schema ~> 0.3`; `tarantool:schema:apply` grants what the schema declares.
+- The schema rake tasks no longer define helper methods and a constant on `Object`.
+
+## 0.2.0 (2026-10-17)
+
+- `tarantool:schema:dump` writes the live schema to `config/tarantool_schema.rb` (`FORCE=1` to overwrite,
+  `dump[users,codes]` to limit the spaces).
+- `plan`, `apply` and `check` take `alter` names as a task argument: `"tarantool:schema:apply[add_field]"`.
+- `LogSubscriber` logs `shutdown.tarantool` (tarantool-client 0.3.0) at info.
+- Depends on `tarantool-schema ~> 0.2`.
+
 ## 0.1.0 (2026-10-17)
 
 First release.

data/README.md

@@ -67,6 +67,14 @@ can run; the first model operation then raises `Tarantool::Rails::Error`.
   password).
 - `Tarantool::Rails.pool` is one `Tarantool::Client::Pool` per process, built on first use with
   `instrumenter: ActiveSupport::Notifications`. After `fork` the pool reopens its connections on its own.
+  `config.tarantool.instrumenter` replaces the instrumenter; the log subscriber still needs the events on
+  `ActiveSupport::Notifications`, so chain it:
+
+  ```ruby
+  # config/initializers/tarantool.rb
+  Rails.application.config.tarantool.instrumenter =
+    Tarantool::OpenTelemetry::Instrumenter.new(instrumenter: ActiveSupport::Notifications)
+  ```
 - `Tarantool::Rails.storage` is a `Storage::Box` (or `Storage::Crud`) over the pool, and
   `Tarantool::Model.default_storage` is set so every model without a storage of its own uses it. Nothing
   connects until a model is used.
@@ -101,7 +109,7 @@ Completed 200 OK in 4ms (Views: 1.9ms | Tarantool: 0.5ms)
 Request lines are debug, colored like ActiveRecord's when `colorize_logging` is on. Keys, tuples and
 arguments never appear: the client does not put them in the event payload. A failed request shows the error
 class and code, not the message. Lifecycle events are logged too: `disconnect` at warn, `reconnect_failed` at
-error, `reconnect`, `fork` and `role_change` at info.
+error, `reconnect`, `fork`, `role_change` and `shutdown` at info.
 
 ## Schema
 
@@ -118,10 +126,14 @@ end
 | Task | |
 |---|---|
 | `rails tarantool:schema:plan` | prints what `apply` would create; drift raises `MismatchError` with the diff |
-| `rails tarantool:schema:apply` | creates the missing spaces and indexes and prints them; never alters or drops |
+| `rails tarantool:schema:apply` | creates the missing spaces, indexes and grants and prints them; never drops |
 | `rails tarantool:schema:check` | for CI: exits 1 and prints `pending: ...` when anything would be created, 0 when live equals declared |
+| `rails tarantool:schema:dump` | writes the live schema to `config/tarantool_schema.rb` for bootstrapping; refuses to overwrite unless `FORCE=1`; `dump[users,codes]` limits the spaces |
 
-The tasks connect with `admin_uri`; see the tarantool-schema README for the privileges that user needs.
+`plan`, `apply` and `check` take the tarantool-schema `alter:` names as an argument: `rails
+"tarantool:schema:apply[add_field]"` appends nullable fields declared past the end of a live format. Without it
+such a format is drift. The tasks connect with `admin_uri`; see the tarantool-schema README for the privileges
+that user needs.
 
 ## Generators
 
@@ -197,6 +209,8 @@ gem must be in the Gemfile.
 `Tarantool::Rails::Configuration`, `Tarantool::Rails::LogSubscriber`, `Tarantool::Rails::Error`
 (descends from `Tarantool::Error`), the rake tasks and the generators.
 
+RBS signatures for this API ship with the gem in `sig/`.
+
 Everything else, including anything tagged `@api private` in its source comment, is an implementation detail
 and may change in any release.
 

data/lib/generators/tarantool/install/templates/tarantool_schema.rb

@@ -5,4 +5,5 @@ Tarantool::Rails.schema = Tarantool::Schema::Definition.new do
   # ensure_space :users,
   #              format: [{ name: :id, type: :unsigned }, { name: :email, type: :string }],
   #              indexes: [{ name: :primary, parts: [:id], sequence: true }, { name: :email, parts: [:email] }]
+  # grant :app, %i[read write], on: :users
 end

data/lib/generators/tarantool/model/model_generator.rb

@@ -22,6 +22,8 @@ module Tarantool
       }.freeze
       ID = Field.new(name: 'id', attribute_type: ':integer', field_type: 'unsigned', nullable: false)
       SCHEMA_PATH = 'config/tarantool_schema.rb'
+      SCHEMA_END = /^end\s*\z/
+      LINE_START = /^/
 
       source_root File.expand_path('templates', __dir__)
 
@@ -40,7 +42,7 @@ module Tarantool
       def add_space_to_schema
         return if options[:skip_schema] || !File.exist?(File.join(destination_root, SCHEMA_PATH))
 
-        inject_into_file SCHEMA_PATH, space_declaration, before: /^end\s*\z/
+        inject_into_file SCHEMA_PATH, space_declaration, before: SCHEMA_END
       end
 
       private
@@ -70,7 +72,7 @@ module Tarantool
                  '             ],', '             indexes: [',
                  "               { name: :primary, parts: [:#{model_fields.first.name}]#{sequence} }", '             ]']
 
-        "\n#{lines.join("\n").gsub(/^/, '  ')}\n"
+        "\n#{lines.join("\n").gsub(LINE_START, '  ')}\n"
       end
     end
   end

data/lib/tarantool/rails/configuration.rb

@@ -17,7 +17,7 @@ module Tarantool
       def filtered(key, value)
         case key
         when :client_options then value.key?(:password) ? value.merge(password: '[FILTERED]') : value
-        when :admin_uri then value&.sub(%r{:[^:@/]*@}, ':[FILTERED]@')
+        when :admin_uri then value&.sub(Configuration::URI_PASSWORD, ':[FILTERED]@')
         else value
         end
       end
@@ -30,6 +30,7 @@ module Tarantool
       KEYS = (CLIENT_KEYS + %i[addresses address read write storage crud admin_uri]).freeze
       CRUD_KEYS = %i[primary_index read write timeout_margin].freeze
       STORAGES = %i[box crud].freeze
+      URI_PASSWORD = %r{:[^:@/]*@}
 
       class << self
         def from_hash(hash)

data/lib/tarantool/rails/log_subscriber.rb

@@ -57,6 +57,10 @@ module Tarantool
         info "Tarantool #{event.payload[:address]} is now #{event.payload[:read_only] ? 'read-only' : 'writable'}"
       end
 
+      def shutdown(event)
+        info "Tarantool #{event.payload[:address]} is shutting down, #{event.payload[:pending]} requests in flight"
+      end
+
       private
 
       def request_name(payload)

data/lib/tarantool/rails/railtie.rb

@@ -10,6 +10,7 @@ module Tarantool
       # A missing config/tarantool.yml is not an error at boot: the install generator has to be able to run.
       initializer 'tarantool.configuration' do |app|
         Tarantool::Rails.schema_path = app.config.tarantool.schema_path || app.root.join('config/tarantool_schema.rb')
+        Tarantool::Rails.instrumenter = app.config.tarantool.instrumenter
         next unless app.root.join('config/tarantool.yml').exist?
 
         section = app.config_for(:tarantool)

data/lib/tarantool/rails/schema_tasks.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Tarantool
+  module Rails
+    # Helpers behind the tarantool:schema rake tasks.
+    # @api private
+    module SchemaTasks
+      # Task arguments are one String: rails "tarantool:schema:apply[add_field]", "tarantool:schema:dump[users,codes]".
+      NAME_SEPARATOR = /[\s,]+/
+
+      module_function
+
+      def names(argument) = argument.to_s.split(NAME_SEPARATOR).reject(&:empty?)
+
+      def dump(path, only)
+        abort "#{path} exists; set FORCE=1 to overwrite" if File.exist?(path) && ENV['FORCE'].to_s.empty?
+
+        definition = Tarantool::Rails.admin_client do |client|
+          Tarantool::Schema::Definition.from_live(client, only: only.empty? ? nil : only)
+        end
+        File.write(path, "# frozen_string_literal: true\n\nTarantool::Rails.schema = #{definition.to_ruby}")
+        puts path
+      end
+    end
+  end
+end

data/lib/tarantool/rails/tasks/schema.rake

@@ -3,22 +3,31 @@
 namespace :tarantool do
   namespace :schema do
     desc 'Print what tarantool:schema:apply would create; fail on drift'
-    task plan: :environment do
-      Tarantool::Rails.admin_client { |client| puts Tarantool::Rails.schema.plan(client) }
+    task :plan, [:alter] => :environment do |_task, args|
+      alter = Tarantool::Rails::SchemaTasks.names(args[:alter]).map(&:to_sym)
+      Tarantool::Rails.admin_client { |client| puts Tarantool::Rails.schema.plan(client, alter:) }
     end
 
     desc 'Create missing Tarantool spaces and indexes; fail on drift'
-    task apply: :environment do
-      Tarantool::Rails.admin_client { |client| puts Tarantool::Rails.schema.apply(client) }
+    task :apply, [:alter] => :environment do |_task, args|
+      alter = Tarantool::Rails::SchemaTasks.names(args[:alter]).map(&:to_sym)
+      Tarantool::Rails.admin_client { |client| puts Tarantool::Rails.schema.apply(client, alter:) }
     end
 
     desc 'Fail unless the live schema equals the declaration, for CI'
-    task check: :environment do
-      pending = Tarantool::Rails.admin_client { |client| Tarantool::Rails.schema.plan(client) }
+    task :check, [:alter] => :environment do |_task, args|
+      alter = Tarantool::Rails::SchemaTasks.names(args[:alter]).map(&:to_sym)
+      pending = Tarantool::Rails.admin_client { |client| Tarantool::Rails.schema.plan(client, alter:) }
       next if pending.empty?
 
       pending.each { |line| puts "pending: #{line}" }
       exit 1
     end
+
+    desc 'Write the live schema to config/tarantool_schema.rb (FORCE=1 to overwrite; spaces as [users,codes])'
+    task :dump, [:only] => :environment do |_task, args|
+      Tarantool::Rails::SchemaTasks.dump(Tarantool::Rails.schema_path.to_s,
+                                         Tarantool::Rails::SchemaTasks.names(args[:only]))
+    end
   end
 end

data/lib/tarantool/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Tarantool
   module Rails
-    VERSION = '0.1.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/tarantool/rails.rb

@@ -10,6 +10,7 @@ require_relative 'rails/errors'
 require_relative 'rails/configuration'
 require_relative 'rails/log_subscriber'
 require_relative 'rails/controller_runtime'
+require_relative 'rails/schema_tasks'
 require_relative 'rails/railtie' if defined?(Rails::Railtie)
 
 module Tarantool
@@ -21,7 +22,13 @@ module Tarantool
 
     class << self
       attr_accessor :config, :schema_path
-      attr_writer :schema
+      attr_writer :schema, :instrumenter
+
+      # What the pool reports requests to; the log subscriber listens to ActiveSupport::Notifications, so an
+      # instrumenter of your own should chain it (tarantool-opentelemetry's does with `instrumenter:`).
+      def instrumenter
+        @instrumenter || ActiveSupport::Notifications
+      end
 
       def pool
         LOCK.synchronize { @pool ||= build_pool }
@@ -69,8 +76,7 @@ module Tarantool
       end
 
       def build_pool
-        Tarantool::Client::Pool.new(configured.addresses, **configured.client_options,
-                                                          instrumenter: ActiveSupport::Notifications)
+        Tarantool::Client::Pool.new(configured.addresses, **configured.client_options, instrumenter:)
       end
 
       def build_storage

data/sig/tarantool/rails.rbs

@@ -0,0 +1,59 @@
+module Tarantool
+  # Rails integration: configuration from config/tarantool.yml, one Pool per process, models on it, log lines,
+  # schema rake tasks and generators.
+  module Rails
+    VERSION: String
+
+    def self.config: () -> Configuration?
+    def self.config=: (Configuration? config) -> void
+    def self.schema_path: () -> (String | Pathname)?
+    def self.schema_path=: ((String | Pathname)? path) -> void
+    # Loaded from schema_path on first use; the file assigns it.
+    def self.schema: () -> Tarantool::Schema::Definition
+    def self.schema=: (Tarantool::Schema::Definition? schema) -> void
+    # ActiveSupport::Notifications unless configured.
+    def self.instrumenter: () -> Tarantool::Client::_Instrumenter
+    def self.instrumenter=: (Tarantool::Client::_Instrumenter? instrumenter) -> void
+    def self.pool: () -> Tarantool::Client::Pool
+    def self.storage: () -> (Tarantool::Model::Storage::Box | Tarantool::Model::Storage::Crud)
+    def self.admin_client: [T] () { (Tarantool::Client client) -> T } -> T
+    def self.use_default_storage!: () -> void
+    def self.disconnect!: () -> void
+
+    class Error < Tarantool::Error
+    end
+
+    # One environment section of config/tarantool.yml; inspect and to_s hide the password.
+    class Configuration < Data
+      attr_reader addresses: Array[String]
+      attr_reader client_options: Hash[Symbol, untyped]
+      attr_reader storage: :box | :crud
+      attr_reader read: Hash[Symbol, untyped]
+      attr_reader write: Hash[Symbol, untyped]
+      attr_reader crud: Hash[Symbol, untyped]
+      attr_reader admin_uri: String?
+
+      # The Hash config_for returns (an ActiveSupport::OrderedOptions is a Hash); unknown keys raise ArgumentError.
+      def self.from_hash: (Hash[Symbol | String, untyped] hash) -> Configuration
+      def inspect: () -> String
+      def to_s: () -> String
+    end
+
+    # ActiveRecord-style log lines for the client's events (an ActiveSupport::LogSubscriber); the time spent in
+    # requests is accumulated per thread for the controller log.
+    class LogSubscriber
+      def self.runtime: () -> Float
+      def self.runtime=: (Float value) -> void
+      def self.reset_runtime: () -> Float
+
+      # Each takes an ActiveSupport::Notifications::Event.
+      def request: (untyped event) -> void
+      def disconnect: (untyped event) -> void
+      def reconnect: (untyped event) -> void
+      def reconnect_failed: (untyped event) -> void
+      def fork: (untyped event) -> void
+      def role_change: (untyped event) -> void
+      def shutdown: (untyped event) -> void
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tarantool-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Starlexxx
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-17 00:00:00.000000000 Z
+date: 2026-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: tarantool-model
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.3'
 description: config/tarantool.yml per environment, one connection pool per process,
   models on it without an initializer, ActiveRecord-style log lines, schema rake tasks
   and generators.
@@ -95,8 +95,10 @@ files:
 - lib/tarantool/rails/errors.rb
 - lib/tarantool/rails/log_subscriber.rb
 - lib/tarantool/rails/railtie.rb
+- lib/tarantool/rails/schema_tasks.rb
 - lib/tarantool/rails/tasks/schema.rake
 - lib/tarantool/rails/version.rb
+- sig/tarantool/rails.rbs
 homepage: https://github.com/Starlexxx/tarantool-ruby
 licenses:
 - MIT