sequelize-rails 0.2.1 → 0.3.0

data/lib/sequel/rails/railties/controller_runtime.rb

@@ -0,0 +1,48 @@
+require "active_support/core_ext/module/attr_internal"
+
+module Sequel
+  module Rails
+    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.
+          ::Sequel::Rails::Railties::LogSubscriber.reset_runtime
+          ::Sequel::Rails::Railties::LogSubscriber.reset_count
+          super
+        end
+
+        def cleanup_view_runtime
+          db_rt_before_render = ::Sequel::Rails::Railties::LogSubscriber.reset_runtime
+          self.db_runtime = (db_runtime || 0) + db_rt_before_render
+          runtime = super
+          db_rt_after_render = ::Sequel::Rails::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) + ::Sequel::Rails::Railties::LogSubscriber.reset_runtime
+          payload[:db_query_count] = ::Sequel::Rails::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
+end

data/lib/sequel/rails/railties/log_subscriber.rb

@@ -0,0 +1,155 @@
+module Sequel
+  module Rails
+    module Railties
+      class LogSubscriber < ActiveSupport::LogSubscriber
+        IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN"]
+
+        class_attribute :backtrace_cleaner, default: ActiveSupport::BacktraceCleaner.new
+
+        def self.runtime=(value)
+          Thread.current["sequel_sql_runtime"] = value
+        end
+
+        def self.runtime
+          Thread.current["sequel_sql_runtime"] ||= 0
+        end
+
+        def self.count=(value)
+          Thread.current["sequel_sql_count"] = value
+        end
+
+        def self.count
+          Thread.current["sequel_sql_count"] ||= 0
+        end
+
+        def self.reset_runtime
+          previous = runtime
+          self.runtime = 0
+          previous
+        end
+
+        def self.reset_count
+          previous = count
+          self.count = 0
+          previous
+        end
+
+        def sql(event)
+          self.class.runtime += event.duration
+          self.class.count += 1
+          return unless logger.debug?
+
+          payload = event.payload
+
+          return if IGNORE_PAYLOAD_NAMES.include?(payload[:name])
+
+          name = format("%s (%.1fms)", payload[:name], event.duration)
+          sql = payload[:sql].squeeze(" ")
+          binds = nil
+
+          if payload[:binds]&.any?
+            casted_params = type_casted_binds(payload[:type_casted_binds])
+
+            binds = []
+            payload[:binds].each_with_index do |attr, i|
+              attribute_name = if attr.respond_to?(:name)
+                attr.name
+              elsif attr.respond_to?(:[]) && attr[i].respond_to?(:name)
+                attr[i].name
+              end
+
+              filtered_params = filter(attribute_name, casted_params[i])
+
+              binds << render_bind(attr, filtered_params)
+            end
+            binds = binds.inspect
+            binds.prepend("  ")
+          end
+
+          name = colorize_payload_name(name, payload[:name])
+          sql = color(sql, sql_color(sql), true) if colorize_logging
+
+          debug "  #{name}  #{sql}#{binds}"
+        end
+
+        private
+
+        def type_casted_binds(casted_binds)
+          casted_binds.respond_to?(:call) ? casted_binds.call : casted_binds
+        end
+
+        def render_bind(attr, value)
+          case attr
+          when ActiveModel::Attribute
+            if attr.type.binary? && attr.value
+              value = "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>"
+            end
+          when Array
+            attr = attr.first
+          else
+            attr = nil
+          end
+
+          [attr&.name, value]
+        end
+
+        def colorize_payload_name(name, payload_name)
+          if payload_name.blank? || payload_name == "SQL" # SQL vs Model Load/Exists
+            color(name, WHITE, true)
+          else
+            color(name, CYAN, true)
+          end
+        end
+
+        def sql_color(sql)
+          case sql
+          when /\A\s*rollback/mi
+            RED
+          when /select .*for update/mi, /\A\s*lock/mi
+            CYAN
+          when /\A\s*select/i
+            CYAN
+          when /\A\s*insert/i
+            GREEN
+          when /\A\s*update/i
+            YELLOW
+          when /\A\s*delete/i
+            RED
+          when /transaction\s*\Z/i, /\A\s*begin/i, /\A\s*commit/i
+            BLUE
+          else
+            MAGENTA
+          end
+        end
+
+        def logger
+          ::Rails.application.config.sequel.logger
+        end
+
+        def debug(progname = nil, &block)
+          return unless super
+
+          if ::Rails.application.config.sequel.verbose_query_logs
+            log_query_source
+          end
+        end
+
+        def log_query_source
+          source = extract_query_source_location(caller)
+
+          if source
+            logger.debug("        ↳ #{source}")
+          end
+        end
+
+        def extract_query_source_location(locations)
+          backtrace_cleaner.clean(locations.lazy).first
+        end
+
+        def filter(name, value)
+          ActiveRecord::Base.inspection_filter.filter_param(name, value)
+        end
+      end
+    end
+  end
+end

