arfi 0.5.1 → 1.0.0

data/sig/lib/arfi/commands/functions_candidates.rbs

@@ -0,0 +1,25 @@
+module Arfi
+  module Commands
+    module FunctionsCandidates : Arfi::Commands::Functions
+      DEFAULT_SCHEMA: "public"
+
+      private
+
+      def collect_all_candidates: (::Pathname root, String adapter) -> Array[candidate]
+
+      def group_candidates_by_key: (Array[candidate] candidates) -> ::Hash[String, Array[candidate]]
+
+      def build_resolved_rows: (::Hash[String, Array[candidate]] by_key) -> Array[::Hash[Symbol, untyped]]
+
+      def generic_candidates: (::Pathname root) -> Array[candidate]
+
+      def adapter_candidates: (::Pathname adapter_root, String adapter) -> Array[candidate]
+
+      def collect_postgresql_schema_candidates: (::Pathname adapter_root, String adapter) -> Array[candidate]
+
+      def collect_candidates: (glob: ::Pathname, schema: String, source: String, origin: String, priority: Integer) -> Array[candidate]
+
+      def rel: (::Pathname | String path) -> String
+    end
+  end
+end

data/sig/lib/arfi/commands/functions_creation.rbs

@@ -0,0 +1,29 @@
+module Arfi
+  module Commands
+    module FunctionsCreation : Arfi::Commands::Functions
+      DEFAULT_SCHEMA: "public"
+
+      ROOT_DIR: "db/functions"
+
+      ADAPTERS: ::Array[:postgresql | :mysql | :trilogy]
+
+      private
+
+      def ensure_dirs!: (adapter: String?, schema: String?) -> void
+
+      def write_file: (String? schema, String function_name, String content) -> void
+
+      def remove_function_file: (String? schema, String function_name) -> void
+
+      def build_postgresql_skeleton: (String? schema, String function_name) -> String
+
+      def build_mysql_skeleton: (String function_name) -> String
+
+      def evaluate_template: (String function_name, String? schema_name, String qualified_name, String original_ref) -> untyped
+
+      def build_sql_function: (String? schema, String function_name, original_ref: String) -> String
+
+      def build_from_file: (String? schema, String function_name, original_ref: String) -> String
+    end
+  end
+end

data/sig/lib/arfi/commands/functions_helpers.rbs

@@ -0,0 +1,41 @@
+module Arfi
+  module Commands
+    module FunctionsHelpers : Arfi::Commands::Functions
+      ADAPTERS: ::Array[:postgresql | :mysql | :trilogy]
+
+      IDENT: ::Regexp
+
+      DEFAULT_SCHEMA: "public"
+
+      ROOT_DIR: "db/functions"
+
+      private
+
+      def validate_schema_format!: () -> void
+
+      def validate_adapter_option!: () -> void
+
+      def parse_function_ref: (String ref) -> [String?, String]
+
+      def validate_identifiers!: (String? schema, String function_name) -> void
+
+      def validate_function_ref!: (String ref) -> void
+
+      def check_schema_conflict!: (String? parsed_schema) -> void
+
+      def resolve_schema_name: (String? schema) -> String?
+
+      def resolve_adapter: () -> String
+
+      def resolve_functions_for: (adapter: String) -> Array[::Hash[Symbol, untyped]]
+
+      def adapter_opt: () -> String?
+
+      def infer_adapter_from_config: () -> String?
+
+      def schema_opt: () -> String?
+
+      def primary_db_config: () -> untyped
+    end
+  end
+end

data/sig/lib/arfi/commands/functions_paths.rbs

@@ -0,0 +1,25 @@
+module Arfi
+  module Commands
+    module FunctionsPaths : Arfi::Commands::Functions
+      ROOT_DIR: "db/functions"
+
+      DEFAULT_SCHEMA: "public"
+
+      private
+
+      def canonical_path: (String? schema, String function_name) -> String
+
+      def function_paths: (String? schema, String function_name) -> Array[String]
+
+      def generic_canonical_path: (::Pathname root, String? schema, String function_name) -> String
+
+      def adapter_canonical_path: (::Pathname root, String? schema, String function_name) -> String
+
+      def generic_function_paths: (::Pathname root, String function_name) -> Array[String]
+
+      def postgresql_function_paths: (::Pathname root, String? schema, String function_name) -> Array[String]
+
+      def mysql_function_paths: (::Pathname root, String function_name) -> Array[String]
+    end
+  end
+end

