adzap-ar_mailer 2.0.2 → 2.1.0

data/History.txt

@@ -1,3 +1,7 @@
+= 2.1.0
+
+* Switched to using a Rails generator for migration and model files. The ar_sendmail options have been removed.
+
 = 2.0.2
 
 * Bugs fixed

data/README.rdoc

@@ -54,22 +54,24 @@ Go to your Rails project:
 
   $ cd your_rails_project
 
-Create a new migration:
+Create the migration and model:
 
-  $ ar_sendmail --create-migration
+This shows the options which are only the model name, which defaults to Email
 
-You'll need to redirect this into a file.  If you want a different name
-provide the --table-name option.
+  ./script/generate ar_mailer -h
 
-Create a new model:
+Then run with defaults
 
-  $ ar_sendmail --create-model
+  ./script/generate ar_mailer
 
-You'll need to redirect this into a file.  If you want a different name
-provide the --table-name option.
+Or specify a custom model name
 
-You'll need to be sure to set the From address for your emails.  Something
-like:
+  ./script/generate ar_mailer Newsletter
+
+See Alternate Mail Storage if you use a custom model name
+
+In your mailer class methods you must be sure to set the From address for your emails.
+Something like:
 
   def list_send(recipient)
     from 'no_reply@example.com'
@@ -101,8 +103,11 @@ See <tt>ar_sendmail -h</tt> for full details.
 
 === Alternate Mail Storage
 
-If you want to set the ActiveRecord model that emails will be stored in,
-see ActionMailer::Base.email_class=
+By default ar_mailer assumes you are using an ActiveRecord model called
+Email to store the emails created before sending. If you want to change
+this you alter it in an intializer like so:
+
+  ActionMailer::Base.email_class = Newsletter
 
 === A Word on TLS
 

data/lib/action_mailer/ar_sendmail.rb

@@ -37,16 +37,13 @@ module ActionMailer; end # :nodoc:
 # The interesting options are:
 # * --daemon
 # * --mailq
-# * --create-migration
-# * --create-model
-# * --table-name
 
 class ActionMailer::ARSendmail
 
   ##
   # The version of ActionMailer::ARSendmail you are running.
 
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 
   ##
   # Maximum number of times authentication will be consecutively retried
@@ -98,41 +95,6 @@ class ActionMailer::ARSendmail
     end
   end
 
-  ##
-  # Creates a new migration using +table_name+ and prints it on stdout.
-
-  def self.create_migration(table_name)
-    require 'active_support'
-    puts <<-EOF
-class Create#{table_name.classify} < ActiveRecord::Migration
-  def self.up
-    create_table :#{table_name.tableize} do |t|
-      t.column :from, :string
-      t.column :to, :string
-      t.column :last_send_attempt, :integer, :default => 0
-      t.column :mail, :text
-      t.column :created_on, :datetime
-    end
-  end
-
-  def self.down
-    drop_table :#{table_name.tableize}
-  end
-end
-    EOF
-  end
-
-  ##
-  # Creates a new model using +table_name+ and prints it on stdout.
-
-  def self.create_model(table_name)
-    require 'active_support'
-    puts <<-EOF
-class #{table_name.classify} < ActiveRecord::Base
-end
-    EOF
-  end
-
   ##
   # Prints a list of unsent emails and the last delivery attempt, if any.
   #
@@ -140,9 +102,8 @@ end
   # known.  See http://api.rubyonrails.org/classes/ActiveRecord/Timestamp.html
   # to learn how to enable ActiveRecord::Timestamp.
 
-  def self.mailq(table_name)
-    klass = table_name.split('::').inject(Object) { |k,n| k.const_get n }
-    emails = klass.find :all
+  def self.mailq
+    emails = ActionMailer::Base.email_class.find :all
 
     if emails.empty? then
       puts "Mail queue is empty"
@@ -191,7 +152,6 @@ end
     options[:MaxAge] = 86400 * 7
     options[:Once] = false
     options[:RailsEnv] = ENV['RAILS_ENV']
-    options[:TableName] = 'Email'
     options[:Pidfile] = options[:Chdir] + '/log/ar_sendmail.pid'
 
     opts = OptionParser.new do |opts|
@@ -253,18 +213,6 @@ end
       opts.separator ''
       opts.separator 'Setup Options:'
 
