rails/commands

Run Rake/Rails commands through the console

Commands

Run Rake and Rails commands during a development console session and run tests during a test console session. This side-steps the need to load the entire environment over and over again when you run these commands from the shell. This constant reloading of the environment is what causes slow boot time on big applications. Think of this like a baby Zeus or the Turbolinks of commands.

Installation

Add this line to your application's Gemfile:

gem 'commands'

And then execute:

$ bundle

Usage

When your console boots, it'll automatically have a commander object instantiated. The following methods are delegated to this object: rake, generate, destroy, update. It's used like this:

> generate "scaffold post title:string"
> rake "db:migrate"

To use a persistent console for testing, be sure to first start it in the test environment, like so ./script/rails console test. Then you can run tests like this:

> test "models"
> test "controllers"
> test "models/person"

You can see the options available for all the commands by running them with no parameters.

commands's Issues

db:migrate doesn't reload migration files

After fat fingering a migration file
PG::Error: ERROR: type "stringa" does not exist

I fix the migration, but rake "db:migrate" does not pick up the new corrected file, if running the command again it will either say:

** Invoke db:migrate => "Completed"

or throw the same exception again. I try reload! but it does not help.

When launching the console: uninitialized constant Rails::ConsoleMethods

Once I've added gem 'commands' to my Gemfile, nothing works anymore, everything stops with:
uninitialized constant Rails::ConsoleMethods

Am I doing something wrong? I love the idea of this mini-Zeus.

Stack:

/Users/gamov/.rvm/gems/ruby-1.9.3-p327@ector/gems/commands-0.2.0/lib/commands.rb:4:in `<top (required)>': uninitialized constant Rails::ConsoleMethods (NameError)
    from /Users/gamov/.rvm/gems/ruby-1.9.3-p327@global/gems/bundler-1.1.5/lib/bundler/runtime.rb:68:in `require'

Switching to test env doesn't set options correctly

The reset options don't make it from config.options.active_record to ActiveRecord::Base, says @josevalim.

Add Tester option for rspec/cucumber

I shudder at the thought, but given it's popularity, I guess we should. @nviennot did some work on this for rspec-console that can serve as prior art: https://github.com/nviennot/rspec-console/blob/master/lib/rspec-console/runner.rb

Not Support run a rails server

Ruby 1.8.7 not supported

Unfortunately I can't use commands because my project uses ruby 1.8.7

The problem is the new Hash Syntax.

/XXX/vendor/bundle/gems/backports-3.3.2/lib/backports/tools.rb:328:in 'require_without_backports': /XXX/vendor/bundle/gems/commands-0.2.1/lib/rails/commands/console_delegation.rb:19: syntax error, unexpected ':', expecting kEND (SyntaxError)
      delegate :rake, :generate, :destroy, :update, to: :commander
                                                       ^

rake -T support

doesn't support rake -T. Again more useful for development than anything.

Useful for dev

Could we add a "server" command to bring up webrick (rails s) in background and server stop could stop it. Would be nice to leave it up in one terminal.

Enable running test command in development console

I've got a working implementation of this here: https://github.com/gbuesing/duoconsole

The test environment is forked after loading Rails and gems, so this work only needs to be performed once -- should be a win for apps with lots of gems.

Commands are sent to the test process via a Unix socket -- the implementation is pretty straightforward.

App reloading behavior works as expected. To pick up changes to config/, lib/ and Gemfile, however, you need to exit the console and reload. I've got code in the "reloadable" branch that enables manual reloading of the entire app (excluding gems), but this requires keeping an additional process around, and I'm not yet sure if this is worth it.

Also, this forking fixes issue #13 (Stop sending ActiveRecord logs to STDOUT during test/rake) when running the test command, and fixes Postgres compatibility (re-establishing the AR connection before forking causes an issue.)

Let me know if there's interest in pulling any of this in here -- I'd be happy to create patches.

Watch for file system changes

Hey

I was wondering what option there are to watch for file changes and automatically have my tests run.

Would it make sense to add support for something like test watch from the rails console, or do I have to wire up some logic myself (e.g. by launching something like guard from the rails console?)

Or are there any other issues which prevent this kind of automated integration?

Options passed to rake are ignored

You currently can't pass "--trace" and friends to the rake options. It's a bit tricky because we're reusing the Rake application instance, so if we just load the options from ARGV, they'll be sticky from run to run. Need a way to reset the option list.

Make it easy to use different ORM

Right now we're hard-coded to Active Record for testing setup. Make it easy to plugin other ORMs.

Add Capistrano to Commands

Would be great to be able to use capistrano just like we can use rake directly from the console.

Classes are not being reloaded on test environment

To make test 'unit' work properly I had to change cache_classes to true in Rails 3.2.13, otherwise changes in classes are not detected.

DummyApp::Application.configure do
  # Settings specified here will take precedence over those in config/application.rb

  # The test environment is used exclusively to run your application's
  # test suite. You never need to work with it otherwise. Remember that
  # your test database is "scratch space" for the test suite and is wiped
  # and recreated between test runs. Don't rely on the data there!
  # config.cache_classes = true
  config.cache_classes = false
  ...
end

Seems this case should be handled by https://github.com/rails/commands/blob/master/lib/rails/commands/test_environment.rb#L24-L31 but is not.

Stop sending ActiveRecord logs to STDOUT during test/rake

I can't seem to find how ActiveRecord is sending the log lines both to STDOUT and to the development.log file. But when we're running rake and test, it shouldn't send to STDOUT (because it'll spam it with INSERTS for fixtures etc).