sequel-activerecord-adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab2f715820608ebeb5599461592f548e15ee736e887eab787019fa491bb96d97
+  data.tar.gz: 60e410e9cde19d52d9338674235e62c0e8f9cfe0839674de0c220fe70b465abd
+SHA512:
+  metadata.gz: 9de6d6449ca1ea8a7f7f471d157efefa844de7e42d3b8e0d5c8f87028aeb1160fdee30b6185447ec5e921b3c28127cbcb43720fe85933adf9778c50039feceac
+  data.tar.gz: eb7ef32a99ce269285e1677b0a6cd421638e7e7920dd4d5af0829d3c633e55322273a950b74d21826412272d2829c8139e6926f91baa91c101d65d2ce5165c31

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Janko Marohnić
+
+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,108 @@
+# Sequel ActiveRecord Adapter
+
+This gem allows the [Sequel] library to reuse an existing ActiveRecord connection.
+It supports `postgresql`, `mysql2` and `sqlite3` adapters.
+
+This can be useful if you're using a library that uses Sequel for database
+interaction (e.g. [Rodauth]), but you want to avoid creating a separate
+database connection. Or if you're transitioning from ActiveRecord to Sequel,
+and want the database connection to be reused.
+
+Note that this is a best-effort implementation, so some discrepancies are still
+possible. However, it's worth mentioning that this gem passes [Rodauth]'s test
+suite for all adapters, which has some pretty advanced Sequel usage.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sequel-activerecord-adapter"
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install sequel-activerecord-adapter
+```
+
+## Usage
+
+Given you've configured your ActiveRecord connection, you can create a Sequel
+database and start making queries:
+
+```rb
+require "sequel-activerecord-adapter"
+
+DB = Sequel.activerecord
+DB.create_table :posts do
+  primary_key :id
+  String :title, null: false
+  Stirng :body, null: false
+end
+
+DB[:posts].insert(
+  title: "Sequel ActiveRecord Adapter",
+  body:  "Allows Sequel to reuse ActiveRecord's connection",
+)
+#=> 1
+
+DB[:posts].all
+#=> [{ title: "Sequel ActiveRecord Adapter", body: "Allows Sequel to reuse ActiveRecord's connection" }]
+
+DB[:posts].update(title: "Sequel Active Record Adapter")
+#=> 1
+```
+
+Since Sequel is using ActiveRecord connection object to make queries, any SQL
+queries will be logged to the ActiveRecord logger.
+
+### Configuration
+
+By default, the connection configuration will be read from `ActiveRecord::Base`.
+If you want to use connection configuration from a different model, you can
+pass the model class:
+
+```rb
+class MyModel < ActiveRecord::Base
+  connects_to database: { writing: :animals, reading: :animals_replica }
+end
+```
+```rb
+Sequel.activerecord(MyModel)
+```
+
+If the correct adapter cannot be inferred from ActiveRecord configuration at
+the time of initialization, you can always specify it explicitly:
+
+```rb
+Sequel.activerecord(adapter: "postgresql")
+```
+
+## Tests
+
+The Rakefile has rake tasks for setting up and tearing down different
+databases, which you need to run first.
+
+Then you can run the tests:
+
+```sh
+$ rake test
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sequel::Activerecord::Adapter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/janko/sequel-activerecord-adapter/blob/master/CODE_OF_CONDUCT.md).
+
+[Sequel]: https://github.com/jeremyevans/sequel
+[Rodauth]: https://github.com/jeremyevans/rodauth

data/lib/sequel-activerecord-adapter.rb

