arfi 0.4.0 → 0.5.0

data/sig/lib/arfi/sql_function_loader.rbs

@@ -0,0 +1,94 @@
+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!: (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
+
+    # +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
+  end
+end

data/sig/lib/arfi/version.rbs

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arfi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  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
@@ -113,24 +113,75 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        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: '1.10'
-description: 'ARFI — ActiveRecord Functional Indexes. Bring the ability to create
-  and maintain functional indexes without transition to structure.sql.
+        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
-executables: []
+executables:
+- arfi
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- 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/connection_adapters/postgresql/database_statements.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
+- 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
 licenses:
 - MIT
@@ -147,7 +198,7 @@ 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:
   - - ">="