data/sig/lib/arfi/commands/functions_rendering.rbs

@@ -0,0 +1,25 @@
+module Arfi
+  module Commands
+    module FunctionsRendering : Arfi::Commands::Functions
+      private
+
+      def print_table: (Array[::Hash[Symbol, untyped]] rows) -> void
+
+      def render_list: (Array[::Hash[Symbol, untyped]] rows) -> void
+
+      def table_columns: () -> Array[String]
+
+      def stringify_rows: (Array[::Hash[Symbol, untyped]] rows) -> Array[::Hash[Symbol, untyped]]
+
+      def calculate_widths: (Array[String] cols, Array[::Hash[Symbol, untyped]] table) -> ::Hash[String, Integer]
+
+      def render_table_rows: (Array[::Hash[Symbol, untyped]] table, Array[String] cols, ::Hash[String, Integer] widths) -> void
+
+      def resolve_key_group: (Array[candidate] arr) -> Array[::Hash[Symbol, untyped]]
+
+      def all_mode_rows: (Array[candidate] arr, candidate chosen) -> Array[::Hash[Symbol, untyped]]
+
+      def default_mode_row: (candidate chosen, Array[candidate] arr) -> Array[::Hash[Symbol, untyped]]
+    end
+  end
+end

data/sig/lib/arfi/commands/init.rbs

@@ -0,0 +1,22 @@
+module Arfi
+  module Commands
+    class Init < Thor
+      ADAPTERS: ::Array[:postgresql | :mysql]
+
+      ROOT_DIR: "db/functions"
+
+      DEFAULT_SCHEMA: "public"
+
+      # steep:ignore:end
+      def create: () -> void
+
+      private
+
+      def validate_schema_format!: () -> void
+
+      def create_base_dirs: () -> void
+
+      def create_adapter_dirs: () -> void
+    end
+  end
+end

data/sig/lib/arfi/commands/project.rbs

@@ -1,28 +1,9 @@
 module Arfi
   module Commands
-    class Project
-      ADAPTERS: Array[Symbol]
-
-      # +Arfi::Commands::Project#create+                 -> void
-      #
-      # This command is used to create `db/functions` directory.
-      #
-      # @example
-      #   bundle exec arfi project create
-      # @return [void]
-      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby.
-      def create: () -> void
-
-      private
-
-      # +Arfi::Commands::Project#functions_dir+          -> Pathname
-      #
-      # Helper method to get path to `db/functions` directory.
-      #
-      # @!visibility private
-      # @private
-      # @return [Pathname] Path to `db/functions` directory
-      def functions_dir: () -> Pathname
-    end
+    # +Arfi::Commands::Project+ class is used to create `db/functions` directory.
+    #
+    # Backward-compatible constant for code that references Arfi::Commands::Project.
+    # @deprecated
+    Project: untyped
   end
 end

data/sig/lib/arfi/extensions/active_record/base.rbs

@@ -1,14 +1,9 @@
 module ActiveRecord
   class Base
-    # +ActiveRecord::Base.function_exists?+               -> bool
-    #
-    # This method checks if a custom SQL function exists in the database.
-    #
-    # @example
-    #   ActiveRecord::Base.function_exists?('my_function') #=> true
-    #   ActiveRecord::Base.function_exists?('my_function123') #=> false
-    # @param [String] function_name The name of the function to check.
-    # @return [Boolean] Returns true if the function exists, false otherwise.
-    def self.function_exists?: (string function_name) -> bool
+    def self.function_exists?: (String function_name) -> bool
+
+    def self.pg_function_exists?: (String function_name) -> bool
+
+    def self.mysql_function_exists?: (String function_name) -> bool
   end
 end

data/sig/lib/arfi/extensions/active_record/connection_adapters/postgresql/database_statements.rbs

@@ -0,0 +1,28 @@
+module Arfi
+  module PostgreSQL
+    module DatabaseStatementsPatch
+      ARFI_UNDEFINED_FUNCTION: ::Regexp
+
+      THREAD_GUARD_KEY: :arfi_reloading_functions
+
+      # Rails 6/7: SELECT often goes through exec_query
+      def exec_query: (*untyped args, **untyped kwargs) -> untyped
+
+      # DDL often goes through execute
+      def execute: (*untyped args, **untyped kwargs) -> untyped
+
+      # Rails 7+/8 may use raw_execute
+      def raw_execute: (*untyped args, **untyped kwargs) -> untyped
+
+      def internal_exec_query: (*untyped args, **untyped kwargs) -> untyped
+
+      private
+
+      def arfi_try_reload_and_retry?: (untyped e) -> (false | true)
+
+      def arfi_extract_function_ident: (untyped message) -> (::Array[nil] | untyped)
+
+      def arfi_has_function_file_for?: (untyped schema, untyped fn) -> (false | untyped)
+    end
+  end
+end

