arfi 0.3.1 → 0.5.0

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

@@ -1,6 +1,8 @@
 module Arfi
   module Commands
     class FIdx < Thor
+      ADAPTERS: Array[Symbol]
+
       # +Arfi::Commands::FIdx#create+                        -> void
       #
       # This command is used to create the functional index.
@@ -21,13 +23,24 @@ module Arfi
       # @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
+      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.
@@ -57,7 +70,7 @@ module Arfi
       # @return [String] SQL function body.
       def build_sql_function: (string index_name) -> ::String
 
-      # +Arfi::Commands::FIdx#create_index_file+                        -> void
+      # +Arfi::Commands::FIdx#create_function_file+                        -> void
       #
       # Helper method to create the index file.
       #
@@ -66,7 +79,7 @@ module Arfi
       # @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
+      def create_function_file: (string index_name, ::String content) -> untyped
 
       # +Arfi::Commands::FIdx#extract_latest_version+                        -> String
       #
@@ -76,7 +89,7 @@ module Arfi
       # @private
       # @param files [Array<String>] List of files.
       # @return [String] Latest version of the index.
-      def extract_latest_version: (Array[String] files) -> string
+      def extract_latest_version: (Array[String] files) -> String
 
       # +Arfi::Commands::FIdx#write_file+                        -> void
       #
@@ -86,9 +99,9 @@ module Arfi
       # @private
       # @param index_name [String] Name of the index.
       # @param content [String] SQL function body.
-      # @param version [Integer] Version of the index.
+      # @param version [String|Integer] Version of the index.
       # @return [void]
-      def write_file: (string index_name, string content, ::Integer version) -> untyped
+      def write_file: (string index_name, ::String content, (::String | ::Integer) version) -> void
     end
   end
 end

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

@@ -1,11 +1,25 @@
 module Arfi
   module Commands
-    class Project < Thor
+    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

data/sig/lib/arfi/railtie.rbs

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

data/sig/lib/arfi/sql_function_loader.rbs

@@ -1,14 +1,66 @@
 module Arfi
   # +Arfi::SqlFunctionLoader+ is a class which loads user defined SQL functions into database.
   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!: () -> (nil | untyped)
+    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
 
     private
 

data/sig/lib/arfi/version.rbs

@@ -1,3 +1,3 @@
 module Arfi
-  VERSION: "0.3.1"
+  VERSION: "0.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arfi
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - unurgunite
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,8 +107,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.21'
-description: 'ARFI — ActiveRecord Functional Indexes. Bring the ability to create
-  and maintain functional indexes without transition to structure.sql.
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.37
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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:
@@ -126,6 +155,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - exe/arfi
 - lib/arfi.rb
 - lib/arfi/Rakefile
@@ -140,11 +170,16 @@ files:
 - lib/arfi/sql_function_loader.rb
 - lib/arfi/tasks/db.rake
 - lib/arfi/version.rb
+- rakelib/yard_docs_generator.rake
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
 - sig/arfi.rbs
+- sig/lib/arfi/cli.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/railtie.rbs
 - sig/lib/arfi/sql_function_loader.rbs
 - sig/lib/arfi/version.rbs
 homepage: https://github.com/unurgunite/arfi
@@ -163,14 +198,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: ActiveRecord Functional Indexes.
 test_files: []