Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nebulab/rails_console_toolkit
Configurable Rails Console Helpers
https://github.com/nebulab/rails_console_toolkit
console rails solidus toolkit
Last synced: about 2 months ago
JSON representation
Configurable Rails Console Helpers
- Host: GitHub
- URL: https://github.com/nebulab/rails_console_toolkit
- Owner: nebulab
- License: mit
- Created: 2019-06-28T14:49:42.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-31T09:57:57.000Z (about 4 years ago)
- Last Synced: 2024-04-25T04:01:41.949Z (9 months ago)
- Topics: console, rails, solidus, toolkit
- Language: Ruby
- Size: 57.6 KB
- Stars: 20
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# RailsConsoleToolkit 🔧🧰
*Configurable Rails Console Helpers*
Find records faster, add custom helpers, improve your console life by 100%.
[](https://github.com/nebulab/rails_console_toolkit/actions?query=workflow%3Abuild)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'rails_console_toolkit'
```
And then generate the initializer:
```
$ bin/rails generate rails_console_toolkit:install
```
or write it manually:
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
# helper definitions go here...
#
# config.use_pack :aliases
# config.use_pack :utils
# config.use_pack :solidus if defined? Spree
end
```
## Helper packs
### Aliases
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
config.use_pack :aliases
end
```
```
> x # alias exit
> r # alias reload!
```
### Utils
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
config.use_pack :utils
end
```
```
> benchmark("foo") { sleep 3 }
foo (3000.6ms)
=> 3
> bm # alias benchmark
```
### [Solidus](https://solidus.io)
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
config.use_pack :solidus
end
```
```
> load_factories # will load solidus factories, useful to create dummy data in development
> product(...) # => will look for Spree::Product records by :id, :slug, :name
> variant(...) # => will look for Spree::Variant records by :id, :sku
> taxon(...) # => will look for Spree::Taxon records by :id, :permalink
> order(...) # => will look for Spree::Order records by :id, :number
> user(...) # => will look for Spree::User records by :id, :email
> country(...) # => will look for Spree::Country records by :id, :iso, :iso3, :iso_name, :name
```
## Custom Helpers
### Generic helpers
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
config.helper :foo do
:bar
end
end
```
```
# bin/rails console
> foo # => :bar
```
### Aliases
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
config.alias :r, :reload!
end
```
```
# bin/rails console
> r # The same as typing "reload!"
```
### Model helpers
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
config.model_helper 'Spree::Product', as: :product, by: %i[name slug]
end
```
```
# bin/rails console
> product('black-tshirt') # => #
> product.slug # => "black-tshirt"
> product 456 # => #
> product.slug # => "red-tshirt"
```
### Removing unwanted helpers
```ruby
# config/initializers/console.rb
RailsConsoleToolkit.configure do |config|
# Will define an alias :x for "exit"
config.use_pack :aliases
config.remove_helper :x
end
```
```
# bin/rails console
> x # NameError (undefined local variable or method \`x' for main:Object)
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/elia/rails_console_toolkit.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## About
[![Nebulab][nebulab-logo]][nebulab]
This project is funded and maintained by the [Nebulab][nebulab] team.
We firmly believe in the power of open-source. [Contact us][contact-us] if you
like our work and you need help with your project design or development.
[nebulab]: https://nebulab.it/
[nebulab-logo]: https://nebulab.it/assets/images/public/logo.svg
[contact-us]: https://nebulab.it/contact-us/