has_messages 0.1.1 → 0.1.2

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,47 +1,34 @@
-*SVN*
+== master
 
-*0.1.1* (June 22nd, 2008)
+== 0.1.2 / 2008-06-29
+
+* Add compatibility with state_machine 0.2.0
+
+== 0.1.1 / 2008-06-22
 
 * Remove log files from gems
 
-*0.1.0* (May 5th, 2008)
+== 0.1.0 / 2008-05-05
 
 * Remove dependency on acts_as_list
-
 * Update to reflect changes from has_states to state_machine
-
 * Introduce an ActionMailer-type api for adding the various types of recipients
-
 * Update migrations to support Rails 2.0 syntax
-
 * Replace has_finder dependency with named_scope
-
 * Remove has_messages helper
-
 * Update documentation
 
-*0.0.1* (September 26th, 2007)
+== 0.0.1 / 2007-09-26
 
 * Add state_changes fixtures for tests
-
 * Use has_finder for tracking the deletion status of Messages/MessageRecipients
-
 * Message#forward and Message#reply should create new instances of the current class, not always Message
-
 * Add type field to MessageRecipient table
-
 * Allow message senders to not be model recipients in third-party plugins
-
 * Remove old references to Message::StateExtension
-
 * Update with dependency on custom_callbacks
-
 * Add documentation
-
 * Convert dos newlines to unix newlines
-
 * Move ReceiverMessage state into the MessageRecipient class
-
 * Moved Build extensions out of the MessageRecipient class
-
 * Fix determining whether classes exist in has_messages

data/{README → README.rdoc}

@@ -4,21 +4,21 @@
 
 == Resources
 
-Wiki
-
-* http://wiki.pluginaweek.org/Has_messages
-
 API
 
 * http://api.pluginaweek.org/has_messages
 
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13274-has_messages
+
 Development
 
-* http://dev.pluginaweek.org/browser/trunk/has_messages
+* http://github.com/pluginaweek/has_messages
 
 Source
 
-* http://svn.pluginaweek.org/trunk/has_messages
+* git://github.com/pluginaweek/has_messages.git
 
 == Description
 
@@ -55,19 +55,19 @@ for more information about the asssociations that are generated from this macro.
   message.to user1, user2
   message.subject = 'Hey!'
   message.body = 'Does anyone want to go out tonight?'
-  message.deliver!
+  message.deliver
 
 === Replying to messages
 
   reply = message.reply_to_all
   reply.body = "I'd love to go out!"
-  reply.deliver!
+  reply.deliver
 
 === Forwarding messages
 
   forward = message.forward
   forward.body = 'Interested?'
-  forward.deliver!
+  forward.deliver
 
 === Processing messages asynchronously
 
@@ -75,21 +75,21 @@ In addition to delivering messages immediately, you can also *queue* messages so
 that an external application processes and delivers them.  This is especially
 useful for messages that need to be sent outside of the confines of the application.
 
-To queue messages for external processing, you can use the <tt>queue!</tt> event,
-rather than <tt>deliver!</tt>.  This will indicate to any external processes that
+To queue messages for external processing, you can use the +queue+ event,
+rather than +deliver+.  This will indicate to any external processes that
 the message is ready to be sent.
 
 To process queued emails, you need an external cron job that checks and sends
 them like so:
 
   Message.with_state('queued').each do |message|
-    message.deliver!
+    message.deliver
   end
 
 == Testing
 
 Before you can run any tests, the following gem must be installed:
-* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
 
 To run against a specific version of Rails:
 
@@ -98,5 +98,5 @@ To run against a specific version of Rails:
 == Dependencies
 
 * Rails 2.1 or later
