activerecord-enhancedsqlite3-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f3c0a5d2a1ceae77db506215c35aa217521e43d152a1ca312e7b2f52887b803
+  data.tar.gz: c5d6f2ac4e34b9181ac7dc6417176fbd5b5dfd5d20376ba6b91731faca73093a
+SHA512:
+  metadata.gz: c26a1f83ede20d480687b01a8d1ab39b7d5c854e16fe7d3c3a6c5c984bd23812f3c5d40c531c3a964e032bc0dba1bc33f8de43a3d85c3b4eade0bd30a251f091
+  data.tar.gz: fdf1d73eaa883f932f0cbb5cb6c4defc6addcfbbf4a8059a634a08f0b773a7b854b1e85c719e2b978a5708c1263dec3901a6c7d6e289eabe8421fdbdfc55bdb6

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-28
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Stephen Margheim
+
+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/README.md

@@ -0,0 +1,35 @@
+# Activerecord::Enhanced::Sqlite3::Adapter
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/activerecord/enhanced/sqlite3/adapter`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/activerecord-enhancedsqlite3-adapter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/activerecord-enhancedsqlite3-adapter.rb

@@ -0,0 +1,3 @@
+require "active_record"
+require "enhanced_sqlite3/version"
+require "enhanced_sqlite3/railtie"

data/lib/enhanced_sqlite3/adapter.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# supports concatenation in default functions: https://github.com/rails/rails/pull/49287
+# supports insert returning values: https://github.com/rails/rails/pull/49290
+# supports configuring busy_handler: https://github.com/rails/rails/pull/49352
+
+require "active_record/connection_adapters/sqlite3_adapter"
+require "enhanced_sqlite3/supports_virtual_columns"
+
+module EnhancedSQLite3
+  module Adapter
+    # Perform any necessary initialization upon the newly-established
+    # @raw_connection -- this is the place to modify the adapter's
+    # connection settings, run queries to configure any application-global
+    # "session" variables, etc.
+    #
+    # Implementations may assume this method will only be called while
+    # holding @lock (or from #initialize).
+    #
+    # extends https://github.com/rails/rails/blob/main/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb#L691
+    def configure_connection
+      configure_busy_handler
+
+      super
+
+      configure_pragmas
+      configure_extensions
+
+      EnhancedSQLite3::SupportsVirtualColumns.apply!
+    end
+
+    private
+
+    def configure_busy_handler
+      if @config[:timeout] && @config[:retries]
+        raise ArgumentError, "Cannot specify both timeout and retries arguments"
+      elsif @config[:retries]
+        # see: https://www.sqlite.org/c3ref/busy_handler.html
+        @raw_connection.busy_handler do |count|
+          count <= @config[:retries]
+        end
+      end
+    end
+
+    def configure_pragmas
+      @config.fetch(:pragmas, []).each do |key, value|
+        execute("PRAGMA #{key} = #{value}", "SCHEMA")
+      end
+    end
+
+    def configure_extensions
+      @raw_connection.enable_load_extension(true)
+      @config.fetch(:extensions, []).each do |extension_name|
+        require extension_name
+        extension_classname = extension_name.camelize
+        extension_class = extension_classname.constantize
+        extension_class.load(@raw_connection)
+      rescue LoadError
+        Rails.logger.error("Failed to find the SQLite extension gem: #{extension_name}. Skipping...")
+      rescue NameError
+        Rails.logger.error("Failed to find the SQLite extension class: #{extension_classname}. Skipping...")
+      end
+      @raw_connection.enable_load_extension(false)
+    end
+  end
+end

data/lib/enhanced_sqlite3/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "enhanced_sqlite3/adapter"
+
+module EnhancedSQLite3
+  class Railtie < ::Rails::Railtie
+    # Enhance the SQLite3 ActiveRecord adapter with optimized defaults
+    initializer "enhanced_sqlite3.enhance_active_record_sqlite3adapter" do |app|
+      ActiveSupport.on_load(:active_record_sqlite3adapter) do
+        # self refers to `SQLite3Adapter` here,
+        # so we can call .prepend
+        prepend EnhancedSQLite3::Adapter
+      end
+    end
+  end
+end

data/lib/enhanced_sqlite3/supports_virtual_columns.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+# see: https://github.com/rails/rails/pull/49346
+module EnhancedSQLite3
+  module SupportsVirtualColumns
+    def self.apply!
+      EnhancedSQLite3::Adapter.include(Adapter)
+      ActiveRecord::ConnectionAdapters::SQLite3::Column.include(Column)
+      ActiveRecord::ConnectionAdapters::SQLite3::SchemaCreation.include(SchemaCreation)
+      ActiveRecord::ConnectionAdapters::SQLite3::TableDefinition.include(TableDefinition)
+      ActiveRecord::ConnectionAdapters::SQLite3::SchemaDumper.include(SchemaDumper)
+    end
+
+    module Adapter
+      def supports_virtual_columns?
+        database_version >= "3.31.0"
+      end
+
+      def new_column_from_field(table_name, field, definitions)
+        default = field["dflt_value"]
+
+        type_metadata = fetch_type_metadata(field["type"])
+        default_value = extract_value_from_default(default)
+        generated_type = extract_generated_type(field)
+
+        default_function = if generated_type.present?
+          default
+        else
+          extract_default_function(default_value, default)
+        end
+
+        rowid = is_column_the_rowid?(field, definitions) if definitions
+
+        ActiveRecord::ConnectionAdapters::SQLite3::Column.new(
+          field["name"],
+          default_value,
+          type_metadata,
+          field["notnull"].to_i == 0,
+          default_function,
+          collation: field["collation"],
+          auto_increment: field["auto_increment"],
+          rowid: rowid,
+          generated_type: generated_type
+        )
+      end
+
+      def table_structure(table_name)
+        structure = if supports_virtual_columns?
+          internal_exec_query("PRAGMA table_xinfo(#{quote_table_name(table_name)})", "SCHEMA")
+        else
+          internal_exec_query("PRAGMA table_info(#{quote_table_name(table_name)})", "SCHEMA")
+        end
+        raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if structure.empty?
+        table_structure_with_collation(table_name, structure)
+      end
+      alias_method :column_definitions, :table_structure
+
+      def invalid_alter_table_type?(type, options)
+        type.to_sym == :primary_key || options[:primary_key] ||
+          options[:null] == false && options[:default].nil?
+        options[:null] == false && options[:default].nil? ||
+          (type.to_sym == :virtual && options[:stored])
+      end
+
+      GENERATED_ALWAYS_AS_REGEX = /.*"(\w+)".+GENERATED ALWAYS AS \((.+)\) (?:STORED|VIRTUAL)/i
+      def table_structure_with_collation(table_name, basic_structure)
+        collation_hash = {}
+        auto_increments = {}
+        generated_columns = {}
+        sql = <<~SQL
+          SELECT sql FROM
+            (SELECT * FROM sqlite_master UNION ALL
+             SELECT * FROM sqlite_temp_master)
+          WHERE type = 'table' AND name = #{quote(table_name)}
+        SQL
+
+        # Result will have following sample string
+        # CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+        #                       "password_digest" varchar COLLATE "NOCASE");
+        result = query_value(sql, "SCHEMA")
+
+        if result
+          # Splitting with left parentheses and discarding the first part will return all
+          # columns separated with comma(,).
+          columns_string = result.split("(", 2).last
+
+          columns_string.split(",").each do |column_string|
+            # This regex will match the column name and collation type and will save
+            # the value in $1 and $2 respectively.
+            collation_hash[$1] = $2 if ActiveRecord::ConnectionAdapters::SQLite3Adapter::COLLATE_REGEX =~ column_string
+            auto_increments[$1] = true if ActiveRecord::ConnectionAdapters::SQLite3Adapter::PRIMARY_KEY_AUTOINCREMENT_REGEX =~ column_string
+            generated_columns[$1] = $2 if GENERATED_ALWAYS_AS_REGEX =~ column_string
+          end
+
+          basic_structure.map do |column|
+            column_name = column["name"]
+
+            if collation_hash.has_key? column_name
+              column["collation"] = collation_hash[column_name]
+            end
+
+            if auto_increments.has_key?(column_name)
+              column["auto_increment"] = true
+            end
+
+            if generated_columns.has_key?(column_name)
+              column["dflt_value"] = generated_columns[column_name]
+            end
+
+            column
+          end
+        else
+          basic_structure.to_a
+        end
+      end
+
+      def extract_generated_type(field)
+        case field["hidden"]
+        when 2 then :virtual
+        when 3 then :stored
+        end
+      end
+    end
+
+    module Column
+      def initialize(*, auto_increment: nil, rowid: false, generated_type: nil, **)
+        super
+        @generated_type = generated_type
+      end
+
+      def virtual?
+        @generated_type.present?
+      end
+
+      def virtual_stored?
+        virtual? && @generated_type == :stored
+      end
+
+      def has_default?
+        super && !virtual?
+      end
+    end
+
+    module SchemaCreation
+      def add_column_options!(sql, options)
+        if options[:collation]
+          sql << " COLLATE \"#{options[:collation]}\""
+        end
+
+        if (as = options[:as])
+          sql << " GENERATED ALWAYS AS (#{as})"
+
+          sql << if options[:stored]
+            " STORED"
+          else
+            " VIRTUAL"
+          end
+        end
+        super
+      end
+    end
+
+    module TableDefinition
+      def new_column_definition(name, type, **options) # :nodoc:
+        case type
+        when :virtual
+          type = options[:type]
+        end
+
+        super
+      end
+
+      def valid_column_definition_options
+        super + [:as, :type, :stored]
+      end
+    end
+
+    module SchemaDumper
+      def prepare_column_options(column)
+        spec = super
+
+        if @connection.supports_virtual_columns? && column.virtual?
+          spec[:as] = extract_expression_for_virtual_column(column)
+          spec[:stored] = column.virtual_stored?
+          spec = {type: schema_type(column).inspect}.merge!(spec)
+        end
+
+        spec
+      end
+
+      def extract_expression_for_virtual_column(column)
+        column.default_function.inspect
+      end
+    end
+  end
+end

data/lib/enhanced_sqlite3/version.rb

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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-enhancedsqlite3-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Margheim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Back-ports generated column support, deferred foreign key support, custom
+  foreign key support, improved default configuration, and adds support for pragma
+  tuning and extension loading
+email:
+- stephen.margheim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activerecord-enhancedsqlite3-adapter.rb
+- lib/enhanced_sqlite3/adapter.rb
+- lib/enhanced_sqlite3/railtie.rb
+- lib/enhanced_sqlite3/supports_virtual_columns.rb
+- lib/enhanced_sqlite3/version.rb
+homepage: https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter
+  source_code_uri: https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter
+  changelog_uri: https://github.com/fractaledmind/activerecord-enhancedsqlite3-adapter/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: ActiveRecord adapter for SQLite that enhances the default.
+test_files: []