data/lib/sequel/rails/translation_support.rb

@@ -0,0 +1,15 @@
+module Sequel
+  module Rails
+    module TranslationSupport
+      def i18n_scope
+        :sequel
+      end
+
+      def lookup_ancestors
+        # ActiveModel uses the name of ancestors. Exclude unnamed classes, like
+        # those returned by Sequel::Model(...).
+        super.reject { |x| x.name.nil? }
+      end
+    end
+  end
+end

data/lib/sequel/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sequel
+  module Rails
+    VERSION = "0.3.0"
+  end
+end

data/lib/sequel/rails.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "sequel/rails/version"
+require "sequel/rails/railtie"
+require "sequel/rails/translation_support"
+
+# Plugins
+require "sequel/plugins/pretty_print"
+
+# Generators
+require "rails/generators"
+require "sequel/rails/generators/migration/migration_generator"
+require "sequel/rails/generators/model/model_generator"
+require "sequel/rails/generators/application_record/application_record_generator"
+
+# Minitest support
+begin
+  gem "minitest"
+  require "sequel/rails/minitest"
+rescue Gem::LoadError
+end
+
+module Sequel
+  module Rails
+    mattr_accessor :configurations
+
+    # Opens a database connection based on the given configuration name
+    def self.connect_to config_name, opts = {}
+      config = configurations.resolve(config_name).configuration_hash.dup
+      config[:adapter] = "sqlite" if config[:adapter] == "sqlite3"
+      config[:max_connections] ||= config.delete(:pool) if config[:pool]
+      config[:pool_timeout] ||= config.delete(:timeout) / 1000 if config[:timeout]
+      Dir.chdir ::Rails.root do
+        ::Sequel.connect config, opts
+      end
+    end
+  end
+end

data/lib/{tasks.rake → sequel/tasks.rake}

@@ -23,14 +23,14 @@ db_namespace = namespace ns do
   task check_protected_environments: :load_config do
     # Disconnect any potentially-existing Sequel database connections
     Sequel::DATABASES.each(&:disconnect)
-    raise "Error: the #{Rails.env} environment is a protected environment." unless Rails.env.test? || Rails.env.development?
+    raise "Error: the #{::Rails.env} environment is a protected environment." unless ::Rails.env.test? || ::Rails.env.development?
   end
 
   task load_config: :environment do
     if ActiveRecord::Base.configurations.empty?
       # Changed: the active_record railtie may not be loaded, so we need to load the database configuration directly
       # ActiveRecord::Base.configurations = ActiveRecord::Tasks::DatabaseTasks.database_configuration
-      ActiveRecord::Base.configurations = Rails.application.config.database_configuration
+      ActiveRecord::Base.configurations = ::Rails.application.config.database_configuration
       # This line was also added
       ActiveRecord::Base.establish_connection
     end
@@ -46,7 +46,7 @@ db_namespace = namespace ns do
     ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
       desc "Create #{name} database for current environment"
       task name => :load_config do
-        db_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: name)
+        db_config = ActiveRecord::Base.configurations.configs_for(env_name: ::Rails.env, name: name)
         ActiveRecord::Tasks::DatabaseTasks.create(db_config)
       end
     end
@@ -65,7 +65,7 @@ db_namespace = namespace ns do
     ActiveRecord::Tasks::DatabaseTasks.for_each(databases) do |name|
       desc "Drop #{name} database for current environment"
       task name => [:load_config, :check_protected_environments] do
-        db_config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: name)
+        db_config = ActiveRecord::Base.configurations.configs_for(env_name: ::Rails.env, name: name)
         ActiveRecord::Tasks::DatabaseTasks.drop(db_config)
       end
     end
@@ -112,14 +112,14 @@ db_namespace = namespace ns do
   task connection: [:environment] do
     require "sequel/core"
     Sequel.extension :migration
-    SequelizeRails.connect_to :primary
+    Sequel::Rails.connect_to :primary
   end
 
   # desc "Backs up the database from DATABASE_URL or config/database.yml for the current RAILS_ENV"
   # task dump: [] do
   # end
 
-  desc "Migrate the database"
+  desc "Runs database migrations"
   task migrate: [:connection] do
     migrator.run
   end