@@ -0,0 +1,43 @@
+require "sequel/core"
+require "active_record"
+
+require "sequel/adapters/activerecord"
+
+module Sequel
+  def self.activerecord(model = nil, **options)
+    model ||= ::ActiveRecord::Base
+
+    activerecord_adapter = model.connection_config.fetch(:adapter)
+
+    case activerecord_adapter
+    when "postgresql" then adapter ||= :postgres
+    when "mysql2"     then adapter ||= :mysql2
+    when "sqlite3"    then adapter ||= :sqlite
+    else
+      raise Sequel::ActiveRecord::Error, "unsupported adapter: #{activerecord_adapter}"
+    end
+
+    db = connect(
+      adapter:            adapter,
+      activerecord_model: model,
+      pool_class:         Sequel::ConnectionPool, # fake connection pool
+      test:               false, # don't force ActiveRecord connection
+      **options,
+    )
+
+    # general database extensions
+    db.extend Sequel::ActiveRecord::DatabaseMethods
+
+    # adapter-specific database extensions
+    Kernel.require "sequel/adapters/activerecord/#{activerecord_adapter}"
+    adapter_module = Sequel::ActiveRecord.const_get(activerecord_adapter.capitalize)
+    db.extend adapter_module::DatabaseMethods
+
+    db
+  end
+
+  module ActiveRecord
+    class Error < Sequel::Error
+    end
+  end
+end

data/lib/sequel/adapters/activerecord.rb

@@ -0,0 +1,77 @@
+require "active_record"
+
+module Sequel
+  module ActiveRecord
+    module DatabaseMethods
+      # Ensure Sequel is not creating its own connection anywhere.
+      def connect(*)
+        raise Sequel::ActiveRecord::Error, "creating a Sequel connection is not allowed"
+      end
+
+      def transaction(savepoint: nil, rollback: nil, auto_savepoint: nil, server: nil, **options)
+        activerecord_not_supported!("#{options} transaction options") if options.any?
+
+        if in_transaction?
+          requires_new = savepoint || Thread.current[:sequel_activerecord_auto_savepoint]
+        else
+          requires_new = true
+        end
+
+        activerecord_model.transaction(requires_new: requires_new) do
+          begin
+            Thread.current[:sequel_activerecord_auto_savepoint] = true if auto_savepoint
+            yield
+          rescue Sequel::Rollback => exception
+            raise if rollback == :reraise
+            raise ::ActiveRecord::Rollback, exception.message, exception.backtrace
+          ensure
+            Thread.current[:sequel_activerecord_auto_savepoint] = nil if auto_savepoint
+          end
+
+          raise ::ActiveRecord::Rollback if rollback == :always
+        end
+      end
+
+      def in_transaction?(*)
+        activerecord_connection.transaction_open?
+      end
+
+      %i[after_commit after_rollback rollback_on_exit rollback_checker].each do |meth|
+        define_method(meth) { |*| activerecord_not_supported!("Database##{meth}") }
+      end
+
+      def synchronize(*)
+        activerecord_connection.lock.synchronize do
+          yield activerecord_raw_connection
+        end
+      end
+
+      def timezone
+        @timezone || activerecord_model.default_timezone || Sequel.database_timezone
+      end
+
+      private
+
+      # We won't be needing a real connection pool.
+      def connection_pool_default_options
+        { pool_class: Sequel::ConnectionPool }
+      end
+
+      def activerecord_raw_connection
+        activerecord_connection.raw_connection
+      end
+
+      def activerecord_connection
+        activerecord_model.connection
+      end
+
+      def activerecord_model
+        opts[:activerecord_model]
+      end
+
+      def activerecord_not_supported!(feature)
+        fail Sequel::ActiveRecord::Error, "#{feature} is currently not supported by ActiveRecord adapter"
+      end
+    end
+  end
+end

data/lib/sequel/adapters/activerecord/mysql2.rb

@@ -0,0 +1,37 @@
+module Sequel
+  module ActiveRecord
+    module Mysql2
+      module DatabaseMethods
+        def execute(sql, opts=OPTS)
+          original_query_options = activerecord_raw_connection.query_options.dup
+
+          activerecord_raw_connection.query_options.merge!(
+            as:             :hash,
+            symbolize_keys: true,
+            cache_rows:     false,
+          )
+
+          result = activerecord_connection.execute(sql)
+
+          if opts[:type] == :select
+            if block_given?
+              yield result
+            else
+              result
+            end
+          elsif block_given?
+            yield activerecord_raw_connection
+          end
+        rescue ::ActiveRecord::StatementInvalid => exception
+          if exception.cause.is_a?(::Mysql2::Error)
+            raise_error(exception.cause)
+          else
+            raise
+          end
+        ensure
+          activerecord_raw_connection.query_options.replace(original_query_options)
+        end
+      end
+    end
+  end
+end

