activerecord-sqlite-types 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67e16d34c7465c93819920e6b15f257bbfed0cb3b4685ca48fdecf003884cceb
+  data.tar.gz: 144d483a737fbdcac6227429a09be49843609ac2cbb6b62e4ecfe6d28a0c53cd
+SHA512:
+  metadata.gz: 1b21b7c5389a14ab97f7ba46663629445568f2609bfae034ba3e614e3151252f350e41a9dadf6dfdaed8406fab310587842204cc6e2531b79dc40433f38a9397
+  data.tar.gz: b3e3b9e618df000b8ad249fb8d46662d601177943f08d55d8d8e9d25ddc68fefe757fa7d976eea748c795bb07d189198b4443d39c3b18f08783b0df9b1a8d957

data/.envrc

@@ -0,0 +1,5 @@
+export DIRENV_WARN_TIMEOUT=20s
+
+eval "$(devenv direnvrc)"
+
+use devenv

data/.standard.yml

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

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-21
+
+### Added
+
+- Initial release
+- `IpAddressType` for PostgreSQL `inet` type compatibility
+- `ArrayType` for PostgreSQL array type compatibility with JSON storage
+- `IntervalStringType` for PostgreSQL `interval` type compatibility
+- Support for Rails 7.0+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Wojtek Wrona
+
+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,146 @@
+# ActiveRecord SQLite Types
+
+Custom ActiveRecord types for migrating from PostgreSQL to SQLite in Rails applications.
+
+This gem provides drop-in replacements for PostgreSQL-specific data types that don't exist natively in SQLite, allowing you to migrate your Rails application from PostgreSQL to SQLite without changing your application code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "activerecord-sqlite-types"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Available Types
+
+### IpAddress
+
+Replaces PostgreSQL's `inet` type with a string representation that preserves IP address functionality.
+
+**Usage:**
+
+```ruby
+class User < ApplicationRecord
+  attribute :current_sign_in_ip, SQLiteTypes::IpAddress.new
+  attribute :last_sign_in_ip, SQLiteTypes::IpAddress.new
+end
+```
+
+**Migration:**
+
+```ruby
+class MigrateInetToString < ActiveRecord::Migration[7.0]
+  def up
+    change_column :users, :current_sign_in_ip, :string
+    change_column :users, :last_sign_in_ip, :string
+  end
+
+  def down
+    change_column :users, :current_sign_in_ip, :inet, using: 'current_sign_in_ip::inet'
+    change_column :users, :last_sign_in_ip, :inet, using: 'last_sign_in_ip::inet'
+  end
+end
+```
+
+### Array
+
+Replaces PostgreSQL arrays with JSON-backed arrays, supporting querying via SQLite's JSON functions.
+
+**Supported subtypes:** `:integer`, `:string`, `:hash`, `:datetime`
+
+**Usage:**
+
+```ruby
+class User < ApplicationRecord
+  attribute :personality_traits, SQLiteTypes::Array.new(:string)
+  attribute :favorite_numbers, SQLiteTypes::Array.new(:integer)
+  attribute :nested_data, SQLiteTypes::Array.new(:integer, nested: true)
+end
+```
+
+**Migration:**
+
+```ruby
+class MigrateArrayToJson < ActiveRecord::Migration[7.0]
+  def up
+    change_column :users, :personality_traits, :json
+    change_column :users, :favorite_numbers, :json
+  end
+
+  def down
+    change_column :users, :personality_traits, :text, array: true, default: [], using: 'personality_traits::text[]'
+    change_column :users, :favorite_numbers, :integer, array: true, default: [], using: 'favorite_numbers::integer[]'
+  end
+end
+```
+
+**Querying arrays:**
+
+For array querying functionality, see [Stephen Margheim's article on enhancing Rails SQLite array columns](https://fractaledmind.github.io/2023/09/12/enhancing-rails-sqlite-array-columns/).
+
+### Interval
+
+Replaces PostgreSQL's `interval` type with ISO8601 duration strings.
+
+**Usage:**
+
+```ruby
+class Event < ApplicationRecord
+  attribute :duration, SQLiteTypes::Interval.new
+end
+```
+
+**Migration:**
+
+```ruby
+class MigrateIntervalToString < ActiveRecord::Migration[7.0]
+  def up
+    change_column :events, :duration, :string
+  end
+
+  def down
+    change_column :events, :duration, :interval, using: 'duration::interval'
+  end
+end
+```
+
+## Migration Strategy
+
+The recommended approach for migrating from PostgreSQL to SQLite is incremental and reversible:
+
+1. **Prepare while still on PostgreSQL:**
+   - Add custom type declarations to your models
+   - Run migrations to change column types (e.g., `inet` → `string`)
+   - Test thoroughly - migrations are reversible!
+
+2. **Switch to SQLite:**
+   - Update `database.yml` to point to SQLite
+   - Run your data migration script (e.g., [pg-to-sqlite](https://github.com/hirefrank/pg-to-sqlite))
+   - Run your test suite
+
+3. **Handle database constraints:**
+   - Drop PostgreSQL-specific constraints before switching
+   - Add SQLite-compatible constraints after switching
+
+For a detailed migration guide, see [this presentation on migrating from PostgreSQL to SQLite](https://gist.github.com/wojtodzio/538de01f6ba24665fa66d204824ca718).
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wojtodzio/activerecord-sqlite-types.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/devenv.lock

@@ -0,0 +1,171 @@
+{
+  "nodes": {
+    "devenv": {
+      "locked": {
+        "dir": "src/modules",
+        "lastModified": 1761156818,
+        "owner": "cachix",
+        "repo": "devenv",
+        "rev": "949fc6dc8f36f38e1cceb1bf1673c4e995a6a766",
+        "type": "github"
+      },
+      "original": {
+        "dir": "src/modules",
+        "owner": "cachix",
+        "repo": "devenv",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1747046372,
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "9100a0f413b0c601e0533d1d94ffd501ce2e7885",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1747046372,
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "9100a0f413b0c601e0533d1d94ffd501ce2e7885",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1760663237,
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "ca5b894d3e3e151ffc1db040b6ce4dcc75d31c37",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1758532697,
+        "owner": "cachix",
+        "repo": "devenv-nixpkgs",
+        "rev": "207a4cb0e1253c7658c6736becc6eb9cace1f25f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "ref": "rolling",
+        "repo": "devenv-nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-ruby": {
+      "inputs": {
+        "flake-compat": "flake-compat_2",
+        "flake-utils": "flake-utils",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1759902829,
+        "owner": "bobvanderlinden",
+        "repo": "nixpkgs-ruby",
+        "rev": "5fba6c022a63f1e76dee4da71edddad8959f088a",
+        "type": "github"
+      },
+      "original": {
+        "owner": "bobvanderlinden",
+        "repo": "nixpkgs-ruby",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devenv": "devenv",
+        "git-hooks": "git-hooks",
+        "nixpkgs": "nixpkgs",
+        "nixpkgs-ruby": "nixpkgs-ruby",
+        "pre-commit-hooks": [
+          "git-hooks"
+        ]
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

data/devenv.nix

@@ -0,0 +1,14 @@
+{ pkgs, ... }:
+
+{
+  languages = {
+    ruby = {
+      version = "3.1";
+      enable = true;
+    };
+  };
+
+  packages = with pkgs; [
+    (sqlite.override { interactive = true; })
+  ];
+}

data/devenv.yaml

@@ -0,0 +1,8 @@
+inputs:
+  nixpkgs:
+    url: github:cachix/devenv-nixpkgs/rolling
+  nixpkgs-ruby:
+    url: github:bobvanderlinden/nixpkgs-ruby
+    inputs:
+      nixpkgs:
+        follows: nixpkgs

data/lib/activerecord-sqlite-types.rb

@@ -0,0 +1,8 @@
+require "active_record"
+require_relative "sqlite_types/version"
+require_relative "sqlite_types/ip_address"
+require_relative "sqlite_types/array"
+require_relative "sqlite_types/interval"
+
+module SQLiteTypes
+end

data/lib/sqlite_types/array.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module SQLiteTypes
+  class Array < ActiveRecord::Type::Json
+    SUPPORTED_SUBTYPES = %i[integer string hash datetime].freeze
+
+    def initialize(subtype, nested: false)
+      raise ArgumentError, "Unsupported subtype: #{subtype}" unless SUPPORTED_SUBTYPES.include?(subtype)
+
+      @subtype = subtype
+      @nested = nested
+      super()
+    end
+
+    def deserialize(value)
+      return if value.nil?
+
+      array = parse_to_array(value)
+
+      if @nested
+        array.map { |nested_array| parse_to_array(nested_array).map { |element| cast_element(element) } }
+      else
+        array.map { |element| cast_element(element) }
+      end
+    end
+
+    def serialize(value)
+      raise ArgumentError, "Invalid value: #{value}" if !valid?(value)
+
+      super
+    end
+
+    def force_equality?(value)
+      value.is_a?(::Array)
+    end
+
+    private
+
+    def valid?(value)
+      return true if value.nil?
+      return false if !value.is_a?(Array)
+      return value.all? { |nested_array| nested_array.is_a?(Array) } if @nested
+
+      true
+    end
+
+    def parse_to_array(value)
+      case value
+      when String
+        begin
+          parsed = ActiveSupport::JSON.decode(value)
+          parsed.is_a?(Array) ? parsed : nil
+        rescue JSON::ParserError
+          nil
+        end
+      when Array
+        value
+      end
+    end
+
+    def cast_element(elem)
+      case @subtype
+      when :integer
+        elem.to_i
+      when :string
+        elem.to_s
+      when :hash
+        elem.to_h
+      when :datetime
+        elem.is_a?(String) ? DateTime.parse(elem).in_time_zone : elem
+      else
+        raise ArgumentError, "Unsupported subtype: #{@subtype}"
+      end
+    end
+  end
+end

data/lib/sqlite_types/interval.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SQLiteTypes
+  class Interval < ActiveRecord::Type::Value
+    def serialize(value)
+      case value
+      when ::ActiveSupport::Duration
+        value.iso8601(precision: precision)
+      when ::Numeric
+        ActiveSupport::Duration.build(value).iso8601(precision: precision)
+      else
+        super
+      end
+    end
+
+    def type_cast_for_schema(value)
+      serialize(value).inspect
+    end
+
+    private
+
+    def cast_value(value)
+      case value
+      when ::ActiveSupport::Duration
+        value
+      when ::String
+        begin
+          ::ActiveSupport::Duration.parse(value)
+        rescue ::ActiveSupport::Duration::ISO8601Parser::ParsingError
+          nil
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/sqlite_types/ip_address.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SQLiteTypes
+  class IpAddress < ActiveRecord::Type::String
+    def serialize(value)
+      return if value.nil?
+
+      case value
+      when IPAddr
+        "#{value}/#{value.prefix}"
+      when String
+        ip_addr = IPAddr.new(value)
+        "#{ip_addr}/#{ip_addr.prefix}"
+      else
+        raise ArgumentError, "Invalid IP address: #{value}"
+      end
+    end
+
+    private
+
+    def cast_value(value)
+      case value
+      when IPAddr
+        value
+      when String
+        IPAddr.new(value)
+      else
+        raise ArgumentError, "Invalid IP address: #{value}"
+      end
+    end
+  end
+end

data/lib/sqlite_types/version.rb

@@ -0,0 +1,3 @@
+module SQLiteTypes
+  VERSION = "0.1.0"
+end

data/sig/sqlite_types.rbs

@@ -0,0 +1,4 @@
+module SQLiteTypes
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-sqlite-types
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wojtek Wrona
+autorequire:
+bindir: exe
+cert_chain: []
+date: 1980-01-01 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'
+description: Provides custom ActiveRecord types to handle PostgreSQL-specific data
+  types (inet, interval, arrays) when migrating to SQLite in Rails applications.
+email:
+- wojtodzio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- devenv.lock
+- devenv.nix
+- devenv.yaml
+- lib/activerecord-sqlite-types.rb
+- lib/sqlite_types/array.rb
+- lib/sqlite_types/interval.rb
+- lib/sqlite_types/ip_address.rb
+- lib/sqlite_types/version.rb
+- sig/sqlite_types.rbs
+homepage: https://github.com/wojtodzio/activerecord-sqlite-types
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/wojtodzio/activerecord-sqlite-types
+  source_code_uri: https://github.com/wojtodzio/activerecord-sqlite-types
+  changelog_uri: https://github.com/wojtodzio/activerecord-sqlite-types/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Custom ActiveRecord types for SQLite migrations from PostgreSQL
+test_files: []