ARFI

---

! 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
  • Installation
  • Usage
    • CLI
    • Project creation
    • Index creation
    • Index destroy
    • Additional help
  • Development
    • Build from source
  • Requirements
  • Contributing
  • License
  • Code of Conduct

Installation

Install the gem and add to the application's Gemfile by executing:

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:

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	:white_check_mark:
db:setup	:white_check_mark:
db:prepare	:white_check_mark:
db:schema:load	:white_check_mark:

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.

License

The gem is available as open source under the terms of the MIT License.

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.