dials 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 616a841d2067499823a017f9b83bf151c2a7df9128ac044154c37a473a275770
-  data.tar.gz: 6d32168d1c2c5bf45742db53b95d1eace0a145ec046e911a21eba1231660812b
+  metadata.gz: 8ecb8e740f9cf1218279b9936a938830e4bc8c34b34b6b9da0861a9d10f4d504
+  data.tar.gz: bcd05bebf177970aedcf90b6db780a9f05a425dc08941af6c3d099238ac3c9da
 SHA512:
-  metadata.gz: 149a10e661a7fc3ca2504d06f33e5c69294c9445373542d66970bb340e6313968170486c1d2184a927b7c08d223bbd20864474b4811c18272adb5b8cbe2459f4
-  data.tar.gz: 74f42bde26e31ed6c2f8ee2f0591c100d921d4282072718c5650237e59027a0981d7c3e454436047f20b6536fb241772c0ec37d93c02c1b52608fe4a73b53a87
+  metadata.gz: 10e8e549da42808d727bc565aeadd200df095d09123e88d3ea203997c63af5d4647e2a6dc6cf47eafd9647647553c39e5f7883a5a029c9de1b84bb28907eab84
+  data.tar.gz: 342ab64adb46a6759cb0e695f87d5c9f3c269a40f279a22d9d5eeb709bd0b91b07ec54eb2c127035ea3a9a43c44e61c79d2e329c0a52b2f516a9da721ad75187

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## [0.2.0] - 2026-09-04
+
+- **`config.table_name_prefix`.** Prefix the gem-owned table when `dials`
+  collides with an existing table — `config.table_name_prefix = "zar_"`
+  names it `zar_dials`. The prefix is used verbatim (trailing underscore
+  included), mirroring Rails' `table_name_prefix` convention. The install
+  generator takes the same prefix (`rails g dials:install
+  --table-name-prefix=zar_`) so the migration and initializer match.
+
 ## [0.1.0] - 2026-09-02
 
 Initial release.

data/lib/dials/active_record/models.rb

@@ -34,7 +34,11 @@ module Dials
     # "ke") as one stream — don't declare dimension enums that differ only
     # by case, or give the table a binary collation.
     class Entry < ::ActiveRecord::Base
-      self.table_name = "dials"
+      # Prefixable via Dials.configure { |c| c.table_name_prefix = "zar_" }
+      # for apps where "dials" collides with an existing table (see
+      # Config#table_name_prefix).
+      DEFAULT_TABLE_NAME = "dials"
+      self.table_name = DEFAULT_TABLE_NAME
 
       validates :key, :scope, :seq, presence: true
       validates :action, presence: true, inclusion: { in: %w[set clear] }

data/lib/dials/config.rb

@@ -19,11 +19,27 @@ module Dials
     # and an explicit actor: always wins.
     attr_accessor :default_actor
 
+    # Prefix for the gem-owned table, mirroring Rails' table_name_prefix
+    # convention: used verbatim, so include the trailing underscore
+    # ("ops_" makes the table "ops_dials"). nil (the default) keeps "dials".
+    # Set it when "dials" collides with an existing table, and pass the same
+    # prefix to the install generator (--table-name-prefix) so the migration
+    # matches.
+    attr_reader :table_name_prefix
+
     def initialize
       @store = nil
       @cache_ttl = 5.0
       @actor_label = Actor::DEFAULT_LABEL
       @default_actor = nil
+      @table_name_prefix = nil
+    end
+
+    # Order-independent with store=: whichever runs second applies the name.
+    def table_name_prefix=(prefix)
+      @table_name_prefix = prefix
+      apply_table_name
+      Dials.reset_cache!
     end
 
     def cache_ttl=(seconds)
@@ -37,6 +53,7 @@ module Dials
                when :memory then Stores::Memory.new
                when :active_record
                  require "dials/active_record"
+                 apply_table_name
                  Stores::ActiveRecordStore.new
                else store
                end
@@ -46,5 +63,14 @@ module Dials
     def store
       @store ||= Stores::Memory.new
     end
