mark_only 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTFhODAwYWViNjgwOTcyNjdmYjkzNTQ0ZDI2MzdhMWQ2NDkzNzM5YQ==
+  data.tar.gz: !binary |-
+    ZjZhNmNmMzZjMzFjMjJkMDExYTc0YmIxZGI3ZTdiNmEzMGYwYmU2Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDJiMmVmNGJmZDJiNmQyMTBjYzExZWZjOTgxY2YxOTM4YThlM2NkMzU5Yjc3
+    ZDgyM2E5M2FiNWI0MWMzMzFhOGIxZmU3MWQ2ZTA2NmRlMjFkZmQ1ODYyNGEz
+    MzAxYTU0ZTg4MzI0MDE1ZjUzOWRhYmExY2I4MWM5MzFlNzI5Nzc=
+  data.tar.gz: !binary |-
+    MTQ4MDQyZGYzYThjMWY0OWIzYzk0Yjg2MTkyOWFmM2E3NzhjNDA2OTQzNjcz
+    NjM1ZjUzMDE3NTAzYmNiZTcyYjBkZWM3ZGI2ZDhiNzAzYTUwMmJmZDM3NGRm
+    YmUyZjFkYTdiYjNkYjg1Y2E1ZTE3MWY4NmFjOTgzNmI0ZGE1ZjA=

data/README.md

@@ -0,0 +1,82 @@
+# Mark Only
+
+Mark Only is a fork of [Paranoia][paranoia] (by Ryan Bigg and others) with significant changes. It only sets a specified column with a specified value on destroy/delete. Like Paranoia it allows before_destroy, etc. callbacks.
+
+However, it does not unscope marked records. This means that anything that attempts to find the record after a destroy will still find it.
+
+To *really* destroy or delete records, use the Paranoia/acts_as_paranoid convention of calling `destroy!` or `delete!`.
+
+## Installation & Usage
+
+Put this in your Gemfile:
+
+```ruby
+gem 'mark_only'
+```
+
+Then run:
+
+```shell
+bundle install
+```
+
+Updating is as simple as `bundle update mark_only`.
+
+#### Run your migrations for the desired models
+
+```ruby
+class AddDeletedAtToClient < ActiveRecord::Migration
+  def self.up
+    add_column :clients, :some_column_to_mark, :string
+  end
+
+  def self.down
+    remove_column :clients, :some_column_to_mark
+  end
+end
+```
+
+### Usage
+
+#### In your environment.rb:
+
+```ruby
+MarkOnly.configure do
+  self.active_value = 'active'
+  self.deleted_value = 'deleted'
+end
+
+...
+```
+
+#### In your model:
+
+```ruby
+class Client < ActiveRecord::Base
+  mark_only :some_column_to_mark
+
+  ...
+end
+```
+
+If you want a method to be called on destroy, simply provide a _before\_destroy_ callback:
+
+```ruby
+class Client < ActiveRecord::Base
+  mark_only :some_column_to_mark
+
+  before_destroy :some_method
+
+  def some_method
+    # do stuff
+  end
+
+  ...
+end
+```
+
+## License
+
+This gem is released under the MIT license.
+
+[paranoia]: https://github.com/radar/paranoia

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :test do
+  load 'test/mark_only_test.rb'
+  #Dir['test/*_test.rb'].each do |testfile|
+  #  load testfile
+  #end
+end
+
+task :default => :test

data/lib/mark_only/version.rb

@@ -0,0 +1,3 @@
+module MarkOnly
+  VERSION = "0.0.1"
+end

data/lib/mark_only.rb

@@ -0,0 +1,73 @@
+require 'mark_only/version'
+
+module MarkOnly
+  class << self
+    [:deleted_value, :active_value].each{|o|attr_accessor o}
+    def configure(&blk); class_eval(&blk); end
+  end
+
+  def self.included(klazz)
+    klazz.extend Query
+  end
+
+  module Query
+    def mark_only? ; true ; end
+  end
+
+  def destroy
+    run_callbacks(:destroy) { delete }
+  end
+
+  def delete
+    puts "updating column #{self.mark_only_column} with value #{MarkOnly.deleted_value}"
+    update_attribute_or_column(self.mark_only_column, MarkOnly.deleted_value) if !deleted? && persisted?
+  end
+
+  def restore!
+    puts "updating column #{self.mark_only_column} with value #{MarkOnly.active_value}"
+    update_attribute_or_column self.mark_only_column, MarkOnly.active_value
+  end
+
+  def destroyed?
+    self.send(self.mark_only_column.to_sym) == MarkOnly.deleted_value
+  end
+  alias :deleted? :destroyed?
+
+  private
+
+  def default_mark_only_column
+    self.send("#{self.mark_only_column}=".to_sym, MarkOnly.active_value) unless self.send(self.mark_only_column.to_sym) == MarkOnly.deleted_value
+  end
+
+  # Rails 3.1 adds update_column. Rails > 3.2.6 deprecates update_attribute, gone in Rails 4.
+  def update_attribute_or_column(*args)
+    respond_to?(:update_column) ? update_column(*args) : update_attribute(*args)
+  end
+end
+
+MarkOnly.configure do
+  self.active_value = 'active'
+  self.deleted_value = 'deleted'
+end
+
+class ActiveRecord::Base
+  def self.mark_only(col_name)
+    after_initialize :default_mark_only_column
+    before_save :default_mark_only_column
+    class_attribute :mark_only_column, instance_writer: true
+    self.mark_only_column = col_name.to_sym
+    alias :destroy! :destroy
+    alias :delete!  :delete
+    include MarkOnly
+  end
+
+  def self.mark_only? ; false ; end
+  def mark_only? ; self.class.mark_only? ; end
+
+  # Override the persisted method to allow for the paranoia gem.
+  # If a mark_only record is selected, then we only want to check
+  # if it's a new record, not if it is "destroyed".
+  def persisted?
+    mark_only? ? !new_record? : super
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mark_only
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+description: A fork of Paranoia (by Ryan Bigg and others) that updates a specified
+  column with an pre-configured value on destroy, and does no scoping. Supports destroy
+  hooks.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mark_only/version.rb
+- lib/mark_only.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/mark_only
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A fork of Paranoia (by Ryan Bigg and others) that updates a specified column
+  with an pre-configured value on delete/destroy.
+test_files: []