data/sig/lib/arfi/sql_function_loader.rbs

@@ -1,94 +1,52 @@
 module Arfi
-  # +Arfi::SqlFunctionLoader+ is a class which loads user defined SQL functions into database.
+  type sql_file_item = {
+    schema: String,
+    base: String,
+    path: String,
+    priority: Integer
+  }
+
   class SqlFunctionLoader
-    attr_accessor self.task_name: nil | String
-
-    # +Arfi::SqlFunctionLoader.load!+                        -> (nil | void)
-    #
-    # Loads user defined SQL functions into database.
-    #
-    # @param task_name [String|nil] Name of the task.
-    # @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!: (task_name: nil | String) -> (nil | untyped)
-
-    # +Arfi::SqlFunctionLoader#sql_functions_by_adapter+      -> Array<String>
-    #
-    # Helper method to get list of SQL files for specific database adapter.
-    #
-    # @!visibility private
-    # @private
-    # @return [Array<String>] List of SQL files.
-    # @raise [Arfi::Errors::AdapterNotSupported] if database adapter is not supported.
-    def self.sql_functions_by_adapter: -> Array[String]
-
-    # +Arfi::SqlFunctionLoader#multi_db?+                       -> Boolean
-    #
-    # Checks if the application has been configured to work with multiple databases.
-    #
-    # @return [Boolean]
-    def self.multi_db?: -> bool
-
-    # +Arfi::SqlFunctionLoader#populate_multiple_db+          -> void
-    #
-    # Loads user defined SQL functions into all databases.
-    #
-    # @!visibility private
-    # @private
-    # @return [void]
-    # @see Arfi::SqlFunctionLoader#multi_db?
-    # @see Arfi::SqlFunctionLoader#populate_db
-    def self.populate_multiple_db: -> void
-
-    # +Arfi::SqlFunctionLoader#raise_unless_supported_adapter+ -> void
-    #
-    # Checks if the database adapter is supported.
-    #
-    # @return [void]
-    # @raise [Arfi::Errors::AdapterNotSupported]
-    def self.raise_unless_supported_adapter: -> void
-
-    # +Arfi::SqlFunctionLoader#handle_db_population+         -> void
-    #
-    # Loads user defined SQL functions into database. This conditional branch was written this way because if we
-    # call db:migrate:db_name, then task_name will not be nil, but it will be zero if we call db:migrate. Then we
-    # check that the application has been configured to work with multiple databases in order to populate all
-    # databases, and only after this check can we populate the database in case the db:migrate (or any other) task
-    # has been called for configuration with a single database. Go to `lib/arfi/tasks/db.rake` for additional info.
-    #
-    # @!visibility private
-    # @private
-    # @return [void]
-    def self.handle_db_population: -> untyped
+    def self.load!: (?task_name: String?, ?connection: ::ActiveRecord::ConnectionAdapters::AbstractAdapter?, ?clear_active_connections: bool, ?verbose: bool) -> void
 
     private
 
-    # +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]
-
-    # +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
+    def self.default_connection: () -> ::ActiveRecord::ConnectionAdapters::AbstractAdapter
+
+    def self.raise_unless_supported_adapter: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn) -> void
+
+    def self.multi_db?: () -> bool
+
+    def self.populate_multiple_db: (verbose: bool, ?task_name: String?) -> void
+
+    def self.current_db_config: () -> untyped
+
+    def self.populate_db: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn, verbose: bool, task_name: String?) -> void
+
+    def self.clear_active_connections_if_needed: (bool clear) -> void
+
+    def self.load_sql_file: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn, ::Pathname | String file, bool verbose, String? task_name) -> void
+
+    def self.log_sql_load: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn, ::Pathname | String file, String? task_name) -> void
+
+    def self.safe_db_env: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn) -> String
+
+    def self.safe_db_name: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn) -> String
+
+    def self.log: (::ActiveRecord::ConnectionAdapters::AbstractAdapter _conn, String msg) -> void
+
+    def self.sql_files: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn) -> Array[String]
+
+    def self.collect_adapter_sql_files: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn, ::Pathname adapter_root) -> Array[sql_file_item]
+
+    def self.collect_postgresql_sql_files: (::Pathname adapter_root) -> Array[sql_file_item]
+
+    def self.collect_adapter_public_sql_files: (::Pathname adapter_root) -> Array[sql_file_item]
+
+    def self.collect_sql: (glob: ::Pathname | String, schema: String, priority: Integer) -> Array[sql_file_item]
+
+    def self.finalize_items: (Array[sql_file_item] items) -> Array[String]
+
+    def self.adapter_root_for: (::ActiveRecord::ConnectionAdapters::AbstractAdapter conn, ::Pathname root) -> ::Pathname
   end
 end

