paranoid 0.0.1 → 0.0.2

data/README.textile

@@ -38,10 +38,10 @@ Automobile.count # => 1
 
 that_large_automobile.destroy
 Automobile.count # => 0
-Automobile.count_with_destroyed # => 1
+Automobile.with_destroyed.count # => 1
 
 # where is that large automobile?
-that_large_automobile = Automobile.find_with_destroyed(:all).first
+that_large_automobile = Automobile.with_destroyed.first
 that_large_automobile.restore
 Automobile.count # => 1
 </pre>
@@ -51,14 +51,24 @@ One thing to note, destroying is always undo-able, but deleting is not.  This is
 <pre>
 Automobile.destroy_all
 Automobile.count # => 0
-Automobile.count_with_destroyed # => 1
+Automobile.with_destroyed.count # => 1
 
 Automobile.delete_all
-Automobile.count_with_destroyed # => 0
+Automobile.with_destroyed.count # => 0
 # And you may say to yourself, "My god!  What have I done?"
 </pre>
 
-Any find/count/sum/etc. _with_destroyed calls should work and you can also do find/count/sum/etc._destroyed_only.
+You can also lookup only destroyed record with with_destroyed_only.
+
+<pre>
+auto1 = Automobile.create()
+auto2 = Automobile.create()
+auto2.destroy
+Automobile.count # => 1
+Automobile.with_destroyed.count # => 2
+Automobile.with_destroyed_only.count # => 1
+Automobile.with_destroyed_only.first # => auto2
+</pre>
 
 h3. Specifying alternate rules for what should be considered destroyed
 

data/Rakefile

@@ -1,3 +1,4 @@
+require 'rake/rdoctask'
 require "spec"
 require "spec/rake/spectask"
 
@@ -22,4 +23,14 @@ rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install jeweler"
 end
 
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "Paranoid"
+  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.template = ENV['template'] ? "#{ENV['template']}.rb" : './rdoc/template.rb'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
 task :default  => :spec

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
-:major: 0
 :minor: 0
-:patch: 1
+:patch: 2
+:major: 0
+:build: 

data/lib/paranoid.rb

@@ -1,3 +1,4 @@
 require 'active_record'
 require 'paranoid/base'
+require 'paranoid/paranoid_methods'
 require 'paranoid/relation'

data/lib/paranoid/base.rb

@@ -1,5 +1,23 @@
 module Paranoid
   module Base
+    # Call this in your model to enable paranoid.
+    #
+    # === Examples
+    #
+    #   Post < ActiveRecord::Base
+    #     paranoid
+    #   end
+    #
+    #   Item < ActiveRecord::Base
+    #     paranoid :field => [:available, fales, true]
+    #   end
+    #
+    # === Options
+    #
+    # [:field]
+    #   Must be a 3 element array in the form
+    #   [:field_name, 'destroyed value', 'not destroyed value']
+    #   Default: [:deleted_at, Proc.new{Time.now.utc}, nil]
     def paranoid(opts = {})
       return if paranoid?
       @paranoid = true
@@ -8,82 +26,20 @@ module Paranoid
       class_inheritable_accessor :destroyed_field, :field_destroyed, :field_not_destroyed
       self.destroyed_field, self.field_destroyed, self.field_not_destroyed = opts[:field]
 
-      extend ClassMethods
-      include InstanceMethods
+      include Paranoid::ParanoidMethods
 
       class_eval do
         class << self
-          delegate :with_destroyed, :to => :scoped
+          delegate :with_destroyed, :with_destroyed_only, :to => :scoped
         end
       end
     end
 
+    # Returns true if the model is paranoid and paranoid is enabled
     def paranoid?
       @paranoid = false unless defined?(@paranoid)
       @paranoid
     end