-* plugins_plus[http://wiki.pluginaweek.org/Plugins_plus]
-* state_machine[http://wiki.pluginaweek.org/State_machine]
+* plugins_plus[http://github.com/pluginaweek/plugins_plus]
+* state_machine[http://github.com/pluginaweek/state_machine]

data/Rakefile

@@ -3,47 +3,55 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
-PKG_NAME           = 'has_messages'
-PKG_VERSION        = '0.1.1'
-PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = 'pluginaweek'
-
-desc 'Default: run unit tests.'
+spec = Gem::Specification.new do |s|
+  s.name              = 'has_messages'
+  s.version           = '0.1.2'
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = 'Demonstrates a reference implementation for sending messages between users.'
+  
+  s.files             = FileList['{app,db,lib,test}/**/*'].to_a - FileList['test/app_root/log/*'].to_a + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc)
+  s.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  s.add_dependency    'state_machine', '>= 0.2.0'
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
 task :default => :test
 
-desc 'Test the has_messages plugin.'
+desc "Test the #{spec.name} plugin."
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = spec.test_files
   t.verbose = true
 end
 
-desc 'Generate documentation for the has_messages plugin.'
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/|app/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'HasMessages'
+  rdoc.title    = spec.name
   rdoc.template = '../rdoc_template.rb'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-spec = Gem::Specification.new do |s|
-  s.name            = PKG_NAME
-  s.version         = PKG_VERSION
-  s.platform        = Gem::Platform::RUBY
-  s.summary         = 'Demonstrates a reference implementation for sending messages between users.'
-  
-  s.files           = FileList['{app,db,lib,test}/**/*'].to_a - FileList['test/app_root/log/*'].to_a + %w(CHANGELOG init.rb MIT-LICENSE Rakefile README)
-  s.require_path    = 'lib'
-  s.autorequire     = 'has_messages'
-  s.has_rdoc        = true
-  s.test_files      = Dir['test/**/*_test.rb']
-  s.add_dependency  'state_machine', '>= 0.1.0'
-  
-  s.author          = 'Aaron Pfeifer'
-  s.email           = 'aaron@pluginaweek.org'
-  s.homepage        = 'http://www.pluginaweek.org'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb', 'app/**/*.rb')
 end
   
 Rake::GemPackageTask.new(spec) do |p|
@@ -52,14 +60,14 @@ Rake::GemPackageTask.new(spec) do |p|
   p.need_zip = true
 end
 
-desc 'Publish the beta gem'
+desc 'Publish the beta gem.'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
 end
 
-desc 'Publish the API documentation'
+desc 'Publish the API documentation.'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
@@ -72,10 +80,10 @@ task :release => [:gem, :package] do
   ruby_forge = RubyForge.new.configure
   ruby_forge.login
   
-  %w( gem tgz zip ).each do |ext|
-    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
     puts "Releasing #{File.basename(file)}..."
     
-    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
   end
 end

data/lib/has_messages.rb

@@ -23,8 +23,8 @@ module PluginAWeek #:nodoc:
       #   message.subject = 'Hello'
       #   message.body = 'How are you?'
       #   message.to User.find(456)
-      #   message.save!
-      #   message.deliver!
+      #   message.save
+      #   message.deliver
       # 
       # == Drafts
       # 

data/test/factory.rb

@@ -1,26 +1,32 @@
 module Factory
-  # Build actions for the class
-  def self.build(klass, &block)
-    name = klass.to_s.underscore
-    define_method("#{name}_attributes", block)
+  # Build actions for the model
+  def self.build(model, &block)
+    name = model.to_s.underscore
     
-    module_eval <<-end_eval
-      def valid_#{name}_attributes(attributes = {})
-        #{name}_attributes(attributes)
-        attributes
-      end
-      
-      def new_#{name}(attributes = {})
-        #{klass}.new(valid_#{name}_attributes(attributes))
-      end
-      
-      def create_#{name}(*args)
-        record = new_#{name}(*args)
-        record.save!
-        record.reload
-        record
-      end
-    end_eval
+    define_method("#{name}_attributes", block)
+    define_method("valid_#{name}_attributes") {|*args| valid_attributes_for(model, *args)}
+    define_method("new_#{name}")              {|*args| new_record(model, *args)}
+    define_method("create_#{name}")           {|*args| create_record(model, *args)}
+  end
+  
+  # Get valid attributes for the model
+  def valid_attributes_for(model, attributes = {})
+    name = model.to_s.underscore
+    send("#{name}_attributes", attributes)
+    attributes
+  end
+  
+  # Build an unsaved record
+  def new_record(model, *args)
+    model.new(valid_attributes_for(model, *args))
+  end
+  
+  # Build and save/reload a record
+  def create_record(model, *args)
+    record = new_record(model, *args)
+    record.save!
+    record.reload
+    record
   end
   
   build Message do |attributes|

data/test/functional/has_messages_test.rb

@@ -36,7 +36,7 @@ class UserTest < Test::Unit::TestCase
   def test_should_be_able_to_send_new_messages
     message = @user.messages.build
     message.to create_user(:login => 'John')
-    assert message.deliver!
+    assert message.deliver
   end
 end
 
@@ -44,7 +44,7 @@ class UserWithUnsentMessages < Test::Unit::TestCase
   def setup
     @user = create_user
     @sent_message = create_message(:sender => @user, :to => create_user(:login => 'you'))
-    @sent_message.deliver!
+    @sent_message.deliver
     @first_draft = create_message(:sender => @user)
     @second_draft = create_message(:sender => @user)
   end
@@ -65,10 +65,10 @@ class UserWithSentMessages < Test::Unit::TestCase
     @draft = create_message(:sender => @user)
     
     @first_sent_message = create_message(:sender => @user, :to => @to)
-    @first_sent_message.deliver!
+    @first_sent_message.deliver
     
     @second_sent_message = create_message(:sender => @user, :to => @to)
-    @second_sent_message.deliver!
+    @second_sent_message.deliver
   end
   
   def test_should_have_sent_messages
@@ -88,10 +88,10 @@ class UserWithReceivedMessages < Test::Unit::TestCase
     @unsent_message = create_message(:sender => @sender, :to => @user)
     
     @first_sent_message = create_message(:sender => @sender, :to => @user)
-    @first_sent_message.deliver!
+    @first_sent_message.deliver
     
     @second_sent_message = create_message(:sender => @sender, :to => @user)
-    @second_sent_message.deliver!
+    @second_sent_message.deliver
   end
   
   def test_should_have_received_messages
@@ -109,16 +109,16 @@ class UserWithHiddenMessagesTest < Test::Unit::TestCase
     @unsent_message = create_message(:sender => @user)
     
     hidden_sent_message = create_message(:sender => @user, :to => @friend)
-    hidden_sent_message.deliver!
+    hidden_sent_message.deliver
     hidden_sent_message.hide!
     @sent_message = create_message(:sender => @user, :to => @friend)
-    @sent_message.deliver!
+    @sent_message.deliver
     
     hidden_received_message = create_message(:sender => @friend, :to => @user)
-    hidden_received_message.deliver!
+    hidden_received_message.deliver
     hidden_received_message.recipients.first.hide!
     @received_message = create_message(:sender => @friend, :to => @user)
-    @received_message.deliver!
+    @received_message.deliver
   end
   
   def test_should_not_include_hidden_messages_in_messages

data/test/unit/message_recipient_test.rb

@@ -164,14 +164,14 @@ class MessageRecipientUnreadWithUnsentMessageTest < Test::Unit::TestCase
   end
   
   def test_should_not_be_able_to_view
-    assert !@recipient.view!
+    assert !@recipient.view
   end
 end
 
 class MessageRecipientUnreadWithSentMessageTest < Test::Unit::TestCase
   def setup
     @recipient = create_message_recipient
-    @recipient.message.deliver!
+    @recipient.message.deliver
   end
   
   def test_should_be_in_the_unread_state
@@ -179,15 +179,15 @@ class MessageRecipientUnreadWithSentMessageTest < Test::Unit::TestCase
   end
   
   def test_should_be_able_to_view
-    assert @recipient.view!
+    assert @recipient.view
   end
 end
 
 class MessageRecipientReadTest < Test::Unit::TestCase
   def setup
     @recipient = create_message_recipient
-    @recipient.message.deliver!
-    @recipient.view!
+    @recipient.message.deliver
+    @recipient.view
   end
   
   def test_should_be_in_the_read_state
@@ -195,7 +195,7 @@ class MessageRecipientReadTest < Test::Unit::TestCase
   end
   
   def test_should_not_be_able_to_view
-    assert !@recipient.view!
+    assert !@recipient.view
   end
 end
 

data/test/unit/message_test.rb

@@ -156,11 +156,11 @@ class MessageWithoutRecipientsTest < Test::Unit::TestCase
   end
   
   def test_should_not_be_able_to_queue
-    assert !@message.queue!
+    assert !@message.queue
   end
   
   def test_should_not_be_able_to_deliver
-    assert !@message.deliver!
+    assert !@message.deliver
   end
 end
 
@@ -193,18 +193,18 @@ class MessageWithRecipientsTest < Test::Unit::TestCase
   end
   
   def test_should_be_able_to_queue
-    assert @message.queue!
+    assert @message.queue
   end
   
   def test_should_be_able_to_deliver
-    assert @message.deliver!
+    assert @message.deliver
   end
 end
 
 class MessageQueuedTest < Test::Unit::TestCase
   def setup
     @message = create_message(:to => create_user(:login => 'coward'))
-    @message.queue!
+    @message.queue
   end
   
   def test_should_be_in_the_queued_state
@@ -212,18 +212,18 @@ class MessageQueuedTest < Test::Unit::TestCase
   end
   
   def test_should_not_be_able_to_queue
-    assert !@message.queue!
+    assert !@message.queue
   end
   
   def test_should_be_able_to_deliver
-    assert @message.deliver!
+    assert @message.deliver
   end
 end
 
 class MessageDeliveredTest < Test::Unit::TestCase
   def setup
     @message = create_message(:to => create_user(:login => 'coward'))
-    @message.deliver!
+    @message.deliver
   end
   
   def test_should_be_in_the_sent_state
@@ -231,11 +231,11 @@ class MessageDeliveredTest < Test::Unit::TestCase
   end
   
   def test_should_not_be_able_to_queue
-    assert !@message.queue!
+    assert !@message.queue
   end
   
   def test_should_not_be_able_to_deliver
-    assert !@message.deliver!
+    assert !@message.deliver
   end
 end
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: has_messages
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Aaron Pfeifer
-autorequire: has_messages
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-06-22 00:00:00 -04:00
+date: 2008-06-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.1.0
+        version: 0.2.0
     version: 
 description: 
 email: aaron@pluginaweek.org
@@ -55,11 +55,11 @@ files:
 - test/unit
 - test/unit/message_test.rb
 - test/unit/message_recipient_test.rb
-- CHANGELOG
+- CHANGELOG.rdoc
 - init.rb
-- MIT-LICENSE
+- LICENSE
 - Rakefile
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://www.pluginaweek.org
 post_install_message: 
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: pluginaweek
 rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2