arfi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4913826264984ac5b1770bdb6d8f7791091e5211744a2f1dc56743a1d623b3e6
-  data.tar.gz: ed864c812bdead458a6dcbb664a6a334fe4ec5789e0832699a619558005cfa74
+  metadata.gz: 331aff2d0db8aae05dd27918368edd128c8a30f49617026967817b32faf95bfc
+  data.tar.gz: b3d68c00606ba1607640b458da75b094cb8a40c88aaf0dbf33758a7902172e07
 SHA512:
-  metadata.gz: 29a2edda4c4fd87bedc107439269665033acc8f2c4d501a65727b6569ea47f512eaa857cb8b3c6e92111050ab11d7a63a0646c65cca62a559e149c3d0ce112ed
-  data.tar.gz: 33a01c96166d42f757972b24fe70e7743ddd64f519bccde85ff45539f76fed5577556ba33081021a0d9ce9f9040282469b2c5cbe3683c1bc4e0eb9ac85439dd7
+  metadata.gz: c2db125c26d24967ec3874ac2d210a9c1b35a9c72e929ffbc7b3b7e5c08fdc4e67acacd0f53dfb34ed208051428a785eb5c21c52ae3cc4b578016a45e4c090d2
+  data.tar.gz: d8dc170dd81542d52979542dc03c59b041f78b6df62b219c7e5dacbc36c5927e8136a74c3f4e60cc4c108198def13e0ff0879f01c044e3561ff9455c8c088dc3

data/.rubocop.yml

@@ -1,3 +1,6 @@
 AllCops:
   TargetRubyVersion: 3.1
   NewCops: enable
+  Exclude:
+    - lib/arfi/extensions/active_record/connection_adapters/postgresql/database_statements.rb
+    - 'vendor/**/*'

data/README.md

@@ -94,12 +94,12 @@ ARFI is built on top of the following gems:
 
 ## Roadmap
 
-| Task           | Completed |
-|----------------|-----------|
-| db:migrate     | [x]       |
-| db:setup       | []        |
-| db:prepare     | []        |
-| db:schema:load | []        |
+| Task           | Completed          |
+|----------------|--------------------|
+| db:migrate     | :white_check_mark: |
+| db:setup       | :white_check_mark: |
+| db:prepare     | :white_check_mark: |
+| db:schema:load | :white_check_mark: |
 
 ## Contributing
 

data/lib/arfi/errors.rb

@@ -18,5 +18,13 @@ module Arfi
         super
       end
     end
+
+    # This error is raised when database adapter is not supported (for e.g., SQLite3).
+    class AdapterNotSupported < StandardError
+      def initialize(message = 'Adapter not supported')
+        @message = message
+        super
+      end
+    end
   end
 end

