arfi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4913826264984ac5b1770bdb6d8f7791091e5211744a2f1dc56743a1d623b3e6
+  data.tar.gz: ed864c812bdead458a6dcbb664a6a334fe4ec5789e0832699a619558005cfa74
+SHA512:
+  metadata.gz: 29a2edda4c4fd87bedc107439269665033acc8f2c4d501a65727b6569ea47f512eaa857cb8b3c6e92111050ab11d7a63a0646c65cca62a559e149c3d0ce112ed
+  data.tar.gz: 33a01c96166d42f757972b24fe70e7743ddd64f519bccde85ff45539f76fed5577556ba33081021a0d9ce9f9040282469b2c5cbe3683c1bc4e0eb9ac85439dd7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-22
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 daniil.lyubimcev
+
+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,117 @@
+# ARFI
+
+![Alt](https://repobeats.axiom.co/api/embed/324b4f481b219890ef5a26e3c6fb73fff8929c93.svg "Repobeats analytics image")
+
+---
+
+**! WARNING !**
+
+This project supports only PostgreSQL databases. In near future, ARFI will support MySQL databases. Since SQLite3 does
+not support functional indexes with custom functions, this project won't support SQLite3 databases in near future.
+
+---
+
+ARFI – *ActiveRecord Functional Indexes*
+
+ARFI gem brings you the ability to create and maintain functional indexes for your ActiveRecord models without
+transition to `structure.sql` (SQL-based schema).
+
+* [ARFI](#arfi)
+    * [Installation](#installation)
+    * [Usage](#usage)
+        * [CLI](#cli)
+        * [Project creation](#project-creation)
+        * [Index creation](#index-creation)
+        * [Index destroy](#index-destroy)
+        * [Additional help](#additional-help)
+    * [Development](#development)
+        * [Build from source](#build-from-source)
+    * [Requirements](#requirements)
+    * [Contributing](#contributing)
+    * [License](#license)
+    * [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add arfi
+```
+
+## Usage
+
+### CLI
+
+ARFI uses Thor as a command line interface (CLI) instead of Rake, so it has a specific DSL.
+
+### Project creation
+
+Firstly, run `bundle exec arfi project create` to create a new project. This command will create `db/functions`
+directory. ARFI uses `db/functions` directory to store your functional indexes.
+
+### Index creation
+
+Run `bundle exec arfi f_idx create function_name` to create a new functional index. New index will be created in
+`db/functions` directory under `function_name_v01.sql` name. Edit you index and run `bundle exec rails db:migrate`
+
+### Index destroy
+
+If you want to destroy your index, run `bundle exec arfi f_idx destroy function_name [revision (1 by default)]`
+
+### Additional help
+
+Run `bundle exec arfi` for additional help.
+
+## Development
+
+### Build from source
+
+The manual installation includes installation via command line interface. it is practically no different from what
+happens during the automatic build of the project:
+
+```shell
+git clone https://github.com/unurgunite/arfi.git
+cd arfi
+bundle install
+gem build arfi.gemspec
+gem install arfi-0.1.0.gem
+```
+
+Also, you can run `bin/setup` to automatically install everything needed.
+
+## Requirements
+
+ARFI is built on top of the following gems:
+
+| Dependencies | Description                                                                                |
+|--------------|--------------------------------------------------------------------------------------------|
+| ActiveRecord | Used to patch `ActiveRecord::Base` module with new methods.                                |
+| Rails        | Used for fetching project settings (database connection settings, Rails environment, etc.) |
+| Thor         | For CLI development.                                                                       |
+| Rubocop      | For static code analysis.                                                                  |
+| Rake         | For patching built-in Rails Rake tasks.                                                    |
+
+## Roadmap
+
+| Task           | Completed |
+|----------------|-----------|
+| db:migrate     | [x]       |
+| db:setup       | []        |
+| db:prepare     | []        |
+| db:schema:load | []        |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/unurgunite/arfi. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/[USERNAME]/Arfi/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Arfi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow
+the [code of conduct](https://github.com/[USERNAME]/Arfi/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/arfi

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'thor'
+require_relative '../lib/arfi/cli'
+
+Arfi::CLI.start(ARGV)

data/lib/arfi/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'arfi'
+
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/arfi/cli.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative 'commands/project'
+require_relative 'commands/f_idx'
+
+module Arfi
+  # Top level CLI class
+  class CLI < Thor
+    desc 'project [COMMAND]', 'Project specific commands.'
+    subcommand 'project', Commands::Project
+
+    desc 'f_idx [COMMAND]', 'Command to handle functional indexes.'
+    subcommand 'f_idx', Commands::FIdx
+  end
+end

data/lib/arfi/commands/f_idx.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'rails'
+require File.expand_path('config/environment', Dir.pwd)
+
+module Arfi
+  module Commands
+    # +Arfi::Commands::FIdx+ module contains commands for manipulating functional index in Rails project.
+    class FIdx < Thor
+      desc 'create INDEX_NAME', 'Initialize the functional index'
+      # +Arfi::Commands::FIdx#create+                        -> void
+      #
+      # This command is used to create the functional index.
+      #
+      # @example
+      #   bundle exec arfi f_idx create some_function
+      # @param index_name [String] Name of the index.
+      # @return [void]
+      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby
+      # @raise [Arfi::Errors::NoFunctionsDir] if there is no `db/functions` directory
+      # @see Arfi::Commands::FIdx#validate_schema_format!
+      def create(index_name)
+        validate_schema_format!
+        content = build_sql_function(index_name)
+        create_index_file(index_name, content)
+      end
+
+      desc 'destroy INDEX_NAME [REVISION]', 'Delete the functional index'
+      # +Arfi::Commands::FIdx#destroy+                        -> void
+      #
+      # This command is used to delete the functional index.
+      #
+      # @example
+      #   bundle exec arfi f_idx destroy some_function [revision index (just an integer, 1 is by default)]
+      # @param index_name [String] Name of the index.
+      # @param revision [String] Revision of the index.
+      # @return [void]
+      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby
+      def destroy(index_name, revision = '01')
+        validate_schema_format!
+
+        revision = "0#{revision}" if revision.match?(/^\d$/)
+        FileUtils.rm("#{functions_dir}/#{index_name}_v#{revision}.sql")
+        puts "Deleted: #{functions_dir}/#{index_name}_v#{revision}.sql"
+      end
+
+      private
+
+      # +Arfi::Commands::FIdx#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
+        Rails.root.join('db/functions')
+      end
+
+      # +Arfi::Commands::FIdx#validate_schema_format!+                        -> void
+      #
+      # Helper method to validate the schema format.
+      #
+      # @!visibility private
+      # @private
+      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby.
+      # @return [nil] if the schema format is valid.
+      def validate_schema_format!
+        raise Arfi::Errors::InvalidSchemaFormat unless ActiveRecord.schema_format == :ruby
+      end
+
+      # +Arfi::Commands::FIdx#build_sql_function+                        -> String
+      #
+      # Helper method to build the SQL function.
+      #
+      # @!visibility private
+      # @private
+      # @param index_name [String] Name of the index.
+      # @return [String] SQL function body.
+      def build_sql_function(index_name)
+        <<~SQL
+          CREATE OR REPLACE FUNCTION #{index_name}() RETURNS TEXT[]
+              LANGUAGE SQL
+              IMMUTABLE AS
+          $$
+              -- Function body here
+          $$
+        SQL
+      end
+
+      # +Arfi::Commands::FIdx#create_index_file+                        -> void
+      #
+      # Helper method to create the index file.
+      #
+      # @!visibility private
+      # @private
+      # @param index_name [String] Name of the index.
+      # @param content [String] SQL function body.
+      # @return [void]
+      def create_index_file(index_name, content)
+        existing_files = Dir.glob("#{functions_dir}/#{index_name}*.sql")
+
+        return write_file(index_name, content, 1) if existing_files.empty?
+
+        latest_version = extract_latest_version(existing_files)
+        write_file(index_name, content, latest_version.next)
+      end
+
+      # +Arfi::Commands::FIdx#extract_latest_version+                        -> Integer
+      #
+      # Helper method to extract the latest version of the index.
+      #
+      # @!visibility private
+      # @private
+      # @param files [Array<String>] List of files.
+      # @return [String] Latest version of the index.
+      def extract_latest_version(files)
+        version_numbers = files.map do |file|
+          File.basename(file)[/\w+_v(\d+)\.sql/, 1]
+        end.compact
+
+        version_numbers.max
+      end
+
+      # +Arfi::Commands::FIdx#write_file+                        -> void
+      #
+      # Helper method to write the index file.
+      #
+      # @!visibility private
+      # @private
+      # @param index_name [String] Name of the index.
+      # @param content [String] SQL function body.
+      # @param version [Integer] Version of the index.
+      # @return [void]
+      def write_file(index_name, content, version)
+        version_str = format('%02d', version)
+        path = "#{functions_dir}/#{index_name}_v#{version_str}.sql"
+        File.write(path, content)
+        puts "Created: #{path}"
+      end
+    end
+  end
+end

data/lib/arfi/commands/project.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'fileutils'
+require 'rails'
+
+module Arfi
+  module Commands
+    # +Arfi::Commands::Project+ class is used to create `db/functions` directory.
+    class Project < Thor
+      desc 'create', 'Initialize project by creating db/functions directory'
+      # +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
+        raise Arfi::Errors::InvalidSchemaFormat unless ActiveRecord.schema_format == :ruby
+        return puts "Directory #{functions_dir} already exists" if Dir.exist?(functions_dir)
+
+        FileUtils.mkdir_p(functions_dir)
+        puts "Created: #{functions_dir}"
+      end
+
+      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
+        Rails.root.join('db/functions')
+      end
+    end
+  end
+end

data/lib/arfi/errors.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Arfi
+  module Errors
+    # This error is raised when there is no `db/functions` directory
+    class NoFunctionsDir < StandardError
+      def initialize(message =
+                       'There is no such directory: db/functions. Did you run `bundle exec arfi project:create`?')
+        @message = message
+        super
+      end
+    end
+
+    # This error is raised when Rails project schema format is not +schema.rb+
+    class InvalidSchemaFormat < StandardError
+      def initialize(message = 'Invalid schema format. ARFI supports only ruby format schemas.')
+        @message = message
+        super
+      end
+    end
+  end
+end

data/lib/arfi/extensions/active_record/base.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+module ActiveRecord
+  class Base # :nodoc:
+    # +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?(function_name)
+      connection.execute("SELECT * FROM pg_proc WHERE proname = '#{function_name}'").any?
+    end
+  end
+end

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

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

data/lib/arfi/extensions/extensions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_record/schema'
+require 'arfi/sql_function_loader'
+require_relative 'active_record/base'
+require_relative 'active_record/tasks/database_tasks'

data/lib/arfi/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'arfi'
+require 'rails'
+
+module Arfi
+  class Railtie < ::Rails::Railtie # :nodoc:
+    railtie_name :arfi
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/arfi/sql_function_loader.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Arfi
+  # +Arfi::SqlFunctionLoader+ is a class which loads user defined SQL functions into database.
+  class SqlFunctionLoader
+    class << self
+      def load!
+        return unless sql_files&.any?
+
+        puts '[ARFI] Loading SQL functions BEFORE schema load transaction...'
+        db_config = Rails.configuration.database_configuration[Rails.env]
+        conn = conn(db_config)
+
+        sql_files&.each do |file|
+          sql = File.read(file).strip
+          conn.exec(sql)
+          puts "[ARFI] Loaded: #{File.basename(file)}"
+        end
+
+        conn.close
+      end
+
+      private
+
+      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']
+        )
+      end
+    end
+  end
+end

data/lib/arfi/tasks/db.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'arfi/sql_function_loader'
+
+namespace :_db do
+  task :arfi_enhance do
+    Arfi::SqlFunctionLoader.load!
+  end
+end
+
+Rake::Task.define_task(:environment) unless Rake::Task.task_defined?(:environment)
+raise UnrecognizedCommandError, 'Warning: db:migrate task not found' unless Rake::Task.task_defined?('db:migrate')
+
+%w[db:migrate db:schema:load db:setup db:prepare].each do |task|
+  Rake::Task[task].enhance(['_db:arfi_enhance']) if Rake::Task.task_defined?(task)
+end

data/lib/arfi/version.rb

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

data/lib/arfi.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'arfi/version'
+require_relative 'arfi/errors'
+require 'arfi/extensions/extensions'
+require 'rails' if defined?(Rails)
+
+# Top level module
+module Arfi
+  require_relative 'arfi/railtie' if defined?(Rails)
+end

data/sig/arfi.rbs

@@ -0,0 +1,2 @@
+module Arfi
+end

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

@@ -0,0 +1,94 @@
+module Arfi
+  module Commands
+    class FIdx < Thor
+      # +Arfi::Commands::FIdx#create+                        -> void
+      #
+      # This command is used to create the functional index.
+      #
+      # @example
+      #   bundle exec arfi f_idx create some_function
+      # @param index_name [String] Name of the index.
+      # @return [void]
+      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby
+      # @raise [Arfi::Errors::NoFunctionsDir] if there is no `db/functions` directory
+      # @see Arfi::Commands::FIdx#validate_schema_format!
+      def create: (string index_name) -> untyped
+
+      # +Arfi::Commands::FIdx#destroy+                        -> void
+      #
+      # This command is used to delete the functional index.
+      #
+      # @example
+      #   bundle exec arfi f_idx destroy some_function [revision index (just an integer, 1 is by default)]
+      # @param index_name [String] Name of the index.
+      # @param revision [String] Revision of the index.
+      # @return [void]
+      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby
+      def destroy: (string index_name, ?::String revision) -> untyped
+
+      private
+
+      # +Arfi::Commands::FIdx#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
+
+      # +Arfi::Commands::FIdx#validate_schema_format!+                        -> void
+      #
+      # Helper method to validate the schema format.
+      #
+      # @!visibility private
+      # @private
+      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby.
+      # @return [nil] if the schema format is valid.
+      def validate_schema_format!: () -> (untyped | nil)
+
+      # +Arfi::Commands::FIdx#build_sql_function+                        -> String
+      #
+      # Helper method to build the SQL function.
+      #
+      # @!visibility private
+      # @private
+      # @param index_name [String] Name of the index.
+      # @return [String] SQL function body.
+      def build_sql_function: (string index_name) -> ::String
+
+      # +Arfi::Commands::FIdx#create_index_file+                        -> void
+      #
+      # Helper method to create the index file.
+      #
+      # @!visibility private
+      # @private
+      # @param index_name [String] Name of the index.
+      # @param content [String] SQL function body.
+      # @return [void]
+      def create_index_file: (string index_name, string content) -> untyped
+
+      # +Arfi::Commands::FIdx#extract_latest_version+                        -> String
+      #
+      # Helper method to extract the latest version of the index.
+      #
+      # @!visibility private
+      # @private
+      # @param files [Array<String>] List of files.
+      # @return [String] Latest version of the index.
+      def extract_latest_version: (Array[String] files) -> string
+
+      # +Arfi::Commands::FIdx#write_file+                        -> void
+      #
+      # Helper method to write the index file.
+      #
+      # @!visibility private
+      # @private
+      # @param index_name [String] Name of the index.
+      # @param content [String] SQL function body.
+      # @param version [Integer] Version of the index.
+      # @return [void]
+      def write_file: (string index_name, string content, ::Integer version) -> untyped
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Arfi
+  module Commands
+    class Project < Thor
+      # @return [void]
+      def create: () -> void
+
+      private
+
+      # @private
+      # @return [Pathname] Path to `db/functions` directory
+      def functions_dir: () -> Pathname
+    end
+  end
+end

data/sig/lib/arfi/errors.rbs

@@ -0,0 +1,15 @@
+module Arfi
+  module Errors
+    class NoFunctionsDir < StandardError
+      @message: string
+
+      def initialize: (?::String message) -> void
+    end
+
+    class InvalidSchemaFormat < StandardError
+      @message: string
+
+      def initialize: (?::String message) -> void
+    end
+  end
+end

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

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

data/sig/lib/arfi/sql_function_loader.rbs

@@ -0,0 +1,19 @@
+module Arfi
+  class SqlFunctionLoader
+    type db_config = {
+        user: String,
+        password: String,
+        host: String,
+        port: Integer,
+        dbname: String
+      }
+
+    def self.load!: () -> (nil | untyped)
+
+    private
+
+    def self.sql_files: () -> (Array[String] | nil)
+
+    def self.conn: (db_config db_config) -> untyped
+  end
+end

data/sig/lib/arfi/version.rbs

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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: arfi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- unurgunite
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Bring the ability to create and maintain functional indexes without transition
+  to structure.sql.
+email:
+- senpaiguru1488@gmail.com
+executables:
+- arfi
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/arfi
+- lib/arfi.rb
+- lib/arfi/Rakefile
+- lib/arfi/cli.rb
+- lib/arfi/commands/f_idx.rb
+- 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/extensions.rb
+- lib/arfi/railtie.rb
+- lib/arfi/sql_function_loader.rb
+- lib/arfi/tasks/db.rake
+- lib/arfi/version.rb
+- sig/arfi.rbs
+- sig/lib/arfi/commands/f_idx.rbs
+- sig/lib/arfi/commands/project.rbs
+- sig/lib/arfi/errors.rbs
+- sig/lib/arfi/extensions/active_record/base.rbs
+- sig/lib/arfi/sql_function_loader.rbs
+- sig/lib/arfi/version.rbs
+homepage: https://github.com/unurgunite/arfi
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/unurgunite/arfi
+  source_code_uri: https://github.com/unurgunite/arfi
+  changelog_uri: https://github.com/unurgunite/arfi/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: ActiveRecord Functional Indexes.
+test_files: []