sequelize-rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a6436860299eb2c361e5301b17ed80ecb416ec1b2a4b0c775b83abb4425a7aa
+  data.tar.gz: '095e1782c0742e4682e1de70d49018a80661222cb5db591ddc613294ed1c3e68'
+SHA512:
+  metadata.gz: 698afc25ec353669f34a355519f6cac981ec590de4c94bb94ca423693856601fb184a7e226183bc61deb23847f27d8145c76d17eaac698bcef47e2a9d8273394
+  data.tar.gz: 97294ea426455e6983b38d552146abcaa8568753ea7013da12f1781cfb8c1c6cd78671f77ab9276bd3e401549a339caf174753879f7de6211808c3b0f714efe2

data/.standard.yml

@@ -0,0 +1,4 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ignore:
+  - 'gemfiles/**/*'

data/Appraisals

@@ -0,0 +1,14 @@
+gem "sqlite3"
+gem "pg"
+
+appraise "rails-6" do
+  gem "activerecord", "~> 6"
+  gem "rails", "~> 6"
+  gem "sequel", "~> 5"
+end
+
+appraise "rails-7" do
+  gem "activerecord", "~> 7"
+  gem "rails", "~> 7"
+  gem "sequel", "~> 5"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sequelize-rails.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,213 @@
+PATH
+  remote: .
+  specs:
+    sequelize-rails (0.2.0)
+      activerecord (>= 6.0.0)
+      rails (>= 6.0.0)
+      sequel (>= 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.3)
+      actionpack (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activesupport (= 7.0.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.3)
+      actionview (= 7.0.3)
+      activesupport (= 7.0.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.3)
+      actionpack (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.3)
+      activesupport (= 7.0.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.3)
+      activesupport (= 7.0.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activestorage (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activesupport (= 7.0.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ansi (1.5.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    digest (3.1.0)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.0)
+    minitest (5.16.0)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pg (1.3.5)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3.1)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (7.0.3)
+      actioncable (= 7.0.3)
+      actionmailbox (= 7.0.3)
+      actionmailer (= 7.0.3)
+      actionpack (= 7.0.3)
+      actiontext (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activemodel (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    railties (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    sequel (5.57.0)
+    sqlite3 (1.4.4)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    strscan (3.0.3)
+    thor (1.2.1)
+    timeout (0.3.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  minitest (~> 5.0)
+  minitest-reporters
+  pg
+  pry
+  rake (~> 13.0)
+  sequelize-rails!
+  sqlite3
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kenaniah Cerny
+
+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,53 @@
+# Sequelize::Rails
+
+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/sequelize_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequelize-rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sequelize-rails
+
+## 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/kenaniah/sequelize-rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Roadmap
+
+ - [x] Support database.yml file
+ - [x] Support `rails db` console command
+ - [ ] Support `rails console --sandbox` (auto rollback all transactions)
+ - [ ] Support logging
+ - [ ] Support db rake tasks
+ - [ ] Support multiple databases
+ - [ ] Support reloading (disconnect all connections)
+ - [ ] Support ActiveRecord plugins / conventions (shims)
+ - [ ] Support PostgreSQL custom format for dump & restore
+ - [ ] Support generators (including orm)
+ - [ ] Support migration generator (and parsed attributes)

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/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "sequelize-rails"
+
+# Load the rails application
+require_relative "../test/dummy/config/environment"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here
+bundle exec appraisal generate
+bundle exec appraisal install

data/bin/test

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Runs the test suite locally
+bundle exec appraisal rake test

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.3"
+gem "activerecord", "~> 6"
+gem "rails", "~> 6"
+gem "sequel", "~> 5"
+
+gemspec path: "../"

data/gemfiles/rails_7.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.3"
+gem "activerecord", "~> 7"
+gem "rails", "~> 7"
+gem "sequel", "~> 5"
+
+gemspec path: "../"

data/lib/sequel/extensions/sequel_instrumentation.rb

@@ -0,0 +1,13 @@
+module Sequel
+  module Extensions
+    module SequelInstrumentation
+      def log_connection_yield(sql, conn, args = nil)
+        ActiveSupport::Notifications.instrument "sql.sequel", sql: sql, conn: conn, binds: args do
+          super
+        end
+      end
+    end
+  end
+  Database.register_extension(:sequel_instrumentation, Extensions::SequelInstrumentation)
+  Database.extension(:sequel_instrumentation)
+end

data/lib/sequel/plugins/pretty_print.rb

@@ -0,0 +1,24 @@
+module Sequel::Plugins::PrettyPrint
+  module InstanceMethods
+    # Modeled after the implementation within ActiveRecord
+    def pretty_print(pp)
+      return super if method(:inspect).owner != Sequel::Model.instance_method(:inspect).owner
+
+      pp.object_address_group(self) do
+        keys = self.class.columns.select { |name| @values.key?(name) || new? }
+        keys = (keys + @values.keys).uniq
+
+        pp.seplist(keys, proc { pp.text(",") }) do |key|
+          pp.breakable " "
+
+          pp.group(1) do
+            pp.text key.to_s
+            pp.text ":"
+            pp.breakable
+            pp.pp self[key]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sequelize-rails.rb

@@ -0,0 +1 @@
+require "sequelize_rails"

data/lib/sequelize_rails/db_console.rb

@@ -0,0 +1,10 @@
+# Monkey patch to allow Rails DB Console to load properly by loading active_record first
+if defined? Rails::DBConsole
+  module DBConsoleMonkeyPatch
+    def initialize options = {}
+      require "active_record"
+      super
+    end
+  end
+  Rails::DBConsole.prepend DBConsoleMonkeyPatch
+end

data/lib/sequelize_rails/generators/application_record/application_record_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SequelizeRails
+  module Generators
+    class ApplicationRecordGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_application_record
+        template "application_record.rb", application_record_file_name
+      end
+
+      private
+
+      def application_record_file_name
+        @application_record_file_name ||=
+          if namespaced?
+            "app/models/#{namespaced_path}/application_record.rb"
+          else
+            "app/models/application_record.rb"
+          end
+      end
+    end
+  end
+end

data/lib/sequelize_rails/generators/application_record/templates/application_record.rb.tt

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class ApplicationRecord < Sequel::Model
+  # Makes this an abstract model
+  dataset = nil
+end
+
+# Allows subclassed models to be initialzed with a customized dataset
+def ApplicationRecord *args
+  ApplicationRecord.Model *args
+end
+<% end -%>

data/lib/sequelize_rails/generators/migration/migration_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SequelizeRails
+  module Generators
+    class MigrationGenerator < ::Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+      def self.next_migration_number _dirname
+        Time.now.strftime "%Y%m%d%H%M%S"
+      end
+
+      def create_migration_file
+        migration_template "migration.rb.erb", "db/migrate/#{file_name}.rb"
+      end
+    end
+  end
+end

data/lib/sequelize_rails/generators/migration/templates/migration.rb.erb

@@ -0,0 +1,9 @@
+Sequel.migration do
+  up do
+    # Add forward migration code here
+  end
+
+  down do
+    # Add rollback migration code here
+  end
+end

data/lib/sequelize_rails/generators/model/model_generator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SequelizeRails
+  module Generators
+    class ModelGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+    end
+  end
+end

data/lib/sequelize_rails/railtie.rb

@@ -0,0 +1,62 @@
+require "sequel"
+require "rails"
+
+# Database configuration
+require "active_record/connection_handling"
+require "active_record/database_configurations"
+
+# Railties
+require "action_controller/railtie"
+require "sequelize_rails/railties/log_subscriber"
+require "sequelize_rails/railties/controller_runtime"
+
+# Load instrumentation before any database connections are established
+Sequel.extension :sequel_instrumentation
+
+# Monkey patches
+require "sequelize_rails/db_console"
+
+module SequelizeRails
+  class Railtie < Rails::Railtie
+    ::SequelizeRails::Railties::LogSubscriber.attach_to :sequel
+    config.app_generators.orm :sequelize_rails, migration: :sequel_migration
+    config.sequel = ActiveSupport::OrderedOptions.new
+
+    initializer "sequel.plugins" do
+      ::Sequel::Model.plugin :active_model
+    end
+
+    initializer "sequel.logger" do |app|
+      app.config.sequel.logger ||= ::Rails.logger
+      app.config.sequel.verbose_query_logs = ::Rails.env.development? if app.config.sequel.verbose_query_logs.nil?
+    end
+
+    # https://api.rubyonrails.org/classes/ActiveModel/Translation.html
+    initializer "sequel.i18n_support" do
+      ::Sequel::Model.send :extend, ::ActiveModel::Translation
+      ::Sequel::Model.send :extend, ::SequelizeRails::TranslationSupport
+    end
+
+    initializer "sequel.pretty_print" do
+      ::Sequel::Model.plugin :pretty_print
+    end
+
+    initializer "sequel.configuration" do
+      SequelizeRails.configurations = ActiveRecord::DatabaseConfigurations.new Rails.application.config.database_configuration
+    end
+
+    initializer "sequel.connection" do
+      SequelizeRails.connect_to :primary unless ARGV.any? { |c| c.starts_with? "db:" }
+    end
+
+    # Expose database runtime to controller for logging.
+    initializer "sequel.log_runtime" do |_app|
+      require "sequelize_rails/railties/controller_runtime"
+      ActionController::Base.send :include, SequelizeRails::Railties::ControllerRuntime
+    end
+
+    rake_tasks do
+      load File.expand_path("../tasks.rake", __dir__)
+    end
+  end
+end

data/lib/sequelize_rails/railties/controller_runtime.rb

@@ -0,0 +1,46 @@
+require "active_support/core_ext/module/attr_internal"
+
+module SequelizeRails
+  module Railties
+    module ControllerRuntime
+      extend ActiveSupport::Concern
+
+      protected
+
+      attr_internal :db_runtime
+
+      def process_action(action, *)
+        # We also need to reset the runtime before each action
+        # because of queries in middleware or in cases we are streaming
+        # and it won't be cleaned up by the method below.
+        ::SequelizeRails::Railties::LogSubscriber.reset_runtime
+        ::SequelizeRails::Railties::LogSubscriber.reset_count
+        super
+      end
+
+      def cleanup_view_runtime
+        db_rt_before_render = ::SequelizeRails::Railties::LogSubscriber.reset_runtime
+        self.db_runtime = (db_runtime || 0) + db_rt_before_render
+        runtime = super
+        db_rt_after_render = ::SequelizeRails::Railties::LogSubscriber.reset_runtime
+        self.db_runtime += db_rt_after_render
+        runtime - db_rt_after_render
+      end
+
+      def append_info_to_payload(payload)
+        super
+        payload[:db_runtime] = (db_runtime || 0) + ::SequelizeRails::Railties::LogSubscriber.reset_runtime
+        payload[:db_query_count] = ::SequelizeRails::Railties::LogSubscriber.count
+      end
+
+      module ClassMethods
+        def log_process_action(payload)
+          messages = super
+          messages << format("Database: %.1fms", payload[:db_runtime].to_f) if payload[:db_runtime]
+          messages << format("Queries: %d", payload[:db_query_count].to_f) if payload[:db_query_count]
+          messages
+        end
+      end
+    end
+  end
+end