data/lib/arfi/extensions/active_record/connection_adapters/postgresql/database_statements.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'active_record/connection_adapters/postgresql/database_statements'
+
+module ActiveRecord
+  module ConnectionAdapters
+    module PostgreSQL
+      module DatabaseStatements
+        def raw_execute(sql, name, async: false, allow_retry: false, materialize_transactions: true)
+          log(sql, name, async: async) do |notification_payload|
+            with_raw_connection(allow_retry: allow_retry, materialize_transactions: materialize_transactions) do |conn|
+              result = conn.async_exec(sql)
+              verified!
+              handle_warnings(result)
+              notification_payload[:row_count] = result.count
+              result
+            rescue => e
+              if e.message.match?(/ERROR:\s{2}function (\S+\(\w+\)) does not exist/)
+                function_name = e.message.match(/ERROR:\s{2}function (\S+\(\w+\)) does not exist/)[1][/^[^(]*/]
+                if (function_file = Dir.glob(Rails.root.join('db', 'functions', "#{function_name}_v*.sql").to_s).first)
+                  conn.async_exec(File.read(function_file).chop)
+                  retry
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/arfi/extensions/extensions.rb

@@ -4,4 +4,4 @@ require 'active_record'
 require 'active_record/schema'
 require 'arfi/sql_function_loader'
 require_relative 'active_record/base'
-require_relative 'active_record/tasks/database_tasks'
+require_relative 'active_record/connection_adapters/postgresql/database_statements'

data/lib/arfi/sql_function_loader.rb

@@ -4,36 +4,58 @@ module Arfi
   # +Arfi::SqlFunctionLoader+ is a class which loads user defined SQL functions into database.
   class SqlFunctionLoader
     class << self
+      # +Arfi::SqlFunctionLoader.load!+                        -> (nil | void)
+      #
+      # Loads user defined SQL functions into database.
+      #
+      # @return [nil] if there is no `db/functions` directory.
+      # @return [void] if there is no errors.
+      # @raise [Arfi::Errors::AdapterNotSupported] if database adapter is SQLite.
       def load!
-        return unless sql_files&.any?
+        return unless sql_files.any?
+        raise Arfi::Errors::AdapterNotSupported if conn.adapter_name == 'SQLite'
 
-        puts '[ARFI] Loading SQL functions BEFORE schema load transaction...'
-        db_config = Rails.configuration.database_configuration[Rails.env]
-        conn = conn(db_config)
+        populate_db
+        conn.close
+      end
+
+      private
 
-        sql_files&.each do |file|
+      # +Arfi::SqlFunctionLoader#populate_db+                   -> void
+      #
+      # Loads user defined SQL functions into database.
+      #
+      # @!visibility private
+      # @private
+      # @return [void]
+      def populate_db
+        sql_files.each do |file|
           sql = File.read(file).strip
-          conn.exec(sql)
+          conn.execute(sql)
           puts "[ARFI] Loaded: #{File.basename(file)}"
         end
-
-        conn.close
       end
 
-      private
-
+      # +Arfi::SqlFunctionLoader#sql_files+                     -> Array<String>
+      #
+      # Helper method to get list of SQL files.
+      #
+      # @!visibility private
+      # @private
+      # @return [Array<String>] List of SQL files.
       def sql_files
         Dir.glob(Rails.root.join('db', 'functions').join('*.sql'))
       end
 
-      def conn(db_config)
-        PG.connect(
-          user: db_config['username'],
-          password: db_config['password'],
-          host: db_config['host'],
-          port: db_config['port'],
-          dbname: db_config['database']
-        )
+      # +Arfi::SqlFunctionLoader#conn+                          -> ActiveRecord::ConnectionAdapters::AbstractAdapter
+      #
+      # Helper method to get database connection.
+      #
+      # @!visibility private
+      # @private
+      # @return [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection.
+      def conn
+        ActiveRecord::Base.lease_connection
       end
     end
   end

data/lib/arfi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Arfi
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/sig/lib/arfi/errors.rbs

@@ -11,5 +11,11 @@ module Arfi
 
       def initialize: (?::String message) -> void
     end
+
+    class AdapterNotSupported < StandardError
+      @message: string
+
+      def initialize: (?::String message) -> void
+    end
   end
 end

data/sig/lib/arfi/sql_function_loader.rbs

@@ -1,19 +1,42 @@
 module Arfi
+  # +Arfi::SqlFunctionLoader+ is a class which loads user defined SQL functions into database.
   class SqlFunctionLoader
-    type db_config = {
-        user: String,
-        password: String,
-        host: String,
-        port: Integer,
-        dbname: String
-      }
-
+    # +Arfi::SqlFunctionLoader.load!+                        -> (nil | void)
+    #
+    # Loads user defined SQL functions into database.
+    #
+    # @return [nil] if there is no `db/functions` directory.
+    # @return [void] if there is no errors.
+    # @raise [Arfi::Errors::AdapterNotSupported] if database adapter is SQLite.
     def self.load!: () -> (nil | untyped)
 
     private
 
-    def self.sql_files: () -> (Array[String] | nil)
+    # +Arfi::SqlFunctionLoader#populate_db+                   -> void
+    #
+    # Loads user defined SQL functions into database.
+    #
+    # @!visibility private
+    # @private
+    # @return [void]
+    def self.populate_db: () -> untyped
+
+    # +Arfi::SqlFunctionLoader#sql_files+                     -> Array<String>
+    #
+    # Helper method to get list of SQL files.
+    #
+    # @!visibility private
+    # @private
+    # @return [Array<String>] List of SQL files.
+    def self.sql_files: () -> Array[String]
 
-    def self.conn: (db_config db_config) -> untyped
+    # +Arfi::SqlFunctionLoader#conn+                          -> ActiveRecord::ConnectionAdapters::AbstractAdapter
+    #
+    # Helper method to get database connection.
+    #
+    # @!visibility private
+    # @private
+    # @return [ActiveRecord::ConnectionAdapters::AbstractAdapter] Database connection.
+    def self.conn: () -> ::ActiveRecord::ConnectionAdapters::AbstractAdapter
   end
 end

data/sig/lib/arfi/version.rbs

@@ -1,3 +1,3 @@
 module Arfi
-  VERSION: "0.1.0"
+  VERSION: "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arfi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - unurgunite
@@ -34,7 +34,7 @@ files:
 - lib/arfi/commands/project.rb
 - lib/arfi/errors.rb
 - lib/arfi/extensions/active_record/base.rb
-- lib/arfi/extensions/active_record/tasks/database_tasks.rb
+- lib/arfi/extensions/active_record/connection_adapters/postgresql/database_statements.rb
 - lib/arfi/extensions/extensions.rb
 - lib/arfi/railtie.rb
 - lib/arfi/sql_function_loader.rb

data/lib/arfi/extensions/active_record/tasks/database_tasks.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module ActiveRecord
-  module Tasks
-    # @!visibility private
-    # Under construction.
-    module DatabaseTasks
-      # class << self
-      #   alias original_load_schema load_schema
-      #
-      #   def load_schema(*args)
-      #     Arfi::SqlFunctionLoader.load!
-      #     original_load_schema(*args)
-      #   end
-      #
-      #   alias original_load_schema_current load_schema_current
-      #
-      #   def load_schema_current(*args)
-      #     Arfi::SqlFunctionLoader.load!
-      #     original_load_schema_current(*args)
-      #   end
-      #
-      #   alias original_dump_schema dump_schema
-      #
-      #   def dump_schema(*args)
-      #     Arfi::SqlFunctionLoader.load!
-      #     original_dump_schema(*args)
-      #   end
-      # end
-    end
-  end
-end