warnr 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+*~
+pkg/
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,27 @@
+Warnr
+======
+
+Warnr builds on the power of Rails 3 validations.
+It lets you use validations to identify situations which are warnings rather than errors.
+It also lets you define a callback on the model which is executed after save if there are any warnings.
+
+Usage Example
+
+class Client < ActiveRecord::Base
+  # Notify the client manager that the ABN has not been set
+  belongs_to :manager, :class_name => "User"
+  
+  validates_presence_of :abn, :manager_id
+  
+  treat_validation_errors_as_warnings_on :abn
+  on_save_with_warnings :handle_warnings
+  
+  def handle_warnings
+    MissingDataNotifier.missing_data_notification(client.manager, client).deliver
+    # Will save the record in a week, which will trigger this process again.
+    DelayedJob.create(1.week, Client, client.id, :save)
+  end
+end
+
+
+Copyright (c) 2010 Daniel Heath, released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rubygems'
+
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Generate documentation for the warner plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Warnr'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/*.rb')
+end
+
+desc 'Test the warner plugin.'
+Spec::Rake::SpecTask.new('test') do |t|
+  t.spec_files = FileList['spec/*.rb']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "warnr"
+    gemspec.summary = "Non-fatal rails 3 validations (ie, warnings rather than errors)"
+    gemspec.description = <<EOF
+Ernr builds on the power of Rails 3 validations.
+It lets you use validations to identify situations which are warnings rather than errors.
+It also lets you define a callback on the model which is executed after save if there are any warnings.
+EOF
+    gemspec.email = "daniel.heath@gmail.com"
+    gemspec.homepage = "http://github.com/DanielHeath/warnr"
+    gemspec.authors = ["Daniel Heath"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+# Include hook code here

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/warnr.rb

@@ -0,0 +1,81 @@
+require 'active_record'
+
+module Warnr
+
+  # Patches ActiveRecord to:
+  # * Store a list of 'warning' fields
+  # * Store a list of callbacks for 'after save, if warnings exist'
+  # * Store a list of warning messages
+  # * Move messages out of the errors object if they belong in the warning object
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.class_eval do
+      class_inheritable_accessor :warnr_warning_fields
+      self.warnr_warning_fields = []
+      define_callbacks :on_save_with_warnings
+      attr_reader :warnings
+      after_initialize :setup_warnr_warnings
+      alias_method_chain 'valid?', 'warnr'
+    end
+  end
+  
+  module ClassMethods
+    
+    # Specify a list of fields to work on.
+    # Validation errors on these fields will be ignored.
+    def treat_validation_errors_as_warnings_on(*fields)
+      self.warnr_warning_fields = self.warnr_warning_fields | fields
+    end
+    
+    # Pass a method name; sets up a callback which runs after create_or_update.
+    def on_save_with_warnings(method)
+      set_callback(:on_save_with_warnings, :after, method)
+    end
+    
+  end
+  
+  private
+  
+  def create_or_update # :nodoc:
+    super
+    run_callbacks :on_save_with_warnings if errors.empty? and not warnings.empty?
+  end
+  
+  def setup_warnr_warnings # :nodoc:
+    @warnings = ActiveModel::Errors.new(self)
+  end
+  
+  # Ugly hack; rather than preventing errors getting added, we move them afterwards.
+  # Alternative may be to modify the ActiveModel validation base class 
+  # so that it passes a record proxy to the validations that can then decide
+  # whether to return the errors or warnings collection when record.errors is called.
+  def move_errors_to_warnings
+    self.class.warnr_warning_fields.each do |field|
+      if errors[field]
+        errors[field].each { |error| warnings.add(field, error) }
+        errors.delete(field)
+      end
+    end
+  end
+end
+
+module ActiveRecord::Validations::InstanceMethods
+  # Using alias_method_chain (ugly!) to wrap the valid? method.
+  def valid_with_warnr?( *args ) 
+    warnings.clear
+    
+    valid_without_warnr?
+    
+    # WARNR: Moves any warning-level validation errors to the warnings collection
+    move_errors_to_warnings
+    # WARNR: Runs warning block if defined
+    run_callbacks :on_save_with_warnings if errors.empty? and not warnings.empty?
+
+    errors.empty?
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  include(Warnr)
+end
+

data/rdoc/classes/ActiveRecord/Validations/InstanceMethods.html

@@ -0,0 +1,152 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: ActiveRecord::Validations::InstanceMethods</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">ActiveRecord::Validations::InstanceMethods</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/warnr_rb.html">
+                lib/warnr.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">valid_with_warnr?</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">valid_with_warnr?</span><span class="method-args">( *args )</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Using alias_method_chain (ugly!) to wrap the valid? method.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+    <span class="ruby-comment cmt"># File lib/warnr.rb, line 64</span>
+64:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">valid_with_warnr?</span>( <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> ) 
+65:     <span class="ruby-identifier">warnings</span>.<span class="ruby-identifier">clear</span>
+66:     
+67:     <span class="ruby-identifier">valid_without_warnr?</span>
+68:     
+69:     <span class="ruby-comment cmt"># WARNR: Moves any warning-level validation errors to the warnings collection</span>
+70:     <span class="ruby-identifier">move_errors_to_warnings</span>
+71:     <span class="ruby-comment cmt"># WARNR: Runs warning block if defined</span>
+72:     <span class="ruby-identifier">run_callbacks</span> <span class="ruby-identifier">:on_save_with_warnings</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword kw">and</span> <span class="ruby-keyword kw">not</span> <span class="ruby-identifier">warnings</span>.<span class="ruby-identifier">empty?</span>
+73: 
+74:     <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">empty?</span>
+75:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/ActiveRecord/Validations.html

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: ActiveRecord::Validations</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">ActiveRecord::Validations</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Validations/InstanceMethods.html" class="link">ActiveRecord::Validations::InstanceMethods</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/ActiveRecord.html

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: ActiveRecord</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">ActiveRecord</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="ActiveRecord/Validations.html" class="link">ActiveRecord::Validations</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>