rails-four-queueing 0.1.0 → 0.2.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Phil Cohen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,10 +1,22 @@
-# Rails::Four::Queueing
+# rails-four-queueing
 
 [![Build Status](https://secure.travis-ci.org/phlipper/rails-four-queueing.png)](https://next.travis-ci.org/phlipper/rails-four-queueing)
 
 ## Description
 
-It's the Queue from Rails 4, backported to Rails 3.2+ for your Queueing pleasure.
+It's the [Queue from Rails 4](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/queueing.rb), backported to Rails 3.2+ for your Queueing pleasure.
+
+> `Rails.queue` is the application's queue. You can push a job onto the queue by:
+>
+> ```
+> Rails.queue.push job
+> ```
+>
+> A job is an object that responds to `#run`. Queue consumers will pop jobs off of the queue and invoke the queue's `run` method.
+>
+> Note that depending on your queue implementation, jobs may not be executed in the same process as they were created in, and are never executed in the same thread as they were created in.
+>
+> If necessary, a queue implementation may need to serialize your job for distribution to another process. The documentation of your queue will specify the requirements for that serialization
 
 
 ## Requirements
@@ -42,34 +54,90 @@ $ gem install rails-four-queueing
 
 ## Usage
 
-It's the [Rails 4 Queue](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/queueing.rb):
+The following queueing strategies are provided by default:
+
+* `SynchronousQueue`
+* `TestQueue`
+
+The following queue consumer strategies are provided by default:
+
+* `ThreadedQueueConsumer`
+
+The threaded consumer will run jobs in a background thread in development mode or in a VM where running jobs on a thread in production mode makes sense.
+
+When the process exits, the consumer pushes a `nil` onto the queue and joins the thread, which will ensure that all jobs are executed before the process finally dies.
+
+_Note: In this port, classes that live under the `ActiveSupport::` namespace in Rails 4 have been moved to the `Rails::Four::Queueing::` namespace._
+
+### Configuration
+
+Rails will now have the following options available:
+
+* `config.queue`
+* `config.queue_consumer`
+* `config.action_mailer.queue`
+
+These can be customized in `config/application.rb` or by environment:
+
+```ruby
+# config/environments/production.rb
+
+# Default the production mode queue to an synchronous queue. You will probably
+# want to replace this with an out-of-process queueing solution.
+config.queue = Rails::Four::Queue::SynchronousQueue.new
 
+# You will probably want to change the job queue consumer from the default.
+config.queue_consumer = Rails::Four::Queueing::ThreadedQueueConsumer.new
 ```
-Rails.queue is the application's queue. You can push a job onto
-the queue by:
 
-  Rails.queue.push job
 
-A job is an object that responds to +run+. Queue consumers will
-pop jobs off of the queue and invoke the queue's +run+ method.
+### ActionMailer
+
+Mail delivery from ActionMailer can be processed asynchronously using the Rails.queue.
 
-Note that depending on your queue implementation, jobs may not
-be executed in the same process as they were created in, and
-are never executed in the same thread as they were created in.
+By default, ActionMailer will use the application default Rails.queue strategy. This can be configured:
 
-If necessary, a queue implementation may need to serialize your
-job for distribution to another process. The documentation of
-your queue will specify the requirements for that serialization
+```ruby
+# The queue that will be used to deliver the mail. The queue should expect a job
+# that responds to run.
+config.action_mailer.queue = Rails::Four::Queue::SynchronousQueue.new
 ```
 
 
-## Contributing
+### Testing
 
-1. [Fork it](https://github.com/phlipper/rails-four-queueing/fork_select)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. [Create a Pull Request](hhttps://github.com/phlipper/rails-four-queueing/pull/new)
+In test mode, the Rails queue is backed by an Array so that assertions can be made about its contents. The test queue provides a `jobs` method to make assertions about the queue's contents and a `drain` method to drain the queue and run the jobs.
+
+Jobs are run in a separate thread to catch mistakes where code assumes that the job is run in the same thread.
+
+```ruby
+# config/environments/test.rb
+
+config.queue = Rails::Four::Queueing::TestQueue.new
+```
+
+### Alternate Providers
+
+The Rails Queue implementation is designed to be pluggable and you may want to investigate other queue providers, such as:
+
+* [resque-rails](https://github.com/jeremy/resque-rails)
+* [Sidekiq](https://github.com/mperham/sidekiq/tree/rails4)
+
+
+## Resources
+
+The following are some resources from around the Internet which introduce the Rails Queue:
+
+_Note: Many of these are, or will be soon, out of date._
+
+* [Ruby on Rails 4.0 Release Notes](http://edgeguides.rubyonrails.org/4_0_release_notes.html)
+* [Rails 4.0 Sneak Peek: Queueing](http://reefpoints.dockyard.com/ruby/2012/06/25/rails-4-sneak-peek-queueing.html)
+* [New in Rails 4.0: Rails Queue](http://www.3magine.com/blog/new-in-rails-4-0-rails-queue/)
+
+
+## A note on spelling
+
+Yes, there are two spelling options. I defer to research provided by [XKCD](http://xkcd.com/853/).
 
 
 ## Contributors
@@ -77,11 +145,18 @@ your queue will specify the requirements for that serialization
 Many thanks go to the following who have contributed to making this gem even better:
 
 * **[@rails](https://github.com/rails)**
-  * for making this all possible in the first place
+    * for making this all possible in the first place
 * **[@elskwid](https://github.com/elskwid)**
-  * for providing the inspiration, and the persperation, to see this through to the bitter end
-* **[@phlipper](https://github.com/phlipper)**
-  * for providing the inspiration, and the persperation, to see this through to the bitter end
+    * for providing the inspiration, and the persperation, to see this through to the bitter end
+
+
+## Contributing
+
+1. [Fork it](https://github.com/phlipper/rails-four-queueing/fork_select)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. [Create a Pull Request](hhttps://github.com/phlipper/rails-four-queueing/pull/new)
 
 
 ## License

data/lib/rails-four-queueing.rb

@@ -1,3 +1,12 @@
+require "active_support/concern"
+
+$: << File.expand_path("../", __FILE__)
+
+require "rails/four/configuration"
+require "rails/four/application"
+require "rails/four/queueing/queue"
+require "rails/four/action_mailer/queued_message"
+
 require "rails/four/queueing/engine"
 
 module Rails

data/lib/rails/four/action_mailer/queued_message.rb

@@ -0,0 +1,42 @@
+# Original File: RAILS_ROOT/actionmailer/lib/action_mailer/queued_message.rb
+require 'delegate'
+
+module Rails
+  module Four
+    module ActionMailer
+      class QueuedMessage < ::Delegator
+        attr_reader :queue
+
+        def initialize(queue, mailer_class, method_name, *args)
+          @queue = queue
+          @job   = DeliveryJob.new(mailer_class, method_name, args)
+        end
+
+        def __getobj__
+          @job.message
+        end
+
+        # Queues the message for delivery.
+        def deliver
+          tap { @queue.push @job }
+        end
+
+        class DeliveryJob
+          def initialize(mailer_class, method_name, args)
+            @mailer_class = mailer_class
+            @method_name  = method_name
+            @args         = args
+          end
+
+          def message
+            @message ||= @mailer_class.send(:new, @method_name, *@args).message
+          end
+
+          def run
+            message.deliver
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/four/application.rb

@@ -1,7 +1,7 @@
 module Rails
   module Four
     module Application
-      extend ActiveSupport::Concern
+      extend ::ActiveSupport::Concern
 
       included do
         attr_accessor :queue_consumer

data/lib/rails/four/configuration.rb

@@ -1,7 +1,7 @@
 module Rails
   module Four
     module Configuration
-      extend ActiveSupport::Concern
+      extend ::ActiveSupport::Concern
 
       included do
         attr_accessor :queue, :queue_consumer

data/lib/rails/four/queueing/engine.rb

@@ -1,6 +1,4 @@
 require "rails"
-require "rails/four/configuration"
-require "rails/four/application"
 
 module Rails
   module Four
@@ -24,9 +22,7 @@ module Rails
         # initialize the configuration instance queue if needed
         config.after_initialize do |app|
           unless app.config.instance_variable_get(:"@queue")
-            app.config.instance_variable_set(
-              :"@queue", Rails::Four::Queueing::SynchronousQueue.new
-            )
+            app.config.instance_variable_set(:"@queue", SynchronousQueue.new)
           end
         end
 
@@ -34,16 +30,34 @@ module Rails
         # copied from: railties/lib/rails/application/finisher.rb
         initializer :activate_queue_consumer, after: "finisher_hook" do |app|
           if app.config.queue.class == Rails::Four::Queueing::Queue
-            app.queue_consumer = app.config.queue_consumer ||
-                                 app.config.queue.consumer
-            if app.queue_consumer.respond_to?(:logger=)
-              app.queue_consumer.logger ||= Rails.logger
-            end
+            app.queue_consumer = app.config.queue_consumer || app.config.queue.consumer
+            app.queue_consumer.logger ||= Rails.logger if app.queue_consumer.respond_to?(:logger=)
             app.queue_consumer.start
             at_exit { app.queue_consumer.shutdown }
           end
         end
 
+        # initialize ActionMailer queue configuration
+        config.after_initialize do |app|
+          app.config.action_mailer.queue ||= app.queue
+        end
+
+        # enable ActionMailer queued delivery
+        ::ActiveSupport.on_load :action_mailer do
+          class_attribute :queue
+          self.queue = Rails::Four::Queueing::SynchronousQueue.new
+
+          # override default implementation to provide a QueuedMessage
+          # copied from Rails 4
+          def self.method_missing(method_name, *args)
+            if action_methods.include?(method_name.to_s)
+              Rails::Four::ActionMailer::QueuedMessage.new(queue, self, method_name, *args)
+            else
+              super
+            end
+          end
+        end
+
       end
     end
   end

data/lib/rails/four/queueing/queue.rb

@@ -0,0 +1,110 @@
+# Original File: RAILS_ROOT/activesupport/lib/active_support/queueing.rb
+require "delegate"
+require "thread"
+
+module Rails
+  module Four
+    module Queueing
+      # A Queue that simply inherits from STDLIB's Queue. When this
+      # queue is used, Rails automatically starts a job runner in a
+      # background thread.
+      class Queue < ::Queue
+        attr_writer :consumer
+
+        def initialize(consumer_options = {})
+          super()
+          @consumer_options = consumer_options
+        end
+
+        def consumer
+          @consumer ||= ThreadedQueueConsumer.new(self, @consumer_options)
+        end
+
+        # Drain the queue, running all jobs in a different thread. This method
+        # may not be available on production queues.
+        def drain
+          # run the jobs in a separate thread so assumptions of synchronous
+          # jobs are caught in test mode.
+          consumer.drain
+        end
+      end
+
+      class SynchronousQueue < Queue
+        def push(job)
+          super.tap { drain }
+        end
+        alias <<  push
+        alias enq push
+      end
+
+      # In test mode, the Rails queue is backed by an Array so that assertions
+      # can be made about its contents. The test queue provides a +jobs+
+      # method to make assertions about the queue's contents and a +drain+
+      # method to drain the queue and run the jobs.
+      #
+      # Jobs are run in a separate thread to catch mistakes where code
+      # assumes that the job is run in the same thread.
+      class TestQueue < Queue
+        # Get a list of the jobs off this queue. This method may not be
+        # available on production queues.
+        def jobs
+          @que.dup
+        end
+
+        # Marshal and unmarshal job before pushing it onto the queue.  This will
+        # raise an exception on any attempts in tests to push jobs that can't (or
+        # shouldn't) be marshalled.
+        def push(job)
+          super Marshal.load(Marshal.dump(job))
+        end
+      end
+
+      # The threaded consumer will run jobs in a background thread in
+      # development mode or in a VM where running jobs on a thread in
+      # production mode makes sense.
+      #
+      # When the process exits, the consumer pushes a nil onto the
+      # queue and joins the thread, which will ensure that all jobs
+      # are executed before the process finally dies.
+      class ThreadedQueueConsumer
+        attr_accessor :logger
+
+        def initialize(queue, options = {})
+          @queue = queue
+          @logger = options[:logger]
+          @fallback_logger = Logger.new($stderr)
+        end
+
+        def start
+          @thread = Thread.new { consume }
+          self
+        end
+
+        def shutdown
+          @queue.push nil
+          @thread.join
+        end
+
+        def drain
+          @queue.pop.run until @queue.empty?
+        end
+
+        def consume
+          while job = @queue.pop
+            run job
+          end
+        end
+
+        def run(job)
+          job.run
+        rescue Exception => exception
+          handle_exception job, exception
+        end
+
+        def handle_exception(job, exception)
+          (logger || @fallback_logger).error "Job Error: #{job.inspect}\n#{exception.message}\n#{exception.backtrace.join("\n")}"
+        end
+      end
+    end
+  end
+end

data/lib/rails/four/queueing/version.rb

@@ -1,7 +1,7 @@
 module Rails
   module Four
     module Queueing
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/test/fixtures/async_mailer/welcome.erb

@@ -0,0 +1 @@
+Welcome

data/test/rails/four/actionmailer/base_test.rb

@@ -0,0 +1,22 @@
+# Original File: RAILS_ROOT/actionmailer/test/base_test.rb
+require "support/action_mailer_abstract_unit"
+require "rails-four-queueing"
+require "support/mailers"
+
+class BaseTest < ActiveSupport::TestCase
+  def teardown
+    ActionMailer::Base.asset_host = nil
+    ActionMailer::Base.assets_dir = nil
+  end
+
+  test "delivering message asynchronously" do
+    AsyncMailer.delivery_method = :test
+    AsyncMailer.deliveries.clear
+
+    AsyncMailer.welcome.deliver
+    assert_equal 0, AsyncMailer.deliveries.length
+
+    AsyncMailer.queue.drain
+    assert_equal 1, AsyncMailer.deliveries.length
+  end
+end

data/test/rails/four/queueing/synchronous_queue_test.rb

@@ -1,6 +1,6 @@
 # Original File: RAILS_ROOT/activesupport/test/queueing/synchronous_queue_test.rb
 require "support/active_support_abstract_unit"
-require "rails/four/queueing"
+require "rails-four-queueing"
 
 class SynchronousQueueTest < ActiveSupport::TestCase
   class Job

data/test/rails/four/queueing/test_queue_test.rb

@@ -1,6 +1,6 @@
 # Original File: RAILS_ROOT/activesupport/test/queueing/test_queue_test.rb
 require "support/active_support_abstract_unit"
-require "rails/four/queueing"
+require "rails-four-queueing"
 
 class TestQueueTest < ActiveSupport::TestCase
   def setup

data/test/rails/four/queueing/threaded_consumer_test.rb

@@ -1,6 +1,6 @@
 # Original File: RAILS_ROOT/activesupport/test/queueing/threaded_consumer_test.rb
 require "support/active_support_abstract_unit"
-require "rails/four/queueing"
+require "rails-four-queueing"
 require "active_support/log_subscriber/test_helper"
 
 class TestThreadConsumer < ActiveSupport::TestCase

data/test/rails/frameworks_test.rb

@@ -0,0 +1,35 @@
+require "support/isolation_abstract_unit"
+require 'set'
+
+module ApplicationTests
+  class FrameworksTest < ActiveSupport::TestCase
+    include ActiveSupport::Testing::Isolation
+
+    def setup
+      build_app
+      boot_rails
+      FileUtils.rm_rf "#{app_path}/config/environments"
+    end
+
+    def teardown
+      teardown_app
+    end
+
+    test "uses the default queue for ActionMailer" do
+      require "#{app_path}/config/environment"
+      assert_kind_of Rails::Four::Queueing::Queue, ActionMailer::Base.queue
+    end
+
+    test "allows me to configure queue for ActionMailer" do
+      app_file "config/environments/development.rb", <<-RUBY
+        AppTemplate::Application.configure do
+          config.action_mailer.queue = Rails::Four::Queueing::TestQueue.new
+        end
+      RUBY
+
+      require "#{app_path}/config/environment"
+      assert_kind_of Rails::Four::Queueing::TestQueue, ActionMailer::Base.queue
+    end
+
+  end
+end

data/test/rails/queue_test.rb

@@ -3,23 +3,6 @@ require "support/isolation_abstract_unit"
 class QueueTest < ActiveSupport::TestCase
   include ActiveSupport::Testing::Isolation
 
-  # overwrite the default `build_app` method to inject the gem for testing
-  def build_app
-    super
-
-    # inject the path to the gem we're testing
-    environment = File.read("#{app_path}/config/application.rb")
-    if environment =~ /(module AppTemplate)/
-      rails_four_queueing_path = File.expand_path(
-        "../../../lib/rails-four-queueing", __FILE__
-      )
-      File.open("#{app_path}/config/application.rb", 'w') do |f|
-        # BOOYA!!
-        f.puts $` + %Q(\nrequire "#{rails_four_queueing_path}"\n) + $1 + $'
-      end
-    end
-  end
-
   def setup
     build_app
     boot_rails

data/test/support/action_mailer_abstract_unit.rb

@@ -0,0 +1,65 @@
+# Original File: RAILS_ROOT/actionmailer/test/abstract_unit.rb
+require File.expand_path('../../../../rails/load_paths', __FILE__)
+require 'active_support/core_ext/kernel/reporting'
+
+# These are the normal settings that will be set up by Railties
+# TODO: Have these tests support other combinations of these values
+silence_warnings do
+  Encoding.default_internal = "UTF-8"
+  Encoding.default_external = "UTF-8"
+end
+
+require 'minitest/autorun'
+require 'action_mailer'
+require 'action_mailer/test_case'
+require "rails-four-queueing"
+
+silence_warnings do
+  # These external dependencies have warnings :/
+  require 'mail'
+end
+
+# Show backtraces for deprecated behavior for quicker cleanup.
+ActiveSupport::Deprecation.debug = true
+
+# Bogus template processors
+ActionView::Template.register_template_handler :haml, lambda { |template| "Look its HAML!".inspect }
+ActionView::Template.register_template_handler :bak, lambda { |template| "Lame backup".inspect }
+
+FIXTURE_LOAD_PATH = File.expand_path('../fixtures', File.dirname(__FILE__))
+ActionMailer::Base.view_paths = FIXTURE_LOAD_PATH
+
+class MockSMTP
+  def self.deliveries
+    @@deliveries
+  end
+
+  def initialize
+    @@deliveries = []
+  end
+
+  def sendmail(mail, from, to)
+    @@deliveries << [mail, from, to]
+  end
+
+  def start(*args)
+    yield self
+  end
+end
+
+class Net::SMTP
+  def self.new(*args)
+    MockSMTP.new
+  end
+end
+
+def set_delivery_method(method)
+  @old_delivery_method = ActionMailer::Base.delivery_method
+  ActionMailer::Base.delivery_method = method
+end
+
+def restore_delivery_method
+  ActionMailer::Base.delivery_method = @old_delivery_method
+end
+
+ActiveSupport::Deprecation.silenced = true

data/test/support/isolation_abstract_unit.rb

@@ -23,6 +23,23 @@ require 'tmpdir'
 
 module TestHelpers
   module Paths
+    # overwrite the default `build_app` method to inject the gem for testing
+    def build_app
+      super
+
+      # inject the path to the gem we're testing
+      environment = File.read("#{app_path}/config/application.rb")
+      if environment =~ /(module AppTemplate)/
+        rails_four_queueing_path = File.expand_path(
+          "../../../../lib/rails-four-queueing", __FILE__
+        )
+        File.open("#{app_path}/config/application.rb", 'w') do |f|
+          f.puts $` + %Q(\nrequire "#{rails_four_queueing_path}"\n) + $1 + $'
+        end
+      end
+    end
+
+
     def app_template_path
       File.join Dir.tmpdir, 'app_template'
     end

data/test/support/mailers.rb

@@ -0,0 +1,18 @@
+# Original File: RAILS_ROOT/actionmailer/test/mailers/base_mailer.rb
+class BaseMailer < ActionMailer::Base
+  self.mailer_name = "base_mailer"
+
+  default to: 'system@test.lindsaar.net',
+          from: 'jose@test.plataformatec.com',
+          reply_to: 'mikel@test.lindsaar.net'
+
+  def welcome(hash = {})
+    headers['X-SPAM'] = "Not SPAM"
+    mail({subject: "The first email on new API!"}.merge!(hash))
+  end
+end
+
+# Original File: RAILS_ROOT/actionmailer/test/mailers/async_mailer.rb
+class AsyncMailer < BaseMailer
+  self.queue = Rails::Four::Queueing::TestQueue.new
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-four-queueing
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,26 +37,30 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/rails/four/action_mailer/queued_message.rb
 - lib/rails/four/application.rb
 - lib/rails/four/configuration.rb
 - lib/rails/four/queueing/engine.rb
+- lib/rails/four/queueing/queue.rb
 - lib/rails/four/queueing/version.rb
-- lib/rails/four/queueing.rb
 - lib/rails-four-queueing.rb
-- lib/tasks/rails-four-queueing_tasks.rake
 - MIT-LICENSE
 - Rakefile
 - README.md
 - test/ci/before_script.sh
+- test/fixtures/async_mailer/welcome.erb
+- test/rails/four/actionmailer/base_test.rb
 - test/rails/four/queueing/synchronous_queue_test.rb
 - test/rails/four/queueing/test_queue_test.rb
 - test/rails/four/queueing/threaded_consumer_test.rb
-- test/rails/initializers/frameworks_test.rb
+- test/rails/frameworks_test.rb
 - test/rails/queue_test.rb
 - test/rails-four-queueing_test.rb
+- test/support/action_mailer_abstract_unit.rb
 - test/support/active_support_abstract_unit.rb
 - test/support/empty_bool.rb
 - test/support/isolation_abstract_unit.rb
+- test/support/mailers.rb
 homepage: http://phlippers.net/rails-four-queueing
 licenses: []
 post_install_message: 
@@ -71,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2226372685420353224
+      hash: -2324722735646449586
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -80,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2226372685420353224
+      hash: -2324722735646449586
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -89,12 +93,16 @@ specification_version: 3
 summary: It's the Queue from Rails 4, backported to Rails 3.2+ for your Queueing pleasure.
 test_files:
 - test/ci/before_script.sh
+- test/fixtures/async_mailer/welcome.erb
+- test/rails/four/actionmailer/base_test.rb
 - test/rails/four/queueing/synchronous_queue_test.rb
 - test/rails/four/queueing/test_queue_test.rb
 - test/rails/four/queueing/threaded_consumer_test.rb
-- test/rails/initializers/frameworks_test.rb
+- test/rails/frameworks_test.rb
 - test/rails/queue_test.rb
 - test/rails-four-queueing_test.rb
+- test/support/action_mailer_abstract_unit.rb
 - test/support/active_support_abstract_unit.rb
 - test/support/empty_bool.rb
 - test/support/isolation_abstract_unit.rb
+- test/support/mailers.rb

data/lib/rails/four/queueing.rb

@@ -1,106 +0,0 @@
-# Original File: RAILS_ROOT/activesupport/lib/active_support/queueing.rb
-require "delegate"
-require "thread"
-
-module Rails::Four::Queueing
-  # A Queue that simply inherits from STDLIB's Queue. When this
-  # queue is used, Rails automatically starts a job runner in a
-  # background thread.
-  class Queue < ::Queue
-    attr_writer :consumer
-
-    def initialize(consumer_options = {})
-      super()
-      @consumer_options = consumer_options
-    end
-
-    def consumer
-      @consumer ||= ThreadedQueueConsumer.new(self, @consumer_options)
-    end
-
-    # Drain the queue, running all jobs in a different thread. This method
-    # may not be available on production queues.
-    def drain
-      # run the jobs in a separate thread so assumptions of synchronous
-      # jobs are caught in test mode.
-      consumer.drain
-    end
-  end
-
-  class SynchronousQueue < Queue
-    def push(job)
-      super.tap { drain }
-    end
-    alias <<  push
-    alias enq push
-  end
-
-  # In test mode, the Rails queue is backed by an Array so that assertions
-  # can be made about its contents. The test queue provides a +jobs+
-  # method to make assertions about the queue's contents and a +drain+
-  # method to drain the queue and run the jobs.
-  #
-  # Jobs are run in a separate thread to catch mistakes where code
-  # assumes that the job is run in the same thread.
-  class TestQueue < Queue
-    # Get a list of the jobs off this queue. This method may not be
-    # available on production queues.
-    def jobs
-      @que.dup
-    end
-
-    # Marshal and unmarshal job before pushing it onto the queue.  This will
-    # raise an exception on any attempts in tests to push jobs that can't (or
-    # shouldn't) be marshalled.
-    def push(job)
-      super Marshal.load(Marshal.dump(job))
-    end
-  end
-
-  # The threaded consumer will run jobs in a background thread in
-  # development mode or in a VM where running jobs on a thread in
-  # production mode makes sense.
-  #
-  # When the process exits, the consumer pushes a nil onto the
-  # queue and joins the thread, which will ensure that all jobs
-  # are executed before the process finally dies.
-  class ThreadedQueueConsumer
-    attr_accessor :logger
-
-    def initialize(queue, options = {})
-      @queue = queue
-      @logger = options[:logger]
-      @fallback_logger = Logger.new($stderr)
-    end
-
-    def start
-      @thread = Thread.new { consume }
-      self
-    end
-
-    def shutdown
-      @queue.push nil
-      @thread.join
-    end
-
-    def drain
-      @queue.pop.run until @queue.empty?
-    end
-
-    def consume
-      while job = @queue.pop
-        run job
-      end
-    end
-
-    def run(job)
-      job.run
-    rescue Exception => exception
-      handle_exception job, exception
-    end
-
-    def handle_exception(job, exception)
-      (logger || @fallback_logger).error "Job Error: #{job.inspect}\n#{exception.message}\n#{exception.backtrace.join("\n")}"
-    end
-  end
-end

data/lib/tasks/rails-four-queueing_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :rails-four-queueing do
-#   # Task goes here
-# end

data/test/rails/initializers/frameworks_test.rb

@@ -1,247 +0,0 @@
-# require "isolation/abstract_unit"
-# require 'set'
-
-# module ApplicationTests
-#   class FrameworksTest < ActiveSupport::TestCase
-#     include ActiveSupport::Testing::Isolation
-
-#     def setup
-#       build_app
-#       boot_rails
-#       FileUtils.rm_rf "#{app_path}/config/environments"
-#     end
-
-#     def teardown
-#       teardown_app
-#     end
-
-#     # AC & AM
-#     test "set load paths set only if action controller or action mailer are in use" do
-#       assert_nothing_raised NameError do
-#         add_to_config <<-RUBY
-#           config.root = "#{app_path}"
-#         RUBY
-
-#         use_frameworks []
-#         require "#{app_path}/config/environment"
-#       end
-#     end
-
-#     test "sets action_controller and action_mailer load paths" do
-#       add_to_config <<-RUBY
-#         config.root = "#{app_path}"
-#       RUBY
-
-#       require "#{app_path}/config/environment"
-
-#       expanded_path = File.expand_path("app/views", app_path)
-#       assert_equal ActionController::Base.view_paths[0].to_s, expanded_path
-#       assert_equal ActionMailer::Base.view_paths[0].to_s, expanded_path
-#     end
-
-#     test "allows me to configure default url options for ActionMailer" do
-#       app_file "config/environments/development.rb", <<-RUBY
-#         AppTemplate::Application.configure do
-#           config.action_mailer.default_url_options = { :host => "test.rails" }
-#         end
-#       RUBY
-
-#       require "#{app_path}/config/environment"
-#       assert_equal "test.rails", ActionMailer::Base.default_url_options[:host]
-#     end
-
-#     test "uses the default queue for ActionMailer" do
-#       require "#{app_path}/config/environment"
-#       assert_kind_of ActiveSupport::Queue, ActionMailer::Base.queue
-#     end
-
-#     test "allows me to configure queue for ActionMailer" do
-#       app_file "config/environments/development.rb", <<-RUBY
-#         AppTemplate::Application.configure do
-#           config.action_mailer.queue = ActiveSupport::TestQueue.new
-#         end
-#       RUBY
-
-#       require "#{app_path}/config/environment"
-#       assert_kind_of ActiveSupport::TestQueue, ActionMailer::Base.queue
-#     end
-
-#     test "does not include url helpers as action methods" do
-#       app_file "config/routes.rb", <<-RUBY
-#         AppTemplate::Application.routes.draw do
-#           get "/foo", :to => lambda { |env| [200, {}, []] }, :as => :foo
-#         end
-#       RUBY
-
-#       app_file "app/mailers/foo.rb", <<-RUBY
-#         class Foo < ActionMailer::Base
-#           def notify
-#           end
-#         end
-#       RUBY
-
-#       require "#{app_path}/config/environment"
-#       assert Foo.method_defined?(:foo_path)
-#       assert Foo.method_defined?(:main_app)
-#       assert_equal Set.new(["notify"]), Foo.action_methods
-#     end
-
-#     test "allows to not load all helpers for controllers" do
-#       add_to_config "config.action_controller.include_all_helpers = false"
-
-#       app_file "app/controllers/application_controller.rb", <<-RUBY
-#         class ApplicationController < ActionController::Base
-#         end
-#       RUBY
-
-#       app_file "app/controllers/foo_controller.rb", <<-RUBY
-#         class FooController < ApplicationController
-#           def included_helpers
-#             render :inline => "<%= from_app_helper -%> <%= from_foo_helper %>"
-#           end
-
-#           def not_included_helper
-#             render :inline => "<%= respond_to?(:from_bar_helper) -%>"
-#           end
-#         end
-#       RUBY
-
-#       app_file "app/helpers/application_helper.rb", <<-RUBY
-#         module ApplicationHelper
-#           def from_app_helper
-#             "from_app_helper"
-#           end
-#         end
-#       RUBY
-
-#       app_file "app/helpers/foo_helper.rb", <<-RUBY
-#         module FooHelper
-#           def from_foo_helper
-#             "from_foo_helper"
-#           end
-#         end
-#       RUBY
-
-#       app_file "app/helpers/bar_helper.rb", <<-RUBY
-#         module BarHelper
-#           def from_bar_helper
-#             "from_bar_helper"
-#           end
-#         end
-#       RUBY
-
-#       app_file "config/routes.rb", <<-RUBY
-#         AppTemplate::Application.routes.draw do
-#           get "/:controller(/:action)"
-#         end
-#       RUBY
-
-#       require 'rack/test'
-#       extend Rack::Test::Methods
-
-#       get "/foo/included_helpers"
-#       assert_equal "from_app_helper from_foo_helper", last_response.body
-
-#       get "/foo/not_included_helper"
-#       assert_equal "false", last_response.body
-#     end
-
-#     # AD
-#     test "action_dispatch extensions are applied to ActionDispatch" do
-#       add_to_config "config.action_dispatch.tld_length = 2"
-#       require "#{app_path}/config/environment"
-#       assert_equal 2, ActionDispatch::Http::URL.tld_length
-#     end
-
-#     test "assignment config.encoding to default_charset" do
-#       charset = 'Shift_JIS'
-#       add_to_config "config.encoding = '#{charset}'"
-#       require "#{app_path}/config/environment"
-#       assert_equal charset, ActionDispatch::Response.default_charset
-#     end
-
-#     # AS
-#     test "if there's no config.active_support.bare, all of ActiveSupport is required" do
-#       use_frameworks []
-#       require "#{app_path}/config/environment"
-#       assert_nothing_raised { [1,2,3].sample }
-#     end
-
-#     test "config.active_support.bare does not require all of ActiveSupport" do
-#       add_to_config "config.active_support.bare = true"
-
-#       use_frameworks []
-
-#       Dir.chdir("#{app_path}/app") do
-#         require "#{app_path}/config/environment"
-#         assert_raises(NoMethodError) { "hello".exclude? "lo" }
-#       end
-#     end
-
-#     # AR
-#     test "active_record extensions are applied to ActiveRecord" do
-#       add_to_config "config.active_record.table_name_prefix = 'tbl_'"
-#       require "#{app_path}/config/environment"
-#       assert_equal 'tbl_', ActiveRecord::Base.table_name_prefix
-#     end
-
-#     test "database middleware doesn't initialize when activerecord is not in frameworks" do
-#       use_frameworks []
-#       require "#{app_path}/config/environment"
-#       assert_nil defined?(ActiveRecord::Base)
-#     end
-
-#     test "use schema cache dump" do
-#       Dir.chdir(app_path) do
-#         `rails generate model post title:string;
-#          bundle exec rake db:migrate db:schema:cache:dump`
-#       end
-#       require "#{app_path}/config/environment"
-#       ActiveRecord::Base.connection.drop_table("posts") # force drop posts table for test.
-#       assert ActiveRecord::Base.connection.schema_cache.tables["posts"]
-#     end
-
-#     test "expire schema cache dump" do
-#       Dir.chdir(app_path) do
-#         `rails generate model post title:string;
-#          bundle exec rake db:migrate db:schema:cache:dump db:rollback`
-#       end
-#       silence_warnings {
-#         require "#{app_path}/config/environment"
-#         assert !ActiveRecord::Base.connection.schema_cache.tables["posts"]
-#       }
-#     end
-
-#     test "active record establish_connection uses Rails.env if DATABASE_URL is not set" do
-#       begin
-#         require "#{app_path}/config/environment"
-#         orig_database_url = ENV.delete("DATABASE_URL")
-#         orig_rails_env, Rails.env = Rails.env, 'development'
-#         ActiveRecord::Base.establish_connection
-#         assert ActiveRecord::Base.connection
-#         assert_match /#{ActiveRecord::Base.configurations[Rails.env]['database']}/, ActiveRecord::Base.connection_config[:database]
-#       ensure
-#         ActiveRecord::Base.remove_connection
-#         ENV["DATABASE_URL"] = orig_database_url if orig_database_url
-#         Rails.env = orig_rails_env if orig_rails_env
-#       end
-#     end
-
-#     test "active record establish_connection uses DATABASE_URL even if Rails.env is set" do
-#       begin
-#         require "#{app_path}/config/environment"
-#         orig_database_url = ENV.delete("DATABASE_URL")
-#         orig_rails_env, Rails.env = Rails.env, 'development'
-#         database_url_db_name = "db/database_url_db.sqlite3"
-#         ENV["DATABASE_URL"] = "sqlite3://:@localhost/#{database_url_db_name}"
-#         ActiveRecord::Base.establish_connection
-#         assert ActiveRecord::Base.connection
-#         assert_match /#{database_url_db_name}/, ActiveRecord::Base.connection_config[:database]
-#       ensure
-#         ActiveRecord::Base.remove_connection
-#         ENV["DATABASE_URL"] = orig_database_url if orig_database_url
-#         Rails.env = orig_rails_env if orig_rails_env
-#       end
-#     end
-#   end
-# end