-
-    module ClassMethods
-      def paranoid_condition
-        {destroyed_field => field_not_destroyed}
-      end
-
-      def paranoid_only_condition
-        ["#{table_name}.#{destroyed_field} IS NOT ?", field_not_destroyed]
-      end
-
-      def disable_paranoid
-        if block_given?
-          @paranoid = false
-          yield
-        end
-      ensure
-        @paranoid = true
-      end
-    end
-
-    module InstanceMethods
-      extend ActiveSupport::Concern
-
-      included do
-        alias_method_chain :create_or_update, :paranoid
-      end
-
-      def restore
-        set_destroyed(field_not_destroyed.respond_to?(:call) ? field_not_destroyed.call : field_not_destroyed)
-        @destroyed = false
-
-        self
-      end
-
-      # Override the default destroy to allow us to soft delete records.
-      # This preserves the before_destroy and after_destroy callbacks.
-      # Because this is also called internally by Model.destroy_all and
-      # the Model.destroy(id), we don't need to specify those methods
-      # separately.
-      def destroy
-        _run_destroy_callbacks do
-          set_destroyed(field_destroyed.respond_to?(:call) ? field_destroyed.call : field_destroyed)
-          @destroyed = true
-        end
-
-        self
-      end
-
-      protected
-
-      def create_or_update_with_paranoid
-        self.class.disable_paranoid { create_or_update_without_paranoid }
-      end
-
-      # Set the value for the destroyed field.
-      def set_destroyed(val)
-        self[destroyed_field] = val
-        updates = self.class.send(:sanitize_sql_for_assignment, {destroyed_field => val})
-        self.class.unscoped.with_destroyed.where(self.class.arel_table[self.class.primary_key].eq(id)).arel.update(updates)
-        @destroyed = true
-      end
-    end
   end
 end
 

data/lib/paranoid/paranoid_methods.rb

@@ -0,0 +1,79 @@
+module Paranoid
+  module ParanoidMethods
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+      alias_method_chain :create_or_update, :paranoid
+    end
+
+    module ClassMethods
+      # Returns the condition used to scope the return to exclude
+      # soft deleted records
+      def paranoid_condition
+        {destroyed_field => field_not_destroyed}
+      end
+
+      # Returns the condition used to scope the return to contain
+      # only soft deleted records
+      def paranoid_only_condition
+        val = field_not_destroyed.respond_to?(:call) ? field_not_destroyed.call : field_not_destroyed
+        column_sql = arel_table[destroyed_field].to_sql
+        case val
+        when nil then "#{column_sql} IS NOT NULL"
+        else          ["#{column_sql} != ?", val]
+        end
+      end
+
+      # Temporarily disables paranoid on the model
+      def disable_paranoid
+        if block_given?
+          @paranoid = false
+          yield
+        else
+          raise 'Only block form is supported'
+        end
+      ensure
+        @paranoid = true
+      end
+    end
+
+    # Restores the record
+    def restore
+      set_destroyed(field_not_destroyed.respond_to?(:call) ? field_not_destroyed.call : field_not_destroyed)
+      @destroyed = false
+
+      self
+    end
+
+    # Override the default destroy to allow us to soft delete records.
+    # This preserves the before_destroy and after_destroy callbacks.
+    # Because this is also called internally by Model.destroy_all and
+    # the Model.destroy(id), we don't need to specify those methods
+    # separately.
+    def destroy
+      _run_destroy_callbacks do
+        set_destroyed(field_destroyed.respond_to?(:call) ? field_destroyed.call : field_destroyed)
+        @destroyed = true
+      end
+
+      self
+    end
+
+    protected
+
+    # Overrides ActiveRecord::Base#create_or_update
+    # to disable paranoid during the create and update operations
+    def create_or_update_with_paranoid
+      self.class.disable_paranoid { create_or_update_without_paranoid }
+    end
+
+    # Set the value for the destroyed field.
+    def set_destroyed(val)
+      self[destroyed_field] = val
+      updates = self.class.send(:sanitize_sql_for_assignment, {destroyed_field => val})
+      self.class.unscoped.with_destroyed.where(self.class.arel_table[self.class.primary_key].eq(id)).arel.update(updates)
+      @destroyed = true
+    end
+  end
+end

data/lib/paranoid/relation.rb

@@ -5,13 +5,18 @@ module Paranoid
     included do
       alias_method_chain :arel, :paranoid
       alias_method_chain :delete_all, :paranoid
+      alias_method_chain :except, :paranoid
+      alias_method_chain :only, :paranoid
     end
 
+    # Returns true if the relation should be scoped to
+    # exclude soft deleted records
     def add_paranoid_condition?
       @add_paranoid = true unless defined?(@add_paranoid)
       @klass.paranoid? && @add_paranoid
     end
 