-      opts.on(      "--create-migration",
-              "Prints a migration to add an Email table",
-              "to stdout") do |create|
-        options[:Migrate] = true
-      end
-
-      opts.on(      "--create-model",
-              "Prints a model for an Email ActiveRecord",
-              "object to stdout") do |create|
-        options[:Model] = true
-      end
-
       opts.separator ''
       opts.separator 'Generic Options:'
 
@@ -282,14 +230,6 @@ end
         options[:RailsEnv] = env
       end
 
-      opts.on("-t", "--table-name TABLE_NAME",
-              "Name of table holding emails",
-              "Used for both sendmail and",
-              "migration creation",
-              "Default: #{options[:TableName]}") do |name|
-        options[:TableName] = name
-      end
-
       opts.on("-v", "--[no-]verbose",
               "Be verbose",
               "Default: #{options[:Verbose]}") do |verbose|
@@ -310,8 +250,6 @@ end
 
     opts.parse! args
 
-    return options if options.include? :Migrate or options.include? :Model
- 
     ENV['RAILS_ENV'] = options[:RailsEnv]
 
     Dir.chdir options[:Chdir] do
@@ -321,7 +259,7 @@ end
         usage opts, <<-EOF
 #{name} must be run from a Rails application's root to deliver email.
 #{Dir.pwd} does not appear to be a Rails application root.
-          EOF
+        EOF
       end
     end
 
@@ -334,14 +272,8 @@ end
   def self.run(args = ARGV)
     options = process_args args
 
-    if options.include? :Migrate then
-      create_migration options[:TableName]
-      exit
-    elsif options.include? :Model then
-      create_model options[:TableName]
-      exit
-    elsif options.include? :MailQ then
-      mailq options[:TableName]
+    if options.include? :MailQ then
+      mailq
       exit
     end
 
@@ -396,18 +328,16 @@ end
   # Valid options are:
   # <tt>:BatchSize</tt>:: Maximum number of emails to send per delay
   # <tt>:Delay</tt>:: Delay between deliver attempts
-  # <tt>:TableName</tt>:: Table name that stores the emails
   # <tt>:Once</tt>:: Only attempt to deliver emails once when run is called
   # <tt>:Verbose</tt>:: Be verbose.
 
   def initialize(options = {})
     options[:Delay] ||= 60
-    options[:TableName] ||= 'Email'
     options[:MaxAge] ||= 86400 * 7
 
     @batch_size = options[:BatchSize]
     @delay = options[:Delay]
-    @email_class = options[:TableName].constantize
+    @email_class = ActionMailer::Base.email_class
     @once = options[:Once]
     @verbose = options[:Verbose]
     @max_age = options[:MaxAge]

data/test/action_mailer.rb

@@ -77,6 +77,7 @@ class ActionMailer::Base
   @server_settings = {}
 
   class << self
+    cattr_accessor :email_class
     attr_accessor :delivery_method
   end
 
@@ -94,6 +95,7 @@ class ActionMailer::Base
 
   def self.reset
     server_settings.clear
+    self.email_class = Email
   end
 
   def self.server_settings
@@ -184,6 +186,8 @@ end
 
 Mail = Email
 
+class Newsletter < Email; end
+
 class String
   def classify
     self

data/test/test_arsendmail.rb

@@ -33,45 +33,6 @@ class TestARSendmail < MiniTest::Unit::TestCase
     $".delete 'config/environment.rb' unless @include_c_e
   end
 
-  def test_class_create_migration
-    out, = capture_io do
-      ActionMailer::ARSendmail.create_migration 'Mail'
-    end
-
-    expected = <<-EOF
-class CreateMail < ActiveRecord::Migration
-  def self.up
-    create_table :mail do |t|
-      t.column :from, :string
-      t.column :to, :string
-      t.column :last_send_attempt, :integer, :default => 0
-      t.column :mail, :text
-      t.column :created_on, :datetime
-    end
-  end
-
-  def self.down
-    drop_table :mail
-  end
-end
-    EOF
-
-    assert_equal expected, out
-  end
-
-  def test_class_create_model
-    out, = capture_io do
-      ActionMailer::ARSendmail.create_model 'Mail'
-    end
-
-    expected = <<-EOF
-class Mail < ActiveRecord::Base
-end
-    EOF
-
-    assert_equal expected, out
-  end
-
   def test_class_mailq
     Email.create :from => nobody, :to => 'recip@h1.example.com',
                  :mail => 'body0'
