hideable 0.2.0 → 0.3.0

data/README.md

@@ -4,7 +4,9 @@
 
 A simple way to provide hideability to ActiveRecord models. Mark records as hidden instead of destroying them for good.
 
-## Use
+## Usage
+
+### Setup
 
 Run the generator to create migrations for all of the models you want to hide:
 
@@ -13,7 +15,7 @@ rails generate hideable:migration Foo Bar
 rake db:migrate
 ```
     
-Declare your models `hideable`:
+Make your models `hideable`:
  
 ```ruby
 class Foo < ActiveRecord::Base
@@ -23,6 +25,8 @@ end
 ```
     
 This will add `#hide!`, `#unhide!` and `#hidden?` instance methods and `.hidden` and `.not_hidden` scopes.
+
+### Associations
     
 Hideable is designed to work in a similar way to the `:dependent` option on associations too, if that's what you want.
 
@@ -50,6 +54,39 @@ foo.hide!
 foo.bar.hidden? #=> true
 ```
 
+Hiding dependents requires the records to be instantiated and can be quite expensive depending on the number of records. You can move the operation into the background where suitable. Instead of `:dependent => :hide`, use the `:updated` option to provide a method name or callable that will be called when the object is hidden or unhidden. The following example demonstrates the use of [Sidekiq](http://github.com/mperham/sidekiq) to hide dependents asynchronously.
+
+```ruby
+class Foo < ActiveRecord::Base
+  has_one :bar
+
+  extend Hideable::ActiveRecord
+  hideable :updated => :update_bars
+
+  private
+    def update_bars
+      HideableWorker.perform_async(self.class.name, self.id)
+    end
+end
+    
+class Bar < ActiveRecord::Base
+  belongs_to :foo
+      
+  extend Hideable::ActiveRecord
+  hideable
+end
+
+require 'sidekiq'
+class HideableWorker
+  include Sidekiq::Worker
+
+  def perform(klass_name, id)
+    klass = klass_name.constantize
+    klass.find(id).update_hideable_dependencies!
+  end
+end
+```
+
 ## Why?
 
 Knowing that you can hide or unhide a record is often better destroying it for good. Other gems – such as [paranoia](https://github.com/radar/paranoia) and [acts_as_paranoid](https://github.com/technoweenie/acts_as_paranoid) – do a similar job by overriding `#destroy`, which I don't like.

data/lib/hideable/active_record.rb

@@ -4,8 +4,11 @@ module Hideable
     def hideable(options = {})
       send :include, InstanceMethods
       class_attribute :hide_dependents
-      self.hide_dependents = options[:dependent] == :hide ? true : false
+      self.hide_dependents = (options[:dependent] == :hide) ? true : false
       after_save :update_hideable_dependents!, :if => :update_hideable_dependents?
+      if options[:updated]
+        after_save options[:updated]
+      end
     end
 
     def hidden

data/lib/hideable/active_record/instance_methods.rb

@@ -19,7 +19,7 @@ module Hideable
       end
 
       def update_hideable_dependents?
-        self.hidden_at_changed?
+        self.class.hide_dependents && self.hidden_at_changed?
       end
 
       def update_hideable_dependents!
@@ -38,11 +38,7 @@ module Hideable
 
         def update_reflected_record?(reflection)
           macros = [:has_many, :has_one, :has_and_belongs_to_many]
-          (
-            macros.include?(reflection.macro) &&
-            reflection.options[:through].nil? &&
-            self.class.hide_dependents == true
-          )
+          macros.include?(reflection.macro) && reflection.options[:through].nil?
         end
 
     end

data/lib/hideable/version.rb

@@ -1,3 +1,3 @@
 module Hideable
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hideable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -93,7 +93,7 @@ dependencies:
         version: 0.5.2
 description: Enables soft-deletion in ActiveRecord by marking records as hidden
 email:
-- joe@tribesports.com
+- joecorcoran@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -105,7 +105,7 @@ files:
 - lib/hideable.rb
 - README.md
 - LICENSE.txt
-homepage: http://rubygems.org/gems/hideable
+homepage: http://github.com/joecorcoran/judge
 licenses: []
 post_install_message: 
 rdoc_options: []