hideable 0.1.0

data/README.md

@@ -0,0 +1,61 @@
+# Hideable
+
+[![Build Status](https://secure.travis-ci.org/joecorcoran/hideable.png?branch=master)](http://travis-ci.org/joecorcoran/hideable)
+
+A simple way to provide hideability to ActiveRecord models. Mark records as hidden instead of destroying them for good.
+
+## Use
+
+Run the generator to create migrations for all of the models you want to hide:
+
+    $ rails generate hideable:migration Foo Bar
+    $ rake db:migrate
+    
+Declare your models `hideable`:
+ 
+    class Foo < ActiveRecord::Base
+      extend Hideable::ActiveRecord
+      hideable
+    end
+    
+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
+
+      extend Hideable::ActiveRecord
+      hideable :dependent => :hide
+    end
+    
+    class Bar < ActiveRecord::Base
+      belongs_to :foo
+      
+      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
+
+## 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.
+
+## Development
+
+Install the general dependencies, including all the versions of `activerecord` that `hideable` is tested against.
+
+```
+$ bundle install && rake appraisal:install
+```
+
+Run tests as follows.
+
+```
+$ rake appraisal
+```

data/lib/generators/hideable/migration_generator.rb

@@ -0,0 +1,16 @@
+module Hideable
+  module Generators
+    
+    class MigrationGenerator < Rails::Generators::Base
+      desc 'Generates a hideable migration for each given class.'
+      argument :classes, :type => :array, :default => [], :banner => 'User Post'
+      def exec
+        classes.each do |c|
+          table_name = c.constantize.table_name
+          generate('migration', "AddHiddenAtTo#{table_name.camelize} hidden_at:datetime")
+        end
+      end
+    end
+
+  end
+end

data/lib/hideable.rb

@@ -0,0 +1,3 @@
+require 'hideable/version'
+require 'hideable/active_record'
+require 'hideable/active_record/instance_methods'

data/lib/hideable/active_record.rb

@@ -0,0 +1,20 @@
+module Hideable
+  module ActiveRecord
+
+    def hideable(options = {})
+      send :include, InstanceMethods
+      class_attribute :hide_dependent
+      self.hide_dependent = options[:dependent] == :hide ? true : false
+      after_save :update_hideable_dependents
+    end
+
+    def hidden
+      where(self.arel_table[:hidden_at].not_eq(nil))
+    end
+
+    def not_hidden
+      where(self.arel_table[:hidden_at].eq(nil))
+    end
+
+  end
+end

data/lib/hideable/active_record/instance_methods.rb

@@ -0,0 +1,46 @@
+module Hideable
+  module ActiveRecord
+    module InstanceMethods
+
+      def hidden?
+        self.hidden_at.is_a?(DateTime)
+      end
+
+      def hide!
+        return if self.hidden?
+        self.hidden_at = DateTime.now
+        self.save!
+      end
+
+      def unhide!
+        return unless self.hidden?
+        self.hidden_at = nil
+        self.save!
+      end
+
+      private
+
+        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
+
+        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
+          )
+        end
+
+    end
+  end
+end

data/lib/hideable/version.rb

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

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: hideable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joe Corcoran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+description: Enables soft-deletion in ActiveRecord by marking records as hidden
+email:
+- joe@tribesports.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/hideable/migration_generator.rb
+- lib/hideable/active_record/instance_methods.rb
+- lib/hideable/active_record.rb
+- lib/hideable/version.rb
+- lib/hideable.rb
+- README.md
+homepage: http://rubygems.org/gems/hideable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Don't want to destroy your records? Hide them
+test_files: []