arfi 0.4.0 → 0.5.0

data/rbs_collection.lock.yaml

@@ -0,0 +1,452 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: actioncable
+  version: '7.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionmailer
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionpack
+  version: '7.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actiontext
+  version: '7.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: actionview
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activejob
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activemodel
+  version: '7.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activerecord
+  version: '8.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activestorage
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: activesupport
+  version: '7.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: ast
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: base64
+  version: '0.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: benchmark
+  version: '0'
+  source:
+    type: stdlib
+- name: bigdecimal
+  version: '3.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: cgi
+  version: '0'
+  source:
+    type: stdlib
+- name: concurrent-ruby
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: connection_pool
+  version: '2.4'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: csv
+  version: '3.3'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: date
+  version: '0'
+  source:
+    type: stdlib
+- name: delegate
+  version: '0'
+  source:
+    type: stdlib
+- name: diff-lcs
+  version: '1.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: digest
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: ffi
+  version: 1.17.2
+  source:
+    type: rubygems
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: globalid
+  version: '1.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: i18n
+  version: '1.10'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: io-console
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: listen
+  version: '3.9'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: mail
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: marcel
+  version: '1.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: mini_mime
+  version: '0.1'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: minitest
+  version: '5.25'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: 0.3.0
+  source:
+    type: rubygems
+- name: net-protocol
+  version: '0'
+  source:
+    type: stdlib
+- name: net-smtp
+  version: '0.5'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: nokogiri
+  version: '1.11'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: openssl
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: parallel
+  version: '1.20'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: parser
+  version: '3.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: pp
+  version: '0'
+  source:
+    type: stdlib
+- name: prettyprint
+  version: '0'
+  source:
+    type: stdlib
+- name: prism
+  version: 1.4.0
+  source:
+    type: rubygems
+- name: rack
+  version: '2.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-dom-testing
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rails-html-sanitizer
+  version: '1.6'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: railties
+  version: '6.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rainbow
+  version: '3.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rake
+  version: '13.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rbs
+  version: 3.9.4
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: regexp_parser
+  version: '2.8'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: repl_type_completor
+  version: 0.1.11
+  source:
+    type: rubygems
+- name: rubocop
+  version: '1.57'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: rubocop-ast
+  version: '1.30'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: securerandom
+  version: '0'
+  source:
+    type: stdlib
+- name: singleton
+  version: '0'
+  source:
+    type: stdlib
+- name: socket
+  version: '0'
+  source:
+    type: stdlib
+- name: stringio
+  version: '0'
+  source:
+    type: stdlib
+- name: strscan
+  version: '0'
+  source:
+    type: stdlib
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: thor
+  version: '1.2'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: time
+  version: '0'
+  source:
+    type: stdlib
+- name: timeout
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+- name: tzinfo
+  version: '2.0'
+  source:
+    type: git
+    name: ruby/gem_rbs_collection
+    revision: a9830177c3fdbebb92f6db6a166ae3e368818162
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    repo_dir: gems
+- name: uri
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true

data/sig/arfi.rbs

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

data/sig/lib/arfi/cli.rbs

@@ -0,0 +1,6 @@
+module Arfi
+  # Top level CLI class
+  class CLI < Thor
+    def version: -> ::Integer
+  end
+end

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

@@ -0,0 +1,107 @@
+module Arfi
+  module Commands
+    class FIdx < Thor
+      ADAPTERS: Array[Symbol]
+
+      # +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.
+      # @return [void]
+      # @raise [Arfi::Errors::InvalidSchemaFormat] if ActiveRecord.schema_format is not :ruby
+      def destroy: (string index_name) -> untyped
+
+      private
+
+      # +Arfi::Commands::FIdx#build_from_file+                          -> String
+      #
+      # Helper method to build the SQL function. Used with flag `--template`.
+      #
+      # @!visibility private
+      # @private
+      # @param index_name [String] Name of the index.
+      # @return [String] SQL function body.
+      # @see Arfi::Commands::FIdx#create
+      # @see Arfi::Commands::FIdx#build_sql_function
+      def build_from_file: (string index_name) -> String
+
+      # +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_function_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_function_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 [String|Integer] Version of the index.
+      # @return [void]
+      def write_file: (string index_name, ::String content, (::String | ::Integer) version) -> void
+    end
+  end
+end

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

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

data/sig/lib/arfi/errors.rbs

@@ -0,0 +1,21 @@
+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
+
+    class AdapterNotSupported < 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/railtie.rbs

@@ -0,0 +1,4 @@
+module Arfi
+  class Railtie < ::Rails::Railtie
+  end
+end