sequelize-rails 0.2.0

data/lib/sequelize_rails/railties/log_subscriber.rb

@@ -0,0 +1,153 @@
+module SequelizeRails
+  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

data/lib/sequelize_rails/translation_support.rb

@@ -0,0 +1,13 @@
+module SequelizeRails
+  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

data/lib/sequelize_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SequelizeRails
+  VERSION = "0.2.0"
+end

data/lib/sequelize_rails.rb

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

data/lib/tasks.rake

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+# These tasks were copied from activerecord/lib/active_record/railties/databases.rake
+# Lines that have been changed will be commented out with the replacement below
+
+require "active_record"
+require "active_support/configuration_file"
+require "active_support/deprecation"
+
+databases = ActiveRecord::Tasks::DatabaseTasks.setup_initial_database_yaml
+
+ns = :db
+db_namespace = namespace ns do
+  # Changed: this task was commented out
+  # desc "Set the environment value for the database"
+  # task "environment:set" => :load_config do
+  #   raise ActiveRecord::EnvironmentStorageError unless ActiveRecord::InternalMetadata.enabled?
+  #   ActiveRecord::InternalMetadata.create_table
+  #   ActiveRecord::InternalMetadata[:environment] = ActiveRecord::Base.connection.migration_context.current_environment
+  # end
+
+  # Changed: this task now only checks the loaded environment
+  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?
+  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
+      # This line was also added
+      ActiveRecord::Base.establish_connection
+    end
+
+    ActiveRecord::Migrator.migrations_paths = ActiveRecord::Tasks::DatabaseTasks.migrations_paths
+  end
+
+  namespace :create do
+    task all: :load_config do
+      ActiveRecord::Tasks::DatabaseTasks.create_all
+    end
+
+    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)
+        ActiveRecord::Tasks::DatabaseTasks.create(db_config)
+      end
+    end
+  end
+
+  desc "Creates the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:create:all to create all databases in the config). Without RAILS_ENV or when RAILS_ENV is development, it defaults to creating the development and test databases, except when DATABASE_URL is present."
+  task create: [:load_config] do
+    ActiveRecord::Tasks::DatabaseTasks.create_current
+  end
+
+  namespace :drop do
+    task all: [:load_config, :check_protected_environments] do
+      ActiveRecord::Tasks::DatabaseTasks.drop_all
+    end
+
+    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)
+        ActiveRecord::Tasks::DatabaseTasks.drop(db_config)
+      end
+    end
+  end
+
+  desc "Drops the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:drop:all to drop all databases in the config). Without RAILS_ENV or when RAILS_ENV is development, it defaults to dropping the development and test databases, except when DATABASE_URL is present."
+  task drop: [:load_config, :check_protected_environments] do
+    db_namespace[:"drop:_unsafe"].invoke
+  end
+
+  task "drop:_unsafe": [:load_config] do
+    ActiveRecord::Tasks::DatabaseTasks.drop_current
+  end
+
+  namespace :purge do
+    task all: [:load_config, :check_protected_environments] do
+      ActiveRecord::Tasks::DatabaseTasks.purge_all
+    end
+  end
+
+  # desc "Truncates tables of each database for current environment"
+  task truncate_all: [:load_config, :check_protected_environments] do
+    ActiveRecord::Tasks::DatabaseTasks.truncate_all
+  end
+
+  # desc "Empty the database from DATABASE_URL or config/database.yml for the current RAILS_ENV (use db:purge:all to purge all databases in the config). Without RAILS_ENV it defaults to purging the development and test databases, except when DATABASE_URL is present."
+  task purge: [:load_config, :check_protected_environments] do
+    ActiveRecord::Tasks::DatabaseTasks.purge_current
+  end
+
+  ############################################################################
+  # end of tasks from activerecord/lib/active_record/railties/databases.rake #
+  ############################################################################
+
+  # Initializes a database migrator
+  def migrator opts = {}
+    if ENV["VERSION"] && ENV["VERSION"].to_i > 0
+      opts[:version] = ENV["VERSION"].to_i
+    end
+    ::Sequel::TimestampMigrator.new(Sequel::DATABASES.first, ActiveRecord::Migrator.migrations_paths.first, opts)
+  end
+
+  # Opens a connection to the primary database and loads the migrator
+  task connection: [:environment] do
+    require "sequel/core"
+    Sequel.extension :migration
+    SequelizeRails.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"
+  task migrate: [:connection] do
+    migrator.run
+  end
+
+  namespace :migrate do
+    # desc "Runs the \"down\" method for the last applied migration"
+    task down: [:connection] do
+      target = (migrator.applied_migrations[-2] || "0_").split("_", 2).first.to_i
+      migrator(target: target).run
+    end
+
+    # desc "Runs the \"up\" method for the next pending migration"
+    task up: [:connection] do
+      pending = migrator.migration_tuples.first
+      if pending
+        target = pending[1].split("_", 2).first.to_i
+        migrator(target: target).run
+      end
+    end
+
+    desc "Rolls back the last migration and re-runs it"
+    task redo: [:down, :up]
+
+    desc "Displays the status of the database migrations"
+    task status: [:connection] do
+      pending = migrator.migration_tuples.count
+      if pending == 1
+        puts "1 pending migration"
+      else
+        puts "#{pending} pending migrations"
+      end
+    end
+  end
+
+  desc "Runs #{ns}:setup if the database does not exist or #{ns}:migrate if it does"
+  task prepare: [] do
+    Rake::Task[:"#{ns}:connection"].invoke
+    Rake::Task[:"#{ns}:migrate"].invoke
+  rescue Sequel::DatabaseConnectionError
+    Rake::Task[:"#{ns}:setup"].invoke
+  end
+
+  desc "Runs #{ns}:drop, #{ns}:setup"
+  task reset: [:"#{ns}:drop", :"#{ns}:setup"]
+
+  # desc "Restores the backup for database from DATABASE_URL or config/database.yml for the current RAILS_ENV"
+  # task restore: [:connection] do
+  # end
+
+  desc "Rolls back the last migration"
+  task rollback: [:"migrate:down"]
+
+  # namespace :schema do
+  #   namespace :cache do
+  #     desc "Clears the database schema and indicies caches"
+  #     task clear: [] do
+  #     end
+
+  #     desc "Creates the database schema and indicies caches"
+  #     task dump: [] do
+  #     end
+  #   end
+
+  #   desc "Creates a backup of just the database's schema"
+  #   task dump: [] do
+  #   end
+
+  #   desc "Restores the database's schema from backup"
+  #   task load: [] do
+  #   end
+  # end
+
+  # desc "Loads the seed data from db/seeds.rb"
+  # task seed: [] do
+  # end
+
+  desc "Runs the #{ns}:create, #{ns}:migrate, #{ns}:seed tasks"
+  task setup: [:"#{ns}:create", :"#{ns}:migrate", :"#{ns}:seed"]
+end

