Giter Club home page Giter Club logo

better_index_name's Introduction

BetterIndexName

Adds a little smarts to ActiveRecords index name generation to try and fit them into 63 characters or less for Postgres and MySQL.

Tries in the following ways:

  • change polymorphic references to just the name of the relation
    • e.g. relation_type_and_relation_id becomes relation
  • change index_ to ix_
  • remove common strings from column names
    • e.g. field_id_1_and_field_id_2 becomes id_1_and_id_2
  • remove leading parts of the table name until there's only one
    • e.g. very_long_table_of_items becomes long_table_of_items, then table_of_items, then of_items, then items until it fits
  • change the column names used in the index to a hash
  • change the table name to a hash if shorter The end. If it's still too long, you'll have to name it manually

Installation

Add this line to your application's Gemfile:

gem "better_index_name"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install better_index_name

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bsharpe/better_index_name. 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 BetterIndexName project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

better_index_name's People

Contributors

bsharpe avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.