acts_as_notifier 0.0.1

data/lib/acts_as_notifier/version.rb

@@ -0,0 +1,3 @@
+module ActsAsNotifier
+  VERSION = "0.0.1"
+end

data/test/acts_as_notifier/acts_as_notifier_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class ActsAsNotifierTest < ActiveSupport::TestCase
+  def setup
+    @widget = Widget.new
+  end
+
+  def test_model_class_methods_created
+    assert Widget.respond_to?(:acts_as_notifier)
+  end
+
+  def test_model_instance_methods_created
+    assert @widget.respond_to?(:force_notification)
+  end
+
+  def test_mailer_is_invoked_on_create
+    MyMailer.expects(:create_method)
+    @widget.save
+  end
+
+  def test_mailer_is_invoked_on_update
+    @widget.save
+    MyMailer.expects(:update_method)
+    @widget.name = "Name"
+    @widget.save
+  end
+
+  def test_mailer_is_invoked_on_save
+    MyMailer.expects(:save_method)
+    @widget.save
+  end
+
+  def test_message_deliver_method_called
+    mailer = mock('Mail::Message')
+    mailer.expects(:deliver).returns(:true)
+    MyMailer.stubs(:create_method).returns(mailer)
+    @widget.save
+  end
+
+  def test_forced_notification
+    MyMailer.expects(:created_with_name_method)
+    @widget.force_notification(:method => :created_with_name_method)
+  end
+end

data/test/acts_as_notifier/conditions_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class ConditionsTest < ActiveSupport::TestCase
+  def setup
+    @widget = Widget.new
+  end
+
+  def test_notification_not_sent_if_condition_false
+    MyMailer.expects(:created_with_name_method).never
+    @widget.save
+  end
+
+  def test_notification_sent_if_condition_true
+    MyMailer.expects(:created_with_name_method)
+    @widget.name = "Name"
+    @widget.save
+  end
+
+  def test_condition_can_be_string
+    @widget.expects(:string_condition?)
+    @widget.save
+  end
+
+  def test_condition_can_be_symbolic_method_name
+    @widget.expects(:has_name?)
+    @widget.save
+  end
+
+  def test_condition_can_be_proc
+    @widget.expects(:proc_condition?)
+    @widget.save
+  end
+
+  def test_condition_procs_receive_options_param
+    @widget.expects(:proc_condition?).with(has_entries(:method => :created_with_proc_condition, :custom => 'created_with_proc_condition'))
+    @widget.save
+  end
+
+  def test_supports_unless_conditions
+    skip ":unless conditions not implemented yet"
+  end
+end

data/test/acts_as_notifier/config_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class ConfigTest < ActiveSupport::TestCase
+  def setup
+    @widget = Widget.new
+  end
+
+  def test_can_configure_default_mailer
+    ActsAsNotifier::Config.default_mailer = MyMailer
+    MyMailer.expects(:create_with_default_mailer_method)
+    @widget.stubs(:no_mailer_test?).returns(true)
+    @widget.save
+    ActsAsNotifier::Config.default_mailer = nil
+  end
+
+  def test_can_configure_default_method
+    ActsAsNotifier::Config.default_method = :my_default_method
+    MyMailer.expects(:my_default_method)
+    @widget.stubs(:no_method_test?).returns(true)
+    @widget.save
+    ActsAsNotifier::Config.default_method = nil
+  end
+
+  def test_can_disable_notifications
+    ActsAsNotifier::Config.disabled = true
+    MyMailer.expects(:create_method).never
+    @widget.save
+    ActsAsNotifier::Config.disabled = false
+  end
+
+  def test_messages_can_be_queued_with_delayed_job
+    ActsAsNotifier::Config.use_delayed_job = true
+    MyMailer.expects(:delay).at_least_once.returns(MyMailer)
+    @widget.save
+    ActsAsNotifier::Config.use_delayed_job = false
+  end
+end

data/test/acts_as_notifier/mailer_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+class MailerTest < ActiveSupport::TestCase
+  def setup
+    @widget = Widget.new
+  end
+
+  def test_mailer_can_be_class
+    MyMailer.expects(:created_with_class_mailer)
+    @widget.stubs(:mailer_test?).returns(true)
+    @widget.save
+  end
+
+  def test_mailer_can_be_string
+    MyMailer.expects(:created_with_string_mailer)
+    @widget.stubs(:mailer_test?).returns(true)
+    @widget.save
+  end
+
+  def test_mailer_can_be_symbol
+    MyMailer.expects(:created_with_symbol_mailer)
+    @widget.stubs(:mailer_test?).returns(true)
+    @widget.save
+  end
+
+  def test_mailer_passed_model_instance
+    MyMailer.expects(:create_method).with(anything, @widget)
+    @widget.save
+  end
+
+  def test_error_raised_if_mailer_not_configured
+    @widget.stubs(:no_mailer_test?).returns(true)
+    assert_raises(RuntimeError) { @widget.save }
+  end
+
+  def test_error_raised_if_method_not_configured
+    @widget.stubs(:no_method_test?).returns(true)
+    assert_raises(RuntimeError) { @widget.save }
+  end
+
+  def test_error_raised_if_method_not_valid
+    @widget.stubs(:invalid_method_test?).returns(true)
+    assert_raises(RuntimeError) { @widget.save }
+  end
+
+end

data/test/acts_as_notifier/recipients_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+
+class RecipientsTest < ActiveSupport::TestCase
+  def setup
+    @widget = Widget.new
+  end
+
+  def test_mailer_receives_recipient_string
+    MyMailer.expects(:create_method).with(@widget.notification_recipients, anything)
+    @widget.save
+  end
+
+  def test_recipients_can_be_symbolic_method_name
+    @widget.expects(:notification_recipients).at_least_once
+    @widget.save
+  end
+
+  def test_recipients_can_be_object_with_email_method
+    user = mock('User')
+    user.stubs(:email).returns('xyz@xyz.xyz')
+    @widget.stubs(:notification_recipients).returns(user)
+    MyMailer.expects(:create_method).with('xyz@xyz.xyz', @widget)
+    @widget.save
+  end
+
+  def test_recipients_can_be_array
+    user = mock('User')
+    user.stubs(:email).returns('xyz@xyz.xyz')
+    @widget.stubs(:notification_recipients).returns([user, 'abc@abc.abc'])
+    MyMailer.expects(:create_method).with('xyz@xyz.xyz, abc@abc.abc', @widget)
+    @widget.save
+  end
+
+  def test_recipients_can_be_proc
+    @widget.stubs(:use_proc?).returns(true)
+    MyMailer.expects(:recipients_proc_method).with(@widget.proc_recipients(nil), @widget)
+    @widget.save
+  end
+
+  def test_recipients_proc_receives_options_param
+    @widget.stubs(:use_proc?).returns(true)
+    @widget.expects(:proc_recipients).with(has_entries(:method => :recipients_proc_method, :custom => 'recipients_proc_method'))
+    @widget.save
+  end
+
+  def test_no_notification_if_recipients_blank
+    @widget.stubs(:notification_recipients).returns(' ')
+    MyMailer.expects(:create_method).never
+    @widget.save
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.