Merge pull request #134 from senny/rails_integration

better Rails integration

Author: senny

lib/generators/queue_classic/install_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'active_record'
+
+module QC
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    namespace "queue_classic:install"
+    self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+    desc 'Generates (but does not run) a migration to add a queue_classic table.'
+
+    def self.next_migration_number(dirname)
+      next_migration_number = current_migration_number(dirname) + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+
+    def create_migration_file
+      migration_template 'add_queue_classic.rb', 'db/migrate/add_queue_classic.rb'
+    end
+  end
+end

lib/generators/queue_classic/templates/add_queue_classic.rb

@@ -0,0 +1,9 @@
+class AddQueueClassic < ActiveRecord::Migration
+  def self.up
+    QC::Setup.create
+  end
+
+  def self.down
+    QC::Setup.drop
+  end
+end

lib/queue_classic.rb

@@ -83,3 +83,4 @@ def self.log(data)
 require "queue_classic/queue"
 require "queue_classic/worker"
 require "queue_classic/setup"
+require "queue_classic/railtie" if defined?(Rails)

lib/queue_classic/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails/railtie'
+
+module QC
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load 'queue_classic/tasks.rb'
+    end
+  end
+end

readme.md

@@ -132,35 +132,22 @@ source "http://rubygems.org"
 gem "queue_classic", "2.2.0"
 ```
 
-Require these files in your Rakefile so that you can run `rake qc:work`.
-
-```ruby
-require "queue_classic"
-require "queue_classic/tasks"
-```
-
 By default, queue_classic will use the QC_DATABASE_URL falling back on DATABASE_URL. The URL must be in the following format: `postgres://username:password@localhost/database_name`.  If you use Heroku's PostgreSQL service, this will already be set. If you don't want to set this variable, you can set the connection in an initializer. **QueueClassic will maintain its own connection to the database.** This may double the number of connections to your database. Set QC::Conn.connection to share the connection between Rails & QueueClassic
 
 ```ruby
 require 'queue_classic'
 QC::Conn.connection = ActiveRecord::Base.connection.raw_connection
 ```
 
-**Note on using ActiveRecord migrations:** If you use the migration, and you wish to use commands that reset the database from the stored schema (e.g. `rake db:reset`), your application must be configured with `config.active_record.schema_format = :sql` in `config/application.rb`.  If you don't do this, the PL/pgSQL function that queue_classic creates will be lost when you reset the database.
+Next you need to run the queue classic generator to create the database
+migration. This will setup the necessary table to use queue classic.
 
-```ruby
-require 'queue_classic'
-
-class AddQueueClassic < ActiveRecord::Migration
-  def self.up
-    QC::Setup.create
-  end
-
-  def self.down
-    QC::Setup.drop
-  end
-end
 ```
+rails generate queue_classic:install
+rake db:migrate
+```
+
+**Note on using ActiveRecord migrations:** If you use the migration, and you wish to use commands that reset the database from the stored schema (e.g. `rake db:reset`), your application must be configured with `config.active_record.schema_format = :sql` in `config/application.rb`.  If you don't do this, the PL/pgSQL function that queue_classic creates will be lost when you reset the database.
 
 ### Rake Task Setup