feat: mysql support (#43)

* chore(docker-compose): add mysql container

* chore: pg and pg_search are optional

* fix(tests): passing for both mysql and pg

* chore: bump to 3.0.0

Breaking change:

The gem no longer depends directly on the `pg_search` gem. This means
models using `pg_search_scope` must be updated to explicitly `include PgSearch::Model`.

* fix(ci): use a real mysql image

* fix(deps): gemfile.lock updated

* fix(ci): configurable encoding

* fix(ci): mysql initialization

Author: danielrudn

.github/workflows/rspec-tests.yml

@@ -3,8 +3,8 @@ name: Tests
 on: [push]
 
 jobs:
-  build:
-    name: RSpec
+  rspec_postgres:
+    name: RSpec (Postgres)
     runs-on: ubuntu-latest
 
     services:
@@ -38,3 +38,40 @@ jobs:
       with:
         name: rspec-screenshots
         path: tmp/screenshots
+  rspec_mysql:
+    name: RSpec (MySQL)
+    runs-on: ubuntu-latest
+
+    services:
+      mysql:
+        image: mysql:8.2
+        ports: ["3306:3306"]
+        env:
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_DATABASE: sn_filterable_test
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+        bundler-cache: true
+    - name: Setup Database
+      env:
+        RAILS_ENV: test
+        DATABASE_URL: mysql2://root:[email protected]:3306/sn_filterable_test
+        DATABASE_ENCODING: utf8mb4
+      run: cd spec/dummy && bin/rails db:schema:load
+    - name: Test with rspec
+      env:
+        RAILS_ENV: test
+        DATABASE_URL: mysql2://root:[email protected]:3306/sn_filterable_test
+        DATABASE_ENCODING: utf8mb4
+      run: bundle exec rspec
+    - name: Archive RSpec screenshots
+      if: always()
+      uses: actions/upload-artifact@v3
+      with:
+        name: rspec-screenshots
+        path: tmp/screenshots

Gemfile.lock

@@ -1,11 +1,9 @@
 PATH
   remote: .
   specs:
-    sn_filterable (2.0.0)
+    sn_filterable (3.0.0)
       heroicon (~> 1)
       kaminari (~> 1)
-      pg (~> 1)
-      pg_search (~> 2)
       tailwindcss-rails (~> 2)
       turbo-rails (~> 2)
       view_component (~> 2)
@@ -144,6 +142,7 @@ GEM
     mini_portile2 (2.8.5)
     minitest (5.21.2)
     mutex_m (0.2.0)
+    mysql2 (0.5.6)
     net-imap (0.4.9.1)
       date
       net-protocol
@@ -161,10 +160,7 @@ GEM
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    pg (1.5.4)
-    pg_search (2.3.6)
-      activerecord (>= 5.2)
-      activesupport (>= 5.2)
+    pg (1.5.6)
     psych (5.1.2)
       stringio
     racc (1.7.3)
@@ -295,6 +291,8 @@ PLATFORMS
 DEPENDENCIES
   factory_bot_rails (~> 6)
   faker (~> 3)
+  mysql2 (~> 0.5)
+  pg (~> 1)
   rake (~> 13)
   rspec-rails (~> 6)
   rubocop-github (~> 0)

docker-compose.yml

@@ -1,5 +1,13 @@
 version: "3"
 services:
+  mysql:
+    image: mysql:8.2
+    environment:
+      - "MYSQL_ROOT_PASSWORD=password"
+      - "MYSQL_DATABASE=sn_filterable_test"
+    ports:
+      - 3306:3306
+
   postgres:
     image: postgres:14-alpine
     ports:

lib/sn_filterable/filterable.rb

@@ -14,12 +14,10 @@
 # `DEFAULT_SORT`: Optional, sets the default sort of the items when no sorting parameter is set. Can be either a [String], which returns the sorting name or an [Array], where the first item is the sorting name and the second item is the sort direction (either `:asc` or `:desc`).
 #
 # @see Filtered
-require "pg_search"
 
 module SnFilterable
   module Filterable
     extend ActiveSupport::Concern
-    include PgSearch::Model
 
     class_methods do
       # Filters and sorts the model's items.

lib/sn_filterable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SnFilterable
-  VERSION = "2.0.0"
+  VERSION = "3.0.0"
 end

sn_filterable.gemspec

@@ -29,12 +29,12 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "heroicon", "~> 1"
   spec.add_dependency "kaminari", "~> 1"
-  spec.add_dependency "pg", "~> 1"
-  spec.add_dependency "pg_search", "~> 2"
   spec.add_dependency "tailwindcss-rails", "~> 2"
   spec.add_dependency "turbo-rails", "~> 2"
   spec.add_dependency "view_component", "~> 2"
 
+  spec.add_development_dependency "pg", "~> 1"
+  spec.add_development_dependency "mysql2", "~> 0.5"
   spec.add_development_dependency "factory_bot_rails", "~> 6"
   spec.add_development_dependency "faker", "~> 3"
   spec.add_development_dependency "rake", "~> 13"

spec/dummy/config/database.yml

@@ -16,7 +16,7 @@
 #
 default: &default
   adapter: postgresql
-  encoding: unicode
+  encoding: <%= ENV["DATABASE_ENCODING"] || "unicode" %>
   # For details on connection pooling, see Rails configuration guide
   # https://guides.rubyonrails.org/configuring.html#database-pooling
   pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

spec/dummy/db/schema.rb

@@ -12,10 +12,6 @@
 
 ActiveRecord::Schema.define(version: 2022_12_07_175021) do
 
-  # These are extensions that must be enabled in order to support this database
-  enable_extension "plpgsql"
-  enable_extension "unaccent"
-
   create_table "dummy_models", force: :cascade do |t|
     t.datetime "created_at", precision: 6, null: false
     t.datetime "updated_at", precision: 6, null: false

spec/models/concerns/filterable_spec.rb

@@ -13,7 +13,7 @@
       BasicFilterableTestModel::FILTER_SCOPE_MAPPINGS = { # rubocop:disable RSpec/LeakyConstantDeclaration
         "name": :filter_by_name,
         "favorite_number": :filter_by_favorite_number,
-        "search": :search_by_name_favorite_number
+        "search": :search_by_name
       }.freeze
 
       BasicFilterableTestModel::SORT_SCOPE_MAPPINGS = { # rubocop:disable RSpec/LeakyConstantDeclaration
@@ -26,13 +26,7 @@
 
       scope :sort_by_name, -> { order :name }
       scope :sort_by_favorite_number, -> { order :favorite_number }
-
-      pg_search_scope :search_by_name_favorite_number,
-                      against: { name: "A", favorite_number: "B" },
-                      using: {
-                        tsearch: { prefix: true, dictionary: "english" }
-                      },
-                      ignoring: :accents
+      scope :search_by_name, ->(search) { where("name like ?", "%#{search}%")}
     end
   end
 
@@ -193,15 +187,6 @@
       expect(filtered.items.map(&:name)).to eq(expected_items)
     end
 
-    it "can search ignoring diacritics" do
-      all_items = BasicFilterableTestModel.where(nil)
-      expected_items = [all_items.first.name]
-
-      filtered = BasicFilterableTestModel.filter(params: ActionController::Parameters.new({ filter: { search: target_user.name.split(//).join("").tr("aeiouylszcn", "àèîôûÿłšżçñ") } }))
-
-      expect(filtered.items.map(&:name)).to eq(expected_items)
-    end
-
     it "can search with other params" do
       expected_items = []
 
@@ -532,15 +517,23 @@ def generate_join_sql(model)
       polymorphic_association_id = "#{polymorphic_association}_id"
       polymorphic_association_type = "#{polymorphic_association}_type"
 
-      "LEFT OUTER JOIN \"#{first_model_table}\" ON \"#{first_model_table}\".id = \"#{base_model_table}\".\"#{polymorphic_association_id}\" AND \"#{base_model_table}\".\"#{polymorphic_association_type}\" = '#{first_model_name}'"
+      if ActiveRecord::Base.connection_db_config.adapter == "mysql2"
+        "LEFT OUTER JOIN `#{first_model_table}` ON `#{first_model_table}`.id = `#{base_model_table}`.`#{polymorphic_association_id}` AND `#{base_model_table}`.`#{polymorphic_association_type}` = '#{first_model_name}'"
+      else
+        "LEFT OUTER JOIN \"#{first_model_table}\" ON \"#{first_model_table}\".id = \"#{base_model_table}\".\"#{polymorphic_association_id}\" AND \"#{base_model_table}\".\"#{polymorphic_association_type}\" = '#{first_model_name}'"
+      end
     end
   end
 
   describe ".coalesce" do
     it "creates a valid function" do
       actual_output = described_class.coalesce([DummyModel], "some_column")
 
-      expect(actual_output).to eq("coalesce(\"dummy_models\".\"some_column\")")
+      if ActiveRecord::Base.connection_db_config.adapter == "mysql2"
+        expect(actual_output).to eq("coalesce(`dummy_models`.`some_column`)")
+      else
+        expect(actual_output).to eq("coalesce(\"dummy_models\".\"some_column\")")
+      end
     end
   end
 end

spec/spec_helper.rb

@@ -10,7 +10,7 @@
 require_relative "dummy/app/models/dummy_model"
 
 ActiveRecord::Base.establish_connection(
-  "postgresql://postgres:password@localhost:5432/sn_filterable_test?schema=public&connection_limit=5"
+  ENV["DATABASE_URL"] || "postgresql://postgres:password@localhost:5432/sn_filterable_test?schema=public&connection_limit=5"
 )
 
 FactoryBot.reload