Sha256: 41cfe0317e575afe2daf8d4ad8d8ae7aa25c36c70a35cf5ef71614c4a0a886c4

Contents?: true

Size: 1.88 KB

Versions: 8

Compression:

Stored size: 1.88 KB

Contents

# DeletedAt

Deleting data is never good. A common solution is to use `default_scope`, but conventional wisdom (and for good reason) deams this a bad practice. So how do we achieve the same effect with minimal intervention. What we're looking for is the cliche "clean" solution.

DeletedAt leverages the power of SQL views to achieve the same effect. It also takes advantage of Ruby's flexibility.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'deleted_at'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install deleted_at

## Usage

Using `DeletedAt` is very simple. It follows a familiar pattern seen throughout the rest of the Ruby/Rails community.

```ruby
class User < ActiveRecord::Base
  # Feel free to include/extend other modules before or after, as you see fit...

  with_deleted_at

  # the rest of your model code...
end
```

You'll (probably) need to migrate your database for `deleted_at` to work properly.

```ruby
class AddDeletedAtColumnToUsers < ActiveRecord::Migration

  def up
    add_column :users, :deleted_at, 'timestamp with time zone'

    DeletedAt.install(User)
  end

  def down
    DeletedAt.uninstall(User)

    remove_column :users, :deleted_at, 'timestamp with time zone'
  end

end
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/deleted_at. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
deleted_at-0.2.6 README.md
deleted_at-0.2.5 README.md
deleted_at-0.2.4 README.md
deleted_at-0.2.3 README.md
deleted_at-0.2.2 README.md
deleted_at-0.2.1 README.md
deleted_at-0.2.0 README.md
deleted_at-0.1.1 README.md