beamer-rails 0.1.0.beta4-x86_64-linux-gnu

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe6a0ee1fbe85423c69148ec557c4ec8a4712455da8b10e9107ccfeb2c1beba7
+  data.tar.gz: b44a3730c6b840e666c65088a7d6a1d2dc47fcc496303fd46730833e8b27291b
+SHA512:
+  metadata.gz: 1ca61775b19b1a1a9ad32d6372468374c1bd11e64691f891a7c8ac52a1582a0c5b5e31b97165afc126c747c047541f2731e705e30db850c545ac79bec8663b36
+  data.tar.gz: 631067e86bc219b5013ec8cb401356cefeb33f4f8fc85e2be84a86b2a89045812c67d97d6df353f12c40634d8dd49a5272e0582164cccccaeb8d2859add48392

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Kevin McConnell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/exe/beamer

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/beamer"
+
+executable = File.join(Beamer.exe_dir, "beamer")
+
+if File.exist?(executable)
+  exec(executable, *ARGV)
+else
+  STDERR.puts("ERROR: Unsupported platform: #{Beamer.platform}")
+  exit 1
+end

data/lib/beamer/connection_adapter.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "active_record/connection_adapters/sqlite3_adapter"
+
+# ActiveRecord database adapter for Beamer-replicated SQLite databases.
+#
+# This adapter extends the standard SQLite3Adapter to automatically configure
+# databases for Beamer replication. It loads the Beamer VFS extension and
+# ensures the database connection uses it.
+#
+# @example database.yml configuration
+#   production:
+#     adapter: beamer
+#     database: storage/production.sqlite3
+#
+# @api private
+class Beamer::ConnectionAdapter < ActiveRecord::ConnectionAdapters::SQLite3Adapter
+  ADAPTER_NAME = "Beamer"
+  BOOLEAN = ActiveRecord::Type::Boolean.new
+
+  # Initialize a new Beamer database connection.
+  #
+  # This loads the Beamer VFS extension, validates that the database is not
+  # in-memory, and configures the connection to use the Beamer VFS.
+  #
+  # @raise [Beamer::UnsupportedDatabaseType] if attempting to use an in-memory database
+  # @raise [Beamer::UnsupportedPlatform] if the Beamer extension is not available
+  def initialize(...)
+    Beamer.load
+
+    super
+
+    if @memory_database
+      raise Beamer::UnsupportedDatabaseType, "Beamer isn't compatible with in-memory databases"
+    end
+
+    configure_beamer(@connection_parameters)
+  end
+
+  def beamer_primary?
+    BOOLEAN.cast(execute_pragma("beamer_is_primary")) if beamer_primary
+  rescue ActiveRecord::StatementInvalid
+    nil
+  end
+
+  def beamer_primary
+    execute_pragma("beamer_primary").presence
+  rescue ActiveRecord::StatementInvalid
+    nil
+  end
+
+  def beamer_last_txn
+    execute_pragma("beamer_last_txn").presence
+  rescue ActiveRecord::StatementInvalid
+    nil
+  end
+
+  def beamer_zone
+    execute_pragma("beamer_zone").presence
+  end
+
+  def beamer_zone=(desired_zone)
+    execute_pragma("beamer_zone = #{quote(desired_zone)}").tap do |new_zone|
+      if new_zone != desired_zone
+        raise Beamer::ZoneChangeError, "Failed to set Beamer zone to #{desired_zone.inspect}"
+      end
+    end
+  end
+
+  private
+    def configure_beamer(config)
+      inject_vfs(config)
+    end
+
+    def inject_vfs(config)
+      if config[:database].blank?
+      end
+
+      database, query_string = config[:database].split("?", 2)
+      attributes = query_string ? CGI.parse(query_string) : {}
+
+      attributes["vfs"] = "beamer"
+      database = "file:#{database}" unless database.start_with?("file:")
+
+      config[:database] = "#{database}?#{URI.encode_www_form(attributes)}"
+    end
+
+    def execute_pragma(pragma)
+      execute("PRAGMA #{pragma}").first&.values&.first
+    end
+end

data/lib/beamer/railtie.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# Rails integration for Beamer.
+#
+# This Railtie automatically registers the Beamer database adapter with ActiveRecord
+# during Rails initialization, allowing you to use `adapter: beamer` in database.yml.
+#
+# @example database.yml configuration
+#   production:
+#     adapter: beamer
+#     database: storage/production.sqlite3
+#
+# @api private
+class Beamer::Railtie < ::Rails::Railtie
+  # Register the Beamer adapter before Rails configuration is loaded.
+  # This ensures the adapter is available when database.yml is parsed.
+  config.before_configuration do
+    ActiveRecord::ConnectionAdapters.register("beamer", "Beamer::ConnectionAdapter", "beamer/connection_adapter")
+    ActiveRecord::Tasks::DatabaseTasks.register_task(/beamer/, "ActiveRecord::Tasks::SQLiteDatabaseTasks")
+
+    if defined?(ActiveRecord::Tenanted)
+      require "beamer/tenanted_database_adapter"
+      ActiveRecord::Tenanted::DatabaseAdapter.register("beamer", "Beamer::TenantedDatabaseAdapter")
+    end
+  end
+end

