hideable 0.1.0 → 0.2.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012-3 Joe Corcoran
+
+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.md

@@ -8,39 +8,47 @@ A simple way to provide hideability to ActiveRecord models. Mark records as hidd
 
 Run the generator to create migrations for all of the models you want to hide:
 
-    $ rails generate hideable:migration Foo Bar
-    $ rake db:migrate
+```bash
+rails generate hideable:migration Foo Bar
+rake db:migrate
+```
     
 Declare your models `hideable`:
  
-    class Foo < ActiveRecord::Base
-      extend Hideable::ActiveRecord
-      hideable
-    end
+```ruby
+class Foo < ActiveRecord::Base
+  extend Hideable::ActiveRecord
+  hideable
+end
+```
     
-This will add `hide!`, `unhide!` and `hidden?` instance methods and `hidden` and `not_hidden` scopes.
+This will add `#hide!`, `#unhide!` and `#hidden?` instance methods and `.hidden` and `.not_hidden` scopes.
     
 Hideable is designed to work in a similar way to the `:dependent` option on associations too, if that's what you want.
 
-    class Foo < ActiveRecord::Base
-      has_one :bar
+```ruby
+class Foo < ActiveRecord::Base
+  has_one :bar
 
-      extend Hideable::ActiveRecord
-      hideable :dependent => :hide
-    end
+  extend Hideable::ActiveRecord
+  hideable :dependent => :hide
+end
     
-    class Bar < ActiveRecord::Base
-      belongs_to :foo
+class Bar < ActiveRecord::Base
+  belongs_to :foo
       
-      extend Hideable::ActiveRecord
-      hideable
-    end
+  extend Hideable::ActiveRecord
+  hideable
+end
+```
 
 All models that you wish to hide, including dependents, must be declared as `hideable`.
 
-    > foo = Foo.not_hidden.first
-    > foo.hide
-    > foo.bar.hidden? #=> true
+```ruby
+foo = Foo.not_hidden.first
+foo.hide!
+foo.bar.hidden? #=> true
+```
 
 ## Why?
 
@@ -50,12 +58,12 @@ Knowing that you can hide or unhide a record is often better destroying it for g
 
 Install the general dependencies, including all the versions of `activerecord` that `hideable` is tested against.
 
-```
-$ bundle install && rake appraisal:install
+```bash
+bundle install && rake appraisal:install
 ```
 
 Run tests as follows.
 
-```
-$ rake appraisal
+```bash
+rake appraisal
 ```

data/lib/hideable/active_record.rb

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

data/lib/hideable/active_record/instance_methods.rb

@@ -18,26 +18,30 @@ module Hideable
         self.save!
       end
 
-      private
+      def update_hideable_dependents?
+        self.hidden_at_changed?
+      end
 
-        def update_hideable_dependents
-          self.class.reflect_on_all_associations.each do |reflection|
-            if update_reflected_record?(reflection)
-              dependent_records = Array(self.send(reflection.name)).compact
-              dependent_records.each do |record|
-                action = self.hidden? ? :hide! : :unhide!
-                record.send(action) if record.respond_to?(action)
-              end
+      def update_hideable_dependents!
+        self.class.reflect_on_all_associations.each do |reflection|
+          if update_reflected_record?(reflection)
+            dependent_records = Array(self.send(reflection.name)).compact
+            dependent_records.each do |record|
+              action = self.hidden? ? :hide! : :unhide!
+              record.send(action) if record.respond_to?(action)
             end
           end
         end
+      end
+
+      private
 
         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_dependent == true
+            self.class.hide_dependents == true
           )
         end
 

data/lib/hideable/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hideable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -104,6 +104,7 @@ files:
 - lib/hideable/version.rb
 - lib/hideable.rb
 - README.md
+- LICENSE.txt
 homepage: http://rubygems.org/gems/hideable
 licenses: []
 post_install_message: