acts_as_removable 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7668aae0ef68e4f3a34049142e66af8ae3dde45
+  data.tar.gz: 3368f24e31ebd5cc6af0a17a74424e1aec5c2a7b
+SHA512:
+  metadata.gz: 07025ebbedcd757e04a3e014e7811d2347b50d741b431d826db279afbcb4bd7fd96b86a6f48155163e069ac2f31a09e0cdd7b84592306ae5d8205c38d3537f1e
+  data.tar.gz: 10ed3f98b93efb322e4d22d02e0c3089fcea6e5792c9525e7f53c876f2c675a896a6b0c2cccb6f567720b852213f57785418cd4fc37ea33a76f52492f0c5b968

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_removable.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Florian Schwab
+
+MIT License
+
+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

@@ -0,0 +1,67 @@
+# ActsAsRemovable
+
+This gem allows you to easily manage ActiveRecord objects that are pseudo destroyed a.k.a. removed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_removable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_removable
+
+## Usage
+
+```ruby
+# a column removed_at of type timestamp is required 
+class MyModel < ActiveRecord::Base
+  acts_as_removable
+end
+
+record = MyModel.create
+record.removed? # => false
+record.remove
+record.removed? # => true
+```
+
+You can also specify the column to use:
+```ruby
+class MyModel < ActiveRecord::Base
+  acts_as_removable column_name: :some_column
+end
+```
+
+And you can use callbacks:
+```ruby
+class MyModel < ActiveRecord::Base
+  acts_as_removable
+
+  before_save do |r|
+    puts "Before removing record"
+  end
+
+  after_remove :after_remove_method
+  def after_remove_method
+    puts "After removing record"
+  end
+end
+```
+
+## Code Status
+
+* [![Build Status](https://api.travis-ci.org/SICSoftwareGmbH/acts_as_removable.png)](https://travis-ci.org/SICSoftwareGmbH/acts_as_removable)
+* [![Dependencies](https://gemnasium.com/SICSoftwareGmbH/acts_as_removable.png?travis)](https://gemnasium.com/SICSoftwareGmbH/acts_as_removable)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/acts_as_removable.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_removable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_removable"
+  spec.version       = ActsAsRemovable::VERSION
+  spec.authors       = ["Florian Schwab"]
+  spec.email         = ["florian.schwab@sic-software.com"]
+  spec.description   = %q{Simplifies handling of pseudo removed records}
+  spec.summary       = %q{Simplifies handling of pseudo removed records}
+  spec.homepage      = "https://github.com/SICSoftwareGmbH/acts_as_removable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.0.0.rc2"
+  spec.add_dependency "activerecord", "~> 4.0.0.rc2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/acts_as_removable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsRemovable
+  VERSION = "0.9.0"
+end

data/lib/acts_as_removable.rb

@@ -0,0 +1,54 @@
+require 'active_support/concern'
+require 'active_record'
+require "acts_as_removable/version"
+
+module ActsAsRemovable
+  extend ActiveSupport::Concern
+
+  included do
+    extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def acts_as_removable(options={})
+      self.class_eval do
+        @_acts_as_removable_column_name = options[:column_name] || 'removed_at'
+        def self._acts_as_removable_column_name
+          @_acts_as_removable_column_name
+        end
+
+        default_scope -> {where("#{self.table_name}.#{self._acts_as_removable_column_name} IS NULL")}
+        scope :removed, -> {where("#{self.table_name}.#{self._acts_as_removable_column_name} IS NOT NULL")}
+
+        define_callbacks :remove
+
+        def self.before_remove(*args, &block)
+          set_callback :remove, :before, *args, &block
+        end
+
+        def self.after_remove(*args, &block)
+          set_callback :remove, :after, *args, &block
+        end
+
+        def removed?
+          self.send(self.class._acts_as_removable_column_name).present?
+        end
+
+        def remove
+          run_callbacks :remove do
+            self.update_attributes(self.class._acts_as_removable_column_name => Time.now)
+          end
+        end
+
+        def remove!
+          run_callbacks :remove do
+            self.update_attributes!(self.class._acts_as_removable_column_name => Time.now)
+          end
+        end
+      end
+    end
+  end
+
+end
+
+ActiveRecord::Base.send(:include, ActsAsRemovable)

data/spec/acts_as_removable_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe 'acts_as_removable' do
+  class MyModel < ActiveRecord::Base
+    acts_as_removable
+    attr_accessor :callback_before, :callback_after
+    before_remove do |r|
+      r.callback_before = true
+    end
+    after_remove do |r|
+      r.callback_after = true
+    end
+  end
+
+  class MySecondModel < ActiveRecord::Base
+    acts_as_removable column_name: :use_this_column
+  end
+
+  before do
+    # setup database
+    db_file = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'acts_as_removable.db'))
+    Dir::mkdir(File.dirname(db_file)) unless File.exists?(File.dirname(db_file))
+    ActiveRecord::Base.establish_connection(
+      :adapter => "sqlite3",
+      :database => "#{File.expand_path(File.join(File.dirname(__FILE__), '..'))}/tmp/acts_as_removable.db"
+    )
+    ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'my_models'")
+    ActiveRecord::Base.connection.create_table(:my_models) do |t|
+      t.timestamp :removed_at
+    end
+    ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'my_second_models'")
+    ActiveRecord::Base.connection.create_table(:my_second_models) do |t|
+      t.string :name
+      t.timestamp :use_this_column
+    end
+  end
+
+  it "test column and check method" do
+    [[MyModel.create!, :removed_at], [MySecondModel.create!, :use_this_column]].each do |r, column_name|
+      r.removed?.should be_false
+      r.send(column_name).should be_nil
+
+      r.remove
+      r.removed?.should be_true
+      r.send(column_name).should be_a(Time)
+    end
+  end
+
+  it "test callbacks" do
+    r = MyModel.create!
+    r.callback_before.should be_false
+    r.callback_after.should be_false
+    r.remove
+    r.callback_before.should be_true
+    r.callback_after.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'acts_as_removable'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_removable
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Florian Schwab
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: 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'
+description: Simplifies handling of pseudo removed records
+email:
+- florian.schwab@sic-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_removable.gemspec
+- lib/acts_as_removable.rb
+- lib/acts_as_removable/version.rb
+- spec/acts_as_removable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/SICSoftwareGmbH/acts_as_removable
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Simplifies handling of pseudo removed records
+test_files:
+- spec/acts_as_removable_spec.rb
+- spec/spec_helper.rb