data/lib/beamer/tenanted_database_adapter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "active_record/tenanted/database_adapters/sqlite"
+
+# Database adapter for ActiveRecord::Tenanted that enables Beamer replication
+# for tenanted databases.
+#
+# This adapter extends the standard SQLite tenanted adapter with Beamer's VFS,
+# allowing each tenant database to have its own replication state and benefit
+# from Beamer's replication capabilities.
+#
+# The adapter is automatically registered when ActiveRecord::Tenanted is detected
+# during Rails initialization (see Beamer::Railtie).
+#
+# @example Creating a tenanted database with Beamer
+#   # With adapter: beamer in database.yml
+#   ActiveRecord::Tenanted.create_tenant("tenant-1")
+#   # Creates a database using Beamer VFS with its own .beamer directory
+#
+# @see https://github.com/basecamp/activerecord-tenanted
+# @api private
+class Beamer::TenantedDatabaseAdapter < ActiveRecord::Tenanted::DatabaseAdapters::SQLite
+end

data/lib/beamer/version.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Beamer
+  VERSION = "0.1.0.beta4"
+
+  NATIVE_PLATFORMS = {
+    "arm-linux-gnu" => "../../release/arm-linux-gnu",
+    "arm-linux-musl" => "../../release/arm-linux-musl",
+    "arm64-darwin" => "../../release/arm64-darwin",
+    "arm64-linux-gnu" => "../../release/aarch64-linux-gnu",
+    "arm64-linux-musl" => "../../release/aarch64-linux-musl",
+    "x86_64-darwin" => "../../release/x86_64-darwin",
+    "x86_64-linux-gnu" => "../../release/x86_64-linux-gnu",
+    "x86_64-linux-musl" => "../../release/x86_64-linux-musl"
+  }
+end

data/lib/beamer-rails.rb

@@ -0,0 +1 @@
+require_relative "./beamer"

data/lib/beamer.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "sqlite3"
+require "rubygems"
+
+require_relative "beamer/version"
+require_relative "beamer/railtie" if defined?(Rails)
+
+module Beamer
+  GEM_NAME = "beamer-rails"
+
+  autoload :ConnectionAdapter, "beamer/connection_adapter"
+
+  # Base exception class for the library.
+  class Error < StandardError; end
+
+  # Raised when the SQLite extension isn't packaged for the current OS, processor and ABI.
+  class UnsupportedPlatform < Error; end
+
+  # Raised when attempting to use Beamer to replicate an unsupported type of database.
+  class UnsupportedDatabaseType < Error; end
+
+  # Raised when a zone change operation fails.
+  class ZoneChangeError < Error; end
+
+  class << self
+    # Loads the Beamer SQLite extension for the current process.
+    #
+    # This registers the Beamer VFS globally with SQLite, enabling all subsequent
+    # database connections to use it. The VFS provides SQLite replication functionality.
+    #
+    # @return [SQLite3::Database] A temporary in-memory database used to load the extension
+    # @raise [UnsupportedPlatform] if the current platform doesn't have a precompiled extension
+    #
+    # @example
+    #   Beamer.load
+    #
+    # @note This is called automatically when using `adapter: beamer` in database.yml.
+    #   You typically don't need to call this manually if you are using Rails.
+    def load
+      if extension_path
+        SQLite3::Database.new(":memory:").tap do |db|
+          db.enable_load_extension(true)
+          db.load_extension(extension_path)
+        end
+      else
+        raise UnsupportedPlatform, "Unsupported platform: #{platform}"
+      end
+
+      true
+    end
+
+    # Returns the file system path to the Beamer SQLite extension for the current platform.
+    #
+    # @return [String, nil] Path to beamer extension, or nil if not found
+    #
+    # @example
+    #   Beamer.extension_path
+    #   # => "/path/to/gem/exe/x86_64-linux-gnu/beamer.so"
+    def extension_path
+      exe_path = "#{exe_dir}/beamer.so"
+
+      if File.exist?(exe_path)
+        exe_path
+      else
+        nil
+      end
+    end
+
+    # Returns the directory containing platform-specific executables and extensions.
+    #
+    # @return [String] Absolute path to the exe directory for the current platform
+    #
+    # @example
+    #   Beamer.exe_dir
+    #   # => "/path/to/gem/exe/x86_64-linux-gnu"
+    def exe_dir
+      File.expand_path("../../exe/#{platform}", __FILE__)
+    end
+
+    # Returns the normalized platform string for the current system.
+    #
+    # This method normalizes platform identifiers to match RubyGems conventions,
+    # adding the `-gnu` suffix to glibc-based Linux platforms.
+    #
+    # @return [String] Platform identifier (e.g., "x86_64-linux-gnu", "arm64-darwin")
+    #
+    # @example
+    #   Beamer.platform
+    #   # => "x86_64-linux-gnu" (on Ubuntu/Debian)
+    #   # => "x86_64-linux-musl" (on Alpine Linux)
+    #   # => "arm64-darwin" (on Apple Silicon Mac)
+    def platform
+      Beamer::NATIVE_PLATFORMS.keys.find { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), GEM_NAME) } ||
+        raise(UnsupportedPlatform, "Can not find a matching platform for: #{Gem::Platform.local}")
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: beamer-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta4
+platform: x86_64-linux-gnu
+authors:
+- Kevin McConnell
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+email:
+- kevin@37signals.com
+executables:
+- beamer
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- exe/beamer
+- exe/x86_64-linux-gnu/beamer
+- exe/x86_64-linux-gnu/beamer.so
+- lib/beamer-rails.rb
+- lib/beamer.rb
+- lib/beamer/connection_adapter.rb
+- lib/beamer/railtie.rb
+- lib/beamer/tenanted_database_adapter.rb
+- lib/beamer/version.rb
+homepage: https://github.com/basecamp/beamer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/basecamp/beamer
+  source_code_uri: https://github.com/basecamp/beamer
+  rubygems_mfa_required: 'true'
+  github_repo: ssh://github.com/basecamp/beamer
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Beamer SQLite replication for Rails
+test_files: []