+    # Overrides ActiveRecord::Relation#arel
     def arel_with_paranoid
       if add_paranoid_condition?
         @arel ||= without_destroyed.arel_without_paranoid
@@ -20,6 +25,8 @@ module Paranoid
       end
     end
 
+    # Overrides ActiveRecord::Relation#delete_all
+    # forcing delete_all to ignore deleted flag
     def delete_all_with_paranoid(*args)
       if add_paranoid_condition?
         with_destroyed.delete_all_without_paranoid(*args)
@@ -28,21 +35,46 @@ module Paranoid
       end
     end
 
-    def skip_paranoid_condition
-      @add_paranoid = false
+    # Overrides ActiveRecord::Relation#except
+    def except_with_paranoid(*args)
+      result = except_without_paranoid(*args)
+      result.instance_variable_set(:@add_paranoid, @add_paranoid) if defined?(@add_paranoid)
+      result
     end
 
+    # Overrides ActiveRecord::Relation#only
+    def only_with_paranoid(*args)
+      result = only_without_paranoid(*args)
+      result.instance_variable_set(:@add_paranoid, @add_paranoid) if defined?(@add_paranoid)
+      result
+    end
+
+    # Returns a new relation scoped to include soft deleted records
     def with_destroyed
       spawn.tap {|relation| relation.skip_paranoid_condition }
     end
 
+    # Returns a new relation scoped to include only deleted records
     def with_destroyed_only
       where(@klass.paranoid_only_condition).tap {|relation| relation.skip_paranoid_condition }
     end
 
+    # Can be used to force the exclusion of soft deleted records down
+    # the chain from a with_destroyed call. *WARNING*: with_destroyed
+    # will do nothing after this has been called! So
+    # Model.without_destroyed.with_destroyed.all will *NOT* return
+    # soft deleted records
     def without_destroyed
       where(@klass.paranoid_condition).tap {|relation| relation.skip_paranoid_condition }
     end
+
+    protected
+
+    # Tell the relation to skip adding the paranoid conditions. DO NOT
+    # call directly. Call with_destroyed.
+    def skip_paranoid_condition
+      @add_paranoid = false
+    end
   end
 end
 