+
+    private
+
+    def apply_table_name
+      return unless defined?(Dials::ActiveRecord::Entry)
+
+      Dials::ActiveRecord::Entry.table_name =
+        "#{@table_name_prefix}#{Dials::ActiveRecord::Entry::DEFAULT_TABLE_NAME}"
+    end
   end
 end

data/lib/dials/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dials
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/generators/dials/install/install_generator.rb

@@ -7,15 +7,20 @@ module Dials
   module Generators
     # `bin/rails generate dials:install`
     #
-    # Creates the migration for the three gem-owned tables and an initializer
-    # with a commented starter registry.
+    # Creates the migration for the gem-owned table and an initializer with
+    # a commented starter registry. --table-name-prefix prefixes the table
+    # (Rails table_name_prefix convention, trailing underscore included) for
+    # apps where "dials" collides with an existing one.
     class InstallGenerator < Rails::Generators::Base
       include ::ActiveRecord::Generators::Migration
 
       source_root File.expand_path("templates", __dir__)
 
+      class_option :table_name_prefix, type: :string, default: "",
+                   desc: 'Prefix for the gem-owned table, used verbatim ("zar_" creates zar_dials)'
+
       def create_migration_file
-        migration_template "migration.rb.tt", "db/migrate/create_dials_tables.rb"
+        migration_template "migration.rb.tt", "db/migrate/create_#{table_name}_table.rb"
       end
 
       def create_initializer
@@ -34,6 +39,12 @@ module Dials
 
         TEXT
       end
+
+      private
+
+      def table_name
+        "#{options[:table_name_prefix]}dials"
+      end
     end
   end
 end

data/lib/generators/dials/install/templates/initializer.rb.tt

@@ -3,11 +3,22 @@
 require "dials/active_record"
 
 Dials.configure do |config|
-  # Where values live. :active_record uses the tables created by
+  # Where values live. :active_record uses the table created by
   # `rails g dials:install`; :memory keeps everything in-process (handy in
   # test environments that never exercise persistence).
   config.store = :active_record
 
+<% if options[:table_name_prefix].empty? -%>
+  # Prefix the gem-owned table when "dials" collides with an existing one.
+  # Used verbatim, so include the trailing underscore. Must match the
+  # migration (`rails g dials:install --table-name-prefix=zar_`).
+  # config.table_name_prefix = "zar_"
+<% else -%>
+  # Names the gem-owned table <%= table_name %>, as created by the install
+  # migration.
+  config.table_name_prefix = "<%= options[:table_name_prefix] %>"
+<% end -%>
+
   # Seconds between cache staleness probes (one cheap query per process per
   # interval). 0 probes on every read; nil never probes.
   # config.cache_ttl = 5.0

data/lib/generators/dials/install/templates/migration.rb.tt

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class CreateDialsTables < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+class Create<%= table_name.camelize %>Table < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def change
     # The gem's ONE table, append-only: every write INSERTs a row, and the
     # newest row per (key, scope) stream is the current override — action
@@ -22,7 +22,7 @@ class CreateDialsTables < ActiveRecord::Migration[<%= ActiveRecord::Migration.cu
     # a binary collation there. PostgreSQL and SQLite compare bytes already.
     identity_collation = ("utf8mb4_bin" if connection.adapter_name.match?(/mysql/i))
 
-    create_table :dials do |t|
+    create_table :<%= table_name %> do |t|
       t.string :key, null: false, limit: 100, collation: identity_collation
       t.string :scope, null: false, limit: 255, collation: identity_collation
       t.bigint :seq, null: false
@@ -33,7 +33,7 @@ class CreateDialsTables < ActiveRecord::Migration[<%= ActiveRecord::Migration.cu
       t.string :actor_label
       t.datetime :created_at, null: false
     end
-    add_index :dials, [:key, :scope, :seq], unique: true
-    add_index :dials, :key
+    add_index :<%= table_name %>, [:key, :scope, :seq], unique: true
+    add_index :<%= table_name %>, :key
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dials
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Keith Gould