data/lib/sequel/adapters/activerecord/postgresql.rb

@@ -0,0 +1,21 @@
+module Sequel
+  module ActiveRecord
+    module Postgresql
+      module DatabaseMethods
+        def execute(sql, opts=OPTS)
+          result = activerecord_connection.execute(sql)
+
+          if block_given?
+            yield result
+          else
+            result.cmd_tuples
+          end
+        rescue ::ActiveRecord::StatementInvalid => exception
+          raise_error(exception.cause, classes: database_error_classes)
+        ensure
+          result.clear if result
+        end
+      end
+    end
+  end
+end

data/lib/sequel/adapters/activerecord/sqlite3.rb

@@ -0,0 +1,64 @@
+module Sequel
+  module ActiveRecord
+    module Sqlite3
+      module DatabaseMethods
+        def execute_ddl(sql, opts=OPTS)
+          execute(sql, opts)
+        end
+
+        private
+
+        def _execute(type, sql, opts, &block)
+          original_results_as_hash = activerecord_raw_connection.results_as_hash
+          activerecord_raw_connection.results_as_hash = false
+
+          case type
+          when :select
+            activerecord_connection.send(:log, sql) do
+              ActiveSupport::Dependencies.interlock.permit_concurrent_loads do
+                activerecord_raw_connection.query(sql, &block)
+              end
+            end
+          when :insert
+            activerecord_connection.execute(sql)
+            activerecord_raw_connection.last_insert_row_id
+          when :update
+            activerecord_connection.send(:execute_batch, sql)
+            activerecord_raw_connection.changes
+          end
+        rescue ::ActiveRecord::RecordNotUnique => exception
+          raise Sequel::UniqueConstraintViolation, exception.cause.message, exception.cause.backtrace
+        rescue ::ActiveRecord::StatementInvalid => exception
+          if exception.cause.is_a?(SQLite3::Exception)
+            raise_error(exception.cause)
+          else
+            raise
+          end
+        ensure
+          activerecord_raw_connection.results_as_hash = original_results_as_hash
+        end
+      end
+
+      class Result
+        def initialize(array)
+          binding.irb
+          @array = array
+        end
+
+        def types
+          return [] if @array.empty?
+          @array[0].types
+        end
+
+        def columns
+          return [] if @array.empty?
+          @array[0].fields
+        end
+
+        def each(&block)
+          @array.each(&block)
+        end
+      end
+    end
+  end
+end

data/sequel-activerecord-adapter.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-activerecord-adapter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Janko Marohnić"]
+  spec.email         = ["janko.marohnic@gmail.com"]
+
+  spec.summary       = %q{Allows Sequel to use ActiveRecord connection for database interaction.}
+  spec.description   = %q{Allows Sequel to use ActiveRecord connection for database interaction.}
+  spec.homepage      = "https://github.com/janko/sequel-activerecord-adapter"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.2.0")
+
+  spec.add_dependency "sequel", "~> 5.0"
+  spec.add_dependency "activerecord", ">= 5.0", "< 7"
+
+  spec.add_development_dependency "pg",      "~> 1.0"
+  spec.add_development_dependency "mysql2",  "~> 0.5"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
+  spec.add_development_dependency "minitest"
+
+  spec.files         = Dir["README.md", "LICENSE.txt", "CHANGELOG.md", "lib/**/*.rb", "*.gemspec"]
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: sequel-activerecord-adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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'
+description: Allows Sequel to use ActiveRecord connection for database interaction.
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/sequel-activerecord-adapter.rb
+- lib/sequel/adapters/activerecord.rb
+- lib/sequel/adapters/activerecord/mysql2.rb
+- lib/sequel/adapters/activerecord/postgresql.rb
+- lib/sequel/adapters/activerecord/sqlite3.rb
+- sequel-activerecord-adapter.gemspec
+homepage: https://github.com/janko/sequel-activerecord-adapter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.1
+signing_key: 
+specification_version: 4
+summary: Allows Sequel to use ActiveRecord connection for database interaction.
+test_files: []