data/paranoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{paranoid}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Genord II"]
-  s.date = %q{2010-02-18}
+  s.date = %q{2010-02-19}
   s.description = %q{}
   s.email = %q{github@xspond.com}
   s.extra_rdoc_files = [
@@ -23,8 +23,10 @@ Gem::Specification.new do |s|
      "init.rb",
      "lib/paranoid.rb",
      "lib/paranoid/base.rb",
+     "lib/paranoid/paranoid_methods.rb",
      "lib/paranoid/relation.rb",
      "paranoid.gemspec",
+     "rdoc/template.rb",
      "spec/database.yml",
      "spec/models.rb",
      "spec/paranoid_spec.rb",

data/rdoc/template.rb

@@ -0,0 +1,613 @@
+# Horo RDoc template
+# Author: Hongli Lai - http://izumi.plan99.net/blog/
+#
+# Based on the Jamis template:
+# http://weblog.jamisbuck.org/2005/4/8/rdoc-template
+
+if defined?(RDoc::Diagram)
+	RDoc::Diagram.class_eval do
+		remove_const(:FONT)
+		const_set(:FONT, "\"Bitstream Vera Sans\"")
+	end
+end
+
+module RDoc
+module Page
+
+FONTS = "\"Bitstream Vera Sans\", Verdana, Arial, Helvetica, sans-serif"
+
+STYLE = <<CSS
+a {
+  color: #00F;
+  text-decoration: none;
+}
+
+a:hover {
+  color: #77F;
+  text-decoration: underline;
+}
+
+body, td, p {
+  font-family: %fonts%;
+  background: #FFF;
+  color: #000;
+  margin: 0px;
+  font-size: small;
+}
+
+p {
+  margin-top: 0.5em;
+  margin-bottom: 0.5em;
+}
+
+#content {
+  margin: 2em;
+  margin-left: 3.5em;
+  margin-right: 3.5em;
+}
+
+#description p {
+  margin-bottom: 0.5em;
+}
+
+.sectiontitle {
+  margin-top: 1em;
+  margin-bottom: 1em;
+  padding: 0.5em;
+  padding-left: 2em;
+  background: #005;
+  color: #FFF;
+  font-weight: bold;
+}
+
+.attr-rw {
+  padding-left: 1em;
+  padding-right: 1em;
+  text-align: center;
+  color: #055;
+}
+
+.attr-name {
+  font-weight: bold;
+}
+
+.attr-desc {
+}
+
+.attr-value {
+  font-family: monospace;
+}
+
+.file-title-prefix {
+  font-size: large;
+}
+
+.file-title {
+  font-size: large;
+  font-weight: bold;
+  background: #005;
+  color: #FFF;
+}
+
+.banner {
+  background: #005;
+  color: #FFF;
+  border: 1px solid black;
+  padding: 1em;
+}
+
+.banner td {
+  background: transparent;
+  color: #FFF;
+}
+
+h1 a, h2 a, .sectiontitle a, .banner a {
+  color: #FF0;
+}
+
+h1 a:hover, h2 a:hover, .sectiontitle a:hover, .banner a:hover {
+  color: #FF7;
+}
+
+.dyn-source {
+  display: none;
+  background: #fffde8;
+  color: #000;
+  border: #ffe0bb dotted 1px;
+  margin: 0.5em 2em 0.5em 2em;
+  padding: 0.5em;
+}
+
+.dyn-source .cmt {
+  color: #00F;
+  font-style: italic;
+}
+
+.dyn-source .kw {
+  color: #070;
+  font-weight: bold;
+}
+
+.method {
+  margin-left: 1em;
+  margin-right: 1em;
+  margin-bottom: 1em;
+}
+
+.description pre {
+  padding: 0.5em;
+  border: #ffe0bb dotted 1px;
+  background: #fffde8;
+}
+
+.method .title {
+  font-family: monospace;
+  font-size: large;
+  border-bottom: 1px dashed black;
+  margin-bottom: 0.3em;
+  padding-bottom: 0.1em;
+}
+
+.method .description, .method .sourcecode {
+  margin-left: 1em;
+}
+
+.description p, .sourcecode p {
+  margin-bottom: 0.5em;
+}
+
+.method .sourcecode p.source-link {
+  text-indent: 0em;
+  margin-top: 0.5em;
+}
+
+.method .aka {
+  margin-top: 0.3em;
+  margin-left: 1em;
+  font-style: italic;
+  text-indent: 2em;
+}
+
+h1 {
+  padding: 1em;
+  margin-left: -1.5em;
+  font-size: x-large;
+  font-weight: bold;
+  color: #FFF;
+  background: #007;
+}
+
+h2 {
+  padding: 0.5em 1em 0.5em 1em;
+  margin-left: -1.5em;
+  font-size: large;
+  font-weight: bold;
+  color: #FFF;
+  background: #009;
+}
+
+h3, h4, h5, h6 {
+  color: #220088;
+  border-bottom: #5522bb solid 1px;
+}
+
+.sourcecode > pre {
+  padding: 0.5em;
+  border: 1px dotted black;
+  background: #FFE;
+}
+
+dt {
+  font-weight: bold
+}
+
+dd {
+  margin-bottom: 0.7em;
+}
+CSS
+
+XHTML_PREAMBLE = %{<?xml version="1.0" encoding="%charset%"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+}
+
+XHTML_FRAMESET_PREAMBLE = %{
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">    
+}
+
+HEADER = XHTML_PREAMBLE + <<ENDHEADER
+<html>
+  <head>
+    <title>%title%</title>
+    <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+    <link rel="stylesheet" href="%style_url%" type="text/css" media="screen" />
+
+    <script language="JavaScript" type="text/javascript">
+    // <![CDATA[
+
+        function toggleSource( id )
+        {
+          var elem
+          var link
+
+          if( document.getElementById )
+          {
+            elem = document.getElementById( id )
+            link = document.getElementById( "l_" + id )
+          }
+          else if ( document.all )
+          {
+            elem = eval( "document.all." + id )
+            link = eval( "document.all.l_" + id )
+          }
+          else
+            return false;
+
+          if( elem.style.display == "block" )
+          {
+            elem.style.display = "none"
+            link.innerHTML = "show source"
+          }
+          else
+          {
+            elem.style.display = "block"
+            link.innerHTML = "hide source"
+          }
+        }
+
+        function openCode( url )
+        {
+          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
+        }
+      // ]]>
+    </script>
+  </head>
+
+  <body>
+ENDHEADER
+
+FILE_PAGE = <<HTML
+<table border='0' cellpadding='0' cellspacing='0' width="100%" class='banner'>
+  <tr><td>
+    <table width="100%" border='0' cellpadding='0' cellspacing='0'><tr>
+      <td class="file-title" colspan="2"><span class="file-title-prefix">File</span><br />%short_name%</td>
+      <td align="right">
+        <table border='0' cellspacing="0" cellpadding="2">
+          <tr>
+            <td>Path:</td>
+            <td>%full_path%
+IF:cvsurl
+				&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+            </td>
+          </tr>
+          <tr>
+            <td>Modified:</td>
+            <td>%dtm_modified%</td>
+          </tr>
+        </table>
+      </td></tr>
+    </table>
+  </td></tr>
+</table><br />
+HTML
+
+###################################################################
+
+CLASS_PAGE = <<HTML
+<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
+  <td class="file-title"><span class="file-title-prefix">%classmod%</span><br />%full_name%</td>
+  <td align="right">
+    <table cellspacing="0" cellpadding="2">
+      <tr valign="top">
+        <td>In:</td>
+        <td>
+START:infiles
+HREF:full_path_url:full_path:
+IF:cvsurl
+&nbsp;(<a href="%cvsurl%">CVS</a>)
+ENDIF:cvsurl
+END:infiles
+        </td>
+      </tr>
+IF:parent
+    <tr>
+      <td>Parent:</td>
+      <td>
+IF:par_url
+        <a href="%par_url%">
+ENDIF:par_url
+%parent%
+IF:par_url
+         </a>
+ENDIF:par_url
+     </td>
+   </tr>
+ENDIF:parent
+         </table>
+        </td>
+        </tr>
+      </table>
+HTML
+
+###################################################################
+
+METHOD_LIST = <<HTML
+  <div id="content">
+IF:diagram
+  <table cellpadding='0' cellspacing='0' border='0' width="100%"><tr><td align="center">
+    %diagram%
+  </td></tr></table>
+ENDIF:diagram
+
+IF:description
+  <div class="description">%description%</div>
+ENDIF:description
+
+IF:requires
+  <div class="sectiontitle">Required Files</div>
+  <ul>
+START:requires
+  <li>HREF:aref:name:</li>
+END:requires
+  </ul>
+ENDIF:requires
+
+IF:toc
+  <div class="sectiontitle">Contents</div>
+  <ul>
+START:toc
+  <li><a href="#%href%">%secname%</a></li>
+END:toc
+  </ul>
+ENDIF:toc
+
+IF:methods
+  <div class="sectiontitle">Methods</div>
+  <ul>
+START:methods
+  <li>HREF:aref:name:</li>
+END:methods
+  </ul>
+ENDIF:methods
+
+IF:includes
+<div class="sectiontitle">Included Modules</div>
+<ul>
+START:includes
+  <li>HREF:aref:name:</li>
+END:includes
+</ul>
+ENDIF:includes
+
+START:sections
+IF:sectitle
+<div class="sectiontitle"><a name="%secsequence%">%sectitle%</a></div>
+IF:seccomment
+<div class="description">
+%seccomment%
+</div>
+ENDIF:seccomment
+ENDIF:sectitle
+
+IF:classlist
+  <div class="sectiontitle">Classes and Modules</div>
+  %classlist%
+ENDIF:classlist
+
+IF:constants
+  <div class="sectiontitle">Constants</div>
+  <table border='0' cellpadding='5'>
+START:constants
+  <tr valign='top'>
+    <td class="attr-name">%name%</td>
+    <td>=</td>
+    <td class="attr-value">%value%</td>
+  </tr>
+IF:desc
+  <tr valign='top'>
+    <td>&nbsp;</td>
+    <td colspan="2" class="attr-desc">%desc%</td>
+  </tr>
+ENDIF:desc
+END:constants
+  </table>
+ENDIF:constants
+
+IF:attributes
+  <div class="sectiontitle">Attributes</div>
+  <table border='0' cellpadding='5'>
+START:attributes
+  <tr valign='top'>
+    <td class='attr-rw'>
+IF:rw
+[%rw%]
+ENDIF:rw
+    </td>
+    <td class='attr-name'>%name%</td>
+    <td class='attr-desc'>%a_desc%</td>
+  </tr>
+END:attributes
+  </table>
+ENDIF:attributes
+
+IF:method_list
+START:method_list
+IF:methods
+<div class="sectiontitle">%type% %category% methods</div>
+START:methods
+<div class="method">
+  <div class="title">
+IF:callseq
+    <a name="%aref%"></a><b>%callseq%</b>
+ENDIF:callseq
+IFNOT:callseq
+    <a name="%aref%"></a><b>%name%</b>%params%
+ENDIF:callseq
+IF:codeurl
+[&nbsp;<a href="%codeurl%" target="SOURCE_CODE" onclick="javascript:openCode('%codeurl%'); return false;">source</a>&nbsp;]
+ENDIF:codeurl
+  </div>
+IF:m_desc
+  <div class="description">
+  %m_desc%
+  </div>
+ENDIF:m_desc
+IF:aka
+<div class="aka">
+  This method is also aliased as
+START:aka
+  <a href="%aref%">%name%</a>
+END:aka
+</div>
+ENDIF:aka
+IF:sourcecode
+<div class="sourcecode">
+  <p class="source-link">[ <a href="javascript:toggleSource('%aref%_source')" id="l_%aref%_source">show source</a> ]</p>
+  <div id="%aref%_source" class="dyn-source">
+<pre>
+%sourcecode%
+</pre>
+  </div>
+</div>
+ENDIF:sourcecode
+</div>
+END:methods
+ENDIF:methods
+END:method_list
+ENDIF:method_list
+END:sections
+</div>
+HTML
+
+FOOTER = <<ENDFOOTER
+  </body>
+</html>
+ENDFOOTER
+
+BODY = HEADER + <<ENDBODY
+  !INCLUDE! <!-- banner header -->
+
+  <div id="bodyContent">
+    #{METHOD_LIST}
+  </div>
+
+  #{FOOTER}
+ENDBODY
+
+########################## Source code ##########################
+
+SRC_PAGE = XHTML_PREAMBLE + <<HTML
+<html>
+<head><title>%title%</title>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+<style type="text/css">
+.ruby-comment    { color: green; font-style: italic }
+.ruby-constant   { color: #4433aa; font-weight: bold; }
+.ruby-identifier { color: #222222;  }
+.ruby-ivar       { color: #2233dd; }
+.ruby-keyword    { color: #3333FF; font-weight: bold }
+.ruby-node       { color: #777777; }
+.ruby-operator   { color: #111111;  }
+.ruby-regexp     { color: #662222; }
+.ruby-value      { color: #662222; font-style: italic }
+  .kw { color: #3333FF; font-weight: bold }
+  .cmt { color: green; font-style: italic }
+  .str { color: #662222; font-style: italic }
+  .re  { color: #662222; }
+</style>
+</head>
+<body bgcolor="white">
+<pre>%code%</pre>
+</body>
+</html>
+HTML
+
+########################## Index ################################
+
+FR_INDEX_BODY = <<HTML
+!INCLUDE!
+HTML
+
+FILE_INDEX = XHTML_PREAMBLE + <<HTML
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+<title>Index</title>
+<style type="text/css">
+<!--
+  body {
+    background-color: #EEE;
+    font-family: #{FONTS}; 
+    color: #000;
+    margin: 0px;
+  }
+  .banner {
+    background: #005;
+    color: #FFF;
+    padding: 0.2em;
+    font-size: small;
+    font-weight: bold;
+    text-align: center;
+  }
+  .entries {
+    margin: 0.25em 1em 0 1em;
+    font-size: x-small;
+  }
+  a {
+    color: #00F;
+    text-decoration: none;
+    white-space: nowrap;
+  }
+  a:hover {
+    color: #77F;
+    text-decoration: underline;
+  }
+-->
+</style>
+<base target="docwin" />
+</head>
+<body>
+<div class="banner">%list_title%</div>
+<div class="entries">
+START:entries
+<a href="%href%">%name%</a><br />
+END:entries
+</div>
+</body></html>
+HTML
+
+CLASS_INDEX = FILE_INDEX
+METHOD_INDEX = FILE_INDEX
+
+INDEX = XHTML_FRAMESET_PREAMBLE + <<HTML
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>%title%</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=%charset%" />
+</head>
+
+<frameset cols="20%,*">
+    <frameset rows="15%,55%,30%">
+        <frame src="fr_file_index.html"   title="Files" name="Files" />
+        <frame src="fr_class_index.html"  name="Classes" />
+        <frame src="fr_method_index.html" name="Methods" />
+    </frameset>
+    <frame  src="%initial_page%" name="docwin" />
+    <noframes>
+          <body bgcolor="white">
+            Click <a href="html/index.html">here</a> for a non-frames
+            version of this page.
+          </body>
+    </noframes>
+</frameset>
+
+</html>
+HTML
+
+end
+end
+

data/spec/paranoid_spec.rb

@@ -5,81 +5,108 @@ LUKE = 'Luke Skywalker'
 
 describe Paranoid do
   before(:each) do
-    Sticker.delete_all
-    Place.delete_all
-    Android.delete_all
-    Person.delete_all
-    Component.delete_all
-
-    @luke = Person.create(:name => LUKE)
-    @r2d2 = Android.create(:name => 'R2D2', :owner_id => @luke.id)
-    @c3p0 = Android.create(:name => 'C3P0', :owner_id => @luke.id)
-
-    @r2d2.components.create(:name => 'Rotors')
-
-    @r2d2.memories.create(:name => 'A pretty sunset')
-    @c3p0.sticker = Sticker.create(:name => 'OMG, PONIES!')
-    @tatooine = Place.create(:name => "Tatooine")
-    @r2d2.places << @tatooine
+    # Sticker.delete_all
+    # Place.delete_all
+    # Android.delete_all
+    # Person.delete_all
+    # Component.delete_all
+    #
+    # @luke = Person.create(:name => LUKE)
+    # @r2d2 = Android.create(:name => 'R2D2', :owner_id => @luke.id)
+    # @c3p0 = Android.create(:name => 'C3P0', :owner_id => @luke.id)
+    #
+    # @r2d2.components.create(:name => 'Rotors')
+    #
+    # @r2d2.memories.create(:name => 'A pretty sunset')
+    # @c3p0.sticker = Sticker.create(:name => 'OMG, PONIES!')
+    # @tatooine = Place.create(:name => "Tatooine")
+    # @r2d2.places << @tatooine
   end
 
-  it 'should recognize a class as paranoid' do
-    Person.paranoid?.should be_false
-    Place.paranoid?.should be_true
-  end
+  describe 'basic functionality' do
+    before(:each) do
+      Place.delete_all
+      @tatooine, @mos_eisley, @coruscant = Place.create([{:name => "Tatooine"}, {:name => 'Mos Eisley'}, {:name => 'Coruscant'}])
+    end
 
-  it 'should hide destroyed records' do
-    @tatooine.update_attribute('deleted_at', Time.now)
-    Place.first(:conditions => {:name => 'Tatooine'}).should be_nil
-  end
+    it 'should recognize a class as paranoid' do
+      Person.paranoid?.should be_false
+      Place.paranoid?.should be_true
+    end
 
-  it 'should reveal destroyed records when with_destroyed' do
-    @tatooine.update_attribute('deleted_at', Time.now)
-    Place.with_destroyed.first(:conditions => {:name => 'Tatooine'}).should_not be_nil
-  end
+    it 'should hide destroyed records' do
+      @tatooine.update_attribute('deleted_at', Time.now)
+      Place.first(:conditions => {:name => 'Tatooine'}).should be_nil
+    end
 
-  it 'should restore the destroyed record' do
-    @tatooine.update_attribute('deleted_at', Time.now)
+    it 'should reveal destroyed records when with_destroyed' do
+      @tatooine.update_attribute('deleted_at', Time.now)
+      Place.with_destroyed.first(:conditions => {:name => 'Tatooine'}).should_not be_nil
+    end
 
-    @tatooine = Place.with_destroyed.first(:conditions => {:name => 'Tatooine'})
-    @tatooine.restore
+    it 'should restore the destroyed record' do
+      @tatooine.update_attribute('deleted_at', Time.now)
 
-    Place.first(:conditions => {:name => 'Tatooine'}).should_not be_nil
-  end
+      @tatooine = Place.with_destroyed.first(:conditions => {:name => 'Tatooine'})
+      @tatooine.restore
 
-  it 'should soft delete paranoid records' do
-    @tatooine.destroy
+      Place.first(:conditions => {:name => 'Tatooine'}).should_not be_nil
+    end
 
-    record = Place.with_destroyed.first(:conditions => {:name => 'Tatooine'})
-    record.should_not be_nil
-    record.deleted_at.should_not be_nil
-  end
+    it 'should soft delete paranoid records' do
+      @tatooine.destroy
 
-  it 'should mark the record destroyed' do
-    @tatooine.destroy
-    @tatooine.destroyed?.should be_true
-  end
+      record = Place.with_destroyed.first(:conditions => {:name => 'Tatooine'})
+      record.should_not be_nil
+      record.deleted_at.should_not be_nil
+    end
 
-  it 'should set the deleted_field' do
-    @tatooine.destroy
-    @tatooine.deleted_at.should_not be_nil
+    it 'should mark the record destroyed' do
+      @tatooine.destroy
+      @tatooine.destroyed?.should be_true
+    end
+
+    it 'should set the deleted_field' do
+      @tatooine.destroy
+      @tatooine.deleted_at.should_not be_nil
+    end
+
+    it 'should show deleted_only' do
+      @tatooine.destroy
+      destroyed = Place.with_destroyed_only.all
+      destroyed.size.should == 1
+      destroyed[0].should == @tatooine
+    end
+
+    it 'should properly count records' do
+      Place.count.should == 3
+
+      @tatooine.destroy
+      Place.count.should == 2
+      Place.with_destroyed.count.should == 3
+      Place.with_destroyed_only.count.should == 1
+    end
   end
 
   describe 'for alternate field information' do
     before(:each) do
       Ninja.delete_all
-      @ninja = Ninja.create(:name => 'Steve')
+      @steve, @bob, @tim = Ninja.create([{:name => 'Steve', :visible => true}, {:name => 'Bob', :visible => true}, {:name => 'Tim', :visible => true}])
+    end
+
+    it 'should have 3 visible ninjas' do
+      Ninja.all.size.should == 3
     end
 
     it 'should vanish the ninja' do
-      @ninja.destroy
+      @steve.destroy
 
       record = Ninja.first(:conditions => {:name => 'Steve'})
       record.should be_nil
     end
 
     it 'should not delete the ninja' do
-      @ninja.destroy
+      @steve.destroy
 
       record = Ninja.with_destroyed.first(:conditions => {:name => 'Steve'})
       record.should_not be_nil
@@ -87,13 +114,29 @@ describe Paranoid do
     end
 
     it 'should mark the ninja vanished' do
-      @ninja.destroy
-      @ninja.destroyed?.should be_true
+      @steve.destroy
+      @steve.destroyed?.should be_true
     end
 
     it 'should set visible to false' do
-      @ninja.destroy
-      @ninja.visible.should be_false
+      @steve.destroy
+      @steve.visible.should be_false
+    end
+
+    it 'should show deleted_only' do
+      @steve.destroy
+      destroyed = Ninja.with_destroyed_only.all
+      destroyed.size.should == 1
+      destroyed[0].should == @steve
+    end
+
+    it 'should properly count records' do
+      Ninja.count.should == 3
+
+      @steve.destroy
+      Ninja.count.should == 2
+      Ninja.with_destroyed.count.should == 3
+      Ninja.with_destroyed_only.count.should == 1
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: paranoid
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Genord II
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-18 00:00:00 -05:00
+date: 2010-02-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,8 +38,10 @@ files:
 - init.rb
 - lib/paranoid.rb
 - lib/paranoid/base.rb
+- lib/paranoid/paranoid_methods.rb
 - lib/paranoid/relation.rb
 - paranoid.gemspec
+- rdoc/template.rb
 - spec/database.yml
 - spec/models.rb
 - spec/paranoid_spec.rb