@@ -83,7 +44,7 @@ end
     last.last_send_attempt = last_attempt_time.to_i
 
     out, err = capture_io do
-      ActionMailer::ARSendmail.mailq 'Email'
+      ActionMailer::ARSendmail.mailq
     end
 
     expected = <<-EOF
@@ -107,7 +68,7 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
 
   def test_class_mailq_empty
     out, err = capture_io do
-      ActionMailer::ARSendmail.mailq 'Email'
+      ActionMailer::ARSendmail.mailq
     end
 
     assert_equal "Mail queue is empty\n", out
@@ -123,14 +84,22 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal nil, @sm.batch_size
 
     @sm = ActionMailer::ARSendmail.new :Delay => 75, :Verbose => true,
-                                       :TableName => 'Object', :Once => true,
-                                       :BatchSize => 1000
+                                       :Once => true, :BatchSize => 1000
 
     assert_equal 75, @sm.delay
-    assert_equal Object, @sm.email_class
+    assert_equal Email, @sm.email_class
     assert_equal true, @sm.once
     assert_equal true, @sm.verbose
     assert_equal 1000, @sm.batch_size
+
+    ActionMailer::Base.email_class = Newsletter
+    @sm = ActionMailer::ARSendmail.new
+
+    assert_equal 60, @sm.delay
+    assert_equal Newsletter, @sm.email_class
+    assert_equal nil, @sm.once
+    assert_equal nil, @sm.verbose
+    assert_equal nil, @sm.batch_size
   end
 
   def test_class_parse_args_batch_size
@@ -241,28 +210,6 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal 86400, options[:MaxAge]
   end
 
-  def test_class_parse_args_migration
-    options = ActionMailer::ARSendmail.process_args []
-    refute_includes options, :Migration
-
-    argv = %w[--create-migration]
-    
-    options = ActionMailer::ARSendmail.process_args argv
-
-    assert_equal true, options[:Migrate]
-  end
-
-  def test_class_parse_args_model
-    options = ActionMailer::ARSendmail.process_args []
-    refute_includes options, :Model
-
-    argv = %w[--create-model]
-    
-    options = ActionMailer::ARSendmail.process_args argv
-
-    assert_equal true, options[:Model]
-  end
-
   def test_class_parse_args_no_config_environment
     $".delete 'config/environment.rb'
 
@@ -276,35 +223,6 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     $" << 'config/environment.rb' if @include_c_e
   end
 
-  def test_class_parse_args_no_config_environment_migrate
-    $".delete 'config/environment.rb'
-
-    out, err = capture_io do
-      ActionMailer::ARSendmail.process_args %w[--create-migration]
-    end
-
-    assert true # count
-
-  ensure
-    $" << 'config/environment.rb' if @include_c_e
-  end
-
-  def test_class_parse_args_no_config_environment_model
-    $".delete 'config/environment.rb'
-
-    out, err = capture_io do
-      ActionMailer::ARSendmail.process_args %w[--create-model]
-    end
-
-    assert true # count
-
-  rescue SystemExit
-    flunk 'Should not exit'
-
-  ensure
-    $" << 'config/environment.rb' if @include_c_e
-  end
-
   def test_class_parse_args_once
     argv = %w[-o]
     
@@ -319,20 +237,6 @@ Last send attempt: Thu Aug 10 11:40:05 %s 2006
     assert_equal true, options[:Once]
   end
 
-  def test_class_parse_args_table_name
-    argv = %w[-t Email]
-    
-    options = ActionMailer::ARSendmail.process_args argv
-
-    assert_equal 'Email', options[:TableName]
-
-    argv = %w[--table-name=Email]
-    
-    options = ActionMailer::ARSendmail.process_args argv
-
-    assert_equal 'Email', options[:TableName]
-  end
-
   def test_class_usage
     out, err = capture_io do
       assert_raises SystemExit do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adzap-ar_mailer
 version: !ruby/object:Gem::Version 
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors: 
 - Eric Hodel
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -07:00
+date: 2009-06-23 00:00:00 -07:00
 default_executable: ar_sendmail
 dependencies: []