data/sig/lib/arfi/tasks/db.rbs

@@ -0,0 +1,3 @@
+class Object
+  def arfi_db_config_for: (String name) -> Hash[Symbol | String, String | Integer | bool | nil]?
+end

data/sig/lib/arfi/version.rbs

@@ -1,3 +1,3 @@
 module Arfi
-  VERSION: "0.5.1"
+  VERSION: String
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arfi
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - unurgunite
@@ -51,6 +51,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: docscribe
+  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: dotenv
+  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: irb
   requirement: !ruby/object:Gem::Requirement
@@ -66,19 +94,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: repl_type_completor
+  name: mysql2
+  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.1.11
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.11
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +149,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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: rubocop-rspec
+  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: rubocop-sorted_methods_by_call
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: steep
   requirement: !ruby/object:Gem::Requirement
@@ -135,32 +219,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.37
-description: 'ARFI — ActiveRecord Functional Indexes. Provides the ability to create
-  and maintain functions that can be used as indexes, as well as in other parts of
-  the project without switching to structure.sql.
-
-  '
-email:
-- senpaiguru1488@gmail.com
+description: |
+  ARFI — ActiveRecord Functions Integration. Provides the ability to create and maintain SQL functions that
+  can be used across the project without switching to structure.sql.
 executables:
 - arfi
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- SECURITY.md
 - Steepfile
+- compose.yml
+- docscribe.yml
 - exe/arfi
+- gemfiles/rails_6_0.gemfile
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_8_0.gemfile
+- gemfiles/rails_8_1.gemfile
 - lib/arfi.rb
 - lib/arfi/Rakefile
 - lib/arfi/cli.rb
 - lib/arfi/commands/f_idx.rb
+- lib/arfi/commands/functions.rb
+- lib/arfi/commands/functions_candidates.rb
+- lib/arfi/commands/functions_creation.rb
+- lib/arfi/commands/functions_helpers.rb
+- lib/arfi/commands/functions_paths.rb
+- lib/arfi/commands/functions_rendering.rb
+- lib/arfi/commands/init.rb
 - lib/arfi/commands/project.rb
 - lib/arfi/errors.rb
 - lib/arfi/extensions/active_record/base.rb
@@ -174,13 +274,24 @@ files:
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
 - sig/arfi.rbs
+- sig/compat/active_record_base_compat.rbs
+- sig/compat/thor_dsl.rbs
 - sig/lib/arfi/cli.rbs
 - sig/lib/arfi/commands/f_idx.rbs
+- sig/lib/arfi/commands/functions.rbs
+- sig/lib/arfi/commands/functions_candidates.rbs
+- sig/lib/arfi/commands/functions_creation.rbs
+- sig/lib/arfi/commands/functions_helpers.rbs
+- sig/lib/arfi/commands/functions_paths.rbs
+- sig/lib/arfi/commands/functions_rendering.rbs
+- sig/lib/arfi/commands/init.rbs
 - sig/lib/arfi/commands/project.rbs
 - sig/lib/arfi/errors.rbs
 - sig/lib/arfi/extensions/active_record/base.rbs
+- sig/lib/arfi/extensions/active_record/connection_adapters/postgresql/database_statements.rbs
 - sig/lib/arfi/railtie.rbs
 - sig/lib/arfi/sql_function_loader.rbs
+- sig/lib/arfi/tasks/db.rbs
 - sig/lib/arfi/version.rbs
 homepage: https://github.com/unurgunite/arfi
 licenses:
@@ -198,14 +309,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.13
 specification_version: 4
-summary: ActiveRecord Functional Indexes.
+summary: ActiveRecord Functions Integration.
 test_files: []