data/sequelize-rails.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/sequelize_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sequelize-rails"
+  spec.version = ::SequelizeRails::VERSION
+  spec.authors = ["Kenaniah Cerny"]
+  spec.email = ["kenaniah@gmail.com"]
+
+  spec.summary = "A gem for using Sequel with Rails natively."
+  spec.description = "This gem provides the railtie that allows Sequel to hook into Rails as an alternative or supplement to ActiveRecord."
+  spec.homepage = "https://github.com/kenaniah/sequelize-rails"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 6.0.0"
+  spec.add_dependency "rails", ">= 6.0.0"
+  spec.add_dependency "sequel", ">= 5.0.0"
+
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "pg"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/sequelize_rails.rbs

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

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: sequelize-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Kenaniah Cerny
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: This gem provides the railtie that allows Sequel to hook into Rails as
+  an alternative or supplement to ActiveRecord.
+email:
+- kenaniah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test
+- gemfiles/.bundle/config
+- gemfiles/rails_6.gemfile
+- gemfiles/rails_7.gemfile
+- lib/sequel/extensions/sequel_instrumentation.rb
+- lib/sequel/plugins/pretty_print.rb
+- 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
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/kenaniah/sequelize-rails
+  source_code_uri: https://github.com/kenaniah/sequelize-rails
+  changelog_uri: https://github.com/kenaniah/sequelize-rails/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: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: A gem for using Sequel with Rails natively.
+test_files: []