data/lib/sequelize-rails.rb

@@ -1 +1 @@
-require "sequelize_rails"
+require "sequel/rails"

data/lib/sequelize_rails.rb

@@ -1,29 +1 @@
-# frozen_string_literal: true
-
-require "sequelize_rails/version"
-require "sequelize_rails/railtie"
-require "sequelize_rails/translation_support"
-
-# Plugins
-require "sequel/plugins/pretty_print"
-
-# Generators
-require "rails/generators"
-require "sequelize_rails/generators/migration/migration_generator"
-require "sequelize_rails/generators/model/model_generator"
-require "sequelize_rails/generators/application_record/application_record_generator"
-
-module SequelizeRails
-  mattr_accessor :configurations
-
-  # Opens a database connection based on the given configuration name
-  def self.connect_to config_name, opts = {}
-    config = SequelizeRails.configurations.resolve(config_name).configuration_hash.dup
-    config[:adapter] = "sqlite" if config[:adapter] == "sqlite3"
-    config[:max_connections] ||= config.delete(:pool) if config[:pool]
-    config[:pool_timeout] ||= config.delete(:timeout) / 1000 if config[:timeout]
-    Dir.chdir Rails.root do
-      Sequel.connect config, opts
-    end
-  end
-end
+require "sequel/rails"

data/sequelize-rails.gemspec

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "lib/sequelize_rails/version"
+require_relative "lib/sequel/rails/version"
 
 Gem::Specification.new do |spec|
   spec.name = "sequelize-rails"
-  spec.version = ::SequelizeRails::VERSION
+  spec.version = ::Sequel::Rails::VERSION
   spec.authors = ["Kenaniah Cerny"]
   spec.email = ["kenaniah@gmail.com"]
 

data/sig/sequelize_rails.rbs

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequelize-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Kenaniah Cerny
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-18 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -144,6 +144,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".standard.yml"
 - Appraisals
 - CHANGELOG.md
@@ -160,20 +161,22 @@ files:
 - gemfiles/rails_7.gemfile
 - lib/sequel/extensions/sequel_instrumentation.rb
 - lib/sequel/plugins/pretty_print.rb
+- lib/sequel/rails.rb
+- lib/sequel/rails/db_console.rb
+- lib/sequel/rails/generators/application_record/application_record_generator.rb
+- lib/sequel/rails/generators/application_record/templates/application_record.rb.tt
+- lib/sequel/rails/generators/migration/migration_generator.rb
+- lib/sequel/rails/generators/migration/templates/migration.rb.erb
+- lib/sequel/rails/generators/model/model_generator.rb
+- lib/sequel/rails/minitest.rb
+- lib/sequel/rails/railtie.rb
+- lib/sequel/rails/railties/controller_runtime.rb
+- lib/sequel/rails/railties/log_subscriber.rb
+- lib/sequel/rails/translation_support.rb
+- lib/sequel/rails/version.rb
+- lib/sequel/tasks.rake
 - lib/sequelize-rails.rb
 - lib/sequelize_rails.rb
-- lib/sequelize_rails/db_console.rb
-- lib/sequelize_rails/generators/application_record/application_record_generator.rb
-- lib/sequelize_rails/generators/application_record/templates/application_record.rb.tt
-- lib/sequelize_rails/generators/migration/migration_generator.rb
-- lib/sequelize_rails/generators/migration/templates/migration.rb.erb
-- lib/sequelize_rails/generators/model/model_generator.rb
-- lib/sequelize_rails/railtie.rb
-- lib/sequelize_rails/railties/controller_runtime.rb
-- lib/sequelize_rails/railties/log_subscriber.rb
-- lib/sequelize_rails/translation_support.rb
-- lib/sequelize_rails/version.rb
-- lib/tasks.rake
 - sequelize-rails.gemspec
 - sig/sequelize_rails.rbs
 homepage: https://github.com/kenaniah/sequelize-rails
@@ -199,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: A gem for using Sequel with Rails natively.

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

@@ -1,24 +0,0 @@
-# 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/migration/migration_generator.rb

@@ -1,21 +0,0 @@
-# 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/model/model_generator.rb

@@ -1,9 +0,0 @@
-# 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

@@ -1,66 +0,0 @@
-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
-    # Log subscriber
-    ::SequelizeRails::Railties::LogSubscriber.attach_to :sequel
-    ::SequelizeRails::Railties::LogSubscriber.backtrace_cleaner.add_filter { |line| line.gsub(Rails.root.to_s + File::SEPARATOR, "") }
-
-    # Config initialization
-    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

@@ -1,46 +0,0 @@
-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