Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/calebhearth/time_for_a_boolean
Back boolean concepts like deleted?, published?, or active? with timestamps
https://github.com/calebhearth/time_for_a_boolean
Last synced: about 1 month ago
JSON representation
Back boolean concepts like deleted?, published?, or active? with timestamps
- Host: GitHub
- URL: https://github.com/calebhearth/time_for_a_boolean
- Owner: calebhearth
- License: mit
- Created: 2013-07-31T02:59:29.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-05-21T22:11:53.000Z (7 months ago)
- Last Synced: 2024-11-17T05:05:17.143Z (about 1 month ago)
- Language: Ruby
- Homepage:
- Size: 39.1 KB
- Stars: 97
- Watchers: 0
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Time for A Boolean
==================
[](https://travis-ci.org/calebthompson/time_for_a_boolean)
[](https://codeclimate.com/github/calebthompson/time_for_a_boolean)
[](https://coveralls.io/r/calebthompson/time_for_a_boolean)
> Sally: Hey, we need to add a flag to Post
> Jean: What for?
> Sally: Well, we want to let users "delete" posts, but not actually lose the
data.
> Jean: Sounds reasonable. But what about later, when we have to know _when_ a
post was deleted?
> Sally: That's a good point, but if we add a timestamp now we have to write all
sorts of methods to keep a nice interface on Post...
> Jean: Time for A Boolean!
Wait, what?
-----------
```
rails generate migration AddDeletedAtToPosts deleted_at:timestamp
```
```ruby
class Post < ActiveRecord::Base
time_for_a_boolean :deleted
...
end
```
```ruby
class PostsController < ApplicationController
def show
@post = Post.find(params[:id])
if @post.deleted?
raise ActiveRecord::RecordNotFound
end
end
def destroy
post = Post.find(params[:id])
post.deleted = true
post.save
redirect_to posts_url
end
end
```
You keep on saying things and I don't get it.
---------------------------------------------
Okay, let's take a look at what happens.
When we call `time_for_a_boolean :deleted` in the Post class definition, several
methods are defined:
| Method | Description
| --------------- | -----------
| `Post#deleted` | `true` if `Post#deleted_at` is set to a time before `Time.current`, `false` otherwise
| `Post#deleted?` | Alias for `Post#deleted`
| `Post#deleted=` | Sets the timestamp to `Time.current` if the new value is true, and `nil` otherwise
These methods allow you to use a timestamp as you would a boolean value in your
application.
Okay... why?
------------
* Audit for when a flag was set. Future you wants this.
* `COUNT(posts.deleted_at)` gives you the count of deleted posts, which is
useful when writing a report. Define and use `Post.deleted.count` when you
have Ruby available.
Other Options
-------------
If you have a date or time column that does not follow the `attribute_at` convention,
you can specify the attribute name:
```
class User < ActiveRecord::Base
time_for_a_boolean :expires, :expires_on
end
```
This is especially useful when using date only columns.